3 * Copyright (C) 2007 Sebastian Dröge <slomo@circular-chaos.org>
5 * gstcontrolsource.c: Interface declaration for control sources
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, USA.
24 * SECTION:gstcontrolsource
25 * @title: GstControlSource
26 * @short_description: base class for control source sources
28 * The #GstControlSource is a base class for control value sources that could
29 * be used to get timestamp-value pairs. A control source essentially is a
32 * A #GstControlSource is used by first getting an instance of a specific
33 * control-source, creating a binding for the control-source to the target property
34 * of the element and then adding the binding to the element. The binding will
35 * convert the data types and value range to fit to the bound property.
37 * For implementing a new #GstControlSource one has to implement
38 * #GstControlSourceGetValue and #GstControlSourceGetValueArray functions.
39 * These are then used by gst_control_source_get_value() and
40 * gst_control_source_get_value_array() to get values for specific timestamps.
43 #include "gst_private.h"
45 #include <glib-object.h>
48 #include "gstcontrolsource.h"
50 #define GST_CAT_DEFAULT control_source_debug
51 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
54 GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "gstcontrolsource", 0, \
55 "dynamic parameter control sources");
57 G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GstControlSource, gst_control_source,
58 GST_TYPE_OBJECT, _do_init);
60 static GObject *gst_control_source_constructor (GType type,
61 guint n_construct_params, GObjectConstructParam * construct_params);
64 gst_control_source_class_init (GstControlSourceClass * klass)
66 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
68 gobject_class->constructor = gst_control_source_constructor;
72 gst_control_source_init (GstControlSource * self)
74 self->get_value = NULL;
75 self->get_value_array = NULL;
79 gst_control_source_constructor (GType type, guint n_construct_params,
80 GObjectConstructParam * construct_params)
85 G_OBJECT_CLASS (gst_control_source_parent_class)->constructor (type,
86 n_construct_params, construct_params);
87 gst_object_ref_sink (self);
93 * gst_control_source_get_value: (method)
94 * @self: the #GstControlSource object
95 * @timestamp: the time for which the value should be returned
96 * @value: (out): the value
98 * Gets the value for this #GstControlSource at a given timestamp.
100 * Returns: %FALSE if the value couldn't be returned, %TRUE otherwise.
103 gst_control_source_get_value (GstControlSource * self, GstClockTime timestamp,
106 g_return_val_if_fail (GST_IS_CONTROL_SOURCE (self), FALSE);
108 if (G_LIKELY (self->get_value)) {
109 return self->get_value (self, timestamp, value);
111 GST_ERROR ("Not bound to a specific property yet!");
117 * gst_control_source_get_value_array: (method)
118 * @self: the #GstControlSource object
119 * @timestamp: the first timestamp
120 * @interval: the time steps
121 * @n_values: the number of values to fetch
122 * @values: (array length=n_values): array to put control-values in
124 * Gets an array of values for for this #GstControlSource. Values that are
125 * undefined contain NANs.
127 * Returns: %TRUE if the given array could be filled, %FALSE otherwise
130 gst_control_source_get_value_array (GstControlSource * self,
131 GstClockTime timestamp, GstClockTime interval, guint n_values,
134 g_return_val_if_fail (GST_IS_CONTROL_SOURCE (self), FALSE);
136 if (G_LIKELY (self->get_value_array)) {
137 return self->get_value_array (self, timestamp, interval, n_values, values);
139 GST_ERROR ("Not bound to a specific property yet!");