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: 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): 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: 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     g_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     g_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       g_object_unref (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*)
 481  *     (allow-none):a set of user-specified properties to exclude or
 482  *     NULL to show 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     /* FIXME: handle flags */
 511     if (G_IS_PARAM_SPEC_ENUM (pspec)) {
 512       GEnumValue *enum_value;
 513       GEnumClass *klass = G_ENUM_CLASS (g_type_class_ref (pspec->value_type));
 514
 515       enum_value = g_enum_get_value (klass, g_value_get_enum (&value));
 516
 517       str = g_strdup_printf ("%s (%d)", enum_value->value_nick,
 518           enum_value->value);
 519       g_type_class_unref (klass);
 520     } else {
 521       str = g_strdup_value_contents (&value);
 522     }
 523     name = gst_object_get_path_string (orig);
 524     g_print ("%s: %s = %s\n", name, pspec->name, str);
 525     g_free (name);
 526     g_free (str);
 527     g_value_unset (&value);
 528   } else {
 529     name = gst_object_get_path_string (orig);
 530     g_warning ("Parameter %s not readable in %s.", pspec->name, name);
 531     g_free (name);
 532   }
 533 }
 534
 535 static gboolean
 536 gst_object_set_name_default (GstObject * object)
 537 {
 538   const gchar *type_name;
 539   gint count;
 540   gchar *name;
 541   GQuark q;
 542   guint i, l;
 543
 544   /* to ensure guaranteed uniqueness across threads, only one thread
 545    * may ever assign a name */
 546   G_LOCK (object_name_mutex);
 547
 548   if (!object_name_counts) {
 549     g_datalist_init (&object_name_counts);
 550   }
 551
 552   q = g_type_qname (G_OBJECT_TYPE (object));
 553   count = GPOINTER_TO_INT (g_datalist_id_get_data (&object_name_counts, q));
 554   g_datalist_id_set_data (&object_name_counts, q, GINT_TO_POINTER (count + 1));
 555
 556   G_UNLOCK (object_name_mutex);
 557
 558   /* GstFooSink -> foosink<N> */
 559   type_name = g_quark_to_string (q);
 560   if (strncmp (type_name, "Gst", 3) == 0)
 561     type_name += 3;
 562   name = g_strdup_printf ("%s%d", type_name, count);
 563   l = strlen (name);
 564   for (i = 0; i < l; i++)
 565     name[i] = g_ascii_tolower (name[i]);
 566
 567   GST_OBJECT_LOCK (object);
 568   if (G_UNLIKELY (object->parent != NULL))
 569     goto had_parent;
 570
 571   g_free (object->name);
 572   object->name = name;
 573
 574   GST_OBJECT_UNLOCK (object);
 575
 576   return TRUE;
 577
 578 had_parent:
 579   {
 580     g_free (name);
 581     GST_WARNING ("parented objects can't be renamed");
 582     GST_OBJECT_UNLOCK (object);
 583     return FALSE;
 584   }
 585 }
 586
 587 /**
 588  * gst_object_set_name:
 589  * @object: a #GstObject
 590  * @name:   new name of object
 591  *
 592  * Sets the name of @object, or gives @object a guaranteed unique
 593  * name (if @name is NULL).
 594  * This function makes a copy of the provided name, so the caller
 595  * retains ownership of the name it sent.
 596  *
 597  * Returns: TRUE if the name could be set. Since Objects that have
 598  * a parent cannot be renamed, this function returns FALSE in those
 599  * cases.
 600  *
 601  * MT safe.  This function grabs and releases @object's LOCK.
 602  */
 603 gboolean
 604 gst_object_set_name (GstObject * object, const gchar * name)
 605 {
 606   gboolean result;
 607
 608   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
 609
 610   GST_OBJECT_LOCK (object);
 611
 612   /* parented objects cannot be renamed */
 613   if (G_UNLIKELY (object->parent != NULL))
 614     goto had_parent;
 615
 616   if (name != NULL) {
 617     g_free (object->name);
 618     object->name = g_strdup (name);
 619     GST_OBJECT_UNLOCK (object);
 620     result = TRUE;
 621   } else {
 622     GST_OBJECT_UNLOCK (object);
 623     result = gst_object_set_name_default (object);
 624   }
 625   /* FIXME-0.11: this misses a g_object_notify (object, "name"); unless called
 626    * from gst_object_set_property.
 627    * Ideally remove such custom setters (or make it static).
 628    */
 629   return result;
 630
 631   /* error */
 632 had_parent:
 633   {
 634     GST_WARNING ("parented objects can't be renamed");
 635     GST_OBJECT_UNLOCK (object);
 636     return FALSE;
 637   }
 638 }
 639
 640 /**
 641  * gst_object_get_name:
 642  * @object: a #GstObject
 643  *
 644  * Returns a copy of the name of @object.
 645  * Caller should g_free() the return value after usage.
 646  * For a nameless object, this returns NULL, which you can safely g_free()
 647  * as well.
 648  *
 649  * Free-function: g_free
 650  *
 651  * Returns: (transfer full): the name of @object. g_free() after usage.
 652  *
 653  * MT safe. This function grabs and releases @object's LOCK.
 654  */
 655 gchar *
 656 gst_object_get_name (GstObject * object)
 657 {
 658   gchar *result = NULL;
 659
 660   g_return_val_if_fail (GST_IS_OBJECT (object), NULL);
 661
 662   GST_OBJECT_LOCK (object);
 663   result = g_strdup (object->name);
 664   GST_OBJECT_UNLOCK (object);
 665
 666   return result;
 667 }
 668
 669 /**
 670  * gst_object_set_parent:
 671  * @object: a #GstObject
 672  * @parent: new parent of object
 673  *
 674  * Sets the parent of @object to @parent. The object's reference count will
 675  * be incremented, and any floating reference will be removed (see gst_object_ref_sink()).
 676  *
 677  * Returns: TRUE if @parent could be set or FALSE when @object
 678  * already had a parent or @object and @parent are the same.
 679  *
 680  * MT safe. Grabs and releases @object's LOCK.
 681  */
 682 gboolean
 683 gst_object_set_parent (GstObject * object, GstObject * parent)
 684 {
 685   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
 686   g_return_val_if_fail (GST_IS_OBJECT (parent), FALSE);
 687   g_return_val_if_fail (object != parent, FALSE);
 688
 689   GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, object,
 690       "set parent (ref and sink)");
 691
 692   GST_OBJECT_LOCK (object);
 693   if (G_UNLIKELY (object->parent != NULL))
 694     goto had_parent;
 695
 696   object->parent = parent;
 697   gst_object_ref_sink (object);
 698   GST_OBJECT_UNLOCK (object);
 699
 700   /* FIXME, this does not work, the deep notify takes the lock from the parent
 701    * object and deadlocks when the parent holds its lock when calling this
 702    * function (like _element_add_pad()) */
 703   /* g_object_notify_by_pspec ((GObject *)object, properties[PROP_PARENT]); */
 704
 705   return TRUE;
 706
 707   /* ERROR handling */
 708 had_parent:
 709   {
 710     GST_CAT_DEBUG_OBJECT (GST_CAT_REFCOUNTING, object,
 711         "set parent failed, object already had a parent");
 712     GST_OBJECT_UNLOCK (object);
 713     return FALSE;
 714   }
 715 }
 716
 717 /**
 718  * gst_object_get_parent:
 719  * @object: a #GstObject
 720  *
 721  * Returns the parent of @object. This function increases the refcount
 722  * of the parent object so you should gst_object_unref() it after usage.
 723  *
 724  * Returns: (transfer full): parent of @object, this can be NULL if @object
 725  *   has no parent. unref after usage.
 726  *
 727  * MT safe. Grabs and releases @object's LOCK.
 728  */
 729 GstObject *
 730 gst_object_get_parent (GstObject * object)
 731 {
 732   GstObject *result = NULL;
 733
 734   g_return_val_if_fail (GST_IS_OBJECT (object), NULL);
 735
 736   GST_OBJECT_LOCK (object);
 737   result = object->parent;
 738   if (G_LIKELY (result))
 739     gst_object_ref (result);
 740   GST_OBJECT_UNLOCK (object);
 741
 742   return result;
 743 }
 744
 745 /**
 746  * gst_object_unparent:
 747  * @object: a #GstObject to unparent
 748  *
 749  * Clear the parent of @object, removing the associated reference.
 750  * This function decreases the refcount of @object.
 751  *
 752  * MT safe. Grabs and releases @object's lock.
 753  */
 754 void
 755 gst_object_unparent (GstObject * object)
 756 {
 757   GstObject *parent;
 758
 759   g_return_if_fail (GST_IS_OBJECT (object));
 760
 761   GST_OBJECT_LOCK (object);
 762   parent = object->parent;
 763
 764   if (G_LIKELY (parent != NULL)) {
 765     GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "unparent");
 766     object->parent = NULL;
 767     GST_OBJECT_UNLOCK (object);
 768
 769     /* g_object_notify_by_pspec ((GObject *)object, properties[PROP_PARENT]); */
 770
 771     gst_object_unref (object);
 772   } else {
 773     GST_OBJECT_UNLOCK (object);
 774   }
 775 }
 776
 777 /**
 778  * gst_object_has_ancestor:
 779  * @object: a #GstObject to check
 780  * @ancestor: a #GstObject to check as ancestor
 781  *
 782  * Check if @object has an ancestor @ancestor somewhere up in
 783  * the hierarchy. One can e.g. check if a #GstElement is inside a #GstPipeline.
 784  *
 785  * Returns: TRUE if @ancestor is an ancestor of @object.
 786  *
 787  * MT safe. Grabs and releases @object's locks.
 788  */
 789 gboolean
 790 gst_object_has_ancestor (GstObject * object, GstObject * ancestor)
 791 {
 792   GstObject *parent, *tmp;
 793
 794   if (!ancestor || !object)
 795     return FALSE;
 796
 797   parent = gst_object_ref (object);
 798   do {
 799     if (parent == ancestor) {
 800       gst_object_unref (parent);
 801       return TRUE;
 802     }
 803
 804     tmp = gst_object_get_parent (parent);
 805     gst_object_unref (parent);
 806     parent = tmp;
 807   } while (parent);
 808
 809   return FALSE;
 810 }
 811
 812 /**
 813  * gst_object_check_uniqueness:
 814  * @list: (transfer none) (element-type Gst.Object): a list of #GstObject to
 815  *      check through
 816  * @name: the name to search for
 817  *
 818  * Checks to see if there is any object named @name in @list. This function
 819  * does not do any locking of any kind. You might want to protect the
 820  * provided list with the lock of the owner of the list. This function
 821  * will lock each #GstObject in the list to compare the name, so be
 822  * carefull when passing a list with a locked object.
 823  *
 824  * Returns: TRUE if a #GstObject named @name does not appear in @list,
 825  * FALSE if it does.
 826  *
 827  * MT safe. Grabs and releases the LOCK of each object in the list.
 828  */
 829 gboolean
 830 gst_object_check_uniqueness (GList * list, const gchar * name)
 831 {
 832   gboolean result = TRUE;
 833
 834   g_return_val_if_fail (name != NULL, FALSE);
 835
 836   for (; list; list = g_list_next (list)) {
 837     GstObject *child;
 838     gboolean eq;
 839
 840     child = GST_OBJECT_CAST (list->data);
 841
 842     GST_OBJECT_LOCK (child);
 843     eq = strcmp (GST_OBJECT_NAME (child), name) == 0;
 844     GST_OBJECT_UNLOCK (child);
 845
 846     if (G_UNLIKELY (eq)) {
 847       result = FALSE;
 848       break;
 849     }
 850   }
 851   return result;
 852 }
 853
 854
 855 static void
 856 gst_object_set_property (GObject * object, guint prop_id,
 857     const GValue * value, GParamSpec * pspec)
 858 {
 859   GstObject *gstobject;
 860
 861   gstobject = GST_OBJECT_CAST (object);
 862
 863   switch (prop_id) {
 864     case PROP_NAME:
 865       gst_object_set_name (gstobject, g_value_get_string (value));
 866       break;
 867     case PROP_PARENT:
 868       gst_object_set_parent (gstobject, g_value_get_object (value));
 869       break;
 870     default:
 871       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 872       break;
 873   }
 874 }
 875
 876 static void
 877 gst_object_get_property (GObject * object, guint prop_id,
 878     GValue * value, GParamSpec * pspec)
 879 {
 880   GstObject *gstobject;
 881
 882   gstobject = GST_OBJECT_CAST (object);
 883
 884   switch (prop_id) {
 885     case PROP_NAME:
 886       g_value_take_string (value, gst_object_get_name (gstobject));
 887       break;
 888     case PROP_PARENT:
 889       g_value_take_object (value, gst_object_get_parent (gstobject));
 890       break;
 891     default:
 892       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 893       break;
 894   }
 895 }
 896
 897 /**
 898  * gst_object_get_path_string:
 899  * @object: a #GstObject
 900  *
 901  * Generates a string describing the path of @object in
 902  * the object hierarchy. Only useful (or used) for debugging.
 903  *
 904  * Free-function: g_free
 905  *
 906  * Returns: (transfer full): a string describing the path of @object. You must
 907  *          g_free() the string after usage.
 908  *
 909  * MT safe. Grabs and releases the #GstObject's LOCK for all objects
 910  *          in the hierarchy.
 911  */
 912 gchar *
 913 gst_object_get_path_string (GstObject * object)
 914 {
 915   GSList *parentage;
 916   GSList *parents;
 917   void *parent;
 918   gchar *prevpath, *path;
 919   const gchar *typename;
 920   gchar *component;
 921   const gchar *separator;
 922
 923   /* ref object before adding to list */
 924   gst_object_ref (object);
 925   parentage = g_slist_prepend (NULL, object);
 926
 927   path = g_strdup ("");
 928
 929   /* first walk the object hierarchy to build a list of the parents,
 930    * be carefull here with refcounting. */
 931   do {
 932     if (GST_IS_OBJECT (object)) {
 933       parent = gst_object_get_parent (object);
 934       /* add parents to list, refcount remains increased while
 935        * we handle the object */
 936       if (parent)
 937         parentage = g_slist_prepend (parentage, parent);
 938     } else {
 939       break;
 940     }
 941     object = parent;
 942   } while (object != NULL);
 943
 944   /* then walk the parent list and print them out. we need to
 945    * decrease the refcounting on each element after we handled
 946    * it. */
 947   for (parents = parentage; parents; parents = g_slist_next (parents)) {
 948     if (G_IS_OBJECT (parents->data)) {
 949       typename = G_OBJECT_TYPE_NAME (parents->data);
 950     } else {
 951       typename = NULL;
 952     }
 953     if (GST_IS_OBJECT (parents->data)) {
 954       GstObject *item = GST_OBJECT_CAST (parents->data);
 955       GstObjectClass *oclass = GST_OBJECT_GET_CLASS (item);
 956       gchar *objname = gst_object_get_name (item);
 957
 958       component = g_strdup_printf ("%s:%s", typename, objname);
 959       separator = oclass->path_string_separator;
 960       /* and unref now */
 961       gst_object_unref (item);
 962       g_free (objname);
 963     } else {
 964       if (typename) {
 965         component = g_strdup_printf ("%s:%p", typename, parents->data);
 966       } else {
 967         component = g_strdup_printf ("%p", parents->data);
 968       }
 969       separator = "/";
 970     }
 971
 972     prevpath = path;
 973     path = g_strjoin (separator, prevpath, component, NULL);
 974     g_free (prevpath);
 975     g_free (component);
 976   }
 977
 978   g_slist_free (parentage);
 979
 980   return path;
 981 }
 982
 983 /* controller helper functions */
 984
 985 /*
 986  * gst_object_find_control_binding:
 987  * @self: the gobject to search for a property in
 988  * @name: the gobject property name to look for
 989  *
 990  * Searches the list of properties under control.
 991  *
 992  * Returns: a #GstControlBinding or %NULL if the property is not being
 993  * controlled.
 994  */
 995 static GstControlBinding *
 996 gst_object_find_control_binding (GstObject * self, const gchar * name)
 997 {
 998   GstControlBinding *binding;
 999   GList *node;
1000
1001   for (node = self->control_bindings; node; node = g_list_next (node)) {
1002     binding = node->data;
1003     /* FIXME: eventually use GQuark to speed it up */
1004     if (!strcmp (binding->name, name)) {
1005       GST_DEBUG_OBJECT (self, "found control binding for property '%s'", name);
1006       return binding;
1007     }
1008   }
1009   GST_DEBUG_OBJECT (self, "controller does not manage property '%s'", name);
1010
1011   return NULL;
1012 }
1013
1014 /* controller functions */
1015
1016 /**
1017  * gst_object_suggest_next_sync:
1018  * @object: the object that has controlled properties
1019  *
1020  * Returns a suggestion for timestamps where buffers should be split
1021  * to get best controller results.
1022  *
1023  * Returns: Returns the suggested timestamp or %GST_CLOCK_TIME_NONE
1024  * if no control-rate was set.
1025  */
1026 GstClockTime
1027 gst_object_suggest_next_sync (GstObject * object)
1028 {
1029   GstClockTime ret;
1030
1031   g_return_val_if_fail (GST_IS_OBJECT (object), GST_CLOCK_TIME_NONE);
1032   g_return_val_if_fail (object->control_rate != GST_CLOCK_TIME_NONE,
1033       GST_CLOCK_TIME_NONE);
1034
1035   GST_OBJECT_LOCK (object);
1036
1037   /* TODO: Implement more logic, depending on interpolation mode and control
1038    * points
1039    * FIXME: we need playback direction
1040    */
1041   ret = object->last_sync + object->control_rate;
1042
1043   GST_OBJECT_UNLOCK (object);
1044
1045   return ret;
1046 }
1047
1048 /**
1049  * gst_object_sync_values:
1050  * @object: the object that has controlled properties
1051  * @timestamp: the time that should be processed
1052  *
1053  * Sets the properties of the object, according to the #GstControlSources that
1054  * (maybe) handle them and for the given timestamp.
1055  *
1056  * If this function fails, it is most likely the application developers fault.
1057  * Most probably the control sources are not setup correctly.
1058  *
1059  * Returns: %TRUE if the controller values could be applied to the object
1060  * properties, %FALSE otherwise
1061  */
1062 gboolean
1063 gst_object_sync_values (GstObject * object, GstClockTime timestamp)
1064 {
1065   GList *node;
1066   gboolean ret = TRUE;
1067
1068   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1069   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), FALSE);
1070
1071   GST_LOG_OBJECT (object, "sync_values");
1072   if (!object->control_bindings)
1073     return TRUE;
1074
1075   /* FIXME: this deadlocks */
1076   /* GST_OBJECT_LOCK (object); */
1077   g_object_freeze_notify ((GObject *) object);
1078   for (node = object->control_bindings; node; node = g_list_next (node)) {
1079     ret &= gst_control_binding_sync_values ((GstControlBinding *) node->data,
1080         object, timestamp, object->last_sync);
1081   }
1082   object->last_sync = timestamp;
1083   g_object_thaw_notify ((GObject *) object);
1084   /* GST_OBJECT_UNLOCK (object); */
1085
1086   return ret;
1087 }
1088
1089
1090 /**
1091  * gst_object_has_active_control_bindings:
1092  * @object: the object that has controlled properties
1093  *
1094  * Check if the @object has an active controlled properties.
1095  *
1096  * Returns: %TRUE if the object has active controlled properties
1097  */
1098 gboolean
1099 gst_object_has_active_control_bindings (GstObject * object)
1100 {
1101   gboolean res = FALSE;
1102   GList *node;
1103
1104   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1105
1106   GST_OBJECT_LOCK (object);
1107   for (node = object->control_bindings; node; node = g_list_next (node)) {
1108     res |= !gst_control_binding_is_disabled ((GstControlBinding *) node->data);
1109   }
1110   GST_OBJECT_UNLOCK (object);
1111   return res;
1112 }
1113
1114 /**
1115  * gst_object_set_control_bindings_disabled:
1116  * @object: the object that has controlled properties
1117  * @disabled: boolean that specifies whether to disable the controller
1118  * or not.
1119  *
1120  * This function is used to disable all controlled properties of the @object for
1121  * some time, i.e. gst_object_sync_values() will do nothing.
1122  */
1123 void
1124 gst_object_set_control_bindings_disabled (GstObject * object, gboolean disabled)
1125 {
1126   GList *node;
1127
1128   g_return_if_fail (GST_IS_OBJECT (object));
1129
1130   GST_OBJECT_LOCK (object);
1131   for (node = object->control_bindings; node; node = g_list_next (node)) {
1132     gst_control_binding_set_disabled ((GstControlBinding *) node->data,
1133         disabled);
1134   }
1135   GST_OBJECT_UNLOCK (object);
1136 }
1137
1138 /**
1139  * gst_object_set_control_binding_disabled:
1140  * @object: the object that has controlled properties
1141  * @property_name: property to disable
1142  * @disabled: boolean that specifies whether to disable the controller
1143  * or not.
1144  *
1145  * This function is used to disable the #GstController on a property for
1146  * some time, i.e. gst_controller_sync_values() will do nothing for the
1147  * property.
1148  */
1149 void
1150 gst_object_set_control_binding_disabled (GstObject * object,
1151     const gchar * property_name, gboolean disabled)
1152 {
1153   GstControlBinding *binding;
1154
1155   g_return_if_fail (GST_IS_OBJECT (object));
1156   g_return_if_fail (property_name);
1157
1158   GST_OBJECT_LOCK (object);
1159   if ((binding = gst_object_find_control_binding (object, property_name))) {
1160     gst_control_binding_set_disabled (binding, disabled);
1161   }
1162   GST_OBJECT_UNLOCK (object);
1163 }
1164
1165
1166 /**
1167  * gst_object_add_control_binding:
1168  * @object: the controller object
1169  * @binding: (transfer full): the #GstControlBinding that should be used
1170  *
1171  * Sets the #GstControlBinding. If there already was a #GstControlBinding
1172  * for this property it will be replaced.
1173  * The @object will take ownership of the @binding.
1174  *
1175  * Returns: %FALSE if the given @binding has not been setup for this object  or
1176  * %TRUE otherwise.
1177  */
1178 gboolean
1179 gst_object_add_control_binding (GstObject * object, GstControlBinding * binding)
1180 {
1181   GstControlBinding *old;
1182
1183   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1184   g_return_val_if_fail (GST_IS_CONTROL_BINDING (binding), FALSE);
1185   //g_return_val_if_fail (g_type_is_a (binding->pspec->owner_type,
1186   //        G_OBJECT_TYPE (object)), FALSE);
1187
1188   GST_OBJECT_LOCK (object);
1189   if ((old = gst_object_find_control_binding (object, binding->name))) {
1190     GST_DEBUG_OBJECT (object, "controlled property %s removed", old->name);
1191     object->control_bindings = g_list_remove (object->control_bindings, old);
1192     gst_object_unparent (GST_OBJECT_CAST (old));
1193   }
1194   object->control_bindings = g_list_prepend (object->control_bindings, binding);
1195   gst_object_set_parent (GST_OBJECT_CAST (binding), object);
1196   GST_DEBUG_OBJECT (object, "controlled property %s added", binding->name);
1197   GST_OBJECT_UNLOCK (object);
1198
1199   return TRUE;
1200 }
1201
1202 /**
1203  * gst_object_get_control_binding:
1204  * @object: the object
1205  * @property_name: name of the property
1206  *
1207  * Gets the corresponding #GstControlBinding for the property. This should be
1208  * unreferenced again after use.
1209  *
1210  * Returns: (transfer full): the #GstControlBinding for @property_name or %NULL if
1211  * the property is not controlled.
1212  */
1213 GstControlBinding *
1214 gst_object_get_control_binding (GstObject * object, const gchar * property_name)
1215 {
1216   GstControlBinding *binding;
1217
1218   g_return_val_if_fail (GST_IS_OBJECT (object), NULL);
1219   g_return_val_if_fail (property_name, NULL);
1220
1221   GST_OBJECT_LOCK (object);
1222   if ((binding = gst_object_find_control_binding (object, property_name))) {
1223     g_object_ref (binding);
1224   }
1225   GST_OBJECT_UNLOCK (object);
1226
1227   return binding;
1228 }
1229
1230 /**
1231  * gst_object_remove_control_binding:
1232  * @object: the object
1233  * @binding: the binding
1234  *
1235  * Removes the corresponding #GstControlBinding. If it was the
1236  * last ref of the binding, it will be disposed.
1237  *
1238  * Returns: %TRUE if the binding could be removed.
1239  */
1240 gboolean
1241 gst_object_remove_control_binding (GstObject * object,
1242     GstControlBinding * binding)
1243 {
1244   GList *node;
1245   gboolean ret = FALSE;
1246
1247   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1248   g_return_val_if_fail (GST_IS_CONTROL_BINDING (binding), FALSE);
1249
1250   GST_OBJECT_LOCK (object);
1251   if ((node = g_list_find (object->control_bindings, binding))) {
1252     GST_DEBUG_OBJECT (object, "controlled property %s removed", binding->name);
1253     object->control_bindings =
1254         g_list_delete_link (object->control_bindings, node);
1255     gst_object_unparent (GST_OBJECT_CAST (binding));
1256     ret = TRUE;
1257   }
1258   GST_OBJECT_UNLOCK (object);
1259
1260   return ret;
1261 }
1262
1263 /**
1264  * gst_object_get_value:
1265  * @object: the object that has controlled properties
1266  * @property_name: the name of the property to get
1267  * @timestamp: the time the control-change should be read from
1268  *
1269  * Gets the value for the given controlled property at the requested time.
1270  *
1271  * Returns: the GValue of the property at the given time, or %NULL if the
1272  * property isn't controlled.
1273  */
1274 GValue *
1275 gst_object_get_value (GstObject * object, const gchar * property_name,
1276     GstClockTime timestamp)
1277 {
1278   GstControlBinding *binding;
1279   GValue *val = NULL;
1280
1281   g_return_val_if_fail (GST_IS_OBJECT (object), NULL);
1282   g_return_val_if_fail (property_name, NULL);
1283   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), NULL);
1284
1285   GST_OBJECT_LOCK (object);
1286   if ((binding = gst_object_find_control_binding (object, property_name))) {
1287     val = gst_control_binding_get_value (binding, timestamp);
1288   }
1289   GST_OBJECT_UNLOCK (object);
1290
1291   return val;
1292 }
1293
1294 /**
1295  * gst_object_get_value_array:
1296  * @object: the object that has controlled properties
1297  * @property_name: the name of the property to get
1298  * @timestamp: the time that should be processed
1299  * @interval: the time spacing between subsequent values
1300  * @n_values: the number of values
1301  * @values: array to put control-values in
1302  *
1303  * Gets a number of values for the given controllered property starting at the
1304  * requested time. The array @values need to hold enough space for @n_values of
1305  * the same type as the objects property's type.
1306  *
1307  * This function is useful if one wants to e.g. draw a graph of the control
1308  * curve or apply a control curve sample by sample.
1309  *
1310  * Returns: %TRUE if the given array could be filled, %FALSE otherwise
1311  */
1312 gboolean
1313 gst_object_get_value_array (GstObject * object, const gchar * property_name,
1314     GstClockTime timestamp, GstClockTime interval, guint n_values,
1315     GValue * values)
1316 {
1317   gboolean res = FALSE;
1318   GstControlBinding *binding;
1319
1320   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1321   g_return_val_if_fail (property_name, FALSE);
1322   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), FALSE);
1323   g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (interval), FALSE);
1324   g_return_val_if_fail (values, FALSE);
1325
1326   GST_OBJECT_LOCK (object);
1327   if ((binding = gst_object_find_control_binding (object, property_name))) {
1328     res = gst_control_binding_get_value_array (binding, timestamp, interval,
1329         n_values, values);
1330   }
1331   GST_OBJECT_UNLOCK (object);
1332   return res;
1333 }
1334
1335
1336 /**
1337  * gst_object_get_control_rate:
1338  * @object: the object that has controlled properties
1339  *
1340  * Obtain the control-rate for this @object. Audio processing #GstElement
1341  * objects will use this rate to sub-divide their processing loop and call
1342  * gst_object_sync_values() inbetween. The length of the processing segment
1343  * should be up to @control-rate nanoseconds.
1344  *
1345  * If the @object is not under property control, this will return
1346  * %GST_CLOCK_TIME_NONE. This allows the element to avoid the sub-dividing.
1347  *
1348  * The control-rate is not expected to change if the element is in
1349  * %GST_STATE_PAUSED or %GST_STATE_PLAYING.
1350  *
1351  * Returns: the control rate in nanoseconds
1352  */
1353 GstClockTime
1354 gst_object_get_control_rate (GstObject * object)
1355 {
1356   g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
1357
1358   return object->control_rate;
1359 }
1360
1361 /**
1362  * gst_object_set_control_rate:
1363  * @object: the object that has controlled properties
1364  * @control_rate: the new control-rate in nanoseconds.
1365  *
1366  * Change the control-rate for this @object. Audio processing #GstElement
1367  * objects will use this rate to sub-divide their processing loop and call
1368  * gst_object_sync_values() inbetween. The length of the processing segment
1369  * should be up to @control-rate nanoseconds.
1370  *
1371  * The control-rate should not change if the element is in %GST_STATE_PAUSED or
1372  * %GST_STATE_PLAYING.
1373  */
1374 void
1375 gst_object_set_control_rate (GstObject * object, GstClockTime control_rate)
1376 {
1377   g_return_if_fail (GST_IS_OBJECT (object));
1378
1379   object->control_rate = control_rate;
1380 }