README 5.09 KB
Newer Older
Mike Whitson's avatar
Mike Whitson committed
1 2
********************************************************************
*                                                                  *
Monty's avatar
 
Monty committed
3 4 5 6
* THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE.   *
* USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS     *
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING.       *
Mike Whitson's avatar
Mike Whitson committed
7
*                                                                  *
Monty's avatar
 
Monty committed
8 9
* THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2001             *
* by the XIPHOPHORUS Company http://www.xiph.org/                  *
Mike Whitson's avatar
Mike Whitson committed
10 11 12
*                                                                  *
********************************************************************

Monty's avatar
 
Monty committed
13 14 15
NEW AND IMPORTANT:

If you're used to the source distribution from the first two beta
Segher Boessenkool's avatar
Segher Boessenkool committed
16
releases, things are now rearranged a bit.  Specifically, the
Jack Moffitt's avatar
Jack Moffitt committed
17 18 19 20
'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
Monty's avatar
 
Monty committed
21
player plugins are in 'vorbis-plugins'.  For now, you'll need to check
Jack Moffitt's avatar
Jack Moffitt committed
22 23
out these other modules seperately. (Note: the xmms plugin is in the xmms
CVS tree in xmms/Input/vorbis.)
Monty's avatar
 
Monty committed
24 25

Secondly, the Ogg/Vorbis build systems now use automake.  Instead of
Jack Moffitt's avatar
Jack Moffitt committed
26 27 28 29 30 31
'./configure; make', the proper build sequence (in each module) is
'./autogen.sh; make'.

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.
Monty's avatar
 
Monty committed
32

Mike Whitson's avatar
Mike Whitson committed
33 34
WHAT'S HERE:

Monty's avatar
 
Monty committed
35
This source distribution includes libvorbis and an example
Mike Whitson's avatar
Mike Whitson committed
36 37 38 39 40
encoder/player to demonstrate use of libvorbis and documentation on
the Ogg Vorbis audio coding format.

Directory:

Segher Boessenkool's avatar
Segher Boessenkool committed
41 42
./lib  		The source for the libraries, a BSD-license implementation
		of the public domain Ogg Vorbis audio encoding format.
Mike Whitson's avatar
Mike Whitson committed
43

Jack Moffitt's avatar
Jack Moffitt committed
44
./include       Library API headers
Monty's avatar
 
Monty committed
45 46 47

./debian        Rules/spec files for building Debian .deb packages

Jack Moffitt's avatar
Jack Moffitt committed
48
./doc           Vorbis documentation
Monty's avatar
 
Monty committed
49

Jack Moffitt's avatar
Jack Moffitt committed
50 51
./examples	Example code illustrating programmatic use of libvorbis, 
		libvorbisfile and libvorbisenc
Mike Whitson's avatar
Mike Whitson committed
52

Monty's avatar
 
Monty committed
53 54
./mac 		Codewarrior project files and build tweaks for MacOS.

Jack Moffitt's avatar
Jack Moffitt committed
55
./win32		Win32 projects files and build automation
Monty's avatar
 
Monty committed
56 57 58

./vq 		Internal utilities for training/building new LSP/residue 
		and auxiliary codebooks.
Mike Whitson's avatar
Mike Whitson committed
59 60 61 62 63 64 65 66 67 68 69 70

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.

Monty's avatar
 
Monty committed
71 72
This package contains:

Monty's avatar
 
Monty committed
73
.) libvorbis, a BSD-license software implementation of
Monty's avatar
 
Monty committed
74
the Vorbis specification by the Xiphophorus company
Monty's avatar
 
Monty committed
75 76
(http://www.xiph.org/) 

Monty's avatar
 
Monty committed
77
.) libvorbisfile, a BSD-license convenience library
Monty's avatar
 
Monty committed
78
built on Vorbis designed to simplify common uses and a number of GPL
Monty's avatar
 
Monty committed
79 80
example programs

Monty's avatar
 
Monty committed
81
.) libvorbisenc, a BSD-license library that provides a simple, programmatic
Monty's avatar
 
Monty committed
82 83 84 85
encoding setup interface 

.) example code making use of libogg, libvorbis, libvorbisfile and
libvorbisenc
Mike Whitson's avatar
Mike Whitson committed
86 87 88

CONTACT:

Jack Moffitt's avatar
Jack Moffitt committed
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/'.
Mike Whitson's avatar
Mike Whitson committed
91 92 93
Up to date technical documents, contact information, source code and
pre-built utilities may be found there.

Jack Moffitt's avatar
Jack Moffitt committed
94
BUILDING FROM CVS:
Mike Whitson's avatar
Mike Whitson committed
95

Monty's avatar
 
Monty committed
96
./autogen.sh
Monty's avatar
 
Monty committed
97
make 
Mike Whitson's avatar
Mike Whitson committed
98

Jack Moffitt's avatar
Jack Moffitt committed
99
and as root if desired:
Mike Whitson's avatar
Mike Whitson committed
100

Monty's avatar
 
Monty committed
101
make install
Mike Whitson's avatar
Mike Whitson committed
102

Monty's avatar
 
Monty committed
103 104 105
This will install the vorbis libraries (static and shared) into
/usr/local/lib, includes into /usr/local/include and API manpages
(once we write some) into /usr/local/man.
Mike Whitson's avatar
Mike Whitson committed
106

Jack Moffitt's avatar
Jack Moffitt committed
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
BUILDING FROM TARBALL DISTRIBUTIONS:

./configure
make

and optionally (as root):
make install

BUILDING RPMS:

after normal configuring:

make dist
rpm -ta libvorbis-<version>.tar.gz

Monty's avatar
 
Monty committed
122 123 124 125 126 127 128
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
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
Segher Boessenkool's avatar
Segher Boessenkool committed
129
that order).  In vorbis/mac/Output you will now have both debug and final
Monty's avatar
 
Monty committed
130 131 132 133 134 135 136 137 138
versions of Vorbis shared libraries to link your projects against.

To build a project using Ogg Vorbis, add access paths to your
CodeWarrior project for the ogg/include, ogg/mac/Output,
vorbis/include, and vorbis/mac/Output folders.  Be sure that
"interpret DOS and Unix paths" is turned on in your project; it can
be found in the "access paths" pane in your project settings.  Now
simply add the shared libraries you need to your project (OggLib and
VorbisLib at least) and #include "ogg/ogg.h" and "vorbis/codec.h"
Segher Boessenkool's avatar
Segher Boessenkool committed
139
wherever you need to access Ogg and Vorbis functionality.
Monty's avatar
 
Monty committed
140 141


Segher Boessenkool's avatar
Segher Boessenkool committed
142
$Id: README,v 1.11 2001/03/22 01:33:20 segher Exp $