gst/gstcontrolsource.h

   1 /* GStreamer
   2  *
   3  * Copyright (C) 2007 Sebastian Dröge <slomo@circular-chaos.org>
   4  *
   5  * gstcontrolsource.h: 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 #ifndef __GST_CONTROL_SOURCE_H__
  24 #define __GST_CONTROL_SOURCE_H__
  25
  26 #include <gst/gstconfig.h>
  27
  28 #include <glib-object.h>
  29
  30 #include <gst/gstclock.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define GST_TYPE_CONTROL_SOURCE \
  35   (gst_control_source_get_type())
  36 #define GST_CONTROL_SOURCE(obj) \
  37   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_CONTROL_SOURCE,GstControlSource))
  38 #define GST_CONTROL_SOURCE_CLASS(klass) \
  39   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_CONTROL_SOURCE,GstControlSourceClass))
  40 #define GST_IS_CONTROL_SOURCE(obj) \
  41   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_CONTROL_SOURCE))
  42 #define GST_IS_CONTROL_SOURCE_CLASS(klass) \
  43   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_CONTROL_SOURCE))
  44 #define GST_CONTROL_SOURCE_GET_CLASS(obj) \
  45   (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_CONTOL_SOURCE, GstControlSourceClass))
  46
  47 typedef struct _GstControlSource GstControlSource;
  48 typedef struct _GstControlSourceClass GstControlSourceClass;
  49 typedef struct _GstTimedValue GstTimedValue;
  50 typedef struct _GstValueArray GstValueArray;
  51
  52 /**
  53  * GstTimedValue:
  54  * @timestamp: timestamp of the value change
  55  * @value: the corresponding value
  56  *
  57  * Structure for saving a timestamp and a value.
  58  */
  59 struct _GstTimedValue
  60 {
  61   GstClockTime timestamp;
  62   GValue       value;
  63 };
  64
  65 /**
  66  * GstValueArray:
  67  * @property_name: the name of the property this array belongs to
  68  * @nbsamples: number of samples requested
  69  * @sample_interval: interval between each sample
  70  * @values: pointer to the array
  71  *
  72  * Structure to receive multiple values at once.
  73  */
  74 struct _GstValueArray
  75 {
  76   const gchar *property_name;
  77   gint         nbsamples;
  78   GstClockTime sample_interval;
  79   gpointer *values;
  80 };
  81
  82 /**
  83  * GstControlSourceGetValue
  84  * @self: the #GstControlSource instance
  85  * @timestamp: timestamp for which a value should be calculated
  86  * @value: a #GValue which will be set to the result. It must be initialized to the correct type.
  87  *
  88  * Function for returning a value for a given timestamp.
  89  *
  90  * Returns: %TRUE if the value was successfully calculated.
  91  *
  92  */
  93 typedef gboolean (* GstControlSourceGetValue) (GstControlSource *self, GstClockTime timestamp, GValue *value);
  94
  95 /**
  96  * GstControlSourceGetValueArray
  97  * @self: the #GstControlSource instance
  98  * @timestamp: timestamp for which a value should be calculated
  99  * @value_array: array to put control-values in
 100  *
 101  * Function for returning a #GstValueArray for a given timestamp.
 102  *
 103  * Returns: %TRUE if the values were successfully calculated.
 104  *
 105  */
 106 typedef gboolean (* GstControlSourceGetValueArray) (GstControlSource *self, GstClockTime timestamp, GstValueArray *value_array);
 107
 108 /**
 109  * GstControlSourceBind
 110  * @self: the #GstControlSource instance
 111  * @pspec: #GParamSpec that should be bound to
 112  *
 113  * Function for binding a #GstControlSource to a #GParamSpec.
 114  *
 115  * Returns: %TRUE if the property could be bound to the #GstControlSource, %FALSE otherwise.
 116  */
 117 typedef gboolean (* GstControlSourceBind) (GstControlSource *self, GParamSpec *pspec);
 118
 119 /**
 120  * GstControlSource:
 121  * @get_value: Function for returning a value for a given timestamp
 122  * @get_value_array: Function for returning a #GstValueArray for a given timestamp
 123  *
 124  * The instance structure of #GstControlSource.
 125  */
 126 struct _GstControlSource {
 127   GObject parent;
 128
 129   /*< public >*/
 130   GstControlSourceGetValue get_value;             /* Returns the value for a property at a given timestamp */
 131   GstControlSourceGetValueArray get_value_array;  /* Returns values for a property in a given timespan */
 132
 133   /*< private >*/
 134   gboolean bound;
 135   gpointer _gst_reserved[GST_PADDING];
 136 };
 137
 138 /**
 139  * GstControlSourceClass:
 140  * @parent_class: Parent class
 141  * @bind: Class method for binding the #GstControlSource to a specific GParamSpec
 142  *
 143  * The class structure of #GstControlSource.
 144  */
 145
 146 struct _GstControlSourceClass
 147 {
 148   GObjectClass parent_class;
 149
 150   GstControlSourceBind bind;  /* Binds the GstControlSource to a specific GParamSpec */
 151
 152   /*< private >*/
 153   gpointer _gst_reserved[GST_PADDING];
 154 };
 155
 156 GType gst_control_source_get_type (void);
 157
 158 /* Functions */
 159 gboolean       gst_control_source_get_value             (GstControlSource *self, GstClockTime timestamp,
 160                                                          GValue *value);
 161 gboolean       gst_control_source_get_value_array       (GstControlSource *self, GstClockTime timestamp,
 162                                                          GstValueArray *value_array);
 163
 164 gboolean       gst_control_source_bind                  (GstControlSource *self, GParamSpec *pspec);
 165
 166 G_END_DECLS
 167
 168 #endif /* __GST_CONTROL_SOURCE_H__ */