gstelement.h 15.3 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
/* gstelement.h and gstelementfactory.h include eachother */
typedef struct _GstElement GstElement;
typedef struct _GstElementClass GstElementClass;

31
/* gstmessage.h needs State */
Wim Taymans's avatar
Wim Taymans committed
32
typedef enum {
33 34 35 36 37 38 39
  GST_STATE_VOID_PENDING        = 0, /* used for GstElement->pending_state when
                                        there is no pending state */
  GST_STATE_NULL                = 1,
  GST_STATE_READY               = 2,
  GST_STATE_PAUSED              = 3,
  GST_STATE_PLAYING             = 4
} GstState;
Wim Taymans's avatar
Wim Taymans committed
40 41


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>
53
#include <gst/gsttaglist.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

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
67 68 69 70 71 72 73
/**
 * GstStateChangeReturn:
 * @GST_STATE_CHANGE_FAILURE   : the state change failed
 * @GST_STATE_CHANGE_SUCCESS   : the state change succeeded
 * @GST_STATE_CHANGE_ASYNC     : the state change will happen asynchronously
 * @GST_STATE_CHANGE_NO_PREROLL: the state change cannot be prerolled
 */
Wim Taymans's avatar
Wim Taymans committed
74
typedef enum {
75 76 77 78 79
  GST_STATE_CHANGE_FAILURE             = 0,
  GST_STATE_CHANGE_SUCCESS             = 1,
  GST_STATE_CHANGE_ASYNC               = 2,
  GST_STATE_CHANGE_NO_PREROLL          = 3
} GstStateChangeReturn;
Wim Taymans's avatar
Wim Taymans committed
80

81
/* NOTE: this probably should be done with an #ifdef to decide
82 83
 * whether to safe-cast or to just do the non-checking cast.
 */
84 85
#define GST_STATE(obj)			(GST_ELEMENT(obj)->current_state)
#define GST_STATE_PENDING(obj)		(GST_ELEMENT(obj)->pending_state)
86
#define GST_STATE_FINAL(obj)		(GST_ELEMENT(obj)->final_state)
87
#define GST_STATE_ERROR(obj)		(GST_ELEMENT(obj)->state_error)
88
#define GST_STATE_NO_PREROLL(obj)	(GST_ELEMENT(obj)->no_preroll)
89

90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
#ifndef GST_DEBUG_STATE_CHANGE
#define GST_STATE_CHANGE(obj) ((1<<(GST_STATE(obj)+8)) | 1<<GST_STATE_PENDING(obj))
#else
inline GstStateChange
_gst_element_get_state_change (GstElement *e)
{
  if (e->state < GST_STATE_NULL || e->state > GST_STATE_PLAYING)
    g_assert_not_reached ();
  if (e->pending_state < GST_STATE_NULL || e->pending_state > GST_STATE_PLAYING)
    g_assert_not_reached ();
  if (e->state - e->pending_state != 1 && e->pending_state - e->state != 1)
    g_assert_not_reached ();
  return (1<<(GST_STATE(obj)+8)) | 1<<GST_STATE_PENDING(obj);
}
#define GST_STATE_CHANGE(obj) _gst_element_get_state_change(obj)
#endif

/* FIXME: How to deal with lost_state ? */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
108 109 110 111 112 113 114 115 116
/**
 * GstStateChange:
 * @GST_STATE_CHANGE_NULL_TO_READY    : state change from NULL to READY
 * @GST_STATE_CHANGE_READY_TO_PAUSED  : state change from READY to PAUSED
 * @GST_STATE_CHANGE_PAUSED_TO_PLAYING: state change from PAUSED to PLAYING
 * @GST_STATE_CHANGE_PLAYING_TO_PAUSED: state change from PLAYING to PAUSED
 * @GST_STATE_CHANGE_PAUSED_TO_READY  : state change from PAUSED to READY
 * @GST_STATE_CHANGE_READY_TO_NULL    : state change from READY to NULL
 */
117
typedef enum /*< flags=0 >*/
118 119 120 121 122 123 124 125
{
  GST_STATE_CHANGE_NULL_TO_READY	= 1<<(GST_STATE_NULL+8) | 1<<GST_STATE_READY,
  GST_STATE_CHANGE_READY_TO_PAUSED	= 1<<(GST_STATE_READY+8) | 1<<GST_STATE_PAUSED,
  GST_STATE_CHANGE_PAUSED_TO_PLAYING	= 1<<(GST_STATE_PAUSED+8) | 1<<GST_STATE_PLAYING,
  GST_STATE_CHANGE_PLAYING_TO_PAUSED	= 1<<(GST_STATE_PLAYING+8) | 1<<GST_STATE_PAUSED,
  GST_STATE_CHANGE_PAUSED_TO_READY	= 1<<(GST_STATE_PAUSED+8) | 1<<GST_STATE_READY,
  GST_STATE_CHANGE_READY_TO_NULL	= 1<<(GST_STATE_READY+8) | 1<<GST_STATE_NULL
} GstStateChange;
126

127 128
typedef enum
{
129 130
  /* ignore state changes from parent */
  GST_ELEMENT_LOCKED_STATE,
131
  
132 133 134
  /* the element is a sink */
  GST_ELEMENT_IS_SINK,

135 136 137 138
  /* Child is being removed from the parent bin. gst_bin_remove on a
   * child already being removed immediately returns FALSE */
  GST_ELEMENT_UNPARENTING,

139
  /* use some padding for future expansion */
140 141
  GST_ELEMENT_FLAG_LAST		= GST_OBJECT_FLAG_LAST + 16
} GstElementFlags;
142

143
#define GST_ELEMENT_IS_LOCKED_STATE(obj)        (GST_FLAG_IS_SET(obj,GST_ELEMENT_LOCKED_STATE))
144

145
#define GST_ELEMENT_NAME(obj)			(GST_OBJECT_NAME(obj))
Wim Taymans's avatar
Wim Taymans committed
146 147
#define GST_ELEMENT_PARENT(obj)			(GST_ELEMENT_CAST(GST_OBJECT_PARENT(obj)))
#define GST_ELEMENT_BUS(obj)			(GST_ELEMENT_CAST(obj)->bus)
148 149
#define GST_ELEMENT_CLOCK(obj)			(GST_ELEMENT_CAST(obj)->clock)
#define GST_ELEMENT_PADS(obj)			(GST_ELEMENT_CAST(obj)->pads)
150

151 152
/**
 * GST_ELEMENT_ERROR:
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
153
 * @el:     the element that throws the error
154
 * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #GstError)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
155 156 157 158 159
 * @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)
160 161 162 163 164
 *
 * 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
165 166 167 168 169
#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)								\
170
    GST_WARNING_OBJECT (el, "error: %s", __txt);			\
Wim Taymans's avatar
Wim Taymans committed
171
  if (__dbg)								\
172
    GST_WARNING_OBJECT (el, "error: %s", __dbg);			\
Wim Taymans's avatar
Wim Taymans committed
173 174 175
  gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_ERROR,		\
    GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,	\
    __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);			\
176
} G_STMT_END
177

Wim Taymans's avatar
Wim Taymans committed
178 179 180 181 182 183
/* 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)								\
184
    GST_WARNING_OBJECT (el, "warning: %s", __txt);			\
Wim Taymans's avatar
Wim Taymans committed
185
  if (__dbg)								\
186
    GST_WARNING_OBJECT (el, "warning: %s", __dbg);			\
Wim Taymans's avatar
Wim Taymans committed
187 188 189 190
  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
191

192 193 194 195 196 197 198 199 200 201 202 203
/* 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
204
struct _GstElement
205
{
206
  GstObject		object;
Erik Walthinsen's avatar
Erik Walthinsen committed
207

208 209 210 211 212 213
  /*< public >*/ /* with STATE_LOCK */
  /* element state */
  GMutex               *state_lock;
  GCond                *state_cond;
  guint8                current_state;
  guint8                pending_state;
214
  guint8                final_state;
215 216
  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. */
217
  gboolean		no_preroll;  /* flag is set when the element cannot preroll */
218
  /*< public >*/ /* with LOCK */
219
  GstBus	       *bus;
Wim Taymans's avatar
Wim Taymans committed
220 221

  /* allocated clock */
222
  GstClock	       *clock;
223
  GstClockTimeDiff	base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
224

225
  /* element pads, these lists can only be iterated while holding
226
   * the LOCK or checking the cookie after each LOCK. */
227 228 229 230 231 232 233 234 235
  guint16               numpads;
  GList                *pads;
  guint16               numsrcpads;
  GList                *srcpads;
  guint16               numsinkpads;
  GList                *sinkpads;
  guint32               pads_cookie;

  /*< private >*/
236
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
237 238
};

239 240
struct _GstElementClass
{
241
  GstObjectClass         parent_class;
Erik Walthinsen's avatar
Erik Walthinsen committed
242

243
  /*< public >*/
244
  /* the element details */
245
  GstElementDetails	 details;
246 247

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

250
  /* templates for our pads */
251 252 253
  GList                 *padtemplates;
  gint                   numpadtemplates;
  guint32                pad_templ_cookie;
254

255
  /*< private >*/
Erik Walthinsen's avatar
Erik Walthinsen committed
256
  /* signal callbacks */
257
  void (*state_changed)	(GstElement *element, GstState old, GstState state);
258
  void (*pad_added)	(GstElement *element, GstPad *pad);
259
  void (*pad_removed)	(GstElement *element, GstPad *pad);
260
  void (*no_more_pads)	(GstElement *element);
261

262 263
  /*< public >*/
  /* virtual methods for subclasses */
264 265

  /* request/release pads */
266 267
  GstPad*		(*request_new_pad)	(GstElement *element, GstPadTemplate *templ, const gchar* name);
  void			(*release_pad)		(GstElement *element, GstPad *pad);
268

269
  /* state changes */
270 271 272
  GstStateChangeReturn (*get_state)		(GstElement * element, GstState * state,
						 GstState * pending, GTimeVal * timeout);
  GstStateChangeReturn (*change_state)		(GstElement *element, GstStateChange transition);
273

Wim Taymans's avatar
Wim Taymans committed
274
  /* bus */
275
  void			(*set_bus)		(GstElement * element, GstBus * bus);
276

277
  /* set/get clocks */
278 279
  GstClock*		(*get_clock)		(GstElement *element);
  void			(*set_clock)		(GstElement *element, GstClock *clock);
280

Wim Taymans's avatar
Wim Taymans committed
281
  /* index */
282 283
  GstIndex*		(*get_index)		(GstElement *element);
  void			(*set_index)		(GstElement *element, GstIndex *index);
Wim Taymans's avatar
Wim Taymans committed
284

285
  /* query functions */
286
  gboolean		(*send_event)		(GstElement *element, GstEvent *event);
287

288
  const GstQueryType*	(*get_query_types)	(GstElement *element);
289
  gboolean		(*query)		(GstElement *element, GstQuery *query);
Wim Taymans's avatar
Wim Taymans committed
290

291 292
  /*< private >*/
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
293 294
};

295
/* element class pad templates */
296
void			gst_element_class_add_pad_template	(GstElementClass *klass, GstPadTemplate *templ);
297 298
GstPadTemplate*		gst_element_class_get_pad_template	(GstElementClass *element_class, const gchar *name);
GList*                  gst_element_class_get_pad_template_list (GstElementClass *element_class);
299 300
void			gst_element_class_set_details		(GstElementClass *klass,
								 const GstElementDetails *details);
301

302 303
/* element instance */
GType			gst_element_get_type		(void);
Erik Walthinsen's avatar
Erik Walthinsen committed
304

305
/* basic name and parentage stuff from GstObject */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
306
#define			gst_element_get_name(elem)	gst_object_get_name(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
307
#define			gst_element_set_name(elem,name)	gst_object_set_name(GST_OBJECT(elem),name)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
308
#define			gst_element_get_parent(elem)	gst_object_get_parent(GST_OBJECT(elem))
Thomas Vander Stichele's avatar
oops  
Thomas Vander Stichele committed
309
#define			gst_element_set_parent(elem,parent)	gst_object_set_parent(GST_OBJECT(elem),parent)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
310

311
/* clocking */
312 313
gboolean		gst_element_requires_clock	(GstElement *element);
gboolean		gst_element_provides_clock	(GstElement *element);
314 315
GstClock*		gst_element_get_clock		(GstElement *element);
void			gst_element_set_clock		(GstElement *element, GstClock *clock);
316 317
void			gst_element_set_base_time	(GstElement *element, GstClockTime time);
GstClockTime		gst_element_get_base_time	(GstElement *element);
318 319

/* indexes */
320 321 322 323
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
324
/* bus */
325 326
void			gst_element_set_bus		(GstElement * element, GstBus * bus);
GstBus *		gst_element_get_bus		(GstElement * element);
327

328
/* pad management */
329 330
gboolean		gst_element_add_pad		(GstElement *element, GstPad *pad);
gboolean		gst_element_remove_pad		(GstElement *element, GstPad *pad);
331
void			gst_element_no_more_pads	(GstElement *element);
332 333 334 335 336 337

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

338 339 340
GstIterator *		gst_element_iterate_pads 	(GstElement * element);
GstIterator *		gst_element_iterate_src_pads 	(GstElement * element);
GstIterator *		gst_element_iterate_sink_pads 	(GstElement * element);
341

342
/* event/query/format stuff */
343
gboolean		gst_element_send_event		(GstElement *element, GstEvent *event);
Wim Taymans's avatar
Wim Taymans committed
344 345 346 347
gboolean		gst_element_seek		(GstElement *element, gdouble rate,
							 GstFormat format, GstSeekFlags flags,
							 GstSeekType cur_type, gint64 cur,
							 GstSeekType stop_type, gint64 stop);
348 349
G_CONST_RETURN GstQueryType*
			gst_element_get_query_types	(GstElement *element);
350
gboolean		gst_element_query		(GstElement *element, GstQuery *query);
351

Wim Taymans's avatar
Wim Taymans committed
352
/* messages */
353
gboolean		gst_element_post_message	(GstElement * element, GstMessage * message);
Wim Taymans's avatar
Wim Taymans committed
354

355
/* error handling */
356
gchar *			_gst_element_error_printf	(const gchar *format, ...);
357 358
void			gst_element_message_full	(GstElement * element, GstMessageType type,
							 GQuark domain, gint code, gchar * text,
359
							 gchar * debug, const gchar * file,
360
							 const gchar * function, gint line);
361 362

/* state management */
363
gboolean		gst_element_is_locked_state	(GstElement *element);
364
gboolean		gst_element_set_locked_state	(GstElement *element, gboolean locked_state);
365 366
gboolean		gst_element_sync_state_with_parent (GstElement *element);

367 368 369
GstStateChangeReturn	gst_element_get_state		(GstElement * element,
							 GstState * state,
							 GstState * pending,
370
							 GTimeVal * timeout);
371
GstStateChangeReturn	gst_element_set_state		(GstElement *element, GstState state);
372

373 374 375
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
376

377 378
/* factory management */
GstElementFactory*	gst_element_get_factory		(GstElement *element);
379

380
G_END_DECLS
381

382
#endif /* __GST_ELEMENT_H__ */