minor comments
[flac.git] / README
1 /* FLAC - Free Lossless Audio Codec
2  * Copyright (C) 2001,2002  Josh Coalson
3  *
4  * This program is part of FLAC; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
17  */
18
19
20 FLAC (http://flac.sourceforge.net/) is an Open Source lossless audio
21 codec developed by Josh Coalson.
22
23 FLAC is comprised of
24   * `libFLAC', a library which implements reference encoders and
25     decoders, and a metadata interface
26   * `libFLAC++', a C++ object wrapper library around libFLAC
27   * `libOggFLAC' and `libOggFLAC++', which provide encoders and
28     decoders for FLAC streams in an Ogg container
29   * `flac', a command-line program for encoding and decoding files
30   * `metaflac', a command-line program for editing FLAC metadata
31   * player plugins for XMMS and Winamp
32   * user and API documentation
33
34 The libraries (libFLAC, libFLAC++, libOggFLAC, and libOggFLAC++) are
35 licensed under the GNU Lesser General Public License (LGPL).  All other
36 programs and plugins are licensed under the GNU General Public License
37 (GPL).  The documentation is licensed under the GNU Free Documentation
38 License (GFDL).
39
40
41 ===============================================================================
42 FLAC - 1.0.4 - Contents
43 ===============================================================================
44
45 - Introduction
46 - Building in a GNU environment
47 - Building with Makefile.lite
48 - Building with MSVC
49 - Building on Mac OS X
50 - Note to embedded developers
51
52
53 ===============================================================================
54 Introduction
55 ===============================================================================
56
57 This is the source release for the FLAC project.  See
58
59         doc/index.html
60
61 for full documentation.
62
63 A brief description of the directory tree:
64
65         doc/          the HTML documentation
66         flac.pbproj/  the Mac OS X Project Builder project
67         include/      public include files for libFLAC and libFLAC++
68         man/          the man page for `flac'
69         src/          the source code and private headers
70         test/         the test scripts
71
72
73 ===============================================================================
74 Building in a GNU environment
75 ===============================================================================
76
77 FLAC uses autoconf and libtool for configuring and building.
78 Better documentation for these will be forthcoming, but in
79 general, this should work:
80
81 ./configure && make && make check && make install
82
83 The 'make check' step is optional; omit it to skip all the tests,
84 which can take several hours.
85
86 NOTE: Despite our best efforts it's entirely possible to have
87 problems when using older versions of autoconf, automake, or
88 libtool.  If you have the latest versions and still can't get it
89 to work, see the next section on Makefile.lite.
90
91 There are a few FLAC-specific arguments you can give to
92 `configure':
93
94 --enable-debug : Builds everything with debug symbols and some
95 extra (and more verbose) error checking.
96
97 --disable-asm-optimizations : Disables the compilation of the
98 assembly routines.  Many routines have assembly versions for
99 speed and `configure' is pretty good about knowing what is
100 supported, but you can use this option to build only from the
101 C sources.
102
103 --enable-sse : If you are building for an x86 CPU that supports
104 SSE instructions, you can enable some of the faster routines
105 if your operating system also supports SSE instructions.  flac
106 can tell if the CPU supports the instructions but currently has
107 no way to test if the OS does, so if it does, you must pass
108 this argument to configure to use the SSE routines.  If flac
109 crashes when built with this option you will have to go back and
110 configure without --enable-sse.  Note that
111 --disable-asm-optimizations implies --disable-sse.
112
113 --enable-3dnow : If you are building for an AMD CPU which has 3DNOW!
114 support, you can use this flag to enable some assembly routines
115 which use 3DNOW! instructions.  There have been some reports that
116 they may cause flac to crash, which is why it is not turned on
117 by default.  Note that --disable-asm-optimizations overrides
118 --enable-3dnow.
119
120 --with-ogg=
121 --with-id3lib=
122 --with-xmms-prefix=
123 --with-libiconv-prefix=
124 Use these if you have these packages but configure can't find them.
125
126
127 ===============================================================================
128 Building with Makefile.lite
129 ===============================================================================
130
131 There is a more lightweight build system for do-it-yourself-ers.
132 It is also useful if configure isn't working, which may be the
133 case since lately we've had some problems with different versions
134 of automake and libtool.  The Makefile.lite system should work
135 on Gnu systems with few or no adjustments.
136
137 From the top level just 'make -f Makefile.lite'.  You can
138 specify zero or one optional target from 'release', 'debug',
139 'test', or 'clean'.  The default is 'release'.  There is no
140 'install' target but everything you need will end up in the
141 obj/ directory.
142
143 If you are not on an x86 system or you don't have nasm, you
144 may have to change the DEFINES in src/libFLAC/Makefile.lite.  If
145 you don't have nasm, remove -DFLAC__HAS_NASM.  If your target is
146 not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.
147
148
149 ===============================================================================
150 Building with MSVC
151 ===============================================================================
152
153 There are two ways to build with MSVC:
154 @@@@Prerequisite: Ogg headers/libs
155
156   1. Project Files
157   Prerequisite: you must have nasm installed, and have the environment
158   variable FLAC_NASM set to the full path to nasmw.exe, e.g
159   C:\nasm\nasmw.exe
160
161   To build everything, run Developer Studio, do File|Open Workspace,
162   and open FLAC.dsw.  Switch to the 'Files' tab, select 'all files'
163   from the tree, do right-mouse-button and 'Set as active project'.
164   The default build mode will probably be Debug; to change to release
165   do Build|Set Active Configuration and select 'all - Win32 Release'.
166   Then do Project|Build.  The libraries will be built as both .libs and DLLs.
167
168   2. nmake
169   Prerequisite: you must have nasm installed and nasmw.exe must be in
170   your path.
171
172   To build everything, open a Command window, cd to the top-level
173   directory (where this README is) and do
174
175   nmake /f Makefile.vc
176
177   This will recur into all the source directories in the right order
178   and build everything.  The libraries will be build only as static
179   libs.  To clean up everything you can do
180
181   nmake /f Makefile.vc clean
182
183   from the top level directory, or any directory which has a
184   Makefile.vc
185
186 Everything will end up in the 'obj' directory.  DLLs and .exe files
187 are all that are needed and can be copied to an installation area an
188 added to the PATH.  The plugins have to be copied to their appropriate
189 place in the player area.  For Winamp2 this is <winamp2-dir>\Plugins
190 and for Winamp3 this is <winamp3-dir>\Wacs.
191
192
193 ===============================================================================
194 Building on Mac OS X
195 ===============================================================================
196
197 If you have Fink, the Gnu flow above should work.  Otherwise,
198 there is a Project Builder project in the top-level source
199 directory to build libFLAC and the command-line utilities on
200 Mac OS X.  In a terminal, cd to the top-level directory (the
201 one that contains this README file) and type:
202
203         pbxbuild -alltargets
204
205 This will create everything and leave it in the build/ directory.
206 Don't worry about the rest of the stuff that is in build/ or
207 the stuff that was already there before building.
208
209 There currently is no install procedure; you will have to
210 manually copy the tools to wherever you need them.
211
212
213 ===============================================================================
214 Note to embedded developers
215 ===============================================================================
216
217 libFLAC has grown larger over time as more functionality has been
218 included, but much of it may be unnecessary for a particular embedded
219 implementation.  Unused parts may be pruned by some simple editing of
220 configure.in and src/libFLAC/Makefile.am; the following dependency
221 graph shows which modules may be pruned without breaking things
222 further down:
223
224 file_encoder.h
225         stream_encoder.h
226                 format.h
227
228 file_decoder.h
229         seekable_stream_decoder.h
230                 stream_decoder.h
231                         format.h
232
233 metadata.h
234         format.h
235
236 There is a section dedicated to embedded use in the libFLAC API
237 HTML documentation (see doc/html/api/index.html).