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., 51 Franklin St, Fifth Floor,
  20  * Boston, MA 02110-1301, 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, it is ready to accept and
  38  *                          process data. Sink elements however only accept one
  39  *                          buffer and then block.
  40  * @GST_STATE_PLAYING     : the element is PLAYING, the #GstClock is running and
  41  *                          the data is flowing.
  42  *
  43  * The possible states an element can be in. States can be changed using
  44  * gst_element_set_state() and checked using gst_element_get_state().
  45  */
  46 typedef enum {
  47   GST_STATE_VOID_PENDING        = 0,
  48   GST_STATE_NULL                = 1,
  49   GST_STATE_READY               = 2,
  50   GST_STATE_PAUSED              = 3,
  51   GST_STATE_PLAYING             = 4
  52 } GstState;
  53
  54
  55 #include <gst/gstconfig.h>
  56 #include <gst/gstobject.h>
  57 #include <gst/gstpad.h>
  58 #include <gst/gstbus.h>
  59 #include <gst/gstclock.h>
  60 #include <gst/gstelementfactory.h>
  61 #include <gst/gstplugin.h>
  62 #include <gst/gstpluginfeature.h>
  63 #include <gst/gstiterator.h>
  64 #include <gst/gstmessage.h>
  65 #include <gst/gstquery.h>
  66 #include <gst/gsttaglist.h>
  67
  68 G_BEGIN_DECLS
  69
  70 #define GST_TYPE_ELEMENT                (gst_element_get_type ())
  71 #define GST_IS_ELEMENT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
  72 #define GST_IS_ELEMENT_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
  73 #define GST_ELEMENT_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ELEMENT, GstElementClass))
  74 #define GST_ELEMENT(obj)                (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
  75 #define GST_ELEMENT_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
  76 #define GST_ELEMENT_CAST(obj)           ((GstElement*)(obj))
  77
  78 /**
  79  * GstStateChangeReturn:
  80  * @GST_STATE_CHANGE_FAILURE   : the state change failed
  81  * @GST_STATE_CHANGE_SUCCESS   : the state change succeeded
  82  * @GST_STATE_CHANGE_ASYNC     : the state change will happen asynchronously
  83  * @GST_STATE_CHANGE_NO_PREROLL: the state change succeeded but the element
  84  *                               cannot produce data in %GST_STATE_PAUSED.
  85  *                               This typically happens with live sources.
  86  *
  87  * The possible return values from a state change function such as
  88  * gst_element_set_state(). Only @GST_STATE_CHANGE_FAILURE is a real failure.
  89  */
  90 typedef enum {
  91   GST_STATE_CHANGE_FAILURE             = 0,
  92   GST_STATE_CHANGE_SUCCESS             = 1,
  93   GST_STATE_CHANGE_ASYNC               = 2,
  94   GST_STATE_CHANGE_NO_PREROLL          = 3
  95 } GstStateChangeReturn;
  96
  97 /* NOTE: this probably should be done with an #ifdef to decide
  98  * whether to safe-cast or to just do the non-checking cast.
  99  */
 100
 101 /**
 102  * GST_STATE:
 103  * @elem: a #GstElement to return state for.
 104  *
 105  * This macro returns the current #GstState of the element.
 106  */
 107 #define GST_STATE(elem)                 (GST_ELEMENT_CAST(elem)->current_state)
 108
 109 /**
 110  * GST_STATE_NEXT:
 111  * @elem: a #GstElement to return the next state for.
 112  *
 113  * This macro returns the next #GstState of the element.
 114  */
 115 #define GST_STATE_NEXT(elem)            (GST_ELEMENT_CAST(elem)->next_state)
 116
 117 /**
 118  * GST_STATE_PENDING:
 119  * @elem: a #GstElement to return the pending state for.
 120  *
 121  * This macro returns the currently pending #GstState of the element.
 122  */
 123 #define GST_STATE_PENDING(elem)         (GST_ELEMENT_CAST(elem)->pending_state)
 124
 125 /**
 126  * GST_STATE_TARGET:
 127  * @elem: a #GstElement to return the target state for.
 128  *
 129  * This macro returns the target #GstState of the element.
 130  */
 131 #define GST_STATE_TARGET(elem)          (GST_ELEMENT_CAST(elem)->target_state)
 132
 133 /**
 134  * GST_STATE_RETURN:
 135  * @elem: a #GstElement to return the last state result for.
 136  *
 137  * This macro returns the last #GstStateChangeReturn value.
 138  */
 139 #define GST_STATE_RETURN(elem)          (GST_ELEMENT_CAST(elem)->last_return)
 140
 141 #define __GST_SIGN(val)                 ((val) < 0 ? -1 : ((val) > 0 ? 1 : 0))
 142 /**
 143  * GST_STATE_GET_NEXT:
 144  * @cur: A starting #GstState
 145  * @pending: A target #GstState
 146  *
 147  * Given a current state @cur and a target state @pending, calculate the next (intermediate)
 148  * #GstState.
 149  */
 150 #define GST_STATE_GET_NEXT(cur,pending)         ((GstState)((cur) + __GST_SIGN ((gint)(pending) - (gint)(cur))))
 151 /**
 152  * GST_STATE_TRANSITION:
 153  * @cur: A current state
 154  * @next: A next state
 155  *
 156  * Given a current state @cur and a next state @next, calculate the associated
 157  * #GstStateChange transition.
 158  */
 159 #define GST_STATE_TRANSITION(cur,next)          ((GstStateChange)(((cur)<<3)|(next)))
 160 /**
 161  * GST_STATE_TRANSITION_CURRENT:
 162  * @trans: A #GstStateChange
 163  *
 164  * Given a state transition @trans, extract the current #GstState.
 165  */
 166 #define GST_STATE_TRANSITION_CURRENT(trans)     ((GstState)((trans)>>3))
 167 /**
 168  * GST_STATE_TRANSITION_NEXT:
 169  * @trans: A #GstStateChange
 170  *
 171  * Given a state transition @trans, extract the next #GstState.
 172  */
 173 #define GST_STATE_TRANSITION_NEXT(trans)        ((GstState)((trans)&0x7))
 174
 175 /**
 176  * GstStateChange:
 177  * @GST_STATE_CHANGE_NULL_TO_READY    : state change from NULL to READY.
 178  * <itemizedlist>
 179  *   <listitem><para>
 180  *     The element must check if the resources it needs are available. Device
 181  *     sinks and -sources typically try to probe the device to constrain their
 182  *     caps.
 183  *   </para></listitem>
 184  *   <listitem><para>
 185  *     The element opens the device (in case feature need to be probed).
 186  *   </para></listitem>
 187  * </itemizedlist>
 188  * @GST_STATE_CHANGE_READY_TO_PAUSED  : state change from READY to PAUSED.
 189  * <itemizedlist>
 190  *   <listitem><para>
 191  *     The element pads are activated in order to receive data in PAUSED.
 192  *     Streaming threads are started.
 193  *   </para></listitem>
 194  *   <listitem><para>
 195  *     Some elements might need to return %GST_STATE_CHANGE_ASYNC and complete
 196  *     the state change when they have enough information. It is a requirement
 197  *     for sinks to return %GST_STATE_CHANGE_ASYNC and complete the state change
 198  *     when they receive the first buffer or %GST_EVENT_EOS (preroll).
 199  *     Sinks also block the dataflow when in PAUSED.
 200  *   </para></listitem>
 201  *   <listitem><para>
 202  *     A pipeline resets the running_time to 0.
 203  *   </para></listitem>
 204  *   <listitem><para>
 205  *     Live sources return %GST_STATE_CHANGE_NO_PREROLL and don't generate data.
 206  *   </para></listitem>
 207  * </itemizedlist>
 208  * @GST_STATE_CHANGE_PAUSED_TO_PLAYING: state change from PAUSED to PLAYING.
 209  * <itemizedlist>
 210  *   <listitem><para>
 211  *     Most elements ignore this state change.
 212  *   </para></listitem>
 213  *   <listitem><para>
 214  *     The pipeline selects a #GstClock and distributes this to all the children
 215  *     before setting them to PLAYING. This means that it is only allowed to
 216  *     synchronize on the #GstClock in the PLAYING state.
 217  *   </para></listitem>
 218  *   <listitem><para>
 219  *     The pipeline uses the #GstClock and the running_time to calculate the
 220  *     base_time. The base_time is distributed to all children when performing
 221  *     the state change.
 222  *   </para></listitem>
 223  *   <listitem><para>
 224  *     Sink elements stop blocking on the preroll buffer or event and start
 225  *     rendering the data.
 226  *   </para></listitem>
 227  *   <listitem><para>
 228  *     Sinks can post %GST_MESSAGE_EOS in the PLAYING state. It is not allowed
 229  *     to post %GST_MESSAGE_EOS when not in the PLAYING state.
 230  *   </para></listitem>
 231  *   <listitem><para>
 232  *     While streaming in PAUSED or PLAYING elements can create and remove
 233  *     sometimes pads.
 234  *   </para></listitem>
 235  *   <listitem><para>
 236  *     Live sources start generating data and return %GST_STATE_CHANGE_SUCCESS.
 237  *   </para></listitem>
 238  * </itemizedlist>
 239  * @GST_STATE_CHANGE_PLAYING_TO_PAUSED: state change from PLAYING to PAUSED.
 240  * <itemizedlist>
 241  *   <listitem><para>
 242  *     Most elements ignore this state change.
 243  *   </para></listitem>
 244  *   <listitem><para>
 245  *     The pipeline calculates the running_time based on the last selected
 246  *     #GstClock and the base_time. It stores this information to continue
 247  *     playback when going back to the PLAYING state.
 248  *   </para></listitem>
 249  *   <listitem><para>
 250  *     Sinks unblock any #GstClock wait calls.
 251  *   </para></listitem>
 252  *   <listitem><para>
 253  *     When a sink does not have a pending buffer to play, it returns
 254  *     %GST_STATE_CHANGE_ASYNC from this state change and completes the state
 255  *     change when it receives a new buffer or an %GST_EVENT_EOS.
 256  *   </para></listitem>
 257  *   <listitem><para>
 258  *     Any queued %GST_MESSAGE_EOS items are removed since they will be reposted
 259  *     when going back to the PLAYING state. The EOS messages are queued in
 260  *     #GstBin containers.
 261  *   </para></listitem>
 262  *   <listitem><para>
 263  *     Live sources stop generating data and return %GST_STATE_CHANGE_NO_PREROLL.
 264  *   </para></listitem>
 265  * </itemizedlist>
 266  * @GST_STATE_CHANGE_PAUSED_TO_READY  : state change from PAUSED to READY.
 267  * <itemizedlist>
 268  *   <listitem><para>
 269  *     Sinks unblock any waits in the preroll.
 270  *   </para></listitem>
 271  *   <listitem><para>
 272  *     Elements unblock any waits on devices
 273  *   </para></listitem>
 274  *   <listitem><para>
 275  *     Chain or get_range functions return %GST_FLOW_FLUSHING.
 276  *   </para></listitem>
 277  *   <listitem><para>
 278  *     The element pads are deactivated so that streaming becomes impossible and
 279  *     all streaming threads are stopped.
 280  *   </para></listitem>
 281  *   <listitem><para>
 282  *     The sink forgets all negotiated formats
 283  *   </para></listitem>
 284  *   <listitem><para>
 285  *     Elements remove all sometimes pads
 286  *   </para></listitem>
 287  * </itemizedlist>
 288  * @GST_STATE_CHANGE_READY_TO_NULL    : state change from READY to NULL.
 289  * <itemizedlist>
 290  *   <listitem><para>
 291  *     Elements close devices
 292  *   </para></listitem>
 293  *   <listitem><para>
 294  *     Elements reset any internal state.
 295  *   </para></listitem>
 296  * </itemizedlist>
 297  *
 298  * These are the different state changes an element goes through.
 299  * %GST_STATE_NULL &rArr; %GST_STATE_PLAYING is called an upwards state change
 300  * and %GST_STATE_PLAYING &rArr; %GST_STATE_NULL a downwards state change.
 301  */
 302 typedef enum /*< flags=0 >*/
 303 {
 304   GST_STATE_CHANGE_NULL_TO_READY        = (GST_STATE_NULL<<3) | GST_STATE_READY,
 305   GST_STATE_CHANGE_READY_TO_PAUSED      = (GST_STATE_READY<<3) | GST_STATE_PAUSED,
 306   GST_STATE_CHANGE_PAUSED_TO_PLAYING    = (GST_STATE_PAUSED<<3) | GST_STATE_PLAYING,
 307   GST_STATE_CHANGE_PLAYING_TO_PAUSED    = (GST_STATE_PLAYING<<3) | GST_STATE_PAUSED,
 308   GST_STATE_CHANGE_PAUSED_TO_READY      = (GST_STATE_PAUSED<<3) | GST_STATE_READY,
 309   GST_STATE_CHANGE_READY_TO_NULL        = (GST_STATE_READY<<3) | GST_STATE_NULL
 310 } GstStateChange;
 311
 312 /**
 313  * GstElementFlags:
 314  * @GST_ELEMENT_FLAG_LOCKED_STATE: ignore state changes from parent
 315  * @GST_ELEMENT_FLAG_SINK: the element is a sink
 316  * @GST_ELEMENT_FLAG_SOURCE: the element is a source.
 317  * @GST_ELEMENT_FLAG_PROVIDE_CLOCK: the element can provide a clock
 318  * @GST_ELEMENT_FLAG_REQUIRE_CLOCK: the element requires a clock
 319  * @GST_ELEMENT_FLAG_INDEXABLE: the element can use an index
 320  * @GST_ELEMENT_FLAG_LAST: offset to define more flags
 321  *
 322  * The standard flags that an element may have.
 323  */
 324 typedef enum
 325 {
 326   GST_ELEMENT_FLAG_LOCKED_STATE   = (GST_OBJECT_FLAG_LAST << 0),
 327   GST_ELEMENT_FLAG_SINK           = (GST_OBJECT_FLAG_LAST << 1),
 328   GST_ELEMENT_FLAG_SOURCE         = (GST_OBJECT_FLAG_LAST << 2),
 329   GST_ELEMENT_FLAG_PROVIDE_CLOCK  = (GST_OBJECT_FLAG_LAST << 3),
 330   GST_ELEMENT_FLAG_REQUIRE_CLOCK  = (GST_OBJECT_FLAG_LAST << 4),
 331   GST_ELEMENT_FLAG_INDEXABLE      = (GST_OBJECT_FLAG_LAST << 5),
 332   /* padding */
 333   GST_ELEMENT_FLAG_LAST           = (GST_OBJECT_FLAG_LAST << 10)
 334 } GstElementFlags;
 335
 336 /**
 337  * GST_ELEMENT_IS_LOCKED_STATE:
 338  * @elem: A #GstElement to query
 339  *
 340  * Check if the element is in the locked state and therefore will ignore state
 341  * changes from its parent object.
 342  */
 343 #define GST_ELEMENT_IS_LOCKED_STATE(elem)        (GST_OBJECT_FLAG_IS_SET(elem,GST_ELEMENT_FLAG_LOCKED_STATE))
 344
 345 /**
 346  * GST_ELEMENT_NAME:
 347  * @elem: A #GstElement to query
 348  *
 349  * Gets the name of this element. This is not thread-safe by default
 350  * (i.e. you will have to make sure the object lock is taken yourself).
 351  * If in doubt use gst_element_get_name() instead.
 352  */
 353 #define GST_ELEMENT_NAME(elem)                  (GST_OBJECT_NAME(elem))
 354
 355 /**
 356  * GST_ELEMENT_PARENT:
 357  * @elem: A #GstElement to query
 358  *
 359  * Get the parent object of this element. This is not thread-safe by default
 360  * (i.e. you will have to make sure the object lock is taken yourself).
 361  * If in doubt use gst_object_get_parent() instead.
 362  */
 363 #define GST_ELEMENT_PARENT(elem)                (GST_ELEMENT_CAST(GST_OBJECT_PARENT(elem)))
 364
 365 /**
 366  * GST_ELEMENT_BUS:
 367  * @elem: A #GstElement to query
 368  *
 369  * Get the message bus of this element. This is not thread-safe by default
 370  * (i.e. you will have to make sure the object lock is taken yourself).
 371  * If in doubt use gst_element_get_bus() instead.
 372  */
 373 #define GST_ELEMENT_BUS(elem)                   (GST_ELEMENT_CAST(elem)->bus)
 374
 375 /**
 376  * GST_ELEMENT_CLOCK:
 377  * @elem: A #GstElement to query
 378  *
 379  * Get the clock of this element.This is not thread-safe by default
 380  * (i.e. you will have to make sure it is safe yourself).
 381  * If in doubt use gst_element_get_clock() instead.
 382  */
 383 #define GST_ELEMENT_CLOCK(elem)                 (GST_ELEMENT_CAST(elem)->clock)
 384
 385 /**
 386  * GST_ELEMENT_PADS:
 387  * @elem: A #GstElement to query
 388  *
 389  * Get the pads of this elements.
 390  */
 391 #define GST_ELEMENT_PADS(elem)                  (GST_ELEMENT_CAST(elem)->pads)
 392
 393 /**
 394  * GST_ELEMENT_START_TIME:
 395  * @elem: a #GstElement to return the start time for.
 396  *
 397  * This macro returns the start_time of the @elem. The start_time is the
 398  * running_time of the pipeline when the element went to PAUSED.
 399  */
 400 #define GST_ELEMENT_START_TIME(elem)            (GST_ELEMENT_CAST(elem)->start_time)
 401
 402 GstStructure *gst_element_message_details_new(const char *name, ...);
 403 #define GST_ELEMENT_MESSAGE_MAKE_DETAILS(args) gst_element_message_details_new args
 404
 405 /**
 406  * GST_ELEMENT_ERROR_WITH_DETAILS:
 407  * @el:     the element that generates the error
 408  * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
 409  * @code:   error code defined for that domain (see #gstreamer-GstGError)
 410  * @text:   the message to display (format string and args enclosed in
 411             parentheses)
 412  * @debug:  debugging information for the message (format string and args
 413             enclosed in parentheses)
 414  * @args    optional name, type, value triplets, which will be stored
 415  *          in the associated GstStructure. NULL terminator required.
 416  *          Must be enclosed within parentheses.
 417  *
 418  * Utility function that elements can use in case they encountered a fatal
 419  * data processing error. The pipeline will post an error message and the
 420  * application will be requested to stop further media processing.
 421  *
 422  * Since: 1.10
 423  */
 424 #define GST_ELEMENT_ERROR_WITH_DETAILS(el, domain, code, text, debug, args)  \
 425 G_STMT_START {                                                          \
 426   gchar *__txt = _gst_element_error_printf text;                        \
 427   gchar *__dbg = _gst_element_error_printf debug;                       \
 428   if (__txt)                                                            \
 429     GST_WARNING_OBJECT (el, "error: %s", __txt);                        \
 430   if (__dbg)                                                            \
 431     GST_WARNING_OBJECT (el, "error: %s", __dbg);                        \
 432   gst_element_message_full_with_details (GST_ELEMENT(el),               \
 433     GST_MESSAGE_ERROR, GST_ ## domain ## _ERROR,                        \
 434       GST_ ## domain ## _ERROR_ ## code, __txt, __dbg, __FILE__,        \
 435       GST_FUNCTION, __LINE__, GST_ELEMENT_MESSAGE_MAKE_DETAILS(args));  \
 436 } G_STMT_END
 437
 438 /**
 439  * GST_ELEMENT_ERROR:
 440  * @el:     the element that generates the error
 441  * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
 442  * @code:   error code defined for that domain (see #gstreamer-GstGError)
 443  * @text:   the message to display (format string and args enclosed in
 444             parentheses)
 445  * @debug:  debugging information for the message (format string and args
 446             enclosed in parentheses)
 447  *
 448  * Utility function that elements can use in case they encountered a fatal
 449  * data processing error. The pipeline will post an error message and the
 450  * application will be requested to stop further media processing.
 451  */
 452 #define GST_ELEMENT_ERROR(el, domain, code, text, debug)                \
 453   GST_ELEMENT_ERROR_WITH_DETAILS(el, domain, code, text, debug, (NULL))
 454
 455 /**
 456  * GST_ELEMENT_WARNING_WITH_DETAILS:
 457  * @el:     the element that generates the warning
 458  * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
 459  * @code:   error code defined for that domain (see #gstreamer-GstGError)
 460  * @text:   the message to display (format string and args enclosed in
 461             parentheses)
 462  * @debug:  debugging information for the message (format string and args
 463             enclosed in parentheses)
 464  * @args    optional name, type, value triplets, which will be stored
 465  *          in the associated GstStructure. NULL terminator required.
 466  *          Must be enclosed within parentheses.
 467  *
 468  * Utility function that elements can use in case they encountered a non-fatal
 469  * data processing problem. The pipeline will post a warning message and the
 470  * application will be informed.
 471  *
 472  * Since: 1.10
 473  */
 474 #define GST_ELEMENT_WARNING_WITH_DETAILS(el, domain, code, text, debug, args)\
 475 G_STMT_START {                                                          \
 476   gchar *__txt = _gst_element_error_printf text;                        \
 477   gchar *__dbg = _gst_element_error_printf debug;                       \
 478   if (__txt)                                                            \
 479     GST_WARNING_OBJECT (el, "warning: %s", __txt);                      \
 480   if (__dbg)                                                            \
 481     GST_WARNING_OBJECT (el, "warning: %s", __dbg);                      \
 482   gst_element_message_full_with_details (GST_ELEMENT(el),               \
 483     GST_MESSAGE_WARNING, GST_ ## domain ## _ERROR,                      \
 484     GST_ ## domain ## _ERROR_ ## code, __txt, __dbg, __FILE__,          \
 485     GST_FUNCTION, __LINE__, GST_ELEMENT_MESSAGE_MAKE_DETAILS(args));    \
 486 } G_STMT_END
 487
 488 /**
 489  * GST_ELEMENT_WARNING:
 490  * @el:     the element that generates the warning
 491  * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
 492  * @code:   error code defined for that domain (see #gstreamer-GstGError)
 493  * @text:   the message to display (format string and args enclosed in
 494             parentheses)
 495  * @debug:  debugging information for the message (format string and args
 496             enclosed in parentheses)
 497  *
 498  * Utility function that elements can use in case they encountered a non-fatal
 499  * data processing problem. The pipeline will post a warning message and the
 500  * application will be informed.
 501  */
 502 #define GST_ELEMENT_WARNING(el, domain, code, text, debug)              \
 503   GST_ELEMENT_WARNING_WITH_DETAILS(el, domain, code, text, debug, (NULL))
 504
 505 /**
 506  * GST_ELEMENT_INFO_WITH_DETAILS:
 507  * @el:     the element that generates the information
 508  * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
 509  * @code:   error code defined for that domain (see #gstreamer-GstGError)
 510  * @text:   the message to display (format string and args enclosed in
 511             parentheses)
 512  * @debug:  debugging information for the message (format string and args
 513             enclosed in parentheses)
 514  * @args    optional name, type, value triplets, which will be stored
 515  *          in the associated GstStructure. NULL terminator required.
 516  *          Must be enclosed within parentheses.
 517  *
 518  * Utility function that elements can use in case they want to inform
 519  * the application of something noteworthy that is not an error.
 520  * The pipeline will post a info message and the
 521  * application will be informed.
 522  * Optional name, type, value triplets may be supplied, and will be stored
 523  * in the associated GstStructure. NULL terminator required.
 524  *
 525  * Since: 1.10
 526  */
 527 #define GST_ELEMENT_INFO_WITH_DETAILS(el, domain, code, text, debug, args)   \
 528 G_STMT_START {                                                          \
 529   gchar *__txt = _gst_element_error_printf text;                        \
 530   gchar *__dbg = _gst_element_error_printf debug;                       \
 531   if (__txt)                                                            \
 532     GST_INFO_OBJECT (el, "info: %s", __txt);                            \
 533   if (__dbg)                                                            \
 534     GST_INFO_OBJECT (el, "info: %s", __dbg);                            \
 535   gst_element_message_full_with_details (GST_ELEMENT(el),               \
 536     GST_MESSAGE_INFO, GST_ ## domain ## _ERROR,                         \
 537     GST_ ## domain ## _ERROR_ ## code, __txt, __dbg, __FILE__,          \
 538     GST_FUNCTION, __LINE__, GST_ELEMENT_MESSAGE_MAKE_DETAILS(args));    \
 539 } G_STMT_END
 540
 541 /**
 542  * GST_ELEMENT_INFO:
 543  * @el:     the element that generates the information
 544  * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
 545  * @code:   error code defined for that domain (see #gstreamer-GstGError)
 546  * @text:   the message to display (format string and args enclosed in
 547             parentheses)
 548  * @debug:  debugging information for the message (format string and args
 549             enclosed in parentheses)
 550  *
 551  * Utility function that elements can use in case they want to inform
 552  * the application of something noteworthy that is not an error.
 553  * The pipeline will post a info message and the
 554  * application will be informed.
 555  */
 556 #define GST_ELEMENT_INFO(el, domain, code, text, debug)                 \
 557   GST_ELEMENT_INFO_WITH_DETAILS(el, domain, code, text, debug, (NULL))
 558
 559 /* the state change mutexes and conds */
 560 /**
 561  * GST_STATE_GET_LOCK:
 562  * @elem:   a #GstElement
 563  *
 564  * Get a reference to the state lock of @elem.
 565  * This lock is used by the core.  It is taken while getting or setting
 566  * the state, during state changes, and while finalizing.
 567  */
 568 #define GST_STATE_GET_LOCK(elem)               (&(GST_ELEMENT_CAST(elem)->state_lock))
 569 /**
 570  * GST_STATE_GET_COND:
 571  * @elem: a #GstElement
 572  *
 573  * Get the conditional used to signal the completion of a state change.
 574  */
 575 #define GST_STATE_GET_COND(elem)               (&GST_ELEMENT_CAST(elem)->state_cond)
 576
 577 #define GST_STATE_LOCK(elem)                   g_rec_mutex_lock(GST_STATE_GET_LOCK(elem))
 578 #define GST_STATE_TRYLOCK(elem)                g_rec_mutex_trylock(GST_STATE_GET_LOCK(elem))
 579 #define GST_STATE_UNLOCK(elem)                 g_rec_mutex_unlock(GST_STATE_GET_LOCK(elem))
 580 #define GST_STATE_WAIT(elem)                   g_cond_wait (GST_STATE_GET_COND (elem), \
 581                                                         GST_OBJECT_GET_LOCK (elem))
 582 #define GST_STATE_WAIT_UNTIL(elem, end_time)   g_cond_wait_until (GST_STATE_GET_COND (elem), \
 583                                                         GST_OBJECT_GET_LOCK (elem), end_time)
 584 #define GST_STATE_SIGNAL(elem)                 g_cond_signal (GST_STATE_GET_COND (elem));
 585 #define GST_STATE_BROADCAST(elem)              g_cond_broadcast (GST_STATE_GET_COND (elem));
 586
 587 /**
 588  * GstElement:
 589  * @state_lock: Used to serialize execution of gst_element_set_state()
 590  * @state_cond: Used to signal completion of a state change
 591  * @state_cookie: Used to detect concurrent execution of
 592  * gst_element_set_state() and gst_element_get_state()
 593  * @target_state: the target state of an element as set by the application
 594  * @current_state: the current state of an element
 595  * @next_state: the next state of an element, can be #GST_STATE_VOID_PENDING if
 596  * the element is in the correct state.
 597  * @pending_state: the final state the element should go to, can be
 598  * #GST_STATE_VOID_PENDING if the element is in the correct state
 599  * @last_return: the last return value of an element state change
 600  * @bus: the bus of the element. This bus is provided to the element by the
 601  * parent element or the application. A #GstPipeline has a bus of its own.
 602  * @clock: the clock of the element. This clock is usually provided to the
 603  * element by the toplevel #GstPipeline.
 604  * @base_time: the time of the clock right before the element is set to
 605  * PLAYING. Subtracting @base_time from the current clock time in the PLAYING
 606  * state will yield the running_time against the clock.
 607  * @start_time: the running_time of the last PAUSED state
 608  * @numpads: number of pads of the element, includes both source and sink pads.
 609  * @pads: (element-type Gst.Pad): list of pads
 610  * @numsrcpads: number of source pads of the element.
 611  * @srcpads: (element-type Gst.Pad): list of source pads
 612  * @numsinkpads: number of sink pads of the element.
 613  * @sinkpads: (element-type Gst.Pad): list of sink pads
 614  * @pads_cookie: updated whenever the a pad is added or removed
 615  *
 616  * GStreamer element abstract base class.
 617  */
 618 struct _GstElement
 619 {
 620   GstObject             object;
 621
 622   /*< public >*/ /* with LOCK */
 623   GRecMutex             state_lock;
 624
 625   /* element state */
 626   GCond                 state_cond;
 627   guint32               state_cookie;
 628   GstState              target_state;
 629   GstState              current_state;
 630   GstState              next_state;
 631   GstState              pending_state;
 632   GstStateChangeReturn  last_return;
 633
 634   GstBus               *bus;
 635
 636   /* allocated clock */
 637   GstClock             *clock;
 638   GstClockTimeDiff      base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
 639   GstClockTime          start_time;
 640
 641   /* element pads, these lists can only be iterated while holding
 642    * the LOCK or checking the cookie after each LOCK. */
 643   guint16               numpads;
 644   GList                *pads;
 645   guint16               numsrcpads;
 646   GList                *srcpads;
 647   guint16               numsinkpads;
 648   GList                *sinkpads;
 649   guint32               pads_cookie;
 650
 651   /* with object LOCK */
 652   GList                *contexts;
 653
 654   /*< private >*/
 655   gpointer _gst_reserved[GST_PADDING-1];
 656 };
 657
 658 /**
 659  * GstElementClass:
 660  * @parent_class: the parent class structure
 661  * @metadata: metadata for elements of this class
 662  * @elementfactory: the #GstElementFactory that creates these elements
 663  * @padtemplates: a #GList of #GstPadTemplate
 664  * @numpadtemplates: the number of padtemplates
 665  * @pad_templ_cookie: changed whenever the padtemplates change
 666  * @request_new_pad: called when a new pad is requested
 667  * @release_pad: called when a request pad is to be released
 668  * @get_state: get the state of the element
 669  * @set_state: set a new state on the element
 670  * @change_state: called by @set_state to perform an incremental state change
 671  * @set_bus: set a #GstBus on the element
 672  * @provide_clock: gets the #GstClock provided by the element
 673  * @set_clock: set the #GstClock on the element
 674  * @send_event: send a #GstEvent to the element
 675  * @query: perform a #GstQuery on the element
 676  * @state_changed: called immediately after a new state was set.
 677  * @post_message: called when a message is posted on the element. Chain up to
 678  *                the parent class' handler to have it posted on the bus.
 679  * @set_context: set a #GstContext on the element
 680  *
 681  * GStreamer element class. Override the vmethods to implement the element
 682  * functionality.
 683  */
 684 struct _GstElementClass
 685 {
 686   GstObjectClass         parent_class;
 687
 688   /*< public >*/
 689   /* the element metadata */
 690   gpointer               metadata;
 691
 692   /* factory that the element was created from */
 693   GstElementFactory     *elementfactory;
 694
 695   /* templates for our pads */
 696   GList                 *padtemplates;
 697   gint                   numpadtemplates;
 698   guint32                pad_templ_cookie;
 699
 700   /*< private >*/
 701   /* signal callbacks */
 702   void (*pad_added)     (GstElement *element, GstPad *pad);
 703   void (*pad_removed)   (GstElement *element, GstPad *pad);
 704   void (*no_more_pads)  (GstElement *element);
 705
 706   /*< public >*/
 707   /* virtual methods for subclasses */
 708
 709   /* request/release pads */
 710   /* FIXME 2.0 harmonize naming with gst_element_request_pad */
 711   GstPad*               (*request_new_pad)      (GstElement *element, GstPadTemplate *templ,
 712                                                  const gchar* name, const GstCaps *caps);
 713
 714   void                  (*release_pad)          (GstElement *element, GstPad *pad);
 715
 716   /* state changes */
 717   GstStateChangeReturn (*get_state)             (GstElement * element, GstState * state,
 718                                                  GstState * pending, GstClockTime timeout);
 719   GstStateChangeReturn (*set_state)             (GstElement *element, GstState state);
 720   GstStateChangeReturn (*change_state)          (GstElement *element, GstStateChange transition);
 721   void                 (*state_changed)         (GstElement *element, GstState oldstate,
 722                                                  GstState newstate, GstState pending);
 723
 724   /* bus */
 725   void                  (*set_bus)              (GstElement * element, GstBus * bus);
 726
 727   /* set/get clocks */
 728   GstClock*             (*provide_clock)        (GstElement *element);
 729   gboolean              (*set_clock)            (GstElement *element, GstClock *clock);
 730
 731   /* query functions */
 732   gboolean              (*send_event)           (GstElement *element, GstEvent *event);
 733
 734   gboolean              (*query)                (GstElement *element, GstQuery *query);
 735
 736   gboolean              (*post_message)         (GstElement *element, GstMessage *message);
 737
 738   void                  (*set_context)          (GstElement *element, GstContext *context);
 739
 740   /*< private >*/
 741   gpointer _gst_reserved[GST_PADDING_LARGE-2];
 742 };
 743
 744 /* element class pad templates */
 745 void                    gst_element_class_add_pad_template      (GstElementClass *klass, GstPadTemplate *templ);
 746
 747 void                    gst_element_class_add_static_pad_template (GstElementClass *klass, GstStaticPadTemplate *static_templ);
 748
 749 GstPadTemplate*         gst_element_class_get_pad_template      (GstElementClass *element_class, const gchar *name);
 750 GList*                  gst_element_class_get_pad_template_list (GstElementClass *element_class);
 751
 752 /* element class meta data */
 753 void                    gst_element_class_set_metadata          (GstElementClass *klass,
 754                                                                  const gchar     *longname,
 755                                                                  const gchar     *classification,
 756                                                                  const gchar     *description,
 757                                                                  const gchar     *author);
 758 void                    gst_element_class_set_static_metadata   (GstElementClass *klass,
 759                                                                  const gchar     *longname,
 760                                                                  const gchar     *classification,
 761                                                                  const gchar     *description,
 762                                                                  const gchar     *author);
 763 void                    gst_element_class_add_metadata          (GstElementClass * klass,
 764                                                                  const gchar * key, const gchar * value);
 765 void                    gst_element_class_add_static_metadata   (GstElementClass * klass,
 766                                                                  const gchar * key, const gchar * value);
 767 const gchar *           gst_element_class_get_metadata          (GstElementClass * klass,
 768                                                                  const gchar * key);
 769
 770
 771 /* element instance */
 772 GType                   gst_element_get_type            (void);
 773
 774 /* basic name and parentage stuff from GstObject */
 775
 776 /**
 777  * gst_element_get_name:
 778  * @elem: a #GstElement to get the name of @elem.
 779  *
 780  * Returns a copy of the name of @elem.
 781  * Caller should g_free() the return value after usage.
 782  * For a nameless element, this returns %NULL, which you can safely g_free()
 783  * as well.
 784  *
 785  * Returns: (transfer full) (nullable): the name of @elem. g_free()
 786  * after usage. MT safe.
 787  *
 788  */
 789 #define                 gst_element_get_name(elem)      gst_object_get_name(GST_OBJECT_CAST(elem))
 790
 791 /**
 792  * gst_element_set_name:
 793  * @elem: a #GstElement to set the name of.
 794  * @name: the new name
 795  *
 796  * Sets the name of the element, getting rid of the old name if there was one.
 797  */
 798 #define                 gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT_CAST(elem),name)
 799
 800 /**
 801  * gst_element_get_parent:
 802  * @elem: a #GstElement to get the parent of.
 803  *
 804  * Get the parent of an element.
 805  *
 806  * Returns: (transfer full): the parent of an element.
 807  */
 808 #define                 gst_element_get_parent(elem)    gst_object_get_parent(GST_OBJECT_CAST(elem))
 809
 810 /**
 811  * gst_element_set_parent:
 812  * @elem: a #GstElement to set the parent of.
 813  * @parent: the new parent #GstObject of the element.
 814  *
 815  * Sets the parent of an element.
 816  */
 817 #define                 gst_element_set_parent(elem,parent)     gst_object_set_parent(GST_OBJECT_CAST(elem),parent)
 818
 819 /* clocking */
 820 GstClock*               gst_element_provide_clock       (GstElement *element);
 821 GstClock*               gst_element_get_clock           (GstElement *element);
 822 gboolean                gst_element_set_clock           (GstElement *element, GstClock *clock);
 823 void                    gst_element_set_base_time       (GstElement *element, GstClockTime time);
 824 GstClockTime            gst_element_get_base_time       (GstElement *element);
 825 void                    gst_element_set_start_time      (GstElement *element, GstClockTime time);
 826 GstClockTime            gst_element_get_start_time      (GstElement *element);
 827
 828 /* bus */
 829 void                    gst_element_set_bus             (GstElement * element, GstBus * bus);
 830 GstBus *                gst_element_get_bus             (GstElement * element);
 831
 832 /* context */
 833 void                    gst_element_set_context         (GstElement * element, GstContext * context);
 834 GList *                 gst_element_get_contexts        (GstElement * element);
 835 GstContext *            gst_element_get_context         (GstElement * element, const gchar * context_type);
 836 GstContext *            gst_element_get_context_unlocked (GstElement * element, const gchar * context_type);
 837
 838 /* pad management */
 839 gboolean                gst_element_add_pad             (GstElement *element, GstPad *pad);
 840 gboolean                gst_element_remove_pad          (GstElement *element, GstPad *pad);
 841 void                    gst_element_no_more_pads        (GstElement *element);
 842
 843 GstPad*                 gst_element_get_static_pad      (GstElement *element, const gchar *name);
 844 GstPad*                 gst_element_get_request_pad     (GstElement *element, const gchar *name);
 845 GstPad*                 gst_element_request_pad         (GstElement *element, GstPadTemplate *templ,
 846                                                          const gchar * name, const GstCaps *caps);
 847 void                    gst_element_release_request_pad (GstElement *element, GstPad *pad);
 848
 849 GstIterator *           gst_element_iterate_pads        (GstElement * element);
 850 GstIterator *           gst_element_iterate_src_pads    (GstElement * element);
 851 GstIterator *           gst_element_iterate_sink_pads   (GstElement * element);
 852
 853 /* event/query/format stuff */
 854 gboolean                gst_element_send_event          (GstElement *element, GstEvent *event);
 855 gboolean                gst_element_seek                (GstElement *element, gdouble rate,
 856                                                          GstFormat format, GstSeekFlags flags,
 857                                                          GstSeekType start_type, gint64 start,
 858                                                          GstSeekType stop_type, gint64 stop);
 859 gboolean                gst_element_query               (GstElement *element, GstQuery *query);
 860
 861 /* messages */
 862 gboolean                gst_element_post_message        (GstElement * element, GstMessage * message);
 863
 864 /* error handling */
 865 /* gcc versions < 3.3 warn about NULL being passed as format to printf */
 866 #if (!defined(__GNUC__) || (__GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 3))
 867 gchar *                 _gst_element_error_printf       (const gchar *format, ...);
 868 #else
 869 gchar *                 _gst_element_error_printf       (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
 870 #endif
 871 void                    gst_element_message_full        (GstElement * element, GstMessageType type,
 872                                                          GQuark domain, gint code, gchar * text,
 873                                                          gchar * debug, const gchar * file,
 874                                                          const gchar * function, gint line);
 875
 876 void                    gst_element_message_full_with_details (GstElement * element, GstMessageType type,
 877                                                          GQuark domain, gint code, gchar * text,
 878                                                          gchar * debug, const gchar * file,
 879                                                          const gchar * function, gint line,
 880                                                          GstStructure * structure);
 881
 882 /* state management */
 883 gboolean                gst_element_is_locked_state     (GstElement *element);
 884 gboolean                gst_element_set_locked_state    (GstElement *element, gboolean locked_state);
 885 gboolean                gst_element_sync_state_with_parent (GstElement *element);
 886
 887 GstStateChangeReturn    gst_element_get_state           (GstElement * element,
 888                                                          GstState * state,
 889                                                          GstState * pending,
 890                                                          GstClockTime timeout);
 891 GstStateChangeReturn    gst_element_set_state           (GstElement *element, GstState state);
 892
 893 void                    gst_element_abort_state         (GstElement * element);
 894 GstStateChangeReturn    gst_element_change_state        (GstElement * element,
 895                                                          GstStateChange transition);
 896 GstStateChangeReturn    gst_element_continue_state      (GstElement * element,
 897                                                          GstStateChangeReturn ret);
 898 void                    gst_element_lost_state          (GstElement * element);
 899
 900 typedef void          (*GstElementCallAsyncFunc)        (GstElement * element,
 901                                                          gpointer     user_data);
 902
 903 void                    gst_element_call_async          (GstElement * element,
 904                                                          GstElementCallAsyncFunc func, gpointer user_data,
 905                                                          GDestroyNotify destroy_notify);
 906
 907 /* factory management */
 908 GstElementFactory*      gst_element_get_factory         (GstElement *element);
 909
 910 /* utility functions */
 911 gulong                  gst_element_add_property_notify_watch (GstElement  * element,
 912                                                                const gchar * property_name,
 913                                                                gboolean      include_value);
 914
 915 gulong                  gst_element_add_property_deep_notify_watch (GstElement  * element,
 916                                                                     const gchar * property_name,
 917                                                                     gboolean      include_value);
 918
 919 void                    gst_element_remove_property_notify_watch (GstElement * element,
 920                                                                   gulong       watch_id);
 921
 922 #ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
 923 G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstElement, gst_object_unref)
 924 #endif
 925
 926 G_END_DECLS
 927
 928 #endif /* __GST_ELEMENT_H__ */