gstelement.h 15.4 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
#define GST_IS_ELEMENT(obj)		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
Wim Taymans's avatar
Wim Taymans committed
61 62
#define GST_IS_ELEMENT_CLASS(klass)	(G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
#define GST_ELEMENT_GET_CLASS(obj)	(G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ELEMENT, GstElementClass))
63 64 65 66 67

#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
68 69
# define GST_ELEMENT                    GST_ELEMENT_CAST
# define GST_ELEMENT_CLASS              GST_ELEMENT_CLASS_CAST
70
#endif
Erik Walthinsen's avatar
Erik Walthinsen committed
71

72
typedef enum {
Wim Taymans's avatar
Wim Taymans committed
73
  /* element is complex (for some def.) and generally require a cothread */
74
  GST_ELEMENT_COMPLEX		= GST_OBJECT_FLAG_LAST,
Wim Taymans's avatar
Wim Taymans committed
75 76
  /* input and output pads aren't directly coupled to each other
     examples: queues, multi-output async readers, etc. */
77
  GST_ELEMENT_DECOUPLED,
Wim Taymans's avatar
Wim Taymans committed
78
  /* this element should be placed in a thread if at all possible */
79
  GST_ELEMENT_THREAD_SUGGESTED,
80 81 82
  /* 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
83
  /* there is a new loopfunction ready for placement */
84
  GST_ELEMENT_NEW_LOOPFUNC,
85 86
  /* if this element can handle events */
  GST_ELEMENT_EVENT_AWARE,
87 88 89 90 91 92
  /* 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,
93

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

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

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

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

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

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

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

  GstScheduler 		*sched;
  gpointer		sched_private;
Wim Taymans's avatar
Wim Taymans committed
127 128

  /* allocated clock */
129
  GstClock		*clock;
Wim Taymans's avatar
Wim Taymans committed
130
  GstClockTime		 base_time;
131 132 133 134 135 136

  /* element pads */
  guint16 		numpads;
  guint16 		numsrcpads;
  guint16 		numsinkpads;
  GList 		*pads;
137 138 139

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

  GstElementPreRunFunction  pre_run_func;
  GstElementPostRunFunction post_run_func;
  GAsyncQueue		*prop_value_queue;
  GMutex		*property_mutex;
Wim Taymans's avatar
Wim Taymans committed
145 146

  gpointer		dummy[8];
Erik Walthinsen's avatar
Erik Walthinsen committed
147 148 149
};

struct _GstElementClass {
150
  GstObjectClass 	parent_class;
Erik Walthinsen's avatar
Erik Walthinsen committed
151 152

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

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

169
  /* vtable*/
170
  gboolean		(*release_locks)	(GstElement *element);
171
  gboolean		(*send_event)		(GstElement *element, GstEvent *event);
Wim Taymans's avatar
Wim Taymans committed
172 173
  gboolean		(*query)		(GstElement *element, GstPadQueryType type,
		  				 GstFormat *format, gint64 *value);
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);
179 180 181
  /* set/get clocks */
  GstClock*		(*get_clock)		(GstElement *element);
  void			(*set_clock)		(GstElement *element, GstClock *clock);
Wim Taymans's avatar
Wim Taymans committed
182 183 184
  /* index */
  GstIndex*		(*get_index)		(GstElement *element);
  void			(*set_index)		(GstElement *element, GstIndex *index);
Wim Taymans's avatar
Wim Taymans committed
185 186

  gpointer		dummy[8];
Erik Walthinsen's avatar
Erik Walthinsen committed
187 188
};

189
void			gst_element_class_add_pad_template	(GstElementClass *klass, GstPadTemplate *templ);
190 191 192
void                    gst_element_class_install_std_props	(GstElementClass *klass,
								 const gchar      *first_name, ...);

Wim Taymans's avatar
Wim Taymans committed
193 194
#define 		gst_element_default_deep_notify 	gst_object_default_deep_notify

195
void 			gst_element_default_error		(GObject *object, GstObject *orig, gchar *error);
196

197
GType			gst_element_get_type		(void);
Wim Taymans's avatar
Wim Taymans committed
198
#define			gst_element_destroy(element)	gst_object_destroy (GST_OBJECT (element))
Erik Walthinsen's avatar
Erik Walthinsen committed
199

Wim Taymans's avatar
Wim Taymans committed
200 201
void			gst_element_set_loop_function	(GstElement *element,
							 GstElementLoopFunction loop);
Erik Walthinsen's avatar
Erik Walthinsen committed
202

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
203
#define			gst_element_get_name(elem)	gst_object_get_name(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
204
#define			gst_element_set_name(elem,name)	gst_object_set_name(GST_OBJECT(elem),name)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
205
#define			gst_element_get_parent(elem)	gst_object_get_parent(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
206
#define			gst_element_set_parent(elem,parent)	gst_object_set_parent(GST_OBJECT(elem),parent)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
207

208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
/* 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);

224 225 226
/* clocking */
gboolean		gst_element_requires_clock	(GstElement *element);
gboolean		gst_element_provides_clock	(GstElement *element);
227 228
GstClock*		gst_element_get_clock 		(GstElement *element);
void			gst_element_set_clock 		(GstElement *element, GstClock *clock);
229 230
GstClockReturn		gst_element_clock_wait 		(GstElement *element, 
							 GstClockID id, GstClockTimeDiff *jitter);
Wim Taymans's avatar
Wim Taymans committed
231
/* indexs */
Wim Taymans's avatar
Wim Taymans committed
232
gboolean		gst_element_is_indexable	(GstElement *element);
Wim Taymans's avatar
Wim Taymans committed
233 234
void			gst_element_set_index		(GstElement *element, GstIndex *index);
GstIndex*		gst_element_get_index		(GstElement *element);
235

236 237

gboolean		gst_element_release_locks	(GstElement *element);
238

239
void			gst_element_yield		(GstElement *element);
240
gboolean		gst_element_interrupt		(GstElement *element);
241 242
void			gst_element_set_scheduler	(GstElement *element, GstScheduler *sched);
GstScheduler*		gst_element_get_scheduler	(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
243

Wim Taymans's avatar
Wim Taymans committed
244
void			gst_element_add_pad		(GstElement *element, GstPad *pad);
245
void			gst_element_remove_pad		(GstElement *element, GstPad *pad);
246
GstPad *		gst_element_add_ghost_pad	(GstElement *element, GstPad *pad, const gchar *name);
247 248
void			gst_element_remove_ghost_pad	(GstElement *element, GstPad *pad);

Wim Taymans's avatar
Wim Taymans committed
249
GstPad*			gst_element_get_pad		(GstElement *element, const gchar *name);
250 251
GstPad*			gst_element_get_static_pad	(GstElement *element, const gchar *name);
GstPad*			gst_element_get_request_pad	(GstElement *element, const gchar *name);
252
void			gst_element_release_request_pad	(GstElement *element, GstPad *pad);
253

254
const GList*		gst_element_get_pad_list	(GstElement *element);
255
GstPad*			gst_element_get_compatible_pad	(GstElement *element, GstPad *pad);
Benjamin Otte's avatar
Benjamin Otte committed
256 257
GstPad*			gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad, 
							 GstCaps *filtercaps);
258
/* unimplemented
259 260
GstPad*			gst_element_get_compatible_request_pad (GstElement *element, GstPadTemplate *templ);
GstPad*			gst_element_get_compatible_static_pad (GstElement *element, GstPadTemplate *templ);
261 262
*/

263
GstPadTemplate*		gst_element_get_pad_template		(GstElement *element, const gchar *name);
264 265
GList*			gst_element_get_pad_template_list	(GstElement *element);
GstPadTemplate*		gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
266

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

282
gboolean		gst_element_send_event		(GstElement *element, GstEvent *event);
Wim Taymans's avatar
Wim Taymans committed
283 284
gboolean		gst_element_query		(GstElement *element, GstPadQueryType type,
			                                 GstFormat *format, gint64 *value);
285

286
void			gst_element_set_eos		(GstElement *element);
287

288
void 			gst_element_error 		(GstElement *element, const gchar *error, ...);
289

290
GstElementState         gst_element_get_state           (GstElement *element);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
291
GstElementStateReturn	gst_element_set_state		(GstElement *element, GstElementState state);
292 293 294

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

297
GstElementFactory*	gst_element_get_factory		(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
298

299 300
GstBin*			gst_element_get_managing_bin	(GstElement *element);

Wim Taymans's avatar
Wim Taymans committed
301

Wim Taymans's avatar
Wim Taymans committed
302
/*
303 304 305 306
 *
 * factories stuff
 *
 **/
307 308 309 310 311
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
312
  gchar *license;               /* license element is under */
313 314 315 316 317 318
  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.) */
};

319 320
#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,\
321
						 GstElementFactory))
322
#define GST_ELEMENT_FACTORY_CLASS(klass) 	(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
323
						 GstElementFactoryClass))
324 325
#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))
326

327 328 329 330 331
#define GST_ELEMENT_RANK_PRIMARY    256
#define GST_ELEMENT_RANK_SECONDARY  128
#define GST_ELEMENT_RANK_MARGINAL   64
#define GST_ELEMENT_RANK_NONE       0

332 333 334 335 336
struct _GstElementFactory {
  GstPluginFeature feature;

  GType type;			/* unique GType of element */

Joshua N. Pritikin's avatar
Joshua N. Pritikin committed
337 338
  guint details_dynamic : 1;

339 340 341 342
  GstElementDetails *details;	/* pointer to details struct */

  GList *padtemplates;
  guint16 numpadtemplates;
343 344

  guint16 rank;			/* used by autoplug to prioritise elements to try */
345 346 347 348 349 350
};

struct _GstElementFactoryClass {
  GstPluginFeatureClass parent_class;
};

351
GType 			gst_element_factory_get_type 		(void);
352

353
GstElementFactory*	gst_element_factory_new			(const gchar *name, GType type,
Wim Taymans's avatar
Wim Taymans committed
354
                                                                 GstElementDetails *details);
355
GstElementFactory*	gst_element_factory_find		(const gchar *name);
Erik Walthinsen's avatar
Erik Walthinsen committed
356

357
void			gst_element_factory_add_pad_template	(GstElementFactory *elementfactory,
358
								 GstPadTemplate *templ);
359

360
gboolean		gst_element_factory_can_src_caps	(GstElementFactory *factory,
Wim Taymans's avatar
Wim Taymans committed
361
								 GstCaps *caps);
362
gboolean		gst_element_factory_can_sink_caps	(GstElementFactory *factory,
Wim Taymans's avatar
Wim Taymans committed
363
								 GstCaps *caps);
Erik Walthinsen's avatar
Erik Walthinsen committed
364

365
GstElement*		gst_element_factory_create		(GstElementFactory *factory,
366
								 const gchar *name);
367
GstElement*		gst_element_factory_make		(const gchar *factoryname, const gchar *name);
368
GstElement*		gst_element_factory_make_or_warn	(const gchar *factoryname, const gchar *name);
369

370 371
void			gst_element_factory_set_rank		(GstElementFactory *factory, guint16 rank);

372
G_END_DECLS
Erik Walthinsen's avatar
Erik Walthinsen committed
373 374


375
#endif /* __GST_ELEMENT_H__ */
Erik Walthinsen's avatar
Erik Walthinsen committed
376