+++ /dev/null
-Note that these instructions are *not* necessary for distribution
-tarballs; they have separate configure/build instructions.
-
-Building this package from CVS is mainly intended for developers.
-General users should obtain official distribution packages; both
-source and binary distributions are available at
-http://www.vorbis.com/.
-
------
-
-These are *brief* instructions on how to build this package from CVS.
-Yes, there are details left out.
-
-There are generally four steps necessary when building from CVS (i.e.,
-a developer's copy):
-
-1. cvs checkout of the sources, or cvs update. RTFM from your
- favorite flavor of CVS documentation; information on the xiph.org
- CVS repository can be found at http://www.xiph.org/cvs.html.
-
-2. [re-]generate files such as "configure" and "Makefile.in" with the
- GNU autoconf/automake tools. Run the "autogen.sh" script to
- perform this step.
-
- *** IF YOU ARE NOT BUILDING WITH GNU MAKE *AND* GCC: you must set
- the AUTOMAKE_FLAGS environment variable to "--include-deps"
- before running autogen.sh. For example:
-
- csh% setenv AUTOMAKE_FLAGS --include-deps
- csh% ./autogen.sh
- or
- sh% AUTOMAKE_FLAGS=--include-deps ./autogen.sh
-
-3. Run configure. There are several options available; see
- "./configure --help" for more information.
-
-4. Run "make" to build the source.
-
-In general, steps 2 and 3 need to be re-run every time any of the
-following files are modified (either manually or by a cvs update):
-
- configure.in
- acinclude.m4
-
-Running "make clean" after running steps 2 and 3 is generally also
-advisable before running step 4. It isn't *always* necessary, but
-unless you understand the workings of autoconf/automake, it's safest
-to just do it.
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
-* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002 *
+* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2004 *
* by the Xiph.org Foundation, http://www.xiph.org/ *
* *
********************************************************************
-NEW AND IMPORTANT:
+Vorbis is a general purpose audio and music encoding format
+contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond
+MPEG audio layer 3. Unlike the MPEG sponsored formats (and other
+proprietary formats such as RealAudio G2 and Windows' flavor of the
+month), the Vorbis CODEC specification belongs to the public domain.
+All the technical details are published and documented, and any
+software entity may make full use of the format without license
+fee, royalty or patent concerns.
-If you're used to the source distribution from the first two beta
-releases, things are now rearranged a bit. Specifically, the
-'vorbis' CVS module contains only the libvorbis, libvorbisfile, and
-libvorbisenc libraries. Because Ogg bitstreams are to be used by other
-Ogg codecs, Ogg framing and streaming functionality is now in libogg
-(the 'ogg' CVS module). Vorbis utilities are in 'vorbis-tools' and various
-player plugins are in 'vorbis-plugins'. For now, you'll need to check
-out these other modules seperately. (Note: the xmms plugin is in the xmms
-CVS tree in xmms/Input/vorbis.)
+This package contains:
-Secondly, the Ogg/Vorbis build systems now use automake. Instead of
-'./configure; make', the proper build sequence (in each module) is
-'./autogen.sh; make'.
+* libvorbis, a BSD-style license software implementation of
+ the Vorbis specification by the Xiph.Org Foundation
+ (http://www.xiph.org/)
-You will also need the newest versions of autoconf, automake, and libtool
-in order to compile vorbis from CVS. configure scripts are provided for you
-in tarball distributions.
+* libvorbisfile, a BSD-style license convenience library
+ built on Vorbis designed to simplify common uses
+
+* libvorbisenc, a BSD-style license library that provides a simple,
+ programmatic encoding setup interface
+
+* example code making use of libogg, libvorbis, libvorbisfile and
+ libvorbisenc
WHAT'S HERE:
This source distribution includes libvorbis and an example
-encoder/player to demonstrate use of libvorbis and documentation on
-the Ogg Vorbis audio coding format.
+encoder/player to demonstrate use of libvorbis as well as
+documentation on the Ogg Vorbis audio coding format.
+
+You'll need libogg (distributed separately) to compile this library.
+A more comprehensive set of utilities is available in the vorbis-tools
+package.
Directory:
./vq Internal utilities for training/building new LSP/residue
and auxiliary codebooks.
-WHAT IS VORBIS:
-
-Vorbis is a general purpose audio and music encoding format
-contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond
-MPEG audio layer 3. Unlike the MPEG sponsored formats (and other
-proprietary formats such as RealAudio G2 and Windows' flavor of the
-month), the Vorbis CODEC specification belongs to the public domain.
-All the technical details are published and documented, and any
-software entity may make full use of the format without royalty or
-patent concerns.
-
-This package contains:
-
-.) libvorbis, a BSD-style license software implementation of
-the Vorbis specification by the Xiph.Org Foundation (http://www.xiph.org/)
-
-.) libvorbisfile, a BSD-style license convenience library
-built on Vorbis designed to simplify common uses and a number of GPL
-example programs
-
-.) libvorbisenc, a BSD-style license library that provides a simple,
-programmatic encoding setup interface
-
-.) example code making use of libogg, libvorbis, libvorbisfile and
-libvorbisenc
-
CONTACT:
The Ogg homepage is located at 'http://www.xiph.org/ogg/'.
Up to date technical documents, contact information, source code and
pre-built utilities may be found there.
-BUILDING FROM CVS:
+BUILDING FROM TRUNK:
+
+Development source is under subversion revision control at
+http://svn.xiph.org/trunk/vorbis/. You will also need the
+newest versions of autoconf, automake, and libtool in order
+to compile vorbis from development source. A configure script
+is provided for you in the source tarball distributions.
-./autogen.sh
-make
+ [update or checkout latest source]
+ ./autogen.sh
+ make
and as root if desired:
-make install
+ make install
This will install the vorbis libraries (static and shared) into
/usr/local/lib, includes into /usr/local/include and API manpages
BUILDING FROM TARBALL DISTRIBUTIONS:
-./configure
-make
+ ./configure
+ make
and optionally (as root):
-make install
+ make install
BUILDING RPMS:
after normal configuring:
-make dist
-rpm -ta libvorbis-<version>.tar.gz
+ make dist
+ rpm -ta libvorbis-<version>.tar.gz
BUILDING ON MACOS 9:
-Vorbis on MacOS 9 is built using CodeWarrior 5.3. To build it, first
-verify that the Ogg libraries are already built following the
+Vorbis on MacOS 9 is built using Metroworks CodeWarrior. To build it,
+first verify that the Ogg libraries are already built following the
instructions in the Ogg module README. Open vorbis/mac/libvorbis.mcp,
switch to the "Targets" pane, select everything, and make the project.
Do the same thing to build libvorbisenc.mcp, and libvorbisfile.mcp (in
simply add the shared libraries you need to your project (OggLib and
VorbisLib at least) and #include "ogg/ogg.h" and "vorbis/codec.h"
wherever you need to access Ogg and Vorbis functionality.
+
projects / platform / upstream / libvorbis.git / commitdiff