Fix build on FreeBSD PowerPC
[flac.git] / README
1 /* FLAC - Free Lossless Audio Codec
2  * Copyright (C) 2001-2009  Josh Coalson
3  * Copyright (C) 2011-2016  Xiph.Org Foundation
4  *
5  * This file is part the FLAC project.  FLAC is comprised of several
6  * components distributed under different licenses.  The codec libraries
7  * are distributed under Xiph.Org's BSD-like license (see the file
8  * COPYING.Xiph in this distribution).  All other programs, libraries, and
9  * plugins are distributed under the LGPL or GPL (see COPYING.LGPL and
10  * COPYING.GPL).  The documentation is distributed under the Gnu FDL (see
11  * COPYING.FDL).  Each file in the FLAC distribution contains at the top the
12  * terms under which it may be distributed.
13  *
14  * Since this particular file is relevant to all components of FLAC,
15  * it may be distributed under the Xiph.Org license, which is the least
16  * restrictive of those mentioned above.  See the file COPYING.Xiph in this
17  * distribution.
18  */
19
20
21 FLAC is an Open Source lossless audio codec developed by Josh Coalson from 2001
22 to 2009.
23
24 From January 2012 FLAC is being maintained by Erik de Castro Lopo under the
25 auspices of the Xiph.org Foundation.
26
27 FLAC is comprised of
28   * `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
32   * `metaflac', a command-line program for viewing and editing FLAC
33     metadata
34   * player plugin for XMMS
35   * user and API documentation
36
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 (see COPYING.GPL).  The documentation is licensed under the GNU Free
41 Documentation License (see COPYING.FDL).
42
43
44 ===============================================================================
45 FLAC - 1.3.3 - Contents
46 ===============================================================================
47
48 - Introduction
49 - Prerequisites
50 - Note to embedded developers
51 - Building in a GNU environment
52 - Building with Makefile.lite
53 - Building with MSVC
54 - Building on Mac OS X
55 - Building with CMake
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         examples/     example programs demonstrating the use of libFLAC and libFLAC++
72         include/      public include files for libFLAC and libFLAC++
73         man/          the man pages for `flac' and `metaflac'
74         src/          the source code and private headers
75         test/         the test scripts
76
77 If you have questions about building FLAC that this document does not answer,
78 please submit them at the following tracker so this document can be improved:
79
80         https://sourceforge.net/p/flac/support-requests/
81
82
83 ===============================================================================
84 Prerequisites
85 ===============================================================================
86
87 To build FLAC with support for Ogg FLAC you must have built and installed
88 libogg according to the specific instructions below.  You must have
89 libogg 1.1.2 or greater, or there will be seeking problems with Ogg FLAC.
90
91 If you are building on x86 and want the assembly optimizations, you will
92 need to have NASM >= 0.98.30 installed according to the specific instructions
93 below.
94
95
96 ===============================================================================
97 Note to embedded developers
98 ===============================================================================
99
100 libFLAC has grown larger over time as more functionality has been
101 included, but much of it may be unnecessary for a particular embedded
102 implementation.  Unused parts may be pruned by some simple editing of
103 configure.ac and src/libFLAC/Makefile.am; the following dependency
104 graph shows which modules may be pruned without breaking things
105 further down:
106
107 metadata.h
108         stream_decoder.h
109         format.h
110
111 stream_encoder.h
112         stream_decoder.h
113         format.h
114
115 stream_decoder.h
116         format.h
117
118 In other words, for pure decoding applications, both the stream encoder
119 and metadata editing interfaces can be safely removed.
120
121 There is a section dedicated to embedded use in the libFLAC API
122 HTML documentation (see doc/html/api/index.html).
123
124 Also, there are several places in the libFLAC code with comments marked
125 with "OPT:" where a #define can be changed to enable code that might be
126 faster on a specific platform.  Experimenting with these can yield faster
127 binaries.
128
129
130 ===============================================================================
131 Building in a GNU environment
132 ===============================================================================
133
134 FLAC uses autoconf and libtool for configuring and building.
135 Better documentation for these will be forthcoming, but in
136 general, this should work:
137
138 ./configure && make && make check && make install
139
140 The 'make check' step is optional; omit it to skip all the tests,
141 which can take several hours and use around 70-80 megs of disk space.
142 Even though it will stop with an explicit message on any failure, it
143 does print out a lot of stuff so you might want to capture the output
144 to a file if you're having a problem.  Also, don't run 'make check'
145 as root because it confuses some of the tests.
146
147 NOTE: Despite our best efforts it's entirely possible to have
148 problems when using older versions of autoconf, automake, or
149 libtool.  If you have the latest versions and still can't get it
150 to work, see the next section on Makefile.lite.
151
152 There are a few FLAC-specific arguments you can give to
153 `configure':
154
155 --enable-debug : Builds everything with debug symbols and some
156 extra (and more verbose) error checking.
157
158 --disable-asm-optimizations : Disables the compilation of the
159 assembly routines.  Many routines have assembly versions for
160 speed and `configure' is pretty good about knowing what is
161 supported, but you can use this option to build only from the
162 C sources.  May be necessary for building on OS X (Intel).
163
164 --enable-sse : If you are building for an x86 CPU that supports
165 SSE instructions, you can enable some of the faster routines
166 if your operating system also supports SSE instructions.  flac
167 can tell if the CPU supports the instructions but currently has
168 no way to test if the OS does, so if it does, you must pass
169 this argument to configure to use the SSE routines.  If flac
170 crashes when built with this option you will have to go back and
171 configure without --enable-sse.  Note that
172 --disable-asm-optimizations implies --disable-sse.
173
174 --enable-local-xmms-plugin : Installs the FLAC XMMS plugin in
175 $HOME/.xmms/Plugins, instead of the global XMMS plugin area
176 (usually /usr/lib/xmms/Input).
177
178 --with-ogg=
179 --with-xmms-prefix=
180 --with-libiconv-prefix=
181 Use these if you have these packages but configure can't find them.
182
183 If you want to build completely from scratch (i.e. starting with just
184 configure.ac and Makefile.am) you should be able to just run 'autogen.sh'
185 but make sure and read the comments in that file first.
186
187
188 ===============================================================================
189 Building with Makefile.lite
190 ===============================================================================
191
192 There is a more lightweight build system for do-it-yourself-ers.
193 It is also useful if configure isn't working, which may be the
194 case since lately we've had some problems with different versions
195 of automake and libtool.  The Makefile.lite system should work
196 on GNU systems with few or no adjustments.
197
198 From the top level just 'make -f Makefile.lite'.  You can
199 specify zero or one optional target from 'release', 'debug',
200 'test', or 'clean'.  The default is 'release'.  There is no
201 'install' target but everything you need will end up in the
202 obj/ directory.
203
204 If you are not on an x86 system or you don't have nasm, you
205 may have to change the DEFINES in src/libFLAC/Makefile.lite.  If
206 you don't have nasm, remove -DFLAC__HAS_NASM.  If your target is
207 not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.
208
209
210 ===============================================================================
211 Building with MSVC
212 ===============================================================================
213
214 There are .vcproj projects and a master FLAC.sln solution to build all
215 the libraries and executables with MSVC 2005 or newer.
216
217 Prerequisite: you must have the Ogg libraries installed as described
218 later.
219
220 Prerequisite: you must have nasm installed, and nasm.exe must be in
221 your PATH, or the path to nasm.exe must be added to the list of
222 directories for executable files in the MSVC global options.
223
224 To build everything, run Visual Studio, do File|Open and open FLAC.sln.
225 From the dropdown in the toolbar, select "Release" instead of "Debug",
226 then do Build|Build Solution.
227
228 This will build all libraries both statically (e.g.
229 objs\release\lib\libFLAC_static.lib) and as DLLs (e.g.
230 objs\release\lib\libFLAC.dll), and it will build all binaries, statically
231 linked (e.g. objs\release\bin\flac.exe).
232
233 Everything will end up in the "objs" directory.  DLLs and .exe files
234 are all that are needed and can be copied to an installation area and
235 added to the PATH.
236
237 By default the code is configured with Ogg support. Before building FLAC
238 you will need to get the Ogg source distribution
239 (see http://xiph.org/downloads/), build libogg_static.lib (load
240 win32\libogg_static.sln, change solution configuration to "Release" and
241 code generation to "Multi-threaded (/MT)", then build), copy libogg_static.lib
242 into FLAC's 'objs\release\lib' directory, and copy the entire include\ogg tree
243 into FLAC's 'include' directory (so that there is an 'ogg' directory in FLAC's
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
247 and remove any "FLAC__HAS_OGG" definitions.
248
249
250 ===============================================================================
251 Building on Mac OS X
252 ===============================================================================
253
254 If you have Fink or a recent version of OS X with the proper autotools,
255 the GNU flow above should work.
256
257
258 ===============================================================================
259 Building with CMake
260 ===============================================================================
261
262 CMake is a cross-platform build system. FLAC can be built on Windows, Linux, Mac
263 OS X using CMake.
264
265 You can use either CMake's CLI or GUI. We recommend you to have a separate build
266 folder outside the repository in order to not spoil it with generated files.
267
268 CLI
269 ---
270    Go to your build folder and run something like this:
271
272    /path/to/flac/build$ cmake /path/to/flac/source
273
274    or e.g. in Windows shell
275
276    C:\path\to\flac\build> cmake \path\to\flac\source
277    (provided that cmake is in your %PATH% variable)
278
279    That will generate build scripts for the default build system (e.g. Makefiles
280    for UNIX). After that you start build with a command like this:
281
282    /path/to/flac/build$ make
283
284    And afterwards you can run tests or install the built libraries and headers
285
286    /path/to/flac/build$ make test
287    /path/to/flac/build$ make install
288
289    If you want use a build system other than default add -G flag to cmake, e.g.:
290
291    /path/to/flac/build$ cmake /path/to/flac/source -GNinja
292    /path/to/flac/build$ ninja
293
294    or:
295
296    /path/to/flac/build$ cmake /path/to/flac/source -GXcode
297
298    Use cmake --help to see the list of available generators.
299
300    If you have OGG on your system you can tell CMake to use it:
301
302    /path/to/flac/build$ cmake /path/to/flac/source -DWITH_OGG=ON
303
304    If CMake fails to find it you can help CMake by specifying the exact path:
305
306    /path/to/flac/build$ cmake /path/to/flac/source -DWITH_OGG=ON -DOGG_ROOT=/path/to/ogg
307
308    CMake will search for OGG by default so if you don't have it you can tell
309    cmake to not do so:
310
311    /path/to/flac/build$ cmake /path/to/flac/source -DWITH_OGG=OFF
312
313    Other FLAC's options (e.g. building C++ lib or docs) can also be put to cmake
314    through -D flag.
315
316 GUI
317 ---
318    It is likely that you would prefer to use it on Windows building for Visual
319    Studio.  It's in essence the same process as building using CLI.
320
321    Open cmake-gui. In the window select a source directory (the repository's
322    root), a build directory (some other directory outside the repository). Then
323    press button "Configure". CMake will ask you which build system you prefer.
324    Choose that version of Visual Studio which you have on your system, choose
325    whether you want to build for x86 or amd64. Press OK. After CMake finishes
326    press "Generate" button, and after that "Open Project". In response CMake
327    will launch Visual Studio and open the generated solution. You can use it as
328    usual but remember that it was generated by CMake. That means that your
329    changes (e.g. some addidional compile flags) will be lost when you run CMake
330    next time.
331
332    Again, if you have OGG on your system set WITH_OGG flag in the list of
333    variables in cmake-gui window before you press "Configure".
334
335    If CMake fails to find MSVC compiler then running cmake-gui from MS Developer
336    comand prompt should help.