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