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