Commit 8bb668dc authored by andre's avatar andre

Initial revision


git-svn-id: http://svn.annodex.net/liboggz/trunk@343 8158c8cd-e7e1-0310-9fa4-c5954c97daef
parents
Conrad Parker <conrad@metadecks.org>
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.
Thu Oct 16 21:55:07 EST 2003 Conrad Parker <conrad@annodex.net>
* split liboggz out from libannodex sources, started ChangeLog
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.
## 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
#!/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 "$@"
# 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
This diff is collapsed.
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
## Process this file with automake to produce Makefile.in
SUBDIRS = oggz
## Process this file with automake to produce Makefile.in
# Include files to install
includedir = $(prefix)/include/oggz
include_HEADERS = oggz.h oggz_constants.h
This diff is collapsed.
/*
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__ */
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}
## Process this file with automake to produce Makefile.in
SUBDIRS = liboggz tools tests examples
## 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)
/*
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: