README 10.1 KB
Newer Older
1
/* FLAC - Free Lossless Audio Codec
2
 * Copyright (C) 2001-2009  Josh Coalson
3
 * Copyright (C) 2011-2016  Xiph.Org Foundation
4
 *
Josh Coalson's avatar
Josh Coalson committed
5
 * This file is part the FLAC project.  FLAC is comprised of several
6
 * components distributed under different licenses.  The codec libraries
Josh Coalson's avatar
Josh Coalson committed
7
8
 * are distributed under Xiph.Org's BSD-like license (see the file
 * COPYING.Xiph in this distribution).  All other programs, libraries, and
9
10
11
12
 * plugins are distributed under the LGPL or GPL (see COPYING.LGPL and
 * COPYING.GPL).  The documentation is distributed under the Gnu FDL (see
 * COPYING.FDL).  Each file in the FLAC distribution contains at the top the
 * terms under which it may be distributed.
13
 *
Josh Coalson's avatar
Josh Coalson committed
14
15
16
17
 * Since this particular file is relevant to all components of FLAC,
 * it may be distributed under the Xiph.Org license, which is the least
 * restrictive of those mentioned above.  See the file COPYING.Xiph in this
 * distribution.
18
19
20
 */


21
22
23
24
25
FLAC is an Open Source lossless audio codec developed by Josh Coalson from 2001
to 2009.

From January 2012 FLAC is being maintained by Erik de Castro Lopo under the
auspices of the Xiph.org Foundation.
26

27
28
FLAC is comprised of
  * `libFLAC', a library which implements reference encoders and
29
    decoders for native FLAC and Ogg FLAC, and a metadata interface
30
  * `libFLAC++', a C++ object wrapper library around libFLAC
31
  * `flac', a command-line program for encoding and decoding files
Josh Coalson's avatar
Josh Coalson committed
32
33
  * `metaflac', a command-line program for viewing and editing FLAC
    metadata
Erik de Castro Lopo's avatar
Erik de Castro Lopo committed
34
  * player plugin for XMMS
35
36
  * user and API documentation

37
The libraries (libFLAC, libFLAC++) are
38
licensed under Xiph.org's BSD-like license (see COPYING.Xiph).  All other
39
programs and plugins are licensed under the GNU General Public License
40
41
(see COPYING.GPL).  The documentation is licensed under the GNU Free
Documentation License (see COPYING.FDL).
42

43

44
===============================================================================
Erik de Castro Lopo's avatar
Erik de Castro Lopo committed
45
FLAC - 1.3.2 - Contents
46
47
48
===============================================================================

- Introduction
49
- Prerequisites
50
- Note to embedded developers
51
52
53
54
55
56
57
58
59
- Building in a GNU environment
- Building with Makefile.lite
- Building with MSVC
- Building on Mac OS X


===============================================================================
Introduction
===============================================================================
Josh Coalson's avatar
Josh Coalson committed
60

61
This is the source release for the FLAC project.  See
Josh Coalson's avatar
Josh Coalson committed
62

Josh Coalson's avatar
Josh Coalson committed
63
	doc/html/index.html
Josh Coalson's avatar
Josh Coalson committed
64
65
66
67
68

for full documentation.

A brief description of the directory tree:

Josh Coalson's avatar
Josh Coalson committed
69
	doc/          the HTML documentation
Erik de Castro Lopo's avatar
Erik de Castro Lopo committed
70
	examples/     example programs demonstrating the use of libFLAC and libFLAC++
Josh Coalson's avatar
Josh Coalson committed
71
	include/      public include files for libFLAC and libFLAC++
Erik de Castro Lopo's avatar
Erik de Castro Lopo committed
72
	man/          the man pages for `flac' and `metaflac'
Josh Coalson's avatar
Josh Coalson committed
73
74
	src/          the source code and private headers
	test/         the test scripts
Josh Coalson's avatar
Josh Coalson committed
75

Erik de Castro Lopo's avatar
Erik de Castro Lopo committed
76
77
78
79
80
If you have questions about building FLAC that this document does not answer,
please submit them at the following tracker so this document can be improved:

	https://sourceforge.net/p/flac/support-requests/

Josh Coalson's avatar
Josh Coalson committed
81

82
83
84
85
86
87
88
89
90
===============================================================================
Prerequisites
===============================================================================

To build FLAC with support for Ogg FLAC you must have built and installed
libogg according to the specific instructions below.  You must have
libogg 1.1.2 or greater, or there will be seeking problems with Ogg FLAC.

If you are building on x86 and want the assembly optimizations, you will
Josh Coalson's avatar
Josh Coalson committed
91
92
need to have NASM >= 0.98.30 installed according to the specific instructions
below.
93
94


95
96
97
98
99
100
101
===============================================================================
Note to embedded developers
===============================================================================

libFLAC has grown larger over time as more functionality has been
included, but much of it may be unnecessary for a particular embedded
implementation.  Unused parts may be pruned by some simple editing of
102
configure.ac and src/libFLAC/Makefile.am; the following dependency
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
graph shows which modules may be pruned without breaking things
further down:

metadata.h
	stream_decoder.h
	format.h

stream_encoder.h
	stream_decoder.h
	format.h

stream_decoder.h
	format.h

In other words, for pure decoding applications, both the stream encoder
and metadata editing interfaces can be safely removed.

There is a section dedicated to embedded use in the libFLAC API
HTML documentation (see doc/html/api/index.html).

Also, there are several places in the libFLAC code with comments marked
with "OPT:" where a #define can be changed to enable code that might be
faster on a specific platform.  Experimenting with these can yield faster
binaries.


129
===============================================================================
Josh Coalson's avatar
Josh Coalson committed
130
Building in a GNU environment
131
===============================================================================
Josh Coalson's avatar
Josh Coalson committed
132

Josh Coalson's avatar
Josh Coalson committed
133
134
135
FLAC uses autoconf and libtool for configuring and building.
Better documentation for these will be forthcoming, but in
general, this should work:
Josh Coalson's avatar
Josh Coalson committed
136

Josh Coalson's avatar
Josh Coalson committed
137
138
139
./configure && make && make check && make install

The 'make check' step is optional; omit it to skip all the tests,
Josh Coalson's avatar
Josh Coalson committed
140
which can take several hours and use around 70-80 megs of disk space.
141
142
143
144
Even though it will stop with an explicit message on any failure, it
does print out a lot of stuff so you might want to capture the output
to a file if you're having a problem.  Also, don't run 'make check'
as root because it confuses some of the tests.
Josh Coalson's avatar
Josh Coalson committed
145

Josh Coalson's avatar
Josh Coalson committed
146
147
148
149
NOTE: Despite our best efforts it's entirely possible to have
problems when using older versions of autoconf, automake, or
libtool.  If you have the latest versions and still can't get it
to work, see the next section on Makefile.lite.
150

151
152
153
154
155
156
157
158
159
160
There are a few FLAC-specific arguments you can give to
`configure':

--enable-debug : Builds everything with debug symbols and some
extra (and more verbose) error checking.

--disable-asm-optimizations : Disables the compilation of the
assembly routines.  Many routines have assembly versions for
speed and `configure' is pretty good about knowing what is
supported, but you can use this option to build only from the
Erik de Castro Lopo's avatar
Erik de Castro Lopo committed
161
C sources.  May be necessary for building on OS X (Intel).
162

163
--enable-sse : If you are building for an x86 CPU that supports
164
165
166
167
168
169
SSE instructions, you can enable some of the faster routines
if your operating system also supports SSE instructions.  flac
can tell if the CPU supports the instructions but currently has
no way to test if the OS does, so if it does, you must pass
this argument to configure to use the SSE routines.  If flac
crashes when built with this option you will have to go back and
170
171
configure without --enable-sse.  Note that
--disable-asm-optimizations implies --disable-sse.
172

Josh Coalson's avatar
Josh Coalson committed
173
174
175
--enable-local-xmms-plugin : Installs the FLAC XMMS plugin in
$HOME/.xmms/Plugins, instead of the global XMMS plugin area
(usually /usr/lib/xmms/Input).
Josh Coalson's avatar
Josh Coalson committed
176

177
178
179
180
181
--with-ogg=
--with-xmms-prefix=
--with-libiconv-prefix=
Use these if you have these packages but configure can't find them.

Josh Coalson's avatar
Josh Coalson committed
182
If you want to build completely from scratch (i.e. starting with just
183
configure.ac and Makefile.am) you should be able to just run 'autogen.sh'
Josh Coalson's avatar
Josh Coalson committed
184
185
but make sure and read the comments in that file first.

Josh Coalson's avatar
Josh Coalson committed
186

187
===============================================================================
188
Building with Makefile.lite
189
===============================================================================
190
191
192
193
194

There is a more lightweight build system for do-it-yourself-ers.
It is also useful if configure isn't working, which may be the
case since lately we've had some problems with different versions
of automake and libtool.  The Makefile.lite system should work
Josh Coalson's avatar
Josh Coalson committed
195
on GNU systems with few or no adjustments.
196
197
198
199
200
201
202
203
204
205
206
207
208

From the top level just 'make -f Makefile.lite'.  You can
specify zero or one optional target from 'release', 'debug',
'test', or 'clean'.  The default is 'release'.  There is no
'install' target but everything you need will end up in the
obj/ directory.

If you are not on an x86 system or you don't have nasm, you
may have to change the DEFINES in src/libFLAC/Makefile.lite.  If
you don't have nasm, remove -DFLAC__HAS_NASM.  If your target is
not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.


209
===============================================================================
Josh Coalson's avatar
Josh Coalson committed
210
Building with MSVC
211
===============================================================================
Josh Coalson's avatar
Josh Coalson committed
212

213
214
There are .vcproj projects and a master FLAC.sln solution to build all
the libraries and executables with MSVC 2005 or newer.
215

216
217
Prerequisite: you must have the Ogg libraries installed as described
later.
Josh Coalson's avatar
Josh Coalson committed
218

219
220
Prerequisite: you must have nasm installed, and nasm.exe must be in
your PATH, or the path to nasm.exe must be added to the list of
221
directories for executable files in the MSVC global options.
222

223
224
To build everything, run Visual Studio, do File|Open and open FLAC.sln.
From the dropdown in the toolbar, select "Release" instead of "Debug",
Erik de Castro Lopo's avatar
Erik de Castro Lopo committed
225
then do Build|Build Solution.
226

227
This will build all libraries both statically (e.g.
228
229
230
objs\release\lib\libFLAC_static.lib) and as DLLs (e.g.
objs\release\lib\libFLAC.dll), and it will build all binaries, statically
linked (e.g. objs\release\bin\flac.exe).
231

232
Everything will end up in the "objs" directory.  DLLs and .exe files
Josh Coalson's avatar
Josh Coalson committed
233
are all that are needed and can be copied to an installation area and
234
added to the PATH.
Josh Coalson's avatar
Josh Coalson committed
235

236
By default the code is configured with Ogg support. Before building FLAC
Josh Coalson's avatar
Josh Coalson committed
237
you will need to get the Ogg source distribution
238
239
240
241
242
(see http://xiph.org/downloads/), build libogg_static.lib (load
win32\libogg_static.sln, change solution configuration to "Release" and
code generation to "Multi-threaded (/MT)", then build), copy libogg_static.lib
into FLAC's 'objs\release\lib' directory, and copy the entire include\ogg tree
into FLAC's 'include' directory (so that there is an 'ogg' directory in FLAC's
Josh Coalson's avatar
Josh Coalson committed
243
244
'include' directory with the files ogg.h, os_types.h and config_types.h).

245
246
If you want to build without Ogg support, instead edit all .vcproj files
and remove any "FLAC__HAS_OGG" definitions.
247

Josh Coalson's avatar
Josh Coalson committed
248

249
===============================================================================
Josh Coalson's avatar
Josh Coalson committed
250
Building on Mac OS X
251
===============================================================================
Josh Coalson's avatar
Josh Coalson committed
252

253
If you have Fink or a recent version of OS X with the proper autotools,
254
the GNU flow above should work.