Struct gstreamer_video::VideoDecoder

[+] Show declaration

pub struct VideoDecoder(_, _);

[−] Expand description

This base class is for video decoders turning encoded data into raw video frames.

The GstVideoDecoder base class and derived subclasses should cooperate as follows:

Configuration

• Initially, GstVideoDecoder calls start when the decoder element is activated, which allows the subclass to perform any global setup.

• GstVideoDecoder calls set_format to inform the subclass of caps describing input video data that it is about to receive, including possibly configuration data. While unlikely, it might be called more than once, if changing input parameters require reconfiguration.

• Incoming data buffers are processed as needed, described in Data Processing below.

• GstVideoDecoder calls stop at end of all processing.

Data processing

• The base class gathers input data, and optionally allows subclass to parse this into subsequently manageable chunks, typically corresponding to and referred to as 'frames'.

• Each input frame is provided in turn to the subclass' handle_frame callback. The ownership of the frame is given to the handle_frame callback.

• If codec processing results in decoded data, the subclass should call VideoDecoder::finish_frame to have decoded data pushed. downstream. Otherwise, the subclass must call VideoDecoder::drop_frame, to allow the base class to do timestamp and offset tracking, and possibly to requeue the frame for a later attempt in the case of reverse playback.

Shutdown phase

• The GstVideoDecoder class calls stop to inform the subclass that data parsing will be stopped.

Additional Notes

• Seeking/Flushing

• When the pipeline is seeked or otherwise flushed, the subclass is informed via a call to its reset callback, with the hard parameter set to true. This indicates the subclass should drop any internal data queues and timestamps and prepare for a fresh set of buffers to arrive for parsing and decoding.

• End Of Stream

• At end-of-stream, the subclass parse function may be called some final times with the at_eos parameter set to true, indicating that the element should not expect any more data to be arriving, and it should parse and remaining frames and call VideoDecoder::have_frame if possible.

The subclass is responsible for providing pad template caps for source and sink pads. The pads need to be named "sink" and "src". It also needs to provide information about the ouptput caps, when they are known. This may be when the base class calls the subclass' set_format function, though it might be during decoding, before calling VideoDecoder::finish_frame. This is done via VideoDecoder::set_output_state

The subclass is also responsible for providing (presentation) timestamps (likely based on corresponding input ones). If that is not applicable or possible, the base class provides limited framerate based interpolation.

Similarly, the base class provides some limited (legacy) seeking support if specifically requested by the subclass, as full-fledged support should rather be left to upstream demuxer, parser or alike. This simple approach caters for seeking and duration reporting using estimated input bitrates. To enable it, a subclass should call VideoDecoderExt::set_estimate_rate to enable handling of incoming byte-streams.

The base class provides some support for reverse playback, in particular in case incoming data is not packetized or upstream does not provide fragments on keyframe boundaries. However, the subclass should then be prepared for the parsing and frame processing stage to occur separately (in normal forward processing, the latter immediately follows the former), The subclass also needs to ensure the parsing stage properly marks keyframes, unless it knows the upstream elements will do so properly for incoming data.

The bare minimum that a functional subclass needs to implement is:

• Provide pad templates

• Inform the base class of output caps via VideoDecoder::set_output_state

• Parse input data, if it is not considered packetized from upstream Data will be provided to parse which should invoke VideoDecoderExt::add_to_frame and VideoDecoder::have_frame to separate the data belonging to each video frame.

• Accept data in handle_frame and provide decoded results to VideoDecoder::finish_frame, or call VideoDecoder::drop_frame.

Implements

VideoDecoderExt, gst::ElementExt, gst::ObjectExt, glib::object::ObjectExt

Trait Implementations

impl Clone for VideoDecoder[+]

[+] Show hidden undocumented items

fn clone(&self) -> VideoDecoder[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for VideoDecoder[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Eq for VideoDecoder

impl Hash for VideoDecoder[+]

[+] Show hidden undocumented items

fn hash<__H: Hasher>(&self, state: &mut __H)[−]

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, [−]

Feeds a slice of this type into the given [Hasher].

impl IsA<Element> for VideoDecoder

impl IsA<Object> for VideoDecoder

impl Ord for VideoDecoder[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &VideoDecoder) -> Ordering[−]

This method returns an [Ordering] between self and other.

[+] Expand attributes

#[must_use] fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use] fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use] fn clamp(self, min: Self, max: Self) -> Self[−]

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: ObjectType> PartialEq<T> for VideoDecoder[+]

[+] Show hidden undocumented items

fn eq(&self, other: &T) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

[+] Expand attributes

#[must_use] fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for VideoDecoder[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &T) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

[+] Expand attributes

#[must_use] fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

[+] Expand attributes

#[must_use] fn le(&self, other: &Rhs) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

[+] Expand attributes

#[must_use] fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

[+] Expand attributes

#[must_use] fn ge(&self, other: &Rhs) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Send for VideoDecoder

impl StaticType for VideoDecoder[+]

[+] Show hidden undocumented items

fn static_type() -> Type[−]

Returns the type identifier of Self.

impl Sync for VideoDecoder