gst/gstutils.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstutils.c: Utility functions: gtk_get_property stuff, etc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22 /**
  23  * SECTION:gstutils
  24  * @short_description: Various utility functions
  25  *
  26  * When defining own plugins, use the GST_BOILERPLATE ease gobject creation.
  27  */
  28
  29 #include <stdio.h>
  30 #include <string.h>
  31
  32 #include "gst_private.h"
  33 #include "gstghostpad.h"
  34 #include "gstutils.h"
  35 #include "gsturitype.h"
  36 #include "gstinfo.h"
  37 #include "gst-i18n-lib.h"
  38
  39
  40 /**
  41  * gst_util_dump_mem:
  42  * @mem: a pointer to the memory to dump
  43  * @size: the size of the memory block to dump
  44  *
  45  * Dumps the memory block into a hex representation. Useful for debugging.
  46  */
  47 void
  48 gst_util_dump_mem (const guchar * mem, guint size)
  49 {
  50   guint i, j;
  51   GString *string = g_string_sized_new (50);
  52   GString *chars = g_string_sized_new (18);
  53
  54   i = j = 0;
  55   while (i < size) {
  56     if (g_ascii_isprint (mem[i]))
  57       g_string_append_printf (chars, "%c", mem[i]);
  58     else
  59       g_string_append_printf (chars, ".");
  60
  61     g_string_append_printf (string, "%02x ", mem[i]);
  62
  63     j++;
  64     i++;
  65
  66     if (j == 16 || i == size) {
  67       g_print ("%08x (%p): %-48.48s %-16.16s\n", i - j, mem + i - j,
  68           string->str, chars->str);
  69       g_string_set_size (string, 0);
  70       g_string_set_size (chars, 0);
  71       j = 0;
  72     }
  73   }
  74   g_string_free (string, TRUE);
  75   g_string_free (chars, TRUE);
  76 }
  77
  78
  79 /**
  80  * gst_util_set_value_from_string:
  81  * @value: the value to set
  82  * @value_str: the string to get the value from
  83  *
  84  * Converts the string to the type of the value and
  85  * sets the value with it.
  86  */
  87 void
  88 gst_util_set_value_from_string (GValue * value, const gchar * value_str)
  89 {
  90
  91   g_return_if_fail (value != NULL);
  92   g_return_if_fail (value_str != NULL);
  93
  94   GST_CAT_DEBUG (GST_CAT_PARAMS, "parsing '%s' to type %s", value_str,
  95       g_type_name (G_VALUE_TYPE (value)));
  96
  97   switch (G_VALUE_TYPE (value)) {
  98     case G_TYPE_STRING:
  99       g_value_set_string (value, g_strdup (value_str));
 100       break;
 101     case G_TYPE_ENUM:
 102     case G_TYPE_INT:{
 103       gint i;
 104
 105       g_return_if_fail (sscanf (value_str, "%d", &i) == 1);
 106       g_value_set_int (value, i);
 107       break;
 108     }
 109     case G_TYPE_UINT:{
 110       guint i;
 111
 112       g_return_if_fail (sscanf (value_str, "%u", &i) == 1);
 113       g_value_set_uint (value, i);
 114       break;
 115     }
 116     case G_TYPE_LONG:{
 117       glong i;
 118
 119       g_return_if_fail (sscanf (value_str, "%ld", &i) == 1);
 120       g_value_set_long (value, i);
 121       break;
 122     }
 123     case G_TYPE_ULONG:{
 124       gulong i;
 125
 126       g_return_if_fail (sscanf (value_str, "%lu", &i) == 1);
 127       g_value_set_ulong (value, i);
 128       break;
 129     }
 130     case G_TYPE_BOOLEAN:{
 131       gboolean i = FALSE;
 132
 133       if (!strncmp ("true", value_str, 4))
 134         i = TRUE;
 135       g_value_set_boolean (value, i);
 136       break;
 137     }
 138     case G_TYPE_CHAR:{
 139       gchar i;
 140
 141       g_return_if_fail (sscanf (value_str, "%c", &i) == 1);
 142       g_value_set_char (value, i);
 143       break;
 144     }
 145     case G_TYPE_UCHAR:{
 146       guchar i;
 147
 148       g_return_if_fail (sscanf (value_str, "%c", &i) == 1);
 149       g_value_set_uchar (value, i);
 150       break;
 151     }
 152     case G_TYPE_FLOAT:{
 153       gfloat i;
 154
 155       g_return_if_fail (sscanf (value_str, "%f", &i) == 1);
 156       g_value_set_float (value, i);
 157       break;
 158     }
 159     case G_TYPE_DOUBLE:{
 160       gfloat i;
 161
 162       g_return_if_fail (sscanf (value_str, "%g", &i) == 1);
 163       g_value_set_double (value, (gdouble) i);
 164       break;
 165     }
 166     default:
 167       break;
 168   }
 169 }
 170
 171 /**
 172  * gst_util_set_object_arg:
 173  * @object: the object to set the argument of
 174  * @name: the name of the argument to set
 175  * @value: the string value to set
 176  *
 177  * Convertes the string value to the type of the objects argument and
 178  * sets the argument with it.
 179  */
 180 void
 181 gst_util_set_object_arg (GObject * object, const gchar * name,
 182     const gchar * value)
 183 {
 184   if (name && value) {
 185     GParamSpec *paramspec;
 186
 187     paramspec =
 188         g_object_class_find_property (G_OBJECT_GET_CLASS (object), name);
 189
 190     if (!paramspec) {
 191       return;
 192     }
 193
 194     GST_DEBUG ("paramspec->flags is %d, paramspec->value_type is %d",
 195         paramspec->flags, (gint) paramspec->value_type);
 196
 197     if (paramspec->flags & G_PARAM_WRITABLE) {
 198       switch (paramspec->value_type) {
 199         case G_TYPE_STRING:
 200           g_object_set (G_OBJECT (object), name, value, NULL);
 201           break;
 202         case G_TYPE_ENUM:
 203         case G_TYPE_INT:{
 204           gint i;
 205
 206           g_return_if_fail (sscanf (value, "%d", &i) == 1);
 207           g_object_set (G_OBJECT (object), name, i, NULL);
 208           break;
 209         }
 210         case G_TYPE_UINT:{
 211           guint i;
 212
 213           g_return_if_fail (sscanf (value, "%u", &i) == 1);
 214           g_object_set (G_OBJECT (object), name, i, NULL);
 215           break;
 216         }
 217         case G_TYPE_LONG:{
 218           glong i;
 219
 220           g_return_if_fail (sscanf (value, "%ld", &i) == 1);
 221           g_object_set (G_OBJECT (object), name, i, NULL);
 222           break;
 223         }
 224         case G_TYPE_ULONG:{
 225           gulong i;
 226
 227           g_return_if_fail (sscanf (value, "%lu", &i) == 1);
 228           g_object_set (G_OBJECT (object), name, i, NULL);
 229           break;
 230         }
 231         case G_TYPE_BOOLEAN:{
 232           gboolean i = FALSE;
 233
 234           if (!g_ascii_strncasecmp ("true", value, 4))
 235             i = TRUE;
 236           g_object_set (G_OBJECT (object), name, i, NULL);
 237           break;
 238         }
 239         case G_TYPE_CHAR:{
 240           gchar i;
 241
 242           g_return_if_fail (sscanf (value, "%c", &i) == 1);
 243           g_object_set (G_OBJECT (object), name, i, NULL);
 244           break;
 245         }
 246         case G_TYPE_UCHAR:{
 247           guchar i;
 248
 249           g_return_if_fail (sscanf (value, "%c", &i) == 1);
 250           g_object_set (G_OBJECT (object), name, i, NULL);
 251           break;
 252         }
 253         case G_TYPE_FLOAT:{
 254           gfloat i;
 255
 256           g_return_if_fail (sscanf (value, "%f", &i) == 1);
 257           g_object_set (G_OBJECT (object), name, i, NULL);
 258           break;
 259         }
 260         case G_TYPE_DOUBLE:{
 261           gfloat i;
 262
 263           g_return_if_fail (sscanf (value, "%g", &i) == 1);
 264           g_object_set (G_OBJECT (object), name, (gdouble) i, NULL);
 265           break;
 266         }
 267         default:
 268           if (G_IS_PARAM_SPEC_ENUM (paramspec)) {
 269             gint i;
 270
 271             g_return_if_fail (sscanf (value, "%d", &i) == 1);
 272             g_object_set (G_OBJECT (object), name, i, NULL);
 273           } else if (paramspec->value_type == GST_TYPE_URI) {
 274             g_object_set (G_OBJECT (object), name, value, NULL);
 275           }
 276           break;
 277       }
 278     }
 279   }
 280 }
 281
 282 /**
 283  * gst_util_uint64_scale:
 284  * @val: the number to scale
 285  * @num: the numerator of the scale ratio
 286  * @denom: the denominator of the scale ratio
 287  *
 288  * Scale @val by @num / @denom, trying to avoid overflows.
 289  *
 290  * Returns: @val * @num / @denom, trying to avoid overflows.
 291  */
 292 guint64
 293 gst_util_uint64_scale (guint64 val, guint64 num, guint64 denom)
 294 {
 295   /* implement me with fixed point, if you care */
 296   return val * (((double) num) / denom);
 297 }
 298
 299 /* -----------------------------------------------------
 300  *
 301  *  The following code will be moved out of the main
 302  * gstreamer library someday.
 303  */
 304
 305 #include "gstpad.h"
 306
 307 static void
 308 string_append_indent (GString * str, gint count)
 309 {
 310   gint xx;
 311
 312   for (xx = 0; xx < count; xx++)
 313     g_string_append_c (str, ' ');
 314 }
 315
 316 /**
 317  * gst_print_pad_caps:
 318  * @buf: the buffer to print the caps in
 319  * @indent: initial indentation
 320  * @pad: the pad to print the caps from
 321  *
 322  * Write the pad capabilities in a human readable format into
 323  * the given GString.
 324  */
 325 void
 326 gst_print_pad_caps (GString * buf, gint indent, GstPad * pad)
 327 {
 328   GstCaps *caps;
 329
 330   caps = pad->caps;
 331
 332   if (!caps) {
 333     string_append_indent (buf, indent);
 334     g_string_printf (buf, "%s:%s has no capabilities",
 335         GST_DEBUG_PAD_NAME (pad));
 336   } else {
 337     char *s;
 338
 339     s = gst_caps_to_string (caps);
 340     g_string_append (buf, s);
 341     g_free (s);
 342   }
 343 }
 344
 345 /**
 346  * gst_print_element_args:
 347  * @buf: the buffer to print the args in
 348  * @indent: initial indentation
 349  * @element: the element to print the args of
 350  *
 351  * Print the element argument in a human readable format in the given
 352  * GString.
 353  */
 354 void
 355 gst_print_element_args (GString * buf, gint indent, GstElement * element)
 356 {
 357   guint width;
 358   GValue value = { 0, };        /* the important thing is that value.type = 0 */
 359   gchar *str = NULL;
 360   GParamSpec *spec, **specs, **walk;
 361
 362   specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (element), NULL);
 363
 364   width = 0;
 365   for (walk = specs; *walk; walk++) {
 366     spec = *walk;
 367     if (width < strlen (spec->name))
 368       width = strlen (spec->name);
 369   }
 370
 371   for (walk = specs; *walk; walk++) {
 372     spec = *walk;
 373
 374     if (spec->flags & G_PARAM_READABLE) {
 375       g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (spec));
 376       g_object_get_property (G_OBJECT (element), spec->name, &value);
 377       str = g_strdup_value_contents (&value);
 378       g_value_unset (&value);
 379     } else {
 380       str = g_strdup ("Parameter not readable.");
 381     }
 382
 383     string_append_indent (buf, indent);
 384     g_string_append (buf, spec->name);
 385     string_append_indent (buf, 2 + width - strlen (spec->name));
 386     g_string_append (buf, str);
 387     g_string_append_c (buf, '\n');
 388
 389     g_free (str);
 390   }
 391
 392   g_free (specs);
 393 }
 394
 395 /**
 396  * gst_element_create_all_pads:
 397  * @element: a #GstElement to create pads for
 398  *
 399  * Creates a pad for each pad template that is always available.
 400  * This function is only useful during object intialization of
 401  * subclasses of #GstElement.
 402  */
 403 void
 404 gst_element_create_all_pads (GstElement * element)
 405 {
 406   GList *padlist;
 407
 408   /* FIXME: lock element */
 409
 410   padlist =
 411       gst_element_class_get_pad_template_list (GST_ELEMENT_CLASS
 412       (G_OBJECT_GET_CLASS (element)));
 413
 414   while (padlist) {
 415     GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
 416
 417     if (padtempl->presence == GST_PAD_ALWAYS) {
 418       GstPad *pad;
 419
 420       pad = gst_pad_new_from_template (padtempl, padtempl->name_template);
 421
 422       gst_element_add_pad (element, pad);
 423     }
 424     padlist = padlist->next;
 425   }
 426 }
 427
 428 /**
 429  * gst_element_get_compatible_pad_template:
 430  * @element: a #GstElement to get a compatible pad template for.
 431  * @compattempl: the #GstPadTemplate to find a compatible template for.
 432  *
 433  * Retrieves a pad template from @element that is compatible with @compattempl.
 434  * Pads from compatible templates can be linked together.
 435  *
 436  * Returns: a compatible #GstPadTemplate, or NULL if none was found. No
 437  * unreferencing is necessary.
 438  */
 439 GstPadTemplate *
 440 gst_element_get_compatible_pad_template (GstElement * element,
 441     GstPadTemplate * compattempl)
 442 {
 443   GstPadTemplate *newtempl = NULL;
 444   GList *padlist;
 445   GstElementClass *class;
 446
 447   g_return_val_if_fail (element != NULL, NULL);
 448   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
 449   g_return_val_if_fail (compattempl != NULL, NULL);
 450
 451   class = GST_ELEMENT_GET_CLASS (element);
 452
 453   padlist = gst_element_class_get_pad_template_list (class);
 454
 455   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
 456       "Looking for a suitable pad template in %s out of %d templates...",
 457       GST_ELEMENT_NAME (element), g_list_length (padlist));
 458
 459   while (padlist) {
 460     GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
 461     GstCaps *intersection;
 462
 463     /* Ignore name
 464      * Ignore presence
 465      * Check direction (must be opposite)
 466      * Check caps
 467      */
 468     GST_CAT_LOG (GST_CAT_CAPS,
 469         "checking pad template %s", padtempl->name_template);
 470     if (padtempl->direction != compattempl->direction) {
 471       GST_CAT_DEBUG (GST_CAT_CAPS,
 472           "compatible direction: found %s pad template \"%s\"",
 473           padtempl->direction == GST_PAD_SRC ? "src" : "sink",
 474           padtempl->name_template);
 475
 476       GST_CAT_DEBUG (GST_CAT_CAPS,
 477           "intersecting %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (compattempl));
 478       GST_CAT_DEBUG (GST_CAT_CAPS,
 479           "..and %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (padtempl));
 480
 481       intersection = gst_caps_intersect (GST_PAD_TEMPLATE_CAPS (compattempl),
 482           GST_PAD_TEMPLATE_CAPS (padtempl));
 483
 484       GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible %" GST_PTR_FORMAT,
 485           (intersection ? "" : "not "), intersection);
 486
 487       if (!gst_caps_is_empty (intersection))
 488         newtempl = padtempl;
 489       gst_caps_unref (intersection);
 490       if (newtempl)
 491         break;
 492     }
 493
 494     padlist = g_list_next (padlist);
 495   }
 496   if (newtempl)
 497     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
 498         "Returning new pad template %p", newtempl);
 499   else
 500     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "No compatible pad template found");
 501
 502   return newtempl;
 503 }
 504
 505 static GstPad *
 506 gst_element_request_pad (GstElement * element, GstPadTemplate * templ,
 507     const gchar * name)
 508 {
 509   GstPad *newpad = NULL;
 510   GstElementClass *oclass;
 511
 512   oclass = GST_ELEMENT_GET_CLASS (element);
 513
 514   if (oclass->request_new_pad)
 515     newpad = (oclass->request_new_pad) (element, templ, name);
 516
 517   if (newpad)
 518     gst_object_ref (newpad);
 519
 520   return newpad;
 521 }
 522
 523
 524
 525 /**
 526  * gst_element_get_pad_from_template:
 527  * @element: a #GstElement.
 528  * @templ: a #GstPadTemplate belonging to @element.
 529  *
 530  * Gets a pad from @element described by @templ. If the presence of @templ is
 531  * #GST_PAD_REQUEST, requests a new pad. Can return %NULL for #GST_PAD_SOMETIMES
 532  * templates.
 533  *
 534  * Returns: the #GstPad, or NULL if one could not be found or created.
 535  */
 536 static GstPad *
 537 gst_element_get_pad_from_template (GstElement * element, GstPadTemplate * templ)
 538 {
 539   GstPad *ret = NULL;
 540   GstPadPresence presence;
 541
 542   /* If this function is ever exported, we need check the validity of `element'
 543    * and `templ', and to make sure the template actually belongs to the
 544    * element. */
 545
 546   presence = GST_PAD_TEMPLATE_PRESENCE (templ);
 547
 548   switch (presence) {
 549     case GST_PAD_ALWAYS:
 550     case GST_PAD_SOMETIMES:
 551       ret = gst_element_get_static_pad (element, templ->name_template);
 552       if (!ret && presence == GST_PAD_ALWAYS)
 553         g_warning
 554             ("Element %s has an ALWAYS template %s, but no pad of the same name",
 555             GST_OBJECT_NAME (element), templ->name_template);
 556       break;
 557
 558     case GST_PAD_REQUEST:
 559       ret = gst_element_request_pad (element, templ, NULL);
 560       break;
 561   }
 562
 563   return ret;
 564 }
 565
 566 /**
 567  * gst_element_request_compatible_pad:
 568  * @element: a #GstElement.
 569  * @templ: the #GstPadTemplate to which the new pad should be able to link.
 570  *
 571  * Requests a pad from @element. The returned pad should be unlinked and
 572  * compatible with @templ. Might return an existing pad, or request a new one.
 573  *
 574  * Returns: a #GstPad, or %NULL if one could not be found or created.
 575  */
 576 GstPad *
 577 gst_element_request_compatible_pad (GstElement * element,
 578     GstPadTemplate * templ)
 579 {
 580   GstPadTemplate *templ_new;
 581   GstPad *pad = NULL;
 582
 583   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
 584   g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
 585
 586   /* FIXME: should really loop through the templates, testing each for
 587    *      compatibility and pad availability. */
 588   templ_new = gst_element_get_compatible_pad_template (element, templ);
 589   if (templ_new)
 590     pad = gst_element_get_pad_from_template (element, templ_new);
 591
 592   /* This can happen for non-request pads. No need to unref. */
 593   if (pad && GST_PAD_PEER (pad))
 594     pad = NULL;
 595
 596   return pad;
 597 }
 598
 599 /**
 600  * gst_element_get_compatible_pad:
 601  * @element: a #GstElement in which the pad should be found.
 602  * @pad: the #GstPad to find a compatible one for.
 603  * @caps: the #GstCaps to use as a filter.
 604  *
 605  * Looks for an unlinked pad to which the given pad can link. It is not
 606  * guaranteed that linking the pads will work, though it should work in most
 607  * cases.
 608  *
 609  * Returns: the #GstPad to which a link can be made, or %NULL if one cannot be
 610  * found.
 611  */
 612 GstPad *
 613 gst_element_get_compatible_pad (GstElement * element, GstPad * pad,
 614     const GstCaps * caps)
 615 {
 616   GstIterator *pads;
 617   GstPadTemplate *templ;
 618   GstCaps *templcaps;
 619   GstPad *foundpad = NULL;
 620   gboolean done;
 621
 622   /* FIXME check for caps compatibility */
 623
 624   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
 625   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
 626
 627   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
 628       "finding pad in %s compatible with %s:%s",
 629       GST_ELEMENT_NAME (element), GST_DEBUG_PAD_NAME (pad));
 630
 631   g_return_val_if_fail (GST_PAD_PEER (pad) == NULL, NULL);
 632
 633   done = FALSE;
 634   /* try to get an existing unlinked pad */
 635   pads = gst_element_iterate_pads (element);
 636   while (!done) {
 637     gpointer padptr;
 638
 639     switch (gst_iterator_next (pads, &padptr)) {
 640       case GST_ITERATOR_OK:
 641       {
 642         GstPad *peer;
 643         GstPad *current;
 644
 645         current = GST_PAD (padptr);
 646
 647         GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
 648             GST_DEBUG_PAD_NAME (current));
 649
 650         peer = gst_pad_get_peer (current);
 651
 652         if (peer == NULL && gst_pad_can_link (pad, current)) {
 653
 654           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
 655               "found existing unlinked pad %s:%s",
 656               GST_DEBUG_PAD_NAME (current));
 657
 658           gst_iterator_free (pads);
 659
 660           return current;
 661         } else {
 662           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unreffing pads");
 663
 664           gst_object_unref (current);
 665           if (peer)
 666             gst_object_unref (peer);
 667         }
 668         break;
 669       }
 670       case GST_ITERATOR_DONE:
 671         done = TRUE;
 672         break;
 673       case GST_ITERATOR_RESYNC:
 674         gst_iterator_resync (pads);
 675         break;
 676       case GST_ITERATOR_ERROR:
 677         g_assert_not_reached ();
 678         break;
 679     }
 680   }
 681   gst_iterator_free (pads);
 682
 683   /* try to create a new one */
 684   /* requesting is a little crazy, we need a template. Let's create one */
 685   templcaps = gst_pad_get_caps (pad);
 686
 687   templ = gst_pad_template_new ((gchar *) GST_PAD_NAME (pad),
 688       GST_PAD_DIRECTION (pad), GST_PAD_ALWAYS, templcaps);
 689   foundpad = gst_element_request_compatible_pad (element, templ);
 690   gst_object_unref (templ);
 691
 692   if (foundpad) {
 693     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
 694         "found existing request pad %s:%s", GST_DEBUG_PAD_NAME (foundpad));
 695     return foundpad;
 696   }
 697
 698   GST_CAT_INFO_OBJECT (GST_CAT_ELEMENT_PADS, element,
 699       "Could not find a compatible pad to link to %s:%s",
 700       GST_DEBUG_PAD_NAME (pad));
 701   return NULL;
 702 }
 703
 704 /**
 705  * gst_element_state_get_name:
 706  * @state: a #GstState to get the name of.
 707  *
 708  * Gets a string representing the given state.
 709  *
 710  * Returns: a string with the name of the state.
 711  */
 712 const gchar *
 713 gst_element_state_get_name (GstState state)
 714 {
 715   switch (state) {
 716 #ifdef GST_DEBUG_COLOR
 717     case GST_STATE_VOID_PENDING:
 718       return "VOID_PENDING";
 719       break;
 720     case GST_STATE_NULL:
 721       return "\033[01;34mNULL\033[00m";
 722       break;
 723     case GST_STATE_READY:
 724       return "\033[01;31mREADY\033[00m";
 725       break;
 726     case GST_STATE_PLAYING:
 727       return "\033[01;32mPLAYING\033[00m";
 728       break;
 729     case GST_STATE_PAUSED:
 730       return "\033[01;33mPAUSED\033[00m";
 731       break;
 732     default:
 733       /* This is a memory leak */
 734       return g_strdup_printf ("\033[01;35;41mUNKNOWN!\033[00m(%d)", state);
 735 #else
 736     case GST_STATE_VOID_PENDING:
 737       return "VOID_PENDING";
 738       break;
 739     case GST_STATE_NULL:
 740       return "NULL";
 741       break;
 742     case GST_STATE_READY:
 743       return "READY";
 744       break;
 745     case GST_STATE_PLAYING:
 746       return "PLAYING";
 747       break;
 748     case GST_STATE_PAUSED:
 749       return "PAUSED";
 750       break;
 751     default:
 752       return g_strdup_printf ("UNKNOWN!(%d)", state);
 753 #endif
 754   }
 755   return "";
 756 }
 757
 758 /**
 759  * gst_element_factory_can_src_caps :
 760  * @factory: factory to query
 761  * @caps: the caps to check
 762  *
 763  * Checks if the factory can source the given capability.
 764  *
 765  * Returns: true if it can src the capabilities
 766  */
 767 gboolean
 768 gst_element_factory_can_src_caps (GstElementFactory * factory,
 769     const GstCaps * caps)
 770 {
 771   GList *templates;
 772
 773   g_return_val_if_fail (factory != NULL, FALSE);
 774   g_return_val_if_fail (caps != NULL, FALSE);
 775
 776   templates = factory->staticpadtemplates;
 777
 778   while (templates) {
 779     GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
 780
 781     if (template->direction == GST_PAD_SRC) {
 782       if (gst_caps_is_always_compatible (gst_static_caps_get (&template->
 783                   static_caps), caps))
 784         return TRUE;
 785     }
 786     templates = g_list_next (templates);
 787   }
 788
 789   return FALSE;
 790 }
 791
 792 /**
 793  * gst_element_factory_can_sink_caps :
 794  * @factory: factory to query
 795  * @caps: the caps to check
 796  *
 797  * Checks if the factory can sink the given capability.
 798  *
 799  * Returns: true if it can sink the capabilities
 800  */
 801 gboolean
 802 gst_element_factory_can_sink_caps (GstElementFactory * factory,
 803     const GstCaps * caps)
 804 {
 805   GList *templates;
 806
 807   g_return_val_if_fail (factory != NULL, FALSE);
 808   g_return_val_if_fail (caps != NULL, FALSE);
 809
 810   templates = factory->staticpadtemplates;
 811
 812   while (templates) {
 813     GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
 814
 815     if (template->direction == GST_PAD_SINK) {
 816       if (gst_caps_is_always_compatible (caps,
 817               gst_static_caps_get (&template->static_caps)))
 818         return TRUE;
 819     }
 820     templates = g_list_next (templates);
 821   }
 822
 823   return FALSE;
 824 }
 825
 826
 827 /* if return val is true, *direct_child is a caller-owned ref on the direct
 828  * child of ancestor that is part of object's ancestry */
 829 static gboolean
 830 object_has_ancestor (GstObject * object, GstObject * ancestor,
 831     GstObject ** direct_child)
 832 {
 833   GstObject *child, *parent;
 834
 835   if (direct_child)
 836     *direct_child = NULL;
 837
 838   child = gst_object_ref (object);
 839   parent = gst_object_get_parent (object);
 840
 841   while (parent) {
 842     if (ancestor == parent) {
 843       if (direct_child)
 844         *direct_child = child;
 845       else
 846         gst_object_unref (child);
 847       gst_object_unref (parent);
 848       return TRUE;
 849     }
 850
 851     gst_object_unref (child);
 852     child = parent;
 853     parent = gst_object_get_parent (parent);
 854   }
 855
 856   gst_object_unref (child);
 857
 858   return FALSE;
 859 }
 860
 861 /* caller owns return */
 862 static GstObject *
 863 find_common_root (GstObject * o1, GstObject * o2)
 864 {
 865   GstObject *top = o1;
 866   GstObject *kid1, *kid2;
 867   GstObject *root = NULL;
 868
 869   while (GST_OBJECT_PARENT (top))
 870     top = GST_OBJECT_PARENT (top);
 871
 872   /* the itsy-bitsy spider... */
 873
 874   if (!object_has_ancestor (o2, top, &kid2))
 875     return NULL;
 876
 877   root = gst_object_ref (top);
 878   while (TRUE) {
 879     if (!object_has_ancestor (o1, kid2, &kid1)) {
 880       gst_object_unref (kid2);
 881       return root;
 882     }
 883     root = kid2;
 884     if (!object_has_ancestor (o2, kid1, &kid2)) {
 885       gst_object_unref (kid1);
 886       return root;
 887     }
 888     root = kid1;
 889   }
 890 }
 891
 892 /* caller does not own return */
 893 static GstPad *
 894 ghost_up (GstElement * e, GstPad * pad)
 895 {
 896   static gint ghost_pad_index = 0;
 897   GstPad *gpad;
 898   gchar *name;
 899   GstObject *parent = GST_OBJECT_PARENT (e);
 900
 901   name = g_strdup_printf ("ghost%d", ghost_pad_index++);
 902   gpad = gst_ghost_pad_new (name, pad);
 903   g_free (name);
 904
 905   if (!gst_element_add_pad ((GstElement *) parent, gpad)) {
 906     g_warning ("Pad named %s already exists in element %s\n",
 907         GST_OBJECT_NAME (gpad), GST_OBJECT_NAME (parent));
 908     gst_object_unref ((GstObject *) gpad);
 909     return NULL;
 910   }
 911
 912   return gpad;
 913 }
 914
 915 static void
 916 remove_pad (gpointer ppad, gpointer unused)
 917 {
 918   GstPad *pad = ppad;
 919
 920   if (!gst_element_remove_pad ((GstElement *) GST_OBJECT_PARENT (pad), pad))
 921     g_warning ("Couldn't remove pad %s from element %s",
 922         GST_OBJECT_NAME (pad), GST_OBJECT_NAME (GST_OBJECT_PARENT (pad)));
 923 }
 924
 925 static gboolean
 926 prepare_link_maybe_ghosting (GstPad ** src, GstPad ** sink,
 927     GSList ** pads_created)
 928 {
 929   GstObject *root;
 930   GstObject *e1, *e2;
 931   GSList *pads_created_local = NULL;
 932
 933   g_assert (pads_created);
 934
 935   e1 = GST_OBJECT_PARENT (*src);
 936   e2 = GST_OBJECT_PARENT (*sink);
 937
 938   if (GST_OBJECT_PARENT (e1) == GST_OBJECT_PARENT (e2)) {
 939     GST_CAT_INFO (GST_CAT_PADS, "%s and %s in same bin, no need for ghost pads",
 940         GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
 941     return TRUE;
 942   }
 943
 944   GST_CAT_INFO (GST_CAT_PADS, "%s and %s not in same bin, making ghost pads",
 945       GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
 946
 947   /* we need to setup some ghost pads */
 948   root = find_common_root (e1, e2);
 949   if (!root) {
 950     g_warning
 951         ("Trying to connect elements that don't share a common ancestor: %s and %s\n",
 952         GST_ELEMENT_NAME (e1), GST_ELEMENT_NAME (e2));
 953     return FALSE;
 954   }
 955
 956   while (GST_OBJECT_PARENT (e1) != root) {
 957     *src = ghost_up ((GstElement *) e1, *src);
 958     if (!*src)
 959       goto cleanup_fail;
 960     e1 = GST_OBJECT_PARENT (*src);
 961     pads_created_local = g_slist_prepend (pads_created_local, *src);
 962   }
 963   while (GST_OBJECT_PARENT (e2) != root) {
 964     *sink = ghost_up ((GstElement *) e2, *sink);
 965     if (!*sink)
 966       goto cleanup_fail;
 967     e2 = GST_OBJECT_PARENT (*sink);
 968     pads_created_local = g_slist_prepend (pads_created_local, *sink);
 969   }
 970
 971   gst_object_unref (root);
 972   *pads_created = g_slist_concat (*pads_created, pads_created_local);
 973   return TRUE;
 974
 975 cleanup_fail:
 976   gst_object_unref (root);
 977   g_slist_foreach (pads_created_local, remove_pad, NULL);
 978   g_slist_free (pads_created_local);
 979   return FALSE;
 980 }
 981
 982 static gboolean
 983 pad_link_maybe_ghosting (GstPad * src, GstPad * sink)
 984 {
 985   GSList *pads_created = NULL;
 986   gboolean ret;
 987
 988   if (!prepare_link_maybe_ghosting (&src, &sink, &pads_created)) {
 989     ret = FALSE;
 990   } else {
 991     ret = (gst_pad_link (src, sink) == GST_PAD_LINK_OK);
 992   }
 993
 994   if (!ret) {
 995     g_slist_foreach (pads_created, remove_pad, NULL);
 996   }
 997   g_slist_free (pads_created);
 998
 999   return ret;
1000 }
1001
1002 /**
1003  * gst_element_link_pads:
1004  * @src: a #GstElement containing the source pad.
1005  * @srcpadname: the name of the #GstPad in source element or NULL for any pad.
1006  * @dest: the #GstElement containing the destination pad.
1007  * @destpadname: the name of the #GstPad in destination element or NULL for any pad.
1008  *
1009  * Links the two named pads of the source and destination elements.
1010  * Side effect is that if one of the pads has no parent, it becomes a
1011  * child of the parent of the other element.  If they have different
1012  * parents, the link fails.
1013  *
1014  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1015  */
1016 gboolean
1017 gst_element_link_pads (GstElement * src, const gchar * srcpadname,
1018     GstElement * dest, const gchar * destpadname)
1019 {
1020   const GList *srcpads, *destpads, *srctempls, *desttempls, *l;
1021   GstPad *srcpad, *destpad;
1022   GstPadTemplate *srctempl, *desttempl;
1023   GstElementClass *srcclass, *destclass;
1024
1025   /* checks */
1026   g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1027   g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1028
1029   srcclass = GST_ELEMENT_GET_CLASS (src);
1030   destclass = GST_ELEMENT_GET_CLASS (dest);
1031
1032   GST_CAT_INFO (GST_CAT_ELEMENT_PADS,
1033       "trying to link element %s:%s to element %s:%s", GST_ELEMENT_NAME (src),
1034       srcpadname ? srcpadname : "(any)", GST_ELEMENT_NAME (dest),
1035       destpadname ? destpadname : "(any)");
1036
1037   /* now get the pads we're trying to link and a list of all remaining pads */
1038   if (srcpadname) {
1039     srcpad = gst_element_get_pad (src, srcpadname);
1040     if (!srcpad) {
1041       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1042           GST_ELEMENT_NAME (src), srcpadname);
1043       return FALSE;
1044     } else {
1045       if (!(GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC)) {
1046         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no src pad",
1047             GST_DEBUG_PAD_NAME (srcpad));
1048         gst_object_unref (srcpad);
1049         return FALSE;
1050       }
1051       if (GST_PAD_PEER (srcpad) != NULL) {
1052         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is already linked",
1053             GST_DEBUG_PAD_NAME (srcpad));
1054         gst_object_unref (srcpad);
1055         return FALSE;
1056       }
1057     }
1058     srcpads = NULL;
1059   } else {
1060     GST_LOCK (src);
1061     srcpads = GST_ELEMENT_PADS (src);
1062     srcpad = srcpads ? GST_PAD_CAST (srcpads->data) : NULL;
1063     if (srcpad)
1064       gst_object_ref (srcpad);
1065     GST_UNLOCK (src);
1066   }
1067   if (destpadname) {
1068     destpad = gst_element_get_pad (dest, destpadname);
1069     if (!destpad) {
1070       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1071           GST_ELEMENT_NAME (dest), destpadname);
1072       return FALSE;
1073     } else {
1074       if (!(GST_PAD_DIRECTION (destpad) == GST_PAD_SINK)) {
1075         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no sink pad",
1076             GST_DEBUG_PAD_NAME (destpad));
1077         gst_object_unref (destpad);
1078         return FALSE;
1079       }
1080       if (GST_PAD_PEER (destpad) != NULL) {
1081         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is already linked",
1082             GST_DEBUG_PAD_NAME (destpad));
1083         gst_object_unref (destpad);
1084         return FALSE;
1085       }
1086     }
1087     destpads = NULL;
1088   } else {
1089     GST_LOCK (dest);
1090     destpads = GST_ELEMENT_PADS (dest);
1091     destpad = destpads ? GST_PAD_CAST (destpads->data) : NULL;
1092     if (destpad)
1093       gst_object_ref (destpad);
1094     GST_UNLOCK (dest);
1095   }
1096
1097   if (srcpadname && destpadname) {
1098     gboolean result;
1099
1100     /* two explicitly specified pads */
1101     result = pad_link_maybe_ghosting (srcpad, destpad);
1102
1103     gst_object_unref (srcpad);
1104     gst_object_unref (destpad);
1105
1106     return result;
1107   }
1108   if (srcpad) {
1109     /* loop through the allowed pads in the source, trying to find a
1110      * compatible destination pad */
1111     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1112         "looping through allowed src and dest pads");
1113     do {
1114       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying src pad %s:%s",
1115           GST_DEBUG_PAD_NAME (srcpad));
1116       if ((GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC) &&
1117           (GST_PAD_PEER (srcpad) == NULL)) {
1118         GstPad *temp;
1119
1120         if (destpadname) {
1121           temp = destpad;
1122           gst_object_ref (temp);
1123         } else {
1124           temp = gst_element_get_compatible_pad (dest, srcpad, NULL);
1125         }
1126
1127         if (temp && pad_link_maybe_ghosting (srcpad, temp)) {
1128           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1129               GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (temp));
1130           if (destpad)
1131             gst_object_unref (destpad);
1132           gst_object_unref (srcpad);
1133           gst_object_unref (temp);
1134           return TRUE;
1135         }
1136
1137         if (temp) {
1138           gst_object_unref (temp);
1139         }
1140       }
1141       /* find a better way for this mess */
1142       if (srcpads) {
1143         srcpads = g_list_next (srcpads);
1144         if (srcpads) {
1145           gst_object_unref (srcpad);
1146           srcpad = GST_PAD_CAST (srcpads->data);
1147           gst_object_ref (srcpad);
1148         }
1149       }
1150     } while (srcpads);
1151   }
1152   if (srcpadname) {
1153     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s:%s to %s",
1154         GST_DEBUG_PAD_NAME (srcpad), GST_ELEMENT_NAME (dest));
1155     gst_object_unref (srcpad);
1156     if (destpad)
1157       gst_object_unref (destpad);
1158     return FALSE;
1159   } else {
1160     if (srcpad)
1161       gst_object_unref (srcpad);
1162     srcpad = NULL;
1163   }
1164   if (destpad) {
1165     /* loop through the existing pads in the destination */
1166     do {
1167       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying dest pad %s:%s",
1168           GST_DEBUG_PAD_NAME (destpad));
1169       if ((GST_PAD_DIRECTION (destpad) == GST_PAD_SINK) &&
1170           (GST_PAD_PEER (destpad) == NULL)) {
1171         GstPad *temp = gst_element_get_compatible_pad (src, destpad, NULL);
1172
1173         if (temp && pad_link_maybe_ghosting (temp, destpad)) {
1174           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1175               GST_DEBUG_PAD_NAME (temp), GST_DEBUG_PAD_NAME (destpad));
1176           gst_object_unref (temp);
1177           gst_object_unref (destpad);
1178           if (srcpad)
1179             gst_object_unref (srcpad);
1180           return TRUE;
1181         }
1182         if (temp) {
1183           gst_object_unref (temp);
1184         }
1185       }
1186       if (destpads) {
1187         destpads = g_list_next (destpads);
1188         if (destpads) {
1189           gst_object_unref (destpad);
1190           destpad = GST_PAD_CAST (destpads->data);
1191           gst_object_ref (destpad);
1192         }
1193       }
1194     } while (destpads);
1195   }
1196   if (destpadname) {
1197     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s:%s",
1198         GST_ELEMENT_NAME (src), GST_DEBUG_PAD_NAME (destpad));
1199     gst_object_unref (destpad);
1200     if (srcpad)
1201       gst_object_unref (srcpad);
1202     return FALSE;
1203   } else {
1204     gst_object_unref (destpad);
1205     if (srcpad)
1206       gst_object_unref (srcpad);
1207     srcpad = NULL;
1208     destpad = NULL;
1209   }
1210
1211   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1212       "we might have request pads on both sides, checking...");
1213   srctempls = gst_element_class_get_pad_template_list (srcclass);
1214   desttempls = gst_element_class_get_pad_template_list (destclass);
1215
1216   if (srctempls && desttempls) {
1217     while (srctempls) {
1218       srctempl = (GstPadTemplate *) srctempls->data;
1219       if (srctempl->presence == GST_PAD_REQUEST) {
1220         for (l = desttempls; l; l = l->next) {
1221           desttempl = (GstPadTemplate *) l->data;
1222           if (desttempl->presence == GST_PAD_REQUEST &&
1223               desttempl->direction != srctempl->direction) {
1224             if (gst_caps_is_always_compatible (gst_pad_template_get_caps
1225                     (srctempl), gst_pad_template_get_caps (desttempl))) {
1226               srcpad =
1227                   gst_element_get_request_pad (src, srctempl->name_template);
1228               destpad =
1229                   gst_element_get_request_pad (dest, desttempl->name_template);
1230               if (pad_link_maybe_ghosting (srcpad, destpad)) {
1231                 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1232                     "linked pad %s:%s to pad %s:%s",
1233                     GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (destpad));
1234                 gst_object_unref (srcpad);
1235                 gst_object_unref (destpad);
1236                 return TRUE;
1237               }
1238               /* it failed, so we release the request pads */
1239               gst_element_release_request_pad (src, srcpad);
1240               gst_element_release_request_pad (dest, destpad);
1241             }
1242           }
1243         }
1244       }
1245       srctempls = srctempls->next;
1246     }
1247   }
1248
1249   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s",
1250       GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
1251   return FALSE;
1252 }
1253
1254 /**
1255  * gst_element_link_pads_filtered:
1256  * @src: a #GstElement containing the source pad.
1257  * @srcpadname: the name of the #GstPad in source element or NULL for any pad.
1258  * @dest: the #GstElement containing the destination pad.
1259  * @destpadname: the name of the #GstPad in destination element or NULL for any pad.
1260  * @filter: the #GstCaps to filter the link, or #NULL for no filter.
1261  *
1262  * Links the two named pads of the source and destination elements. Side effect
1263  * is that if one of the pads has no parent, it becomes a child of the parent of
1264  * the other element. If they have different parents, the link fails. If @caps
1265  * is not #NULL, makes sure that the caps of the link is a subset of @caps.
1266  *
1267  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1268  */
1269 gboolean
1270 gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
1271     GstElement * dest, const gchar * destpadname, GstCaps * filter)
1272 {
1273   /* checks */
1274   g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1275   g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1276   g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), FALSE);
1277
1278   if (filter) {
1279     GstElement *capsfilter;
1280     GstObject *parent;
1281     GstState state, pending;
1282     GTimeVal tv;
1283
1284     capsfilter = gst_element_factory_make ("capsfilter", NULL);
1285     if (!capsfilter) {
1286       GST_ERROR ("Could not make a capsfilter");
1287       return FALSE;
1288     }
1289
1290     parent = gst_object_get_parent (GST_OBJECT (src));
1291     g_return_val_if_fail (GST_IS_BIN (parent), FALSE);
1292
1293     GST_TIME_TO_TIMEVAL (0, tv);
1294     gst_element_get_state (GST_ELEMENT_CAST (parent), &state, &pending, &tv);
1295
1296     if (!gst_bin_add (GST_BIN (parent), capsfilter)) {
1297       GST_ERROR ("Could not add capsfilter");
1298       gst_object_unref (capsfilter);
1299       gst_object_unref (parent);
1300       return FALSE;
1301     }
1302
1303     if (pending != GST_STATE_VOID_PENDING)
1304       state = pending;
1305
1306     gst_element_set_state (capsfilter, state);
1307
1308     gst_object_unref (parent);
1309
1310     g_object_set (capsfilter, "filter-caps", filter, NULL);
1311
1312     if (gst_element_link_pads (src, srcpadname, capsfilter, "sink")
1313         && gst_element_link_pads (capsfilter, "src", dest, destpadname)) {
1314       return TRUE;
1315     } else {
1316       GST_INFO ("Could not link elements");
1317       gst_bin_remove (GST_BIN (GST_OBJECT_PARENT (capsfilter)), capsfilter);
1318       /* will unref and unlink as appropriate */
1319       return FALSE;
1320     }
1321   } else {
1322     return gst_element_link_pads (src, srcpadname, dest, destpadname);
1323   }
1324 }
1325
1326 /**
1327  * gst_element_link:
1328  * @src: a #GstElement containing the source pad.
1329  * @dest: the #GstElement containing the destination pad.
1330  *
1331  * Links @src to @dest. The link must be from source to
1332  * destination; the other direction will not be tried. The function looks for
1333  * existing pads that aren't linked yet. It will request new pads if necessary.
1334  * If multiple links are possible, only one is established.
1335  *
1336  * Returns: TRUE if the elements could be linked, FALSE otherwise.
1337  */
1338 gboolean
1339 gst_element_link (GstElement * src, GstElement * dest)
1340 {
1341   return gst_element_link_pads_filtered (src, NULL, dest, NULL, NULL);
1342 }
1343
1344 /**
1345  * gst_element_link_many:
1346  * @element_1: the first #GstElement in the link chain.
1347  * @element_2: the second #GstElement in the link chain.
1348  * @...: the NULL-terminated list of elements to link in order.
1349  *
1350  * Chain together a series of elements. Uses gst_element_link().
1351  *
1352  * Returns: TRUE on success, FALSE otherwise.
1353  */
1354 gboolean
1355 gst_element_link_many (GstElement * element_1, GstElement * element_2, ...)
1356 {
1357   va_list args;
1358
1359   g_return_val_if_fail (GST_IS_ELEMENT (element_1), FALSE);
1360   g_return_val_if_fail (GST_IS_ELEMENT (element_2), FALSE);
1361
1362   va_start (args, element_2);
1363
1364   while (element_2) {
1365     if (!gst_element_link (element_1, element_2))
1366       return FALSE;
1367
1368     element_1 = element_2;
1369     element_2 = va_arg (args, GstElement *);
1370   }
1371
1372   va_end (args);
1373
1374   return TRUE;
1375 }
1376
1377 /**
1378  * gst_element_link_filtered:
1379  * @src: a #GstElement containing the source pad.
1380  * @dest: the #GstElement containing the destination pad.
1381  * @filter: the #GstCaps to filter the link, or #NULL for no filter.
1382  *
1383  * Links @src to @dest using the given caps as filtercaps.
1384  * The link must be from source to
1385  * destination; the other direction will not be tried. The function looks for
1386  * existing pads that aren't linked yet. It will request new pads if necessary.
1387  * If multiple links are possible, only one is established.
1388  *
1389  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1390  */
1391 gboolean
1392 gst_element_link_filtered (GstElement * src, GstElement * dest,
1393     GstCaps * filter)
1394 {
1395   return gst_element_link_pads_filtered (src, NULL, dest, NULL, filter);
1396 }
1397
1398 /**
1399  * gst_element_unlink_pads:
1400  * @src: a #GstElement containing the source pad.
1401  * @srcpadname: the name of the #GstPad in source element.
1402  * @dest: a #GstElement containing the destination pad.
1403  * @destpadname: the name of the #GstPad in destination element.
1404  *
1405  * Unlinks the two named pads of the source and destination elements.
1406  */
1407 void
1408 gst_element_unlink_pads (GstElement * src, const gchar * srcpadname,
1409     GstElement * dest, const gchar * destpadname)
1410 {
1411   GstPad *srcpad, *destpad;
1412
1413   g_return_if_fail (src != NULL);
1414   g_return_if_fail (GST_IS_ELEMENT (src));
1415   g_return_if_fail (srcpadname != NULL);
1416   g_return_if_fail (dest != NULL);
1417   g_return_if_fail (GST_IS_ELEMENT (dest));
1418   g_return_if_fail (destpadname != NULL);
1419
1420   /* obtain the pads requested */
1421   srcpad = gst_element_get_pad (src, srcpadname);
1422   if (srcpad == NULL) {
1423     GST_WARNING_OBJECT (src, "source element has no pad \"%s\"", srcpadname);
1424     return;
1425   }
1426   destpad = gst_element_get_pad (dest, destpadname);
1427   if (srcpad == NULL) {
1428     GST_WARNING_OBJECT (dest, "destination element has no pad \"%s\"",
1429         destpadname);
1430     return;
1431   }
1432
1433   /* we're satisified they can be unlinked, let's do it */
1434   gst_pad_unlink (srcpad, destpad);
1435 }
1436
1437 /**
1438  * gst_element_unlink_many:
1439  * @element_1: the first #GstElement in the link chain.
1440  * @element_2: the second #GstElement in the link chain.
1441  * @...: the NULL-terminated list of elements to unlink in order.
1442  *
1443  * Unlinks a series of elements. Uses gst_element_unlink().
1444  */
1445 void
1446 gst_element_unlink_many (GstElement * element_1, GstElement * element_2, ...)
1447 {
1448   va_list args;
1449
1450   g_return_if_fail (element_1 != NULL && element_2 != NULL);
1451   g_return_if_fail (GST_IS_ELEMENT (element_1) && GST_IS_ELEMENT (element_2));
1452
1453   va_start (args, element_2);
1454
1455   while (element_2) {
1456     gst_element_unlink (element_1, element_2);
1457
1458     element_1 = element_2;
1459     element_2 = va_arg (args, GstElement *);
1460   }
1461
1462   va_end (args);
1463 }
1464
1465 /**
1466  * gst_element_unlink:
1467  * @src: the source #GstElement to unlink.
1468  * @dest: the sink #GstElement to unlink.
1469  *
1470  * Unlinks all source pads of the source element with all sink pads
1471  * of the sink element to which they are linked.
1472  */
1473 void
1474 gst_element_unlink (GstElement * src, GstElement * dest)
1475 {
1476   GstIterator *pads;
1477   gboolean done = FALSE;
1478
1479   g_return_if_fail (GST_IS_ELEMENT (src));
1480   g_return_if_fail (GST_IS_ELEMENT (dest));
1481
1482   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unlinking \"%s\" and \"%s\"",
1483       GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
1484
1485   pads = gst_element_iterate_pads (src);
1486   while (!done) {
1487     gpointer data;
1488
1489     switch (gst_iterator_next (pads, &data)) {
1490       case GST_ITERATOR_OK:
1491       {
1492         GstPad *pad = GST_PAD_CAST (data);
1493
1494         if (GST_PAD_IS_SRC (pad)) {
1495           GstPad *peerpad = gst_pad_get_peer (pad);
1496
1497           /* see if the pad is connected and is really a pad
1498            * of dest */
1499           if (peerpad) {
1500             GstElement *peerelem;
1501
1502             peerelem = gst_pad_get_parent_element (peerpad);
1503
1504             if (peerelem == dest) {
1505               gst_pad_unlink (pad, peerpad);
1506             }
1507             if (peerelem)
1508               gst_object_unref (peerelem);
1509
1510             gst_object_unref (peerpad);
1511           }
1512         }
1513         gst_object_unref (pad);
1514         break;
1515       }
1516       case GST_ITERATOR_RESYNC:
1517         gst_iterator_resync (pads);
1518         break;
1519       case GST_ITERATOR_DONE:
1520         done = TRUE;
1521         break;
1522       default:
1523         g_assert_not_reached ();
1524         break;
1525     }
1526   }
1527 }
1528
1529 gboolean
1530 gst_element_query_position (GstElement * element, GstFormat * format,
1531     gint64 * cur, gint64 * end)
1532 {
1533   GstQuery *query;
1534   gboolean ret;
1535
1536   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1537   g_return_val_if_fail (format != NULL, FALSE);
1538
1539   query = gst_query_new_position (*format);
1540   ret = gst_element_query (element, query);
1541
1542   if (ret)
1543     gst_query_parse_position (query, format, cur, end);
1544
1545   gst_query_unref (query);
1546
1547   return ret;
1548 }
1549
1550 gboolean
1551 gst_element_query_convert (GstElement * element, GstFormat src_format,
1552     gint64 src_val, GstFormat * dest_fmt, gint64 * dest_val)
1553 {
1554   GstQuery *query;
1555   gboolean ret;
1556
1557   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1558   g_return_val_if_fail (dest_fmt != NULL, FALSE);
1559   g_return_val_if_fail (dest_val != NULL, FALSE);
1560
1561   if (*dest_fmt == src_format) {
1562     *dest_val = src_val;
1563     return TRUE;
1564   }
1565
1566   query = gst_query_new_convert (src_format, src_val, *dest_fmt);
1567   ret = gst_element_query (element, query);
1568
1569   if (ret)
1570     gst_query_parse_convert (query, NULL, NULL, dest_fmt, dest_val);
1571
1572   gst_query_unref (query);
1573
1574   return ret;
1575 }
1576
1577
1578 /**
1579  * gst_pad_can_link:
1580  * @srcpad: the source #GstPad to link.
1581  * @sinkpad: the sink #GstPad to link.
1582  *
1583  * Checks if the source pad and the sink pad can be linked.
1584  * Both @srcpad and @sinkpad must be unlinked.
1585  *
1586  * Returns: TRUE if the pads can be linked, FALSE otherwise.
1587  */
1588 gboolean
1589 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
1590 {
1591   /* FIXME This function is gross.  It's almost a direct copy of
1592    * gst_pad_link_filtered().  Any decent programmer would attempt
1593    * to merge the two functions, which I will do some day. --ds
1594    */
1595
1596   /* generic checks */
1597   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
1598   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
1599
1600   GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
1601       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
1602
1603   /* FIXME: shouldn't we convert this to g_return_val_if_fail? */
1604   if (GST_PAD_PEER (srcpad) != NULL) {
1605     GST_CAT_INFO (GST_CAT_PADS, "Source pad %s:%s has a peer, failed",
1606         GST_DEBUG_PAD_NAME (srcpad));
1607     return FALSE;
1608   }
1609   if (GST_PAD_PEER (sinkpad) != NULL) {
1610     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has a peer, failed",
1611         GST_DEBUG_PAD_NAME (sinkpad));
1612     return FALSE;
1613   }
1614   if (!GST_PAD_IS_SRC (srcpad)) {
1615     GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s is not source pad, failed",
1616         GST_DEBUG_PAD_NAME (srcpad));
1617     return FALSE;
1618   }
1619   if (!GST_PAD_IS_SINK (sinkpad)) {
1620     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s is not sink pad, failed",
1621         GST_DEBUG_PAD_NAME (sinkpad));
1622     return FALSE;
1623   }
1624   if (GST_PAD_PARENT (srcpad) == NULL) {
1625     GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s has no parent, failed",
1626         GST_DEBUG_PAD_NAME (srcpad));
1627     return FALSE;
1628   }
1629   if (GST_PAD_PARENT (sinkpad) == NULL) {
1630     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has no parent, failed",
1631         GST_DEBUG_PAD_NAME (srcpad));
1632     return FALSE;
1633   }
1634
1635   return TRUE;
1636 }
1637
1638 /**
1639  * gst_pad_use_fixed_caps:
1640  * @pad: the pad to use
1641  *
1642  * A helper function you can use that sets the
1643  * @gst_pad_get_fixed_caps_func as the gstcaps function for the
1644  * pad. This way the function will always return the negotiated caps
1645  * or in case the pad is not negotiated, the padtemplate caps.
1646  *
1647  * Use this function on a pad that, once _set_caps() has been called
1648  * on it, it cannot be renegotiated to something else.
1649  */
1650 void
1651 gst_pad_use_fixed_caps (GstPad * pad)
1652 {
1653   gst_pad_set_getcaps_function (pad, gst_pad_get_fixed_caps_func);
1654 }
1655
1656 /**
1657  * gst_pad_get_fixed_caps_func:
1658  * @pad: the pad to use
1659  *
1660  * A helper function you can use as a GetCaps function that
1661  * will return the currently negotiated caps or the padtemplate
1662  * when NULL.
1663  *
1664  * Returns: The currently negotiated caps or the padtemplate.
1665  */
1666 GstCaps *
1667 gst_pad_get_fixed_caps_func (GstPad * pad)
1668 {
1669   GstCaps *result;
1670
1671   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1672
1673   if (GST_PAD_CAPS (pad)) {
1674     result = GST_PAD_CAPS (pad);
1675
1676     GST_CAT_DEBUG (GST_CAT_CAPS,
1677         "using pad caps %p %" GST_PTR_FORMAT, result, result);
1678
1679     result = gst_caps_ref (result);
1680     goto done;
1681   }
1682   if (GST_PAD_PAD_TEMPLATE (pad)) {
1683     GstPadTemplate *templ = GST_PAD_PAD_TEMPLATE (pad);
1684
1685     result = GST_PAD_TEMPLATE_CAPS (templ);
1686     GST_CAT_DEBUG (GST_CAT_CAPS,
1687         "using pad template %p with caps %p %" GST_PTR_FORMAT, templ, result,
1688         result);
1689
1690     result = gst_caps_ref (result);
1691     goto done;
1692   }
1693   GST_CAT_DEBUG (GST_CAT_CAPS, "pad has no caps");
1694   result = gst_caps_new_empty ();
1695
1696 done:
1697   return result;
1698 }
1699
1700 /**
1701  * gst_pad_get_parent_element:
1702  * @pad: a pad
1703  *
1704  * Gets the parent of @pad, cast to a #GstElement. If a @pad has no parent or
1705  * its parent is not an element, return NULL.
1706  *
1707  * Returns: The parent of the pad. The caller has a reference on the parent, so
1708  * unref when you're finished with it.
1709  *
1710  * MT safe.
1711  */
1712 GstElement *
1713 gst_pad_get_parent_element (GstPad * pad)
1714 {
1715   GstObject *p;
1716
1717   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
1718
1719   p = gst_object_get_parent (GST_OBJECT_CAST (pad));
1720
1721   if (p && !GST_IS_ELEMENT (p)) {
1722     gst_object_unref (p);
1723     p = NULL;
1724   }
1725   return GST_ELEMENT_CAST (p);
1726 }
1727
1728 /**
1729  * gst_flow_get_name:
1730  * @ret: a #GstFlowReturn to get the name of.
1731  *
1732  * Gets a string representing the given flow return.
1733  *
1734  * Returns: a string with the name of the flow return.
1735  */
1736 G_CONST_RETURN gchar *
1737 gst_flow_get_name (GstFlowReturn ret)
1738 {
1739   switch (ret) {
1740     case GST_FLOW_RESEND:
1741       return "need to resend buffer";
1742     case GST_FLOW_OK:
1743       return "OK";
1744       /* expected failures */
1745     case GST_FLOW_NOT_LINKED:
1746       return "pad not linked";
1747     case GST_FLOW_WRONG_STATE:
1748       return "pad in wrong state";
1749       /* error cases */
1750     case GST_FLOW_UNEXPECTED:
1751       return "unexpected data on pad";
1752     case GST_FLOW_NOT_NEGOTIATED:
1753       return "pad not negotiated";
1754     case GST_FLOW_ERROR:
1755       return "fatal error occured";
1756     case GST_FLOW_NOT_SUPPORTED:
1757       return "unsupported function called";
1758     default:
1759       return "unknown error";
1760   }
1761 }
1762
1763 /**
1764  * gst_object_default_error:
1765  * @source: the #GstObject that initiated the error.
1766  * @error: the GError.
1767  * @debug: an additional debug information string, or NULL.
1768  *
1769  * A default error function.
1770  *
1771  * The default handler will simply print the error string using g_print.
1772  */
1773 void
1774 gst_object_default_error (GstObject * source, GError * error, gchar * debug)
1775 {
1776   gchar *name = gst_object_get_path_string (source);
1777
1778   g_print (_("ERROR: from element %s: %s\n"), name, error->message);
1779   if (debug)
1780     g_print (_("Additional debug info:\n%s\n"), debug);
1781
1782   g_free (name);
1783 }
1784
1785 /**
1786  * gst_bin_add_many:
1787  * @bin: the bin to add the elements to
1788  * @element_1: the first element to add to the bin
1789  * @...: additional elements to add to the bin
1790  *
1791  * Adds a NULL-terminated list of elements to a bin.  This function is
1792  * equivalent to calling gst_bin_add() for each member of the list.
1793  */
1794 void
1795 gst_bin_add_many (GstBin * bin, GstElement * element_1, ...)
1796 {
1797   va_list args;
1798
1799   g_return_if_fail (GST_IS_BIN (bin));
1800   g_return_if_fail (GST_IS_ELEMENT (element_1));
1801
1802   va_start (args, element_1);
1803
1804   while (element_1) {
1805     gst_bin_add (bin, element_1);
1806
1807     element_1 = va_arg (args, GstElement *);
1808   }
1809
1810   va_end (args);
1811 }
1812
1813 /**
1814  * gst_bin_remove_many:
1815  * @bin: the bin to remove the elements from
1816  * @element_1: the first element to remove from the bin
1817  * @...: NULL-terminated list of elements to remove from the bin
1818  *
1819  * Remove a list of elements from a bin. This function is equivalent
1820  * to calling gst_bin_remove() with each member of the list.
1821  */
1822 void
1823 gst_bin_remove_many (GstBin * bin, GstElement * element_1, ...)
1824 {
1825   va_list args;
1826
1827   g_return_if_fail (GST_IS_BIN (bin));
1828   g_return_if_fail (GST_IS_ELEMENT (element_1));
1829
1830   va_start (args, element_1);
1831
1832   while (element_1) {
1833     gst_bin_remove (bin, element_1);
1834
1835     element_1 = va_arg (args, GstElement *);
1836   }
1837
1838   va_end (args);
1839 }
1840
1841 static void
1842 get_state_func (GstElement * element, gpointer unused)
1843 {
1844   GstStateChangeReturn ret = GST_STATE_CHANGE_ASYNC;
1845
1846   GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
1847       "new thread waiting on state change");
1848
1849   /* wait indefinitely */
1850   while (ret == GST_STATE_CHANGE_ASYNC)
1851     ret = gst_element_get_state (element, NULL, NULL, NULL);
1852
1853   GST_CAT_INFO_OBJECT (GST_CAT_STATES, element,
1854       "thread done waiting on state change");
1855
1856   gst_object_unref (element);
1857 }
1858
1859 /**
1860  * gst_bin_watch_for_state_change:
1861  * @bin: the bin to watch for state changes
1862  *
1863  * Spawns a thread calling gst_element_get_state on @bin with infinite timeout.
1864  *
1865  * In practice this is done because if a bin returns %GST_STATE_CHANGE_ASYNC
1866  * from a state change, it will not commit its state until someone calls
1867  * gst_element_get_state() on it. Thus having another thread checking the bin's
1868  * state will ensure that a state-changed message gets posted on the bus
1869  * eventually.
1870  *
1871  * This function is admittedly a bit of a hack. Bins should always post
1872  * messages. However this behavior was broken out into this function to avoid
1873  * spawning threads when scrubbing, when the bin's state is changing quickly and
1874  * asynchronously.
1875  */
1876 void
1877 gst_bin_watch_for_state_change (GstBin * bin)
1878 {
1879   static GThreadPool *pool = NULL;
1880   static GStaticMutex mutex = G_STATIC_MUTEX_INIT;
1881
1882   g_static_mutex_lock (&mutex);
1883   if (pool == NULL)
1884     pool = g_thread_pool_new ((GFunc) get_state_func, NULL, -1, FALSE, NULL);
1885   g_static_mutex_unlock (&mutex);
1886
1887   g_thread_pool_push (pool, gst_object_ref (bin), NULL);
1888 }
1889
1890 static void
1891 gst_element_populate_std_props (GObjectClass * klass, const gchar * prop_name,
1892     guint arg_id, GParamFlags flags)
1893 {
1894   GQuark prop_id = g_quark_from_string (prop_name);
1895   GParamSpec *pspec;
1896
1897   static GQuark fd_id = 0;
1898   static GQuark blocksize_id;
1899   static GQuark bytesperread_id;
1900   static GQuark dump_id;
1901   static GQuark filesize_id;
1902   static GQuark mmapsize_id;
1903   static GQuark location_id;
1904   static GQuark offset_id;
1905   static GQuark silent_id;
1906   static GQuark touch_id;
1907
1908   if (!fd_id) {
1909     fd_id = g_quark_from_static_string ("fd");
1910     blocksize_id = g_quark_from_static_string ("blocksize");
1911     bytesperread_id = g_quark_from_static_string ("bytesperread");
1912     dump_id = g_quark_from_static_string ("dump");
1913     filesize_id = g_quark_from_static_string ("filesize");
1914     mmapsize_id = g_quark_from_static_string ("mmapsize");
1915     location_id = g_quark_from_static_string ("location");
1916     offset_id = g_quark_from_static_string ("offset");
1917     silent_id = g_quark_from_static_string ("silent");
1918     touch_id = g_quark_from_static_string ("touch");
1919   }
1920
1921   if (prop_id == fd_id) {
1922     pspec = g_param_spec_int ("fd", "File-descriptor",
1923         "File-descriptor for the file being read", 0, G_MAXINT, 0, flags);
1924   } else if (prop_id == blocksize_id) {
1925     pspec = g_param_spec_ulong ("blocksize", "Block Size",
1926         "Block size to read per buffer", 0, G_MAXULONG, 4096, flags);
1927
1928   } else if (prop_id == bytesperread_id) {
1929     pspec = g_param_spec_int ("bytesperread", "Bytes per read",
1930         "Number of bytes to read per buffer", G_MININT, G_MAXINT, 0, flags);
1931
1932   } else if (prop_id == dump_id) {
1933     pspec = g_param_spec_boolean ("dump", "Dump",
1934         "Dump bytes to stdout", FALSE, flags);
1935
1936   } else if (prop_id == filesize_id) {
1937     pspec = g_param_spec_int64 ("filesize", "File Size",
1938         "Size of the file being read", 0, G_MAXINT64, 0, flags);
1939
1940   } else if (prop_id == mmapsize_id) {
1941     pspec = g_param_spec_ulong ("mmapsize", "mmap() Block Size",
1942         "Size in bytes of mmap()d regions", 0, G_MAXULONG, 4 * 1048576, flags);
1943
1944   } else if (prop_id == location_id) {
1945     pspec = g_param_spec_string ("location", "File Location",
1946         "Location of the file to read", NULL, flags);
1947
1948   } else if (prop_id == offset_id) {
1949     pspec = g_param_spec_int64 ("offset", "File Offset",
1950         "Byte offset of current read pointer", 0, G_MAXINT64, 0, flags);
1951
1952   } else if (prop_id == silent_id) {
1953     pspec = g_param_spec_boolean ("silent", "Silent", "Don't produce events",
1954         FALSE, flags);
1955
1956   } else if (prop_id == touch_id) {
1957     pspec = g_param_spec_boolean ("touch", "Touch read data",
1958         "Touch data to force disk read before " "push ()", TRUE, flags);
1959   } else {
1960     g_warning ("Unknown - 'standard' property '%s' id %d from klass %s",
1961         prop_name, arg_id, g_type_name (G_OBJECT_CLASS_TYPE (klass)));
1962     pspec = NULL;
1963   }
1964
1965   if (pspec) {
1966     g_object_class_install_property (klass, arg_id, pspec);
1967   }
1968 }
1969
1970 /**
1971  * gst_element_class_install_std_props:
1972  * @klass: the #GstElementClass to add the properties to.
1973  * @first_name: the name of the first property.
1974  * in a NULL terminated
1975  * @...: the id and flags of the first property, followed by
1976  * further 'name', 'id', 'flags' triplets and terminated by NULL.
1977  *
1978  * Adds a list of standardized properties with types to the @klass.
1979  * the id is for the property switch in your get_prop method, and
1980  * the flags determine readability / writeability.
1981  **/
1982 void
1983 gst_element_class_install_std_props (GstElementClass * klass,
1984     const gchar * first_name, ...)
1985 {
1986   const char *name;
1987
1988   va_list args;
1989
1990   g_return_if_fail (GST_IS_ELEMENT_CLASS (klass));
1991
1992   va_start (args, first_name);
1993
1994   name = first_name;
1995
1996   while (name) {
1997     int arg_id = va_arg (args, int);
1998     int flags = va_arg (args, int);
1999
2000     gst_element_populate_std_props ((GObjectClass *) klass, name, arg_id,
2001         flags);
2002
2003     name = va_arg (args, char *);
2004   }
2005
2006   va_end (args);
2007 }
2008
2009
2010 /**
2011  * gst_buffer_merge:
2012  * @buf1: a first source #GstBuffer to merge.
2013  * @buf2: the second source #GstBuffer to merge.
2014  *
2015  * Create a new buffer that is the concatenation of the two source
2016  * buffers.  The original source buffers will not be modified or
2017  * unref'd.  Make sure you unref the source buffers if they are not used
2018  * anymore afterwards.
2019  *
2020  * If the buffers point to contiguous areas of memory, the buffer
2021  * is created without copying the data.
2022  *
2023  * Returns: the new #GstBuffer that's the concatenation of the source buffers.
2024  */
2025 GstBuffer *
2026 gst_buffer_merge (GstBuffer * buf1, GstBuffer * buf2)
2027 {
2028   GstBuffer *result;
2029
2030   /* we're just a specific case of the more general gst_buffer_span() */
2031   result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
2032
2033   return result;
2034 }
2035
2036 /**
2037  * gst_buffer_join:
2038  * @buf1: a first source #GstBuffer to join.
2039  * @buf2: the second source #GstBuffer to join.
2040  *
2041  * Create a new buffer that is the concatenation of the two source
2042  * buffers, and takes ownership of the original source buffers.
2043  *
2044  * If the buffers point to contiguous areas of memory, the buffer
2045  * is created without copying the data.
2046  *
2047  * Returns: the new #GstBuffer that's the concatenation of the source buffers.
2048  */
2049 GstBuffer *
2050 gst_buffer_join (GstBuffer * buf1, GstBuffer * buf2)
2051 {
2052   GstBuffer *result;
2053
2054   result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
2055   gst_buffer_unref (buf1);
2056   gst_buffer_unref (buf2);
2057
2058   return result;
2059 }
2060
2061
2062 /**
2063  * gst_buffer_stamp:
2064  * @dest: buffer to stamp
2065  * @src: buffer to stamp from
2066  *
2067  * Copies additional information (timestamps and offsets) from one buffer to
2068  * the other.
2069  */
2070 void
2071 gst_buffer_stamp (GstBuffer * dest, const GstBuffer * src)
2072 {
2073   g_return_if_fail (dest != NULL);
2074   g_return_if_fail (src != NULL);
2075
2076   GST_BUFFER_TIMESTAMP (dest) = GST_BUFFER_TIMESTAMP (src);
2077   GST_BUFFER_DURATION (dest) = GST_BUFFER_DURATION (src);
2078   GST_BUFFER_OFFSET (dest) = GST_BUFFER_OFFSET (src);
2079   GST_BUFFER_OFFSET_END (dest) = GST_BUFFER_OFFSET_END (src);
2080 }
2081
2082 static gboolean
2083 intersect_caps_func (GstPad * pad, GValue * ret, GstPad * orig)
2084 {
2085   if (pad != orig) {
2086     GstCaps *peercaps, *existing;
2087
2088     existing = g_value_get_pointer (ret);
2089     peercaps = gst_pad_peer_get_caps (pad);
2090     if (peercaps == NULL)
2091       peercaps = gst_caps_new_any ();
2092     g_value_set_pointer (ret, gst_caps_intersect (existing, peercaps));
2093     gst_caps_unref (existing);
2094     gst_caps_unref (peercaps);
2095   }
2096   return TRUE;
2097 }
2098
2099 /**
2100  * gst_pad_proxy_getcaps:
2101  * @pad: a #GstPad to proxy.
2102  *
2103  * Calls gst_pad_get_allowed_caps() for every other pad belonging to the
2104  * same element as @pad, and returns the intersection of the results.
2105  *
2106  * This function is useful as a default getcaps function for an element
2107  * that can handle any stream format, but requires all its pads to have
2108  * the same caps.  Two such elements are tee and aggregator.
2109  *
2110  * Returns: the intersection of the other pads' allowed caps.
2111  */
2112 GstCaps *
2113 gst_pad_proxy_getcaps (GstPad * pad)
2114 {
2115   GstElement *element;
2116   GstCaps *caps, *intersected;
2117   GstIterator *iter;
2118   GstIteratorResult res;
2119   GValue ret = { 0, };
2120
2121   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2122
2123   GST_DEBUG ("proxying getcaps for %s:%s", GST_DEBUG_PAD_NAME (pad));
2124
2125   element = gst_pad_get_parent_element (pad);
2126   if (element == NULL)
2127     return NULL;
2128
2129   iter = gst_element_iterate_pads (element);
2130
2131   g_value_init (&ret, G_TYPE_POINTER);
2132   g_value_set_pointer (&ret, gst_caps_new_any ());
2133
2134   res = gst_iterator_fold (iter, (GstIteratorFoldFunction) intersect_caps_func,
2135       &ret, pad);
2136   gst_iterator_free (iter);
2137
2138   if (res != GST_ITERATOR_DONE) {
2139     g_warning ("Pad list changed during capsnego for element %s",
2140         GST_ELEMENT_NAME (element));
2141     return NULL;
2142   }
2143
2144   caps = g_value_get_pointer (&ret);
2145   g_value_unset (&ret);
2146
2147   intersected = gst_caps_intersect (caps, gst_pad_get_pad_template_caps (pad));
2148   gst_caps_unref (caps);
2149
2150   return intersected;
2151 }
2152
2153 typedef struct
2154 {
2155   GstPad *orig;
2156   GstCaps *caps;
2157 } LinkData;
2158
2159 static gboolean
2160 link_fold_func (GstPad * pad, GValue * ret, LinkData * data)
2161 {
2162   gboolean success = TRUE;
2163
2164   if (pad != data->orig) {
2165     success = gst_pad_set_caps (pad, data->caps);
2166     g_value_set_boolean (ret, success);
2167   }
2168
2169   return success;
2170 }
2171
2172 /**
2173  * gst_pad_proxy_setcaps
2174  * @pad: a #GstPad to proxy from
2175  * @caps: the #GstCaps to link with
2176  *
2177  * Calls gst_pad_set_caps() for every other pad belonging to the
2178  * same element as @pad.  If gst_pad_set_caps() fails on any pad,
2179  * the proxy setcaps fails. May be used only during negotiation.
2180  *
2181  * Returns: TRUE if sucessful
2182  */
2183 gboolean
2184 gst_pad_proxy_setcaps (GstPad * pad, GstCaps * caps)
2185 {
2186   GstElement *element;
2187   GstIterator *iter;
2188   GstIteratorResult res;
2189   GValue ret = { 0, };
2190   LinkData data;
2191
2192   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2193   g_return_val_if_fail (caps != NULL, FALSE);
2194
2195   GST_DEBUG ("proxying pad link for %s:%s", GST_DEBUG_PAD_NAME (pad));
2196
2197   element = gst_pad_get_parent_element (pad);
2198
2199   iter = gst_element_iterate_pads (element);
2200
2201   g_value_init (&ret, G_TYPE_BOOLEAN);
2202   g_value_set_boolean (&ret, TRUE);
2203   data.orig = pad;
2204   data.caps = caps;
2205
2206   res = gst_iterator_fold (iter, (GstIteratorFoldFunction) link_fold_func,
2207       &ret, &data);
2208   gst_iterator_free (iter);
2209
2210   if (res != GST_ITERATOR_DONE) {
2211     g_warning ("Pad list changed during proxy_pad_link for element %s",
2212         GST_ELEMENT_NAME (element));
2213     return FALSE;
2214   }
2215
2216   /* ok not to unset the gvalue */
2217   return g_value_get_boolean (&ret);
2218 }
2219
2220 /**
2221  * gst_pad_query_position:
2222  * @pad: a #GstPad to invoke the position query on.
2223  * @format: a pointer to the #GstFormat asked for.
2224  *          On return contains the #GstFormat used.
2225  * @cur: A location in which to store the current position, or NULL.
2226  * @end: A location in which to store the end position (length), or NULL.
2227  *
2228  * Queries a pad for the stream position and length.
2229  *
2230  * Returns: TRUE if the query could be performed.
2231  */
2232 gboolean
2233 gst_pad_query_position (GstPad * pad, GstFormat * format, gint64 * cur,
2234     gint64 * end)
2235 {
2236   GstQuery *query;
2237   gboolean ret;
2238
2239   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2240   g_return_val_if_fail (format != NULL, FALSE);
2241
2242   query = gst_query_new_position (*format);
2243   ret = gst_pad_query (pad, query);
2244
2245   if (ret)
2246     gst_query_parse_position (query, format, cur, end);
2247
2248   gst_query_unref (query);
2249
2250   return ret;
2251 }
2252
2253 /**
2254  * gst_pad_query_convert:
2255  * @pad: a #GstPad to invoke the convert query on.
2256  * @src_format: a #GstFormat to convert from.
2257  * @src_val: a value to convert.
2258  * @dest_format: a pointer to the #GstFormat to convert to.
2259  * @dest_val: a pointer to the result.
2260  *
2261  * Queries a pad to convert @src_val in @src_format to @dest_format.
2262  *
2263  * Returns: TRUE if the query could be performed.
2264  */
2265 gboolean
2266 gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2267     GstFormat * dest_format, gint64 * dest_val)
2268 {
2269   GstQuery *query;
2270   gboolean ret;
2271
2272   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2273   g_return_val_if_fail (dest_format != NULL, FALSE);
2274   g_return_val_if_fail (dest_val != NULL, FALSE);
2275
2276   if (*dest_format == src_format) {
2277     *dest_val = src_val;
2278     return TRUE;
2279   }
2280
2281   query = gst_query_new_convert (src_format, src_val, *dest_format);
2282   ret = gst_pad_query (pad, query);
2283
2284   if (ret)
2285     gst_query_parse_convert (query, NULL, NULL, dest_format, dest_val);
2286
2287   gst_query_unref (query);
2288
2289   return ret;
2290 }
2291
2292 /**
2293  * gst_atomic_int_set:
2294  * @atomic_int: pointer to an atomic integer
2295  * @value: value to set
2296  *
2297  * Unconditionally sets the atomic integer to @value.
2298  */
2299 void
2300 gst_atomic_int_set (gint * atomic_int, gint value)
2301 {
2302   int ignore;
2303
2304   *atomic_int = value;
2305   /* read acts as a memory barrier */
2306   ignore = g_atomic_int_get (atomic_int);
2307 }
2308
2309 /**
2310  * gst_pad_add_data_probe:
2311  * @pad: pad to add the data probe handler to
2312  * @handler: function to call when data is passed over pad
2313  * @data: data to pass along with the handler
2314  *
2315  * Connects a signal handler to the pad's have-data signal, and increases
2316  * the do_{buffer,event}_signals number on the pads so that those
2317  * signals are actually fired.
2318  *
2319  * Returns: The handler id
2320  */
2321
2322 gulong
2323 gst_pad_add_data_probe (GstPad * pad, GCallback handler, gpointer data)
2324 {
2325   gulong sigid;
2326
2327   g_return_val_if_fail (GST_IS_PAD (pad), 0);
2328   g_return_val_if_fail (handler != NULL, 0);
2329
2330   GST_LOCK (pad);
2331   sigid = g_signal_connect (pad, "have-data", handler, data);
2332   GST_PAD_DO_EVENT_SIGNALS (pad)++;
2333   GST_PAD_DO_BUFFER_SIGNALS (pad)++;
2334   GST_DEBUG ("adding data probe to pad %s:%s, now %d data, %d event probes",
2335       GST_DEBUG_PAD_NAME (pad),
2336       GST_PAD_DO_BUFFER_SIGNALS (pad), GST_PAD_DO_EVENT_SIGNALS (pad));
2337   GST_UNLOCK (pad);
2338
2339   return sigid;
2340 }
2341
2342 /**
2343  * gst_pad_add_event_probe:
2344  * @pad: pad to add the event probe handler to
2345  * @handler: function to call when data is passed over pad
2346  * @data: data to pass along with the handler
2347  *
2348  * Connects a signal handler to the pad's have-data signal, and increases
2349  * the do_event_signals number on the pads so that this signal
2350  * is actually fired.
2351  *
2352  * Returns: The handler id
2353  */
2354
2355 gulong
2356 gst_pad_add_event_probe (GstPad * pad, GCallback handler, gpointer data)
2357 {
2358   gulong sigid;
2359
2360   g_return_val_if_fail (GST_IS_PAD (pad), 0);
2361   g_return_val_if_fail (handler != NULL, 0);
2362
2363   GST_LOCK (pad);
2364   sigid = g_signal_connect (pad, "have-data", handler, data);
2365   GST_PAD_DO_EVENT_SIGNALS (pad)++;
2366   GST_DEBUG ("adding event probe to pad %s:%s, now %d probes",
2367       GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_EVENT_SIGNALS (pad));
2368   GST_UNLOCK (pad);
2369
2370   return sigid;
2371 }
2372
2373 /**
2374  * gst_pad_add_buffer_probe:
2375  * @pad: pad to add the buffer probe handler to
2376  * @handler: function to call when data is passed over pad
2377  * @data: data to pass along with the handler
2378  *
2379  * Connects a signal handler to the pad's have-data signal, and increases
2380  * the do_buffer_signals number on the pads so that this signal
2381  * is actually fired.
2382  *
2383  * Returns: The handler id
2384  */
2385
2386 gulong
2387 gst_pad_add_buffer_probe (GstPad * pad, GCallback handler, gpointer data)
2388 {
2389   gulong sigid;
2390
2391   g_return_val_if_fail (GST_IS_PAD (pad), 0);
2392   g_return_val_if_fail (handler != NULL, 0);
2393
2394   GST_LOCK (pad);
2395   sigid = g_signal_connect (pad, "have-data", handler, data);
2396   GST_PAD_DO_BUFFER_SIGNALS (pad)++;
2397   GST_DEBUG ("adding buffer probe to pad %s:%s, now %d probes",
2398       GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_BUFFER_SIGNALS (pad));
2399   GST_UNLOCK (pad);
2400
2401   return sigid;
2402 }
2403
2404 /**
2405  * gst_pad_remove_data_probe:
2406  * @pad: pad to remove the data probe handler from
2407  * @handler: function that was assigned to the signal
2408  * @data: data that was assigned to the signal handler
2409  *
2410  * Unconnects a signal handler to the pad's have-data signal, and decreases
2411  * the do_{buffer,event}_signals number on the pads so that those
2412  * signals are actually no more fired if no signals are connected.
2413  */
2414
2415 void
2416 gst_pad_remove_data_probe (GstPad * pad, GCallback handler, gpointer data)
2417 {
2418   guint count;
2419
2420   g_return_if_fail (GST_IS_PAD (pad));
2421   g_return_if_fail (handler != NULL);
2422
2423   GST_LOCK (pad);
2424   count = g_signal_handlers_disconnect_by_func (pad, handler, data);
2425   GST_PAD_DO_BUFFER_SIGNALS (pad) -= count;
2426   GST_PAD_DO_EVENT_SIGNALS (pad) -= count;
2427   GST_DEBUG
2428       ("removing %d data probes from pad %s:%s, now %d event, %d buffer probes",
2429       count, GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_EVENT_SIGNALS (pad),
2430       GST_PAD_DO_BUFFER_SIGNALS (pad));
2431   GST_UNLOCK (pad);
2432 }
2433
2434 /**
2435  * gst_pad_remove_event_probe:
2436  * @pad: pad to remove the event probe handler from
2437  * @handler: function that was assigned to the signal
2438  * @data: data that was assigned to the signal handler
2439  *
2440  * Unconnects a signal handler to the pad's have-data signal, and decreases
2441  * the do_event_signals number on the pads so that this signal is
2442  * actually no more fired if no signals are connected.
2443  */
2444
2445 void
2446 gst_pad_remove_event_probe (GstPad * pad, GCallback handler, gpointer data)
2447 {
2448   guint count;
2449
2450   g_return_if_fail (GST_IS_PAD (pad));
2451   g_return_if_fail (handler != NULL);
2452
2453   GST_LOCK (pad);
2454   count = g_signal_handlers_disconnect_by_func (pad, handler, data);
2455   GST_PAD_DO_EVENT_SIGNALS (pad) -= count;
2456   GST_DEBUG ("removing %d event probes from pad %s:%s, now %d event probes",
2457       count, GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_EVENT_SIGNALS (pad));
2458   GST_UNLOCK (pad);
2459 }
2460
2461 /**
2462  * gst_pad_remove_buffer_probe:
2463  * @pad: pad to remove the buffer probe handler from
2464  * @handler: function that was assigned to the signal
2465  * @data: data that was assigned to the signal handler
2466  *
2467  * Unconnects a signal handler to the pad's have-data signal, and decreases
2468  * the emit_buffer_signals number on the pads so that this signal is
2469  * actually no more fired if no signals are connected.
2470  */
2471
2472 void
2473 gst_pad_remove_buffer_probe (GstPad * pad, GCallback handler, gpointer data)
2474 {
2475   guint count;
2476
2477   g_return_if_fail (GST_IS_PAD (pad));
2478   g_return_if_fail (handler != NULL);
2479
2480   GST_LOCK (pad);
2481   count = g_signal_handlers_disconnect_by_func (pad, handler, data);
2482   GST_PAD_DO_BUFFER_SIGNALS (pad) -= count;
2483   GST_DEBUG ("removing %d buffer probes from pad %s:%s, now %d buffer probes",
2484       count, GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_BUFFER_SIGNALS (pad));
2485   GST_UNLOCK (pad);
2486 }
2487
2488 /**
2489  * gst_element_found_tags_for_pad:
2490  * @element: element for which to post taglist to bus.
2491  * @pad: pad on which to push tag-event.
2492  * @list: the taglist to post on the bus and create event from.
2493  *
2494  * Posts a message to the bus that new tags were found and pushes the
2495  * tags as event. Takes ownership of the taglist.
2496  */
2497 void
2498 gst_element_found_tags_for_pad (GstElement * element,
2499     GstPad * pad, GstTagList * list)
2500 {
2501   g_return_if_fail (element != NULL);
2502   g_return_if_fail (pad != NULL);
2503   g_return_if_fail (list != NULL);
2504
2505   gst_pad_push_event (pad, gst_event_new_tag (gst_tag_list_copy (list)));
2506   gst_element_post_message (element,
2507       gst_message_new_tag (GST_OBJECT (element), list));
2508 }
2509
2510 static void
2511 push_and_ref (GstPad * pad, GstEvent * event)
2512 {
2513   gst_pad_push_event (pad, gst_event_ref (event));
2514 }
2515
2516 /**
2517  * gst_element_found_tags:
2518  * @element: element for which we found the tags.
2519  * @list: list of tags.
2520  *
2521  * Posts a message to the bus that new tags were found, and pushes an event
2522  * to all sourcepads. Takes ownership of the taglist.
2523  */
2524 void
2525 gst_element_found_tags (GstElement * element, GstTagList * list)
2526 {
2527   GstIterator *iter;
2528   GstEvent *event;
2529
2530   g_return_if_fail (element != NULL);
2531   g_return_if_fail (list != NULL);
2532
2533   iter = gst_element_iterate_src_pads (element);
2534   event = gst_event_new_tag (gst_tag_list_copy (list));
2535   gst_iterator_foreach (iter, (GFunc) push_and_ref, event);
2536   gst_iterator_free (iter);
2537   gst_event_unref (event);
2538
2539   gst_element_post_message (element,
2540       gst_message_new_tag (GST_OBJECT (element), list));
2541 }