cfc6ad0e28024d501ab49d6f856a7577444cda7f
[ffmpeg.git] / libavutil / hwcontext.h
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_H
20 #define AVUTIL_HWCONTEXT_H
21
22 #include "buffer.h"
23 #include "frame.h"
24 #include "log.h"
25 #include "pixfmt.h"
26
27 enum AVHWDeviceType {
28     AV_HWDEVICE_TYPE_VDPAU,
29     AV_HWDEVICE_TYPE_CUDA,
30     AV_HWDEVICE_TYPE_VAAPI,
31     AV_HWDEVICE_TYPE_DXVA2,
32     AV_HWDEVICE_TYPE_QSV,
33     AV_HWDEVICE_TYPE_VIDEOTOOLBOX,
34 };
35
36 typedef struct AVHWDeviceInternal AVHWDeviceInternal;
37
38 /**
39  * This struct aggregates all the (hardware/vendor-specific) "high-level" state,
40  * i.e. state that is not tied to a concrete processing configuration.
41  * E.g., in an API that supports hardware-accelerated encoding and decoding,
42  * this struct will (if possible) wrap the state that is common to both encoding
43  * and decoding and from which specific instances of encoders or decoders can be
44  * derived.
45  *
46  * This struct is reference-counted with the AVBuffer mechanism. The
47  * av_hwdevice_ctx_alloc() constructor yields a reference, whose data field
48  * points to the actual AVHWDeviceContext. Further objects derived from
49  * AVHWDeviceContext (such as AVHWFramesContext, describing a frame pool with
50  * specific properties) will hold an internal reference to it. After all the
51  * references are released, the AVHWDeviceContext itself will be freed,
52  * optionally invoking a user-specified callback for uninitializing the hardware
53  * state.
54  */
55 typedef struct AVHWDeviceContext {
56     /**
57      * A class for logging. Set by av_hwdevice_ctx_alloc().
58      */
59     const AVClass *av_class;
60
61     /**
62      * Private data used internally by libavutil. Must not be accessed in any
63      * way by the caller.
64      */
65     AVHWDeviceInternal *internal;
66
67     /**
68      * This field identifies the underlying API used for hardware access.
69      *
70      * This field is set when this struct is allocated and never changed
71      * afterwards.
72      */
73     enum AVHWDeviceType type;
74
75     /**
76      * The format-specific data, allocated and freed by libavutil along with
77      * this context.
78      *
79      * Should be cast by the user to the format-specific context defined in the
80      * corresponding header (hwcontext_*.h) and filled as described in the
81      * documentation before calling av_hwdevice_ctx_init().
82      *
83      * After calling av_hwdevice_ctx_init() this struct should not be modified
84      * by the caller.
85      */
86     void *hwctx;
87
88     /**
89      * This field may be set by the caller before calling av_hwdevice_ctx_init().
90      *
91      * If non-NULL, this callback will be called when the last reference to
92      * this context is unreferenced, immediately before it is freed.
93      *
94      * @note when other objects (e.g an AVHWFramesContext) are derived from this
95      *       struct, this callback will be invoked after all such child objects
96      *       are fully uninitialized and their respective destructors invoked.
97      */
98     void (*free)(struct AVHWDeviceContext *ctx);
99
100     /**
101      * Arbitrary user data, to be used e.g. by the free() callback.
102      */
103     void *user_opaque;
104 } AVHWDeviceContext;
105
106 typedef struct AVHWFramesInternal AVHWFramesInternal;
107
108 /**
109  * This struct describes a set or pool of "hardware" frames (i.e. those with
110  * data not located in normal system memory). All the frames in the pool are
111  * assumed to be allocated in the same way and interchangeable.
112  *
113  * This struct is reference-counted with the AVBuffer mechanism and tied to a
114  * given AVHWDeviceContext instance. The av_hwframe_ctx_alloc() constructor
115  * yields a reference, whose data field points to the actual AVHWFramesContext
116  * struct.
117  */
118 typedef struct AVHWFramesContext {
119     /**
120      * A class for logging.
121      */
122     const AVClass *av_class;
123
124     /**
125      * Private data used internally by libavutil. Must not be accessed in any
126      * way by the caller.
127      */
128     AVHWFramesInternal *internal;
129
130     /**
131      * A reference to the parent AVHWDeviceContext. This reference is owned and
132      * managed by the enclosing AVHWFramesContext, but the caller may derive
133      * additional references from it.
134      */
135     AVBufferRef *device_ref;
136
137     /**
138      * The parent AVHWDeviceContext. This is simply a pointer to
139      * device_ref->data provided for convenience.
140      *
141      * Set by libavutil in av_hwframe_ctx_init().
142      */
143     AVHWDeviceContext *device_ctx;
144
145     /**
146      * The format-specific data, allocated and freed automatically along with
147      * this context.
148      *
149      * Should be cast by the user to the format-specific context defined in the
150      * corresponding header (hwframe_*.h) and filled as described in the
151      * documentation before calling av_hwframe_ctx_init().
152      *
153      * After any frames using this context are created, the contents of this
154      * struct should not be modified by the caller.
155      */
156     void *hwctx;
157
158     /**
159      * This field may be set by the caller before calling av_hwframe_ctx_init().
160      *
161      * If non-NULL, this callback will be called when the last reference to
162      * this context is unreferenced, immediately before it is freed.
163      */
164     void (*free)(struct AVHWFramesContext *ctx);
165
166     /**
167      * Arbitrary user data, to be used e.g. by the free() callback.
168      */
169     void *user_opaque;
170
171     /**
172      * A pool from which the frames are allocated by av_hwframe_get_buffer().
173      * This field may be set by the caller before calling av_hwframe_ctx_init().
174      * The buffers returned by calling av_buffer_pool_get() on this pool must
175      * have the properties described in the documentation in the corresponding hw
176      * type's header (hwcontext_*.h). The pool will be freed strictly before
177      * this struct's free() callback is invoked.
178      *
179      * This field may be NULL, then libavutil will attempt to allocate a pool
180      * internally. Note that certain device types enforce pools allocated at
181      * fixed size (frame count), which cannot be extended dynamically. In such a
182      * case, initial_pool_size must be set appropriately.
183      */
184     AVBufferPool *pool;
185
186     /**
187      * Initial size of the frame pool. If a device type does not support
188      * dynamically resizing the pool, then this is also the maximum pool size.
189      *
190      * May be set by the caller before calling av_hwframe_ctx_init(). Must be
191      * set if pool is NULL and the device type does not support dynamic pools.
192      */
193     int initial_pool_size;
194
195     /**
196      * The pixel format identifying the underlying HW surface type.
197      *
198      * Must be a hwaccel format, i.e. the corresponding descriptor must have the
199      * AV_PIX_FMT_FLAG_HWACCEL flag set.
200      *
201      * Must be set by the user before calling av_hwframe_ctx_init().
202      */
203     enum AVPixelFormat format;
204
205     /**
206      * The pixel format identifying the actual data layout of the hardware
207      * frames.
208      *
209      * Must be set by the caller before calling av_hwframe_ctx_init().
210      *
211      * @note when the underlying API does not provide the exact data layout, but
212      * only the colorspace/bit depth, this field should be set to the fully
213      * planar version of that format (e.g. for 8-bit 420 YUV it should be
214      * AV_PIX_FMT_YUV420P, not AV_PIX_FMT_NV12 or anything else).
215      */
216     enum AVPixelFormat sw_format;
217
218     /**
219      * The allocated dimensions of the frames in this pool.
220      *
221      * Must be set by the user before calling av_hwframe_ctx_init().
222      */
223     int width, height;
224 } AVHWFramesContext;
225
226 /**
227  * Allocate an AVHWDeviceContext for a given hardware type.
228  *
229  * @param type the type of the hardware device to allocate.
230  * @return a reference to the newly created AVHWDeviceContext on success or NULL
231  *         on failure.
232  */
233 AVBufferRef *av_hwdevice_ctx_alloc(enum AVHWDeviceType type);
234
235 /**
236  * Finalize the device context before use. This function must be called after
237  * the context is filled with all the required information and before it is
238  * used in any way.
239  *
240  * @param ref a reference to the AVHWDeviceContext
241  * @return 0 on success, a negative AVERROR code on failure
242  */
243 int av_hwdevice_ctx_init(AVBufferRef *ref);
244
245 /**
246  * Open a device of the specified type and create an AVHWDeviceContext for it.
247  *
248  * This is a convenience function intended to cover the simple cases. Callers
249  * who need to fine-tune device creation/management should open the device
250  * manually and then wrap it in an AVHWDeviceContext using
251  * av_hwdevice_ctx_alloc()/av_hwdevice_ctx_init().
252  *
253  * The returned context is already initialized and ready for use, the caller
254  * should not call av_hwdevice_ctx_init() on it. The user_opaque/free fields of
255  * the created AVHWDeviceContext are set by this function and should not be
256  * touched by the caller.
257  *
258  * @param device_ctx On success, a reference to the newly-created device context
259  *                   will be written here. The reference is owned by the caller
260  *                   and must be released with av_buffer_unref() when no longer
261  *                   needed. On failure, NULL will be written to this pointer.
262  * @param type The type of the device to create.
263  * @param device A type-specific string identifying the device to open.
264  * @param opts A dictionary of additional (type-specific) options to use in
265  *             opening the device. The dictionary remains owned by the caller.
266  * @param flags currently unused
267  *
268  * @return 0 on success, a negative AVERROR code on failure.
269  */
270 int av_hwdevice_ctx_create(AVBufferRef **device_ctx, enum AVHWDeviceType type,
271                            const char *device, AVDictionary *opts, int flags);
272
273 /**
274  * Allocate an AVHWFramesContext tied to a given device context.
275  *
276  * @param device_ctx a reference to a AVHWDeviceContext. This function will make
277  *                   a new reference for internal use, the one passed to the
278  *                   function remains owned by the caller.
279  * @return a reference to the newly created AVHWFramesContext on success or NULL
280  *         on failure.
281  */
282 AVBufferRef *av_hwframe_ctx_alloc(AVBufferRef *device_ctx);
283
284 /**
285  * Finalize the context before use. This function must be called after the
286  * context is filled with all the required information and before it is attached
287  * to any frames.
288  *
289  * @param ref a reference to the AVHWFramesContext
290  * @return 0 on success, a negative AVERROR code on failure
291  */
292 int av_hwframe_ctx_init(AVBufferRef *ref);
293
294 /**
295  * Allocate a new frame attached to the given AVHWFramesContext.
296  *
297  * @param hwframe_ctx a reference to an AVHWFramesContext
298  * @param frame an empty (freshly allocated or unreffed) frame to be filled with
299  *              newly allocated buffers.
300  * @param flags currently unused, should be set to zero
301  * @return 0 on success, a negative AVERROR code on failure
302  */
303 int av_hwframe_get_buffer(AVBufferRef *hwframe_ctx, AVFrame *frame, int flags);
304
305 /**
306  * Copy data to or from a hw surface. At least one of dst/src must have an
307  * AVHWFramesContext attached.
308  *
309  * If src has an AVHWFramesContext attached, then the format of dst (if set)
310  * must use one of the formats returned by av_hwframe_transfer_get_formats(src,
311  * AV_HWFRAME_TRANSFER_DIRECTION_FROM).
312  * If dst has an AVHWFramesContext attached, then the format of src must use one
313  * of the formats returned by av_hwframe_transfer_get_formats(dst,
314  * AV_HWFRAME_TRANSFER_DIRECTION_TO)
315  *
316  * dst may be "clean" (i.e. with data/buf pointers unset), in which case the
317  * data buffers will be allocated by this function using av_frame_get_buffer().
318  * If dst->format is set, then this format will be used, otherwise (when
319  * dst->format is AV_PIX_FMT_NONE) the first acceptable format will be chosen.
320  *
321  * The two frames must have matching allocated dimensions (i.e. equal to
322  * AVHWFramesContext.width/height), since not all device types support
323  * transferring a sub-rectangle of the whole surface. The display dimensions
324  * (i.e. AVFrame.width/height) may be smaller than the allocated dimensions, but
325  * also have to be equal for both frames. When the display dimensions are
326  * smaller than the allocated dimensions, the content of the padding in the
327  * destination frame is unspecified.
328  *
329  * @param dst the destination frame. dst is not touched on failure.
330  * @param src the source frame.
331  * @param flags currently unused, should be set to zero
332  * @return 0 on success, a negative AVERROR error code on failure.
333  */
334 int av_hwframe_transfer_data(AVFrame *dst, const AVFrame *src, int flags);
335
336 enum AVHWFrameTransferDirection {
337     /**
338      * Transfer the data from the queried hw frame.
339      */
340     AV_HWFRAME_TRANSFER_DIRECTION_FROM,
341
342     /**
343      * Transfer the data to the queried hw frame.
344      */
345     AV_HWFRAME_TRANSFER_DIRECTION_TO,
346 };
347
348 /**
349  * Get a list of possible source or target formats usable in
350  * av_hwframe_transfer_data().
351  *
352  * @param hwframe_ctx the frame context to obtain the information for
353  * @param dir the direction of the transfer
354  * @param formats the pointer to the output format list will be written here.
355  *                The list is terminated with AV_PIX_FMT_NONE and must be freed
356  *                by the caller when no longer needed using av_free().
357  *                If this function returns successfully, the format list will
358  *                have at least one item (not counting the terminator).
359  *                On failure, the contents of this pointer are unspecified.
360  * @param flags currently unused, should be set to zero
361  * @return 0 on success, a negative AVERROR code on failure.
362  */
363 int av_hwframe_transfer_get_formats(AVBufferRef *hwframe_ctx,
364                                     enum AVHWFrameTransferDirection dir,
365                                     enum AVPixelFormat **formats, int flags);
366
367
368 /**
369  * This struct describes the constraints on hardware frames attached to
370  * a given device with a hardware-specific configuration.  This is returned
371  * by av_hwdevice_get_hwframe_constraints() and must be freed by
372  * av_hwframe_constraints_free() after use.
373  */
374 typedef struct AVHWFramesConstraints {
375     /**
376      * A list of possible values for format in the hw_frames_ctx,
377      * terminated by AV_PIX_FMT_NONE.  This member will always be filled.
378      */
379     enum AVPixelFormat *valid_hw_formats;
380
381     /**
382      * A list of possible values for sw_format in the hw_frames_ctx,
383      * terminated by AV_PIX_FMT_NONE.  Can be NULL if this information is
384      * not known.
385      */
386     enum AVPixelFormat *valid_sw_formats;
387
388     /**
389      * The minimum size of frames in this hw_frames_ctx.
390      * (Zero if not known.)
391      */
392     int min_width;
393     int min_height;
394
395     /**
396      * The maximum size of frames in this hw_frames_ctx.
397      * (INT_MAX if not known / no limit.)
398      */
399     int max_width;
400     int max_height;
401 } AVHWFramesConstraints;
402
403 /**
404  * Allocate a HW-specific configuration structure for a given HW device.
405  * After use, the user must free all members as required by the specific
406  * hardware structure being used, then free the structure itself with
407  * av_free().
408  *
409  * @param device_ctx a reference to the associated AVHWDeviceContext.
410  * @return The newly created HW-specific configuration structure on
411  *         success or NULL on failure.
412  */
413 void *av_hwdevice_hwconfig_alloc(AVBufferRef *device_ctx);
414
415 /**
416  * Get the constraints on HW frames given a device and the HW-specific
417  * configuration to be used with that device.  If no HW-specific
418  * configuration is provided, returns the maximum possible capabilities
419  * of the device.
420  *
421  * @param ref a reference to the associated AVHWDeviceContext.
422  * @param hwconfig a filled HW-specific configuration structure, or NULL
423  *        to return the maximum possible capabilities of the device.
424  * @return AVHWFramesConstraints structure describing the constraints
425  *         on the device, or NULL if not available.
426  */
427 AVHWFramesConstraints *av_hwdevice_get_hwframe_constraints(AVBufferRef *ref,
428                                                            const void *hwconfig);
429
430 /**
431  * Free an AVHWFrameConstraints structure.
432  *
433  * @param constraints The (filled or unfilled) AVHWFrameConstraints structure.
434  */
435 void av_hwframe_constraints_free(AVHWFramesConstraints **constraints);
436
437
438 /**
439  * Flags to apply to frame mappings.
440  */
441 enum {
442     /**
443      * The mapping must be readable.
444      */
445     AV_HWFRAME_MAP_READ      = 1 << 0,
446     /**
447      * The mapping must be writeable.
448      */
449     AV_HWFRAME_MAP_WRITE     = 1 << 1,
450     /**
451      * The mapped frame will be overwritten completely in subsequent
452      * operations, so the current frame data need not be loaded.  Any values
453      * which are not overwritten are unspecified.
454      */
455     AV_HWFRAME_MAP_OVERWRITE = 1 << 2,
456     /**
457      * The mapping must be direct.  That is, there must not be any copying in
458      * the map or unmap steps.  Note that performance of direct mappings may
459      * be much lower than normal memory.
460      */
461     AV_HWFRAME_MAP_DIRECT    = 1 << 3,
462 };
463
464 /**
465  * Map a hardware frame.
466  *
467  * This has a number of different possible effects, depending on the format
468  * and origin of the src and dst frames.  On input, src should be a usable
469  * frame with valid buffers and dst should be blank (typically as just created
470  * by av_frame_alloc()).  src should have an associated hwframe context, and
471  * dst may optionally have a format and associated hwframe context.
472  *
473  * If src was created by mapping a frame from the hwframe context of dst,
474  * then this function undoes the mapping - dst is replaced by a reference to
475  * the frame that src was originally mapped from.
476  *
477  * If both src and dst have an associated hwframe context, then this function
478  * attempts to map the src frame from its hardware context to that of dst and
479  * then fill dst with appropriate data to be usable there.  This will only be
480  * possible if the hwframe contexts and associated devices are compatible -
481  * given compatible devices, av_hwframe_ctx_create_derived() can be used to
482  * create a hwframe context for dst in which mapping should be possible.
483  *
484  * If src has a hwframe context but dst does not, then the src frame is
485  * mapped to normal memory and should thereafter be usable as a normal frame.
486  * If the format is set on dst, then the mapping will attempt to create dst
487  * with that format and fail if it is not possible.  If format is unset (is
488  * AV_PIX_FMT_NONE) then dst will be mapped with whatever the most appropriate
489  * format to use is (probably the sw_format of the src hwframe context).
490  *
491  * A return value of AVERROR(ENOSYS) indicates that the mapping is not
492  * possible with the given arguments and hwframe setup, while other return
493  * values indicate that it failed somehow.
494  *
495  * @param dst Destination frame, to contain the mapping.
496  * @param src Source frame, to be mapped.
497  * @param flags Some combination of AV_HWFRAME_MAP_* flags.
498  * @return Zero on success, negative AVERROR code on failure.
499  */
500 int av_hwframe_map(AVFrame *dst, const AVFrame *src, int flags);
501
502
503 /**
504  * Create and initialise an AVHWFramesContext as a mapping of another existing
505  * AVHWFramesContext on a different device.
506  *
507  * av_hwframe_ctx_init() should not be called after this.
508  *
509  * @param derived_frame_ctx  On success, a reference to the newly created
510  *                           AVHWFramesContext.
511  * @param derived_device_ctx A reference to the device to create the new
512  *                           AVHWFramesContext on.
513  * @param source_frame_ctx   A reference to an existing AVHWFramesContext
514  *                           which will be mapped to the derived context.
515  * @param flags  Currently unused; should be set to zero.
516  * @return       Zero on success, negative AVERROR code on failure.
517  */
518 int av_hwframe_ctx_create_derived(AVBufferRef **derived_frame_ctx,
519                                   enum AVPixelFormat format,
520                                   AVBufferRef *derived_device_ctx,
521                                   AVBufferRef *source_frame_ctx,
522                                   int flags);
523
524 #endif /* AVUTIL_HWCONTEXT_H */