Functions ¶

data:: the bit stream generated by the frame header
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.AV1BitWriterResult, data: int, size: int)

Generating the according AV1 bit stream OBU by providing the frame header.

New in version 1.22.

GstCodecParsers.av1_bit_writer_frame_header_obu_with_offsets(frame_hdr, seq_hdr, temporal_id, spatial_id, size_field, size_field_size, size)¶

Parameters:

frame_hdr (GstCodecParsers.AV1FrameHeaderOBU) – the frame header of GstCodecParsers.AV1FrameHeaderOBU to write
seq_hdr (GstCodecParsers.AV1SequenceHeaderOBU) – the sequence header of GstCodecParsers.AV1SequenceHeaderOBU to refer
temporal_id (int) – specifies the temporal level of the data contained in the OBU.
spatial_id (int) – specifies the spatial level of the data contained in the OBU.
size_field (bool) – whether the OBU header contains the OBU size.
size_field_size (int) – 0 means a fixed OBU header size field.
size (int) – the size in bytes of the input and output

Returns:

qindex_offset:: return the qindex fields offset in bits.
segmentation_offset:: return the segmentation fields offset in bits.
lf_offset:: return the loopfilter fields offset in bits.
cdef_offset:: return the cdef fields offset in bits.
cdef_size:: return the cdef fields size in bits.
data:: the bit stream generated by the frame header
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.AV1BitWriterResult, qindex_offset: int, segmentation_offset: int, lf_offset: int, cdef_offset: int, cdef_size: int, data: int, size: int)

While Generating the according AV1 bit stream OBU by providing the frame header, this function also return bit offsets of qindex, segmentation and cdef, etc. These offsets can help to change the content of these fields later. This function is useful if the encoder may change the content of the frame header after generating it. For example, some HW needs user to provide a frame header before the real encoding job, and it will change the according fields in the frame header during the real encoding job.

New in version 1.22.

GstCodecParsers.av1_bit_writer_metadata_obu(metadata, temporal_id, spatial_id, size_field, size)¶

Parameters:

metadata (GstCodecParsers.AV1MetadataOBU) – the meta data of GstCodecParsers.AV1MetadataOBU to write
temporal_id (int) – specifies the temporal level of the data contained in the OBU.
spatial_id (int) – specifies the spatial level of the data contained in the OBU.
size_field (bool) – whether the header contain size feild
size (int) – the size in bytes of the input and output

Returns:

data:: the bit stream generated by the meta data
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.AV1BitWriterResult, data: int, size: int)

Generating the according AV1 bit stream OBU by providing the meta data.

New in version 1.22.

GstCodecParsers.av1_bit_writer_sequence_header_obu(seq_hdr, size_field, size)¶

Parameters:

seq_hdr (GstCodecParsers.AV1SequenceHeaderOBU) – the sequence header of GstCodecParsers.AV1SequenceHeaderOBU to write
size_field (bool) – whether the header contain size feild
size (int) – the size in bytes of the input and output

Returns:

data:: the bit stream generated by the sequence header
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.AV1BitWriterResult, data: int, size: int)

Generating the according AV1 bit stream OBU by providing the sequence header.

New in version 1.22.

GstCodecParsers.av1_bit_writer_temporal_delimiter_obu(size_field, size)¶

Parameters:

size_field (bool) – whether the header contain size feild
size (int) – the size in bytes of the input and output

Returns:

GstCodecParsers.LcevcMeta

data:: the bit stream generated
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.AV1BitWriterResult, data: int, size: int)

Generating the according temporal delimiter AV1 bit stream OBU.

New in version 1.22.

GstCodecParsers.buffer_add_lcevc_meta(buffer, enhancement_data)¶

Parameters:

buffer (Gst.Buffer) – a Gst.Buffer
enhancement_data (Gst.Buffer) – the parsed LCEVC enhancement data

Returns:

the GstCodecParsers.LcevcMeta on buffer.

Return type:

Attaches GstCodecParsers.LcevcMeta metadata to buffer.

New in version 1.26.

GstCodecParsers.buffer_add_mpeg_video_meta(buffer, seq_hdr, seq_ext, disp_ext, pic_hdr, pic_ext, quant_ext)¶

Parameters:

buffer (Gst.Buffer) – a Gst.Buffer
seq_hdr (GstCodecParsers.MpegVideoSequenceHdr) – a GstCodecParsers.MpegVideoSequenceHdr
seq_ext (GstCodecParsers.MpegVideoSequenceExt) – a GstCodecParsers.MpegVideoSequenceExt
disp_ext (GstCodecParsers.MpegVideoSequenceDisplayExt) – a GstCodecParsers.MpegVideoSequenceDisplayExt
pic_hdr (GstCodecParsers.MpegVideoPictureHdr) – a GstCodecParsers.MpegVideoPictureHdr
pic_ext (GstCodecParsers.MpegVideoPictureExt) – a GstCodecParsers.MpegVideoPictureExt
quant_ext (GstCodecParsers.MpegVideoQuantMatrixExt) – a GstCodecParsers.MpegVideoQuantMatrixExt

Returns:

a newly created GstCodecParsers.MpegVideoMeta

Return type:

GstCodecParsers.MpegVideoMeta

Creates and adds a GstCodecParsers.MpegVideoMeta to a buffer. Provided structures must either be None or GSlice-allocated.

New in version 1.2.

GstCodecParsers.buffer_get_lcevc_meta(buffer)¶

Parameters:: buffer (Gst.Buffer) – a Gst.Buffer
Returns:: the GstCodecParsers.LcevcMeta with lowest id (usually 0) or None when there is no such metadata on buffer.
Return type:: GstCodecParsers.LcevcMeta or None

Find the GstCodecParsers.LcevcMeta on buffer with the lowest id.

Buffers can contain multiple GstCodecParsers.LcevcMeta metadata items when dealing with multiview buffers.

New in version 1.26.

GstCodecParsers.buffer_get_lcevc_meta_id(buffer, id)¶

Parameters:

buffer (Gst.Buffer) – a Gst.Buffer
id (int) – a metadata id

Returns:

the GstCodecParsers.LcevcMeta with id or None when there is no such metadata on buffer.

Return type:

GstCodecParsers.LcevcMeta or None

Find the GstCodecParsers.LcevcMeta on buffer with the given id.

Buffers can contain multiple GstCodecParsers.LcevcMeta metadata items when dealing with multiview buffers.

New in version 1.26.

GstCodecParsers.h263_parse(packet, data, offset, size)¶

Parameters:

packet (GstCodecParsers.Mpeg4Packet) – The GstCodecParsers.Mpeg4Packet to fill
data (int) – The data to parse
offset (int) – offset from which to start the parsing
size (int) – The size of the data to parse

Returns:

Return type:

Parses data and fills packet with the information of the next packet found.

Note that the type of the packet is meaningless in this case.

GstCodecParsers.h264_bit_writer_aud(primary_pic_type, start_code, size)¶

Parameters:

primary_pic_type (int) – indicate the possible slice types list just as the H264 spec defines
start_code (bool) – whether adding the nal start code
size (int) – the size in bytes of the input and output

Returns:

data:: the bit stream generated by the aud
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.H264BitWriterResult, data: int, size: int)

Generating the according h264 bit stream of an aud.

New in version 1.22.

GstCodecParsers.h264_bit_writer_convert_to_nal(nal_prefix_size, packetized, has_startcode, add_trailings, raw_data, raw_size, nal_size)¶

Parameters:

nal_prefix_size (int) – the size in bytes for the prefix of a nal, may be 2, 3 or 4
packetized (bool) – whether to write the bit stream in packetized format, which does not have the start code but has a nal_prefix_size bytes’ size prepending to the real nal data
has_startcode (bool) – whether the input already has a start code
add_trailings (bool) – whether to add rbsp trailing bits to make the output aligned to byte
raw_data (int) – the input bit stream
raw_size (int) – the size in bits of the input bit stream
nal_size (int) – the size in bytes of the output

Returns:

nal_data:: the output bit stream converted to a real nal
nal_size:: the size in bytes of the output

Return type:

(GstCodecParsers.H264BitWriterResult, nal_data: int, nal_size: int)

Converting a bit stream into a real nal packet. If the bit stream already has a start code, it will be replaced by the new one specified by the nal_prefix_size and packetized. It is assured that the output aligns to the byte and the all the emulations are inserted.

New in version 1.22.

GstCodecParsers.h264_bit_writer_filler(start_code, num, data, size)¶

Parameters:

start_code (bool) – whether adding the nal start code
num (int) – number of filler codes to add
data (int) – bit stream storage
size (int) – size in bytes of the input and output

Returns:

data:: bit stream storage
size:: size in bytes of the input and output

Return type:

(GstCodecParsers.H264BitWriterResult, data: int, size: int)

Generates the according h264 bit stream nal bitstream of a filler with size.

New in version 1.26.

GstCodecParsers.h264_bit_writer_pps(pps, start_code, size)¶

Parameters:

pps (GstCodecParsers.H264PPS) – the pps of GstCodecParsers.H264PPS to write
start_code (bool) – whether adding the nal start code
size (int) – the size in bytes of the input and output

Returns:

data:: the bit stream generated by the pps
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.H264BitWriterResult, data: int, size: int)

Generating the according h264 bit stream by providing the pps.

New in version 1.22.

GstCodecParsers.h264_bit_writer_sei(sei_messages, start_code, size)¶

Parameters:

sei_messages ([GstCodecParsers.H264SEIMessage]) – An array of GstCodecParsers.H264SEIMessage to write
start_code (bool) – whether adding the nal start code
size (int) – the size in bytes of the input and output

Returns:

data:: the bit stream generated by the sei messages
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.H264BitWriterResult, data: int, size: int)

Generating the according h264 bit stream by providing sei messages.

New in version 1.22.

GstCodecParsers.h264_bit_writer_slice_hdr(slice, start_code, nal_type, is_ref, size)¶

Parameters:

slice (GstCodecParsers.H264SliceHdr) – the slice header of GstCodecParsers.H264SliceHdr to write
start_code (bool) – whether adding the nal start code
nal_type (GstCodecParsers.H264NalUnitType) – the slice’s nal type of GstCodecParsers.H264NalUnitType
is_ref (bool) – whether the slice is a reference
size (int) – the size in bytes of the input and output

Returns:

data:: the bit stream generated by the slice header
size:: the size in bytes of the input and output
trail_bits_num:: the trail bits number which is not byte aligned.

Return type:

(GstCodecParsers.H264BitWriterResult, data: int, size: int, trail_bits_num: int)

Generating the according h264 bit stream by providing the slice header.

New in version 1.22.

GstCodecParsers.h264_bit_writer_sps(sps, start_code, size)¶

Parameters:

sps (GstCodecParsers.H264SPS) – the sps of GstCodecParsers.H264SPS to write
start_code (bool) – whether adding the nal start code
size (int) – the size in bytes of the input and output

Returns:

data:: the bit stream generated by the sps
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.H264BitWriterResult, data: int, size: int)

Generating the according h264 bit stream by providing the sps.

New in version 1.22.

GstCodecParsers.h264_create_sei_memory(start_code_prefix_length, messages)¶

Parameters:

start_code_prefix_length (int) – a length of start code prefix, must be 3 or 4
messages ([GstCodecParsers.H264SEIMessage]) – a GLib.Array of GstCodecParsers.H264SEIMessage

Returns:

a Gst.Memory containing a SEI nal unit

Return type:

Creates raw byte-stream format (a.k.a Annex B type) SEI nal unit data from messages

New in version 1.18.

GstCodecParsers.h264_create_sei_memory_avc(nal_length_size, messages)¶

Parameters:

nal_length_size (int) – a size of nal length field, allowed range is [1, 4]
messages ([GstCodecParsers.H264SEIMessage]) – a GLib.Array of GstCodecParsers.H264SEIMessage

Returns:

a Gst.Memory containing a SEI nal unit

Return type:

Creates raw packetized format SEI nal unit data from messages

New in version 1.18.

GstCodecParsers.h264_parse_pps(nalparser, nalu, pps)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
nalu (GstCodecParsers.H264NalUnit) – The GstCodecParsers.H264NalUnitType.PPS GstCodecParsers.H264NalUnit to parse
pps (GstCodecParsers.H264PPS) – The GstCodecParsers.H264PPS to fill.

Returns:

Return type:

Parses data, and fills the pps structure.

The resulting pps data structure shall be deallocated with the GstCodecParsers.H264PPS.clear() function when it is no longer needed, or prior to parsing a new PPS NAL unit.

GstCodecParsers.h264_parse_sps(nalu, sps)¶

Parameters:

nalu (GstCodecParsers.H264NalUnit) – The GstCodecParsers.H264NalUnitType.SPS GstCodecParsers.H264NalUnit to parse
sps (GstCodecParsers.H264SPS) – The GstCodecParsers.H264SPS to fill.

Returns:

Return type:

Parses data, and fills the sps structure.

GstCodecParsers.h264_parse_subset_sps(nalu, sps)¶

Parameters:

nalu (GstCodecParsers.H264NalUnit) – The GstCodecParsers.H264NalUnitType.SUBSET_SPS GstCodecParsers.H264NalUnit to parse
sps (GstCodecParsers.H264SPS) – The GstCodecParsers.H264SPS to fill.

Returns:

Return type:

Parses data, and fills in the sps structure.

This function fully parses data and allocates all the necessary data structures needed for MVC extensions. The resulting sps structure shall be deallocated with GstCodecParsers.H264SPS.clear() when it is no longer needed.

Note: if the caller doesn’t need any of the MVC-specific data, then GstCodecParsers.h264_parser_parse_sps() is more efficient because those extra syntax elements are not parsed and no extra memory is allocated.

New in version 1.6.

GstCodecParsers.h264_parser_identify_and_split_nalu_avc(nalparser, data, offset, size, nal_length_size, nalus)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
data (int) – The data to parse, containing an AVC coded NAL unit
offset (int) – the offset in data from which to parse the NAL unit
size (int) – the size of data
nal_length_size (int) – the size in bytes of the AVC nal length prefix.
nalus ([GstCodecParsers.H264NalUnit]) – a caller allocated GLib.Array of GstCodecParsers.H264NalUnit where to store parsed nal headers

Returns:

consumed:: the size of consumed bytes

Return type:

(GstCodecParsers.H264ParserResult, consumed: int)

Parses data for packetized (e.g., avc/avc3) bitstream and sets nalus. In addition to nal identifying process, this method scans start-code prefix to split malformed packet into actual nal chunks.

New in version 1.22.9.

GstCodecParsers.h264_parser_identify_nalu(nalparser, data, offset, size, nalu)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
data (int) – The data to parse, containing an Annex B coded NAL unit
offset (int) – the offset in data from which to parse the NAL unit
size (int) – the size of data
nalu (GstCodecParsers.H264NalUnit) – The GstCodecParsers.H264NalUnit to store the identified NAL unit in

Returns:

Return type:

Parses the headers of an Annex B coded NAL unit from data and puts the result into nalu.

GstCodecParsers.h264_parser_identify_nalu_avc(nalparser, data, offset, size, nal_length_size, nalu)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
data (int) – The data to parse, containing an AVC coded NAL unit
offset (int) – the offset in data from which to parse the NAL unit
size (int) – the size of data
nal_length_size (int) – the size in bytes of the AVC nal length prefix.
nalu (GstCodecParsers.H264NalUnit) – The GstCodecParsers.H264NalUnit to store the identified NAL unit in

Returns:

Return type:

Parses the headers of an AVC coded NAL unit from data and puts the result into nalu.

GstCodecParsers.h264_parser_identify_nalu_unchecked(nalparser, data, offset, size, nalu)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
data (int) – The data to parse
offset (int) – the offset from which to parse data
size (int) – the size of data
nalu (GstCodecParsers.H264NalUnit) – The GstCodecParsers.H264NalUnit where to store parsed nal headers

Returns:

Return type:

Parses data and fills nalu from the next nalu data from data.

This differs from gst_h264_parser_identify_nalu in that it doesn’t check whether the packet is complete or not.

Note: Only use this function if you already know the provided data is a complete NALU, else use gst_h264_parser_identify_nalu.

GstCodecParsers.h264_parser_insert_sei(nalparser, au, sei)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
au (Gst.Buffer) – a Gst.Buffer containing AU data
sei (Gst.Memory) – a Gst.Memory containing a SEI nal

Returns:

a SEI inserted Gst.Buffer or None if cannot figure out proper position to insert a sei

Return type:

Gst.Buffer or None

Copy au into new Gst.Buffer and insert sei into the Gst.Buffer. The validation for completeness of au and sei is caller’s responsibility. Both au and sei must be byte-stream formatted

New in version 1.18.

GstCodecParsers.h264_parser_insert_sei_avc(nalparser, nal_length_size, au, sei)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
nal_length_size (int) – a size of nal length field, allowed range is [1, 4]
au (Gst.Buffer) – a Gst.Buffer containing AU data
sei (Gst.Memory) – a Gst.Memory containing a SEI nal

Returns:

a SEI inserted Gst.Buffer or None if cannot figure out proper position to insert a sei

Return type:

Gst.Buffer or None

Copy au into new Gst.Buffer and insert sei into the Gst.Buffer. The validation for completeness of au and sei is caller’s responsibility. Nal prefix type of both au and sei must be packetized, and also the size of nal length field must be identical to nal_length_size

New in version 1.18.

GstCodecParsers.h264_parser_parse_decoder_config_record(nalparser, data, size)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
data (int) – the data to parse
size (int) – the size of data

Returns:

config:: parsed GstCodecParsers.H264DecoderConfigRecord data

Return type:

(GstCodecParsers.H264ParserResult, config: GstCodecParsers.H264DecoderConfigRecord)

Parses AVCDecoderConfigurationRecord data and fill into config. The caller must free config via GstCodecParsers.H264DecoderConfigRecord.free()

This method does not parse SPS and PPS and therefore the caller needs to parse each NAL unit via appropriate parsing method.

New in version 1.22.

GstCodecParsers.h264_parser_parse_nal(nalparser, nalu)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
nalu (GstCodecParsers.H264NalUnit) – The GstCodecParsers.H264NalUnit to parse

Returns:

Return type:

This function should be called in the case one doesn’t need to parse a specific structure. It is necessary to do so to make sure nalparser is up to date.

GstCodecParsers.h264_parser_parse_pps(nalparser, nalu, pps)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
nalu (GstCodecParsers.H264NalUnit) – The GstCodecParsers.H264NalUnitType.PPS GstCodecParsers.H264NalUnit to parse
pps (GstCodecParsers.H264PPS) – The GstCodecParsers.H264PPS to fill.

Returns:

Return type:

Parses nalu containing a Picture Parameter Set, and fills pps.

The resulting pps data structure must be deallocated by the caller using GstCodecParsers.H264PPS.clear().

GstCodecParsers.h264_parser_parse_sei(nalparser, nalu, messages)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
nalu (GstCodecParsers.H264NalUnit) – The GstCodecParsers.H264NalUnitType.SEI GstCodecParsers.H264NalUnit to parse
messages ([GstCodecParsers.H264SEIMessage]) – The GLib.Array of GstCodecParsers.H264SEIMessage to fill. The caller must free it when done.

Returns:

Return type:

Parses nalu containing one or more Supplementary Enhancement Information messages, and allocates and fills the messages array.

GstCodecParsers.h264_parser_parse_slice_hdr(nalparser, nalu, slice, parse_pred_weight_table, parse_dec_ref_pic_marking)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
nalu (GstCodecParsers.H264NalUnit) – The GstCodecParsers.H264NalUnitType.SLICE to GstCodecParsers.H264NalUnitType.SLICE_IDR GstCodecParsers.H264NalUnit to parse
slice (GstCodecParsers.H264SliceHdr) – The GstCodecParsers.H264SliceHdr to fill.
parse_pred_weight_table (bool) – Whether to parse the pred_weight_table or not
parse_dec_ref_pic_marking (bool) – Whether to parse the dec_ref_pic_marking or not

Returns:

Return type:

Parses nalu containing a coded slice, and fills slice.

GstCodecParsers.h264_parser_parse_sps(nalparser, nalu, sps)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
nalu (GstCodecParsers.H264NalUnit) – The GstCodecParsers.H264NalUnitType.SPS GstCodecParsers.H264NalUnit to parse
sps (GstCodecParsers.H264SPS) – The GstCodecParsers.H264SPS to fill.

Returns:

Return type:

Parses nalu containing a Sequence Parameter Set, and fills sps.

GstCodecParsers.h264_parser_parse_subset_sps(nalparser, nalu, sps)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
nalu (GstCodecParsers.H264NalUnit) – The GstCodecParsers.H264NalUnitType.SUBSET_SPS GstCodecParsers.H264NalUnit to parse
sps (GstCodecParsers.H264SPS) – The GstCodecParsers.H264SPS to fill.

Returns:

Return type:

Parses data, and fills in the sps structure.

This function fully parses data and allocates all the necessary data structures needed for MVC extensions. The resulting sps structure shall be deallocated with GstCodecParsers.H264SPS.clear() when it is no longer needed.

Note: if the caller doesn’t need any of the MVC-specific data, then GstCodecParsers.h264_parser_parse_sps() is more efficient because those extra syntax elements are not parsed and no extra memory is allocated.

New in version 1.6.

GstCodecParsers.h264_parser_update_pps(nalparser, pps)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
pps (GstCodecParsers.H264PPS) – a GstCodecParsers.H264PPS.

Returns:

Return type:

Replace internal Picture Parameter Set struct corresponding to id of pps with pps. nalparser will mark pps as last parsed pps.

New in version 1.18.

GstCodecParsers.h264_parser_update_sps(nalparser, sps)¶

Parameters:

nalparser (GstCodecParsers.H264NalParser) – a GstCodecParsers.H264NalParser
sps (GstCodecParsers.H264SPS) – a GstCodecParsers.H264SPS.

Returns:

Return type:

Replace internal Sequence Parameter Set struct corresponding to id of sps with sps. nalparser will mark sps as last parsed sps.

New in version 1.18.

GstCodecParsers.h264_profile_from_string(profile)¶

Parameters:: profile (str) – the descriptive name for GstCodecParsers.H264Profile
Returns:: the GstCodecParsers.H264Profile of string or GstCodecParsers.H265Profile.INVALID on error
Return type:: GstCodecParsers.H264Profile

Returns a GstCodecParsers.H264Profile for the string.

New in version 1.24.

GstCodecParsers.h264_quant_matrix_4x4_get_raster_from_zigzag(quant)¶

Parameters:: quant (int) – The source quantization matrix
Returns:: The resulting quantization matrix
Return type:: out_quant: int

Converts quantization matrix quant from zigzag scan order to raster scan order and store the resulting factors into out_quant.

Note: it is an error to pass the same table in both quant and out_quant arguments.

New in version 1.4.

GstCodecParsers.h264_quant_matrix_4x4_get_zigzag_from_raster(quant)¶

Parameters:: quant (int) – The source quantization matrix
Returns:: The resulting quantization matrix
Return type:: out_quant: int

Converts quantization matrix quant from raster scan order to zigzag scan order and store the resulting factors into out_quant.

Note: it is an error to pass the same table in both quant and out_quant arguments.

New in version 1.4.

GstCodecParsers.h264_quant_matrix_8x8_get_raster_from_zigzag(quant)¶

Parameters:: quant (int) – The source quantization matrix
Returns:: The resulting quantization matrix
Return type:: out_quant: int

Converts quantization matrix quant from zigzag scan order to raster scan order and store the resulting factors into out_quant.

Note: it is an error to pass the same table in both quant and out_quant arguments.

New in version 1.4.

GstCodecParsers.h264_quant_matrix_8x8_get_zigzag_from_raster(quant)¶

Parameters:: quant (int) – The source quantization matrix
Returns:: The resulting quantization matrix
Return type:: out_quant: int

Converts quantization matrix quant from raster scan order to zigzag scan order and store the resulting factors into out_quant.

Note: it is an error to pass the same table in both quant and out_quant arguments.

New in version 1.4.

GstCodecParsers.h264_sei_clear(sei)¶

Parameters:: sei (GstCodecParsers.H264SEIMessage) –

sei: The GstCodecParsers.H264SEIMessage to clear Frees allocated data in sei if any.

New in version 1.18.

GstCodecParsers.h264_slice_type_to_string(slice_type)¶

Parameters:: slice_type (GstCodecParsers.H264SliceType) – a GstCodecParsers.H264SliceType
Returns:: the name for slice_type or None on error
Return type:: str or None

Returns the descriptive name for the GstCodecParsers.H264SliceType.

New in version 1.24.

GstCodecParsers.h264_video_calculate_framerate(sps, field_pic_flag, pic_struct)¶

Parameters:

sps (GstCodecParsers.H264SPS) – Current Sequence Parameter Set
field_pic_flag (int) – Current field_pic_flag, obtained from latest slice header
pic_struct (int) – pic_struct value if available, 0 otherwise

Returns:

fps_num:: The resulting fps numerator
fps_den:: The resulting fps denominator

Return type:

(fps_num: int, fps_den: int)

Calculate framerate of a video sequence using sps VUI information, field_pic_flag from a slice header and pic_struct from GstCodecParsers.H264PicTiming SEI message.

If framerate is variable or can’t be determined, fps_num will be set to 0 and fps_den to 1.

GstCodecParsers.h265_create_sei_memory(layer_id, temporal_id_plus1, start_code_prefix_length, messages)¶

Parameters:

layer_id (int) – a nal unit layer id
temporal_id_plus1 (int) – a nal unit temporal identifier
start_code_prefix_length (int) – a length of start code prefix, must be 3 or 4
messages ([GstCodecParsers.H265SEIMessage]) – a GLib.Array of GstCodecParsers.H265SEIMessage

Returns:

a Gst.Memory containing a PREFIX SEI nal unit

Return type:

Creates raw byte-stream format (a.k.a Annex B type) SEI nal unit data from messages

New in version 1.18.

GstCodecParsers.h265_create_sei_memory_hevc(layer_id, temporal_id_plus1, nal_length_size, messages)¶

Parameters:

layer_id (int) – a nal unit layer id
temporal_id_plus1 (int) – a nal unit temporal identifier
nal_length_size (int) – a size of nal length field, allowed range is [1, 4]
messages ([GstCodecParsers.H265SEIMessage]) – a GLib.Array of GstCodecParsers.H265SEIMessage

Returns:

a Gst.Memory containing a PREFIX SEI nal unit

Return type:

Creates raw packetized format SEI nal unit data from messages

New in version 1.18.

GstCodecParsers.h265_get_profile_from_sps(sps)¶

Parameters:: sps (GstCodecParsers.H265SPS) – a GstCodecParsers.H265SPS
Returns:: a GstCodecParsers.H265Profile
Return type:: GstCodecParsers.H265Profile

Return the H265 profile from sps.

New in version 1.20.

GstCodecParsers.h265_parse_pps(parser, nalu, pps)¶

Parameters:

parser (GstCodecParsers.H265Parser) – a GstCodecParsers.H265Parser
nalu (GstCodecParsers.H265NalUnit) – The GstCodecParsers.H265NalUnitType.PPS GstCodecParsers.H265NalUnit to parse
pps (GstCodecParsers.H265PPS) – The GstCodecParsers.H265PPS to fill.

Returns:

Return type:

Parses data, and fills the pps structure.

GstCodecParsers.h265_parse_sps(parser, nalu, sps, parse_vui_params)¶

Parameters:

parser (GstCodecParsers.H265Parser) –
nalu (GstCodecParsers.H265NalUnit) – The GstCodecParsers.H265NalUnitType.SPS GstCodecParsers.H265NalUnit to parse
sps (GstCodecParsers.H265SPS) – The GstCodecParsers.H265SPS to fill.
parse_vui_params (bool) – Whether to parse the vui_params or not

Returns:

Return type:

parser: The GstCodecParsers.H265Parser Parses data, and fills the sps structure.

GstCodecParsers.h265_parse_sps_ext(parser, nalu, sps, sps_ext, parse_vui_params)¶

Parameters:

parser (GstCodecParsers.H265Parser) –
nalu (GstCodecParsers.H265NalUnit) – The GstCodecParsers.H265NalUnitType.SPS GstCodecParsers.H265NalUnit to parse
sps (GstCodecParsers.H265SPS) – The GstCodecParsers.H265SPS to fill.
sps_ext (GstCodecParsers.H265SPSEXT) – The GstCodecParsers.H265SPSEXT matching the GstCodecParsers.H265SPS to fill.
parse_vui_params (bool) – Whether to parse the vui_params or not

Returns:

Return type:

parser: The GstCodecParsers.H265Parser Parses data, and fills the sps structure.

New in version 1.28.

GstCodecParsers.h265_parse_vps(nalu, vps)¶

Parameters:

nalu (GstCodecParsers.H265NalUnit) – The GstCodecParsers.H265NalUnitType.VPS GstCodecParsers.H265NalUnit to parse
vps (GstCodecParsers.H265VPS) – The GstCodecParsers.H265VPS to fill.

Returns:

Return type:

Parses data, and fills the vps structure.

GstCodecParsers.h265_profile_from_string(string)¶

Parameters:: string (str) – the descriptive name for GstCodecParsers.H265Profile
Returns:: the GstCodecParsers.H265Profile of string or GstCodecParsers.H265Profile.INVALID on error
Return type:: GstCodecParsers.H265Profile

Returns a GstCodecParsers.H265Profile for the string.

New in version 1.18.

GstCodecParsers.h265_profile_to_string(profile)¶

Parameters:: profile (GstCodecParsers.H265Profile) – a GstCodecParsers.H265Profile
Returns:: the name for profile or None on error
Return type:: str or None

Returns the descriptive name for the GstCodecParsers.H265Profile.

New in version 1.18.

GstCodecParsers.h265_quant_matrix_4x4_get_raster_from_uprightdiagonal(quant)¶

Parameters:: quant (int) – The source quantization matrix
Returns:: The resulting quantization matrix
Return type:: out_quant: int

Converts quantization matrix quant from uprightdiagonal scan order to raster scan order and store the resulting factors into out_quant.

Note: it is an error to pass the same table in both quant and out_quant arguments.

New in version 1.6.

GstCodecParsers.h265_quant_matrix_4x4_get_raster_from_zigzag(quant)¶

Parameters:: quant (int) – The source quantization matrix
Returns:: The resulting quantization matrix
Return type:: out_quant: int

Converts quantization matrix quant from zigzag scan order to raster scan order and store the resulting factors into out_quant.

Note: it is an error to pass the same table in both quant and out_quant arguments.

New in version 1.6.

GstCodecParsers.h265_quant_matrix_4x4_get_uprightdiagonal_from_raster(quant)¶

Parameters:: quant (int) – The source quantization matrix
Returns:: The resulting quantization matrix
Return type:: out_quant: int

Converts quantization matrix quant from raster scan order to uprightdiagonal scan order and store the resulting factors into out_quant.

Note: it is an error to pass the same table in both quant and out_quant arguments.

New in version 1.6.

GstCodecParsers.h265_quant_matrix_4x4_get_zigzag_from_raster(quant)¶

Parameters:: quant (int) – The source quantization matrix
Returns:: The resulting quantization matrix
Return type:: out_quant: int

Converts quantization matrix quant from raster scan order to zigzag scan order and store the resulting factors into out_quant.

Note: it is an error to pass the same table in both quant and out_quant arguments.

New in version 1.6.

GstCodecParsers.h265_quant_matrix_8x8_get_raster_from_uprightdiagonal(quant)¶

Parameters:: quant (int) – The source quantization matrix
Returns:: The resulting quantization matrix
Return type:: out_quant: int

Converts quantization matrix quant from uprightdiagonal scan order to raster scan order and store the resulting factors into out_quant.

Note: it is an error to pass the same table in both quant and out_quant arguments.

New in version 1.6.

GstCodecParsers.h265_quant_matrix_8x8_get_raster_from_zigzag(quant)¶

Parameters:: quant (int) – The source quantization matrix
Returns:: The resulting quantization matrix
Return type:: out_quant: int

Converts quantization matrix quant from zigzag scan order to raster scan order and store the resulting factors into out_quant.

Note: it is an error to pass the same table in both quant and out_quant arguments.

New in version 1.6.

GstCodecParsers.h265_quant_matrix_8x8_get_uprightdiagonal_from_raster(quant)¶

Parameters:: quant (int) – The source quantization matrix
Returns:: The resulting quantization matrix
Return type:: out_quant: int

Converts quantization matrix quant from raster scan order to uprightdiagonal scan order and store the resulting factors into out_quant.

Note: it is an error to pass the same table in both quant and out_quant arguments.

New in version 1.6.

GstCodecParsers.h265_quant_matrix_8x8_get_zigzag_from_raster(quant)¶

Parameters:: quant (int) – The source quantization matrix
Returns:: The resulting quantization matrix
Return type:: out_quant: int

Converts quantization matrix quant from raster scan order to zigzag scan order and store the resulting factors into out_quant.

Note: it is an error to pass the same table in both quant and out_quant arguments.

New in version 1.6.

GstCodecParsers.h265_sei_copy(dest_sei, src_sei)¶

Parameters:

dest_sei (GstCodecParsers.H265SEIMessage) – The destination GstCodecParsers.H265SEIMessage to copy into
src_sei (GstCodecParsers.H265SEIMessage) – The source GstCodecParsers.H265SEIMessage to copy from

Returns:

True if everything went fine, False otherwise

Return type:

Copies src_sei into dst_sei

GstCodecParsers.h265_sei_free(sei)¶

Parameters:: sei (GstCodecParsers.H265SEIMessage) –

sei: The GstCodecParsers.H265SEIMessage to free Frees sei fields.

GstCodecParsers.h265_slice_type_to_string(slice_type)¶

Parameters:: slice_type (GstCodecParsers.H265SliceType) – a GstCodecParsers.H265SliceType
Returns:: the name for slice_type or None on error
Return type:: str or None

Returns the descriptive name for the GstCodecParsers.H265SliceType.

New in version 1.24.

GstCodecParsers.h266_parse_aps(parser, nalu, aps)¶

Parameters:

parser (GstCodecParsers.H266Parser) – a GstCodecParsers.H266Parser
nalu (GstCodecParsers.H266NalUnit) – The APS GstCodecParsers.H266NalUnit to parse
aps (GstCodecParsers.H266APS) – The GstCodecParsers.H266APS to fill.

Returns:

Return type:

Parses data, and fills the aps structure.

New in version 1.26.

GstCodecParsers.h266_parse_pps(parser, nalu, pps)¶

Parameters:

parser (GstCodecParsers.H266Parser) – a GstCodecParsers.H266Parser
nalu (GstCodecParsers.H266NalUnit) – The GstCodecParsers.H266NalUnitType.PPS GstCodecParsers.H266NalUnit to parse
pps (GstCodecParsers.H266PPS) – The GstCodecParsers.H266PPS to fill.

Returns:

Return type:

Parses data, and fills the pps structure.

New in version 1.26.

GstCodecParsers.h266_parse_sps(parser, nalu, sps)¶

Parameters:

parser (GstCodecParsers.H266Parser) – The GstCodecParsers.H266Parser
nalu (GstCodecParsers.H266NalUnit) – The GstCodecParsers.H266NalUnitType.SPS GstCodecParsers.H266NalUnit to parse
sps (GstCodecParsers.H266SPS) – The GstCodecParsers.H266SPS to fill.

Returns:

Return type:

Parses data, and fills the sps structure.

New in version 1.26.

GstCodecParsers.h266_parse_vps(nalu, vps)¶

Parameters:

nalu (GstCodecParsers.H266NalUnit) – The GstCodecParsers.H266NalUnitType.VPS GstCodecParsers.H266NalUnit to parse
vps (GstCodecParsers.H266VPS) – The GstCodecParsers.H266VPS to fill.

Returns:

Return type:

Parses data, and fills the vps structure.

New in version 1.26.

GstCodecParsers.h266_profile_from_string(string)¶

Parameters:: string (str) – the descriptive name for GstCodecParsers.H266Profile
Returns:: the GstCodecParsers.H266Profile of string or GstCodecParsers.H266Profile.INVALID on error
Return type:: GstCodecParsers.H266Profile

Returns a GstCodecParsers.H266Profile for the string.

New in version 1.26.

GstCodecParsers.h266_profile_to_string(profile)¶

Parameters:: profile (GstCodecParsers.H266Profile) – a GstCodecParsers.H266Profile
Returns:: the name for profile or None on error
Return type:: str or None

Returns the descriptive name for the GstCodecParsers.H266Profile.

New in version 1.26.

GstCodecParsers.jpeg2000_colorspace_from_string(colorspace_string)¶

Parameters:: colorspace_string (str) –
Return type:: GstCodecParsers.JPEG2000Colorspace

GstCodecParsers.jpeg2000_colorspace_to_string(colorspace)¶

Parameters:: colorspace (GstCodecParsers.JPEG2000Colorspace) –
Return type:: str

GstCodecParsers.jpeg2000_sampling_from_string(sampling_string)¶

Parameters:: sampling_string (str) –
Return type:: GstCodecParsers.JPEG2000Sampling

GstCodecParsers.jpeg2000_sampling_is_mono(sampling)¶

Parameters:: sampling (GstCodecParsers.JPEG2000Sampling) –
Return type:: bool

GstCodecParsers.jpeg2000_sampling_is_rgb(sampling)¶

Parameters:: sampling (GstCodecParsers.JPEG2000Sampling) –
Return type:: bool

GstCodecParsers.jpeg2000_sampling_is_yuv(sampling)¶

Parameters:: sampling (GstCodecParsers.JPEG2000Sampling) –
Return type:: bool

GstCodecParsers.jpeg2000_sampling_to_string(sampling)¶

Parameters:: sampling (GstCodecParsers.JPEG2000Sampling) –
Return type:: str

GstCodecParsers.jpeg_bit_writer_frame_header(frame_hdr, marker, size)¶

Parameters:

frame_hdr (GstCodecParsers.JpegFrameHdr) – the frame header of GstCodecParsers.JpegFrameHdr to write
marker (GstCodecParsers.JpegMarker) – the GstCodecParsers.JpegMarker id for this segment
size (int) – the size in bytes of the input and output

Returns:

data:: the bit stream generated by this frame header
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.JpegBitWriterResult, data: int, size: int)

Generating the according JPEG bit stream by providing the frame header.

New in version 1.26.

GstCodecParsers.jpeg_bit_writer_huffman_table(huff_tables, size)¶

Parameters:

huff_tables (GstCodecParsers.JpegHuffmanTables) – the huffman tables of GstCodecParsers.JpegHuffmanTables to write
size (int) – the size in bytes of the input and output

Returns:

data:: the bit stream generated by the huffman tables
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.JpegBitWriterResult, data: int, size: int)

Generating the according JPEG bit stream by providing the huffman tables.

New in version 1.26.

GstCodecParsers.jpeg_bit_writer_quantization_table(quant_tables, size)¶

Parameters:

quant_tables (GstCodecParsers.JpegQuantTables) – the quantization tables of GstCodecParsers.JpegQuantTables to write
size (int) – the size in bytes of the input and output

Returns:

data:: the bit stream generated by the quantization tables
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.JpegBitWriterResult, data: int, size: int)

Generating the according JPEG bit stream by providing the quantization tables.

New in version 1.26.

GstCodecParsers.jpeg_bit_writer_restart_interval(interval, size)¶

Parameters:

interval (int) – the interval value for restart
size (int) – the size in bytes of the input and output

Returns:

data:: the bit stream generated by the interval value
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.JpegBitWriterResult, data: int, size: int)

Generating the according JPEG bit stream by providing the interval value.

New in version 1.26.

GstCodecParsers.jpeg_bit_writer_scan_header(scan_hdr, size)¶

Parameters:

scan_hdr (GstCodecParsers.JpegScanHdr) – the scan header of GstCodecParsers.JpegScanHdr to write
size (int) – the size in bytes of the input and output

Returns:

data:: the bit stream generated by this scan header
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.JpegBitWriterResult, data: int, size: int)

Generating the according JPEG bit stream by providing the scan header.

New in version 1.26.

GstCodecParsers.jpeg_bit_writer_segment_with_data(marker, seg_data, seg_size, size)¶

Parameters:

marker (GstCodecParsers.JpegMarker) – the GstCodecParsers.JpegMarker id for this segment
seg_data (int or None) – the user provided bit stream data
seg_size (int) – the size of the segment data
size (int) – the size in bytes of the input and output

Returns:

data:: the generated bit stream of this segment
size:: the size in bytes of the input and output

Return type:

(GstCodecParsers.JpegBitWriterResult, data: int, size: int)

Generating the bit stream for a JPEG segment.

New in version 1.26.

GstCodecParsers.jpeg_get_default_huffman_tables()¶

Returns:: The default DC/AC Huffman tables to fill in
Return type:: huff_tables: GstCodecParsers.JpegHuffmanTables

Fills in huf_tables with the default AC/DC Huffman tables, as specified by the JPEG standard.

New in version 1.6.

GstCodecParsers.jpeg_get_default_quantization_tables(quant_tables)¶

Parameters:: quant_tables (GstCodecParsers.JpegQuantTables) –

GstCodecParsers.jpeg_parse(data, size, offset)¶

Parameters:

data (int) – The data to parse
size (int) – The size of data
offset (int) – The offset from which to start parsing

Returns:

True if a packet start code was found.

seg:: pointer to a GstCodecParsers.JpegSegment structure to fill in

Return type:

(bool, seg: GstCodecParsers.JpegSegment)

Parses the JPEG bitstream contained in data, and returns the detected segment as a GstCodecParsers.JpegSegment.

Note that a valid segment may be returned with a length that exceeds the available data. It is up to the caller to make sure there’s enough data available when parsing the segment.

New in version 1.6.

GstCodecParsers.lcevc_meta_api_get_type()¶

Returns:: the GObject.GType of the LCEVC meta API.
Return type:: GObject.GType

Gets the GObject.GType of the LCEVC meta API.

New in version 1.26.

GstCodecParsers.lcevc_meta_get_info()¶

Returns:: the GstCodecParsers.LcevcMeta of the LCEVC meta.
Return type:: Gst.MetaInfo

Gets the Gst.MetaInfo of the LCEVC meta.

New in version 1.26.

GstCodecParsers.mpeg4_parse(packet, skip_user_data, vop, data, offset, size)¶

Parameters:

packet (GstCodecParsers.Mpeg4Packet) – The GstCodecParsers.Mpeg4Packet to fill
skip_user_data (bool) – True to skip user data packet False otherwise
vop (GstCodecParsers.Mpeg4VideoObjectPlane) – The last parsed GstCodecParsers.Mpeg4VideoObjectPlane or None if you do not need to detect the resync codes.
data (int) – The data to parse
offset (int) – offset from which to start the parsing
size (int) – The size of the data to parse

Returns:

Return type:

Parses data and fills packet with the information of the next packet found.

GstCodecParsers.mpeg4_parse_group_of_vop(gov, data, size)¶

Parameters:

gov (GstCodecParsers.Mpeg4GroupOfVOP) – The GstCodecParsers.Mpeg4GroupOfVOP structure to fill
data (int) – The data to parse
size (int) – The size of the data to parse

Returns:

Return type:

Parses data containing the group of video object plane packet, and fills the gov structure.

GstCodecParsers.mpeg4_parse_video_object_layer(vol, vo, data, size)¶

Parameters:

vol (GstCodecParsers.Mpeg4VideoObjectLayer) – The GstCodecParsers.Mpeg4VideoObjectLayer structure to fill
vo (GstCodecParsers.Mpeg4VisualObject) – The GstCodecParsers.Mpeg4VisualObject currently being parsed or None
data (int) – The data to parse
size (int) – The size of the data to parse

Returns:

Return type:

Parses data containing the video object layer packet, and fills the vol structure.

GstCodecParsers.mpeg4_parse_video_object_plane(vop, sprite_trajectory, vol, data, size)¶

Parameters:

vop (GstCodecParsers.Mpeg4VideoObjectPlane) – The GstCodecParsers.Mpeg4VideoObjectPlane currently being parsed
sprite_trajectory (GstCodecParsers.Mpeg4SpriteTrajectory) – A GstCodecParsers.Mpeg4SpriteTrajectory to fill or None
vol (GstCodecParsers.Mpeg4VideoObjectLayer) – The GstCodecParsers.Mpeg4VideoObjectLayer structure to fill
data (int) – The data to parse
size (int) – The size of the data to parse

Returns:

Return type:

Parses data containing the video object plane packet, and fills the vol structure.

GstCodecParsers.mpeg4_parse_video_packet_header(videopackethdr, vol, vop, sprite_trajectory, data, size)¶

Parameters:

videopackethdr (GstCodecParsers.Mpeg4VideoPacketHdr) – The GstCodecParsers.Mpeg4VideoPacketHdr structure to fill
vol (GstCodecParsers.Mpeg4VideoObjectLayer) – The last parsed GstCodecParsers.Mpeg4VideoObjectLayer, will be updated with the information found during the parsing
vop (GstCodecParsers.Mpeg4VideoObjectPlane) – The last parsed GstCodecParsers.Mpeg4VideoObjectPlane, will be updated with the information found during the parsing
sprite_trajectory (GstCodecParsers.Mpeg4SpriteTrajectory) – A GstCodecParsers.Mpeg4SpriteTrajectory to fill or None with the information found during the parsing
data (int) – The data to parse, should be set after the resync marker.
size (int) – The size of the data to parse

Return type:

Parsers data containing the video packet header and fills the videopackethdr structure

GstCodecParsers.mpeg4_parse_video_plane_short_header(shorthdr, data, size)¶

Parameters:

shorthdr (GstCodecParsers.Mpeg4VideoPlaneShortHdr) –
data (int) –
size (int) –

Return type:

GstCodecParsers.mpeg4_parse_visual_object(vo, signal_type, data, size)¶

Parameters:

vo (GstCodecParsers.Mpeg4VisualObject) – The GstCodecParsers.Mpeg4VisualObject structure to fill
signal_type (GstCodecParsers.Mpeg4VideoSignalType) – The GstCodecParsers.Mpeg4VideoSignalType to fill or None
data (int) – The data to parse, should contain the vo_start_code but not the start code prefix
size (int) – The size of the data to parse

Returns:

Return type:

Parses data containing the visual object packet, and fills the vo structure.

GstCodecParsers.mpeg4_parse_visual_object_sequence(vos, data, size)¶

Parameters:

vos (GstCodecParsers.Mpeg4VisualObjectSequence) – The GstCodecParsers.Mpeg4VisualObjectSequence structure to fill
data (int) – The data to parse, should contain the visual_object_sequence_start_code but not the start code prefix
size (int) – The size of the data to parse

Returns:

Return type:

Parses data containing the visual object sequence packet, and fills the vos structure.

GstCodecParsers.mpeg_video_finalise_mpeg2_sequence_header(hdr, seqext, displayext)¶

Parameters:

hdr (GstCodecParsers.MpegVideoSequenceHdr) –
seqext (GstCodecParsers.MpegVideoSequenceExt) –
displayext (GstCodecParsers.MpegVideoSequenceDisplayExt) –

Return type:

GstCodecParsers.mpeg_video_meta_api_get_type()¶

Return type:: GObject.GType

GstCodecParsers.mpeg_video_meta_get_info()¶

Return type:: Gst.MetaInfo

GstCodecParsers.mpeg_video_parse(packet, data, size, offset)¶

Parameters:

packet (GstCodecParsers.MpegVideoPacket) – a GstCodecParsers.MpegVideoPacket to fill with the data and offset of the next packet found
data (int) – The data to parse
size (int) – The size of data
offset (int) – The offset from which to start parsing

Returns:

True if a packet start code was found, otherwise False.

Return type:

Parses the MPEG 1/2 video bitstream contained in data, and returns the offset, and if known also the size, in packet. This function will scan the data to find the next packet if needed.

GstCodecParsers.mpeg_video_quant_matrix_get_raster_from_zigzag(quant)¶

Parameters:: quant (int) – The source quantization matrix
Returns:: The resulting quantization matrix
Return type:: out_quant: int

Converts quantization matrix quant from zigzag scan order to raster scan order and store the resulting factors into out_quant.

Note: it is an error to pass the same table in both quant and out_quant arguments.

New in version 1.2.

GstCodecParsers.mpeg_video_quant_matrix_get_zigzag_from_raster(quant)¶

Parameters:: quant (int) – The source quantization matrix
Returns:: The resulting quantization matrix
Return type:: out_quant: int

Converts quantization matrix quant from raster scan order to zigzag scan order and store the resulting factors into out_quant.

Note: it is an error to pass the same table in both quant and out_quant arguments.

New in version 1.2.

GstCodecParsers.vc1_bitplanes_ensure_size(bitplanes, seqhdr)¶

Parameters:

bitplanes (GstCodecParsers.VC1BitPlanes) – The GstCodecParsers.VC1BitPlanes to reset
seqhdr (GstCodecParsers.VC1SeqHdr) – The GstCodecParsers.VC1SeqHdr from which to set bitplanes

Returns:

True if everything went fine, False otherwise

Return type:

Fills the bitplanes structure from seqhdr, this function should be called after GstCodecParsers.vc1_parse_sequence_header if in simple or main mode, or after GstCodecParsers.vc1_parse_entry_point_header if in advanced mode.

GstCodecParsers.vc1_bitplanes_free(bitplanes)¶

Parameters:: bitplanes (GstCodecParsers.VC1BitPlanes) –

GstCodecParsers.vc1_bitplanes_free_1(bitplanes)¶

Parameters:: bitplanes (GstCodecParsers.VC1BitPlanes) –

GstCodecParsers.vc1_identify_next_bdu(data, size)¶

Parameters:

data (int) – The data to parse
size (int) – the size of data

Returns:

a GstCodecParsers.VC1EntryPointHdr

bdu:: The GstCodecParsers.VC1BDU where to store parsed bdu headers

Return type:

(GstCodecParsers.VC1ParserResult, bdu: GstCodecParsers.VC1BDU)

Parses data and fills bdu fields

GstCodecParsers.vc1_parse_entry_point_header(data, size, seqhdr)¶

Parameters:

data (int) – The data to parse
size (int) – the size of data
seqhdr (GstCodecParsers.VC1SeqHdr) – The GstCodecParsers.VC1SeqHdr currently being parsed

Returns:

entrypoint:: The GstCodecParsers.VC1EntryPointHdr to set.

Return type:

(GstCodecParsers.VC1ParserResult, entrypoint: GstCodecParsers.VC1EntryPointHdr)

Parses data, and sets entrypoint fields.

GstCodecParsers.vc1_parse_field_header(data, size, fieldhdr, seqhdr, bitplanes)¶

Parameters:

data (int) – The data to parse
size (int) – the size of data
fieldhdr (GstCodecParsers.VC1FrameHdr) – The GstCodecParsers.VC1FrameHdr to fill.
seqhdr (GstCodecParsers.VC1SeqHdr) – The GstCodecParsers.VC1SeqHdr currently being parsed
bitplanes (GstCodecParsers.VC1BitPlanes) – The GstCodecParsers.VC1BitPlanes to store bitplanes in or None

Returns:

Return type:

Parses data, and fills fieldhdr fields.

GstCodecParsers.vc1_parse_frame_header(data, size, framehdr, seqhdr, bitplanes)¶

Parameters:

data (int) – The data to parse
size (int) – the size of data
framehdr (GstCodecParsers.VC1FrameHdr) – The GstCodecParsers.VC1FrameHdr to fill.
seqhdr (GstCodecParsers.VC1SeqHdr) – The GstCodecParsers.VC1SeqHdr currently being parsed
bitplanes (GstCodecParsers.VC1BitPlanes) – The GstCodecParsers.VC1BitPlanes to store bitplanes in or None

Returns:

Return type:

Parses data, and fills entrypoint fields.

GstCodecParsers.vc1_parse_frame_layer(data, size, framelayer)¶

Parameters:

data (int) – The data to parse
size (int) – the size of data
framelayer (GstCodecParsers.VC1FrameLayer) – The GstCodecParsers.VC1FrameLayer to fill.

Returns:

Return type:

Parses data, and fills framelayer fields.

GstCodecParsers.vc1_parse_sequence_header(data, size, seqhdr)¶

Parameters:

data (int) – The data to parse
size (int) – the size of data
seqhdr (GstCodecParsers.VC1SeqHdr) – The GstCodecParsers.VC1SeqHdr to set.

Returns:

Return type:

Parses data, and fills seqhdr fields.

GstCodecParsers.vc1_parse_sequence_header_struct_a(data, size, structa)¶

Parameters:

data (int) – The data to parse
size (int) – the size of data
structa (GstCodecParsers.VC1SeqStructA) – The GstCodecParsers.VC1SeqStructA to set.

Returns:

Return type:

Parses data, and fills structa fields.

GstCodecParsers.vc1_parse_sequence_header_struct_b(data, size, structb)¶

Parameters:

data (int) – The data to parse
size (int) – the size of data
structb (GstCodecParsers.VC1SeqStructB) – The GstCodecParsers.VC1SeqStructB to set.

Returns:

Return type:

Parses data, and fills structb fields.

GstCodecParsers.vc1_parse_sequence_header_struct_c(data, size, structc)¶

Parameters:

data (int) – The data to parse
size (int) – the size of data
structc (GstCodecParsers.VC1SeqStructC) – The GstCodecParsers.VC1SeqStructC to set.

Returns:

Return type:

Parses data, and fills structc fields.

GstCodecParsers.vc1_parse_sequence_layer(data, size, seqlayer)¶

Parameters:

data (int) – The data to parse
size (int) – the size of data
seqlayer (GstCodecParsers.VC1SeqLayer) – The GstCodecParsers.VC1SeqLayer to set.

Returns:

Return type:

Parses data, and fills seqlayer fields.

GstCodecParsers.vc1_parse_slice_header(data, size, slicehdr, seqhdr)¶

Parameters:

data (int) – The data to parse
size (int) – The size of data
slicehdr (GstCodecParsers.VC1SliceHdr) – The GstCodecParsers.VC1SliceHdr to fill
seqhdr (GstCodecParsers.VC1SeqHdr) – The GstCodecParsers.VC1SeqHdr that was previously parsed

Returns:

Return type: