gstelement.h 11.3 KB
Newer Older
1 2 3 4 5
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wtay@chello.be>
 *
 * gstelement.h: Header for GstElement
Erik Walthinsen's avatar
Erik Walthinsen committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */


#ifndef __GST_ELEMENT_H__
#define __GST_ELEMENT_H__

27
#include <gst/gstconfig.h>
Richard Boulton's avatar
Richard Boulton committed
28

Erik Walthinsen's avatar
Erik Walthinsen committed
29 30 31
#include <gst/gstobject.h>
#include <gst/gstpad.h>
#include <gst/cothreads.h>
32
#include <gst/gstpluginfeature.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
33 34 35 36 37

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

38
#define GST_NUM_STATES 4
Erik Walthinsen's avatar
Erik Walthinsen committed
39

40
typedef enum {
41
  GST_STATE_VOID_PENDING	= 0,
42 43
  GST_STATE_NULL		= (1 << 0),
  GST_STATE_READY		= (1 << 1),
44 45
  GST_STATE_PAUSED		= (1 << 2),
  GST_STATE_PLAYING		= (1 << 3),
46 47 48
} GstElementState;

typedef enum {
49 50 51
  GST_STATE_FAILURE		= 0,
  GST_STATE_SUCCESS		= 1,
  GST_STATE_ASYNC		= 2,
52 53
} GstElementStateReturn;

Erik Walthinsen's avatar
Erik Walthinsen committed
54

55 56 57
/* NOTE: this probably should be done with an #ifdef to decide 
 * whether to safe-cast or to just do the non-checking cast.
 */
58 59 60
#define GST_STATE(obj)			(GST_ELEMENT(obj)->current_state)
#define GST_STATE_PENDING(obj)		(GST_ELEMENT(obj)->pending_state)

61
/* Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g> */
62
#define GST_STATE_TRANSITION(obj)	((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
63
#define GST_STATE_NULL_TO_READY		((GST_STATE_NULL<<8) | GST_STATE_READY)
64
#define GST_STATE_READY_TO_PAUSED	((GST_STATE_READY<<8) | GST_STATE_PAUSED)
65
#define GST_STATE_PAUSED_TO_PLAYING	((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
66 67
#define GST_STATE_PLAYING_TO_PAUSED	((GST_STATE_PLAYING<<8) | GST_STATE_PAUSED)
#define GST_STATE_PAUSED_TO_READY	((GST_STATE_PAUSED<<8) | GST_STATE_READY)
68
#define GST_STATE_READY_TO_NULL		((GST_STATE_READY<<8) | GST_STATE_NULL)
69

70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
extern GType _gst_element_type;

#define GST_TYPE_ELEMENT		(_gst_element_type)

#define GST_ELEMENT_FAST(obj)		((GstElement*)(obj))
#define GST_ELEMENT_CLASS_FAST(klass)	((GstElementClass*)(klass))
#define GST_IS_ELEMENT(obj)		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
#define GST_IS_ELEMENT_CLASS(obj)	(G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))

#ifdef GST_TYPE_PARANOID
# define GST_ELEMENT(obj)		(G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
# define GST_ELEMENT_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
#else
# define GST_ELEMENT                    GST_ELEMENT_FAST
# define GST_ELEMENT_CLASS              GST_ELEMENT_CLASS_FAST
#endif
Erik Walthinsen's avatar
Erik Walthinsen committed
86

87
typedef enum {
Wim Taymans's avatar
Wim Taymans committed
88
  /* element is complex (for some def.) and generally require a cothread */
89
  GST_ELEMENT_COMPLEX		= GST_OBJECT_FLAG_LAST,
Wim Taymans's avatar
Wim Taymans committed
90 91
  /* input and output pads aren't directly coupled to each other
     examples: queues, multi-output async readers, etc. */
92
  GST_ELEMENT_DECOUPLED,
Wim Taymans's avatar
Wim Taymans committed
93
  /* this element should be placed in a thread if at all possible */
94
  GST_ELEMENT_THREAD_SUGGESTED,
Wim Taymans's avatar
Wim Taymans committed
95
  /* this element is incable of seeking (FIXME: does this apply to filters?) */
96
  GST_ELEMENT_NO_SEEK,
97

98 99
  /***** !!!!! need to have a flag that says that an element must
    *not* be an entry into a scheduling chain !!!!! *****/
100 101 102
  /* this element for some reason doesn't obey COTHREAD_STOPPING, or
     has some other reason why it can't be the entry */
  GST_ELEMENT_NO_ENTRY,
103

Wim Taymans's avatar
Wim Taymans committed
104
  /* there is a new loopfunction ready for placement */
105
  GST_ELEMENT_NEW_LOOPFUNC,
Wim Taymans's avatar
Wim Taymans committed
106
  /* the cothread holding this element needs to be stopped */
107
  GST_ELEMENT_COTHREAD_STOPPING,
Wim Taymans's avatar
Wim Taymans committed
108
  /* the element has to be scheduled as a cothread for any sanity */
109
  GST_ELEMENT_USE_COTHREAD,
110

111 112 113
  /* if this element can handle events */
  GST_ELEMENT_EVENT_AWARE,

114
  /* use some padding for future expansion */
115
  GST_ELEMENT_FLAG_LAST		= GST_OBJECT_FLAG_LAST + 12,
116 117
} GstElementFlags;

118 119
#define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)	(GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
#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))
121
#define GST_ELEMENT_IS_EVENT_AWARE(obj)		(GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
122

123 124
#define GST_ELEMENT_NAME(obj)			(GST_OBJECT_NAME(obj))
#define GST_ELEMENT_PARENT(obj)			(GST_OBJECT_PARENT(obj))
125 126
#define GST_ELEMENT_MANAGER(obj)		(((GstElement*)(obj))->manager)
#define GST_ELEMENT_SCHED(obj)			(((GstElement*)(obj))->sched)
Wim Taymans's avatar
Wim Taymans committed
127
#define GST_ELEMENT_PADS(obj)			((obj)->pads)
128

129 130
/*typedef struct _GstElement GstElement;*/
/*typedef struct _GstElementClass GstElementClass;*/
Erik Walthinsen's avatar
Erik Walthinsen committed
131
typedef struct _GstElementFactory GstElementFactory;
132
typedef struct _GstElementFactoryClass GstElementFactoryClass;
Erik Walthinsen's avatar
Erik Walthinsen committed
133 134 135 136

typedef void (*GstElementLoopFunction) (GstElement *element);

struct _GstElement {
137
  GstObject 		object;
Erik Walthinsen's avatar
Erik Walthinsen committed
138

139 140 141 142
  /* element state  and scheduling */
  guint8 		current_state;
  guint8 		pending_state;
  GstElement 		*manager;
143
  GstScheduler 		*sched;
Erik Walthinsen's avatar
Erik Walthinsen committed
144
  GstElementLoopFunction loopfunc;
145 146 147 148 149 150 151 152
  cothread_state 	*threadstate;

  /* element pads */
  guint16 		numpads;
  guint16 		numsrcpads;
  guint16 		numsinkpads;
  GList 		*pads;
  GstPad 		*select_pad;
Erik Walthinsen's avatar
Erik Walthinsen committed
153 154 155
};

struct _GstElementClass {
156
  GstObjectClass 	parent_class;
Erik Walthinsen's avatar
Erik Walthinsen committed
157 158

  /* the elementfactory that created us */
159
  GstElementFactory 	*elementfactory;
160
  /* templates for our pads */
161 162
  GList 		*padtemplates;
  gint 			numpadtemplates;
163
  
Erik Walthinsen's avatar
Erik Walthinsen committed
164
  /* signal callbacks */
165 166 167 168
  void (*state_change)		(GstElement *element, GstElementState old, GstElementState state);
  void (*new_pad)		(GstElement *element, GstPad *pad);
  void (*pad_removed)		(GstElement *element, GstPad *pad);
  void (*error)			(GstElement *element, gchar *error);
169 170 171
  void (*eos)			(GstElement *element);

  /* 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, GValue *value, GParamSpec *pspec);
Erik Walthinsen's avatar
Erik Walthinsen committed
174 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, const gchar* name);
Erik Walthinsen's avatar
Erik Walthinsen committed
179 180
};

181
void			gst_element_class_add_padtemplate	(GstElementClass *klass, GstPadTemplate *templ);
182

183
GType			gst_element_get_type		(void);
Wim Taymans's avatar
Wim Taymans committed
184
#define			gst_element_destroy(element)	gst_object_destroy (GST_OBJECT (element))
Erik Walthinsen's avatar
Erik Walthinsen committed
185

Wim Taymans's avatar
Wim Taymans committed
186 187
void			gst_element_set_loop_function	(GstElement *element,
							 GstElementLoopFunction loop);
Erik Walthinsen's avatar
Erik Walthinsen committed
188

189 190 191 192 193
void                    gst_element_set_name            (GstElement *element, const gchar *name);
const gchar*            gst_element_get_name            (GstElement *element);

void                    gst_element_set_parent          (GstElement *element, GstObject *parent);
GstObject*              gst_element_get_parent          (GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
194

195 196
void			gst_element_set_sched		(GstElement *element, GstScheduler *sched);
GstScheduler*		gst_element_get_sched		(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
197

Wim Taymans's avatar
Wim Taymans committed
198
void			gst_element_add_pad		(GstElement *element, GstPad *pad);
199
void			gst_element_remove_pad		(GstElement *element, GstPad *pad);
Wim Taymans's avatar
Wim Taymans committed
200
GstPad*			gst_element_get_pad		(GstElement *element, const gchar *name);
201
GList*			gst_element_get_pad_list	(GstElement *element);
Wim Taymans's avatar
Wim Taymans committed
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);
Erik Walthinsen's avatar
Erik Walthinsen committed
206

207
GstPad*			gst_element_request_compatible_pad (GstElement *element, GstPadTemplate *templ);
208 209
GstPad*			gst_element_request_pad_by_name	(GstElement *element, const gchar *name);

Wim Taymans's avatar
Wim Taymans committed
210 211 212 213
void			gst_element_connect		(GstElement *src, const gchar *srcpadname,
							 GstElement *dest, const gchar *destpadname);
void			gst_element_disconnect		(GstElement *src, const gchar *srcpadname,
							 GstElement *dest, const gchar *destpadname);
Erik Walthinsen's avatar
Erik Walthinsen committed
214

215 216 217
void			gst_element_signal_eos		(GstElement *element);


218
GstElementState         gst_element_get_state           (GstElement *element);
Wim Taymans's avatar
Wim Taymans committed
219
gint			gst_element_set_state		(GstElement *element, GstElementState state);
220 221 222 223

void 			gst_element_wait_state_change 	(GstElement *element);
	
const gchar*		gst_element_statename		(GstElementState state);
Erik Walthinsen's avatar
Erik Walthinsen committed
224

Wim Taymans's avatar
Wim Taymans committed
225
void			gst_element_error		(GstElement *element, const gchar *error);
Erik Walthinsen's avatar
Erik Walthinsen committed
226

227
GstElementFactory*	gst_element_get_factory		(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
228

Wim Taymans's avatar
Wim Taymans committed
229 230 231 232
void                    gst_element_install_std_props   (GstElementClass *klass,
							 const char      *first_name, ...);


233
#ifndef GST_DISABLE_LOADSAVE
Erik Walthinsen's avatar
Erik Walthinsen committed
234
/* XML write and read */
235
GstElement*		gst_element_restore_thyself	(xmlNodePtr self, GstObject *parent);
236
#endif
Erik Walthinsen's avatar
Erik Walthinsen committed
237 238


Wim Taymans's avatar
Wim Taymans committed
239
/*
240 241 242 243
 *
 * factories stuff
 *
 **/
244 245 246 247 248 249 250 251 252 253 254
typedef struct _GstElementDetails GstElementDetails;

struct _GstElementDetails {
  gchar *longname;              /* long, english name */
  gchar *klass;                 /* type of element, as hierarchy */
  gchar *description;           /* insights of one form or another */
  gchar *version;               /* version of the element */
  gchar *author;                /* who wrote this thing? */
  gchar *copyright;             /* copyright details (year, etc.) */
};

255 256 257 258 259 260 261
#define GST_TYPE_ELEMENTFACTORY 		(gst_elementfactory_get_type())
#define GST_ELEMENTFACTORY(obj)  		(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENTFACTORY,\
						 GstElementFactory))
#define GST_ELEMENTFACTORY_CLASS(klass) 	(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENTFACTORY,\
						 GstElementFactoryClass))
#define GST_IS_ELEMENTFACTORY(obj) 		(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENTFACTORY))
#define GST_IS_ELEMENTFACTORY_CLASS(klass) 	(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENTFACTORY))
262 263 264 265 266 267

struct _GstElementFactory {
  GstPluginFeature feature;

  GType type;			/* unique GType of element */

Joshua N. Pritikin's avatar
Joshua N. Pritikin committed
268 269
  guint details_dynamic : 1;

270 271 272 273 274 275 276 277 278 279 280 281
  GstElementDetails *details;	/* pointer to details struct */

  GList *padtemplates;
  guint16 numpadtemplates;
};

struct _GstElementFactoryClass {
  GstPluginFeatureClass parent_class;
};

GType 			gst_elementfactory_get_type 		(void);

282
GstElementFactory*	gst_elementfactory_new			(const gchar *name,GType type,
Wim Taymans's avatar
Wim Taymans committed
283
                                                                 GstElementDetails *details);
284

Wim Taymans's avatar
Wim Taymans committed
285
GstElementFactory*	gst_elementfactory_find			(const gchar *name);
286
const GList*		gst_elementfactory_get_list		(void);
Erik Walthinsen's avatar
Erik Walthinsen committed
287

288 289
void			gst_elementfactory_add_padtemplate	(GstElementFactory *elementfactory,
								 GstPadTemplate *templ);
290

Wim Taymans's avatar
Wim Taymans committed
291 292 293 294
gboolean		gst_elementfactory_can_src_caps		(GstElementFactory *factory,
								 GstCaps *caps);
gboolean		gst_elementfactory_can_sink_caps	(GstElementFactory *factory,
								 GstCaps *caps);
Erik Walthinsen's avatar
Erik Walthinsen committed
295

296
GstElement*		gst_elementfactory_create		(GstElementFactory *factory,
297
								 const gchar *name);
Wim Taymans's avatar
Wim Taymans committed
298
/* FIXME this name is wrong, probably so is the one above it */
Wim Taymans's avatar
Wim Taymans committed
299
GstElement*		gst_elementfactory_make			(const gchar *factoryname, const gchar *name);
300

Erik Walthinsen's avatar
Erik Walthinsen committed
301 302 303 304 305
#ifdef __cplusplus
}
#endif /* __cplusplus */


306
#endif /* __GST_ELEMENT_H__ */
Erik Walthinsen's avatar
Erik Walthinsen committed
307