FFmpeg
Data Fields
AVHWFramesContext Struct Reference

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

#include <hwcontext.h>

Data Fields

const AVClassav_class
 A class for logging. More...
 
AVHWFramesInternalinternal
 Private data used internally by libavutil. More...
 
AVBufferRefdevice_ref
 A reference to the parent AVHWDeviceContext. More...
 
AVHWDeviceContextdevice_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...
 
AVBufferPoolpool
 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
vaapi_encode.c.

Definition at line 124 of file hwcontext.h.

Field Documentation

◆ av_class

const AVClass* AVHWFramesContext::av_class

A class for logging.

Definition at line 128 of file hwcontext.h.

◆ internal

AVHWFramesInternal* AVHWFramesContext::internal

◆ device_ref

AVBufferRef* AVHWFramesContext::device_ref

◆ device_ctx

AVHWDeviceContext* AVHWFramesContext::device_ctx

◆ 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.

Definition at line 162 of file hwcontext.h.

Referenced by ff_dxva2_common_frame_params(), ff_dxva2_decode_init(), ff_qsv_enc_init(), ff_qsv_init_session_frames(), ff_vaapi_vpp_config_output(), fill_frameinfo_by_link(), init_out_pool(), init_out_session(), init_video_param(), init_video_param_jpeg(), init_vpp_session(), opencl_frames_init_command_queue(), qsv_create_mids(), qsv_decode_preinit(), qsv_frame_alloc(), qsv_frame_lock(), qsv_frames_derive_from(), qsv_frames_derive_to(), qsv_init_child_ctx(), qsv_map_to(), qsv_setup_mids(), try_export_flags(), vaapi_frames_init(), vaapi_frames_uninit(), vaapi_pool_alloc(), vulkan_frames_init(), and vulkan_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 170 of file hwcontext.h.

Referenced by nvdec_init_hwframes().

◆ user_opaque

void* AVHWFramesContext::user_opaque

Arbitrary user data, to be used e.g.

by the free() callback.

Definition at line 175 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 190 of file hwcontext.h.

Referenced by drm_get_buffer(), nvdec_init_hwframes(), opencl_frames_init(), opencl_get_buffer(), vaapi_frames_init(), vaapi_get_buffer(), vulkan_frames_init(), and vulkan_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
vaapi_encode.c.

Definition at line 199 of file hwcontext.h.

Referenced by amf_init_context(), avcodec_get_hw_frames_parameters(), config_output(), ff_decode_get_hw_frames_ctx(), ff_dxva2_common_frame_params(), ff_nvdec_decode_init(), ff_nvdec_frame_params(), ff_vaapi_vpp_config_output(), hwmap_config_output(), init_out_pool(), init_vpp_session(), nvdec_init_hwframes(), qsv_decode_preinit(), qsv_frames_derive_to(), qsv_init_child_ctx(), set_hwframe_ctx(), vaapi_frames_init(), and vaapi_pool_alloc().

◆ format

enum AVPixelFormat AVHWFramesContext::format

◆ 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).
Examples
vaapi_encode.c.

Definition at line 222 of file hwcontext.h.

Referenced by alloc_bind_mem(), amf_init_context(), av_hwframe_ctx_create_derived(), av_hwframe_map(), config_output(), config_props(), create_frame(), cudaupload_config_output(), drm_map_from(), ff_dxva2_common_frame_params(), ff_encode_preinit(), 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_vk_filter_config_input(), ff_vk_filter_config_output(), filter_frame(), have_alpha_planar(), hwmap_config_output(), hwupload_config_output(), init_hwframe_ctx(), init_out_pool(), init_processing_chain(), init_stage(), init_vpp_session(), nlmeans_opencl_filter_frame(), nppscale_deinterleave(), nppscale_interleave(), nppsharpen_config(), nppsharpen_sharpen(), nvenc_register_frame(), opencl_map_frame(), opencl_map_from(), opencl_pool_alloc(), opencl_transfer_data_from(), opencl_transfer_data_to(), opencl_transfer_get_formats(), overlay_cuda_config_output(), overlay_opencl_blend(), overlay_vulkan_blend(), pad_opencl_init(), prepare_frame(), process_frames(), qsv_decode_preinit(), qsv_frame_lock(), qsv_init_child_ctx(), rkmpp_retrieve_frame(), set_hwframe_ctx(), thumbnail(), tonemap_opencl_filter_frame(), try_export_flags(), vaapi_encode_h265_init_sequence_params(), vaapi_encode_mjpeg_init_picture_params(), vaapi_frames_init(), vaapi_map_frame(), vaapi_transfer_get_formats(), vaapi_vpp_frame_is_rgb(), vulkan_frame_free(), vulkan_free_internal(), vulkan_map_frame_to_mem(), vulkan_pool_alloc(), vulkan_transfer_get_formats(), vulkan_unmap_frame(), and xfade_frame().

◆ width

int AVHWFramesContext::width

◆ height

int AVHWFramesContext::height

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