1 ********************************************************************
3 * THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. *
4 * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS *
5 * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
6 * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
8 * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001 *
9 * by the XIPHOPHORUS Company http://www.xiph.org/ *
11 ********************************************************************
15 If you're used to the source distribution from the first two beta
16 releases, things are now rearranged a bit. Specifically, the
17 'vorbis' CVS module contains only the libvorbis, libvorbisfile, and
18 libvorbisenc libraries. Because Ogg bitstreams are to be used by other
19 Ogg codecs, Ogg framing and streaming functionality is now in libogg
20 (the 'ogg' CVS module). Vorbis utilities are in 'vorbis-tools' and various
21 player plugins are in 'vorbis-plugins'. For now, you'll need to check
22 out these other modules seperately. (Note: the xmms plugin is in the xmms
23 CVS tree in xmms/Input/vorbis.)
25 Secondly, the Ogg/Vorbis build systems now use automake. Instead of
26 './configure; make', the proper build sequence (in each module) is
29 You will also need the newest versions of autoconf, automake, and libtool
30 in order to compile vorbis from CVS. configure scripts are provided for you
31 in tarball distributions.
35 This source distribution includes libvorbis and an example
36 encoder/player to demonstrate use of libvorbis and documentation on
37 the Ogg Vorbis audio coding format.
41 ./lib The source for the libraries, a BSD-license implementation
42 of the public domain Ogg Vorbis audio encoding format.
44 ./include Library API headers
46 ./debian Rules/spec files for building Debian .deb packages
48 ./doc Vorbis documentation
50 ./examples Example code illustrating programmatic use of libvorbis,
51 libvorbisfile and libvorbisenc
53 ./mac Codewarrior project files and build tweaks for MacOS.
55 ./win32 Win32 projects files and build automation
57 ./vq Internal utilities for training/building new LSP/residue
58 and auxiliary codebooks.
62 Vorbis is a general purpose audio and music encoding format
63 contemporary to MPEG-4's AAC and TwinVQ, the next generation beyond
64 MPEG audio layer 3. Unlike the MPEG sponsored formats (and other
65 proprietary formats such as RealAudio G2 and Windows' flavor of the
66 month), the Vorbis CODEC specification belongs to the public domain.
67 All the technical details are published and documented, and any
68 software entity may make full use of the format without royalty or
71 This package contains:
73 .) libvorbis, a BSD-license software implementation of
74 the Vorbis specification by the Xiphophorus company
75 (http://www.xiph.org/)
77 .) libvorbisfile, a BSD-license convenience library
78 built on Vorbis designed to simplify common uses and a number of GPL
81 .) libvorbisenc, a BSD-license library that provides a simple, programmatic
82 encoding setup interface
84 .) example code making use of libogg, libvorbis, libvorbisfile and
89 The Ogg homepage is located at 'http://www.xiph.org/ogg/'.
90 Vorbis's homepage is located at 'http://www.xiph.org/ogg/vorbis/'.
91 Up to date technical documents, contact information, source code and
92 pre-built utilities may be found there.
99 and as root if desired:
103 This will install the vorbis libraries (static and shared) into
104 /usr/local/lib, includes into /usr/local/include and API manpages
105 (once we write some) into /usr/local/man.
107 BUILDING FROM TARBALL DISTRIBUTIONS:
112 and optionally (as root):
117 after normal configuring:
120 rpm -ta libvorbis-<version>.tar.gz
124 Vorbis on MacOS 9 is built using CodeWarrior 5.3. To build it, first
125 verify that the Ogg libraries are already built following the
126 instructions in the Ogg module README. Open vorbis/mac/libvorbis.mcp,
127 switch to the "Targets" pane, select everything, and make the project.
128 Do the same thing to build libvorbisenc.mcp, and libvorbisfile.mcp (in
129 that order). In vorbis/mac/Output you will now have both debug and final
130 versions of Vorbis shared libraries to link your projects against.
132 To build a project using Ogg Vorbis, add access paths to your
133 CodeWarrior project for the ogg/include, ogg/mac/Output,
134 vorbis/include, and vorbis/mac/Output folders. Be sure that
135 "interpret DOS and Unix paths" is turned on in your project; it can
136 be found in the "access paths" pane in your project settings. Now
137 simply add the shared libraries you need to your project (OggLib and
138 VorbisLib at least) and #include "ogg/ogg.h" and "vorbis/codec.h"
139 wherever you need to access Ogg and Vorbis functionality.
142 $Id: README,v 1.11 2001/03/22 01:33:20 segher Exp $