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 void
  57 gst_control_source_class_init (GstControlSourceClass * klass)
  58 {
  59   //GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  60
  61   /* Has to be implemented by children */
  62   klass->bind = NULL;
  63
  64   GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "gstcontrolsource", 0,
  65       "dynamic parameter control sources");
  66 }
  67
  68 static void
  69 gst_control_source_init (GstControlSource * self)
  70 {
  71   /* Set default handlers that print a warning */
  72   self->get_value = NULL;
  73   self->get_value_array = NULL;
  74   self->bound = FALSE;
  75 }
  76
  77 /**
  78  * gst_control_source_get_value:
  79  * @self: the #GstControlSource object
  80  * @timestamp: the time for which the value should be returned
  81  * @value: the value
  82  *
  83  * Gets the value for this #GstControlSource at a given timestamp.
  84  *
  85  * Returns: FALSE if the value couldn't be returned, TRUE otherwise.
  86  */
  87 gboolean
  88 gst_control_source_get_value (GstControlSource * self, GstClockTime timestamp,
  89     GValue * value)
  90 {
  91   g_return_val_if_fail (GST_IS_CONTROL_SOURCE (self), FALSE);
  92
  93   if (G_LIKELY (self->get_value)) {
  94     return self->get_value (self, timestamp, value);
  95   } else {
  96     GST_ERROR ("Not bound to a specific property yet!");
  97     return FALSE;
  98   }
  99 }
 100
 101 /**
 102  * gst_control_source_get_value_array:
 103  * @self: the #GstControlSource object
 104  * @timestamp: the time that should be processed
 105  * @value_array: array to put control-values in
 106  *
 107  * Gets an array of values for one element property.
 108  *
 109  * All fields of @value_array must be filled correctly. Especially the
 110  * @value_array->values array must be big enough to keep the requested amount
 111  * of values.
 112  *
 113  * The type of the values in the array is the same as the property's type.
 114  *
 115  * Returns: %TRUE if the given array could be filled, %FALSE otherwise
 116  */
 117 gboolean
 118 gst_control_source_get_value_array (GstControlSource * self,
 119     GstClockTime timestamp, GstClockTime interval, guint n_values,
 120     gpointer values)
 121 {
 122   g_return_val_if_fail (GST_IS_CONTROL_SOURCE (self), FALSE);
 123
 124   if (G_LIKELY (self->get_value_array)) {
 125     return self->get_value_array (self, timestamp, interval, n_values, values);
 126   } else {
 127     GST_ERROR ("Not bound to a specific property yet!");
 128     return FALSE;
 129   }
 130 }
 131
 132 /**
 133  * gst_control_source_bind:
 134  * @self: the #GstControlSource object
 135  * @pspec: #GParamSpec for the property for which this #GstControlSource should generate values.
 136  *
 137  * Binds a #GstControlSource to a specific property. This must be called only once for a
 138  * #GstControlSource.
 139  *
 140  * Returns: %TRUE if the #GstControlSource was bound correctly, %FALSE otherwise.
 141  */
 142 gboolean
 143 gst_control_source_bind (GstControlSource * self, GParamSpec * pspec)
 144 {
 145   gboolean ret = FALSE;
 146
 147   g_return_val_if_fail (GST_IS_CONTROL_SOURCE (self), FALSE);
 148   g_return_val_if_fail (GST_CONTROL_SOURCE_GET_CLASS (self)->bind, FALSE);
 149   g_return_val_if_fail (!self->bound, FALSE);
 150
 151   ret = GST_CONTROL_SOURCE_GET_CLASS (self)->bind (self, pspec);
 152
 153   if (ret)
 154     self->bound = TRUE;
 155
 156   return ret;
 157 }