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>
42 #endif /* __cplusplus */
46 GST_STATE_NONE_PENDING = 0,
47 GST_STATE_NULL = (1 << 0),
48 GST_STATE_READY = (1 << 1),
49 GST_STATE_PLAYING = (1 << 2),
50 GST_STATE_PAUSED = (1 << 3),
54 GST_STATE_FAILURE = 0,
55 GST_STATE_SUCCESS = 1,
57 } GstElementStateReturn;
59 static inline char *_gst_print_statename(int state) {
61 case GST_STATE_NONE_PENDING: return "NONE_PENDING";break;
62 case GST_STATE_NULL: return "NULL";break;
63 case GST_STATE_READY: return "READY";break;
64 case GST_STATE_PLAYING: return "PLAYING";break;
65 case GST_STATE_PAUSED: return "PAUSED";break;
71 #define GST_STATE(obj) (GST_ELEMENT(obj)->current_state)
72 #define GST_STATE_PENDING(obj) (GST_ELEMENT(obj)->pending_state)
74 // Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g>
75 #define GST_STATE_TRANSITION(obj) ((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
76 #define GST_STATE_NULL_TO_READY ((GST_STATE_NULL<<8) | GST_STATE_READY)
77 #define GST_STATE_READY_TO_PLAYING ((GST_STATE_READY<<8) | GST_STATE_PLAYING)
78 #define GST_STATE_PLAYING_TO_PAUSED ((GST_STATE_PLAYING<<8) | GST_STATE_PAUSED)
79 #define GST_STATE_PAUSED_TO_PLAYING ((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
80 #define GST_STATE_PLAYING_TO_READY ((GST_STATE_PLAYING<<8) | GST_STATE_READY)
81 #define GST_STATE_READY_TO_NULL ((GST_STATE_READY<<8) | GST_STATE_NULL)
83 #define GST_TYPE_ELEMENT \
84 (gst_element_get_type())
85 #define GST_ELEMENT(obj) \
86 (GTK_CHECK_CAST((obj),GST_TYPE_ELEMENT,GstElement))
87 #define GST_ELEMENT_CLASS(klass) \
88 (GTK_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT,GstElementClass))
89 #define GST_IS_ELEMENT(obj) \
90 (GTK_CHECK_TYPE((obj),GST_TYPE_ELEMENT))
91 #define GST_IS_ELEMENT_CLASS(klass) \
92 (GTK_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT))
95 /* element is complex (for some def.) and generally require a cothread */
96 GST_ELEMENT_COMPLEX = GST_OBJECT_FLAG_LAST,
97 /* input and output pads aren't directly coupled to each other
98 examples: queues, multi-output async readers, etc. */
99 GST_ELEMENT_DECOUPLED,
100 /* this element should be placed in a thread if at all possible */
101 GST_ELEMENT_THREAD_SUGGESTED,
102 /* this element is incable of seeking (FIXME: does this apply to filters?) */
105 /***** !!!!! need to have a flag that says that an element must
106 *not* be an entry into a scheduling chain !!!!! *****/
108 /* there is a new loopfunction ready for placement */
109 GST_ELEMENT_NEW_LOOPFUNC,
110 /* the cothread holding this element needs to be stopped */
111 GST_ELEMENT_COTHREAD_STOPPING,
112 /* the element has to be scheduled as a cothread for any sanity */
113 GST_ELEMENT_USE_COTHREAD,
115 /* if this element is in EOS */
118 /* use some padding for future expansion */
119 GST_ELEMENT_FLAG_LAST = GST_OBJECT_FLAG_LAST + 8,
122 #define GST_ELEMENT_IS_THREAD_SUGGESTED(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
123 #define GST_ELEMENT_IS_COTHREAD_STOPPING(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_COTHREAD_STOPPING))
124 #define GST_ELEMENT_IS_EOS(obj) (GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
126 #define GST_ELEMENT_NAME(obj) (GST_OBJECT_NAME(obj))
127 #define GST_ELEMENT_PARENT(obj) (GST_OBJECT_PARENT(obj))
128 #define GST_ELEMENT_PADS(obj) ((obj)->pads)
130 typedef struct _GstElement GstElement;
131 typedef struct _GstElementClass GstElementClass;
132 typedef struct _GstElementDetails GstElementDetails;
133 typedef struct _GstElementFactory GstElementFactory;
135 typedef void (*GstElementLoopFunction) (GstElement *element);
140 guint8 current_state;
141 guint8 pending_state;
143 GstElementLoopFunction loopfunc;
144 cothread_state *threadstate;
154 struct _GstElementClass {
155 GstObjectClass parent_class;
157 /* the elementfactory that created us */
158 GstElementFactory *elementfactory;
160 /* signal callbacks */
161 void (*state_change) (GstElement *element,GstElementState state);
162 void (*new_pad) (GstElement *element,GstPad *pad);
163 void (*new_ghost_pad) (GstElement *element,GstPad *pad);
164 void (*error) (GstElement *element,gchar *error);
165 void (*eos) (GstElement *element);
167 /* change the element state */
168 GstElementStateReturn (*change_state) (GstElement *element);
169 /* request a new pad */
170 GstPad* (*request_new_pad) (GstElement *element, GstPadTemplate *templ);
173 struct _GstElementDetails {
174 gchar *longname; /* long, english name */
175 gchar *klass; /* type of element, as hierarchy */
176 gchar *description; /* insights of one form or another */
177 gchar *version; /* version of the element */
178 gchar *author; /* who wrote this thing? */
179 gchar *copyright; /* copyright details (year, etc.) */
182 struct _GstElementFactory {
183 gchar *name; /* name of element */
184 GtkType type; /* unique GtkType of element */
186 GstElementDetails *details; /* pointer to details struct */
189 guint16 numpadtemplates;
192 GtkType gst_element_get_type (void);
193 GstElement* gst_element_new (void);
194 #define gst_element_destroy(element) gst_object_destroy (GST_OBJECT (element))
196 void gst_element_set_loop_function (GstElement *element,
197 GstElementLoopFunction loop);
199 void gst_element_set_name (GstElement *element, const gchar *name);
200 const gchar* gst_element_get_name (GstElement *element);
202 void gst_element_set_parent (GstElement *element, GstObject *parent);
203 GstObject* gst_element_get_parent (GstElement *element);
205 void gst_element_set_manager (GstElement *element, GstElement *manager);
206 GstElement* gst_element_get_manager (GstElement *element);
208 void gst_element_add_pad (GstElement *element, GstPad *pad);
209 GstPad* gst_element_get_pad (GstElement *element, const gchar *name);
210 GList* gst_element_get_pad_list (GstElement *element);
211 GList* gst_element_get_padtemplate_list (GstElement *element);
212 GstPadTemplate* gst_element_get_padtemplate_by_name (GstElement *element, const guchar *name);
213 void gst_element_add_ghost_pad (GstElement *element, GstPad *pad, gchar *name);
214 void gst_element_remove_ghost_pad (GstElement *element, GstPad *pad);
216 GstPad* gst_element_request_compatible_pad (GstElement *element, GstPadTemplate *templ);
217 GstPad* gst_element_request_pad_by_name (GstElement *element, const gchar *name);
219 void gst_element_connect (GstElement *src, const gchar *srcpadname,
220 GstElement *dest, const gchar *destpadname);
221 void gst_element_disconnect (GstElement *src, const gchar *srcpadname,
222 GstElement *dest, const gchar *destpadname);
224 void gst_element_signal_eos (GstElement *element);
227 /* called by the app to set the state of the element */
228 gint gst_element_set_state (GstElement *element, GstElementState state);
230 void gst_element_error (GstElement *element, const gchar *error);
232 GstElementFactory* gst_element_get_factory (GstElement *element);
234 /* XML write and read */
235 GstElement* gst_element_load_thyself (xmlNodePtr self, GstObject *parent);
243 GstElementFactory* gst_elementfactory_new (const gchar *name,GtkType type,
244 GstElementDetails *details);
245 void gst_elementfactory_destroy (GstElementFactory *elementfactory);
247 GstElementFactory* gst_elementfactory_find (const gchar *name);
248 GList* gst_elementfactory_get_list (void);
250 void gst_elementfactory_add_padtemplate (GstElementFactory *elementfactory,
251 GstPadTemplate *templ);
253 gboolean gst_elementfactory_can_src_caps (GstElementFactory *factory,
255 gboolean gst_elementfactory_can_sink_caps (GstElementFactory *factory,
257 gboolean gst_elementfactory_can_src_caps (GstElementFactory *factory,
259 gboolean gst_elementfactory_can_sink_caps (GstElementFactory *factory,
262 GstElement* gst_elementfactory_create (GstElementFactory *factory,
264 /* FIXME this name is wrong, probably so is the one above it */
265 GstElement* gst_elementfactory_make (const gchar *factoryname, const gchar *name);
267 xmlNodePtr gst_elementfactory_save_thyself (GstElementFactory *factory, xmlNodePtr parent);
268 GstElementFactory* gst_elementfactory_load_thyself (xmlNodePtr parent);
272 #endif /* __cplusplus */
275 #endif /* __GST_ELEMENT_H__ */