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 */
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 typedef struct _GstElementFactory GstElementFactory;
143 typedef struct _GstElementFactoryClass GstElementFactoryClass;
145 typedef void (*GstElementLoopFunction) (GstElement *element);
146 typedef void (*GstElementPreRunFunction) (GstElement *element);
147 typedef void (*GstElementPostRunFunction) (GstElement *element);
152 /* element state and scheduling */
153 guint8 current_state;
154 guint8 pending_state;
155 GstElementLoopFunction loopfunc;
158 gpointer sched_private;
160 /* allocated clock */
162 GstClockTime base_time;
173 GstElementPreRunFunction pre_run_func;
174 GstElementPostRunFunction post_run_func;
175 GAsyncQueue *prop_value_queue;
176 GMutex *property_mutex;
178 gpointer _gst_reserved[GST_PADDING];
181 struct _GstElementClass {
182 GstObjectClass parent_class;
184 /* the element details */
185 GstElementDetails details;
187 /* factory that the element was created from */
188 GstElementFactory *elementfactory;
190 /* templates for our pads */
192 gint numpadtemplates;
194 /* signal callbacks */
195 void (*state_change) (GstElement *element, GstElementState old, GstElementState state);
196 void (*new_pad) (GstElement *element, GstPad *pad);
197 void (*pad_removed) (GstElement *element, GstPad *pad);
198 void (*error) (GstElement *element, GstElement *source, gchar *error);
199 void (*eos) (GstElement *element);
200 void (*found_tag) (GstElement *element, GstElement *source, GstTagList *tag_list);
202 /* local pointers for get/set */
203 void (*set_property) (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
204 void (*get_property) (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
207 gboolean (*release_locks) (GstElement *element);
209 /* query/convert/events functions */
210 const GstEventMask* (*get_event_masks) (GstElement *element);
211 gboolean (*send_event) (GstElement *element, GstEvent *event);
212 const GstFormat* (*get_formats) (GstElement *element);
213 gboolean (*convert) (GstElement *element,
214 GstFormat src_format, gint64 src_value,
215 GstFormat *dest_format, gint64 *dest_value);
216 const GstQueryType* (*get_query_types) (GstElement *element);
217 gboolean (*query) (GstElement *element, GstQueryType type,
218 GstFormat *format, gint64 *value);
220 /* change the element state */
221 GstElementStateReturn (*change_state) (GstElement *element);
223 /* request/release pads */
224 GstPad* (*request_new_pad) (GstElement *element, GstPadTemplate *templ, const gchar* name);
225 void (*release_pad) (GstElement *element, GstPad *pad);
228 GstClock* (*get_clock) (GstElement *element);
229 void (*set_clock) (GstElement *element, GstClock *clock);
232 GstIndex* (*get_index) (GstElement *element);
233 void (*set_index) (GstElement *element, GstIndex *index);
235 gpointer _gst_reserved[GST_PADDING];
238 void gst_element_class_add_pad_template (GstElementClass *klass, GstPadTemplate *templ);
239 void gst_element_class_install_std_props (GstElementClass *klass,
240 const gchar *first_name, ...);
241 void gst_element_class_set_details (GstElementClass *klass,
242 GstElementDetails *details);
244 #define gst_element_default_deep_notify gst_object_default_deep_notify
246 void gst_element_default_error (GObject *object, GstObject *orig, gchar *error);
248 GType gst_element_get_type (void);
249 void gst_element_set_loop_function (GstElement *element,
250 GstElementLoopFunction loop);
252 #define gst_element_get_name(elem) gst_object_get_name(GST_OBJECT(elem))
253 #define gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT(elem),name)
254 #define gst_element_get_parent(elem) gst_object_get_parent(GST_OBJECT(elem))
255 #define gst_element_set_parent(elem,parent) gst_object_set_parent(GST_OBJECT(elem),parent)
257 /* threadsafe versions of their g_object_* counterparts */
258 void gst_element_set (GstElement *element, const gchar *first_property_name, ...);
259 void gst_element_get (GstElement *element, const gchar *first_property_name, ...);
260 void gst_element_set_valist (GstElement *element, const gchar *first_property_name,
262 void gst_element_get_valist (GstElement *element, const gchar *first_property_name,
264 void gst_element_set_property (GstElement *element, const gchar *property_name,
265 const GValue *value);
266 void gst_element_get_property (GstElement *element, const gchar *property_name,
269 void gst_element_enable_threadsafe_properties (GstElement *element);
270 void gst_element_disable_threadsafe_properties (GstElement *element);
271 void gst_element_set_pending_properties (GstElement *element);
274 gboolean gst_element_requires_clock (GstElement *element);
275 gboolean gst_element_provides_clock (GstElement *element);
276 GstClock* gst_element_get_clock (GstElement *element);
277 void gst_element_set_clock (GstElement *element, GstClock *clock);
278 GstClockReturn gst_element_clock_wait (GstElement *element,
279 GstClockID id, GstClockTimeDiff *jitter);
282 gboolean gst_element_is_indexable (GstElement *element);
283 void gst_element_set_index (GstElement *element, GstIndex *index);
284 GstIndex* gst_element_get_index (GstElement *element);
287 gboolean gst_element_release_locks (GstElement *element);
289 void gst_element_yield (GstElement *element);
290 gboolean gst_element_interrupt (GstElement *element);
291 void gst_element_set_scheduler (GstElement *element, GstScheduler *sched);
292 GstScheduler* gst_element_get_scheduler (GstElement *element);
294 void gst_element_add_pad (GstElement *element, GstPad *pad);
295 void gst_element_remove_pad (GstElement *element, GstPad *pad);
296 GstPad * gst_element_add_ghost_pad (GstElement *element, GstPad *pad, const gchar *name);
297 void gst_element_remove_ghost_pad (GstElement *element, GstPad *pad);
299 GstPad* gst_element_get_pad (GstElement *element, const gchar *name);
300 GstPad* gst_element_get_static_pad (GstElement *element, const gchar *name);
301 GstPad* gst_element_get_request_pad (GstElement *element, const gchar *name);
302 void gst_element_release_request_pad (GstElement *element, GstPad *pad);
304 G_CONST_RETURN GList*
305 gst_element_get_pad_list (GstElement *element);
306 GstPad* gst_element_get_compatible_pad (GstElement *element, GstPad *pad);
307 GstPad* gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad,
308 GstCaps *filtercaps);
310 GstPadTemplate* gst_element_class_get_pad_template (GstElementClass *element_class, const gchar *name);
311 GList* gst_element_class_get_pad_template_list (GstElementClass *element_class);
312 GstPadTemplate* gst_element_get_pad_template (GstElement *element, const gchar *name);
313 GList* gst_element_get_pad_template_list (GstElement *element);
314 GstPadTemplate* gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
316 gboolean gst_element_link (GstElement *src, GstElement *dest);
317 gboolean gst_element_link_many (GstElement *element_1,
318 GstElement *element_2, ...);
319 gboolean gst_element_link_filtered (GstElement *src, GstElement *dest,
320 GstCaps *filtercaps);
321 void gst_element_unlink (GstElement *src, GstElement *dest);
322 void gst_element_unlink_many (GstElement *element_1,
323 GstElement *element_2, ...);
325 gboolean gst_element_link_pads (GstElement *src, const gchar *srcpadname,
326 GstElement *dest, const gchar *destpadname);
327 gboolean gst_element_link_pads_filtered (GstElement *src, const gchar *srcpadname,
328 GstElement *dest, const gchar *destpadname,
329 GstCaps *filtercaps);
330 void gst_element_unlink_pads (GstElement *src, const gchar *srcpadname,
331 GstElement *dest, const gchar *destpadname);
333 G_CONST_RETURN GstEventMask*
334 gst_element_get_event_masks (GstElement *element);
335 gboolean gst_element_send_event (GstElement *element, GstEvent *event);
336 gboolean gst_element_seek (GstElement *element, GstSeekType seek_type,
338 G_CONST_RETURN GstQueryType*
339 gst_element_get_query_types (GstElement *element);
340 gboolean gst_element_query (GstElement *element, GstQueryType type,
341 GstFormat *format, gint64 *value);
342 G_CONST_RETURN GstFormat*
343 gst_element_get_formats (GstElement *element);
344 gboolean gst_element_convert (GstElement *element,
345 GstFormat src_format, gint64 src_value,
346 GstFormat *dest_format, gint64 *dest_value);
348 void gst_element_found_tags (GstElement *element, GstTagList *tag_list);
349 void gst_element_found_tags_for_pad (GstElement *element, GstPad *pad, GstClockTime timestamp,
352 void gst_element_set_eos (GstElement *element);
354 void gst_element_error (GstElement *element, const gchar *error, ...);
356 gboolean gst_element_is_locked_state (GstElement *element);
357 void gst_element_set_locked_state (GstElement *element, gboolean locked_state);
358 gboolean gst_element_sync_state_with_parent (GstElement *element);
360 GstElementState gst_element_get_state (GstElement *element);
361 GstElementStateReturn gst_element_set_state (GstElement *element, GstElementState state);
363 void gst_element_wait_state_change (GstElement *element);
365 G_CONST_RETURN gchar* gst_element_state_get_name (GstElementState state);
367 GstElementFactory* gst_element_get_factory (GstElement *element);
369 GstBin* gst_element_get_managing_bin (GstElement *element);
378 #define GST_TYPE_ELEMENT_FACTORY (gst_element_factory_get_type())
379 #define GST_ELEMENT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
381 #define GST_ELEMENT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
382 GstElementFactoryClass))
383 #define GST_IS_ELEMENT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
384 #define GST_IS_ELEMENT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
386 struct _GstElementFactory {
387 GstPluginFeature parent;
389 GType type; /* unique GType of element or 0 if not loaded */
391 GstElementDetails details;
393 GList * padtemplates;
394 guint numpadtemplates;
396 /* URI interface stuff */
398 gchar ** uri_protocols;
400 GList * interfaces; /* interfaces this element implements */
402 gpointer _gst_reserved[GST_PADDING];
405 struct _GstElementFactoryClass {
406 GstPluginFeatureClass parent_class;
408 gpointer _gst_reserved[GST_PADDING];
411 GType gst_element_factory_get_type (void);
413 gboolean gst_element_register (GstPlugin *plugin,
414 const gchar *elementname,
418 GstElementFactory * gst_element_factory_find (const gchar *name);
419 GType gst_element_factory_get_element_type (GstElementFactory *factory);
420 G_CONST_RETURN gchar * gst_element_factory_get_longname (GstElementFactory *factory);
421 G_CONST_RETURN gchar * gst_element_factory_get_klass (GstElementFactory *factory);
422 G_CONST_RETURN gchar * gst_element_factory_get_description (GstElementFactory *factory);
423 G_CONST_RETURN gchar * gst_element_factory_get_version (GstElementFactory *factory);
424 G_CONST_RETURN gchar * gst_element_factory_get_author (GstElementFactory *factory);
425 guint gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
426 G_CONST_RETURN GList * gst_element_factory_get_pad_templates (GstElementFactory *factory);
427 guint gst_element_factory_get_uri_type (GstElementFactory *factory);
428 gchar ** gst_element_factory_get_uri_protocols (GstElementFactory *factory);
430 GstElement* gst_element_factory_create (GstElementFactory *factory,
432 GstElement* gst_element_factory_make (const gchar *factoryname, const gchar *name);
434 gboolean gst_element_factory_can_src_caps (GstElementFactory *factory,
436 gboolean gst_element_factory_can_sink_caps (GstElementFactory *factory,
439 void __gst_element_factory_add_pad_template (GstElementFactory *elementfactory,
440 GstPadTemplate *templ);
441 void __gst_element_factory_add_interface (GstElementFactory *elementfactory,
442 const gchar *interfacename);
448 #endif /* __GST_ELEMENT_H__ */