diff --git a/ChangeLog b/ChangeLog index 8a0505af64..d94b2c8882 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,21 @@ +2004-07-28 Thomas Vander Stichele + + * 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 * docs/gst/gstreamer-docs.sgml: diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am index abd2525cfe..0abce001c4 100644 --- a/docs/libs/Makefile.am +++ b/docs/libs/Makefile.am @@ -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 = diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml index 3571b6d81c..845335289d 100644 --- a/docs/libs/gstreamer-libs-docs.sgml +++ b/docs/libs/gstreamer-libs-docs.sgml @@ -3,6 +3,7 @@ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ %version-entities; + - &GstControl; - &GstDataProtocol; diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt index d66291cc94..495fbba924 100644 --- a/docs/libs/gstreamer-libs-sections.txt +++ b/docs/libs/gstreamer-libs-sections.txt @@ -77,6 +77,28 @@ gst_backbitsX swab32 +
+gstbytestream +libs/bytestream/bytestream.h +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 + +
+
gstdataprotocol libs/dataprotocol/dataprotocol.h diff --git a/docs/libs/tmpl/gstbytestream.sgml b/docs/libs/tmpl/gstbytestream.sgml new file mode 100644 index 0000000000..48660ff0bc --- /dev/null +++ b/docs/libs/tmpl/gstbytestream.sgml @@ -0,0 +1,178 @@ + +gstbytestream + + +exposes a stream interface on pads. + + + + + + + + + + + + + + + + +@pad: +@event: +@buflist: +@headbufavail: +@listavail: +@assembled: +@assembled_len: +@offset: +@last_ts: +@in_seek: +@_gst_reserved: + + + + + + +@bs: + + + + + + + +@bs: +@len: +@Returns: + + + + + + + +@bs: +@len: + + + + + + + +@bs: +@avail_out: +@event_out: + + + + + + + +@bs: +@Returns: + + + + + + + +@bs: +@Returns: + + + + + + + +@pad: +@Returns: + + + + + + + +@bs: +@buf: +@len: +@Returns: + + + + + + + +@bs: +@data: +@len: +@Returns: + + + + + + + +@bs: + + + + + + + +@bs: +@buf: +@len: +@Returns: + + + + + + + +@bs: + + + + + + + +@bs: +@offset: +@method: +@Returns: + +@type: + + + + + + + +@bs: +@size: +@Returns: + + + + + + + +@bs: +@Returns: + + diff --git a/docs/libs/tmpl/gstcontrol.sgml b/docs/libs/tmpl/gstcontrol.sgml index a6ae5bde12..3ebdcba645 100644 --- a/docs/libs/tmpl/gstcontrol.sgml +++ b/docs/libs/tmpl/gstcontrol.sgml @@ -2,7 +2,7 @@ gstcontrol -Dynamic parameter functionality +dynamic parameter functionality. diff --git a/docs/libs/tmpl/gstdataprotocol.sgml b/docs/libs/tmpl/gstdataprotocol.sgml index 099e5878b3..0cd1515e94 100644 --- a/docs/libs/tmpl/gstdataprotocol.sgml +++ b/docs/libs/tmpl/gstdataprotocol.sgml @@ -2,7 +2,7 @@ gstdataprotocol -GStreamer Data Protocol, serializes buffers, caps and events. +implements GStreamer Data Protocol to serialize buffers, caps and events. diff --git a/docs/libs/tmpl/gstgetbits.sgml b/docs/libs/tmpl/gstgetbits.sgml index 2f72a3e98b..1d107d65fa 100644 --- a/docs/libs/tmpl/gstgetbits.sgml +++ b/docs/libs/tmpl/gstgetbits.sgml @@ -2,7 +2,7 @@ gstgetbits -Accelerated routines for getting bits from a data stream +accelerated routines for getting bits from a data stream. diff --git a/libs/gst/bytestream/Makefile.am b/libs/gst/bytestream/Makefile.am index b1a0e4e933..1e61fe9610 100644 --- a/libs/gst/bytestream/Makefile.am +++ b/libs/gst/bytestream/Makefile.am @@ -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 - diff --git a/libs/gst/bytestream/bytestream.c b/libs/gst/bytestream/bytestream.c index 75fa56444a..e7f4d46006 100644 --- a/libs/gst/bytestream/bytestream.c +++ b/libs/gst/bytestream/bytestream.c @@ -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) @@ -433,7 +433,7 @@ gst_bytestream_assemble (GstByteStream * bs, guint32 len) * @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 @@ -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) diff --git a/libs/gst/bytestream/bytestream.h b/libs/gst/bytestream/bytestream.h index 08ae068a37..a3dcc6194c 100644 --- a/libs/gst/bytestream/bytestream.h +++ b/libs/gst/bytestream/bytestream.h @@ -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); diff --git a/libs/gst/control/Makefile.am b/libs/gst/control/Makefile.am index 404e8c3092..d341b8f643 100644 --- a/libs/gst/control/Makefile.am +++ b/libs/gst/control/Makefile.am @@ -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 - diff --git a/libs/gst/dataprotocol/Makefile.am b/libs/gst/dataprotocol/Makefile.am index 280ec3cb08..c4077eb10d 100644 --- a/libs/gst/dataprotocol/Makefile.am +++ b/libs/gst/dataprotocol/Makefile.am @@ -1,4 +1,3 @@ - plugin_LTLIBRARIES = libgstdataprotocol.la AS_LIBTOOL_LIB = libgstdataprotocol diff --git a/libs/gst/getbits/Makefile.am b/libs/gst/getbits/Makefile.am index e818589c76..92cf2b7d68 100644 --- a/libs/gst/getbits/Makefile.am +++ b/libs/gst/getbits/Makefile.am @@ -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 - diff --git a/libs/gst/getbits/getbits.h b/libs/gst/getbits/getbits.h index c070939298..e5586e17be 100644 --- a/libs/gst/getbits/getbits.h +++ b/libs/gst/getbits/getbits.h @@ -15,11 +15,11 @@ typedef void (*GstGetbitsCallback) (gst_getbits_t *gb, void *data); /* 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; @@ -32,7 +32,7 @@ struct _gst_getbits_t { 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); }; @@ -49,11 +49,11 @@ void gst_getbits_newbuf(gst_getbits_t *gb, unsigned char *buffer, unsigned long (-(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))