GstCodecParsers.AV1FrameHeaderOBU

Fields

Name	Type	Access	Description
all_lossless	int	r/w	is a variable that is equal to 1 when coded_lossless is equal to 1 and frame_width is equal to upscaled_width. This indicates that the frame is fully lossless at the upscaled resolution.
allow_high_precision_mv	bool	r/w	equal to 0 specifies that motion vectors are specified to quarter pel precision; allow_high_precision_mv equal to 1 specifies that motion vectors are specified to eighth pel precision.
allow_intrabc	bool	r/w	equal to 1 indicates that intra block copy may be used in this frame. allow_intrabc equal to 0 indicates that intra block copy is not allowed in this frame.
allow_screen_content_tools	int	r/w	equal to 1 indicates that intra blocks may use palette encoding; allow_screen_content_tools equal to 0 indicates that palette encoding is never used.
allow_warped_motion	bool	r/w	equal to 1 indicates that the syntax element motion_mode may be present. allow_warped_motion equal to 0 indicates that the syntax element motion_mode will not be present (this means that LOCALWARP cannot be signaled if allow_warped_motion is equal to 0).
buffer_removal_time	[int]	r/w	specifies the frame removal time in units of DecCT clock ticks counted from the removal time of the last frame with frame_type equal to KEY_FRAME for operating point opNum. buffer_removal_time is signaled as a fixed length unsigned integer with a length in bits given by buffer_removal_time_length_minus_1 + 1. buffer_removal_time is the remainder of a modulo 1 << ( buffer_removal_time_length_minus_1 + 1 ) counter.
buffer_removal_time_present_flag	bool	r/w	equal to 1 specifies that buffer_removal_time is present in the bitstream. buffer_removal_time_present_flag equal to 0 specifies that buffer_removal_time is not present in the bitstream.
cdef_params	GstCodecParsers.AV1CDEFParams	r/w	a GstCodecParsers.AV1CDEFParams holding the CDEF paramters.
coded_lossless	int	r/w	is a variable that is equal to 1 when all segments use lossless encoding.
current_frame_id	int	r/w	specifies the frame id number for the current frame. Frame id numbers are additional information that do not affect the decoding process, but provide decoders with a way of detecting missing reference frames so that appropriate action can be taken.
disable_cdf_update	bool	r/w	specifies whether the CDF update in the symbol decoding process should be disabled.
disable_frame_end_update_cdf	bool	r/w	equal to 1 indicates that the end of frame CDF update is disabled; disable_frame_end_update_cdf equal to 0 indicates that the end of frame CDF update is enabled.
display_frame_id	int	r/w	provides the frame id number for the frame to output. It is a requirement of bitstream conformance that whenever display_frame_id is read, the value matches ref_frame_id[ frame_to_show_map_idx ] (the value of current_frame_id at the time that the frame indexed by frame_to_show_map_idx was stored), and that ref_valid[ frame_to_show_map_idx ] is equal to 1. It is a requirement of bitstream conformance that the number of bits needed to read display_frame_id does not exceed 16. This is equivalent to the constraint that idLen <= 16
error_resilient_mode	bool	r/w	equal to 1 indicates that error resilient mode is enabled; error_resilient_mode equal to 0 indicates that error resilient mode is disabled.
expected_frame_id	[int]	r/w	specifies the frame id for each frame used for reference.
film_grain_params	GstCodecParsers.AV1FilmGrainParams	r/w	a GstCodecParsers.AV1FilmGrainParams holding the Film Grain parameters.
force_integer_mv	bool	r/w	equal to 1 specifies that motion vectors will always be integers. force_integer_mv equal to 0 specifies that motion vectors can contain fractional bits.
frame_height	int	r/w	the frame height.
frame_is_intra	int	r/w	if equal to 0 indicating that this frame may use inter prediction.
frame_presentation_time	int	r/w	specifies the presentation time of the frame in clock ticks DispCT counted from the removal time of the last frame with frame_type equal to KEY_FRAME for the operating point that is being decoded. The syntax element is signaled as a fixed length unsigned integer with a length in bits given by frame_presentation_time_length_minus_1 + 1. The frame_presentation_time is the remainder of a modulo 1 << (frame_presentation_time_length_minus_1 + 1) counter.
frame_refs_short_signaling	bool	r/w	equal to 1 indicates that only two reference frames are explicitly signaled. frame_refs_short_signaling equal to 0 indicates that all reference frames are explicitly signaled.
frame_size_override_flag	bool	r/w	equal to 0 specifies that the frame size is equal to the size in the sequence header. frame_size_override_flag equal to 1 specifies that the frame size will either be specified as the size of one of the reference frames, or computed from the frame_width_minus_1 and frame_height_minus_1 syntax elements.
frame_to_show_map_idx	int	r/w	specifies the frame to be output. It is only available if show_existing_frame is 1.
frame_type	GstCodecParsers.AV1FrameType	r/w	specifies the type of the frame.
frame_width	int	r/w	the frame width.
global_motion_params	GstCodecParsers.AV1GlobalMotionParams	r/w	a GstCodecParsers.AV1GlobalMotionParams holding the global motion parameters.
gold_frame_idx	int	r/w	specifies the reference frame to use for GOLDEN_FRAME. ref_frame_idx[i]: specifies which reference frames are used by inter frames. delta_frame_id_minus_1 is used to calculate delta_frame_id.
interpolation_filter	GstCodecParsers.AV1InterpolationFilter	r/w	a GstCodecParsers.AV1InterpolationFilter that specifies the filter selection used for performing inter prediction.
is_filter_switchable	bool	r/w	equal to 1 indicates that the filter selection is signaled at the block level; is_filter_switchable equal to 0 indicates that the filter selection is signaled at the frame level.
is_motion_mode_switchable	bool	r/w	equal to 0 specifies that only the SIMPLE motion mode will be used.
last_frame_idx	int	r/w	specifies the reference frame to use for LAST_FRAME.
loop_filter_params	GstCodecParsers.AV1LoopFilterParams	r/w	a GstCodecParsers.AV1LoopFilterParams holding the loop filter parameters.
loop_restoration_params	GstCodecParsers.AV1LoopRestorationParams	r/w	a GstCodecParsers.AV1LoopRestorationParams holding the loop restoration parameters.
lossless_array	bytes	r/w	whether the segmentation is lossless.
order_hint	int	r/w	is used to compute order_hint.
order_hints	[int]	r/w	specifies the expected output order for each reference frame.
primary_ref_frame	int	r/w	specifies which reference frame contains the CDF values and other state that should be loaded at the start of the frame.
quantization_params	GstCodecParsers.AV1QuantizationParams	r/w	a GstCodecParsers.AV1QuantizationParams holding the quantization parameters.
reduced_tx_set	bool	r/w	equal to 1 specifies that the frame is restricted to a reduced subset of the full set of transform types.
ref_frame_idx	[int]	r/w
ref_frame_sign_bias	[int]	r/w	specifies the intended direction of the motion vector in time for each reference frame.
ref_global_motion_params	GstCodecParsers.AV1GlobalMotionParams	r/w	specifies the global motion parameters of the reference.
ref_order_hint	[int]	r/w	specifies the expected output order hint for each reference buffer.
reference_select	bool	r/w	equal to 1 specifies that the mode info for inter blocks contains the syntax element comp_mode that indicates whether to use single or compound reference prediction. Reference_select equal to 0 specifies that all interblocks will use single prediction.
refresh_frame_flags	int	r/w	contains a bitmask that specifies which reference frame slots will be updated with the current frame after it is decoded. If frame_type is equal to GstCodecParsers.AV1FrameType.INTRA_ONLY_FRAME, it is a requirement of bitstream conformance that refresh_frame_flags is not equal to 0xff.
render_and_frame_size_different	bool	r/w	equal to 0 means that the render width and height are inferred from the frame width and height. render_and_frame_size_different equal to 1 means that the render width and height are explicitly coded in the bitstream.
render_height	int	r/w	the frame height to be rendered.
render_width	int	r/w	the frame width to be rendered.
seg_qm_Level	bytes	r/w	the segmentation’s qm level.
segmentation_params	GstCodecParsers.AV1SegmentationParams	r/w	a GstCodecParsers.AV1SegmentationParams holding the segmentation parameters.
show_existing_frame	bool	r/w	equal to 1, indicates the frame indexed by frame_to_show_map_idx is to be output; show_existing_frame equal to 0 indicates that further processing is required. If obu_type is equal to GstCodecParsers.AV1OBUType.FRAME, it is a requirement of bitstream conformance that show_existing_frame is equal to 0.
show_frame	bool	r/w	equal to 1 specifies that this frame should be immediately output once decoded. show_frame equal to 0 specifies that this frame should not be immediately output. (It may be output later if a later uncompressed header uses show_existing_frame equal to 1).
showable_frame	bool	r/w	equal to 1 specifies that the frame may be output using the show_existing_frame mechanism. showable_frame equal to 0 specifies that this frame will not be output using the show_existing_frame mechanism. It is a requirement of bitstream conformance that when show_existing_frame is used to show a previous frame, that the value of showable_frame for the previous frame was equal to 1. It is a requirement of bitstream conformance that a particular showable frame is output via the show_existing_frame mechanism at most once.
skip_mode_frame	bytes	r/w	specifies the frames to use for compound prediction when skip_mode is 1.
skip_mode_present	bool	r/w	equal to 1 specifies that the syntax element skip_mode will be coded in the bitstream. skip_mode_present equal to 0 specifies that skip_mode will not be used for this frame.
superres_denom	int	r/w	is the denominator of a fraction that specifies the ratio between the superblock width before and after upscaling.
tile_info	GstCodecParsers.AV1TileInfo	r/w	a GstCodecParsers.AV1TileInfo holding the tile info.
tu_presentation_delay	int	r/w	is a syntax element used by the decoder model. It does not affect the decoding process.
tx_mode	GstCodecParsers.AV1TXModes	r/w	specifies how the transform size is determined.
tx_mode_select	bool	r/w	is used to compute TxMode.
upscaled_width	int	r/w	the upscaled width.
use_ref_frame_mvs	bool	r/w	equal to 1 specifies that motion vector information from a previous frame can be used when decoding the current frame. use_ref_frame_mvs equal to 0 specifies that this information will not be used.
use_superres	bool	r/w	equal to 0 indicates that no upscaling is needed. use_superres equal to 1 indicates that upscaling is needed.

Methods

None

Details

class GstCodecParsers.AV1FrameHeaderOBU