FFmpeg
Data Structures | Enumerations | Functions
hwcontext.h File Reference
#include "buffer.h"
#include "frame.h"
#include "log.h"
#include "pixfmt.h"

Go to the source code of this file.

Data Structures

struct  AVHWDeviceContext
 This struct aggregates all the (hardware/vendor-specific) "high-level" state, i.e. More...
 
struct  AVHWFramesContext
 This struct describes a set or pool of "hardware" frames (i.e. More...
 
struct  AVHWFramesConstraints
 This struct describes the constraints on hardware frames attached to a given device with a hardware-specific configuration. More...
 

Enumerations

enum  AVHWDeviceType {
  AV_HWDEVICE_TYPE_NONE, AV_HWDEVICE_TYPE_VDPAU, AV_HWDEVICE_TYPE_CUDA, AV_HWDEVICE_TYPE_VAAPI,
  AV_HWDEVICE_TYPE_DXVA2, AV_HWDEVICE_TYPE_QSV, AV_HWDEVICE_TYPE_VIDEOTOOLBOX, AV_HWDEVICE_TYPE_D3D11VA,
  AV_HWDEVICE_TYPE_DRM, AV_HWDEVICE_TYPE_OPENCL, AV_HWDEVICE_TYPE_MEDIACODEC
}
 
enum  AVHWFrameTransferDirection { AV_HWFRAME_TRANSFER_DIRECTION_FROM, AV_HWFRAME_TRANSFER_DIRECTION_TO }
 
enum  { AV_HWFRAME_MAP_READ = 1 << 0, AV_HWFRAME_MAP_WRITE = 1 << 1, AV_HWFRAME_MAP_OVERWRITE = 1 << 2, AV_HWFRAME_MAP_DIRECT = 1 << 3 }
 Flags to apply to frame mappings. More...
 

Functions

enum AVHWDeviceType av_hwdevice_find_type_by_name (const char *name)
 Look up an AVHWDeviceType by name. More...
 
const char * av_hwdevice_get_type_name (enum AVHWDeviceType type)
 Get the string name of an AVHWDeviceType. More...
 
enum AVHWDeviceType av_hwdevice_iterate_types (enum AVHWDeviceType prev)
 Iterate over supported device types. More...
 
AVBufferRefav_hwdevice_ctx_alloc (enum AVHWDeviceType type)
 Allocate an AVHWDeviceContext for a given hardware type. More...
 
int av_hwdevice_ctx_init (AVBufferRef *ref)
 Finalize the device context before use. More...
 
int av_hwdevice_ctx_create (AVBufferRef **device_ctx, enum AVHWDeviceType type, const char *device, AVDictionary *opts, int flags)
 Open a device of the specified type and create an AVHWDeviceContext for it. More...
 
int av_hwdevice_ctx_create_derived (AVBufferRef **dst_ctx, enum AVHWDeviceType type, AVBufferRef *src_ctx, int flags)
 Create a new device of the specified type from an existing device. More...
 
AVBufferRefav_hwframe_ctx_alloc (AVBufferRef *device_ctx)
 Allocate an AVHWFramesContext tied to a given device context. More...
 
int av_hwframe_ctx_init (AVBufferRef *ref)
 Finalize the context before use. More...
 
int av_hwframe_get_buffer (AVBufferRef *hwframe_ctx, AVFrame *frame, int flags)
 Allocate a new frame attached to the given AVHWFramesContext. More...
 
int av_hwframe_transfer_data (AVFrame *dst, const AVFrame *src, int flags)
 Copy data to or from a hw surface. More...
 
int av_hwframe_transfer_get_formats (AVBufferRef *hwframe_ctx, enum AVHWFrameTransferDirection dir, enum AVPixelFormat **formats, int flags)
 Get a list of possible source or target formats usable in av_hwframe_transfer_data(). More...
 
voidav_hwdevice_hwconfig_alloc (AVBufferRef *device_ctx)
 Allocate a HW-specific configuration structure for a given HW device. More...
 
AVHWFramesConstraintsav_hwdevice_get_hwframe_constraints (AVBufferRef *ref, const void *hwconfig)
 Get the constraints on HW frames given a device and the HW-specific configuration to be used with that device. More...
 
void av_hwframe_constraints_free (AVHWFramesConstraints **constraints)
 Free an AVHWFrameConstraints structure. More...
 
int av_hwframe_map (AVFrame *dst, const AVFrame *src, int flags)
 Map a hardware frame. More...
 
int av_hwframe_ctx_create_derived (AVBufferRef **derived_frame_ctx, enum AVPixelFormat format, AVBufferRef *derived_device_ctx, AVBufferRef *source_frame_ctx, int flags)
 Create and initialise an AVHWFramesContext as a mapping of another existing AVHWFramesContext on a different device. More...
 

Enumeration Type Documentation

Enumerator
AV_HWDEVICE_TYPE_NONE 
AV_HWDEVICE_TYPE_VDPAU 
AV_HWDEVICE_TYPE_CUDA 
AV_HWDEVICE_TYPE_VAAPI 
AV_HWDEVICE_TYPE_DXVA2 
AV_HWDEVICE_TYPE_QSV 
AV_HWDEVICE_TYPE_VIDEOTOOLBOX 
AV_HWDEVICE_TYPE_D3D11VA 
AV_HWDEVICE_TYPE_DRM 
AV_HWDEVICE_TYPE_OPENCL 
AV_HWDEVICE_TYPE_MEDIACODEC 

Definition at line 27 of file hwcontext.h.

Enumerator
AV_HWFRAME_TRANSFER_DIRECTION_FROM 

Transfer the data from the queried hw frame.

AV_HWFRAME_TRANSFER_DIRECTION_TO 

Transfer the data to the queried hw frame.

Definition at line 394 of file hwcontext.h.

anonymous enum

Flags to apply to frame mappings.

Enumerator
AV_HWFRAME_MAP_READ 

The mapping must be readable.

AV_HWFRAME_MAP_WRITE 

The mapping must be writeable.

AV_HWFRAME_MAP_OVERWRITE 

The mapped frame will be overwritten completely in subsequent operations, so the current frame data need not be loaded.

Any values which are not overwritten are unspecified.

AV_HWFRAME_MAP_DIRECT 

The mapping must be direct.

That is, there must not be any copying in the map or unmap steps. Note that performance of direct mappings may be much lower than normal memory.

Definition at line 499 of file hwcontext.h.

Function Documentation

enum AVHWDeviceType av_hwdevice_find_type_by_name ( const char *  name)

Look up an AVHWDeviceType by name.

Parameters
nameString name of the device type (case-insensitive).
Returns
The type from enum AVHWDeviceType, or AV_HWDEVICE_TYPE_NONE if not found.

Definition at line 78 of file hwcontext.c.

Referenced by add_input_streams(), hw_device_init_from_string(), hwmap_config_output(), main(), and test_device_type().

const char* av_hwdevice_get_type_name ( enum AVHWDeviceType  type)

Get the string name of an AVHWDeviceType.

Parameters
typeType from enum AVHWDeviceType.
Returns
Pointer to a static string containing the name, or NULL if the type is not valid.

Definition at line 88 of file hwcontext.c.

Referenced by add_input_streams(), amf_init_context(), ff_decode_get_hw_frames_ctx(), get_format(), hw_device_default_name(), hw_device_setup_for_decode(), main(), opt_init_hw_device(), print_codec(), show_hwaccels(), test_derivation(), and test_device_type().

enum AVHWDeviceType av_hwdevice_iterate_types ( enum AVHWDeviceType  prev)

Iterate over supported device types.

Parameters
typeAV_HWDEVICE_TYPE_NONE initially, then the previous type returned by this function in subsequent iterations.
Returns
The next usable device type from enum AVHWDeviceType, or AV_HWDEVICE_TYPE_NONE if there are no more.

Definition at line 97 of file hwcontext.c.

Referenced by add_input_streams(), main(), opt_init_hw_device(), show_hwaccels(), and test_derivation().

AVBufferRef* av_hwdevice_ctx_alloc ( enum AVHWDeviceType  type)

Allocate an AVHWDeviceContext for a given hardware type.

Parameters
typethe type of the hardware device to allocate.
Returns
a reference to the newly created AVHWDeviceContext on success or NULL on failure.

Definition at line 138 of file hwcontext.c.

Referenced by av_hwdevice_ctx_create(), av_hwdevice_ctx_create_derived(), ff_vaapi_decode_init(), qsv_init_child_ctx(), and rkmpp_init_decoder().

int av_hwdevice_ctx_init ( AVBufferRef ref)

Finalize the device context before use.

This function must be called after the context is filled with all the required information and before it is used in any way.

Parameters
refa reference to the AVHWDeviceContext
Returns
0 on success, a negative AVERROR code on failure

Definition at line 196 of file hwcontext.c.

Referenced by av_hwdevice_ctx_create(), av_hwdevice_ctx_create_derived(), qsv_init_child_ctx(), and rkmpp_init_decoder().

int av_hwdevice_ctx_create ( AVBufferRef **  device_ctx,
enum AVHWDeviceType  type,
const char *  device,
AVDictionary opts,
int  flags 
)

Open a device of the specified type and create an AVHWDeviceContext for it.

This is a convenience function intended to cover the simple cases. Callers who need to fine-tune device creation/management should open the device manually and then wrap it in an AVHWDeviceContext using av_hwdevice_ctx_alloc()/av_hwdevice_ctx_init().

The returned context is already initialized and ready for use, the caller should not call av_hwdevice_ctx_init() on it. The user_opaque/free fields of the created AVHWDeviceContext are set by this function and should not be touched by the caller.

Parameters
device_ctxOn success, a reference to the newly-created device context will be written here. The reference is owned by the caller and must be released with av_buffer_unref() when no longer needed. On failure, NULL will be written to this pointer.
typeThe type of the device to create.
deviceA type-specific string identifying the device to open.
optsA dictionary of additional (type-specific) options to use in opening the device. The dictionary remains owned by the caller.
flagscurrently unused
Returns
0 on success, a negative AVERROR code on failure.

Definition at line 571 of file hwcontext.c.

Referenced by cudaupload_init(), cuvid_decode_init(), cuvid_init(), hw_decoder_init(), hw_device_init_from_string(), hw_device_init_from_type(), kmsgrab_read_header(), main(), qsv_device_create(), qsv_device_init(), qsv_load_plugins(), and test_device().

int av_hwdevice_ctx_create_derived ( AVBufferRef **  dst_ctx,
enum AVHWDeviceType  type,
AVBufferRef src_ctx,
int  flags 
)

Create a new device of the specified type from an existing device.

If the source device is a device of the target type or was originally derived from such a device (possibly through one or more intermediate devices of other types), then this will return a reference to the existing device of the same type as is requested.

Otherwise, it will attempt to derive a new device from the given source device. If direct derivation to the new type is not implemented, it will attempt the same derivation from each ancestor of the source device in turn looking for an implemented derivation method.

Parameters
dst_ctxOn success, a reference to the newly-created AVHWDeviceContext.
typeThe type of the new device to create.
src_ctxA reference to an existing AVHWDeviceContext which will be used to create the new device.
flagsCurrently unused; should be set to zero.
Returns
Zero on success, a negative AVERROR code on failure.

Definition at line 607 of file hwcontext.c.

Referenced by hw_device_init_from_string(), hwmap_config_output(), and test_derivation().

AVBufferRef* av_hwframe_ctx_alloc ( AVBufferRef device_ctx)

Allocate an AVHWFramesContext tied to a given device context.

Parameters
device_ctxa reference to a AVHWDeviceContext. This function will make a new reference for internal use, the one passed to the function remains owned by the caller.
Returns
a reference to the newly created AVHWFramesContext on success or NULL on failure.

Definition at line 243 of file hwcontext.c.

Referenced by av_hwframe_ctx_create_derived(), avcodec_get_hw_frames_parameters(), config_output(), cudaupload_config_output(), cuvid_decode_init(), cuvid_init(), ff_opencl_filter_config_output(), ff_vaapi_vpp_config_output(), ff_videotoolbox_uninit(), get_format(), hwmap_config_output(), hwupload_config_output(), init_out_pool(), init_stage(), init_vpp_session(), kmsgrab_read_header(), qsv_frame_alloc(), qsv_init(), qsv_init_child_ctx(), rkmpp_retrieve_frame(), set_hwframe_ctx(), and vaapi_encode_create_recon_frames().

int av_hwframe_ctx_init ( AVBufferRef ref)

Finalize the context before use.

This function must be called after the context is filled with all the required information and before it is attached to any frames.

Parameters
refa reference to the AVHWFramesContext
Returns
0 on success, a negative AVERROR code on failure

Definition at line 329 of file hwcontext.c.

Referenced by config_output(), cudaupload_config_output(), cuvid_init(), ff_decode_get_hw_frames_ctx(), ff_opencl_filter_config_output(), ff_vaapi_vpp_config_output(), ff_videotoolbox_uninit(), get_format(), hwmap_config_output(), hwupload_config_output(), init_out_pool(), init_stage(), init_vpp_session(), kmsgrab_read_header(), qsv_frame_alloc(), qsv_init(), qsv_init_child_ctx(), rkmpp_retrieve_frame(), set_hwframe_ctx(), and vaapi_encode_create_recon_frames().

int av_hwframe_get_buffer ( AVBufferRef hwframe_ctx,
AVFrame frame,
int  flags 
)

Allocate a new frame attached to the given AVHWFramesContext.

Parameters
hwframe_ctxa reference to an AVHWFramesContext
framean empty (freshly allocated or unreffed) frame to be filled with newly allocated buffers.
flagscurrently unused, should be set to zero
Returns
0 on success, a negative AVERROR code on failure

Definition at line 465 of file hwcontext.c.

Referenced by av_hwframe_get_buffer(), avcodec_default_get_buffer2(), cudascale_scale(), cuvid_output_frame(), ff_default_get_video_buffer(), hwframe_pool_prealloc(), init_stage(), main(), nppscale_scale(), npptranspose_filter(), qsv_get_buffer(), query_frame(), and vaapi_encode_issue().

int av_hwframe_transfer_data ( AVFrame dst,
const AVFrame src,
int  flags 
)

Copy data to or from a hw surface.

At least one of dst/src must have an AVHWFramesContext attached.

If src has an AVHWFramesContext attached, then the format of dst (if set) must use one of the formats returned by av_hwframe_transfer_get_formats(src, AV_HWFRAME_TRANSFER_DIRECTION_FROM). If dst has an AVHWFramesContext attached, then the format of src must use one of the formats returned by av_hwframe_transfer_get_formats(dst, AV_HWFRAME_TRANSFER_DIRECTION_TO)

dst may be "clean" (i.e. with data/buf pointers unset), in which case the data buffers will be allocated by this function using av_frame_get_buffer(). If dst->format is set, then this format will be used, otherwise (when dst->format is AV_PIX_FMT_NONE) the first acceptable format will be chosen.

The two frames must have matching allocated dimensions (i.e. equal to AVHWFramesContext.width/height), since not all device types support transferring a sub-rectangle of the whole surface. The display dimensions (i.e. AVFrame.width/height) may be smaller than the allocated dimensions, but also have to be equal for both frames. When the display dimensions are smaller than the allocated dimensions, the content of the padding in the destination frame is unspecified.

Parameters
dstthe destination frame. dst is not touched on failure.
srcthe source frame.
flagscurrently unused, should be set to zero
Returns
0 on success, a negative AVERROR error code on failure.

Definition at line 439 of file hwcontext.c.

Referenced by cudaupload_filter_frame(), cuvid_output_frame(), decode_packet(), decode_write(), hwaccel_retrieve_data(), hwdownload_filter_frame(), hwupload_filter_frame(), main(), qsv_transfer_data_child(), and transfer_data_alloc().

int av_hwframe_transfer_get_formats ( AVBufferRef hwframe_ctx,
enum AVHWFrameTransferDirection  dir,
enum AVPixelFormat **  formats,
int  flags 
)

Get a list of possible source or target formats usable in av_hwframe_transfer_data().

Parameters
hwframe_ctxthe frame context to obtain the information for
dirthe direction of the transfer
formatsthe pointer to the output format list will be written here. The list is terminated with AV_PIX_FMT_NONE and must be freed by the caller when no longer needed using av_free(). If this function returns successfully, the format list will have at least one item (not counting the terminator). On failure, the contents of this pointer are unspecified.
flagscurrently unused, should be set to zero
Returns
0 on success, a negative AVERROR code on failure.

Definition at line 381 of file hwcontext.c.

Referenced by hwdownload_config_output(), and transfer_data_alloc().

void* av_hwdevice_hwconfig_alloc ( AVBufferRef device_ctx)

Allocate a HW-specific configuration structure for a given HW device.

After use, the user must free all members as required by the specific hardware structure being used, then free the structure itself with av_free().

Parameters
device_ctxa reference to the associated AVHWDeviceContext.
Returns
The newly created HW-specific configuration structure on success or NULL on failure.

Definition at line 526 of file hwcontext.c.

Referenced by ff_vaapi_vpp_config_output(), vaapi_decode_make_config(), and vaapi_encode_create_recon_frames().

AVHWFramesConstraints* av_hwdevice_get_hwframe_constraints ( AVBufferRef ref,
const void hwconfig 
)

Get the constraints on HW frames given a device and the HW-specific configuration to be used with that device.

If no HW-specific configuration is provided, returns the maximum possible capabilities of the device.

Parameters
refa reference to the associated AVHWDeviceContext.
hwconfiga filled HW-specific configuration structure, or NULL to return the maximum possible capabilities of the device.
Returns
AVHWFramesConstraints structure describing the constraints on the device, or NULL if not available.

Definition at line 537 of file hwcontext.c.

Referenced by ff_vaapi_vpp_config_output(), hwupload_query_formats(), vaapi_decode_make_config(), and vaapi_encode_create_recon_frames().

void av_hwframe_constraints_free ( AVHWFramesConstraints **  constraints)

Free an AVHWFrameConstraints structure.

Parameters
constraintsThe (filled or unfilled) AVHWFrameConstraints structure.

Definition at line 562 of file hwcontext.c.

Referenced by av_hwdevice_get_hwframe_constraints(), ff_vaapi_vpp_config_output(), hwupload_query_formats(), vaapi_decode_make_config(), and vaapi_encode_create_recon_frames().

int av_hwframe_map ( AVFrame dst,
const AVFrame src,
int  flags 
)

Map a hardware frame.

This has a number of different possible effects, depending on the format and origin of the src and dst frames. On input, src should be a usable frame with valid buffers and dst should be blank (typically as just created by av_frame_alloc()). src should have an associated hwframe context, and dst may optionally have a format and associated hwframe context.

If src was created by mapping a frame from the hwframe context of dst, then this function undoes the mapping - dst is replaced by a reference to the frame that src was originally mapped from.

If both src and dst have an associated hwframe context, then this function attempts to map the src frame from its hardware context to that of dst and then fill dst with appropriate data to be usable there. This will only be possible if the hwframe contexts and associated devices are compatible - given compatible devices, av_hwframe_ctx_create_derived() can be used to create a hwframe context for dst in which mapping should be possible.

If src has a hwframe context but dst does not, then the src frame is mapped to normal memory and should thereafter be usable as a normal frame. If the format is set on dst, then the mapping will attempt to create dst with that format and fail if it is not possible. If format is unset (is AV_PIX_FMT_NONE) then dst will be mapped with whatever the most appropriate format to use is (probably the sw_format of the src hwframe context).

A return value of AVERROR(ENOSYS) indicates that the mapping is not possible with the given arguments and hwframe setup, while other return values indicate that it failed somehow.

Parameters
dstDestination frame, to contain the mapping.
srcSource frame, to be mapped.
flagsSome combination of AV_HWFRAME_MAP_* flags.
Returns
Zero on success, negative AVERROR code on failure.

Definition at line 740 of file hwcontext.c.

Referenced by av_hwframe_get_buffer(), hwmap_filter_frame(), hwmap_get_buffer(), opencl_map_frame(), qsv_frame_lock(), and qsv_map_from().

int av_hwframe_ctx_create_derived ( AVBufferRef **  derived_frame_ctx,
enum AVPixelFormat  format,
AVBufferRef derived_device_ctx,
AVBufferRef source_frame_ctx,
int  flags 
)

Create and initialise an AVHWFramesContext as a mapping of another existing AVHWFramesContext on a different device.

av_hwframe_ctx_init() should not be called after this.

Parameters
derived_frame_ctxOn success, a reference to the newly created AVHWFramesContext.
derived_device_ctxA reference to the device to create the new AVHWFramesContext on.
source_frame_ctxA reference to an existing AVHWFramesContext which will be mapped to the derived context.
flagsSome combination of AV_HWFRAME_MAP_* flags, defining the mapping parameters to apply to frames which are allocated in the derived device.
Returns
Zero on success, negative AVERROR code on failure.

Definition at line 798 of file hwcontext.c.

Referenced by hwmap_config_output().