gstelement.h 15.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>
28
#include <gst/gsttypes.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
29 30
#include <gst/gstobject.h>
#include <gst/gstpad.h>
31
#include <gst/gstclock.h>
32
#include <gst/gstpluginfeature.h>
Wim Taymans's avatar
Wim Taymans committed
33
#include <gst/gstindex.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,
79 80 81
  /* 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
82
  /* there is a new loopfunction ready for placement */
83
  GST_ELEMENT_NEW_LOOPFUNC,
84 85
  /* if this element can handle events */
  GST_ELEMENT_EVENT_AWARE,
86 87 88 89 90 91
  /* 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,
92

93
  /* use some padding for future expansion */
94
  GST_ELEMENT_FLAG_LAST		= GST_OBJECT_FLAG_LAST + 16
95 96
} GstElementFlags;

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

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

Erik Walthinsen's avatar
Erik Walthinsen committed
109
typedef struct _GstElementFactory GstElementFactory;
110
typedef struct _GstElementFactoryClass GstElementFactoryClass;
Erik Walthinsen's avatar
Erik Walthinsen committed
111

112
typedef void 		(*GstElementLoopFunction) 	(GstElement *element);
113 114
typedef void 		(*GstElementPreRunFunction) 	(GstElement *element);
typedef void 		(*GstElementPostRunFunction) 	(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
115 116

struct _GstElement {
117
  GstObject 		object;
Erik Walthinsen's avatar
Erik Walthinsen committed
118

119 120 121 122
  /* element state  and scheduling */
  guint8 		current_state;
  guint8 		pending_state;
  GstElement 		*manager;
Erik Walthinsen's avatar
Erik Walthinsen committed
123
  GstElementLoopFunction loopfunc;
124 125 126

  GstScheduler 		*sched;
  gpointer		sched_private;
127
  GstClock		*clock;
Wim Taymans's avatar
Wim Taymans committed
128
  GstClockTime		 base_time;
129 130 131 132 133 134 135

  /* element pads */
  guint16 		numpads;
  guint16 		numsrcpads;
  guint16 		numsinkpads;
  GList 		*pads;
  GstPad 		*select_pad;
136 137 138

  GMutex 		*state_mutex;
  GCond 		*state_cond;
139 140 141 142 143

  GstElementPreRunFunction  pre_run_func;
  GstElementPostRunFunction post_run_func;
  GAsyncQueue		*prop_value_queue;
  GMutex		*property_mutex;
Erik Walthinsen's avatar
Erik Walthinsen committed
144 145 146
};

struct _GstElementClass {
147
  GstObjectClass 	parent_class;
Erik Walthinsen's avatar
Erik Walthinsen committed
148 149

  /* the elementfactory that created us */
150
  GstElementFactory 	*elementfactory;
151
  /* templates for our pads */
152 153
  GList 		*padtemplates;
  gint 			numpadtemplates;
154
  
Erik Walthinsen's avatar
Erik Walthinsen committed
155
  /* signal callbacks */
156 157 158 159 160
  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);
161 162

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

166
  /* vtable*/
167
  gboolean		(*release_locks)	(GstElement *element);
168
  gboolean		(*send_event)		(GstElement *element, GstEvent *event);
Wim Taymans's avatar
Wim Taymans committed
169 170
  gboolean		(*query)		(GstElement *element, GstPadQueryType type,
		  				 GstFormat *format, gint64 *value);
Erik Walthinsen's avatar
Erik Walthinsen committed
171
  /* change the element state */
172
  GstElementStateReturn (*change_state)		(GstElement *element);
173
  /* request a new pad */
174
  GstPad*		(*request_new_pad)	(GstElement *element, GstPadTemplate *templ, const gchar* name);
175
  void			(*release_pad)		(GstElement *element, GstPad *pad);
176 177 178
  /* set/get clocks */
  GstClock*		(*get_clock)		(GstElement *element);
  void			(*set_clock)		(GstElement *element, GstClock *clock);
Wim Taymans's avatar
Wim Taymans committed
179 180 181
  /* index */
  GstIndex*		(*get_index)		(GstElement *element);
  void			(*set_index)		(GstElement *element, GstIndex *index);
Erik Walthinsen's avatar
Erik Walthinsen committed
182 183
};

184
void			gst_element_class_add_pad_template	(GstElementClass *klass, GstPadTemplate *templ);
185 186 187
void                    gst_element_class_install_std_props	(GstElementClass *klass,
								 const gchar      *first_name, ...);

Wim Taymans's avatar
Wim Taymans committed
188 189
#define 		gst_element_default_deep_notify 	gst_object_default_deep_notify

190
void 			gst_element_default_error		(GObject *object, GstObject *orig, gchar *error);
191

192
GType			gst_element_get_type		(void);
Wim Taymans's avatar
Wim Taymans committed
193
#define			gst_element_destroy(element)	gst_object_destroy (GST_OBJECT (element))
Erik Walthinsen's avatar
Erik Walthinsen committed
194

Wim Taymans's avatar
Wim Taymans committed
195 196
void			gst_element_set_loop_function	(GstElement *element,
							 GstElementLoopFunction loop);
Erik Walthinsen's avatar
Erik Walthinsen committed
197

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
198
#define			gst_element_get_name(elem)	gst_object_get_name(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
199
#define			gst_element_set_name(elem,name)	gst_object_set_name(GST_OBJECT(elem),name)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
200
#define			gst_element_get_parent(elem)	gst_object_get_parent(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
201
#define			gst_element_set_parent(elem,parent)	gst_object_set_parent(GST_OBJECT(elem),parent)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
202

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
/* 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);

219 220 221
/* clocking */
gboolean		gst_element_requires_clock	(GstElement *element);
gboolean		gst_element_provides_clock	(GstElement *element);
222 223
GstClock*		gst_element_get_clock 		(GstElement *element);
void			gst_element_set_clock 		(GstElement *element, GstClock *clock);
224 225
GstClockReturn		gst_element_clock_wait 		(GstElement *element, GstClock *clock, 
							 GstClockTime time, GstClockTimeDiff *jitter);
Wim Taymans's avatar
Wim Taymans committed
226
/* indexs */
Wim Taymans's avatar
Wim Taymans committed
227
gboolean		gst_element_is_indexable	(GstElement *element);
Wim Taymans's avatar
Wim Taymans committed
228 229
void			gst_element_set_index		(GstElement *element, GstIndex *index);
GstIndex*		gst_element_get_index		(GstElement *element);
230

231 232

gboolean		gst_element_release_locks	(GstElement *element);
233

234
void			gst_element_yield		(GstElement *element);
235
gboolean		gst_element_interrupt		(GstElement *element);
236 237
void			gst_element_set_scheduler	(GstElement *element, GstScheduler *sched);
GstScheduler*		gst_element_get_scheduler	(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
238

Wim Taymans's avatar
Wim Taymans committed
239
void			gst_element_add_pad		(GstElement *element, GstPad *pad);
240
void			gst_element_remove_pad		(GstElement *element, GstPad *pad);
241
GstPad *		gst_element_add_ghost_pad	(GstElement *element, GstPad *pad, const gchar *name);
242 243
void			gst_element_remove_ghost_pad	(GstElement *element, GstPad *pad);

Wim Taymans's avatar
Wim Taymans committed
244
GstPad*			gst_element_get_pad		(GstElement *element, const gchar *name);
245 246
GstPad*			gst_element_get_static_pad	(GstElement *element, const gchar *name);
GstPad*			gst_element_get_request_pad	(GstElement *element, const gchar *name);
247
void			gst_element_release_request_pad	(GstElement *element, GstPad *pad);
248

249
const GList*		gst_element_get_pad_list	(GstElement *element);
250
GstPad*			gst_element_get_compatible_pad	(GstElement *element, GstPad *pad);
Benjamin Otte's avatar
Benjamin Otte committed
251 252
GstPad*			gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad, 
							 GstCaps *filtercaps);
253
/* unimplemented
254 255
GstPad*			gst_element_get_compatible_request_pad (GstElement *element, GstPadTemplate *templ);
GstPad*			gst_element_get_compatible_static_pad (GstElement *element, GstPadTemplate *templ);
256 257
*/

258
GstPadTemplate*		gst_element_get_pad_template		(GstElement *element, const gchar *name);
259 260
GList*			gst_element_get_pad_template_list	(GstElement *element);
GstPadTemplate*		gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
261

262 263 264
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
265
							 GstCaps *filtercaps);
266 267 268 269
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
270
							 GstElement *dest, const gchar *destpadname);
271
gboolean		gst_element_connect_pads_filtered (GstElement *src, const gchar *srcpadname,
272 273
							 GstElement *dest, const gchar *destpadname,
							 GstCaps *filtercaps);
274
void			gst_element_disconnect_pads	(GstElement *src, const gchar *srcpadname,
Wim Taymans's avatar
Wim Taymans committed
275
							 GstElement *dest, const gchar *destpadname);
Erik Walthinsen's avatar
Erik Walthinsen committed
276

277
gboolean		gst_element_send_event		(GstElement *element, GstEvent *event);
Wim Taymans's avatar
Wim Taymans committed
278 279
gboolean		gst_element_query		(GstElement *element, GstPadQueryType type,
			                                 GstFormat *format, gint64 *value);
280

281
void			gst_element_set_eos		(GstElement *element);
282

283
void 			gst_element_error 		(GstElement *element, const gchar *error, ...);
284

285
GstElementState         gst_element_get_state           (GstElement *element);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
286
GstElementStateReturn	gst_element_set_state		(GstElement *element, GstElementState state);
287 288 289

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

292
GstElementFactory*	gst_element_get_factory		(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
293

294 295
GstBin*			gst_element_get_managing_bin	(GstElement *element);

Wim Taymans's avatar
Wim Taymans committed
296

Wim Taymans's avatar
Wim Taymans committed
297
/*
298 299 300 301
 *
 * factories stuff
 *
 **/
302 303 304 305 306
typedef struct _GstElementDetails GstElementDetails;

struct _GstElementDetails {
  gchar *longname;              /* long, english name */
  gchar *klass;                 /* type of element, as hierarchy */
Christian Schaller's avatar
Christian Schaller committed
307
  gchar *license;               /* license element is under */
308 309 310 311 312 313
  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.) */
};

314 315
#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,\
316
						 GstElementFactory))
317
#define GST_ELEMENT_FACTORY_CLASS(klass) 	(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
318
						 GstElementFactoryClass))
319 320
#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))
321

322 323 324 325 326
#define GST_ELEMENT_RANK_PRIMARY    256
#define GST_ELEMENT_RANK_SECONDARY  128
#define GST_ELEMENT_RANK_MARGINAL   64
#define GST_ELEMENT_RANK_NONE       0

327 328 329 330 331
struct _GstElementFactory {
  GstPluginFeature feature;

  GType type;			/* unique GType of element */

Joshua N. Pritikin's avatar
Joshua N. Pritikin committed
332 333
  guint details_dynamic : 1;

334 335 336 337
  GstElementDetails *details;	/* pointer to details struct */

  GList *padtemplates;
  guint16 numpadtemplates;
338 339

  guint16 rank;			/* used by autoplug to prioritise elements to try */
340 341 342 343 344 345
};

struct _GstElementFactoryClass {
  GstPluginFeatureClass parent_class;
};

346
GType 			gst_element_factory_get_type 		(void);
347

348
GstElementFactory*	gst_element_factory_new			(const gchar *name, GType type,
Wim Taymans's avatar
Wim Taymans committed
349
                                                                 GstElementDetails *details);
350
GstElementFactory*	gst_element_factory_find		(const gchar *name);
Erik Walthinsen's avatar
Erik Walthinsen committed
351

352
void			gst_element_factory_add_pad_template	(GstElementFactory *elementfactory,
353
								 GstPadTemplate *templ);
354

355
gboolean		gst_element_factory_can_src_caps	(GstElementFactory *factory,
Wim Taymans's avatar
Wim Taymans committed
356
								 GstCaps *caps);
357
gboolean		gst_element_factory_can_sink_caps	(GstElementFactory *factory,
Wim Taymans's avatar
Wim Taymans committed
358
								 GstCaps *caps);
Erik Walthinsen's avatar
Erik Walthinsen committed
359

360
GstElement*		gst_element_factory_create		(GstElementFactory *factory,
361
								 const gchar *name);
362
GstElement*		gst_element_factory_make		(const gchar *factoryname, const gchar *name);
363
GstElement*		gst_element_factory_make_or_warn	(const gchar *factoryname, const gchar *name);
364

365 366
void			gst_element_factory_set_rank		(GstElementFactory *factory, guint16 rank);

367
G_END_DECLS
Erik Walthinsen's avatar
Erik Walthinsen committed
368 369


370
#endif /* __GST_ELEMENT_H__ */
Erik Walthinsen's avatar
Erik Walthinsen committed
371