Data.ByteString.IsoBaseFileFormat.Util.FullBox

Full Boxes

Documentation

data FullBox t (version :: Nat) where

A FullBox contains an extra version and a flags field. In this implementation it is wrapped around the rest of the box content. This enforces that the FullBox header fields are always at the beginning - at least as long as this module hides the FullBox constructor ;)

Constructors

FullBox :: (KnownNat version, IsBox t) => !(BoxFlags 24) -> !(BoxContent t) -> FullBox t version

Instances

(KnownNat version, IsBox t, Default (BoxContent t)) => Default (FullBox t version)

Defined in Data.ByteString.IsoBaseFileFormat.Util.FullBox

Methods

def :: FullBox t version

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

Defined in Data.ByteString.IsoBaseFileFormat.Util.FullBox

Methods

boxSize :: FullBox t v -> BoxSize

boxBuilder :: FullBox t v -> Builder

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

Defined in Data.ByteString.IsoBaseFileFormat.Util.FullBox

Associated Types

type BoxContent (FullBox t v) :: Type

Methods

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

type BoxTypeSymbol (FullBox t v :: Type)

Defined in Data.ByteString.IsoBaseFileFormat.Util.FullBox

type BoxTypeSymbol (FullBox t v :: Type) = BoxTypeSymbol t

type BoxContent (FullBox t v)

Defined in Data.ByteString.IsoBaseFileFormat.Util.FullBox

type BoxContent (FullBox t v) = FullBox t v

fullBox :: (KnownNat v, IsBox t) => BoxFlags 24 -> BoxContent t -> Box (FullBox t v)

Create a FullBox from a BoxVersion and BoxFlags

newtype BoxFlags bits

In addition to a version there can be 24 bits for custom flags etc in a FullBox.

Constructors

BoxFlags Integer

Instances

Eq (BoxFlags bits)

Defined in Data.ByteString.IsoBaseFileFormat.Util.FullBox

Methods

(==) :: BoxFlags bits -> BoxFlags bits -> Bool

(/=) :: BoxFlags bits -> BoxFlags bits -> Bool

Num (BoxFlags bits)

Defined in Data.ByteString.IsoBaseFileFormat.Util.FullBox

Methods

(+) :: BoxFlags bits -> BoxFlags bits -> BoxFlags bits

(-) :: BoxFlags bits -> BoxFlags bits -> BoxFlags bits

(*) :: BoxFlags bits -> BoxFlags bits -> BoxFlags bits

negate :: BoxFlags bits -> BoxFlags bits

abs :: BoxFlags bits -> BoxFlags bits

signum :: BoxFlags bits -> BoxFlags bits

fromInteger :: Integer -> BoxFlags bits

Show (BoxFlags bits)

Defined in Data.ByteString.IsoBaseFileFormat.Util.FullBox

Methods

showsPrec :: Int -> BoxFlags bits -> ShowS

show :: BoxFlags bits -> String

showList :: [BoxFlags bits] -> ShowS

KnownNat bits => Bits (BoxFlags bits)

Defined in Data.ByteString.IsoBaseFileFormat.Util.FullBox

Methods

(.&.) :: BoxFlags bits -> BoxFlags bits -> BoxFlags bits

(.|.) :: BoxFlags bits -> BoxFlags bits -> BoxFlags bits

xor :: BoxFlags bits -> BoxFlags bits -> BoxFlags bits

complement :: BoxFlags bits -> BoxFlags bits

shift :: BoxFlags bits -> Int -> BoxFlags bits

rotate :: BoxFlags bits -> Int -> BoxFlags bits

zeroBits :: BoxFlags bits

bit :: Int -> BoxFlags bits

setBit :: BoxFlags bits -> Int -> BoxFlags bits

clearBit :: BoxFlags bits -> Int -> BoxFlags bits

complementBit :: BoxFlags bits -> Int -> BoxFlags bits

testBit :: BoxFlags bits -> Int -> Bool

bitSizeMaybe :: BoxFlags bits -> Maybe Int

bitSize :: BoxFlags bits -> Int

isSigned :: BoxFlags bits -> Bool

shiftL :: BoxFlags bits -> Int -> BoxFlags bits

unsafeShiftL :: BoxFlags bits -> Int -> BoxFlags bits

shiftR :: BoxFlags bits -> Int -> BoxFlags bits

unsafeShiftR :: BoxFlags bits -> Int -> BoxFlags bits

rotateL :: BoxFlags bits -> Int -> BoxFlags bits

rotateR :: BoxFlags bits -> Int -> BoxFlags bits

popCount :: BoxFlags bits -> Int

KnownNat bits => IsBoxContent (BoxFlags bits)

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

Defined in Data.ByteString.IsoBaseFileFormat.Util.FullBox

Methods

boxSize :: BoxFlags bits -> BoxSize

boxBuilder :: BoxFlags bits -> Builder