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:
* docs/libs/Makefile.am:
* docs/libs/gstreamer-libs-docs.sgml:
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 =
"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">
<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>
</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>
GstDPHeaderFlag
--- /dev/null
+<!-- ##### 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:
+
+
gstcontrol
<!-- ##### SECTION Short_Description ##### -->
-Dynamic parameter functionality
+dynamic parameter functionality.
<!-- ##### SECTION Long_Description ##### -->
<para>
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>
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>
-
plugin_LTLIBRARIES = libgstbytestream.la
AS_LIBTOOL_LIB = libgstbytestream
uninstall-local: as-libtool-uninstall-local
include $(top_srcdir)/common/as-libtool.mak
-
*
* creates a bytestream from the given pad
*
- * Returns: a new #GstByteStream object
+ * Returns: a new #GstByteStream object.
*/
GstByteStream *
gst_bytestream_new (GstPad * pad)
* @bs: the bytestream to flush
* @len: the number of bytes to flush
*
- * Flush len bytes from the bytestream.
+ * Flush len bytes from the bytestream.
* This function can return FALSE when the number of
* bytes could not be flushed due to an event. In that case,
* you can get the number of available bytes before the event
* 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)
* 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)
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);
-
lib_LTLIBRARIES = libgstcontrol-@GST_MAJORMINOR@.la
AS_LIBTOOL_LIB = libgstcontrol-@GST_MAJORMINOR@
uninstall-local: as-libtool-uninstall-local
include $(top_srcdir)/common/as-libtool.mak
-
-
plugin_LTLIBRARIES = libgstdataprotocol.la
AS_LIBTOOL_LIB = libgstdataprotocol
-
plugin_LTLIBRARIES = libgstgetbits.la
AS_LIBTOOL_LIB = libgstgstgetbits
uninstall-local: as-libtool-uninstall-local
include $(top_srcdir)/common/as-libtool.mak
-
/* breaks in structure show alignment on quadword boundaries */
/* FIXME: need to find out how to force GCC to align this to octwords */
struct _gst_getbits_t {
- unsigned char *ptr;
+ unsigned char *ptr;
unsigned long *longptr;
unsigned char *endptr;
unsigned long length;
- long bits;
+ long bits;
unsigned long dword;
unsigned long temp;
unsigned long (*getbyte)(gst_getbits_t *gb, unsigned long bits);
unsigned long (*show1bit)(gst_getbits_t *gb, unsigned long bits);
unsigned long (*showbits)(gst_getbits_t *gb, unsigned long bits);
- void (*flushbits)(gst_getbits_t *gb, unsigned long bits);
+ void (*flushbits)(gst_getbits_t *gb, unsigned long bits);
void (*backbits)(gst_getbits_t *gb, unsigned long bits);
};
(-(gb)->bits)&0x7 \
)
-#define gst_getbits_align_byte(gb)
+#define gst_getbits_align_byte(gb)
#define gst_getbits_bufferpos(gb) ((gb)->ptr)
-#define gst_getbits_bytesleft(gb) ((gb)->endptr - (gb)->ptr)
+#define gst_getbits_bytesleft(gb) ((gb)->endptr - (gb)->ptr)
#define gst_getbits_bitsleft(gb) (((gb)->endptr - (gb)->ptr)*8 - ((-(gb)->bits)&0x7))
projects / platform / upstream / gstreamer.git / commitdiff