gstelement.h 33.2 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
/**
 * GstState:
34 35 36 37 38 39 40 41
 * @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, it is ready to accept and
 *                          process data. Sink elements however only accept one
 *                          buffer and then block.
 * @GST_STATE_PLAYING     : the element is PLAYING, the #GstClock is running and
 *                          the data is flowing.
Wim Taymans's avatar
Wim Taymans committed
42
 *
Mart Raudsepp's avatar
Mart Raudsepp committed
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().
Wim Taymans's avatar
Wim Taymans committed
45
 */
Wim Taymans's avatar
Wim Taymans committed
46
typedef enum {
47
  GST_STATE_VOID_PENDING        = 0,
48 49 50 51 52
  GST_STATE_NULL                = 1,
  GST_STATE_READY               = 2,
  GST_STATE_PAUSED              = 3,
  GST_STATE_PLAYING             = 4
} GstState;
Wim Taymans's avatar
Wim Taymans committed
53 54


55
#include <gst/gstconfig.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
56 57
#include <gst/gstobject.h>
#include <gst/gstpad.h>
Wim Taymans's avatar
Wim Taymans committed
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>
Wim Taymans's avatar
Wim Taymans committed
63
#include <gst/gstindex.h>
64
#include <gst/gstindexfactory.h>
65
#include <gst/gstiterator.h>
Wim Taymans's avatar
Wim Taymans committed
66
#include <gst/gstmessage.h>
67
#include <gst/gsttaglist.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
68

69 70
G_BEGIN_DECLS

Wim Taymans's avatar
Wim Taymans committed
71 72 73 74 75 76 77
#define GST_TYPE_ELEMENT                (gst_element_get_type ())
#define GST_IS_ELEMENT(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_ELEMENT))
#define GST_IS_ELEMENT_CLASS(klass)     (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_ELEMENT))
#define GST_ELEMENT_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_ELEMENT, GstElementClass))
#define GST_ELEMENT(obj)                (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_ELEMENT, GstElement))
#define GST_ELEMENT_CLASS(klass)        (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_ELEMENT, GstElementClass))
#define GST_ELEMENT_CAST(obj)           ((GstElement*)(obj))
78

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
79 80 81 82 83
/**
 * 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
84
 * @GST_STATE_CHANGE_NO_PREROLL: the state change succeeded but the element
85 86
 *                               cannot produce data in %GST_STATE_PAUSED.
 *                               This typically happens with live sources.
87
 *
88 89
 * 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
90
 */
Wim Taymans's avatar
Wim Taymans committed
91
typedef enum {
92 93 94 95 96
  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
97

98
/* NOTE: this probably should be done with an #ifdef to decide
99 100
 * whether to safe-cast or to just do the non-checking cast.
 */
101 102 103

/**
 * GST_STATE:
104
 * @elem: a #GstElement to return state for.
105
 *
106
 * This macro returns the current #GstState of the element.
107
 */
Wim Taymans's avatar
Wim Taymans committed
108
#define GST_STATE(elem)                 (GST_ELEMENT_CAST(elem)->current_state)
109

110 111
/**
 * GST_STATE_NEXT:
112
 * @elem: a #GstElement to return the next state for.
113
 *
114
 * This macro returns the next #GstState of the element.
115
 */
Wim Taymans's avatar
Wim Taymans committed
116
#define GST_STATE_NEXT(elem)            (GST_ELEMENT_CAST(elem)->next_state)
117

118 119
/**
 * GST_STATE_PENDING:
120
 * @elem: a #GstElement to return the pending state for.
121
 *
122
 * This macro returns the currently pending #GstState of the element.
123
 */
Wim Taymans's avatar
Wim Taymans committed
124
#define GST_STATE_PENDING(elem)         (GST_ELEMENT_CAST(elem)->pending_state)
125

126 127 128 129 130 131 132 133
/**
 * 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
 */
Wim Taymans's avatar
Wim Taymans committed
134
#define GST_STATE_TARGET(elem)          (GST_ELEMENT_CAST(elem)->abidata.ABI.target_state)
135

136 137
/**
 * GST_STATE_RETURN:
138
 * @elem: a #GstElement to return the last state result for.
139
 *
140
 * This macro returns the last #GstStateChangeReturn value.
141
 */
Wim Taymans's avatar
Wim Taymans committed
142
#define GST_STATE_RETURN(elem)          (GST_ELEMENT_CAST(elem)->last_return)
143

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

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
178 179
/**
 * GstStateChange:
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
 * @GST_STATE_CHANGE_NULL_TO_READY    : state change from NULL to READY.
 * <itemizedlist>
 *   <listitem><para>
 *     The element must check if the resources it needs are available. Device
 *     sinks and -sources typically try to probe the device to constrain their
 *     caps.
 *   </para></listitem>
 *   <listitem><para>
 *     The element opens the device (in case feature need to be probed).
 *   </para></listitem>
 * </itemizedlist>
 * @GST_STATE_CHANGE_READY_TO_PAUSED  : state change from READY to PAUSED.
 * <itemizedlist>
 *   <listitem><para>
 *     The element pads are activated in order to receive data in PAUSED.
 *     Streaming threads are started.
 *   </para></listitem>
 *   <listitem><para>
 *     Some elements might need to return ASYNC and complete the state change
 *     when they have enough information. It is a requirement for sinks to
 *     return ASYNC and complete the state change when they receive the first
 *     buffer or EOS event (preroll). Sinks also block the dataflow when in
 *     PAUSED.
 *   </para></listitem>
 *   <listitem><para>
 *     A pipeline resets the running_time to 0.
 *   </para></listitem>
 *   <listitem><para>
 *     Live sources return NO_PREROLL and don't generate data.
 *   </para></listitem>
 * </itemizedlist>
 * @GST_STATE_CHANGE_PAUSED_TO_PLAYING: state change from PAUSED to PLAYING.
 * <itemizedlist>
 *   <listitem><para>
 *     Most elements ignore this state change.
 *   </para></listitem>
 *   <listitem><para>
 *     The pipeline selects a clock and distributes this to all the children
 *     before setting them to PLAYING. This means that it is only alowed to
 *     synchronize on the clock in the PLAYING state.
 *   </para></listitem>
 *   <listitem><para>
 *     The pipeline uses the clock and the running_time to calculate the
 *     base_time. The base_time is distributed to all children when performing
 *     the state change.
 *   </para></listitem>
 *   <listitem><para>
 *     Sink elements stop blocking on the preroll buffer or event and start
 *     rendering the data.
 *   </para></listitem>
 *   <listitem><para>
 *     Sinks can post the EOS message in the PLAYING state. It is not allowed to
 *     post EOS when not in the PLAYING state.
 *   </para></listitem>
 *   <listitem><para>
 *     While streaming in PAUSED or PLAYING elements can create and remove
 *     sometimes pads.
 *   </para></listitem>
 *   <listitem><para>
 *     Live sources start generating data and return SUCCESS.
 *   </para></listitem>
 * </itemizedlist>
 * @GST_STATE_CHANGE_PLAYING_TO_PAUSED: state change from PLAYING to PAUSED.
 * <itemizedlist>
 *   <listitem><para>
 *     Most elements ignore this state change.
 *   </para></listitem>
 *   <listitem><para>
 *     The pipeline calculates the running_time based on the last selected clock
 *     and the base_time. It stores this information to continue playback when
 *     going back to the PLAYING state.
 *   </para></listitem>
 *   <listitem><para>
 *     Sinks unblock any clock wait calls.
 *   </para></listitem>
 *   <listitem><para>
 *     When a sink does not have a pending buffer to play, it returns ASYNC from
 *     this state change and completes the state change when it receives a new
 *     buffer or an EOS event.
 *   </para></listitem>
 *   <listitem><para>
 *     Any queued EOS messages are removed since they will be reposted when going
 *     back to the PLAYING state. The EOS messages are queued in GstBins.
 *   </para></listitem>
 *   <listitem><para>
 *     Live sources stop generating data and return NO_PREROLL.
 *   </para></listitem>
 * </itemizedlist>
 * @GST_STATE_CHANGE_PAUSED_TO_READY  : state change from PAUSED to READY.
 * <itemizedlist>
 *   <listitem><para>
 *     Sinks unblock any waits in the preroll.
 *   </para></listitem>
 *   <listitem><para>
 *     Elements unblock any waits on devices
 *   </para></listitem>
 *   <listitem><para>
 *     Chain or get_range functions return WRONG_STATE.
 *   </para></listitem>
 *   <listitem><para>
 *     The element pads are deactivated so that streaming becomes impossible and
 *     all streaming threads are stopped.
 *   </para></listitem>
 *   <listitem><para>
 *     The sink forgets all negotiated formats
 *   </para></listitem>
 *   <listitem><para>
 *     Elements remove all sometimes pads
 *   </para></listitem>
 * </itemizedlist>
 * @GST_STATE_CHANGE_READY_TO_NULL    : state change from READY to NULL.
 * <itemizedlist>
 *   <listitem><para>
 *     Elements close devices
 *   </para></listitem>
 *   <listitem><para>
 *     Elements reset any internal state.
 *   </para></listitem>
 * </itemizedlist>
 *
 * These are the different state changes an element goes through.
 * %GST_STATE_NULL &rArr; %GST_STATE_PLAYING is called an upwards state change
 * and %GST_STATE_PLAYING &rArr; %GST_STATE_NULL a downwards state change.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
303
 */
304
typedef enum /*< flags=0 >*/
305
{
Wim Taymans's avatar
Wim Taymans committed
306 307 308 309 310 311
  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
312
} GstStateChange;
313

314 315 316 317 318 319
/**
 * 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
Wim Taymans's avatar
Wim Taymans committed
320
 * @GST_ELEMENT_IS_SOURCE: the element is a source. Since 0.10.31
321 322 323 324
 * @GST_ELEMENT_FLAG_LAST: offset to define more flags
 *
 * The standard flags that an element may have.
 */
325 326
typedef enum
{
327 328 329
  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),
Wim Taymans's avatar
Wim Taymans committed
330
  GST_ELEMENT_IS_SOURCE         = (GST_OBJECT_FLAG_LAST << 3),
331 332
  /* padding */
  GST_ELEMENT_FLAG_LAST         = (GST_OBJECT_FLAG_LAST << 16)
333
} GstElementFlags;
334

335 336
/**
 * GST_ELEMENT_IS_LOCKED_STATE:
337
 * @elem: A #GstElement to query
338
 *
339
 * Check if the element is in the locked state and therefore will ignore state
340 341
 * changes from its parent object.
 */
342
#define GST_ELEMENT_IS_LOCKED_STATE(elem)        (GST_OBJECT_FLAG_IS_SET(elem,GST_ELEMENT_LOCKED_STATE))
343

344 345
/**
 * GST_ELEMENT_NAME:
346
 * @elem: A #GstElement to query
347 348 349 350
 *
 * Gets the name of this element. Use only in core as this is not
 * ABI-compatible. Others use gst_element_get_name()
 */
Wim Taymans's avatar
Wim Taymans committed
351
#define GST_ELEMENT_NAME(elem)                  (GST_OBJECT_NAME(elem))
352 353 354

/**
 * GST_ELEMENT_PARENT:
355
 * @elem: A #GstElement to query
356 357 358
 *
 * Get the parent object of this element.
 */
Wim Taymans's avatar
Wim Taymans committed
359
#define GST_ELEMENT_PARENT(elem)                (GST_ELEMENT_CAST(GST_OBJECT_PARENT(elem)))
360 361 362

/**
 * GST_ELEMENT_BUS:
363
 * @elem: A #GstElement to query
364 365 366
 *
 * Get the message bus of this element.
 */
Wim Taymans's avatar
Wim Taymans committed
367
#define GST_ELEMENT_BUS(elem)                   (GST_ELEMENT_CAST(elem)->bus)
368 369 370

/**
 * GST_ELEMENT_CLOCK:
371
 * @elem: A #GstElement to query
372 373 374
 *
 * Get the clock of this element
 */
Wim Taymans's avatar
Wim Taymans committed
375
#define GST_ELEMENT_CLOCK(elem)                 (GST_ELEMENT_CAST(elem)->clock)
376 377 378

/**
 * GST_ELEMENT_PADS:
379
 * @elem: A #GstElement to query
380 381 382
 *
 * Get the pads of this elements.
 */
Wim Taymans's avatar
Wim Taymans committed
383
#define GST_ELEMENT_PADS(elem)                  (GST_ELEMENT_CAST(elem)->pads)
384

385 386 387 388 389 390 391 392 393
/**
 * GST_ELEMENT_START_TIME:
 * @elem: a #GstElement to return the start time for.
 *
 * This macro returns the start_time of the @elem. The start_time is the
 * running_time of the pipeline when the element went to PAUSED.
 *
 * Since: 0.10.24
 */
Wim Taymans's avatar
Wim Taymans committed
394
#define GST_ELEMENT_START_TIME(elem)            (GST_ELEMENT_CAST(elem)->abidata.ABI.start_time)
395

396 397
/**
 * GST_ELEMENT_ERROR:
398
 * @el:     the element that generates the error
399 400
 * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
 * @code:   error code defined for that domain (see #gstreamer-GstGError)
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
401 402 403 404
 * @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)
405 406
 *
 * Utility function that elements can use in case they encountered a fatal
407
 * data processing error. The pipeline will post an error message and the
408 409
 * application will be requested to stop further media processing.
 */
Wim Taymans's avatar
Wim Taymans committed
410 411 412 413 414 415 416 417 418 419 420
#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)                                                            \
    GST_WARNING_OBJECT (el, "error: %s", __txt);                        \
  if (__dbg)                                                            \
    GST_WARNING_OBJECT (el, "error: %s", __dbg);                        \
  gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_ERROR,         \
    GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,        \
    __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);                    \
421
} G_STMT_END
422

423 424
/**
 * GST_ELEMENT_WARNING:
425
 * @el:     the element that generates the warning
426 427
 * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
 * @code:   error code defined for that domain (see #gstreamer-GstGError)
428 429 430 431 432 433
 * @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
434
 * data processing problem. The pipeline will post a warning message and the
435 436
 * application will be informed.
 */
Wim Taymans's avatar
Wim Taymans committed
437 438 439 440 441 442 443 444 445 446 447
#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)                                                            \
    GST_WARNING_OBJECT (el, "warning: %s", __txt);                      \
  if (__dbg)                                                            \
    GST_WARNING_OBJECT (el, "warning: %s", __dbg);                      \
  gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_WARNING,       \
    GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,        \
  __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);                      \
Wim Taymans's avatar
Wim Taymans committed
448
} G_STMT_END
Erik Walthinsen's avatar
Erik Walthinsen committed
449

450 451 452 453 454 455 456 457 458 459 460 461 462 463
/**
 * 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.
464 465
 *
 * Since: 0.10.12
466
 */
Wim Taymans's avatar
Wim Taymans committed
467 468 469 470 471 472 473 474 475 476 477
#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__);                      \
478 479
} G_STMT_END

480
/* the state change mutexes and conds */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
481
/**
482 483
 * GST_STATE_GET_LOCK:
 * @elem:   a #GstElement
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
484
 *
485 486
 * 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
487 488
 * the state, during state changes, and while finalizing.
 */
489 490 491
#define GST_STATE_GET_LOCK(elem)               (GST_ELEMENT_CAST(elem)->state_lock)
/**
 * GST_STATE_GET_COND:
492
 * @elem: a #GstElement
493 494 495 496 497
 *
 * Get the conditional used to signal the completion of a state change.
 */
#define GST_STATE_GET_COND(elem)               (GST_ELEMENT_CAST(elem)->state_cond)

498 499 500 501 502
#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)
503
#define GST_STATE_WAIT(elem)                   g_cond_wait (GST_STATE_GET_COND (elem), \
Wim Taymans's avatar
Wim Taymans committed
504
                                                        GST_OBJECT_GET_LOCK (elem))
505
#define GST_STATE_TIMED_WAIT(elem, timeval)    g_cond_timed_wait (GST_STATE_GET_COND (elem), \
Wim Taymans's avatar
Wim Taymans committed
506
                                                        GST_OBJECT_GET_LOCK (elem), timeval)
507 508 509
#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));

510 511 512 513
/**
 * GstElement:
 * @state_lock: Used to serialize execution of gst_element_set_state()
 * @state_cond: Used to signal completion of a state change
514 515
 * @state_cookie: Used to detect concurrent execution of
 * gst_element_set_state() and gst_element_get_state()
516
 * @current_state: the current state of an element
517 518 519 520
 * @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
521
 * @last_return: the last return value of an element state change
522 523
 * @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.
524
 * @clock: the clock of the element. This clock is usually provided to the
525 526 527
 * 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
528
 * state will yield the running_time against the clock.
529 530 531 532 533 534 535 536 537 538
 * @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
539
struct _GstElement
540
{
Wim Taymans's avatar
Wim Taymans committed
541
  GstObject             object;
Erik Walthinsen's avatar
Erik Walthinsen committed
542

543
  /*< public >*/ /* with LOCK */
544
  GStaticRecMutex      *state_lock;
545 546

  /* element state */
547
  GCond                *state_cond;
Wim Taymans's avatar
Wim Taymans committed
548
  guint32               state_cookie;
549 550 551 552 553
  GstState              current_state;
  GstState              next_state;
  GstState              pending_state;
  GstStateChangeReturn  last_return;

Wim Taymans's avatar
Wim Taymans committed
554
  GstBus               *bus;
Wim Taymans's avatar
Wim Taymans committed
555 556

  /* allocated clock */
Wim Taymans's avatar
Wim Taymans committed
557 558
  GstClock             *clock;
  GstClockTimeDiff      base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
559

560
  /* element pads, these lists can only be iterated while holding
561
   * the LOCK or checking the cookie after each LOCK. */
562 563 564 565 566 567 568 569 570
  guint16               numpads;
  GList                *pads;
  guint16               numsrcpads;
  GList                *srcpads;
  guint16               numsinkpads;
  GList                *sinkpads;
  guint32               pads_cookie;

  /*< private >*/
571 572 573 574
  union {
    struct {
      /* state set by application */
      GstState              target_state;
575 576
      /* running time of the last PAUSED state */
      GstClockTime          start_time;
577 578 579 580
    } 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
581 582
};

583 584 585 586 587 588
/**
 * 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
589
 * @numpadtemplates: the number of padtemplates
590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
 * @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.
 */
608 609
struct _GstElementClass
{
610
  GstObjectClass         parent_class;
Erik Walthinsen's avatar
Erik Walthinsen committed
611

612
  /*< public >*/
613
  /* the element details */
614
  /* FIXME-0.11: deprecate this in favour of meta_data */
Wim Taymans's avatar
Wim Taymans committed
615
  GstElementDetails      details;
616 617

  /* factory that the element was created from */
Wim Taymans's avatar
Wim Taymans committed
618
  GstElementFactory     *elementfactory;
619

620
  /* templates for our pads */
621 622 623
  GList                 *padtemplates;
  gint                   numpadtemplates;
  guint32                pad_templ_cookie;
624

625
  /*< private >*/
Erik Walthinsen's avatar
Erik Walthinsen committed
626
  /* signal callbacks */
Wim Taymans's avatar
Wim Taymans committed
627 628 629
  void (*pad_added)     (GstElement *element, GstPad *pad);
  void (*pad_removed)   (GstElement *element, GstPad *pad);
  void (*no_more_pads)  (GstElement *element);
630

631 632
  /*< public >*/
  /* virtual methods for subclasses */
633 634

  /* request/release pads */
Wim Taymans's avatar
Wim Taymans committed
635 636
  GstPad*               (*request_new_pad)      (GstElement *element, GstPadTemplate *templ, const gchar* name);
  void                  (*release_pad)          (GstElement *element, GstPad *pad);
637

638
  /* state changes */
Wim Taymans's avatar
Wim Taymans committed
639 640 641 642
  GstStateChangeReturn (*get_state)             (GstElement * element, GstState * state,
                                                 GstState * pending, GstClockTime timeout);
  GstStateChangeReturn (*set_state)             (GstElement *element, GstState state);
  GstStateChangeReturn (*change_state)          (GstElement *element, GstStateChange transition);
643

Wim Taymans's avatar
Wim Taymans committed
644
  /* bus */
Wim Taymans's avatar
Wim Taymans committed
645
  void                  (*set_bus)              (GstElement * element, GstBus * bus);
646

647
  /* set/get clocks */
Wim Taymans's avatar
Wim Taymans committed
648 649
  GstClock*             (*provide_clock)        (GstElement *element);
  gboolean              (*set_clock)            (GstElement *element, GstClock *clock);
650

Wim Taymans's avatar
Wim Taymans committed
651
  /* index */
Wim Taymans's avatar
Wim Taymans committed
652 653
  GstIndex*             (*get_index)            (GstElement *element);
  void                  (*set_index)            (GstElement *element, GstIndex *index);
Wim Taymans's avatar
Wim Taymans committed
654

655
  /* query functions */
Wim Taymans's avatar
Wim Taymans committed
656
  gboolean              (*send_event)           (GstElement *element, GstEvent *event);
657

Wim Taymans's avatar
Wim Taymans committed
658 659
  const GstQueryType*   (*get_query_types)      (GstElement *element);
  gboolean              (*query)                (GstElement *element, GstQuery *query);
Wim Taymans's avatar
Wim Taymans committed
660

661
  /*< private >*/
662 663 664 665
  /* FIXME-0.11: move up and replace details */
  gpointer		meta_data;

  gpointer _gst_reserved[GST_PADDING-1];
Erik Walthinsen's avatar
Erik Walthinsen committed
666 667
};

668
/* element class pad templates */
Wim Taymans's avatar
Wim Taymans committed
669 670 671
void                    gst_element_class_add_pad_template      (GstElementClass *klass, GstPadTemplate *templ);
GstPadTemplate*         gst_element_class_get_pad_template      (GstElementClass *element_class, const gchar *name);
GList*                  gst_element_class_get_pad_template_list (GstElementClass *element_class);
672 673 674 675

/* element class meta data */
void                    gst_element_class_set_documentation_uri (GstElementClass * klass, const gchar *uri);
void                    gst_element_class_set_icon_name         (GstElementClass * klass, const gchar *name);
Wim Taymans's avatar
Wim Taymans committed
676 677 678 679 680
void                    gst_element_class_set_details_simple    (GstElementClass *klass,
                                                                 const gchar     *longname,
                                                                 const gchar     *classification,
                                                                 const gchar     *description,
                                                                 const gchar     *author);
681

682
/* element instance */
Wim Taymans's avatar
Wim Taymans committed
683
GType                   gst_element_get_type            (void);
Erik Walthinsen's avatar
Erik Walthinsen committed
684

685
/* basic name and parentage stuff from GstObject */
686 687 688

/**
 * gst_element_get_name:
689 690 691 692 693 694 695 696
 * @elem: a #GstElement to get the name of @elem.
 *
 * Returns a copy of the name of @elem.
 * Caller should g_free() the return value after usage.
 * For a nameless element, this returns NULL, which you can safely g_free()
 * as well.
 *
 * Returns: the name of @elem. g_free() after usage. MT safe. 
697 698
 *
 */
Wim Taymans's avatar
Wim Taymans committed
699
#define                 gst_element_get_name(elem)      gst_object_get_name(GST_OBJECT_CAST(elem))
700 701 702 703

/**
 * gst_element_set_name:
 * @elem: a #GstElement to set the name of.
704
 * @name: the new name
705 706 707
 *
 * Sets the name of the element, getting rid of the old name if there was one.
 */
Wim Taymans's avatar
Wim Taymans committed
708
#define                 gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT_CAST(elem),name)
709 710 711 712 713 714 715

/**
 * gst_element_get_parent:
 * @elem: a #GstElement to get the parent of.
 *
 * Gets the parent of an element.
 */
Wim Taymans's avatar
Wim Taymans committed
716
#define                 gst_element_get_parent(elem)    gst_object_get_parent(GST_OBJECT_CAST(elem))
717 718 719 720

/**
 * gst_element_set_parent:
 * @elem: a #GstElement to set the parent of.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
721
 * @parent: the new parent #GstObject of the element.
722 723 724
 *
 * Sets the parent of an element.
 */
Wim Taymans's avatar
Wim Taymans committed
725
#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
726

727
/* clocking */
Wim Taymans's avatar
Wim Taymans committed
728 729 730 731 732 733 734 735 736
gboolean                gst_element_requires_clock      (GstElement *element);
gboolean                gst_element_provides_clock      (GstElement *element);
GstClock*               gst_element_provide_clock       (GstElement *element);
GstClock*               gst_element_get_clock           (GstElement *element);
gboolean                gst_element_set_clock           (GstElement *element, GstClock *clock);
void                    gst_element_set_base_time       (GstElement *element, GstClockTime time);
GstClockTime            gst_element_get_base_time       (GstElement *element);
void                    gst_element_set_start_time      (GstElement *element, GstClockTime time);
GstClockTime            gst_element_get_start_time      (GstElement *element);
737 738

/* indexes */
Wim Taymans's avatar
Wim Taymans committed
739 740 741
gboolean                gst_element_is_indexable        (GstElement *element);
void                    gst_element_set_index           (GstElement *element, GstIndex *index);
GstIndex*               gst_element_get_index           (GstElement *element);
742

Wim Taymans's avatar
Wim Taymans committed
743
/* bus */
Wim Taymans's avatar
Wim Taymans committed
744 745
void                    gst_element_set_bus             (GstElement * element, GstBus * bus);
GstBus *                gst_element_get_bus             (GstElement * element);
746

747
/* pad management */
Wim Taymans's avatar
Wim Taymans committed
748 749 750
gboolean                gst_element_add_pad             (GstElement *element, GstPad *pad);
gboolean                gst_element_remove_pad          (GstElement *element, GstPad *pad);
void                    gst_element_no_more_pads        (GstElement *element);
751

Wim Taymans's avatar
Wim Taymans committed
752 753 754
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);
755

Wim Taymans's avatar
Wim Taymans committed
756 757 758
GstIterator *           gst_element_iterate_pads        (GstElement * element);
GstIterator *           gst_element_iterate_src_pads    (GstElement * element);
GstIterator *           gst_element_iterate_sink_pads   (GstElement * element);
759

760
/* event/query/format stuff */
Wim Taymans's avatar
Wim Taymans committed
761 762 763 764 765
gboolean                gst_element_send_event          (GstElement *element, GstEvent *event);
gboolean                gst_element_seek                (GstElement *element, gdouble rate,
                                                         GstFormat format, GstSeekFlags flags,
                                                         GstSeekType cur_type, gint64 cur,
                                                         GstSeekType stop_type, gint64 stop);
766
G_CONST_RETURN GstQueryType*
Wim Taymans's avatar
Wim Taymans committed
767 768
                        gst_element_get_query_types     (GstElement *element);
gboolean                gst_element_query               (GstElement *element, GstQuery *query);
769

Wim Taymans's avatar
Wim Taymans committed
770
/* messages */
Wim Taymans's avatar
Wim Taymans committed
771
gboolean                gst_element_post_message        (GstElement * element, GstMessage * message);
Wim Taymans's avatar
Wim Taymans committed
772

773
/* error handling */
774 775
/* 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))
Wim Taymans's avatar
Wim Taymans committed
776
gchar *                 _gst_element_error_printf       (const gchar *format, ...);
777
#else
Wim Taymans's avatar
Wim Taymans committed
778
gchar *                 _gst_element_error_printf       (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
779
#endif
Wim Taymans's avatar
Wim Taymans committed
780 781 782 783
void                    gst_element_message_full        (GstElement * element, GstMessageType type,
                                                         GQuark domain, gint code, gchar * text,
                                                         gchar * debug, const gchar * file,
                                                         const gchar * function, gint line);
784 785

/* state management */
Wim Taymans's avatar
Wim Taymans committed
786 787 788
gboolean                gst_element_is_locked_state     (GstElement *element);
gboolean                gst_element_set_locked_state    (GstElement *element, gboolean locked_state);
gboolean                gst_element_sync_state_with_parent (GstElement *element);
789

Wim Taymans's avatar
Wim Taymans committed
790 791 792 793 794
GstStateChangeReturn    gst_element_get_state           (GstElement * element,
                                                         GstState * state,
                                                         GstState * pending,
                                                         GstClockTime timeout);
GstStateChangeReturn    gst_element_set_state           (GstElement *element, GstState state);
795

Wim Taymans's avatar
Wim Taymans committed
796
void                    gst_element_abort_state         (GstElement * element);
797
GstStateChangeReturn    gst_element_change_state        (GstElement * element,
Wim Taymans's avatar
Wim Taymans committed
798 799
                                                         GstStateChange transition);
GstStateChangeReturn    gst_element_continue_state      (GstElement * element,
800
                                                         GstStateChangeReturn ret);
Wim Taymans's avatar
Wim Taymans committed
801 802
void                    gst_element_lost_state          (GstElement * element);
void                    gst_element_lost_state_full     (GstElement * element, gboolean new_base_time);
Wim Taymans's avatar
Wim Taymans committed
803

804
/* factory management */
Wim Taymans's avatar
Wim Taymans committed
805
GstElementFactory*      gst_element_get_factory         (GstElement *element);
806

807
G_END_DECLS
808

809
#endif /* __GST_ELEMENT_H__ */