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