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;
32 typedef struct _GstPadProbeInfo GstPadProbeInfo;
36 * @GST_PAD_UNKNOWN: direction is unknown.
37 * @GST_PAD_SRC: the pad is a source pad.
38 * @GST_PAD_SINK: the pad is a sink pad.
40 * The direction of a pad.
50 * @GST_PAD_MODE_NONE: Pad will not handle dataflow
51 * @GST_PAD_MODE_PUSH: Pad handles dataflow in downstream push mode
52 * @GST_PAD_MODE_PULL: Pad handles dataflow in upstream pull mode
54 * The status of a GstPad. After activating a pad, which usually happens when the
55 * parent element goes from READY to PAUSED, the GstPadMode defines if the
56 * pad operates in push or pull mode.
64 #include <gst/gstobject.h>
65 #include <gst/gstbuffer.h>
66 #include <gst/gstbufferlist.h>
67 #include <gst/gstcaps.h>
68 #include <gst/gstpadtemplate.h>
69 #include <gst/gstevent.h>
70 #include <gst/gstquery.h>
71 #include <gst/gsttask.h>
78 #define GST_TYPE_PAD (gst_pad_get_type ())
79 #define GST_IS_PAD(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PAD))
80 #define GST_IS_PAD_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PAD))
81 #define GST_PAD(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PAD, GstPad))
82 #define GST_PAD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PAD, GstPadClass))
83 #define GST_PAD_CAST(obj) ((GstPad*)(obj))
89 * @GST_PAD_LINK_OK : link succeeded
90 * @GST_PAD_LINK_WRONG_HIERARCHY: pads have no common grandparent
91 * @GST_PAD_LINK_WAS_LINKED : pad was already linked
92 * @GST_PAD_LINK_WRONG_DIRECTION: pads have wrong direction
93 * @GST_PAD_LINK_NOFORMAT : pads do not have common format
94 * @GST_PAD_LINK_NOSCHED : pads cannot cooperate in scheduling
95 * @GST_PAD_LINK_REFUSED : refused for some reason
97 * Result values from gst_pad_link and friends.
101 GST_PAD_LINK_WRONG_HIERARCHY = -1,
102 GST_PAD_LINK_WAS_LINKED = -2,
103 GST_PAD_LINK_WRONG_DIRECTION = -3,
104 GST_PAD_LINK_NOFORMAT = -4,
105 GST_PAD_LINK_NOSCHED = -5,
106 GST_PAD_LINK_REFUSED = -6
110 * GST_PAD_LINK_FAILED:
111 * @ret: the #GstPadLinkReturn value
113 * Macro to test if the given #GstPadLinkReturn value indicates a failed
116 #define GST_PAD_LINK_FAILED(ret) ((ret) < GST_PAD_LINK_OK)
119 * GST_PAD_LINK_SUCCESSFUL:
120 * @ret: the #GstPadLinkReturn value
122 * Macro to test if the given #GstPadLinkReturn value indicates a successful
125 #define GST_PAD_LINK_SUCCESSFUL(ret) ((ret) >= GST_PAD_LINK_OK)
129 * @GST_FLOW_OK: Data passing was ok.
130 * @GST_FLOW_NOT_LINKED: Pad is not linked.
131 * @GST_FLOW_FLUSHING: Pad is flushing.
132 * @GST_FLOW_EOS: Pad is EOS.
133 * @GST_FLOW_NOT_NEGOTIATED: Pad is not negotiated.
134 * @GST_FLOW_ERROR: Some (fatal) error occured. Element generating
135 * this error should post an error message with more
137 * @GST_FLOW_NOT_SUPPORTED: This operation is not supported.
138 * @GST_FLOW_CUSTOM_SUCCESS: Elements can use values starting from
139 * this (and higher) to define custom success
140 * codes. Since 0.10.7.
141 * @GST_FLOW_CUSTOM_SUCCESS_1: Pre-defined custom success code (define your
142 * custom success code to this to avoid compiler
143 * warnings). Since 0.10.29.
144 * @GST_FLOW_CUSTOM_SUCCESS_2: Pre-defined custom success code. Since 0.10.29.
145 * @GST_FLOW_CUSTOM_ERROR: Elements can use values starting from
146 * this (and lower) to define custom error codes.
148 * @GST_FLOW_CUSTOM_ERROR_1: Pre-defined custom error code (define your
149 * custom error code to this to avoid compiler
150 * warnings). Since 0.10.29.
151 * @GST_FLOW_CUSTOM_ERROR_2: Pre-defined custom error code. Since 0.10.29.
153 * The result of passing data to a pad.
155 * Note that the custom return values should not be exposed outside of the
156 * element scope and are available since 0.10.7.
158 /* FIXME 0.11: remove custom flow returns */
160 /* custom success starts here */
161 GST_FLOW_CUSTOM_SUCCESS_2 = 102,
162 GST_FLOW_CUSTOM_SUCCESS_1 = 101,
163 GST_FLOW_CUSTOM_SUCCESS = 100,
165 /* core predefined */
167 /* expected failures */
168 GST_FLOW_NOT_LINKED = -1,
169 GST_FLOW_FLUSHING = -2,
172 GST_FLOW_NOT_NEGOTIATED = -4,
174 GST_FLOW_NOT_SUPPORTED = -6,
176 /* custom error starts here */
177 GST_FLOW_CUSTOM_ERROR = -100,
178 GST_FLOW_CUSTOM_ERROR_1 = -101,
179 GST_FLOW_CUSTOM_ERROR_2 = -102
182 const gchar* gst_flow_get_name (GstFlowReturn ret);
183 GQuark gst_flow_to_quark (GstFlowReturn ret);
187 * @GST_PAD_LINK_CHECK_NOTHING: Don't check hierarchy or caps compatibility.
188 * @GST_PAD_LINK_CHECK_HIERARCHY: Check the pads have same parents/grandparents.
189 * Could be omitted if it is already known that the two elements that own the
190 * pads are in the same bin.
191 * @GST_PAD_LINK_CHECK_TEMPLATE_CAPS: Check if the pads are compatible by using
192 * their template caps. This is much faster than @GST_PAD_LINK_CHECK_CAPS, but
193 * would be unsafe e.g. if one pad has %GST_CAPS_ANY.
194 * @GST_PAD_LINK_CHECK_CAPS: Check if the pads are compatible by comparing the
195 * caps returned by gst_pad_query_caps().
197 * The amount of checking to be done when linking pads. @GST_PAD_LINK_CHECK_CAPS
198 * and @GST_PAD_LINK_CHECK_TEMPLATE_CAPS are mutually exclusive. If both are
199 * specified, expensive but safe @GST_PAD_LINK_CHECK_CAPS are performed.
202 * Only disable some of the checks if you are 100% certain you know the link
203 * will not fail because of hierarchy/caps compatibility failures. If uncertain,
204 * use the default checks (%GST_PAD_LINK_CHECK_DEFAULT) or the regular methods
205 * for linking the pads.
212 GST_PAD_LINK_CHECK_NOTHING = 0,
213 GST_PAD_LINK_CHECK_HIERARCHY = 1 << 0,
214 GST_PAD_LINK_CHECK_TEMPLATE_CAPS = 1 << 1,
215 GST_PAD_LINK_CHECK_CAPS = 1 << 2
219 * GST_PAD_LINK_CHECK_DEFAULT:
221 * The default checks done when linking pads (i.e. the ones used by
226 #define GST_PAD_LINK_CHECK_DEFAULT ((GstPadLinkCheck) (GST_PAD_LINK_CHECK_HIERARCHY | GST_PAD_LINK_CHECK_CAPS))
230 * GstPadActivateFunction:
232 * @parent: the parent of @pad
234 * This function is called when the pad is activated during the element
235 * READY to PAUSED state change. By default this function will call the
236 * activate function that puts the pad in push mode but elements can
237 * override this function to activate the pad in pull mode if they wish.
239 * Returns: TRUE if the pad could be activated.
241 typedef gboolean (*GstPadActivateFunction) (GstPad *pad, GstObject *parent);
243 * GstPadActivateModeFunction:
245 * @parent: the parent of @pad
246 * @mode: the requested activation mode of @pad
247 * @active: activate or deactivate the pad.
249 * The prototype of the push and pull activate functions.
251 * Returns: TRUE if the pad could be activated or deactivated.
253 typedef gboolean (*GstPadActivateModeFunction) (GstPad *pad, GstObject *parent,
254 GstPadMode mode, gboolean active);
259 * GstPadChainFunction:
260 * @pad: the sink #GstPad that performed the chain.
261 * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
262 * @parent is guaranteed to be not-NULL and remain valid during the
263 * execution of this function.
264 * @buffer: the #GstBuffer that is chained, not %NULL.
266 * A function that will be called on sinkpads when chaining buffers.
267 * The function typically processes the data contained in the buffer and
268 * either consumes the data or passes it on to the internally linked pad(s).
270 * The implementer of this function receives a refcount to @buffer and should
271 * gst_buffer_unref() when the buffer is no longer needed.
273 * When a chain function detects an error in the data stream, it must post an
274 * error on the bus and return an appropriate #GstFlowReturn value.
276 * Returns: #GST_FLOW_OK for success
278 typedef GstFlowReturn (*GstPadChainFunction) (GstPad *pad, GstObject *parent,
282 * GstPadChainListFunction:
283 * @pad: the sink #GstPad that performed the chain.
284 * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
285 * @parent is guaranteed to be not-NULL and remain valid during the
286 * execution of this function.
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, GstObject *parent,
302 GstBufferList *list);
305 * GstPadGetRangeFunction:
306 * @pad: the src #GstPad to perform the getrange on.
307 * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
308 * @parent is guaranteed to be not-NULL and remain valid during the
309 * execution of this function.
310 * @offset: the offset of the range
311 * @length: the length of the range
312 * @buffer: a memory location to hold the result buffer, cannot be NULL.
314 * This function will be called on source pads when a peer element
315 * request a buffer at the specified @offset and @length. If this function
316 * returns #GST_FLOW_OK, the result buffer will be stored in @buffer. The
317 * contents of @buffer is invalid for any other return value.
319 * This function is installed on a source pad with
320 * gst_pad_set_getrange_function() and can only be called on source pads after
321 * they are successfully activated with gst_pad_activate_pull().
323 * @offset and @length are always given in byte units. @offset must normally be a value
324 * between 0 and the length in bytes of the data available on @pad. The
325 * length (duration in bytes) can be retrieved with a #GST_QUERY_DURATION or with a
326 * #GST_QUERY_SEEKING.
328 * Any @offset larger or equal than the length will make the function return
329 * #GST_FLOW_EOS, which corresponds to EOS. In this case @buffer does not
330 * contain a valid buffer.
332 * The buffer size of @buffer will only be smaller than @length when @offset is
333 * near the end of the stream. In all other cases, the size of @buffer must be
334 * exactly the requested size.
336 * It is allowed to call this function with a 0 @length and valid @offset, in
337 * which case @buffer will contain a 0-sized buffer and the function returns
340 * When this function is called with a -1 @offset, the sequentially next buffer
341 * of length @length in the stream is returned.
343 * When this function is called with a -1 @length, a buffer with a default
344 * optimal length is returned in @buffer. The length might depend on the value
347 * Returns: #GST_FLOW_OK for success and a valid buffer in @buffer. Any other
348 * return value leaves @buffer undefined.
350 typedef GstFlowReturn (*GstPadGetRangeFunction) (GstPad *pad, GstObject *parent,
351 guint64 offset, guint length,
355 * GstPadEventFunction:
356 * @pad: the #GstPad to handle the event.
357 * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
358 * @parent is guaranteed to be not-NULL and remain valid during the
359 * execution of this function.
360 * @event: the #GstEvent to handle.
362 * Function signature to handle an event for the pad.
364 * Returns: TRUE if the pad could handle the event.
366 typedef gboolean (*GstPadEventFunction) (GstPad *pad, GstObject *parent,
372 * GstPadIterIntLinkFunction:
373 * @pad: The #GstPad to query.
374 * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
375 * @parent is guaranteed to be not-NULL and remain valid during the
376 * execution of this function.
378 * The signature of the internal pad link iterator function.
380 * Returns: a new #GstIterator that will iterate over all pads that are
381 * linked to the given pad on the inside of the parent element.
383 * the caller must call gst_iterator_free() after usage.
387 typedef GstIterator* (*GstPadIterIntLinkFunction) (GstPad *pad, GstObject *parent);
389 /* generic query function */
391 * GstPadQueryFunction:
392 * @pad: the #GstPad to query.
393 * @parent: the parent of @pad. If the #GST_PAD_FLAG_NEED_PARENT flag is set,
394 * @parent is guaranteed to be not-NULL and remain valid during the
395 * execution of this function.
396 * @query: the #GstQuery object to execute
398 * The signature of the query function.
400 * Returns: TRUE if the query could be performed.
402 typedef gboolean (*GstPadQueryFunction) (GstPad *pad, GstObject *parent,
409 * @pad: the #GstPad that is linked.
410 * @peer: the peer #GstPad of the link
412 * Function signature to handle a new link on the pad.
414 * Returns: the result of the link with the specified peer.
416 typedef GstPadLinkReturn (*GstPadLinkFunction) (GstPad *pad, GstPad *peer);
418 * GstPadUnlinkFunction
419 * @pad: the #GstPad that is linked.
421 * Function signature to handle a unlinking the pad prom its peer.
423 typedef void (*GstPadUnlinkFunction) (GstPad *pad);
428 * GstPadForwardFunction:
429 * @pad: the #GstPad that is forwarded.
430 * @user_data: the gpointer to optional user data.
432 * A forward function is called for all internally linked pads, see
435 * Returns: TRUE if the dispatching procedure has to be stopped.
437 typedef gboolean (*GstPadForwardFunction) (GstPad *pad, gpointer user_data);
441 * @GST_PAD_PROBE_TYPE_INVALID: invalid probe type
442 * @GST_PAD_PROBE_TYPE_IDLE: probe idle pads and block
443 * @GST_PAD_PROBE_TYPE_BLOCK: probe and block pads
444 * @GST_PAD_PROBE_TYPE_BUFFER: probe buffers
445 * @GST_PAD_PROBE_TYPE_BUFFER_LIST: probe buffer lists
446 * @GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM: probe downstream events
447 * @GST_PAD_PROBE_TYPE_EVENT_UPSTREAM: probe upstream events
448 * @GST_PAD_PROBE_TYPE_EVENT_FLUSH: probe flush events. This probe has to be
449 * explicitly enabled and is not included in the
450 * @@GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM or
451 * @@GST_PAD_PROBE_TYPE_EVENT_UPSTREAM probe types.
452 * @GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM: probe downstream queries
453 * @GST_PAD_PROBE_TYPE_QUERY_UPSTREAM: probe upstream queries
454 * @GST_PAD_PROBE_TYPE_PUSH: probe push
455 * @GST_PAD_PROBE_TYPE_PULL: probe pull
457 * The different probing types that can occur. When either one of
458 * @GST_PAD_PROBE_TYPE_IDLE or @GST_PAD_PROBE_TYPE_BLOCK is used, the probe will be a
463 GST_PAD_PROBE_TYPE_INVALID = 0,
464 /* flags to control blocking */
465 GST_PAD_PROBE_TYPE_IDLE = (1 << 0),
466 GST_PAD_PROBE_TYPE_BLOCK = (1 << 1),
467 /* flags to select datatypes */
468 GST_PAD_PROBE_TYPE_BUFFER = (1 << 4),
469 GST_PAD_PROBE_TYPE_BUFFER_LIST = (1 << 5),
470 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM = (1 << 6),
471 GST_PAD_PROBE_TYPE_EVENT_UPSTREAM = (1 << 7),
472 GST_PAD_PROBE_TYPE_EVENT_FLUSH = (1 << 8),
473 GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM = (1 << 9),
474 GST_PAD_PROBE_TYPE_QUERY_UPSTREAM = (1 << 10),
475 /* flags to select scheduling mode */
476 GST_PAD_PROBE_TYPE_PUSH = (1 << 12),
477 GST_PAD_PROBE_TYPE_PULL = (1 << 13)
480 #define GST_PAD_PROBE_TYPE_BLOCKING (GST_PAD_PROBE_TYPE_IDLE | GST_PAD_PROBE_TYPE_BLOCK)
481 #define GST_PAD_PROBE_TYPE_BLOCK_DOWNSTREAM (GST_PAD_PROBE_TYPE_BLOCK | GST_PAD_PROBE_TYPE_DATA_DOWNSTREAM)
482 #define GST_PAD_PROBE_TYPE_BLOCK_UPSTREAM (GST_PAD_PROBE_TYPE_BLOCK | GST_PAD_PROBE_TYPE_DATA_UPSTREAM)
483 #define GST_PAD_PROBE_TYPE_DATA_DOWNSTREAM (GST_PAD_PROBE_TYPE_BUFFER | GST_PAD_PROBE_TYPE_BUFFER_LIST | \
484 GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM)
485 #define GST_PAD_PROBE_TYPE_DATA_UPSTREAM (GST_PAD_PROBE_TYPE_EVENT_UPSTREAM)
486 #define GST_PAD_PROBE_TYPE_DATA_BOTH (GST_PAD_PROBE_TYPE_DATA_DOWNSTREAM | \
487 GST_PAD_PROBE_TYPE_DATA_UPSTREAM)
488 #define GST_PAD_PROBE_TYPE_EVENT_BOTH (GST_PAD_PROBE_TYPE_EVENT_DOWNSTREAM | \
489 GST_PAD_PROBE_TYPE_EVENT_UPSTREAM)
490 #define GST_PAD_PROBE_TYPE_QUERY_BOTH (GST_PAD_PROBE_TYPE_QUERY_DOWNSTREAM | \
491 GST_PAD_PROBE_TYPE_QUERY_UPSTREAM)
492 #define GST_PAD_PROBE_TYPE_ALL_BOTH (GST_PAD_PROBE_TYPE_DATA_BOTH | \
493 GST_PAD_PROBE_TYPE_QUERY_BOTH)
494 #define GST_PAD_PROBE_TYPE_SCHEDULING (GST_PAD_PROBE_TYPE_PUSH | GST_PAD_PROBE_TYPE_PULL)
498 * @GST_PAD_PROBE_OK: normal probe return value
499 * @GST_PAD_PROBE_DROP: drop data in data probes. For push mode this means that
500 * the data item is not sent downstream. For pull mode, it means that the
501 * data item is not passed upstream. In both cases, this result code
502 * returns #GST_FLOW_OK or %TRUE to the caller.
503 * @GST_PAD_PROBE_REMOVE: remove probe
504 * @GST_PAD_PROBE_PASS: pass the data item in the block probe and block on
507 * Different return values for the #GstPadProbeCallback.
513 GST_PAD_PROBE_REMOVE,
520 * @type: the current probe type
521 * @id: the id of the probe
522 * @data: type specific data, check the @type field to know the datatype.
523 * This field can be NULL.
524 * @offset: offset of pull probe, this field is valid when @type contains
525 * #GST_PAD_PROBE_TYPE_PULL
526 * @size: size of pull probe, this field is valid when @type contains
527 * #GST_PAD_PROBE_TYPE_PULL
529 * Info passed in the #GstPadProbeCallback.
531 struct _GstPadProbeInfo
533 GstPadProbeType type;
540 gpointer _gst_reserved[GST_PADDING];
543 #define GST_PAD_PROBE_INFO_TYPE(d) ((d)->type)
544 #define GST_PAD_PROBE_INFO_ID(d) ((d)->id)
545 #define GST_PAD_PROBE_INFO_DATA(d) ((d)->data)
547 #define GST_PAD_PROBE_INFO_BUFFER(d) GST_BUFFER_CAST(GST_PAD_PROBE_INFO_DATA(d))
548 #define GST_PAD_PROBE_INFO_BUFFER_LIST(d) GST_BUFFER_LIST_CAST(GST_PAD_PROBE_INFO_DATA(d))
549 #define GST_PAD_PROBE_INFO_EVENT(d) GST_EVENT_CAST(GST_PAD_PROBE_INFO_DATA(d))
550 #define GST_PAD_PROBE_INFO_QUERY(d) GST_QUERY_CAST(GST_PAD_PROBE_INFO_DATA(d))
552 #define GST_PAD_PROBE_INFO_OFFSET(d) ((d)->offset)
553 #define GST_PAD_PROBE_INFO_SIZE(d) ((d)->size)
556 * GstPadProbeCallback
557 * @pad: the #GstPad that is blocked
558 * @info: #GstPadProbeInfo
559 * @user_data: the gpointer to optional user data.
561 * Callback used by gst_pad_add_probe(). Gets called to notify about the current
564 * The callback is allowed to modify the data pointer in @info.
566 typedef GstPadProbeReturn (*GstPadProbeCallback) (GstPad *pad, GstPadProbeInfo *info,
570 * GstPadStickyEventsForeachFunction:
572 * @event: a sticky #GstEvent.
573 * @user_data: the #gpointer to optional user data.
575 * Callback used by gst_pad_sticky_events_foreach().
577 * When this function returns %TRUE, the next event will be
578 * returned. When %FALSE is returned, gst_pad_sticky_events_foreach() will return.
580 * When @event is set to NULL, the item will be removed from the list of sticky events.
581 * When @event has been made writable, the new buffer reference can be assigned
582 * to @event. This function is responsible for unreffing the old event when
583 * removing or modifying.
585 * Returns: %TRUE if the iteration should continue
587 typedef gboolean (*GstPadStickyEventsForeachFunction) (GstPad *pad, GstEvent **event,
592 * @GST_PAD_FLAG_BLOCKED: is dataflow on a pad blocked
593 * @GST_PAD_FLAG_FLUSHING: is pad refusing buffers
594 * @GST_PAD_FLAG_BLOCKING: is pad currently blocking on a buffer or event
595 * @GST_PAD_FLAG_NEED_PARENT: ensure that there is a parent object before calling
596 * into the pad callbacks.
597 * @GST_PAD_FLAG_NEED_RECONFIGURE: the pad should be reconfigured/renegotiated.
598 * The flag has to be unset manually after
599 * reconfiguration happened.
600 * @GST_PAD_FLAG_PENDING_EVENTS: the pad has pending events
601 * @GST_PAD_FLAG_FIXED_CAPS: the pad is using fixed caps this means that once the
602 * caps are set on the pad, the caps query function only
603 * returns those caps.
604 * @GST_PAD_FLAG_PROXY_CAPS: the default event and query handler will forward
605 * all events and queries to the internally linked pads
606 * instead of discarding them.
607 * @GST_PAD_FLAG_PROXY_ALLOCATION: the default query handler will forward
608 * allocation queries to the internally linked pads
609 * instead of discarding them.
610 * @GST_PAD_FLAG_LAST: offset to define more flags
615 GST_PAD_FLAG_BLOCKED = (GST_OBJECT_FLAG_LAST << 0),
616 GST_PAD_FLAG_FLUSHING = (GST_OBJECT_FLAG_LAST << 1),
617 GST_PAD_FLAG_BLOCKING = (GST_OBJECT_FLAG_LAST << 2),
618 GST_PAD_FLAG_NEED_PARENT = (GST_OBJECT_FLAG_LAST << 3),
619 GST_PAD_FLAG_NEED_RECONFIGURE = (GST_OBJECT_FLAG_LAST << 4),
620 GST_PAD_FLAG_PENDING_EVENTS = (GST_OBJECT_FLAG_LAST << 5),
621 GST_PAD_FLAG_FIXED_CAPS = (GST_OBJECT_FLAG_LAST << 6),
622 GST_PAD_FLAG_PROXY_CAPS = (GST_OBJECT_FLAG_LAST << 7),
623 GST_PAD_FLAG_PROXY_ALLOCATION = (GST_OBJECT_FLAG_LAST << 8),
625 GST_PAD_FLAG_LAST = (GST_OBJECT_FLAG_LAST << 16)
630 * @element_private: private data owned by the parent element
631 * @padtemplate: padtemplate for this pad
632 * @direction: the direction of the pad, cannot change after creating
635 * The #GstPad structure. Use the functions to update the variables.
641 gpointer element_private;
643 GstPadTemplate *padtemplate;
645 GstPadDirection direction;
648 /* streaming rec_lock */
649 GRecMutex stream_rec_lock;
652 /* block cond, mutex is from the object */
657 GstPadActivateFunction activatefunc;
658 gpointer activatedata;
659 GDestroyNotify activatenotify;
660 GstPadActivateModeFunction activatemodefunc;
661 gpointer activatemodedata;
662 GDestroyNotify activatemodenotify;
666 GstPadLinkFunction linkfunc;
668 GDestroyNotify linknotify;
669 GstPadUnlinkFunction unlinkfunc;
671 GDestroyNotify unlinknotify;
673 /* data transport functions */
674 GstPadChainFunction chainfunc;
676 GDestroyNotify chainnotify;
677 GstPadChainListFunction chainlistfunc;
678 gpointer chainlistdata;
679 GDestroyNotify chainlistnotify;
680 GstPadGetRangeFunction getrangefunc;
681 gpointer getrangedata;
682 GDestroyNotify getrangenotify;
683 GstPadEventFunction eventfunc;
685 GDestroyNotify eventnotify;
690 /* generic query method */
691 GstPadQueryFunction queryfunc;
693 GDestroyNotify querynotify;
696 GstPadIterIntLinkFunction iterintlinkfunc;
697 gpointer iterintlinkdata;
698 GDestroyNotify iterintlinknotify;
700 /* counts number of probes attached. */
706 gpointer _gst_reserved[GST_PADDING];
709 struct _GstPadClass {
710 GstObjectClass parent_class;
712 /* signal callbacks */
713 void (*linked) (GstPad *pad, GstPad *peer);
714 void (*unlinked) (GstPad *pad, GstPad *peer);
717 gpointer _gst_reserved[GST_PADDING];
721 /***** helper macros *****/
723 #define GST_PAD_NAME(pad) (GST_OBJECT_NAME(pad))
724 #define GST_PAD_PARENT(pad) (GST_ELEMENT_CAST(GST_OBJECT_PARENT(pad)))
725 #define GST_PAD_ELEMENT_PRIVATE(pad) (GST_PAD_CAST(pad)->element_private)
726 #define GST_PAD_PAD_TEMPLATE(pad) (GST_PAD_CAST(pad)->padtemplate)
727 #define GST_PAD_DIRECTION(pad) (GST_PAD_CAST(pad)->direction)
728 #define GST_PAD_TASK(pad) (GST_PAD_CAST(pad)->task)
729 #define GST_PAD_MODE(pad) (GST_PAD_CAST(pad)->mode)
731 #define GST_PAD_ACTIVATEFUNC(pad) (GST_PAD_CAST(pad)->activatefunc)
732 #define GST_PAD_ACTIVATEMODEFUNC(pad) (GST_PAD_CAST(pad)->activatemodefunc)
733 #define GST_PAD_CHAINFUNC(pad) (GST_PAD_CAST(pad)->chainfunc)
734 #define GST_PAD_CHAINLISTFUNC(pad) (GST_PAD_CAST(pad)->chainlistfunc)
735 #define GST_PAD_GETRANGEFUNC(pad) (GST_PAD_CAST(pad)->getrangefunc)
736 #define GST_PAD_EVENTFUNC(pad) (GST_PAD_CAST(pad)->eventfunc)
737 #define GST_PAD_QUERYFUNC(pad) (GST_PAD_CAST(pad)->queryfunc)
738 #define GST_PAD_ITERINTLINKFUNC(pad) (GST_PAD_CAST(pad)->iterintlinkfunc)
740 #define GST_PAD_PEER(pad) (GST_PAD_CAST(pad)->peer)
741 #define GST_PAD_LINKFUNC(pad) (GST_PAD_CAST(pad)->linkfunc)
742 #define GST_PAD_UNLINKFUNC(pad) (GST_PAD_CAST(pad)->unlinkfunc)
744 #define GST_PAD_IS_SRC(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SRC)
745 #define GST_PAD_IS_SINK(pad) (GST_PAD_DIRECTION(pad) == GST_PAD_SINK)
747 #define GST_PAD_IS_LINKED(pad) (GST_PAD_PEER(pad) != NULL)
749 #define GST_PAD_IS_ACTIVE(pad) (GST_PAD_MODE(pad) != GST_PAD_MODE_NONE)
751 #define GST_PAD_IS_BLOCKED(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKED))
752 #define GST_PAD_IS_BLOCKING(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_BLOCKING))
754 #define GST_PAD_IS_FLUSHING(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_FLUSHING))
755 #define GST_PAD_SET_FLUSHING(pad) (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_FLUSHING))
756 #define GST_PAD_UNSET_FLUSHING(pad) (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_FLUSHING))
758 #define GST_PAD_NEEDS_RECONFIGURE(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_NEED_RECONFIGURE))
759 #define GST_PAD_HAS_PENDING_EVENTS(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_PENDING_EVENTS))
760 #define GST_PAD_IS_FIXED_CAPS(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_FIXED_CAPS))
761 #define GST_PAD_NEEDS_PARENT(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_NEED_PARENT))
763 #define GST_PAD_IS_PROXY_CAPS(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_PROXY_CAPS))
764 #define GST_PAD_SET_PROXY_CAPS(pad) (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PROXY_CAPS))
765 #define GST_PAD_UNSET_PROXY_CAPS(pad) (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PROXY_CAPS))
767 #define GST_PAD_IS_PROXY_ALLOCATION(pad) (GST_OBJECT_FLAG_IS_SET (pad, GST_PAD_FLAG_PROXY_ALLOCATION))
768 #define GST_PAD_SET_PROXY_ALLOCATION(pad) (GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_PROXY_ALLOCATION))
769 #define GST_PAD_UNSET_PROXY_ALLOCATION(pad) (GST_OBJECT_FLAG_UNSET (pad, GST_PAD_FLAG_PROXY_ALLOCATION))
772 * GST_PAD_GET_STREAM_LOCK:
775 * Get the stream lock of @pad. The stream lock is protecting the
776 * resources used in the data processing functions of @pad.
778 #define GST_PAD_GET_STREAM_LOCK(pad) (&(GST_PAD_CAST(pad)->stream_rec_lock))
780 * GST_PAD_STREAM_LOCK:
783 * Lock the stream lock of @pad.
785 #define GST_PAD_STREAM_LOCK(pad) g_rec_mutex_lock(GST_PAD_GET_STREAM_LOCK(pad))
787 * GST_PAD_STREAM_TRYLOCK:
790 * Try to Lock the stream lock of the pad, return TRUE if the lock could be
793 #define GST_PAD_STREAM_TRYLOCK(pad) g_rec_mutex_trylock(GST_PAD_GET_STREAM_LOCK(pad))
795 * GST_PAD_STREAM_UNLOCK:
798 * Unlock the stream lock of @pad.
800 #define GST_PAD_STREAM_UNLOCK(pad) g_rec_mutex_unlock(GST_PAD_GET_STREAM_LOCK(pad))
802 #define GST_PAD_BLOCK_GET_COND(pad) (&GST_PAD_CAST(pad)->block_cond)
803 #define GST_PAD_BLOCK_WAIT(pad) (g_cond_wait(GST_PAD_BLOCK_GET_COND (pad), GST_OBJECT_GET_LOCK (pad)))
804 #define GST_PAD_BLOCK_SIGNAL(pad) (g_cond_signal(GST_PAD_BLOCK_GET_COND (pad)))
805 #define GST_PAD_BLOCK_BROADCAST(pad) (g_cond_broadcast(GST_PAD_BLOCK_GET_COND (pad)))
807 GType gst_pad_get_type (void);
810 GstPad* gst_pad_new (const gchar *name, GstPadDirection direction);
811 GstPad* gst_pad_new_from_template (GstPadTemplate *templ, const gchar *name);
812 GstPad* gst_pad_new_from_static_template (GstStaticPadTemplate *templ, const gchar *name);
817 * @pad: the pad to get the name from
819 * Get a copy of the name of the pad. g_free() after usage.
823 #define gst_pad_get_name(pad) gst_object_get_name (GST_OBJECT_CAST (pad))
825 * gst_pad_get_parent:
826 * @pad: the pad to get the parent of
828 * Get the parent of @pad. This function increases the refcount
829 * of the parent object so you should gst_object_unref() it after usage.
830 * Can return NULL if the pad did not have a parent.
834 #define gst_pad_get_parent(pad) gst_object_get_parent (GST_OBJECT_CAST (pad))
836 GstPadDirection gst_pad_get_direction (GstPad *pad);
838 gboolean gst_pad_set_active (GstPad *pad, gboolean active);
839 gboolean gst_pad_is_active (GstPad *pad);
840 gboolean gst_pad_activate_mode (GstPad *pad, GstPadMode mode,
843 gulong gst_pad_add_probe (GstPad *pad,
844 GstPadProbeType mask,
845 GstPadProbeCallback callback,
847 GDestroyNotify destroy_data);
848 void gst_pad_remove_probe (GstPad *pad, gulong id);
850 gboolean gst_pad_is_blocked (GstPad *pad);
851 gboolean gst_pad_is_blocking (GstPad *pad);
853 void gst_pad_mark_reconfigure (GstPad *pad);
854 gboolean gst_pad_check_reconfigure (GstPad *pad);
856 void gst_pad_set_element_private (GstPad *pad, gpointer priv);
857 gpointer gst_pad_get_element_private (GstPad *pad);
859 GstPadTemplate* gst_pad_get_pad_template (GstPad *pad);
861 GstEvent* gst_pad_get_sticky_event (GstPad *pad, GstEventType event_type,
863 void gst_pad_sticky_events_foreach (GstPad *pad, GstPadStickyEventsForeachFunction foreach_func, gpointer user_data);
865 /* data passing setup functions */
866 void gst_pad_set_activate_function_full (GstPad *pad,
867 GstPadActivateFunction activate,
869 GDestroyNotify notify);
870 void gst_pad_set_activatemode_function_full (GstPad *pad,
871 GstPadActivateModeFunction activatemode,
873 GDestroyNotify notify);
874 /* data passing functions */
875 void gst_pad_set_chain_function_full (GstPad *pad,
876 GstPadChainFunction chain,
878 GDestroyNotify notify);
879 void gst_pad_set_chain_list_function_full (GstPad *pad,
880 GstPadChainListFunction chainlist,
882 GDestroyNotify notify);
883 void gst_pad_set_getrange_function_full (GstPad *pad,
884 GstPadGetRangeFunction get,
886 GDestroyNotify notify);
887 void gst_pad_set_event_function_full (GstPad *pad,
888 GstPadEventFunction event,
890 GDestroyNotify notify);
892 #define gst_pad_set_activate_function(p,f) gst_pad_set_activate_function_full((p),(f),NULL,NULL)
893 #define gst_pad_set_activatemode_function(p,f) gst_pad_set_activatemode_function_full((p),(f),NULL,NULL)
894 #define gst_pad_set_chain_function(p,f) gst_pad_set_chain_function_full((p),(f),NULL,NULL)
895 #define gst_pad_set_chain_list_function(p,f) gst_pad_set_chain_list_function_full((p),(f),NULL,NULL)
896 #define gst_pad_set_getrange_function(p,f) gst_pad_set_getrange_function_full((p),(f),NULL,NULL)
897 #define gst_pad_set_event_function(p,f) gst_pad_set_event_function_full((p),(f),NULL,NULL)
900 void gst_pad_set_link_function_full (GstPad *pad,
901 GstPadLinkFunction link,
903 GDestroyNotify notify);
904 void gst_pad_set_unlink_function_full (GstPad *pad,
905 GstPadUnlinkFunction unlink,
907 GDestroyNotify notify);
909 #define gst_pad_set_link_function(p,f) gst_pad_set_link_function_full((p),(f),NULL,NULL)
910 #define gst_pad_set_unlink_function(p,f) gst_pad_set_unlink_function_full((p),(f),NULL,NULL)
912 gboolean gst_pad_can_link (GstPad *srcpad, GstPad *sinkpad);
913 GstPadLinkReturn gst_pad_link (GstPad *srcpad, GstPad *sinkpad);
914 GstPadLinkReturn gst_pad_link_full (GstPad *srcpad, GstPad *sinkpad, GstPadLinkCheck flags);
915 gboolean gst_pad_unlink (GstPad *srcpad, GstPad *sinkpad);
916 gboolean gst_pad_is_linked (GstPad *pad);
918 GstPad* gst_pad_get_peer (GstPad *pad);
920 GstCaps* gst_pad_get_pad_template_caps (GstPad *pad);
922 /* capsnego function for linked/unlinked pads */
923 GstCaps * gst_pad_get_current_caps (GstPad * pad);
924 gboolean gst_pad_has_current_caps (GstPad * pad);
925 gboolean gst_pad_set_caps (GstPad * pad, GstCaps *caps);
927 /* capsnego for linked pads */
928 GstCaps * gst_pad_get_allowed_caps (GstPad * pad);
931 gint64 gst_pad_get_offset (GstPad *pad);
932 void gst_pad_set_offset (GstPad *pad, gint64 offset);
934 /* data passing functions to peer */
935 GstFlowReturn gst_pad_push (GstPad *pad, GstBuffer *buffer);
936 GstFlowReturn gst_pad_push_list (GstPad *pad, GstBufferList *list);
937 GstFlowReturn gst_pad_pull_range (GstPad *pad, guint64 offset, guint size,
939 gboolean gst_pad_push_event (GstPad *pad, GstEvent *event);
940 gboolean gst_pad_event_default (GstPad *pad, GstObject *parent,
943 /* data passing functions on pad */
944 GstFlowReturn gst_pad_chain (GstPad *pad, GstBuffer *buffer);
945 GstFlowReturn gst_pad_chain_list (GstPad *pad, GstBufferList *list);
946 GstFlowReturn gst_pad_get_range (GstPad *pad, guint64 offset, guint size,
948 gboolean gst_pad_send_event (GstPad *pad, GstEvent *event);
951 gboolean gst_pad_start_task (GstPad *pad, GstTaskFunction func,
953 gboolean gst_pad_pause_task (GstPad *pad);
954 gboolean gst_pad_stop_task (GstPad *pad);
957 void gst_pad_set_iterate_internal_links_function_full (GstPad * pad,
958 GstPadIterIntLinkFunction iterintlink,
960 GDestroyNotify notify);
961 GstIterator * gst_pad_iterate_internal_links (GstPad * pad);
962 GstIterator * gst_pad_iterate_internal_links_default (GstPad * pad, GstObject *parent);
964 #define gst_pad_set_iterate_internal_links_function(p,f) gst_pad_set_iterate_internal_links_function_full((p),(f),NULL,NULL)
966 /* generic query function */
967 gboolean gst_pad_query (GstPad *pad, GstQuery *query);
968 gboolean gst_pad_peer_query (GstPad *pad, GstQuery *query);
969 void gst_pad_set_query_function_full (GstPad *pad, GstPadQueryFunction query,
971 GDestroyNotify notify);
972 gboolean gst_pad_query_default (GstPad *pad, GstObject *parent,
975 #define gst_pad_set_query_function(p,f) gst_pad_set_query_function_full((p),(f),NULL,NULL)
977 /* misc helper functions */
978 gboolean gst_pad_forward (GstPad *pad, GstPadForwardFunction forward,
983 #endif /* __GST_PAD_H__ */