avutil/tests/audio_fifo.c: pass by reference for efficiency and change datatype to...
[ffmpeg.git] / libavutil / hwcontext_vaapi.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_VAAPI_H
20 #define AVUTIL_HWCONTEXT_VAAPI_H
21
22 #include <va/va.h>
23
24 /**
25  * @file
26  * API-specific header for AV_HWDEVICE_TYPE_VAAPI.
27  *
28  * Dynamic frame pools are supported, but note that any pool used as a render
29  * target is required to be of fixed size in order to be be usable as an
30  * argument to vaCreateContext().
31  *
32  * For user-allocated pools, AVHWFramesContext.pool must return AVBufferRefs
33  * with the data pointer set to a VASurfaceID.
34  */
35
36 enum {
37     /**
38      * The quirks field has been set by the user and should not be detected
39      * automatically by av_hwdevice_ctx_init().
40      */
41     AV_VAAPI_DRIVER_QUIRK_USER_SET = (1 << 0),
42     /**
43      * The driver does not destroy parameter buffers when they are used by
44      * vaRenderPicture().  Additional code will be required to destroy them
45      * separately afterwards.
46      */
47     AV_VAAPI_DRIVER_QUIRK_RENDER_PARAM_BUFFERS = (1 << 1),
48
49     /**
50      * The driver does not support the VASurfaceAttribMemoryType attribute,
51      * so the surface allocation code will not try to use it.
52      */
53     AV_VAAPI_DRIVER_QUIRK_ATTRIB_MEMTYPE = (1 << 2),
54 };
55
56 /**
57  * VAAPI connection details.
58  *
59  * Allocated as AVHWDeviceContext.hwctx
60  */
61 typedef struct AVVAAPIDeviceContext {
62     /**
63      * The VADisplay handle, to be filled by the user.
64      */
65     VADisplay display;
66     /**
67      * Driver quirks to apply - this is filled by av_hwdevice_ctx_init(),
68      * with reference to a table of known drivers, unless the
69      * AV_VAAPI_DRIVER_QUIRK_USER_SET bit is already present.  The user
70      * may need to refer to this field when performing any later
71      * operations using VAAPI with the same VADisplay.
72      */
73     unsigned int driver_quirks;
74 } AVVAAPIDeviceContext;
75
76 /**
77  * VAAPI-specific data associated with a frame pool.
78  *
79  * Allocated as AVHWFramesContext.hwctx.
80  */
81 typedef struct AVVAAPIFramesContext {
82     /**
83      * Set by the user to apply surface attributes to all surfaces in
84      * the frame pool.  If null, default settings are used.
85      */
86     VASurfaceAttrib *attributes;
87     int           nb_attributes;
88     /**
89      * The surfaces IDs of all surfaces in the pool after creation.
90      * Only valid if AVHWFramesContext.initial_pool_size was positive.
91      * These are intended to be used as the render_targets arguments to
92      * vaCreateContext().
93      */
94     VASurfaceID     *surface_ids;
95     int           nb_surfaces;
96 } AVVAAPIFramesContext;
97
98 /**
99  * VAAPI hardware pipeline configuration details.
100  *
101  * Allocated with av_hwdevice_hwconfig_alloc().
102  */
103 typedef struct AVVAAPIHWConfig {
104     /**
105      * ID of a VAAPI pipeline configuration.
106      */
107     VAConfigID config_id;
108 } AVVAAPIHWConfig;
109
110 #endif /* AVUTIL_HWCONTEXT_VAAPI_H */