aboutsummaryrefslogtreecommitdiff
path: root/gst/gstcontrolbinding.c
diff options
context:
space:
mode:
Diffstat (limited to 'gst/gstcontrolbinding.c')
-rw-r--r--gst/gstcontrolbinding.c325
1 files changed, 325 insertions, 0 deletions
diff --git a/gst/gstcontrolbinding.c b/gst/gstcontrolbinding.c
new file mode 100644
index 0000000..74d078e
--- /dev/null
+++ b/gst/gstcontrolbinding.c
@@ -0,0 +1,325 @@
+/* GStreamer
+ *
+ * Copyright (C) 2011 Stefan Sauer <ensonic@users.sf.net>
+ *
+ * gstcontrolbinding.c: Attachment for control sources
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Library General Public License for more details.
+ *
+ * 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.
+ */
+/**
+ * SECTION:gstcontrolbinding
+ * @short_description: attachment for control source sources
+ *
+ * A value mapping object that attaches control sources to gobject properties.
+ */
+
+#include "gst_private.h"
+
+#include <glib-object.h>
+#include <gst/gst.h>
+
+#include "gstcontrolbinding.h"
+
+#include <math.h>
+
+#define GST_CAT_DEFAULT control_binding_debug
+GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
+
+#define _do_init \
+ GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "gstcontrolbinding", 0, \
+ "dynamic parameter control source attachment");
+
+static GObject *gst_control_binding_constructor (GType type,
+ guint n_construct_params, GObjectConstructParam * construct_params);
+static void gst_control_binding_set_property (GObject * object, guint prop_id,
+ const GValue * value, GParamSpec * pspec);
+static void gst_control_binding_get_property (GObject * object, guint prop_id,
+ GValue * value, GParamSpec * pspec);
+static void gst_control_binding_dispose (GObject * object);
+static void gst_control_binding_finalize (GObject * object);
+
+G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GstControlBinding, gst_control_binding,
+ GST_TYPE_OBJECT, _do_init);
+
+enum
+{
+ PROP_0,
+ PROP_OBJECT,
+ PROP_NAME,
+ PROP_LAST
+};
+
+static GParamSpec *properties[PROP_LAST];
+
+static void
+gst_control_binding_class_init (GstControlBindingClass * klass)
+{
+ GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+
+ gobject_class->constructor = gst_control_binding_constructor;
+ gobject_class->set_property = gst_control_binding_set_property;
+ gobject_class->get_property = gst_control_binding_get_property;
+ gobject_class->dispose = gst_control_binding_dispose;
+ gobject_class->finalize = gst_control_binding_finalize;
+
+ properties[PROP_OBJECT] =
+ g_param_spec_object ("object", "Object",
+ "The object of the property", GST_TYPE_OBJECT,
+ G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
+
+ properties[PROP_NAME] =
+ g_param_spec_string ("name", "Name", "The name of the property", NULL,
+ G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS);
+
+
+ g_object_class_install_properties (gobject_class, PROP_LAST, properties);
+}
+
+static void
+gst_control_binding_init (GstControlBinding * self)
+{
+}
+
+static GObject *
+gst_control_binding_constructor (GType type, guint n_construct_params,
+ GObjectConstructParam * construct_params)
+{
+ GstControlBinding *self;
+ GParamSpec *pspec;
+
+ self = GST_CONTROL_BINDING (G_OBJECT_CLASS (gst_control_binding_parent_class)
+ ->constructor (type, n_construct_params, construct_params));
+
+ GST_INFO_OBJECT (self->object, "trying to put property '%s' under control",
+ self->name);
+
+ /* check if the object has a property of that name */
+ if ((pspec =
+ g_object_class_find_property (G_OBJECT_GET_CLASS (self->object),
+ self->name))) {
+ GST_DEBUG_OBJECT (self->object, " psec->flags : 0x%08x", pspec->flags);
+
+ /* check if this param is witable && controlable && !construct-only */
+ if ((pspec->flags & (G_PARAM_WRITABLE | GST_PARAM_CONTROLLABLE |
+ G_PARAM_CONSTRUCT_ONLY)) ==
+ (G_PARAM_WRITABLE | GST_PARAM_CONTROLLABLE)) {
+ self->pspec = pspec;
+ }
+ } else {
+ GST_WARNING_OBJECT (self->object, "class '%s' has no property '%s'",
+ G_OBJECT_TYPE_NAME (self->object), self->name);
+ }
+ return (GObject *) self;
+}
+
+static void
+gst_control_binding_dispose (GObject * object)
+{
+ GstControlBinding *self = GST_CONTROL_BINDING (object);
+
+ if (self->object)
+ gst_object_replace (&self->object, NULL);
+
+ ((GObjectClass *) gst_control_binding_parent_class)->dispose (object);
+}
+
+static void
+gst_control_binding_finalize (GObject * object)
+{
+ GstControlBinding *self = GST_CONTROL_BINDING (object);
+
+ g_free (self->name);
+
+ ((GObjectClass *) gst_control_binding_parent_class)->finalize (object);
+}
+
+static void
+gst_control_binding_set_property (GObject * object, guint prop_id,
+ const GValue * value, GParamSpec * pspec)
+{
+ GstControlBinding *self = GST_CONTROL_BINDING (object);
+
+ switch (prop_id) {
+ case PROP_OBJECT:
+ self->object = g_value_dup_object (value);
+ break;
+ case PROP_NAME:
+ self->name = g_value_dup_string (value);
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
+
+static void
+gst_control_binding_get_property (GObject * object, guint prop_id,
+ GValue * value, GParamSpec * pspec)
+{
+ GstControlBinding *self = GST_CONTROL_BINDING (object);
+
+ switch (prop_id) {
+ case PROP_OBJECT:
+ g_value_set_object (value, self->object);
+ break;
+ case PROP_NAME:
+ g_value_set_string (value, self->name);
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
+
+/* functions */
+
+/**
+ * gst_control_binding_sync_values:
+ * @self: the control binding
+ * @object: the object that has controlled properties
+ * @timestamp: the time that should be processed
+ * @last_sync: the last time this was called
+ *
+ * Sets the property of the @object, according to the #GstControlSources that
+ * handle them and for the given timestamp.
+ *
+ * If this function fails, it is most likely the application developers fault.
+ * Most probably the control sources are not setup correctly.
+ *
+ * Returns: %TRUE if the controller value could be applied to the object
+ * property, %FALSE otherwise
+ */
+gboolean
+gst_control_binding_sync_values (GstControlBinding * self, GstObject * object,
+ GstClockTime timestamp, GstClockTime last_sync)
+{
+ GstControlBindingClass *klass;
+ gboolean ret = FALSE;
+
+ g_return_val_if_fail (GST_IS_CONTROL_BINDING (self), FALSE);
+
+ if (self->disabled)
+ return TRUE;
+
+ klass = GST_CONTROL_BINDING_GET_CLASS (self);
+
+ if (G_LIKELY (klass->sync_values != NULL)) {
+ ret = klass->sync_values (self, object, timestamp, last_sync);
+ } else {
+ GST_WARNING_OBJECT (self, "missing sync_values implementation");
+ }
+ return ret;
+}
+
+/**
+ * gst_control_binding_get_value:
+ * @self: the control binding
+ * @timestamp: the time the control-change should be read from
+ *
+ * Gets the value for the given controlled property at the requested time.
+ *
+ * Returns: the GValue of the property at the given time, or %NULL if the
+ * property isn't controlled.
+ */
+GValue *
+gst_control_binding_get_value (GstControlBinding * self, GstClockTime timestamp)
+{
+ GstControlBindingClass *klass;
+ GValue *ret = NULL;
+
+ g_return_val_if_fail (GST_IS_CONTROL_BINDING (self), NULL);
+ g_return_val_if_fail (GST_CLOCK_TIME_IS_VALID (timestamp), NULL);
+
+ klass = GST_CONTROL_BINDING_GET_CLASS (self);
+
+ if (G_LIKELY (klass->get_value != NULL)) {
+ ret = klass->get_value (self, timestamp);
+ } else {
+ GST_WARNING_OBJECT (self, "missing get_value implementation");
+ }
+ return ret;
+}
+
+/**
+ * gst_control_binding_get_value_array:
+ * @self: the control binding
+ * @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 values for the given controllered 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.
+ *
+ * Returns: %TRUE if the given array could be filled, %FALSE otherwise
+ */
+gboolean
+gst_control_binding_get_value_array (GstControlBinding * self,
+ GstClockTime timestamp, GstClockTime interval, guint n_values,
+ GValue * values)
+{
+ GstControlBindingClass *klass;
+ gboolean ret = FALSE;
+
+ g_return_val_if_fail (GST_IS_CONTROL_BINDING (self), 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);
+
+ klass = GST_CONTROL_BINDING_GET_CLASS (self);
+
+ if (G_LIKELY (klass->get_value_array != NULL)) {
+ ret = klass->get_value_array (self, timestamp, interval, n_values, values);
+ } else {
+ GST_WARNING_OBJECT (self, "missing get_value_array implementation");
+ }
+ return ret;
+}
+
+/**
+ * gst_control_binding_set_disabled:
+ * @self: the control binding
+ * @disabled: boolean that specifies whether to disable the controller
+ * or not.
+ *
+ * This function is used to disable a control binding for some time, i.e.
+ * gst_object_sync_values() will do nothing.
+ */
+void
+gst_control_binding_set_disabled (GstControlBinding * self, gboolean disabled)
+{
+ g_return_if_fail (GST_IS_CONTROL_BINDING (self));
+ self->disabled = disabled;
+}
+
+/**
+ * gst_control_binding_is_disabled:
+ * @self: the control binding
+ *
+ * Check if the control binding is disabled.
+ *
+ * Returns: %TRUE if the binding is inactive
+ */
+gboolean
+gst_control_binding_is_disabled (GstControlBinding * self)
+{
+ g_return_val_if_fail (GST_IS_CONTROL_BINDING (self), TRUE);
+ return (self->disabled == TRUE);
+}