mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-29 21:21:12 +00:00
Code Issues 1 Projects Releases Wiki Activity

added short description for two libraries (what is the state of gstgetbits/putbits)

Browse source 
Original commit message from CVS:
added short description for two libraries (what is the state of gstgetbits/putbits)
This commit is contained in:
Stefan Kost 2004-07-14 12:17:43 +00:00
parent 9b99ef6164
commit 8812f880f5
3 changed files with 777 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/libs/gstreamer-libs-docs.sgml
View file

@ -4,6 +4,9 @@
<!ENTITY % version-entities SYSTEM "version.entities"> <!ENTITY % version-entities SYSTEM "version.entities">
%version-entities; %version-entities;
<!ENTITY GstGetbits SYSTEM "xml/gstgetbits.xml"> <!ENTITY GstGetbits SYSTEM "xml/gstgetbits.xml">
<!-- has not yet been written
<!ENTITY GstGetbits SYSTEM "xml/gstputbits.xml">
-->
<!ENTITY GstControl SYSTEM "xml/gstcontrol.xml"> <!ENTITY GstControl SYSTEM "xml/gstcontrol.xml">
<!ENTITY GstDataProtocol SYSTEM "xml/gstdataprotocol.xml"> <!ENTITY GstDataProtocol SYSTEM "xml/gstdataprotocol.xml">
@ -25,6 +28,9 @@
GStreamer provides some standard libraries you can use to create plugins. GStreamer provides some standard libraries you can use to create plugins.
</para> </para>
&GstGetbits; &GstGetbits;
<!-- has not yet been written
&GstPutbits;
-->
&GstControl; &GstControl;
&GstDataProtocol; &GstDataProtocol;

210
docs/libs/tmpl/gstcontrol.sgml Normal file
View file

@ -0,0 +1,210 @@
<!-- ##### SECTION Title ##### -->
gstcontrol
<!-- ##### SECTION Short_Description ##### -->
Dynamic parameter functionality
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### FUNCTION gst_control_init ##### -->
<para>
</para>
@argc:
@argv:
<!-- ##### 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:
@name:
@Returns:
<!-- ##### FUNCTION gst_dpman_get_dparam_type ##### -->
<para>
</para>
@dpman:
@name:
@Returns:
<!-- ##### 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:
<!-- ##### 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:

561
docs/libs/tmpl/gstgetbits.sgml Normal file
View file

@ -0,0 +1,561 @@
<!-- ##### SECTION Title ##### -->
gstgetbits
<!-- ##### SECTION Short_Description ##### -->
Accelerated routines for getting bits from a data stream
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT gst_getbits_t ##### -->
<para>
</para>
@ptr:
@longptr:
@endptr:
@length:
@bits:
@dword:
@temp:
@callback:
@data:
@get1bit:
@getbits:
@getbits_fast:
@getbyte:
@show1bit:
@showbits:
@flushbits:
@backbits:
<!-- ##### USER_FUNCTION GstGetbitsCallback ##### -->
<para>
</para>
@gb:
@data:
<!-- ##### FUNCTION gst_getbits_init ##### -->
<para>
</para>
@gb:
@callback:
@data:
<!-- ##### FUNCTION gst_getbits_newbuf ##### -->
<para>
</para>
@gb:
@buffer:
@Param3:
<!-- ##### MACRO gst_getbits_bitoffset ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits_align_byte ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits_bufferpos ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits_bytesleft ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits_bitsleft ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbyte ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits_fastn ##### -->
<para>
</para>
@gb:
@n:
<!-- ##### MACRO gst_getbitsn ##### -->
<para>
</para>
@gb:
@num:
<!-- ##### MACRO gst_getbits1 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits2 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits3 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits4 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits5 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits6 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits7 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits8 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits9 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits10 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits11 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits12 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits13 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits14 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits15 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits16 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits17 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits18 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits19 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits20 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits21 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits22 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_getbits23 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbitsn ##### -->
<para>
</para>
@gb:
@num:
<!-- ##### MACRO gst_showbits1 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits2 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits3 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits4 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits5 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits6 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits7 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits8 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits9 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits10 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits11 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits12 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits13 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits14 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits15 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits16 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits17 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits18 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits19 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits20 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits21 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits22 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits23 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits24 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_showbits32 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_flushbitsn ##### -->
<para>
</para>
@gb:
@num:
<!-- ##### MACRO gst_flushbits32 ##### -->
<para>
</para>
@gb:
<!-- ##### MACRO gst_backbitsn ##### -->
<para>
</para>
@gb:
@num:
<!-- ##### MACRO gst_backbits24 ##### -->
<para>
</para>
@gb: