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 #endif /* __cplusplus */
39 #define GST_NUM_STATES 4
41 /* NOTE: this probably should be done with an #ifdef to decide
42 * whether to safe-cast or to just do the non-checking cast.
44 #define GST_STATE(obj) (GST_ELEMENT(obj)->current_state)
45 #define GST_STATE_PENDING(obj) (GST_ELEMENT(obj)->pending_state)
47 /* Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g> */
48 #define GST_STATE_TRANSITION(obj) ((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
49 #define GST_STATE_NULL_TO_READY ((GST_STATE_NULL<<8) | GST_STATE_READY)
50 #define GST_STATE_READY_TO_PAUSED ((GST_STATE_READY<<8) | GST_STATE_PAUSED)
51 #define GST_STATE_PAUSED_TO_PLAYING ((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
52 #define GST_STATE_PLAYING_TO_PAUSED ((GST_STATE_PLAYING<<8) | GST_STATE_PAUSED)
53 #define GST_STATE_PAUSED_TO_READY ((GST_STATE_PAUSED<<8) | GST_STATE_READY)
54 #define GST_STATE_READY_TO_NULL ((GST_STATE_READY<<8) | GST_STATE_NULL)
56 extern GType _gst_element_type;
58 #define GST_TYPE_ELEMENT (_gst_element_type)
60 #define GST_ELEMENT_CAST(obj) ((GstElement*)(obj))
61 #define GST_ELEMENT_CLASS_CAST(klass) ((GstElementClass*)(klass))
62 #define GST_IS_ELEMENT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
63 #define GST_IS_ELEMENT_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
65 #ifdef GST_TYPE_PARANOID
66 # define GST_ELEMENT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
67 # define GST_ELEMENT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
69 # define GST_ELEMENT GST_ELEMENT_CAST
70 # define GST_ELEMENT_CLASS GST_ELEMENT_CLASS_CAST
74 /* element is complex (for some def.) and generally require a cothread */
75 GST_ELEMENT_COMPLEX = GST_OBJECT_FLAG_LAST,
76 /* input and output pads aren't directly coupled to each other
77 examples: queues, multi-output async readers, etc. */
78 GST_ELEMENT_DECOUPLED,
79 /* this element should be placed in a thread if at all possible */
80 GST_ELEMENT_THREAD_SUGGESTED,
81 /* this element is incable of seeking (FIXME: does this apply to filters?) */
84 /* this element, for some reason, has a loop function that performs
85 * an infinite loop without calls to gst_element_yield () */
86 GST_ELEMENT_INFINITE_LOOP,
88 /* private flags that can be used by the scheduler */
89 GST_ELEMENT_SCHEDULER_PRIVATE1,
90 GST_ELEMENT_SCHEDULER_PRIVATE2,
92 /* there is a new loopfunction ready for placement */
93 GST_ELEMENT_NEW_LOOPFUNC,
95 /* if this element can handle events */
96 GST_ELEMENT_EVENT_AWARE,
98 /* use some padding for future expansion */
99 GST_ELEMENT_FLAG_LAST = GST_OBJECT_FLAG_LAST + 12,
102 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
103 #define GST_ELEMENT_IS_EOS(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
104 #define GST_ELEMENT_IS_EVENT_AWARE(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
105 #define GST_ELEMENT_IS_DECOUPLED(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
107 #define GST_ELEMENT_NAME(obj) (GST_OBJECT_NAME(obj))
108 #define GST_ELEMENT_PARENT(obj) (GST_OBJECT_PARENT(obj))
109 #define GST_ELEMENT_MANAGER(obj) (((GstElement*)(obj))->manager)
110 #define GST_ELEMENT_SCHED(obj) (((GstElement*)(obj))->sched)
111 #define GST_ELEMENT_CLOCK(obj) (((GstElement*)(obj))->clock)
112 #define GST_ELEMENT_PADS(obj) ((obj)->pads)
114 /*typedef struct _GstElement GstElement;*/
115 /*typedef struct _GstElementClass GstElementClass;*/
116 typedef struct _GstElementFactory GstElementFactory;
117 typedef struct _GstElementFactoryClass GstElementFactoryClass;
119 typedef void (*GstElementLoopFunction) (GstElement *element);
120 typedef void (*GstElementSetClockFunction) (GstElement *element, GstClock *clock);
121 typedef GstClock* (*GstElementGetClockFunction) (GstElement *element);
126 /* element state and scheduling */
127 guint8 current_state;
128 guint8 pending_state;
130 GstElementLoopFunction loopfunc;
133 gpointer sched_private;
134 GstElementSetClockFunction setclockfunc;
135 GstElementGetClockFunction getclockfunc;
148 struct _GstElementClass {
149 GstObjectClass parent_class;
151 /* the elementfactory that created us */
152 GstElementFactory *elementfactory;
153 /* templates for our pads */
155 gint numpadtemplates;
157 /* signal callbacks */
158 void (*state_change) (GstElement *element, GstElementState old, GstElementState state);
159 void (*new_pad) (GstElement *element, GstPad *pad);
160 void (*pad_removed) (GstElement *element, GstPad *pad);
161 void (*error) (GstElement *element, GstElement *source, gchar *error);
162 void (*eos) (GstElement *element);
164 /* local pointers for get/set */
165 void (*set_property) (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
166 void (*get_property) (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
169 /* change the element state */
170 GstElementStateReturn (*change_state) (GstElement *element);
171 /* request a new pad */
172 GstPad* (*request_new_pad) (GstElement *element, GstPadTemplate *templ, const gchar* name);
175 void gst_element_class_add_pad_template (GstElementClass *klass, GstPadTemplate *templ);
177 GType gst_element_get_type (void);
178 #define gst_element_destroy(element) gst_object_destroy (GST_OBJECT (element))
180 void gst_element_set_loop_function (GstElement *element,
181 GstElementLoopFunction loop);
183 void gst_element_set_name (GstElement *element, const gchar *name);
184 const gchar* gst_element_get_name (GstElement *element);
186 void gst_element_set_parent (GstElement *element, GstObject *parent);
187 GstObject* gst_element_get_parent (GstElement *element);
189 GstClock* gst_element_get_clock (GstElement *element);
190 void gst_element_set_clock (GstElement *element, GstClock *clock);
191 GstClockReturn gst_element_clock_wait (GstElement *element, GstClock *clock, GstClockTime time);
193 void gst_element_yield (GstElement *element);
194 gboolean gst_element_interrupt (GstElement *element);
195 void gst_element_set_sched (GstElement *element, GstScheduler *sched);
196 GstScheduler* gst_element_get_sched (GstElement *element);
198 void gst_element_add_pad (GstElement *element, GstPad *pad);
199 void gst_element_remove_pad (GstElement *element, GstPad *pad);
200 GstPad * gst_element_add_ghost_pad (GstElement *element, GstPad *pad, gchar *name);
201 void gst_element_remove_ghost_pad (GstElement *element, GstPad *pad);
203 GstPad* gst_element_get_pad (GstElement *element, const gchar *name);
204 GstPad* gst_element_get_static_pad (GstElement *element, const gchar *name);
205 GstPad* gst_element_get_request_pad (GstElement *element, const gchar *name);
207 GList* gst_element_get_pad_list (GstElement *element);
208 GstPad* gst_element_get_compatible_pad (GstElement *element, GstPad *pad);
209 GstPad* gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad,
210 GstCaps *filtercaps);
212 GstPad* gst_element_get_compatible_request_pad (GstElement *element, GstPadTemplate *templ);
213 GstPad* gst_element_get_compatible_static_pad (GstElement *element, GstPadTemplate *templ);
216 GstPadTemplate* gst_element_get_pad_template (GstElement *element, const guchar *name);
217 GList* gst_element_get_pad_template_list (GstElement *element);
218 GstPadTemplate* gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
220 gboolean gst_element_connect (GstElement *src, GstElement *dest);
221 gboolean gst_element_connect_many (GstElement *element_1, GstElement *element_2, ...);
222 gboolean gst_element_connect_filtered (GstElement *src, GstElement *dest,
223 GstCaps *filtercaps);
224 void gst_element_disconnect (GstElement *src, GstElement *dest);
225 void gst_element_disconnect_many (GstElement *element_1, GstElement *element_2, ...);
227 gboolean gst_element_connect_pads (GstElement *src, const gchar *srcpadname,
228 GstElement *dest, const gchar *destpadname);
229 gboolean gst_element_connect_pads_filtered (GstElement *src, const gchar *srcpadname,
230 GstElement *dest, const gchar *destpadname,
231 GstCaps *filtercaps);
232 void gst_element_disconnect_pads (GstElement *src, const gchar *srcpadname,
233 GstElement *dest, const gchar *destpadname);
235 void gst_element_set_eos (GstElement *element);
237 void gst_element_error (GstElement *element, const gchar *error, ...);
239 GstElementState gst_element_get_state (GstElement *element);
240 gint gst_element_set_state (GstElement *element, GstElementState state);
242 void gst_element_wait_state_change (GstElement *element);
244 const gchar* gst_element_state_get_name (GstElementState state);
246 GstElementFactory* gst_element_get_factory (GstElement *element);
248 void gst_element_class_install_std_props (GstElementClass *klass,
249 const char *first_name, ...);
251 GstBin* gst_element_get_managing_bin (GstElement *element);
259 typedef struct _GstElementDetails GstElementDetails;
261 struct _GstElementDetails {
262 gchar *longname; /* long, english name */
263 gchar *klass; /* type of element, as hierarchy */
264 gchar *description; /* insights of one form or another */
265 gchar *version; /* version of the element */
266 gchar *author; /* who wrote this thing? */
267 gchar *copyright; /* copyright details (year, etc.) */
270 #define GST_TYPE_ELEMENT_FACTORY (gst_element_factory_get_type())
271 #define GST_ELEMENT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
273 #define GST_ELEMENT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
274 GstElementFactoryClass))
275 #define GST_IS_ELEMENT_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
276 #define GST_IS_ELEMENT_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
278 struct _GstElementFactory {
279 GstPluginFeature feature;
281 GType type; /* unique GType of element */
283 guint details_dynamic : 1;
285 GstElementDetails *details; /* pointer to details struct */
288 guint16 numpadtemplates;
291 struct _GstElementFactoryClass {
292 GstPluginFeatureClass parent_class;
295 GType gst_element_factory_get_type (void);
297 GstElementFactory* gst_element_factory_new (const gchar *name,GType type,
298 GstElementDetails *details);
300 GstElementFactory* gst_element_factory_find (const gchar *name);
301 const GList* gst_element_factory_get_list (void);
303 void gst_element_factory_add_pad_template (GstElementFactory *elementfactory,
304 GstPadTemplate *templ);
306 gboolean gst_element_factory_can_src_caps (GstElementFactory *factory,
308 gboolean gst_element_factory_can_sink_caps (GstElementFactory *factory,
311 GstElement* gst_element_factory_create (GstElementFactory *factory,
313 /* FIXME this name is wrong, probably so is the one above it */
314 GstElement* gst_element_factory_make (const gchar *factoryname, const gchar *name);
318 #endif /* __cplusplus */
321 #endif /* __GST_ELEMENT_H__ */