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 <parser.h> // NOTE: this is xml-config's fault
29 // Include compatability defines: if libxml hasn't already defined these,
30 // we have an old version 1.x
31 #ifndef xmlChildrenNode
32 #define xmlChildrenNode childs
33 #define xmlRootNode root
36 #include <gst/gstobject.h>
37 #include <gst/gstpad.h>
38 #include <gst/cothreads.h>
39 #include <gst/gstpluginfeature.h>
43 #endif /* __cplusplus */
47 GST_STATE_VOID_PENDING = 0,
48 GST_STATE_NULL = (1 << 0),
49 GST_STATE_READY = (1 << 1),
50 GST_STATE_PAUSED = (1 << 2),
51 GST_STATE_PLAYING = (1 << 3),
55 GST_STATE_FAILURE = 0,
56 GST_STATE_SUCCESS = 1,
58 } GstElementStateReturn;
61 // NOTE: this probably should be done with an #ifdef to decide whether to safe-cast
62 // or to just do the non-checking cast.
63 #define GST_STATE(obj) (GST_ELEMENT(obj)->current_state)
64 #define GST_STATE_PENDING(obj) (GST_ELEMENT(obj)->pending_state)
66 // Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g>
67 #define GST_STATE_TRANSITION(obj) ((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
68 #define GST_STATE_NULL_TO_READY ((GST_STATE_NULL<<8) | GST_STATE_READY)
69 #define GST_STATE_READY_TO_PAUSED ((GST_STATE_READY<<8) | GST_STATE_PAUSED)
70 #define GST_STATE_PAUSED_TO_PLAYING ((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
71 #define GST_STATE_PLAYING_TO_PAUSED ((GST_STATE_PLAYING<<8) | GST_STATE_PAUSED)
72 #define GST_STATE_PAUSED_TO_READY ((GST_STATE_PAUSED<<8) | GST_STATE_READY)
73 #define GST_STATE_READY_TO_NULL ((GST_STATE_READY<<8) | GST_STATE_NULL)
75 #define GST_TYPE_ELEMENT \
76 (gst_element_get_type())
77 #define GST_ELEMENT(obj) \
78 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT,GstElement))
79 #define GST_ELEMENT_CLASS(klass) \
80 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT,GstElementClass))
81 #define GST_IS_ELEMENT(obj) \
82 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT))
83 #define GST_IS_ELEMENT_CLASS(klass) \
84 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT))
87 /* element is complex (for some def.) and generally require a cothread */
88 GST_ELEMENT_COMPLEX = GST_OBJECT_FLAG_LAST,
89 /* input and output pads aren't directly coupled to each other
90 examples: queues, multi-output async readers, etc. */
91 GST_ELEMENT_DECOUPLED,
92 /* this element should be placed in a thread if at all possible */
93 GST_ELEMENT_THREAD_SUGGESTED,
94 /* this element is incable of seeking (FIXME: does this apply to filters?) */
97 /***** !!!!! need to have a flag that says that an element must
98 *not* be an entry into a scheduling chain !!!!! *****/
99 /* this element for some reason doesn't obey COTHREAD_STOPPING, or
100 has some other reason why it can't be the entry */
101 GST_ELEMENT_NO_ENTRY,
103 /* there is a new loopfunction ready for placement */
104 GST_ELEMENT_NEW_LOOPFUNC,
105 /* the cothread holding this element needs to be stopped */
106 GST_ELEMENT_COTHREAD_STOPPING,
107 /* the element has to be scheduled as a cothread for any sanity */
108 GST_ELEMENT_USE_COTHREAD,
110 /* if this element is in EOS */
113 /* use some padding for future expansion */
114 GST_ELEMENT_FLAG_LAST = GST_OBJECT_FLAG_LAST + 12,
117 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
118 #define GST_ELEMENT_IS_COTHREAD_STOPPING(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_COTHREAD_STOPPING))
119 #define GST_ELEMENT_IS_EOS(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
121 #define GST_ELEMENT_NAME(obj) (GST_OBJECT_NAME(obj))
122 #define GST_ELEMENT_PARENT(obj) (GST_OBJECT_PARENT(obj))
123 #define GST_ELEMENT_MANAGER(obj) (((GstElement*)(obj))->manager)
124 #define GST_ELEMENT_SCHED(obj) (((GstElement*)(obj))->sched)
125 #define GST_ELEMENT_PADS(obj) ((obj)->pads)
127 //typedef struct _GstElement GstElement;
128 //typedef struct _GstElementClass GstElementClass;
129 typedef struct _GstElementFactory GstElementFactory;
130 typedef struct _GstElementFactoryClass GstElementFactoryClass;
132 typedef void (*GstElementLoopFunction) (GstElement *element);
137 guint8 current_state;
138 guint8 pending_state;
140 GstElementLoopFunction loopfunc;
141 cothread_state *threadstate;
153 struct _GstElementClass {
154 GstObjectClass parent_class;
156 /* the elementfactory that created us */
157 GstElementFactory *elementfactory;
158 /* templates for our pads */
160 gint numpadtemplates;
162 /* signal callbacks */
163 void (*state_change) (GstElement *element,GstElementState state);
164 void (*new_pad) (GstElement *element,GstPad *pad);
165 void (*pad_removed) (GstElement *element,GstPad *pad);
166 void (*new_ghost_pad) (GstElement *element,GstPad *pad);
167 void (*ghost_pad_removed) (GstElement *element,GstPad *pad);
168 void (*error) (GstElement *element,gchar *error);
169 void (*eos) (GstElement *element);
171 /* local pointers for get/set */
172 void (*set_property) (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
173 void (*get_property) (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
175 /* change the element state */
176 GstElementStateReturn (*change_state) (GstElement *element);
177 /* request a new pad */
178 GstPad* (*request_new_pad) (GstElement *element, GstPadTemplate *templ);
181 void gst_element_class_add_padtemplate (GstElementClass *element, GstPadTemplate *templ);
183 GType gst_element_get_type (void);
184 #define gst_element_destroy(element) gst_object_destroy (GST_OBJECT (element))
186 void gst_element_set_loop_function (GstElement *element,
187 GstElementLoopFunction loop);
189 void gst_element_set_name (GstElement *element, const gchar *name);
190 const gchar* gst_element_get_name (GstElement *element);
192 void gst_element_set_parent (GstElement *element, GstObject *parent);
193 GstObject* gst_element_get_parent (GstElement *element);
195 void gst_element_set_sched (GstElement *element, GstSchedule *sched);
196 GstSchedule* 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_get_pad (GstElement *element, const gchar *name);
201 GList* gst_element_get_pad_list (GstElement *element);
202 GList* gst_element_get_padtemplate_list (GstElement *element);
203 GstPadTemplate* gst_element_get_padtemplate_by_name (GstElement *element, const guchar *name);
204 void gst_element_add_ghost_pad (GstElement *element, GstPad *pad, gchar *name);
205 void gst_element_remove_ghost_pad (GstElement *element, GstPad *pad);
207 GstPad* gst_element_request_compatible_pad (GstElement *element, GstPadTemplate *templ);
208 GstPad* gst_element_request_pad_by_name (GstElement *element, const gchar *name);
210 void gst_element_connect (GstElement *src, const gchar *srcpadname,
211 GstElement *dest, const gchar *destpadname);
212 void gst_element_disconnect (GstElement *src, const gchar *srcpadname,
213 GstElement *dest, const gchar *destpadname);
215 void gst_element_signal_eos (GstElement *element);
218 /* called by the app to set the state of the element */
219 gint gst_element_set_state (GstElement *element, GstElementState state);
220 const gchar * gst_element_statename (GstElementState state);
222 void gst_element_error (GstElement *element, const gchar *error);
224 GstElementFactory* gst_element_get_factory (GstElement *element);
226 /* XML write and read */
227 GstElement* gst_element_restore_thyself (xmlNodePtr self, GstObject *parent);
235 typedef struct _GstElementDetails GstElementDetails;
237 struct _GstElementDetails {
238 gchar *longname; /* long, english name */
239 gchar *klass; /* type of element, as hierarchy */
240 gchar *description; /* insights of one form or another */
241 gchar *version; /* version of the element */
242 gchar *author; /* who wrote this thing? */
243 gchar *copyright; /* copyright details (year, etc.) */
246 #define GST_TYPE_ELEMENTFACTORY \
247 (gst_elementfactory_get_type())
248 #define GST_ELEMENTFACTORY(obj) \
249 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENTFACTORY,GstElementFactory))
250 #define GST_ELEMENTFACTORY_CLASS(klass) \
251 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENTFACTORY,GstElementFactoryClass))
252 #define GST_IS_ELEMENTFACTORY(obj) \
253 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENTFACTORY))
254 #define GST_IS_ELEMENTFACTORY_CLASS(klass) \
255 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENTFACTORY))
257 struct _GstElementFactory {
258 GstPluginFeature feature;
260 GType type; /* unique GType of element */
262 GstElementDetails *details; /* pointer to details struct */
265 guint16 numpadtemplates;
268 struct _GstElementFactoryClass {
269 GstPluginFeatureClass parent_class;
272 GType gst_elementfactory_get_type (void);
274 GstElementFactory* gst_elementfactory_new (const gchar *name,GType type,
275 GstElementDetails *details);
277 GstElementFactory* gst_elementfactory_find (const gchar *name);
278 const GList* gst_elementfactory_get_list (void);
280 void gst_elementfactory_add_padtemplate (GstElementFactory *elementfactory,
281 GstPadTemplate *templ);
283 gboolean gst_elementfactory_can_src_caps (GstElementFactory *factory,
285 gboolean gst_elementfactory_can_sink_caps (GstElementFactory *factory,
288 GstElement* gst_elementfactory_create (GstElementFactory *factory,
290 /* FIXME this name is wrong, probably so is the one above it */
291 GstElement* gst_elementfactory_make (const gchar *factoryname, const gchar *name);
296 #endif /* __cplusplus */
299 #endif /* __GST_ELEMENT_H__ */