FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
AVHWAccel Struct Reference

#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...
 
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_params )(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size)
 Callback for parameter data (SPS/PPS/VPS etc). 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...
 
void(* decode_mb )(struct MpegEncContext *s)
 Called for every Macroblock in a slice. 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 3530 of file avcodec.h.

Field Documentation

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 3536 of file avcodec.h.

Referenced by hwaccel_init().

enum AVMediaType AVHWAccel::type

Type of codec implemented by the hardware accelerator.

See AVMEDIA_TYPE_xxx

Definition at line 3543 of file avcodec.h.

enum AVCodecID AVHWAccel::id

Codec implemented by the hardware accelerator.

See AV_CODEC_ID_xxx

Definition at line 3550 of file avcodec.h.

enum AVPixelFormat AVHWAccel::pix_fmt

Supported pixel format.

Only hardware accelerated formats are supported here.

Definition at line 3557 of file avcodec.h.

Referenced by ff_decode_get_hw_frames_ctx(), and ff_dxva2_decode_init().

int AVHWAccel::capabilities

Hardware accelerated codec capabilities.

see AV_HWACCEL_CODEC_CAP_*

Definition at line 3563 of file avcodec.h.

Referenced by hwaccel_init().

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

Allocate a custom buffer.

Definition at line 3576 of file avcodec.h.

Referenced by get_buffer_internal().

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 3592 of file avcodec.h.

Referenced by decode_nal_unit(), decode_nal_units(), ff_h263_decode_frame(), mpeg_field_start(), vc1_decode_frame(), vp78_decode_frame(), and vp9_decode_frame().

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

Callback for parameter data (SPS/PPS/VPS etc).

Useful for hardware decoders which keep persistent state about the video parameters, and need to receive any changes to update that state.

Parameters
avctxthe codec context
typethe nal unit type
bufthe nal unit data buffer
buf_sizethe size of the nal unit in bytes
Returns
zero if successful, a negative value otherwise

Definition at line 3606 of file avcodec.h.

Referenced by decode_nal_unit(), and decode_nal_units().

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. The only exception is XvMC, that works on MB level.

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 3620 of file avcodec.h.

Referenced by decode_nal_unit(), decode_nal_units(), decode_slice(), er_supported(), ff_er_add_slice(), mpeg_decode_slice(), vc1_decode_frame(), vp78_decode_frame(), and vp9_decode_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 3631 of file avcodec.h.

Referenced by ff_h263_decode_frame(), ff_h264_field_end(), hevc_decode_frame(), mpeg_field_start(), slice_end(), vc1_decode_frame(), vp78_decode_frame(), and vp9_decode_frame().

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 3640 of file avcodec.h.

Referenced by alloc_frame(), alloc_frame_buffer(), alloc_picture(), vp8_alloc_frame(), and vp9_frame_alloc().

void(* AVHWAccel::decode_mb)(struct MpegEncContext *s)

Called for every Macroblock in a slice.

XvMC uses it to replace the ff_mpv_reconstruct_mb(). Instead of decoding to raw picture, MB parameters are stored in an array provided by the video driver.

Parameters
sthe mpeg context

Definition at line 3651 of file avcodec.h.

Referenced by ff_blockdsp_init_x86(), ff_er_frame_end(), is_intra_more_likely(), and mpv_reconstruct_mb_internal().

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 3660 of file avcodec.h.

Referenced by ff_vdpau_common_reinit(), and hwaccel_init().

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 3668 of file avcodec.h.

Referenced by avcodec_close(), ff_vdpau_common_reinit(), and hwaccel_uninit().

int AVHWAccel::priv_data_size

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

Definition at line 3674 of file avcodec.h.

Referenced by hwaccel_init().

int AVHWAccel::caps_internal

Internal hwaccel capabilities.

Definition at line 3679 of file avcodec.h.

Referenced by ff_thread_finish_setup().

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 3689 of file avcodec.h.

Referenced by avcodec_get_hw_frames_parameters().


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