]> Gitweb @ Texas Instruments - Open Source Git Repositories - git.TI.com/gitweb - glsdk/gstreamer0-10.git/blob - gst/gstelement.h
docs/gst/Makefile.am: Disable a bunch of headers from being scanned
[glsdk/gstreamer0-10.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  */
24 #ifndef __GST_ELEMENT_H__
25 #define __GST_ELEMENT_H__
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>
37 G_BEGIN_DECLS
39 typedef struct _GstElementDetails GstElementDetails;
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? */
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))
56 #define GST_NUM_STATES 4
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)
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)
73 extern GType _gst_element_type;
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))
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
101 typedef enum {
102   /* element is complex (for some def.) and generally require a cothread */
103   GST_ELEMENT_COMPLEX           = GST_OBJECT_FLAG_LAST,
104   /* input and output pads aren't directly coupled to each other
105      examples: queues, multi-output async readers, etc. */
106   GST_ELEMENT_DECOUPLED,
107   /* this element should be placed in a thread if at all possible */
108   GST_ELEMENT_THREAD_SUGGESTED,
109   /* this element, for some reason, has a loop function that performs
110    * an infinite loop without calls to gst_element_yield () */
111   GST_ELEMENT_INFINITE_LOOP,
112   /* there is a new loopfunction ready for placement */
113   GST_ELEMENT_NEW_LOOPFUNC,
114   /* if this element can handle events */
115   GST_ELEMENT_EVENT_AWARE,
116   /* use threadsafe property get/set implementation */
117   GST_ELEMENT_USE_THREADSAFE_PROPERTIES,
119   /* private flags that can be used by the scheduler */
120   GST_ELEMENT_SCHEDULER_PRIVATE1,
121   GST_ELEMENT_SCHEDULER_PRIVATE2,
123   /* ignore state changes from parent */
124   GST_ELEMENT_LOCKED_STATE,
126   /* element is in error */
127   GST_ELEMENT_IN_ERROR,
129   /* use some padding for future expansion */
130   GST_ELEMENT_FLAG_LAST         = GST_OBJECT_FLAG_LAST + 16
131 } GstElementFlags;
133 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)    (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
134 #define GST_ELEMENT_IS_EVENT_AWARE(obj)         (GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
135 #define GST_ELEMENT_IS_DECOUPLED(obj)           (GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
137 #define GST_ELEMENT_NAME(obj)                   (GST_OBJECT_NAME(obj))
138 #define GST_ELEMENT_PARENT(obj)                 (GST_OBJECT_PARENT(obj))
139 #define GST_ELEMENT_MANAGER(obj)                (((GstElement*)(obj))->manager)
140 #define GST_ELEMENT_SCHED(obj)                  (((GstElement*)(obj))->sched)
141 #define GST_ELEMENT_CLOCK(obj)                  (((GstElement*)(obj))->clock)
142 #define GST_ELEMENT_PADS(obj)                   ((obj)->pads)
144 #define GST_ELEMENT_ERROR(el, domain, code, message, debug) G_STMT_START { \
145   gchar *__msg = _gst_element_error_printf message; \
146   gchar *__dbg = _gst_element_error_printf debug; \
147   GST_ERROR_OBJECT (el, "%s", __msg); \
148   GST_ERROR_OBJECT (el, "%s", __dbg); \
149   gst_element_error_full (GST_ELEMENT(el), \
150   GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code, \
151   __msg, __dbg, __FILE__, GST_FUNCTION, __LINE__); \
152 } G_STMT_END
154 typedef struct _GstElementFactory GstElementFactory;
155 typedef struct _GstElementFactoryClass GstElementFactoryClass;
157 typedef void            (*GstElementLoopFunction)       (GstElement *element);
158 typedef void            (*GstElementPreRunFunction)     (GstElement *element);
159 typedef void            (*GstElementPostRunFunction)    (GstElement *element);
161 struct _GstElement {
162   GstObject             object;
164   /* element state  and scheduling */
165   guint8                current_state;
166   guint8                pending_state;
167   GstElementLoopFunction loopfunc;
169   GstScheduler          *sched;
170   gpointer              sched_private;
172   /* allocated clock */
173   GstClock              *clock;
174   GstClockTimeDiff      base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
176   /* element pads */
177   guint16               numpads;
178   guint16               numsrcpads;
179   guint16               numsinkpads;
180   GList                 *pads;
182   GMutex                *state_mutex;
183   GCond                 *state_cond;
185   GstElementPreRunFunction  pre_run_func;
186   GstElementPostRunFunction post_run_func;
187   GAsyncQueue           *prop_value_queue;
188   GMutex                *property_mutex;
190   gpointer _gst_reserved[GST_PADDING];
191 };
193 struct _GstElementClass {
194   GstObjectClass        parent_class;
196   /* the element details */
197   GstElementDetails     details;
199   /* factory that the element was created from */
200   GstElementFactory     *elementfactory;
202   /* templates for our pads */
203   GList                 *padtemplates;
204   gint                  numpadtemplates;
205   
206   /* signal callbacks */
207   void (*state_change)  (GstElement *element, GstElementState old, GstElementState state);
208   void (*new_pad)       (GstElement *element, GstPad *pad);
209   void (*pad_removed)   (GstElement *element, GstPad *pad);
210   void (*error)         (GstElement *element, GstElement *source, GError *error, gchar *debug);
211   void (*eos)           (GstElement *element);
212   void (*found_tag)     (GstElement *element, GstElement *source, const GstTagList *tag_list);
214   /* local pointers for get/set */
215   void (*set_property)  (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
216   void (*get_property)  (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
218   /* vtable*/
219   gboolean              (*release_locks)        (GstElement *element);
221   /* query/convert/events functions */
222   const GstEventMask*   (*get_event_masks)      (GstElement *element);
223   gboolean              (*send_event)           (GstElement *element, GstEvent *event);
224   const GstFormat*      (*get_formats)          (GstElement *element);
225   gboolean              (*convert)              (GstElement *element,
226                                                  GstFormat  src_format,  gint64  src_value,
227                                                  GstFormat *dest_format, gint64 *dest_value);
228   const GstQueryType*   (*get_query_types)      (GstElement *element);
229   gboolean              (*query)                (GstElement *element, GstQueryType type,
230                                                  GstFormat *format, gint64 *value);
232   /* change the element state */
233   GstElementStateReturn (*change_state)         (GstElement *element);
235   /* request/release pads */
236   GstPad*               (*request_new_pad)      (GstElement *element, GstPadTemplate *templ, const gchar* name);
237   void                  (*release_pad)          (GstElement *element, GstPad *pad);
239   /* set/get clocks */
240   GstClock*             (*get_clock)            (GstElement *element);
241   void                  (*set_clock)            (GstElement *element, GstClock *clock);
243   /* index */
244   GstIndex*             (*get_index)            (GstElement *element);
245   void                  (*set_index)            (GstElement *element, GstIndex *index);
247   GstElementStateReturn (*set_state)            (GstElement *element, GstElementState state);
248   gpointer _gst_reserved[GST_PADDING];
249 };
251 void                    gst_element_class_add_pad_template      (GstElementClass *klass, GstPadTemplate *templ);
252 void                    gst_element_class_install_std_props     (GstElementClass *klass,
253                                                                  const gchar      *first_name, ...);
254 void                    gst_element_class_set_details           (GstElementClass *klass,
255                                                                  const GstElementDetails *details);
257 #define                 gst_element_default_deep_notify         gst_object_default_deep_notify
259 void                    gst_element_default_error               (GObject *object, GstObject *orig, GError *error, gchar *debug);
261 GType                   gst_element_get_type            (void);
262 void                    gst_element_set_loop_function   (GstElement *element,
263                                                          GstElementLoopFunction loop);
265 #define                 gst_element_get_name(elem)      gst_object_get_name(GST_OBJECT(elem))
266 #define                 gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT(elem),name)
267 #define                 gst_element_get_parent(elem)    gst_object_get_parent(GST_OBJECT(elem))
268 #define                 gst_element_set_parent(elem,parent)     gst_object_set_parent(GST_OBJECT(elem),parent)
270 /* threadsafe versions of their g_object_* counterparts */
271 void                    gst_element_set                 (GstElement *element, const gchar *first_property_name, ...);
272 void                    gst_element_get                 (GstElement *element, const gchar *first_property_name, ...);
273 void                    gst_element_set_valist          (GstElement *element, const gchar *first_property_name,
274                                                          va_list var_args);
275 void                    gst_element_get_valist          (GstElement *element, const gchar *first_property_name,
276                                                          va_list var_args);
277 void                    gst_element_set_property        (GstElement *element, const gchar *property_name,
278                                                          const GValue   *value);
279 void                    gst_element_get_property        (GstElement *element, const gchar *property_name,
280                                                          GValue *value);
282 void                    gst_element_enable_threadsafe_properties        (GstElement *element);
283 void                    gst_element_disable_threadsafe_properties       (GstElement *element);
284 void                    gst_element_set_pending_properties              (GstElement *element);
286 /* clocking */
287 gboolean                gst_element_requires_clock      (GstElement *element);
288 gboolean                gst_element_provides_clock      (GstElement *element);
289 GstClock*               gst_element_get_clock           (GstElement *element);
290 void                    gst_element_set_clock           (GstElement *element, GstClock *clock);
291 GstClockReturn          gst_element_clock_wait          (GstElement *element, 
292                                                          GstClockID id, GstClockTimeDiff *jitter);
293 GstClockTime            gst_element_get_time            (GstElement *element);
294 gboolean                gst_element_wait                (GstElement *element, GstClockTime timestamp);
295 void                    gst_element_set_time            (GstElement *element, GstClockTime time);
296 void                    gst_element_set_time_delay      (GstElement *element, GstClockTime time, GstClockTime delay);
298 void                    gst_element_adjust_time         (GstElement *element, GstClockTimeDiff diff);
299  
300 /* indexs */
301 gboolean                gst_element_is_indexable        (GstElement *element);
302 void                    gst_element_set_index           (GstElement *element, GstIndex *index);
303 GstIndex*               gst_element_get_index           (GstElement *element);
306 gboolean                gst_element_release_locks       (GstElement *element);
308 void                    gst_element_yield               (GstElement *element);
309 gboolean                gst_element_interrupt           (GstElement *element);
310 void                    gst_element_set_scheduler       (GstElement *element, GstScheduler *sched);
311 GstScheduler*           gst_element_get_scheduler       (GstElement *element);
313 void                    gst_element_add_pad             (GstElement *element, GstPad *pad);
314 void                    gst_element_remove_pad          (GstElement *element, GstPad *pad);
315 GstPad *                gst_element_add_ghost_pad       (GstElement *element, GstPad *pad, const gchar *name);
316 void                    gst_element_remove_ghost_pad    (GstElement *element, GstPad *pad);
318 GstPad*                 gst_element_get_pad             (GstElement *element, const gchar *name);
319 GstPad*                 gst_element_get_static_pad      (GstElement *element, const gchar *name);
320 GstPad*                 gst_element_get_request_pad     (GstElement *element, const gchar *name);
321 void                    gst_element_release_request_pad (GstElement *element, GstPad *pad);
323 G_CONST_RETURN GList*
324                         gst_element_get_pad_list        (GstElement *element);
325 GstPad*                 gst_element_get_compatible_pad  (GstElement *element, GstPad *pad);
326 GstPad*                 gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad, 
327                                                          const GstCaps *filtercaps);
329 GstPadTemplate*         gst_element_class_get_pad_template      (GstElementClass *element_class, const gchar *name);
330 GList*                  gst_element_class_get_pad_template_list (GstElementClass *element_class);
331 GstPadTemplate*         gst_element_get_pad_template            (GstElement *element, const gchar *name);
332 GList*                  gst_element_get_pad_template_list       (GstElement *element);
333 GstPadTemplate*         gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
335 gboolean                gst_element_link                (GstElement *src, GstElement *dest);
336 gboolean                gst_element_link_many           (GstElement *element_1, 
337                                                          GstElement *element_2, ...);
338 gboolean                gst_element_link_filtered       (GstElement *src, GstElement *dest,
339                                                          const GstCaps *filtercaps);
340 void                    gst_element_unlink              (GstElement *src, GstElement *dest);
341 void                    gst_element_unlink_many         (GstElement *element_1, 
342                                                          GstElement *element_2, ...);
344 gboolean                gst_element_link_pads           (GstElement *src, const gchar *srcpadname,
345                                                          GstElement *dest, const gchar *destpadname);
346 gboolean                gst_element_link_pads_filtered  (GstElement *src, const gchar *srcpadname,
347                                                          GstElement *dest, const gchar *destpadname,
348                                                          const GstCaps *filtercaps);
349 void                    gst_element_unlink_pads         (GstElement *src, const gchar *srcpadname,
350                                                          GstElement *dest, const gchar *destpadname);
352 G_CONST_RETURN GstEventMask*
353                         gst_element_get_event_masks     (GstElement *element);
354 gboolean                gst_element_send_event          (GstElement *element, GstEvent *event);
355 gboolean                gst_element_seek                (GstElement *element, GstSeekType seek_type,
356                                                          guint64 offset);
357 G_CONST_RETURN GstQueryType*
358                         gst_element_get_query_types     (GstElement *element);
359 gboolean                gst_element_query               (GstElement *element, GstQueryType type,
360                                                          GstFormat *format, gint64 *value);
361 G_CONST_RETURN GstFormat*
362                         gst_element_get_formats         (GstElement *element);
363 gboolean                gst_element_convert             (GstElement *element, 
364                                                          GstFormat  src_format,  gint64  src_value,
365                                                          GstFormat *dest_format, gint64 *dest_value);
367 void                    gst_element_found_tags          (GstElement *element, const GstTagList *tag_list);
368 void                    gst_element_found_tags_for_pad  (GstElement *element, GstPad *pad, GstClockTime timestamp, 
369                                                          GstTagList *list);
371 void                    gst_element_set_eos             (GstElement *element);
373 gchar *                 _gst_element_error_printf       (const gchar *format, ...);
374 void                    gst_element_error_full          (GstElement *element, GQuark domain, gint code, 
375                                                          gchar *message, gchar *debug, 
376                                                          const gchar *file, const gchar *function, gint line);
378 gboolean                gst_element_is_locked_state     (GstElement *element);
379 void                    gst_element_set_locked_state    (GstElement *element, gboolean locked_state);
380 gboolean                gst_element_sync_state_with_parent (GstElement *element);
382 GstElementState         gst_element_get_state           (GstElement *element);
383 GstElementStateReturn   gst_element_set_state           (GstElement *element, GstElementState state);
385 void                    gst_element_wait_state_change   (GstElement *element);
386         
387 G_CONST_RETURN gchar*   gst_element_state_get_name      (GstElementState state);
389 GstElementFactory*      gst_element_get_factory         (GstElement *element);
391 GstBin*                 gst_element_get_managing_bin    (GstElement *element);
394 /*
395  *
396  * factories stuff
397  *
398  **/
400 #define GST_TYPE_ELEMENT_FACTORY                (gst_element_factory_get_type())
401 #define GST_ELEMENT_FACTORY(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
402                                                  GstElementFactory))
403 #define GST_ELEMENT_FACTORY_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
404                                                  GstElementFactoryClass))
405 #define GST_IS_ELEMENT_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
406 #define GST_IS_ELEMENT_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
408 struct _GstElementFactory {
409   GstPluginFeature      parent;
411   GType                 type;                   /* unique GType of element or 0 if not loaded */
413   GstElementDetails     details;
415   GList *               padtemplates;
416   guint                 numpadtemplates;
418   /* URI interface stuff */
419   guint                 uri_type;
420   gchar **              uri_protocols;
421   
422   GList *               interfaces;             /* interfaces this element implements */
424   gpointer _gst_reserved[GST_PADDING];
425 };
427 struct _GstElementFactoryClass {
428   GstPluginFeatureClass parent_class;
430   gpointer _gst_reserved[GST_PADDING];
431 };
433 GType                   gst_element_factory_get_type            (void);
435 gboolean                gst_element_register                    (GstPlugin *plugin,
436                                                                  const gchar *name,
437                                                                  guint rank,
438                                                                  GType type);
440 GstElementFactory *     gst_element_factory_find                (const gchar *name);
441 GType                   gst_element_factory_get_element_type    (GstElementFactory *factory);
442 G_CONST_RETURN gchar *  gst_element_factory_get_longname        (GstElementFactory *factory);
443 G_CONST_RETURN gchar *  gst_element_factory_get_klass           (GstElementFactory *factory);
444 G_CONST_RETURN gchar *  gst_element_factory_get_description     (GstElementFactory *factory);
445 G_CONST_RETURN gchar *  gst_element_factory_get_author          (GstElementFactory *factory);
446 guint                   gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
447 G_CONST_RETURN GList *  gst_element_factory_get_pad_templates   (GstElementFactory *factory);
448 guint                   gst_element_factory_get_uri_type        (GstElementFactory *factory);           
449 gchar **                gst_element_factory_get_uri_protocols   (GstElementFactory *factory);           
451 GstElement*             gst_element_factory_create              (GstElementFactory *factory,
452                                                                  const gchar *name);
453 GstElement*             gst_element_factory_make                (const gchar *factoryname, const gchar *name);
455 gboolean                gst_element_factory_can_src_caps        (GstElementFactory *factory,
456                                                                  const GstCaps *caps);
457 gboolean                gst_element_factory_can_sink_caps       (GstElementFactory *factory,
458                                                                  const GstCaps *caps);
460 void                    __gst_element_factory_add_pad_template  (GstElementFactory *elementfactory,
461                                                                  GstPadTemplate *templ);
462 void                    __gst_element_factory_add_interface     (GstElementFactory *elementfactory,
463                                                                  const gchar *interfacename);
466 G_END_DECLS
469 #endif /* __GST_ELEMENT_H__ */