add more info about requirements and possible solutions to problems
[flac.git] / README
1 /* FLAC - Free Lossless Audio Codec
2  * Copyright (C) 2001,2002,2003,2004  Josh Coalson
3  *
4  * This file is part the FLAC project.  FLAC is comprised of several
5  * components distributed under difference licenses.  The codec libraries
6  * are distributed under Xiph.Org's BSD-like license (see the file
7  * COPYING.Xiph in this distribution).  All other programs, libraries, and
8  * plugins are distributed under the GPL (see COPYING.GPL).  The documentation
9  * is distributed under the Gnu FDL (see COPYING.FDL).  Each file in the
10  * FLAC distribution contains at the top the terms under which it may be
11  * distributed.
12  *
13  * Since this particular file is relevant to all components of FLAC,
14  * it may be distributed under the Xiph.Org license, which is the least
15  * restrictive of those mentioned above.  See the file COPYING.Xiph in this
16  * distribution.
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 viewing and editing FLAC
31     metadata
32   * player plugins for XMMS and Winamp
33   * user and API documentation
34
35 The libraries (libFLAC, libFLAC++, libOggFLAC, and libOggFLAC++) are
36 licensed under Xiph.org's BSD-like license (see COPYING.Xiph).  All other
37 programs and plugins are licensed under the GNU General Public License
38 (see COPYING.GPL).  The documentation is licensed under the GNU Free
39 Documentation License (see COPYING.FDL).
40
41
42 ===============================================================================
43 FLAC - 1.1.1-beta1 - Contents
44 ===============================================================================
45
46 - Introduction
47 - Building in a GNU environment
48 - Building with Makefile.lite
49 - Building with MSVC
50 - Building on Mac OS X
51 - Note to embedded developers
52
53
54 ===============================================================================
55 Introduction
56 ===============================================================================
57
58 This is the source release for the FLAC project.  See
59
60         doc/index.html
61
62 for full documentation.
63
64 A brief description of the directory tree:
65
66         doc/          the HTML documentation
67         flac.pbproj/  the Mac OS X Project Builder project
68         include/      public include files for libFLAC and libFLAC++
69         man/          the man page for `flac'
70         src/          the source code and private headers
71         test/         the test scripts
72
73
74 ===============================================================================
75 Building in a GNU environment
76 ===============================================================================
77
78 FLAC uses autoconf and libtool for configuring and building.
79 Better documentation for these will be forthcoming, but in
80 general, this should work:
81
82 ./configure && make && make check && make install
83
84 The 'make check' step is optional; omit it to skip all the tests,
85 which can take several hours and use around 70-80 megs of disk space.
86 Even though it will stop with an explicit message on any failure, it
87 does print out a lot of stuff so you might want to capture the output
88 to a file if you're having a problem.  Also, don't run 'make check'
89 as root because it confuses some of the tests.
90
91 NOTE: Despite our best efforts it's entirely possible to have
92 problems when using older versions of autoconf, automake, or
93 libtool.  If you have the latest versions and still can't get it
94 to work, see the next section on Makefile.lite.
95
96 There are a few FLAC-specific arguments you can give to
97 `configure':
98
99 --enable-debug : Builds everything with debug symbols and some
100 extra (and more verbose) error checking.
101
102 --disable-asm-optimizations : Disables the compilation of the
103 assembly routines.  Many routines have assembly versions for
104 speed and `configure' is pretty good about knowing what is
105 supported, but you can use this option to build only from the
106 C sources.
107
108 --enable-sse : If you are building for an x86 CPU that supports
109 SSE instructions, you can enable some of the faster routines
110 if your operating system also supports SSE instructions.  flac
111 can tell if the CPU supports the instructions but currently has
112 no way to test if the OS does, so if it does, you must pass
113 this argument to configure to use the SSE routines.  If flac
114 crashes when built with this option you will have to go back and
115 configure without --enable-sse.  Note that
116 --disable-asm-optimizations implies --disable-sse.
117
118 --enable-local-xmms-plugin : Installs the FLAC XMMS plugin in
119 $HOME/.xmms/Plugins, instead of the global XMMS plugin area
120 (usually /usr/lib/xmms/Input).
121
122 --with-ogg=
123 --with-id3lib=
124 --with-xmms-prefix=
125 --with-libiconv-prefix=
126 Use these if you have these packages but configure can't find them.
127
128 If you want to build completely from scratch (i.e. starting with just
129 configure.in and Makefile.am) you should be able to just run 'autogen.sh'
130 but make sure and read the comments in that file first.
131
132
133 ===============================================================================
134 Building with Makefile.lite
135 ===============================================================================
136
137 There is a more lightweight build system for do-it-yourself-ers.
138 It is also useful if configure isn't working, which may be the
139 case since lately we've had some problems with different versions
140 of automake and libtool.  The Makefile.lite system should work
141 on GNU systems with few or no adjustments.
142
143 From the top level just 'make -f Makefile.lite'.  You can
144 specify zero or one optional target from 'release', 'debug',
145 'test', or 'clean'.  The default is 'release'.  There is no
146 'install' target but everything you need will end up in the
147 obj/ directory.
148
149 If you are not on an x86 system or you don't have nasm, you
150 may have to change the DEFINES in src/libFLAC/Makefile.lite.  If
151 you don't have nasm, remove -DFLAC__HAS_NASM.  If your target is
152 not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.
153
154
155 ===============================================================================
156 Building with MSVC
157 ===============================================================================
158
159 There are now .dsp projects and a master FLAC.dsw workspace to build
160 all the libraries and executables.
161
162 Prerequisite: you must have the Ogg libraries installed as described
163 later.
164
165 Prerequisite: you must have nasm installed, and have the environment
166 variable FLAC_NASM set to the full path to nasmw.exe, e.g
167
168 C:\nasm\nasmw.exe
169
170 To build everything, run Developer Studio, do File|Open Workspace,
171 and open FLAC.dsw.  Select "Build | Set active configuration..."
172 from the menu, then in the dialog, select "All - Win32 Release" (or
173 Debug if you prefer).  Click "Ok" then hit F7 to build. This will build
174 all libraries both statically (e.g. obj\release\lib\libFLAC_static.lib)
175 and as DLLs (e.g.  obj\release\bin\libFLAC.dll), and it will build all
176 binaries, statically linked (e.g. obj\release\bin\flac.exe).
177
178 Everything will end up in the "obj" directory.  DLLs and .exe files
179 are all that are needed and can be copied to an installation area and
180 added to the PATH.  The plugins have to be copied to their appropriate
181 place in the player area.  For Winamp2 this is <winamp2-dir>\Plugins.
182
183 By default the code is configured with Ogg support.  Before building FLAC
184 you will need to get the Ogg source distribution
185 (see http://xiph.org/ogg/vorbis/download/), build ogg_static.lib (load and
186 build win32\ogg_static.dsp), copy ogg_static.lib into FLAC's
187 'obj\release\lib' directory, and copy the entire include\ogg tree into
188 FLAC's 'include' directory (so that there is an 'ogg' directory in FLAC's
189 'include' directory with the files ogg.h, os_types.h and config_types.h).
190
191
192 ===============================================================================
193 Building on Mac OS X
194 ===============================================================================
195
196 If you have Fink, the GNU flow above should work.  Otherwise,
197 there is a Project Builder project in the top-level source
198 directory to build libFLAC and the command-line utilities on
199 Mac OS X.  In a terminal, cd to the top-level directory (the
200 one that contains this README file) and type:
201
202         pbxbuild -alltargets
203
204 This will create everything and leave it in the build/ directory.
205 Don't worry about the rest of the stuff that is in build/ or
206 the stuff that was already there before building.
207
208 The Project Builder project requires that you have libiconv and
209 libogg in /sw, ala fink.  If you don't, you'll need to install
210 them somewhere and change the path to them in the Library Paths
211 section of several targets.
212
213 It also assumes the CPU supports Altivec instructions.  If it does
214 not, you will also have to add -DFLAC__NO_ASM to the CFLAGS in the
215 libFLAC target.
216
217 There currently is no install procedure; you will have to
218 manually copy the tools to wherever you need them.
219
220
221 ===============================================================================
222 Note to embedded developers
223 ===============================================================================
224
225 libFLAC has grown larger over time as more functionality has been
226 included, but much of it may be unnecessary for a particular embedded
227 implementation.  Unused parts may be pruned by some simple editing of
228 configure.in and src/libFLAC/Makefile.am; the following dependency
229 graph shows which modules may be pruned without breaking things
230 further down:
231
232 file_encoder.h
233         stream_encoder.h
234                 format.h
235
236 file_decoder.h
237         seekable_stream_decoder.h
238                 stream_decoder.h
239                         format.h
240
241 metadata.h
242         format.h
243
244 There is a section dedicated to embedded use in the libFLAC API
245 HTML documentation (see doc/html/api/index.html).