gstelement.h 14.4 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__

Wim Taymans's avatar
Wim Taymans committed
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
/* gstelement.h and gstelementfactory.h include eachother */
typedef struct _GstElement GstElement;
typedef struct _GstElementClass GstElementClass;

/* gstmessage.h needs ElementState */
#define GST_NUM_STATES 4
typedef enum {
  GST_STATE_VOID_PENDING        = 0,
  GST_STATE_NULL                = (1 << 0),
  GST_STATE_READY               = (1 << 1),
  GST_STATE_PAUSED              = (1 << 2),
  GST_STATE_PLAYING             = (1 << 3)
} GstElementState;


42
#include <gst/gstconfig.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
43 44
#include <gst/gstobject.h>
#include <gst/gstpad.h>
Wim Taymans's avatar
Wim Taymans committed
45
#include <gst/gstbus.h>
46
#include <gst/gstclock.h>
47
#include <gst/gstelementfactory.h>
48
#include <gst/gstplugin.h>
49
#include <gst/gstpluginfeature.h>
Wim Taymans's avatar
Wim Taymans committed
50
#include <gst/gstindex.h>
51
#include <gst/gstiterator.h>
Wim Taymans's avatar
Wim Taymans committed
52
#include <gst/gstmessage.h>
Benjamin Otte's avatar
Benjamin Otte committed
53
#include <gst/gsttag.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
54

55 56
G_BEGIN_DECLS

57
GST_EXPORT GType _gst_element_type;
58

59 60 61 62 63 64 65
#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))
66

Wim Taymans's avatar
Wim Taymans committed
67 68 69 70 71 72 73
typedef enum {
  GST_STATE_FAILURE             = 0,
  GST_STATE_SUCCESS             = 1,
  GST_STATE_ASYNC               = 2,
  GST_STATE_NO_PREROLL          = 3
} GstElementStateReturn;

74
/* NOTE: this probably should be done with an #ifdef to decide
75 76
 * whether to safe-cast or to just do the non-checking cast.
 */
77 78
#define GST_STATE(obj)			(GST_ELEMENT(obj)->current_state)
#define GST_STATE_PENDING(obj)		(GST_ELEMENT(obj)->pending_state)
79
#define GST_STATE_FINAL(obj)		(GST_ELEMENT(obj)->final_state)
80
#define GST_STATE_ERROR(obj)		(GST_ELEMENT(obj)->state_error)
81
#define GST_STATE_NO_PREROLL(obj)	(GST_ELEMENT(obj)->no_preroll)
82

83
/* Note: using 8 bit shift mostly "just because", it leaves us enough room to grow <g> */
84
#define GST_STATE_TRANSITION(obj)	((GST_STATE(obj)<<8) | GST_STATE_PENDING(obj))
85
#define GST_STATE_NULL_TO_READY		((GST_STATE_NULL<<8) | GST_STATE_READY)
86
#define GST_STATE_READY_TO_PAUSED	((GST_STATE_READY<<8) | GST_STATE_PAUSED)
87
#define GST_STATE_PAUSED_TO_PLAYING	((GST_STATE_PAUSED<<8) | GST_STATE_PLAYING)
88 89
#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)
90
#define GST_STATE_READY_TO_NULL		((GST_STATE_READY<<8) | GST_STATE_NULL)
91

92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
/* 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

109 110
typedef enum
{
111 112 113
  /* ignore state changes from parent */
  GST_ELEMENT_LOCKED_STATE,

114 115 116
  /* the element is a sink */
  GST_ELEMENT_IS_SINK,

117
  /* use some padding for future expansion */
118 119
  GST_ELEMENT_FLAG_LAST		= GST_OBJECT_FLAG_LAST + 16
} GstElementFlags;
120

121
#define GST_ELEMENT_IS_LOCKED_STATE(obj)        (GST_FLAG_IS_SET(obj,GST_ELEMENT_LOCKED_STATE))
122

123
#define GST_ELEMENT_NAME(obj)			(GST_OBJECT_NAME(obj))
Wim Taymans's avatar
Wim Taymans committed
124 125
#define GST_ELEMENT_PARENT(obj)			(GST_ELEMENT_CAST(GST_OBJECT_PARENT(obj)))
#define GST_ELEMENT_BUS(obj)			(GST_ELEMENT_CAST(obj)->bus)
126 127
#define GST_ELEMENT_CLOCK(obj)			(GST_ELEMENT_CAST(obj)->clock)
#define GST_ELEMENT_PADS(obj)			(GST_ELEMENT_CAST(obj)->pads)
128

129 130
/**
 * GST_ELEMENT_ERROR:
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
131
 * @el:     the element that throws the error
132
 * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #GstError)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
133 134 135 136 137
 * @code:   error code defined for that domain (see #GstError)
 * @text:   the message to display (format string and args enclosed in
            parentheses)
 * @debug:  debugging information for the message (format string and args
            enclosed in parentheses)
138 139 140 141 142
 *
 * 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
143 144 145 146 147 148 149 150 151 152 153
#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__);			\
154
} G_STMT_END
155

Wim Taymans's avatar
Wim Taymans committed
156 157 158 159 160 161 162 163 164 165 166 167 168
/* 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
169

170 171 172 173 174 175 176 177 178 179 180 181
/* 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
182
struct _GstElement
183
{
184
  GstObject		object;
Erik Walthinsen's avatar
Erik Walthinsen committed
185

186 187 188 189 190 191
  /*< public >*/ /* with STATE_LOCK */
  /* element state */
  GMutex               *state_lock;
  GCond                *state_cond;
  guint8                current_state;
  guint8                pending_state;
192
  guint8                final_state;
193 194
  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. */
195
  gboolean		no_preroll;  /* flag is set when the element cannot preroll */
196
  /*< public >*/ /* with LOCK */
197
  GstBus	       *bus;
Wim Taymans's avatar
Wim Taymans committed
198 199

  /* allocated clock */
200
  GstClock	       *clock;
201
  GstClockTimeDiff	base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
202

203
  /* element pads, these lists can only be iterated while holding
204
   * the LOCK or checking the cookie after each LOCK. */
205 206 207 208 209 210 211 212 213
  guint16               numpads;
  GList                *pads;
  guint16               numsrcpads;
  GList                *srcpads;
  guint16               numsinkpads;
  GList                *sinkpads;
  guint32               pads_cookie;

  /*< private >*/
214
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
215 216
};

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

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

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

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

233
  /*< private >*/
Erik Walthinsen's avatar
Erik Walthinsen committed
234
  /* signal callbacks */
235 236 237
  void (*state_change)	(GstElement *element, GstElementState old, GstElementState state);
  void (*new_pad)	(GstElement *element, GstPad *pad);
  void (*pad_removed)	(GstElement *element, GstPad *pad);
238
  void (*no_more_pads)	(GstElement *element);
239

240 241
  /*< public >*/
  /* virtual methods for subclasses */
242 243

  /* request/release pads */
244 245
  GstPad*		(*request_new_pad)	(GstElement *element, GstPadTemplate *templ, const gchar* name);
  void			(*release_pad)		(GstElement *element, GstPad *pad);
246

247
  /* state changes */
248 249
  GstElementStateReturn (*get_state)		(GstElement * element, GstElementState * state,
						 GstElementState * pending, GTimeVal * timeout);
250 251
  GstElementStateReturn (*change_state)		(GstElement *element);

Wim Taymans's avatar
Wim Taymans committed
252
  /* bus */
253
  void			(*set_bus)		(GstElement * element, GstBus * bus);
254

255
  /* set/get clocks */
256 257
  GstClock*		(*get_clock)		(GstElement *element);
  void			(*set_clock)		(GstElement *element, GstClock *clock);
258

Wim Taymans's avatar
Wim Taymans committed
259
  /* index */
260 261
  GstIndex*		(*get_index)		(GstElement *element);
  void			(*set_index)		(GstElement *element, GstIndex *index);
Wim Taymans's avatar
Wim Taymans committed
262

263
  /* query functions */
264
  gboolean		(*send_event)		(GstElement *element, GstEvent *event);
265

266
  const GstQueryType*	(*get_query_types)	(GstElement *element);
267
  gboolean		(*query)		(GstElement *element, GstQuery *query);
Wim Taymans's avatar
Wim Taymans committed
268

269 270
  /*< private >*/
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
271 272
};

273
/* element class pad templates */
274
void			gst_element_class_add_pad_template	(GstElementClass *klass, GstPadTemplate *templ);
275 276
GstPadTemplate*		gst_element_class_get_pad_template	(GstElementClass *element_class, const gchar *name);
GList*                  gst_element_class_get_pad_template_list (GstElementClass *element_class);
277 278
void			gst_element_class_set_details		(GstElementClass *klass,
								 const GstElementDetails *details);
279

280 281
/* element instance */
GType			gst_element_get_type		(void);
Erik Walthinsen's avatar
Erik Walthinsen committed
282

283
/* basic name and parentage stuff from GstObject */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
284
#define			gst_element_get_name(elem)	gst_object_get_name(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
285
#define			gst_element_set_name(elem,name)	gst_object_set_name(GST_OBJECT(elem),name)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
286
#define			gst_element_get_parent(elem)	gst_object_get_parent(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
287
#define			gst_element_set_parent(elem,parent)	gst_object_set_parent(GST_OBJECT(elem),parent)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
288

289
/* clocking */
290 291
gboolean		gst_element_requires_clock	(GstElement *element);
gboolean		gst_element_provides_clock	(GstElement *element);
292 293
GstClock*		gst_element_get_clock		(GstElement *element);
void			gst_element_set_clock		(GstElement *element, GstClock *clock);
294 295
void			gst_element_set_base_time	(GstElement *element, GstClockTime time);
GstClockTime		gst_element_get_base_time	(GstElement *element);
296 297

/* indexes */
298 299 300 301
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
302
/* bus */
303 304
void			gst_element_set_bus		(GstElement * element, GstBus * bus);
GstBus *		gst_element_get_bus		(GstElement * element);
305

306
/* pad management */
307 308
gboolean		gst_element_add_pad		(GstElement *element, GstPad *pad);
gboolean		gst_element_remove_pad		(GstElement *element, GstPad *pad);
309
void			gst_element_no_more_pads	(GstElement *element);
310 311 312 313 314 315

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

316 317 318
GstIterator *		gst_element_iterate_pads 	(GstElement * element);
GstIterator *		gst_element_iterate_src_pads 	(GstElement * element);
GstIterator *		gst_element_iterate_sink_pads 	(GstElement * element);
319

320
/* event/query/format stuff */
321 322 323 324 325
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);
326
gboolean		gst_element_query		(GstElement *element, GstQuery *query);
327

Wim Taymans's avatar
Wim Taymans committed
328
/* messages */
329
gboolean		gst_element_post_message	(GstElement * element, GstMessage * message);
Wim Taymans's avatar
Wim Taymans committed
330

331
/* error handling */
332
gchar *			_gst_element_error_printf	(const gchar *format, ...);
333 334
void			gst_element_message_full	(GstElement * element, GstMessageType type,
							 GQuark domain, gint code, gchar * text,
335
							 gchar * debug, const gchar * file,
336
							 const gchar * function, gint line);
337 338

/* state management */
339
gboolean		gst_element_is_locked_state	(GstElement *element);
340
gboolean		gst_element_set_locked_state	(GstElement *element, gboolean locked_state);
341 342
gboolean		gst_element_sync_state_with_parent (GstElement *element);

343
GstElementStateReturn	gst_element_get_state		(GstElement * element,
344
							 GstElementState * state,
345
							 GstElementState * pending,
346
							 GTimeVal * timeout);
347 348
GstElementStateReturn	gst_element_set_state		(GstElement *element, GstElementState state);

349 350 351
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
352

353 354
/* factory management */
GstElementFactory*	gst_element_get_factory		(GstElement *element);
355

356
G_END_DECLS
357

358
#endif /* __GST_ELEMENT_H__ */