gstelement.h 19.8 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 38 39
G_BEGIN_DECLS

typedef struct _GstElementDetails GstElementDetails;
40 41

/* FIXME: need translatable stuff in here (how handle in registry)? */
42 43 44 45 46
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? */
47

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
GSTREAMER_EXPORT GType _gst_element_type;
74 75 76

#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 131
  GST_ELEMENT_FLAG_LAST		= GST_OBJECT_FLAG_LAST + 16
} GstElementFlags;
132

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", __msg); \
148
  GST_ERROR_OBJECT (el, "%s", __dbg); \
149
  gst_element_error_full (GST_ELEMENT(el), \
150
  GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code, \
151 152
  __msg, __dbg, __FILE__, GST_FUNCTION, __LINE__); \
} G_STMT_END
153

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

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

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

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

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

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

  /* element pads */
177 178 179 180
  guint16 		numpads;
  guint16 		numsrcpads;
  guint16 		numsinkpads;
  GList 		*pads;
181

182 183
  GMutex 		*state_mutex;
  GCond 		*state_cond;
184

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

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

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

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

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

202
  /* templates for our pads */
203 204 205
  GList 		*padtemplates;
  gint 			numpadtemplates;
  
Erik Walthinsen's avatar
Erik Walthinsen committed
206
  /* signal callbacks */
207 208 209 210 211 212
  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, GError *error, gchar *debug);
  void (*eos)		(GstElement *element);
  void (*found_tag)	(GstElement *element, GstElement *source, const GstTagList *tag_list);
213 214

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

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

  /* query/convert/events functions */
222 223 224 225 226 227 228 229 230
  const GstEventMask*   (*get_event_masks)     	(GstElement *element);
  gboolean		(*send_event)		(GstElement *element, GstEvent *event);
  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,
		  				 GstFormat *format, gint64 *value);
231

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

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

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

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

247
  GstElementStateReturn	(*set_state)		(GstElement *element, GstElementState state);
248 249 250 251 252

  /* FIXME 0.9: move up to signals */
  void			(*no_more_pads)		(GstElement *element);
  
  gpointer _gst_reserved[GST_PADDING - 1];
Erik Walthinsen's avatar
Erik Walthinsen committed
253 254
};

255 256 257 258 259
void			gst_element_class_add_pad_template	(GstElementClass *klass, GstPadTemplate *templ);
void                    gst_element_class_install_std_props	(GstElementClass *klass,
								 const gchar      *first_name, ...);
void			gst_element_class_set_details		(GstElementClass *klass,
								 const GstElementDetails *details);
260

Wim Taymans's avatar
Wim Taymans committed
261 262
#define 		gst_element_default_deep_notify 	gst_object_default_deep_notify

263
void 			gst_element_default_error		(GObject *object, GstObject *orig, GError *error, gchar *debug);
264

265 266 267
GType			gst_element_get_type		(void);
void			gst_element_set_loop_function	(GstElement *element,
							 GstElementLoopFunction loop);
Erik Walthinsen's avatar
Erik Walthinsen committed
268

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
269
#define			gst_element_get_name(elem)	gst_object_get_name(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
270
#define			gst_element_set_name(elem,name)	gst_object_set_name(GST_OBJECT(elem),name)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
271
#define			gst_element_get_parent(elem)	gst_object_get_parent(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
272
#define			gst_element_set_parent(elem,parent)	gst_object_set_parent(GST_OBJECT(elem),parent)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
273

274
/* threadsafe versions of their g_object_* counterparts */
275 276 277 278 279 280 281 282 283 284 285 286 287 288
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);
289

290
/* clocking */
291 292 293 294 295 296 297 298 299
gboolean		gst_element_requires_clock	(GstElement *element);
gboolean		gst_element_provides_clock	(GstElement *element);
GstClock*		gst_element_get_clock 		(GstElement *element);
void			gst_element_set_clock 		(GstElement *element, GstClock *clock);
GstClockReturn		gst_element_clock_wait 		(GstElement *element, 
							 GstClockID id, GstClockTimeDiff *jitter);
GstClockTime		gst_element_get_time		(GstElement *element);
gboolean		gst_element_wait		(GstElement *element, GstClockTime timestamp);
void			gst_element_set_time		(GstElement *element, GstClockTime time);
300 301
void			gst_element_set_time_delay	(GstElement *element, GstClockTime time, GstClockTime delay);

302 303
void			gst_element_adjust_time		(GstElement *element, GstClockTimeDiff diff);
 
Wim Taymans's avatar
Wim Taymans committed
304
/* indexs */
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
gboolean		gst_element_is_indexable	(GstElement *element);
void			gst_element_set_index		(GstElement *element, GstIndex *index);
GstIndex*		gst_element_get_index		(GstElement *element);


gboolean		gst_element_release_locks	(GstElement *element);

void			gst_element_yield		(GstElement *element);
gboolean		gst_element_interrupt		(GstElement *element);
void			gst_element_set_scheduler	(GstElement *element, GstScheduler *sched);
GstScheduler*		gst_element_get_scheduler	(GstElement *element);

void			gst_element_add_pad		(GstElement *element, GstPad *pad);
void			gst_element_remove_pad		(GstElement *element, GstPad *pad);
GstPad *		gst_element_add_ghost_pad	(GstElement *element, GstPad *pad, const gchar *name);
320
#ifndef GST_DISABLE_DEPRECATED
321
void			gst_element_remove_ghost_pad	(GstElement *element, GstPad *pad);
322 323
#endif
void			gst_element_no_more_pads	(GstElement *element);
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398

GstPad*			gst_element_get_pad		(GstElement *element, const gchar *name);
GstPad*			gst_element_get_static_pad	(GstElement *element, const gchar *name);
GstPad*			gst_element_get_request_pad	(GstElement *element, const gchar *name);
void			gst_element_release_request_pad	(GstElement *element, GstPad *pad);

G_CONST_RETURN GList*
			gst_element_get_pad_list	(GstElement *element);
GstPad*			gst_element_get_compatible_pad	(GstElement *element, GstPad *pad);
GstPad*			gst_element_get_compatible_pad_filtered (GstElement *element, GstPad *pad, 
							 const GstCaps *filtercaps);

GstPadTemplate*		gst_element_class_get_pad_template	(GstElementClass *element_class, const gchar *name);
GList*                  gst_element_class_get_pad_template_list (GstElementClass *element_class);
GstPadTemplate*		gst_element_get_pad_template		(GstElement *element, const gchar *name);
GList*			gst_element_get_pad_template_list	(GstElement *element);
GstPadTemplate*		gst_element_get_compatible_pad_template (GstElement *element, GstPadTemplate *compattempl);

gboolean		gst_element_link		(GstElement *src, GstElement *dest);
gboolean		gst_element_link_many 		(GstElement *element_1, 
							 GstElement *element_2, ...);
gboolean		gst_element_link_filtered 	(GstElement *src, GstElement *dest,
							 const GstCaps *filtercaps);
void			gst_element_unlink 		(GstElement *src, GstElement *dest);
void			gst_element_unlink_many 	(GstElement *element_1, 
							 GstElement *element_2, ...);

gboolean		gst_element_link_pads		(GstElement *src, const gchar *srcpadname,
							 GstElement *dest, const gchar *destpadname);
gboolean		gst_element_link_pads_filtered 	(GstElement *src, const gchar *srcpadname,
							 GstElement *dest, const gchar *destpadname,
							 const GstCaps *filtercaps);
void			gst_element_unlink_pads		(GstElement *src, const gchar *srcpadname,
							 GstElement *dest, const gchar *destpadname);

G_CONST_RETURN GstEventMask*
			gst_element_get_event_masks	(GstElement *element);
gboolean		gst_element_send_event		(GstElement *element, GstEvent *event);
gboolean		gst_element_seek		(GstElement *element, GstSeekType seek_type,
							 guint64 offset);
G_CONST_RETURN GstQueryType*
			gst_element_get_query_types	(GstElement *element);
gboolean		gst_element_query		(GstElement *element, GstQueryType type,
			                                 GstFormat *format, gint64 *value);
G_CONST_RETURN GstFormat*
			gst_element_get_formats		(GstElement *element);
gboolean		gst_element_convert		(GstElement *element, 
		 					 GstFormat  src_format,  gint64  src_value,
							 GstFormat *dest_format, gint64 *dest_value);

void			gst_element_found_tags		(GstElement *element, const GstTagList *tag_list);
void			gst_element_found_tags_for_pad	(GstElement *element, GstPad *pad, GstClockTime timestamp, 
							 GstTagList *list);

void			gst_element_set_eos		(GstElement *element);

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

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);

GstElementState         gst_element_get_state           (GstElement *element);
GstElementStateReturn	gst_element_set_state		(GstElement *element, GstElementState state);

void 			gst_element_wait_state_change 	(GstElement *element);
	
G_CONST_RETURN gchar*	gst_element_state_get_name	(GstElementState state);

GstElementFactory*	gst_element_get_factory		(GstElement *element);

GstBin*			gst_element_get_managing_bin	(GstElement *element);
399

Wim Taymans's avatar
Wim Taymans committed
400

Wim Taymans's avatar
Wim Taymans committed
401
/*
402 403 404 405
 *
 * factories stuff
 *
 **/
406

407 408
#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,\
409
						 GstElementFactory))
410
#define GST_ELEMENT_FACTORY_CLASS(klass) 	(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
411
						 GstElementFactoryClass))
412 413
#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))
414

415 416
struct _GstElementFactory {
  GstPluginFeature	parent;
417

418
  GType			type;			/* unique GType of element or 0 if not loaded */
419

420
  GstElementDetails	details;
Joshua N. Pritikin's avatar
Joshua N. Pritikin committed
421

422 423
  GList *		padtemplates;
  guint			numpadtemplates;
424

Benjamin Otte's avatar
Benjamin Otte committed
425
  /* URI interface stuff */
426 427 428 429
  guint			uri_type;
  gchar **		uri_protocols;
  
  GList *		interfaces;		/* interfaces this element implements */
Benjamin Otte's avatar
Benjamin Otte committed
430

431
  gpointer _gst_reserved[GST_PADDING];
432 433
};

434
struct _GstElementFactoryClass {
435
  GstPluginFeatureClass parent_class;
436

437
  gpointer _gst_reserved[GST_PADDING];
438 439
};

440 441 442
GType 			gst_element_factory_get_type 		(void);

gboolean		gst_element_register			(GstPlugin *plugin,
443
								 const gchar *name,
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
								 guint rank,
								 GType type);

GstElementFactory *	gst_element_factory_find		(const gchar *name);
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);
guint			gst_element_factory_get_num_pad_templates (GstElementFactory *factory);
G_CONST_RETURN GList *	gst_element_factory_get_pad_templates	(GstElementFactory *factory);
guint			gst_element_factory_get_uri_type	(GstElementFactory *factory);		
gchar **		gst_element_factory_get_uri_protocols	(GstElementFactory *factory);		

GstElement*		gst_element_factory_create		(GstElementFactory *factory,
								 const gchar *name);
GstElement*		gst_element_factory_make		(const gchar *factoryname, const gchar *name);

gboolean		gst_element_factory_can_src_caps	(GstElementFactory *factory,
								 const GstCaps *caps);
gboolean		gst_element_factory_can_sink_caps	(GstElementFactory *factory,
								 const GstCaps *caps);

void			__gst_element_factory_add_pad_template	(GstElementFactory *elementfactory,
								 GstPadTemplate *templ);
void			__gst_element_factory_add_interface	(GstElementFactory *elementfactory,
								 const gchar *interfacename);
471

472

473
G_END_DECLS
474 475


476
#endif /* __GST_ELEMENT_H__ */
477