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  */
  29
  30 #include "gst_private.h"
  31 #include <stdio.h>
  32 #include <string.h>
  33
  34 #include "gstghostpad.h"
  35 #include "gstutils.h"
  36 #include "gsterror.h"
  37 #include "gstinfo.h"
  38 #include "gstparse.h"
  39 #include "gstvalue.h"
  40 #include "gst-i18n-lib.h"
  41 #include "glib-compat-private.h"
  42 #include <math.h>
  43
  44 /**
  45  * gst_util_dump_mem:
  46  * @mem: a pointer to the memory to dump
  47  * @size: the size of the memory block to dump
  48  *
  49  * Dumps the memory block into a hex representation. Useful for debugging.
  50  */
  51 void
  52 gst_util_dump_mem (const guchar * mem, guint size)
  53 {
  54   guint i, j;
  55   GString *string = g_string_sized_new (50);
  56   GString *chars = g_string_sized_new (18);
  57
  58   i = j = 0;
  59   while (i < size) {
  60     if (g_ascii_isprint (mem[i]))
  61       g_string_append_c (chars, mem[i]);
  62     else
  63       g_string_append_c (chars, '.');
  64
  65     g_string_append_printf (string, "%02x ", mem[i]);
  66
  67     j++;
  68     i++;
  69
  70     if (j == 16 || i == size) {
  71       g_print ("%08x (%p): %-48.48s %-16.16s\n", i - j, mem + i - j,
  72           string->str, chars->str);
  73       g_string_set_size (string, 0);
  74       g_string_set_size (chars, 0);
  75       j = 0;
  76     }
  77   }
  78   g_string_free (string, TRUE);
  79   g_string_free (chars, TRUE);
  80 }
  81
  82
  83 /**
  84  * gst_util_set_value_from_string:
  85  * @value: (out caller-allocates): the value to set
  86  * @value_str: the string to get the value from
  87  *
  88  * Converts the string to the type of the value and
  89  * sets the value with it.
  90  *
  91  * Note that this function is dangerous as it does not return any indication
  92  * if the conversion worked or not.
  93  */
  94 void
  95 gst_util_set_value_from_string (GValue * value, const gchar * value_str)
  96 {
  97   gboolean res;
  98
  99   g_return_if_fail (value != NULL);
 100   g_return_if_fail (value_str != NULL);
 101
 102   GST_CAT_DEBUG (GST_CAT_PARAMS, "parsing '%s' to type %s", value_str,
 103       g_type_name (G_VALUE_TYPE (value)));
 104
 105   res = gst_value_deserialize (value, value_str);
 106   if (!res && G_VALUE_TYPE (value) == G_TYPE_BOOLEAN) {
 107     /* backwards compat, all booleans that fail to parse are false */
 108     g_value_set_boolean (value, FALSE);
 109     res = TRUE;
 110   }
 111   g_return_if_fail (res);
 112 }
 113
 114 /**
 115  * gst_util_set_object_arg:
 116  * @object: the object to set the argument of
 117  * @name: the name of the argument to set
 118  * @value: the string value to set
 119  *
 120  * Convertes the string value to the type of the objects argument and
 121  * sets the argument with it.
 122  *
 123  * Note that this function silently returns if @object has no property named
 124  * @name or when @value cannot be converted to the type of the property.
 125  */
 126 void
 127 gst_util_set_object_arg (GObject * object, const gchar * name,
 128     const gchar * value)
 129 {
 130   GParamSpec *pspec;
 131   GType value_type;
 132   GValue v = { 0, };
 133
 134   g_return_if_fail (G_IS_OBJECT (object));
 135   g_return_if_fail (name != NULL);
 136   g_return_if_fail (value != NULL);
 137
 138   pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), name);
 139   if (!pspec)
 140     return;
 141
 142   value_type = pspec->value_type;
 143
 144   GST_DEBUG ("pspec->flags is %d, pspec->value_type is %s",
 145       pspec->flags, g_type_name (value_type));
 146
 147   if (!(pspec->flags & G_PARAM_WRITABLE))
 148     return;
 149
 150   g_value_init (&v, value_type);
 151
 152   /* special case for element <-> xml (de)serialisation */
 153   if (GST_VALUE_HOLDS_STRUCTURE (&v) && strcmp (value, "NULL") == 0) {
 154     g_value_set_boxed (&v, NULL);
 155     goto done;
 156   }
 157
 158   if (!gst_value_deserialize (&v, value))
 159     return;
 160
 161 done:
 162
 163   g_object_set_property (object, pspec->name, &v);
 164   g_value_unset (&v);
 165 }
 166
 167 /* work around error C2520: conversion from unsigned __int64 to double
 168  * not implemented, use signed __int64
 169  *
 170  * These are implemented as functions because on some platforms a 64bit int to
 171  * double conversion is not defined/implemented.
 172  */
 173
 174 gdouble
 175 gst_util_guint64_to_gdouble (guint64 value)
 176 {
 177   if (value & G_GINT64_CONSTANT (0x8000000000000000))
 178     return (gdouble) ((gint64) value) + (gdouble) 18446744073709551616.;
 179   else
 180     return (gdouble) ((gint64) value);
 181 }
 182
 183 guint64
 184 gst_util_gdouble_to_guint64 (gdouble value)
 185 {
 186   if (value < (gdouble) 9223372036854775808.)   /* 1 << 63 */
 187     return ((guint64) ((gint64) value));
 188
 189   value -= (gdouble) 18446744073709551616.;
 190   return ((guint64) ((gint64) value));
 191 }
 192
 193 #ifndef HAVE_UINT128_T
 194 /* convenience struct for getting high and low uint32 parts of
 195  * a guint64 */
 196 typedef union
 197 {
 198   guint64 ll;
 199   struct
 200   {
 201 #if G_BYTE_ORDER == G_BIG_ENDIAN
 202     guint32 high, low;
 203 #else
 204     guint32 low, high;
 205 #endif
 206   } l;
 207 } GstUInt64;
 208
 209 #if defined (__x86_64__) && defined (__GNUC__)
 210 static inline void
 211 gst_util_uint64_mul_uint64 (GstUInt64 * c1, GstUInt64 * c0, guint64 arg1,
 212     guint64 arg2)
 213 {
 214   __asm__ __volatile__ ("mulq %3":"=a" (c0->ll), "=d" (c1->ll)
 215       :"a" (arg1), "g" (arg2)
 216       );
 217 }
 218 #else /* defined (__x86_64__) */
 219 /* multiply two 64-bit unsigned ints into a 128-bit unsigned int.  the high
 220  * and low 64 bits of the product are placed in c1 and c0 respectively.
 221  * this operation cannot overflow. */
 222 static inline void
 223 gst_util_uint64_mul_uint64 (GstUInt64 * c1, GstUInt64 * c0, guint64 arg1,
 224     guint64 arg2)
 225 {
 226   GstUInt64 a1, b0;
 227   GstUInt64 v, n;
 228
 229   /* prepare input */
 230   v.ll = arg1;
 231   n.ll = arg2;
 232
 233   /* do 128 bits multiply
 234    *                   nh   nl
 235    *                *  vh   vl
 236    *                ----------
 237    * a0 =              vl * nl
 238    * a1 =         vl * nh
 239    * b0 =         vh * nl
 240    * b1 =  + vh * nh
 241    *       -------------------
 242    *        c1h  c1l  c0h  c0l
 243    *
 244    * "a0" is optimized away, result is stored directly in c0.  "b1" is
 245    * optimized away, result is stored directly in c1.
 246    */
 247   c0->ll = (guint64) v.l.low * n.l.low;
 248   a1.ll = (guint64) v.l.low * n.l.high;
 249   b0.ll = (guint64) v.l.high * n.l.low;
 250
 251   /* add the high word of a0 to the low words of a1 and b0 using c1 as
 252    * scrach space to capture the carry.  the low word of the result becomes
 253    * the final high word of c0 */
 254   c1->ll = (guint64) c0->l.high + a1.l.low + b0.l.low;
 255   c0->l.high = c1->l.low;
 256
 257   /* add the carry from the result above (found in the high word of c1) and
 258    * the high words of a1 and b0 to b1, the result is c1. */
 259   c1->ll = (guint64) v.l.high * n.l.high + c1->l.high + a1.l.high + b0.l.high;
 260 }
 261 #endif /* defined (__x86_64__) */
 262
 263 #if defined (__x86_64__) && defined (__GNUC__)
 264 static inline guint64
 265 gst_util_div128_64 (GstUInt64 c1, GstUInt64 c0, guint64 denom)
 266 {
 267   guint64 res;
 268
 269   __asm__ __volatile__ ("divq %3":"=a" (res)
 270       :"d" (c1.ll), "a" (c0.ll), "g" (denom)
 271       );
 272
 273   return res;
 274 }
 275 #else
 276 /* count leading zeros */
 277 static inline guint
 278 gst_util_clz (guint32 val)
 279 {
 280   guint s;
 281
 282   s = val | (val >> 1);
 283   s |= (s >> 2);
 284   s |= (s >> 4);
 285   s |= (s >> 8);
 286   s = ~(s | (s >> 16));
 287   s = s - ((s >> 1) & 0x55555555);
 288   s = (s & 0x33333333) + ((s >> 2) & 0x33333333);
 289   s = (s + (s >> 4)) & 0x0f0f0f0f;
 290   s += (s >> 8);
 291   s = (s + (s >> 16)) & 0x3f;
 292
 293   return s;
 294 }
 295
 296 /* based on Hacker's Delight p152 */
 297 static inline guint64
 298 gst_util_div128_64 (GstUInt64 c1, GstUInt64 c0, guint64 denom)
 299 {
 300   GstUInt64 q1, q0, rhat;
 301   GstUInt64 v, cmp1, cmp2;
 302   guint s;
 303
 304   v.ll = denom;
 305
 306   /* count number of leading zeroes, we know they must be in the high
 307    * part of denom since denom > G_MAXUINT32. */
 308   s = gst_util_clz (v.l.high);
 309
 310   if (s > 0) {
 311     /* normalize divisor and dividend */
 312     v.ll <<= s;
 313     c1.ll = (c1.ll << s) | (c0.l.high >> (32 - s));
 314     c0.ll <<= s;
 315   }
 316
 317   q1.ll = c1.ll / v.l.high;
 318   rhat.ll = c1.ll - q1.ll * v.l.high;
 319
 320   cmp1.l.high = rhat.l.low;
 321   cmp1.l.low = c0.l.high;
 322   cmp2.ll = q1.ll * v.l.low;
 323
 324   while (q1.l.high || cmp2.ll > cmp1.ll) {
 325     q1.ll--;
 326     rhat.ll += v.l.high;
 327     if (rhat.l.high)
 328       break;
 329     cmp1.l.high = rhat.l.low;
 330     cmp2.ll -= v.l.low;
 331   }
 332   c1.l.high = c1.l.low;
 333   c1.l.low = c0.l.high;
 334   c1.ll -= q1.ll * v.ll;
 335   q0.ll = c1.ll / v.l.high;
 336   rhat.ll = c1.ll - q0.ll * v.l.high;
 337
 338   cmp1.l.high = rhat.l.low;
 339   cmp1.l.low = c0.l.low;
 340   cmp2.ll = q0.ll * v.l.low;
 341
 342   while (q0.l.high || cmp2.ll > cmp1.ll) {
 343     q0.ll--;
 344     rhat.ll += v.l.high;
 345     if (rhat.l.high)
 346       break;
 347     cmp1.l.high = rhat.l.low;
 348     cmp2.ll -= v.l.low;
 349   }
 350   q0.l.high += q1.l.low;
 351
 352   return q0.ll;
 353 }
 354 #endif /* defined (__GNUC__) */
 355
 356 /* This always gives the correct result because:
 357  * a) val <= G_MAXUINT64-1
 358  * b) (c0,c1) <= G_MAXUINT64 * (G_MAXUINT64-1)
 359  *    or
 360  *    (c0,c1) == G_MAXUINT64 * G_MAXUINT64 and denom < G_MAXUINT64
 361  *    (note: num==denom case is handled by short path)
 362  * This means that (c0,c1) either has enough space for val
 363  * or that the overall result will overflow anyway.
 364  */
 365
 366 /* add correction with carry */
 367 #define CORRECT(c0,c1,val)                    \
 368   if (val) {                                  \
 369     if (G_MAXUINT64 - c0.ll < val) {          \
 370       if (G_UNLIKELY (c1.ll == G_MAXUINT64))  \
 371         /* overflow */                        \
 372         return G_MAXUINT64;                   \
 373       c1.ll++;                                \
 374     }                                         \
 375     c0.ll += val;                             \
 376   }
 377
 378 static guint64
 379 gst_util_uint64_scale_uint64_unchecked (guint64 val, guint64 num,
 380     guint64 denom, guint64 correct)
 381 {
 382   GstUInt64 c1, c0;
 383
 384   /* compute 128-bit numerator product */
 385   gst_util_uint64_mul_uint64 (&c1, &c0, val, num);
 386
 387   /* perform rounding correction */
 388   CORRECT (c0, c1, correct);
 389
 390   /* high word as big as or bigger than denom --> overflow */
 391   if (G_UNLIKELY (c1.ll >= denom))
 392     return G_MAXUINT64;
 393
 394   /* compute quotient, fits in 64 bits */
 395   return gst_util_div128_64 (c1, c0, denom);
 396 }
 397 #else
 398
 399 #define GST_MAXUINT128 ((__uint128_t) -1)
 400 static guint64
 401 gst_util_uint64_scale_uint64_unchecked (guint64 val, guint64 num,
 402     guint64 denom, guint64 correct)
 403 {
 404   __uint128_t tmp;
 405
 406   /* Calculate val * num */
 407   tmp = ((__uint128_t) val) * ((__uint128_t) num);
 408
 409   /* overflow checks */
 410   if (G_UNLIKELY (GST_MAXUINT128 - correct < tmp))
 411     return G_MAXUINT64;
 412
 413   /* perform rounding correction */
 414   tmp += correct;
 415
 416   /* Divide by denom */
 417   tmp /= denom;
 418
 419   /* if larger than G_MAXUINT64 --> overflow */
 420   if (G_UNLIKELY (tmp > G_MAXUINT64))
 421     return G_MAXUINT64;
 422
 423   /* compute quotient, fits in 64 bits */
 424   return (guint64) tmp;
 425 }
 426
 427 #endif
 428
 429 #if !defined (__x86_64__) && !defined (HAVE_UINT128_T)
 430 static inline void
 431 gst_util_uint64_mul_uint32 (GstUInt64 * c1, GstUInt64 * c0, guint64 arg1,
 432     guint32 arg2)
 433 {
 434   GstUInt64 a;
 435
 436   a.ll = arg1;
 437
 438   c0->ll = (guint64) a.l.low * arg2;
 439   c1->ll = (guint64) a.l.high * arg2 + c0->l.high;
 440   c0->l.high = 0;
 441 }
 442
 443 /* divide a 96-bit unsigned int by a 32-bit unsigned int when we know the
 444  * quotient fits into 64 bits.  the high 64 bits and low 32 bits of the
 445  * numerator are expected in c1 and c0 respectively. */
 446 static inline guint64
 447 gst_util_div96_32 (guint64 c1, guint64 c0, guint32 denom)
 448 {
 449   c0 += (c1 % denom) << 32;
 450   return ((c1 / denom) << 32) + (c0 / denom);
 451 }
 452
 453 static inline guint64
 454 gst_util_uint64_scale_uint32_unchecked (guint64 val, guint32 num,
 455     guint32 denom, guint32 correct)
 456 {
 457   GstUInt64 c1, c0;
 458
 459   /* compute 96-bit numerator product */
 460   gst_util_uint64_mul_uint32 (&c1, &c0, val, num);
 461
 462   /* condition numerator based on rounding mode */
 463   CORRECT (c0, c1, correct);
 464
 465   /* high 32 bits as big as or bigger than denom --> overflow */
 466   if (G_UNLIKELY (c1.l.high >= denom))
 467     return G_MAXUINT64;
 468
 469   /* compute quotient, fits in 64 bits */
 470   return gst_util_div96_32 (c1.ll, c0.ll, denom);
 471 }
 472 #endif
 473
 474 /* the guts of the gst_util_uint64_scale() variants */
 475 static guint64
 476 _gst_util_uint64_scale (guint64 val, guint64 num, guint64 denom,
 477     guint64 correct)
 478 {
 479   g_return_val_if_fail (denom != 0, G_MAXUINT64);
 480
 481   if (G_UNLIKELY (num == 0))
 482     return 0;
 483
 484   if (G_UNLIKELY (num == denom))
 485     return val;
 486
 487   /* on 64bits we always use a full 128bits multiply/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_add (&counter, 1);
 708 }
 709
 710 /**
 711  * gst_util_seqnum_compare:
 712  * @s1: A sequence number.
 713  * @s2: Another sequence number.
 714  *
 715  * Compare two sequence numbers, handling wraparound.
 716  *
 717  * The current implementation just returns (gint32)(@s1 - @s2).
 718  *
 719  * Returns: A negative number if @s1 is before @s2, 0 if they are equal, or a
 720  * positive number if @s1 is after @s2.
 721  *
 722  * Since: 0.10.22
 723  */
 724 gint32
 725 gst_util_seqnum_compare (guint32 s1, guint32 s2)
 726 {
 727   return (gint32) (s1 - s2);
 728 }
 729
 730 /* -----------------------------------------------------
 731  *
 732  *  The following code will be moved out of the main
 733  * gstreamer library someday.
 734  */
 735
 736 #include "gstpad.h"
 737
 738 static void
 739 string_append_indent (GString * str, gint count)
 740 {
 741   gint xx;
 742
 743   for (xx = 0; xx < count; xx++)
 744     g_string_append_c (str, ' ');
 745 }
 746
 747 /**
 748  * gst_print_pad_caps:
 749  * @buf: the buffer to print the caps in
 750  * @indent: initial indentation
 751  * @pad: (transfer none): the pad to print the caps from
 752  *
 753  * Write the pad capabilities in a human readable format into
 754  * the given GString.
 755  */
 756 void
 757 gst_print_pad_caps (GString * buf, gint indent, GstPad * pad)
 758 {
 759   GstCaps *caps;
 760
 761   caps = gst_pad_get_current_caps (pad);
 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     gst_caps_unref (caps);
 775   }
 776 }
 777
 778 /**
 779  * gst_print_element_args:
 780  * @buf: the buffer to print the args in
 781  * @indent: initial indentation
 782  * @element: (transfer none): the element to print the args of
 783  *
 784  * Print the element argument in a human readable format in the given
 785  * GString.
 786  */
 787 void
 788 gst_print_element_args (GString * buf, gint indent, GstElement * element)
 789 {
 790   guint width;
 791   GValue value = { 0, };        /* the important thing is that value.type = 0 */
 792   gchar *str = NULL;
 793   GParamSpec *spec, **specs, **walk;
 794
 795   specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (element), NULL);
 796
 797   width = 0;
 798   for (walk = specs; *walk; walk++) {
 799     spec = *walk;
 800     if (width < strlen (spec->name))
 801       width = strlen (spec->name);
 802   }
 803
 804   for (walk = specs; *walk; walk++) {
 805     spec = *walk;
 806
 807     if (spec->flags & G_PARAM_READABLE) {
 808       g_value_init (&value, spec->value_type);
 809       g_object_get_property (G_OBJECT (element), spec->name, &value);
 810       str = g_strdup_value_contents (&value);
 811       g_value_unset (&value);
 812     } else {
 813       str = g_strdup ("Parameter not readable.");
 814     }
 815
 816     string_append_indent (buf, indent);
 817     g_string_append (buf, spec->name);
 818     string_append_indent (buf, 2 + width - strlen (spec->name));
 819     g_string_append (buf, str);
 820     g_string_append_c (buf, '\n');
 821
 822     g_free (str);
 823   }
 824
 825   g_free (specs);
 826 }
 827
 828 /**
 829  * gst_element_create_all_pads:
 830  * @element: (transfer none): a #GstElement to create pads for
 831  *
 832  * Creates a pad for each pad template that is always available.
 833  * This function is only useful during object initialization of
 834  * subclasses of #GstElement.
 835  */
 836 void
 837 gst_element_create_all_pads (GstElement * element)
 838 {
 839   GList *padlist;
 840
 841   /* FIXME: lock element */
 842
 843   padlist =
 844       gst_element_class_get_pad_template_list (GST_ELEMENT_CLASS
 845       (G_OBJECT_GET_CLASS (element)));
 846
 847   while (padlist) {
 848     GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
 849
 850     if (padtempl->presence == GST_PAD_ALWAYS) {
 851       GstPad *pad;
 852
 853       pad = gst_pad_new_from_template (padtempl, padtempl->name_template);
 854
 855       gst_element_add_pad (element, pad);
 856     }
 857     padlist = padlist->next;
 858   }
 859 }
 860
 861 /**
 862  * gst_element_get_compatible_pad_template:
 863  * @element: (transfer none): a #GstElement to get a compatible pad template for
 864  * @compattempl: (transfer none): the #GstPadTemplate to find a compatible
 865  *     template for
 866  *
 867  * Retrieves a pad template from @element that is compatible with @compattempl.
 868  * Pads from compatible templates can be linked together.
 869  *
 870  * Returns: (transfer none): a compatible #GstPadTemplate, or NULL if none
 871  *     was found. No unreferencing is necessary.
 872  */
 873 GstPadTemplate *
 874 gst_element_get_compatible_pad_template (GstElement * element,
 875     GstPadTemplate * compattempl)
 876 {
 877   GstPadTemplate *newtempl = NULL;
 878   GList *padlist;
 879   GstElementClass *class;
 880   gboolean compatible;
 881
 882   g_return_val_if_fail (element != NULL, NULL);
 883   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
 884   g_return_val_if_fail (compattempl != NULL, NULL);
 885
 886   class = GST_ELEMENT_GET_CLASS (element);
 887
 888   padlist = gst_element_class_get_pad_template_list (class);
 889
 890   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
 891       "Looking for a suitable pad template in %s out of %d templates...",
 892       GST_ELEMENT_NAME (element), g_list_length (padlist));
 893
 894   while (padlist) {
 895     GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
 896
 897     /* Ignore name
 898      * Ignore presence
 899      * Check direction (must be opposite)
 900      * Check caps
 901      */
 902     GST_CAT_LOG (GST_CAT_CAPS,
 903         "checking pad template %s", padtempl->name_template);
 904     if (padtempl->direction != compattempl->direction) {
 905       GST_CAT_DEBUG (GST_CAT_CAPS,
 906           "compatible direction: found %s pad template \"%s\"",
 907           padtempl->direction == GST_PAD_SRC ? "src" : "sink",
 908           padtempl->name_template);
 909
 910       GST_CAT_DEBUG (GST_CAT_CAPS,
 911           "intersecting %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (compattempl));
 912       GST_CAT_DEBUG (GST_CAT_CAPS,
 913           "..and %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (padtempl));
 914
 915       compatible = gst_caps_can_intersect (GST_PAD_TEMPLATE_CAPS (compattempl),
 916           GST_PAD_TEMPLATE_CAPS (padtempl));
 917
 918       GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible",
 919           (compatible ? "" : "not "));
 920
 921       if (compatible) {
 922         newtempl = padtempl;
 923         break;
 924       }
 925     }
 926
 927     padlist = g_list_next (padlist);
 928   }
 929   if (newtempl)
 930     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
 931         "Returning new pad template %p", newtempl);
 932   else
 933     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "No compatible pad template found");
 934
 935   return newtempl;
 936 }
 937
 938 /**
 939  * gst_element_get_pad_from_template:
 940  * @element: (transfer none): a #GstElement.
 941  * @templ: (transfer none): a #GstPadTemplate belonging to @element.
 942  *
 943  * Gets a pad from @element described by @templ. If the presence of @templ is
 944  * #GST_PAD_REQUEST, requests a new pad. Can return %NULL for #GST_PAD_SOMETIMES
 945  * templates.
 946  *
 947  * Returns: (transfer full): the #GstPad, or NULL if one could not be found
 948  *     or created.
 949  */
 950 static GstPad *
 951 gst_element_get_pad_from_template (GstElement * element, GstPadTemplate * templ)
 952 {
 953   GstPad *ret = NULL;
 954   GstPadPresence presence;
 955
 956   /* If this function is ever exported, we need check the validity of `element'
 957    * and `templ', and to make sure the template actually belongs to the
 958    * element. */
 959
 960   presence = GST_PAD_TEMPLATE_PRESENCE (templ);
 961
 962   switch (presence) {
 963     case GST_PAD_ALWAYS:
 964     case GST_PAD_SOMETIMES:
 965       ret = gst_element_get_static_pad (element, templ->name_template);
 966       if (!ret && presence == GST_PAD_ALWAYS)
 967         g_warning
 968             ("Element %s has an ALWAYS template %s, but no pad of the same name",
 969             GST_OBJECT_NAME (element), templ->name_template);
 970       break;
 971
 972     case GST_PAD_REQUEST:
 973       ret = gst_element_request_pad (element, templ, NULL, NULL);
 974       break;
 975   }
 976
 977   return ret;
 978 }
 979
 980 /*
 981  * gst_element_request_compatible_pad:
 982  * @element: a #GstElement.
 983  * @templ: the #GstPadTemplate to which the new pad should be able to link.
 984  *
 985  * Requests a pad from @element. The returned pad should be unlinked and
 986  * compatible with @templ. Might return an existing pad, or request a new one.
 987  *
 988  * Returns: a #GstPad, or %NULL if one could not be found or created.
 989  */
 990 static GstPad *
 991 gst_element_request_compatible_pad (GstElement * element,
 992     GstPadTemplate * templ)
 993 {
 994   GstPadTemplate *templ_new;
 995   GstPad *pad = NULL;
 996
 997   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
 998   g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
 999
1000   /* FIXME: should really loop through the templates, testing each for
1001    *      compatibility and pad availability. */
1002   templ_new = gst_element_get_compatible_pad_template (element, templ);
1003   if (templ_new)
1004     pad = gst_element_get_pad_from_template (element, templ_new);
1005
1006   /* This can happen for non-request pads. No need to unref. */
1007   if (pad && GST_PAD_PEER (pad))
1008     pad = NULL;
1009
1010   return pad;
1011 }
1012
1013 /*
1014  * Checks if the source pad and the sink pad can be linked.
1015  * Both @srcpad and @sinkpad must be unlinked and have a parent.
1016  */
1017 static gboolean
1018 gst_pad_check_link (GstPad * srcpad, GstPad * sinkpad)
1019 {
1020   /* FIXME This function is gross.  It's almost a direct copy of
1021    * gst_pad_link_filtered().  Any decent programmer would attempt
1022    * to merge the two functions, which I will do some day. --ds
1023    */
1024
1025   /* generic checks */
1026   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1027   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1028
1029   GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
1030       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1031
1032   /* FIXME: shouldn't we convert this to g_return_val_if_fail? */
1033   if (GST_PAD_PEER (srcpad) != NULL) {
1034     GST_CAT_INFO (GST_CAT_PADS, "Source pad %s:%s has a peer, failed",
1035         GST_DEBUG_PAD_NAME (srcpad));
1036     return FALSE;
1037   }
1038   if (GST_PAD_PEER (sinkpad) != NULL) {
1039     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has a peer, failed",
1040         GST_DEBUG_PAD_NAME (sinkpad));
1041     return FALSE;
1042   }
1043   if (!GST_PAD_IS_SRC (srcpad)) {
1044     GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s is not source pad, failed",
1045         GST_DEBUG_PAD_NAME (srcpad));
1046     return FALSE;
1047   }
1048   if (!GST_PAD_IS_SINK (sinkpad)) {
1049     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s is not sink pad, failed",
1050         GST_DEBUG_PAD_NAME (sinkpad));
1051     return FALSE;
1052   }
1053   if (GST_PAD_PARENT (srcpad) == NULL) {
1054     GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s has no parent, failed",
1055         GST_DEBUG_PAD_NAME (srcpad));
1056     return FALSE;
1057   }
1058   if (GST_PAD_PARENT (sinkpad) == NULL) {
1059     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has no parent, failed",
1060         GST_DEBUG_PAD_NAME (srcpad));
1061     return FALSE;
1062   }
1063
1064   return TRUE;
1065 }
1066
1067 /**
1068  * gst_element_get_compatible_pad:
1069  * @element: (transfer none): a #GstElement in which the pad should be found.
1070  * @pad: (transfer none): the #GstPad to find a compatible one for.
1071  * @caps: the #GstCaps to use as a filter.
1072  *
1073  * Looks for an unlinked pad to which the given pad can link. It is not
1074  * guaranteed that linking the pads will work, though it should work in most
1075  * cases.
1076  *
1077  * This function will first attempt to find a compatible unlinked ALWAYS pad,
1078  * and if none can be found, it will request a compatible REQUEST pad by looking
1079  * at the templates of @element.
1080  *
1081  * Returns: (transfer full): the #GstPad to which a link can be made, or %NULL
1082  *     if one cannot be found. gst_object_unref() after usage.
1083  */
1084 GstPad *
1085 gst_element_get_compatible_pad (GstElement * element, GstPad * pad,
1086     GstCaps * caps)
1087 {
1088   GstIterator *pads;
1089   GstPadTemplate *templ;
1090   GstCaps *templcaps;
1091   GstPad *foundpad = NULL;
1092   gboolean done;
1093   GValue padptr = { 0, };
1094
1095   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
1096   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1097
1098   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1099       "finding pad in %s compatible with %s:%s",
1100       GST_ELEMENT_NAME (element), GST_DEBUG_PAD_NAME (pad));
1101
1102   g_return_val_if_fail (GST_PAD_PEER (pad) == NULL, NULL);
1103
1104   done = FALSE;
1105
1106   /* try to get an existing unlinked pad */
1107   if (GST_PAD_IS_SRC (pad)) {
1108     pads = gst_element_iterate_sink_pads (element);
1109   } else if (GST_PAD_IS_SINK (pad)) {
1110     pads = gst_element_iterate_src_pads (element);
1111   } else {
1112     pads = gst_element_iterate_pads (element);
1113   }
1114
1115   while (!done) {
1116     switch (gst_iterator_next (pads, &padptr)) {
1117       case GST_ITERATOR_OK:
1118       {
1119         GstPad *peer;
1120         GstPad *current;
1121         GstPad *srcpad;
1122         GstPad *sinkpad;
1123
1124         current = g_value_get_object (&padptr);
1125
1126         GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
1127             GST_DEBUG_PAD_NAME (current));
1128
1129         if (GST_PAD_IS_SRC (current)) {
1130           srcpad = current;
1131           sinkpad = pad;
1132         } else {
1133           srcpad = pad;
1134           sinkpad = current;
1135         }
1136         peer = gst_pad_get_peer (current);
1137
1138         if (peer == NULL && gst_pad_check_link (srcpad, sinkpad)) {
1139           GstCaps *temp, *intersection;
1140           gboolean compatible;
1141
1142           /* Now check if the two pads' caps are compatible */
1143           temp = gst_pad_query_caps (pad, NULL);
1144           if (caps) {
1145             intersection = gst_caps_intersect (temp, caps);
1146             gst_caps_unref (temp);
1147           } else {
1148             intersection = temp;
1149           }
1150
1151           temp = gst_pad_query_caps (current, NULL);
1152           compatible = gst_caps_can_intersect (temp, intersection);
1153           gst_caps_unref (temp);
1154           gst_caps_unref (intersection);
1155
1156           if (compatible) {
1157             GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1158                 "found existing unlinked compatible pad %s:%s",
1159                 GST_DEBUG_PAD_NAME (current));
1160             gst_iterator_free (pads);
1161
1162             current = gst_object_ref (current);
1163             g_value_unset (&padptr);
1164
1165             return current;
1166           } else {
1167             GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "incompatible pads");
1168           }
1169         } else {
1170           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1171               "already linked or cannot be linked (peer = %p)", peer);
1172         }
1173         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unreffing pads");
1174
1175         g_value_reset (&padptr);
1176         if (peer)
1177           gst_object_unref (peer);
1178         break;
1179       }
1180       case GST_ITERATOR_DONE:
1181         done = TRUE;
1182         break;
1183       case GST_ITERATOR_RESYNC:
1184         gst_iterator_resync (pads);
1185         break;
1186       case GST_ITERATOR_ERROR:
1187         g_assert_not_reached ();
1188         break;
1189     }
1190   }
1191   g_value_unset (&padptr);
1192   gst_iterator_free (pads);
1193
1194   GST_CAT_DEBUG_OBJECT (GST_CAT_ELEMENT_PADS, element,
1195       "Could not find a compatible unlinked always pad to link to %s:%s, now checking request pads",
1196       GST_DEBUG_PAD_NAME (pad));
1197
1198   /* try to create a new one */
1199   /* requesting is a little crazy, we need a template. Let's create one */
1200   /* FIXME: why not gst_pad_get_pad_template (pad); */
1201   templcaps = gst_pad_query_caps (pad, NULL);
1202   templ = gst_pad_template_new ((gchar *) GST_PAD_NAME (pad),
1203       GST_PAD_DIRECTION (pad), GST_PAD_ALWAYS, templcaps);
1204   gst_caps_unref (templcaps);
1205
1206   foundpad = gst_element_request_compatible_pad (element, templ);
1207   gst_object_unref (templ);
1208
1209   if (foundpad) {
1210     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1211         "found existing request pad %s:%s", GST_DEBUG_PAD_NAME (foundpad));
1212     return foundpad;
1213   }
1214
1215   GST_CAT_INFO_OBJECT (GST_CAT_ELEMENT_PADS, element,
1216       "Could not find a compatible pad to link to %s:%s",
1217       GST_DEBUG_PAD_NAME (pad));
1218   return NULL;
1219 }
1220
1221 /**
1222  * gst_element_state_get_name:
1223  * @state: a #GstState to get the name of.
1224  *
1225  * Gets a string representing the given state.
1226  *
1227  * Returns: (transfer none): a string with the name of the state.
1228  */
1229 const gchar *
1230 gst_element_state_get_name (GstState state)
1231 {
1232   switch (state) {
1233     case GST_STATE_VOID_PENDING:
1234       return "VOID_PENDING";
1235     case GST_STATE_NULL:
1236       return "NULL";
1237     case GST_STATE_READY:
1238       return "READY";
1239     case GST_STATE_PLAYING:
1240       return "PLAYING";
1241     case GST_STATE_PAUSED:
1242       return "PAUSED";
1243     default:
1244       /* This is a memory leak */
1245       return g_strdup_printf ("UNKNOWN!(%d)", state);
1246   }
1247 }
1248
1249 /**
1250  * gst_element_state_change_return_get_name:
1251  * @state_ret: a #GstStateChangeReturn to get the name of.
1252  *
1253  * Gets a string representing the given state change result.
1254  *
1255  * Returns: (transfer none): a string with the name of the state
1256  *    result.
1257  *
1258  * Since: 0.10.11
1259  */
1260 const gchar *
1261 gst_element_state_change_return_get_name (GstStateChangeReturn state_ret)
1262 {
1263   switch (state_ret) {
1264     case GST_STATE_CHANGE_FAILURE:
1265       return "FAILURE";
1266     case GST_STATE_CHANGE_SUCCESS:
1267       return "SUCCESS";
1268     case GST_STATE_CHANGE_ASYNC:
1269       return "ASYNC";
1270     case GST_STATE_CHANGE_NO_PREROLL:
1271       return "NO PREROLL";
1272     default:
1273       /* This is a memory leak */
1274       return g_strdup_printf ("UNKNOWN!(%d)", state_ret);
1275   }
1276 }
1277
1278
1279 static gboolean
1280 gst_element_factory_can_accept_all_caps_in_direction (GstElementFactory *
1281     factory, const GstCaps * caps, GstPadDirection direction)
1282 {
1283   GList *templates;
1284
1285   g_return_val_if_fail (factory != NULL, FALSE);
1286   g_return_val_if_fail (caps != NULL, FALSE);
1287
1288   templates = factory->staticpadtemplates;
1289
1290   while (templates) {
1291     GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1292
1293     if (template->direction == direction) {
1294       GstCaps *templcaps = gst_static_caps_get (&template->static_caps);
1295
1296       if (gst_caps_is_always_compatible (caps, templcaps)) {
1297         gst_caps_unref (templcaps);
1298         return TRUE;
1299       }
1300       gst_caps_unref (templcaps);
1301     }
1302     templates = g_list_next (templates);
1303   }
1304
1305   return FALSE;
1306 }
1307
1308 static gboolean
1309 gst_element_factory_can_accept_any_caps_in_direction (GstElementFactory *
1310     factory, const GstCaps * caps, GstPadDirection direction)
1311 {
1312   GList *templates;
1313
1314   g_return_val_if_fail (factory != NULL, FALSE);
1315   g_return_val_if_fail (caps != NULL, FALSE);
1316
1317   templates = factory->staticpadtemplates;
1318
1319   while (templates) {
1320     GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1321
1322     if (template->direction == direction) {
1323       GstCaps *templcaps = gst_static_caps_get (&template->static_caps);
1324
1325       if (gst_caps_can_intersect (caps, templcaps)) {
1326         gst_caps_unref (templcaps);
1327         return TRUE;
1328       }
1329       gst_caps_unref (templcaps);
1330     }
1331     templates = g_list_next (templates);
1332   }
1333
1334   return FALSE;
1335 }
1336
1337 /**
1338  * gst_element_factory_can_sink_all_caps:
1339  * @factory: factory to query
1340  * @caps: the caps to check
1341  *
1342  * Checks if the factory can sink all possible capabilities.
1343  *
1344  * Returns: %TRUE if the caps are fully compatible.
1345  *
1346  * Since: 0.10.33
1347  */
1348 gboolean
1349 gst_element_factory_can_sink_all_caps (GstElementFactory * factory,
1350     const GstCaps * caps)
1351 {
1352   return gst_element_factory_can_accept_all_caps_in_direction (factory, caps,
1353       GST_PAD_SINK);
1354 }
1355
1356 /**
1357  * gst_element_factory_can_src_all_caps:
1358  * @factory: factory to query
1359  * @caps: the caps to check
1360  *
1361  * Checks if the factory can src all possible capabilities.
1362  *
1363  * Returns: %TRUE if the caps are fully compatible.
1364  *
1365  * Since: 0.10.33
1366  */
1367 gboolean
1368 gst_element_factory_can_src_all_caps (GstElementFactory * factory,
1369     const GstCaps * caps)
1370 {
1371   return gst_element_factory_can_accept_all_caps_in_direction (factory, caps,
1372       GST_PAD_SRC);
1373 }
1374
1375 /**
1376  * gst_element_factory_can_sink_any_caps:
1377  * @factory: factory to query
1378  * @caps: the caps to check
1379  *
1380  * Checks if the factory can sink any possible capability.
1381  *
1382  * Returns: %TRUE if the caps have a common subset.
1383  *
1384  * Since: 0.10.33
1385  */
1386 gboolean
1387 gst_element_factory_can_sink_any_caps (GstElementFactory * factory,
1388     const GstCaps * caps)
1389 {
1390   return gst_element_factory_can_accept_any_caps_in_direction (factory, caps,
1391       GST_PAD_SINK);
1392 }
1393
1394 /**
1395  * gst_element_factory_can_src_any_caps:
1396  * @factory: factory to query
1397  * @caps: the caps to check
1398  *
1399  * Checks if the factory can src any possible capability.
1400  *
1401  * Returns: %TRUE if the caps have a common subset.
1402  *
1403  * Since: 0.10.33
1404  */
1405 gboolean
1406 gst_element_factory_can_src_any_caps (GstElementFactory * factory,
1407     const GstCaps * caps)
1408 {
1409   return gst_element_factory_can_accept_any_caps_in_direction (factory, caps,
1410       GST_PAD_SRC);
1411 }
1412
1413 /* if return val is true, *direct_child is a caller-owned ref on the direct
1414  * child of ancestor that is part of object's ancestry */
1415 static gboolean
1416 object_has_ancestor (GstObject * object, GstObject * ancestor,
1417     GstObject ** direct_child)
1418 {
1419   GstObject *child, *parent;
1420
1421   if (direct_child)
1422     *direct_child = NULL;
1423
1424   child = gst_object_ref (object);
1425   parent = gst_object_get_parent (object);
1426
1427   while (parent) {
1428     if (ancestor == parent) {
1429       if (direct_child)
1430         *direct_child = child;
1431       else
1432         gst_object_unref (child);
1433       gst_object_unref (parent);
1434       return TRUE;
1435     }
1436
1437     gst_object_unref (child);
1438     child = parent;
1439     parent = gst_object_get_parent (parent);
1440   }
1441
1442   gst_object_unref (child);
1443
1444   return FALSE;
1445 }
1446
1447 /* caller owns return */
1448 static GstObject *
1449 find_common_root (GstObject * o1, GstObject * o2)
1450 {
1451   GstObject *top = o1;
1452   GstObject *kid1, *kid2;
1453   GstObject *root = NULL;
1454
1455   while (GST_OBJECT_PARENT (top))
1456     top = GST_OBJECT_PARENT (top);
1457
1458   /* the itsy-bitsy spider... */
1459
1460   if (!object_has_ancestor (o2, top, &kid2))
1461     return NULL;
1462
1463   root = gst_object_ref (top);
1464   while (TRUE) {
1465     if (!object_has_ancestor (o1, kid2, &kid1)) {
1466       gst_object_unref (kid2);
1467       return root;
1468     }
1469     root = kid2;
1470     if (!object_has_ancestor (o2, kid1, &kid2)) {
1471       gst_object_unref (kid1);
1472       return root;
1473     }
1474     root = kid1;
1475   }
1476 }
1477
1478 /* caller does not own return */
1479 static GstPad *
1480 ghost_up (GstElement * e, GstPad * pad)
1481 {
1482   static gint ghost_pad_index = 0;
1483   GstPad *gpad;
1484   gchar *name;
1485   GstState current;
1486   GstState next;
1487   GstObject *parent = GST_OBJECT_PARENT (e);
1488
1489   name = g_strdup_printf ("ghost%d", ghost_pad_index++);
1490   gpad = gst_ghost_pad_new (name, pad);
1491   g_free (name);
1492
1493   GST_STATE_LOCK (e);
1494   gst_element_get_state (e, &current, &next, 0);
1495
1496   if (current > GST_STATE_READY || next == GST_STATE_PAUSED)
1497     gst_pad_set_active (gpad, TRUE);
1498
1499   if (!gst_element_add_pad ((GstElement *) parent, gpad)) {
1500     g_warning ("Pad named %s already exists in element %s\n",
1501         GST_OBJECT_NAME (gpad), GST_OBJECT_NAME (parent));
1502     gst_object_unref ((GstObject *) gpad);
1503     GST_STATE_UNLOCK (e);
1504     return NULL;
1505   }
1506   GST_STATE_UNLOCK (e);
1507
1508   return gpad;
1509 }
1510
1511 static void
1512 remove_pad (gpointer ppad, gpointer unused)
1513 {
1514   GstPad *pad = ppad;
1515
1516   if (!gst_element_remove_pad ((GstElement *) GST_OBJECT_PARENT (pad), pad))
1517     g_warning ("Couldn't remove pad %s from element %s",
1518         GST_OBJECT_NAME (pad), GST_OBJECT_NAME (GST_OBJECT_PARENT (pad)));
1519 }
1520
1521 static gboolean
1522 prepare_link_maybe_ghosting (GstPad ** src, GstPad ** sink,
1523     GSList ** pads_created)
1524 {
1525   GstObject *root;
1526   GstObject *e1, *e2;
1527   GSList *pads_created_local = NULL;
1528
1529   g_assert (pads_created);
1530
1531   e1 = GST_OBJECT_PARENT (*src);
1532   e2 = GST_OBJECT_PARENT (*sink);
1533
1534   if (G_UNLIKELY (e1 == NULL)) {
1535     GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1536         GST_PTR_FORMAT, *src);
1537     return FALSE;
1538   }
1539   if (G_UNLIKELY (e2 == NULL)) {
1540     GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1541         GST_PTR_FORMAT, *sink);
1542     return FALSE;
1543   }
1544
1545   if (GST_OBJECT_PARENT (e1) == GST_OBJECT_PARENT (e2)) {
1546     GST_CAT_INFO (GST_CAT_PADS, "%s and %s in same bin, no need for ghost pads",
1547         GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1548     return TRUE;
1549   }
1550
1551   GST_CAT_INFO (GST_CAT_PADS, "%s and %s not in same bin, making ghost pads",
1552       GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1553
1554   /* we need to setup some ghost pads */
1555   root = find_common_root (e1, e2);
1556   if (!root) {
1557     g_warning ("Trying to connect elements that don't share a common "
1558         "ancestor: %s and %s", GST_ELEMENT_NAME (e1), GST_ELEMENT_NAME (e2));
1559     return FALSE;
1560   }
1561
1562   while (GST_OBJECT_PARENT (e1) != root) {
1563     *src = ghost_up ((GstElement *) e1, *src);
1564     if (!*src)
1565       goto cleanup_fail;
1566     e1 = GST_OBJECT_PARENT (*src);
1567     pads_created_local = g_slist_prepend (pads_created_local, *src);
1568   }
1569   while (GST_OBJECT_PARENT (e2) != root) {
1570     *sink = ghost_up ((GstElement *) e2, *sink);
1571     if (!*sink)
1572       goto cleanup_fail;
1573     e2 = GST_OBJECT_PARENT (*sink);
1574     pads_created_local = g_slist_prepend (pads_created_local, *sink);
1575   }
1576
1577   gst_object_unref (root);
1578   *pads_created = g_slist_concat (*pads_created, pads_created_local);
1579   return TRUE;
1580
1581 cleanup_fail:
1582   gst_object_unref (root);
1583   g_slist_foreach (pads_created_local, remove_pad, NULL);
1584   g_slist_free (pads_created_local);
1585   return FALSE;
1586 }
1587
1588 static gboolean
1589 pad_link_maybe_ghosting (GstPad * src, GstPad * sink, GstPadLinkCheck flags)
1590 {
1591   GSList *pads_created = NULL;
1592   gboolean ret;
1593
1594   if (!prepare_link_maybe_ghosting (&src, &sink, &pads_created)) {
1595     ret = FALSE;
1596   } else {
1597     ret = (gst_pad_link_full (src, sink, flags) == GST_PAD_LINK_OK);
1598   }
1599
1600   if (!ret) {
1601     g_slist_foreach (pads_created, remove_pad, NULL);
1602   }
1603   g_slist_free (pads_created);
1604
1605   return ret;
1606 }
1607
1608 /**
1609  * gst_element_link_pads_full:
1610  * @src: a #GstElement containing the source pad.
1611  * @srcpadname: (allow-none): the name of the #GstPad in source element
1612  *     or NULL for any pad.
1613  * @dest: (transfer none): the #GstElement containing the destination pad.
1614  * @destpadname: (allow-none): the name of the #GstPad in destination element,
1615  * or NULL for any pad.
1616  * @flags: the #GstPadLinkCheck to be performed when linking pads.
1617  *
1618  * Links the two named pads of the source and destination elements.
1619  * Side effect is that if one of the pads has no parent, it becomes a
1620  * child of the parent of the other element.  If they have different
1621  * parents, the link fails.
1622  *
1623  * Calling gst_element_link_pads_full() with @flags == %GST_PAD_LINK_CHECK_DEFAULT
1624  * is the same as calling gst_element_link_pads() and the recommended way of
1625  * linking pads with safety checks applied.
1626  *
1627  * This is a convenience function for gst_pad_link_full().
1628  *
1629  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1630  *
1631  * Since: 0.10.30
1632  */
1633 gboolean
1634 gst_element_link_pads_full (GstElement * src, const gchar * srcpadname,
1635     GstElement * dest, const gchar * destpadname, GstPadLinkCheck flags)
1636 {
1637   const GList *srcpads, *destpads, *srctempls, *desttempls, *l;
1638   GstPad *srcpad, *destpad;
1639   GstPadTemplate *srctempl, *desttempl;
1640   GstElementClass *srcclass, *destclass;
1641
1642   /* checks */
1643   g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1644   g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1645
1646   GST_CAT_INFO (GST_CAT_ELEMENT_PADS,
1647       "trying to link element %s:%s to element %s:%s", GST_ELEMENT_NAME (src),
1648       srcpadname ? srcpadname : "(any)", GST_ELEMENT_NAME (dest),
1649       destpadname ? destpadname : "(any)");
1650
1651   /* get a src pad */
1652   if (srcpadname) {
1653     /* name specified, look it up */
1654     if (!(srcpad = gst_element_get_static_pad (src, srcpadname)))
1655       srcpad = gst_element_get_request_pad (src, srcpadname);
1656     if (!srcpad) {
1657       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1658           GST_ELEMENT_NAME (src), srcpadname);
1659       return FALSE;
1660     } else {
1661       if (!(GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC)) {
1662         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no src pad",
1663             GST_DEBUG_PAD_NAME (srcpad));
1664         gst_object_unref (srcpad);
1665         return FALSE;
1666       }
1667       if (GST_PAD_PEER (srcpad) != NULL) {
1668         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1669             "pad %s:%s is already linked to %s:%s", GST_DEBUG_PAD_NAME (srcpad),
1670             GST_DEBUG_PAD_NAME (GST_PAD_PEER (srcpad)));
1671         gst_object_unref (srcpad);
1672         return FALSE;
1673       }
1674     }
1675     srcpads = NULL;
1676   } else {
1677     /* no name given, get the first available pad */
1678     GST_OBJECT_LOCK (src);
1679     srcpads = GST_ELEMENT_PADS (src);
1680     srcpad = srcpads ? GST_PAD_CAST (srcpads->data) : NULL;
1681     if (srcpad)
1682       gst_object_ref (srcpad);
1683     GST_OBJECT_UNLOCK (src);
1684   }
1685
1686   /* get a destination pad */
1687   if (destpadname) {
1688     /* name specified, look it up */
1689     if (!(destpad = gst_element_get_static_pad (dest, destpadname)))
1690       destpad = gst_element_get_request_pad (dest, destpadname);
1691     if (!destpad) {
1692       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1693           GST_ELEMENT_NAME (dest), destpadname);
1694       return FALSE;
1695     } else {
1696       if (!(GST_PAD_DIRECTION (destpad) == GST_PAD_SINK)) {
1697         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no sink pad",
1698             GST_DEBUG_PAD_NAME (destpad));
1699         gst_object_unref (destpad);
1700         return FALSE;
1701       }
1702       if (GST_PAD_PEER (destpad) != NULL) {
1703         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1704             "pad %s:%s is already linked to %s:%s",
1705             GST_DEBUG_PAD_NAME (destpad),
1706             GST_DEBUG_PAD_NAME (GST_PAD_PEER (destpad)));
1707         gst_object_unref (destpad);
1708         return FALSE;
1709       }
1710     }
1711     destpads = NULL;
1712   } else {
1713     /* no name given, get the first available pad */
1714     GST_OBJECT_LOCK (dest);
1715     destpads = GST_ELEMENT_PADS (dest);
1716     destpad = destpads ? GST_PAD_CAST (destpads->data) : NULL;
1717     if (destpad)
1718       gst_object_ref (destpad);
1719     GST_OBJECT_UNLOCK (dest);
1720   }
1721
1722   if (srcpadname && destpadname) {
1723     gboolean result;
1724
1725     /* two explicitly specified pads */
1726     result = pad_link_maybe_ghosting (srcpad, destpad, flags);
1727
1728     gst_object_unref (srcpad);
1729     gst_object_unref (destpad);
1730
1731     return result;
1732   }
1733
1734   if (srcpad) {
1735     /* loop through the allowed pads in the source, trying to find a
1736      * compatible destination pad */
1737     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1738         "looping through allowed src and dest pads");
1739     do {
1740       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying src pad %s:%s",
1741           GST_DEBUG_PAD_NAME (srcpad));
1742       if ((GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC) &&
1743           (GST_PAD_PEER (srcpad) == NULL)) {
1744         GstPad *temp;
1745
1746         if (destpadname) {
1747           temp = destpad;
1748           gst_object_ref (temp);
1749         } else {
1750           temp = gst_element_get_compatible_pad (dest, srcpad, NULL);
1751         }
1752
1753         if (temp && pad_link_maybe_ghosting (srcpad, temp, flags)) {
1754           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1755               GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (temp));
1756           if (destpad)
1757             gst_object_unref (destpad);
1758           gst_object_unref (srcpad);
1759           gst_object_unref (temp);
1760           return TRUE;
1761         }
1762
1763         if (temp) {
1764           gst_object_unref (temp);
1765         }
1766       }
1767       /* find a better way for this mess */
1768       if (srcpads) {
1769         srcpads = g_list_next (srcpads);
1770         if (srcpads) {
1771           gst_object_unref (srcpad);
1772           srcpad = GST_PAD_CAST (srcpads->data);
1773           gst_object_ref (srcpad);
1774         }
1775       }
1776     } while (srcpads);
1777   }
1778   if (srcpadname) {
1779     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s:%s to %s",
1780         GST_DEBUG_PAD_NAME (srcpad), GST_ELEMENT_NAME (dest));
1781     if (destpad)
1782       gst_object_unref (destpad);
1783     destpad = NULL;
1784   }
1785   if (srcpad)
1786     gst_object_unref (srcpad);
1787   srcpad = NULL;
1788
1789   if (destpad) {
1790     /* loop through the existing pads in the destination */
1791     do {
1792       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying dest pad %s:%s",
1793           GST_DEBUG_PAD_NAME (destpad));
1794       if ((GST_PAD_DIRECTION (destpad) == GST_PAD_SINK) &&
1795           (GST_PAD_PEER (destpad) == NULL)) {
1796         GstPad *temp = gst_element_get_compatible_pad (src, destpad, NULL);
1797
1798         if (temp && pad_link_maybe_ghosting (temp, destpad, flags)) {
1799           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1800               GST_DEBUG_PAD_NAME (temp), GST_DEBUG_PAD_NAME (destpad));
1801           gst_object_unref (temp);
1802           gst_object_unref (destpad);
1803           return TRUE;
1804         }
1805         if (temp) {
1806           gst_object_unref (temp);
1807         }
1808       }
1809       if (destpads) {
1810         destpads = g_list_next (destpads);
1811         if (destpads) {
1812           gst_object_unref (destpad);
1813           destpad = GST_PAD_CAST (destpads->data);
1814           gst_object_ref (destpad);
1815         }
1816       }
1817     } while (destpads);
1818   }
1819
1820   if (destpadname) {
1821     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s:%s",
1822         GST_ELEMENT_NAME (src), GST_DEBUG_PAD_NAME (destpad));
1823     gst_object_unref (destpad);
1824     return FALSE;
1825   } else {
1826     if (destpad)
1827       gst_object_unref (destpad);
1828     destpad = NULL;
1829   }
1830
1831   srcclass = GST_ELEMENT_GET_CLASS (src);
1832   destclass = GST_ELEMENT_GET_CLASS (dest);
1833
1834   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1835       "we might have request pads on both sides, checking...");
1836   srctempls = gst_element_class_get_pad_template_list (srcclass);
1837   desttempls = gst_element_class_get_pad_template_list (destclass);
1838
1839   if (srctempls && desttempls) {
1840     while (srctempls) {
1841       srctempl = (GstPadTemplate *) srctempls->data;
1842       if (srctempl->presence == GST_PAD_REQUEST) {
1843         for (l = desttempls; l; l = l->next) {
1844           desttempl = (GstPadTemplate *) l->data;
1845           if (desttempl->presence == GST_PAD_REQUEST &&
1846               desttempl->direction != srctempl->direction) {
1847             GstCaps *srccaps, *destcaps;
1848
1849             srccaps = gst_pad_template_get_caps (srctempl);
1850             destcaps = gst_pad_template_get_caps (desttempl);
1851             if (gst_caps_is_always_compatible (srccaps, destcaps)) {
1852               srcpad =
1853                   gst_element_request_pad (src, srctempl,
1854                   srctempl->name_template, NULL);
1855               destpad =
1856                   gst_element_request_pad (dest, desttempl,
1857                   desttempl->name_template, NULL);
1858               if (srcpad && destpad
1859                   && pad_link_maybe_ghosting (srcpad, destpad, flags)) {
1860                 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1861                     "linked pad %s:%s to pad %s:%s",
1862                     GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (destpad));
1863                 gst_object_unref (srcpad);
1864                 gst_object_unref (destpad);
1865                 gst_caps_unref (srccaps);
1866                 gst_caps_unref (destcaps);
1867                 return TRUE;
1868               }
1869               /* it failed, so we release the request pads */
1870               if (srcpad)
1871                 gst_element_release_request_pad (src, srcpad);
1872               if (destpad)
1873                 gst_element_release_request_pad (dest, destpad);
1874             }
1875             gst_caps_unref (srccaps);
1876             gst_caps_unref (destcaps);
1877           }
1878         }
1879       }
1880       srctempls = srctempls->next;
1881     }
1882   }
1883
1884   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s",
1885       GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
1886   return FALSE;
1887 }
1888
1889 /**
1890  * gst_element_link_pads:
1891  * @src: a #GstElement containing the source pad.
1892  * @srcpadname: (allow-none): the name of the #GstPad in source element
1893  *     or NULL for any pad.
1894  * @dest: (transfer none): the #GstElement containing the destination pad.
1895  * @destpadname: (allow-none): the name of the #GstPad in destination element,
1896  * or NULL for any pad.
1897  *
1898  * Links the two named pads of the source and destination elements.
1899  * Side effect is that if one of the pads has no parent, it becomes a
1900  * child of the parent of the other element.  If they have different
1901  * parents, the link fails.
1902  *
1903  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1904  */
1905 gboolean
1906 gst_element_link_pads (GstElement * src, const gchar * srcpadname,
1907     GstElement * dest, const gchar * destpadname)
1908 {
1909   return gst_element_link_pads_full (src, srcpadname, dest, destpadname,
1910       GST_PAD_LINK_CHECK_DEFAULT);
1911 }
1912
1913 /**
1914  * gst_element_link_pads_filtered:
1915  * @src: a #GstElement containing the source pad.
1916  * @srcpadname: (allow-none): the name of the #GstPad in source element
1917  *     or NULL for any pad.
1918  * @dest: (transfer none): the #GstElement containing the destination pad.
1919  * @destpadname: (allow-none): the name of the #GstPad in destination element
1920  *     or NULL for any pad.
1921  * @filter: (transfer none) (allow-none): the #GstCaps to filter the link,
1922  *     or #NULL for no filter.
1923  *
1924  * Links the two named pads of the source and destination elements. Side effect
1925  * is that if one of the pads has no parent, it becomes a child of the parent of
1926  * the other element. If they have different parents, the link fails. If @caps
1927  * is not #NULL, makes sure that the caps of the link is a subset of @caps.
1928  *
1929  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1930  */
1931 gboolean
1932 gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
1933     GstElement * dest, const gchar * destpadname, GstCaps * filter)
1934 {
1935   /* checks */
1936   g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1937   g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1938   g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), FALSE);
1939
1940   if (filter) {
1941     GstElement *capsfilter;
1942     GstObject *parent;
1943     GstState state, pending;
1944     gboolean lr1, lr2;
1945
1946     capsfilter = gst_element_factory_make ("capsfilter", NULL);
1947     if (!capsfilter) {
1948       GST_ERROR ("Could not make a capsfilter");
1949       return FALSE;
1950     }
1951
1952     parent = gst_object_get_parent (GST_OBJECT (src));
1953     g_return_val_if_fail (GST_IS_BIN (parent), FALSE);
1954
1955     gst_element_get_state (GST_ELEMENT_CAST (parent), &state, &pending, 0);
1956
1957     if (!gst_bin_add (GST_BIN (parent), capsfilter)) {
1958       GST_ERROR ("Could not add capsfilter");
1959       gst_object_unref (capsfilter);
1960       gst_object_unref (parent);
1961       return FALSE;
1962     }
1963
1964     if (pending != GST_STATE_VOID_PENDING)
1965       state = pending;
1966
1967     gst_element_set_state (capsfilter, state);
1968
1969     gst_object_unref (parent);
1970
1971     g_object_set (capsfilter, "caps", filter, NULL);
1972
1973     lr1 = gst_element_link_pads (src, srcpadname, capsfilter, "sink");
1974     lr2 = gst_element_link_pads (capsfilter, "src", dest, destpadname);
1975     if (lr1 && lr2) {
1976       return TRUE;
1977     } else {
1978       if (!lr1) {
1979         GST_INFO ("Could not link pads: %s:%s - capsfilter:sink",
1980             GST_ELEMENT_NAME (src), srcpadname);
1981       } else {
1982         GST_INFO ("Could not link pads: capsfilter:src - %s:%s",
1983             GST_ELEMENT_NAME (dest), destpadname);
1984       }
1985       gst_element_set_state (capsfilter, GST_STATE_NULL);
1986       /* this will unlink and unref as appropriate */
1987       gst_bin_remove (GST_BIN (GST_OBJECT_PARENT (capsfilter)), capsfilter);
1988       return FALSE;
1989     }
1990   } else {
1991     if (gst_element_link_pads (src, srcpadname, dest, destpadname)) {
1992       return TRUE;
1993     } else {
1994       GST_INFO ("Could not link pads: %s:%s - %s:%s", GST_ELEMENT_NAME (src),
1995           srcpadname, GST_ELEMENT_NAME (dest), destpadname);
1996       return FALSE;
1997     }
1998   }
1999 }
2000
2001 /**
2002  * gst_element_link:
2003  * @src: (transfer none): a #GstElement containing the source pad.
2004  * @dest: (transfer none): the #GstElement containing the destination pad.
2005  *
2006  * Links @src to @dest. The link must be from source to
2007  * destination; the other direction will not be tried. The function looks for
2008  * existing pads that aren't linked yet. It will request new pads if necessary.
2009  * Such pads need to be released manually when unlinking.
2010  * If multiple links are possible, only one is established.
2011  *
2012  * Make sure you have added your elements to a bin or pipeline with
2013  * gst_bin_add() before trying to link them.
2014  *
2015  * Returns: TRUE if the elements could be linked, FALSE otherwise.
2016  */
2017 gboolean
2018 gst_element_link (GstElement * src, GstElement * dest)
2019 {
2020   return gst_element_link_pads (src, NULL, dest, NULL);
2021 }
2022
2023 /**
2024  * gst_element_link_many:
2025  * @element_1: (transfer none): the first #GstElement in the link chain.
2026  * @element_2: (transfer none): the second #GstElement in the link chain.
2027  * @...: the NULL-terminated list of elements to link in order.
2028  *
2029  * Chain together a series of elements. Uses gst_element_link().
2030  * Make sure you have added your elements to a bin or pipeline with
2031  * gst_bin_add() before trying to link them.
2032  *
2033  * Returns: TRUE on success, FALSE otherwise.
2034  */
2035 gboolean
2036 gst_element_link_many (GstElement * element_1, GstElement * element_2, ...)
2037 {
2038   gboolean res = TRUE;
2039   va_list args;
2040
2041   g_return_val_if_fail (GST_IS_ELEMENT (element_1), FALSE);
2042   g_return_val_if_fail (GST_IS_ELEMENT (element_2), FALSE);
2043
2044   va_start (args, element_2);
2045
2046   while (element_2) {
2047     if (!gst_element_link (element_1, element_2)) {
2048       res = FALSE;
2049       break;
2050     }
2051
2052     element_1 = element_2;
2053     element_2 = va_arg (args, GstElement *);
2054   }
2055
2056   va_end (args);
2057
2058   return res;
2059 }
2060
2061 /**
2062  * gst_element_link_filtered:
2063  * @src: a #GstElement containing the source pad.
2064  * @dest: (transfer none): the #GstElement containing the destination pad.
2065  * @filter: (transfer none) (allow-none): the #GstCaps to filter the link,
2066  *     or #NULL for no filter.
2067  *
2068  * Links @src to @dest using the given caps as filtercaps.
2069  * The link must be from source to
2070  * destination; the other direction will not be tried. The function looks for
2071  * existing pads that aren't linked yet. It will request new pads if necessary.
2072  * If multiple links are possible, only one is established.
2073  *
2074  * Make sure you have added your elements to a bin or pipeline with
2075  * gst_bin_add() before trying to link them.
2076  *
2077  * Returns: TRUE if the pads could be linked, FALSE otherwise.
2078  */
2079 gboolean
2080 gst_element_link_filtered (GstElement * src, GstElement * dest,
2081     GstCaps * filter)
2082 {
2083   return gst_element_link_pads_filtered (src, NULL, dest, NULL, filter);
2084 }
2085
2086 /**
2087  * gst_element_unlink_pads:
2088  * @src: a (transfer none): #GstElement containing the source pad.
2089  * @srcpadname: the name of the #GstPad in source element.
2090  * @dest: (transfer none): a #GstElement containing the destination pad.
2091  * @destpadname: the name of the #GstPad in destination element.
2092  *
2093  * Unlinks the two named pads of the source and destination elements.
2094  *
2095  * This is a convenience function for gst_pad_unlink().
2096  */
2097 void
2098 gst_element_unlink_pads (GstElement * src, const gchar * srcpadname,
2099     GstElement * dest, const gchar * destpadname)
2100 {
2101   GstPad *srcpad, *destpad;
2102   gboolean srcrequest, destrequest;
2103
2104   srcrequest = destrequest = FALSE;
2105
2106   g_return_if_fail (src != NULL);
2107   g_return_if_fail (GST_IS_ELEMENT (src));
2108   g_return_if_fail (srcpadname != NULL);
2109   g_return_if_fail (dest != NULL);
2110   g_return_if_fail (GST_IS_ELEMENT (dest));
2111   g_return_if_fail (destpadname != NULL);
2112
2113   /* obtain the pads requested */
2114   if (!(srcpad = gst_element_get_static_pad (src, srcpadname)))
2115     if ((srcpad = gst_element_get_request_pad (src, srcpadname)))
2116       srcrequest = TRUE;
2117   if (srcpad == NULL) {
2118     GST_WARNING_OBJECT (src, "source element has no pad \"%s\"", srcpadname);
2119     return;
2120   }
2121   if (!(destpad = gst_element_get_static_pad (dest, destpadname)))
2122     if ((destpad = gst_element_get_request_pad (dest, destpadname)))
2123       destrequest = TRUE;
2124   if (destpad == NULL) {
2125     GST_WARNING_OBJECT (dest, "destination element has no pad \"%s\"",
2126         destpadname);
2127     goto free_src;
2128   }
2129
2130   /* we're satisfied they can be unlinked, let's do it */
2131   gst_pad_unlink (srcpad, destpad);
2132
2133   if (destrequest)
2134     gst_element_release_request_pad (dest, destpad);
2135   gst_object_unref (destpad);
2136
2137 free_src:
2138   if (srcrequest)
2139     gst_element_release_request_pad (src, srcpad);
2140   gst_object_unref (srcpad);
2141 }
2142
2143 /**
2144  * gst_element_unlink_many:
2145  * @element_1: (transfer none): the first #GstElement in the link chain.
2146  * @element_2: (transfer none): the second #GstElement in the link chain.
2147  * @...: the NULL-terminated list of elements to unlink in order.
2148  *
2149  * Unlinks a series of elements. Uses gst_element_unlink().
2150  */
2151 void
2152 gst_element_unlink_many (GstElement * element_1, GstElement * element_2, ...)
2153 {
2154   va_list args;
2155
2156   g_return_if_fail (element_1 != NULL && element_2 != NULL);
2157   g_return_if_fail (GST_IS_ELEMENT (element_1) && GST_IS_ELEMENT (element_2));
2158
2159   va_start (args, element_2);
2160
2161   while (element_2) {
2162     gst_element_unlink (element_1, element_2);
2163
2164     element_1 = element_2;
2165     element_2 = va_arg (args, GstElement *);
2166   }
2167
2168   va_end (args);
2169 }
2170
2171 /**
2172  * gst_element_unlink:
2173  * @src: (transfer none): the source #GstElement to unlink.
2174  * @dest: (transfer none): the sink #GstElement to unlink.
2175  *
2176  * Unlinks all source pads of the source element with all sink pads
2177  * of the sink element to which they are linked.
2178  *
2179  * If the link has been made using gst_element_link(), it could have created an
2180  * requestpad, which has to be released using gst_element_release_request_pad().
2181  */
2182 void
2183 gst_element_unlink (GstElement * src, GstElement * dest)
2184 {
2185   GstIterator *pads;
2186   gboolean done = FALSE;
2187   GValue data = { 0, };
2188
2189   g_return_if_fail (GST_IS_ELEMENT (src));
2190   g_return_if_fail (GST_IS_ELEMENT (dest));
2191
2192   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unlinking \"%s\" and \"%s\"",
2193       GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
2194
2195   pads = gst_element_iterate_pads (src);
2196   while (!done) {
2197     switch (gst_iterator_next (pads, &data)) {
2198       case GST_ITERATOR_OK:
2199       {
2200         GstPad *pad = g_value_get_object (&data);
2201
2202         if (GST_PAD_IS_SRC (pad)) {
2203           GstPad *peerpad = gst_pad_get_peer (pad);
2204
2205           /* see if the pad is linked and is really a pad of dest */
2206           if (peerpad) {
2207             GstElement *peerelem;
2208
2209             peerelem = gst_pad_get_parent_element (peerpad);
2210
2211             if (peerelem == dest) {
2212               gst_pad_unlink (pad, peerpad);
2213             }
2214             if (peerelem)
2215               gst_object_unref (peerelem);
2216
2217             gst_object_unref (peerpad);
2218           }
2219         }
2220         g_value_reset (&data);
2221         break;
2222       }
2223       case GST_ITERATOR_RESYNC:
2224         gst_iterator_resync (pads);
2225         break;
2226       case GST_ITERATOR_DONE:
2227         done = TRUE;
2228         break;
2229       default:
2230         g_assert_not_reached ();
2231         break;
2232     }
2233   }
2234   g_value_unset (&data);
2235   gst_iterator_free (pads);
2236 }
2237
2238 /**
2239  * gst_element_query_position:
2240  * @element: a #GstElement to invoke the position query on.
2241  * @format: the #GstFormat requested
2242  * @cur: (out) (allow-none): a location in which to store the current
2243  *     position, or NULL.
2244  *
2245  * Queries an element for the stream position. If one repeatedly calls this
2246  * function one can also create and reuse it in gst_element_query().
2247  *
2248  * Returns: TRUE if the query could be performed.
2249  */
2250 gboolean
2251 gst_element_query_position (GstElement * element, GstFormat format,
2252     gint64 * cur)
2253 {
2254   GstQuery *query;
2255   gboolean ret;
2256
2257   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2258   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2259
2260   query = gst_query_new_position (format);
2261   ret = gst_element_query (element, query);
2262
2263   if (ret)
2264     gst_query_parse_position (query, NULL, cur);
2265
2266   gst_query_unref (query);
2267
2268   return ret;
2269 }
2270
2271 /**
2272  * gst_element_query_duration:
2273  * @element: a #GstElement to invoke the duration query on.
2274  * @format: the #GstFormat requested
2275  * @duration: (out): A location in which to store the total duration, or NULL.
2276  *
2277  * Queries an element for the total stream duration.
2278  *
2279  * Returns: TRUE if the query could be performed.
2280  */
2281 gboolean
2282 gst_element_query_duration (GstElement * element, GstFormat format,
2283     gint64 * duration)
2284 {
2285   GstQuery *query;
2286   gboolean ret;
2287
2288   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2289   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2290
2291   query = gst_query_new_duration (format);
2292   ret = gst_element_query (element, query);
2293
2294   if (ret)
2295     gst_query_parse_duration (query, NULL, duration);
2296
2297   gst_query_unref (query);
2298
2299   return ret;
2300 }
2301
2302 /**
2303  * gst_element_query_convert:
2304  * @element: a #GstElement to invoke the convert query on.
2305  * @src_format: (inout): a #GstFormat to convert from.
2306  * @src_val: a value to convert.
2307  * @dest_format: the #GstFormat to convert to.
2308  * @dest_val: (out): a pointer to the result.
2309  *
2310  * Queries an element to convert @src_val in @src_format to @dest_format.
2311  *
2312  * Returns: TRUE if the query could be performed.
2313  */
2314 gboolean
2315 gst_element_query_convert (GstElement * element, GstFormat src_format,
2316     gint64 src_val, GstFormat dest_format, gint64 * dest_val)
2317 {
2318   GstQuery *query;
2319   gboolean ret;
2320
2321   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2322   g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
2323   g_return_val_if_fail (dest_val != NULL, FALSE);
2324
2325   if (dest_format == src_format || src_val == -1) {
2326     *dest_val = src_val;
2327     return TRUE;
2328   }
2329
2330   query = gst_query_new_convert (src_format, src_val, dest_format);
2331   ret = gst_element_query (element, query);
2332
2333   if (ret)
2334     gst_query_parse_convert (query, NULL, NULL, NULL, dest_val);
2335
2336   gst_query_unref (query);
2337
2338   return ret;
2339 }
2340
2341 /**
2342  * gst_element_seek_simple
2343  * @element: a #GstElement to seek on
2344  * @format: a #GstFormat to execute the seek in, such as #GST_FORMAT_TIME
2345  * @seek_flags: seek options; playback applications will usually want to use
2346  *            GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_KEY_UNIT here
2347  * @seek_pos: position to seek to (relative to the start); if you are doing
2348  *            a seek in #GST_FORMAT_TIME this value is in nanoseconds -
2349  *            multiply with #GST_SECOND to convert seconds to nanoseconds or
2350  *            with #GST_MSECOND to convert milliseconds to nanoseconds.
2351  *
2352  * Simple API to perform a seek on the given element, meaning it just seeks
2353  * to the given position relative to the start of the stream. For more complex
2354  * operations like segment seeks (e.g. for looping) or changing the playback
2355  * rate or seeking relative to the last configured playback segment you should
2356  * use gst_element_seek().
2357  *
2358  * In a completely prerolled PAUSED or PLAYING pipeline, seeking is always
2359  * guaranteed to return %TRUE on a seekable media type or %FALSE when the media
2360  * type is certainly not seekable (such as a live stream).
2361  *
2362  * Some elements allow for seeking in the READY state, in this
2363  * case they will store the seek event and execute it when they are put to
2364  * PAUSED. If the element supports seek in READY, it will always return %TRUE when
2365  * it receives the event in the READY state.
2366  *
2367  * Returns: %TRUE if the seek operation succeeded (the seek might not always be
2368  * executed instantly though)
2369  *
2370  * Since: 0.10.7
2371  */
2372 gboolean
2373 gst_element_seek_simple (GstElement * element, GstFormat format,
2374     GstSeekFlags seek_flags, gint64 seek_pos)
2375 {
2376   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2377   g_return_val_if_fail (seek_pos >= 0, FALSE);
2378
2379   return gst_element_seek (element, 1.0, format, seek_flags,
2380       GST_SEEK_TYPE_SET, seek_pos, GST_SEEK_TYPE_NONE, 0);
2381 }
2382
2383 /**
2384  * gst_pad_use_fixed_caps:
2385  * @pad: the pad to use
2386  *
2387  * A helper function you can use that sets the FIXED_CAPS flag
2388  * This way the default getcaps function will always return the negotiated caps
2389  * or in case the pad is not negotiated, the padtemplate caps.
2390  *
2391  * Use this function on a pad that, once gst_pad_set_caps() has been called
2392  * on it, cannot be renegotiated to something else.
2393  */
2394 void
2395 gst_pad_use_fixed_caps (GstPad * pad)
2396 {
2397   GST_OBJECT_FLAG_SET (pad, GST_PAD_FLAG_FIXED_CAPS);
2398 }
2399
2400 /**
2401  * gst_pad_get_parent_element:
2402  * @pad: a pad
2403  *
2404  * Gets the parent of @pad, cast to a #GstElement. If a @pad has no parent or
2405  * its parent is not an element, return NULL.
2406  *
2407  * Returns: (transfer full): the parent of the pad. The caller has a
2408  * reference on the parent, so unref when you're finished with it.
2409  *
2410  * MT safe.
2411  */
2412 GstElement *
2413 gst_pad_get_parent_element (GstPad * pad)
2414 {
2415   GstObject *p;
2416
2417   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2418
2419   p = gst_object_get_parent (GST_OBJECT_CAST (pad));
2420
2421   if (p && !GST_IS_ELEMENT (p)) {
2422     gst_object_unref (p);
2423     p = NULL;
2424   }
2425   return GST_ELEMENT_CAST (p);
2426 }
2427
2428 /**
2429  * gst_object_default_error:
2430  * @source: the #GstObject that initiated the error.
2431  * @error: (in): the GError.
2432  * @debug: (in) (allow-none): an additional debug information string, or NULL
2433  *
2434  * A default error function that uses g_printerr() to display the error message
2435  * and the optional debug sting..
2436  *
2437  * The default handler will simply print the error string using g_print.
2438  */
2439 void
2440 gst_object_default_error (GstObject * source, const GError * error,
2441     const gchar * debug)
2442 {
2443   gchar *name = gst_object_get_path_string (source);
2444
2445   g_printerr (_("ERROR: from element %s: %s\n"), name, error->message);
2446   if (debug)
2447     g_printerr (_("Additional debug info:\n%s\n"), debug);
2448
2449   g_free (name);
2450 }
2451
2452 /**
2453  * gst_bin_add_many:
2454  * @bin: a #GstBin
2455  * @element_1: (transfer full): the #GstElement element to add to the bin
2456  * @...: (transfer full): additional elements to add to the bin
2457  *
2458  * Adds a NULL-terminated list of elements to a bin.  This function is
2459  * equivalent to calling gst_bin_add() for each member of the list. The return
2460  * value of each gst_bin_add() is ignored.
2461  */
2462 void
2463 gst_bin_add_many (GstBin * bin, GstElement * element_1, ...)
2464 {
2465   va_list args;
2466
2467   g_return_if_fail (GST_IS_BIN (bin));
2468   g_return_if_fail (GST_IS_ELEMENT (element_1));
2469
2470   va_start (args, element_1);
2471
2472   while (element_1) {
2473     gst_bin_add (bin, element_1);
2474
2475     element_1 = va_arg (args, GstElement *);
2476   }
2477
2478   va_end (args);
2479 }
2480
2481 /**
2482  * gst_bin_remove_many:
2483  * @bin: a #GstBin
2484  * @element_1: (transfer none): the first #GstElement to remove from the bin
2485  * @...: (transfer none): NULL-terminated list of elements to remove from the bin
2486  *
2487  * Remove a list of elements from a bin. This function is equivalent
2488  * to calling gst_bin_remove() with each member of the list.
2489  */
2490 void
2491 gst_bin_remove_many (GstBin * bin, GstElement * element_1, ...)
2492 {
2493   va_list args;
2494
2495   g_return_if_fail (GST_IS_BIN (bin));
2496   g_return_if_fail (GST_IS_ELEMENT (element_1));
2497
2498   va_start (args, element_1);
2499
2500   while (element_1) {
2501     gst_bin_remove (bin, element_1);
2502
2503     element_1 = va_arg (args, GstElement *);
2504   }
2505
2506   va_end (args);
2507 }
2508
2509 /**
2510  * gst_buffer_merge:
2511  * @buf1: (transfer none): the first source #GstBuffer to merge.
2512  * @buf2: (transfer none): the second source #GstBuffer to merge.
2513  *
2514  * Create a new buffer that is the concatenation of the two source
2515  * buffers.  The original source buffers will not be modified or
2516  * unref'd.  Make sure you unref the source buffers if they are not used
2517  * anymore afterwards.
2518  *
2519  * If the buffers point to contiguous areas of memory, the buffer
2520  * is created without copying the data.
2521  *
2522  * Free-function: gst_buffer_unref
2523  *
2524  * Returns: (transfer full): the new #GstBuffer which is the concatenation
2525  *     of the source buffers.
2526  */
2527 GstBuffer *
2528 gst_buffer_merge (GstBuffer * buf1, GstBuffer * buf2)
2529 {
2530   GstBuffer *result;
2531   gsize size1, size2;
2532
2533   size1 = gst_buffer_get_size (buf1);
2534   size2 = gst_buffer_get_size (buf2);
2535
2536   /* we're just a specific case of the more general gst_buffer_span() */
2537   result = gst_buffer_span (buf1, 0, buf2, size1 + size2);
2538
2539   return result;
2540 }
2541
2542 /**
2543  * gst_buffer_join:
2544  * @buf1: (transfer full): the first source #GstBuffer.
2545  * @buf2: (transfer full): the second source #GstBuffer.
2546  *
2547  * Create a new buffer that is the concatenation of the two source
2548  * buffers, and unrefs the original source buffers.
2549  *
2550  * If the buffers point to contiguous areas of memory, the buffer
2551  * is created without copying the data.
2552  *
2553  * This is a convenience function for C programmers. See also
2554  * gst_buffer_merge(), which does the same thing without
2555  * unreffing the input parameters. Language bindings without
2556  * explicit reference counting should not wrap this function.
2557  *
2558  * Returns: (transfer full): the new #GstBuffer which is the concatenation of
2559  * the source buffers.
2560  */
2561 GstBuffer *
2562 gst_buffer_join (GstBuffer * buf1, GstBuffer * buf2)
2563 {
2564   GstBuffer *result;
2565   gsize size1, size2;
2566
2567   size1 = gst_buffer_get_size (buf1);
2568   size2 = gst_buffer_get_size (buf2);
2569
2570   result = gst_buffer_span (buf1, 0, buf2, size1 + size2);
2571   gst_buffer_unref (buf1);
2572   gst_buffer_unref (buf2);
2573
2574   return result;
2575 }
2576
2577 typedef struct
2578 {
2579   GstQuery *query;
2580   gboolean ret;
2581 } QueryAcceptCapsData;
2582
2583 static gboolean
2584 query_accept_caps_func (GstPad * pad, QueryAcceptCapsData * data)
2585 {
2586   if (G_LIKELY (gst_pad_peer_query (pad, data->query))) {
2587     gboolean result;
2588
2589     gst_query_parse_accept_caps_result (data->query, &result);
2590     data->ret &= result;
2591   }
2592   return FALSE;
2593 }
2594
2595 /**
2596  * gst_pad_proxy_query_accept_caps:
2597  * @pad: a #GstPad to proxy.
2598  * @query: an ACCEPT_CAPS #GstQuery.
2599  *
2600  * Calls gst_pad_accept_caps() for all internally linked pads of @pad and
2601  * returns the intersection of the results.
2602  *
2603  * This function is useful as a default accept caps query function for an element
2604  * that can handle any stream format, but requires caps that are acceptable for
2605  * all oposite pads.
2606  *
2607  * Returns: TRUE if @query could be executed
2608  */
2609 gboolean
2610 gst_pad_proxy_query_accept_caps (GstPad * pad, GstQuery * query)
2611 {
2612   QueryAcceptCapsData data;
2613
2614   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2615   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
2616   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_ACCEPT_CAPS, FALSE);
2617
2618   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad,
2619       "proxying accept caps query for %s:%s", GST_DEBUG_PAD_NAME (pad));
2620
2621   data.query = query;
2622   /* value to hold the return, by default it holds TRUE */
2623   data.ret = TRUE;
2624
2625   gst_pad_forward (pad, (GstPadForwardFunction) query_accept_caps_func, &data);
2626   gst_query_set_accept_caps_result (query, data.ret);
2627
2628   return TRUE;
2629 }
2630
2631 typedef struct
2632 {
2633   GstQuery *query;
2634   GstCaps *ret;
2635 } QueryCapsData;
2636
2637 static gboolean
2638 query_caps_func (GstPad * pad, QueryCapsData * data)
2639 {
2640   gboolean empty = FALSE;
2641
2642   if (G_LIKELY (gst_pad_peer_query (pad, data->query))) {
2643     GstCaps *peercaps, *intersection;
2644
2645     gst_query_parse_caps_result (data->query, &peercaps);
2646     GST_DEBUG_OBJECT (pad, "intersect with result %" GST_PTR_FORMAT, peercaps);
2647     intersection = gst_caps_intersect (data->ret, peercaps);
2648     GST_DEBUG_OBJECT (pad, "intersected %" GST_PTR_FORMAT, intersection);
2649
2650     gst_caps_unref (data->ret);
2651     data->ret = intersection;
2652
2653     /* stop when empty */
2654     empty = gst_caps_is_empty (intersection);
2655   }
2656   return empty;
2657 }
2658
2659 /**
2660  * gst_pad_proxy_query_caps:
2661  * @pad: a #GstPad to proxy.
2662  * @query: a CAPS #GstQuery.
2663  *
2664  * Calls gst_pad_query_caps() for all internally linked pads fof @pad and returns
2665  * the intersection of the results.
2666  *
2667  * This function is useful as a default caps query function for an element
2668  * that can handle any stream format, but requires all its pads to have
2669  * the same caps.  Two such elements are tee and adder.
2670  *
2671  * Returns: TRUE if @query could be executed
2672  */
2673 gboolean
2674 gst_pad_proxy_query_caps (GstPad * pad, GstQuery * query)
2675 {
2676   GstCaps *templ, *intersected;
2677   QueryCapsData data;
2678
2679   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2680   g_return_val_if_fail (GST_IS_QUERY (query), FALSE);
2681   g_return_val_if_fail (GST_QUERY_TYPE (query) == GST_QUERY_CAPS, FALSE);
2682
2683   GST_CAT_DEBUG_OBJECT (GST_CAT_PADS, pad, "proxying caps query for %s:%s",
2684       GST_DEBUG_PAD_NAME (pad));
2685
2686   data.query = query;
2687   /* value to hold the return, by default it holds ANY */
2688   data.ret = gst_caps_new_any ();
2689
2690   gst_pad_forward (pad, (GstPadForwardFunction) query_caps_func, &data);
2691
2692   templ = gst_pad_get_pad_template_caps (pad);
2693   intersected = gst_caps_intersect (data.ret, templ);
2694   gst_caps_unref (data.ret);
2695   gst_caps_unref (templ);
2696
2697   gst_query_set_caps_result (query, intersected);
2698   gst_caps_unref (intersected);
2699
2700   return TRUE;
2701 }
2702
2703 /**
2704  * gst_pad_query_position:
2705  * @pad: a #GstPad to invoke the position query on.
2706  * @format: the #GstFormat requested
2707  * @cur: (out): A location in which to store the current position, or NULL.
2708  *
2709  * Queries a pad for the stream position.
2710  *
2711  * Returns: TRUE if the query could be performed.
2712  */
2713 gboolean
2714 gst_pad_query_position (GstPad * pad, GstFormat format, gint64 * cur)
2715 {
2716   GstQuery *query;
2717   gboolean ret;
2718
2719   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2720   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2721
2722   query = gst_query_new_position (format);
2723   if ((ret = gst_pad_query (pad, query)))
2724     gst_query_parse_position (query, NULL, cur);
2725   gst_query_unref (query);
2726
2727   return ret;
2728 }
2729
2730 /**
2731  * gst_pad_peer_query_position:
2732  * @pad: a #GstPad on whose peer to invoke the position query on.
2733  *       Must be a sink pad.
2734  * @format: the #GstFormat requested
2735  * @cur: (out) (allow-none): a location in which to store the current
2736  *     position, or NULL.
2737  *
2738  * Queries the peer of a given sink pad for the stream position.
2739  *
2740  * Returns: TRUE if the query could be performed.
2741  */
2742 gboolean
2743 gst_pad_peer_query_position (GstPad * pad, GstFormat format, gint64 * cur)
2744 {
2745   GstQuery *query;
2746   gboolean ret = FALSE;
2747
2748   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2749   g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2750   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2751
2752   query = gst_query_new_position (format);
2753   if ((ret = gst_pad_peer_query (pad, query)))
2754     gst_query_parse_position (query, NULL, cur);
2755   gst_query_unref (query);
2756
2757   return ret;
2758 }
2759
2760 /**
2761  * gst_pad_query_duration:
2762  * @pad: a #GstPad to invoke the duration query on.
2763  * @format: the #GstFormat requested
2764  * @duration: (out) (allow-none): a location in which to store the total
2765  *     duration, or NULL.
2766  *
2767  * Queries a pad for the total stream duration.
2768  *
2769  * Returns: TRUE if the query could be performed.
2770  */
2771 gboolean
2772 gst_pad_query_duration (GstPad * pad, GstFormat format, gint64 * duration)
2773 {
2774   GstQuery *query;
2775   gboolean ret;
2776
2777   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2778   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2779
2780   query = gst_query_new_duration (format);
2781   if ((ret = gst_pad_query (pad, query)))
2782     gst_query_parse_duration (query, NULL, duration);
2783   gst_query_unref (query);
2784
2785   return ret;
2786 }
2787
2788 /**
2789  * gst_pad_peer_query_duration:
2790  * @pad: a #GstPad on whose peer pad to invoke the duration query on.
2791  *       Must be a sink pad.
2792  * @format: the #GstFormat requested
2793  * @duration: (out) (allow-none): a location in which to store the total
2794  *     duration, or NULL.
2795  *
2796  * Queries the peer pad of a given sink pad for the total stream duration.
2797  *
2798  * Returns: TRUE if the query could be performed.
2799  */
2800 gboolean
2801 gst_pad_peer_query_duration (GstPad * pad, GstFormat format, gint64 * duration)
2802 {
2803   GstQuery *query;
2804   gboolean ret = FALSE;
2805
2806   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2807   g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2808   g_return_val_if_fail (format != GST_FORMAT_UNDEFINED, FALSE);
2809
2810   query = gst_query_new_duration (format);
2811   if ((ret = gst_pad_peer_query (pad, query)))
2812     gst_query_parse_duration (query, NULL, duration);
2813   gst_query_unref (query);
2814
2815   return ret;
2816 }
2817
2818 /**
2819  * gst_pad_query_convert:
2820  * @pad: a #GstPad to invoke the convert query on.
2821  * @src_format: a #GstFormat to convert from.
2822  * @src_val: a value to convert.
2823  * @dest_format: the #GstFormat to convert to.
2824  * @dest_val: (out): a pointer to the result.
2825  *
2826  * Queries a pad to convert @src_val in @src_format to @dest_format.
2827  *
2828  * Returns: TRUE if the query could be performed.
2829  */
2830 gboolean
2831 gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2832     GstFormat dest_format, gint64 * dest_val)
2833 {
2834   GstQuery *query;
2835   gboolean ret;
2836
2837   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2838   g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
2839   g_return_val_if_fail (dest_val != NULL, FALSE);
2840
2841   if (dest_format == src_format || src_val == -1) {
2842     *dest_val = src_val;
2843     return TRUE;
2844   }
2845
2846   query = gst_query_new_convert (src_format, src_val, dest_format);
2847   if ((ret = gst_pad_query (pad, query)))
2848     gst_query_parse_convert (query, NULL, NULL, NULL, dest_val);
2849   gst_query_unref (query);
2850
2851   return ret;
2852 }
2853
2854 /**
2855  * gst_pad_peer_query_convert:
2856  * @pad: a #GstPad, on whose peer pad to invoke the convert query on.
2857  *       Must be a sink pad.
2858  * @src_format: a #GstFormat to convert from.
2859  * @src_val: a value to convert.
2860  * @dest_format: the #GstFormat to convert to.
2861  * @dest_val: (out): a pointer to the result.
2862  *
2863  * Queries the peer pad of a given sink pad to convert @src_val in @src_format
2864  * to @dest_format.
2865  *
2866  * Returns: TRUE if the query could be performed.
2867  */
2868 gboolean
2869 gst_pad_peer_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2870     GstFormat dest_format, gint64 * dest_val)
2871 {
2872   GstQuery *query;
2873   gboolean ret = FALSE;
2874
2875   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2876   g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2877   g_return_val_if_fail (dest_format != GST_FORMAT_UNDEFINED, FALSE);
2878   g_return_val_if_fail (dest_val != NULL, FALSE);
2879
2880   query = gst_query_new_convert (src_format, src_val, dest_format);
2881   if ((ret = gst_pad_peer_query (pad, query)))
2882     gst_query_parse_convert (query, NULL, NULL, NULL, dest_val);
2883   gst_query_unref (query);
2884
2885   return ret;
2886 }
2887
2888 /**
2889  * gst_pad_query_caps:
2890  * @pad: a  #GstPad to get the capabilities of.
2891  * @filter: (allow-none): suggested #GstCaps, or NULL
2892  *
2893  * Gets the capabilities this pad can produce or consume.
2894  * Note that this method doesn't necessarily return the caps set by
2895  * gst_pad_set_caps() - use gst_pad_get_current_caps() for that instead.
2896  * gst_pad_query_caps returns all possible caps a pad can operate with, using
2897  * the pad's CAPS query function, If the query fails, this function will return
2898  * @filter, if not #NULL, otherwise ANY.
2899  *
2900  * When called on sinkpads @filter contains the caps that
2901  * upstream could produce in the order preferred by upstream. When
2902  * called on srcpads @filter contains the caps accepted by
2903  * downstream in the preffered order. @filter might be %NULL but
2904  * if it is not %NULL the returned caps will be a subset of @filter.
2905  *
2906  * Note that this function does not return writable #GstCaps, use
2907  * gst_caps_make_writable() before modifying the caps.
2908  *
2909  * Returns: (transfer full): the caps of the pad with incremented ref-count.
2910  */
2911 GstCaps *
2912 gst_pad_query_caps (GstPad * pad, GstCaps * filter)
2913 {
2914   GstCaps *result = NULL;
2915   GstQuery *query;
2916
2917   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2918   g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), NULL);
2919
2920   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "get pad caps");
2921
2922   query = gst_query_new_caps (filter);
2923   if (gst_pad_query (pad, query)) {
2924     gst_query_parse_caps_result (query, &result);
2925     gst_caps_ref (result);
2926     GST_DEBUG_OBJECT (pad, "query returned %" GST_PTR_FORMAT, result);
2927   } else if (filter) {
2928     result = gst_caps_ref (filter);
2929   } else {
2930     result = gst_caps_new_any ();
2931   }
2932   gst_query_unref (query);
2933
2934   return result;
2935 }
2936
2937 /**
2938  * gst_pad_peer_query_caps:
2939  * @pad: a  #GstPad to get the capabilities of.
2940  * @filter: (allow-none): a #GstCaps filter, or NULL.
2941  *
2942  * Gets the capabilities of the peer connected to this pad. Similar to
2943  * gst_pad_query_caps().
2944  *
2945  * When called on srcpads @filter contains the caps that
2946  * upstream could produce in the order preferred by upstream. When
2947  * called on sinkpads @filter contains the caps accepted by
2948  * downstream in the preffered order. @filter might be %NULL but
2949  * if it is not %NULL the returned caps will be a subset of @filter.
2950  *
2951  * Returns: the caps of the peer pad with incremented ref-count. This function
2952  * returns %NULL when there is no peer pad.
2953  */
2954 GstCaps *
2955 gst_pad_peer_query_caps (GstPad * pad, GstCaps * filter)
2956 {
2957   GstCaps *result = NULL;
2958   GstQuery *query;
2959
2960   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2961   g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), NULL);
2962
2963   query = gst_query_new_caps (filter);
2964   if (gst_pad_peer_query (pad, query)) {
2965     gst_query_parse_caps_result (query, &result);
2966     gst_caps_ref (result);
2967     GST_DEBUG_OBJECT (pad, "peer query returned %" GST_PTR_FORMAT, result);
2968   } else if (filter) {
2969     result = gst_caps_ref (filter);
2970   } else {
2971     result = gst_caps_new_any ();
2972   }
2973   gst_query_unref (query);
2974
2975   return result;
2976 }
2977
2978 /**
2979  * gst_pad_query_accept_caps:
2980  * @pad: a #GstPad to check
2981  * @caps: a #GstCaps to check on the pad
2982  *
2983  * Check if the given pad accepts the caps.
2984  *
2985  * Returns: TRUE if the pad can accept the caps.
2986  */
2987 gboolean
2988 gst_pad_query_accept_caps (GstPad * pad, GstCaps * caps)
2989 {
2990   gboolean res = TRUE;
2991   GstQuery *query;
2992
2993   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2994   g_return_val_if_fail (GST_IS_CAPS (caps), FALSE);
2995
2996   GST_CAT_DEBUG_OBJECT (GST_CAT_CAPS, pad, "accept caps of %p", caps);
2997
2998   query = gst_query_new_accept_caps (caps);
2999   if (gst_pad_query (pad, query)) {
3000     gst_query_parse_accept_caps_result (query, &res);
3001     GST_DEBUG_OBJECT (pad, "query returned %d", res);
3002   }
3003   gst_query_unref (query);
3004
3005   return res;
3006 }
3007
3008 /**
3009  * gst_pad_peer_query_accept_caps:
3010  * @pad: a  #GstPad to check the peer of
3011  * @caps: a #GstCaps to check on the pad
3012  *
3013  * Check if the peer of @pad accepts @caps. If @pad has no peer, this function
3014  * returns TRUE.
3015  *
3016  * Returns: TRUE if the peer of @pad can accept the caps or @pad has no peer.
3017  */
3018 gboolean
3019 gst_pad_peer_query_accept_caps (GstPad * pad, GstCaps * caps)
3020 {
3021   gboolean res = TRUE;
3022   GstQuery *query;
3023
3024   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
3025   g_return_val_if_fail (GST_IS_CAPS (caps), FALSE);
3026
3027   query = gst_query_new_accept_caps (caps);
3028   if (gst_pad_peer_query (pad, query)) {
3029     gst_query_parse_accept_caps_result (query, &res);
3030     GST_DEBUG_OBJECT (pad, "query returned %d", res);
3031   }
3032   gst_query_unref (query);
3033
3034   return res;
3035 }
3036
3037 static GstPad *
3038 element_find_unlinked_pad (GstElement * element, GstPadDirection direction)
3039 {
3040   GstIterator *iter;
3041   GstPad *unlinked_pad = NULL;
3042   gboolean done;
3043   GValue data = { 0, };
3044
3045   switch (direction) {
3046     case GST_PAD_SRC:
3047       iter = gst_element_iterate_src_pads (element);
3048       break;
3049     case GST_PAD_SINK:
3050       iter = gst_element_iterate_sink_pads (element);
3051       break;
3052     default:
3053       g_return_val_if_reached (NULL);
3054   }
3055
3056   done = FALSE;
3057   while (!done) {
3058     switch (gst_iterator_next (iter, &data)) {
3059       case GST_ITERATOR_OK:{
3060         GstPad *peer;
3061         GstPad *pad = g_value_get_object (&data);
3062
3063         GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
3064             GST_DEBUG_PAD_NAME (pad));
3065
3066         peer = gst_pad_get_peer (pad);
3067         if (peer == NULL) {
3068           unlinked_pad = gst_object_ref (pad);
3069           done = TRUE;
3070           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
3071               "found existing unlinked pad %s:%s",
3072               GST_DEBUG_PAD_NAME (unlinked_pad));
3073         } else {
3074           gst_object_unref (peer);
3075         }
3076         g_value_reset (&data);
3077         break;
3078       }
3079       case GST_ITERATOR_DONE:
3080         done = TRUE;
3081         break;
3082       case GST_ITERATOR_RESYNC:
3083         gst_iterator_resync (iter);
3084         break;
3085       case GST_ITERATOR_ERROR:
3086         g_return_val_if_reached (NULL);
3087         break;
3088     }
3089   }
3090   g_value_unset (&data);
3091   gst_iterator_free (iter);
3092
3093   return unlinked_pad;
3094 }
3095
3096 /**
3097  * gst_bin_find_unlinked_pad:
3098  * @bin: bin in which to look for elements with unlinked pads
3099  * @direction: whether to look for an unlinked source or sink pad
3100  *
3101  * Recursively looks for elements with an unlinked pad of the given
3102  * direction within the specified bin and returns an unlinked pad
3103  * if one is found, or NULL otherwise. If a pad is found, the caller
3104  * owns a reference to it and should use gst_object_unref() on the
3105  * pad when it is not needed any longer.
3106  *
3107  * Returns: (transfer full): unlinked pad of the given direction, or NULL.
3108  *
3109  * Since: 0.10.20
3110  */
3111 GstPad *
3112 gst_bin_find_unlinked_pad (GstBin * bin, GstPadDirection direction)
3113 {
3114   GstIterator *iter;
3115   gboolean done;
3116   GstPad *pad = NULL;
3117   GValue data = { 0, };
3118
3119   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3120   g_return_val_if_fail (direction != GST_PAD_UNKNOWN, NULL);
3121
3122   done = FALSE;
3123   iter = gst_bin_iterate_recurse (bin);
3124   while (!done) {
3125     switch (gst_iterator_next (iter, &data)) {
3126       case GST_ITERATOR_OK:{
3127         GstElement *element = g_value_get_object (&data);
3128
3129         pad = element_find_unlinked_pad (element, direction);
3130         if (pad != NULL)
3131           done = TRUE;
3132         g_value_reset (&data);
3133         break;
3134       }
3135       case GST_ITERATOR_DONE:
3136         done = TRUE;
3137         break;
3138       case GST_ITERATOR_RESYNC:
3139         gst_iterator_resync (iter);
3140         break;
3141       case GST_ITERATOR_ERROR:
3142         g_return_val_if_reached (NULL);
3143         break;
3144     }
3145   }
3146   g_value_unset (&data);
3147   gst_iterator_free (iter);
3148
3149   return pad;
3150 }
3151
3152 /**
3153  * gst_parse_bin_from_description:
3154  * @bin_description: command line describing the bin
3155  * @ghost_unlinked_pads: whether to automatically create ghost pads
3156  *     for unlinked source or sink pads within the bin
3157  * @err: where to store the error message in case of an error, or NULL
3158  *
3159  * This is a convenience wrapper around gst_parse_launch() to create a
3160  * #GstBin from a gst-launch-style pipeline description. See
3161  * gst_parse_launch() and the gst-launch man page for details about the
3162  * syntax. Ghost pads on the bin for unlinked source or sink pads
3163  * within the bin can automatically be created (but only a maximum of
3164  * one ghost pad for each direction will be created; if you expect
3165  * multiple unlinked source pads or multiple unlinked sink pads
3166  * and want them all ghosted, you will have to create the ghost pads
3167  * yourself).
3168  *
3169  * Returns: (transfer floating): a newly-created bin, or NULL if an error occurred.
3170  *
3171  * Since: 0.10.3
3172  */
3173 GstElement *
3174 gst_parse_bin_from_description (const gchar * bin_description,
3175     gboolean ghost_unlinked_pads, GError ** err)
3176 {
3177   return gst_parse_bin_from_description_full (bin_description,
3178       ghost_unlinked_pads, NULL, GST_PARSE_FLAG_NONE, err);
3179 }
3180
3181 /**
3182  * gst_parse_bin_from_description_full:
3183  * @bin_description: command line describing the bin
3184  * @ghost_unlinked_pads: whether to automatically create ghost pads
3185  *     for unlinked source or sink pads within the bin
3186  * @context: (transfer none) (allow-none): a parse context allocated with
3187  *     gst_parse_context_new(), or %NULL
3188  * @flags: parsing options, or #GST_PARSE_FLAG_NONE
3189  * @err: where to store the error message in case of an error, or NULL
3190  *
3191  * This is a convenience wrapper around gst_parse_launch() to create a
3192  * #GstBin from a gst-launch-style pipeline description. See
3193  * gst_parse_launch() and the gst-launch man page for details about the
3194  * syntax. Ghost pads on the bin for unlinked source or sink pads
3195  * within the bin can automatically be created (but only a maximum of
3196  * one ghost pad for each direction will be created; if you expect
3197  * multiple unlinked source pads or multiple unlinked sink pads
3198  * and want them all ghosted, you will have to create the ghost pads
3199  * yourself).
3200  *
3201  * Returns: (transfer full): a newly-created bin, or NULL if an error occurred.
3202  *
3203  * Since: 0.10.20
3204  */
3205 GstElement *
3206 gst_parse_bin_from_description_full (const gchar * bin_description,
3207     gboolean ghost_unlinked_pads, GstParseContext * context,
3208     GstParseFlags flags, GError ** err)
3209 {
3210 #ifndef GST_DISABLE_PARSE
3211   GstPad *pad = NULL;
3212   GstBin *bin;
3213   gchar *desc;
3214
3215   g_return_val_if_fail (bin_description != NULL, NULL);
3216   g_return_val_if_fail (err == NULL || *err == NULL, NULL);
3217
3218   GST_DEBUG ("Making bin from description '%s'", bin_description);
3219
3220   /* parse the pipeline to a bin */
3221   desc = g_strdup_printf ("bin.( %s )", bin_description);
3222   bin = (GstBin *) gst_parse_launch_full (desc, context, flags, err);
3223   g_free (desc);
3224
3225   if (bin == NULL || (err && *err != NULL)) {
3226     if (bin)
3227       gst_object_unref (bin);
3228     return NULL;
3229   }
3230
3231   /* find pads and ghost them if necessary */
3232   if (ghost_unlinked_pads) {
3233     if ((pad = gst_bin_find_unlinked_pad (bin, GST_PAD_SRC))) {
3234       gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("src", pad));
3235       gst_object_unref (pad);
3236     }
3237     if ((pad = gst_bin_find_unlinked_pad (bin, GST_PAD_SINK))) {
3238       gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("sink", pad));
3239       gst_object_unref (pad);
3240     }
3241   }
3242
3243   return GST_ELEMENT (bin);
3244 #else
3245   gchar *msg;
3246
3247   GST_WARNING ("Disabled API called");
3248
3249   msg = gst_error_get_message (GST_CORE_ERROR, GST_CORE_ERROR_DISABLED);
3250   g_set_error (err, GST_CORE_ERROR, GST_CORE_ERROR_DISABLED, "%s", msg);
3251   g_free (msg);
3252
3253   return NULL;
3254 #endif
3255 }
3256
3257 /**
3258  * gst_util_get_timestamp:
3259  *
3260  * Get a timestamp as GstClockTime to be used for interval measurements.
3261  * The timestamp should not be interpreted in any other way.
3262  *
3263  * Returns: the timestamp
3264  *
3265  * Since: 0.10.16
3266  */
3267 GstClockTime
3268 gst_util_get_timestamp (void)
3269 {
3270 #if defined (HAVE_POSIX_TIMERS) && defined(HAVE_MONOTONIC_CLOCK)
3271   struct timespec now;
3272
3273   clock_gettime (CLOCK_MONOTONIC, &now);
3274   return GST_TIMESPEC_TO_TIME (now);
3275 #else
3276   GTimeVal now;
3277
3278   g_get_current_time (&now);
3279   return GST_TIMEVAL_TO_TIME (now);
3280 #endif
3281 }
3282
3283 /**
3284  * gst_util_array_binary_search:
3285  * @array: the sorted input array
3286  * @num_elements: number of elements in the array
3287  * @element_size: size of every element in bytes
3288  * @search_func: (scope call): function to compare two elements, @search_data will always be passed as second argument
3289  * @mode: search mode that should be used
3290  * @search_data: element that should be found
3291  * @user_data: (closure): data to pass to @search_func
3292  *
3293  * Searches inside @array for @search_data by using the comparison function
3294  * @search_func. @array must be sorted ascending.
3295  *
3296  * As @search_data is always passed as second argument to @search_func it's
3297  * not required that @search_data has the same type as the array elements.
3298  *
3299  * The complexity of this search function is O(log (num_elements)).
3300  *
3301  * Returns: (transfer none): The address of the found element or %NULL if nothing was found
3302  *
3303  * Since: 0.10.23
3304  */
3305 gpointer
3306 gst_util_array_binary_search (gpointer array, guint num_elements,
3307     gsize element_size, GCompareDataFunc search_func, GstSearchMode mode,
3308     gconstpointer search_data, gpointer user_data)
3309 {
3310   glong left = 0, right = num_elements - 1, m;
3311   gint ret;
3312   guint8 *data = (guint8 *) array;
3313
3314   g_return_val_if_fail (array != NULL, NULL);
3315   g_return_val_if_fail (element_size > 0, NULL);
3316   g_return_val_if_fail (search_func != NULL, NULL);
3317
3318   /* 0. No elements => return NULL */
3319   if (num_elements == 0)
3320     return NULL;
3321
3322   /* 1. If search_data is before the 0th element return the 0th element */
3323   ret = search_func (data, search_data, user_data);
3324   if ((ret >= 0 && mode == GST_SEARCH_MODE_AFTER) || ret == 0)
3325     return data;
3326   else if (ret > 0)
3327     return NULL;
3328
3329   /* 2. If search_data is after the last element return the last element */
3330   ret =
3331       search_func (data + (num_elements - 1) * element_size, search_data,
3332       user_data);
3333   if ((ret <= 0 && mode == GST_SEARCH_MODE_BEFORE) || ret == 0)
3334     return data + (num_elements - 1) * element_size;
3335   else if (ret < 0)
3336     return NULL;
3337
3338   /* 3. else binary search */
3339   while (TRUE) {
3340     m = left + (right - left) / 2;
3341
3342     ret = search_func (data + m * element_size, search_data, user_data);
3343
3344     if (ret == 0) {
3345       return data + m * element_size;
3346     } else if (ret < 0) {
3347       left = m + 1;
3348     } else {
3349       right = m - 1;
3350     }
3351
3352     /* No exact match found */
3353     if (right < left) {
3354       if (mode == GST_SEARCH_MODE_EXACT) {
3355         return NULL;
3356       } else if (mode == GST_SEARCH_MODE_AFTER) {
3357         if (ret < 0)
3358           return (m < num_elements) ? data + (m + 1) * element_size : NULL;
3359         else
3360           return data + m * element_size;
3361       } else {
3362         if (ret < 0)
3363           return data + m * element_size;
3364         else
3365           return (m > 0) ? data + (m - 1) * element_size : NULL;
3366       }
3367     }
3368   }
3369 }
3370
3371 /* Finds the greatest common divisor.
3372  * Returns 1 if none other found.
3373  * This is Euclid's algorithm. */
3374
3375 /**
3376  * gst_util_greatest_common_divisor:
3377  * @a: First value as #gint
3378  * @b: Second value as #gint
3379  *
3380  * Calculates the greatest common divisor of @a
3381  * and @b.
3382  *
3383  * Returns: Greatest common divisor of @a and @b
3384  *
3385  * Since: 0.10.26
3386  */
3387 gint
3388 gst_util_greatest_common_divisor (gint a, gint b)
3389 {
3390   while (b != 0) {
3391     int temp = a;
3392
3393     a = b;
3394     b = temp % b;
3395   }
3396
3397   return ABS (a);
3398 }
3399
3400 /**
3401  * gst_util_greatest_common_divisor_int64:
3402  * @a: First value as #gint64
3403  * @b: Second value as #gint64
3404  *
3405  * Calculates the greatest common divisor of @a
3406  * and @b.
3407  *
3408  * Returns: Greatest common divisor of @a and @b
3409  *
3410  * Since: 0.11.0
3411  */
3412 gint64
3413 gst_util_greatest_common_divisor_int64 (gint64 a, gint64 b)
3414 {
3415   while (b != 0) {
3416     gint64 temp = a;
3417
3418     a = b;
3419     b = temp % b;
3420   }
3421
3422   return ABS (a);
3423 }
3424
3425
3426 /**
3427  * gst_util_fraction_to_double:
3428  * @src_n: Fraction numerator as #gint
3429  * @src_d: Fraction denominator #gint
3430  * @dest: (out): pointer to a #gdouble for the result
3431  *
3432  * Transforms a fraction to a #gdouble.
3433  *
3434  * Since: 0.10.26
3435  */
3436 void
3437 gst_util_fraction_to_double (gint src_n, gint src_d, gdouble * dest)
3438 {
3439   g_return_if_fail (dest != NULL);
3440   g_return_if_fail (src_d != 0);
3441
3442   *dest = ((gdouble) src_n) / ((gdouble) src_d);
3443 }
3444
3445 #define MAX_TERMS       30
3446 #define MIN_DIVISOR     1.0e-10
3447 #define MAX_ERROR       1.0e-20
3448
3449 /* use continued fractions to transform a double into a fraction,
3450  * see http://mathforum.org/dr.math/faq/faq.fractions.html#decfrac.
3451  * This algorithm takes care of overflows.
3452  */
3453
3454 /**
3455  * gst_util_double_to_fraction:
3456  * @src: #gdouble to transform
3457  * @dest_n: (out): pointer to a #gint to hold the result numerator
3458  * @dest_d: (out): pointer to a #gint to hold the result denominator
3459  *
3460  * Transforms a #gdouble to a fraction and simplifies
3461  * the result.
3462  *
3463  * Since: 0.10.26
3464  */
3465 void
3466 gst_util_double_to_fraction (gdouble src, gint * dest_n, gint * dest_d)
3467 {
3468
3469   gdouble V, F;                 /* double being converted */
3470   gint N, D;                    /* will contain the result */
3471   gint A;                       /* current term in continued fraction */
3472   gint64 N1, D1;                /* numerator, denominator of last approx */
3473   gint64 N2, D2;                /* numerator, denominator of previous approx */
3474   gint i;
3475   gint gcd;
3476   gboolean negative = FALSE;
3477
3478   g_return_if_fail (dest_n != NULL);
3479   g_return_if_fail (dest_d != NULL);
3480
3481   /* initialize fraction being converted */
3482   F = src;
3483   if (F < 0.0) {
3484     F = -F;
3485     negative = TRUE;
3486   }
3487
3488   V = F;
3489   /* initialize fractions with 1/0, 0/1 */
3490   N1 = 1;
3491   D1 = 0;
3492   N2 = 0;
3493   D2 = 1;
3494   N = 1;
3495   D = 1;
3496
3497   for (i = 0; i < MAX_TERMS; i++) {
3498     /* get next term */
3499     A = (gint) F;               /* no floor() needed, F is always >= 0 */
3500     /* get new divisor */
3501     F = F - A;
3502
3503     /* calculate new fraction in temp */
3504     N2 = N1 * A + N2;
3505     D2 = D1 * A + D2;
3506
3507     /* guard against overflow */
3508     if (N2 > G_MAXINT || D2 > G_MAXINT) {
3509       break;
3510     }
3511
3512     N = N2;
3513     D = D2;
3514
3515     /* save last two fractions */
3516     N2 = N1;
3517     D2 = D1;
3518     N1 = N;
3519     D1 = D;
3520
3521     /* quit if dividing by zero or close enough to target */
3522     if (F < MIN_DIVISOR || fabs (V - ((gdouble) N) / D) < MAX_ERROR) {
3523       break;
3524     }
3525
3526     /* Take reciprocal */
3527     F = 1 / F;
3528   }
3529   /* fix for overflow */
3530   if (D == 0) {
3531     N = G_MAXINT;
3532     D = 1;
3533   }
3534   /* fix for negative */
3535   if (negative)
3536     N = -N;
3537
3538   /* simplify */
3539   gcd = gst_util_greatest_common_divisor (N, D);
3540   if (gcd) {
3541     N /= gcd;
3542     D /= gcd;
3543   }
3544
3545   /* set results */
3546   *dest_n = N;
3547   *dest_d = D;
3548 }
3549
3550 /**
3551  * gst_util_fraction_multiply:
3552  * @a_n: Numerator of first value
3553  * @a_d: Denominator of first value
3554  * @b_n: Numerator of second value
3555  * @b_d: Denominator of second value
3556  * @res_n: (out): Pointer to #gint to hold the result numerator
3557  * @res_d: (out): Pointer to #gint to hold the result denominator
3558  *
3559  * Multiplies the fractions @a_n/@a_d and @b_n/@b_d and stores
3560  * the result in @res_n and @res_d.
3561  *
3562  * Returns: %FALSE on overflow, %TRUE otherwise.
3563  *
3564  * Since: 0.10.26
3565  */
3566 gboolean
3567 gst_util_fraction_multiply (gint a_n, gint a_d, gint b_n, gint b_d,
3568     gint * res_n, gint * res_d)
3569 {
3570   gint gcd;
3571
3572   g_return_val_if_fail (res_n != NULL, FALSE);
3573   g_return_val_if_fail (res_d != NULL, FALSE);
3574   g_return_val_if_fail (a_d != 0, FALSE);
3575   g_return_val_if_fail (b_d != 0, FALSE);
3576
3577   gcd = gst_util_greatest_common_divisor (a_n, a_d);
3578   a_n /= gcd;
3579   a_d /= gcd;
3580
3581   gcd = gst_util_greatest_common_divisor (b_n, b_d);
3582   b_n /= gcd;
3583   b_d /= gcd;
3584
3585   gcd = gst_util_greatest_common_divisor (a_n, b_d);
3586   a_n /= gcd;
3587   b_d /= gcd;
3588
3589   gcd = gst_util_greatest_common_divisor (a_d, b_n);
3590   a_d /= gcd;
3591   b_n /= gcd;
3592
3593   /* This would result in overflow */
3594   if (a_n != 0 && G_MAXINT / ABS (a_n) < ABS (b_n))
3595     return FALSE;
3596   if (G_MAXINT / ABS (a_d) < ABS (b_d))
3597     return FALSE;
3598
3599   *res_n = a_n * b_n;
3600   *res_d = a_d * b_d;
3601
3602   gcd = gst_util_greatest_common_divisor (*res_n, *res_d);
3603   *res_n /= gcd;
3604   *res_d /= gcd;
3605
3606   return TRUE;
3607 }
3608
3609 /**
3610  * gst_util_fraction_add:
3611  * @a_n: Numerator of first value
3612  * @a_d: Denominator of first value
3613  * @b_n: Numerator of second value
3614  * @b_d: Denominator of second value
3615  * @res_n: (out): Pointer to #gint to hold the result numerator
3616  * @res_d: (out): Pointer to #gint to hold the result denominator
3617  *
3618  * Adds the fractions @a_n/@a_d and @b_n/@b_d and stores
3619  * the result in @res_n and @res_d.
3620  *
3621  * Returns: %FALSE on overflow, %TRUE otherwise.
3622  *
3623  * Since: 0.10.26
3624  */
3625 gboolean
3626 gst_util_fraction_add (gint a_n, gint a_d, gint b_n, gint b_d, gint * res_n,
3627     gint * res_d)
3628 {
3629   gint gcd;
3630
3631   g_return_val_if_fail (res_n != NULL, FALSE);
3632   g_return_val_if_fail (res_d != NULL, FALSE);
3633   g_return_val_if_fail (a_d != 0, FALSE);
3634   g_return_val_if_fail (b_d != 0, FALSE);
3635
3636   gcd = gst_util_greatest_common_divisor (a_n, a_d);
3637   a_n /= gcd;
3638   a_d /= gcd;
3639
3640   gcd = gst_util_greatest_common_divisor (b_n, b_d);
3641   b_n /= gcd;
3642   b_d /= gcd;
3643
3644   if (a_n == 0) {
3645     *res_n = b_n;
3646     *res_d = b_d;
3647     return TRUE;
3648   }
3649   if (b_n == 0) {
3650     *res_n = a_n;
3651     *res_d = a_d;
3652     return TRUE;
3653   }
3654
3655   /* This would result in overflow */
3656   if (G_MAXINT / ABS (a_n) < ABS (b_n))
3657     return FALSE;
3658   if (G_MAXINT / ABS (a_d) < ABS (b_d))
3659     return FALSE;
3660   if (G_MAXINT / ABS (a_d) < ABS (b_d))
3661     return FALSE;
3662
3663   *res_n = (a_n * b_d) + (a_d * b_n);
3664   *res_d = a_d * b_d;
3665
3666   gcd = gst_util_greatest_common_divisor (*res_n, *res_d);
3667   if (gcd) {
3668     *res_n /= gcd;
3669     *res_d /= gcd;
3670   } else {
3671     /* res_n == 0 */
3672     *res_d = 1;
3673   }
3674
3675   return TRUE;
3676 }
3677
3678 /**
3679  * gst_util_fraction_compare:
3680  * @a_n: Numerator of first value
3681  * @a_d: Denominator of first value
3682  * @b_n: Numerator of second value
3683  * @b_d: Denominator of second value
3684  *
3685  * Compares the fractions @a_n/@a_d and @b_n/@b_d and returns
3686  * -1 if a < b, 0 if a = b and 1 if a > b.
3687  *
3688  * Returns: -1 if a < b; 0 if a = b; 1 if a > b.
3689  *
3690  * Since: 0.10.31
3691  */
3692 gint
3693 gst_util_fraction_compare (gint a_n, gint a_d, gint b_n, gint b_d)
3694 {
3695   gint64 new_num_1;
3696   gint64 new_num_2;
3697   gint gcd;
3698
3699   g_return_val_if_fail (a_d != 0 && b_d != 0, 0);
3700
3701   /* Simplify */
3702   gcd = gst_util_greatest_common_divisor (a_n, a_d);
3703   a_n /= gcd;
3704   a_d /= gcd;
3705
3706   gcd = gst_util_greatest_common_divisor (b_n, b_d);
3707   b_n /= gcd;
3708   b_d /= gcd;
3709
3710   /* fractions are reduced when set, so we can quickly see if they're equal */
3711   if (a_n == b_n && a_d == b_d)
3712     return 0;
3713
3714   /* extend to 64 bits */
3715   new_num_1 = ((gint64) a_n) * b_d;
3716   new_num_2 = ((gint64) b_n) * a_d;
3717   if (new_num_1 < new_num_2)
3718     return -1;
3719   if (new_num_1 > new_num_2)
3720     return 1;
3721
3722   /* Should not happen because a_d and b_d are not 0 */
3723   g_return_val_if_reached (0);
3724 }