Add GST_PARAM_CONTROLLABLE and GST_PARAM_USER_SHIFT. Move paramspec docs to own section.
Original commit message from CVS:
* docs/gst/gstreamer-docs.sgml:
* docs/gst/gstreamer-sections.txt:
* gst/gstparamspecs.c:
* gst/gstparamspecs.h:
Add GST_PARAM_CONTROLLABLE and GST_PARAM_USER_SHIFT. Move paramspec
docs to own section.
* gst/gstvalue.c:
This now only documents GValue.
* docs/libs/gstreamer-libs-sections.txt:
* libs/gst/controller/gstcontroller.h:
Remove GST_PARAM_CONTROLLABLE.
diff --git a/ChangeLog b/ChangeLog
index e0a7e06..f32461d 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,21 @@
2008-04-15 Stefan Kost <ensonic@users.sf.net>
+ * docs/gst/gstreamer-docs.sgml:
+ * docs/gst/gstreamer-sections.txt:
+ * gst/gstparamspecs.c:
+ * gst/gstparamspecs.h:
+ Add GST_PARAM_CONTROLLABLE and GST_PARAM_USER_SHIFT. Move paramspec
+ docs to own section.
+
+ * gst/gstvalue.c:
+ This now only documents GValue.
+
+ * docs/libs/gstreamer-libs-sections.txt:
+ * libs/gst/controller/gstcontroller.h:
+ Remove GST_PARAM_CONTROLLABLE.
+
+2008-04-15 Stefan Kost <ensonic@users.sf.net>
+
* docs/README:
Correct file path. Tell about how to use -overrides.txt.
* docs/design/draft-tagreading.txt:
diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml
index c580f6c..886ff0d 100644
--- a/docs/gst/gstreamer-docs.sgml
+++ b/docs/gst/gstreamer-docs.sgml
@@ -31,6 +31,7 @@
<!ENTITY GstObject SYSTEM "xml/gstobject.xml">
<!ENTITY GstPad SYSTEM "xml/gstpad.xml">
<!ENTITY GstPadTemplate SYSTEM "xml/gstpadtemplate.xml">
+<!ENTITY GstParamSpec SYSTEM "xml/gstparamspec.xml">
<!ENTITY GstParse SYSTEM "xml/gstparse.xml">
<!ENTITY GstPipeline SYSTEM "xml/gstpipeline.xml">
<!ENTITY GstPlugin SYSTEM "xml/gstplugin.xml">
@@ -135,6 +136,7 @@
&GstObject;
&GstPad;
&GstPadTemplate;
+ &GstParamSpec;
&GstParse;
&GstPipeline;
&GstPlugin;
diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt
index 3998f80..1952cb3 100644
--- a/docs/gst/gstreamer-sections.txt
+++ b/docs/gst/gstreamer-sections.txt
@@ -1479,6 +1479,26 @@
<SECTION>
+<FILE>gstparamspec</FILE>
+<TITLE>GstParamSpec</TITLE>
+
+GST_PARAM_CONTROLLABLE
+GST_PARAM_USER_SHIFT
+
+<SUBSECTION paramspecfraction>
+GstParamSpecFraction
+gst_param_spec_fraction
+
+<SUBSECTION Standard>
+GST_IS_PARAM_SPEC_FRACTION
+GST_PARAM_SPEC_FRACTION
+GST_TYPE_PARAM_FRACTION
+gst_param_spec_fraction_get_type
+
+</SECTION>
+
+
+<SECTION>
<FILE>gstparse</FILE>
<TITLE>GstParse</TITLE>
gst_parse_error_quark
@@ -2276,10 +2296,6 @@
gst_value_fraction_multiply
gst_value_fraction_subtract
-<SUBSECTION paramspecfraction>
-GstParamSpecFraction
-gst_param_spec_fraction
-
<SUBSECTION fractionrange>
GST_VALUE_HOLDS_FRACTION_RANGE
GST_TYPE_FRACTION_RANGE
@@ -2347,11 +2363,6 @@
gst_value_array_get_value
gst_value_array_prepend_value
-<SUBSECTION Standard>
-GST_IS_PARAM_SPEC_FRACTION
-GST_PARAM_SPEC_FRACTION
-GST_TYPE_PARAM_FRACTION
-gst_param_spec_fraction_get_type
<SUBSECTION Private>
gst_date_get_type
diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt
index f395bae..9f2c4ad 100644
--- a/docs/libs/gstreamer-libs-sections.txt
+++ b/docs/libs/gstreamer-libs-sections.txt
@@ -81,7 +81,6 @@
gst_controller_unset_all
gst_controller_get_all
gst_controller_set_interpolation_mode
-GST_PARAM_CONTROLLABLE
<SUBSECTION Standard>
GstControllerClass
GstControllerPrivate
diff --git a/gst/gstparamspecs.c b/gst/gstparamspecs.c
index fa75e4e..e75a944 100644
--- a/gst/gstparamspecs.c
+++ b/gst/gstparamspecs.c
@@ -16,6 +16,15 @@
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
+/**
+ * SECTION:gstparamspec
+ * @short_description: GParamSpec implementations specific
+ * to GStreamer
+ *
+ * GParamSpec implementations specific to GStreamer.
+ *
+ * Last reviewed on 2008-03-11 (0.10.18)
+ */
#ifdef HAVE_CONFIG_H
#include "config.h"
diff --git a/gst/gstparamspecs.h b/gst/gstparamspecs.h
index d021d40..079ff4d 100644
--- a/gst/gstparamspecs.h
+++ b/gst/gstparamspecs.h
@@ -24,6 +24,24 @@
G_BEGIN_DECLS
+/* --- paramspec flags */
+
+/**
+ * GST_PARAM_CONTROLLABLE:
+ *
+ * Use this flag on GObject properties to signal they can make sense to be.
+ * controlled over time. This hint is used by the GstController.
+ */
+#define GST_PARAM_CONTROLLABLE (1 << (G_PARAM_USER_SHIFT + 1))
+
+/**
+ * GST_PARAM_USER_SHIFT:
+ *
+ * Bits based on GST_PARAM_USER_SHIFT can be used by 3rd party applications.
+ */
+#define GST_PARAM_USER_SHIFT (1 << (G_PARAM_USER_SHIFT + 8))
+
+
/* --- type macros --- */
#define GST_TYPE_PARAM_FRACTION (gst_param_spec_fraction_get_type ())
diff --git a/gst/gstvalue.c b/gst/gstvalue.c
index 9da84e5..f69fb65 100644
--- a/gst/gstvalue.c
+++ b/gst/gstvalue.c
@@ -19,15 +19,15 @@
/**
* SECTION:gstvalue
- * @short_description: GValue and GParamSpec implementations specific
+ * @short_description: GValue implementations specific
* to GStreamer
*
- * GValue and GParamSpec implementations specific to GStreamer.
+ * GValue implementations specific to GStreamer.
*
* Note that operations on the same GstValue (or GValue) from multiple
* threads may lead to undefined behaviour.
*
- * Last reviewed on 2006-03-07 (0.10.4)
+ * Last reviewed on 2008-03-11 (0.10.18)
*/
#ifdef HAVE_CONFIG_H
diff --git a/libs/gst/controller/gstcontroller.h b/libs/gst/controller/gstcontroller.h
index b729de6..9389490 100644
--- a/libs/gst/controller/gstcontroller.h
+++ b/libs/gst/controller/gstcontroller.h
@@ -35,15 +35,6 @@
G_BEGIN_DECLS
-/**
- * GST_PARAM_CONTROLLABLE:
- *
- * Use this flag on GstElement properties you wish to be (eventually) handled
- * by a GstController.
- * TODO: needs to go to gstelemnt.h (to avoid clashes on G_PARAM_USER_SHIFT)
- */
-#define GST_PARAM_CONTROLLABLE (1 << (G_PARAM_USER_SHIFT + 1))
-
/* type macros */
#define GST_TYPE_CONTROLLER (gst_controller_get_type ())
