Data.MediaBus.Media.Reframe

This module contains functions and types for reframing the sequence number and timestamps of Frames.

This means that this module will allow you to record a set of incoming frames using pushFrame. Whenever you want to extract the timing and sequence number information of the next frame with a given duration, use generateFrame.

Documentation

initialReframerState :: (Num d, Num s) => ReframerSt s d

Create an empty initial state.

runReframer :: Monad m => ReframerT m s d a -> ReframerSt s d -> m (a, ReframerSt s d)

Run state ReframerSt state transformer.

pushStartFrame :: (Num d, Monad m) => d -> ReframerT m s d ()

Reset the current timing and sequence number, and start with the given start time.

pushFrame :: (Num d, Monad m, Eq d, Ord d) => Frame s d d -> ReframerT m s d (Maybe PushFrameError)

Increase the available duration by the duration in the frame, iff the timestamp of the given frame matches exactly the timestamp after the end of the available period, otherwise do nothing with the state and return True.

data PushFrameError

Specifies in what way pushFrame failed

Constructors

InputFrameIsLate

The input frame ends before $sel:_endTs:MkTimeFrame

InputFrameOverlaps

The input frame starts before, and ends after $sel:_endTs:MkTimeFrame

InputFrameIsEarly

The input frame begins after $sel:_endTs:MkTimeFrame

Instances

Enum PushFrameError

Methods

succ :: PushFrameError -> PushFrameError

pred :: PushFrameError -> PushFrameError

toEnum :: Int -> PushFrameError

fromEnum :: PushFrameError -> Int

enumFrom :: PushFrameError -> [PushFrameError]

enumFromThen :: PushFrameError -> PushFrameError -> [PushFrameError]

enumFromTo :: PushFrameError -> PushFrameError -> [PushFrameError]

enumFromThenTo :: PushFrameError -> PushFrameError -> PushFrameError -> [PushFrameError]

Eq PushFrameError

Methods

(==) :: PushFrameError -> PushFrameError -> Bool

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

Ord PushFrameError

Methods

compare :: PushFrameError -> PushFrameError -> Ordering

(<) :: PushFrameError -> PushFrameError -> Bool

(<=) :: PushFrameError -> PushFrameError -> Bool

(>) :: PushFrameError -> PushFrameError -> Bool

(>=) :: PushFrameError -> PushFrameError -> Bool

max :: PushFrameError -> PushFrameError -> PushFrameError

min :: PushFrameError -> PushFrameError -> PushFrameError

Show PushFrameError

Methods

showsPrec :: Int -> PushFrameError -> ShowS

show :: PushFrameError -> String

showList :: [PushFrameError] -> ShowS

nextFrameAvailableDuration :: (Num d, Monad m) => ReframerT m s d d

Return the duration of the frames recorded with pushFrame.

nextFrameTimestamp :: (Num d, Monad m) => ReframerT m s d d

Return the timestamp of the frame being build. .

generateFrame :: (Num s, Num d, Monad m, Eq d, Ord d, Show d) => d -> ReframerT m s d (Frame s d d)

Try to create a frame with the given duration, and update the state accordingly, the actual duration, that was available is put into the payload field of the frame returned. The start time stamp of the next frame is always incremented by the wantedDureation regardless of wether it was available.

type ReframerT m s d a = StateT (ReframerSt s d) m a

The ReframerSt StateT transformer

data ReframerSt s d

Reframer state.

Instances

(Show s, Show d) => Show (ReframerSt s d)

Methods

showsPrec :: Int -> ReframerSt s d -> ShowS

show :: ReframerSt s d -> String

showList :: [ReframerSt s d] -> ShowS

data ReframeError s d

The exception type for encodeLinearToAacC

Constructors

MkReframeError String (Maybe d) (ReframerSt s d)

Instances

(Show s, Show d) => Show (ReframeError s d)

Methods

showsPrec :: Int -> ReframeError s d -> ShowS

show :: ReframeError s d -> String

showList :: [ReframeError s d] -> ShowS

(Show s, Typeable * s, Show d, Typeable * d) => Exception (ReframeError s d)

Methods

toException :: ReframeError s d -> SomeException

fromException :: SomeException -> Maybe (ReframeError s d)

displayException :: ReframeError s d -> String

mkReFrameError :: Monad m => String -> Maybe d -> ReframerT m s d (ReframeError s d)

Utility function to generate a ReframeError with the current state.