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