#include <avcodec.h>

Data Fields

const char * name
 Name of the hardware accelerated codec. More...
 
enum AVMediaType type
 Type of codec implemented by the hardware accelerator. More...
 
enum AVCodecID id
 Codec implemented by the hardware accelerator. More...
 
enum AVPixelFormat pix_fmt
 Supported pixel format. More...
 
int capabilities
 Hardware accelerated codec capabilities. More...
 
struct AVHWAccelnext
 
int(* alloc_frame )(AVCodecContext *avctx, AVFrame *frame)
 Allocate a custom buffer. More...
 
int(* start_frame )(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size)
 Called at the beginning of each frame or field picture. More...
 
int(* decode_slice )(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size)
 Callback for each slice. More...
 
int(* end_frame )(AVCodecContext *avctx)
 Called at the end of each frame or field picture. More...
 
int frame_priv_data_size
 Size of per-frame hardware accelerator private data. More...
 
int(* init )(AVCodecContext *avctx)
 Initialize the hwaccel private data. More...
 
int(* uninit )(AVCodecContext *avctx)
 Uninitialize the hwaccel private data. More...
 
int priv_data_size
 Size of the private data to allocate in AVCodecInternal.hwaccel_priv_data. More...
 
int caps_internal
 Internal hwaccel capabilities. More...
 
int(* frame_params )(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx)
 Fill the given hw_frames context with current codec parameters. More...
 

Detailed Description

Definition at line 2999 of file avcodec.h.

Field Documentation

◆ name

const char* AVHWAccel::name

Name of the hardware accelerated codec.

The name is globally unique among encoders and among decoders (but an encoder and a decoder can share the same name).

Definition at line 3005 of file avcodec.h.

◆ type

enum AVMediaType AVHWAccel::type

Type of codec implemented by the hardware accelerator.

See AVMEDIA_TYPE_xxx

Definition at line 3012 of file avcodec.h.

◆ id

enum AVCodecID AVHWAccel::id

Codec implemented by the hardware accelerator.

See AV_CODEC_ID_xxx

Definition at line 3019 of file avcodec.h.

◆ pix_fmt

enum AVPixelFormat AVHWAccel::pix_fmt

Supported pixel format.

Only hardware accelerated formats are supported here.

Definition at line 3026 of file avcodec.h.

◆ capabilities

int AVHWAccel::capabilities

Hardware accelerated codec capabilities.

see FF_HWACCEL_CODEC_CAP_*

Definition at line 3032 of file avcodec.h.

◆ next

struct AVHWAccel* AVHWAccel::next

Definition at line 3041 of file avcodec.h.

◆ alloc_frame

int(* AVHWAccel::alloc_frame) (AVCodecContext *avctx, AVFrame *frame)

Allocate a custom buffer.

Definition at line 3046 of file avcodec.h.

◆ start_frame

int(* AVHWAccel::start_frame) (AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size)

Called at the beginning of each frame or field picture.

Meaningful frame information (codec specific) is guaranteed to be parsed at this point. This function is mandatory.

Note that buf can be NULL along with buf_size set to 0. Otherwise, this means the whole frame is available at this point.

Parameters
avctxthe codec context
bufthe frame data buffer base
buf_sizethe size of the frame in bytes
Returns
zero if successful, a negative value otherwise

Definition at line 3062 of file avcodec.h.

◆ decode_slice

int(* AVHWAccel::decode_slice) (AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size)

Callback for each slice.

Meaningful slice information (codec specific) is guaranteed to be parsed at this point. This function is mandatory.

Parameters
avctxthe codec context
bufthe slice data buffer base
buf_sizethe size of the slice in bytes
Returns
zero if successful, a negative value otherwise

Definition at line 3075 of file avcodec.h.

◆ end_frame

int(* AVHWAccel::end_frame) (AVCodecContext *avctx)

Called at the end of each frame or field picture.

The whole picture is parsed at this point and can now be sent to the hardware accelerator. This function is mandatory.

Parameters
avctxthe codec context
Returns
zero if successful, a negative value otherwise

Definition at line 3086 of file avcodec.h.

◆ frame_priv_data_size

int AVHWAccel::frame_priv_data_size

Size of per-frame hardware accelerator private data.

Private data is allocated with av_mallocz() before AVCodecContext.get_buffer() and deallocated after AVCodecContext.release_buffer().

Definition at line 3095 of file avcodec.h.

◆ init

int(* AVHWAccel::init) (AVCodecContext *avctx)

Initialize the hwaccel private data.

This will be called from ff_get_format(), after hwaccel and hwaccel_context are set and the hwaccel private data in AVCodecInternal is allocated.

Definition at line 3104 of file avcodec.h.

◆ uninit

int(* AVHWAccel::uninit) (AVCodecContext *avctx)

Uninitialize the hwaccel private data.

This will be called from get_format() or avcodec_close(), after hwaccel and hwaccel_context are already uninitialized.

Definition at line 3112 of file avcodec.h.

◆ priv_data_size

int AVHWAccel::priv_data_size

Size of the private data to allocate in AVCodecInternal.hwaccel_priv_data.

Definition at line 3118 of file avcodec.h.

◆ caps_internal

int AVHWAccel::caps_internal

Internal hwaccel capabilities.

Definition at line 3123 of file avcodec.h.

◆ frame_params

int(* AVHWAccel::frame_params) (AVCodecContext *avctx, AVBufferRef *hw_frames_ctx)

Fill the given hw_frames context with current codec parameters.

Called from get_format. Refer to avcodec_get_hw_frames_parameters() for details.

This CAN be called before AVHWAccel.init is called, and you must assume that avctx->hwaccel_priv_data is invalid.

Definition at line 3133 of file avcodec.h.


The documentation for this struct was generated from the following file: