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 #define _do_init \
  55   GST_DEBUG_CATEGORY_INIT (GST_CAT_DEFAULT, "gstcontrolsource", 0, \
  56       "dynamic parameter control sources");
  57
  58 G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GstControlSource, gst_control_source,
  59     GST_TYPE_OBJECT, _do_init);
  60
  61 static void
  62 gst_control_source_class_init (GstControlSourceClass * klass)
  63 {
  64 }
  65
  66 static void
  67 gst_control_source_init (GstControlSource * self)
  68 {
  69   self->get_value = NULL;
  70   self->get_value_array = NULL;
  71 }
  72
  73 /**
  74  * gst_control_source_get_value:
  75  * @self: the #GstControlSource object
  76  * @timestamp: the time for which the value should be returned
  77  * @value: the value
  78  *
  79  * Gets the value for this #GstControlSource at a given timestamp.
  80  *
  81  * Returns: FALSE if the value couldn't be returned, TRUE otherwise.
  82  */
  83 gboolean
  84 gst_control_source_get_value (GstControlSource * self, GstClockTime timestamp,
  85     gdouble * value)
  86 {
  87   g_return_val_if_fail (GST_IS_CONTROL_SOURCE (self), FALSE);
  88
  89   if (G_LIKELY (self->get_value)) {
  90     return self->get_value (self, timestamp, value);
  91   } else {
  92     GST_ERROR ("Not bound to a specific property yet!");
  93     return FALSE;
  94   }
  95 }
  96
  97 /**
  98  * gst_control_source_get_value_array:
  99  * @self: the #GstControlSource object
 100  * @timestamp: the first timestamp
 101  * @interval: the time steps
 102  * @n_values: the number of values to fetch
 103  * @value_array: array to put control-values in
 104  *
 105  * Gets an array of values for for this #GstControlSource.
 106  *
 107  * Returns: %TRUE if the given array could be filled, %FALSE otherwise
 108  */
 109 gboolean
 110 gst_control_source_get_value_array (GstControlSource * self,
 111     GstClockTime timestamp, GstClockTime interval, guint n_values,
 112     gdouble * values)
 113 {
 114   g_return_val_if_fail (GST_IS_CONTROL_SOURCE (self), FALSE);
 115
 116   if (G_LIKELY (self->get_value_array)) {
 117     return self->get_value_array (self, timestamp, interval, n_values, values);
 118   } else {
 119     GST_ERROR ("Not bound to a specific property yet!");
 120     return FALSE;
 121   }
 122 }