gstelement.h 14.1 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

29
#include <gst/gsttypes.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
30 31
#include <gst/gstobject.h>
#include <gst/gstpad.h>
32
#include <gst/gstclock.h>
33
#include <gst/gstpluginfeature.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
34

35
G_BEGIN_DECLS
Erik Walthinsen's avatar
Erik Walthinsen committed
36

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

39 40 41
/* NOTE: this probably should be done with an #ifdef to decide 
 * whether to safe-cast or to just do the non-checking cast.
 */
42 43 44
#define GST_STATE(obj)			(GST_ELEMENT(obj)->current_state)
#define GST_STATE_PENDING(obj)		(GST_ELEMENT(obj)->pending_state)

45
/* Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g> */
46
#define GST_STATE_TRANSITION(obj)	((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
47
#define GST_STATE_NULL_TO_READY		((GST_STATE_NULL<<8) | GST_STATE_READY)
48
#define GST_STATE_READY_TO_PAUSED	((GST_STATE_READY<<8) | GST_STATE_PAUSED)
49
#define GST_STATE_PAUSED_TO_PLAYING	((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
50 51
#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)
52
#define GST_STATE_READY_TO_NULL		((GST_STATE_READY<<8) | GST_STATE_NULL)
53

54 55 56 57
extern GType _gst_element_type;

#define GST_TYPE_ELEMENT		(_gst_element_type)

58 59
#define GST_ELEMENT_CAST(obj)		((GstElement*)(obj))
#define GST_ELEMENT_CLASS_CAST(klass)	((GstElementClass*)(klass))
60 61 62 63 64 65 66
#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
67 68
# define GST_ELEMENT                    GST_ELEMENT_CAST
# define GST_ELEMENT_CLASS              GST_ELEMENT_CLASS_CAST
69
#endif
Erik Walthinsen's avatar
Erik Walthinsen committed
70

71
typedef enum {
Wim Taymans's avatar
Wim Taymans committed
72
  /* element is complex (for some def.) and generally require a cothread */
73
  GST_ELEMENT_COMPLEX		= GST_OBJECT_FLAG_LAST,
Wim Taymans's avatar
Wim Taymans committed
74 75
  /* input and output pads aren't directly coupled to each other
     examples: queues, multi-output async readers, etc. */
76
  GST_ELEMENT_DECOUPLED,
Wim Taymans's avatar
Wim Taymans committed
77
  /* this element should be placed in a thread if at all possible */
78
  GST_ELEMENT_THREAD_SUGGESTED,
Wim Taymans's avatar
Wim Taymans committed
79
  /* this element is incable of seeking (FIXME: does this apply to filters?) */
80
  GST_ELEMENT_NO_SEEK,
81 82 83
  /* this element, for some reason, has a loop function that performs
   * an infinite loop without calls to gst_element_yield () */
  GST_ELEMENT_INFINITE_LOOP,
Wim Taymans's avatar
Wim Taymans committed
84
  /* there is a new loopfunction ready for placement */
85
  GST_ELEMENT_NEW_LOOPFUNC,
86 87
  /* if this element can handle events */
  GST_ELEMENT_EVENT_AWARE,
88 89 90 91 92 93
  /* use threadsafe property get/set implementation */
  GST_ELEMENT_USE_THREADSAFE_PROPERTIES,

  /* private flags that can be used by the scheduler */
  GST_ELEMENT_SCHEDULER_PRIVATE1,
  GST_ELEMENT_SCHEDULER_PRIVATE2,
94

95
  /* use some padding for future expansion */
96
  GST_ELEMENT_FLAG_LAST		= GST_OBJECT_FLAG_LAST + 16,
97 98
} GstElementFlags;

99
#define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)	(GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
100
#define GST_ELEMENT_IS_EOS(obj)			(GST_FLAG_IS_SET(obj,GST_ELEMENT_EOS))
101
#define GST_ELEMENT_IS_EVENT_AWARE(obj)		(GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
102
#define GST_ELEMENT_IS_DECOUPLED(obj)		(GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
103

104 105
#define GST_ELEMENT_NAME(obj)			(GST_OBJECT_NAME(obj))
#define GST_ELEMENT_PARENT(obj)			(GST_OBJECT_PARENT(obj))
106 107
#define GST_ELEMENT_MANAGER(obj)		(((GstElement*)(obj))->manager)
#define GST_ELEMENT_SCHED(obj)			(((GstElement*)(obj))->sched)
108
#define GST_ELEMENT_CLOCK(obj)			(((GstElement*)(obj))->clock)
Wim Taymans's avatar
Wim Taymans committed
109
#define GST_ELEMENT_PADS(obj)			((obj)->pads)
110

Erik Walthinsen's avatar
Erik Walthinsen committed
111
typedef struct _GstElementFactory GstElementFactory;
112
typedef struct _GstElementFactoryClass GstElementFactoryClass;
Erik Walthinsen's avatar
Erik Walthinsen committed
113

114 115 116
typedef void 		(*GstElementLoopFunction) 	(GstElement *element);
typedef void 		(*GstElementSetClockFunction) 	(GstElement *element, GstClock *clock);
typedef GstClock* 	(*GstElementGetClockFunction) 	(GstElement *element);
117 118
typedef void 		(*GstElementPreRunFunction) 	(GstElement *element);
typedef void 		(*GstElementPostRunFunction) 	(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
119 120

struct _GstElement {
121
  GstObject 		object;
Erik Walthinsen's avatar
Erik Walthinsen committed
122

123 124 125 126
  /* element state  and scheduling */
  guint8 		current_state;
  guint8 		pending_state;
  GstElement 		*manager;
Erik Walthinsen's avatar
Erik Walthinsen committed
127
  GstElementLoopFunction loopfunc;
128 129 130

  GstScheduler 		*sched;
  gpointer		sched_private;
131 132
  GstElementSetClockFunction setclockfunc;
  GstElementGetClockFunction getclockfunc;
133
  GstClock		*clock;
134 135 136 137 138 139 140

  /* element pads */
  guint16 		numpads;
  guint16 		numsrcpads;
  guint16 		numsinkpads;
  GList 		*pads;
  GstPad 		*select_pad;
141 142 143

  GMutex 		*state_mutex;
  GCond 		*state_cond;
144 145 146 147 148

  GstElementPreRunFunction  pre_run_func;
  GstElementPostRunFunction post_run_func;
  GAsyncQueue		*prop_value_queue;
  GMutex		*property_mutex;
Erik Walthinsen's avatar
Erik Walthinsen committed
149 150 151
};

struct _GstElementClass {
152
  GstObjectClass 	parent_class;
Erik Walthinsen's avatar
Erik Walthinsen committed
153 154

  /* the elementfactory that created us */
155
  GstElementFactory 	*elementfactory;
156
  /* templates for our pads */
157 158
  GList 		*padtemplates;
  gint 			numpadtemplates;
159
  
Erik Walthinsen's avatar
Erik Walthinsen committed
160
  /* signal callbacks */
161 162 163 164 165 166
  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, GstElement *source, gchar *error);
  void (*eos)		(GstElement *element);
  void (*deep_notify)	(GstObject *object, GstObject *orig, GParamSpec *pspec);
167 168

  /* local pointers for get/set */
169
  void (*set_property) 	(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
170
  void (*get_property)	(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
Erik Walthinsen's avatar
Erik Walthinsen committed
171

172
  /* vtable*/
173
  gboolean		(*release_locks)	(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
174
  /* change the element state */
175
  GstElementStateReturn (*change_state)		(GstElement *element);
176
  /* request a new pad */
177
  GstPad*		(*request_new_pad)	(GstElement *element, GstPadTemplate *templ, const gchar* name);
178
  void			(*release_pad)		(GstElement *element, GstPad *pad);
Erik Walthinsen's avatar
Erik Walthinsen committed
179 180
};

181
void			gst_element_class_add_pad_template	(GstElementClass *klass, GstPadTemplate *templ);
182 183 184
void                    gst_element_class_install_std_props	(GstElementClass *klass,
								 const gchar      *first_name, ...);

185

186
GType			gst_element_get_type		(void);
Wim Taymans's avatar
Wim Taymans committed
187
#define			gst_element_destroy(element)	gst_object_destroy (GST_OBJECT (element))
Erik Walthinsen's avatar
Erik Walthinsen committed
188

Wim Taymans's avatar
Wim Taymans committed
189 190
void			gst_element_set_loop_function	(GstElement *element,
							 GstElementLoopFunction loop);
Erik Walthinsen's avatar
Erik Walthinsen committed
191

192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
/* threadsafe versions of their g_object_* counterparts */
void	    		gst_element_set			(GstElement *element, const gchar *first_property_name, ...);
void        		gst_element_get			(GstElement *element, const gchar *first_property_name, ...);
void			gst_element_set_valist		(GstElement *element, const gchar *first_property_name,
                                                         va_list var_args);
void			gst_element_get_valist		(GstElement *element, const gchar *first_property_name,
                                                         va_list var_args);
void			gst_element_set_property	(GstElement *element, const gchar *property_name,
                                                         const GValue   *value);
void			gst_element_get_property	(GstElement *element, const gchar *property_name,
                                                         GValue *value);

void			gst_element_enable_threadsafe_properties	(GstElement *element);
void			gst_element_disable_threadsafe_properties	(GstElement *element);
void			gst_element_set_pending_properties		(GstElement *element);

208 209 210 211 212
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
213

214 215
GstClock*		gst_element_get_clock 		(GstElement *element);
void			gst_element_set_clock 		(GstElement *element, GstClock *clock);
216 217 218 219
GstClockReturn		gst_element_clock_wait 		(GstElement *element, GstClock *clock, 
							 GstClockTime time, GstClockTimeDiff *jitter);

gboolean		gst_element_release_locks	(GstElement *element);
220

221
void			gst_element_yield		(GstElement *element);
222
gboolean		gst_element_interrupt		(GstElement *element);
223 224
void			gst_element_set_scheduler	(GstElement *element, GstScheduler *sched);
GstScheduler*		gst_element_get_scheduler	(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
225

Wim Taymans's avatar
Wim Taymans committed
226
void			gst_element_add_pad		(GstElement *element, GstPad *pad);
227
void			gst_element_remove_pad		(GstElement *element, GstPad *pad);
228 229 230
GstPad *		gst_element_add_ghost_pad	(GstElement *element, GstPad *pad, gchar *name);
void			gst_element_remove_ghost_pad	(GstElement *element, GstPad *pad);

Wim Taymans's avatar
Wim Taymans committed
231
GstPad*			gst_element_get_pad		(GstElement *element, const gchar *name);
232 233
GstPad*			gst_element_get_static_pad	(GstElement *element, const gchar *name);
GstPad*			gst_element_get_request_pad	(GstElement *element, const gchar *name);
234
void			gst_element_release_request_pad	(GstElement *element, GstPad *pad);
235

236
GList*			gst_element_get_pad_list	(GstElement *element);
237
GstPad*			gst_element_get_compatible_pad	(GstElement *element, GstPad *pad);
Benjamin Otte's avatar
Benjamin Otte committed
238 239
GstPad*			gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad, 
							 GstCaps *filtercaps);
240
/* unimplemented
241 242
GstPad*			gst_element_get_compatible_request_pad (GstElement *element, GstPadTemplate *templ);
GstPad*			gst_element_get_compatible_static_pad (GstElement *element, GstPadTemplate *templ);
243 244 245 246 247
*/

GstPadTemplate*		gst_element_get_pad_template		(GstElement *element, const guchar *name);
GList*			gst_element_get_pad_template_list	(GstElement *element);
GstPadTemplate*		gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
248

249 250 251
gboolean		gst_element_connect		(GstElement *src, GstElement *dest);
gboolean		gst_element_connect_many 	(GstElement *element_1, GstElement *element_2, ...);
gboolean		gst_element_connect_filtered 	(GstElement *src, GstElement *dest,
Benjamin Otte's avatar
Benjamin Otte committed
252
							 GstCaps *filtercaps);
253 254 255 256
void			gst_element_disconnect 		(GstElement *src, GstElement *dest);
void			gst_element_disconnect_many 	(GstElement *element_1, GstElement *element_2, ...);

gboolean		gst_element_connect_pads	(GstElement *src, const gchar *srcpadname,
Wim Taymans's avatar
Wim Taymans committed
257
							 GstElement *dest, const gchar *destpadname);
258
gboolean		gst_element_connect_pads_filtered (GstElement *src, const gchar *srcpadname,
259 260
							 GstElement *dest, const gchar *destpadname,
							 GstCaps *filtercaps);
261
void			gst_element_disconnect_pads	(GstElement *src, const gchar *srcpadname,
Wim Taymans's avatar
Wim Taymans committed
262
							 GstElement *dest, const gchar *destpadname);
Erik Walthinsen's avatar
Erik Walthinsen committed
263

264
void			gst_element_set_eos		(GstElement *element);
265

266
void 			gst_element_error 		(GstElement *element, const gchar *error, ...);
267

268
GstElementState         gst_element_get_state           (GstElement *element);
Wim Taymans's avatar
Wim Taymans committed
269
gint			gst_element_set_state		(GstElement *element, GstElementState state);
270 271 272

void 			gst_element_wait_state_change 	(GstElement *element);
	
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
273
const gchar*		gst_element_state_get_name	(GstElementState state);
Erik Walthinsen's avatar
Erik Walthinsen committed
274

275
GstElementFactory*	gst_element_get_factory		(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
276

277 278
GstBin*			gst_element_get_managing_bin	(GstElement *element);

Wim Taymans's avatar
Wim Taymans committed
279

Wim Taymans's avatar
Wim Taymans committed
280
/*
281 282 283 284
 *
 * factories stuff
 *
 **/
285 286 287 288 289 290 291 292 293 294 295
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.) */
};

296 297
#define GST_TYPE_ELEMENT_FACTORY 		(gst_element_factory_get_type())
#define GST_ELEMENT_FACTORY(obj)  		(G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ELEMENT_FACTORY,\
298
						 GstElementFactory))
299
#define GST_ELEMENT_FACTORY_CLASS(klass) 	(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
300
						 GstElementFactoryClass))
301 302
#define GST_IS_ELEMENT_FACTORY(obj) 		(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ELEMENT_FACTORY))
#define GST_IS_ELEMENT_FACTORY_CLASS(klass) 	(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ELEMENT_FACTORY))
303 304 305 306 307 308

struct _GstElementFactory {
  GstPluginFeature feature;

  GType type;			/* unique GType of element */

Joshua N. Pritikin's avatar
Joshua N. Pritikin committed
309 310
  guint details_dynamic : 1;

311 312 313 314 315 316 317 318 319 320
  GstElementDetails *details;	/* pointer to details struct */

  GList *padtemplates;
  guint16 numpadtemplates;
};

struct _GstElementFactoryClass {
  GstPluginFeatureClass parent_class;
};

321
GType 			gst_element_factory_get_type 		(void);
322

323
GstElementFactory*	gst_element_factory_new			(const gchar *name, GType type,
Wim Taymans's avatar
Wim Taymans committed
324
                                                                 GstElementDetails *details);
325
GstElementFactory*	gst_element_factory_find		(const gchar *name);
Erik Walthinsen's avatar
Erik Walthinsen committed
326

327
void			gst_element_factory_add_pad_template	(GstElementFactory *elementfactory,
328
								 GstPadTemplate *templ);
329

330
gboolean		gst_element_factory_can_src_caps	(GstElementFactory *factory,
Wim Taymans's avatar
Wim Taymans committed
331
								 GstCaps *caps);
332
gboolean		gst_element_factory_can_sink_caps	(GstElementFactory *factory,
Wim Taymans's avatar
Wim Taymans committed
333
								 GstCaps *caps);
Erik Walthinsen's avatar
Erik Walthinsen committed
334

335
GstElement*		gst_element_factory_create		(GstElementFactory *factory,
336
								 const gchar *name);
Wim Taymans's avatar
Wim Taymans committed
337
/* FIXME this name is wrong, probably so is the one above it */
338
GstElement*		gst_element_factory_make		(const gchar *factoryname, const gchar *name);
339

340
G_END_DECLS
Erik Walthinsen's avatar
Erik Walthinsen committed
341 342


343
#endif /* __GST_ELEMENT_H__ */
Erik Walthinsen's avatar
Erik Walthinsen committed
344