GstAV1Parser

For more details about the structures, you can refer to the AV1 Bitstream & Decoding Process Specification V1.0.0 specification

It offers you bitstream parsing of low overhead bistream format (Section 5) or Annex B according to the setting of the parser. By calling the function of gst_av1_parser_reset, user can switch between bistream mode and Annex B mode.

To retrieve OBUs and parse its headers, you should firstly call the function of gst_av1_parser_identify_one_obu to get the OBU type if succeeds or just discard the data if fails.

Then, depending on the GstAV1OBUType of the newly parsed GstAV1OBU, you should call the differents functions to parse the structure details:

Note: Some parser functions are dependent on information provided in the sequence header and reference frame's information. It maintains a state inside itself, which contains all global vars and reference information during the whole parsing process. Calling gst_av1_parser_reset or a new sequence's arriving can clear and reset this inside state.

After successfully handled a frame(for example, decode a frame successfully), you should call gst_av1_parser_reference_frame_update to update the parser's inside state(such as reference information, global segmentation information, etc).

Note: If the frame is actived by show_existing_frame in GST_AV1_OBU_FRAME_HEADER, the function of gst_av1_parser_reference_frame_loading should be called before really showing that frame.

since: 1.18.00

Functions

gst_av1_parser_free

void 
gst_av1_parser_free (GstAV1Parser * parser)

If parser is not NULL, frees its allocated memory.

It cannot be used afterwards.

Parameters:

parser

the GstAV1Parser to free

Returns ( void ) –
No description available

Since : 1.18


gst_av1_parser_identify_one_obu

GstAV1ParserResult
gst_av1_parser_identify_one_obu (GstAV1Parser * parser,
                                 const guint8 * data,
                                 guint32 size,
                                 GstAV1OBU * obu,
                                 guint32 * consumed)

Identify one obu's type from the incoming data stream. This function should be called first to know the type of obu before other parse APIs.

Parameters:

parser

the GstAV1Parser

data

the data to parse

size

the size of data

obu

a GstAV1OBU to store the identified result

consumed

the consumed data size

Returns ( GstAV1ParserResult ) –

The GstAV1ParserResult.

Since : 1.18


gst_av1_parser_new

GstAV1Parser *
gst_av1_parser_new ()

Allocates a new GstAV1Parser,

Returns ( GstAV1Parser * ) –

a newly-allocated GstAV1Parser

Since : 1.18


gst_av1_parser_parse_frame_header_obu

GstAV1ParserResult
gst_av1_parser_parse_frame_header_obu (GstAV1Parser * parser,
                                       GstAV1OBU * obu,
                                       GstAV1FrameHeaderOBU * frame_header)

Parse one frame header obu based on the parser context, store the result in the frame.

Parameters:

parser

the GstAV1Parser

obu

a GstAV1OBU to be parsed

frame_header

a GstAV1FrameHeaderOBU to store the parsed result.

Returns ( GstAV1ParserResult ) –

The GstAV1ParserResult.

Since : 1.18


gst_av1_parser_parse_frame_obu

GstAV1ParserResult
gst_av1_parser_parse_frame_obu (GstAV1Parser * parser,
                                GstAV1OBU * obu,
                                GstAV1FrameOBU * frame)

Parse one frame obu based on the parser context, store the result in the frame.

Parameters:

parser

the GstAV1Parser

obu

a GstAV1OBU to be parsed

frame

a GstAV1FrameOBU to store the parsed result.

Returns ( GstAV1ParserResult ) –

The GstAV1ParserResult.

Since : 1.18


gst_av1_parser_parse_metadata_obu

GstAV1ParserResult
gst_av1_parser_parse_metadata_obu (GstAV1Parser * parser,
                                   GstAV1OBU * obu,
                                   GstAV1MetadataOBU * metadata)

Parse one meta data obu based on the parser context.

Parameters:

parser

the GstAV1Parser

obu

a GstAV1OBU to be parsed

metadata

a GstAV1MetadataOBU to store the parsed result.

Returns ( GstAV1ParserResult ) –

The GstAV1ParserResult.

Since : 1.18


gst_av1_parser_parse_sequence_header_obu

GstAV1ParserResult
gst_av1_parser_parse_sequence_header_obu (GstAV1Parser * parser,
                                          GstAV1OBU * obu,
                                          GstAV1SequenceHeaderOBU * seq_header)

Parse one sequence header obu based on the parser context, store the result in the seq_header.

Parameters:

parser

the GstAV1Parser

obu

a GstAV1OBU to be parsed

seq_header

a GstAV1SequenceHeaderOBU to store the parsed result.

Returns ( GstAV1ParserResult ) –

The GstAV1ParserResult.

Since : 1.18


gst_av1_parser_parse_temporal_delimiter_obu

GstAV1ParserResult
gst_av1_parser_parse_temporal_delimiter_obu (GstAV1Parser * parser,
                                             GstAV1OBU * obu)

Parse one temporal delimiter obu based on the parser context. The temporal delimiter is just delimiter and contains no content.

Parameters:

parser

the GstAV1Parser

obu

a GstAV1OBU to be parsed

Returns ( GstAV1ParserResult ) –

The GstAV1ParserResult.

Since : 1.18


gst_av1_parser_parse_tile_group_obu

GstAV1ParserResult
gst_av1_parser_parse_tile_group_obu (GstAV1Parser * parser,
                                     GstAV1OBU * obu,
                                     GstAV1TileGroupOBU * tile_group)

Parse one tile group obu based on the parser context, store the result in the tile_group.

Parameters:

parser

the GstAV1Parser

obu

a GstAV1OBU to be parsed

tile_group

a GstAV1TileGroupOBU to store the parsed result.

Returns ( GstAV1ParserResult ) –

The GstAV1ParserResult.

Since : 1.18


gst_av1_parser_parse_tile_list_obu

GstAV1ParserResult
gst_av1_parser_parse_tile_list_obu (GstAV1Parser * parser,
                                    GstAV1OBU * obu,
                                    GstAV1TileListOBU * tile_list)

Parse one tile list obu based on the parser context, store the result in the tile_list. It is for large scale tile coding mode.

Parameters:

parser

the GstAV1Parser

obu

a GstAV1OBU to be parsed

tile_list

a GstAV1TileListOBU to store the parsed result.

Returns ( GstAV1ParserResult ) –

The GstAV1ParserResult.

Since : 1.18


gst_av1_parser_reference_frame_loading

GstAV1ParserResult
gst_av1_parser_reference_frame_loading (GstAV1Parser * parser,
                                        GstAV1FrameHeaderOBU * frame_header)

Load the context of frame_header to parser's state. This function is used when we want to show already parsed frames before.

Parameters:

parser

the GstAV1Parser

frame_header

a GstAV1FrameHeaderOBU to load

Returns ( GstAV1ParserResult ) –

The GstAV1ParserResult.

Since : 1.18


gst_av1_parser_reference_frame_update

GstAV1ParserResult
gst_av1_parser_reference_frame_update (GstAV1Parser * parser,
                                       GstAV1FrameHeaderOBU * frame_header)

Update the context of frame_header to parser's state. This function is used when we finish one frame's decoding/showing, and need to update info such as reference, global parameters.

Parameters:

parser

the GstAV1Parser

frame_header

a GstAV1FrameHeaderOBU to load

Returns ( GstAV1ParserResult ) –

The GstAV1ParserResult.

Since : 1.18


gst_av1_parser_reset

void 
gst_av1_parser_reset (GstAV1Parser * parser,
                      gboolean annex_b)

Reset the current GstAV1Parser's state totally.

Parameters:

parser

the GstAV1Parser

annex_b

indicate whether conforms to annex b

Returns ( void ) –
No description available

Since : 1.18


Structures

GstAV1CDEFParams

struct _GstAV1CDEFParams {
  guint8 cdef_damping;
  guint8 cdef_bits;
  guint8 cdef_y_pri_strength[GST_AV1_CDEF_MAX];
  guint8 cdef_y_sec_strength[GST_AV1_CDEF_MAX];
  guint8 cdef_uv_pri_strength[GST_AV1_CDEF_MAX];
  guint8 cdef_uv_sec_strength[GST_AV1_CDEF_MAX];
};

Parameters of Constrained Directional Enhancement Filter (CDEF).

Fields

cdef_damping (guint8) –

controls the amount of damping in the deringing filter.

cdef_bits (guint8) –

specifies the number of bits needed to specify which CDEF filter to apply.

cdef_y_pri_strength (guint8 [8] ) –

specify the strength of the primary filter (Y component)

cdef_y_sec_strength (guint8 [8] ) –

specify the strength of the secondary filter (Y component).

cdef_uv_pri_strength (guint8 [8] ) –

specify the strength of the primary filter (UV components).

cdef_uv_sec_strength (guint8 [8] ) –

specify the strength of the secondary filter (UV components).


GstAV1ColorConfig

struct _GstAV1ColorConfig {
  gboolean high_bitdepth;
  gboolean twelve_bit;
  gboolean mono_chrome;
  gboolean color_description_present_flag;
  GstAV1ColorPrimaries color_primaries;
  GstAV1TransferCharacteristics transfer_characteristics;
  GstAV1MatrixCoefficients matrix_coefficients;
  gboolean color_range;
  guint8 subsampling_x;
  guint8 subsampling_y;
  GstAV1ChromaSamplePositions chroma_sample_position;
  gboolean separate_uv_delta_q;
};

Fields

high_bitdepth (gboolean) –

syntax element which, together with seq_profile, determine the bit depth.

twelve_bit (gboolean) –

is syntax elements which, together with seq_profile and high_bitdepth, determines the bit depth.

mono_chrome (gboolean) –

equal to 1 indicates that the video does not contain U and V color planes. mono_chrome equal to 0 indicates that the video contains Y, U, and V color planes.

color_description_present_flag (gboolean) –

equal to 1 specifies that color_primaries, transfer_characteristics, and matrix_coefficients are present. color_description_present_flag equal to 0 specifies that color_primaries, transfer_characteristics and matrix_coefficients are not present.

color_primaries (GstAV1ColorPrimaries) –

is an integer that is defined by the "Color primaries" section of ISO/IEC 23091-4/ITU-T H.273.

transfer_characteristics (GstAV1TransferCharacteristics) –

is an integer that is defined by the "Transfer characteristics" section of ISO/IEC 23091-4/ITU-T H.273.

matrix_coefficients (GstAV1MatrixCoefficients) –

is an integer that is defined by the "Matrix coefficients" section of ISO/IEC 23091-4/ITU-T H.273.

color_range (gboolean) –

is a binary value that is associated with the VideoFullRangeFlag variable specified in ISO/IEC 23091-4/ITU-T H.273. color range equal to 0 shall be referred to as the studio swing representation and color range equal to 1 shall be referred to as the full swing representation for all intents relating to this specification. subsampling_x, subsampling_y: specify the chroma subsampling format. If matrix_coefficients is equal to GST_AV1_MC_IDENTITY, it is a requirement of bitstream conformance that subsampling_x is equal to 0 and subsampling_y is equal to 0. chroma_sample_position specifies the sample position for subsampled streams:

subsampling_x (guint8) –
No description available
subsampling_y (guint8) –
No description available
chroma_sample_position (GstAV1ChromaSamplePositions) –
No description available
separate_uv_delta_q (gboolean) –

equal to 1 indicates that the U and V planes may have separate delta quantizer values. separate_uv_delta_q equal to 0 indicates that the U and V planes will share the same delta quantizer value.


GstAV1DecoderModelInfo

struct _GstAV1DecoderModelInfo {
  guint8 buffer_delay_length_minus_1;
  guint32 num_units_in_decoding_tick;
  guint8 buffer_removal_time_length_minus_1;
  guint8 frame_presentation_time_length_minus_1;
};

Fields

buffer_delay_length_minus_1 (guint8) –

plus 1 specifies the length of the decoder_buffer_delay and the encoder_buffer_delay syntax elements, in bits.

num_units_in_decoding_tick (guint32) –

is the number of time units of a decoding clock operating at the frequency time_scale Hz that corresponds to one increment of a clock tick counter.

buffer_removal_time_length_minus_1 (guint8) –

plus 1 specifies the length of the buffer_removal_time syntax element, in bits.

frame_presentation_time_length_minus_1 (guint8) –

plus 1 specifies the length of the frame_presentation_time syntax element, in bits.


GstAV1FilmGrainParams

struct _GstAV1FilmGrainParams {
  gboolean apply_grain;
  guint16 grain_seed;
  gboolean update_grain;
  guint8 film_grain_params_ref_idx;
  guint8 num_y_points;
  guint8 point_y_value[GST_AV1_MAX_NUM_Y_POINTS];
  guint8 point_y_scaling[GST_AV1_MAX_NUM_Y_POINTS];
  guint8 chroma_scaling_from_luma;
  guint8 num_cb_points;
  guint8 point_cb_value[GST_AV1_MAX_NUM_CB_POINTS];
  guint8 point_cb_scaling[GST_AV1_MAX_NUM_CB_POINTS];
  guint8 num_cr_points;
  guint8 point_cr_value[GST_AV1_MAX_NUM_CR_POINTS];
  guint8 point_cr_scaling[GST_AV1_MAX_NUM_CR_POINTS];
  guint8 grain_scaling_minus_8;
  guint8 ar_coeff_lag;
  guint8 ar_coeffs_y_plus_128[GST_AV1_MAX_NUM_POS_LUMA];
  guint8 ar_coeffs_cb_plus_128[GST_AV1_MAX_NUM_POS_LUMA];
  guint8 ar_coeffs_cr_plus_128[GST_AV1_MAX_NUM_POS_LUMA];
  guint8 ar_coeff_shift_minus_6;
  guint8 grain_scale_shift;
  guint8 cb_mult;
  guint8 cb_luma_mult;
  guint8 cb_offset;
  guint8 cr_mult;
  guint8 cr_luma_mult;
  guint8 cr_offset;
  gboolean overlap_flag;
  gboolean clip_to_restricted_range;
};

Fields

apply_grain (gboolean) –

equal to 1 specifies that film grain should be added to this frame. apply_grain equal to 0 specifies that film grain should not be added.

grain_seed (guint16) –

specifies the starting value for the pseudo-random numbers used during film grain synthesis.

update_grain (gboolean) –

equal to 1 means that a new set of parameters should be sent. update_grain equal to 0 means that the previous set of parameters should be used.

film_grain_params_ref_idx (guint8) –

indicates which reference frame contains the film grain parameters to be used for this frame.

num_y_points (guint8) –

specifies the number of points for the piece-wise linear scaling function of the luma component. It is a requirement of bitstream conformance that num_y_points is less than or equal to 14.

point_y_value (guint8 [16] ) –

represents the x (luma value) coordinate for the i-th point of the piecewise linear scaling function for luma component. The values are signaled on the scale of 0..255. (In case of 10 bit video, these values correspond to luma values divided by 4. In case of 12 bit video, these values correspond to luma values divided by 16.) If i is greater than 0, it is a r equirement of bitstream conformance that point_y_value[ i ] is greater than point_y_value[ i - 1 ] (this ensures the x coordinates are specified in increasing order).

point_y_scaling (guint8 [16] ) –

represents the scaling (output) value for the i-th point of the piecewise linear scaling function for luma component.

chroma_scaling_from_luma (guint8) –

specifies that the chroma scaling is inferred from the luma scaling.

num_cb_points (guint8) –

specifies the number of points for the piece-wise linear scaling function of the cb component. It is a requirement of bitstream conformance that num_cb_points is less than or equal to 10.

point_cb_value (guint8 [16] ) –

represents the x coordinate for the i-th point of the piece-wise linear scaling function for cb component. The values are signaled on the scale of 0..255. If i is greater than 0, it is a requirement of bitstream conformance that point_cb_value[ i ] is greater than point_cb_value[ i - 1 ].

point_cb_scaling (guint8 [16] ) –

represents the scaling (output) value for the i-th point of the piecewise linear scaling function for cb component.

num_cr_points (guint8) –

specifies represents the number of points for the piece-wise linear scaling function of the cr component. It is a requirement of bitstream conformance that num_cr_points is less than or equal to 10. If subsampling_x is equal to 1 and subsampling_y is equal to 1 and num_cb_points is equal to 0, it is a requirement of bitstream conformance that num_cr_points is equal to 0. If subsampling_x is equal to 1 and subsampling_y is equal to 1 and num_cb_points is not equal to 0, it is a requirement of bitstream conformance that num_cr_points is not equal to 0.

point_cr_value (guint8 [16] ) –

represents the x coordinate for the i-th point of the piece-wise linear scaling function for cr component. The values are signaled on the scale of 0..255. If i is greater than 0, it is a requirement of bitstream conformance that point_cr_value[ i ] is greater than point_cr_value[ i - 1 ].

point_cr_scaling (guint8 [16] ) –

represents the scaling (output) value for the i-th point of the piecewise linear scaling function for cr component.

grain_scaling_minus_8 (guint8) –

represents the shift - 8 applied to the values of the chroma component. The grain_scaling_minus_8 can take values of 0..3 and determines the range and quantization step of the standard deviation of film grain.

ar_coeff_lag (guint8) –

specifies the number of auto-regressive coefficients for luma and chroma.

ar_coeffs_y_plus_128 (guint8 [25] ) –

specifies auto-regressive coefficients used for the Y plane.

ar_coeffs_cb_plus_128 (guint8 [25] ) –

specifies auto-regressive coefficients used for the U plane.

ar_coeffs_cr_plus_128 (guint8 [25] ) –

specifies auto-regressive coefficients used for the V plane.

ar_coeff_shift_minus_6 (guint8) –

specifies the range of the auto-regressive coefficients. Values of 0, 1, 2, and 3 correspond to the ranges for auto-regressive coefficients of [-2, 2), [-1, 1), [-0.5, 0.5) and [-0.25, 0.25) respectively.

grain_scale_shift (guint8) –

specifies how much the Gaussian random numbers should be scaled down during the grain synthesis process.

cb_mult (guint8) –

represents a multiplier for the cb component used in derivation of the input index to the cb component scaling function.

cb_luma_mult (guint8) –

represents a multiplier for the average luma component used in derivation of the input index to the cb component scaling function.

cb_offset (guint8) –

represents an offset used in derivation of the input index to the cb component scaling function.

cr_mult (guint8) –

represents a multiplier for the cr component used in derivation of the input index to the cr component scaling function.

cr_luma_mult (guint8) –

represents a multiplier for the average luma component used in derivation of the input index to the cr component scaling function.

cr_offset (guint8) –

represents an offset used in derivation of the input index to the cr component scaling function.

overlap_flag (gboolean) –

equal to 1 indicates that the overlap between film grain blocks shall be applied. overlap_flag equal to 0 indicates that the overlap between film grain blocks shall not be applied.

clip_to_restricted_range (gboolean) –

equal to 1 indicates that clipping to the restricted (studio) range shall be applied to the sample values after adding the film grain (see the semantics for color_range for an explanation of studio swing). clip_to_restricted_range equal to 0 indicates that clipping to the full range shall be applied to the sample values after adding the film grain.


GstAV1FrameHeaderOBU

struct _GstAV1FrameHeaderOBU {
  gboolean show_existing_frame;
  guint8 frame_to_show_map_idx;
  guint32 frame_presentation_time;
  guint32 tu_presentation_delay;
  guint32 display_frame_id;
  GstAV1FrameType frame_type;
  gboolean show_frame;
  gboolean showable_frame;
  gboolean error_resilient_mode;
  gboolean disable_cdf_update;
  guint8 allow_screen_content_tools;
  gboolean force_integer_mv;
  guint32 current_frame_id;
  gboolean frame_size_override_flag;
  guint32 order_hint;
  guint8 primary_ref_frame;
  gboolean buffer_removal_time_present_flag;
  guint32 buffer_removal_time[GST_AV1_MAX_OPERATING_POINTS];
  guint8 refresh_frame_flags;
  guint32 ref_order_hint[GST_AV1_NUM_REF_FRAMES];
  gboolean allow_intrabc;
  gboolean frame_refs_short_signaling;
  guint8 last_frame_idx;
  guint8 gold_frame_idx;
  guint8 ref_frame_idx[GST_AV1_REFS_PER_FRAME];
  gboolean allow_high_precision_mv;
  gboolean is_motion_mode_switchable;
  gboolean use_ref_frame_mvs;
  gboolean disable_frame_end_update_cdf;
  gboolean allow_warped_motion;
  gboolean reduced_tx_set;
  gboolean render_and_frame_size_different;
  gboolean use_superres;
  gboolean is_filter_switchable;
  GstAV1InterpolationFilter interpolation_filter;
  GstAV1LoopFilterParams loop_filter_params;
  GstAV1QuantizationParams quantization_params;
  GstAV1SegmenationParams segmentation_params;
  GstAV1TileInfo tile_info;
  GstAV1CDEFParams cdef_params;
  GstAV1LoopRestorationParams loop_restoration_params;
  gboolean tx_mode_select;
  gboolean skip_mode_present;
  gboolean reference_select;
  GstAV1GlobalMotionParams global_motion_params;
  GstAV1FilmGrainParams film_grain_params;

  /* Global vars set by frame header */
  guint32 superres_denom; /* SuperresDenom */
  guint8 frame_is_intra; /* FrameIsIntra */
  guint32 order_hints[GST_AV1_NUM_REF_FRAMES]; /* OrderHints */
  guint32 ref_frame_sign_bias[GST_AV1_NUM_REF_FRAMES]; /* RefFrameSignBias */

  guint8 coded_lossless; /* CodedLossless */
  guint8 all_lossless; /* AllLossless */
  guint8 lossless_array[GST_AV1_MAX_SEGMENTS]; /* LosslessArray */
  guint8 seg_qm_Level[3][GST_AV1_MAX_SEGMENTS]; /* SegQMLevel */

  guint32 upscaled_width; /* UpscaledWidth */
  guint32 frame_width; /* FrameWidth */
  guint32 frame_height; /* FrameHeight */
  guint32 render_width;  /* RenderWidth */
  guint32 render_height; /* RenderHeight */

  GstAV1TXModes tx_mode; /* TxMode */

  guint8 skip_mode_frame[2]; /* SkipModeFrame */
};

Fields

show_existing_frame (gboolean) –

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 GST_AV1_OBU_FRAME, it is a requirement of bitstream conformance that show_existing_frame is equal to 0.

frame_to_show_map_idx (guint8) –

specifies the frame to be output. It is only available if show_existing_frame is 1.

frame_presentation_time (guint32) –

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.

tu_presentation_delay (guint32) –

is a syntax element used by the decoder model. It does not affect the decoding process.

display_frame_id (guint32) –

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 equjal 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

frame_type (GstAV1FrameType) –

specifies the type of the frame.

show_frame (gboolean) –

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 (gboolean) –

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.

error_resilient_mode (gboolean) –

equal to 1 indicates that error resilient mode is enabled; error_resilient_mode equal to 0 indicates that error resilient mode is disabled.

disable_cdf_update (gboolean) –

specifies whether the CDF update in the symbol decoding process should be disabled.

allow_screen_content_tools (guint8) –

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.

force_integer_mv (gboolean) –

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.

current_frame_id (guint32) –

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.

frame_size_override_flag (gboolean) –

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.

order_hint (guint32) –

is used to compute order_hint.

primary_ref_frame (guint8) –

specifies which reference frame contains the CDF values and other state that should be loaded at the start of the frame.

buffer_removal_time_present_flag (gboolean) –

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.

buffer_removal_time (guint32 [32] ) –

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.

refresh_frame_flags (guint8) –

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 GST_AV1_INTRA_ONLY_FRAME, it is a requirement of bitstream conformance that refresh_frame_flags is not equal to 0xff.

ref_order_hint (guint32 [8] ) –

specifies the expected output order hint for each reference buffer.

allow_intrabc (gboolean) –

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.

frame_refs_short_signaling (gboolean) –

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.

last_frame_idx (guint8) –

specifies the reference frame to use for LAST_FRAME.

gold_frame_idx (guint8) –

specifies the reference frame to use for GOLDEN_FRAME.

ref_frame_idx (guint8 [7] ) –
No description available
allow_high_precision_mv (gboolean) –

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.

is_motion_mode_switchable (gboolean) –

equal to 0 specifies that only the SIMPLE motion mode will be used.

use_ref_frame_mvs (gboolean) –

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.

disable_frame_end_update_cdf (gboolean) –

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.

allow_warped_motion (gboolean) –

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).

reduced_tx_set (gboolean) –

equal to 1 specifies that the frame is restricted to a reduced subset of the full set of transform types.

render_and_frame_size_different (gboolean) –

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.

use_superres (gboolean) –

equal to 0 indicates that no upscaling is needed. use_superres equal to 1 indicates that upscaling is needed.

is_filter_switchable (gboolean) –

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.

interpolation_filter (GstAV1InterpolationFilter) –

a GstAV1InterpolationFilter that specifies the filter selection used for performing inter prediction.

loop_filter_params (GstAV1LoopFilterParams) –

a GstAV1LoopFilterParams holding the loop filter parameters.

quantization_params (GstAV1QuantizationParams) –

a GstAV1QuantizationParams holding the quantization parameters.

segmentation_params (GstAV1SegmenationParams) –

a GstAV1SegmenationParams holding the segementation parameters.

tile_info (GstAV1TileInfo) –

a GstAV1TileInfo holding the tile info.

cdef_params (GstAV1CDEFParams) –

a GstAV1CDEFParams holding the CDEF paramters.

loop_restoration_params (GstAV1LoopRestorationParams) –

a GstAV1LoopRestorationParams holding the loop restoration parameters.

tx_mode_select (gboolean) –

is used to compute TxMode.

skip_mode_present (gboolean) –

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.

reference_select (gboolean) –

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.

global_motion_params (GstAV1GlobalMotionParams) –

a GstAV1GlobalMotionParams holding the global motion parameters.

film_grain_params (GstAV1FilmGrainParams) –

a GstAV1FilmGrainParams holding the Film Grain parameters.

superres_denom (guint32) –

is the denominator of a fraction that specifies the ratio between the superblock width before and after upscaling.

frame_is_intra (guint8) –

if equal to 0 indicating that this frame may use inter prediction.

order_hints (guint32 [8] ) –

specifies the expected output order for each reference frame.

ref_frame_sign_bias (guint32 [8] ) –

specifies the intended direction of the motion vector in time for each reference frame.

coded_lossless (guint8) –

is a variable that is equal to 1 when all segments use lossless encoding.

all_lossless (guint8) –

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.

lossless_array (guint8 [8] ) –

whether the segmentation is lossless.

seg_qm_Level (guint8 [3][8] ) –

the segmentation's qm level.

upscaled_width (guint32) –

the upscaled width.

frame_width (guint32) –

the frame width.

frame_height (guint32) –

the frame height.

render_width (guint32) –

the frame width to be rendered.

render_height (guint32) –

the frame height to be rendered.

tx_mode (GstAV1TXModes) –

specifies how the transform size is determined.

skip_mode_frame (guint8 [2] ) –

specifies the frames to use for compound prediction when skip_mode is 1.


GstAV1FrameOBU

struct _GstAV1FrameOBU {
  GstAV1TileGroupOBU tile_group;
  GstAV1FrameHeaderOBU frame_header;
};

Fields

tile_group (GstAV1TileGroupOBU) –

a GstAV1TileGroupOBU holding tile_group data.

frame_header (GstAV1FrameHeaderOBU) –

a GstAV1FrameHeaderOBU holding frame_header data.


GstAV1GlobalMotionParams

struct _GstAV1GlobalMotionParams {
  gboolean is_global[GST_AV1_NUM_REF_FRAMES];
  gboolean is_rot_zoom[GST_AV1_NUM_REF_FRAMES];
  gboolean is_translation[GST_AV1_NUM_REF_FRAMES];
  gint32 gm_params[GST_AV1_NUM_REF_FRAMES][6];

  GstAV1WarpModelType gm_type[GST_AV1_NUM_REF_FRAMES]; /* GmType */
};

Fields

is_global (gboolean [8] ) –

specifies whether global motion parameters are present for a particular reference frame.

is_rot_zoom (gboolean [8] ) –

specifies whether a particular reference frame uses rotation and zoom global motion.

is_translation (gboolean [8] ) –

specifies whether a particular reference frame uses translation global motion.

gm_params (gint32 [8][6] ) –

is set equal to SavedGmParams[ frame_to_show_map_idx ][ ref ][ j ] for ref = LAST_FRAME..ALTREF_FRAME, for j = 0..5.

gm_type (GstAV1WarpModelType [8] ) –

specifying the type of global motion.


GstAV1LoopFilterParams

struct _GstAV1LoopFilterParams {
  guint8 loop_filter_level[4];
  guint8 loop_filter_sharpness;
  gboolean loop_filter_delta_enabled;
  gboolean loop_filter_delta_update;

  guint8 loop_filter_ref_deltas[GST_AV1_TOTAL_REFS_PER_FRAME];
  guint8 loop_filter_mode_deltas[2];

  gboolean delta_lf_present;
  guint8 delta_lf_res;
  guint8 delta_lf_multi;
};

Fields

loop_filter_level (guint8 [4] ) –

is an array containing loop filter strength values. Different loop filter strength values from the array are used depending on the image plane being filtered, and the edge direction (vertical or horizontal) being filtered.

loop_filter_sharpness (guint8) –

indicates the sharpness level. The loop_filter_level and loop_filter_sharpness together determine when a block edge is filtered, and by how much the filtering can change the sample values. The loop filter process is described in AV1 Bitstream Spec. section 7.14.

loop_filter_delta_enabled (gboolean) –

equal to 1 means that the filter level depends on the mode and reference frame used to predict a block. loop_filter_delta_enabled equal to 0 means that the filter level does not depend on the mode and reference frame.

loop_filter_delta_update (gboolean) –

equal to 1 means that the bitstream contains additional syntax elements that specify which mode and reference frame deltas are to be updated. loop_filter_delta_update equal to 0 means that these syntax elements are not present.

loop_filter_ref_deltas (guint8 [8] ) –

contains the adjustment needed for the filter level based on the chosen reference frame. If this syntax element is not present in the bitstream, it maintains its previous value.

loop_filter_mode_deltas (guint8 [2] ) –

contains the adjustment needed for the filter level based on the chosen mode. If this syntax element is not present in the bitstream, it maintains its previous value.

delta_lf_present (gboolean) –

specifies whether loop filter delta values are present in the bitstream.

delta_lf_res (guint8) –

specifies the left shift which should be applied to decoded loop filter delta values.

delta_lf_multi (guint8) –

equal to 1 specifies that separate loop filter deltas are sent for horizontal luma edges, vertical luma edges, the U edges, and the V edges. delta_lf_multi equal to 0 specifies that the same loop filter delta is used for all edges.


GstAV1LoopRestorationParams

struct _GstAV1LoopRestorationParams {
  guint8 lr_unit_shift;
  gboolean lr_uv_shift;

  GstAV1FrameRestorationType frame_restoration_type[GST_AV1_MAX_NUM_PLANES]; /* FrameRestorationType */
  guint32 loop_restoration_size[GST_AV1_MAX_NUM_PLANES]; /* LoopRestorationSize */
  guint8 uses_lr; /* UsesLr */
};

Fields

lr_unit_shift (guint8) –

specifies if the luma restoration size should be halved.

lr_uv_shift (gboolean) –

is only present for 4:2:0 formats and specifies if the chroma size should be half the luma size.

frame_restoration_type (GstAV1FrameRestorationType [3] ) –

specifies the type of restoration used for each plane.

loop_restoration_size (guint32 [3] ) –

specifies the size of loop restoration units in units of samples in the current plane.

uses_lr (guint8) –

indicates if any plane uses loop restoration.


GstAV1MetadataHdrCll

struct _GstAV1MetadataHdrCll {
  guint16 max_cll;
  guint16 max_fall;
};

High Dynamic Range content light level syntax metadata.

Fields

max_cll (guint16) –

specifies the maximum content light level as specified in CEA-861.3, Appendix A.

max_fall (guint16) –

specifies the maximum frame-average light level as specified in CEA-861.3, Appendix A.


GstAV1MetadataHdrMdcv

struct _GstAV1MetadataHdrMdcv {
  guint16 primary_chromaticity_x[3];
  guint16 primary_chromaticity_y[3];
  guint16 white_point_chromaticity_x;
  guint16 white_point_chromaticity_y;
  guint32 luminance_max;
  guint32 luminance_min;
};

High Dynamic Range mastering display color volume metadata.

Fields

primary_chromaticity_x (guint16 [3] ) –

specifies a 0.16 fixed-point X chromaticity coordinate as defined by CIE 1931, where i = 0,1,2 specifies Red, Green, Blue respectively.

primary_chromaticity_y (guint16 [3] ) –

specifies a 0.16 fixed-point Y chromaticity coordinate as defined by CIE 1931, where i = 0,1,2 specifies Red, Green, Blue respectively.

white_point_chromaticity_x (guint16) –

specifies a 0.16 fixed-point white X chromaticity coordinate as defined by CIE 1931.

white_point_chromaticity_y (guint16) –

specifies a 0.16 fixed-point white Y chromaticity coordinate as defined by CIE 1931.

luminance_max (guint32) –

is a 24.8 fixed-point maximum luminance, represented in candelas per square meter.

luminance_min (guint32) –

is a 18.14 fixed-point minimum luminance, represented in candelas per square meter.


GstAV1MetadataITUT_T35

struct _GstAV1MetadataITUT_T35 {
  guint8 itu_t_t35_country_code;
  guint8 itu_t_t35_country_code_extention_byte;
  /* itu_t_t35_payload_bytes - not specified at this spec */
  guint8 *itu_t_t35_payload_bytes;
};

Fields

itu_t_t35_country_code (guint8) –

shall be a byte having a value specified as a country code by Annex A of Recommendation ITU-T T.35.

itu_t_t35_country_code_extention_byte (guint8) –
No description available
itu_t_t35_payload_bytes (guint8 *) –

shall be bytes containing data registered as specified in Recommendation ITU-T T.35.


GstAV1MetadataOBU

struct _GstAV1MetadataOBU {
  GstAV1MetadataType metadata_type;
  union {
    GstAV1MetadataITUT_T35 itut_t35;
    GstAV1MetadataHdrCll hdr_cll;
    GstAV1MetadataHdrMdcv hdr_mdcv;
    GstAV1MetadataScalability scalability;
    GstAV1MetadataTimecode timecode;
  };
};

Fields

metadata_type (GstAV1MetadataType) –

type of metadata


GstAV1MetadataScalability

struct _GstAV1MetadataScalability {
  GstAV1ScalabilityModes scalability_mode_idc;
  guint8 spatial_layers_cnt_minus_1;
  gboolean spatial_layer_dimensions_present_flag;
  gboolean spatial_layer_description_present_flag;
  gboolean temporal_group_description_present_flag;
  guint16 spatial_layer_max_width[GST_AV1_MAX_SPATIAL_LAYERS];
  guint16 spatial_layer_max_height[GST_AV1_MAX_SPATIAL_LAYERS];
  guint8 spatial_layer_ref_id[GST_AV1_MAX_SPATIAL_LAYERS];
  guint8 temporal_group_size;

  guint8 temporal_group_temporal_id[GST_AV1_MAX_TEMPORAL_GROUP_SIZE];
  guint8 temporal_group_temporal_switching_up_point_flag[GST_AV1_MAX_TEMPORAL_GROUP_SIZE];
  guint8 temporal_group_spatial_switching_up_point_flag[GST_AV1_MAX_TEMPORAL_GROUP_SIZE];
  guint8 temporal_group_ref_cnt[GST_AV1_MAX_TEMPORAL_GROUP_SIZE];
  guint8 temporal_group_ref_pic_diff[GST_AV1_MAX_TEMPORAL_GROUP_SIZE]
                                    [GST_AV1_MAX_TEMPORAL_GROUP_REFERENCES];
};

The scalability metadata OBU is intended for use by intermediate processing entities that may perform selective layer elimination.

Fields

scalability_mode_idc (GstAV1ScalabilityModes) –

indicates the picture prediction structure of the bitstream.

spatial_layers_cnt_minus_1 (guint8) –

indicates the number of spatial layers present in the video sequence minus one.

spatial_layer_dimensions_present_flag (gboolean) –

indicates when set to 1 that the spatial_layer_max_width and spatial_layer_max_height parameters are present for each of the (@spatial_layers_cnt_minus_1 + 1) layers, or that it they are not present when set to 0.

spatial_layer_description_present_flag (gboolean) –

indicates when set to 1 that the spatial_layer_ref_id is present for each of the (@spatial_layers_cnt_minus_1 + 1) layers, or that it is not present when set to 0.

temporal_group_description_present_flag (gboolean) –

indicates when set to 1 that the temporal dependency information is present, or that it is not when set to 0.

spatial_layer_max_width (guint16 [2] ) –

specifies the maximum frame width for the frames with spatial_id equal to i. This number must not be larger than max_frame_width_minus_1 + 1.

spatial_layer_max_height (guint16 [2] ) –

specifies the maximum frame height for the frames with spatial_id equal to i. This number must not be larger than max_frame_height_minus_1 + 1.

spatial_layer_ref_id (guint8 [2] ) –

specifies the spatial_id value of the frame within the current temporal unit that the frame of layer i uses for reference. If no frame within the current temporal unit is used for reference the value must be equal to 255.

temporal_group_size (guint8) –

indicates the number of pictures in a temporal picture group. If the temporal_group_size is greater than 0, then the scalability structure data allows the inter-picture temporal dependency structure of the video sequence to be specified. If the temporal_group_size is greater than 0, then for temporal_group_size pictures in the temporal group, each picture's temporal layer id (@temporal_id), switch up points (@temporal_group_temporal_switching_up_point_flag and temporal_group_spatial_switching_up_point_flag), and the reference picture indices (@temporal_group_ref_pic_diff) are specified. The first picture specified in a temporal group must have temporal_id equal to 0. If the parameter temporal_group_size is not present or set to 0, then either there is only one temporal layer or there is no fixed inter-picture temporal dependency present going forward in the video sequence. Note that for a given picture, all frames follow the same inter-picture temporal dependency structure. However, the frame rate of each layer can be different from each other. The specified dependency structure in the scalability structure data must be for the highest frame rate layer.

temporal_group_temporal_id (guint8 [8] ) –

specifies the temporal_id value for the i-th picture in the temporal group.

temporal_group_temporal_switching_up_point_flag (guint8 [8] ) –

is set to 1 if subsequent (in decoding order) pictures with a temporal_id higher than temporal_group_temporal_id[i] do not depend on any picture preceding the current picture (in coding order) with temporal_id higher than temporal_group_temporal_id[ i ].

temporal_group_spatial_switching_up_point_flag (guint8 [8] ) –

is set to 1 if spatial layers of the current picture in the temporal group (i.e., pictures with a spatial_id higher than zero) do not depend on any picture preceding the current picture in the temporal group.

temporal_group_ref_cnt (guint8 [8] ) –

indicates the number of reference pictures used by the i-th picture in the temporal group.

temporal_group_ref_pic_diff (guint8 [8][8] ) –

indicates, for the i-th picture in the temporal group, the temporal distance between the i-th picture and the j-th reference picture used by the i-th picture. The temporal distance is measured in frames, counting only frames of identical spatial_id values.


GstAV1MetadataTimecode

struct _GstAV1MetadataTimecode {
  guint8 counting_type;       /* candidate for sperate Type GstAV1TimecodeCountingType */
  gboolean full_timestamp_flag;
  gboolean discontinuity_flag;
  gboolean cnt_dropped_flag;
  guint8 n_frames;
  gboolean seconds_flag;
  guint8 seconds_value;
  gboolean minutes_flag;
  guint8 minutes_value;
  gboolean hours_flag;
  guint8 hours_value;
  guint8 time_offset_length;
  guint32 time_offset_value;
};

Fields

counting_type (guint8) –

specifies the method of dropping values of the n_frames syntax element as specified in AV1 Spec 6.1.1. counting_type should be the same for all pictures in the coded video sequence.

full_timestamp_flag (gboolean) –

equal to 1 indicates that the the seconds_value, minutes_value, hours_value syntax elements will be present. full_timestamp_flag equal to 0 indicates that there are flags to control the presence of these syntax elements.

discontinuity_flag (gboolean) –

equal to 0 indicates that the difference between the current value of clockTimestamp and the value of clockTimestamp computed from the previous set of timestamp syntax elements in output order can be interpreted as the time difference between the times of origin or capture of the associated frames or fields. discontinuity_flag equal to 1 indicates that the difference between the current value of clockTimestamp and the value of clockTimestamp computed from the previous set of clock timestamp syntax elements in output order should not be interpreted as the time difference between the times of origin or capture of the associated frames or fields.

cnt_dropped_flag (gboolean) –

specifies the skipping of one or more values of n_frames using the counting method specified by counting_type.

n_frames (guint8) –

is used to compute clockTimestamp. When timing_info_present_flag is equal to 1, n_frames shall be less than maxFps, where maxFps is specified by maxFps = ceil( time_scale / ( 2 * num_units_in_display_tick ) ).

seconds_flag (gboolean) –

equal to 1 specifies that seconds_value and minutes_flag are present when full_timestamp_flag is equal to 0. seconds_flag equal to 0 specifies that seconds_value and minutes_flag are not present.

seconds_value (guint8) –

is used to compute clockTimestamp and shall be in the range of 0 to 59. When seconds_value is not present, its value is inferred to be equal to the value of seconds_value for the previous set of clock timestamp syntax elements in decoding order, and it is required that such a previous seconds_value shall have been present.

minutes_flag (gboolean) –

equal to 1 specifies that minutes_value and hours_flag are present when full_timestamp_flag is equal to 0 and seconds_flag is equal to 1. minutes_flag equal to 0 specifies that minutes_value and hours_flag are not present.

minutes_value (guint8) –

specifies the value of mm used to compute clockTimestamp and shall be in the range of 0 to 59, inclusive. When minutes_value is not present, its value is inferred to be equal to the value of minutes_value for the previous set of clock timestamp syntax elements in decoding order, and it is required that such a previous minutes_value shall have been present.

hours_flag (gboolean) –

equal to 1 specifies that hours_value is present when full_timestamp_flag is equal to 0 and seconds_flag is equal to 1 and minutes_flag is equal to 1.

hours_value (guint8) –

is used to compute clockTimestamp and shall be in the range of 0 to 23, inclusive. When hours_value is not present, its value is inferred to be equal to the value of hours_value for the previous set of clock timestamp syntax elements in decoding order, and it is required that such a previous hours_value shall have been present.

time_offset_length (guint8) –

greater than 0 specifies the length in bits of the time_offset_value syntax element. time_offset_length equal to 0 specifies that the time_offset_value syntax element is not present. time_offset_length should be the same for all pictures in the coded video sequence.

time_offset_value (guint32) –

is used to compute clockTimestamp. The number of bits used to represent time_offset_value is equal to time_offset_length. When time_offset_value is not present, its value is inferred to be equal to 0.


GstAV1OBU

struct _GstAV1OBU {
  GstAV1OBUHeader header;
  GstAV1OBUType obu_type;
  guint8 *data;
  guint32 obu_size;
};

It is the general representation of AV1 OBU (Open Bitstream Unit). One OBU include its header and payload.

Fields

header (GstAV1OBUHeader) –

a GstAV1OBUHeader OBU Header

obu_type (GstAV1OBUType) –

the type of data structure contained in the OBU payload.

data (guint8 *) –

references the current data chunk that holds the OBU

obu_size (guint32) –

size of the OBU, not include header size


GstAV1OBUHeader

struct _GstAV1OBUHeader {
  GstAV1OBUType obu_type;
  gboolean obu_extention_flag;
  gboolean obu_has_size_field;
  guint8 obu_temporal_id;
  guint8 obu_spatial_id;
};

Collect info for OBU header and OBU extension header if obu_extension_flag == 1.

Fields

obu_type (GstAV1OBUType) –

the type of data structure contained in the OBU payload.

obu_extention_flag (gboolean) –

indicates if OBU header extention is present.

obu_has_size_field (gboolean) –

equal to 1 indicates that the obu_size syntax element will be present. obu_has_size_field equal to 0 indicates that the obu_size syntax element will not be present.

obu_temporal_id (guint8) –

specifies the temporal level of the data contained in the OBU.

obu_spatial_id (guint8) –

specifies the spatial level of the data contained in the OBU.


GstAV1OperatingPoint

struct _GstAV1OperatingPoint {
  guint8 seq_level_idx;
  guint8 seq_tier;
  guint16 idc;
  gboolean decoder_model_present_for_this_op;
  guint8 decoder_buffer_delay;
  guint8 encoder_buffer_delay;
  gboolean low_delay_mode_flag;
  gboolean initial_display_delay_present_for_this_op;
  guint8 initial_display_delay_minus_1;
};

Fields

seq_level_idx (guint8) –

specifies the level that the coded video sequence conforms to.

seq_tier (guint8) –

specifies the tier that the coded video sequence conforms to.

idc (guint16) –

contains a bitmask that indicates which spatial and temporal layers should be decoded. Bit k is equal to 1 if temporal layer k should be decoded (for k between 0 and 7). Bit j+8 is equal to 1 if spatial layer j should be decoded (for j between 0 and 3).

decoder_model_present_for_this_op (gboolean) –

equal to one indicates that there is a decoder model associated with this operating point. decoder_model_present_for_this_op equal to zero indicates that there is not a decoder model associated.

decoder_buffer_delay (guint8) –

specifies the time interval between the arrival of the first bit in the smoothing buffer and the subsequent removal of the data that belongs to the first coded frame for operating point op, measured in units of 1/90000 seconds. The length of decoder_buffer_delay is specified by buffer_delay_length_minus_1 + 1, in bits.

encoder_buffer_delay (guint8) –

specifies, in combination with decoder_buffer_delay syntax element, the first bit arrival time of frames to be decoded to the smoothing buffer. encoder_buffer_delay is measured in units of 1/90000 seconds. For a video sequence that includes one or more random access points the sum of decoder_buffer_delay and encoder_buffer_delay shall be kept constant.

low_delay_mode_flag (gboolean) –

equal to 1 indicates that the smoothing buffer operates in low-delay mode for operating point op. In low-delay mode late decode times and buffer underflow are both permitted. low_delay_mode_flag equal to 0 indicates that the smoothing buffer operates in strict mode, where buffer underflow is not allowed.

initial_display_delay_present_for_this_op (gboolean) –

equal to 1 indicates that initial_display_delay_minus_1 is specified for this operating. 0 indicates that initial_display_delay_minus_1 is not specified for this operating point.

initial_display_delay_minus_1 (guint8) –

plus 1 specifies, for operating point i, the number of decoded frames that should be present in the buffer pool before the first presentable frame is displayed. This will ensure that all presentable frames in the sequence can be decoded at or before the time that they are scheduled for display.


GstAV1Parser

GstAV1Parser opaque structure

Instantiante it with gst_av1_parser_new and destroy it with gst_av1_parser_free


GstAV1QuantizationParams

struct _GstAV1QuantizationParams {
  guint8 base_q_idx;
  gboolean diff_uv_delta;
  gboolean using_qmatrix;
  guint8 qm_y;
  guint8 qm_u;
  guint8 qm_v;

  gboolean delta_q_present;
  guint8 delta_q_res;

  gint8 delta_q_y_dc; /* DeltaQYDc */
  gint8 delta_q_u_dc; /* DeltaQUDc */
  gint8 delta_q_u_ac; /* DeltaQUAc */
  gint8 delta_q_v_dc; /* DeltaQVDc */
  gint8 delta_q_v_ac; /* DeltaQVAc */
};

Fields

base_q_idx (guint8) –

indicates the base frame qindex. This is used for Y AC coefficients and as the base value for the other quantizers.

diff_uv_delta (gboolean) –

equal to 1 indicates that the U and V delta quantizer values are coded separately. diff_uv_delta equal to 0 indicates that the U and V delta quantizer values share a common value.

using_qmatrix (gboolean) –

specifies that the quantizer matrix will be used to compute quantizers.

qm_y (guint8) –

specifies the level in the quantizer matrix that should be used for luma plane decoding.

qm_u (guint8) –

specifies the level in the quantizer matrix that should be used for chroma U plane decoding.

qm_v (guint8) –

specifies the level in the quantizer matrix that should be used for chroma V plane decoding.

delta_q_present (gboolean) –

specifies whether quantizer index delta values are present in the bitstream.

delta_q_res (guint8) –

specifies the left shift which should be applied to decoded quantizer index delta values.

delta_q_y_dc (gint8) –

indicates the Y DC quantizer relative to base_q_idx.

delta_q_u_dc (gint8) –

indicates the U DC quantizer relative to base_q_idx.

delta_q_u_ac (gint8) –

indicates the U AC quantizer relative to base_q_idx.

delta_q_v_dc (gint8) –

indicates the V DC quantizer relative to base_q_idx.

delta_q_v_ac (gint8) –

indicates the V AC quantizer relative to base_q_idx.


GstAV1ReferenceFrameInfo

struct _GstAV1ReferenceFrameInfo {
  struct {
    gboolean ref_valid; /* RefValid */
    guint32 ref_frame_id; /* RefFrameId */
    guint32 ref_upscaled_width; /* RefUpscaledWidth */
    guint32 ref_frame_width; /* RefFrameWidth */
    guint32 ref_frame_height; /* RefFrameHeight */
    guint32 ref_render_width; /* RefRenderWidth */
    guint32 ref_render_height; /* RefRenderHeight */
    guint32 ref_mi_cols; /* RefMiCols */
    guint32 ref_mi_rows; /* RefMiRows */
    GstAV1FrameType ref_frame_type; /* RefFrameType */
    guint8 ref_subsampling_x; /* RefSubsamplingX */
    guint8 ref_subsampling_y; /* RefSubsamplingY */
    guint8 ref_bit_depth; /* RefBitDepth */
    guint32 ref_order_hint; /* RefOrderHint */
    GstAV1SegmenationParams ref_segmentation_params;
    GstAV1GlobalMotionParams ref_global_motion_params;
    GstAV1LoopFilterParams ref_lf_params;
    GstAV1FilmGrainParams ref_film_grain_params;
    GstAV1TileInfo ref_tile_info;
  } entry[GST_AV1_NUM_REF_FRAMES];
};

All the info related to a reference frames.

Fields

entry (struct (anonymous struct at /builds/gstreamer/gst-docs/gst-build/subprojects/gst-plugins-bad/gst-libs/gst/codecparsers/gstav1parser.h:1593:3) [8] ) –
No description available

GstAV1SegmenationParams

struct _GstAV1SegmenationParams {
  gboolean segmentation_enabled;
  guint8 segmentation_update_map;
  guint8 segmentation_temporal_update;
  guint8 segmentation_update_data;

  gint8 feature_enabled[GST_AV1_MAX_SEGMENTS][GST_AV1_SEG_LVL_MAX]; /* FeatureEnabled */
  gint16 feature_data[GST_AV1_MAX_SEGMENTS][GST_AV1_SEG_LVL_MAX]; /* FeatureData */
  guint8 seg_id_pre_skip; /* SegIdPreSkip */
  guint8 last_active_seg_id; /* LastActiveSegId */
};

Fields

segmentation_enabled (gboolean) –

equal to 1 indicates that this frame makes use of the segmentation tool; segmentation_enabled equal to 0 indicates that the frame does not use segmentation.

segmentation_update_map (guint8) –

equal to 1 indicates that the segmentation map are updated during the decoding of this frame. segmentation_update_map equal to 0 means that the segmentation map from the previous frame is used.

segmentation_temporal_update (guint8) –

equal to 1 indicates that the updates to the segmentation map are coded relative to the existing segmentation map. segmentation_temporal_update equal to 0 indicates that the new segmentation map is coded without reference to the existing segmentation map.

segmentation_update_data (guint8) –

equal to 1 indicates that new parameters are about to be specified for each segment. segmentation_update_data equal to 0 indicates that the segmentation parameters should keep their existing values.

feature_enabled (gint8 [8][8] ) –

set to 1 when the feature of segmentation is enabled.

feature_data (gint16 [8][8] ) –

the value of according segmentation feature.

seg_id_pre_skip (guint8) –

equal to 1 indicates that the segment id will be read before the skip syntax element. seg_id_pre_skip equal to 0 indicates that the skip syntax element will be read first.

last_active_seg_id (guint8) –

indicates the highest numbered segment id that has some enabled feature. This is used when decoding the segment id to only decode choices corresponding to used segments.


GstAV1SequenceHeaderOBU

struct _GstAV1SequenceHeaderOBU {
  GstAV1Profile seq_profile;
  gboolean still_picture;
  guint8 reduced_still_picture_header;

  guint8 frame_width_bits_minus_1;
  guint8 frame_height_bits_minus_1;
  guint16 max_frame_width_minus_1;
  guint16 max_frame_height_minus_1;

  gboolean frame_id_numbers_present_flag;
  guint8 delta_frame_id_length_minus_2;
  guint8 additional_frame_id_length_minus_1;

  gboolean use_128x128_superblock;
  gboolean enable_filter_intra;
  gboolean enable_intra_edge_filter;
  gboolean enable_interintra_compound;
  gboolean enable_masked_compound;
  gboolean enable_warped_motion;
  gboolean enable_order_hint;
  gboolean enable_dual_filter;
  gboolean enable_jnt_comp;
  gboolean enable_ref_frame_mvs;
  gboolean seq_choose_screen_content_tools;
  guint8 seq_force_screen_content_tools;
  gboolean seq_choose_integer_mv;
  guint8 seq_force_integer_mv;
  gint8 order_hint_bits_minus_1;

  gboolean enable_superres;
  gboolean enable_cdef;
  gboolean enable_restoration;

  guint8 film_grain_params_present;

  guint8 operating_points_cnt_minus_1;
  GstAV1OperatingPoint operating_points[GST_AV1_MAX_OPERATING_POINTS];

  gboolean decoder_model_info_present_flag;
  GstAV1DecoderModelInfo decoder_model_info;
  guint8 initial_display_delay_present_flag;

  gboolean timing_info_present_flag;
  GstAV1TimingInfo timing_info;

  GstAV1ColorConfig color_config;

  /* Global var calculated by sequence */
  guint8 order_hint_bits; /* OrderHintBits */
  guint8 bit_depth; /* BitDepth */
  guint8 num_planes; /* NumPlanes */
};

Fields

seq_profile (GstAV1Profile) –

specifies the features that can be used in the coded video sequence

still_picture (gboolean) –

equal to 1 specifies that the bitstream contains only one coded frame.

reduced_still_picture_header (guint8) –

specifies that the syntax elements not needed by a still picture are omitted.

frame_width_bits_minus_1 (guint8) –

specifies the number of bits minus 1 used for transmitting the frame width syntax elements.

frame_height_bits_minus_1 (guint8) –

specifies the number of bits minus 1 used for transmitting the frame height syntax elements.

max_frame_width_minus_1 (guint16) –

specifies the maximum frame width minus 1 for the frames represented by this sequenceheader.

max_frame_height_minus_1 (guint16) –

specifies the maximum frame height minus 1 for the frames represented by this sequenceheader.

frame_id_numbers_present_flag (gboolean) –

specifies whether frame id numbers are present in the bitstream.

delta_frame_id_length_minus_2 (guint8) –

specifies the number of bits minus 2 used to encode delta_frame_id syntax elements.

additional_frame_id_length_minus_1 (guint8) –

is used to calculate the number of bits used to encode the frame_id syntax element.

use_128x128_superblock (gboolean) –

when equal to 1, indicates that superblocks contain 128x128 luma samples. When equal to 0, it indicates that superblocks contain 64x64 luma samples. (The number of contained chroma samples depends on subsampling_x and subsampling_y).

enable_filter_intra (gboolean) –

equal to 1 specifies that the use_filter_intra syntax element may be present. enable_filter_intra equal to 0 specifies that the use_filter_intra syntax element will not be present.

enable_intra_edge_filter (gboolean) –

specifies whether the intra edge filtering process should be enabled.

enable_interintra_compound (gboolean) –

equal to 1 specifies that the mode info for inter blocks may contain the syntax element interintra. enable_interintra_compound equal to 0 specifies that the syntax element interintra will not be present.

enable_masked_compound (gboolean) –

equal to 1 specifies that the mode info for inter blocks may contain the syntax element compound_type. enable_masked_compound equal to 0 specifies that the syntax element compound_type will not be present.

enable_warped_motion (gboolean) –

equal to 1 indicates that the allow_warped_motion syntax element may be present. enable_warped_motion equal to 0 indicates that the allow_warped_motion syntax element will not be present.

enable_order_hint (gboolean) –

equal to 1 indicates that tools based on the values of order hints may be used. enable_order_hint equal to 0 indicates that tools based on order hints are disabled.

enable_dual_filter (gboolean) –

equal to 1 indicates that the inter prediction filter type may be specified independently in the horizontal and vertical directions. If the flag is equal to 0, only one filter type may be specified, which is then used in both directions.

enable_jnt_comp (gboolean) –

equal to 1 indicates that the distance weights process may be used for inter prediction.

enable_ref_frame_mvs (gboolean) –

equal to 1 indicates that the use_ref_frame_mvs syntax element may be present. enable_ref_frame_mvs equal to 0 indicates that the use_ref_frame_mvs syntax element will not be present.

seq_choose_screen_content_tools (gboolean) –

equal to 0 indicates that the seq_force_screen_content_tools syntax element will be present. seq_choose_screen_content_tools equal to 1 indicates that seq_force_screen_content_tools should be set equal to SELECT_SCREEN_CONTENT_TOOLS.

seq_force_screen_content_tools (guint8) –

equal to SELECT_SCREEN_CONTENT_TOOLS indicates that the allow_screen_content_tools syntax element will be present in the frame header. Otherwise, seq_force_screen_content_tools contains the value for allow_screen_content_tools.

seq_choose_integer_mv (gboolean) –

equal to 0 indicates that the seq_force_integer_mv syntax element will be present. seq_choose_integer_mv equal to 1 indicates that seq_force_integer_mv should be set equal to SELECT_INTEGER_MV.

seq_force_integer_mv (guint8) –

equal to SELECT_INTEGER_MV indicates that the force_integer_mv syntax element will be present in the frame header (providing allow_screen_content_tools is equal to 1). Otherwise, seq_force_integer_mv contains the value for force_integer_mv.

order_hint_bits_minus_1 (gint8) –

is used to compute OrderHintBits.

enable_superres (gboolean) –

equal to 1 specifies that the use_superres syntax element will be present in the uncompressed header. enable_superres equal to 0 specifies that the use_superres syntax element will not be present (instead use_superres will be set to 0 in the uncompressed header without being read).

enable_cdef (gboolean) –

equal to 1 specifies that cdef filtering may be enabled. enable_cdef equal to 0 specifies that cdef filtering is disabled.

enable_restoration (gboolean) –

equal to 1 specifies that loop restoration filtering may be enabled. enable_restoration equal to 0 specifies that loop restoration filtering is disabled.

film_grain_params_present (guint8) –

specifies whether film grain parameters are present in the bitstream.

operating_points_cnt_minus_1 (guint8) –

indicates the number of operating points minus 1 present in this bitstream.

operating_points (GstAV1OperatingPoint [32] ) –

specifies the corresponding operating point for a set of operating parameters.

decoder_model_info_present_flag (gboolean) –

specifies whether the decoder model info is present in the bitstream.

decoder_model_info (GstAV1DecoderModelInfo) –

holds information about the decoder model.

initial_display_delay_present_flag (guint8) –

specifies whether initial display delay information is present in the bitstream or not.

timing_info_present_flag (gboolean) –

specifies whether timing info is present in the bitstream.

timing_info (GstAV1TimingInfo) –

holds the timing information.

color_config (GstAV1ColorConfig) –

hold the color configuration.

order_hint_bits (guint8) –

specifies the number of bits used for the order_hint syntax element.

bit_depth (guint8) –

the bit depth of the stream.

num_planes (guint8) –

the YUV plane number.


GstAV1TileGroupOBU

struct _GstAV1TileGroupOBU {
  gboolean tile_start_and_end_present_flag;
  guint8 tg_start;
  guint8 tg_end;
  struct {
    /* global varialbes */
    guint32 mi_row_start; /* MiRowStart */
    guint32 mi_row_end; /* MiRowEnd */
    guint32 mi_col_start; /* MiColStart */
    guint32 mi_col_end; /* MiColEnd */
  } entry[GST_AV1_MAX_TILE_COUNT];

  guint32 num_tiles; /* NumTiles */
};

Fields

tile_start_and_end_present_flag (gboolean) –
No description available
tg_start (guint8) –
No description available
tg_end (guint8) –
No description available
entry (struct (anonymous struct at /builds/gstreamer/gst-docs/gst-build/subprojects/gst-plugins-bad/gst-libs/gst/codecparsers/gstav1parser.h:1672:3) [512] ) –
No description available
num_tiles (guint32) –
No description available

GstAV1TileInfo

struct _GstAV1TileInfo {
  guint8 uniform_tile_spacing_flag;
  gint increment_tile_rows_log2;
  gint width_in_sbs_minus_1[GST_AV1_MAX_TILE_COLS];
  gint height_in_sbs_minus_1[GST_AV1_MAX_TILE_ROWS];
  gint tile_size_bytes_minus_1;
  guint8 context_update_tile_id;

  guint32 mi_col_starts[GST_AV1_MAX_TILE_COLS + 1]; /* MiColStarts */
  guint32 mi_row_starts[GST_AV1_MAX_TILE_ROWS + 1]; /* MiRowStarts */
  guint8 tile_cols_log2; /* TileColsLog2 */
  guint8 tile_cols; /* TileCols */
  guint8 tile_rows_log2; /* TileRowsLog2 */
  guint8 tile_rows; /* TileRows */
  guint8 tile_size_bytes; /* TileSizeBytes */
};

Fields

uniform_tile_spacing_flag (guint8) –

equal to 1 means that the tiles are uniformly spaced across the frame. (In other words, all tiles are the same size except for the ones at the right and bottom edge which can be smaller.) uniform_tile_spacing_flag equal to 0 means that the tile sizes are coded.

increment_tile_rows_log2 (gint) –

is used to compute tile_rows_log2.

width_in_sbs_minus_1 (gint [64] ) –

specifies the width of a tile minus 1 in units of superblocks.

height_in_sbs_minus_1 (gint [64] ) –

specifies the height of a tile minus 1 in units of superblocks.

tile_size_bytes_minus_1 (gint) –

is used to compute tile_size_bytes

context_update_tile_id (guint8) –

specifies which tile to use for the CDF update.

mi_col_starts (guint32 [65] ) –

is an array specifying the start column (in units of 4x4 luma samples) for each tile across the image.

mi_row_starts (guint32 [65] ) –

is an array specifying the start row (in units of 4x4 luma samples) for each tile down the image.

tile_cols_log2 (guint8) –

specifies the base 2 logarithm of the desired number of tiles across the frame.

tile_cols (guint8) –

specifies the number of tiles across the frame. It is a requirement of bitstream conformance that tile_cols is less than or equal to GST_AV1_MAX_TILE_COLS.

tile_rows_log2 (guint8) –

specifies the base 2 logarithm of the desired number of tiles down the frame.

tile_rows (guint8) –

specifies the number of tiles down the frame. It is a requirement of bitstream conformance that tile_rows is less than or equal to GST_AV1_MAX_TILE_ROWS.

tile_size_bytes (guint8) –

specifies the number of bytes needed to code each tile size.


GstAV1TileListOBU

struct _GstAV1TileListOBU {
  guint8 output_frame_width_in_tiles_minus_1;
  guint8 output_frame_height_in_tiles_minus_1;
  guint16 tile_count_minus_1;
  struct {
    guint8 anchor_frame_idx;
    guint8 anchor_tile_row;
    guint8 anchor_tile_col;
    guint16 tile_data_size_minus_1;
    /* Just refer to obu's data, invalid after OBU data released */
    guint8 *coded_tile_data;
  } entry[GST_AV1_MAX_TILE_COUNT];
};

Fields

output_frame_width_in_tiles_minus_1 (guint8) –
No description available
output_frame_height_in_tiles_minus_1 (guint8) –
No description available
tile_count_minus_1 (guint16) –
No description available
entry (struct (anonymous struct at /builds/gstreamer/gst-docs/gst-build/subprojects/gst-plugins-bad/gst-libs/gst/codecparsers/gstav1parser.h:1638:3) [512] ) –
No description available

GstAV1TimingInfo

struct _GstAV1TimingInfo {
  guint32 num_units_in_display_tick;
  guint32 time_scale;
  gboolean equal_picture_interval;
  guint32 num_ticks_per_picture_minus_1;
};

Fields

num_units_in_display_tick (guint32) –

is the number of time units of a clock operating at the frequency time_scale Hz that corresponds to one increment of a clock tick counter. A clock tick, in seconds, is equal to num_units_in_display_tick divided by time_scale. It is a requirement of bitstream conformance that num_units_in_display_tick is greater than 0.

time_scale (guint32) –

is the number of time units that pass in one second. It is a requirement of bitstream conformance that time_scale is greater than 0.

equal_picture_interval (gboolean) –

equal to 1 indicates that pictures should be displayed according to their output order with the number of ticks between two consecutive pictures (without dropping frames) specified by num_ticks_per_picture_minus_1 + 1. equal_picture_interval equal to 0 indicates that the interval between two consecutive pictures is not specified.

num_ticks_per_picture_minus_1 (guint32) –

plus 1 specifies the number of clock ticks corresponding to output time between two consecutive pictures in the output order. It is a requirement of bitstream conformance that the value of num_ticks_per_picture_minus_1 shall be in the range of 0 to (1 << 32) - 2, inclusive.


Enumerations

GstAV1ChromaSamplePositions

typedef enum {
  GST_AV1_CSP_UNKNOWN = 0,
  GST_AV1_CSP_VERTICAL = 1,
  GST_AV1_CSP_COLOCATED = 2,
  GST_AV1_CSP_RESERVED = 3,
} GstAV1ChromaSamplePositions;

Members

GST_AV1_CSP_UNKNOWN (0) –

Unknown (in this case the source video transfer function must be signaled outside the AV1 bitstream).

GST_AV1_CSP_VERTICAL (1) –

Horizontally co-located with (0, 0) luma sample, vertical position in the middle between two luma samples.

GST_AV1_CSP_COLOCATED (2) –

co-located with (0, 0) luma sample.

GST_AV1_CSP_RESERVED (3) –

For future use.


GstAV1ColorPrimaries

typedef enum {
  GST_AV1_CP_BT_709 = 1,
  GST_AV1_CP_UNSPECIFIED = 2,
  GST_AV1_CP_BT_470_M = 4,
  GST_AV1_CP_BT_470_B_G = 5,
  GST_AV1_CP_BT_601 = 6,
  GST_AV1_CP_SMPTE_240 = 7,
  GST_AV1_CP_GENERIC_FILM = 8,
  GST_AV1_CP_BT_2020 = 9,
  GST_AV1_CP_XYZ = 10,
  GST_AV1_CP_SMPTE_431 = 11,
  GST_AV1_CP_SMPTE_432 = 12,
  GST_AV1_CP_EBU_3213 = 22,
} GstAV1ColorPrimaries;

Members

GST_AV1_CP_BT_709 (1) –

BT.709

GST_AV1_CP_UNSPECIFIED (2) –

Unspecified

GST_AV1_CP_BT_470_M (4) –

BT.470 System M (historical)

GST_AV1_CP_BT_470_B_G (5) –

BT.470 System B, G (historical),

GST_AV1_CP_BT_601 (6) –

BT.601

GST_AV1_CP_SMPTE_240 (7) –

SMPTE 240

GST_AV1_CP_GENERIC_FILM (8) –

Generic film (color filters using illuminant C,

GST_AV1_CP_BT_2020 (9) –

BT.2020, BT.2100,

GST_AV1_CP_XYZ (10) –

SMPTE 428 (CIE 1921 XYZ),

GST_AV1_CP_SMPTE_431 (11) –

SMPTE RP 431-2

GST_AV1_CP_SMPTE_432 (12) –

SMPTE EG 432-1

GST_AV1_CP_EBU_3213 (22) –

EBU Tech. 3213-E


GstAV1FrameRestorationType

typedef enum {
  GST_AV1_FRAME_RESTORE_NONE = 0,
  GST_AV1_FRAME_RESTORE_WIENER = 1,
  GST_AV1_FRAME_RESTORE_SGRPROJ = 2,
  GST_AV1_FRAME_RESTORE_SWITCHABLE = 3,
} GstAV1FrameRestorationType;

Members

GST_AV1_FRAME_RESTORE_NONE (0) –

no filtering is applied

GST_AV1_FRAME_RESTORE_WIENER (1) –

Wiener filter process is invoked

GST_AV1_FRAME_RESTORE_SGRPROJ (2) –

self guided filter proces is invoked

GST_AV1_FRAME_RESTORE_SWITCHABLE (3) –

restoration filter is swichtable


GstAV1FrameType

typedef enum {
  GST_AV1_KEY_FRAME = 0,
  GST_AV1_INTER_FRAME = 1,
  GST_AV1_INTRA_ONLY_FRAME = 2,
  GST_AV1_SWITCH_FRAME = 3,
} GstAV1FrameType;

Members

GST_AV1_KEY_FRAME (0) –

Key Frame

GST_AV1_INTER_FRAME (1) –

InterFrame

GST_AV1_INTRA_ONLY_FRAME (2) –

Intra-Only Frame

GST_AV1_SWITCH_FRAME (3) –

Switch Frame


GstAV1InterpolationFilter

typedef enum {
  GST_AV1_INTERPOLATION_FILTER_EIGHTTAP = 0,
  GST_AV1_INTERPOLATION_FILTER_EIGHTTAP_SMOOTH = 1,
  GST_AV1_INTERPOLATION_FILTER_EIGHTTAP_SHARP = 2,
  GST_AV1_INTERPOLATION_FILTER_BILINEAR = 3,
  GST_AV1_INTERPOLATION_FILTER_SWITCHABLE = 4,
} GstAV1InterpolationFilter;

Members

GST_AV1_INTERPOLATION_FILTER_EIGHTTAP (0) –

Eighttap

GST_AV1_INTERPOLATION_FILTER_EIGHTTAP_SMOOTH (1) –

Eighttap Smooth

GST_AV1_INTERPOLATION_FILTER_EIGHTTAP_SHARP (2) –

Eighttap Sharp

GST_AV1_INTERPOLATION_FILTER_BILINEAR (3) –

Bilinear

GST_AV1_INTERPOLATION_FILTER_SWITCHABLE (4) –

Filter is swichtable


GstAV1MatrixCoefficients

typedef enum {
  GST_AV1_MC_IDENTITY = 0,
  GST_AV1_MC_BT_709 = 1,
  GST_AV1_MC_UNSPECIFIED = 2,
  GST_AV1_MC_RESERVED_3 = 3,
  GST_AV1_MC_FCC = 4,
  GST_AV1_MC_BT_470_B_G = 5,
  GST_AV1_MC_BT_601 = 6,
  GST_AV1_MC_SMPTE_240 = 7,
  GST_AV1_MC_SMPTE_YCGCO = 8,
  GST_AV1_MC_BT_2020_NCL = 9,
  GST_AV1_MC_BT_2020_CL = 10,
  GST_AV1_MC_SMPTE_2085 = 11,
  GST_AV1_MC_CHROMAT_NCL = 12,
  GST_AV1_MC_CHROMAT_CL = 13,
  GST_AV1_MC_ICTCP = 14,
} GstAV1MatrixCoefficients;

Members

GST_AV1_MC_IDENTITY (0) –

Identity matrix

GST_AV1_MC_BT_709 (1) –

BT.709

GST_AV1_MC_UNSPECIFIED (2) –

Unspecified

GST_AV1_MC_RESERVED_3 (3) –

For future use

GST_AV1_MC_FCC (4) –

US FCC 73.628

GST_AV1_MC_BT_470_B_G (5) –

BT.470 System B, G (historical)

GST_AV1_MC_BT_601 (6) –

BT.601

GST_AV1_MC_SMPTE_240 (7) –

SMPTE 240 M

GST_AV1_MC_SMPTE_YCGCO (8) –

YCgCo

GST_AV1_MC_BT_2020_NCL (9) –

BT.2020 non-constant luminance, BT.2100 YCbCr

GST_AV1_MC_BT_2020_CL (10) –

BT.2020 constant luminance

GST_AV1_MC_SMPTE_2085 (11) –

SMPTE ST 2085 YDzDx

GST_AV1_MC_CHROMAT_NCL (12) –

Chromaticity-derived non-constant luminance

GST_AV1_MC_CHROMAT_CL (13) –

Chromaticity-derived constant luminancw

GST_AV1_MC_ICTCP (14) –

BT.2100 ICtCp


GstAV1MetadataType

typedef enum {
  GST_AV1_METADATA_TYPE_RESERVED_0 = 0,
  GST_AV1_METADATA_TYPE_HDR_CLL = 1,
  GST_AV1_METADATA_TYPE_HDR_MDCV = 2,
  GST_AV1_METADATA_TYPE_SCALABILITY = 3,
  GST_AV1_METADATA_TYPE_ITUT_T35 = 4,
  GST_AV1_METADATA_TYPE_TIMECODE = 5,
} GstAV1MetadataType;

Members

GST_AV1_METADATA_TYPE_RESERVED_0 (0) –

Reserved 0

GST_AV1_METADATA_TYPE_HDR_CLL (1) –

Metadata high dynamic range content light level semantics

GST_AV1_METADATA_TYPE_HDR_MDCV (2) –

Metadata high dynamic range mastering display color volume semantics

GST_AV1_METADATA_TYPE_SCALABILITY (3) –

Metadata scalability semantics

GST_AV1_METADATA_TYPE_ITUT_T35 (4) –

Metadata ITUT T35 semantics

GST_AV1_METADATA_TYPE_TIMECODE (5) –

Timecode semantics


GstAV1OBUType

typedef enum {
  GST_AV1_OBU_RESERVED_0 = 0,
  GST_AV1_OBU_SEQUENCE_HEADER = 1,
  GST_AV1_OBU_TEMPORAL_DELIMITER = 2,
  GST_AV1_OBU_FRAME_HEADER = 3,
  GST_AV1_OBU_TILE_GROUP = 4,
  GST_AV1_OBU_METADATA = 5,
  GST_AV1_OBU_FRAME = 6,
  GST_AV1_OBU_REDUNDANT_FRAME_HEADER = 7,
  GST_AV1_OBU_TILE_LIST = 8,
  GST_AV1_OBU_RESERVED_9 = 9,
  GST_AV1_OBU_RESERVED_10 = 10,
  GST_AV1_OBU_RESERVED_11 = 11,
  GST_AV1_OBU_RESERVED_12 = 12,
  GST_AV1_OBU_RESERVED_13 = 13,
  GST_AV1_OBU_RESERVED_14 = 14,
  GST_AV1_OBU_PADDING = 15,
} GstAV1OBUType;

Defines all the possible OBU types

Members

GST_AV1_OBU_RESERVED_0 (0) –

Reserved 0

GST_AV1_OBU_SEQUENCE_HEADER (1) –

Sequence Header OBU

GST_AV1_OBU_TEMPORAL_DELIMITER (2) –

Temporal Delimiter OBU

GST_AV1_OBU_FRAME_HEADER (3) –

Frame Header OBU

GST_AV1_OBU_TILE_GROUP (4) –

Tile Group OBU

GST_AV1_OBU_METADATA (5) –

Metadata OBU

GST_AV1_OBU_FRAME (6) –

Frame OBU (includes Frame Header and one Tile Group)

GST_AV1_OBU_REDUNDANT_FRAME_HEADER (7) –

Redundant Frame Header OBU

GST_AV1_OBU_TILE_LIST (8) –

Tile LIst OBU

GST_AV1_OBU_RESERVED_9 (9) –

Reserved 9

GST_AV1_OBU_RESERVED_10 (10) –

Reserved 10

GST_AV1_OBU_RESERVED_11 (11) –

Reserved 11

GST_AV1_OBU_RESERVED_12 (12) –

Reserved 12

GST_AV1_OBU_RESERVED_13 (13) –

Reserved 13

GST_AV1_OBU_RESERVED_14 (14) –

Reserved 14

GST_AV1_OBU_PADDING (15) –

Padding


GstAV1ParserResult

typedef enum {
  GST_AV1_PARSER_OK = 0,
  GST_AV1_PARSER_NO_MORE_DATA = 1,
  GST_AV1_PARSER_DROP = 2,
  GST_AV1_PARSER_BITSTREAM_ERROR = 3,
  GST_AV1_PARSER_MISSING_OBU_REFERENCE = 4,
  GST_AV1_PARSER_INVALID_OPERATION = 5,
} GstAV1ParserResult;

Defines the result of parser process

Members

GST_AV1_PARSER_OK (0) –

successful return

GST_AV1_PARSER_NO_MORE_DATA (1) –

the parser needs more data for one OBU

GST_AV1_PARSER_DROP (2) –

no need to handle this OBU, skip it

GST_AV1_PARSER_BITSTREAM_ERROR (3) –

stream error, for example, include invalid bits

GST_AV1_PARSER_MISSING_OBU_REFERENCE (4) –

no reference, for example, no sequence found

GST_AV1_PARSER_INVALID_OPERATION (5) –

something like invalid parameters


GstAV1Profile

typedef enum {
  GST_AV1_PROFILE_0 = 0,
  GST_AV1_PROFILE_1 = 1,
  GST_AV1_PROFILE_2 = 2,
} GstAV1Profile;

Defines the AV1 profiles

Members

GST_AV1_PROFILE_0 (0) –

8-bit and 10-bit 4:2:0 and 4:0:0 only.

GST_AV1_PROFILE_1 (1) –

8-bit and 10-bit 4:4:4.

GST_AV1_PROFILE_2 (2) –

8-bit and 10-bit 4:2:2, 12-bit 4:0:0 4:2:2 and 4:4:4


GstAV1ReferenceFrame

typedef enum {
  GST_AV1_REF_INTRA_FRAME = 0,
  GST_AV1_REF_LAST_FRAME = 1,
  GST_AV1_REF_LAST2_FRAME = 2,
  GST_AV1_REF_LAST3_FRAME = 3,
  GST_AV1_REF_GOLDEN_FRAME = 4,
  GST_AV1_REF_BWDREF_FRAME = 5,
  GST_AV1_REF_ALTREF2_FRAME = 6,
  GST_AV1_REF_ALTREF_FRAME = 7,
  GST_AV1_NUM_REF_FRAMES
} GstAV1ReferenceFrame;

Members

GST_AV1_REF_INTRA_FRAME (0) –

Intra Frame Reference

GST_AV1_REF_LAST_FRAME (1) –

Last Reference Frame

GST_AV1_REF_LAST2_FRAME (2) –

Last2 Reference Frame

GST_AV1_REF_LAST3_FRAME (3) –

Last3 Reference Frame

GST_AV1_REF_GOLDEN_FRAME (4) –

Golden Reference Frame

GST_AV1_REF_BWDREF_FRAME (5) –

BWD Reference Frame

GST_AV1_REF_ALTREF2_FRAME (6) –

Alternative2 Reference Frame

GST_AV1_REF_ALTREF_FRAME (7) –

Alternative Reference Frame

GST_AV1_NUM_REF_FRAMES (8) –

Total Reference Frame Number


GstAV1ScalabilityModes

typedef enum {
  GST_AV1_SCALABILITY_L1T2 = 0,
  GST_AV1_SCALABILITY_L1T3 = 1,
  GST_AV1_SCALABILITY_L2T1 = 2,
  GST_AV1_SCALABILITY_L2T2 = 3,
  GST_AV1_SCALABILITY_L2T3 = 4,
  GST_AV1_SCALABILITY_S2T1 = 5,
  GST_AV1_SCALABILITY_S2T2 = 6,
  GST_AV1_SCALABILITY_S2T3 = 7,
  GST_AV1_SCALABILITY_L2T1h = 8,
  GST_AV1_SCALABILITY_L2T2h = 9,
  GST_AV1_SCALABILITY_L2T3h = 10,
  GST_AV1_SCALABILITY_S2T1h = 11,
  GST_AV1_SCALABILITY_S2T2h = 12,
  GST_AV1_SCALABILITY_S2T3h = 13,
  GST_AV1_SCALABILITY_SS = 14,
} GstAV1ScalabilityModes;

Members

GST_AV1_SCALABILITY_L1T2 (0) –

1 spatial layer, 2 temporal layers

GST_AV1_SCALABILITY_L1T3 (1) –

1 spatial layer, 3 temporal layers

GST_AV1_SCALABILITY_L2T1 (2) –

2 spatial layer (ratio 2:1), 1 temporal layer, inter-layer dependency

GST_AV1_SCALABILITY_L2T2 (3) –

2 spatial layer (ratio 2:1), 2 temporal layer, inter-layer dependency

GST_AV1_SCALABILITY_L2T3 (4) –

2 spatial layer (ratio 2:1), 3 temporal layer, inter-layer dependency

GST_AV1_SCALABILITY_S2T1 (5) –

2 spatial layer (ratio 2:1), 1 temporal layer

GST_AV1_SCALABILITY_S2T2 (6) –

2 spatial layer (ratio 2:1), 2 temporal layer

GST_AV1_SCALABILITY_S2T3 (7) –

2 spatial layer (ratio 2:1), 3 temporal layer

GST_AV1_SCALABILITY_L2T1h (8) –

2 spatial layer (ratio 1.5:1), 1 temporal layer, inter-layer dependency

GST_AV1_SCALABILITY_L2T2h (9) –

2 spatial layer (ratio 1.5:1), 2 temporal layer, inter-layer dependency

GST_AV1_SCALABILITY_L2T3h (10) –

2 spatial layer (ratio 1.5:1), 3 temporal layer, inter-layer dependency

GST_AV1_SCALABILITY_S2T1h (11) –

2 spatial layer (ratio 1.5:1), 1 temporal layer

GST_AV1_SCALABILITY_S2T2h (12) –

2 spatial layer (ratio 1.5:1), 2 temporal layer

GST_AV1_SCALABILITY_S2T3h (13) –

2 spatial layer (ratio 1.5:1), 3 temporal layer

GST_AV1_SCALABILITY_SS (14) –

Use scalability structure GstAV1MetadataScalability


GstAV1SeqLevels

typedef enum {
  GST_AV1_SEQ_LEVEL_2_0 = 0,
  GST_AV1_SEQ_LEVEL_2_1 = 1,
  GST_AV1_SEQ_LEVEL_2_2 = 2,
  GST_AV1_SEQ_LEVEL_2_3 = 3,
  GST_AV1_SEQ_LEVEL_3_0 = 4,
  GST_AV1_SEQ_LEVEL_3_1 = 5,
  GST_AV1_SEQ_LEVEL_3_2 = 6,
  GST_AV1_SEQ_LEVEL_3_3 = 7,
  GST_AV1_SEQ_LEVEL_4_0 = 8,
  GST_AV1_SEQ_LEVEL_4_1 = 9,
  GST_AV1_SEQ_LEVEL_4_2 = 10,
  GST_AV1_SEQ_LEVEL_4_3 = 11,
  GST_AV1_SEQ_LEVEL_5_0 = 12,
  GST_AV1_SEQ_LEVEL_5_1 = 13,
  GST_AV1_SEQ_LEVEL_5_2 = 14,
  GST_AV1_SEQ_LEVEL_5_3 = 15,
  GST_AV1_SEQ_LEVEL_6_0 = 16,
  GST_AV1_SEQ_LEVEL_6_1 = 17,
  GST_AV1_SEQ_LEVEL_6_2 = 18,
  GST_AV1_SEQ_LEVEL_6_3 = 19,
  GST_AV1_SEQ_LEVEL_7_0 = 20,
  GST_AV1_SEQ_LEVEL_7_1 = 21,
  GST_AV1_SEQ_LEVEL_7_2 = 22,
  GST_AV1_SEQ_LEVEL_7_3 = 23,
  GST_AV1_SEQ_LEVELS,
  GST_AV1_SEQ_LEVEL_MAX = 31
} GstAV1SeqLevels;

Defines all the possible OBU types

Members

GST_AV1_SEQ_LEVEL_2_0 (0) –

Level 2.0

GST_AV1_SEQ_LEVEL_2_1 (1) –

Level 2.1

GST_AV1_SEQ_LEVEL_2_2 (2) –

Level 2.2

GST_AV1_SEQ_LEVEL_2_3 (3) –

Level 2.3

GST_AV1_SEQ_LEVEL_3_0 (4) –

Level 3.0

GST_AV1_SEQ_LEVEL_3_1 (5) –

Level 3.1

GST_AV1_SEQ_LEVEL_3_2 (6) –

Level 3.2

GST_AV1_SEQ_LEVEL_3_3 (7) –

Level 3.3

GST_AV1_SEQ_LEVEL_4_0 (8) –

Level 4.0

GST_AV1_SEQ_LEVEL_4_1 (9) –

Level 4.1

GST_AV1_SEQ_LEVEL_4_2 (10) –

Level 4.2

GST_AV1_SEQ_LEVEL_4_3 (11) –

Level 4.3

GST_AV1_SEQ_LEVEL_5_0 (12) –

Level 5.0

GST_AV1_SEQ_LEVEL_5_1 (13) –

Level 5.1

GST_AV1_SEQ_LEVEL_5_2 (14) –

Level 5.2

GST_AV1_SEQ_LEVEL_5_3 (15) –

Level 5.3

GST_AV1_SEQ_LEVEL_6_0 (16) –

Level 6.0

GST_AV1_SEQ_LEVEL_6_1 (17) –

Level 6.1

GST_AV1_SEQ_LEVEL_6_2 (18) –

Level 6.2

GST_AV1_SEQ_LEVEL_6_3 (19) –

Level 6.3

GST_AV1_SEQ_LEVEL_7_0 (20) –

Level 7.0

GST_AV1_SEQ_LEVEL_7_1 (21) –

Level 7.1

GST_AV1_SEQ_LEVEL_7_2 (22) –

Level 7.2

GST_AV1_SEQ_LEVEL_7_3 (23) –

Level 7.3

GST_AV1_SEQ_LEVELS (24) –

all valid levels

GST_AV1_SEQ_LEVEL_MAX (31) –

Maximum parameters


GstAV1TXModes

typedef enum {
  GST_AV1_TX_MODE_ONLY_4x4 = 0,
  GST_AV1_TX_MODE_LARGEST = 1,
  GST_AV1_TX_MODE_SELECT = 2,
} GstAV1TXModes;

Members

GST_AV1_TX_MODE_ONLY_4x4 (0) –

the inverse transform will use only 4x4 transforms.

GST_AV1_TX_MODE_LARGEST (1) –

the inverse transform will use the largest transform size that fits inside the block.

GST_AV1_TX_MODE_SELECT (2) –

the choice of transform size is specified explicitly for each block.


GstAV1TransferCharacteristics

typedef enum {
  GST_AV1_TC_RESERVED_0 = 0,
  GST_AV1_TC_BT_709 = 1,
  GST_AV1_TC_UNSPECIFIED = 2,
  GST_AV1_TC_RESERVED_3 = 3,
  GST_AV1_TC_BT_470_M = 4,
  GST_AV1_TC_BT_470_B_G = 5,
  GST_AV1_TC_BT_601 = 6,
  GST_AV1_TC_SMPTE_240 = 7,
  GST_AV1_TC_LINEAR = 8,
  GST_AV1_TC_LOG_100 = 9,
  GST_AV1_TC_LOG_100_SQRT10 = 10,
  GST_AV1_TC_IEC_61966 = 11,
  GST_AV1_TC_BT_1361 = 12,
  GST_AV1_TC_SRGB = 13,
  GST_AV1_TC_BT_2020_10_BIT = 14,
  GST_AV1_TC_BT_2020_12_BIT = 15,
  GST_AV1_TC_SMPTE_2084 = 16,
  GST_AV1_TC_SMPTE_428 = 17,
  GST_AV1_TC_HLG = 18,
} GstAV1TransferCharacteristics;

Members

GST_AV1_TC_RESERVED_0 (0) –

For future use

GST_AV1_TC_BT_709 (1) –

BT.709

GST_AV1_TC_UNSPECIFIED (2) –

Unspecified

GST_AV1_TC_RESERVED_3 (3) –

For future use

GST_AV1_TC_BT_470_M (4) –

BT.470 System M (historical)

GST_AV1_TC_BT_470_B_G (5) –

BT.470 System B, G (historical)

GST_AV1_TC_BT_601 (6) –

BT.601

GST_AV1_TC_SMPTE_240 (7) –

SMPTE 240 M

GST_AV1_TC_LINEAR (8) –

Linear

GST_AV1_TC_LOG_100 (9) –

Logarithmic (100 : 1 range)

GST_AV1_TC_LOG_100_SQRT10 (10) –

Logarithmic (100 * Sqrt(10) : 1 range)

GST_AV1_TC_IEC_61966 (11) –

IEC 61966-2-4

GST_AV1_TC_BT_1361 (12) –

BT.1361

GST_AV1_TC_SRGB (13) –

sRGB or sYCC

GST_AV1_TC_BT_2020_10_BIT (14) –

BT.2020 10-bit systems

GST_AV1_TC_BT_2020_12_BIT (15) –

BT.2020 12-bit systems

GST_AV1_TC_SMPTE_2084 (16) –

SMPTE ST 2084, ITU BT.2100 PQ

GST_AV1_TC_SMPTE_428 (17) –

SMPTE ST 428

GST_AV1_TC_HLG (18) –

BT.2100 HLG, ARIB STD-B67


GstAV1WarpModelType

typedef enum {
  GST_AV1_WARP_MODEL_IDENTITY = 0,
  GST_AV1_WARP_MODEL_TRANSLATION = 1,
  GST_AV1_WARP_MODEL_ROTZOOM = 2,
  GST_AV1_WARP_MODEL_AFFINE = 3,
} GstAV1WarpModelType;

Members

GST_AV1_WARP_MODEL_IDENTITY (0) –

Warp model is just an identity transform

GST_AV1_WARP_MODEL_TRANSLATION (1) –

Warp model is a pure translation

GST_AV1_WARP_MODEL_ROTZOOM (2) –

Warp model is a rotation + symmetric zoom + translation

GST_AV1_WARP_MODEL_AFFINE (3) –

Warp model is a general affine transform


The results of the search are