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 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 #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);
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,
117 /* private flags that can be used by the scheduler */
118 GST_ELEMENT_SCHEDULER_PRIVATE1,
119 GST_ELEMENT_SCHEDULER_PRIVATE2,
121 /* ignore state changes from parent */
122 GST_ELEMENT_LOCKED_STATE,
124 /* element is in error */
125 GST_ELEMENT_IN_ERROR,
127 /* use some padding for future expansion */
128 GST_ELEMENT_FLAG_LAST = GST_OBJECT_FLAG_LAST + 16
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))
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)
142 #define GST_ELEMENT_ERROR(el, domain, code, message, debug) G_STMT_START { \
143 gchar *__msg = _gst_element_error_printf message; \
144 gchar *__dbg = _gst_element_error_printf debug; \
145 gst_element_error_full (GST_ELEMENT(el), \
146 GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code, \
147 __msg, __dbg, __FILE__, GST_FUNCTION, __LINE__); \
150 typedef struct _GstElementFactory GstElementFactory;
151 typedef struct _GstElementFactoryClass GstElementFactoryClass;
153 typedef void (*GstElementLoopFunction) (GstElement *element);
154 typedef void (*GstElementPreRunFunction) (GstElement *element);
155 typedef void (*GstElementPostRunFunction) (GstElement *element);
160 /* element state and scheduling */
161 guint8 current_state;
162 guint8 pending_state;
163 GstElementLoopFunction loopfunc;
166 gpointer sched_private;
168 /* allocated clock */
170 GstClockTimeDiff base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
181 GstElementPreRunFunction pre_run_func;
182 GstElementPostRunFunction post_run_func;
183 GAsyncQueue *prop_value_queue;
184 GMutex *property_mutex;
186 gpointer _gst_reserved[GST_PADDING];
189 struct _GstElementClass {
190 GstObjectClass parent_class;
192 /* the element details */
193 GstElementDetails details;
195 /* factory that the element was created from */
196 GstElementFactory *elementfactory;
198 /* templates for our pads */
200 gint numpadtemplates;
202 /* signal callbacks */
203 void (*state_change) (GstElement *element, GstElementState old, GstElementState state);
204 void (*new_pad) (GstElement *element, GstPad *pad);
205 void (*pad_removed) (GstElement *element, GstPad *pad);
206 void (*error) (GstElement *element, GstElement *source, GError *error, gchar *debug);
207 void (*eos) (GstElement *element);
208 void (*found_tag) (GstElement *element, GstElement *source, const GstTagList *tag_list);
210 /* local pointers for get/set */
211 void (*set_property) (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
212 void (*get_property) (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
215 gboolean (*release_locks) (GstElement *element);
217 /* query/convert/events functions */
218 const GstEventMask* (*get_event_masks) (GstElement *element);
219 gboolean (*send_event) (GstElement *element, GstEvent *event);
220 const GstFormat* (*get_formats) (GstElement *element);
221 gboolean (*convert) (GstElement *element,
222 GstFormat src_format, gint64 src_value,
223 GstFormat *dest_format, gint64 *dest_value);
224 const GstQueryType* (*get_query_types) (GstElement *element);
225 gboolean (*query) (GstElement *element, GstQueryType type,
226 GstFormat *format, gint64 *value);
228 /* change the element state */
229 GstElementStateReturn (*change_state) (GstElement *element);
231 /* request/release pads */
232 GstPad* (*request_new_pad) (GstElement *element, GstPadTemplate *templ, const gchar* name);
233 void (*release_pad) (GstElement *element, GstPad *pad);
236 GstClock* (*get_clock) (GstElement *element);
237 void (*set_clock) (GstElement *element, GstClock *clock);
240 GstIndex* (*get_index) (GstElement *element);
241 void (*set_index) (GstElement *element, GstIndex *index);
243 GstElementStateReturn (*set_state) (GstElement *element, GstElementState state);
244 gpointer _gst_reserved[GST_PADDING - 1];
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 const GstElementDetails *details);
253 #define gst_element_default_deep_notify gst_object_default_deep_notify
255 void gst_element_default_error (GObject *object, GstObject *orig, GError *error, gchar *debug);
257 GType gst_element_get_type (void);
258 void gst_element_set_loop_function (GstElement *element,
259 GstElementLoopFunction loop);
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)
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,
271 void gst_element_get_valist (GstElement *element, const gchar *first_property_name,
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,
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);
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 #ifndef GST_DEISABLE_DEPRECATED
288 GstClockReturn gst_element_clock_wait (GstElement *element,
289 GstClockID id, GstClockTimeDiff *jitter);
291 GstClockTime gst_element_get_time (GstElement *element);
292 gboolean gst_element_wait (GstElement *element, GstClockTime timestamp);
293 void gst_element_set_time (GstElement *element, GstClockTime time);
294 void gst_element_adjust_time (GstElement *element, GstClockTimeDiff diff);
297 gboolean gst_element_is_indexable (GstElement *element);
298 void gst_element_set_index (GstElement *element, GstIndex *index);
299 GstIndex* gst_element_get_index (GstElement *element);
302 gboolean gst_element_release_locks (GstElement *element);
304 void gst_element_yield (GstElement *element);
305 gboolean gst_element_interrupt (GstElement *element);
306 void gst_element_set_scheduler (GstElement *element, GstScheduler *sched);
307 GstScheduler* gst_element_get_scheduler (GstElement *element);
309 void gst_element_add_pad (GstElement *element, GstPad *pad);
310 void gst_element_remove_pad (GstElement *element, GstPad *pad);
311 GstPad * gst_element_add_ghost_pad (GstElement *element, GstPad *pad, const gchar *name);
312 void gst_element_remove_ghost_pad (GstElement *element, GstPad *pad);
314 GstPad* gst_element_get_pad (GstElement *element, const gchar *name);
315 GstPad* gst_element_get_static_pad (GstElement *element, const gchar *name);
316 GstPad* gst_element_get_request_pad (GstElement *element, const gchar *name);
317 void gst_element_release_request_pad (GstElement *element, GstPad *pad);
319 G_CONST_RETURN GList*
320 gst_element_get_pad_list (GstElement *element);
321 GstPad* gst_element_get_compatible_pad (GstElement *element, GstPad *pad);
322 GstPad* gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad,
323 const GstCaps *filtercaps);
325 GstPadTemplate* gst_element_class_get_pad_template (GstElementClass *element_class, const gchar *name);
326 GList* gst_element_class_get_pad_template_list (GstElementClass *element_class);
327 GstPadTemplate* gst_element_get_pad_template (GstElement *element, const gchar *name);
328 GList* gst_element_get_pad_template_list (GstElement *element);
329 GstPadTemplate* gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
331 gboolean gst_element_link (GstElement *src, GstElement *dest);
332 gboolean gst_element_link_many (GstElement *element_1,
333 GstElement *element_2, ...);
334 gboolean gst_element_link_filtered (GstElement *src, GstElement *dest,
335 const GstCaps *filtercaps);
336 void gst_element_unlink (GstElement *src, GstElement *dest);
337 void gst_element_unlink_many (GstElement *element_1,
338 GstElement *element_2, ...);
340 gboolean gst_element_link_pads (GstElement *src, const gchar *srcpadname,
341 GstElement *dest, const gchar *destpadname);
342 gboolean gst_element_link_pads_filtered (GstElement *src, const gchar *srcpadname,
343 GstElement *dest, const gchar *destpadname,
344 const GstCaps *filtercaps);
345 void gst_element_unlink_pads (GstElement *src, const gchar *srcpadname,
346 GstElement *dest, const gchar *destpadname);
348 G_CONST_RETURN GstEventMask*
349 gst_element_get_event_masks (GstElement *element);
350 gboolean gst_element_send_event (GstElement *element, GstEvent *event);
351 gboolean gst_element_seek (GstElement *element, GstSeekType seek_type,
353 G_CONST_RETURN GstQueryType*
354 gst_element_get_query_types (GstElement *element);
355 gboolean gst_element_query (GstElement *element, GstQueryType type,
356 GstFormat *format, gint64 *value);
357 G_CONST_RETURN GstFormat*
358 gst_element_get_formats (GstElement *element);
359 gboolean gst_element_convert (GstElement *element,
360 GstFormat src_format, gint64 src_value,
361 GstFormat *dest_format, gint64 *dest_value);
363 void gst_element_found_tags (GstElement *element, const GstTagList *tag_list);
364 void gst_element_found_tags_for_pad (GstElement *element, GstPad *pad, GstClockTime timestamp,
367 void gst_element_set_eos (GstElement *element);
369 gchar * _gst_element_error_printf (const gchar *format, ...);
370 void gst_element_error_full (GstElement *element, GQuark domain, gint code,
371 gchar *message, gchar *debug,
372 const gchar *file, const gchar *function, gint line);
374 gboolean gst_element_is_locked_state (GstElement *element);
375 void gst_element_set_locked_state (GstElement *element, gboolean locked_state);
376 gboolean gst_element_sync_state_with_parent (GstElement *element);
378 GstElementState gst_element_get_state (GstElement *element);
379 GstElementStateReturn gst_element_set_state (GstElement *element, GstElementState state);
381 void gst_element_wait_state_change (GstElement *element);
383 G_CONST_RETURN gchar* gst_element_state_get_name (GstElementState state);
385 GstElementFactory* gst_element_get_factory (GstElement *element);
387 GstBin* gst_element_get_managing_bin (GstElement *element);
396 #define GST_TYPE_ELEMENT_FACTORY (gst_element_factory_get_type())
397 #define GST_ELEMENT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
399 #define GST_ELEMENT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
400 GstElementFactoryClass))
401 #define GST_IS_ELEMENT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
402 #define GST_IS_ELEMENT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
404 struct _GstElementFactory {
405 GstPluginFeature parent;
407 GType type; /* unique GType of element or 0 if not loaded */
409 GstElementDetails details;
411 GList * padtemplates;
412 guint numpadtemplates;
414 /* URI interface stuff */
416 gchar ** uri_protocols;
418 GList * interfaces; /* interfaces this element implements */
420 gpointer _gst_reserved[GST_PADDING];
423 struct _GstElementFactoryClass {
424 GstPluginFeatureClass parent_class;
426 gpointer _gst_reserved[GST_PADDING];
429 GType gst_element_factory_get_type (void);
431 gboolean gst_element_register (GstPlugin *plugin,
432 const gchar *elementname,
436 GstElementFactory * gst_element_factory_find (const gchar *name);
437 GType gst_element_factory_get_element_type (GstElementFactory *factory);
438 G_CONST_RETURN gchar * gst_element_factory_get_longname (GstElementFactory *factory);
439 G_CONST_RETURN gchar * gst_element_factory_get_klass (GstElementFactory *factory);
440 G_CONST_RETURN gchar * gst_element_factory_get_description (GstElementFactory *factory);
441 G_CONST_RETURN gchar * gst_element_factory_get_author (GstElementFactory *factory);
442 guint gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
443 G_CONST_RETURN GList * gst_element_factory_get_pad_templates (GstElementFactory *factory);
444 guint gst_element_factory_get_uri_type (GstElementFactory *factory);
445 gchar ** gst_element_factory_get_uri_protocols (GstElementFactory *factory);
447 GstElement* gst_element_factory_create (GstElementFactory *factory,
449 GstElement* gst_element_factory_make (const gchar *factoryname, const gchar *name);
451 gboolean gst_element_factory_can_src_caps (GstElementFactory *factory,
452 const GstCaps *caps);
453 gboolean gst_element_factory_can_sink_caps (GstElementFactory *factory,
454 const GstCaps *caps);
456 void __gst_element_factory_add_pad_template (GstElementFactory *elementfactory,
457 GstPadTemplate *templ);
458 void __gst_element_factory_add_interface (GstElementFactory *elementfactory,
459 const gchar *interfacename);
465 #endif /* __GST_ELEMENT_H__ */