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