2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 * 2002 Thomas Vander Stichele <thomas@apestaart.org>
6 * gstutils.c: Utility functions
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
26 * @short_description: Various utility functions
28 * When defining own plugins, use the GST_BOILERPLATE ease gobject creation.
31 #include "gst_private.h"
35 #include "gstghostpad.h"
41 #include "gst-i18n-lib.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 multipy/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_exchange_and_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)
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);
777 * gst_print_element_args:
778 * @buf: the buffer to print the args in
779 * @indent: initial indentation
780 * @element: (transfer none): the element to print the args of
782 * Print the element argument in a human readable format in the given
786 gst_print_element_args (GString * buf, gint indent, GstElement * element)
789 GValue value = { 0, }; /* the important thing is that value.type = 0 */
791 GParamSpec *spec, **specs, **walk;
793 specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (element), NULL);
796 for (walk = specs; *walk; walk++) {
798 if (width < strlen (spec->name))
799 width = strlen (spec->name);
802 for (walk = specs; *walk; walk++) {
805 if (spec->flags & G_PARAM_READABLE) {
806 g_value_init (&value, spec->value_type);
807 g_object_get_property (G_OBJECT (element), spec->name, &value);
808 str = g_strdup_value_contents (&value);
809 g_value_unset (&value);
811 str = g_strdup ("Parameter not readable.");
814 string_append_indent (buf, indent);
815 g_string_append (buf, spec->name);
816 string_append_indent (buf, 2 + width - strlen (spec->name));
817 g_string_append (buf, str);
818 g_string_append_c (buf, '\n');
827 * gst_element_create_all_pads:
828 * @element: (transfer none): a #GstElement to create pads for
830 * Creates a pad for each pad template that is always available.
831 * This function is only useful during object intialization of
832 * subclasses of #GstElement.
835 gst_element_create_all_pads (GstElement * element)
839 /* FIXME: lock element */
842 gst_element_class_get_pad_template_list (GST_ELEMENT_CLASS
843 (G_OBJECT_GET_CLASS (element)));
846 GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
848 if (padtempl->presence == GST_PAD_ALWAYS) {
851 pad = gst_pad_new_from_template (padtempl, padtempl->name_template);
853 gst_element_add_pad (element, pad);
855 padlist = padlist->next;
860 * gst_element_get_compatible_pad_template:
861 * @element: (transfer none): a #GstElement to get a compatible pad template for
862 * @compattempl: (transfer none): the #GstPadTemplate to find a compatible
865 * Retrieves a pad template from @element that is compatible with @compattempl.
866 * Pads from compatible templates can be linked together.
868 * Returns: (transfer none): a compatible #GstPadTemplate, or NULL if none
869 * was found. No unreferencing is necessary.
872 gst_element_get_compatible_pad_template (GstElement * element,
873 GstPadTemplate * compattempl)
875 GstPadTemplate *newtempl = NULL;
877 GstElementClass *class;
880 g_return_val_if_fail (element != NULL, NULL);
881 g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
882 g_return_val_if_fail (compattempl != NULL, NULL);
884 class = GST_ELEMENT_GET_CLASS (element);
886 padlist = gst_element_class_get_pad_template_list (class);
888 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
889 "Looking for a suitable pad template in %s out of %d templates...",
890 GST_ELEMENT_NAME (element), g_list_length (padlist));
893 GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
897 * Check direction (must be opposite)
900 GST_CAT_LOG (GST_CAT_CAPS,
901 "checking pad template %s", padtempl->name_template);
902 if (padtempl->direction != compattempl->direction) {
903 GST_CAT_DEBUG (GST_CAT_CAPS,
904 "compatible direction: found %s pad template \"%s\"",
905 padtempl->direction == GST_PAD_SRC ? "src" : "sink",
906 padtempl->name_template);
908 GST_CAT_DEBUG (GST_CAT_CAPS,
909 "intersecting %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (compattempl));
910 GST_CAT_DEBUG (GST_CAT_CAPS,
911 "..and %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (padtempl));
913 compatible = gst_caps_can_intersect (GST_PAD_TEMPLATE_CAPS (compattempl),
914 GST_PAD_TEMPLATE_CAPS (padtempl));
916 GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
917 (compatible ? "" : "not "));
925 padlist = g_list_next (padlist);
928 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
929 "Returning new pad template %p", newtempl);
931 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "No compatible pad template found");
937 * gst_element_get_pad_from_template:
938 * @element: (transfer none): a #GstElement.
939 * @templ: (transfer none): a #GstPadTemplate belonging to @element.
941 * Gets a pad from @element described by @templ. If the presence of @templ is
942 * #GST_PAD_REQUEST, requests a new pad. Can return %NULL for #GST_PAD_SOMETIMES
945 * Returns: (transfer full): the #GstPad, or NULL if one could not be found
949 gst_element_get_pad_from_template (GstElement * element, GstPadTemplate * templ)
952 GstPadPresence presence;
954 /* If this function is ever exported, we need check the validity of `element'
955 * and `templ', and to make sure the template actually belongs to the
958 presence = GST_PAD_TEMPLATE_PRESENCE (templ);
962 case GST_PAD_SOMETIMES:
963 ret = gst_element_get_static_pad (element, templ->name_template);
964 if (!ret && presence == GST_PAD_ALWAYS)
966 ("Element %s has an ALWAYS template %s, but no pad of the same name",
967 GST_OBJECT_NAME (element), templ->name_template);
970 case GST_PAD_REQUEST:
971 ret = gst_element_request_pad (element, templ, NULL, NULL);
979 * gst_element_request_compatible_pad:
980 * @element: a #GstElement.
981 * @templ: the #GstPadTemplate to which the new pad should be able to link.
983 * Requests a pad from @element. The returned pad should be unlinked and
984 * compatible with @templ. Might return an existing pad, or request a new one.
986 * Returns: a #GstPad, or %NULL if one could not be found or created.
989 gst_element_request_compatible_pad (GstElement * element,
990 GstPadTemplate * templ)
992 GstPadTemplate *templ_new;
995 g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
996 g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
998 /* FIXME: should really loop through the templates, testing each for
999 * compatibility and pad availability. */
1000 templ_new = gst_element_get_compatible_pad_template (element, templ);
1002 pad = gst_element_get_pad_from_template (element, templ_new);
1004 /* This can happen for non-request pads. No need to unref. */
1005 if (pad && GST_PAD_PEER (pad))
1012 * Checks if the source pad and the sink pad can be linked.
1013 * Both @srcpad and @sinkpad must be unlinked and have a parent.
1016 gst_pad_check_link (GstPad * srcpad, GstPad * sinkpad)
1018 /* FIXME This function is gross. It's almost a direct copy of
1019 * gst_pad_link_filtered(). Any decent programmer would attempt
1020 * to merge the two functions, which I will do some day. --ds
1023 /* generic checks */
1024 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1025 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1027 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
1028 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1030 /* FIXME: shouldn't we convert this to g_return_val_if_fail? */
1031 if (GST_PAD_PEER (srcpad) != NULL) {
1032 GST_CAT_INFO (GST_CAT_PADS, "Source pad %s:%s has a peer, failed",
1033 GST_DEBUG_PAD_NAME (srcpad));
1036 if (GST_PAD_PEER (sinkpad) != NULL) {
1037 GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has a peer, failed",
1038 GST_DEBUG_PAD_NAME (sinkpad));
1041 if (!GST_PAD_IS_SRC (srcpad)) {
1042 GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s is not source pad, failed",
1043 GST_DEBUG_PAD_NAME (srcpad));
1046 if (!GST_PAD_IS_SINK (sinkpad)) {
1047 GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s is not sink pad, failed",
1048 GST_DEBUG_PAD_NAME (sinkpad));
1051 if (GST_PAD_PARENT (srcpad) == NULL) {
1052 GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s has no parent, failed",
1053 GST_DEBUG_PAD_NAME (srcpad));
1056 if (GST_PAD_PARENT (sinkpad) == NULL) {
1057 GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has no parent, failed",
1058 GST_DEBUG_PAD_NAME (srcpad));
1066 * gst_element_get_compatible_pad:
1067 * @element: (transfer none): a #GstElement in which the pad should be found.
1068 * @pad: (transfer none): the #GstPad to find a compatible one for.
1069 * @caps: the #GstCaps to use as a filter.
1071 * Looks for an unlinked pad to which the given pad can link. It is not
1072 * guaranteed that linking the pads will work, though it should work in most
1075 * This function will first attempt to find a compatible unlinked ALWAYS pad,
1076 * and if none can be found, it will request a compatible REQUEST pad by looking
1077 * at the templates of @element.
1079 * Returns: (transfer full): the #GstPad to which a link can be made, or %NULL
1080 * if one cannot be found. gst_object_unref() after usage.
1083 gst_element_get_compatible_pad (GstElement * element, GstPad * pad,
1084 const GstCaps * caps)
1087 GstPadTemplate *templ;
1089 GstPad *foundpad = NULL;
1092 g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
1093 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1095 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1096 "finding pad in %s compatible with %s:%s",
1097 GST_ELEMENT_NAME (element), GST_DEBUG_PAD_NAME (pad));
1099 g_return_val_if_fail (GST_PAD_PEER (pad) == NULL, NULL);
1103 /* try to get an existing unlinked pad */
1104 if (GST_PAD_IS_SRC (pad)) {
1105 pads = gst_element_iterate_sink_pads (element);
1106 } else if (GST_PAD_IS_SINK (pad)) {
1107 pads = gst_element_iterate_src_pads (element);
1109 pads = gst_element_iterate_pads (element);
1115 switch (gst_iterator_next (pads, &padptr)) {
1116 case GST_ITERATOR_OK:
1123 current = GST_PAD (padptr);
1125 GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
1126 GST_DEBUG_PAD_NAME (current));
1128 if (GST_PAD_IS_SRC (current)) {
1135 peer = gst_pad_get_peer (current);
1137 if (peer == NULL && gst_pad_check_link (srcpad, sinkpad)) {
1138 GstCaps *temp, *intersection;
1139 gboolean compatible;
1141 /* Now check if the two pads' caps are compatible */
1142 temp = gst_pad_get_caps_reffed (pad);
1144 intersection = gst_caps_intersect (temp, caps);
1145 gst_caps_unref (temp);
1147 intersection = temp;
1150 temp = gst_pad_get_caps_reffed (current);
1151 compatible = gst_caps_can_intersect (temp, intersection);
1152 gst_caps_unref (temp);
1153 gst_caps_unref (intersection);
1156 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1157 "found existing unlinked compatible pad %s:%s",
1158 GST_DEBUG_PAD_NAME (current));
1159 gst_iterator_free (pads);
1163 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "incompatible pads");
1166 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1167 "already linked or cannot be linked (peer = %p)", peer);
1169 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unreffing pads");
1171 gst_object_unref (current);
1173 gst_object_unref (peer);
1176 case GST_ITERATOR_DONE:
1179 case GST_ITERATOR_RESYNC:
1180 gst_iterator_resync (pads);
1182 case GST_ITERATOR_ERROR:
1183 g_assert_not_reached ();
1187 gst_iterator_free (pads);
1189 GST_CAT_DEBUG_OBJECT (GST_CAT_ELEMENT_PADS, element,
1190 "Could not find a compatible unlinked always pad to link to %s:%s, now checking request pads",
1191 GST_DEBUG_PAD_NAME (pad));
1193 /* try to create a new one */
1194 /* requesting is a little crazy, we need a template. Let's create one */
1195 /* FIXME: why not gst_pad_get_pad_template (pad); */
1196 templcaps = gst_pad_get_caps_reffed (pad);
1198 templ = gst_pad_template_new ((gchar *) GST_PAD_NAME (pad),
1199 GST_PAD_DIRECTION (pad), GST_PAD_ALWAYS, templcaps);
1201 foundpad = gst_element_request_compatible_pad (element, templ);
1202 gst_object_unref (templ);
1205 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1206 "found existing request pad %s:%s", GST_DEBUG_PAD_NAME (foundpad));
1210 GST_CAT_INFO_OBJECT (GST_CAT_ELEMENT_PADS, element,
1211 "Could not find a compatible pad to link to %s:%s",
1212 GST_DEBUG_PAD_NAME (pad));
1217 * gst_element_state_get_name:
1218 * @state: a #GstState to get the name of.
1220 * Gets a string representing the given state.
1222 * Returns: (transfer none): a string with the name of the state.
1224 G_CONST_RETURN gchar *
1225 gst_element_state_get_name (GstState state)
1228 case GST_STATE_VOID_PENDING:
1229 return "VOID_PENDING";
1230 case GST_STATE_NULL:
1232 case GST_STATE_READY:
1234 case GST_STATE_PLAYING:
1236 case GST_STATE_PAUSED:
1239 /* This is a memory leak */
1240 return g_strdup_printf ("UNKNOWN!(%d)", state);
1245 * gst_element_state_change_return_get_name:
1246 * @state_ret: a #GstStateChangeReturn to get the name of.
1248 * Gets a string representing the given state change result.
1250 * Returns: (transfer none): a string with the name of the state
1255 G_CONST_RETURN gchar *
1256 gst_element_state_change_return_get_name (GstStateChangeReturn state_ret)
1258 switch (state_ret) {
1259 case GST_STATE_CHANGE_FAILURE:
1261 case GST_STATE_CHANGE_SUCCESS:
1263 case GST_STATE_CHANGE_ASYNC:
1265 case GST_STATE_CHANGE_NO_PREROLL:
1266 return "NO PREROLL";
1268 /* This is a memory leak */
1269 return g_strdup_printf ("UNKNOWN!(%d)", state_ret);
1275 * gst_element_factory_can_src_caps:
1276 * @factory: factory to query
1277 * @caps: the caps to check
1279 * Checks if the factory can source the given capability.
1281 * Returns: true if it can src the capabilities
1284 gst_element_factory_can_src_caps (GstElementFactory * factory,
1285 const GstCaps * caps)
1289 g_return_val_if_fail (factory != NULL, FALSE);
1290 g_return_val_if_fail (caps != NULL, FALSE);
1292 templates = factory->staticpadtemplates;
1295 GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1297 if (template->direction == GST_PAD_SRC) {
1298 if (gst_caps_is_always_compatible (gst_static_caps_get
1299 (&template->static_caps), caps))
1302 templates = g_list_next (templates);
1309 * gst_element_factory_can_sink_caps:
1310 * @factory: factory to query
1311 * @caps: the caps to check
1313 * Checks if the factory can sink the given capability.
1315 * Returns: true if it can sink the capabilities
1318 gst_element_factory_can_sink_caps (GstElementFactory * factory,
1319 const GstCaps * caps)
1323 g_return_val_if_fail (factory != NULL, FALSE);
1324 g_return_val_if_fail (caps != NULL, FALSE);
1326 templates = factory->staticpadtemplates;
1329 GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1331 if (template->direction == GST_PAD_SINK) {
1332 if (gst_caps_is_always_compatible (caps,
1333 gst_static_caps_get (&template->static_caps)))
1336 templates = g_list_next (templates);
1343 /* if return val is true, *direct_child is a caller-owned ref on the direct
1344 * child of ancestor that is part of object's ancestry */
1346 object_has_ancestor (GstObject * object, GstObject * ancestor,
1347 GstObject ** direct_child)
1349 GstObject *child, *parent;
1352 *direct_child = NULL;
1354 child = gst_object_ref (object);
1355 parent = gst_object_get_parent (object);
1358 if (ancestor == parent) {
1360 *direct_child = child;
1362 gst_object_unref (child);
1363 gst_object_unref (parent);
1367 gst_object_unref (child);
1369 parent = gst_object_get_parent (parent);
1372 gst_object_unref (child);
1377 /* caller owns return */
1379 find_common_root (GstObject * o1, GstObject * o2)
1381 GstObject *top = o1;
1382 GstObject *kid1, *kid2;
1383 GstObject *root = NULL;
1385 while (GST_OBJECT_PARENT (top))
1386 top = GST_OBJECT_PARENT (top);
1388 /* the itsy-bitsy spider... */
1390 if (!object_has_ancestor (o2, top, &kid2))
1393 root = gst_object_ref (top);
1395 if (!object_has_ancestor (o1, kid2, &kid1)) {
1396 gst_object_unref (kid2);
1400 if (!object_has_ancestor (o2, kid1, &kid2)) {
1401 gst_object_unref (kid1);
1408 /* caller does not own return */
1410 ghost_up (GstElement * e, GstPad * pad)
1412 static gint ghost_pad_index = 0;
1417 GstObject *parent = GST_OBJECT_PARENT (e);
1419 name = g_strdup_printf ("ghost%d", ghost_pad_index++);
1420 gpad = gst_ghost_pad_new (name, pad);
1424 gst_element_get_state (e, ¤t, &next, 0);
1426 if (current > GST_STATE_READY || next == GST_STATE_PAUSED)
1427 gst_pad_set_active (gpad, TRUE);
1429 if (!gst_element_add_pad ((GstElement *) parent, gpad)) {
1430 g_warning ("Pad named %s already exists in element %s\n",
1431 GST_OBJECT_NAME (gpad), GST_OBJECT_NAME (parent));
1432 gst_object_unref ((GstObject *) gpad);
1433 GST_STATE_UNLOCK (e);
1436 GST_STATE_UNLOCK (e);
1442 remove_pad (gpointer ppad, gpointer unused)
1446 if (!gst_element_remove_pad ((GstElement *) GST_OBJECT_PARENT (pad), pad))
1447 g_warning ("Couldn't remove pad %s from element %s",
1448 GST_OBJECT_NAME (pad), GST_OBJECT_NAME (GST_OBJECT_PARENT (pad)));
1452 prepare_link_maybe_ghosting (GstPad ** src, GstPad ** sink,
1453 GSList ** pads_created)
1457 GSList *pads_created_local = NULL;
1459 g_assert (pads_created);
1461 e1 = GST_OBJECT_PARENT (*src);
1462 e2 = GST_OBJECT_PARENT (*sink);
1464 if (G_UNLIKELY (e1 == NULL)) {
1465 GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1466 GST_PTR_FORMAT, *src);
1469 if (G_UNLIKELY (e2 == NULL)) {
1470 GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1471 GST_PTR_FORMAT, *sink);
1475 if (GST_OBJECT_PARENT (e1) == GST_OBJECT_PARENT (e2)) {
1476 GST_CAT_INFO (GST_CAT_PADS, "%s and %s in same bin, no need for ghost pads",
1477 GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1481 GST_CAT_INFO (GST_CAT_PADS, "%s and %s not in same bin, making ghost pads",
1482 GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1484 /* we need to setup some ghost pads */
1485 root = find_common_root (e1, e2);
1487 g_warning ("Trying to connect elements that don't share a common "
1488 "ancestor: %s and %s", GST_ELEMENT_NAME (e1), GST_ELEMENT_NAME (e2));
1492 while (GST_OBJECT_PARENT (e1) != root) {
1493 *src = ghost_up ((GstElement *) e1, *src);
1496 e1 = GST_OBJECT_PARENT (*src);
1497 pads_created_local = g_slist_prepend (pads_created_local, *src);
1499 while (GST_OBJECT_PARENT (e2) != root) {
1500 *sink = ghost_up ((GstElement *) e2, *sink);
1503 e2 = GST_OBJECT_PARENT (*sink);
1504 pads_created_local = g_slist_prepend (pads_created_local, *sink);
1507 gst_object_unref (root);
1508 *pads_created = g_slist_concat (*pads_created, pads_created_local);
1512 gst_object_unref (root);
1513 g_slist_foreach (pads_created_local, remove_pad, NULL);
1514 g_slist_free (pads_created_local);
1519 pad_link_maybe_ghosting (GstPad * src, GstPad * sink, GstPadLinkCheck flags)
1521 GSList *pads_created = NULL;
1524 if (!prepare_link_maybe_ghosting (&src, &sink, &pads_created)) {
1527 ret = (gst_pad_link_full (src, sink, flags) == GST_PAD_LINK_OK);
1531 g_slist_foreach (pads_created, remove_pad, NULL);
1533 g_slist_free (pads_created);
1539 * gst_element_link_pads_full:
1540 * @src: a #GstElement containing the source pad.
1541 * @srcpadname: (allow-none): the name of the #GstPad in source element
1542 * or NULL for any pad.
1543 * @dest: (transfer none): the #GstElement containing the destination pad.
1544 * @destpadname: (allow-none): the name of the #GstPad in destination element,
1545 * or NULL for any pad.
1546 * @flags: the #GstPadLinkCheck to be performed when linking pads.
1548 * Links the two named pads of the source and destination elements.
1549 * Side effect is that if one of the pads has no parent, it becomes a
1550 * child of the parent of the other element. If they have different
1551 * parents, the link fails.
1553 * Calling gst_element_link_pads_full() with @flags == %GST_PAD_LINK_CHECK_DEFAULT
1554 * is the same as calling gst_element_link_pads() and the recommended way of
1555 * linking pads with safety checks applied.
1557 * This is a convenience function for gst_pad_link_full().
1559 * Returns: TRUE if the pads could be linked, FALSE otherwise.
1564 gst_element_link_pads_full (GstElement * src, const gchar * srcpadname,
1565 GstElement * dest, const gchar * destpadname, GstPadLinkCheck flags)
1567 const GList *srcpads, *destpads, *srctempls, *desttempls, *l;
1568 GstPad *srcpad, *destpad;
1569 GstPadTemplate *srctempl, *desttempl;
1570 GstElementClass *srcclass, *destclass;
1573 g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1574 g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1576 GST_CAT_INFO (GST_CAT_ELEMENT_PADS,
1577 "trying to link element %s:%s to element %s:%s", GST_ELEMENT_NAME (src),
1578 srcpadname ? srcpadname : "(any)", GST_ELEMENT_NAME (dest),
1579 destpadname ? destpadname : "(any)");
1583 /* name specified, look it up */
1584 if (!(srcpad = gst_element_get_static_pad (src, srcpadname)))
1585 srcpad = gst_element_get_request_pad (src, srcpadname);
1587 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1588 GST_ELEMENT_NAME (src), srcpadname);
1591 if (!(GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC)) {
1592 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no src pad",
1593 GST_DEBUG_PAD_NAME (srcpad));
1594 gst_object_unref (srcpad);
1597 if (GST_PAD_PEER (srcpad) != NULL) {
1598 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1599 "pad %s:%s is already linked to %s:%s", GST_DEBUG_PAD_NAME (srcpad),
1600 GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
1601 gst_object_unref (srcpad);
1607 /* no name given, get the first available pad */
1608 GST_OBJECT_LOCK (src);
1609 srcpads = GST_ELEMENT_PADS (src);
1610 srcpad = srcpads ? GST_PAD_CAST (srcpads->data) : NULL;
1612 gst_object_ref (srcpad);
1613 GST_OBJECT_UNLOCK (src);
1616 /* get a destination pad */
1618 /* name specified, look it up */
1619 if (!(destpad = gst_element_get_static_pad (dest, destpadname)))
1620 destpad = gst_element_get_request_pad (dest, destpadname);
1622 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1623 GST_ELEMENT_NAME (dest), destpadname);
1626 if (!(GST_PAD_DIRECTION (destpad) == GST_PAD_SINK)) {
1627 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no sink pad",
1628 GST_DEBUG_PAD_NAME (destpad));
1629 gst_object_unref (destpad);
1632 if (GST_PAD_PEER (destpad) != NULL) {
1633 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1634 "pad %s:%s is already linked to %s:%s",
1635 GST_DEBUG_PAD_NAME (destpad),
1636 GST_DEBUG_PAD_NAME (GST_PAD_PEER (destpad)));
1637 gst_object_unref (destpad);
1643 /* no name given, get the first available pad */
1644 GST_OBJECT_LOCK (dest);
1645 destpads = GST_ELEMENT_PADS (dest);
1646 destpad = destpads ? GST_PAD_CAST (destpads->data) : NULL;
1648 gst_object_ref (destpad);
1649 GST_OBJECT_UNLOCK (dest);
1652 if (srcpadname && destpadname) {
1655 /* two explicitly specified pads */
1656 result = pad_link_maybe_ghosting (srcpad, destpad, flags);
1658 gst_object_unref (srcpad);
1659 gst_object_unref (destpad);
1665 /* loop through the allowed pads in the source, trying to find a
1666 * compatible destination pad */
1667 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1668 "looping through allowed src and dest pads");
1670 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying src pad %s:%s",
1671 GST_DEBUG_PAD_NAME (srcpad));
1672 if ((GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC) &&
1673 (GST_PAD_PEER (srcpad) == NULL)) {
1678 gst_object_ref (temp);
1680 temp = gst_element_get_compatible_pad (dest, srcpad, NULL);
1683 if (temp && pad_link_maybe_ghosting (srcpad, temp, flags)) {
1684 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1685 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (temp));
1687 gst_object_unref (destpad);
1688 gst_object_unref (srcpad);
1689 gst_object_unref (temp);
1694 gst_object_unref (temp);
1697 /* find a better way for this mess */
1699 srcpads = g_list_next (srcpads);
1701 gst_object_unref (srcpad);
1702 srcpad = GST_PAD_CAST (srcpads->data);
1703 gst_object_ref (srcpad);
1709 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s:%s to %s",
1710 GST_DEBUG_PAD_NAME (srcpad), GST_ELEMENT_NAME (dest));
1712 gst_object_unref (destpad);
1716 gst_object_unref (srcpad);
1720 /* loop through the existing pads in the destination */
1722 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying dest pad %s:%s",
1723 GST_DEBUG_PAD_NAME (destpad));
1724 if ((GST_PAD_DIRECTION (destpad) == GST_PAD_SINK) &&
1725 (GST_PAD_PEER (destpad) == NULL)) {
1726 GstPad *temp = gst_element_get_compatible_pad (src, destpad, NULL);
1728 if (temp && pad_link_maybe_ghosting (temp, destpad, flags)) {
1729 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1730 GST_DEBUG_PAD_NAME (temp), GST_DEBUG_PAD_NAME (destpad));
1731 gst_object_unref (temp);
1732 gst_object_unref (destpad);
1736 gst_object_unref (temp);
1740 destpads = g_list_next (destpads);
1742 gst_object_unref (destpad);
1743 destpad = GST_PAD_CAST (destpads->data);
1744 gst_object_ref (destpad);
1751 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s:%s",
1752 GST_ELEMENT_NAME (src), GST_DEBUG_PAD_NAME (destpad));
1753 gst_object_unref (destpad);
1757 gst_object_unref (destpad);
1761 srcclass = GST_ELEMENT_GET_CLASS (src);
1762 destclass = GST_ELEMENT_GET_CLASS (dest);
1764 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1765 "we might have request pads on both sides, checking...");
1766 srctempls = gst_element_class_get_pad_template_list (srcclass);
1767 desttempls = gst_element_class_get_pad_template_list (destclass);
1769 if (srctempls && desttempls) {
1771 srctempl = (GstPadTemplate *) srctempls->data;
1772 if (srctempl->presence == GST_PAD_REQUEST) {
1773 for (l = desttempls; l; l = l->next) {
1774 desttempl = (GstPadTemplate *) l->data;
1775 if (desttempl->presence == GST_PAD_REQUEST &&
1776 desttempl->direction != srctempl->direction) {
1777 if (gst_caps_is_always_compatible (gst_pad_template_get_caps
1778 (srctempl), gst_pad_template_get_caps (desttempl))) {
1780 gst_element_request_pad (src, srctempl,
1781 srctempl->name_template, NULL);
1783 gst_element_request_pad (dest, desttempl,
1784 desttempl->name_template, NULL);
1785 if (srcpad && destpad
1786 && pad_link_maybe_ghosting (srcpad, destpad, flags)) {
1787 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1788 "linked pad %s:%s to pad %s:%s",
1789 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (destpad));
1790 gst_object_unref (srcpad);
1791 gst_object_unref (destpad);
1794 /* it failed, so we release the request pads */
1796 gst_element_release_request_pad (src, srcpad);
1798 gst_element_release_request_pad (dest, destpad);
1803 srctempls = srctempls->next;
1807 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s",
1808 GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
1813 * gst_element_link_pads:
1814 * @src: a #GstElement containing the source pad.
1815 * @srcpadname: (allow-none): the name of the #GstPad in source element
1816 * or NULL for any pad.
1817 * @dest: (transfer none): the #GstElement containing the destination pad.
1818 * @destpadname: (allow-none): the name of the #GstPad in destination element,
1819 * or NULL for any pad.
1821 * Links the two named pads of the source and destination elements.
1822 * Side effect is that if one of the pads has no parent, it becomes a
1823 * child of the parent of the other element. If they have different
1824 * parents, the link fails.
1826 * Returns: TRUE if the pads could be linked, FALSE otherwise.
1829 gst_element_link_pads (GstElement * src, const gchar * srcpadname,
1830 GstElement * dest, const gchar * destpadname)
1832 return gst_element_link_pads_full (src, srcpadname, dest, destpadname,
1833 GST_PAD_LINK_CHECK_DEFAULT);
1837 * gst_element_link_pads_filtered:
1838 * @src: a #GstElement containing the source pad.
1839 * @srcpadname: (allow-none): the name of the #GstPad in source element
1840 * or NULL for any pad.
1841 * @dest: (transfer none): the #GstElement containing the destination pad.
1842 * @destpadname: (allow-none): the name of the #GstPad in destination element
1843 * or NULL for any pad.
1844 * @filter: (transfer none) (allow-none): the #GstCaps to filter the link,
1845 * or #NULL for no filter.
1847 * Links the two named pads of the source and destination elements. Side effect
1848 * is that if one of the pads has no parent, it becomes a child of the parent of
1849 * the other element. If they have different parents, the link fails. If @caps
1850 * is not #NULL, makes sure that the caps of the link is a subset of @caps.
1852 * Returns: TRUE if the pads could be linked, FALSE otherwise.
1855 gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
1856 GstElement * dest, const gchar * destpadname, GstCaps * filter)
1859 g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1860 g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1861 g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), FALSE);
1864 GstElement *capsfilter;
1866 GstState state, pending;
1869 capsfilter = gst_element_factory_make ("capsfilter", NULL);
1871 GST_ERROR ("Could not make a capsfilter");
1875 parent = gst_object_get_parent (GST_OBJECT (src));
1876 g_return_val_if_fail (GST_IS_BIN (parent), FALSE);
1878 gst_element_get_state (GST_ELEMENT_CAST (parent), &state, &pending, 0);
1880 if (!gst_bin_add (GST_BIN (parent), capsfilter)) {
1881 GST_ERROR ("Could not add capsfilter");
1882 gst_object_unref (capsfilter);
1883 gst_object_unref (parent);
1887 if (pending != GST_STATE_VOID_PENDING)
1890 gst_element_set_state (capsfilter, state);
1892 gst_object_unref (parent);
1894 g_object_set (capsfilter, "caps", filter, NULL);
1896 lr1 = gst_element_link_pads (src, srcpadname, capsfilter, "sink");
1897 lr2 = gst_element_link_pads (capsfilter, "src", dest, destpadname);
1902 GST_INFO ("Could not link pads: %s:%s - capsfilter:sink",
1903 GST_ELEMENT_NAME (src), srcpadname);
1905 GST_INFO ("Could not link pads: capsfilter:src - %s:%s",
1906 GST_ELEMENT_NAME (dest), destpadname);
1908 gst_element_set_state (capsfilter, GST_STATE_NULL);
1909 /* this will unlink and unref as appropriate */
1910 gst_bin_remove (GST_BIN (GST_OBJECT_PARENT (capsfilter)), capsfilter);
1914 if (gst_element_link_pads (src, srcpadname, dest, destpadname)) {
1917 GST_INFO ("Could not link pads: %s:%s - %s:%s", GST_ELEMENT_NAME (src),
1918 srcpadname, GST_ELEMENT_NAME (dest), destpadname);
1926 * @src: (transfer none): a #GstElement containing the source pad.
1927 * @dest: (transfer none): the #GstElement containing the destination pad.
1929 * Links @src to @dest. The link must be from source to
1930 * destination; the other direction will not be tried. The function looks for
1931 * existing pads that aren't linked yet. It will request new pads if necessary.
1932 * Such pads need to be released manualy when unlinking.
1933 * If multiple links are possible, only one is established.
1935 * Make sure you have added your elements to a bin or pipeline with
1936 * gst_bin_add() before trying to link them.
1938 * Returns: TRUE if the elements could be linked, FALSE otherwise.
1941 gst_element_link (GstElement * src, GstElement * dest)
1943 return gst_element_link_pads (src, NULL, dest, NULL);
1947 * gst_element_link_many:
1948 * @element_1: (transfer none): the first #GstElement in the link chain.
1949 * @element_2: (transfer none): the second #GstElement in the link chain.
1950 * @...: the NULL-terminated list of elements to link in order.
1952 * Chain together a series of elements. Uses gst_element_link().
1953 * Make sure you have added your elements to a bin or pipeline with
1954 * gst_bin_add() before trying to link them.
1956 * Returns: TRUE on success, FALSE otherwise.
1959 gst_element_link_many (GstElement * element_1, GstElement * element_2, ...)
1961 gboolean res = TRUE;
1964 g_return_val_if_fail (GST_IS_ELEMENT (element_1), FALSE);
1965 g_return_val_if_fail (GST_IS_ELEMENT (element_2), FALSE);
1967 va_start (args, element_2);
1970 if (!gst_element_link (element_1, element_2)) {
1975 element_1 = element_2;
1976 element_2 = va_arg (args, GstElement *);
1985 * gst_element_link_filtered:
1986 * @src: a #GstElement containing the source pad.
1987 * @dest: (transfer none): the #GstElement containing the destination pad.
1988 * @filter: (transfer none) (allow-none): the #GstCaps to filter the link,
1989 * or #NULL for no filter.
1991 * Links @src to @dest using the given caps as filtercaps.
1992 * The link must be from source to
1993 * destination; the other direction will not be tried. The function looks for
1994 * existing pads that aren't linked yet. It will request new pads if necessary.
1995 * If multiple links are possible, only one is established.
1997 * Make sure you have added your elements to a bin or pipeline with
1998 * gst_bin_add() before trying to link them.
2000 * Returns: TRUE if the pads could be linked, FALSE otherwise.
2003 gst_element_link_filtered (GstElement * src, GstElement * dest,
2006 return gst_element_link_pads_filtered (src, NULL, dest, NULL, filter);
2010 * gst_element_unlink_pads:
2011 * @src: a (transfer none): #GstElement containing the source pad.
2012 * @srcpadname: the name of the #GstPad in source element.
2013 * @dest: (transfer none): a #GstElement containing the destination pad.
2014 * @destpadname: the name of the #GstPad in destination element.
2016 * Unlinks the two named pads of the source and destination elements.
2018 * This is a convenience function for gst_pad_unlink().
2021 gst_element_unlink_pads (GstElement * src, const gchar * srcpadname,
2022 GstElement * dest, const gchar * destpadname)
2024 GstPad *srcpad, *destpad;
2025 gboolean srcrequest, destrequest;
2027 srcrequest = destrequest = FALSE;
2029 g_return_if_fail (src != NULL);
2030 g_return_if_fail (GST_IS_ELEMENT (src));
2031 g_return_if_fail (srcpadname != NULL);
2032 g_return_if_fail (dest != NULL);
2033 g_return_if_fail (GST_IS_ELEMENT (dest));
2034 g_return_if_fail (destpadname != NULL);
2036 /* obtain the pads requested */
2037 if (!(srcpad = gst_element_get_static_pad (src, srcpadname)))
2038 if ((srcpad = gst_element_get_request_pad (src, srcpadname)))
2040 if (srcpad == NULL) {
2041 GST_WARNING_OBJECT (src, "source element has no pad \"%s\"", srcpadname);
2044 if (!(destpad = gst_element_get_static_pad (dest, destpadname)))
2045 if ((destpad = gst_element_get_request_pad (dest, destpadname)))
2047 if (destpad == NULL) {
2048 GST_WARNING_OBJECT (dest, "destination element has no pad \"%s\"",
2053 /* we're satisified they can be unlinked, let's do it */
2054 gst_pad_unlink (srcpad, destpad);
2057 gst_element_release_request_pad (dest, destpad);
2058 gst_object_unref (destpad);
2062 gst_element_release_request_pad (src, srcpad);
2063 gst_object_unref (srcpad);
2067 * gst_element_unlink_many:
2068 * @element_1: (transfer none): the first #GstElement in the link chain.
2069 * @element_2: (transfer none): the second #GstElement in the link chain.
2070 * @...: the NULL-terminated list of elements to unlink in order.
2072 * Unlinks a series of elements. Uses gst_element_unlink().
2075 gst_element_unlink_many (GstElement * element_1, GstElement * element_2, ...)
2079 g_return_if_fail (element_1 != NULL && element_2 != NULL);
2080 g_return_if_fail (GST_IS_ELEMENT (element_1) && GST_IS_ELEMENT (element_2));
2082 va_start (args, element_2);
2085 gst_element_unlink (element_1, element_2);
2087 element_1 = element_2;
2088 element_2 = va_arg (args, GstElement *);
2095 * gst_element_unlink:
2096 * @src: (transfer none): the source #GstElement to unlink.
2097 * @dest: (transfer none): the sink #GstElement to unlink.
2099 * Unlinks all source pads of the source element with all sink pads
2100 * of the sink element to which they are linked.
2102 * If the link has been made using gst_element_link(), it could have created an
2103 * requestpad, which has to be released using gst_element_release_request_pad().
2106 gst_element_unlink (GstElement * src, GstElement * dest)
2109 gboolean done = FALSE;
2111 g_return_if_fail (GST_IS_ELEMENT (src));
2112 g_return_if_fail (GST_IS_ELEMENT (dest));
2114 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unlinking \"%s\" and \"%s\"",
2115 GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
2117 pads = gst_element_iterate_pads (src);
2121 switch (gst_iterator_next (pads, &data)) {
2122 case GST_ITERATOR_OK:
2124 GstPad *pad = GST_PAD_CAST (data);
2126 if (GST_PAD_IS_SRC (pad)) {
2127 GstPad *peerpad = gst_pad_get_peer (pad);
2129 /* see if the pad is linked and is really a pad of dest */
2131 GstElement *peerelem;
2133 peerelem = gst_pad_get_parent_element (peerpad);
2135 if (peerelem == dest) {
2136 gst_pad_unlink (pad, peerpad);
2139 gst_object_unref (peerelem);
2141 gst_object_unref (peerpad);
2144 gst_object_unref (pad);
2147 case GST_ITERATOR_RESYNC:
2148 gst_iterator_resync (pads);
2150 case GST_ITERATOR_DONE:
2154 g_assert_not_reached ();
2158 gst_iterator_free (pads);
2162 * gst_element_query_position:
2163 * @element: a #GstElement to invoke the position query on.
2164 * @format: (inout): a pointer to the #GstFormat asked for.
2165 * On return contains the #GstFormat used.
2166 * @cur: (out) (allow-none): a location in which to store the current
2167 * position, or NULL.
2169 * Queries an element for the stream position. If one repeatedly calls this
2170 * function one can also create and reuse it in gst_element_query().
2172 * Returns: TRUE if the query could be performed.
2175 gst_element_query_position (GstElement * element, GstFormat * format,
2181 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2182 g_return_val_if_fail (format != NULL, FALSE);
2184 query = gst_query_new_position (*format);
2185 ret = gst_element_query (element, query);
2188 gst_query_parse_position (query, format, cur);
2190 gst_query_unref (query);
2196 * gst_element_query_duration:
2197 * @element: a #GstElement to invoke the duration query on.
2198 * @format: (inout): a pointer to the #GstFormat asked for.
2199 * On return contains the #GstFormat used.
2200 * @duration: (out): A location in which to store the total duration, or NULL.
2202 * Queries an element for the total stream duration.
2204 * Returns: TRUE if the query could be performed.
2207 gst_element_query_duration (GstElement * element, GstFormat * format,
2213 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2214 g_return_val_if_fail (format != NULL, FALSE);
2216 query = gst_query_new_duration (*format);
2217 ret = gst_element_query (element, query);
2220 gst_query_parse_duration (query, format, duration);
2222 gst_query_unref (query);
2228 * gst_element_query_convert:
2229 * @element: a #GstElement to invoke the convert query on.
2230 * @src_format: (inout): a #GstFormat to convert from.
2231 * @src_val: a value to convert.
2232 * @dest_format: (inout): a pointer to the #GstFormat to convert to.
2233 * @dest_val: (out): a pointer to the result.
2235 * Queries an element to convert @src_val in @src_format to @dest_format.
2237 * Returns: TRUE if the query could be performed.
2240 gst_element_query_convert (GstElement * element, GstFormat src_format,
2241 gint64 src_val, GstFormat * dest_format, gint64 * dest_val)
2246 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2247 g_return_val_if_fail (dest_format != NULL, FALSE);
2248 g_return_val_if_fail (dest_val != NULL, FALSE);
2250 if (*dest_format == src_format || src_val == -1) {
2251 *dest_val = src_val;
2255 query = gst_query_new_convert (src_format, src_val, *dest_format);
2256 ret = gst_element_query (element, query);
2259 gst_query_parse_convert (query, NULL, NULL, dest_format, dest_val);
2261 gst_query_unref (query);
2267 * gst_element_seek_simple
2268 * @element: a #GstElement to seek on
2269 * @format: a #GstFormat to execute the seek in, such as #GST_FORMAT_TIME
2270 * @seek_flags: seek options; playback applications will usually want to use
2271 * GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_KEY_UNIT here
2272 * @seek_pos: position to seek to (relative to the start); if you are doing
2273 * a seek in #GST_FORMAT_TIME this value is in nanoseconds -
2274 * multiply with #GST_SECOND to convert seconds to nanoseconds or
2275 * with #GST_MSECOND to convert milliseconds to nanoseconds.
2277 * Simple API to perform a seek on the given element, meaning it just seeks
2278 * to the given position relative to the start of the stream. For more complex
2279 * operations like segment seeks (e.g. for looping) or changing the playback
2280 * rate or seeking relative to the last configured playback segment you should
2281 * use gst_element_seek().
2283 * In a completely prerolled PAUSED or PLAYING pipeline, seeking is always
2284 * guaranteed to return %TRUE on a seekable media type or %FALSE when the media
2285 * type is certainly not seekable (such as a live stream).
2287 * Some elements allow for seeking in the READY state, in this
2288 * case they will store the seek event and execute it when they are put to
2289 * PAUSED. If the element supports seek in READY, it will always return %TRUE when
2290 * it receives the event in the READY state.
2292 * Returns: %TRUE if the seek operation succeeded (the seek might not always be
2293 * executed instantly though)
2298 gst_element_seek_simple (GstElement * element, GstFormat format,
2299 GstSeekFlags seek_flags, gint64 seek_pos)
2301 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2302 g_return_val_if_fail (seek_pos >= 0, FALSE);
2304 return gst_element_seek (element, 1.0, format, seek_flags,
2305 GST_SEEK_TYPE_SET, seek_pos, GST_SEEK_TYPE_NONE, 0);
2309 * gst_pad_use_fixed_caps:
2310 * @pad: the pad to use
2312 * A helper function you can use that sets the
2313 * @gst_pad_get_fixed_caps_func as the getcaps function for the
2314 * pad. This way the function will always return the negotiated caps
2315 * or in case the pad is not negotiated, the padtemplate caps.
2317 * Use this function on a pad that, once gst_pad_set_caps() has been called
2318 * on it, cannot be renegotiated to something else.
2321 gst_pad_use_fixed_caps (GstPad * pad)
2323 gst_pad_set_getcaps_function (pad, gst_pad_get_fixed_caps_func);
2327 * gst_pad_get_fixed_caps_func:
2328 * @pad: the pad to use
2330 * A helper function you can use as a GetCaps function that
2331 * will return the currently negotiated caps or the padtemplate
2334 * Free-function: gst_caps_unref
2336 * Returns: (transfer full): the currently negotiated caps or the padtemplate.
2339 gst_pad_get_fixed_caps_func (GstPad * pad)
2343 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2345 GST_OBJECT_LOCK (pad);
2346 if (GST_PAD_CAPS (pad)) {
2347 result = GST_PAD_CAPS (pad);
2349 GST_CAT_DEBUG (GST_CAT_CAPS,
2350 "using pad caps %p %" GST_PTR_FORMAT, result, result);
2352 result = gst_caps_ref (result);
2353 } else if (GST_PAD_PAD_TEMPLATE (pad)) {
2354 GstPadTemplate *templ = GST_PAD_PAD_TEMPLATE (pad);
2356 result = GST_PAD_TEMPLATE_CAPS (templ);
2357 GST_CAT_DEBUG (GST_CAT_CAPS,
2358 "using pad template %p with caps %p %" GST_PTR_FORMAT, templ, result,
2361 result = gst_caps_ref (result);
2363 GST_CAT_DEBUG (GST_CAT_CAPS, "pad has no caps");
2364 result = gst_caps_new_empty ();
2366 GST_OBJECT_UNLOCK (pad);
2372 * gst_pad_get_parent_element:
2375 * Gets the parent of @pad, cast to a #GstElement. If a @pad has no parent or
2376 * its parent is not an element, return NULL.
2378 * Returns: (transfer full): the parent of the pad. The caller has a
2379 * reference on the parent, so unref when you're finished with it.
2384 gst_pad_get_parent_element (GstPad * pad)
2388 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2390 p = gst_object_get_parent (GST_OBJECT_CAST (pad));
2392 if (p && !GST_IS_ELEMENT (p)) {
2393 gst_object_unref (p);
2396 return GST_ELEMENT_CAST (p);
2400 * gst_object_default_error:
2401 * @source: the #GstObject that initiated the error.
2402 * @error: (in): the GError.
2403 * @debug: (in) (allow-none): an additional debug information string, or NULL
2405 * A default error function.
2407 * The default handler will simply print the error string using g_print.
2410 gst_object_default_error (GstObject * source, const GError * error,
2411 const gchar * debug)
2413 gchar *name = gst_object_get_path_string (source);
2415 /* FIXME 0.11: should change this to g_printerr() */
2416 g_print (_("ERROR: from element %s: %s\n"), name, error->message);
2418 g_print (_("Additional debug info:\n%s\n"), debug);
2426 * @element_1: (transfer full): the #GstElement element to add to the bin
2427 * @...: (transfer full): additional elements to add to the bin
2429 * Adds a NULL-terminated list of elements to a bin. This function is
2430 * equivalent to calling gst_bin_add() for each member of the list. The return
2431 * value of each gst_bin_add() is ignored.
2434 gst_bin_add_many (GstBin * bin, GstElement * element_1, ...)
2438 g_return_if_fail (GST_IS_BIN (bin));
2439 g_return_if_fail (GST_IS_ELEMENT (element_1));
2441 va_start (args, element_1);
2444 gst_bin_add (bin, element_1);
2446 element_1 = va_arg (args, GstElement *);
2453 * gst_bin_remove_many:
2455 * @element_1: (transfer none): the first #GstElement to remove from the bin
2456 * @...: (transfer none): NULL-terminated list of elements to remove from the bin
2458 * Remove a list of elements from a bin. This function is equivalent
2459 * to calling gst_bin_remove() with each member of the list.
2462 gst_bin_remove_many (GstBin * bin, GstElement * element_1, ...)
2466 g_return_if_fail (GST_IS_BIN (bin));
2467 g_return_if_fail (GST_IS_ELEMENT (element_1));
2469 va_start (args, element_1);
2472 gst_bin_remove (bin, element_1);
2474 element_1 = va_arg (args, GstElement *);
2481 gst_element_populate_std_props (GObjectClass * klass, const gchar * prop_name,
2482 guint arg_id, GParamFlags flags)
2484 GQuark prop_id = g_quark_from_string (prop_name);
2487 static GQuark fd_id = 0;
2488 static GQuark blocksize_id;
2489 static GQuark bytesperread_id;
2490 static GQuark dump_id;
2491 static GQuark filesize_id;
2492 static GQuark mmapsize_id;
2493 static GQuark location_id;
2494 static GQuark offset_id;
2495 static GQuark silent_id;
2496 static GQuark touch_id;
2498 flags |= G_PARAM_STATIC_STRINGS;
2501 fd_id = g_quark_from_static_string ("fd");
2502 blocksize_id = g_quark_from_static_string ("blocksize");
2503 bytesperread_id = g_quark_from_static_string ("bytesperread");
2504 dump_id = g_quark_from_static_string ("dump");
2505 filesize_id = g_quark_from_static_string ("filesize");
2506 mmapsize_id = g_quark_from_static_string ("mmapsize");
2507 location_id = g_quark_from_static_string ("location");
2508 offset_id = g_quark_from_static_string ("offset");
2509 silent_id = g_quark_from_static_string ("silent");
2510 touch_id = g_quark_from_static_string ("touch");
2513 if (prop_id == fd_id) {
2514 pspec = g_param_spec_int ("fd", "File-descriptor",
2515 "File-descriptor for the file being read", 0, G_MAXINT, 0, flags);
2516 } else if (prop_id == blocksize_id) {
2517 pspec = g_param_spec_ulong ("blocksize", "Block Size",
2518 "Block size to read per buffer", 0, G_MAXULONG, 4096, flags);
2520 } else if (prop_id == bytesperread_id) {
2521 pspec = g_param_spec_int ("bytesperread", "Bytes per read",
2522 "Number of bytes to read per buffer", G_MININT, G_MAXINT, 0, flags);
2524 } else if (prop_id == dump_id) {
2525 pspec = g_param_spec_boolean ("dump", "Dump",
2526 "Dump bytes to stdout", FALSE, flags);
2528 } else if (prop_id == filesize_id) {
2529 pspec = g_param_spec_int64 ("filesize", "File Size",
2530 "Size of the file being read", 0, G_MAXINT64, 0, flags);
2532 } else if (prop_id == mmapsize_id) {
2533 pspec = g_param_spec_ulong ("mmapsize", "mmap() Block Size",
2534 "Size in bytes of mmap()d regions", 0, G_MAXULONG, 4 * 1048576, flags);
2536 } else if (prop_id == location_id) {
2537 pspec = g_param_spec_string ("location", "File Location",
2538 "Location of the file to read", NULL, flags);
2540 } else if (prop_id == offset_id) {
2541 pspec = g_param_spec_int64 ("offset", "File Offset",
2542 "Byte offset of current read pointer", 0, G_MAXINT64, 0, flags);
2544 } else if (prop_id == silent_id) {
2545 pspec = g_param_spec_boolean ("silent", "Silent", "Don't produce events",
2548 } else if (prop_id == touch_id) {
2549 pspec = g_param_spec_boolean ("touch", "Touch read data",
2550 "Touch data to force disk read before " "push ()", TRUE, flags);
2552 g_warning ("Unknown - 'standard' property '%s' id %d from klass %s",
2553 prop_name, arg_id, g_type_name (G_OBJECT_CLASS_TYPE (klass)));
2558 g_object_class_install_property (klass, arg_id, pspec);
2563 * gst_element_class_install_std_props:
2564 * @klass: the #GstElementClass to add the properties to.
2565 * @first_name: the name of the first property.
2566 * in a NULL terminated
2567 * @...: the id and flags of the first property, followed by
2568 * further 'name', 'id', 'flags' triplets and terminated by NULL.
2570 * Adds a list of standardized properties with types to the @klass.
2571 * the id is for the property switch in your get_prop method, and
2572 * the flags determine readability / writeability.
2575 gst_element_class_install_std_props (GstElementClass * klass,
2576 const gchar * first_name, ...)
2582 g_return_if_fail (GST_IS_ELEMENT_CLASS (klass));
2584 va_start (args, first_name);
2589 int arg_id = va_arg (args, int);
2590 int flags = va_arg (args, int);
2592 gst_element_populate_std_props ((GObjectClass *) klass, name, arg_id,
2595 name = va_arg (args, char *);
2604 * @buf1: (transfer none): the first source #GstBuffer to merge.
2605 * @buf2: (transfer none): the second source #GstBuffer to merge.
2607 * Create a new buffer that is the concatenation of the two source
2608 * buffers. The original source buffers will not be modified or
2609 * unref'd. Make sure you unref the source buffers if they are not used
2610 * anymore afterwards.
2612 * If the buffers point to contiguous areas of memory, the buffer
2613 * is created without copying the data.
2615 * Free-function: gst_buffer_unref
2617 * Returns: (transfer full): the new #GstBuffer which is the concatenation
2618 * of the source buffers.
2621 gst_buffer_merge (GstBuffer * buf1, GstBuffer * buf2)
2625 /* we're just a specific case of the more general gst_buffer_span() */
2626 result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
2633 * @buf1: the first source #GstBuffer.
2634 * @buf2: the second source #GstBuffer.
2636 * Create a new buffer that is the concatenation of the two source
2637 * buffers, and unrefs the original source buffers.
2639 * If the buffers point to contiguous areas of memory, the buffer
2640 * is created without copying the data.
2642 * This is a convenience function for C programmers. See also
2643 * gst_buffer_merge(), which does the same thing without
2644 * unreffing the input parameters. Language bindings without
2645 * explicit reference counting should not wrap this function.
2647 * Returns: (transfer full): the new #GstBuffer which is the concatenation of
2648 * the source buffers.
2651 gst_buffer_join (GstBuffer * buf1, GstBuffer * buf2)
2655 result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
2656 gst_buffer_unref (buf1);
2657 gst_buffer_unref (buf2);
2665 * @dest: (transfer none): buffer to stamp
2666 * @src: buffer to stamp from
2668 * Copies additional information (the timestamp, duration, and offset start
2669 * and end) from one buffer to the other.
2671 * This function does not copy any buffer flags or caps and is equivalent to
2672 * gst_buffer_copy_metadata(@dest, @src, GST_BUFFER_COPY_TIMESTAMPS).
2674 * Deprecated: use gst_buffer_copy_metadata() instead, it provides more
2677 #ifndef GST_REMOVE_DEPRECATED
2678 #ifdef GST_DISABLE_DEPRECATED
2679 void gst_buffer_stamp (GstBuffer * dest, const GstBuffer * src);
2682 gst_buffer_stamp (GstBuffer * dest, const GstBuffer * src)
2684 gst_buffer_copy_metadata (dest, src, GST_BUFFER_COPY_TIMESTAMPS);
2686 #endif /* GST_REMOVE_DEPRECATED */
2689 getcaps_fold_func (GstPad * pad, GValue * ret, GstPad * orig)
2691 gboolean empty = FALSE;
2692 GstCaps *peercaps, *existing;
2694 existing = g_value_get_pointer (ret);
2695 peercaps = gst_pad_peer_get_caps_reffed (pad);
2696 if (G_LIKELY (peercaps)) {
2697 GstCaps *intersection = gst_caps_intersect (existing, peercaps);
2699 empty = gst_caps_is_empty (intersection);
2701 g_value_set_pointer (ret, intersection);
2702 gst_caps_unref (existing);
2703 gst_caps_unref (peercaps);
2705 gst_object_unref (pad);
2710 * gst_pad_proxy_getcaps:
2711 * @pad: a #GstPad to proxy.
2713 * Calls gst_pad_get_allowed_caps() for every other pad belonging to the
2714 * same element as @pad, and returns the intersection of the results.
2716 * This function is useful as a default getcaps function for an element
2717 * that can handle any stream format, but requires all its pads to have
2718 * the same caps. Two such elements are tee and adder.
2720 * Free-function: gst_caps_unref
2722 * Returns: (transfer full): the intersection of the other pads' allowed caps.
2725 gst_pad_proxy_getcaps (GstPad * pad)
2727 GstElement *element;
2728 GstCaps *caps, *intersected;
2730 GstIteratorResult res;
2731 GValue ret = { 0, };
2733 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2735 GST_CAT_DEBUG (GST_CAT_PADS, "proxying getcaps for %s:%s",
2736 GST_DEBUG_PAD_NAME (pad));
2738 element = gst_pad_get_parent_element (pad);
2739 if (element == NULL)
2742 /* value to hold the return, by default it holds ANY, the ref is taken by
2744 g_value_init (&ret, G_TYPE_POINTER);
2745 g_value_set_pointer (&ret, gst_caps_new_any ());
2747 /* only iterate the pads in the oposite direction */
2748 if (GST_PAD_IS_SRC (pad))
2749 iter = gst_element_iterate_sink_pads (element);
2751 iter = gst_element_iterate_src_pads (element);
2755 gst_iterator_fold (iter, (GstIteratorFoldFunction) getcaps_fold_func,
2758 case GST_ITERATOR_RESYNC:
2759 /* unref any value stored */
2760 if ((caps = g_value_get_pointer (&ret)))
2761 gst_caps_unref (caps);
2762 /* need to reset the result again to ANY */
2763 g_value_set_pointer (&ret, gst_caps_new_any ());
2764 gst_iterator_resync (iter);
2766 case GST_ITERATOR_DONE:
2767 /* all pads iterated, return collected value */
2769 case GST_ITERATOR_OK:
2770 /* premature exit (happens if caps intersection is empty) */
2773 /* iterator returned _ERROR, mark an error and exit */
2774 if ((caps = g_value_get_pointer (&ret)))
2775 gst_caps_unref (caps);
2776 g_value_set_pointer (&ret, NULL);
2781 gst_iterator_free (iter);
2783 gst_object_unref (element);
2785 caps = g_value_get_pointer (&ret);
2786 g_value_unset (&ret);
2790 gst_caps_intersect (caps, gst_pad_get_pad_template_caps (pad));
2791 gst_caps_unref (caps);
2793 intersected = gst_caps_copy (gst_pad_get_pad_template_caps (pad));
2801 GST_DEBUG_OBJECT (pad, "no parent");
2802 return gst_caps_copy (gst_pad_get_pad_template_caps (pad));
2806 g_warning ("Pad list returned error on element %s",
2807 GST_ELEMENT_NAME (element));
2808 gst_iterator_free (iter);
2809 gst_object_unref (element);
2810 return gst_caps_copy (gst_pad_get_pad_template_caps (pad));
2821 setcaps_fold_func (GstPad * pad, GValue * ret, SetCapsFoldData * data)
2823 gboolean success = TRUE;
2825 if (pad != data->orig) {
2826 success = gst_pad_set_caps (pad, data->caps);
2827 g_value_set_boolean (ret, success);
2829 gst_object_unref (pad);
2835 * gst_pad_proxy_setcaps
2836 * @pad: a #GstPad to proxy from
2837 * @caps: (transfer none): the #GstCaps to link with
2839 * Calls gst_pad_set_caps() for every other pad belonging to the
2840 * same element as @pad. If gst_pad_set_caps() fails on any pad,
2841 * the proxy setcaps fails. May be used only during negotiation.
2843 * Returns: TRUE if sucessful
2846 gst_pad_proxy_setcaps (GstPad * pad, GstCaps * caps)
2848 GstElement *element;
2850 GstIteratorResult res;
2851 GValue ret = { 0, };
2852 SetCapsFoldData data;
2854 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2855 g_return_val_if_fail (caps != NULL, FALSE);
2857 GST_CAT_DEBUG (GST_CAT_PADS, "proxying pad link for %s:%s",
2858 GST_DEBUG_PAD_NAME (pad));
2860 element = gst_pad_get_parent_element (pad);
2861 if (element == NULL)
2864 /* only iterate the pads in the oposite direction */
2865 if (GST_PAD_IS_SRC (pad))
2866 iter = gst_element_iterate_sink_pads (element);
2868 iter = gst_element_iterate_src_pads (element);
2870 g_value_init (&ret, G_TYPE_BOOLEAN);
2871 g_value_set_boolean (&ret, TRUE);
2876 res = gst_iterator_fold (iter, (GstIteratorFoldFunction) setcaps_fold_func,
2880 case GST_ITERATOR_RESYNC:
2881 /* reset return value */
2882 g_value_set_boolean (&ret, TRUE);
2883 gst_iterator_resync (iter);
2885 case GST_ITERATOR_DONE:
2886 /* all pads iterated, return collected value */
2889 /* iterator returned _ERROR or premature end with _OK,
2890 * mark an error and exit */
2895 gst_iterator_free (iter);
2897 gst_object_unref (element);
2899 /* ok not to unset the gvalue */
2900 return g_value_get_boolean (&ret);
2905 g_warning ("Pad list return error on element %s",
2906 GST_ELEMENT_NAME (element));
2907 gst_iterator_free (iter);
2908 gst_object_unref (element);
2914 * gst_pad_query_position:
2915 * @pad: a #GstPad to invoke the position query on.
2916 * @format: (inout): a pointer to the #GstFormat asked for.
2917 * On return contains the #GstFormat used.
2918 * @cur: (out): A location in which to store the current position, or NULL.
2920 * Queries a pad for the stream position.
2922 * Returns: TRUE if the query could be performed.
2925 gst_pad_query_position (GstPad * pad, GstFormat * format, gint64 * cur)
2930 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2931 g_return_val_if_fail (format != NULL, FALSE);
2933 query = gst_query_new_position (*format);
2934 ret = gst_pad_query (pad, query);
2937 gst_query_parse_position (query, format, cur);
2939 gst_query_unref (query);
2945 * gst_pad_query_peer_position:
2946 * @pad: a #GstPad on whose peer to invoke the position query on.
2947 * Must be a sink pad.
2948 * @format: (inout): a pointer to the #GstFormat asked for.
2949 * On return contains the #GstFormat used.
2950 * @cur: (out) (allow-none): a location in which to store the current
2951 * position, or NULL.
2953 * Queries the peer of a given sink pad for the stream position.
2955 * Returns: TRUE if the query could be performed.
2958 gst_pad_query_peer_position (GstPad * pad, GstFormat * format, gint64 * cur)
2960 gboolean ret = FALSE;
2963 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2964 g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2965 g_return_val_if_fail (format != NULL, FALSE);
2967 peer = gst_pad_get_peer (pad);
2969 ret = gst_pad_query_position (peer, format, cur);
2970 gst_object_unref (peer);
2977 * gst_pad_query_duration:
2978 * @pad: a #GstPad to invoke the duration query on.
2979 * @format: (inout): a pointer to the #GstFormat asked for.
2980 * On return contains the #GstFormat used.
2981 * @duration: (out) (allow-none): a location in which to store the total
2982 * duration, or NULL.
2984 * Queries a pad for the total stream duration.
2986 * Returns: TRUE if the query could be performed.
2989 gst_pad_query_duration (GstPad * pad, GstFormat * format, gint64 * duration)
2994 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2995 g_return_val_if_fail (format != NULL, FALSE);
2997 query = gst_query_new_duration (*format);
2998 ret = gst_pad_query (pad, query);
3001 gst_query_parse_duration (query, format, duration);
3003 gst_query_unref (query);
3009 * gst_pad_query_peer_duration:
3010 * @pad: a #GstPad on whose peer pad to invoke the duration query on.
3011 * Must be a sink pad.
3012 * @format: (inout) :a pointer to the #GstFormat asked for.
3013 * On return contains the #GstFormat used.
3014 * @duration: (out) (allow-none): a location in which to store the total
3015 * duration, or NULL.
3017 * Queries the peer pad of a given sink pad for the total stream duration.
3019 * Returns: TRUE if the query could be performed.
3022 gst_pad_query_peer_duration (GstPad * pad, GstFormat * format,
3025 gboolean ret = FALSE;
3028 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3029 g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
3030 g_return_val_if_fail (format != NULL, FALSE);
3032 peer = gst_pad_get_peer (pad);
3034 ret = gst_pad_query_duration (peer, format, duration);
3035 gst_object_unref (peer);
3042 * gst_pad_query_convert:
3043 * @pad: a #GstPad to invoke the convert query on.
3044 * @src_format: a #GstFormat to convert from.
3045 * @src_val: a value to convert.
3046 * @dest_format: (inout): a pointer to the #GstFormat to convert to.
3047 * @dest_val: (out): a pointer to the result.
3049 * Queries a pad to convert @src_val in @src_format to @dest_format.
3051 * Returns: TRUE if the query could be performed.
3054 gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
3055 GstFormat * dest_format, gint64 * dest_val)
3060 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3061 g_return_val_if_fail (dest_format != NULL, FALSE);
3062 g_return_val_if_fail (dest_val != NULL, FALSE);
3064 if (*dest_format == src_format || src_val == -1) {
3065 *dest_val = src_val;
3069 query = gst_query_new_convert (src_format, src_val, *dest_format);
3070 ret = gst_pad_query (pad, query);
3073 gst_query_parse_convert (query, NULL, NULL, dest_format, dest_val);
3075 gst_query_unref (query);
3081 * gst_pad_query_peer_convert:
3082 * @pad: a #GstPad, on whose peer pad to invoke the convert query on.
3083 * Must be a sink pad.
3084 * @src_format: a #GstFormat to convert from.
3085 * @src_val: a value to convert.
3086 * @dest_format: (inout): a pointer to the #GstFormat to convert to.
3087 * @dest_val: (out): a pointer to the result.
3089 * Queries the peer pad of a given sink pad to convert @src_val in @src_format
3092 * Returns: TRUE if the query could be performed.
3095 gst_pad_query_peer_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
3096 GstFormat * dest_format, gint64 * dest_val)
3098 gboolean ret = FALSE;
3101 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3102 g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
3103 g_return_val_if_fail (dest_format != NULL, FALSE);
3104 g_return_val_if_fail (dest_val != NULL, FALSE);
3106 peer = gst_pad_get_peer (pad);
3108 ret = gst_pad_query_convert (peer, src_format, src_val, dest_format,
3110 gst_object_unref (peer);
3117 * gst_atomic_int_set:
3118 * @atomic_int: (inout): pointer to an atomic integer
3119 * @value: value to set
3121 * Unconditionally sets the atomic integer to @value.
3123 * Deprecated: Use g_atomic_int_set().
3126 #ifndef GST_REMOVE_DEPRECATED
3127 #ifdef GST_DISABLE_DEPRECATED
3128 void gst_atomic_int_set (gint * atomic_int, gint value);
3131 gst_atomic_int_set (gint * atomic_int, gint value)
3133 g_atomic_int_set (atomic_int, value);
3138 * gst_pad_add_data_probe:
3139 * @pad: pad to add the data probe handler to
3140 * @handler: function to call when data is passed over pad
3141 * @data: (closure): data to pass along with the handler
3143 * Adds a "data probe" to a pad. This function will be called whenever data
3144 * passes through a pad. In this case data means both events and buffers. The
3145 * probe will be called with the data as an argument, meaning @handler should
3146 * have the same callback signature as the #GstPad::have-data signal.
3147 * Note that the data will have a reference count greater than 1, so it will
3148 * be immutable -- you must not change it.
3150 * For source pads, the probe will be called after the blocking function, if any
3151 * (see gst_pad_set_blocked_async()), but before looking up the peer to chain
3152 * to. For sink pads, the probe function will be called before configuring the
3153 * sink with new caps, if any, and before calling the pad's chain function.
3155 * Your data probe should return TRUE to let the data continue to flow, or FALSE
3156 * to drop it. Dropping data is rarely useful, but occasionally comes in handy
3159 * Although probes are implemented internally by connecting @handler to the
3160 * have-data signal on the pad, if you want to remove a probe it is insufficient
3161 * to only call g_signal_handler_disconnect on the returned handler id. To
3162 * remove a probe, use the appropriate function, such as
3163 * gst_pad_remove_data_probe().
3165 * Returns: The handler id.
3168 gst_pad_add_data_probe (GstPad * pad, GCallback handler, gpointer data)
3170 return gst_pad_add_data_probe_full (pad, handler, data, NULL);
3174 * gst_pad_add_data_probe_full:
3175 * @pad: pad to add the data probe handler to
3176 * @handler: function to call when data is passed over pad
3177 * @data: (closure): data to pass along with the handler
3178 * @notify: (allow-none): function to call when the probe is disconnected,
3181 * Adds a "data probe" to a pad. This function will be called whenever data
3182 * passes through a pad. In this case data means both events and buffers. The
3183 * probe will be called with the data as an argument, meaning @handler should
3184 * have the same callback signature as the #GstPad::have-data signal.
3185 * Note that the data will have a reference count greater than 1, so it will
3186 * be immutable -- you must not change it.
3188 * For source pads, the probe will be called after the blocking function, if any
3189 * (see gst_pad_set_blocked_async()), but before looking up the peer to chain
3190 * to. For sink pads, the probe function will be called before configuring the
3191 * sink with new caps, if any, and before calling the pad's chain function.
3193 * Your data probe should return TRUE to let the data continue to flow, or FALSE
3194 * to drop it. Dropping data is rarely useful, but occasionally comes in handy
3197 * Although probes are implemented internally by connecting @handler to the
3198 * have-data signal on the pad, if you want to remove a probe it is insufficient
3199 * to only call g_signal_handler_disconnect on the returned handler id. To
3200 * remove a probe, use the appropriate function, such as
3201 * gst_pad_remove_data_probe().
3203 * The @notify function is called when the probe is disconnected and usually
3204 * used to free @data.
3206 * Returns: The handler id.
3211 gst_pad_add_data_probe_full (GstPad * pad, GCallback handler,
3212 gpointer data, GDestroyNotify notify)
3216 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3217 g_return_val_if_fail (handler != NULL, 0);
3219 GST_OBJECT_LOCK (pad);
3221 /* we only expose a GDestroyNotify in our API because that's less confusing */
3222 sigid = g_signal_connect_data (pad, "have-data", handler, data,
3223 (GClosureNotify) notify, 0);
3225 GST_PAD_DO_EVENT_SIGNALS (pad)++;
3226 GST_PAD_DO_BUFFER_SIGNALS (pad)++;
3227 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
3228 "adding data probe, now %d data, %d event probes",
3229 GST_PAD_DO_BUFFER_SIGNALS (pad), GST_PAD_DO_EVENT_SIGNALS (pad));
3230 _priv_gst_pad_invalidate_cache (pad);
3231 GST_OBJECT_UNLOCK (pad);
3237 * gst_pad_add_event_probe:
3238 * @pad: pad to add the event probe handler to
3239 * @handler: function to call when events are passed over pad
3240 * @data: (closure): data to pass along with the handler
3242 * Adds a probe that will be called for all events passing through a pad. See
3243 * gst_pad_add_data_probe() for more information.
3245 * Returns: The handler id
3248 gst_pad_add_event_probe (GstPad * pad, GCallback handler, gpointer data)
3250 return gst_pad_add_event_probe_full (pad, handler, data, NULL);
3254 * gst_pad_add_event_probe_full:
3255 * @pad: pad to add the event probe handler to
3256 * @handler: function to call when events are passed over pad
3257 * @data: (closure): data to pass along with the handler, or NULL
3258 * @notify: (allow-none): function to call when probe is disconnected, or NULL
3260 * Adds a probe that will be called for all events passing through a pad. See
3261 * gst_pad_add_data_probe() for more information.
3263 * The @notify function is called when the probe is disconnected and usually
3264 * used to free @data.
3266 * Returns: The handler id
3271 gst_pad_add_event_probe_full (GstPad * pad, GCallback handler,
3272 gpointer data, GDestroyNotify notify)
3276 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3277 g_return_val_if_fail (handler != NULL, 0);
3279 GST_OBJECT_LOCK (pad);
3281 /* we only expose a GDestroyNotify in our API because that's less confusing */
3282 sigid = g_signal_connect_data (pad, "have-data::event", handler, data,
3283 (GClosureNotify) notify, 0);
3285 GST_PAD_DO_EVENT_SIGNALS (pad)++;
3286 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "adding event probe, now %d probes",
3287 GST_PAD_DO_EVENT_SIGNALS (pad));
3288 _priv_gst_pad_invalidate_cache (pad);
3289 GST_OBJECT_UNLOCK (pad);
3295 * gst_pad_add_buffer_probe:
3296 * @pad: pad to add the buffer probe handler to
3297 * @handler: function to call when buffers are passed over pad
3298 * @data: (closure): data to pass along with the handler
3300 * Adds a probe that will be called for all buffers passing through a pad. See
3301 * gst_pad_add_data_probe() for more information.
3303 * Returns: The handler id
3306 gst_pad_add_buffer_probe (GstPad * pad, GCallback handler, gpointer data)
3308 return gst_pad_add_buffer_probe_full (pad, handler, data, NULL);
3312 * gst_pad_add_buffer_probe_full:
3313 * @pad: pad to add the buffer probe handler to
3314 * @handler: function to call when buffer are passed over pad
3315 * @data: (closure): data to pass along with the handler
3316 * @notify: (allow-none): function to call when the probe is disconnected,
3319 * Adds a probe that will be called for all buffers passing through a pad. See
3320 * gst_pad_add_data_probe() for more information.
3322 * The @notify function is called when the probe is disconnected and usually
3323 * used to free @data.
3325 * Returns: The handler id
3330 gst_pad_add_buffer_probe_full (GstPad * pad, GCallback handler,
3331 gpointer data, GDestroyNotify notify)
3335 g_return_val_if_fail (GST_IS_PAD (pad), 0);
3336 g_return_val_if_fail (handler != NULL, 0);
3338 GST_OBJECT_LOCK (pad);
3340 /* we only expose a GDestroyNotify in our API because that's less confusing */
3341 sigid = g_signal_connect_data (pad, "have-data::buffer", handler, data,
3342 (GClosureNotify) notify, 0);
3344 GST_PAD_DO_BUFFER_SIGNALS (pad)++;
3345 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "adding buffer probe, now %d probes",
3346 GST_PAD_DO_BUFFER_SIGNALS (pad));
3347 _priv_gst_pad_invalidate_cache (pad);
3348 GST_OBJECT_UNLOCK (pad);
3354 * gst_pad_remove_data_probe:
3355 * @pad: pad to remove the data probe handler from
3356 * @handler_id: handler id returned from gst_pad_add_data_probe
3358 * Removes a data probe from @pad.
3361 gst_pad_remove_data_probe (GstPad * pad, guint handler_id)
3363 g_return_if_fail (GST_IS_PAD (pad));
3364 g_return_if_fail (handler_id > 0);
3366 GST_OBJECT_LOCK (pad);
3367 g_signal_handler_disconnect (pad, handler_id);
3368 GST_PAD_DO_BUFFER_SIGNALS (pad)--;
3369 GST_PAD_DO_EVENT_SIGNALS (pad)--;
3370 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
3371 "removed data probe, now %d event, %d buffer probes",
3372 GST_PAD_DO_EVENT_SIGNALS (pad), GST_PAD_DO_BUFFER_SIGNALS (pad));
3373 GST_OBJECT_UNLOCK (pad);
3378 * gst_pad_remove_event_probe:
3379 * @pad: pad to remove the event probe handler from
3380 * @handler_id: handler id returned from gst_pad_add_event_probe
3382 * Removes an event probe from @pad.
3385 gst_pad_remove_event_probe (GstPad * pad, guint handler_id)
3387 g_return_if_fail (GST_IS_PAD (pad));
3388 g_return_if_fail (handler_id > 0);
3390 GST_OBJECT_LOCK (pad);
3391 g_signal_handler_disconnect (pad, handler_id);
3392 GST_PAD_DO_EVENT_SIGNALS (pad)--;
3393 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
3394 "removed event probe, now %d event probes",
3395 GST_PAD_DO_EVENT_SIGNALS (pad));
3396 GST_OBJECT_UNLOCK (pad);
3400 * gst_pad_remove_buffer_probe:
3401 * @pad: pad to remove the buffer probe handler from
3402 * @handler_id: handler id returned from gst_pad_add_buffer_probe
3404 * Removes a buffer probe from @pad.
3407 gst_pad_remove_buffer_probe (GstPad * pad, guint handler_id)
3409 g_return_if_fail (GST_IS_PAD (pad));
3410 g_return_if_fail (handler_id > 0);
3412 GST_OBJECT_LOCK (pad);
3413 g_signal_handler_disconnect (pad, handler_id);
3414 GST_PAD_DO_BUFFER_SIGNALS (pad)--;
3415 GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
3416 "removed buffer probe, now %d buffer probes",
3417 GST_PAD_DO_BUFFER_SIGNALS (pad));
3418 GST_OBJECT_UNLOCK (pad);
3423 * gst_element_found_tags_for_pad:
3424 * @element: element for which to post taglist to bus.
3425 * @pad: (transfer none): pad on which to push tag-event
3426 * @list: (transfer full): the taglist to post on the bus and create event from
3428 * Posts a message to the bus that new tags were found and pushes the
3429 * tags as event. Takes ownership of the @list.
3431 * This is a utility method for elements. Applications should use the
3432 * #GstTagSetter interface.
3435 gst_element_found_tags_for_pad (GstElement * element,
3436 GstPad * pad, GstTagList * list)
3438 g_return_if_fail (element != NULL);
3439 g_return_if_fail (pad != NULL);
3440 g_return_if_fail (list != NULL);
3442 gst_pad_push_event (pad, gst_event_new_tag (gst_tag_list_copy (list)));
3443 /* FIXME 0.11: Set the pad as source. */
3444 gst_element_post_message (element,
3445 gst_message_new_tag_full (GST_OBJECT (element), pad, list));
3449 push_and_ref (GstPad * pad, GstEvent * event)
3451 gst_pad_push_event (pad, gst_event_ref (event));
3452 /* iterator refs pad, we unref when we are done with it */
3453 gst_object_unref (pad);
3457 * gst_element_found_tags:
3458 * @element: element for which we found the tags.
3459 * @list: (transfer full): list of tags.
3461 * Posts a message to the bus that new tags were found, and pushes an event
3462 * to all sourcepads. Takes ownership of the @list.
3464 * This is a utility method for elements. Applications should use the
3465 * #GstTagSetter interface.
3468 gst_element_found_tags (GstElement * element, GstTagList * list)
3473 g_return_if_fail (element != NULL);
3474 g_return_if_fail (list != NULL);
3476 iter = gst_element_iterate_src_pads (element);
3477 event = gst_event_new_tag (gst_tag_list_copy (list));
3478 gst_iterator_foreach (iter, (GFunc) push_and_ref, event);
3479 gst_iterator_free (iter);
3480 gst_event_unref (event);
3482 gst_element_post_message (element,
3483 gst_message_new_tag (GST_OBJECT (element), list));
3487 element_find_unlinked_pad (GstElement * element, GstPadDirection direction)
3490 GstPad *unlinked_pad = NULL;
3493 switch (direction) {
3495 iter = gst_element_iterate_src_pads (element);
3498 iter = gst_element_iterate_sink_pads (element);
3501 g_return_val_if_reached (NULL);
3508 switch (gst_iterator_next (iter, &pad)) {
3509 case GST_ITERATOR_OK:{
3512 GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
3513 GST_DEBUG_PAD_NAME (pad));
3515 peer = gst_pad_get_peer (GST_PAD (pad));
3519 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
3520 "found existing unlinked pad %s:%s",
3521 GST_DEBUG_PAD_NAME (unlinked_pad));
3523 gst_object_unref (pad);
3524 gst_object_unref (peer);
3528 case GST_ITERATOR_DONE:
3531 case GST_ITERATOR_RESYNC:
3532 gst_iterator_resync (iter);
3534 case GST_ITERATOR_ERROR:
3535 g_return_val_if_reached (NULL);
3540 gst_iterator_free (iter);
3542 return unlinked_pad;
3546 * gst_bin_find_unlinked_pad:
3547 * @bin: bin in which to look for elements with unlinked pads
3548 * @direction: whether to look for an unlinked source or sink pad
3550 * Recursively looks for elements with an unlinked pad of the given
3551 * direction within the specified bin and returns an unlinked pad
3552 * if one is found, or NULL otherwise. If a pad is found, the caller
3553 * owns a reference to it and should use gst_object_unref() on the
3554 * pad when it is not needed any longer.
3556 * Returns: (transfer full): unlinked pad of the given direction, or NULL.
3561 gst_bin_find_unlinked_pad (GstBin * bin, GstPadDirection direction)
3567 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3568 g_return_val_if_fail (direction != GST_PAD_UNKNOWN, NULL);
3571 iter = gst_bin_iterate_recurse (bin);
3575 switch (gst_iterator_next (iter, &element)) {
3576 case GST_ITERATOR_OK:
3577 pad = element_find_unlinked_pad (GST_ELEMENT (element), direction);
3578 gst_object_unref (element);
3582 case GST_ITERATOR_DONE:
3585 case GST_ITERATOR_RESYNC:
3586 gst_iterator_resync (iter);
3588 case GST_ITERATOR_ERROR:
3589 g_return_val_if_reached (NULL);
3594 gst_iterator_free (iter);
3600 * gst_bin_find_unconnected_pad:
3601 * @bin: bin in which to look for elements with unlinked pads
3602 * @direction: whether to look for an unlinked source or sink pad
3604 * Recursively looks for elements with an unlinked pad of the given
3605 * direction within the specified bin and returns an unlinked pad
3606 * if one is found, or NULL otherwise. If a pad is found, the caller
3607 * owns a reference to it and should use gst_object_unref() on the
3608 * pad when it is not needed any longer.
3610 * Returns: (transfer full): unlinked pad of the given direction, or NULL.
3614 * Deprecated: use gst_bin_find_unlinked_pad() instead.
3616 #ifndef GST_REMOVE_DEPRECATED
3617 #ifdef GST_DISABLE_DEPRECATED
3618 GstPad *gst_bin_find_unconnected_pad (GstBin * bin, GstPadDirection direction);
3621 gst_bin_find_unconnected_pad (GstBin * bin, GstPadDirection direction)
3623 return gst_bin_find_unlinked_pad (bin, direction);
3628 * gst_parse_bin_from_description:
3629 * @bin_description: command line describing the bin
3630 * @ghost_unlinked_pads: whether to automatically create ghost pads
3631 * for unlinked source or sink pads within the bin
3632 * @err: where to store the error message in case of an error, or NULL
3634 * This is a convenience wrapper around gst_parse_launch() to create a
3635 * #GstBin from a gst-launch-style pipeline description. See
3636 * gst_parse_launch() and the gst-launch man page for details about the
3637 * syntax. Ghost pads on the bin for unlinked source or sink pads
3638 * within the bin can automatically be created (but only a maximum of
3639 * one ghost pad for each direction will be created; if you expect
3640 * multiple unlinked source pads or multiple unlinked sink pads
3641 * and want them all ghosted, you will have to create the ghost pads
3644 * Returns: (transfer full): a newly-created bin, or NULL if an error occurred.
3649 gst_parse_bin_from_description (const gchar * bin_description,
3650 gboolean ghost_unlinked_pads, GError ** err)
3652 return gst_parse_bin_from_description_full (bin_description,
3653 ghost_unlinked_pads, NULL, 0, err);
3657 * gst_parse_bin_from_description_full:
3658 * @bin_description: command line describing the bin
3659 * @ghost_unlinked_pads: whether to automatically create ghost pads
3660 * for unlinked source or sink pads within the bin
3661 * @context: (transfer none) (allow-none): a parse context allocated with
3662 * gst_parse_context_new(), or %NULL
3663 * @flags: parsing options, or #GST_PARSE_FLAG_NONE
3664 * @err: where to store the error message in case of an error, or NULL
3666 * This is a convenience wrapper around gst_parse_launch() to create a
3667 * #GstBin from a gst-launch-style pipeline description. See
3668 * gst_parse_launch() and the gst-launch man page for details about the
3669 * syntax. Ghost pads on the bin for unlinked source or sink pads
3670 * within the bin can automatically be created (but only a maximum of
3671 * one ghost pad for each direction will be created; if you expect
3672 * multiple unlinked source pads or multiple unlinked sink pads
3673 * and want them all ghosted, you will have to create the ghost pads
3676 * Returns: (transfer full): a newly-created bin, or NULL if an error occurred.
3681 gst_parse_bin_from_description_full (const gchar * bin_description,
3682 gboolean ghost_unlinked_pads, GstParseContext * context,
3683 GstParseFlags flags, GError ** err)
3685 #ifndef GST_DISABLE_PARSE
3690 g_return_val_if_fail (bin_description != NULL, NULL);
3691 g_return_val_if_fail (err == NULL || *err == NULL, NULL);
3693 GST_DEBUG ("Making bin from description '%s'", bin_description);
3695 /* parse the pipeline to a bin */
3696 desc = g_strdup_printf ("bin.( %s )", bin_description);
3697 bin = (GstBin *) gst_parse_launch_full (desc, context, flags, err);
3700 if (bin == NULL || (err && *err != NULL)) {
3702 gst_object_unref (bin);
3706 /* find pads and ghost them if necessary */
3707 if (ghost_unlinked_pads) {
3708 if ((pad = gst_bin_find_unlinked_pad (bin, GST_PAD_SRC))) {
3709 gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("src", pad));
3710 gst_object_unref (pad);
3712 if ((pad = gst_bin_find_unlinked_pad (bin, GST_PAD_SINK))) {
3713 gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("sink", pad));
3714 gst_object_unref (pad);
3718 return GST_ELEMENT (bin);
3722 GST_WARNING ("Disabled API called");
3724 msg = gst_error_get_message (GST_CORE_ERROR, GST_CORE_ERROR_DISABLED);
3725 g_set_error (err, GST_CORE_ERROR, GST_CORE_ERROR_DISABLED, "%s", msg);
3733 * gst_type_register_static_full:
3734 * @parent_type: The GType of the parent type the newly registered type will
3736 * @type_name: NULL-terminated string used as the name of the new type
3737 * @class_size: Size of the class structure.
3738 * @base_init: Location of the base initialization function (optional).
3739 * @base_finalize: Location of the base finalization function (optional).
3740 * @class_init: Location of the class initialization function for class types
3741 * Location of the default vtable inititalization function for interface
3743 * @class_finalize: Location of the class finalization function for class types.
3744 * Location of the default vtable finalization function for interface types.
3746 * @class_data: User-supplied data passed to the class init/finalize functions.
3747 * @instance_size: Size of the instance (object) structure (required for
3748 * instantiatable types only).
3749 * @n_preallocs: The number of pre-allocated (cached) instances to reserve
3750 * memory for (0 indicates no caching). Ignored on recent GLib's.
3751 * @instance_init: Location of the instance initialization function (optional,
3752 * for instantiatable types only).
3753 * @value_table: A GTypeValueTable function table for generic handling of
3754 * GValues of this type (usually only useful for fundamental types).
3755 * @flags: #GTypeFlags for this GType. E.g: G_TYPE_FLAG_ABSTRACT
3757 * Helper function which constructs a #GTypeInfo structure and registers a
3758 * GType, but which generates less linker overhead than a static const
3759 * #GTypeInfo structure. For further details of the parameters, please see
3760 * #GTypeInfo in the GLib documentation.
3762 * Registers type_name as the name of a new static type derived from
3763 * parent_type. The value of flags determines the nature (e.g. abstract or
3764 * not) of the type. It works by filling a GTypeInfo struct and calling
3765 * g_type_register_static().
3767 * Returns: A #GType for the newly-registered type.
3772 gst_type_register_static_full (GType parent_type,
3773 const gchar * type_name,
3775 GBaseInitFunc base_init,
3776 GBaseFinalizeFunc base_finalize,
3777 GClassInitFunc class_init,
3778 GClassFinalizeFunc class_finalize,
3779 gconstpointer class_data,
3780 guint instance_size,
3781 guint16 n_preallocs,
3782 GInstanceInitFunc instance_init,
3783 const GTypeValueTable * value_table, GTypeFlags flags)
3787 info.class_size = class_size;
3788 info.base_init = base_init;
3789 info.base_finalize = base_finalize;
3790 info.class_init = class_init;
3791 info.class_finalize = class_finalize;
3792 info.class_data = class_data;
3793 info.instance_size = instance_size;
3794 info.n_preallocs = n_preallocs;
3795 info.instance_init = instance_init;
3796 info.value_table = value_table;
3798 return g_type_register_static (parent_type, type_name, &info, flags);
3803 * gst_util_get_timestamp:
3805 * Get a timestamp as GstClockTime to be used for interval meassurements.
3806 * The timestamp should not be interpreted in any other way.
3808 * Returns: the timestamp
3813 gst_util_get_timestamp (void)
3815 #if defined (HAVE_POSIX_TIMERS) && defined(HAVE_MONOTONIC_CLOCK)
3816 struct timespec now;
3818 clock_gettime (CLOCK_MONOTONIC, &now);
3819 return GST_TIMESPEC_TO_TIME (now);
3823 g_get_current_time (&now);
3824 return GST_TIMEVAL_TO_TIME (now);
3829 * gst_util_array_binary_search:
3830 * @array: the sorted input array
3831 * @num_elements: number of elements in the array
3832 * @element_size: size of every element in bytes
3833 * @search_func: function to compare two elements, @search_data will always be passed as second argument
3834 * @mode: search mode that should be used
3835 * @search_data: element that should be found
3836 * @user_data: (closure): data to pass to @search_func
3838 * Searches inside @array for @search_data by using the comparison function
3839 * @search_func. @array must be sorted ascending.
3841 * As @search_data is always passed as second argument to @search_func it's
3842 * not required that @search_data has the same type as the array elements.
3844 * The complexity of this search function is O(log (num_elements)).
3846 * Returns: The address of the found element or %NULL if nothing was found
3851 gst_util_array_binary_search (gpointer array, guint num_elements,
3852 gsize element_size, GCompareDataFunc search_func, GstSearchMode mode,
3853 gconstpointer search_data, gpointer user_data)
3855 glong left = 0, right = num_elements - 1, m;
3857 guint8 *data = (guint8 *) array;
3859 g_return_val_if_fail (array != NULL, NULL);
3860 g_return_val_if_fail (element_size > 0, NULL);
3861 g_return_val_if_fail (search_func != NULL, NULL);
3863 /* 0. No elements => return NULL */
3864 if (num_elements == 0)
3867 /* 1. If search_data is before the 0th element return the 0th element */
3868 ret = search_func (data, search_data, user_data);
3869 if ((ret >= 0 && mode == GST_SEARCH_MODE_AFTER) || ret == 0)
3874 /* 2. If search_data is after the last element return the last element */
3876 search_func (data + (num_elements - 1) * element_size, search_data,
3878 if ((ret <= 0 && mode == GST_SEARCH_MODE_BEFORE) || ret == 0)
3879 return data + (num_elements - 1) * element_size;
3883 /* 3. else binary search */
3885 m = left + (right - left) / 2;
3887 ret = search_func (data + m * element_size, search_data, user_data);
3890 return data + m * element_size;
3891 } else if (ret < 0) {
3897 /* No exact match found */
3899 if (mode == GST_SEARCH_MODE_EXACT) {
3901 } else if (mode == GST_SEARCH_MODE_AFTER) {
3903 return (m < num_elements) ? data + (m + 1) * element_size : NULL;
3905 return data + m * element_size;
3908 return data + m * element_size;
3910 return (m > 0) ? data + (m - 1) * element_size : NULL;
3916 /* Finds the greatest common divisor.
3917 * Returns 1 if none other found.
3918 * This is Euclid's algorithm. */
3921 * gst_util_greatest_common_divisor:
3922 * @a: First value as #gint
3923 * @b: Second value as #gint
3925 * Calculates the greatest common divisor of @a
3928 * Returns: Greatest common divisor of @a and @b
3933 gst_util_greatest_common_divisor (gint a, gint b)
3946 * gst_util_fraction_to_double:
3947 * @src_n: Fraction numerator as #gint
3948 * @src_d: Fraction denominator #gint
3949 * @dest: (out): pointer to a #gdouble for the result
3951 * Transforms a #gdouble to a fraction and simplifies the result.
3956 gst_util_fraction_to_double (gint src_n, gint src_d, gdouble * dest)
3958 g_return_if_fail (dest != NULL);
3959 g_return_if_fail (src_d != 0);
3961 *dest = ((gdouble) src_n) / ((gdouble) src_d);
3964 #define MAX_TERMS 30
3965 #define MIN_DIVISOR 1.0e-10
3966 #define MAX_ERROR 1.0e-20
3968 /* use continued fractions to transform a double into a fraction,
3969 * see http://mathforum.org/dr.math/faq/faq.fractions.html#decfrac.
3970 * This algorithm takes care of overflows.
3974 * gst_util_double_to_fraction:
3975 * @src: #gdouble to transform
3976 * @dest_n: (out): pointer to a #gint to hold the result numerator
3977 * @dest_d: (out): pointer to a #gint to hold the result denominator
3979 * Transforms a #gdouble to a fraction and simplifies
3985 gst_util_double_to_fraction (gdouble src, gint * dest_n, gint * dest_d)
3988 gdouble V, F; /* double being converted */
3989 gint N, D; /* will contain the result */
3990 gint A; /* current term in continued fraction */
3991 gint64 N1, D1; /* numerator, denominator of last approx */
3992 gint64 N2, D2; /* numerator, denominator of previous approx */
3995 gboolean negative = FALSE;
3997 g_return_if_fail (dest_n != NULL);
3998 g_return_if_fail (dest_d != NULL);
4000 /* initialize fraction being converted */
4008 /* initialize fractions with 1/0, 0/1 */
4016 for (i = 0; i < MAX_TERMS; i++) {
4018 A = (gint) F; /* no floor() needed, F is always >= 0 */
4019 /* get new divisor */
4022 /* calculate new fraction in temp */
4026 /* guard against overflow */
4027 if (N2 > G_MAXINT || D2 > G_MAXINT) {
4034 /* save last two fractions */
4040 /* quit if dividing by zero or close enough to target */
4041 if (F < MIN_DIVISOR || fabs (V - ((gdouble) N) / D) < MAX_ERROR) {
4045 /* Take reciprocal */
4048 /* fix for overflow */
4053 /* fix for negative */
4058 gcd = gst_util_greatest_common_divisor (N, D);
4070 * gst_util_fraction_multiply:
4071 * @a_n: Numerator of first value
4072 * @a_d: Denominator of first value
4073 * @b_n: Numerator of second value
4074 * @b_d: Denominator of second value
4075 * @res_n: (out): Pointer to #gint to hold the result numerator
4076 * @res_d: (out): Pointer to #gint to hold the result denominator
4078 * Multiplies the fractions @a_n/@a_d and @b_n/@b_d and stores
4079 * the result in @res_n and @res_d.
4081 * Returns: %FALSE on overflow, %TRUE otherwise.
4086 gst_util_fraction_multiply (gint a_n, gint a_d, gint b_n, gint b_d,
4087 gint * res_n, gint * res_d)
4091 g_return_val_if_fail (res_n != NULL, FALSE);
4092 g_return_val_if_fail (res_d != NULL, FALSE);
4093 g_return_val_if_fail (a_d != 0, FALSE);
4094 g_return_val_if_fail (b_d != 0, FALSE);
4096 gcd = gst_util_greatest_common_divisor (a_n, a_d);
4100 gcd = gst_util_greatest_common_divisor (b_n, b_d);
4104 gcd = gst_util_greatest_common_divisor (a_n, b_d);
4108 gcd = gst_util_greatest_common_divisor (a_d, b_n);
4112 /* This would result in overflow */
4113 if (a_n != 0 && G_MAXINT / ABS (a_n) < ABS (b_n))
4115 if (G_MAXINT / ABS (a_d) < ABS (b_d))
4121 gcd = gst_util_greatest_common_divisor (*res_n, *res_d);
4129 * gst_util_fraction_add:
4130 * @a_n: Numerator of first value
4131 * @a_d: Denominator of first value
4132 * @b_n: Numerator of second value
4133 * @b_d: Denominator of second value
4134 * @res_n: (out): Pointer to #gint to hold the result numerator
4135 * @res_d: (out): Pointer to #gint to hold the result denominator
4137 * Adds the fractions @a_n/@a_d and @b_n/@b_d and stores
4138 * the result in @res_n and @res_d.
4140 * Returns: %FALSE on overflow, %TRUE otherwise.
4145 gst_util_fraction_add (gint a_n, gint a_d, gint b_n, gint b_d, gint * res_n,
4150 g_return_val_if_fail (res_n != NULL, FALSE);
4151 g_return_val_if_fail (res_d != NULL, FALSE);
4152 g_return_val_if_fail (a_d != 0, FALSE);
4153 g_return_val_if_fail (b_d != 0, FALSE);
4155 gcd = gst_util_greatest_common_divisor (a_n, a_d);
4159 gcd = gst_util_greatest_common_divisor (b_n, b_d);
4174 /* This would result in overflow */
4175 if (G_MAXINT / ABS (a_n) < ABS (b_n))
4177 if (G_MAXINT / ABS (a_d) < ABS (b_d))
4179 if (G_MAXINT / ABS (a_d) < ABS (b_d))
4182 *res_n = (a_n * b_d) + (a_d * b_n);
4185 gcd = gst_util_greatest_common_divisor (*res_n, *res_d);
4198 * gst_util_fraction_compare:
4199 * @a_n: Numerator of first value
4200 * @a_d: Denominator of first value
4201 * @b_n: Numerator of second value
4202 * @b_d: Denominator of second value
4204 * Compares the fractions @a_n/@a_d and @b_n/@b_d and returns
4205 * -1 if a < b, 0 if a = b and 1 if a > b.
4207 * Returns: -1 if a < b; 0 if a = b; 1 if a > b.
4212 gst_util_fraction_compare (gint a_n, gint a_d, gint b_n, gint b_d)
4218 g_return_val_if_fail (a_d != 0 && b_d != 0, 0);
4221 gcd = gst_util_greatest_common_divisor (a_n, a_d);
4225 gcd = gst_util_greatest_common_divisor (b_n, b_d);
4229 /* fractions are reduced when set, so we can quickly see if they're equal */
4230 if (a_n == b_n && a_d == b_d)
4233 /* extend to 64 bits */
4234 new_num_1 = ((gint64) a_n) * b_d;
4235 new_num_2 = ((gint64) b_n) * a_d;
4236 if (new_num_1 < new_num_2)
4238 if (new_num_1 > new_num_2)
4241 /* Should not happen because a_d and b_d are not 0 */
4242 g_return_val_if_reached (0);