Change GST_GET_TIMESTAMP into gst_util_get_timestamp and replace all uses as we don...
[platform/upstream/gstreamer.git] / gst / gstutils.c
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *                    2002 Thomas Vander Stichele <thomas@apestaart.org>
5  *
6  * gstutils.c: Utility functions: gtk_get_property stuff, etc.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23
24 /**
25  * SECTION:gstutils
26  * @short_description: Various utility functions
27  *
28  * When defining own plugins, use the GST_BOILERPLATE ease gobject creation.
29  */
30
31 #include "gst_private.h"
32 #include <stdio.h>
33 #include <string.h>
34
35 #include "gstghostpad.h"
36 #include "gstutils.h"
37 #include "gsterror.h"
38 #include "gstinfo.h"
39 #include "gstparse.h"
40 #include "gst-i18n-lib.h"
41
42
43 /**
44  * gst_util_dump_mem:
45  * @mem: a pointer to the memory to dump
46  * @size: the size of the memory block to dump
47  *
48  * Dumps the memory block into a hex representation. Useful for debugging.
49  */
50 void
51 gst_util_dump_mem (const guchar * mem, guint size)
52 {
53   guint i, j;
54   GString *string = g_string_sized_new (50);
55   GString *chars = g_string_sized_new (18);
56
57   i = j = 0;
58   while (i < size) {
59     if (g_ascii_isprint (mem[i]))
60       g_string_append_printf (chars, "%c", mem[i]);
61     else
62       g_string_append_printf (chars, ".");
63
64     g_string_append_printf (string, "%02x ", mem[i]);
65
66     j++;
67     i++;
68
69     if (j == 16 || i == size) {
70       g_print ("%08x (%p): %-48.48s %-16.16s\n", i - j, mem + i - j,
71           string->str, chars->str);
72       g_string_set_size (string, 0);
73       g_string_set_size (chars, 0);
74       j = 0;
75     }
76   }
77   g_string_free (string, TRUE);
78   g_string_free (chars, TRUE);
79 }
80
81
82 /**
83  * gst_util_set_value_from_string:
84  * @value: the value to set
85  * @value_str: the string to get the value from
86  *
87  * Converts the string to the type of the value and
88  * sets the value with it.
89  */
90 void
91 gst_util_set_value_from_string (GValue * value, const gchar * value_str)
92 {
93   gint sscanf_ret;
94
95   g_return_if_fail (value != NULL);
96   g_return_if_fail (value_str != NULL);
97
98   GST_CAT_DEBUG (GST_CAT_PARAMS, "parsing '%s' to type %s", value_str,
99       g_type_name (G_VALUE_TYPE (value)));
100
101   switch (G_VALUE_TYPE (value)) {
102     case G_TYPE_STRING:
103       g_value_set_string (value, value_str);
104       break;
105     case G_TYPE_ENUM:
106     case G_TYPE_INT:{
107       gint i;
108
109       sscanf_ret = sscanf (value_str, "%d", &i);
110       g_return_if_fail (sscanf_ret == 1);
111       g_value_set_int (value, i);
112       break;
113     }
114     case G_TYPE_UINT:{
115       guint i;
116
117       sscanf_ret = sscanf (value_str, "%u", &i);
118       g_return_if_fail (sscanf_ret == 1);
119       g_value_set_uint (value, i);
120       break;
121     }
122     case G_TYPE_LONG:{
123       glong i;
124
125       sscanf_ret = sscanf (value_str, "%ld", &i);
126       g_return_if_fail (sscanf_ret == 1);
127       g_value_set_long (value, i);
128       break;
129     }
130     case G_TYPE_ULONG:{
131       gulong i;
132
133       sscanf_ret = sscanf (value_str, "%lu", &i);
134       g_return_if_fail (sscanf_ret == 1);
135       g_value_set_ulong (value, i);
136       break;
137     }
138     case G_TYPE_BOOLEAN:{
139       gboolean i = FALSE;
140
141       if (!g_ascii_strncasecmp ("true", value_str, 4))
142         i = TRUE;
143       g_value_set_boolean (value, i);
144       break;
145     }
146     case G_TYPE_CHAR:{
147       gchar i;
148
149       sscanf_ret = sscanf (value_str, "%c", &i);
150       g_return_if_fail (sscanf_ret == 1);
151       g_value_set_char (value, i);
152       break;
153     }
154     case G_TYPE_UCHAR:{
155       guchar i;
156
157       sscanf_ret = sscanf (value_str, "%c", &i);
158       g_return_if_fail (sscanf_ret == 1);
159       g_value_set_uchar (value, i);
160       break;
161     }
162     case G_TYPE_FLOAT:{
163       gfloat i;
164
165       sscanf_ret = sscanf (value_str, "%f", &i);
166       g_return_if_fail (sscanf_ret == 1);
167       g_value_set_float (value, i);
168       break;
169     }
170     case G_TYPE_DOUBLE:{
171       gfloat i;
172
173       sscanf_ret = sscanf (value_str, "%g", &i);
174       g_return_if_fail (sscanf_ret == 1);
175       g_value_set_double (value, (gdouble) i);
176       break;
177     }
178     default:
179       break;
180   }
181 }
182
183 /**
184  * gst_util_set_object_arg:
185  * @object: the object to set the argument of
186  * @name: the name of the argument to set
187  * @value: the string value to set
188  *
189  * Convertes the string value to the type of the objects argument and
190  * sets the argument with it.
191  */
192 void
193 gst_util_set_object_arg (GObject * object, const gchar * name,
194     const gchar * value)
195 {
196   gboolean sscanf_ret;
197
198   if (name && value) {
199     GParamSpec *paramspec;
200
201     paramspec =
202         g_object_class_find_property (G_OBJECT_GET_CLASS (object), name);
203
204     if (!paramspec) {
205       return;
206     }
207
208     GST_DEBUG ("paramspec->flags is %d, paramspec->value_type is %d",
209         paramspec->flags, (gint) paramspec->value_type);
210
211     if (paramspec->flags & G_PARAM_WRITABLE) {
212       switch (paramspec->value_type) {
213         case G_TYPE_STRING:
214           g_object_set (G_OBJECT (object), name, value, NULL);
215           break;
216         case G_TYPE_ENUM:
217         case G_TYPE_INT:{
218           gint i;
219
220           sscanf_ret = sscanf (value, "%d", &i);
221           g_return_if_fail (sscanf_ret == 1);
222           g_object_set (G_OBJECT (object), name, i, NULL);
223           break;
224         }
225         case G_TYPE_UINT:{
226           guint i;
227
228           sscanf_ret = sscanf (value, "%u", &i);
229           g_return_if_fail (sscanf_ret == 1);
230           g_object_set (G_OBJECT (object), name, i, NULL);
231           break;
232         }
233         case G_TYPE_LONG:{
234           glong i;
235
236           sscanf_ret = sscanf (value, "%ld", &i);
237           g_return_if_fail (sscanf_ret == 1);
238           g_object_set (G_OBJECT (object), name, i, NULL);
239           break;
240         }
241         case G_TYPE_ULONG:{
242           gulong i;
243
244           sscanf_ret = sscanf (value, "%lu", &i);
245           g_return_if_fail (sscanf_ret == 1);
246           g_object_set (G_OBJECT (object), name, i, NULL);
247           break;
248         }
249         case G_TYPE_BOOLEAN:{
250           gboolean i = FALSE;
251
252           if (!g_ascii_strncasecmp ("true", value, 4))
253             i = TRUE;
254           g_object_set (G_OBJECT (object), name, i, NULL);
255           break;
256         }
257         case G_TYPE_CHAR:{
258           gchar i;
259
260           sscanf_ret = sscanf (value, "%c", &i);
261           g_return_if_fail (sscanf_ret == 1);
262           g_object_set (G_OBJECT (object), name, i, NULL);
263           break;
264         }
265         case G_TYPE_UCHAR:{
266           guchar i;
267
268           sscanf_ret = sscanf (value, "%c", &i);
269           g_return_if_fail (sscanf_ret == 1);
270           g_object_set (G_OBJECT (object), name, i, NULL);
271           break;
272         }
273         case G_TYPE_FLOAT:{
274           gfloat i;
275
276           sscanf_ret = sscanf (value, "%f", &i);
277           g_return_if_fail (sscanf_ret == 1);
278           g_object_set (G_OBJECT (object), name, i, NULL);
279           break;
280         }
281         case G_TYPE_DOUBLE:{
282           gfloat i;
283
284           sscanf_ret = sscanf (value, "%g", &i);
285           g_return_if_fail (sscanf_ret == 1);
286           g_object_set (G_OBJECT (object), name, (gdouble) i, NULL);
287           break;
288         }
289         default:
290           if (G_IS_PARAM_SPEC_ENUM (paramspec)) {
291             gint i;
292
293             sscanf_ret = sscanf (value, "%d", &i);
294             g_return_if_fail (sscanf_ret == 1);
295             g_object_set (G_OBJECT (object), name, i, NULL);
296           }
297           break;
298       }
299     }
300   }
301 }
302
303 /* work around error C2520: conversion from unsigned __int64 to double
304  * not implemented, use signed __int64
305  *
306  * These are implemented as functions because on some platforms a 64bit int to
307  * double conversion is not defined/implemented.
308  */
309
310 gdouble
311 gst_util_guint64_to_gdouble (guint64 value)
312 {
313   if (value & G_GINT64_CONSTANT (0x8000000000000000))
314     return (gdouble) ((gint64) value) + (gdouble) 18446744073709551616.;
315   else
316     return (gdouble) ((gint64) value);
317 }
318
319 guint64
320 gst_util_gdouble_to_guint64 (gdouble value)
321 {
322   if (value < (gdouble) 9223372036854775808.)   /* 1 << 63 */
323     return ((guint64) ((gint64) value));
324
325   value -= (gdouble) 18446744073709551616.;
326   return ((guint64) ((gint64) value));
327 }
328
329 /* convenience struct for getting high and low uint32 parts of
330  * a guint64 */
331 typedef union
332 {
333   guint64 ll;
334   struct
335   {
336 #if G_BYTE_ORDER == G_BIG_ENDIAN
337     guint32 high, low;
338 #else
339     guint32 low, high;
340 #endif
341   } l;
342 } GstUInt64;
343
344 /* based on Hacker's Delight p152 */
345 static guint64
346 gst_util_div128_64 (GstUInt64 c1, GstUInt64 c0, guint64 denom)
347 {
348   GstUInt64 q1, q0, rhat;
349   GstUInt64 v, cmp1, cmp2;
350   guint s;
351
352   v.ll = denom;
353
354   /* count number of leading zeroes, we know they must be in the high
355    * part of denom since denom > G_MAXUINT32. */
356   s = v.l.high | (v.l.high >> 1);
357   s |= (s >> 2);
358   s |= (s >> 4);
359   s |= (s >> 8);
360   s = ~(s | (s >> 16));
361   s = s - ((s >> 1) & 0x55555555);
362   s = (s & 0x33333333) + ((s >> 2) & 0x33333333);
363   s = (s + (s >> 4)) & 0x0f0f0f0f;
364   s += (s >> 8);
365   s = (s + (s >> 16)) & 0x3f;
366
367   if (s > 0) {
368     /* normalize divisor and dividend */
369     v.ll <<= s;
370     c1.ll = (c1.ll << s) | (c0.l.high >> (32 - s));
371     c0.ll <<= s;
372   }
373
374   q1.ll = c1.ll / v.l.high;
375   rhat.ll = c1.ll - q1.ll * v.l.high;
376
377   cmp1.l.high = rhat.l.low;
378   cmp1.l.low = c0.l.high;
379   cmp2.ll = q1.ll * v.l.low;
380
381   while (q1.l.high || cmp2.ll > cmp1.ll) {
382     q1.ll--;
383     rhat.ll += v.l.high;
384     if (rhat.l.high)
385       break;
386     cmp1.l.high = rhat.l.low;
387     cmp2.ll -= v.l.low;
388   }
389   c1.l.high = c1.l.low;
390   c1.l.low = c0.l.high;
391   c1.ll -= q1.ll * v.ll;
392   q0.ll = c1.ll / v.l.high;
393   rhat.ll = c1.ll - q0.ll * v.l.high;
394
395   cmp1.l.high = rhat.l.low;
396   cmp1.l.low = c0.l.low;
397   cmp2.ll = q0.ll * v.l.low;
398
399   while (q0.l.high || cmp2.ll > cmp1.ll) {
400     q0.ll--;
401     rhat.ll += v.l.high;
402     if (rhat.l.high)
403       break;
404     cmp1.l.high = rhat.l.low;
405     cmp2.ll -= v.l.low;
406   }
407   q0.l.high += q1.l.low;
408
409   return q0.ll;
410 }
411
412 static guint64
413 gst_util_uint64_scale_int64 (guint64 val, guint64 num, guint64 denom)
414 {
415   GstUInt64 a0, a1, b0, b1, c0, ct, c1, result;
416   GstUInt64 v, n;
417
418   /* prepare input */
419   v.ll = val;
420   n.ll = num;
421
422   /* do 128 bits multiply
423    *                   nh   nl
424    *                *  vh   vl
425    *                ----------
426    * a0 =              vl * nl
427    * a1 =         vl * nh
428    * b0 =         vh * nl
429    * b1 =  + vh * nh
430    *       -------------------
431    * c1,c0
432    */
433   a0.ll = (guint64) v.l.low * n.l.low;
434   a1.ll = (guint64) v.l.low * n.l.high;
435   b0.ll = (guint64) v.l.high * n.l.low;
436   b1.ll = (guint64) v.l.high * n.l.high;
437
438   /* and sum together with carry into 128 bits c1, c0 */
439   c0.l.low = a0.l.low;
440   ct.ll = (guint64) a0.l.high + a1.l.low + b0.l.low;
441   c0.l.high = ct.l.low;
442   c1.ll = (guint64) a1.l.high + b0.l.high + ct.l.high + b1.ll;
443
444   /* if high bits bigger than denom, we overflow */
445   if (c1.ll >= denom)
446     goto overflow;
447
448   /* shortcut for division by 1, c1.ll should be 0 because of the
449    * overflow check above. */
450   if (denom == 1)
451     return c0.ll;
452
453   /* and 128/64 bits division, result fits 64 bits */
454   if (denom <= G_MAXUINT32) {
455     guint32 den = (guint32) denom;
456
457     /* easy case, (c1,c0)128/(den)32 division */
458     c1.l.high %= den;
459     c1.l.high = c1.ll % den;
460     c1.l.low = c0.l.high;
461     c0.l.high = c1.ll % den;
462     result.l.high = c1.ll / den;
463     result.l.low = c0.ll / den;
464   } else {
465     result.ll = gst_util_div128_64 (c1, c0, denom);
466   }
467   return result.ll;
468
469 overflow:
470   {
471     return G_MAXUINT64;
472   }
473 }
474
475 /**
476  * gst_util_uint64_scale:
477  * @val: the number to scale
478  * @num: the numerator of the scale ratio
479  * @denom: the denominator of the scale ratio
480  *
481  * Scale @val by @num / @denom, trying to avoid overflows.
482  *
483  * This function can potentially be very slow if denom > G_MAXUINT32.
484  *
485  * Returns: @val * @num / @denom, trying to avoid overflows.
486  * In the case of an overflow, this function returns G_MAXUINT64.
487  */
488 guint64
489 gst_util_uint64_scale (guint64 val, guint64 num, guint64 denom)
490 {
491   g_return_val_if_fail (denom != 0, G_MAXUINT64);
492
493   if (num == 0)
494     return 0;
495
496   if (num == 1 && denom == 1)
497     return val;
498
499   /* if the denom is high, we need to do a 64 muldiv */
500   if (denom > G_MAXINT32)
501     goto do_int64;
502
503   /* if num and denom are low we can do a 32 bit muldiv */
504   if (num <= G_MAXINT32)
505     goto do_int32;
506
507   /* val and num are high, we need 64 muldiv */
508   if (val > G_MAXINT32)
509     goto do_int64;
510
511   /* val is low and num is high, we can swap them and do 32 muldiv */
512   return gst_util_uint64_scale_int (num, (gint) val, (gint) denom);
513
514 do_int32:
515   return gst_util_uint64_scale_int (val, (gint) num, (gint) denom);
516
517 do_int64:
518   /* to the more heavy implementations... */
519   return gst_util_uint64_scale_int64 (val, num, denom);
520 }
521
522 /**
523  * gst_util_uint64_scale_int:
524  * @val: guint64 (such as a #GstClockTime) to scale.
525  * @num: numerator of the scale factor.
526  * @denom: denominator of the scale factor.
527  *
528  * Scale a guint64 by a factor expressed as a fraction (num/denom), avoiding
529  * overflows and loss of precision.
530  *
531  * @num and @denom must be positive integers. @denom cannot be 0.
532  *
533  * Returns: @val * @num / @denom, avoiding overflow and loss of precision.
534  * In the case of an overflow, this function returns G_MAXUINT64.
535  */
536 guint64
537 gst_util_uint64_scale_int (guint64 val, gint num, gint denom)
538 {
539   GstUInt64 result;
540   GstUInt64 low, high;
541
542   g_return_val_if_fail (denom > 0, G_MAXUINT64);
543   g_return_val_if_fail (num >= 0, G_MAXUINT64);
544
545   if (num == 0)
546     return 0;
547
548   if (num == 1 && denom == 1)
549     return val;
550
551   if (val <= G_MAXUINT32)
552     /* simple case */
553     return val * num / denom;
554
555   /* do 96 bits mult/div */
556   low.ll = val;
557   result.ll = ((guint64) low.l.low) * num;
558   high.ll = ((guint64) low.l.high) * num + (result.l.high);
559
560   low.ll = high.ll / denom;
561   result.l.high = high.ll % denom;
562   result.ll /= denom;
563
564   /* avoid overflow */
565   if (low.ll + result.l.high > G_MAXUINT32)
566     goto overflow;
567
568   result.l.high += low.l.low;
569
570   return result.ll;
571
572 overflow:
573   {
574     return G_MAXUINT64;
575   }
576 }
577
578 /* -----------------------------------------------------
579  *
580  *  The following code will be moved out of the main
581  * gstreamer library someday.
582  */
583
584 #include "gstpad.h"
585
586 static void
587 string_append_indent (GString * str, gint count)
588 {
589   gint xx;
590
591   for (xx = 0; xx < count; xx++)
592     g_string_append_c (str, ' ');
593 }
594
595 /**
596  * gst_print_pad_caps:
597  * @buf: the buffer to print the caps in
598  * @indent: initial indentation
599  * @pad: the pad to print the caps from
600  *
601  * Write the pad capabilities in a human readable format into
602  * the given GString.
603  */
604 void
605 gst_print_pad_caps (GString * buf, gint indent, GstPad * pad)
606 {
607   GstCaps *caps;
608
609   caps = pad->caps;
610
611   if (!caps) {
612     string_append_indent (buf, indent);
613     g_string_printf (buf, "%s:%s has no capabilities",
614         GST_DEBUG_PAD_NAME (pad));
615   } else {
616     char *s;
617
618     s = gst_caps_to_string (caps);
619     g_string_append (buf, s);
620     g_free (s);
621   }
622 }
623
624 /**
625  * gst_print_element_args:
626  * @buf: the buffer to print the args in
627  * @indent: initial indentation
628  * @element: the element to print the args of
629  *
630  * Print the element argument in a human readable format in the given
631  * GString.
632  */
633 void
634 gst_print_element_args (GString * buf, gint indent, GstElement * element)
635 {
636   guint width;
637   GValue value = { 0, };        /* the important thing is that value.type = 0 */
638   gchar *str = NULL;
639   GParamSpec *spec, **specs, **walk;
640
641   specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (element), NULL);
642
643   width = 0;
644   for (walk = specs; *walk; walk++) {
645     spec = *walk;
646     if (width < strlen (spec->name))
647       width = strlen (spec->name);
648   }
649
650   for (walk = specs; *walk; walk++) {
651     spec = *walk;
652
653     if (spec->flags & G_PARAM_READABLE) {
654       g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (spec));
655       g_object_get_property (G_OBJECT (element), spec->name, &value);
656       str = g_strdup_value_contents (&value);
657       g_value_unset (&value);
658     } else {
659       str = g_strdup ("Parameter not readable.");
660     }
661
662     string_append_indent (buf, indent);
663     g_string_append (buf, spec->name);
664     string_append_indent (buf, 2 + width - strlen (spec->name));
665     g_string_append (buf, str);
666     g_string_append_c (buf, '\n');
667
668     g_free (str);
669   }
670
671   g_free (specs);
672 }
673
674 /**
675  * gst_element_create_all_pads:
676  * @element: a #GstElement to create pads for
677  *
678  * Creates a pad for each pad template that is always available.
679  * This function is only useful during object intialization of
680  * subclasses of #GstElement.
681  */
682 void
683 gst_element_create_all_pads (GstElement * element)
684 {
685   GList *padlist;
686
687   /* FIXME: lock element */
688
689   padlist =
690       gst_element_class_get_pad_template_list (GST_ELEMENT_CLASS
691       (G_OBJECT_GET_CLASS (element)));
692
693   while (padlist) {
694     GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
695
696     if (padtempl->presence == GST_PAD_ALWAYS) {
697       GstPad *pad;
698
699       pad = gst_pad_new_from_template (padtempl, padtempl->name_template);
700
701       gst_element_add_pad (element, pad);
702     }
703     padlist = padlist->next;
704   }
705 }
706
707 /**
708  * gst_element_get_compatible_pad_template:
709  * @element: a #GstElement to get a compatible pad template for.
710  * @compattempl: the #GstPadTemplate to find a compatible template for.
711  *
712  * Retrieves a pad template from @element that is compatible with @compattempl.
713  * Pads from compatible templates can be linked together.
714  *
715  * Returns: a compatible #GstPadTemplate, or NULL if none was found. No
716  * unreferencing is necessary.
717  */
718 GstPadTemplate *
719 gst_element_get_compatible_pad_template (GstElement * element,
720     GstPadTemplate * compattempl)
721 {
722   GstPadTemplate *newtempl = NULL;
723   GList *padlist;
724   GstElementClass *class;
725
726   g_return_val_if_fail (element != NULL, NULL);
727   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
728   g_return_val_if_fail (compattempl != NULL, NULL);
729
730   class = GST_ELEMENT_GET_CLASS (element);
731
732   padlist = gst_element_class_get_pad_template_list (class);
733
734   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
735       "Looking for a suitable pad template in %s out of %d templates...",
736       GST_ELEMENT_NAME (element), g_list_length (padlist));
737
738   while (padlist) {
739     GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
740     GstCaps *intersection;
741
742     /* Ignore name
743      * Ignore presence
744      * Check direction (must be opposite)
745      * Check caps
746      */
747     GST_CAT_LOG (GST_CAT_CAPS,
748         "checking pad template %s", padtempl->name_template);
749     if (padtempl->direction != compattempl->direction) {
750       GST_CAT_DEBUG (GST_CAT_CAPS,
751           "compatible direction: found %s pad template \"%s\"",
752           padtempl->direction == GST_PAD_SRC ? "src" : "sink",
753           padtempl->name_template);
754
755       GST_CAT_DEBUG (GST_CAT_CAPS,
756           "intersecting %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (compattempl));
757       GST_CAT_DEBUG (GST_CAT_CAPS,
758           "..and %" GST_PTR_FORMAT, GST_PAD_TEMPLATE_CAPS (padtempl));
759
760       intersection = gst_caps_intersect (GST_PAD_TEMPLATE_CAPS (compattempl),
761           GST_PAD_TEMPLATE_CAPS (padtempl));
762
763       GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible %" GST_PTR_FORMAT,
764           (intersection ? "" : "not "), intersection);
765
766       if (!gst_caps_is_empty (intersection))
767         newtempl = padtempl;
768       gst_caps_unref (intersection);
769       if (newtempl)
770         break;
771     }
772
773     padlist = g_list_next (padlist);
774   }
775   if (newtempl)
776     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
777         "Returning new pad template %p", newtempl);
778   else
779     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "No compatible pad template found");
780
781   return newtempl;
782 }
783
784 static GstPad *
785 gst_element_request_pad (GstElement * element, GstPadTemplate * templ,
786     const gchar * name)
787 {
788   GstPad *newpad = NULL;
789   GstElementClass *oclass;
790
791   oclass = GST_ELEMENT_GET_CLASS (element);
792
793   if (oclass->request_new_pad)
794     newpad = (oclass->request_new_pad) (element, templ, name);
795
796   if (newpad)
797     gst_object_ref (newpad);
798
799   return newpad;
800 }
801
802
803
804 /**
805  * gst_element_get_pad_from_template:
806  * @element: a #GstElement.
807  * @templ: a #GstPadTemplate belonging to @element.
808  *
809  * Gets a pad from @element described by @templ. If the presence of @templ is
810  * #GST_PAD_REQUEST, requests a new pad. Can return %NULL for #GST_PAD_SOMETIMES
811  * templates.
812  *
813  * Returns: the #GstPad, or NULL if one could not be found or created.
814  */
815 static GstPad *
816 gst_element_get_pad_from_template (GstElement * element, GstPadTemplate * templ)
817 {
818   GstPad *ret = NULL;
819   GstPadPresence presence;
820
821   /* If this function is ever exported, we need check the validity of `element'
822    * and `templ', and to make sure the template actually belongs to the
823    * element. */
824
825   presence = GST_PAD_TEMPLATE_PRESENCE (templ);
826
827   switch (presence) {
828     case GST_PAD_ALWAYS:
829     case GST_PAD_SOMETIMES:
830       ret = gst_element_get_static_pad (element, templ->name_template);
831       if (!ret && presence == GST_PAD_ALWAYS)
832         g_warning
833             ("Element %s has an ALWAYS template %s, but no pad of the same name",
834             GST_OBJECT_NAME (element), templ->name_template);
835       break;
836
837     case GST_PAD_REQUEST:
838       ret = gst_element_request_pad (element, templ, NULL);
839       break;
840   }
841
842   return ret;
843 }
844
845 /**
846  * gst_element_request_compatible_pad:
847  * @element: a #GstElement.
848  * @templ: the #GstPadTemplate to which the new pad should be able to link.
849  *
850  * Requests a pad from @element. The returned pad should be unlinked and
851  * compatible with @templ. Might return an existing pad, or request a new one.
852  *
853  * Returns: a #GstPad, or %NULL if one could not be found or created.
854  */
855 GstPad *
856 gst_element_request_compatible_pad (GstElement * element,
857     GstPadTemplate * templ)
858 {
859   GstPadTemplate *templ_new;
860   GstPad *pad = NULL;
861
862   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
863   g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
864
865   /* FIXME: should really loop through the templates, testing each for
866    *      compatibility and pad availability. */
867   templ_new = gst_element_get_compatible_pad_template (element, templ);
868   if (templ_new)
869     pad = gst_element_get_pad_from_template (element, templ_new);
870
871   /* This can happen for non-request pads. No need to unref. */
872   if (pad && GST_PAD_PEER (pad))
873     pad = NULL;
874
875   return pad;
876 }
877
878 /**
879  * gst_element_get_compatible_pad:
880  * @element: a #GstElement in which the pad should be found.
881  * @pad: the #GstPad to find a compatible one for.
882  * @caps: the #GstCaps to use as a filter.
883  *
884  * Looks for an unlinked pad to which the given pad can link. It is not
885  * guaranteed that linking the pads will work, though it should work in most
886  * cases.
887  *
888  * Returns: the #GstPad to which a link can be made, or %NULL if one cannot be
889  * found. gst_object_unref() after usage.
890  */
891 GstPad *
892 gst_element_get_compatible_pad (GstElement * element, GstPad * pad,
893     const GstCaps * caps)
894 {
895   GstIterator *pads;
896   GstPadTemplate *templ;
897   GstCaps *templcaps;
898   GstPad *foundpad = NULL;
899   gboolean done;
900
901   /* FIXME check for caps compatibility */
902
903   g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
904   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
905
906   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
907       "finding pad in %s compatible with %s:%s",
908       GST_ELEMENT_NAME (element), GST_DEBUG_PAD_NAME (pad));
909
910   g_return_val_if_fail (GST_PAD_PEER (pad) == NULL, NULL);
911
912   done = FALSE;
913   /* try to get an existing unlinked pad */
914   pads = gst_element_iterate_pads (element);
915   while (!done) {
916     gpointer padptr;
917
918     switch (gst_iterator_next (pads, &padptr)) {
919       case GST_ITERATOR_OK:
920       {
921         GstPad *peer;
922         GstPad *current;
923
924         current = GST_PAD (padptr);
925
926         GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
927             GST_DEBUG_PAD_NAME (current));
928
929         peer = gst_pad_get_peer (current);
930
931         if (peer == NULL && gst_pad_can_link (pad, current)) {
932
933           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
934               "found existing unlinked pad %s:%s",
935               GST_DEBUG_PAD_NAME (current));
936
937           gst_iterator_free (pads);
938
939           return current;
940         } else {
941           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unreffing pads");
942
943           gst_object_unref (current);
944           if (peer)
945             gst_object_unref (peer);
946         }
947         break;
948       }
949       case GST_ITERATOR_DONE:
950         done = TRUE;
951         break;
952       case GST_ITERATOR_RESYNC:
953         gst_iterator_resync (pads);
954         break;
955       case GST_ITERATOR_ERROR:
956         g_assert_not_reached ();
957         break;
958     }
959   }
960   gst_iterator_free (pads);
961
962   /* try to create a new one */
963   /* requesting is a little crazy, we need a template. Let's create one */
964   templcaps = gst_pad_get_caps (pad);
965
966   templ = gst_pad_template_new ((gchar *) GST_PAD_NAME (pad),
967       GST_PAD_DIRECTION (pad), GST_PAD_ALWAYS, templcaps);
968   foundpad = gst_element_request_compatible_pad (element, templ);
969   gst_object_unref (templ);
970
971   if (foundpad) {
972     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
973         "found existing request pad %s:%s", GST_DEBUG_PAD_NAME (foundpad));
974     return foundpad;
975   }
976
977   GST_CAT_INFO_OBJECT (GST_CAT_ELEMENT_PADS, element,
978       "Could not find a compatible pad to link to %s:%s",
979       GST_DEBUG_PAD_NAME (pad));
980   return NULL;
981 }
982
983 /**
984  * gst_element_state_get_name:
985  * @state: a #GstState to get the name of.
986  *
987  * Gets a string representing the given state.
988  *
989  * Returns: a string with the name of the state.
990  */
991 G_CONST_RETURN gchar *
992 gst_element_state_get_name (GstState state)
993 {
994   switch (state) {
995 #ifdef GST_DEBUG_COLOR
996     case GST_STATE_VOID_PENDING:
997       return "VOID_PENDING";
998     case GST_STATE_NULL:
999       return "\033[01;34mNULL\033[00m";
1000     case GST_STATE_READY:
1001       return "\033[01;31mREADY\033[00m";
1002     case GST_STATE_PLAYING:
1003       return "\033[01;32mPLAYING\033[00m";
1004     case GST_STATE_PAUSED:
1005       return "\033[01;33mPAUSED\033[00m";
1006     default:
1007       /* This is a memory leak */
1008       return g_strdup_printf ("\033[01;35;41mUNKNOWN!\033[00m(%d)", state);
1009 #else
1010     case GST_STATE_VOID_PENDING:
1011       return "VOID_PENDING";
1012     case GST_STATE_NULL:
1013       return "NULL";
1014     case GST_STATE_READY:
1015       return "READY";
1016     case GST_STATE_PLAYING:
1017       return "PLAYING";
1018     case GST_STATE_PAUSED:
1019       return "PAUSED";
1020     default:
1021       /* This is a memory leak */
1022       return g_strdup_printf ("UNKNOWN!(%d)", state);
1023 #endif
1024   }
1025 }
1026
1027 /**
1028  * gst_element_state_change_return_get_name:
1029  * @state_ret: a #GstStateChangeReturn to get the name of.
1030  *
1031  * Gets a string representing the given state change result.
1032  *
1033  * Returns: a string with the name of the state change result.
1034  */
1035 G_CONST_RETURN gchar *
1036 gst_element_state_change_return_get_name (GstStateChangeReturn state_ret)
1037 {
1038   switch (state_ret) {
1039 #ifdef GST_DEBUG_COLOR
1040     case GST_STATE_CHANGE_FAILURE:
1041       return "\033[01;31mFAILURE\033[00m";
1042     case GST_STATE_CHANGE_SUCCESS:
1043       return "\033[01;32mSUCCESS\033[00m";
1044     case GST_STATE_CHANGE_ASYNC:
1045       return "\033[01;33mASYNC\033[00m";
1046     case GST_STATE_CHANGE_NO_PREROLL:
1047       return "\033[01;34mNO_PREROLL\033[00m";
1048     default:
1049       /* This is a memory leak */
1050       return g_strdup_printf ("\033[01;35;41mUNKNOWN!\033[00m(%d)", state_ret);
1051 #else
1052     case GST_STATE_CHANGE_FAILURE:
1053       return "FAILURE";
1054     case GST_STATE_CHANGE_SUCCESS:
1055       return "SUCCESS";
1056     case GST_STATE_CHANGE_ASYNC:
1057       return "ASYNC";
1058     case GST_STATE_CHANGE_NO_PREROLL:
1059       return "NO PREROLL";
1060     default:
1061       /* This is a memory leak */
1062       return g_strdup_printf ("UNKNOWN!(%d)", state_ret);
1063 #endif
1064   }
1065 }
1066
1067
1068 /**
1069  * gst_element_factory_can_src_caps :
1070  * @factory: factory to query
1071  * @caps: the caps to check
1072  *
1073  * Checks if the factory can source the given capability.
1074  *
1075  * Returns: true if it can src the capabilities
1076  */
1077 gboolean
1078 gst_element_factory_can_src_caps (GstElementFactory * factory,
1079     const GstCaps * caps)
1080 {
1081   GList *templates;
1082
1083   g_return_val_if_fail (factory != NULL, FALSE);
1084   g_return_val_if_fail (caps != NULL, FALSE);
1085
1086   templates = factory->staticpadtemplates;
1087
1088   while (templates) {
1089     GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1090
1091     if (template->direction == GST_PAD_SRC) {
1092       if (gst_caps_is_always_compatible (gst_static_caps_get (&template->
1093                   static_caps), caps))
1094         return TRUE;
1095     }
1096     templates = g_list_next (templates);
1097   }
1098
1099   return FALSE;
1100 }
1101
1102 /**
1103  * gst_element_factory_can_sink_caps :
1104  * @factory: factory to query
1105  * @caps: the caps to check
1106  *
1107  * Checks if the factory can sink the given capability.
1108  *
1109  * Returns: true if it can sink the capabilities
1110  */
1111 gboolean
1112 gst_element_factory_can_sink_caps (GstElementFactory * factory,
1113     const GstCaps * caps)
1114 {
1115   GList *templates;
1116
1117   g_return_val_if_fail (factory != NULL, FALSE);
1118   g_return_val_if_fail (caps != NULL, FALSE);
1119
1120   templates = factory->staticpadtemplates;
1121
1122   while (templates) {
1123     GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1124
1125     if (template->direction == GST_PAD_SINK) {
1126       if (gst_caps_is_always_compatible (caps,
1127               gst_static_caps_get (&template->static_caps)))
1128         return TRUE;
1129     }
1130     templates = g_list_next (templates);
1131   }
1132
1133   return FALSE;
1134 }
1135
1136
1137 /* if return val is true, *direct_child is a caller-owned ref on the direct
1138  * child of ancestor that is part of object's ancestry */
1139 static gboolean
1140 object_has_ancestor (GstObject * object, GstObject * ancestor,
1141     GstObject ** direct_child)
1142 {
1143   GstObject *child, *parent;
1144
1145   if (direct_child)
1146     *direct_child = NULL;
1147
1148   child = gst_object_ref (object);
1149   parent = gst_object_get_parent (object);
1150
1151   while (parent) {
1152     if (ancestor == parent) {
1153       if (direct_child)
1154         *direct_child = child;
1155       else
1156         gst_object_unref (child);
1157       gst_object_unref (parent);
1158       return TRUE;
1159     }
1160
1161     gst_object_unref (child);
1162     child = parent;
1163     parent = gst_object_get_parent (parent);
1164   }
1165
1166   gst_object_unref (child);
1167
1168   return FALSE;
1169 }
1170
1171 /* caller owns return */
1172 static GstObject *
1173 find_common_root (GstObject * o1, GstObject * o2)
1174 {
1175   GstObject *top = o1;
1176   GstObject *kid1, *kid2;
1177   GstObject *root = NULL;
1178
1179   while (GST_OBJECT_PARENT (top))
1180     top = GST_OBJECT_PARENT (top);
1181
1182   /* the itsy-bitsy spider... */
1183
1184   if (!object_has_ancestor (o2, top, &kid2))
1185     return NULL;
1186
1187   root = gst_object_ref (top);
1188   while (TRUE) {
1189     if (!object_has_ancestor (o1, kid2, &kid1)) {
1190       gst_object_unref (kid2);
1191       return root;
1192     }
1193     root = kid2;
1194     if (!object_has_ancestor (o2, kid1, &kid2)) {
1195       gst_object_unref (kid1);
1196       return root;
1197     }
1198     root = kid1;
1199   }
1200 }
1201
1202 /* caller does not own return */
1203 static GstPad *
1204 ghost_up (GstElement * e, GstPad * pad)
1205 {
1206   static gint ghost_pad_index = 0;
1207   GstPad *gpad;
1208   gchar *name;
1209   GstObject *parent = GST_OBJECT_PARENT (e);
1210
1211   name = g_strdup_printf ("ghost%d", ghost_pad_index++);
1212   gpad = gst_ghost_pad_new (name, pad);
1213   g_free (name);
1214
1215   if (!gst_element_add_pad ((GstElement *) parent, gpad)) {
1216     g_warning ("Pad named %s already exists in element %s\n",
1217         GST_OBJECT_NAME (gpad), GST_OBJECT_NAME (parent));
1218     gst_object_unref ((GstObject *) gpad);
1219     return NULL;
1220   }
1221
1222   return gpad;
1223 }
1224
1225 static void
1226 remove_pad (gpointer ppad, gpointer unused)
1227 {
1228   GstPad *pad = ppad;
1229
1230   if (!gst_element_remove_pad ((GstElement *) GST_OBJECT_PARENT (pad), pad))
1231     g_warning ("Couldn't remove pad %s from element %s",
1232         GST_OBJECT_NAME (pad), GST_OBJECT_NAME (GST_OBJECT_PARENT (pad)));
1233 }
1234
1235 static gboolean
1236 prepare_link_maybe_ghosting (GstPad ** src, GstPad ** sink,
1237     GSList ** pads_created)
1238 {
1239   GstObject *root;
1240   GstObject *e1, *e2;
1241   GSList *pads_created_local = NULL;
1242
1243   g_assert (pads_created);
1244
1245   e1 = GST_OBJECT_PARENT (*src);
1246   e2 = GST_OBJECT_PARENT (*sink);
1247
1248   if (G_UNLIKELY (e1 == NULL)) {
1249     GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1250         GST_PTR_FORMAT, *src);
1251     return FALSE;
1252   }
1253   if (G_UNLIKELY (e2 == NULL)) {
1254     GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1255         GST_PTR_FORMAT, *sink);
1256     return FALSE;
1257   }
1258
1259   if (GST_OBJECT_PARENT (e1) == GST_OBJECT_PARENT (e2)) {
1260     GST_CAT_INFO (GST_CAT_PADS, "%s and %s in same bin, no need for ghost pads",
1261         GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1262     return TRUE;
1263   }
1264
1265   GST_CAT_INFO (GST_CAT_PADS, "%s and %s not in same bin, making ghost pads",
1266       GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1267
1268   /* we need to setup some ghost pads */
1269   root = find_common_root (e1, e2);
1270   if (!root) {
1271     g_warning ("Trying to connect elements that don't share a common "
1272         "ancestor: %s and %s", GST_ELEMENT_NAME (e1), GST_ELEMENT_NAME (e2));
1273     return FALSE;
1274   }
1275
1276   while (GST_OBJECT_PARENT (e1) != root) {
1277     *src = ghost_up ((GstElement *) e1, *src);
1278     if (!*src)
1279       goto cleanup_fail;
1280     e1 = GST_OBJECT_PARENT (*src);
1281     pads_created_local = g_slist_prepend (pads_created_local, *src);
1282   }
1283   while (GST_OBJECT_PARENT (e2) != root) {
1284     *sink = ghost_up ((GstElement *) e2, *sink);
1285     if (!*sink)
1286       goto cleanup_fail;
1287     e2 = GST_OBJECT_PARENT (*sink);
1288     pads_created_local = g_slist_prepend (pads_created_local, *sink);
1289   }
1290
1291   gst_object_unref (root);
1292   *pads_created = g_slist_concat (*pads_created, pads_created_local);
1293   return TRUE;
1294
1295 cleanup_fail:
1296   gst_object_unref (root);
1297   g_slist_foreach (pads_created_local, remove_pad, NULL);
1298   g_slist_free (pads_created_local);
1299   return FALSE;
1300 }
1301
1302 static gboolean
1303 pad_link_maybe_ghosting (GstPad * src, GstPad * sink)
1304 {
1305   GSList *pads_created = NULL;
1306   gboolean ret;
1307
1308   if (!prepare_link_maybe_ghosting (&src, &sink, &pads_created)) {
1309     ret = FALSE;
1310   } else {
1311     ret = (gst_pad_link (src, sink) == GST_PAD_LINK_OK);
1312   }
1313
1314   if (!ret) {
1315     g_slist_foreach (pads_created, remove_pad, NULL);
1316   }
1317   g_slist_free (pads_created);
1318
1319   return ret;
1320 }
1321
1322 /**
1323  * gst_element_link_pads:
1324  * @src: a #GstElement containing the source pad.
1325  * @srcpadname: the name of the #GstPad in source element or NULL for any pad.
1326  * @dest: the #GstElement containing the destination pad.
1327  * @destpadname: the name of the #GstPad in destination element,
1328  * or NULL for any pad.
1329  *
1330  * Links the two named pads of the source and destination elements.
1331  * Side effect is that if one of the pads has no parent, it becomes a
1332  * child of the parent of the other element.  If they have different
1333  * parents, the link fails.
1334  *
1335  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1336  */
1337 gboolean
1338 gst_element_link_pads (GstElement * src, const gchar * srcpadname,
1339     GstElement * dest, const gchar * destpadname)
1340 {
1341   const GList *srcpads, *destpads, *srctempls, *desttempls, *l;
1342   GstPad *srcpad, *destpad;
1343   GstPadTemplate *srctempl, *desttempl;
1344   GstElementClass *srcclass, *destclass;
1345
1346   /* checks */
1347   g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1348   g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1349
1350   srcclass = GST_ELEMENT_GET_CLASS (src);
1351   destclass = GST_ELEMENT_GET_CLASS (dest);
1352
1353   GST_CAT_INFO (GST_CAT_ELEMENT_PADS,
1354       "trying to link element %s:%s to element %s:%s", GST_ELEMENT_NAME (src),
1355       srcpadname ? srcpadname : "(any)", GST_ELEMENT_NAME (dest),
1356       destpadname ? destpadname : "(any)");
1357
1358   /* get a src pad */
1359   if (srcpadname) {
1360     /* name specified, look it up */
1361     srcpad = gst_element_get_pad (src, srcpadname);
1362     if (!srcpad) {
1363       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1364           GST_ELEMENT_NAME (src), srcpadname);
1365       return FALSE;
1366     } else {
1367       if (!(GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC)) {
1368         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no src pad",
1369             GST_DEBUG_PAD_NAME (srcpad));
1370         gst_object_unref (srcpad);
1371         return FALSE;
1372       }
1373       if (GST_PAD_PEER (srcpad) != NULL) {
1374         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is already linked",
1375             GST_DEBUG_PAD_NAME (srcpad));
1376         gst_object_unref (srcpad);
1377         return FALSE;
1378       }
1379     }
1380     srcpads = NULL;
1381   } else {
1382     /* no name given, get the first available pad */
1383     GST_OBJECT_LOCK (src);
1384     srcpads = GST_ELEMENT_PADS (src);
1385     srcpad = srcpads ? GST_PAD_CAST (srcpads->data) : NULL;
1386     if (srcpad)
1387       gst_object_ref (srcpad);
1388     GST_OBJECT_UNLOCK (src);
1389   }
1390
1391   /* get a destination pad */
1392   if (destpadname) {
1393     /* name specified, look it up */
1394     destpad = gst_element_get_pad (dest, destpadname);
1395     if (!destpad) {
1396       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1397           GST_ELEMENT_NAME (dest), destpadname);
1398       return FALSE;
1399     } else {
1400       if (!(GST_PAD_DIRECTION (destpad) == GST_PAD_SINK)) {
1401         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no sink pad",
1402             GST_DEBUG_PAD_NAME (destpad));
1403         gst_object_unref (destpad);
1404         return FALSE;
1405       }
1406       if (GST_PAD_PEER (destpad) != NULL) {
1407         GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is already linked",
1408             GST_DEBUG_PAD_NAME (destpad));
1409         gst_object_unref (destpad);
1410         return FALSE;
1411       }
1412     }
1413     destpads = NULL;
1414   } else {
1415     /* no name given, get the first available pad */
1416     GST_OBJECT_LOCK (dest);
1417     destpads = GST_ELEMENT_PADS (dest);
1418     destpad = destpads ? GST_PAD_CAST (destpads->data) : NULL;
1419     if (destpad)
1420       gst_object_ref (destpad);
1421     GST_OBJECT_UNLOCK (dest);
1422   }
1423
1424   if (srcpadname && destpadname) {
1425     gboolean result;
1426
1427     /* two explicitly specified pads */
1428     result = pad_link_maybe_ghosting (srcpad, destpad);
1429
1430     gst_object_unref (srcpad);
1431     gst_object_unref (destpad);
1432
1433     return result;
1434   }
1435
1436   if (srcpad) {
1437     /* loop through the allowed pads in the source, trying to find a
1438      * compatible destination pad */
1439     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1440         "looping through allowed src and dest pads");
1441     do {
1442       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying src pad %s:%s",
1443           GST_DEBUG_PAD_NAME (srcpad));
1444       if ((GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC) &&
1445           (GST_PAD_PEER (srcpad) == NULL)) {
1446         GstPad *temp;
1447
1448         if (destpadname) {
1449           temp = destpad;
1450           gst_object_ref (temp);
1451         } else {
1452           temp = gst_element_get_compatible_pad (dest, srcpad, NULL);
1453         }
1454
1455         if (temp && pad_link_maybe_ghosting (srcpad, temp)) {
1456           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1457               GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (temp));
1458           if (destpad)
1459             gst_object_unref (destpad);
1460           gst_object_unref (srcpad);
1461           gst_object_unref (temp);
1462           return TRUE;
1463         }
1464
1465         if (temp) {
1466           gst_object_unref (temp);
1467         }
1468       }
1469       /* find a better way for this mess */
1470       if (srcpads) {
1471         srcpads = g_list_next (srcpads);
1472         if (srcpads) {
1473           gst_object_unref (srcpad);
1474           srcpad = GST_PAD_CAST (srcpads->data);
1475           gst_object_ref (srcpad);
1476         }
1477       }
1478     } while (srcpads);
1479   }
1480   if (srcpadname) {
1481     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s:%s to %s",
1482         GST_DEBUG_PAD_NAME (srcpad), GST_ELEMENT_NAME (dest));
1483     if (destpad)
1484       gst_object_unref (destpad);
1485     destpad = NULL;
1486   }
1487   if (srcpad)
1488     gst_object_unref (srcpad);
1489   srcpad = NULL;
1490
1491   if (destpad) {
1492     /* loop through the existing pads in the destination */
1493     do {
1494       GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying dest pad %s:%s",
1495           GST_DEBUG_PAD_NAME (destpad));
1496       if ((GST_PAD_DIRECTION (destpad) == GST_PAD_SINK) &&
1497           (GST_PAD_PEER (destpad) == NULL)) {
1498         GstPad *temp = gst_element_get_compatible_pad (src, destpad, NULL);
1499
1500         if (temp && pad_link_maybe_ghosting (temp, destpad)) {
1501           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1502               GST_DEBUG_PAD_NAME (temp), GST_DEBUG_PAD_NAME (destpad));
1503           gst_object_unref (temp);
1504           gst_object_unref (destpad);
1505           return TRUE;
1506         }
1507         if (temp) {
1508           gst_object_unref (temp);
1509         }
1510       }
1511       if (destpads) {
1512         destpads = g_list_next (destpads);
1513         if (destpads) {
1514           gst_object_unref (destpad);
1515           destpad = GST_PAD_CAST (destpads->data);
1516           gst_object_ref (destpad);
1517         }
1518       }
1519     } while (destpads);
1520   }
1521
1522   if (destpadname) {
1523     GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s:%s",
1524         GST_ELEMENT_NAME (src), GST_DEBUG_PAD_NAME (destpad));
1525     gst_object_unref (destpad);
1526     return FALSE;
1527   } else {
1528     if (destpad)
1529       gst_object_unref (destpad);
1530     destpad = NULL;
1531   }
1532
1533   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1534       "we might have request pads on both sides, checking...");
1535   srctempls = gst_element_class_get_pad_template_list (srcclass);
1536   desttempls = gst_element_class_get_pad_template_list (destclass);
1537
1538   if (srctempls && desttempls) {
1539     while (srctempls) {
1540       srctempl = (GstPadTemplate *) srctempls->data;
1541       if (srctempl->presence == GST_PAD_REQUEST) {
1542         for (l = desttempls; l; l = l->next) {
1543           desttempl = (GstPadTemplate *) l->data;
1544           if (desttempl->presence == GST_PAD_REQUEST &&
1545               desttempl->direction != srctempl->direction) {
1546             if (gst_caps_is_always_compatible (gst_pad_template_get_caps
1547                     (srctempl), gst_pad_template_get_caps (desttempl))) {
1548               srcpad =
1549                   gst_element_get_request_pad (src, srctempl->name_template);
1550               destpad =
1551                   gst_element_get_request_pad (dest, desttempl->name_template);
1552               if (pad_link_maybe_ghosting (srcpad, destpad)) {
1553                 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1554                     "linked pad %s:%s to pad %s:%s",
1555                     GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (destpad));
1556                 gst_object_unref (srcpad);
1557                 gst_object_unref (destpad);
1558                 return TRUE;
1559               }
1560               /* it failed, so we release the request pads */
1561               gst_element_release_request_pad (src, srcpad);
1562               gst_element_release_request_pad (dest, destpad);
1563             }
1564           }
1565         }
1566       }
1567       srctempls = srctempls->next;
1568     }
1569   }
1570
1571   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s",
1572       GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
1573   return FALSE;
1574 }
1575
1576 /**
1577  * gst_element_link_pads_filtered:
1578  * @src: a #GstElement containing the source pad.
1579  * @srcpadname: the name of the #GstPad in source element or NULL for any pad.
1580  * @dest: the #GstElement containing the destination pad.
1581  * @destpadname: the name of the #GstPad in destination element or NULL for any pad.
1582  * @filter: the #GstCaps to filter the link, or #NULL for no filter.
1583  *
1584  * Links the two named pads of the source and destination elements. Side effect
1585  * is that if one of the pads has no parent, it becomes a child of the parent of
1586  * the other element. If they have different parents, the link fails. If @caps
1587  * is not #NULL, makes sure that the caps of the link is a subset of @caps.
1588  *
1589  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1590  */
1591 gboolean
1592 gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
1593     GstElement * dest, const gchar * destpadname, GstCaps * filter)
1594 {
1595   /* checks */
1596   g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1597   g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1598   g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), FALSE);
1599
1600   if (filter) {
1601     GstElement *capsfilter;
1602     GstObject *parent;
1603     GstState state, pending;
1604
1605     capsfilter = gst_element_factory_make ("capsfilter", NULL);
1606     if (!capsfilter) {
1607       GST_ERROR ("Could not make a capsfilter");
1608       return FALSE;
1609     }
1610
1611     parent = gst_object_get_parent (GST_OBJECT (src));
1612     g_return_val_if_fail (GST_IS_BIN (parent), FALSE);
1613
1614     gst_element_get_state (GST_ELEMENT_CAST (parent), &state, &pending, 0);
1615
1616     if (!gst_bin_add (GST_BIN (parent), capsfilter)) {
1617       GST_ERROR ("Could not add capsfilter");
1618       gst_object_unref (capsfilter);
1619       gst_object_unref (parent);
1620       return FALSE;
1621     }
1622
1623     if (pending != GST_STATE_VOID_PENDING)
1624       state = pending;
1625
1626     gst_element_set_state (capsfilter, state);
1627
1628     gst_object_unref (parent);
1629
1630     g_object_set (capsfilter, "caps", filter, NULL);
1631
1632     if (gst_element_link_pads (src, srcpadname, capsfilter, "sink")
1633         && gst_element_link_pads (capsfilter, "src", dest, destpadname)) {
1634       return TRUE;
1635     } else {
1636       GST_INFO ("Could not link elements");
1637       gst_element_set_state (capsfilter, GST_STATE_NULL);
1638       /* this will unlink and unref as appropriate */
1639       gst_bin_remove (GST_BIN (GST_OBJECT_PARENT (capsfilter)), capsfilter);
1640       return FALSE;
1641     }
1642   } else {
1643     return gst_element_link_pads (src, srcpadname, dest, destpadname);
1644   }
1645 }
1646
1647 /**
1648  * gst_element_link:
1649  * @src: a #GstElement containing the source pad.
1650  * @dest: the #GstElement containing the destination pad.
1651  *
1652  * Links @src to @dest. The link must be from source to
1653  * destination; the other direction will not be tried. The function looks for
1654  * existing pads that aren't linked yet. It will request new pads if necessary.
1655  * Such pads need to be released manualy when unlinking.
1656  * If multiple links are possible, only one is established.
1657  *
1658  * Make sure you have added your elements to a bin or pipeline with
1659  * gst_bin_add() before trying to link them.
1660  *
1661  * Returns: TRUE if the elements could be linked, FALSE otherwise.
1662  */
1663 gboolean
1664 gst_element_link (GstElement * src, GstElement * dest)
1665 {
1666   return gst_element_link_pads_filtered (src, NULL, dest, NULL, NULL);
1667 }
1668
1669 /**
1670  * gst_element_link_many:
1671  * @element_1: the first #GstElement in the link chain.
1672  * @element_2: the second #GstElement in the link chain.
1673  * @...: the NULL-terminated list of elements to link in order.
1674  *
1675  * Chain together a series of elements. Uses gst_element_link().
1676  * Make sure you have added your elements to a bin or pipeline with
1677  * gst_bin_add() before trying to link them.
1678  *
1679  * Returns: TRUE on success, FALSE otherwise.
1680  */
1681 gboolean
1682 gst_element_link_many (GstElement * element_1, GstElement * element_2, ...)
1683 {
1684   va_list args;
1685
1686   g_return_val_if_fail (GST_IS_ELEMENT (element_1), FALSE);
1687   g_return_val_if_fail (GST_IS_ELEMENT (element_2), FALSE);
1688
1689   va_start (args, element_2);
1690
1691   while (element_2) {
1692     if (!gst_element_link (element_1, element_2))
1693       return FALSE;
1694
1695     element_1 = element_2;
1696     element_2 = va_arg (args, GstElement *);
1697   }
1698
1699   va_end (args);
1700
1701   return TRUE;
1702 }
1703
1704 /**
1705  * gst_element_link_filtered:
1706  * @src: a #GstElement containing the source pad.
1707  * @dest: the #GstElement containing the destination pad.
1708  * @filter: the #GstCaps to filter the link, or #NULL for no filter.
1709  *
1710  * Links @src to @dest using the given caps as filtercaps.
1711  * The link must be from source to
1712  * destination; the other direction will not be tried. The function looks for
1713  * existing pads that aren't linked yet. It will request new pads if necessary.
1714  * If multiple links are possible, only one is established.
1715  *
1716  * Make sure you have added your elements to a bin or pipeline with
1717  * gst_bin_add() before trying to link them.
1718  *
1719  * Returns: TRUE if the pads could be linked, FALSE otherwise.
1720  */
1721 gboolean
1722 gst_element_link_filtered (GstElement * src, GstElement * dest,
1723     GstCaps * filter)
1724 {
1725   return gst_element_link_pads_filtered (src, NULL, dest, NULL, filter);
1726 }
1727
1728 /**
1729  * gst_element_unlink_pads:
1730  * @src: a #GstElement containing the source pad.
1731  * @srcpadname: the name of the #GstPad in source element.
1732  * @dest: a #GstElement containing the destination pad.
1733  * @destpadname: the name of the #GstPad in destination element.
1734  *
1735  * Unlinks the two named pads of the source and destination elements.
1736  */
1737 void
1738 gst_element_unlink_pads (GstElement * src, const gchar * srcpadname,
1739     GstElement * dest, const gchar * destpadname)
1740 {
1741   GstPad *srcpad, *destpad;
1742
1743   g_return_if_fail (src != NULL);
1744   g_return_if_fail (GST_IS_ELEMENT (src));
1745   g_return_if_fail (srcpadname != NULL);
1746   g_return_if_fail (dest != NULL);
1747   g_return_if_fail (GST_IS_ELEMENT (dest));
1748   g_return_if_fail (destpadname != NULL);
1749
1750   /* obtain the pads requested */
1751   srcpad = gst_element_get_pad (src, srcpadname);
1752   if (srcpad == NULL) {
1753     GST_WARNING_OBJECT (src, "source element has no pad \"%s\"", srcpadname);
1754     return;
1755   }
1756   destpad = gst_element_get_pad (dest, destpadname);
1757   if (destpad == NULL) {
1758     GST_WARNING_OBJECT (dest, "destination element has no pad \"%s\"",
1759         destpadname);
1760     gst_object_unref (srcpad);
1761     return;
1762   }
1763
1764   /* we're satisified they can be unlinked, let's do it */
1765   gst_pad_unlink (srcpad, destpad);
1766   gst_object_unref (srcpad);
1767   gst_object_unref (destpad);
1768 }
1769
1770 /**
1771  * gst_element_unlink_many:
1772  * @element_1: the first #GstElement in the link chain.
1773  * @element_2: the second #GstElement in the link chain.
1774  * @...: the NULL-terminated list of elements to unlink in order.
1775  *
1776  * Unlinks a series of elements. Uses gst_element_unlink().
1777  */
1778 void
1779 gst_element_unlink_many (GstElement * element_1, GstElement * element_2, ...)
1780 {
1781   va_list args;
1782
1783   g_return_if_fail (element_1 != NULL && element_2 != NULL);
1784   g_return_if_fail (GST_IS_ELEMENT (element_1) && GST_IS_ELEMENT (element_2));
1785
1786   va_start (args, element_2);
1787
1788   while (element_2) {
1789     gst_element_unlink (element_1, element_2);
1790
1791     element_1 = element_2;
1792     element_2 = va_arg (args, GstElement *);
1793   }
1794
1795   va_end (args);
1796 }
1797
1798 /**
1799  * gst_element_unlink:
1800  * @src: the source #GstElement to unlink.
1801  * @dest: the sink #GstElement to unlink.
1802  *
1803  * Unlinks all source pads of the source element with all sink pads
1804  * of the sink element to which they are linked.
1805  *
1806  * If the link has been made using gst_element_link(), it could have created an
1807  * requestpad, which has to be released using gst_element_release_request_pad().
1808  */
1809 void
1810 gst_element_unlink (GstElement * src, GstElement * dest)
1811 {
1812   GstIterator *pads;
1813   gboolean done = FALSE;
1814
1815   g_return_if_fail (GST_IS_ELEMENT (src));
1816   g_return_if_fail (GST_IS_ELEMENT (dest));
1817
1818   GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unlinking \"%s\" and \"%s\"",
1819       GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
1820
1821   pads = gst_element_iterate_pads (src);
1822   while (!done) {
1823     gpointer data;
1824
1825     switch (gst_iterator_next (pads, &data)) {
1826       case GST_ITERATOR_OK:
1827       {
1828         GstPad *pad = GST_PAD_CAST (data);
1829
1830         if (GST_PAD_IS_SRC (pad)) {
1831           GstPad *peerpad = gst_pad_get_peer (pad);
1832
1833           /* see if the pad is connected and is really a pad
1834            * of dest */
1835           if (peerpad) {
1836             GstElement *peerelem;
1837
1838             peerelem = gst_pad_get_parent_element (peerpad);
1839
1840             if (peerelem == dest) {
1841               gst_pad_unlink (pad, peerpad);
1842             }
1843             if (peerelem)
1844               gst_object_unref (peerelem);
1845
1846             gst_object_unref (peerpad);
1847           }
1848         }
1849         gst_object_unref (pad);
1850         break;
1851       }
1852       case GST_ITERATOR_RESYNC:
1853         gst_iterator_resync (pads);
1854         break;
1855       case GST_ITERATOR_DONE:
1856         done = TRUE;
1857         break;
1858       default:
1859         g_assert_not_reached ();
1860         break;
1861     }
1862   }
1863   gst_iterator_free (pads);
1864 }
1865
1866 /**
1867  * gst_element_query_position:
1868  * @element: a #GstElement to invoke the position query on.
1869  * @format: a pointer to the #GstFormat asked for.
1870  *          On return contains the #GstFormat used.
1871  * @cur: A location in which to store the current position, or NULL.
1872  *
1873  * Queries an element for the stream position.
1874  *
1875  * Returns: TRUE if the query could be performed.
1876  */
1877 gboolean
1878 gst_element_query_position (GstElement * element, GstFormat * format,
1879     gint64 * cur)
1880 {
1881   GstQuery *query;
1882   gboolean ret;
1883
1884   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1885   g_return_val_if_fail (format != NULL, FALSE);
1886
1887   query = gst_query_new_position (*format);
1888   ret = gst_element_query (element, query);
1889
1890   if (ret)
1891     gst_query_parse_position (query, format, cur);
1892
1893   gst_query_unref (query);
1894
1895   return ret;
1896 }
1897
1898 /**
1899  * gst_element_query_duration:
1900  * @element: a #GstElement to invoke the duration query on.
1901  * @format: a pointer to the #GstFormat asked for.
1902  *          On return contains the #GstFormat used.
1903  * @duration: A location in which to store the total duration, or NULL.
1904  *
1905  * Queries an element for the total stream duration.
1906  *
1907  * Returns: TRUE if the query could be performed.
1908  */
1909 gboolean
1910 gst_element_query_duration (GstElement * element, GstFormat * format,
1911     gint64 * duration)
1912 {
1913   GstQuery *query;
1914   gboolean ret;
1915
1916   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1917   g_return_val_if_fail (format != NULL, FALSE);
1918
1919   query = gst_query_new_duration (*format);
1920   ret = gst_element_query (element, query);
1921
1922   if (ret)
1923     gst_query_parse_duration (query, format, duration);
1924
1925   gst_query_unref (query);
1926
1927   return ret;
1928 }
1929
1930 /**
1931  * gst_element_query_convert:
1932  * @element: a #GstElement to invoke the convert query on.
1933  * @src_format: a #GstFormat to convert from.
1934  * @src_val: a value to convert.
1935  * @dest_format: a pointer to the #GstFormat to convert to.
1936  * @dest_val: a pointer to the result.
1937  *
1938  * Queries an element to convert @src_val in @src_format to @dest_format.
1939  *
1940  * Returns: TRUE if the query could be performed.
1941  */
1942 gboolean
1943 gst_element_query_convert (GstElement * element, GstFormat src_format,
1944     gint64 src_val, GstFormat * dest_format, gint64 * dest_val)
1945 {
1946   GstQuery *query;
1947   gboolean ret;
1948
1949   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1950   g_return_val_if_fail (dest_format != NULL, FALSE);
1951   g_return_val_if_fail (dest_val != NULL, FALSE);
1952
1953   if (*dest_format == src_format) {
1954     *dest_val = src_val;
1955     return TRUE;
1956   }
1957
1958   query = gst_query_new_convert (src_format, src_val, *dest_format);
1959   ret = gst_element_query (element, query);
1960
1961   if (ret)
1962     gst_query_parse_convert (query, NULL, NULL, dest_format, dest_val);
1963
1964   gst_query_unref (query);
1965
1966   return ret;
1967 }
1968
1969 /**
1970  * gst_element_seek_simple
1971  * @element: a #GstElement to seek on
1972  * @format: a #GstFormat to execute the seek in, such as #GST_FORMAT_TIME
1973  * @seek_flags: seek options; playback applications will usually want to use
1974  *            GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_KEY_UNIT here
1975  * @seek_pos: position to seek to (relative to the start); if you are doing
1976  *            a seek in #GST_FORMAT_TIME this value is in nanoseconds -
1977  *            multiply with #GST_SECOND to convert seconds to nanoseconds or
1978  *            with #GST_MSECOND to convert milliseconds to nanoseconds.
1979  *
1980  * Simple API to perform a seek on the given element, meaning it just seeks
1981  * to the given position relative to the start of the stream. For more complex
1982  * operations like segment seeks (e.g. for looping) or changing the playback
1983  * rate or seeking relative to the last configured playback segment you should
1984  * use gst_element_seek().
1985  *
1986  * In a completely prerolled PAUSED or PLAYING pipeline, seeking is always
1987  * guaranteed to return %TRUE on a seekable media type or %FALSE when the media
1988  * type is certainly not seekable (such as a live stream).
1989  *
1990  * Some elements allow for seeking in the READY state, in this
1991  * case they will store the seek event and execute it when they are put to
1992  * PAUSED. If the element supports seek in READY, it will always return %TRUE when
1993  * it receives the event in the READY state.
1994  *
1995  * Returns: %TRUE if the seek operation succeeded (the seek might not always be
1996  * executed instantly though)
1997  *
1998  * Since: 0.10.7
1999  */
2000 gboolean
2001 gst_element_seek_simple (GstElement * element, GstFormat format,
2002     GstSeekFlags seek_flags, gint64 seek_pos)
2003 {
2004   g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2005   g_return_val_if_fail (seek_pos >= 0, FALSE);
2006
2007   return gst_element_seek (element, 1.0, format, seek_flags,
2008       GST_SEEK_TYPE_SET, seek_pos, GST_SEEK_TYPE_NONE, 0);
2009 }
2010
2011 /**
2012  * gst_pad_can_link:
2013  * @srcpad: the source #GstPad to link.
2014  * @sinkpad: the sink #GstPad to link.
2015  *
2016  * Checks if the source pad and the sink pad can be linked.
2017  * Both @srcpad and @sinkpad must be unlinked.
2018  *
2019  * Returns: TRUE if the pads can be linked, FALSE otherwise.
2020  */
2021 gboolean
2022 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
2023 {
2024   /* FIXME This function is gross.  It's almost a direct copy of
2025    * gst_pad_link_filtered().  Any decent programmer would attempt
2026    * to merge the two functions, which I will do some day. --ds
2027    */
2028
2029   /* generic checks */
2030   g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
2031   g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
2032
2033   GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
2034       GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2035
2036   /* FIXME: shouldn't we convert this to g_return_val_if_fail? */
2037   if (GST_PAD_PEER (srcpad) != NULL) {
2038     GST_CAT_INFO (GST_CAT_PADS, "Source pad %s:%s has a peer, failed",
2039         GST_DEBUG_PAD_NAME (srcpad));
2040     return FALSE;
2041   }
2042   if (GST_PAD_PEER (sinkpad) != NULL) {
2043     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has a peer, failed",
2044         GST_DEBUG_PAD_NAME (sinkpad));
2045     return FALSE;
2046   }
2047   if (!GST_PAD_IS_SRC (srcpad)) {
2048     GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s is not source pad, failed",
2049         GST_DEBUG_PAD_NAME (srcpad));
2050     return FALSE;
2051   }
2052   if (!GST_PAD_IS_SINK (sinkpad)) {
2053     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s is not sink pad, failed",
2054         GST_DEBUG_PAD_NAME (sinkpad));
2055     return FALSE;
2056   }
2057   if (GST_PAD_PARENT (srcpad) == NULL) {
2058     GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s has no parent, failed",
2059         GST_DEBUG_PAD_NAME (srcpad));
2060     return FALSE;
2061   }
2062   if (GST_PAD_PARENT (sinkpad) == NULL) {
2063     GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has no parent, failed",
2064         GST_DEBUG_PAD_NAME (srcpad));
2065     return FALSE;
2066   }
2067
2068   return TRUE;
2069 }
2070
2071 /**
2072  * gst_pad_use_fixed_caps:
2073  * @pad: the pad to use
2074  *
2075  * A helper function you can use that sets the
2076  * @gst_pad_get_fixed_caps_func as the getcaps function for the
2077  * pad. This way the function will always return the negotiated caps
2078  * or in case the pad is not negotiated, the padtemplate caps.
2079  *
2080  * Use this function on a pad that, once _set_caps() has been called
2081  * on it, cannot be renegotiated to something else.
2082  */
2083 void
2084 gst_pad_use_fixed_caps (GstPad * pad)
2085 {
2086   gst_pad_set_getcaps_function (pad, gst_pad_get_fixed_caps_func);
2087 }
2088
2089 /**
2090  * gst_pad_get_fixed_caps_func:
2091  * @pad: the pad to use
2092  *
2093  * A helper function you can use as a GetCaps function that
2094  * will return the currently negotiated caps or the padtemplate
2095  * when NULL.
2096  *
2097  * Returns: The currently negotiated caps or the padtemplate.
2098  */
2099 GstCaps *
2100 gst_pad_get_fixed_caps_func (GstPad * pad)
2101 {
2102   GstCaps *result;
2103
2104   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2105
2106   GST_OBJECT_LOCK (pad);
2107   if (GST_PAD_CAPS (pad)) {
2108     result = GST_PAD_CAPS (pad);
2109
2110     GST_CAT_DEBUG (GST_CAT_CAPS,
2111         "using pad caps %p %" GST_PTR_FORMAT, result, result);
2112
2113     result = gst_caps_ref (result);
2114     goto done;
2115   }
2116   if (GST_PAD_PAD_TEMPLATE (pad)) {
2117     GstPadTemplate *templ = GST_PAD_PAD_TEMPLATE (pad);
2118
2119     result = GST_PAD_TEMPLATE_CAPS (templ);
2120     GST_CAT_DEBUG (GST_CAT_CAPS,
2121         "using pad template %p with caps %p %" GST_PTR_FORMAT, templ, result,
2122         result);
2123
2124     result = gst_caps_ref (result);
2125     goto done;
2126   }
2127   GST_CAT_DEBUG (GST_CAT_CAPS, "pad has no caps");
2128   result = gst_caps_new_empty ();
2129
2130 done:
2131   GST_OBJECT_UNLOCK (pad);
2132
2133   return result;
2134 }
2135
2136 /**
2137  * gst_pad_get_parent_element:
2138  * @pad: a pad
2139  *
2140  * Gets the parent of @pad, cast to a #GstElement. If a @pad has no parent or
2141  * its parent is not an element, return NULL.
2142  *
2143  * Returns: The parent of the pad. The caller has a reference on the parent, so
2144  * unref when you're finished with it.
2145  *
2146  * MT safe.
2147  */
2148 GstElement *
2149 gst_pad_get_parent_element (GstPad * pad)
2150 {
2151   GstObject *p;
2152
2153   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2154
2155   p = gst_object_get_parent (GST_OBJECT_CAST (pad));
2156
2157   if (p && !GST_IS_ELEMENT (p)) {
2158     gst_object_unref (p);
2159     p = NULL;
2160   }
2161   return GST_ELEMENT_CAST (p);
2162 }
2163
2164 /**
2165  * gst_object_default_error:
2166  * @source: the #GstObject that initiated the error.
2167  * @error: the GError.
2168  * @debug: an additional debug information string, or NULL.
2169  *
2170  * A default error function.
2171  *
2172  * The default handler will simply print the error string using g_print.
2173  */
2174 void
2175 gst_object_default_error (GstObject * source, GError * error, gchar * debug)
2176 {
2177   gchar *name = gst_object_get_path_string (source);
2178
2179   g_print (_("ERROR: from element %s: %s\n"), name, error->message);
2180   if (debug)
2181     g_print (_("Additional debug info:\n%s\n"), debug);
2182
2183   g_free (name);
2184 }
2185
2186 /**
2187  * gst_bin_add_many:
2188  * @bin: a #GstBin
2189  * @element_1: the #GstElement element to add to the bin
2190  * @...: additional elements to add to the bin
2191  *
2192  * Adds a NULL-terminated list of elements to a bin.  This function is
2193  * equivalent to calling gst_bin_add() for each member of the list. The return
2194  * value of each gst_bin_add() is ignored.
2195  */
2196 void
2197 gst_bin_add_many (GstBin * bin, GstElement * element_1, ...)
2198 {
2199   va_list args;
2200
2201   g_return_if_fail (GST_IS_BIN (bin));
2202   g_return_if_fail (GST_IS_ELEMENT (element_1));
2203
2204   va_start (args, element_1);
2205
2206   while (element_1) {
2207     gst_bin_add (bin, element_1);
2208
2209     element_1 = va_arg (args, GstElement *);
2210   }
2211
2212   va_end (args);
2213 }
2214
2215 /**
2216  * gst_bin_remove_many:
2217  * @bin: a #GstBin
2218  * @element_1: the first #GstElement to remove from the bin
2219  * @...: NULL-terminated list of elements to remove from the bin
2220  *
2221  * Remove a list of elements from a bin. This function is equivalent
2222  * to calling gst_bin_remove() with each member of the list.
2223  */
2224 void
2225 gst_bin_remove_many (GstBin * bin, GstElement * element_1, ...)
2226 {
2227   va_list args;
2228
2229   g_return_if_fail (GST_IS_BIN (bin));
2230   g_return_if_fail (GST_IS_ELEMENT (element_1));
2231
2232   va_start (args, element_1);
2233
2234   while (element_1) {
2235     gst_bin_remove (bin, element_1);
2236
2237     element_1 = va_arg (args, GstElement *);
2238   }
2239
2240   va_end (args);
2241 }
2242
2243 static void
2244 gst_element_populate_std_props (GObjectClass * klass, const gchar * prop_name,
2245     guint arg_id, GParamFlags flags)
2246 {
2247   GQuark prop_id = g_quark_from_string (prop_name);
2248   GParamSpec *pspec;
2249
2250   static GQuark fd_id = 0;
2251   static GQuark blocksize_id;
2252   static GQuark bytesperread_id;
2253   static GQuark dump_id;
2254   static GQuark filesize_id;
2255   static GQuark mmapsize_id;
2256   static GQuark location_id;
2257   static GQuark offset_id;
2258   static GQuark silent_id;
2259   static GQuark touch_id;
2260
2261   if (!fd_id) {
2262     fd_id = g_quark_from_static_string ("fd");
2263     blocksize_id = g_quark_from_static_string ("blocksize");
2264     bytesperread_id = g_quark_from_static_string ("bytesperread");
2265     dump_id = g_quark_from_static_string ("dump");
2266     filesize_id = g_quark_from_static_string ("filesize");
2267     mmapsize_id = g_quark_from_static_string ("mmapsize");
2268     location_id = g_quark_from_static_string ("location");
2269     offset_id = g_quark_from_static_string ("offset");
2270     silent_id = g_quark_from_static_string ("silent");
2271     touch_id = g_quark_from_static_string ("touch");
2272   }
2273
2274   if (prop_id == fd_id) {
2275     pspec = g_param_spec_int ("fd", "File-descriptor",
2276         "File-descriptor for the file being read", 0, G_MAXINT, 0, flags);
2277   } else if (prop_id == blocksize_id) {
2278     pspec = g_param_spec_ulong ("blocksize", "Block Size",
2279         "Block size to read per buffer", 0, G_MAXULONG, 4096, flags);
2280
2281   } else if (prop_id == bytesperread_id) {
2282     pspec = g_param_spec_int ("bytesperread", "Bytes per read",
2283         "Number of bytes to read per buffer", G_MININT, G_MAXINT, 0, flags);
2284
2285   } else if (prop_id == dump_id) {
2286     pspec = g_param_spec_boolean ("dump", "Dump",
2287         "Dump bytes to stdout", FALSE, flags);
2288
2289   } else if (prop_id == filesize_id) {
2290     pspec = g_param_spec_int64 ("filesize", "File Size",
2291         "Size of the file being read", 0, G_MAXINT64, 0, flags);
2292
2293   } else if (prop_id == mmapsize_id) {
2294     pspec = g_param_spec_ulong ("mmapsize", "mmap() Block Size",
2295         "Size in bytes of mmap()d regions", 0, G_MAXULONG, 4 * 1048576, flags);
2296
2297   } else if (prop_id == location_id) {
2298     pspec = g_param_spec_string ("location", "File Location",
2299         "Location of the file to read", NULL, flags);
2300
2301   } else if (prop_id == offset_id) {
2302     pspec = g_param_spec_int64 ("offset", "File Offset",
2303         "Byte offset of current read pointer", 0, G_MAXINT64, 0, flags);
2304
2305   } else if (prop_id == silent_id) {
2306     pspec = g_param_spec_boolean ("silent", "Silent", "Don't produce events",
2307         FALSE, flags);
2308
2309   } else if (prop_id == touch_id) {
2310     pspec = g_param_spec_boolean ("touch", "Touch read data",
2311         "Touch data to force disk read before " "push ()", TRUE, flags);
2312   } else {
2313     g_warning ("Unknown - 'standard' property '%s' id %d from klass %s",
2314         prop_name, arg_id, g_type_name (G_OBJECT_CLASS_TYPE (klass)));
2315     pspec = NULL;
2316   }
2317
2318   if (pspec) {
2319     g_object_class_install_property (klass, arg_id, pspec);
2320   }
2321 }
2322
2323 /**
2324  * gst_element_class_install_std_props:
2325  * @klass: the #GstElementClass to add the properties to.
2326  * @first_name: the name of the first property.
2327  * in a NULL terminated
2328  * @...: the id and flags of the first property, followed by
2329  * further 'name', 'id', 'flags' triplets and terminated by NULL.
2330  *
2331  * Adds a list of standardized properties with types to the @klass.
2332  * the id is for the property switch in your get_prop method, and
2333  * the flags determine readability / writeability.
2334  **/
2335 void
2336 gst_element_class_install_std_props (GstElementClass * klass,
2337     const gchar * first_name, ...)
2338 {
2339   const char *name;
2340
2341   va_list args;
2342
2343   g_return_if_fail (GST_IS_ELEMENT_CLASS (klass));
2344
2345   va_start (args, first_name);
2346
2347   name = first_name;
2348
2349   while (name) {
2350     int arg_id = va_arg (args, int);
2351     int flags = va_arg (args, int);
2352
2353     gst_element_populate_std_props ((GObjectClass *) klass, name, arg_id,
2354         flags);
2355
2356     name = va_arg (args, char *);
2357   }
2358
2359   va_end (args);
2360 }
2361
2362
2363 /**
2364  * gst_buffer_merge:
2365  * @buf1: the first source #GstBuffer to merge.
2366  * @buf2: the second source #GstBuffer to merge.
2367  *
2368  * Create a new buffer that is the concatenation of the two source
2369  * buffers.  The original source buffers will not be modified or
2370  * unref'd.  Make sure you unref the source buffers if they are not used
2371  * anymore afterwards.
2372  *
2373  * If the buffers point to contiguous areas of memory, the buffer
2374  * is created without copying the data.
2375  *
2376  * Returns: the new #GstBuffer which is the concatenation of the source buffers.
2377  */
2378 GstBuffer *
2379 gst_buffer_merge (GstBuffer * buf1, GstBuffer * buf2)
2380 {
2381   GstBuffer *result;
2382
2383   /* we're just a specific case of the more general gst_buffer_span() */
2384   result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
2385
2386   return result;
2387 }
2388
2389 /**
2390  * gst_buffer_join:
2391  * @buf1: the first source #GstBuffer.
2392  * @buf2: the second source #GstBuffer.
2393  *
2394  * Create a new buffer that is the concatenation of the two source
2395  * buffers, and unrefs the original source buffers.
2396  *
2397  * If the buffers point to contiguous areas of memory, the buffer
2398  * is created without copying the data.
2399  *
2400  * Returns: the new #GstBuffer which is the concatenation of the source buffers.
2401  */
2402 GstBuffer *
2403 gst_buffer_join (GstBuffer * buf1, GstBuffer * buf2)
2404 {
2405   GstBuffer *result;
2406
2407   result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
2408   gst_buffer_unref (buf1);
2409   gst_buffer_unref (buf2);
2410
2411   return result;
2412 }
2413
2414
2415 /**
2416  * gst_buffer_stamp:
2417  * @dest: buffer to stamp
2418  * @src: buffer to stamp from
2419  *
2420  * Copies additional information (the timestamp, duration, and offset start
2421  * and end) from one buffer to the other.
2422  *
2423  * This function does not copy any buffer flags or caps and is equivalent to
2424  * gst_buffer_copy_metadata(@dest, @src, GST_BUFFER_COPY_TIMESTAMPS).
2425  *
2426  * Deprecated: use gst_buffer_copy_metadata() instead, it provides more
2427  * control.
2428  */
2429 #ifndef GST_REMOVE_DEPRECATED
2430 void
2431 gst_buffer_stamp (GstBuffer * dest, const GstBuffer * src)
2432 {
2433   gst_buffer_copy_metadata (dest, src, GST_BUFFER_COPY_TIMESTAMPS);
2434 }
2435 #endif
2436
2437 static gboolean
2438 intersect_caps_func (GstPad * pad, GValue * ret, GstPad * orig)
2439 {
2440   if (pad != orig) {
2441     GstCaps *peercaps, *existing;
2442
2443     existing = g_value_get_pointer (ret);
2444     peercaps = gst_pad_peer_get_caps (pad);
2445     if (peercaps == NULL)
2446       peercaps = gst_caps_new_any ();
2447     g_value_set_pointer (ret, gst_caps_intersect (existing, peercaps));
2448     gst_caps_unref (existing);
2449     gst_caps_unref (peercaps);
2450   }
2451   gst_object_unref (pad);
2452   return TRUE;
2453 }
2454
2455 /**
2456  * gst_pad_proxy_getcaps:
2457  * @pad: a #GstPad to proxy.
2458  *
2459  * Calls gst_pad_get_allowed_caps() for every other pad belonging to the
2460  * same element as @pad, and returns the intersection of the results.
2461  *
2462  * This function is useful as a default getcaps function for an element
2463  * that can handle any stream format, but requires all its pads to have
2464  * the same caps.  Two such elements are tee and aggregator.
2465  *
2466  * Returns: the intersection of the other pads' allowed caps.
2467  */
2468 GstCaps *
2469 gst_pad_proxy_getcaps (GstPad * pad)
2470 {
2471   GstElement *element;
2472   GstCaps *caps, *intersected;
2473   GstIterator *iter;
2474   GstIteratorResult res;
2475   GValue ret = { 0, };
2476
2477   g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2478
2479   GST_DEBUG ("proxying getcaps for %s:%s", GST_DEBUG_PAD_NAME (pad));
2480
2481   element = gst_pad_get_parent_element (pad);
2482   if (element == NULL)
2483     return NULL;
2484
2485   /* value to hold the return, by default it holds ANY, the ref is taken by
2486    * the GValue. */
2487   g_value_init (&ret, G_TYPE_POINTER);
2488   g_value_set_pointer (&ret, gst_caps_new_any ());
2489
2490   iter = gst_element_iterate_pads (element);
2491   while (1) {
2492     res =
2493         gst_iterator_fold (iter, (GstIteratorFoldFunction) intersect_caps_func,
2494         &ret, pad);
2495     switch (res) {
2496       case GST_ITERATOR_RESYNC:
2497         /* unref any value stored */
2498         if ((caps = g_value_get_pointer (&ret)))
2499           gst_caps_unref (caps);
2500         /* need to reset the result again to ANY */
2501         g_value_set_pointer (&ret, gst_caps_new_any ());
2502         gst_iterator_resync (iter);
2503         break;
2504       case GST_ITERATOR_DONE:
2505         /* all pads iterated, return collected value */
2506         goto done;
2507       default:
2508         /* iterator returned _ERROR or premature end with _OK,
2509          * mark an error and exit */
2510         if ((caps = g_value_get_pointer (&ret)))
2511           gst_caps_unref (caps);
2512         g_value_set_pointer (&ret, NULL);
2513         goto error;
2514     }
2515   }
2516 done:
2517   gst_iterator_free (iter);
2518
2519   gst_object_unref (element);
2520
2521   caps = g_value_get_pointer (&ret);
2522   g_value_unset (&ret);
2523
2524   intersected = gst_caps_intersect (caps, gst_pad_get_pad_template_caps (pad));
2525   gst_caps_unref (caps);
2526
2527   return intersected;
2528
2529   /* ERRORS */
2530 error:
2531   {
2532     g_warning ("Pad list returned error on element %s",
2533         GST_ELEMENT_NAME (element));
2534     gst_iterator_free (iter);
2535     gst_object_unref (element);
2536     return NULL;
2537   }
2538 }
2539
2540 typedef struct
2541 {
2542   GstPad *orig;
2543   GstCaps *caps;
2544 } LinkData;
2545
2546 static gboolean
2547 link_fold_func (GstPad * pad, GValue * ret, LinkData * data)
2548 {
2549   gboolean success = TRUE;
2550
2551   if (pad != data->orig) {
2552     success = gst_pad_set_caps (pad, data->caps);
2553     g_value_set_boolean (ret, success);
2554   }
2555   gst_object_unref (pad);
2556
2557   return success;
2558 }
2559
2560 /**
2561  * gst_pad_proxy_setcaps
2562  * @pad: a #GstPad to proxy from
2563  * @caps: the #GstCaps to link with
2564  *
2565  * Calls gst_pad_set_caps() for every other pad belonging to the
2566  * same element as @pad.  If gst_pad_set_caps() fails on any pad,
2567  * the proxy setcaps fails. May be used only during negotiation.
2568  *
2569  * Returns: TRUE if sucessful
2570  */
2571 gboolean
2572 gst_pad_proxy_setcaps (GstPad * pad, GstCaps * caps)
2573 {
2574   GstElement *element;
2575   GstIterator *iter;
2576   GstIteratorResult res;
2577   GValue ret = { 0, };
2578   LinkData data;
2579
2580   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2581   g_return_val_if_fail (caps != NULL, FALSE);
2582
2583   GST_DEBUG ("proxying pad link for %s:%s", GST_DEBUG_PAD_NAME (pad));
2584
2585   element = gst_pad_get_parent_element (pad);
2586   if (element == NULL)
2587     return FALSE;
2588
2589   iter = gst_element_iterate_pads (element);
2590
2591   g_value_init (&ret, G_TYPE_BOOLEAN);
2592   g_value_set_boolean (&ret, TRUE);
2593   data.orig = pad;
2594   data.caps = caps;
2595
2596   res = gst_iterator_fold (iter, (GstIteratorFoldFunction) link_fold_func,
2597       &ret, &data);
2598   gst_iterator_free (iter);
2599
2600   if (res != GST_ITERATOR_DONE)
2601     goto pads_changed;
2602
2603   gst_object_unref (element);
2604
2605   /* ok not to unset the gvalue */
2606   return g_value_get_boolean (&ret);
2607
2608   /* ERRORS */
2609 pads_changed:
2610   {
2611     g_warning ("Pad list changed during proxy_pad_link for element %s",
2612         GST_ELEMENT_NAME (element));
2613     gst_object_unref (element);
2614     return FALSE;
2615   }
2616 }
2617
2618 /**
2619  * gst_pad_query_position:
2620  * @pad: a #GstPad to invoke the position query on.
2621  * @format: a pointer to the #GstFormat asked for.
2622  *          On return contains the #GstFormat used.
2623  * @cur: A location in which to store the current position, or NULL.
2624  *
2625  * Queries a pad for the stream position.
2626  *
2627  * Returns: TRUE if the query could be performed.
2628  */
2629 gboolean
2630 gst_pad_query_position (GstPad * pad, GstFormat * format, gint64 * cur)
2631 {
2632   GstQuery *query;
2633   gboolean ret;
2634
2635   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2636   g_return_val_if_fail (format != NULL, FALSE);
2637
2638   query = gst_query_new_position (*format);
2639   ret = gst_pad_query (pad, query);
2640
2641   if (ret)
2642     gst_query_parse_position (query, format, cur);
2643
2644   gst_query_unref (query);
2645
2646   return ret;
2647 }
2648
2649 /**
2650  * gst_pad_query_peer_position:
2651  * @pad: a #GstPad on whose peer to invoke the position query on.
2652  *       Must be a sink pad.
2653  * @format: a pointer to the #GstFormat asked for.
2654  *          On return contains the #GstFormat used.
2655  * @cur: A location in which to store the current position, or NULL.
2656  *
2657  * Queries the peer of a given sink pad for the stream position.
2658  *
2659  * Returns: TRUE if the query could be performed.
2660  */
2661 gboolean
2662 gst_pad_query_peer_position (GstPad * pad, GstFormat * format, gint64 * cur)
2663 {
2664   gboolean ret = FALSE;
2665   GstPad *peer;
2666
2667   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2668   g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2669   g_return_val_if_fail (format != NULL, FALSE);
2670
2671   peer = gst_pad_get_peer (pad);
2672   if (peer) {
2673     ret = gst_pad_query_position (peer, format, cur);
2674     gst_object_unref (peer);
2675   }
2676
2677   return ret;
2678 }
2679
2680 /**
2681  * gst_pad_query_duration:
2682  * @pad: a #GstPad to invoke the duration query on.
2683  * @format: a pointer to the #GstFormat asked for.
2684  *          On return contains the #GstFormat used.
2685  * @duration: A location in which to store the total duration, or NULL.
2686  *
2687  * Queries a pad for the total stream duration.
2688  *
2689  * Returns: TRUE if the query could be performed.
2690  */
2691 gboolean
2692 gst_pad_query_duration (GstPad * pad, GstFormat * format, gint64 * duration)
2693 {
2694   GstQuery *query;
2695   gboolean ret;
2696
2697   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2698   g_return_val_if_fail (format != NULL, FALSE);
2699
2700   query = gst_query_new_duration (*format);
2701   ret = gst_pad_query (pad, query);
2702
2703   if (ret)
2704     gst_query_parse_duration (query, format, duration);
2705
2706   gst_query_unref (query);
2707
2708   return ret;
2709 }
2710
2711 /**
2712  * gst_pad_query_peer_duration:
2713  * @pad: a #GstPad on whose peer pad to invoke the duration query on.
2714  *       Must be a sink pad.
2715  * @format: a pointer to the #GstFormat asked for.
2716  *          On return contains the #GstFormat used.
2717  * @duration: A location in which to store the total duration, or NULL.
2718  *
2719  * Queries the peer pad of a given sink pad for the total stream duration.
2720  *
2721  * Returns: TRUE if the query could be performed.
2722  */
2723 gboolean
2724 gst_pad_query_peer_duration (GstPad * pad, GstFormat * format,
2725     gint64 * duration)
2726 {
2727   gboolean ret = FALSE;
2728   GstPad *peer;
2729
2730   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2731   g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2732   g_return_val_if_fail (format != NULL, FALSE);
2733
2734   peer = gst_pad_get_peer (pad);
2735   if (peer) {
2736     ret = gst_pad_query_duration (peer, format, duration);
2737     gst_object_unref (peer);
2738   }
2739
2740   return ret;
2741 }
2742
2743 /**
2744  * gst_pad_query_convert:
2745  * @pad: a #GstPad to invoke the convert query on.
2746  * @src_format: a #GstFormat to convert from.
2747  * @src_val: a value to convert.
2748  * @dest_format: a pointer to the #GstFormat to convert to.
2749  * @dest_val: a pointer to the result.
2750  *
2751  * Queries a pad to convert @src_val in @src_format to @dest_format.
2752  *
2753  * Returns: TRUE if the query could be performed.
2754  */
2755 gboolean
2756 gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2757     GstFormat * dest_format, gint64 * dest_val)
2758 {
2759   GstQuery *query;
2760   gboolean ret;
2761
2762   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2763   g_return_val_if_fail (src_val >= 0, FALSE);
2764   g_return_val_if_fail (dest_format != NULL, FALSE);
2765   g_return_val_if_fail (dest_val != NULL, FALSE);
2766
2767   if (*dest_format == src_format) {
2768     *dest_val = src_val;
2769     return TRUE;
2770   }
2771
2772   query = gst_query_new_convert (src_format, src_val, *dest_format);
2773   ret = gst_pad_query (pad, query);
2774
2775   if (ret)
2776     gst_query_parse_convert (query, NULL, NULL, dest_format, dest_val);
2777
2778   gst_query_unref (query);
2779
2780   return ret;
2781 }
2782
2783 /**
2784  * gst_pad_query_peer_convert:
2785  * @pad: a #GstPad, on whose peer pad to invoke the convert query on.
2786  *       Must be a sink pad.
2787  * @src_format: a #GstFormat to convert from.
2788  * @src_val: a value to convert.
2789  * @dest_format: a pointer to the #GstFormat to convert to.
2790  * @dest_val: a pointer to the result.
2791  *
2792  * Queries the peer pad of a given sink pad to convert @src_val in @src_format
2793  * to @dest_format.
2794  *
2795  * Returns: TRUE if the query could be performed.
2796  */
2797 gboolean
2798 gst_pad_query_peer_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2799     GstFormat * dest_format, gint64 * dest_val)
2800 {
2801   gboolean ret = FALSE;
2802   GstPad *peer;
2803
2804   g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2805   g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2806   g_return_val_if_fail (src_val >= 0, FALSE);
2807   g_return_val_if_fail (dest_format != NULL, FALSE);
2808   g_return_val_if_fail (dest_val != NULL, FALSE);
2809
2810   peer = gst_pad_get_peer (pad);
2811   if (peer) {
2812     ret = gst_pad_query_convert (peer, src_format, src_val, dest_format,
2813         dest_val);
2814     gst_object_unref (peer);
2815   }
2816
2817   return ret;
2818 }
2819
2820 /**
2821  * gst_atomic_int_set:
2822  * @atomic_int: pointer to an atomic integer
2823  * @value: value to set
2824  *
2825  * Unconditionally sets the atomic integer to @value.
2826  */
2827 void
2828 gst_atomic_int_set (gint * atomic_int, gint value)
2829 {
2830   int ignore;
2831
2832   *atomic_int = value;
2833   /* read acts as a memory barrier */
2834   ignore = g_atomic_int_get (atomic_int);
2835 }
2836
2837 /**
2838  * gst_pad_add_data_probe:
2839  * @pad: pad to add the data probe handler to
2840  * @handler: function to call when data is passed over pad
2841  * @data: data to pass along with the handler
2842  *
2843  * Adds a "data probe" to a pad. This function will be called whenever data
2844  * passes through a pad. In this case data means both events and buffers. The
2845  * probe will be called with the data as an argument, meaning @handler should
2846  * have the same callback signature as the 'have-data' signal of #GstPad.
2847  * Note that the data will have a reference count greater than 1, so it will
2848  * be immutable -- you must not change it.
2849  *
2850  * For source pads, the probe will be called after the blocking function, if any
2851  * (see gst_pad_set_blocked_async()), but before looking up the peer to chain
2852  * to. For sink pads, the probe function will be called before configuring the
2853  * sink with new caps, if any, and before calling the pad's chain function.
2854  *
2855  * Your data probe should return TRUE to let the data continue to flow, or FALSE
2856  * to drop it. Dropping data is rarely useful, but occasionally comes in handy
2857  * with events.
2858  *
2859  * Although probes are implemented internally by connecting @handler to the
2860  * have-data signal on the pad, if you want to remove a probe it is insufficient
2861  * to only call g_signal_handler_disconnect on the returned handler id. To
2862  * remove a probe, use the appropriate function, such as
2863  * gst_pad_remove_data_probe().
2864  *
2865  * Returns: The handler id.
2866  */
2867 gulong
2868 gst_pad_add_data_probe (GstPad * pad, GCallback handler, gpointer data)
2869 {
2870   gulong sigid;
2871
2872   g_return_val_if_fail (GST_IS_PAD (pad), 0);
2873   g_return_val_if_fail (handler != NULL, 0);
2874
2875   GST_OBJECT_LOCK (pad);
2876   sigid = g_signal_connect (pad, "have-data", handler, data);
2877   GST_PAD_DO_EVENT_SIGNALS (pad)++;
2878   GST_PAD_DO_BUFFER_SIGNALS (pad)++;
2879   GST_DEBUG ("adding data probe to pad %s:%s, now %d data, %d event probes",
2880       GST_DEBUG_PAD_NAME (pad),
2881       GST_PAD_DO_BUFFER_SIGNALS (pad), GST_PAD_DO_EVENT_SIGNALS (pad));
2882   GST_OBJECT_UNLOCK (pad);
2883
2884   return sigid;
2885 }
2886
2887 /**
2888  * gst_pad_add_event_probe:
2889  * @pad: pad to add the event probe handler to
2890  * @handler: function to call when data is passed over pad
2891  * @data: data to pass along with the handler
2892  *
2893  * Adds a probe that will be called for all events passing through a pad. See
2894  * gst_pad_add_data_probe() for more information.
2895  *
2896  * Returns: The handler id
2897  */
2898 gulong
2899 gst_pad_add_event_probe (GstPad * pad, GCallback handler, gpointer data)
2900 {
2901   gulong sigid;
2902
2903   g_return_val_if_fail (GST_IS_PAD (pad), 0);
2904   g_return_val_if_fail (handler != NULL, 0);
2905
2906   GST_OBJECT_LOCK (pad);
2907   sigid = g_signal_connect (pad, "have-data::event", handler, data);
2908   GST_PAD_DO_EVENT_SIGNALS (pad)++;
2909   GST_DEBUG ("adding event probe to pad %s:%s, now %d probes",
2910       GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_EVENT_SIGNALS (pad));
2911   GST_OBJECT_UNLOCK (pad);
2912
2913   return sigid;
2914 }
2915
2916 /**
2917  * gst_pad_add_buffer_probe:
2918  * @pad: pad to add the buffer probe handler to
2919  * @handler: function to call when data is passed over pad
2920  * @data: data to pass along with the handler
2921  *
2922  * Adds a probe that will be called for all buffers passing through a pad. See
2923  * gst_pad_add_data_probe() for more information.
2924  *
2925  * Returns: The handler id
2926  */
2927 gulong
2928 gst_pad_add_buffer_probe (GstPad * pad, GCallback handler, gpointer data)
2929 {
2930   gulong sigid;
2931
2932   g_return_val_if_fail (GST_IS_PAD (pad), 0);
2933   g_return_val_if_fail (handler != NULL, 0);
2934
2935   GST_OBJECT_LOCK (pad);
2936   sigid = g_signal_connect (pad, "have-data::buffer", handler, data);
2937   GST_PAD_DO_BUFFER_SIGNALS (pad)++;
2938   GST_DEBUG ("adding buffer probe to pad %s:%s, now %d probes",
2939       GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_BUFFER_SIGNALS (pad));
2940   GST_OBJECT_UNLOCK (pad);
2941
2942   return sigid;
2943 }
2944
2945 /**
2946  * gst_pad_remove_data_probe:
2947  * @pad: pad to remove the data probe handler from
2948  * @handler_id: handler id returned from gst_pad_add_data_probe
2949  *
2950  * Removes a data probe from @pad.
2951  */
2952 void
2953 gst_pad_remove_data_probe (GstPad * pad, guint handler_id)
2954 {
2955   g_return_if_fail (GST_IS_PAD (pad));
2956   g_return_if_fail (handler_id > 0);
2957
2958   GST_OBJECT_LOCK (pad);
2959   g_signal_handler_disconnect (pad, handler_id);
2960   GST_PAD_DO_BUFFER_SIGNALS (pad)--;
2961   GST_PAD_DO_EVENT_SIGNALS (pad)--;
2962   GST_DEBUG
2963       ("removed data probe from pad %s:%s, now %d event, %d buffer probes",
2964       GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_EVENT_SIGNALS (pad),
2965       GST_PAD_DO_BUFFER_SIGNALS (pad));
2966   GST_OBJECT_UNLOCK (pad);
2967
2968 }
2969
2970 /**
2971  * gst_pad_remove_event_probe:
2972  * @pad: pad to remove the event probe handler from
2973  * @handler_id: handler id returned from gst_pad_add_event_probe
2974  *
2975  * Removes an event probe from @pad.
2976  */
2977 void
2978 gst_pad_remove_event_probe (GstPad * pad, guint handler_id)
2979 {
2980   g_return_if_fail (GST_IS_PAD (pad));
2981   g_return_if_fail (handler_id > 0);
2982
2983   GST_OBJECT_LOCK (pad);
2984   g_signal_handler_disconnect (pad, handler_id);
2985   GST_PAD_DO_EVENT_SIGNALS (pad)--;
2986   GST_DEBUG ("removed event probe from pad %s:%s, now %d event probes",
2987       GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_EVENT_SIGNALS (pad));
2988   GST_OBJECT_UNLOCK (pad);
2989 }
2990
2991 /**
2992  * gst_pad_remove_buffer_probe:
2993  * @pad: pad to remove the buffer probe handler from
2994  * @handler_id: handler id returned from gst_pad_add_buffer_probe
2995  *
2996  * Removes a buffer probe from @pad.
2997  */
2998 void
2999 gst_pad_remove_buffer_probe (GstPad * pad, guint handler_id)
3000 {
3001   g_return_if_fail (GST_IS_PAD (pad));
3002   g_return_if_fail (handler_id > 0);
3003
3004   GST_OBJECT_LOCK (pad);
3005   g_signal_handler_disconnect (pad, handler_id);
3006   GST_PAD_DO_BUFFER_SIGNALS (pad)--;
3007   GST_DEBUG ("removed buffer probe from pad %s:%s, now %d buffer probes",
3008       GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_BUFFER_SIGNALS (pad));
3009   GST_OBJECT_UNLOCK (pad);
3010
3011 }
3012
3013 /**
3014  * gst_element_found_tags_for_pad:
3015  * @element: element for which to post taglist to bus.
3016  * @pad: pad on which to push tag-event.
3017  * @list: the taglist to post on the bus and create event from.
3018  *
3019  * Posts a message to the bus that new tags were found and pushes the
3020  * tags as event. Takes ownership of the @list.
3021  *
3022  * This is a utility method for elements. Applications should use the
3023  * #GstTagSetter interface.
3024  */
3025 void
3026 gst_element_found_tags_for_pad (GstElement * element,
3027     GstPad * pad, GstTagList * list)
3028 {
3029   g_return_if_fail (element != NULL);
3030   g_return_if_fail (pad != NULL);
3031   g_return_if_fail (list != NULL);
3032
3033   gst_pad_push_event (pad, gst_event_new_tag (gst_tag_list_copy (list)));
3034   gst_element_post_message (element,
3035       gst_message_new_tag (GST_OBJECT (element), list));
3036 }
3037
3038 static void
3039 push_and_ref (GstPad * pad, GstEvent * event)
3040 {
3041   gst_pad_push_event (pad, gst_event_ref (event));
3042   /* iterator refs pad, we unref when we are done with it */
3043   gst_object_unref (pad);
3044 }
3045
3046 /**
3047  * gst_element_found_tags:
3048  * @element: element for which we found the tags.
3049  * @list: list of tags.
3050  *
3051  * Posts a message to the bus that new tags were found, and pushes an event
3052  * to all sourcepads. Takes ownership of the @list.
3053  *
3054  * This is a utility method for elements. Applications should use the
3055  * #GstTagSetter interface.
3056  */
3057 void
3058 gst_element_found_tags (GstElement * element, GstTagList * list)
3059 {
3060   GstIterator *iter;
3061   GstEvent *event;
3062
3063   g_return_if_fail (element != NULL);
3064   g_return_if_fail (list != NULL);
3065
3066   iter = gst_element_iterate_src_pads (element);
3067   event = gst_event_new_tag (gst_tag_list_copy (list));
3068   gst_iterator_foreach (iter, (GFunc) push_and_ref, event);
3069   gst_iterator_free (iter);
3070   gst_event_unref (event);
3071
3072   gst_element_post_message (element,
3073       gst_message_new_tag (GST_OBJECT (element), list));
3074 }
3075
3076 static GstPad *
3077 element_find_unconnected_pad (GstElement * element, GstPadDirection direction)
3078 {
3079   GstIterator *iter;
3080   GstPad *unconnected_pad = NULL;
3081   gboolean done;
3082
3083   switch (direction) {
3084     case GST_PAD_SRC:
3085       iter = gst_element_iterate_src_pads (element);
3086       break;
3087     case GST_PAD_SINK:
3088       iter = gst_element_iterate_sink_pads (element);
3089       break;
3090     default:
3091       g_assert_not_reached ();
3092   }
3093
3094   done = FALSE;
3095   while (!done) {
3096     gpointer pad;
3097
3098     switch (gst_iterator_next (iter, &pad)) {
3099       case GST_ITERATOR_OK:{
3100         GstPad *peer;
3101
3102         GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
3103             GST_DEBUG_PAD_NAME (pad));
3104
3105         peer = gst_pad_get_peer (GST_PAD (pad));
3106         if (peer == NULL) {
3107           unconnected_pad = pad;
3108           done = TRUE;
3109           GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
3110               "found existing unlinked pad %s:%s",
3111               GST_DEBUG_PAD_NAME (unconnected_pad));
3112         } else {
3113           gst_object_unref (pad);
3114           gst_object_unref (peer);
3115         }
3116         break;
3117       }
3118       case GST_ITERATOR_DONE:
3119         done = TRUE;
3120         break;
3121       case GST_ITERATOR_RESYNC:
3122         gst_iterator_resync (iter);
3123         break;
3124       case GST_ITERATOR_ERROR:
3125         g_return_val_if_reached (NULL);
3126         break;
3127     }
3128   }
3129
3130   gst_iterator_free (iter);
3131
3132   return unconnected_pad;
3133 }
3134
3135 /**
3136  * gst_bin_find_unconnected_pad:
3137  * @bin: bin in which to look for elements with unconnected pads
3138  * @direction: whether to look for an unconnected source or sink pad
3139  *
3140  * Recursively looks for elements with an unconnected pad of the given
3141  * direction within the specified bin and returns an unconnected pad
3142  * if one is found, or NULL otherwise. If a pad is found, the caller
3143  * owns a reference to it and should use gst_object_unref() on the
3144  * pad when it is not needed any longer.
3145  *
3146  * Returns: unconnected pad of the given direction, or NULL.
3147  *
3148  * Since: 0.10.3
3149  */
3150 GstPad *
3151 gst_bin_find_unconnected_pad (GstBin * bin, GstPadDirection direction)
3152 {
3153   GstIterator *iter;
3154   gboolean done;
3155   GstPad *pad = NULL;
3156
3157   g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3158   g_return_val_if_fail (direction != GST_PAD_UNKNOWN, NULL);
3159
3160   done = FALSE;
3161   iter = gst_bin_iterate_recurse (bin);
3162   while (!done) {
3163     gpointer element;
3164
3165     switch (gst_iterator_next (iter, &element)) {
3166       case GST_ITERATOR_OK:
3167         pad = element_find_unconnected_pad (GST_ELEMENT (element), direction);
3168         gst_object_unref (element);
3169         if (pad != NULL)
3170           done = TRUE;
3171         break;
3172       case GST_ITERATOR_DONE:
3173         done = TRUE;
3174         break;
3175       case GST_ITERATOR_RESYNC:
3176         gst_iterator_resync (iter);
3177         break;
3178       case GST_ITERATOR_ERROR:
3179         g_return_val_if_reached (NULL);
3180         break;
3181     }
3182   }
3183
3184   gst_iterator_free (iter);
3185
3186   return pad;
3187 }
3188
3189 /**
3190  * gst_parse_bin_from_description:
3191  * @bin_description: command line describing the bin
3192  * @ghost_unconnected_pads: whether to automatically create ghost pads
3193  *                          for unconnected source or sink pads within
3194  *                          the bin
3195  * @err: where to store the error message in case of an error, or NULL
3196  *
3197  * This is a convenience wrapper around gst_parse_launch() to create a
3198  * #GstBin from a gst-launch-style pipeline description. See
3199  * gst_parse_launch() and the gst-launch man page for details about the
3200  * syntax. Ghost pads on the bin for unconnected source or sink pads
3201  * within the bin can automatically be created (but only a maximum of
3202  * one ghost pad for each direction will be created; if you expect
3203  * multiple unconnected source pads or multiple unconnected sink pads
3204  * and want them all ghosted, you will have to create the ghost pads
3205  * yourself).
3206  *
3207  * Returns: a newly-created bin, or NULL if an error occurred.
3208  *
3209  * Since: 0.10.3
3210  */
3211 GstElement *
3212 gst_parse_bin_from_description (const gchar * bin_description,
3213     gboolean ghost_unconnected_pads, GError ** err)
3214 {
3215 #ifndef GST_DISABLE_PARSE
3216   GstPad *pad = NULL;
3217   GstBin *bin;
3218   gchar *desc;
3219
3220   g_return_val_if_fail (bin_description != NULL, NULL);
3221   g_return_val_if_fail (err == NULL || *err == NULL, NULL);
3222
3223   GST_DEBUG ("Making bin from description '%s'", bin_description);
3224
3225   /* parse the pipeline to a bin */
3226   desc = g_strdup_printf ("bin.( %s )", bin_description);
3227   bin = (GstBin *) gst_parse_launch (desc, err);
3228   g_free (desc);
3229
3230   if (bin == NULL || (err && *err != NULL)) {
3231     if (bin)
3232       gst_object_unref (bin);
3233     return NULL;
3234   }
3235
3236   /* find pads and ghost them if necessary */
3237   if (ghost_unconnected_pads) {
3238     if ((pad = gst_bin_find_unconnected_pad (bin, GST_PAD_SRC))) {
3239       gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("src", pad));
3240       gst_object_unref (pad);
3241     }
3242     if ((pad = gst_bin_find_unconnected_pad (bin, GST_PAD_SINK))) {
3243       gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("sink", pad));
3244       gst_object_unref (pad);
3245     }
3246   }
3247
3248   return GST_ELEMENT (bin);
3249 #else
3250   gchar *msg;
3251
3252   GST_WARNING ("Disabled API called: gst_parse_bin_from_description()");
3253
3254   msg = gst_error_get_message (GST_CORE_ERROR, GST_CORE_ERROR_DISABLED);
3255   g_set_error (err, GST_CORE_ERROR, GST_CORE_ERROR_DISABLED, "%s", msg);
3256   g_free (msg);
3257
3258   return NULL;
3259 #endif
3260 }
3261
3262 /**
3263  * gst_type_register_static_full:
3264  * @parent_type: The GType of the parent type the newly registered type will 
3265  *   derive from
3266  * @type_name: NULL-terminated string used as the name of the new type
3267  * @class_size: Size of the class structure.
3268  * @base_init: Location of the base initialization function (optional).
3269  * @base_finalize: Location of the base finalization function (optional).
3270  * @class_init: Location of the class initialization function for class types 
3271  *   Location of the default vtable inititalization function for interface 
3272  *   types. (optional)
3273  * @class_finalize: Location of the class finalization function for class types.
3274  *   Location of the default vtable finalization function for interface types. 
3275  *   (optional)
3276  * @class_data: User-supplied data passed to the class init/finalize functions.
3277  * @instance_size: Size of the instance (object) structure (required for 
3278  *   instantiatable types only).
3279  * @n_preallocs: The number of pre-allocated (cached) instances to reserve 
3280  *   memory for (0 indicates no caching). Ignored on recent GLib's.
3281  * @instance_init: Location of the instance initialization function (optional, 
3282  *   for instantiatable types only).
3283  * @value_table: A GTypeValueTable function table for generic handling of 
3284  *   GValues of this type (usually only useful for fundamental types). 
3285  * @flags: #GTypeFlags for this GType. E.g: G_TYPE_FLAG_ABSTRACT
3286  *
3287  * Helper function which constructs a #GTypeInfo structure and registers a 
3288  * GType, but which generates less linker overhead than a static const 
3289  * #GTypeInfo structure. For further details of the parameters, please see
3290  * #GTypeInfo in the GLib documentation.
3291  *
3292  * Registers type_name as the name of a new static type derived from 
3293  * parent_type. The value of flags determines the nature (e.g. abstract or 
3294  * not) of the type. It works by filling a GTypeInfo struct and calling 
3295  * g_type_info_register_static().
3296  *
3297  * Returns: A #GType for the newly-registered type.
3298  *
3299  * Since: 0.10.14
3300  */
3301 GType
3302 gst_type_register_static_full (GType parent_type,
3303     const gchar * type_name,
3304     guint class_size,
3305     GBaseInitFunc base_init,
3306     GBaseFinalizeFunc base_finalize,
3307     GClassInitFunc class_init,
3308     GClassFinalizeFunc class_finalize,
3309     gconstpointer class_data,
3310     guint instance_size,
3311     guint16 n_preallocs,
3312     GInstanceInitFunc instance_init,
3313     const GTypeValueTable * value_table, GTypeFlags flags)
3314 {
3315   GTypeInfo info;
3316
3317   info.class_size = class_size;
3318   info.base_init = base_init;
3319   info.base_finalize = base_finalize;
3320   info.class_init = class_init;
3321   info.class_finalize = class_finalize;
3322   info.class_data = class_data;
3323   info.instance_size = instance_size;
3324   info.n_preallocs = n_preallocs;
3325   info.instance_init = instance_init;
3326   info.value_table = value_table;
3327
3328   return g_type_register_static (parent_type, type_name, &info, flags);
3329 }
3330
3331
3332 /**
3333  * gst_util_get_timestamp:
3334  *
3335  * Get a timestamp as GstClockTime to be used for interval meassurements.
3336  * The timestamp should not be interpreted in any other way.
3337  *
3338  * Returns: the timestamp
3339  *
3340  * Since: 0.10.16
3341  */
3342 G_GNUC_PURE GstClockTime
3343 gst_util_get_timestamp (void)
3344 {
3345 #ifdef HAVE_POSIX_TIMERS
3346   struct timespec now;
3347
3348   clock_gettime (CLOCK_MONOTONIC, &now);
3349   return GST_TIMESPEC_TO_TIME (now);
3350 #else
3351   GTimeVal now;
3352
3353   g_get_current_time (&now);
3354   return GST_TIMEVAL_TO_TIME (now);
3355 #endif
3356 }