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 typedef struct _GstPad GstPad;
30 typedef struct _GstPadPrivate GstPadPrivate;
31 typedef struct _GstPadClass GstPadClass;
35 * @GST_PAD_UNKNOWN: direction is unknown.
36 * @GST_PAD_SRC: the pad is a source pad.
37 * @GST_PAD_SINK: the pad is a sink pad.
39 * The direction of a pad.
47 #include <gst/gstobject.h>
48 #include <gst/gstbuffer.h>
49 #include <gst/gstbufferlist.h>
50 #include <gst/gstcaps.h>
51 #include <gst/gstpadtemplate.h>
52 #include <gst/gstevent.h>
53 #include <gst/gstquery.h>
54 #include <gst/gsttask.h>
61 #define GST_TYPE_PAD (gst_pad_get_type ())
62 #define GST_IS_PAD(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD))
63 #define GST_IS_PAD_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
64 #define GST_PAD(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD, GstPad))
65 #define GST_PAD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD, GstPadClass))
66 #define GST_PAD_CAST(obj) ((GstPad*)(obj))
72 * @GST_PAD_LINK_OK : link succeeded
73 * @GST_PAD_LINK_WRONG_HIERARCHY: pads have no common grandparent
74 * @GST_PAD_LINK_WAS_LINKED : pad was already linked
75 * @GST_PAD_LINK_WRONG_DIRECTION: pads have wrong direction
76 * @GST_PAD_LINK_NOFORMAT : pads do not have common format
77 * @GST_PAD_LINK_NOSCHED : pads cannot cooperate in scheduling
78 * @GST_PAD_LINK_REFUSED : refused for some reason
80 * Result values from gst_pad_link and friends.
84 GST_PAD_LINK_WRONG_HIERARCHY = -1,
85 GST_PAD_LINK_WAS_LINKED = -2,
86 GST_PAD_LINK_WRONG_DIRECTION = -3,
87 GST_PAD_LINK_NOFORMAT = -4,
88 GST_PAD_LINK_NOSCHED = -5,
89 GST_PAD_LINK_REFUSED = -6
93 * GST_PAD_LINK_FAILED:
94 * @ret: the #GstPadLinkReturn value
96 * Macro to test if the given #GstPadLinkReturn value indicates a failed
99 #define GST_PAD_LINK_FAILED(ret) ((ret) < GST_PAD_LINK_OK)
102 * GST_PAD_LINK_SUCCESSFUL:
103 * @ret: the #GstPadLinkReturn value
105 * Macro to test if the given #GstPadLinkReturn value indicates a successful
108 #define GST_PAD_LINK_SUCCESSFUL(ret) ((ret) >= GST_PAD_LINK_OK)
112 * @GST_FLOW_RESEND: Resend buffer, possibly with new caps (not
113 * sent yet) (unused/unimplemented).
114 * @GST_FLOW_OK: Data passing was ok.
115 * @GST_FLOW_NOT_LINKED: Pad is not linked.
116 * @GST_FLOW_WRONG_STATE: Pad is in wrong state.
117 * @GST_FLOW_UNEXPECTED: Did not expect anything, like after EOS.
118 * @GST_FLOW_NOT_NEGOTIATED: Pad is not negotiated.
119 * @GST_FLOW_ERROR: Some (fatal) error occured. Element generating
120 * this error should post an error message with more
122 * @GST_FLOW_NOT_SUPPORTED: This operation is not supported.
123 * @GST_FLOW_CUSTOM_SUCCESS: Elements can use values starting from
124 * this (and higher) to define custom success
125 * codes. Since 0.10.7.
126 * @GST_FLOW_CUSTOM_SUCCESS_1: Pre-defined custom success code (define your
127 * custom success code to this to avoid compiler
128 * warnings). Since 0.10.29.
129 * @GST_FLOW_CUSTOM_SUCCESS_2: Pre-defined custom success code. Since 0.10.29.
130 * @GST_FLOW_CUSTOM_ERROR: Elements can use values starting from
131 * this (and lower) to define custom error codes.
133 * @GST_FLOW_CUSTOM_ERROR_1: Pre-defined custom error code (define your
134 * custom error code to this to avoid compiler
135 * warnings). Since 0.10.29.
136 * @GST_FLOW_CUSTOM_ERROR_2: Pre-defined custom error code. Since 0.10.29.
138 * The result of passing data to a pad.
140 * Note that the custom return values should not be exposed outside of the
141 * element scope and are available since 0.10.7.
143 /* FIXME 0.11: remove custom flow returns */
145 /* custom success starts here */
146 GST_FLOW_CUSTOM_SUCCESS_2 = 102,
147 GST_FLOW_CUSTOM_SUCCESS_1 = 101,
148 GST_FLOW_CUSTOM_SUCCESS = 100,
150 /* core predefined */
153 /* expected failures */
154 GST_FLOW_NOT_LINKED = -1,
155 GST_FLOW_WRONG_STATE = -2,
157 GST_FLOW_UNEXPECTED = -3,
158 GST_FLOW_NOT_NEGOTIATED = -4,
160 GST_FLOW_NOT_SUPPORTED = -6,
162 /* custom error starts here */
163 GST_FLOW_CUSTOM_ERROR = -100,
164 GST_FLOW_CUSTOM_ERROR_1 = -101,
165 GST_FLOW_CUSTOM_ERROR_2 = -102
168 G_CONST_RETURN gchar* gst_flow_get_name (GstFlowReturn ret);
169 GQuark gst_flow_to_quark (GstFlowReturn ret);
173 * @GST_PAD_LINK_CHECK_NOTHING: Don't check hierarchy or caps compatibility.
174 * @GST_PAD_LINK_CHECK_HIERARCHY: Check the pads have same parents/grandparents.
175 * Could be omitted if it is already known that the two elements that own the
176 * pads are in the same bin.
177 * @GST_PAD_LINK_CHECK_TEMPLATE_CAPS: Check if the pads are compatible by using
178 * their template caps. This is much faster than @GST_PAD_LINK_CHECK_CAPS, but
179 * would be unsafe e.g. if one pad has %GST_CAPS_ANY.
180 * @GST_PAD_LINK_CHECK_CAPS: Check if the pads are compatible by comparing the
181 * caps returned by gst_pad_get_caps().
183 * The amount of checking to be done when linking pads. @GST_PAD_LINK_CHECK_CAPS
184 * and @GST_PAD_LINK_CHECK_TEMPLATE_CAPS are mutually exclusive. If both are
185 * specified, expensive but safe @GST_PAD_LINK_CHECK_CAPS are performed.
188 * Only disable some of the checks if you are 100% certain you know the link
189 * will not fail because of hierarchy/caps compatibility failures. If uncertain,
190 * use the default checks (%GST_PAD_LINK_CHECK_DEFAULT) or the regular methods
191 * for linking the pads.
198 GST_PAD_LINK_CHECK_NOTHING = 0,
199 GST_PAD_LINK_CHECK_HIERARCHY = 1 << 0,
200 GST_PAD_LINK_CHECK_TEMPLATE_CAPS = 1 << 1,
201 GST_PAD_LINK_CHECK_CAPS = 1 << 2
205 * GST_PAD_LINK_CHECK_DEFAULT:
207 * The default checks done when linking pads (i.e. the ones used by
212 #define GST_PAD_LINK_CHECK_DEFAULT (GST_PAD_LINK_CHECK_HIERARCHY | GST_PAD_LINK_CHECK_CAPS)
216 * @GST_ACTIVATE_NONE: Pad will not handle dataflow
217 * @GST_ACTIVATE_PUSH: Pad handles dataflow in downstream push mode
218 * @GST_ACTIVATE_PULL: Pad handles dataflow in upstream pull mode
220 * The status of a GstPad. After activating a pad, which usually happens when the
221 * parent element goes from READY to PAUSED, the GstActivateMode defines if the
222 * pad operates in push or pull mode.
231 * GST_PAD_MODE_ACTIVATE:
232 * @mode: a #GstActivateMode
234 * Macro to test if the given #GstActivateMode value indicates that datapassing
235 * is possible or not.
237 #define GST_PAD_MODE_ACTIVATE(mode) ((mode) != GST_ACTIVATE_NONE)
241 * GstPadActivateFunction:
244 * This function is called when the pad is activated during the element
245 * READY to PAUSED state change. By default this function will call the
246 * activate function that puts the pad in push mode but elements can
247 * override this function to activate the pad in pull mode if they wish.
249 * Returns: TRUE if the pad could be activated.
251 typedef gboolean (*GstPadActivateFunction) (GstPad *pad);
253 * GstPadActivateModeFunction:
255 * @active: activate or deactivate the pad.
257 * The prototype of the push and pull activate functions.
259 * Returns: TRUE if the pad could be activated or deactivated.
261 typedef gboolean (*GstPadActivateModeFunction) (GstPad *pad, gboolean active);
266 * GstPadChainFunction:
267 * @pad: the sink #GstPad that performed the chain.
268 * @buffer: the #GstBuffer that is chained, not %NULL.
270 * A function that will be called on sinkpads when chaining buffers.
271 * The function typically processes the data contained in the buffer and
272 * either consumes the data or passes it on to the internally linked pad(s).
274 * The implementer of this function receives a refcount to @buffer and should
275 * gst_buffer_unref() when the buffer is no longer needed.
277 * When a chain function detects an error in the data stream, it must post an
278 * error on the bus and return an appropriate #GstFlowReturn value.
280 * Returns: #GST_FLOW_OK for success
282 typedef GstFlowReturn (*GstPadChainFunction) (GstPad *pad, GstBuffer *buffer);
285 * GstPadChainListFunction:
286 * @pad: the sink #GstPad that performed the chain.
287 * @list: the #GstBufferList that is chained, not %NULL.
289 * A function that will be called on sinkpads when chaining buffer lists.
290 * The function typically processes the data contained in the buffer list and
291 * either consumes the data or passes it on to the internally linked pad(s).
293 * The implementer of this function receives a refcount to @list and
294 * should gst_buffer_list_unref() when the list is no longer needed.
296 * When a chainlist function detects an error in the data stream, it must
297 * post an error on the bus and return an appropriate #GstFlowReturn value.
299 * Returns: #GST_FLOW_OK for success
301 typedef GstFlowReturn (*GstPadChainListFunction) (GstPad *pad, GstBufferList *list);
304 * GstPadGetRangeFunction:
305 * @pad: the src #GstPad to perform the getrange on.
306 * @offset: the offset of the range
307 * @length: the length of the range
308 * @buffer: a memory location to hold the result buffer, cannot be NULL.
310 * This function will be called on source pads when a peer element
311 * request a buffer at the specified @offset and @length. If this function
312 * returns #GST_FLOW_OK, the result buffer will be stored in @buffer. The
313 * contents of @buffer is invalid for any other return value.
315 * This function is installed on a source pad with
316 * gst_pad_set_getrange_function() and can only be called on source pads after
317 * they are successfully activated with gst_pad_activate_pull().
319 * @offset and @length are always given in byte units. @offset must normally be a value
320 * between 0 and the length in bytes of the data available on @pad. The
321 * length (duration in bytes) can be retrieved with a #GST_QUERY_DURATION or with a
322 * #GST_QUERY_SEEKING.
324 * Any @offset larger or equal than the length will make the function return
325 * #GST_FLOW_UNEXPECTED, which corresponds to EOS. In this case @buffer does not
326 * contain a valid buffer.
328 * The buffer size of @buffer will only be smaller than @length when @offset is
329 * near the end of the stream. In all other cases, the size of @buffer must be
330 * exactly the requested size.
332 * It is allowed to call this function with a 0 @length and valid @offset, in
333 * which case @buffer will contain a 0-sized buffer and the function returns
336 * When this function is called with a -1 @offset, the sequentially next buffer
337 * of length @length in the stream is returned.
339 * When this function is called with a -1 @length, a buffer with a default
340 * optimal length is returned in @buffer. The length might depend on the value
343 * Returns: #GST_FLOW_OK for success and a valid buffer in @buffer. Any other
344 * return value leaves @buffer undefined.
346 typedef GstFlowReturn (*GstPadGetRangeFunction) (GstPad *pad, guint64 offset,
347 guint length, GstBuffer **buffer);
350 * GstPadEventFunction:
351 * @pad: the #GstPad to handle the event.
352 * @event: the #GstEvent to handle.
354 * Function signature to handle an event for the pad.
356 * Returns: TRUE if the pad could handle the event.
358 typedef gboolean (*GstPadEventFunction) (GstPad *pad, GstEvent *event);
363 * GstPadIterIntLinkFunction:
364 * @pad: The #GstPad to query.
366 * The signature of the internal pad link iterator function.
368 * Returns: a new #GstIterator that will iterate over all pads that are
369 * linked to the given pad on the inside of the parent element.
371 * the caller must call gst_iterator_free() after usage.
375 typedef GstIterator* (*GstPadIterIntLinkFunction) (GstPad *pad);
377 /* generic query function */
379 * GstPadQueryTypeFunction:
380 * @pad: a #GstPad to query
382 * The signature of the query types function.
384 * Returns: a constant array of query types
386 typedef const GstQueryType* (*GstPadQueryTypeFunction) (GstPad *pad);
389 * GstPadQueryFunction:
390 * @pad: the #GstPad to query.
391 * @query: the #GstQuery object to execute
393 * The signature of the query function.
395 * Returns: TRUE if the query could be performed.
397 typedef gboolean (*GstPadQueryFunction) (GstPad *pad, GstQuery *query);
403 * @pad: the #GstPad that is linked.
404 * @peer: the peer #GstPad of the link
406 * Function signature to handle a new link on the pad.
408 * Returns: the result of the link with the specified peer.
410 typedef GstPadLinkReturn (*GstPadLinkFunction) (GstPad *pad, GstPad *peer);
412 * GstPadUnlinkFunction
413 * @pad: the #GstPad that is linked.
415 * Function signature to handle a unlinking the pad prom its peer.
417 typedef void (*GstPadUnlinkFunction) (GstPad *pad);
422 * GstPadGetCapsFunction:
423 * @pad: the #GstPad to get the capabilities of.
424 * @filter: filter #GstCaps.
426 * When called on sinkpads @filter contains the caps that
427 * upstream could produce in the order preferred by upstream. When
428 * called on srcpads @filter contains the caps accepted by
429 * downstream in the preffered order. @filter might be %NULL but if
430 * it is not %NULL only a subset of @filter must be returned.
432 * Returns a copy of the capabilities of the specified pad. By default this
433 * function will return the pad template capabilities, but can optionally
434 * be overridden by elements.
436 * Returns: a newly allocated copy #GstCaps of the pad.
438 typedef GstCaps* (*GstPadGetCapsFunction) (GstPad *pad, GstCaps *filter);
441 * GstPadSetCapsFunction:
442 * @pad: the #GstPad to set the capabilities of.
443 * @caps: the #GstCaps to set
445 * Set @caps on @pad. By default this function updates the caps of the
446 * pad but the function can be overriden by elements to perform extra
447 * actions or verifications.
449 * Returns: TRUE if the caps could be set on the pad.
451 typedef gboolean (*GstPadSetCapsFunction) (GstPad *pad, GstCaps *caps);
453 * GstPadAcceptCapsFunction:
454 * @pad: the #GstPad to check
455 * @caps: the #GstCaps to check
457 * Check if @pad can accept @caps. By default this function will see if @caps
458 * intersect with the result from gst_pad_get_caps() by can be overridden to
459 * perform extra checks.
461 * Returns: TRUE if the caps can be accepted by the pad.
463 typedef gboolean (*GstPadAcceptCapsFunction) (GstPad *pad, GstCaps *caps);
465 * GstPadFixateCapsFunction:
467 * @caps: the #GstCaps to fixate
469 * Given possibly unfixed caps @caps, let @pad use its default prefered
470 * format to make a fixed caps. @caps should be writable. By default this
471 * function will pick the first value of any ranges or lists in the caps but
472 * elements can override this function to perform other behaviour.
474 typedef void (*GstPadFixateCapsFunction) (GstPad *pad, GstCaps *caps);
478 * GstPadForwardFunction:
479 * @pad: the #GstPad that is forwarded.
480 * @user_data: the gpointer to optional user data.
482 * A forward function is called for all internally linked pads, see
485 * Returns: TRUE if the dispatching procedure has to be stopped.
487 typedef gboolean (*GstPadForwardFunction) (GstPad *pad, gpointer user_data);
491 * @GST_PROBE_TYPE_INVALID: invalid probe type
492 * @GST_PROBE_TYPE_IDLE: probe idle pads and block
493 * @GST_PROBE_TYPE_BLOCK: probe and block pads
494 * @GST_PROBE_TYPE_BUFFER: probe buffers
495 * @GST_PROBE_TYPE_BUFFER_LIST: probe buffer lists
496 * @GST_PROBE_TYPE_EVENT: probe events
497 * @GST_PROBE_TYPE_PUSH: probe push
498 * @GST_PROBE_TYPE_PULL: probe pull
500 * The different probing types that can occur. When either one of
501 * @GST_PROBE_TYPE_IDLE or @GST_PROBE_TYPE_BLOCK is used, the probe will be a
506 GST_PROBE_TYPE_INVALID = 0,
507 /* flags to control blocking */
508 GST_PROBE_TYPE_IDLE = (1 << 0),
509 GST_PROBE_TYPE_BLOCK = (1 << 1),
510 /* flags to select datatypes */
511 GST_PROBE_TYPE_BUFFER = (1 << 2),
512 GST_PROBE_TYPE_BUFFER_LIST = (1 << 3),
513 GST_PROBE_TYPE_EVENT = (1 << 4),
514 /* flags to select scheduling mode */
515 GST_PROBE_TYPE_PUSH = (1 << 5),
516 GST_PROBE_TYPE_PULL = (1 << 6),
519 #define GST_PROBE_TYPE_BLOCKING (GST_PROBE_TYPE_IDLE | GST_PROBE_TYPE_BLOCK)
520 #define GST_PROBE_TYPE_DATA (GST_PROBE_TYPE_BUFFER | GST_PROBE_TYPE_EVENT | \
521 GST_PROBE_TYPE_BUFFER_LIST)
522 #define GST_PROBE_TYPE_SCHEDULING (GST_PROBE_TYPE_PUSH | GST_PROBE_TYPE_PULL)
526 * @GST_PROBE_OK: normal probe return value
527 * @GST_PROBE_DROP: drop data in data probes
528 * @GST_PROBE_REMOVE: remove probe
529 * @GST_PROBE_PASS: pass the data item in the block probe and block on
532 * Different return values for the #GstPadProbeCallback.
543 * GstPadProbeCallback
544 * @pad: the #GstPad that is blocked
545 * @type: the current probe type
546 * @type_data: type specific data
547 * @user_data: the gpointer to optional user data.
549 * Callback used by gst_pad_add_probe(). Gets called to notify about the current
552 typedef GstProbeReturn (*GstPadProbeCallback) (GstPad *pad, GstProbeType type,
553 gpointer type_data, gpointer user_data);
556 * GstPadStickyEventsForeachFunction:
558 * @event: the sticky #GstEvent.
559 * @user_data: the #gpointer to optional user data.
561 * Callback used by gst_pad_sticky_events_foreach().
563 * Returns: GST_FLOW_OK if the iteration should continue
565 typedef GstFlowReturn (*GstPadStickyEventsForeachFunction) (GstPad *pad, GstEvent *event, gpointer user_data);
569 * @GST_PAD_BLOCKED: is dataflow on a pad blocked
570 * @GST_PAD_FLUSHING: is pad refusing buffers
571 * @GST_PAD_IN_GETCAPS: GstPadGetCapsFunction() is running now
572 * @GST_PAD_IN_SETCAPS: GstPadSetCapsFunction() is running now
573 * @GST_PAD_BLOCKING: is pad currently blocking on a buffer or event
574 * @GST_PAD_NEED_RECONFIGURE: the pad should be reconfigured/renegotiated.
575 * The flag has to be unset manually after
576 * reconfiguration happened.
578 * @GST_PAD_NEED_EVENTS: the pad has pending events
579 * @GST_PAD_FIXED_CAPS: the pad is using fixed caps this means that once the
580 * caps are set on the pad, the getcaps function only
581 * returns those caps.
582 * @GST_PAD_FLAG_LAST: offset to define more flags
587 GST_PAD_BLOCKED = (GST_OBJECT_FLAG_LAST << 0),
588 GST_PAD_FLUSHING = (GST_OBJECT_FLAG_LAST << 1),
589 GST_PAD_IN_GETCAPS = (GST_OBJECT_FLAG_LAST << 2),
590 GST_PAD_IN_SETCAPS = (GST_OBJECT_FLAG_LAST << 3),
591 GST_PAD_BLOCKING = (GST_OBJECT_FLAG_LAST << 4),
592 GST_PAD_NEED_RECONFIGURE = (GST_OBJECT_FLAG_LAST << 5),
593 GST_PAD_NEED_EVENTS = (GST_OBJECT_FLAG_LAST << 6),
594 GST_PAD_FIXED_CAPS = (GST_OBJECT_FLAG_LAST << 7),
596 GST_PAD_FLAG_LAST = (GST_OBJECT_FLAG_LAST << 16)
601 * @element_private: private data owned by the parent element
602 * @padtemplate: padtemplate for this pad
603 * @direction: the direction of the pad, cannot change after creating
605 * @stream_rec_lock: recursive stream lock of the pad, used to protect
606 * the data used in streaming.
607 * @task: task for this pad if the pad is actively driving dataflow.
608 * @block_cond: conditional to signal pad block
609 * @getcapsfunc: function to get caps of the pad
610 * @setcapsfunc: function to set caps on the pad
611 * @acceptcapsfunc: function to check if pad can accept caps
612 * @fixatecapsfunc: function to fixate caps
613 * @activatefunc: pad activation function
614 * @activatepushfunc: function to activate/deactivate pad in push mode
615 * @activatepullfunc: function to activate/deactivate pad in pull mode
616 * @linkfunc: function called when pad is linked
617 * @unlinkfunc: function called when pad is unlinked
618 * @peer: the pad this pad is linked to
619 * @chainfunc: function to chain buffer to pad
620 * @getrangefunc: function to get a range of data from a pad
621 * @eventfunc: function to send an event to a pad
622 * @mode: current activation mode of the pad
623 * @querytypefunc: get list of supported queries
624 * @queryfunc: perform a query on the pad
625 * @iterintlinkfunc: get the internal links iterator of this pad
627 * The #GstPad structure. Use the functions to update the variables.
633 gpointer element_private;
635 GstPadTemplate *padtemplate;
637 GstPadDirection direction;
639 /*< public >*/ /* with STREAM_LOCK */
640 /* streaming rec_lock */
641 GStaticRecMutex stream_rec_lock;
644 /*< public >*/ /* with LOCK */
645 /* block cond, mutex is from the object */
649 /* the pad capabilities */
650 GstPadGetCapsFunction getcapsfunc;
651 GstPadSetCapsFunction setcapsfunc;
652 GstPadAcceptCapsFunction acceptcapsfunc;
653 GstPadFixateCapsFunction fixatecapsfunc;
655 GstActivateMode mode;
656 GstPadActivateFunction activatefunc;
657 GstPadActivateModeFunction activatepushfunc;
658 GstPadActivateModeFunction activatepullfunc;
662 GstPadLinkFunction linkfunc;
663 GstPadUnlinkFunction unlinkfunc;
665 /* data transport functions */
666 GstPadChainFunction chainfunc;
667 GstPadChainListFunction chainlistfunc;
668 GstPadGetRangeFunction getrangefunc;
669 GstPadEventFunction eventfunc;
674 /* generic query method */
675 GstPadQueryTypeFunction querytypefunc;
676 GstPadQueryFunction queryfunc;
679 GstPadIterIntLinkFunction iterintlinkfunc;
681 /* counts number of probes attached. */
688 gpointer _gst_reserved[GST_PADDING];
691 struct _GstPadClass {
692 GstObjectClass parent_class;
694 /* signal callbacks */
695 void (*linked) (GstPad *pad, GstPad *peer);
696 void (*unlinked) (GstPad *pad, GstPad *peer);
699 gpointer _gst_reserved[GST_PADDING];
703 /***** helper macros *****/
705 #define GST_PAD_NAME(pad) (GST_OBJECT_NAME(pad))
706 #define GST_PAD_PARENT(pad) (GST_ELEMENT_CAST(GST_OBJECT_PARENT(pad)))
707 #define GST_PAD_ELEMENT_PRIVATE(pad) (GST_PAD_CAST(pad)->element_private)
708 #define GST_PAD_PAD_TEMPLATE(pad) (GST_PAD_CAST(pad)->padtemplate)
709 #define GST_PAD_DIRECTION(pad) (GST_PAD_CAST(pad)->direction)
710 #define GST_PAD_TASK(pad) (GST_PAD_CAST(pad)->task)
711 #define GST_PAD_ACTIVATE_MODE(pad) (GST_PAD_CAST(pad)->mode)
713 #define GST_PAD_ACTIVATEFUNC(pad) (GST_PAD_CAST(pad)->activatefunc)
714 #define GST_PAD_ACTIVATEPUSHFUNC(pad) (GST_PAD_CAST(pad)->activatepushfunc)
715 #define GST_PAD_ACTIVATEPULLFUNC(pad) (GST_PAD_CAST(pad)->activatepullfunc)
716 #define GST_PAD_CHAINFUNC(pad) (GST_PAD_CAST(pad)->chainfunc)
717 #define GST_PAD_CHAINLISTFUNC(pad) (GST_PAD_CAST(pad)->chainlistfunc)
718 #define GST_PAD_GETRANGEFUNC(pad) (GST_PAD_CAST(pad)->getrangefunc)
719 #define GST_PAD_EVENTFUNC(pad) (GST_PAD_CAST(pad)->eventfunc)
720 #define GST_PAD_QUERYTYPEFUNC(pad) (GST_PAD_CAST(pad)->querytypefunc)
721 #define GST_PAD_QUERYFUNC(pad) (GST_PAD_CAST(pad)->queryfunc)
722 #define GST_PAD_ITERINTLINKFUNC(pad) (GST_PAD_CAST(pad)->iterintlinkfunc)
724 #define GST_PAD_PEER(pad) (GST_PAD_CAST(pad)->peer)
725 #define GST_PAD_LINKFUNC(pad) (GST_PAD_CAST(pad)->linkfunc)
726 #define GST_PAD_UNLINKFUNC(pad) (GST_PAD_CAST(pad)->unlinkfunc)
728 #define GST_PAD_GETCAPSFUNC(pad) (GST_PAD_CAST(pad)->getcapsfunc)
729 #define GST_PAD_SETCAPSFUNC(pad) (GST_PAD_CAST(pad)->setcapsfunc)
730 #define GST_PAD_ACCEPTCAPSFUNC(pad) (GST_PAD_CAST(pad)->acceptcapsfunc)
731 #define GST_PAD_FIXATECAPSFUNC(pad) (GST_PAD_CAST(pad)->fixatecapsfunc)
733 #define GST_PAD_IS_SRC(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SRC)
734 #define GST_PAD_IS_SINK(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SINK)
736 #define GST_PAD_IS_LINKED(pad) (GST_PAD_PEER(pad) != NULL)
738 #define GST_PAD_IS_BLOCKED(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_BLOCKED))
739 #define GST_PAD_IS_BLOCKING(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_BLOCKING))
740 #define GST_PAD_IS_FLUSHING(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLUSHING))
741 #define GST_PAD_IS_IN_GETCAPS(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_IN_GETCAPS))
742 #define GST_PAD_IS_IN_SETCAPS(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_IN_SETCAPS))
743 #define GST_PAD_NEEDS_RECONFIGURE(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_NEED_RECONFIGURE))
744 #define GST_PAD_NEEDS_EVENTS(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_NEED_EVENTS))
745 #define GST_PAD_IS_FIXED_CAPS(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FIXED_CAPS))
747 #define GST_PAD_SET_FLUSHING(pad) (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLUSHING))
748 #define GST_PAD_UNSET_FLUSHING(pad) (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLUSHING))
751 * GST_PAD_GET_STREAM_LOCK:
754 * Get the stream lock of @pad. The stream lock is protecting the
755 * resources used in the data processing functions of @pad.
757 #define GST_PAD_GET_STREAM_LOCK(pad) (&(GST_PAD_CAST(pad)->stream_rec_lock))
759 * GST_PAD_STREAM_LOCK:
762 * Lock the stream lock of @pad.
764 #define GST_PAD_STREAM_LOCK(pad) (g_static_rec_mutex_lock(GST_PAD_GET_STREAM_LOCK(pad)))
766 * GST_PAD_STREAM_LOCK_FULL:
768 * @t: the number of times to recursively lock
770 * Lock the stream lock of @pad @t times.
772 #define GST_PAD_STREAM_LOCK_FULL(pad,t) (g_static_rec_mutex_lock_full(GST_PAD_GET_STREAM_LOCK(pad), t))
774 * GST_PAD_STREAM_TRYLOCK:
777 * Try to Lock the stream lock of the pad, return TRUE if the lock could be
780 #define GST_PAD_STREAM_TRYLOCK(pad) (g_static_rec_mutex_trylock(GST_PAD_GET_STREAM_LOCK(pad)))
782 * GST_PAD_STREAM_UNLOCK:
785 * Unlock the stream lock of @pad.
787 #define GST_PAD_STREAM_UNLOCK(pad) (g_static_rec_mutex_unlock(GST_PAD_GET_STREAM_LOCK(pad)))
789 * GST_PAD_STREAM_UNLOCK_FULL:
792 * Fully unlock the recursive stream lock of @pad, return the number of times
795 #define GST_PAD_STREAM_UNLOCK_FULL(pad) (g_static_rec_mutex_unlock_full(GST_PAD_GET_STREAM_LOCK(pad)))
797 #define GST_PAD_BLOCK_GET_COND(pad) (GST_PAD_CAST(pad)->block_cond)
798 #define GST_PAD_BLOCK_WAIT(pad) (g_cond_wait(GST_PAD_BLOCK_GET_COND (pad), GST_OBJECT_GET_LOCK (pad)))
799 #define GST_PAD_BLOCK_SIGNAL(pad) (g_cond_signal(GST_PAD_BLOCK_GET_COND (pad)))
800 #define GST_PAD_BLOCK_BROADCAST(pad) (g_cond_broadcast(GST_PAD_BLOCK_GET_COND (pad)))
802 /* FIXME: this awful circular dependency need to be resolved properly (see padtemplate.h) */
803 #include <gst/gstpadtemplate.h>
805 GType gst_pad_get_type (void);
808 GstPad* gst_pad_new (const gchar *name, GstPadDirection direction);
809 GstPad* gst_pad_new_from_template (GstPadTemplate *templ, const gchar *name);
810 GstPad* gst_pad_new_from_static_template (GstStaticPadTemplate *templ, const gchar *name);
815 * @pad: the pad to get the name from
817 * Get a copy of the name of the pad. g_free() after usage.
821 #define gst_pad_get_name(pad) gst_object_get_name (GST_OBJECT_CAST (pad))
823 * gst_pad_get_parent:
824 * @pad: the pad to get the parent of
826 * Get the parent of @pad. This function increases the refcount
827 * of the parent object so you should gst_object_unref() it after usage.
828 * Can return NULL if the pad did not have a parent.
832 #define gst_pad_get_parent(pad) gst_object_get_parent (GST_OBJECT_CAST (pad))
834 GstPadDirection gst_pad_get_direction (GstPad *pad);
836 gboolean gst_pad_set_active (GstPad *pad, gboolean active);
837 gboolean gst_pad_is_active (GstPad *pad);
838 gboolean gst_pad_activate_pull (GstPad *pad, gboolean active);
839 gboolean gst_pad_activate_push (GstPad *pad, gboolean active);
841 gulong gst_pad_add_probe (GstPad *pad,
843 GstPadProbeCallback callback,
845 GDestroyNotify destroy_data);
846 void gst_pad_remove_probe (GstPad *pad, gulong id);
848 gboolean gst_pad_is_blocked (GstPad *pad);
849 gboolean gst_pad_is_blocking (GstPad *pad);
851 void gst_pad_set_element_private (GstPad *pad, gpointer priv);
852 gpointer gst_pad_get_element_private (GstPad *pad);
854 GstPadTemplate* gst_pad_get_pad_template (GstPad *pad);
856 GstEvent* gst_pad_get_sticky_event (GstPad *pad, GstEventType event_type);
857 GstFlowReturn gst_pad_sticky_events_foreach (GstPad *pad, GstPadStickyEventsForeachFunction foreach_func, gpointer user_data);
859 /* data passing setup functions */
860 void gst_pad_set_activate_function (GstPad *pad, GstPadActivateFunction activate);
861 void gst_pad_set_activatepull_function (GstPad *pad, GstPadActivateModeFunction activatepull);
862 void gst_pad_set_activatepush_function (GstPad *pad, GstPadActivateModeFunction activatepush);
863 void gst_pad_set_chain_function (GstPad *pad, GstPadChainFunction chain);
864 void gst_pad_set_chain_list_function (GstPad *pad, GstPadChainListFunction chainlist);
865 void gst_pad_set_getrange_function (GstPad *pad, GstPadGetRangeFunction get);
866 void gst_pad_set_event_function (GstPad *pad, GstPadEventFunction event);
869 void gst_pad_set_link_function (GstPad *pad, GstPadLinkFunction link);
870 void gst_pad_set_unlink_function (GstPad *pad, GstPadUnlinkFunction unlink);
872 gboolean gst_pad_can_link (GstPad *srcpad, GstPad *sinkpad);
873 GstPadLinkReturn gst_pad_link (GstPad *srcpad, GstPad *sinkpad);
874 GstPadLinkReturn gst_pad_link_full (GstPad *srcpad, GstPad *sinkpad, GstPadLinkCheck flags);
875 gboolean gst_pad_unlink (GstPad *srcpad, GstPad *sinkpad);
876 gboolean gst_pad_is_linked (GstPad *pad);
878 GstPad* gst_pad_get_peer (GstPad *pad);
880 /* capsnego functions */
881 void gst_pad_set_getcaps_function (GstPad *pad, GstPadGetCapsFunction getcaps);
882 void gst_pad_set_acceptcaps_function (GstPad *pad, GstPadAcceptCapsFunction acceptcaps);
883 void gst_pad_set_fixatecaps_function (GstPad *pad, GstPadFixateCapsFunction fixatecaps);
884 void gst_pad_set_setcaps_function (GstPad *pad, GstPadSetCapsFunction setcaps);
886 GstCaps* gst_pad_get_pad_template_caps (GstPad *pad);
888 /* capsnego function for linked/unlinked pads */
889 GstCaps * gst_pad_get_current_caps (GstPad * pad);
890 gboolean gst_pad_has_current_caps (GstPad * pad);
891 GstCaps * gst_pad_get_caps (GstPad * pad, GstCaps *filter);
892 void gst_pad_fixate_caps (GstPad * pad, GstCaps *caps);
893 gboolean gst_pad_accept_caps (GstPad * pad, GstCaps *caps);
894 gboolean gst_pad_set_caps (GstPad * pad, GstCaps *caps);
896 GstCaps * gst_pad_peer_get_caps (GstPad * pad, GstCaps *filter);
897 gboolean gst_pad_peer_accept_caps (GstPad * pad, GstCaps *caps);
899 /* capsnego for linked pads */
900 GstCaps * gst_pad_get_allowed_caps (GstPad * pad);
901 GstCaps * gst_pad_get_negotiated_caps (GstPad * pad);
904 gint64 gst_pad_get_offset (GstPad *pad);
905 void gst_pad_set_offset (GstPad *pad, gint64 offset);
907 /* data passing functions to peer */
908 GstFlowReturn gst_pad_push (GstPad *pad, GstBuffer *buffer);
909 GstFlowReturn gst_pad_push_list (GstPad *pad, GstBufferList *list);
910 GstFlowReturn gst_pad_pull_range (GstPad *pad, guint64 offset, guint size,
912 gboolean gst_pad_push_event (GstPad *pad, GstEvent *event);
913 gboolean gst_pad_event_default (GstPad *pad, GstEvent *event);
914 gboolean gst_pad_event_forward (GstPad *pad, GstEvent *event);
916 /* data passing functions on pad */
917 GstFlowReturn gst_pad_chain (GstPad *pad, GstBuffer *buffer);
918 GstFlowReturn gst_pad_chain_list (GstPad *pad, GstBufferList *list);
919 GstFlowReturn gst_pad_get_range (GstPad *pad, guint64 offset, guint size,
921 gboolean gst_pad_send_event (GstPad *pad, GstEvent *event);
924 gboolean gst_pad_start_task (GstPad *pad, GstTaskFunction func,
926 gboolean gst_pad_pause_task (GstPad *pad);
927 gboolean gst_pad_stop_task (GstPad *pad);
930 void gst_pad_set_iterate_internal_links_function (GstPad * pad,
931 GstPadIterIntLinkFunction iterintlink);
932 GstIterator * gst_pad_iterate_internal_links (GstPad * pad);
933 GstIterator * gst_pad_iterate_internal_links_default (GstPad * pad);
936 /* generic query function */
937 void gst_pad_set_query_type_function (GstPad *pad, GstPadQueryTypeFunction type_func);
938 G_CONST_RETURN GstQueryType*
939 gst_pad_get_query_types (GstPad *pad);
940 G_CONST_RETURN GstQueryType*
941 gst_pad_get_query_types_default (GstPad *pad);
943 gboolean gst_pad_query (GstPad *pad, GstQuery *query);
944 gboolean gst_pad_peer_query (GstPad *pad, GstQuery *query);
945 void gst_pad_set_query_function (GstPad *pad, GstPadQueryFunction query);
946 gboolean gst_pad_query_default (GstPad *pad, GstQuery *query);
948 /* misc helper functions */
949 gboolean gst_pad_forward (GstPad *pad, GstPadForwardFunction forward,
954 #endif /* __GST_PAD_H__ */