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