853b43aa46a912570159db61267e217e39c76233
1 /* GStreamer
2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 *
5 * gstpad.c: Pads for linking elements together
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
16 *
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
21 */
22 /**
23 * SECTION:gstpad
24 * @short_description: Object contained by elements that allows links to other elements
25 * @see_also: #GstPadTemplate, #GstElement, #GstEvent
26 *
27 * A #GstElement is linked to other elements via "pads", which are extremely
28 * light-weight generic link points.
29 * After two pads are retrieved from an element with gst_element_get_pad(),
30 * the pads can be link with gst_pad_link(). (For quick links,
31 * you can also use gst_element_link(), which will make the obvious
32 * link for you if it's straightforward.)
33 *
34 * Pads are typically created from a #GstPadTemplate with
35 * gst_pad_new_from_template().
36 *
37 * Pads have #GstCaps attached to it to describe the media type they are capable
38 * of dealing with.
39 * gst_pad_get_caps() and gst_pad_try_set_caps() are used to manipulate the caps
40 * of the pads.
41 * Pads created from a pad template cannot set capabilities that are
42 * incompatible with the pad template capabilities.
43 *
44 * Pads without pad templates can be created with gst_pad_new(),
45 * which takes a direction and a name as an argument. If the name is NULL,
46 * then a guaranteed unique name will be assigned to it.
47 *
48 * gst_pad_get_parent() will retrieve the #GstElement that owns the pad.
49 *
50 * A #GstElement creating a pad will typically use the various
51 * gst_pad_set_*_function() calls to register callbacks for various events
52 * on the pads.
53 *
54 * GstElements will use gst_pad_push() and gst_pad_pull() to push out
55 * or pull in a buffer.
56 * gst_pad_select() and gst_pad_selectv() are used by plugins to wait for the
57 * first incoming buffer or event on any of the given set of pads.
58 *
59 * To send a #GstEvent on a pad, use gst_pad_send_event().
60 *
61 * Last reviewed on December 13th, 2002 (0.5.0.1)
62 */
64 #include "gst_private.h"
66 #include "gstpad.h"
67 #include "gstpadtemplate.h"
68 #include "gstenumtypes.h"
69 #include "gstmarshal.h"
70 #include "gstutils.h"
71 #include "gstinfo.h"
72 #include "gsterror.h"
73 #include "gstvalue.h"
75 GST_DEBUG_CATEGORY_STATIC (debug_dataflow);
76 #define DEBUG_DATA(obj,data,notice) G_STMT_START{\
77 if (!data) { \
78 GST_CAT_DEBUG_OBJECT (debug_dataflow, obj, "NULL data value"); \
79 } else if (GST_IS_EVENT (data)) { \
80 GST_CAT_DEBUG_OBJECT (debug_dataflow, obj, "%s event %p (type %d, refcount %d)", notice, data, \
81 GST_EVENT_TYPE (data), GST_DATA_REFCOUNT_VALUE (data)); \
82 } else { \
83 GST_CAT_LOG_OBJECT (debug_dataflow, obj, "%s buffer %p (size %u, refcount %d)", notice, data, \
84 GST_BUFFER_SIZE (data), GST_BUFFER_REFCOUNT_VALUE (data)); \
85 } \
86 }G_STMT_END
87 #define GST_CAT_DEFAULT GST_CAT_PADS
89 /* Pad signals and args */
90 enum
91 {
92 PAD_LINKED,
93 PAD_UNLINKED,
94 PAD_REQUEST_LINK,
95 PAD_HAVE_DATA,
96 /* FILL ME */
97 LAST_SIGNAL
98 };
100 enum
101 {
102 PAD_PROP_0,
103 PAD_PROP_CAPS,
104 PAD_PROP_DIRECTION,
105 PAD_PROP_TEMPLATE,
106 /* FILL ME */
107 };
109 GType _gst_pad_type = 0;
111 static void gst_pad_class_init (GstPadClass * klass);
112 static void gst_pad_init (GstPad * pad);
113 static void gst_pad_dispose (GObject * object);
114 static void gst_pad_finalize (GObject * object);
115 static void gst_pad_set_property (GObject * object, guint prop_id,
116 const GValue * value, GParamSpec * pspec);
117 static void gst_pad_get_property (GObject * object, guint prop_id,
118 GValue * value, GParamSpec * pspec);
120 static GstCaps *gst_pad_get_caps_unlocked (GstPad * pad);
121 static void gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ);
122 static gboolean gst_pad_activate_default (GstPad * pad);
124 #ifndef GST_DISABLE_LOADSAVE
125 static xmlNodePtr gst_pad_save_thyself (GstObject * object, xmlNodePtr parent);
126 #endif
128 static GstObjectClass *parent_class = NULL;
129 static guint gst_pad_signals[LAST_SIGNAL] = { 0 };
131 static GQuark buffer_quark;
132 static GQuark event_quark;
134 GType
135 gst_pad_get_type (void)
136 {
137 if (!_gst_pad_type) {
138 static const GTypeInfo pad_info = {
139 sizeof (GstPadClass), NULL, NULL,
140 (GClassInitFunc) gst_pad_class_init, NULL, NULL,
141 sizeof (GstPad),
142 0,
143 (GInstanceInitFunc) gst_pad_init, NULL
144 };
146 _gst_pad_type = g_type_register_static (GST_TYPE_OBJECT, "GstPad",
147 &pad_info, 0);
149 buffer_quark = g_quark_from_static_string ("buffer");
150 event_quark = g_quark_from_static_string ("event");
152 GST_DEBUG_CATEGORY_INIT (debug_dataflow, "GST_DATAFLOW",
153 GST_DEBUG_BOLD | GST_DEBUG_FG_GREEN, "dataflow inside pads");
154 }
155 return _gst_pad_type;
156 }
158 static gboolean
159 _gst_do_pass_data_accumulator (GSignalInvocationHint * ihint,
160 GValue * return_accu, const GValue * handler_return, gpointer dummy)
161 {
162 gboolean ret = g_value_get_boolean (handler_return);
164 GST_DEBUG ("accumulated %d", ret);
165 g_value_set_boolean (return_accu, ret);
167 return ret;
168 }
170 static gboolean
171 default_have_data (GstPad * pad, GstMiniObject * o)
172 {
173 return TRUE;
174 }
176 static void
177 gst_pad_class_init (GstPadClass * klass)
178 {
179 GObjectClass *gobject_class;
182 GstObjectClass *gstobject_class;
184 gobject_class = (GObjectClass *) klass;
185 gstobject_class = (GstObjectClass *) klass;
187 parent_class = g_type_class_ref (GST_TYPE_OBJECT);
189 gobject_class->dispose = GST_DEBUG_FUNCPTR (gst_pad_dispose);
190 gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_pad_finalize);
191 gobject_class->set_property = GST_DEBUG_FUNCPTR (gst_pad_set_property);
192 gobject_class->get_property = GST_DEBUG_FUNCPTR (gst_pad_get_property);
194 /**
195 * GstPad::linked:
196 * @pad: the pad that emitted the signal
197 * @peer: the peer pad that has been connected
198 *
199 * Signals that a pad has been linked to the peer pad.
200 */
201 gst_pad_signals[PAD_LINKED] =
202 g_signal_new ("linked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
203 G_STRUCT_OFFSET (GstPadClass, linked), NULL, NULL,
204 gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_PAD);
205 /**
206 * GstPad::unlinked:
207 * @pad: the pad that emitted the signal
208 * @peer: the peer pad that has been disconnected
209 *
210 * Signals that a pad has been unlinked from the peer pad.
211 */
212 gst_pad_signals[PAD_UNLINKED] =
213 g_signal_new ("unlinked", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
214 G_STRUCT_OFFSET (GstPadClass, unlinked), NULL, NULL,
215 gst_marshal_VOID__OBJECT, G_TYPE_NONE, 1, GST_TYPE_PAD);
216 /**
217 * GstPad::request-link:
218 * @pad: the pad that emitted the signal
219 * @peer: the peer pad for which a connection is requested
220 *
221 * Signals that a pad connection has been requested.
222 */
223 gst_pad_signals[PAD_REQUEST_LINK] =
224 g_signal_new ("request-link", G_TYPE_FROM_CLASS (klass),
225 G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GstPadClass, request_link), NULL,
226 NULL, gst_marshal_VOID__OBJECT, G_TYPE_NONE, 0);
228 /**
229 * GstPad::have-data:
230 * @pad: the pad that emitted the signal
231 * @mini_obj: new data
232 *
233 * Signals that new data is available on the pad. This signal is used
234 * internally for implementing pad probes.
235 * See gst_pad_add_*_probe functions.
236 *
237 * Returns: %TRUE to keep the data, %FALSE to drop it
238 */
239 gst_pad_signals[PAD_HAVE_DATA] =
240 g_signal_new ("have-data", G_TYPE_FROM_CLASS (klass),
241 G_SIGNAL_RUN_LAST | G_SIGNAL_DETAILED,
242 G_STRUCT_OFFSET (GstPadClass, have_data),
243 _gst_do_pass_data_accumulator,
244 NULL, gst_marshal_BOOLEAN__POINTER, G_TYPE_BOOLEAN, 1,
245 GST_TYPE_MINI_OBJECT);
247 g_object_class_install_property (G_OBJECT_CLASS (klass), PAD_PROP_CAPS,
248 g_param_spec_boxed ("caps", "Caps", "The capabilities of the pad",
249 GST_TYPE_CAPS, G_PARAM_READABLE));
250 g_object_class_install_property (G_OBJECT_CLASS (klass), PAD_PROP_DIRECTION,
251 g_param_spec_enum ("direction", "Direction", "The direction of the pad",
252 GST_TYPE_PAD_DIRECTION, GST_PAD_UNKNOWN,
253 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
254 g_object_class_install_property (G_OBJECT_CLASS (klass), PAD_PROP_TEMPLATE,
255 g_param_spec_object ("template", "Template",
256 "The GstPadTemplate of this pad", GST_TYPE_PAD_TEMPLATE,
257 G_PARAM_READWRITE));
259 #ifndef GST_DISABLE_LOADSAVE
260 gstobject_class->save_thyself = GST_DEBUG_FUNCPTR (gst_pad_save_thyself);
261 #endif
262 gstobject_class->path_string_separator = ".";
264 klass->have_data = default_have_data;
265 }
267 static void
268 gst_pad_init (GstPad * pad)
269 {
270 pad->direction = GST_PAD_UNKNOWN;
271 pad->peer = NULL;
273 pad->chainfunc = NULL;
275 pad->caps = NULL;
277 pad->linkfunc = NULL;
278 pad->getcapsfunc = NULL;
280 pad->activatefunc = gst_pad_activate_default;
281 pad->eventfunc = gst_pad_event_default;
282 pad->querytypefunc = gst_pad_get_query_types_default;
283 pad->queryfunc = gst_pad_query_default;
284 pad->intlinkfunc = gst_pad_get_internal_links_default;
286 pad->do_buffer_signals = 0;
287 pad->do_event_signals = 0;
289 GST_PAD_UNSET_FLUSHING (pad);
291 pad->preroll_lock = g_mutex_new ();
292 pad->preroll_cond = g_cond_new ();
294 pad->stream_rec_lock = g_new (GStaticRecMutex, 1);
295 g_static_rec_mutex_init (pad->stream_rec_lock);
297 pad->block_cond = g_cond_new ();
298 }
300 static void
301 gst_pad_dispose (GObject * object)
302 {
303 GstPad *pad = GST_PAD (object);
305 gst_pad_set_pad_template (pad, NULL);
306 /* FIXME, we have links to many other things like caps
307 * and the peer pad... */
309 /* No linked pad can ever be disposed.
310 * It has to have a parent to be linked
311 * and a parent would hold a reference */
312 /* FIXME: what about if g_object_dispose is explicitly called on the pad? Is
313 that legal? otherwise we could assert GST_OBJECT_PARENT (pad) == NULL as
314 well... */
315 GST_CAT_DEBUG (GST_CAT_REFCOUNTING, "dispose %s:%s",
316 GST_DEBUG_PAD_NAME (pad));
318 g_assert (GST_PAD_PEER (pad) == NULL);
320 /* clear the caps */
321 gst_caps_replace (&GST_PAD_CAPS (pad), NULL);
323 if (GST_IS_ELEMENT (GST_OBJECT_PARENT (pad))) {
324 GST_CAT_DEBUG (GST_CAT_REFCOUNTING, "removing pad from element '%s'",
325 GST_OBJECT_NAME (GST_OBJECT (GST_ELEMENT (GST_OBJECT_PARENT (pad)))));
327 gst_element_remove_pad (GST_ELEMENT (GST_OBJECT_PARENT (pad)), pad);
328 }
330 G_OBJECT_CLASS (parent_class)->dispose (object);
331 }
333 static void
334 gst_pad_finalize (GObject * object)
335 {
336 GstPad *pad = GST_PAD (object);
337 GstTask *task;
339 /* in case the task is still around, clean it up */
340 if ((task = GST_PAD_TASK (pad))) {
341 gst_task_join (task);
342 GST_PAD_TASK (pad) = NULL;
343 gst_object_unref (task);
344 }
346 if (pad->stream_rec_lock) {
347 g_static_rec_mutex_free (pad->stream_rec_lock);
348 g_free (pad->stream_rec_lock);
349 pad->stream_rec_lock = NULL;
350 }
351 if (pad->preroll_lock) {
352 g_mutex_free (pad->preroll_lock);
353 g_cond_free (pad->preroll_cond);
354 pad->preroll_lock = NULL;
355 pad->preroll_cond = NULL;
356 }
357 if (pad->block_cond) {
358 g_cond_free (pad->block_cond);
359 pad->block_cond = NULL;
360 }
362 G_OBJECT_CLASS (parent_class)->finalize (object);
363 }
365 static void
366 gst_pad_set_property (GObject * object, guint prop_id,
367 const GValue * value, GParamSpec * pspec)
368 {
369 g_return_if_fail (GST_IS_PAD (object));
371 switch (prop_id) {
372 case PAD_PROP_DIRECTION:
373 GST_PAD_DIRECTION (object) = g_value_get_enum (value);
374 break;
375 case PAD_PROP_TEMPLATE:
376 gst_pad_set_pad_template (GST_PAD_CAST (object),
377 (GstPadTemplate *) g_value_dup_object (value));
378 break;
379 default:
380 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
381 break;
382 }
383 }
385 static void
386 gst_pad_get_property (GObject * object, guint prop_id,
387 GValue * value, GParamSpec * pspec)
388 {
389 g_return_if_fail (GST_IS_PAD (object));
391 switch (prop_id) {
392 case PAD_PROP_CAPS:
393 g_value_set_boxed (value, GST_PAD_CAPS (object));
394 break;
395 case PAD_PROP_DIRECTION:
396 g_value_set_enum (value, GST_PAD_DIRECTION (object));
397 break;
398 case PAD_PROP_TEMPLATE:
399 g_value_set_object (value, GST_PAD_TEMPLATE (object));
400 break;
401 default:
402 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
403 break;
404 }
405 }
407 /**
408 * gst_pad_new:
409 * @name: the name of the new pad.
410 * @direction: the #GstPadDirection of the pad.
411 *
412 * Creates a new pad with the given name in the given direction.
413 * If name is NULL, a guaranteed unique name (across all pads)
414 * will be assigned.
415 * This function makes a copy of the name so you can safely free the name.
416 *
417 * Returns: a new #GstPad, or NULL in case of an error.
418 *
419 * MT safe.
420 */
421 GstPad *
422 gst_pad_new (const gchar * name, GstPadDirection direction)
423 {
424 return g_object_new (GST_TYPE_PAD,
425 "name", name, "direction", direction, NULL);
426 }
428 /**
429 * gst_pad_new_from_template:
430 * @templ: the pad template to use
431 * @name: the name of the element
432 *
433 * Creates a new pad with the given name from the given template.
434 * If name is NULL, a guaranteed unique name (across all pads)
435 * will be assigned.
436 * This function makes a copy of the name so you can safely free the name.
437 *
438 * Returns: a new #GstPad, or NULL in case of an error.
439 */
440 GstPad *
441 gst_pad_new_from_template (GstPadTemplate * templ, const gchar * name)
442 {
443 g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
445 return g_object_new (GST_TYPE_PAD,
446 "name", name, "direction", templ->direction, "template", templ, NULL);
447 }
449 /**
450 * gst_pad_get_direction:
451 * @pad: a #GstPad to get the direction of.
452 *
453 * Gets the direction of the pad. The direction of the pad is
454 * decided at construction time so this function does not take
455 * the LOCK.
456 *
457 * Returns: the #GstPadDirection of the pad.
458 *
459 * MT safe.
460 */
461 GstPadDirection
462 gst_pad_get_direction (GstPad * pad)
463 {
464 GstPadDirection result;
466 /* PAD_UNKNOWN is a little silly but we need some sort of
467 * error return value */
468 g_return_val_if_fail (GST_IS_PAD (pad), GST_PAD_UNKNOWN);
470 GST_LOCK (pad);
471 result = GST_PAD_DIRECTION (pad);
472 GST_UNLOCK (pad);
474 return result;
475 }
477 static gboolean
478 gst_pad_activate_default (GstPad * pad)
479 {
480 return gst_pad_activate_push (pad, TRUE);
481 }
483 static void
484 pre_activate_switch (GstPad * pad, gboolean new_active)
485 {
486 if (new_active) {
487 return;
488 } else {
489 GST_LOCK (pad);
490 GST_PAD_SET_FLUSHING (pad);
491 /* unlock blocked pads so element can resume and stop */
492 GST_PAD_BLOCK_SIGNAL (pad);
493 GST_UNLOCK (pad);
494 }
495 }
497 static void
498 post_activate_switch (GstPad * pad, gboolean new_active)
499 {
500 if (new_active) {
501 GST_LOCK (pad);
502 GST_PAD_UNSET_FLUSHING (pad);
503 GST_UNLOCK (pad);
504 } else {
505 /* make streaming stop */
506 GST_STREAM_LOCK (pad);
507 GST_STREAM_UNLOCK (pad);
508 }
509 }
511 /**
512 * gst_pad_set_active:
513 * @pad: the #GstPad to activate or deactivate.
514 * @active: whether or not the pad should be active.
515 *
516 * Activates or deactivates the given pad. Must be called with the %GST_STATE_LOCK.
517 * Normally called from within core state change functions.
518 *
519 * If @active, makes sure the pad is active. If it is already active, either in
520 * push or pull mode, just return. Otherwise dispatches to the pad's activate
521 * function to perform the actual activation.
522 *
523 * If not @active, checks the pad's current mode and calls
524 * gst_pad_activate_push() or gst_pad_activate_pull(), as appropriate, with a
525 * FALSE argument.
526 *
527 * Returns: TRUE if the operation was successfull.
528 *
529 * MT safe. Must be called with %GST_STATE_LOCK.
530 */
531 gboolean
532 gst_pad_set_active (GstPad * pad, gboolean active)
533 {
534 GstActivateMode old;
535 gboolean ret = FALSE;
537 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
539 GST_LOCK (pad);
540 old = GST_PAD_ACTIVATE_MODE (pad);
541 GST_UNLOCK (pad);
543 if (active) {
544 switch (old) {
545 case GST_ACTIVATE_PUSH:
546 case GST_ACTIVATE_PULL:
547 ret = TRUE;
548 break;
549 case GST_ACTIVATE_NONE:
550 ret = (GST_PAD_ACTIVATEFUNC (pad)) (pad);
551 break;
552 }
553 } else {
554 switch (old) {
555 case GST_ACTIVATE_PUSH:
556 ret = gst_pad_activate_push (pad, FALSE);
557 break;
558 case GST_ACTIVATE_PULL:
559 ret = gst_pad_activate_pull (pad, FALSE);
560 break;
561 case GST_ACTIVATE_NONE:
562 ret = TRUE;
563 break;
564 }
565 }
567 return ret;
568 }
570 /**
571 * gst_pad_activate_pull:
572 * @pad: the #GstPad to activate or deactivate.
573 * @active: whether or not the pad should be active.
574 *
575 * Activates or deactivates the given pad in pull mode via dispatching to the
576 * pad's activatepullfunc. For use from within pad activation functions only.
577 * When called on sink pads, will first proxy the call to the peer pad, which is
578 * expected to activate its internally linked pads from within its activate_pull
579 * function.
580 *
581 * If you don't know what this is, you probably don't want to call it.
582 *
583 * Returns: TRUE if the operation was successfull.
584 *
585 * MT safe.
586 */
587 gboolean
588 gst_pad_activate_pull (GstPad * pad, gboolean active)
589 {
590 GstActivateMode old;
592 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
594 GST_LOCK (pad);
595 old = GST_PAD_ACTIVATE_MODE (pad);
596 GST_UNLOCK (pad);
598 if ((active && old == GST_ACTIVATE_PULL)
599 || (!active && old == GST_ACTIVATE_NONE))
600 goto was_ok;
602 if (active) {
603 g_return_val_if_fail (old == GST_ACTIVATE_NONE, FALSE);
604 } else {
605 g_return_val_if_fail (old == GST_ACTIVATE_PULL, FALSE);
606 }
608 if (gst_pad_get_direction (pad) == GST_PAD_SINK) {
609 GstPad *peer = gst_pad_get_peer (pad);
611 if (peer) {
612 if (!gst_pad_activate_pull (peer, active)) {
613 GST_LOCK (peer);
614 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
615 "activate_pull on peer (%s:%s) failed", GST_DEBUG_PAD_NAME (peer));
616 GST_UNLOCK (peer);
617 gst_object_unref (peer);
618 goto failure;
619 }
620 }
621 }
623 pre_activate_switch (pad, active);
625 if (GST_PAD_ACTIVATEPULLFUNC (pad)) {
626 if (GST_PAD_ACTIVATEPULLFUNC (pad) (pad, active)) {
627 goto success;
628 } else {
629 goto failure;
630 }
631 } else {
632 /* can happen for sinks of passthrough elements */
633 goto success;
634 }
636 was_ok:
637 {
638 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in pull mode",
639 active ? "activated" : "deactivated");
640 return TRUE;
641 }
643 success:
644 {
645 GST_LOCK (pad);
646 GST_PAD_ACTIVATE_MODE (pad) =
647 active ? GST_ACTIVATE_PULL : GST_ACTIVATE_NONE;
648 GST_UNLOCK (pad);
649 post_activate_switch (pad, active);
651 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in pull mode",
652 active ? "activated" : "deactivated");
653 return TRUE;
654 }
656 failure:
657 {
658 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in pull mode",
659 active ? "activate" : "deactivate");
660 return FALSE;
661 }
662 }
664 /**
665 * gst_pad_activate_push:
666 * @pad: the #GstPad to activate or deactivate.
667 * @active: whether or not the pad should be active.
668 *
669 * Activates or deactivates the given pad in push mode via dispatching to the
670 * pad's activatepushfunc. For use from within pad activation functions only.
671 *
672 * If you don't know what this is, you probably don't want to call it.
673 *
674 * Returns: TRUE if the operation was successfull.
675 *
676 * MT safe.
677 */
678 gboolean
679 gst_pad_activate_push (GstPad * pad, gboolean active)
680 {
681 GstActivateMode old;
683 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
684 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "trying to set %s in push mode",
685 active ? "activated" : "deactivated");
687 GST_LOCK (pad);
688 old = GST_PAD_ACTIVATE_MODE (pad);
689 GST_UNLOCK (pad);
691 if ((active && old == GST_ACTIVATE_PUSH)
692 || (!active && old == GST_ACTIVATE_NONE))
693 goto was_ok;
695 if (active) {
696 g_return_val_if_fail (old == GST_ACTIVATE_NONE, FALSE);
697 } else {
698 g_return_val_if_fail (old == GST_ACTIVATE_PUSH, FALSE);
699 }
701 pre_activate_switch (pad, active);
703 if (GST_PAD_ACTIVATEPUSHFUNC (pad)) {
704 if (GST_PAD_ACTIVATEPUSHFUNC (pad) (pad, active)) {
705 goto success;
706 } else {
707 goto failure;
708 }
709 } else {
710 /* quite ok, element relies on state change func to prepare itself */
711 goto success;
712 }
714 was_ok:
715 {
716 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "already %s in push mode",
717 active ? "activated" : "deactivated");
718 return TRUE;
719 }
721 success:
722 {
723 GST_LOCK (pad);
724 GST_PAD_ACTIVATE_MODE (pad) =
725 active ? GST_ACTIVATE_PUSH : GST_ACTIVATE_NONE;
726 GST_UNLOCK (pad);
727 post_activate_switch (pad, active);
729 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "%s in push mode",
730 active ? "activated" : "deactivated");
731 return TRUE;
732 }
734 failure:
735 {
736 GST_CAT_INFO_OBJECT (GST_CAT_PADS, pad, "failed to %s in push mode",
737 active ? "activate" : "deactivate");
738 return FALSE;
739 }
740 }
742 /**
743 * gst_pad_is_active:
744 * @pad: the #GstPad to query
745 *
746 * Query if a pad is active
747 *
748 * Returns: TRUE if the pad is active.
749 *
750 * MT safe.
751 */
752 gboolean
753 gst_pad_is_active (GstPad * pad)
754 {
755 gboolean result = FALSE;
757 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
759 GST_LOCK (pad);
760 result = GST_PAD_MODE_ACTIVATE (GST_PAD_ACTIVATE_MODE (pad));
761 GST_UNLOCK (pad);
763 return result;
764 }
766 /**
767 * gst_pad_set_blocked_async:
768 * @pad: the #GstPad to block or unblock
769 * @blocked: boolean indicating we should block or unblock
770 * @callback: #GstPadBlockCallback that will be called when the
771 * operation succeeds.
772 * @user_data: user data passed to the callback
773 *
774 * Blocks or unblocks the dataflow on a pad. The provided callback
775 * is called when the operation succeeds. This can take a while as
776 * the pad can only become blocked when real dataflow is happening.
777 * When the pipeline is stalled, for example in PAUSED, this can
778 * take an indeterminate amount of time.
779 * You can pass NULL as the callback to make this call block. Be
780 * carefull with this blocking call as it might not return for
781 * reasons stated above.
782 *
783 * Returns: TRUE if the pad could be blocked. This function can fail
784 * if wrong parameters were passed or the pad was already in the
785 * requested state.
786 *
787 * MT safe.
788 */
789 gboolean
790 gst_pad_set_blocked_async (GstPad * pad, gboolean blocked,
791 GstPadBlockCallback callback, gpointer user_data)
792 {
793 gboolean was_blocked;
795 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
797 GST_LOCK (pad);
799 was_blocked = GST_PAD_IS_BLOCKED (pad);
801 if (G_UNLIKELY (was_blocked == blocked))
802 goto had_right_state;
804 if (blocked) {
805 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "blocking pad %s:%s",
806 GST_DEBUG_PAD_NAME (pad));
808 GST_FLAG_SET (pad, GST_PAD_BLOCKED);
809 pad->block_callback = callback;
810 pad->block_data = user_data;
811 if (!callback) {
812 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "waiting for block");
813 GST_PAD_BLOCK_WAIT (pad);
814 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "blocked");
815 }
816 } else {
817 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "unblocking pad %s:%s",
818 GST_DEBUG_PAD_NAME (pad));
820 GST_FLAG_UNSET (pad, GST_PAD_BLOCKED);
822 pad->block_callback = callback;
823 pad->block_data = user_data;
825 if (callback) {
826 GST_PAD_BLOCK_SIGNAL (pad);
827 } else {
828 GST_PAD_BLOCK_SIGNAL (pad);
829 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "waiting for unblock");
830 GST_PAD_BLOCK_WAIT (pad);
831 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "unblocked");
832 }
833 }
834 GST_UNLOCK (pad);
836 return TRUE;
838 had_right_state:
839 {
840 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
841 "pad %s:%s was in right state", GST_DEBUG_PAD_NAME (pad));
842 GST_UNLOCK (pad);
843 return FALSE;
844 }
845 }
847 /**
848 * gst_pad_set_blocked:
849 * @pad: the #GstPad to block or unblock
850 * @blocked: boolean indicating we should block or unblock
851 *
852 * Blocks or unblocks the dataflow on a pad. This function is
853 * a shortcut for @gst_pad_set_blocked_async() with a NULL
854 * callback.
855 *
856 * Returns: TRUE if the pad could be blocked. This function can fail
857 * wrong parameters were passed or the pad was already in the
858 * requested state.
859 *
860 * MT safe.
861 */
862 gboolean
863 gst_pad_set_blocked (GstPad * pad, gboolean blocked)
864 {
865 return gst_pad_set_blocked_async (pad, blocked, NULL, NULL);
866 }
868 /**
869 * gst_pad_is_blocked:
870 * @pad: the #GstPad to query
871 *
872 * Checks if the pad is blocked or not. This function returns the
873 * last requested state of the pad. It is not certain that the pad
874 * is actually blocked at this point.
875 *
876 * Returns: TRUE if the pad is blocked.
877 *
878 * MT safe.
879 */
880 gboolean
881 gst_pad_is_blocked (GstPad * pad)
882 {
883 gboolean result = FALSE;
885 g_return_val_if_fail (GST_IS_PAD (pad), result);
887 GST_LOCK (pad);
888 result = GST_FLAG_IS_SET (pad, GST_PAD_BLOCKED);
889 GST_UNLOCK (pad);
891 return result;
892 }
894 /**
895 * gst_pad_set_activate_function:
896 * @pad: a sink #GstPad.
897 * @activate: the #GstPadActivateFunction to set.
898 *
899 * Sets the given activate function for the pad. The activate function will
900 * dispatch to activate_push or activate_pull to perform the actual activation.
901 * Only makes sense to set on sink pads.
902 *
903 * Call this function if your sink pad can start a pull-based task.
904 */
905 void
906 gst_pad_set_activate_function (GstPad * pad, GstPadActivateFunction activate)
907 {
908 g_return_if_fail (GST_IS_PAD (pad));
910 GST_PAD_ACTIVATEFUNC (pad) = activate;
911 GST_CAT_DEBUG (GST_CAT_PADS, "activatefunc for %s:%s set to %s",
912 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (activate));
913 }
915 /**
916 * gst_pad_set_activatepull_function:
917 * @pad: a sink #GstPad.
918 * @activatepull: the #GstPadActivateModeFunction to set.
919 *
920 * Sets the given activate_pull function for the pad. An activate_pull function
921 * prepares the element and any upstream connections for pulling. See XXX
922 * part-activation.txt for details.
923 */
924 void
925 gst_pad_set_activatepull_function (GstPad * pad,
926 GstPadActivateModeFunction activatepull)
927 {
928 g_return_if_fail (GST_IS_PAD (pad));
930 GST_PAD_ACTIVATEPULLFUNC (pad) = activatepull;
931 GST_CAT_DEBUG (GST_CAT_PADS, "activatepullfunc for %s:%s set to %s",
932 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (activatepull));
933 }
935 /**
936 * gst_pad_set_activatepush_function:
937 * @pad: a sink #GstPad.
938 * @activatepush: the #GstPadActivateModeFunction to set.
939 *
940 * Sets the given activate_push function for the pad. An activate_push function
941 * prepares the element for pushing. See XXX part-activation.txt for details.
942 */
943 void
944 gst_pad_set_activatepush_function (GstPad * pad,
945 GstPadActivateModeFunction activatepush)
946 {
947 g_return_if_fail (GST_IS_PAD (pad));
949 GST_PAD_ACTIVATEPUSHFUNC (pad) = activatepush;
950 GST_CAT_DEBUG (GST_CAT_PADS, "activatepushfunc for %s:%s set to %s",
951 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (activatepush));
952 }
954 /**
955 * gst_pad_set_chain_function:
956 * @pad: a sink #GstPad.
957 * @chain: the #GstPadChainFunction to set.
958 *
959 * Sets the given chain function for the pad. The chain function is called to
960 * process a #GstBuffer input buffer.
961 */
962 void
963 gst_pad_set_chain_function (GstPad * pad, GstPadChainFunction chain)
964 {
965 g_return_if_fail (GST_IS_PAD (pad));
966 g_return_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SINK);
968 GST_PAD_CHAINFUNC (pad) = chain;
969 GST_CAT_DEBUG (GST_CAT_PADS, "chainfunc for %s:%s set to %s",
970 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (chain));
971 }
973 /**
974 * gst_pad_set_getrange_function:
975 * @pad: a source #GstPad.
976 * @get: the #GstPadGetRangeFunction to set.
977 *
978 * Sets the given getrange function for the pad. The getrange function is called to
979 * produce a new #GstBuffer to start the processing pipeline. Getrange functions cannot
980 * return %NULL.
981 */
982 void
983 gst_pad_set_getrange_function (GstPad * pad, GstPadGetRangeFunction get)
984 {
985 g_return_if_fail (GST_IS_PAD (pad));
986 g_return_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SRC);
988 GST_PAD_GETRANGEFUNC (pad) = get;
990 GST_CAT_DEBUG (GST_CAT_PADS, "getrangefunc for %s:%s set to %s",
991 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (get));
992 }
994 /**
995 * gst_pad_set_checkgetrange_function:
996 * @pad: a source #GstPad.
997 * @check: the #GstPadCheckGetRangeFunction to set.
998 *
999 * Sets the given checkgetrange function for the pad. Implement this function on
1000 * a pad if you dynamically support getrange based scheduling on the pad.
1001 */
1002 void
1003 gst_pad_set_checkgetrange_function (GstPad * pad,
1004 GstPadCheckGetRangeFunction check)
1005 {
1006 g_return_if_fail (GST_IS_PAD (pad));
1007 g_return_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SRC);
1009 GST_PAD_CHECKGETRANGEFUNC (pad) = check;
1011 GST_CAT_DEBUG (GST_CAT_PADS, "checkgetrangefunc for %s:%s set to %s",
1012 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (check));
1013 }
1015 /**
1016 * gst_pad_set_event_function:
1017 * @pad: a source #GstPad.
1018 * @event: the #GstPadEventFunction to set.
1019 *
1020 * Sets the given event handler for the pad.
1021 */
1022 void
1023 gst_pad_set_event_function (GstPad * pad, GstPadEventFunction event)
1024 {
1025 g_return_if_fail (GST_IS_PAD (pad));
1027 GST_PAD_EVENTFUNC (pad) = event;
1029 GST_CAT_DEBUG (GST_CAT_PADS, "eventfunc for %s:%s set to %s",
1030 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (event));
1031 }
1033 /**
1034 * gst_pad_set_query_function:
1035 * @pad: a #GstPad of either direction.
1036 * @query: the #GstPadQueryFunction to set.
1037 *
1038 * Set the given query function for the pad.
1039 */
1040 void
1041 gst_pad_set_query_function (GstPad * pad, GstPadQueryFunction query)
1042 {
1043 g_return_if_fail (GST_IS_PAD (pad));
1045 GST_PAD_QUERYFUNC (pad) = query;
1047 GST_CAT_DEBUG (GST_CAT_PADS, "queryfunc for %s:%s set to %s",
1048 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (query));
1049 }
1051 /**
1052 * gst_pad_set_query_type_function:
1053 * @pad: a #GstPad of either direction.
1054 * @type_func: the #GstPadQueryTypeFunction to set.
1055 *
1056 * Set the given query type function for the pad.
1057 */
1058 void
1059 gst_pad_set_query_type_function (GstPad * pad,
1060 GstPadQueryTypeFunction type_func)
1061 {
1062 g_return_if_fail (GST_IS_PAD (pad));
1064 GST_PAD_QUERYTYPEFUNC (pad) = type_func;
1066 GST_CAT_DEBUG (GST_CAT_PADS, "querytypefunc for %s:%s set to %s",
1067 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (type_func));
1068 }
1070 /**
1071 * gst_pad_get_query_types:
1072 * @pad: a #GstPad.
1073 *
1074 * Get an array of supported queries that can be performed
1075 * on this pad.
1076 *
1077 * Returns: a zero-terminated array of #GstQueryType.
1078 */
1079 const GstQueryType *
1080 gst_pad_get_query_types (GstPad * pad)
1081 {
1082 GstPadQueryTypeFunction func;
1084 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1086 if (G_UNLIKELY ((func = GST_PAD_QUERYTYPEFUNC (pad)) == NULL))
1087 goto no_func;
1089 return func (pad);
1091 no_func:
1092 {
1093 return NULL;
1094 }
1095 }
1097 static gboolean
1098 gst_pad_get_query_types_dispatcher (GstPad * pad, const GstQueryType ** data)
1099 {
1100 *data = gst_pad_get_query_types (pad);
1102 return TRUE;
1103 }
1105 /**
1106 * gst_pad_get_query_types_default:
1107 * @pad: a #GstPad.
1108 *
1109 * Invoke the default dispatcher for the query types on
1110 * the pad.
1111 *
1112 * Returns: an zero-terminated array of #GstQueryType, or NULL if none of the
1113 * internally-linked pads has a query types function.
1114 */
1115 const GstQueryType *
1116 gst_pad_get_query_types_default (GstPad * pad)
1117 {
1118 GstQueryType *result = NULL;
1120 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1122 gst_pad_dispatcher (pad, (GstPadDispatcherFunction)
1123 gst_pad_get_query_types_dispatcher, &result);
1125 return result;
1126 }
1128 /**
1129 * gst_pad_set_internal_link_function:
1130 * @pad: a #GstPad of either direction.
1131 * @intlink: the #GstPadIntLinkFunction to set.
1132 *
1133 * Sets the given internal link function for the pad.
1134 */
1135 void
1136 gst_pad_set_internal_link_function (GstPad * pad, GstPadIntLinkFunction intlink)
1137 {
1138 g_return_if_fail (GST_IS_PAD (pad));
1140 GST_PAD_INTLINKFUNC (pad) = intlink;
1141 GST_CAT_DEBUG (GST_CAT_PADS, "internal link for %s:%s set to %s",
1142 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (intlink));
1143 }
1145 /**
1146 * gst_pad_set_link_function:
1147 * @pad: a #GstPad.
1148 * @link: the #GstPadLinkFunction to set.
1149 *
1150 * Sets the given link function for the pad. It will be called when the pad is
1151 * linked or relinked with caps. The caps passed to the link function is
1152 * the caps for the connnection. It can contain a non fixed caps.
1153 *
1154 * The return value GST_PAD_LINK_OK should be used when the connection can be
1155 * made.
1156 *
1157 * The return value GST_PAD_LINK_REFUSED should be used when the connection
1158 * cannot be made for some reason.
1159 */
1160 void
1161 gst_pad_set_link_function (GstPad * pad, GstPadLinkFunction link)
1162 {
1163 g_return_if_fail (GST_IS_PAD (pad));
1165 GST_PAD_LINKFUNC (pad) = link;
1166 GST_CAT_DEBUG (GST_CAT_PADS, "linkfunc for %s:%s set to %s",
1167 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (link));
1168 }
1170 /**
1171 * gst_pad_set_unlink_function:
1172 * @pad: a #GstPad.
1173 * @unlink: the #GstPadUnlinkFunction to set.
1174 *
1175 * Sets the given unlink function for the pad. It will be called
1176 * when the pad is unlinked.
1177 */
1178 void
1179 gst_pad_set_unlink_function (GstPad * pad, GstPadUnlinkFunction unlink)
1180 {
1181 g_return_if_fail (GST_IS_PAD (pad));
1183 GST_PAD_UNLINKFUNC (pad) = unlink;
1184 GST_CAT_DEBUG (GST_CAT_PADS, "unlinkfunc for %s:%s set to %s",
1185 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (unlink));
1186 }
1188 /**
1189 * gst_pad_set_getcaps_function:
1190 * @pad: a #GstPad.
1191 * @getcaps: the #GstPadGetCapsFunction to set.
1192 *
1193 * Sets the given getcaps function for the pad. @getcaps should return the
1194 * allowable caps for a pad in the context of the element's state, its link to
1195 * other elements, and the devices or files it has opened. These caps must be a
1196 * subset of the pad template caps. In the NULL state with no links, @getcaps
1197 * should ideally return the same caps as the pad template. In rare
1198 * circumstances, an object property can affect the caps returned by @getcaps,
1199 * but this is discouraged.
1200 *
1201 * You do not need to call this function if @pad's allowed caps are always the
1202 * same as the pad template caps. This can only be true if the padtemplate
1203 * has fixed simple caps.
1204 *
1205 * For most filters, the caps returned by @getcaps is directly affected by the
1206 * allowed caps on other pads. For demuxers and decoders, the caps returned by
1207 * the srcpad's getcaps function is directly related to the stream data. Again,
1208 * @getcaps should return the most specific caps it reasonably can, since this
1209 * helps with autoplugging.
1210 *
1211 * Note that the return value from @getcaps is owned by the caller, so the caller
1212 * should unref the caps after usage.
1213 */
1214 void
1215 gst_pad_set_getcaps_function (GstPad * pad, GstPadGetCapsFunction getcaps)
1216 {
1217 g_return_if_fail (GST_IS_PAD (pad));
1219 GST_PAD_GETCAPSFUNC (pad) = getcaps;
1220 GST_CAT_DEBUG (GST_CAT_PADS, "getcapsfunc for %s:%s set to %s",
1221 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (getcaps));
1222 }
1224 /**
1225 * gst_pad_set_acceptcaps_function:
1226 * @pad: a #GstPad.
1227 * @acceptcaps: the #GstPadAcceptCapsFunction to set.
1228 *
1229 * Sets the given acceptcaps function for the pad. The acceptcaps function
1230 * will be called to check if the pad can accept the given caps.
1231 */
1232 void
1233 gst_pad_set_acceptcaps_function (GstPad * pad,
1234 GstPadAcceptCapsFunction acceptcaps)
1235 {
1236 g_return_if_fail (GST_IS_PAD (pad));
1238 GST_PAD_ACCEPTCAPSFUNC (pad) = acceptcaps;
1239 GST_CAT_DEBUG (GST_CAT_PADS, "acceptcapsfunc for %s:%s set to %s",
1240 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (acceptcaps));
1241 }
1243 /**
1244 * gst_pad_set_fixatecaps_function:
1245 * @pad: a #GstPad.
1246 * @fixatecaps: the #GstPadFixateCapsFunction to set.
1247 *
1248 * Sets the given fixatecaps function for the pad. The fixatecaps function
1249 * will be called whenever the default values for a GstCaps needs to be
1250 * filled in.
1251 */
1252 void
1253 gst_pad_set_fixatecaps_function (GstPad * pad,
1254 GstPadFixateCapsFunction fixatecaps)
1255 {
1256 g_return_if_fail (GST_IS_PAD (pad));
1258 GST_PAD_FIXATECAPSFUNC (pad) = fixatecaps;
1259 GST_CAT_DEBUG (GST_CAT_PADS, "fixatecapsfunc for %s:%s set to %s",
1260 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (fixatecaps));
1261 }
1263 /**
1264 * gst_pad_set_setcaps_function:
1265 * @pad: a #GstPad.
1266 * @setcaps: the #GstPadSetCapsFunction to set.
1267 *
1268 * Sets the given setcaps function for the pad. The setcaps function
1269 * will be called whenever a buffer with a new media type is pushed or
1270 * pulled from the pad. The pad/element needs to update it's internal
1271 * structures to process the new media type. If this new type is not
1272 * acceptable, the setcaps function should return FALSE.
1273 */
1274 void
1275 gst_pad_set_setcaps_function (GstPad * pad, GstPadSetCapsFunction setcaps)
1276 {
1277 g_return_if_fail (GST_IS_PAD (pad));
1279 GST_PAD_SETCAPSFUNC (pad) = setcaps;
1280 GST_CAT_DEBUG (GST_CAT_PADS, "setcapsfunc for %s:%s set to %s",
1281 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (setcaps));
1282 }
1284 /**
1285 * gst_pad_set_bufferalloc_function:
1286 * @pad: a sink #GstPad.
1287 * @bufalloc: the #GstPadBufferAllocFunction to set.
1288 *
1289 * Sets the given bufferalloc function for the pad. Note that the
1290 * bufferalloc function can only be set on sinkpads.
1291 */
1292 void
1293 gst_pad_set_bufferalloc_function (GstPad * pad,
1294 GstPadBufferAllocFunction bufalloc)
1295 {
1296 g_return_if_fail (GST_IS_PAD (pad));
1297 g_return_if_fail (GST_PAD_IS_SINK (pad));
1299 GST_PAD_BUFFERALLOCFUNC (pad) = bufalloc;
1300 GST_CAT_DEBUG (GST_CAT_PADS, "bufferallocfunc for %s:%s set to %s",
1301 GST_DEBUG_PAD_NAME (pad), GST_DEBUG_FUNCPTR_NAME (bufalloc));
1302 }
1304 /**
1305 * gst_pad_unlink:
1306 * @srcpad: the source #GstPad to unlink.
1307 * @sinkpad: the sink #GstPad to unlink.
1308 *
1309 * Unlinks the source pad from the sink pad. Will emit the "unlinked" signal on
1310 * both pads.
1311 *
1312 * Returns: TRUE if the pads were unlinked. This function returns FALSE if
1313 * the pads were not linked together.
1314 *
1315 * MT safe.
1316 */
1317 gboolean
1318 gst_pad_unlink (GstPad * srcpad, GstPad * sinkpad)
1319 {
1320 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1321 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1323 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinking %s:%s(%p) and %s:%s(%p)",
1324 GST_DEBUG_PAD_NAME (srcpad), srcpad,
1325 GST_DEBUG_PAD_NAME (sinkpad), sinkpad);
1327 GST_LOCK (srcpad);
1329 if (G_UNLIKELY (GST_PAD_DIRECTION (srcpad) != GST_PAD_SRC))
1330 goto not_srcpad;
1332 GST_LOCK (sinkpad);
1334 if (G_UNLIKELY (GST_PAD_DIRECTION (sinkpad) != GST_PAD_SINK))
1335 goto not_sinkpad;
1337 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != sinkpad))
1338 goto not_linked_together;
1340 if (GST_PAD_UNLINKFUNC (srcpad)) {
1341 GST_PAD_UNLINKFUNC (srcpad) (srcpad);
1342 }
1343 if (GST_PAD_UNLINKFUNC (sinkpad)) {
1344 GST_PAD_UNLINKFUNC (sinkpad) (sinkpad);
1345 }
1347 /* first clear peers */
1348 GST_PAD_PEER (srcpad) = NULL;
1349 GST_PAD_PEER (sinkpad) = NULL;
1351 GST_UNLOCK (sinkpad);
1352 GST_UNLOCK (srcpad);
1354 /* fire off a signal to each of the pads telling them
1355 * that they've been unlinked */
1356 g_signal_emit (G_OBJECT (srcpad), gst_pad_signals[PAD_UNLINKED], 0, sinkpad);
1357 g_signal_emit (G_OBJECT (sinkpad), gst_pad_signals[PAD_UNLINKED], 0, srcpad);
1359 GST_CAT_INFO (GST_CAT_ELEMENT_PADS, "unlinked %s:%s and %s:%s",
1360 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1362 return TRUE;
1364 not_srcpad:
1365 {
1366 g_critical ("pad %s is not a source pad", GST_PAD_NAME (srcpad));
1367 GST_UNLOCK (srcpad);
1368 return FALSE;
1369 }
1370 not_sinkpad:
1371 {
1372 g_critical ("pad %s is not a sink pad", GST_PAD_NAME (sinkpad));
1373 GST_UNLOCK (sinkpad);
1374 GST_UNLOCK (srcpad);
1375 return FALSE;
1376 }
1377 not_linked_together:
1378 {
1379 /* we do not emit a warning in this case because unlinking cannot
1380 * be made MT safe.*/
1381 GST_UNLOCK (sinkpad);
1382 GST_UNLOCK (srcpad);
1383 return FALSE;
1384 }
1385 }
1387 /**
1388 * gst_pad_is_linked:
1389 * @pad: pad to check
1390 *
1391 * Checks if a @pad is linked to another pad or not.
1392 *
1393 * Returns: TRUE if the pad is linked, FALSE otherwise.
1394 *
1395 * MT safe.
1396 */
1397 gboolean
1398 gst_pad_is_linked (GstPad * pad)
1399 {
1400 gboolean result;
1402 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1404 GST_LOCK (pad);
1405 result = (GST_PAD_PEER (pad) != NULL);
1406 GST_UNLOCK (pad);
1408 return result;
1409 }
1411 /* get the caps from both pads and see if the intersection
1412 * is not empty.
1413 *
1414 * This function should be called with the pad LOCK on both
1415 * pads
1416 */
1417 static gboolean
1418 gst_pad_link_check_compatible_unlocked (GstPad * src, GstPad * sink)
1419 {
1420 GstCaps *srccaps;
1421 GstCaps *sinkcaps;
1423 srccaps = gst_pad_get_caps_unlocked (src);
1424 sinkcaps = gst_pad_get_caps_unlocked (sink);
1425 GST_CAT_DEBUG (GST_CAT_CAPS, " src caps %" GST_PTR_FORMAT, srccaps);
1426 GST_CAT_DEBUG (GST_CAT_CAPS, "sink caps %" GST_PTR_FORMAT, sinkcaps);
1428 /* if we have caps on both pads we can check the intersection */
1429 if (srccaps && sinkcaps) {
1430 GstCaps *icaps;
1432 icaps = gst_caps_intersect (srccaps, sinkcaps);
1433 gst_caps_unref (srccaps);
1434 gst_caps_unref (sinkcaps);
1436 GST_CAT_DEBUG (GST_CAT_CAPS,
1437 "intersection caps %p %" GST_PTR_FORMAT, icaps, icaps);
1439 if (!icaps || gst_caps_is_empty (icaps)) {
1440 GST_CAT_DEBUG (GST_CAT_CAPS, "intersection is empty");
1441 gst_caps_unref (icaps);
1442 return FALSE;
1443 }
1444 gst_caps_unref (icaps);
1445 }
1447 return TRUE;
1448 }
1450 /* check if the grandparents of both pads are the same.
1451 * This check is required so that we don't try to link
1452 * pads from elements in different bins without ghostpads.
1453 *
1454 * The LOCK should be helt on both pads
1455 */
1456 static gboolean
1457 gst_pad_link_check_hierarchy (GstPad * src, GstPad * sink)
1458 {
1459 GstObject *psrc, *psink;
1460 gboolean res = TRUE;
1462 psrc = GST_OBJECT_PARENT (src);
1463 psink = GST_OBJECT_PARENT (sink);
1465 /* if one of the pads has no parent, we allow the link */
1466 if (psrc && psink) {
1467 /* if the parents are the same, we have a loop */
1468 if (psrc == psink) {
1469 GST_CAT_DEBUG (GST_CAT_CAPS, "pads have same parent %" GST_PTR_FORMAT,
1470 psrc);
1471 res = FALSE;
1472 goto done;
1473 }
1474 /* if they both have a parent, we check the grandparents */
1475 psrc = gst_object_get_parent (psrc);
1476 psink = gst_object_get_parent (psink);
1478 if (psrc != psink) {
1479 /* if they have grandparents but they are not the same */
1480 GST_CAT_DEBUG (GST_CAT_CAPS,
1481 "pads have different grandparents %" GST_PTR_FORMAT " and %"
1482 GST_PTR_FORMAT, psrc, psink);
1483 res = FALSE;
1484 }
1485 if (psrc)
1486 gst_object_unref (psrc);
1487 if (psink)
1488 gst_object_unref (psink);
1489 }
1490 done:
1491 return res;
1492 }
1494 /* FIXME leftover from an attempt at refactoring... */
1495 /* call with the two pads unlocked */
1496 static GstPadLinkReturn
1497 gst_pad_link_prepare (GstPad * srcpad, GstPad * sinkpad)
1498 {
1499 /* generic checks */
1500 g_return_val_if_fail (GST_IS_PAD (srcpad), GST_PAD_LINK_REFUSED);
1501 g_return_val_if_fail (GST_IS_PAD (sinkpad), GST_PAD_LINK_REFUSED);
1503 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
1504 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1506 GST_LOCK (srcpad);
1508 if (G_UNLIKELY (GST_PAD_DIRECTION (srcpad) != GST_PAD_SRC))
1509 goto not_srcpad;
1511 if (G_UNLIKELY (GST_PAD_PEER (srcpad) != NULL))
1512 goto src_was_linked;
1514 GST_LOCK (sinkpad);
1516 if (G_UNLIKELY (GST_PAD_DIRECTION (sinkpad) != GST_PAD_SINK))
1517 goto not_sinkpad;
1519 if (G_UNLIKELY (GST_PAD_PEER (sinkpad) != NULL))
1520 goto sink_was_linked;
1522 /* check hierarchy, pads can only be linked if the grandparents
1523 * are the same. */
1524 if (!gst_pad_link_check_hierarchy (srcpad, sinkpad))
1525 goto wrong_hierarchy;
1527 /* check pad caps for non-empty intersection */
1528 if (!gst_pad_link_check_compatible_unlocked (srcpad, sinkpad))
1529 goto no_format;
1531 /* FIXME check pad scheduling for non-empty intersection */
1533 return GST_PAD_LINK_OK;
1535 not_srcpad:
1536 {
1537 g_critical ("pad %s is not a source pad", GST_PAD_NAME (srcpad));
1538 GST_UNLOCK (srcpad);
1539 return GST_PAD_LINK_WRONG_DIRECTION;
1540 }
1541 src_was_linked:
1542 {
1543 GST_CAT_INFO (GST_CAT_PADS, "src %s:%s was linked",
1544 GST_DEBUG_PAD_NAME (srcpad));
1545 /* we do not emit a warning in this case because unlinking cannot
1546 * be made MT safe.*/
1547 GST_UNLOCK (srcpad);
1548 return GST_PAD_LINK_WAS_LINKED;
1549 }
1550 not_sinkpad:
1551 {
1552 g_critical ("pad %s is not a sink pad", GST_PAD_NAME (sinkpad));
1553 GST_UNLOCK (sinkpad);
1554 GST_UNLOCK (srcpad);
1555 return GST_PAD_LINK_WRONG_DIRECTION;
1556 }
1557 sink_was_linked:
1558 {
1559 GST_CAT_INFO (GST_CAT_PADS, "sink %s:%s was linked",
1560 GST_DEBUG_PAD_NAME (sinkpad));
1561 /* we do not emit a warning in this case because unlinking cannot
1562 * be made MT safe.*/
1563 GST_UNLOCK (sinkpad);
1564 GST_UNLOCK (srcpad);
1565 return GST_PAD_LINK_WAS_LINKED;
1566 }
1567 wrong_hierarchy:
1568 {
1569 GST_CAT_INFO (GST_CAT_PADS, "pads have wrong hierarchy");
1570 GST_UNLOCK (sinkpad);
1571 GST_UNLOCK (srcpad);
1572 return GST_PAD_LINK_WRONG_HIERARCHY;
1573 }
1574 no_format:
1575 {
1576 GST_CAT_INFO (GST_CAT_PADS, "caps are incompatible");
1577 GST_UNLOCK (sinkpad);
1578 GST_UNLOCK (srcpad);
1579 return GST_PAD_LINK_NOFORMAT;
1580 }
1581 }
1583 /**
1584 * gst_pad_link:
1585 * @srcpad: the source #GstPad to link.
1586 * @sinkpad: the sink #GstPad to link.
1587 *
1588 * Links the source pad and the sink pad.
1589 *
1590 * Returns: A result code indicating if the connection worked or
1591 * what went wrong.
1592 *
1593 * MT Safe.
1594 */
1595 GstPadLinkReturn
1596 gst_pad_link (GstPad * srcpad, GstPad * sinkpad)
1597 {
1598 GstPadLinkReturn result;
1600 /* prepare will also lock the two pads */
1601 result = gst_pad_link_prepare (srcpad, sinkpad);
1603 if (result != GST_PAD_LINK_OK)
1604 goto prepare_failed;
1606 GST_UNLOCK (sinkpad);
1607 GST_UNLOCK (srcpad);
1609 /* FIXME released the locks here, concurrent thread might link
1610 * something else. */
1611 if (GST_PAD_LINKFUNC (srcpad)) {
1612 /* this one will call the peer link function */
1613 result = GST_PAD_LINKFUNC (srcpad) (srcpad, sinkpad);
1614 } else if (GST_PAD_LINKFUNC (sinkpad)) {
1615 /* if no source link function, we need to call the sink link
1616 * function ourselves. */
1617 result = GST_PAD_LINKFUNC (sinkpad) (sinkpad, srcpad);
1618 } else {
1619 result = GST_PAD_LINK_OK;
1620 }
1622 GST_LOCK (srcpad);
1623 GST_LOCK (sinkpad);
1625 if (result == GST_PAD_LINK_OK) {
1626 GST_PAD_PEER (srcpad) = sinkpad;
1627 GST_PAD_PEER (sinkpad) = srcpad;
1629 GST_UNLOCK (sinkpad);
1630 GST_UNLOCK (srcpad);
1632 /* fire off a signal to each of the pads telling them
1633 * that they've been linked */
1634 g_signal_emit (G_OBJECT (srcpad), gst_pad_signals[PAD_LINKED], 0, sinkpad);
1635 g_signal_emit (G_OBJECT (sinkpad), gst_pad_signals[PAD_LINKED], 0, srcpad);
1637 GST_CAT_INFO (GST_CAT_PADS, "linked %s:%s and %s:%s, successful",
1638 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1639 } else {
1640 GST_CAT_INFO (GST_CAT_PADS, "link between %s:%s and %s:%s failed",
1641 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1643 GST_UNLOCK (sinkpad);
1644 GST_UNLOCK (srcpad);
1645 }
1646 return result;
1648 prepare_failed:
1649 {
1650 return result;
1651 }
1652 }
1654 static void
1655 gst_pad_set_pad_template (GstPad * pad, GstPadTemplate * templ)
1656 {
1657 /* this function would need checks if it weren't static */
1659 GST_LOCK (pad);
1660 gst_object_replace ((GstObject **) & pad->padtemplate, (GstObject *) templ);
1661 GST_UNLOCK (pad);
1663 if (templ)
1664 gst_pad_template_pad_created (templ, pad);
1665 }
1667 /**
1668 * gst_pad_get_pad_template:
1669 * @pad: a #GstPad.
1670 *
1671 * Gets the template for @pad.
1672 *
1673 * Returns: the #GstPadTemplate from which this pad was instantiated, or %NULL
1674 * if this pad has no template.
1675 *
1676 * FIXME: currently returns an unrefcounted padtemplate.
1677 */
1678 GstPadTemplate *
1679 gst_pad_get_pad_template (GstPad * pad)
1680 {
1681 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1683 return GST_PAD_PAD_TEMPLATE (pad);
1684 }
1687 /* should be called with the pad LOCK held */
1688 /* refs the caps, so caller is responsible for getting it unreffed */
1689 static GstCaps *
1690 gst_pad_get_caps_unlocked (GstPad * pad)
1691 {
1692 GstCaps *result = NULL;
1694 GST_CAT_DEBUG (GST_CAT_CAPS, "get pad caps of %s:%s (%p)",
1695 GST_DEBUG_PAD_NAME (pad), pad);
1697 if (GST_PAD_GETCAPSFUNC (pad)) {
1698 GST_CAT_DEBUG (GST_CAT_CAPS, "dispatching to pad getcaps function");
1700 GST_FLAG_SET (pad, GST_PAD_IN_GETCAPS);
1701 GST_UNLOCK (pad);
1702 result = GST_PAD_GETCAPSFUNC (pad) (pad);
1703 GST_LOCK (pad);
1704 GST_FLAG_UNSET (pad, GST_PAD_IN_GETCAPS);
1706 if (result == NULL) {
1707 g_critical ("pad %s:%s returned NULL caps from getcaps function",
1708 GST_DEBUG_PAD_NAME (pad));
1709 } else {
1710 GST_CAT_DEBUG (GST_CAT_CAPS,
1711 "pad getcaps %s:%s returned %" GST_PTR_FORMAT,
1712 GST_DEBUG_PAD_NAME (pad), result);
1713 #ifndef G_DISABLE_ASSERT
1714 /* check that the returned caps are a real subset of the template caps */
1715 if (GST_PAD_PAD_TEMPLATE (pad)) {
1716 const GstCaps *templ_caps =
1717 GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (pad));
1718 if (!gst_caps_is_subset (result, templ_caps)) {
1719 GstCaps *temp;
1721 GST_CAT_ERROR_OBJECT (GST_CAT_CAPS, pad,
1722 "pad returned caps %" GST_PTR_FORMAT
1723 " which are not a real subset of its template caps %"
1724 GST_PTR_FORMAT, result, templ_caps);
1725 g_warning
1726 ("pad %s:%s returned caps that are not a real subset of its template caps",
1727 GST_DEBUG_PAD_NAME (pad));
1728 temp = gst_caps_intersect (templ_caps, result);
1729 gst_caps_unref (result);
1730 result = temp;
1731 }
1732 }
1733 #endif
1734 goto done;
1735 }
1736 }
1737 if (GST_PAD_PAD_TEMPLATE (pad)) {
1738 GstPadTemplate *templ = GST_PAD_PAD_TEMPLATE (pad);
1740 result = GST_PAD_TEMPLATE_CAPS (templ);
1741 GST_CAT_DEBUG (GST_CAT_CAPS,
1742 "using pad template %p with caps %p %" GST_PTR_FORMAT, templ, result,
1743 result);
1745 result = gst_caps_ref (result);
1746 goto done;
1747 }
1748 if (GST_PAD_CAPS (pad)) {
1749 result = GST_PAD_CAPS (pad);
1751 GST_CAT_DEBUG (GST_CAT_CAPS,
1752 "using pad caps %p %" GST_PTR_FORMAT, result, result);
1754 result = gst_caps_ref (result);
1755 goto done;
1756 }
1758 GST_CAT_DEBUG (GST_CAT_CAPS, "pad has no caps");
1759 result = gst_caps_new_empty ();
1761 done:
1762 return result;
1763 }
1765 /**
1766 * gst_pad_get_caps:
1767 * @pad: a #GstPad to get the capabilities of.
1768 *
1769 * Gets the capabilities this pad can produce or consume.
1770 * Note that this method doesn't necessarily returns the caps set by
1771 * #gst_pad_set_caps - use #GST_PAD_CAPS for that instead.
1772 * gst_pad_get_caps returns all possible caps a pad can operate with, using
1773 * the pad's get_caps function;
1774 * this returns the pad template caps if not explicitly set.
1775 *
1776 * Returns: a newly allocated copy of the #GstCaps of this pad.
1777 *
1778 * MT safe.
1779 */
1780 GstCaps *
1781 gst_pad_get_caps (GstPad * pad)
1782 {
1783 GstCaps *result = NULL;
1785 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1787 GST_LOCK (pad);
1789 GST_CAT_DEBUG (GST_CAT_CAPS, "get pad caps of %s:%s (%p)",
1790 GST_DEBUG_PAD_NAME (pad), pad);
1792 if (G_UNLIKELY (GST_PAD_IS_IN_GETCAPS (pad)))
1793 goto was_dispatching;
1795 result = gst_pad_get_caps_unlocked (pad);
1796 GST_UNLOCK (pad);
1798 return result;
1800 was_dispatching:
1801 {
1802 GST_CAT_DEBUG (GST_CAT_CAPS,
1803 "pad %s:%s is already dispatching!", GST_DEBUG_PAD_NAME (pad));
1804 g_warning ("pad %s:%s recursively called getcaps!",
1805 GST_DEBUG_PAD_NAME (pad));
1806 GST_UNLOCK (pad);
1807 return NULL;
1808 }
1809 }
1811 /**
1812 * gst_pad_peer_get_caps:
1813 * @pad: a #GstPad to get the peer capabilities of.
1814 *
1815 * Gets the capabilities of the peer connected to this pad.
1816 *
1817 * Returns: the #GstCaps of the peer pad. This function returns a new caps, so use
1818 * gst_caps_unref to get rid of it. this function returns NULL if there is no
1819 * peer pad or when this function is called recursively from a getcaps function.
1820 */
1821 GstCaps *
1822 gst_pad_peer_get_caps (GstPad * pad)
1823 {
1824 GstPad *peerpad;
1825 GstCaps *result = NULL;
1827 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1829 GST_LOCK (pad);
1831 GST_CAT_DEBUG (GST_CAT_CAPS, "get peer caps of %s:%s (%p)",
1832 GST_DEBUG_PAD_NAME (pad), pad);
1834 peerpad = GST_PAD_PEER (pad);
1835 if (G_UNLIKELY (peerpad == NULL))
1836 goto no_peer;
1838 if (G_UNLIKELY (GST_PAD_IS_IN_GETCAPS (peerpad)))
1839 goto was_dispatching;
1841 gst_object_ref (peerpad);
1842 GST_UNLOCK (pad);
1844 result = gst_pad_get_caps (peerpad);
1846 gst_object_unref (peerpad);
1848 return result;
1850 no_peer:
1851 {
1852 GST_UNLOCK (pad);
1853 return NULL;
1854 }
1855 was_dispatching:
1856 {
1857 GST_CAT_DEBUG (GST_CAT_CAPS,
1858 "pad %s:%s is already dispatching!", GST_DEBUG_PAD_NAME (pad));
1859 g_warning ("pad %s:%s recursively called getcaps!",
1860 GST_DEBUG_PAD_NAME (pad));
1861 GST_UNLOCK (pad);
1862 return NULL;
1863 }
1864 }
1866 static gboolean
1867 fixate_value (GValue * dest, const GValue * src)
1868 {
1869 if (G_VALUE_TYPE (src) == GST_TYPE_INT_RANGE) {
1870 g_value_init (dest, G_TYPE_INT);
1871 g_value_set_int (dest, gst_value_get_int_range_min (src));
1872 } else if (G_VALUE_TYPE (src) == GST_TYPE_DOUBLE_RANGE) {
1873 g_value_init (dest, G_TYPE_DOUBLE);
1874 g_value_set_double (dest, gst_value_get_double_range_min (src));
1875 } else if (G_VALUE_TYPE (src) == GST_TYPE_LIST) {
1876 GValue temp = { 0 };
1878 gst_value_init_and_copy (&temp, gst_value_list_get_value (src, 0));
1879 if (!fixate_value (dest, &temp))
1880 gst_value_init_and_copy (dest, &temp);
1881 g_value_unset (&temp);
1882 } else if (G_VALUE_TYPE (src) == GST_TYPE_ARRAY) {
1883 gboolean res = FALSE;
1884 gint n;
1886 g_value_init (dest, GST_TYPE_ARRAY);
1887 for (n = 0; n < gst_value_list_get_size (src); n++) {
1888 GValue kid = { 0 };
1889 const GValue *orig_kid = gst_value_list_get_value (src, n);
1891 if (!fixate_value (&kid, orig_kid))
1892 gst_value_init_and_copy (&kid, orig_kid);
1893 else
1894 res = TRUE;
1895 gst_value_list_append_value (dest, &kid);
1896 g_value_unset (&kid);
1897 }
1899 if (!res)
1900 g_value_unset (dest);
1902 return res;
1903 } else {
1904 return FALSE;
1905 }
1907 return TRUE;
1908 }
1910 static gboolean
1911 gst_pad_default_fixate (GQuark field_id, const GValue * value, gpointer data)
1912 {
1913 GstStructure *s = data;
1914 GValue v = { 0 };
1916 if (fixate_value (&v, value)) {
1917 gst_structure_id_set_value (s, field_id, &v);
1918 g_value_unset (&v);
1919 }
1921 return TRUE;
1922 }
1924 /**
1925 * gst_pad_fixate_caps:
1926 * @pad: a #GstPad to fixate
1927 * @caps: the #GstCaps to fixate
1928 *
1929 * Fixate a caps on the given pad. Modifies the caps in place, so you should
1930 * make sure that the caps are actually writable (see gst_caps_make_writable()).
1931 */
1932 void
1933 gst_pad_fixate_caps (GstPad * pad, GstCaps * caps)
1934 {
1935 GstPadFixateCapsFunction fixatefunc;
1936 gint n;
1938 g_return_if_fail (GST_IS_PAD (pad));
1939 g_return_if_fail (caps != NULL);
1941 if (gst_caps_is_fixed (caps))
1942 return;
1944 fixatefunc = GST_PAD_FIXATECAPSFUNC (pad);
1945 if (fixatefunc) {
1946 fixatefunc (pad, caps);
1947 }
1949 /* default fixation */
1950 for (n = 0; n < gst_caps_get_size (caps); n++) {
1951 GstStructure *s = gst_caps_get_structure (caps, n);
1953 gst_structure_foreach (s, gst_pad_default_fixate, s);
1954 }
1955 }
1957 /**
1958 * gst_pad_accept_caps:
1959 * @pad: a #GstPad to check
1960 * @caps: a #GstCaps to check on the pad
1961 *
1962 * Check if the given pad accepts the caps.
1963 *
1964 * Returns: TRUE if the pad can accept the caps.
1965 */
1966 gboolean
1967 gst_pad_accept_caps (GstPad * pad, GstCaps * caps)
1968 {
1969 gboolean result;
1970 GstPadAcceptCapsFunction acceptfunc;
1972 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
1974 /* any pad can be unnegotiated */
1975 if (caps == NULL)
1976 return TRUE;
1978 GST_LOCK (pad);
1979 acceptfunc = GST_PAD_ACCEPTCAPSFUNC (pad);
1981 GST_CAT_DEBUG (GST_CAT_CAPS, "pad accept caps of %s:%s (%p)",
1982 GST_DEBUG_PAD_NAME (pad), pad);
1983 GST_UNLOCK (pad);
1985 if (acceptfunc) {
1986 /* we can call the function */
1987 result = acceptfunc (pad, caps);
1988 } else {
1989 /* else see get the caps and see if it intersects to something
1990 * not empty */
1991 GstCaps *intersect;
1992 GstCaps *allowed;
1994 allowed = gst_pad_get_caps (pad);
1995 if (allowed) {
1996 intersect = gst_caps_intersect (allowed, caps);
1998 result = !gst_caps_is_empty (intersect);
2000 gst_caps_unref (allowed);
2001 gst_caps_unref (intersect);
2002 } else {
2003 result = FALSE;
2004 }
2005 }
2006 return result;
2007 }
2009 /**
2010 * gst_pad_peer_accept_caps:
2011 * @pad: a #GstPad to check
2012 * @caps: a #GstCaps to check on the pad
2013 *
2014 * Check if the given pad accepts the caps.
2015 *
2016 * Returns: TRUE if the pad can accept the caps.
2017 */
2018 gboolean
2019 gst_pad_peer_accept_caps (GstPad * pad, GstCaps * caps)
2020 {
2021 GstPad *peerpad;
2022 gboolean result;
2024 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2026 GST_LOCK (pad);
2028 GST_CAT_DEBUG (GST_CAT_CAPS, "peer accept caps of %s:%s (%p)",
2029 GST_DEBUG_PAD_NAME (pad), pad);
2031 peerpad = GST_PAD_PEER (pad);
2032 if (G_UNLIKELY (peerpad == NULL))
2033 goto no_peer;
2035 result = gst_pad_accept_caps (peerpad, caps);
2036 GST_UNLOCK (pad);
2038 return result;
2040 no_peer:
2041 {
2042 GST_UNLOCK (pad);
2043 return TRUE;
2044 }
2045 }
2047 /**
2048 * gst_pad_set_caps:
2049 * @pad: a #GstPad to set the capabilities of.
2050 * @caps: a #GstCaps to set.
2051 *
2052 * Sets the capabilities of this pad. The caps must be fixed. Any previous
2053 * caps on the pad will be unreffed. This function refs the caps so you should
2054 * unref if as soon as you don't need it anymore.
2055 * It is possible to set NULL caps, which will make the pad unnegotiated
2056 * again.
2057 *
2058 * Returns: TRUE if the caps could be set. FALSE if the caps were not fixed
2059 * or bad parameters were provided to this function.
2060 *
2061 * MT safe.
2062 */
2063 gboolean
2064 gst_pad_set_caps (GstPad * pad, GstCaps * caps)
2065 {
2066 GstPadSetCapsFunction setcaps;
2067 GstCaps *existing;
2069 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2070 g_return_val_if_fail (caps == NULL || gst_caps_is_fixed (caps), FALSE);
2072 GST_LOCK (pad);
2073 setcaps = GST_PAD_SETCAPSFUNC (pad);
2075 existing = GST_PAD_CAPS (pad);
2076 if (caps == existing)
2077 goto setting_same_caps;
2078 else if (caps && existing && gst_caps_is_equal (caps, existing))
2079 goto setting_same_caps;
2081 /* call setcaps function to configure the pad */
2082 if (setcaps != NULL && caps) {
2083 if (!GST_PAD_IS_IN_SETCAPS (pad)) {
2084 GST_FLAG_SET (pad, GST_PAD_IN_SETCAPS);
2085 GST_UNLOCK (pad);
2086 if (!setcaps (pad, caps))
2087 goto could_not_set;
2088 GST_LOCK (pad);
2089 GST_FLAG_UNSET (pad, GST_PAD_IN_SETCAPS);
2090 } else {
2091 GST_CAT_DEBUG (GST_CAT_CAPS, "pad %s:%s was dispatching",
2092 GST_DEBUG_PAD_NAME (pad));
2093 }
2094 }
2096 gst_caps_replace (&GST_PAD_CAPS (pad), caps);
2097 GST_CAT_DEBUG (GST_CAT_CAPS, "%s:%s caps %" GST_PTR_FORMAT,
2098 GST_DEBUG_PAD_NAME (pad), caps);
2099 GST_UNLOCK (pad);
2101 g_object_notify (G_OBJECT (pad), "caps");
2103 return TRUE;
2105 setting_same_caps:
2106 {
2107 GST_UNLOCK (pad);
2108 gst_caps_replace (&GST_PAD_CAPS (pad), caps);
2109 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2110 "caps %" GST_PTR_FORMAT " same as existing, updating ptr only", caps);
2111 return TRUE;
2112 }
2113 /* errors */
2114 could_not_set:
2115 {
2116 GST_LOCK (pad);
2117 GST_FLAG_UNSET (pad, GST_PAD_IN_SETCAPS);
2118 GST_CAT_DEBUG (GST_CAT_CAPS,
2119 "pad %s:%s, caps %" GST_PTR_FORMAT " could not be set",
2120 GST_DEBUG_PAD_NAME (pad), caps);
2121 GST_UNLOCK (pad);
2123 return FALSE;
2124 }
2125 }
2127 static gboolean
2128 gst_pad_configure_sink (GstPad * pad, GstCaps * caps)
2129 {
2130 GstPadAcceptCapsFunction acceptcaps;
2131 GstPadSetCapsFunction setcaps;
2132 gboolean res;
2134 acceptcaps = GST_PAD_ACCEPTCAPSFUNC (pad);
2135 setcaps = GST_PAD_SETCAPSFUNC (pad);
2137 /* See if pad accepts the caps, by calling acceptcaps, only
2138 * needed if no setcaps function */
2139 if (setcaps == NULL && acceptcaps != NULL) {
2140 if (!acceptcaps (pad, caps))
2141 goto not_accepted;
2142 }
2143 /* set caps on pad if call succeeds */
2144 res = gst_pad_set_caps (pad, caps);
2145 /* no need to unref the caps here, set_caps takes a ref and
2146 * our ref goes away when we leave this function. */
2148 return res;
2150 not_accepted:
2151 {
2152 GST_CAT_DEBUG (GST_CAT_CAPS, "caps %" GST_PTR_FORMAT " not accepted", caps);
2153 return FALSE;
2154 }
2155 }
2157 /* returns TRUE if the src pad could be configured to accept the given caps */
2158 static gboolean
2159 gst_pad_configure_src (GstPad * pad, GstCaps * caps)
2160 {
2161 GstPadAcceptCapsFunction acceptcaps;
2162 GstPadSetCapsFunction setcaps;
2163 gboolean res;
2165 acceptcaps = GST_PAD_ACCEPTCAPSFUNC (pad);
2166 setcaps = GST_PAD_SETCAPSFUNC (pad);
2168 /* See if pad accepts the caps, by calling acceptcaps, only
2169 * needed if no setcaps function */
2170 if (setcaps == NULL && acceptcaps != NULL) {
2171 if (!acceptcaps (pad, caps))
2172 goto not_accepted;
2173 }
2174 /* set caps on pad if call succeeds */
2175 res = gst_pad_set_caps (pad, caps);
2176 /* no need to unref the caps here, set_caps takes a ref and
2177 * our ref goes away when we leave this function. */
2179 return res;
2181 not_accepted:
2182 {
2183 GST_CAT_DEBUG (GST_CAT_CAPS, "caps %" GST_PTR_FORMAT " not accepted", caps);
2184 return FALSE;
2185 }
2186 }
2188 /**
2189 * gst_pad_get_pad_template_caps:
2190 * @pad: a #GstPad to get the template capabilities from.
2191 *
2192 * Gets the capabilities for @pad's template.
2193 *
2194 * Returns: the #GstCaps of this pad template. If you intend to keep a reference
2195 * on the caps, make a copy (see gst_caps_copy ()).
2196 */
2197 const GstCaps *
2198 gst_pad_get_pad_template_caps (GstPad * pad)
2199 {
2200 static GstStaticCaps anycaps = GST_STATIC_CAPS ("ANY");
2202 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2204 if (GST_PAD_PAD_TEMPLATE (pad))
2205 return GST_PAD_TEMPLATE_CAPS (GST_PAD_PAD_TEMPLATE (pad));
2207 return gst_static_caps_get (&anycaps);
2208 }
2211 /**
2212 * gst_pad_get_peer:
2213 * @pad: a #GstPad to get the peer of.
2214 *
2215 * Gets the peer of @pad. This function refs the peer pad so
2216 * you need to unref it after use.
2217 *
2218 * Returns: the peer #GstPad. Unref after usage.
2219 *
2220 * MT safe.
2221 */
2222 GstPad *
2223 gst_pad_get_peer (GstPad * pad)
2224 {
2225 GstPad *result;
2227 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2229 GST_LOCK (pad);
2230 result = GST_PAD_PEER (pad);
2231 if (result)
2232 gst_object_ref (result);
2233 GST_UNLOCK (pad);
2235 return result;
2236 }
2238 /**
2239 * gst_pad_get_allowed_caps:
2240 * @srcpad: a #GstPad, it must a a source pad.
2241 *
2242 * Gets the capabilities of the allowed media types that can flow through
2243 * @srcpad and its peer. The pad must be a source pad.
2244 * The caller must free the resulting caps.
2245 *
2246 * Returns: the allowed #GstCaps of the pad link. Free the caps when
2247 * you no longer need it. This function returns NULL when the @srcpad has no
2248 * peer.
2249 *
2250 * MT safe.
2251 */
2252 GstCaps *
2253 gst_pad_get_allowed_caps (GstPad * srcpad)
2254 {
2255 GstCaps *mycaps;
2256 GstCaps *caps;
2257 GstCaps *peercaps;
2258 GstPad *peer;
2260 g_return_val_if_fail (GST_IS_PAD (srcpad), NULL);
2261 g_return_val_if_fail (GST_PAD_IS_SRC (srcpad), NULL);
2263 GST_LOCK (srcpad);
2265 peer = GST_PAD_PEER (srcpad);
2266 if (G_UNLIKELY (peer == NULL))
2267 goto no_peer;
2269 GST_CAT_DEBUG (GST_CAT_PROPERTIES, "%s:%s: getting allowed caps",
2270 GST_DEBUG_PAD_NAME (srcpad));
2272 gst_object_ref (peer);
2273 GST_UNLOCK (srcpad);
2274 mycaps = gst_pad_get_caps (srcpad);
2276 peercaps = gst_pad_get_caps (peer);
2277 gst_object_unref (peer);
2279 caps = gst_caps_intersect (mycaps, peercaps);
2280 gst_caps_unref (peercaps);
2281 gst_caps_unref (mycaps);
2283 GST_CAT_DEBUG (GST_CAT_CAPS, "allowed caps %" GST_PTR_FORMAT, caps);
2285 return caps;
2287 no_peer:
2288 {
2289 GST_CAT_DEBUG (GST_CAT_PROPERTIES, "%s:%s: no peer",
2290 GST_DEBUG_PAD_NAME (srcpad));
2291 GST_UNLOCK (srcpad);
2293 return NULL;
2294 }
2295 }
2297 /**
2298 * gst_pad_get_negotiated_caps:
2299 * @pad: a #GstPad.
2300 *
2301 * Gets the capabilities of the media type that currently flows through @pad
2302 * and its peer.
2303 *
2304 * This function can be used on both src and sinkpads. Note that srcpads are
2305 * always negotiated before sinkpads so it is possible that the negotiated caps
2306 * on the srcpad do not match the negotiated caps of the peer.
2307 *
2308 * Returns: the negotiated #GstCaps of the pad link. Free the caps when
2309 * you no longer need it. This function returns NULL when the @pad has no
2310 * peer or is not negotiated yet.
2311 *
2312 * MT safe.
2313 */
2314 GstCaps *
2315 gst_pad_get_negotiated_caps (GstPad * pad)
2316 {
2317 GstCaps *caps;
2318 GstPad *peer;
2320 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2322 GST_LOCK (pad);
2324 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
2325 goto no_peer;
2327 GST_CAT_DEBUG (GST_CAT_PROPERTIES, "%s:%s: getting negotiated caps",
2328 GST_DEBUG_PAD_NAME (pad));
2330 caps = GST_PAD_CAPS (pad);
2331 if (caps)
2332 gst_caps_ref (caps);
2333 GST_UNLOCK (pad);
2335 GST_CAT_DEBUG (GST_CAT_CAPS, "negotiated caps %" GST_PTR_FORMAT, caps);
2337 return caps;
2339 no_peer:
2340 {
2341 GST_CAT_DEBUG (GST_CAT_PROPERTIES, "%s:%s: no peer",
2342 GST_DEBUG_PAD_NAME (pad));
2343 GST_UNLOCK (pad);
2345 return NULL;
2346 }
2347 }
2349 /**
2350 * gst_pad_alloc_buffer:
2351 * @pad: a source #GstPad
2352 * @offset: the offset of the new buffer in the stream
2353 * @size: the size of the new buffer
2354 * @caps: the caps of the new buffer
2355 * @buf: a newly allocated buffer
2356 *
2357 * Allocates a new, empty buffer optimized to push to pad @pad. This
2358 * function only works if @pad is a source pad and has a peer.
2359 *
2360 * You need to check the caps of the buffer after performing this
2361 * function and renegotiate to the format if needed.
2362 *
2363 * A new, empty #GstBuffer will be put in the @buf argument.
2364 *
2365 * Returns: a result code indicating success of the operation. Any
2366 * result code other than GST_FLOW_OK is an error and @buf should
2367 * not be used.
2368 * An error can occur if the pad is not connected or when the downstream
2369 * peer elements cannot provide an acceptable buffer.
2370 *
2371 * MT safe.
2372 */
2373 GstFlowReturn
2374 gst_pad_alloc_buffer (GstPad * pad, guint64 offset, gint size, GstCaps * caps,
2375 GstBuffer ** buf)
2376 {
2377 GstPad *peer;
2378 GstFlowReturn ret;
2379 GstPadBufferAllocFunction bufferallocfunc;
2380 gboolean caps_changed;
2382 GST_DEBUG_OBJECT (pad, "offset %" G_GUINT64_FORMAT, offset);
2384 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
2385 g_return_val_if_fail (GST_PAD_IS_SRC (pad), GST_FLOW_ERROR);
2386 g_return_val_if_fail (buf != NULL, GST_FLOW_ERROR);
2388 GST_LOCK (pad);
2389 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
2390 goto no_peer;
2392 gst_object_ref (peer);
2393 GST_UNLOCK (pad);
2395 if (G_LIKELY ((bufferallocfunc = peer->bufferallocfunc) == NULL))
2396 goto fallback;
2398 GST_LOCK (peer);
2399 /* when the peer is flushing we cannot give a buffer */
2400 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (peer)))
2401 goto flushing;
2403 GST_CAT_DEBUG (GST_CAT_PADS,
2404 "calling bufferallocfunc &%s (@%p) of peer pad %s:%s for size %d ...",
2405 GST_DEBUG_FUNCPTR_NAME (bufferallocfunc),
2406 &bufferallocfunc, GST_DEBUG_PAD_NAME (peer), size);
2407 if (offset == GST_BUFFER_OFFSET_NONE)
2408 GST_CAT_DEBUG (GST_CAT_PADS, "... and offset NONE");
2409 else
2410 GST_CAT_DEBUG (GST_CAT_PADS, "... and offset %" G_GUINT64_FORMAT, offset);
2411 GST_UNLOCK (peer);
2413 ret = bufferallocfunc (peer, offset, size, caps, buf);
2415 if (G_UNLIKELY (ret != GST_FLOW_OK))
2416 goto peer_error;
2417 if (G_UNLIKELY (*buf == NULL))
2418 goto fallback;
2420 /* If the buffer alloc function didn't set up the caps like it should,
2421 * do it for it */
2422 if (caps && (GST_BUFFER_CAPS (*buf) == NULL)) {
2423 GST_WARNING ("Buffer allocation function for pad % " GST_PTR_FORMAT
2424 " did not set up caps. Setting", peer);
2426 gst_buffer_set_caps (*buf, caps);
2427 }
2429 do_caps:
2430 gst_object_unref (peer);
2432 /* FIXME, move capnego this into a base class? */
2433 caps = GST_BUFFER_CAPS (*buf);
2434 caps_changed = caps && caps != GST_PAD_CAPS (pad);
2435 /* we got a new datatype on the pad, see if it can handle it */
2436 if (G_UNLIKELY (caps_changed)) {
2437 GST_DEBUG ("caps changed to %" GST_PTR_FORMAT, caps);
2438 if (G_UNLIKELY (!gst_pad_configure_src (pad, caps)))
2439 goto not_negotiated;
2440 }
2441 return ret;
2443 no_peer:
2444 {
2445 /* pad has no peer */
2446 GST_CAT_DEBUG (GST_CAT_PADS,
2447 "%s:%s called bufferallocfunc but had no peer",
2448 GST_DEBUG_PAD_NAME (pad));
2449 GST_UNLOCK (pad);
2450 return GST_FLOW_NOT_LINKED;
2451 }
2452 flushing:
2453 {
2454 /* peer was flushing */
2455 GST_UNLOCK (peer);
2456 gst_object_unref (peer);
2457 GST_CAT_DEBUG (GST_CAT_PADS,
2458 "%s:%s called bufferallocfunc but peer was flushing",
2459 GST_DEBUG_PAD_NAME (pad));
2460 return GST_FLOW_WRONG_STATE;
2461 }
2462 /* fallback case, allocate a buffer of our own, add pad caps. */
2463 fallback:
2464 {
2465 GST_CAT_DEBUG (GST_CAT_PADS,
2466 "%s:%s fallback buffer alloc", GST_DEBUG_PAD_NAME (pad));
2467 *buf = gst_buffer_new_and_alloc (size);
2468 GST_BUFFER_OFFSET (*buf) = offset;
2469 gst_buffer_set_caps (*buf, caps);
2471 ret = GST_FLOW_OK;
2473 goto do_caps;
2474 }
2475 not_negotiated:
2476 {
2477 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2478 "alloc function retured unacceptable buffer");
2479 return GST_FLOW_NOT_NEGOTIATED;
2480 }
2481 peer_error:
2482 {
2483 gst_object_unref (peer);
2484 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2485 "alloc function retured error %d", ret);
2486 return ret;
2487 }
2488 }
2490 /**
2491 * gst_pad_get_internal_links_default:
2492 * @pad: the #GstPad to get the internal links of.
2493 *
2494 * Gets a list of pads to which the given pad is linked to
2495 * inside of the parent element.
2496 * This is the default handler, and thus returns a list of all of the
2497 * pads inside the parent element with opposite direction.
2498 * The caller must free this list after use.
2499 *
2500 * Returns: a newly allocated #GList of pads, or NULL if the pad has no parent.
2501 *
2502 * Not MT safe.
2503 */
2504 GList *
2505 gst_pad_get_internal_links_default (GstPad * pad)
2506 {
2507 GList *res = NULL;
2508 GstElement *parent;
2509 GList *parent_pads;
2510 GstPadDirection direction;
2512 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2514 direction = pad->direction;
2516 parent = GST_PAD_PARENT (pad);
2517 if (!parent)
2518 return NULL;
2520 parent_pads = parent->pads;
2522 while (parent_pads) {
2523 GstPad *parent_pad = GST_PAD_CAST (parent_pads->data);
2525 if (parent_pad->direction != direction) {
2526 res = g_list_prepend (res, parent_pad);
2527 }
2529 parent_pads = g_list_next (parent_pads);
2530 }
2532 return res;
2533 }
2535 /**
2536 * gst_pad_get_internal_links:
2537 * @pad: the #GstPad to get the internal links of.
2538 *
2539 * Gets a list of pads to which the given pad is linked to
2540 * inside of the parent element.
2541 * The caller must free this list after use.
2542 *
2543 * Returns: a newly allocated #GList of pads.
2544 *
2545 * Not MT safe.
2546 */
2547 GList *
2548 gst_pad_get_internal_links (GstPad * pad)
2549 {
2550 GList *res = NULL;
2552 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2554 if (GST_PAD_INTLINKFUNC (pad))
2555 res = GST_PAD_INTLINKFUNC (pad) (pad);
2557 return res;
2558 }
2561 static gboolean
2562 gst_pad_event_default_dispatch (GstPad * pad, GstEvent * event)
2563 {
2564 GList *orig, *pads;
2565 gboolean result;
2567 GST_INFO_OBJECT (pad, "Sending event %p to all internally linked pads",
2568 event);
2570 result = (GST_PAD_DIRECTION (pad) == GST_PAD_SINK);
2572 orig = pads = gst_pad_get_internal_links (pad);
2574 while (pads) {
2575 GstPad *eventpad = GST_PAD_CAST (pads->data);
2577 pads = g_list_next (pads);
2579 /* for all of the internally-linked pads that are actually linked */
2580 if (GST_PAD_IS_LINKED (eventpad)) {
2581 if (GST_PAD_DIRECTION (eventpad) == GST_PAD_SRC) {
2582 /* for each pad we send to, we should ref the event; it's up
2583 * to downstream to unref again when handled. */
2584 GST_LOG_OBJECT (pad, "Reffing and sending event %p to %s:%s", event,
2585 GST_DEBUG_PAD_NAME (eventpad));
2586 gst_event_ref (event);
2587 gst_pad_push_event (eventpad, event);
2588 } else {
2589 /* we only send the event on one pad, multi-sinkpad elements
2590 * should implement a handler */
2591 GST_LOG_OBJECT (pad, "sending event %p to one sink pad %s:%s", event,
2592 GST_DEBUG_PAD_NAME (eventpad));
2593 result = gst_pad_push_event (eventpad, event);
2594 goto done;
2595 }
2596 }
2597 }
2598 /* we handled the incoming event so we unref once */
2599 GST_LOG_OBJECT (pad, "handled event %p, unreffing", event);
2600 gst_event_unref (event);
2602 done:
2603 g_list_free (orig);
2605 return result;
2606 }
2608 /**
2609 * gst_pad_event_default:
2610 * @pad: a #GstPad to call the default event handler on.
2611 * @event: the #GstEvent to handle.
2612 *
2613 * Invokes the default event handler for the given pad. End-of-stream and
2614 * discontinuity events are handled specially, and then the event is sent to all
2615 * pads internally linked to @pad. Note that if there are many possible sink
2616 * pads that are internally linked to @pad, only one will be sent an event.
2617 * Multi-sinkpad elements should implement custom event handlers.
2618 *
2619 * Returns: TRUE if the event was sent succesfully.
2620 */
2621 gboolean
2622 gst_pad_event_default (GstPad * pad, GstEvent * event)
2623 {
2624 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2625 g_return_val_if_fail (event != NULL, FALSE);
2627 switch (GST_EVENT_TYPE (event)) {
2628 case GST_EVENT_EOS:
2629 {
2630 GST_DEBUG_OBJECT (pad, "pausing task because of eos");
2631 gst_pad_pause_task (pad);
2632 }
2633 default:
2634 break;
2635 }
2637 return gst_pad_event_default_dispatch (pad, event);
2638 }
2640 /**
2641 * gst_pad_dispatcher:
2642 * @pad: a #GstPad to dispatch.
2643 * @dispatch: the #GstDispatcherFunction to call.
2644 * @data: gpointer user data passed to the dispatcher function.
2645 *
2646 * Invokes the given dispatcher function on all pads that are
2647 * internally linked to the given pad.
2648 * The GstPadDispatcherFunction should return TRUE when no further pads
2649 * need to be processed.
2650 *
2651 * Returns: TRUE if one of the dispatcher functions returned TRUE.
2652 */
2653 gboolean
2654 gst_pad_dispatcher (GstPad * pad, GstPadDispatcherFunction dispatch,
2655 gpointer data)
2656 {
2657 gboolean res = FALSE;
2658 GList *int_pads, *orig;
2660 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2661 g_return_val_if_fail (dispatch != NULL, FALSE);
2663 orig = int_pads = gst_pad_get_internal_links (pad);
2665 while (int_pads) {
2666 GstPad *int_pad = GST_PAD_CAST (int_pads->data);
2667 GstPad *int_peer = GST_PAD_PEER (int_pad);
2669 if (int_peer) {
2670 res = dispatch (int_peer, data);
2671 if (res)
2672 break;
2673 }
2674 int_pads = g_list_next (int_pads);
2675 }
2677 g_list_free (orig);
2679 return res;
2680 }
2682 /**
2683 * gst_pad_query:
2684 * @pad: a #GstPad to invoke the default query on.
2685 * @query: the #GstQuery to perform.
2686 *
2687 * Dispatches a query to a pad. The query should have been allocated by the
2688 * caller via one of the type-specific allocation functions in gstquery.h. The
2689 * element is responsible for filling the query with an appropriate response,
2690 * which should then be parsed with a type-specific query parsing function.
2691 *
2692 * Again, the caller is responsible for both the allocation and deallocation of
2693 * the query structure.
2694 *
2695 * Returns: TRUE if the query could be performed.
2696 */
2697 gboolean
2698 gst_pad_query (GstPad * pad, GstQuery * query)
2699 {
2700 GstPadQueryFunction func;
2702 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2703 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
2705 GST_DEBUG ("sending query %p to pad %s:%s", query, GST_DEBUG_PAD_NAME (pad));
2707 if ((func = GST_PAD_QUERYFUNC (pad)) == NULL)
2708 goto no_func;
2710 return func (pad, query);
2712 no_func:
2713 {
2714 GST_DEBUG ("pad had no query function");
2715 return FALSE;
2716 }
2717 }
2719 gboolean
2720 gst_pad_query_default (GstPad * pad, GstQuery * query)
2721 {
2722 switch (GST_QUERY_TYPE (query)) {
2723 case GST_QUERY_POSITION:
2724 case GST_QUERY_SEEKING:
2725 case GST_QUERY_FORMATS:
2726 case GST_QUERY_LATENCY:
2727 case GST_QUERY_JITTER:
2728 case GST_QUERY_RATE:
2729 case GST_QUERY_CONVERT:
2730 default:
2731 return gst_pad_dispatcher
2732 (pad, (GstPadDispatcherFunction) gst_pad_query, query);
2733 }
2734 }
2736 #ifndef GST_DISABLE_LOADSAVE
2737 /* FIXME: why isn't this on a GstElement ? */
2738 /**
2739 * gst_pad_load_and_link:
2740 * @self: an #xmlNodePtr to read the description from.
2741 * @parent: the #GstObject element that owns the pad.
2742 *
2743 * Reads the pad definition from the XML node and links the given pad
2744 * in the element to a pad of an element up in the hierarchy.
2745 */
2746 void
2747 gst_pad_load_and_link (xmlNodePtr self, GstObject * parent)
2748 {
2749 xmlNodePtr field = self->xmlChildrenNode;
2750 GstPad *pad = NULL, *targetpad;
2751 gchar *peer = NULL;
2752 gchar **split;
2753 GstElement *target;
2754 GstObject *grandparent;
2755 gchar *name = NULL;
2757 while (field) {
2758 if (!strcmp ((char *) field->name, "name")) {
2759 name = (gchar *) xmlNodeGetContent (field);
2760 pad = gst_element_get_pad (GST_ELEMENT (parent), name);
2761 g_free (name);
2762 } else if (!strcmp ((char *) field->name, "peer")) {
2763 peer = (gchar *) xmlNodeGetContent (field);
2764 }
2765 field = field->next;
2766 }
2767 g_return_if_fail (pad != NULL);
2769 if (peer == NULL)
2770 return;
2772 split = g_strsplit (peer, ".", 2);
2774 if (split[0] == NULL || split[1] == NULL) {
2775 GST_CAT_DEBUG (GST_CAT_XML,
2776 "Could not parse peer '%s' for pad %s:%s, leaving unlinked",
2777 peer, GST_DEBUG_PAD_NAME (pad));
2779 g_free (peer);
2780 return;
2781 }
2782 g_free (peer);
2784 g_return_if_fail (split[0] != NULL);
2785 g_return_if_fail (split[1] != NULL);
2787 grandparent = gst_object_get_parent (parent);
2789 if (grandparent && GST_IS_BIN (grandparent)) {
2790 target = gst_bin_get_by_name_recurse_up (GST_BIN (grandparent), split[0]);
2791 } else
2792 goto cleanup;
2794 if (target == NULL)
2795 goto cleanup;
2797 targetpad = gst_element_get_pad (target, split[1]);
2799 if (targetpad == NULL)
2800 goto cleanup;
2802 gst_pad_link (pad, targetpad);
2804 cleanup:
2805 g_strfreev (split);
2806 }
2808 /**
2809 * gst_pad_save_thyself:
2810 * @pad: a #GstPad to save.
2811 * @parent: the parent #xmlNodePtr to save the description in.
2812 *
2813 * Saves the pad into an xml representation.
2814 *
2815 * Returns: the #xmlNodePtr representation of the pad.
2816 */
2817 static xmlNodePtr
2818 gst_pad_save_thyself (GstObject * object, xmlNodePtr parent)
2819 {
2820 GstPad *pad;
2821 GstPad *peer;
2823 g_return_val_if_fail (GST_IS_PAD (object), NULL);
2825 pad = GST_PAD (object);
2827 xmlNewChild (parent, NULL, (xmlChar *) "name",
2828 (xmlChar *) GST_PAD_NAME (pad));
2829 if (GST_PAD_PEER (pad) != NULL) {
2830 gchar *content;
2832 peer = GST_PAD_PEER (pad);
2833 /* first check to see if the peer's parent's parent is the same */
2834 /* we just save it off */
2835 content = g_strdup_printf ("%s.%s",
2836 GST_OBJECT_NAME (GST_PAD_PARENT (peer)), GST_PAD_NAME (peer));
2837 xmlNewChild (parent, NULL, (xmlChar *) "peer", (xmlChar *) content);
2838 g_free (content);
2839 } else
2840 xmlNewChild (parent, NULL, (xmlChar *) "peer", NULL);
2842 return parent;
2843 }
2845 #if 0
2846 /**
2847 * gst_ghost_pad_save_thyself:
2848 * @pad: a ghost #GstPad to save.
2849 * @parent: the parent #xmlNodePtr to save the description in.
2850 *
2851 * Saves the ghost pad into an xml representation.
2852 *
2853 * Returns: the #xmlNodePtr representation of the pad.
2854 */
2855 xmlNodePtr
2856 gst_ghost_pad_save_thyself (GstPad * pad, xmlNodePtr parent)
2857 {
2858 xmlNodePtr self;
2860 g_return_val_if_fail (GST_IS_GHOST_PAD (pad), NULL);
2862 self = xmlNewChild (parent, NULL, (xmlChar *) "ghostpad", NULL);
2863 xmlNewChild (self, NULL, (xmlChar *) "name", (xmlChar *) GST_PAD_NAME (pad));
2864 xmlNewChild (self, NULL, (xmlChar *) "parent",
2865 (xmlChar *) GST_OBJECT_NAME (GST_PAD_PARENT (pad)));
2867 /* FIXME FIXME FIXME! */
2869 return self;
2870 }
2871 #endif /* 0 */
2872 #endif /* GST_DISABLE_LOADSAVE */
2874 /*
2875 * should be called with pad lock held
2876 *
2877 * MT safe.
2878 */
2879 static void
2880 handle_pad_block (GstPad * pad)
2881 {
2882 GstPadBlockCallback callback;
2883 gpointer user_data;
2885 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
2886 "signal block taken on pad %s:%s", GST_DEBUG_PAD_NAME (pad));
2888 /* need to grab extra ref for the callbacks */
2889 gst_object_ref (pad);
2891 callback = pad->block_callback;
2892 if (callback) {
2893 user_data = pad->block_data;
2894 GST_UNLOCK (pad);
2895 callback (pad, TRUE, user_data);
2896 GST_LOCK (pad);
2897 } else {
2898 GST_PAD_BLOCK_SIGNAL (pad);
2899 }
2901 while (GST_PAD_IS_BLOCKED (pad))
2902 GST_PAD_BLOCK_WAIT (pad);
2904 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad, "got unblocked");
2906 callback = pad->block_callback;
2907 if (callback) {
2908 user_data = pad->block_data;
2909 GST_UNLOCK (pad);
2910 callback (pad, FALSE, user_data);
2911 GST_LOCK (pad);
2912 } else {
2913 GST_PAD_BLOCK_SIGNAL (pad);
2914 }
2916 gst_object_unref (pad);
2917 }
2919 /**********************************************************************
2920 * Data passing functions
2921 */
2923 static gboolean
2924 gst_pad_emit_have_data_signal (GstPad * pad, GstMiniObject * obj)
2925 {
2926 GValue ret = { 0 };
2927 GValue args[2] = { {0}, {0} };
2928 gboolean res;
2929 GQuark detail;
2931 /* init */
2932 g_value_init (&ret, G_TYPE_BOOLEAN);
2933 g_value_set_boolean (&ret, TRUE);
2934 g_value_init (&args[0], GST_TYPE_PAD);
2935 g_value_set_object (&args[0], pad);
2936 g_value_init (&args[1], GST_TYPE_MINI_OBJECT); // G_TYPE_POINTER);
2937 gst_value_set_mini_object (&args[1], obj);
2939 if (GST_IS_EVENT (obj))
2940 detail = event_quark;
2941 else
2942 detail = buffer_quark;
2944 /* actually emit */
2945 g_signal_emitv (args, gst_pad_signals[PAD_HAVE_DATA], detail, &ret);
2946 res = g_value_get_boolean (&ret);
2948 /* clean up */
2949 g_value_unset (&ret);
2950 g_value_unset (&args[0]);
2951 g_value_unset (&args[1]);
2953 return res;
2954 }
2956 /**
2957 * gst_pad_chain:
2958 * @pad: a sink #GstPad.
2959 * @buffer: the #GstBuffer to send.
2960 *
2961 * Chain a buffer to @pad.
2962 *
2963 * Returns: a #GstFlowReturn from the pad.
2964 *
2965 * MT safe.
2966 */
2967 GstFlowReturn
2968 gst_pad_chain (GstPad * pad, GstBuffer * buffer)
2969 {
2970 GstCaps *caps;
2971 gboolean caps_changed;
2972 GstPadChainFunction chainfunc;
2973 GstFlowReturn ret;
2974 gboolean emit_signal;
2976 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
2977 g_return_val_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SINK,
2978 GST_FLOW_ERROR);
2979 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
2980 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
2982 GST_STREAM_LOCK (pad);
2984 GST_LOCK (pad);
2985 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
2986 goto flushing;
2988 caps = GST_BUFFER_CAPS (buffer);
2989 caps_changed = caps && caps != GST_PAD_CAPS (pad);
2991 emit_signal = GST_PAD_DO_BUFFER_SIGNALS (pad) > 0;
2992 GST_UNLOCK (pad);
2994 /* see if the signal should be emited, we emit before caps nego as
2995 * we might drop the buffer and do capsnego for nothing. */
2996 if (G_UNLIKELY (emit_signal)) {
2997 if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (buffer)))
2998 goto dropping;
2999 }
3001 /* we got a new datatype on the pad, see if it can handle it */
3002 if (G_UNLIKELY (caps_changed)) {
3003 GST_DEBUG ("caps changed to %" GST_PTR_FORMAT, caps);
3004 if (G_UNLIKELY (!gst_pad_configure_sink (pad, caps)))
3005 goto not_negotiated;
3006 }
3008 /* NOTE: we read the chainfunc unlocked.
3009 * we cannot hold the lock for the pad so we might send
3010 * the data to the wrong function. This is not really a
3011 * problem since functions are assigned at creation time
3012 * and don't change that often... */
3013 if (G_UNLIKELY ((chainfunc = GST_PAD_CHAINFUNC (pad)) == NULL))
3014 goto no_function;
3016 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3017 "calling chainfunction &%s of pad %s:%s",
3018 GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_DEBUG_PAD_NAME (pad));
3020 ret = chainfunc (pad, buffer);
3022 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3023 "called chainfunction &%s of pad %s:%s, returned %d",
3024 GST_DEBUG_FUNCPTR_NAME (chainfunc), GST_DEBUG_PAD_NAME (pad), ret);
3026 GST_STREAM_UNLOCK (pad);
3028 return ret;
3030 /* ERRORS */
3031 flushing:
3032 {
3033 gst_buffer_unref (buffer);
3034 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3035 "pushing, but pad was flushing");
3036 GST_UNLOCK (pad);
3037 GST_STREAM_UNLOCK (pad);
3038 return GST_FLOW_WRONG_STATE;
3039 }
3040 dropping:
3041 {
3042 gst_buffer_unref (buffer);
3043 GST_DEBUG_OBJECT (pad, "Dropping buffer due to FALSE probe return");
3044 GST_STREAM_UNLOCK (pad);
3045 return GST_FLOW_OK;
3046 }
3047 not_negotiated:
3048 {
3049 gst_buffer_unref (buffer);
3050 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3051 "pushing buffer but pad did not accept");
3052 GST_STREAM_UNLOCK (pad);
3053 return GST_FLOW_NOT_NEGOTIATED;
3054 }
3055 no_function:
3056 {
3057 gst_buffer_unref (buffer);
3058 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3059 "pushing, but not chainhandler");
3060 GST_ELEMENT_ERROR (GST_PAD_PARENT (pad), CORE, PAD, (NULL),
3061 ("push on pad %s:%s but it has no chainfunction",
3062 GST_DEBUG_PAD_NAME (pad)));
3063 GST_STREAM_UNLOCK (pad);
3064 return GST_FLOW_ERROR;
3065 }
3066 }
3068 /**
3069 * gst_pad_push:
3070 * @pad: a source #GstPad.
3071 * @buffer: the #GstBuffer to push.
3072 *
3073 * Pushes a buffer to the peer of @pad. @pad must be linked.
3074 *
3075 * Returns: a #GstFlowReturn from the peer pad.
3076 *
3077 * MT safe.
3078 */
3079 GstFlowReturn
3080 gst_pad_push (GstPad * pad, GstBuffer * buffer)
3081 {
3082 GstPad *peer;
3083 GstFlowReturn ret;
3084 gboolean emit_signal;
3086 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3087 g_return_val_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SRC, GST_FLOW_ERROR);
3088 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
3089 g_return_val_if_fail (GST_IS_BUFFER (buffer), GST_FLOW_ERROR);
3091 GST_LOCK (pad);
3092 while (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad)))
3093 handle_pad_block (pad);
3095 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
3096 goto not_linked;
3098 /* we emit signals on the pad areg, the peer will have a chance to
3099 * emit in the _chain() function */
3100 emit_signal = GST_PAD_DO_BUFFER_SIGNALS (pad) > 0;
3102 gst_object_ref (peer);
3103 GST_UNLOCK (pad);
3105 if (G_UNLIKELY (emit_signal)) {
3106 if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (buffer)))
3107 goto dropping;
3108 }
3110 ret = gst_pad_chain (peer, buffer);
3112 gst_object_unref (peer);
3114 return ret;
3116 /* ERROR recovery here */
3117 not_linked:
3118 {
3119 gst_buffer_unref (buffer);
3120 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3121 "pushing, but it was not linked");
3122 GST_UNLOCK (pad);
3123 return GST_FLOW_NOT_LINKED;
3124 }
3125 dropping:
3126 {
3127 gst_buffer_unref (buffer);
3128 gst_object_unref (peer);
3129 GST_DEBUG ("Dropping buffer due to FALSE probe return");
3130 return GST_FLOW_OK;
3131 }
3132 }
3134 /**
3135 * gst_pad_check_pull_range:
3136 * @pad: a sink #GstPad.
3137 *
3138 * Checks if a #gst_pad_pull_range() can be performed on the peer
3139 * source pad. This function is used by plugins that want to check
3140 * if they can use random access on the peer source pad.
3141 *
3142 * The peer sourcepad can implement a custom #GstPadCheckGetRangeFunction
3143 * if it needs to perform some logic to determine if pull_range is
3144 * possible.
3145 *
3146 * Returns: a gboolean with the result.
3147 *
3148 * MT safe.
3149 */
3150 gboolean
3151 gst_pad_check_pull_range (GstPad * pad)
3152 {
3153 GstPad *peer;
3154 gboolean ret;
3155 GstPadCheckGetRangeFunction checkgetrangefunc;
3157 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3159 GST_LOCK (pad);
3160 if (GST_PAD_DIRECTION (pad) != GST_PAD_SINK)
3161 goto wrong_direction;
3163 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
3164 goto not_connected;
3166 gst_object_ref (peer);
3167 GST_UNLOCK (pad);
3169 /* see note in above function */
3170 if (G_LIKELY ((checkgetrangefunc = peer->checkgetrangefunc) == NULL)) {
3171 /* FIXME, kindoff ghetto */
3172 ret = GST_PAD_GETRANGEFUNC (peer) != NULL;
3173 } else {
3174 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3175 "calling checkgetrangefunc %s of peer pad %s:%s",
3176 GST_DEBUG_FUNCPTR_NAME (checkgetrangefunc), GST_DEBUG_PAD_NAME (peer));
3178 ret = checkgetrangefunc (peer);
3179 }
3181 gst_object_unref (peer);
3183 return ret;
3185 /* ERROR recovery here */
3186 wrong_direction:
3187 {
3188 GST_UNLOCK (pad);
3189 return FALSE;
3190 }
3191 not_connected:
3192 {
3193 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3194 "checking pull range, but it was not linked");
3195 GST_UNLOCK (pad);
3196 return FALSE;
3197 }
3198 }
3200 /**
3201 * gst_pad_get_range:
3202 * @pad: a src #GstPad.
3203 * @offset: The start offset of the buffer
3204 * @size: The length of the buffer
3205 * @buffer: a pointer to hold the #GstBuffer.
3206 *
3207 * Calls the getrange function of @pad.
3208 *
3209 * Returns: a #GstFlowReturn from the pad.
3210 *
3211 * MT safe.
3212 */
3213 GstFlowReturn
3214 gst_pad_get_range (GstPad * pad, guint64 offset, guint size,
3215 GstBuffer ** buffer)
3216 {
3217 GstFlowReturn ret;
3218 GstPadGetRangeFunction getrangefunc;
3219 gboolean emit_signal;
3221 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3222 g_return_val_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SRC, GST_FLOW_ERROR);
3223 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
3225 GST_STREAM_LOCK (pad);
3227 GST_LOCK (pad);
3228 if (G_UNLIKELY (GST_PAD_IS_FLUSHING (pad)))
3229 goto flushing;
3231 emit_signal = GST_PAD_DO_BUFFER_SIGNALS (pad) > 0;
3232 GST_UNLOCK (pad);
3234 if (G_UNLIKELY ((getrangefunc = GST_PAD_GETRANGEFUNC (pad)) == NULL))
3235 goto no_function;
3237 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3238 "calling getrangefunc %s of peer pad %s:%s, offset %"
3239 G_GUINT64_FORMAT ", size %u",
3240 GST_DEBUG_FUNCPTR_NAME (getrangefunc), GST_DEBUG_PAD_NAME (pad),
3241 offset, size);
3243 ret = getrangefunc (pad, offset, size, buffer);
3245 /* can only fire the signal if we have a valid buffer */
3246 if (G_UNLIKELY (emit_signal) && (ret == GST_FLOW_OK)) {
3247 if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (*buffer)))
3248 goto dropping;
3249 }
3251 GST_STREAM_UNLOCK (pad);
3253 return ret;
3255 /* ERRORS */
3256 flushing:
3257 {
3258 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3259 "pulling range, but pad was flushing");
3260 GST_UNLOCK (pad);
3261 GST_STREAM_UNLOCK (pad);
3262 return GST_FLOW_WRONG_STATE;
3263 }
3264 no_function:
3265 {
3266 GST_ELEMENT_ERROR (GST_PAD_PARENT (pad), CORE, PAD, (NULL),
3267 ("pullrange on pad %s:%s but it has no getrangefunction",
3268 GST_DEBUG_PAD_NAME (pad)));
3269 GST_STREAM_UNLOCK (pad);
3270 return GST_FLOW_ERROR;
3271 }
3272 dropping:
3273 {
3274 GST_DEBUG ("Dropping data after FALSE probe return");
3275 GST_STREAM_UNLOCK (pad);
3276 gst_buffer_unref (*buffer);
3277 *buffer = NULL;
3278 return GST_FLOW_UNEXPECTED;
3279 }
3280 }
3283 /**
3284 * gst_pad_pull_range:
3285 * @pad: a sink #GstPad.
3286 * @offset: The start offset of the buffer
3287 * @size: The length of the buffer
3288 * @buffer: a pointer to hold the #GstBuffer.
3289 *
3290 * Pulls a buffer from the peer pad. @pad must be linked.
3291 *
3292 * Returns: a #GstFlowReturn from the peer pad.
3293 *
3294 * MT safe.
3295 */
3296 GstFlowReturn
3297 gst_pad_pull_range (GstPad * pad, guint64 offset, guint size,
3298 GstBuffer ** buffer)
3299 {
3300 GstPad *peer;
3301 GstFlowReturn ret;
3302 gboolean emit_signal;
3304 g_return_val_if_fail (GST_IS_PAD (pad), GST_FLOW_ERROR);
3305 g_return_val_if_fail (GST_PAD_DIRECTION (pad) == GST_PAD_SINK,
3306 GST_FLOW_ERROR);
3307 g_return_val_if_fail (buffer != NULL, GST_FLOW_ERROR);
3309 GST_LOCK (pad);
3311 while (G_UNLIKELY (GST_PAD_IS_BLOCKED (pad)))
3312 handle_pad_block (pad);
3314 if (G_UNLIKELY ((peer = GST_PAD_PEER (pad)) == NULL))
3315 goto not_connected;
3317 /* signal emision for the pad, peer has chance to emit when
3318 * we call _get_range() */
3319 emit_signal = GST_PAD_DO_BUFFER_SIGNALS (pad) > 0;
3321 gst_object_ref (peer);
3322 GST_UNLOCK (pad);
3324 ret = gst_pad_get_range (peer, offset, size, buffer);
3326 gst_object_unref (peer);
3328 /* can only fire the signal if we have a valid buffer */
3329 if (G_UNLIKELY (emit_signal) && (ret == GST_FLOW_OK)) {
3330 if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (*buffer)))
3331 goto dropping;
3332 }
3333 return ret;
3335 /* ERROR recovery here */
3336 not_connected:
3337 {
3338 GST_CAT_LOG_OBJECT (GST_CAT_SCHEDULING, pad,
3339 "pulling range, but it was not linked");
3340 GST_UNLOCK (pad);
3341 return GST_FLOW_NOT_LINKED;
3342 }
3343 dropping:
3344 {
3345 GST_DEBUG ("Dropping data after FALSE probe return");
3346 gst_buffer_unref (*buffer);
3347 *buffer = NULL;
3348 return GST_FLOW_UNEXPECTED;
3349 }
3350 }
3352 /**
3353 * gst_pad_push_event:
3354 * @pad: a #GstPad to push the event to.
3355 * @event: the #GstEvent to send to the pad.
3356 *
3357 * Sends the event to the peer of the given pad. This function is
3358 * mainly used by elements to send events to their peer
3359 * elements.
3360 *
3361 * Returns: TRUE if the event was handled.
3362 *
3363 * MT safe.
3364 */
3365 gboolean
3366 gst_pad_push_event (GstPad * pad, GstEvent * event)
3367 {
3368 GstPad *peerpad;
3369 gboolean result;
3370 gboolean emit_signal;
3372 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3373 g_return_val_if_fail (event != NULL, FALSE);
3375 GST_LOCK (pad);
3376 peerpad = GST_PAD_PEER (pad);
3377 if (peerpad == NULL)
3378 goto not_linked;
3380 emit_signal = GST_PAD_DO_EVENT_SIGNALS (pad) > 0;
3382 gst_object_ref (peerpad);
3383 GST_UNLOCK (pad);
3385 if (G_UNLIKELY (emit_signal)) {
3386 if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (event)))
3387 goto dropping;
3388 }
3390 result = gst_pad_send_event (peerpad, event);
3392 gst_object_unref (peerpad);
3394 return result;
3396 /* ERROR handling */
3397 not_linked:
3398 {
3399 gst_event_unref (event);
3400 GST_UNLOCK (pad);
3401 return FALSE;
3402 }
3403 dropping:
3404 {
3405 GST_DEBUG ("Dropping event after FALSE probe return");
3406 gst_object_unref (peerpad);
3407 gst_event_unref (event);
3408 return FALSE;
3409 }
3410 }
3412 /**
3413 * gst_pad_send_event:
3414 * @pad: a #GstPad to send the event to.
3415 * @event: the #GstEvent to send to the pad.
3416 *
3417 * Sends the event to the pad. This function can be used
3418 * by applications to send events in the pipeline.
3419 *
3420 * Returns: TRUE if the event was handled.
3421 */
3422 gboolean
3423 gst_pad_send_event (GstPad * pad, GstEvent * event)
3424 {
3425 gboolean result = FALSE;
3426 GstPadEventFunction eventfunc;
3427 gboolean emit_signal;
3429 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3430 g_return_val_if_fail (event != NULL, FALSE);
3432 GST_LOCK (pad);
3434 if (GST_PAD_IS_SINK (pad) && !GST_EVENT_IS_DOWNSTREAM (event))
3435 goto wrong_direction;
3436 if (GST_PAD_IS_SRC (pad) && !GST_EVENT_IS_UPSTREAM (event))
3437 goto wrong_direction;
3439 if (GST_EVENT_SRC (event) == NULL)
3440 GST_EVENT_SRC (event) = gst_object_ref (pad);
3442 switch (GST_EVENT_TYPE (event)) {
3443 case GST_EVENT_FLUSH_START:
3444 GST_CAT_DEBUG (GST_CAT_EVENT,
3445 "have event type %d (FLUSH_START) on pad %s:%s",
3446 GST_EVENT_TYPE (event), GST_DEBUG_PAD_NAME (pad));
3448 /* can't even accept a flush begin event when flushing */
3449 if (GST_PAD_IS_FLUSHING (pad))
3450 goto flushing;
3451 GST_PAD_SET_FLUSHING (pad);
3452 GST_CAT_DEBUG (GST_CAT_EVENT, "set flush flag");
3453 break;
3454 case GST_EVENT_FLUSH_STOP:
3455 GST_PAD_UNSET_FLUSHING (pad);
3456 GST_CAT_DEBUG (GST_CAT_EVENT, "cleared flush flag");
3457 break;
3458 default:
3459 GST_CAT_DEBUG (GST_CAT_EVENT, "have event type %d on pad %s:%s",
3460 GST_EVENT_TYPE (event), GST_DEBUG_PAD_NAME (pad));
3462 if (GST_PAD_IS_FLUSHING (pad))
3463 goto flushing;
3464 break;
3465 }
3467 if ((eventfunc = GST_PAD_EVENTFUNC (pad)) == NULL)
3468 goto no_function;
3470 emit_signal = GST_PAD_DO_EVENT_SIGNALS (pad) > 0;
3472 gst_object_ref (pad);
3473 GST_UNLOCK (pad);
3475 if (G_UNLIKELY (emit_signal)) {
3476 if (!gst_pad_emit_have_data_signal (pad, GST_MINI_OBJECT (event)))
3477 goto dropping;
3478 }
3480 result = eventfunc (GST_PAD_CAST (pad), event);
3482 gst_object_unref (pad);
3484 return result;
3486 /* ERROR handling */
3487 wrong_direction:
3488 {
3489 g_warning ("pad %s:%s sending event in wrong direction",
3490 GST_DEBUG_PAD_NAME (pad));
3491 GST_UNLOCK (pad);
3492 gst_event_unref (event);
3493 return FALSE;
3494 }
3495 no_function:
3496 {
3497 g_warning ("pad %s:%s has no event handler, file a bug.",
3498 GST_DEBUG_PAD_NAME (pad));
3499 GST_UNLOCK (pad);
3500 gst_event_unref (event);
3501 return FALSE;
3502 }
3503 flushing:
3504 {
3505 GST_UNLOCK (pad);
3506 GST_CAT_DEBUG (GST_CAT_EVENT, "Received event on flushing pad. Discarding");
3507 gst_event_unref (event);
3508 return FALSE;
3509 }
3510 dropping:
3511 {
3512 GST_DEBUG ("Dropping event after FALSE probe return");
3513 gst_object_unref (pad);
3514 gst_event_unref (event);
3515 return FALSE;
3516 }
3517 }
3519 /**
3520 * gst_pad_set_element_private:
3521 * @pad: the #GstPad to set the private data of.
3522 * @priv: The private data to attach to the pad.
3523 *
3524 * Set the given private data gpointer on the pad.
3525 * This function can only be used by the element that owns the pad.
3526 */
3527 void
3528 gst_pad_set_element_private (GstPad * pad, gpointer priv)
3529 {
3530 pad->element_private = priv;
3531 }
3533 /**
3534 * gst_pad_get_element_private:
3535 * @pad: the #GstPad to get the private data of.
3536 *
3537 * Gets the private data of a pad.
3538 *
3539 * Returns: a #gpointer to the private data.
3540 */
3541 gpointer
3542 gst_pad_get_element_private (GstPad * pad)
3543 {
3544 return pad->element_private;
3545 }
3547 /**
3548 * gst_pad_start_task:
3549 * @pad: the #GstPad to start the task of
3550 * @func: the task function to call
3551 * @data: data passed to the task function
3552 *
3553 * Starts a task that repeadedly calls @func with @data. This function
3554 * is nostly used in the pad activation function to start the
3555 * dataflow. This function will automatically acauire the STREAM_LOCK of
3556 * the pad before calling @func.
3557 *
3558 * Returns: a TRUE if the task could be started.
3559 */
3560 gboolean
3561 gst_pad_start_task (GstPad * pad, GstTaskFunction func, gpointer data)
3562 {
3563 GstTask *task;
3565 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3566 g_return_val_if_fail (func != NULL, FALSE);
3568 GST_LOCK (pad);
3569 task = GST_PAD_TASK (pad);
3570 if (task == NULL) {
3571 task = gst_task_create (func, data);
3572 gst_task_set_lock (task, GST_STREAM_GET_LOCK (pad));
3573 GST_PAD_TASK (pad) = task;
3574 }
3575 gst_task_start (task);
3576 GST_UNLOCK (pad);
3578 return TRUE;
3579 }
3581 /**
3582 * gst_pad_pause_task:
3583 * @pad: the #GstPad to pause the task of
3584 *
3585 * Pause the task of @pad. This function will also make sure that the
3586 * function executed by the task will effectively stop.
3587 *
3588 * Returns: a TRUE if the task could be paused or FALSE when the pad
3589 * has no task.
3590 */
3591 gboolean
3592 gst_pad_pause_task (GstPad * pad)
3593 {
3594 GstTask *task;
3596 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3598 GST_LOCK (pad);
3599 task = GST_PAD_TASK (pad);
3600 if (task == NULL)
3601 goto no_task;
3602 gst_task_pause (task);
3603 GST_UNLOCK (pad);
3605 GST_STREAM_LOCK (pad);
3606 GST_STREAM_UNLOCK (pad);
3608 return TRUE;
3610 no_task:
3611 {
3612 GST_UNLOCK (pad);
3613 return TRUE;
3614 }
3615 }
3617 /**
3618 * gst_pad_stop_task:
3619 * @pad: the #GstPad to stop the task of
3620 *
3621 * Stop the task of @pad. This function will also make sure that the
3622 * function executed by the task will effectively stop if not called
3623 * from the GstTaskFunction.
3624 *
3625 * This function will deadlock if called from the GstTaskFunction of
3626 * the task. Use #gst_task_pause() instead.
3627 *
3628 * Returns: a TRUE if the task could be stopped or FALSE when the pad
3629 * has no task.
3630 */
3631 gboolean
3632 gst_pad_stop_task (GstPad * pad)
3633 {
3634 GstTask *task;
3636 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3638 GST_LOCK (pad);
3639 task = GST_PAD_TASK (pad);
3640 if (task == NULL)
3641 goto no_task;
3642 GST_PAD_TASK (pad) = NULL;
3643 gst_task_stop (task);
3644 GST_UNLOCK (pad);
3646 GST_STREAM_LOCK (pad);
3647 GST_STREAM_UNLOCK (pad);
3649 gst_task_join (task);
3651 gst_object_unref (task);
3653 return TRUE;
3655 no_task:
3656 {
3657 GST_UNLOCK (pad);
3658 return TRUE;
3659 }
3660 }