utils: expose pad_link_maybe_ghosting
[platform/upstream/gstreamer.git] / gst / gstutils.c
1 /* GStreamer
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>
5  *
6  * gstutils.c: Utility functions
7  *
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.
12  *
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.
17  *
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., 51 Franklin St, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23
24 /**
25  * SECTION:gstutils
26  * @short_description: Various utility functions
27  *
28  */
29
30 #include "gst_private.h"
31 #include <stdio.h>
32 #include <string.h>
33
34 #include "gstghostpad.h"
35 #include "gstutils.h"
36 #include "gsterror.h"
37 #include "gstinfo.h"
38 #include "gstparse.h"
39 #include "gstvalue.h"
40 #include "gst-i18n-lib.h"
41 #include "glib-compat-private.h"
42 #include <math.h>
43
44 /**
45  * gst_util_dump_mem:
46  * @mem: a pointer to the memory to dump
47  * @size: the size of the memory block to dump
48  *
49  * Dumps the memory block into a hex representation. Useful for debugging.
50  */
51 void
52 gst_util_dump_mem (const guchar * mem, guint size)
53 {
54   guint i, j;
55   GString *string = g_string_sized_new (50);
56   GString *chars = g_string_sized_new (18);
57
58   i = j = 0;
59   while (i < size) {
60     if (g_ascii_isprint (mem[i]))
61       g_string_append_c (chars, mem[i]);
62     else
63       g_string_append_c (chars, '.');
64
65     g_string_append_printf (string, "%02x ", mem[i]);
66
67     j++;
68     i++;
69
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);
75       j = 0;
76     }
77   }
78   g_string_free (string, TRUE);
79   g_string_free (chars, TRUE);
80 }
81
82
83 /**
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
87  *
88  * Converts the string to the type of the value and
89  * sets the value with it.
90  *
91  * Note that this function is dangerous as it does not return any indication
92  * if the conversion worked or not.
93  */
94 void
95 gst_util_set_value_from_string (GValue * value, const gchar * value_str)
96 {
97   gboolean res;
98
99   g_return_if_fail (value != NULL);
100   g_return_if_fail (value_str != NULL);
101
102   GST_CAT_DEBUG (GST_CAT_PARAMS, "parsing '%s' to type %s", value_str,
103       g_type_name (G_VALUE_TYPE (value)));
104
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);
109     res = TRUE;
110   }
111   g_return_if_fail (res);
112 }
113
114 /**
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
119  *
120  * Converts the string value to the type of the objects argument and
121  * sets the argument with it.
122  *
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.
125  */
126 void
127 gst_util_set_object_arg (GObject * object, const gchar * name,
128     const gchar * value)
129 {
130   GParamSpec *pspec;
131   GType value_type;
132   GValue v = { 0, };
133
134   g_return_if_fail (G_IS_OBJECT (object));
135   g_return_if_fail (name != NULL);
136   g_return_if_fail (value != NULL);
137
138   pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), name);
139   if (!pspec)
140     return;
141
142   value_type = pspec->value_type;
143
144   GST_DEBUG ("pspec->flags is %d, pspec->value_type is %s",
145       pspec->flags, g_type_name (value_type));
146
147   if (!(pspec->flags & G_PARAM_WRITABLE))
148     return;
149
150   g_value_init (&v, value_type);
151
152   /* special case for element <-> xml (de)serialisation */
153   if (value_type == GST_TYPE_STRUCTURE && strcmp (value, "NULL") == 0) {
154     g_value_set_boxed (&v, NULL);
155     goto done;
156   }
157
158   if (!gst_value_deserialize (&v, value))
159     return;
160
161 done:
162
163   g_object_set_property (object, pspec->name, &v);
164   g_value_unset (&v);
165 }
166
167 /* work around error C2520: conversion from unsigned __int64 to double
168  * not implemented, use signed __int64
169  *
170  * These are implemented as functions because on some platforms a 64bit int to
171  * double conversion is not defined/implemented.
172  */
173
174 gdouble
175 gst_util_guint64_to_gdouble (guint64 value)
176 {
177   if (value & G_GINT64_CONSTANT (0x8000000000000000))
178     return (gdouble) ((gint64) value) + (gdouble) 18446744073709551616.;
179   else
180     return (gdouble) ((gint64) value);
181 }
182
183 guint64
184 gst_util_gdouble_to_guint64 (gdouble value)
185 {
186   if (value < (gdouble) 9223372036854775808.)   /* 1 << 63 */
187     return ((guint64) ((gint64) value));
188
189   value -= (gdouble) 18446744073709551616.;
190   return ((guint64) ((gint64) value));
191 }
192
193 #ifndef HAVE_UINT128_T
194 /* convenience struct for getting high and low uint32 parts of
195  * a guint64 */
196 typedef union
197 {
198   guint64 ll;
199   struct
200   {
201 #if G_BYTE_ORDER == G_BIG_ENDIAN
202     guint32 high, low;
203 #else
204     guint32 low, high;
205 #endif
206   } l;
207 } GstUInt64;
208
209 #if defined (__x86_64__) && defined (__GNUC__)
210 static inline void
211 gst_util_uint64_mul_uint64 (GstUInt64 * c1, GstUInt64 * c0, guint64 arg1,
212     guint64 arg2)
213 {
214   __asm__ __volatile__ ("mulq %3":"=a" (c0->ll), "=d" (c1->ll)
215       :"a" (arg1), "g" (arg2)
216       );
217 }
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. */
222 static inline void
223 gst_util_uint64_mul_uint64 (GstUInt64 * c1, GstUInt64 * c0, guint64 arg1,
224     guint64 arg2)
225 {
226   GstUInt64 a1, b0;
227   GstUInt64 v, n;
228
229   /* prepare input */
230   v.ll = arg1;
231   n.ll = arg2;
232
233   /* do 128 bits multiply
234    *                   nh   nl
235    *                *  vh   vl
236    *                ----------
237    * a0 =              vl * nl
238    * a1 =         vl * nh
239    * b0 =         vh * nl
240    * b1 =  + vh * nh
241    *       -------------------
242    *        c1h  c1l  c0h  c0l
243    *
244    * "a0" is optimized away, result is stored directly in c0.  "b1" is
245    * optimized away, result is stored directly in c1.
246    */
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;
250
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;
256
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;
260 }
261 #endif /* defined (__x86_64__) */
262
263 #if defined (__x86_64__) && defined (__GNUC__)
264 static inline guint64
265 gst_util_div128_64 (GstUInt64 c1, GstUInt64 c0, guint64 denom)
266 {
267   guint64 res;
268
269   __asm__ __volatile__ ("divq %3":"=a" (res)
270       :"d" (c1.ll), "a" (c0.ll), "g" (denom)
271       );
272
273   return res;
274 }
275 #else
276 /* count leading zeros */
277 static inline guint
278 gst_util_clz (guint32 val)
279 {
280   guint s;
281
282   s = val | (val >> 1);
283   s |= (s >> 2);
284   s |= (s >> 4);
285   s |= (s >> 8);
286   s = ~(s | (s >> 16));
287   s = s - ((s >> 1) & 0x55555555);
288   s = (s & 0x33333333) + ((s >> 2) & 0x33333333);
289   s = (s + (s >> 4)) & 0x0f0f0f0f;
290   s += (s >> 8);
291   s = (s + (s >> 16)) & 0x3f;
292
293   return s;
294 }
295
296 /* based on Hacker's Delight p152 */
297 static inline guint64
298 gst_util_div128_64 (GstUInt64 c1, GstUInt64 c0, guint64 denom)
299 {
300   GstUInt64 q1, q0, rhat;
301   GstUInt64 v, cmp1, cmp2;
302   guint s;
303
304   v.ll = denom;
305
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);
309
310   if (s > 0) {
311     /* normalize divisor and dividend */
312     v.ll <<= s;
313     c1.ll = (c1.ll << s) | (c0.l.high >> (32 - s));
314     c0.ll <<= s;
315   }
316
317   q1.ll = c1.ll / v.l.high;
318   rhat.ll = c1.ll - q1.ll * v.l.high;
319
320   cmp1.l.high = rhat.l.low;
321   cmp1.l.low = c0.l.high;
322   cmp2.ll = q1.ll * v.l.low;
323
324   while (q1.l.high || cmp2.ll > cmp1.ll) {
325     q1.ll--;
326     rhat.ll += v.l.high;
327     if (rhat.l.high)
328       break;
329     cmp1.l.high = rhat.l.low;
330     cmp2.ll -= v.l.low;
331   }
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;
337
338   cmp1.l.high = rhat.l.low;
339   cmp1.l.low = c0.l.low;
340   cmp2.ll = q0.ll * v.l.low;
341
342   while (q0.l.high || cmp2.ll > cmp1.ll) {
343     q0.ll--;
344     rhat.ll += v.l.high;
345     if (rhat.l.high)
346       break;
347     cmp1.l.high = rhat.l.low;
348     cmp2.ll -= v.l.low;
349   }
350   q0.l.high += q1.l.low;
351
352   return q0.ll;
353 }
354 #endif /* defined (__GNUC__) */
355
356 /* This always gives the correct result because:
357  * a) val <= G_MAXUINT64-1
358  * b) (c0,c1) <= G_MAXUINT64 * (G_MAXUINT64-1)
359  *    or
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.
364  */
365
366 /* add correction with carry */
367 #define CORRECT(c0,c1,val)                    \
368   if (val) {                                  \
369     if (G_MAXUINT64 - c0.ll < val) {          \
370       if (G_UNLIKELY (c1.ll == G_MAXUINT64))  \
371         /* overflow */                        \
372         return G_MAXUINT64;                   \
373       c1.ll++;                                \
374     }                                         \
375     c0.ll += val;                             \
376   }
377
378 static guint64
379 gst_util_uint64_scale_uint64_unchecked (guint64 val, guint64 num,
380     guint64 denom, guint64 correct)
381 {
382   GstUInt64 c1, c0;
383
384   /* compute 128-bit numerator product */
385   gst_util_uint64_mul_uint64 (&c1, &c0, val, num);
386
387   /* perform rounding correction */
388   CORRECT (c0, c1, correct);
389
390   /* high word as big as or bigger than denom --> overflow */
391   if (G_UNLIKELY (c1.ll >= denom))
392     return G_MAXUINT64;
393
394   /* compute quotient, fits in 64 bits */
395   return gst_util_div128_64 (c1, c0, denom);
396 }
397 #else
398
399 #define GST_MAXUINT128 ((__uint128_t) -1)
400 static guint64
401 gst_util_uint64_scale_uint64_unchecked (guint64 val, guint64 num,
402     guint64 denom, guint64 correct)
403 {
404   __uint128_t tmp;
405
406   /* Calculate val * num */
407   tmp = ((__uint128_t) val) * ((__uint128_t) num);
408
409   /* overflow checks */
410   if (G_UNLIKELY (GST_MAXUINT128 - correct < tmp))
411     return G_MAXUINT64;
412
413   /* perform rounding correction */
414   tmp += correct;
415
416   /* Divide by denom */
417   tmp /= denom;
418
419   /* if larger than G_MAXUINT64 --> overflow */
420   if (G_UNLIKELY (tmp > G_MAXUINT64))
421     return G_MAXUINT64;
422
423   /* compute quotient, fits in 64 bits */
424   return (guint64) tmp;
425 }
426
427 #endif
428
429 #if !defined (__x86_64__) && !defined (HAVE_UINT128_T)
430 static inline void
431 gst_util_uint64_mul_uint32 (GstUInt64 * c1, GstUInt64 * c0, guint64 arg1,
432     guint32 arg2)
433 {
434   GstUInt64 a;
435
436   a.ll = arg1;
437
438   c0->ll = (guint64) a.l.low * arg2;
439   c1->ll = (guint64) a.l.high * arg2 + c0->l.high;
440   c0->l.high = 0;
441 }
442
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)
448 {
449   c0 += (c1 % denom) << 32;
450   return ((c1 / denom) << 32) + (c0 / denom);
451 }
452
453 static inline guint64
454 gst_util_uint64_scale_uint32_unchecked (guint64 val, guint32 num,
455     guint32 denom, guint32 correct)
456 {
457   GstUInt64 c1, c0;
458
459   /* compute 96-bit numerator product */
460   gst_util_uint64_mul_uint32 (&c1, &c0, val, num);
461
462   /* condition numerator based on rounding mode */
463   CORRECT (c0, c1, correct);
464
465   /* high 32 bits as big as or bigger than denom --> overflow */
466   if (G_UNLIKELY (c1.l.high >= denom))
467     return G_MAXUINT64;
468
469   /* compute quotient, fits in 64 bits */
470   return gst_util_div96_32 (c1.ll, c0.ll, denom);
471 }
472 #endif
473
474 /* the guts of the gst_util_uint64_scale() variants */
475 static guint64
476 _gst_util_uint64_scale (guint64 val, guint64 num, guint64 denom,
477     guint64 correct)
478 {
479   g_return_val_if_fail (denom != 0, G_MAXUINT64);
480
481   if (G_UNLIKELY (num == 0))
482     return 0;
483
484   if (G_UNLIKELY (num == denom))
485     return val;
486
487   /* on 64bits we always use a full 128bits multiply/division */
488 #if !defined (__x86_64__) && !defined (HAVE_UINT128_T)
489   /* denom is low --> try to use 96 bit muldiv */
490   if (G_LIKELY (denom <= G_MAXUINT32)) {
491     /* num is low --> use 96 bit muldiv */
492     if (G_LIKELY (num <= G_MAXUINT32))
493       return gst_util_uint64_scale_uint32_unchecked (val, (guint32) num,
494           (guint32) denom, correct);
495
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);
500   }
501 #endif /* !defined (__x86_64__) && !defined (HAVE_UINT128_T) */
502
503   /* val is high and num is high --> use 128-bit muldiv */
504   return gst_util_uint64_scale_uint64_unchecked (val, num, denom, correct);
505 }
506
507 /**
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
512  *
513  * Scale @val by the rational number @num / @denom, avoiding overflows and
514  * underflows and without loss of precision.
515  *
516  * This function can potentially be very slow if val and num are both
517  * greater than G_MAXUINT32.
518  *
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().
525  */
526 guint64
527 gst_util_uint64_scale (guint64 val, guint64 num, guint64 denom)
528 {
529   return _gst_util_uint64_scale (val, num, denom, 0);
530 }
531
532 /**
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
537  *
538  * Scale @val by the rational number @num / @denom, avoiding overflows and
539  * underflows and without loss of precision.
540  *
541  * This function can potentially be very slow if val and num are both
542  * greater than G_MAXUINT32.
543  *
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().
550  */
551 guint64
552 gst_util_uint64_scale_round (guint64 val, guint64 num, guint64 denom)
553 {
554   return _gst_util_uint64_scale (val, num, denom, denom >> 1);
555 }
556
557 /**
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
562  *
563  * Scale @val by the rational number @num / @denom, avoiding overflows and
564  * underflows and without loss of precision.
565  *
566  * This function can potentially be very slow if val and num are both
567  * greater than G_MAXUINT32.
568  *
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().
575  */
576 guint64
577 gst_util_uint64_scale_ceil (guint64 val, guint64 num, guint64 denom)
578 {
579   return _gst_util_uint64_scale (val, num, denom, denom - 1);
580 }
581
582 /* the guts of the gst_util_uint64_scale_int() variants */
583 static guint64
584 _gst_util_uint64_scale_int (guint64 val, gint num, gint denom, gint correct)
585 {
586   g_return_val_if_fail (denom > 0, G_MAXUINT64);
587   g_return_val_if_fail (num >= 0, G_MAXUINT64);
588
589   if (G_UNLIKELY (num == 0))
590     return 0;
591
592   if (G_UNLIKELY (num == denom))
593     return val;
594
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 */
602     val += correct;
603
604     return val / (guint64) denom;
605   }
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);
610 #else
611   /* always use full 128bits scale */
612   return gst_util_uint64_scale_uint64_unchecked (val, num, denom, correct);
613 #endif
614 }
615
616 /**
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.
621  *
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.
625  *
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().
632  */
633 guint64
634 gst_util_uint64_scale_int (guint64 val, gint num, gint denom)
635 {
636   return _gst_util_uint64_scale_int (val, num, denom, 0);
637 }
638
639 /**
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.
644  *
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.
648  *
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().
655  */
656 guint64
657 gst_util_uint64_scale_int_round (guint64 val, gint num, gint denom)
658 {
659   /* we can use a shift to divide by 2 because denom is required to be
660    * positive. */
661   return _gst_util_uint64_scale_int (val, num, denom, denom >> 1);
662 }
663
664 /**
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.
669  *
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.
673  *
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().
680  */
681 guint64
682 gst_util_uint64_scale_int_ceil (guint64 val, gint num, gint denom)
683 {
684   return _gst_util_uint64_scale_int (val, num, denom, denom - 1);
685 }
686
687 /**
688  * gst_util_seqnum_next:
689  *
690  * Return a constantly incrementing sequence number.
691  *
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.
696  *
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.
700  */
701 guint32
702 gst_util_seqnum_next (void)
703 {
704   static gint counter = 0;
705   return g_atomic_int_add (&counter, 1);
706 }
707
708 /**
709  * gst_util_seqnum_compare:
710  * @s1: A sequence number.
711  * @s2: Another sequence number.
712  *
713  * Compare two sequence numbers, handling wraparound.
714  *
715  * The current implementation just returns (gint32)(@s1 - @s2).
716  *
717  * Returns: A negative number if @s1 is before @s2, 0 if they are equal, or a
718  * positive number if @s1 is after @s2.
719  */
720 gint32
721 gst_util_seqnum_compare (guint32 s1, guint32 s2)
722 {
723   return (gint32) (s1 - s2);
724 }
725
726 /* -----------------------------------------------------
727  *
728  *  The following code will be moved out of the main
729  * gstreamer library someday.
730  */
731
732 #include "gstpad.h"
733
734 /**
735  * gst_element_create_all_pads:
736  * @element: (transfer none): a #GstElement to create pads for
737  *
738  * Creates a pad for each pad template that is always available.
739  * This function is only useful during object initialization of
740  * subclasses of #GstElement.
741  */
742 void
743 gst_element_create_all_pads (GstElement * element)
744 {
745   GList *padlist;
746
747   /* FIXME: lock element */
748
749   padlist =
750       gst_element_class_get_pad_template_list (GST_ELEMENT_CLASS
751       (G_OBJECT_GET_CLASS (element)));
752
753   while (padlist) {
754     GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
755
756     if (padtempl->presence == GST_PAD_ALWAYS) {
757       GstPad *pad;
758
759       pad = gst_pad_new_from_template (padtempl, padtempl->name_template);
760
761       gst_element_add_pad (element, pad);
762     }
763     padlist = padlist->next;
764   }
765 }
766
767 /**
768  * gst_element_get_compatible_pad_template:
769  * @element: (transfer none): a #GstElement to get a compatible pad template for
770  * @compattempl: (transfer none): the #GstPadTemplate to find a compatible
771  *     template for
772  *
773  * Retrieves a pad template from @element that is compatible with @compattempl.
774  * Pads from compatible templates can be linked together.
775  *
776  * Returns: (transfer none) (nullable): a compatible #GstPadTemplate,
777  *   or %NULL if none was found. No unreferencing is necessary.
778  */
779 GstPadTemplate *
780 gst_element_get_compatible_pad_template (GstElement * element,
781     GstPadTemplate * compattempl)
782 {
783   GstPadTemplate *newtempl = NULL;
784   GList *padlist;
785   GstElementClass *class;
786   gboolean compatible;
787
788   g_return_val_if_fail (element != NULL, NULL);
789   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
790   g_return_val_if_fail (compattempl != NULL, NULL);
791
792   class = GST_ELEMENT_GET_CLASS (element);
793
794   padlist = gst_element_class_get_pad_template_list (class);
795
796   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
797       "Looking for a suitable pad template in %s out of %d templates...",
798       GST_ELEMENT_NAME (element), g_list_length (padlist));
799
800   while (padlist) {
801     GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
802
803     /* Ignore name
804      * Ignore presence
805      * Check direction (must be opposite)
806      * Check caps
807      */
808     GST_CAT_LOG (GST_CAT_CAPS,
809         "checking pad template %s", padtempl->name_template);
810     if (padtempl->direction != compattempl->direction) {
811       GST_CAT_DEBUG (GST_CAT_CAPS,
812           "compatible direction: found %s pad template \"%s\"",
813           padtempl->direction == GST_PAD_SRC ? "src" : "sink",
814           padtempl->name_template);
815
816       GST_CAT_DEBUG (GST_CAT_CAPS,
817           "intersecting %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (compattempl));
818       GST_CAT_DEBUG (GST_CAT_CAPS,
819           "..and %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (padtempl));
820
821       compatible = gst_caps_can_intersect (GST_PAD_TEMPLATE_CAPS (compattempl),
822           GST_PAD_TEMPLATE_CAPS (padtempl));
823
824       GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
825           (compatible ? "" : "not "));
826
827       if (compatible) {
828         newtempl = padtempl;
829         break;
830       }
831     }
832
833     padlist = g_list_next (padlist);
834   }
835   if (newtempl)
836     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
837         "Returning new pad template %p", newtempl);
838   else
839     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "No compatible pad template found");
840
841   return newtempl;
842 }
843
844 /**
845  * gst_element_get_pad_from_template:
846  * @element: (transfer none): a #GstElement.
847  * @templ: (transfer none): a #GstPadTemplate belonging to @element.
848  *
849  * Gets a pad from @element described by @templ. If the presence of @templ is
850  * #GST_PAD_REQUEST, requests a new pad. Can return %NULL for #GST_PAD_SOMETIMES
851  * templates.
852  *
853  * Returns: (transfer full) (nullable): the #GstPad, or %NULL if one
854  *   could not be found or created.
855  */
856 static GstPad *
857 gst_element_get_pad_from_template (GstElement * element, GstPadTemplate * templ)
858 {
859   GstPad *ret = NULL;
860   GstPadPresence presence;
861
862   /* If this function is ever exported, we need check the validity of `element'
863    * and `templ', and to make sure the template actually belongs to the
864    * element. */
865
866   presence = GST_PAD_TEMPLATE_PRESENCE (templ);
867
868   switch (presence) {
869     case GST_PAD_ALWAYS:
870     case GST_PAD_SOMETIMES:
871       ret = gst_element_get_static_pad (element, templ->name_template);
872       if (!ret && presence == GST_PAD_ALWAYS)
873         g_warning
874             ("Element %s has an ALWAYS template %s, but no pad of the same name",
875             GST_OBJECT_NAME (element), templ->name_template);
876       break;
877
878     case GST_PAD_REQUEST:
879       ret = gst_element_request_pad (element, templ, NULL, NULL);
880       break;
881   }
882
883   return ret;
884 }
885
886 /*
887  * gst_element_request_compatible_pad:
888  * @element: a #GstElement.
889  * @templ: the #GstPadTemplate to which the new pad should be able to link.
890  *
891  * Requests a pad from @element. The returned pad should be unlinked and
892  * compatible with @templ. Might return an existing pad, or request a new one.
893  *
894  * Returns: (nullable): a #GstPad, or %NULL if one could not be found
895  *   or created.
896  */
897 static GstPad *
898 gst_element_request_compatible_pad (GstElement * element,
899     GstPadTemplate * templ)
900 {
901   GstPadTemplate *templ_new;
902   GstPad *pad = NULL;
903
904   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
905   g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
906
907   /* FIXME: should really loop through the templates, testing each for
908    *      compatibility and pad availability. */
909   templ_new = gst_element_get_compatible_pad_template (element, templ);
910   if (templ_new)
911     pad = gst_element_get_pad_from_template (element, templ_new);
912
913   /* This can happen for non-request pads. No need to unref. */
914   if (pad && GST_PAD_PEER (pad))
915     pad = NULL;
916
917   return pad;
918 }
919
920 /*
921  * Checks if the source pad and the sink pad can be linked.
922  * Both @srcpad and @sinkpad must be unlinked and have a parent.
923  */
924 static gboolean
925 gst_pad_check_link (GstPad * srcpad, GstPad * sinkpad)
926 {
927   /* generic checks */
928   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
929   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
930
931   GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
932       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
933
934   if (GST_PAD_PEER (srcpad) != NULL) {
935     GST_CAT_INFO (GST_CAT_PADS, "Source pad %s:%s has a peer, failed",
936         GST_DEBUG_PAD_NAME (srcpad));
937     return FALSE;
938   }
939   if (GST_PAD_PEER (sinkpad) != NULL) {
940     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has a peer, failed",
941         GST_DEBUG_PAD_NAME (sinkpad));
942     return FALSE;
943   }
944   if (!GST_PAD_IS_SRC (srcpad)) {
945     GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s is not source pad, failed",
946         GST_DEBUG_PAD_NAME (srcpad));
947     return FALSE;
948   }
949   if (!GST_PAD_IS_SINK (sinkpad)) {
950     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s is not sink pad, failed",
951         GST_DEBUG_PAD_NAME (sinkpad));
952     return FALSE;
953   }
954   if (GST_PAD_PARENT (srcpad) == NULL) {
955     GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s has no parent, failed",
956         GST_DEBUG_PAD_NAME (srcpad));
957     return FALSE;
958   }
959   if (GST_PAD_PARENT (sinkpad) == NULL) {
960     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has no parent, failed",
961         GST_DEBUG_PAD_NAME (srcpad));
962     return FALSE;
963   }
964
965   return TRUE;
966 }
967
968 /**
969  * gst_element_get_compatible_pad:
970  * @element: (transfer none): a #GstElement in which the pad should be found.
971  * @pad: (transfer none): the #GstPad to find a compatible one for.
972  * @caps: (allow-none): the #GstCaps to use as a filter.
973  *
974  * Looks for an unlinked pad to which the given pad can link. It is not
975  * guaranteed that linking the pads will work, though it should work in most
976  * cases.
977  *
978  * This function will first attempt to find a compatible unlinked ALWAYS pad,
979  * and if none can be found, it will request a compatible REQUEST pad by looking
980  * at the templates of @element.
981  *
982  * Returns: (transfer full) (nullable): the #GstPad to which a link
983  *   can be made, or %NULL if one cannot be found. gst_object_unref()
984  *   after usage.
985  */
986 GstPad *
987 gst_element_get_compatible_pad (GstElement * element, GstPad * pad,
988     GstCaps * caps)
989 {
990   GstIterator *pads;
991   GstPadTemplate *templ;
992   GstCaps *templcaps;
993   GstPad *foundpad = NULL;
994   gboolean done;
995   GValue padptr = { 0, };
996
997   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
998   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
999
1000   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1001       "finding pad in %s compatible with %s:%s",
1002       GST_ELEMENT_NAME (element), GST_DEBUG_PAD_NAME (pad));
1003
1004   g_return_val_if_fail (GST_PAD_PEER (pad) == NULL, NULL);
1005
1006   done = FALSE;
1007
1008   /* try to get an existing unlinked pad */
1009   if (GST_PAD_IS_SRC (pad)) {
1010     pads = gst_element_iterate_sink_pads (element);
1011   } else if (GST_PAD_IS_SINK (pad)) {
1012     pads = gst_element_iterate_src_pads (element);
1013   } else {
1014     pads = gst_element_iterate_pads (element);
1015   }
1016
1017   while (!done) {
1018     switch (gst_iterator_next (pads, &padptr)) {
1019       case GST_ITERATOR_OK:
1020       {
1021         GstPad *peer;
1022         GstPad *current;
1023         GstPad *srcpad;
1024         GstPad *sinkpad;
1025
1026         current = g_value_get_object (&padptr);
1027
1028         GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
1029             GST_DEBUG_PAD_NAME (current));
1030
1031         if (GST_PAD_IS_SRC (current)) {
1032           srcpad = current;
1033           sinkpad = pad;
1034         } else {
1035           srcpad = pad;
1036           sinkpad = current;
1037         }
1038         peer = gst_pad_get_peer (current);
1039
1040         if (peer == NULL && gst_pad_check_link (srcpad, sinkpad)) {
1041           GstCaps *temp, *intersection;
1042           gboolean compatible;
1043
1044           /* Now check if the two pads' caps are compatible */
1045           temp = gst_pad_query_caps (pad, NULL);
1046           if (caps) {
1047             intersection = gst_caps_intersect (temp, caps);
1048             gst_caps_unref (temp);
1049           } else {
1050             intersection = temp;
1051           }
1052
1053           temp = gst_pad_query_caps (current, NULL);
1054           compatible = gst_caps_can_intersect (temp, intersection);
1055           gst_caps_unref (temp);
1056           gst_caps_unref (intersection);
1057
1058           if (compatible) {
1059             GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1060                 "found existing unlinked compatible pad %s:%s",
1061                 GST_DEBUG_PAD_NAME (current));
1062             gst_iterator_free (pads);
1063
1064             current = gst_object_ref (current);
1065             g_value_unset (&padptr);
1066
1067             return current;
1068           } else {
1069             GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "incompatible pads");
1070           }
1071         } else {
1072           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1073               "already linked or cannot be linked (peer = %p)", peer);
1074         }
1075         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unreffing pads");
1076
1077         g_value_reset (&padptr);
1078         if (peer)
1079           gst_object_unref (peer);
1080         break;
1081       }
1082       case GST_ITERATOR_DONE:
1083         done = TRUE;
1084         break;
1085       case GST_ITERATOR_RESYNC:
1086         gst_iterator_resync (pads);
1087         break;
1088       case GST_ITERATOR_ERROR:
1089         g_assert_not_reached ();
1090         break;
1091     }
1092   }
1093   g_value_unset (&padptr);
1094   gst_iterator_free (pads);
1095
1096   GST_CAT_DEBUG_OBJECT (GST_CAT_ELEMENT_PADS, element,
1097       "Could not find a compatible unlinked always pad to link to %s:%s, now checking request pads",
1098       GST_DEBUG_PAD_NAME (pad));
1099
1100   /* try to create a new one */
1101   /* requesting is a little crazy, we need a template. Let's create one */
1102   templcaps = gst_pad_query_caps (pad, NULL);
1103   if (caps) {
1104     GstCaps *inter = gst_caps_intersect (templcaps, caps);
1105
1106     gst_caps_unref (templcaps);
1107     templcaps = inter;
1108   }
1109   templ = gst_pad_template_new ((gchar *) GST_PAD_NAME (pad),
1110       GST_PAD_DIRECTION (pad), GST_PAD_ALWAYS, templcaps);
1111   gst_caps_unref (templcaps);
1112
1113   foundpad = gst_element_request_compatible_pad (element, templ);
1114   gst_object_unref (templ);
1115
1116   if (foundpad) {
1117     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1118         "found existing request pad %s:%s", GST_DEBUG_PAD_NAME (foundpad));
1119     return foundpad;
1120   }
1121
1122   GST_CAT_INFO_OBJECT (GST_CAT_ELEMENT_PADS, element,
1123       "Could not find a compatible pad to link to %s:%s",
1124       GST_DEBUG_PAD_NAME (pad));
1125   return NULL;
1126 }
1127
1128 /**
1129  * gst_element_state_get_name:
1130  * @state: a #GstState to get the name of.
1131  *
1132  * Gets a string representing the given state.
1133  *
1134  * Returns: (transfer none): a string with the name of the state.
1135  */
1136 const gchar *
1137 gst_element_state_get_name (GstState state)
1138 {
1139   switch (state) {
1140     case GST_STATE_VOID_PENDING:
1141       return "VOID_PENDING";
1142     case GST_STATE_NULL:
1143       return "NULL";
1144     case GST_STATE_READY:
1145       return "READY";
1146     case GST_STATE_PLAYING:
1147       return "PLAYING";
1148     case GST_STATE_PAUSED:
1149       return "PAUSED";
1150     default:
1151       /* This is a memory leak */
1152       return g_strdup_printf ("UNKNOWN!(%d)", state);
1153   }
1154 }
1155
1156 /**
1157  * gst_element_state_change_return_get_name:
1158  * @state_ret: a #GstStateChangeReturn to get the name of.
1159  *
1160  * Gets a string representing the given state change result.
1161  *
1162  * Returns: (transfer none): a string with the name of the state
1163  *    result.
1164  */
1165 const gchar *
1166 gst_element_state_change_return_get_name (GstStateChangeReturn state_ret)
1167 {
1168   switch (state_ret) {
1169     case GST_STATE_CHANGE_FAILURE:
1170       return "FAILURE";
1171     case GST_STATE_CHANGE_SUCCESS:
1172       return "SUCCESS";
1173     case GST_STATE_CHANGE_ASYNC:
1174       return "ASYNC";
1175     case GST_STATE_CHANGE_NO_PREROLL:
1176       return "NO PREROLL";
1177     default:
1178       /* This is a memory leak */
1179       return g_strdup_printf ("UNKNOWN!(%d)", state_ret);
1180   }
1181 }
1182
1183
1184 static gboolean
1185 gst_element_factory_can_accept_all_caps_in_direction (GstElementFactory *
1186     factory, const GstCaps * caps, GstPadDirection direction)
1187 {
1188   GList *templates;
1189
1190   g_return_val_if_fail (factory != NULL, FALSE);
1191   g_return_val_if_fail (caps != NULL, FALSE);
1192
1193   templates = factory->staticpadtemplates;
1194
1195   while (templates) {
1196     GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1197
1198     if (template->direction == direction) {
1199       GstCaps *templcaps = gst_static_caps_get (&template->static_caps);
1200
1201       if (gst_caps_is_always_compatible (caps, templcaps)) {
1202         gst_caps_unref (templcaps);
1203         return TRUE;
1204       }
1205       gst_caps_unref (templcaps);
1206     }
1207     templates = g_list_next (templates);
1208   }
1209
1210   return FALSE;
1211 }
1212
1213 static gboolean
1214 gst_element_factory_can_accept_any_caps_in_direction (GstElementFactory *
1215     factory, const GstCaps * caps, GstPadDirection direction)
1216 {
1217   GList *templates;
1218
1219   g_return_val_if_fail (factory != NULL, FALSE);
1220   g_return_val_if_fail (caps != NULL, FALSE);
1221
1222   templates = factory->staticpadtemplates;
1223
1224   while (templates) {
1225     GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1226
1227     if (template->direction == direction) {
1228       GstCaps *templcaps = gst_static_caps_get (&template->static_caps);
1229
1230       if (gst_caps_can_intersect (caps, templcaps)) {
1231         gst_caps_unref (templcaps);
1232         return TRUE;
1233       }
1234       gst_caps_unref (templcaps);
1235     }
1236     templates = g_list_next (templates);
1237   }
1238
1239   return FALSE;
1240 }
1241
1242 /**
1243  * gst_element_factory_can_sink_all_caps:
1244  * @factory: factory to query
1245  * @caps: the caps to check
1246  *
1247  * Checks if the factory can sink all possible capabilities.
1248  *
1249  * Returns: %TRUE if the caps are fully compatible.
1250  */
1251 gboolean
1252 gst_element_factory_can_sink_all_caps (GstElementFactory * factory,
1253     const GstCaps * caps)
1254 {
1255   return gst_element_factory_can_accept_all_caps_in_direction (factory, caps,
1256       GST_PAD_SINK);
1257 }
1258
1259 /**
1260  * gst_element_factory_can_src_all_caps:
1261  * @factory: factory to query
1262  * @caps: the caps to check
1263  *
1264  * Checks if the factory can src all possible capabilities.
1265  *
1266  * Returns: %TRUE if the caps are fully compatible.
1267  */
1268 gboolean
1269 gst_element_factory_can_src_all_caps (GstElementFactory * factory,
1270     const GstCaps * caps)
1271 {
1272   return gst_element_factory_can_accept_all_caps_in_direction (factory, caps,
1273       GST_PAD_SRC);
1274 }
1275
1276 /**
1277  * gst_element_factory_can_sink_any_caps:
1278  * @factory: factory to query
1279  * @caps: the caps to check
1280  *
1281  * Checks if the factory can sink any possible capability.
1282  *
1283  * Returns: %TRUE if the caps have a common subset.
1284  */
1285 gboolean
1286 gst_element_factory_can_sink_any_caps (GstElementFactory * factory,
1287     const GstCaps * caps)
1288 {
1289   return gst_element_factory_can_accept_any_caps_in_direction (factory, caps,
1290       GST_PAD_SINK);
1291 }
1292
1293 /**
1294  * gst_element_factory_can_src_any_caps:
1295  * @factory: factory to query
1296  * @caps: the caps to check
1297  *
1298  * Checks if the factory can src any possible capability.
1299  *
1300  * Returns: %TRUE if the caps have a common subset.
1301  */
1302 gboolean
1303 gst_element_factory_can_src_any_caps (GstElementFactory * factory,
1304     const GstCaps * caps)
1305 {
1306   return gst_element_factory_can_accept_any_caps_in_direction (factory, caps,
1307       GST_PAD_SRC);
1308 }
1309
1310 /* if return val is true, *direct_child is a caller-owned ref on the direct
1311  * child of ancestor that is part of object's ancestry */
1312 static gboolean
1313 object_has_ancestor (GstObject * object, GstObject * ancestor,
1314     GstObject ** direct_child)
1315 {
1316   GstObject *child, *parent;
1317
1318   if (direct_child)
1319     *direct_child = NULL;
1320
1321   child = gst_object_ref (object);
1322   parent = gst_object_get_parent (object);
1323
1324   while (parent) {
1325     if (ancestor == parent) {
1326       if (direct_child)
1327         *direct_child = child;
1328       else
1329         gst_object_unref (child);
1330       gst_object_unref (parent);
1331       return TRUE;
1332     }
1333
1334     gst_object_unref (child);
1335     child = parent;
1336     parent = gst_object_get_parent (parent);
1337   }
1338
1339   gst_object_unref (child);
1340
1341   return FALSE;
1342 }
1343
1344 /* caller owns return */
1345 static GstObject *
1346 find_common_root (GstObject * o1, GstObject * o2)
1347 {
1348   GstObject *top = o1;
1349   GstObject *kid1, *kid2;
1350   GstObject *root = NULL;
1351
1352   while (GST_OBJECT_PARENT (top))
1353     top = GST_OBJECT_PARENT (top);
1354
1355   /* the itsy-bitsy spider... */
1356
1357   if (!object_has_ancestor (o2, top, &kid2))
1358     return NULL;
1359
1360   root = gst_object_ref (top);
1361   while (TRUE) {
1362     if (!object_has_ancestor (o1, kid2, &kid1)) {
1363       gst_object_unref (kid2);
1364       return root;
1365     }
1366     root = kid2;
1367     if (!object_has_ancestor (o2, kid1, &kid2)) {
1368       gst_object_unref (kid1);
1369       return root;
1370     }
1371     root = kid1;
1372   }
1373 }
1374
1375 /* caller does not own return */
1376 static GstPad *
1377 ghost_up (GstElement * e, GstPad * pad)
1378 {
1379   static gint ghost_pad_index = 0;
1380   GstPad *gpad;
1381   gchar *name;
1382   GstState current;
1383   GstState next;
1384   GstObject *parent = GST_OBJECT_PARENT (e);
1385
1386   name = g_strdup_printf ("ghost%d", ghost_pad_index++);
1387   gpad = gst_ghost_pad_new (name, pad);
1388   g_free (name);
1389
1390   GST_STATE_LOCK (e);
1391   gst_element_get_state (e, &current, &next, 0);
1392
1393   if (current > GST_STATE_READY || next == GST_STATE_PAUSED)
1394     gst_pad_set_active (gpad, TRUE);
1395
1396   if (!gst_element_add_pad ((GstElement *) parent, gpad)) {
1397     g_warning ("Pad named %s already exists in element %s\n",
1398         GST_OBJECT_NAME (gpad), GST_OBJECT_NAME (parent));
1399     gst_object_unref ((GstObject *) gpad);
1400     GST_STATE_UNLOCK (e);
1401     return NULL;
1402   }
1403   GST_STATE_UNLOCK (e);
1404
1405   return gpad;
1406 }
1407
1408 static void
1409 remove_pad (gpointer ppad, gpointer unused)
1410 {
1411   GstPad *pad = ppad;
1412
1413   if (!gst_element_remove_pad ((GstElement *) GST_OBJECT_PARENT (pad), pad))
1414     g_warning ("Couldn't remove pad %s from element %s",
1415         GST_OBJECT_NAME (pad), GST_OBJECT_NAME (GST_OBJECT_PARENT (pad)));
1416 }
1417
1418 static gboolean
1419 prepare_link_maybe_ghosting (GstPad ** src, GstPad ** sink,
1420     GSList ** pads_created)
1421 {
1422   GstObject *root;
1423   GstObject *e1, *e2;
1424   GSList *pads_created_local = NULL;
1425
1426   g_assert (pads_created);
1427
1428   e1 = GST_OBJECT_PARENT (*src);
1429   e2 = GST_OBJECT_PARENT (*sink);
1430
1431   if (G_UNLIKELY (e1 == NULL)) {
1432     GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1433         GST_PTR_FORMAT, *src);
1434     return FALSE;
1435   }
1436   if (G_UNLIKELY (e2 == NULL)) {
1437     GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1438         GST_PTR_FORMAT, *sink);
1439     return FALSE;
1440   }
1441
1442   if (GST_OBJECT_PARENT (e1) == GST_OBJECT_PARENT (e2)) {
1443     GST_CAT_INFO (GST_CAT_PADS, "%s and %s in same bin, no need for ghost pads",
1444         GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1445     return TRUE;
1446   }
1447
1448   GST_CAT_INFO (GST_CAT_PADS, "%s and %s not in same bin, making ghost pads",
1449       GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1450
1451   /* we need to setup some ghost pads */
1452   root = find_common_root (e1, e2);
1453   if (!root) {
1454     if (GST_OBJECT_PARENT (e1) == NULL)
1455       g_warning ("Trying to link elements %s and %s that don't share a common "
1456           "ancestor: %s hasn't been added to a bin or pipeline, but %s is in %s",
1457           GST_ELEMENT_NAME (e1), GST_ELEMENT_NAME (e2),
1458           GST_ELEMENT_NAME (e1), GST_ELEMENT_NAME (e2),
1459           GST_ELEMENT_NAME (GST_OBJECT_PARENT (e2)));
1460     else if (GST_OBJECT_PARENT (e2) == NULL)
1461       g_warning ("Trying to link elements %s and %s that don't share a common "
1462           "ancestor: %s hasn't been added to a bin or pipeline, and %s is in %s",
1463           GST_ELEMENT_NAME (e1), GST_ELEMENT_NAME (e2),
1464           GST_ELEMENT_NAME (e2), GST_ELEMENT_NAME (e1),
1465           GST_ELEMENT_NAME (GST_OBJECT_PARENT (e1)));
1466     else
1467       g_warning ("Trying to link elements %s and %s that don't share a common "
1468           "ancestor: %s is in %s, and %s is in %s",
1469           GST_ELEMENT_NAME (e1), GST_ELEMENT_NAME (e2),
1470           GST_ELEMENT_NAME (e1), GST_ELEMENT_NAME (GST_OBJECT_PARENT (e1)),
1471           GST_ELEMENT_NAME (e2), GST_ELEMENT_NAME (GST_OBJECT_PARENT (e2)));
1472     return FALSE;
1473   }
1474
1475   while (GST_OBJECT_PARENT (e1) != root) {
1476     *src = ghost_up ((GstElement *) e1, *src);
1477     if (!*src)
1478       goto cleanup_fail;
1479     e1 = GST_OBJECT_PARENT (*src);
1480     pads_created_local = g_slist_prepend (pads_created_local, *src);
1481   }
1482   while (GST_OBJECT_PARENT (e2) != root) {
1483     *sink = ghost_up ((GstElement *) e2, *sink);
1484     if (!*sink)
1485       goto cleanup_fail;
1486     e2 = GST_OBJECT_PARENT (*sink);
1487     pads_created_local = g_slist_prepend (pads_created_local, *sink);
1488   }
1489
1490   gst_object_unref (root);
1491   *pads_created = g_slist_concat (*pads_created, pads_created_local);
1492   return TRUE;
1493
1494 cleanup_fail:
1495   gst_object_unref (root);
1496   g_slist_foreach (pads_created_local, remove_pad, NULL);
1497   g_slist_free (pads_created_local);
1498   return FALSE;
1499 }
1500
1501 static gboolean
1502 pad_link_maybe_ghosting (GstPad * src, GstPad * sink, GstPadLinkCheck flags)
1503 {
1504   GSList *pads_created = NULL;
1505   gboolean ret;
1506
1507   if (!prepare_link_maybe_ghosting (&src, &sink, &pads_created)) {
1508     ret = FALSE;
1509   } else {
1510     ret = (gst_pad_link_full (src, sink, flags) == GST_PAD_LINK_OK);
1511   }
1512
1513   if (!ret) {
1514     g_slist_foreach (pads_created, remove_pad, NULL);
1515   }
1516   g_slist_free (pads_created);
1517
1518   return ret;
1519 }
1520
1521 /**
1522  * gst_pad_link_maybe_ghosting_full:
1523  * @src: a #GstPad
1524  * @sink: a #GstPad
1525  * @flags: some #GstPadLinkCheck flags
1526  *
1527  * Links @src to @sink, creating any #GstGhostPad's in between as necessary.
1528  *
1529  * This is a convenience function to save having to create and add intermediate
1530  * #GstGhostPad's as required for linking across #GstBin boundaries.
1531  *
1532  * If @src or @sink pads don't have parent elements or do not share a common
1533  * ancestor, the link will fail.
1534  *
1535  * Calling gst_pad_link_maybe_ghosting_full() with
1536  * @flags == %GST_PAD_LINK_CHECK_DEFAULT is the recommended way of linking
1537  * pads with safety checks applied.
1538  *
1539  * Returns: whether the link succeeded.
1540  *
1541  * Since: 1.10
1542  */
1543 gboolean
1544 gst_pad_link_maybe_ghosting_full (GstPad * src, GstPad * sink,
1545     GstPadLinkCheck flags)
1546 {
1547   g_return_val_if_fail (GST_IS_PAD (src), FALSE);
1548   g_return_val_if_fail (GST_IS_PAD (sink), FALSE);
1549
1550   return pad_link_maybe_ghosting (src, sink, flags);
1551 }
1552
1553 static void
1554 release_and_unref_pad (GstElement * element, GstPad * pad, gboolean requestpad)
1555 {
1556   if (pad) {
1557     if (requestpad)
1558       gst_element_release_request_pad (element, pad);
1559     gst_object_unref (pad);
1560   }
1561 }
1562
1563 /**
1564  * gst_element_link_pads_full:
1565  * @src: a #GstElement containing the source pad.
1566  * @srcpadname: (allow-none): the name of the #GstPad in source element
1567  *     or %NULL for any pad.
1568  * @dest: (transfer none): the #GstElement containing the destination pad.
1569  * @destpadname: (allow-none): the name of the #GstPad in destination element,
1570  * or %NULL for any pad.
1571  * @flags: the #GstPadLinkCheck to be performed when linking pads.
1572  *
1573  * Links the two named pads of the source and destination elements.
1574  * Side effect is that if one of the pads has no parent, it becomes a
1575  * child of the parent of the other element.  If they have different
1576  * parents, the link fails.
1577  *
1578  * Calling gst_element_link_pads_full() with @flags == %GST_PAD_LINK_CHECK_DEFAULT
1579  * is the same as calling gst_element_link_pads() and the recommended way of
1580  * linking pads with safety checks applied.
1581  *
1582  * This is a convenience function for gst_pad_link_full().
1583  *
1584  * Returns: %TRUE if the pads could be linked, %FALSE otherwise.
1585  */
1586 gboolean
1587 gst_element_link_pads_full (GstElement * src, const gchar * srcpadname,
1588     GstElement * dest, const gchar * destpadname, GstPadLinkCheck flags)
1589 {
1590   const GList *srcpads, *destpads, *srctempls, *desttempls, *l;
1591   GstPad *srcpad, *destpad;
1592   GstPadTemplate *srctempl, *desttempl;
1593   GstElementClass *srcclass, *destclass;
1594   gboolean srcrequest, destrequest;
1595
1596   /* checks */
1597   g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1598   g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1599
1600   GST_CAT_INFO (GST_CAT_ELEMENT_PADS,
1601       "trying to link element %s:%s to element %s:%s", GST_ELEMENT_NAME (src),
1602       srcpadname ? srcpadname : "(any)", GST_ELEMENT_NAME (dest),
1603       destpadname ? destpadname : "(any)");
1604
1605   srcrequest = FALSE;
1606   destrequest = FALSE;
1607
1608   /* get a src pad */
1609   if (srcpadname) {
1610     /* name specified, look it up */
1611     if (!(srcpad = gst_element_get_static_pad (src, srcpadname))) {
1612       if ((srcpad = gst_element_get_request_pad (src, srcpadname)))
1613         srcrequest = TRUE;
1614     }
1615     if (!srcpad) {
1616       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1617           GST_ELEMENT_NAME (src), srcpadname);
1618       return FALSE;
1619     } else {
1620       if (!(GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC)) {
1621         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no src pad",
1622             GST_DEBUG_PAD_NAME (srcpad));
1623         release_and_unref_pad (src, srcpad, srcrequest);
1624         return FALSE;
1625       }
1626       if (GST_PAD_PEER (srcpad) != NULL) {
1627         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1628             "pad %s:%s is already linked to %s:%s", GST_DEBUG_PAD_NAME (srcpad),
1629             GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
1630         /* already linked request pads look like static pads, so the request pad
1631          * was never requested a second time above, so no need to release it */
1632         gst_object_unref (srcpad);
1633         return FALSE;
1634       }
1635     }
1636     srcpads = NULL;
1637   } else {
1638     /* no name given, get the first available pad */
1639     GST_OBJECT_LOCK (src);
1640     srcpads = GST_ELEMENT_PADS (src);
1641     srcpad = srcpads ? GST_PAD_CAST (srcpads->data) : NULL;
1642     if (srcpad)
1643       gst_object_ref (srcpad);
1644     GST_OBJECT_UNLOCK (src);
1645   }
1646
1647   /* get a destination pad */
1648   if (destpadname) {
1649     /* name specified, look it up */
1650     if (!(destpad = gst_element_get_static_pad (dest, destpadname))) {
1651       if ((destpad = gst_element_get_request_pad (dest, destpadname)))
1652         destrequest = TRUE;
1653     }
1654     if (!destpad) {
1655       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1656           GST_ELEMENT_NAME (dest), destpadname);
1657       release_and_unref_pad (src, srcpad, srcrequest);
1658       return FALSE;
1659     } else {
1660       if (!(GST_PAD_DIRECTION (destpad) == GST_PAD_SINK)) {
1661         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no sink pad",
1662             GST_DEBUG_PAD_NAME (destpad));
1663         release_and_unref_pad (src, srcpad, srcrequest);
1664         release_and_unref_pad (dest, destpad, destrequest);
1665         return FALSE;
1666       }
1667       if (GST_PAD_PEER (destpad) != NULL) {
1668         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1669             "pad %s:%s is already linked to %s:%s",
1670             GST_DEBUG_PAD_NAME (destpad),
1671             GST_DEBUG_PAD_NAME (GST_PAD_PEER (destpad)));
1672         release_and_unref_pad (src, srcpad, srcrequest);
1673         /* already linked request pads look like static pads, so the request pad
1674          * was never requested a second time above, so no need to release it */
1675         gst_object_unref (destpad);
1676         return FALSE;
1677       }
1678     }
1679     destpads = NULL;
1680   } else {
1681     /* no name given, get the first available pad */
1682     GST_OBJECT_LOCK (dest);
1683     destpads = GST_ELEMENT_PADS (dest);
1684     destpad = destpads ? GST_PAD_CAST (destpads->data) : NULL;
1685     if (destpad)
1686       gst_object_ref (destpad);
1687     GST_OBJECT_UNLOCK (dest);
1688   }
1689
1690   if (srcpadname && destpadname) {
1691     gboolean result;
1692
1693     /* two explicitly specified pads */
1694     result = pad_link_maybe_ghosting (srcpad, destpad, flags);
1695
1696     if (result) {
1697       gst_object_unref (srcpad);
1698       gst_object_unref (destpad);
1699     } else {
1700       release_and_unref_pad (src, srcpad, srcrequest);
1701       release_and_unref_pad (dest, destpad, destrequest);
1702     }
1703     return result;
1704   }
1705
1706   if (srcpad) {
1707     /* loop through the allowed pads in the source, trying to find a
1708      * compatible destination pad */
1709     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1710         "looping through allowed src and dest pads");
1711     do {
1712       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying src pad %s:%s",
1713           GST_DEBUG_PAD_NAME (srcpad));
1714       if ((GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC) &&
1715           (GST_PAD_PEER (srcpad) == NULL)) {
1716         gboolean temprequest = FALSE;
1717         GstPad *temp;
1718
1719         if (destpadname) {
1720           temp = destpad;
1721           gst_object_ref (temp);
1722         } else {
1723           temp = gst_element_get_compatible_pad (dest, srcpad, NULL);
1724           if (temp && GST_PAD_PAD_TEMPLATE (temp)
1725               && GST_PAD_TEMPLATE_PRESENCE (GST_PAD_PAD_TEMPLATE (temp)) ==
1726               GST_PAD_REQUEST) {
1727             temprequest = TRUE;
1728           }
1729         }
1730
1731         if (temp && pad_link_maybe_ghosting (srcpad, temp, flags)) {
1732           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1733               GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (temp));
1734           if (destpad)
1735             gst_object_unref (destpad);
1736           gst_object_unref (srcpad);
1737           gst_object_unref (temp);
1738           return TRUE;
1739         }
1740
1741         if (temp) {
1742           if (temprequest)
1743             gst_element_release_request_pad (dest, temp);
1744           gst_object_unref (temp);
1745         }
1746       }
1747       /* find a better way for this mess */
1748       if (srcpads) {
1749         srcpads = g_list_next (srcpads);
1750         if (srcpads) {
1751           gst_object_unref (srcpad);
1752           srcpad = GST_PAD_CAST (srcpads->data);
1753           gst_object_ref (srcpad);
1754         }
1755       }
1756     } while (srcpads);
1757   }
1758   if (srcpadname) {
1759     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s:%s to %s",
1760         GST_DEBUG_PAD_NAME (srcpad), GST_ELEMENT_NAME (dest));
1761     /* no need to release any request pad as both src- and destpadname must be
1762      * set to end up here, but this case has already been taken care of above */
1763     if (destpad)
1764       gst_object_unref (destpad);
1765     destpad = NULL;
1766   }
1767   if (srcpad) {
1768     release_and_unref_pad (src, srcpad, srcrequest);
1769     srcpad = NULL;
1770   }
1771
1772   if (destpad) {
1773     /* loop through the existing pads in the destination */
1774     do {
1775       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying dest pad %s:%s",
1776           GST_DEBUG_PAD_NAME (destpad));
1777       if ((GST_PAD_DIRECTION (destpad) == GST_PAD_SINK) &&
1778           (GST_PAD_PEER (destpad) == NULL)) {
1779         GstPad *temp = gst_element_get_compatible_pad (src, destpad, NULL);
1780         gboolean temprequest = FALSE;
1781
1782         if (temp && GST_PAD_PAD_TEMPLATE (temp)
1783             && GST_PAD_TEMPLATE_PRESENCE (GST_PAD_PAD_TEMPLATE (temp)) ==
1784             GST_PAD_REQUEST) {
1785           temprequest = TRUE;
1786         }
1787
1788         if (temp && pad_link_maybe_ghosting (temp, destpad, flags)) {
1789           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1790               GST_DEBUG_PAD_NAME (temp), GST_DEBUG_PAD_NAME (destpad));
1791           gst_object_unref (temp);
1792           gst_object_unref (destpad);
1793           return TRUE;
1794         }
1795
1796         release_and_unref_pad (src, temp, temprequest);
1797       }
1798       if (destpads) {
1799         destpads = g_list_next (destpads);
1800         if (destpads) {
1801           gst_object_unref (destpad);
1802           destpad = GST_PAD_CAST (destpads->data);
1803           gst_object_ref (destpad);
1804         }
1805       }
1806     } while (destpads);
1807   }
1808
1809   if (destpadname) {
1810     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s:%s",
1811         GST_ELEMENT_NAME (src), GST_DEBUG_PAD_NAME (destpad));
1812     release_and_unref_pad (dest, destpad, destrequest);
1813     return FALSE;
1814   } else {
1815     /* no need to release any request pad as the case of unset destpatname and
1816      * destpad being a requst pad has already been taken care of when looking
1817      * though the destination pads above */
1818     if (destpad) {
1819       gst_object_unref (destpad);
1820     }
1821     destpad = NULL;
1822   }
1823
1824   srcclass = GST_ELEMENT_GET_CLASS (src);
1825   destclass = GST_ELEMENT_GET_CLASS (dest);
1826
1827   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1828       "we might have request pads on both sides, checking...");
1829   srctempls = gst_element_class_get_pad_template_list (srcclass);
1830   desttempls = gst_element_class_get_pad_template_list (destclass);
1831
1832   if (srctempls && desttempls) {
1833     while (srctempls) {
1834       srctempl = (GstPadTemplate *) srctempls->data;
1835       if (srctempl->presence == GST_PAD_REQUEST) {
1836         for (l = desttempls; l; l = l->next) {
1837           desttempl = (GstPadTemplate *) l->data;
1838           if (desttempl->presence == GST_PAD_REQUEST &&
1839               desttempl->direction != srctempl->direction) {
1840             GstCaps *srccaps, *destcaps;
1841
1842             srccaps = gst_pad_template_get_caps (srctempl);
1843             destcaps = gst_pad_template_get_caps (desttempl);
1844             if (gst_caps_is_always_compatible (srccaps, destcaps)) {
1845               srcpad =
1846                   gst_element_request_pad (src, srctempl,
1847                   srctempl->name_template, NULL);
1848               destpad =
1849                   gst_element_request_pad (dest, desttempl,
1850                   desttempl->name_template, NULL);
1851               if (srcpad && destpad
1852                   && pad_link_maybe_ghosting (srcpad, destpad, flags)) {
1853                 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1854                     "linked pad %s:%s to pad %s:%s",
1855                     GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (destpad));
1856                 gst_object_unref (srcpad);
1857                 gst_object_unref (destpad);
1858                 gst_caps_unref (srccaps);
1859                 gst_caps_unref (destcaps);
1860                 return TRUE;
1861               }
1862               /* it failed, so we release the request pads */
1863               if (srcpad) {
1864                 gst_element_release_request_pad (src, srcpad);
1865                 gst_object_unref (srcpad);
1866               }
1867               if (destpad) {
1868                 gst_element_release_request_pad (dest, destpad);
1869                 gst_object_unref (destpad);
1870               }
1871             }
1872             gst_caps_unref (srccaps);
1873             gst_caps_unref (destcaps);
1874           }
1875         }
1876       }
1877       srctempls = srctempls->next;
1878     }
1879   }
1880
1881   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s",
1882       GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
1883   return FALSE;
1884 }
1885
1886 /**
1887  * gst_element_link_pads:
1888  * @src: a #GstElement containing the source pad.
1889  * @srcpadname: (allow-none): the name of the #GstPad in source element
1890  *     or %NULL for any pad.
1891  * @dest: (transfer none): the #GstElement containing the destination pad.
1892  * @destpadname: (allow-none): the name of the #GstPad in destination element,
1893  * or %NULL for any pad.
1894  *
1895  * Links the two named pads of the source and destination elements.
1896  * Side effect is that if one of the pads has no parent, it becomes a
1897  * child of the parent of the other element.  If they have different
1898  * parents, the link fails.
1899  *
1900  * Returns: %TRUE if the pads could be linked, %FALSE otherwise.
1901  */
1902 gboolean
1903 gst_element_link_pads (GstElement * src, const gchar * srcpadname,
1904     GstElement * dest, const gchar * destpadname)
1905 {
1906   return gst_element_link_pads_full (src, srcpadname, dest, destpadname,
1907       GST_PAD_LINK_CHECK_DEFAULT);
1908 }
1909
1910 /**
1911  * gst_element_link_pads_filtered:
1912  * @src: a #GstElement containing the source pad.
1913  * @srcpadname: (allow-none): the name of the #GstPad in source element
1914  *     or %NULL for any pad.
1915  * @dest: (transfer none): the #GstElement containing the destination pad.
1916  * @destpadname: (allow-none): the name of the #GstPad in destination element
1917  *     or %NULL for any pad.
1918  * @filter: (transfer none) (allow-none): the #GstCaps to filter the link,
1919  *     or %NULL for no filter.
1920  *
1921  * Links the two named pads of the source and destination elements. Side effect
1922  * is that if one of the pads has no parent, it becomes a child of the parent of
1923  * the other element. If they have different parents, the link fails. If @caps
1924  * is not %NULL, makes sure that the caps of the link is a subset of @caps.
1925  *
1926  * Returns: %TRUE if the pads could be linked, %FALSE otherwise.
1927  */
1928 gboolean
1929 gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
1930     GstElement * dest, const gchar * destpadname, GstCaps * filter)
1931 {
1932   /* checks */
1933   g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1934   g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1935   g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), FALSE);
1936
1937   if (filter) {
1938     GstElement *capsfilter;
1939     GstObject *parent;
1940     GstState state, pending;
1941     gboolean lr1, lr2;
1942
1943     capsfilter = gst_element_factory_make ("capsfilter", NULL);
1944     if (!capsfilter) {
1945       GST_ERROR ("Could not make a capsfilter");
1946       return FALSE;
1947     }
1948
1949     parent = gst_object_get_parent (GST_OBJECT (src));
1950     g_return_val_if_fail (GST_IS_BIN (parent), FALSE);
1951
1952     gst_element_get_state (GST_ELEMENT_CAST (parent), &state, &pending, 0);
1953
1954     if (!gst_bin_add (GST_BIN (parent), capsfilter)) {
1955       GST_ERROR ("Could not add capsfilter");
1956       gst_object_unref (capsfilter);
1957       gst_object_unref (parent);
1958       return FALSE;
1959     }
1960
1961     if (pending != GST_STATE_VOID_PENDING)
1962       state = pending;
1963
1964     gst_element_set_state (capsfilter, state);
1965
1966     gst_object_unref (parent);
1967
1968     g_object_set (capsfilter, "caps", filter, NULL);
1969
1970     lr1 = gst_element_link_pads (src, srcpadname, capsfilter, "sink");
1971     lr2 = gst_element_link_pads (capsfilter, "src", dest, destpadname);
1972     if (lr1 && lr2) {
1973       return TRUE;
1974     } else {
1975       if (!lr1) {
1976         GST_INFO ("Could not link pads: %s:%s - capsfilter:sink",
1977             GST_ELEMENT_NAME (src), srcpadname);
1978       } else {
1979         GST_INFO ("Could not link pads: capsfilter:src - %s:%s",
1980             GST_ELEMENT_NAME (dest), destpadname);
1981       }
1982       gst_element_set_state (capsfilter, GST_STATE_NULL);
1983       /* this will unlink and unref as appropriate */
1984       gst_bin_remove (GST_BIN (GST_OBJECT_PARENT (capsfilter)), capsfilter);
1985       return FALSE;
1986     }
1987   } else {
1988     if (gst_element_link_pads (src, srcpadname, dest, destpadname)) {
1989       return TRUE;
1990     } else {
1991       GST_INFO ("Could not link pads: %s:%s - %s:%s", GST_ELEMENT_NAME (src),
1992           srcpadname, GST_ELEMENT_NAME (dest), destpadname);
1993       return FALSE;
1994     }
1995   }
1996 }
1997
1998 /**
1999  * gst_element_link:
2000  * @src: (transfer none): a #GstElement containing the source pad.
2001  * @dest: (transfer none): the #GstElement containing the destination pad.
2002  *
2003  * Links @src to @dest. The link must be from source to
2004  * destination; the other direction will not be tried. The function looks for
2005  * existing pads that aren't linked yet. It will request new pads if necessary.
2006  * Such pads need to be released manually when unlinking.
2007  * If multiple links are possible, only one is established.
2008  *
2009  * Make sure you have added your elements to a bin or pipeline with
2010  * gst_bin_add() before trying to link them.
2011  *
2012  * Returns: %TRUE if the elements could be linked, %FALSE otherwise.
2013  */
2014 gboolean
2015 gst_element_link (GstElement * src, GstElement * dest)
2016 {
2017   return gst_element_link_pads (src, NULL, dest, NULL);
2018 }
2019
2020 /**
2021  * gst_element_link_many:
2022  * @element_1: (transfer none): the first #GstElement in the link chain.
2023  * @element_2: (transfer none): the second #GstElement in the link chain.
2024  * @...: the %NULL-terminated list of elements to link in order.
2025  *
2026  * Chain together a series of elements. Uses gst_element_link().
2027  * Make sure you have added your elements to a bin or pipeline with
2028  * gst_bin_add() before trying to link them.
2029  *
2030  * Returns: %TRUE on success, %FALSE otherwise.
2031  */
2032 gboolean
2033 gst_element_link_many (GstElement * element_1, GstElement * element_2, ...)
2034 {
2035   gboolean res = TRUE;
2036   va_list args;
2037
2038   g_return_val_if_fail (GST_IS_ELEMENT (element_1), FALSE);
2039   g_return_val_if_fail (GST_IS_ELEMENT (element_2), FALSE);
2040
2041   va_start (args, element_2);
2042
2043   while (element_2) {
2044     if (!gst_element_link (element_1, element_2)) {
2045       res = FALSE;
2046       break;
2047     }
2048
2049     element_1 = element_2;
2050     element_2 = va_arg (args, GstElement *);
2051   }
2052
2053   va_end (args);
2054
2055   return res;
2056 }
2057
2058 /**
2059  * gst_element_link_filtered:
2060  * @src: a #GstElement containing the source pad.
2061  * @dest: (transfer none): the #GstElement containing the destination pad.
2062  * @filter: (transfer none) (allow-none): the #GstCaps to filter the link,
2063  *     or %NULL for no filter.
2064  *
2065  * Links @src to @dest using the given caps as filtercaps.
2066  * The link must be from source to
2067  * destination; the other direction will not be tried. The function looks for
2068  * existing pads that aren't linked yet. It will request new pads if necessary.
2069  * If multiple links are possible, only one is established.
2070  *
2071  * Make sure you have added your elements to a bin or pipeline with
2072  * gst_bin_add() before trying to link them.
2073  *
2074  * Returns: %TRUE if the pads could be linked, %FALSE otherwise.
2075  */
2076 gboolean
2077 gst_element_link_filtered (GstElement * src, GstElement * dest,
2078     GstCaps * filter)
2079 {
2080   return gst_element_link_pads_filtered (src, NULL, dest, NULL, filter);
2081 }
2082
2083 /**
2084  * gst_element_unlink_pads:
2085  * @src: a (transfer none): #GstElement containing the source pad.
2086  * @srcpadname: the name of the #GstPad in source element.
2087  * @dest: (transfer none): a #GstElement containing the destination pad.
2088  * @destpadname: the name of the #GstPad in destination element.
2089  *
2090  * Unlinks the two named pads of the source and destination elements.
2091  *
2092  * This is a convenience function for gst_pad_unlink().
2093  */
2094 void
2095 gst_element_unlink_pads (GstElement * src, const gchar * srcpadname,
2096     GstElement * dest, const gchar * destpadname)
2097 {
2098   GstPad *srcpad, *destpad;
2099   gboolean srcrequest, destrequest;
2100
2101   srcrequest = destrequest = FALSE;
2102
2103   g_return_if_fail (src != NULL);
2104   g_return_if_fail (GST_IS_ELEMENT (src));
2105   g_return_if_fail (srcpadname != NULL);
2106   g_return_if_fail (dest != NULL);
2107   g_return_if_fail (GST_IS_ELEMENT (dest));
2108   g_return_if_fail (destpadname != NULL);
2109
2110   /* obtain the pads requested */
2111   if (!(srcpad = gst_element_get_static_pad (src, srcpadname)))
2112     if ((srcpad = gst_element_get_request_pad (src, srcpadname)))
2113       srcrequest = TRUE;
2114   if (srcpad == NULL) {
2115     GST_WARNING_OBJECT (src, "source element has no pad \"%s\"", srcpadname);
2116     return;
2117   }
2118   if (!(destpad = gst_element_get_static_pad (dest, destpadname)))
2119     if ((destpad = gst_element_get_request_pad (dest, destpadname)))
2120       destrequest = TRUE;
2121   if (destpad == NULL) {
2122     GST_WARNING_OBJECT (dest, "destination element has no pad \"%s\"",
2123         destpadname);
2124     goto free_src;
2125   }
2126
2127   /* we're satisfied they can be unlinked, let's do it */
2128   gst_pad_unlink (srcpad, destpad);
2129
2130   if (destrequest)
2131     gst_element_release_request_pad (dest, destpad);
2132   gst_object_unref (destpad);
2133
2134 free_src:
2135   if (srcrequest)
2136     gst_element_release_request_pad (src, srcpad);
2137   gst_object_unref (srcpad);
2138 }
2139
2140 /**
2141  * gst_element_unlink_many:
2142  * @element_1: (transfer none): the first #GstElement in the link chain.
2143  * @element_2: (transfer none): the second #GstElement in the link chain.
2144  * @...: the %NULL-terminated list of elements to unlink in order.
2145  *
2146  * Unlinks a series of elements. Uses gst_element_unlink().
2147  */
2148 void
2149 gst_element_unlink_many (GstElement * element_1, GstElement * element_2, ...)
2150 {
2151   va_list args;
2152
2153   g_return_if_fail (element_1 != NULL && element_2 != NULL);
2154   g_return_if_fail (GST_IS_ELEMENT (element_1) && GST_IS_ELEMENT (element_2));
2155
2156   va_start (args, element_2);
2157
2158   while (element_2) {
2159     gst_element_unlink (element_1, element_2);
2160
2161     element_1 = element_2;
2162     element_2 = va_arg (args, GstElement *);
2163   }
2164
2165   va_end (args);
2166 }
2167
2168 /**
2169  * gst_element_unlink:
2170  * @src: (transfer none): the source #GstElement to unlink.
2171  * @dest: (transfer none): the sink #GstElement to unlink.
2172  *
2173  * Unlinks all source pads of the source element with all sink pads
2174  * of the sink element to which they are linked.
2175  *
2176  * If the link has been made using gst_element_link(), it could have created an
2177  * requestpad, which has to be released using gst_element_release_request_pad().
2178  */
2179 void
2180 gst_element_unlink (GstElement * src, GstElement * dest)
2181 {
2182   GstIterator *pads;
2183   gboolean done = FALSE;
2184   GValue data = { 0, };
2185
2186   g_return_if_fail (GST_IS_ELEMENT (src));
2187   g_return_if_fail (GST_IS_ELEMENT (dest));
2188
2189   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unlinking \"%s\" and \"%s\"",
2190       GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
2191
2192   pads = gst_element_iterate_pads (src);
2193   while (!done) {
2194     switch (gst_iterator_next (pads, &data)) {
2195       case GST_ITERATOR_OK:
2196       {
2197         GstPad *pad = g_value_get_object (&data);
2198
2199         if (GST_PAD_IS_SRC (pad)) {
2200           GstPad *peerpad = gst_pad_get_peer (pad);
2201
2202           /* see if the pad is linked and is really a pad of dest */
2203           if (peerpad) {
2204             GstElement *peerelem;
2205
2206             peerelem = gst_pad_get_parent_element (peerpad);
2207
2208             if (peerelem == dest) {
2209               gst_pad_unlink (pad, peerpad);
2210             }
2211             if (peerelem)
2212               gst_object_unref (peerelem);
2213
2214             gst_object_unref (peerpad);
2215           }
2216         }
2217         g_value_reset (&data);
2218         break;
2219       }
2220       case GST_ITERATOR_RESYNC:
2221         gst_iterator_resync (pads);
2222         break;
2223       case GST_ITERATOR_DONE:
2224         done = TRUE;
2225         break;
2226       default:
2227         g_assert_not_reached ();
2228         break;
2229     }
2230   }
2231   g_value_unset (&data);
2232   gst_iterator_free (pads);
2233 }
2234
2235 /**
2236  * gst_element_query_position:
2237  * @element: a #GstElement to invoke the position query on.
2238  * @format: the #GstFormat requested
2239  * @cur: (out) (allow-none): a location in which to store the current
2240  *     position, or %NULL.
2241  *
2242  * Queries an element (usually top-level pipeline or playbin element) for the
2243  * stream position in nanoseconds. This will be a value between 0 and the
2244  * stream duration (if the stream duration is known). This query will usually
2245  * only work once the pipeline is prerolled (i.e. reached PAUSED or PLAYING
2246  * state). The application will receive an ASYNC_DONE message on the pipeline
2247  * bus when that is the case.
2248  *
2249  * If one repeatedly calls this function one can also create a query and reuse
2250  * it in gst_element_query().
2251  *
2252  * Returns: %TRUE if the query could be performed.
2253  */
2254 gboolean
2255 gst_element_query_position (GstElement * element, GstFormat format,
2256     gint64 * cur)
2257 {
2258   GstQuery *query;
2259   gboolean ret;
2260
2261   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2262   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2263
2264   query = gst_query_new_position (format);
2265   ret = gst_element_query (element, query);
2266
2267   if (ret)
2268     gst_query_parse_position (query, NULL, cur);
2269
2270   gst_query_unref (query);
2271
2272   return ret;
2273 }
2274
2275 /**
2276  * gst_element_query_duration:
2277  * @element: a #GstElement to invoke the duration query on.
2278  * @format: the #GstFormat requested
2279  * @duration: (out) (allow-none): A location in which to store the total duration, or %NULL.
2280  *
2281  * Queries an element (usually top-level pipeline or playbin element) for the
2282  * total stream duration in nanoseconds. This query will only work once the
2283  * pipeline is prerolled (i.e. reached PAUSED or PLAYING state). The application
2284  * will receive an ASYNC_DONE message on the pipeline bus when that is the case.
2285  *
2286  * If the duration changes for some reason, you will get a DURATION_CHANGED
2287  * message on the pipeline bus, in which case you should re-query the duration
2288  * using this function.
2289  *
2290  * Returns: %TRUE if the query could be performed.
2291  */
2292 gboolean
2293 gst_element_query_duration (GstElement * element, GstFormat format,
2294     gint64 * duration)
2295 {
2296   GstQuery *query;
2297   gboolean ret;
2298
2299   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2300   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2301
2302   query = gst_query_new_duration (format);
2303   ret = gst_element_query (element, query);
2304
2305   if (ret)
2306     gst_query_parse_duration (query, NULL, duration);
2307
2308   gst_query_unref (query);
2309
2310   return ret;
2311 }
2312
2313 /**
2314  * gst_element_query_convert:
2315  * @element: a #GstElement to invoke the convert query on.
2316  * @src_format: a #GstFormat to convert from.
2317  * @src_val: a value to convert.
2318  * @dest_format: the #GstFormat to convert to.
2319  * @dest_val: (out): a pointer to the result.
2320  *
2321  * Queries an element to convert @src_val in @src_format to @dest_format.
2322  *
2323  * Returns: %TRUE if the query could be performed.
2324  */
2325 gboolean
2326 gst_element_query_convert (GstElement * element, GstFormat src_format,
2327     gint64 src_val, GstFormat dest_format, gint64 * dest_val)
2328 {
2329   GstQuery *query;
2330   gboolean ret;
2331
2332   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2333   g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
2334   g_return_val_if_fail (dest_val != NULL, FALSE);
2335
2336   if (dest_format == src_format || src_val == -1) {
2337     *dest_val = src_val;
2338     return TRUE;
2339   }
2340
2341   query = gst_query_new_convert (src_format, src_val, dest_format);
2342   ret = gst_element_query (element, query);
2343
2344   if (ret)
2345     gst_query_parse_convert (query, NULL, NULL, NULL, dest_val);
2346
2347   gst_query_unref (query);
2348
2349   return ret;
2350 }
2351
2352 /**
2353  * gst_element_seek_simple:
2354  * @element: a #GstElement to seek on
2355  * @format: a #GstFormat to execute the seek in, such as #GST_FORMAT_TIME
2356  * @seek_flags: seek options; playback applications will usually want to use
2357  *            GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_KEY_UNIT here
2358  * @seek_pos: position to seek to (relative to the start); if you are doing
2359  *            a seek in #GST_FORMAT_TIME this value is in nanoseconds -
2360  *            multiply with #GST_SECOND to convert seconds to nanoseconds or
2361  *            with #GST_MSECOND to convert milliseconds to nanoseconds.
2362  *
2363  * Simple API to perform a seek on the given element, meaning it just seeks
2364  * to the given position relative to the start of the stream. For more complex
2365  * operations like segment seeks (e.g. for looping) or changing the playback
2366  * rate or seeking relative to the last configured playback segment you should
2367  * use gst_element_seek().
2368  *
2369  * In a completely prerolled PAUSED or PLAYING pipeline, seeking is always
2370  * guaranteed to return %TRUE on a seekable media type or %FALSE when the media
2371  * type is certainly not seekable (such as a live stream).
2372  *
2373  * Some elements allow for seeking in the READY state, in this
2374  * case they will store the seek event and execute it when they are put to
2375  * PAUSED. If the element supports seek in READY, it will always return %TRUE when
2376  * it receives the event in the READY state.
2377  *
2378  * Returns: %TRUE if the seek operation succeeded. Flushing seeks will trigger a
2379  * preroll, which will emit %GST_MESSAGE_ASYNC_DONE.
2380  */
2381 gboolean
2382 gst_element_seek_simple (GstElement * element, GstFormat format,
2383     GstSeekFlags seek_flags, gint64 seek_pos)
2384 {
2385   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2386   g_return_val_if_fail (seek_pos >= 0, FALSE);
2387
2388   return gst_element_seek (element, 1.0, format, seek_flags,
2389       GST_SEEK_TYPE_SET, seek_pos, GST_SEEK_TYPE_NONE, 0);
2390 }
2391
2392 /**
2393  * gst_pad_use_fixed_caps:
2394  * @pad: the pad to use
2395  *
2396  * A helper function you can use that sets the FIXED_CAPS flag
2397  * This way the default CAPS query will always return the negotiated caps
2398  * or in case the pad is not negotiated, the padtemplate caps.
2399  *
2400  * The negotiated caps are the caps of the last CAPS event that passed on the
2401  * pad. Use this function on a pad that, once it negotiated to a CAPS, cannot
2402  * be renegotiated to something else.
2403  */
2404 void
2405 gst_pad_use_fixed_caps (GstPad * pad)
2406 {
2407   GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_FIXED_CAPS);
2408 }
2409
2410 /**
2411  * gst_pad_get_parent_element:
2412  * @pad: a pad
2413  *
2414  * Gets the parent of @pad, cast to a #GstElement. If a @pad has no parent or
2415  * its parent is not an element, return %NULL.
2416  *
2417  * Returns: (transfer full) (nullable): the parent of the pad. The
2418  * caller has a reference on the parent, so unref when you're finished
2419  * with it.
2420  *
2421  * MT safe.
2422  */
2423 GstElement *
2424 gst_pad_get_parent_element (GstPad * pad)
2425 {
2426   GstObject *p;
2427
2428   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2429
2430   p = gst_object_get_parent (GST_OBJECT_CAST (pad));
2431
2432   if (p && !GST_IS_ELEMENT (p)) {
2433     gst_object_unref (p);
2434     p = NULL;
2435   }
2436   return GST_ELEMENT_CAST (p);
2437 }
2438
2439 /**
2440  * gst_object_default_error:
2441  * @source: the #GstObject that initiated the error.
2442  * @error: (in): the GError.
2443  * @debug: (in) (allow-none): an additional debug information string, or %NULL
2444  *
2445  * A default error function that uses g_printerr() to display the error message
2446  * and the optional debug sting..
2447  *
2448  * The default handler will simply print the error string using g_print.
2449  */
2450 void
2451 gst_object_default_error (GstObject * source, const GError * error,
2452     const gchar * debug)
2453 {
2454   gchar *name = gst_object_get_path_string (source);
2455
2456   g_printerr (_("ERROR: from element %s: %s\n"), name, error->message);
2457   if (debug)
2458     g_printerr (_("Additional debug info:\n%s\n"), debug);
2459
2460   g_free (name);
2461 }
2462
2463 /**
2464  * gst_bin_add_many:
2465  * @bin: a #GstBin
2466  * @element_1: (transfer full): the #GstElement element to add to the bin
2467  * @...: (transfer full): additional elements to add to the bin
2468  *
2469  * Adds a %NULL-terminated list of elements to a bin.  This function is
2470  * equivalent to calling gst_bin_add() for each member of the list. The return
2471  * value of each gst_bin_add() is ignored.
2472  */
2473 void
2474 gst_bin_add_many (GstBin * bin, GstElement * element_1, ...)
2475 {
2476   va_list args;
2477
2478   g_return_if_fail (GST_IS_BIN (bin));
2479   g_return_if_fail (GST_IS_ELEMENT (element_1));
2480
2481   va_start (args, element_1);
2482
2483   while (element_1) {
2484     gst_bin_add (bin, element_1);
2485
2486     element_1 = va_arg (args, GstElement *);
2487   }
2488
2489   va_end (args);
2490 }
2491
2492 /**
2493  * gst_bin_remove_many:
2494  * @bin: a #GstBin
2495  * @element_1: (transfer none): the first #GstElement to remove from the bin
2496  * @...: (transfer none): %NULL-terminated list of elements to remove from the bin
2497  *
2498  * Remove a list of elements from a bin. This function is equivalent
2499  * to calling gst_bin_remove() with each member of the list.
2500  */
2501 void
2502 gst_bin_remove_many (GstBin * bin, GstElement * element_1, ...)
2503 {
2504   va_list args;
2505
2506   g_return_if_fail (GST_IS_BIN (bin));
2507   g_return_if_fail (GST_IS_ELEMENT (element_1));
2508
2509   va_start (args, element_1);
2510
2511   while (element_1) {
2512     gst_bin_remove (bin, element_1);
2513
2514     element_1 = va_arg (args, GstElement *);
2515   }
2516
2517   va_end (args);
2518 }
2519
2520 typedef struct
2521 {
2522   GstQuery *query;
2523   gboolean ret;
2524 } QueryAcceptCapsData;
2525
2526 static gboolean
2527 query_accept_caps_func (GstPad * pad, QueryAcceptCapsData * data)
2528 {
2529   if (G_LIKELY (gst_pad_peer_query (pad, data->query))) {
2530     gboolean result;
2531
2532     gst_query_parse_accept_caps_result (data->query, &result);
2533     data->ret &= result;
2534   }
2535   return FALSE;
2536 }
2537
2538 /**
2539  * gst_pad_proxy_query_accept_caps:
2540  * @pad: a #GstPad to proxy.
2541  * @query: an ACCEPT_CAPS #GstQuery.
2542  *
2543  * Checks if all internally linked pads of @pad accepts the caps in @query and
2544  * returns the intersection of the results.
2545  *
2546  * This function is useful as a default accept caps query function for an element
2547  * that can handle any stream format, but requires caps that are acceptable for
2548  * all opposite pads.
2549  *
2550  * Returns: %TRUE if @query could be executed
2551  */
2552 gboolean
2553 gst_pad_proxy_query_accept_caps (GstPad * pad, GstQuery * query)
2554 {
2555   QueryAcceptCapsData data;
2556
2557   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2558   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
2559   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS, FALSE);
2560
2561   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
2562       "proxying accept caps query for %s:%s", GST_DEBUG_PAD_NAME (pad));
2563
2564   data.query = query;
2565   /* value to hold the return, by default it holds TRUE */
2566   /* FIXME: TRUE is wrong when there are no pads */
2567   data.ret = TRUE;
2568
2569   gst_pad_forward (pad, (GstPadForwardFunction) query_accept_caps_func, &data);
2570   gst_query_set_accept_caps_result (query, data.ret);
2571
2572   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "proxying accept caps query: %d",
2573       data.ret);
2574
2575   return data.ret;
2576 }
2577
2578 typedef struct
2579 {
2580   GstQuery *query;
2581   GstCaps *ret;
2582 } QueryCapsData;
2583
2584 static gboolean
2585 query_caps_func (GstPad * pad, QueryCapsData * data)
2586 {
2587   gboolean empty = FALSE;
2588
2589   if (G_LIKELY (gst_pad_peer_query (pad, data->query))) {
2590     GstCaps *peercaps, *intersection;
2591
2592     gst_query_parse_caps_result (data->query, &peercaps);
2593     GST_DEBUG_OBJECT (pad, "intersect with result %" GST_PTR_FORMAT, peercaps);
2594     intersection = gst_caps_intersect (data->ret, peercaps);
2595     GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, intersection);
2596
2597     gst_caps_unref (data->ret);
2598     data->ret = intersection;
2599
2600     /* stop when empty */
2601     empty = gst_caps_is_empty (intersection);
2602   }
2603   return empty;
2604 }
2605
2606 /**
2607  * gst_pad_proxy_query_caps:
2608  * @pad: a #GstPad to proxy.
2609  * @query: a CAPS #GstQuery.
2610  *
2611  * Calls gst_pad_query_caps() for all internally linked pads of @pad and returns
2612  * the intersection of the results.
2613  *
2614  * This function is useful as a default caps query function for an element
2615  * that can handle any stream format, but requires all its pads to have
2616  * the same caps.  Two such elements are tee and adder.
2617  *
2618  * Returns: %TRUE if @query could be executed
2619  */
2620 gboolean
2621 gst_pad_proxy_query_caps (GstPad * pad, GstQuery * query)
2622 {
2623   GstCaps *filter, *templ, *result;
2624   QueryCapsData data;
2625
2626   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2627   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
2628   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS, FALSE);
2629
2630   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "proxying caps query for %s:%s",
2631       GST_DEBUG_PAD_NAME (pad));
2632
2633   data.query = query;
2634
2635   /* value to hold the return, by default it holds the filter or ANY */
2636   gst_query_parse_caps (query, &filter);
2637   data.ret = filter ? gst_caps_ref (filter) : gst_caps_new_any ();
2638
2639   gst_pad_forward (pad, (GstPadForwardFunction) query_caps_func, &data);
2640
2641   templ = gst_pad_get_pad_template_caps (pad);
2642   result = gst_caps_intersect (data.ret, templ);
2643   gst_caps_unref (data.ret);
2644   gst_caps_unref (templ);
2645
2646   gst_query_set_caps_result (query, result);
2647   gst_caps_unref (result);
2648
2649   /* FIXME: return something depending on the processing */
2650   return TRUE;
2651 }
2652
2653 /**
2654  * gst_pad_query_position:
2655  * @pad: a #GstPad to invoke the position query on.
2656  * @format: the #GstFormat requested
2657  * @cur: (out) (allow-none): A location in which to store the current position, or %NULL.
2658  *
2659  * Queries a pad for the stream position.
2660  *
2661  * Returns: %TRUE if the query could be performed.
2662  */
2663 gboolean
2664 gst_pad_query_position (GstPad * pad, GstFormat format, gint64 * cur)
2665 {
2666   GstQuery *query;
2667   gboolean ret;
2668
2669   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2670   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2671
2672   query = gst_query_new_position (format);
2673   if ((ret = gst_pad_query (pad, query)))
2674     gst_query_parse_position (query, NULL, cur);
2675   gst_query_unref (query);
2676
2677   return ret;
2678 }
2679
2680 /**
2681  * gst_pad_peer_query_position:
2682  * @pad: a #GstPad on whose peer to invoke the position query on.
2683  *       Must be a sink pad.
2684  * @format: the #GstFormat requested
2685  * @cur: (out) (allow-none): a location in which to store the current
2686  *     position, or %NULL.
2687  *
2688  * Queries the peer of a given sink pad for the stream position.
2689  *
2690  * Returns: %TRUE if the query could be performed.
2691  */
2692 gboolean
2693 gst_pad_peer_query_position (GstPad * pad, GstFormat format, gint64 * cur)
2694 {
2695   GstQuery *query;
2696   gboolean ret = FALSE;
2697
2698   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2699   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2700
2701   query = gst_query_new_position (format);
2702   if ((ret = gst_pad_peer_query (pad, query)))
2703     gst_query_parse_position (query, NULL, cur);
2704   gst_query_unref (query);
2705
2706   return ret;
2707 }
2708
2709 /**
2710  * gst_pad_query_duration:
2711  * @pad: a #GstPad to invoke the duration query on.
2712  * @format: the #GstFormat requested
2713  * @duration: (out) (allow-none): a location in which to store the total
2714  *     duration, or %NULL.
2715  *
2716  * Queries a pad for the total stream duration.
2717  *
2718  * Returns: %TRUE if the query could be performed.
2719  */
2720 gboolean
2721 gst_pad_query_duration (GstPad * pad, GstFormat format, gint64 * duration)
2722 {
2723   GstQuery *query;
2724   gboolean ret;
2725
2726   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2727   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2728
2729   query = gst_query_new_duration (format);
2730   if ((ret = gst_pad_query (pad, query)))
2731     gst_query_parse_duration (query, NULL, duration);
2732   gst_query_unref (query);
2733
2734   return ret;
2735 }
2736
2737 /**
2738  * gst_pad_peer_query_duration:
2739  * @pad: a #GstPad on whose peer pad to invoke the duration query on.
2740  *       Must be a sink pad.
2741  * @format: the #GstFormat requested
2742  * @duration: (out) (allow-none): a location in which to store the total
2743  *     duration, or %NULL.
2744  *
2745  * Queries the peer pad of a given sink pad for the total stream duration.
2746  *
2747  * Returns: %TRUE if the query could be performed.
2748  */
2749 gboolean
2750 gst_pad_peer_query_duration (GstPad * pad, GstFormat format, gint64 * duration)
2751 {
2752   GstQuery *query;
2753   gboolean ret = FALSE;
2754
2755   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2756   g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2757   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2758
2759   query = gst_query_new_duration (format);
2760   if ((ret = gst_pad_peer_query (pad, query)))
2761     gst_query_parse_duration (query, NULL, duration);
2762   gst_query_unref (query);
2763
2764   return ret;
2765 }
2766
2767 /**
2768  * gst_pad_query_convert:
2769  * @pad: a #GstPad to invoke the convert query on.
2770  * @src_format: a #GstFormat to convert from.
2771  * @src_val: a value to convert.
2772  * @dest_format: the #GstFormat to convert to.
2773  * @dest_val: (out): a pointer to the result.
2774  *
2775  * Queries a pad to convert @src_val in @src_format to @dest_format.
2776  *
2777  * Returns: %TRUE if the query could be performed.
2778  */
2779 gboolean
2780 gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2781     GstFormat dest_format, gint64 * dest_val)
2782 {
2783   GstQuery *query;
2784   gboolean ret;
2785
2786   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2787   g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
2788   g_return_val_if_fail (dest_val != NULL, FALSE);
2789
2790   if (dest_format == src_format || src_val == -1) {
2791     *dest_val = src_val;
2792     return TRUE;
2793   }
2794
2795   query = gst_query_new_convert (src_format, src_val, dest_format);
2796   if ((ret = gst_pad_query (pad, query)))
2797     gst_query_parse_convert (query, NULL, NULL, NULL, dest_val);
2798   gst_query_unref (query);
2799
2800   return ret;
2801 }
2802
2803 /**
2804  * gst_pad_peer_query_convert:
2805  * @pad: a #GstPad, on whose peer pad to invoke the convert query on.
2806  *       Must be a sink pad.
2807  * @src_format: a #GstFormat to convert from.
2808  * @src_val: a value to convert.
2809  * @dest_format: the #GstFormat to convert to.
2810  * @dest_val: (out): a pointer to the result.
2811  *
2812  * Queries the peer pad of a given sink pad to convert @src_val in @src_format
2813  * to @dest_format.
2814  *
2815  * Returns: %TRUE if the query could be performed.
2816  */
2817 gboolean
2818 gst_pad_peer_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2819     GstFormat dest_format, gint64 * dest_val)
2820 {
2821   GstQuery *query;
2822   gboolean ret = FALSE;
2823
2824   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2825   g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2826   g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
2827   g_return_val_if_fail (dest_val != NULL, FALSE);
2828
2829   query = gst_query_new_convert (src_format, src_val, dest_format);
2830   if ((ret = gst_pad_peer_query (pad, query)))
2831     gst_query_parse_convert (query, NULL, NULL, NULL, dest_val);
2832   gst_query_unref (query);
2833
2834   return ret;
2835 }
2836
2837 /**
2838  * gst_pad_query_caps:
2839  * @pad: a  #GstPad to get the capabilities of.
2840  * @filter: (allow-none): suggested #GstCaps, or %NULL
2841  *
2842  * Gets the capabilities this pad can produce or consume.
2843  * Note that this method doesn't necessarily return the caps set by sending a
2844  * gst_event_new_caps() - use gst_pad_get_current_caps() for that instead.
2845  * gst_pad_query_caps returns all possible caps a pad can operate with, using
2846  * the pad's CAPS query function, If the query fails, this function will return
2847  * @filter, if not %NULL, otherwise ANY.
2848  *
2849  * When called on sinkpads @filter contains the caps that
2850  * upstream could produce in the order preferred by upstream. When
2851  * called on srcpads @filter contains the caps accepted by
2852  * downstream in the preferred order. @filter might be %NULL but
2853  * if it is not %NULL the returned caps will be a subset of @filter.
2854  *
2855  * Note that this function does not return writable #GstCaps, use
2856  * gst_caps_make_writable() before modifying the caps.
2857  *
2858  * Returns: (transfer full): the caps of the pad with incremented ref-count.
2859  */
2860 GstCaps *
2861 gst_pad_query_caps (GstPad * pad, GstCaps * filter)
2862 {
2863   GstCaps *result = NULL;
2864   GstQuery *query;
2865
2866   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2867   g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), NULL);
2868
2869   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2870       "get pad caps with filter %" GST_PTR_FORMAT, filter);
2871
2872   query = gst_query_new_caps (filter);
2873   if (gst_pad_query (pad, query)) {
2874     gst_query_parse_caps_result (query, &result);
2875     gst_caps_ref (result);
2876     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2877         "query returned %" GST_PTR_FORMAT, result);
2878   } else if (filter) {
2879     result = gst_caps_ref (filter);
2880   } else {
2881     result = gst_caps_new_any ();
2882   }
2883   gst_query_unref (query);
2884
2885   return result;
2886 }
2887
2888 /**
2889  * gst_pad_peer_query_caps:
2890  * @pad: a  #GstPad to get the capabilities of.
2891  * @filter: (allow-none): a #GstCaps filter, or %NULL.
2892  *
2893  * Gets the capabilities of the peer connected to this pad. Similar to
2894  * gst_pad_query_caps().
2895  *
2896  * When called on srcpads @filter contains the caps that
2897  * upstream could produce in the order preferred by upstream. When
2898  * called on sinkpads @filter contains the caps accepted by
2899  * downstream in the preferred order. @filter might be %NULL but
2900  * if it is not %NULL the returned caps will be a subset of @filter.
2901  *
2902  * Returns: (transfer full): the caps of the peer pad with incremented
2903  * ref-count. When there is no peer pad, this function returns @filter or,
2904  * when @filter is %NULL, ANY caps.
2905  */
2906 GstCaps *
2907 gst_pad_peer_query_caps (GstPad * pad, GstCaps * filter)
2908 {
2909   GstCaps *result = NULL;
2910   GstQuery *query;
2911
2912   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2913   g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), NULL);
2914
2915   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2916       "get pad peer caps with filter %" GST_PTR_FORMAT, filter);
2917
2918   query = gst_query_new_caps (filter);
2919   if (gst_pad_peer_query (pad, query)) {
2920     gst_query_parse_caps_result (query, &result);
2921     gst_caps_ref (result);
2922     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2923         "peer query returned %" GST_PTR_FORMAT, result);
2924   } else if (filter) {
2925     result = gst_caps_ref (filter);
2926   } else {
2927     result = gst_caps_new_any ();
2928   }
2929   gst_query_unref (query);
2930
2931   return result;
2932 }
2933
2934 /**
2935  * gst_pad_query_accept_caps:
2936  * @pad: a #GstPad to check
2937  * @caps: a #GstCaps to check on the pad
2938  *
2939  * Check if the given pad accepts the caps.
2940  *
2941  * Returns: %TRUE if the pad can accept the caps.
2942  */
2943 gboolean
2944 gst_pad_query_accept_caps (GstPad * pad, GstCaps * caps)
2945 {
2946   gboolean res = TRUE;
2947   GstQuery *query;
2948
2949   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2950   g_return_val_if_fail (GST_IS_CAPS (caps), FALSE);
2951
2952   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "accept caps of %"
2953       GST_PTR_FORMAT, caps);
2954
2955   query = gst_query_new_accept_caps (caps);
2956   if (gst_pad_query (pad, query)) {
2957     gst_query_parse_accept_caps_result (query, &res);
2958     GST_DEBUG_OBJECT (pad, "query returned %d", res);
2959   }
2960   gst_query_unref (query);
2961
2962   return res;
2963 }
2964
2965 /**
2966  * gst_pad_peer_query_accept_caps:
2967  * @pad: a  #GstPad to check the peer of
2968  * @caps: a #GstCaps to check on the pad
2969  *
2970  * Check if the peer of @pad accepts @caps. If @pad has no peer, this function
2971  * returns %TRUE.
2972  *
2973  * Returns: %TRUE if the peer of @pad can accept the caps or @pad has no peer.
2974  */
2975 gboolean
2976 gst_pad_peer_query_accept_caps (GstPad * pad, GstCaps * caps)
2977 {
2978   gboolean res = TRUE;
2979   GstQuery *query;
2980
2981   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2982   g_return_val_if_fail (GST_IS_CAPS (caps), FALSE);
2983
2984   query = gst_query_new_accept_caps (caps);
2985   if (gst_pad_peer_query (pad, query)) {
2986     gst_query_parse_accept_caps_result (query, &res);
2987     GST_DEBUG_OBJECT (pad, "query returned %d", res);
2988   }
2989   gst_query_unref (query);
2990
2991   return res;
2992 }
2993
2994 static GstPad *
2995 element_find_unlinked_pad (GstElement * element, GstPadDirection direction)
2996 {
2997   GstIterator *iter;
2998   GstPad *unlinked_pad = NULL;
2999   gboolean done;
3000   GValue data = { 0, };
3001
3002   switch (direction) {
3003     case GST_PAD_SRC:
3004       iter = gst_element_iterate_src_pads (element);
3005       break;
3006     case GST_PAD_SINK:
3007       iter = gst_element_iterate_sink_pads (element);
3008       break;
3009     default:
3010       g_return_val_if_reached (NULL);
3011   }
3012
3013   done = FALSE;
3014   while (!done) {
3015     switch (gst_iterator_next (iter, &data)) {
3016       case GST_ITERATOR_OK:{
3017         GstPad *peer;
3018         GstPad *pad = g_value_get_object (&data);
3019
3020         GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
3021             GST_DEBUG_PAD_NAME (pad));
3022
3023         peer = gst_pad_get_peer (pad);
3024         if (peer == NULL) {
3025           unlinked_pad = gst_object_ref (pad);
3026           done = TRUE;
3027           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
3028               "found existing unlinked pad %s:%s",
3029               GST_DEBUG_PAD_NAME (unlinked_pad));
3030         } else {
3031           gst_object_unref (peer);
3032         }
3033         g_value_reset (&data);
3034         break;
3035       }
3036       case GST_ITERATOR_DONE:
3037         done = TRUE;
3038         break;
3039       case GST_ITERATOR_RESYNC:
3040         gst_iterator_resync (iter);
3041         break;
3042       case GST_ITERATOR_ERROR:
3043         g_return_val_if_reached (NULL);
3044         break;
3045     }
3046   }
3047   g_value_unset (&data);
3048   gst_iterator_free (iter);
3049
3050   return unlinked_pad;
3051 }
3052
3053 /**
3054  * gst_bin_find_unlinked_pad:
3055  * @bin: bin in which to look for elements with unlinked pads
3056  * @direction: whether to look for an unlinked source or sink pad
3057  *
3058  * Recursively looks for elements with an unlinked pad of the given
3059  * direction within the specified bin and returns an unlinked pad
3060  * if one is found, or %NULL otherwise. If a pad is found, the caller
3061  * owns a reference to it and should use gst_object_unref() on the
3062  * pad when it is not needed any longer.
3063  *
3064  * Returns: (transfer full) (nullable): unlinked pad of the given
3065  * direction, %NULL.
3066  */
3067 GstPad *
3068 gst_bin_find_unlinked_pad (GstBin * bin, GstPadDirection direction)
3069 {
3070   GstIterator *iter;
3071   gboolean done;
3072   GstPad *pad = NULL;
3073   GValue data = { 0, };
3074
3075   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3076   g_return_val_if_fail (direction != GST_PAD_UNKNOWN, NULL);
3077
3078   done = FALSE;
3079   iter = gst_bin_iterate_recurse (bin);
3080   while (!done) {
3081     switch (gst_iterator_next (iter, &data)) {
3082       case GST_ITERATOR_OK:{
3083         GstElement *element = g_value_get_object (&data);
3084
3085         pad = element_find_unlinked_pad (element, direction);
3086         if (pad != NULL)
3087           done = TRUE;
3088         g_value_reset (&data);
3089         break;
3090       }
3091       case GST_ITERATOR_DONE:
3092         done = TRUE;
3093         break;
3094       case GST_ITERATOR_RESYNC:
3095         gst_iterator_resync (iter);
3096         break;
3097       case GST_ITERATOR_ERROR:
3098         g_return_val_if_reached (NULL);
3099         break;
3100     }
3101   }
3102   g_value_unset (&data);
3103   gst_iterator_free (iter);
3104
3105   return pad;
3106 }
3107
3108 static void
3109 gst_bin_sync_children_states_foreach (const GValue * value, gpointer user_data)
3110 {
3111   gboolean *success = user_data;
3112   GstElement *element = g_value_get_object (value);
3113
3114   if (gst_element_is_locked_state (element)) {
3115     *success = TRUE;
3116   } else {
3117     *success = *success && gst_element_sync_state_with_parent (element);
3118
3119     if (GST_IS_BIN (element))
3120       *success = *success
3121           && gst_bin_sync_children_states (GST_BIN_CAST (element));
3122   }
3123 }
3124
3125 /**
3126  * gst_bin_sync_children_states:
3127  * @bin: a #GstBin
3128  *
3129  * Synchronizes the state of every child of @bin with the state
3130  * of @bin. See also gst_element_sync_state_with_parent().
3131  *
3132  * Returns: %TRUE if syncing the state was successful for all children,
3133  *  otherwise %FALSE.
3134  *
3135  * Since: 1.6
3136  */
3137 gboolean
3138 gst_bin_sync_children_states (GstBin * bin)
3139 {
3140   GstIterator *it;
3141   GstIteratorResult res = GST_ITERATOR_OK;
3142   gboolean success = TRUE;
3143
3144   it = gst_bin_iterate_sorted (bin);
3145
3146   do {
3147     if (res == GST_ITERATOR_RESYNC) {
3148       success = TRUE;
3149       gst_iterator_resync (it);
3150     }
3151     res =
3152         gst_iterator_foreach (it, gst_bin_sync_children_states_foreach,
3153         &success);
3154   } while (res == GST_ITERATOR_RESYNC);
3155   gst_iterator_free (it);
3156
3157   return success;
3158 }
3159
3160 /**
3161  * gst_parse_bin_from_description:
3162  * @bin_description: command line describing the bin
3163  * @ghost_unlinked_pads: whether to automatically create ghost pads
3164  *     for unlinked source or sink pads within the bin
3165  * @err: where to store the error message in case of an error, or %NULL
3166  *
3167  * This is a convenience wrapper around gst_parse_launch() to create a
3168  * #GstBin from a gst-launch-style pipeline description. See
3169  * gst_parse_launch() and the gst-launch man page for details about the
3170  * syntax. Ghost pads on the bin for unlinked source or sink pads
3171  * within the bin can automatically be created (but only a maximum of
3172  * one ghost pad for each direction will be created; if you expect
3173  * multiple unlinked source pads or multiple unlinked sink pads
3174  * and want them all ghosted, you will have to create the ghost pads
3175  * yourself).
3176  *
3177  * Returns: (transfer floating) (type Gst.Bin) (nullable): a
3178  *   newly-created bin, or %NULL if an error occurred.
3179  */
3180 GstElement *
3181 gst_parse_bin_from_description (const gchar * bin_description,
3182     gboolean ghost_unlinked_pads, GError ** err)
3183 {
3184   return gst_parse_bin_from_description_full (bin_description,
3185       ghost_unlinked_pads, NULL, GST_PARSE_FLAG_NONE, err);
3186 }
3187
3188 /**
3189  * gst_parse_bin_from_description_full:
3190  * @bin_description: command line describing the bin
3191  * @ghost_unlinked_pads: whether to automatically create ghost pads
3192  *     for unlinked source or sink pads within the bin
3193  * @context: (transfer none) (allow-none): a parse context allocated with
3194  *     gst_parse_context_new(), or %NULL
3195  * @flags: parsing options, or #GST_PARSE_FLAG_NONE
3196  * @err: where to store the error message in case of an error, or %NULL
3197  *
3198  * This is a convenience wrapper around gst_parse_launch() to create a
3199  * #GstBin from a gst-launch-style pipeline description. See
3200  * gst_parse_launch() and the gst-launch man page for details about the
3201  * syntax. Ghost pads on the bin for unlinked source or sink pads
3202  * within the bin can automatically be created (but only a maximum of
3203  * one ghost pad for each direction will be created; if you expect
3204  * multiple unlinked source pads or multiple unlinked sink pads
3205  * and want them all ghosted, you will have to create the ghost pads
3206  * yourself).
3207  *
3208  * Returns: (transfer floating) (type Gst.Element): a newly-created
3209  *   element, which is guaranteed to be a bin unless
3210  *   GST_FLAG_NO_SINGLE_ELEMENT_BINS was passed, or %NULL if an error
3211  *   occurred.
3212  */
3213 GstElement *
3214 gst_parse_bin_from_description_full (const gchar * bin_description,
3215     gboolean ghost_unlinked_pads, GstParseContext * context,
3216     GstParseFlags flags, GError ** err)
3217 {
3218 #ifndef GST_DISABLE_PARSE
3219   GstPad *pad = NULL;
3220   GstElement *element;
3221   GstBin *bin;
3222   gchar *desc;
3223
3224   g_return_val_if_fail (bin_description != NULL, NULL);
3225   g_return_val_if_fail (err == NULL || *err == NULL, NULL);
3226
3227   GST_DEBUG ("Making bin from description '%s'", bin_description);
3228
3229   /* parse the pipeline to a bin */
3230   if (flags & GST_PARSE_FLAG_NO_SINGLE_ELEMENT_BINS) {
3231     element = gst_parse_launch_full (bin_description, context, flags, err);
3232   } else {
3233     desc = g_strdup_printf ("bin.( %s )", bin_description);
3234     element = gst_parse_launch_full (desc, context, flags, err);
3235     g_free (desc);
3236   }
3237
3238   if (element == NULL || (err && *err != NULL)) {
3239     if (element)
3240       gst_object_unref (element);
3241     return NULL;
3242   }
3243
3244   if (GST_IS_BIN (element)) {
3245     bin = GST_BIN (element);
3246   } else {
3247     return element;
3248   }
3249
3250   /* find pads and ghost them if necessary */
3251   if (ghost_unlinked_pads) {
3252     if ((pad = gst_bin_find_unlinked_pad (bin, GST_PAD_SRC))) {
3253       gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("src", pad));
3254       gst_object_unref (pad);
3255     }
3256     if ((pad = gst_bin_find_unlinked_pad (bin, GST_PAD_SINK))) {
3257       gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("sink", pad));
3258       gst_object_unref (pad);
3259     }
3260   }
3261
3262   return GST_ELEMENT (bin);
3263 #else
3264   gchar *msg;
3265
3266   GST_WARNING ("Disabled API called");
3267
3268   msg = gst_error_get_message (GST_CORE_ERROR, GST_CORE_ERROR_DISABLED);
3269   g_set_error (err, GST_CORE_ERROR, GST_CORE_ERROR_DISABLED, "%s", msg);
3270   g_free (msg);
3271
3272   return NULL;
3273 #endif
3274 }
3275
3276 /**
3277  * gst_util_get_timestamp:
3278  *
3279  * Get a timestamp as GstClockTime to be used for interval measurements.
3280  * The timestamp should not be interpreted in any other way.
3281  *
3282  * Returns: the timestamp
3283  */
3284 GstClockTime
3285 gst_util_get_timestamp (void)
3286 {
3287 #if defined (HAVE_POSIX_TIMERS) && defined(HAVE_MONOTONIC_CLOCK) &&\
3288     defined (HAVE_CLOCK_GETTIME)
3289   struct timespec now;
3290
3291   clock_gettime (CLOCK_MONOTONIC, &now);
3292   return GST_TIMESPEC_TO_TIME (now);
3293 #else
3294   GTimeVal now;
3295
3296   g_get_current_time (&now);
3297   return GST_TIMEVAL_TO_TIME (now);
3298 #endif
3299 }
3300
3301 /**
3302  * gst_util_array_binary_search:
3303  * @array: the sorted input array
3304  * @num_elements: number of elements in the array
3305  * @element_size: size of every element in bytes
3306  * @search_func: (scope call): function to compare two elements, @search_data will always be passed as second argument
3307  * @mode: search mode that should be used
3308  * @search_data: element that should be found
3309  * @user_data: (closure): data to pass to @search_func
3310  *
3311  * Searches inside @array for @search_data by using the comparison function
3312  * @search_func. @array must be sorted ascending.
3313  *
3314  * As @search_data is always passed as second argument to @search_func it's
3315  * not required that @search_data has the same type as the array elements.
3316  *
3317  * The complexity of this search function is O(log (num_elements)).
3318  *
3319  * Returns: (transfer none) (nullable): The address of the found
3320  * element or %NULL if nothing was found
3321  */
3322 gpointer
3323 gst_util_array_binary_search (gpointer array, guint num_elements,
3324     gsize element_size, GCompareDataFunc search_func, GstSearchMode mode,
3325     gconstpointer search_data, gpointer user_data)
3326 {
3327   glong left = 0, right = num_elements - 1, m;
3328   gint ret;
3329   guint8 *data = (guint8 *) array;
3330
3331   g_return_val_if_fail (array != NULL, NULL);
3332   g_return_val_if_fail (element_size > 0, NULL);
3333   g_return_val_if_fail (search_func != NULL, NULL);
3334
3335   /* 0. No elements => return NULL */
3336   if (num_elements == 0)
3337     return NULL;
3338
3339   /* 1. If search_data is before the 0th element return the 0th element */
3340   ret = search_func (data, search_data, user_data);
3341   if ((ret >= 0 && mode == GST_SEARCH_MODE_AFTER) || ret == 0)
3342     return data;
3343   else if (ret > 0)
3344     return NULL;
3345
3346   /* 2. If search_data is after the last element return the last element */
3347   ret =
3348       search_func (data + (num_elements - 1) * element_size, search_data,
3349       user_data);
3350   if ((ret <= 0 && mode == GST_SEARCH_MODE_BEFORE) || ret == 0)
3351     return data + (num_elements - 1) * element_size;
3352   else if (ret < 0)
3353     return NULL;
3354
3355   /* 3. else binary search */
3356   while (TRUE) {
3357     m = left + (right - left) / 2;
3358
3359     ret = search_func (data + m * element_size, search_data, user_data);
3360
3361     if (ret == 0) {
3362       return data + m * element_size;
3363     } else if (ret < 0) {
3364       left = m + 1;
3365     } else {
3366       right = m - 1;
3367     }
3368
3369     /* No exact match found */
3370     if (right < left) {
3371       if (mode == GST_SEARCH_MODE_EXACT) {
3372         return NULL;
3373       } else if (mode == GST_SEARCH_MODE_AFTER) {
3374         if (ret < 0)
3375           return (m < num_elements) ? data + (m + 1) * element_size : NULL;
3376         else
3377           return data + m * element_size;
3378       } else {
3379         if (ret < 0)
3380           return data + m * element_size;
3381         else
3382           return (m > 0) ? data + (m - 1) * element_size : NULL;
3383       }
3384     }
3385   }
3386 }
3387
3388 /* Finds the greatest common divisor.
3389  * Returns 1 if none other found.
3390  * This is Euclid's algorithm. */
3391
3392 /**
3393  * gst_util_greatest_common_divisor:
3394  * @a: First value as #gint
3395  * @b: Second value as #gint
3396  *
3397  * Calculates the greatest common divisor of @a
3398  * and @b.
3399  *
3400  * Returns: Greatest common divisor of @a and @b
3401  */
3402 gint
3403 gst_util_greatest_common_divisor (gint a, gint b)
3404 {
3405   while (b != 0) {
3406     int temp = a;
3407
3408     a = b;
3409     b = temp % b;
3410   }
3411
3412   return ABS (a);
3413 }
3414
3415 /**
3416  * gst_util_greatest_common_divisor_int64:
3417  * @a: First value as #gint64
3418  * @b: Second value as #gint64
3419  *
3420  * Calculates the greatest common divisor of @a
3421  * and @b.
3422  *
3423  * Returns: Greatest common divisor of @a and @b
3424  */
3425 gint64
3426 gst_util_greatest_common_divisor_int64 (gint64 a, gint64 b)
3427 {
3428   while (b != 0) {
3429     gint64 temp = a;
3430
3431     a = b;
3432     b = temp % b;
3433   }
3434
3435   return ABS (a);
3436 }
3437
3438
3439 /**
3440  * gst_util_fraction_to_double:
3441  * @src_n: Fraction numerator as #gint
3442  * @src_d: Fraction denominator #gint
3443  * @dest: (out): pointer to a #gdouble for the result
3444  *
3445  * Transforms a fraction to a #gdouble.
3446  */
3447 void
3448 gst_util_fraction_to_double (gint src_n, gint src_d, gdouble * dest)
3449 {
3450   g_return_if_fail (dest != NULL);
3451   g_return_if_fail (src_d != 0);
3452
3453   *dest = ((gdouble) src_n) / ((gdouble) src_d);
3454 }
3455
3456 #define MAX_TERMS       30
3457 #define MIN_DIVISOR     1.0e-10
3458 #define MAX_ERROR       1.0e-20
3459
3460 /* use continued fractions to transform a double into a fraction,
3461  * see http://mathforum.org/dr.math/faq/faq.fractions.html#decfrac.
3462  * This algorithm takes care of overflows.
3463  */
3464
3465 /**
3466  * gst_util_double_to_fraction:
3467  * @src: #gdouble to transform
3468  * @dest_n: (out): pointer to a #gint to hold the result numerator
3469  * @dest_d: (out): pointer to a #gint to hold the result denominator
3470  *
3471  * Transforms a #gdouble to a fraction and simplifies
3472  * the result.
3473  */
3474 void
3475 gst_util_double_to_fraction (gdouble src, gint * dest_n, gint * dest_d)
3476 {
3477
3478   gdouble V, F;                 /* double being converted */
3479   gint N, D;                    /* will contain the result */
3480   gint A;                       /* current term in continued fraction */
3481   gint64 N1, D1;                /* numerator, denominator of last approx */
3482   gint64 N2, D2;                /* numerator, denominator of previous approx */
3483   gint i;
3484   gint gcd;
3485   gboolean negative = FALSE;
3486
3487   g_return_if_fail (dest_n != NULL);
3488   g_return_if_fail (dest_d != NULL);
3489
3490   /* initialize fraction being converted */
3491   F = src;
3492   if (F < 0.0) {
3493     F = -F;
3494     negative = TRUE;
3495   }
3496
3497   V = F;
3498   /* initialize fractions with 1/0, 0/1 */
3499   N1 = 1;
3500   D1 = 0;
3501   N2 = 0;
3502   D2 = 1;
3503   N = 1;
3504   D = 1;
3505
3506   for (i = 0; i < MAX_TERMS; i++) {
3507     /* get next term */
3508     A = (gint) F;               /* no floor() needed, F is always >= 0 */
3509     /* get new divisor */
3510     F = F - A;
3511
3512     /* calculate new fraction in temp */
3513     N2 = N1 * A + N2;
3514     D2 = D1 * A + D2;
3515
3516     /* guard against overflow */
3517     if (N2 > G_MAXINT || D2 > G_MAXINT) {
3518       break;
3519     }
3520
3521     N = N2;
3522     D = D2;
3523
3524     /* save last two fractions */
3525     N2 = N1;
3526     D2 = D1;
3527     N1 = N;
3528     D1 = D;
3529
3530     /* quit if dividing by zero or close enough to target */
3531     if (F < MIN_DIVISOR || fabs (V - ((gdouble) N) / D) < MAX_ERROR) {
3532       break;
3533     }
3534
3535     /* Take reciprocal */
3536     F = 1 / F;
3537   }
3538   /* fix for overflow */
3539   if (D == 0) {
3540     N = G_MAXINT;
3541     D = 1;
3542   }
3543   /* fix for negative */
3544   if (negative)
3545     N = -N;
3546
3547   /* simplify */
3548   gcd = gst_util_greatest_common_divisor (N, D);
3549   if (gcd) {
3550     N /= gcd;
3551     D /= gcd;
3552   }
3553
3554   /* set results */
3555   *dest_n = N;
3556   *dest_d = D;
3557 }
3558
3559 /**
3560  * gst_util_fraction_multiply:
3561  * @a_n: Numerator of first value
3562  * @a_d: Denominator of first value
3563  * @b_n: Numerator of second value
3564  * @b_d: Denominator of second value
3565  * @res_n: (out): Pointer to #gint to hold the result numerator
3566  * @res_d: (out): Pointer to #gint to hold the result denominator
3567  *
3568  * Multiplies the fractions @a_n/@a_d and @b_n/@b_d and stores
3569  * the result in @res_n and @res_d.
3570  *
3571  * Returns: %FALSE on overflow, %TRUE otherwise.
3572  */
3573 gboolean
3574 gst_util_fraction_multiply (gint a_n, gint a_d, gint b_n, gint b_d,
3575     gint * res_n, gint * res_d)
3576 {
3577   gint gcd;
3578
3579   g_return_val_if_fail (res_n != NULL, FALSE);
3580   g_return_val_if_fail (res_d != NULL, FALSE);
3581   g_return_val_if_fail (a_d != 0, FALSE);
3582   g_return_val_if_fail (b_d != 0, FALSE);
3583
3584   /* early out if either is 0, as its gcd would be 0 */
3585   if (a_n == 0 || b_n == 0) {
3586     *res_n = 0;
3587     *res_d = 1;
3588     return TRUE;
3589   }
3590
3591   gcd = gst_util_greatest_common_divisor (a_n, a_d);
3592   a_n /= gcd;
3593   a_d /= gcd;
3594
3595   gcd = gst_util_greatest_common_divisor (b_n, b_d);
3596   b_n /= gcd;
3597   b_d /= gcd;
3598
3599   gcd = gst_util_greatest_common_divisor (a_n, b_d);
3600   a_n /= gcd;
3601   b_d /= gcd;
3602
3603   gcd = gst_util_greatest_common_divisor (a_d, b_n);
3604   a_d /= gcd;
3605   b_n /= gcd;
3606
3607   /* This would result in overflow */
3608   if (a_n != 0 && G_MAXINT / ABS (a_n) < ABS (b_n))
3609     return FALSE;
3610   if (G_MAXINT / ABS (a_d) < ABS (b_d))
3611     return FALSE;
3612
3613   *res_n = a_n * b_n;
3614   *res_d = a_d * b_d;
3615
3616   gcd = gst_util_greatest_common_divisor (*res_n, *res_d);
3617   *res_n /= gcd;
3618   *res_d /= gcd;
3619
3620   return TRUE;
3621 }
3622
3623 /**
3624  * gst_util_fraction_add:
3625  * @a_n: Numerator of first value
3626  * @a_d: Denominator of first value
3627  * @b_n: Numerator of second value
3628  * @b_d: Denominator of second value
3629  * @res_n: (out): Pointer to #gint to hold the result numerator
3630  * @res_d: (out): Pointer to #gint to hold the result denominator
3631  *
3632  * Adds the fractions @a_n/@a_d and @b_n/@b_d and stores
3633  * the result in @res_n and @res_d.
3634  *
3635  * Returns: %FALSE on overflow, %TRUE otherwise.
3636  */
3637 gboolean
3638 gst_util_fraction_add (gint a_n, gint a_d, gint b_n, gint b_d, gint * res_n,
3639     gint * res_d)
3640 {
3641   gint gcd;
3642
3643   g_return_val_if_fail (res_n != NULL, FALSE);
3644   g_return_val_if_fail (res_d != NULL, FALSE);
3645   g_return_val_if_fail (a_d != 0, FALSE);
3646   g_return_val_if_fail (b_d != 0, FALSE);
3647
3648   gcd = gst_util_greatest_common_divisor (a_n, a_d);
3649   a_n /= gcd;
3650   a_d /= gcd;
3651
3652   gcd = gst_util_greatest_common_divisor (b_n, b_d);
3653   b_n /= gcd;
3654   b_d /= gcd;
3655
3656   if (a_n == 0) {
3657     *res_n = b_n;
3658     *res_d = b_d;
3659     return TRUE;
3660   }
3661   if (b_n == 0) {
3662     *res_n = a_n;
3663     *res_d = a_d;
3664     return TRUE;
3665   }
3666
3667   /* This would result in overflow */
3668   if (G_MAXINT / ABS (a_n) < ABS (b_n))
3669     return FALSE;
3670   if (G_MAXINT / ABS (a_d) < ABS (b_d))
3671     return FALSE;
3672
3673   *res_n = (a_n * b_d) + (a_d * b_n);
3674   *res_d = a_d * b_d;
3675
3676   gcd = gst_util_greatest_common_divisor (*res_n, *res_d);
3677   if (gcd) {
3678     *res_n /= gcd;
3679     *res_d /= gcd;
3680   } else {
3681     /* res_n == 0 */
3682     *res_d = 1;
3683   }
3684
3685   return TRUE;
3686 }
3687
3688 /**
3689  * gst_util_fraction_compare:
3690  * @a_n: Numerator of first value
3691  * @a_d: Denominator of first value
3692  * @b_n: Numerator of second value
3693  * @b_d: Denominator of second value
3694  *
3695  * Compares the fractions @a_n/@a_d and @b_n/@b_d and returns
3696  * -1 if a < b, 0 if a = b and 1 if a > b.
3697  *
3698  * Returns: -1 if a < b; 0 if a = b; 1 if a > b.
3699  */
3700 gint
3701 gst_util_fraction_compare (gint a_n, gint a_d, gint b_n, gint b_d)
3702 {
3703   gint64 new_num_1;
3704   gint64 new_num_2;
3705   gint gcd;
3706
3707   g_return_val_if_fail (a_d != 0 && b_d != 0, 0);
3708
3709   /* Simplify */
3710   gcd = gst_util_greatest_common_divisor (a_n, a_d);
3711   a_n /= gcd;
3712   a_d /= gcd;
3713
3714   gcd = gst_util_greatest_common_divisor (b_n, b_d);
3715   b_n /= gcd;
3716   b_d /= gcd;
3717
3718   /* fractions are reduced when set, so we can quickly see if they're equal */
3719   if (a_n == b_n && a_d == b_d)
3720     return 0;
3721
3722   /* extend to 64 bits */
3723   new_num_1 = ((gint64) a_n) * b_d;
3724   new_num_2 = ((gint64) b_n) * a_d;
3725   if (new_num_1 < new_num_2)
3726     return -1;
3727   if (new_num_1 > new_num_2)
3728     return 1;
3729
3730   /* Should not happen because a_d and b_d are not 0 */
3731   g_return_val_if_reached (0);
3732 }
3733
3734 static gchar *
3735 gst_pad_create_stream_id_internal (GstPad * pad, GstElement * parent,
3736     const gchar * stream_id)
3737 {
3738   GstEvent *upstream_event;
3739   gchar *upstream_stream_id = NULL, *new_stream_id;
3740   GstPad *sinkpad;
3741
3742   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
3743   g_return_val_if_fail (GST_PAD_IS_SRC (pad), NULL);
3744   g_return_val_if_fail (GST_IS_ELEMENT (parent), NULL);
3745
3746   g_return_val_if_fail (parent->numsinkpads <= 1, NULL);
3747
3748   /* If the element has multiple source pads it must
3749    * provide a stream-id for every source pad, otherwise
3750    * all source pads will have the same and are not
3751    * distinguishable */
3752   g_return_val_if_fail (parent->numsrcpads <= 1 || stream_id, NULL);
3753
3754   /* First try to get the upstream stream-start stream-id from the sinkpad.
3755    * This will only work for non-source elements */
3756   sinkpad = gst_element_get_static_pad (parent, "sink");
3757   if (sinkpad) {
3758     upstream_event =
3759         gst_pad_get_sticky_event (sinkpad, GST_EVENT_STREAM_START, 0);
3760     if (upstream_event) {
3761       const gchar *tmp;
3762
3763       gst_event_parse_stream_start (upstream_event, &tmp);
3764       if (tmp)
3765         upstream_stream_id = g_strdup (tmp);
3766       gst_event_unref (upstream_event);
3767     }
3768     gst_object_unref (sinkpad);
3769   }
3770
3771   /* The only case where we don't have an upstream start-start event
3772    * here is for source elements */
3773   if (!upstream_stream_id) {
3774     GstQuery *query;
3775     gchar *uri = NULL;
3776
3777     /* Try to generate one from the URI query and
3778      * if it fails take a random number instead */
3779     query = gst_query_new_uri ();
3780     if (gst_element_query (parent, query)) {
3781       gst_query_parse_uri (query, &uri);
3782     }
3783
3784     if (uri) {
3785       GChecksum *cs;
3786
3787       /* And then generate an SHA256 sum of the URI */
3788       cs = g_checksum_new (G_CHECKSUM_SHA256);
3789       g_checksum_update (cs, (const guchar *) uri, strlen (uri));
3790       g_free (uri);
3791       upstream_stream_id = g_strdup (g_checksum_get_string (cs));
3792       g_checksum_free (cs);
3793     } else {
3794       /* Just get some random number if the URI query fails */
3795       GST_FIXME_OBJECT (pad, "Creating random stream-id, consider "
3796           "implementing a deterministic way of creating a stream-id");
3797       upstream_stream_id =
3798           g_strdup_printf ("%08x%08x%08x%08x", g_random_int (), g_random_int (),
3799           g_random_int (), g_random_int ());
3800     }
3801
3802     gst_query_unref (query);
3803   }
3804
3805   if (stream_id) {
3806     new_stream_id = g_strconcat (upstream_stream_id, "/", stream_id, NULL);
3807   } else {
3808     new_stream_id = g_strdup (upstream_stream_id);
3809   }
3810
3811   g_free (upstream_stream_id);
3812
3813   return new_stream_id;
3814 }
3815
3816 /**
3817  * gst_pad_create_stream_id_printf_valist:
3818  * @pad: A source #GstPad
3819  * @parent: Parent #GstElement of @pad
3820  * @stream_id: (allow-none): The stream-id
3821  * @var_args: parameters for the @stream_id format string
3822  *
3823  * Creates a stream-id for the source #GstPad @pad by combining the
3824  * upstream information with the optional @stream_id of the stream
3825  * of @pad. @pad must have a parent #GstElement and which must have zero
3826  * or one sinkpad. @stream_id can only be %NULL if the parent element
3827  * of @pad has only a single source pad.
3828  *
3829  * This function generates an unique stream-id by getting the upstream
3830  * stream-start event stream ID and appending @stream_id to it. If the
3831  * element has no sinkpad it will generate an upstream stream-id by
3832  * doing an URI query on the element and in the worst case just uses
3833  * a random number. Source elements that don't implement the URI
3834  * handler interface should ideally generate a unique, deterministic
3835  * stream-id manually instead.
3836  *
3837  * Returns: A stream-id for @pad. g_free() after usage.
3838  */
3839 gchar *
3840 gst_pad_create_stream_id_printf_valist (GstPad * pad, GstElement * parent,
3841     const gchar * stream_id, va_list var_args)
3842 {
3843   gchar *expanded = NULL, *new_stream_id;
3844
3845   if (stream_id)
3846     expanded = g_strdup_vprintf (stream_id, var_args);
3847
3848   new_stream_id = gst_pad_create_stream_id_internal (pad, parent, expanded);
3849
3850   g_free (expanded);
3851
3852   return new_stream_id;
3853 }
3854
3855 /**
3856  * gst_pad_create_stream_id_printf:
3857  * @pad: A source #GstPad
3858  * @parent: Parent #GstElement of @pad
3859  * @stream_id: (allow-none): The stream-id
3860  * @...: parameters for the @stream_id format string
3861  *
3862  * Creates a stream-id for the source #GstPad @pad by combining the
3863  * upstream information with the optional @stream_id of the stream
3864  * of @pad. @pad must have a parent #GstElement and which must have zero
3865  * or one sinkpad. @stream_id can only be %NULL if the parent element
3866  * of @pad has only a single source pad.
3867  *
3868  * This function generates an unique stream-id by getting the upstream
3869  * stream-start event stream ID and appending @stream_id to it. If the
3870  * element has no sinkpad it will generate an upstream stream-id by
3871  * doing an URI query on the element and in the worst case just uses
3872  * a random number. Source elements that don't implement the URI
3873  * handler interface should ideally generate a unique, deterministic
3874  * stream-id manually instead.
3875  *
3876  * Returns: A stream-id for @pad. g_free() after usage.
3877  */
3878 gchar *
3879 gst_pad_create_stream_id_printf (GstPad * pad, GstElement * parent,
3880     const gchar * stream_id, ...)
3881 {
3882   va_list var_args;
3883   gchar *new_stream_id;
3884
3885   va_start (var_args, stream_id);
3886   new_stream_id =
3887       gst_pad_create_stream_id_printf_valist (pad, parent, stream_id, var_args);
3888   va_end (var_args);
3889
3890   return new_stream_id;
3891 }
3892
3893 /**
3894  * gst_pad_create_stream_id:
3895  * @pad: A source #GstPad
3896  * @parent: Parent #GstElement of @pad
3897  * @stream_id: (allow-none): The stream-id
3898  *
3899  * Creates a stream-id for the source #GstPad @pad by combining the
3900  * upstream information with the optional @stream_id of the stream
3901  * of @pad. @pad must have a parent #GstElement and which must have zero
3902  * or one sinkpad. @stream_id can only be %NULL if the parent element
3903  * of @pad has only a single source pad.
3904  *
3905  * This function generates an unique stream-id by getting the upstream
3906  * stream-start event stream ID and appending @stream_id to it. If the
3907  * element has no sinkpad it will generate an upstream stream-id by
3908  * doing an URI query on the element and in the worst case just uses
3909  * a random number. Source elements that don't implement the URI
3910  * handler interface should ideally generate a unique, deterministic
3911  * stream-id manually instead.
3912  *
3913  * Since stream IDs are sorted alphabetically, any numbers in the
3914  * stream ID should be printed with a fixed number of characters,
3915  * preceded by 0's, such as by using the format \%03u instead of \%u.
3916  *
3917  * Returns: A stream-id for @pad. g_free() after usage.
3918  */
3919 gchar *
3920 gst_pad_create_stream_id (GstPad * pad, GstElement * parent,
3921     const gchar * stream_id)
3922 {
3923   return gst_pad_create_stream_id_internal (pad, parent, stream_id);
3924 }
3925
3926 /**
3927  * gst_pad_get_stream_id:
3928  * @pad: A source #GstPad
3929  *
3930  * Returns the current stream-id for the @pad, or %NULL if none has been
3931  * set yet, i.e. the pad has not received a stream-start event yet.
3932  *
3933  * This is a convenience wrapper around gst_pad_get_sticky_event() and
3934  * gst_event_parse_stream_start().
3935  *
3936  * The returned stream-id string should be treated as an opaque string, its
3937  * contents should not be interpreted.
3938  *
3939  * Returns: (nullable): a newly-allocated copy of the stream-id for
3940  *     @pad, or %NULL.  g_free() the returned string when no longer
3941  *     needed.
3942  *
3943  * Since: 1.2
3944  */
3945 gchar *
3946 gst_pad_get_stream_id (GstPad * pad)
3947 {
3948   const gchar *stream_id = NULL;
3949   GstEvent *event;
3950   gchar *ret = NULL;
3951
3952   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
3953
3954   event = gst_pad_get_sticky_event (pad, GST_EVENT_STREAM_START, 0);
3955   if (event != NULL) {
3956     gst_event_parse_stream_start (event, &stream_id);
3957     ret = g_strdup (stream_id);
3958     gst_event_unref (event);
3959     GST_LOG_OBJECT (pad, "pad has stream-id '%s'", ret);
3960   } else {
3961     GST_DEBUG_OBJECT (pad, "pad has not received a stream-start event yet");
3962   }
3963
3964   return ret;
3965 }
3966
3967 /**
3968  * gst_util_group_id_next:
3969  *
3970  * Return a constantly incrementing group id.
3971  *
3972  * This function is used to generate a new group-id for the
3973  * stream-start event.
3974  *
3975  * Returns: A constantly incrementing unsigned integer, which might
3976  * overflow back to 0 at some point.
3977  */
3978 guint
3979 gst_util_group_id_next (void)
3980 {
3981   static gint counter = 0;
3982   return g_atomic_int_add (&counter, 1);
3983 }