Merge remote-tracking branch 'origin/0.10'
[platform/upstream/gstreamer.git] / gst / gstelement.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *               2000,2004 Wim Taymans <wim@fluendo.com>
4  *
5  * gstelement.h: Header for GstElement
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23
24 #ifndef __GST_ELEMENT_H__
25 #define __GST_ELEMENT_H__
26
27 /* gstelement.h and gstelementfactory.h include eachother */
28 typedef struct _GstElement GstElement;
29 typedef struct _GstElementClass GstElementClass;
30
31 /* gstmessage.h needs State */
32 /**
33  * GstState:
34  * @GST_STATE_VOID_PENDING: no pending state.
35  * @GST_STATE_NULL        : the NULL state or initial state of an element.
36  * @GST_STATE_READY       : the element is ready to go to PAUSED.
37  * @GST_STATE_PAUSED      : the element is PAUSED, 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  * Since: 0.10.13
132  */
133 #define GST_STATE_TARGET(elem)          (GST_ELEMENT_CAST(elem)->target_state)
134
135 /**
136  * GST_STATE_RETURN:
137  * @elem: a #GstElement to return the last state result for.
138  *
139  * This macro returns the last #GstStateChangeReturn value.
140  */
141 #define GST_STATE_RETURN(elem)          (GST_ELEMENT_CAST(elem)->last_return)
142
143 #define __GST_SIGN(val)                 ((val) < 0 ? -1 : ((val) > 0 ? 1 : 0))
144 /**
145  * GST_STATE_GET_NEXT:
146  * @cur: A starting #GstState
147  * @pending: A target #GstState
148  *
149  * Given a current state @cur and a target state @pending, calculate the next (intermediate)
150  * #GstState.
151  */
152 #define GST_STATE_GET_NEXT(cur,pending)         ((GstState)((cur) + __GST_SIGN ((gint)(pending) - (gint)(cur))))
153 /**
154  * GST_STATE_TRANSITION:
155  * @cur: A current state
156  * @next: A next state
157  *
158  * Given a current state @cur and a next state @next, calculate the associated
159  * #GstStateChange transition.
160  */
161 #define GST_STATE_TRANSITION(cur,next)          ((GstStateChange)(((cur)<<3)|(next)))
162 /**
163  * GST_STATE_TRANSITION_CURRENT:
164  * @trans: A #GstStateChange
165  *
166  * Given a state transition @trans, extract the current #GstState.
167  */
168 #define GST_STATE_TRANSITION_CURRENT(trans)     ((GstState)((trans)>>3))
169 /**
170  * GST_STATE_TRANSITION_NEXT:
171  * @trans: A #GstStateChange
172  *
173  * Given a state transition @trans, extract the next #GstState.
174  */
175 #define GST_STATE_TRANSITION_NEXT(trans)        ((GstState)((trans)&0x7))
176
177 /**
178  * GstStateChange:
179  * @GST_STATE_CHANGE_NULL_TO_READY    : state change from NULL to READY.
180  * <itemizedlist>
181  *   <listitem><para>
182  *     The element must check if the resources it needs are available. Device
183  *     sinks and -sources typically try to probe the device to constrain their
184  *     caps.
185  *   </para></listitem>
186  *   <listitem><para>
187  *     The element opens the device (in case feature need to be probed).
188  *   </para></listitem>
189  * </itemizedlist>
190  * @GST_STATE_CHANGE_READY_TO_PAUSED  : state change from READY to PAUSED.
191  * <itemizedlist>
192  *   <listitem><para>
193  *     The element pads are activated in order to receive data in PAUSED.
194  *     Streaming threads are started.
195  *   </para></listitem>
196  *   <listitem><para>
197  *     Some elements might need to return %GST_STATE_CHANGE_ASYNC and complete
198  *     the state change when they have enough information. It is a requirement
199  *     for sinks to return %GST_STATE_CHANGE_ASYNC and complete the state change
200  *     when they receive the first buffer or %GST_EVENT_EOS (preroll).
201  *     Sinks also block the dataflow when in PAUSED.
202  *   </para></listitem>
203  *   <listitem><para>
204  *     A pipeline resets the running_time to 0.
205  *   </para></listitem>
206  *   <listitem><para>
207  *     Live sources return %GST_STATE_CHANGE_NO_PREROLL and don't generate data.
208  *   </para></listitem>
209  * </itemizedlist>
210  * @GST_STATE_CHANGE_PAUSED_TO_PLAYING: state change from PAUSED to PLAYING.
211  * <itemizedlist>
212  *   <listitem><para>
213  *     Most elements ignore this state change.
214  *   </para></listitem>
215  *   <listitem><para>
216  *     The pipeline selects a #GstClock and distributes this to all the children
217  *     before setting them to PLAYING. This means that it is only alowed to
218  *     synchronize on the #GstClock in the PLAYING state.
219  *   </para></listitem>
220  *   <listitem><para>
221  *     The pipeline uses the #GstClock and the running_time to calculate the
222  *     base_time. The base_time is distributed to all children when performing
223  *     the state change.
224  *   </para></listitem>
225  *   <listitem><para>
226  *     Sink elements stop blocking on the preroll buffer or event and start
227  *     rendering the data.
228  *   </para></listitem>
229  *   <listitem><para>
230  *     Sinks can post %GST_MESSAGE_EOS in the PLAYING state. It is not allowed
231  *     to post %GST_MESSAGE_EOS when not in the PLAYING state.
232  *   </para></listitem>
233  *   <listitem><para>
234  *     While streaming in PAUSED or PLAYING elements can create and remove
235  *     sometimes pads.
236  *   </para></listitem>
237  *   <listitem><para>
238  *     Live sources start generating data and return %GST_STATE_CHANGE_SUCCESS.
239  *   </para></listitem>
240  * </itemizedlist>
241  * @GST_STATE_CHANGE_PLAYING_TO_PAUSED: state change from PLAYING to PAUSED.
242  * <itemizedlist>
243  *   <listitem><para>
244  *     Most elements ignore this state change.
245  *   </para></listitem>
246  *   <listitem><para>
247  *     The pipeline calculates the running_time based on the last selected
248  *     #GstClock and the base_time. It stores this information to continue
249  *     playback when going back to the PLAYING state.
250  *   </para></listitem>
251  *   <listitem><para>
252  *     Sinks unblock any #GstClock wait calls.
253  *   </para></listitem>
254  *   <listitem><para>
255  *     When a sink does not have a pending buffer to play, it returns
256  *     %GST_STATE_CHANGE_ASYNC from this state change and completes the state
257  *     change when it receives a new buffer or an %GST_EVENT_EOS.
258  *   </para></listitem>
259  *   <listitem><para>
260  *     Any queued %GST_MESSAGE_EOS items are removed since they will be reposted
261  *     when going back to the PLAYING state. The EOS messages are queued in
262  *     #GstBin containers.
263  *   </para></listitem>
264  *   <listitem><para>
265  *     Live sources stop generating data and return %GST_STATE_CHANGE_NO_PREROLL.
266  *   </para></listitem>
267  * </itemizedlist>
268  * @GST_STATE_CHANGE_PAUSED_TO_READY  : state change from PAUSED to READY.
269  * <itemizedlist>
270  *   <listitem><para>
271  *     Sinks unblock any waits in the preroll.
272  *   </para></listitem>
273  *   <listitem><para>
274  *     Elements unblock any waits on devices
275  *   </para></listitem>
276  *   <listitem><para>
277  *     Chain or get_range functions return %GST_FLOW_FLUSHING.
278  *   </para></listitem>
279  *   <listitem><para>
280  *     The element pads are deactivated so that streaming becomes impossible and
281  *     all streaming threads are stopped.
282  *   </para></listitem>
283  *   <listitem><para>
284  *     The sink forgets all negotiated formats
285  *   </para></listitem>
286  *   <listitem><para>
287  *     Elements remove all sometimes pads
288  *   </para></listitem>
289  * </itemizedlist>
290  * @GST_STATE_CHANGE_READY_TO_NULL    : state change from READY to NULL.
291  * <itemizedlist>
292  *   <listitem><para>
293  *     Elements close devices
294  *   </para></listitem>
295  *   <listitem><para>
296  *     Elements reset any internal state.
297  *   </para></listitem>
298  * </itemizedlist>
299  *
300  * These are the different state changes an element goes through.
301  * %GST_STATE_NULL &rArr; %GST_STATE_PLAYING is called an upwards state change
302  * and %GST_STATE_PLAYING &rArr; %GST_STATE_NULL a downwards state change.
303  */
304 typedef enum /*< flags=0 >*/
305 {
306   GST_STATE_CHANGE_NULL_TO_READY        = (GST_STATE_NULL<<3) | GST_STATE_READY,
307   GST_STATE_CHANGE_READY_TO_PAUSED      = (GST_STATE_READY<<3) | GST_STATE_PAUSED,
308   GST_STATE_CHANGE_PAUSED_TO_PLAYING    = (GST_STATE_PAUSED<<3) | GST_STATE_PLAYING,
309   GST_STATE_CHANGE_PLAYING_TO_PAUSED    = (GST_STATE_PLAYING<<3) | GST_STATE_PAUSED,
310   GST_STATE_CHANGE_PAUSED_TO_READY      = (GST_STATE_PAUSED<<3) | GST_STATE_READY,
311   GST_STATE_CHANGE_READY_TO_NULL        = (GST_STATE_READY<<3) | GST_STATE_NULL
312 } GstStateChange;
313
314 /**
315  * GstElementFlags:
316  * @GST_ELEMENT_FLAG_UNPARENTING: Child is being removed from the parent bin.
317  *  gst_bin_remove() on a child already being removed immediately returns FALSE
318  * @GST_ELEMENT_FLAG_LOCKED_STATE: ignore state changes from parent
319  * @GST_ELEMENT_FLAG_SINK: the element is a sink
320  * @GST_ELEMENT_FLAG_SOURCE: the element is a source. Since 0.10.31
321  * @GST_ELEMENT_FLAG_PROVIDE_CLOCK: the element can provide a clock
322  * @GST_ELEMENT_FLAG_REQUIRE_CLOCK: the element requires a clock
323  * @GST_ELEMENT_FLAG_INDEXABLE: the element can use an index
324  * @GST_ELEMENT_FLAG_LAST: offset to define more flags
325  *
326  * The standard flags that an element may have.
327  */
328 typedef enum
329 {
330   GST_ELEMENT_FLAG_UNPARENTING    = (GST_OBJECT_FLAG_LAST << 0),
331   GST_ELEMENT_FLAG_LOCKED_STATE   = (GST_OBJECT_FLAG_LAST << 1),
332   GST_ELEMENT_FLAG_SINK           = (GST_OBJECT_FLAG_LAST << 2),
333   GST_ELEMENT_FLAG_SOURCE         = (GST_OBJECT_FLAG_LAST << 3),
334   GST_ELEMENT_FLAG_PROVIDE_CLOCK  = (GST_OBJECT_FLAG_LAST << 4),
335   GST_ELEMENT_FLAG_REQUIRE_CLOCK  = (GST_OBJECT_FLAG_LAST << 5),
336   GST_ELEMENT_FLAG_INDEXABLE      = (GST_OBJECT_FLAG_LAST << 6),
337   /* padding */
338   GST_ELEMENT_FLAG_LAST           = (GST_OBJECT_FLAG_LAST << 10)
339 } GstElementFlags;
340
341 /**
342  * GST_ELEMENT_IS_LOCKED_STATE:
343  * @elem: A #GstElement to query
344  *
345  * Check if the element is in the locked state and therefore will ignore state
346  * changes from its parent object.
347  */
348 #define GST_ELEMENT_IS_LOCKED_STATE(elem)        (GST_OBJECT_FLAG_IS_SET(elem,GST_ELEMENT_FLAG_LOCKED_STATE))
349
350 /**
351  * GST_ELEMENT_NAME:
352  * @elem: A #GstElement to query
353  *
354  * Gets the name of this element. Use only in core as this is not
355  * ABI-compatible. Others use gst_element_get_name()
356  */
357 #define GST_ELEMENT_NAME(elem)                  (GST_OBJECT_NAME(elem))
358
359 /**
360  * GST_ELEMENT_PARENT:
361  * @elem: A #GstElement to query
362  *
363  * Get the parent object of this element.
364  */
365 #define GST_ELEMENT_PARENT(elem)                (GST_ELEMENT_CAST(GST_OBJECT_PARENT(elem)))
366
367 /**
368  * GST_ELEMENT_BUS:
369  * @elem: A #GstElement to query
370  *
371  * Get the message bus of this element.
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
380  */
381 #define GST_ELEMENT_CLOCK(elem)                 (GST_ELEMENT_CAST(elem)->clock)
382
383 /**
384  * GST_ELEMENT_PADS:
385  * @elem: A #GstElement to query
386  *
387  * Get the pads of this elements.
388  */
389 #define GST_ELEMENT_PADS(elem)                  (GST_ELEMENT_CAST(elem)->pads)
390
391 /**
392  * GST_ELEMENT_START_TIME:
393  * @elem: a #GstElement to return the start time for.
394  *
395  * This macro returns the start_time of the @elem. The start_time is the
396  * running_time of the pipeline when the element went to PAUSED.
397  *
398  * Since: 0.10.24
399  */
400 #define GST_ELEMENT_START_TIME(elem)            (GST_ELEMENT_CAST(elem)->start_time)
401
402 /**
403  * GST_ELEMENT_ERROR:
404  * @el:     the element that generates the error
405  * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
406  * @code:   error code defined for that domain (see #gstreamer-GstGError)
407  * @text:   the message to display (format string and args enclosed in
408             parentheses)
409  * @debug:  debugging information for the message (format string and args
410             enclosed in parentheses)
411  *
412  * Utility function that elements can use in case they encountered a fatal
413  * data processing error. The pipeline will post an error message and the
414  * application will be requested to stop further media processing.
415  */
416 #define GST_ELEMENT_ERROR(el, domain, code, text, debug)                \
417 G_STMT_START {                                                          \
418   gchar *__txt = _gst_element_error_printf text;                        \
419   gchar *__dbg = _gst_element_error_printf debug;                       \
420   if (__txt)                                                            \
421     GST_WARNING_OBJECT (el, "error: %s", __txt);                        \
422   if (__dbg)                                                            \
423     GST_WARNING_OBJECT (el, "error: %s", __dbg);                        \
424   gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_ERROR,         \
425     GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,        \
426     __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);                    \
427 } G_STMT_END
428
429 /**
430  * GST_ELEMENT_WARNING:
431  * @el:     the element that generates the warning
432  * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
433  * @code:   error code defined for that domain (see #gstreamer-GstGError)
434  * @text:   the message to display (format string and args enclosed in
435             parentheses)
436  * @debug:  debugging information for the message (format string and args
437             enclosed in parentheses)
438  *
439  * Utility function that elements can use in case they encountered a non-fatal
440  * data processing problem. The pipeline will post a warning message and the
441  * application will be informed.
442  */
443 #define GST_ELEMENT_WARNING(el, domain, code, text, debug)              \
444 G_STMT_START {                                                          \
445   gchar *__txt = _gst_element_error_printf text;                        \
446   gchar *__dbg = _gst_element_error_printf debug;                       \
447   if (__txt)                                                            \
448     GST_WARNING_OBJECT (el, "warning: %s", __txt);                      \
449   if (__dbg)                                                            \
450     GST_WARNING_OBJECT (el, "warning: %s", __dbg);                      \
451   gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_WARNING,       \
452     GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,        \
453   __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);                      \
454 } G_STMT_END
455
456 /**
457  * GST_ELEMENT_INFO:
458  * @el:     the element that generates the information
459  * @domain: like CORE, LIBRARY, RESOURCE or STREAM (see #gstreamer-GstGError)
460  * @code:   error code defined for that domain (see #gstreamer-GstGError)
461  * @text:   the message to display (format string and args enclosed in
462             parentheses)
463  * @debug:  debugging information for the message (format string and args
464             enclosed in parentheses)
465  *
466  * Utility function that elements can use in case they want to inform
467  * the application of something noteworthy that is not an error.
468  * The pipeline will post a info message and the
469  * application will be informed.
470  *
471  * Since: 0.10.12
472  */
473 #define GST_ELEMENT_INFO(el, domain, code, text, debug)                 \
474 G_STMT_START {                                                          \
475   gchar *__txt = _gst_element_error_printf text;                        \
476   gchar *__dbg = _gst_element_error_printf debug;                       \
477   if (__txt)                                                            \
478     GST_INFO_OBJECT (el, "info: %s", __txt);                            \
479   if (__dbg)                                                            \
480     GST_INFO_OBJECT (el, "info: %s", __dbg);                            \
481   gst_element_message_full (GST_ELEMENT(el), GST_MESSAGE_INFO,          \
482     GST_ ## domain ## _ERROR, GST_ ## domain ## _ERROR_ ## code,        \
483   __txt, __dbg, __FILE__, GST_FUNCTION, __LINE__);                      \
484 } G_STMT_END
485
486 /* the state change mutexes and conds */
487 /**
488  * GST_STATE_GET_LOCK:
489  * @elem:   a #GstElement
490  *
491  * Get a reference to the state lock of @elem.
492  * This lock is used by the core.  It is taken while getting or setting
493  * the state, during state changes, and while finalizing.
494  */
495 #define GST_STATE_GET_LOCK(elem)               (&(GST_ELEMENT_CAST(elem)->state_lock))
496 /**
497  * GST_STATE_GET_COND:
498  * @elem: a #GstElement
499  *
500  * Get the conditional used to signal the completion of a state change.
501  */
502 #define GST_STATE_GET_COND(elem)               (&GST_ELEMENT_CAST(elem)->state_cond)
503
504 #define GST_STATE_LOCK(elem)                   g_rec_mutex_lock(GST_STATE_GET_LOCK(elem))
505 #define GST_STATE_TRYLOCK(elem)                g_rec_mutex_trylock(GST_STATE_GET_LOCK(elem))
506 #define GST_STATE_UNLOCK(elem)                 g_rec_mutex_unlock(GST_STATE_GET_LOCK(elem))
507 #define GST_STATE_UNLOCK_FULL(elem)            g_rec_mutex_unlock_full(GST_STATE_GET_LOCK(elem))
508 #define GST_STATE_LOCK_FULL(elem,t)            g_rec_mutex_lock_full(GST_STATE_GET_LOCK(elem), t)
509 #define GST_STATE_WAIT(elem)                   g_cond_wait (GST_STATE_GET_COND (elem), \
510                                                         GST_OBJECT_GET_LOCK (elem))
511 #define GST_STATE_WAIT_UNTIL(elem, end_time)   g_cond_wait_until (GST_STATE_GET_COND (elem), \
512                                                         GST_OBJECT_GET_LOCK (elem), end_time)
513 #define GST_STATE_SIGNAL(elem)                 g_cond_signal (GST_STATE_GET_COND (elem));
514 #define GST_STATE_BROADCAST(elem)              g_cond_broadcast (GST_STATE_GET_COND (elem));
515
516 /**
517  * GstElement:
518  * @state_lock: Used to serialize execution of gst_element_set_state()
519  * @state_cond: Used to signal completion of a state change
520  * @state_cookie: Used to detect concurrent execution of
521  * gst_element_set_state() and gst_element_get_state()
522  * @target_state: the target state of an element as set by the application
523  * @current_state: the current state of an element
524  * @next_state: the next state of an element, can be #GST_STATE_VOID_PENDING if
525  * the element is in the correct state.
526  * @pending_state: the final state the element should go to, can be
527  * #GST_STATE_VOID_PENDING if the element is in the correct state
528  * @last_return: the last return value of an element state change
529  * @bus: the bus of the element. This bus is provided to the element by the
530  * parent element or the application. A #GstPipeline has a bus of its own.
531  * @clock: the clock of the element. This clock is usually provided to the
532  * element by the toplevel #GstPipeline.
533  * @base_time: the time of the clock right before the element is set to
534  * PLAYING. Subtracting @base_time from the current clock time in the PLAYING
535  * state will yield the running_time against the clock.
536  * @start_time: the running_time of the last PAUSED state
537  * @numpads: number of pads of the element, includes both source and sink pads.
538  * @pads: list of pads
539  * @numsrcpads: number of source pads of the element.
540  * @srcpads: list of source pads
541  * @numsinkpads: number of sink pads of the element.
542  * @sinkpads: list of sink pads
543  * @pads_cookie: updated whenever the a pad is added or removed
544  *
545  * GStreamer element abstract base class.
546  */
547 struct _GstElement
548 {
549   GstObject             object;
550
551   /*< public >*/ /* with LOCK */
552   GRecMutex             state_lock;
553
554   /* element state */
555   GCond                 state_cond;
556   guint32               state_cookie;
557   GstState              target_state;
558   GstState              current_state;
559   GstState              next_state;
560   GstState              pending_state;
561   GstStateChangeReturn  last_return;
562
563   GstBus               *bus;
564
565   /* allocated clock */
566   GstClock             *clock;
567   GstClockTimeDiff      base_time; /* NULL/READY: 0 - PAUSED: current time - PLAYING: difference to clock */
568   GstClockTime          start_time;
569
570   /* element pads, these lists can only be iterated while holding
571    * the LOCK or checking the cookie after each LOCK. */
572   guint16               numpads;
573   GList                *pads;
574   guint16               numsrcpads;
575   GList                *srcpads;
576   guint16               numsinkpads;
577   GList                *sinkpads;
578   guint32               pads_cookie;
579
580   /*< private >*/
581   gpointer _gst_reserved[GST_PADDING];
582 };
583
584 /**
585  * GstElementClass:
586  * @parent_class: the parent class structure
587  * @metadata: metadata for elements of this class
588  * @elementfactory: the #GstElementFactory that creates these elements
589  * @padtemplates: a #GList of #GstPadTemplate
590  * @numpadtemplates: the number of padtemplates
591  * @pad_templ_cookie: changed whenever the padtemplates change
592  * @request_new_pad: called when a new pad is requested
593  * @release_pad: called when a request pad is to be released
594  * @get_state: get the state of the element
595  * @set_state: set a new state on the element
596  * @change_state: called by @set_state to perform an incremental state change
597  * @set_bus: set a #GstBus on the element
598  * @provide_clock: gets the #GstClock provided by the element
599  * @set_clock: set the #GstClock on the element
600  * @send_event: send a #GstEvent to the element
601  * @query: perform a #GstQuery on the element
602  * @state_changed: called immediately after a new state was set.
603  *
604  * GStreamer element class. Override the vmethods to implement the element
605  * functionality.
606  */
607 struct _GstElementClass
608 {
609   GstObjectClass         parent_class;
610
611   /*< public >*/
612   /* the element metadata */
613   gpointer               metadata;
614
615   /* factory that the element was created from */
616   GstElementFactory     *elementfactory;
617
618   /* templates for our pads */
619   GList                 *padtemplates;
620   gint                   numpadtemplates;
621   guint32                pad_templ_cookie;
622
623   /*< private >*/
624   /* signal callbacks */
625   void (*pad_added)     (GstElement *element, GstPad *pad);
626   void (*pad_removed)   (GstElement *element, GstPad *pad);
627   void (*no_more_pads)  (GstElement *element);
628
629   /*< public >*/
630   /* virtual methods for subclasses */
631
632   /* request/release pads */
633   GstPad*               (*request_new_pad)      (GstElement *element, GstPadTemplate *templ,
634                                                  const gchar* name, const GstCaps *caps);
635   void                  (*release_pad)          (GstElement *element, GstPad *pad);
636
637   /* state changes */
638   GstStateChangeReturn (*get_state)             (GstElement * element, GstState * state,
639                                                  GstState * pending, GstClockTime timeout);
640   GstStateChangeReturn (*set_state)             (GstElement *element, GstState state);
641   GstStateChangeReturn (*change_state)          (GstElement *element, GstStateChange transition);
642   void                 (*state_changed)         (GstElement *element, GstState oldstate,
643                                                  GstState newstate, GstState pending);
644
645   /* bus */
646   void                  (*set_bus)              (GstElement * element, GstBus * bus);
647
648   /* set/get clocks */
649   GstClock*             (*provide_clock)        (GstElement *element);
650   gboolean              (*set_clock)            (GstElement *element, GstClock *clock);
651
652   /* query functions */
653   gboolean              (*send_event)           (GstElement *element, GstEvent *event);
654
655   gboolean              (*query)                (GstElement *element, GstQuery *query);
656
657   /*< private >*/
658   gpointer _gst_reserved[GST_PADDING_LARGE];
659 };
660
661 /* element class pad templates */
662 void                    gst_element_class_add_pad_template      (GstElementClass *klass, GstPadTemplate *templ);
663 GstPadTemplate*         gst_element_class_get_pad_template      (GstElementClass *element_class, const gchar *name);
664 GList*                  gst_element_class_get_pad_template_list (GstElementClass *element_class);
665
666 /* element class meta data */
667 void                    gst_element_class_set_metadata          (GstElementClass *klass,
668                                                                  const gchar     *longname,
669                                                                  const gchar     *classification,
670                                                                  const gchar     *description,
671                                                                  const gchar     *author);
672 void                    gst_element_class_add_metadata          (GstElementClass * klass,
673                                                                  const gchar * key, const gchar * value);
674 const gchar *           gst_element_class_get_metadata          (GstElementClass * klass,
675                                                                  const gchar * key);
676
677
678 /* element instance */
679 GType                   gst_element_get_type            (void);
680
681 /* basic name and parentage stuff from GstObject */
682
683 /**
684  * gst_element_get_name:
685  * @elem: a #GstElement to get the name of @elem.
686  *
687  * Returns a copy of the name of @elem.
688  * Caller should g_free() the return value after usage.
689  * For a nameless element, this returns NULL, which you can safely g_free()
690  * as well.
691  *
692  * Returns: (transfer full): the name of @elem. g_free() after usage. MT safe.
693  *
694  */
695 #define                 gst_element_get_name(elem)      gst_object_get_name(GST_OBJECT_CAST(elem))
696
697 /**
698  * gst_element_set_name:
699  * @elem: a #GstElement to set the name of.
700  * @name: the new name
701  *
702  * Sets the name of the element, getting rid of the old name if there was one.
703  */
704 #define                 gst_element_set_name(elem,name) gst_object_set_name(GST_OBJECT_CAST(elem),name)
705
706 /**
707  * gst_element_get_parent:
708  * @elem: a #GstElement to get the parent of.
709  *
710  * Get the parent of an element.
711  *
712  * Returns: (transfer full): the parent of an element.
713  */
714 #define                 gst_element_get_parent(elem)    gst_object_get_parent(GST_OBJECT_CAST(elem))
715
716 /**
717  * gst_element_set_parent:
718  * @elem: a #GstElement to set the parent of.
719  * @parent: the new parent #GstObject of the element.
720  *
721  * Sets the parent of an element.
722  */
723 #define                 gst_element_set_parent(elem,parent)     gst_object_set_parent(GST_OBJECT_CAST(elem),parent)
724
725 /* clocking */
726 GstClock*               gst_element_provide_clock       (GstElement *element);
727 GstClock*               gst_element_get_clock           (GstElement *element);
728 gboolean                gst_element_set_clock           (GstElement *element, GstClock *clock);
729 void                    gst_element_set_base_time       (GstElement *element, GstClockTime time);
730 GstClockTime            gst_element_get_base_time       (GstElement *element);
731 void                    gst_element_set_start_time      (GstElement *element, GstClockTime time);
732 GstClockTime            gst_element_get_start_time      (GstElement *element);
733
734 /* bus */
735 void                    gst_element_set_bus             (GstElement * element, GstBus * bus);
736 GstBus *                gst_element_get_bus             (GstElement * element);
737
738 /* pad management */
739 gboolean                gst_element_add_pad             (GstElement *element, GstPad *pad);
740 gboolean                gst_element_remove_pad          (GstElement *element, GstPad *pad);
741 void                    gst_element_no_more_pads        (GstElement *element);
742
743 GstPad*                 gst_element_get_static_pad      (GstElement *element, const gchar *name);
744 GstPad*                 gst_element_get_request_pad     (GstElement *element, const gchar *name);
745 GstPad*                 gst_element_request_pad         (GstElement *element, GstPadTemplate *templ,
746                                                          const gchar * name, const GstCaps *caps);
747 void                    gst_element_release_request_pad (GstElement *element, GstPad *pad);
748
749 GstIterator *           gst_element_iterate_pads        (GstElement * element);
750 GstIterator *           gst_element_iterate_src_pads    (GstElement * element);
751 GstIterator *           gst_element_iterate_sink_pads   (GstElement * element);
752
753 /* event/query/format stuff */
754 gboolean                gst_element_send_event          (GstElement *element, GstEvent *event);
755 gboolean                gst_element_seek                (GstElement *element, gdouble rate,
756                                                          GstFormat format, GstSeekFlags flags,
757                                                          GstSeekType cur_type, gint64 cur,
758                                                          GstSeekType stop_type, gint64 stop);
759 gboolean                gst_element_query               (GstElement *element, GstQuery *query);
760
761 /* messages */
762 gboolean                gst_element_post_message        (GstElement * element, GstMessage * message);
763
764 /* error handling */
765 /* gcc versions < 3.3 warn about NULL being passed as format to printf */
766 #if (defined(GST_USING_PRINTF_EXTENSION) || !defined(__GNUC__) || (__GNUC__ < 3) || (__GNUC__ == 3 && __GNUC_MINOR__ < 3))
767 gchar *                 _gst_element_error_printf       (const gchar *format, ...);
768 #else
769 gchar *                 _gst_element_error_printf       (const gchar *format, ...) G_GNUC_PRINTF (1, 2);
770 #endif
771 void                    gst_element_message_full        (GstElement * element, GstMessageType type,
772                                                          GQuark domain, gint code, gchar * text,
773                                                          gchar * debug, const gchar * file,
774                                                          const gchar * function, gint line);
775
776 /* state management */
777 gboolean                gst_element_is_locked_state     (GstElement *element);
778 gboolean                gst_element_set_locked_state    (GstElement *element, gboolean locked_state);
779 gboolean                gst_element_sync_state_with_parent (GstElement *element);
780
781 GstStateChangeReturn    gst_element_get_state           (GstElement * element,
782                                                          GstState * state,
783                                                          GstState * pending,
784                                                          GstClockTime timeout);
785 GstStateChangeReturn    gst_element_set_state           (GstElement *element, GstState state);
786
787 void                    gst_element_abort_state         (GstElement * element);
788 GstStateChangeReturn    gst_element_change_state        (GstElement * element,
789                                                          GstStateChange transition);
790 GstStateChangeReturn    gst_element_continue_state      (GstElement * element,
791                                                          GstStateChangeReturn ret);
792 void                    gst_element_lost_state          (GstElement * element);
793
794 /* factory management */
795 GstElementFactory*      gst_element_get_factory         (GstElement *element);
796
797 G_END_DECLS
798
799 #endif /* __GST_ELEMENT_H__ */