Userful gstreamer-vaapi
[vaapi:cpu-gstreamer-vaapi.git] / gst-libs / gst / vaapi / gstvaapicontext.h
1 /*
2  *  gstvaapicontext.h - VA context abstraction (private)
3  *
4  *  Copyright (C) 2010-2011 Splitted-Desktop Systems
5  *    Author: Gwenole Beauchesne <gwenole.beauchesne@splitted-desktop.com>
6  *  Copyright (C) 2011-2014 Intel Corporation
7  *    Author: Gwenole Beauchesne <gwenole.beauchesne@intel.com>
8  *
9  *  This library is free software; you can redistribute it and/or
10  *  modify it under the terms of the GNU Lesser General Public License
11  *  as published by the Free Software Foundation; either version 2.1
12  *  of the License, or (at your option) any later version.
13  *
14  *  This library is distributed in the hope that it will be useful,
15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  *  Lesser General Public License for more details.
18  *
19  *  You should have received a copy of the GNU Lesser General Public
20  *  License along with this library; if not, write to the Free
21  *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22  *  Boston, MA 02110-1301 USA
23  */
24
25 #ifndef GST_VAAPI_CONTEXT_H
26 #define GST_VAAPI_CONTEXT_H
27
28 #include "gstvaapiobject.h"
29 #include "gstvaapiobject_priv.h"
30 #include "gstvaapiprofile.h"
31 #include "gstvaapidisplay.h"
32 #include "gstvaapisurface.h"
33 #include "gstvaapivideopool.h"
34
35 G_BEGIN_DECLS
36
37 #define GST_VAAPI_CONTEXT(obj) \
38   ((GstVaapiContext *) (obj))
39
40 typedef struct _GstVaapiConfigInfoEncoder GstVaapiConfigInfoEncoder;
41 typedef struct _GstVaapiContextInfo GstVaapiContextInfo;
42 typedef struct _GstVaapiContext GstVaapiContext;
43 typedef struct _GstVaapiContextClass GstVaapiContextClass;
44
45 /**
46  * GstVaapiContextUsage:
47  * @GST_VAAPI_CONTEXT_MODE_DECODE: context used for decoding.
48  * @GST_VAAPI_CONTEXT_MODE_ENCODE: context used for encoding.
49  * @GST_VAAPI_CONTEXT_MODE_VPP: context used for video processing.
50  *
51  * The set of supported VA context usages.
52  */
53 typedef enum {
54   GST_VAAPI_CONTEXT_USAGE_DECODE = 1,
55   GST_VAAPI_CONTEXT_USAGE_ENCODE,
56   GST_VAAPI_CONTEXT_USAGE_VPP,
57 } GstVaapiContextUsage;
58
59 /**
60  * GstVaapiConfigInfoEncoder:
61  * @rc_mode: rate-control mode (#GstVaapiRateControl).
62  * @packed_headers: notify encoder that packed headers are submitted (mask).
63  *
64  * Extra configuration for encoding.
65  */
66 struct _GstVaapiConfigInfoEncoder
67 {
68   GstVaapiRateControl rc_mode;
69   guint packed_headers;
70 };
71
72 /**
73  * GstVaapiContextInfo:
74  *
75  * Structure holding VA context info like encoded size, decoder
76  * profile and entry-point to use, and maximum number of reference
77  * frames reported by the bitstream.
78  */
79 struct _GstVaapiContextInfo
80 {
81   GstVaapiContextUsage usage;
82   GstVaapiProfile profile;
83   GstVaapiEntrypoint entrypoint;
84   guint width;
85   guint height;
86   guint ref_frames;
87   union _GstVaapiConfigInfo {
88     GstVaapiConfigInfoEncoder encoder;
89   } config;
90 };
91
92 /**
93  * GstVaapiContext:
94  *
95  * A VA context wrapper.
96  */
97 struct _GstVaapiContext
98 {
99   /*< private >*/
100   GstVaapiObject parent_instance;
101
102   GstVaapiContextInfo info;
103   VAProfile va_profile;
104   VAEntrypoint va_entrypoint;
105   VAConfigID va_config;
106   GPtrArray *surfaces;
107   GstVaapiVideoPool *surfaces_pool;
108   GPtrArray *overlays[2];
109   guint overlay_id;
110 };
111
112 /**
113  * GstVaapiContextClass:
114  *
115  * A VA context wrapper class.
116  */
117 struct _GstVaapiContextClass
118 {
119   /*< private >*/
120   GstVaapiObjectClass parent_class;
121 };
122
123 G_GNUC_INTERNAL
124 GstVaapiContext *
125 gst_vaapi_context_new (GstVaapiDisplay * display,
126     const GstVaapiContextInfo * cip);
127
128 G_GNUC_INTERNAL
129 gboolean
130 gst_vaapi_context_reset (GstVaapiContext * context,
131     const GstVaapiContextInfo * new_cip);
132
133 G_GNUC_INTERNAL
134 GstVaapiID
135 gst_vaapi_context_get_id (GstVaapiContext * context);
136
137 G_GNUC_INTERNAL
138 GstVaapiSurfaceProxy *
139 gst_vaapi_context_get_surface_proxy (GstVaapiContext * context);
140
141 G_GNUC_INTERNAL
142 guint
143 gst_vaapi_context_get_surface_count (GstVaapiContext * context);
144
145 G_END_DECLS
146
147 #endif /* GST_VAAPI_CONTEXT_H */