X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=gst%2Fgstcontrolsource.c;h=1817edce96f23ab600dbf910a675afaf68e6b1d8;hb=706e10ad0586bf98c829cdfaa079118447b94ef5;hp=b75c2eea381aff79594f3dcd898cd3694635d42b;hpb=393c758a1c2ddf738e4fdc31123cbd5a41fb0b43;p=platform%2Fupstream%2Fgstreamer.git

diff --git a/gst/gstcontrolsource.c b/gst/gstcontrolsource.c
index b75c2ee..1817edc 100644
--- a/gst/gstcontrolsource.c
+++ b/gst/gstcontrolsource.c
@@ -16,29 +16,28 @@
  *
  * You should have received a copy of the GNU Library General Public
  * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
  */
 
 /**
  * SECTION:gstcontrolsource
+ * @title: GstControlSource
  * @short_description: base class for control source sources
  *
  * The #GstControlSource is a base class for control value sources that could
- * be used by #GstController to get timestamp-value pairs.
+ * be used to get timestamp-value pairs. A control source essentially is a
+ * function over time.
  *
- * A #GstControlSource is used by first getting an instance, binding it to a
- * #GParamSpec (for example by using gst_controller_set_control_source()) and
- * then by having it used by the #GstController or calling
- * gst_control_source_get_value() or gst_control_source_get_value_array().
- *
- * For implementing a new #GstControlSource one has to implement a
- * #GstControlSourceBind method, which will depending on the #GParamSpec set up
- * the control source for use and sets the #GstControlSourceGetValue and
- * #GstControlSourceGetValueArray functions. These are then used by
- * gst_control_source_get_value() or gst_control_source_get_value_array()
- * to get values for specific timestamps.
+ * A #GstControlSource is used by first getting an instance of a specific
+ * control-source, creating a binding for the control-source to the target property
+ * of the element and then adding the binding to the element. The binding will
+ * convert the data types and value range to fit to the bound property.
  *
+ * For implementing a new #GstControlSource one has to implement
+ * #GstControlSourceGetValue and #GstControlSourceGetValueArray functions.
+ * These are then used by gst_control_source_get_value() and
+ * gst_control_source_get_value_array() to get values for specific timestamps.
  */
 
 #include "gst_private.h"
@@ -58,15 +57,9 @@ GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
 G_DEFINE_ABSTRACT_TYPE_WITH_CODE (GstControlSource, gst_control_source,
     GST_TYPE_OBJECT, _do_init);
 
-static GObject *gst_control_source_constructor (GType type,
-    guint n_construct_params, GObjectConstructParam * construct_params);
-
 static void
 gst_control_source_class_init (GstControlSourceClass * klass)
 {
-  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
-
-  gobject_class->constructor = gst_control_source_constructor;
 }
 
 static void
@@ -76,29 +69,15 @@ gst_control_source_init (GstControlSource * self)
   self->get_value_array = NULL;
 }
 
-static GObject *
-gst_control_source_constructor (GType type, guint n_construct_params,
-    GObjectConstructParam * construct_params)
-{
-  GObject *self;
-
-  self =
-      G_OBJECT_CLASS (gst_control_source_parent_class)->constructor (type,
-      n_construct_params, construct_params);
-  gst_object_ref_sink (self);
-
-  return self;
-}
-
 /**
- * gst_control_source_get_value:
+ * gst_control_source_get_value: (method)
  * @self: the #GstControlSource object
  * @timestamp: the time for which the value should be returned
- * @value: the value
+ * @value: (out): the value
  *
  * Gets the value for this #GstControlSource at a given timestamp.
  *
- * Returns: FALSE if the value couldn't be returned, TRUE otherwise.
+ * Returns: %FALSE if the value couldn't be returned, %TRUE otherwise.
  */
 gboolean
 gst_control_source_get_value (GstControlSource * self, GstClockTime timestamp,
@@ -115,14 +94,15 @@ gst_control_source_get_value (GstControlSource * self, GstClockTime timestamp,
 }
 
 /**
- * gst_control_source_get_value_array:
+ * gst_control_source_get_value_array: (method)
  * @self: the #GstControlSource object
  * @timestamp: the first timestamp
  * @interval: the time steps
  * @n_values: the number of values to fetch
- * @value_array: array to put control-values in
+ * @values: (array length=n_values): array to put control-values in
  *
- * Gets an array of values for for this #GstControlSource.
+ * Gets an array of values for for this #GstControlSource. Values that are
+ * undefined contain NANs.
  *
  * Returns: %TRUE if the given array could be filled, %FALSE otherwise
  */