gst/gstcontrolsource.c

   1 /* GStreamer
   2  *
   3  * Copyright (C) 2007 Sebastian Dröge <slomo@circular-chaos.org>
   4  *
   5  * gstcontrolsource.c: Interface declaration for control sources
   6  *
   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.
  11  *
  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.
  16  *
  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., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 /**
  24  * SECTION:gstcontrolsource
  25  * @short_description: base class for control source sources
  26  *
  27  * The #GstControlSource is a base class for control value sources that could
  28  * be used by #GstController to get timestamp-value pairs.
  29  *
  30  * A #GstControlSource is used by first getting an instance, binding it to a
  31  * #GParamSpec (for example by using gst_controller_set_control_source()) and
  32  * then by having it used by the #GstController or calling
  33  * gst_control_source_get_value() or gst_control_source_get_value_array().
  34  *
  35  * For implementing a new #GstControlSource one has to implement a
  36  * #GstControlSourceBind method, which will depending on the #GParamSpec set up
  37  * the control source for use and sets the #GstControlSourceGetValue and
  38  * #GstControlSourceGetValueArray functions. These are then used by
  39  * gst_control_source_get_value() or gst_control_source_get_value_array()
  40  * to get values for specific timestamps.
  41  *
  42  */
  43
  44 #include "gst_private.h"
  45
  46 #include <glib-object.h>
  47 #include <gst/gst.h>
  48
  49 #include "gstcontrolsource.h"
  50
  51 #define GST_CAT_DEFAULT control_source_debug
  52 GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
  53
  54 G_DEFINE_ABSTRACT_TYPE (GstControlSource, gst_control_source, G_TYPE_OBJECT);
  55
  56 static GObjectClass *parent_class = NULL;
  57
  58 static void
  59 gst_control_source_class_init (GstControlSourceClass * klass)
  60 {
  61   //GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  62
  63   parent_class = g_type_class_peek_parent (klass);
  64
  65   /* Has to be implemented by children */
  66   klass->bind = NULL;
  67
  68   GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "gstcontrolsource", 0,
  69       "dynamic parameter control sources");
  70 }
  71
  72 static void
  73 gst_control_source_init (GstControlSource * self)
  74 {
  75   /* Set default handlers that print a warning */
  76   self->get_value = NULL;
  77   self->get_value_array = NULL;
  78   self->bound = FALSE;
  79 }
  80
  81 /**
  82  * gst_control_source_get_value:
  83  * @self: the #GstControlSource object
  84  * @timestamp: the time for which the value should be returned
  85  * @value: the value
  86  *
  87  * Gets the value for this #GstControlSource at a given timestamp.
  88  *
  89  * Returns: FALSE if the value couldn't be returned, TRUE otherwise.
  90  */
  91 gboolean
  92 gst_control_source_get_value (GstControlSource * self, GstClockTime timestamp,
  93     GValue * value)
  94 {
  95   g_return_val_if_fail (GST_IS_CONTROL_SOURCE (self), FALSE);
  96
  97   if (G_LIKELY (self->get_value)) {
  98     return self->get_value (self, timestamp, value);
  99   } else {
 100     GST_ERROR ("Not bound to a specific property yet!");
 101     return FALSE;
 102   }
 103 }
 104
 105 /**
 106  * gst_control_source_get_value_array:
 107  * @self: the #GstControlSource object
 108  * @timestamp: the time that should be processed
 109  * @value_array: array to put control-values in
 110  *
 111  * Gets an array of values for one element property.
 112  *
 113  * All fields of @value_array must be filled correctly. Especially the
 114  * @value_array->values array must be big enough to keep the requested amount
 115  * of values.
 116  *
 117  * The type of the values in the array is the same as the property's type.
 118  *
 119  * Returns: %TRUE if the given array could be filled, %FALSE otherwise
 120  */
 121 gboolean
 122 gst_control_source_get_value_array (GstControlSource * self,
 123     GstClockTime timestamp, GstValueArray * value_array)
 124 {
 125   g_return_val_if_fail (GST_IS_CONTROL_SOURCE (self), FALSE);
 126
 127   if (G_LIKELY (self->get_value_array)) {
 128     return self->get_value_array (self, timestamp, value_array);
 129   } else {
 130     GST_ERROR ("Not bound to a specific property yet!");
 131     return FALSE;
 132   }
 133 }
 134
 135 /**
 136  * gst_control_source_bind:
 137  * @self: the #GstControlSource object
 138  * @pspec: #GParamSpec for the property for which this #GstControlSource should generate values.
 139  *
 140  * Binds a #GstControlSource to a specific property. This must be called only once for a
 141  * #GstControlSource.
 142  *
 143  * Returns: %TRUE if the #GstControlSource was bound correctly, %FALSE otherwise.
 144  */
 145 gboolean
 146 gst_control_source_bind (GstControlSource * self, GParamSpec * pspec)
 147 {
 148   gboolean ret = FALSE;
 149
 150   g_return_val_if_fail (GST_IS_CONTROL_SOURCE (self), FALSE);
 151   g_return_val_if_fail (GST_CONTROL_SOURCE_GET_CLASS (self)->bind, FALSE);
 152   g_return_val_if_fail (!self->bound, FALSE);
 153
 154   ret = GST_CONTROL_SOURCE_GET_CLASS (self)->bind (self, pspec);
 155
 156   if (ret)
 157     self->bound = TRUE;
 158
 159   return ret;
 160 }