Data.ByteString.IsoBaseFileFormat.Boxes.FullBox

Full Boxes

Documentation

data FullBox version t 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 :: BoxVersion version -> BoxFlags 24 -> t -> FullBox version t

Instances

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

Methods

boxSize :: FullBox Nat version t -> BoxSize

boxBuilder :: FullBox Nat version t -> Builder

fullBox :: (IsBoxType t, ValidContainerBox brand t ts, BoxContent t ~ FullBox version c) => BoxVersion version -> BoxFlags 24 -> c -> Boxes brand ts -> Box brand t

Create a FullBox from a BoxVersion and BoxFlags

closedFullBox :: (IsBoxType t, ValidBox brand t, BoxContent t ~ FullBox version c) => BoxVersion version -> BoxFlags 24 -> c -> Box brand t

Create a FullBox from a BoxVersion and BoxFlags without nested boxes.

type BoxVersion v = Template (U8 "fullbox-version") v

The box version (in a FullBox) is a single byte

newtype BoxFlags bits

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

Constructors

BoxFlags Integer

Instances

Eq (BoxFlags k bits)

Methods

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

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

Num (BoxFlags k bits)

Methods

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

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

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

negate :: BoxFlags k bits -> BoxFlags k bits

abs :: BoxFlags k bits -> BoxFlags k bits

signum :: BoxFlags k bits -> BoxFlags k bits

fromInteger :: Integer -> BoxFlags k bits

Show (BoxFlags k bits)

Methods

showsPrec :: Int -> BoxFlags k bits -> ShowS

show :: BoxFlags k bits -> String

showList :: [BoxFlags k bits] -> ShowS

KnownNat bits => Bits (BoxFlags Nat bits)

Methods

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

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

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

complement :: BoxFlags Nat bits -> BoxFlags Nat bits

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

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

zeroBits :: BoxFlags Nat bits

bit :: Int -> BoxFlags Nat bits

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

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

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

testBit :: BoxFlags Nat bits -> Int -> Bool

bitSizeMaybe :: BoxFlags Nat bits -> Maybe Int

bitSize :: BoxFlags Nat bits -> Int

isSigned :: BoxFlags Nat bits -> Bool

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

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

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

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

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

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

popCount :: BoxFlags Nat bits -> Int

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