FFmpeg  4.0
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, int flags);
71 
74 
76  const void *hwconfig,
77  AVHWFramesConstraints *constraints);
78 
81 
85  enum AVPixelFormat **formats);
87  const AVFrame *src);
89  const AVFrame *src);
90 
92  const AVFrame *src, int flags);
94  const AVFrame *src, int flags);
95 
97  AVHWFramesContext *src_ctx, int flags);
99  AVHWFramesContext *src_ctx, int flags);
100 } HWContextType;
101 
104  void *priv;
105 
106  /**
107  * For a derived device, a reference to the original device
108  * context it was derived from.
109  */
111 };
112 
115  void *priv;
116 
118 
119  /**
120  * For a derived context, a reference to the original frames
121  * context it was derived from.
122  */
124  /**
125  * Flags to apply to the mapping from the source to the derived
126  * frame context when trying to allocate in the derived context.
127  */
129 };
130 
131 typedef struct HWMapDescriptor {
132  /**
133  * A reference to the original source of the mapping.
134  */
136  /**
137  * A reference to the hardware frames context in which this
138  * mapping was made. May be the same as source->hw_frames_ctx,
139  * but need not be.
140  */
142  /**
143  * Unmap function.
144  */
146  struct HWMapDescriptor *hwmap);
147  /**
148  * Hardware-specific private data associated with the mapping.
149  */
150  void *priv;
152 
153 int ff_hwframe_map_create(AVBufferRef *hwframe_ref,
154  AVFrame *dst, const AVFrame *src,
155  void (*unmap)(AVHWFramesContext *ctx,
156  HWMapDescriptor *hwmap),
157  void *priv);
158 
159 
170 
171 #endif /* AVUTIL_HWCONTEXT_INTERNAL_H */
This struct aggregates all the (hardware/vendor-specific) "high-level" state, i.e.
Definition: hwcontext.h:60
This structure describes decoded (raw) audio or video data.
Definition: frame.h:218
void(* frames_uninit)(AVHWFramesContext *ctx)
int(* frames_derive_from)(AVHWFramesContext *dst_ctx, AVHWFramesContext *src_ctx, int flags)
const HWContextType ff_hwcontext_type_vdpau
const HWContextType ff_hwcontext_type_mediacodec
const HWContextType ff_hwcontext_type_dxva2
size_t device_priv_size
size of the private data, i.e.
int(* device_derive)(AVHWDeviceContext *dst_ctx, AVHWDeviceContext *src_ctx, int flags)
#define src
Definition: vp8dsp.c:254
const HWContextType * hw_type
int(* map_from)(AVHWFramesContext *ctx, AVFrame *dst, const AVFrame *src, int flags)
int(* frames_get_buffer)(AVHWFramesContext *ctx, AVFrame *frame)
AVBufferPool * pool_internal
size_t frames_priv_size
size of the private data, i.e.
enum AVHWDeviceType type
size_t device_hwctx_size
size of the public hardware-specific context, i.e.
void(* unmap)(AVHWFramesContext *ctx, struct HWMapDescriptor *hwmap)
Unmap function.
int(* transfer_data_from)(AVHWFramesContext *ctx, AVFrame *dst, const AVFrame *src)
static AVFrame * frame
const HWContextType ff_hwcontext_type_qsv
static int flags
Definition: log.c:55
size_t frames_hwctx_size
size of the public frame pool hardware-specific context, i.e.
int(* device_init)(AVHWDeviceContext *ctx)
The buffer pool.
void(* device_uninit)(AVHWDeviceContext *ctx)
AVBufferRef * source_frames
For a derived context, a reference to the original frames context it was derived from.
const HWContextType ff_hwcontext_type_videotoolbox
reference-counted frame API
AVDictionary * opts
Definition: movenc.c:50
AVFrame * source
A reference to the original source of the mapping.
enum AVPixelFormat * pix_fmts
An array of pixel formats supported by the AVHWFramesContext instances Terminated by AV_PIX_FMT_NONE...
int(* frames_derive_to)(AVHWFramesContext *dst_ctx, AVHWFramesContext *src_ctx, int flags)
const char * name
int(* transfer_get_formats)(AVHWFramesContext *ctx, enum AVHWFrameTransferDirection dir, enum AVPixelFormat **formats)
size_t device_hwconfig_size
Size of the hardware-specific device configuration.
AVFormatContext * ctx
Definition: movenc.c:48
int(* transfer_data_to)(AVHWFramesContext *ctx, AVFrame *dst, const AVFrame *src)
int ff_hwframe_map_create(AVBufferRef *hwframe_ref, AVFrame *dst, const AVFrame *src, void(*unmap)(AVHWFramesContext *ctx, HWMapDescriptor *hwmap), void *priv)
Definition: hwcontext.c:689
void * priv
Hardware-specific private data associated with the mapping.
typedef void(RENAME(mix_any_func_type))
This struct describes the constraints on hardware frames attached to a given device with a hardware-s...
Definition: hwcontext.h:432
int source_allocation_map_flags
Flags to apply to the mapping from the source to the derived frame context when trying to allocate in...
This struct describes a set or pool of "hardware" frames (i.e.
Definition: hwcontext.h:123
refcounted data buffer API
AVBufferRef * hw_frames_ctx
A reference to the hardware frames context in which this mapping was made.
int(* device_create)(AVHWDeviceContext *ctx, const char *device, AVDictionary *opts, int flags)
const HWContextType ff_hwcontext_type_d3d11va
A reference to a data buffer.
Definition: buffer.h:81
int
const HWContextType * hw_type
const HWContextType ff_hwcontext_type_opencl
const HWContextType ff_hwcontext_type_drm
const HWContextType ff_hwcontext_type_cuda
AVHWFrameTransferDirection
Definition: hwcontext.h:394
pixel format definitions
AVHWDeviceType
Definition: hwcontext.h:27
int(* frames_get_constraints)(AVHWDeviceContext *ctx, const void *hwconfig, AVHWFramesConstraints *constraints)
int(* map_to)(AVHWFramesContext *ctx, AVFrame *dst, const AVFrame *src, int flags)
AVBufferRef * source_device
For a derived device, a reference to the original device context it was derived from.
formats
Definition: signature.h:48
AVPixelFormat
Pixel format.
Definition: pixfmt.h:60
int(* frames_init)(AVHWFramesContext *ctx)
const HWContextType ff_hwcontext_type_vaapi