gstelement.h 33.8 KB
Newer Older
1 2
/* GStreamer
 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3
 *               2000,2004 Wim Taymans <wim@fluendo.com>
4 5
 *
 * gstelement.h: Header for GstElement
Erik Walthinsen's avatar
Erik Walthinsen committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */


#ifndef __GST_ELEMENT_H__
#define __GST_ELEMENT_H__

Wim Taymans's avatar
Wim Taymans committed
27 28 29 30
/* gstelement.h and gstelementfactory.h include eachother */
typedef struct _GstElement GstElement;
typedef struct _GstElementClass GstElementClass;

31
/* gstmessage.h needs State */
Wim Taymans's avatar
Wim Taymans committed
32 33
/**
 * 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>
Wim Taymans's avatar
Wim Taymans committed
67
#include <gst/gstquery.h>
68
#include <gst/gsttaglist.h>
Erik Walthinsen's avatar
Erik Walthinsen committed
69

70 71
G_BEGIN_DECLS

Wim Taymans's avatar
Wim Taymans committed
72 73 74 75 76 77 78
#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))
79

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
80 81 82 83 84
/**
 * 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
85
 * @GST_STATE_CHANGE_NO_PREROLL: the state change succeeded but the element
86 87
 *                               cannot produce data in %GST_STATE_PAUSED.
 *                               This typically happens with live sources.
88
 *
89 90
 * The possible return values from a state change function such as 
 * gst_element_set_state(). Only @GST_STATE_CHANGE_FAILURE is a real failure.
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
91
 */
Wim Taymans's avatar
Wim Taymans committed
92
typedef enum {
93 94 95 96 97
  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
98

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

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

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

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

127 128 129 130 131 132 133 134
/**
 * 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
 */
135
#define GST_STATE_TARGET(elem)          (GST_ELEMENT_CAST(elem)->target_state)
136

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

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

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
179 180
/**
 * GstStateChange:
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
 * @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>
199 200 201 202 203
 *     Some elements might need to return %GST_STATE_CHANGE_ASYNC and complete
 *     the state change when they have enough information. It is a requirement
 *     for sinks to return %GST_STATE_CHANGE_ASYNC and complete the state change
 *     when they receive the first buffer or %GST_EVENT_EOS (preroll).
 *     Sinks also block the dataflow when in PAUSED.
204 205 206 207 208
 *   </para></listitem>
 *   <listitem><para>
 *     A pipeline resets the running_time to 0.
 *   </para></listitem>
 *   <listitem><para>
209
 *     Live sources return %GST_STATE_CHANGE_NO_PREROLL and don't generate data.
210 211 212 213 214 215 216 217
 *   </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>
218
 *     The pipeline selects a #GstClock and distributes this to all the children
219
 *     before setting them to PLAYING. This means that it is only alowed to
220
 *     synchronize on the #GstClock in the PLAYING state.
221 222
 *   </para></listitem>
 *   <listitem><para>
223
 *     The pipeline uses the #GstClock and the running_time to calculate the
224 225 226 227 228 229 230 231
 *     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>
232 233
 *     Sinks can post %GST_MESSAGE_EOS in the PLAYING state. It is not allowed
 *     to post %GST_MESSAGE_EOS when not in the PLAYING state.
234 235 236 237 238 239
 *   </para></listitem>
 *   <listitem><para>
 *     While streaming in PAUSED or PLAYING elements can create and remove
 *     sometimes pads.
 *   </para></listitem>
 *   <listitem><para>
240
 *     Live sources start generating data and return %GST_STATE_CHANGE_SUCCESS.
241 242 243 244 245 246 247 248
 *   </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>
249 250 251
 *     The pipeline calculates the running_time based on the last selected
 *     #GstClock and the base_time. It stores this information to continue
 *     playback when going back to the PLAYING state.
252 253
 *   </para></listitem>
 *   <listitem><para>
254
 *     Sinks unblock any #GstClock wait calls.
255 256
 *   </para></listitem>
 *   <listitem><para>
257 258 259
 *     When a sink does not have a pending buffer to play, it returns 
 *     %GST_STATE_CHANGE_ASYNC from this state change and completes the state
 *     change when it receives a new buffer or an %GST_EVENT_EOS.
260 261
 *   </para></listitem>
 *   <listitem><para>
262 263 264
 *     Any queued %GST_MESSAGE_EOS items are removed since they will be reposted
 *     when going back to the PLAYING state. The EOS messages are queued in
 *     #GstBin containers.
265 266
 *   </para></listitem>
 *   <listitem><para>
267
 *     Live sources stop generating data and return %GST_STATE_CHANGE_NO_PREROLL.
268 269 270 271 272 273 274 275 276 277 278
 *   </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>
279
 *     Chain or get_range functions return %GST_FLOW_WRONG_STATE.
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
 *   </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
305
 */
306
typedef enum /*< flags=0 >*/
307
{
Wim Taymans's avatar
Wim Taymans committed
308 309 310 311 312 313
  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
314
} GstStateChange;
315

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

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

346 347
/**
 * GST_ELEMENT_NAME:
348
 * @elem: A #GstElement to query
349 350 351 352
 *
 * 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
353
#define GST_ELEMENT_NAME(elem)                  (GST_OBJECT_NAME(elem))
354 355 356

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

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

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

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

387 388 389 390 391 392 393 394 395
/**
 * 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
 */
396
#define GST_ELEMENT_START_TIME(elem)            (GST_ELEMENT_CAST(elem)->start_time)
397

398 399
/**
 * GST_ELEMENT_ERROR:
400
 * @el:     the element that generates the error
401 402
 * @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
403 404 405 406
 * @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)
407 408
 *
 * Utility function that elements can use in case they encountered a fatal
409
 * data processing error. The pipeline will post an error message and the
410 411
 * application will be requested to stop further media processing.
 */
Wim Taymans's avatar
Wim Taymans committed
412 413 414 415 416 417 418 419 420 421 422
#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__);                    \
423
} G_STMT_END
424

425 426
/**
 * GST_ELEMENT_WARNING:
427
 * @el:     the element that generates the warning
428 429
 * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
 * @code:   error code defined for that domain (see #gstreamer-GstGError)
430 431 432 433 434 435
 * @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
436
 * data processing problem. The pipeline will post a warning message and the
437 438
 * application will be informed.
 */
Wim Taymans's avatar
Wim Taymans committed
439 440 441 442 443 444 445 446 447 448 449
#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
450
} G_STMT_END
Erik Walthinsen's avatar
Erik Walthinsen committed
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.
464
 * The pipeline will post a info message and the
465
 * application will be informed.
466 467
 *
 * Since: 0.10.12
468
 */
Wim Taymans's avatar
Wim Taymans committed
469 470 471 472 473 474 475 476 477 478 479
#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__);                      \
480 481
} G_STMT_END

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

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

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

547
  /*< public >*/ /* with LOCK */
548
  GStaticRecMutex       state_lock;
549 550

  /* element state */
551
  GCond                *state_cond;
Wim Taymans's avatar
Wim Taymans committed
552
  guint32               state_cookie;
553
  GstState              target_state;
554 555 556 557 558
  GstState              current_state;
  GstState              next_state;
  GstState              pending_state;
  GstStateChangeReturn  last_return;

Wim Taymans's avatar
Wim Taymans committed
559
  GstBus               *bus;
Wim Taymans's avatar
Wim Taymans committed
560 561

  /* allocated clock */
Wim Taymans's avatar
Wim Taymans committed
562 563
  GstClock             *clock;
  GstClockTimeDiff      base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
564
  GstClockTime          start_time;
565

566
  /* element pads, these lists can only be iterated while holding
567
   * the LOCK or checking the cookie after each LOCK. */
568 569 570 571 572 573 574 575 576
  guint16               numpads;
  GList                *pads;
  guint16               numsrcpads;
  GList                *srcpads;
  guint16               numsinkpads;
  GList                *sinkpads;
  guint32               pads_cookie;

  /*< private >*/
577
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
578 579
};

580 581 582
/**
 * GstElementClass:
 * @parent_class: the parent class structure
583
 * @metadata: metadata for elements of this class
584 585
 * @elementfactory: the #GstElementFactory that creates these elements
 * @padtemplates: a #GList of #GstPadTemplate
586
 * @numpadtemplates: the number of padtemplates
587 588 589 590 591 592 593 594 595 596 597 598 599 600
 * @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
601
 * @state_changed: called immediately after a new state was set. Since: 0.10.35.
602 603 604 605
 *
 * GStreamer element class. Override the vmethods to implement the element
 * functionality.
 */
606 607
struct _GstElementClass
{
608
  GstObjectClass         parent_class;
Erik Walthinsen's avatar
Erik Walthinsen committed
609

610
  /*< public >*/
611 612
  /* the element metadata */
  gpointer		 metadata;
613 614

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

617
  /* templates for our pads */
618 619 620
  GList                 *padtemplates;
  gint                   numpadtemplates;
  guint32                pad_templ_cookie;
621

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

628 629
  /*< public >*/
  /* virtual methods for subclasses */
630 631

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

636
  /* state changes */
Wim Taymans's avatar
Wim Taymans committed
637 638 639 640
  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);
641 642
  void                 (*state_changed)         (GstElement *element, GstState oldstate,
                                                 GstState newstate, GstState pending);
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
  const GstQueryType*   (*get_query_types)      (GstElement *element);
659
  gboolean              (*query)                (GstElement *element, GstQuery *query);
Wim Taymans's avatar
Wim Taymans committed
660

661
  /*< private >*/
662
  gpointer _gst_reserved[GST_PADDING];
Erik Walthinsen's avatar
Erik Walthinsen committed
663 664
};

665
/* element class pad templates */
Wim Taymans's avatar
Wim Taymans committed
666 667 668
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);
669 670

/* element class meta data */
671
void                    gst_element_class_set_metadata          (GstElementClass *klass,
Wim Taymans's avatar
Wim Taymans committed
672 673 674 675
                                                                 const gchar     *longname,
                                                                 const gchar     *classification,
                                                                 const gchar     *description,
                                                                 const gchar     *author);
676 677
void                    gst_element_class_add_metadata          (GstElementClass * klass,
                                                                 const gchar * key, const gchar * value);
678 679
G_CONST_RETURN gchar *  gst_element_class_get_metadata          (GstElementClass * klass,
                                                                 const gchar * key);
680

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
 * @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.
 *
696
 * Returns: (transfer full): 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

/**
 * gst_element_get_parent:
 * @elem: a #GstElement to get the parent of.
 *
Stefan Kost's avatar
Stefan Kost committed
714 715
 * Get the parent of an element.
 *
716
 * Returns: (transfer full): the parent of an element.
717
 */
Wim Taymans's avatar
Wim Taymans committed
718
#define                 gst_element_get_parent(elem)    gst_object_get_parent(GST_OBJECT_CAST(elem))
719 720 721 722

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

729
/* clocking */
Wim Taymans's avatar
Wim Taymans committed
730 731 732 733 734 735 736 737 738
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);
739 740

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

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

749
/* pad management */
Wim Taymans's avatar
Wim Taymans committed
750 751 752
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);
753

Wim Taymans's avatar
Wim Taymans committed
754 755
GstPad*                 gst_element_get_static_pad      (GstElement *element, const gchar *name);
GstPad*                 gst_element_get_request_pad     (GstElement *element, const gchar *name);
756
GstPad*                 gst_element_request_pad         (GstElement *element, GstPadTemplate *templ,
757
							 const gchar * name, const GstCaps *caps);
Wim Taymans's avatar
Wim Taymans committed
758
void                    gst_element_release_request_pad (GstElement *element, GstPad *pad);
759

Wim Taymans's avatar
Wim Taymans committed
760 761 762
GstIterator *           gst_element_iterate_pads        (GstElement * element);
GstIterator *           gst_element_iterate_src_pads    (GstElement * element);
GstIterator *           gst_element_iterate_sink_pads   (GstElement * element);
763

764
/* event/query/format stuff */
Wim Taymans's avatar
Wim Taymans committed
765 766 767 768 769
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);
770
G_CONST_RETURN GstQueryType*
Wim Taymans's avatar
Wim Taymans committed
771
                        gst_element_get_query_types     (GstElement *element);
772
gboolean                gst_element_query               (GstElement *element, GstQuery *query);
773

Wim Taymans's avatar
Wim Taymans committed
774
/* messages */
Wim Taymans's avatar
Wim Taymans committed
775
gboolean                gst_element_post_message        (GstElement * element, GstMessage * message);
Wim Taymans's avatar
Wim Taymans committed
776

777
/* error handling */
778 779
/* 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
780
gchar *                 _gst_element_error_printf       (const gchar *format, ...);
781
#else
Wim Taymans's avatar
Wim Taymans committed
782
gchar *                 _gst_element_error_printf       (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
783
#endif
Wim Taymans's avatar
Wim Taymans committed
784 785 786 787
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);
788 789

/* state management */
Wim Taymans's avatar
Wim Taymans committed
790 791 792
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);
793

Wim Taymans's avatar
Wim Taymans committed
794 795 796 797 798
GstStateChangeReturn    gst_element_get_state           (GstElement * element,
                                                         GstState * state,
                                                         GstState * pending,
                                                         GstClockTime timeout);
GstStateChangeReturn    gst_element_set_state           (GstElement *element, GstState state);
799

Wim Taymans's avatar
Wim Taymans committed
800
void                    gst_element_abort_state         (GstElement * element);
801
GstStateChangeReturn    gst_element_change_state        (GstElement * element,
Wim Taymans's avatar
Wim Taymans committed
802 803
                                                         GstStateChange transition);
GstStateChangeReturn    gst_element_continue_state      (GstElement * element,
804
                                                         GstStateChangeReturn ret);
805
void                    gst_element_lost_state          (GstElement * element, gboolean new_base_time);
Wim Taymans's avatar
Wim Taymans committed
806

807
/* factory management */
Wim Taymans's avatar
Wim Taymans committed
808
GstElementFactory*      gst_element_get_factory         (GstElement *element);
809

810
G_END_DECLS
811

812
#endif /* __GST_ELEMENT_H__ */