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>
40 #include <gst/gstdparammanager.h>
44 #endif /* __cplusplus */
48 GST_STATE_VOID_PENDING = 0,
49 GST_STATE_NULL = (1 << 0),
50 GST_STATE_READY = (1 << 1),
51 GST_STATE_PAUSED = (1 << 2),
52 GST_STATE_PLAYING = (1 << 3),
56 GST_STATE_FAILURE = 0,
57 GST_STATE_SUCCESS = 1,
59 } GstElementStateReturn;
62 // NOTE: this probably should be done with an #ifdef to decide whether to safe-cast
63 // or to just do the non-checking cast.
64 #define GST_STATE(obj) (GST_ELEMENT(obj)->current_state)
65 #define GST_STATE_PENDING(obj) (GST_ELEMENT(obj)->pending_state)
67 // Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g>
68 #define GST_STATE_TRANSITION(obj) ((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
69 #define GST_STATE_NULL_TO_READY ((GST_STATE_NULL<<8) | GST_STATE_READY)
70 #define GST_STATE_READY_TO_PAUSED ((GST_STATE_READY<<8) | GST_STATE_PAUSED)
71 #define GST_STATE_PAUSED_TO_PLAYING ((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
72 #define GST_STATE_PLAYING_TO_PAUSED ((GST_STATE_PLAYING<<8) | GST_STATE_PAUSED)
73 #define GST_STATE_PAUSED_TO_READY ((GST_STATE_PAUSED<<8) | GST_STATE_READY)
74 #define GST_STATE_READY_TO_NULL ((GST_STATE_READY<<8) | GST_STATE_NULL)
76 #define GST_TYPE_ELEMENT \
77 (gst_element_get_type())
78 #define GST_ELEMENT(obj) \
79 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT,GstElement))
80 #define GST_ELEMENT_CLASS(klass) \
81 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT,GstElementClass))
82 #define GST_IS_ELEMENT(obj) \
83 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT))
84 #define GST_IS_ELEMENT_CLASS(klass) \
85 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT))
88 /* element is complex (for some def.) and generally require a cothread */
89 GST_ELEMENT_COMPLEX = GST_OBJECT_FLAG_LAST,
90 /* input and output pads aren't directly coupled to each other
91 examples: queues, multi-output async readers, etc. */
92 GST_ELEMENT_DECOUPLED,
93 /* this element should be placed in a thread if at all possible */
94 GST_ELEMENT_THREAD_SUGGESTED,
95 /* this element is incable of seeking (FIXME: does this apply to filters?) */
98 /***** !!!!! need to have a flag that says that an element must
99 *not* be an entry into a scheduling chain !!!!! *****/
100 /* this element for some reason doesn't obey COTHREAD_STOPPING, or
101 has some other reason why it can't be the entry */
102 GST_ELEMENT_NO_ENTRY,
104 /* there is a new loopfunction ready for placement */
105 GST_ELEMENT_NEW_LOOPFUNC,
106 /* the cothread holding this element needs to be stopped */
107 GST_ELEMENT_COTHREAD_STOPPING,
108 /* the element has to be scheduled as a cothread for any sanity */
109 GST_ELEMENT_USE_COTHREAD,
111 /* if this element is in EOS */
114 /* use some padding for future expansion */
115 GST_ELEMENT_FLAG_LAST = GST_OBJECT_FLAG_LAST + 12,
118 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
119 #define GST_ELEMENT_IS_COTHREAD_STOPPING(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_COTHREAD_STOPPING))
120 #define GST_ELEMENT_IS_EOS(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
122 #define GST_ELEMENT_NAME(obj) (GST_OBJECT_NAME(obj))
123 #define GST_ELEMENT_PARENT(obj) (GST_OBJECT_PARENT(obj))
124 #define GST_ELEMENT_MANAGER(obj) (((GstElement*)(obj))->manager)
125 #define GST_ELEMENT_SCHED(obj) (((GstElement*)(obj))->sched)
126 #define GST_ELEMENT_PADS(obj) ((obj)->pads)
127 #define GST_ELEMENT_DPARAM_MANAGER(obj) ((obj)->dpman)
129 //typedef struct _GstElement GstElement;
130 //typedef struct _GstElementClass GstElementClass;
131 typedef struct _GstElementFactory GstElementFactory;
132 typedef struct _GstElementFactoryClass GstElementFactoryClass;
134 typedef void (*GstElementLoopFunction) (GstElement *element);
139 guint8 current_state;
140 guint8 pending_state;
142 GstElementLoopFunction loopfunc;
143 cothread_state *threadstate;
153 GstDParamManager *dpman;
156 struct _GstElementClass {
157 GstObjectClass parent_class;
159 /* the elementfactory that created us */
160 GstElementFactory *elementfactory;
161 /* templates for our pads */
163 gint numpadtemplates;
165 /* signal callbacks */
166 void (*state_change) (GstElement *element,GstElementState state);
167 void (*new_pad) (GstElement *element,GstPad *pad);
168 void (*pad_removed) (GstElement *element,GstPad *pad);
169 void (*new_ghost_pad) (GstElement *element,GstPad *pad);
170 void (*ghost_pad_removed) (GstElement *element,GstPad *pad);
171 void (*error) (GstElement *element,gchar *error);
172 void (*eos) (GstElement *element);
174 /* local pointers for get/set */
175 void (*set_property) (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
176 void (*get_property) (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
178 /* change the element state */
179 GstElementStateReturn (*change_state) (GstElement *element);
180 /* request a new pad */
181 GstPad* (*request_new_pad) (GstElement *element, GstPadTemplate *templ);
184 void gst_element_class_add_padtemplate (GstElementClass *element, GstPadTemplate *templ);
186 GType gst_element_get_type (void);
187 #define gst_element_destroy(element) gst_object_destroy (GST_OBJECT (element))
189 void gst_element_set_loop_function (GstElement *element,
190 GstElementLoopFunction loop);
192 void gst_element_set_name (GstElement *element, const gchar *name);
193 const gchar* gst_element_get_name (GstElement *element);
195 void gst_element_set_parent (GstElement *element, GstObject *parent);
196 GstObject* gst_element_get_parent (GstElement *element);
198 void gst_element_set_sched (GstElement *element, GstSchedule *sched);
199 GstSchedule* gst_element_get_sched (GstElement *element);
201 void gst_element_add_pad (GstElement *element, GstPad *pad);
202 void gst_element_remove_pad (GstElement *element, GstPad *pad);
203 GstPad* gst_element_get_pad (GstElement *element, const gchar *name);
204 GList* gst_element_get_pad_list (GstElement *element);
205 GList* gst_element_get_padtemplate_list (GstElement *element);
206 GstPadTemplate* gst_element_get_padtemplate_by_name (GstElement *element, const guchar *name);
207 void gst_element_add_ghost_pad (GstElement *element, GstPad *pad, gchar *name);
208 void gst_element_remove_ghost_pad (GstElement *element, GstPad *pad);
210 GstPad* gst_element_request_compatible_pad (GstElement *element, GstPadTemplate *templ);
211 GstPad* gst_element_request_pad_by_name (GstElement *element, const gchar *name);
213 void gst_element_connect (GstElement *src, const gchar *srcpadname,
214 GstElement *dest, const gchar *destpadname);
215 void gst_element_disconnect (GstElement *src, const gchar *srcpadname,
216 GstElement *dest, const gchar *destpadname);
218 void gst_element_signal_eos (GstElement *element);
221 /* called by the app to set the state of the element */
222 gint gst_element_set_state (GstElement *element, GstElementState state);
223 const gchar * gst_element_statename (GstElementState state);
225 void gst_element_error (GstElement *element, const gchar *error);
227 GstElementFactory* gst_element_get_factory (GstElement *element);
229 /* XML write and read */
230 GstElement* gst_element_restore_thyself (xmlNodePtr self, GstObject *parent);
238 typedef struct _GstElementDetails GstElementDetails;
240 struct _GstElementDetails {
241 gchar *longname; /* long, english name */
242 gchar *klass; /* type of element, as hierarchy */
243 gchar *description; /* insights of one form or another */
244 gchar *version; /* version of the element */
245 gchar *author; /* who wrote this thing? */
246 gchar *copyright; /* copyright details (year, etc.) */
249 #define GST_TYPE_ELEMENTFACTORY \
250 (gst_elementfactory_get_type())
251 #define GST_ELEMENTFACTORY(obj) \
252 (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENTFACTORY,GstElementFactory))
253 #define GST_ELEMENTFACTORY_CLASS(klass) \
254 (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENTFACTORY,GstElementFactoryClass))
255 #define GST_IS_ELEMENTFACTORY(obj) \
256 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENTFACTORY))
257 #define GST_IS_ELEMENTFACTORY_CLASS(klass) \
258 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENTFACTORY))
260 struct _GstElementFactory {
261 GstPluginFeature feature;
263 GType type; /* unique GType of element */
265 GstElementDetails *details; /* pointer to details struct */
268 guint16 numpadtemplates;
271 struct _GstElementFactoryClass {
272 GstPluginFeatureClass parent_class;
275 GType gst_elementfactory_get_type (void);
277 GstElementFactory* gst_elementfactory_new (const gchar *name,GType type,
278 GstElementDetails *details);
280 GstElementFactory* gst_elementfactory_find (const gchar *name);
281 const GList* gst_elementfactory_get_list (void);
283 void gst_elementfactory_add_padtemplate (GstElementFactory *elementfactory,
284 GstPadTemplate *templ);
286 gboolean gst_elementfactory_can_src_caps (GstElementFactory *factory,
288 gboolean gst_elementfactory_can_sink_caps (GstElementFactory *factory,
291 GstElement* gst_elementfactory_create (GstElementFactory *factory,
293 /* FIXME this name is wrong, probably so is the one above it */
294 GstElement* gst_elementfactory_make (const gchar *factoryname, const gchar *name);
299 #endif /* __cplusplus */
302 #endif /* __GST_ELEMENT_H__ */