gstelement.h 14.1 KB
Newer Older
1 2
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3
 *               2000,2004 Wim Taymans <wim@fluendo.com>
4 5
 *
 * 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/gstelementfactory.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>
Wim Taymans's avatar
Wim Taymans committed
37
#include <gst/gstmessage.h>
Benjamin Otte's avatar
Benjamin Otte committed
38
#include <gst/gsttag.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
39

40 41
G_BEGIN_DECLS

42
GST_EXPORT GType _gst_element_type;
43

44 45 46 47 48 49 50
#define GST_TYPE_ELEMENT		(_gst_element_type)
#define GST_IS_ELEMENT(obj)		(G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
#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))
#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))
#define GST_ELEMENT_CAST(obj)		((GstElement*)(obj))
51

52
#define GST_NUM_STATES 4
53 54 55
/* NOTE: this probably should be done with an #ifdef to decide 
 * whether to safe-cast or to just do the non-checking cast.
 */
56 57
#define GST_STATE(obj)			(GST_ELEMENT(obj)->current_state)
#define GST_STATE_PENDING(obj)		(GST_ELEMENT(obj)->pending_state)
58
#define GST_STATE_ERROR(obj)		(GST_ELEMENT(obj)->state_error)
59

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

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
/* convenience functions */
#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

86 87
typedef enum
{
88 89 90
  /* private flags that can be used by the scheduler */
  GST_ELEMENT_SCHEDULER_PRIVATE1,
  GST_ELEMENT_SCHEDULER_PRIVATE2,
91

92 93 94
  /* ignore state changes from parent */
  GST_ELEMENT_LOCKED_STATE,

95 96 97
  /* the element is a sink */
  GST_ELEMENT_IS_SINK,

98
  /* use some padding for future expansion */
99 100
  GST_ELEMENT_FLAG_LAST		= GST_OBJECT_FLAG_LAST + 16
} GstElementFlags;
101

102
#define GST_ELEMENT_IS_LOCKED_STATE(obj)        (GST_FLAG_IS_SET(obj,GST_ELEMENT_LOCKED_STATE))
103

104
#define GST_ELEMENT_NAME(obj)			(GST_OBJECT_NAME(obj))
Wim Taymans's avatar
Wim Taymans committed
105 106 107
#define GST_ELEMENT_PARENT(obj)			(GST_ELEMENT_CAST(GST_OBJECT_PARENT(obj)))
#define GST_ELEMENT_MANAGER(obj)		(GST_ELEMENT_CAST(obj)->manager)
#define GST_ELEMENT_BUS(obj)			(GST_ELEMENT_CAST(obj)->bus)
Wim Taymans's avatar
Wim Taymans committed
108
#define GST_ELEMENT_SCHEDULER(obj)		(GST_ELEMENT_CAST(obj)->scheduler)
109 110
#define GST_ELEMENT_CLOCK(obj)			(GST_ELEMENT_CAST(obj)->clock)
#define GST_ELEMENT_PADS(obj)			(GST_ELEMENT_CAST(obj)->pads)
111

112 113 114 115 116 117 118 119 120 121 122 123
/**
 * 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.
 */
Wim Taymans's avatar
Wim Taymans committed
124 125 126 127 128 129 130 131 132 133 134
#define GST_ELEMENT_ERROR(el, domain, code, text, debug)		\
G_STMT_START {								\
  gchar *__txt = _gst_element_error_printf text;			\
  gchar *__dbg = _gst_element_error_printf debug;			\
  if (__txt)								\
    GST_ERROR_OBJECT (el, "%s", __txt);					\
  if (__dbg)								\
    GST_ERROR_OBJECT (el, "%s", __dbg);					\
  gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_ERROR,		\
    GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,	\
    __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);			\
135
} G_STMT_END
136

Wim Taymans's avatar
Wim Taymans committed
137 138 139 140 141 142 143 144 145 146 147 148 149
/* log a (non-fatal) warning message and post it on the bus */
#define GST_ELEMENT_WARNING(el, domain, code, text, debug)		\
G_STMT_START {								\
  gchar *__txt = _gst_element_error_printf text;			\
  gchar *__dbg = _gst_element_error_printf debug;			\
  if (__txt)								\
    GST_WARNING_OBJECT (el, "%s", __txt);				\
  if (__dbg)								\
    GST_WARNING_OBJECT (el, "%s", __dbg);				\
  gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_WARNING,	\
    GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,	\
  __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);			\
} G_STMT_END
Erik Walthinsen's avatar
Erik Walthinsen committed
150

151 152 153 154 155 156 157 158 159 160 161 162
/* the state change mutexes and conds */
#define GST_STATE_GET_LOCK(elem)               (GST_ELEMENT_CAST(elem)->state_lock)
#define GST_STATE_LOCK(elem)                   g_mutex_lock(GST_STATE_GET_LOCK(elem))
#define GST_STATE_TRYLOCK(elem)                g_mutex_trylock(GST_STATE_GET_LOCK(elem))
#define GST_STATE_UNLOCK(elem)                 g_mutex_unlock(GST_STATE_GET_LOCK(elem))
#define GST_STATE_GET_COND(elem)               (GST_ELEMENT_CAST(elem)->state_cond)
#define GST_STATE_WAIT(elem)                   g_cond_wait (GST_STATE_GET_COND (elem), GST_STATE_GET_LOCK (elem))
#define GST_STATE_TIMED_WAIT(elem, timeval)    g_cond_timed_wait (GST_STATE_GET_COND (elem), GST_STATE_GET_LOCK (elem),\
		                                                timeval)
#define GST_STATE_SIGNAL(elem)                 g_cond_signal (GST_STATE_GET_COND (elem));
#define GST_STATE_BROADCAST(elem)              g_cond_broadcast (GST_STATE_GET_COND (elem));

Wim Taymans's avatar
Wim Taymans committed
163
struct _GstElement
164
{
165
  GstObject 		object;
Erik Walthinsen's avatar
Erik Walthinsen committed
166

167 168 169 170 171 172 173 174 175
  /*< public >*/ /* with STATE_LOCK */
  /* element state */
  GMutex               *state_lock;
  GCond                *state_cond;
  guint8                current_state;
  guint8                pending_state;
  gboolean              state_error; /* flag is set when the element has an error in the last state
                                        change. it is cleared when doing another state change. */
  /*< public >*/ /* with LOCK */
Wim Taymans's avatar
Wim Taymans committed
176
  /* element manager */
177 178
  GstPipeline  	       *manager;
  GstBus       	       *bus;
Wim Taymans's avatar
Wim Taymans committed
179
  GstScheduler 	       *scheduler;
Wim Taymans's avatar
Wim Taymans committed
180 181

  /* allocated clock */
182
  GstClock	       *clock;
183
  GstClockTimeDiff    	base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
184

185
  /* element pads, these lists can only be iterated while holding
186
   * the LOCK or checking the cookie after each LOCK. */
187 188 189 190 191 192 193 194 195
  guint16               numpads;
  GList                *pads;
  guint16               numsrcpads;
  GList                *srcpads;
  guint16               numsinkpads;
  GList                *sinkpads;
  guint32               pads_cookie;

  /*< private >*/
196
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
197 198
};

199 200
struct _GstElementClass
{
201
  GstObjectClass         parent_class;
Erik Walthinsen's avatar
Erik Walthinsen committed
202

203
  /*< public >*/
204
  /* the element details */
205
  GstElementDetails 	 details;
206 207

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

210
  /* templates for our pads */
211 212 213
  GList                 *padtemplates;
  gint                   numpadtemplates;
  guint32                pad_templ_cookie;
214

Erik Walthinsen's avatar
Erik Walthinsen committed
215
  /* signal callbacks */
216 217 218
  void (*state_change)	(GstElement *element, GstElementState old, GstElementState state);
  void (*new_pad)	(GstElement *element, GstPad *pad);
  void (*pad_removed)	(GstElement *element, GstPad *pad);
219
  void (*no_more_pads)	(GstElement *element);
220

221
  /*< protected >*/
Wim Taymans's avatar
Wim Taymans committed
222
  /* vtable */
223 224

  /* request/release pads */
225 226
  GstPad*		(*request_new_pad)	(GstElement *element, GstPadTemplate *templ, const gchar* name);
  void			(*release_pad)		(GstElement *element, GstPad *pad);
227

228
  /* state changes */
229 230
  GstElementStateReturn (*get_state) 		(GstElement * element, GstElementState * state,
      						 GstElementState * pending, GTimeVal * timeout);
231 232
  GstElementStateReturn (*change_state)		(GstElement *element);

Wim Taymans's avatar
Wim Taymans committed
233
  /* manager */
234 235
  void 			(*set_manager)      	(GstElement * element, GstPipeline * pipeline);
  void 			(*set_bus)          	(GstElement * element, GstBus * bus);
236 237
  void			(*set_scheduler)	(GstElement *element, GstScheduler *scheduler);

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

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

246
  /* query functions */
247
  gboolean		(*send_event)		(GstElement *element, GstEvent *event);
248

249
  const GstQueryType* 	(*get_query_types)    	(GstElement *element);
250
  gboolean		(*query)		(GstElement *element, GstQuery *query);
Wim Taymans's avatar
Wim Taymans committed
251

252 253
  /*< private >*/
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
254 255
};

256
/* element class pad templates */
257
void			gst_element_class_add_pad_template	(GstElementClass *klass, GstPadTemplate *templ);
258 259
GstPadTemplate*		gst_element_class_get_pad_template	(GstElementClass *element_class, const gchar *name);
GList*                  gst_element_class_get_pad_template_list (GstElementClass *element_class);
260 261
void			gst_element_class_set_details		(GstElementClass *klass,
								 const GstElementDetails *details);
262

263 264
/* element instance */
GType			gst_element_get_type		(void);
Erik Walthinsen's avatar
Erik Walthinsen committed
265

266
/* basic name and parentage stuff from GstObject */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
267
#define			gst_element_get_name(elem)	gst_object_get_name(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
268
#define			gst_element_set_name(elem,name)	gst_object_set_name(GST_OBJECT(elem),name)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
269
#define			gst_element_get_parent(elem)	gst_object_get_parent(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
270
#define			gst_element_set_parent(elem,parent)	gst_object_set_parent(GST_OBJECT(elem),parent)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
271

272
/* clocking */
273 274 275 276
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);
277 278

/* indexes */
279 280 281 282
gboolean		gst_element_is_indexable	(GstElement *element);
void			gst_element_set_index		(GstElement *element, GstIndex *index);
GstIndex*		gst_element_get_index		(GstElement *element);

Wim Taymans's avatar
Wim Taymans committed
283
/* manager and tasks */
284 285 286 287
void 			gst_element_set_manager 	(GstElement * element, GstPipeline * pipeline);
GstPipeline *		gst_element_get_manager 	(GstElement * element);
void 			gst_element_set_bus 		(GstElement * element, GstBus * bus);
GstBus *		gst_element_get_bus 		(GstElement * element);
288 289 290
void			gst_element_set_scheduler	(GstElement *element, GstScheduler *sched);
GstScheduler*		gst_element_get_scheduler	(GstElement *element);

291
/* pad management */
292 293
gboolean		gst_element_add_pad		(GstElement *element, GstPad *pad);
gboolean		gst_element_remove_pad		(GstElement *element, GstPad *pad);
294
void			gst_element_no_more_pads	(GstElement *element);
295 296 297 298 299 300

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

301
GstIterator *		gst_element_iterate_pads 	(GstElement * element);
302

303
/* event/query/format stuff */
304 305 306 307 308
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);
309
gboolean		gst_element_query		(GstElement *element, GstQuery *query);
310

Wim Taymans's avatar
Wim Taymans committed
311
/* messages */
312
gboolean 		gst_element_post_message 	(GstElement * element, GstMessage * message);
Wim Taymans's avatar
Wim Taymans committed
313

314
/* error handling */
315
gchar *			_gst_element_error_printf	(const gchar *format, ...);
316 317 318 319
void 			gst_element_message_full 	(GstElement * element, GstMessageType type,
   							 GQuark domain, gint code, gchar * text, 
							 gchar * debug, const gchar * file,
   							 const gchar * function, gint line);
320 321

/* state management */
322
gboolean		gst_element_is_locked_state	(GstElement *element);
323
gboolean		gst_element_set_locked_state	(GstElement *element, gboolean locked_state);
324 325
gboolean		gst_element_sync_state_with_parent (GstElement *element);

326 327 328 329
GstElementStateReturn 	gst_element_get_state 		(GstElement * element, 
							 GstElementState * state,
    							 GstElementState * pending, 
							 GTimeVal * timeout);
330 331
GstElementStateReturn	gst_element_set_state		(GstElement *element, GstElementState state);

332 333 334
void 			gst_element_abort_state 	(GstElement * element);
void 			gst_element_commit_state 	(GstElement * element);
void 			gst_element_lost_state 	        (GstElement * element);
Wim Taymans's avatar
Wim Taymans committed
335

336 337
/* factory management */
GstElementFactory*	gst_element_get_factory		(GstElement *element);
338

339
G_END_DECLS
340

341
#endif /* __GST_ELEMENT_H__ */