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