gstelement.h 24.5 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
/**
 * 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
 *
40
 * The posible states an element can be in.
Wim Taymans's avatar
Wim Taymans committed
41
 */
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
/**
 * 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
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
80 81 82
 * @GST_STATE_CHANGE_NO_PREROLL: the state change succeeded but the element
 *                               cannot produce data in PAUSED. This typically
 *                               happens with live sources.
83
 *
84 85
 * The possible return values from a state change function. Only
 * @GST_STATE_CHANGE_FAILURE is a real failure.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
86
 */
Wim Taymans's avatar
Wim Taymans committed
87
typedef enum {
88 89 90 91 92
  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
93

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

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

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

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

122 123 124 125 126 127 128 129 130 131
/**
 * GST_STATE_TARGET:
 * @elem: a #GstElement to return the target state for.
 *
 * This macro returns the target #GstState of the element.
 *
 * Since: 0.10.13
 */
#define GST_STATE_TARGET(elem)		(GST_ELEMENT_CAST(elem)->abidata.ABI.target_state)

132 133
/**
 * GST_STATE_RETURN:
134
 * @elem: a #GstElement to return the last state result for.
135
 *
136
 * This macro returns the last #GstStateChangeReturn value.
137
 */
138
#define GST_STATE_RETURN(elem)		(GST_ELEMENT_CAST(elem)->last_return)
139

140
#define __GST_SIGN(val)			((val) < 0 ? -1 : ((val) > 0 ? 1 : 0))
Wim Taymans's avatar
Wim Taymans committed
141 142
/**
 * GST_STATE_GET_NEXT:
143 144
 * @cur: A starting #GstState
 * @pending: A target #GstState
Wim Taymans's avatar
Wim Taymans committed
145
 *
146 147
 * Given a current state @cur and a target state @pending, calculate the next (intermediate)
 * #GstState.
Wim Taymans's avatar
Wim Taymans committed
148
 */
149
#define GST_STATE_GET_NEXT(cur,pending)		((cur) + __GST_SIGN ((gint)(pending) - (gint)(cur)))
Wim Taymans's avatar
Wim Taymans committed
150 151 152 153 154
/**
 * GST_STATE_TRANSITION:
 * @cur: A current state
 * @next: A next state
 *
155
 * Given a current state @cur and a next state @next, calculate the associated
156
 * #GstStateChange transition.
Wim Taymans's avatar
Wim Taymans committed
157
 */
158
#define GST_STATE_TRANSITION(cur,next)		((GstStateChange)(((cur)<<3)|(next)))
Wim Taymans's avatar
Wim Taymans committed
159 160
/**
 * GST_STATE_TRANSITION_CURRENT:
161
 * @trans: A #GstStateChange
Wim Taymans's avatar
Wim Taymans committed
162
 *
163
 * Given a state transition @trans, extract the current #GstState.
Wim Taymans's avatar
Wim Taymans committed
164
 */
165
#define GST_STATE_TRANSITION_CURRENT(trans)	((GstState)((trans)>>3))
Wim Taymans's avatar
Wim Taymans committed
166 167
/**
 * GST_STATE_TRANSITION_NEXT:
168
 * @trans: A #GstStateChange
Wim Taymans's avatar
Wim Taymans committed
169
 *
170
 * Given a state transition @trans, extract the next #GstState.
Wim Taymans's avatar
Wim Taymans committed
171
 */
172
#define GST_STATE_TRANSITION_NEXT(trans)	((GstState)((trans)&0x7))
173

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
174 175 176 177 178 179 180 181
/**
 * 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
182 183 184
 *
 * The different (interesting) state changes that are passed to the
 * state change functions of elements.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
185
 */
186
typedef enum /*< flags=0 >*/
187
{
188 189 190 191 192 193
  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
194
} GstStateChange;
195

196 197 198 199 200 201 202 203 204 205
/**
 * 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.
 */
206 207
typedef enum
{
208 209 210 211 212
  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)
213
} GstElementFlags;
214

215 216
/**
 * GST_ELEMENT_IS_LOCKED_STATE:
217
 * @elem: A #GstElement to query
218
 *
219
 * Check if the element is in the locked state and therefore will ignore state
220 221
 * changes from its parent object.
 */
222
#define GST_ELEMENT_IS_LOCKED_STATE(elem)        (GST_OBJECT_FLAG_IS_SET(elem,GST_ELEMENT_LOCKED_STATE))
223

224 225
/**
 * GST_ELEMENT_NAME:
226
 * @elem: A #GstElement to query
227 228 229 230
 *
 * Gets the name of this element. Use only in core as this is not
 * ABI-compatible. Others use gst_element_get_name()
 */
231
#define GST_ELEMENT_NAME(elem)			(GST_OBJECT_NAME(elem))
232 233 234

/**
 * GST_ELEMENT_PARENT:
235
 * @elem: A #GstElement to query
236 237 238
 *
 * Get the parent object of this element.
 */
239
#define GST_ELEMENT_PARENT(elem)		(GST_ELEMENT_CAST(GST_OBJECT_PARENT(elem)))
240 241 242

/**
 * GST_ELEMENT_BUS:
243
 * @elem: A #GstElement to query
244 245 246
 *
 * Get the message bus of this element.
 */
247
#define GST_ELEMENT_BUS(elem)			(GST_ELEMENT_CAST(elem)->bus)
248 249 250

/**
 * GST_ELEMENT_CLOCK:
251
 * @elem: A #GstElement to query
252 253 254
 *
 * Get the clock of this element
 */
255
#define GST_ELEMENT_CLOCK(elem)			(GST_ELEMENT_CAST(elem)->clock)
256 257 258

/**
 * GST_ELEMENT_PADS:
259
 * @elem: A #GstElement to query
260 261 262
 *
 * Get the pads of this elements.
 */
263
#define GST_ELEMENT_PADS(elem)			(GST_ELEMENT_CAST(elem)->pads)
264

265 266
/**
 * GST_ELEMENT_ERROR:
267
 * @el:     the element that generates the error
268 269
 * @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
270 271 272 273
 * @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)
274 275
 *
 * Utility function that elements can use in case they encountered a fatal
276
 * data processing error. The pipeline will post an error message and the
277 278
 * application will be requested to stop further media processing.
 */
Wim Taymans's avatar
Wim Taymans committed
279 280 281 282 283
#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)								\
284
    GST_WARNING_OBJECT (el, "error: %s", __txt);			\
Wim Taymans's avatar
Wim Taymans committed
285
  if (__dbg)								\
286
    GST_WARNING_OBJECT (el, "error: %s", __dbg);			\
Wim Taymans's avatar
Wim Taymans committed
287 288 289
  gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_ERROR,		\
    GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,	\
    __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);			\
290
} G_STMT_END
291

292 293
/**
 * GST_ELEMENT_WARNING:
294
 * @el:     the element that generates the warning
295 296
 * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
 * @code:   error code defined for that domain (see #gstreamer-GstGError)
297 298 299 300 301 302
 * @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
303
 * data processing problem. The pipeline will post a warning message and the
304 305
 * application will be informed.
 */
Wim Taymans's avatar
Wim Taymans committed
306 307 308 309 310
#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)								\
311
    GST_WARNING_OBJECT (el, "warning: %s", __txt);			\
Wim Taymans's avatar
Wim Taymans committed
312
  if (__dbg)								\
313
    GST_WARNING_OBJECT (el, "warning: %s", __dbg);			\
Wim Taymans's avatar
Wim Taymans committed
314 315 316 317
  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
318

319 320 321 322 323 324 325 326 327 328 329 330 331 332
/**
 * GST_ELEMENT_INFO:
 * @el:     the element that generates the information
 * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
 * @code:   error code defined for that domain (see #gstreamer-GstGError)
 * @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 want to inform
 * the application of something noteworthy that is not an error.
 * The pipeline will post a warning message and the
 * application will be informed.
333 334
 *
 * Since: 0.10.12
335 336 337 338 339 340 341 342 343 344 345 346 347 348
 */
#define GST_ELEMENT_INFO(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_INFO_OBJECT (el, "info: %s", __txt);				\
  if (__dbg)								\
    GST_INFO_OBJECT (el, "info: %s", __dbg);				\
  gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_INFO,		\
    GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,	\
  __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);			\
} G_STMT_END

349
/* the state change mutexes and conds */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
350
/**
351 352
 * GST_STATE_GET_LOCK:
 * @elem:   a #GstElement
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
353
 *
354 355
 * 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
356 357
 * the state, during state changes, and while finalizing.
 */
358 359 360
#define GST_STATE_GET_LOCK(elem)               (GST_ELEMENT_CAST(elem)->state_lock)
/**
 * GST_STATE_GET_COND:
361
 * @elem: a #GstElement
362 363 364 365 366
 *
 * Get the conditional used to signal the completion of a state change.
 */
#define GST_STATE_GET_COND(elem)               (GST_ELEMENT_CAST(elem)->state_cond)

367 368 369 370 371
#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)
372
#define GST_STATE_WAIT(elem)                   g_cond_wait (GST_STATE_GET_COND (elem), \
373
							GST_OBJECT_GET_LOCK (elem))
374
#define GST_STATE_TIMED_WAIT(elem, timeval)    g_cond_timed_wait (GST_STATE_GET_COND (elem), \
375
							GST_OBJECT_GET_LOCK (elem), timeval)
376 377 378
#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));

379 380 381 382
/**
 * GstElement:
 * @state_lock: Used to serialize execution of gst_element_set_state()
 * @state_cond: Used to signal completion of a state change
383 384
 * @state_cookie: Used to detect concurrent execution of
 * gst_element_set_state() and gst_element_get_state()
385
 * @current_state: the current state of an element
386 387 388 389
 * @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
390
 * @last_return: the last return value of an element state change
391 392 393 394 395 396 397
 * @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.
398 399 400 401 402 403 404 405 406 407
 * @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
408
struct _GstElement
409
{
410
  GstObject		object;
Erik Walthinsen's avatar
Erik Walthinsen committed
411

412
  /*< public >*/ /* with LOCK */
413
  GStaticRecMutex      *state_lock;
414 415

  /* element state */
416
  GCond                *state_cond;
Wim Taymans's avatar
Wim Taymans committed
417
  guint32		state_cookie;
418 419 420 421 422
  GstState              current_state;
  GstState              next_state;
  GstState              pending_state;
  GstStateChangeReturn  last_return;

423
  GstBus	       *bus;
Wim Taymans's avatar
Wim Taymans committed
424 425

  /* allocated clock */
426
  GstClock	       *clock;
427
  GstClockTimeDiff	base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
428

429
  /* element pads, these lists can only be iterated while holding
430
   * the LOCK or checking the cookie after each LOCK. */
431 432 433 434 435 436 437 438 439
  guint16               numpads;
  GList                *pads;
  guint16               numsrcpads;
  GList                *srcpads;
  guint16               numsinkpads;
  GList                *sinkpads;
  guint32               pads_cookie;

  /*< private >*/
440 441 442 443 444 445 446 447
  union {
    struct {
      /* state set by application */
      GstState              target_state;
    } ABI;
    /* adding + 0 to mark ABI change to be undone later */
    gpointer _gst_reserved[GST_PADDING + 0];
  } abidata;
Erik Walthinsen's avatar
Erik Walthinsen committed
448 449
};

450 451 452 453 454 455
/**
 * 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
456
 * @numpadtemplates: the number of padtemplates
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
 * @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.
 */
475 476
struct _GstElementClass
{
477
  GstObjectClass         parent_class;
Erik Walthinsen's avatar
Erik Walthinsen committed
478

479
  /*< public >*/
480
  /* the element details */
481
  GstElementDetails	 details;
482 483

  /* factory that the element was created from */
484
  GstElementFactory	*elementfactory;
485

486
  /* templates for our pads */
487 488 489
  GList                 *padtemplates;
  gint                   numpadtemplates;
  guint32                pad_templ_cookie;
490

491
  /*< private >*/
Erik Walthinsen's avatar
Erik Walthinsen committed
492
  /* signal callbacks */
493
  void (*pad_added)	(GstElement *element, GstPad *pad);
494
  void (*pad_removed)	(GstElement *element, GstPad *pad);
495
  void (*no_more_pads)	(GstElement *element);
496

497 498
  /*< public >*/
  /* virtual methods for subclasses */
499 500

  /* request/release pads */
501 502
  GstPad*		(*request_new_pad)	(GstElement *element, GstPadTemplate *templ, const gchar* name);
  void			(*release_pad)		(GstElement *element, GstPad *pad);
503

504
  /* state changes */
505
  GstStateChangeReturn (*get_state)		(GstElement * element, GstState * state,
506
						 GstState * pending, GstClockTime timeout);
Wim Taymans's avatar
Wim Taymans committed
507
  GstStateChangeReturn (*set_state)		(GstElement *element, GstState state);
508
  GstStateChangeReturn (*change_state)		(GstElement *element, GstStateChange transition);
509

Wim Taymans's avatar
Wim Taymans committed
510
  /* bus */
511
  void			(*set_bus)		(GstElement * element, GstBus * bus);
512

513
  /* set/get clocks */
514
  GstClock*		(*provide_clock)	(GstElement *element);
515
  gboolean		(*set_clock)		(GstElement *element, GstClock *clock);
516

Wim Taymans's avatar
Wim Taymans committed
517
  /* index */
518 519
  GstIndex*		(*get_index)		(GstElement *element);
  void			(*set_index)		(GstElement *element, GstIndex *index);
Wim Taymans's avatar
Wim Taymans committed
520

521
  /* query functions */
522
  gboolean		(*send_event)		(GstElement *element, GstEvent *event);
523

524
  const GstQueryType*	(*get_query_types)	(GstElement *element);
525
  gboolean		(*query)		(GstElement *element, GstQuery *query);
Wim Taymans's avatar
Wim Taymans committed
526

527 528
  /*< private >*/
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
529 530
};

531
/* element class pad templates */
532
void			gst_element_class_add_pad_template	(GstElementClass *klass, GstPadTemplate *templ);
533
GstPadTemplate*		gst_element_class_get_pad_template	(GstElementClass *element_class, const gchar *name);
534 535
GList*                  gst_element_class_get_pad_template_list	(GstElementClass *element_class);
void			gst_element_class_set_details		(GstElementClass *klass, const GstElementDetails *details);
536 537 538 539 540
void			gst_element_class_set_details_simple	(GstElementClass *klass,
			                                    	 const gchar     *longname,
			                                    	 const gchar     *classification,
			                                    	 const gchar     *description,
			                                         const gchar     *author);
541

542 543
/* element instance */
GType			gst_element_get_type		(void);
Erik Walthinsen's avatar
Erik Walthinsen committed
544

545
/* basic name and parentage stuff from GstObject */
546 547 548 549 550 551 552

/**
 * gst_element_get_name:
 * @elem: a #GstElement to set the name of.
 *
 * Gets the name of the element.
 */
553
#define			gst_element_get_name(elem)	gst_object_get_name(GST_OBJECT_CAST(elem))
554 555 556 557

/**
 * gst_element_set_name:
 * @elem: a #GstElement to set the name of.
558
 * @name: the new name
559 560 561
 *
 * Sets the name of the element, getting rid of the old name if there was one.
 */
562
#define			gst_element_set_name(elem,name)	gst_object_set_name(GST_OBJECT_CAST(elem),name)
563 564 565 566 567 568 569

/**
 * gst_element_get_parent:
 * @elem: a #GstElement to get the parent of.
 *
 * Gets the parent of an element.
 */
570
#define			gst_element_get_parent(elem)	gst_object_get_parent(GST_OBJECT_CAST(elem))
571 572 573 574

/**
 * gst_element_set_parent:
 * @elem: a #GstElement to set the parent of.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
575
 * @parent: the new parent #GstObject of the element.
576 577 578
 *
 * Sets the parent of an element.
 */
579
#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
580

581
/* clocking */
582 583
gboolean		gst_element_requires_clock	(GstElement *element);
gboolean		gst_element_provides_clock	(GstElement *element);
584
GstClock*		gst_element_provide_clock	(GstElement *element);
585
GstClock*		gst_element_get_clock		(GstElement *element);
586
gboolean		gst_element_set_clock		(GstElement *element, GstClock *clock);
587 588
void			gst_element_set_base_time	(GstElement *element, GstClockTime time);
GstClockTime		gst_element_get_base_time	(GstElement *element);
589 590

/* indexes */
591 592 593 594
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
595
/* bus */
596 597
void			gst_element_set_bus		(GstElement * element, GstBus * bus);
GstBus *		gst_element_get_bus		(GstElement * element);
598

599
/* pad management */
600 601
gboolean		gst_element_add_pad		(GstElement *element, GstPad *pad);
gboolean		gst_element_remove_pad		(GstElement *element, GstPad *pad);
602
void			gst_element_no_more_pads	(GstElement *element);
603

604
#ifndef GST_DISABLE_DEPRECATED
605
GstPad*			gst_element_get_pad		(GstElement *element, const gchar *name);
606
#endif /* GST_DISABLE_DEPRECATED */
607 608 609 610
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);

611 612 613
GstIterator *		gst_element_iterate_pads	(GstElement * element);
GstIterator *		gst_element_iterate_src_pads	(GstElement * element);
GstIterator *		gst_element_iterate_sink_pads	(GstElement * element);
614

615
/* event/query/format stuff */
616
gboolean		gst_element_send_event		(GstElement *element, GstEvent *event);
Wim Taymans's avatar
Wim Taymans committed
617 618 619 620
gboolean		gst_element_seek		(GstElement *element, gdouble rate,
							 GstFormat format, GstSeekFlags flags,
							 GstSeekType cur_type, gint64 cur,
							 GstSeekType stop_type, gint64 stop);
621 622
G_CONST_RETURN GstQueryType*
			gst_element_get_query_types	(GstElement *element);
623
gboolean		gst_element_query		(GstElement *element, GstQuery *query);
624

Wim Taymans's avatar
Wim Taymans committed
625
/* messages */
626
gboolean		gst_element_post_message	(GstElement * element, GstMessage * message);
Wim Taymans's avatar
Wim Taymans committed
627

628
/* error handling */
629 630
/* gcc versions < 3.3 warn about NULL being passed as format to printf */
#if (defined(GST_USING_PRINTF_EXTENSION) || !defined(__GNUC__) || (__GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 3))
631
gchar *			_gst_element_error_printf	(const gchar *format, ...);
632 633 634
#else
gchar *			_gst_element_error_printf	(const gchar *format, ...) G_GNUC_PRINTF (1, 2);
#endif
635 636
void			gst_element_message_full	(GstElement * element, GstMessageType type,
							 GQuark domain, gint code, gchar * text,
637
							 gchar * debug, const gchar * file,
638
							 const gchar * function, gint line);
639 640

/* state management */
641
gboolean		gst_element_is_locked_state	(GstElement *element);
642
gboolean		gst_element_set_locked_state	(GstElement *element, gboolean locked_state);
643 644
gboolean		gst_element_sync_state_with_parent (GstElement *element);

645 646 647
GstStateChangeReturn	gst_element_get_state		(GstElement * element,
							 GstState * state,
							 GstState * pending,
648
							 GstClockTime timeout);
649
GstStateChangeReturn	gst_element_set_state		(GstElement *element, GstState state);
650

651
void			gst_element_abort_state		(GstElement * element);
652 653
GstStateChangeReturn    gst_element_change_state        (GstElement * element,
		                                         GstStateChange transition);
654 655
GstStateChangeReturn	gst_element_continue_state	(GstElement * element,
                                                         GstStateChangeReturn ret);
656
void			gst_element_lost_state	        (GstElement * element);
Wim Taymans's avatar
Wim Taymans committed
657

658 659
/* factory management */
GstElementFactory*	gst_element_get_factory		(GstElement *element);
660

661
G_END_DECLS
662

663
#endif /* __GST_ELEMENT_H__ */