gstelement.h 20.6 KB
Newer Older
1 2 3
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
 *                    2000 Wim Taymans <wtay@chello.be>
4
 *                    2004 Wim Taymans <wim@fluendo.com>
5 6
 *
 * gstelement.h: Header for GstElement
Erik Walthinsen's avatar
Erik Walthinsen committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 *
 * 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__

28
#include <gst/gstconfig.h>
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/gstplugin.h>
34
#include <gst/gstpluginfeature.h>
Wim Taymans's avatar
Wim Taymans committed
35
#include <gst/gstindex.h>
36
#include <gst/gstiterator.h>
Benjamin Otte's avatar
Benjamin Otte committed
37
#include <gst/gsttag.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
38

39 40 41
G_BEGIN_DECLS

typedef struct _GstElementDetails GstElementDetails;
42 43

/* FIXME: need translatable stuff in here (how handle in registry)? */
44 45 46
struct _GstElementDetails
{
  /*< public > */
47 48 49 50
  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? */
51

52
  /*< private > */
53
  gpointer _gst_reserved[GST_PADDING];
54
};
55

56
#define GST_ELEMENT_DETAILS(longname,klass,description,author)		\
57
  { longname, klass, description, author, GST_PADDING_INIT }
58 59 60 61
#define GST_IS_ELEMENT_DETAILS(details) (					\
  (details) && ((details)->longname != NULL) && ((details)->klass != NULL)	\
  && ((details)->description != NULL) && ((details)->author != NULL))

62
#define GST_NUM_STATES 4
Erik Walthinsen's avatar
Erik Walthinsen committed
63

64 65 66
/* NOTE: this probably should be done with an #ifdef to decide 
 * whether to safe-cast or to just do the non-checking cast.
 */
67 68
#define GST_STATE(obj)			(GST_ELEMENT(obj)->current_state)
#define GST_STATE_PENDING(obj)		(GST_ELEMENT(obj)->pending_state)
69
#define GST_STATE_ERROR(obj)		(GST_ELEMENT(obj)->state_error)
70

71
/* Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g> */
72
#define GST_STATE_TRANSITION(obj)	((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
73
#define GST_STATE_NULL_TO_READY		((GST_STATE_NULL<<8) | GST_STATE_READY)
74
#define GST_STATE_READY_TO_PAUSED	((GST_STATE_READY<<8) | GST_STATE_PAUSED)
75
#define GST_STATE_PAUSED_TO_PLAYING	((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
76 77
#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)
78
#define GST_STATE_READY_TO_NULL		((GST_STATE_READY<<8) | GST_STATE_NULL)
79

80
GST_EXPORT GType _gst_element_type;
81 82 83

#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
84 85
#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))
86 87
#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))
88
#define GST_ELEMENT_CAST(obj)		((GstElement*)(obj))
Erik Walthinsen's avatar
Erik Walthinsen committed
89

90
/* convenience functions */
91
#ifndef GST_DISABLE_DEPRECATED
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
#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
107
#endif
108

109 110
typedef enum
{
Wim Taymans's avatar
Wim Taymans committed
111 112
  /* input and output pads aren't directly coupled to each other
     examples: queues, multi-output async readers, etc. */
113
  GST_ELEMENT_DECOUPLED,
114 115 116
  /* 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
117
  /* there is a new loopfunction ready for placement */
118
  GST_ELEMENT_NEW_LOOPFUNC,
119 120
  /* if this element can handle events */
  GST_ELEMENT_EVENT_AWARE,
121 122 123
  /* use threadsafe property get/set implementation */
  GST_ELEMENT_USE_THREADSAFE_PROPERTIES,

124

125 126 127
  /* private flags that can be used by the scheduler */
  GST_ELEMENT_SCHEDULER_PRIVATE1,
  GST_ELEMENT_SCHEDULER_PRIVATE2,
128

129 130 131
  /* ignore state changes from parent */
  GST_ELEMENT_LOCKED_STATE,

132
  /* element is in error */
133
  GST_ELEMENT_IN_ERROR,
134

135
  /* use some padding for future expansion */
136 137
  GST_ELEMENT_FLAG_LAST		= GST_OBJECT_FLAG_LAST + 16
} GstElementFlags;
138

139
#define GST_ELEMENT_IS_THREAD_SUGGESTED(obj)	(GST_FLAG_IS_SET(obj,GST_ELEMENT_THREAD_SUGGESTED))
140
#define GST_ELEMENT_IS_EVENT_AWARE(obj)		(GST_FLAG_IS_SET(obj,GST_ELEMENT_EVENT_AWARE))
141
#define GST_ELEMENT_IS_DECOUPLED(obj)		(GST_FLAG_IS_SET(obj,GST_ELEMENT_DECOUPLED))
142

143 144
#define GST_ELEMENT_NAME(obj)			(GST_OBJECT_NAME(obj))
#define GST_ELEMENT_PARENT(obj)			(GST_OBJECT_PARENT(obj))
145
#define GST_ELEMENT_SCHEDULER(obj)		(((GstElement*)(obj))->sched)
146
#define GST_ELEMENT_CLOCK(obj)			(((GstElement*)(obj))->clock)
Wim Taymans's avatar
Wim Taymans committed
147
#define GST_ELEMENT_PADS(obj)			((obj)->pads)
148

149 150 151 152 153 154 155 156 157 158 159 160
/**
 * GST_ELEMENT_ERROR:
 * @el: the element that throws the error
 * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #GstError)
 * @code: error code defined for that domain (see #GstError)
 * @message: the message to display (format string and args enclosed in round brackets)
 * @debug: debugging information for the message (format string and args enclosed in round brackets)
 *
 * Utility function that elements can use in case they encountered a fatal
 * data processing error. The pipeline will throw an error signal and the
 * application will be requested to stop further media processing.
 */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
161
#define GST_ELEMENT_ERROR(el, domain, code, message, debug) G_STMT_START { \
162 163
  gchar *__msg = _gst_element_error_printf message; \
  gchar *__dbg = _gst_element_error_printf debug; \
164 165 166
  if (__msg) \
    GST_ERROR_OBJECT (el, "%s", __msg); \
  if (__dbg) \
167
  GST_ERROR_OBJECT (el, "%s", __dbg); \
168
  gst_element_error_full (GST_ELEMENT(el), \
169
  GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code, \
170 171
  __msg, __dbg, __FILE__, GST_FUNCTION, __LINE__); \
} G_STMT_END
172

Erik Walthinsen's avatar
Erik Walthinsen committed
173
typedef struct _GstElementFactory GstElementFactory;
174
typedef struct _GstElementFactoryClass GstElementFactoryClass;
Erik Walthinsen's avatar
Erik Walthinsen committed
175

176 177 178
typedef void 		(*GstElementLoopFunction) 	(GstElement *element);
typedef void 		(*GstElementPreRunFunction) 	(GstElement *element);
typedef void 		(*GstElementPostRunFunction) 	(GstElement *element);
Erik Walthinsen's avatar
Erik Walthinsen committed
179

180 181
struct _GstElement {
  GstObject 		object;
Erik Walthinsen's avatar
Erik Walthinsen committed
182

183
  /* element state  and scheduling */
184 185
  guint8 		current_state;
  guint8 		pending_state;
Erik Walthinsen's avatar
Erik Walthinsen committed
186
  GstElementLoopFunction loopfunc;
187

188 189
  GstScheduler 		*sched;
  gpointer		sched_private;
Wim Taymans's avatar
Wim Taymans committed
190 191

  /* allocated clock */
192 193
  GstClock		*clock;
  GstClockTimeDiff    	base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
194

195 196 197 198 199 200 201 202 203
   /* element pads, these lists can only be iterated while holding
   * the LOCK or checking the cookie after each LOCK. */
  guint16   numpads;
  GList    *pads;
  guint16   numsrcpads;
  GList    *srcpads;
  guint16   numsinkpads;
  GList    *sinkpads;
  guint32   pads_cookie;
204

205 206
  GMutex 		*state_mutex;
  GCond 		*state_cond;
207

208
  GstElementPreRunFunction  pre_run_func;
209
  GstElementPostRunFunction post_run_func;
210 211
  GAsyncQueue		*prop_value_queue;
  GMutex		*property_mutex;
Wim Taymans's avatar
Wim Taymans committed
212

213
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
214 215
};

216 217 218
struct _GstElementClass
{
  GstObjectClass parent_class;
Erik Walthinsen's avatar
Erik Walthinsen committed
219

220
  /*< public > */
221
  /* the element details */
222
  GstElementDetails 	details;
223 224

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

227
  /* templates for our pads */
228 229 230 231
  GList *padtemplates;
  gint numpadtemplates;
  guint32 pad_templ_cookie;

Erik Walthinsen's avatar
Erik Walthinsen committed
232
  /* signal callbacks */
233 234 235 236 237 238
  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);
239 240

  /* local pointers for get/set */
241 242
  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
243

244 245
  /* vtable*/
  gboolean		(*release_locks)	(GstElement *element);
246 247

  /* query/convert/events functions */
248 249 250 251 252 253 254 255 256
  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);
257

Erik Walthinsen's avatar
Erik Walthinsen committed
258
  /* change the element state */
259
  GstElementStateReturn (*change_state)		(GstElement *element);
260 261

  /* request/release pads */
262 263
  GstPad*		(*request_new_pad)	(GstElement *element, GstPadTemplate *templ, const gchar* name);
  void			(*release_pad)		(GstElement *element, GstPad *pad);
264

265
  /* set/get clocks */
266 267
  GstClock*		(*get_clock)		(GstElement *element);
  void			(*set_clock)		(GstElement *element, GstClock *clock);
268

Wim Taymans's avatar
Wim Taymans committed
269
  /* index */
270 271
  GstIndex*		(*get_index)		(GstElement *element);
  void			(*set_index)		(GstElement *element, GstIndex *index);
Wim Taymans's avatar
Wim Taymans committed
272

273 274 275
  /* scheduler */
  void			(*set_scheduler)	(GstElement *element, GstScheduler *scheduler);

276
  GstElementStateReturn	(*set_state)		(GstElement *element, GstElementState state);
277 278 279 280 281

  /* 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
282 283
};

284 285 286 287 288
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);
289

Wim Taymans's avatar
Wim Taymans committed
290 291
#define 		gst_element_default_deep_notify 	gst_object_default_deep_notify

292
void 			gst_element_default_error		(GObject *object, GstObject *orig, GError *error, gchar *debug);
293

294 295 296
GType			gst_element_get_type		(void);
void			gst_element_set_loop_function	(GstElement *element,
							 GstElementLoopFunction loop);
Erik Walthinsen's avatar
Erik Walthinsen committed
297

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
298
#define			gst_element_get_name(elem)	gst_object_get_name(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
299
#define			gst_element_set_name(elem,name)	gst_object_set_name(GST_OBJECT(elem),name)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
300
#define			gst_element_get_parent(elem)	gst_object_get_parent(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
301
#define			gst_element_set_parent(elem,parent)	gst_object_set_parent(GST_OBJECT(elem),parent)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
302

303
/* threadsafe versions of their g_object_* counterparts */
304 305 306 307 308 309 310 311 312 313 314 315 316 317
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);
318

319
/* clocking */
320 321 322 323 324 325 326 327 328
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);
329 330
void			gst_element_set_time_delay	(GstElement *element, GstClockTime time, GstClockTime delay);

331 332
void			gst_element_adjust_time		(GstElement *element, GstClockTimeDiff diff);
 
Wim Taymans's avatar
Wim Taymans committed
333
/* indexs */
334 335 336 337 338 339 340 341 342 343 344 345
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);

346 347
gboolean		gst_element_add_pad		(GstElement *element, GstPad *pad);
gboolean		gst_element_remove_pad		(GstElement *element, GstPad *pad);
348
GstPad *		gst_element_add_ghost_pad	(GstElement *element, GstPad *pad, const gchar *name);
349
void			gst_element_no_more_pads	(GstElement *element);
350 351 352 353 354 355

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

356 357
GstIterator *gst_element_iterate_pads (GstElement * element);

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 399 400 401 402 403 404 405 406 407 408 409 410 411
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);
412
gboolean		gst_element_set_locked_state	(GstElement *element, gboolean locked_state);
413 414 415 416 417 418 419 420 421 422 423 424
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);
425

Wim Taymans's avatar
Wim Taymans committed
426

Wim Taymans's avatar
Wim Taymans committed
427
/*
428 429 430 431
 *
 * factories stuff
 *
 **/
432

433 434
#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,\
435
						 GstElementFactory))
436
#define GST_ELEMENT_FACTORY_CLASS(klass) 	(G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ELEMENT_FACTORY,\
437
						 GstElementFactoryClass))
438 439
#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))
440

441 442
struct _GstElementFactory {
  GstPluginFeature	parent;
443

444
  GType			type;			/* unique GType of element or 0 if not loaded */
445

446
  GstElementDetails	details;
Joshua N. Pritikin's avatar
Joshua N. Pritikin committed
447

448 449
  GList *		padtemplates;
  guint			numpadtemplates;
450

Benjamin Otte's avatar
Benjamin Otte committed
451
  /* URI interface stuff */
452 453 454 455
  guint			uri_type;
  gchar **		uri_protocols;
  
  GList *		interfaces;		/* interfaces this element implements */
Benjamin Otte's avatar
Benjamin Otte committed
456

457
  gpointer _gst_reserved[GST_PADDING];
458 459
};

460
struct _GstElementFactoryClass {
461
  GstPluginFeatureClass parent_class;
462

463
  gpointer _gst_reserved[GST_PADDING];
464 465
};

466 467 468
GType 			gst_element_factory_get_type 		(void);

gboolean		gst_element_register			(GstPlugin *plugin,
469
								 const gchar *name,
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
								 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);
497

498

499
G_END_DECLS
500 501


502
#endif /* __GST_ELEMENT_H__ */
503