vaapisink: add support for "display-name" property.
[platform/upstream/gstreamer-vaapi.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 #include "gstvaapiuploader.h"
34
35 G_BEGIN_DECLS
36
37 typedef struct _GstVaapiPluginBase GstVaapiPluginBase;
38 typedef struct _GstVaapiPluginBaseClass GstVaapiPluginBaseClass;
39
40 #define GST_VAAPI_PLUGIN_BASE(plugin) \
41   ((GstVaapiPluginBase *)(plugin))
42 #define GST_VAAPI_PLUGIN_BASE_CLASS(plugin) \
43   ((GstVaapiPluginBaseClass *)(plugin))
44 #define GST_VAAPI_PLUGIN_BASE_GET_CLASS(plugin) \
45   GST_VAAPI_PLUGIN_BASE_CLASS(GST_ELEMENT_GET_CLASS( \
46       GST_VAAPI_PLUGIN_BASE_ELEMENT(plugin)))
47 #define GST_VAAPI_PLUGIN_BASE_PARENT(plugin) \
48   (&GST_VAAPI_PLUGIN_BASE(plugin)->parent_instance)
49 #define GST_VAAPI_PLUGIN_BASE_PARENT_CLASS(plugin) \
50   (&GST_VAAPI_PLUGIN_BASE_CLASS(plugin)->parent_class)
51 #define GST_VAAPI_PLUGIN_BASE_ELEMENT(plugin) \
52   (&GST_VAAPI_PLUGIN_BASE_PARENT(plugin)->element)
53 #define GST_VAAPI_PLUGIN_BASE_ELEMENT_CLASS(plugin) \
54   (&GST_VAAPI_PLUGIN_BASE_PARENT_CLASS(plugin)->element)
55 #define GST_VAAPI_PLUGIN_BASE_DECODER(plugin) \
56   (&GST_VAAPI_PLUGIN_BASE_PARENT(plugin)->decoder)
57 #define GST_VAAPI_PLUGIN_BASE_DECODER_CLASS(plugin) \
58   (&GST_VAAPI_PLUGIN_BASE_PARENT_CLASS(plugin)->decoder)
59 #define GST_VAAPI_PLUGIN_BASE_ENCODER(plugin) \
60   (&GST_VAAPI_PLUGIN_BASE_PARENT(plugin)->encoder)
61 #define GST_VAAPI_PLUGIN_BASE_ENCODER_CLASS(plugin) \
62   (&GST_VAAPI_PLUGIN_BASE_PARENT_CLASS(plugin)->encoder)
63 #define GST_VAAPI_PLUGIN_BASE_TRANSFORM(plugin) \
64   (&GST_VAAPI_PLUGIN_BASE_PARENT(plugin)->transform)
65 #define GST_VAAPI_PLUGIN_BASE_TRANSFORM_CLASS(plugin) \
66   (&GST_VAAPI_PLUGIN_BASE_PARENT_CLASS(plugin)->transform)
67 #define GST_VAAPI_PLUGIN_BASE_SINK(plugin) \
68   (&GST_VAAPI_PLUGIN_BASE_PARENT(plugin)->sink)
69 #define GST_VAAPI_PLUGIN_BASE_SINK_CLASS(plugin) \
70   (&GST_VAAPI_PLUGIN_BASE_PARENT_CLASS(plugin)->sink)
71
72 #define GST_VAAPI_PLUGIN_BASE_INIT_INTERFACES \
73   gst_vaapi_plugin_base_init_interfaces(g_define_type_id);
74
75 #define GST_VAAPI_PLUGIN_BASE_SINK_PAD(plugin) \
76   (GST_VAAPI_PLUGIN_BASE(plugin)->sinkpad)
77 #define GST_VAAPI_PLUGIN_BASE_SINK_PAD_CAPS(plugin) \
78   (GST_VAAPI_PLUGIN_BASE(plugin)->sinkpad_caps)
79 #define GST_VAAPI_PLUGIN_BASE_SINK_PAD_INFO(plugin) \
80   (&GST_VAAPI_PLUGIN_BASE(plugin)->sinkpad_info)
81 #define GST_VAAPI_PLUGIN_BASE_SINK_PAD_QUERYFUNC(plugin) \
82   (GST_VAAPI_PLUGIN_BASE(plugin)->sinkpad_query)
83 #define GST_VAAPI_PLUGIN_BASE_SRC_PAD(plugin) \
84   (GST_VAAPI_PLUGIN_BASE(plugin)->srcpad)
85 #define GST_VAAPI_PLUGIN_BASE_SRC_PAD_CAPS(plugin) \
86   (GST_VAAPI_PLUGIN_BASE(plugin)->srcpad_caps)
87 #define GST_VAAPI_PLUGIN_BASE_SRC_PAD_INFO(plugin) \
88   (&GST_VAAPI_PLUGIN_BASE(plugin)->srcpad_info)
89 #define GST_VAAPI_PLUGIN_BASE_SRC_PAD_QUERYFYNC(plugin) \
90   (GST_VAAPI_PLUGIN_BASE(plugin)->srcpad_query)
91
92 #define GST_VAAPI_PLUGIN_BASE_DISPLAY(plugin) \
93   (GST_VAAPI_PLUGIN_BASE(plugin)->display)
94 #define GST_VAAPI_PLUGIN_BASE_DISPLAY_TYPE(plugin) \
95   (GST_VAAPI_PLUGIN_BASE(plugin)->display_type)
96 #define GST_VAAPI_PLUGIN_BASE_DISPLAY_NAME(plugin) \
97   (GST_VAAPI_PLUGIN_BASE(plugin)->display_name)
98 #define GST_VAAPI_PLUGIN_BASE_DISPLAY_REPLACE(plugin, new_display) \
99   (gst_vaapi_display_replace(&GST_VAAPI_PLUGIN_BASE_DISPLAY(plugin), \
100        (new_display)))
101
102 #define GST_VAAPI_PLUGIN_BASE_UPLOADER(plugin) \
103   (GST_VAAPI_PLUGIN_BASE(plugin)->uploader)
104 #define GST_VAAPI_PLUGIN_BASE_UPLOADER_CAPS(plugin) \
105   (gst_vaapi_uploader_get_caps(GST_VAAPI_PLUGIN_BASE_UPLOADER(plugin)))
106 #define GST_VAAPI_PLUGIN_BASE_UPLOADER_USED(plugin) \
107   (GST_VAAPI_PLUGIN_BASE(plugin)->uploader_used)
108
109 struct _GstVaapiPluginBase
110 {
111   /*< private >*/
112   union
113   {
114     GstElement element;
115     GstVideoDecoder decoder;
116     GstVideoEncoder encoder;
117     GstBaseTransform transform;
118     GstVideoSink sink;
119   } parent_instance;
120
121   GstDebugCategory *debug_category;
122
123   GstPad *sinkpad;
124   GstCaps *sinkpad_caps;
125   gboolean sinkpad_caps_changed;
126   GstVideoInfo sinkpad_info;
127   GstPadQueryFunction sinkpad_query;
128 #if GST_CHECK_VERSION(1,0,0)
129   GstBufferPool *sinkpad_buffer_pool;
130   guint sinkpad_buffer_size;
131 #endif
132
133   GstPad *srcpad;
134   GstCaps *srcpad_caps;
135   gboolean srcpad_caps_changed;
136   GstVideoInfo srcpad_info;
137   GstPadQueryFunction srcpad_query;
138
139   GstVaapiDisplay *display;
140   GstVaapiDisplayType display_type;
141   GstVaapiDisplayType display_type_req;
142   gchar *display_name;
143
144   GstVaapiUploader *uploader;
145   gboolean uploader_used;
146 };
147
148 struct _GstVaapiPluginBaseClass
149 {
150   /*< private >*/
151   union
152   {
153     GstElementClass element;
154     GstVideoDecoderClass decoder;
155     GstVideoEncoderClass encoder;
156     GstBaseTransformClass transform;
157     GstVideoSinkClass sink;
158   } parent_class;
159
160   gboolean  (*has_interface) (GstVaapiPluginBase * plugin, GType type);
161   void (*display_changed) (GstVaapiPluginBase * plugin);
162 };
163
164 G_GNUC_INTERNAL
165 void
166 gst_vaapi_plugin_base_init_interfaces (GType type);
167
168 G_GNUC_INTERNAL
169 void
170 gst_vaapi_plugin_base_class_init (GstVaapiPluginBaseClass * klass);
171
172 G_GNUC_INTERNAL
173 void
174 gst_vaapi_plugin_base_init (GstVaapiPluginBase * plugin,
175     GstDebugCategory * debug_category);
176
177 G_GNUC_INTERNAL
178 void
179 gst_vaapi_plugin_base_finalize (GstVaapiPluginBase * plugin);
180
181 G_GNUC_INTERNAL
182 gboolean
183 gst_vaapi_plugin_base_open (GstVaapiPluginBase * plugin);
184
185 G_GNUC_INTERNAL
186 void
187 gst_vaapi_plugin_base_close (GstVaapiPluginBase * plugin);
188
189 G_GNUC_INTERNAL
190 void
191 gst_vaapi_plugin_base_set_display_type (GstVaapiPluginBase * plugin,
192     GstVaapiDisplayType display_type);
193
194 G_GNUC_INTERNAL
195 void
196 gst_vaapi_plugin_base_set_display_name (GstVaapiPluginBase * plugin,
197     const gchar * display_name);
198
199 G_GNUC_INTERNAL
200 gboolean
201 gst_vaapi_plugin_base_ensure_display (GstVaapiPluginBase * plugin);
202
203 G_GNUC_INTERNAL
204 gboolean
205 gst_vaapi_plugin_base_ensure_uploader (GstVaapiPluginBase * plugin);
206
207 G_GNUC_INTERNAL
208 gboolean
209 gst_vaapi_plugin_base_set_caps (GstVaapiPluginBase * plugin, GstCaps * incaps,
210     GstCaps * outcaps);
211
212 G_GNUC_INTERNAL
213 gboolean
214 gst_vaapi_plugin_base_propose_allocation (GstVaapiPluginBase * plugin,
215     GstQuery * query);
216
217 G_GNUC_INTERNAL
218 GstFlowReturn
219 gst_vaapi_plugin_base_allocate_input_buffer (GstVaapiPluginBase * plugin,
220     GstCaps * caps, GstBuffer ** outbuf_ptr);
221
222 G_GNUC_INTERNAL
223 GstFlowReturn
224 gst_vaapi_plugin_base_get_input_buffer (GstVaapiPluginBase * plugin,
225     GstBuffer * inbuf, GstBuffer ** outbuf_ptr);
226
227 G_END_DECLS
228
229 #endif /* GST_VAAPI_PLUGIN_BASE_H */