24217964d8cff9d6fa11e021ab7faf14a4384831
[platform/upstream/gstreamer.git] / tools / element-templates / basetransform
1 /* vim: set filetype=c: */
2 % ClassName
3 GstBaseTransform
4 % TYPE_CLASS_NAME
5 GST_TYPE_BASE_TRANSFORM
6 % pads
7 srcpad-simple
8 sinkpad-simple
9 % pkg-config
10 gstreamer-base-1.0
11 % includes
12 #include <gst/base/gstbasetransform.h>
13 % prototypes
14 static GstCaps *gst_replace_transform_caps (GstBaseTransform * trans,
15     GstPadDirection direction, GstCaps * caps, GstCaps * filter);
16 static GstCaps *gst_replace_fixate_caps (GstBaseTransform * trans,
17     GstPadDirection direction, GstCaps * caps, GstCaps * othercaps);
18 static gboolean gst_replace_accept_caps (GstBaseTransform * trans,
19     GstPadDirection direction, GstCaps * caps);
20 static gboolean gst_replace_set_caps (GstBaseTransform * trans,
21     GstCaps * incaps, GstCaps * outcaps);
22 static gboolean gst_replace_query (GstBaseTransform * trans,
23     GstPadDirection direction, GstQuery * query);
24 static gboolean gst_replace_decide_allocation (GstBaseTransform * trans,
25     GstQuery * query);
26 static gboolean gst_replace_filter_meta (GstBaseTransform * trans,
27     GstQuery * query, GType api, const GstStructure * params);
28 static gboolean gst_replace_propose_allocation (GstBaseTransform * trans,
29     GstQuery * decide_query, GstQuery * query);
30 static gboolean gst_replace_transform_size (GstBaseTransform * trans,
31     GstPadDirection direction, GstCaps * caps, gsize size, GstCaps * othercaps,
32     gsize * othersize);
33 static gboolean gst_replace_get_unit_size (GstBaseTransform * trans,
34     GstCaps * caps, gsize * size);
35 static gboolean gst_replace_start (GstBaseTransform * trans);
36 static gboolean gst_replace_stop (GstBaseTransform * trans);
37 static gboolean gst_replace_sink_event (GstBaseTransform * trans,
38     GstEvent * event);
39 static gboolean gst_replace_src_event (GstBaseTransform * trans,
40     GstEvent * event);
41 static GstFlowReturn gst_replace_prepare_output_buffer (GstBaseTransform *
42     trans, GstBuffer * input, GstBuffer ** outbuf);
43 static gboolean gst_replace_copy_metadata (GstBaseTransform * trans,
44     GstBuffer * input, GstBuffer * outbuf);
45 static gboolean gst_replace_transform_meta (GstBaseTransform * trans,
46     GstBuffer * outbuf, GstMeta * meta, GstBuffer * inbuf);
47 static void gst_replace_before_transform (GstBaseTransform * trans,
48     GstBuffer * buffer);
49 static GstFlowReturn gst_replace_transform (GstBaseTransform * trans,
50     GstBuffer * inbuf, GstBuffer * outbuf);
51 static GstFlowReturn gst_replace_transform_ip (GstBaseTransform * trans,
52     GstBuffer * buf);
53 % declare-class
54   GstBaseTransformClass *base_transform_class = GST_BASE_TRANSFORM_CLASS (klass);
55 % set-methods
56   base_transform_class->transform_caps = GST_DEBUG_FUNCPTR (gst_replace_transform_caps);
57   base_transform_class->fixate_caps = GST_DEBUG_FUNCPTR (gst_replace_fixate_caps);
58   base_transform_class->accept_caps = GST_DEBUG_FUNCPTR (gst_replace_accept_caps);
59   base_transform_class->set_caps = GST_DEBUG_FUNCPTR (gst_replace_set_caps);
60   base_transform_class->query = GST_DEBUG_FUNCPTR (gst_replace_query);
61   base_transform_class->decide_allocation = GST_DEBUG_FUNCPTR (gst_replace_decide_allocation);
62   base_transform_class->filter_meta = GST_DEBUG_FUNCPTR (gst_replace_filter_meta);
63   base_transform_class->propose_allocation = GST_DEBUG_FUNCPTR (gst_replace_propose_allocation);
64   base_transform_class->transform_size = GST_DEBUG_FUNCPTR (gst_replace_transform_size);
65   base_transform_class->get_unit_size = GST_DEBUG_FUNCPTR (gst_replace_get_unit_size);
66   base_transform_class->start = GST_DEBUG_FUNCPTR (gst_replace_start);
67   base_transform_class->stop = GST_DEBUG_FUNCPTR (gst_replace_stop);
68   base_transform_class->sink_event = GST_DEBUG_FUNCPTR (gst_replace_sink_event);
69   base_transform_class->src_event = GST_DEBUG_FUNCPTR (gst_replace_src_event);
70   base_transform_class->prepare_output_buffer = GST_DEBUG_FUNCPTR (gst_replace_prepare_output_buffer);
71   base_transform_class->copy_metadata = GST_DEBUG_FUNCPTR (gst_replace_copy_metadata);
72   base_transform_class->transform_meta = GST_DEBUG_FUNCPTR (gst_replace_transform_meta);
73   base_transform_class->before_transform = GST_DEBUG_FUNCPTR (gst_replace_before_transform);
74   base_transform_class->transform = GST_DEBUG_FUNCPTR (gst_replace_transform);
75   base_transform_class->transform_ip = GST_DEBUG_FUNCPTR (gst_replace_transform_ip);
76 % methods
77 static GstCaps *
78 gst_replace_transform_caps (GstBaseTransform * trans, GstPadDirection direction,
79     GstCaps * caps, GstCaps * filter)
80 {
81   GstReplace *replace = GST_REPLACE (trans);
82
83   GST_DEBUG_OBJECT (replace, "transform_caps");
84
85   return NULL;
86 }
87
88 static GstCaps *
89 gst_replace_fixate_caps (GstBaseTransform * trans, GstPadDirection direction,
90     GstCaps * caps, GstCaps * othercaps)
91 {
92   GstReplace *replace = GST_REPLACE (trans);
93
94   GST_DEBUG_OBJECT (replace, "fixate_caps");
95
96   return NULL;
97 }
98
99 static gboolean
100 gst_replace_accept_caps (GstBaseTransform * trans, GstPadDirection direction,
101     GstCaps * caps)
102 {
103   GstReplace *replace = GST_REPLACE (trans);
104
105   GST_DEBUG_OBJECT (replace, "accept_caps");
106
107   return TRUE;
108 }
109
110 static gboolean
111 gst_replace_set_caps (GstBaseTransform * trans, GstCaps * incaps,
112     GstCaps * outcaps)
113 {
114   GstReplace *replace = GST_REPLACE (trans);
115
116   GST_DEBUG_OBJECT (replace, "set_caps");
117
118   return TRUE;
119 }
120
121 static gboolean
122 gst_replace_query (GstBaseTransform * trans, GstPadDirection direction,
123     GstQuery * query)
124 {
125   GstReplace *replace = GST_REPLACE (trans);
126
127   GST_DEBUG_OBJECT (replace, "query");
128
129   return TRUE;
130 }
131
132 /* decide allocation query for output buffers */
133 static gboolean
134 gst_replace_decide_allocation (GstBaseTransform * trans, GstQuery * query)
135 {
136   GstReplace *replace = GST_REPLACE (trans);
137
138   GST_DEBUG_OBJECT (replace, "decide_allocation");
139
140   return TRUE;
141 }
142
143 static gboolean
144 gst_replace_filter_meta (GstBaseTransform * trans, GstQuery * query, GType api,
145     const GstStructure * params)
146 {
147   GstReplace *replace = GST_REPLACE (trans);
148
149   GST_DEBUG_OBJECT (replace, "filter_meta");
150
151   return TRUE;
152 }
153
154 /* propose allocation query parameters for input buffers */
155 static gboolean
156 gst_replace_propose_allocation (GstBaseTransform * trans,
157     GstQuery * decide_query, GstQuery * query)
158 {
159   GstReplace *replace = GST_REPLACE (trans);
160
161   GST_DEBUG_OBJECT (replace, "propose_allocation");
162
163   return TRUE;
164 }
165
166 /* transform size */
167 static gboolean
168 gst_replace_transform_size (GstBaseTransform * trans, GstPadDirection direction,
169     GstCaps * caps, gsize size, GstCaps * othercaps, gsize * othersize)
170 {
171   GstReplace *replace = GST_REPLACE (trans);
172
173   GST_DEBUG_OBJECT (replace, "transform_size");
174
175   return TRUE;
176 }
177
178 static gboolean
179 gst_replace_get_unit_size (GstBaseTransform * trans, GstCaps * caps,
180     gsize * size)
181 {
182   GstReplace *replace = GST_REPLACE (trans);
183
184   GST_DEBUG_OBJECT (replace, "get_unit_size");
185
186   return TRUE;
187 }
188
189 /* states */
190 static gboolean
191 gst_replace_start (GstBaseTransform * trans)
192 {
193   GstReplace *replace = GST_REPLACE (trans);
194
195   GST_DEBUG_OBJECT (replace, "start");
196
197   return TRUE;
198 }
199
200 static gboolean
201 gst_replace_stop (GstBaseTransform * trans)
202 {
203   GstReplace *replace = GST_REPLACE (trans);
204
205   GST_DEBUG_OBJECT (replace, "stop");
206
207   return TRUE;
208 }
209
210 /* sink and src pad event handlers */
211 static gboolean
212 gst_replace_sink_event (GstBaseTransform * trans, GstEvent * event)
213 {
214   GstReplace *replace = GST_REPLACE (trans);
215
216   GST_DEBUG_OBJECT (replace, "sink_event");
217
218   return GST_BASE_TRANSFORM_CLASS (gst_replace_parent_class)->sink_event (
219       trans, event);
220 }
221
222 static gboolean
223 gst_replace_src_event (GstBaseTransform * trans, GstEvent * event)
224 {
225   GstReplace *replace = GST_REPLACE (trans);
226
227   GST_DEBUG_OBJECT (replace, "src_event");
228
229   return GST_BASE_TRANSFORM_CLASS (gst_replace_parent_class)->src_event (
230       trans, event);
231 }
232
233 static GstFlowReturn
234 gst_replace_prepare_output_buffer (GstBaseTransform * trans, GstBuffer * input,
235     GstBuffer ** outbuf)
236 {
237   GstReplace *replace = GST_REPLACE (trans);
238
239   GST_DEBUG_OBJECT (replace, "prepare_output_buffer");
240
241   return GST_FLOW_OK;
242 }
243
244 /* metadata */
245 static gboolean
246 gst_replace_copy_metadata (GstBaseTransform * trans, GstBuffer * input,
247     GstBuffer * outbuf)
248 {
249   GstReplace *replace = GST_REPLACE (trans);
250
251   GST_DEBUG_OBJECT (replace, "copy_metadata");
252
253   return TRUE;
254 }
255
256 static gboolean
257 gst_replace_transform_meta (GstBaseTransform * trans, GstBuffer * outbuf,
258     GstMeta * meta, GstBuffer * inbuf)
259 {
260   GstReplace *replace = GST_REPLACE (trans);
261
262   GST_DEBUG_OBJECT (replace, "transform_meta");
263
264   return TRUE;
265 }
266
267 static void
268 gst_replace_before_transform (GstBaseTransform * trans, GstBuffer * buffer)
269 {
270   GstReplace *replace = GST_REPLACE (trans);
271
272   GST_DEBUG_OBJECT (replace, "before_transform");
273
274 }
275
276 /* transform */
277 static GstFlowReturn
278 gst_replace_transform (GstBaseTransform * trans, GstBuffer * inbuf,
279     GstBuffer * outbuf)
280 {
281   GstReplace *replace = GST_REPLACE (trans);
282
283   GST_DEBUG_OBJECT (replace, "transform");
284
285   return GST_FLOW_OK;
286 }
287
288 static GstFlowReturn
289 gst_replace_transform_ip (GstBaseTransform * trans, GstBuffer * buf)
290 {
291   GstReplace *replace = GST_REPLACE (trans);
292
293   GST_DEBUG_OBJECT (replace, "transform_ip");
294
295   return GST_FLOW_OK;
296 }
297 % end