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