5f0aeb157235fae9f42ec853261b5d0238376df8
[flac.git] / README
1 /* FLAC - Free Lossless Audio Codec
2  * Copyright (C) 2001  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 1) `libFLAC', a library which implements
24 reference encoders and decoders, licensed under the GNU Lesser
25 General Public License (LGPL); 2) `flac', a command-line program for
26 encoding and decoding files, licensed under the GNU General public
27 License (GPL); 3) `metaflac', a command-line program for editing
28 FLAC metadata, licensed under the GPL; 4) player plugins for XMMS
29 and Winamp, licensed under the GPL; and 5) documentation, licensed
30 under the GNU Free Documentation License.
31
32 ============
33 FLAC - 1.0.1
34 ============
35
36 This is the source release for the FLAC project.  See
37
38         doc/index.html
39
40 for full documentation.
41
42 A brief description of the directory tree:
43
44         doc/       the HTML documentation
45         include/   public include files for libFLAC
46         src/       the source code and private headers
47         test/      the test scripts
48
49
50 =============================
51 Building in a GNU environment
52 =============================
53
54 FLAC uses autoconf and libtool for configuring and building.
55 Better documentation for these will be forthcoming, but in
56 general, this should work:
57
58 ./configure && make && make install
59
60 If it doesn't, see the next section on Makefile.lite.
61
62 There are a few FLAC-specific arguments you can give to
63 `configure':
64
65 --enable-debug : Builds everything with debug symbols and some
66 extra (and more verbose) error checking.
67
68 --disable-asm-optimizations : Disables the compilation of the
69 assembly routines.  Many routines have assembly versions for
70 speed and `configure' is pretty good about knowing what is
71 supported, but you can use this option to build only from the
72 C sources.
73
74 --sse-os : If you are building for an x86 CPU that supports
75 SSE instructions, you can enable some of the faster routines
76 if your operating system also supports SSE instructions.  flac
77 can tell if the CPU supports the instructions but currently has
78 no way to test if the OS does, so if it does, you must pass
79 this argument to configure to use the SSE routines.  If flac
80 crashes when built with this option you will have to go back and
81 configure without --sse-os.  Note that --disable-asm-optimizations
82 overrides --sse-os.
83
84
85 ===========================
86 Building with Makefile.lite
87 ===========================
88
89 There is a more lightweight build system for do-it-yourself-ers.
90 It is also useful if configure isn't working, which may be the
91 case since lately we've had some problems with different versions
92 of automake and libtool.  The Makefile.lite system should work
93 on Gnu systems with few or no minor adjustments.
94
95 From the top level just 'make -f Makefile.lite'.  You can
96 specify zero or one optional target from 'release', 'debug',
97 'test', or 'clean'.  The default is 'release'.  There is no
98 'install' target but everything you need will end up in the
99 obj/ directory.
100
101 If you are not on an x86 system or you don't have nasm, you
102 may have to change the DEFINES in src/libFLAC/Makefile.lite.  If
103 you don't have nasm, remove -DFLAC__HAS_NASM.  If your target is
104 not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.
105
106
107 ==================
108 Building with MSVC
109 ==================
110
111 There is no overall make system for MSVC but the individual
112 source directories with a 'Makefile.vc' file in them allow
113 building with MSVC.  Just 'nmake /f Makefile.vc'.  Currently
114 the Makefile.vc for libFLAC is hardcoded to use nasm.  If
115 you don't have nasm, or don't want any assembly optimizations,
116 edit the makefile, adding '/D FLAC__NO_ASM' and delete the
117 rules which compile the .s files.
118
119
120 ====================
121 Building on Mac OS X
122 ====================
123
124 There is a Project Builder project in the top-level source
125 directory to build libFLAC and the command-line utilities on
126 Mac OS X.  In a terminal, cd to the top-level directory (the
127 one that contains this README file) and type:
128
129         pbxbuild -alltargets
130
131 This will create everything and leave it in build/ directory.
132 Don't worry about the rest of the stuff that is in build or
133 the stuff that was already there before building.
134
135 There currently is no install procedure; you will have to
136 manually copy the tools to wherever you need them.