Struct gstreamer_video::VideoEncoder

pub struct VideoEncoder { /* private fields */ }

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

GstVideoEncoder and subclass should cooperate as follows.

Configuration

• Initially, GstVideoEncoder calls start when the encoder element is activated, which allows subclass to perform any global setup.
• GstVideoEncoder calls set_format to inform subclass of the format of input video data that it is about to receive. Subclass should setup for encoding and configure base class as appropriate (e.g. latency). While unlikely, it might be called more than once, if changing input parameters require reconfiguration. Baseclass will ensure that processing of current configuration is finished.
• GstVideoEncoder calls stop at end of all processing.

Data processing

• Base class collects input data and metadata into a frame and hands this to subclass’ handle_frame.

• If codec processing results in encoded data, subclass should call VideoEncoderExt::finish_frame() to have encoded data pushed downstream.

• If implemented, baseclass calls subclass pre_push just prior to pushing to allow subclasses to modify some metadata on the buffer. If it returns GST_FLOW_OK, the buffer is pushed downstream.

• GstVideoEncoderClass will handle both srcpad and sinkpad events. Sink events will be passed to subclass if event callback has been provided.

Shutdown phase

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

Subclass is responsible for providing pad template caps for source and sink pads. The pads need to be named “sink” and “src”. It should also be able to provide fixed src pad caps in getcaps by the time it calls VideoEncoderExt::finish_frame().

Things that subclass need to take care of:

• Provide pad templates
• Provide source pad caps before pushing the first buffer
• Accept data in handle_frame and provide encoded results to VideoEncoderExt::finish_frame().

The qos property will enable the Quality-of-Service features of the encoder which gather statistics about the real-time performance of the downstream elements. If enabled, subclasses can use VideoEncoderExt::max_encode_time() to check if input frames are already late and drop them right away to give a chance to the pipeline to catch up.

This is an Abstract Base Class, you cannot instantiate it.

Properties

min-force-key-unit-interval

Minimum interval between force-keyunit requests in nanoseconds. See VideoEncoderExt::set_min_force_key_unit_interval() for more details.

Readable | Writeable

qos

Readable | Writeable

Object

name

Readable | Writeable | Construct

parent

The parent of the object. Please note, that when changing the ‘parent’ property, we don’t emit notify and deep-notify signals due to locking issues. In some cases one can use GstBin::element-added or GstBin::element-removed signals on the parent to achieve a similar effect.

Readable | Writeable

Implements

VideoEncoderExt, gst::prelude::ElementExt, gst::prelude::ObjectExt, [trait@glib::ObjectExt], VideoEncoderExtManual

GLib type: GObject with reference counted clone semantics.

Implementations

impl VideoEncoder

pub const NONE: Option<&'static VideoEncoder> = None

Trait Implementations

impl Clone for VideoEncoder

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for VideoEncoder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for VideoEncoder

type ParamSpec = ParamSpecObject

type SetValue = VideoEncoder

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, VideoEncoder>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for VideoEncoder

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: VideoEncoderImpl> IsSubclassable<T> for VideoEncoder

fn class_init(klass: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for VideoEncoder

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for VideoEncoder

type Parent = Element

impl<OT: ObjectType> PartialEq<OT> for VideoEncoder

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for VideoEncoder

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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 StaticType for VideoEncoder

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for VideoEncoder

impl IsA<Element> for VideoEncoder

impl IsA<Object> for VideoEncoder

impl Send for VideoEncoder

impl Sync for VideoEncoder