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