2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 * 2002 Thomas Vander Stichele <thomas@apestaart.org>
6 * gstutils.c: Utility functions
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
26 * @short_description: Various utility functions
28 * When defining own plugins, use the GST_BOILERPLATE ease gobject creation.
31 #include "gst_private.h"
35 #include "gstghostpad.h"
40 #include "gst-i18n-lib.h"
45 * @mem: a pointer to the memory to dump
46 * @size: the size of the memory block to dump
48 * Dumps the memory block into a hex representation. Useful for debugging.
51 gst_util_dump_mem (const guchar * mem, guint size)
54 GString *string = g_string_sized_new (50);
55 GString *chars = g_string_sized_new (18);
59 if (g_ascii_isprint (mem[i]))
60 g_string_append_c (chars, mem[i]);
62 g_string_append_c (chars, '.');
64 g_string_append_printf (string, "%02x ", mem[i]);
69 if (j == 16 || i == size) {
70 g_print ("%08x (%p): %-48.48s %-16.16s\n", i - j, mem + i - j,
71 string->str, chars->str);
72 g_string_set_size (string, 0);
73 g_string_set_size (chars, 0);
77 g_string_free (string, TRUE);
78 g_string_free (chars, TRUE);
83 * gst_util_set_value_from_string:
84 * @value: the value to set
85 * @value_str: the string to get the value from
87 * Converts the string to the type of the value and
88 * sets the value with it.
91 gst_util_set_value_from_string (GValue * value, const gchar * value_str)
95 g_return_if_fail (value != NULL);
96 g_return_if_fail (value_str != NULL);
98 GST_CAT_DEBUG (GST_CAT_PARAMS, "parsing '%s' to type %s", value_str,
99 g_type_name (G_VALUE_TYPE (value)));
101 switch (G_VALUE_TYPE (value)) {
103 g_value_set_string (value, value_str);
109 sscanf_ret = sscanf (value_str, "%d", &i);
110 g_return_if_fail (sscanf_ret == 1);
111 g_value_set_int (value, i);
117 sscanf_ret = sscanf (value_str, "%u", &i);
118 g_return_if_fail (sscanf_ret == 1);
119 g_value_set_uint (value, i);
125 sscanf_ret = sscanf (value_str, "%ld", &i);
126 g_return_if_fail (sscanf_ret == 1);
127 g_value_set_long (value, i);
133 sscanf_ret = sscanf (value_str, "%lu", &i);
134 g_return_if_fail (sscanf_ret == 1);
135 g_value_set_ulong (value, i);
138 case G_TYPE_BOOLEAN:{
141 if (!g_ascii_strncasecmp ("true", value_str, 4))
143 g_value_set_boolean (value, i);
149 sscanf_ret = sscanf (value_str, "%c", &i);
150 g_return_if_fail (sscanf_ret == 1);
151 g_value_set_char (value, i);
157 sscanf_ret = sscanf (value_str, "%c", &i);
158 g_return_if_fail (sscanf_ret == 1);
159 g_value_set_uchar (value, i);
165 sscanf_ret = sscanf (value_str, "%f", &i);
166 g_return_if_fail (sscanf_ret == 1);
167 g_value_set_float (value, i);
173 sscanf_ret = sscanf (value_str, "%g", &i);
174 g_return_if_fail (sscanf_ret == 1);
175 g_value_set_double (value, (gdouble) i);
184 * gst_util_set_object_arg:
185 * @object: the object to set the argument of
186 * @name: the name of the argument to set
187 * @value: the string value to set
189 * Convertes the string value to the type of the objects argument and
190 * sets the argument with it.
193 gst_util_set_object_arg (GObject * object, const gchar * name,
199 GParamSpec *paramspec;
202 g_object_class_find_property (G_OBJECT_GET_CLASS (object), name);
208 GST_DEBUG ("paramspec->flags is %d, paramspec->value_type is %d",
209 paramspec->flags, (gint) paramspec->value_type);
211 if (paramspec->flags & G_PARAM_WRITABLE) {
212 switch (paramspec->value_type) {
214 g_object_set (G_OBJECT (object), name, value, NULL);
220 sscanf_ret = sscanf (value, "%d", &i);
221 g_return_if_fail (sscanf_ret == 1);
222 g_object_set (G_OBJECT (object), name, i, NULL);
228 sscanf_ret = sscanf (value, "%u", &i);
229 g_return_if_fail (sscanf_ret == 1);
230 g_object_set (G_OBJECT (object), name, i, NULL);
236 sscanf_ret = sscanf (value, "%ld", &i);
237 g_return_if_fail (sscanf_ret == 1);
238 g_object_set (G_OBJECT (object), name, i, NULL);
244 sscanf_ret = sscanf (value, "%lu", &i);
245 g_return_if_fail (sscanf_ret == 1);
246 g_object_set (G_OBJECT (object), name, i, NULL);
249 case G_TYPE_BOOLEAN:{
252 if (!g_ascii_strncasecmp ("true", value, 4))
254 g_object_set (G_OBJECT (object), name, i, NULL);
260 sscanf_ret = sscanf (value, "%c", &i);
261 g_return_if_fail (sscanf_ret == 1);
262 g_object_set (G_OBJECT (object), name, i, NULL);
268 sscanf_ret = sscanf (value, "%c", &i);
269 g_return_if_fail (sscanf_ret == 1);
270 g_object_set (G_OBJECT (object), name, i, NULL);
276 sscanf_ret = sscanf (value, "%f", &i);
277 g_return_if_fail (sscanf_ret == 1);
278 g_object_set (G_OBJECT (object), name, i, NULL);
284 sscanf_ret = sscanf (value, "%g", &i);
285 g_return_if_fail (sscanf_ret == 1);
286 g_object_set (G_OBJECT (object), name, (gdouble) i, NULL);
290 if (G_IS_PARAM_SPEC_ENUM (paramspec)) {
293 sscanf_ret = sscanf (value, "%d", &i);
294 g_return_if_fail (sscanf_ret == 1);
295 g_object_set (G_OBJECT (object), name, i, NULL);
303 /* work around error C2520: conversion from unsigned __int64 to double
304 * not implemented, use signed __int64
306 * These are implemented as functions because on some platforms a 64bit int to
307 * double conversion is not defined/implemented.
311 gst_util_guint64_to_gdouble (guint64 value)
313 if (value & G_GINT64_CONSTANT (0x8000000000000000))
314 return (gdouble) ((gint64) value) + (gdouble) 18446744073709551616.;
316 return (gdouble) ((gint64) value);
320 gst_util_gdouble_to_guint64 (gdouble value)
322 if (value < (gdouble) 9223372036854775808.) /* 1 << 63 */
323 return ((guint64) ((gint64) value));
325 value -= (gdouble) 18446744073709551616.;
326 return ((guint64) ((gint64) value));
329 /* convenience struct for getting high and low uint32 parts of
336 #if G_BYTE_ORDER == G_BIG_ENDIAN
344 /* based on Hacker's Delight p152 */
346 gst_util_div128_64 (GstUInt64 c1, GstUInt64 c0, guint64 denom)
348 GstUInt64 q1, q0, rhat;
349 GstUInt64 v, cmp1, cmp2;
354 /* count number of leading zeroes, we know they must be in the high
355 * part of denom since denom > G_MAXUINT32. */
356 s = v.l.high | (v.l.high >> 1);
360 s = ~(s | (s >> 16));
361 s = s - ((s >> 1) & 0x55555555);
362 s = (s & 0x33333333) + ((s >> 2) & 0x33333333);
363 s = (s + (s >> 4)) & 0x0f0f0f0f;
365 s = (s + (s >> 16)) & 0x3f;
368 /* normalize divisor and dividend */
370 c1.ll = (c1.ll << s) | (c0.l.high >> (32 - s));
374 q1.ll = c1.ll / v.l.high;
375 rhat.ll = c1.ll - q1.ll * v.l.high;
377 cmp1.l.high = rhat.l.low;
378 cmp1.l.low = c0.l.high;
379 cmp2.ll = q1.ll * v.l.low;
381 while (q1.l.high || cmp2.ll > cmp1.ll) {
386 cmp1.l.high = rhat.l.low;
389 c1.l.high = c1.l.low;
390 c1.l.low = c0.l.high;
391 c1.ll -= q1.ll * v.ll;
392 q0.ll = c1.ll / v.l.high;
393 rhat.ll = c1.ll - q0.ll * v.l.high;
395 cmp1.l.high = rhat.l.low;
396 cmp1.l.low = c0.l.low;
397 cmp2.ll = q0.ll * v.l.low;
399 while (q0.l.high || cmp2.ll > cmp1.ll) {
404 cmp1.l.high = rhat.l.low;
407 q0.l.high += q1.l.low;
413 gst_util_uint64_scale_int64 (guint64 val, guint64 num, guint64 denom)
415 GstUInt64 a0, a1, b0, b1, c0, ct, c1, result;
422 /* do 128 bits multiply
430 * -------------------
433 a0.ll = (guint64) v.l.low * n.l.low;
434 a1.ll = (guint64) v.l.low * n.l.high;
435 b0.ll = (guint64) v.l.high * n.l.low;
436 b1.ll = (guint64) v.l.high * n.l.high;
438 /* and sum together with carry into 128 bits c1, c0 */
440 ct.ll = (guint64) a0.l.high + a1.l.low + b0.l.low;
441 c0.l.high = ct.l.low;
442 c1.ll = (guint64) a1.l.high + b0.l.high + ct.l.high + b1.ll;
444 /* if high bits bigger than denom, we overflow */
448 /* shortcut for division by 1, c1.ll should be 0 because of the
449 * overflow check above. */
453 /* and 128/64 bits division, result fits 64 bits */
454 if (denom <= G_MAXUINT32) {
455 guint32 den = (guint32) denom;
457 /* easy case, (c1,c0)128/(den)32 division */
459 c1.l.high = c1.ll % den;
460 c1.l.low = c0.l.high;
461 c0.l.high = c1.ll % den;
462 result.l.high = c1.ll / den;
463 result.l.low = c0.ll / den;
465 result.ll = gst_util_div128_64 (c1, c0, denom);
476 * gst_util_uint64_scale:
477 * @val: the number to scale
478 * @num: the numerator of the scale ratio
479 * @denom: the denominator of the scale ratio
481 * Scale @val by @num / @denom, trying to avoid overflows.
483 * This function can potentially be very slow if denom > G_MAXUINT32.
485 * Returns: @val * @num / @denom, trying to avoid overflows.
486 * In the case of an overflow, this function returns G_MAXUINT64.
489 gst_util_uint64_scale (guint64 val, guint64 num, guint64 denom)
491 g_return_val_if_fail (denom != 0, G_MAXUINT64);
496 if (num == 1 && denom == 1)
499 /* if the denom is high, we need to do a 64 muldiv */
500 if (denom > G_MAXINT32)
503 /* if num and denom are low we can do a 32 bit muldiv */
504 if (num <= G_MAXINT32)
507 /* val and num are high, we need 64 muldiv */
508 if (val > G_MAXINT32)
511 /* val is low and num is high, we can swap them and do 32 muldiv */
512 return gst_util_uint64_scale_int (num, (gint) val, (gint) denom);
515 return gst_util_uint64_scale_int (val, (gint) num, (gint) denom);
518 /* to the more heavy implementations... */
519 return gst_util_uint64_scale_int64 (val, num, denom);
523 * gst_util_uint64_scale_int:
524 * @val: guint64 (such as a #GstClockTime) to scale.
525 * @num: numerator of the scale factor.
526 * @denom: denominator of the scale factor.
528 * Scale a guint64 by a factor expressed as a fraction (num/denom), avoiding
529 * overflows and loss of precision.
531 * @num and @denom must be positive integers. @denom cannot be 0.
533 * Returns: @val * @num / @denom, avoiding overflow and loss of precision.
534 * In the case of an overflow, this function returns G_MAXUINT64.
537 gst_util_uint64_scale_int (guint64 val, gint num, gint denom)
542 g_return_val_if_fail (denom > 0, G_MAXUINT64);
543 g_return_val_if_fail (num >= 0, G_MAXUINT64);
548 if (num == 1 && denom == 1)
551 if (val <= G_MAXUINT32)
553 return val * num / denom;
555 /* do 96 bits mult/div */
557 result.ll = ((guint64) low.l.low) * num;
558 high.ll = ((guint64) low.l.high) * num + (result.l.high);
560 low.ll = high.ll / denom;
561 result.l.high = high.ll % denom;
565 if (low.ll + result.l.high > G_MAXUINT32)
568 result.l.high += low.l.low;
579 * gst_util_seqnum_next:
581 * Return a constantly incrementing sequence number.
583 * This function is used internally to GStreamer to be able to determine which
584 * events and messages are "the same". For example, elements may set the seqnum
585 * on a segment-done message to be the same as that of the last seek event, to
586 * indicate that event and the message correspond to the same segment.
588 * Returns: A constantly incrementing 32-bit unsigned integer, which might
589 * overflow back to 0 at some point. Use gst_util_seqnum_compare() to make sure
590 * you handle wraparound correctly.
595 gst_util_seqnum_next (void)
597 static gint counter = 0;
598 return g_atomic_int_exchange_and_add (&counter, 1);
602 * gst_util_seqnum_compare:
603 * @s1: A sequence number.
604 * @s2: Another sequence number.
606 * Compare two sequence numbers, handling wraparound.
608 * The current implementation just returns (gint32)(@s1 - @s2).
610 * Returns: A negative number if @s1 is before @s2, 0 if they are equal, or a
611 * positive number if @s1 is after @s2.
616 gst_util_seqnum_compare (guint32 s1, guint32 s2)
618 return (gint32) (s1 - s2);
621 /* -----------------------------------------------------
623 * The following code will be moved out of the main
624 * gstreamer library someday.
630 string_append_indent (GString * str, gint count)
634 for (xx = 0; xx < count; xx++)
635 g_string_append_c (str, ' ');
639 * gst_print_pad_caps:
640 * @buf: the buffer to print the caps in
641 * @indent: initial indentation
642 * @pad: the pad to print the caps from
644 * Write the pad capabilities in a human readable format into
648 gst_print_pad_caps (GString * buf, gint indent, GstPad * pad)
655 string_append_indent (buf, indent);
656 g_string_printf (buf, "%s:%s has no capabilities",
657 GST_DEBUG_PAD_NAME (pad));
661 s = gst_caps_to_string (caps);
662 g_string_append (buf, s);
668 * gst_print_element_args:
669 * @buf: the buffer to print the args in
670 * @indent: initial indentation
671 * @element: the element to print the args of
673 * Print the element argument in a human readable format in the given
677 gst_print_element_args (GString * buf, gint indent, GstElement * element)
680 GValue value = { 0, }; /* the important thing is that value.type = 0 */
682 GParamSpec *spec, **specs, **walk;
684 specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (element), NULL);
687 for (walk = specs; *walk; walk++) {
689 if (width < strlen (spec->name))
690 width = strlen (spec->name);
693 for (walk = specs; *walk; walk++) {
696 if (spec->flags & G_PARAM_READABLE) {
697 g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (spec));
698 g_object_get_property (G_OBJECT (element), spec->name, &value);
699 str = g_strdup_value_contents (&value);
700 g_value_unset (&value);
702 str = g_strdup ("Parameter not readable.");
705 string_append_indent (buf, indent);
706 g_string_append (buf, spec->name);
707 string_append_indent (buf, 2 + width - strlen (spec->name));
708 g_string_append (buf, str);
709 g_string_append_c (buf, '\n');
718 * gst_element_create_all_pads:
719 * @element: a #GstElement to create pads for
721 * Creates a pad for each pad template that is always available.
722 * This function is only useful during object intialization of
723 * subclasses of #GstElement.
726 gst_element_create_all_pads (GstElement * element)
730 /* FIXME: lock element */
733 gst_element_class_get_pad_template_list (GST_ELEMENT_CLASS
734 (G_OBJECT_GET_CLASS (element)));
737 GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
739 if (padtempl->presence == GST_PAD_ALWAYS) {
742 pad = gst_pad_new_from_template (padtempl, padtempl->name_template);
744 gst_element_add_pad (element, pad);
746 padlist = padlist->next;
751 * gst_element_get_compatible_pad_template:
752 * @element: a #GstElement to get a compatible pad template for.
753 * @compattempl: the #GstPadTemplate to find a compatible template for.
755 * Retrieves a pad template from @element that is compatible with @compattempl.
756 * Pads from compatible templates can be linked together.
758 * Returns: a compatible #GstPadTemplate, or NULL if none was found. No
759 * unreferencing is necessary.
762 gst_element_get_compatible_pad_template (GstElement * element,
763 GstPadTemplate * compattempl)
765 GstPadTemplate *newtempl = NULL;
767 GstElementClass *class;
769 g_return_val_if_fail (element != NULL, NULL);
770 g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
771 g_return_val_if_fail (compattempl != NULL, NULL);
773 class = GST_ELEMENT_GET_CLASS (element);
775 padlist = gst_element_class_get_pad_template_list (class);
777 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
778 "Looking for a suitable pad template in %s out of %d templates...",
779 GST_ELEMENT_NAME (element), g_list_length (padlist));
782 GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
783 GstCaps *intersection;
787 * Check direction (must be opposite)
790 GST_CAT_LOG (GST_CAT_CAPS,
791 "checking pad template %s", padtempl->name_template);
792 if (padtempl->direction != compattempl->direction) {
793 GST_CAT_DEBUG (GST_CAT_CAPS,
794 "compatible direction: found %s pad template \"%s\"",
795 padtempl->direction == GST_PAD_SRC ? "src" : "sink",
796 padtempl->name_template);
798 GST_CAT_DEBUG (GST_CAT_CAPS,
799 "intersecting %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (compattempl));
800 GST_CAT_DEBUG (GST_CAT_CAPS,
801 "..and %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (padtempl));
803 intersection = gst_caps_intersect (GST_PAD_TEMPLATE_CAPS (compattempl),
804 GST_PAD_TEMPLATE_CAPS (padtempl));
806 GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible %" GST_PTR_FORMAT,
807 (intersection ? "" : "not "), intersection);
809 if (!gst_caps_is_empty (intersection))
811 gst_caps_unref (intersection);
816 padlist = g_list_next (padlist);
819 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
820 "Returning new pad template %p", newtempl);
822 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "No compatible pad template found");
828 gst_element_request_pad (GstElement * element, GstPadTemplate * templ,
831 GstPad *newpad = NULL;
832 GstElementClass *oclass;
834 oclass = GST_ELEMENT_GET_CLASS (element);
836 if (oclass->request_new_pad)
837 newpad = (oclass->request_new_pad) (element, templ, name);
840 gst_object_ref (newpad);
848 * gst_element_get_pad_from_template:
849 * @element: a #GstElement.
850 * @templ: a #GstPadTemplate belonging to @element.
852 * Gets a pad from @element described by @templ. If the presence of @templ is
853 * #GST_PAD_REQUEST, requests a new pad. Can return %NULL for #GST_PAD_SOMETIMES
856 * Returns: the #GstPad, or NULL if one could not be found or created.
859 gst_element_get_pad_from_template (GstElement * element, GstPadTemplate * templ)
862 GstPadPresence presence;
864 /* If this function is ever exported, we need check the validity of `element'
865 * and `templ', and to make sure the template actually belongs to the
868 presence = GST_PAD_TEMPLATE_PRESENCE (templ);
872 case GST_PAD_SOMETIMES:
873 ret = gst_element_get_static_pad (element, templ->name_template);
874 if (!ret && presence == GST_PAD_ALWAYS)
876 ("Element %s has an ALWAYS template %s, but no pad of the same name",
877 GST_OBJECT_NAME (element), templ->name_template);
880 case GST_PAD_REQUEST:
881 ret = gst_element_request_pad (element, templ, NULL);
889 * gst_element_request_compatible_pad:
890 * @element: a #GstElement.
891 * @templ: the #GstPadTemplate to which the new pad should be able to link.
893 * Requests a pad from @element. The returned pad should be unlinked and
894 * compatible with @templ. Might return an existing pad, or request a new one.
896 * Returns: a #GstPad, or %NULL if one could not be found or created.
899 gst_element_request_compatible_pad (GstElement * element,
900 GstPadTemplate * templ)
902 GstPadTemplate *templ_new;
905 g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
906 g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
908 /* FIXME: should really loop through the templates, testing each for
909 * compatibility and pad availability. */
910 templ_new = gst_element_get_compatible_pad_template (element, templ);
912 pad = gst_element_get_pad_from_template (element, templ_new);
914 /* This can happen for non-request pads. No need to unref. */
915 if (pad && GST_PAD_PEER (pad))
922 * gst_element_get_compatible_pad:
923 * @element: a #GstElement in which the pad should be found.
924 * @pad: the #GstPad to find a compatible one for.
925 * @caps: the #GstCaps to use as a filter.
927 * Looks for an unlinked pad to which the given pad can link. It is not
928 * guaranteed that linking the pads will work, though it should work in most
931 * Returns: the #GstPad to which a link can be made, or %NULL if one cannot be
932 * found. gst_object_unref() after usage.
935 gst_element_get_compatible_pad (GstElement * element, GstPad * pad,
936 const GstCaps * caps)
939 GstPadTemplate *templ;
941 GstPad *foundpad = NULL;
944 g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
945 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
947 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
948 "finding pad in %s compatible with %s:%s",
949 GST_ELEMENT_NAME (element), GST_DEBUG_PAD_NAME (pad));
951 g_return_val_if_fail (GST_PAD_PEER (pad) == NULL, NULL);
954 /* try to get an existing unlinked pad */
955 pads = gst_element_iterate_pads (element);
959 switch (gst_iterator_next (pads, &padptr)) {
960 case GST_ITERATOR_OK:
965 current = GST_PAD (padptr);
967 GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
968 GST_DEBUG_PAD_NAME (current));
970 peer = gst_pad_get_peer (current);
972 if (peer == NULL && gst_pad_can_link (pad, current)) {
973 GstCaps *temp, *temp2, *intersection;
975 /* Now check if the two pads' caps are compatible */
976 temp = gst_pad_get_caps (pad);
978 intersection = gst_caps_intersect (temp, caps);
979 gst_caps_unref (temp);
984 temp = gst_pad_get_caps (current);
985 temp2 = gst_caps_intersect (temp, intersection);
986 gst_caps_unref (temp);
987 gst_caps_unref (intersection);
989 intersection = temp2;
991 if (!gst_caps_is_empty (intersection)) {
992 gst_caps_unref (intersection);
994 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
995 "found existing unlinked compatible pad %s:%s",
996 GST_DEBUG_PAD_NAME (current));
997 gst_iterator_free (pads);
1001 gst_caps_unref (intersection);
1003 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unreffing pads");
1005 gst_object_unref (current);
1007 gst_object_unref (peer);
1010 case GST_ITERATOR_DONE:
1013 case GST_ITERATOR_RESYNC:
1014 gst_iterator_resync (pads);
1016 case GST_ITERATOR_ERROR:
1017 g_assert_not_reached ();
1021 gst_iterator_free (pads);
1023 GST_CAT_DEBUG_OBJECT (GST_CAT_ELEMENT_PADS, element,
1024 "Could not find a compatible unlinked always pad to link to %s:%s, now checking request pads",
1025 GST_DEBUG_PAD_NAME (pad));
1027 /* try to create a new one */
1028 /* requesting is a little crazy, we need a template. Let's create one */
1029 /* FIXME: why not gst_pad_get_pad_template (pad); */
1030 templcaps = gst_pad_get_caps (pad);
1032 templ = gst_pad_template_new ((gchar *) GST_PAD_NAME (pad),
1033 GST_PAD_DIRECTION (pad), GST_PAD_ALWAYS, templcaps);
1035 /* FIXME : Because of a bug in gst_pad_template_new() by which is does not
1036 * properly steal the refcount of the given caps, we have to unref these caps
1037 * REVERT THIS WHEN FIXED !*/
1038 gst_caps_unref (templcaps);
1040 foundpad = gst_element_request_compatible_pad (element, templ);
1041 gst_object_unref (templ);
1044 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1045 "found existing request pad %s:%s", GST_DEBUG_PAD_NAME (foundpad));
1049 GST_CAT_INFO_OBJECT (GST_CAT_ELEMENT_PADS, element,
1050 "Could not find a compatible pad to link to %s:%s",
1051 GST_DEBUG_PAD_NAME (pad));
1056 * gst_element_state_get_name:
1057 * @state: a #GstState to get the name of.
1059 * Gets a string representing the given state.
1061 * Returns: a string with the name of the state.
1063 G_CONST_RETURN gchar *
1064 gst_element_state_get_name (GstState state)
1067 #ifdef GST_DEBUG_COLOR
1068 case GST_STATE_VOID_PENDING:
1069 return "VOID_PENDING";
1070 case GST_STATE_NULL:
1071 return "\033[01;34mNULL\033[00m";
1072 case GST_STATE_READY:
1073 return "\033[01;31mREADY\033[00m";
1074 case GST_STATE_PLAYING:
1075 return "\033[01;32mPLAYING\033[00m";
1076 case GST_STATE_PAUSED:
1077 return "\033[01;33mPAUSED\033[00m";
1079 /* This is a memory leak */
1080 return g_strdup_printf ("\033[01;35;41mUNKNOWN!\033[00m(%d)", state);
1082 case GST_STATE_VOID_PENDING:
1083 return "VOID_PENDING";
1084 case GST_STATE_NULL:
1086 case GST_STATE_READY:
1088 case GST_STATE_PLAYING:
1090 case GST_STATE_PAUSED:
1093 /* This is a memory leak */
1094 return g_strdup_printf ("UNKNOWN!(%d)", state);
1100 * gst_element_state_change_return_get_name:
1101 * @state_ret: a #GstStateChangeReturn to get the name of.
1103 * Gets a string representing the given state change result.
1105 * Returns: a string with the name of the state change result.
1109 G_CONST_RETURN gchar *
1110 gst_element_state_change_return_get_name (GstStateChangeReturn state_ret)
1112 switch (state_ret) {
1113 #ifdef GST_DEBUG_COLOR
1114 case GST_STATE_CHANGE_FAILURE:
1115 return "\033[01;31mFAILURE\033[00m";
1116 case GST_STATE_CHANGE_SUCCESS:
1117 return "\033[01;32mSUCCESS\033[00m";
1118 case GST_STATE_CHANGE_ASYNC:
1119 return "\033[01;33mASYNC\033[00m";
1120 case GST_STATE_CHANGE_NO_PREROLL:
1121 return "\033[01;34mNO_PREROLL\033[00m";
1123 /* This is a memory leak */
1124 return g_strdup_printf ("\033[01;35;41mUNKNOWN!\033[00m(%d)", state_ret);
1126 case GST_STATE_CHANGE_FAILURE:
1128 case GST_STATE_CHANGE_SUCCESS:
1130 case GST_STATE_CHANGE_ASYNC:
1132 case GST_STATE_CHANGE_NO_PREROLL:
1133 return "NO PREROLL";
1135 /* This is a memory leak */
1136 return g_strdup_printf ("UNKNOWN!(%d)", state_ret);
1143 * gst_element_factory_can_src_caps :
1144 * @factory: factory to query
1145 * @caps: the caps to check
1147 * Checks if the factory can source the given capability.
1149 * Returns: true if it can src the capabilities
1152 gst_element_factory_can_src_caps (GstElementFactory * factory,
1153 const GstCaps * caps)
1157 g_return_val_if_fail (factory != NULL, FALSE);
1158 g_return_val_if_fail (caps != NULL, FALSE);
1160 templates = factory->staticpadtemplates;
1163 GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1165 if (template->direction == GST_PAD_SRC) {
1166 if (gst_caps_is_always_compatible (gst_static_caps_get
1167 (&template->static_caps), caps))
1170 templates = g_list_next (templates);
1177 * gst_element_factory_can_sink_caps :
1178 * @factory: factory to query
1179 * @caps: the caps to check
1181 * Checks if the factory can sink the given capability.
1183 * Returns: true if it can sink the capabilities
1186 gst_element_factory_can_sink_caps (GstElementFactory * factory,
1187 const GstCaps * caps)
1191 g_return_val_if_fail (factory != NULL, FALSE);
1192 g_return_val_if_fail (caps != NULL, FALSE);
1194 templates = factory->staticpadtemplates;
1197 GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1199 if (template->direction == GST_PAD_SINK) {
1200 if (gst_caps_is_always_compatible (caps,
1201 gst_static_caps_get (&template->static_caps)))
1204 templates = g_list_next (templates);
1211 /* if return val is true, *direct_child is a caller-owned ref on the direct
1212 * child of ancestor that is part of object's ancestry */
1214 object_has_ancestor (GstObject * object, GstObject * ancestor,
1215 GstObject ** direct_child)
1217 GstObject *child, *parent;
1220 *direct_child = NULL;
1222 child = gst_object_ref (object);
1223 parent = gst_object_get_parent (object);
1226 if (ancestor == parent) {
1228 *direct_child = child;
1230 gst_object_unref (child);
1231 gst_object_unref (parent);
1235 gst_object_unref (child);
1237 parent = gst_object_get_parent (parent);
1240 gst_object_unref (child);
1245 /* caller owns return */
1247 find_common_root (GstObject * o1, GstObject * o2)
1249 GstObject *top = o1;
1250 GstObject *kid1, *kid2;
1251 GstObject *root = NULL;
1253 while (GST_OBJECT_PARENT (top))
1254 top = GST_OBJECT_PARENT (top);
1256 /* the itsy-bitsy spider... */
1258 if (!object_has_ancestor (o2, top, &kid2))
1261 root = gst_object_ref (top);
1263 if (!object_has_ancestor (o1, kid2, &kid1)) {
1264 gst_object_unref (kid2);
1268 if (!object_has_ancestor (o2, kid1, &kid2)) {
1269 gst_object_unref (kid1);
1276 /* caller does not own return */
1278 ghost_up (GstElement * e, GstPad * pad)
1280 static gint ghost_pad_index = 0;
1283 GstObject *parent = GST_OBJECT_PARENT (e);
1285 name = g_strdup_printf ("ghost%d", ghost_pad_index++);
1286 gpad = gst_ghost_pad_new (name, pad);
1289 if (!gst_element_add_pad ((GstElement *) parent, gpad)) {
1290 g_warning ("Pad named %s already exists in element %s\n",
1291 GST_OBJECT_NAME (gpad), GST_OBJECT_NAME (parent));
1292 gst_object_unref ((GstObject *) gpad);
1300 remove_pad (gpointer ppad, gpointer unused)
1304 if (!gst_element_remove_pad ((GstElement *) GST_OBJECT_PARENT (pad), pad))
1305 g_warning ("Couldn't remove pad %s from element %s",
1306 GST_OBJECT_NAME (pad), GST_OBJECT_NAME (GST_OBJECT_PARENT (pad)));
1310 prepare_link_maybe_ghosting (GstPad ** src, GstPad ** sink,
1311 GSList ** pads_created)
1315 GSList *pads_created_local = NULL;
1317 g_assert (pads_created);
1319 e1 = GST_OBJECT_PARENT (*src);
1320 e2 = GST_OBJECT_PARENT (*sink);
1322 if (G_UNLIKELY (e1 == NULL)) {
1323 GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1324 GST_PTR_FORMAT, *src);
1327 if (G_UNLIKELY (e2 == NULL)) {
1328 GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1329 GST_PTR_FORMAT, *sink);
1333 if (GST_OBJECT_PARENT (e1) == GST_OBJECT_PARENT (e2)) {
1334 GST_CAT_INFO (GST_CAT_PADS, "%s and %s in same bin, no need for ghost pads",
1335 GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1339 GST_CAT_INFO (GST_CAT_PADS, "%s and %s not in same bin, making ghost pads",
1340 GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1342 /* we need to setup some ghost pads */
1343 root = find_common_root (e1, e2);
1345 g_warning ("Trying to connect elements that don't share a common "
1346 "ancestor: %s and %s", GST_ELEMENT_NAME (e1), GST_ELEMENT_NAME (e2));
1350 while (GST_OBJECT_PARENT (e1) != root) {
1351 *src = ghost_up ((GstElement *) e1, *src);
1354 e1 = GST_OBJECT_PARENT (*src);
1355 pads_created_local = g_slist_prepend (pads_created_local, *src);
1357 while (GST_OBJECT_PARENT (e2) != root) {
1358 *sink = ghost_up ((GstElement *) e2, *sink);
1361 e2 = GST_OBJECT_PARENT (*sink);
1362 pads_created_local = g_slist_prepend (pads_created_local, *sink);
1365 gst_object_unref (root);
1366 *pads_created = g_slist_concat (*pads_created, pads_created_local);
1370 gst_object_unref (root);
1371 g_slist_foreach (pads_created_local, remove_pad, NULL);
1372 g_slist_free (pads_created_local);
1377 pad_link_maybe_ghosting (GstPad * src, GstPad * sink)
1379 GSList *pads_created = NULL;
1382 if (!prepare_link_maybe_ghosting (&src, &sink, &pads_created)) {
1385 ret = (gst_pad_link (src, sink) == GST_PAD_LINK_OK);
1389 g_slist_foreach (pads_created, remove_pad, NULL);
1391 g_slist_free (pads_created);
1397 * gst_element_link_pads:
1398 * @src: a #GstElement containing the source pad.
1399 * @srcpadname: the name of the #GstPad in source element or NULL for any pad.
1400 * @dest: the #GstElement containing the destination pad.
1401 * @destpadname: the name of the #GstPad in destination element,
1402 * or NULL for any pad.
1404 * Links the two named pads of the source and destination elements.
1405 * Side effect is that if one of the pads has no parent, it becomes a
1406 * child of the parent of the other element. If they have different
1407 * parents, the link fails.
1409 * Returns: TRUE if the pads could be linked, FALSE otherwise.
1412 gst_element_link_pads (GstElement * src, const gchar * srcpadname,
1413 GstElement * dest, const gchar * destpadname)
1415 const GList *srcpads, *destpads, *srctempls, *desttempls, *l;
1416 GstPad *srcpad, *destpad;
1417 GstPadTemplate *srctempl, *desttempl;
1418 GstElementClass *srcclass, *destclass;
1421 g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1422 g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1424 srcclass = GST_ELEMENT_GET_CLASS (src);
1425 destclass = GST_ELEMENT_GET_CLASS (dest);
1427 GST_CAT_INFO (GST_CAT_ELEMENT_PADS,
1428 "trying to link element %s:%s to element %s:%s", GST_ELEMENT_NAME (src),
1429 srcpadname ? srcpadname : "(any)", GST_ELEMENT_NAME (dest),
1430 destpadname ? destpadname : "(any)");
1434 /* name specified, look it up */
1435 if (!(srcpad = gst_element_get_static_pad (src, srcpadname)))
1436 srcpad = gst_element_get_request_pad (src, srcpadname);
1438 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1439 GST_ELEMENT_NAME (src), srcpadname);
1442 if (!(GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC)) {
1443 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no src pad",
1444 GST_DEBUG_PAD_NAME (srcpad));
1445 gst_object_unref (srcpad);
1448 if (GST_PAD_PEER (srcpad) != NULL) {
1449 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is already linked",
1450 GST_DEBUG_PAD_NAME (srcpad));
1451 gst_object_unref (srcpad);
1457 /* no name given, get the first available pad */
1458 GST_OBJECT_LOCK (src);
1459 srcpads = GST_ELEMENT_PADS (src);
1460 srcpad = srcpads ? GST_PAD_CAST (srcpads->data) : NULL;
1462 gst_object_ref (srcpad);
1463 GST_OBJECT_UNLOCK (src);
1466 /* get a destination pad */
1468 /* name specified, look it up */
1469 if (!(destpad = gst_element_get_static_pad (dest, destpadname)))
1470 destpad = gst_element_get_request_pad (dest, destpadname);
1472 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1473 GST_ELEMENT_NAME (dest), destpadname);
1476 if (!(GST_PAD_DIRECTION (destpad) == GST_PAD_SINK)) {
1477 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no sink pad",
1478 GST_DEBUG_PAD_NAME (destpad));
1479 gst_object_unref (destpad);
1482 if (GST_PAD_PEER (destpad) != NULL) {
1483 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is already linked",
1484 GST_DEBUG_PAD_NAME (destpad));
1485 gst_object_unref (destpad);
1491 /* no name given, get the first available pad */
1492 GST_OBJECT_LOCK (dest);
1493 destpads = GST_ELEMENT_PADS (dest);
1494 destpad = destpads ? GST_PAD_CAST (destpads->data) : NULL;
1496 gst_object_ref (destpad);
1497 GST_OBJECT_UNLOCK (dest);
1500 if (srcpadname && destpadname) {
1503 /* two explicitly specified pads */
1504 result = pad_link_maybe_ghosting (srcpad, destpad);
1506 gst_object_unref (srcpad);
1507 gst_object_unref (destpad);
1513 /* loop through the allowed pads in the source, trying to find a
1514 * compatible destination pad */
1515 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1516 "looping through allowed src and dest pads");
1518 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying src pad %s:%s",
1519 GST_DEBUG_PAD_NAME (srcpad));
1520 if ((GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC) &&
1521 (GST_PAD_PEER (srcpad) == NULL)) {
1526 gst_object_ref (temp);
1528 temp = gst_element_get_compatible_pad (dest, srcpad, NULL);
1531 if (temp && pad_link_maybe_ghosting (srcpad, temp)) {
1532 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1533 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (temp));
1535 gst_object_unref (destpad);
1536 gst_object_unref (srcpad);
1537 gst_object_unref (temp);
1542 gst_object_unref (temp);
1545 /* find a better way for this mess */
1547 srcpads = g_list_next (srcpads);
1549 gst_object_unref (srcpad);
1550 srcpad = GST_PAD_CAST (srcpads->data);
1551 gst_object_ref (srcpad);
1557 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s:%s to %s",
1558 GST_DEBUG_PAD_NAME (srcpad), GST_ELEMENT_NAME (dest));
1560 gst_object_unref (destpad);
1564 gst_object_unref (srcpad);
1568 /* loop through the existing pads in the destination */
1570 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying dest pad %s:%s",
1571 GST_DEBUG_PAD_NAME (destpad));
1572 if ((GST_PAD_DIRECTION (destpad) == GST_PAD_SINK) &&
1573 (GST_PAD_PEER (destpad) == NULL)) {
1574 GstPad *temp = gst_element_get_compatible_pad (src, destpad, NULL);
1576 if (temp && pad_link_maybe_ghosting (temp, destpad)) {
1577 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1578 GST_DEBUG_PAD_NAME (temp), GST_DEBUG_PAD_NAME (destpad));
1579 gst_object_unref (temp);
1580 gst_object_unref (destpad);
1584 gst_object_unref (temp);
1588 destpads = g_list_next (destpads);
1590 gst_object_unref (destpad);
1591 destpad = GST_PAD_CAST (destpads->data);
1592 gst_object_ref (destpad);
1599 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s:%s",
1600 GST_ELEMENT_NAME (src), GST_DEBUG_PAD_NAME (destpad));
1601 gst_object_unref (destpad);
1605 gst_object_unref (destpad);
1609 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1610 "we might have request pads on both sides, checking...");
1611 srctempls = gst_element_class_get_pad_template_list (srcclass);
1612 desttempls = gst_element_class_get_pad_template_list (destclass);
1614 if (srctempls && desttempls) {
1616 srctempl = (GstPadTemplate *) srctempls->data;
1617 if (srctempl->presence == GST_PAD_REQUEST) {
1618 for (l = desttempls; l; l = l->next) {
1619 desttempl = (GstPadTemplate *) l->data;
1620 if (desttempl->presence == GST_PAD_REQUEST &&
1621 desttempl->direction != srctempl->direction) {
1622 if (gst_caps_is_always_compatible (gst_pad_template_get_caps
1623 (srctempl), gst_pad_template_get_caps (desttempl))) {
1625 gst_element_get_request_pad (src, srctempl->name_template);
1627 gst_element_get_request_pad (dest, desttempl->name_template);
1628 if (srcpad && destpad
1629 && pad_link_maybe_ghosting (srcpad, destpad)) {
1630 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1631 "linked pad %s:%s to pad %s:%s",
1632 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (destpad));
1633 gst_object_unref (srcpad);
1634 gst_object_unref (destpad);
1637 /* it failed, so we release the request pads */
1639 gst_element_release_request_pad (src, srcpad);
1641 gst_element_release_request_pad (dest, destpad);
1646 srctempls = srctempls->next;
1650 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s",
1651 GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
1656 * gst_element_link_pads_filtered:
1657 * @src: a #GstElement containing the source pad.
1658 * @srcpadname: the name of the #GstPad in source element or NULL for any pad.
1659 * @dest: the #GstElement containing the destination pad.
1660 * @destpadname: the name of the #GstPad in destination element or NULL for any pad.
1661 * @filter: the #GstCaps to filter the link, or #NULL for no filter.
1663 * Links the two named pads of the source and destination elements. Side effect
1664 * is that if one of the pads has no parent, it becomes a child of the parent of
1665 * the other element. If they have different parents, the link fails. If @caps
1666 * is not #NULL, makes sure that the caps of the link is a subset of @caps.
1668 * Returns: TRUE if the pads could be linked, FALSE otherwise.
1671 gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
1672 GstElement * dest, const gchar * destpadname, GstCaps * filter)
1675 g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1676 g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1677 g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), FALSE);
1680 GstElement *capsfilter;
1682 GstState state, pending;
1684 capsfilter = gst_element_factory_make ("capsfilter", NULL);
1686 GST_ERROR ("Could not make a capsfilter");
1690 parent = gst_object_get_parent (GST_OBJECT (src));
1691 g_return_val_if_fail (GST_IS_BIN (parent), FALSE);
1693 gst_element_get_state (GST_ELEMENT_CAST (parent), &state, &pending, 0);
1695 if (!gst_bin_add (GST_BIN (parent), capsfilter)) {
1696 GST_ERROR ("Could not add capsfilter");
1697 gst_object_unref (capsfilter);
1698 gst_object_unref (parent);
1702 if (pending != GST_STATE_VOID_PENDING)
1705 gst_element_set_state (capsfilter, state);
1707 gst_object_unref (parent);
1709 g_object_set (capsfilter, "caps", filter, NULL);
1711 if (gst_element_link_pads (src, srcpadname, capsfilter, "sink")
1712 && gst_element_link_pads (capsfilter, "src", dest, destpadname)) {
1715 GST_INFO ("Could not link elements");
1716 gst_element_set_state (capsfilter, GST_STATE_NULL);
1717 /* this will unlink and unref as appropriate */
1718 gst_bin_remove (GST_BIN (GST_OBJECT_PARENT (capsfilter)), capsfilter);
1722 return gst_element_link_pads (src, srcpadname, dest, destpadname);
1728 * @src: a #GstElement containing the source pad.
1729 * @dest: the #GstElement containing the destination pad.
1731 * Links @src to @dest. The link must be from source to
1732 * destination; the other direction will not be tried. The function looks for
1733 * existing pads that aren't linked yet. It will request new pads if necessary.
1734 * Such pads need to be released manualy when unlinking.
1735 * If multiple links are possible, only one is established.
1737 * Make sure you have added your elements to a bin or pipeline with
1738 * gst_bin_add() before trying to link them.
1740 * Returns: TRUE if the elements could be linked, FALSE otherwise.
1743 gst_element_link (GstElement * src, GstElement * dest)
1745 return gst_element_link_pads_filtered (src, NULL, dest, NULL, NULL);
1749 * gst_element_link_many:
1750 * @element_1: the first #GstElement in the link chain.
1751 * @element_2: the second #GstElement in the link chain.
1752 * @...: the NULL-terminated list of elements to link in order.
1754 * Chain together a series of elements. Uses gst_element_link().
1755 * Make sure you have added your elements to a bin or pipeline with
1756 * gst_bin_add() before trying to link them.
1758 * Returns: TRUE on success, FALSE otherwise.
1761 gst_element_link_many (GstElement * element_1, GstElement * element_2, ...)
1765 g_return_val_if_fail (GST_IS_ELEMENT (element_1), FALSE);
1766 g_return_val_if_fail (GST_IS_ELEMENT (element_2), FALSE);
1768 va_start (args, element_2);
1771 if (!gst_element_link (element_1, element_2))
1774 element_1 = element_2;
1775 element_2 = va_arg (args, GstElement *);
1784 * gst_element_link_filtered:
1785 * @src: a #GstElement containing the source pad.
1786 * @dest: the #GstElement containing the destination pad.
1787 * @filter: the #GstCaps to filter the link, or #NULL for no filter.
1789 * Links @src to @dest using the given caps as filtercaps.
1790 * The link must be from source to
1791 * destination; the other direction will not be tried. The function looks for
1792 * existing pads that aren't linked yet. It will request new pads if necessary.
1793 * If multiple links are possible, only one is established.
1795 * Make sure you have added your elements to a bin or pipeline with
1796 * gst_bin_add() before trying to link them.
1798 * Returns: TRUE if the pads could be linked, FALSE otherwise.
1801 gst_element_link_filtered (GstElement * src, GstElement * dest,
1804 return gst_element_link_pads_filtered (src, NULL, dest, NULL, filter);
1808 * gst_element_unlink_pads:
1809 * @src: a #GstElement containing the source pad.
1810 * @srcpadname: the name of the #GstPad in source element.
1811 * @dest: a #GstElement containing the destination pad.
1812 * @destpadname: the name of the #GstPad in destination element.
1814 * Unlinks the two named pads of the source and destination elements.
1817 gst_element_unlink_pads (GstElement * src, const gchar * srcpadname,
1818 GstElement * dest, const gchar * destpadname)
1820 GstPad *srcpad, *destpad;
1821 gboolean srcrequest, destrequest;
1823 srcrequest = destrequest = FALSE;
1825 g_return_if_fail (src != NULL);
1826 g_return_if_fail (GST_IS_ELEMENT (src));
1827 g_return_if_fail (srcpadname != NULL);
1828 g_return_if_fail (dest != NULL);
1829 g_return_if_fail (GST_IS_ELEMENT (dest));
1830 g_return_if_fail (destpadname != NULL);
1832 /* obtain the pads requested */
1833 if (!(srcpad = gst_element_get_static_pad (src, srcpadname)))
1834 if ((srcpad = gst_element_get_request_pad (src, srcpadname)))
1836 if (srcpad == NULL) {
1837 GST_WARNING_OBJECT (src, "source element has no pad \"%s\"", srcpadname);
1840 if (!(destpad = gst_element_get_static_pad (dest, destpadname)))
1841 if ((destpad = gst_element_get_request_pad (dest, destpadname)))
1843 if (destpad == NULL) {
1844 GST_WARNING_OBJECT (dest, "destination element has no pad \"%s\"",
1849 /* we're satisified they can be unlinked, let's do it */
1850 gst_pad_unlink (srcpad, destpad);
1853 gst_element_release_request_pad (dest, destpad);
1854 gst_object_unref (destpad);
1858 gst_element_release_request_pad (src, srcpad);
1859 gst_object_unref (srcpad);
1863 * gst_element_unlink_many:
1864 * @element_1: the first #GstElement in the link chain.
1865 * @element_2: the second #GstElement in the link chain.
1866 * @...: the NULL-terminated list of elements to unlink in order.
1868 * Unlinks a series of elements. Uses gst_element_unlink().
1871 gst_element_unlink_many (GstElement * element_1, GstElement * element_2, ...)
1875 g_return_if_fail (element_1 != NULL && element_2 != NULL);
1876 g_return_if_fail (GST_IS_ELEMENT (element_1) && GST_IS_ELEMENT (element_2));
1878 va_start (args, element_2);
1881 gst_element_unlink (element_1, element_2);
1883 element_1 = element_2;
1884 element_2 = va_arg (args, GstElement *);
1891 * gst_element_unlink:
1892 * @src: the source #GstElement to unlink.
1893 * @dest: the sink #GstElement to unlink.
1895 * Unlinks all source pads of the source element with all sink pads
1896 * of the sink element to which they are linked.
1898 * If the link has been made using gst_element_link(), it could have created an
1899 * requestpad, which has to be released using gst_element_release_request_pad().
1902 gst_element_unlink (GstElement * src, GstElement * dest)
1905 gboolean done = FALSE;
1907 g_return_if_fail (GST_IS_ELEMENT (src));
1908 g_return_if_fail (GST_IS_ELEMENT (dest));
1910 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unlinking \"%s\" and \"%s\"",
1911 GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
1913 pads = gst_element_iterate_pads (src);
1917 switch (gst_iterator_next (pads, &data)) {
1918 case GST_ITERATOR_OK:
1920 GstPad *pad = GST_PAD_CAST (data);
1922 if (GST_PAD_IS_SRC (pad)) {
1923 GstPad *peerpad = gst_pad_get_peer (pad);
1925 /* see if the pad is linked and is really a pad of dest */
1927 GstElement *peerelem;
1929 peerelem = gst_pad_get_parent_element (peerpad);
1931 if (peerelem == dest) {
1932 gst_pad_unlink (pad, peerpad);
1935 gst_object_unref (peerelem);
1937 gst_object_unref (peerpad);
1940 gst_object_unref (pad);
1943 case GST_ITERATOR_RESYNC:
1944 gst_iterator_resync (pads);
1946 case GST_ITERATOR_DONE:
1950 g_assert_not_reached ();
1954 gst_iterator_free (pads);
1958 * gst_element_query_position:
1959 * @element: a #GstElement to invoke the position query on.
1960 * @format: a pointer to the #GstFormat asked for.
1961 * On return contains the #GstFormat used.
1962 * @cur: A location in which to store the current position, or NULL.
1964 * Queries an element for the stream position.
1966 * Returns: TRUE if the query could be performed.
1969 gst_element_query_position (GstElement * element, GstFormat * format,
1975 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1976 g_return_val_if_fail (format != NULL, FALSE);
1978 query = gst_query_new_position (*format);
1979 ret = gst_element_query (element, query);
1982 gst_query_parse_position (query, format, cur);
1984 gst_query_unref (query);
1990 * gst_element_query_duration:
1991 * @element: a #GstElement to invoke the duration query on.
1992 * @format: a pointer to the #GstFormat asked for.
1993 * On return contains the #GstFormat used.
1994 * @duration: A location in which to store the total duration, or NULL.
1996 * Queries an element for the total stream duration.
1998 * Returns: TRUE if the query could be performed.
2001 gst_element_query_duration (GstElement * element, GstFormat * format,
2007 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2008 g_return_val_if_fail (format != NULL, FALSE);
2010 query = gst_query_new_duration (*format);
2011 ret = gst_element_query (element, query);
2014 gst_query_parse_duration (query, format, duration);
2016 gst_query_unref (query);
2022 * gst_element_query_convert:
2023 * @element: a #GstElement to invoke the convert query on.
2024 * @src_format: a #GstFormat to convert from.
2025 * @src_val: a value to convert.
2026 * @dest_format: a pointer to the #GstFormat to convert to.
2027 * @dest_val: a pointer to the result.
2029 * Queries an element to convert @src_val in @src_format to @dest_format.
2031 * Returns: TRUE if the query could be performed.
2034 gst_element_query_convert (GstElement * element, GstFormat src_format,
2035 gint64 src_val, GstFormat * dest_format, gint64 * dest_val)
2040 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2041 g_return_val_if_fail (dest_format != NULL, FALSE);
2042 g_return_val_if_fail (dest_val != NULL, FALSE);
2044 if (*dest_format == src_format) {
2045 *dest_val = src_val;
2049 query = gst_query_new_convert (src_format, src_val, *dest_format);
2050 ret = gst_element_query (element, query);
2053 gst_query_parse_convert (query, NULL, NULL, dest_format, dest_val);
2055 gst_query_unref (query);
2061 * gst_element_seek_simple
2062 * @element: a #GstElement to seek on
2063 * @format: a #GstFormat to execute the seek in, such as #GST_FORMAT_TIME
2064 * @seek_flags: seek options; playback applications will usually want to use
2065 * GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_KEY_UNIT here
2066 * @seek_pos: position to seek to (relative to the start); if you are doing
2067 * a seek in #GST_FORMAT_TIME this value is in nanoseconds -
2068 * multiply with #GST_SECOND to convert seconds to nanoseconds or
2069 * with #GST_MSECOND to convert milliseconds to nanoseconds.
2071 * Simple API to perform a seek on the given element, meaning it just seeks
2072 * to the given position relative to the start of the stream. For more complex
2073 * operations like segment seeks (e.g. for looping) or changing the playback
2074 * rate or seeking relative to the last configured playback segment you should
2075 * use gst_element_seek().
2077 * In a completely prerolled PAUSED or PLAYING pipeline, seeking is always
2078 * guaranteed to return %TRUE on a seekable media type or %FALSE when the media
2079 * type is certainly not seekable (such as a live stream).
2081 * Some elements allow for seeking in the READY state, in this
2082 * case they will store the seek event and execute it when they are put to
2083 * PAUSED. If the element supports seek in READY, it will always return %TRUE when
2084 * it receives the event in the READY state.
2086 * Returns: %TRUE if the seek operation succeeded (the seek might not always be
2087 * executed instantly though)
2092 gst_element_seek_simple (GstElement * element, GstFormat format,
2093 GstSeekFlags seek_flags, gint64 seek_pos)
2095 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2096 g_return_val_if_fail (seek_pos >= 0, FALSE);
2098 return gst_element_seek (element, 1.0, format, seek_flags,
2099 GST_SEEK_TYPE_SET, seek_pos, GST_SEEK_TYPE_NONE, 0);
2104 * @srcpad: the source #GstPad to link.
2105 * @sinkpad: the sink #GstPad to link.
2107 * Checks if the source pad and the sink pad can be linked.
2108 * Both @srcpad and @sinkpad must be unlinked.
2110 * Returns: TRUE if the pads can be linked, FALSE otherwise.
2113 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
2115 /* FIXME This function is gross. It's almost a direct copy of
2116 * gst_pad_link_filtered(). Any decent programmer would attempt
2117 * to merge the two functions, which I will do some day. --ds
2120 /* generic checks */
2121 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
2122 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
2124 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
2125 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2127 /* FIXME: shouldn't we convert this to g_return_val_if_fail? */
2128 if (GST_PAD_PEER (srcpad) != NULL) {
2129 GST_CAT_INFO (GST_CAT_PADS, "Source pad %s:%s has a peer, failed",
2130 GST_DEBUG_PAD_NAME (srcpad));
2133 if (GST_PAD_PEER (sinkpad) != NULL) {
2134 GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has a peer, failed",
2135 GST_DEBUG_PAD_NAME (sinkpad));
2138 if (!GST_PAD_IS_SRC (srcpad)) {
2139 GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s is not source pad, failed",
2140 GST_DEBUG_PAD_NAME (srcpad));
2143 if (!GST_PAD_IS_SINK (sinkpad)) {
2144 GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s is not sink pad, failed",
2145 GST_DEBUG_PAD_NAME (sinkpad));
2148 if (GST_PAD_PARENT (srcpad) == NULL) {
2149 GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s has no parent, failed",
2150 GST_DEBUG_PAD_NAME (srcpad));
2153 if (GST_PAD_PARENT (sinkpad) == NULL) {
2154 GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has no parent, failed",
2155 GST_DEBUG_PAD_NAME (srcpad));
2163 * gst_pad_use_fixed_caps:
2164 * @pad: the pad to use
2166 * A helper function you can use that sets the
2167 * @gst_pad_get_fixed_caps_func as the getcaps function for the
2168 * pad. This way the function will always return the negotiated caps
2169 * or in case the pad is not negotiated, the padtemplate caps.
2171 * Use this function on a pad that, once _set_caps() has been called
2172 * on it, cannot be renegotiated to something else.
2175 gst_pad_use_fixed_caps (GstPad * pad)
2177 gst_pad_set_getcaps_function (pad, gst_pad_get_fixed_caps_func);
2181 * gst_pad_get_fixed_caps_func:
2182 * @pad: the pad to use
2184 * A helper function you can use as a GetCaps function that
2185 * will return the currently negotiated caps or the padtemplate
2188 * Returns: The currently negotiated caps or the padtemplate.
2191 gst_pad_get_fixed_caps_func (GstPad * pad)
2195 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2197 GST_OBJECT_LOCK (pad);
2198 if (GST_PAD_CAPS (pad)) {
2199 result = GST_PAD_CAPS (pad);
2201 GST_CAT_DEBUG (GST_CAT_CAPS,
2202 "using pad caps %p %" GST_PTR_FORMAT, result, result);
2204 result = gst_caps_ref (result);
2207 if (GST_PAD_PAD_TEMPLATE (pad)) {
2208 GstPadTemplate *templ = GST_PAD_PAD_TEMPLATE (pad);
2210 result = GST_PAD_TEMPLATE_CAPS (templ);
2211 GST_CAT_DEBUG (GST_CAT_CAPS,
2212 "using pad template %p with caps %p %" GST_PTR_FORMAT, templ, result,
2215 result = gst_caps_ref (result);
2218 GST_CAT_DEBUG (GST_CAT_CAPS, "pad has no caps");
2219 result = gst_caps_new_empty ();
2222 GST_OBJECT_UNLOCK (pad);
2228 * gst_pad_get_parent_element:
2231 * Gets the parent of @pad, cast to a #GstElement. If a @pad has no parent or
2232 * its parent is not an element, return NULL.
2234 * Returns: The parent of the pad. The caller has a reference on the parent, so
2235 * unref when you're finished with it.
2240 gst_pad_get_parent_element (GstPad * pad)
2244 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2246 p = gst_object_get_parent (GST_OBJECT_CAST (pad));
2248 if (p && !GST_IS_ELEMENT (p)) {
2249 gst_object_unref (p);
2252 return GST_ELEMENT_CAST (p);
2256 * gst_object_default_error:
2257 * @source: the #GstObject that initiated the error.
2258 * @error: the GError.
2259 * @debug: an additional debug information string, or NULL.
2261 * A default error function.
2263 * The default handler will simply print the error string using g_print.
2266 gst_object_default_error (GstObject * source, GError * error, gchar * debug)
2268 gchar *name = gst_object_get_path_string (source);
2270 g_print (_("ERROR: from element %s: %s\n"), name, error->message);
2272 g_print (_("Additional debug info:\n%s\n"), debug);
2280 * @element_1: the #GstElement element to add to the bin
2281 * @...: additional elements to add to the bin
2283 * Adds a NULL-terminated list of elements to a bin. This function is
2284 * equivalent to calling gst_bin_add() for each member of the list. The return
2285 * value of each gst_bin_add() is ignored.
2288 gst_bin_add_many (GstBin * bin, GstElement * element_1, ...)
2292 g_return_if_fail (GST_IS_BIN (bin));
2293 g_return_if_fail (GST_IS_ELEMENT (element_1));
2295 va_start (args, element_1);
2298 gst_bin_add (bin, element_1);
2300 element_1 = va_arg (args, GstElement *);
2307 * gst_bin_remove_many:
2309 * @element_1: the first #GstElement to remove from the bin
2310 * @...: NULL-terminated list of elements to remove from the bin
2312 * Remove a list of elements from a bin. This function is equivalent
2313 * to calling gst_bin_remove() with each member of the list.
2316 gst_bin_remove_many (GstBin * bin, GstElement * element_1, ...)
2320 g_return_if_fail (GST_IS_BIN (bin));
2321 g_return_if_fail (GST_IS_ELEMENT (element_1));
2323 va_start (args, element_1);
2326 gst_bin_remove (bin, element_1);
2328 element_1 = va_arg (args, GstElement *);
2335 gst_element_populate_std_props (GObjectClass * klass, const gchar * prop_name,
2336 guint arg_id, GParamFlags flags)
2338 GQuark prop_id = g_quark_from_string (prop_name);
2341 static GQuark fd_id = 0;
2342 static GQuark blocksize_id;
2343 static GQuark bytesperread_id;
2344 static GQuark dump_id;
2345 static GQuark filesize_id;
2346 static GQuark mmapsize_id;
2347 static GQuark location_id;
2348 static GQuark offset_id;
2349 static GQuark silent_id;
2350 static GQuark touch_id;
2353 fd_id = g_quark_from_static_string ("fd");
2354 blocksize_id = g_quark_from_static_string ("blocksize");
2355 bytesperread_id = g_quark_from_static_string ("bytesperread");
2356 dump_id = g_quark_from_static_string ("dump");
2357 filesize_id = g_quark_from_static_string ("filesize");
2358 mmapsize_id = g_quark_from_static_string ("mmapsize");
2359 location_id = g_quark_from_static_string ("location");
2360 offset_id = g_quark_from_static_string ("offset");
2361 silent_id = g_quark_from_static_string ("silent");
2362 touch_id = g_quark_from_static_string ("touch");
2365 if (prop_id == fd_id) {
2366 pspec = g_param_spec_int ("fd", "File-descriptor",
2367 "File-descriptor for the file being read", 0, G_MAXINT, 0, flags);
2368 } else if (prop_id == blocksize_id) {
2369 pspec = g_param_spec_ulong ("blocksize", "Block Size",
2370 "Block size to read per buffer", 0, G_MAXULONG, 4096, flags);
2372 } else if (prop_id == bytesperread_id) {
2373 pspec = g_param_spec_int ("bytesperread", "Bytes per read",
2374 "Number of bytes to read per buffer", G_MININT, G_MAXINT, 0, flags);
2376 } else if (prop_id == dump_id) {
2377 pspec = g_param_spec_boolean ("dump", "Dump",
2378 "Dump bytes to stdout", FALSE, flags);
2380 } else if (prop_id == filesize_id) {
2381 pspec = g_param_spec_int64 ("filesize", "File Size",
2382 "Size of the file being read", 0, G_MAXINT64, 0, flags);
2384 } else if (prop_id == mmapsize_id) {
2385 pspec = g_param_spec_ulong ("mmapsize", "mmap() Block Size",
2386 "Size in bytes of mmap()d regions", 0, G_MAXULONG, 4 * 1048576, flags);
2388 } else if (prop_id == location_id) {
2389 pspec = g_param_spec_string ("location", "File Location",
2390 "Location of the file to read", NULL, flags);
2392 } else if (prop_id == offset_id) {
2393 pspec = g_param_spec_int64 ("offset", "File Offset",
2394 "Byte offset of current read pointer", 0, G_MAXINT64, 0, flags);
2396 } else if (prop_id == silent_id) {
2397 pspec = g_param_spec_boolean ("silent", "Silent", "Don't produce events",
2400 } else if (prop_id == touch_id) {
2401 pspec = g_param_spec_boolean ("touch", "Touch read data",
2402 "Touch data to force disk read before " "push ()", TRUE, flags);
2404 g_warning ("Unknown - 'standard' property '%s' id %d from klass %s",
2405 prop_name, arg_id, g_type_name (G_OBJECT_CLASS_TYPE (klass)));
2410 g_object_class_install_property (klass, arg_id, pspec);
2415 * gst_element_class_install_std_props:
2416 * @klass: the #GstElementClass to add the properties to.
2417 * @first_name: the name of the first property.
2418 * in a NULL terminated
2419 * @...: the id and flags of the first property, followed by
2420 * further 'name', 'id', 'flags' triplets and terminated by NULL.
2422 * Adds a list of standardized properties with types to the @klass.
2423 * the id is for the property switch in your get_prop method, and
2424 * the flags determine readability / writeability.
2427 gst_element_class_install_std_props (GstElementClass * klass,
2428 const gchar * first_name, ...)
2434 g_return_if_fail (GST_IS_ELEMENT_CLASS (klass));
2436 va_start (args, first_name);
2441 int arg_id = va_arg (args, int);
2442 int flags = va_arg (args, int);
2444 gst_element_populate_std_props ((GObjectClass *) klass, name, arg_id,
2447 name = va_arg (args, char *);
2456 * @buf1: the first source #GstBuffer to merge.
2457 * @buf2: the second source #GstBuffer to merge.
2459 * Create a new buffer that is the concatenation of the two source
2460 * buffers. The original source buffers will not be modified or
2461 * unref'd. Make sure you unref the source buffers if they are not used
2462 * anymore afterwards.
2464 * If the buffers point to contiguous areas of memory, the buffer
2465 * is created without copying the data.
2467 * Returns: the new #GstBuffer which is the concatenation of the source buffers.
2470 gst_buffer_merge (GstBuffer * buf1, GstBuffer * buf2)
2474 /* we're just a specific case of the more general gst_buffer_span() */
2475 result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
2482 * @buf1: the first source #GstBuffer.
2483 * @buf2: the second source #GstBuffer.
2485 * Create a new buffer that is the concatenation of the two source
2486 * buffers, and unrefs the original source buffers.
2488 * If the buffers point to contiguous areas of memory, the buffer
2489 * is created without copying the data.
2491 * This is a convenience function for C programmers. See also
2492 * gst_buffer_merge(), which does the same thing without
2493 * unreffing the input parameters. Language bindings without
2494 * explicit reference counting should not wrap this function.
2496 * Returns: the new #GstBuffer which is the concatenation of the source buffers.
2499 gst_buffer_join (GstBuffer * buf1, GstBuffer * buf2)
2503 result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
2504 gst_buffer_unref (buf1);
2505 gst_buffer_unref (buf2);
2513 * @dest: buffer to stamp
2514 * @src: buffer to stamp from
2516 * Copies additional information (the timestamp, duration, and offset start
2517 * and end) from one buffer to the other.
2519 * This function does not copy any buffer flags or caps and is equivalent to
2520 * gst_buffer_copy_metadata(@dest, @src, GST_BUFFER_COPY_TIMESTAMPS).
2522 * Deprecated: use gst_buffer_copy_metadata() instead, it provides more
2525 #ifndef GST_REMOVE_DEPRECATED
2527 gst_buffer_stamp (GstBuffer * dest, const GstBuffer * src)
2529 gst_buffer_copy_metadata (dest, src, GST_BUFFER_COPY_TIMESTAMPS);
2531 #endif /* GST_REMOVE_DEPRECATED */
2534 intersect_caps_func (GstPad * pad, GValue * ret, GstPad * orig)
2537 GstCaps *peercaps, *existing;
2539 existing = g_value_get_pointer (ret);
2540 peercaps = gst_pad_peer_get_caps (pad);
2541 if (peercaps == NULL)
2542 peercaps = gst_caps_new_any ();
2543 g_value_set_pointer (ret, gst_caps_intersect (existing, peercaps));
2544 gst_caps_unref (existing);
2545 gst_caps_unref (peercaps);
2547 gst_object_unref (pad);
2552 * gst_pad_proxy_getcaps:
2553 * @pad: a #GstPad to proxy.
2555 * Calls gst_pad_get_allowed_caps() for every other pad belonging to the
2556 * same element as @pad, and returns the intersection of the results.
2558 * This function is useful as a default getcaps function for an element
2559 * that can handle any stream format, but requires all its pads to have
2560 * the same caps. Two such elements are tee and aggregator.
2562 * Returns: the intersection of the other pads' allowed caps.
2565 gst_pad_proxy_getcaps (GstPad * pad)
2567 GstElement *element;
2568 GstCaps *caps, *intersected;
2570 GstIteratorResult res;
2571 GValue ret = { 0, };
2573 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2575 GST_DEBUG ("proxying getcaps for %s:%s", GST_DEBUG_PAD_NAME (pad));
2577 element = gst_pad_get_parent_element (pad);
2578 if (element == NULL)
2581 /* value to hold the return, by default it holds ANY, the ref is taken by
2583 g_value_init (&ret, G_TYPE_POINTER);
2584 g_value_set_pointer (&ret, gst_caps_new_any ());
2586 iter = gst_element_iterate_pads (element);
2589 gst_iterator_fold (iter, (GstIteratorFoldFunction) intersect_caps_func,
2592 case GST_ITERATOR_RESYNC:
2593 /* unref any value stored */
2594 if ((caps = g_value_get_pointer (&ret)))
2595 gst_caps_unref (caps);
2596 /* need to reset the result again to ANY */
2597 g_value_set_pointer (&ret, gst_caps_new_any ());
2598 gst_iterator_resync (iter);
2600 case GST_ITERATOR_DONE:
2601 /* all pads iterated, return collected value */
2604 /* iterator returned _ERROR or premature end with _OK,
2605 * mark an error and exit */
2606 if ((caps = g_value_get_pointer (&ret)))
2607 gst_caps_unref (caps);
2608 g_value_set_pointer (&ret, NULL);
2613 gst_iterator_free (iter);
2615 gst_object_unref (element);
2617 caps = g_value_get_pointer (&ret);
2618 g_value_unset (&ret);
2620 intersected = gst_caps_intersect (caps, gst_pad_get_pad_template_caps (pad));
2621 gst_caps_unref (caps);
2628 g_warning ("Pad list returned error on element %s",
2629 GST_ELEMENT_NAME (element));
2630 gst_iterator_free (iter);
2631 gst_object_unref (element);
2643 link_fold_func (GstPad * pad, GValue * ret, LinkData * data)
2645 gboolean success = TRUE;
2647 if (pad != data->orig) {
2648 success = gst_pad_set_caps (pad, data->caps);
2649 g_value_set_boolean (ret, success);
2651 gst_object_unref (pad);
2657 * gst_pad_proxy_setcaps
2658 * @pad: a #GstPad to proxy from
2659 * @caps: the #GstCaps to link with
2661 * Calls gst_pad_set_caps() for every other pad belonging to the
2662 * same element as @pad. If gst_pad_set_caps() fails on any pad,
2663 * the proxy setcaps fails. May be used only during negotiation.
2665 * Returns: TRUE if sucessful
2668 gst_pad_proxy_setcaps (GstPad * pad, GstCaps * caps)
2670 GstElement *element;
2672 GstIteratorResult res;
2673 GValue ret = { 0, };
2676 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2677 g_return_val_if_fail (caps != NULL, FALSE);
2679 GST_DEBUG ("proxying pad link for %s:%s", GST_DEBUG_PAD_NAME (pad));
2681 element = gst_pad_get_parent_element (pad);
2682 if (element == NULL)
2685 iter = gst_element_iterate_pads (element);
2687 g_value_init (&ret, G_TYPE_BOOLEAN);
2688 g_value_set_boolean (&ret, TRUE);
2692 res = gst_iterator_fold (iter, (GstIteratorFoldFunction) link_fold_func,
2694 gst_iterator_free (iter);
2696 if (res != GST_ITERATOR_DONE)
2699 gst_object_unref (element);
2701 /* ok not to unset the gvalue */
2702 return g_value_get_boolean (&ret);
2707 g_warning ("Pad list changed during proxy_pad_link for element %s",
2708 GST_ELEMENT_NAME (element));
2709 gst_object_unref (element);
2715 * gst_pad_query_position:
2716 * @pad: a #GstPad to invoke the position query on.
2717 * @format: a pointer to the #GstFormat asked for.
2718 * On return contains the #GstFormat used.
2719 * @cur: A location in which to store the current position, or NULL.
2721 * Queries a pad for the stream position.
2723 * Returns: TRUE if the query could be performed.
2726 gst_pad_query_position (GstPad * pad, GstFormat * format, gint64 * cur)
2731 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2732 g_return_val_if_fail (format != NULL, FALSE);
2734 query = gst_query_new_position (*format);
2735 ret = gst_pad_query (pad, query);
2738 gst_query_parse_position (query, format, cur);
2740 gst_query_unref (query);
2746 * gst_pad_query_peer_position:
2747 * @pad: a #GstPad on whose peer to invoke the position query on.
2748 * Must be a sink pad.
2749 * @format: a pointer to the #GstFormat asked for.
2750 * On return contains the #GstFormat used.
2751 * @cur: A location in which to store the current position, or NULL.
2753 * Queries the peer of a given sink pad for the stream position.
2755 * Returns: TRUE if the query could be performed.
2758 gst_pad_query_peer_position (GstPad * pad, GstFormat * format, gint64 * cur)
2760 gboolean ret = FALSE;
2763 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2764 g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2765 g_return_val_if_fail (format != NULL, FALSE);
2767 peer = gst_pad_get_peer (pad);
2769 ret = gst_pad_query_position (peer, format, cur);
2770 gst_object_unref (peer);
2777 * gst_pad_query_duration:
2778 * @pad: a #GstPad to invoke the duration query on.
2779 * @format: a pointer to the #GstFormat asked for.
2780 * On return contains the #GstFormat used.
2781 * @duration: A location in which to store the total duration, or NULL.
2783 * Queries a pad for the total stream duration.
2785 * Returns: TRUE if the query could be performed.
2788 gst_pad_query_duration (GstPad * pad, GstFormat * format, gint64 * duration)
2793 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2794 g_return_val_if_fail (format != NULL, FALSE);
2796 query = gst_query_new_duration (*format);
2797 ret = gst_pad_query (pad, query);
2800 gst_query_parse_duration (query, format, duration);
2802 gst_query_unref (query);
2808 * gst_pad_query_peer_duration:
2809 * @pad: a #GstPad on whose peer pad to invoke the duration query on.
2810 * Must be a sink pad.
2811 * @format: a pointer to the #GstFormat asked for.
2812 * On return contains the #GstFormat used.
2813 * @duration: A location in which to store the total duration, or NULL.
2815 * Queries the peer pad of a given sink pad for the total stream duration.
2817 * Returns: TRUE if the query could be performed.
2820 gst_pad_query_peer_duration (GstPad * pad, GstFormat * format,
2823 gboolean ret = FALSE;
2826 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2827 g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2828 g_return_val_if_fail (format != NULL, FALSE);
2830 peer = gst_pad_get_peer (pad);
2832 ret = gst_pad_query_duration (peer, format, duration);
2833 gst_object_unref (peer);
2840 * gst_pad_query_convert:
2841 * @pad: a #GstPad to invoke the convert query on.
2842 * @src_format: a #GstFormat to convert from.
2843 * @src_val: a value to convert.
2844 * @dest_format: a pointer to the #GstFormat to convert to.
2845 * @dest_val: a pointer to the result.
2847 * Queries a pad to convert @src_val in @src_format to @dest_format.
2849 * Returns: TRUE if the query could be performed.
2852 gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2853 GstFormat * dest_format, gint64 * dest_val)
2858 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2859 g_return_val_if_fail (dest_format != NULL, FALSE);
2860 g_return_val_if_fail (dest_val != NULL, FALSE);
2862 if (*dest_format == src_format) {
2863 *dest_val = src_val;
2867 query = gst_query_new_convert (src_format, src_val, *dest_format);
2868 ret = gst_pad_query (pad, query);
2871 gst_query_parse_convert (query, NULL, NULL, dest_format, dest_val);
2873 gst_query_unref (query);
2879 * gst_pad_query_peer_convert:
2880 * @pad: a #GstPad, on whose peer pad to invoke the convert query on.
2881 * Must be a sink pad.
2882 * @src_format: a #GstFormat to convert from.
2883 * @src_val: a value to convert.
2884 * @dest_format: a pointer to the #GstFormat to convert to.
2885 * @dest_val: a pointer to the result.
2887 * Queries the peer pad of a given sink pad to convert @src_val in @src_format
2890 * Returns: TRUE if the query could be performed.
2893 gst_pad_query_peer_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2894 GstFormat * dest_format, gint64 * dest_val)
2896 gboolean ret = FALSE;
2899 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2900 g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2901 g_return_val_if_fail (src_val >= 0, FALSE);
2902 g_return_val_if_fail (dest_format != NULL, FALSE);
2903 g_return_val_if_fail (dest_val != NULL, FALSE);
2905 peer = gst_pad_get_peer (pad);
2907 ret = gst_pad_query_convert (peer, src_format, src_val, dest_format,
2909 gst_object_unref (peer);
2916 * gst_atomic_int_set:
2917 * @atomic_int: pointer to an atomic integer
2918 * @value: value to set
2920 * Unconditionally sets the atomic integer to @value.
2922 * Deprecated: Use g_atomic_int_set().
2925 #ifndef GST_REMOVE_DEPRECATED
2927 gst_atomic_int_set (gint * atomic_int, gint value)
2929 g_atomic_int_set (atomic_int, value);
2934 * gst_pad_add_data_probe:
2935 * @pad: pad to add the data probe handler to
2936 * @handler: function to call when data is passed over pad
2937 * @data: data to pass along with the handler
2939 * Adds a "data probe" to a pad. This function will be called whenever data
2940 * passes through a pad. In this case data means both events and buffers. The
2941 * probe will be called with the data as an argument, meaning @handler should
2942 * have the same callback signature as the #GstPad::have-data signal.
2943 * Note that the data will have a reference count greater than 1, so it will
2944 * be immutable -- you must not change it.
2946 * For source pads, the probe will be called after the blocking function, if any
2947 * (see gst_pad_set_blocked_async()), but before looking up the peer to chain
2948 * to. For sink pads, the probe function will be called before configuring the
2949 * sink with new caps, if any, and before calling the pad's chain function.
2951 * Your data probe should return TRUE to let the data continue to flow, or FALSE
2952 * to drop it. Dropping data is rarely useful, but occasionally comes in handy
2955 * Although probes are implemented internally by connecting @handler to the
2956 * have-data signal on the pad, if you want to remove a probe it is insufficient
2957 * to only call g_signal_handler_disconnect on the returned handler id. To
2958 * remove a probe, use the appropriate function, such as
2959 * gst_pad_remove_data_probe().
2961 * Returns: The handler id.
2964 gst_pad_add_data_probe (GstPad * pad, GCallback handler, gpointer data)
2966 return gst_pad_add_data_probe_full (pad, handler, data, NULL);
2970 * gst_pad_add_data_probe_full:
2971 * @pad: pad to add the data probe handler to
2972 * @handler: function to call when data is passed over pad
2973 * @data: data to pass along with the handler
2974 * @notify: function to call when the probe is disconnected, or NULL
2976 * Adds a "data probe" to a pad. This function will be called whenever data
2977 * passes through a pad. In this case data means both events and buffers. The
2978 * probe will be called with the data as an argument, meaning @handler should
2979 * have the same callback signature as the #GstPad::have-data signal.
2980 * Note that the data will have a reference count greater than 1, so it will
2981 * be immutable -- you must not change it.
2983 * For source pads, the probe will be called after the blocking function, if any
2984 * (see gst_pad_set_blocked_async()), but before looking up the peer to chain
2985 * to. For sink pads, the probe function will be called before configuring the
2986 * sink with new caps, if any, and before calling the pad's chain function.
2988 * Your data probe should return TRUE to let the data continue to flow, or FALSE
2989 * to drop it. Dropping data is rarely useful, but occasionally comes in handy
2992 * Although probes are implemented internally by connecting @handler to the
2993 * have-data signal on the pad, if you want to remove a probe it is insufficient
2994 * to only call g_signal_handler_disconnect on the returned handler id. To
2995 * remove a probe, use the appropriate function, such as
2996 * gst_pad_remove_data_probe().
2998 * The @notify function is called when the probe is disconnected and usually
2999 * used to free @data.
3001 * Returns: The handler id.
3006 gst_pad_add_data_probe_full (GstPad * pad, GCallback handler,
3007 gpointer data, GDestroyNotify notify)
3011 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3012 g_return_val_if_fail (handler != NULL, 0);
3014 GST_OBJECT_LOCK (pad);
3016 /* we only expose a GDestroyNotify in our API because that's less confusing */
3017 sigid = g_signal_connect_data (pad, "have-data", handler, data,
3018 (GClosureNotify) notify, 0);
3020 GST_PAD_DO_EVENT_SIGNALS (pad)++;
3021 GST_PAD_DO_BUFFER_SIGNALS (pad)++;
3022 GST_DEBUG ("adding data probe to pad %s:%s, now %d data, %d event probes",
3023 GST_DEBUG_PAD_NAME (pad),
3024 GST_PAD_DO_BUFFER_SIGNALS (pad), GST_PAD_DO_EVENT_SIGNALS (pad));
3025 GST_OBJECT_UNLOCK (pad);
3031 * gst_pad_add_event_probe:
3032 * @pad: pad to add the event probe handler to
3033 * @handler: function to call when events are passed over pad
3034 * @data: data to pass along with the handler
3036 * Adds a probe that will be called for all events passing through a pad. See
3037 * gst_pad_add_data_probe() for more information.
3039 * Returns: The handler id
3042 gst_pad_add_event_probe (GstPad * pad, GCallback handler, gpointer data)
3044 return gst_pad_add_event_probe_full (pad, handler, data, NULL);
3048 * gst_pad_add_event_probe_full:
3049 * @pad: pad to add the event probe handler to
3050 * @handler: function to call when events are passed over pad
3051 * @data: data to pass along with the handler, or NULL
3052 * @notify: function to call when probe is disconnected, or NULL
3054 * Adds a probe that will be called for all events passing through a pad. See
3055 * gst_pad_add_data_probe() for more information.
3057 * The @notify function is called when the probe is disconnected and usually
3058 * used to free @data.
3060 * Returns: The handler id
3065 gst_pad_add_event_probe_full (GstPad * pad, GCallback handler,
3066 gpointer data, GDestroyNotify notify)
3070 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3071 g_return_val_if_fail (handler != NULL, 0);
3073 GST_OBJECT_LOCK (pad);
3075 /* we only expose a GDestroyNotify in our API because that's less confusing */
3076 sigid = g_signal_connect_data (pad, "have-data::event", handler, data,
3077 (GClosureNotify) notify, 0);
3079 GST_PAD_DO_EVENT_SIGNALS (pad)++;
3080 GST_DEBUG ("adding event probe to pad %s:%s, now %d probes",
3081 GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_EVENT_SIGNALS (pad));
3082 GST_OBJECT_UNLOCK (pad);
3088 * gst_pad_add_buffer_probe:
3089 * @pad: pad to add the buffer probe handler to
3090 * @handler: function to call when buffers are passed over pad
3091 * @data: data to pass along with the handler
3093 * Adds a probe that will be called for all buffers passing through a pad. See
3094 * gst_pad_add_data_probe() for more information.
3096 * Returns: The handler id
3099 gst_pad_add_buffer_probe (GstPad * pad, GCallback handler, gpointer data)
3101 return gst_pad_add_buffer_probe_full (pad, handler, data, NULL);
3105 * gst_pad_add_buffer_probe_full:
3106 * @pad: pad to add the buffer probe handler to
3107 * @handler: function to call when buffer are passed over pad
3108 * @data: data to pass along with the handler
3109 * @notify: function to call when the probe is disconnected, or NULL
3111 * Adds a probe that will be called for all buffers passing through a pad. See
3112 * gst_pad_add_data_probe() for more information.
3114 * The @notify function is called when the probe is disconnected and usually
3115 * used to free @data.
3117 * Returns: The handler id
3122 gst_pad_add_buffer_probe_full (GstPad * pad, GCallback handler,
3123 gpointer data, GDestroyNotify notify)
3127 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3128 g_return_val_if_fail (handler != NULL, 0);
3130 GST_OBJECT_LOCK (pad);
3132 /* we only expose a GDestroyNotify in our API because that's less confusing */
3133 sigid = g_signal_connect_data (pad, "have-data::buffer", handler, data,
3134 (GClosureNotify) notify, 0);
3136 GST_PAD_DO_BUFFER_SIGNALS (pad)++;
3137 GST_DEBUG ("adding buffer probe to pad %s:%s, now %d probes",
3138 GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_BUFFER_SIGNALS (pad));
3139 GST_OBJECT_UNLOCK (pad);
3145 * gst_pad_remove_data_probe:
3146 * @pad: pad to remove the data probe handler from
3147 * @handler_id: handler id returned from gst_pad_add_data_probe
3149 * Removes a data probe from @pad.
3152 gst_pad_remove_data_probe (GstPad * pad, guint handler_id)
3154 g_return_if_fail (GST_IS_PAD (pad));
3155 g_return_if_fail (handler_id > 0);
3157 GST_OBJECT_LOCK (pad);
3158 g_signal_handler_disconnect (pad, handler_id);
3159 GST_PAD_DO_BUFFER_SIGNALS (pad)--;
3160 GST_PAD_DO_EVENT_SIGNALS (pad)--;
3162 ("removed data probe from pad %s:%s, now %d event, %d buffer probes",
3163 GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_EVENT_SIGNALS (pad),
3164 GST_PAD_DO_BUFFER_SIGNALS (pad));
3165 GST_OBJECT_UNLOCK (pad);
3170 * gst_pad_remove_event_probe:
3171 * @pad: pad to remove the event probe handler from
3172 * @handler_id: handler id returned from gst_pad_add_event_probe
3174 * Removes an event probe from @pad.
3177 gst_pad_remove_event_probe (GstPad * pad, guint handler_id)
3179 g_return_if_fail (GST_IS_PAD (pad));
3180 g_return_if_fail (handler_id > 0);
3182 GST_OBJECT_LOCK (pad);
3183 g_signal_handler_disconnect (pad, handler_id);
3184 GST_PAD_DO_EVENT_SIGNALS (pad)--;
3185 GST_DEBUG ("removed event probe from pad %s:%s, now %d event probes",
3186 GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_EVENT_SIGNALS (pad));
3187 GST_OBJECT_UNLOCK (pad);
3191 * gst_pad_remove_buffer_probe:
3192 * @pad: pad to remove the buffer probe handler from
3193 * @handler_id: handler id returned from gst_pad_add_buffer_probe
3195 * Removes a buffer probe from @pad.
3198 gst_pad_remove_buffer_probe (GstPad * pad, guint handler_id)
3200 g_return_if_fail (GST_IS_PAD (pad));
3201 g_return_if_fail (handler_id > 0);
3203 GST_OBJECT_LOCK (pad);
3204 g_signal_handler_disconnect (pad, handler_id);
3205 GST_PAD_DO_BUFFER_SIGNALS (pad)--;
3206 GST_DEBUG ("removed buffer probe from pad %s:%s, now %d buffer probes",
3207 GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_BUFFER_SIGNALS (pad));
3208 GST_OBJECT_UNLOCK (pad);
3213 * gst_element_found_tags_for_pad:
3214 * @element: element for which to post taglist to bus.
3215 * @pad: pad on which to push tag-event.
3216 * @list: the taglist to post on the bus and create event from.
3218 * Posts a message to the bus that new tags were found and pushes the
3219 * tags as event. Takes ownership of the @list.
3221 * This is a utility method for elements. Applications should use the
3222 * #GstTagSetter interface.
3225 gst_element_found_tags_for_pad (GstElement * element,
3226 GstPad * pad, GstTagList * list)
3228 g_return_if_fail (element != NULL);
3229 g_return_if_fail (pad != NULL);
3230 g_return_if_fail (list != NULL);
3232 gst_pad_push_event (pad, gst_event_new_tag (gst_tag_list_copy (list)));
3233 /* FIXME 0.11: Set the pad as source to make it possible to detect for
3234 * which pad the tags are actually found.
3236 gst_element_post_message (element,
3237 gst_message_new_tag (GST_OBJECT (element), list));
3241 push_and_ref (GstPad * pad, GstEvent * event)
3243 gst_pad_push_event (pad, gst_event_ref (event));
3244 /* iterator refs pad, we unref when we are done with it */
3245 gst_object_unref (pad);
3249 * gst_element_found_tags:
3250 * @element: element for which we found the tags.
3251 * @list: list of tags.
3253 * Posts a message to the bus that new tags were found, and pushes an event
3254 * to all sourcepads. Takes ownership of the @list.
3256 * This is a utility method for elements. Applications should use the
3257 * #GstTagSetter interface.
3260 gst_element_found_tags (GstElement * element, GstTagList * list)
3265 g_return_if_fail (element != NULL);
3266 g_return_if_fail (list != NULL);
3268 iter = gst_element_iterate_src_pads (element);
3269 event = gst_event_new_tag (gst_tag_list_copy (list));
3270 gst_iterator_foreach (iter, (GFunc) push_and_ref, event);
3271 gst_iterator_free (iter);
3272 gst_event_unref (event);
3274 gst_element_post_message (element,
3275 gst_message_new_tag (GST_OBJECT (element), list));
3279 element_find_unlinked_pad (GstElement * element, GstPadDirection direction)
3282 GstPad *unlinked_pad = NULL;
3285 switch (direction) {
3287 iter = gst_element_iterate_src_pads (element);
3290 iter = gst_element_iterate_sink_pads (element);
3293 g_return_val_if_reached (NULL);
3300 switch (gst_iterator_next (iter, &pad)) {
3301 case GST_ITERATOR_OK:{
3304 GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
3305 GST_DEBUG_PAD_NAME (pad));
3307 peer = gst_pad_get_peer (GST_PAD (pad));
3311 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
3312 "found existing unlinked pad %s:%s",
3313 GST_DEBUG_PAD_NAME (unlinked_pad));
3315 gst_object_unref (pad);
3316 gst_object_unref (peer);
3320 case GST_ITERATOR_DONE:
3323 case GST_ITERATOR_RESYNC:
3324 gst_iterator_resync (iter);
3326 case GST_ITERATOR_ERROR:
3327 g_return_val_if_reached (NULL);
3332 gst_iterator_free (iter);
3334 return unlinked_pad;
3338 * gst_bin_find_unlinked_pad:
3339 * @bin: bin in which to look for elements with unlinked pads
3340 * @direction: whether to look for an unlinked source or sink pad
3342 * Recursively looks for elements with an unlinked pad of the given
3343 * direction within the specified bin and returns an unlinked pad
3344 * if one is found, or NULL otherwise. If a pad is found, the caller
3345 * owns a reference to it and should use gst_object_unref() on the
3346 * pad when it is not needed any longer.
3348 * Returns: unlinked pad of the given direction, or NULL.
3353 gst_bin_find_unlinked_pad (GstBin * bin, GstPadDirection direction)
3359 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3360 g_return_val_if_fail (direction != GST_PAD_UNKNOWN, NULL);
3363 iter = gst_bin_iterate_recurse (bin);
3367 switch (gst_iterator_next (iter, &element)) {
3368 case GST_ITERATOR_OK:
3369 pad = element_find_unlinked_pad (GST_ELEMENT (element), direction);
3370 gst_object_unref (element);
3374 case GST_ITERATOR_DONE:
3377 case GST_ITERATOR_RESYNC:
3378 gst_iterator_resync (iter);
3380 case GST_ITERATOR_ERROR:
3381 g_return_val_if_reached (NULL);
3386 gst_iterator_free (iter);
3392 * gst_bin_find_unconnected_pad:
3393 * @bin: bin in which to look for elements with unlinked pads
3394 * @direction: whether to look for an unlinked source or sink pad
3396 * Recursively looks for elements with an unlinked pad of the given
3397 * direction within the specified bin and returns an unlinked pad
3398 * if one is found, or NULL otherwise. If a pad is found, the caller
3399 * owns a reference to it and should use gst_object_unref() on the
3400 * pad when it is not needed any longer.
3402 * Returns: unlinked pad of the given direction, or NULL.
3406 * Deprecated: use gst_bin_find_unlinked_pad() instead.
3408 #ifndef GST_REMOVE_DEPRECATED
3410 gst_bin_find_unconnected_pad (GstBin * bin, GstPadDirection direction)
3412 return gst_bin_find_unlinked_pad (bin, direction);
3417 * gst_parse_bin_from_description:
3418 * @bin_description: command line describing the bin
3419 * @ghost_unlinked_pads: whether to automatically create ghost pads
3420 * for unlinked source or sink pads within the bin
3421 * @err: where to store the error message in case of an error, or NULL
3423 * This is a convenience wrapper around gst_parse_launch() to create a
3424 * #GstBin from a gst-launch-style pipeline description. See
3425 * gst_parse_launch() and the gst-launch man page for details about the
3426 * syntax. Ghost pads on the bin for unlinked source or sink pads
3427 * within the bin can automatically be created (but only a maximum of
3428 * one ghost pad for each direction will be created; if you expect
3429 * multiple unlinked source pads or multiple unlinked sink pads
3430 * and want them all ghosted, you will have to create the ghost pads
3433 * Returns: a newly-created bin, or NULL if an error occurred.
3438 gst_parse_bin_from_description (const gchar * bin_description,
3439 gboolean ghost_unlinked_pads, GError ** err)
3441 return gst_parse_bin_from_description_full (bin_description,
3442 ghost_unlinked_pads, NULL, 0, err);
3446 * gst_parse_bin_from_description_full:
3447 * @bin_description: command line describing the bin
3448 * @ghost_unlinked_pads: whether to automatically create ghost pads
3449 * for unlinked source or sink pads within the bin
3450 * @context: a parse context allocated with gst_parse_context_new(), or %NULL
3451 * @flags: parsing options, or #GST_PARSE_FLAG_NONE
3452 * @err: where to store the error message in case of an error, or NULL
3454 * This is a convenience wrapper around gst_parse_launch() to create a
3455 * #GstBin from a gst-launch-style pipeline description. See
3456 * gst_parse_launch() and the gst-launch man page for details about the
3457 * syntax. Ghost pads on the bin for unlinked source or sink pads
3458 * within the bin can automatically be created (but only a maximum of
3459 * one ghost pad for each direction will be created; if you expect
3460 * multiple unlinked source pads or multiple unlinked sink pads
3461 * and want them all ghosted, you will have to create the ghost pads
3464 * Returns: a newly-created bin, or NULL if an error occurred.
3469 gst_parse_bin_from_description_full (const gchar * bin_description,
3470 gboolean ghost_unlinked_pads, GstParseContext * context,
3471 GstParseFlags flags, GError ** err)
3473 #ifndef GST_DISABLE_PARSE
3478 g_return_val_if_fail (bin_description != NULL, NULL);
3479 g_return_val_if_fail (err == NULL || *err == NULL, NULL);
3481 GST_DEBUG ("Making bin from description '%s'", bin_description);
3483 /* parse the pipeline to a bin */
3484 desc = g_strdup_printf ("bin.( %s )", bin_description);
3485 bin = (GstBin *) gst_parse_launch_full (desc, context, flags, err);
3488 if (bin == NULL || (err && *err != NULL)) {
3490 gst_object_unref (bin);
3494 /* find pads and ghost them if necessary */
3495 if (ghost_unlinked_pads) {
3496 if ((pad = gst_bin_find_unlinked_pad (bin, GST_PAD_SRC))) {
3497 gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("src", pad));
3498 gst_object_unref (pad);
3500 if ((pad = gst_bin_find_unlinked_pad (bin, GST_PAD_SINK))) {
3501 gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("sink", pad));
3502 gst_object_unref (pad);
3506 return GST_ELEMENT (bin);
3510 GST_WARNING ("Disabled API called");
3512 msg = gst_error_get_message (GST_CORE_ERROR, GST_CORE_ERROR_DISABLED);
3513 g_set_error (err, GST_CORE_ERROR, GST_CORE_ERROR_DISABLED, "%s", msg);
3521 * gst_type_register_static_full:
3522 * @parent_type: The GType of the parent type the newly registered type will
3524 * @type_name: NULL-terminated string used as the name of the new type
3525 * @class_size: Size of the class structure.
3526 * @base_init: Location of the base initialization function (optional).
3527 * @base_finalize: Location of the base finalization function (optional).
3528 * @class_init: Location of the class initialization function for class types
3529 * Location of the default vtable inititalization function for interface
3531 * @class_finalize: Location of the class finalization function for class types.
3532 * Location of the default vtable finalization function for interface types.
3534 * @class_data: User-supplied data passed to the class init/finalize functions.
3535 * @instance_size: Size of the instance (object) structure (required for
3536 * instantiatable types only).
3537 * @n_preallocs: The number of pre-allocated (cached) instances to reserve
3538 * memory for (0 indicates no caching). Ignored on recent GLib's.
3539 * @instance_init: Location of the instance initialization function (optional,
3540 * for instantiatable types only).
3541 * @value_table: A GTypeValueTable function table for generic handling of
3542 * GValues of this type (usually only useful for fundamental types).
3543 * @flags: #GTypeFlags for this GType. E.g: G_TYPE_FLAG_ABSTRACT
3545 * Helper function which constructs a #GTypeInfo structure and registers a
3546 * GType, but which generates less linker overhead than a static const
3547 * #GTypeInfo structure. For further details of the parameters, please see
3548 * #GTypeInfo in the GLib documentation.
3550 * Registers type_name as the name of a new static type derived from
3551 * parent_type. The value of flags determines the nature (e.g. abstract or
3552 * not) of the type. It works by filling a GTypeInfo struct and calling
3553 * g_type_info_register_static().
3555 * Returns: A #GType for the newly-registered type.
3560 gst_type_register_static_full (GType parent_type,
3561 const gchar * type_name,
3563 GBaseInitFunc base_init,
3564 GBaseFinalizeFunc base_finalize,
3565 GClassInitFunc class_init,
3566 GClassFinalizeFunc class_finalize,
3567 gconstpointer class_data,
3568 guint instance_size,
3569 guint16 n_preallocs,
3570 GInstanceInitFunc instance_init,
3571 const GTypeValueTable * value_table, GTypeFlags flags)
3575 info.class_size = class_size;
3576 info.base_init = base_init;
3577 info.base_finalize = base_finalize;
3578 info.class_init = class_init;
3579 info.class_finalize = class_finalize;
3580 info.class_data = class_data;
3581 info.instance_size = instance_size;
3582 info.n_preallocs = n_preallocs;
3583 info.instance_init = instance_init;
3584 info.value_table = value_table;
3586 return g_type_register_static (parent_type, type_name, &info, flags);
3591 * gst_util_get_timestamp:
3593 * Get a timestamp as GstClockTime to be used for interval meassurements.
3594 * The timestamp should not be interpreted in any other way.
3596 * Returns: the timestamp
3601 gst_util_get_timestamp (void)
3603 #if defined (HAVE_POSIX_TIMERS) && defined(HAVE_MONOTONIC_CLOCK)
3604 struct timespec now;
3606 clock_gettime (CLOCK_MONOTONIC, &now);
3607 return GST_TIMESPEC_TO_TIME (now);
3611 g_get_current_time (&now);
3612 return GST_TIMEVAL_TO_TIME (now);