7caadb8959279a20eb939a7f1ccd0ca4463bfe42
[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
38
39 typedef struct _GstElementDetails GstElementDetails;
40
41 /* FIXME: need translatable stuff in here (how handle in registry)? */
42 struct _GstElementDetails {
43   gchar *longname;              /* long, english name */
44   gchar *klass;                 /* type of element, as hierarchy */
45   gchar *description;           /* insights of one form or another */
46   gchar *author;                /* who wrote this thing? */
47
48   gpointer _gst_reserved[GST_PADDING];
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 #ifdef G_HAVE_ISO_VARARGS
84 #define GST_ELEMENT_QUERY_TYPE_FUNCTION(functionname, ...) \
85         GST_QUERY_TYPE_FUNCTION (GstElement*, functionname, __VA_ARGS__);
86 #define GST_ELEMENT_FORMATS_FUNCTION(functionname, ...)    \
87         GST_FORMATS_FUNCTION (GstElement*, functionname, __VA_ARGS__);
88 #define GST_ELEMENT_EVENT_MASK_FUNCTION(functionname, ...) \
89         GST_EVENT_MASK_FUNCTION (GstElement*, functionname, __VA_ARGS__);
90 #elif defined(G_HAVE_GNUC_VARARGS)
91 #define GST_ELEMENT_QUERY_TYPE_FUNCTION(functionname, a...) \
92         GST_QUERY_TYPE_FUNCTION (GstElement*, functionname, a);
93 #define GST_ELEMENT_FORMATS_FUNCTION(functionname, a...)    \
94         GST_FORMATS_FUNCTION (GstElement*, functionname, a);
95 #define GST_ELEMENT_EVENT_MASK_FUNCTION(functionname, a...) \
96         GST_EVENT_MASK_FUNCTION (GstElement*, functionname, a);
97 #endif
98
99 typedef enum {
100   /* element is complex (for some def.) and generally require a cothread */
101   GST_ELEMENT_COMPLEX           = GST_OBJECT_FLAG_LAST,
102   /* input and output pads aren't directly coupled to each other
103      examples: queues, multi-output async readers, etc. */
104   GST_ELEMENT_DECOUPLED,
105   /* this element should be placed in a thread if at all possible */
106   GST_ELEMENT_THREAD_SUGGESTED,
107   /* this element, for some reason, has a loop function that performs
108    * an infinite loop without calls to gst_element_yield () */
109   GST_ELEMENT_INFINITE_LOOP,
110   /* there is a new loopfunction ready for placement */
111   GST_ELEMENT_NEW_LOOPFUNC,
112   /* if this element can handle events */
113   GST_ELEMENT_EVENT_AWARE,
114   /* use threadsafe property get/set implementation */
115   GST_ELEMENT_USE_THREADSAFE_PROPERTIES,
116
117   /* private flags that can be used by the scheduler */
118   GST_ELEMENT_SCHEDULER_PRIVATE1,
119   GST_ELEMENT_SCHEDULER_PRIVATE2,
120
121   /* ignore state changes from parent */
122   GST_ELEMENT_LOCKED_STATE,
123
124   /* element is in error */
125   GST_ELEMENT_ERROR,
126
127   /* use some padding for future expansion */
128   GST_ELEMENT_FLAG_LAST         = GST_OBJECT_FLAG_LAST + 16
129 } GstElementFlags;
130
131 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)    (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
132 #define GST_ELEMENT_IS_EVENT_AWARE(obj)         (GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
133 #define GST_ELEMENT_IS_DECOUPLED(obj)           (GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
134
135 #define GST_ELEMENT_NAME(obj)                   (GST_OBJECT_NAME(obj))
136 #define GST_ELEMENT_PARENT(obj)                 (GST_OBJECT_PARENT(obj))
137 #define GST_ELEMENT_MANAGER(obj)                (((GstElement*)(obj))->manager)
138 #define GST_ELEMENT_SCHED(obj)                  (((GstElement*)(obj))->sched)
139 #define GST_ELEMENT_CLOCK(obj)                  (((GstElement*)(obj))->clock)
140 #define GST_ELEMENT_PADS(obj)                   ((obj)->pads)
141
142 #define gst_element_error(el, domain, code, message, debug) G_STMT_START { \
143   gst_element_error_extended (GST_ELEMENT(el), \
144   GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code, \
145   _gst_element_error_printf message, \
146   _gst_element_error_printf debug, \
147   __FILE__, GST_FUNCTION, __LINE__); } G_STMT_END
148
149 typedef struct _GstElementFactory GstElementFactory;
150 typedef struct _GstElementFactoryClass GstElementFactoryClass;
151
152 typedef void            (*GstElementLoopFunction)       (GstElement *element);
153 typedef void            (*GstElementPreRunFunction)     (GstElement *element);
154 typedef void            (*GstElementPostRunFunction)    (GstElement *element);
155
156 struct _GstElement {
157   GstObject             object;
158
159   /* element state  and scheduling */
160   guint8                current_state;
161   guint8                pending_state;
162   GstElementLoopFunction loopfunc;
163
164   GstScheduler          *sched;
165   gpointer              sched_private;
166
167   /* allocated clock */
168   GstClock              *clock;
169   GstClockTimeDiff      base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
170
171   /* element pads */
172   guint16               numpads;
173   guint16               numsrcpads;
174   guint16               numsinkpads;
175   GList                 *pads;
176
177   GMutex                *state_mutex;
178   GCond                 *state_cond;
179
180   GstElementPreRunFunction  pre_run_func;
181   GstElementPostRunFunction post_run_func;
182   GAsyncQueue           *prop_value_queue;
183   GMutex                *property_mutex;
184
185   gpointer _gst_reserved[GST_PADDING];
186 };
187
188 struct _GstElementClass {
189   GstObjectClass        parent_class;
190
191   /* the element details */
192   GstElementDetails     details;
193
194   /* factory that the element was created from */
195   GstElementFactory     *elementfactory;
196
197   /* templates for our pads */
198   GList                 *padtemplates;
199   gint                  numpadtemplates;
200   
201   /* signal callbacks */
202   void (*state_change)  (GstElement *element, GstElementState old, GstElementState state);
203   void (*new_pad)       (GstElement *element, GstPad *pad);
204   void (*pad_removed)   (GstElement *element, GstPad *pad);
205   void (*error)         (GstElement *element, GstElement *source, GError *error, gchar *debug);
206   void (*eos)           (GstElement *element);
207   void (*found_tag)     (GstElement *element, GstElement *source, GstTagList *tag_list);
208
209   /* local pointers for get/set */
210   void (*set_property)  (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
211   void (*get_property)  (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
212
213   /* vtable*/
214   gboolean              (*release_locks)        (GstElement *element);
215
216   /* query/convert/events functions */
217   const GstEventMask*   (*get_event_masks)      (GstElement *element);
218   gboolean              (*send_event)           (GstElement *element, GstEvent *event);
219   const GstFormat*      (*get_formats)          (GstElement *element);
220   gboolean              (*convert)              (GstElement *element,
221                                                  GstFormat  src_format,  gint64  src_value,
222                                                  GstFormat *dest_format, gint64 *dest_value);
223   const GstQueryType*   (*get_query_types)      (GstElement *element);
224   gboolean              (*query)                (GstElement *element, GstQueryType type,
225                                                  GstFormat *format, gint64 *value);
226
227   /* change the element state */
228   GstElementStateReturn (*change_state)         (GstElement *element);
229
230   /* request/release pads */
231   GstPad*               (*request_new_pad)      (GstElement *element, GstPadTemplate *templ, const gchar* name);
232   void                  (*release_pad)          (GstElement *element, GstPad *pad);
233
234   /* set/get clocks */
235   GstClock*             (*get_clock)            (GstElement *element);
236   void                  (*set_clock)            (GstElement *element, GstClock *clock);
237
238   /* index */
239   GstIndex*             (*get_index)            (GstElement *element);
240   void                  (*set_index)            (GstElement *element, GstIndex *index);
241
242   GstElementStateReturn (*set_state)            (GstElement *element, GstElementState state);
243   gpointer _gst_reserved[GST_PADDING - 1];
244 };
245
246 void                    gst_element_class_add_pad_template      (GstElementClass *klass, GstPadTemplate *templ);
247 void                    gst_element_class_install_std_props     (GstElementClass *klass,
248                                                                  const gchar      *first_name, ...);
249 void                    gst_element_class_set_details           (GstElementClass *klass,
250                                                                  const GstElementDetails *details);
251
252 #define                 gst_element_default_deep_notify         gst_object_default_deep_notify
253
254 void                    gst_element_default_error               (GObject *object, GstObject *orig, GError *error, gchar *debug);
255
256 GType                   gst_element_get_type            (void);
257 void                    gst_element_set_loop_function   (GstElement *element,
258                                                          GstElementLoopFunction loop);
259
260 #define                 gst_element_get_name(elem)      gst_object_get_name(GST_OBJECT(elem))
261 #define                 gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT(elem),name)
262 #define                 gst_element_get_parent(elem)    gst_object_get_parent(GST_OBJECT(elem))
263 #define                 gst_element_set_parent(elem,parent)     gst_object_set_parent(GST_OBJECT(elem),parent)
264
265 /* threadsafe versions of their g_object_* counterparts */
266 void                    gst_element_set                 (GstElement *element, const gchar *first_property_name, ...);
267 void                    gst_element_get                 (GstElement *element, const gchar *first_property_name, ...);
268 void                    gst_element_set_valist          (GstElement *element, const gchar *first_property_name,
269                                                          va_list var_args);
270 void                    gst_element_get_valist          (GstElement *element, const gchar *first_property_name,
271                                                          va_list var_args);
272 void                    gst_element_set_property        (GstElement *element, const gchar *property_name,
273                                                          const GValue   *value);
274 void                    gst_element_get_property        (GstElement *element, const gchar *property_name,
275                                                          GValue *value);
276
277 void                    gst_element_enable_threadsafe_properties        (GstElement *element);
278 void                    gst_element_disable_threadsafe_properties       (GstElement *element);
279 void                    gst_element_set_pending_properties              (GstElement *element);
280
281 /* clocking */
282 gboolean                gst_element_requires_clock      (GstElement *element);
283 gboolean                gst_element_provides_clock      (GstElement *element);
284 GstClock*               gst_element_get_clock           (GstElement *element);
285 void                    gst_element_set_clock           (GstElement *element, GstClock *clock);
286 #ifndef GST_DEISABLE_DEPRECATED
287 GstClockReturn          gst_element_clock_wait          (GstElement *element, 
288                                                          GstClockID id, GstClockTimeDiff *jitter);
289 #endif
290 GstClockTime            gst_element_get_time            (GstElement *element);
291 gboolean                gst_element_wait                (GstElement *element, GstClockTime timestamp);
292 void                    gst_element_set_time            (GstElement *element, GstClockTime time);
293 void                    gst_element_adjust_time         (GstElement *element, GstClockTimeDiff diff);
294  
295 /* indexs */
296 gboolean                gst_element_is_indexable        (GstElement *element);
297 void                    gst_element_set_index           (GstElement *element, GstIndex *index);
298 GstIndex*               gst_element_get_index           (GstElement *element);
299
300
301 gboolean                gst_element_release_locks       (GstElement *element);
302
303 void                    gst_element_yield               (GstElement *element);
304 gboolean                gst_element_interrupt           (GstElement *element);
305 void                    gst_element_set_scheduler       (GstElement *element, GstScheduler *sched);
306 GstScheduler*           gst_element_get_scheduler       (GstElement *element);
307
308 void                    gst_element_add_pad             (GstElement *element, GstPad *pad);
309 void                    gst_element_remove_pad          (GstElement *element, GstPad *pad);
310 GstPad *                gst_element_add_ghost_pad       (GstElement *element, GstPad *pad, const gchar *name);
311 void                    gst_element_remove_ghost_pad    (GstElement *element, GstPad *pad);
312
313 GstPad*                 gst_element_get_pad             (GstElement *element, const gchar *name);
314 GstPad*                 gst_element_get_static_pad      (GstElement *element, const gchar *name);
315 GstPad*                 gst_element_get_request_pad     (GstElement *element, const gchar *name);
316 void                    gst_element_release_request_pad (GstElement *element, GstPad *pad);
317
318 G_CONST_RETURN GList*
319                         gst_element_get_pad_list        (GstElement *element);
320 GstPad*                 gst_element_get_compatible_pad  (GstElement *element, GstPad *pad);
321 GstPad*                 gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad, 
322                                                          const GstCaps *filtercaps);
323
324 GstPadTemplate*         gst_element_class_get_pad_template      (GstElementClass *element_class, const gchar *name);
325 GList*                  gst_element_class_get_pad_template_list (GstElementClass *element_class);
326 GstPadTemplate*         gst_element_get_pad_template            (GstElement *element, const gchar *name);
327 GList*                  gst_element_get_pad_template_list       (GstElement *element);
328 GstPadTemplate*         gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
329
330 gboolean                gst_element_link                (GstElement *src, GstElement *dest);
331 gboolean                gst_element_link_many           (GstElement *element_1, 
332                                                          GstElement *element_2, ...);
333 gboolean                gst_element_link_filtered       (GstElement *src, GstElement *dest,
334                                                          const GstCaps *filtercaps);
335 void                    gst_element_unlink              (GstElement *src, GstElement *dest);
336 void                    gst_element_unlink_many         (GstElement *element_1, 
337                                                          GstElement *element_2, ...);
338
339 gboolean                gst_element_link_pads           (GstElement *src, const gchar *srcpadname,
340                                                          GstElement *dest, const gchar *destpadname);
341 gboolean                gst_element_link_pads_filtered  (GstElement *src, const gchar *srcpadname,
342                                                          GstElement *dest, const gchar *destpadname,
343                                                          const GstCaps *filtercaps);
344 void                    gst_element_unlink_pads         (GstElement *src, const gchar *srcpadname,
345                                                          GstElement *dest, const gchar *destpadname);
346
347 G_CONST_RETURN GstEventMask*
348                         gst_element_get_event_masks     (GstElement *element);
349 gboolean                gst_element_send_event          (GstElement *element, GstEvent *event);
350 gboolean                gst_element_seek                (GstElement *element, GstSeekType seek_type,
351                                                          guint64 offset);
352 G_CONST_RETURN GstQueryType*
353                         gst_element_get_query_types     (GstElement *element);
354 gboolean                gst_element_query               (GstElement *element, GstQueryType type,
355                                                          GstFormat *format, gint64 *value);
356 G_CONST_RETURN GstFormat*
357                         gst_element_get_formats         (GstElement *element);
358 gboolean                gst_element_convert             (GstElement *element, 
359                                                          GstFormat  src_format,  gint64  src_value,
360                                                          GstFormat *dest_format, gint64 *dest_value);
361
362 void                    gst_element_found_tags          (GstElement *element, GstTagList *tag_list);
363 void                    gst_element_found_tags_for_pad  (GstElement *element, GstPad *pad, GstClockTime timestamp, 
364                                                          GstTagList *list);
365
366 void                    gst_element_set_eos             (GstElement *element);
367
368 gchar *                 gst_element_error_printf        (const gchar *format, ...);
369 void                    gst_element_error_extended      (GstElement *element, GQuark domain, gint code, gchar *message, gchar *debug, const gchar *file, const gchar *function, gint line);
370
371 gboolean                gst_element_is_locked_state     (GstElement *element);
372 void                    gst_element_set_locked_state    (GstElement *element, gboolean locked_state);
373 gboolean                gst_element_sync_state_with_parent (GstElement *element);
374
375 GstElementState         gst_element_get_state           (GstElement *element);
376 GstElementStateReturn   gst_element_set_state           (GstElement *element, GstElementState state);
377
378 void                    gst_element_wait_state_change   (GstElement *element);
379         
380 G_CONST_RETURN gchar*   gst_element_state_get_name      (GstElementState state);
381
382 GstElementFactory*      gst_element_get_factory         (GstElement *element);
383
384 GstBin*                 gst_element_get_managing_bin    (GstElement *element);
385
386
387 /*
388  *
389  * factories stuff
390  *
391  **/
392
393 #define GST_TYPE_ELEMENT_FACTORY                (gst_element_factory_get_type())
394 #define GST_ELEMENT_FACTORY(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
395                                                  GstElementFactory))
396 #define GST_ELEMENT_FACTORY_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
397                                                  GstElementFactoryClass))
398 #define GST_IS_ELEMENT_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
399 #define GST_IS_ELEMENT_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
400
401 struct _GstElementFactory {
402   GstPluginFeature      parent;
403
404   GType                 type;                   /* unique GType of element or 0 if not loaded */
405
406   GstElementDetails     details;
407
408   GList *               padtemplates;
409   guint                 numpadtemplates;
410
411   /* URI interface stuff */
412   guint                 uri_type;
413   gchar **              uri_protocols;
414   
415   GList *               interfaces;             /* interfaces this element implements */
416
417   gpointer _gst_reserved[GST_PADDING];
418 };
419
420 struct _GstElementFactoryClass {
421   GstPluginFeatureClass parent_class;
422
423   gpointer _gst_reserved[GST_PADDING];
424 };
425
426 GType                   gst_element_factory_get_type            (void);
427
428 gboolean                gst_element_register                    (GstPlugin *plugin,
429                                                                  const gchar *elementname,
430                                                                  guint rank,
431                                                                  GType type);
432
433 GstElementFactory *     gst_element_factory_find                (const gchar *name);
434 GType                   gst_element_factory_get_element_type    (GstElementFactory *factory);
435 G_CONST_RETURN gchar *  gst_element_factory_get_longname        (GstElementFactory *factory);
436 G_CONST_RETURN gchar *  gst_element_factory_get_klass           (GstElementFactory *factory);
437 G_CONST_RETURN gchar *  gst_element_factory_get_description     (GstElementFactory *factory);
438 G_CONST_RETURN gchar *  gst_element_factory_get_version         (GstElementFactory *factory);
439 G_CONST_RETURN gchar *  gst_element_factory_get_author          (GstElementFactory *factory);
440 guint                   gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
441 G_CONST_RETURN GList *  gst_element_factory_get_pad_templates   (GstElementFactory *factory);
442 guint                   gst_element_factory_get_uri_type        (GstElementFactory *factory);           
443 gchar **                gst_element_factory_get_uri_protocols   (GstElementFactory *factory);           
444
445 GstElement*             gst_element_factory_create              (GstElementFactory *factory,
446                                                                  const gchar *name);
447 GstElement*             gst_element_factory_make                (const gchar *factoryname, const gchar *name);
448
449 gboolean                gst_element_factory_can_src_caps        (GstElementFactory *factory,
450                                                                  const GstCaps *caps);
451 gboolean                gst_element_factory_can_sink_caps       (GstElementFactory *factory,
452                                                                  const GstCaps *caps);
453
454 void                    __gst_element_factory_add_pad_template  (GstElementFactory *elementfactory,
455                                                                  GstPadTemplate *templ);
456 void                    __gst_element_factory_add_interface     (GstElementFactory *elementfactory,
457                                                                  const gchar *interfacename);
458
459
460 G_END_DECLS
461
462
463 #endif /* __GST_ELEMENT_H__ */
464