]> git.jsancho.org Git - lugaru.git/blob - libvorbis-1.0.1/README
Fixed keyboard input AGAIN.
[lugaru.git] / libvorbis-1.0.1 / README
1 ********************************************************************
2 *                                                                  *
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.       *
7 *                                                                  *
8 * THE OggVorbis SOURCE CODE IS (C) COPYRIGHT 1994-2002             *
9 * by the Xiph.org Foundation, http://www.xiph.org/                 *
10 *                                                                  *
11 ********************************************************************
12
13 NEW AND IMPORTANT:
14
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.)
24
25 Secondly, the Ogg/Vorbis build systems now use automake.  Instead of
26 './configure; make', the proper build sequence (in each module) is
27 './autogen.sh; make'.
28
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.
32
33 WHAT'S HERE:
34
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.
38
39 Directory:
40
41 ./lib           The source for the libraries, a BSD-license implementation
42                 of the public domain Ogg Vorbis audio encoding format.
43
44 ./include       Library API headers
45
46 ./debian        Rules/spec files for building Debian .deb packages
47
48 ./doc           Vorbis documentation
49
50 ./examples      Example code illustrating programmatic use of libvorbis, 
51                 libvorbisfile and libvorbisenc
52
53 ./mac           Codewarrior project files and build tweaks for MacOS.
54
55 ./macosx        Project files for MacOS X.
56
57 ./win32         Win32 projects files and build automation
58
59 ./vq            Internal utilities for training/building new LSP/residue 
60                 and auxiliary codebooks.
61
62 WHAT IS VORBIS:
63
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
71 patent concerns.
72
73 This package contains:
74
75 .) libvorbis, a BSD-style license software implementation of
76 the Vorbis specification by the Xiph.Org Foundation (http://www.xiph.org/) 
77
78 .) libvorbisfile, a BSD-style license convenience library
79 built on Vorbis designed to simplify common uses and a number of GPL
80 example programs
81
82 .) libvorbisenc, a BSD-style license library that provides a simple,
83 programmatic encoding setup interface 
84
85 .) example code making use of libogg, libvorbis, libvorbisfile and
86 libvorbisenc
87
88 CONTACT:
89
90 The Ogg homepage is located at 'http://www.xiph.org/ogg/'.
91 Vorbis's homepage is located at 'http://www.xiph.org/ogg/vorbis/'.
92 Up to date technical documents, contact information, source code and
93 pre-built utilities may be found there.
94
95 BUILDING FROM CVS:
96
97 ./autogen.sh
98 make 
99
100 and as root if desired:
101
102 make install
103
104 This will install the vorbis libraries (static and shared) into
105 /usr/local/lib, includes into /usr/local/include and API manpages
106 (once we write some) into /usr/local/man.
107
108 BUILDING FROM TARBALL DISTRIBUTIONS:
109
110 ./configure
111 make
112
113 and optionally (as root):
114 make install
115
116 BUILDING RPMS:
117
118 after normal configuring:
119
120 make dist
121 rpm -ta libvorbis-<version>.tar.gz
122
123 BUILDING ON MACOS 9:
124
125 Vorbis on MacOS 9 is built using CodeWarrior 5.3.  To build it, first
126 verify that the Ogg libraries are already built following the
127 instructions in the Ogg module README.  Open vorbis/mac/libvorbis.mcp,
128 switch to the "Targets" pane, select everything, and make the project.
129 Do the same thing to build libvorbisenc.mcp, and libvorbisfile.mcp (in
130 that order).  In vorbis/mac/Output you will now have both debug and final
131 versions of Vorbis shared libraries to link your projects against.
132
133 To build a project using Ogg Vorbis, add access paths to your
134 CodeWarrior project for the ogg/include, ogg/mac/Output,
135 vorbis/include, and vorbis/mac/Output folders.  Be sure that
136 "interpret DOS and Unix paths" is turned on in your project; it can
137 be found in the "access paths" pane in your project settings.  Now
138 simply add the shared libraries you need to your project (OggLib and
139 VorbisLib at least) and #include "ogg/ogg.h" and "vorbis/codec.h"
140 wherever you need to access Ogg and Vorbis functionality.