gstelement.h 21.8 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 33 34 35 36 37 38 39 40 41
/**
 * GstState:
 * @GST_STATE_VOID_PENDING     : no pending state.
 * @GST_STATE_NULL             : the NULL state or initial state of an element
 * @GST_STATE_READY            : the element is ready to go to PAUSED
 * @GST_STATE_PAUSED           : the element is PAUSED
 * @GST_STATE_PLAYING          : the element is PLAYING
 *
 * The posible states an element can be in. 
 */
Wim Taymans's avatar
Wim Taymans committed
42
typedef enum {
43
  GST_STATE_VOID_PENDING        = 0,
44 45 46 47 48
  GST_STATE_NULL                = 1,
  GST_STATE_READY               = 2,
  GST_STATE_PAUSED              = 3,
  GST_STATE_PLAYING             = 4
} GstState;
Wim Taymans's avatar
Wim Taymans committed
49 50


51
#include <gst/gstconfig.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
52 53
#include <gst/gstobject.h>
#include <gst/gstpad.h>
Wim Taymans's avatar
Wim Taymans committed
54
#include <gst/gstbus.h>
55
#include <gst/gstclock.h>
56
#include <gst/gstelementfactory.h>
57
#include <gst/gstplugin.h>
58
#include <gst/gstpluginfeature.h>
Wim Taymans's avatar
Wim Taymans committed
59
#include <gst/gstindex.h>
60
#include <gst/gstindexfactory.h>
61
#include <gst/gstiterator.h>
Wim Taymans's avatar
Wim Taymans committed
62
#include <gst/gstmessage.h>
63
#include <gst/gsttaglist.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
64

65 66
G_BEGIN_DECLS

67
#define GST_TYPE_ELEMENT		(gst_element_get_type ())
68 69 70 71 72 73
#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))
74

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
75 76 77 78 79 80
/**
 * 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
81 82
 *
 * the possible return values from a state change function.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
83
 */
Wim Taymans's avatar
Wim Taymans committed
84
typedef enum {
85 86 87 88 89
  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
90

91
/* NOTE: this probably should be done with an #ifdef to decide
92 93
 * whether to safe-cast or to just do the non-checking cast.
 */
94 95 96

/**
 * GST_STATE:
97
 * @elem: a #GstElement to return state for.
98
 *
99
 * This macro returns the current #GstState of the element.
100
 */
101
#define GST_STATE(elem)			(GST_ELEMENT_CAST(elem)->current_state)
102

103 104
/**
 * GST_STATE_NEXT:
105
 * @elem: a #GstElement to return the next state for.
106
 *
107
 * This macro returns the next #GstState of the element. 
108
 */
109
#define GST_STATE_NEXT(elem)		(GST_ELEMENT_CAST(elem)->next_state)
110

111 112
/**
 * GST_STATE_PENDING:
113
 * @elem: a #GstElement to return the pending state for.
114
 *
115
 * This macro returns the currently pending #GstState of the element.
116
 */
117
#define GST_STATE_PENDING(elem)		(GST_ELEMENT_CAST(elem)->pending_state)
118 119 120

/**
 * GST_STATE_RETURN:
121
 * @elem: a #GstElement to return the last state result for.
122
 *
123
 * This macro returns the last #GstStateChangeReturn value.
124
 */
125
#define GST_STATE_RETURN(elem)		(GST_ELEMENT_CAST(elem)->last_return)
126

127
#define __GST_SIGN(val)				((val) < 0 ? -1 : ((val) > 0 ? 1 : 0))
Wim Taymans's avatar
Wim Taymans committed
128 129
/**
 * GST_STATE_GET_NEXT:
130 131
 * @cur: A starting #GstState
 * @pending: A target #GstState
Wim Taymans's avatar
Wim Taymans committed
132
 *
133 134
 * Given a current state @cur and a target state @pending, calculate the next (intermediate)
 * #GstState.
Wim Taymans's avatar
Wim Taymans committed
135
 */
136
#define GST_STATE_GET_NEXT(cur,pending) 	((cur) + __GST_SIGN ((gint)(pending) - (gint)(cur)))
Wim Taymans's avatar
Wim Taymans committed
137 138 139 140 141
/**
 * GST_STATE_TRANSITION:
 * @cur: A current state
 * @next: A next state
 *
142 143
 * Given a current state @cur and a next state @next, calculate the associated 
 * #GstStateChange transition.
Wim Taymans's avatar
Wim Taymans committed
144
 */
145
#define GST_STATE_TRANSITION(cur,next)  	(((cur)<<3)|(next))
Wim Taymans's avatar
Wim Taymans committed
146 147
/**
 * GST_STATE_TRANSITION_CURRENT:
148
 * @trans: A #GstStateChange 
Wim Taymans's avatar
Wim Taymans committed
149
 *
150
 * Given a state transition @trans, extract the current #GstState.
Wim Taymans's avatar
Wim Taymans committed
151
 */
152
#define GST_STATE_TRANSITION_CURRENT(trans)  	((trans)>>3)
Wim Taymans's avatar
Wim Taymans committed
153 154
/**
 * GST_STATE_TRANSITION_NEXT:
155
 * @trans: A #GstStateChange
Wim Taymans's avatar
Wim Taymans committed
156
 *
157
 * Given a state transition @trans, extract the next #GstState.
Wim Taymans's avatar
Wim Taymans committed
158
 */
159 160
#define GST_STATE_TRANSITION_NEXT(trans)  	((trans)&0x7)

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
161 162 163 164 165 166 167 168
/**
 * 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
Wim Taymans's avatar
Wim Taymans committed
169 170 171
 *
 * The different (interesting) state changes that are passed to the
 * state change functions of elements.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
172
 */
173
typedef enum /*< flags=0 >*/
174
{
175 176 177 178 179 180
  GST_STATE_CHANGE_NULL_TO_READY	= (GST_STATE_NULL<<3) | GST_STATE_READY,
  GST_STATE_CHANGE_READY_TO_PAUSED	= (GST_STATE_READY<<3) | GST_STATE_PAUSED,
  GST_STATE_CHANGE_PAUSED_TO_PLAYING	= (GST_STATE_PAUSED<<3) | GST_STATE_PLAYING,
  GST_STATE_CHANGE_PLAYING_TO_PAUSED	= (GST_STATE_PLAYING<<3) | GST_STATE_PAUSED,
  GST_STATE_CHANGE_PAUSED_TO_READY	= (GST_STATE_PAUSED<<3) | GST_STATE_READY,
  GST_STATE_CHANGE_READY_TO_NULL	= (GST_STATE_READY<<3) | GST_STATE_NULL
181
} GstStateChange;
182

183 184 185 186 187 188 189 190 191 192
/**
 * GstElementFlags:
 * @GST_ELEMENT_LOCKED_STATE: ignore state changes from parent
 * @GST_ELEMENT_IS_SINK: the element is a sink
 * @GST_ELEMENT_UNPARENTING: Child is being removed from the parent bin.
 *  gst_bin_remove() on a child already being removed immediately returns FALSE
 * @GST_ELEMENT_FLAG_LAST: offset to define more flags
 *
 * The standard flags that an element may have.
 */
193 194
typedef enum
{
195 196 197 198 199
  GST_ELEMENT_LOCKED_STATE      = (GST_OBJECT_FLAG_LAST << 0),
  GST_ELEMENT_IS_SINK           = (GST_OBJECT_FLAG_LAST << 1),
  GST_ELEMENT_UNPARENTING       = (GST_OBJECT_FLAG_LAST << 2),
  /* padding */
  GST_ELEMENT_FLAG_LAST         = (GST_OBJECT_FLAG_LAST << 16)
200
} GstElementFlags;
201

202 203
/**
 * GST_ELEMENT_IS_LOCKED_STATE:
204
 * @elem: A #GstElement to query
205
 *
206
 * Check if the element is in the locked state and therefore will ignore state
207 208
 * changes from its parent object.
 */
209
#define GST_ELEMENT_IS_LOCKED_STATE(elem)        (GST_OBJECT_FLAG_IS_SET(elem,GST_ELEMENT_LOCKED_STATE))
210

211 212
/**
 * GST_ELEMENT_NAME:
213
 * @elem: A #GstElement to query
214 215 216 217
 *
 * Gets the name of this element. Use only in core as this is not
 * ABI-compatible. Others use gst_element_get_name()
 */
218
#define GST_ELEMENT_NAME(elem)			(GST_OBJECT_NAME(elem))
219 220 221

/**
 * GST_ELEMENT_PARENT:
222
 * @elem: A #GstElement to query
223 224 225
 *
 * Get the parent object of this element.
 */
226
#define GST_ELEMENT_PARENT(elem)		(GST_ELEMENT_CAST(GST_OBJECT_PARENT(elem)))
227 228 229

/**
 * GST_ELEMENT_BUS:
230
 * @elem: A #GstElement to query
231 232 233
 *
 * Get the message bus of this element.
 */
234
#define GST_ELEMENT_BUS(elem)			(GST_ELEMENT_CAST(elem)->bus)
235 236 237

/**
 * GST_ELEMENT_CLOCK:
238
 * @elem: A #GstElement to query
239 240 241
 *
 * Get the clock of this element
 */
242
#define GST_ELEMENT_CLOCK(elem)			(GST_ELEMENT_CAST(elem)->clock)
243 244 245

/**
 * GST_ELEMENT_PADS:
246
 * @elem: A #GstElement to query
247 248 249
 *
 * Get the pads of this elements.
 */
250
#define GST_ELEMENT_PADS(elem)			(GST_ELEMENT_CAST(elem)->pads)
251

252 253
/**
 * GST_ELEMENT_ERROR:
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
254
 * @el:     the element that throws the error
255 256
 * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #GstGError)
 * @code:   error code defined for that domain (see #GstGError)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
257 258 259 260
 * @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)
261 262 263 264 265
 *
 * 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
266 267 268 269 270
#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)								\
271
    GST_WARNING_OBJECT (el, "error: %s", __txt);			\
Wim Taymans's avatar
Wim Taymans committed
272
  if (__dbg)								\
273
    GST_WARNING_OBJECT (el, "error: %s", __dbg);			\
Wim Taymans's avatar
Wim Taymans committed
274 275 276
  gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_ERROR,		\
    GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,	\
    __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);			\
277
} G_STMT_END
278

279 280 281
/**
 * GST_ELEMENT_WARNING:
 * @el:     the element that throws the error
282 283
 * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #GstGError)
 * @code:   error code defined for that domain (see #GstGError)
284 285 286 287 288 289 290 291 292
 * @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)
 *
 * Utility function that elements can use in case they encountered a non-fatal
 * data processing problem. The pipeline will throw a warning signal and the
 * application will be informed.
 */
Wim Taymans's avatar
Wim Taymans committed
293 294 295 296 297
#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)								\
298
    GST_WARNING_OBJECT (el, "warning: %s", __txt);			\
Wim Taymans's avatar
Wim Taymans committed
299
  if (__dbg)								\
300
    GST_WARNING_OBJECT (el, "warning: %s", __dbg);			\
Wim Taymans's avatar
Wim Taymans committed
301 302 303 304
  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
305

306
/* the state change mutexes and conds */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
307
/**
308 309
 * GST_STATE_GET_LOCK:
 * @elem:   a #GstElement
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
310
 *
311 312
 * Get a reference to the state lock of @elem.
 * This lock is used by the core.  It is taken while getting or setting
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
313 314
 * the state, during state changes, and while finalizing.
 */
315 316 317 318 319 320 321 322 323
#define GST_STATE_GET_LOCK(elem)               (GST_ELEMENT_CAST(elem)->state_lock)
/**
 * GST_STATE_GET_COND:
 * @elem: a #GstElement 
 *
 * Get the conditional used to signal the completion of a state change.
 */
#define GST_STATE_GET_COND(elem)               (GST_ELEMENT_CAST(elem)->state_cond)

324 325 326 327 328
#define GST_STATE_LOCK(elem)                   g_static_rec_mutex_lock(GST_STATE_GET_LOCK(elem))
#define GST_STATE_TRYLOCK(elem)                g_static_rec_mutex_trylock(GST_STATE_GET_LOCK(elem))
#define GST_STATE_UNLOCK(elem)                 g_static_rec_mutex_unlock(GST_STATE_GET_LOCK(elem))
#define GST_STATE_UNLOCK_FULL(elem)            g_static_rec_mutex_unlock_full(GST_STATE_GET_LOCK(elem))
#define GST_STATE_LOCK_FULL(elem,t)            g_static_rec_mutex_lock_full(GST_STATE_GET_LOCK(elem), t)
329 330 331 332
#define GST_STATE_WAIT(elem)                   g_cond_wait (GST_STATE_GET_COND (elem), \
							GST_GET_LOCK (elem))
#define GST_STATE_TIMED_WAIT(elem, timeval)    g_cond_timed_wait (GST_STATE_GET_COND (elem), \
							GST_GET_LOCK (elem), timeval)
333 334 335
#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));

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
/**
 * GstElement:
 * @state_lock: Used to serialize execution of gst_element_set_state()
 * @state_cond: Used to signal completion of a state change
 * @state_cookie: Used to detect concurrent execution of gst_element_set_state() and
 *     gst_element_get_state()
 * @current_state: the current state of an element
 * @next_state: the next state of an element, can be #GST_STATE_VOID_PENDING if the 
 *     element is in the correct state.
 * @pending_state: the final state the element should go to, can be #GST_STATE_VOID_PENDING
 *     if the element is in the correct state
 * @last_return: the last return value of an element state change
 * @bus: the bus of the element. This bus is provided to the element by the parent element
 *     or the application. A #GstPipeline has a bus of its own.
 * @clock: the clock of the element. This clock is usually provided by to the element by
 *     the toplevel #GstPipeline.
 * @base_time: the time of the clock right before the element is set to PLAYING. Subtracting
 *     @base_time from the current clock time in the PLAYING state will yield the stream time.
 * @numpads: number of pads of the element, includes both source and sink pads.
 * @pads: list of pads
 * @numsrcpads: number of source pads of the element.
 * @srcpads: list of source pads
 * @numsinkpads: number of sink pads of the element.
 * @sinkpads: list of sink pads
 * @pads_cookie: updated whenever the a pad is added or removed
 *
 * GStreamer element abstract base class.
 */
Wim Taymans's avatar
Wim Taymans committed
364
struct _GstElement
365
{
366
  GstObject		object;
Erik Walthinsen's avatar
Erik Walthinsen committed
367

368
  /*< public >*/ /* with LOCK */
369
  GStaticRecMutex      *state_lock;
370 371

  /* element state */
372
  GCond                *state_cond;
Wim Taymans's avatar
Wim Taymans committed
373
  guint32		state_cookie;
374 375 376 377 378
  GstState              current_state;
  GstState              next_state;
  GstState              pending_state;
  GstStateChangeReturn  last_return;

379
  GstBus	       *bus;
Wim Taymans's avatar
Wim Taymans committed
380 381

  /* allocated clock */
382
  GstClock	       *clock;
383
  GstClockTimeDiff	base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
384

385
  /* element pads, these lists can only be iterated while holding
386
   * the LOCK or checking the cookie after each LOCK. */
387 388 389 390 391 392 393 394 395
  guint16               numpads;
  GList                *pads;
  guint16               numsrcpads;
  GList                *srcpads;
  guint16               numsinkpads;
  GList                *sinkpads;
  guint32               pads_cookie;

  /*< private >*/
396
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
397 398
};

399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
/**
 * GstElementClass:
 * @parent_class: the parent class structure
 * @details: #GstElementDetails for elements of this class
 * @elementfactory: the #GstElementFactory that creates these elements
 * @padtemplates: a #GList of #GstPadTemplate
 * @numpadtemplates: the number of padtemplates 
 * @pad_templ_cookie: changed whenever the padtemplates change
 * @request_new_pad: called when a new pad is requested
 * @release_pad: called when a request pad is to be released
 * @get_state: get the state of the element
 * @set_state: set a new state on the element
 * @change_state: called by @set_state to perform an incremental state change
 * @set_bus: set a #GstBus on the element
 * @provide_clock: gets the #GstClock provided by the element
 * @set_clock: set the #GstClock on the element
 * @get_index: set a #GstIndex on the element
 * @set_index: get the #GstIndex of an element
 * @send_event: send a #GstEvent to the element
 * @get_query_types: get the supported #GstQueryType of this element
 * @query: perform a #GstQuery on the element
 *
 * GStreamer element class. Override the vmethods to implement the element
 * functionality.
 */
424 425
struct _GstElementClass
{
426
  GstObjectClass         parent_class;
Erik Walthinsen's avatar
Erik Walthinsen committed
427

428
  /*< public >*/
429
  /* the element details */
430
  GstElementDetails	 details;
431 432

  /* factory that the element was created from */
433
  GstElementFactory	*elementfactory;
434

435
  /* templates for our pads */
436 437 438
  GList                 *padtemplates;
  gint                   numpadtemplates;
  guint32                pad_templ_cookie;
439

440
  /*< private >*/
Erik Walthinsen's avatar
Erik Walthinsen committed
441
  /* signal callbacks */
442
  void (*state_changed)	(GstElement *element, GstState old, GstState state); /* FIXME, ABI unused */
443
  void (*pad_added)	(GstElement *element, GstPad *pad);
444
  void (*pad_removed)	(GstElement *element, GstPad *pad);
445
  void (*no_more_pads)	(GstElement *element);
446

447 448
  /*< public >*/
  /* virtual methods for subclasses */
449 450

  /* request/release pads */
451 452
  GstPad*		(*request_new_pad)	(GstElement *element, GstPadTemplate *templ, const gchar* name);
  void			(*release_pad)		(GstElement *element, GstPad *pad);
453

454
  /* state changes */
455
  GstStateChangeReturn (*get_state)		(GstElement * element, GstState * state,
456
						 GstState * pending, GstClockTime timeout);
Wim Taymans's avatar
Wim Taymans committed
457
  GstStateChangeReturn (*set_state)		(GstElement *element, GstState state);
458
  GstStateChangeReturn (*change_state)		(GstElement *element, GstStateChange transition);
459

Wim Taymans's avatar
Wim Taymans committed
460
  /* bus */
461
  void			(*set_bus)		(GstElement * element, GstBus * bus);
462

463
  /* set/get clocks */
464
  GstClock*		(*provide_clock)	(GstElement *element);
465
  void			(*set_clock)		(GstElement *element, GstClock *clock);
466

Wim Taymans's avatar
Wim Taymans committed
467
  /* index */
468 469
  GstIndex*		(*get_index)		(GstElement *element);
  void			(*set_index)		(GstElement *element, GstIndex *index);
Wim Taymans's avatar
Wim Taymans committed
470

471
  /* query functions */
472
  gboolean		(*send_event)		(GstElement *element, GstEvent *event);
473

474
  const GstQueryType*	(*get_query_types)	(GstElement *element);
475
  gboolean		(*query)		(GstElement *element, GstQuery *query);
Wim Taymans's avatar
Wim Taymans committed
476

477 478
  /*< private >*/
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
479 480
};

481
/* element class pad templates */
482
void			gst_element_class_add_pad_template	(GstElementClass *klass, GstPadTemplate *templ);
483 484
GstPadTemplate*		gst_element_class_get_pad_template	(GstElementClass *element_class, const gchar *name);
GList*                  gst_element_class_get_pad_template_list (GstElementClass *element_class);
485 486
void			gst_element_class_set_details		(GstElementClass *klass,
								 const GstElementDetails *details);
487

488 489
/* element instance */
GType			gst_element_get_type		(void);
Erik Walthinsen's avatar
Erik Walthinsen committed
490

491
/* basic name and parentage stuff from GstObject */
492 493 494 495 496 497 498

/**
 * gst_element_get_name:
 * @elem: a #GstElement to set the name of.
 *
 * Gets the name of the element.
 */
499
#define			gst_element_get_name(elem)	gst_object_get_name(GST_OBJECT_CAST(elem))
500 501 502 503

/**
 * gst_element_set_name:
 * @elem: a #GstElement to set the name of.
504
 * @name: the new name
505 506 507
 *
 * Sets the name of the element, getting rid of the old name if there was one.
 */
508
#define			gst_element_set_name(elem,name)	gst_object_set_name(GST_OBJECT_CAST(elem),name)
509 510 511 512 513 514 515

/**
 * gst_element_get_parent:
 * @elem: a #GstElement to get the parent of.
 *
 * Gets the parent of an element.
 */
516
#define			gst_element_get_parent(elem)	gst_object_get_parent(GST_OBJECT_CAST(elem))
517 518 519 520

/**
 * gst_element_set_parent:
 * @elem: a #GstElement to set the parent of.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
521
 * @parent: the new parent #GstObject of the element.
522 523 524
 *
 * Sets the parent of an element.
 */
525
#define			gst_element_set_parent(elem,parent)	gst_object_set_parent(GST_OBJECT_CAST(elem),parent)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
526

527
/* clocking */
528 529
gboolean		gst_element_requires_clock	(GstElement *element);
gboolean		gst_element_provides_clock	(GstElement *element);
530
GstClock*		gst_element_provide_clock	(GstElement *element);
531 532
GstClock*		gst_element_get_clock		(GstElement *element);
void			gst_element_set_clock		(GstElement *element, GstClock *clock);
533 534
void			gst_element_set_base_time	(GstElement *element, GstClockTime time);
GstClockTime		gst_element_get_base_time	(GstElement *element);
535 536

/* indexes */
537 538 539 540
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
541
/* bus */
542 543
void			gst_element_set_bus		(GstElement * element, GstBus * bus);
GstBus *		gst_element_get_bus		(GstElement * element);
544

545
/* pad management */
546 547
gboolean		gst_element_add_pad		(GstElement *element, GstPad *pad);
gboolean		gst_element_remove_pad		(GstElement *element, GstPad *pad);
548
void			gst_element_no_more_pads	(GstElement *element);
549 550 551 552 553 554

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

555 556 557
GstIterator *		gst_element_iterate_pads 	(GstElement * element);
GstIterator *		gst_element_iterate_src_pads 	(GstElement * element);
GstIterator *		gst_element_iterate_sink_pads 	(GstElement * element);
558

559
/* event/query/format stuff */
560
gboolean		gst_element_send_event		(GstElement *element, GstEvent *event);
Wim Taymans's avatar
Wim Taymans committed
561 562 563 564
gboolean		gst_element_seek		(GstElement *element, gdouble rate,
							 GstFormat format, GstSeekFlags flags,
							 GstSeekType cur_type, gint64 cur,
							 GstSeekType stop_type, gint64 stop);
565 566
G_CONST_RETURN GstQueryType*
			gst_element_get_query_types	(GstElement *element);
567
gboolean		gst_element_query		(GstElement *element, GstQuery *query);
568

Wim Taymans's avatar
Wim Taymans committed
569
/* messages */
570
gboolean		gst_element_post_message	(GstElement * element, GstMessage * message);
Wim Taymans's avatar
Wim Taymans committed
571

572
/* error handling */
573
gchar *			_gst_element_error_printf	(const gchar *format, ...);
574 575
void			gst_element_message_full	(GstElement * element, GstMessageType type,
							 GQuark domain, gint code, gchar * text,
576
							 gchar * debug, const gchar * file,
577
							 const gchar * function, gint line);
578 579

/* state management */
580
gboolean		gst_element_is_locked_state	(GstElement *element);
581
gboolean		gst_element_set_locked_state	(GstElement *element, gboolean locked_state);
582 583
gboolean		gst_element_sync_state_with_parent (GstElement *element);

584 585 586
GstStateChangeReturn	gst_element_get_state		(GstElement * element,
							 GstState * state,
							 GstState * pending,
587
							 GstClockTime timeout);
588
GstStateChangeReturn	gst_element_set_state		(GstElement *element, GstState state);
589

590
void			gst_element_abort_state		(GstElement * element);
591
GstStateChangeReturn	gst_element_commit_state	(GstElement * element);
592
void			gst_element_lost_state	        (GstElement * element);
Wim Taymans's avatar
Wim Taymans committed
593

594 595
/* factory management */
GstElementFactory*	gst_element_get_factory		(GstElement *element);
596

597
G_END_DECLS
598

599
#endif /* __GST_ELEMENT_H__ */