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/gstpluginfeature.h>
33 #include <gst/gstindex.h>
37 #define GST_NUM_STATES 4
39 /* NOTE: this probably should be done with an #ifdef to decide
40 * whether to safe-cast or to just do the non-checking cast.
42 #define GST_STATE(obj) (GST_ELEMENT(obj)->current_state)
43 #define GST_STATE_PENDING(obj) (GST_ELEMENT(obj)->pending_state)
45 /* Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g> */
46 #define GST_STATE_TRANSITION(obj) ((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
47 #define GST_STATE_NULL_TO_READY ((GST_STATE_NULL<<8) | GST_STATE_READY)
48 #define GST_STATE_READY_TO_PAUSED ((GST_STATE_READY<<8) | GST_STATE_PAUSED)
49 #define GST_STATE_PAUSED_TO_PLAYING ((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
50 #define GST_STATE_PLAYING_TO_PAUSED ((GST_STATE_PLAYING<<8) | GST_STATE_PAUSED)
51 #define GST_STATE_PAUSED_TO_READY ((GST_STATE_PAUSED<<8) | GST_STATE_READY)
52 #define GST_STATE_READY_TO_NULL ((GST_STATE_READY<<8) | GST_STATE_NULL)
54 extern GType _gst_element_type;
56 #define GST_TYPE_ELEMENT (_gst_element_type)
58 #define GST_ELEMENT_CAST(obj) ((GstElement*)(obj))
59 #define GST_ELEMENT_CLASS_CAST(klass) ((GstElementClass*)(klass))
60 #define GST_IS_ELEMENT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
61 #define GST_IS_ELEMENT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
62 #define GST_ELEMENT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ELEMENT, GstElementClass))
64 #ifdef GST_TYPE_PARANOID
65 # define GST_ELEMENT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
66 # define GST_ELEMENT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
68 # define GST_ELEMENT GST_ELEMENT_CAST
69 # define GST_ELEMENT_CLASS GST_ELEMENT_CLASS_CAST
73 /* element is complex (for some def.) and generally require a cothread */
74 GST_ELEMENT_COMPLEX = GST_OBJECT_FLAG_LAST,
75 /* input and output pads aren't directly coupled to each other
76 examples: queues, multi-output async readers, etc. */
77 GST_ELEMENT_DECOUPLED,
78 /* this element should be placed in a thread if at all possible */
79 GST_ELEMENT_THREAD_SUGGESTED,
80 /* this element, for some reason, has a loop function that performs
81 * an infinite loop without calls to gst_element_yield () */
82 GST_ELEMENT_INFINITE_LOOP,
83 /* there is a new loopfunction ready for placement */
84 GST_ELEMENT_NEW_LOOPFUNC,
85 /* if this element can handle events */
86 GST_ELEMENT_EVENT_AWARE,
87 /* use threadsafe property get/set implementation */
88 GST_ELEMENT_USE_THREADSAFE_PROPERTIES,
90 /* private flags that can be used by the scheduler */
91 GST_ELEMENT_SCHEDULER_PRIVATE1,
92 GST_ELEMENT_SCHEDULER_PRIVATE2,
94 /* use some padding for future expansion */
95 GST_ELEMENT_FLAG_LAST = GST_OBJECT_FLAG_LAST + 16
98 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
99 #define GST_ELEMENT_IS_EOS(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
100 #define GST_ELEMENT_IS_EVENT_AWARE(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
101 #define GST_ELEMENT_IS_DECOUPLED(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
103 #define GST_ELEMENT_NAME(obj) (GST_OBJECT_NAME(obj))
104 #define GST_ELEMENT_PARENT(obj) (GST_OBJECT_PARENT(obj))
105 #define GST_ELEMENT_MANAGER(obj) (((GstElement*)(obj))->manager)
106 #define GST_ELEMENT_SCHED(obj) (((GstElement*)(obj))->sched)
107 #define GST_ELEMENT_CLOCK(obj) (((GstElement*)(obj))->clock)
108 #define GST_ELEMENT_PADS(obj) ((obj)->pads)
110 typedef struct _GstElementFactory GstElementFactory;
111 typedef struct _GstElementFactoryClass GstElementFactoryClass;
113 typedef void (*GstElementLoopFunction) (GstElement *element);
114 typedef void (*GstElementPreRunFunction) (GstElement *element);
115 typedef void (*GstElementPostRunFunction) (GstElement *element);
120 /* element state and scheduling */
121 guint8 current_state;
122 guint8 pending_state;
123 GstElementLoopFunction loopfunc;
126 gpointer sched_private;
128 /* allocated clock */
130 GstClockTime base_time;
141 GstElementPreRunFunction pre_run_func;
142 GstElementPostRunFunction post_run_func;
143 GAsyncQueue *prop_value_queue;
144 GMutex *property_mutex;
149 struct _GstElementClass {
150 GstObjectClass parent_class;
152 /* the elementfactory that created us */
153 GstElementFactory *elementfactory;
154 /* templates for our pads */
156 gint numpadtemplates;
158 /* signal callbacks */
159 void (*state_change) (GstElement *element, GstElementState old, GstElementState state);
160 void (*new_pad) (GstElement *element, GstPad *pad);
161 void (*pad_removed) (GstElement *element, GstPad *pad);
162 void (*error) (GstElement *element, GstElement *source, gchar *error);
163 void (*eos) (GstElement *element);
165 /* local pointers for get/set */
166 void (*set_property) (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
167 void (*get_property) (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
170 gboolean (*release_locks) (GstElement *element);
171 gboolean (*send_event) (GstElement *element, GstEvent *event);
172 gboolean (*query) (GstElement *element, GstPadQueryType type,
173 GstFormat *format, gint64 *value);
174 /* change the element state */
175 GstElementStateReturn (*change_state) (GstElement *element);
176 /* request a new pad */
177 GstPad* (*request_new_pad) (GstElement *element, GstPadTemplate *templ, const gchar* name);
178 void (*release_pad) (GstElement *element, GstPad *pad);
180 GstClock* (*get_clock) (GstElement *element);
181 void (*set_clock) (GstElement *element, GstClock *clock);
183 GstIndex* (*get_index) (GstElement *element);
184 void (*set_index) (GstElement *element, GstIndex *index);
189 void gst_element_class_add_pad_template (GstElementClass *klass, GstPadTemplate *templ);
190 void gst_element_class_install_std_props (GstElementClass *klass,
191 const gchar *first_name, ...);
193 #define gst_element_default_deep_notify gst_object_default_deep_notify
195 void gst_element_default_error (GObject *object, GstObject *orig, gchar *error);
197 GType gst_element_get_type (void);
198 #define gst_element_destroy(element) gst_object_destroy (GST_OBJECT (element))
200 void gst_element_set_loop_function (GstElement *element,
201 GstElementLoopFunction loop);
203 #define gst_element_get_name(elem) gst_object_get_name(GST_OBJECT(elem))
204 #define gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT(elem),name)
205 #define gst_element_get_parent(elem) gst_object_get_parent(GST_OBJECT(elem))
206 #define gst_element_set_parent(elem,parent) gst_object_set_parent(GST_OBJECT(elem),parent)
208 /* threadsafe versions of their g_object_* counterparts */
209 void gst_element_set (GstElement *element, const gchar *first_property_name, ...);
210 void gst_element_get (GstElement *element, const gchar *first_property_name, ...);
211 void gst_element_set_valist (GstElement *element, const gchar *first_property_name,
213 void gst_element_get_valist (GstElement *element, const gchar *first_property_name,
215 void gst_element_set_property (GstElement *element, const gchar *property_name,
216 const GValue *value);
217 void gst_element_get_property (GstElement *element, const gchar *property_name,
220 void gst_element_enable_threadsafe_properties (GstElement *element);
221 void gst_element_disable_threadsafe_properties (GstElement *element);
222 void gst_element_set_pending_properties (GstElement *element);
225 gboolean gst_element_requires_clock (GstElement *element);
226 gboolean gst_element_provides_clock (GstElement *element);
227 GstClock* gst_element_get_clock (GstElement *element);
228 void gst_element_set_clock (GstElement *element, GstClock *clock);
229 GstClockReturn gst_element_clock_wait (GstElement *element, GstClock *clock,
230 GstClockTime time, GstClockTimeDiff *jitter);
232 gboolean gst_element_is_indexable (GstElement *element);
233 void gst_element_set_index (GstElement *element, GstIndex *index);
234 GstIndex* gst_element_get_index (GstElement *element);
237 gboolean gst_element_release_locks (GstElement *element);
239 void gst_element_yield (GstElement *element);
240 gboolean gst_element_interrupt (GstElement *element);
241 void gst_element_set_scheduler (GstElement *element, GstScheduler *sched);
242 GstScheduler* gst_element_get_scheduler (GstElement *element);
244 void gst_element_add_pad (GstElement *element, GstPad *pad);
245 void gst_element_remove_pad (GstElement *element, GstPad *pad);
246 GstPad * gst_element_add_ghost_pad (GstElement *element, GstPad *pad, const gchar *name);
247 void gst_element_remove_ghost_pad (GstElement *element, GstPad *pad);
249 GstPad* gst_element_get_pad (GstElement *element, const gchar *name);
250 GstPad* gst_element_get_static_pad (GstElement *element, const gchar *name);
251 GstPad* gst_element_get_request_pad (GstElement *element, const gchar *name);
252 void gst_element_release_request_pad (GstElement *element, GstPad *pad);
254 const GList* gst_element_get_pad_list (GstElement *element);
255 GstPad* gst_element_get_compatible_pad (GstElement *element, GstPad *pad);
256 GstPad* gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad,
257 GstCaps *filtercaps);
259 GstPad* gst_element_get_compatible_request_pad (GstElement *element, GstPadTemplate *templ);
260 GstPad* gst_element_get_compatible_static_pad (GstElement *element, GstPadTemplate *templ);
263 GstPadTemplate* gst_element_get_pad_template (GstElement *element, const gchar *name);
264 GList* gst_element_get_pad_template_list (GstElement *element);
265 GstPadTemplate* gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
267 gboolean gst_element_connect (GstElement *src, GstElement *dest);
268 gboolean gst_element_connect_many (GstElement *element_1, GstElement *element_2, ...);
269 gboolean gst_element_connect_filtered (GstElement *src, GstElement *dest,
270 GstCaps *filtercaps);
271 void gst_element_disconnect (GstElement *src, GstElement *dest);
272 void gst_element_disconnect_many (GstElement *element_1, GstElement *element_2, ...);
274 gboolean gst_element_connect_pads (GstElement *src, const gchar *srcpadname,
275 GstElement *dest, const gchar *destpadname);
276 gboolean gst_element_connect_pads_filtered (GstElement *src, const gchar *srcpadname,
277 GstElement *dest, const gchar *destpadname,
278 GstCaps *filtercaps);
279 void gst_element_disconnect_pads (GstElement *src, const gchar *srcpadname,
280 GstElement *dest, const gchar *destpadname);
282 gboolean gst_element_send_event (GstElement *element, GstEvent *event);
283 gboolean gst_element_query (GstElement *element, GstPadQueryType type,
284 GstFormat *format, gint64 *value);
286 void gst_element_set_eos (GstElement *element);
288 void gst_element_error (GstElement *element, const gchar *error, ...);
290 GstElementState gst_element_get_state (GstElement *element);
291 GstElementStateReturn gst_element_set_state (GstElement *element, GstElementState state);
293 void gst_element_wait_state_change (GstElement *element);
295 const gchar* gst_element_state_get_name (GstElementState state);
297 GstElementFactory* gst_element_get_factory (GstElement *element);
299 GstBin* gst_element_get_managing_bin (GstElement *element);
307 typedef struct _GstElementDetails GstElementDetails;
309 struct _GstElementDetails {
310 gchar *longname; /* long, english name */
311 gchar *klass; /* type of element, as hierarchy */
312 gchar *license; /* license element is under */
313 gchar *description; /* insights of one form or another */
314 gchar *version; /* version of the element */
315 gchar *author; /* who wrote this thing? */
316 gchar *copyright; /* copyright details (year, etc.) */
319 #define GST_TYPE_ELEMENT_FACTORY (gst_element_factory_get_type())
320 #define GST_ELEMENT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
322 #define GST_ELEMENT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
323 GstElementFactoryClass))
324 #define GST_IS_ELEMENT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
325 #define GST_IS_ELEMENT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
327 #define GST_ELEMENT_RANK_PRIMARY 256
328 #define GST_ELEMENT_RANK_SECONDARY 128
329 #define GST_ELEMENT_RANK_MARGINAL 64
330 #define GST_ELEMENT_RANK_NONE 0
332 struct _GstElementFactory {
333 GstPluginFeature feature;
335 GType type; /* unique GType of element */
337 guint details_dynamic : 1;
339 GstElementDetails *details; /* pointer to details struct */
342 guint16 numpadtemplates;
344 guint16 rank; /* used by autoplug to prioritise elements to try */
347 struct _GstElementFactoryClass {
348 GstPluginFeatureClass parent_class;
351 GType gst_element_factory_get_type (void);
353 GstElementFactory* gst_element_factory_new (const gchar *name, GType type,
354 GstElementDetails *details);
355 GstElementFactory* gst_element_factory_find (const gchar *name);
357 void gst_element_factory_add_pad_template (GstElementFactory *elementfactory,
358 GstPadTemplate *templ);
360 gboolean gst_element_factory_can_src_caps (GstElementFactory *factory,
362 gboolean gst_element_factory_can_sink_caps (GstElementFactory *factory,
365 GstElement* gst_element_factory_create (GstElementFactory *factory,
367 GstElement* gst_element_factory_make (const gchar *factoryname, const gchar *name);
368 GstElement* gst_element_factory_make_or_warn (const gchar *factoryname, const gchar *name);
370 void gst_element_factory_set_rank (GstElementFactory *factory, guint16 rank);
375 #endif /* __GST_ELEMENT_H__ */