Merge branch 'master' into 0.11
[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., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23
24 /**
25  * SECTION:gstutils
26  * @short_description: Various utility functions
27  *
28  * When defining own plugins, use the GST_BOILERPLATE ease gobject creation.
29  */
30
31 #include "gst_private.h"
32 #include <stdio.h>
33 #include <string.h>
34
35 #include "gstghostpad.h"
36 #include "gstutils.h"
37 #include "gsterror.h"
38 #include "gstinfo.h"
39 #include "gstparse.h"
40 #include "gstvalue.h"
41 #include "gst-i18n-lib.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  * Convertes 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 multipy/division */
488 #if !defined (__x86_64__) && !defined (HAVE_UINT128_T)
489   /* denom is low --> try to use 96 bit muldiv */
490   if (G_LIKELY (denom <= G_MAXUINT32)) {
491     /* num is low --> use 96 bit muldiv */
492     if (G_LIKELY (num <= G_MAXUINT32))
493       return gst_util_uint64_scale_uint32_unchecked (val, (guint32) num,
494           (guint32) denom, correct);
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  * Since: 0.10.22
702  */
703 guint32
704 gst_util_seqnum_next (void)
705 {
706   static gint counter = 0;
707   return g_atomic_int_exchange_and_add (&counter, 1);
708 }
709
710 /**
711  * gst_util_seqnum_compare:
712  * @s1: A sequence number.
713  * @s2: Another sequence number.
714  *
715  * Compare two sequence numbers, handling wraparound.
716  *
717  * The current implementation just returns (gint32)(@s1 - @s2).
718  *
719  * Returns: A negative number if @s1 is before @s2, 0 if they are equal, or a
720  * positive number if @s1 is after @s2.
721  *
722  * Since: 0.10.22
723  */
724 gint32
725 gst_util_seqnum_compare (guint32 s1, guint32 s2)
726 {
727   return (gint32) (s1 - s2);
728 }
729
730 /* -----------------------------------------------------
731  *
732  *  The following code will be moved out of the main
733  * gstreamer library someday.
734  */
735
736 #include "gstpad.h"
737
738 static void
739 string_append_indent (GString * str, gint count)
740 {
741   gint xx;
742
743   for (xx = 0; xx < count; xx++)
744     g_string_append_c (str, ' ');
745 }
746
747 /**
748  * gst_print_pad_caps:
749  * @buf: the buffer to print the caps in
750  * @indent: initial indentation
751  * @pad: (transfer none): the pad to print the caps from
752  *
753  * Write the pad capabilities in a human readable format into
754  * the given GString.
755  */
756 void
757 gst_print_pad_caps (GString * buf, gint indent, GstPad * pad)
758 {
759   GstCaps *caps;
760
761   caps = pad->caps;
762
763   if (!caps) {
764     string_append_indent (buf, indent);
765     g_string_printf (buf, "%s:%s has no capabilities",
766         GST_DEBUG_PAD_NAME (pad));
767   } else {
768     char *s;
769
770     s = gst_caps_to_string (caps);
771     g_string_append (buf, s);
772     g_free (s);
773   }
774 }
775
776 /**
777  * gst_print_element_args:
778  * @buf: the buffer to print the args in
779  * @indent: initial indentation
780  * @element: (transfer none): the element to print the args of
781  *
782  * Print the element argument in a human readable format in the given
783  * GString.
784  */
785 void
786 gst_print_element_args (GString * buf, gint indent, GstElement * element)
787 {
788   guint width;
789   GValue value = { 0, };        /* the important thing is that value.type = 0 */
790   gchar *str = NULL;
791   GParamSpec *spec, **specs, **walk;
792
793   specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (element), NULL);
794
795   width = 0;
796   for (walk = specs; *walk; walk++) {
797     spec = *walk;
798     if (width < strlen (spec->name))
799       width = strlen (spec->name);
800   }
801
802   for (walk = specs; *walk; walk++) {
803     spec = *walk;
804
805     if (spec->flags & G_PARAM_READABLE) {
806       g_value_init (&value, spec->value_type);
807       g_object_get_property (G_OBJECT (element), spec->name, &value);
808       str = g_strdup_value_contents (&value);
809       g_value_unset (&value);
810     } else {
811       str = g_strdup ("Parameter not readable.");
812     }
813
814     string_append_indent (buf, indent);
815     g_string_append (buf, spec->name);
816     string_append_indent (buf, 2 + width - strlen (spec->name));
817     g_string_append (buf, str);
818     g_string_append_c (buf, '\n');
819
820     g_free (str);
821   }
822
823   g_free (specs);
824 }
825
826 /**
827  * gst_element_create_all_pads:
828  * @element: (transfer none): a #GstElement to create pads for
829  *
830  * Creates a pad for each pad template that is always available.
831  * This function is only useful during object intialization of
832  * subclasses of #GstElement.
833  */
834 void
835 gst_element_create_all_pads (GstElement * element)
836 {
837   GList *padlist;
838
839   /* FIXME: lock element */
840
841   padlist =
842       gst_element_class_get_pad_template_list (GST_ELEMENT_CLASS
843       (G_OBJECT_GET_CLASS (element)));
844
845   while (padlist) {
846     GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
847
848     if (padtempl->presence == GST_PAD_ALWAYS) {
849       GstPad *pad;
850
851       pad = gst_pad_new_from_template (padtempl, padtempl->name_template);
852
853       gst_element_add_pad (element, pad);
854     }
855     padlist = padlist->next;
856   }
857 }
858
859 /**
860  * gst_element_get_compatible_pad_template:
861  * @element: (transfer none): a #GstElement to get a compatible pad template for
862  * @compattempl: (transfer none): the #GstPadTemplate to find a compatible
863  *     template for
864  *
865  * Retrieves a pad template from @element that is compatible with @compattempl.
866  * Pads from compatible templates can be linked together.
867  *
868  * Returns: (transfer none): a compatible #GstPadTemplate, or NULL if none
869  *     was found. No unreferencing is necessary.
870  */
871 GstPadTemplate *
872 gst_element_get_compatible_pad_template (GstElement * element,
873     GstPadTemplate * compattempl)
874 {
875   GstPadTemplate *newtempl = NULL;
876   GList *padlist;
877   GstElementClass *class;
878   gboolean compatible;
879
880   g_return_val_if_fail (element != NULL, NULL);
881   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
882   g_return_val_if_fail (compattempl != NULL, NULL);
883
884   class = GST_ELEMENT_GET_CLASS (element);
885
886   padlist = gst_element_class_get_pad_template_list (class);
887
888   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
889       "Looking for a suitable pad template in %s out of %d templates...",
890       GST_ELEMENT_NAME (element), g_list_length (padlist));
891
892   while (padlist) {
893     GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
894
895     /* Ignore name
896      * Ignore presence
897      * Check direction (must be opposite)
898      * Check caps
899      */
900     GST_CAT_LOG (GST_CAT_CAPS,
901         "checking pad template %s", padtempl->name_template);
902     if (padtempl->direction != compattempl->direction) {
903       GST_CAT_DEBUG (GST_CAT_CAPS,
904           "compatible direction: found %s pad template \"%s\"",
905           padtempl->direction == GST_PAD_SRC ? "src" : "sink",
906           padtempl->name_template);
907
908       GST_CAT_DEBUG (GST_CAT_CAPS,
909           "intersecting %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (compattempl));
910       GST_CAT_DEBUG (GST_CAT_CAPS,
911           "..and %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (padtempl));
912
913       compatible = gst_caps_can_intersect (GST_PAD_TEMPLATE_CAPS (compattempl),
914           GST_PAD_TEMPLATE_CAPS (padtempl));
915
916       GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
917           (compatible ? "" : "not "));
918
919       if (compatible) {
920         newtempl = padtempl;
921         break;
922       }
923     }
924
925     padlist = g_list_next (padlist);
926   }
927   if (newtempl)
928     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
929         "Returning new pad template %p", newtempl);
930   else
931     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "No compatible pad template found");
932
933   return newtempl;
934 }
935
936 /**
937  * gst_element_get_pad_from_template:
938  * @element: (transfer none): a #GstElement.
939  * @templ: (transfer none): a #GstPadTemplate belonging to @element.
940  *
941  * Gets a pad from @element described by @templ. If the presence of @templ is
942  * #GST_PAD_REQUEST, requests a new pad. Can return %NULL for #GST_PAD_SOMETIMES
943  * templates.
944  *
945  * Returns: (transfer full): the #GstPad, or NULL if one could not be found
946  *     or created.
947  */
948 static GstPad *
949 gst_element_get_pad_from_template (GstElement * element, GstPadTemplate * templ)
950 {
951   GstPad *ret = NULL;
952   GstPadPresence presence;
953
954   /* If this function is ever exported, we need check the validity of `element'
955    * and `templ', and to make sure the template actually belongs to the
956    * element. */
957
958   presence = GST_PAD_TEMPLATE_PRESENCE (templ);
959
960   switch (presence) {
961     case GST_PAD_ALWAYS:
962     case GST_PAD_SOMETIMES:
963       ret = gst_element_get_static_pad (element, templ->name_template);
964       if (!ret && presence == GST_PAD_ALWAYS)
965         g_warning
966             ("Element %s has an ALWAYS template %s, but no pad of the same name",
967             GST_OBJECT_NAME (element), templ->name_template);
968       break;
969
970     case GST_PAD_REQUEST:
971       ret = gst_element_request_pad (element, templ, NULL, NULL);
972       break;
973   }
974
975   return ret;
976 }
977
978 /*
979  * gst_element_request_compatible_pad:
980  * @element: a #GstElement.
981  * @templ: the #GstPadTemplate to which the new pad should be able to link.
982  *
983  * Requests a pad from @element. The returned pad should be unlinked and
984  * compatible with @templ. Might return an existing pad, or request a new one.
985  *
986  * Returns: a #GstPad, or %NULL if one could not be found or created.
987  */
988 static GstPad *
989 gst_element_request_compatible_pad (GstElement * element,
990     GstPadTemplate * templ)
991 {
992   GstPadTemplate *templ_new;
993   GstPad *pad = NULL;
994
995   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
996   g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
997
998   /* FIXME: should really loop through the templates, testing each for
999    *      compatibility and pad availability. */
1000   templ_new = gst_element_get_compatible_pad_template (element, templ);
1001   if (templ_new)
1002     pad = gst_element_get_pad_from_template (element, templ_new);
1003
1004   /* This can happen for non-request pads. No need to unref. */
1005   if (pad && GST_PAD_PEER (pad))
1006     pad = NULL;
1007
1008   return pad;
1009 }
1010
1011 /*
1012  * Checks if the source pad and the sink pad can be linked.
1013  * Both @srcpad and @sinkpad must be unlinked and have a parent.
1014  */
1015 static gboolean
1016 gst_pad_check_link (GstPad * srcpad, GstPad * sinkpad)
1017 {
1018   /* FIXME This function is gross.  It's almost a direct copy of
1019    * gst_pad_link_filtered().  Any decent programmer would attempt
1020    * to merge the two functions, which I will do some day. --ds
1021    */
1022
1023   /* generic checks */
1024   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1025   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1026
1027   GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
1028       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1029
1030   /* FIXME: shouldn't we convert this to g_return_val_if_fail? */
1031   if (GST_PAD_PEER (srcpad) != NULL) {
1032     GST_CAT_INFO (GST_CAT_PADS, "Source pad %s:%s has a peer, failed",
1033         GST_DEBUG_PAD_NAME (srcpad));
1034     return FALSE;
1035   }
1036   if (GST_PAD_PEER (sinkpad) != NULL) {
1037     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has a peer, failed",
1038         GST_DEBUG_PAD_NAME (sinkpad));
1039     return FALSE;
1040   }
1041   if (!GST_PAD_IS_SRC (srcpad)) {
1042     GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s is not source pad, failed",
1043         GST_DEBUG_PAD_NAME (srcpad));
1044     return FALSE;
1045   }
1046   if (!GST_PAD_IS_SINK (sinkpad)) {
1047     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s is not sink pad, failed",
1048         GST_DEBUG_PAD_NAME (sinkpad));
1049     return FALSE;
1050   }
1051   if (GST_PAD_PARENT (srcpad) == NULL) {
1052     GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s has no parent, failed",
1053         GST_DEBUG_PAD_NAME (srcpad));
1054     return FALSE;
1055   }
1056   if (GST_PAD_PARENT (sinkpad) == NULL) {
1057     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has no parent, failed",
1058         GST_DEBUG_PAD_NAME (srcpad));
1059     return FALSE;
1060   }
1061
1062   return TRUE;
1063 }
1064
1065 /**
1066  * gst_element_get_compatible_pad:
1067  * @element: (transfer none): a #GstElement in which the pad should be found.
1068  * @pad: (transfer none): the #GstPad to find a compatible one for.
1069  * @caps: the #GstCaps to use as a filter.
1070  *
1071  * Looks for an unlinked pad to which the given pad can link. It is not
1072  * guaranteed that linking the pads will work, though it should work in most
1073  * cases.
1074  *
1075  * This function will first attempt to find a compatible unlinked ALWAYS pad,
1076  * and if none can be found, it will request a compatible REQUEST pad by looking
1077  * at the templates of @element.
1078  *
1079  * Returns: (transfer full): the #GstPad to which a link can be made, or %NULL
1080  *     if one cannot be found. gst_object_unref() after usage.
1081  */
1082 GstPad *
1083 gst_element_get_compatible_pad (GstElement * element, GstPad * pad,
1084     const GstCaps * caps)
1085 {
1086   GstIterator *pads;
1087   GstPadTemplate *templ;
1088   GstCaps *templcaps;
1089   GstPad *foundpad = NULL;
1090   gboolean done;
1091   GValue padptr = { 0, };
1092
1093   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
1094   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1095
1096   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1097       "finding pad in %s compatible with %s:%s",
1098       GST_ELEMENT_NAME (element), GST_DEBUG_PAD_NAME (pad));
1099
1100   g_return_val_if_fail (GST_PAD_PEER (pad) == NULL, NULL);
1101
1102   done = FALSE;
1103
1104   /* try to get an existing unlinked pad */
1105   if (GST_PAD_IS_SRC (pad)) {
1106     pads = gst_element_iterate_sink_pads (element);
1107   } else if (GST_PAD_IS_SINK (pad)) {
1108     pads = gst_element_iterate_src_pads (element);
1109   } else {
1110     pads = gst_element_iterate_pads (element);
1111   }
1112
1113   while (!done) {
1114     switch (gst_iterator_next (pads, &padptr)) {
1115       case GST_ITERATOR_OK:
1116       {
1117         GstPad *peer;
1118         GstPad *current;
1119         GstPad *srcpad;
1120         GstPad *sinkpad;
1121
1122         current = g_value_get_object (&padptr);
1123
1124         GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
1125             GST_DEBUG_PAD_NAME (current));
1126
1127         if (GST_PAD_IS_SRC (current)) {
1128           srcpad = current;
1129           sinkpad = pad;
1130         } else {
1131           srcpad = pad;
1132           sinkpad = current;
1133         }
1134         peer = gst_pad_get_peer (current);
1135
1136         if (peer == NULL && gst_pad_check_link (srcpad, sinkpad)) {
1137           GstCaps *temp, *intersection;
1138           gboolean compatible;
1139
1140           /* Now check if the two pads' caps are compatible */
1141           temp = gst_pad_get_caps (pad);
1142           if (caps) {
1143             intersection = gst_caps_intersect (temp, caps);
1144             gst_caps_unref (temp);
1145           } else {
1146             intersection = temp;
1147           }
1148
1149           temp = gst_pad_get_caps (current);
1150           compatible = gst_caps_can_intersect (temp, intersection);
1151           gst_caps_unref (temp);
1152           gst_caps_unref (intersection);
1153
1154           if (compatible) {
1155             GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1156                 "found existing unlinked compatible pad %s:%s",
1157                 GST_DEBUG_PAD_NAME (current));
1158             gst_iterator_free (pads);
1159
1160             current = gst_object_ref (current);
1161             g_value_unset (&padptr);
1162
1163             return current;
1164           } else {
1165             GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "incompatible pads");
1166           }
1167         } else {
1168           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1169               "already linked or cannot be linked (peer = %p)", peer);
1170         }
1171         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unreffing pads");
1172
1173         g_value_reset (&padptr);
1174         if (peer)
1175           gst_object_unref (peer);
1176         break;
1177       }
1178       case GST_ITERATOR_DONE:
1179         done = TRUE;
1180         break;
1181       case GST_ITERATOR_RESYNC:
1182         gst_iterator_resync (pads);
1183         break;
1184       case GST_ITERATOR_ERROR:
1185         g_assert_not_reached ();
1186         break;
1187     }
1188   }
1189   g_value_unset (&padptr);
1190   gst_iterator_free (pads);
1191
1192   GST_CAT_DEBUG_OBJECT (GST_CAT_ELEMENT_PADS, element,
1193       "Could not find a compatible unlinked always pad to link to %s:%s, now checking request pads",
1194       GST_DEBUG_PAD_NAME (pad));
1195
1196   /* try to create a new one */
1197   /* requesting is a little crazy, we need a template. Let's create one */
1198   /* FIXME: why not gst_pad_get_pad_template (pad); */
1199   templcaps = gst_pad_get_caps (pad);
1200
1201   templ = gst_pad_template_new ((gchar *) GST_PAD_NAME (pad),
1202       GST_PAD_DIRECTION (pad), GST_PAD_ALWAYS, templcaps);
1203
1204   foundpad = gst_element_request_compatible_pad (element, templ);
1205   gst_object_unref (templ);
1206
1207   if (foundpad) {
1208     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1209         "found existing request pad %s:%s", GST_DEBUG_PAD_NAME (foundpad));
1210     return foundpad;
1211   }
1212
1213   GST_CAT_INFO_OBJECT (GST_CAT_ELEMENT_PADS, element,
1214       "Could not find a compatible pad to link to %s:%s",
1215       GST_DEBUG_PAD_NAME (pad));
1216   return NULL;
1217 }
1218
1219 /**
1220  * gst_element_state_get_name:
1221  * @state: a #GstState to get the name of.
1222  *
1223  * Gets a string representing the given state.
1224  *
1225  * Returns: (transfer none): a string with the name of the state.
1226  */
1227 G_CONST_RETURN gchar *
1228 gst_element_state_get_name (GstState state)
1229 {
1230   switch (state) {
1231     case GST_STATE_VOID_PENDING:
1232       return "VOID_PENDING";
1233     case GST_STATE_NULL:
1234       return "NULL";
1235     case GST_STATE_READY:
1236       return "READY";
1237     case GST_STATE_PLAYING:
1238       return "PLAYING";
1239     case GST_STATE_PAUSED:
1240       return "PAUSED";
1241     default:
1242       /* This is a memory leak */
1243       return g_strdup_printf ("UNKNOWN!(%d)", state);
1244   }
1245 }
1246
1247 /**
1248  * gst_element_state_change_return_get_name:
1249  * @state_ret: a #GstStateChangeReturn to get the name of.
1250  *
1251  * Gets a string representing the given state change result.
1252  *
1253  * Returns: (transfer none): a string with the name of the state
1254  *    result.
1255  *
1256  * Since: 0.10.11
1257  */
1258 G_CONST_RETURN gchar *
1259 gst_element_state_change_return_get_name (GstStateChangeReturn state_ret)
1260 {
1261   switch (state_ret) {
1262     case GST_STATE_CHANGE_FAILURE:
1263       return "FAILURE";
1264     case GST_STATE_CHANGE_SUCCESS:
1265       return "SUCCESS";
1266     case GST_STATE_CHANGE_ASYNC:
1267       return "ASYNC";
1268     case GST_STATE_CHANGE_NO_PREROLL:
1269       return "NO PREROLL";
1270     default:
1271       /* This is a memory leak */
1272       return g_strdup_printf ("UNKNOWN!(%d)", state_ret);
1273   }
1274 }
1275
1276
1277 static gboolean
1278 gst_element_factory_can_accept_all_caps_in_direction (GstElementFactory *
1279     factory, const GstCaps * caps, GstPadDirection direction)
1280 {
1281   GList *templates;
1282
1283   g_return_val_if_fail (factory != NULL, FALSE);
1284   g_return_val_if_fail (caps != NULL, FALSE);
1285
1286   templates = factory->staticpadtemplates;
1287
1288   while (templates) {
1289     GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1290
1291     if (template->direction == direction) {
1292       GstCaps *templcaps = gst_static_caps_get (&template->static_caps);
1293
1294       if (gst_caps_is_always_compatible (caps, templcaps)) {
1295         gst_caps_unref (templcaps);
1296         return TRUE;
1297       }
1298       gst_caps_unref (templcaps);
1299     }
1300     templates = g_list_next (templates);
1301   }
1302
1303   return FALSE;
1304 }
1305
1306 static gboolean
1307 gst_element_factory_can_accept_any_caps_in_direction (GstElementFactory *
1308     factory, const GstCaps * caps, GstPadDirection direction)
1309 {
1310   GList *templates;
1311
1312   g_return_val_if_fail (factory != NULL, FALSE);
1313   g_return_val_if_fail (caps != NULL, FALSE);
1314
1315   templates = factory->staticpadtemplates;
1316
1317   while (templates) {
1318     GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1319
1320     if (template->direction == direction) {
1321       GstCaps *templcaps = gst_static_caps_get (&template->static_caps);
1322
1323       if (gst_caps_can_intersect (caps, templcaps)) {
1324         gst_caps_unref (templcaps);
1325         return TRUE;
1326       }
1327       gst_caps_unref (templcaps);
1328     }
1329     templates = g_list_next (templates);
1330   }
1331
1332   return FALSE;
1333 }
1334
1335 /**
1336  * gst_element_factory_can_sink_all_caps:
1337  * @factory: factory to query
1338  * @caps: the caps to check
1339  *
1340  * Checks if the factory can sink all possible capabilities.
1341  *
1342  * Returns: %TRUE if the caps are fully compatible.
1343  *
1344  * Since: 0.10.33
1345  */
1346 gboolean
1347 gst_element_factory_can_sink_all_caps (GstElementFactory * factory,
1348     const GstCaps * caps)
1349 {
1350   return gst_element_factory_can_accept_all_caps_in_direction (factory, caps,
1351       GST_PAD_SINK);
1352 }
1353
1354 /**
1355  * gst_element_factory_can_src_all_caps:
1356  * @factory: factory to query
1357  * @caps: the caps to check
1358  *
1359  * Checks if the factory can src all possible capabilities.
1360  *
1361  * Returns: %TRUE if the caps are fully compatible.
1362  *
1363  * Since: 0.10.33
1364  */
1365 gboolean
1366 gst_element_factory_can_src_all_caps (GstElementFactory * factory,
1367     const GstCaps * caps)
1368 {
1369   return gst_element_factory_can_accept_all_caps_in_direction (factory, caps,
1370       GST_PAD_SRC);
1371 }
1372
1373 /**
1374  * gst_element_factory_can_sink_any_caps:
1375  * @factory: factory to query
1376  * @caps: the caps to check
1377  *
1378  * Checks if the factory can sink any possible capability.
1379  *
1380  * Returns: %TRUE if the caps have a common subset.
1381  *
1382  * Since: 0.10.33
1383  */
1384 gboolean
1385 gst_element_factory_can_sink_any_caps (GstElementFactory * factory,
1386     const GstCaps * caps)
1387 {
1388   return gst_element_factory_can_accept_any_caps_in_direction (factory, caps,
1389       GST_PAD_SINK);
1390 }
1391
1392 /**
1393  * gst_element_factory_can_src_any_caps:
1394  * @factory: factory to query
1395  * @caps: the caps to check
1396  *
1397  * Checks if the factory can src any possible capability.
1398  *
1399  * Returns: %TRUE if the caps have a common subset.
1400  *
1401  * Since: 0.10.33
1402  */
1403 gboolean
1404 gst_element_factory_can_src_any_caps (GstElementFactory * factory,
1405     const GstCaps * caps)
1406 {
1407   return gst_element_factory_can_accept_any_caps_in_direction (factory, caps,
1408       GST_PAD_SRC);
1409 }
1410
1411 /* if return val is true, *direct_child is a caller-owned ref on the direct
1412  * child of ancestor that is part of object's ancestry */
1413 static gboolean
1414 object_has_ancestor (GstObject * object, GstObject * ancestor,
1415     GstObject ** direct_child)
1416 {
1417   GstObject *child, *parent;
1418
1419   if (direct_child)
1420     *direct_child = NULL;
1421
1422   child = gst_object_ref (object);
1423   parent = gst_object_get_parent (object);
1424
1425   while (parent) {
1426     if (ancestor == parent) {
1427       if (direct_child)
1428         *direct_child = child;
1429       else
1430         gst_object_unref (child);
1431       gst_object_unref (parent);
1432       return TRUE;
1433     }
1434
1435     gst_object_unref (child);
1436     child = parent;
1437     parent = gst_object_get_parent (parent);
1438   }
1439
1440   gst_object_unref (child);
1441
1442   return FALSE;
1443 }
1444
1445 /* caller owns return */
1446 static GstObject *
1447 find_common_root (GstObject * o1, GstObject * o2)
1448 {
1449   GstObject *top = o1;
1450   GstObject *kid1, *kid2;
1451   GstObject *root = NULL;
1452
1453   while (GST_OBJECT_PARENT (top))
1454     top = GST_OBJECT_PARENT (top);
1455
1456   /* the itsy-bitsy spider... */
1457
1458   if (!object_has_ancestor (o2, top, &kid2))
1459     return NULL;
1460
1461   root = gst_object_ref (top);
1462   while (TRUE) {
1463     if (!object_has_ancestor (o1, kid2, &kid1)) {
1464       gst_object_unref (kid2);
1465       return root;
1466     }
1467     root = kid2;
1468     if (!object_has_ancestor (o2, kid1, &kid2)) {
1469       gst_object_unref (kid1);
1470       return root;
1471     }
1472     root = kid1;
1473   }
1474 }
1475
1476 /* caller does not own return */
1477 static GstPad *
1478 ghost_up (GstElement * e, GstPad * pad)
1479 {
1480   static gint ghost_pad_index = 0;
1481   GstPad *gpad;
1482   gchar *name;
1483   GstState current;
1484   GstState next;
1485   GstObject *parent = GST_OBJECT_PARENT (e);
1486
1487   name = g_strdup_printf ("ghost%d", ghost_pad_index++);
1488   gpad = gst_ghost_pad_new (name, pad);
1489   g_free (name);
1490
1491   GST_STATE_LOCK (e);
1492   gst_element_get_state (e, &current, &next, 0);
1493
1494   if (current > GST_STATE_READY || next == GST_STATE_PAUSED)
1495     gst_pad_set_active (gpad, TRUE);
1496
1497   if (!gst_element_add_pad ((GstElement *) parent, gpad)) {
1498     g_warning ("Pad named %s already exists in element %s\n",
1499         GST_OBJECT_NAME (gpad), GST_OBJECT_NAME (parent));
1500     gst_object_unref ((GstObject *) gpad);
1501     GST_STATE_UNLOCK (e);
1502     return NULL;
1503   }
1504   GST_STATE_UNLOCK (e);
1505
1506   return gpad;
1507 }
1508
1509 static void
1510 remove_pad (gpointer ppad, gpointer unused)
1511 {
1512   GstPad *pad = ppad;
1513
1514   if (!gst_element_remove_pad ((GstElement *) GST_OBJECT_PARENT (pad), pad))
1515     g_warning ("Couldn't remove pad %s from element %s",
1516         GST_OBJECT_NAME (pad), GST_OBJECT_NAME (GST_OBJECT_PARENT (pad)));
1517 }
1518
1519 static gboolean
1520 prepare_link_maybe_ghosting (GstPad ** src, GstPad ** sink,
1521     GSList ** pads_created)
1522 {
1523   GstObject *root;
1524   GstObject *e1, *e2;
1525   GSList *pads_created_local = NULL;
1526
1527   g_assert (pads_created);
1528
1529   e1 = GST_OBJECT_PARENT (*src);
1530   e2 = GST_OBJECT_PARENT (*sink);
1531
1532   if (G_UNLIKELY (e1 == NULL)) {
1533     GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1534         GST_PTR_FORMAT, *src);
1535     return FALSE;
1536   }
1537   if (G_UNLIKELY (e2 == NULL)) {
1538     GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1539         GST_PTR_FORMAT, *sink);
1540     return FALSE;
1541   }
1542
1543   if (GST_OBJECT_PARENT (e1) == GST_OBJECT_PARENT (e2)) {
1544     GST_CAT_INFO (GST_CAT_PADS, "%s and %s in same bin, no need for ghost pads",
1545         GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1546     return TRUE;
1547   }
1548
1549   GST_CAT_INFO (GST_CAT_PADS, "%s and %s not in same bin, making ghost pads",
1550       GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1551
1552   /* we need to setup some ghost pads */
1553   root = find_common_root (e1, e2);
1554   if (!root) {
1555     g_warning ("Trying to connect elements that don't share a common "
1556         "ancestor: %s and %s", GST_ELEMENT_NAME (e1), GST_ELEMENT_NAME (e2));
1557     return FALSE;
1558   }
1559
1560   while (GST_OBJECT_PARENT (e1) != root) {
1561     *src = ghost_up ((GstElement *) e1, *src);
1562     if (!*src)
1563       goto cleanup_fail;
1564     e1 = GST_OBJECT_PARENT (*src);
1565     pads_created_local = g_slist_prepend (pads_created_local, *src);
1566   }
1567   while (GST_OBJECT_PARENT (e2) != root) {
1568     *sink = ghost_up ((GstElement *) e2, *sink);
1569     if (!*sink)
1570       goto cleanup_fail;
1571     e2 = GST_OBJECT_PARENT (*sink);
1572     pads_created_local = g_slist_prepend (pads_created_local, *sink);
1573   }
1574
1575   gst_object_unref (root);
1576   *pads_created = g_slist_concat (*pads_created, pads_created_local);
1577   return TRUE;
1578
1579 cleanup_fail:
1580   gst_object_unref (root);
1581   g_slist_foreach (pads_created_local, remove_pad, NULL);
1582   g_slist_free (pads_created_local);
1583   return FALSE;
1584 }
1585
1586 static gboolean
1587 pad_link_maybe_ghosting (GstPad * src, GstPad * sink, GstPadLinkCheck flags)
1588 {
1589   GSList *pads_created = NULL;
1590   gboolean ret;
1591
1592   if (!prepare_link_maybe_ghosting (&src, &sink, &pads_created)) {
1593     ret = FALSE;
1594   } else {
1595     ret = (gst_pad_link_full (src, sink, flags) == GST_PAD_LINK_OK);
1596   }
1597
1598   if (!ret) {
1599     g_slist_foreach (pads_created, remove_pad, NULL);
1600   }
1601   g_slist_free (pads_created);
1602
1603   return ret;
1604 }
1605
1606 /**
1607  * gst_element_link_pads_full:
1608  * @src: a #GstElement containing the source pad.
1609  * @srcpadname: (allow-none): the name of the #GstPad in source element
1610  *     or NULL for any pad.
1611  * @dest: (transfer none): the #GstElement containing the destination pad.
1612  * @destpadname: (allow-none): the name of the #GstPad in destination element,
1613  * or NULL for any pad.
1614  * @flags: the #GstPadLinkCheck to be performed when linking pads.
1615  *
1616  * Links the two named pads of the source and destination elements.
1617  * Side effect is that if one of the pads has no parent, it becomes a
1618  * child of the parent of the other element.  If they have different
1619  * parents, the link fails.
1620  *
1621  * Calling gst_element_link_pads_full() with @flags == %GST_PAD_LINK_CHECK_DEFAULT
1622  * is the same as calling gst_element_link_pads() and the recommended way of
1623  * linking pads with safety checks applied.
1624  *
1625  * This is a convenience function for gst_pad_link_full().
1626  *
1627  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1628  *
1629  * Since: 0.10.30
1630  */
1631 gboolean
1632 gst_element_link_pads_full (GstElement * src, const gchar * srcpadname,
1633     GstElement * dest, const gchar * destpadname, GstPadLinkCheck flags)
1634 {
1635   const GList *srcpads, *destpads, *srctempls, *desttempls, *l;
1636   GstPad *srcpad, *destpad;
1637   GstPadTemplate *srctempl, *desttempl;
1638   GstElementClass *srcclass, *destclass;
1639
1640   /* checks */
1641   g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1642   g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1643
1644   GST_CAT_INFO (GST_CAT_ELEMENT_PADS,
1645       "trying to link element %s:%s to element %s:%s", GST_ELEMENT_NAME (src),
1646       srcpadname ? srcpadname : "(any)", GST_ELEMENT_NAME (dest),
1647       destpadname ? destpadname : "(any)");
1648
1649   /* get a src pad */
1650   if (srcpadname) {
1651     /* name specified, look it up */
1652     if (!(srcpad = gst_element_get_static_pad (src, srcpadname)))
1653       srcpad = gst_element_get_request_pad (src, srcpadname);
1654     if (!srcpad) {
1655       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1656           GST_ELEMENT_NAME (src), srcpadname);
1657       return FALSE;
1658     } else {
1659       if (!(GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC)) {
1660         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no src pad",
1661             GST_DEBUG_PAD_NAME (srcpad));
1662         gst_object_unref (srcpad);
1663         return FALSE;
1664       }
1665       if (GST_PAD_PEER (srcpad) != NULL) {
1666         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1667             "pad %s:%s is already linked to %s:%s", GST_DEBUG_PAD_NAME (srcpad),
1668             GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
1669         gst_object_unref (srcpad);
1670         return FALSE;
1671       }
1672     }
1673     srcpads = NULL;
1674   } else {
1675     /* no name given, get the first available pad */
1676     GST_OBJECT_LOCK (src);
1677     srcpads = GST_ELEMENT_PADS (src);
1678     srcpad = srcpads ? GST_PAD_CAST (srcpads->data) : NULL;
1679     if (srcpad)
1680       gst_object_ref (srcpad);
1681     GST_OBJECT_UNLOCK (src);
1682   }
1683
1684   /* get a destination pad */
1685   if (destpadname) {
1686     /* name specified, look it up */
1687     if (!(destpad = gst_element_get_static_pad (dest, destpadname)))
1688       destpad = gst_element_get_request_pad (dest, destpadname);
1689     if (!destpad) {
1690       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1691           GST_ELEMENT_NAME (dest), destpadname);
1692       return FALSE;
1693     } else {
1694       if (!(GST_PAD_DIRECTION (destpad) == GST_PAD_SINK)) {
1695         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no sink pad",
1696             GST_DEBUG_PAD_NAME (destpad));
1697         gst_object_unref (destpad);
1698         return FALSE;
1699       }
1700       if (GST_PAD_PEER (destpad) != NULL) {
1701         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1702             "pad %s:%s is already linked to %s:%s",
1703             GST_DEBUG_PAD_NAME (destpad),
1704             GST_DEBUG_PAD_NAME (GST_PAD_PEER (destpad)));
1705         gst_object_unref (destpad);
1706         return FALSE;
1707       }
1708     }
1709     destpads = NULL;
1710   } else {
1711     /* no name given, get the first available pad */
1712     GST_OBJECT_LOCK (dest);
1713     destpads = GST_ELEMENT_PADS (dest);
1714     destpad = destpads ? GST_PAD_CAST (destpads->data) : NULL;
1715     if (destpad)
1716       gst_object_ref (destpad);
1717     GST_OBJECT_UNLOCK (dest);
1718   }
1719
1720   if (srcpadname && destpadname) {
1721     gboolean result;
1722
1723     /* two explicitly specified pads */
1724     result = pad_link_maybe_ghosting (srcpad, destpad, flags);
1725
1726     gst_object_unref (srcpad);
1727     gst_object_unref (destpad);
1728
1729     return result;
1730   }
1731
1732   if (srcpad) {
1733     /* loop through the allowed pads in the source, trying to find a
1734      * compatible destination pad */
1735     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1736         "looping through allowed src and dest pads");
1737     do {
1738       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying src pad %s:%s",
1739           GST_DEBUG_PAD_NAME (srcpad));
1740       if ((GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC) &&
1741           (GST_PAD_PEER (srcpad) == NULL)) {
1742         GstPad *temp;
1743
1744         if (destpadname) {
1745           temp = destpad;
1746           gst_object_ref (temp);
1747         } else {
1748           temp = gst_element_get_compatible_pad (dest, srcpad, NULL);
1749         }
1750
1751         if (temp && pad_link_maybe_ghosting (srcpad, temp, flags)) {
1752           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1753               GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (temp));
1754           if (destpad)
1755             gst_object_unref (destpad);
1756           gst_object_unref (srcpad);
1757           gst_object_unref (temp);
1758           return TRUE;
1759         }
1760
1761         if (temp) {
1762           gst_object_unref (temp);
1763         }
1764       }
1765       /* find a better way for this mess */
1766       if (srcpads) {
1767         srcpads = g_list_next (srcpads);
1768         if (srcpads) {
1769           gst_object_unref (srcpad);
1770           srcpad = GST_PAD_CAST (srcpads->data);
1771           gst_object_ref (srcpad);
1772         }
1773       }
1774     } while (srcpads);
1775   }
1776   if (srcpadname) {
1777     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s:%s to %s",
1778         GST_DEBUG_PAD_NAME (srcpad), GST_ELEMENT_NAME (dest));
1779     if (destpad)
1780       gst_object_unref (destpad);
1781     destpad = NULL;
1782   }
1783   if (srcpad)
1784     gst_object_unref (srcpad);
1785   srcpad = NULL;
1786
1787   if (destpad) {
1788     /* loop through the existing pads in the destination */
1789     do {
1790       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying dest pad %s:%s",
1791           GST_DEBUG_PAD_NAME (destpad));
1792       if ((GST_PAD_DIRECTION (destpad) == GST_PAD_SINK) &&
1793           (GST_PAD_PEER (destpad) == NULL)) {
1794         GstPad *temp = gst_element_get_compatible_pad (src, destpad, NULL);
1795
1796         if (temp && pad_link_maybe_ghosting (temp, destpad, flags)) {
1797           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1798               GST_DEBUG_PAD_NAME (temp), GST_DEBUG_PAD_NAME (destpad));
1799           gst_object_unref (temp);
1800           gst_object_unref (destpad);
1801           return TRUE;
1802         }
1803         if (temp) {
1804           gst_object_unref (temp);
1805         }
1806       }
1807       if (destpads) {
1808         destpads = g_list_next (destpads);
1809         if (destpads) {
1810           gst_object_unref (destpad);
1811           destpad = GST_PAD_CAST (destpads->data);
1812           gst_object_ref (destpad);
1813         }
1814       }
1815     } while (destpads);
1816   }
1817
1818   if (destpadname) {
1819     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s:%s",
1820         GST_ELEMENT_NAME (src), GST_DEBUG_PAD_NAME (destpad));
1821     gst_object_unref (destpad);
1822     return FALSE;
1823   } else {
1824     if (destpad)
1825       gst_object_unref (destpad);
1826     destpad = NULL;
1827   }
1828
1829   srcclass = GST_ELEMENT_GET_CLASS (src);
1830   destclass = GST_ELEMENT_GET_CLASS (dest);
1831
1832   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1833       "we might have request pads on both sides, checking...");
1834   srctempls = gst_element_class_get_pad_template_list (srcclass);
1835   desttempls = gst_element_class_get_pad_template_list (destclass);
1836
1837   if (srctempls && desttempls) {
1838     while (srctempls) {
1839       srctempl = (GstPadTemplate *) srctempls->data;
1840       if (srctempl->presence == GST_PAD_REQUEST) {
1841         for (l = desttempls; l; l = l->next) {
1842           desttempl = (GstPadTemplate *) l->data;
1843           if (desttempl->presence == GST_PAD_REQUEST &&
1844               desttempl->direction != srctempl->direction) {
1845             if (gst_caps_is_always_compatible (gst_pad_template_get_caps
1846                     (srctempl), gst_pad_template_get_caps (desttempl))) {
1847               srcpad =
1848                   gst_element_request_pad (src, srctempl,
1849                   srctempl->name_template, NULL);
1850               destpad =
1851                   gst_element_request_pad (dest, desttempl,
1852                   desttempl->name_template, NULL);
1853               if (srcpad && destpad
1854                   && pad_link_maybe_ghosting (srcpad, destpad, flags)) {
1855                 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1856                     "linked pad %s:%s to pad %s:%s",
1857                     GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (destpad));
1858                 gst_object_unref (srcpad);
1859                 gst_object_unref (destpad);
1860                 return TRUE;
1861               }
1862               /* it failed, so we release the request pads */
1863               if (srcpad)
1864                 gst_element_release_request_pad (src, srcpad);
1865               if (destpad)
1866                 gst_element_release_request_pad (dest, destpad);
1867             }
1868           }
1869         }
1870       }
1871       srctempls = srctempls->next;
1872     }
1873   }
1874
1875   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s",
1876       GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
1877   return FALSE;
1878 }
1879
1880 /**
1881  * gst_element_link_pads:
1882  * @src: a #GstElement containing the source pad.
1883  * @srcpadname: (allow-none): the name of the #GstPad in source element
1884  *     or NULL for any pad.
1885  * @dest: (transfer none): the #GstElement containing the destination pad.
1886  * @destpadname: (allow-none): the name of the #GstPad in destination element,
1887  * or NULL for any pad.
1888  *
1889  * Links the two named pads of the source and destination elements.
1890  * Side effect is that if one of the pads has no parent, it becomes a
1891  * child of the parent of the other element.  If they have different
1892  * parents, the link fails.
1893  *
1894  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1895  */
1896 gboolean
1897 gst_element_link_pads (GstElement * src, const gchar * srcpadname,
1898     GstElement * dest, const gchar * destpadname)
1899 {
1900   return gst_element_link_pads_full (src, srcpadname, dest, destpadname,
1901       GST_PAD_LINK_CHECK_DEFAULT);
1902 }
1903
1904 /**
1905  * gst_element_link_pads_filtered:
1906  * @src: a #GstElement containing the source pad.
1907  * @srcpadname: (allow-none): the name of the #GstPad in source element
1908  *     or NULL for any pad.
1909  * @dest: (transfer none): the #GstElement containing the destination pad.
1910  * @destpadname: (allow-none): the name of the #GstPad in destination element
1911  *     or NULL for any pad.
1912  * @filter: (transfer none) (allow-none): the #GstCaps to filter the link,
1913  *     or #NULL for no filter.
1914  *
1915  * Links the two named pads of the source and destination elements. Side effect
1916  * is that if one of the pads has no parent, it becomes a child of the parent of
1917  * the other element. If they have different parents, the link fails. If @caps
1918  * is not #NULL, makes sure that the caps of the link is a subset of @caps.
1919  *
1920  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1921  */
1922 gboolean
1923 gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
1924     GstElement * dest, const gchar * destpadname, GstCaps * filter)
1925 {
1926   /* checks */
1927   g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1928   g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1929   g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), FALSE);
1930
1931   if (filter) {
1932     GstElement *capsfilter;
1933     GstObject *parent;
1934     GstState state, pending;
1935     gboolean lr1, lr2;
1936
1937     capsfilter = gst_element_factory_make ("capsfilter", NULL);
1938     if (!capsfilter) {
1939       GST_ERROR ("Could not make a capsfilter");
1940       return FALSE;
1941     }
1942
1943     parent = gst_object_get_parent (GST_OBJECT (src));
1944     g_return_val_if_fail (GST_IS_BIN (parent), FALSE);
1945
1946     gst_element_get_state (GST_ELEMENT_CAST (parent), &state, &pending, 0);
1947
1948     if (!gst_bin_add (GST_BIN (parent), capsfilter)) {
1949       GST_ERROR ("Could not add capsfilter");
1950       gst_object_unref (capsfilter);
1951       gst_object_unref (parent);
1952       return FALSE;
1953     }
1954
1955     if (pending != GST_STATE_VOID_PENDING)
1956       state = pending;
1957
1958     gst_element_set_state (capsfilter, state);
1959
1960     gst_object_unref (parent);
1961
1962     g_object_set (capsfilter, "caps", filter, NULL);
1963
1964     lr1 = gst_element_link_pads (src, srcpadname, capsfilter, "sink");
1965     lr2 = gst_element_link_pads (capsfilter, "src", dest, destpadname);
1966     if (lr1 && lr2) {
1967       return TRUE;
1968     } else {
1969       if (!lr1) {
1970         GST_INFO ("Could not link pads: %s:%s - capsfilter:sink",
1971             GST_ELEMENT_NAME (src), srcpadname);
1972       } else {
1973         GST_INFO ("Could not link pads: capsfilter:src - %s:%s",
1974             GST_ELEMENT_NAME (dest), destpadname);
1975       }
1976       gst_element_set_state (capsfilter, GST_STATE_NULL);
1977       /* this will unlink and unref as appropriate */
1978       gst_bin_remove (GST_BIN (GST_OBJECT_PARENT (capsfilter)), capsfilter);
1979       return FALSE;
1980     }
1981   } else {
1982     if (gst_element_link_pads (src, srcpadname, dest, destpadname)) {
1983       return TRUE;
1984     } else {
1985       GST_INFO ("Could not link pads: %s:%s - %s:%s", GST_ELEMENT_NAME (src),
1986           srcpadname, GST_ELEMENT_NAME (dest), destpadname);
1987       return FALSE;
1988     }
1989   }
1990 }
1991
1992 /**
1993  * gst_element_link:
1994  * @src: (transfer none): a #GstElement containing the source pad.
1995  * @dest: (transfer none): the #GstElement containing the destination pad.
1996  *
1997  * Links @src to @dest. The link must be from source to
1998  * destination; the other direction will not be tried. The function looks for
1999  * existing pads that aren't linked yet. It will request new pads if necessary.
2000  * Such pads need to be released manualy when unlinking.
2001  * If multiple links are possible, only one is established.
2002  *
2003  * Make sure you have added your elements to a bin or pipeline with
2004  * gst_bin_add() before trying to link them.
2005  *
2006  * Returns: TRUE if the elements could be linked, FALSE otherwise.
2007  */
2008 gboolean
2009 gst_element_link (GstElement * src, GstElement * dest)
2010 {
2011   return gst_element_link_pads (src, NULL, dest, NULL);
2012 }
2013
2014 /**
2015  * gst_element_link_many:
2016  * @element_1: (transfer none): the first #GstElement in the link chain.
2017  * @element_2: (transfer none): the second #GstElement in the link chain.
2018  * @...: the NULL-terminated list of elements to link in order.
2019  *
2020  * Chain together a series of elements. Uses gst_element_link().
2021  * Make sure you have added your elements to a bin or pipeline with
2022  * gst_bin_add() before trying to link them.
2023  *
2024  * Returns: TRUE on success, FALSE otherwise.
2025  */
2026 gboolean
2027 gst_element_link_many (GstElement * element_1, GstElement * element_2, ...)
2028 {
2029   gboolean res = TRUE;
2030   va_list args;
2031
2032   g_return_val_if_fail (GST_IS_ELEMENT (element_1), FALSE);
2033   g_return_val_if_fail (GST_IS_ELEMENT (element_2), FALSE);
2034
2035   va_start (args, element_2);
2036
2037   while (element_2) {
2038     if (!gst_element_link (element_1, element_2)) {
2039       res = FALSE;
2040       break;
2041     }
2042
2043     element_1 = element_2;
2044     element_2 = va_arg (args, GstElement *);
2045   }
2046
2047   va_end (args);
2048
2049   return res;
2050 }
2051
2052 /**
2053  * gst_element_link_filtered:
2054  * @src: a #GstElement containing the source pad.
2055  * @dest: (transfer none): the #GstElement containing the destination pad.
2056  * @filter: (transfer none) (allow-none): the #GstCaps to filter the link,
2057  *     or #NULL for no filter.
2058  *
2059  * Links @src to @dest using the given caps as filtercaps.
2060  * The link must be from source to
2061  * destination; the other direction will not be tried. The function looks for
2062  * existing pads that aren't linked yet. It will request new pads if necessary.
2063  * If multiple links are possible, only one is established.
2064  *
2065  * Make sure you have added your elements to a bin or pipeline with
2066  * gst_bin_add() before trying to link them.
2067  *
2068  * Returns: TRUE if the pads could be linked, FALSE otherwise.
2069  */
2070 gboolean
2071 gst_element_link_filtered (GstElement * src, GstElement * dest,
2072     GstCaps * filter)
2073 {
2074   return gst_element_link_pads_filtered (src, NULL, dest, NULL, filter);
2075 }
2076
2077 /**
2078  * gst_element_unlink_pads:
2079  * @src: a (transfer none): #GstElement containing the source pad.
2080  * @srcpadname: the name of the #GstPad in source element.
2081  * @dest: (transfer none): a #GstElement containing the destination pad.
2082  * @destpadname: the name of the #GstPad in destination element.
2083  *
2084  * Unlinks the two named pads of the source and destination elements.
2085  *
2086  * This is a convenience function for gst_pad_unlink().
2087  */
2088 void
2089 gst_element_unlink_pads (GstElement * src, const gchar * srcpadname,
2090     GstElement * dest, const gchar * destpadname)
2091 {
2092   GstPad *srcpad, *destpad;
2093   gboolean srcrequest, destrequest;
2094
2095   srcrequest = destrequest = FALSE;
2096
2097   g_return_if_fail (src != NULL);
2098   g_return_if_fail (GST_IS_ELEMENT (src));
2099   g_return_if_fail (srcpadname != NULL);
2100   g_return_if_fail (dest != NULL);
2101   g_return_if_fail (GST_IS_ELEMENT (dest));
2102   g_return_if_fail (destpadname != NULL);
2103
2104   /* obtain the pads requested */
2105   if (!(srcpad = gst_element_get_static_pad (src, srcpadname)))
2106     if ((srcpad = gst_element_get_request_pad (src, srcpadname)))
2107       srcrequest = TRUE;
2108   if (srcpad == NULL) {
2109     GST_WARNING_OBJECT (src, "source element has no pad \"%s\"", srcpadname);
2110     return;
2111   }
2112   if (!(destpad = gst_element_get_static_pad (dest, destpadname)))
2113     if ((destpad = gst_element_get_request_pad (dest, destpadname)))
2114       destrequest = TRUE;
2115   if (destpad == NULL) {
2116     GST_WARNING_OBJECT (dest, "destination element has no pad \"%s\"",
2117         destpadname);
2118     goto free_src;
2119   }
2120
2121   /* we're satisified they can be unlinked, let's do it */
2122   gst_pad_unlink (srcpad, destpad);
2123
2124   if (destrequest)
2125     gst_element_release_request_pad (dest, destpad);
2126   gst_object_unref (destpad);
2127
2128 free_src:
2129   if (srcrequest)
2130     gst_element_release_request_pad (src, srcpad);
2131   gst_object_unref (srcpad);
2132 }
2133
2134 /**
2135  * gst_element_unlink_many:
2136  * @element_1: (transfer none): the first #GstElement in the link chain.
2137  * @element_2: (transfer none): the second #GstElement in the link chain.
2138  * @...: the NULL-terminated list of elements to unlink in order.
2139  *
2140  * Unlinks a series of elements. Uses gst_element_unlink().
2141  */
2142 void
2143 gst_element_unlink_many (GstElement * element_1, GstElement * element_2, ...)
2144 {
2145   va_list args;
2146
2147   g_return_if_fail (element_1 != NULL && element_2 != NULL);
2148   g_return_if_fail (GST_IS_ELEMENT (element_1) && GST_IS_ELEMENT (element_2));
2149
2150   va_start (args, element_2);
2151
2152   while (element_2) {
2153     gst_element_unlink (element_1, element_2);
2154
2155     element_1 = element_2;
2156     element_2 = va_arg (args, GstElement *);
2157   }
2158
2159   va_end (args);
2160 }
2161
2162 /**
2163  * gst_element_unlink:
2164  * @src: (transfer none): the source #GstElement to unlink.
2165  * @dest: (transfer none): the sink #GstElement to unlink.
2166  *
2167  * Unlinks all source pads of the source element with all sink pads
2168  * of the sink element to which they are linked.
2169  *
2170  * If the link has been made using gst_element_link(), it could have created an
2171  * requestpad, which has to be released using gst_element_release_request_pad().
2172  */
2173 void
2174 gst_element_unlink (GstElement * src, GstElement * dest)
2175 {
2176   GstIterator *pads;
2177   gboolean done = FALSE;
2178   GValue data = { 0, };
2179
2180   g_return_if_fail (GST_IS_ELEMENT (src));
2181   g_return_if_fail (GST_IS_ELEMENT (dest));
2182
2183   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unlinking \"%s\" and \"%s\"",
2184       GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
2185
2186   pads = gst_element_iterate_pads (src);
2187   while (!done) {
2188     switch (gst_iterator_next (pads, &data)) {
2189       case GST_ITERATOR_OK:
2190       {
2191         GstPad *pad = g_value_get_object (&data);
2192
2193         if (GST_PAD_IS_SRC (pad)) {
2194           GstPad *peerpad = gst_pad_get_peer (pad);
2195
2196           /* see if the pad is linked and is really a pad of dest */
2197           if (peerpad) {
2198             GstElement *peerelem;
2199
2200             peerelem = gst_pad_get_parent_element (peerpad);
2201
2202             if (peerelem == dest) {
2203               gst_pad_unlink (pad, peerpad);
2204             }
2205             if (peerelem)
2206               gst_object_unref (peerelem);
2207
2208             gst_object_unref (peerpad);
2209           }
2210         }
2211         g_value_reset (&data);
2212         break;
2213       }
2214       case GST_ITERATOR_RESYNC:
2215         gst_iterator_resync (pads);
2216         break;
2217       case GST_ITERATOR_DONE:
2218         done = TRUE;
2219         break;
2220       default:
2221         g_assert_not_reached ();
2222         break;
2223     }
2224   }
2225   g_value_unset (&data);
2226   gst_iterator_free (pads);
2227 }
2228
2229 /**
2230  * gst_element_query_position:
2231  * @element: a #GstElement to invoke the position query on.
2232  * @format: (inout): a pointer to the #GstFormat asked for.
2233  *          On return contains the #GstFormat used.
2234  * @cur: (out) (allow-none): a location in which to store the current
2235  *     position, or NULL.
2236  *
2237  * Queries an element for the stream position. If one repeatedly calls this
2238  * function one can also create and reuse it in gst_element_query().
2239  *
2240  * Returns: TRUE if the query could be performed.
2241  */
2242 gboolean
2243 gst_element_query_position (GstElement * element, GstFormat * format,
2244     gint64 * cur)
2245 {
2246   GstQuery *query;
2247   gboolean ret;
2248
2249   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2250   g_return_val_if_fail (format != NULL, FALSE);
2251
2252   query = gst_query_new_position (*format);
2253   ret = gst_element_query (element, query);
2254
2255   if (ret)
2256     gst_query_parse_position (query, format, cur);
2257
2258   gst_query_unref (query);
2259
2260   return ret;
2261 }
2262
2263 /**
2264  * gst_element_query_duration:
2265  * @element: a #GstElement to invoke the duration query on.
2266  * @format: (inout): a pointer to the #GstFormat asked for.
2267  *          On return contains the #GstFormat used.
2268  * @duration: (out): A location in which to store the total duration, or NULL.
2269  *
2270  * Queries an element for the total stream duration.
2271  *
2272  * Returns: TRUE if the query could be performed.
2273  */
2274 gboolean
2275 gst_element_query_duration (GstElement * element, GstFormat * format,
2276     gint64 * duration)
2277 {
2278   GstQuery *query;
2279   gboolean ret;
2280
2281   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2282   g_return_val_if_fail (format != NULL, FALSE);
2283
2284   query = gst_query_new_duration (*format);
2285   ret = gst_element_query (element, query);
2286
2287   if (ret)
2288     gst_query_parse_duration (query, format, duration);
2289
2290   gst_query_unref (query);
2291
2292   return ret;
2293 }
2294
2295 /**
2296  * gst_element_query_convert:
2297  * @element: a #GstElement to invoke the convert query on.
2298  * @src_format: (inout): a #GstFormat to convert from.
2299  * @src_val: a value to convert.
2300  * @dest_format: (inout): a pointer to the #GstFormat to convert to.
2301  * @dest_val: (out): a pointer to the result.
2302  *
2303  * Queries an element to convert @src_val in @src_format to @dest_format.
2304  *
2305  * Returns: TRUE if the query could be performed.
2306  */
2307 gboolean
2308 gst_element_query_convert (GstElement * element, GstFormat src_format,
2309     gint64 src_val, GstFormat * dest_format, gint64 * dest_val)
2310 {
2311   GstQuery *query;
2312   gboolean ret;
2313
2314   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2315   g_return_val_if_fail (dest_format != NULL, FALSE);
2316   g_return_val_if_fail (dest_val != NULL, FALSE);
2317
2318   if (*dest_format == src_format || src_val == -1) {
2319     *dest_val = src_val;
2320     return TRUE;
2321   }
2322
2323   query = gst_query_new_convert (src_format, src_val, *dest_format);
2324   ret = gst_element_query (element, query);
2325
2326   if (ret)
2327     gst_query_parse_convert (query, NULL, NULL, dest_format, dest_val);
2328
2329   gst_query_unref (query);
2330
2331   return ret;
2332 }
2333
2334 /**
2335  * gst_element_seek_simple
2336  * @element: a #GstElement to seek on
2337  * @format: a #GstFormat to execute the seek in, such as #GST_FORMAT_TIME
2338  * @seek_flags: seek options; playback applications will usually want to use
2339  *            GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_KEY_UNIT here
2340  * @seek_pos: position to seek to (relative to the start); if you are doing
2341  *            a seek in #GST_FORMAT_TIME this value is in nanoseconds -
2342  *            multiply with #GST_SECOND to convert seconds to nanoseconds or
2343  *            with #GST_MSECOND to convert milliseconds to nanoseconds.
2344  *
2345  * Simple API to perform a seek on the given element, meaning it just seeks
2346  * to the given position relative to the start of the stream. For more complex
2347  * operations like segment seeks (e.g. for looping) or changing the playback
2348  * rate or seeking relative to the last configured playback segment you should
2349  * use gst_element_seek().
2350  *
2351  * In a completely prerolled PAUSED or PLAYING pipeline, seeking is always
2352  * guaranteed to return %TRUE on a seekable media type or %FALSE when the media
2353  * type is certainly not seekable (such as a live stream).
2354  *
2355  * Some elements allow for seeking in the READY state, in this
2356  * case they will store the seek event and execute it when they are put to
2357  * PAUSED. If the element supports seek in READY, it will always return %TRUE when
2358  * it receives the event in the READY state.
2359  *
2360  * Returns: %TRUE if the seek operation succeeded (the seek might not always be
2361  * executed instantly though)
2362  *
2363  * Since: 0.10.7
2364  */
2365 gboolean
2366 gst_element_seek_simple (GstElement * element, GstFormat format,
2367     GstSeekFlags seek_flags, gint64 seek_pos)
2368 {
2369   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2370   g_return_val_if_fail (seek_pos >= 0, FALSE);
2371
2372   return gst_element_seek (element, 1.0, format, seek_flags,
2373       GST_SEEK_TYPE_SET, seek_pos, GST_SEEK_TYPE_NONE, 0);
2374 }
2375
2376 /**
2377  * gst_pad_use_fixed_caps:
2378  * @pad: the pad to use
2379  *
2380  * A helper function you can use that sets the FIXED_CAPS flag
2381  * This way the default getcaps function will always return the negotiated caps
2382  * or in case the pad is not negotiated, the padtemplate caps.
2383  *
2384  * Use this function on a pad that, once gst_pad_set_caps() has been called
2385  * on it, cannot be renegotiated to something else.
2386  */
2387 void
2388 gst_pad_use_fixed_caps (GstPad * pad)
2389 {
2390   GST_OBJECT_FLAG_SET (pad, GST_PAD_FIXED_CAPS);
2391 }
2392
2393 /**
2394  * gst_pad_get_parent_element:
2395  * @pad: a pad
2396  *
2397  * Gets the parent of @pad, cast to a #GstElement. If a @pad has no parent or
2398  * its parent is not an element, return NULL.
2399  *
2400  * Returns: (transfer full): the parent of the pad. The caller has a
2401  * reference on the parent, so unref when you're finished with it.
2402  *
2403  * MT safe.
2404  */
2405 GstElement *
2406 gst_pad_get_parent_element (GstPad * pad)
2407 {
2408   GstObject *p;
2409
2410   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2411
2412   p = gst_object_get_parent (GST_OBJECT_CAST (pad));
2413
2414   if (p && !GST_IS_ELEMENT (p)) {
2415     gst_object_unref (p);
2416     p = NULL;
2417   }
2418   return GST_ELEMENT_CAST (p);
2419 }
2420
2421 /**
2422  * gst_object_default_error:
2423  * @source: the #GstObject that initiated the error.
2424  * @error: (in): the GError.
2425  * @debug: (in) (allow-none): an additional debug information string, or NULL
2426  *
2427  * A default error function.
2428  *
2429  * The default handler will simply print the error string using g_print.
2430  */
2431 void
2432 gst_object_default_error (GstObject * source, const GError * error,
2433     const gchar * debug)
2434 {
2435   gchar *name = gst_object_get_path_string (source);
2436
2437   /* FIXME 0.11: should change this to g_printerr() */
2438   g_print (_("ERROR: from element %s: %s\n"), name, error->message);
2439   if (debug)
2440     g_print (_("Additional debug info:\n%s\n"), debug);
2441
2442   g_free (name);
2443 }
2444
2445 /**
2446  * gst_bin_add_many:
2447  * @bin: a #GstBin
2448  * @element_1: (transfer full): the #GstElement element to add to the bin
2449  * @...: (transfer full): additional elements to add to the bin
2450  *
2451  * Adds a NULL-terminated list of elements to a bin.  This function is
2452  * equivalent to calling gst_bin_add() for each member of the list. The return
2453  * value of each gst_bin_add() is ignored.
2454  */
2455 void
2456 gst_bin_add_many (GstBin * bin, GstElement * element_1, ...)
2457 {
2458   va_list args;
2459
2460   g_return_if_fail (GST_IS_BIN (bin));
2461   g_return_if_fail (GST_IS_ELEMENT (element_1));
2462
2463   va_start (args, element_1);
2464
2465   while (element_1) {
2466     gst_bin_add (bin, element_1);
2467
2468     element_1 = va_arg (args, GstElement *);
2469   }
2470
2471   va_end (args);
2472 }
2473
2474 /**
2475  * gst_bin_remove_many:
2476  * @bin: a #GstBin
2477  * @element_1: (transfer none): the first #GstElement to remove from the bin
2478  * @...: (transfer none): NULL-terminated list of elements to remove from the bin
2479  *
2480  * Remove a list of elements from a bin. This function is equivalent
2481  * to calling gst_bin_remove() with each member of the list.
2482  */
2483 void
2484 gst_bin_remove_many (GstBin * bin, GstElement * element_1, ...)
2485 {
2486   va_list args;
2487
2488   g_return_if_fail (GST_IS_BIN (bin));
2489   g_return_if_fail (GST_IS_ELEMENT (element_1));
2490
2491   va_start (args, element_1);
2492
2493   while (element_1) {
2494     gst_bin_remove (bin, element_1);
2495
2496     element_1 = va_arg (args, GstElement *);
2497   }
2498
2499   va_end (args);
2500 }
2501
2502 static void
2503 gst_element_populate_std_props (GObjectClass * klass, const gchar * prop_name,
2504     guint arg_id, GParamFlags flags)
2505 {
2506   GQuark prop_id = g_quark_from_string (prop_name);
2507   GParamSpec *pspec;
2508
2509   static GQuark fd_id = 0;
2510   static GQuark blocksize_id;
2511   static GQuark bytesperread_id;
2512   static GQuark dump_id;
2513   static GQuark filesize_id;
2514   static GQuark mmapsize_id;
2515   static GQuark location_id;
2516   static GQuark offset_id;
2517   static GQuark silent_id;
2518   static GQuark touch_id;
2519
2520   flags |= G_PARAM_STATIC_STRINGS;
2521
2522   if (!fd_id) {
2523     fd_id = g_quark_from_static_string ("fd");
2524     blocksize_id = g_quark_from_static_string ("blocksize");
2525     bytesperread_id = g_quark_from_static_string ("bytesperread");
2526     dump_id = g_quark_from_static_string ("dump");
2527     filesize_id = g_quark_from_static_string ("filesize");
2528     mmapsize_id = g_quark_from_static_string ("mmapsize");
2529     location_id = g_quark_from_static_string ("location");
2530     offset_id = g_quark_from_static_string ("offset");
2531     silent_id = g_quark_from_static_string ("silent");
2532     touch_id = g_quark_from_static_string ("touch");
2533   }
2534
2535   if (prop_id == fd_id) {
2536     pspec = g_param_spec_int ("fd", "File-descriptor",
2537         "File-descriptor for the file being read", 0, G_MAXINT, 0, flags);
2538   } else if (prop_id == blocksize_id) {
2539     pspec = g_param_spec_ulong ("blocksize", "Block Size",
2540         "Block size to read per buffer", 0, G_MAXULONG, 4096, flags);
2541
2542   } else if (prop_id == bytesperread_id) {
2543     pspec = g_param_spec_int ("bytesperread", "Bytes per read",
2544         "Number of bytes to read per buffer", G_MININT, G_MAXINT, 0, flags);
2545
2546   } else if (prop_id == dump_id) {
2547     pspec = g_param_spec_boolean ("dump", "Dump",
2548         "Dump bytes to stdout", FALSE, flags);
2549
2550   } else if (prop_id == filesize_id) {
2551     pspec = g_param_spec_int64 ("filesize", "File Size",
2552         "Size of the file being read", 0, G_MAXINT64, 0, flags);
2553
2554   } else if (prop_id == mmapsize_id) {
2555     pspec = g_param_spec_ulong ("mmapsize", "mmap() Block Size",
2556         "Size in bytes of mmap()d regions", 0, G_MAXULONG, 4 * 1048576, flags);
2557
2558   } else if (prop_id == location_id) {
2559     pspec = g_param_spec_string ("location", "File Location",
2560         "Location of the file to read", NULL, flags);
2561
2562   } else if (prop_id == offset_id) {
2563     pspec = g_param_spec_int64 ("offset", "File Offset",
2564         "Byte offset of current read pointer", 0, G_MAXINT64, 0, flags);
2565
2566   } else if (prop_id == silent_id) {
2567     pspec = g_param_spec_boolean ("silent", "Silent", "Don't produce events",
2568         FALSE, flags);
2569
2570   } else if (prop_id == touch_id) {
2571     pspec = g_param_spec_boolean ("touch", "Touch read data",
2572         "Touch data to force disk read before " "push ()", TRUE, flags);
2573   } else {
2574     g_warning ("Unknown - 'standard' property '%s' id %d from klass %s",
2575         prop_name, arg_id, g_type_name (G_OBJECT_CLASS_TYPE (klass)));
2576     pspec = NULL;
2577   }
2578
2579   if (pspec) {
2580     g_object_class_install_property (klass, arg_id, pspec);
2581   }
2582 }
2583
2584 /**
2585  * gst_element_class_install_std_props:
2586  * @klass: the #GstElementClass to add the properties to.
2587  * @first_name: the name of the first property.
2588  * in a NULL terminated
2589  * @...: the id and flags of the first property, followed by
2590  * further 'name', 'id', 'flags' triplets and terminated by NULL.
2591  *
2592  * Adds a list of standardized properties with types to the @klass.
2593  * the id is for the property switch in your get_prop method, and
2594  * the flags determine readability / writeability.
2595  **/
2596 void
2597 gst_element_class_install_std_props (GstElementClass * klass,
2598     const gchar * first_name, ...)
2599 {
2600   const char *name;
2601
2602   va_list args;
2603
2604   g_return_if_fail (GST_IS_ELEMENT_CLASS (klass));
2605
2606   va_start (args, first_name);
2607
2608   name = first_name;
2609
2610   while (name) {
2611     int arg_id = va_arg (args, int);
2612     int flags = va_arg (args, int);
2613
2614     gst_element_populate_std_props ((GObjectClass *) klass, name, arg_id,
2615         flags);
2616
2617     name = va_arg (args, char *);
2618   }
2619
2620   va_end (args);
2621 }
2622
2623
2624 /**
2625  * gst_buffer_merge:
2626  * @buf1: (transfer none): the first source #GstBuffer to merge.
2627  * @buf2: (transfer none): the second source #GstBuffer to merge.
2628  *
2629  * Create a new buffer that is the concatenation of the two source
2630  * buffers.  The original source buffers will not be modified or
2631  * unref'd.  Make sure you unref the source buffers if they are not used
2632  * anymore afterwards.
2633  *
2634  * If the buffers point to contiguous areas of memory, the buffer
2635  * is created without copying the data.
2636  *
2637  * Free-function: gst_buffer_unref
2638  *
2639  * Returns: (transfer full): the new #GstBuffer which is the concatenation
2640  *     of the source buffers.
2641  */
2642 GstBuffer *
2643 gst_buffer_merge (GstBuffer * buf1, GstBuffer * buf2)
2644 {
2645   GstBuffer *result;
2646   gsize size1, size2;
2647
2648   size1 = gst_buffer_get_size (buf1);
2649   size2 = gst_buffer_get_size (buf2);
2650
2651   /* we're just a specific case of the more general gst_buffer_span() */
2652   result = gst_buffer_span (buf1, 0, buf2, size1 + size2);
2653
2654   return result;
2655 }
2656
2657 /**
2658  * gst_buffer_join:
2659  * @buf1: the first source #GstBuffer.
2660  * @buf2: the second source #GstBuffer.
2661  *
2662  * Create a new buffer that is the concatenation of the two source
2663  * buffers, and unrefs the original source buffers.
2664  *
2665  * If the buffers point to contiguous areas of memory, the buffer
2666  * is created without copying the data.
2667  *
2668  * This is a convenience function for C programmers. See also
2669  * gst_buffer_merge(), which does the same thing without
2670  * unreffing the input parameters. Language bindings without
2671  * explicit reference counting should not wrap this function.
2672  *
2673  * Returns: (transfer full): the new #GstBuffer which is the concatenation of
2674  * the source buffers.
2675  */
2676 GstBuffer *
2677 gst_buffer_join (GstBuffer * buf1, GstBuffer * buf2)
2678 {
2679   GstBuffer *result;
2680   gsize size1, size2;
2681
2682   size1 = gst_buffer_get_size (buf1);
2683   size2 = gst_buffer_get_size (buf2);
2684
2685   result = gst_buffer_span (buf1, 0, buf2, size1 + size2);
2686   gst_buffer_unref (buf1);
2687   gst_buffer_unref (buf2);
2688
2689   return result;
2690 }
2691
2692
2693 static gboolean
2694 getcaps_fold_func (const GValue * vpad, GValue * ret, GstPad * orig)
2695 {
2696   GstPad *pad = g_value_get_object (vpad);
2697   gboolean empty = FALSE;
2698   GstCaps *peercaps, *existing;
2699
2700   existing = g_value_get_pointer (ret);
2701   peercaps = gst_pad_peer_get_caps (pad);
2702   if (G_LIKELY (peercaps)) {
2703     GstCaps *intersection = gst_caps_intersect (existing, peercaps);
2704
2705     empty = gst_caps_is_empty (intersection);
2706
2707     g_value_set_pointer (ret, intersection);
2708     gst_caps_unref (existing);
2709     gst_caps_unref (peercaps);
2710   }
2711   return !empty;
2712 }
2713
2714 /**
2715  * gst_pad_proxy_getcaps:
2716  * @pad: a #GstPad to proxy.
2717  *
2718  * Calls gst_pad_get_allowed_caps() for every other pad belonging to the
2719  * same element as @pad, and returns the intersection of the results.
2720  *
2721  * This function is useful as a default getcaps function for an element
2722  * that can handle any stream format, but requires all its pads to have
2723  * the same caps.  Two such elements are tee and adder.
2724  *
2725  * Free-function: gst_caps_unref
2726  *
2727  * Returns: (transfer full): the intersection of the other pads' allowed caps.
2728  */
2729 GstCaps *
2730 gst_pad_proxy_getcaps (GstPad * pad)
2731 {
2732   GstElement *element;
2733   GstCaps *caps, *intersected;
2734   GstIterator *iter;
2735   GstIteratorResult res;
2736   GValue ret = { 0, };
2737
2738   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2739
2740   GST_CAT_DEBUG (GST_CAT_PADS, "proxying getcaps for %s:%s",
2741       GST_DEBUG_PAD_NAME (pad));
2742
2743   element = gst_pad_get_parent_element (pad);
2744   if (element == NULL)
2745     goto no_parent;
2746
2747   /* value to hold the return, by default it holds ANY, the ref is taken by
2748    * the GValue. */
2749   g_value_init (&ret, G_TYPE_POINTER);
2750   g_value_set_pointer (&ret, gst_caps_new_any ());
2751
2752   /* only iterate the pads in the oposite direction */
2753   if (GST_PAD_IS_SRC (pad))
2754     iter = gst_element_iterate_sink_pads (element);
2755   else
2756     iter = gst_element_iterate_src_pads (element);
2757
2758   while (1) {
2759     res =
2760         gst_iterator_fold (iter, (GstIteratorFoldFunction) getcaps_fold_func,
2761         &ret, pad);
2762     switch (res) {
2763       case GST_ITERATOR_RESYNC:
2764         /* unref any value stored */
2765         if ((caps = g_value_get_pointer (&ret)))
2766           gst_caps_unref (caps);
2767         /* need to reset the result again to ANY */
2768         g_value_set_pointer (&ret, gst_caps_new_any ());
2769         gst_iterator_resync (iter);
2770         break;
2771       case GST_ITERATOR_DONE:
2772         /* all pads iterated, return collected value */
2773         goto done;
2774       case GST_ITERATOR_OK:
2775         /* premature exit (happens if caps intersection is empty) */
2776         goto done;
2777       default:
2778         /* iterator returned _ERROR, mark an error and exit */
2779         if ((caps = g_value_get_pointer (&ret)))
2780           gst_caps_unref (caps);
2781         g_value_set_pointer (&ret, NULL);
2782         goto error;
2783     }
2784   }
2785 done:
2786   gst_iterator_free (iter);
2787
2788   gst_object_unref (element);
2789
2790   caps = g_value_get_pointer (&ret);
2791   g_value_unset (&ret);
2792
2793   if (caps) {
2794     intersected =
2795         gst_caps_intersect (caps, gst_pad_get_pad_template_caps (pad));
2796     gst_caps_unref (caps);
2797   } else {
2798     intersected = gst_caps_copy (gst_pad_get_pad_template_caps (pad));
2799   }
2800
2801   return intersected;
2802
2803   /* ERRORS */
2804 no_parent:
2805   {
2806     GST_DEBUG_OBJECT (pad, "no parent");
2807     return gst_caps_copy (gst_pad_get_pad_template_caps (pad));
2808   }
2809 error:
2810   {
2811     g_warning ("Pad list returned error on element %s",
2812         GST_ELEMENT_NAME (element));
2813     gst_iterator_free (iter);
2814     gst_object_unref (element);
2815     return gst_caps_copy (gst_pad_get_pad_template_caps (pad));
2816   }
2817 }
2818
2819 typedef struct
2820 {
2821   GstPad *orig;
2822   GstCaps *caps;
2823 } SetCapsFoldData;
2824
2825 static gboolean
2826 setcaps_fold_func (const GValue * vpad, GValue * ret, SetCapsFoldData * data)
2827 {
2828   gboolean success = TRUE;
2829   GstPad *pad = g_value_get_object (vpad);
2830
2831   if (pad != data->orig) {
2832     success = gst_pad_set_caps (pad, data->caps);
2833     g_value_set_boolean (ret, success);
2834   }
2835
2836   return success;
2837 }
2838
2839 /**
2840  * gst_pad_proxy_setcaps
2841  * @pad: a #GstPad to proxy from
2842  * @caps: (transfer none): the #GstCaps to link with
2843  *
2844  * Calls gst_pad_set_caps() for every other pad belonging to the
2845  * same element as @pad.  If gst_pad_set_caps() fails on any pad,
2846  * the proxy setcaps fails. May be used only during negotiation.
2847  *
2848  * Returns: TRUE if sucessful
2849  */
2850 gboolean
2851 gst_pad_proxy_setcaps (GstPad * pad, GstCaps * caps)
2852 {
2853   GstElement *element;
2854   GstIterator *iter;
2855   GstIteratorResult res;
2856   GValue ret = { 0, };
2857   SetCapsFoldData data;
2858
2859   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2860   g_return_val_if_fail (caps != NULL, FALSE);
2861
2862   GST_CAT_DEBUG (GST_CAT_PADS, "proxying pad link for %s:%s",
2863       GST_DEBUG_PAD_NAME (pad));
2864
2865   element = gst_pad_get_parent_element (pad);
2866   if (element == NULL)
2867     return FALSE;
2868
2869   /* only iterate the pads in the oposite direction */
2870   if (GST_PAD_IS_SRC (pad))
2871     iter = gst_element_iterate_sink_pads (element);
2872   else
2873     iter = gst_element_iterate_src_pads (element);
2874
2875   g_value_init (&ret, G_TYPE_BOOLEAN);
2876   g_value_set_boolean (&ret, TRUE);
2877   data.orig = pad;
2878   data.caps = caps;
2879
2880   while (1) {
2881     res = gst_iterator_fold (iter, (GstIteratorFoldFunction) setcaps_fold_func,
2882         &ret, &data);
2883
2884     switch (res) {
2885       case GST_ITERATOR_RESYNC:
2886         /* reset return value */
2887         g_value_set_boolean (&ret, TRUE);
2888         gst_iterator_resync (iter);
2889         break;
2890       case GST_ITERATOR_DONE:
2891         /* all pads iterated, return collected value */
2892         goto done;
2893       default:
2894         /* iterator returned _ERROR or premature end with _OK,
2895          * mark an error and exit */
2896         goto error;
2897     }
2898   }
2899 done:
2900   gst_iterator_free (iter);
2901
2902   gst_object_unref (element);
2903
2904   /* ok not to unset the gvalue */
2905   return g_value_get_boolean (&ret);
2906
2907   /* ERRORS */
2908 error:
2909   {
2910     g_warning ("Pad list return error on element %s",
2911         GST_ELEMENT_NAME (element));
2912     gst_iterator_free (iter);
2913     gst_object_unref (element);
2914     return FALSE;
2915   }
2916 }
2917
2918 /**
2919  * gst_pad_query_position:
2920  * @pad: a #GstPad to invoke the position query on.
2921  * @format: (inout): a pointer to the #GstFormat asked for.
2922  *          On return contains the #GstFormat used.
2923  * @cur: (out): A location in which to store the current position, or NULL.
2924  *
2925  * Queries a pad for the stream position.
2926  *
2927  * Returns: TRUE if the query could be performed.
2928  */
2929 gboolean
2930 gst_pad_query_position (GstPad * pad, GstFormat * format, gint64 * cur)
2931 {
2932   GstQuery *query;
2933   gboolean ret;
2934
2935   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2936   g_return_val_if_fail (format != NULL, FALSE);
2937
2938   query = gst_query_new_position (*format);
2939   ret = gst_pad_query (pad, query);
2940
2941   if (ret)
2942     gst_query_parse_position (query, format, cur);
2943
2944   gst_query_unref (query);
2945
2946   return ret;
2947 }
2948
2949 /**
2950  * gst_pad_query_peer_position:
2951  * @pad: a #GstPad on whose peer to invoke the position query on.
2952  *       Must be a sink pad.
2953  * @format: (inout): a pointer to the #GstFormat asked for.
2954  *          On return contains the #GstFormat used.
2955  * @cur: (out) (allow-none): a location in which to store the current
2956  *     position, or NULL.
2957  *
2958  * Queries the peer of a given sink pad for the stream position.
2959  *
2960  * Returns: TRUE if the query could be performed.
2961  */
2962 gboolean
2963 gst_pad_query_peer_position (GstPad * pad, GstFormat * format, gint64 * cur)
2964 {
2965   gboolean ret = FALSE;
2966   GstPad *peer;
2967
2968   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2969   g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2970   g_return_val_if_fail (format != NULL, FALSE);
2971
2972   peer = gst_pad_get_peer (pad);
2973   if (peer) {
2974     ret = gst_pad_query_position (peer, format, cur);
2975     gst_object_unref (peer);
2976   }
2977
2978   return ret;
2979 }
2980
2981 /**
2982  * gst_pad_query_duration:
2983  * @pad: a #GstPad to invoke the duration query on.
2984  * @format: (inout): a pointer to the #GstFormat asked for.
2985  *          On return contains the #GstFormat used.
2986  * @duration: (out) (allow-none): a location in which to store the total
2987  *     duration, or NULL.
2988  *
2989  * Queries a pad for the total stream duration.
2990  *
2991  * Returns: TRUE if the query could be performed.
2992  */
2993 gboolean
2994 gst_pad_query_duration (GstPad * pad, GstFormat * format, gint64 * duration)
2995 {
2996   GstQuery *query;
2997   gboolean ret;
2998
2999   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3000   g_return_val_if_fail (format != NULL, FALSE);
3001
3002   query = gst_query_new_duration (*format);
3003   ret = gst_pad_query (pad, query);
3004
3005   if (ret)
3006     gst_query_parse_duration (query, format, duration);
3007
3008   gst_query_unref (query);
3009
3010   return ret;
3011 }
3012
3013 /**
3014  * gst_pad_query_peer_duration:
3015  * @pad: a #GstPad on whose peer pad to invoke the duration query on.
3016  *       Must be a sink pad.
3017  * @format: (inout) :a pointer to the #GstFormat asked for.
3018  *          On return contains the #GstFormat used.
3019  * @duration: (out) (allow-none): a location in which to store the total
3020  *     duration, or NULL.
3021  *
3022  * Queries the peer pad of a given sink pad for the total stream duration.
3023  *
3024  * Returns: TRUE if the query could be performed.
3025  */
3026 gboolean
3027 gst_pad_query_peer_duration (GstPad * pad, GstFormat * format,
3028     gint64 * duration)
3029 {
3030   gboolean ret = FALSE;
3031   GstPad *peer;
3032
3033   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3034   g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
3035   g_return_val_if_fail (format != NULL, FALSE);
3036
3037   peer = gst_pad_get_peer (pad);
3038   if (peer) {
3039     ret = gst_pad_query_duration (peer, format, duration);
3040     gst_object_unref (peer);
3041   }
3042
3043   return ret;
3044 }
3045
3046 /**
3047  * gst_pad_query_convert:
3048  * @pad: a #GstPad to invoke the convert query on.
3049  * @src_format: a #GstFormat to convert from.
3050  * @src_val: a value to convert.
3051  * @dest_format: (inout): a pointer to the #GstFormat to convert to.
3052  * @dest_val: (out): a pointer to the result.
3053  *
3054  * Queries a pad to convert @src_val in @src_format to @dest_format.
3055  *
3056  * Returns: TRUE if the query could be performed.
3057  */
3058 gboolean
3059 gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
3060     GstFormat * dest_format, gint64 * dest_val)
3061 {
3062   GstQuery *query;
3063   gboolean ret;
3064
3065   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3066   g_return_val_if_fail (dest_format != NULL, FALSE);
3067   g_return_val_if_fail (dest_val != NULL, FALSE);
3068
3069   if (*dest_format == src_format || src_val == -1) {
3070     *dest_val = src_val;
3071     return TRUE;
3072   }
3073
3074   query = gst_query_new_convert (src_format, src_val, *dest_format);
3075   ret = gst_pad_query (pad, query);
3076
3077   if (ret)
3078     gst_query_parse_convert (query, NULL, NULL, dest_format, dest_val);
3079
3080   gst_query_unref (query);
3081
3082   return ret;
3083 }
3084
3085 /**
3086  * gst_pad_query_peer_convert:
3087  * @pad: a #GstPad, on whose peer pad to invoke the convert query on.
3088  *       Must be a sink pad.
3089  * @src_format: a #GstFormat to convert from.
3090  * @src_val: a value to convert.
3091  * @dest_format: (inout): a pointer to the #GstFormat to convert to.
3092  * @dest_val: (out): a pointer to the result.
3093  *
3094  * Queries the peer pad of a given sink pad to convert @src_val in @src_format
3095  * to @dest_format.
3096  *
3097  * Returns: TRUE if the query could be performed.
3098  */
3099 gboolean
3100 gst_pad_query_peer_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
3101     GstFormat * dest_format, gint64 * dest_val)
3102 {
3103   gboolean ret = FALSE;
3104   GstPad *peer;
3105
3106   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3107   g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
3108   g_return_val_if_fail (dest_format != NULL, FALSE);
3109   g_return_val_if_fail (dest_val != NULL, FALSE);
3110
3111   peer = gst_pad_get_peer (pad);
3112   if (peer) {
3113     ret = gst_pad_query_convert (peer, src_format, src_val, dest_format,
3114         dest_val);
3115     gst_object_unref (peer);
3116   }
3117
3118   return ret;
3119 }
3120
3121 /**
3122  * gst_pad_add_data_probe:
3123  * @pad: pad to add the data probe handler to
3124  * @handler: function to call when data is passed over pad
3125  * @data: (closure): data to pass along with the handler
3126  *
3127  * Adds a "data probe" to a pad. This function will be called whenever data
3128  * passes through a pad. In this case data means both events and buffers. The
3129  * probe will be called with the data as an argument, meaning @handler should
3130  * have the same callback signature as the #GstPad::have-data signal.
3131  * Note that the data will have a reference count greater than 1, so it will
3132  * be immutable -- you must not change it.
3133  *
3134  * For source pads, the probe will be called after the blocking function, if any
3135  * (see gst_pad_set_blocked_async()), but before looking up the peer to chain
3136  * to. For sink pads, the probe function will be called before configuring the
3137  * sink with new caps, if any, and before calling the pad's chain function.
3138  *
3139  * Your data probe should return TRUE to let the data continue to flow, or FALSE
3140  * to drop it. Dropping data is rarely useful, but occasionally comes in handy
3141  * with events.
3142  *
3143  * Although probes are implemented internally by connecting @handler to the
3144  * have-data signal on the pad, if you want to remove a probe it is insufficient
3145  * to only call g_signal_handler_disconnect on the returned handler id. To
3146  * remove a probe, use the appropriate function, such as
3147  * gst_pad_remove_data_probe().
3148  *
3149  * Returns: The handler id.
3150  */
3151 gulong
3152 gst_pad_add_data_probe (GstPad * pad, GCallback handler, gpointer data)
3153 {
3154   return gst_pad_add_data_probe_full (pad, handler, data, NULL);
3155 }
3156
3157 /**
3158  * gst_pad_add_data_probe_full:
3159  * @pad: pad to add the data probe handler to
3160  * @handler: function to call when data is passed over pad
3161  * @data: (closure): data to pass along with the handler
3162  * @notify: (allow-none): function to call when the probe is disconnected,
3163  *     or NULL
3164  *
3165  * Adds a "data probe" to a pad. This function will be called whenever data
3166  * passes through a pad. In this case data means both events and buffers. The
3167  * probe will be called with the data as an argument, meaning @handler should
3168  * have the same callback signature as the #GstPad::have-data signal.
3169  * Note that the data will have a reference count greater than 1, so it will
3170  * be immutable -- you must not change it.
3171  *
3172  * For source pads, the probe will be called after the blocking function, if any
3173  * (see gst_pad_set_blocked_async()), but before looking up the peer to chain
3174  * to. For sink pads, the probe function will be called before configuring the
3175  * sink with new caps, if any, and before calling the pad's chain function.
3176  *
3177  * Your data probe should return TRUE to let the data continue to flow, or FALSE
3178  * to drop it. Dropping data is rarely useful, but occasionally comes in handy
3179  * with events.
3180  *
3181  * Although probes are implemented internally by connecting @handler to the
3182  * have-data signal on the pad, if you want to remove a probe it is insufficient
3183  * to only call g_signal_handler_disconnect on the returned handler id. To
3184  * remove a probe, use the appropriate function, such as
3185  * gst_pad_remove_data_probe().
3186  *
3187  * The @notify function is called when the probe is disconnected and usually
3188  * used to free @data.
3189  *
3190  * Returns: The handler id.
3191  *
3192  * Since: 0.10.20
3193  */
3194 gulong
3195 gst_pad_add_data_probe_full (GstPad * pad, GCallback handler,
3196     gpointer data, GDestroyNotify notify)
3197 {
3198   gulong sigid;
3199
3200   g_return_val_if_fail (GST_IS_PAD (pad), 0);
3201   g_return_val_if_fail (handler != NULL, 0);
3202
3203   GST_OBJECT_LOCK (pad);
3204
3205   /* we only expose a GDestroyNotify in our API because that's less confusing */
3206   sigid = g_signal_connect_data (pad, "have-data", handler, data,
3207       (GClosureNotify) notify, 0);
3208
3209   GST_PAD_DO_EVENT_SIGNALS (pad)++;
3210   GST_PAD_DO_BUFFER_SIGNALS (pad)++;
3211   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
3212       "adding data probe, now %d data, %d event probes",
3213       GST_PAD_DO_BUFFER_SIGNALS (pad), GST_PAD_DO_EVENT_SIGNALS (pad));
3214   _priv_gst_pad_invalidate_cache (pad);
3215   GST_OBJECT_UNLOCK (pad);
3216
3217   return sigid;
3218 }
3219
3220 /**
3221  * gst_pad_add_event_probe:
3222  * @pad: pad to add the event probe handler to
3223  * @handler: function to call when events are passed over pad
3224  * @data: (closure): data to pass along with the handler
3225  *
3226  * Adds a probe that will be called for all events passing through a pad. See
3227  * gst_pad_add_data_probe() for more information.
3228  *
3229  * Returns: The handler id
3230  */
3231 gulong
3232 gst_pad_add_event_probe (GstPad * pad, GCallback handler, gpointer data)
3233 {
3234   return gst_pad_add_event_probe_full (pad, handler, data, NULL);
3235 }
3236
3237 /**
3238  * gst_pad_add_event_probe_full:
3239  * @pad: pad to add the event probe handler to
3240  * @handler: function to call when events are passed over pad
3241  * @data: (closure): data to pass along with the handler, or NULL
3242  * @notify: (allow-none): function to call when probe is disconnected, or NULL
3243  *
3244  * Adds a probe that will be called for all events passing through a pad. See
3245  * gst_pad_add_data_probe() for more information.
3246  *
3247  * The @notify function is called when the probe is disconnected and usually
3248  * used to free @data.
3249  *
3250  * Returns: The handler id
3251  *
3252  * Since: 0.10.20
3253  */
3254 gulong
3255 gst_pad_add_event_probe_full (GstPad * pad, GCallback handler,
3256     gpointer data, GDestroyNotify notify)
3257 {
3258   gulong sigid;
3259
3260   g_return_val_if_fail (GST_IS_PAD (pad), 0);
3261   g_return_val_if_fail (handler != NULL, 0);
3262
3263   GST_OBJECT_LOCK (pad);
3264
3265   /* we only expose a GDestroyNotify in our API because that's less confusing */
3266   sigid = g_signal_connect_data (pad, "have-data::event", handler, data,
3267       (GClosureNotify) notify, 0);
3268
3269   GST_PAD_DO_EVENT_SIGNALS (pad)++;
3270   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "adding event probe, now %d probes",
3271       GST_PAD_DO_EVENT_SIGNALS (pad));
3272   _priv_gst_pad_invalidate_cache (pad);
3273   GST_OBJECT_UNLOCK (pad);
3274
3275   return sigid;
3276 }
3277
3278 /**
3279  * gst_pad_add_buffer_probe:
3280  * @pad: pad to add the buffer probe handler to
3281  * @handler: function to call when buffers are passed over pad
3282  * @data: (closure): data to pass along with the handler
3283  *
3284  * Adds a probe that will be called for all buffers passing through a pad. See
3285  * gst_pad_add_data_probe() for more information.
3286  *
3287  * Returns: The handler id
3288  */
3289 gulong
3290 gst_pad_add_buffer_probe (GstPad * pad, GCallback handler, gpointer data)
3291 {
3292   return gst_pad_add_buffer_probe_full (pad, handler, data, NULL);
3293 }
3294
3295 /**
3296  * gst_pad_add_buffer_probe_full:
3297  * @pad: pad to add the buffer probe handler to
3298  * @handler: function to call when buffer are passed over pad
3299  * @data: (closure): data to pass along with the handler
3300  * @notify: (allow-none): function to call when the probe is disconnected,
3301  *     or NULL
3302  *
3303  * Adds a probe that will be called for all buffers passing through a pad. See
3304  * gst_pad_add_data_probe() for more information.
3305  *
3306  * The @notify function is called when the probe is disconnected and usually
3307  * used to free @data.
3308  *
3309  * Returns: The handler id
3310  *
3311  * Since: 0.10.20
3312  */
3313 gulong
3314 gst_pad_add_buffer_probe_full (GstPad * pad, GCallback handler,
3315     gpointer data, GDestroyNotify notify)
3316 {
3317   gulong sigid;
3318
3319   g_return_val_if_fail (GST_IS_PAD (pad), 0);
3320   g_return_val_if_fail (handler != NULL, 0);
3321
3322   GST_OBJECT_LOCK (pad);
3323
3324   /* we only expose a GDestroyNotify in our API because that's less confusing */
3325   sigid = g_signal_connect_data (pad, "have-data::buffer", handler, data,
3326       (GClosureNotify) notify, 0);
3327
3328   GST_PAD_DO_BUFFER_SIGNALS (pad)++;
3329   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "adding buffer probe, now %d probes",
3330       GST_PAD_DO_BUFFER_SIGNALS (pad));
3331   _priv_gst_pad_invalidate_cache (pad);
3332   GST_OBJECT_UNLOCK (pad);
3333
3334   return sigid;
3335 }
3336
3337 /**
3338  * gst_pad_remove_data_probe:
3339  * @pad: pad to remove the data probe handler from
3340  * @handler_id: handler id returned from gst_pad_add_data_probe
3341  *
3342  * Removes a data probe from @pad.
3343  */
3344 void
3345 gst_pad_remove_data_probe (GstPad * pad, guint handler_id)
3346 {
3347   g_return_if_fail (GST_IS_PAD (pad));
3348   g_return_if_fail (handler_id > 0);
3349
3350   GST_OBJECT_LOCK (pad);
3351   g_signal_handler_disconnect (pad, handler_id);
3352   GST_PAD_DO_BUFFER_SIGNALS (pad)--;
3353   GST_PAD_DO_EVENT_SIGNALS (pad)--;
3354   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
3355       "removed data probe, now %d event, %d buffer probes",
3356       GST_PAD_DO_EVENT_SIGNALS (pad), GST_PAD_DO_BUFFER_SIGNALS (pad));
3357   GST_OBJECT_UNLOCK (pad);
3358
3359 }
3360
3361 /**
3362  * gst_pad_remove_event_probe:
3363  * @pad: pad to remove the event probe handler from
3364  * @handler_id: handler id returned from gst_pad_add_event_probe
3365  *
3366  * Removes an event probe from @pad.
3367  */
3368 void
3369 gst_pad_remove_event_probe (GstPad * pad, guint handler_id)
3370 {
3371   g_return_if_fail (GST_IS_PAD (pad));
3372   g_return_if_fail (handler_id > 0);
3373
3374   GST_OBJECT_LOCK (pad);
3375   g_signal_handler_disconnect (pad, handler_id);
3376   GST_PAD_DO_EVENT_SIGNALS (pad)--;
3377   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
3378       "removed event probe, now %d event probes",
3379       GST_PAD_DO_EVENT_SIGNALS (pad));
3380   GST_OBJECT_UNLOCK (pad);
3381 }
3382
3383 /**
3384  * gst_pad_remove_buffer_probe:
3385  * @pad: pad to remove the buffer probe handler from
3386  * @handler_id: handler id returned from gst_pad_add_buffer_probe
3387  *
3388  * Removes a buffer probe from @pad.
3389  */
3390 void
3391 gst_pad_remove_buffer_probe (GstPad * pad, guint handler_id)
3392 {
3393   g_return_if_fail (GST_IS_PAD (pad));
3394   g_return_if_fail (handler_id > 0);
3395
3396   GST_OBJECT_LOCK (pad);
3397   g_signal_handler_disconnect (pad, handler_id);
3398   GST_PAD_DO_BUFFER_SIGNALS (pad)--;
3399   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
3400       "removed buffer probe, now %d buffer probes",
3401       GST_PAD_DO_BUFFER_SIGNALS (pad));
3402   GST_OBJECT_UNLOCK (pad);
3403
3404 }
3405
3406 /**
3407  * gst_element_found_tags_for_pad:
3408  * @element: element for which to post taglist to bus.
3409  * @pad: (transfer none): pad on which to push tag-event
3410  * @list: (transfer full): the taglist to post on the bus and create event from
3411  *
3412  * Posts a message to the bus that new tags were found and pushes the
3413  * tags as event. Takes ownership of the @list.
3414  *
3415  * This is a utility method for elements. Applications should use the
3416  * #GstTagSetter interface.
3417  */
3418 void
3419 gst_element_found_tags_for_pad (GstElement * element,
3420     GstPad * pad, GstTagList * list)
3421 {
3422   g_return_if_fail (element != NULL);
3423   g_return_if_fail (pad != NULL);
3424   g_return_if_fail (list != NULL);
3425
3426   gst_pad_push_event (pad, gst_event_new_tag (gst_tag_list_copy (list)));
3427   /* FIXME 0.11: Set the pad as source. */
3428   gst_element_post_message (element,
3429       gst_message_new_tag_full (GST_OBJECT (element), pad, list));
3430 }
3431
3432 static void
3433 push_and_ref (const GValue * vpad, GstEvent * event)
3434 {
3435   GstPad *pad = g_value_get_object (vpad);
3436
3437   gst_pad_push_event (pad, gst_event_ref (event));
3438 }
3439
3440 /**
3441  * gst_element_found_tags:
3442  * @element: element for which we found the tags.
3443  * @list: (transfer full): list of tags.
3444  *
3445  * Posts a message to the bus that new tags were found, and pushes an event
3446  * to all sourcepads. Takes ownership of the @list.
3447  *
3448  * This is a utility method for elements. Applications should use the
3449  * #GstTagSetter interface.
3450  */
3451 void
3452 gst_element_found_tags (GstElement * element, GstTagList * list)
3453 {
3454   GstIterator *iter;
3455   GstEvent *event;
3456
3457   g_return_if_fail (element != NULL);
3458   g_return_if_fail (list != NULL);
3459
3460   iter = gst_element_iterate_src_pads (element);
3461   event = gst_event_new_tag (gst_tag_list_copy (list));
3462   gst_iterator_foreach (iter, (GstIteratorForeachFunction) push_and_ref, event);
3463   gst_iterator_free (iter);
3464   gst_event_unref (event);
3465
3466   gst_element_post_message (element,
3467       gst_message_new_tag (GST_OBJECT (element), list));
3468 }
3469
3470 static GstPad *
3471 element_find_unlinked_pad (GstElement * element, GstPadDirection direction)
3472 {
3473   GstIterator *iter;
3474   GstPad *unlinked_pad = NULL;
3475   gboolean done;
3476   GValue data = { 0, };
3477
3478   switch (direction) {
3479     case GST_PAD_SRC:
3480       iter = gst_element_iterate_src_pads (element);
3481       break;
3482     case GST_PAD_SINK:
3483       iter = gst_element_iterate_sink_pads (element);
3484       break;
3485     default:
3486       g_return_val_if_reached (NULL);
3487   }
3488
3489   done = FALSE;
3490   while (!done) {
3491     switch (gst_iterator_next (iter, &data)) {
3492       case GST_ITERATOR_OK:{
3493         GstPad *peer;
3494         GstPad *pad = g_value_get_object (&data);
3495
3496         GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
3497             GST_DEBUG_PAD_NAME (pad));
3498
3499         peer = gst_pad_get_peer (pad);
3500         if (peer == NULL) {
3501           unlinked_pad = gst_object_ref (pad);
3502           done = TRUE;
3503           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
3504               "found existing unlinked pad %s:%s",
3505               GST_DEBUG_PAD_NAME (unlinked_pad));
3506         } else {
3507           gst_object_unref (peer);
3508         }
3509         g_value_reset (&data);
3510         break;
3511       }
3512       case GST_ITERATOR_DONE:
3513         done = TRUE;
3514         break;
3515       case GST_ITERATOR_RESYNC:
3516         gst_iterator_resync (iter);
3517         break;
3518       case GST_ITERATOR_ERROR:
3519         g_return_val_if_reached (NULL);
3520         break;
3521     }
3522   }
3523   g_value_unset (&data);
3524   gst_iterator_free (iter);
3525
3526   return unlinked_pad;
3527 }
3528
3529 /**
3530  * gst_bin_find_unlinked_pad:
3531  * @bin: bin in which to look for elements with unlinked pads
3532  * @direction: whether to look for an unlinked source or sink pad
3533  *
3534  * Recursively looks for elements with an unlinked pad of the given
3535  * direction within the specified bin and returns an unlinked pad
3536  * if one is found, or NULL otherwise. If a pad is found, the caller
3537  * owns a reference to it and should use gst_object_unref() on the
3538  * pad when it is not needed any longer.
3539  *
3540  * Returns: (transfer full): unlinked pad of the given direction, or NULL.
3541  *
3542  * Since: 0.10.20
3543  */
3544 GstPad *
3545 gst_bin_find_unlinked_pad (GstBin * bin, GstPadDirection direction)
3546 {
3547   GstIterator *iter;
3548   gboolean done;
3549   GstPad *pad = NULL;
3550   GValue data = { 0, };
3551
3552   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3553   g_return_val_if_fail (direction != GST_PAD_UNKNOWN, NULL);
3554
3555   done = FALSE;
3556   iter = gst_bin_iterate_recurse (bin);
3557   while (!done) {
3558     switch (gst_iterator_next (iter, &data)) {
3559       case GST_ITERATOR_OK:{
3560         GstElement *element = g_value_get_object (&data);
3561
3562         pad = element_find_unlinked_pad (element, direction);
3563         if (pad != NULL)
3564           done = TRUE;
3565         g_value_reset (&data);
3566         break;
3567       }
3568       case GST_ITERATOR_DONE:
3569         done = TRUE;
3570         break;
3571       case GST_ITERATOR_RESYNC:
3572         gst_iterator_resync (iter);
3573         break;
3574       case GST_ITERATOR_ERROR:
3575         g_return_val_if_reached (NULL);
3576         break;
3577     }
3578   }
3579   g_value_unset (&data);
3580   gst_iterator_free (iter);
3581
3582   return pad;
3583 }
3584
3585 /**
3586  * gst_parse_bin_from_description:
3587  * @bin_description: command line describing the bin
3588  * @ghost_unlinked_pads: whether to automatically create ghost pads
3589  *     for unlinked source or sink pads within the bin
3590  * @err: where to store the error message in case of an error, or NULL
3591  *
3592  * This is a convenience wrapper around gst_parse_launch() to create a
3593  * #GstBin from a gst-launch-style pipeline description. See
3594  * gst_parse_launch() and the gst-launch man page for details about the
3595  * syntax. Ghost pads on the bin for unlinked source or sink pads
3596  * within the bin can automatically be created (but only a maximum of
3597  * one ghost pad for each direction will be created; if you expect
3598  * multiple unlinked source pads or multiple unlinked sink pads
3599  * and want them all ghosted, you will have to create the ghost pads
3600  * yourself).
3601  *
3602  * Returns: (transfer full): a newly-created bin, or NULL if an error occurred.
3603  *
3604  * Since: 0.10.3
3605  */
3606 GstElement *
3607 gst_parse_bin_from_description (const gchar * bin_description,
3608     gboolean ghost_unlinked_pads, GError ** err)
3609 {
3610   return gst_parse_bin_from_description_full (bin_description,
3611       ghost_unlinked_pads, NULL, GST_PARSE_FLAG_NONE, err);
3612 }
3613
3614 /**
3615  * gst_parse_bin_from_description_full:
3616  * @bin_description: command line describing the bin
3617  * @ghost_unlinked_pads: whether to automatically create ghost pads
3618  *     for unlinked source or sink pads within the bin
3619  * @context: (transfer none) (allow-none): a parse context allocated with
3620  *     gst_parse_context_new(), or %NULL
3621  * @flags: parsing options, or #GST_PARSE_FLAG_NONE
3622  * @err: where to store the error message in case of an error, or NULL
3623  *
3624  * This is a convenience wrapper around gst_parse_launch() to create a
3625  * #GstBin from a gst-launch-style pipeline description. See
3626  * gst_parse_launch() and the gst-launch man page for details about the
3627  * syntax. Ghost pads on the bin for unlinked source or sink pads
3628  * within the bin can automatically be created (but only a maximum of
3629  * one ghost pad for each direction will be created; if you expect
3630  * multiple unlinked source pads or multiple unlinked sink pads
3631  * and want them all ghosted, you will have to create the ghost pads
3632  * yourself).
3633  *
3634  * Returns: (transfer full): a newly-created bin, or NULL if an error occurred.
3635  *
3636  * Since: 0.10.20
3637  */
3638 GstElement *
3639 gst_parse_bin_from_description_full (const gchar * bin_description,
3640     gboolean ghost_unlinked_pads, GstParseContext * context,
3641     GstParseFlags flags, GError ** err)
3642 {
3643 #ifndef GST_DISABLE_PARSE
3644   GstPad *pad = NULL;
3645   GstBin *bin;
3646   gchar *desc;
3647
3648   g_return_val_if_fail (bin_description != NULL, NULL);
3649   g_return_val_if_fail (err == NULL || *err == NULL, NULL);
3650
3651   GST_DEBUG ("Making bin from description '%s'", bin_description);
3652
3653   /* parse the pipeline to a bin */
3654   desc = g_strdup_printf ("bin.( %s )", bin_description);
3655   bin = (GstBin *) gst_parse_launch_full (desc, context, flags, err);
3656   g_free (desc);
3657
3658   if (bin == NULL || (err && *err != NULL)) {
3659     if (bin)
3660       gst_object_unref (bin);
3661     return NULL;
3662   }
3663
3664   /* find pads and ghost them if necessary */
3665   if (ghost_unlinked_pads) {
3666     if ((pad = gst_bin_find_unlinked_pad (bin, GST_PAD_SRC))) {
3667       gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("src", pad));
3668       gst_object_unref (pad);
3669     }
3670     if ((pad = gst_bin_find_unlinked_pad (bin, GST_PAD_SINK))) {
3671       gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("sink", pad));
3672       gst_object_unref (pad);
3673     }
3674   }
3675
3676   return GST_ELEMENT (bin);
3677 #else
3678   gchar *msg;
3679
3680   GST_WARNING ("Disabled API called");
3681
3682   msg = gst_error_get_message (GST_CORE_ERROR, GST_CORE_ERROR_DISABLED);
3683   g_set_error (err, GST_CORE_ERROR, GST_CORE_ERROR_DISABLED, "%s", msg);
3684   g_free (msg);
3685
3686   return NULL;
3687 #endif
3688 }
3689
3690 /**
3691  * gst_type_register_static_full:
3692  * @parent_type: The GType of the parent type the newly registered type will
3693  *   derive from
3694  * @type_name: NULL-terminated string used as the name of the new type
3695  * @class_size: Size of the class structure.
3696  * @base_init: Location of the base initialization function (optional).
3697  * @base_finalize: Location of the base finalization function (optional).
3698  * @class_init: Location of the class initialization function for class types
3699  *   Location of the default vtable inititalization function for interface
3700  *   types. (optional)
3701  * @class_finalize: Location of the class finalization function for class types.
3702  *   Location of the default vtable finalization function for interface types.
3703  *   (optional)
3704  * @class_data: User-supplied data passed to the class init/finalize functions.
3705  * @instance_size: Size of the instance (object) structure (required for
3706  *   instantiatable types only).
3707  * @n_preallocs: The number of pre-allocated (cached) instances to reserve
3708  *   memory for (0 indicates no caching). Ignored on recent GLib's.
3709  * @instance_init: Location of the instance initialization function (optional,
3710  *   for instantiatable types only).
3711  * @value_table: A GTypeValueTable function table for generic handling of
3712  *   GValues of this type (usually only useful for fundamental types).
3713  * @flags: #GTypeFlags for this GType. E.g: G_TYPE_FLAG_ABSTRACT
3714  *
3715  * Helper function which constructs a #GTypeInfo structure and registers a
3716  * GType, but which generates less linker overhead than a static const
3717  * #GTypeInfo structure. For further details of the parameters, please see
3718  * #GTypeInfo in the GLib documentation.
3719  *
3720  * Registers type_name as the name of a new static type derived from
3721  * parent_type. The value of flags determines the nature (e.g. abstract or
3722  * not) of the type. It works by filling a GTypeInfo struct and calling
3723  * g_type_register_static().
3724  *
3725  * Returns: A #GType for the newly-registered type.
3726  *
3727  * Since: 0.10.14
3728  */
3729 GType
3730 gst_type_register_static_full (GType parent_type,
3731     const gchar * type_name,
3732     guint class_size,
3733     GBaseInitFunc base_init,
3734     GBaseFinalizeFunc base_finalize,
3735     GClassInitFunc class_init,
3736     GClassFinalizeFunc class_finalize,
3737     gconstpointer class_data,
3738     guint instance_size,
3739     guint16 n_preallocs,
3740     GInstanceInitFunc instance_init,
3741     const GTypeValueTable * value_table, GTypeFlags flags)
3742 {
3743   GTypeInfo info;
3744
3745   info.class_size = class_size;
3746   info.base_init = base_init;
3747   info.base_finalize = base_finalize;
3748   info.class_init = class_init;
3749   info.class_finalize = class_finalize;
3750   info.class_data = class_data;
3751   info.instance_size = instance_size;
3752   info.n_preallocs = n_preallocs;
3753   info.instance_init = instance_init;
3754   info.value_table = value_table;
3755
3756   return g_type_register_static (parent_type, type_name, &info, flags);
3757 }
3758
3759
3760 /**
3761  * gst_util_get_timestamp:
3762  *
3763  * Get a timestamp as GstClockTime to be used for interval meassurements.
3764  * The timestamp should not be interpreted in any other way.
3765  *
3766  * Returns: the timestamp
3767  *
3768  * Since: 0.10.16
3769  */
3770 GstClockTime
3771 gst_util_get_timestamp (void)
3772 {
3773 #if defined (HAVE_POSIX_TIMERS) && defined(HAVE_MONOTONIC_CLOCK)
3774   struct timespec now;
3775
3776   clock_gettime (CLOCK_MONOTONIC, &now);
3777   return GST_TIMESPEC_TO_TIME (now);
3778 #else
3779   GTimeVal now;
3780
3781   g_get_current_time (&now);
3782   return GST_TIMEVAL_TO_TIME (now);
3783 #endif
3784 }
3785
3786 /**
3787  * gst_util_array_binary_search:
3788  * @array: the sorted input array
3789  * @num_elements: number of elements in the array
3790  * @element_size: size of every element in bytes
3791  * @search_func: (scope call): function to compare two elements, @search_data will always be passed as second argument
3792  * @mode: search mode that should be used
3793  * @search_data: element that should be found
3794  * @user_data: (closure): data to pass to @search_func
3795  *
3796  * Searches inside @array for @search_data by using the comparison function
3797  * @search_func. @array must be sorted ascending.
3798  *
3799  * As @search_data is always passed as second argument to @search_func it's
3800  * not required that @search_data has the same type as the array elements.
3801  *
3802  * The complexity of this search function is O(log (num_elements)).
3803  *
3804  * Returns: (transfer none): The address of the found element or %NULL if nothing was found
3805  *
3806  * Since: 0.10.23
3807  */
3808 gpointer
3809 gst_util_array_binary_search (gpointer array, guint num_elements,
3810     gsize element_size, GCompareDataFunc search_func, GstSearchMode mode,
3811     gconstpointer search_data, gpointer user_data)
3812 {
3813   glong left = 0, right = num_elements - 1, m;
3814   gint ret;
3815   guint8 *data = (guint8 *) array;
3816
3817   g_return_val_if_fail (array != NULL, NULL);
3818   g_return_val_if_fail (element_size > 0, NULL);
3819   g_return_val_if_fail (search_func != NULL, NULL);
3820
3821   /* 0. No elements => return NULL */
3822   if (num_elements == 0)
3823     return NULL;
3824
3825   /* 1. If search_data is before the 0th element return the 0th element */
3826   ret = search_func (data, search_data, user_data);
3827   if ((ret >= 0 && mode == GST_SEARCH_MODE_AFTER) || ret == 0)
3828     return data;
3829   else if (ret > 0)
3830     return NULL;
3831
3832   /* 2. If search_data is after the last element return the last element */
3833   ret =
3834       search_func (data + (num_elements - 1) * element_size, search_data,
3835       user_data);
3836   if ((ret <= 0 && mode == GST_SEARCH_MODE_BEFORE) || ret == 0)
3837     return data + (num_elements - 1) * element_size;
3838   else if (ret < 0)
3839     return NULL;
3840
3841   /* 3. else binary search */
3842   while (TRUE) {
3843     m = left + (right - left) / 2;
3844
3845     ret = search_func (data + m * element_size, search_data, user_data);
3846
3847     if (ret == 0) {
3848       return data + m * element_size;
3849     } else if (ret < 0) {
3850       left = m + 1;
3851     } else {
3852       right = m - 1;
3853     }
3854
3855     /* No exact match found */
3856     if (right < left) {
3857       if (mode == GST_SEARCH_MODE_EXACT) {
3858         return NULL;
3859       } else if (mode == GST_SEARCH_MODE_AFTER) {
3860         if (ret < 0)
3861           return (m < num_elements) ? data + (m + 1) * element_size : NULL;
3862         else
3863           return data + m * element_size;
3864       } else {
3865         if (ret < 0)
3866           return data + m * element_size;
3867         else
3868           return (m > 0) ? data + (m - 1) * element_size : NULL;
3869       }
3870     }
3871   }
3872 }
3873
3874 /* Finds the greatest common divisor.
3875  * Returns 1 if none other found.
3876  * This is Euclid's algorithm. */
3877
3878 /**
3879  * gst_util_greatest_common_divisor:
3880  * @a: First value as #gint
3881  * @b: Second value as #gint
3882  *
3883  * Calculates the greatest common divisor of @a
3884  * and @b.
3885  *
3886  * Returns: Greatest common divisor of @a and @b
3887  *
3888  * Since: 0.10.26
3889  */
3890 gint
3891 gst_util_greatest_common_divisor (gint a, gint b)
3892 {
3893   while (b != 0) {
3894     int temp = a;
3895
3896     a = b;
3897     b = temp % b;
3898   }
3899
3900   return ABS (a);
3901 }
3902
3903 /**
3904  * gst_util_fraction_to_double:
3905  * @src_n: Fraction numerator as #gint
3906  * @src_d: Fraction denominator #gint
3907  * @dest: (out): pointer to a #gdouble for the result
3908  *
3909  * Transforms a fraction to a #gdouble.
3910  *
3911  * Since: 0.10.26
3912  */
3913 void
3914 gst_util_fraction_to_double (gint src_n, gint src_d, gdouble * dest)
3915 {
3916   g_return_if_fail (dest != NULL);
3917   g_return_if_fail (src_d != 0);
3918
3919   *dest = ((gdouble) src_n) / ((gdouble) src_d);
3920 }
3921
3922 #define MAX_TERMS       30
3923 #define MIN_DIVISOR     1.0e-10
3924 #define MAX_ERROR       1.0e-20
3925
3926 /* use continued fractions to transform a double into a fraction,
3927  * see http://mathforum.org/dr.math/faq/faq.fractions.html#decfrac.
3928  * This algorithm takes care of overflows.
3929  */
3930
3931 /**
3932  * gst_util_double_to_fraction:
3933  * @src: #gdouble to transform
3934  * @dest_n: (out): pointer to a #gint to hold the result numerator
3935  * @dest_d: (out): pointer to a #gint to hold the result denominator
3936  *
3937  * Transforms a #gdouble to a fraction and simplifies
3938  * the result.
3939  *
3940  * Since: 0.10.26
3941  */
3942 void
3943 gst_util_double_to_fraction (gdouble src, gint * dest_n, gint * dest_d)
3944 {
3945
3946   gdouble V, F;                 /* double being converted */
3947   gint N, D;                    /* will contain the result */
3948   gint A;                       /* current term in continued fraction */
3949   gint64 N1, D1;                /* numerator, denominator of last approx */
3950   gint64 N2, D2;                /* numerator, denominator of previous approx */
3951   gint i;
3952   gint gcd;
3953   gboolean negative = FALSE;
3954
3955   g_return_if_fail (dest_n != NULL);
3956   g_return_if_fail (dest_d != NULL);
3957
3958   /* initialize fraction being converted */
3959   F = src;
3960   if (F < 0.0) {
3961     F = -F;
3962     negative = TRUE;
3963   }
3964
3965   V = F;
3966   /* initialize fractions with 1/0, 0/1 */
3967   N1 = 1;
3968   D1 = 0;
3969   N2 = 0;
3970   D2 = 1;
3971   N = 1;
3972   D = 1;
3973
3974   for (i = 0; i < MAX_TERMS; i++) {
3975     /* get next term */
3976     A = (gint) F;               /* no floor() needed, F is always >= 0 */
3977     /* get new divisor */
3978     F = F - A;
3979
3980     /* calculate new fraction in temp */
3981     N2 = N1 * A + N2;
3982     D2 = D1 * A + D2;
3983
3984     /* guard against overflow */
3985     if (N2 > G_MAXINT || D2 > G_MAXINT) {
3986       break;
3987     }
3988
3989     N = N2;
3990     D = D2;
3991
3992     /* save last two fractions */
3993     N2 = N1;
3994     D2 = D1;
3995     N1 = N;
3996     D1 = D;
3997
3998     /* quit if dividing by zero or close enough to target */
3999     if (F < MIN_DIVISOR || fabs (V - ((gdouble) N) / D) < MAX_ERROR) {
4000       break;
4001     }
4002
4003     /* Take reciprocal */
4004     F = 1 / F;
4005   }
4006   /* fix for overflow */
4007   if (D == 0) {
4008     N = G_MAXINT;
4009     D = 1;
4010   }
4011   /* fix for negative */
4012   if (negative)
4013     N = -N;
4014
4015   /* simplify */
4016   gcd = gst_util_greatest_common_divisor (N, D);
4017   if (gcd) {
4018     N /= gcd;
4019     D /= gcd;
4020   }
4021
4022   /* set results */
4023   *dest_n = N;
4024   *dest_d = D;
4025 }
4026
4027 /**
4028  * gst_util_fraction_multiply:
4029  * @a_n: Numerator of first value
4030  * @a_d: Denominator of first value
4031  * @b_n: Numerator of second value
4032  * @b_d: Denominator of second value
4033  * @res_n: (out): Pointer to #gint to hold the result numerator
4034  * @res_d: (out): Pointer to #gint to hold the result denominator
4035  *
4036  * Multiplies the fractions @a_n/@a_d and @b_n/@b_d and stores
4037  * the result in @res_n and @res_d.
4038  *
4039  * Returns: %FALSE on overflow, %TRUE otherwise.
4040  *
4041  * Since: 0.10.26
4042  */
4043 gboolean
4044 gst_util_fraction_multiply (gint a_n, gint a_d, gint b_n, gint b_d,
4045     gint * res_n, gint * res_d)
4046 {
4047   gint gcd;
4048
4049   g_return_val_if_fail (res_n != NULL, FALSE);
4050   g_return_val_if_fail (res_d != NULL, FALSE);
4051   g_return_val_if_fail (a_d != 0, FALSE);
4052   g_return_val_if_fail (b_d != 0, FALSE);
4053
4054   gcd = gst_util_greatest_common_divisor (a_n, a_d);
4055   a_n /= gcd;
4056   a_d /= gcd;
4057
4058   gcd = gst_util_greatest_common_divisor (b_n, b_d);
4059   b_n /= gcd;
4060   b_d /= gcd;
4061
4062   gcd = gst_util_greatest_common_divisor (a_n, b_d);
4063   a_n /= gcd;
4064   b_d /= gcd;
4065
4066   gcd = gst_util_greatest_common_divisor (a_d, b_n);
4067   a_d /= gcd;
4068   b_n /= gcd;
4069
4070   /* This would result in overflow */
4071   if (a_n != 0 && G_MAXINT / ABS (a_n) < ABS (b_n))
4072     return FALSE;
4073   if (G_MAXINT / ABS (a_d) < ABS (b_d))
4074     return FALSE;
4075
4076   *res_n = a_n * b_n;
4077   *res_d = a_d * b_d;
4078
4079   gcd = gst_util_greatest_common_divisor (*res_n, *res_d);
4080   *res_n /= gcd;
4081   *res_d /= gcd;
4082
4083   return TRUE;
4084 }
4085
4086 /**
4087  * gst_util_fraction_add:
4088  * @a_n: Numerator of first value
4089  * @a_d: Denominator of first value
4090  * @b_n: Numerator of second value
4091  * @b_d: Denominator of second value
4092  * @res_n: (out): Pointer to #gint to hold the result numerator
4093  * @res_d: (out): Pointer to #gint to hold the result denominator
4094  *
4095  * Adds the fractions @a_n/@a_d and @b_n/@b_d and stores
4096  * the result in @res_n and @res_d.
4097  *
4098  * Returns: %FALSE on overflow, %TRUE otherwise.
4099  *
4100  * Since: 0.10.26
4101  */
4102 gboolean
4103 gst_util_fraction_add (gint a_n, gint a_d, gint b_n, gint b_d, gint * res_n,
4104     gint * res_d)
4105 {
4106   gint gcd;
4107
4108   g_return_val_if_fail (res_n != NULL, FALSE);
4109   g_return_val_if_fail (res_d != NULL, FALSE);
4110   g_return_val_if_fail (a_d != 0, FALSE);
4111   g_return_val_if_fail (b_d != 0, FALSE);
4112
4113   gcd = gst_util_greatest_common_divisor (a_n, a_d);
4114   a_n /= gcd;
4115   a_d /= gcd;
4116
4117   gcd = gst_util_greatest_common_divisor (b_n, b_d);
4118   b_n /= gcd;
4119   b_d /= gcd;
4120
4121   if (a_n == 0) {
4122     *res_n = b_n;
4123     *res_d = b_d;
4124     return TRUE;
4125   }
4126   if (b_n == 0) {
4127     *res_n = a_n;
4128     *res_d = a_d;
4129     return TRUE;
4130   }
4131
4132   /* This would result in overflow */
4133   if (G_MAXINT / ABS (a_n) < ABS (b_n))
4134     return FALSE;
4135   if (G_MAXINT / ABS (a_d) < ABS (b_d))
4136     return FALSE;
4137   if (G_MAXINT / ABS (a_d) < ABS (b_d))
4138     return FALSE;
4139
4140   *res_n = (a_n * b_d) + (a_d * b_n);
4141   *res_d = a_d * b_d;
4142
4143   gcd = gst_util_greatest_common_divisor (*res_n, *res_d);
4144   if (gcd) {
4145     *res_n /= gcd;
4146     *res_d /= gcd;
4147   } else {
4148     /* res_n == 0 */
4149     *res_d = 1;
4150   }
4151
4152   return TRUE;
4153 }
4154
4155 /**
4156  * gst_util_fraction_compare:
4157  * @a_n: Numerator of first value
4158  * @a_d: Denominator of first value
4159  * @b_n: Numerator of second value
4160  * @b_d: Denominator of second value
4161  *
4162  * Compares the fractions @a_n/@a_d and @b_n/@b_d and returns
4163  * -1 if a < b, 0 if a = b and 1 if a > b.
4164  *
4165  * Returns: -1 if a < b; 0 if a = b; 1 if a > b.
4166  *
4167  * Since: 0.10.31
4168  */
4169 gint
4170 gst_util_fraction_compare (gint a_n, gint a_d, gint b_n, gint b_d)
4171 {
4172   gint64 new_num_1;
4173   gint64 new_num_2;
4174   gint gcd;
4175
4176   g_return_val_if_fail (a_d != 0 && b_d != 0, 0);
4177
4178   /* Simplify */
4179   gcd = gst_util_greatest_common_divisor (a_n, a_d);
4180   a_n /= gcd;
4181   a_d /= gcd;
4182
4183   gcd = gst_util_greatest_common_divisor (b_n, b_d);
4184   b_n /= gcd;
4185   b_d /= gcd;
4186
4187   /* fractions are reduced when set, so we can quickly see if they're equal */
4188   if (a_n == b_n && a_d == b_d)
4189     return 0;
4190
4191   /* extend to 64 bits */
4192   new_num_1 = ((gint64) a_n) * b_d;
4193   new_num_2 = ((gint64) b_n) * a_d;
4194   if (new_num_1 < new_num_2)
4195     return -1;
4196   if (new_num_1 > new_num_2)
4197     return 1;
4198
4199   /* Should not happen because a_d and b_d are not 0 */
4200   g_return_val_if_reached (0);
4201 }