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