gstelement.h 19.5 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/gstplugin.h>
33
#include <gst/gstpluginfeature.h>
Wim Taymans's avatar
Wim Taymans committed
34
#include <gst/gstindex.h>
Benjamin Otte's avatar
Benjamin Otte committed
35
#include <gst/gsttag.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
36

37
G_BEGIN_DECLS
Erik Walthinsen's avatar
Erik Walthinsen committed
38

39 40 41 42 43 44 45 46 47
typedef struct _GstElementDetails GstElementDetails;

/* FIXME: need translatable stuff in here (how handle in registry)? */
struct _GstElementDetails {
  gchar *longname;              /* long, english name */
  gchar *klass;                 /* type of element, as hierarchy */
  gchar *description;           /* insights of one form or another */
  gchar *author;                /* who wrote this thing? */

48
  gpointer _gst_reserved[GST_PADDING];
49 50
};
#define GST_ELEMENT_DETAILS(longname,klass,description,author)		\
51
  { longname, klass, description, author, GST_PADDING_INIT }
52 53 54 55
#define GST_IS_ELEMENT_DETAILS(details) (					\
  (details) && ((details)->longname != NULL) && ((details)->klass != NULL)	\
  && ((details)->description != NULL) && ((details)->author != NULL))

56
#define GST_NUM_STATES 4
Erik Walthinsen's avatar
Erik Walthinsen committed
57

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

64
/* Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g> */
65
#define GST_STATE_TRANSITION(obj)	((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
66
#define GST_STATE_NULL_TO_READY		((GST_STATE_NULL<<8) | GST_STATE_READY)
67
#define GST_STATE_READY_TO_PAUSED	((GST_STATE_READY<<8) | GST_STATE_PAUSED)
68
#define GST_STATE_PAUSED_TO_PLAYING	((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
69 70
#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)
71
#define GST_STATE_READY_TO_NULL		((GST_STATE_READY<<8) | GST_STATE_NULL)
72

73 74 75 76
extern GType _gst_element_type;

#define GST_TYPE_ELEMENT		(_gst_element_type)
#define GST_IS_ELEMENT(obj)		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
Wim Taymans's avatar
Wim Taymans committed
77 78
#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))
79 80
#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))
Erik Walthinsen's avatar
Erik Walthinsen committed
81

82
/* convenience functions */
83
#ifndef GST_DISABLE_DEPRECATED
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
#ifdef G_HAVE_ISO_VARARGS
#define GST_ELEMENT_QUERY_TYPE_FUNCTION(functionname, ...) \
	GST_QUERY_TYPE_FUNCTION (GstElement*, functionname, __VA_ARGS__);
#define GST_ELEMENT_FORMATS_FUNCTION(functionname, ...)    \
	GST_FORMATS_FUNCTION (GstElement*, functionname, __VA_ARGS__);
#define GST_ELEMENT_EVENT_MASK_FUNCTION(functionname, ...) \
	GST_EVENT_MASK_FUNCTION (GstElement*, functionname, __VA_ARGS__);
#elif defined(G_HAVE_GNUC_VARARGS)
#define GST_ELEMENT_QUERY_TYPE_FUNCTION(functionname, a...) \
	GST_QUERY_TYPE_FUNCTION (GstElement*, functionname, a);
#define GST_ELEMENT_FORMATS_FUNCTION(functionname, a...)    \
	GST_FORMATS_FUNCTION (GstElement*, functionname, a);
#define GST_ELEMENT_EVENT_MASK_FUNCTION(functionname, a...) \
	GST_EVENT_MASK_FUNCTION (GstElement*, functionname, a);
#endif
99
#endif
100

101
typedef enum {
Wim Taymans's avatar
Wim Taymans committed
102
  /* element is complex (for some def.) and generally require a cothread */
103
  GST_ELEMENT_COMPLEX		= GST_OBJECT_FLAG_LAST,
Wim Taymans's avatar
Wim Taymans committed
104 105
  /* input and output pads aren't directly coupled to each other
     examples: queues, multi-output async readers, etc. */
106
  GST_ELEMENT_DECOUPLED,
Wim Taymans's avatar
Wim Taymans committed
107
  /* this element should be placed in a thread if at all possible */
108
  GST_ELEMENT_THREAD_SUGGESTED,
109 110 111
  /* 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
112
  /* there is a new loopfunction ready for placement */
113
  GST_ELEMENT_NEW_LOOPFUNC,
114 115
  /* if this element can handle events */
  GST_ELEMENT_EVENT_AWARE,
116 117 118 119 120 121
  /* 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,
122

123 124 125
  /* ignore state changes from parent */
  GST_ELEMENT_LOCKED_STATE,

126
  /* element is in error */
127
  GST_ELEMENT_IN_ERROR,
128

129
  /* use some padding for future expansion */
130
  GST_ELEMENT_FLAG_LAST		= GST_OBJECT_FLAG_LAST + 16
131 132
} GstElementFlags;

133
#define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)	(GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
134
#define GST_ELEMENT_IS_EVENT_AWARE(obj)		(GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
135
#define GST_ELEMENT_IS_DECOUPLED(obj)		(GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
136

137 138
#define GST_ELEMENT_NAME(obj)			(GST_OBJECT_NAME(obj))
#define GST_ELEMENT_PARENT(obj)			(GST_OBJECT_PARENT(obj))
139 140
#define GST_ELEMENT_MANAGER(obj)		(((GstElement*)(obj))->manager)
#define GST_ELEMENT_SCHED(obj)			(((GstElement*)(obj))->sched)
141
#define GST_ELEMENT_CLOCK(obj)			(((GstElement*)(obj))->clock)
Wim Taymans's avatar
Wim Taymans committed
142
#define GST_ELEMENT_PADS(obj)			((obj)->pads)
143

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
144
#define GST_ELEMENT_ERROR(el, domain, code, message, debug) G_STMT_START { \
145 146
  gchar *__msg = _gst_element_error_printf message; \
  gchar *__dbg = _gst_element_error_printf debug; \
147
  GST_ERROR_OBJECT (el, "%s", __dbg); \
148
  gst_element_error_full (GST_ELEMENT(el), \
149
  GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code, \
150 151
  __msg, __dbg, __FILE__, GST_FUNCTION, __LINE__); \
} G_STMT_END
152

Erik Walthinsen's avatar
Erik Walthinsen committed
153
typedef struct _GstElementFactory GstElementFactory;
154
typedef struct _GstElementFactoryClass GstElementFactoryClass;
Erik Walthinsen's avatar
Erik Walthinsen committed
155

156
typedef void 		(*GstElementLoopFunction) 	(GstElement *element);
157 158
typedef void 		(*GstElementPreRunFunction) 	(GstElement *element);
typedef void 		(*GstElementPostRunFunction) 	(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
159 160

struct _GstElement {
161
  GstObject 		object;
Erik Walthinsen's avatar
Erik Walthinsen committed
162

163 164 165
  /* element state  and scheduling */
  guint8 		current_state;
  guint8 		pending_state;
Erik Walthinsen's avatar
Erik Walthinsen committed
166
  GstElementLoopFunction loopfunc;
167 168 169

  GstScheduler 		*sched;
  gpointer		sched_private;
Wim Taymans's avatar
Wim Taymans committed
170 171

  /* allocated clock */
172
  GstClock		*clock;
173
  GstClockTimeDiff    	base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
174 175 176 177 178 179

  /* element pads */
  guint16 		numpads;
  guint16 		numsrcpads;
  guint16 		numsinkpads;
  GList 		*pads;
180 181 182

  GMutex 		*state_mutex;
  GCond 		*state_cond;
183 184 185 186 187

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

189
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
190 191 192
};

struct _GstElementClass {
193
  GstObjectClass 	parent_class;
Erik Walthinsen's avatar
Erik Walthinsen committed
194

195 196
  /* the element details */
  GstElementDetails 	details;
197 198 199 200

  /* factory that the element was created from */
  GstElementFactory	*elementfactory;

201
  /* templates for our pads */
202 203
  GList 		*padtemplates;
  gint 			numpadtemplates;
204
  
Erik Walthinsen's avatar
Erik Walthinsen committed
205
  /* signal callbacks */
206 207 208
  void (*state_change)	(GstElement *element, GstElementState old, GstElementState state);
  void (*new_pad)	(GstElement *element, GstPad *pad);
  void (*pad_removed)	(GstElement *element, GstPad *pad);
209
  void (*error)		(GstElement *element, GstElement *source, GError *error, gchar *debug);
210
  void (*eos)		(GstElement *element);
211
  void (*found_tag)	(GstElement *element, GstElement *source, const GstTagList *tag_list);
212 213

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

217
  /* vtable*/
218
  gboolean		(*release_locks)	(GstElement *element);
219 220 221

  /* query/convert/events functions */
  const GstEventMask*   (*get_event_masks)     	(GstElement *element);
222
  gboolean		(*send_event)		(GstElement *element, GstEvent *event);
223 224 225 226 227 228
  const GstFormat*      (*get_formats)        	(GstElement *element);
  gboolean              (*convert)        	(GstElement *element,
		                                 GstFormat  src_format,  gint64  src_value,
						 GstFormat *dest_format, gint64 *dest_value);
  const GstQueryType* 	(*get_query_types)    	(GstElement *element);
  gboolean		(*query)		(GstElement *element, GstQueryType type,
Wim Taymans's avatar
Wim Taymans committed
229
		  				 GstFormat *format, gint64 *value);
230

Erik Walthinsen's avatar
Erik Walthinsen committed
231
  /* change the element state */
232
  GstElementStateReturn (*change_state)		(GstElement *element);
233 234

  /* request/release pads */
235
  GstPad*		(*request_new_pad)	(GstElement *element, GstPadTemplate *templ, const gchar* name);
236
  void			(*release_pad)		(GstElement *element, GstPad *pad);
237

238 239 240
  /* set/get clocks */
  GstClock*		(*get_clock)		(GstElement *element);
  void			(*set_clock)		(GstElement *element, GstClock *clock);
241

Wim Taymans's avatar
Wim Taymans committed
242 243 244
  /* index */
  GstIndex*		(*get_index)		(GstElement *element);
  void			(*set_index)		(GstElement *element, GstIndex *index);
Wim Taymans's avatar
Wim Taymans committed
245

246
  GstElementStateReturn	(*set_state)		(GstElement *element, GstElementState state);
247
  gpointer _gst_reserved[GST_PADDING - 1];
Erik Walthinsen's avatar
Erik Walthinsen committed
248 249
};

250
void			gst_element_class_add_pad_template	(GstElementClass *klass, GstPadTemplate *templ);
251 252
void                    gst_element_class_install_std_props	(GstElementClass *klass,
								 const gchar      *first_name, ...);
253
void			gst_element_class_set_details		(GstElementClass *klass,
David Schleef's avatar
David Schleef committed
254
								 const GstElementDetails *details);
255

Wim Taymans's avatar
Wim Taymans committed
256 257
#define 		gst_element_default_deep_notify 	gst_object_default_deep_notify

258
void 			gst_element_default_error		(GObject *object, GstObject *orig, GError *error, gchar *debug);
259

260
GType			gst_element_get_type		(void);
Wim Taymans's avatar
Wim Taymans committed
261 262
void			gst_element_set_loop_function	(GstElement *element,
							 GstElementLoopFunction loop);
Erik Walthinsen's avatar
Erik Walthinsen committed
263

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
264
#define			gst_element_get_name(elem)	gst_object_get_name(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
265
#define			gst_element_set_name(elem,name)	gst_object_set_name(GST_OBJECT(elem),name)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
266
#define			gst_element_get_parent(elem)	gst_object_get_parent(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
267
#define			gst_element_set_parent(elem,parent)	gst_object_set_parent(GST_OBJECT(elem),parent)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
268

269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
/* 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);

285 286 287
/* clocking */
gboolean		gst_element_requires_clock	(GstElement *element);
gboolean		gst_element_provides_clock	(GstElement *element);
288 289
GstClock*		gst_element_get_clock 		(GstElement *element);
void			gst_element_set_clock 		(GstElement *element, GstClock *clock);
290
#ifndef GST_DISABLE_DEPRECATED
291 292
GstClockReturn		gst_element_clock_wait 		(GstElement *element, 
							 GstClockID id, GstClockTimeDiff *jitter);
293 294 295 296 297
#endif
GstClockTime		gst_element_get_time		(GstElement *element);
gboolean		gst_element_wait		(GstElement *element, GstClockTime timestamp);
void			gst_element_set_time		(GstElement *element, GstClockTime time);
void			gst_element_adjust_time		(GstElement *element, GstClockTimeDiff diff);
Wim Taymans's avatar
Wim Taymans committed
298
 
Wim Taymans's avatar
Wim Taymans committed
299
/* indexs */
Wim Taymans's avatar
Wim Taymans committed
300
gboolean		gst_element_is_indexable	(GstElement *element);
Wim Taymans's avatar
Wim Taymans committed
301 302
void			gst_element_set_index		(GstElement *element, GstIndex *index);
GstIndex*		gst_element_get_index		(GstElement *element);
303

304 305

gboolean		gst_element_release_locks	(GstElement *element);
306

307
void			gst_element_yield		(GstElement *element);
308
gboolean		gst_element_interrupt		(GstElement *element);
309 310
void			gst_element_set_scheduler	(GstElement *element, GstScheduler *sched);
GstScheduler*		gst_element_get_scheduler	(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
311

Wim Taymans's avatar
Wim Taymans committed
312
void			gst_element_add_pad		(GstElement *element, GstPad *pad);
313
void			gst_element_remove_pad		(GstElement *element, GstPad *pad);
314
GstPad *		gst_element_add_ghost_pad	(GstElement *element, GstPad *pad, const gchar *name);
315 316
void			gst_element_remove_ghost_pad	(GstElement *element, GstPad *pad);

Wim Taymans's avatar
Wim Taymans committed
317
GstPad*			gst_element_get_pad		(GstElement *element, const gchar *name);
318 319
GstPad*			gst_element_get_static_pad	(GstElement *element, const gchar *name);
GstPad*			gst_element_get_request_pad	(GstElement *element, const gchar *name);
320
void			gst_element_release_request_pad	(GstElement *element, GstPad *pad);
321

322 323
G_CONST_RETURN GList*
			gst_element_get_pad_list	(GstElement *element);
324
GstPad*			gst_element_get_compatible_pad	(GstElement *element, GstPad *pad);
Benjamin Otte's avatar
Benjamin Otte committed
325
GstPad*			gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad, 
David Schleef's avatar
David Schleef committed
326
							 const GstCaps *filtercaps);
327

328 329
GstPadTemplate*		gst_element_class_get_pad_template	(GstElementClass *element_class, const gchar *name);
GList*                  gst_element_class_get_pad_template_list (GstElementClass *element_class);
330
GstPadTemplate*		gst_element_get_pad_template		(GstElement *element, const gchar *name);
331 332
GList*			gst_element_get_pad_template_list	(GstElement *element);
GstPadTemplate*		gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);
333

334
gboolean		gst_element_link		(GstElement *src, GstElement *dest);
335 336
gboolean		gst_element_link_many 		(GstElement *element_1, 
							 GstElement *element_2, ...);
337
gboolean		gst_element_link_filtered 	(GstElement *src, GstElement *dest,
David Schleef's avatar
David Schleef committed
338
							 const GstCaps *filtercaps);
339
void			gst_element_unlink 		(GstElement *src, GstElement *dest);
340 341
void			gst_element_unlink_many 	(GstElement *element_1, 
							 GstElement *element_2, ...);
342

343
gboolean		gst_element_link_pads		(GstElement *src, const gchar *srcpadname,
Wim Taymans's avatar
Wim Taymans committed
344
							 GstElement *dest, const gchar *destpadname);
345
gboolean		gst_element_link_pads_filtered 	(GstElement *src, const gchar *srcpadname,
346
							 GstElement *dest, const gchar *destpadname,
David Schleef's avatar
David Schleef committed
347
							 const GstCaps *filtercaps);
348
void			gst_element_unlink_pads		(GstElement *src, const gchar *srcpadname,
Wim Taymans's avatar
Wim Taymans committed
349
							 GstElement *dest, const gchar *destpadname);
Erik Walthinsen's avatar
Erik Walthinsen committed
350

351 352
G_CONST_RETURN GstEventMask*
			gst_element_get_event_masks	(GstElement *element);
353
gboolean		gst_element_send_event		(GstElement *element, GstEvent *event);
354 355
gboolean		gst_element_seek		(GstElement *element, GstSeekType seek_type,
							 guint64 offset);
356 357
G_CONST_RETURN GstQueryType*
			gst_element_get_query_types	(GstElement *element);
358
gboolean		gst_element_query		(GstElement *element, GstQueryType type,
Wim Taymans's avatar
Wim Taymans committed
359
			                                 GstFormat *format, gint64 *value);
360 361
G_CONST_RETURN GstFormat*
			gst_element_get_formats		(GstElement *element);
362 363 364
gboolean		gst_element_convert		(GstElement *element, 
		 					 GstFormat  src_format,  gint64  src_value,
							 GstFormat *dest_format, gint64 *dest_value);
365

366
void			gst_element_found_tags		(GstElement *element, const GstTagList *tag_list);
Benjamin Otte's avatar
Benjamin Otte committed
367 368 369
void			gst_element_found_tags_for_pad	(GstElement *element, GstPad *pad, GstClockTime timestamp, 
							 GstTagList *list);

370
void			gst_element_set_eos		(GstElement *element);
371

372
gchar *			_gst_element_error_printf	(const gchar *format, ...);
373 374 375
void			gst_element_error_full		(GstElement *element, GQuark domain, gint code, 
							 gchar *message, gchar *debug, 
							 const gchar *file, const gchar *function, gint line);
376

Benjamin Otte's avatar
Benjamin Otte committed
377 378 379
gboolean		gst_element_is_locked_state	(GstElement *element);
void			gst_element_set_locked_state	(GstElement *element, gboolean locked_state);
gboolean		gst_element_sync_state_with_parent (GstElement *element);
380

381
GstElementState         gst_element_get_state           (GstElement *element);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
382
GstElementStateReturn	gst_element_set_state		(GstElement *element, GstElementState state);
383 384 385

void 			gst_element_wait_state_change 	(GstElement *element);
	
386
G_CONST_RETURN gchar*	gst_element_state_get_name	(GstElementState state);
Erik Walthinsen's avatar
Erik Walthinsen committed
387

388 389
GstElementFactory*	gst_element_get_factory		(GstElement *element);

390 391
GstBin*			gst_element_get_managing_bin	(GstElement *element);

Wim Taymans's avatar
Wim Taymans committed
392

Wim Taymans's avatar
Wim Taymans committed
393
/*
394 395 396 397
 *
 * factories stuff
 *
 **/
398

399 400
#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,\
401
						 GstElementFactory))
402
#define GST_ELEMENT_FACTORY_CLASS(klass) 	(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
403
						 GstElementFactoryClass))
404 405
#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))
406 407

struct _GstElementFactory {
408
  GstPluginFeature	parent;
409

410
  GType			type;			/* unique GType of element or 0 if not loaded */
411

412
  GstElementDetails	details;
Joshua N. Pritikin's avatar
Joshua N. Pritikin committed
413

414 415
  GList *		padtemplates;
  guint			numpadtemplates;
416

Benjamin Otte's avatar
Benjamin Otte committed
417 418 419 420 421
  /* URI interface stuff */
  guint			uri_type;
  gchar **		uri_protocols;
  
  GList *		interfaces;		/* interfaces this element implements */
Benjamin Otte's avatar
Benjamin Otte committed
422

423
  gpointer _gst_reserved[GST_PADDING];
424 425 426 427
};

struct _GstElementFactoryClass {
  GstPluginFeatureClass parent_class;
428

429
  gpointer _gst_reserved[GST_PADDING];
430 431
};

432
GType 			gst_element_factory_get_type 		(void);
433

434 435 436 437 438
gboolean		gst_element_register			(GstPlugin *plugin,
								 const gchar *elementname,
								 guint rank,
								 GType type);

439
GstElementFactory *	gst_element_factory_find		(const gchar *name);
440 441 442 443 444
GType			gst_element_factory_get_element_type	(GstElementFactory *factory);
G_CONST_RETURN gchar *	gst_element_factory_get_longname	(GstElementFactory *factory);
G_CONST_RETURN gchar *	gst_element_factory_get_klass		(GstElementFactory *factory);
G_CONST_RETURN gchar *	gst_element_factory_get_description  	(GstElementFactory *factory);
G_CONST_RETURN gchar *	gst_element_factory_get_author		(GstElementFactory *factory);
445 446
guint			gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
G_CONST_RETURN GList *	gst_element_factory_get_pad_templates	(GstElementFactory *factory);
Benjamin Otte's avatar
Benjamin Otte committed
447 448
guint			gst_element_factory_get_uri_type	(GstElementFactory *factory);		
gchar **		gst_element_factory_get_uri_protocols	(GstElementFactory *factory);		
Erik Walthinsen's avatar
Erik Walthinsen committed
449

450 451 452
GstElement*		gst_element_factory_create		(GstElementFactory *factory,
								 const gchar *name);
GstElement*		gst_element_factory_make		(const gchar *factoryname, const gchar *name);
453

454
gboolean		gst_element_factory_can_src_caps	(GstElementFactory *factory,
David Schleef's avatar
David Schleef committed
455
								 const GstCaps *caps);
456
gboolean		gst_element_factory_can_sink_caps	(GstElementFactory *factory,
David Schleef's avatar
David Schleef committed
457
								 const GstCaps *caps);
Erik Walthinsen's avatar
Erik Walthinsen committed
458

459 460
void			__gst_element_factory_add_pad_template	(GstElementFactory *elementfactory,
								 GstPadTemplate *templ);
Benjamin Otte's avatar
Benjamin Otte committed
461 462
void			__gst_element_factory_add_interface	(GstElementFactory *elementfactory,
								 const gchar *interfacename);
463

464

465
G_END_DECLS
Erik Walthinsen's avatar
Erik Walthinsen committed
466 467


468
#endif /* __GST_ELEMENT_H__ */
Erik Walthinsen's avatar
Erik Walthinsen committed
469