2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
5 * gstelement.h: Header for GstElement
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.
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.
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.
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 typedef struct _GstElementDetails GstElementDetails;
39 /* FIXME: need translatable stuff in here (how handle in registry)? */
40 struct _GstElementDetails
42 gchar *longname; /* long, english name */
43 gchar *klass; /* type of element, as hierarchy */
44 gchar *description; /* insights of one form or another */
45 gchar *author; /* who wrote this thing? */
47 gpointer _gst_reserved[GST_PADDING];
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.
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);
103 /* element is complex (for some def.) and generally require a cothread */
104 GST_ELEMENT_COMPLEX = GST_OBJECT_FLAG_LAST,
105 /* input and output pads aren't directly coupled to each other
106 examples: queues, multi-output async readers, etc. */
107 GST_ELEMENT_DECOUPLED,
108 /* this element should be placed in a thread if at all possible */
109 GST_ELEMENT_THREAD_SUGGESTED,
110 /* this element, for some reason, has a loop function that performs
111 * an infinite loop without calls to gst_element_yield () */
112 GST_ELEMENT_INFINITE_LOOP,
113 /* there is a new loopfunction ready for placement */
114 GST_ELEMENT_NEW_LOOPFUNC,
115 /* if this element can handle events */
116 GST_ELEMENT_EVENT_AWARE,
117 /* use threadsafe property get/set implementation */
118 GST_ELEMENT_USE_THREADSAFE_PROPERTIES,
120 /* private flags that can be used by the scheduler */
121 GST_ELEMENT_SCHEDULER_PRIVATE1,
122 GST_ELEMENT_SCHEDULER_PRIVATE2,
124 /* ignore state changes from parent */
125 GST_ELEMENT_LOCKED_STATE,
127 /* element is in error */
128 GST_ELEMENT_IN_ERROR,
130 /* use some padding for future expansion */
131 GST_ELEMENT_FLAG_LAST = GST_OBJECT_FLAG_LAST + 16
135 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
136 #define GST_ELEMENT_IS_EVENT_AWARE(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
137 #define GST_ELEMENT_IS_DECOUPLED(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
139 #define GST_ELEMENT_NAME(obj) (GST_OBJECT_NAME(obj))
140 #define GST_ELEMENT_PARENT(obj) (GST_OBJECT_PARENT(obj))
141 #define GST_ELEMENT_MANAGER(obj) (((GstElement*)(obj))->manager)
142 #define GST_ELEMENT_SCHED(obj) (((GstElement*)(obj))->sched)
143 #define GST_ELEMENT_CLOCK(obj) (((GstElement*)(obj))->clock)
144 #define GST_ELEMENT_PADS(obj) ((obj)->pads)
146 #define GST_ELEMENT_ERROR(el, domain, code, message, debug) G_STMT_START { \
147 gchar *__msg = _gst_element_error_printf message; \
148 gchar *__dbg = _gst_element_error_printf debug; \
149 GST_ERROR_OBJECT (el, "%s", __msg); \
150 GST_ERROR_OBJECT (el, "%s", __dbg); \
151 gst_element_error_full (GST_ELEMENT(el), \
152 GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code, \
153 __msg, __dbg, __FILE__, GST_FUNCTION, __LINE__); \
156 typedef struct _GstElementFactory GstElementFactory;
157 typedef struct _GstElementFactoryClass GstElementFactoryClass;
159 typedef void (*GstElementLoopFunction) (GstElement * element);
160 typedef void (*GstElementPreRunFunction) (GstElement * element);
161 typedef void (*GstElementPostRunFunction) (GstElement * element);
167 /* element state and scheduling */
168 guint8 current_state;
169 guint8 pending_state;
170 GstElementLoopFunction loopfunc;
173 gpointer sched_private;
175 /* allocated clock */
177 GstClockTimeDiff base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
188 GstElementPreRunFunction pre_run_func;
189 GstElementPostRunFunction post_run_func;
190 GAsyncQueue *prop_value_queue;
191 GMutex *property_mutex;
193 gpointer _gst_reserved[GST_PADDING];
196 struct _GstElementClass
198 GstObjectClass parent_class;
200 /* the element details */
201 GstElementDetails details;
203 /* factory that the element was created from */
204 GstElementFactory *elementfactory;
206 /* templates for our pads */
208 gint numpadtemplates;
210 /* signal callbacks */
211 void (*state_change) (GstElement * element, GstElementState old,
212 GstElementState state);
213 void (*new_pad) (GstElement * element, GstPad * pad);
214 void (*pad_removed) (GstElement * element, GstPad * pad);
215 void (*error) (GstElement * element, GstElement * source, GError * error,
217 void (*eos) (GstElement * element);
218 void (*found_tag) (GstElement * element, GstElement * source,
219 const GstTagList * tag_list);
221 /* local pointers for get/set */
222 void (*set_property) (GObject * object, guint prop_id, const GValue * value,
224 void (*get_property) (GObject * object, guint prop_id, GValue * value,
228 gboolean (*release_locks) (GstElement * element);
230 /* query/convert/events functions */
231 const GstEventMask *(*get_event_masks) (GstElement * element);
232 gboolean (*send_event) (GstElement * element, GstEvent * event);
233 const GstFormat *(*get_formats) (GstElement * element);
234 gboolean (*convert) (GstElement * element,
235 GstFormat src_format, gint64 src_value,
236 GstFormat * dest_format, gint64 * dest_value);
237 const GstQueryType *(*get_query_types) (GstElement * element);
238 gboolean (*query) (GstElement * element, GstQueryType type,
239 GstFormat * format, gint64 * value);
241 /* change the element state */
242 GstElementStateReturn (*change_state) (GstElement * element);
244 /* request/release pads */
245 GstPad *(*request_new_pad) (GstElement * element, GstPadTemplate * templ,
247 void (*release_pad) (GstElement * element, GstPad * pad);
250 GstClock *(*get_clock) (GstElement * element);
251 void (*set_clock) (GstElement * element, GstClock * clock);
254 GstIndex *(*get_index) (GstElement * element);
255 void (*set_index) (GstElement * element, GstIndex * index);
257 GstElementStateReturn (*set_state) (GstElement * element,
258 GstElementState state);
259 gpointer _gst_reserved[GST_PADDING];
262 void gst_element_class_add_pad_template (GstElementClass * klass,
263 GstPadTemplate * templ);
264 void gst_element_class_install_std_props (GstElementClass * klass,
265 const gchar * first_name, ...);
266 void gst_element_class_set_details (GstElementClass * klass,
267 const GstElementDetails * details);
269 #define gst_element_default_deep_notify gst_object_default_deep_notify
271 void gst_element_default_error (GObject * object, GstObject * orig,
272 GError * error, gchar * debug);
274 GType gst_element_get_type (void);
275 void gst_element_set_loop_function (GstElement * element,
276 GstElementLoopFunction loop);
278 #define gst_element_get_name(elem) gst_object_get_name(GST_OBJECT(elem))
279 #define gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT(elem),name)
280 #define gst_element_get_parent(elem) gst_object_get_parent(GST_OBJECT(elem))
281 #define gst_element_set_parent(elem,parent) gst_object_set_parent(GST_OBJECT(elem),parent)
283 /* threadsafe versions of their g_object_* counterparts */
284 void gst_element_set (GstElement * element, const gchar * first_property_name,
286 void gst_element_get (GstElement * element, const gchar * first_property_name,
288 void gst_element_set_valist (GstElement * element,
289 const gchar * first_property_name, va_list var_args);
290 void gst_element_get_valist (GstElement * element,
291 const gchar * first_property_name, va_list var_args);
292 void gst_element_set_property (GstElement * element,
293 const gchar * property_name, const GValue * value);
294 void gst_element_get_property (GstElement * element,
295 const gchar * property_name, GValue * value);
297 void gst_element_enable_threadsafe_properties (GstElement * element);
298 void gst_element_disable_threadsafe_properties (GstElement * element);
299 void gst_element_set_pending_properties (GstElement * element);
302 gboolean gst_element_requires_clock (GstElement * element);
303 gboolean gst_element_provides_clock (GstElement * element);
304 GstClock *gst_element_get_clock (GstElement * element);
305 void gst_element_set_clock (GstElement * element, GstClock * clock);
306 GstClockReturn gst_element_clock_wait (GstElement * element,
307 GstClockID id, GstClockTimeDiff * jitter);
308 GstClockTime gst_element_get_time (GstElement * element);
309 gboolean gst_element_wait (GstElement * element, GstClockTime timestamp);
310 void gst_element_set_time (GstElement * element, GstClockTime time);
311 void gst_element_adjust_time (GstElement * element, GstClockTimeDiff diff);
314 gboolean gst_element_is_indexable (GstElement * element);
315 void gst_element_set_index (GstElement * element, GstIndex * index);
316 GstIndex *gst_element_get_index (GstElement * element);
319 gboolean gst_element_release_locks (GstElement * element);
321 void gst_element_yield (GstElement * element);
322 gboolean gst_element_interrupt (GstElement * element);
323 void gst_element_set_scheduler (GstElement * element, GstScheduler * sched);
324 GstScheduler *gst_element_get_scheduler (GstElement * element);
326 void gst_element_add_pad (GstElement * element, GstPad * pad);
327 void gst_element_remove_pad (GstElement * element, GstPad * pad);
328 GstPad *gst_element_add_ghost_pad (GstElement * element, GstPad * pad,
330 void gst_element_remove_ghost_pad (GstElement * element, GstPad * pad);
332 GstPad *gst_element_get_pad (GstElement * element, const gchar * name);
333 GstPad *gst_element_get_static_pad (GstElement * element, const gchar * name);
334 GstPad *gst_element_get_request_pad (GstElement * element, const gchar * name);
335 void gst_element_release_request_pad (GstElement * element, GstPad * pad);
337 G_CONST_RETURN GList *gst_element_get_pad_list (GstElement * element);
338 GstPad *gst_element_get_compatible_pad (GstElement * element, GstPad * pad);
339 GstPad *gst_element_get_compatible_pad_filtered (GstElement * element,
340 GstPad * pad, const GstCaps * filtercaps);
342 GstPadTemplate *gst_element_class_get_pad_template (GstElementClass *
343 element_class, const gchar * name);
344 GList *gst_element_class_get_pad_template_list (GstElementClass *
346 GstPadTemplate *gst_element_get_pad_template (GstElement * element,
348 GList *gst_element_get_pad_template_list (GstElement * element);
349 GstPadTemplate *gst_element_get_compatible_pad_template (GstElement * element,
350 GstPadTemplate * compattempl);
352 gboolean gst_element_link (GstElement * src, GstElement * dest);
353 gboolean gst_element_link_many (GstElement * element_1,
354 GstElement * element_2, ...);
355 gboolean gst_element_link_filtered (GstElement * src, GstElement * dest,
356 const GstCaps * filtercaps);
357 void gst_element_unlink (GstElement * src, GstElement * dest);
358 void gst_element_unlink_many (GstElement * element_1,
359 GstElement * element_2, ...);
361 gboolean gst_element_link_pads (GstElement * src, const gchar * srcpadname,
362 GstElement * dest, const gchar * destpadname);
363 gboolean gst_element_link_pads_filtered (GstElement * src,
364 const gchar * srcpadname, GstElement * dest, const gchar * destpadname,
365 const GstCaps * filtercaps);
366 void gst_element_unlink_pads (GstElement * src, const gchar * srcpadname,
367 GstElement * dest, const gchar * destpadname);
369 G_CONST_RETURN GstEventMask *gst_element_get_event_masks (GstElement * element);
370 gboolean gst_element_send_event (GstElement * element, GstEvent * event);
371 gboolean gst_element_seek (GstElement * element, GstSeekType seek_type,
373 G_CONST_RETURN GstQueryType *gst_element_get_query_types (GstElement * element);
374 gboolean gst_element_query (GstElement * element, GstQueryType type,
375 GstFormat * format, gint64 * value);
376 G_CONST_RETURN GstFormat *gst_element_get_formats (GstElement * element);
377 gboolean gst_element_convert (GstElement * element,
378 GstFormat src_format, gint64 src_value,
379 GstFormat * dest_format, gint64 * dest_value);
381 void gst_element_found_tags (GstElement * element, const GstTagList * tag_list);
382 void gst_element_found_tags_for_pad (GstElement * element, GstPad * pad,
383 GstClockTime timestamp, GstTagList * list);
385 void gst_element_set_eos (GstElement * element);
387 gchar *_gst_element_error_printf (const gchar * format, ...);
388 void gst_element_error_full (GstElement * element, GQuark domain, gint code,
389 gchar * message, gchar * debug,
390 const gchar * file, const gchar * function, gint line);
392 gboolean gst_element_is_locked_state (GstElement * element);
393 void gst_element_set_locked_state (GstElement * element, gboolean locked_state);
394 gboolean gst_element_sync_state_with_parent (GstElement * element);
396 GstElementState gst_element_get_state (GstElement * element);
397 GstElementStateReturn gst_element_set_state (GstElement * element,
398 GstElementState state);
400 void gst_element_wait_state_change (GstElement * element);
402 G_CONST_RETURN gchar *gst_element_state_get_name (GstElementState state);
404 GstElementFactory *gst_element_get_factory (GstElement * element);
406 GstBin *gst_element_get_managing_bin (GstElement * element);
415 #define GST_TYPE_ELEMENT_FACTORY (gst_element_factory_get_type())
416 #define GST_ELEMENT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
418 #define GST_ELEMENT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
419 GstElementFactoryClass))
420 #define GST_IS_ELEMENT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
421 #define GST_IS_ELEMENT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
423 struct _GstElementFactory
425 GstPluginFeature parent;
427 GType type; /* unique GType of element or 0 if not loaded */
429 GstElementDetails details;
432 guint numpadtemplates;
434 /* URI interface stuff */
436 gchar **uri_protocols;
438 GList *interfaces; /* interfaces this element implements */
440 gpointer _gst_reserved[GST_PADDING];
443 struct _GstElementFactoryClass
445 GstPluginFeatureClass parent_class;
447 gpointer _gst_reserved[GST_PADDING];
450 GType gst_element_factory_get_type (void);
452 gboolean gst_element_register (GstPlugin * plugin,
453 const gchar * elementname, guint rank, GType type);
455 GstElementFactory *gst_element_factory_find (const gchar * name);
456 GType gst_element_factory_get_element_type (GstElementFactory * factory);
457 G_CONST_RETURN gchar *gst_element_factory_get_longname (GstElementFactory *
459 G_CONST_RETURN gchar *gst_element_factory_get_klass (GstElementFactory *
461 G_CONST_RETURN gchar *gst_element_factory_get_description (GstElementFactory *
463 G_CONST_RETURN gchar *gst_element_factory_get_author (GstElementFactory *
465 guint gst_element_factory_get_num_pad_templates (GstElementFactory * factory);
466 G_CONST_RETURN GList *gst_element_factory_get_pad_templates (GstElementFactory *
468 guint gst_element_factory_get_uri_type (GstElementFactory * factory);
469 gchar **gst_element_factory_get_uri_protocols (GstElementFactory * factory);
471 GstElement *gst_element_factory_create (GstElementFactory * factory,
473 GstElement *gst_element_factory_make (const gchar * factoryname,
476 gboolean gst_element_factory_can_src_caps (GstElementFactory * factory,
477 const GstCaps * caps);
478 gboolean gst_element_factory_can_sink_caps (GstElementFactory * factory,
479 const GstCaps * caps);
481 void __gst_element_factory_add_pad_template (GstElementFactory * elementfactory,
482 GstPadTemplate * templ);
483 void __gst_element_factory_add_interface (GstElementFactory * elementfactory,
484 const gchar * interfacename);
488 #endif /* __GST_ELEMENT_H__ */