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