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>
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];
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 GST_EXPORT 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);
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
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_SCHED(obj) (((GstElement*)(obj))->sched)
140 #define GST_ELEMENT_CLOCK(obj) (((GstElement*)(obj))->clock)
141 #define GST_ELEMENT_PADS(obj) ((obj)->pads)
145 * @el: the element that throws the error
146 * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #GstError)
147 * @code: error code defined for that domain (see #GstError)
148 * @message: the message to display (format string and args enclosed in round brackets)
149 * @debug: debugging information for the message (format string and args enclosed in round brackets)
151 * Utility function that elements can use in case they encountered a fatal
152 * data processing error. The pipeline will throw an error signal and the
153 * application will be requested to stop further media processing.
155 #define GST_ELEMENT_ERROR(el, domain, code, message, debug) G_STMT_START { \
156 gchar *__msg = _gst_element_error_printf message; \
157 gchar *__dbg = _gst_element_error_printf debug; \
159 GST_ERROR_OBJECT (el, "%s", __msg); \
161 GST_ERROR_OBJECT (el, "%s", __dbg); \
162 gst_element_error_full (GST_ELEMENT(el), \
163 GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code, \
164 __msg, __dbg, __FILE__, GST_FUNCTION, __LINE__); \
167 typedef struct _GstElementFactory GstElementFactory;
168 typedef struct _GstElementFactoryClass GstElementFactoryClass;
170 typedef void (*GstElementLoopFunction) (GstElement *element);
171 typedef void (*GstElementPreRunFunction) (GstElement *element);
172 typedef void (*GstElementPostRunFunction) (GstElement *element);
177 /* element state and scheduling */
178 guint8 current_state;
179 guint8 pending_state;
180 GstElementLoopFunction loopfunc;
183 gpointer sched_private;
185 /* allocated clock */
187 GstClockTimeDiff base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
198 GstElementPreRunFunction pre_run_func;
199 GstElementPostRunFunction post_run_func;
200 GAsyncQueue *prop_value_queue;
201 GMutex *property_mutex;
203 gpointer _gst_reserved[GST_PADDING];
206 struct _GstElementClass {
207 GstObjectClass parent_class;
209 /* the element details */
210 GstElementDetails details;
212 /* factory that the element was created from */
213 GstElementFactory *elementfactory;
215 /* templates for our pads */
217 gint numpadtemplates;
219 /* signal callbacks */
220 void (*state_change) (GstElement *element, GstElementState old, GstElementState state);
221 void (*new_pad) (GstElement *element, GstPad *pad);
222 void (*pad_removed) (GstElement *element, GstPad *pad);
223 void (*error) (GstElement *element, GstElement *source, GError *error, gchar *debug);
224 void (*eos) (GstElement *element);
225 void (*found_tag) (GstElement *element, GstElement *source, const GstTagList *tag_list);
227 /* local pointers for get/set */
228 void (*set_property) (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
229 void (*get_property) (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
232 gboolean (*release_locks) (GstElement *element);
234 /* query/convert/events functions */
235 const GstEventMask* (*get_event_masks) (GstElement *element);
236 gboolean (*send_event) (GstElement *element, GstEvent *event);
237 const GstFormat* (*get_formats) (GstElement *element);
238 gboolean (*convert) (GstElement *element,
239 GstFormat src_format, gint64 src_value,
240 GstFormat *dest_format, gint64 *dest_value);
241 const GstQueryType* (*get_query_types) (GstElement *element);
242 gboolean (*query) (GstElement *element, GstQueryType type,
243 GstFormat *format, gint64 *value);
245 /* change the element state */
246 GstElementStateReturn (*change_state) (GstElement *element);
248 /* request/release pads */
249 GstPad* (*request_new_pad) (GstElement *element, GstPadTemplate *templ, const gchar* name);
250 void (*release_pad) (GstElement *element, GstPad *pad);
253 GstClock* (*get_clock) (GstElement *element);
254 void (*set_clock) (GstElement *element, GstClock *clock);
257 GstIndex* (*get_index) (GstElement *element);
258 void (*set_index) (GstElement *element, GstIndex *index);
260 GstElementStateReturn (*set_state) (GstElement *element, GstElementState state);
262 /* FIXME 0.9: move up to signals */
263 void (*no_more_pads) (GstElement *element);
265 gpointer _gst_reserved[GST_PADDING - 1];
268 void gst_element_class_add_pad_template (GstElementClass *klass, GstPadTemplate *templ);
269 void gst_element_class_install_std_props (GstElementClass *klass,
270 const gchar *first_name, ...);
271 void gst_element_class_set_details (GstElementClass *klass,
272 const GstElementDetails *details);
274 #define gst_element_default_deep_notify gst_object_default_deep_notify
276 void gst_element_default_error (GObject *object, GstObject *orig, GError *error, gchar *debug);
278 GType gst_element_get_type (void);
279 void gst_element_set_loop_function (GstElement *element,
280 GstElementLoopFunction loop);
282 #define gst_element_get_name(elem) gst_object_get_name(GST_OBJECT(elem))
283 #define gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT(elem),name)
284 #define gst_element_get_parent(elem) gst_object_get_parent(GST_OBJECT(elem))
285 #define gst_element_set_parent(elem,parent) gst_object_set_parent(GST_OBJECT(elem),parent)
287 /* threadsafe versions of their g_object_* counterparts */
288 void gst_element_set (GstElement *element, const gchar *first_property_name, ...);
289 void gst_element_get (GstElement *element, const gchar *first_property_name, ...);
290 void gst_element_set_valist (GstElement *element, const gchar *first_property_name,
292 void gst_element_get_valist (GstElement *element, const gchar *first_property_name,
294 void gst_element_set_property (GstElement *element, const gchar *property_name,
295 const GValue *value);
296 void gst_element_get_property (GstElement *element, const gchar *property_name,
299 void gst_element_enable_threadsafe_properties (GstElement *element);
300 void gst_element_disable_threadsafe_properties (GstElement *element);
301 void gst_element_set_pending_properties (GstElement *element);
304 gboolean gst_element_requires_clock (GstElement *element);
305 gboolean gst_element_provides_clock (GstElement *element);
306 GstClock* gst_element_get_clock (GstElement *element);
307 void gst_element_set_clock (GstElement *element, GstClock *clock);
308 GstClockReturn gst_element_clock_wait (GstElement *element,
309 GstClockID id, GstClockTimeDiff *jitter);
310 GstClockTime gst_element_get_time (GstElement *element);
311 gboolean gst_element_wait (GstElement *element, GstClockTime timestamp);
312 void gst_element_set_time (GstElement *element, GstClockTime time);
313 void gst_element_set_time_delay (GstElement *element, GstClockTime time, GstClockTime delay);
315 void gst_element_adjust_time (GstElement *element, GstClockTimeDiff diff);
318 gboolean gst_element_is_indexable (GstElement *element);
319 void gst_element_set_index (GstElement *element, GstIndex *index);
320 GstIndex* gst_element_get_index (GstElement *element);
323 gboolean gst_element_release_locks (GstElement *element);
325 void gst_element_yield (GstElement *element);
326 gboolean gst_element_interrupt (GstElement *element);
327 void gst_element_set_scheduler (GstElement *element, GstScheduler *sched);
328 GstScheduler* gst_element_get_scheduler (GstElement *element);
330 void gst_element_add_pad (GstElement *element, GstPad *pad);
331 void gst_element_remove_pad (GstElement *element, GstPad *pad);
332 GstPad * gst_element_add_ghost_pad (GstElement *element, GstPad *pad, const gchar *name);
333 #ifndef GST_DISABLE_DEPRECATED
334 void gst_element_remove_ghost_pad (GstElement *element, GstPad *pad);
336 void gst_element_no_more_pads (GstElement *element);
338 GstPad* gst_element_get_pad (GstElement *element, const gchar *name);
339 GstPad* gst_element_get_static_pad (GstElement *element, const gchar *name);
340 GstPad* gst_element_get_request_pad (GstElement *element, const gchar *name);
341 void gst_element_release_request_pad (GstElement *element, GstPad *pad);
343 G_CONST_RETURN GList*
344 gst_element_get_pad_list (GstElement *element);
345 GstPad* gst_element_get_compatible_pad (GstElement *element, GstPad *pad);
346 GstPad* gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad,
347 const GstCaps *filtercaps);
349 GstPadTemplate* gst_element_class_get_pad_template (GstElementClass *element_class, const gchar *name);
350 GList* gst_element_class_get_pad_template_list (GstElementClass *element_class);
351 GstPadTemplate* gst_element_get_pad_template (GstElement *element, const gchar *name);
352 GList* gst_element_get_pad_template_list (GstElement *element);
353 GstPadTemplate* gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
355 gboolean gst_element_link (GstElement *src, GstElement *dest);
356 gboolean gst_element_link_many (GstElement *element_1,
357 GstElement *element_2, ...);
358 gboolean gst_element_link_filtered (GstElement *src, GstElement *dest,
359 const GstCaps *filtercaps);
360 void gst_element_unlink (GstElement *src, GstElement *dest);
361 void gst_element_unlink_many (GstElement *element_1,
362 GstElement *element_2, ...);
364 gboolean gst_element_link_pads (GstElement *src, const gchar *srcpadname,
365 GstElement *dest, const gchar *destpadname);
366 gboolean gst_element_link_pads_filtered (GstElement *src, const gchar *srcpadname,
367 GstElement *dest, const gchar *destpadname,
368 const GstCaps *filtercaps);
369 void gst_element_unlink_pads (GstElement *src, const gchar *srcpadname,
370 GstElement *dest, const gchar *destpadname);
372 G_CONST_RETURN GstEventMask*
373 gst_element_get_event_masks (GstElement *element);
374 gboolean gst_element_send_event (GstElement *element, GstEvent *event);
375 gboolean gst_element_seek (GstElement *element, GstSeekType seek_type,
377 G_CONST_RETURN GstQueryType*
378 gst_element_get_query_types (GstElement *element);
379 gboolean gst_element_query (GstElement *element, GstQueryType type,
380 GstFormat *format, gint64 *value);
381 G_CONST_RETURN GstFormat*
382 gst_element_get_formats (GstElement *element);
383 gboolean gst_element_convert (GstElement *element,
384 GstFormat src_format, gint64 src_value,
385 GstFormat *dest_format, gint64 *dest_value);
387 void gst_element_found_tags (GstElement *element, const GstTagList *tag_list);
388 void gst_element_found_tags_for_pad (GstElement *element, GstPad *pad, GstClockTime timestamp,
391 void gst_element_set_eos (GstElement *element);
393 gchar * _gst_element_error_printf (const gchar *format, ...);
394 void gst_element_error_full (GstElement *element, GQuark domain, gint code,
395 gchar *message, gchar *debug,
396 const gchar *file, const gchar *function, gint line);
398 gboolean gst_element_is_locked_state (GstElement *element);
399 void gst_element_set_locked_state (GstElement *element, gboolean locked_state);
400 gboolean gst_element_sync_state_with_parent (GstElement *element);
402 GstElementState gst_element_get_state (GstElement *element);
403 GstElementStateReturn gst_element_set_state (GstElement *element, GstElementState state);
405 void gst_element_wait_state_change (GstElement *element);
407 G_CONST_RETURN gchar* gst_element_state_get_name (GstElementState state);
409 GstElementFactory* gst_element_get_factory (GstElement *element);
411 GstBin* gst_element_get_managing_bin (GstElement *element);
420 #define GST_TYPE_ELEMENT_FACTORY (gst_element_factory_get_type())
421 #define GST_ELEMENT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
423 #define GST_ELEMENT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
424 GstElementFactoryClass))
425 #define GST_IS_ELEMENT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
426 #define GST_IS_ELEMENT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
428 struct _GstElementFactory {
429 GstPluginFeature parent;
431 GType type; /* unique GType of element or 0 if not loaded */
433 GstElementDetails details;
435 GList * padtemplates;
436 guint numpadtemplates;
438 /* URI interface stuff */
440 gchar ** uri_protocols;
442 GList * interfaces; /* interfaces this element implements */
444 gpointer _gst_reserved[GST_PADDING];
447 struct _GstElementFactoryClass {
448 GstPluginFeatureClass parent_class;
450 gpointer _gst_reserved[GST_PADDING];
453 GType gst_element_factory_get_type (void);
455 gboolean gst_element_register (GstPlugin *plugin,
460 GstElementFactory * gst_element_factory_find (const gchar *name);
461 GType gst_element_factory_get_element_type (GstElementFactory *factory);
462 G_CONST_RETURN gchar * gst_element_factory_get_longname (GstElementFactory *factory);
463 G_CONST_RETURN gchar * gst_element_factory_get_klass (GstElementFactory *factory);
464 G_CONST_RETURN gchar * gst_element_factory_get_description (GstElementFactory *factory);
465 G_CONST_RETURN gchar * gst_element_factory_get_author (GstElementFactory *factory);
466 guint gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
467 G_CONST_RETURN GList * gst_element_factory_get_pad_templates (GstElementFactory *factory);
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, const gchar *name);
475 gboolean gst_element_factory_can_src_caps (GstElementFactory *factory,
476 const GstCaps *caps);
477 gboolean gst_element_factory_can_sink_caps (GstElementFactory *factory,
478 const GstCaps *caps);
480 void __gst_element_factory_add_pad_template (GstElementFactory *elementfactory,
481 GstPadTemplate *templ);
482 void __gst_element_factory_add_interface (GstElementFactory *elementfactory,
483 const gchar *interfacename);
489 #endif /* __GST_ELEMENT_H__ */