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
42 /* NOTE: this probably should be done with an #ifdef to decide
43 * whether to safe-cast or to just do the non-checking cast.
45 #define GST_STATE(obj) (GST_ELEMENT(obj)->current_state)
46 #define GST_STATE_PENDING(obj) (GST_ELEMENT(obj)->pending_state)
48 /* Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g> */
49 #define GST_STATE_TRANSITION(obj) ((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
50 #define GST_STATE_NULL_TO_READY ((GST_STATE_NULL<<8) | GST_STATE_READY)
51 #define GST_STATE_READY_TO_PAUSED ((GST_STATE_READY<<8) | GST_STATE_PAUSED)
52 #define GST_STATE_PAUSED_TO_PLAYING ((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
53 #define GST_STATE_PLAYING_TO_PAUSED ((GST_STATE_PLAYING<<8) | GST_STATE_PAUSED)
54 #define GST_STATE_PAUSED_TO_READY ((GST_STATE_PAUSED<<8) | GST_STATE_READY)
55 #define GST_STATE_READY_TO_NULL ((GST_STATE_READY<<8) | GST_STATE_NULL)
57 extern GType _gst_element_type;
59 #define GST_TYPE_ELEMENT (_gst_element_type)
61 #define GST_ELEMENT_CAST(obj) ((GstElement*)(obj))
62 #define GST_ELEMENT_CLASS_CAST(klass) ((GstElementClass*)(klass))
63 #define GST_IS_ELEMENT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
64 #define GST_IS_ELEMENT_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
66 #ifdef GST_TYPE_PARANOID
67 # define GST_ELEMENT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
68 # define GST_ELEMENT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
70 # define GST_ELEMENT GST_ELEMENT_CAST
71 # define GST_ELEMENT_CLASS GST_ELEMENT_CLASS_CAST
75 /* element is complex (for some def.) and generally require a cothread */
76 GST_ELEMENT_COMPLEX = GST_OBJECT_FLAG_LAST,
77 /* input and output pads aren't directly coupled to each other
78 examples: queues, multi-output async readers, etc. */
79 GST_ELEMENT_DECOUPLED,
80 /* this element should be placed in a thread if at all possible */
81 GST_ELEMENT_THREAD_SUGGESTED,
82 /* this element is incable of seeking (FIXME: does this apply to filters?) */
85 /* this element, for some reason, has a loop function that performs
86 * an infinite loop without calls to gst_element_yield () */
87 GST_ELEMENT_INFINITE_LOOP,
89 /* private flags that can be used by the scheduler */
90 GST_ELEMENT_SCHEDULER_PRIVATE1,
91 GST_ELEMENT_SCHEDULER_PRIVATE2,
93 /* there is a new loopfunction ready for placement */
94 GST_ELEMENT_NEW_LOOPFUNC,
96 /* if this element can handle events */
97 GST_ELEMENT_EVENT_AWARE,
99 /* use some padding for future expansion */
100 GST_ELEMENT_FLAG_LAST = GST_OBJECT_FLAG_LAST + 12,
103 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
104 #define GST_ELEMENT_IS_EOS(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
105 #define GST_ELEMENT_IS_EVENT_AWARE(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
106 #define GST_ELEMENT_IS_DECOUPLED(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
108 #define GST_ELEMENT_NAME(obj) (GST_OBJECT_NAME(obj))
109 #define GST_ELEMENT_PARENT(obj) (GST_OBJECT_PARENT(obj))
110 #define GST_ELEMENT_MANAGER(obj) (((GstElement*)(obj))->manager)
111 #define GST_ELEMENT_SCHED(obj) (((GstElement*)(obj))->sched)
112 #define GST_ELEMENT_CLOCK(obj) (((GstElement*)(obj))->clock)
113 #define GST_ELEMENT_PADS(obj) ((obj)->pads)
115 /*typedef struct _GstElement GstElement;*/
116 /*typedef struct _GstElementClass GstElementClass;*/
117 typedef struct _GstElementFactory GstElementFactory;
118 typedef struct _GstElementFactoryClass GstElementFactoryClass;
120 typedef void (*GstElementLoopFunction) (GstElement *element);
121 typedef void (*GstElementSetClockFunction) (GstElement *element, GstClock *clock);
122 typedef GstClock* (*GstElementGetClockFunction) (GstElement *element);
127 /* element state and scheduling */
128 guint8 current_state;
129 guint8 pending_state;
131 GstElementLoopFunction loopfunc;
134 gpointer sched_private;
135 GstElementSetClockFunction setclockfunc;
136 GstElementGetClockFunction getclockfunc;
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 /* change the element state */
171 GstElementStateReturn (*change_state) (GstElement *element);
172 /* request a new pad */
173 GstPad* (*request_new_pad) (GstElement *element, GstPadTemplate *templ, const gchar* name);
174 void (*send_event) (GstElement *element, GstEvent *event);
177 void gst_element_class_add_padtemplate (GstElementClass *klass, GstPadTemplate *templ);
179 GType gst_element_get_type (void);
180 #define gst_element_destroy(element) gst_object_destroy (GST_OBJECT (element))
182 void gst_element_set_loop_function (GstElement *element,
183 GstElementLoopFunction loop);
185 void gst_element_set_name (GstElement *element, const gchar *name);
186 const gchar* gst_element_get_name (GstElement *element);
188 void gst_element_set_parent (GstElement *element, GstObject *parent);
189 GstObject* gst_element_get_parent (GstElement *element);
191 GstClock* gst_element_get_clock (GstElement *element);
192 void gst_element_set_clock (GstElement *element, GstClock *clock);
193 GstClockReturn gst_element_clock_wait (GstElement *element, GstClock *clock, GstClockTime time);
195 void gst_element_yield (GstElement *element);
196 gboolean gst_element_interrupt (GstElement *element);
197 void gst_element_set_sched (GstElement *element, GstScheduler *sched);
198 GstScheduler* gst_element_get_sched (GstElement *element);
200 void gst_element_add_pad (GstElement *element, GstPad *pad);
201 void gst_element_remove_pad (GstElement *element, GstPad *pad);
202 GstPad* gst_element_get_pad (GstElement *element, const gchar *name);
203 GList* gst_element_get_pad_list (GstElement *element);
204 GList* gst_element_get_padtemplate_list (GstElement *element);
205 GstPadTemplate* gst_element_get_padtemplate_by_name (GstElement *element, const guchar *name);
206 GstPad * gst_element_add_ghost_pad (GstElement *element, GstPad *pad, gchar *name);
207 void gst_element_remove_ghost_pad (GstElement *element, GstPad *pad);
209 GstPad* gst_element_request_compatible_pad (GstElement *element, GstPadTemplate *templ);
210 GstPad* gst_element_request_pad_by_name (GstElement *element, const gchar *name);
211 GstPad* gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad,
212 GstCaps *filtercaps);
213 GstPad* gst_element_get_compatible_pad (GstElement *element, GstPad *pad);
215 /* these functions should probably have another name, but gst_element_connect is already used */
216 gboolean gst_element_connect_elements (GstElement *src, GstElement *dest);
217 gboolean gst_element_connect_elements_filtered (GstElement *src, GstElement *dest,
218 GstCaps *filtercaps);
219 gboolean gst_element_connect (GstElement *src, const gchar *srcpadname,
220 GstElement *dest, const gchar *destpadname);
221 gboolean gst_element_connect_filtered (GstElement *src, const gchar *srcpadname,
222 GstElement *dest, const gchar *destpadname,
223 GstCaps *filtercaps);
224 void gst_element_disconnect (GstElement *src, const gchar *srcpadname,
225 GstElement *dest, const gchar *destpadname);
226 void gst_element_disconnect_elements (GstElement *src, GstElement *dest);
227 gboolean gst_element_connect_elements_many (GstElement *element_1, GstElement *element_2, ...);
229 void gst_element_set_eos (GstElement *element);
231 void gst_element_send_event (GstElement *element, GstEvent *event);
234 GstElementState gst_element_get_state (GstElement *element);
235 gint gst_element_set_state (GstElement *element, GstElementState state);
237 void gst_element_wait_state_change (GstElement *element);
239 const gchar* gst_element_statename (GstElementState state);
241 void gst_element_info (GstElement *element, const gchar *info, ...);
242 void gst_element_error (GstElement *element, const gchar *error, ...);
244 GstElementFactory* gst_element_get_factory (GstElement *element);
246 void gst_element_install_std_props (GstElementClass *klass,
247 const char *first_name, ...);
255 typedef struct _GstElementDetails GstElementDetails;
257 struct _GstElementDetails {
258 gchar *longname; /* long, english name */
259 gchar *klass; /* type of element, as hierarchy */
260 gchar *description; /* insights of one form or another */
261 gchar *version; /* version of the element */
262 gchar *author; /* who wrote this thing? */
263 gchar *copyright; /* copyright details (year, etc.) */
266 #define GST_TYPE_ELEMENTFACTORY (gst_elementfactory_get_type())
267 #define GST_ELEMENTFACTORY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENTFACTORY,\
269 #define GST_ELEMENTFACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENTFACTORY,\
270 GstElementFactoryClass))
271 #define GST_IS_ELEMENTFACTORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENTFACTORY))
272 #define GST_IS_ELEMENTFACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENTFACTORY))
274 struct _GstElementFactory {
275 GstPluginFeature feature;
277 GType type; /* unique GType of element */
279 guint details_dynamic : 1;
281 GstElementDetails *details; /* pointer to details struct */
284 guint16 numpadtemplates;
287 struct _GstElementFactoryClass {
288 GstPluginFeatureClass parent_class;
291 GType gst_elementfactory_get_type (void);
293 GstElementFactory* gst_elementfactory_new (const gchar *name,GType type,
294 GstElementDetails *details);
296 GstElementFactory* gst_elementfactory_find (const gchar *name);
297 const GList* gst_elementfactory_get_list (void);
299 void gst_elementfactory_add_padtemplate (GstElementFactory *elementfactory,
300 GstPadTemplate *templ);
302 gboolean gst_elementfactory_can_src_caps (GstElementFactory *factory,
304 gboolean gst_elementfactory_can_sink_caps (GstElementFactory *factory,
307 GstElement* gst_elementfactory_create (GstElementFactory *factory,
309 /* FIXME this name is wrong, probably so is the one above it */
310 GstElement* gst_elementfactory_make (const gchar *factoryname, const gchar *name);
314 #endif /* __cplusplus */
317 #endif /* __GST_ELEMENT_H__ */