gst/gstelement.h

   1 /* GStreamer
   2  * 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
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23
  24 #ifndef __GST_ELEMENT_H__
  25 #define __GST_ELEMENT_H__
  26
  27 /* gstelement.h and gstelementfactory.h include eachother */
  28 typedef struct _GstElement GstElement;
  29 typedef struct _GstElementClass GstElementClass;
  30
  31 /* gstmessage.h needs State */
  32 /**
  33  * GstState:
  34  * @GST_STATE_VOID_PENDING     : no pending state.
  35  * @GST_STATE_NULL             : the NULL state or initial state of an element
  36  * @GST_STATE_READY            : the element is ready to go to PAUSED
  37  * @GST_STATE_PAUSED           : the element is PAUSED
  38  * @GST_STATE_PLAYING          : the element is PLAYING
  39  *
  40  * The posible states an element can be in.
  41  */
  42 typedef enum {
  43   GST_STATE_VOID_PENDING        = 0,
  44   GST_STATE_NULL                = 1,
  45   GST_STATE_READY               = 2,
  46   GST_STATE_PAUSED              = 3,
  47   GST_STATE_PLAYING             = 4
  48 } GstState;
  49
  50
  51 #include <gst/gstconfig.h>
  52 #include <gst/gstobject.h>
  53 #include <gst/gstpad.h>
  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>
  59 #include <gst/gstindex.h>
  60 #include <gst/gstindexfactory.h>
  61 #include <gst/gstiterator.h>
  62 #include <gst/gstmessage.h>
  63 #include <gst/gsttaglist.h>
  64
  65 G_BEGIN_DECLS
  66
  67 #define GST_TYPE_ELEMENT                (gst_element_get_type ())
  68 #define GST_IS_ELEMENT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
  69 #define GST_IS_ELEMENT_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
  70 #define GST_ELEMENT_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ELEMENT, GstElementClass))
  71 #define GST_ELEMENT(obj)                (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
  72 #define GST_ELEMENT_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
  73 #define GST_ELEMENT_CAST(obj)           ((GstElement*)(obj))
  74
  75 /**
  76  * GstStateChangeReturn:
  77  * @GST_STATE_CHANGE_FAILURE   : the state change failed
  78  * @GST_STATE_CHANGE_SUCCESS   : the state change succeeded
  79  * @GST_STATE_CHANGE_ASYNC     : the state change will happen asynchronously
  80  * @GST_STATE_CHANGE_NO_PREROLL: the state change succeeded but the element cannot
  81  *                               produce data in PAUSED. This typically happens
  82  *                               with live sources.
  83  *
  84  * The possible return values from a state change function. Only
  85  * @GST_STATE_CHANGE_FAILURE is a real failure.
  86  */
  87 typedef enum {
  88   GST_STATE_CHANGE_FAILURE             = 0,
  89   GST_STATE_CHANGE_SUCCESS             = 1,
  90   GST_STATE_CHANGE_ASYNC               = 2,
  91   GST_STATE_CHANGE_NO_PREROLL          = 3
  92 } GstStateChangeReturn;
  93
  94 /* NOTE: this probably should be done with an #ifdef to decide
  95  * whether to safe-cast or to just do the non-checking cast.
  96  */
  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  * GST_STATE_RETURN:
 124  * @elem: a #GstElement to return the last state result for.
 125  *
 126  * This macro returns the last #GstStateChangeReturn value.
 127  */
 128 #define GST_STATE_RETURN(elem)          (GST_ELEMENT_CAST(elem)->last_return)
 129
 130 #define __GST_SIGN(val)                 ((val) < 0 ? -1 : ((val) > 0 ? 1 : 0))
 131 /**
 132  * GST_STATE_GET_NEXT:
 133  * @cur: A starting #GstState
 134  * @pending: A target #GstState
 135  *
 136  * Given a current state @cur and a target state @pending, calculate the next (intermediate)
 137  * #GstState.
 138  */
 139 #define GST_STATE_GET_NEXT(cur,pending)         ((cur) + __GST_SIGN ((gint)(pending) - (gint)(cur)))
 140 /**
 141  * GST_STATE_TRANSITION:
 142  * @cur: A current state
 143  * @next: A next state
 144  *
 145  * Given a current state @cur and a next state @next, calculate the associated
 146  * #GstStateChange transition.
 147  */
 148 #define GST_STATE_TRANSITION(cur,next)          ((GstStateChange)(((cur)<<3)|(next)))
 149 /**
 150  * GST_STATE_TRANSITION_CURRENT:
 151  * @trans: A #GstStateChange
 152  *
 153  * Given a state transition @trans, extract the current #GstState.
 154  */
 155 #define GST_STATE_TRANSITION_CURRENT(trans)     ((GstState)((trans)>>3))
 156 /**
 157  * GST_STATE_TRANSITION_NEXT:
 158  * @trans: A #GstStateChange
 159  *
 160  * Given a state transition @trans, extract the next #GstState.
 161  */
 162 #define GST_STATE_TRANSITION_NEXT(trans)        ((GstState)((trans)&0x7))
 163
 164 /**
 165  * GstStateChange:
 166  * @GST_STATE_CHANGE_NULL_TO_READY    : state change from NULL to READY
 167  * @GST_STATE_CHANGE_READY_TO_PAUSED  : state change from READY to PAUSED
 168  * @GST_STATE_CHANGE_PAUSED_TO_PLAYING: state change from PAUSED to PLAYING
 169  * @GST_STATE_CHANGE_PLAYING_TO_PAUSED: state change from PLAYING to PAUSED
 170  * @GST_STATE_CHANGE_PAUSED_TO_READY  : state change from PAUSED to READY
 171  * @GST_STATE_CHANGE_READY_TO_NULL    : state change from READY to NULL
 172  *
 173  * The different (interesting) state changes that are passed to the
 174  * state change functions of elements.
 175  */
 176 typedef enum /*< flags=0 >*/
 177 {
 178   GST_STATE_CHANGE_NULL_TO_READY        = (GST_STATE_NULL<<3) | GST_STATE_READY,
 179   GST_STATE_CHANGE_READY_TO_PAUSED      = (GST_STATE_READY<<3) | GST_STATE_PAUSED,
 180   GST_STATE_CHANGE_PAUSED_TO_PLAYING    = (GST_STATE_PAUSED<<3) | GST_STATE_PLAYING,
 181   GST_STATE_CHANGE_PLAYING_TO_PAUSED    = (GST_STATE_PLAYING<<3) | GST_STATE_PAUSED,
 182   GST_STATE_CHANGE_PAUSED_TO_READY      = (GST_STATE_PAUSED<<3) | GST_STATE_READY,
 183   GST_STATE_CHANGE_READY_TO_NULL        = (GST_STATE_READY<<3) | GST_STATE_NULL
 184 } GstStateChange;
 185
 186 /**
 187  * GstElementFlags:
 188  * @GST_ELEMENT_LOCKED_STATE: ignore state changes from parent
 189  * @GST_ELEMENT_IS_SINK: the element is a sink
 190  * @GST_ELEMENT_UNPARENTING: Child is being removed from the parent bin.
 191  *  gst_bin_remove() on a child already being removed immediately returns FALSE
 192  * @GST_ELEMENT_FLAG_LAST: offset to define more flags
 193  *
 194  * The standard flags that an element may have.
 195  */
 196 typedef enum
 197 {
 198   GST_ELEMENT_LOCKED_STATE      = (GST_OBJECT_FLAG_LAST << 0),
 199   GST_ELEMENT_IS_SINK           = (GST_OBJECT_FLAG_LAST << 1),
 200   GST_ELEMENT_UNPARENTING       = (GST_OBJECT_FLAG_LAST << 2),
 201   /* padding */
 202   GST_ELEMENT_FLAG_LAST         = (GST_OBJECT_FLAG_LAST << 16)
 203 } GstElementFlags;
 204
 205 /**
 206  * GST_ELEMENT_IS_LOCKED_STATE:
 207  * @elem: A #GstElement to query
 208  *
 209  * Check if the element is in the locked state and therefore will ignore state
 210  * changes from its parent object.
 211  */
 212 #define GST_ELEMENT_IS_LOCKED_STATE(elem)        (GST_OBJECT_FLAG_IS_SET(elem,GST_ELEMENT_LOCKED_STATE))
 213
 214 /**
 215  * GST_ELEMENT_NAME:
 216  * @elem: A #GstElement to query
 217  *
 218  * Gets the name of this element. Use only in core as this is not
 219  * ABI-compatible. Others use gst_element_get_name()
 220  */
 221 #define GST_ELEMENT_NAME(elem)                  (GST_OBJECT_NAME(elem))
 222
 223 /**
 224  * GST_ELEMENT_PARENT:
 225  * @elem: A #GstElement to query
 226  *
 227  * Get the parent object of this element.
 228  */
 229 #define GST_ELEMENT_PARENT(elem)                (GST_ELEMENT_CAST(GST_OBJECT_PARENT(elem)))
 230
 231 /**
 232  * GST_ELEMENT_BUS:
 233  * @elem: A #GstElement to query
 234  *
 235  * Get the message bus of this element.
 236  */
 237 #define GST_ELEMENT_BUS(elem)                   (GST_ELEMENT_CAST(elem)->bus)
 238
 239 /**
 240  * GST_ELEMENT_CLOCK:
 241  * @elem: A #GstElement to query
 242  *
 243  * Get the clock of this element
 244  */
 245 #define GST_ELEMENT_CLOCK(elem)                 (GST_ELEMENT_CAST(elem)->clock)
 246
 247 /**
 248  * GST_ELEMENT_PADS:
 249  * @elem: A #GstElement to query
 250  *
 251  * Get the pads of this elements.
 252  */
 253 #define GST_ELEMENT_PADS(elem)                  (GST_ELEMENT_CAST(elem)->pads)
 254
 255 /**
 256  * GST_ELEMENT_ERROR:
 257  * @el:     the element that generates the error
 258  * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #GstGError)
 259  * @code:   error code defined for that domain (see #GstGError)
 260  * @text:   the message to display (format string and args enclosed in
 261             parentheses)
 262  * @debug:  debugging information for the message (format string and args
 263             enclosed in parentheses)
 264  *
 265  * Utility function that elements can use in case they encountered a fatal
 266  * data processing error. The pipeline will post an error message and the
 267  * application will be requested to stop further media processing.
 268  */
 269 #define GST_ELEMENT_ERROR(el, domain, code, text, debug)                \
 270 G_STMT_START {                                                          \
 271   gchar *__txt = _gst_element_error_printf text;                        \
 272   gchar *__dbg = _gst_element_error_printf debug;                       \
 273   if (__txt)                                                            \
 274     GST_WARNING_OBJECT (el, "error: %s", __txt);                        \
 275   if (__dbg)                                                            \
 276     GST_WARNING_OBJECT (el, "error: %s", __dbg);                        \
 277   gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_ERROR,         \
 278     GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,        \
 279     __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);                    \
 280 } G_STMT_END
 281
 282 /**
 283  * GST_ELEMENT_WARNING:
 284  * @el:     the element that generates the warning
 285  * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
 286  * @code:   error code defined for that domain (see #gstreamer-GstGError)
 287  * @text:   the message to display (format string and args enclosed in
 288             parentheses)
 289  * @debug:  debugging information for the message (format string and args
 290             enclosed in parentheses)
 291  *
 292  * Utility function that elements can use in case they encountered a non-fatal
 293  * data processing problem. The pipeline will post a warning message and the
 294  * application will be informed.
 295  */
 296 #define GST_ELEMENT_WARNING(el, domain, code, text, debug)              \
 297 G_STMT_START {                                                          \
 298   gchar *__txt = _gst_element_error_printf text;                        \
 299   gchar *__dbg = _gst_element_error_printf debug;                       \
 300   if (__txt)                                                            \
 301     GST_WARNING_OBJECT (el, "warning: %s", __txt);                      \
 302   if (__dbg)                                                            \
 303     GST_WARNING_OBJECT (el, "warning: %s", __dbg);                      \
 304   gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_WARNING,       \
 305     GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,        \
 306   __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);                      \
 307 } G_STMT_END
 308
 309 /**
 310  * GST_ELEMENT_INFO:
 311  * @el:     the element that generates the information
 312  * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
 313  * @code:   error code defined for that domain (see #gstreamer-GstGError)
 314  * @text:   the message to display (format string and args enclosed in
 315             parentheses)
 316  * @debug:  debugging information for the message (format string and args
 317             enclosed in parentheses)
 318  *
 319  * Utility function that elements can use in case they want to inform
 320  * the application of something noteworthy that is not an error.
 321  * The pipeline will post a warning message and the
 322  * application will be informed.
 323  *
 324  * Since: 0.10.12
 325  */
 326 #define GST_ELEMENT_INFO(el, domain, code, text, debug)                 \
 327 G_STMT_START {                                                          \
 328   gchar *__txt = _gst_element_error_printf text;                        \
 329   gchar *__dbg = _gst_element_error_printf debug;                       \
 330   if (__txt)                                                            \
 331     GST_INFO_OBJECT (el, "info: %s", __txt);                            \
 332   if (__dbg)                                                            \
 333     GST_INFO_OBJECT (el, "info: %s", __dbg);                            \
 334   gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_INFO,          \
 335     GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,        \
 336   __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);                      \
 337 } G_STMT_END
 338
 339 /* the state change mutexes and conds */
 340 /**
 341  * GST_STATE_GET_LOCK:
 342  * @elem:   a #GstElement
 343  *
 344  * Get a reference to the state lock of @elem.
 345  * This lock is used by the core.  It is taken while getting or setting
 346  * the state, during state changes, and while finalizing.
 347  */
 348 #define GST_STATE_GET_LOCK(elem)               (GST_ELEMENT_CAST(elem)->state_lock)
 349 /**
 350  * GST_STATE_GET_COND:
 351  * @elem: a #GstElement
 352  *
 353  * Get the conditional used to signal the completion of a state change.
 354  */
 355 #define GST_STATE_GET_COND(elem)               (GST_ELEMENT_CAST(elem)->state_cond)
 356
 357 #define GST_STATE_LOCK(elem)                   g_static_rec_mutex_lock(GST_STATE_GET_LOCK(elem))
 358 #define GST_STATE_TRYLOCK(elem)                g_static_rec_mutex_trylock(GST_STATE_GET_LOCK(elem))
 359 #define GST_STATE_UNLOCK(elem)                 g_static_rec_mutex_unlock(GST_STATE_GET_LOCK(elem))
 360 #define GST_STATE_UNLOCK_FULL(elem)            g_static_rec_mutex_unlock_full(GST_STATE_GET_LOCK(elem))
 361 #define GST_STATE_LOCK_FULL(elem,t)            g_static_rec_mutex_lock_full(GST_STATE_GET_LOCK(elem), t)
 362 #define GST_STATE_WAIT(elem)                   g_cond_wait (GST_STATE_GET_COND (elem), \
 363                                                         GST_OBJECT_GET_LOCK (elem))
 364 #define GST_STATE_TIMED_WAIT(elem, timeval)    g_cond_timed_wait (GST_STATE_GET_COND (elem), \
 365                                                         GST_OBJECT_GET_LOCK (elem), timeval)
 366 #define GST_STATE_SIGNAL(elem)                 g_cond_signal (GST_STATE_GET_COND (elem));
 367 #define GST_STATE_BROADCAST(elem)              g_cond_broadcast (GST_STATE_GET_COND (elem));
 368
 369 /**
 370  * GstElement:
 371  * @state_lock: Used to serialize execution of gst_element_set_state()
 372  * @state_cond: Used to signal completion of a state change
 373  * @state_cookie: Used to detect concurrent execution of
 374  * gst_element_set_state() and gst_element_get_state()
 375  * @current_state: the current state of an element
 376  * @next_state: the next state of an element, can be #GST_STATE_VOID_PENDING if
 377  * the element is in the correct state.
 378  * @pending_state: the final state the element should go to, can be
 379  * #GST_STATE_VOID_PENDING if the element is in the correct state
 380  * @last_return: the last return value of an element state change
 381  * @bus: the bus of the element. This bus is provided to the element by the
 382  * parent element or the application. A #GstPipeline has a bus of its own.
 383  * @clock: the clock of the element. This clock is usually provided by to the
 384  * element by the toplevel #GstPipeline.
 385  * @base_time: the time of the clock right before the element is set to
 386  * PLAYING. Subtracting @base_time from the current clock time in the PLAYING
 387  * state will yield the stream time.
 388  * @numpads: number of pads of the element, includes both source and sink pads.
 389  * @pads: list of pads
 390  * @numsrcpads: number of source pads of the element.
 391  * @srcpads: list of source pads
 392  * @numsinkpads: number of sink pads of the element.
 393  * @sinkpads: list of sink pads
 394  * @pads_cookie: updated whenever the a pad is added or removed
 395  *
 396  * GStreamer element abstract base class.
 397  */
 398 struct _GstElement
 399 {
 400   GstObject             object;
 401
 402   /*< public >*/ /* with LOCK */
 403   GStaticRecMutex      *state_lock;
 404
 405   /* element state */
 406   GCond                *state_cond;
 407   guint32               state_cookie;
 408   GstState              current_state;
 409   GstState              next_state;
 410   GstState              pending_state;
 411   GstStateChangeReturn  last_return;
 412
 413   GstBus               *bus;
 414
 415   /* allocated clock */
 416   GstClock             *clock;
 417   GstClockTimeDiff      base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
 418
 419   /* element pads, these lists can only be iterated while holding
 420    * the LOCK or checking the cookie after each LOCK. */
 421   guint16               numpads;
 422   GList                *pads;
 423   guint16               numsrcpads;
 424   GList                *srcpads;
 425   guint16               numsinkpads;
 426   GList                *sinkpads;
 427   guint32               pads_cookie;
 428
 429   /*< private >*/
 430   gpointer _gst_reserved[GST_PADDING];
 431 };
 432
 433 /**
 434  * GstElementClass:
 435  * @parent_class: the parent class structure
 436  * @details: #GstElementDetails for elements of this class
 437  * @elementfactory: the #GstElementFactory that creates these elements
 438  * @padtemplates: a #GList of #GstPadTemplate
 439  * @numpadtemplates: the number of padtemplates
 440  * @pad_templ_cookie: changed whenever the padtemplates change
 441  * @request_new_pad: called when a new pad is requested
 442  * @release_pad: called when a request pad is to be released
 443  * @get_state: get the state of the element
 444  * @set_state: set a new state on the element
 445  * @change_state: called by @set_state to perform an incremental state change
 446  * @set_bus: set a #GstBus on the element
 447  * @provide_clock: gets the #GstClock provided by the element
 448  * @set_clock: set the #GstClock on the element
 449  * @get_index: set a #GstIndex on the element
 450  * @set_index: get the #GstIndex of an element
 451  * @send_event: send a #GstEvent to the element
 452  * @get_query_types: get the supported #GstQueryType of this element
 453  * @query: perform a #GstQuery on the element
 454  *
 455  * GStreamer element class. Override the vmethods to implement the element
 456  * functionality.
 457  */
 458 struct _GstElementClass
 459 {
 460   GstObjectClass         parent_class;
 461
 462   /*< public >*/
 463   /* the element details */
 464   GstElementDetails      details;
 465
 466   /* factory that the element was created from */
 467   GstElementFactory     *elementfactory;
 468
 469   /* templates for our pads */
 470   GList                 *padtemplates;
 471   gint                   numpadtemplates;
 472   guint32                pad_templ_cookie;
 473
 474   /*< private >*/
 475   /* signal callbacks */
 476   void (*pad_added)     (GstElement *element, GstPad *pad);
 477   void (*pad_removed)   (GstElement *element, GstPad *pad);
 478   void (*no_more_pads)  (GstElement *element);
 479
 480   /*< public >*/
 481   /* virtual methods for subclasses */
 482
 483   /* request/release pads */
 484   GstPad*               (*request_new_pad)      (GstElement *element, GstPadTemplate *templ, const gchar* name);
 485   void                  (*release_pad)          (GstElement *element, GstPad *pad);
 486
 487   /* state changes */
 488   GstStateChangeReturn (*get_state)             (GstElement * element, GstState * state,
 489                                                  GstState * pending, GstClockTime timeout);
 490   GstStateChangeReturn (*set_state)             (GstElement *element, GstState state);
 491   GstStateChangeReturn (*change_state)          (GstElement *element, GstStateChange transition);
 492
 493   /* bus */
 494   void                  (*set_bus)              (GstElement * element, GstBus * bus);
 495
 496   /* set/get clocks */
 497   GstClock*             (*provide_clock)        (GstElement *element);
 498   gboolean              (*set_clock)            (GstElement *element, GstClock *clock);
 499
 500   /* index */
 501   GstIndex*             (*get_index)            (GstElement *element);
 502   void                  (*set_index)            (GstElement *element, GstIndex *index);
 503
 504   /* query functions */
 505   gboolean              (*send_event)           (GstElement *element, GstEvent *event);
 506
 507   const GstQueryType*   (*get_query_types)      (GstElement *element);
 508   gboolean              (*query)                (GstElement *element, GstQuery *query);
 509
 510   /*< private >*/
 511   gpointer _gst_reserved[GST_PADDING];
 512 };
 513
 514 /* element class pad templates */
 515 void                    gst_element_class_add_pad_template      (GstElementClass *klass, GstPadTemplate *templ);
 516 GstPadTemplate*         gst_element_class_get_pad_template      (GstElementClass *element_class, const gchar *name);
 517 GList*                  gst_element_class_get_pad_template_list (GstElementClass *element_class);
 518 void                    gst_element_class_set_details           (GstElementClass *klass,
 519                                                                  const GstElementDetails *details);
 520
 521 /* element instance */
 522 GType                   gst_element_get_type            (void);
 523
 524 /* basic name and parentage stuff from GstObject */
 525
 526 /**
 527  * gst_element_get_name:
 528  * @elem: a #GstElement to set the name of.
 529  *
 530  * Gets the name of the element.
 531  */
 532 #define                 gst_element_get_name(elem)      gst_object_get_name(GST_OBJECT_CAST(elem))
 533
 534 /**
 535  * gst_element_set_name:
 536  * @elem: a #GstElement to set the name of.
 537  * @name: the new name
 538  *
 539  * Sets the name of the element, getting rid of the old name if there was one.
 540  */
 541 #define                 gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT_CAST(elem),name)
 542
 543 /**
 544  * gst_element_get_parent:
 545  * @elem: a #GstElement to get the parent of.
 546  *
 547  * Gets the parent of an element.
 548  */
 549 #define                 gst_element_get_parent(elem)    gst_object_get_parent(GST_OBJECT_CAST(elem))
 550
 551 /**
 552  * gst_element_set_parent:
 553  * @elem: a #GstElement to set the parent of.
 554  * @parent: the new parent #GstObject of the element.
 555  *
 556  * Sets the parent of an element.
 557  */
 558 #define                 gst_element_set_parent(elem,parent)     gst_object_set_parent(GST_OBJECT_CAST(elem),parent)
 559
 560 /* clocking */
 561 gboolean                gst_element_requires_clock      (GstElement *element);
 562 gboolean                gst_element_provides_clock      (GstElement *element);
 563 GstClock*               gst_element_provide_clock       (GstElement *element);
 564 GstClock*               gst_element_get_clock           (GstElement *element);
 565 gboolean                gst_element_set_clock           (GstElement *element, GstClock *clock);
 566 void                    gst_element_set_base_time       (GstElement *element, GstClockTime time);
 567 GstClockTime            gst_element_get_base_time       (GstElement *element);
 568
 569 /* indexes */
 570 gboolean                gst_element_is_indexable        (GstElement *element);
 571 void                    gst_element_set_index           (GstElement *element, GstIndex *index);
 572 GstIndex*               gst_element_get_index           (GstElement *element);
 573
 574 /* bus */
 575 void                    gst_element_set_bus             (GstElement * element, GstBus * bus);
 576 GstBus *                gst_element_get_bus             (GstElement * element);
 577
 578 /* pad management */
 579 gboolean                gst_element_add_pad             (GstElement *element, GstPad *pad);
 580 gboolean                gst_element_remove_pad          (GstElement *element, GstPad *pad);
 581 void                    gst_element_no_more_pads        (GstElement *element);
 582
 583 GstPad*                 gst_element_get_pad             (GstElement *element, const gchar *name);
 584 GstPad*                 gst_element_get_static_pad      (GstElement *element, const gchar *name);
 585 GstPad*                 gst_element_get_request_pad     (GstElement *element, const gchar *name);
 586 void                    gst_element_release_request_pad (GstElement *element, GstPad *pad);
 587
 588 GstIterator *           gst_element_iterate_pads        (GstElement * element);
 589 GstIterator *           gst_element_iterate_src_pads    (GstElement * element);
 590 GstIterator *           gst_element_iterate_sink_pads   (GstElement * element);
 591
 592 /* event/query/format stuff */
 593 gboolean                gst_element_send_event          (GstElement *element, GstEvent *event);
 594 gboolean                gst_element_seek                (GstElement *element, gdouble rate,
 595                                                          GstFormat format, GstSeekFlags flags,
 596                                                          GstSeekType cur_type, gint64 cur,
 597                                                          GstSeekType stop_type, gint64 stop);
 598 G_CONST_RETURN GstQueryType*
 599                         gst_element_get_query_types     (GstElement *element);
 600 gboolean                gst_element_query               (GstElement *element, GstQuery *query);
 601
 602 /* messages */
 603 gboolean                gst_element_post_message        (GstElement * element, GstMessage * message);
 604
 605 /* error handling */
 606 /* gcc versions < 3.3 warn about NULL being passed as format to printf */
 607 #if (defined(GST_USING_PRINTF_EXTENSION) || !defined(__GNUC__) || (__GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 3))
 608 gchar *                 _gst_element_error_printf       (const gchar *format, ...);
 609 #else
 610 gchar *                 _gst_element_error_printf       (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
 611 #endif
 612 void                    gst_element_message_full        (GstElement * element, GstMessageType type,
 613                                                          GQuark domain, gint code, gchar * text,
 614                                                          gchar * debug, const gchar * file,
 615                                                          const gchar * function, gint line);
 616
 617 /* state management */
 618 gboolean                gst_element_is_locked_state     (GstElement *element);
 619 gboolean                gst_element_set_locked_state    (GstElement *element, gboolean locked_state);
 620 gboolean                gst_element_sync_state_with_parent (GstElement *element);
 621
 622 GstStateChangeReturn    gst_element_get_state           (GstElement * element,
 623                                                          GstState * state,
 624                                                          GstState * pending,
 625                                                          GstClockTime timeout);
 626 GstStateChangeReturn    gst_element_set_state           (GstElement *element, GstState state);
 627
 628 void                    gst_element_abort_state         (GstElement * element);
 629 GstStateChangeReturn    gst_element_continue_state      (GstElement * element,
 630                                                          GstStateChangeReturn ret);
 631 void                    gst_element_lost_state          (GstElement * element);
 632
 633 /* factory management */
 634 GstElementFactory*      gst_element_get_factory         (GstElement *element);
 635
 636 G_END_DECLS
 637
 638 #endif /* __GST_ELEMENT_H__ */