This struct describes a set or pool of "hardware" frames (i.e. More...

#include <libavutil/hwcontext.h>

Data Fields
const AVClass *	av_class
	A class for logging. More...

AVHWFramesInternal *	internal
	Private data used internally by libavutil. More...

AVBufferRef *	device_ref
	A reference to the parent AVHWDeviceContext. More...

AVHWDeviceContext *	device_ctx
	The parent AVHWDeviceContext. More...

void *	hwctx
	The format-specific data, allocated and freed automatically along with this context. More...

void(*	free )(struct AVHWFramesContext *ctx)
	This field may be set by the caller before calling av_hwframe_ctx_init(). More...

void *	user_opaque
	Arbitrary user data, to be used e.g. More...

AVBufferPool *	pool
	A pool from which the frames are allocated by av_hwframe_get_buffer(). More...

int	initial_pool_size
	Initial size of the frame pool. More...

enum AVPixelFormat	format
	The pixel format identifying the underlying HW surface type. More...

enum AVPixelFormat	sw_format
	The pixel format identifying the actual data layout of the hardware frames. More...

int	width
	The allocated dimensions of the frames in this pool. More...

int	height

Detailed Description

This struct describes a set or pool of "hardware" frames (i.e.

those with data not located in normal system memory). All the frames in the pool are assumed to be allocated in the same way and interchangeable.

This struct is reference-counted with the AVBuffer mechanism and tied to a given AVHWDeviceContext instance. The av_hwframe_ctx_alloc() constructor yields a reference, whose data field points to the actual AVHWFramesContext struct.

Examples:: qsvdec.c, and vaapi_encode.c.

Definition at line 123 of file hwcontext.h.

Field Documentation

◆ av_class

const AVClass* AVHWFramesContext::av_class

A class for logging.

Definition at line 127 of file hwcontext.h.

◆ internal

AVHWFramesInternal* AVHWFramesContext::internal

Private data used internally by libavutil.

Must not be accessed in any way by the caller.

Definition at line 133 of file hwcontext.h.

Referenced by av_hwframe_ctx_create_derived(), av_hwframe_ctx_init(), av_hwframe_get_buffer(), av_hwframe_map(), av_hwframe_transfer_data(), av_hwframe_transfer_get_formats(), cuda_frames_init(), cuda_transfer_data_from(), cuda_transfer_data_to(), d3d11va_alloc_single(), d3d11va_create_staging_texture(), d3d11va_frames_init(), d3d11va_frames_uninit(), d3d11va_pool_alloc(), d3d11va_transfer_data(), d3d11va_transfer_get_formats(), dxva2_frames_init(), dxva2_frames_uninit(), dxva2_init_pool(), dxva2_pool_alloc(), frame_alloc(), hwframe_ctx_free(), opencl_frames_init(), opencl_frames_init_command_queue(), opencl_frames_uninit(), opencl_map_frame(), opencl_mem_flags_for_mapping(), opencl_transfer_data_from(), opencl_transfer_data_to(), opencl_unmap_frame(), qsv_frames_derive_to(), qsv_frames_init(), qsv_frames_uninit(), qsv_init_child_ctx(), qsv_init_internal_session(), qsv_init_pool(), qsv_map_from(), qsv_pool_alloc(), qsv_transfer_data_child(), qsv_transfer_data_from(), qsv_transfer_data_to(), vaapi_frames_init(), vaapi_frames_uninit(), vaapi_map_frame(), vaapi_pool_alloc(), vdpau_frames_init(), vdpau_pool_alloc(), vdpau_transfer_data_from(), vdpau_transfer_data_to(), and vdpau_transfer_get_formats().

◆ device_ref

AVBufferRef* AVHWFramesContext::device_ref

A reference to the parent AVHWDeviceContext.

This reference is owned and managed by the enclosing AVHWFramesContext, but the caller may derive additional references from it.

Definition at line 140 of file hwcontext.h.

Referenced by cuvid_decode_init(), ff_nvdec_decode_init(), ff_opencl_filter_config_input(), ff_qsv_init_session_frames(), ff_vaapi_common_frame_params(), ff_vaapi_decode_init(), ff_vaapi_encode_init(), ff_vaapi_vpp_config_output(), ff_videotoolbox_uninit(), hwframe_ctx_free(), hwmap_config_output(), init_out_pool(), init_processing_chain(), init_vpp_session(), and qsv_frame_alloc().

◆ device_ctx

AVHWDeviceContext* AVHWFramesContext::device_ctx

The parent AVHWDeviceContext.

This is simply a pointer to device_ref->data provided for convenience.

Set by libavutil in av_hwframe_ctx_init().

Definition at line 148 of file hwcontext.h.

Referenced by amf_init_context(), av_hwframe_ctx_create_derived(), bufref_wrap_interface(), config_output(), config_props(), cuda_buffer_free(), cuda_pool_alloc(), cuda_transfer_data_from(), cuda_transfer_data_to(), cudascale_config_props(), cudascale_filter_frame(), cuvid_decode_init(), d3d11va_alloc_single(), d3d11va_create_staging_texture(), d3d11va_frames_init(), d3d11va_transfer_data(), dxva2_frames_uninit(), dxva2_init_pool(), ff_dxva2_common_frame_params(), ff_dxva2_decode_init(), ff_vaapi_common_frame_params(), ff_vaapi_decode_init(), ff_vdpau_common_init(), filter_frame(), init_out_session(), nppscale_filter_frame(), nvenc_setup_device(), opencl_frames_derive_to(), opencl_frames_init_command_queue(), opencl_map_frame(), opencl_map_to(), opencl_mem_flags_for_mapping(), opencl_pool_alloc(), qsv_frames_derive_from(), qsv_frames_derive_to(), qsv_init_child_ctx(), qsv_init_internal_session(), vaapi_buffer_free(), vaapi_frames_init(), vaapi_map_frame(), vaapi_map_to_memory(), vaapi_pool_alloc(), vaapi_transfer_get_formats(), vaapi_unmap_frame(), vdpau_buffer_free(), vdpau_frames_init(), and vdpau_pool_alloc().

◆ hwctx

void* AVHWFramesContext::hwctx

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

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

After any frames using this context are created, the contents of this struct should not be modified by the caller.

Examples:: qsvdec.c.

Definition at line 161 of file hwcontext.h.

Referenced by bufref_wrap_interface(), d3d11va_alloc_single(), d3d11va_frames_init(), d3d11va_frames_uninit(), d3d11va_pool_alloc(), dxva2_frames_init(), dxva2_frames_uninit(), dxva2_init_pool(), dxva2_pool_alloc(), ff_dxva2_common_frame_params(), ff_dxva2_decode_init(), ff_qsv_enc_init(), ff_qsv_init_session_frames(), ff_vaapi_decode_init(), ff_vaapi_encode_init(), ff_vaapi_vpp_config_output(), fill_frameinfo_by_link(), frame_alloc(), get_format(), hwframe_ctx_free(), init_out_pool(), init_out_session(), init_video_param(), init_video_param_jpeg(), init_vpp_session(), opencl_frames_init_command_queue(), opencl_mem_flags_for_mapping(), qsv_create_mids(), qsv_decode_init(), qsv_frame_alloc(), qsv_frame_lock(), qsv_frames_derive_from(), qsv_frames_derive_to(), qsv_frames_init(), qsv_init(), qsv_init_child_ctx(), qsv_init_internal_session(), qsv_init_pool(), qsv_map_to(), qsv_pool_alloc(), qsv_setup_mids(), vaapi_decode_find_best_format(), vaapi_frames_init(), vaapi_frames_uninit(), and vaapi_pool_alloc().

◆ free

void(* AVHWFramesContext::free) (struct AVHWFramesContext *ctx)

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

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

Definition at line 169 of file hwcontext.h.

Referenced by hwframe_ctx_free().

◆ user_opaque

void* AVHWFramesContext::user_opaque

Arbitrary user data, to be used e.g.

by the free() callback.

Definition at line 174 of file hwcontext.h.

◆ pool

AVBufferPool* AVHWFramesContext::pool

A pool from which the frames are allocated by av_hwframe_get_buffer().

This field may be set by the caller before calling av_hwframe_ctx_init(). The buffers returned by calling av_buffer_pool_get() on this pool must have the properties described in the documentation in the corresponding hw type's header (hwcontext_*.h). The pool will be freed strictly before this struct's free() callback is invoked.

This field may be NULL, then libavutil will attempt to allocate a pool internally. Note that certain device types enforce pools allocated at fixed size (frame count), which cannot be extended dynamically. In such a case, initial_pool_size must be set appropriately.

Definition at line 189 of file hwcontext.h.

Referenced by av_hwframe_ctx_init(), av_hwframe_get_buffer(), cuda_frames_init(), cuda_get_buffer(), d3d11va_get_buffer(), drm_get_buffer(), dxva2_frames_init(), dxva2_get_buffer(), opencl_frames_init(), opencl_get_buffer(), qsv_frames_init(), qsv_get_buffer(), vaapi_frames_init(), vaapi_get_buffer(), vdpau_frames_init(), vdpau_get_buffer(), and vt_get_buffer().

◆ initial_pool_size

int AVHWFramesContext::initial_pool_size

Initial size of the frame pool.

If a device type does not support dynamically resizing the pool, then this is also the maximum pool size.

May be set by the caller before calling av_hwframe_ctx_init(). Must be set if pool is NULL and the device type does not support dynamic pools.

Examples:: qsvdec.c, and vaapi_encode.c.

Definition at line 198 of file hwcontext.h.

Referenced by amf_init_context(), av_hwframe_ctx_init(), avcodec_get_hw_frames_parameters(), d3d11va_frames_init(), dxva2_init_pool(), ff_decode_get_hw_frames_ctx(), ff_dxva2_common_frame_params(), ff_filter_init_hw_frames(), ff_nvdec_decode_init(), ff_nvdec_frame_params(), ff_vaapi_vpp_config_output(), get_format(), hwframe_pool_prealloc(), hwmap_config_output(), hwupload_config_output(), init_out_pool(), init_vpp_session(), opencl_mem_flags_for_mapping(), qsv_init(), qsv_init_child_ctx(), qsv_init_pool(), set_hwframe_ctx(), vaapi_decode_make_config(), vaapi_encode_create_recon_frames(), vaapi_frames_init(), and vaapi_pool_alloc().

◆ format

enum AVPixelFormat AVHWFramesContext::format

The pixel format identifying the underlying HW surface type.

Must be a hwaccel format, i.e. the corresponding descriptor must have the AV_PIX_FMT_FLAG_HWACCEL flag set.

Must be set by the user before calling av_hwframe_ctx_init().

Examples:: qsvdec.c, and vaapi_encode.c.

Definition at line 208 of file hwcontext.h.

Referenced by av_hwframe_ctx_create_derived(), av_hwframe_ctx_init(), av_hwframe_get_buffer(), av_hwframe_map(), avcodec_open2(), cudaupload_config_output(), cuvid_init(), ff_dxva2_common_frame_params(), ff_dxva2_decode_init(), ff_get_format(), ff_nvdec_frame_params(), ff_nvenc_encode_init(), ff_opencl_filter_config_input(), ff_opencl_filter_config_output(), ff_vaapi_vpp_config_output(), ff_vdpau_common_frame_params(), ff_videotoolbox_uninit(), get_format(), hwmap_config_output(), hwupload_config_output(), init_out_pool(), init_stage(), init_vpp_session(), kmsgrab_read_header(), nvenc_setup_device(), qsv_init(), qsv_init_child_ctx(), qsv_transfer_data_child(), rkmpp_retrieve_frame(), set_hwframe_ctx(), vaapi_decode_make_config(), and vaapi_encode_create_recon_frames().

◆ sw_format

enum AVPixelFormat AVHWFramesContext::sw_format

The pixel format identifying the actual data layout of the hardware frames.

Must be set by the caller before calling av_hwframe_ctx_init().

Note: when the underlying API does not provide the exact data layout, but only the colorspace/bit depth, this field should be set to the fully planar version of that format (e.g. for 8-bit 420 YUV it should be AV_PIX_FMT_YUV420P, not AV_PIX_FMT_NV12 or anything else).