Data.ByteString.IsoBaseFileFormat.Boxes.Box

Definition of the most basic element in an ISOBMFF file: a box. See Chapter 4 in the standard document. A box is a container with a type, a size, some data and some nested boxes. The standard defines - among other characteristics - available box types and their semantics, the fields they contain and how they are nested into each other. This library tries to capture some of these characteristics using modern Haskell type system features, in order to provide compile time checks for (partial) standard compliance.

Box Type Classes

class (KnownSymbol (BoxTypeSymbol t), IsBoxContent (BoxContent t)) => IsBox t where

Base class for all (abstractphantomnormal-) types that represent boxes

Associated Types

type BoxContent t

Methods

toBoxType :: proxy t -> BoxType

Instances

IsBox DataInformation

Associated Types

type BoxContent DataInformation :: *

Methods

toBoxType :: proxy DataInformation -> BoxType

IsBox FileType

File Type Box

Associated Types

type BoxContent FileType :: *

Methods

toBoxType :: proxy FileType -> BoxType

IsBox Media

Associated Types

type BoxContent Media :: *

Methods

toBoxType :: proxy Media -> BoxType

IsBox MediaData

Associated Types

type BoxContent MediaData :: *

Methods

toBoxType :: proxy MediaData -> BoxType

IsBox MediaInformation

Associated Types

type BoxContent MediaInformation :: *

Methods

toBoxType :: proxy MediaInformation -> BoxType

IsBox Movie

Associated Types

type BoxContent Movie :: *

Methods

toBoxType :: proxy Movie -> BoxType

IsBox Skip

Associated Types

type BoxContent Skip :: *

Methods

toBoxType :: proxy Skip -> BoxType

IsBox Track

Associated Types

type BoxContent Track :: *

Methods

toBoxType :: proxy Track -> BoxType

IsBox DataEntryUrn

Associated Types

type BoxContent DataEntryUrn :: *

Methods

toBoxType :: proxy DataEntryUrn -> BoxType

IsBox DataEntryUrl

Associated Types

type BoxContent DataEntryUrl :: *

Methods

toBoxType :: proxy DataEntryUrl -> BoxType

IsBox DataReference

Associated Types

type BoxContent DataReference :: *

Methods

toBoxType :: proxy DataReference -> BoxType

IsBox Handler

Associated Types

type BoxContent Handler :: *

Methods

toBoxType :: proxy Handler -> BoxType

IsBox ProgressiveDownload

Associated Types

type BoxContent ProgressiveDownload :: *

Methods

toBoxType :: proxy ProgressiveDownload -> BoxType

IsBox NullMediaHeader

Associated Types

type BoxContent NullMediaHeader :: *

Methods

toBoxType :: proxy NullMediaHeader -> BoxType

IsBox HintMediaHeader

Associated Types

type BoxContent HintMediaHeader :: *

Methods

toBoxType :: proxy HintMediaHeader -> BoxType

IsBox SoundMediaHeader

Associated Types

type BoxContent SoundMediaHeader :: *

Methods

toBoxType :: proxy SoundMediaHeader -> BoxType

IsBox VideoMediaHeader

Associated Types

type BoxContent VideoMediaHeader :: *

Methods

toBoxType :: proxy VideoMediaHeader -> BoxType

IsBox b => IsBox (Box b)

Associated Types

type BoxContent (Box b) :: *

Methods

toBoxType :: proxy (Box b) -> BoxType

IsBox (MediaHeader v)

Associated Types

type BoxContent (MediaHeader v) :: *

Methods

toBoxType :: proxy (MediaHeader v) -> BoxType

IsBox (MovieHeader version)

Associated Types

type BoxContent (MovieHeader version) :: *

Methods

toBoxType :: proxy (MovieHeader version) -> BoxType

IsBox (TrackHeader version)

Associated Types

type BoxContent (TrackHeader version) :: *

Methods

toBoxType :: proxy (TrackHeader version) -> BoxType

IsBox b => IsBox (ContainerBox b bs)

Associated Types

type BoxContent (ContainerBox b bs) :: *

Methods

toBoxType :: proxy (ContainerBox b bs) -> BoxType

(KnownNat v, IsBox t) => IsBox (FullBox t v)

Associated Types

type BoxContent (FullBox t v) :: *

Methods

toBoxType :: proxy (FullBox t v) -> BoxType

type family BoxTypeSymbol t :: Symbol

A type family used by the type-level consistency checks. It is required that an instance of this type family exists for every IsBox instance. This family could not be associative since it is used by type families that cannot have type class constraints.

Instances

type BoxTypeSymbol DataInformation

type BoxTypeSymbol DataInformation = "dinf"

type BoxTypeSymbol FileType

type BoxTypeSymbol FileType = "ftyp"

type BoxTypeSymbol Media

type BoxTypeSymbol Media = "mdia"

type BoxTypeSymbol MediaData

type BoxTypeSymbol MediaData = "mdat"

type BoxTypeSymbol MediaInformation

type BoxTypeSymbol MediaInformation = "minf"

type BoxTypeSymbol Movie

type BoxTypeSymbol Movie = "moov"

type BoxTypeSymbol Skip

type BoxTypeSymbol Skip = "skip"

type BoxTypeSymbol Track

type BoxTypeSymbol Track = "trak"

type BoxTypeSymbol DataEntryUrn

type BoxTypeSymbol DataEntryUrn = "urn "

type BoxTypeSymbol DataEntryUrl

type BoxTypeSymbol DataEntryUrl = "urn "

type BoxTypeSymbol DataReference

type BoxTypeSymbol DataReference = "dref"

type BoxTypeSymbol Handler

type BoxTypeSymbol Handler = "hdlr"

type BoxTypeSymbol ProgressiveDownload

type BoxTypeSymbol ProgressiveDownload = "pdin"

type BoxTypeSymbol NullMediaHeader

type BoxTypeSymbol NullMediaHeader = "nmhd"

type BoxTypeSymbol HintMediaHeader

type BoxTypeSymbol HintMediaHeader = "hmhd"

type BoxTypeSymbol SoundMediaHeader

type BoxTypeSymbol SoundMediaHeader = "smhd"

type BoxTypeSymbol VideoMediaHeader

type BoxTypeSymbol VideoMediaHeader = "vmhd"

type BoxTypeSymbol (Box b)

type BoxTypeSymbol (Box b) = BoxTypeSymbol b

type BoxTypeSymbol (MediaHeader v)

type BoxTypeSymbol (MediaHeader v) = "mdhd"

type BoxTypeSymbol (MovieHeader v)

type BoxTypeSymbol (MovieHeader v) = "mvhd"

type BoxTypeSymbol (TrackHeader version)

type BoxTypeSymbol (TrackHeader version) = "tkhd"

type BoxTypeSymbol (ContainerBox b bs)

type BoxTypeSymbol (ContainerBox b bs) = BoxTypeSymbol b

type BoxTypeSymbol (FullBox t v)

type BoxTypeSymbol (FullBox t v) = BoxTypeSymbol t

class IsBoxContent a where

Types that go into a box. A box content is a piece of data that can be reused in different instances of IsBox. It has no BoxType and hence defines no box.

Minimal complete definition

boxSize, boxBuilder

Methods

boxSize :: a -> BoxSize

boxBuilder :: a -> Builder

Instances

IsBoxContent ()

An empty box content can by represented by () (i.e. unit).

Methods

boxSize :: () -> BoxSize

boxBuilder :: () -> Builder

IsBoxContent ByteString

Trivial instance for ByteString

Methods

boxSize :: ByteString -> BoxSize

boxBuilder :: ByteString -> Builder

IsBoxContent Text

This Text instance writes a null terminated UTF-8 string.

Methods

boxSize :: Text -> BoxSize

boxBuilder :: Text -> Builder

IsBoxContent BoxTypeExtension

Methods

boxSize :: BoxTypeExtension -> BoxSize

boxBuilder :: BoxTypeExtension -> Builder

IsBoxContent FourCc

Methods

boxSize :: FourCc -> BoxSize

boxBuilder :: FourCc -> Builder

IsBoxContent BoxType

Methods

boxSize :: BoxType -> BoxSize

boxBuilder :: BoxType -> Builder

IsBoxContent BoxSizeExtension

Methods

boxSize :: BoxSizeExtension -> BoxSize

boxBuilder :: BoxSizeExtension -> Builder

IsBoxContent BoxSize

Methods

boxSize :: BoxSize -> BoxSize

boxBuilder :: BoxSize -> Builder

IsBoxContent FileType

Methods

boxSize :: FileType -> BoxSize

boxBuilder :: FileType -> Builder

IsBoxContent MediaData

Methods

boxSize :: MediaData -> BoxSize

boxBuilder :: MediaData -> Builder

IsBoxContent Language

Methods

boxSize :: Language -> BoxSize

boxBuilder :: Language -> Builder

IsBoxContent Skip

Methods

boxSize :: Skip -> BoxSize

boxBuilder :: Skip -> Builder

IsBoxContent DataEntryUrn

Methods

boxSize :: DataEntryUrn -> BoxSize

boxBuilder :: DataEntryUrn -> Builder

IsBoxContent DataEntryUrl

Methods

boxSize :: DataEntryUrl -> BoxSize

boxBuilder :: DataEntryUrl -> Builder

IsBoxContent DataReference

Methods

boxSize :: DataReference -> BoxSize

boxBuilder :: DataReference -> Builder

IsBoxContent HandlerType

Methods

boxSize :: HandlerType -> BoxSize

boxBuilder :: HandlerType -> Builder

IsBoxContent Handler

Methods

boxSize :: Handler -> BoxSize

boxBuilder :: Handler -> Builder

IsBoxContent NullMediaHeader

Methods

boxSize :: NullMediaHeader -> BoxSize

boxBuilder :: NullMediaHeader -> Builder

IsBoxContent HintMediaHeader

Methods

boxSize :: HintMediaHeader -> BoxSize

boxBuilder :: HintMediaHeader -> Builder

IsBoxContent SoundMediaHeader

Methods

boxSize :: SoundMediaHeader -> BoxSize

boxBuilder :: SoundMediaHeader -> Builder

IsBoxContent VideoMediaHeader

Methods

boxSize :: VideoMediaHeader -> BoxSize

boxBuilder :: VideoMediaHeader -> Builder

IsBoxContent a => IsBoxContent (Maybe a)

This instance writes zero bytes for Nothing and delegates on Just.

Methods

boxSize :: Maybe a -> BoxSize

boxBuilder :: Maybe a -> Builder

IsBoxContent (Boxes bs)

Methods

boxSize :: Boxes bs -> BoxSize

boxBuilder :: Boxes bs -> Builder

IsBoxContent (Box cnt)

Methods

boxSize :: Box cnt -> BoxSize

boxBuilder :: Box cnt -> Builder

IsBoxContent (ApplyVersioned c)

Methods

boxSize :: ApplyVersioned c -> BoxSize

boxBuilder :: ApplyVersioned c -> Builder

IsBoxContent (MediaHeader v)

Methods

boxSize :: MediaHeader v -> BoxSize

boxBuilder :: MediaHeader v -> Builder

IsBoxContent (MovieHeader version)

Methods

boxSize :: MovieHeader version -> BoxSize

boxBuilder :: MovieHeader version -> Builder

IsBoxContent (TrackHeader version)

Methods

boxSize :: TrackHeader version -> BoxSize

boxBuilder :: TrackHeader version -> Builder

(IsBoxContent p, IsBoxContent c) => IsBoxContent ((:+) p c)

Methods

boxSize :: (p :+ c) -> BoxSize

boxBuilder :: (p :+ c) -> Builder

IsBoxContent (ContainerBox b bs)

Methods

boxSize :: ContainerBox b bs -> BoxSize

boxBuilder :: ContainerBox b bs -> Builder

KnownNat bits => IsBoxContent (BoxFlags Nat bits)

Get the number of bytes required to store a number of bits.

Methods

boxSize :: BoxFlags Nat bits -> BoxSize

boxBuilder :: BoxFlags Nat bits -> Builder

(IsBox t, KnownNat v) => IsBoxContent (FullBox t v)

Methods

boxSize :: FullBox t v -> BoxSize

boxBuilder :: FullBox t v -> Builder

IsBoxContent (Versioned v0 v1 version)

Methods

boxSize :: Versioned v0 v1 version -> BoxSize

boxBuilder :: Versioned v0 v1 version -> Builder

(IsBoxContent o, FromTypeLit k o v) => IsBoxContent (Template k o v)

Methods

boxSize :: Template k o v -> BoxSize

boxBuilder :: Template k o v -> Builder

IsBoxContent (Scalar k Int64 label)

Methods

boxSize :: Scalar k Int64 label -> BoxSize

boxBuilder :: Scalar k Int64 label -> Builder

IsBoxContent (Scalar k Int32 label)

Methods

boxSize :: Scalar k Int32 label -> BoxSize

boxBuilder :: Scalar k Int32 label -> Builder

IsBoxContent (Scalar k Int16 label)

Methods

boxSize :: Scalar k Int16 label -> BoxSize

boxBuilder :: Scalar k Int16 label -> Builder

IsBoxContent (Scalar k Int8 label)

Methods

boxSize :: Scalar k Int8 label -> BoxSize

boxBuilder :: Scalar k Int8 label -> Builder

IsBoxContent (Scalar k Word64 label)

Methods

boxSize :: Scalar k Word64 label -> BoxSize

boxBuilder :: Scalar k Word64 label -> Builder

IsBoxContent (Scalar k Word32 label)

Methods

boxSize :: Scalar k Word32 label -> BoxSize

boxBuilder :: Scalar k Word32 label -> Builder

IsBoxContent (Scalar k Word16 label)

Methods

boxSize :: Scalar k Word16 label -> BoxSize

boxBuilder :: Scalar k Word16 label -> Builder

IsBoxContent (Scalar k Word8 label)

Methods

boxSize :: Scalar k Word8 label -> BoxSize

boxBuilder :: Scalar k Word8 label -> Builder

(IsBoxContent o, FromTypeLit k o v) => IsBoxContent (Constant * k o v)

Methods

boxSize :: Constant * k o v -> BoxSize

boxBuilder :: Constant * k o v -> Builder

(Num o, IsBoxContent (Scalar k o label), KnownNat len) => IsBoxContent (ScalarArray k label len o)

Methods

boxSize :: ScalarArray k label len o -> BoxSize

boxBuilder :: ScalarArray k label len o -> Builder

Data types

data Box b where

A type that wraps the contents of a box and the box type.

Constructors

Box :: IsBox b => BoxContent b -> Box b

Instances

IsBoxContent (Box cnt)

Methods

boxSize :: Box cnt -> BoxSize

boxBuilder :: Box cnt -> Builder

IsBox b => IsBox (Box b)

Associated Types

type BoxContent (Box b) :: *

Methods

toBoxType :: proxy (Box b) -> BoxType

type BoxTypeSymbol (Box b)

type BoxTypeSymbol (Box b) = BoxTypeSymbol b

type BoxContent (Box b)

type BoxContent (Box b) = BoxContent b

type IsRuleConform * * (Box b) (Box r)

type IsRuleConform * * (Box b) (Box r) = (==) Symbol (BoxTypeSymbol b) (BoxTypeSymbol r)

type IsRuleConform * * (Box b) (ContainerBox b' rules)

type IsRuleConform * * (Box b) (ContainerBox b' rules) = (&&) (IsContainerBox b) ((&&) (IsRuleConform * * (Box b) (Box b')) (IsRuleConform * * (ChildBoxes b) (Boxes rules)))

data ContainerBox b bs where

Compose BoxContent and Boxes under the Constraint that they are composable.

Constructors

ContainerBox :: IsBox b => BoxContent b -> Boxes bs -> ContainerBox b bs

Instances

IsBoxContent (ContainerBox b bs)

Methods

boxSize :: ContainerBox b bs -> BoxSize

boxBuilder :: ContainerBox b bs -> Builder

IsBox b => IsBox (ContainerBox b bs)

Associated Types

type BoxContent (ContainerBox b bs) :: *

Methods

toBoxType :: proxy (ContainerBox b bs) -> BoxType

type IsRuleConform * * (Box b) (ContainerBox b' rules)

type IsRuleConform * * (Box b) (ContainerBox b' rules) = (&&) (IsContainerBox b) ((&&) (IsRuleConform * * (Box b) (Box b')) (IsRuleConform * * (ChildBoxes b) (Boxes rules)))

type BoxTypeSymbol (ContainerBox b bs)

type BoxTypeSymbol (ContainerBox b bs) = BoxTypeSymbol b

type BoxContent (ContainerBox b bs)

type BoxContent (ContainerBox b bs) = ContainerBox b bs

data Boxes boxTypes where

A heterogenous collection of boxes.

Constructors

NoBoxes :: Boxes '[]

(:.) :: Box l -> Boxes r -> Boxes (Box l ': r) infixr 2

(:<>) :: Boxes l -> Boxes r -> Boxes (l :++ r) infixr 1

Create a Boxes collection from two Boxes

(:|) :: Box l -> Box r -> Boxes '[Box l, Box r] infixr 2

Instances

IsBoxContent (Boxes bs)

Methods

boxSize :: Boxes bs -> BoxSize

boxBuilder :: Boxes bs -> Builder

type IsRuleConform * * (Boxes bs) (Boxes rs)

type IsRuleConform * * (Boxes bs) (Boxes rs) = IsRuleConform [Type] [Type] bs rs

($:) :: (Boxes '[Box l] -> r) -> Box l -> r infixr 3

Apply a function to a Boxes collection containing only a single Box.

singletonBox :: Box l -> Boxes '[Box l]

Create a Boxes collection with a single Box.

typeListLength :: forall a proxy ts. (KnownNat (Length ts), Num a) => proxy ts -> a

Get the elements in a type level array

containerBox :: IsBox t => BoxContent t -> Boxes ts -> Box (ContainerBox t ts)

A box that contains no fields, but nested boxes.

Box Size and Type

data BoxSize

The size of the box. If the size is limited to a (fixed) value, it can be provided as a Word64 which will be represented as either a 32bit compact size or as 64 bit largesize. If UnlimitedSize is used, the box extends to the end of the file.

Constructors

UnlimitedSize

BoxSize Word64

Instances

Eq BoxSize

Methods

(==) :: BoxSize -> BoxSize -> Bool

(/=) :: BoxSize -> BoxSize -> Bool

Num BoxSize

Methods

(+) :: BoxSize -> BoxSize -> BoxSize

(-) :: BoxSize -> BoxSize -> BoxSize

(*) :: BoxSize -> BoxSize -> BoxSize

negate :: BoxSize -> BoxSize

abs :: BoxSize -> BoxSize

signum :: BoxSize -> BoxSize

fromInteger :: Integer -> BoxSize

Show BoxSize

Methods

showsPrec :: Int -> BoxSize -> ShowS

show :: BoxSize -> String

showList :: [BoxSize] -> ShowS

IsBoxContent BoxSize

Methods

boxSize :: BoxSize -> BoxSize

boxBuilder :: BoxSize -> Builder

data BoxSizeExtension

The BoxSize can be > 2^32 in which case an BoxSizeExtension must be added after the type field.

Constructors

BoxSizeExtension BoxSize

Instances

IsBoxContent BoxSizeExtension

Methods

boxSize :: BoxSizeExtension -> BoxSize

boxBuilder :: BoxSizeExtension -> Builder

data BoxType

A box has a type, this is the value level representation for the box type.

Constructors

StdType FourCc

FourCc can be used as boxType in Box, standard four letter character code, e.g. ftyp

CustomBoxType String

CustomBoxType defines custom boxTypes in Boxes.

Instances

Eq BoxType

Methods

(==) :: BoxType -> BoxType -> Bool

(/=) :: BoxType -> BoxType -> Bool

Show BoxType

Methods

showsPrec :: Int -> BoxType -> ShowS

show :: BoxType -> String

showList :: [BoxType] -> ShowS

IsBoxContent BoxType

Methods

boxSize :: BoxType -> BoxSize

boxBuilder :: BoxType -> Builder

parseBoxType :: KnownSymbol t => proxy t -> BoxType

Create a box type from a Symbol. Parse the symbol value, if it's a four charachter code, then return that as StdType otherwise parse a UUID (TODO) and return a CustomBoxType.

newtype FourCc

A type containin a printable four letter character code.

Constructors

FourCc (Char, Char, Char, Char)

Instances

Eq FourCc

Methods

(==) :: FourCc -> FourCc -> Bool

(/=) :: FourCc -> FourCc -> Bool

Show FourCc

Methods

showsPrec :: Int -> FourCc -> ShowS

show :: FourCc -> String

showList :: [FourCc] -> ShowS

IsString FourCc

Methods

fromString :: String -> FourCc

IsBoxContent FourCc

Methods

boxSize :: FourCc -> BoxSize

boxBuilder :: FourCc -> Builder

data BoxTypeExtension

When using custom types extra data must be written after the extra size information. Since the box type and the optional custom box type are not guaranteed to be consequtive, this type handles the second part seperately.

Constructors

BoxTypeExtension BoxType

Instances

IsBoxContent BoxTypeExtension

Methods

boxSize :: BoxTypeExtension -> BoxSize

boxBuilder :: BoxTypeExtension -> Builder

IsBoxContent instances

Box concatenation

data a :+ b infixr 3

Box content composition

Constructors

a :+ b infixr 3

Instances

(Default a, Default b) => Default ((:+) a b)

Methods

def :: a :+ b

(IsBoxContent p, IsBoxContent c) => IsBoxContent ((:+) p c)

Methods

boxSize :: (p :+ c) -> BoxSize

boxBuilder :: (p :+ c) -> Builder

Type Layout Rule Matchers

type OM b bs = ContainerBox b bs

Mandatory, container box, exactly one

type OO b bs = OnceOptionalX (ContainerBox b bs)

Optional, container box, zero or one

type SM b bs = SomeMandatoryX (ContainerBox b bs)

Mandatory, container box, one or more

type SO b bs = SomeOptionalX (ContainerBox b bs)

Optional, container box, zero or more

type OM_ b = Box b

Mandatory, exactly one, no children

type OO_ b = OnceOptionalX (Box b)

Optional, zero or one, no children

type SM_ b = SomeMandatoryX (Box b)

Mandatory, one or more, no children

type SO_ b = SomeOptionalX (Box b)

Optional, zero or more, no children

type family IsContainerBox t :: Bool where ...

Equations

IsContainerBox (ContainerBox a as) = True

IsContainerBox b = False

type family ChildBoxes c where ...

Equations

ChildBoxes (ContainerBox a as) = Boxes as