gstreamer/docs/libs/gstreamer-libs-docs.sgml
Sebastian Dröge b377c58e43 Add bit reader and byte reader classes, including documentation and an extensive unit test suite. Fixes bug #553554.
Original commit message from CVS:
* docs/libs/gstreamer-libs-docs.sgml:
* docs/libs/gstreamer-libs-sections.txt:
* libs/gst/base/Makefile.am:
* libs/gst/base/gstbitreader.c: (gst_bit_reader_new),
(gst_bit_reader_new_from_buffer), (gst_bit_reader_free),
(gst_bit_reader_init), (gst_bit_reader_init_from_buffer),
(gst_bit_reader_set_pos), (gst_bit_reader_get_pos),
(gst_bit_reader_get_remaining), (gst_bit_reader_skip),
(gst_bit_reader_skip_to_byte):
* libs/gst/base/gstbitreader.h:
* libs/gst/base/gstbytereader.c: (GDOUBLE_SWAP_LE_BE),
(GFLOAT_SWAP_LE_BE), (gst_byte_reader_new),
(gst_byte_reader_new_from_buffer), (gst_byte_reader_free),
(gst_byte_reader_init), (gst_byte_reader_init_from_buffer),
(gst_byte_reader_set_pos), (gst_byte_reader_get_pos),
(gst_byte_reader_get_remaining), (gst_byte_reader_skip),
(gst_byte_reader_get_uint8), (gst_byte_reader_get_int8),
(gst_byte_reader_peek_uint8), (gst_byte_reader_peek_int8),
(gst_byte_reader_get_uint24_le), (gst_byte_reader_get_uint24_be),
(gst_byte_reader_get_int24_le), (gst_byte_reader_get_int24_be),
(gst_byte_reader_peek_uint24_le), (gst_byte_reader_peek_uint24_be),
(gst_byte_reader_peek_int24_le), (gst_byte_reader_peek_int24_be):
* libs/gst/base/gstbytereader.h:
* tests/check/Makefile.am:
* tests/check/libs/bitreader.c: (GST_START_TEST),
(gst_bit_reader_suite):
* tests/check/libs/bytereader.c: (GST_START_TEST),
(gst_byte_reader_suite):
Add bit reader and byte reader classes, including documentation
and an extensive unit test suite. Fixes bug #553554.
2008-10-06 12:41:53 +00:00

135 lines
4.3 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY % version-entities SYSTEM "version.entities">
%version-entities;
<!ENTITY GstAdapter SYSTEM "xml/gstadapter.xml">
<!ENTITY GstBaseSrc SYSTEM "xml/gstbasesrc.xml">
<!ENTITY GstBaseSink SYSTEM "xml/gstbasesink.xml">
<!ENTITY GstBaseTransform SYSTEM "xml/gstbasetransform.xml">
<!ENTITY GstBitReader SYSTEM "xml/gstbitreader.xml">
<!ENTITY GstByteReader SYSTEM "xml/gstbytereader.xml">
<!ENTITY GstCollectPads SYSTEM "xml/gstcollectpads.xml">
<!ENTITY GstPushSrc SYSTEM "xml/gstpushsrc.xml">
<!ENTITY GstTypeFindHelper SYSTEM "xml/gsttypefindhelper.xml">
<!ENTITY GstDataQueue SYSTEM "xml/gstdataqueue.xml">
<!ENTITY GstCheck SYSTEM "xml/gstcheck.xml">
<!ENTITY GstCheckBufferStraw SYSTEM "xml/gstcheckbufferstraw.xml">
<!ENTITY GstController SYSTEM "xml/gstcontroller.xml">
<!ENTITY GstControlSource SYSTEM "xml/gstcontrolsource.xml">
<!ENTITY GstInterpolationControlSource SYSTEM "xml/gstinterpolationcontrolsource.xml">
<!ENTITY GstLFOControlSource SYSTEM "xml/gstlfocontrolsource.xml">
<!ENTITY GstControllerGObject SYSTEM "xml/gstcontrollergobject.xml">
<!ENTITY GstDataProtocol SYSTEM "xml/gstdataprotocol.xml">
<!ENTITY GstNetClientClock SYSTEM "xml/gstnetclientclock.xml">
<!ENTITY GstNetTimePacket SYSTEM "xml/gstnettimepacket.xml">
<!ENTITY GstNetTimeProvider SYSTEM "xml/gstnettimeprovider.xml">
<!-- generated by gtkdoc-mkdb -->
<!ENTITY gstreamer-libs-tree-index SYSTEM "xml/tree_index.sgml">
<!ENTITY hash "#">
]>
<book id="index">
<bookinfo>
<title>GStreamer &GST_MAJORMINOR; Library Reference Manual</title>
<releaseinfo>
for GStreamer Library &GST_MAJORMINOR; (&GST_VERSION;)
<ulink role="online-location" url="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/">http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/</ulink>.
</releaseinfo>
</bookinfo>
<part id="gstreamer-libs">
<title>GStreamer Libraries</title>
<para>
To ease the creation of plugins, a library system was created. The most common
functions for a plugin can be found in a library.
</para>
<para>
GStreamer provides some standard libraries you can use to create plugins.
</para>
<chapter id="gstreamer-base">
<title>GStreamer Base and Utillity Classes</title>
<para>
libgstbase-&GST_MAJORMINOR;.so provides some base classes to be extended
by elements and utillity classes that are most useful for plugin developers.
</para>
&GstBaseSrc;
&GstBaseSink;
&GstBaseTransform;
&GstPushSrc;
&GstAdapter;
&GstBitReader;
&GstByteReader;
&GstCollectPads;
&GstTypeFindHelper;
&GstDataQueue;
</chapter>
<chapter id="gstreamer-control">
<title>GStreamer Dynamic Parameter Control</title>
&GstController;
&GstControlSource;
&GstInterpolationControlSource;
&GstLFOControlSource;
&GstControllerGObject;
</chapter>
<chapter id="gstreamer-dataprotocol">
<title>GStreamer Data Protocol</title>
&GstDataProtocol;
</chapter>
<chapter id="gstreamer-net">
<title>GStreamer Network Classes</title>
<para>
libgstnet-&GST_MAJORMINOR;.so provides network elements and objects.
</para>
&GstNetClientClock;
&GstNetTimePacket;
&GstNetTimeProvider;
</chapter>
<chapter id="gstreamer-check">
<title>GStreamer Check Unit Testing</title>
<para>
libgstcheck-&GST_MAJORMINOR;.so provides functionality for writing
unit tests that use the check framework.
</para>
&GstCheck;
&GstCheckBufferStraw;
</chapter>
</part>
<part id="gstreamer-libs-hierarchy">
<title>Object Hierarchy</title>
&gstreamer-libs-tree-index;
</part>
<index id="api-index">
<title>Index</title>
</index>
<index role="deprecated">
<title>Index of deprecated symbols</title>
</index>
<!-- disable, as
- index generation is extremly slow in gtk-doc
- we have not tagged lots of symbols thsi way anyway
<index role="0.8">
<title>Index of new symbols in 0.8</title>
</index>
<index role="0.9">
<title>Index of new symbols in 0.9</title>
</index>
-->
</book>