pad: add enums for custom flow return success and error codes
[platform/upstream/gstreamer.git] / gst / gstpad.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wim.taymans@chello.be>
4  *
5  * gstpad.h: Header for GstPad object
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_PAD_H__
25 #define __GST_PAD_H__
26
27 #include <gst/gstconfig.h>
28
29 #include <gst/gstobject.h>
30 #include <gst/gstbuffer.h>
31 #include <gst/gstbufferlist.h>
32 #include <gst/gstcaps.h>
33 #include <gst/gstevent.h>
34 #include <gst/gstquery.h>
35 #include <gst/gsttask.h>
36
37 G_BEGIN_DECLS
38
39 /*
40  * Pad base class
41  */
42 #define GST_TYPE_PAD                    (gst_pad_get_type ())
43 #define GST_IS_PAD(obj)                 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD))
44 #define GST_IS_PAD_CLASS(klass)         (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
45 #define GST_PAD(obj)                    (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD, GstPad))
46 #define GST_PAD_CLASS(klass)            (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD, GstPadClass))
47 #define GST_PAD_CAST(obj)               ((GstPad*)(obj))
48
49
50 typedef struct _GstPad GstPad;
51 typedef struct _GstPadPrivate GstPadPrivate;
52 typedef struct _GstPadClass GstPadClass;
53
54 /**
55  * GstPadLinkReturn:
56  * @GST_PAD_LINK_OK             : link succeeded
57  * @GST_PAD_LINK_WRONG_HIERARCHY: pads have no common grandparent
58  * @GST_PAD_LINK_WAS_LINKED     : pad was already linked
59  * @GST_PAD_LINK_WRONG_DIRECTION: pads have wrong direction
60  * @GST_PAD_LINK_NOFORMAT       : pads do not have common format
61  * @GST_PAD_LINK_NOSCHED        : pads cannot cooperate in scheduling
62  * @GST_PAD_LINK_REFUSED        : refused for some reason
63  *
64  * Result values from gst_pad_link and friends.
65  */
66 typedef enum {
67   GST_PAD_LINK_OK               =  0,
68   GST_PAD_LINK_WRONG_HIERARCHY  = -1,
69   GST_PAD_LINK_WAS_LINKED       = -2,
70   GST_PAD_LINK_WRONG_DIRECTION  = -3,
71   GST_PAD_LINK_NOFORMAT         = -4,
72   GST_PAD_LINK_NOSCHED          = -5,
73   GST_PAD_LINK_REFUSED          = -6
74 } GstPadLinkReturn;
75
76 /**
77  * GST_PAD_LINK_FAILED:
78  * @ret: the #GstPadLinkReturn value
79  *
80  * Macro to test if the given #GstPadLinkReturn value indicates a failed
81  * link step.
82  */
83 #define GST_PAD_LINK_FAILED(ret) ((ret) < GST_PAD_LINK_OK)
84
85 /**
86  * GST_PAD_LINK_SUCCESSFUL:
87  * @ret: the #GstPadLinkReturn value
88  *
89  * Macro to test if the given #GstPadLinkReturn value indicates a successful
90  * link step.
91  */
92 #define GST_PAD_LINK_SUCCESSFUL(ret) ((ret) >= GST_PAD_LINK_OK)
93
94 /**
95  * GstFlowReturn:
96  * @GST_FLOW_RESEND:             Resend buffer, possibly with new caps (not
97  *                                 sent yet) (unused/unimplemented).
98  * @GST_FLOW_OK:                 Data passing was ok.
99  * @GST_FLOW_NOT_LINKED:         Pad is not linked.
100  * @GST_FLOW_WRONG_STATE:        Pad is in wrong state.
101  * @GST_FLOW_UNEXPECTED:         Did not expect anything, like after EOS.
102  * @GST_FLOW_NOT_NEGOTIATED:     Pad is not negotiated.
103  * @GST_FLOW_ERROR:              Some (fatal) error occured. Element generating
104  *                               this error should post an error message with more
105  *                               details.
106  * @GST_FLOW_NOT_SUPPORTED:      This operation is not supported.
107  * @GST_FLOW_CUSTOM_SUCCESS:     Elements can use values starting from
108  *                               this (and higher) to define custom success
109  *                               codes. Since 0.10.7.
110  * @GST_FLOW_CUSTOM_SUCCESS_1:   Pre-defined custom success code (define your
111  *                               custom success code to this to avoid compiler
112  *                               warnings). Since 0.10.29.
113  * @GST_FLOW_CUSTOM_SUCCESS_2:   Pre-defined custom success code. Since 0.10.29.
114  * @GST_FLOW_CUSTOM_ERROR:       Elements can use values starting from
115  *                               this (and lower) to define custom error codes.
116  *                               Since 0.10.7.
117  * @GST_FLOW_CUSTOM_ERROR_1:     Pre-defined custom error code (define your
118  *                               custom error code to this to avoid compiler
119  *                               warnings). Since 0.10.29.
120  * @GST_FLOW_CUSTOM_ERROR_2:     Pre-defined custom error code. Since 0.10.29.
121  *
122  * The result of passing data to a pad.
123  *
124  * Note that the custom return values should not be exposed outside of the
125  * element scope and are available since 0.10.7.
126  */
127 /* FIXME 0.11: remove custom flow returns */
128 typedef enum {
129   /* custom success starts here */
130   GST_FLOW_CUSTOM_SUCCESS_2 = 102,
131   GST_FLOW_CUSTOM_SUCCESS_1 = 101,
132   GST_FLOW_CUSTOM_SUCCESS = 100,
133
134   /* core predefined */
135   GST_FLOW_RESEND         =  1,
136   GST_FLOW_OK             =  0,
137   /* expected failures */
138   GST_FLOW_NOT_LINKED     = -1,
139   GST_FLOW_WRONG_STATE    = -2,
140   /* error cases */
141   GST_FLOW_UNEXPECTED     = -3,
142   GST_FLOW_NOT_NEGOTIATED = -4,
143   GST_FLOW_ERROR          = -5,
144   GST_FLOW_NOT_SUPPORTED  = -6,
145
146   /* custom error starts here */
147   GST_FLOW_CUSTOM_ERROR   = -100,
148   GST_FLOW_CUSTOM_ERROR_1 = -101,
149   GST_FLOW_CUSTOM_ERROR_2 = -102
150 } GstFlowReturn;
151
152 /**
153  * GST_FLOW_IS_FATAL:
154  * @ret: a #GstFlowReturn value
155  *
156  * Macro to test if the given #GstFlowReturn value indicates a fatal
157  * error. This macro is mainly used in elements driving the pipeline to decide
158  * whether an error message should be posted on the bus. Note that such
159  * elements may also need to post an error message in the #GST_FLOW_NOT_LINKED
160  * case which is not caught by this macro.
161  */
162 #define GST_FLOW_IS_FATAL(ret) ((ret) <= GST_FLOW_UNEXPECTED)
163
164 /**
165  * GST_FLOW_IS_SUCCESS:
166  * @ret: a #GstFlowReturn value
167  *
168  * Macro to test if the given #GstFlowReturn value indicates a
169  * successfull result
170  * This macro is mainly used in elements to decide if the processing
171  * of a buffer was successfull.
172  *
173  * Since: 0.10.7
174  */
175 #define GST_FLOW_IS_SUCCESS(ret) ((ret) >= GST_FLOW_OK)
176
177 G_CONST_RETURN gchar*   gst_flow_get_name       (GstFlowReturn ret);
178 GQuark                  gst_flow_to_quark       (GstFlowReturn ret);
179
180 /**
181  * GstActivateMode:
182  * @GST_ACTIVATE_NONE:           Pad will not handle dataflow
183  * @GST_ACTIVATE_PUSH:           Pad handles dataflow in downstream push mode
184  * @GST_ACTIVATE_PULL:           Pad handles dataflow in upstream pull mode
185  *
186  * The status of a GstPad. After activating a pad, which usually happens when the
187  * parent element goes from READY to PAUSED, the GstActivateMode defines if the
188  * pad operates in push or pull mode.
189  */
190 typedef enum {
191   GST_ACTIVATE_NONE,
192   GST_ACTIVATE_PUSH,
193   GST_ACTIVATE_PULL
194 } GstActivateMode;
195
196 /**
197  * GST_PAD_MODE_ACTIVATE:
198  * @mode: a #GstActivateMode
199  *
200  * Macro to test if the given #GstActivateMode value indicates that datapassing
201  * is possible or not.
202  */
203 #define GST_PAD_MODE_ACTIVATE(mode) ((mode) != GST_ACTIVATE_NONE)
204
205 /* pad states */
206 /**
207  * GstPadActivateFunction:
208  * @pad: a #GstPad
209  *
210  * This function is called when the pad is activated during the element
211  * READY to PAUSED state change. By default this function will call the
212  * activate function that puts the pad in push mode but elements can
213  * override this function to activate the pad in pull mode if they wish.
214  *
215  * Returns: TRUE if the pad could be activated.
216  */
217 typedef gboolean                (*GstPadActivateFunction)       (GstPad *pad);
218 /**
219  * GstPadActivateModeFunction:
220  * @pad: a #GstPad
221  * @active: activate or deactivate the pad.
222  *
223  * The prototype of the push and pull activate functions.
224  *
225  * Returns: TRUE if the pad could be activated or deactivated.
226  */
227 typedef gboolean                (*GstPadActivateModeFunction)   (GstPad *pad, gboolean active);
228
229
230 /* data passing */
231 /**
232  * GstPadChainFunction:
233  * @pad: the sink #GstPad that performed the chain.
234  * @buffer: the #GstBuffer that is chained, not %NULL.
235  *
236  * A function that will be called on sinkpads when chaining buffers.
237  * The function typically processes the data contained in the buffer and
238  * either consumes the data or passes it on to the internally linked pad(s).
239  *
240  * The implementer of this function receives a refcount to @buffer and should
241  * gst_buffer_unref() when the buffer is no longer needed.
242  *
243  * When a chain function detects an error in the data stream, it must post an
244  * error on the bus and return an appropriate #GstFlowReturn value.
245  *
246  * Returns: #GST_FLOW_OK for success
247  */
248 typedef GstFlowReturn           (*GstPadChainFunction)          (GstPad *pad, GstBuffer *buffer);
249
250 /**
251  * GstPadChainListFunction:
252  * @pad: the sink #GstPad that performed the chain.
253  * @list: the #GstBufferList that is chained, not %NULL.
254  *
255  * A function that will be called on sinkpads when chaining buffer lists.
256  * The function typically processes the data contained in the buffer list and
257  * either consumes the data or passes it on to the internally linked pad(s).
258  *
259  * The implementer of this function receives a refcount to @list and
260  * should gst_buffer_list_unref() when the list is no longer needed.
261  *
262  * When a chainlist function detects an error in the data stream, it must
263  * post an error on the bus and return an appropriate #GstFlowReturn value.
264  *
265  * Returns: #GST_FLOW_OK for success
266  */
267 typedef GstFlowReturn           (*GstPadChainListFunction)      (GstPad *pad, GstBufferList *list);
268
269 /**
270  * GstPadGetRangeFunction:
271  * @pad: the src #GstPad to perform the getrange on.
272  * @offset: the offset of the range
273  * @length: the length of the range
274  * @buffer: a memory location to hold the result buffer, cannot be NULL.
275  *
276  * This function will be called on source pads when a peer element
277  * request a buffer at the specified @offset and @length. If this function
278  * returns #GST_FLOW_OK, the result buffer will be stored in @buffer. The
279  * contents of @buffer is invalid for any other return value.
280  *
281  * This function is installed on a source pad with
282  * gst_pad_set_getrange_function() and can only be called on source pads after
283  * they are successfully activated with gst_pad_activate_pull().
284  *
285  * @offset and @length are always given in byte units. @offset must normally be a value
286  * between 0 and the length in bytes of the data available on @pad. The
287  * length (duration in bytes) can be retrieved with a #GST_QUERY_DURATION or with a
288  * #GST_QUERY_SEEKING.
289  *
290  * Any @offset larger or equal than the length will make the function return
291  * #GST_FLOW_UNEXPECTED, which corresponds to EOS. In this case @buffer does not
292  * contain a valid buffer.
293  *
294  * The buffer size of @buffer might be smaller than @length when @offset is near
295  * the end of the stream.
296  *
297  * It is allowed to call this function with a 0 @length and valid @offset, in
298  * which case @buffer will contain a 0-sized buffer and the function returns
299  * #GST_FLOW_OK.
300  *
301  * When this function is called with a -1 @offset, the sequentially next buffer
302  * of length @length in the stream is returned.
303  *
304  * When this function is called with a -1 @length, a buffer with a default
305  * optimal length is returned in @buffer. The length might depend on the value
306  * of @offset.
307  *
308  * Returns: #GST_FLOW_OK for success
309  */
310 typedef GstFlowReturn           (*GstPadGetRangeFunction)       (GstPad *pad, guint64 offset,
311                                                                  guint length, GstBuffer **buffer);
312
313 /**
314  * GstPadEventFunction:
315  * @pad: the #GstPad to handle the event.
316  * @event: the #GstEvent to handle.
317  *
318  * Function signature to handle an event for the pad.
319  *
320  * Returns: TRUE if the pad could handle the event.
321  */
322 typedef gboolean                (*GstPadEventFunction)          (GstPad *pad, GstEvent *event);
323
324
325 /* FIXME: 0.11: deprecate me, check range should use seeking query */
326 /**
327  * GstPadCheckGetRangeFunction:
328  * @pad: a #GstPad
329  *
330  * Check if @pad can be activated in pull mode.
331  *
332  * This function will be deprecated after 0.10; use the seeking query to check
333  * if a pad can support random access.
334  *
335  * Returns: TRUE if the pad can operate in pull mode.
336  */
337 typedef gboolean                (*GstPadCheckGetRangeFunction)  (GstPad *pad);
338
339 /* internal links */
340 /**
341  * GstPadIntLinkFunction:
342  * @pad: The #GstPad to query.
343  *
344  * The signature of the internal pad link function.
345  *
346  * Returns: a newly allocated #GList of pads that are linked to the given pad on
347  * the inside of the parent element.
348  *
349  * The caller must call g_list_free() on it after use.
350  *
351  * Deprecated: use the threadsafe #GstPadIterIntLinkFunction instead.
352  */
353 typedef GList*                  (*GstPadIntLinkFunction)        (GstPad *pad);
354
355 /**
356  * GstPadIterIntLinkFunction:
357  * @pad: The #GstPad to query.
358  *
359  * The signature of the internal pad link iterator function.
360  *
361  * Returns: a new #GstIterator that will iterate over all pads that are
362  * linked to the given pad on the inside of the parent element.
363  *
364  * the caller must call gst_iterator_free() after usage.
365  *
366  * Since 0.10.21
367  */
368 typedef GstIterator*           (*GstPadIterIntLinkFunction)    (GstPad *pad);
369
370 /* generic query function */
371 /**
372  * GstPadQueryTypeFunction:
373  * @pad: a #GstPad to query
374  *
375  * The signature of the query types function.
376  *
377  * Returns: a constant array of query types
378  */
379 typedef const GstQueryType*     (*GstPadQueryTypeFunction)      (GstPad *pad);
380
381 /**
382  * GstPadQueryFunction:
383  * @pad: the #GstPad to query.
384  * @query: the #GstQuery object to execute
385  *
386  * The signature of the query function.
387  *
388  * Returns: TRUE if the query could be performed.
389  */
390 typedef gboolean                (*GstPadQueryFunction)          (GstPad *pad, GstQuery *query);
391
392
393 /* linking */
394 /**
395  * GstPadLinkFunction
396  * @pad: the #GstPad that is linked.
397  * @peer: the peer #GstPad of the link
398  *
399  * Function signature to handle a new link on the pad.
400  *
401  * Returns: the result of the link with the specified peer.
402  */
403 typedef GstPadLinkReturn        (*GstPadLinkFunction)           (GstPad *pad, GstPad *peer);
404 /**
405  * GstPadUnlinkFunction
406  * @pad: the #GstPad that is linked.
407  *
408  * Function signature to handle a unlinking the pad prom its peer.
409  */
410 typedef void                    (*GstPadUnlinkFunction)         (GstPad *pad);
411
412
413 /* caps nego */
414 /**
415  * GstPadGetCapsFunction:
416  * @pad: the #GstPad to get the capabilities of.
417  *
418  * Returns a copy of the capabilities of the specified pad. By default this
419  * function will return the pad template capabilities, but can optionally
420  * be overridden by elements.
421  *
422  * Returns: a newly allocated copy #GstCaps of the pad.
423  */
424 typedef GstCaps*                (*GstPadGetCapsFunction)        (GstPad *pad);
425
426 /**
427  * GstPadSetCapsFunction:
428  * @pad: the #GstPad to set the capabilities of.
429  * @caps: the #GstCaps to set
430  *
431  * Set @caps on @pad. By default this function updates the caps of the
432  * pad but the function can be overriden by elements to perform extra
433  * actions or verifications.
434  *
435  * Returns: TRUE if the caps could be set on the pad.
436  */
437 typedef gboolean                (*GstPadSetCapsFunction)        (GstPad *pad, GstCaps *caps);
438 /**
439  * GstPadAcceptCapsFunction:
440  * @pad: the #GstPad to check
441  * @caps: the #GstCaps to check
442  *
443  * Check if @pad can accept @caps. By default this function will see if @caps
444  * intersect with the result from gst_pad_get_caps() by can be overridden to
445  * perform extra checks.
446  *
447  * Returns: TRUE if the caps can be accepted by the pad.
448  */
449 typedef gboolean                (*GstPadAcceptCapsFunction)     (GstPad *pad, GstCaps *caps);
450 /**
451  * GstPadFixateCapsFunction:
452  * @pad: a #GstPad
453  * @caps: the #GstCaps to fixate
454  *
455  * Given possibly unfixed caps @caps, let @pad use its default prefered
456  * format to make a fixed caps. @caps should be writable. By default this
457  * function will pick the first value of any ranges or lists in the caps but
458  * elements can override this function to perform other behaviour.
459  */
460 typedef void                    (*GstPadFixateCapsFunction)     (GstPad *pad, GstCaps *caps);
461 /**
462  * GstPadBufferAllocFunction:
463  * @pad: a sink #GstPad
464  * @offset: the desired offset of the buffer
465  * @size: the desired size of the buffer
466  * @caps: the desired caps of the buffer
467  * @buf: pointer to hold the allocated buffer.
468  *
469  * Ask the sinkpad @pad to allocate a buffer with @offset, @size and @caps.
470  * The result will be stored in @buf.
471  *
472  * The purpose of this function is to allocate a buffer that is optimal to
473  * be processed by @pad. The function is mostly overridden by elements that can
474  * provide a hardware buffer in order to avoid additional memcpy operations.
475  *
476  * The function can return a buffer that has caps different from the requested
477  * @caps, in which case the upstream element requests a format change to this
478  * new caps.
479  * If a format change was requested, the returned buffer will be one to hold
480  * the data of said new caps, so its size might be different from the requested
481  * @size.
482  *
483  * When this function returns anything else than #GST_FLOW_OK, the buffer allocation
484  * failed and @buf does not contain valid data. If the function returns #GST_FLOW_OK and
485  * the @buf is NULL, a #GstBuffer will be created with @caps, @offset and @size.
486  *
487  * By default this function returns a new buffer of @size and with @caps containing
488  * purely malloced data. The buffer should be freed with gst_buffer_unref()
489  * after usage.
490  *
491  * Returns: #GST_FLOW_OK if @buf contains a valid buffer, any other return
492  *  value means @buf does not hold a valid buffer.
493  */
494 typedef GstFlowReturn           (*GstPadBufferAllocFunction)    (GstPad *pad, guint64 offset, guint size,
495                                                                  GstCaps *caps, GstBuffer **buf);
496
497 /* misc */
498 /**
499  * GstPadDispatcherFunction:
500  * @pad: the #GstPad that is dispatched.
501  * @data: the gpointer to optional user data.
502  *
503  * A dispatcher function is called for all internally linked pads, see
504  * gst_pad_dispatcher().
505  *
506  * Returns: TRUE if the dispatching procedure has to be stopped.
507  */
508 typedef gboolean                (*GstPadDispatcherFunction)     (GstPad *pad, gpointer data);
509
510 /**
511  * GstPadBlockCallback:
512  * @pad: the #GstPad that is blockend or unblocked.
513  * @blocked: blocking state for the pad
514  * @user_data: the gpointer to optional user data.
515  *
516  * Callback used by gst_pad_set_blocked_async(). Gets called when the blocking
517  * operation succeeds.
518  */
519 typedef void                    (*GstPadBlockCallback)          (GstPad *pad, gboolean blocked, gpointer user_data);
520
521 /**
522  * GstPadDirection:
523  * @GST_PAD_UNKNOWN: direction is unknown.
524  * @GST_PAD_SRC: the pad is a source pad.
525  * @GST_PAD_SINK: the pad is a sink pad.
526  *
527  * The direction of a pad.
528  */
529 typedef enum {
530   GST_PAD_UNKNOWN,
531   GST_PAD_SRC,
532   GST_PAD_SINK
533 } GstPadDirection;
534
535 /**
536  * GstPadFlags:
537  * @GST_PAD_BLOCKED: is dataflow on a pad blocked
538  * @GST_PAD_FLUSHING: is pad refusing buffers
539  * @GST_PAD_IN_GETCAPS: GstPadGetCapsFunction() is running now
540  * @GST_PAD_IN_SETCAPS: GstPadSetCapsFunction() is running now
541  * @GST_PAD_BLOCKING: is pad currently blocking on a buffer or event
542  * @GST_PAD_FLAG_LAST: offset to define more flags
543  *
544  * Pad state flags
545  */
546 typedef enum {
547   GST_PAD_BLOCKED       = (GST_OBJECT_FLAG_LAST << 0),
548   GST_PAD_FLUSHING      = (GST_OBJECT_FLAG_LAST << 1),
549   GST_PAD_IN_GETCAPS    = (GST_OBJECT_FLAG_LAST << 2),
550   GST_PAD_IN_SETCAPS    = (GST_OBJECT_FLAG_LAST << 3),
551   GST_PAD_BLOCKING      = (GST_OBJECT_FLAG_LAST << 4),
552   /* padding */
553   GST_PAD_FLAG_LAST     = (GST_OBJECT_FLAG_LAST << 8)
554 } GstPadFlags;
555
556 /* FIXME: this awful circular dependency need to be resolved properly (see padtemplate.h) */
557 typedef struct _GstPadTemplate GstPadTemplate;
558
559 /**
560  * GstPad:
561  * @element_private: private data owned by the parent element
562  * @padtemplate: padtemplate for this pad
563  * @direction: the direction of the pad, cannot change after creating
564  *             the pad.
565  * @stream_rec_lock: recursive stream lock of the pad, used to protect
566  *                   the data used in streaming.
567  * @task: task for this pad if the pad is actively driving dataflow.
568  * @preroll_lock: lock used when prerolling
569  * @preroll_cond: conf to signal preroll
570  * @block_cond: conditional to signal pad block
571  * @block_callback: callback for the pad block if any
572  * @block_data: user data for @block_callback
573  * @caps: the current caps of the pad
574  * @getcapsfunc: function to get caps of the pad
575  * @setcapsfunc: function to set caps on the pad
576  * @acceptcapsfunc: function to check if pad can accept caps
577  * @fixatecapsfunc: function to fixate caps
578  * @activatefunc: pad activation function
579  * @activatepushfunc: function to activate/deactivate pad in push mode
580  * @activatepullfunc: function to activate/deactivate pad in pull mode
581  * @linkfunc: function called when pad is linked
582  * @unlinkfunc: function called when pad is unlinked
583  * @peer: the pad this pad is linked to
584  * @sched_private: private storage for the scheduler
585  * @chainfunc: function to chain buffer to pad
586  * @checkgetrangefunc: function to check if pad can operate in pull mode
587  * @getrangefunc: function to get a range of data from a pad
588  * @eventfunc: function to send an event to a pad
589  * @mode: current activation mode of the pad
590  * @querytypefunc: get list of supported queries
591  * @queryfunc: perform a query on the pad
592  * @intlinkfunc: get the internal links of this pad
593  * @bufferallocfunc: function to allocate a buffer for this pad
594  * @do_buffer_signals: counter counting installed buffer signals
595  * @do_event_signals: counter counting installed event signals
596  * @iterintlinkfunc: get the internal links iterator of this pad
597  * @block_destroy_data: notify function for gst_pad_set_blocked_async_full()
598  *
599  * The #GstPad structure. Use the functions to update the variables.
600  */
601 struct _GstPad {
602   GstObject                     object;
603
604   /*< public >*/
605   gpointer                      element_private;
606
607   GstPadTemplate                *padtemplate;
608
609   GstPadDirection                direction;
610
611   /*< public >*/ /* with STREAM_LOCK */
612   /* streaming rec_lock */
613   GStaticRecMutex               *stream_rec_lock;
614   GstTask                       *task;
615   /*< public >*/ /* with PREROLL_LOCK */
616   GMutex                        *preroll_lock;
617   GCond                         *preroll_cond;
618
619   /*< public >*/ /* with LOCK */
620   /* block cond, mutex is from the object */
621   GCond                         *block_cond;
622   GstPadBlockCallback            block_callback;
623   gpointer                       block_data;
624
625   /* the pad capabilities */
626   GstCaps                       *caps;
627   GstPadGetCapsFunction         getcapsfunc;
628   GstPadSetCapsFunction         setcapsfunc;
629   GstPadAcceptCapsFunction       acceptcapsfunc;
630   GstPadFixateCapsFunction       fixatecapsfunc;
631
632   GstPadActivateFunction         activatefunc;
633   GstPadActivateModeFunction     activatepushfunc;
634   GstPadActivateModeFunction     activatepullfunc;
635
636   /* pad link */
637   GstPadLinkFunction             linkfunc;
638   GstPadUnlinkFunction           unlinkfunc;
639   GstPad                        *peer;
640
641   gpointer                       sched_private;
642
643   /* data transport functions */
644   GstPadChainFunction            chainfunc;
645   GstPadCheckGetRangeFunction    checkgetrangefunc;
646   GstPadGetRangeFunction         getrangefunc;
647   GstPadEventFunction            eventfunc;
648
649   GstActivateMode                mode;
650
651   /* generic query method */
652   GstPadQueryTypeFunction        querytypefunc;
653   GstPadQueryFunction            queryfunc;
654
655   /* internal links */
656   GstPadIntLinkFunction          intlinkfunc;
657
658   GstPadBufferAllocFunction      bufferallocfunc;
659
660   /* whether to emit signals for have-data. counts number
661    * of handlers attached. */
662   gint                           do_buffer_signals;
663   gint                           do_event_signals;
664
665   /* ABI added */
666   /* iterate internal links */
667   GstPadIterIntLinkFunction     iterintlinkfunc;
668
669   /* free block_data */
670   GDestroyNotify block_destroy_data;
671
672   /*< private >*/
673   union {
674     struct {
675       gboolean                      block_callback_called;
676       GstPadPrivate                *priv;
677     } ABI;
678     gpointer _gst_reserved[GST_PADDING - 2];
679   } abidata;
680 };
681
682 struct _GstPadClass {
683   GstObjectClass        parent_class;
684
685   /* signal callbacks */
686   void          (*linked)               (GstPad *pad, GstPad *peer);
687   void          (*unlinked)             (GstPad *pad, GstPad *peer);
688   void          (*request_link)         (GstPad *pad);
689   gboolean      (*have_data)            (GstPad *pad, GstMiniObject *data);
690
691   /*< private >*/
692   gpointer _gst_reserved[GST_PADDING];
693 };
694
695
696 /***** helper macros *****/
697 /* GstPad */
698 #define GST_PAD_NAME(pad)               (GST_OBJECT_NAME(pad))
699 #define GST_PAD_PARENT(pad)             (GST_ELEMENT_CAST(GST_OBJECT_PARENT(pad)))
700 #define GST_PAD_ELEMENT_PRIVATE(pad)    (GST_PAD_CAST(pad)->element_private)
701 #define GST_PAD_PAD_TEMPLATE(pad)       (GST_PAD_CAST(pad)->padtemplate)
702 #define GST_PAD_DIRECTION(pad)          (GST_PAD_CAST(pad)->direction)
703 #define GST_PAD_TASK(pad)               (GST_PAD_CAST(pad)->task)
704 #define GST_PAD_ACTIVATE_MODE(pad)      (GST_PAD_CAST(pad)->mode)
705
706 #define GST_PAD_ACTIVATEFUNC(pad)       (GST_PAD_CAST(pad)->activatefunc)
707 #define GST_PAD_ACTIVATEPUSHFUNC(pad)   (GST_PAD_CAST(pad)->activatepushfunc)
708 #define GST_PAD_ACTIVATEPULLFUNC(pad)   (GST_PAD_CAST(pad)->activatepullfunc)
709 #define GST_PAD_CHAINFUNC(pad)          (GST_PAD_CAST(pad)->chainfunc)
710 #define GST_PAD_CHECKGETRANGEFUNC(pad)  (GST_PAD_CAST(pad)->checkgetrangefunc)
711 #define GST_PAD_GETRANGEFUNC(pad)       (GST_PAD_CAST(pad)->getrangefunc)
712 #define GST_PAD_EVENTFUNC(pad)          (GST_PAD_CAST(pad)->eventfunc)
713 #define GST_PAD_QUERYTYPEFUNC(pad)      (GST_PAD_CAST(pad)->querytypefunc)
714 #define GST_PAD_QUERYFUNC(pad)          (GST_PAD_CAST(pad)->queryfunc)
715 #ifndef GST_DISABLE_DEPRECATED
716 #define GST_PAD_INTLINKFUNC(pad)        (GST_PAD_CAST(pad)->intlinkfunc)
717 #endif
718 #define GST_PAD_ITERINTLINKFUNC(pad)    (GST_PAD_CAST(pad)->iterintlinkfunc)
719
720 #define GST_PAD_PEER(pad)               (GST_PAD_CAST(pad)->peer)
721 #define GST_PAD_LINKFUNC(pad)           (GST_PAD_CAST(pad)->linkfunc)
722 #define GST_PAD_UNLINKFUNC(pad)         (GST_PAD_CAST(pad)->unlinkfunc)
723
724 /**
725  * GST_PAD_CAPS:
726  * @pad: a #GstPad.
727  *
728  * The caps for this pad.
729  */
730 #define GST_PAD_CAPS(pad)               (GST_PAD_CAST(pad)->caps)
731 #define GST_PAD_GETCAPSFUNC(pad)        (GST_PAD_CAST(pad)->getcapsfunc)
732 #define GST_PAD_SETCAPSFUNC(pad)        (GST_PAD_CAST(pad)->setcapsfunc)
733 #define GST_PAD_ACCEPTCAPSFUNC(pad)     (GST_PAD_CAST(pad)->acceptcapsfunc)
734 #define GST_PAD_FIXATECAPSFUNC(pad)     (GST_PAD_CAST(pad)->fixatecapsfunc)
735
736 #define GST_PAD_BUFFERALLOCFUNC(pad)    (GST_PAD_CAST(pad)->bufferallocfunc)
737
738 #define GST_PAD_DO_BUFFER_SIGNALS(pad)  (GST_PAD_CAST(pad)->do_buffer_signals)
739 #define GST_PAD_DO_EVENT_SIGNALS(pad)   (GST_PAD_CAST(pad)->do_event_signals)
740
741 #define GST_PAD_IS_LINKED(pad)          (GST_PAD_PEER(pad) != NULL)
742 #define GST_PAD_IS_BLOCKED(pad)         (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_BLOCKED))
743 #define GST_PAD_IS_BLOCKING(pad)        (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_BLOCKING))
744 #define GST_PAD_IS_FLUSHING(pad)        (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLUSHING))
745 #define GST_PAD_IS_IN_GETCAPS(pad)      (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_IN_GETCAPS))
746 #define GST_PAD_IS_IN_SETCAPS(pad)      (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_IN_SETCAPS))
747 #define GST_PAD_IS_SRC(pad)             (GST_PAD_DIRECTION(pad) == GST_PAD_SRC)
748 #define GST_PAD_IS_SINK(pad)            (GST_PAD_DIRECTION(pad) == GST_PAD_SINK)
749
750 #define GST_PAD_SET_FLUSHING(pad)       (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLUSHING))
751 #define GST_PAD_UNSET_FLUSHING(pad)     (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLUSHING))
752
753 /**
754  * GST_PAD_GET_STREAM_LOCK:
755  * @pad: a #GstPad
756  *
757  * Get the stream lock of @pad. The stream lock is protecting the
758  * resources used in the data processing functions of @pad.
759  */
760 #define GST_PAD_GET_STREAM_LOCK(pad)    (GST_PAD_CAST(pad)->stream_rec_lock)
761 /**
762  * GST_PAD_STREAM_LOCK:
763  * @pad: a #GstPad
764  *
765  * Lock the stream lock of @pad.
766  */
767 #define GST_PAD_STREAM_LOCK(pad)        (g_static_rec_mutex_lock(GST_PAD_GET_STREAM_LOCK(pad)))
768 /**
769  * GST_PAD_STREAM_LOCK_FULL:
770  * @pad: a #GstPad
771  * @t: the number of times to recursively lock
772  *
773  * Lock the stream lock of @pad @t times.
774  */
775 #define GST_PAD_STREAM_LOCK_FULL(pad,t) (g_static_rec_mutex_lock_full(GST_PAD_GET_STREAM_LOCK(pad), t))
776 /**
777  * GST_PAD_STREAM_TRYLOCK:
778  * @pad: a #GstPad
779  *
780  * Try to Lock the stream lock of the pad, return TRUE if the lock could be
781  * taken.
782  */
783 #define GST_PAD_STREAM_TRYLOCK(pad)     (g_static_rec_mutex_trylock(GST_PAD_GET_STREAM_LOCK(pad)))
784 /**
785  * GST_PAD_STREAM_UNLOCK:
786  * @pad: a #GstPad
787  *
788  * Unlock the stream lock of @pad.
789  */
790 #define GST_PAD_STREAM_UNLOCK(pad)      (g_static_rec_mutex_unlock(GST_PAD_GET_STREAM_LOCK(pad)))
791 /**
792  * GST_PAD_STREAM_UNLOCK_FULL:
793  * @pad: a #GstPad
794  *
795  * Fully unlock the recursive stream lock of @pad, return the number of times
796  * @pad was locked.
797  */
798 #define GST_PAD_STREAM_UNLOCK_FULL(pad) (g_static_rec_mutex_unlock_full(GST_PAD_GET_STREAM_LOCK(pad)))
799
800 #define GST_PAD_GET_PREROLL_LOCK(pad)   (GST_PAD_CAST(pad)->preroll_lock)
801 #define GST_PAD_PREROLL_LOCK(pad)       (g_mutex_lock(GST_PAD_GET_PREROLL_LOCK(pad)))
802 #define GST_PAD_PREROLL_TRYLOCK(pad)    (g_mutex_trylock(GST_PAD_GET_PREROLL_LOCK(pad)))
803 #define GST_PAD_PREROLL_UNLOCK(pad)     (g_mutex_unlock(GST_PAD_GET_PREROLL_LOCK(pad)))
804
805 #define GST_PAD_GET_PREROLL_COND(pad)   (GST_PAD_CAST(pad)->preroll_cond)
806 #define GST_PAD_PREROLL_WAIT(pad)       \
807     g_cond_wait (GST_PAD_GET_PREROLL_COND (pad), GST_PAD_GET_PREROLL_LOCK (pad))
808 #define GST_PAD_PREROLL_TIMED_WAIT(pad, timeval) \
809     g_cond_timed_wait (GST_PAD_GET_PREROLL_COND (pad), GST_PAD_GET_PREROLL_LOCK (pad), timeval)
810 #define GST_PAD_PREROLL_SIGNAL(pad)     g_cond_signal (GST_PAD_GET_PREROLL_COND (pad));
811 #define GST_PAD_PREROLL_BROADCAST(pad)  g_cond_broadcast (GST_PAD_GET_PREROLL_COND (pad));
812
813 #define GST_PAD_BLOCK_GET_COND(pad)     (GST_PAD_CAST(pad)->block_cond)
814 #define GST_PAD_BLOCK_WAIT(pad)         (g_cond_wait(GST_PAD_BLOCK_GET_COND (pad), GST_OBJECT_GET_LOCK (pad)))
815 #define GST_PAD_BLOCK_SIGNAL(pad)       (g_cond_signal(GST_PAD_BLOCK_GET_COND (pad)))
816 #define GST_PAD_BLOCK_BROADCAST(pad)    (g_cond_broadcast(GST_PAD_BLOCK_GET_COND (pad)))
817
818 /* FIXME: this awful circular dependency need to be resolved properly (see padtemplate.h) */
819 #include <gst/gstpadtemplate.h>
820
821 GType                   gst_pad_get_type                        (void);
822
823 /* creating pads */
824 GstPad*                 gst_pad_new                             (const gchar *name, GstPadDirection direction);
825 GstPad*                 gst_pad_new_from_template               (GstPadTemplate *templ, const gchar *name);
826 GstPad*                 gst_pad_new_from_static_template        (GstStaticPadTemplate *templ, const gchar *name);
827
828
829 /**
830  * gst_pad_get_name:
831  * @pad: the pad to get the name from
832  *
833  * Get a copy of the name of the pad. g_free() after usage.
834  *
835  * MT safe.
836  */
837 #define gst_pad_get_name(pad) gst_object_get_name (GST_OBJECT_CAST (pad))
838 /**
839  * gst_pad_get_parent:
840  * @pad: the pad to get the parent of
841  *
842  * Get the parent of @pad. This function increases the refcount
843  * of the parent object so you should gst_object_unref() it after usage.
844  * Can return NULL if the pad did not have a parent.
845  *
846  * MT safe.
847  */
848 #define gst_pad_get_parent(pad) gst_object_get_parent (GST_OBJECT_CAST (pad))
849
850 GstPadDirection         gst_pad_get_direction                   (GstPad *pad);
851
852 gboolean                gst_pad_set_active                      (GstPad *pad, gboolean active);
853 gboolean                gst_pad_is_active                       (GstPad *pad);
854 gboolean                gst_pad_activate_pull                   (GstPad *pad, gboolean active);
855 gboolean                gst_pad_activate_push                   (GstPad *pad, gboolean active);
856
857 gboolean                gst_pad_set_blocked                     (GstPad *pad, gboolean blocked);
858 gboolean                gst_pad_set_blocked_async               (GstPad *pad, gboolean blocked,
859                                                                  GstPadBlockCallback callback, gpointer user_data);
860 gboolean                gst_pad_set_blocked_async_full          (GstPad *pad, gboolean blocked,
861                                                                  GstPadBlockCallback callback, gpointer user_data,
862                                                                  GDestroyNotify destroy_data);
863 gboolean                gst_pad_is_blocked                      (GstPad *pad);
864 gboolean                gst_pad_is_blocking                     (GstPad *pad);
865
866 void                    gst_pad_set_element_private             (GstPad *pad, gpointer priv);
867 gpointer                gst_pad_get_element_private             (GstPad *pad);
868
869 GstPadTemplate*         gst_pad_get_pad_template                (GstPad *pad);
870
871 void                    gst_pad_set_bufferalloc_function        (GstPad *pad, GstPadBufferAllocFunction bufalloc);
872 GstFlowReturn           gst_pad_alloc_buffer                    (GstPad *pad, guint64 offset, gint size,
873                                                                  GstCaps *caps, GstBuffer **buf);
874 GstFlowReturn           gst_pad_alloc_buffer_and_set_caps       (GstPad *pad, guint64 offset, gint size,
875                                                                  GstCaps *caps, GstBuffer **buf);
876
877 /* data passing setup functions */
878 void                    gst_pad_set_activate_function           (GstPad *pad, GstPadActivateFunction activate);
879 void                    gst_pad_set_activatepull_function       (GstPad *pad, GstPadActivateModeFunction activatepull);
880 void                    gst_pad_set_activatepush_function       (GstPad *pad, GstPadActivateModeFunction activatepush);
881 void                    gst_pad_set_chain_function              (GstPad *pad, GstPadChainFunction chain);
882 void                    gst_pad_set_chain_list_function (GstPad *pad, GstPadChainListFunction chainlist);
883 void                    gst_pad_set_getrange_function           (GstPad *pad, GstPadGetRangeFunction get);
884 void                    gst_pad_set_checkgetrange_function      (GstPad *pad, GstPadCheckGetRangeFunction check);
885 void                    gst_pad_set_event_function              (GstPad *pad, GstPadEventFunction event);
886
887 /* pad links */
888 void                    gst_pad_set_link_function               (GstPad *pad, GstPadLinkFunction link);
889 void                    gst_pad_set_unlink_function             (GstPad *pad, GstPadUnlinkFunction unlink);
890
891 gboolean                gst_pad_can_link                        (GstPad *srcpad, GstPad *sinkpad);
892 GstPadLinkReturn        gst_pad_link                            (GstPad *srcpad, GstPad *sinkpad);
893 gboolean                gst_pad_unlink                          (GstPad *srcpad, GstPad *sinkpad);
894 gboolean                gst_pad_is_linked                       (GstPad *pad);
895
896 GstPad*                 gst_pad_get_peer                        (GstPad *pad);
897
898 /* capsnego functions */
899 void                    gst_pad_set_getcaps_function            (GstPad *pad, GstPadGetCapsFunction getcaps);
900 void                    gst_pad_set_acceptcaps_function         (GstPad *pad, GstPadAcceptCapsFunction acceptcaps);
901 void                    gst_pad_set_fixatecaps_function         (GstPad *pad, GstPadFixateCapsFunction fixatecaps);
902 void                    gst_pad_set_setcaps_function            (GstPad *pad, GstPadSetCapsFunction setcaps);
903
904 G_CONST_RETURN GstCaps* gst_pad_get_pad_template_caps           (GstPad *pad);
905
906 /* capsnego function for linked/unlinked pads */
907 GstCaps *               gst_pad_get_caps_reffed                 (GstPad * pad);
908 GstCaps *               gst_pad_get_caps                        (GstPad * pad);
909 void                    gst_pad_fixate_caps                     (GstPad * pad, GstCaps *caps);
910 gboolean                gst_pad_accept_caps                     (GstPad * pad, GstCaps *caps);
911 gboolean                gst_pad_set_caps                        (GstPad * pad, GstCaps *caps);
912
913 GstCaps *               gst_pad_peer_get_caps_reffed            (GstPad * pad);
914 GstCaps *               gst_pad_peer_get_caps                   (GstPad * pad);
915 gboolean                gst_pad_peer_accept_caps                (GstPad * pad, GstCaps *caps);
916
917 /* capsnego for linked pads */
918 GstCaps *               gst_pad_get_allowed_caps                (GstPad * pad);
919 GstCaps *               gst_pad_get_negotiated_caps             (GstPad * pad);
920
921 /* data passing functions to peer */
922 GstFlowReturn           gst_pad_push                            (GstPad *pad, GstBuffer *buffer);
923 GstFlowReturn           gst_pad_push_list                       (GstPad *pad, GstBufferList *list);
924 gboolean                gst_pad_check_pull_range                (GstPad *pad);
925 GstFlowReturn           gst_pad_pull_range                      (GstPad *pad, guint64 offset, guint size,
926                                                                  GstBuffer **buffer);
927 gboolean                gst_pad_push_event                      (GstPad *pad, GstEvent *event);
928 gboolean                gst_pad_event_default                   (GstPad *pad, GstEvent *event);
929
930 /* data passing functions on pad */
931 GstFlowReturn           gst_pad_chain                           (GstPad *pad, GstBuffer *buffer);
932 GstFlowReturn           gst_pad_chain_list                      (GstPad *pad, GstBufferList *list);
933 GstFlowReturn           gst_pad_get_range                       (GstPad *pad, guint64 offset, guint size,
934                                                                  GstBuffer **buffer);
935 gboolean                gst_pad_send_event                      (GstPad *pad, GstEvent *event);
936
937 /* pad tasks */
938 gboolean                gst_pad_start_task                      (GstPad *pad, GstTaskFunction func,
939                                                                  gpointer data);
940 gboolean                gst_pad_pause_task                      (GstPad *pad);
941 gboolean                gst_pad_stop_task                       (GstPad *pad);
942
943 /* internal links */
944 #ifndef GST_DISABLE_DEPRECATED
945 void                    gst_pad_set_internal_link_function      (GstPad *pad, GstPadIntLinkFunction intlink);
946 GList*                  gst_pad_get_internal_links              (GstPad *pad);
947 GList*                  gst_pad_get_internal_links_default      (GstPad *pad);
948 #endif
949
950 void                    gst_pad_set_iterate_internal_links_function (GstPad * pad,
951                                                                  GstPadIterIntLinkFunction iterintlink);
952 GstIterator *           gst_pad_iterate_internal_links          (GstPad * pad);
953 GstIterator *           gst_pad_iterate_internal_links_default  (GstPad * pad);
954
955
956 /* generic query function */
957 void                    gst_pad_set_query_type_function         (GstPad *pad, GstPadQueryTypeFunction type_func);
958 G_CONST_RETURN GstQueryType*
959                         gst_pad_get_query_types                 (GstPad *pad);
960 G_CONST_RETURN GstQueryType*
961                         gst_pad_get_query_types_default         (GstPad *pad);
962
963 gboolean                gst_pad_query                           (GstPad *pad, GstQuery *query);
964 gboolean                gst_pad_peer_query                      (GstPad *pad, GstQuery *query);
965 void                    gst_pad_set_query_function              (GstPad *pad, GstPadQueryFunction query);
966 gboolean                gst_pad_query_default                   (GstPad *pad, GstQuery *query);
967
968 /* misc helper functions */
969 gboolean                gst_pad_dispatcher                      (GstPad *pad, GstPadDispatcherFunction dispatch,
970                                                                  gpointer data);
971
972 #ifndef GST_DISABLE_LOADSAVE
973 void                    gst_pad_load_and_link                   (xmlNodePtr self, GstObject *parent);
974 #endif
975
976 G_END_DECLS
977
978 #endif /* __GST_PAD_H__ */