From 4a638e29d9cdc561d896509152d3a6eb7ccd0d95 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Tue, 15 Apr 2008 06:16:33 +0000 Subject: [PATCH] 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. --- ChangeLog | 16 +++++++++++++++ docs/gst/gstreamer-docs.sgml | 2 ++ docs/gst/gstreamer-sections.txt | 29 ++++++++++++++++++--------- docs/libs/gstreamer-libs-sections.txt | 1 - gst/gstparamspecs.c | 9 +++++++++ gst/gstparamspecs.h | 18 +++++++++++++++++ gst/gstvalue.c | 6 +++--- libs/gst/controller/gstcontroller.h | 9 --------- 8 files changed, 68 insertions(+), 22 deletions(-) diff --git a/ChangeLog b/ChangeLog index e0a7e06c68..f32461d3fd 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,19 @@ +2008-04-15 Stefan Kost + + * 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 * docs/README: diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml index c580f6c6f1..886ff0d107 100644 --- a/docs/gst/gstreamer-docs.sgml +++ b/docs/gst/gstreamer-docs.sgml @@ -31,6 +31,7 @@ + @@ -135,6 +136,7 @@ Windows. It is released under the GNU Library General Public License &GstObject; &GstPad; &GstPadTemplate; + &GstParamSpec; &GstParse; &GstPipeline; &GstPlugin; diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 3998f80b2f..1952cb3fff 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -1478,6 +1478,26 @@ gst_static_caps_get_type +
+gstparamspec +GstParamSpec + +GST_PARAM_CONTROLLABLE +GST_PARAM_USER_SHIFT + + +GstParamSpecFraction +gst_param_spec_fraction + + +GST_IS_PARAM_SPEC_FRACTION +GST_PARAM_SPEC_FRACTION +GST_TYPE_PARAM_FRACTION +gst_param_spec_fraction_get_type + +
+ +
gstparse GstParse @@ -2276,10 +2296,6 @@ gst_value_get_fraction_denominator gst_value_fraction_multiply gst_value_fraction_subtract - -GstParamSpecFraction -gst_param_spec_fraction - GST_VALUE_HOLDS_FRACTION_RANGE GST_TYPE_FRACTION_RANGE @@ -2347,11 +2363,6 @@ gst_value_array_get_size gst_value_array_get_value gst_value_array_prepend_value - -GST_IS_PARAM_SPEC_FRACTION -GST_PARAM_SPEC_FRACTION -GST_TYPE_PARAM_FRACTION -gst_param_spec_fraction_get_type gst_date_get_type diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt index f395baed38..9f2c4ada2e 100644 --- a/docs/libs/gstreamer-libs-sections.txt +++ b/docs/libs/gstreamer-libs-sections.txt @@ -81,7 +81,6 @@ gst_controller_unset gst_controller_unset_all gst_controller_get_all gst_controller_set_interpolation_mode -GST_PARAM_CONTROLLABLE GstControllerClass GstControllerPrivate diff --git a/gst/gstparamspecs.c b/gst/gstparamspecs.c index fa75e4e1e8..e75a944322 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 d021d40d59..079ff4d17a 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 9da84e57ee..f69fb655a6 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 b729de6d39..9389490e11 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 ())