gst-indent run on core
[platform/upstream/gstreamer.git] / gst / gstelement.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstelement.h: Header for GstElement
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23
24 #ifndef __GST_ELEMENT_H__
25 #define __GST_ELEMENT_H__
26
27 #include <gst/gstconfig.h>
28 #include <gst/gsttypes.h>
29 #include <gst/gstobject.h>
30 #include <gst/gstpad.h>
31 #include <gst/gstclock.h>
32 #include <gst/gstplugin.h>
33 #include <gst/gstpluginfeature.h>
34 #include <gst/gstindex.h>
35 #include <gst/gsttag.h>
36
37 G_BEGIN_DECLS typedef struct _GstElementDetails GstElementDetails;
38
39 /* FIXME: need translatable stuff in here (how handle in registry)? */
40 struct _GstElementDetails
41 {
42   gchar *longname;              /* long, english name */
43   gchar *klass;                 /* type of element, as hierarchy */
44   gchar *description;           /* insights of one form or another */
45   gchar *author;                /* who wrote this thing? */
46
47   gpointer _gst_reserved[GST_PADDING];
48 };
49
50 #define GST_ELEMENT_DETAILS(longname,klass,description,author)          \
51   { longname, klass, description, author, GST_PADDING_INIT }
52 #define GST_IS_ELEMENT_DETAILS(details) (                                       \
53   (details) && ((details)->longname != NULL) && ((details)->klass != NULL)      \
54   && ((details)->description != NULL) && ((details)->author != NULL))
55
56 #define GST_NUM_STATES 4
57
58 /* NOTE: this probably should be done with an #ifdef to decide 
59  * whether to safe-cast or to just do the non-checking cast.
60  */
61 #define GST_STATE(obj)                  (GST_ELEMENT(obj)->current_state)
62 #define GST_STATE_PENDING(obj)          (GST_ELEMENT(obj)->pending_state)
63
64 /* Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g> */
65 #define GST_STATE_TRANSITION(obj)       ((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
66 #define GST_STATE_NULL_TO_READY         ((GST_STATE_NULL<<8) | GST_STATE_READY)
67 #define GST_STATE_READY_TO_PAUSED       ((GST_STATE_READY<<8) | GST_STATE_PAUSED)
68 #define GST_STATE_PAUSED_TO_PLAYING     ((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
69 #define GST_STATE_PLAYING_TO_PAUSED     ((GST_STATE_PLAYING<<8) | GST_STATE_PAUSED)
70 #define GST_STATE_PAUSED_TO_READY       ((GST_STATE_PAUSED<<8) | GST_STATE_READY)
71 #define GST_STATE_READY_TO_NULL         ((GST_STATE_READY<<8) | GST_STATE_NULL)
72
73 extern GType _gst_element_type;
74
75 #define GST_TYPE_ELEMENT                (_gst_element_type)
76 #define GST_IS_ELEMENT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
77 #define GST_IS_ELEMENT_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
78 #define GST_ELEMENT_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ELEMENT, GstElementClass))
79 #define GST_ELEMENT(obj)                (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
80 #define GST_ELEMENT_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
81
82 /* convenience functions */
83 #ifndef GST_DISABLE_DEPRECATED
84 #ifdef G_HAVE_ISO_VARARGS
85 #define GST_ELEMENT_QUERY_TYPE_FUNCTION(functionname, ...) \
86         GST_QUERY_TYPE_FUNCTION (GstElement*, functionname, __VA_ARGS__);
87 #define GST_ELEMENT_FORMATS_FUNCTION(functionname, ...)    \
88         GST_FORMATS_FUNCTION (GstElement*, functionname, __VA_ARGS__);
89 #define GST_ELEMENT_EVENT_MASK_FUNCTION(functionname, ...) \
90         GST_EVENT_MASK_FUNCTION (GstElement*, functionname, __VA_ARGS__);
91 #elif defined(G_HAVE_GNUC_VARARGS)
92 #define GST_ELEMENT_QUERY_TYPE_FUNCTION(functionname, a...) \
93         GST_QUERY_TYPE_FUNCTION (GstElement*, functionname, a);
94 #define GST_ELEMENT_FORMATS_FUNCTION(functionname, a...)    \
95         GST_FORMATS_FUNCTION (GstElement*, functionname, a);
96 #define GST_ELEMENT_EVENT_MASK_FUNCTION(functionname, a...) \
97         GST_EVENT_MASK_FUNCTION (GstElement*, functionname, a);
98 #endif
99 #endif
100
101 typedef enum
102 {
103   /* element is complex (for some def.) and generally require a cothread */
104   GST_ELEMENT_COMPLEX = GST_OBJECT_FLAG_LAST,
105   /* input and output pads aren't directly coupled to each other
106      examples: queues, multi-output async readers, etc. */
107   GST_ELEMENT_DECOUPLED,
108   /* this element should be placed in a thread if at all possible */
109   GST_ELEMENT_THREAD_SUGGESTED,
110   /* this element, for some reason, has a loop function that performs
111    * an infinite loop without calls to gst_element_yield () */
112   GST_ELEMENT_INFINITE_LOOP,
113   /* there is a new loopfunction ready for placement */
114   GST_ELEMENT_NEW_LOOPFUNC,
115   /* if this element can handle events */
116   GST_ELEMENT_EVENT_AWARE,
117   /* use threadsafe property get/set implementation */
118   GST_ELEMENT_USE_THREADSAFE_PROPERTIES,
119
120   /* private flags that can be used by the scheduler */
121   GST_ELEMENT_SCHEDULER_PRIVATE1,
122   GST_ELEMENT_SCHEDULER_PRIVATE2,
123
124   /* ignore state changes from parent */
125   GST_ELEMENT_LOCKED_STATE,
126
127   /* element is in error */
128   GST_ELEMENT_IN_ERROR,
129
130   /* use some padding for future expansion */
131   GST_ELEMENT_FLAG_LAST = GST_OBJECT_FLAG_LAST + 16
132 } GstElementFlags;
133
134 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)    (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
135 #define GST_ELEMENT_IS_EVENT_AWARE(obj)         (GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
136 #define GST_ELEMENT_IS_DECOUPLED(obj)           (GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
137
138 #define GST_ELEMENT_NAME(obj)                   (GST_OBJECT_NAME(obj))
139 #define GST_ELEMENT_PARENT(obj)                 (GST_OBJECT_PARENT(obj))
140 #define GST_ELEMENT_MANAGER(obj)                (((GstElement*)(obj))->manager)
141 #define GST_ELEMENT_SCHED(obj)                  (((GstElement*)(obj))->sched)
142 #define GST_ELEMENT_CLOCK(obj)                  (((GstElement*)(obj))->clock)
143 #define GST_ELEMENT_PADS(obj)                   ((obj)->pads)
144
145 #define GST_ELEMENT_ERROR(el, domain, code, message, debug) G_STMT_START { \
146   gchar *__msg = _gst_element_error_printf message; \
147   gchar *__dbg = _gst_element_error_printf debug; \
148   GST_ERROR_OBJECT (el, "%s", __msg); \
149   GST_ERROR_OBJECT (el, "%s", __dbg); \
150   gst_element_error_full (GST_ELEMENT(el), \
151   GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code, \
152   __msg, __dbg, __FILE__, GST_FUNCTION, __LINE__); \
153 } G_STMT_END
154
155 typedef struct _GstElementFactory GstElementFactory;
156 typedef struct _GstElementFactoryClass GstElementFactoryClass;
157
158 typedef void (*GstElementLoopFunction) (GstElement * element);
159 typedef void (*GstElementPreRunFunction) (GstElement * element);
160 typedef void (*GstElementPostRunFunction) (GstElement * element);
161
162 struct _GstElement
163 {
164   GstObject object;
165
166   /* element state  and scheduling */
167   guint8 current_state;
168   guint8 pending_state;
169   GstElementLoopFunction loopfunc;
170
171   GstScheduler *sched;
172   gpointer sched_private;
173
174   /* allocated clock */
175   GstClock *clock;
176   GstClockTimeDiff base_time;   /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
177
178   /* element pads */
179   guint16 numpads;
180   guint16 numsrcpads;
181   guint16 numsinkpads;
182   GList *pads;
183
184   GMutex *state_mutex;
185   GCond *state_cond;
186
187   GstElementPreRunFunction pre_run_func;
188   GstElementPostRunFunction post_run_func;
189   GAsyncQueue *prop_value_queue;
190   GMutex *property_mutex;
191
192   gpointer _gst_reserved[GST_PADDING];
193 };
194
195 struct _GstElementClass
196 {
197   GstObjectClass parent_class;
198
199   /* the element details */
200   GstElementDetails details;
201
202   /* factory that the element was created from */
203   GstElementFactory *elementfactory;
204
205   /* templates for our pads */
206   GList *padtemplates;
207   gint numpadtemplates;
208
209   /* signal callbacks */
210   void (*state_change) (GstElement * element, GstElementState old,
211       GstElementState state);
212   void (*new_pad) (GstElement * element, GstPad * pad);
213   void (*pad_removed) (GstElement * element, GstPad * pad);
214   void (*error) (GstElement * element, GstElement * source, GError * error,
215       gchar * debug);
216   void (*eos) (GstElement * element);
217   void (*found_tag) (GstElement * element, GstElement * source,
218       const GstTagList * tag_list);
219
220   /* local pointers for get/set */
221   void (*set_property) (GObject * object, guint prop_id, const GValue * value,
222       GParamSpec * pspec);
223   void (*get_property) (GObject * object, guint prop_id, GValue * value,
224       GParamSpec * pspec);
225
226   /* vtable */
227     gboolean (*release_locks) (GstElement * element);
228
229   /* query/convert/events functions */
230   const GstEventMask *(*get_event_masks) (GstElement * element);
231     gboolean (*send_event) (GstElement * element, GstEvent * event);
232   const GstFormat *(*get_formats) (GstElement * element);
233     gboolean (*convert) (GstElement * element,
234       GstFormat src_format, gint64 src_value,
235       GstFormat * dest_format, gint64 * dest_value);
236   const GstQueryType *(*get_query_types) (GstElement * element);
237     gboolean (*query) (GstElement * element, GstQueryType type,
238       GstFormat * format, gint64 * value);
239
240   /* change the element state */
241     GstElementStateReturn (*change_state) (GstElement * element);
242
243   /* request/release pads */
244   GstPad *(*request_new_pad) (GstElement * element, GstPadTemplate * templ,
245       const gchar * name);
246   void (*release_pad) (GstElement * element, GstPad * pad);
247
248   /* set/get clocks */
249   GstClock *(*get_clock) (GstElement * element);
250   void (*set_clock) (GstElement * element, GstClock * clock);
251
252   /* index */
253   GstIndex *(*get_index) (GstElement * element);
254   void (*set_index) (GstElement * element, GstIndex * index);
255
256     GstElementStateReturn (*set_state) (GstElement * element,
257       GstElementState state);
258   gpointer _gst_reserved[GST_PADDING];
259 };
260
261 void gst_element_class_add_pad_template (GstElementClass * klass,
262     GstPadTemplate * templ);
263 void gst_element_class_install_std_props (GstElementClass * klass,
264     const gchar * first_name, ...);
265 void gst_element_class_set_details (GstElementClass * klass,
266     const GstElementDetails * details);
267
268 #define                 gst_element_default_deep_notify         gst_object_default_deep_notify
269
270 void gst_element_default_error (GObject * object, GstObject * orig,
271     GError * error, gchar * debug);
272
273 GType gst_element_get_type (void);
274 void gst_element_set_loop_function (GstElement * element,
275     GstElementLoopFunction loop);
276
277 #define                 gst_element_get_name(elem)      gst_object_get_name(GST_OBJECT(elem))
278 #define                 gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT(elem),name)
279 #define                 gst_element_get_parent(elem)    gst_object_get_parent(GST_OBJECT(elem))
280 #define                 gst_element_set_parent(elem,parent)     gst_object_set_parent(GST_OBJECT(elem),parent)
281
282 /* threadsafe versions of their g_object_* counterparts */
283 void gst_element_set (GstElement * element, const gchar * first_property_name,
284     ...);
285 void gst_element_get (GstElement * element, const gchar * first_property_name,
286     ...);
287 void gst_element_set_valist (GstElement * element,
288     const gchar * first_property_name, va_list var_args);
289 void gst_element_get_valist (GstElement * element,
290     const gchar * first_property_name, va_list var_args);
291 void gst_element_set_property (GstElement * element,
292     const gchar * property_name, const GValue * value);
293 void gst_element_get_property (GstElement * element,
294     const gchar * property_name, GValue * value);
295
296 void gst_element_enable_threadsafe_properties (GstElement * element);
297 void gst_element_disable_threadsafe_properties (GstElement * element);
298 void gst_element_set_pending_properties (GstElement * element);
299
300 /* clocking */
301 gboolean gst_element_requires_clock (GstElement * element);
302 gboolean gst_element_provides_clock (GstElement * element);
303 GstClock *gst_element_get_clock (GstElement * element);
304 void gst_element_set_clock (GstElement * element, GstClock * clock);
305 GstClockReturn gst_element_clock_wait (GstElement * element,
306     GstClockID id, GstClockTimeDiff * jitter);
307 GstClockTime gst_element_get_time (GstElement * element);
308 gboolean gst_element_wait (GstElement * element, GstClockTime timestamp);
309 void gst_element_set_time (GstElement * element, GstClockTime time);
310 void gst_element_adjust_time (GstElement * element, GstClockTimeDiff diff);
311
312 /* indexs */
313 gboolean gst_element_is_indexable (GstElement * element);
314 void gst_element_set_index (GstElement * element, GstIndex * index);
315 GstIndex *gst_element_get_index (GstElement * element);
316
317
318 gboolean gst_element_release_locks (GstElement * element);
319
320 void gst_element_yield (GstElement * element);
321 gboolean gst_element_interrupt (GstElement * element);
322 void gst_element_set_scheduler (GstElement * element, GstScheduler * sched);
323 GstScheduler *gst_element_get_scheduler (GstElement * element);
324
325 void gst_element_add_pad (GstElement * element, GstPad * pad);
326 void gst_element_remove_pad (GstElement * element, GstPad * pad);
327 GstPad *gst_element_add_ghost_pad (GstElement * element, GstPad * pad,
328     const gchar * name);
329 void gst_element_remove_ghost_pad (GstElement * element, GstPad * pad);
330
331 GstPad *gst_element_get_pad (GstElement * element, const gchar * name);
332 GstPad *gst_element_get_static_pad (GstElement * element, const gchar * name);
333 GstPad *gst_element_get_request_pad (GstElement * element, const gchar * name);
334 void gst_element_release_request_pad (GstElement * element, GstPad * pad);
335
336 G_CONST_RETURN GList *gst_element_get_pad_list (GstElement * element);
337 GstPad *gst_element_get_compatible_pad (GstElement * element, GstPad * pad);
338 GstPad *gst_element_get_compatible_pad_filtered (GstElement * element,
339     GstPad * pad, const GstCaps * filtercaps);
340
341 GstPadTemplate *gst_element_class_get_pad_template (GstElementClass *
342     element_class, const gchar * name);
343 GList *gst_element_class_get_pad_template_list (GstElementClass *
344     element_class);
345 GstPadTemplate *gst_element_get_pad_template (GstElement * element,
346     const gchar * name);
347 GList *gst_element_get_pad_template_list (GstElement * element);
348 GstPadTemplate *gst_element_get_compatible_pad_template (GstElement * element,
349     GstPadTemplate * compattempl);
350
351 gboolean gst_element_link (GstElement * src, GstElement * dest);
352 gboolean gst_element_link_many (GstElement * element_1,
353     GstElement * element_2, ...);
354 gboolean gst_element_link_filtered (GstElement * src, GstElement * dest,
355     const GstCaps * filtercaps);
356 void gst_element_unlink (GstElement * src, GstElement * dest);
357 void gst_element_unlink_many (GstElement * element_1,
358     GstElement * element_2, ...);
359
360 gboolean gst_element_link_pads (GstElement * src, const gchar * srcpadname,
361     GstElement * dest, const gchar * destpadname);
362 gboolean gst_element_link_pads_filtered (GstElement * src,
363     const gchar * srcpadname, GstElement * dest, const gchar * destpadname,
364     const GstCaps * filtercaps);
365 void gst_element_unlink_pads (GstElement * src, const gchar * srcpadname,
366     GstElement * dest, const gchar * destpadname);
367
368 G_CONST_RETURN GstEventMask *gst_element_get_event_masks (GstElement * element);
369 gboolean gst_element_send_event (GstElement * element, GstEvent * event);
370 gboolean gst_element_seek (GstElement * element, GstSeekType seek_type,
371     guint64 offset);
372 G_CONST_RETURN GstQueryType *gst_element_get_query_types (GstElement * element);
373 gboolean gst_element_query (GstElement * element, GstQueryType type,
374     GstFormat * format, gint64 * value);
375 G_CONST_RETURN GstFormat *gst_element_get_formats (GstElement * element);
376 gboolean gst_element_convert (GstElement * element,
377     GstFormat src_format, gint64 src_value,
378     GstFormat * dest_format, gint64 * dest_value);
379
380 void gst_element_found_tags (GstElement * element, const GstTagList * tag_list);
381 void gst_element_found_tags_for_pad (GstElement * element, GstPad * pad,
382     GstClockTime timestamp, GstTagList * list);
383
384 void gst_element_set_eos (GstElement * element);
385
386 gchar *_gst_element_error_printf (const gchar * format, ...);
387 void gst_element_error_full (GstElement * element, GQuark domain, gint code,
388     gchar * message, gchar * debug,
389     const gchar * file, const gchar * function, gint line);
390
391 gboolean gst_element_is_locked_state (GstElement * element);
392 void gst_element_set_locked_state (GstElement * element, gboolean locked_state);
393 gboolean gst_element_sync_state_with_parent (GstElement * element);
394
395 GstElementState gst_element_get_state (GstElement * element);
396 GstElementStateReturn gst_element_set_state (GstElement * element,
397     GstElementState state);
398
399 void gst_element_wait_state_change (GstElement * element);
400
401 G_CONST_RETURN gchar *gst_element_state_get_name (GstElementState state);
402
403 GstElementFactory *gst_element_get_factory (GstElement * element);
404
405 GstBin *gst_element_get_managing_bin (GstElement * element);
406
407
408 /*
409  *
410  * factories stuff
411  *
412  **/
413
414 #define GST_TYPE_ELEMENT_FACTORY                (gst_element_factory_get_type())
415 #define GST_ELEMENT_FACTORY(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
416                                                  GstElementFactory))
417 #define GST_ELEMENT_FACTORY_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
418                                                  GstElementFactoryClass))
419 #define GST_IS_ELEMENT_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
420 #define GST_IS_ELEMENT_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
421
422 struct _GstElementFactory
423 {
424   GstPluginFeature parent;
425
426   GType type;                   /* unique GType of element or 0 if not loaded */
427
428   GstElementDetails details;
429
430   GList *padtemplates;
431   guint numpadtemplates;
432
433   /* URI interface stuff */
434   guint uri_type;
435   gchar **uri_protocols;
436
437   GList *interfaces;            /* interfaces this element implements */
438
439   gpointer _gst_reserved[GST_PADDING];
440 };
441
442 struct _GstElementFactoryClass
443 {
444   GstPluginFeatureClass parent_class;
445
446   gpointer _gst_reserved[GST_PADDING];
447 };
448
449 GType gst_element_factory_get_type (void);
450
451 gboolean gst_element_register (GstPlugin * plugin,
452     const gchar * elementname, guint rank, GType type);
453
454 GstElementFactory *gst_element_factory_find (const gchar * name);
455 GType gst_element_factory_get_element_type (GstElementFactory * factory);
456 G_CONST_RETURN gchar *gst_element_factory_get_longname (GstElementFactory *
457     factory);
458 G_CONST_RETURN gchar *gst_element_factory_get_klass (GstElementFactory *
459     factory);
460 G_CONST_RETURN gchar *gst_element_factory_get_description (GstElementFactory *
461     factory);
462 G_CONST_RETURN gchar *gst_element_factory_get_author (GstElementFactory *
463     factory);
464 guint gst_element_factory_get_num_pad_templates (GstElementFactory * factory);
465 G_CONST_RETURN GList *gst_element_factory_get_pad_templates (GstElementFactory *
466     factory);
467 guint gst_element_factory_get_uri_type (GstElementFactory * factory);
468 gchar **gst_element_factory_get_uri_protocols (GstElementFactory * factory);
469
470 GstElement *gst_element_factory_create (GstElementFactory * factory,
471     const gchar * name);
472 GstElement *gst_element_factory_make (const gchar * factoryname,
473     const gchar * name);
474
475 gboolean gst_element_factory_can_src_caps (GstElementFactory * factory,
476     const GstCaps * caps);
477 gboolean gst_element_factory_can_sink_caps (GstElementFactory * factory,
478     const GstCaps * caps);
479
480 void __gst_element_factory_add_pad_template (GstElementFactory * elementfactory,
481     GstPadTemplate * templ);
482 void __gst_element_factory_add_interface (GstElementFactory * elementfactory,
483     const gchar * interfacename);
484
485
486 G_END_DECLS
487 #endif /* __GST_ELEMENT_H__ */