*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
/**
*
* #GstObject provides a root for the object hierarchy tree filed in by the
* GStreamer library. It is currently a thin wrapper on top of
- * #GObject. It is an abstract class that is not very usable on its own.
+ * #GInitiallyUnowned. It is an abstract class that is not very usable on its own.
*
* #GstObject gives us basic refcounting, parenting functionality and locking.
* Most of the function are just extended for special GStreamer needs and can be
* found under the same name in the base class of #GstObject which is #GObject
* (e.g. g_object_ref() becomes gst_object_ref()).
*
- * The most interesting difference between #GstObject and #GObject is the
- * "floating" reference count. A #GObject is created with a reference count of
- * 1, owned by the creator of the #GObject. (The owner of a reference is the
- * code section that has the right to call gst_object_unref() in order to
- * remove that reference.) A #GstObject is created with a reference count of 1
- * also, but it isn't owned by anyone; Instead, the initial reference count
- * of a #GstObject is "floating". The floating reference can be removed by
- * anyone at any time, by calling gst_object_sink(). gst_object_sink() does
- * nothing if an object is already sunk (has no floating reference).
- *
- * When you add a #GstElement to its parent container, the parent container will
- * do this:
- * <informalexample>
- * <programlisting>
- * gst_object_ref (GST_OBJECT (child_element));
- * gst_object_sink (GST_OBJECT (child_element));
- * </programlisting>
- * </informalexample>
- * This means that the container now owns a reference to the child element
- * (since it called gst_object_ref()), and the child element has no floating
- * reference.
- *
- * The purpose of the floating reference is to keep the child element alive
- * until you add it to a parent container, which then manages the lifetime of
- * the object itself:
- * <informalexample>
- * <programlisting>
- * element = gst_element_factory_make (factoryname, name);
- * // element has one floating reference to keep it alive
- * gst_bin_add (GST_BIN (bin), element);
- * // element has one non-floating reference owned by the container
- * </programlisting>
- * </informalexample>
- *
- * Another effect of this is, that calling gst_object_unref() on a bin object,
- * will also destoy all the #GstElement objects in it. The same is true for
- * calling gst_bin_remove().
- *
- * Special care has to be taken for all methods that gst_object_sink() an object
- * since if the caller of those functions had a floating reference to the object,
- * the object reference is now invalid.
+ * Since #GstObject dereives from #GInitiallyUnowned, it also inherits the
+ * floating reference. Be aware that functions such as gst_bin_add() and
+ * gst_element_add_pad() take ownership of the floating reference.
*
* In contrast to #GObject instances, #GstObject adds a name property. The functions
* gst_object_set_name() and gst_object_get_name() are used to set/get the name
* <para>
* Controlled properties offers a lightweight way to adjust gobject
* properties over stream-time. It works by using time-stamped value pairs that
- * are queued for element-properties. At run-time the elements continously pull
+ * are queued for element-properties. At run-time the elements continuously pull
* values changes for the current stream-time.
*
* What needs to be changed in a #GstElement?
* </orderedlist>
*
* What needs to be done in applications?
- * Again its not a lot to change.
+ * Again it's not a lot to change.
* <orderedlist>
* <listitem><para>
- * first put some properties under control, by calling
- * gst_object_control_properties (object, "prop1", "prop2",...);
- * </para></listitem>
- * <listitem><para>
* create a #GstControlSource.
* csource = gst_interpolation_control_source_new ();
* g_object_set (csource, "mode", GST_INTERPOLATION_MODE_LINEAR, NULL);
* </para></listitem>
* <listitem><para>
* Attach the #GstControlSource on the controller to a property.
- * gst_object_set_control_source (object, "prop1", csource);
+ * gst_object_add_control_binding (object, gst_direct_control_binding_new (object, "prop1", csource));
* </para></listitem>
* <listitem><para>
* Set the control values
* </para>
* </refsect2>
*
- * Last reviewed on 2005-11-09 (0.9.4)
+ * Last reviewed on 2012-03-29 (0.11.3)
*/
#include "gst_private.h"
#include "glib-compat-private.h"
#include "gstobject.h"
-#include "gstmarshal.h"
#include "gstclock.h"
#include "gstcontrolbinding.h"
#include "gstcontrolsource.h"
GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
#ifndef GST_DISABLE_TRACE
- _gst_object_trace = gst_alloc_trace_register (g_type_name (GST_TYPE_OBJECT));
+ _gst_object_trace =
+ _gst_alloc_trace_register (g_type_name (GST_TYPE_OBJECT), -2);
#endif
gobject_class->set_property = gst_object_set_property;
properties[PROP_NAME] =
g_param_spec_string ("name", "Name", "The name of the object", NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS);
- g_object_class_install_property (gobject_class, PROP_NAME,
- properties[PROP_NAME]);
properties[PROP_PARENT] =
g_param_spec_object ("parent", "Parent", "The parent of the object",
GST_TYPE_OBJECT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
- g_object_class_install_property (gobject_class, PROP_PARENT,
- properties[PROP_PARENT]);
+
+ g_object_class_install_properties (gobject_class, PROP_LAST, properties);
/**
* GstObject::deep-notify:
g_signal_new ("deep-notify", G_TYPE_FROM_CLASS (klass),
G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED |
G_SIGNAL_NO_HOOKS, G_STRUCT_OFFSET (GstObjectClass, deep_notify), NULL,
- NULL, gst_marshal_VOID__OBJECT_PARAM, G_TYPE_NONE, 2, GST_TYPE_OBJECT,
+ NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 2, GST_TYPE_OBJECT,
G_TYPE_PARAM);
klass->path_string_separator = "/";
static void
gst_object_init (GstObject * object)
{
- object->lock = g_mutex_new ();
+ g_mutex_init (&object->lock);
object->parent = NULL;
object->name = NULL;
GST_CAT_TRACE_OBJECT (GST_CAT_REFCOUNTING, object, "%p new", object);
#ifndef GST_DISABLE_TRACE
- gst_alloc_trace_new (_gst_object_trace, object);
+ _gst_alloc_trace_new (_gst_object_trace, object);
#endif
object->flags = 0;
/**
* gst_object_ref:
- * @object: a #GstObject to reference
+ * @object: (type Gst.Object): a #GstObject to reference
*
* Increments the reference count on @object. This function
* does not take the lock on @object because it relies on
* constructs like :
* result = gst_object_ref (object->parent);
*
- * Returns: (transfer full): A pointer to @object
+ * Returns: (transfer full) (type Gst.Object): A pointer to @object
*/
gpointer
gst_object_ref (gpointer object)
/**
* gst_object_unref:
- * @object: a #GstObject to unreference
+ * @object: (type Gst.Object): a #GstObject to unreference
*
* Decrements the reference count on @object. If reference count hits
* zero, destroy @object. This function does not take the lock
return FALSE;
if (newobj)
- g_object_ref (newobj);
+ gst_object_ref (newobj);
while (G_UNLIKELY (!g_atomic_pointer_compare_and_exchange ((gpointer *)
oldobj, oldptr, newobj))) {
}
if (oldptr)
- g_object_unref (oldptr);
+ gst_object_unref (oldptr);
return oldptr != newobj;
}
GList *node;
for (node = self->control_bindings; node; node = g_list_next (node)) {
- g_object_unref (node->data);
+ gst_object_unparent (node->data);
}
g_list_free (self->control_bindings);
self->control_bindings = NULL;
g_signal_handlers_destroy (object);
g_free (gstobject->name);
- g_mutex_free (gstobject->lock);
+ g_mutex_clear (&gstobject->lock);
#ifndef GST_DISABLE_TRACE
- gst_alloc_trace_free (_gst_object_trace, object);
+ _gst_alloc_trace_free (_gst_object_trace, object);
#endif
((GObjectClass *) gst_object_parent_class)->finalize (object);
* @object: the #GObject that signalled the notify.
* @orig: a #GstObject that initiated the notify.
* @pspec: a #GParamSpec of the property.
- * @excluded_props: (array zero-terminated=1) (element-type gchar*)
- * (allow-none):a set of user-specified properties to exclude or
- * NULL to show all changes.
+ * @excluded_props: (array zero-terminated=1) (element-type gchar*) (allow-none):
+ * a set of user-specified properties to exclude or NULL to show
+ * all changes.
*
* A default deep_notify signal callback for an object. The user data
* should contain a pointer to an array of strings that should be excluded
g_value_init (&value, pspec->value_type);
g_object_get_property (G_OBJECT (orig), pspec->name, &value);
- /* FIXME: handle flags */
- if (G_IS_PARAM_SPEC_ENUM (pspec)) {
- GEnumValue *enum_value;
- GEnumClass *klass = G_ENUM_CLASS (g_type_class_ref (pspec->value_type));
-
- enum_value = g_enum_get_value (klass, g_value_get_enum (&value));
-
- str = g_strdup_printf ("%s (%d)", enum_value->value_nick,
- enum_value->value);
- g_type_class_unref (klass);
- } else {
- str = g_strdup_value_contents (&value);
- }
+ if (G_VALUE_HOLDS_STRING (&value))
+ str = g_value_dup_string (&value);
+ else
+ str = gst_value_serialize (&value);
name = gst_object_get_path_string (orig);
g_print ("%s: %s = %s\n", name, pspec->name, str);
g_free (name);
type_name = g_quark_to_string (q);
if (strncmp (type_name, "Gst", 3) == 0)
type_name += 3;
- name = g_strdup_printf ("%s%d", type_name, count);
+ /* give the 20th "queue" element and the first "queue2" different names */
+ l = strlen (type_name);
+ if (l > 0 && g_ascii_isdigit (type_name[l - 1])) {
+ name = g_strdup_printf ("%s-%d", type_name, count);
+ } else {
+ name = g_strdup_printf ("%s%d", type_name, count);
+ }
+
l = strlen (name);
for (i = 0; i < l; i++)
name[i] = g_ascii_tolower (name[i]);
/**
- * gst_object_set_control_binding:
+ * gst_object_add_control_binding:
* @object: the controller object
- * @binding: the #GstControlBinding that should be used for the property
+ * @binding: (transfer full): the #GstControlBinding that should be used
+ *
+ * Attach the #GstControlBinding to the object. If there already was a
+ * #GstControlBinding for this property it will be replaced.
*
- * Sets the #GstControlBinding. If there already was a #GstControlBinding
- * for this property it will be replaced. Use %NULL for @binding to unset it.
+ * The @object will take ownership of the @binding.
*
- * Returns: %FALSE if the given property isn't handled by the controller or
- * %TRUE if everything worked as expected.
+ * Returns: %FALSE if the given @binding has not been setup for this object or
+ * has been setup for a non suitable property, %TRUE otherwise.
*/
gboolean
-gst_object_set_control_binding (GstObject * object, GstControlBinding * binding)
+gst_object_add_control_binding (GstObject * object, GstControlBinding * binding)
{
GstControlBinding *old;
- gboolean ret = FALSE;
g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
- g_return_val_if_fail ((!binding || GST_IS_CONTROL_BINDING (binding)), FALSE);
+ g_return_val_if_fail (GST_IS_CONTROL_BINDING (binding), FALSE);
+ g_return_val_if_fail (binding->pspec, FALSE);
GST_OBJECT_LOCK (object);
if ((old = gst_object_find_control_binding (object, binding->name))) {
+ GST_DEBUG_OBJECT (object, "controlled property %s removed", old->name);
object->control_bindings = g_list_remove (object->control_bindings, old);
- g_object_unref (old);
- GST_DEBUG_OBJECT (object, "controlled property %s removed", binding->name);
- ret = TRUE;
- }
- if (binding) {
- object->control_bindings =
- g_list_prepend (object->control_bindings, g_object_ref (binding));
- GST_DEBUG_OBJECT (object, "controlled property %s added", binding->name);
- ret = TRUE;
+ gst_object_unparent (GST_OBJECT_CAST (old));
}
+ object->control_bindings = g_list_prepend (object->control_bindings, binding);
+ gst_object_set_parent (GST_OBJECT_CAST (binding), object);
+ GST_DEBUG_OBJECT (object, "controlled property %s added", binding->name);
GST_OBJECT_UNLOCK (object);
- return ret;
+ return TRUE;
}
/**
GST_OBJECT_LOCK (object);
if ((binding = gst_object_find_control_binding (object, property_name))) {
- g_object_ref (binding);
+ gst_object_ref (binding);
}
GST_OBJECT_UNLOCK (object);
}
/**
- * gst_object_set_control_source:
- * @object: the controller object
- * @property_name: name of the property for which the #GstControlSource should be set
- * @csource: the #GstControlSource that should be used for the property
- *
- * Sets the #GstControlSource for @property_name. If there already was a #GstControlSource
- * for this property it will be unreferenced.
+ * gst_object_remove_control_binding:
+ * @object: the object
+ * @binding: the binding
*
- * This is a convenience function for gst_object_set_control_binding().
+ * Removes the corresponding #GstControlBinding. If it was the
+ * last ref of the binding, it will be disposed.
*
- * Returns: %FALSE if the given property isn't handled by the controller or the new #GstControlSource
- * couldn't be bound to the property, %TRUE if everything worked as expected.
+ * Returns: %TRUE if the binding could be removed.
*/
gboolean
-gst_object_set_control_source (GstObject * object, const gchar * property_name,
- GstControlSource * csource)
+gst_object_remove_control_binding (GstObject * object,
+ GstControlBinding * binding)
{
- GstControlBinding *binding;
+ GList *node;
gboolean ret = FALSE;
g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
- g_return_val_if_fail (property_name, FALSE);
- g_return_val_if_fail ((!csource || GST_IS_CONTROL_SOURCE (csource)), FALSE);
+ g_return_val_if_fail (GST_IS_CONTROL_BINDING (binding), FALSE);
GST_OBJECT_LOCK (object);
- if ((binding = gst_object_find_control_binding (object, property_name))) {
+ if ((node = g_list_find (object->control_bindings, binding))) {
+ GST_DEBUG_OBJECT (object, "controlled property %s removed", binding->name);
object->control_bindings =
- g_list_remove (object->control_bindings, binding);
- g_object_unref (binding);
- GST_DEBUG_OBJECT (object, "controlled property %s removed", property_name);
+ g_list_delete_link (object->control_bindings, node);
+ gst_object_unparent (GST_OBJECT_CAST (binding));
ret = TRUE;
}
- if (csource) {
- if ((binding = gst_control_binding_new (object, property_name, csource))) {
- object->control_bindings =
- g_list_prepend (object->control_bindings, binding);
- GST_DEBUG_OBJECT (object, "controlled property %s added", property_name);
- ret = TRUE;
- } else {
- ret = FALSE;
- }
- }
- GST_OBJECT_UNLOCK (object);
-
- return ret;
-}
-
-/**
- * gst_object_get_control_source:
- * @object: the object
- * @property_name: name of the property
- *
- * Gets the corresponding #GstControlSource for the property. This should be
- * unreferenced again after use.
- *
- * This is a convenience function for gst_object_get_control_binding().
- *
- * Returns: (transfer full): the #GstControlSource for @property_name or %NULL if
- * the property is not controlled.
- */
-GstControlSource *
-gst_object_get_control_source (GstObject * object, const gchar * property_name)
-{
- GstControlBinding *binding;
- GstControlSource *ret = NULL;
-
- g_return_val_if_fail (GST_IS_OBJECT (object), NULL);
- g_return_val_if_fail (property_name, NULL);
-
- GST_OBJECT_LOCK (object);
- if ((binding = gst_object_find_control_binding (object, property_name))) {
- ret = gst_control_binding_get_control_source (binding);
- }
GST_OBJECT_UNLOCK (object);
return ret;
}
-
/**
* gst_object_get_value:
* @object: the object that has controlled properties
* @n_values: the number of values
* @values: array to put control-values in
*
- * Gets a number of values for the given controllered property starting at the
+ * Gets a number of values for the given controlled property starting at the
* requested time. The array @values need to hold enough space for @n_values of
* the same type as the objects property's type.
*
* This function is useful if one wants to e.g. draw a graph of the control
* curve or apply a control curve sample by sample.
*
+ * The values are unboxed and ready to be used. The similar function
+ * gst_object_get_g_value_array() returns the array as #GValues and is
+ * better suites for bindings.
+ *
* Returns: %TRUE if the given array could be filled, %FALSE otherwise
*/
gboolean
gst_object_get_value_array (GstObject * object, const gchar * property_name,
GstClockTime timestamp, GstClockTime interval, guint n_values,
- GValue * values)
+ gpointer values)
{
gboolean res = FALSE;
GstControlBinding *binding;
return res;
}
+/**
+ * gst_object_get_g_value_array:
+ * @object: the object that has controlled properties
+ * @property_name: the name of the property to get
+ * @timestamp: the time that should be processed
+ * @interval: the time spacing between subsequent values
+ * @n_values: the number of values
+ * @values: array to put control-values in
+ *
+ * Gets a number of #GValues for the given controlled property starting at the
+ * requested time. The array @values need to hold enough space for @n_values of
+ * #GValue.
+ *
+ * This function is useful if one wants to e.g. draw a graph of the control
+ * curve or apply a control curve sample by sample.
+ *
+ * Returns: %TRUE if the given array could be filled, %FALSE otherwise
+ */
+gboolean
+gst_object_get_g_value_array (GstObject * object, const gchar * property_name,
+ GstClockTime timestamp, GstClockTime interval, guint n_values,
+ GValue * values)
+{
+ gboolean res = FALSE;
+ GstControlBinding *binding;
+
+ g_return_val_if_fail (GST_IS_OBJECT (object), FALSE);
+ g_return_val_if_fail (property_name, FALSE);
+ g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), FALSE);
+ g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (interval), FALSE);
+ g_return_val_if_fail (values, FALSE);
+
+ GST_OBJECT_LOCK (object);
+ if ((binding = gst_object_find_control_binding (object, property_name))) {
+ res = gst_control_binding_get_g_value_array (binding, timestamp, interval,
+ n_values, values);
+ }
+ GST_OBJECT_UNLOCK (object);
+ return res;
+}
+
/**
* gst_object_get_control_rate:
projects / platform / upstream / gstreamer.git / blobdiff