lavc: handle hw_frames_ctx where necessary
[libav.git] / libavutil / hwcontext.h
CommitLineData
89923e41
AK
1/*
2 * This file is part of Libav.
3 *
4 * Libav 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 * Libav 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 Libav; 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_H
20#define AVUTIL_HWCONTEXT_H
21
22#include "buffer.h"
23#include "frame.h"
24#include "log.h"
25#include "pixfmt.h"
26
27enum AVHWDeviceType {
28 AV_HWDEVICE_TYPE_VDPAU,
ad884d10 29 AV_HWDEVICE_TYPE_CUDA,
551c6775 30 AV_HWDEVICE_TYPE_VAAPI,
c46db38c 31 AV_HWDEVICE_TYPE_DXVA2,
89923e41
AK
32};
33
34typedef struct AVHWDeviceInternal AVHWDeviceInternal;
35
36/**
37 * This struct aggregates all the (hardware/vendor-specific) "high-level" state,
38 * i.e. state that is not tied to a concrete processing configuration.
39 * E.g., in an API that supports hardware-accelerated encoding and decoding,
40 * this struct will (if possible) wrap the state that is common to both encoding
41 * and decoding and from which specific instances of encoders or decoders can be
42 * derived.
43 *
44 * This struct is reference-counted with the AVBuffer mechanism. The
45 * av_hwdevice_ctx_alloc() constructor yields a reference, whose data field
46 * points to the actual AVHWDeviceContext. Further objects derived from
47 * AVHWDeviceContext (such as AVHWFramesContext, describing a frame pool with
48 * specific properties) will hold an internal reference to it. After all the
49 * references are released, the AVHWDeviceContext itself will be freed,
50 * optionally invoking a user-specified callback for uninitializing the hardware
51 * state.
52 */
53typedef struct AVHWDeviceContext {
54 /**
55 * A class for logging. Set by av_hwdevice_ctx_alloc().
56 */
57 const AVClass *av_class;
58
59 /**
60 * Private data used internally by libavutil. Must not be accessed in any
61 * way by the caller.
62 */
63 AVHWDeviceInternal *internal;
64
65 /**
66 * This field identifies the underlying API used for hardware access.
67 *
68 * This field is set when this struct is allocated and never changed
69 * afterwards.
70 */
71 enum AVHWDeviceType type;
72
73 /**
74 * The format-specific data, allocated and freed by libavutil along with
75 * this context.
76 *
77 * Should be cast by the user to the format-specific context defined in the
78 * corresponding header (hwcontext_*.h) and filled as described in the
79 * documentation before calling av_hwdevice_ctx_init().
80 *
81 * After calling av_hwdevice_ctx_init() this struct should not be modified
82 * by the caller.
83 */
84 void *hwctx;
85
86 /**
87 * This field may be set by the caller before calling av_hwdevice_ctx_init().
88 *
89 * If non-NULL, this callback will be called when the last reference to
90 * this context is unreferenced, immediately before it is freed.
91 *
92 * @note when other objects (e.g an AVHWFramesContext) are derived from this
93 * struct, this callback will be invoked after all such child objects
94 * are fully uninitialized and their respective destructors invoked.
95 */
96 void (*free)(struct AVHWDeviceContext *ctx);
97
98 /**
99 * Arbitrary user data, to be used e.g. by the free() callback.
100 */
101 void *user_opaque;
102} AVHWDeviceContext;
103
104typedef struct AVHWFramesInternal AVHWFramesInternal;
105
106/**
107 * This struct describes a set or pool of "hardware" frames (i.e. those with
108 * data not located in normal system memory). All the frames in the pool are
109 * assumed to be allocated in the same way and interchangeable.
110 *
111 * This struct is reference-counted with the AVBuffer mechanism and tied to a
112 * given AVHWDeviceContext instance. The av_hwframe_ctx_alloc() constructor
113 * yields a reference, whose data field points to the actual AVHWFramesContext
114 * struct.
115 */
116typedef struct AVHWFramesContext {
117 /**
118 * A class for logging.
119 */
120 const AVClass *av_class;
121
122 /**
123 * Private data used internally by libavutil. Must not be accessed in any
124 * way by the caller.
125 */
126 AVHWFramesInternal *internal;
127
128 /**
129 * A reference to the parent AVHWDeviceContext. This reference is owned and
130 * managed by the enclosing AVHWFramesContext, but the caller may derive
131 * additional references from it.
132 */
133 AVBufferRef *device_ref;
134
135 /**
136 * The parent AVHWDeviceContext. This is simply a pointer to
137 * device_ref->data provided for convenience.
138 *
139 * Set by libavutil in av_hwframe_ctx_init().
140 */
141 AVHWDeviceContext *device_ctx;
142
143 /**
144 * The format-specific data, allocated and freed automatically along with
145 * this context.
146 *
147 * Should be cast by the user to the format-specific context defined in the
148 * corresponding header (hwframe_*.h) and filled as described in the
149 * documentation before calling av_hwframe_ctx_init().
150 *
151 * After any frames using this context are created, the contents of this
152 * struct should not be modified by the caller.
153 */
154 void *hwctx;
155
156 /**
157 * This field may be set by the caller before calling av_hwframe_ctx_init().
158 *
159 * If non-NULL, this callback will be called when the last reference to
160 * this context is unreferenced, immediately before it is freed.
161 */
162 void (*free)(struct AVHWFramesContext *ctx);
163
164 /**
165 * Arbitrary user data, to be used e.g. by the free() callback.
166 */
167 void *user_opaque;
168
169 /**
170 * A pool from which the frames are allocated by av_hwframe_get_buffer().
171 * This field may be set by the caller before calling av_hwframe_ctx_init().
172 * The buffers returned by calling av_buffer_pool_get() on this pool must
41ed7ab4 173 * have the properties described in the documentation in the corresponding hw
89923e41
AK
174 * type's header (hwcontext_*.h). The pool will be freed strictly before
175 * this struct's free() callback is invoked.
176 *
177 * This field may be NULL, then libavutil will attempt to allocate a pool
178 * internally. Note that certain device types enforce pools allocated at
179 * fixed size (frame count), which cannot be extended dynamically. In such a
180 * case, initial_pool_size must be set appropriately.
181 */
182 AVBufferPool *pool;
183
184 /**
185 * Initial size of the frame pool. If a device type does not support
186 * dynamically resizing the pool, then this is also the maximum pool size.
187 *
188 * May be set by the caller before calling av_hwframe_ctx_init(). Must be
189 * set if pool is NULL and the device type does not support dynamic pools.
190 */
191 int initial_pool_size;
192
193 /**
194 * The pixel format identifying the underlying HW surface type.
195 *
196 * Must be a hwaccel format, i.e. the corresponding descriptor must have the
197 * AV_PIX_FMT_FLAG_HWACCEL flag set.
198 *
199 * Must be set by the user before calling av_hwframe_ctx_init().
200 */
201 enum AVPixelFormat format;
202
203 /**
204 * The pixel format identifying the actual data layout of the hardware
205 * frames.
206 *
207 * Must be set by the caller before calling av_hwframe_ctx_init().
208 *
209 * @note when the underlying API does not provide the exact data layout, but
210 * only the colorspace/bit depth, this field should be set to the fully
211 * planar version of that format (e.g. for 8-bit 420 YUV it should be
212 * AV_PIX_FMT_YUV420P, not AV_PIX_FMT_NV12 or anything else).
213 */
214 enum AVPixelFormat sw_format;
215
216 /**
217 * The allocated dimensions of the frames in this pool.
218 *
219 * Must be set by the user before calling av_hwframe_ctx_init().
220 */
221 int width, height;
222} AVHWFramesContext;
223
224/**
225 * Allocate an AVHWDeviceContext for a given pixel format.
226 *
227 * @param format a hwaccel pixel format (AV_PIX_FMT_FLAG_HWACCEL must be set
228 * on the corresponding format descriptor)
229 * @return a reference to the newly created AVHWDeviceContext on success or NULL
230 * on failure.
231 */
232AVBufferRef *av_hwdevice_ctx_alloc(enum AVHWDeviceType type);
233
234/**
235 * Finalize the device context before use. This function must be called after
236 * the context is filled with all the required information and before it is
237 * used in any way.
238 *
239 * @param ref a reference to the AVHWDeviceContext
240 * @return 0 on success, a negative AVERROR code on failure
241 */
242int av_hwdevice_ctx_init(AVBufferRef *ref);
243
244/**
245 * Allocate an AVHWFramesContext tied to a given device context.
246 *
247 * @param device_ctx a reference to a AVHWDeviceContext. This function will make
248 * a new reference for internal use, the one passed to the
249 * function remains owned by the caller.
250 * @return a reference to the newly created AVHWFramesContext on success or NULL
251 * on failure.
252 */
253AVBufferRef *av_hwframe_ctx_alloc(AVBufferRef *device_ctx);
254
255/**
256 * Finalize the context before use. This function must be called after the
257 * context is filled with all the required information and before it is attached
258 * to any frames.
259 *
260 * @param ref a reference to the AVHWFramesContext
261 * @return 0 on success, a negative AVERROR code on failure
262 */
263int av_hwframe_ctx_init(AVBufferRef *ref);
264
265/**
266 * Allocate a new frame attached to the given AVHWFramesContext.
267 *
268 * @param hwframe_ctx a reference to an AVHWFramesContext
269 * @param frame an empty (freshly allocated or unreffed) frame to be filled with
270 * newly allocated buffers.
271 * @param flags currently unused, should be set to zero
272 * @return 0 on success, a negative AVERROR code on failure
273 */
274int av_hwframe_get_buffer(AVBufferRef *hwframe_ctx, AVFrame *frame, int flags);
275
276/**
277 * Copy data to or from a hw surface. At least one of dst/src must have an
278 * AVHWFramesContext attached.
279 *
280 * If src has an AVHWFramesContext attached, then the format of dst (if set)
281 * must use one of the formats returned by av_hwframe_transfer_get_formats(src,
282 * AV_HWFRAME_TRANSFER_DIRECTION_FROM).
283 * If dst has an AVHWFramesContext attached, then the format of src must use one
284 * of the formats returned by av_hwframe_transfer_get_formats(dst,
285 * AV_HWFRAME_TRANSFER_DIRECTION_TO)
286 *
287 * dst may be "clean" (i.e. with data/buf pointers unset), in which case the
288 * data buffers will be allocated by this function using av_frame_get_buffer().
289 * If dst->format is set, then this format will be used, otherwise (when
290 * dst->format is AV_PIX_FMT_NONE) the first acceptable format will be chosen.
291 *
292 * @param dst the destination frame. dst is not touched on failure.
293 * @param src the source frame.
294 * @param flags currently unused, should be set to zero
295 * @return 0 on success, a negative AVERROR error code on failure.
296 */
297int av_hwframe_transfer_data(AVFrame *dst, const AVFrame *src, int flags);
298
299enum AVHWFrameTransferDirection {
300 /**
301 * Transfer the data from the queried hw frame.
302 */
303 AV_HWFRAME_TRANSFER_DIRECTION_FROM,
304
305 /**
306 * Transfer the data to the queried hw frame.
307 */
308 AV_HWFRAME_TRANSFER_DIRECTION_TO,
309};
310
311/**
312 * Get a list of possible source or target formats usable in
313 * av_hwframe_transfer_data().
314 *
315 * @param hwframe_ctx the frame context to obtain the information for
316 * @param dir the direction of the transfer
317 * @param formats the pointer to the output format list will be written here.
318 * The list is terminated with AV_PIX_FMT_NONE and must be freed
319 * by the caller when no longer needed using av_free().
320 * If this function returns successfully, the format list will
321 * have at least one item (not counting the terminator).
322 * On failure, the contents of this pointer are unspecified.
323 * @param flags currently unused, should be set to zero
324 * @return 0 on success, a negative AVERROR code on failure.
325 */
326int av_hwframe_transfer_get_formats(AVBufferRef *hwframe_ctx,
327 enum AVHWFrameTransferDirection dir,
328 enum AVPixelFormat **formats, int flags);
329
330
b1f01e85
MT
331/**
332 * This struct describes the constraints on hardware frames attached to
333 * a given device with a hardware-specific configuration. This is returned
334 * by av_hwdevice_get_hwframe_constraints() and must be freed by
335 * av_hwframe_constraints_free() after use.
336 */
337typedef struct AVHWFramesConstraints {
338 /**
339 * A list of possible values for format in the hw_frames_ctx,
340 * terminated by AV_PIX_FMT_NONE. This member will always be filled.
341 */
342 enum AVPixelFormat *valid_hw_formats;
343
344 /**
345 * A list of possible values for sw_format in the hw_frames_ctx,
346 * terminated by AV_PIX_FMT_NONE. Can be NULL if this information is
347 * not known.
348 */
349 enum AVPixelFormat *valid_sw_formats;
350
351 /**
352 * The minimum size of frames in this hw_frames_ctx.
353 * (Zero if not known.)
354 */
355 int min_width;
356 int min_height;
357
358 /**
359 * The maximum size of frames in this hw_frames_ctx.
360 * (INT_MAX if not known / no limit.)
361 */
362 int max_width;
363 int max_height;
364} AVHWFramesConstraints;
365
366/**
367 * Allocate a HW-specific configuration structure for a given HW device.
368 * After use, the user must free all members as required by the specific
369 * hardware structure being used, then free the structure itself with
370 * av_free().
371 *
372 * @param device_ctx a reference to the associated AVHWDeviceContext.
373 * @return The newly created HW-specific configuration structure on
374 * success or NULL on failure.
375 */
376void *av_hwdevice_hwconfig_alloc(AVBufferRef *device_ctx);
377
378/**
379 * Get the constraints on HW frames given a device and the HW-specific
380 * configuration to be used with that device. If no HW-specific
41ed7ab4 381 * configuration is provided, returns the maximum possible capabilities
b1f01e85
MT
382 * of the device.
383 *
384 * @param device_ctx a reference to the associated AVHWDeviceContext.
385 * @param hwconfig a filled HW-specific configuration structure, or NULL
386 * to return the maximum possible capabilities of the device.
387 * @return AVHWFramesConstraints structure describing the constraints
388 * on the device, or NULL if not available.
389 */
390AVHWFramesConstraints *av_hwdevice_get_hwframe_constraints(AVBufferRef *ref,
391 const void *hwconfig);
392
393/**
394 * Free an AVHWFrameConstraints structure.
395 *
396 * @param constraints The (filled or unfilled) AVHWFrameConstraints structure.
397 */
398void av_hwframe_constraints_free(AVHWFramesConstraints **constraints);
399
89923e41 400#endif /* AVUTIL_HWCONTEXT_H */