2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wim.taymans@chello.be>
5 * gstpad.h: Header for GstPad object
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.
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.
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.
27 #include <gst/gstconfig.h>
29 #include <gst/gstobject.h>
30 #include <gst/gstbuffer.h>
31 #include <gst/gstcaps.h>
32 #include <gst/gstevent.h>
33 #include <gst/gstquery.h>
34 #include <gst/gsttask.h>
41 #define GST_TYPE_PAD (gst_pad_get_type ())
42 #define GST_IS_PAD(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD))
43 #define GST_IS_PAD_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
44 #define GST_PAD(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD, GstPad))
45 #define GST_PAD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD, GstPadClass))
46 #define GST_PAD_CAST(obj) ((GstPad*)(obj))
49 typedef struct _GstPad GstPad;
50 typedef struct _GstPadClass GstPadClass;
54 * @GST_PAD_LINK_OK : link succeeded
55 * @GST_PAD_LINK_WRONG_HIERARCHY: pads have no common grandparent
56 * @GST_PAD_LINK_WAS_LINKED : pad was already linked
57 * @GST_PAD_LINK_WRONG_DIRECTION: pads have wrong direction
58 * @GST_PAD_LINK_NOFORMAT : pads do not have common format
59 * @GST_PAD_LINK_NOSCHED : pads cannot cooperate in scheduling
60 * @GST_PAD_LINK_REFUSED : refused for some reason
62 * Result values from gst_pad_link and friends.
66 GST_PAD_LINK_WRONG_HIERARCHY = -1,
67 GST_PAD_LINK_WAS_LINKED = -2,
68 GST_PAD_LINK_WRONG_DIRECTION = -3,
69 GST_PAD_LINK_NOFORMAT = -4,
70 GST_PAD_LINK_NOSCHED = -5,
71 GST_PAD_LINK_REFUSED = -6
75 * GST_PAD_LINK_FAILED:
76 * @ret: the #GstPadLinkReturn value
78 * Macro to test if the given #GstPadLinkReturn value indicates a failed
81 #define GST_PAD_LINK_FAILED(ret) ((ret) < GST_PAD_LINK_OK)
84 * GST_PAD_LINK_SUCCESSFUL:
85 * @ret: the #GstPadLinkReturn value
87 * Macro to test if the given #GstPadLinkReturn value indicates a successful
90 #define GST_PAD_LINK_SUCCESSFUL(ret) ((ret) >= GST_PAD_LINK_OK)
94 * @GST_FLOW_CUSTOM_SUCCESS: Elements can use values starting from
95 * this to define custom success codes.
97 * @GST_FLOW_RESEND: Resend buffer, possibly with new caps (not
98 * sent yet) (unused/unimplemented).
99 * @GST_FLOW_OK: Data passing was ok.
100 * @GST_FLOW_NOT_LINKED: Pad is not linked.
101 * @GST_FLOW_WRONG_STATE: Pad is in wrong state.
102 * @GST_FLOW_UNEXPECTED: Did not expect anything, like after EOS.
103 * @GST_FLOW_NOT_NEGOTIATED: Pad is not negotiated.
104 * @GST_FLOW_ERROR: Some (fatal) error occured. Element generating
105 * this error should post an error message with more
107 * @GST_FLOW_NOT_SUPPORTED: This operation is not supported.
108 * @GST_FLOW_CUSTOM_ERROR: Elements can use values starting from
109 * this to define custom error codes. Since 0.10.7.
111 * The result of passing data to a pad.
113 * Note that the custom return values should not be exposed outside of the
114 * element scope and are available since 0.10.7.
117 /* custom success starts here */
118 GST_FLOW_CUSTOM_SUCCESS = 100,
120 /* core predefined */
123 /* expected failures */
124 GST_FLOW_NOT_LINKED = -1,
125 GST_FLOW_WRONG_STATE = -2,
127 GST_FLOW_UNEXPECTED = -3,
128 GST_FLOW_NOT_NEGOTIATED = -4,
130 GST_FLOW_NOT_SUPPORTED = -6,
132 /* custom error starts here */
133 GST_FLOW_CUSTOM_ERROR = -100
138 * @ret: a #GstFlowReturn value
140 * Macro to test if the given #GstFlowReturn value indicates a fatal
141 * error. This macro is mainly used in elements driving the pipeline to decide
142 * whether an error message should be posted on the bus. Note that such
143 * elements may also need to post an error message in the #GST_FLOW_NOT_LINKED
144 * case which is not caught by this macro.
146 #define GST_FLOW_IS_FATAL(ret) ((ret) <= GST_FLOW_UNEXPECTED)
149 * GST_FLOW_IS_SUCCESS:
150 * @ret: a #GstFlowReturn value
152 * Macro to test if the given #GstFlowReturn value indicates a
154 * This macro is mainly used in elements to decide if the processing
155 * of a buffer was successfull.
159 #define GST_FLOW_IS_SUCCESS(ret) ((ret) >= GST_FLOW_OK)
161 G_CONST_RETURN gchar* gst_flow_get_name (GstFlowReturn ret);
162 GQuark gst_flow_to_quark (GstFlowReturn ret);
166 * @GST_ACTIVATE_NONE: Pad will not handle dataflow
167 * @GST_ACTIVATE_PUSH: Pad handles dataflow in downstream push mode
168 * @GST_ACTIVATE_PULL: Pad handles dataflow in upstream pull mode
170 * The status of a GstPad. After activating a pad, which usually happens when the
171 * parent element goes from READY to PAUSED, the GstActivateMode defines if the
172 * pad operates in push or pull mode.
181 * GST_PAD_MODE_ACTIVATE:
182 * @mode: a #GstActivateMode
184 * Macro to test if the given #GstActivateMode value indicates that datapassing
185 * is possible or not.
187 #define GST_PAD_MODE_ACTIVATE(mode) ((mode) != GST_ACTIVATE_NONE)
191 * GstPadActivateFunction:
194 * This function is called when the pad is activated during the element
195 * READY to PAUSED state change. By default this function will call the
196 * activate function that puts the pad in push mode but elements can
197 * override this function to activate the pad in pull mode if they wish.
199 * Returns: TRUE if the pad could be activated.
201 typedef gboolean (*GstPadActivateFunction) (GstPad *pad);
203 * GstPadActivateModeFunction:
205 * @active: activate or deactivate the pad.
207 * The prototype of the push and pull activate functions.
209 * Returns: TRUE if the pad could be activated or deactivated.
211 typedef gboolean (*GstPadActivateModeFunction) (GstPad *pad, gboolean active);
216 * GstPadChainFunction:
217 * @pad: the sink #GstPad that performed the chain.
218 * @buffer: the #GstBuffer that is chained, not %NULL.
220 * A function that will be called on sinkpads when chaining buffers.
221 * The function typically processes the data contained in the buffer and
222 * either consumes the data or passes it on to the internally linked pad(s).
224 * The implementer of this function receives a refcount to @buffer and should
225 * gst_buffer_unref() when the buffer is no longer needed.
227 * When a chain function detects an error in the data stream, it must post an
228 * error on the bus and return an appropriate #GstFlowReturn value.
230 * Returns: #GST_FLOW_OK for success
232 typedef GstFlowReturn (*GstPadChainFunction) (GstPad *pad, GstBuffer *buffer);
234 * GstPadGetRangeFunction:
235 * @pad: the src #GstPad to perform the getrange on.
236 * @offset: the offset of the range
237 * @length: the length of the range
238 * @buffer: a memory location to hold the result buffer, cannot be NULL.
240 * This function will be called on source pads when a peer element
241 * request a buffer at the specified @offset and @length. If this function
242 * returns #GST_FLOW_OK, the result buffer will be stored in @buffer. The
243 * contents of @buffer is invalid for any other return value.
245 * This function is installed on a source pad with
246 * gst_pad_set_getrange_function() and can only be called on source pads after
247 * they are successfully activated with gst_pad_activate_pull().
249 * @offset and @length are always given in byte units. @offset must normally be a value
250 * between 0 and the length in bytes of the data available on @pad. The
251 * length (duration in bytes) can be retrieved with a #GST_QUERY_DURATION or with a
252 * #GST_QUERY_SEEKING.
254 * Any @offset larger or equal than the length will make the function return
255 * #GST_FLOW_UNEXPECTED, which corresponds to EOS. In this case @buffer does not
256 * contain a valid buffer.
258 * The buffer size of @buffer might be smaller than @length when @offset is near
259 * the end of the stream.
261 * It is allowed to call this function with a 0 @length and valid @offset, in
262 * which case @buffer will contain a 0-sized buffer and the function returns
265 * When this function is called with a -1 @offset, the sequentially next buffer
266 * of length @length in the stream is returned.
268 * When this function is called with a -1 @length, a buffer with a default
269 * optimal length is returned in @buffer. The length might depend on the value
272 * Returns: #GST_FLOW_OK for success
274 typedef GstFlowReturn (*GstPadGetRangeFunction) (GstPad *pad, guint64 offset,
275 guint length, GstBuffer **buffer);
278 * GstPadEventFunction:
279 * @pad: the #GstPad to handle the event.
280 * @event: the #GstEvent to handle.
282 * Function signature to handle an event for the pad.
284 * Returns: TRUE if the pad could handle the event.
286 typedef gboolean (*GstPadEventFunction) (GstPad *pad, GstEvent *event);
289 /* FIXME: 0.11: deprecate me, check range should use seeking query */
291 * GstPadCheckGetRangeFunction:
294 * Check if @pad can be activated in pull mode.
296 * This function will be deprecated after 0.10; use the seeking query to check
297 * if a pad can support random access.
299 * Returns: TRUE if the pad can operate in pull mode.
301 typedef gboolean (*GstPadCheckGetRangeFunction) (GstPad *pad);
305 * GstPadIntLinkFunction:
306 * @pad: The #GstPad to query.
308 * The signature of the internal pad link function.
310 * Returns: a newly allocated #GList of pads that are linked to the given pad on
311 * the inside of the parent element.
313 * The caller must call g_list_free() on it after use.
315 * Deprecated: use the threadsafe #GstPadIterIntLinkFunction instead.
317 typedef GList* (*GstPadIntLinkFunction) (GstPad *pad);
320 * GstPadIterIntLinkFunction:
321 * @pad: The #GstPad to query.
323 * The signature of the internal pad link iterator function.
325 * Returns: a new #GstIterator that will iterate over all pads that are
326 * linked to the given pad on the inside of the parent element.
328 * the caller must call gst_iterator_free() after usage.
332 typedef GstIterator* (*GstPadIterIntLinkFunction) (GstPad *pad);
334 /* generic query function */
336 * GstPadQueryTypeFunction:
337 * @pad: a #GstPad to query
339 * The signature of the query types function.
341 * Returns: a constant array of query types
343 typedef const GstQueryType* (*GstPadQueryTypeFunction) (GstPad *pad);
346 * GstPadQueryFunction:
347 * @pad: the #GstPad to query.
348 * @query: the #GstQuery object to execute
350 * The signature of the query function.
352 * Returns: TRUE if the query could be performed.
354 typedef gboolean (*GstPadQueryFunction) (GstPad *pad, GstQuery *query);
360 * @pad: the #GstPad that is linked.
361 * @peer: the peer #GstPad of the link
363 * Function signature to handle a new link on the pad.
365 * Returns: the result of the link with the specified peer.
367 typedef GstPadLinkReturn (*GstPadLinkFunction) (GstPad *pad, GstPad *peer);
369 * GstPadUnlinkFunction
370 * @pad: the #GstPad that is linked.
372 * Function signature to handle a unlinking the pad prom its peer.
374 typedef void (*GstPadUnlinkFunction) (GstPad *pad);
379 * GstPadGetCapsFunction:
380 * @pad: the #GstPad to get the capabilities of.
382 * Returns a copy of the capabilities of the specified pad. By default this
383 * function will return the pad template capabilities, but can optionally
384 * be overridden by elements.
386 * Returns: a newly allocated copy #GstCaps of the pad.
388 typedef GstCaps* (*GstPadGetCapsFunction) (GstPad *pad);
391 * GstPadSetCapsFunction:
392 * @pad: the #GstPad to set the capabilities of.
393 * @caps: the #GstCaps to set
395 * Set @caps on @pad. By default this function updates the caps of the
396 * pad but the function can be overriden by elements to perform extra
397 * actions or verifications.
399 * Returns: TRUE if the caps could be set on the pad.
401 typedef gboolean (*GstPadSetCapsFunction) (GstPad *pad, GstCaps *caps);
403 * GstPadAcceptCapsFunction:
404 * @pad: the #GstPad to check
405 * @caps: the #GstCaps to check
407 * Check if @pad can accept @caps. By default this function will see if @caps
408 * intersect with the result from gst_pad_get_caps() by can be overridden to
409 * perform extra checks.
411 * Returns: TRUE if the caps can be accepted by the pad.
413 typedef gboolean (*GstPadAcceptCapsFunction) (GstPad *pad, GstCaps *caps);
415 * GstPadFixateCapsFunction:
417 * @caps: the #GstCaps to fixate
419 * Given possibly unfixed caps @caps, let @pad use its default prefered
420 * format to make a fixed caps. @caps should be writable. By default this
421 * function will pick the first value of any ranges or lists in the caps but
422 * elements can override this function to perform other behaviour.
424 typedef void (*GstPadFixateCapsFunction) (GstPad *pad, GstCaps *caps);
426 * GstPadBufferAllocFunction:
427 * @pad: a sink #GstPad
428 * @offset: the desired offset of the buffer
429 * @size: the desired size of the buffer
430 * @caps: the desired caps of the buffer
431 * @buf: pointer to hold the allocated buffer.
433 * Ask the sinkpad @pad to allocate a buffer with @offset, @size and @caps.
434 * The result will be stored in @buf.
436 * The purpose of this function is to allocate a buffer that is optimal to
437 * be processed by @pad. The function is mostly overridden by elements that can
438 * provide a hardware buffer in order to avoid additional memcpy operations.
440 * The function can return a buffer that has caps different from the requested
441 * @caps, in which case the upstream element requests a format change to this
443 * If a format change was requested, the returned buffer will be one to hold
444 * the data of said new caps, so its size might be different from the requested
447 * When this function returns anything else than #GST_FLOW_OK, the buffer allocation
448 * failed and @buf does not contain valid data. If the function returns #GST_FLOW_OK and
449 * the @buf is NULL, a #GstBuffer will be created with @caps, @offset and @size.
451 * By default this function returns a new buffer of @size and with @caps containing
452 * purely malloced data. The buffer should be freed with gst_buffer_unref()
455 * Returns: #GST_FLOW_OK if @buf contains a valid buffer, any other return
456 * value means @buf does not hold a valid buffer.
458 typedef GstFlowReturn (*GstPadBufferAllocFunction) (GstPad *pad, guint64 offset, guint size,
459 GstCaps *caps, GstBuffer **buf);
463 * GstPadDispatcherFunction:
464 * @pad: the #GstPad that is dispatched.
465 * @data: the gpointer to optional user data.
467 * A dispatcher function is called for all internally linked pads, see
468 * gst_pad_dispatcher().
470 * Returns: TRUE if the dispatching procedure has to be stopped.
472 typedef gboolean (*GstPadDispatcherFunction) (GstPad *pad, gpointer data);
475 * GstPadBlockCallback:
476 * @pad: the #GstPad that is blockend or unblocked.
477 * @blocked: blocking state for the pad
478 * @user_data: the gpointer to optional user data.
480 * Callback used by gst_pad_set_blocked_async(). Gets called when the blocking
481 * operation succeeds.
483 typedef void (*GstPadBlockCallback) (GstPad *pad, gboolean blocked, gpointer user_data);
487 * @GST_PAD_UNKNOWN: direction is unknown.
488 * @GST_PAD_SRC: the pad is a source pad.
489 * @GST_PAD_SINK: the pad is a sink pad.
491 * The direction of a pad.
501 * @GST_PAD_BLOCKED: is dataflow on a pad blocked
502 * @GST_PAD_FLUSHING: is pad refusing buffers
503 * @GST_PAD_IN_GETCAPS: GstPadGetCapsFunction() is running now
504 * @GST_PAD_IN_SETCAPS: GstPadSetCapsFunction() is running now
505 * @GST_PAD_BLOCKING: is pad currently blocking on a buffer or event
506 * @GST_PAD_FLAG_LAST: offset to define more flags
511 GST_PAD_BLOCKED = (GST_OBJECT_FLAG_LAST << 0),
512 GST_PAD_FLUSHING = (GST_OBJECT_FLAG_LAST << 1),
513 GST_PAD_IN_GETCAPS = (GST_OBJECT_FLAG_LAST << 2),
514 GST_PAD_IN_SETCAPS = (GST_OBJECT_FLAG_LAST << 3),
515 GST_PAD_BLOCKING = (GST_OBJECT_FLAG_LAST << 4),
517 GST_PAD_FLAG_LAST = (GST_OBJECT_FLAG_LAST << 8)
520 /* FIXME: this awful circular dependency need to be resolved properly (see padtemplate.h) */
521 typedef struct _GstPadTemplate GstPadTemplate;
525 * @element_private: private data owned by the parent element
526 * @padtemplate: padtemplate for this pad
527 * @direction: the direction of the pad, cannot change after creating
529 * @stream_rec_lock: recursive stream lock of the pad, used to protect
530 * the data used in streaming.
531 * @task: task for this pad if the pad is actively driving dataflow.
532 * @preroll_lock: lock used when prerolling
533 * @preroll_cond: conf to signal preroll
534 * @block_cond: conditional to signal pad block
535 * @block_callback: callback for the pad block if any
536 * @block_data: user data for @block_callback
537 * @caps: the current caps of the pad
538 * @getcapsfunc: function to get caps of the pad
539 * @setcapsfunc: function to set caps on the pad
540 * @acceptcapsfunc: function to check if pad can accept caps
541 * @fixatecapsfunc: function to fixate caps
542 * @activatefunc: pad activation function
543 * @activatepushfunc: function to activate/deactivate pad in push mode
544 * @activatepullfunc: function to activate/deactivate pad in pull mode
545 * @linkfunc: function called when pad is linked
546 * @unlinkfunc: function called when pad is unlinked
547 * @peer: the pad this pad is linked to
548 * @sched_private: private storage for the scheduler
549 * @chainfunc: function to chain data to pad
550 * @checkgetrangefunc: function to check if pad can operate in pull mode
551 * @getrangefunc: function to get a range of data from a pad
552 * @eventfunc: function to send an event to a pad
553 * @mode: current activation mode of the pad
554 * @querytypefunc: get list of supported queries
555 * @queryfunc: perform a query on the pad
556 * @intlinkfunc: get the internal links of this pad
557 * @bufferallocfunc: function to allocate a buffer for this pad
558 * @do_buffer_signals: counter counting installed buffer signals
559 * @do_event_signals: counter counting installed event signals
560 * @iterintlinkfunc: get the internal links iterator of this pad
561 * @block_destroy_data: notify function for gst_pad_set_blocked_async_full()
563 * The #GstPad structure. Use the functions to update the variables.
569 gpointer element_private;
571 GstPadTemplate *padtemplate;
573 GstPadDirection direction;
575 /*< public >*/ /* with STREAM_LOCK */
576 /* streaming rec_lock */
577 GStaticRecMutex *stream_rec_lock;
579 /*< public >*/ /* with PREROLL_LOCK */
580 GMutex *preroll_lock;
583 /*< public >*/ /* with LOCK */
584 /* block cond, mutex is from the object */
586 GstPadBlockCallback block_callback;
589 /* the pad capabilities */
591 GstPadGetCapsFunction getcapsfunc;
592 GstPadSetCapsFunction setcapsfunc;
593 GstPadAcceptCapsFunction acceptcapsfunc;
594 GstPadFixateCapsFunction fixatecapsfunc;
596 GstPadActivateFunction activatefunc;
597 GstPadActivateModeFunction activatepushfunc;
598 GstPadActivateModeFunction activatepullfunc;
601 GstPadLinkFunction linkfunc;
602 GstPadUnlinkFunction unlinkfunc;
605 gpointer sched_private;
607 /* data transport functions */
608 GstPadChainFunction chainfunc;
609 GstPadCheckGetRangeFunction checkgetrangefunc;
610 GstPadGetRangeFunction getrangefunc;
611 GstPadEventFunction eventfunc;
613 GstActivateMode mode;
615 /* generic query method */
616 GstPadQueryTypeFunction querytypefunc;
617 GstPadQueryFunction queryfunc;
620 GstPadIntLinkFunction intlinkfunc;
622 GstPadBufferAllocFunction bufferallocfunc;
624 /* whether to emit signals for have-data. counts number
625 * of handlers attached. */
626 gint do_buffer_signals;
627 gint do_event_signals;
630 /* iterate internal links */
631 GstPadIterIntLinkFunction iterintlinkfunc;
633 /* free block_data */
634 GDestroyNotify block_destroy_data;
639 gboolean block_callback_called;
641 gpointer _gst_reserved[GST_PADDING - 2];
645 struct _GstPadClass {
646 GstObjectClass parent_class;
648 /* signal callbacks */
649 void (*linked) (GstPad *pad, GstPad *peer);
650 void (*unlinked) (GstPad *pad, GstPad *peer);
651 void (*request_link) (GstPad *pad);
652 gboolean (*have_data) (GstPad *pad, GstMiniObject *data);
655 gpointer _gst_reserved[GST_PADDING];
659 /***** helper macros *****/
661 #define GST_PAD_NAME(pad) (GST_OBJECT_NAME(pad))
662 #define GST_PAD_PARENT(pad) (GST_ELEMENT_CAST(GST_OBJECT_PARENT(pad)))
663 #define GST_PAD_ELEMENT_PRIVATE(pad) (GST_PAD_CAST(pad)->element_private)
664 #define GST_PAD_PAD_TEMPLATE(pad) (GST_PAD_CAST(pad)->padtemplate)
665 #define GST_PAD_DIRECTION(pad) (GST_PAD_CAST(pad)->direction)
666 #define GST_PAD_TASK(pad) (GST_PAD_CAST(pad)->task)
667 #define GST_PAD_ACTIVATE_MODE(pad) (GST_PAD_CAST(pad)->mode)
669 #define GST_PAD_ACTIVATEFUNC(pad) (GST_PAD_CAST(pad)->activatefunc)
670 #define GST_PAD_ACTIVATEPUSHFUNC(pad) (GST_PAD_CAST(pad)->activatepushfunc)
671 #define GST_PAD_ACTIVATEPULLFUNC(pad) (GST_PAD_CAST(pad)->activatepullfunc)
672 #define GST_PAD_CHAINFUNC(pad) (GST_PAD_CAST(pad)->chainfunc)
673 #define GST_PAD_CHECKGETRANGEFUNC(pad) (GST_PAD_CAST(pad)->checkgetrangefunc)
674 #define GST_PAD_GETRANGEFUNC(pad) (GST_PAD_CAST(pad)->getrangefunc)
675 #define GST_PAD_EVENTFUNC(pad) (GST_PAD_CAST(pad)->eventfunc)
676 #define GST_PAD_QUERYTYPEFUNC(pad) (GST_PAD_CAST(pad)->querytypefunc)
677 #define GST_PAD_QUERYFUNC(pad) (GST_PAD_CAST(pad)->queryfunc)
678 #define GST_PAD_INTLINKFUNC(pad) (GST_PAD_CAST(pad)->intlinkfunc)
679 #define GST_PAD_ITERINTLINKFUNC(pad) (GST_PAD_CAST(pad)->iterintlinkfunc)
681 #define GST_PAD_PEER(pad) (GST_PAD_CAST(pad)->peer)
682 #define GST_PAD_LINKFUNC(pad) (GST_PAD_CAST(pad)->linkfunc)
683 #define GST_PAD_UNLINKFUNC(pad) (GST_PAD_CAST(pad)->unlinkfunc)
689 * The caps for this pad.
691 #define GST_PAD_CAPS(pad) (GST_PAD_CAST(pad)->caps)
692 #define GST_PAD_GETCAPSFUNC(pad) (GST_PAD_CAST(pad)->getcapsfunc)
693 #define GST_PAD_SETCAPSFUNC(pad) (GST_PAD_CAST(pad)->setcapsfunc)
694 #define GST_PAD_ACCEPTCAPSFUNC(pad) (GST_PAD_CAST(pad)->acceptcapsfunc)
695 #define GST_PAD_FIXATECAPSFUNC(pad) (GST_PAD_CAST(pad)->fixatecapsfunc)
697 #define GST_PAD_BUFFERALLOCFUNC(pad) (GST_PAD_CAST(pad)->bufferallocfunc)
699 #define GST_PAD_DO_BUFFER_SIGNALS(pad) (GST_PAD_CAST(pad)->do_buffer_signals)
700 #define GST_PAD_DO_EVENT_SIGNALS(pad) (GST_PAD_CAST(pad)->do_event_signals)
702 #define GST_PAD_IS_LINKED(pad) (GST_PAD_PEER(pad) != NULL)
703 #define GST_PAD_IS_BLOCKED(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_BLOCKED))
704 #define GST_PAD_IS_BLOCKING(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_BLOCKING))
705 #define GST_PAD_IS_FLUSHING(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLUSHING))
706 #define GST_PAD_IS_IN_GETCAPS(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_IN_GETCAPS))
707 #define GST_PAD_IS_IN_SETCAPS(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_IN_SETCAPS))
708 #define GST_PAD_IS_SRC(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SRC)
709 #define GST_PAD_IS_SINK(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SINK)
711 #define GST_PAD_SET_FLUSHING(pad) (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLUSHING))
712 #define GST_PAD_UNSET_FLUSHING(pad) (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLUSHING))
715 * GST_PAD_GET_STREAM_LOCK:
718 * Get the stream lock of @pad. The stream lock is protecting the
719 * resources used in the data processing functions of @pad.
721 #define GST_PAD_GET_STREAM_LOCK(pad) (GST_PAD_CAST(pad)->stream_rec_lock)
723 * GST_PAD_STREAM_LOCK:
726 * Lock the stream lock of @pad.
728 #define GST_PAD_STREAM_LOCK(pad) (g_static_rec_mutex_lock(GST_PAD_GET_STREAM_LOCK(pad)))
730 * GST_PAD_STREAM_LOCK_FULL:
732 * @t: the number of times to recursively lock
734 * Lock the stream lock of @pad @t times.
736 #define GST_PAD_STREAM_LOCK_FULL(pad,t) (g_static_rec_mutex_lock_full(GST_PAD_GET_STREAM_LOCK(pad), t))
738 * GST_PAD_STREAM_TRYLOCK:
741 * Try to Lock the stream lock of the pad, return TRUE if the lock could be
744 #define GST_PAD_STREAM_TRYLOCK(pad) (g_static_rec_mutex_trylock(GST_PAD_GET_STREAM_LOCK(pad)))
746 * GST_PAD_STREAM_UNLOCK:
749 * Unlock the stream lock of @pad.
751 #define GST_PAD_STREAM_UNLOCK(pad) (g_static_rec_mutex_unlock(GST_PAD_GET_STREAM_LOCK(pad)))
753 * GST_PAD_STREAM_UNLOCK_FULL:
756 * Fully unlock the recursive stream lock of @pad, return the number of times
759 #define GST_PAD_STREAM_UNLOCK_FULL(pad) (g_static_rec_mutex_unlock_full(GST_PAD_GET_STREAM_LOCK(pad)))
761 #define GST_PAD_GET_PREROLL_LOCK(pad) (GST_PAD_CAST(pad)->preroll_lock)
762 #define GST_PAD_PREROLL_LOCK(pad) (g_mutex_lock(GST_PAD_GET_PREROLL_LOCK(pad)))
763 #define GST_PAD_PREROLL_TRYLOCK(pad) (g_mutex_trylock(GST_PAD_GET_PREROLL_LOCK(pad)))
764 #define GST_PAD_PREROLL_UNLOCK(pad) (g_mutex_unlock(GST_PAD_GET_PREROLL_LOCK(pad)))
766 #define GST_PAD_GET_PREROLL_COND(pad) (GST_PAD_CAST(pad)->preroll_cond)
767 #define GST_PAD_PREROLL_WAIT(pad) \
768 g_cond_wait (GST_PAD_GET_PREROLL_COND (pad), GST_PAD_GET_PREROLL_LOCK (pad))
769 #define GST_PAD_PREROLL_TIMED_WAIT(pad, timeval) \
770 g_cond_timed_wait (GST_PAD_GET_PREROLL_COND (pad), GST_PAD_GET_PREROLL_LOCK (pad), timeval)
771 #define GST_PAD_PREROLL_SIGNAL(pad) g_cond_signal (GST_PAD_GET_PREROLL_COND (pad));
772 #define GST_PAD_PREROLL_BROADCAST(pad) g_cond_broadcast (GST_PAD_GET_PREROLL_COND (pad));
774 #define GST_PAD_BLOCK_GET_COND(pad) (GST_PAD_CAST(pad)->block_cond)
775 #define GST_PAD_BLOCK_WAIT(pad) (g_cond_wait(GST_PAD_BLOCK_GET_COND (pad), GST_OBJECT_GET_LOCK (pad)))
776 #define GST_PAD_BLOCK_SIGNAL(pad) (g_cond_signal(GST_PAD_BLOCK_GET_COND (pad)))
777 #define GST_PAD_BLOCK_BROADCAST(pad) (g_cond_broadcast(GST_PAD_BLOCK_GET_COND (pad)))
779 /* FIXME: this awful circular dependency need to be resolved properly (see padtemplate.h) */
780 #include <gst/gstpadtemplate.h>
782 GType gst_pad_get_type (void);
785 GstPad* gst_pad_new (const gchar *name, GstPadDirection direction);
786 GstPad* gst_pad_new_from_template (GstPadTemplate *templ, const gchar *name);
787 GstPad* gst_pad_new_from_static_template (GstStaticPadTemplate *templ, const gchar *name);
792 * @pad: the pad to get the name from
794 * Get a copy of the name of the pad. g_free() after usage.
798 #define gst_pad_get_name(pad) gst_object_get_name (GST_OBJECT_CAST (pad))
800 * gst_pad_get_parent:
801 * @pad: the pad to get the parent of
803 * Get the parent of @pad. This function increases the refcount
804 * of the parent object so you should gst_object_unref() it after usage.
805 * Can return NULL if the pad did not have a parent.
809 #define gst_pad_get_parent(pad) gst_object_get_parent (GST_OBJECT_CAST (pad))
811 GstPadDirection gst_pad_get_direction (GstPad *pad);
813 gboolean gst_pad_set_active (GstPad *pad, gboolean active);
814 gboolean gst_pad_is_active (GstPad *pad);
815 gboolean gst_pad_activate_pull (GstPad *pad, gboolean active);
816 gboolean gst_pad_activate_push (GstPad *pad, gboolean active);
818 gboolean gst_pad_set_blocked (GstPad *pad, gboolean blocked);
819 gboolean gst_pad_set_blocked_async (GstPad *pad, gboolean blocked,
820 GstPadBlockCallback callback, gpointer user_data);
821 gboolean gst_pad_set_blocked_async_full (GstPad *pad, gboolean blocked,
822 GstPadBlockCallback callback, gpointer user_data,
823 GDestroyNotify destroy_data);
824 gboolean gst_pad_is_blocked (GstPad *pad);
825 gboolean gst_pad_is_blocking (GstPad *pad);
827 void gst_pad_set_element_private (GstPad *pad, gpointer priv);
828 gpointer gst_pad_get_element_private (GstPad *pad);
830 GstPadTemplate* gst_pad_get_pad_template (GstPad *pad);
832 void gst_pad_set_bufferalloc_function (GstPad *pad, GstPadBufferAllocFunction bufalloc);
833 GstFlowReturn gst_pad_alloc_buffer (GstPad *pad, guint64 offset, gint size,
834 GstCaps *caps, GstBuffer **buf);
835 GstFlowReturn gst_pad_alloc_buffer_and_set_caps (GstPad *pad, guint64 offset, gint size,
836 GstCaps *caps, GstBuffer **buf);
838 /* data passing setup functions */
839 void gst_pad_set_activate_function (GstPad *pad, GstPadActivateFunction activate);
840 void gst_pad_set_activatepull_function (GstPad *pad, GstPadActivateModeFunction activatepull);
841 void gst_pad_set_activatepush_function (GstPad *pad, GstPadActivateModeFunction activatepush);
842 void gst_pad_set_chain_function (GstPad *pad, GstPadChainFunction chain);
843 void gst_pad_set_getrange_function (GstPad *pad, GstPadGetRangeFunction get);
844 void gst_pad_set_checkgetrange_function (GstPad *pad, GstPadCheckGetRangeFunction check);
845 void gst_pad_set_event_function (GstPad *pad, GstPadEventFunction event);
848 void gst_pad_set_link_function (GstPad *pad, GstPadLinkFunction link);
849 void gst_pad_set_unlink_function (GstPad *pad, GstPadUnlinkFunction unlink);
851 GstPadLinkReturn gst_pad_link (GstPad *srcpad, GstPad *sinkpad);
852 gboolean gst_pad_unlink (GstPad *srcpad, GstPad *sinkpad);
853 gboolean gst_pad_is_linked (GstPad *pad);
855 GstPad* gst_pad_get_peer (GstPad *pad);
857 /* capsnego functions */
858 void gst_pad_set_getcaps_function (GstPad *pad, GstPadGetCapsFunction getcaps);
859 void gst_pad_set_acceptcaps_function (GstPad *pad, GstPadAcceptCapsFunction acceptcaps);
860 void gst_pad_set_fixatecaps_function (GstPad *pad, GstPadFixateCapsFunction fixatecaps);
861 void gst_pad_set_setcaps_function (GstPad *pad, GstPadSetCapsFunction setcaps);
863 G_CONST_RETURN GstCaps* gst_pad_get_pad_template_caps (GstPad *pad);
865 /* capsnego function for linked/unlinked pads */
866 GstCaps * gst_pad_get_caps (GstPad * pad);
867 void gst_pad_fixate_caps (GstPad * pad, GstCaps *caps);
868 gboolean gst_pad_accept_caps (GstPad * pad, GstCaps *caps);
869 gboolean gst_pad_set_caps (GstPad * pad, GstCaps *caps);
871 GstCaps * gst_pad_peer_get_caps (GstPad * pad);
872 gboolean gst_pad_peer_accept_caps (GstPad * pad, GstCaps *caps);
874 /* capsnego for linked pads */
875 GstCaps * gst_pad_get_allowed_caps (GstPad * pad);
876 GstCaps * gst_pad_get_negotiated_caps (GstPad * pad);
878 /* data passing functions to peer */
879 GstFlowReturn gst_pad_push (GstPad *pad, GstBuffer *buffer);
880 gboolean gst_pad_check_pull_range (GstPad *pad);
881 GstFlowReturn gst_pad_pull_range (GstPad *pad, guint64 offset, guint size,
883 gboolean gst_pad_push_event (GstPad *pad, GstEvent *event);
884 gboolean gst_pad_event_default (GstPad *pad, GstEvent *event);
886 /* data passing functions on pad */
887 GstFlowReturn gst_pad_chain (GstPad *pad, GstBuffer *buffer);
888 GstFlowReturn gst_pad_get_range (GstPad *pad, guint64 offset, guint size,
890 gboolean gst_pad_send_event (GstPad *pad, GstEvent *event);
893 gboolean gst_pad_start_task (GstPad *pad, GstTaskFunction func,
895 gboolean gst_pad_pause_task (GstPad *pad);
896 gboolean gst_pad_stop_task (GstPad *pad);
899 void gst_pad_set_internal_link_function (GstPad *pad, GstPadIntLinkFunction intlink);
900 GList* gst_pad_get_internal_links (GstPad *pad);
901 GList* gst_pad_get_internal_links_default (GstPad *pad);
903 void gst_pad_set_iterate_internal_links_function (GstPad * pad,
904 GstPadIterIntLinkFunction iterintlink);
905 GstIterator * gst_pad_iterate_internal_links (GstPad * pad);
906 GstIterator * gst_pad_iterate_internal_links_default (GstPad * pad);
909 /* generic query function */
910 void gst_pad_set_query_type_function (GstPad *pad, GstPadQueryTypeFunction type_func);
911 G_CONST_RETURN GstQueryType*
912 gst_pad_get_query_types (GstPad *pad);
913 G_CONST_RETURN GstQueryType*
914 gst_pad_get_query_types_default (GstPad *pad);
916 gboolean gst_pad_query (GstPad *pad, GstQuery *query);
917 gboolean gst_pad_peer_query (GstPad *pad, GstQuery *query);
918 void gst_pad_set_query_function (GstPad *pad, GstPadQueryFunction query);
919 gboolean gst_pad_query_default (GstPad *pad, GstQuery *query);
921 /* misc helper functions */
922 gboolean gst_pad_dispatcher (GstPad *pad, GstPadDispatcherFunction dispatch,
925 #ifndef GST_DISABLE_LOADSAVE
926 void gst_pad_load_and_link (xmlNodePtr self, GstObject *parent);
931 #endif /* __GST_PAD_H__ */