GstCodecs.AV1Decoder¶

Subclasses:: None

Methods¶

Inherited:: GstVideo.VideoDecoder (43), Gst.Element (81), Gst.Object (27), GObject.Object (37)
Structs:: Gst.ElementClass (10), GObject.ObjectClass (5)

Virtual Methods¶

Inherited:: GstVideo.VideoDecoder (21), Gst.Element (16), Gst.Object (1), GObject.Object (7)

	`do_decode_tile` (picture, tile)
	`do_duplicate_picture` (frame, picture)
	`do_end_picture` (picture)
	`do_get_preferred_output_delay` (live)
	`do_new_picture` (frame, picture)
	`do_output_picture` (frame, picture)
	`do_start_picture` (picture, dpb)

Properties¶

Inherited:: GstVideo.VideoDecoder (6), Gst.Object (2)

Signals¶

Inherited:: Gst.Element (3), Gst.Object (1), GObject.Object (1)

Fields¶

Inherited:: Gst.Element (3), Gst.Object (1), GObject.Object (1)

Name	Type	Access
highest_spatial_layer	`int`	r
input_state	`GstVideo.VideoCodecState`	r
padding	[`object`]	r
parent	`GstVideo.VideoDecoder`	r

Class Details¶

class GstCodecs.AV1Decoder(**kwargs)¶

Bases:: GstVideo.VideoDecoder
Abstract:: Yes
Structure:: GstCodecs.AV1DecoderClass

The opaque GstCodecs.AV1Decoder data structure.

New in version 1.20.

do_decode_tile(picture, tile) virtual¶

Parameters:

picture (GstCodecs.AV1Picture) – a GstCodecs.AV1Picture
tile (GstCodecs.AV1Tile) – a GstCodecs.AV1Tile

Return type:

Gst.FlowReturn

Provides the tile data with tile group header and required raw bitstream for subclass to decode it.

New in version 1.20.

do_duplicate_picture(frame, picture) virtual¶

Parameters:

frame (GstVideo.VideoCodecFrame) – the current GstVideo.VideoCodecFrame
picture (GstCodecs.AV1Picture) – a GstCodecs.AV1Picture

Return type:

GstCodecs.AV1Picture

Called when need to duplicate an existing GstCodecs.AV1Picture. As duplicated key-frame will populate the DPB, this virtual function is not optional.

New in version 1.22.

do_end_picture(picture) virtual¶

Parameters:: picture (GstCodecs.AV1Picture) – a GstCodecs.AV1Picture
Return type:: Gst.FlowReturn

Optional. Called per one GstCodecs.AV1Picture to notify subclass to finish decoding process for the GstCodecs.AV1Picture

New in version 1.20.

do_get_preferred_output_delay(live) virtual¶

Parameters:: live (bool) – whether upstream is live or not
Returns:: the number of perferred delayed output frame
Return type:: int

Optional. Called by baseclass to query whether delaying output is preferred by subclass or not.

New in version 1.22.

do_new_picture(frame, picture) virtual¶

Parameters:

frame (GstVideo.VideoCodecFrame) – a GstVideo.VideoCodecFrame
picture (GstCodecs.AV1Picture) – a GstCodecs.AV1Picture

Return type:

Gst.FlowReturn

Optional. Called whenever new GstCodecs.AV1Picture is created. Subclass can set implementation specific user data on the GstCodecs.AV1Picture via GstCodecs.AV1Picture.set_user_data()

New in version 1.20.

do_output_picture(frame, picture) virtual¶

Parameters:

frame (GstVideo.VideoCodecFrame) – a GstVideo.VideoCodecFrame
picture (GstCodecs.AV1Picture) – a GstCodecs.AV1Picture

Return type:

Gst.FlowReturn

Called with a GstCodecs.AV1Picture which is required to be outputted. The GstVideo.VideoCodecFrame must be consumed by subclass.

New in version 1.20.

do_start_picture(picture, dpb) virtual¶

Parameters:

picture (GstCodecs.AV1Picture) – a GstCodecs.AV1Picture
dpb (GstCodecs.AV1Dpb) – a GstCodecs.AV1Dpb

Return type:

Gst.FlowReturn

Optional. Called per one GstCodecs.AV1Picture to notify subclass to prepare decoding process for the GstCodecs.AV1Picture

New in version 1.20.