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 IsBoxContent (BoxContent t) => IsBoxType t where

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

Minimal complete definition

toBoxType

Associated Types

type BoxContent t

Methods

toBoxType :: proxy t -> BoxContent t -> BoxType

Instances

IsBoxType * FileType

File Type Box

Associated Types

type BoxContent FileType (t :: FileType) :: *

Methods

toBoxType :: proxy t -> BoxContent FileType t -> BoxType

IsBoxType * Handler

Associated Types

type BoxContent Handler (t :: Handler) :: *

Methods

toBoxType :: proxy t -> BoxContent Handler t -> BoxType

IsBoxType * Media

Associated Types

type BoxContent Media (t :: Media) :: *

Methods

toBoxType :: proxy t -> BoxContent Media t -> BoxType

IsBoxType * MediaData

Associated Types

type BoxContent MediaData (t :: MediaData) :: *

Methods

toBoxType :: proxy t -> BoxContent MediaData t -> BoxType

IsBoxType * MediaInformation

Associated Types

type BoxContent MediaInformation (t :: MediaInformation) :: *

Methods

toBoxType :: proxy t -> BoxContent MediaInformation t -> BoxType

IsBoxType * Movie

Associated Types

type BoxContent Movie (t :: Movie) :: *

Methods

toBoxType :: proxy t -> BoxContent Movie t -> BoxType

IsBoxType * ProgressiveDownload

Associated Types

type BoxContent ProgressiveDownload (t :: ProgressiveDownload) :: *

Methods

toBoxType :: proxy t -> BoxContent ProgressiveDownload t -> BoxType

IsBoxType * Skip

Associated Types

type BoxContent Skip (t :: Skip) :: *

Methods

toBoxType :: proxy t -> BoxContent Skip t -> BoxType

IsBoxType * SpecificMediaHeader

Associated Types

type BoxContent SpecificMediaHeader (t :: SpecificMediaHeader) :: *

Methods

toBoxType :: proxy t -> BoxContent SpecificMediaHeader t -> BoxType

IsBoxType * Track

Associated Types

type BoxContent Track (t :: Track) :: *

Methods

toBoxType :: proxy t -> BoxContent Track t -> BoxType

KnownNat v => IsBoxType * (MediaHeader v)

Associated Types

type BoxContent (MediaHeader v) (t :: MediaHeader v) :: *

Methods

toBoxType :: proxy t -> BoxContent (MediaHeader v) t -> BoxType

KnownNat version => IsBoxType * (MovieHeader version)

Associated Types

type BoxContent (MovieHeader version) (t :: MovieHeader version) :: *

Methods

toBoxType :: proxy t -> BoxContent (MovieHeader version) t -> BoxType

KnownNat version => IsBoxType * (TrackHeader version)

Associated Types

type BoxContent (TrackHeader version) (t :: TrackHeader version) :: *

Methods

toBoxType :: proxy t -> BoxContent (TrackHeader version) t -> BoxType

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 HandlerType

Methods

boxSize :: HandlerType -> BoxSize

boxBuilder :: HandlerType -> Builder

IsBoxContent Handler

Methods

boxSize :: Handler -> BoxSize

boxBuilder :: Handler -> Builder

IsBoxContent Language

Methods

boxSize :: Language -> BoxSize

boxBuilder :: Language -> Builder

IsBoxContent Skip

Methods

boxSize :: Skip -> BoxSize

boxBuilder :: Skip -> Builder

IsBoxContent SpecificMediaHeader

Methods

boxSize :: SpecificMediaHeader -> BoxSize

boxBuilder :: SpecificMediaHeader -> 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 (Boxes brand bs)

Methods

boxSize :: Boxes brand bs -> BoxSize

boxBuilder :: Boxes brand bs -> Builder

IsBoxContent (Box brand cnt)

Methods

boxSize :: Box brand cnt -> BoxSize

boxBuilder :: Box brand cnt -> Builder

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

Methods

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

boxBuilder :: (p :+ c) -> 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

(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

(KnownNat version, IsBoxContent t) => IsBoxContent (FullBox Nat version t)

Methods

boxSize :: FullBox Nat version t -> BoxSize

boxBuilder :: FullBox Nat version t -> 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 (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 brand b where

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

Constructors

Box :: (IsBoxType b, IsBrandConform brand (Just b) ts) => BoxContent b -> Boxes brand ts -> Box brand b

Instances

IsBoxContent (Box brand cnt)

Methods

boxSize :: Box brand cnt -> BoxSize

boxBuilder :: Box brand cnt -> Builder

data Boxes brand boxTypes where

A heterogenous collection of boxes.

Constructors

NoBoxes :: Boxes brand '[]

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

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

Create a Boxes collection from two Boxes

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

Instances

IsBoxContent (Boxes brand bs)

Methods

boxSize :: Boxes brand bs -> BoxSize

boxBuilder :: Boxes brand bs -> Builder

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

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

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

Create a Boxes collection with a single Box.

closedBox :: (IsBoxType t, IsBrandConform brand (Just t) '[]) => BoxContent t -> Box brand t

A box that contains no nested boxes.

containerBox :: (IsBoxType t, IsBrandConform brand (Just t) ts, BoxContent t ~ ()) => Boxes brand ts -> Box brand t

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

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