change license verbiage to Xiph's
[flac.git] / README
1 /* FLAC - Free Lossless Audio Codec
2  * Copyright (C) 2001,2002,2003  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 Xiph.org's BSD-like license (see COPYING.Xiph).  All other
36 programs and plugins are licensed under the GNU General Public License
37 (see COPYING.GPL).  The documentation is licensed under the GNU Free
38 Documentation License (see COPYING.FDL).
39
40
41 ===============================================================================
42 FLAC - 1.1.0 - 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 and use around 70-80 megs of disk space.
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-local-xmms-plugin : Installs the FLAC XMMS plugin in
114 $HOME/.xmms/Plugins, instead of the global XMMS plugin area
115 (usually /usr/lib/xmms/Input).
116
117 --with-ogg=
118 --with-id3lib=
119 --with-xmms-prefix=
120 --with-libiconv-prefix=
121 Use these if you have these packages but configure can't find them.
122
123 If you want to build completely from scratch (i.e. starting with just
124 configure.in and Makefile.am) you should be able to just run 'autogen.sh'
125 but make sure and read the comments in that file first.
126
127
128 ===============================================================================
129 Building with Makefile.lite
130 ===============================================================================
131
132 There is a more lightweight build system for do-it-yourself-ers.
133 It is also useful if configure isn't working, which may be the
134 case since lately we've had some problems with different versions
135 of automake and libtool.  The Makefile.lite system should work
136 on GNU systems with few or no adjustments.
137
138 From the top level just 'make -f Makefile.lite'.  You can
139 specify zero or one optional target from 'release', 'debug',
140 'test', or 'clean'.  The default is 'release'.  There is no
141 'install' target but everything you need will end up in the
142 obj/ directory.
143
144 If you are not on an x86 system or you don't have nasm, you
145 may have to change the DEFINES in src/libFLAC/Makefile.lite.  If
146 you don't have nasm, remove -DFLAC__HAS_NASM.  If your target is
147 not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.
148
149
150 ===============================================================================
151 Building with MSVC
152 ===============================================================================
153
154 There are now .dsp projects and a master FLAC.dsw workspace to build
155 all the libraries and executables.
156
157 Prerequisite: you must have the Ogg libraries installed as described
158 later.
159
160 Prerequisite: you must have nasm installed, and have the environment
161 variable FLAC_NASM set to the full path to nasmw.exe, e.g
162
163 C:\nasm\nasmw.exe
164
165 To build everything, run Developer Studio, do File|Open Workspace,
166 and open FLAC.dsw.  Select "Build | Set active configuration..."
167 from the menu, then in the dialog, select "All - Win32 Release" (or
168 Debug if you prefer).  Click "Ok" then hit F7 to build. This will build
169 all libraries both statically (e.g. obj\release\lib\libFLAC_static.lib)
170 and as DLLs (e.g.  obj\release\bin\libFLAC.dll), and it will build all
171 binaries, statically linked (e.g. obj\release\bin\flac.exe).
172
173 Everything will end up in the "obj" directory.  DLLs and .exe files
174 are all that are needed and can be copied to an installation area and
175 added to the PATH.  The plugins have to be copied to their appropriate
176 place in the player area.  For Winamp2 this is <winamp2-dir>\Plugins
177 and for Winamp3 this is <winamp3-dir>\Wacs.
178
179 By default the code is configured with Ogg support.  Before building FLAC
180 you will need to get the Ogg source distribution
181 (see http://xiph.org/ogg/vorbis/download/), build ogg_static.lib (load and
182 build win32\ogg_static.dsp), copy ogg_static.lib into FLAC's
183 'obj\release\lib' directory, and copy the entire include\ogg tree into
184 FLAC's 'include' directory (so that there is an 'ogg' directory in FLAC's
185 'include' directory with the files ogg.h, os_types.h and config_types.h).
186
187
188 ===============================================================================
189 Building on Mac OS X
190 ===============================================================================
191
192 If you have Fink, the GNU flow above should work.  Otherwise,
193 there is a Project Builder project in the top-level source
194 directory to build libFLAC and the command-line utilities on
195 Mac OS X.  In a terminal, cd to the top-level directory (the
196 one that contains this README file) and type:
197
198         pbxbuild -alltargets
199
200 This will create everything and leave it in the build/ directory.
201 Don't worry about the rest of the stuff that is in build/ or
202 the stuff that was already there before building.
203
204 There currently is no install procedure; you will have to
205 manually copy the tools to wherever you need them.
206
207
208 ===============================================================================
209 Note to embedded developers
210 ===============================================================================
211
212 libFLAC has grown larger over time as more functionality has been
213 included, but much of it may be unnecessary for a particular embedded
214 implementation.  Unused parts may be pruned by some simple editing of
215 configure.in and src/libFLAC/Makefile.am; the following dependency
216 graph shows which modules may be pruned without breaking things
217 further down:
218
219 file_encoder.h
220         stream_encoder.h
221                 format.h
222
223 file_decoder.h
224         seekable_stream_decoder.h
225                 stream_decoder.h
226                         format.h
227
228 metadata.h
229         format.h
230
231 There is a section dedicated to embedded use in the libFLAC API
232 HTML documentation (see doc/html/api/index.html).