mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-26 03:31:05 +00:00
various doc and style fixes, adding bytestream
Original commit message from CVS: various doc and style fixes, adding bytestream
This commit is contained in:
Thomas Vander Stichele
parent
21c0f31205
commit
2270883f00
15 changed files with 239 additions and 23 deletions
18
ChangeLog
18
ChangeLog
|
|
@ -1,3 +1,21 @@
|
|||
2004-07-28 Thomas Vander Stichele <thomas at apestaart dot org>
|
||||
|
||||
* docs/libs/Makefile.am:
|
||||
* docs/libs/gstreamer-libs-docs.sgml:
|
||||
* docs/libs/gstreamer-libs-sections.txt:
|
||||
* docs/libs/tmpl/gstbytestream.sgml:
|
||||
* docs/libs/tmpl/gstcontrol.sgml:
|
||||
* docs/libs/tmpl/gstdataprotocol.sgml:
|
||||
* docs/libs/tmpl/gstgetbits.sgml:
|
||||
* libs/gst/bytestream/Makefile.am:
|
||||
* libs/gst/bytestream/bytestream.c:
|
||||
* libs/gst/bytestream/bytestream.h:
|
||||
* libs/gst/control/Makefile.am:
|
||||
* libs/gst/dataprotocol/Makefile.am:
|
||||
* libs/gst/getbits/Makefile.am:
|
||||
* libs/gst/getbits/getbits.h:
|
||||
various doc and style fixes, adding bytestream to libs docs.
|
||||
|
||||
2004-07-28 Thomas Vander Stichele <thomas at apestaart dot org>
|
||||
|
||||
* docs/gst/gstreamer-docs.sgml:
|
||||
|
|
|
|||
|
|
@ -65,7 +65,9 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c
|
|||
SCANOBJ_DEPS = $(top_builddir)/libs/gst/control/libgstcontrol-@GST_MAJORMINOR@.la
|
||||
|
||||
# Header files to ignore when scanning.
|
||||
IGNORE_HFILES=
|
||||
IGNORE_HFILES = \
|
||||
gstgetbits_inl.h \
|
||||
dp-private.h
|
||||
|
||||
# Images to copy into HTML directory.
|
||||
HTML_IMAGES =
|
||||
|
|
|
|||
|
|
@ -3,6 +3,7 @@
|
|||
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
|
||||
<!ENTITY % version-entities SYSTEM "version.entities">
|
||||
%version-entities;
|
||||
<!ENTITY GstBytestream SYSTEM "xml/gstbytestream.xml">
|
||||
<!ENTITY GstGetbits SYSTEM "xml/gstgetbits.xml">
|
||||
<!-- has not yet been written
|
||||
<!ENTITY GstGetbits SYSTEM "xml/gstputbits.xml">
|
||||
|
|
@ -30,12 +31,13 @@
|
|||
<para>
|
||||
GStreamer provides some standard libraries you can use to create plugins.
|
||||
</para>
|
||||
&GstBytestream;
|
||||
&GstControl;
|
||||
&GstDataProtocol;
|
||||
&GstGetbits;
|
||||
<!-- has not yet been written
|
||||
&GstPutbits;
|
||||
-->
|
||||
&GstControl;
|
||||
&GstDataProtocol;
|
||||
|
||||
</chapter>
|
||||
|
||||
|
|
|
|||
|
|
@ -77,6 +77,28 @@ gst_backbitsX
|
|||
swab32
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstbytestream</FILE>
|
||||
<INCLUDE>libs/bytestream/bytestream.h</INCLUDE>
|
||||
GstByteStream
|
||||
gst_bytestream_destroy
|
||||
gst_bytestream_flush
|
||||
gst_bytestream_flush_fast
|
||||
gst_bytestream_get_status
|
||||
gst_bytestream_get_timestamp
|
||||
gst_bytestream_length
|
||||
gst_bytestream_new
|
||||
gst_bytestream_peek
|
||||
gst_bytestream_peek_bytes
|
||||
gst_bytestream_print_status
|
||||
gst_bytestream_read
|
||||
gst_bytestream_reset
|
||||
gst_bytestream_seek
|
||||
gst_bytestream_size_hint
|
||||
gst_bytestream_tell
|
||||
<SUBSECTION Standard>
|
||||
</SECTION>
|
||||
|
||||
<SECTION>
|
||||
<FILE>gstdataprotocol</FILE>
|
||||
<INCLUDE>libs/dataprotocol/dataprotocol.h</INCLUDE>
|
||||
|
|
|
|||
178
docs/libs/tmpl/gstbytestream.sgml
Normal file
178
docs/libs/tmpl/gstbytestream.sgml
Normal file
|
|
@ -0,0 +1,178 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
gstbytestream
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
exposes a stream interface on pads.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### STRUCT GstByteStream ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@event:
|
||||
@buflist:
|
||||
@headbufavail:
|
||||
@listavail:
|
||||
@assembled:
|
||||
@assembled_len:
|
||||
@offset:
|
||||
@last_ts:
|
||||
@in_seek:
|
||||
@_gst_reserved:
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_destroy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_flush ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bs:
|
||||
@len:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_flush_fast ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bs:
|
||||
@len:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_get_status ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bs:
|
||||
@avail_out:
|
||||
@event_out:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_get_timestamp ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_length ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bs:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pad:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_peek ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bs:
|
||||
@buf:
|
||||
@len:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_peek_bytes ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bs:
|
||||
@data:
|
||||
@len:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_print_status ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_read ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bs:
|
||||
@buf:
|
||||
@len:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_reset ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bs:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_seek ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bs:
|
||||
@offset:
|
||||
@method:
|
||||
@Returns:
|
||||
<!-- # Unused Parameters # -->
|
||||
@type:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_size_hint ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bs:
|
||||
@size:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION gst_bytestream_tell ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@bs:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
gstcontrol
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Dynamic parameter functionality
|
||||
dynamic parameter functionality.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
gstdataprotocol
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
GStreamer Data Protocol, serializes buffers, caps and events.
|
||||
implements GStreamer Data Protocol to serialize buffers, caps and events.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
gstgetbits
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
Accelerated routines for getting bits from a data stream
|
||||
accelerated routines for getting bits from a data stream.
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
|
||||
plugin_LTLIBRARIES = libgstbytestream.la
|
||||
AS_LIBTOOL_LIB = libgstbytestream
|
||||
|
||||
|
|
@ -18,4 +17,3 @@ install-data-local: as-libtool-install-data-local
|
|||
uninstall-local: as-libtool-uninstall-local
|
||||
|
||||
include $(top_srcdir)/common/as-libtool.mak
|
||||
|
||||
|
|
|
|||
|
|
@ -72,7 +72,7 @@ gst_bytestream_exit (GstByteStream * bs)
|
|||
*
|
||||
* creates a bytestream from the given pad
|
||||
*
|
||||
* Returns: a new #GstByteStream object
|
||||
* Returns: a new #GstByteStream object.
|
||||
*/
|
||||
GstByteStream *
|
||||
gst_bytestream_new (GstPad * pad)
|
||||
|
|
@ -660,7 +660,7 @@ gst_bytestream_read (GstByteStream * bs, GstBuffer ** buf, guint32 len)
|
|||
* Giving size hints to the peer element might improve performance
|
||||
* since less buffers need to be merged.
|
||||
*
|
||||
* Returns: TRUE if the hint was accepted
|
||||
* Returns: TRUE if the hint was accepted.
|
||||
*/
|
||||
gboolean
|
||||
gst_bytestream_size_hint (GstByteStream * bs, guint32 size)
|
||||
|
|
@ -708,7 +708,7 @@ gst_bytestream_get_status (GstByteStream * bs,
|
|||
* the next read could span two or more input buffers with different
|
||||
* timestamps.
|
||||
*
|
||||
* Returns: a timestamp
|
||||
* Returns: a timestamp.
|
||||
*/
|
||||
guint64
|
||||
gst_bytestream_get_timestamp (GstByteStream * bs)
|
||||
|
|
|
|||
|
|
@ -59,7 +59,8 @@ guint32 gst_bytestream_read (GstByteStream *bs, GstBuffer** buf, guint32 len)
|
|||
guint64 gst_bytestream_tell (GstByteStream *bs);
|
||||
guint64 gst_bytestream_length (GstByteStream *bs);
|
||||
gboolean gst_bytestream_size_hint (GstByteStream *bs, guint32 size);
|
||||
gboolean gst_bytestream_seek (GstByteStream *bs, gint64 offset, GstSeekType type);
|
||||
gboolean gst_bytestream_seek (GstByteStream *bs, gint64 offset, GstSeekType method);
|
||||
|
||||
guint32 gst_bytestream_peek (GstByteStream *bs, GstBuffer** buf, guint32 len);
|
||||
guint32 gst_bytestream_peek_bytes (GstByteStream *bs, guint8** data, guint32 len);
|
||||
gboolean gst_bytestream_flush (GstByteStream *bs, guint32 len);
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
|
||||
lib_LTLIBRARIES = libgstcontrol-@GST_MAJORMINOR@.la
|
||||
AS_LIBTOOL_LIB = libgstcontrol-@GST_MAJORMINOR@
|
||||
|
||||
|
|
@ -33,4 +32,3 @@ install-data-local: as-libtool-install-data-local
|
|||
uninstall-local: as-libtool-uninstall-local
|
||||
|
||||
include $(top_srcdir)/common/as-libtool.mak
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
|
||||
plugin_LTLIBRARIES = libgstdataprotocol.la
|
||||
AS_LIBTOOL_LIB = libgstdataprotocol
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,3 @@
|
|||
|
||||
plugin_LTLIBRARIES = libgstgetbits.la
|
||||
AS_LIBTOOL_LIB = libgstgstgetbits
|
||||
|
||||
|
|
@ -28,4 +27,3 @@ install-data-local: as-libtool-install-data-local
|
|||
uninstall-local: as-libtool-uninstall-local
|
||||
|
||||
include $(top_srcdir)/common/as-libtool.mak
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue