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