From d0b8df667772ac397cc79ab6abcb39fd6ebcd619 Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Wed, 26 Jan 2005 15:15:26 +0000 Subject: [PATCH] restructured DParam docs added some thoughts about dparams ng Original commit message from CVS: restructured DParam docs added some thoughts about dparams ng --- ChangeLog | 23 +++ docs/gst/gstreamer-sections.txt | 2 + docs/libs/gstreamer-libs-docs.sgml | 36 +++-- docs/libs/gstreamer-libs-sections.txt | 72 ++++++++- docs/libs/tmpl/gstcontrol.sgml | 273 ---------------------------------- docs/libs/tmpl/gstdparam.sgml | 88 +++++++++++ docs/libs/tmpl/gstdplinint.sgml | 31 ++++ docs/libs/tmpl/gstdpman.sgml | 214 ++++++++++++++++++++++++++ docs/libs/tmpl/gstdpsmooth.sgml | 51 +++++++ docs/libs/tmpl/gstputbits.sgml | 16 ++ docs/libs/tmpl/gstunitconvert.sgml | 112 ++++++++++++++ docs/random/ensonic/dparams.txt | 3 + libs/gst/control/dparam.c | 2 +- libs/gst/control/dparam.h | 1 - libs/gst/control/dparammanager.c | 3 +- 15 files changed, 638 insertions(+), 289 deletions(-) create mode 100644 docs/libs/tmpl/gstdparam.sgml create mode 100644 docs/libs/tmpl/gstdplinint.sgml create mode 100644 docs/libs/tmpl/gstdpman.sgml create mode 100644 docs/libs/tmpl/gstdpsmooth.sgml create mode 100644 docs/libs/tmpl/gstputbits.sgml create mode 100644 docs/libs/tmpl/gstunitconvert.sgml diff --git a/ChangeLog b/ChangeLog index 734de3d..9fb8bd5 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,26 @@ +2005-01-26 Stefan Kost + + * docs/gst/gstreamer-sections.txt: + * docs/libs/gstreamer-libs-docs.sgml: + * docs/libs/gstreamer-libs-sections.txt: + * docs/libs/tmpl/gstcontrol.sgml: + * docs/libs/tmpl/gstdparam.sgml: + * docs/libs/tmpl/gstdplinint.sgml: + * docs/libs/tmpl/gstdpman.sgml: + * docs/libs/tmpl/gstdpsmooth.sgml: + * docs/libs/tmpl/gstputbits.sgml: + * docs/libs/tmpl/gstunitconvert.sgml: + * libs/gst/control/dparam.c: + * libs/gst/control/dparam.h: + * libs/gst/control/dparammanager.c: + (gst_dpman_add_required_dparam_callback), + (gst_dpman_add_required_dparam_direct), + (gst_dpman_add_required_dparam_array), + (gst_dpman_remove_required_dparam), (gst_dpman_attach_dparam), + (gst_dpman_get_dparam), (gst_dpman_get_dparam_type), + (gst_dpman_get_manager) + restructured DParam docs + 2005-01-25 Tim-Philipp Müller * gst-element-check.m4: diff --git a/docs/gst/gstreamer-sections.txt b/docs/gst/gstreamer-sections.txt index 6231a7a..7a48a91 100644 --- a/docs/gst/gstreamer-sections.txt +++ b/docs/gst/gstreamer-sections.txt @@ -8,6 +8,8 @@ # # +gst/gst.h +
gst Gst diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml index c841789..6027b5a 100644 --- a/docs/libs/gstreamer-libs-docs.sgml +++ b/docs/libs/gstreamer-libs-docs.sgml @@ -9,6 +9,11 @@ --> + + + + + @@ -21,7 +26,7 @@ GStreamer &GST_MAJORMINOR; Library Reference Manual for GStreamer Library &GST_MAJORMINOR; (&GST_VERSION;) - + GStreamer Libraries @@ -31,20 +36,29 @@ GStreamer provides some standard libraries you can use to create plugins. - &GstBytestream; + &GstBytestream; + &GstDataProtocol; + &GstGetbits; + + + + + gstcontrol &GstControl; - &GstDataProtocol; - &GstGetbits; - + &GstDParamManager; + &GstDParam; + &GstDParamSmooth; + &GstDParamLinInterp; + &GstUnitConvert; + + - - - + Object Hierarchy &gstreamer-libs-tree-index; - + API Index diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt index b98c2b5..88b3f54 100644 --- a/docs/libs/gstreamer-libs-sections.txt +++ b/docs/libs/gstreamer-libs-sections.txt @@ -1,3 +1,14 @@ +# GStreamer Libraries API reference sections + +# please add section in the alpahbetical order to each library +# using the following template +#
+# gstxxx +# GstXxx +# +# +#
+
gstgetbits libs/getbits/gstgetbits.h @@ -122,11 +133,21 @@ gst_dp_validate_packet
+# GstControl library +
gstcontrol +GstControl libs/control/control.h gst_control_init - + + +
+ +
+gstdpman +GstDParamManager +libs/control/control.h GstDParamManager gst_dpman_new gst_dpman_add_required_dparam_callback @@ -145,11 +166,58 @@ gst_dpman_set_mode gst_dpman_set_parent gst_dpman_get_manager gst_dpman_bypass_dparam - + + +
+ +
+gstdparam +GstDParam +libs/control/control.h GstDParam gst_dparam_new gst_dparam_attach gst_dparam_detach gst_dparam_do_update_default + + +
+ +
+gstdpsmooth +GstDParamSmooth +libs/control/control.h +GstDParamSmooth gst_dpsmooth_new + +
+ +
+gstdplinint +GstDParamLinInterp +libs/control/control.h +GstDParamLinInterp +gst_dp_linint_new + + +
+ +
+gstunitconvert +GstUnitConvert +libs/control/control.h +GstUnitConvert +gst_unitconv_new +gst_unitconv_set_convert_units +gst_unitconv_convert_value +gst_unitconv_unit_spec +gst_unitconv_unit_exists +gst_unitconv_unit_is_logarithmic +gst_unitconv_register_unit +gst_unitconv_register_convert_func +gst_unitconv_register_convert_property + + +
+ diff --git a/docs/libs/tmpl/gstcontrol.sgml b/docs/libs/tmpl/gstcontrol.sgml index 5c71bf5..afc9feb 100644 --- a/docs/libs/tmpl/gstcontrol.sgml +++ b/docs/libs/tmpl/gstcontrol.sgml @@ -42,276 +42,3 @@ The next step is to get hold of the GstDParamManager instance of a GstElement. @argv: - - - - - - - - - - - -@gstdparammanager: the object which received the signal. -@arg1: - - - - - - -@name: -@parent: -@Returns: - - - - - - - -@dpman: -@param_spec: -@unit_name: -@update_func: -@update_data: -@Returns: - - - - - - - -@dpman: -@param_spec: -@unit_name: -@update_data: -@Returns: - - - - - - - -@dpman: -@param_spec: -@unit_name: -@update_data: -@Returns: - - - - - - - -@dpman: -@dparam_name: - - - - - - - -@dpman: -@dparam_name: -@dparam: -@Returns: - - - - - - - -@dpman: -@dparam_name: - - - - - - - -@dpman: -@dparam_name: -@Returns: - -@name: - - - - - - - -@dpman: -@dparam_name: -@Returns: - -@name: - - - - - - - -@dpman: -@Returns: - - - - - - - -@dpman: -@dparam_name: -@Returns: - - - - - - - -@dpman: -@rate: - - - - - - - -@klass: -@modename: -@preprocessfunc: -@processfunc: -@setupfunc: -@teardownfunc: - - - - - - - -@dpman: -@modename: -@Returns: - - - - - - - -@dpman: -@parent: - - - - - - - -@parent: -@Returns: - - - - - - - -@dpman: -@dparam_name: - - - - - - - - - - - - - -@gstdparam: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - - - - - - -@type: -@Returns: - - - - - - - -@dparam: -@manager: -@param_spec: -@unit_name: - - - - - - - -@dparam: - - - - - - - -@dparam: -@timestamp: -@value: -@update_info: - - - - - - - -@type: -@Returns: - - diff --git a/docs/libs/tmpl/gstdparam.sgml b/docs/libs/tmpl/gstdparam.sgml new file mode 100644 index 0000000..349dbe5 --- /dev/null +++ b/docs/libs/tmpl/gstdparam.sgml @@ -0,0 +1,88 @@ + +GstDParam + + +dynamic parameter instance + + + + + + + + + + + + + + + + + + + + + + +@gstdparam: the object which received the signal. + + + + + + + + + + + + + + + + + + + + + + + + + + +@type: +@Returns: + + + + + + + +@dparam: +@manager: +@param_spec: +@unit_name: + + + + + + + +@dparam: + + + + + + + +@dparam: +@timestamp: +@value: +@update_info: + + diff --git a/docs/libs/tmpl/gstdplinint.sgml b/docs/libs/tmpl/gstdplinint.sgml new file mode 100644 index 0000000..ca453e1 --- /dev/null +++ b/docs/libs/tmpl/gstdplinint.sgml @@ -0,0 +1,31 @@ + +GstDParamLinInterp + + +linear interpolation dynamic parameter + + + + + + + + + + + + + + + + + + + + + + +@type: +@Returns: + + diff --git a/docs/libs/tmpl/gstdpman.sgml b/docs/libs/tmpl/gstdpman.sgml new file mode 100644 index 0000000..b6a4d43 --- /dev/null +++ b/docs/libs/tmpl/gstdpman.sgml @@ -0,0 +1,214 @@ + +GstDParamManager + + +dynamic parameter manager + + + +The manager bings all functions to work with #GstElements and their #GstDParams. +One can find out which dparams an element has, get the parameter specs and +pick a control change rate. + + +Some functions are meant for dparam implementor (plugin writers), where others +are for applications that use elements with dparams. + + + + + + + + + + + + + + + + + + +@gstdparammanager: the object which received the signal. +@arg1: + + + + + + +@name: +@parent: +@Returns: + + + + + + + +@dpman: +@param_spec: +@unit_name: +@update_func: +@update_data: +@Returns: + + + + + + + +@dpman: +@param_spec: +@unit_name: +@update_data: +@Returns: + + + + + + + +@dpman: +@param_spec: +@unit_name: +@update_data: +@Returns: + + + + + + + +@dpman: +@dparam_name: + + + + + + + +@dpman: +@dparam_name: +@dparam: +@Returns: + + + + + + + +@dpman: +@dparam_name: + + + + + + + +@dpman: +@dparam_name: +@Returns: + +@name: + + + + + + + +@dpman: +@dparam_name: +@Returns: + +@name: + + + + + + + +@dpman: +@Returns: + + + + + + + +@dpman: +@dparam_name: +@Returns: + + + + + + + +@dpman: +@rate: + + + + + + + +@klass: +@modename: +@preprocessfunc: +@processfunc: +@setupfunc: +@teardownfunc: + + + + + + + +@dpman: +@modename: +@Returns: + + + + + + + +@dpman: +@parent: + + + + + + + +@parent: +@Returns: + + + + + + + +@dpman: +@dparam_name: + + diff --git a/docs/libs/tmpl/gstdpsmooth.sgml b/docs/libs/tmpl/gstdpsmooth.sgml new file mode 100644 index 0000000..bfd5e83 --- /dev/null +++ b/docs/libs/tmpl/gstdpsmooth.sgml @@ -0,0 +1,51 @@ + +GstDParamSmooth + + +realtime smoothed dynamic parameter + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@type: +@Returns: + + diff --git a/docs/libs/tmpl/gstputbits.sgml b/docs/libs/tmpl/gstputbits.sgml new file mode 100644 index 0000000..21c6f20 --- /dev/null +++ b/docs/libs/tmpl/gstputbits.sgml @@ -0,0 +1,16 @@ + +gstputbits + + +Accelerated routines for putting bits into a data stream + + + + + + + + + + + diff --git a/docs/libs/tmpl/gstunitconvert.sgml b/docs/libs/tmpl/gstunitconvert.sgml new file mode 100644 index 0000000..e06b2e4 --- /dev/null +++ b/docs/libs/tmpl/gstunitconvert.sgml @@ -0,0 +1,112 @@ + +GstUnitConvert + + +conversion between units of measurement + + + + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@unitconv: +@from_unit_named: +@to_unit_named: +@Returns: + + + + + + + +@unitconv: +@from_value: +@to_value: +@Returns: + + + + + + + +@unit_name: +@Returns: + + + + + + + +@unit_name: +@Returns: + + + + + + + +@unit_name: +@Returns: + + + + + + + +@domain_name: +@is_domain_default: +@is_logarithmic: +@unit_spec: +@Returns: + + + + + + + +@from_unit_named: +@to_unit_named: +@convert_func: +@Returns: + + + + + + + +@unit_name: +@convert_prop_spec: +@Returns: + + diff --git a/docs/random/ensonic/dparams.txt b/docs/random/ensonic/dparams.txt index e7e91a7..30742ad 100644 --- a/docs/random/ensonic/dparams.txt +++ b/docs/random/ensonic/dparams.txt @@ -13,6 +13,9 @@ $Id$ dparam_mode_synchronous dparam_mode_asynchronous dparam_mode_disabled + * split dparam manager api + * plugin api + * application api * documentation * state of unitconvert diff --git a/libs/gst/control/dparam.c b/libs/gst/control/dparam.c index 9dc297a..df3c8c8 100644 --- a/libs/gst/control/dparam.c +++ b/libs/gst/control/dparam.c @@ -1,7 +1,7 @@ /* GStreamer * Copyright (C) 2001 Steve Baker * - * gstdparam.c: Dynamic Parameter functionality + * gstdparam.c: Dynamic Parameter * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public diff --git a/libs/gst/control/dparam.h b/libs/gst/control/dparam.h index 0ece3bf..dfbbfd8 100644 --- a/libs/gst/control/dparam.h +++ b/libs/gst/control/dparam.h @@ -55,7 +55,6 @@ G_BEGIN_DECLS typedef struct _GstDParamClass GstDParamClass; - typedef enum { GST_DPARAM_UPDATE_FIRST, GST_DPARAM_UPDATE_NORMAL diff --git a/libs/gst/control/dparammanager.c b/libs/gst/control/dparammanager.c index 87c329c..15686dd 100644 --- a/libs/gst/control/dparammanager.c +++ b/libs/gst/control/dparammanager.c @@ -636,7 +636,7 @@ gst_dpman_set_parent (GstDParamManager * dpman, GstElement * parent) * Fetch the GstElement that parameters are handled by this manager. * * Returns: the GstDParamManager which belongs to this element or NULL - * if it doesn't exist + * if it doesn't exist. Do not call g_object_unref() on it. */ GstDParamManager * gst_dpman_get_manager (GstElement * parent) @@ -647,6 +647,7 @@ gst_dpman_get_manager (GstElement * parent) g_return_val_if_fail (GST_IS_ELEMENT (parent), NULL); dpman = (GstDParamManager *) g_hash_table_lookup (_element_registry, parent); + /* FIXME: shouldn't this be g_object_ref(dpman); */ return dpman; } -- 2.7.4