Commit d0b8df66 authored by Stefan Kost's avatar Stefan Kost
Browse files

restructured DParam docs added some thoughts about dparams ng

Original commit message from CVS:
restructured DParam docs
added some thoughts about dparams ng
parent 461d0394
2005-01-26 Stefan Kost <ensonic@users.sf.net>
* 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 <tim at centricular dot net>
* gst-element-check.m4:
......
......@@ -8,6 +8,8 @@
# <SUBSECTION Private>
# </SECTION>
<INCLUDE>gst/gst.h</INCLUDE>
<SECTION>
<FILE>gst</FILE>
<TITLE>Gst</TITLE>
......
......@@ -9,6 +9,11 @@
<!ENTITY GstGetbits SYSTEM "xml/gstputbits.xml">
-->
<!ENTITY GstControl SYSTEM "xml/gstcontrol.xml">
<!ENTITY GstDParamManager SYSTEM "xml/gstdpman.xml">
<!ENTITY GstDParam SYSTEM "xml/gstdparam.xml">
<!ENTITY GstDParamSmooth SYSTEM "xml/gstdpsmooth.xml">
<!ENTITY GstDParamLinInterp SYSTEM "xml/gstdplinint.xml">
<!ENTITY GstUnitConvert SYSTEM "xml/gstunitconvert.xml">
<!ENTITY GstDataProtocol SYSTEM "xml/gstdataprotocol.xml">
<!-- generated by gtkdoc-mkdb, stupid name -->
......@@ -21,7 +26,7 @@
<title>GStreamer &GST_MAJORMINOR; Library Reference Manual</title>
<releaseinfo>for GStreamer Library &GST_MAJORMINOR; (&GST_VERSION;)</releaseinfo>
</bookinfo>
<chapter id="gstreamer-libs">
<part id="gstreamer-libs">
<title>GStreamer Libraries</title>
<para>
......@@ -31,20 +36,29 @@
<para>
GStreamer provides some standard libraries you can use to create plugins.
</para>
&GstBytestream;
&GstBytestream;
&GstDataProtocol;
&GstGetbits;
<!-- has not yet been written
&GstPutbits;
-->
<!--link linkend="GObject">GObject</link-->
<chapter id="gstreamer-control">
<title>gstcontrol</title>
&GstControl;
&GstDataProtocol;
&GstGetbits;
<!-- has not yet been written
&GstPutbits;
-->
&GstDParamManager;
&GstDParam;
&GstDParamSmooth;
&GstDParamLinInterp;
&GstUnitConvert;
</chapter>
</part>
</chapter>
<chapter id="gstreamer-libs-hierarchy">
<part id="gstreamer-libs-hierarchy">
<title>Object Hierarchy</title>
&gstreamer-libs-tree-index;
</chapter>
</part>
<index id="api-index">
<title>API Index</title>
......
# GStreamer Libraries API reference sections
# please add section in the alpahbetical order to each library
# using the following template
# <SECTION>
# <FILE>gstxxx</FILE>
# <TITLE>GstXxx</TITLE>
# <SUBSECTION Standard>
# <SUBSECTION Private>
# </SECTION>
<SECTION>
<FILE>gstgetbits</FILE>
<INCLUDE>libs/getbits/gstgetbits.h</INCLUDE>
......@@ -122,11 +133,21 @@ gst_dp_validate_packet
<SUBSECTION Standard>
</SECTION>
# GstControl library
<SECTION>
<FILE>gstcontrol</FILE>
<TITLE>GstControl</TITLE>
<INCLUDE>libs/control/control.h</INCLUDE>
gst_control_init
<SUBSECTION Dynamic Parameter Manager>
<SUBSECTION Standard>
<SUBSECTION Private>
</SECTION>
<SECTION>
<FILE>gstdpman</FILE>
<TITLE>GstDParamManager</TITLE>
<INCLUDE>libs/control/control.h</INCLUDE>
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
<SUBSECTION Dynamic Parameters>
<SUBSECTION Standard>
<SUBSECTION Private>
</SECTION>
<SECTION>
<FILE>gstdparam</FILE>
<TITLE>GstDParam</TITLE>
<INCLUDE>libs/control/control.h</INCLUDE>
GstDParam
gst_dparam_new
gst_dparam_attach
gst_dparam_detach
gst_dparam_do_update_default
<SUBSECTION Standard>
<SUBSECTION Private>
</SECTION>
<SECTION>
<FILE>gstdpsmooth</FILE>
<TITLE>GstDParamSmooth</TITLE>
<INCLUDE>libs/control/control.h</INCLUDE>
GstDParamSmooth
gst_dpsmooth_new
<SUBSECTION Standard>
<SUBSECTION Private>
</SECTION>
<SECTION>
<FILE>gstdplinint</FILE>
<TITLE>GstDParamLinInterp</TITLE>
<INCLUDE>libs/control/control.h</INCLUDE>
GstDParamLinInterp
gst_dp_linint_new
<SUBSECTION Standard>
<SUBSECTION Private>
</SECTION>
<SECTION>
<FILE>gstunitconvert</FILE>
<TITLE>GstUnitConvert</TITLE>
<INCLUDE>libs/control/control.h</INCLUDE>
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
<SUBSECTION Standard>
<SUBSECTION Private>
</SECTION>
......@@ -42,276 +42,3 @@ The next step is to get hold of the GstDParamManager instance of a GstElement.
@argv:
<!-- ##### STRUCT GstDParamManager ##### -->
<para>
</para>
<!-- ##### SIGNAL GstDParamManager::new-required-dparam ##### -->
<para>
</para>
@gstdparammanager: the object which received the signal.
@arg1:
<!-- ##### FUNCTION gst_dpman_new ##### -->
<para>
</para>
@name:
@parent:
@Returns:
<!-- ##### FUNCTION gst_dpman_add_required_dparam_callback ##### -->
<para>
</para>
@dpman:
@param_spec:
@unit_name:
@update_func:
@update_data:
@Returns:
<!-- ##### FUNCTION gst_dpman_add_required_dparam_direct ##### -->
<para>
</para>
@dpman:
@param_spec:
@unit_name:
@update_data:
@Returns:
<!-- ##### FUNCTION gst_dpman_add_required_dparam_array ##### -->
<para>
</para>
@dpman:
@param_spec:
@unit_name:
@update_data:
@Returns:
<!-- ##### FUNCTION gst_dpman_remove_required_dparam ##### -->
<para>
</para>
@dpman:
@dparam_name:
<!-- ##### FUNCTION gst_dpman_attach_dparam ##### -->
<para>
</para>
@dpman:
@dparam_name:
@dparam:
@Returns:
<!-- ##### FUNCTION gst_dpman_detach_dparam ##### -->
<para>
</para>
@dpman:
@dparam_name:
<!-- ##### FUNCTION gst_dpman_get_dparam ##### -->
<para>
</para>
@dpman:
@dparam_name:
@Returns:
<!-- # Unused Parameters # -->
@name:
<!-- ##### FUNCTION gst_dpman_get_dparam_type ##### -->
<para>
</para>
@dpman:
@dparam_name:
@Returns:
<!-- # Unused Parameters # -->
@name:
<!-- ##### FUNCTION gst_dpman_list_dparam_specs ##### -->
<para>
</para>
@dpman:
@Returns:
<!-- ##### FUNCTION gst_dpman_get_param_spec ##### -->
<para>
</para>
@dpman:
@dparam_name:
@Returns:
<!-- ##### FUNCTION gst_dpman_set_rate ##### -->
<para>
</para>
@dpman:
@rate:
<!-- ##### FUNCTION gst_dpman_register_mode ##### -->
<para>
</para>
@klass:
@modename:
@preprocessfunc:
@processfunc:
@setupfunc:
@teardownfunc:
<!-- ##### FUNCTION gst_dpman_set_mode ##### -->
<para>
</para>
@dpman:
@modename:
@Returns:
<!-- ##### FUNCTION gst_dpman_set_parent ##### -->
<para>
</para>
@dpman:
@parent:
<!-- ##### FUNCTION gst_dpman_get_manager ##### -->
<para>
</para>
@parent:
@Returns:
<!-- ##### FUNCTION gst_dpman_bypass_dparam ##### -->
<para>
</para>
@dpman:
@dparam_name:
<!-- ##### STRUCT GstDParam ##### -->
<para>
</para>
<!-- ##### SIGNAL GstDParam::value-changed ##### -->
<para>
</para>
@gstdparam: the object which received the signal.
<!-- ##### ARG GstDParam:value-double ##### -->
<para>
</para>
<!-- ##### ARG GstDParam:value-float ##### -->
<para>
</para>
<!-- ##### ARG GstDParam:value-int ##### -->
<para>
</para>
<!-- ##### ARG GstDParam:value-int64 ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_dparam_new ##### -->
<para>
</para>
@type:
@Returns:
<!-- ##### FUNCTION gst_dparam_attach ##### -->
<para>
</para>
@dparam:
@manager:
@param_spec:
@unit_name:
<!-- ##### FUNCTION gst_dparam_detach ##### -->
<para>
</para>
@dparam:
<!-- ##### FUNCTION gst_dparam_do_update_default ##### -->
<para>
</para>
@dparam:
@timestamp:
@value:
@update_info:
<!-- ##### FUNCTION gst_dpsmooth_new ##### -->
<para>
</para>
@type:
@Returns:
<!-- ##### SECTION Title ##### -->
GstDParam
<!-- ##### SECTION Short_Description ##### -->
dynamic parameter instance
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstDParam ##### -->
<para>
</para>
<!-- ##### SIGNAL GstDParam::value-changed ##### -->
<para>
</para>
@gstdparam: the object which received the signal.
<!-- ##### ARG GstDParam:value-double ##### -->
<para>
</para>
<!-- ##### ARG GstDParam:value-float ##### -->
<para>
</para>
<!-- ##### ARG GstDParam:value-int ##### -->
<para>
</para>
<!-- ##### ARG GstDParam:value-int64 ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_dparam_new ##### -->
<para>
</para>
@type:
@Returns:
<!-- ##### FUNCTION gst_dparam_attach ##### -->
<para>
</para>
@dparam:
@manager:
@param_spec:
@unit_name:
<!-- ##### FUNCTION gst_dparam_detach ##### -->
<para>
</para>
@dparam:
<!-- ##### FUNCTION gst_dparam_do_update_default ##### -->
<para>
</para>
@dparam:
@timestamp:
@value:
@update_info:
<!-- ##### SECTION Title ##### -->
GstDParamLinInterp
<!-- ##### SECTION Short_Description ##### -->
linear interpolation dynamic parameter
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstDParamLinInterp ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_dp_linint_new ##### -->
<para>
</para>
@type:
@Returns:
<!-- ##### SECTION Title ##### -->
GstDParamManager
<!-- ##### SECTION Short_Description ##### -->
dynamic parameter manager
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<para>
Some functions are meant for dparam implementor (plugin writers), where others
are for applications that use elements with dparams.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT GstDParamManager ##### -->
<para>
</para>
<!-- ##### SIGNAL GstDParamManager::new-required-dparam ##### -->
<para>
</para>
@gstdparammanager: the object which received the signal.
@arg1:
<!-- ##### FUNCTION gst_dpman_new ##### -->
<para>
</para>
@name:
@parent:
@Returns:
<!-- ##### FUNCTION gst_dpman_add_required_dparam_callback ##### -->
<para>
</para>
@dpman:
@param_spec:
@unit_name:
@update_func:
@update_data:
@Returns: