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
30 #include "gst_private.h"
34 #include "gstghostpad.h"
40 #include "gst-i18n-lib.h"
41 #include "glib-compat-private.h"
46 * @mem: a pointer to the memory to dump
47 * @size: the size of the memory block to dump
49 * Dumps the memory block into a hex representation. Useful for debugging.
52 gst_util_dump_mem (const guchar * mem, guint size)
55 GString *string = g_string_sized_new (50);
56 GString *chars = g_string_sized_new (18);
60 if (g_ascii_isprint (mem[i]))
61 g_string_append_c (chars, mem[i]);
63 g_string_append_c (chars, '.');
65 g_string_append_printf (string, "%02x ", mem[i]);
70 if (j == 16 || i == size) {
71 g_print ("%08x (%p): %-48.48s %-16.16s\n", i - j, mem + i - j,
72 string->str, chars->str);
73 g_string_set_size (string, 0);
74 g_string_set_size (chars, 0);
78 g_string_free (string, TRUE);
79 g_string_free (chars, TRUE);
84 * gst_util_set_value_from_string:
85 * @value: (out caller-allocates): the value to set
86 * @value_str: the string to get the value from
88 * Converts the string to the type of the value and
89 * sets the value with it.
91 * Note that this function is dangerous as it does not return any indication
92 * if the conversion worked or not.
95 gst_util_set_value_from_string (GValue * value, const gchar * value_str)
99 g_return_if_fail (value != NULL);
100 g_return_if_fail (value_str != NULL);
102 GST_CAT_DEBUG (GST_CAT_PARAMS, "parsing '%s' to type %s", value_str,
103 g_type_name (G_VALUE_TYPE (value)));
105 res = gst_value_deserialize (value, value_str);
106 if (!res && G_VALUE_TYPE (value) == G_TYPE_BOOLEAN) {
107 /* backwards compat, all booleans that fail to parse are false */
108 g_value_set_boolean (value, FALSE);
111 g_return_if_fail (res);
115 * gst_util_set_object_arg:
116 * @object: the object to set the argument of
117 * @name: the name of the argument to set
118 * @value: the string value to set
120 * Convertes the string value to the type of the objects argument and
121 * sets the argument with it.
123 * Note that this function silently returns if @object has no property named
124 * @name or when @value cannot be converted to the type of the property.
127 gst_util_set_object_arg (GObject * object, const gchar * name,
134 g_return_if_fail (G_IS_OBJECT (object));
135 g_return_if_fail (name != NULL);
136 g_return_if_fail (value != NULL);
138 pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), name);
142 value_type = pspec->value_type;
144 GST_DEBUG ("pspec->flags is %d, pspec->value_type is %s",
145 pspec->flags, g_type_name (value_type));
147 if (!(pspec->flags & G_PARAM_WRITABLE))
150 g_value_init (&v, value_type);
152 /* special case for element <-> xml (de)serialisation */
153 if (GST_VALUE_HOLDS_STRUCTURE (&v) && strcmp (value, "NULL") == 0) {
154 g_value_set_boxed (&v, NULL);
158 if (!gst_value_deserialize (&v, value))
163 g_object_set_property (object, pspec->name, &v);
167 /* work around error C2520: conversion from unsigned __int64 to double
168 * not implemented, use signed __int64
170 * These are implemented as functions because on some platforms a 64bit int to
171 * double conversion is not defined/implemented.
175 gst_util_guint64_to_gdouble (guint64 value)
177 if (value & G_GINT64_CONSTANT (0x8000000000000000))
178 return (gdouble) ((gint64) value) + (gdouble) 18446744073709551616.;
180 return (gdouble) ((gint64) value);
184 gst_util_gdouble_to_guint64 (gdouble value)
186 if (value < (gdouble) 9223372036854775808.) /* 1 << 63 */
187 return ((guint64) ((gint64) value));
189 value -= (gdouble) 18446744073709551616.;
190 return ((guint64) ((gint64) value));
193 #ifndef HAVE_UINT128_T
194 /* convenience struct for getting high and low uint32 parts of
201 #if G_BYTE_ORDER == G_BIG_ENDIAN
209 #if defined (__x86_64__) && defined (__GNUC__)
211 gst_util_uint64_mul_uint64 (GstUInt64 * c1, GstUInt64 * c0, guint64 arg1,
214 __asm__ __volatile__ ("mulq %3":"=a" (c0->ll), "=d" (c1->ll)
215 :"a" (arg1), "g" (arg2)
218 #else /* defined (__x86_64__) */
219 /* multiply two 64-bit unsigned ints into a 128-bit unsigned int. the high
220 * and low 64 bits of the product are placed in c1 and c0 respectively.
221 * this operation cannot overflow. */
223 gst_util_uint64_mul_uint64 (GstUInt64 * c1, GstUInt64 * c0, guint64 arg1,
233 /* do 128 bits multiply
241 * -------------------
244 * "a0" is optimized away, result is stored directly in c0. "b1" is
245 * optimized away, result is stored directly in c1.
247 c0->ll = (guint64) v.l.low * n.l.low;
248 a1.ll = (guint64) v.l.low * n.l.high;
249 b0.ll = (guint64) v.l.high * n.l.low;
251 /* add the high word of a0 to the low words of a1 and b0 using c1 as
252 * scrach space to capture the carry. the low word of the result becomes
253 * the final high word of c0 */
254 c1->ll = (guint64) c0->l.high + a1.l.low + b0.l.low;
255 c0->l.high = c1->l.low;
257 /* add the carry from the result above (found in the high word of c1) and
258 * the high words of a1 and b0 to b1, the result is c1. */
259 c1->ll = (guint64) v.l.high * n.l.high + c1->l.high + a1.l.high + b0.l.high;
261 #endif /* defined (__x86_64__) */
263 #if defined (__x86_64__) && defined (__GNUC__)
264 static inline guint64
265 gst_util_div128_64 (GstUInt64 c1, GstUInt64 c0, guint64 denom)
269 __asm__ __volatile__ ("divq %3":"=a" (res)
270 :"d" (c1.ll), "a" (c0.ll), "g" (denom)
276 /* count leading zeros */
278 gst_util_clz (guint32 val)
282 s = val | (val >> 1);
286 s = ~(s | (s >> 16));
287 s = s - ((s >> 1) & 0x55555555);
288 s = (s & 0x33333333) + ((s >> 2) & 0x33333333);
289 s = (s + (s >> 4)) & 0x0f0f0f0f;
291 s = (s + (s >> 16)) & 0x3f;
296 /* based on Hacker's Delight p152 */
297 static inline guint64
298 gst_util_div128_64 (GstUInt64 c1, GstUInt64 c0, guint64 denom)
300 GstUInt64 q1, q0, rhat;
301 GstUInt64 v, cmp1, cmp2;
306 /* count number of leading zeroes, we know they must be in the high
307 * part of denom since denom > G_MAXUINT32. */
308 s = gst_util_clz (v.l.high);
311 /* normalize divisor and dividend */
313 c1.ll = (c1.ll << s) | (c0.l.high >> (32 - s));
317 q1.ll = c1.ll / v.l.high;
318 rhat.ll = c1.ll - q1.ll * v.l.high;
320 cmp1.l.high = rhat.l.low;
321 cmp1.l.low = c0.l.high;
322 cmp2.ll = q1.ll * v.l.low;
324 while (q1.l.high || cmp2.ll > cmp1.ll) {
329 cmp1.l.high = rhat.l.low;
332 c1.l.high = c1.l.low;
333 c1.l.low = c0.l.high;
334 c1.ll -= q1.ll * v.ll;
335 q0.ll = c1.ll / v.l.high;
336 rhat.ll = c1.ll - q0.ll * v.l.high;
338 cmp1.l.high = rhat.l.low;
339 cmp1.l.low = c0.l.low;
340 cmp2.ll = q0.ll * v.l.low;
342 while (q0.l.high || cmp2.ll > cmp1.ll) {
347 cmp1.l.high = rhat.l.low;
350 q0.l.high += q1.l.low;
354 #endif /* defined (__GNUC__) */
356 /* This always gives the correct result because:
357 * a) val <= G_MAXUINT64-1
358 * b) (c0,c1) <= G_MAXUINT64 * (G_MAXUINT64-1)
360 * (c0,c1) == G_MAXUINT64 * G_MAXUINT64 and denom < G_MAXUINT64
361 * (note: num==denom case is handled by short path)
362 * This means that (c0,c1) either has enough space for val
363 * or that the overall result will overflow anyway.
366 /* add correction with carry */
367 #define CORRECT(c0,c1,val) \
369 if (G_MAXUINT64 - c0.ll < val) { \
370 if (G_UNLIKELY (c1.ll == G_MAXUINT64)) \
372 return G_MAXUINT64; \
379 gst_util_uint64_scale_uint64_unchecked (guint64 val, guint64 num,
380 guint64 denom, guint64 correct)
384 /* compute 128-bit numerator product */
385 gst_util_uint64_mul_uint64 (&c1, &c0, val, num);
387 /* perform rounding correction */
388 CORRECT (c0, c1, correct);
390 /* high word as big as or bigger than denom --> overflow */
391 if (G_UNLIKELY (c1.ll >= denom))
394 /* compute quotient, fits in 64 bits */
395 return gst_util_div128_64 (c1, c0, denom);
399 #define GST_MAXUINT128 ((__uint128_t) -1)
401 gst_util_uint64_scale_uint64_unchecked (guint64 val, guint64 num,
402 guint64 denom, guint64 correct)
406 /* Calculate val * num */
407 tmp = ((__uint128_t) val) * ((__uint128_t) num);
409 /* overflow checks */
410 if (G_UNLIKELY (GST_MAXUINT128 - correct < tmp))
413 /* perform rounding correction */
416 /* Divide by denom */
419 /* if larger than G_MAXUINT64 --> overflow */
420 if (G_UNLIKELY (tmp > G_MAXUINT64))
423 /* compute quotient, fits in 64 bits */
424 return (guint64) tmp;
429 #if !defined (__x86_64__) && !defined (HAVE_UINT128_T)
431 gst_util_uint64_mul_uint32 (GstUInt64 * c1, GstUInt64 * c0, guint64 arg1,
438 c0->ll = (guint64) a.l.low * arg2;
439 c1->ll = (guint64) a.l.high * arg2 + c0->l.high;
443 /* divide a 96-bit unsigned int by a 32-bit unsigned int when we know the
444 * quotient fits into 64 bits. the high 64 bits and low 32 bits of the
445 * numerator are expected in c1 and c0 respectively. */
446 static inline guint64
447 gst_util_div96_32 (guint64 c1, guint64 c0, guint32 denom)
449 c0 += (c1 % denom) << 32;
450 return ((c1 / denom) << 32) + (c0 / denom);
453 static inline guint64
454 gst_util_uint64_scale_uint32_unchecked (guint64 val, guint32 num,
455 guint32 denom, guint32 correct)
459 /* compute 96-bit numerator product */
460 gst_util_uint64_mul_uint32 (&c1, &c0, val, num);
462 /* condition numerator based on rounding mode */
463 CORRECT (c0, c1, correct);
465 /* high 32 bits as big as or bigger than denom --> overflow */
466 if (G_UNLIKELY (c1.l.high >= denom))
469 /* compute quotient, fits in 64 bits */
470 return gst_util_div96_32 (c1.ll, c0.ll, denom);
474 /* the guts of the gst_util_uint64_scale() variants */
476 _gst_util_uint64_scale (guint64 val, guint64 num, guint64 denom,
479 g_return_val_if_fail (denom != 0, G_MAXUINT64);
481 if (G_UNLIKELY (num == 0))
484 if (G_UNLIKELY (num == denom))
487 /* on 64bits we always use a full 128bits multiply/division */
488 #if !defined (__x86_64__) && !defined (HAVE_UINT128_T)
489 /* denom is low --> try to use 96 bit muldiv */
490 if (G_LIKELY (denom <= G_MAXUINT32)) {
491 /* num is low --> use 96 bit muldiv */
492 if (G_LIKELY (num <= G_MAXUINT32))
493 return gst_util_uint64_scale_uint32_unchecked (val, (guint32) num,
494 (guint32) denom, correct);
496 /* num is high but val is low --> swap and use 96-bit muldiv */
497 if (G_LIKELY (val <= G_MAXUINT32))
498 return gst_util_uint64_scale_uint32_unchecked (num, (guint32) val,
499 (guint32) denom, correct);
501 #endif /* !defined (__x86_64__) && !defined (HAVE_UINT128_T) */
503 /* val is high and num is high --> use 128-bit muldiv */
504 return gst_util_uint64_scale_uint64_unchecked (val, num, denom, correct);
508 * gst_util_uint64_scale:
509 * @val: the number to scale
510 * @num: the numerator of the scale ratio
511 * @denom: the denominator of the scale ratio
513 * Scale @val by the rational number @num / @denom, avoiding overflows and
514 * underflows and without loss of precision.
516 * This function can potentially be very slow if val and num are both
517 * greater than G_MAXUINT32.
519 * Returns: @val * @num / @denom. In the case of an overflow, this
520 * function returns G_MAXUINT64. If the result is not exactly
521 * representable as an integer it is truncated. See also
522 * gst_util_uint64_scale_round(), gst_util_uint64_scale_ceil(),
523 * gst_util_uint64_scale_int(), gst_util_uint64_scale_int_round(),
524 * gst_util_uint64_scale_int_ceil().
527 gst_util_uint64_scale (guint64 val, guint64 num, guint64 denom)
529 return _gst_util_uint64_scale (val, num, denom, 0);
533 * gst_util_uint64_scale_round:
534 * @val: the number to scale
535 * @num: the numerator of the scale ratio
536 * @denom: the denominator of the scale ratio
538 * Scale @val by the rational number @num / @denom, avoiding overflows and
539 * underflows and without loss of precision.
541 * This function can potentially be very slow if val and num are both
542 * greater than G_MAXUINT32.
544 * Returns: @val * @num / @denom. In the case of an overflow, this
545 * function returns G_MAXUINT64. If the result is not exactly
546 * representable as an integer, it is rounded to the nearest integer
547 * (half-way cases are rounded up). See also gst_util_uint64_scale(),
548 * gst_util_uint64_scale_ceil(), gst_util_uint64_scale_int(),
549 * gst_util_uint64_scale_int_round(), gst_util_uint64_scale_int_ceil().
552 gst_util_uint64_scale_round (guint64 val, guint64 num, guint64 denom)
554 return _gst_util_uint64_scale (val, num, denom, denom >> 1);
558 * gst_util_uint64_scale_ceil:
559 * @val: the number to scale
560 * @num: the numerator of the scale ratio
561 * @denom: the denominator of the scale ratio
563 * Scale @val by the rational number @num / @denom, avoiding overflows and
564 * underflows and without loss of precision.
566 * This function can potentially be very slow if val and num are both
567 * greater than G_MAXUINT32.
569 * Returns: @val * @num / @denom. In the case of an overflow, this
570 * function returns G_MAXUINT64. If the result is not exactly
571 * representable as an integer, it is rounded up. See also
572 * gst_util_uint64_scale(), gst_util_uint64_scale_round(),
573 * gst_util_uint64_scale_int(), gst_util_uint64_scale_int_round(),
574 * gst_util_uint64_scale_int_ceil().
577 gst_util_uint64_scale_ceil (guint64 val, guint64 num, guint64 denom)
579 return _gst_util_uint64_scale (val, num, denom, denom - 1);
582 /* the guts of the gst_util_uint64_scale_int() variants */
584 _gst_util_uint64_scale_int (guint64 val, gint num, gint denom, gint correct)
586 g_return_val_if_fail (denom > 0, G_MAXUINT64);
587 g_return_val_if_fail (num >= 0, G_MAXUINT64);
589 if (G_UNLIKELY (num == 0))
592 if (G_UNLIKELY (num == denom))
595 if (val <= G_MAXUINT32) {
596 /* simple case. num and denom are not negative so casts are OK. when
597 * not truncating, the additions to the numerator cannot overflow
598 * because val*num <= G_MAXUINT32 * G_MAXINT32 < G_MAXUINT64 -
599 * G_MAXINT32, so there's room to add another gint32. */
600 val *= (guint64) num;
601 /* add rounding correction */
604 return val / (guint64) denom;
606 #if !defined (__x86_64__) && !defined (HAVE_UINT128_T)
607 /* num and denom are not negative so casts are OK */
608 return gst_util_uint64_scale_uint32_unchecked (val, (guint32) num,
609 (guint32) denom, (guint32) correct);
611 /* always use full 128bits scale */
612 return gst_util_uint64_scale_uint64_unchecked (val, num, denom, correct);
617 * gst_util_uint64_scale_int:
618 * @val: guint64 (such as a #GstClockTime) to scale.
619 * @num: numerator of the scale factor.
620 * @denom: denominator of the scale factor.
622 * Scale @val by the rational number @num / @denom, avoiding overflows and
623 * underflows and without loss of precision. @num must be non-negative and
624 * @denom must be positive.
626 * Returns: @val * @num / @denom. In the case of an overflow, this
627 * function returns G_MAXUINT64. If the result is not exactly
628 * representable as an integer, it is truncated. See also
629 * gst_util_uint64_scale_int_round(), gst_util_uint64_scale_int_ceil(),
630 * gst_util_uint64_scale(), gst_util_uint64_scale_round(),
631 * gst_util_uint64_scale_ceil().
634 gst_util_uint64_scale_int (guint64 val, gint num, gint denom)
636 return _gst_util_uint64_scale_int (val, num, denom, 0);
640 * gst_util_uint64_scale_int_round:
641 * @val: guint64 (such as a #GstClockTime) to scale.
642 * @num: numerator of the scale factor.
643 * @denom: denominator of the scale factor.
645 * Scale @val by the rational number @num / @denom, avoiding overflows and
646 * underflows and without loss of precision. @num must be non-negative and
647 * @denom must be positive.
649 * Returns: @val * @num / @denom. In the case of an overflow, this
650 * function returns G_MAXUINT64. If the result is not exactly
651 * representable as an integer, it is rounded to the nearest integer
652 * (half-way cases are rounded up). See also gst_util_uint64_scale_int(),
653 * gst_util_uint64_scale_int_ceil(), gst_util_uint64_scale(),
654 * gst_util_uint64_scale_round(), gst_util_uint64_scale_ceil().
657 gst_util_uint64_scale_int_round (guint64 val, gint num, gint denom)
659 /* we can use a shift to divide by 2 because denom is required to be
661 return _gst_util_uint64_scale_int (val, num, denom, denom >> 1);
665 * gst_util_uint64_scale_int_ceil:
666 * @val: guint64 (such as a #GstClockTime) to scale.
667 * @num: numerator of the scale factor.
668 * @denom: denominator of the scale factor.
670 * Scale @val by the rational number @num / @denom, avoiding overflows and
671 * underflows and without loss of precision. @num must be non-negative and
672 * @denom must be positive.
674 * Returns: @val * @num / @denom. In the case of an overflow, this
675 * function returns G_MAXUINT64. If the result is not exactly
676 * representable as an integer, it is rounded up. See also
677 * gst_util_uint64_scale_int(), gst_util_uint64_scale_int_round(),
678 * gst_util_uint64_scale(), gst_util_uint64_scale_round(),
679 * gst_util_uint64_scale_ceil().
682 gst_util_uint64_scale_int_ceil (guint64 val, gint num, gint denom)
684 return _gst_util_uint64_scale_int (val, num, denom, denom - 1);
688 * gst_util_seqnum_next:
690 * Return a constantly incrementing sequence number.
692 * This function is used internally to GStreamer to be able to determine which
693 * events and messages are "the same". For example, elements may set the seqnum
694 * on a segment-done message to be the same as that of the last seek event, to
695 * indicate that event and the message correspond to the same segment.
697 * Returns: A constantly incrementing 32-bit unsigned integer, which might
698 * overflow back to 0 at some point. Use gst_util_seqnum_compare() to make sure
699 * you handle wraparound correctly.
704 gst_util_seqnum_next (void)
706 static gint counter = 0;
707 return G_ATOMIC_INT_ADD (&counter, 1);
711 * gst_util_seqnum_compare:
712 * @s1: A sequence number.
713 * @s2: Another sequence number.
715 * Compare two sequence numbers, handling wraparound.
717 * The current implementation just returns (gint32)(@s1 - @s2).
719 * Returns: A negative number if @s1 is before @s2, 0 if they are equal, or a
720 * positive number if @s1 is after @s2.
725 gst_util_seqnum_compare (guint32 s1, guint32 s2)
727 return (gint32) (s1 - s2);
730 /* -----------------------------------------------------
732 * The following code will be moved out of the main
733 * gstreamer library someday.
739 string_append_indent (GString * str, gint count)
743 for (xx = 0; xx < count; xx++)
744 g_string_append_c (str, ' ');
748 * gst_print_pad_caps:
749 * @buf: the buffer to print the caps in
750 * @indent: initial indentation
751 * @pad: (transfer none): the pad to print the caps from
753 * Write the pad capabilities in a human readable format into
757 gst_print_pad_caps (GString * buf, gint indent, GstPad * pad)
761 caps = gst_pad_get_current_caps (pad);
764 string_append_indent (buf, indent);
765 g_string_printf (buf, "%s:%s has no capabilities",
766 GST_DEBUG_PAD_NAME (pad));
770 s = gst_caps_to_string (caps);
771 g_string_append (buf, s);
774 gst_caps_unref (caps);
779 * gst_print_element_args:
780 * @buf: the buffer to print the args in
781 * @indent: initial indentation
782 * @element: (transfer none): the element to print the args of
784 * Print the element argument in a human readable format in the given
788 gst_print_element_args (GString * buf, gint indent, GstElement * element)
791 GValue value = { 0, }; /* the important thing is that value.type = 0 */
793 GParamSpec *spec, **specs, **walk;
795 specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (element), NULL);
798 for (walk = specs; *walk; walk++) {
800 if (width < strlen (spec->name))
801 width = strlen (spec->name);
804 for (walk = specs; *walk; walk++) {
807 if (spec->flags & G_PARAM_READABLE) {
808 g_value_init (&value, spec->value_type);
809 g_object_get_property (G_OBJECT (element), spec->name, &value);
810 str = g_strdup_value_contents (&value);
811 g_value_unset (&value);
813 str = g_strdup ("Parameter not readable.");
816 string_append_indent (buf, indent);
817 g_string_append (buf, spec->name);
818 string_append_indent (buf, 2 + width - strlen (spec->name));
819 g_string_append (buf, str);
820 g_string_append_c (buf, '\n');
829 * gst_element_create_all_pads:
830 * @element: (transfer none): a #GstElement to create pads for
832 * Creates a pad for each pad template that is always available.
833 * This function is only useful during object initialization of
834 * subclasses of #GstElement.
837 gst_element_create_all_pads (GstElement * element)
841 /* FIXME: lock element */
844 gst_element_class_get_pad_template_list (GST_ELEMENT_CLASS
845 (G_OBJECT_GET_CLASS (element)));
848 GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
850 if (padtempl->presence == GST_PAD_ALWAYS) {
853 pad = gst_pad_new_from_template (padtempl, padtempl->name_template);
855 gst_element_add_pad (element, pad);
857 padlist = padlist->next;
862 * gst_element_get_compatible_pad_template:
863 * @element: (transfer none): a #GstElement to get a compatible pad template for
864 * @compattempl: (transfer none): the #GstPadTemplate to find a compatible
867 * Retrieves a pad template from @element that is compatible with @compattempl.
868 * Pads from compatible templates can be linked together.
870 * Returns: (transfer none): a compatible #GstPadTemplate, or NULL if none
871 * was found. No unreferencing is necessary.
874 gst_element_get_compatible_pad_template (GstElement * element,
875 GstPadTemplate * compattempl)
877 GstPadTemplate *newtempl = NULL;
879 GstElementClass *class;
882 g_return_val_if_fail (element != NULL, NULL);
883 g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
884 g_return_val_if_fail (compattempl != NULL, NULL);
886 class = GST_ELEMENT_GET_CLASS (element);
888 padlist = gst_element_class_get_pad_template_list (class);
890 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
891 "Looking for a suitable pad template in %s out of %d templates...",
892 GST_ELEMENT_NAME (element), g_list_length (padlist));
895 GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
899 * Check direction (must be opposite)
902 GST_CAT_LOG (GST_CAT_CAPS,
903 "checking pad template %s", padtempl->name_template);
904 if (padtempl->direction != compattempl->direction) {
905 GST_CAT_DEBUG (GST_CAT_CAPS,
906 "compatible direction: found %s pad template \"%s\"",
907 padtempl->direction == GST_PAD_SRC ? "src" : "sink",
908 padtempl->name_template);
910 GST_CAT_DEBUG (GST_CAT_CAPS,
911 "intersecting %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (compattempl));
912 GST_CAT_DEBUG (GST_CAT_CAPS,
913 "..and %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (padtempl));
915 compatible = gst_caps_can_intersect (GST_PAD_TEMPLATE_CAPS (compattempl),
916 GST_PAD_TEMPLATE_CAPS (padtempl));
918 GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
919 (compatible ? "" : "not "));
927 padlist = g_list_next (padlist);
930 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
931 "Returning new pad template %p", newtempl);
933 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "No compatible pad template found");
939 * gst_element_get_pad_from_template:
940 * @element: (transfer none): a #GstElement.
941 * @templ: (transfer none): a #GstPadTemplate belonging to @element.
943 * Gets a pad from @element described by @templ. If the presence of @templ is
944 * #GST_PAD_REQUEST, requests a new pad. Can return %NULL for #GST_PAD_SOMETIMES
947 * Returns: (transfer full): the #GstPad, or NULL if one could not be found
951 gst_element_get_pad_from_template (GstElement * element, GstPadTemplate * templ)
954 GstPadPresence presence;
956 /* If this function is ever exported, we need check the validity of `element'
957 * and `templ', and to make sure the template actually belongs to the
960 presence = GST_PAD_TEMPLATE_PRESENCE (templ);
964 case GST_PAD_SOMETIMES:
965 ret = gst_element_get_static_pad (element, templ->name_template);
966 if (!ret && presence == GST_PAD_ALWAYS)
968 ("Element %s has an ALWAYS template %s, but no pad of the same name",
969 GST_OBJECT_NAME (element), templ->name_template);
972 case GST_PAD_REQUEST:
973 ret = gst_element_request_pad (element, templ, NULL, NULL);
981 * gst_element_request_compatible_pad:
982 * @element: a #GstElement.
983 * @templ: the #GstPadTemplate to which the new pad should be able to link.
985 * Requests a pad from @element. The returned pad should be unlinked and
986 * compatible with @templ. Might return an existing pad, or request a new one.
988 * Returns: a #GstPad, or %NULL if one could not be found or created.
991 gst_element_request_compatible_pad (GstElement * element,
992 GstPadTemplate * templ)
994 GstPadTemplate *templ_new;
997 g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
998 g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
1000 /* FIXME: should really loop through the templates, testing each for
1001 * compatibility and pad availability. */
1002 templ_new = gst_element_get_compatible_pad_template (element, templ);
1004 pad = gst_element_get_pad_from_template (element, templ_new);
1006 /* This can happen for non-request pads. No need to unref. */
1007 if (pad && GST_PAD_PEER (pad))
1014 * Checks if the source pad and the sink pad can be linked.
1015 * Both @srcpad and @sinkpad must be unlinked and have a parent.
1018 gst_pad_check_link (GstPad * srcpad, GstPad * sinkpad)
1020 /* FIXME This function is gross. It's almost a direct copy of
1021 * gst_pad_link_filtered(). Any decent programmer would attempt
1022 * to merge the two functions, which I will do some day. --ds
1025 /* generic checks */
1026 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1027 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1029 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
1030 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1032 /* FIXME: shouldn't we convert this to g_return_val_if_fail? */
1033 if (GST_PAD_PEER (srcpad) != NULL) {
1034 GST_CAT_INFO (GST_CAT_PADS, "Source pad %s:%s has a peer, failed",
1035 GST_DEBUG_PAD_NAME (srcpad));
1038 if (GST_PAD_PEER (sinkpad) != NULL) {
1039 GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has a peer, failed",
1040 GST_DEBUG_PAD_NAME (sinkpad));
1043 if (!GST_PAD_IS_SRC (srcpad)) {
1044 GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s is not source pad, failed",
1045 GST_DEBUG_PAD_NAME (srcpad));
1048 if (!GST_PAD_IS_SINK (sinkpad)) {
1049 GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s is not sink pad, failed",
1050 GST_DEBUG_PAD_NAME (sinkpad));
1053 if (GST_PAD_PARENT (srcpad) == NULL) {
1054 GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s has no parent, failed",
1055 GST_DEBUG_PAD_NAME (srcpad));
1058 if (GST_PAD_PARENT (sinkpad) == NULL) {
1059 GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has no parent, failed",
1060 GST_DEBUG_PAD_NAME (srcpad));
1068 * gst_element_get_compatible_pad:
1069 * @element: (transfer none): a #GstElement in which the pad should be found.
1070 * @pad: (transfer none): the #GstPad to find a compatible one for.
1071 * @caps: the #GstCaps to use as a filter.
1073 * Looks for an unlinked pad to which the given pad can link. It is not
1074 * guaranteed that linking the pads will work, though it should work in most
1077 * This function will first attempt to find a compatible unlinked ALWAYS pad,
1078 * and if none can be found, it will request a compatible REQUEST pad by looking
1079 * at the templates of @element.
1081 * Returns: (transfer full): the #GstPad to which a link can be made, or %NULL
1082 * if one cannot be found. gst_object_unref() after usage.
1085 gst_element_get_compatible_pad (GstElement * element, GstPad * pad,
1086 const GstCaps * caps)
1089 GstPadTemplate *templ;
1091 GstPad *foundpad = NULL;
1093 GValue padptr = { 0, };
1095 g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
1096 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1098 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1099 "finding pad in %s compatible with %s:%s",
1100 GST_ELEMENT_NAME (element), GST_DEBUG_PAD_NAME (pad));
1102 g_return_val_if_fail (GST_PAD_PEER (pad) == NULL, NULL);
1106 /* try to get an existing unlinked pad */
1107 if (GST_PAD_IS_SRC (pad)) {
1108 pads = gst_element_iterate_sink_pads (element);
1109 } else if (GST_PAD_IS_SINK (pad)) {
1110 pads = gst_element_iterate_src_pads (element);
1112 pads = gst_element_iterate_pads (element);
1116 switch (gst_iterator_next (pads, &padptr)) {
1117 case GST_ITERATOR_OK:
1124 current = g_value_get_object (&padptr);
1126 GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
1127 GST_DEBUG_PAD_NAME (current));
1129 if (GST_PAD_IS_SRC (current)) {
1136 peer = gst_pad_get_peer (current);
1138 if (peer == NULL && gst_pad_check_link (srcpad, sinkpad)) {
1139 GstCaps *temp, *intersection;
1140 gboolean compatible;
1142 /* Now check if the two pads' caps are compatible */
1143 temp = gst_pad_query_caps (pad, NULL);
1145 intersection = gst_caps_intersect (temp, caps);
1146 gst_caps_unref (temp);
1148 intersection = temp;
1151 temp = gst_pad_query_caps (current, NULL);
1152 compatible = gst_caps_can_intersect (temp, intersection);
1153 gst_caps_unref (temp);
1154 gst_caps_unref (intersection);
1157 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1158 "found existing unlinked compatible pad %s:%s",
1159 GST_DEBUG_PAD_NAME (current));
1160 gst_iterator_free (pads);
1162 current = gst_object_ref (current);
1163 g_value_unset (&padptr);
1167 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "incompatible pads");
1170 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1171 "already linked or cannot be linked (peer = %p)", peer);
1173 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unreffing pads");
1175 g_value_reset (&padptr);
1177 gst_object_unref (peer);
1180 case GST_ITERATOR_DONE:
1183 case GST_ITERATOR_RESYNC:
1184 gst_iterator_resync (pads);
1186 case GST_ITERATOR_ERROR:
1187 g_assert_not_reached ();
1191 g_value_unset (&padptr);
1192 gst_iterator_free (pads);
1194 GST_CAT_DEBUG_OBJECT (GST_CAT_ELEMENT_PADS, element,
1195 "Could not find a compatible unlinked always pad to link to %s:%s, now checking request pads",
1196 GST_DEBUG_PAD_NAME (pad));
1198 /* try to create a new one */
1199 /* requesting is a little crazy, we need a template. Let's create one */
1200 /* FIXME: why not gst_pad_get_pad_template (pad); */
1201 templcaps = gst_pad_query_caps (pad, NULL);
1202 templ = gst_pad_template_new ((gchar *) GST_PAD_NAME (pad),
1203 GST_PAD_DIRECTION (pad), GST_PAD_ALWAYS, templcaps);
1204 gst_caps_unref (templcaps);
1206 foundpad = gst_element_request_compatible_pad (element, templ);
1207 gst_object_unref (templ);
1210 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1211 "found existing request pad %s:%s", GST_DEBUG_PAD_NAME (foundpad));
1215 GST_CAT_INFO_OBJECT (GST_CAT_ELEMENT_PADS, element,
1216 "Could not find a compatible pad to link to %s:%s",
1217 GST_DEBUG_PAD_NAME (pad));
1222 * gst_element_state_get_name:
1223 * @state: a #GstState to get the name of.
1225 * Gets a string representing the given state.
1227 * Returns: (transfer none): a string with the name of the state.
1230 gst_element_state_get_name (GstState state)
1233 case GST_STATE_VOID_PENDING:
1234 return "VOID_PENDING";
1235 case GST_STATE_NULL:
1237 case GST_STATE_READY:
1239 case GST_STATE_PLAYING:
1241 case GST_STATE_PAUSED:
1244 /* This is a memory leak */
1245 return g_strdup_printf ("UNKNOWN!(%d)", state);
1250 * gst_element_state_change_return_get_name:
1251 * @state_ret: a #GstStateChangeReturn to get the name of.
1253 * Gets a string representing the given state change result.
1255 * Returns: (transfer none): a string with the name of the state
1261 gst_element_state_change_return_get_name (GstStateChangeReturn state_ret)
1263 switch (state_ret) {
1264 case GST_STATE_CHANGE_FAILURE:
1266 case GST_STATE_CHANGE_SUCCESS:
1268 case GST_STATE_CHANGE_ASYNC:
1270 case GST_STATE_CHANGE_NO_PREROLL:
1271 return "NO PREROLL";
1273 /* This is a memory leak */
1274 return g_strdup_printf ("UNKNOWN!(%d)", state_ret);
1280 gst_element_factory_can_accept_all_caps_in_direction (GstElementFactory *
1281 factory, const GstCaps * caps, GstPadDirection direction)
1285 g_return_val_if_fail (factory != NULL, FALSE);
1286 g_return_val_if_fail (caps != NULL, FALSE);
1288 templates = factory->staticpadtemplates;
1291 GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1293 if (template->direction == direction) {
1294 GstCaps *templcaps = gst_static_caps_get (&template->static_caps);
1296 if (gst_caps_is_always_compatible (caps, templcaps)) {
1297 gst_caps_unref (templcaps);
1300 gst_caps_unref (templcaps);
1302 templates = g_list_next (templates);
1309 gst_element_factory_can_accept_any_caps_in_direction (GstElementFactory *
1310 factory, const GstCaps * caps, GstPadDirection direction)
1314 g_return_val_if_fail (factory != NULL, FALSE);
1315 g_return_val_if_fail (caps != NULL, FALSE);
1317 templates = factory->staticpadtemplates;
1320 GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1322 if (template->direction == direction) {
1323 GstCaps *templcaps = gst_static_caps_get (&template->static_caps);
1325 if (gst_caps_can_intersect (caps, templcaps)) {
1326 gst_caps_unref (templcaps);
1329 gst_caps_unref (templcaps);
1331 templates = g_list_next (templates);
1338 * gst_element_factory_can_sink_all_caps:
1339 * @factory: factory to query
1340 * @caps: the caps to check
1342 * Checks if the factory can sink all possible capabilities.
1344 * Returns: %TRUE if the caps are fully compatible.
1349 gst_element_factory_can_sink_all_caps (GstElementFactory * factory,
1350 const GstCaps * caps)
1352 return gst_element_factory_can_accept_all_caps_in_direction (factory, caps,
1357 * gst_element_factory_can_src_all_caps:
1358 * @factory: factory to query
1359 * @caps: the caps to check
1361 * Checks if the factory can src all possible capabilities.
1363 * Returns: %TRUE if the caps are fully compatible.
1368 gst_element_factory_can_src_all_caps (GstElementFactory * factory,
1369 const GstCaps * caps)
1371 return gst_element_factory_can_accept_all_caps_in_direction (factory, caps,
1376 * gst_element_factory_can_sink_any_caps:
1377 * @factory: factory to query
1378 * @caps: the caps to check
1380 * Checks if the factory can sink any possible capability.
1382 * Returns: %TRUE if the caps have a common subset.
1387 gst_element_factory_can_sink_any_caps (GstElementFactory * factory,
1388 const GstCaps * caps)
1390 return gst_element_factory_can_accept_any_caps_in_direction (factory, caps,
1395 * gst_element_factory_can_src_any_caps:
1396 * @factory: factory to query
1397 * @caps: the caps to check
1399 * Checks if the factory can src any possible capability.
1401 * Returns: %TRUE if the caps have a common subset.
1406 gst_element_factory_can_src_any_caps (GstElementFactory * factory,
1407 const GstCaps * caps)
1409 return gst_element_factory_can_accept_any_caps_in_direction (factory, caps,
1413 /* if return val is true, *direct_child is a caller-owned ref on the direct
1414 * child of ancestor that is part of object's ancestry */
1416 object_has_ancestor (GstObject * object, GstObject * ancestor,
1417 GstObject ** direct_child)
1419 GstObject *child, *parent;
1422 *direct_child = NULL;
1424 child = gst_object_ref (object);
1425 parent = gst_object_get_parent (object);
1428 if (ancestor == parent) {
1430 *direct_child = child;
1432 gst_object_unref (child);
1433 gst_object_unref (parent);
1437 gst_object_unref (child);
1439 parent = gst_object_get_parent (parent);
1442 gst_object_unref (child);
1447 /* caller owns return */
1449 find_common_root (GstObject * o1, GstObject * o2)
1451 GstObject *top = o1;
1452 GstObject *kid1, *kid2;
1453 GstObject *root = NULL;
1455 while (GST_OBJECT_PARENT (top))
1456 top = GST_OBJECT_PARENT (top);
1458 /* the itsy-bitsy spider... */
1460 if (!object_has_ancestor (o2, top, &kid2))
1463 root = gst_object_ref (top);
1465 if (!object_has_ancestor (o1, kid2, &kid1)) {
1466 gst_object_unref (kid2);
1470 if (!object_has_ancestor (o2, kid1, &kid2)) {
1471 gst_object_unref (kid1);
1478 /* caller does not own return */
1480 ghost_up (GstElement * e, GstPad * pad)
1482 static gint ghost_pad_index = 0;
1487 GstObject *parent = GST_OBJECT_PARENT (e);
1489 name = g_strdup_printf ("ghost%d", ghost_pad_index++);
1490 gpad = gst_ghost_pad_new (name, pad);
1494 gst_element_get_state (e, ¤t, &next, 0);
1496 if (current > GST_STATE_READY || next == GST_STATE_PAUSED)
1497 gst_pad_set_active (gpad, TRUE);
1499 if (!gst_element_add_pad ((GstElement *) parent, gpad)) {
1500 g_warning ("Pad named %s already exists in element %s\n",
1501 GST_OBJECT_NAME (gpad), GST_OBJECT_NAME (parent));
1502 gst_object_unref ((GstObject *) gpad);
1503 GST_STATE_UNLOCK (e);
1506 GST_STATE_UNLOCK (e);
1512 remove_pad (gpointer ppad, gpointer unused)
1516 if (!gst_element_remove_pad ((GstElement *) GST_OBJECT_PARENT (pad), pad))
1517 g_warning ("Couldn't remove pad %s from element %s",
1518 GST_OBJECT_NAME (pad), GST_OBJECT_NAME (GST_OBJECT_PARENT (pad)));
1522 prepare_link_maybe_ghosting (GstPad ** src, GstPad ** sink,
1523 GSList ** pads_created)
1527 GSList *pads_created_local = NULL;
1529 g_assert (pads_created);
1531 e1 = GST_OBJECT_PARENT (*src);
1532 e2 = GST_OBJECT_PARENT (*sink);
1534 if (G_UNLIKELY (e1 == NULL)) {
1535 GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1536 GST_PTR_FORMAT, *src);
1539 if (G_UNLIKELY (e2 == NULL)) {
1540 GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1541 GST_PTR_FORMAT, *sink);
1545 if (GST_OBJECT_PARENT (e1) == GST_OBJECT_PARENT (e2)) {
1546 GST_CAT_INFO (GST_CAT_PADS, "%s and %s in same bin, no need for ghost pads",
1547 GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1551 GST_CAT_INFO (GST_CAT_PADS, "%s and %s not in same bin, making ghost pads",
1552 GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1554 /* we need to setup some ghost pads */
1555 root = find_common_root (e1, e2);
1557 g_warning ("Trying to connect elements that don't share a common "
1558 "ancestor: %s and %s", GST_ELEMENT_NAME (e1), GST_ELEMENT_NAME (e2));
1562 while (GST_OBJECT_PARENT (e1) != root) {
1563 *src = ghost_up ((GstElement *) e1, *src);
1566 e1 = GST_OBJECT_PARENT (*src);
1567 pads_created_local = g_slist_prepend (pads_created_local, *src);
1569 while (GST_OBJECT_PARENT (e2) != root) {
1570 *sink = ghost_up ((GstElement *) e2, *sink);
1573 e2 = GST_OBJECT_PARENT (*sink);
1574 pads_created_local = g_slist_prepend (pads_created_local, *sink);
1577 gst_object_unref (root);
1578 *pads_created = g_slist_concat (*pads_created, pads_created_local);
1582 gst_object_unref (root);
1583 g_slist_foreach (pads_created_local, remove_pad, NULL);
1584 g_slist_free (pads_created_local);
1589 pad_link_maybe_ghosting (GstPad * src, GstPad * sink, GstPadLinkCheck flags)
1591 GSList *pads_created = NULL;
1594 if (!prepare_link_maybe_ghosting (&src, &sink, &pads_created)) {
1597 ret = (gst_pad_link_full (src, sink, flags) == GST_PAD_LINK_OK);
1601 g_slist_foreach (pads_created, remove_pad, NULL);
1603 g_slist_free (pads_created);
1609 * gst_element_link_pads_full:
1610 * @src: a #GstElement containing the source pad.
1611 * @srcpadname: (allow-none): the name of the #GstPad in source element
1612 * or NULL for any pad.
1613 * @dest: (transfer none): the #GstElement containing the destination pad.
1614 * @destpadname: (allow-none): the name of the #GstPad in destination element,
1615 * or NULL for any pad.
1616 * @flags: the #GstPadLinkCheck to be performed when linking pads.
1618 * Links the two named pads of the source and destination elements.
1619 * Side effect is that if one of the pads has no parent, it becomes a
1620 * child of the parent of the other element. If they have different
1621 * parents, the link fails.
1623 * Calling gst_element_link_pads_full() with @flags == %GST_PAD_LINK_CHECK_DEFAULT
1624 * is the same as calling gst_element_link_pads() and the recommended way of
1625 * linking pads with safety checks applied.
1627 * This is a convenience function for gst_pad_link_full().
1629 * Returns: TRUE if the pads could be linked, FALSE otherwise.
1634 gst_element_link_pads_full (GstElement * src, const gchar * srcpadname,
1635 GstElement * dest, const gchar * destpadname, GstPadLinkCheck flags)
1637 const GList *srcpads, *destpads, *srctempls, *desttempls, *l;
1638 GstPad *srcpad, *destpad;
1639 GstPadTemplate *srctempl, *desttempl;
1640 GstElementClass *srcclass, *destclass;
1643 g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1644 g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1646 GST_CAT_INFO (GST_CAT_ELEMENT_PADS,
1647 "trying to link element %s:%s to element %s:%s", GST_ELEMENT_NAME (src),
1648 srcpadname ? srcpadname : "(any)", GST_ELEMENT_NAME (dest),
1649 destpadname ? destpadname : "(any)");
1653 /* name specified, look it up */
1654 if (!(srcpad = gst_element_get_static_pad (src, srcpadname)))
1655 srcpad = gst_element_get_request_pad (src, srcpadname);
1657 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1658 GST_ELEMENT_NAME (src), srcpadname);
1661 if (!(GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC)) {
1662 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no src pad",
1663 GST_DEBUG_PAD_NAME (srcpad));
1664 gst_object_unref (srcpad);
1667 if (GST_PAD_PEER (srcpad) != NULL) {
1668 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1669 "pad %s:%s is already linked to %s:%s", GST_DEBUG_PAD_NAME (srcpad),
1670 GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
1671 gst_object_unref (srcpad);
1677 /* no name given, get the first available pad */
1678 GST_OBJECT_LOCK (src);
1679 srcpads = GST_ELEMENT_PADS (src);
1680 srcpad = srcpads ? GST_PAD_CAST (srcpads->data) : NULL;
1682 gst_object_ref (srcpad);
1683 GST_OBJECT_UNLOCK (src);
1686 /* get a destination pad */
1688 /* name specified, look it up */
1689 if (!(destpad = gst_element_get_static_pad (dest, destpadname)))
1690 destpad = gst_element_get_request_pad (dest, destpadname);
1692 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1693 GST_ELEMENT_NAME (dest), destpadname);
1696 if (!(GST_PAD_DIRECTION (destpad) == GST_PAD_SINK)) {
1697 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no sink pad",
1698 GST_DEBUG_PAD_NAME (destpad));
1699 gst_object_unref (destpad);
1702 if (GST_PAD_PEER (destpad) != NULL) {
1703 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1704 "pad %s:%s is already linked to %s:%s",
1705 GST_DEBUG_PAD_NAME (destpad),
1706 GST_DEBUG_PAD_NAME (GST_PAD_PEER (destpad)));
1707 gst_object_unref (destpad);
1713 /* no name given, get the first available pad */
1714 GST_OBJECT_LOCK (dest);
1715 destpads = GST_ELEMENT_PADS (dest);
1716 destpad = destpads ? GST_PAD_CAST (destpads->data) : NULL;
1718 gst_object_ref (destpad);
1719 GST_OBJECT_UNLOCK (dest);
1722 if (srcpadname && destpadname) {
1725 /* two explicitly specified pads */
1726 result = pad_link_maybe_ghosting (srcpad, destpad, flags);
1728 gst_object_unref (srcpad);
1729 gst_object_unref (destpad);
1735 /* loop through the allowed pads in the source, trying to find a
1736 * compatible destination pad */
1737 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1738 "looping through allowed src and dest pads");
1740 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying src pad %s:%s",
1741 GST_DEBUG_PAD_NAME (srcpad));
1742 if ((GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC) &&
1743 (GST_PAD_PEER (srcpad) == NULL)) {
1748 gst_object_ref (temp);
1750 temp = gst_element_get_compatible_pad (dest, srcpad, NULL);
1753 if (temp && pad_link_maybe_ghosting (srcpad, temp, flags)) {
1754 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1755 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (temp));
1757 gst_object_unref (destpad);
1758 gst_object_unref (srcpad);
1759 gst_object_unref (temp);
1764 gst_object_unref (temp);
1767 /* find a better way for this mess */
1769 srcpads = g_list_next (srcpads);
1771 gst_object_unref (srcpad);
1772 srcpad = GST_PAD_CAST (srcpads->data);
1773 gst_object_ref (srcpad);
1779 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s:%s to %s",
1780 GST_DEBUG_PAD_NAME (srcpad), GST_ELEMENT_NAME (dest));
1782 gst_object_unref (destpad);
1786 gst_object_unref (srcpad);
1790 /* loop through the existing pads in the destination */
1792 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying dest pad %s:%s",
1793 GST_DEBUG_PAD_NAME (destpad));
1794 if ((GST_PAD_DIRECTION (destpad) == GST_PAD_SINK) &&
1795 (GST_PAD_PEER (destpad) == NULL)) {
1796 GstPad *temp = gst_element_get_compatible_pad (src, destpad, NULL);
1798 if (temp && pad_link_maybe_ghosting (temp, destpad, flags)) {
1799 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1800 GST_DEBUG_PAD_NAME (temp), GST_DEBUG_PAD_NAME (destpad));
1801 gst_object_unref (temp);
1802 gst_object_unref (destpad);
1806 gst_object_unref (temp);
1810 destpads = g_list_next (destpads);
1812 gst_object_unref (destpad);
1813 destpad = GST_PAD_CAST (destpads->data);
1814 gst_object_ref (destpad);
1821 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s:%s",
1822 GST_ELEMENT_NAME (src), GST_DEBUG_PAD_NAME (destpad));
1823 gst_object_unref (destpad);
1827 gst_object_unref (destpad);
1831 srcclass = GST_ELEMENT_GET_CLASS (src);
1832 destclass = GST_ELEMENT_GET_CLASS (dest);
1834 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1835 "we might have request pads on both sides, checking...");
1836 srctempls = gst_element_class_get_pad_template_list (srcclass);
1837 desttempls = gst_element_class_get_pad_template_list (destclass);
1839 if (srctempls && desttempls) {
1841 srctempl = (GstPadTemplate *) srctempls->data;
1842 if (srctempl->presence == GST_PAD_REQUEST) {
1843 for (l = desttempls; l; l = l->next) {
1844 desttempl = (GstPadTemplate *) l->data;
1845 if (desttempl->presence == GST_PAD_REQUEST &&
1846 desttempl->direction != srctempl->direction) {
1847 GstCaps *srccaps, *destcaps;
1849 srccaps = gst_pad_template_get_caps (srctempl);
1850 destcaps = gst_pad_template_get_caps (desttempl);
1851 if (gst_caps_is_always_compatible (srccaps, destcaps)) {
1853 gst_element_request_pad (src, srctempl,
1854 srctempl->name_template, NULL);
1856 gst_element_request_pad (dest, desttempl,
1857 desttempl->name_template, NULL);
1858 if (srcpad && destpad
1859 && pad_link_maybe_ghosting (srcpad, destpad, flags)) {
1860 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1861 "linked pad %s:%s to pad %s:%s",
1862 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (destpad));
1863 gst_object_unref (srcpad);
1864 gst_object_unref (destpad);
1865 gst_caps_unref (srccaps);
1866 gst_caps_unref (destcaps);
1869 /* it failed, so we release the request pads */
1871 gst_element_release_request_pad (src, srcpad);
1873 gst_element_release_request_pad (dest, destpad);
1875 gst_caps_unref (srccaps);
1876 gst_caps_unref (destcaps);
1880 srctempls = srctempls->next;
1884 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s",
1885 GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
1890 * gst_element_link_pads:
1891 * @src: a #GstElement containing the source pad.
1892 * @srcpadname: (allow-none): the name of the #GstPad in source element
1893 * or NULL for any pad.
1894 * @dest: (transfer none): the #GstElement containing the destination pad.
1895 * @destpadname: (allow-none): the name of the #GstPad in destination element,
1896 * or NULL for any pad.
1898 * Links the two named pads of the source and destination elements.
1899 * Side effect is that if one of the pads has no parent, it becomes a
1900 * child of the parent of the other element. If they have different
1901 * parents, the link fails.
1903 * Returns: TRUE if the pads could be linked, FALSE otherwise.
1906 gst_element_link_pads (GstElement * src, const gchar * srcpadname,
1907 GstElement * dest, const gchar * destpadname)
1909 return gst_element_link_pads_full (src, srcpadname, dest, destpadname,
1910 GST_PAD_LINK_CHECK_DEFAULT);
1914 * gst_element_link_pads_filtered:
1915 * @src: a #GstElement containing the source pad.
1916 * @srcpadname: (allow-none): the name of the #GstPad in source element
1917 * or NULL for any pad.
1918 * @dest: (transfer none): the #GstElement containing the destination pad.
1919 * @destpadname: (allow-none): the name of the #GstPad in destination element
1920 * or NULL for any pad.
1921 * @filter: (transfer none) (allow-none): the #GstCaps to filter the link,
1922 * or #NULL for no filter.
1924 * Links the two named pads of the source and destination elements. Side effect
1925 * is that if one of the pads has no parent, it becomes a child of the parent of
1926 * the other element. If they have different parents, the link fails. If @caps
1927 * is not #NULL, makes sure that the caps of the link is a subset of @caps.
1929 * Returns: TRUE if the pads could be linked, FALSE otherwise.
1932 gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
1933 GstElement * dest, const gchar * destpadname, GstCaps * filter)
1936 g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1937 g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1938 g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), FALSE);
1941 GstElement *capsfilter;
1943 GstState state, pending;
1946 capsfilter = gst_element_factory_make ("capsfilter", NULL);
1948 GST_ERROR ("Could not make a capsfilter");
1952 parent = gst_object_get_parent (GST_OBJECT (src));
1953 g_return_val_if_fail (GST_IS_BIN (parent), FALSE);
1955 gst_element_get_state (GST_ELEMENT_CAST (parent), &state, &pending, 0);
1957 if (!gst_bin_add (GST_BIN (parent), capsfilter)) {
1958 GST_ERROR ("Could not add capsfilter");
1959 gst_object_unref (capsfilter);
1960 gst_object_unref (parent);
1964 if (pending != GST_STATE_VOID_PENDING)
1967 gst_element_set_state (capsfilter, state);
1969 gst_object_unref (parent);
1971 g_object_set (capsfilter, "caps", filter, NULL);
1973 lr1 = gst_element_link_pads (src, srcpadname, capsfilter, "sink");
1974 lr2 = gst_element_link_pads (capsfilter, "src", dest, destpadname);
1979 GST_INFO ("Could not link pads: %s:%s - capsfilter:sink",
1980 GST_ELEMENT_NAME (src), srcpadname);
1982 GST_INFO ("Could not link pads: capsfilter:src - %s:%s",
1983 GST_ELEMENT_NAME (dest), destpadname);
1985 gst_element_set_state (capsfilter, GST_STATE_NULL);
1986 /* this will unlink and unref as appropriate */
1987 gst_bin_remove (GST_BIN (GST_OBJECT_PARENT (capsfilter)), capsfilter);
1991 if (gst_element_link_pads (src, srcpadname, dest, destpadname)) {
1994 GST_INFO ("Could not link pads: %s:%s - %s:%s", GST_ELEMENT_NAME (src),
1995 srcpadname, GST_ELEMENT_NAME (dest), destpadname);
2003 * @src: (transfer none): a #GstElement containing the source pad.
2004 * @dest: (transfer none): the #GstElement containing the destination pad.
2006 * Links @src to @dest. The link must be from source to
2007 * destination; the other direction will not be tried. The function looks for
2008 * existing pads that aren't linked yet. It will request new pads if necessary.
2009 * Such pads need to be released manually when unlinking.
2010 * If multiple links are possible, only one is established.
2012 * Make sure you have added your elements to a bin or pipeline with
2013 * gst_bin_add() before trying to link them.
2015 * Returns: TRUE if the elements could be linked, FALSE otherwise.
2018 gst_element_link (GstElement * src, GstElement * dest)
2020 return gst_element_link_pads (src, NULL, dest, NULL);
2024 * gst_element_link_many:
2025 * @element_1: (transfer none): the first #GstElement in the link chain.
2026 * @element_2: (transfer none): the second #GstElement in the link chain.
2027 * @...: the NULL-terminated list of elements to link in order.
2029 * Chain together a series of elements. Uses gst_element_link().
2030 * Make sure you have added your elements to a bin or pipeline with
2031 * gst_bin_add() before trying to link them.
2033 * Returns: TRUE on success, FALSE otherwise.
2036 gst_element_link_many (GstElement * element_1, GstElement * element_2, ...)
2038 gboolean res = TRUE;
2041 g_return_val_if_fail (GST_IS_ELEMENT (element_1), FALSE);
2042 g_return_val_if_fail (GST_IS_ELEMENT (element_2), FALSE);
2044 va_start (args, element_2);
2047 if (!gst_element_link (element_1, element_2)) {
2052 element_1 = element_2;
2053 element_2 = va_arg (args, GstElement *);
2062 * gst_element_link_filtered:
2063 * @src: a #GstElement containing the source pad.
2064 * @dest: (transfer none): the #GstElement containing the destination pad.
2065 * @filter: (transfer none) (allow-none): the #GstCaps to filter the link,
2066 * or #NULL for no filter.
2068 * Links @src to @dest using the given caps as filtercaps.
2069 * The link must be from source to
2070 * destination; the other direction will not be tried. The function looks for
2071 * existing pads that aren't linked yet. It will request new pads if necessary.
2072 * If multiple links are possible, only one is established.
2074 * Make sure you have added your elements to a bin or pipeline with
2075 * gst_bin_add() before trying to link them.
2077 * Returns: TRUE if the pads could be linked, FALSE otherwise.
2080 gst_element_link_filtered (GstElement * src, GstElement * dest,
2083 return gst_element_link_pads_filtered (src, NULL, dest, NULL, filter);
2087 * gst_element_unlink_pads:
2088 * @src: a (transfer none): #GstElement containing the source pad.
2089 * @srcpadname: the name of the #GstPad in source element.
2090 * @dest: (transfer none): a #GstElement containing the destination pad.
2091 * @destpadname: the name of the #GstPad in destination element.
2093 * Unlinks the two named pads of the source and destination elements.
2095 * This is a convenience function for gst_pad_unlink().
2098 gst_element_unlink_pads (GstElement * src, const gchar * srcpadname,
2099 GstElement * dest, const gchar * destpadname)
2101 GstPad *srcpad, *destpad;
2102 gboolean srcrequest, destrequest;
2104 srcrequest = destrequest = FALSE;
2106 g_return_if_fail (src != NULL);
2107 g_return_if_fail (GST_IS_ELEMENT (src));
2108 g_return_if_fail (srcpadname != NULL);
2109 g_return_if_fail (dest != NULL);
2110 g_return_if_fail (GST_IS_ELEMENT (dest));
2111 g_return_if_fail (destpadname != NULL);
2113 /* obtain the pads requested */
2114 if (!(srcpad = gst_element_get_static_pad (src, srcpadname)))
2115 if ((srcpad = gst_element_get_request_pad (src, srcpadname)))
2117 if (srcpad == NULL) {
2118 GST_WARNING_OBJECT (src, "source element has no pad \"%s\"", srcpadname);
2121 if (!(destpad = gst_element_get_static_pad (dest, destpadname)))
2122 if ((destpad = gst_element_get_request_pad (dest, destpadname)))
2124 if (destpad == NULL) {
2125 GST_WARNING_OBJECT (dest, "destination element has no pad \"%s\"",
2130 /* we're satisfied they can be unlinked, let's do it */
2131 gst_pad_unlink (srcpad, destpad);
2134 gst_element_release_request_pad (dest, destpad);
2135 gst_object_unref (destpad);
2139 gst_element_release_request_pad (src, srcpad);
2140 gst_object_unref (srcpad);
2144 * gst_element_unlink_many:
2145 * @element_1: (transfer none): the first #GstElement in the link chain.
2146 * @element_2: (transfer none): the second #GstElement in the link chain.
2147 * @...: the NULL-terminated list of elements to unlink in order.
2149 * Unlinks a series of elements. Uses gst_element_unlink().
2152 gst_element_unlink_many (GstElement * element_1, GstElement * element_2, ...)
2156 g_return_if_fail (element_1 != NULL && element_2 != NULL);
2157 g_return_if_fail (GST_IS_ELEMENT (element_1) && GST_IS_ELEMENT (element_2));
2159 va_start (args, element_2);
2162 gst_element_unlink (element_1, element_2);
2164 element_1 = element_2;
2165 element_2 = va_arg (args, GstElement *);
2172 * gst_element_unlink:
2173 * @src: (transfer none): the source #GstElement to unlink.
2174 * @dest: (transfer none): the sink #GstElement to unlink.
2176 * Unlinks all source pads of the source element with all sink pads
2177 * of the sink element to which they are linked.
2179 * If the link has been made using gst_element_link(), it could have created an
2180 * requestpad, which has to be released using gst_element_release_request_pad().
2183 gst_element_unlink (GstElement * src, GstElement * dest)
2186 gboolean done = FALSE;
2187 GValue data = { 0, };
2189 g_return_if_fail (GST_IS_ELEMENT (src));
2190 g_return_if_fail (GST_IS_ELEMENT (dest));
2192 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unlinking \"%s\" and \"%s\"",
2193 GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
2195 pads = gst_element_iterate_pads (src);
2197 switch (gst_iterator_next (pads, &data)) {
2198 case GST_ITERATOR_OK:
2200 GstPad *pad = g_value_get_object (&data);
2202 if (GST_PAD_IS_SRC (pad)) {
2203 GstPad *peerpad = gst_pad_get_peer (pad);
2205 /* see if the pad is linked and is really a pad of dest */
2207 GstElement *peerelem;
2209 peerelem = gst_pad_get_parent_element (peerpad);
2211 if (peerelem == dest) {
2212 gst_pad_unlink (pad, peerpad);
2215 gst_object_unref (peerelem);
2217 gst_object_unref (peerpad);
2220 g_value_reset (&data);
2223 case GST_ITERATOR_RESYNC:
2224 gst_iterator_resync (pads);
2226 case GST_ITERATOR_DONE:
2230 g_assert_not_reached ();
2234 g_value_unset (&data);
2235 gst_iterator_free (pads);
2239 * gst_element_query_position:
2240 * @element: a #GstElement to invoke the position query on.
2241 * @format: the #GstFormat requested
2242 * @cur: (out) (allow-none): a location in which to store the current
2243 * position, or NULL.
2245 * Queries an element for the stream position. If one repeatedly calls this
2246 * function one can also create and reuse it in gst_element_query().
2248 * Returns: TRUE if the query could be performed.
2251 gst_element_query_position (GstElement * element, GstFormat format,
2257 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2258 g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2260 query = gst_query_new_position (format);
2261 ret = gst_element_query (element, query);
2264 gst_query_parse_position (query, NULL, cur);
2266 gst_query_unref (query);
2272 * gst_element_query_duration:
2273 * @element: a #GstElement to invoke the duration query on.
2274 * @format: the #GstFormat requested
2275 * @duration: (out): A location in which to store the total duration, or NULL.
2277 * Queries an element for the total stream duration.
2279 * Returns: TRUE if the query could be performed.
2282 gst_element_query_duration (GstElement * element, GstFormat format,
2288 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2289 g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2291 query = gst_query_new_duration (format);
2292 ret = gst_element_query (element, query);
2295 gst_query_parse_duration (query, NULL, duration);
2297 gst_query_unref (query);
2303 * gst_element_query_convert:
2304 * @element: a #GstElement to invoke the convert query on.
2305 * @src_format: (inout): a #GstFormat to convert from.
2306 * @src_val: a value to convert.
2307 * @dest_format: the #GstFormat to convert to.
2308 * @dest_val: (out): a pointer to the result.
2310 * Queries an element to convert @src_val in @src_format to @dest_format.
2312 * Returns: TRUE if the query could be performed.
2315 gst_element_query_convert (GstElement * element, GstFormat src_format,
2316 gint64 src_val, GstFormat dest_format, gint64 * dest_val)
2321 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2322 g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
2323 g_return_val_if_fail (dest_val != NULL, FALSE);
2325 if (dest_format == src_format || src_val == -1) {
2326 *dest_val = src_val;
2330 query = gst_query_new_convert (src_format, src_val, dest_format);
2331 ret = gst_element_query (element, query);
2334 gst_query_parse_convert (query, NULL, NULL, NULL, dest_val);
2336 gst_query_unref (query);
2342 * gst_element_seek_simple
2343 * @element: a #GstElement to seek on
2344 * @format: a #GstFormat to execute the seek in, such as #GST_FORMAT_TIME
2345 * @seek_flags: seek options; playback applications will usually want to use
2346 * GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_KEY_UNIT here
2347 * @seek_pos: position to seek to (relative to the start); if you are doing
2348 * a seek in #GST_FORMAT_TIME this value is in nanoseconds -
2349 * multiply with #GST_SECOND to convert seconds to nanoseconds or
2350 * with #GST_MSECOND to convert milliseconds to nanoseconds.
2352 * Simple API to perform a seek on the given element, meaning it just seeks
2353 * to the given position relative to the start of the stream. For more complex
2354 * operations like segment seeks (e.g. for looping) or changing the playback
2355 * rate or seeking relative to the last configured playback segment you should
2356 * use gst_element_seek().
2358 * In a completely prerolled PAUSED or PLAYING pipeline, seeking is always
2359 * guaranteed to return %TRUE on a seekable media type or %FALSE when the media
2360 * type is certainly not seekable (such as a live stream).
2362 * Some elements allow for seeking in the READY state, in this
2363 * case they will store the seek event and execute it when they are put to
2364 * PAUSED. If the element supports seek in READY, it will always return %TRUE when
2365 * it receives the event in the READY state.
2367 * Returns: %TRUE if the seek operation succeeded (the seek might not always be
2368 * executed instantly though)
2373 gst_element_seek_simple (GstElement * element, GstFormat format,
2374 GstSeekFlags seek_flags, gint64 seek_pos)
2376 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2377 g_return_val_if_fail (seek_pos >= 0, FALSE);
2379 return gst_element_seek (element, 1.0, format, seek_flags,
2380 GST_SEEK_TYPE_SET, seek_pos, GST_SEEK_TYPE_NONE, 0);
2384 * gst_pad_use_fixed_caps:
2385 * @pad: the pad to use
2387 * A helper function you can use that sets the FIXED_CAPS flag
2388 * This way the default getcaps function will always return the negotiated caps
2389 * or in case the pad is not negotiated, the padtemplate caps.
2391 * Use this function on a pad that, once gst_pad_set_caps() has been called
2392 * on it, cannot be renegotiated to something else.
2395 gst_pad_use_fixed_caps (GstPad * pad)
2397 GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_FIXED_CAPS);
2401 * gst_pad_get_parent_element:
2404 * Gets the parent of @pad, cast to a #GstElement. If a @pad has no parent or
2405 * its parent is not an element, return NULL.
2407 * Returns: (transfer full): the parent of the pad. The caller has a
2408 * reference on the parent, so unref when you're finished with it.
2413 gst_pad_get_parent_element (GstPad * pad)
2417 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2419 p = gst_object_get_parent (GST_OBJECT_CAST (pad));
2421 if (p && !GST_IS_ELEMENT (p)) {
2422 gst_object_unref (p);
2425 return GST_ELEMENT_CAST (p);
2429 * gst_object_default_error:
2430 * @source: the #GstObject that initiated the error.
2431 * @error: (in): the GError.
2432 * @debug: (in) (allow-none): an additional debug information string, or NULL
2434 * A default error function that uses g_printerr() to display the error message
2435 * and the optional debug sting..
2437 * The default handler will simply print the error string using g_print.
2440 gst_object_default_error (GstObject * source, const GError * error,
2441 const gchar * debug)
2443 gchar *name = gst_object_get_path_string (source);
2445 g_printerr (_("ERROR: from element %s: %s\n"), name, error->message);
2447 g_printerr (_("Additional debug info:\n%s\n"), debug);
2455 * @element_1: (transfer full): the #GstElement element to add to the bin
2456 * @...: (transfer full): additional elements to add to the bin
2458 * Adds a NULL-terminated list of elements to a bin. This function is
2459 * equivalent to calling gst_bin_add() for each member of the list. The return
2460 * value of each gst_bin_add() is ignored.
2463 gst_bin_add_many (GstBin * bin, GstElement * element_1, ...)
2467 g_return_if_fail (GST_IS_BIN (bin));
2468 g_return_if_fail (GST_IS_ELEMENT (element_1));
2470 va_start (args, element_1);
2473 gst_bin_add (bin, element_1);
2475 element_1 = va_arg (args, GstElement *);
2482 * gst_bin_remove_many:
2484 * @element_1: (transfer none): the first #GstElement to remove from the bin
2485 * @...: (transfer none): NULL-terminated list of elements to remove from the bin
2487 * Remove a list of elements from a bin. This function is equivalent
2488 * to calling gst_bin_remove() with each member of the list.
2491 gst_bin_remove_many (GstBin * bin, GstElement * element_1, ...)
2495 g_return_if_fail (GST_IS_BIN (bin));
2496 g_return_if_fail (GST_IS_ELEMENT (element_1));
2498 va_start (args, element_1);
2501 gst_bin_remove (bin, element_1);
2503 element_1 = va_arg (args, GstElement *);
2510 gst_element_populate_std_props (GObjectClass * klass, const gchar * prop_name,
2511 guint arg_id, GParamFlags flags)
2513 GQuark prop_id = g_quark_from_string (prop_name);
2516 static GQuark fd_id = 0;
2517 static GQuark blocksize_id;
2518 static GQuark bytesperread_id;
2519 static GQuark dump_id;
2520 static GQuark filesize_id;
2521 static GQuark mmapsize_id;
2522 static GQuark location_id;
2523 static GQuark offset_id;
2524 static GQuark silent_id;
2525 static GQuark touch_id;
2527 flags |= G_PARAM_STATIC_STRINGS;
2530 fd_id = g_quark_from_static_string ("fd");
2531 blocksize_id = g_quark_from_static_string ("blocksize");
2532 bytesperread_id = g_quark_from_static_string ("bytesperread");
2533 dump_id = g_quark_from_static_string ("dump");
2534 filesize_id = g_quark_from_static_string ("filesize");
2535 mmapsize_id = g_quark_from_static_string ("mmapsize");
2536 location_id = g_quark_from_static_string ("location");
2537 offset_id = g_quark_from_static_string ("offset");
2538 silent_id = g_quark_from_static_string ("silent");
2539 touch_id = g_quark_from_static_string ("touch");
2542 if (prop_id == fd_id) {
2543 pspec = g_param_spec_int ("fd", "File-descriptor",
2544 "File-descriptor for the file being read", 0, G_MAXINT, 0, flags);
2545 } else if (prop_id == blocksize_id) {
2546 pspec = g_param_spec_ulong ("blocksize", "Block Size",
2547 "Block size to read per buffer", 0, G_MAXULONG, 4096, flags);
2549 } else if (prop_id == bytesperread_id) {
2550 pspec = g_param_spec_int ("bytesperread", "Bytes per read",
2551 "Number of bytes to read per buffer", G_MININT, G_MAXINT, 0, flags);
2553 } else if (prop_id == dump_id) {
2554 pspec = g_param_spec_boolean ("dump", "Dump",
2555 "Dump bytes to stdout", FALSE, flags);
2557 } else if (prop_id == filesize_id) {
2558 pspec = g_param_spec_int64 ("filesize", "File Size",
2559 "Size of the file being read", 0, G_MAXINT64, 0, flags);
2561 } else if (prop_id == mmapsize_id) {
2562 pspec = g_param_spec_ulong ("mmapsize", "mmap() Block Size",
2563 "Size in bytes of mmap()d regions", 0, G_MAXULONG, 4 * 1048576, flags);
2565 } else if (prop_id == location_id) {
2566 pspec = g_param_spec_string ("location", "File Location",
2567 "Location of the file to read", NULL, flags);
2569 } else if (prop_id == offset_id) {
2570 pspec = g_param_spec_int64 ("offset", "File Offset",
2571 "Byte offset of current read pointer", 0, G_MAXINT64, 0, flags);
2573 } else if (prop_id == silent_id) {
2574 pspec = g_param_spec_boolean ("silent", "Silent", "Don't produce events",
2577 } else if (prop_id == touch_id) {
2578 pspec = g_param_spec_boolean ("touch", "Touch read data",
2579 "Touch data to force disk read before " "push ()", TRUE, flags);
2581 g_warning ("Unknown - 'standard' property '%s' id %d from klass %s",
2582 prop_name, arg_id, g_type_name (G_OBJECT_CLASS_TYPE (klass)));
2587 g_object_class_install_property (klass, arg_id, pspec);
2592 * gst_element_class_install_std_props:
2593 * @klass: the #GstElementClass to add the properties to.
2594 * @first_name: the name of the first property.
2595 * in a NULL terminated
2596 * @...: the id and flags of the first property, followed by
2597 * further 'name', 'id', 'flags' triplets and terminated by NULL.
2599 * Adds a list of standardized properties with types to the @klass.
2600 * the id is for the property switch in your get_prop method, and
2601 * the flags determine readability / writeability.
2604 gst_element_class_install_std_props (GstElementClass * klass,
2605 const gchar * first_name, ...)
2611 g_return_if_fail (GST_IS_ELEMENT_CLASS (klass));
2613 va_start (args, first_name);
2618 int arg_id = va_arg (args, int);
2619 GParamFlags flags = (GParamFlags) va_arg (args, int);
2621 gst_element_populate_std_props ((GObjectClass *) klass, name, arg_id,
2624 name = va_arg (args, char *);
2633 * @buf1: (transfer none): the first source #GstBuffer to merge.
2634 * @buf2: (transfer none): the second source #GstBuffer to merge.
2636 * Create a new buffer that is the concatenation of the two source
2637 * buffers. The original source buffers will not be modified or
2638 * unref'd. Make sure you unref the source buffers if they are not used
2639 * anymore afterwards.
2641 * If the buffers point to contiguous areas of memory, the buffer
2642 * is created without copying the data.
2644 * Free-function: gst_buffer_unref
2646 * Returns: (transfer full): the new #GstBuffer which is the concatenation
2647 * of the source buffers.
2650 gst_buffer_merge (GstBuffer * buf1, GstBuffer * buf2)
2655 size1 = gst_buffer_get_size (buf1);
2656 size2 = gst_buffer_get_size (buf2);
2658 /* we're just a specific case of the more general gst_buffer_span() */
2659 result = gst_buffer_span (buf1, 0, buf2, size1 + size2);
2666 * @buf1: (transfer full): the first source #GstBuffer.
2667 * @buf2: (transfer full): the second source #GstBuffer.
2669 * Create a new buffer that is the concatenation of the two source
2670 * buffers, and unrefs the original source buffers.
2672 * If the buffers point to contiguous areas of memory, the buffer
2673 * is created without copying the data.
2675 * This is a convenience function for C programmers. See also
2676 * gst_buffer_merge(), which does the same thing without
2677 * unreffing the input parameters. Language bindings without
2678 * explicit reference counting should not wrap this function.
2680 * Returns: (transfer full): the new #GstBuffer which is the concatenation of
2681 * the source buffers.
2684 gst_buffer_join (GstBuffer * buf1, GstBuffer * buf2)
2689 size1 = gst_buffer_get_size (buf1);
2690 size2 = gst_buffer_get_size (buf2);
2692 result = gst_buffer_span (buf1, 0, buf2, size1 + size2);
2693 gst_buffer_unref (buf1);
2694 gst_buffer_unref (buf2);
2703 } QueryAcceptCapsData;
2706 query_accept_caps_func (GstPad * pad, QueryAcceptCapsData * data)
2708 if (G_LIKELY (gst_pad_peer_query (pad, data->query))) {
2711 gst_query_parse_accept_caps_result (data->query, &result);
2712 data->ret &= result;
2718 * gst_pad_proxy_query_accept_caps:
2719 * @pad: a #GstPad to proxy.
2720 * @query: an ACCEPT_CAPS #GstQuery.
2722 * Calls gst_pad_accept_caps() for all internally linked pads of @pad and
2723 * returns the intersection of the results.
2725 * This function is useful as a default accept caps query function for an element
2726 * that can handle any stream format, but requires caps that are acceptable for
2729 * Returns: TRUE if @query could be executed
2732 gst_pad_proxy_query_accept_caps (GstPad * pad, GstQuery * query)
2734 QueryAcceptCapsData data;
2736 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2737 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
2738 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS, FALSE);
2740 GST_CAT_DEBUG (GST_CAT_PADS, "proxying accept caps query for %s:%s",
2741 GST_DEBUG_PAD_NAME (pad));
2744 /* value to hold the return, by default it holds TRUE */
2747 gst_pad_forward (pad, (GstPadForwardFunction) query_accept_caps_func, &data);
2748 gst_query_set_accept_caps_result (query, data.ret);
2760 query_caps_func (GstPad * pad, QueryCapsData * data)
2762 gboolean empty = FALSE;
2764 if (G_LIKELY (gst_pad_peer_query (pad, data->query))) {
2765 GstCaps *peercaps, *intersection;
2767 gst_query_parse_caps_result (data->query, &peercaps);
2768 GST_DEBUG_OBJECT (pad, "intersect with result %" GST_PTR_FORMAT, peercaps);
2769 intersection = gst_caps_intersect (data->ret, peercaps);
2770 GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, intersection);
2772 gst_caps_unref (data->ret);
2773 data->ret = intersection;
2775 /* stop when empty */
2776 empty = gst_caps_is_empty (intersection);
2782 * gst_pad_proxy_query_caps:
2783 * @pad: a #GstPad to proxy.
2784 * @query: a CAPS #GstQuery.
2786 * Calls gst_pad_query_caps() for all internally linked pads fof @pad and returns
2787 * the intersection of the results.
2789 * This function is useful as a default caps query function for an element
2790 * that can handle any stream format, but requires all its pads to have
2791 * the same caps. Two such elements are tee and adder.
2793 * Returns: TRUE if @query could be executed
2796 gst_pad_proxy_query_caps (GstPad * pad, GstQuery * query)
2798 GstCaps *intersected;
2801 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2802 g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
2803 g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS, FALSE);
2805 GST_CAT_DEBUG (GST_CAT_PADS, "proxying caps query for %s:%s",
2806 GST_DEBUG_PAD_NAME (pad));
2809 /* value to hold the return, by default it holds ANY */
2810 data.ret = gst_caps_new_any ();
2812 gst_pad_forward (pad, (GstPadForwardFunction) query_caps_func, &data);
2816 gst_caps_intersect (data.ret, gst_pad_get_pad_template_caps (pad));
2817 gst_caps_unref (data.ret);
2819 intersected = gst_caps_copy (gst_pad_get_pad_template_caps (pad));
2821 gst_query_set_caps_result (query, intersected);
2822 gst_caps_unref (intersected);
2828 * gst_pad_query_position:
2829 * @pad: a #GstPad to invoke the position query on.
2830 * @format: the #GstFormat requested
2831 * @cur: (out): A location in which to store the current position, or NULL.
2833 * Queries a pad for the stream position.
2835 * Returns: TRUE if the query could be performed.
2838 gst_pad_query_position (GstPad * pad, GstFormat format, gint64 * cur)
2843 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2844 g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2846 query = gst_query_new_position (format);
2847 if ((ret = gst_pad_query (pad, query)))
2848 gst_query_parse_position (query, NULL, cur);
2849 gst_query_unref (query);
2855 * gst_pad_peer_query_position:
2856 * @pad: a #GstPad on whose peer to invoke the position query on.
2857 * Must be a sink pad.
2858 * @format: the #GstFormat requested
2859 * @cur: (out) (allow-none): a location in which to store the current
2860 * position, or NULL.
2862 * Queries the peer of a given sink pad for the stream position.
2864 * Returns: TRUE if the query could be performed.
2867 gst_pad_peer_query_position (GstPad * pad, GstFormat format, gint64 * cur)
2870 gboolean ret = FALSE;
2872 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2873 g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2874 g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2876 query = gst_query_new_position (format);
2877 if ((ret = gst_pad_peer_query (pad, query)))
2878 gst_query_parse_position (query, NULL, cur);
2879 gst_query_unref (query);
2885 * gst_pad_query_duration:
2886 * @pad: a #GstPad to invoke the duration query on.
2887 * @format: the #GstFormat requested
2888 * @duration: (out) (allow-none): a location in which to store the total
2889 * duration, or NULL.
2891 * Queries a pad for the total stream duration.
2893 * Returns: TRUE if the query could be performed.
2896 gst_pad_query_duration (GstPad * pad, GstFormat format, gint64 * duration)
2901 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2902 g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2904 query = gst_query_new_duration (format);
2905 if ((ret = gst_pad_query (pad, query)))
2906 gst_query_parse_duration (query, NULL, duration);
2907 gst_query_unref (query);
2913 * gst_pad_peer_query_duration:
2914 * @pad: a #GstPad on whose peer pad to invoke the duration query on.
2915 * Must be a sink pad.
2916 * @format: the #GstFormat requested
2917 * @duration: (out) (allow-none): a location in which to store the total
2918 * duration, or NULL.
2920 * Queries the peer pad of a given sink pad for the total stream duration.
2922 * Returns: TRUE if the query could be performed.
2925 gst_pad_peer_query_duration (GstPad * pad, GstFormat format, gint64 * duration)
2928 gboolean ret = FALSE;
2930 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2931 g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2932 g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2934 query = gst_query_new_duration (format);
2935 if ((ret = gst_pad_peer_query (pad, query)))
2936 gst_query_parse_duration (query, NULL, duration);
2937 gst_query_unref (query);
2943 * gst_pad_query_convert:
2944 * @pad: a #GstPad to invoke the convert query on.
2945 * @src_format: a #GstFormat to convert from.
2946 * @src_val: a value to convert.
2947 * @dest_format: the #GstFormat to convert to.
2948 * @dest_val: (out): a pointer to the result.
2950 * Queries a pad to convert @src_val in @src_format to @dest_format.
2952 * Returns: TRUE if the query could be performed.
2955 gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2956 GstFormat dest_format, gint64 * dest_val)
2961 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2962 g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
2963 g_return_val_if_fail (dest_val != NULL, FALSE);
2965 if (dest_format == src_format || src_val == -1) {
2966 *dest_val = src_val;
2970 query = gst_query_new_convert (src_format, src_val, dest_format);
2971 if ((ret = gst_pad_query (pad, query)))
2972 gst_query_parse_convert (query, NULL, NULL, NULL, dest_val);
2973 gst_query_unref (query);
2979 * gst_pad_peer_query_convert:
2980 * @pad: a #GstPad, on whose peer pad to invoke the convert query on.
2981 * Must be a sink pad.
2982 * @src_format: a #GstFormat to convert from.
2983 * @src_val: a value to convert.
2984 * @dest_format: the #GstFormat to convert to.
2985 * @dest_val: (out): a pointer to the result.
2987 * Queries the peer pad of a given sink pad to convert @src_val in @src_format
2990 * Returns: TRUE if the query could be performed.
2993 gst_pad_peer_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2994 GstFormat dest_format, gint64 * dest_val)
2997 gboolean ret = FALSE;
2999 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3000 g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
3001 g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
3002 g_return_val_if_fail (dest_val != NULL, FALSE);
3004 query = gst_query_new_convert (src_format, src_val, dest_format);
3005 if ((ret = gst_pad_peer_query (pad, query)))
3006 gst_query_parse_convert (query, NULL, NULL, NULL, dest_val);
3007 gst_query_unref (query);
3013 * gst_pad_query_caps:
3014 * @pad: a #GstPad to get the capabilities of.
3015 * @filter: suggested #GstCaps.
3017 * Gets the capabilities this pad can produce or consume.
3018 * Note that this method doesn't necessarily return the caps set by
3019 * gst_pad_set_caps() - use gst_pad_get_current_caps() for that instead.
3020 * gst_pad_query_caps returns all possible caps a pad can operate with, using
3021 * the pad's CAPS query function, If the query fails, this function will return
3022 * @filter, if not #NULL, otherwise ANY.
3024 * When called on sinkpads @filter contains the caps that
3025 * upstream could produce in the order preferred by upstream. When
3026 * called on srcpads @filter contains the caps accepted by
3027 * downstream in the preffered order. @filter might be %NULL but
3028 * if it is not %NULL the returned caps will be a subset of @filter.
3030 * Note that this function does not return writable #GstCaps, use
3031 * gst_caps_make_writable() before modifying the caps.
3033 * Returns: (transfer full): the caps of the pad with incremented ref-count.
3036 gst_pad_query_caps (GstPad * pad, GstCaps * filter)
3038 GstCaps *result = NULL;
3041 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
3042 g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), NULL);
3044 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "get pad caps");
3046 query = gst_query_new_caps (filter);
3047 if (gst_pad_query (pad, query)) {
3048 gst_query_parse_caps_result (query, &result);
3049 gst_caps_ref (result);
3050 GST_DEBUG_OBJECT (pad, "query returned %" GST_PTR_FORMAT, result);
3051 } else if (filter) {
3052 result = gst_caps_ref (filter);
3054 result = gst_caps_new_any ();
3056 gst_query_unref (query);
3062 * gst_pad_peer_query_caps:
3063 * @pad: a #GstPad to get the capabilities of.
3064 * @filter: a #GstCaps filter.
3066 * Gets the capabilities of the peer connected to this pad. Similar to
3067 * gst_pad_query_caps().
3069 * When called on srcpads @filter contains the caps that
3070 * upstream could produce in the order preferred by upstream. When
3071 * called on sinkpads @filter contains the caps accepted by
3072 * downstream in the preffered order. @filter might be %NULL but
3073 * if it is not %NULL the returned caps will be a subset of @filter.
3075 * Returns: the caps of the peer pad with incremented ref-count. This function
3076 * returns %NULL when there is no peer pad.
3079 gst_pad_peer_query_caps (GstPad * pad, GstCaps * filter)
3081 GstCaps *result = NULL;
3084 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
3085 g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), NULL);
3087 query = gst_query_new_caps (filter);
3088 if (gst_pad_peer_query (pad, query)) {
3089 gst_query_parse_caps_result (query, &result);
3090 gst_caps_ref (result);
3091 GST_DEBUG_OBJECT (pad, "peer query returned %d", result);
3092 } else if (filter) {
3093 result = gst_caps_ref (filter);
3095 result = gst_caps_new_any ();
3097 gst_query_unref (query);
3103 * gst_pad_query_accept_caps:
3104 * @pad: a #GstPad to check
3105 * @caps: a #GstCaps to check on the pad
3107 * Check if the given pad accepts the caps.
3109 * Returns: TRUE if the pad can accept the caps.
3112 gst_pad_query_accept_caps (GstPad * pad, GstCaps * caps)
3114 gboolean res = TRUE;
3117 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3118 g_return_val_if_fail (GST_IS_CAPS (caps), FALSE);
3120 GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "accept caps of %p", caps);
3122 query = gst_query_new_accept_caps (caps);
3123 if (gst_pad_query (pad, query)) {
3124 GST_DEBUG_OBJECT (pad, "query returned %d", res);
3125 gst_query_parse_accept_caps_result (query, &res);
3127 gst_query_unref (query);
3133 * gst_pad_peer_query_accept_caps:
3134 * @pad: a #GstPad to check the peer of
3135 * @caps: a #GstCaps to check on the pad
3137 * Check if the peer of @pad accepts @caps. If @pad has no peer, this function
3140 * Returns: TRUE if the peer of @pad can accept the caps or @pad has no peer.
3143 gst_pad_peer_query_accept_caps (GstPad * pad, GstCaps * caps)
3145 gboolean res = TRUE;
3148 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3149 g_return_val_if_fail (GST_IS_CAPS (caps), FALSE);
3151 query = gst_query_new_accept_caps (caps);
3152 if (gst_pad_peer_query (pad, query)) {
3153 GST_DEBUG_OBJECT (pad, "query returned %d", res);
3154 gst_query_parse_accept_caps_result (query, &res);
3156 gst_query_unref (query);
3162 element_find_unlinked_pad (GstElement * element, GstPadDirection direction)
3165 GstPad *unlinked_pad = NULL;
3167 GValue data = { 0, };
3169 switch (direction) {
3171 iter = gst_element_iterate_src_pads (element);
3174 iter = gst_element_iterate_sink_pads (element);
3177 g_return_val_if_reached (NULL);
3182 switch (gst_iterator_next (iter, &data)) {
3183 case GST_ITERATOR_OK:{
3185 GstPad *pad = g_value_get_object (&data);
3187 GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
3188 GST_DEBUG_PAD_NAME (pad));
3190 peer = gst_pad_get_peer (pad);
3192 unlinked_pad = gst_object_ref (pad);
3194 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
3195 "found existing unlinked pad %s:%s",
3196 GST_DEBUG_PAD_NAME (unlinked_pad));
3198 gst_object_unref (peer);
3200 g_value_reset (&data);
3203 case GST_ITERATOR_DONE:
3206 case GST_ITERATOR_RESYNC:
3207 gst_iterator_resync (iter);
3209 case GST_ITERATOR_ERROR:
3210 g_return_val_if_reached (NULL);
3214 g_value_unset (&data);
3215 gst_iterator_free (iter);
3217 return unlinked_pad;
3221 * gst_bin_find_unlinked_pad:
3222 * @bin: bin in which to look for elements with unlinked pads
3223 * @direction: whether to look for an unlinked source or sink pad
3225 * Recursively looks for elements with an unlinked pad of the given
3226 * direction within the specified bin and returns an unlinked pad
3227 * if one is found, or NULL otherwise. If a pad is found, the caller
3228 * owns a reference to it and should use gst_object_unref() on the
3229 * pad when it is not needed any longer.
3231 * Returns: (transfer full): unlinked pad of the given direction, or NULL.
3236 gst_bin_find_unlinked_pad (GstBin * bin, GstPadDirection direction)
3241 GValue data = { 0, };
3243 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3244 g_return_val_if_fail (direction != GST_PAD_UNKNOWN, NULL);
3247 iter = gst_bin_iterate_recurse (bin);
3249 switch (gst_iterator_next (iter, &data)) {
3250 case GST_ITERATOR_OK:{
3251 GstElement *element = g_value_get_object (&data);
3253 pad = element_find_unlinked_pad (element, direction);
3256 g_value_reset (&data);
3259 case GST_ITERATOR_DONE:
3262 case GST_ITERATOR_RESYNC:
3263 gst_iterator_resync (iter);
3265 case GST_ITERATOR_ERROR:
3266 g_return_val_if_reached (NULL);
3270 g_value_unset (&data);
3271 gst_iterator_free (iter);
3277 * gst_parse_bin_from_description:
3278 * @bin_description: command line describing the bin
3279 * @ghost_unlinked_pads: whether to automatically create ghost pads
3280 * for unlinked source or sink pads within the bin
3281 * @err: where to store the error message in case of an error, or NULL
3283 * This is a convenience wrapper around gst_parse_launch() to create a
3284 * #GstBin from a gst-launch-style pipeline description. See
3285 * gst_parse_launch() and the gst-launch man page for details about the
3286 * syntax. Ghost pads on the bin for unlinked source or sink pads
3287 * within the bin can automatically be created (but only a maximum of
3288 * one ghost pad for each direction will be created; if you expect
3289 * multiple unlinked source pads or multiple unlinked sink pads
3290 * and want them all ghosted, you will have to create the ghost pads
3293 * Returns: (transfer full): a newly-created bin, or NULL if an error occurred.
3298 gst_parse_bin_from_description (const gchar * bin_description,
3299 gboolean ghost_unlinked_pads, GError ** err)
3301 return gst_parse_bin_from_description_full (bin_description,
3302 ghost_unlinked_pads, NULL, GST_PARSE_FLAG_NONE, err);
3306 * gst_parse_bin_from_description_full:
3307 * @bin_description: command line describing the bin
3308 * @ghost_unlinked_pads: whether to automatically create ghost pads
3309 * for unlinked source or sink pads within the bin
3310 * @context: (transfer none) (allow-none): a parse context allocated with
3311 * gst_parse_context_new(), or %NULL
3312 * @flags: parsing options, or #GST_PARSE_FLAG_NONE
3313 * @err: where to store the error message in case of an error, or NULL
3315 * This is a convenience wrapper around gst_parse_launch() to create a
3316 * #GstBin from a gst-launch-style pipeline description. See
3317 * gst_parse_launch() and the gst-launch man page for details about the
3318 * syntax. Ghost pads on the bin for unlinked source or sink pads
3319 * within the bin can automatically be created (but only a maximum of
3320 * one ghost pad for each direction will be created; if you expect
3321 * multiple unlinked source pads or multiple unlinked sink pads
3322 * and want them all ghosted, you will have to create the ghost pads
3325 * Returns: (transfer full): a newly-created bin, or NULL if an error occurred.
3330 gst_parse_bin_from_description_full (const gchar * bin_description,
3331 gboolean ghost_unlinked_pads, GstParseContext * context,
3332 GstParseFlags flags, GError ** err)
3334 #ifndef GST_DISABLE_PARSE
3339 g_return_val_if_fail (bin_description != NULL, NULL);
3340 g_return_val_if_fail (err == NULL || *err == NULL, NULL);
3342 GST_DEBUG ("Making bin from description '%s'", bin_description);
3344 /* parse the pipeline to a bin */
3345 desc = g_strdup_printf ("bin.( %s )", bin_description);
3346 bin = (GstBin *) gst_parse_launch_full (desc, context, flags, err);
3349 if (bin == NULL || (err && *err != NULL)) {
3351 gst_object_unref (bin);
3355 /* find pads and ghost them if necessary */
3356 if (ghost_unlinked_pads) {
3357 if ((pad = gst_bin_find_unlinked_pad (bin, GST_PAD_SRC))) {
3358 gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("src", pad));
3359 gst_object_unref (pad);
3361 if ((pad = gst_bin_find_unlinked_pad (bin, GST_PAD_SINK))) {
3362 gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("sink", pad));
3363 gst_object_unref (pad);
3367 return GST_ELEMENT (bin);
3371 GST_WARNING ("Disabled API called");
3373 msg = gst_error_get_message (GST_CORE_ERROR, GST_CORE_ERROR_DISABLED);
3374 g_set_error (err, GST_CORE_ERROR, GST_CORE_ERROR_DISABLED, "%s", msg);
3382 * gst_util_get_timestamp:
3384 * Get a timestamp as GstClockTime to be used for interval measurements.
3385 * The timestamp should not be interpreted in any other way.
3387 * Returns: the timestamp
3392 gst_util_get_timestamp (void)
3394 #if defined (HAVE_POSIX_TIMERS) && defined(HAVE_MONOTONIC_CLOCK)
3395 struct timespec now;
3397 clock_gettime (CLOCK_MONOTONIC, &now);
3398 return GST_TIMESPEC_TO_TIME (now);
3402 g_get_current_time (&now);
3403 return GST_TIMEVAL_TO_TIME (now);
3408 * gst_util_array_binary_search:
3409 * @array: the sorted input array
3410 * @num_elements: number of elements in the array
3411 * @element_size: size of every element in bytes
3412 * @search_func: (scope call): function to compare two elements, @search_data will always be passed as second argument
3413 * @mode: search mode that should be used
3414 * @search_data: element that should be found
3415 * @user_data: (closure): data to pass to @search_func
3417 * Searches inside @array for @search_data by using the comparison function
3418 * @search_func. @array must be sorted ascending.
3420 * As @search_data is always passed as second argument to @search_func it's
3421 * not required that @search_data has the same type as the array elements.
3423 * The complexity of this search function is O(log (num_elements)).
3425 * Returns: (transfer none): The address of the found element or %NULL if nothing was found
3430 gst_util_array_binary_search (gpointer array, guint num_elements,
3431 gsize element_size, GCompareDataFunc search_func, GstSearchMode mode,
3432 gconstpointer search_data, gpointer user_data)
3434 glong left = 0, right = num_elements - 1, m;
3436 guint8 *data = (guint8 *) array;
3438 g_return_val_if_fail (array != NULL, NULL);
3439 g_return_val_if_fail (element_size > 0, NULL);
3440 g_return_val_if_fail (search_func != NULL, NULL);
3442 /* 0. No elements => return NULL */
3443 if (num_elements == 0)
3446 /* 1. If search_data is before the 0th element return the 0th element */
3447 ret = search_func (data, search_data, user_data);
3448 if ((ret >= 0 && mode == GST_SEARCH_MODE_AFTER) || ret == 0)
3453 /* 2. If search_data is after the last element return the last element */
3455 search_func (data + (num_elements - 1) * element_size, search_data,
3457 if ((ret <= 0 && mode == GST_SEARCH_MODE_BEFORE) || ret == 0)
3458 return data + (num_elements - 1) * element_size;
3462 /* 3. else binary search */
3464 m = left + (right - left) / 2;
3466 ret = search_func (data + m * element_size, search_data, user_data);
3469 return data + m * element_size;
3470 } else if (ret < 0) {
3476 /* No exact match found */
3478 if (mode == GST_SEARCH_MODE_EXACT) {
3480 } else if (mode == GST_SEARCH_MODE_AFTER) {
3482 return (m < num_elements) ? data + (m + 1) * element_size : NULL;
3484 return data + m * element_size;
3487 return data + m * element_size;
3489 return (m > 0) ? data + (m - 1) * element_size : NULL;
3495 /* Finds the greatest common divisor.
3496 * Returns 1 if none other found.
3497 * This is Euclid's algorithm. */
3500 * gst_util_greatest_common_divisor:
3501 * @a: First value as #gint
3502 * @b: Second value as #gint
3504 * Calculates the greatest common divisor of @a
3507 * Returns: Greatest common divisor of @a and @b
3512 gst_util_greatest_common_divisor (gint a, gint b)
3525 * gst_util_fraction_to_double:
3526 * @src_n: Fraction numerator as #gint
3527 * @src_d: Fraction denominator #gint
3528 * @dest: (out): pointer to a #gdouble for the result
3530 * Transforms a fraction to a #gdouble.
3535 gst_util_fraction_to_double (gint src_n, gint src_d, gdouble * dest)
3537 g_return_if_fail (dest != NULL);
3538 g_return_if_fail (src_d != 0);
3540 *dest = ((gdouble) src_n) / ((gdouble) src_d);
3543 #define MAX_TERMS 30
3544 #define MIN_DIVISOR 1.0e-10
3545 #define MAX_ERROR 1.0e-20
3547 /* use continued fractions to transform a double into a fraction,
3548 * see http://mathforum.org/dr.math/faq/faq.fractions.html#decfrac.
3549 * This algorithm takes care of overflows.
3553 * gst_util_double_to_fraction:
3554 * @src: #gdouble to transform
3555 * @dest_n: (out): pointer to a #gint to hold the result numerator
3556 * @dest_d: (out): pointer to a #gint to hold the result denominator
3558 * Transforms a #gdouble to a fraction and simplifies
3564 gst_util_double_to_fraction (gdouble src, gint * dest_n, gint * dest_d)
3567 gdouble V, F; /* double being converted */
3568 gint N, D; /* will contain the result */
3569 gint A; /* current term in continued fraction */
3570 gint64 N1, D1; /* numerator, denominator of last approx */
3571 gint64 N2, D2; /* numerator, denominator of previous approx */
3574 gboolean negative = FALSE;
3576 g_return_if_fail (dest_n != NULL);
3577 g_return_if_fail (dest_d != NULL);
3579 /* initialize fraction being converted */
3587 /* initialize fractions with 1/0, 0/1 */
3595 for (i = 0; i < MAX_TERMS; i++) {
3597 A = (gint) F; /* no floor() needed, F is always >= 0 */
3598 /* get new divisor */
3601 /* calculate new fraction in temp */
3605 /* guard against overflow */
3606 if (N2 > G_MAXINT || D2 > G_MAXINT) {
3613 /* save last two fractions */
3619 /* quit if dividing by zero or close enough to target */
3620 if (F < MIN_DIVISOR || fabs (V - ((gdouble) N) / D) < MAX_ERROR) {
3624 /* Take reciprocal */
3627 /* fix for overflow */
3632 /* fix for negative */
3637 gcd = gst_util_greatest_common_divisor (N, D);
3649 * gst_util_fraction_multiply:
3650 * @a_n: Numerator of first value
3651 * @a_d: Denominator of first value
3652 * @b_n: Numerator of second value
3653 * @b_d: Denominator of second value
3654 * @res_n: (out): Pointer to #gint to hold the result numerator
3655 * @res_d: (out): Pointer to #gint to hold the result denominator
3657 * Multiplies the fractions @a_n/@a_d and @b_n/@b_d and stores
3658 * the result in @res_n and @res_d.
3660 * Returns: %FALSE on overflow, %TRUE otherwise.
3665 gst_util_fraction_multiply (gint a_n, gint a_d, gint b_n, gint b_d,
3666 gint * res_n, gint * res_d)
3670 g_return_val_if_fail (res_n != NULL, FALSE);
3671 g_return_val_if_fail (res_d != NULL, FALSE);
3672 g_return_val_if_fail (a_d != 0, FALSE);
3673 g_return_val_if_fail (b_d != 0, FALSE);
3675 gcd = gst_util_greatest_common_divisor (a_n, a_d);
3679 gcd = gst_util_greatest_common_divisor (b_n, b_d);
3683 gcd = gst_util_greatest_common_divisor (a_n, b_d);
3687 gcd = gst_util_greatest_common_divisor (a_d, b_n);
3691 /* This would result in overflow */
3692 if (a_n != 0 && G_MAXINT / ABS (a_n) < ABS (b_n))
3694 if (G_MAXINT / ABS (a_d) < ABS (b_d))
3700 gcd = gst_util_greatest_common_divisor (*res_n, *res_d);
3708 * gst_util_fraction_add:
3709 * @a_n: Numerator of first value
3710 * @a_d: Denominator of first value
3711 * @b_n: Numerator of second value
3712 * @b_d: Denominator of second value
3713 * @res_n: (out): Pointer to #gint to hold the result numerator
3714 * @res_d: (out): Pointer to #gint to hold the result denominator
3716 * Adds the fractions @a_n/@a_d and @b_n/@b_d and stores
3717 * the result in @res_n and @res_d.
3719 * Returns: %FALSE on overflow, %TRUE otherwise.
3724 gst_util_fraction_add (gint a_n, gint a_d, gint b_n, gint b_d, gint * res_n,
3729 g_return_val_if_fail (res_n != NULL, FALSE);
3730 g_return_val_if_fail (res_d != NULL, FALSE);
3731 g_return_val_if_fail (a_d != 0, FALSE);
3732 g_return_val_if_fail (b_d != 0, FALSE);
3734 gcd = gst_util_greatest_common_divisor (a_n, a_d);
3738 gcd = gst_util_greatest_common_divisor (b_n, b_d);
3753 /* This would result in overflow */
3754 if (G_MAXINT / ABS (a_n) < ABS (b_n))
3756 if (G_MAXINT / ABS (a_d) < ABS (b_d))
3758 if (G_MAXINT / ABS (a_d) < ABS (b_d))
3761 *res_n = (a_n * b_d) + (a_d * b_n);
3764 gcd = gst_util_greatest_common_divisor (*res_n, *res_d);
3777 * gst_util_fraction_compare:
3778 * @a_n: Numerator of first value
3779 * @a_d: Denominator of first value
3780 * @b_n: Numerator of second value
3781 * @b_d: Denominator of second value
3783 * Compares the fractions @a_n/@a_d and @b_n/@b_d and returns
3784 * -1 if a < b, 0 if a = b and 1 if a > b.
3786 * Returns: -1 if a < b; 0 if a = b; 1 if a > b.
3791 gst_util_fraction_compare (gint a_n, gint a_d, gint b_n, gint b_d)
3797 g_return_val_if_fail (a_d != 0 && b_d != 0, 0);
3800 gcd = gst_util_greatest_common_divisor (a_n, a_d);
3804 gcd = gst_util_greatest_common_divisor (b_n, b_d);
3808 /* fractions are reduced when set, so we can quickly see if they're equal */
3809 if (a_n == b_n && a_d == b_d)
3812 /* extend to 64 bits */
3813 new_num_1 = ((gint64) a_n) * b_d;
3814 new_num_2 = ((gint64) b_n) * a_d;
3815 if (new_num_1 < new_num_2)
3817 if (new_num_1 > new_num_2)
3820 /* Should not happen because a_d and b_d are not 0 */
3821 g_return_val_if_reached (0);