Trait gstreamer_video::subclass::prelude::VideoDecoderImpl

pub trait VideoDecoderImpl: VideoDecoderImplExt + ElementImpl {
    // Provided methods
    fn open(&self) -> Result<(), ErrorMessage> { ... }
    fn close(&self) -> Result<(), ErrorMessage> { ... }
    fn start(&self) -> Result<(), ErrorMessage> { ... }
    fn stop(&self) -> Result<(), ErrorMessage> { ... }
    fn finish(&self) -> Result<FlowSuccess, FlowError> { ... }
    fn drain(&self) -> Result<FlowSuccess, FlowError> { ... }
    fn set_format(
        &self,
        state: &VideoCodecState<'static, Readable>,
    ) -> Result<(), LoggableError> { ... }
    fn parse(
        &self,
        frame: &VideoCodecFrame<'_>,
        adapter: &Adapter,
        at_eos: bool,
    ) -> Result<FlowSuccess, FlowError> { ... }
    fn handle_frame(
        &self,
        frame: VideoCodecFrame<'_>,
    ) -> Result<FlowSuccess, FlowError> { ... }
    fn flush(&self) -> bool { ... }
    fn negotiate(&self) -> Result<(), LoggableError> { ... }
    fn caps(&self, filter: Option<&Caps>) -> Caps { ... }
    fn sink_event(&self, event: Event) -> bool { ... }
    fn sink_query(&self, query: &mut QueryRef) -> bool { ... }
    fn src_event(&self, event: Event) -> bool { ... }
    fn src_query(&self, query: &mut QueryRef) -> bool { ... }
    fn propose_allocation(
        &self,
        query: &mut Allocation,
    ) -> Result<(), LoggableError> { ... }
    fn decide_allocation(
        &self,
        query: &mut Allocation,
    ) -> Result<(), LoggableError> { ... }
    fn handle_missing_data(
        &self,
        timestamp: ClockTime,
        duration: Option<ClockTime>,
    ) -> bool { ... }
}

Provided Methods

fn open(&self) -> Result<(), ErrorMessage>

Optional. Called when the element changes to GST_STATE_READY. Allows opening external resources.

fn close(&self) -> Result<(), ErrorMessage>

Optional. Called when the element changes to GST_STATE_NULL. Allows closing external resources.

fn start(&self) -> Result<(), ErrorMessage>

Optional. Called when the element starts processing. Allows opening external resources.

fn stop(&self) -> Result<(), ErrorMessage>

Optional. Called when the element stops processing. Allows closing external resources.

fn finish(&self) -> Result<FlowSuccess, FlowError>

Optional. Called to request subclass to dispatch any pending remaining data at EOS. Sub-classes can refuse to decode new data after.

fn drain(&self) -> Result<FlowSuccess, FlowError>

Optional. Called to request subclass to decode any data it can at this point, but that more data may arrive after. (e.g. at segment end). Sub-classes should be prepared to handle new data afterward, or seamless segment processing will break. Since: 1.6

fn set_format( &self, state: &VideoCodecState<'static, Readable>, ) -> Result<(), LoggableError>

Notifies subclass of incoming data format (caps).

fn parse( &self, frame: &VideoCodecFrame<'_>, adapter: &Adapter, at_eos: bool, ) -> Result<FlowSuccess, FlowError>

Required for non-packetized input. Allows chopping incoming data into manageable units (frames) for subsequent decoding.

fn handle_frame( &self, frame: VideoCodecFrame<'_>, ) -> Result<FlowSuccess, FlowError>

frame

The frame to handle

fn flush(&self) -> bool

Optional. Flush all remaining data from the decoder without pushing it downstream. Since: 1.2

fn negotiate(&self) -> Result<(), LoggableError>

Negotiate with downstream elements to currently configured VideoCodecState. Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if negotiate fails.

Returns

true if the negotiation succeeded, else false.

fn caps(&self, filter: Option<&Caps>) -> Caps

fn sink_event(&self, event: Event) -> bool

Optional. Event handler on the sink pad. This function should return TRUE if the event was handled and should be discarded (i.e. not unref’ed). Subclasses should chain up to the parent implementation to invoke the default handler.

fn sink_query(&self, query: &mut QueryRef) -> bool

Optional. Query handler on the sink pad. This function should return TRUE if the query could be performed. Subclasses should chain up to the parent implementation to invoke the default handler. Since: 1.4

fn src_event(&self, event: Event) -> bool

Optional. Event handler on the source pad. This function should return TRUE if the event was handled and should be discarded (i.e. not unref’ed). Subclasses should chain up to the parent implementation to invoke the default handler.

fn src_query(&self, query: &mut QueryRef) -> bool

Optional. Query handler on the source pad. This function should return TRUE if the query could be performed. Subclasses should chain up to the parent implementation to invoke the default handler. Since: 1.4

fn propose_allocation( &self, query: &mut Allocation, ) -> Result<(), LoggableError>

Optional. Propose buffer allocation parameters for upstream elements. Subclasses should chain up to the parent implementation to invoke the default handler.

fn decide_allocation(&self, query: &mut Allocation) -> Result<(), LoggableError>

Optional. Setup the allocation parameters for allocating output buffers. The passed in query contains the result of the downstream allocation query. Subclasses should chain up to the parent implementation to invoke the default handler.

fn handle_missing_data( &self, timestamp: ClockTime, duration: Option<ClockTime>, ) -> bool

timestamp

Timestamp of the missing data

duration

Duration of the missing data

Returns

true if the decoder should be drained afterwards.

Object Safety

This trait is not object safe.

Implementors