Struct ffmpeg_dev::sys::AVHWDeviceContext

#[repr(C)]
pub struct AVHWDeviceContext {
    pub av_class: *const AVClass,
    pub internal: *mut AVHWDeviceInternal,
    pub type_: AVHWDeviceType,
    pub hwctx: *mut c_void,
    pub free: Option<unsafe extern "C" fn(ctx: *mut AVHWDeviceContext)>,
    pub user_opaque: *mut c_void,
}

This struct aggregates all the (hardware/vendor-specific) "high-level" state, i.e. state that is not tied to a concrete processing configuration. E.g., in an API that supports hardware-accelerated encoding and decoding, this struct will (if possible) wrap the state that is common to both encoding and decoding and from which specific instances of encoders or decoders can be derived.

This struct is reference-counted with the AVBuffer mechanism. The av_hwdevice_ctx_alloc() constructor yields a reference, whose data field points to the actual AVHWDeviceContext. Further objects derived from AVHWDeviceContext (such as AVHWFramesContext, describing a frame pool with specific properties) will hold an internal reference to it. After all the references are released, the AVHWDeviceContext itself will be freed, optionally invoking a user-specified callback for uninitializing the hardware state.

Fields

av_class: *const AVClass

A class for logging. Set by av_hwdevice_ctx_alloc().

internal: *mut AVHWDeviceInternal

Private data used internally by libavutil. Must not be accessed in any way by the caller.

type_: AVHWDeviceType

This field identifies the underlying API used for hardware access.

This field is set when this struct is allocated and never changed afterwards.

hwctx: *mut c_void

The format-specific data, allocated and freed by libavutil along with this context.

Should be cast by the user to the format-specific context defined in the corresponding header (hwcontext_*.h) and filled as described in the documentation before calling av_hwdevice_ctx_init().

After calling av_hwdevice_ctx_init() this struct should not be modified by the caller.

free: Option<unsafe extern "C" fn(ctx: *mut AVHWDeviceContext)>

This field may be set by the caller before calling av_hwdevice_ctx_init().

If non-NULL, this callback will be called when the last reference to this context is unreferenced, immediately before it is freed.

@note when other objects (e.g an AVHWFramesContext) are derived from this struct, this callback will be invoked after all such child objects are fully uninitialized and their respective destructors invoked.

user_opaque: *mut c_void

Arbitrary user data, to be used e.g. by the free() callback.

Trait Implementations

impl Clone for AVHWDeviceContext

fn clone(&self) -> AVHWDeviceContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for AVHWDeviceContext

impl Debug for AVHWDeviceContext

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

Formats the value using the given formatter.