add verbiage for libOggFLAC, libOggFLAC++
[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
26   * `libFLAC++', a C++ object wrapper library around libFLAC
27   * `libOggFLAC' and `libOggFLAC++', which provide encoders and
28     decoders for FLAC streams in an Ogg container
29   * `flac', a command-line program for encoding and decoding files
30   * `metaflac', a command-line program for editing FLAC metadata
31   * player plugins for XMMS and Winamp
32   * user and API documentation
33
34 The libraries (libFLAC, libFLAC++, libOggFLAC, and libOggFLAC++) are
35 licensed under the GNU Lesser General Public License (LGPL).  All other
36 programs and plugins are licensed under the GNU General Public License
37 (GPL).  The documentation is licensed under the GNU Free Documentation
38 License (GFDL).
39
40
41 ===============================================================================
42 FLAC - 1.0.3 - Contents
43 ===============================================================================
44
45 - Introduction
46 - Building in a GNU environment
47 - Building with Makefile.lite
48 - Building with MSVC
49 - Building on Mac OS X
50 - Note to embedded developers
51
52
53 ===============================================================================
54 Introduction
55 ===============================================================================
56
57 This is the source release for the FLAC project.  See
58
59         doc/index.html
60
61 for full documentation.
62
63 A brief description of the directory tree:
64
65         doc/          the HTML documentation
66         flac.pbproj/  the Mac OS X Project Builder project
67         include/      public include files for libFLAC and libFLAC++
68         man/          the man page for `flac'
69         src/          the source code and private headers
70         test/         the test scripts
71
72
73 ===============================================================================
74 Building in a GNU environment
75 ===============================================================================
76
77 FLAC uses autoconf and libtool for configuring and building.
78 Better documentation for these will be forthcoming, but in
79 general, this should work:
80
81 ./configure && make && make install
82
83 NOTE: Despite our best efforts it's entirely possible to have
84 problems when using older versions of autoconf, automake, or
85 libtool.  If you have the latest versions and still can't get it
86 to work, see the next section on Makefile.lite.
87
88 There are a few FLAC-specific arguments you can give to
89 `configure':
90
91 --enable-debug : Builds everything with debug symbols and some
92 extra (and more verbose) error checking.
93
94 --disable-asm-optimizations : Disables the compilation of the
95 assembly routines.  Many routines have assembly versions for
96 speed and `configure' is pretty good about knowing what is
97 supported, but you can use this option to build only from the
98 C sources.
99
100 --enable-sse : If you are building for an x86 CPU that supports
101 SSE instructions, you can enable some of the faster routines
102 if your operating system also supports SSE instructions.  flac
103 can tell if the CPU supports the instructions but currently has
104 no way to test if the OS does, so if it does, you must pass
105 this argument to configure to use the SSE routines.  If flac
106 crashes when built with this option you will have to go back and
107 configure without --enable-sse.  Note that
108 --disable-asm-optimizations implies --disable-sse.
109
110 --enable-3dnow : If you are building for an AMD CPU which has 3DNOW!
111 support, you can use this flag to enable some assembly routines
112 which use 3DNOW! instructions.  There have been some reports that
113 they may cause flac to crash, which is why it is not turned on
114 by default.  Note that --disable-asm-optimizations overrides
115 --enable-3dnow.
116
117
118 ===============================================================================
119 Building with Makefile.lite
120 ===============================================================================
121
122 There is a more lightweight build system for do-it-yourself-ers.
123 It is also useful if configure isn't working, which may be the
124 case since lately we've had some problems with different versions
125 of automake and libtool.  The Makefile.lite system should work
126 on Gnu systems with few or no adjustments.
127
128 From the top level just 'make -f Makefile.lite'.  You can
129 specify zero or one optional target from 'release', 'debug',
130 'test', or 'clean'.  The default is 'release'.  There is no
131 'install' target but everything you need will end up in the
132 obj/ directory.
133
134 If you are not on an x86 system or you don't have nasm, you
135 may have to change the DEFINES in src/libFLAC/Makefile.lite.  If
136 you don't have nasm, remove -DFLAC__HAS_NASM.  If your target is
137 not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.
138
139
140 ===============================================================================
141 Building with MSVC
142 ===============================================================================
143
144 There is no overall make system for MSVC but the individual
145 source directories with a 'Makefile.vc' file in them allow
146 building with MSVC.  Just 'nmake /f Makefile.vc'.  Currently
147 the Makefile.vc for libFLAC is hardcoded to use nasm.  If
148 you don't have nasm, or don't want any assembly optimizations,
149 edit the makefile, adding '/D FLAC__NO_ASM', and delete the
150 rules which compile the .nasm files.
151
152
153 ===============================================================================
154 Building on Mac OS X
155 ===============================================================================
156
157 If you have Fink, the Gnu flow above should work.  Otherwise,
158 there is a Project Builder project in the top-level source
159 directory to build libFLAC and the command-line utilities on
160 Mac OS X.  In a terminal, cd to the top-level directory (the
161 one that contains this README file) and type:
162
163         pbxbuild -alltargets
164
165 This will create everything and leave it in the build/ directory.
166 Don't worry about the rest of the stuff that is in build/ or
167 the stuff that was already there before building.
168
169 There currently is no install procedure; you will have to
170 manually copy the tools to wherever you need them.
171
172
173 ===============================================================================
174 Note to embedded developers
175 ===============================================================================
176
177 libFLAC has grown larger over time as more functionality has been
178 included, but much of it may be unnecessary for a particular embedded
179 implementation.  Unused parts may be pruned by some simple editing of
180 configure.in and src/libFLAC/Makefile.am; the following dependency
181 graph shows which modules may be pruned without breaking things
182 further down:
183
184 file_encoder.h
185         stream_encoder.h
186                 format.h
187
188 file_decoder.h
189         seekable_stream_decoder.h
190                 stream_decoder.h
191                         format.h
192
193 metadata.h
194         format.h
195
196 There is a section dedicated to embedded use in the libFLAC API
197 HTML documentation (see doc/html/api/index.html).