FFmpeg
hwcontext_internal.h
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 #ifndef AVUTIL_HWCONTEXT_INTERNAL_H
20 #define AVUTIL_HWCONTEXT_INTERNAL_H
21 
22 #include <stddef.h>
23 
24 #include "buffer.h"
25 #include "hwcontext.h"
26 #include "frame.h"
27 #include "pixfmt.h"
28 
29 typedef struct HWContextType {
31  const char *name;
32 
33  /**
34  * An array of pixel formats supported by the AVHWFramesContext instances
35  * Terminated by AV_PIX_FMT_NONE.
36  */
37  const enum AVPixelFormat *pix_fmts;
38 
39  /**
40  * size of the public hardware-specific context,
41  * i.e. AVHWDeviceContext.hwctx
42  */
44  /**
45  * size of the private data, i.e.
46  * AVHWDeviceInternal.priv
47  */
49 
50  /**
51  * Size of the hardware-specific device configuration.
52  * (Used to query hwframe constraints.)
53  */
55 
56  /**
57  * size of the public frame pool hardware-specific context,
58  * i.e. AVHWFramesContext.hwctx
59  */
61  /**
62  * size of the private data, i.e.
63  * AVHWFramesInternal.priv
64  */
66 
67  int (*device_create)(AVHWDeviceContext *ctx, const char *device,
68  AVDictionary *opts, int flags);
70  AVHWDeviceContext *src_ctx,
71  AVDictionary *opts, int flags);
72 
75 
77  const void *hwconfig,
78  AVHWFramesConstraints *constraints);
79 
82 
86  enum AVPixelFormat **formats);
88  const AVFrame *src);
90  const AVFrame *src);
91 
93  const AVFrame *src, int flags);
95  const AVFrame *src, int flags);
96 
98  AVHWFramesContext *src_ctx, int flags);
100  AVHWFramesContext *src_ctx, int flags);
101 } HWContextType;
102 
105  void *priv;
106 
107  /**
108  * For a derived device, a reference to the original device
109  * context it was derived from.
110  */
112 };
113 
116  void *priv;
117 
119 
120  /**
121  * For a derived context, a reference to the original frames
122  * context it was derived from.
123  */
125  /**
126  * Flags to apply to the mapping from the source to the derived
127  * frame context when trying to allocate in the derived context.
128  */
130 };
131 
132 typedef struct HWMapDescriptor {
133  /**
134  * A reference to the original source of the mapping.
135  */
137  /**
138  * A reference to the hardware frames context in which this
139  * mapping was made. May be the same as source->hw_frames_ctx,
140  * but need not be.
141  */
143  /**
144  * Unmap function.
145  */
147  struct HWMapDescriptor *hwmap);
148  /**
149  * Hardware-specific private data associated with the mapping.
150  */
151  void *priv;
153 
154 int ff_hwframe_map_create(AVBufferRef *hwframe_ref,
155  AVFrame *dst, const AVFrame *src,
156  void (*unmap)(AVHWFramesContext *ctx,
157  HWMapDescriptor *hwmap),
158  void *priv);
159 
160 /**
161  * Replace the current hwmap of dst with the one from src, used for indirect
162  * mappings like VAAPI->(DRM)->OpenCL/Vulkan where a direct interop is missing
163  */
164 int ff_hwframe_map_replace(AVFrame *dst, const AVFrame *src);
165 
178 
179 #endif /* AVUTIL_HWCONTEXT_INTERNAL_H */
formats
formats
Definition: signature.h:48
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:71
AVHWDeviceInternal::source_device
AVBufferRef * source_device
For a derived device, a reference to the original device context it was derived from.
Definition: hwcontext_internal.h:111
HWContextType::device_uninit
void(* device_uninit)(AVHWDeviceContext *ctx)
Definition: hwcontext_internal.h:74
HWContextType::frames_get_buffer
int(* frames_get_buffer)(AVHWFramesContext *ctx, AVFrame *frame)
Definition: hwcontext_internal.h:83
HWMapDescriptor::source
AVFrame * source
A reference to the original source of the mapping.
Definition: hwcontext_internal.h:136
AVBufferPool
The buffer pool.
Definition: buffer_internal.h:88
HWContextType::transfer_data_to
int(* transfer_data_to)(AVHWFramesContext *ctx, AVFrame *dst, const AVFrame *src)
Definition: hwcontext_internal.h:87
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:340
ff_hwcontext_type_qsv
const HWContextType ff_hwcontext_type_qsv
Definition: hwcontext_qsv.c:2245
HWContextType::map_to
int(* map_to)(AVHWFramesContext *ctx, AVFrame *dst, const AVFrame *src, int flags)
Definition: hwcontext_internal.h:92
ff_hwcontext_type_vdpau
const HWContextType ff_hwcontext_type_vdpau
Definition: hwcontext_vdpau.c:507
HWContextType::frames_init
int(* frames_init)(AVHWFramesContext *ctx)
Definition: hwcontext_internal.h:80
ff_hwcontext_type_vaapi
const HWContextType ff_hwcontext_type_vaapi
Definition: hwcontext_vaapi.c:2016
HWContextType::map_from
int(* map_from)(AVHWFramesContext *ctx, AVFrame *dst, const AVFrame *src, int flags)
Definition: hwcontext_internal.h:94
HWContextType::device_hwconfig_size
size_t device_hwconfig_size
Size of the hardware-specific device configuration.
Definition: hwcontext_internal.h:54
AVDictionary
Definition: dict.c:34
HWMapDescriptor::hw_frames_ctx
AVBufferRef * hw_frames_ctx
A reference to the hardware frames context in which this mapping was made.
Definition: hwcontext_internal.h:142
HWMapDescriptor::priv
void * priv
Hardware-specific private data associated with the mapping.
Definition: hwcontext_internal.h:151
AVHWFramesInternal::source_frames
AVBufferRef * source_frames
For a derived context, a reference to the original frames context it was derived from.
Definition: hwcontext_internal.h:124
AVHWFramesInternal::pool_internal
AVBufferPool * pool_internal
Definition: hwcontext_internal.h:118
AVHWFramesConstraints
This struct describes the constraints on hardware frames attached to a given device with a hardware-s...
Definition: hwcontext.h:454
AVHWFramesInternal::priv
void * priv
Definition: hwcontext_internal.h:116
HWContextType::device_derive
int(* device_derive)(AVHWDeviceContext *dst_ctx, AVHWDeviceContext *src_ctx, AVDictionary *opts, int flags)
Definition: hwcontext_internal.h:69
HWContextType::frames_get_constraints
int(* frames_get_constraints)(AVHWDeviceContext *ctx, const void *hwconfig, AVHWFramesConstraints *constraints)
Definition: hwcontext_internal.h:76
ff_hwcontext_type_mediacodec
const HWContextType ff_hwcontext_type_mediacodec
Definition: hwcontext_mediacodec.c:107
HWContextType::frames_priv_size
size_t frames_priv_size
size of the private data, i.e.
Definition: hwcontext_internal.h:65
AVHWFramesInternal::source_allocation_map_flags
int source_allocation_map_flags
Flags to apply to the mapping from the source to the derived frame context when trying to allocate in...
Definition: hwcontext_internal.h:129
AVHWDeviceContext
This struct aggregates all the (hardware/vendor-specific) "high-level" state, i.e.
Definition: hwcontext.h:62
ff_hwcontext_type_d3d12va
const HWContextType ff_hwcontext_type_d3d12va
Definition: hwcontext_d3d12va.c:669
HWContextType::type
enum AVHWDeviceType type
Definition: hwcontext_internal.h:30
HWContextType::frames_uninit
void(* frames_uninit)(AVHWFramesContext *ctx)
Definition: hwcontext_internal.h:81
ff_hwframe_map_replace
int ff_hwframe_map_replace(AVFrame *dst, const AVFrame *src)
Replace the current hwmap of dst with the one from src, used for indirect mappings like VAAPI->(DRM)-...
Definition: hwcontext.c:952
AVHWDeviceType
AVHWDeviceType
Definition: hwcontext.h:27
ctx
AVFormatContext * ctx
Definition: movenc.c:48
HWContextType::device_create
int(* device_create)(AVHWDeviceContext *ctx, const char *device, AVDictionary *opts, int flags)
Definition: hwcontext_internal.h:67
ff_hwcontext_type_videotoolbox
const HWContextType ff_hwcontext_type_videotoolbox
Definition: hwcontext_videotoolbox.c:762
frame
static AVFrame * frame
Definition: demux_decode.c:54
opts
AVDictionary * opts
Definition: movenc.c:50
AVHWDeviceInternal::priv
void * priv
Definition: hwcontext_internal.h:105
HWContextType::transfer_get_formats
int(* transfer_get_formats)(AVHWFramesContext *ctx, enum AVHWFrameTransferDirection dir, enum AVPixelFormat **formats)
Definition: hwcontext_internal.h:84
AVHWFramesInternal
Definition: hwcontext_internal.h:114
ff_hwframe_map_create
int ff_hwframe_map_create(AVBufferRef *hwframe_ref, AVFrame *dst, const AVFrame *src, void(*unmap)(AVHWFramesContext *ctx, HWMapDescriptor *hwmap), void *priv)
Definition: hwcontext.c:745
HWContextType::frames_derive_to
int(* frames_derive_to)(AVHWFramesContext *dst_ctx, AVHWFramesContext *src_ctx, int flags)
Definition: hwcontext_internal.h:97
AVHWFramesInternal::hw_type
const HWContextType * hw_type
Definition: hwcontext_internal.h:115
frame.h
buffer.h
HWContextType::frames_derive_from
int(* frames_derive_from)(AVHWFramesContext *dst_ctx, AVHWFramesContext *src_ctx, int flags)
Definition: hwcontext_internal.h:99
HWContextType::frames_hwctx_size
size_t frames_hwctx_size
size of the public frame pool hardware-specific context, i.e.
Definition: hwcontext_internal.h:60
AVHWDeviceInternal
Definition: hwcontext_internal.h:103
ff_hwcontext_type_vulkan
const HWContextType ff_hwcontext_type_vulkan
Definition: hwcontext_vulkan.c:3717
HWContextType::device_hwctx_size
size_t device_hwctx_size
size of the public hardware-specific context, i.e.
Definition: hwcontext_internal.h:43
ff_hwcontext_type_drm
const HWContextType ff_hwcontext_type_drm
Definition: hwcontext_drm.c:304
HWContextType::name
const char * name
Definition: hwcontext_internal.h:31
HWMapDescriptor::unmap
void(* unmap)(AVHWFramesContext *ctx, struct HWMapDescriptor *hwmap)
Unmap function.
Definition: hwcontext_internal.h:146
AVHWDeviceInternal::hw_type
const HWContextType * hw_type
Definition: hwcontext_internal.h:104
ff_hwcontext_type_d3d11va
const HWContextType ff_hwcontext_type_d3d11va
Definition: hwcontext_d3d11va.c:694
AVHWFrameTransferDirection
AVHWFrameTransferDirection
Definition: hwcontext.h:416
AVHWFramesContext
This struct describes a set or pool of "hardware" frames (i.e.
Definition: hwcontext.h:125
pixfmt.h
HWContextType::device_init
int(* device_init)(AVHWDeviceContext *ctx)
Definition: hwcontext_internal.h:73
HWContextType::pix_fmts
enum AVPixelFormat * pix_fmts
An array of pixel formats supported by the AVHWFramesContext instances Terminated by AV_PIX_FMT_NONE.
Definition: hwcontext_internal.h:37
HWContextType::device_priv_size
size_t device_priv_size
size of the private data, i.e.
Definition: hwcontext_internal.h:48
AVBufferRef
A reference to a data buffer.
Definition: buffer.h:82
ff_hwcontext_type_cuda
const HWContextType ff_hwcontext_type_cuda
Definition: hwcontext_cuda.c:561
src
INIT_CLIP pixel * src
Definition: h264pred_template.c:418
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:474
hwcontext.h
HWContextType::transfer_data_from
int(* transfer_data_from)(AVHWFramesContext *ctx, AVFrame *dst, const AVFrame *src)
Definition: hwcontext_internal.h:89
HWContextType
Definition: hwcontext_internal.h:29
int
int
Definition: ffmpeg_filter.c:424
HWMapDescriptor
Definition: hwcontext_internal.h:132
ff_hwcontext_type_opencl
const HWContextType ff_hwcontext_type_opencl
Definition: hwcontext_opencl.c:2931
ff_hwcontext_type_dxva2
const HWContextType ff_hwcontext_type_dxva2
Definition: hwcontext_dxva2.c:584