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>
29 #include <gst/gsttypes.h>
30 #include <gst/gstobject.h>
31 #include <gst/gstpad.h>
32 #include <gst/gstclock.h>
33 #include <gst/gstpluginfeature.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(obj) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
63 #ifdef GST_TYPE_PARANOID
64 # define GST_ELEMENT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
65 # define GST_ELEMENT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
67 # define GST_ELEMENT GST_ELEMENT_CAST
68 # define GST_ELEMENT_CLASS GST_ELEMENT_CLASS_CAST
72 /* element is complex (for some def.) and generally require a cothread */
73 GST_ELEMENT_COMPLEX = GST_OBJECT_FLAG_LAST,
74 /* input and output pads aren't directly coupled to each other
75 examples: queues, multi-output async readers, etc. */
76 GST_ELEMENT_DECOUPLED,
77 /* this element should be placed in a thread if at all possible */
78 GST_ELEMENT_THREAD_SUGGESTED,
79 /* this element is incable of seeking (FIXME: does this apply to filters?) */
81 /* this element, for some reason, has a loop function that performs
82 * an infinite loop without calls to gst_element_yield () */
83 GST_ELEMENT_INFINITE_LOOP,
84 /* there is a new loopfunction ready for placement */
85 GST_ELEMENT_NEW_LOOPFUNC,
86 /* if this element can handle events */
87 GST_ELEMENT_EVENT_AWARE,
88 /* use threadsafe property get/set implementation */
89 GST_ELEMENT_USE_THREADSAFE_PROPERTIES,
91 /* private flags that can be used by the scheduler */
92 GST_ELEMENT_SCHEDULER_PRIVATE1,
93 GST_ELEMENT_SCHEDULER_PRIVATE2,
95 /* use some padding for future expansion */
96 GST_ELEMENT_FLAG_LAST = GST_OBJECT_FLAG_LAST + 16,
99 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
100 #define GST_ELEMENT_IS_EOS(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
101 #define GST_ELEMENT_IS_EVENT_AWARE(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
102 #define GST_ELEMENT_IS_DECOUPLED(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
104 #define GST_ELEMENT_NAME(obj) (GST_OBJECT_NAME(obj))
105 #define GST_ELEMENT_PARENT(obj) (GST_OBJECT_PARENT(obj))
106 #define GST_ELEMENT_MANAGER(obj) (((GstElement*)(obj))->manager)
107 #define GST_ELEMENT_SCHED(obj) (((GstElement*)(obj))->sched)
108 #define GST_ELEMENT_CLOCK(obj) (((GstElement*)(obj))->clock)
109 #define GST_ELEMENT_PADS(obj) ((obj)->pads)
111 typedef struct _GstElementFactory GstElementFactory;
112 typedef struct _GstElementFactoryClass GstElementFactoryClass;
114 typedef void (*GstElementLoopFunction) (GstElement *element);
115 typedef void (*GstElementSetClockFunction) (GstElement *element, GstClock *clock);
116 typedef GstClock* (*GstElementGetClockFunction) (GstElement *element);
117 typedef void (*GstElementPreRunFunction) (GstElement *element);
118 typedef void (*GstElementPostRunFunction) (GstElement *element);
123 /* element state and scheduling */
124 guint8 current_state;
125 guint8 pending_state;
127 GstElementLoopFunction loopfunc;
130 gpointer sched_private;
131 GstElementSetClockFunction setclockfunc;
132 GstElementGetClockFunction getclockfunc;
144 GstElementPreRunFunction pre_run_func;
145 GstElementPostRunFunction post_run_func;
146 GAsyncQueue *prop_value_queue;
147 GMutex *property_mutex;
150 struct _GstElementClass {
151 GstObjectClass parent_class;
153 /* the elementfactory that created us */
154 GstElementFactory *elementfactory;
155 /* templates for our pads */
157 gint numpadtemplates;
159 /* signal callbacks */
160 void (*state_change) (GstElement *element, GstElementState old, GstElementState state);
161 void (*new_pad) (GstElement *element, GstPad *pad);
162 void (*pad_removed) (GstElement *element, GstPad *pad);
163 void (*error) (GstElement *element, GstElement *source, gchar *error);
164 void (*eos) (GstElement *element);
165 void (*deep_notify) (GstObject *object, GstObject *orig, GParamSpec *pspec);
167 /* local pointers for get/set */
168 void (*set_property) (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
169 void (*get_property) (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
172 /* change the element state */
173 GstElementStateReturn (*change_state) (GstElement *element);
174 /* request a new pad */
175 GstPad* (*request_new_pad) (GstElement *element, GstPadTemplate *templ, const gchar* name);
176 void (*release_pad) (GstElement *element, GstPad *pad);
179 void gst_element_class_add_pad_template (GstElementClass *klass, GstPadTemplate *templ);
180 void gst_element_class_install_std_props (GstElementClass *klass,
181 const gchar *first_name, ...);
184 GType gst_element_get_type (void);
185 #define gst_element_destroy(element) gst_object_destroy (GST_OBJECT (element))
187 void gst_element_set_loop_function (GstElement *element,
188 GstElementLoopFunction loop);
190 /* threadsafe versions of their g_object_* counterparts */
191 void gst_element_set (GstElement *element, const gchar *first_property_name, ...);
192 void gst_element_get (GstElement *element, const gchar *first_property_name, ...);
193 void gst_element_set_valist (GstElement *element, const gchar *first_property_name,
195 void gst_element_get_valist (GstElement *element, const gchar *first_property_name,
197 void gst_element_set_property (GstElement *element, const gchar *property_name,
198 const GValue *value);
199 void gst_element_get_property (GstElement *element, const gchar *property_name,
202 void gst_element_enable_threadsafe_properties (GstElement *element);
203 void gst_element_disable_threadsafe_properties (GstElement *element);
204 void gst_element_set_pending_properties (GstElement *element);
206 void gst_element_set_name (GstElement *element, const gchar *name);
207 const gchar* gst_element_get_name (GstElement *element);
209 void gst_element_set_parent (GstElement *element, GstObject *parent);
210 GstObject* gst_element_get_parent (GstElement *element);
212 GstClock* gst_element_get_clock (GstElement *element);
213 void gst_element_set_clock (GstElement *element, GstClock *clock);
214 GstClockReturn gst_element_clock_wait (GstElement *element, GstClock *clock, GstClockTime time);
216 void gst_element_yield (GstElement *element);
217 gboolean gst_element_interrupt (GstElement *element);
218 void gst_element_set_scheduler (GstElement *element, GstScheduler *sched);
219 GstScheduler* gst_element_get_scheduler (GstElement *element);
221 void gst_element_add_pad (GstElement *element, GstPad *pad);
222 void gst_element_remove_pad (GstElement *element, GstPad *pad);
223 GstPad * gst_element_add_ghost_pad (GstElement *element, GstPad *pad, gchar *name);
224 void gst_element_remove_ghost_pad (GstElement *element, GstPad *pad);
226 GstPad* gst_element_get_pad (GstElement *element, const gchar *name);
227 GstPad* gst_element_get_static_pad (GstElement *element, const gchar *name);
228 GstPad* gst_element_get_request_pad (GstElement *element, const gchar *name);
229 void gst_element_release_request_pad (GstElement *element, GstPad *pad);
231 GList* gst_element_get_pad_list (GstElement *element);
232 GstPad* gst_element_get_compatible_pad (GstElement *element, GstPad *pad);
233 GstPad* gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad,
234 GstCaps *filtercaps);
236 GstPad* gst_element_get_compatible_request_pad (GstElement *element, GstPadTemplate *templ);
237 GstPad* gst_element_get_compatible_static_pad (GstElement *element, GstPadTemplate *templ);
240 GstPadTemplate* gst_element_get_pad_template (GstElement *element, const guchar *name);
241 GList* gst_element_get_pad_template_list (GstElement *element);
242 GstPadTemplate* gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
244 gboolean gst_element_connect (GstElement *src, GstElement *dest);
245 gboolean gst_element_connect_many (GstElement *element_1, GstElement *element_2, ...);
246 gboolean gst_element_connect_filtered (GstElement *src, GstElement *dest,
247 GstCaps *filtercaps);
248 void gst_element_disconnect (GstElement *src, GstElement *dest);
249 void gst_element_disconnect_many (GstElement *element_1, GstElement *element_2, ...);
251 gboolean gst_element_connect_pads (GstElement *src, const gchar *srcpadname,
252 GstElement *dest, const gchar *destpadname);
253 gboolean gst_element_connect_pads_filtered (GstElement *src, const gchar *srcpadname,
254 GstElement *dest, const gchar *destpadname,
255 GstCaps *filtercaps);
256 void gst_element_disconnect_pads (GstElement *src, const gchar *srcpadname,
257 GstElement *dest, const gchar *destpadname);
259 void gst_element_set_eos (GstElement *element);
261 void gst_element_error (GstElement *element, const gchar *error, ...);
263 GstElementState gst_element_get_state (GstElement *element);
264 gint gst_element_set_state (GstElement *element, GstElementState state);
266 void gst_element_wait_state_change (GstElement *element);
268 const gchar* gst_element_state_get_name (GstElementState state);
270 GstElementFactory* gst_element_get_factory (GstElement *element);
272 GstBin* gst_element_get_managing_bin (GstElement *element);
280 typedef struct _GstElementDetails GstElementDetails;
282 struct _GstElementDetails {
283 gchar *longname; /* long, english name */
284 gchar *klass; /* type of element, as hierarchy */
285 gchar *description; /* insights of one form or another */
286 gchar *version; /* version of the element */
287 gchar *author; /* who wrote this thing? */
288 gchar *copyright; /* copyright details (year, etc.) */
291 #define GST_TYPE_ELEMENT_FACTORY (gst_element_factory_get_type())
292 #define GST_ELEMENT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
294 #define GST_ELEMENT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
295 GstElementFactoryClass))
296 #define GST_IS_ELEMENT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
297 #define GST_IS_ELEMENT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
299 struct _GstElementFactory {
300 GstPluginFeature feature;
302 GType type; /* unique GType of element */
304 guint details_dynamic : 1;
306 GstElementDetails *details; /* pointer to details struct */
309 guint16 numpadtemplates;
312 struct _GstElementFactoryClass {
313 GstPluginFeatureClass parent_class;
316 GType gst_element_factory_get_type (void);
318 GstElementFactory* gst_element_factory_new (const gchar *name, GType type,
319 GstElementDetails *details);
320 GstElementFactory* gst_element_factory_find (const gchar *name);
322 void gst_element_factory_add_pad_template (GstElementFactory *elementfactory,
323 GstPadTemplate *templ);
325 gboolean gst_element_factory_can_src_caps (GstElementFactory *factory,
327 gboolean gst_element_factory_can_sink_caps (GstElementFactory *factory,
330 GstElement* gst_element_factory_create (GstElementFactory *factory,
332 /* FIXME this name is wrong, probably so is the one above it */
333 GstElement* gst_element_factory_make (const gchar *factoryname, const gchar *name);
338 #endif /* __GST_ELEMENT_H__ */