Set version to 1.3.0 and update coyprights throughout.
[flac.git] / README
1 /* FLAC - Free Lossless Audio Codec
2  * Copyright (C) 2012  Xiph.org Foundation
3  * Copyright (C) 2001-2009  Josh Coalson
4  * Copyright (C) 2011-2013  Xiph.Org Foundation
5  *
6  * This file is part the FLAC project.  FLAC is comprised of several
7  * components distributed under difference licenses.  The codec libraries
8  * are distributed under Xiph.Org's BSD-like license (see the file
9  * COPYING.Xiph in this distribution).  All other programs, libraries, and
10  * plugins are distributed under the LGPL or GPL (see COPYING.LGPL and
11  * COPYING.GPL).  The documentation is distributed under the Gnu FDL (see
12  * COPYING.FDL).  Each file in the FLAC distribution contains at the top the
13  * terms under which it may be distributed.
14  *
15  * Since this particular file is relevant to all components of FLAC,
16  * it may be distributed under the Xiph.Org license, which is the least
17  * restrictive of those mentioned above.  See the file COPYING.Xiph in this
18  * distribution.
19  */
20
21
22 FLAC is an Open Source lossless audio codec developed by Josh Coalson from 2001
23 to 2009.
24
25 From January 2012 FLAC is being maintained by Erik de Castro Lopo under the
26 auspices of the Xiph.org Foundation.
27
28 FLAC is comprised of
29   * `libFLAC', a library which implements reference encoders and
30     decoders for native FLAC and Ogg FLAC, and a metadata interface
31   * `libFLAC++', a C++ object wrapper library around libFLAC
32   * `flac', a command-line program for encoding and decoding files
33   * `metaflac', a command-line program for viewing and editing FLAC
34     metadata
35   * player plugins for XMMS and Winamp
36   * user and API documentation
37
38 The libraries (libFLAC, libFLAC++) are
39 licensed under Xiph.org's BSD-like license (see COPYING.Xiph).  All other
40 programs and plugins are licensed under the GNU General Public License
41 (see COPYING.GPL).  The documentation is licensed under the GNU Free
42 Documentation License (see COPYING.FDL).
43
44
45 ===============================================================================
46 FLAC - 1.2.1 - Contents
47 ===============================================================================
48
49 - Introduction
50 - Prerequisites
51 - Note to embedded developers
52 - Building in a GNU environment
53 - Building with Makefile.lite
54 - Building with MSVC
55 - Building on Mac OS X
56
57
58 ===============================================================================
59 Introduction
60 ===============================================================================
61
62 This is the source release for the FLAC project.  See
63
64         doc/html/index.html
65
66 for full documentation.
67
68 A brief description of the directory tree:
69
70         doc/          the HTML documentation
71         include/      public include files for libFLAC and libFLAC++
72         man/          the man page for `flac'
73         src/          the source code and private headers
74         test/         the test scripts
75
76
77 ===============================================================================
78 Prerequisites
79 ===============================================================================
80
81 To build FLAC with support for Ogg FLAC you must have built and installed
82 libogg according to the specific instructions below.  You must have
83 libogg 1.1.2 or greater, or there will be seeking problems with Ogg FLAC.
84
85 If you are building on x86 and want the assembly optimizations, you will
86 need to have NASM >= 0.98.30 installed according to the specific instructions
87 below.
88
89
90 ===============================================================================
91 Note to embedded developers
92 ===============================================================================
93
94 libFLAC has grown larger over time as more functionality has been
95 included, but much of it may be unnecessary for a particular embedded
96 implementation.  Unused parts may be pruned by some simple editing of
97 configure.ac and src/libFLAC/Makefile.am; the following dependency
98 graph shows which modules may be pruned without breaking things
99 further down:
100
101 metadata.h
102         stream_decoder.h
103         format.h
104
105 stream_encoder.h
106         stream_decoder.h
107         format.h
108
109 stream_decoder.h
110         format.h
111
112 In other words, for pure decoding applications, both the stream encoder
113 and metadata editing interfaces can be safely removed.
114
115 There is a section dedicated to embedded use in the libFLAC API
116 HTML documentation (see doc/html/api/index.html).
117
118 Also, there are several places in the libFLAC code with comments marked
119 with "OPT:" where a #define can be changed to enable code that might be
120 faster on a specific platform.  Experimenting with these can yield faster
121 binaries.
122
123
124 ===============================================================================
125 Building in a GNU environment
126 ===============================================================================
127
128 FLAC uses autoconf and libtool for configuring and building.
129 Better documentation for these will be forthcoming, but in
130 general, this should work:
131
132 ./configure && make && make check && make install
133
134 The 'make check' step is optional; omit it to skip all the tests,
135 which can take several hours and use around 70-80 megs of disk space.
136 Even though it will stop with an explicit message on any failure, it
137 does print out a lot of stuff so you might want to capture the output
138 to a file if you're having a problem.  Also, don't run 'make check'
139 as root because it confuses some of the tests.
140
141 NOTE: Despite our best efforts it's entirely possible to have
142 problems when using older versions of autoconf, automake, or
143 libtool.  If you have the latest versions and still can't get it
144 to work, see the next section on Makefile.lite.
145
146 There are a few FLAC-specific arguments you can give to
147 `configure':
148
149 --enable-debug : Builds everything with debug symbols and some
150 extra (and more verbose) error checking.
151
152 --disable-asm-optimizations : Disables the compilation of the
153 assembly routines.  Many routines have assembly versions for
154 speed and `configure' is pretty good about knowing what is
155 supported, but you can use this option to build only from the
156 C sources.  May be necessary for building on OS X (Intel)
157
158 --enable-sse : If you are building for an x86 CPU that supports
159 SSE instructions, you can enable some of the faster routines
160 if your operating system also supports SSE instructions.  flac
161 can tell if the CPU supports the instructions but currently has
162 no way to test if the OS does, so if it does, you must pass
163 this argument to configure to use the SSE routines.  If flac
164 crashes when built with this option you will have to go back and
165 configure without --enable-sse.  Note that
166 --disable-asm-optimizations implies --disable-sse.
167
168 --enable-local-xmms-plugin : Installs the FLAC XMMS plugin in
169 $HOME/.xmms/Plugins, instead of the global XMMS plugin area
170 (usually /usr/lib/xmms/Input).
171
172 --with-ogg=
173 --with-xmms-prefix=
174 --with-libiconv-prefix=
175 Use these if you have these packages but configure can't find them.
176
177 If you want to build completely from scratch (i.e. starting with just
178 configure.ac and Makefile.am) you should be able to just run 'autogen.sh'
179 but make sure and read the comments in that file first.
180
181
182 ===============================================================================
183 Building with Makefile.lite
184 ===============================================================================
185
186 There is a more lightweight build system for do-it-yourself-ers.
187 It is also useful if configure isn't working, which may be the
188 case since lately we've had some problems with different versions
189 of automake and libtool.  The Makefile.lite system should work
190 on GNU systems with few or no adjustments.
191
192 From the top level just 'make -f Makefile.lite'.  You can
193 specify zero or one optional target from 'release', 'debug',
194 'test', or 'clean'.  The default is 'release'.  There is no
195 'install' target but everything you need will end up in the
196 obj/ directory.
197
198 If you are not on an x86 system or you don't have nasm, you
199 may have to change the DEFINES in src/libFLAC/Makefile.lite.  If
200 you don't have nasm, remove -DFLAC__HAS_NASM.  If your target is
201 not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.
202
203
204 ===============================================================================
205 Building with MSVC
206 ===============================================================================
207
208 There are .vcproj projects and a master FLAC.sln solution to build all
209 the libraries and executables with MSVC 2005 or newer.
210
211 Prerequisite: you must have the Ogg libraries installed as described
212 later.
213
214 Prerequisite: you must have nasm installed, and nasm.exe must be in
215 your PATH, or the path to nasm.exe must be added to the list of
216 directories for executable files in the MSVC global options.
217
218 VC++ 2005:
219 To build everything, run Visual Studio, do File|Open and open FLAC.sln.
220 From the dropdown in the toolbar, select "Release" instead of "Debug",
221 then hit F7 to build.
222
223 This will build all libraries both statically (e.g.
224 objs\release\lib\libFLAC_static.lib) and as DLLs (e.g.
225 objs\release\lib\libFLAC.dll), and it will build all binaries, statically
226 linked (e.g. objs\release\bin\flac.exe).
227
228 Everything will end up in the "objs" directory.  DLLs and .exe files
229 are all that are needed and can be copied to an installation area and
230 added to the PATH.
231
232 By default the code is configured with Ogg support. Before building FLAC
233 you will need to get the Ogg source distribution
234 (see http://xiph.org/downloads/), build libogg_static.lib (load
235 win32\libogg_static.sln, change solution configuration to "Release" and
236 code generation to "Multi-threaded (/MT)", then build), copy libogg_static.lib
237 into FLAC's 'objs\release\lib' directory, and copy the entire include\ogg tree
238 into FLAC's 'include' directory (so that there is an 'ogg' directory in FLAC's
239 'include' directory with the files ogg.h, os_types.h and config_types.h).
240
241 If you want to build without Ogg support, instead edit all .vcproj files
242 and remove any "FLAC__HAS_OGG" definitions.
243
244
245 ===============================================================================
246 Building on Mac OS X
247 ===============================================================================
248
249 If you have Fink or a recent version of OS X with the proper autotools,
250 the GNU flow above should work.