docs: Fix typos in function/object descriptions
[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 (GST_VALUE_HOLDS_STRUCTURE (&v) && 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): a compatible #GstPadTemplate, or NULL if none
777  *     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): the #GstPad, or NULL if one could not be found
854  *     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: a #GstPad, or %NULL if one could not be found or created.
895  */
896 static GstPad *
897 gst_element_request_compatible_pad (GstElement * element,
898     GstPadTemplate * templ)
899 {
900   GstPadTemplate *templ_new;
901   GstPad *pad = NULL;
902
903   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
904   g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
905
906   /* FIXME: should really loop through the templates, testing each for
907    *      compatibility and pad availability. */
908   templ_new = gst_element_get_compatible_pad_template (element, templ);
909   if (templ_new)
910     pad = gst_element_get_pad_from_template (element, templ_new);
911
912   /* This can happen for non-request pads. No need to unref. */
913   if (pad && GST_PAD_PEER (pad))
914     pad = NULL;
915
916   return pad;
917 }
918
919 /*
920  * Checks if the source pad and the sink pad can be linked.
921  * Both @srcpad and @sinkpad must be unlinked and have a parent.
922  */
923 static gboolean
924 gst_pad_check_link (GstPad * srcpad, GstPad * sinkpad)
925 {
926   /* FIXME This function is gross.  It's almost a direct copy of
927    * gst_pad_link_filtered().  Any decent programmer would attempt
928    * to merge the two functions, which I will do some day. --ds
929    */
930
931   /* generic checks */
932   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
933   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
934
935   GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
936       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
937
938   /* FIXME: shouldn't we convert this to g_return_val_if_fail? */
939   if (GST_PAD_PEER (srcpad) != NULL) {
940     GST_CAT_INFO (GST_CAT_PADS, "Source pad %s:%s has a peer, failed",
941         GST_DEBUG_PAD_NAME (srcpad));
942     return FALSE;
943   }
944   if (GST_PAD_PEER (sinkpad) != NULL) {
945     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has a peer, failed",
946         GST_DEBUG_PAD_NAME (sinkpad));
947     return FALSE;
948   }
949   if (!GST_PAD_IS_SRC (srcpad)) {
950     GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s is not source pad, failed",
951         GST_DEBUG_PAD_NAME (srcpad));
952     return FALSE;
953   }
954   if (!GST_PAD_IS_SINK (sinkpad)) {
955     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s is not sink pad, failed",
956         GST_DEBUG_PAD_NAME (sinkpad));
957     return FALSE;
958   }
959   if (GST_PAD_PARENT (srcpad) == NULL) {
960     GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s has no parent, failed",
961         GST_DEBUG_PAD_NAME (srcpad));
962     return FALSE;
963   }
964   if (GST_PAD_PARENT (sinkpad) == NULL) {
965     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has no parent, failed",
966         GST_DEBUG_PAD_NAME (srcpad));
967     return FALSE;
968   }
969
970   return TRUE;
971 }
972
973 /**
974  * gst_element_get_compatible_pad:
975  * @element: (transfer none): a #GstElement in which the pad should be found.
976  * @pad: (transfer none): the #GstPad to find a compatible one for.
977  * @caps: (allow-none): the #GstCaps to use as a filter.
978  *
979  * Looks for an unlinked pad to which the given pad can link. It is not
980  * guaranteed that linking the pads will work, though it should work in most
981  * cases.
982  *
983  * This function will first attempt to find a compatible unlinked ALWAYS pad,
984  * and if none can be found, it will request a compatible REQUEST pad by looking
985  * at the templates of @element.
986  *
987  * Returns: (transfer full): the #GstPad to which a link can be made, or %NULL
988  *     if one cannot be found. gst_object_unref() after usage.
989  */
990 GstPad *
991 gst_element_get_compatible_pad (GstElement * element, GstPad * pad,
992     GstCaps * caps)
993 {
994   GstIterator *pads;
995   GstPadTemplate *templ;
996   GstCaps *templcaps;
997   GstPad *foundpad = NULL;
998   gboolean done;
999   GValue padptr = { 0, };
1000
1001   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
1002   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1003
1004   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1005       "finding pad in %s compatible with %s:%s",
1006       GST_ELEMENT_NAME (element), GST_DEBUG_PAD_NAME (pad));
1007
1008   g_return_val_if_fail (GST_PAD_PEER (pad) == NULL, NULL);
1009
1010   done = FALSE;
1011
1012   /* try to get an existing unlinked pad */
1013   if (GST_PAD_IS_SRC (pad)) {
1014     pads = gst_element_iterate_sink_pads (element);
1015   } else if (GST_PAD_IS_SINK (pad)) {
1016     pads = gst_element_iterate_src_pads (element);
1017   } else {
1018     pads = gst_element_iterate_pads (element);
1019   }
1020
1021   while (!done) {
1022     switch (gst_iterator_next (pads, &padptr)) {
1023       case GST_ITERATOR_OK:
1024       {
1025         GstPad *peer;
1026         GstPad *current;
1027         GstPad *srcpad;
1028         GstPad *sinkpad;
1029
1030         current = g_value_get_object (&padptr);
1031
1032         GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
1033             GST_DEBUG_PAD_NAME (current));
1034
1035         if (GST_PAD_IS_SRC (current)) {
1036           srcpad = current;
1037           sinkpad = pad;
1038         } else {
1039           srcpad = pad;
1040           sinkpad = current;
1041         }
1042         peer = gst_pad_get_peer (current);
1043
1044         if (peer == NULL && gst_pad_check_link (srcpad, sinkpad)) {
1045           GstCaps *temp, *intersection;
1046           gboolean compatible;
1047
1048           /* Now check if the two pads' caps are compatible */
1049           temp = gst_pad_query_caps (pad, NULL);
1050           if (caps) {
1051             intersection = gst_caps_intersect (temp, caps);
1052             gst_caps_unref (temp);
1053           } else {
1054             intersection = temp;
1055           }
1056
1057           temp = gst_pad_query_caps (current, NULL);
1058           compatible = gst_caps_can_intersect (temp, intersection);
1059           gst_caps_unref (temp);
1060           gst_caps_unref (intersection);
1061
1062           if (compatible) {
1063             GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1064                 "found existing unlinked compatible pad %s:%s",
1065                 GST_DEBUG_PAD_NAME (current));
1066             gst_iterator_free (pads);
1067
1068             current = gst_object_ref (current);
1069             g_value_unset (&padptr);
1070
1071             return current;
1072           } else {
1073             GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "incompatible pads");
1074           }
1075         } else {
1076           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1077               "already linked or cannot be linked (peer = %p)", peer);
1078         }
1079         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unreffing pads");
1080
1081         g_value_reset (&padptr);
1082         if (peer)
1083           gst_object_unref (peer);
1084         break;
1085       }
1086       case GST_ITERATOR_DONE:
1087         done = TRUE;
1088         break;
1089       case GST_ITERATOR_RESYNC:
1090         gst_iterator_resync (pads);
1091         break;
1092       case GST_ITERATOR_ERROR:
1093         g_assert_not_reached ();
1094         break;
1095     }
1096   }
1097   g_value_unset (&padptr);
1098   gst_iterator_free (pads);
1099
1100   GST_CAT_DEBUG_OBJECT (GST_CAT_ELEMENT_PADS, element,
1101       "Could not find a compatible unlinked always pad to link to %s:%s, now checking request pads",
1102       GST_DEBUG_PAD_NAME (pad));
1103
1104   /* try to create a new one */
1105   /* requesting is a little crazy, we need a template. Let's create one */
1106   /* FIXME: why not gst_pad_get_pad_template (pad); */
1107   templcaps = gst_pad_query_caps (pad, NULL);
1108   templ = gst_pad_template_new ((gchar *) GST_PAD_NAME (pad),
1109       GST_PAD_DIRECTION (pad), GST_PAD_ALWAYS, templcaps);
1110   gst_caps_unref (templcaps);
1111
1112   foundpad = gst_element_request_compatible_pad (element, templ);
1113   gst_object_unref (templ);
1114
1115   if (foundpad) {
1116     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1117         "found existing request pad %s:%s", GST_DEBUG_PAD_NAME (foundpad));
1118     return foundpad;
1119   }
1120
1121   GST_CAT_INFO_OBJECT (GST_CAT_ELEMENT_PADS, element,
1122       "Could not find a compatible pad to link to %s:%s",
1123       GST_DEBUG_PAD_NAME (pad));
1124   return NULL;
1125 }
1126
1127 /**
1128  * gst_element_state_get_name:
1129  * @state: a #GstState to get the name of.
1130  *
1131  * Gets a string representing the given state.
1132  *
1133  * Returns: (transfer none): a string with the name of the state.
1134  */
1135 const gchar *
1136 gst_element_state_get_name (GstState state)
1137 {
1138   switch (state) {
1139     case GST_STATE_VOID_PENDING:
1140       return "VOID_PENDING";
1141     case GST_STATE_NULL:
1142       return "NULL";
1143     case GST_STATE_READY:
1144       return "READY";
1145     case GST_STATE_PLAYING:
1146       return "PLAYING";
1147     case GST_STATE_PAUSED:
1148       return "PAUSED";
1149     default:
1150       /* This is a memory leak */
1151       return g_strdup_printf ("UNKNOWN!(%d)", state);
1152   }
1153 }
1154
1155 /**
1156  * gst_element_state_change_return_get_name:
1157  * @state_ret: a #GstStateChangeReturn to get the name of.
1158  *
1159  * Gets a string representing the given state change result.
1160  *
1161  * Returns: (transfer none): a string with the name of the state
1162  *    result.
1163  */
1164 const gchar *
1165 gst_element_state_change_return_get_name (GstStateChangeReturn state_ret)
1166 {
1167   switch (state_ret) {
1168     case GST_STATE_CHANGE_FAILURE:
1169       return "FAILURE";
1170     case GST_STATE_CHANGE_SUCCESS:
1171       return "SUCCESS";
1172     case GST_STATE_CHANGE_ASYNC:
1173       return "ASYNC";
1174     case GST_STATE_CHANGE_NO_PREROLL:
1175       return "NO PREROLL";
1176     default:
1177       /* This is a memory leak */
1178       return g_strdup_printf ("UNKNOWN!(%d)", state_ret);
1179   }
1180 }
1181
1182
1183 static gboolean
1184 gst_element_factory_can_accept_all_caps_in_direction (GstElementFactory *
1185     factory, const GstCaps * caps, GstPadDirection direction)
1186 {
1187   GList *templates;
1188
1189   g_return_val_if_fail (factory != NULL, FALSE);
1190   g_return_val_if_fail (caps != NULL, FALSE);
1191
1192   templates = factory->staticpadtemplates;
1193
1194   while (templates) {
1195     GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1196
1197     if (template->direction == direction) {
1198       GstCaps *templcaps = gst_static_caps_get (&template->static_caps);
1199
1200       if (gst_caps_is_always_compatible (caps, templcaps)) {
1201         gst_caps_unref (templcaps);
1202         return TRUE;
1203       }
1204       gst_caps_unref (templcaps);
1205     }
1206     templates = g_list_next (templates);
1207   }
1208
1209   return FALSE;
1210 }
1211
1212 static gboolean
1213 gst_element_factory_can_accept_any_caps_in_direction (GstElementFactory *
1214     factory, const GstCaps * caps, GstPadDirection direction)
1215 {
1216   GList *templates;
1217
1218   g_return_val_if_fail (factory != NULL, FALSE);
1219   g_return_val_if_fail (caps != NULL, FALSE);
1220
1221   templates = factory->staticpadtemplates;
1222
1223   while (templates) {
1224     GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1225
1226     if (template->direction == direction) {
1227       GstCaps *templcaps = gst_static_caps_get (&template->static_caps);
1228
1229       if (gst_caps_can_intersect (caps, templcaps)) {
1230         gst_caps_unref (templcaps);
1231         return TRUE;
1232       }
1233       gst_caps_unref (templcaps);
1234     }
1235     templates = g_list_next (templates);
1236   }
1237
1238   return FALSE;
1239 }
1240
1241 /**
1242  * gst_element_factory_can_sink_all_caps:
1243  * @factory: factory to query
1244  * @caps: the caps to check
1245  *
1246  * Checks if the factory can sink all possible capabilities.
1247  *
1248  * Returns: %TRUE if the caps are fully compatible.
1249  */
1250 gboolean
1251 gst_element_factory_can_sink_all_caps (GstElementFactory * factory,
1252     const GstCaps * caps)
1253 {
1254   return gst_element_factory_can_accept_all_caps_in_direction (factory, caps,
1255       GST_PAD_SINK);
1256 }
1257
1258 /**
1259  * gst_element_factory_can_src_all_caps:
1260  * @factory: factory to query
1261  * @caps: the caps to check
1262  *
1263  * Checks if the factory can src all possible capabilities.
1264  *
1265  * Returns: %TRUE if the caps are fully compatible.
1266  */
1267 gboolean
1268 gst_element_factory_can_src_all_caps (GstElementFactory * factory,
1269     const GstCaps * caps)
1270 {
1271   return gst_element_factory_can_accept_all_caps_in_direction (factory, caps,
1272       GST_PAD_SRC);
1273 }
1274
1275 /**
1276  * gst_element_factory_can_sink_any_caps:
1277  * @factory: factory to query
1278  * @caps: the caps to check
1279  *
1280  * Checks if the factory can sink any possible capability.
1281  *
1282  * Returns: %TRUE if the caps have a common subset.
1283  */
1284 gboolean
1285 gst_element_factory_can_sink_any_caps (GstElementFactory * factory,
1286     const GstCaps * caps)
1287 {
1288   return gst_element_factory_can_accept_any_caps_in_direction (factory, caps,
1289       GST_PAD_SINK);
1290 }
1291
1292 /**
1293  * gst_element_factory_can_src_any_caps:
1294  * @factory: factory to query
1295  * @caps: the caps to check
1296  *
1297  * Checks if the factory can src any possible capability.
1298  *
1299  * Returns: %TRUE if the caps have a common subset.
1300  */
1301 gboolean
1302 gst_element_factory_can_src_any_caps (GstElementFactory * factory,
1303     const GstCaps * caps)
1304 {
1305   return gst_element_factory_can_accept_any_caps_in_direction (factory, caps,
1306       GST_PAD_SRC);
1307 }
1308
1309 /* if return val is true, *direct_child is a caller-owned ref on the direct
1310  * child of ancestor that is part of object's ancestry */
1311 static gboolean
1312 object_has_ancestor (GstObject * object, GstObject * ancestor,
1313     GstObject ** direct_child)
1314 {
1315   GstObject *child, *parent;
1316
1317   if (direct_child)
1318     *direct_child = NULL;
1319
1320   child = gst_object_ref (object);
1321   parent = gst_object_get_parent (object);
1322
1323   while (parent) {
1324     if (ancestor == parent) {
1325       if (direct_child)
1326         *direct_child = child;
1327       else
1328         gst_object_unref (child);
1329       gst_object_unref (parent);
1330       return TRUE;
1331     }
1332
1333     gst_object_unref (child);
1334     child = parent;
1335     parent = gst_object_get_parent (parent);
1336   }
1337
1338   gst_object_unref (child);
1339
1340   return FALSE;
1341 }
1342
1343 /* caller owns return */
1344 static GstObject *
1345 find_common_root (GstObject * o1, GstObject * o2)
1346 {
1347   GstObject *top = o1;
1348   GstObject *kid1, *kid2;
1349   GstObject *root = NULL;
1350
1351   while (GST_OBJECT_PARENT (top))
1352     top = GST_OBJECT_PARENT (top);
1353
1354   /* the itsy-bitsy spider... */
1355
1356   if (!object_has_ancestor (o2, top, &kid2))
1357     return NULL;
1358
1359   root = gst_object_ref (top);
1360   while (TRUE) {
1361     if (!object_has_ancestor (o1, kid2, &kid1)) {
1362       gst_object_unref (kid2);
1363       return root;
1364     }
1365     root = kid2;
1366     if (!object_has_ancestor (o2, kid1, &kid2)) {
1367       gst_object_unref (kid1);
1368       return root;
1369     }
1370     root = kid1;
1371   }
1372 }
1373
1374 /* caller does not own return */
1375 static GstPad *
1376 ghost_up (GstElement * e, GstPad * pad)
1377 {
1378   static gint ghost_pad_index = 0;
1379   GstPad *gpad;
1380   gchar *name;
1381   GstState current;
1382   GstState next;
1383   GstObject *parent = GST_OBJECT_PARENT (e);
1384
1385   name = g_strdup_printf ("ghost%d", ghost_pad_index++);
1386   gpad = gst_ghost_pad_new (name, pad);
1387   g_free (name);
1388
1389   GST_STATE_LOCK (e);
1390   gst_element_get_state (e, &current, &next, 0);
1391
1392   if (current > GST_STATE_READY || next == GST_STATE_PAUSED)
1393     gst_pad_set_active (gpad, TRUE);
1394
1395   if (!gst_element_add_pad ((GstElement *) parent, gpad)) {
1396     g_warning ("Pad named %s already exists in element %s\n",
1397         GST_OBJECT_NAME (gpad), GST_OBJECT_NAME (parent));
1398     gst_object_unref ((GstObject *) gpad);
1399     GST_STATE_UNLOCK (e);
1400     return NULL;
1401   }
1402   GST_STATE_UNLOCK (e);
1403
1404   return gpad;
1405 }
1406
1407 static void
1408 remove_pad (gpointer ppad, gpointer unused)
1409 {
1410   GstPad *pad = ppad;
1411
1412   if (!gst_element_remove_pad ((GstElement *) GST_OBJECT_PARENT (pad), pad))
1413     g_warning ("Couldn't remove pad %s from element %s",
1414         GST_OBJECT_NAME (pad), GST_OBJECT_NAME (GST_OBJECT_PARENT (pad)));
1415 }
1416
1417 static gboolean
1418 prepare_link_maybe_ghosting (GstPad ** src, GstPad ** sink,
1419     GSList ** pads_created)
1420 {
1421   GstObject *root;
1422   GstObject *e1, *e2;
1423   GSList *pads_created_local = NULL;
1424
1425   g_assert (pads_created);
1426
1427   e1 = GST_OBJECT_PARENT (*src);
1428   e2 = GST_OBJECT_PARENT (*sink);
1429
1430   if (G_UNLIKELY (e1 == NULL)) {
1431     GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1432         GST_PTR_FORMAT, *src);
1433     return FALSE;
1434   }
1435   if (G_UNLIKELY (e2 == NULL)) {
1436     GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1437         GST_PTR_FORMAT, *sink);
1438     return FALSE;
1439   }
1440
1441   if (GST_OBJECT_PARENT (e1) == GST_OBJECT_PARENT (e2)) {
1442     GST_CAT_INFO (GST_CAT_PADS, "%s and %s in same bin, no need for ghost pads",
1443         GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1444     return TRUE;
1445   }
1446
1447   GST_CAT_INFO (GST_CAT_PADS, "%s and %s not in same bin, making ghost pads",
1448       GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1449
1450   /* we need to setup some ghost pads */
1451   root = find_common_root (e1, e2);
1452   if (!root) {
1453     g_warning ("Trying to connect elements that don't share a common "
1454         "ancestor: %s and %s", GST_ELEMENT_NAME (e1), GST_ELEMENT_NAME (e2));
1455     return FALSE;
1456   }
1457
1458   while (GST_OBJECT_PARENT (e1) != root) {
1459     *src = ghost_up ((GstElement *) e1, *src);
1460     if (!*src)
1461       goto cleanup_fail;
1462     e1 = GST_OBJECT_PARENT (*src);
1463     pads_created_local = g_slist_prepend (pads_created_local, *src);
1464   }
1465   while (GST_OBJECT_PARENT (e2) != root) {
1466     *sink = ghost_up ((GstElement *) e2, *sink);
1467     if (!*sink)
1468       goto cleanup_fail;
1469     e2 = GST_OBJECT_PARENT (*sink);
1470     pads_created_local = g_slist_prepend (pads_created_local, *sink);
1471   }
1472
1473   gst_object_unref (root);
1474   *pads_created = g_slist_concat (*pads_created, pads_created_local);
1475   return TRUE;
1476
1477 cleanup_fail:
1478   gst_object_unref (root);
1479   g_slist_foreach (pads_created_local, remove_pad, NULL);
1480   g_slist_free (pads_created_local);
1481   return FALSE;
1482 }
1483
1484 static gboolean
1485 pad_link_maybe_ghosting (GstPad * src, GstPad * sink, GstPadLinkCheck flags)
1486 {
1487   GSList *pads_created = NULL;
1488   gboolean ret;
1489
1490   if (!prepare_link_maybe_ghosting (&src, &sink, &pads_created)) {
1491     ret = FALSE;
1492   } else {
1493     ret = (gst_pad_link_full (src, sink, flags) == GST_PAD_LINK_OK);
1494   }
1495
1496   if (!ret) {
1497     g_slist_foreach (pads_created, remove_pad, NULL);
1498   }
1499   g_slist_free (pads_created);
1500
1501   return ret;
1502 }
1503
1504 /**
1505  * gst_element_link_pads_full:
1506  * @src: a #GstElement containing the source pad.
1507  * @srcpadname: (allow-none): the name of the #GstPad in source element
1508  *     or NULL for any pad.
1509  * @dest: (transfer none): the #GstElement containing the destination pad.
1510  * @destpadname: (allow-none): the name of the #GstPad in destination element,
1511  * or NULL for any pad.
1512  * @flags: the #GstPadLinkCheck to be performed when linking pads.
1513  *
1514  * Links the two named pads of the source and destination elements.
1515  * Side effect is that if one of the pads has no parent, it becomes a
1516  * child of the parent of the other element.  If they have different
1517  * parents, the link fails.
1518  *
1519  * Calling gst_element_link_pads_full() with @flags == %GST_PAD_LINK_CHECK_DEFAULT
1520  * is the same as calling gst_element_link_pads() and the recommended way of
1521  * linking pads with safety checks applied.
1522  *
1523  * This is a convenience function for gst_pad_link_full().
1524  *
1525  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1526  */
1527 gboolean
1528 gst_element_link_pads_full (GstElement * src, const gchar * srcpadname,
1529     GstElement * dest, const gchar * destpadname, GstPadLinkCheck flags)
1530 {
1531   const GList *srcpads, *destpads, *srctempls, *desttempls, *l;
1532   GstPad *srcpad, *destpad;
1533   GstPadTemplate *srctempl, *desttempl;
1534   GstElementClass *srcclass, *destclass;
1535
1536   /* checks */
1537   g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1538   g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1539
1540   GST_CAT_INFO (GST_CAT_ELEMENT_PADS,
1541       "trying to link element %s:%s to element %s:%s", GST_ELEMENT_NAME (src),
1542       srcpadname ? srcpadname : "(any)", GST_ELEMENT_NAME (dest),
1543       destpadname ? destpadname : "(any)");
1544
1545   /* get a src pad */
1546   if (srcpadname) {
1547     /* name specified, look it up */
1548     if (!(srcpad = gst_element_get_static_pad (src, srcpadname)))
1549       srcpad = gst_element_get_request_pad (src, srcpadname);
1550     if (!srcpad) {
1551       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1552           GST_ELEMENT_NAME (src), srcpadname);
1553       return FALSE;
1554     } else {
1555       if (!(GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC)) {
1556         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no src pad",
1557             GST_DEBUG_PAD_NAME (srcpad));
1558         gst_object_unref (srcpad);
1559         return FALSE;
1560       }
1561       if (GST_PAD_PEER (srcpad) != NULL) {
1562         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1563             "pad %s:%s is already linked to %s:%s", GST_DEBUG_PAD_NAME (srcpad),
1564             GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
1565         gst_object_unref (srcpad);
1566         return FALSE;
1567       }
1568     }
1569     srcpads = NULL;
1570   } else {
1571     /* no name given, get the first available pad */
1572     GST_OBJECT_LOCK (src);
1573     srcpads = GST_ELEMENT_PADS (src);
1574     srcpad = srcpads ? GST_PAD_CAST (srcpads->data) : NULL;
1575     if (srcpad)
1576       gst_object_ref (srcpad);
1577     GST_OBJECT_UNLOCK (src);
1578   }
1579
1580   /* get a destination pad */
1581   if (destpadname) {
1582     /* name specified, look it up */
1583     if (!(destpad = gst_element_get_static_pad (dest, destpadname)))
1584       destpad = gst_element_get_request_pad (dest, destpadname);
1585     if (!destpad) {
1586       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1587           GST_ELEMENT_NAME (dest), destpadname);
1588       return FALSE;
1589     } else {
1590       if (!(GST_PAD_DIRECTION (destpad) == GST_PAD_SINK)) {
1591         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no sink pad",
1592             GST_DEBUG_PAD_NAME (destpad));
1593         gst_object_unref (destpad);
1594         return FALSE;
1595       }
1596       if (GST_PAD_PEER (destpad) != NULL) {
1597         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1598             "pad %s:%s is already linked to %s:%s",
1599             GST_DEBUG_PAD_NAME (destpad),
1600             GST_DEBUG_PAD_NAME (GST_PAD_PEER (destpad)));
1601         gst_object_unref (destpad);
1602         return FALSE;
1603       }
1604     }
1605     destpads = NULL;
1606   } else {
1607     /* no name given, get the first available pad */
1608     GST_OBJECT_LOCK (dest);
1609     destpads = GST_ELEMENT_PADS (dest);
1610     destpad = destpads ? GST_PAD_CAST (destpads->data) : NULL;
1611     if (destpad)
1612       gst_object_ref (destpad);
1613     GST_OBJECT_UNLOCK (dest);
1614   }
1615
1616   if (srcpadname && destpadname) {
1617     gboolean result;
1618
1619     /* two explicitly specified pads */
1620     result = pad_link_maybe_ghosting (srcpad, destpad, flags);
1621
1622     gst_object_unref (srcpad);
1623     gst_object_unref (destpad);
1624
1625     return result;
1626   }
1627
1628   if (srcpad) {
1629     /* loop through the allowed pads in the source, trying to find a
1630      * compatible destination pad */
1631     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1632         "looping through allowed src and dest pads");
1633     do {
1634       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying src pad %s:%s",
1635           GST_DEBUG_PAD_NAME (srcpad));
1636       if ((GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC) &&
1637           (GST_PAD_PEER (srcpad) == NULL)) {
1638         GstPad *temp;
1639
1640         if (destpadname) {
1641           temp = destpad;
1642           gst_object_ref (temp);
1643         } else {
1644           temp = gst_element_get_compatible_pad (dest, srcpad, NULL);
1645         }
1646
1647         if (temp && pad_link_maybe_ghosting (srcpad, temp, flags)) {
1648           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1649               GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (temp));
1650           if (destpad)
1651             gst_object_unref (destpad);
1652           gst_object_unref (srcpad);
1653           gst_object_unref (temp);
1654           return TRUE;
1655         }
1656
1657         if (temp) {
1658           gst_object_unref (temp);
1659         }
1660       }
1661       /* find a better way for this mess */
1662       if (srcpads) {
1663         srcpads = g_list_next (srcpads);
1664         if (srcpads) {
1665           gst_object_unref (srcpad);
1666           srcpad = GST_PAD_CAST (srcpads->data);
1667           gst_object_ref (srcpad);
1668         }
1669       }
1670     } while (srcpads);
1671   }
1672   if (srcpadname) {
1673     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s:%s to %s",
1674         GST_DEBUG_PAD_NAME (srcpad), GST_ELEMENT_NAME (dest));
1675     if (destpad)
1676       gst_object_unref (destpad);
1677     destpad = NULL;
1678   }
1679   if (srcpad)
1680     gst_object_unref (srcpad);
1681   srcpad = NULL;
1682
1683   if (destpad) {
1684     /* loop through the existing pads in the destination */
1685     do {
1686       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying dest pad %s:%s",
1687           GST_DEBUG_PAD_NAME (destpad));
1688       if ((GST_PAD_DIRECTION (destpad) == GST_PAD_SINK) &&
1689           (GST_PAD_PEER (destpad) == NULL)) {
1690         GstPad *temp = gst_element_get_compatible_pad (src, destpad, NULL);
1691
1692         if (temp && pad_link_maybe_ghosting (temp, destpad, flags)) {
1693           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1694               GST_DEBUG_PAD_NAME (temp), GST_DEBUG_PAD_NAME (destpad));
1695           gst_object_unref (temp);
1696           gst_object_unref (destpad);
1697           return TRUE;
1698         }
1699         if (temp) {
1700           gst_object_unref (temp);
1701         }
1702       }
1703       if (destpads) {
1704         destpads = g_list_next (destpads);
1705         if (destpads) {
1706           gst_object_unref (destpad);
1707           destpad = GST_PAD_CAST (destpads->data);
1708           gst_object_ref (destpad);
1709         }
1710       }
1711     } while (destpads);
1712   }
1713
1714   if (destpadname) {
1715     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s:%s",
1716         GST_ELEMENT_NAME (src), GST_DEBUG_PAD_NAME (destpad));
1717     gst_object_unref (destpad);
1718     return FALSE;
1719   } else {
1720     if (destpad)
1721       gst_object_unref (destpad);
1722     destpad = NULL;
1723   }
1724
1725   srcclass = GST_ELEMENT_GET_CLASS (src);
1726   destclass = GST_ELEMENT_GET_CLASS (dest);
1727
1728   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1729       "we might have request pads on both sides, checking...");
1730   srctempls = gst_element_class_get_pad_template_list (srcclass);
1731   desttempls = gst_element_class_get_pad_template_list (destclass);
1732
1733   if (srctempls && desttempls) {
1734     while (srctempls) {
1735       srctempl = (GstPadTemplate *) srctempls->data;
1736       if (srctempl->presence == GST_PAD_REQUEST) {
1737         for (l = desttempls; l; l = l->next) {
1738           desttempl = (GstPadTemplate *) l->data;
1739           if (desttempl->presence == GST_PAD_REQUEST &&
1740               desttempl->direction != srctempl->direction) {
1741             GstCaps *srccaps, *destcaps;
1742
1743             srccaps = gst_pad_template_get_caps (srctempl);
1744             destcaps = gst_pad_template_get_caps (desttempl);
1745             if (gst_caps_is_always_compatible (srccaps, destcaps)) {
1746               srcpad =
1747                   gst_element_request_pad (src, srctempl,
1748                   srctempl->name_template, NULL);
1749               destpad =
1750                   gst_element_request_pad (dest, desttempl,
1751                   desttempl->name_template, NULL);
1752               if (srcpad && destpad
1753                   && pad_link_maybe_ghosting (srcpad, destpad, flags)) {
1754                 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1755                     "linked pad %s:%s to pad %s:%s",
1756                     GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (destpad));
1757                 gst_object_unref (srcpad);
1758                 gst_object_unref (destpad);
1759                 gst_caps_unref (srccaps);
1760                 gst_caps_unref (destcaps);
1761                 return TRUE;
1762               }
1763               /* it failed, so we release the request pads */
1764               if (srcpad)
1765                 gst_element_release_request_pad (src, srcpad);
1766               if (destpad)
1767                 gst_element_release_request_pad (dest, destpad);
1768             }
1769             gst_caps_unref (srccaps);
1770             gst_caps_unref (destcaps);
1771           }
1772         }
1773       }
1774       srctempls = srctempls->next;
1775     }
1776   }
1777
1778   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s",
1779       GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
1780   return FALSE;
1781 }
1782
1783 /**
1784  * gst_element_link_pads:
1785  * @src: a #GstElement containing the source pad.
1786  * @srcpadname: (allow-none): the name of the #GstPad in source element
1787  *     or NULL for any pad.
1788  * @dest: (transfer none): the #GstElement containing the destination pad.
1789  * @destpadname: (allow-none): the name of the #GstPad in destination element,
1790  * or NULL for any pad.
1791  *
1792  * Links the two named pads of the source and destination elements.
1793  * Side effect is that if one of the pads has no parent, it becomes a
1794  * child of the parent of the other element.  If they have different
1795  * parents, the link fails.
1796  *
1797  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1798  */
1799 gboolean
1800 gst_element_link_pads (GstElement * src, const gchar * srcpadname,
1801     GstElement * dest, const gchar * destpadname)
1802 {
1803   return gst_element_link_pads_full (src, srcpadname, dest, destpadname,
1804       GST_PAD_LINK_CHECK_DEFAULT);
1805 }
1806
1807 /**
1808  * gst_element_link_pads_filtered:
1809  * @src: a #GstElement containing the source pad.
1810  * @srcpadname: (allow-none): the name of the #GstPad in source element
1811  *     or NULL for any pad.
1812  * @dest: (transfer none): the #GstElement containing the destination pad.
1813  * @destpadname: (allow-none): the name of the #GstPad in destination element
1814  *     or NULL for any pad.
1815  * @filter: (transfer none) (allow-none): the #GstCaps to filter the link,
1816  *     or #NULL for no filter.
1817  *
1818  * Links the two named pads of the source and destination elements. Side effect
1819  * is that if one of the pads has no parent, it becomes a child of the parent of
1820  * the other element. If they have different parents, the link fails. If @caps
1821  * is not #NULL, makes sure that the caps of the link is a subset of @caps.
1822  *
1823  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1824  */
1825 gboolean
1826 gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
1827     GstElement * dest, const gchar * destpadname, GstCaps * filter)
1828 {
1829   /* checks */
1830   g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1831   g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1832   g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), FALSE);
1833
1834   if (filter) {
1835     GstElement *capsfilter;
1836     GstObject *parent;
1837     GstState state, pending;
1838     gboolean lr1, lr2;
1839
1840     capsfilter = gst_element_factory_make ("capsfilter", NULL);
1841     if (!capsfilter) {
1842       GST_ERROR ("Could not make a capsfilter");
1843       return FALSE;
1844     }
1845
1846     parent = gst_object_get_parent (GST_OBJECT (src));
1847     g_return_val_if_fail (GST_IS_BIN (parent), FALSE);
1848
1849     gst_element_get_state (GST_ELEMENT_CAST (parent), &state, &pending, 0);
1850
1851     if (!gst_bin_add (GST_BIN (parent), capsfilter)) {
1852       GST_ERROR ("Could not add capsfilter");
1853       gst_object_unref (capsfilter);
1854       gst_object_unref (parent);
1855       return FALSE;
1856     }
1857
1858     if (pending != GST_STATE_VOID_PENDING)
1859       state = pending;
1860
1861     gst_element_set_state (capsfilter, state);
1862
1863     gst_object_unref (parent);
1864
1865     g_object_set (capsfilter, "caps", filter, NULL);
1866
1867     lr1 = gst_element_link_pads (src, srcpadname, capsfilter, "sink");
1868     lr2 = gst_element_link_pads (capsfilter, "src", dest, destpadname);
1869     if (lr1 && lr2) {
1870       return TRUE;
1871     } else {
1872       if (!lr1) {
1873         GST_INFO ("Could not link pads: %s:%s - capsfilter:sink",
1874             GST_ELEMENT_NAME (src), srcpadname);
1875       } else {
1876         GST_INFO ("Could not link pads: capsfilter:src - %s:%s",
1877             GST_ELEMENT_NAME (dest), destpadname);
1878       }
1879       gst_element_set_state (capsfilter, GST_STATE_NULL);
1880       /* this will unlink and unref as appropriate */
1881       gst_bin_remove (GST_BIN (GST_OBJECT_PARENT (capsfilter)), capsfilter);
1882       return FALSE;
1883     }
1884   } else {
1885     if (gst_element_link_pads (src, srcpadname, dest, destpadname)) {
1886       return TRUE;
1887     } else {
1888       GST_INFO ("Could not link pads: %s:%s - %s:%s", GST_ELEMENT_NAME (src),
1889           srcpadname, GST_ELEMENT_NAME (dest), destpadname);
1890       return FALSE;
1891     }
1892   }
1893 }
1894
1895 /**
1896  * gst_element_link:
1897  * @src: (transfer none): a #GstElement containing the source pad.
1898  * @dest: (transfer none): the #GstElement containing the destination pad.
1899  *
1900  * Links @src to @dest. The link must be from source to
1901  * destination; the other direction will not be tried. The function looks for
1902  * existing pads that aren't linked yet. It will request new pads if necessary.
1903  * Such pads need to be released manually when unlinking.
1904  * If multiple links are possible, only one is established.
1905  *
1906  * Make sure you have added your elements to a bin or pipeline with
1907  * gst_bin_add() before trying to link them.
1908  *
1909  * Returns: TRUE if the elements could be linked, FALSE otherwise.
1910  */
1911 gboolean
1912 gst_element_link (GstElement * src, GstElement * dest)
1913 {
1914   return gst_element_link_pads (src, NULL, dest, NULL);
1915 }
1916
1917 /**
1918  * gst_element_link_many:
1919  * @element_1: (transfer none): the first #GstElement in the link chain.
1920  * @element_2: (transfer none): the second #GstElement in the link chain.
1921  * @...: the NULL-terminated list of elements to link in order.
1922  *
1923  * Chain together a series of elements. Uses gst_element_link().
1924  * Make sure you have added your elements to a bin or pipeline with
1925  * gst_bin_add() before trying to link them.
1926  *
1927  * Returns: TRUE on success, FALSE otherwise.
1928  */
1929 gboolean
1930 gst_element_link_many (GstElement * element_1, GstElement * element_2, ...)
1931 {
1932   gboolean res = TRUE;
1933   va_list args;
1934
1935   g_return_val_if_fail (GST_IS_ELEMENT (element_1), FALSE);
1936   g_return_val_if_fail (GST_IS_ELEMENT (element_2), FALSE);
1937
1938   va_start (args, element_2);
1939
1940   while (element_2) {
1941     if (!gst_element_link (element_1, element_2)) {
1942       res = FALSE;
1943       break;
1944     }
1945
1946     element_1 = element_2;
1947     element_2 = va_arg (args, GstElement *);
1948   }
1949
1950   va_end (args);
1951
1952   return res;
1953 }
1954
1955 /**
1956  * gst_element_link_filtered:
1957  * @src: a #GstElement containing the source pad.
1958  * @dest: (transfer none): the #GstElement containing the destination pad.
1959  * @filter: (transfer none) (allow-none): the #GstCaps to filter the link,
1960  *     or #NULL for no filter.
1961  *
1962  * Links @src to @dest using the given caps as filtercaps.
1963  * The link must be from source to
1964  * destination; the other direction will not be tried. The function looks for
1965  * existing pads that aren't linked yet. It will request new pads if necessary.
1966  * If multiple links are possible, only one is established.
1967  *
1968  * Make sure you have added your elements to a bin or pipeline with
1969  * gst_bin_add() before trying to link them.
1970  *
1971  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1972  */
1973 gboolean
1974 gst_element_link_filtered (GstElement * src, GstElement * dest,
1975     GstCaps * filter)
1976 {
1977   return gst_element_link_pads_filtered (src, NULL, dest, NULL, filter);
1978 }
1979
1980 /**
1981  * gst_element_unlink_pads:
1982  * @src: a (transfer none): #GstElement containing the source pad.
1983  * @srcpadname: the name of the #GstPad in source element.
1984  * @dest: (transfer none): a #GstElement containing the destination pad.
1985  * @destpadname: the name of the #GstPad in destination element.
1986  *
1987  * Unlinks the two named pads of the source and destination elements.
1988  *
1989  * This is a convenience function for gst_pad_unlink().
1990  */
1991 void
1992 gst_element_unlink_pads (GstElement * src, const gchar * srcpadname,
1993     GstElement * dest, const gchar * destpadname)
1994 {
1995   GstPad *srcpad, *destpad;
1996   gboolean srcrequest, destrequest;
1997
1998   srcrequest = destrequest = FALSE;
1999
2000   g_return_if_fail (src != NULL);
2001   g_return_if_fail (GST_IS_ELEMENT (src));
2002   g_return_if_fail (srcpadname != NULL);
2003   g_return_if_fail (dest != NULL);
2004   g_return_if_fail (GST_IS_ELEMENT (dest));
2005   g_return_if_fail (destpadname != NULL);
2006
2007   /* obtain the pads requested */
2008   if (!(srcpad = gst_element_get_static_pad (src, srcpadname)))
2009     if ((srcpad = gst_element_get_request_pad (src, srcpadname)))
2010       srcrequest = TRUE;
2011   if (srcpad == NULL) {
2012     GST_WARNING_OBJECT (src, "source element has no pad \"%s\"", srcpadname);
2013     return;
2014   }
2015   if (!(destpad = gst_element_get_static_pad (dest, destpadname)))
2016     if ((destpad = gst_element_get_request_pad (dest, destpadname)))
2017       destrequest = TRUE;
2018   if (destpad == NULL) {
2019     GST_WARNING_OBJECT (dest, "destination element has no pad \"%s\"",
2020         destpadname);
2021     goto free_src;
2022   }
2023
2024   /* we're satisfied they can be unlinked, let's do it */
2025   gst_pad_unlink (srcpad, destpad);
2026
2027   if (destrequest)
2028     gst_element_release_request_pad (dest, destpad);
2029   gst_object_unref (destpad);
2030
2031 free_src:
2032   if (srcrequest)
2033     gst_element_release_request_pad (src, srcpad);
2034   gst_object_unref (srcpad);
2035 }
2036
2037 /**
2038  * gst_element_unlink_many:
2039  * @element_1: (transfer none): the first #GstElement in the link chain.
2040  * @element_2: (transfer none): the second #GstElement in the link chain.
2041  * @...: the NULL-terminated list of elements to unlink in order.
2042  *
2043  * Unlinks a series of elements. Uses gst_element_unlink().
2044  */
2045 void
2046 gst_element_unlink_many (GstElement * element_1, GstElement * element_2, ...)
2047 {
2048   va_list args;
2049
2050   g_return_if_fail (element_1 != NULL && element_2 != NULL);
2051   g_return_if_fail (GST_IS_ELEMENT (element_1) && GST_IS_ELEMENT (element_2));
2052
2053   va_start (args, element_2);
2054
2055   while (element_2) {
2056     gst_element_unlink (element_1, element_2);
2057
2058     element_1 = element_2;
2059     element_2 = va_arg (args, GstElement *);
2060   }
2061
2062   va_end (args);
2063 }
2064
2065 /**
2066  * gst_element_unlink:
2067  * @src: (transfer none): the source #GstElement to unlink.
2068  * @dest: (transfer none): the sink #GstElement to unlink.
2069  *
2070  * Unlinks all source pads of the source element with all sink pads
2071  * of the sink element to which they are linked.
2072  *
2073  * If the link has been made using gst_element_link(), it could have created an
2074  * requestpad, which has to be released using gst_element_release_request_pad().
2075  */
2076 void
2077 gst_element_unlink (GstElement * src, GstElement * dest)
2078 {
2079   GstIterator *pads;
2080   gboolean done = FALSE;
2081   GValue data = { 0, };
2082
2083   g_return_if_fail (GST_IS_ELEMENT (src));
2084   g_return_if_fail (GST_IS_ELEMENT (dest));
2085
2086   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unlinking \"%s\" and \"%s\"",
2087       GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
2088
2089   pads = gst_element_iterate_pads (src);
2090   while (!done) {
2091     switch (gst_iterator_next (pads, &data)) {
2092       case GST_ITERATOR_OK:
2093       {
2094         GstPad *pad = g_value_get_object (&data);
2095
2096         if (GST_PAD_IS_SRC (pad)) {
2097           GstPad *peerpad = gst_pad_get_peer (pad);
2098
2099           /* see if the pad is linked and is really a pad of dest */
2100           if (peerpad) {
2101             GstElement *peerelem;
2102
2103             peerelem = gst_pad_get_parent_element (peerpad);
2104
2105             if (peerelem == dest) {
2106               gst_pad_unlink (pad, peerpad);
2107             }
2108             if (peerelem)
2109               gst_object_unref (peerelem);
2110
2111             gst_object_unref (peerpad);
2112           }
2113         }
2114         g_value_reset (&data);
2115         break;
2116       }
2117       case GST_ITERATOR_RESYNC:
2118         gst_iterator_resync (pads);
2119         break;
2120       case GST_ITERATOR_DONE:
2121         done = TRUE;
2122         break;
2123       default:
2124         g_assert_not_reached ();
2125         break;
2126     }
2127   }
2128   g_value_unset (&data);
2129   gst_iterator_free (pads);
2130 }
2131
2132 /**
2133  * gst_element_query_position:
2134  * @element: a #GstElement to invoke the position query on.
2135  * @format: the #GstFormat requested
2136  * @cur: (out) (allow-none): a location in which to store the current
2137  *     position, or NULL.
2138  *
2139  * Queries an element (usually top-level pipeline or playbin element) for the
2140  * stream position in nanoseconds. This will be a value between 0 and the
2141  * stream duration (if the stream duration is known). This query will usually
2142  * only work once the pipeline is prerolled (i.e. reached PAUSED or PLAYING
2143  * state). The application will receive an ASYNC_DONE message on the pipeline
2144  * bus when that is the case.
2145  *
2146  * If one repeatedly calls this function one can also create a query and reuse
2147  * it in gst_element_query().
2148  *
2149  * Returns: TRUE if the query could be performed.
2150  */
2151 gboolean
2152 gst_element_query_position (GstElement * element, GstFormat format,
2153     gint64 * cur)
2154 {
2155   GstQuery *query;
2156   gboolean ret;
2157
2158   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2159   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2160
2161   query = gst_query_new_position (format);
2162   ret = gst_element_query (element, query);
2163
2164   if (ret)
2165     gst_query_parse_position (query, NULL, cur);
2166
2167   gst_query_unref (query);
2168
2169   return ret;
2170 }
2171
2172 /**
2173  * gst_element_query_duration:
2174  * @element: a #GstElement to invoke the duration query on.
2175  * @format: the #GstFormat requested
2176  * @duration: (out) (allow-none): A location in which to store the total duration, or NULL.
2177  *
2178  * Queries an element (usually top-level pipeline or playbin element) for the
2179  * total stream duration in nanoseconds. This query will only work once the
2180  * pipeline is prerolled (i.e. reached PAUSED or PLAYING state). The application
2181  * will receive an ASYNC_DONE message on the pipeline bus when that is the case.
2182  *
2183  * If the duration changes for some reason, you will get a DURATION_CHANGED
2184  * message on the pipeline bus, in which case you should re-query the duration
2185  * using this function.
2186  *
2187  * Returns: TRUE if the query could be performed.
2188  */
2189 gboolean
2190 gst_element_query_duration (GstElement * element, GstFormat format,
2191     gint64 * duration)
2192 {
2193   GstQuery *query;
2194   gboolean ret;
2195
2196   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2197   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2198
2199   query = gst_query_new_duration (format);
2200   ret = gst_element_query (element, query);
2201
2202   if (ret)
2203     gst_query_parse_duration (query, NULL, duration);
2204
2205   gst_query_unref (query);
2206
2207   return ret;
2208 }
2209
2210 /**
2211  * gst_element_query_convert:
2212  * @element: a #GstElement to invoke the convert query on.
2213  * @src_format: (inout): a #GstFormat to convert from.
2214  * @src_val: a value to convert.
2215  * @dest_format: the #GstFormat to convert to.
2216  * @dest_val: (out): a pointer to the result.
2217  *
2218  * Queries an element to convert @src_val in @src_format to @dest_format.
2219  *
2220  * Returns: TRUE if the query could be performed.
2221  */
2222 gboolean
2223 gst_element_query_convert (GstElement * element, GstFormat src_format,
2224     gint64 src_val, GstFormat dest_format, gint64 * dest_val)
2225 {
2226   GstQuery *query;
2227   gboolean ret;
2228
2229   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2230   g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
2231   g_return_val_if_fail (dest_val != NULL, FALSE);
2232
2233   if (dest_format == src_format || src_val == -1) {
2234     *dest_val = src_val;
2235     return TRUE;
2236   }
2237
2238   query = gst_query_new_convert (src_format, src_val, dest_format);
2239   ret = gst_element_query (element, query);
2240
2241   if (ret)
2242     gst_query_parse_convert (query, NULL, NULL, NULL, dest_val);
2243
2244   gst_query_unref (query);
2245
2246   return ret;
2247 }
2248
2249 /**
2250  * gst_element_seek_simple:
2251  * @element: a #GstElement to seek on
2252  * @format: a #GstFormat to execute the seek in, such as #GST_FORMAT_TIME
2253  * @seek_flags: seek options; playback applications will usually want to use
2254  *            GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_KEY_UNIT here
2255  * @seek_pos: position to seek to (relative to the start); if you are doing
2256  *            a seek in #GST_FORMAT_TIME this value is in nanoseconds -
2257  *            multiply with #GST_SECOND to convert seconds to nanoseconds or
2258  *            with #GST_MSECOND to convert milliseconds to nanoseconds.
2259  *
2260  * Simple API to perform a seek on the given element, meaning it just seeks
2261  * to the given position relative to the start of the stream. For more complex
2262  * operations like segment seeks (e.g. for looping) or changing the playback
2263  * rate or seeking relative to the last configured playback segment you should
2264  * use gst_element_seek().
2265  *
2266  * In a completely prerolled PAUSED or PLAYING pipeline, seeking is always
2267  * guaranteed to return %TRUE on a seekable media type or %FALSE when the media
2268  * type is certainly not seekable (such as a live stream).
2269  *
2270  * Some elements allow for seeking in the READY state, in this
2271  * case they will store the seek event and execute it when they are put to
2272  * PAUSED. If the element supports seek in READY, it will always return %TRUE when
2273  * it receives the event in the READY state.
2274  *
2275  * Returns: %TRUE if the seek operation succeeded. Flushing seeks will trigger a
2276  * preroll, which will emit %GST_MESSAGE_ASYNC_DONE.
2277  */
2278 gboolean
2279 gst_element_seek_simple (GstElement * element, GstFormat format,
2280     GstSeekFlags seek_flags, gint64 seek_pos)
2281 {
2282   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2283   g_return_val_if_fail (seek_pos >= 0, FALSE);
2284
2285   return gst_element_seek (element, 1.0, format, seek_flags,
2286       GST_SEEK_TYPE_SET, seek_pos, GST_SEEK_TYPE_NONE, 0);
2287 }
2288
2289 /**
2290  * gst_pad_use_fixed_caps:
2291  * @pad: the pad to use
2292  *
2293  * A helper function you can use that sets the FIXED_CAPS flag
2294  * This way the default CAPS query will always return the negotiated caps
2295  * or in case the pad is not negotiated, the padtemplate caps.
2296  *
2297  * The negotiated caps are the caps of the last CAPS event that passed on the
2298  * pad. Use this function on a pad that, once it negotiated to a CAPS, cannot
2299  * be renegotiated to something else.
2300  */
2301 void
2302 gst_pad_use_fixed_caps (GstPad * pad)
2303 {
2304   GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_FIXED_CAPS);
2305 }
2306
2307 /**
2308  * gst_pad_get_parent_element:
2309  * @pad: a pad
2310  *
2311  * Gets the parent of @pad, cast to a #GstElement. If a @pad has no parent or
2312  * its parent is not an element, return NULL.
2313  *
2314  * Returns: (transfer full): the parent of the pad. The caller has a
2315  * reference on the parent, so unref when you're finished with it.
2316  *
2317  * MT safe.
2318  */
2319 GstElement *
2320 gst_pad_get_parent_element (GstPad * pad)
2321 {
2322   GstObject *p;
2323
2324   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2325
2326   p = gst_object_get_parent (GST_OBJECT_CAST (pad));
2327
2328   if (p && !GST_IS_ELEMENT (p)) {
2329     gst_object_unref (p);
2330     p = NULL;
2331   }
2332   return GST_ELEMENT_CAST (p);
2333 }
2334
2335 /**
2336  * gst_object_default_error:
2337  * @source: the #GstObject that initiated the error.
2338  * @error: (in): the GError.
2339  * @debug: (in) (allow-none): an additional debug information string, or NULL
2340  *
2341  * A default error function that uses g_printerr() to display the error message
2342  * and the optional debug sting..
2343  *
2344  * The default handler will simply print the error string using g_print.
2345  */
2346 void
2347 gst_object_default_error (GstObject * source, const GError * error,
2348     const gchar * debug)
2349 {
2350   gchar *name = gst_object_get_path_string (source);
2351
2352   g_printerr (_("ERROR: from element %s: %s\n"), name, error->message);
2353   if (debug)
2354     g_printerr (_("Additional debug info:\n%s\n"), debug);
2355
2356   g_free (name);
2357 }
2358
2359 /**
2360  * gst_bin_add_many:
2361  * @bin: a #GstBin
2362  * @element_1: (transfer full): the #GstElement element to add to the bin
2363  * @...: (transfer full): additional elements to add to the bin
2364  *
2365  * Adds a NULL-terminated list of elements to a bin.  This function is
2366  * equivalent to calling gst_bin_add() for each member of the list. The return
2367  * value of each gst_bin_add() is ignored.
2368  */
2369 void
2370 gst_bin_add_many (GstBin * bin, GstElement * element_1, ...)
2371 {
2372   va_list args;
2373
2374   g_return_if_fail (GST_IS_BIN (bin));
2375   g_return_if_fail (GST_IS_ELEMENT (element_1));
2376
2377   va_start (args, element_1);
2378
2379   while (element_1) {
2380     gst_bin_add (bin, element_1);
2381
2382     element_1 = va_arg (args, GstElement *);
2383   }
2384
2385   va_end (args);
2386 }
2387
2388 /**
2389  * gst_bin_remove_many:
2390  * @bin: a #GstBin
2391  * @element_1: (transfer none): the first #GstElement to remove from the bin
2392  * @...: (transfer none): NULL-terminated list of elements to remove from the bin
2393  *
2394  * Remove a list of elements from a bin. This function is equivalent
2395  * to calling gst_bin_remove() with each member of the list.
2396  */
2397 void
2398 gst_bin_remove_many (GstBin * bin, GstElement * element_1, ...)
2399 {
2400   va_list args;
2401
2402   g_return_if_fail (GST_IS_BIN (bin));
2403   g_return_if_fail (GST_IS_ELEMENT (element_1));
2404
2405   va_start (args, element_1);
2406
2407   while (element_1) {
2408     gst_bin_remove (bin, element_1);
2409
2410     element_1 = va_arg (args, GstElement *);
2411   }
2412
2413   va_end (args);
2414 }
2415
2416 typedef struct
2417 {
2418   GstQuery *query;
2419   gboolean ret;
2420 } QueryAcceptCapsData;
2421
2422 static gboolean
2423 query_accept_caps_func (GstPad * pad, QueryAcceptCapsData * data)
2424 {
2425   if (G_LIKELY (gst_pad_peer_query (pad, data->query))) {
2426     gboolean result;
2427
2428     gst_query_parse_accept_caps_result (data->query, &result);
2429     data->ret &= result;
2430   }
2431   return FALSE;
2432 }
2433
2434 /**
2435  * gst_pad_proxy_query_accept_caps:
2436  * @pad: a #GstPad to proxy.
2437  * @query: an ACCEPT_CAPS #GstQuery.
2438  *
2439  * Checks if all internally linked pads of @pad accepts the caps in @query and
2440  * returns the intersection of the results.
2441  *
2442  * This function is useful as a default accept caps query function for an element
2443  * that can handle any stream format, but requires caps that are acceptable for
2444  * all opposite pads.
2445  *
2446  * Returns: TRUE if @query could be executed
2447  */
2448 gboolean
2449 gst_pad_proxy_query_accept_caps (GstPad * pad, GstQuery * query)
2450 {
2451   QueryAcceptCapsData data;
2452
2453   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2454   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
2455   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS, FALSE);
2456
2457   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
2458       "proxying accept caps query for %s:%s", GST_DEBUG_PAD_NAME (pad));
2459
2460   data.query = query;
2461   /* value to hold the return, by default it holds TRUE */
2462   data.ret = TRUE;
2463
2464   gst_pad_forward (pad, (GstPadForwardFunction) query_accept_caps_func, &data);
2465   gst_query_set_accept_caps_result (query, data.ret);
2466
2467   return TRUE;
2468 }
2469
2470 typedef struct
2471 {
2472   GstQuery *query;
2473   GstCaps *ret;
2474 } QueryCapsData;
2475
2476 static gboolean
2477 query_caps_func (GstPad * pad, QueryCapsData * data)
2478 {
2479   gboolean empty = FALSE;
2480
2481   if (G_LIKELY (gst_pad_peer_query (pad, data->query))) {
2482     GstCaps *peercaps, *intersection;
2483
2484     gst_query_parse_caps_result (data->query, &peercaps);
2485     GST_DEBUG_OBJECT (pad, "intersect with result %" GST_PTR_FORMAT, peercaps);
2486     intersection = gst_caps_intersect (data->ret, peercaps);
2487     GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, intersection);
2488
2489     gst_caps_unref (data->ret);
2490     data->ret = intersection;
2491
2492     /* stop when empty */
2493     empty = gst_caps_is_empty (intersection);
2494   }
2495   return empty;
2496 }
2497
2498 /**
2499  * gst_pad_proxy_query_caps:
2500  * @pad: a #GstPad to proxy.
2501  * @query: a CAPS #GstQuery.
2502  *
2503  * Calls gst_pad_query_caps() for all internally linked pads of @pad and returns
2504  * the intersection of the results.
2505  *
2506  * This function is useful as a default caps query function for an element
2507  * that can handle any stream format, but requires all its pads to have
2508  * the same caps.  Two such elements are tee and adder.
2509  *
2510  * Returns: TRUE if @query could be executed
2511  */
2512 gboolean
2513 gst_pad_proxy_query_caps (GstPad * pad, GstQuery * query)
2514 {
2515   GstCaps *filter, *templ, *result;
2516   QueryCapsData data;
2517
2518   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2519   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
2520   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS, FALSE);
2521
2522   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "proxying caps query for %s:%s",
2523       GST_DEBUG_PAD_NAME (pad));
2524
2525   data.query = query;
2526
2527   /* value to hold the return, by default it holds the filter or ANY */
2528   gst_query_parse_caps (query, &filter);
2529   data.ret = filter ? gst_caps_ref (filter) : gst_caps_new_any ();
2530
2531   gst_pad_forward (pad, (GstPadForwardFunction) query_caps_func, &data);
2532
2533   templ = gst_pad_get_pad_template_caps (pad);
2534   result = gst_caps_intersect (data.ret, templ);
2535   gst_caps_unref (data.ret);
2536   gst_caps_unref (templ);
2537
2538   gst_query_set_caps_result (query, result);
2539   gst_caps_unref (result);
2540
2541   return TRUE;
2542 }
2543
2544 /**
2545  * gst_pad_query_position:
2546  * @pad: a #GstPad to invoke the position query on.
2547  * @format: the #GstFormat requested
2548  * @cur: (out) (allow-none): A location in which to store the current position, or NULL.
2549  *
2550  * Queries a pad for the stream position.
2551  *
2552  * Returns: TRUE if the query could be performed.
2553  */
2554 gboolean
2555 gst_pad_query_position (GstPad * pad, GstFormat format, gint64 * cur)
2556 {
2557   GstQuery *query;
2558   gboolean ret;
2559
2560   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2561   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2562
2563   query = gst_query_new_position (format);
2564   if ((ret = gst_pad_query (pad, query)))
2565     gst_query_parse_position (query, NULL, cur);
2566   gst_query_unref (query);
2567
2568   return ret;
2569 }
2570
2571 /**
2572  * gst_pad_peer_query_position:
2573  * @pad: a #GstPad on whose peer to invoke the position query on.
2574  *       Must be a sink pad.
2575  * @format: the #GstFormat requested
2576  * @cur: (out) (allow-none): a location in which to store the current
2577  *     position, or NULL.
2578  *
2579  * Queries the peer of a given sink pad for the stream position.
2580  *
2581  * Returns: TRUE if the query could be performed.
2582  */
2583 gboolean
2584 gst_pad_peer_query_position (GstPad * pad, GstFormat format, gint64 * cur)
2585 {
2586   GstQuery *query;
2587   gboolean ret = FALSE;
2588
2589   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2590   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2591
2592   query = gst_query_new_position (format);
2593   if ((ret = gst_pad_peer_query (pad, query)))
2594     gst_query_parse_position (query, NULL, cur);
2595   gst_query_unref (query);
2596
2597   return ret;
2598 }
2599
2600 /**
2601  * gst_pad_query_duration:
2602  * @pad: a #GstPad to invoke the duration query on.
2603  * @format: the #GstFormat requested
2604  * @duration: (out) (allow-none): a location in which to store the total
2605  *     duration, or NULL.
2606  *
2607  * Queries a pad for the total stream duration.
2608  *
2609  * Returns: TRUE if the query could be performed.
2610  */
2611 gboolean
2612 gst_pad_query_duration (GstPad * pad, GstFormat format, gint64 * duration)
2613 {
2614   GstQuery *query;
2615   gboolean ret;
2616
2617   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2618   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2619
2620   query = gst_query_new_duration (format);
2621   if ((ret = gst_pad_query (pad, query)))
2622     gst_query_parse_duration (query, NULL, duration);
2623   gst_query_unref (query);
2624
2625   return ret;
2626 }
2627
2628 /**
2629  * gst_pad_peer_query_duration:
2630  * @pad: a #GstPad on whose peer pad to invoke the duration query on.
2631  *       Must be a sink pad.
2632  * @format: the #GstFormat requested
2633  * @duration: (out) (allow-none): a location in which to store the total
2634  *     duration, or NULL.
2635  *
2636  * Queries the peer pad of a given sink pad for the total stream duration.
2637  *
2638  * Returns: TRUE if the query could be performed.
2639  */
2640 gboolean
2641 gst_pad_peer_query_duration (GstPad * pad, GstFormat format, gint64 * duration)
2642 {
2643   GstQuery *query;
2644   gboolean ret = FALSE;
2645
2646   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2647   g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2648   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2649
2650   query = gst_query_new_duration (format);
2651   if ((ret = gst_pad_peer_query (pad, query)))
2652     gst_query_parse_duration (query, NULL, duration);
2653   gst_query_unref (query);
2654
2655   return ret;
2656 }
2657
2658 /**
2659  * gst_pad_query_convert:
2660  * @pad: a #GstPad to invoke the convert query on.
2661  * @src_format: a #GstFormat to convert from.
2662  * @src_val: a value to convert.
2663  * @dest_format: the #GstFormat to convert to.
2664  * @dest_val: (out): a pointer to the result.
2665  *
2666  * Queries a pad to convert @src_val in @src_format to @dest_format.
2667  *
2668  * Returns: TRUE if the query could be performed.
2669  */
2670 gboolean
2671 gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2672     GstFormat dest_format, gint64 * dest_val)
2673 {
2674   GstQuery *query;
2675   gboolean ret;
2676
2677   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2678   g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
2679   g_return_val_if_fail (dest_val != NULL, FALSE);
2680
2681   if (dest_format == src_format || src_val == -1) {
2682     *dest_val = src_val;
2683     return TRUE;
2684   }
2685
2686   query = gst_query_new_convert (src_format, src_val, dest_format);
2687   if ((ret = gst_pad_query (pad, query)))
2688     gst_query_parse_convert (query, NULL, NULL, NULL, dest_val);
2689   gst_query_unref (query);
2690
2691   return ret;
2692 }
2693
2694 /**
2695  * gst_pad_peer_query_convert:
2696  * @pad: a #GstPad, on whose peer pad to invoke the convert query on.
2697  *       Must be a sink pad.
2698  * @src_format: a #GstFormat to convert from.
2699  * @src_val: a value to convert.
2700  * @dest_format: the #GstFormat to convert to.
2701  * @dest_val: (out): a pointer to the result.
2702  *
2703  * Queries the peer pad of a given sink pad to convert @src_val in @src_format
2704  * to @dest_format.
2705  *
2706  * Returns: TRUE if the query could be performed.
2707  */
2708 gboolean
2709 gst_pad_peer_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2710     GstFormat dest_format, gint64 * dest_val)
2711 {
2712   GstQuery *query;
2713   gboolean ret = FALSE;
2714
2715   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2716   g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2717   g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
2718   g_return_val_if_fail (dest_val != NULL, FALSE);
2719
2720   query = gst_query_new_convert (src_format, src_val, dest_format);
2721   if ((ret = gst_pad_peer_query (pad, query)))
2722     gst_query_parse_convert (query, NULL, NULL, NULL, dest_val);
2723   gst_query_unref (query);
2724
2725   return ret;
2726 }
2727
2728 /**
2729  * gst_pad_query_caps:
2730  * @pad: a  #GstPad to get the capabilities of.
2731  * @filter: (allow-none): suggested #GstCaps, or NULL
2732  *
2733  * Gets the capabilities this pad can produce or consume.
2734  * Note that this method doesn't necessarily return the caps set by sending a
2735  * gst_event_new_caps() - use gst_pad_get_current_caps() for that instead.
2736  * gst_pad_query_caps returns all possible caps a pad can operate with, using
2737  * the pad's CAPS query function, If the query fails, this function will return
2738  * @filter, if not #NULL, otherwise ANY.
2739  *
2740  * When called on sinkpads @filter contains the caps that
2741  * upstream could produce in the order preferred by upstream. When
2742  * called on srcpads @filter contains the caps accepted by
2743  * downstream in the preferred order. @filter might be %NULL but
2744  * if it is not %NULL the returned caps will be a subset of @filter.
2745  *
2746  * Note that this function does not return writable #GstCaps, use
2747  * gst_caps_make_writable() before modifying the caps.
2748  *
2749  * Returns: (transfer full): the caps of the pad with incremented ref-count.
2750  */
2751 GstCaps *
2752 gst_pad_query_caps (GstPad * pad, GstCaps * filter)
2753 {
2754   GstCaps *result = NULL;
2755   GstQuery *query;
2756
2757   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2758   g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), NULL);
2759
2760   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2761       "get pad caps with filter %" GST_PTR_FORMAT, filter);
2762
2763   query = gst_query_new_caps (filter);
2764   if (gst_pad_query (pad, query)) {
2765     gst_query_parse_caps_result (query, &result);
2766     gst_caps_ref (result);
2767     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2768         "query returned %" GST_PTR_FORMAT, result);
2769   } else if (filter) {
2770     result = gst_caps_ref (filter);
2771   } else {
2772     result = gst_caps_new_any ();
2773   }
2774   gst_query_unref (query);
2775
2776   return result;
2777 }
2778
2779 /**
2780  * gst_pad_peer_query_caps:
2781  * @pad: a  #GstPad to get the capabilities of.
2782  * @filter: (allow-none): a #GstCaps filter, or NULL.
2783  *
2784  * Gets the capabilities of the peer connected to this pad. Similar to
2785  * gst_pad_query_caps().
2786  *
2787  * When called on srcpads @filter contains the caps that
2788  * upstream could produce in the order preferred by upstream. When
2789  * called on sinkpads @filter contains the caps accepted by
2790  * downstream in the preferred order. @filter might be %NULL but
2791  * if it is not %NULL the returned caps will be a subset of @filter.
2792  *
2793  * Returns: the caps of the peer pad with incremented ref-count. When there is
2794  * no peer pad, this function returns @filter or, when @filter is %NULL, ANY
2795  * caps.
2796  */
2797 GstCaps *
2798 gst_pad_peer_query_caps (GstPad * pad, GstCaps * filter)
2799 {
2800   GstCaps *result = NULL;
2801   GstQuery *query;
2802
2803   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2804   g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), NULL);
2805
2806   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2807       "get pad peer caps with filter %" GST_PTR_FORMAT, filter);
2808
2809   query = gst_query_new_caps (filter);
2810   if (gst_pad_peer_query (pad, query)) {
2811     gst_query_parse_caps_result (query, &result);
2812     gst_caps_ref (result);
2813     GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad,
2814         "peer query returned %" GST_PTR_FORMAT, result);
2815   } else if (filter) {
2816     result = gst_caps_ref (filter);
2817   } else {
2818     result = gst_caps_new_any ();
2819   }
2820   gst_query_unref (query);
2821
2822   return result;
2823 }
2824
2825 /**
2826  * gst_pad_query_accept_caps:
2827  * @pad: a #GstPad to check
2828  * @caps: a #GstCaps to check on the pad
2829  *
2830  * Check if the given pad accepts the caps.
2831  *
2832  * Returns: TRUE if the pad can accept the caps.
2833  */
2834 gboolean
2835 gst_pad_query_accept_caps (GstPad * pad, GstCaps * caps)
2836 {
2837   gboolean res = TRUE;
2838   GstQuery *query;
2839
2840   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2841   g_return_val_if_fail (GST_IS_CAPS (caps), FALSE);
2842
2843   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "accept caps of %"
2844       GST_PTR_FORMAT, caps);
2845
2846   query = gst_query_new_accept_caps (caps);
2847   if (gst_pad_query (pad, query)) {
2848     gst_query_parse_accept_caps_result (query, &res);
2849     GST_DEBUG_OBJECT (pad, "query returned %d", res);
2850   }
2851   gst_query_unref (query);
2852
2853   return res;
2854 }
2855
2856 /**
2857  * gst_pad_peer_query_accept_caps:
2858  * @pad: a  #GstPad to check the peer of
2859  * @caps: a #GstCaps to check on the pad
2860  *
2861  * Check if the peer of @pad accepts @caps. If @pad has no peer, this function
2862  * returns TRUE.
2863  *
2864  * Returns: TRUE if the peer of @pad can accept the caps or @pad has no peer.
2865  */
2866 gboolean
2867 gst_pad_peer_query_accept_caps (GstPad * pad, GstCaps * caps)
2868 {
2869   gboolean res = TRUE;
2870   GstQuery *query;
2871
2872   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2873   g_return_val_if_fail (GST_IS_CAPS (caps), FALSE);
2874
2875   query = gst_query_new_accept_caps (caps);
2876   if (gst_pad_peer_query (pad, query)) {
2877     gst_query_parse_accept_caps_result (query, &res);
2878     GST_DEBUG_OBJECT (pad, "query returned %d", res);
2879   }
2880   gst_query_unref (query);
2881
2882   return res;
2883 }
2884
2885 static GstPad *
2886 element_find_unlinked_pad (GstElement * element, GstPadDirection direction)
2887 {
2888   GstIterator *iter;
2889   GstPad *unlinked_pad = NULL;
2890   gboolean done;
2891   GValue data = { 0, };
2892
2893   switch (direction) {
2894     case GST_PAD_SRC:
2895       iter = gst_element_iterate_src_pads (element);
2896       break;
2897     case GST_PAD_SINK:
2898       iter = gst_element_iterate_sink_pads (element);
2899       break;
2900     default:
2901       g_return_val_if_reached (NULL);
2902   }
2903
2904   done = FALSE;
2905   while (!done) {
2906     switch (gst_iterator_next (iter, &data)) {
2907       case GST_ITERATOR_OK:{
2908         GstPad *peer;
2909         GstPad *pad = g_value_get_object (&data);
2910
2911         GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
2912             GST_DEBUG_PAD_NAME (pad));
2913
2914         peer = gst_pad_get_peer (pad);
2915         if (peer == NULL) {
2916           unlinked_pad = gst_object_ref (pad);
2917           done = TRUE;
2918           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
2919               "found existing unlinked pad %s:%s",
2920               GST_DEBUG_PAD_NAME (unlinked_pad));
2921         } else {
2922           gst_object_unref (peer);
2923         }
2924         g_value_reset (&data);
2925         break;
2926       }
2927       case GST_ITERATOR_DONE:
2928         done = TRUE;
2929         break;
2930       case GST_ITERATOR_RESYNC:
2931         gst_iterator_resync (iter);
2932         break;
2933       case GST_ITERATOR_ERROR:
2934         g_return_val_if_reached (NULL);
2935         break;
2936     }
2937   }
2938   g_value_unset (&data);
2939   gst_iterator_free (iter);
2940
2941   return unlinked_pad;
2942 }
2943
2944 /**
2945  * gst_bin_find_unlinked_pad:
2946  * @bin: bin in which to look for elements with unlinked pads
2947  * @direction: whether to look for an unlinked source or sink pad
2948  *
2949  * Recursively looks for elements with an unlinked pad of the given
2950  * direction within the specified bin and returns an unlinked pad
2951  * if one is found, or NULL otherwise. If a pad is found, the caller
2952  * owns a reference to it and should use gst_object_unref() on the
2953  * pad when it is not needed any longer.
2954  *
2955  * Returns: (transfer full): unlinked pad of the given direction, or NULL.
2956  */
2957 GstPad *
2958 gst_bin_find_unlinked_pad (GstBin * bin, GstPadDirection direction)
2959 {
2960   GstIterator *iter;
2961   gboolean done;
2962   GstPad *pad = NULL;
2963   GValue data = { 0, };
2964
2965   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
2966   g_return_val_if_fail (direction != GST_PAD_UNKNOWN, NULL);
2967
2968   done = FALSE;
2969   iter = gst_bin_iterate_recurse (bin);
2970   while (!done) {
2971     switch (gst_iterator_next (iter, &data)) {
2972       case GST_ITERATOR_OK:{
2973         GstElement *element = g_value_get_object (&data);
2974
2975         pad = element_find_unlinked_pad (element, direction);
2976         if (pad != NULL)
2977           done = TRUE;
2978         g_value_reset (&data);
2979         break;
2980       }
2981       case GST_ITERATOR_DONE:
2982         done = TRUE;
2983         break;
2984       case GST_ITERATOR_RESYNC:
2985         gst_iterator_resync (iter);
2986         break;
2987       case GST_ITERATOR_ERROR:
2988         g_return_val_if_reached (NULL);
2989         break;
2990     }
2991   }
2992   g_value_unset (&data);
2993   gst_iterator_free (iter);
2994
2995   return pad;
2996 }
2997
2998 /**
2999  * gst_parse_bin_from_description:
3000  * @bin_description: command line describing the bin
3001  * @ghost_unlinked_pads: whether to automatically create ghost pads
3002  *     for unlinked source or sink pads within the bin
3003  * @err: where to store the error message in case of an error, or NULL
3004  *
3005  * This is a convenience wrapper around gst_parse_launch() to create a
3006  * #GstBin from a gst-launch-style pipeline description. See
3007  * gst_parse_launch() and the gst-launch man page for details about the
3008  * syntax. Ghost pads on the bin for unlinked source or sink pads
3009  * within the bin can automatically be created (but only a maximum of
3010  * one ghost pad for each direction will be created; if you expect
3011  * multiple unlinked source pads or multiple unlinked sink pads
3012  * and want them all ghosted, you will have to create the ghost pads
3013  * yourself).
3014  *
3015  * Returns: (transfer floating) (type Gst.Bin): a newly-created bin,
3016  *   or %NULL if an error occurred.
3017  */
3018 GstElement *
3019 gst_parse_bin_from_description (const gchar * bin_description,
3020     gboolean ghost_unlinked_pads, GError ** err)
3021 {
3022   return gst_parse_bin_from_description_full (bin_description,
3023       ghost_unlinked_pads, NULL, GST_PARSE_FLAG_NONE, err);
3024 }
3025
3026 /**
3027  * gst_parse_bin_from_description_full:
3028  * @bin_description: command line describing the bin
3029  * @ghost_unlinked_pads: whether to automatically create ghost pads
3030  *     for unlinked source or sink pads within the bin
3031  * @context: (transfer none) (allow-none): a parse context allocated with
3032  *     gst_parse_context_new(), or %NULL
3033  * @flags: parsing options, or #GST_PARSE_FLAG_NONE
3034  * @err: where to store the error message in case of an error, or NULL
3035  *
3036  * This is a convenience wrapper around gst_parse_launch() to create a
3037  * #GstBin from a gst-launch-style pipeline description. See
3038  * gst_parse_launch() and the gst-launch man page for details about the
3039  * syntax. Ghost pads on the bin for unlinked source or sink pads
3040  * within the bin can automatically be created (but only a maximum of
3041  * one ghost pad for each direction will be created; if you expect
3042  * multiple unlinked source pads or multiple unlinked sink pads
3043  * and want them all ghosted, you will have to create the ghost pads
3044  * yourself).
3045  *
3046  * Returns: (transfer full) (type Gst.Element): a newly-created element, which
3047  *   is guaranteed to be a bin unless GST_FLAG_NO_SINGLE_ELEMENT_BINS was
3048  *   passed, or %NULL if an error occurred.
3049  */
3050 GstElement *
3051 gst_parse_bin_from_description_full (const gchar * bin_description,
3052     gboolean ghost_unlinked_pads, GstParseContext * context,
3053     GstParseFlags flags, GError ** err)
3054 {
3055 #ifndef GST_DISABLE_PARSE
3056   GstPad *pad = NULL;
3057   GstElement *element;
3058   GstBin *bin;
3059   gchar *desc;
3060
3061   g_return_val_if_fail (bin_description != NULL, NULL);
3062   g_return_val_if_fail (err == NULL || *err == NULL, NULL);
3063
3064   GST_DEBUG ("Making bin from description '%s'", bin_description);
3065
3066   /* parse the pipeline to a bin */
3067   if (flags & GST_PARSE_FLAG_NO_SINGLE_ELEMENT_BINS) {
3068     element = gst_parse_launch_full (bin_description, context, flags, err);
3069   } else {
3070     desc = g_strdup_printf ("bin.( %s )", bin_description);
3071     element = gst_parse_launch_full (desc, context, flags, err);
3072     g_free (desc);
3073   }
3074
3075   if (element == NULL || (err && *err != NULL)) {
3076     if (element)
3077       gst_object_unref (element);
3078     return NULL;
3079   }
3080
3081   if (GST_IS_BIN (element)) {
3082     bin = GST_BIN (element);
3083   } else {
3084     return element;
3085   }
3086
3087   /* find pads and ghost them if necessary */
3088   if (ghost_unlinked_pads) {
3089     if ((pad = gst_bin_find_unlinked_pad (bin, GST_PAD_SRC))) {
3090       gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("src", pad));
3091       gst_object_unref (pad);
3092     }
3093     if ((pad = gst_bin_find_unlinked_pad (bin, GST_PAD_SINK))) {
3094       gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("sink", pad));
3095       gst_object_unref (pad);
3096     }
3097   }
3098
3099   return GST_ELEMENT (bin);
3100 #else
3101   gchar *msg;
3102
3103   GST_WARNING ("Disabled API called");
3104
3105   msg = gst_error_get_message (GST_CORE_ERROR, GST_CORE_ERROR_DISABLED);
3106   g_set_error (err, GST_CORE_ERROR, GST_CORE_ERROR_DISABLED, "%s", msg);
3107   g_free (msg);
3108
3109   return NULL;
3110 #endif
3111 }
3112
3113 /**
3114  * gst_util_get_timestamp:
3115  *
3116  * Get a timestamp as GstClockTime to be used for interval measurements.
3117  * The timestamp should not be interpreted in any other way.
3118  *
3119  * Returns: the timestamp
3120  */
3121 GstClockTime
3122 gst_util_get_timestamp (void)
3123 {
3124 #if defined (HAVE_POSIX_TIMERS) && defined(HAVE_MONOTONIC_CLOCK) &&\
3125     defined (HAVE_CLOCK_GETTIME)
3126   struct timespec now;
3127
3128   clock_gettime (CLOCK_MONOTONIC, &now);
3129   return GST_TIMESPEC_TO_TIME (now);
3130 #else
3131   GTimeVal now;
3132
3133   g_get_current_time (&now);
3134   return GST_TIMEVAL_TO_TIME (now);
3135 #endif
3136 }
3137
3138 /**
3139  * gst_util_array_binary_search:
3140  * @array: the sorted input array
3141  * @num_elements: number of elements in the array
3142  * @element_size: size of every element in bytes
3143  * @search_func: (scope call): function to compare two elements, @search_data will always be passed as second argument
3144  * @mode: search mode that should be used
3145  * @search_data: element that should be found
3146  * @user_data: (closure): data to pass to @search_func
3147  *
3148  * Searches inside @array for @search_data by using the comparison function
3149  * @search_func. @array must be sorted ascending.
3150  *
3151  * As @search_data is always passed as second argument to @search_func it's
3152  * not required that @search_data has the same type as the array elements.
3153  *
3154  * The complexity of this search function is O(log (num_elements)).
3155  *
3156  * Returns: (transfer none): The address of the found element or %NULL if nothing was found
3157  */
3158 gpointer
3159 gst_util_array_binary_search (gpointer array, guint num_elements,
3160     gsize element_size, GCompareDataFunc search_func, GstSearchMode mode,
3161     gconstpointer search_data, gpointer user_data)
3162 {
3163   glong left = 0, right = num_elements - 1, m;
3164   gint ret;
3165   guint8 *data = (guint8 *) array;
3166
3167   g_return_val_if_fail (array != NULL, NULL);
3168   g_return_val_if_fail (element_size > 0, NULL);
3169   g_return_val_if_fail (search_func != NULL, NULL);
3170
3171   /* 0. No elements => return NULL */
3172   if (num_elements == 0)
3173     return NULL;
3174
3175   /* 1. If search_data is before the 0th element return the 0th element */
3176   ret = search_func (data, search_data, user_data);
3177   if ((ret >= 0 && mode == GST_SEARCH_MODE_AFTER) || ret == 0)
3178     return data;
3179   else if (ret > 0)
3180     return NULL;
3181
3182   /* 2. If search_data is after the last element return the last element */
3183   ret =
3184       search_func (data + (num_elements - 1) * element_size, search_data,
3185       user_data);
3186   if ((ret <= 0 && mode == GST_SEARCH_MODE_BEFORE) || ret == 0)
3187     return data + (num_elements - 1) * element_size;
3188   else if (ret < 0)
3189     return NULL;
3190
3191   /* 3. else binary search */
3192   while (TRUE) {
3193     m = left + (right - left) / 2;
3194
3195     ret = search_func (data + m * element_size, search_data, user_data);
3196
3197     if (ret == 0) {
3198       return data + m * element_size;
3199     } else if (ret < 0) {
3200       left = m + 1;
3201     } else {
3202       right = m - 1;
3203     }
3204
3205     /* No exact match found */
3206     if (right < left) {
3207       if (mode == GST_SEARCH_MODE_EXACT) {
3208         return NULL;
3209       } else if (mode == GST_SEARCH_MODE_AFTER) {
3210         if (ret < 0)
3211           return (m < num_elements) ? data + (m + 1) * element_size : NULL;
3212         else
3213           return data + m * element_size;
3214       } else {
3215         if (ret < 0)
3216           return data + m * element_size;
3217         else
3218           return (m > 0) ? data + (m - 1) * element_size : NULL;
3219       }
3220     }
3221   }
3222 }
3223
3224 /* Finds the greatest common divisor.
3225  * Returns 1 if none other found.
3226  * This is Euclid's algorithm. */
3227
3228 /**
3229  * gst_util_greatest_common_divisor:
3230  * @a: First value as #gint
3231  * @b: Second value as #gint
3232  *
3233  * Calculates the greatest common divisor of @a
3234  * and @b.
3235  *
3236  * Returns: Greatest common divisor of @a and @b
3237  */
3238 gint
3239 gst_util_greatest_common_divisor (gint a, gint b)
3240 {
3241   while (b != 0) {
3242     int temp = a;
3243
3244     a = b;
3245     b = temp % b;
3246   }
3247
3248   return ABS (a);
3249 }
3250
3251 /**
3252  * gst_util_greatest_common_divisor_int64:
3253  * @a: First value as #gint64
3254  * @b: Second value as #gint64
3255  *
3256  * Calculates the greatest common divisor of @a
3257  * and @b.
3258  *
3259  * Returns: Greatest common divisor of @a and @b
3260  */
3261 gint64
3262 gst_util_greatest_common_divisor_int64 (gint64 a, gint64 b)
3263 {
3264   while (b != 0) {
3265     gint64 temp = a;
3266
3267     a = b;
3268     b = temp % b;
3269   }
3270
3271   return ABS (a);
3272 }
3273
3274
3275 /**
3276  * gst_util_fraction_to_double:
3277  * @src_n: Fraction numerator as #gint
3278  * @src_d: Fraction denominator #gint
3279  * @dest: (out): pointer to a #gdouble for the result
3280  *
3281  * Transforms a fraction to a #gdouble.
3282  */
3283 void
3284 gst_util_fraction_to_double (gint src_n, gint src_d, gdouble * dest)
3285 {
3286   g_return_if_fail (dest != NULL);
3287   g_return_if_fail (src_d != 0);
3288
3289   *dest = ((gdouble) src_n) / ((gdouble) src_d);
3290 }
3291
3292 #define MAX_TERMS       30
3293 #define MIN_DIVISOR     1.0e-10
3294 #define MAX_ERROR       1.0e-20
3295
3296 /* use continued fractions to transform a double into a fraction,
3297  * see http://mathforum.org/dr.math/faq/faq.fractions.html#decfrac.
3298  * This algorithm takes care of overflows.
3299  */
3300
3301 /**
3302  * gst_util_double_to_fraction:
3303  * @src: #gdouble to transform
3304  * @dest_n: (out): pointer to a #gint to hold the result numerator
3305  * @dest_d: (out): pointer to a #gint to hold the result denominator
3306  *
3307  * Transforms a #gdouble to a fraction and simplifies
3308  * the result.
3309  */
3310 void
3311 gst_util_double_to_fraction (gdouble src, gint * dest_n, gint * dest_d)
3312 {
3313
3314   gdouble V, F;                 /* double being converted */
3315   gint N, D;                    /* will contain the result */
3316   gint A;                       /* current term in continued fraction */
3317   gint64 N1, D1;                /* numerator, denominator of last approx */
3318   gint64 N2, D2;                /* numerator, denominator of previous approx */
3319   gint i;
3320   gint gcd;
3321   gboolean negative = FALSE;
3322
3323   g_return_if_fail (dest_n != NULL);
3324   g_return_if_fail (dest_d != NULL);
3325
3326   /* initialize fraction being converted */
3327   F = src;
3328   if (F < 0.0) {
3329     F = -F;
3330     negative = TRUE;
3331   }
3332
3333   V = F;
3334   /* initialize fractions with 1/0, 0/1 */
3335   N1 = 1;
3336   D1 = 0;
3337   N2 = 0;
3338   D2 = 1;
3339   N = 1;
3340   D = 1;
3341
3342   for (i = 0; i < MAX_TERMS; i++) {
3343     /* get next term */
3344     A = (gint) F;               /* no floor() needed, F is always >= 0 */
3345     /* get new divisor */
3346     F = F - A;
3347
3348     /* calculate new fraction in temp */
3349     N2 = N1 * A + N2;
3350     D2 = D1 * A + D2;
3351
3352     /* guard against overflow */
3353     if (N2 > G_MAXINT || D2 > G_MAXINT) {
3354       break;
3355     }
3356
3357     N = N2;
3358     D = D2;
3359
3360     /* save last two fractions */
3361     N2 = N1;
3362     D2 = D1;
3363     N1 = N;
3364     D1 = D;
3365
3366     /* quit if dividing by zero or close enough to target */
3367     if (F < MIN_DIVISOR || fabs (V - ((gdouble) N) / D) < MAX_ERROR) {
3368       break;
3369     }
3370
3371     /* Take reciprocal */
3372     F = 1 / F;
3373   }
3374   /* fix for overflow */
3375   if (D == 0) {
3376     N = G_MAXINT;
3377     D = 1;
3378   }
3379   /* fix for negative */
3380   if (negative)
3381     N = -N;
3382
3383   /* simplify */
3384   gcd = gst_util_greatest_common_divisor (N, D);
3385   if (gcd) {
3386     N /= gcd;
3387     D /= gcd;
3388   }
3389
3390   /* set results */
3391   *dest_n = N;
3392   *dest_d = D;
3393 }
3394
3395 /**
3396  * gst_util_fraction_multiply:
3397  * @a_n: Numerator of first value
3398  * @a_d: Denominator of first value
3399  * @b_n: Numerator of second value
3400  * @b_d: Denominator of second value
3401  * @res_n: (out): Pointer to #gint to hold the result numerator
3402  * @res_d: (out): Pointer to #gint to hold the result denominator
3403  *
3404  * Multiplies the fractions @a_n/@a_d and @b_n/@b_d and stores
3405  * the result in @res_n and @res_d.
3406  *
3407  * Returns: %FALSE on overflow, %TRUE otherwise.
3408  */
3409 gboolean
3410 gst_util_fraction_multiply (gint a_n, gint a_d, gint b_n, gint b_d,
3411     gint * res_n, gint * res_d)
3412 {
3413   gint gcd;
3414
3415   g_return_val_if_fail (res_n != NULL, FALSE);
3416   g_return_val_if_fail (res_d != NULL, FALSE);
3417   g_return_val_if_fail (a_d != 0, FALSE);
3418   g_return_val_if_fail (b_d != 0, FALSE);
3419
3420   gcd = gst_util_greatest_common_divisor (a_n, a_d);
3421   a_n /= gcd;
3422   a_d /= gcd;
3423
3424   gcd = gst_util_greatest_common_divisor (b_n, b_d);
3425   b_n /= gcd;
3426   b_d /= gcd;
3427
3428   gcd = gst_util_greatest_common_divisor (a_n, b_d);
3429   a_n /= gcd;
3430   b_d /= gcd;
3431
3432   gcd = gst_util_greatest_common_divisor (a_d, b_n);
3433   a_d /= gcd;
3434   b_n /= gcd;
3435
3436   /* This would result in overflow */
3437   if (a_n != 0 && G_MAXINT / ABS (a_n) < ABS (b_n))
3438     return FALSE;
3439   if (G_MAXINT / ABS (a_d) < ABS (b_d))
3440     return FALSE;
3441
3442   *res_n = a_n * b_n;
3443   *res_d = a_d * b_d;
3444
3445   gcd = gst_util_greatest_common_divisor (*res_n, *res_d);
3446   *res_n /= gcd;
3447   *res_d /= gcd;
3448
3449   return TRUE;
3450 }
3451
3452 /**
3453  * gst_util_fraction_add:
3454  * @a_n: Numerator of first value
3455  * @a_d: Denominator of first value
3456  * @b_n: Numerator of second value
3457  * @b_d: Denominator of second value
3458  * @res_n: (out): Pointer to #gint to hold the result numerator
3459  * @res_d: (out): Pointer to #gint to hold the result denominator
3460  *
3461  * Adds the fractions @a_n/@a_d and @b_n/@b_d and stores
3462  * the result in @res_n and @res_d.
3463  *
3464  * Returns: %FALSE on overflow, %TRUE otherwise.
3465  */
3466 gboolean
3467 gst_util_fraction_add (gint a_n, gint a_d, gint b_n, gint b_d, gint * res_n,
3468     gint * res_d)
3469 {
3470   gint gcd;
3471
3472   g_return_val_if_fail (res_n != NULL, FALSE);
3473   g_return_val_if_fail (res_d != NULL, FALSE);
3474   g_return_val_if_fail (a_d != 0, FALSE);
3475   g_return_val_if_fail (b_d != 0, FALSE);
3476
3477   gcd = gst_util_greatest_common_divisor (a_n, a_d);
3478   a_n /= gcd;
3479   a_d /= gcd;
3480
3481   gcd = gst_util_greatest_common_divisor (b_n, b_d);
3482   b_n /= gcd;
3483   b_d /= gcd;
3484
3485   if (a_n == 0) {
3486     *res_n = b_n;
3487     *res_d = b_d;
3488     return TRUE;
3489   }
3490   if (b_n == 0) {
3491     *res_n = a_n;
3492     *res_d = a_d;
3493     return TRUE;
3494   }
3495
3496   /* This would result in overflow */
3497   if (G_MAXINT / ABS (a_n) < ABS (b_n))
3498     return FALSE;
3499   if (G_MAXINT / ABS (a_d) < ABS (b_d))
3500     return FALSE;
3501   if (G_MAXINT / ABS (a_d) < ABS (b_d))
3502     return FALSE;
3503
3504   *res_n = (a_n * b_d) + (a_d * b_n);
3505   *res_d = a_d * b_d;
3506
3507   gcd = gst_util_greatest_common_divisor (*res_n, *res_d);
3508   if (gcd) {
3509     *res_n /= gcd;
3510     *res_d /= gcd;
3511   } else {
3512     /* res_n == 0 */
3513     *res_d = 1;
3514   }
3515
3516   return TRUE;
3517 }
3518
3519 /**
3520  * gst_util_fraction_compare:
3521  * @a_n: Numerator of first value
3522  * @a_d: Denominator of first value
3523  * @b_n: Numerator of second value
3524  * @b_d: Denominator of second value
3525  *
3526  * Compares the fractions @a_n/@a_d and @b_n/@b_d and returns
3527  * -1 if a < b, 0 if a = b and 1 if a > b.
3528  *
3529  * Returns: -1 if a < b; 0 if a = b; 1 if a > b.
3530  */
3531 gint
3532 gst_util_fraction_compare (gint a_n, gint a_d, gint b_n, gint b_d)
3533 {
3534   gint64 new_num_1;
3535   gint64 new_num_2;
3536   gint gcd;
3537
3538   g_return_val_if_fail (a_d != 0 && b_d != 0, 0);
3539
3540   /* Simplify */
3541   gcd = gst_util_greatest_common_divisor (a_n, a_d);
3542   a_n /= gcd;
3543   a_d /= gcd;
3544
3545   gcd = gst_util_greatest_common_divisor (b_n, b_d);
3546   b_n /= gcd;
3547   b_d /= gcd;
3548
3549   /* fractions are reduced when set, so we can quickly see if they're equal */
3550   if (a_n == b_n && a_d == b_d)
3551     return 0;
3552
3553   /* extend to 64 bits */
3554   new_num_1 = ((gint64) a_n) * b_d;
3555   new_num_2 = ((gint64) b_n) * a_d;
3556   if (new_num_1 < new_num_2)
3557     return -1;
3558   if (new_num_1 > new_num_2)
3559     return 1;
3560
3561   /* Should not happen because a_d and b_d are not 0 */
3562   g_return_val_if_reached (0);
3563 }
3564
3565 static gchar *
3566 gst_pad_create_stream_id_internal (GstPad * pad, GstElement * parent,
3567     const gchar * stream_id)
3568 {
3569   GstEvent *upstream_event;
3570   gchar *upstream_stream_id = NULL, *new_stream_id;
3571   GstPad *sinkpad;
3572
3573   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
3574   g_return_val_if_fail (GST_PAD_IS_SRC (pad), NULL);
3575   g_return_val_if_fail (GST_IS_ELEMENT (parent), NULL);
3576
3577   g_return_val_if_fail (parent->numsinkpads <= 1, NULL);
3578
3579   /* If the element has multiple source pads it must
3580    * provide a stream-id for every source pad, otherwise
3581    * all source pads will have the same and are not
3582    * distinguishable */
3583   g_return_val_if_fail (parent->numsrcpads <= 1 || stream_id, NULL);
3584
3585   /* First try to get the upstream stream-start stream-id from the sinkpad.
3586    * This will only work for non-source elements */
3587   sinkpad = gst_element_get_static_pad (parent, "sink");
3588   if (sinkpad) {
3589     upstream_event =
3590         gst_pad_get_sticky_event (sinkpad, GST_EVENT_STREAM_START, 0);
3591     if (upstream_event) {
3592       const gchar *tmp;
3593
3594       gst_event_parse_stream_start (upstream_event, &tmp);
3595       if (tmp)
3596         upstream_stream_id = g_strdup (tmp);
3597       gst_event_unref (upstream_event);
3598     }
3599     gst_object_unref (sinkpad);
3600   }
3601
3602   /* The only case where we don't have an upstream start-start event
3603    * here is for source elements */
3604   if (!upstream_stream_id) {
3605     GstQuery *query;
3606
3607     /* Try to generate one from the URI query and
3608      * if it fails take a random number instead */
3609     query = gst_query_new_uri ();
3610     if (gst_element_query (parent, query)) {
3611       GChecksum *cs;
3612       gchar *uri;
3613
3614       gst_query_parse_uri (query, &uri);
3615
3616       /* And then generate an SHA256 sum of the URI */
3617       cs = g_checksum_new (G_CHECKSUM_SHA256);
3618       g_checksum_update (cs, (const guchar *) uri, strlen (uri));
3619       g_free (uri);
3620       upstream_stream_id = g_strdup (g_checksum_get_string (cs));
3621       g_checksum_free (cs);
3622     } else {
3623       /* Just get some random number if the URI query fails */
3624       GST_FIXME_OBJECT (pad, "Creating random stream-id, consider "
3625           "implementing a deterministic way of creating a stream-id");
3626       upstream_stream_id =
3627           g_strdup_printf ("%08x%08x%08x%08x", g_random_int (), g_random_int (),
3628           g_random_int (), g_random_int ());
3629     }
3630
3631     gst_query_unref (query);
3632   }
3633
3634   if (stream_id) {
3635     new_stream_id = g_strconcat (upstream_stream_id, "/", stream_id, NULL);
3636   } else {
3637     new_stream_id = g_strdup (upstream_stream_id);
3638   }
3639
3640   g_free (upstream_stream_id);
3641
3642   return new_stream_id;
3643 }
3644
3645 /**
3646  * gst_pad_create_stream_id_printf_valist:
3647  * @pad: A source #GstPad
3648  * @parent: Parent #GstElement of @pad
3649  * @stream_id: (allow-none): The stream-id
3650  * @var_args: parameters for the @stream_id format string
3651  *
3652  * Creates a stream-id for the source #GstPad @pad by combining the
3653  * upstream information with the optional @stream_id of the stream
3654  * of @pad. @pad must have a parent #GstElement and which must have zero
3655  * or one sinkpad. @stream_id can only be %NULL if the parent element
3656  * of @pad has only a single source pad.
3657  *
3658  * This function generates an unique stream-id by getting the upstream
3659  * stream-start event stream ID and appending @stream_id to it. If the
3660  * element has no sinkpad it will generate an upstream stream-id by
3661  * doing an URI query on the element and in the worst case just uses
3662  * a random number. Source elements that don't implement the URI
3663  * handler interface should ideally generate a unique, deterministic
3664  * stream-id manually instead.
3665  *
3666  * Returns: A stream-id for @pad. g_free() after usage.
3667  */
3668 gchar *
3669 gst_pad_create_stream_id_printf_valist (GstPad * pad, GstElement * parent,
3670     const gchar * stream_id, va_list var_args)
3671 {
3672   gchar *expanded = NULL, *new_stream_id;
3673
3674   if (stream_id)
3675     expanded = g_strdup_vprintf (stream_id, var_args);
3676
3677   new_stream_id = gst_pad_create_stream_id_internal (pad, parent, expanded);
3678
3679   g_free (expanded);
3680
3681   return new_stream_id;
3682 }
3683
3684 /**
3685  * gst_pad_create_stream_id_printf:
3686  * @pad: A source #GstPad
3687  * @parent: Parent #GstElement of @pad
3688  * @stream_id: (allow-none): The stream-id
3689  * @...: parameters for the @stream_id format string
3690  *
3691  * Creates a stream-id for the source #GstPad @pad by combining the
3692  * upstream information with the optional @stream_id of the stream
3693  * of @pad. @pad must have a parent #GstElement and which must have zero
3694  * or one sinkpad. @stream_id can only be %NULL if the parent element
3695  * of @pad has only a single source pad.
3696  *
3697  * This function generates an unique stream-id by getting the upstream
3698  * stream-start event stream ID and appending @stream_id to it. If the
3699  * element has no sinkpad it will generate an upstream stream-id by
3700  * doing an URI query on the element and in the worst case just uses
3701  * a random number. Source elements that don't implement the URI
3702  * handler interface should ideally generate a unique, deterministic
3703  * stream-id manually instead.
3704  *
3705  * Returns: A stream-id for @pad. g_free() after usage.
3706  */
3707 gchar *
3708 gst_pad_create_stream_id_printf (GstPad * pad, GstElement * parent,
3709     const gchar * stream_id, ...)
3710 {
3711   va_list var_args;
3712   gchar *new_stream_id;
3713
3714   va_start (var_args, stream_id);
3715   new_stream_id =
3716       gst_pad_create_stream_id_printf_valist (pad, parent, stream_id, var_args);
3717   va_end (var_args);
3718
3719   return new_stream_id;
3720 }
3721
3722 /**
3723  * gst_pad_create_stream_id:
3724  * @pad: A source #GstPad
3725  * @parent: Parent #GstElement of @pad
3726  * @stream_id: (allow-none): The stream-id
3727  *
3728  * Creates a stream-id for the source #GstPad @pad by combining the
3729  * upstream information with the optional @stream_id of the stream
3730  * of @pad. @pad must have a parent #GstElement and which must have zero
3731  * or one sinkpad. @stream_id can only be %NULL if the parent element
3732  * of @pad has only a single source pad.
3733  *
3734  * This function generates an unique stream-id by getting the upstream
3735  * stream-start event stream ID and appending @stream_id to it. If the
3736  * element has no sinkpad it will generate an upstream stream-id by
3737  * doing an URI query on the element and in the worst case just uses
3738  * a random number. Source elements that don't implement the URI
3739  * handler interface should ideally generate a unique, deterministic
3740  * stream-id manually instead.
3741  *
3742  * Since stream IDs are sorted alphabetically, any numbers in the
3743  * stream ID should be printed with a fixed number of characters,
3744  * preceded by 0's, such as by using the format \%03u instead of \%u.
3745  *
3746  * Returns: A stream-id for @pad. g_free() after usage.
3747  */
3748 gchar *
3749 gst_pad_create_stream_id (GstPad * pad, GstElement * parent,
3750     const gchar * stream_id)
3751 {
3752   return gst_pad_create_stream_id_internal (pad, parent, stream_id);
3753 }
3754
3755 /**
3756  * gst_pad_get_stream_id:
3757  * @pad: A source #GstPad
3758  *
3759  * Returns the current stream-id for the @pad, or %NULL if none has been
3760  * set yet, i.e. the pad has not received a stream-start event yet.
3761  *
3762  * This is a convenience wrapper around gst_pad_get_sticky_event() and
3763  * gst_event_parse_stream_start().
3764  *
3765  * The returned stream-id string should be treated as an opaque string, its
3766  * contents should not be interpreted.
3767  *
3768  * Returns: a newly-allocated copy of the stream-id for @pad, or %NULL.
3769  *     g_free() the returned string when no longer needed.
3770  *
3771  * Since: 1.2
3772  */
3773 gchar *
3774 gst_pad_get_stream_id (GstPad * pad)
3775 {
3776   const gchar *stream_id = NULL;
3777   GstEvent *event;
3778   gchar *ret = NULL;
3779
3780   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
3781
3782   event = gst_pad_get_sticky_event (pad, GST_EVENT_STREAM_START, 0);
3783   if (event != NULL) {
3784     gst_event_parse_stream_start (event, &stream_id);
3785     ret = g_strdup (stream_id);
3786     gst_event_unref (event);
3787     GST_LOG_OBJECT (pad, "pad has stream-id '%s'", ret);
3788   } else {
3789     GST_DEBUG_OBJECT (pad, "pad has not received a stream-start event yet");
3790   }
3791
3792   return ret;
3793 }
3794
3795 /**
3796  * gst_util_group_id_next:
3797  *
3798  * Return a constantly incrementing group id.
3799  *
3800  * This function is used to generate a new group-id for the
3801  * stream-start event.
3802  *
3803  * Returns: A constantly incrementing unsigned integer, which might
3804  * overflow back to 0 at some point.
3805  */
3806 guint
3807 gst_util_group_id_next (void)
3808 {
3809   static gint counter = 0;
3810   return g_atomic_int_add (&counter, 1);
3811 }