Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Initial revision

git-svn-id: http://svn.annodex.net/liboggz/trunk@343 8158c8cd-e7e1-0310-9fa4-c5954c97daef
  • Loading branch information...
commit 8bb668dce048ae1c71cff1932e1e83fd4dbb0464 0 parents
andre authored
Showing with 7,161 additions and 0 deletions.
  1. +1 −0  AUTHORS
  2. +29 −0 COPYING
  3. +3 −0  ChangeLog
  4. +182 −0 INSTALL
  5. +8 −0 Makefile.am
  6. +1 −0  NEWS
  7. +2 −0  README
  8. +53 −0 autogen.sh
  9. +240 −0 configure.ac
  10. +1,078 −0 doc/Doxyfile.in
  11. +33 −0 doc/Makefile.am
  12. +3 −0  include/Makefile.am
  13. +6 −0 include/oggz/Makefile.am
  14. +747 −0 include/oggz/oggz.h
  15. +123 −0 include/oggz/oggz_constants.h
  16. +11 −0 oggz.pc.in
  17. +3 −0  src/Makefile.am
  18. +27 −0 src/examples/Makefile.am
  19. +95 −0 src/examples/identity.c
  20. +83 −0 src/examples/read-file.c
  21. +19 −0 src/liboggz/Makefile.am
  22. +34 −0 src/liboggz/Version_script.in
  23. +451 −0 src/liboggz/oggz.c
  24. +190 −0 src/liboggz/oggz_private.h
  25. +1,192 −0 src/liboggz/oggz_read.c
  26. +246 −0 src/liboggz/oggz_vector.c
  27. +82 −0 src/liboggz/oggz_vector.h
  28. +713 −0 src/liboggz/oggz_write.c
  29. +50 −0 src/tests/Makefile.am
  30. +43 −0 src/tests/oggz_tests.h
  31. +115 −0 src/tests/write-bad-bos.c
  32. +101 −0 src/tests/write-bad-bytes.c
  33. +99 −0 src/tests/write-bad-eos.c
  34. +99 −0 src/tests/write-bad-granulepos.c
  35. +85 −0 src/tests/write-bad-guard.c
  36. +98 −0 src/tests/write-bad-packetno.c
  37. +97 −0 src/tests/write-dup-bos.c
  38. +73 −0 src/tests/write-recursive.c
  39. +98 −0 src/tests/write-unmarked-guard.c
  40. +25 −0 src/tools/Makefile.am
  41. +190 −0 src/tools/oggzdump.c
  42. +249 −0 src/tools/oggzed.c
  43. +84 −0 src/tools/oggzinfo.c
1  AUTHORS
@@ -0,0 +1 @@
+Conrad Parker <conrad@metadecks.org>
29 COPYING
@@ -0,0 +1,29 @@
+ Copyright (C) 2003 CSIRO Australia
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+
+ - Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+ - Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ - Neither the name of the CSIRO nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
3  ChangeLog
@@ -0,0 +1,3 @@
+Thu Oct 16 21:55:07 EST 2003 Conrad Parker <conrad@annodex.net>
+
+ * split liboggz out from libannodex sources, started ChangeLog
182 INSTALL
@@ -0,0 +1,182 @@
+Basic Installation
+==================
+
+ These are generic installation instructions.
+
+ The `configure' shell script attempts to guess correct values for
+various system-dependent variables used during compilation. It uses
+those values to create a `Makefile' in each directory of the package.
+It may also create one or more `.h' files containing system-dependent
+definitions. Finally, it creates a shell script `config.status' that
+you can run in the future to recreate the current configuration, a file
+`config.cache' that saves the results of its tests to speed up
+reconfiguring, and a file `config.log' containing compiler output
+(useful mainly for debugging `configure').
+
+ If you need to do unusual things to compile the package, please try
+to figure out how `configure' could check whether to do them, and mail
+diffs or instructions to the address given in the `README' so they can
+be considered for the next release. If at some point `config.cache'
+contains results you don't want to keep, you may remove or edit it.
+
+ The file `configure.in' is used to create `configure' by a program
+called `autoconf'. You only need `configure.in' if you want to change
+it or regenerate `configure' using a newer version of `autoconf'.
+
+The simplest way to compile this package is:
+
+ 1. `cd' to the directory containing the package's source code and type
+ `./configure' to configure the package for your system. If you're
+ using `csh' on an old version of System V, you might need to type
+ `sh ./configure' instead to prevent `csh' from trying to execute
+ `configure' itself.
+
+ Running `configure' takes awhile. While running, it prints some
+ messages telling which features it is checking for.
+
+ 2. Type `make' to compile the package.
+
+ 3. Optionally, type `make check' to run any self-tests that come with
+ the package.
+
+ 4. Type `make install' to install the programs and any data files and
+ documentation.
+
+ 5. You can remove the program binaries and object files from the
+ source code directory by typing `make clean'. To also remove the
+ files that `configure' created (so you can compile the package for
+ a different kind of computer), type `make distclean'. There is
+ also a `make maintainer-clean' target, but that is intended mainly
+ for the package's developers. If you use it, you may have to get
+ all sorts of other programs in order to regenerate files that came
+ with the distribution.
+
+Compilers and Options
+=====================
+
+ Some systems require unusual options for compilation or linking that
+the `configure' script does not know about. You can give `configure'
+initial values for variables by setting them in the environment. Using
+a Bourne-compatible shell, you can do that on the command line like
+this:
+ CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
+
+Or on systems that have the `env' program, you can do it like this:
+ env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
+
+Compiling For Multiple Architectures
+====================================
+
+ You can compile the package for more than one kind of computer at the
+same time, by placing the object files for each architecture in their
+own directory. To do this, you must use a version of `make' that
+supports the `VPATH' variable, such as GNU `make'. `cd' to the
+directory where you want the object files and executables to go and run
+the `configure' script. `configure' automatically checks for the
+source code in the directory that `configure' is in and in `..'.
+
+ If you have to use a `make' that does not supports the `VPATH'
+variable, you have to compile the package for one architecture at a time
+in the source code directory. After you have installed the package for
+one architecture, use `make distclean' before reconfiguring for another
+architecture.
+
+Installation Names
+==================
+
+ By default, `make install' will install the package's files in
+`/usr/local/bin', `/usr/local/man', etc. You can specify an
+installation prefix other than `/usr/local' by giving `configure' the
+option `--prefix=PATH'.
+
+ You can specify separate installation prefixes for
+architecture-specific files and architecture-independent files. If you
+give `configure' the option `--exec-prefix=PATH', the package will use
+PATH as the prefix for installing programs and libraries.
+Documentation and other data files will still use the regular prefix.
+
+ In addition, if you use an unusual directory layout you can give
+options like `--bindir=PATH' to specify different values for particular
+kinds of files. Run `configure --help' for a list of the directories
+you can set and what kinds of files go in them.
+
+ If the package supports it, you can cause programs to be installed
+with an extra prefix or suffix on their names by giving `configure' the
+option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
+
+Optional Features
+=================
+
+ Some packages pay attention to `--enable-FEATURE' options to
+`configure', where FEATURE indicates an optional part of the package.
+They may also pay attention to `--with-PACKAGE' options, where PACKAGE
+is something like `gnu-as' or `x' (for the X Window System). The
+`README' should mention any `--enable-' and `--with-' options that the
+package recognizes.
+
+ For packages that use the X Window System, `configure' can usually
+find the X include and library files automatically, but if it doesn't,
+you can use the `configure' options `--x-includes=DIR' and
+`--x-libraries=DIR' to specify their locations.
+
+Specifying the System Type
+==========================
+
+ There may be some features `configure' can not figure out
+automatically, but needs to determine by the type of host the package
+will run on. Usually `configure' can figure that out, but if it prints
+a message saying it can not guess the host type, give it the
+`--host=TYPE' option. TYPE can either be a short name for the system
+type, such as `sun4', or a canonical name with three fields:
+ CPU-COMPANY-SYSTEM
+
+See the file `config.sub' for the possible values of each field. If
+`config.sub' isn't included in this package, then this package doesn't
+need to know the host type.
+
+ If you are building compiler tools for cross-compiling, you can also
+use the `--target=TYPE' option to select the type of system they will
+produce code for and the `--build=TYPE' option to select the type of
+system on which you are compiling the package.
+
+Sharing Defaults
+================
+
+ If you want to set default values for `configure' scripts to share,
+you can create a site shell script called `config.site' that gives
+default values for variables like `CC', `cache_file', and `prefix'.
+`configure' looks for `PREFIX/share/config.site' if it exists, then
+`PREFIX/etc/config.site' if it exists. Or, you can set the
+`CONFIG_SITE' environment variable to the location of the site script.
+A warning: not all `configure' scripts look for a site script.
+
+Operation Controls
+==================
+
+ `configure' recognizes the following options to control how it
+operates.
+
+`--cache-file=FILE'
+ Use and save the results of the tests in FILE instead of
+ `./config.cache'. Set FILE to `/dev/null' to disable caching, for
+ debugging `configure'.
+
+`--help'
+ Print a summary of the options to `configure', and exit.
+
+`--quiet'
+`--silent'
+`-q'
+ Do not print messages saying which checks are being made. To
+ suppress all normal output, redirect it to `/dev/null' (any error
+ messages will still be shown).
+
+`--srcdir=DIR'
+ Look for the package's source code in directory DIR. Usually
+ `configure' can determine that directory automatically.
+
+`--version'
+ Print the version of Autoconf used to generate the `configure'
+ script, and exit.
+
+`configure' also accepts some other, not widely useful, options.
8 Makefile.am
@@ -0,0 +1,8 @@
+## Process this file with automake to produce Makefile.in
+
+SUBDIRS = doc include src
+
+EXTRA_DIST = oggz.pc.in
+
+pkgconfigdir = $(libdir)/pkgconfig
+pkgconfig_DATA = oggz.pc
1  NEWS
@@ -0,0 +1 @@
+
2  README
@@ -0,0 +1,2 @@
+
+
53 autogen.sh
@@ -0,0 +1,53 @@
+#!/bin/sh
+
+# find out the automake version number, in format 1.major.minor
+# (i don't think version 2 will be coming anytime soon :) (stolen
+# from videolan's vlc bootstrap strip)
+automake_version="none"
+if automake-1.7 --version >/dev/null 2>&1; then
+ automake_version="-1.7"
+elif automake-1.6 --version >/dev/null 2>&1; then
+ automake_version="-1.6"
+elif automake-1.5 --version >/dev/null 2>&1; then
+ automake_version="-1.5"
+elif automake --version > /dev/null 2>&1; then
+ automake_version=""
+ case "`automake --version | sed -e '1s/[^0-9]*//' -e q`" in
+ 0|0.*|1|1.[01234]|1.[01234][-.]*) automake_version="none" ;;
+ 1.5*) automake_version="-1.5" ;;
+ 1.6*) automake_version="-1.6" ;;
+ 1.7*) automake_version="-1.7" ;;
+ 1.8*) automake_version="-1.8" ;;
+ 1.9*) automake_version="-1.9" ;;
+ esac
+fi
+
+if test "x${automake_version}" = "xnone"; then
+ set +x
+ echo "you need automake version 1.5 or later"
+ exit 1
+fi
+
+
+
+automake_version_major=`echo "$automake_version" | cut -d. -f2`
+automake_version_minor=`echo "$automake_version" | cut -d. -f3`
+
+# need at least automake >= 1.5
+if test "$automake_version_major" -lt "5"; then
+ echo "$0: this project requires automake >= 1.5. Please upgrade your version of automake to at least 1.5"
+ exit 1
+fi
+
+# make autotools directory if it doesn't already exist
+[ -d "autotools" ] || mkdir "autotools"
+
+# need libltdl?
+if grep -q AC_LIBLTDL_CONVENIENCE configure.*; then
+ LIBTOOLIZE=${LIBTOOLIZE:-libtoolize}
+ "$LIBTOOLIZE" --ltdl --copy --force
+fi
+
+AUTORECONF=${AUTORECONF:-autoreconf}
+"$AUTORECONF" --install "$@"
+
240 configure.ac
@@ -0,0 +1,240 @@
+# Process this file with autoconf to produce a configure script.
+AC_INIT
+AC_CONFIG_SRCDIR([src/liboggz/oggz.c])
+
+AC_PREREQ(2.53)
+AC_CONFIG_AUX_DIR(autotools)
+AC_CANONICAL_TARGET
+
+AM_INIT_AUTOMAKE(liboggz, 0.5.43)
+AM_CONFIG_HEADER(config.h)
+
+SHARED_VERSION_INFO="0:5:0"
+SHLIB_VERSION_ARG=""
+
+# Checks for programs.
+AC_PROG_CC
+AC_PROG_INSTALL
+AC_PROG_MAKE_SET
+AC_PROG_LIBTOOL
+
+AC_C_CONST
+AC_C_BIGENDIAN
+
+
+# Check for doxygen
+AC_CHECK_PROG(HAVE_DOXYGEN, doxygen, true, false)
+AM_CONDITIONAL(HAVE_DOXYGEN,$HAVE_DOXYGEN)
+if test $HAVE_DOXYGEN = "false"; then
+ AC_MSG_WARN([*** doxygen not found, docs will not be built])
+fi
+
+# Check for docbook
+AC_CHECK_PROG(HAVE_DOCBOOK, docbook2man, true, false)
+AM_CONDITIONAL(HAVE_DOCBOOK,$HAVE_DOCBOOK)
+
+dnl Check for types
+
+dnl Checks for libraries.
+LIBS=""
+
+# check for getopt in standard library
+HAVE_GETOPT=no
+AC_CHECK_LIB(getopt, getopt, HAVE_GETOPT="yes")
+if test "x$HAVE_GETOPT" = xyes ; then
+ GETOPT_LIBS="-lgetopt"
+ AC_SUBST(GETOPT_LIBS)
+fi
+
+dnl Overall configuration success flag
+oggz_config_ok=yes
+
+dnl
+dnl Configuration option for building of experimental code.
+dnl
+
+ac_enable_experimental=no
+AC_ARG_ENABLE(experimental,
+ [ --enable-experimental enable building of experimental code ],
+ [ ac_enable_experimental=yes ])
+
+if test "x${ac_enable_experimental}" = xyes ; then
+ AC_DEFINE(OGGZ_CONFIG_EXPERIMENTAL, [], [Define to build experimental code])
+fi
+
+dnl
+dnl Configuration option for building of reading support.
+dnl
+
+ac_enable_read=yes
+AC_ARG_ENABLE(read,
+ [ --disable-read disable building of reading support ],
+ [ ac_enable_read=no ], [ ac_enable_read=yes] )
+
+if test "x${ac_enable_read}" = xyes ; then
+ AC_DEFINE(OGGZ_CONFIG_READ, [1], [Build reading support])
+else
+ AC_DEFINE(OGGZ_CONFIG_READ, [0], [Do not build reading support])
+fi
+AM_CONDITIONAL(OGGZ_CONFIG_READ, test "x${ac_enable_read}" = xyes)
+
+dnl
+dnl Configuration option for building of writing support.
+dnl
+
+ac_enable_write=yes
+AC_ARG_ENABLE(write,
+ [ --disable-write disable building of writing support ],
+ [ ac_enable_write=no ], [ ac_enable_write=yes] )
+
+if test "x${ac_enable_write}" = xyes ; then
+ AC_DEFINE(OGGZ_CONFIG_WRITE, [1], [Build writing support])
+else
+ AC_DEFINE(OGGZ_CONFIG_WRITE, [0], [Do not build writing support])
+fi
+AM_CONDITIONAL(OGGZ_CONFIG_WRITE, test "x${ac_enable_write}" = xyes)
+
+dnl
+dnl Check read/write option sanity
+dnl
+if test "x${ac_enable_read}" = xno && test "x${ac_enable_write}" = xno ; then
+ AC_MSG_ERROR([
+***
+*** You have attempted to explicitly disable both writing and reading.
+***
+])
+fi
+
+
+dnl
+dnl Detect Ogg
+dnl
+
+HAVE_OGG=no
+XIPH_PATH_OGG(HAVE_OGG="yes", HAVE_OGG="no")
+if test "x$HAVE_OGG" = xno ; then
+ oggz_config_ok="no"
+ AC_CHECK_LIB(ogg, ogg_stream_init, HAVE_OGG="maybe")
+fi
+AM_CONDITIONAL(HAVE_OGG, [test "x$HAVE_OGG" = "xyes"])
+
+# Checks for header files.
+
+# Checks for typedefs, structures, and compiler characteristics.
+
+dnl Use -Wall if we have gcc.
+dnl changequote(,)dnl
+if test "x$ac_cv_prog_gcc" = xyes ; then
+ CFLAGS="$CFLAGS -Wall -g"
+fi
+dnl changequote([,])dnl
+
+case "$target_os" in
+ darwin* | rhapsody*)
+ dnl Disable -Wall and -pedantic for Apple Darwin/Rhapsody.
+ dnl System headers on these systems are broken.
+ temp_CFLAGS=`echo $CFLAGS | sed "s/-Wall -pedantic//"`
+ CFLAGS=$temp_CFLAGS
+ ;;
+ linux* | solaris*)
+ SHLIB_VERSION_ARG="-Wl,--version-script=Version_script"
+ ;;
+ *)
+ ;;
+esac
+
+# Checks for library functions.
+
+dnl
+dnl Configuration tests complete -- provide summary of results.
+dnl
+
+if test $oggz_config_ok = no ; then
+
+AC_MSG_RESULT([
+**************************************************************
+
+*** $PACKAGE $VERSION: Automatic configuration FAILED.
+
+*** The file config.log has full details.
+
+*** The following required libraries are missing or
+*** misconfigured on your system:
+])
+
+if test "x$HAVE_OGG" != xyes ; then
+ AC_MSG_RESULT(
+[*** libogg, available from http://www.xiph.org/ogg/])
+fi
+if test "x$HAVE_OGG" = xmaybe ; then
+ AC_MSG_RESULT(
+[ Development files missing: The libogg library binary seems to be
+ installed, but building of a test program failed.
+])
+fi
+
+AC_MSG_RESULT(
+[*** If you install the required libraries from source, you
+*** need to inform the dynamic linker of their location. If
+*** you install them in a system-wide directory such as
+*** /usr/local (the default), you must ensure that
+*** /usr/local/lib is listed in /etc/ld.so.conf, then run
+*** ldconfig to update the dynamic linking system.
+*** Alternatively, you can set your LD_LIBRARY_PATH environment
+*** variable to include the library installation directory.
+])
+
+
+AC_MSG_RESULT(
+[**************************************************************
+])
+
+
+AC_MSG_ERROR([
+***
+*** After fixing the above problems, you must run ./configure again.
+***
+])
+
+else
+
+AC_SUBST(SHLIB_VERSION_ARG)
+AC_SUBST(SHARED_VERSION_INFO)
+
+AC_OUTPUT([
+Makefile
+doc/Makefile
+doc/Doxyfile
+include/Makefile
+include/oggz/Makefile
+src/Makefile
+src/liboggz/Version_script
+src/liboggz/Makefile
+src/tools/Makefile
+src/tests/Makefile
+src/examples/Makefile
+oggz.pc
+])
+
+AC_MSG_RESULT([
+------------------------------------------------------------------------
+ $PACKAGE $VERSION: Automatic configuration OK.
+
+ General configuration:
+
+ Experimental code: ........... ${ac_enable_experimental}
+ Reading support: ............. ${ac_enable_read}
+ Writing support: ............. ${ac_enable_write}
+
+ Installation paths:
+
+ liboggz: ..................... ${prefix}/lib
+ C header files: .............. ${prefix}/include/oggz
+ Documentation: ............... ${prefix}/share/doc/$PACKAGE
+
+ Example programs will be built but not installed.
+------------------------------------------------------------------------
+])
+
+
+fi
1,078 doc/Doxyfile.in
@@ -0,0 +1,1078 @@
+# Doxyfile 1.3.4
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project
+#
+# All text after a hash (#) is considered a comment and will be ignored
+# The format is:
+# TAG = value [value, ...]
+# For lists items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ")
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
+# by quotes) that should identify the project.
+
+PROJECT_NAME = @PACKAGE@
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER = @VERSION@
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = liboggz
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch,
+# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en
+# (Japanese with English messages), Korean, Norwegian, Polish, Portuguese,
+# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian.
+
+OUTPUT_LANGUAGE = English
+
+# This tag can be used to specify the encoding used in the generated output.
+# The encoding is not always determined by the language that is chosen,
+# but also whether or not the output is meant for Windows or non-Windows users.
+# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES
+# forces the Windows encoding (this is the default for the Windows binary),
+# whereas setting the tag to NO uses a Unix-style encoding (the default for
+# all platforms other than Windows).
+
+USE_WINDOWS_ENCODING = NO
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF = YES
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited
+# members of a class in the documentation of that class as if those members were
+# ordinary class members. Constructors, destructors and assignment operators of
+# the base classes will not be shown.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. It is allowed to use relative paths in the argument list.
+
+STRIP_FROM_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful is your file systems
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like the Qt-style comments (thus requiring an
+# explict @brief command for a brief description.
+
+JAVADOC_AUTOBRIEF = YES
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the DETAILS_AT_TOP tag is set to YES then Doxygen
+# will output the detailed description near the top, like JavaDoc.
+# If set to NO, the detailed description appears after the member
+# documentation.
+
+DETAILS_AT_TOP = YES
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# reimplements.
+
+INHERIT_DOCS = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE = 8
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources
+# only. Doxygen will then generate output that is more tailored for Java.
+# For instance, namespaces will be presented as packages, qualified scopes
+# will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
+# the \nosubgrouping command.
+
+SUBGROUPING = YES
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL = NO
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC = NO
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# users are advised to set this option to NO.
+
+CASE_SENSE_NAMES = YES
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS = YES
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or define consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and defines in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR = YES
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text.
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT = @top_srcdir@/include/oggz
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp
+# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc
+
+FILE_PATTERNS =
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories
+# that are symbolic links (a Unix filesystem feature) are excluded from the input.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories.
+
+EXCLUDE_PATTERNS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+EXAMPLE_PATH = ../COPYING ../INSTALL ../src/examples
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output.
+
+INPUT_FILTER =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES (the default)
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = YES
+
+# If the REFERENCES_RELATION tag is set to YES (the default)
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION = YES
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX = NO
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header.
+
+HTML_HEADER =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet
+
+HTML_STYLESHEET =
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS = YES
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compressed HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output dir.
+
+CHM_FILE =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND = NO
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index at
+# top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it.
+
+DISABLE_INDEX = NO
+
+# This tag can be used to set the number of enum values (range [1..20])
+# that doxygen will group on one line in the generated HTML documentation.
+
+ENUM_VALUES_PER_LINE = 4
+
+# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be
+# generated containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+,
+# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are
+# probably better off using the HTML help feature.
+
+GENERATE_TREEVIEW = NO
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH = 250
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX = YES
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, a4wide, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE = a4wide
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS = NO
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX = NO
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimised for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS = NO
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assigments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_XML = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD =
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader. This is useful
+# if you want to understand what is going on. On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_PREDEFINED tags.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# in the INCLUDE_PATH (see below) will be search if a #include is found.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed.
+
+PREDEFINED =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all function-like macros that are alone
+# on a line, have an all uppercase name, and do not end with a semicolon. Such
+# function macros are typically used for boiler-plate code, and will confuse the
+# parser if not removed.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration::addtions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles.
+# Optionally an initial location of the external documentation
+# can be added for each tagfile. The format of a tag file without
+# this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths or
+# URLs. If a location is present for each tag, the installdox tool
+# does not have to be run to correct the links.
+# Note that each tag file must have a unique name
+# (where the name does NOT include the path)
+# If a tag file is not located in the directory in which doxygen
+# is run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or
+# super classes. Setting the tag to NO turns the diagrams off. Note that this
+# option is superceded by the HAVE_DOT option below. This is only a fallback. It is
+# recommended to install and use dot, since it yields more powerful graphs.
+
+CLASS_DIAGRAMS = YES
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT = NO
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# the CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similiar to the OMG's Unified Modeling
+# Language.
+
+UML_LOOK = NO
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will
+# generate a call dependency graph for every global function or class method.
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable call graphs for selected
+# functions only using the \callgraph command.
+
+CALL_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are png, jpg, or gif
+# If left blank png will be used.
+
+DOT_IMAGE_FORMAT = png
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found on the path.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS =
+
+# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width
+# (in pixels) of the graphs generated by dot. If a graph becomes larger than
+# this value, doxygen will try to truncate the graph, so that it fits within
+# the specified constraint. Beware that most browsers cannot cope with very
+# large images.
+
+MAX_DOT_GRAPH_WIDTH = 1024
+
+# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height
+# (in pixels) of the graphs generated by dot. If a graph becomes larger than
+# this value, doxygen will try to truncate the graph, so that it fits within
+# the specified constraint. Beware that most browsers cannot cope with very
+# large images.
+
+MAX_DOT_GRAPH_HEIGHT = 1024
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes that
+# lay further from the root node will be omitted. Note that setting this option to
+# 1 or 2 may greatly reduce the computation time needed for large code bases. Also
+# note that a graph may be further truncated if the graph's image dimensions are
+# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT).
+# If 0 is used for the depth value (the default), the graph is not depth-constrained.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP = YES
+
+#---------------------------------------------------------------------------
+# Configuration::addtions related to the search engine
+#---------------------------------------------------------------------------
+
+# The SEARCHENGINE tag specifies whether or not a search engine should be
+# used. If set to NO the values of all tags below this one will be ignored.
+
+SEARCHENGINE = NO
33 doc/Makefile.am
@@ -0,0 +1,33 @@
+docdir=$(prefix)/share/doc/@PACKAGE@
+
+EXTRA_DIST = Doxyfile.in liboggz
+
+all: doxygen-build.stamp
+
+if HAVE_DOXYGEN
+doxygen-build.stamp: Doxyfile $(top_srcdir)/include/oggz/*.h
+ doxygen
+ touch doxygen-build.stamp
+else
+doxygen-build.stamp:
+ echo "*** Warning: Doxygen not found; documentation will not be built."
+ touch doxygen-build.stamp
+endif
+
+install-data-local: doxygen-build.stamp
+ $(mkinstalldirs) $(docdir)
+ if test -d liboggz; then \
+ for dir in liboggz/*; do \
+ if test -d $$dir; then \
+ b=`basename $$dir`; \
+ $(mkinstalldirs) $(docdir)/$$b; \
+ (cd $$dir && $(INSTALL_DATA) * $(docdir)/$$b) \
+ fi \
+ done \
+ fi
+
+uninstall-local:
+ rm -rf $(docdir)
+
+maintainer-clean-local:
+ if test -d liboggz; then rm -rf liboggz; fi
3  include/Makefile.am
@@ -0,0 +1,3 @@
+## Process this file with automake to produce Makefile.in
+
+SUBDIRS = oggz
6 include/oggz/Makefile.am
@@ -0,0 +1,6 @@
+## Process this file with automake to produce Makefile.in
+
+# Include files to install
+includedir = $(prefix)/include/oggz
+include_HEADERS = oggz.h oggz_constants.h
+
747 include/oggz/oggz.h
@@ -0,0 +1,747 @@
+/*
+ Copyright (C) 2003 Commonwealth Scientific and Industrial Research
+ Organisation (CSIRO) Australia
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+
+ - Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+ - Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ - Neither the name of CSIRO Australia nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+#ifndef __OGGZ_H__
+#define __OGGZ_H__
+
+#include <ogg/ogg.h>
+#include <oggz/oggz_constants.h>
+
+/** \mainpage
+ *
+ * \section intro Oggz makes programming with Ogg easy!
+ *
+ * This is the documentation for the Oggz C API. Oggz provides a simple
+ * programming interface for reading and writing Ogg files and streams.
+ * Ogg is an interleaving data container developed by Monty
+ * at <a href="http://www.xiph.org/">Xiph.Org</a>, originally to
+ * support the Ogg Vorbis audio format.
+ *
+ * liboggz supports the flexibility afforded by the Ogg file format
+ *
+ * - A simple, callback based open/read/close or open/write/close interface
+ * to all Ogg files
+ * - A customisable seeking abstraction for seeking on multitrack Ogg data
+ *
+ * \subsection contents Contents
+ *
+ * - \link basics Basics \endlink:
+ * Information about Ogg required to understand liboggz
+ *
+ * - \link oggz.h oggz.h \endlink:
+ * Documentation of the Oggz API
+ *
+ * - \link configuration Configuration \endlink:
+ * Customizing liboggz to only read or write.
+ *
+ * - \link building Building \endlink:
+ * Information related to building software that uses liboggz.
+ *
+ * \section Licensing
+ *
+ * liboggz is provided under the following BSD-style open source license:
+ *
+ * \include COPYING
+ *
+ */
+
+/** \defgroup basics Ogg basics
+ *
+ * \section Scope
+ *
+ * This section provides a minimal introduction to Ogg concepts, covering
+ * only that which is required to use liboggz.
+ *
+ * For more detailed information, see the
+ * <a href="http://www.xiph.org/ogg/">Ogg</a> homepage
+ * or IETF <a href="http://www.ietf.org/rfc/rfc3533.txt">RFC 3533</a>
+ * <i>The Ogg File Format version 0</i>.
+ *
+ * \section Terminology
+ *
+ * \subsection Bitstreams
+ *
+ * Physical bitstreams contain interleaved logical bitstreams.
+ * Each logical bitstream is uniquely identified by a serial number or
+ * \a serialno.
+ *
+ * - \a serialno: an integer identifying a logical bitstream.
+ *
+ * \subsection Packets
+ *
+ *
+ *
+ */
+
+/** \defgroup configuration Configuration
+ * \section ./configure ./configure
+ *
+ * It is possible to customize the functionality of liboggz
+ * by using various ./configure flags when
+ * building it from source. You can build a smaller
+ * version of liboggz to only read or write.
+ * By default, both reading and writing support is built.
+ *
+ * For general information about using ./configure, see the file
+ * \link install INSTALL \endlink
+ *
+ * \subsection no_encode Removing writing support
+ *
+ * Configuring with \a --disable-write will remove all support for writing:
+ * - All internal write related functions will not be built
+ * - Any attempt to call oggz_new(), oggz_open() or oggz_openfd()
+ * with \a flags == OGGZ_WRITE will fail, returning NULL
+ * - Any attempt to call oggz_write(), oggz_write_output(), oggz_write_feed(),
+ * oggz_write_set_hungry_callback(), or oggz_write_get_next_page_size()
+ * will return OGGZ_ERR_DISABLED
+ *
+ * \subsection no_decode Removing reading support
+ *
+ * Configuring with \a --disable-read will remove all support for reading:
+ * - All internal reading related functions will not be built
+ * - Any attempt to call oggz_new(), oggz_open() or oggz_openfd()
+ * with \a flags == OGGZ_READ will fail, returning NULL
+ * - Any attempt to call oggz_read(), oggz_read_input(),
+ * oggz_set_read_callback(), oggz_seek(), or oggz_seek_units() will return
+ * OGGZ_ERR_DISABLED
+ *
+ */
+
+/** \defgroup install Installation
+ * \section install INSTALL
+ *
+ * \include INSTALL
+ */
+
+/** \defgroup building Building against liboggz
+ *
+ *
+ * \section autoconf Using GNU autoconf
+ *
+ * If you are using GNU autoconf, you do not need to call pkg-config
+ * directly. Use the following macro to determine if liboggz is
+ * available:
+ *
+ <pre>
+ PKG_CHECK_MODULES(OGGZ, oggz >= 0.6.0,
+ HAVE_OGGZ="yes", HAVE_OGGZ="no")
+ if test "x$HAVE_OGGZ" = "xyes" ; then
+ AC_SUBST(OGGZ_CFLAGS)
+ AC_SUBST(OGGZ_LIBS)
+ fi
+ </pre>
+ *
+ * If liboggz is found, HAVE_OGGZ will be set to "yes", and
+ * the autoconf variables OGGZ_CFLAGS and OGGZ_LIBS will
+ * be set appropriately.
+ *
+ * \section pkg-config Determining compiler options with pkg-config
+ *
+ * If you are not using GNU autoconf in your project, you can use the
+ * pkg-config tool directly to determine the correct compiler options.
+ *
+ <pre>
+ OGGZ_CFLAGS=`pkg-config --cflags oggz`
+
+ OGGZ_LIBS=`pkg-config --libs oggz`
+ </pre>
+ *
+ */
+
+/** \file
+ * The liboggz C API.
+ *
+ * \section general Generic semantics
+ *
+ * All access is managed via an OGGZ handle. This can be instantiated
+ * in one of three ways:
+ *
+ * - oggz_open() - Open a full pathname
+ * - oggz_openfd() - Use an already opened file descriptor
+ * - oggz_new() - Create an anonymous OGGZ object, which you can later
+ * handle via memory buffers
+ *
+ * To finish using an OGGZ handle, it should be closed with oggz_close().
+ *
+ * \section reading Reading Ogg data
+ *
+ * To read from Ogg files or streams you must instantiate an OGGZ handle
+ * with flags set to OGGZ_READ, and provide an OggzReadPacket
+ * callback with oggz_set_read_callback().
+ * See the \ref read_api section for details.
+ *
+ * \section writing Writing Ogg data
+ *
+ * To write to Ogg files or streams you must instantiate an OGGZ handle
+ * with flags set to OGGZ_WRITE, and provide an OggzWritePacket
+ * callback with oggz_set_write_callback().
+ * See the \ref write_api section for details.
+ *
+ * \section headers Headers
+ *
+ * oggz.h provides direct access to libogg types such as ogg_packet, defined
+ * in <ogg/ogg.h>.
+ */
+
+/** \defgroup seeking_group Seeking
+ * \section seeking Seeking
+ *
+ * The seeking semantics of the Ogg file format were outlined by Monty in
+ * <a href="http://www.xiph.org/archives/theora-dev/200209/0040.html">a
+ * post to theora-dev</a> in September 2002. Quoting from that post, we
+ * have the following assumptions:
+ *
+ * - Ogg is not a non-linear format. ... It is a media transport format
+ * designed to do nothing more than deliver content, in a stream, and
+ * have all the pieces arrive on time and in sync.
+ * - The Ogg layer does not know the specifics of the codec data it's
+ * multiplexing into a stream. It knows nothing beyond 'Oooo, packets!',
+ * that the packets belong to different buckets, that the packets go in
+ * order, and that packets have position markers. Ogg does not even have
+ * a concept of 'time'; it only knows about the sequentially increasing,
+ * unitless position markers. It is up to higher layers which have
+ * access to the codec APIs to assign and convert units of framing or
+ * time.
+ *
+ * liboggz provides two abstractions for seeking at an arbitrary level of
+ * precision, as well as allowing seeking to a direct byte offset.
+ *
+ * To seek across non-metric spaces for which a partial order
+ * exists (ie. data that is not synchronised by a measure such as time, but
+ * is nevertheless somehow seekably structured), use an OggzOrder.
+ *
+ * For most purposes, such as media data, use an OggzMetric instead.
+ */
+
+/**
+ * An opaque handle to an Ogg file. This is returned by oggz_open() or
+ * oggz_new(), and is passed to all other oggz_* functions.
+ */
+typedef void * OGGZ;
+
+/**
+ * Create a new OGGZ object
+ * \param flags OGGZ_READ or OGGZ_WRITE
+ * \returns A new OGGZ object
+ * \retval NULL on system error; check errno for details
+ */
+OGGZ * oggz_new (int flags);
+
+/**
+ * Open an Ogg file, creating an OGGZ handle for it
+ * \param filename The file to open
+ * \param flags OGGZ_READ or OGGZ_WRITE
+ * \return A new OGGZ handle
+ * \retval NULL System error; check errno for details
+ */
+OGGZ * oggz_open (char * filename, int flags);
+
+/**
+ * Create an OGGZ handle associated with a file descriptor.
+ * \param fd An open file descriptor
+ * \param flags OGGZ_READ or OGGZ_WRITE
+ * \returns A new OGGZ handle
+ * \retval NULL System error; check errno for details
+ */
+OGGZ * oggz_openfd (int fd, int flags);
+
+/**
+ * Ensure any associated file descriptors are flushed.
+ * \param oggz An OGGZ handle
+ * \retval 0 Success
+ * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
+ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ
+ * \retval OGGZ_ERR_SYSTEM System error; check errno for details
+ */
+int oggz_flush (OGGZ * oggz);
+
+/**
+ * Close an OGGZ handle
+ * \param oggz An OGGZ handle
+ * \retval 0 Success
+ * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
+ * \retval OGGZ_ERR_SYSTEM System error; check errno for details
+ */
+int oggz_close (OGGZ * oggz);
+
+/**
+ * Determine if a given logical bitstream is at bos (beginning of stream).
+ * \param oggz An OGGZ handle
+ * \param serialno Identify a logical bitstream within \a oggz, or -1 to
+ * query if all logical bitstreams in \a oggz are at bos
+ * \retval 1 The given stream is at bos
+ * \retval 0 The given stream is not at bos
+ * \retval OGGZ_ERR_BAD_SERIALNO \a serialno does not identify an existing
+ * logical bitstream in \a oggz.
+ */
+int oggz_get_bos (OGGZ * oggz, long serialno);
+
+/**
+ * Determine if a given logical bitstream is at eos (end of stream).
+ * \param oggz An OGGZ handle
+ * \param serialno Identify a logical bitstream within \a oggz, or -1 to
+ * query if all logical bitstreams in \a oggz are at eos
+ * \retval 1 The given stream is at eos
+ * \retval 0 The given stream is not at eos
+ * \retval OGGZ_ERR_BAD_SERIALNO \a serialno does not identify an existing
+ * logical bitstream in \a oggz.
+ */
+int oggz_get_eos (OGGZ * oggz, long serialno);
+
+/** \defgroup read_api OGGZ Read API
+ *
+ * \{
+ */
+
+/**
+ * This is the signature of a callback which you must provide for Oggz
+ * to call whenever it finds a new packet in the Ogg stream associated
+ * with \a oggz.
+ *
+ * \param oggz The OGGZ handle
+ * \param op The full ogg_packet (see <ogg/ogg.h>)
+ * \param serialno Identify the logical bistream in \a oggz that contains
+ * \a op
+ * \param user_data A generic pointer you have provided earlier
+ * \returns 0 to continue, non-zero to instruct OGGZ to stop.
+ *
+ * \note It is possible to provide different callbacks per logical
+ * bitstream -- see oggz_set_read_callback() for more information.
+ */
+typedef int (*OggzReadPacket) (OGGZ * oggz, ogg_packet * op, long serialno,
+ void * user_data);
+
+/**
+ * Set a callback for Oggz to call when a new Ogg packet is found in the
+ * stream.
+ *
+ * \param oggz An OGGZ handle previously opened for reading
+ * \param serialno Identify the logical bitstream in \a oggz to attach
+ * this callback to, or -1 to attach this callback to all unattached
+ * logical bitstreams in \a oggz.
+ * \param read_packet Your callback function
+ * \param user_data Arbitrary data you wish to pass to your callback
+ * \retval 0 Success
+ * \retval OGGZ_ERR_BAD_SERIALNO \a serialno does not identify an existing
+ * logical bitstream in \a oggz.
+ * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
+ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ
+ *
+ * \note Values of \a serialno other than -1 allows you to specify different
+ * callback functions for each logical bitstream.
+ *
+ * \note It is safe to call this callback from within an OggzReadPacket
+ * function, in order to specify that subsequent packets should be handled
+ * by a different OggzReadPacket function.
+ */
+int oggz_set_read_callback (OGGZ * oggz, long serialno,
+ OggzReadPacket read_packet, void * user_data);
+
+/**
+ * Read n bytes into \a oggz, calling any read callbacks on the fly.
+ * \param oggz An OGGZ handle previously opened for reading
+ * \param n A count of bytes to ingest
+ * \retval "> 0" The number of bytes successfully ingested.
+ * \retval 0 End of file
+ * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
+ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ
+ * \retval OGGZ_ERR_SYSTEM System error; check errno for details
+ */
+long oggz_read (OGGZ * oggz, long n);
+
+/**
+ * Input data into \a oggz.
+ * \param oggz An OGGZ handle previously opened for reading
+ * \param buf A memory buffer
+ * \param n A count of bytes to input
+ * \retval "> 0" The number of bytes successfully ingested.
+ * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
+ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ
+ */
+long oggz_read_input (OGGZ * oggz, unsigned char * buf, long n);
+
+/** \}
+ */
+
+/** \defgroup write_api OGGZ Write API
+ *
+ * \{
+ */
+
+/**
+ * This is the signature of a callback which Oggz will call when \a oggz
+ * is \link hungry hungry \endlink.
+ *
+ * \param oggz The OGGZ handle
+ * \param empty A value of 1 indicates that the packet queue is currently
+ * empty. A value of 0 indicates that the packet queue is not empty.
+ * \param user_data A generic pointer you have provided earlier
+ * \retval 0 Continue
+ * \retval non-zero Instruct OGGZ to stop.
+ */
+typedef int (*OggzWriteHungry) (OGGZ * oggz, int empty, void * user_data);
+
+/**
+ * Set a callback for Oggz to call when \a oggz
+ * is \link hungry hungry \endlink.
+ *
+ * \param oggz An OGGZ handle previously opened for writing
+ * \param hungry Your callback function
+ * \param only_when_empty When to call: a value of 0 indicates that
+ * OGGZ should call \a hungry() after each and every packet is written;
+ * a value of 1 indicates that OGGZ should call \a hungry() only when
+ * its packet queue is empty
+ * \param user_data Arbitrary data you wish to pass to your callback
+ * \retval 0 Success
+ * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
+ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ
+ * \note Passing a value of 0 for \a only_when_empty allows you to feed
+ * new packets into \a oggz's packet queue on the fly.
+ */
+int oggz_write_set_hungry_callback (OGGZ * oggz,
+ OggzWriteHungry hungry,
+ int only_when_empty,
+ void * user_data);
+/**
+ * Add a packet to \a oggz's packet queue.
+ * \param oggz An OGGZ handle previously opened for writing
+ * \param op An ogg_packet with all fields filled in
+ * \param serialno Identify the logical bitstream in \a oggz to add the
+ * packet to
+ * \param flush Whether to flush this packet to the stream
+ * \param guard A guard for nocopy, NULL otherwise
+ * \retval 0 Success
+ * \retval OGGZ_ERR_BAD_GUARD \a guard specified has non-zero initialization
+ * \retval OGGZ_ERR_BOS Packet would be bos packet of a new logical bitstream,
+ * but oggz has already written one or more non-bos packets in
+ * other logical bitstreams,
+ * and \a oggz is not flagged OGGZ_NONSTRICT
+ * \retval OGGZ_ERR_EOS The logical bitstream identified by \a serialno is
+ * already at eos,
+ * and \a oggz is not flagged OGGZ_NONSTRICT
+ * \retval OGGZ_ERR_BAD_BYTES \a op->bytes is invalid,
+ * and \a oggz is not flagged OGGZ_NONSTRICT
+ * \retval OGGZ_ERR_BAD_B_O_S \a op->b_o_s is invalid,
+ * and \a oggz is not flagged OGGZ_NONSTRICT
+ * \retval OGGZ_ERR_BAD_GRANULEPOS \a op->granulepos is less than that of
+ * an earlier packet within this logical bitstream,
+ * and \a oggz is not flagged OGGZ_NONSTRICT
+ * \retval OGGZ_ERR_BAD_PACKETNO \a op->packetno is less than that of an
+ * earlier packet within this logical bitstream,
+ * and \a oggz is not flagged OGGZ_NONSTRICT
+ * \retval OGGZ_ERR_BAD_SERIALNO \a serialno does not identify an existing
+ * logical bitstream in \a oggz,
+ * and \a oggz is not flagged OGGZ_NONSTRICT
+ * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
+ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ
+ *
+ * \note If \a op->b_o_s is initialized to \a -1 before calling
+ * oggz_write_feed(), Oggz will fill it in with the appropriate
+ * value; ie. 1 for the first packet of a new stream, and 0 otherwise.
+ */
+int oggz_write_feed (OGGZ * oggz, ogg_packet * op, long serialno, int flush,
+ int * guard);
+
+/**
+ * Output data from an OGGZ handle. Oggz will call your write callback
+ * as needed.
+ *
+ * \param oggz An OGGZ handle previously opened for writing
+ * \param buf A memory buffer
+ * \param n A count of bytes to output
+ * \retval "> 0" The number of bytes successfully output
+ * \retval 0 End of stream
+ * \retval OGGZ_ERR_RECURSIVE_WRITE Attempt to initiate writing from
+ * within an OggzHungry callback
+ * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
+ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ
+ */
+long oggz_write_output (OGGZ * oggz, unsigned char * buf, long n);
+
+/**
+ * Write n bytes from an OGGZ handle. Oggz will call your write callback
+ * as needed.
+ *
+ * \param oggz An OGGZ handle previously opened for writing
+ * \param n A count of bytes to be written
+ * \retval "> 0" The number of bytes successfully output
+ * \retval 0 End of stream
+ * \retval OGGZ_ERR_RECURSIVE_WRITE Attempt to initiate writing from
+ * within an OggzHungry callback
+ * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
+ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ
+ */
+long oggz_write (OGGZ * oggz, long n);
+
+/**
+ * Query the number of bytes in the next page to be written.
+ *
+ * \param oggz An OGGZ handle previously opened for writing
+ * \retval ">= 0" The number of bytes in the next page
+ * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
+ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ
+ */
+long oggz_write_get_next_page_size (OGGZ * oggz);
+
+/** \}
+ */
+
+/** \defgroup metric OggzMetric
+ *
+ * If every position in an Ogg stream can be described by a metric (eg. time)
+ * then define this function that returns some arbitrary unit value.
+ * This is the normal use of OGGZ for media streams. The meaning of units is
+ * arbitrary, but must be consistent across all logical bitstreams; for
+ * example a conversion of the time offset of a given packet into nanoseconds
+ * or a similar stream-specific subdivision may be appropriate.
+ *
+ * To use OggzMetric:
+ *
+ * - Implement an OggzMetric callback
+ * - Set the OggzMetric callback using oggz_set_metric()
+ * - To seek, use oggz_seek_units(). Oggz will perform a ratio search
+ * through the Ogg bitstream, using the OggzMetric callback to determine
+ * its position relative to the desired unit.
+ *
+ * \note
+ *
+ * Many data streams begin with headers describing such things as codec
+ * setup parameters. One of the assumptions Monty makes is:
+ *
+ * - Given pre-cached decode headers, a player may seek into a stream at
+ * any point and begin decode.
+ *
+ * Thus, the first action taken by applications dealing with such data is
+ * to read in and cache the decode headers; thereafter the application can
+ * safely seek to arbitrary points in the data.
+ *
+ * This impacts seeking because the portion of the bitstream containing
+ * decode headers should not be considered part of the metric space. To
+ * inform Oggz not to seek earlier than the end of the decode headers,
+ * use oggz_data_begins_here().
+ *
+ * \{
+ */
+
+/**
+ * Specify that a logical bitstream has a linear metric
+ * \param oggz An OGGZ handle
+ * \param serialno Identify the logical bitstream in \a oggz to attach
+ * this linear metric to. A value of -1 indicates that the metric should
+ * be attached to all unattached logical bitstreams in \a oggz.
+ * \param granule_rate_numerator The numerator of the granule rate
+ * \param granule_rate_denominator The denominator of the granule rate
+ * \returns 0 Success
+ * \retval OGGZ_ERR_BAD_SERIALNO \a serialno does not identify an existing
+ * logical bitstream in \a oggz.
+ * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
+ */
+int oggz_set_metric_linear (OGGZ * oggz, long serialno,
+ ogg_int64_t granule_rate_numerator,
+ ogg_int64_t granule_rate_denominator);
+
+/**
+ * This is the signature of a function to correlate Ogg streams.
+ * If every position in an Ogg stream can be described by a metric (eg. time)
+ * then define this function that returns some arbitrary unit value.
+ * This is the normal use of OGGZ for media streams. The meaning of units is
+ * arbitrary, but must be consistent across all logical bitstreams; for
+ * example a conversion of the time offset of a given packet into nanoseconds
+ * or a similar stream-specific subdivision may be appropriate.
+ *
+ * \param oggz An OGGZ handle
+ * \param serialno Identifies a logical bitstream within \a oggz
+ * \param granulepos A granulepos within the logical bitstream identified
+ * by \a serialno
+ * \param user_data Arbitrary data you wish to pass to your callback
+ * \returns A conversion of the (serialno, granulepos) pair into a measure
+ * in units which is consistent across all logical bitstreams within \a oggz
+ */
+typedef ogg_int64_t (*OggzMetric) (OGGZ * oggz, long serialno,
+ ogg_int64_t granulepos, void * user_data);
+
+/**
+ * Set the OggzMetric to use for an OGGZ handle
+ *
+ * \param oggz An OGGZ handle
+ * \param serialno Identify the logical bitstream in \a oggz to attach
+ * this metric to. A value of -1 indicates that this metric
+ * should be attached to all unattached logical bitstreams
+ * in \a oggz.
+ * \param metric An OggzMetric callback
+ * \param user_data arbitrary data to pass to the metric callback
+ *
+ * \returns 0 Success
+ * \retval OGGZ_ERR_BAD_SERIALNO \a serialno does not identify an existing
+ * logical bitstream in \a oggz, and is not -1
+ * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
+ *
+ * \note Specifying values of \a serialno other than -1 allows you to pass
+ * logical bitstream specific user_data to the same metric.
+ * \note Alternatively, you may use a different \a metric for each
+ * \a serialno, but all metrics used must return mutually consistent
+ * unit measurements.
+ */
+int oggz_set_metric (OGGZ * oggz, long serialno, OggzMetric metric,
+ void * user_data);
+
+/**
+ * Seek to a number of units corresponding to the Metric function
+ * \param oggz An OGGZ handle
+ * \param units A number of units
+ * \param whence As defined in <stdio.h>: SEEK_SET, SEEK_CUR or SEEK_END
+ * \returns the new file offset, or -1 on failure.
+ */
+ogg_int64_t oggz_seek_units (OGGZ * oggz, ogg_int64_t units, int whence);
+
+/** \}
+ */
+
+#ifdef _UNIMPLEMENTED
+/** \defgroup order OggzOrder
+ *
+ * \subsection OggzOrder
+ *
+ * Suppose there is a partial order < and a corresponding equivalence
+ * relation = defined on the space of packets in the Ogg stream of 'OGGZ'.
+ * An OggzOrder simply provides a comparison in terms of '<' and '=' for
+ * ogg_packets against a target.
+ *
+ * To use OggzOrder:
+ *
+ * - Implement an OggzOrder callback
+ * - Set the OggzOrder callback for an OGGZ handle with oggz_set_order()
+ * - To seek, use oggz_seek_byorder(). Oggz will use a combination bisection
+ * search and scan of the Ogg bitstream, using the OggzOrder callback to
+ * match against the desired 'target'.
+ *
+ * Otherwise, for more general ogg streams for which a partial order can be
+ * defined, define a function matching this specification.
+ *
+ * Parameters:
+ *
+ * OGGZ: the OGGZ object
+ * op: an ogg packet in the stream
+ * target: a user defined object
+ *
+ * Return values:
+ *
+ * -1 , if 'op' would occur before the position represented by 'target'
+ * 0 , if the position of 'op' is equivalent to that of 'target'
+ * 1 , if 'op' would occur after the position represented by 'target'
+ * 2 , if the relationship between 'op' and 'target' is undefined.
+ *
+ * Symbolically:
+ *
+ * Suppose there is a partial order < and a corresponding equivalence
+ * relation = defined on the space of packets in the Ogg stream of 'OGGZ'.
+ * Let p represent the position of the packet 'op', and t be the position
+ * represented by 'target'.
+ *
+ * Then a function implementing OggzPacketOrder should return as follows:
+ *
+ * -1 , p < t
+ * 0 , p = t
+ * 1 , t < p
+ * 2 , otherwise
+ *
+ * Hacker's hint: if there are no circumstances in which you would return
+ * a value of 2, there is a linear order; it may be possible to define a
+ * Metric rather than an Order.
+ * \{
+ */
+typedef int (*OggzOrder) (OGGZ * oggz, ogg_packet * op, void * target,
+ void * user_data);
+/**
+ * \retval 0 Success
+ * \retval OGGZ_ERR_BAD_OGGZ \a oggz does not refer to an existing OGGZ
+ * \retval OGGZ_ERR_INVALID Operation not suitable for this OGGZ
+ */
+int oggz_set_order (OGGZ * oggz, long serialno, OggzOrder order,
+ void * user_data);
+
+long oggz_seek_byorder (OGGZ * oggz, void * target);
+
+/** \}
+ */
+#endif /* _UNIMPLEMENTED */
+
+/**
+ * Tell OGGZ that we're past the headers, to remember the current packet
+ * as the start of data.
+ * This informs the seeking mechanism that when seeking back to unit 0,
+ * go to the packet we're on now, not to the start of the file, which
+ * is usually codec headers.
+ * \param oggz An OGGZ handle previously opened for reading
+ * \returns 0 on success, -1 on failure.
+ */
+int oggz_data_begins_here (OGGZ * oggz);
+
+/**
+ * Provide the file offset in bytes corresponding to the data read.
+ * \param oggz An OGGZ handle
+ * \returns The current offset of oggz.
+ *
+ * \note When reading, the value returned by oggz_tell() reflects the
+ * data offset of the start of the most recent packet processed, so that
+ * when called from an OggzReadPacket callback it reflects the byte
+ * offset of the start of the packet. As OGGZ may have internally read
+ * ahead, this may differ from the current offset of the associated file
+ * descriptor.
+ */
+off_t oggz_tell (OGGZ * oggz);
+
+/**
+ * Seek to a specific bytes offset
+ * \param oggz An OGGZ handle
+ * \param offset a byte offset
+ * \param whence As defined in <stdio.h>: SEEK_SET, SEEK_CUR or SEEK_END
+ * \returns the new file offset, or -1 on failure.
+ */
+off_t oggz_seek (OGGZ * oggz, off_t offset, int whence);
+
+#ifdef _UNIMPLEMENTED
+long oggz_seek_packets (OGGZ * oggz, long serialno, long packets, int whence);
+#endif
+
+
+/**
+ * Request a new serialno, as required for a new stream, ensuring the serialno
+ * is not yet used for any other streams managed by this OGGZ.
+ * \param oggz An OGGZ handle
+ * \returns A new serialno, not already occuring in any logical bitstreams
+ * in \a oggz.
+ */
+long oggz_serialno_new (OGGZ * oggz);
+
+
+#endif /* __OGGZ_H__ */
123 include/oggz/oggz_constants.h
@@ -0,0 +1,123 @@
+/*
+ Copyright (C) 2003 Commonwealth Scientific and Industrial Research
+ Organisation (CSIRO) Australia
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+
+ - Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+ - Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ - Neither the name of CSIRO Australia nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+#ifndef __OGGZ_CONSTANTS_H__
+#define __OGGZ_CONSTANTS_H__
+
+/** \file
+ * General constants used by liboggz.
+ */
+
+/**
+ * Flags to oggz_new(), oggz_open(), and oggz_openfd().
+ */
+enum OggzFlags {
+ /** Read only */
+ OGGZ_READ = 0x00,
+
+ /** Write only */
+ OGGZ_WRITE = 0x01,
+
+ /** Disable strict adherence to mapping constraints, eg for
+ * handling an incomplete stream */
+ OGGZ_NONSTRICT = 0x10
+};
+
+/**
+ * Flush options for oggz_write_feed; can be or'ed together
+ */
+enum OggzFlushOpts {
+ /** Flush all streams before beginning this packet */
+ OGGZ_FLUSH_BEFORE = 0x01,
+
+ /** Flush after this packet */
+ OGGZ_FLUSH_AFTER = 0x02
+};
+
+/**
+ * Definitions of error return values
+ */
+enum OggzError {
+ /** No error */
+ OGGZ_ERR_OK = 0,
+
+ /** generic error */
+ OGGZ_ERR_GENERIC = -1,
+
+ /** oggz is not a valid OGGZ */
+ OGGZ_ERR_BAD_OGGZ = -2,
+
+ /** The requested operation is not suitable for this OGGZ */
+ OGGZ_ERR_INVALID = -3,
+
+ /** oggz contains no logical bitstreams */
+ OGGZ_ERR_NO_STREAMS = -4,
+
+ /** Operation is inappropriate for oggz in current bos state */
+ OGGZ_ERR_BOS = -5,
+
+ /** Operation is inappropriate for oggz in current eos state */
+ OGGZ_ERR_EOS = -6,
+
+ /** System specific error; check errno for details */
+ OGGZ_ERR_SYSTEM = -10,
+
+ /** Functionality disabled at build time */
+ OGGZ_ERR_DISABLED = -11,
+
+ /** The requested serialno does not exist in this OGGZ */
+ OGGZ_ERR_BAD_SERIALNO = -20,
+
+ /** Packet disallowed due to invalid byte length */
+ OGGZ_ERR_BAD_BYTES = -21,
+
+ /** Packet disallowed due to invalid b_o_s (beginning of stream) flag */
+ OGGZ_ERR_BAD_B_O_S = -22,
+
+ /** Packet disallowed due to invalid e_o_s (end of stream) flag */
+ OGGZ_ERR_BAD_E_O_S = -23,
+
+ /** Packet disallowed due to invalid granulepos */
+ OGGZ_ERR_BAD_GRANULEPOS = -24,
+
+ /** Packet disallowed due to invalid packetno */
+ OGGZ_ERR_BAD_PACKETNO = -25,
+
+ /** Guard provided by user has non-zero value */
+ OGGZ_ERR_BAD_GUARD = -210,
+
+ /** Attempt to call oggz_write() or oggz_write_output() from within
+ * a hungry() callback */
+ OGGZ_ERR_RECURSIVE_WRITE = -266
+};
+
+#endif /* __OGGZ_CONSTANTS_H__ */
11 oggz.pc.in
@@ -0,0 +1,11 @@
+prefix=@prefix@
+exec_prefix=@exec_prefix@
+libdir=@libdir@
+includedir=@includedir@
+
+Name: oggz
+Description: A library for reading and writing Ogg encapsulated data.
+Requires:
+Version: @VERSION@
+Libs: -L${libdir} -loggz -logg
+Cflags: -I${includedir}
3  src/Makefile.am
@@ -0,0 +1,3 @@
+## Process this file with automake to produce Makefile.in
+
+SUBDIRS = liboggz tools tests examples
27 src/examples/Makefile.am
@@ -0,0 +1,27 @@
+## Process this file with automake to produce Makefile.in
+
+AM_CFLAGS = -Wall -pedantic -g
+
+INCLUDES = -I$(top_srcdir)/include
+
+OGGZDIR = ../liboggz
+OGGZ_LIBS = $(OGGZDIR)/liboggz.la @OGG_LIBS@
+
+if OGGZ_CONFIG_READ
+if OGGZ_CONFIG_WRITE
+oggz_rw_programs = identity
+endif
+endif
+
+if OGGZ_CONFIG_READ
+oggz_read_programs = read-file
+endif
+
+# Programs to build
+noinst_PROGRAMS = $(oggz_rw_programs) $(oggz_read_programs)
+
+identity_SOURCES = identity.c
+identity_LDADD = $(OGGZ_LIBS)
+
+read_file_SOURCES = read-file.c
+read_file_LDADD = $(OGGZ_LIBS)
95 src/examples/identity.c
@@ -0,0 +1,95 @@
+/*
+ Copyright (C) 2003 Commonwealth Scientific and Industrial Research
+ Organisation (CSIRO) Australia
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+
+ - Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+
+ - Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ - Neither the name of CSIRO Australia nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,