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