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>
6 * gstutils.c: Utility functions: gtk_get_property stuff, etc.
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.
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.
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.
26 * @short_description: Various utility functions
28 * When defining own plugins, use the GST_BOILERPLATE ease gobject creation.
31 #include "gst_private.h"
35 #include "gstghostpad.h"
40 #include "gst-i18n-lib.h"
45 * @mem: a pointer to the memory to dump
46 * @size: the size of the memory block to dump
48 * Dumps the memory block into a hex representation. Useful for debugging.
51 gst_util_dump_mem (const guchar * mem, guint size)
54 GString *string = g_string_sized_new (50);
55 GString *chars = g_string_sized_new (18);
59 if (g_ascii_isprint (mem[i]))
60 g_string_append_c (chars, mem[i]);
62 g_string_append_c (chars, '.');
64 g_string_append_printf (string, "%02x ", mem[i]);
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);
77 g_string_free (string, TRUE);
78 g_string_free (chars, TRUE);
83 * gst_util_set_value_from_string:
84 * @value: the value to set
85 * @value_str: the string to get the value from
87 * Converts the string to the type of the value and
88 * sets the value with it.
91 gst_util_set_value_from_string (GValue * value, const gchar * value_str)
95 g_return_if_fail (value != NULL);
96 g_return_if_fail (value_str != NULL);
98 GST_CAT_DEBUG (GST_CAT_PARAMS, "parsing '%s' to type %s", value_str,
99 g_type_name (G_VALUE_TYPE (value)));
101 switch (G_VALUE_TYPE (value)) {
103 g_value_set_string (value, value_str);
109 sscanf_ret = sscanf (value_str, "%d", &i);
110 g_return_if_fail (sscanf_ret == 1);
111 g_value_set_int (value, i);
117 sscanf_ret = sscanf (value_str, "%u", &i);
118 g_return_if_fail (sscanf_ret == 1);
119 g_value_set_uint (value, i);
125 sscanf_ret = sscanf (value_str, "%ld", &i);
126 g_return_if_fail (sscanf_ret == 1);
127 g_value_set_long (value, i);
133 sscanf_ret = sscanf (value_str, "%lu", &i);
134 g_return_if_fail (sscanf_ret == 1);
135 g_value_set_ulong (value, i);
138 case G_TYPE_BOOLEAN:{
141 if (!g_ascii_strncasecmp ("true", value_str, 4))
143 g_value_set_boolean (value, i);
149 sscanf_ret = sscanf (value_str, "%c", &i);
150 g_return_if_fail (sscanf_ret == 1);
151 g_value_set_char (value, i);
157 sscanf_ret = sscanf (value_str, "%c", &i);
158 g_return_if_fail (sscanf_ret == 1);
159 g_value_set_uchar (value, i);
165 sscanf_ret = sscanf (value_str, "%f", &i);
166 g_return_if_fail (sscanf_ret == 1);
167 g_value_set_float (value, i);
173 sscanf_ret = sscanf (value_str, "%g", &i);
174 g_return_if_fail (sscanf_ret == 1);
175 g_value_set_double (value, (gdouble) i);
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
189 * Convertes the string value to the type of the objects argument and
190 * sets the argument with it.
193 gst_util_set_object_arg (GObject * object, const gchar * name,
199 GParamSpec *paramspec;
202 g_object_class_find_property (G_OBJECT_GET_CLASS (object), name);
208 GST_DEBUG ("paramspec->flags is %d, paramspec->value_type is %d",
209 paramspec->flags, (gint) paramspec->value_type);
211 if (paramspec->flags & G_PARAM_WRITABLE) {
212 switch (paramspec->value_type) {
214 g_object_set (G_OBJECT (object), name, value, NULL);
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);
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);
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);
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);
249 case G_TYPE_BOOLEAN:{
252 if (!g_ascii_strncasecmp ("true", value, 4))
254 g_object_set (G_OBJECT (object), name, i, NULL);
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);
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);
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);
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);
290 if (G_IS_PARAM_SPEC_ENUM (paramspec)) {
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);
303 /* work around error C2520: conversion from unsigned __int64 to double
304 * not implemented, use signed __int64
306 * These are implemented as functions because on some platforms a 64bit int to
307 * double conversion is not defined/implemented.
311 gst_util_guint64_to_gdouble (guint64 value)
313 if (value & G_GINT64_CONSTANT (0x8000000000000000))
314 return (gdouble) ((gint64) value) + (gdouble) 18446744073709551616.;
316 return (gdouble) ((gint64) value);
320 gst_util_gdouble_to_guint64 (gdouble value)
322 if (value < (gdouble) 9223372036854775808.) /* 1 << 63 */
323 return ((guint64) ((gint64) value));
325 value -= (gdouble) 18446744073709551616.;
326 return ((guint64) ((gint64) value));
329 /* convenience struct for getting high and low uint32 parts of
336 #if G_BYTE_ORDER == G_BIG_ENDIAN
344 /* based on Hacker's Delight p152 */
346 gst_util_div128_64 (GstUInt64 c1, GstUInt64 c0, guint64 denom)
348 GstUInt64 q1, q0, rhat;
349 GstUInt64 v, cmp1, cmp2;
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);
360 s = ~(s | (s >> 16));
361 s = s - ((s >> 1) & 0x55555555);
362 s = (s & 0x33333333) + ((s >> 2) & 0x33333333);
363 s = (s + (s >> 4)) & 0x0f0f0f0f;
365 s = (s + (s >> 16)) & 0x3f;
368 /* normalize divisor and dividend */
370 c1.ll = (c1.ll << s) | (c0.l.high >> (32 - s));
374 q1.ll = c1.ll / v.l.high;
375 rhat.ll = c1.ll - q1.ll * v.l.high;
377 cmp1.l.high = rhat.l.low;
378 cmp1.l.low = c0.l.high;
379 cmp2.ll = q1.ll * v.l.low;
381 while (q1.l.high || cmp2.ll > cmp1.ll) {
386 cmp1.l.high = rhat.l.low;
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;
395 cmp1.l.high = rhat.l.low;
396 cmp1.l.low = c0.l.low;
397 cmp2.ll = q0.ll * v.l.low;
399 while (q0.l.high || cmp2.ll > cmp1.ll) {
404 cmp1.l.high = rhat.l.low;
407 q0.l.high += q1.l.low;
413 gst_util_uint64_scale_int64 (guint64 val, guint64 num, guint64 denom)
415 GstUInt64 a0, a1, b0, b1, c0, ct, c1, result;
422 /* do 128 bits multiply
430 * -------------------
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;
438 /* and sum together with carry into 128 bits c1, c0 */
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;
444 /* if high bits bigger than denom, we overflow */
448 /* shortcut for division by 1, c1.ll should be 0 because of the
449 * overflow check above. */
453 /* and 128/64 bits division, result fits 64 bits */
454 if (denom <= G_MAXUINT32) {
455 guint32 den = (guint32) denom;
457 /* easy case, (c1,c0)128/(den)32 division */
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;
465 result.ll = gst_util_div128_64 (c1, c0, denom);
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
481 * Scale @val by @num / @denom, trying to avoid overflows.
483 * This function can potentially be very slow if denom > G_MAXUINT32.
485 * Returns: @val * @num / @denom, trying to avoid overflows.
486 * In the case of an overflow, this function returns G_MAXUINT64.
489 gst_util_uint64_scale (guint64 val, guint64 num, guint64 denom)
491 g_return_val_if_fail (denom != 0, G_MAXUINT64);
496 if (num == 1 && denom == 1)
499 /* if the denom is high, we need to do a 64 muldiv */
500 if (denom > G_MAXINT32)
503 /* if num and denom are low we can do a 32 bit muldiv */
504 if (num <= G_MAXINT32)
507 /* val and num are high, we need 64 muldiv */
508 if (val > G_MAXINT32)
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);
515 return gst_util_uint64_scale_int (val, (gint) num, (gint) denom);
518 /* to the more heavy implementations... */
519 return gst_util_uint64_scale_int64 (val, num, denom);
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.
528 * Scale a guint64 by a factor expressed as a fraction (num/denom), avoiding
529 * overflows and loss of precision.
531 * @num and @denom must be positive integers. @denom cannot be 0.
533 * Returns: @val * @num / @denom, avoiding overflow and loss of precision.
534 * In the case of an overflow, this function returns G_MAXUINT64.
537 gst_util_uint64_scale_int (guint64 val, gint num, gint denom)
542 g_return_val_if_fail (denom > 0, G_MAXUINT64);
543 g_return_val_if_fail (num >= 0, G_MAXUINT64);
548 if (num == 1 && denom == 1)
551 if (val <= G_MAXUINT32)
553 return val * num / denom;
555 /* do 96 bits mult/div */
557 result.ll = ((guint64) low.l.low) * num;
558 high.ll = ((guint64) low.l.high) * num + (result.l.high);
560 low.ll = high.ll / denom;
561 result.l.high = high.ll % denom;
565 if (low.ll + result.l.high > G_MAXUINT32)
568 result.l.high += low.l.low;
578 /* -----------------------------------------------------
580 * The following code will be moved out of the main
581 * gstreamer library someday.
587 string_append_indent (GString * str, gint count)
591 for (xx = 0; xx < count; xx++)
592 g_string_append_c (str, ' ');
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
601 * Write the pad capabilities in a human readable format into
605 gst_print_pad_caps (GString * buf, gint indent, GstPad * pad)
612 string_append_indent (buf, indent);
613 g_string_printf (buf, "%s:%s has no capabilities",
614 GST_DEBUG_PAD_NAME (pad));
618 s = gst_caps_to_string (caps);
619 g_string_append (buf, s);
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
630 * Print the element argument in a human readable format in the given
634 gst_print_element_args (GString * buf, gint indent, GstElement * element)
637 GValue value = { 0, }; /* the important thing is that value.type = 0 */
639 GParamSpec *spec, **specs, **walk;
641 specs = g_object_class_list_properties (G_OBJECT_GET_CLASS (element), NULL);
644 for (walk = specs; *walk; walk++) {
646 if (width < strlen (spec->name))
647 width = strlen (spec->name);
650 for (walk = specs; *walk; walk++) {
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);
659 str = g_strdup ("Parameter not readable.");
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');
675 * gst_element_create_all_pads:
676 * @element: a #GstElement to create pads for
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.
683 gst_element_create_all_pads (GstElement * element)
687 /* FIXME: lock element */
690 gst_element_class_get_pad_template_list (GST_ELEMENT_CLASS
691 (G_OBJECT_GET_CLASS (element)));
694 GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
696 if (padtempl->presence == GST_PAD_ALWAYS) {
699 pad = gst_pad_new_from_template (padtempl, padtempl->name_template);
701 gst_element_add_pad (element, pad);
703 padlist = padlist->next;
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.
712 * Retrieves a pad template from @element that is compatible with @compattempl.
713 * Pads from compatible templates can be linked together.
715 * Returns: a compatible #GstPadTemplate, or NULL if none was found. No
716 * unreferencing is necessary.
719 gst_element_get_compatible_pad_template (GstElement * element,
720 GstPadTemplate * compattempl)
722 GstPadTemplate *newtempl = NULL;
724 GstElementClass *class;
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);
730 class = GST_ELEMENT_GET_CLASS (element);
732 padlist = gst_element_class_get_pad_template_list (class);
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));
739 GstPadTemplate *padtempl = (GstPadTemplate *) padlist->data;
740 GstCaps *intersection;
744 * Check direction (must be opposite)
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);
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));
760 intersection = gst_caps_intersect (GST_PAD_TEMPLATE_CAPS (compattempl),
761 GST_PAD_TEMPLATE_CAPS (padtempl));
763 GST_CAT_DEBUG (GST_CAT_CAPS, "caps are %scompatible %" GST_PTR_FORMAT,
764 (intersection ? "" : "not "), intersection);
766 if (!gst_caps_is_empty (intersection))
768 gst_caps_unref (intersection);
773 padlist = g_list_next (padlist);
776 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
777 "Returning new pad template %p", newtempl);
779 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "No compatible pad template found");
785 gst_element_request_pad (GstElement * element, GstPadTemplate * templ,
788 GstPad *newpad = NULL;
789 GstElementClass *oclass;
791 oclass = GST_ELEMENT_GET_CLASS (element);
793 if (oclass->request_new_pad)
794 newpad = (oclass->request_new_pad) (element, templ, name);
797 gst_object_ref (newpad);
805 * gst_element_get_pad_from_template:
806 * @element: a #GstElement.
807 * @templ: a #GstPadTemplate belonging to @element.
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
813 * Returns: the #GstPad, or NULL if one could not be found or created.
816 gst_element_get_pad_from_template (GstElement * element, GstPadTemplate * templ)
819 GstPadPresence presence;
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
825 presence = GST_PAD_TEMPLATE_PRESENCE (templ);
829 case GST_PAD_SOMETIMES:
830 ret = gst_element_get_static_pad (element, templ->name_template);
831 if (!ret && presence == GST_PAD_ALWAYS)
833 ("Element %s has an ALWAYS template %s, but no pad of the same name",
834 GST_OBJECT_NAME (element), templ->name_template);
837 case GST_PAD_REQUEST:
838 ret = gst_element_request_pad (element, templ, NULL);
846 * gst_element_request_compatible_pad:
847 * @element: a #GstElement.
848 * @templ: the #GstPadTemplate to which the new pad should be able to link.
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.
853 * Returns: a #GstPad, or %NULL if one could not be found or created.
856 gst_element_request_compatible_pad (GstElement * element,
857 GstPadTemplate * templ)
859 GstPadTemplate *templ_new;
862 g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
863 g_return_val_if_fail (GST_IS_PAD_TEMPLATE (templ), NULL);
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);
869 pad = gst_element_get_pad_from_template (element, templ_new);
871 /* This can happen for non-request pads. No need to unref. */
872 if (pad && GST_PAD_PEER (pad))
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.
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
888 * Returns: the #GstPad to which a link can be made, or %NULL if one cannot be
889 * found. gst_object_unref() after usage.
892 gst_element_get_compatible_pad (GstElement * element, GstPad * pad,
893 const GstCaps * caps)
896 GstPadTemplate *templ;
898 GstPad *foundpad = NULL;
901 /* FIXME check for caps compatibility */
903 g_return_val_if_fail (GST_IS_ELEMENT (element), NULL);
904 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
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));
910 g_return_val_if_fail (GST_PAD_PEER (pad) == NULL, NULL);
913 /* try to get an existing unlinked pad */
914 pads = gst_element_iterate_pads (element);
918 switch (gst_iterator_next (pads, &padptr)) {
919 case GST_ITERATOR_OK:
924 current = GST_PAD (padptr);
926 GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
927 GST_DEBUG_PAD_NAME (current));
929 peer = gst_pad_get_peer (current);
931 if (peer == NULL && gst_pad_can_link (pad, current)) {
933 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
934 "found existing unlinked pad %s:%s",
935 GST_DEBUG_PAD_NAME (current));
937 gst_iterator_free (pads);
941 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unreffing pads");
943 gst_object_unref (current);
945 gst_object_unref (peer);
949 case GST_ITERATOR_DONE:
952 case GST_ITERATOR_RESYNC:
953 gst_iterator_resync (pads);
955 case GST_ITERATOR_ERROR:
956 g_assert_not_reached ();
960 gst_iterator_free (pads);
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);
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);
972 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
973 "found existing request pad %s:%s", GST_DEBUG_PAD_NAME (foundpad));
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));
984 * gst_element_state_get_name:
985 * @state: a #GstState to get the name of.
987 * Gets a string representing the given state.
989 * Returns: a string with the name of the state.
991 G_CONST_RETURN gchar *
992 gst_element_state_get_name (GstState state)
995 #ifdef GST_DEBUG_COLOR
996 case GST_STATE_VOID_PENDING:
997 return "VOID_PENDING";
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";
1007 /* This is a memory leak */
1008 return g_strdup_printf ("\033[01;35;41mUNKNOWN!\033[00m(%d)", state);
1010 case GST_STATE_VOID_PENDING:
1011 return "VOID_PENDING";
1012 case GST_STATE_NULL:
1014 case GST_STATE_READY:
1016 case GST_STATE_PLAYING:
1018 case GST_STATE_PAUSED:
1021 /* This is a memory leak */
1022 return g_strdup_printf ("UNKNOWN!(%d)", state);
1028 * gst_element_state_change_return_get_name:
1029 * @state_ret: a #GstStateChangeReturn to get the name of.
1031 * Gets a string representing the given state change result.
1033 * Returns: a string with the name of the state change result.
1037 G_CONST_RETURN gchar *
1038 gst_element_state_change_return_get_name (GstStateChangeReturn state_ret)
1040 switch (state_ret) {
1041 #ifdef GST_DEBUG_COLOR
1042 case GST_STATE_CHANGE_FAILURE:
1043 return "\033[01;31mFAILURE\033[00m";
1044 case GST_STATE_CHANGE_SUCCESS:
1045 return "\033[01;32mSUCCESS\033[00m";
1046 case GST_STATE_CHANGE_ASYNC:
1047 return "\033[01;33mASYNC\033[00m";
1048 case GST_STATE_CHANGE_NO_PREROLL:
1049 return "\033[01;34mNO_PREROLL\033[00m";
1051 /* This is a memory leak */
1052 return g_strdup_printf ("\033[01;35;41mUNKNOWN!\033[00m(%d)", state_ret);
1054 case GST_STATE_CHANGE_FAILURE:
1056 case GST_STATE_CHANGE_SUCCESS:
1058 case GST_STATE_CHANGE_ASYNC:
1060 case GST_STATE_CHANGE_NO_PREROLL:
1061 return "NO PREROLL";
1063 /* This is a memory leak */
1064 return g_strdup_printf ("UNKNOWN!(%d)", state_ret);
1071 * gst_element_factory_can_src_caps :
1072 * @factory: factory to query
1073 * @caps: the caps to check
1075 * Checks if the factory can source the given capability.
1077 * Returns: true if it can src the capabilities
1080 gst_element_factory_can_src_caps (GstElementFactory * factory,
1081 const GstCaps * caps)
1085 g_return_val_if_fail (factory != NULL, FALSE);
1086 g_return_val_if_fail (caps != NULL, FALSE);
1088 templates = factory->staticpadtemplates;
1091 GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1093 if (template->direction == GST_PAD_SRC) {
1094 if (gst_caps_is_always_compatible (gst_static_caps_get (&template->
1095 static_caps), caps))
1098 templates = g_list_next (templates);
1105 * gst_element_factory_can_sink_caps :
1106 * @factory: factory to query
1107 * @caps: the caps to check
1109 * Checks if the factory can sink the given capability.
1111 * Returns: true if it can sink the capabilities
1114 gst_element_factory_can_sink_caps (GstElementFactory * factory,
1115 const GstCaps * caps)
1119 g_return_val_if_fail (factory != NULL, FALSE);
1120 g_return_val_if_fail (caps != NULL, FALSE);
1122 templates = factory->staticpadtemplates;
1125 GstStaticPadTemplate *template = (GstStaticPadTemplate *) templates->data;
1127 if (template->direction == GST_PAD_SINK) {
1128 if (gst_caps_is_always_compatible (caps,
1129 gst_static_caps_get (&template->static_caps)))
1132 templates = g_list_next (templates);
1139 /* if return val is true, *direct_child is a caller-owned ref on the direct
1140 * child of ancestor that is part of object's ancestry */
1142 object_has_ancestor (GstObject * object, GstObject * ancestor,
1143 GstObject ** direct_child)
1145 GstObject *child, *parent;
1148 *direct_child = NULL;
1150 child = gst_object_ref (object);
1151 parent = gst_object_get_parent (object);
1154 if (ancestor == parent) {
1156 *direct_child = child;
1158 gst_object_unref (child);
1159 gst_object_unref (parent);
1163 gst_object_unref (child);
1165 parent = gst_object_get_parent (parent);
1168 gst_object_unref (child);
1173 /* caller owns return */
1175 find_common_root (GstObject * o1, GstObject * o2)
1177 GstObject *top = o1;
1178 GstObject *kid1, *kid2;
1179 GstObject *root = NULL;
1181 while (GST_OBJECT_PARENT (top))
1182 top = GST_OBJECT_PARENT (top);
1184 /* the itsy-bitsy spider... */
1186 if (!object_has_ancestor (o2, top, &kid2))
1189 root = gst_object_ref (top);
1191 if (!object_has_ancestor (o1, kid2, &kid1)) {
1192 gst_object_unref (kid2);
1196 if (!object_has_ancestor (o2, kid1, &kid2)) {
1197 gst_object_unref (kid1);
1204 /* caller does not own return */
1206 ghost_up (GstElement * e, GstPad * pad)
1208 static gint ghost_pad_index = 0;
1211 GstObject *parent = GST_OBJECT_PARENT (e);
1213 name = g_strdup_printf ("ghost%d", ghost_pad_index++);
1214 gpad = gst_ghost_pad_new (name, pad);
1217 if (!gst_element_add_pad ((GstElement *) parent, gpad)) {
1218 g_warning ("Pad named %s already exists in element %s\n",
1219 GST_OBJECT_NAME (gpad), GST_OBJECT_NAME (parent));
1220 gst_object_unref ((GstObject *) gpad);
1228 remove_pad (gpointer ppad, gpointer unused)
1232 if (!gst_element_remove_pad ((GstElement *) GST_OBJECT_PARENT (pad), pad))
1233 g_warning ("Couldn't remove pad %s from element %s",
1234 GST_OBJECT_NAME (pad), GST_OBJECT_NAME (GST_OBJECT_PARENT (pad)));
1238 prepare_link_maybe_ghosting (GstPad ** src, GstPad ** sink,
1239 GSList ** pads_created)
1243 GSList *pads_created_local = NULL;
1245 g_assert (pads_created);
1247 e1 = GST_OBJECT_PARENT (*src);
1248 e2 = GST_OBJECT_PARENT (*sink);
1250 if (G_UNLIKELY (e1 == NULL)) {
1251 GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1252 GST_PTR_FORMAT, *src);
1255 if (G_UNLIKELY (e2 == NULL)) {
1256 GST_WARNING ("Trying to ghost a pad that doesn't have a parent: %"
1257 GST_PTR_FORMAT, *sink);
1261 if (GST_OBJECT_PARENT (e1) == GST_OBJECT_PARENT (e2)) {
1262 GST_CAT_INFO (GST_CAT_PADS, "%s and %s in same bin, no need for ghost pads",
1263 GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1267 GST_CAT_INFO (GST_CAT_PADS, "%s and %s not in same bin, making ghost pads",
1268 GST_OBJECT_NAME (e1), GST_OBJECT_NAME (e2));
1270 /* we need to setup some ghost pads */
1271 root = find_common_root (e1, e2);
1273 g_warning ("Trying to connect elements that don't share a common "
1274 "ancestor: %s and %s", GST_ELEMENT_NAME (e1), GST_ELEMENT_NAME (e2));
1278 while (GST_OBJECT_PARENT (e1) != root) {
1279 *src = ghost_up ((GstElement *) e1, *src);
1282 e1 = GST_OBJECT_PARENT (*src);
1283 pads_created_local = g_slist_prepend (pads_created_local, *src);
1285 while (GST_OBJECT_PARENT (e2) != root) {
1286 *sink = ghost_up ((GstElement *) e2, *sink);
1289 e2 = GST_OBJECT_PARENT (*sink);
1290 pads_created_local = g_slist_prepend (pads_created_local, *sink);
1293 gst_object_unref (root);
1294 *pads_created = g_slist_concat (*pads_created, pads_created_local);
1298 gst_object_unref (root);
1299 g_slist_foreach (pads_created_local, remove_pad, NULL);
1300 g_slist_free (pads_created_local);
1305 pad_link_maybe_ghosting (GstPad * src, GstPad * sink)
1307 GSList *pads_created = NULL;
1310 if (!prepare_link_maybe_ghosting (&src, &sink, &pads_created)) {
1313 ret = (gst_pad_link (src, sink) == GST_PAD_LINK_OK);
1317 g_slist_foreach (pads_created, remove_pad, NULL);
1319 g_slist_free (pads_created);
1325 * gst_element_link_pads:
1326 * @src: a #GstElement containing the source pad.
1327 * @srcpadname: the name of the #GstPad in source element or NULL for any pad.
1328 * @dest: the #GstElement containing the destination pad.
1329 * @destpadname: the name of the #GstPad in destination element,
1330 * or NULL for any pad.
1332 * Links the two named pads of the source and destination elements.
1333 * Side effect is that if one of the pads has no parent, it becomes a
1334 * child of the parent of the other element. If they have different
1335 * parents, the link fails.
1337 * Returns: TRUE if the pads could be linked, FALSE otherwise.
1340 gst_element_link_pads (GstElement * src, const gchar * srcpadname,
1341 GstElement * dest, const gchar * destpadname)
1343 const GList *srcpads, *destpads, *srctempls, *desttempls, *l;
1344 GstPad *srcpad, *destpad;
1345 GstPadTemplate *srctempl, *desttempl;
1346 GstElementClass *srcclass, *destclass;
1349 g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1350 g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1352 srcclass = GST_ELEMENT_GET_CLASS (src);
1353 destclass = GST_ELEMENT_GET_CLASS (dest);
1355 GST_CAT_INFO (GST_CAT_ELEMENT_PADS,
1356 "trying to link element %s:%s to element %s:%s", GST_ELEMENT_NAME (src),
1357 srcpadname ? srcpadname : "(any)", GST_ELEMENT_NAME (dest),
1358 destpadname ? destpadname : "(any)");
1362 /* name specified, look it up */
1363 srcpad = gst_element_get_pad (src, srcpadname);
1365 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1366 GST_ELEMENT_NAME (src), srcpadname);
1369 if (!(GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC)) {
1370 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no src pad",
1371 GST_DEBUG_PAD_NAME (srcpad));
1372 gst_object_unref (srcpad);
1375 if (GST_PAD_PEER (srcpad) != NULL) {
1376 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is already linked",
1377 GST_DEBUG_PAD_NAME (srcpad));
1378 gst_object_unref (srcpad);
1384 /* no name given, get the first available pad */
1385 GST_OBJECT_LOCK (src);
1386 srcpads = GST_ELEMENT_PADS (src);
1387 srcpad = srcpads ? GST_PAD_CAST (srcpads->data) : NULL;
1389 gst_object_ref (srcpad);
1390 GST_OBJECT_UNLOCK (src);
1393 /* get a destination pad */
1395 /* name specified, look it up */
1396 destpad = gst_element_get_pad (dest, destpadname);
1398 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no pad %s:%s",
1399 GST_ELEMENT_NAME (dest), destpadname);
1402 if (!(GST_PAD_DIRECTION (destpad) == GST_PAD_SINK)) {
1403 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is no sink pad",
1404 GST_DEBUG_PAD_NAME (destpad));
1405 gst_object_unref (destpad);
1408 if (GST_PAD_PEER (destpad) != NULL) {
1409 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "pad %s:%s is already linked",
1410 GST_DEBUG_PAD_NAME (destpad));
1411 gst_object_unref (destpad);
1417 /* no name given, get the first available pad */
1418 GST_OBJECT_LOCK (dest);
1419 destpads = GST_ELEMENT_PADS (dest);
1420 destpad = destpads ? GST_PAD_CAST (destpads->data) : NULL;
1422 gst_object_ref (destpad);
1423 GST_OBJECT_UNLOCK (dest);
1426 if (srcpadname && destpadname) {
1429 /* two explicitly specified pads */
1430 result = pad_link_maybe_ghosting (srcpad, destpad);
1432 gst_object_unref (srcpad);
1433 gst_object_unref (destpad);
1439 /* loop through the allowed pads in the source, trying to find a
1440 * compatible destination pad */
1441 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1442 "looping through allowed src and dest pads");
1444 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying src pad %s:%s",
1445 GST_DEBUG_PAD_NAME (srcpad));
1446 if ((GST_PAD_DIRECTION (srcpad) == GST_PAD_SRC) &&
1447 (GST_PAD_PEER (srcpad) == NULL)) {
1452 gst_object_ref (temp);
1454 temp = gst_element_get_compatible_pad (dest, srcpad, NULL);
1457 if (temp && pad_link_maybe_ghosting (srcpad, temp)) {
1458 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1459 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (temp));
1461 gst_object_unref (destpad);
1462 gst_object_unref (srcpad);
1463 gst_object_unref (temp);
1468 gst_object_unref (temp);
1471 /* find a better way for this mess */
1473 srcpads = g_list_next (srcpads);
1475 gst_object_unref (srcpad);
1476 srcpad = GST_PAD_CAST (srcpads->data);
1477 gst_object_ref (srcpad);
1483 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s:%s to %s",
1484 GST_DEBUG_PAD_NAME (srcpad), GST_ELEMENT_NAME (dest));
1486 gst_object_unref (destpad);
1490 gst_object_unref (srcpad);
1494 /* loop through the existing pads in the destination */
1496 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "trying dest pad %s:%s",
1497 GST_DEBUG_PAD_NAME (destpad));
1498 if ((GST_PAD_DIRECTION (destpad) == GST_PAD_SINK) &&
1499 (GST_PAD_PEER (destpad) == NULL)) {
1500 GstPad *temp = gst_element_get_compatible_pad (src, destpad, NULL);
1502 if (temp && pad_link_maybe_ghosting (temp, destpad)) {
1503 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "linked pad %s:%s to pad %s:%s",
1504 GST_DEBUG_PAD_NAME (temp), GST_DEBUG_PAD_NAME (destpad));
1505 gst_object_unref (temp);
1506 gst_object_unref (destpad);
1510 gst_object_unref (temp);
1514 destpads = g_list_next (destpads);
1516 gst_object_unref (destpad);
1517 destpad = GST_PAD_CAST (destpads->data);
1518 gst_object_ref (destpad);
1525 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s:%s",
1526 GST_ELEMENT_NAME (src), GST_DEBUG_PAD_NAME (destpad));
1527 gst_object_unref (destpad);
1531 gst_object_unref (destpad);
1535 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1536 "we might have request pads on both sides, checking...");
1537 srctempls = gst_element_class_get_pad_template_list (srcclass);
1538 desttempls = gst_element_class_get_pad_template_list (destclass);
1540 if (srctempls && desttempls) {
1542 srctempl = (GstPadTemplate *) srctempls->data;
1543 if (srctempl->presence == GST_PAD_REQUEST) {
1544 for (l = desttempls; l; l = l->next) {
1545 desttempl = (GstPadTemplate *) l->data;
1546 if (desttempl->presence == GST_PAD_REQUEST &&
1547 desttempl->direction != srctempl->direction) {
1548 if (gst_caps_is_always_compatible (gst_pad_template_get_caps
1549 (srctempl), gst_pad_template_get_caps (desttempl))) {
1551 gst_element_get_request_pad (src, srctempl->name_template);
1553 gst_element_get_request_pad (dest, desttempl->name_template);
1554 if (srcpad && destpad
1555 && pad_link_maybe_ghosting (srcpad, destpad)) {
1556 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
1557 "linked pad %s:%s to pad %s:%s",
1558 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (destpad));
1559 gst_object_unref (srcpad);
1560 gst_object_unref (destpad);
1563 /* it failed, so we release the request pads */
1565 gst_element_release_request_pad (src, srcpad);
1567 gst_element_release_request_pad (dest, destpad);
1572 srctempls = srctempls->next;
1576 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "no link possible from %s to %s",
1577 GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
1582 * gst_element_link_pads_filtered:
1583 * @src: a #GstElement containing the source pad.
1584 * @srcpadname: the name of the #GstPad in source element or NULL for any pad.
1585 * @dest: the #GstElement containing the destination pad.
1586 * @destpadname: the name of the #GstPad in destination element or NULL for any pad.
1587 * @filter: the #GstCaps to filter the link, or #NULL for no filter.
1589 * Links the two named pads of the source and destination elements. Side effect
1590 * is that if one of the pads has no parent, it becomes a child of the parent of
1591 * the other element. If they have different parents, the link fails. If @caps
1592 * is not #NULL, makes sure that the caps of the link is a subset of @caps.
1594 * Returns: TRUE if the pads could be linked, FALSE otherwise.
1597 gst_element_link_pads_filtered (GstElement * src, const gchar * srcpadname,
1598 GstElement * dest, const gchar * destpadname, GstCaps * filter)
1601 g_return_val_if_fail (GST_IS_ELEMENT (src), FALSE);
1602 g_return_val_if_fail (GST_IS_ELEMENT (dest), FALSE);
1603 g_return_val_if_fail (filter == NULL || GST_IS_CAPS (filter), FALSE);
1606 GstElement *capsfilter;
1608 GstState state, pending;
1610 capsfilter = gst_element_factory_make ("capsfilter", NULL);
1612 GST_ERROR ("Could not make a capsfilter");
1616 parent = gst_object_get_parent (GST_OBJECT (src));
1617 g_return_val_if_fail (GST_IS_BIN (parent), FALSE);
1619 gst_element_get_state (GST_ELEMENT_CAST (parent), &state, &pending, 0);
1621 if (!gst_bin_add (GST_BIN (parent), capsfilter)) {
1622 GST_ERROR ("Could not add capsfilter");
1623 gst_object_unref (capsfilter);
1624 gst_object_unref (parent);
1628 if (pending != GST_STATE_VOID_PENDING)
1631 gst_element_set_state (capsfilter, state);
1633 gst_object_unref (parent);
1635 g_object_set (capsfilter, "caps", filter, NULL);
1637 if (gst_element_link_pads (src, srcpadname, capsfilter, "sink")
1638 && gst_element_link_pads (capsfilter, "src", dest, destpadname)) {
1641 GST_INFO ("Could not link elements");
1642 gst_element_set_state (capsfilter, GST_STATE_NULL);
1643 /* this will unlink and unref as appropriate */
1644 gst_bin_remove (GST_BIN (GST_OBJECT_PARENT (capsfilter)), capsfilter);
1648 return gst_element_link_pads (src, srcpadname, dest, destpadname);
1654 * @src: a #GstElement containing the source pad.
1655 * @dest: the #GstElement containing the destination pad.
1657 * Links @src to @dest. The link must be from source to
1658 * destination; the other direction will not be tried. The function looks for
1659 * existing pads that aren't linked yet. It will request new pads if necessary.
1660 * Such pads need to be released manualy when unlinking.
1661 * If multiple links are possible, only one is established.
1663 * Make sure you have added your elements to a bin or pipeline with
1664 * gst_bin_add() before trying to link them.
1666 * Returns: TRUE if the elements could be linked, FALSE otherwise.
1669 gst_element_link (GstElement * src, GstElement * dest)
1671 return gst_element_link_pads_filtered (src, NULL, dest, NULL, NULL);
1675 * gst_element_link_many:
1676 * @element_1: the first #GstElement in the link chain.
1677 * @element_2: the second #GstElement in the link chain.
1678 * @...: the NULL-terminated list of elements to link in order.
1680 * Chain together a series of elements. Uses gst_element_link().
1681 * Make sure you have added your elements to a bin or pipeline with
1682 * gst_bin_add() before trying to link them.
1684 * Returns: TRUE on success, FALSE otherwise.
1687 gst_element_link_many (GstElement * element_1, GstElement * element_2, ...)
1691 g_return_val_if_fail (GST_IS_ELEMENT (element_1), FALSE);
1692 g_return_val_if_fail (GST_IS_ELEMENT (element_2), FALSE);
1694 va_start (args, element_2);
1697 if (!gst_element_link (element_1, element_2))
1700 element_1 = element_2;
1701 element_2 = va_arg (args, GstElement *);
1710 * gst_element_link_filtered:
1711 * @src: a #GstElement containing the source pad.
1712 * @dest: the #GstElement containing the destination pad.
1713 * @filter: the #GstCaps to filter the link, or #NULL for no filter.
1715 * Links @src to @dest using the given caps as filtercaps.
1716 * The link must be from source to
1717 * destination; the other direction will not be tried. The function looks for
1718 * existing pads that aren't linked yet. It will request new pads if necessary.
1719 * If multiple links are possible, only one is established.
1721 * Make sure you have added your elements to a bin or pipeline with
1722 * gst_bin_add() before trying to link them.
1724 * Returns: TRUE if the pads could be linked, FALSE otherwise.
1727 gst_element_link_filtered (GstElement * src, GstElement * dest,
1730 return gst_element_link_pads_filtered (src, NULL, dest, NULL, filter);
1734 * gst_element_unlink_pads:
1735 * @src: a #GstElement containing the source pad.
1736 * @srcpadname: the name of the #GstPad in source element.
1737 * @dest: a #GstElement containing the destination pad.
1738 * @destpadname: the name of the #GstPad in destination element.
1740 * Unlinks the two named pads of the source and destination elements.
1743 gst_element_unlink_pads (GstElement * src, const gchar * srcpadname,
1744 GstElement * dest, const gchar * destpadname)
1746 GstPad *srcpad, *destpad;
1748 g_return_if_fail (src != NULL);
1749 g_return_if_fail (GST_IS_ELEMENT (src));
1750 g_return_if_fail (srcpadname != NULL);
1751 g_return_if_fail (dest != NULL);
1752 g_return_if_fail (GST_IS_ELEMENT (dest));
1753 g_return_if_fail (destpadname != NULL);
1755 /* obtain the pads requested */
1756 srcpad = gst_element_get_pad (src, srcpadname);
1757 if (srcpad == NULL) {
1758 GST_WARNING_OBJECT (src, "source element has no pad \"%s\"", srcpadname);
1761 destpad = gst_element_get_pad (dest, destpadname);
1762 if (destpad == NULL) {
1763 GST_WARNING_OBJECT (dest, "destination element has no pad \"%s\"",
1765 gst_object_unref (srcpad);
1769 /* we're satisified they can be unlinked, let's do it */
1770 gst_pad_unlink (srcpad, destpad);
1771 gst_object_unref (srcpad);
1772 gst_object_unref (destpad);
1776 * gst_element_unlink_many:
1777 * @element_1: the first #GstElement in the link chain.
1778 * @element_2: the second #GstElement in the link chain.
1779 * @...: the NULL-terminated list of elements to unlink in order.
1781 * Unlinks a series of elements. Uses gst_element_unlink().
1784 gst_element_unlink_many (GstElement * element_1, GstElement * element_2, ...)
1788 g_return_if_fail (element_1 != NULL && element_2 != NULL);
1789 g_return_if_fail (GST_IS_ELEMENT (element_1) && GST_IS_ELEMENT (element_2));
1791 va_start (args, element_2);
1794 gst_element_unlink (element_1, element_2);
1796 element_1 = element_2;
1797 element_2 = va_arg (args, GstElement *);
1804 * gst_element_unlink:
1805 * @src: the source #GstElement to unlink.
1806 * @dest: the sink #GstElement to unlink.
1808 * Unlinks all source pads of the source element with all sink pads
1809 * of the sink element to which they are linked.
1811 * If the link has been made using gst_element_link(), it could have created an
1812 * requestpad, which has to be released using gst_element_release_request_pad().
1815 gst_element_unlink (GstElement * src, GstElement * dest)
1818 gboolean done = FALSE;
1820 g_return_if_fail (GST_IS_ELEMENT (src));
1821 g_return_if_fail (GST_IS_ELEMENT (dest));
1823 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS, "unlinking \"%s\" and \"%s\"",
1824 GST_ELEMENT_NAME (src), GST_ELEMENT_NAME (dest));
1826 pads = gst_element_iterate_pads (src);
1830 switch (gst_iterator_next (pads, &data)) {
1831 case GST_ITERATOR_OK:
1833 GstPad *pad = GST_PAD_CAST (data);
1835 if (GST_PAD_IS_SRC (pad)) {
1836 GstPad *peerpad = gst_pad_get_peer (pad);
1838 /* see if the pad is connected and is really a pad
1841 GstElement *peerelem;
1843 peerelem = gst_pad_get_parent_element (peerpad);
1845 if (peerelem == dest) {
1846 gst_pad_unlink (pad, peerpad);
1849 gst_object_unref (peerelem);
1851 gst_object_unref (peerpad);
1854 gst_object_unref (pad);
1857 case GST_ITERATOR_RESYNC:
1858 gst_iterator_resync (pads);
1860 case GST_ITERATOR_DONE:
1864 g_assert_not_reached ();
1868 gst_iterator_free (pads);
1872 * gst_element_query_position:
1873 * @element: a #GstElement to invoke the position query on.
1874 * @format: a pointer to the #GstFormat asked for.
1875 * On return contains the #GstFormat used.
1876 * @cur: A location in which to store the current position, or NULL.
1878 * Queries an element for the stream position.
1880 * Returns: TRUE if the query could be performed.
1883 gst_element_query_position (GstElement * element, GstFormat * format,
1889 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1890 g_return_val_if_fail (format != NULL, FALSE);
1892 query = gst_query_new_position (*format);
1893 ret = gst_element_query (element, query);
1896 gst_query_parse_position (query, format, cur);
1898 gst_query_unref (query);
1904 * gst_element_query_duration:
1905 * @element: a #GstElement to invoke the duration query on.
1906 * @format: a pointer to the #GstFormat asked for.
1907 * On return contains the #GstFormat used.
1908 * @duration: A location in which to store the total duration, or NULL.
1910 * Queries an element for the total stream duration.
1912 * Returns: TRUE if the query could be performed.
1915 gst_element_query_duration (GstElement * element, GstFormat * format,
1921 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1922 g_return_val_if_fail (format != NULL, FALSE);
1924 query = gst_query_new_duration (*format);
1925 ret = gst_element_query (element, query);
1928 gst_query_parse_duration (query, format, duration);
1930 gst_query_unref (query);
1936 * gst_element_query_convert:
1937 * @element: a #GstElement to invoke the convert query on.
1938 * @src_format: a #GstFormat to convert from.
1939 * @src_val: a value to convert.
1940 * @dest_format: a pointer to the #GstFormat to convert to.
1941 * @dest_val: a pointer to the result.
1943 * Queries an element to convert @src_val in @src_format to @dest_format.
1945 * Returns: TRUE if the query could be performed.
1948 gst_element_query_convert (GstElement * element, GstFormat src_format,
1949 gint64 src_val, GstFormat * dest_format, gint64 * dest_val)
1954 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
1955 g_return_val_if_fail (dest_format != NULL, FALSE);
1956 g_return_val_if_fail (dest_val != NULL, FALSE);
1958 if (*dest_format == src_format) {
1959 *dest_val = src_val;
1963 query = gst_query_new_convert (src_format, src_val, *dest_format);
1964 ret = gst_element_query (element, query);
1967 gst_query_parse_convert (query, NULL, NULL, dest_format, dest_val);
1969 gst_query_unref (query);
1975 * gst_element_seek_simple
1976 * @element: a #GstElement to seek on
1977 * @format: a #GstFormat to execute the seek in, such as #GST_FORMAT_TIME
1978 * @seek_flags: seek options; playback applications will usually want to use
1979 * GST_SEEK_FLAG_FLUSH | GST_SEEK_FLAG_KEY_UNIT here
1980 * @seek_pos: position to seek to (relative to the start); if you are doing
1981 * a seek in #GST_FORMAT_TIME this value is in nanoseconds -
1982 * multiply with #GST_SECOND to convert seconds to nanoseconds or
1983 * with #GST_MSECOND to convert milliseconds to nanoseconds.
1985 * Simple API to perform a seek on the given element, meaning it just seeks
1986 * to the given position relative to the start of the stream. For more complex
1987 * operations like segment seeks (e.g. for looping) or changing the playback
1988 * rate or seeking relative to the last configured playback segment you should
1989 * use gst_element_seek().
1991 * In a completely prerolled PAUSED or PLAYING pipeline, seeking is always
1992 * guaranteed to return %TRUE on a seekable media type or %FALSE when the media
1993 * type is certainly not seekable (such as a live stream).
1995 * Some elements allow for seeking in the READY state, in this
1996 * case they will store the seek event and execute it when they are put to
1997 * PAUSED. If the element supports seek in READY, it will always return %TRUE when
1998 * it receives the event in the READY state.
2000 * Returns: %TRUE if the seek operation succeeded (the seek might not always be
2001 * executed instantly though)
2006 gst_element_seek_simple (GstElement * element, GstFormat format,
2007 GstSeekFlags seek_flags, gint64 seek_pos)
2009 g_return_val_if_fail (GST_IS_ELEMENT (element), FALSE);
2010 g_return_val_if_fail (seek_pos >= 0, FALSE);
2012 return gst_element_seek (element, 1.0, format, seek_flags,
2013 GST_SEEK_TYPE_SET, seek_pos, GST_SEEK_TYPE_NONE, 0);
2018 * @srcpad: the source #GstPad to link.
2019 * @sinkpad: the sink #GstPad to link.
2021 * Checks if the source pad and the sink pad can be linked.
2022 * Both @srcpad and @sinkpad must be unlinked.
2024 * Returns: TRUE if the pads can be linked, FALSE otherwise.
2027 gst_pad_can_link (GstPad * srcpad, GstPad * sinkpad)
2029 /* FIXME This function is gross. It's almost a direct copy of
2030 * gst_pad_link_filtered(). Any decent programmer would attempt
2031 * to merge the two functions, which I will do some day. --ds
2034 /* generic checks */
2035 g_return_val_if_fail (GST_IS_PAD (srcpad), FALSE);
2036 g_return_val_if_fail (GST_IS_PAD (sinkpad), FALSE);
2038 GST_CAT_INFO (GST_CAT_PADS, "trying to link %s:%s and %s:%s",
2039 GST_DEBUG_PAD_NAME (srcpad), GST_DEBUG_PAD_NAME (sinkpad));
2041 /* FIXME: shouldn't we convert this to g_return_val_if_fail? */
2042 if (GST_PAD_PEER (srcpad) != NULL) {
2043 GST_CAT_INFO (GST_CAT_PADS, "Source pad %s:%s has a peer, failed",
2044 GST_DEBUG_PAD_NAME (srcpad));
2047 if (GST_PAD_PEER (sinkpad) != NULL) {
2048 GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has a peer, failed",
2049 GST_DEBUG_PAD_NAME (sinkpad));
2052 if (!GST_PAD_IS_SRC (srcpad)) {
2053 GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s is not source pad, failed",
2054 GST_DEBUG_PAD_NAME (srcpad));
2057 if (!GST_PAD_IS_SINK (sinkpad)) {
2058 GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s is not sink pad, failed",
2059 GST_DEBUG_PAD_NAME (sinkpad));
2062 if (GST_PAD_PARENT (srcpad) == NULL) {
2063 GST_CAT_INFO (GST_CAT_PADS, "Src pad %s:%s has no parent, failed",
2064 GST_DEBUG_PAD_NAME (srcpad));
2067 if (GST_PAD_PARENT (sinkpad) == NULL) {
2068 GST_CAT_INFO (GST_CAT_PADS, "Sink pad %s:%s has no parent, failed",
2069 GST_DEBUG_PAD_NAME (srcpad));
2077 * gst_pad_use_fixed_caps:
2078 * @pad: the pad to use
2080 * A helper function you can use that sets the
2081 * @gst_pad_get_fixed_caps_func as the getcaps function for the
2082 * pad. This way the function will always return the negotiated caps
2083 * or in case the pad is not negotiated, the padtemplate caps.
2085 * Use this function on a pad that, once _set_caps() has been called
2086 * on it, cannot be renegotiated to something else.
2089 gst_pad_use_fixed_caps (GstPad * pad)
2091 gst_pad_set_getcaps_function (pad, gst_pad_get_fixed_caps_func);
2095 * gst_pad_get_fixed_caps_func:
2096 * @pad: the pad to use
2098 * A helper function you can use as a GetCaps function that
2099 * will return the currently negotiated caps or the padtemplate
2102 * Returns: The currently negotiated caps or the padtemplate.
2105 gst_pad_get_fixed_caps_func (GstPad * pad)
2109 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2111 GST_OBJECT_LOCK (pad);
2112 if (GST_PAD_CAPS (pad)) {
2113 result = GST_PAD_CAPS (pad);
2115 GST_CAT_DEBUG (GST_CAT_CAPS,
2116 "using pad caps %p %" GST_PTR_FORMAT, result, result);
2118 result = gst_caps_ref (result);
2121 if (GST_PAD_PAD_TEMPLATE (pad)) {
2122 GstPadTemplate *templ = GST_PAD_PAD_TEMPLATE (pad);
2124 result = GST_PAD_TEMPLATE_CAPS (templ);
2125 GST_CAT_DEBUG (GST_CAT_CAPS,
2126 "using pad template %p with caps %p %" GST_PTR_FORMAT, templ, result,
2129 result = gst_caps_ref (result);
2132 GST_CAT_DEBUG (GST_CAT_CAPS, "pad has no caps");
2133 result = gst_caps_new_empty ();
2136 GST_OBJECT_UNLOCK (pad);
2142 * gst_pad_get_parent_element:
2145 * Gets the parent of @pad, cast to a #GstElement. If a @pad has no parent or
2146 * its parent is not an element, return NULL.
2148 * Returns: The parent of the pad. The caller has a reference on the parent, so
2149 * unref when you're finished with it.
2154 gst_pad_get_parent_element (GstPad * pad)
2158 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2160 p = gst_object_get_parent (GST_OBJECT_CAST (pad));
2162 if (p && !GST_IS_ELEMENT (p)) {
2163 gst_object_unref (p);
2166 return GST_ELEMENT_CAST (p);
2170 * gst_object_default_error:
2171 * @source: the #GstObject that initiated the error.
2172 * @error: the GError.
2173 * @debug: an additional debug information string, or NULL.
2175 * A default error function.
2177 * The default handler will simply print the error string using g_print.
2180 gst_object_default_error (GstObject * source, GError * error, gchar * debug)
2182 gchar *name = gst_object_get_path_string (source);
2184 g_print (_("ERROR: from element %s: %s\n"), name, error->message);
2186 g_print (_("Additional debug info:\n%s\n"), debug);
2194 * @element_1: the #GstElement element to add to the bin
2195 * @...: additional elements to add to the bin
2197 * Adds a NULL-terminated list of elements to a bin. This function is
2198 * equivalent to calling gst_bin_add() for each member of the list. The return
2199 * value of each gst_bin_add() is ignored.
2202 gst_bin_add_many (GstBin * bin, GstElement * element_1, ...)
2206 g_return_if_fail (GST_IS_BIN (bin));
2207 g_return_if_fail (GST_IS_ELEMENT (element_1));
2209 va_start (args, element_1);
2212 gst_bin_add (bin, element_1);
2214 element_1 = va_arg (args, GstElement *);
2221 * gst_bin_remove_many:
2223 * @element_1: the first #GstElement to remove from the bin
2224 * @...: NULL-terminated list of elements to remove from the bin
2226 * Remove a list of elements from a bin. This function is equivalent
2227 * to calling gst_bin_remove() with each member of the list.
2230 gst_bin_remove_many (GstBin * bin, GstElement * element_1, ...)
2234 g_return_if_fail (GST_IS_BIN (bin));
2235 g_return_if_fail (GST_IS_ELEMENT (element_1));
2237 va_start (args, element_1);
2240 gst_bin_remove (bin, element_1);
2242 element_1 = va_arg (args, GstElement *);
2249 gst_element_populate_std_props (GObjectClass * klass, const gchar * prop_name,
2250 guint arg_id, GParamFlags flags)
2252 GQuark prop_id = g_quark_from_string (prop_name);
2255 static GQuark fd_id = 0;
2256 static GQuark blocksize_id;
2257 static GQuark bytesperread_id;
2258 static GQuark dump_id;
2259 static GQuark filesize_id;
2260 static GQuark mmapsize_id;
2261 static GQuark location_id;
2262 static GQuark offset_id;
2263 static GQuark silent_id;
2264 static GQuark touch_id;
2267 fd_id = g_quark_from_static_string ("fd");
2268 blocksize_id = g_quark_from_static_string ("blocksize");
2269 bytesperread_id = g_quark_from_static_string ("bytesperread");
2270 dump_id = g_quark_from_static_string ("dump");
2271 filesize_id = g_quark_from_static_string ("filesize");
2272 mmapsize_id = g_quark_from_static_string ("mmapsize");
2273 location_id = g_quark_from_static_string ("location");
2274 offset_id = g_quark_from_static_string ("offset");
2275 silent_id = g_quark_from_static_string ("silent");
2276 touch_id = g_quark_from_static_string ("touch");
2279 if (prop_id == fd_id) {
2280 pspec = g_param_spec_int ("fd", "File-descriptor",
2281 "File-descriptor for the file being read", 0, G_MAXINT, 0, flags);
2282 } else if (prop_id == blocksize_id) {
2283 pspec = g_param_spec_ulong ("blocksize", "Block Size",
2284 "Block size to read per buffer", 0, G_MAXULONG, 4096, flags);
2286 } else if (prop_id == bytesperread_id) {
2287 pspec = g_param_spec_int ("bytesperread", "Bytes per read",
2288 "Number of bytes to read per buffer", G_MININT, G_MAXINT, 0, flags);
2290 } else if (prop_id == dump_id) {
2291 pspec = g_param_spec_boolean ("dump", "Dump",
2292 "Dump bytes to stdout", FALSE, flags);
2294 } else if (prop_id == filesize_id) {
2295 pspec = g_param_spec_int64 ("filesize", "File Size",
2296 "Size of the file being read", 0, G_MAXINT64, 0, flags);
2298 } else if (prop_id == mmapsize_id) {
2299 pspec = g_param_spec_ulong ("mmapsize", "mmap() Block Size",
2300 "Size in bytes of mmap()d regions", 0, G_MAXULONG, 4 * 1048576, flags);
2302 } else if (prop_id == location_id) {
2303 pspec = g_param_spec_string ("location", "File Location",
2304 "Location of the file to read", NULL, flags);
2306 } else if (prop_id == offset_id) {
2307 pspec = g_param_spec_int64 ("offset", "File Offset",
2308 "Byte offset of current read pointer", 0, G_MAXINT64, 0, flags);
2310 } else if (prop_id == silent_id) {
2311 pspec = g_param_spec_boolean ("silent", "Silent", "Don't produce events",
2314 } else if (prop_id == touch_id) {
2315 pspec = g_param_spec_boolean ("touch", "Touch read data",
2316 "Touch data to force disk read before " "push ()", TRUE, flags);
2318 g_warning ("Unknown - 'standard' property '%s' id %d from klass %s",
2319 prop_name, arg_id, g_type_name (G_OBJECT_CLASS_TYPE (klass)));
2324 g_object_class_install_property (klass, arg_id, pspec);
2329 * gst_element_class_install_std_props:
2330 * @klass: the #GstElementClass to add the properties to.
2331 * @first_name: the name of the first property.
2332 * in a NULL terminated
2333 * @...: the id and flags of the first property, followed by
2334 * further 'name', 'id', 'flags' triplets and terminated by NULL.
2336 * Adds a list of standardized properties with types to the @klass.
2337 * the id is for the property switch in your get_prop method, and
2338 * the flags determine readability / writeability.
2341 gst_element_class_install_std_props (GstElementClass * klass,
2342 const gchar * first_name, ...)
2348 g_return_if_fail (GST_IS_ELEMENT_CLASS (klass));
2350 va_start (args, first_name);
2355 int arg_id = va_arg (args, int);
2356 int flags = va_arg (args, int);
2358 gst_element_populate_std_props ((GObjectClass *) klass, name, arg_id,
2361 name = va_arg (args, char *);
2370 * @buf1: the first source #GstBuffer to merge.
2371 * @buf2: the second source #GstBuffer to merge.
2373 * Create a new buffer that is the concatenation of the two source
2374 * buffers. The original source buffers will not be modified or
2375 * unref'd. Make sure you unref the source buffers if they are not used
2376 * anymore afterwards.
2378 * If the buffers point to contiguous areas of memory, the buffer
2379 * is created without copying the data.
2381 * Returns: the new #GstBuffer which is the concatenation of the source buffers.
2384 gst_buffer_merge (GstBuffer * buf1, GstBuffer * buf2)
2388 /* we're just a specific case of the more general gst_buffer_span() */
2389 result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
2396 * @buf1: the first source #GstBuffer.
2397 * @buf2: the second source #GstBuffer.
2399 * Create a new buffer that is the concatenation of the two source
2400 * buffers, and unrefs the original source buffers.
2402 * If the buffers point to contiguous areas of memory, the buffer
2403 * is created without copying the data.
2405 * Returns: the new #GstBuffer which is the concatenation of the source buffers.
2408 gst_buffer_join (GstBuffer * buf1, GstBuffer * buf2)
2412 result = gst_buffer_span (buf1, 0, buf2, buf1->size + buf2->size);
2413 gst_buffer_unref (buf1);
2414 gst_buffer_unref (buf2);
2422 * @dest: buffer to stamp
2423 * @src: buffer to stamp from
2425 * Copies additional information (the timestamp, duration, and offset start
2426 * and end) from one buffer to the other.
2428 * This function does not copy any buffer flags or caps and is equivalent to
2429 * gst_buffer_copy_metadata(@dest, @src, GST_BUFFER_COPY_TIMESTAMPS).
2431 * Deprecated: use gst_buffer_copy_metadata() instead, it provides more
2434 #ifndef GST_REMOVE_DEPRECATED
2436 gst_buffer_stamp (GstBuffer * dest, const GstBuffer * src)
2438 gst_buffer_copy_metadata (dest, src, GST_BUFFER_COPY_TIMESTAMPS);
2443 intersect_caps_func (GstPad * pad, GValue * ret, GstPad * orig)
2446 GstCaps *peercaps, *existing;
2448 existing = g_value_get_pointer (ret);
2449 peercaps = gst_pad_peer_get_caps (pad);
2450 if (peercaps == NULL)
2451 peercaps = gst_caps_new_any ();
2452 g_value_set_pointer (ret, gst_caps_intersect (existing, peercaps));
2453 gst_caps_unref (existing);
2454 gst_caps_unref (peercaps);
2456 gst_object_unref (pad);
2461 * gst_pad_proxy_getcaps:
2462 * @pad: a #GstPad to proxy.
2464 * Calls gst_pad_get_allowed_caps() for every other pad belonging to the
2465 * same element as @pad, and returns the intersection of the results.
2467 * This function is useful as a default getcaps function for an element
2468 * that can handle any stream format, but requires all its pads to have
2469 * the same caps. Two such elements are tee and aggregator.
2471 * Returns: the intersection of the other pads' allowed caps.
2474 gst_pad_proxy_getcaps (GstPad * pad)
2476 GstElement *element;
2477 GstCaps *caps, *intersected;
2479 GstIteratorResult res;
2480 GValue ret = { 0, };
2482 g_return_val_if_fail (GST_IS_PAD (pad), NULL);
2484 GST_DEBUG ("proxying getcaps for %s:%s", GST_DEBUG_PAD_NAME (pad));
2486 element = gst_pad_get_parent_element (pad);
2487 if (element == NULL)
2490 /* value to hold the return, by default it holds ANY, the ref is taken by
2492 g_value_init (&ret, G_TYPE_POINTER);
2493 g_value_set_pointer (&ret, gst_caps_new_any ());
2495 iter = gst_element_iterate_pads (element);
2498 gst_iterator_fold (iter, (GstIteratorFoldFunction) intersect_caps_func,
2501 case GST_ITERATOR_RESYNC:
2502 /* unref any value stored */
2503 if ((caps = g_value_get_pointer (&ret)))
2504 gst_caps_unref (caps);
2505 /* need to reset the result again to ANY */
2506 g_value_set_pointer (&ret, gst_caps_new_any ());
2507 gst_iterator_resync (iter);
2509 case GST_ITERATOR_DONE:
2510 /* all pads iterated, return collected value */
2513 /* iterator returned _ERROR or premature end with _OK,
2514 * mark an error and exit */
2515 if ((caps = g_value_get_pointer (&ret)))
2516 gst_caps_unref (caps);
2517 g_value_set_pointer (&ret, NULL);
2522 gst_iterator_free (iter);
2524 gst_object_unref (element);
2526 caps = g_value_get_pointer (&ret);
2527 g_value_unset (&ret);
2529 intersected = gst_caps_intersect (caps, gst_pad_get_pad_template_caps (pad));
2530 gst_caps_unref (caps);
2537 g_warning ("Pad list returned error on element %s",
2538 GST_ELEMENT_NAME (element));
2539 gst_iterator_free (iter);
2540 gst_object_unref (element);
2552 link_fold_func (GstPad * pad, GValue * ret, LinkData * data)
2554 gboolean success = TRUE;
2556 if (pad != data->orig) {
2557 success = gst_pad_set_caps (pad, data->caps);
2558 g_value_set_boolean (ret, success);
2560 gst_object_unref (pad);
2566 * gst_pad_proxy_setcaps
2567 * @pad: a #GstPad to proxy from
2568 * @caps: the #GstCaps to link with
2570 * Calls gst_pad_set_caps() for every other pad belonging to the
2571 * same element as @pad. If gst_pad_set_caps() fails on any pad,
2572 * the proxy setcaps fails. May be used only during negotiation.
2574 * Returns: TRUE if sucessful
2577 gst_pad_proxy_setcaps (GstPad * pad, GstCaps * caps)
2579 GstElement *element;
2581 GstIteratorResult res;
2582 GValue ret = { 0, };
2585 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2586 g_return_val_if_fail (caps != NULL, FALSE);
2588 GST_DEBUG ("proxying pad link for %s:%s", GST_DEBUG_PAD_NAME (pad));
2590 element = gst_pad_get_parent_element (pad);
2591 if (element == NULL)
2594 iter = gst_element_iterate_pads (element);
2596 g_value_init (&ret, G_TYPE_BOOLEAN);
2597 g_value_set_boolean (&ret, TRUE);
2601 res = gst_iterator_fold (iter, (GstIteratorFoldFunction) link_fold_func,
2603 gst_iterator_free (iter);
2605 if (res != GST_ITERATOR_DONE)
2608 gst_object_unref (element);
2610 /* ok not to unset the gvalue */
2611 return g_value_get_boolean (&ret);
2616 g_warning ("Pad list changed during proxy_pad_link for element %s",
2617 GST_ELEMENT_NAME (element));
2618 gst_object_unref (element);
2624 * gst_pad_query_position:
2625 * @pad: a #GstPad to invoke the position query on.
2626 * @format: a pointer to the #GstFormat asked for.
2627 * On return contains the #GstFormat used.
2628 * @cur: A location in which to store the current position, or NULL.
2630 * Queries a pad for the stream position.
2632 * Returns: TRUE if the query could be performed.
2635 gst_pad_query_position (GstPad * pad, GstFormat * format, gint64 * cur)
2640 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2641 g_return_val_if_fail (format != NULL, FALSE);
2643 query = gst_query_new_position (*format);
2644 ret = gst_pad_query (pad, query);
2647 gst_query_parse_position (query, format, cur);
2649 gst_query_unref (query);
2655 * gst_pad_query_peer_position:
2656 * @pad: a #GstPad on whose peer to invoke the position query on.
2657 * Must be a sink pad.
2658 * @format: a pointer to the #GstFormat asked for.
2659 * On return contains the #GstFormat used.
2660 * @cur: A location in which to store the current position, or NULL.
2662 * Queries the peer of a given sink pad for the stream position.
2664 * Returns: TRUE if the query could be performed.
2667 gst_pad_query_peer_position (GstPad * pad, GstFormat * format, gint64 * cur)
2669 gboolean ret = FALSE;
2672 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2673 g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2674 g_return_val_if_fail (format != NULL, FALSE);
2676 peer = gst_pad_get_peer (pad);
2678 ret = gst_pad_query_position (peer, format, cur);
2679 gst_object_unref (peer);
2686 * gst_pad_query_duration:
2687 * @pad: a #GstPad to invoke the duration query on.
2688 * @format: a pointer to the #GstFormat asked for.
2689 * On return contains the #GstFormat used.
2690 * @duration: A location in which to store the total duration, or NULL.
2692 * Queries a pad for the total stream duration.
2694 * Returns: TRUE if the query could be performed.
2697 gst_pad_query_duration (GstPad * pad, GstFormat * format, gint64 * duration)
2702 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2703 g_return_val_if_fail (format != NULL, FALSE);
2705 query = gst_query_new_duration (*format);
2706 ret = gst_pad_query (pad, query);
2709 gst_query_parse_duration (query, format, duration);
2711 gst_query_unref (query);
2717 * gst_pad_query_peer_duration:
2718 * @pad: a #GstPad on whose peer pad to invoke the duration query on.
2719 * Must be a sink pad.
2720 * @format: a pointer to the #GstFormat asked for.
2721 * On return contains the #GstFormat used.
2722 * @duration: A location in which to store the total duration, or NULL.
2724 * Queries the peer pad of a given sink pad for the total stream duration.
2726 * Returns: TRUE if the query could be performed.
2729 gst_pad_query_peer_duration (GstPad * pad, GstFormat * format,
2732 gboolean ret = FALSE;
2735 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2736 g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2737 g_return_val_if_fail (format != NULL, FALSE);
2739 peer = gst_pad_get_peer (pad);
2741 ret = gst_pad_query_duration (peer, format, duration);
2742 gst_object_unref (peer);
2749 * gst_pad_query_convert:
2750 * @pad: a #GstPad to invoke the convert query on.
2751 * @src_format: a #GstFormat to convert from.
2752 * @src_val: a value to convert.
2753 * @dest_format: a pointer to the #GstFormat to convert to.
2754 * @dest_val: a pointer to the result.
2756 * Queries a pad to convert @src_val in @src_format to @dest_format.
2758 * Returns: TRUE if the query could be performed.
2761 gst_pad_query_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2762 GstFormat * dest_format, gint64 * dest_val)
2767 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2768 g_return_val_if_fail (src_val >= 0, FALSE);
2769 g_return_val_if_fail (dest_format != NULL, FALSE);
2770 g_return_val_if_fail (dest_val != NULL, FALSE);
2772 if (*dest_format == src_format) {
2773 *dest_val = src_val;
2777 query = gst_query_new_convert (src_format, src_val, *dest_format);
2778 ret = gst_pad_query (pad, query);
2781 gst_query_parse_convert (query, NULL, NULL, dest_format, dest_val);
2783 gst_query_unref (query);
2789 * gst_pad_query_peer_convert:
2790 * @pad: a #GstPad, on whose peer pad to invoke the convert query on.
2791 * Must be a sink pad.
2792 * @src_format: a #GstFormat to convert from.
2793 * @src_val: a value to convert.
2794 * @dest_format: a pointer to the #GstFormat to convert to.
2795 * @dest_val: a pointer to the result.
2797 * Queries the peer pad of a given sink pad to convert @src_val in @src_format
2800 * Returns: TRUE if the query could be performed.
2803 gst_pad_query_peer_convert (GstPad * pad, GstFormat src_format, gint64 src_val,
2804 GstFormat * dest_format, gint64 * dest_val)
2806 gboolean ret = FALSE;
2809 g_return_val_if_fail (GST_IS_PAD (pad), FALSE);
2810 g_return_val_if_fail (GST_PAD_IS_SINK (pad), FALSE);
2811 g_return_val_if_fail (src_val >= 0, FALSE);
2812 g_return_val_if_fail (dest_format != NULL, FALSE);
2813 g_return_val_if_fail (dest_val != NULL, FALSE);
2815 peer = gst_pad_get_peer (pad);
2817 ret = gst_pad_query_convert (peer, src_format, src_val, dest_format,
2819 gst_object_unref (peer);
2826 * gst_atomic_int_set:
2827 * @atomic_int: pointer to an atomic integer
2828 * @value: value to set
2830 * Unconditionally sets the atomic integer to @value.
2833 gst_atomic_int_set (gint * atomic_int, gint value)
2837 *atomic_int = value;
2838 /* read acts as a memory barrier */
2839 ignore = g_atomic_int_get (atomic_int);
2843 * gst_pad_add_data_probe:
2844 * @pad: pad to add the data probe handler to
2845 * @handler: function to call when data is passed over pad
2846 * @data: data to pass along with the handler
2848 * Adds a "data probe" to a pad. This function will be called whenever data
2849 * passes through a pad. In this case data means both events and buffers. The
2850 * probe will be called with the data as an argument, meaning @handler should
2851 * have the same callback signature as the 'have-data' signal of #GstPad.
2852 * Note that the data will have a reference count greater than 1, so it will
2853 * be immutable -- you must not change it.
2855 * For source pads, the probe will be called after the blocking function, if any
2856 * (see gst_pad_set_blocked_async()), but before looking up the peer to chain
2857 * to. For sink pads, the probe function will be called before configuring the
2858 * sink with new caps, if any, and before calling the pad's chain function.
2860 * Your data probe should return TRUE to let the data continue to flow, or FALSE
2861 * to drop it. Dropping data is rarely useful, but occasionally comes in handy
2864 * Although probes are implemented internally by connecting @handler to the
2865 * have-data signal on the pad, if you want to remove a probe it is insufficient
2866 * to only call g_signal_handler_disconnect on the returned handler id. To
2867 * remove a probe, use the appropriate function, such as
2868 * gst_pad_remove_data_probe().
2870 * Returns: The handler id.
2873 gst_pad_add_data_probe (GstPad * pad, GCallback handler, gpointer data)
2877 g_return_val_if_fail (GST_IS_PAD (pad), 0);
2878 g_return_val_if_fail (handler != NULL, 0);
2880 GST_OBJECT_LOCK (pad);
2881 sigid = g_signal_connect (pad, "have-data", handler, data);
2882 GST_PAD_DO_EVENT_SIGNALS (pad)++;
2883 GST_PAD_DO_BUFFER_SIGNALS (pad)++;
2884 GST_DEBUG ("adding data probe to pad %s:%s, now %d data, %d event probes",
2885 GST_DEBUG_PAD_NAME (pad),
2886 GST_PAD_DO_BUFFER_SIGNALS (pad), GST_PAD_DO_EVENT_SIGNALS (pad));
2887 GST_OBJECT_UNLOCK (pad);
2893 * gst_pad_add_event_probe:
2894 * @pad: pad to add the event probe handler to
2895 * @handler: function to call when data is passed over pad
2896 * @data: data to pass along with the handler
2898 * Adds a probe that will be called for all events passing through a pad. See
2899 * gst_pad_add_data_probe() for more information.
2901 * Returns: The handler id
2904 gst_pad_add_event_probe (GstPad * pad, GCallback handler, gpointer data)
2908 g_return_val_if_fail (GST_IS_PAD (pad), 0);
2909 g_return_val_if_fail (handler != NULL, 0);
2911 GST_OBJECT_LOCK (pad);
2912 sigid = g_signal_connect (pad, "have-data::event", handler, data);
2913 GST_PAD_DO_EVENT_SIGNALS (pad)++;
2914 GST_DEBUG ("adding event probe to pad %s:%s, now %d probes",
2915 GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_EVENT_SIGNALS (pad));
2916 GST_OBJECT_UNLOCK (pad);
2922 * gst_pad_add_buffer_probe:
2923 * @pad: pad to add the buffer probe handler to
2924 * @handler: function to call when data is passed over pad
2925 * @data: data to pass along with the handler
2927 * Adds a probe that will be called for all buffers passing through a pad. See
2928 * gst_pad_add_data_probe() for more information.
2930 * Returns: The handler id
2933 gst_pad_add_buffer_probe (GstPad * pad, GCallback handler, gpointer data)
2937 g_return_val_if_fail (GST_IS_PAD (pad), 0);
2938 g_return_val_if_fail (handler != NULL, 0);
2940 GST_OBJECT_LOCK (pad);
2941 sigid = g_signal_connect (pad, "have-data::buffer", handler, data);
2942 GST_PAD_DO_BUFFER_SIGNALS (pad)++;
2943 GST_DEBUG ("adding buffer probe to pad %s:%s, now %d probes",
2944 GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_BUFFER_SIGNALS (pad));
2945 GST_OBJECT_UNLOCK (pad);
2951 * gst_pad_remove_data_probe:
2952 * @pad: pad to remove the data probe handler from
2953 * @handler_id: handler id returned from gst_pad_add_data_probe
2955 * Removes a data probe from @pad.
2958 gst_pad_remove_data_probe (GstPad * pad, guint handler_id)
2960 g_return_if_fail (GST_IS_PAD (pad));
2961 g_return_if_fail (handler_id > 0);
2963 GST_OBJECT_LOCK (pad);
2964 g_signal_handler_disconnect (pad, handler_id);
2965 GST_PAD_DO_BUFFER_SIGNALS (pad)--;
2966 GST_PAD_DO_EVENT_SIGNALS (pad)--;
2968 ("removed data probe from pad %s:%s, now %d event, %d buffer probes",
2969 GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_EVENT_SIGNALS (pad),
2970 GST_PAD_DO_BUFFER_SIGNALS (pad));
2971 GST_OBJECT_UNLOCK (pad);
2976 * gst_pad_remove_event_probe:
2977 * @pad: pad to remove the event probe handler from
2978 * @handler_id: handler id returned from gst_pad_add_event_probe
2980 * Removes an event probe from @pad.
2983 gst_pad_remove_event_probe (GstPad * pad, guint handler_id)
2985 g_return_if_fail (GST_IS_PAD (pad));
2986 g_return_if_fail (handler_id > 0);
2988 GST_OBJECT_LOCK (pad);
2989 g_signal_handler_disconnect (pad, handler_id);
2990 GST_PAD_DO_EVENT_SIGNALS (pad)--;
2991 GST_DEBUG ("removed event probe from pad %s:%s, now %d event probes",
2992 GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_EVENT_SIGNALS (pad));
2993 GST_OBJECT_UNLOCK (pad);
2997 * gst_pad_remove_buffer_probe:
2998 * @pad: pad to remove the buffer probe handler from
2999 * @handler_id: handler id returned from gst_pad_add_buffer_probe
3001 * Removes a buffer probe from @pad.
3004 gst_pad_remove_buffer_probe (GstPad * pad, guint handler_id)
3006 g_return_if_fail (GST_IS_PAD (pad));
3007 g_return_if_fail (handler_id > 0);
3009 GST_OBJECT_LOCK (pad);
3010 g_signal_handler_disconnect (pad, handler_id);
3011 GST_PAD_DO_BUFFER_SIGNALS (pad)--;
3012 GST_DEBUG ("removed buffer probe from pad %s:%s, now %d buffer probes",
3013 GST_DEBUG_PAD_NAME (pad), GST_PAD_DO_BUFFER_SIGNALS (pad));
3014 GST_OBJECT_UNLOCK (pad);
3019 * gst_element_found_tags_for_pad:
3020 * @element: element for which to post taglist to bus.
3021 * @pad: pad on which to push tag-event.
3022 * @list: the taglist to post on the bus and create event from.
3024 * Posts a message to the bus that new tags were found and pushes the
3025 * tags as event. Takes ownership of the @list.
3027 * This is a utility method for elements. Applications should use the
3028 * #GstTagSetter interface.
3031 gst_element_found_tags_for_pad (GstElement * element,
3032 GstPad * pad, GstTagList * list)
3034 g_return_if_fail (element != NULL);
3035 g_return_if_fail (pad != NULL);
3036 g_return_if_fail (list != NULL);
3038 gst_pad_push_event (pad, gst_event_new_tag (gst_tag_list_copy (list)));
3039 gst_element_post_message (element,
3040 gst_message_new_tag (GST_OBJECT (element), list));
3044 push_and_ref (GstPad * pad, GstEvent * event)
3046 gst_pad_push_event (pad, gst_event_ref (event));
3047 /* iterator refs pad, we unref when we are done with it */
3048 gst_object_unref (pad);
3052 * gst_element_found_tags:
3053 * @element: element for which we found the tags.
3054 * @list: list of tags.
3056 * Posts a message to the bus that new tags were found, and pushes an event
3057 * to all sourcepads. Takes ownership of the @list.
3059 * This is a utility method for elements. Applications should use the
3060 * #GstTagSetter interface.
3063 gst_element_found_tags (GstElement * element, GstTagList * list)
3068 g_return_if_fail (element != NULL);
3069 g_return_if_fail (list != NULL);
3071 iter = gst_element_iterate_src_pads (element);
3072 event = gst_event_new_tag (gst_tag_list_copy (list));
3073 gst_iterator_foreach (iter, (GFunc) push_and_ref, event);
3074 gst_iterator_free (iter);
3075 gst_event_unref (event);
3077 gst_element_post_message (element,
3078 gst_message_new_tag (GST_OBJECT (element), list));
3082 element_find_unconnected_pad (GstElement * element, GstPadDirection direction)
3085 GstPad *unconnected_pad = NULL;
3088 switch (direction) {
3090 iter = gst_element_iterate_src_pads (element);
3093 iter = gst_element_iterate_sink_pads (element);
3096 g_return_val_if_reached (NULL);
3103 switch (gst_iterator_next (iter, &pad)) {
3104 case GST_ITERATOR_OK:{
3107 GST_CAT_LOG (GST_CAT_ELEMENT_PADS, "examining pad %s:%s",
3108 GST_DEBUG_PAD_NAME (pad));
3110 peer = gst_pad_get_peer (GST_PAD (pad));
3112 unconnected_pad = pad;
3114 GST_CAT_DEBUG (GST_CAT_ELEMENT_PADS,
3115 "found existing unlinked pad %s:%s",
3116 GST_DEBUG_PAD_NAME (unconnected_pad));
3118 gst_object_unref (pad);
3119 gst_object_unref (peer);
3123 case GST_ITERATOR_DONE:
3126 case GST_ITERATOR_RESYNC:
3127 gst_iterator_resync (iter);
3129 case GST_ITERATOR_ERROR:
3130 g_return_val_if_reached (NULL);
3135 gst_iterator_free (iter);
3137 return unconnected_pad;
3141 * gst_bin_find_unconnected_pad:
3142 * @bin: bin in which to look for elements with unconnected pads
3143 * @direction: whether to look for an unconnected source or sink pad
3145 * Recursively looks for elements with an unconnected pad of the given
3146 * direction within the specified bin and returns an unconnected pad
3147 * if one is found, or NULL otherwise. If a pad is found, the caller
3148 * owns a reference to it and should use gst_object_unref() on the
3149 * pad when it is not needed any longer.
3151 * Returns: unconnected pad of the given direction, or NULL.
3156 gst_bin_find_unconnected_pad (GstBin * bin, GstPadDirection direction)
3162 g_return_val_if_fail (GST_IS_BIN (bin), NULL);
3163 g_return_val_if_fail (direction != GST_PAD_UNKNOWN, NULL);
3166 iter = gst_bin_iterate_recurse (bin);
3170 switch (gst_iterator_next (iter, &element)) {
3171 case GST_ITERATOR_OK:
3172 pad = element_find_unconnected_pad (GST_ELEMENT (element), direction);
3173 gst_object_unref (element);
3177 case GST_ITERATOR_DONE:
3180 case GST_ITERATOR_RESYNC:
3181 gst_iterator_resync (iter);
3183 case GST_ITERATOR_ERROR:
3184 g_return_val_if_reached (NULL);
3189 gst_iterator_free (iter);
3195 * gst_parse_bin_from_description:
3196 * @bin_description: command line describing the bin
3197 * @ghost_unconnected_pads: whether to automatically create ghost pads
3198 * for unconnected source or sink pads within
3200 * @err: where to store the error message in case of an error, or NULL
3202 * This is a convenience wrapper around gst_parse_launch() to create a
3203 * #GstBin from a gst-launch-style pipeline description. See
3204 * gst_parse_launch() and the gst-launch man page for details about the
3205 * syntax. Ghost pads on the bin for unconnected source or sink pads
3206 * within the bin can automatically be created (but only a maximum of
3207 * one ghost pad for each direction will be created; if you expect
3208 * multiple unconnected source pads or multiple unconnected sink pads
3209 * and want them all ghosted, you will have to create the ghost pads
3212 * Returns: a newly-created bin, or NULL if an error occurred.
3217 gst_parse_bin_from_description (const gchar * bin_description,
3218 gboolean ghost_unconnected_pads, GError ** err)
3220 #ifndef GST_DISABLE_PARSE
3225 g_return_val_if_fail (bin_description != NULL, NULL);
3226 g_return_val_if_fail (err == NULL || *err == NULL, NULL);
3228 GST_DEBUG ("Making bin from description '%s'", bin_description);
3230 /* parse the pipeline to a bin */
3231 desc = g_strdup_printf ("bin.( %s )", bin_description);
3232 bin = (GstBin *) gst_parse_launch (desc, err);
3235 if (bin == NULL || (err && *err != NULL)) {
3237 gst_object_unref (bin);
3241 /* find pads and ghost them if necessary */
3242 if (ghost_unconnected_pads) {
3243 if ((pad = gst_bin_find_unconnected_pad (bin, GST_PAD_SRC))) {
3244 gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("src", pad));
3245 gst_object_unref (pad);
3247 if ((pad = gst_bin_find_unconnected_pad (bin, GST_PAD_SINK))) {
3248 gst_element_add_pad (GST_ELEMENT (bin), gst_ghost_pad_new ("sink", pad));
3249 gst_object_unref (pad);
3253 return GST_ELEMENT (bin);
3257 GST_WARNING ("Disabled API called: gst_parse_bin_from_description()");
3259 msg = gst_error_get_message (GST_CORE_ERROR, GST_CORE_ERROR_DISABLED);
3260 g_set_error (err, GST_CORE_ERROR, GST_CORE_ERROR_DISABLED, "%s", msg);
3268 * gst_type_register_static_full:
3269 * @parent_type: The GType of the parent type the newly registered type will
3271 * @type_name: NULL-terminated string used as the name of the new type
3272 * @class_size: Size of the class structure.
3273 * @base_init: Location of the base initialization function (optional).
3274 * @base_finalize: Location of the base finalization function (optional).
3275 * @class_init: Location of the class initialization function for class types
3276 * Location of the default vtable inititalization function for interface
3278 * @class_finalize: Location of the class finalization function for class types.
3279 * Location of the default vtable finalization function for interface types.
3281 * @class_data: User-supplied data passed to the class init/finalize functions.
3282 * @instance_size: Size of the instance (object) structure (required for
3283 * instantiatable types only).
3284 * @n_preallocs: The number of pre-allocated (cached) instances to reserve
3285 * memory for (0 indicates no caching). Ignored on recent GLib's.
3286 * @instance_init: Location of the instance initialization function (optional,
3287 * for instantiatable types only).
3288 * @value_table: A GTypeValueTable function table for generic handling of
3289 * GValues of this type (usually only useful for fundamental types).
3290 * @flags: #GTypeFlags for this GType. E.g: G_TYPE_FLAG_ABSTRACT
3292 * Helper function which constructs a #GTypeInfo structure and registers a
3293 * GType, but which generates less linker overhead than a static const
3294 * #GTypeInfo structure. For further details of the parameters, please see
3295 * #GTypeInfo in the GLib documentation.
3297 * Registers type_name as the name of a new static type derived from
3298 * parent_type. The value of flags determines the nature (e.g. abstract or
3299 * not) of the type. It works by filling a GTypeInfo struct and calling
3300 * g_type_info_register_static().
3302 * Returns: A #GType for the newly-registered type.
3307 gst_type_register_static_full (GType parent_type,
3308 const gchar * type_name,
3310 GBaseInitFunc base_init,
3311 GBaseFinalizeFunc base_finalize,
3312 GClassInitFunc class_init,
3313 GClassFinalizeFunc class_finalize,
3314 gconstpointer class_data,
3315 guint instance_size,
3316 guint16 n_preallocs,
3317 GInstanceInitFunc instance_init,
3318 const GTypeValueTable * value_table, GTypeFlags flags)
3322 info.class_size = class_size;
3323 info.base_init = base_init;
3324 info.base_finalize = base_finalize;
3325 info.class_init = class_init;
3326 info.class_finalize = class_finalize;
3327 info.class_data = class_data;
3328 info.instance_size = instance_size;
3329 info.n_preallocs = n_preallocs;
3330 info.instance_init = instance_init;
3331 info.value_table = value_table;
3333 return g_type_register_static (parent_type, type_name, &info, flags);
3338 * gst_util_get_timestamp:
3340 * Get a timestamp as GstClockTime to be used for interval meassurements.
3341 * The timestamp should not be interpreted in any other way.
3343 * Returns: the timestamp
3348 gst_util_get_timestamp (void)
3350 #if defined (HAVE_POSIX_TIMERS) && defined(HAVE_MONOTONIC_CLOCK)
3351 struct timespec now;
3353 clock_gettime (CLOCK_MONOTONIC, &now);
3354 return GST_TIMESPEC_TO_TIME (now);
3358 g_get_current_time (&now);
3359 return GST_TIMEVAL_TO_TIME (now);