plugins: rework set_context() vmethod definition
[platform/upstream/gstreamer.git] / gst / vaapi / gstvaapipluginbase.h
1 /*
2  *  gstvaapipluginbase.h - Base GStreamer VA-API Plugin element
3  *
4  *  Copyright (C) 2010-2011 Splitted-Desktop Systems
5  *    Author: Gwenole Beauchesne <gwenole.beauchesne@splitted-desktop.com>
6  *  Copyright (C) 2011-2013 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_PLUGIN_BASE_H
26 #define GST_VAAPI_PLUGIN_BASE_H
27
28 #include <gst/base/gstbasetransform.h>
29 #include <gst/video/gstvideodecoder.h>
30 #include <gst/video/gstvideoencoder.h>
31 #include <gst/video/gstvideosink.h>
32 #include <gst/vaapi/gstvaapidisplay.h>
33
34 #ifdef USE_GST_GL_HELPERS
35 # include <gst/gl/gstglcontext.h>
36 #endif
37
38 G_BEGIN_DECLS
39
40 typedef struct _GstVaapiPluginBase GstVaapiPluginBase;
41 typedef struct _GstVaapiPluginBaseClass GstVaapiPluginBaseClass;
42
43 #define GST_VAAPI_PLUGIN_BASE(plugin) \
44   ((GstVaapiPluginBase *)(plugin))
45 #define GST_VAAPI_PLUGIN_BASE_CLASS(plugin) \
46   ((GstVaapiPluginBaseClass *)(plugin))
47 #define GST_VAAPI_PLUGIN_BASE_GET_CLASS(plugin) \
48   GST_VAAPI_PLUGIN_BASE_CLASS(GST_ELEMENT_GET_CLASS( \
49       GST_VAAPI_PLUGIN_BASE_ELEMENT(plugin)))
50 #define GST_VAAPI_PLUGIN_BASE_PARENT(plugin) \
51   (&GST_VAAPI_PLUGIN_BASE(plugin)->parent_instance)
52 #define GST_VAAPI_PLUGIN_BASE_PARENT_CLASS(plugin) \
53   (&GST_VAAPI_PLUGIN_BASE_CLASS(plugin)->parent_class)
54 #define GST_VAAPI_PLUGIN_BASE_ELEMENT(plugin) \
55   (&GST_VAAPI_PLUGIN_BASE_PARENT(plugin)->element)
56 #define GST_VAAPI_PLUGIN_BASE_ELEMENT_CLASS(plugin) \
57   (&GST_VAAPI_PLUGIN_BASE_PARENT_CLASS(plugin)->element)
58 #define GST_VAAPI_PLUGIN_BASE_DECODER(plugin) \
59   (&GST_VAAPI_PLUGIN_BASE_PARENT(plugin)->decoder)
60 #define GST_VAAPI_PLUGIN_BASE_DECODER_CLASS(plugin) \
61   (&GST_VAAPI_PLUGIN_BASE_PARENT_CLASS(plugin)->decoder)
62 #define GST_VAAPI_PLUGIN_BASE_ENCODER(plugin) \
63   (&GST_VAAPI_PLUGIN_BASE_PARENT(plugin)->encoder)
64 #define GST_VAAPI_PLUGIN_BASE_ENCODER_CLASS(plugin) \
65   (&GST_VAAPI_PLUGIN_BASE_PARENT_CLASS(plugin)->encoder)
66 #define GST_VAAPI_PLUGIN_BASE_TRANSFORM(plugin) \
67   (&GST_VAAPI_PLUGIN_BASE_PARENT(plugin)->transform)
68 #define GST_VAAPI_PLUGIN_BASE_TRANSFORM_CLASS(plugin) \
69   (&GST_VAAPI_PLUGIN_BASE_PARENT_CLASS(plugin)->transform)
70 #define GST_VAAPI_PLUGIN_BASE_SINK(plugin) \
71   (&GST_VAAPI_PLUGIN_BASE_PARENT(plugin)->sink)
72 #define GST_VAAPI_PLUGIN_BASE_SINK_CLASS(plugin) \
73   (&GST_VAAPI_PLUGIN_BASE_PARENT_CLASS(plugin)->sink)
74
75 #define GST_VAAPI_PLUGIN_BASE_INIT_INTERFACES \
76   gst_vaapi_plugin_base_init_interfaces(g_define_type_id);
77
78 #define GST_VAAPI_PLUGIN_BASE_SINK_PAD(plugin) \
79   (GST_VAAPI_PLUGIN_BASE(plugin)->sinkpad)
80 #define GST_VAAPI_PLUGIN_BASE_SINK_PAD_CAPS(plugin) \
81   (GST_VAAPI_PLUGIN_BASE(plugin)->sinkpad_caps)
82 #define GST_VAAPI_PLUGIN_BASE_SINK_PAD_INFO(plugin) \
83   (&GST_VAAPI_PLUGIN_BASE(plugin)->sinkpad_info)
84 #define GST_VAAPI_PLUGIN_BASE_SINK_PAD_QUERYFUNC(plugin) \
85   (GST_VAAPI_PLUGIN_BASE(plugin)->sinkpad_query)
86 #define GST_VAAPI_PLUGIN_BASE_SRC_PAD(plugin) \
87   (GST_VAAPI_PLUGIN_BASE(plugin)->srcpad)
88 #define GST_VAAPI_PLUGIN_BASE_SRC_PAD_CAPS(plugin) \
89   (GST_VAAPI_PLUGIN_BASE(plugin)->srcpad_caps)
90 #define GST_VAAPI_PLUGIN_BASE_SRC_PAD_INFO(plugin) \
91   (&GST_VAAPI_PLUGIN_BASE(plugin)->srcpad_info)
92 #define GST_VAAPI_PLUGIN_BASE_SRC_PAD_QUERYFYNC(plugin) \
93   (GST_VAAPI_PLUGIN_BASE(plugin)->srcpad_query)
94
95 #define GST_VAAPI_PLUGIN_BASE_DISPLAY(plugin) \
96   (GST_VAAPI_PLUGIN_BASE(plugin)->display)
97 #define GST_VAAPI_PLUGIN_BASE_DISPLAY_TYPE(plugin) \
98   (GST_VAAPI_PLUGIN_BASE(plugin)->display_type)
99 #define GST_VAAPI_PLUGIN_BASE_DISPLAY_NAME(plugin) \
100   (GST_VAAPI_PLUGIN_BASE(plugin)->display_name)
101 #define GST_VAAPI_PLUGIN_BASE_DISPLAY_REPLACE(plugin, new_display) \
102   (gst_vaapi_display_replace(&GST_VAAPI_PLUGIN_BASE_DISPLAY(plugin), \
103        (new_display)))
104
105 #define GST_VAAPI_PLUGIN_BASE_DEFINE_SET_CONTEXT(parent_class) \
106   static void \
107   gst_vaapi_base_set_context (GstElement * element, GstContext * context) \
108   { \
109     GstVaapiPluginBase *const plugin = GST_VAAPI_PLUGIN_BASE (element); \
110     \
111     gst_vaapi_plugin_base_set_context (plugin, context); \
112     GST_ELEMENT_CLASS (parent_class)->set_context (element, context); \
113   }
114
115 struct _GstVaapiPluginBase
116 {
117   /*< private >*/
118   union
119   {
120     GstElement element;
121     GstVideoDecoder decoder;
122     GstVideoEncoder encoder;
123     GstBaseTransform transform;
124     GstVideoSink sink;
125   } parent_instance;
126
127   GstDebugCategory *debug_category;
128
129   GstPad *sinkpad;
130   GstCaps *sinkpad_caps;
131   gboolean sinkpad_caps_changed;
132   gboolean sinkpad_caps_is_raw;
133   GstVideoInfo sinkpad_info;
134   GstBufferPool *sinkpad_buffer_pool;
135   guint sinkpad_buffer_size;
136
137   GstPad *srcpad;
138   GstCaps *srcpad_caps;
139   gboolean srcpad_caps_changed;
140   GstVideoInfo srcpad_info;
141   GstBufferPool *srcpad_buffer_pool;
142
143   GstVaapiDisplay *display;
144   GstVaapiDisplayType display_type;
145   GstVaapiDisplayType display_type_req;
146   gchar *display_name;
147
148   GstObject *gl_context;
149
150   GstCaps *allowed_raw_caps;
151 };
152
153 struct _GstVaapiPluginBaseClass
154 {
155   /*< private >*/
156   union
157   {
158     GstElementClass element;
159     GstVideoDecoderClass decoder;
160     GstVideoEncoderClass encoder;
161     GstBaseTransformClass transform;
162     GstVideoSinkClass sink;
163   } parent_class;
164
165   gboolean  (*has_interface) (GstVaapiPluginBase * plugin, GType type);
166   void (*display_changed) (GstVaapiPluginBase * plugin);
167 };
168
169 G_GNUC_INTERNAL
170 void
171 gst_vaapi_plugin_base_init_interfaces (GType type);
172
173 G_GNUC_INTERNAL
174 void
175 gst_vaapi_plugin_base_class_init (GstVaapiPluginBaseClass * klass);
176
177 G_GNUC_INTERNAL
178 void
179 gst_vaapi_plugin_base_init (GstVaapiPluginBase * plugin,
180     GstDebugCategory * debug_category);
181
182 G_GNUC_INTERNAL
183 void
184 gst_vaapi_plugin_base_finalize (GstVaapiPluginBase * plugin);
185
186 G_GNUC_INTERNAL
187 gboolean
188 gst_vaapi_plugin_base_open (GstVaapiPluginBase * plugin);
189
190 G_GNUC_INTERNAL
191 void
192 gst_vaapi_plugin_base_close (GstVaapiPluginBase * plugin);
193
194 G_GNUC_INTERNAL
195 gboolean
196 gst_vaapi_plugin_base_has_display_type (GstVaapiPluginBase * plugin,
197     GstVaapiDisplayType display_type_req);
198
199 G_GNUC_INTERNAL
200 void
201 gst_vaapi_plugin_base_set_display_type (GstVaapiPluginBase * plugin,
202     GstVaapiDisplayType display_type);
203
204 G_GNUC_INTERNAL
205 void
206 gst_vaapi_plugin_base_set_display_name (GstVaapiPluginBase * plugin,
207     const gchar * display_name);
208
209 G_GNUC_INTERNAL
210 gboolean
211 gst_vaapi_plugin_base_ensure_display (GstVaapiPluginBase * plugin);
212
213 G_GNUC_INTERNAL
214 gboolean
215 gst_vaapi_plugin_base_set_caps (GstVaapiPluginBase * plugin, GstCaps * incaps,
216     GstCaps * outcaps);
217
218 G_GNUC_INTERNAL
219 gboolean
220 gst_vaapi_plugin_base_propose_allocation (GstVaapiPluginBase * plugin,
221     GstQuery * query);
222
223 G_GNUC_INTERNAL
224 gboolean
225 gst_vaapi_plugin_base_decide_allocation (GstVaapiPluginBase * plugin,
226     GstQuery * query);
227
228 G_GNUC_INTERNAL
229 GstFlowReturn
230 gst_vaapi_plugin_base_get_input_buffer (GstVaapiPluginBase * plugin,
231     GstBuffer * inbuf, GstBuffer ** outbuf_ptr);
232
233 G_GNUC_INTERNAL
234 void
235 gst_vaapi_plugin_base_set_context (GstVaapiPluginBase * plugin,
236     GstContext * context);
237
238 G_GNUC_INTERNAL
239 void
240 gst_vaapi_plugin_base_set_gl_context (GstVaapiPluginBase * plugin,
241     GstObject * object);
242
243 G_GNUC_INTERNAL
244 GstCaps *
245 gst_vaapi_plugin_base_get_allowed_raw_caps (GstVaapiPluginBase * plugin);
246
247 G_END_DECLS
248
249 #endif /* GST_VAAPI_PLUGIN_BASE_H */