gst/gstobject.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *                    2005 Wim Taymans <wim@fluendo.com>
   5  *
   6  * gstobject.c: Fundamental class used for all of GStreamer
   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:gstobject
  26  * @short_description: Base class for the GStreamer object hierarchy
  27  *
  28  * #GstObject provides a root for the object hierarchy tree filed in by the
  29  * GStreamer library.  It is currently a thin wrapper on top of
  30  * #GInitiallyUnowned. It is an abstract class that is not very usable on its own.
  31  *
  32  * #GstObject gives us basic refcounting, parenting functionality and locking.
  33  * Most of the function are just extended for special GStreamer needs and can be
  34  * found under the same name in the base class of #GstObject which is #GObject
  35  * (e.g. g_object_ref() becomes gst_object_ref()).
  36  *
  37  * Since #GstObject dereives from #GInitiallyUnowned, it also inherits the
  38  * floating reference. Be aware that functions such as gst_bin_add() and
  39  * gst_element_add_pad() take ownership of the floating reference.
  40  *
  41  * In contrast to #GObject instances, #GstObject adds a name property. The functions
  42  * gst_object_set_name() and gst_object_get_name() are used to set/get the name
  43  * of the object.
  44  *
  45  * <refsect2>
  46  * <title>controlled properties</title>
  47  * <para>
  48  * Controlled properties offers a lightweight way to adjust gobject
  49  * properties over stream-time. It works by using time-stamped value pairs that
  50  * are queued for element-properties. At run-time the elements continously pull
  51  * values changes for the current stream-time.
  52  *
  53  * What needs to be changed in a #GstElement?
  54  * Very little - it is just two steps to make a plugin controllable!
  55  * <orderedlist>
  56  *   <listitem><para>
  57  *     mark gobject-properties paramspecs that make sense to be controlled,
  58  *     by GST_PARAM_CONTROLLABLE.
  59  *   </para></listitem>
  60  *   <listitem><para>
  61  *     when processing data (get, chain, loop function) at the beginning call
  62  *     gst_object_sync_values(element,timestamp).
  63  *     This will made the controller to update all gobject properties that are under
  64  *     control with the current values based on timestamp.
  65  *   </para></listitem>
  66  * </orderedlist>
  67  *
  68  * What needs to be done in applications?
  69  * Again its not a lot to change.
  70  * <orderedlist>
  71  *   <listitem><para>
  72  *     first put some properties under control, by calling
  73  *     gst_object_control_properties (object, "prop1", "prop2",...);
  74  *   </para></listitem>
  75  *   <listitem><para>
  76  *     create a #GstControlSource.
  77  *     csource = gst_interpolation_control_source_new ();
  78  *     g_object_set (csource, "mode", GST_INTERPOLATION_MODE_LINEAR, NULL);
  79  *   </para></listitem>
  80  *   <listitem><para>
  81  *     Attach the #GstControlSource on the controller to a property.
  82  *     gst_object_add_control_binding (object, gst_direct_control_binding_new (objetct, "prop1", csource));
  83  *   </para></listitem>
  84  *   <listitem><para>
  85  *     Set the control values
  86  *     gst_timed_value_control_source_set ((GstTimedValueControlSource *)csource,0 * GST_SECOND, value1);
  87  *     gst_timed_value_control_source_set ((GstTimedValueControlSource *)csource,1 * GST_SECOND, value2);
  88  *   </para></listitem>
  89  *   <listitem><para>
  90  *     start your pipeline
  91  *   </para></listitem>
  92  * </orderedlist>
  93  * </para>
  94  * </refsect2>
  95  *
  96  * Last reviewed on 2012-03-29 (0.11.3)
  97  */
  98
  99 #include "gst_private.h"
 100 #include "glib-compat-private.h"
 101
 102 #include "gstobject.h"
 103 #include "gstclock.h"
 104 #include "gstcontrolbinding.h"
 105 #include "gstcontrolsource.h"
 106 #include "gstinfo.h"
 107 #include "gstparamspecs.h"
 108 #include "gstutils.h"
 109
 110 #ifndef GST_DISABLE_TRACE
 111 #include "gsttrace.h"
 112 static GstAllocTrace *_gst_object_trace;
 113 #endif
 114
 115 #define DEBUG_REFCOUNT
 116
 117 /* Object signals and args */
 118 enum
 119 {
 120   DEEP_NOTIFY,
 121   LAST_SIGNAL
 122 };
 123
 124 enum
 125 {
 126   PROP_0,
 127   PROP_NAME,
 128   PROP_PARENT,
 129   PROP_LAST
 130 };
 131
 132 enum
 133 {
 134   SO_OBJECT_LOADED,
 135   SO_LAST_SIGNAL
 136 };
 137
 138 /* maps type name quark => count */
 139 static GData *object_name_counts = NULL;
 140
 141 G_LOCK_DEFINE_STATIC (object_name_mutex);
 142
 143 static void gst_object_set_property (GObject * object, guint prop_id,
 144     const GValue * value, GParamSpec * pspec);
 145 static void gst_object_get_property (GObject * object, guint prop_id,
 146     GValue * value, GParamSpec * pspec);
 147
 148 static void gst_object_dispatch_properties_changed (GObject * object,
 149     guint n_pspecs, GParamSpec ** pspecs);
 150
 151 static void gst_object_dispose (GObject * object);
 152 static void gst_object_finalize (GObject * object);
 153
 154 static gboolean gst_object_set_name_default (GstObject * object);
 155
 156 static guint gst_object_signals[LAST_SIGNAL] = { 0 };
 157
 158 static GParamSpec *properties[PROP_LAST];
 159
 160 G_DEFINE_ABSTRACT_TYPE (GstObject, gst_object, G_TYPE_INITIALLY_UNOWNED);
 161
 162 static void
 163 gst_object_class_init (GstObjectClass * klass)
 164 {
 165   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 166
 167 #ifndef GST_DISABLE_TRACE
 168   _gst_object_trace =
 169       _gst_alloc_trace_register (g_type_name (GST_TYPE_OBJECT), -2);
 170 #endif
 171
 172   gobject_class->set_property = gst_object_set_property;
 173   gobject_class->get_property = gst_object_get_property;
 174
 175   properties[PROP_NAME] =
 176       g_param_spec_string ("name", "Name", "The name of the object", NULL,
 177       G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
 178
 179   properties[PROP_PARENT] =
 180       g_param_spec_object ("parent", "Parent", "The parent of the object",
 181       GST_TYPE_OBJECT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
 182
 183   g_object_class_install_properties (gobject_class, PROP_LAST, properties);
 184
 185   /**
 186    * GstObject::deep-notify:
 187    * @gstobject: a #GstObject
 188    * @prop_object: the object that originated the signal
 189    * @prop: the property that changed
 190    *
 191    * The deep notify signal is used to be notified of property changes. It is
 192    * typically attached to the toplevel bin to receive notifications from all
 193    * the elements contained in that bin.
 194    */
 195   gst_object_signals[DEEP_NOTIFY] =
 196       g_signal_new ("deep-notify", G_TYPE_FROM_CLASS (klass),
 197       G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED |
 198       G_SIGNAL_NO_HOOKS, G_STRUCT_OFFSET (GstObjectClass, deep_notify), NULL,
 199       NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 2, GST_TYPE_OBJECT,
 200       G_TYPE_PARAM);
 201
 202   klass->path_string_separator = "/";
 203
 204   /* see the comments at gst_object_dispatch_properties_changed */
 205   gobject_class->dispatch_properties_changed
 206       = GST_DEBUG_FUNCPTR (gst_object_dispatch_properties_changed);
 207
 208   gobject_class->dispose = gst_object_dispose;
 209   gobject_class->finalize = gst_object_finalize;
 210 }
 211
 212 static void
 213 gst_object_init (GstObject * object)
 214 {
 215   g_mutex_init (&object->lock);
 216   object->parent = NULL;
 217   object->name = NULL;
 218   GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "%p new", object);
 219
 220 #ifndef GST_DISABLE_TRACE
 221   _gst_alloc_trace_new (_gst_object_trace, object);
 222 #endif
 223
 224   object->flags = 0;
 225
 226   object->control_rate = 100 * GST_MSECOND;
 227   object->last_sync = GST_CLOCK_TIME_NONE;
 228 }
 229
 230 /**
 231  * gst_object_ref:
 232  * @object: (type Gst.Object): a #GstObject to reference
 233  *
 234  * Increments the reference count on @object. This function
 235  * does not take the lock on @object because it relies on
 236  * atomic refcounting.
 237  *
 238  * This object returns the input parameter to ease writing
 239  * constructs like :
 240  *  result = gst_object_ref (object->parent);
 241  *
 242  * Returns: (transfer full) (type Gst.Object): A pointer to @object
 243  */
 244 gpointer
 245 gst_object_ref (gpointer object)
 246 {
 247   g_return_val_if_fail (object != NULL, NULL);
 248
 249 #ifdef DEBUG_REFCOUNT
 250   GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "%p ref %d->%d", object,
 251       ((GObject *) object)->ref_count, ((GObject *) object)->ref_count + 1);
 252 #endif
 253   g_object_ref (object);
 254
 255   return object;
 256 }
 257
 258 /**
 259  * gst_object_unref:
 260  * @object: (type Gst.Object): a #GstObject to unreference
 261  *
 262  * Decrements the reference count on @object.  If reference count hits
 263  * zero, destroy @object. This function does not take the lock
 264  * on @object as it relies on atomic refcounting.
 265  *
 266  * The unref method should never be called with the LOCK held since
 267  * this might deadlock the dispose function.
 268  */
 269 void
 270 gst_object_unref (gpointer object)
 271 {
 272   g_return_if_fail (object != NULL);
 273   g_return_if_fail (((GObject *) object)->ref_count > 0);
 274
 275 #ifdef DEBUG_REFCOUNT
 276   GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "%p unref %d->%d", object,
 277       ((GObject *) object)->ref_count, ((GObject *) object)->ref_count - 1);
 278 #endif
 279   g_object_unref (object);
 280 }
 281
 282 /**
 283  * gst_object_ref_sink: (skip)
 284  * @object: a #GstObject to sink
 285  *
 286  * Increase the reference count of @object, and possibly remove the floating
 287  * reference, if @object has a floating reference.
 288  *
 289  * In other words, if the object is floating, then this call "assumes ownership"
 290  * of the floating reference, converting it to a normal reference by clearing
 291  * the floating flag while leaving the reference count unchanged. If the object
 292  * is not floating, then this call adds a new normal reference increasing the
 293  * reference count by one.
 294  */
 295 gpointer
 296 gst_object_ref_sink (gpointer object)
 297 {
 298   g_return_val_if_fail (object != NULL, NULL);
 299
 300 #ifdef DEBUG_REFCOUNT
 301   GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "%p ref_sink %d->%d",
 302       object, ((GObject *) object)->ref_count,
 303       ((GObject *) object)->ref_count + 1);
 304 #endif
 305   return g_object_ref_sink (object);
 306 }
 307
 308 /**
 309  * gst_object_replace:
 310  * @oldobj: (inout) (transfer full): pointer to a place of a #GstObject to
 311  *     replace
 312  * @newobj: (transfer none): a new #GstObject
 313  *
 314  * Atomically modifies a pointer to point to a new object.
 315  * The reference count of @oldobj is decreased and the reference count of
 316  * @newobj is increased.
 317  *
 318  * Either @newobj and the value pointed to by @oldobj may be NULL.
 319  *
 320  * Returns: TRUE if @newobj was different from @oldobj
 321  */
 322 gboolean
 323 gst_object_replace (GstObject ** oldobj, GstObject * newobj)
 324 {
 325   GstObject *oldptr;
 326
 327   g_return_val_if_fail (oldobj != NULL, FALSE);
 328
 329 #ifdef DEBUG_REFCOUNT
 330   GST_CAT_TRACE (GST_CAT_REFCOUNTING, "replace %p %s (%d) with %p %s (%d)",
 331       *oldobj, *oldobj ? GST_STR_NULL (GST_OBJECT_NAME (*oldobj)) : "(NONE)",
 332       *oldobj ? G_OBJECT (*oldobj)->ref_count : 0,
 333       newobj, newobj ? GST_STR_NULL (GST_OBJECT_NAME (newobj)) : "(NONE)",
 334       newobj ? G_OBJECT (newobj)->ref_count : 0);
 335 #endif
 336
 337   oldptr = g_atomic_pointer_get ((gpointer *) oldobj);
 338
 339   if (G_UNLIKELY (oldptr == newobj))
 340     return FALSE;
 341
 342   if (newobj)
 343     gst_object_ref (newobj);
 344
 345   while (G_UNLIKELY (!g_atomic_pointer_compare_and_exchange ((gpointer *)
 346               oldobj, oldptr, newobj))) {
 347     oldptr = g_atomic_pointer_get ((gpointer *) oldobj);
 348     if (G_UNLIKELY (oldptr == newobj))
 349       break;
 350   }
 351
 352   if (oldptr)
 353     gst_object_unref (oldptr);
 354
 355   return oldptr != newobj;
 356 }
 357
 358 /* dispose is called when the object has to release all links
 359  * to other objects */
 360 static void
 361 gst_object_dispose (GObject * object)
 362 {
 363   GstObject *self = (GstObject *) object;
 364   GstObject *parent;
 365
 366   GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "dispose");
 367
 368   GST_OBJECT_LOCK (object);
 369   if ((parent = GST_OBJECT_PARENT (object)))
 370     goto have_parent;
 371   GST_OBJECT_PARENT (object) = NULL;
 372   GST_OBJECT_UNLOCK (object);
 373
 374   if (self->control_bindings) {
 375     GList *node;
 376
 377     for (node = self->control_bindings; node; node = g_list_next (node)) {
 378       gst_object_unparent (node->data);
 379     }
 380     g_list_free (self->control_bindings);
 381     self->control_bindings = NULL;
 382   }
 383
 384   ((GObjectClass *) gst_object_parent_class)->dispose (object);
 385
 386   return;
 387
 388   /* ERRORS */
 389 have_parent:
 390   {
 391     g_critical ("\nTrying to dispose object \"%s\", but it still has a "
 392         "parent \"%s\".\nYou need to let the parent manage the "
 393         "object instead of unreffing the object directly.\n",
 394         GST_OBJECT_NAME (object), GST_OBJECT_NAME (parent));
 395     GST_OBJECT_UNLOCK (object);
 396     /* ref the object again to revive it in this error case */
 397     gst_object_ref (object);
 398     return;
 399   }
 400 }
 401
 402 /* finalize is called when the object has to free its resources */
 403 static void
 404 gst_object_finalize (GObject * object)
 405 {
 406   GstObject *gstobject = GST_OBJECT_CAST (object);
 407
 408   GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "finalize");
 409
 410   g_signal_handlers_destroy (object);
 411
 412   g_free (gstobject->name);
 413   g_mutex_clear (&gstobject->lock);
 414
 415 #ifndef GST_DISABLE_TRACE
 416   _gst_alloc_trace_free (_gst_object_trace, object);
 417 #endif
 418
 419   ((GObjectClass *) gst_object_parent_class)->finalize (object);
 420 }
 421
 422 /* Changing a GObject property of a GstObject will result in "deep-notify"
 423  * signals being emitted by the object itself, as well as in each parent
 424  * object. This is so that an application can connect a listener to the
 425  * top-level bin to catch property-change notifications for all contained
 426  * elements.
 427  *
 428  * MT safe.
 429  */
 430 static void
 431 gst_object_dispatch_properties_changed (GObject * object,
 432     guint n_pspecs, GParamSpec ** pspecs)
 433 {
 434   GstObject *gst_object, *parent, *old_parent;
 435   guint i;
 436 #ifndef GST_DISABLE_GST_DEBUG
 437   gchar *name = NULL;
 438   const gchar *debug_name;
 439 #endif
 440
 441   /* do the standard dispatching */
 442   ((GObjectClass *)
 443       gst_object_parent_class)->dispatch_properties_changed (object, n_pspecs,
 444       pspecs);
 445
 446   gst_object = GST_OBJECT_CAST (object);
 447 #ifndef GST_DISABLE_GST_DEBUG
 448   if (G_UNLIKELY (_gst_debug_min >= GST_LEVEL_LOG)) {
 449     name = gst_object_get_name (gst_object);
 450     debug_name = GST_STR_NULL (name);
 451   } else
 452     debug_name = "";
 453 #endif
 454
 455   /* now let the parent dispatch those, too */
 456   parent = gst_object_get_parent (gst_object);
 457   while (parent) {
 458     for (i = 0; i < n_pspecs; i++) {
 459       GST_CAT_LOG_OBJECT (GST_CAT_PROPERTIES, parent,
 460           "deep notification from %s (%s)", debug_name, pspecs[i]->name);
 461
 462       g_signal_emit (parent, gst_object_signals[DEEP_NOTIFY],
 463           g_quark_from_string (pspecs[i]->name), gst_object, pspecs[i]);
 464     }
 465
 466     old_parent = parent;
 467     parent = gst_object_get_parent (old_parent);
 468     gst_object_unref (old_parent);
 469   }
 470 #ifndef GST_DISABLE_GST_DEBUG
 471   g_free (name);
 472 #endif
 473 }
 474
 475 /**
 476  * gst_object_default_deep_notify:
 477  * @object: the #GObject that signalled the notify.
 478  * @orig: a #GstObject that initiated the notify.
 479  * @pspec: a #GParamSpec of the property.
 480  * @excluded_props: (array zero-terminated=1) (element-type gchar*) (allow-none):
 481  *     a set of user-specified properties to exclude or NULL to show
 482  *     all changes.
 483  *
 484  * A default deep_notify signal callback for an object. The user data
 485  * should contain a pointer to an array of strings that should be excluded
 486  * from the notify. The default handler will print the new value of the property
 487  * using g_print.
 488  *
 489  * MT safe. This function grabs and releases @object's LOCK for getting its
 490  *          path string.
 491  */
 492 void
 493 gst_object_default_deep_notify (GObject * object, GstObject * orig,
 494     GParamSpec * pspec, gchar ** excluded_props)
 495 {
 496   GValue value = { 0, };        /* the important thing is that value.type = 0 */
 497   gchar *str = NULL;
 498   gchar *name = NULL;
 499
 500   if (pspec->flags & G_PARAM_READABLE) {
 501     /* let's not print these out for excluded properties... */
 502     while (excluded_props != NULL && *excluded_props != NULL) {
 503       if (strcmp (pspec->name, *excluded_props) == 0)
 504         return;
 505       excluded_props++;
 506     }
 507     g_value_init (&value, pspec->value_type);
 508     g_object_get_property (G_OBJECT (orig), pspec->name, &value);
 509
 510     if (G_VALUE_HOLDS_STRING (&value))
 511       str = g_value_dup_string (&value);
 512     else
 513       str = gst_value_serialize (&value);
 514     name = gst_object_get_path_string (orig);
 515     g_print ("%s: %s = %s\n", name, pspec->name, str);
 516     g_free (name);
 517     g_free (str);
 518     g_value_unset (&value);
 519   } else {
 520     name = gst_object_get_path_string (orig);
 521     g_warning ("Parameter %s not readable in %s.", pspec->name, name);
 522     g_free (name);
 523   }
 524 }
 525
 526 static gboolean
 527 gst_object_set_name_default (GstObject * object)
 528 {
 529   const gchar *type_name;
 530   gint count;
 531   gchar *name;
 532   GQuark q;
 533   guint i, l;
 534
 535   /* to ensure guaranteed uniqueness across threads, only one thread
 536    * may ever assign a name */
 537   G_LOCK (object_name_mutex);
 538
 539   if (!object_name_counts) {
 540     g_datalist_init (&object_name_counts);
 541   }
 542
 543   q = g_type_qname (G_OBJECT_TYPE (object));
 544   count = GPOINTER_TO_INT (g_datalist_id_get_data (&object_name_counts, q));
 545   g_datalist_id_set_data (&object_name_counts, q, GINT_TO_POINTER (count + 1));
 546
 547   G_UNLOCK (object_name_mutex);
 548
 549   /* GstFooSink -> foosink<N> */
 550   type_name = g_quark_to_string (q);
 551   if (strncmp (type_name, "Gst", 3) == 0)
 552     type_name += 3;
 553   /* give the 20th "queue" element and the first "queue2" different names */
 554   l = strlen (type_name);
 555   if (l > 0 && g_ascii_isdigit (type_name[l - 1])) {
 556     name = g_strdup_printf ("%s-%d", type_name, count);
 557   } else {
 558     name = g_strdup_printf ("%s%d", type_name, count);
 559   }
 560
 561   l = strlen (name);
 562   for (i = 0; i < l; i++)
 563     name[i] = g_ascii_tolower (name[i]);
 564
 565   GST_OBJECT_LOCK (object);
 566   if (G_UNLIKELY (object->parent != NULL))
 567     goto had_parent;
 568
 569   g_free (object->name);
 570   object->name = name;
 571
 572   GST_OBJECT_UNLOCK (object);
 573
 574   return TRUE;
 575
 576 had_parent:
 577   {
 578     g_free (name);
 579     GST_WARNING ("parented objects can't be renamed");
 580     GST_OBJECT_UNLOCK (object);
 581     return FALSE;
 582   }
 583 }
 584
 585 /**
 586  * gst_object_set_name:
 587  * @object: a #GstObject
 588  * @name:   new name of object
 589  *
 590  * Sets the name of @object, or gives @object a guaranteed unique
 591  * name (if @name is NULL).
 592  * This function makes a copy of the provided name, so the caller
 593  * retains ownership of the name it sent.
 594  *
 595  * Returns: TRUE if the name could be set. Since Objects that have
 596  * a parent cannot be renamed, this function returns FALSE in those
 597  * cases.
 598  *
 599  * MT safe.  This function grabs and releases @object's LOCK.
 600  */
 601 gboolean
 602 gst_object_set_name (GstObject * object, const gchar * name)
 603 {
 604   gboolean result;
 605
 606   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
 607
 608   GST_OBJECT_LOCK (object);
 609
 610   /* parented objects cannot be renamed */
 611   if (G_UNLIKELY (object->parent != NULL))
 612     goto had_parent;
 613
 614   if (name != NULL) {
 615     g_free (object->name);
 616     object->name = g_strdup (name);
 617     GST_OBJECT_UNLOCK (object);
 618     result = TRUE;
 619   } else {
 620     GST_OBJECT_UNLOCK (object);
 621     result = gst_object_set_name_default (object);
 622   }
 623   /* FIXME-0.11: this misses a g_object_notify (object, "name"); unless called
 624    * from gst_object_set_property.
 625    * Ideally remove such custom setters (or make it static).
 626    */
 627   return result;
 628
 629   /* error */
 630 had_parent:
 631   {
 632     GST_WARNING ("parented objects can't be renamed");
 633     GST_OBJECT_UNLOCK (object);
 634     return FALSE;
 635   }
 636 }
 637
 638 /**
 639  * gst_object_get_name:
 640  * @object: a #GstObject
 641  *
 642  * Returns a copy of the name of @object.
 643  * Caller should g_free() the return value after usage.
 644  * For a nameless object, this returns NULL, which you can safely g_free()
 645  * as well.
 646  *
 647  * Free-function: g_free
 648  *
 649  * Returns: (transfer full): the name of @object. g_free() after usage.
 650  *
 651  * MT safe. This function grabs and releases @object's LOCK.
 652  */
 653 gchar *
 654 gst_object_get_name (GstObject * object)
 655 {
 656   gchar *result = NULL;
 657
 658   g_return_val_if_fail (GST_IS_OBJECT (object), NULL);
 659
 660   GST_OBJECT_LOCK (object);
 661   result = g_strdup (object->name);
 662   GST_OBJECT_UNLOCK (object);
 663
 664   return result;
 665 }
 666
 667 /**
 668  * gst_object_set_parent:
 669  * @object: a #GstObject
 670  * @parent: new parent of object
 671  *
 672  * Sets the parent of @object to @parent. The object's reference count will
 673  * be incremented, and any floating reference will be removed (see gst_object_ref_sink()).
 674  *
 675  * Returns: TRUE if @parent could be set or FALSE when @object
 676  * already had a parent or @object and @parent are the same.
 677  *
 678  * MT safe. Grabs and releases @object's LOCK.
 679  */
 680 gboolean
 681 gst_object_set_parent (GstObject * object, GstObject * parent)
 682 {
 683   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
 684   g_return_val_if_fail (GST_IS_OBJECT (parent), FALSE);
 685   g_return_val_if_fail (object != parent, FALSE);
 686
 687   GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, object,
 688       "set parent (ref and sink)");
 689
 690   GST_OBJECT_LOCK (object);
 691   if (G_UNLIKELY (object->parent != NULL))
 692     goto had_parent;
 693
 694   object->parent = parent;
 695   gst_object_ref_sink (object);
 696   GST_OBJECT_UNLOCK (object);
 697
 698   /* FIXME, this does not work, the deep notify takes the lock from the parent
 699    * object and deadlocks when the parent holds its lock when calling this
 700    * function (like _element_add_pad()) */
 701   /* g_object_notify_by_pspec ((GObject *)object, properties[PROP_PARENT]); */
 702
 703   return TRUE;
 704
 705   /* ERROR handling */
 706 had_parent:
 707   {
 708     GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, object,
 709         "set parent failed, object already had a parent");
 710     GST_OBJECT_UNLOCK (object);
 711     return FALSE;
 712   }
 713 }
 714
 715 /**
 716  * gst_object_get_parent:
 717  * @object: a #GstObject
 718  *
 719  * Returns the parent of @object. This function increases the refcount
 720  * of the parent object so you should gst_object_unref() it after usage.
 721  *
 722  * Returns: (transfer full): parent of @object, this can be NULL if @object
 723  *   has no parent. unref after usage.
 724  *
 725  * MT safe. Grabs and releases @object's LOCK.
 726  */
 727 GstObject *
 728 gst_object_get_parent (GstObject * object)
 729 {
 730   GstObject *result = NULL;
 731
 732   g_return_val_if_fail (GST_IS_OBJECT (object), NULL);
 733
 734   GST_OBJECT_LOCK (object);
 735   result = object->parent;
 736   if (G_LIKELY (result))
 737     gst_object_ref (result);
 738   GST_OBJECT_UNLOCK (object);
 739
 740   return result;
 741 }
 742
 743 /**
 744  * gst_object_unparent:
 745  * @object: a #GstObject to unparent
 746  *
 747  * Clear the parent of @object, removing the associated reference.
 748  * This function decreases the refcount of @object.
 749  *
 750  * MT safe. Grabs and releases @object's lock.
 751  */
 752 void
 753 gst_object_unparent (GstObject * object)
 754 {
 755   GstObject *parent;
 756
 757   g_return_if_fail (GST_IS_OBJECT (object));
 758
 759   GST_OBJECT_LOCK (object);
 760   parent = object->parent;
 761
 762   if (G_LIKELY (parent != NULL)) {
 763     GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "unparent");
 764     object->parent = NULL;
 765     GST_OBJECT_UNLOCK (object);
 766
 767     /* g_object_notify_by_pspec ((GObject *)object, properties[PROP_PARENT]); */
 768
 769     gst_object_unref (object);
 770   } else {
 771     GST_OBJECT_UNLOCK (object);
 772   }
 773 }
 774
 775 /**
 776  * gst_object_has_ancestor:
 777  * @object: a #GstObject to check
 778  * @ancestor: a #GstObject to check as ancestor
 779  *
 780  * Check if @object has an ancestor @ancestor somewhere up in
 781  * the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.
 782  *
 783  * Returns: TRUE if @ancestor is an ancestor of @object.
 784  *
 785  * MT safe. Grabs and releases @object's locks.
 786  */
 787 gboolean
 788 gst_object_has_ancestor (GstObject * object, GstObject * ancestor)
 789 {
 790   GstObject *parent, *tmp;
 791
 792   if (!ancestor || !object)
 793     return FALSE;
 794
 795   parent = gst_object_ref (object);
 796   do {
 797     if (parent == ancestor) {
 798       gst_object_unref (parent);
 799       return TRUE;
 800     }
 801
 802     tmp = gst_object_get_parent (parent);
 803     gst_object_unref (parent);
 804     parent = tmp;
 805   } while (parent);
 806
 807   return FALSE;
 808 }
 809
 810 /**
 811  * gst_object_check_uniqueness:
 812  * @list: (transfer none) (element-type Gst.Object): a list of #GstObject to
 813  *      check through
 814  * @name: the name to search for
 815  *
 816  * Checks to see if there is any object named @name in @list. This function
 817  * does not do any locking of any kind. You might want to protect the
 818  * provided list with the lock of the owner of the list. This function
 819  * will lock each #GstObject in the list to compare the name, so be
 820  * carefull when passing a list with a locked object.
 821  *
 822  * Returns: TRUE if a #GstObject named @name does not appear in @list,
 823  * FALSE if it does.
 824  *
 825  * MT safe. Grabs and releases the LOCK of each object in the list.
 826  */
 827 gboolean
 828 gst_object_check_uniqueness (GList * list, const gchar * name)
 829 {
 830   gboolean result = TRUE;
 831
 832   g_return_val_if_fail (name != NULL, FALSE);
 833
 834   for (; list; list = g_list_next (list)) {
 835     GstObject *child;
 836     gboolean eq;
 837
 838     child = GST_OBJECT_CAST (list->data);
 839
 840     GST_OBJECT_LOCK (child);
 841     eq = strcmp (GST_OBJECT_NAME (child), name) == 0;
 842     GST_OBJECT_UNLOCK (child);
 843
 844     if (G_UNLIKELY (eq)) {
 845       result = FALSE;
 846       break;
 847     }
 848   }
 849   return result;
 850 }
 851
 852
 853 static void
 854 gst_object_set_property (GObject * object, guint prop_id,
 855     const GValue * value, GParamSpec * pspec)
 856 {
 857   GstObject *gstobject;
 858
 859   gstobject = GST_OBJECT_CAST (object);
 860
 861   switch (prop_id) {
 862     case PROP_NAME:
 863       gst_object_set_name (gstobject, g_value_get_string (value));
 864       break;
 865     case PROP_PARENT:
 866       gst_object_set_parent (gstobject, g_value_get_object (value));
 867       break;
 868     default:
 869       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 870       break;
 871   }
 872 }
 873
 874 static void
 875 gst_object_get_property (GObject * object, guint prop_id,
 876     GValue * value, GParamSpec * pspec)
 877 {
 878   GstObject *gstobject;
 879
 880   gstobject = GST_OBJECT_CAST (object);
 881
 882   switch (prop_id) {
 883     case PROP_NAME:
 884       g_value_take_string (value, gst_object_get_name (gstobject));
 885       break;
 886     case PROP_PARENT:
 887       g_value_take_object (value, gst_object_get_parent (gstobject));
 888       break;
 889     default:
 890       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 891       break;
 892   }
 893 }
 894
 895 /**
 896  * gst_object_get_path_string:
 897  * @object: a #GstObject
 898  *
 899  * Generates a string describing the path of @object in
 900  * the object hierarchy. Only useful (or used) for debugging.
 901  *
 902  * Free-function: g_free
 903  *
 904  * Returns: (transfer full): a string describing the path of @object. You must
 905  *          g_free() the string after usage.
 906  *
 907  * MT safe. Grabs and releases the #GstObject's LOCK for all objects
 908  *          in the hierarchy.
 909  */
 910 gchar *
 911 gst_object_get_path_string (GstObject * object)
 912 {
 913   GSList *parentage;
 914   GSList *parents;
 915   void *parent;
 916   gchar *prevpath, *path;
 917   const gchar *typename;
 918   gchar *component;
 919   const gchar *separator;
 920
 921   /* ref object before adding to list */
 922   gst_object_ref (object);
 923   parentage = g_slist_prepend (NULL, object);
 924
 925   path = g_strdup ("");
 926
 927   /* first walk the object hierarchy to build a list of the parents,
 928    * be carefull here with refcounting. */
 929   do {
 930     if (GST_IS_OBJECT (object)) {
 931       parent = gst_object_get_parent (object);
 932       /* add parents to list, refcount remains increased while
 933        * we handle the object */
 934       if (parent)
 935         parentage = g_slist_prepend (parentage, parent);
 936     } else {
 937       break;
 938     }
 939     object = parent;
 940   } while (object != NULL);
 941
 942   /* then walk the parent list and print them out. we need to
 943    * decrease the refcounting on each element after we handled
 944    * it. */
 945   for (parents = parentage; parents; parents = g_slist_next (parents)) {
 946     if (G_IS_OBJECT (parents->data)) {
 947       typename = G_OBJECT_TYPE_NAME (parents->data);
 948     } else {
 949       typename = NULL;
 950     }
 951     if (GST_IS_OBJECT (parents->data)) {
 952       GstObject *item = GST_OBJECT_CAST (parents->data);
 953       GstObjectClass *oclass = GST_OBJECT_GET_CLASS (item);
 954       gchar *objname = gst_object_get_name (item);
 955
 956       component = g_strdup_printf ("%s:%s", typename, objname);
 957       separator = oclass->path_string_separator;
 958       /* and unref now */
 959       gst_object_unref (item);
 960       g_free (objname);
 961     } else {
 962       if (typename) {
 963         component = g_strdup_printf ("%s:%p", typename, parents->data);
 964       } else {
 965         component = g_strdup_printf ("%p", parents->data);
 966       }
 967       separator = "/";
 968     }
 969
 970     prevpath = path;
 971     path = g_strjoin (separator, prevpath, component, NULL);
 972     g_free (prevpath);
 973     g_free (component);
 974   }
 975
 976   g_slist_free (parentage);
 977
 978   return path;
 979 }
 980
 981 /* controller helper functions */
 982
 983 /*
 984  * gst_object_find_control_binding:
 985  * @self: the gobject to search for a property in
 986  * @name: the gobject property name to look for
 987  *
 988  * Searches the list of properties under control.
 989  *
 990  * Returns: a #GstControlBinding or %NULL if the property is not being
 991  * controlled.
 992  */
 993 static GstControlBinding *
 994 gst_object_find_control_binding (GstObject * self, const gchar * name)
 995 {
 996   GstControlBinding *binding;
 997   GList *node;
 998
 999   for (node = self->control_bindings; node; node = g_list_next (node)) {
1000     binding = node->data;
1001     /* FIXME: eventually use GQuark to speed it up */
1002     if (!strcmp (binding->name, name)) {
1003       GST_DEBUG_OBJECT (self, "found control binding for property '%s'", name);
1004       return binding;
1005     }
1006   }
1007   GST_DEBUG_OBJECT (self, "controller does not manage property '%s'", name);
1008
1009   return NULL;
1010 }
1011
1012 /* controller functions */
1013
1014 /**
1015  * gst_object_suggest_next_sync:
1016  * @object: the object that has controlled properties
1017  *
1018  * Returns a suggestion for timestamps where buffers should be split
1019  * to get best controller results.
1020  *
1021  * Returns: Returns the suggested timestamp or %GST_CLOCK_TIME_NONE
1022  * if no control-rate was set.
1023  */
1024 GstClockTime
1025 gst_object_suggest_next_sync (GstObject * object)
1026 {
1027   GstClockTime ret;
1028
1029   g_return_val_if_fail (GST_IS_OBJECT (object), GST_CLOCK_TIME_NONE);
1030   g_return_val_if_fail (object->control_rate != GST_CLOCK_TIME_NONE,
1031       GST_CLOCK_TIME_NONE);
1032
1033   GST_OBJECT_LOCK (object);
1034
1035   /* TODO: Implement more logic, depending on interpolation mode and control
1036    * points
1037    * FIXME: we need playback direction
1038    */
1039   ret = object->last_sync + object->control_rate;
1040
1041   GST_OBJECT_UNLOCK (object);
1042
1043   return ret;
1044 }
1045
1046 /**
1047  * gst_object_sync_values:
1048  * @object: the object that has controlled properties
1049  * @timestamp: the time that should be processed
1050  *
1051  * Sets the properties of the object, according to the #GstControlSources that
1052  * (maybe) handle them and for the given timestamp.
1053  *
1054  * If this function fails, it is most likely the application developers fault.
1055  * Most probably the control sources are not setup correctly.
1056  *
1057  * Returns: %TRUE if the controller values could be applied to the object
1058  * properties, %FALSE otherwise
1059  */
1060 gboolean
1061 gst_object_sync_values (GstObject * object, GstClockTime timestamp)
1062 {
1063   GList *node;
1064   gboolean ret = TRUE;
1065
1066   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1067   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), FALSE);
1068
1069   GST_LOG_OBJECT (object, "sync_values");
1070   if (!object->control_bindings)
1071     return TRUE;
1072
1073   /* FIXME: this deadlocks */
1074   /* GST_OBJECT_LOCK (object); */
1075   g_object_freeze_notify ((GObject *) object);
1076   for (node = object->control_bindings; node; node = g_list_next (node)) {
1077     ret &= gst_control_binding_sync_values ((GstControlBinding *) node->data,
1078         object, timestamp, object->last_sync);
1079   }
1080   object->last_sync = timestamp;
1081   g_object_thaw_notify ((GObject *) object);
1082   /* GST_OBJECT_UNLOCK (object); */
1083
1084   return ret;
1085 }
1086
1087
1088 /**
1089  * gst_object_has_active_control_bindings:
1090  * @object: the object that has controlled properties
1091  *
1092  * Check if the @object has an active controlled properties.
1093  *
1094  * Returns: %TRUE if the object has active controlled properties
1095  */
1096 gboolean
1097 gst_object_has_active_control_bindings (GstObject * object)
1098 {
1099   gboolean res = FALSE;
1100   GList *node;
1101
1102   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1103
1104   GST_OBJECT_LOCK (object);
1105   for (node = object->control_bindings; node; node = g_list_next (node)) {
1106     res |= !gst_control_binding_is_disabled ((GstControlBinding *) node->data);
1107   }
1108   GST_OBJECT_UNLOCK (object);
1109   return res;
1110 }
1111
1112 /**
1113  * gst_object_set_control_bindings_disabled:
1114  * @object: the object that has controlled properties
1115  * @disabled: boolean that specifies whether to disable the controller
1116  * or not.
1117  *
1118  * This function is used to disable all controlled properties of the @object for
1119  * some time, i.e. gst_object_sync_values() will do nothing.
1120  */
1121 void
1122 gst_object_set_control_bindings_disabled (GstObject * object, gboolean disabled)
1123 {
1124   GList *node;
1125
1126   g_return_if_fail (GST_IS_OBJECT (object));
1127
1128   GST_OBJECT_LOCK (object);
1129   for (node = object->control_bindings; node; node = g_list_next (node)) {
1130     gst_control_binding_set_disabled ((GstControlBinding *) node->data,
1131         disabled);
1132   }
1133   GST_OBJECT_UNLOCK (object);
1134 }
1135
1136 /**
1137  * gst_object_set_control_binding_disabled:
1138  * @object: the object that has controlled properties
1139  * @property_name: property to disable
1140  * @disabled: boolean that specifies whether to disable the controller
1141  * or not.
1142  *
1143  * This function is used to disable the #GstController on a property for
1144  * some time, i.e. gst_controller_sync_values() will do nothing for the
1145  * property.
1146  */
1147 void
1148 gst_object_set_control_binding_disabled (GstObject * object,
1149     const gchar * property_name, gboolean disabled)
1150 {
1151   GstControlBinding *binding;
1152
1153   g_return_if_fail (GST_IS_OBJECT (object));
1154   g_return_if_fail (property_name);
1155
1156   GST_OBJECT_LOCK (object);
1157   if ((binding = gst_object_find_control_binding (object, property_name))) {
1158     gst_control_binding_set_disabled (binding, disabled);
1159   }
1160   GST_OBJECT_UNLOCK (object);
1161 }
1162
1163
1164 /**
1165  * gst_object_add_control_binding:
1166  * @object: the controller object
1167  * @binding: (transfer full): the #GstControlBinding that should be used
1168  *
1169  * Sets the #GstControlBinding. If there already was a #GstControlBinding
1170  * for this property it will be replaced.
1171  * The @object will take ownership of the @binding.
1172  *
1173  * Returns: %FALSE if the given @binding has not been setup for this object  or
1174  * %TRUE otherwise.
1175  */
1176 gboolean
1177 gst_object_add_control_binding (GstObject * object, GstControlBinding * binding)
1178 {
1179   GstControlBinding *old;
1180
1181   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1182   g_return_val_if_fail (GST_IS_CONTROL_BINDING (binding), FALSE);
1183   //g_return_val_if_fail (g_type_is_a (binding->pspec->owner_type,
1184   //        G_OBJECT_TYPE (object)), FALSE);
1185
1186   GST_OBJECT_LOCK (object);
1187   if ((old = gst_object_find_control_binding (object, binding->name))) {
1188     GST_DEBUG_OBJECT (object, "controlled property %s removed", old->name);
1189     object->control_bindings = g_list_remove (object->control_bindings, old);
1190     gst_object_unparent (GST_OBJECT_CAST (old));
1191   }
1192   object->control_bindings = g_list_prepend (object->control_bindings, binding);
1193   gst_object_set_parent (GST_OBJECT_CAST (binding), object);
1194   GST_DEBUG_OBJECT (object, "controlled property %s added", binding->name);
1195   GST_OBJECT_UNLOCK (object);
1196
1197   return TRUE;
1198 }
1199
1200 /**
1201  * gst_object_get_control_binding:
1202  * @object: the object
1203  * @property_name: name of the property
1204  *
1205  * Gets the corresponding #GstControlBinding for the property. This should be
1206  * unreferenced again after use.
1207  *
1208  * Returns: (transfer full): the #GstControlBinding for @property_name or %NULL if
1209  * the property is not controlled.
1210  */
1211 GstControlBinding *
1212 gst_object_get_control_binding (GstObject * object, const gchar * property_name)
1213 {
1214   GstControlBinding *binding;
1215
1216   g_return_val_if_fail (GST_IS_OBJECT (object), NULL);
1217   g_return_val_if_fail (property_name, NULL);
1218
1219   GST_OBJECT_LOCK (object);
1220   if ((binding = gst_object_find_control_binding (object, property_name))) {
1221     gst_object_ref (binding);
1222   }
1223   GST_OBJECT_UNLOCK (object);
1224
1225   return binding;
1226 }
1227
1228 /**
1229  * gst_object_remove_control_binding:
1230  * @object: the object
1231  * @binding: the binding
1232  *
1233  * Removes the corresponding #GstControlBinding. If it was the
1234  * last ref of the binding, it will be disposed.
1235  *
1236  * Returns: %TRUE if the binding could be removed.
1237  */
1238 gboolean
1239 gst_object_remove_control_binding (GstObject * object,
1240     GstControlBinding * binding)
1241 {
1242   GList *node;
1243   gboolean ret = FALSE;
1244
1245   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1246   g_return_val_if_fail (GST_IS_CONTROL_BINDING (binding), FALSE);
1247
1248   GST_OBJECT_LOCK (object);
1249   if ((node = g_list_find (object->control_bindings, binding))) {
1250     GST_DEBUG_OBJECT (object, "controlled property %s removed", binding->name);
1251     object->control_bindings =
1252         g_list_delete_link (object->control_bindings, node);
1253     gst_object_unparent (GST_OBJECT_CAST (binding));
1254     ret = TRUE;
1255   }
1256   GST_OBJECT_UNLOCK (object);
1257
1258   return ret;
1259 }
1260
1261 /**
1262  * gst_object_get_value:
1263  * @object: the object that has controlled properties
1264  * @property_name: the name of the property to get
1265  * @timestamp: the time the control-change should be read from
1266  *
1267  * Gets the value for the given controlled property at the requested time.
1268  *
1269  * Returns: the GValue of the property at the given time, or %NULL if the
1270  * property isn't controlled.
1271  */
1272 GValue *
1273 gst_object_get_value (GstObject * object, const gchar * property_name,
1274     GstClockTime timestamp)
1275 {
1276   GstControlBinding *binding;
1277   GValue *val = NULL;
1278
1279   g_return_val_if_fail (GST_IS_OBJECT (object), NULL);
1280   g_return_val_if_fail (property_name, NULL);
1281   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), NULL);
1282
1283   GST_OBJECT_LOCK (object);
1284   if ((binding = gst_object_find_control_binding (object, property_name))) {
1285     val = gst_control_binding_get_value (binding, timestamp);
1286   }
1287   GST_OBJECT_UNLOCK (object);
1288
1289   return val;
1290 }
1291
1292 /**
1293  * gst_object_get_value_array:
1294  * @object: the object that has controlled properties
1295  * @property_name: the name of the property to get
1296  * @timestamp: the time that should be processed
1297  * @interval: the time spacing between subsequent values
1298  * @n_values: the number of values
1299  * @values: array to put control-values in
1300  *
1301  * Gets a number of values for the given controlled property starting at the
1302  * requested time. The array @values need to hold enough space for @n_values of
1303  * the same type as the objects property's type.
1304  *
1305  * This function is useful if one wants to e.g. draw a graph of the control
1306  * curve or apply a control curve sample by sample.
1307  *
1308  * The values are unboxed and ready to be used. The similar function
1309  * gst_object_get_g_value_array() returns the array as #GValues and is
1310  * better suites for bindings.
1311  *
1312  * Returns: %TRUE if the given array could be filled, %FALSE otherwise
1313  */
1314 gboolean
1315 gst_object_get_value_array (GstObject * object, const gchar * property_name,
1316     GstClockTime timestamp, GstClockTime interval, guint n_values,
1317     gpointer values)
1318 {
1319   gboolean res = FALSE;
1320   GstControlBinding *binding;
1321
1322   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1323   g_return_val_if_fail (property_name, FALSE);
1324   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), FALSE);
1325   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (interval), FALSE);
1326   g_return_val_if_fail (values, FALSE);
1327
1328   GST_OBJECT_LOCK (object);
1329   if ((binding = gst_object_find_control_binding (object, property_name))) {
1330     res = gst_control_binding_get_value_array (binding, timestamp, interval,
1331         n_values, values);
1332   }
1333   GST_OBJECT_UNLOCK (object);
1334   return res;
1335 }
1336
1337 /**
1338  * gst_object_get_g_value_array:
1339  * @object: the object that has controlled properties
1340  * @property_name: the name of the property to get
1341  * @timestamp: the time that should be processed
1342  * @interval: the time spacing between subsequent values
1343  * @n_values: the number of values
1344  * @values: array to put control-values in
1345  *
1346  * Gets a number of #GValues for the given controlled property starting at the
1347  * requested time. The array @values need to hold enough space for @n_values of
1348  * #GValue.
1349  *
1350  * This function is useful if one wants to e.g. draw a graph of the control
1351  * curve or apply a control curve sample by sample.
1352  *
1353  * Returns: %TRUE if the given array could be filled, %FALSE otherwise
1354  */
1355 gboolean
1356 gst_object_get_g_value_array (GstObject * object, const gchar * property_name,
1357     GstClockTime timestamp, GstClockTime interval, guint n_values,
1358     GValue * values)
1359 {
1360   gboolean res = FALSE;
1361   GstControlBinding *binding;
1362
1363   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1364   g_return_val_if_fail (property_name, FALSE);
1365   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), FALSE);
1366   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (interval), FALSE);
1367   g_return_val_if_fail (values, FALSE);
1368
1369   GST_OBJECT_LOCK (object);
1370   if ((binding = gst_object_find_control_binding (object, property_name))) {
1371     res = gst_control_binding_get_g_value_array (binding, timestamp, interval,
1372         n_values, values);
1373   }
1374   GST_OBJECT_UNLOCK (object);
1375   return res;
1376 }
1377
1378
1379 /**
1380  * gst_object_get_control_rate:
1381  * @object: the object that has controlled properties
1382  *
1383  * Obtain the control-rate for this @object. Audio processing #GstElement
1384  * objects will use this rate to sub-divide their processing loop and call
1385  * gst_object_sync_values() inbetween. The length of the processing segment
1386  * should be up to @control-rate nanoseconds.
1387  *
1388  * If the @object is not under property control, this will return
1389  * %GST_CLOCK_TIME_NONE. This allows the element to avoid the sub-dividing.
1390  *
1391  * The control-rate is not expected to change if the element is in
1392  * %GST_STATE_PAUSED or %GST_STATE_PLAYING.
1393  *
1394  * Returns: the control rate in nanoseconds
1395  */
1396 GstClockTime
1397 gst_object_get_control_rate (GstObject * object)
1398 {
1399   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1400
1401   return object->control_rate;
1402 }
1403
1404 /**
1405  * gst_object_set_control_rate:
1406  * @object: the object that has controlled properties
1407  * @control_rate: the new control-rate in nanoseconds.
1408  *
1409  * Change the control-rate for this @object. Audio processing #GstElement
1410  * objects will use this rate to sub-divide their processing loop and call
1411  * gst_object_sync_values() inbetween. The length of the processing segment
1412  * should be up to @control-rate nanoseconds.
1413  *
1414  * The control-rate should not change if the element is in %GST_STATE_PAUSED or
1415  * %GST_STATE_PLAYING.
1416  */
1417 void
1418 gst_object_set_control_rate (GstObject * object, GstClockTime control_rate)
1419 {
1420   g_return_if_fail (GST_IS_OBJECT (object));
1421
1422   object->control_rate = control_rate;
1423 }