BaseParseFrame

class BaseParseFrame(*args, **kwargs)

Frame (context) data passed to each frame parsing virtual methods. In addition to providing the data to be checked for a valid frame or an already identified frame, it conveys additional metadata or control information from and to the subclass w.r.t. the particular frame in question (rather than global parameters). Some of these may apply to each parsing stage, others only to some a particular one. These parameters are effectively zeroed at start of each frame’s processing, i.e. parsing virtual method invocation sequence.

Constructors

class BaseParseFrame

classmethod new(buffer: Buffer, flags: BaseParseFrameFlags, overhead: int) → BaseParseFrame

Allocates a new BaseParseFrame. This function is mainly for bindings, elements written in C should usually allocate the frame on the stack and then use init() to initialise it.

Parameters:

• buffer – a Buffer

• flags – the flags

• overhead – number of bytes in this frame which should be counted as metadata overhead, ie. not used to calculate the average bitrate. Set to -1 to mark the entire frame as metadata. If in doubt, set to 0.

Methods

class BaseParseFrame

free() → None

Frees the provided frame.

init() → None

Sets a BaseParseFrame to initial state. Currently this means all public fields are zero-ed and a private flag is set to make sure free() only frees the contents but not the actual frame. Use this function to initialise a BaseParseFrame allocated on the stack.

Fields

class BaseParseFrame

buffer

Input data to be parsed for frames.

flags

A combination of input and output BaseParseFrameFlags that

convey additional context to subclass or allow subclass to tune subsequent BaseParse actions.

offset

Media specific offset of input frame

Note that a converter may have a different one on the frame’s buffer.

out_buffer

Output data.

overhead

Subclass can set this to indicates the metadata overhead

for the given frame, which is then used to enable more accurate bitrate computations. If this is -1, it is assumed that this frame should be skipped in bitrate calculation.

size