README 5.7 KB
Newer Older
1
/* FLAC - Free Lossless Audio Codec
2
 * Copyright (C) 2001,2002  Josh Coalson
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 *
 * This program is part of FLAC; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */


FLAC (http://flac.sourceforge.net/) is an Open Source lossless audio
codec developed by Josh Coalson.

23
24
25
26
27
28
29
30
31
32
33
FLAC is comprised of
  * `libFLAC', a library which implements reference encoders and
    decoders, and a metadata interface, licensed under the GNU
    Lesser General Public License (LGPL)
  * `libFLAC++', a C++ object wrapper library around libFLAC
  * `flac', a command-line program for encoding and decoding files,
    licensed under the GNU General public License (GPL)
  * `metaflac', a command-line program for editing FLAC metadata,
    licensed under the GPL
  * player plugins for XMMS and Winamp, licensed under the GPL
  * documentation, licensed under the GNU Free Documentation License.
34

Josh Coalson's avatar
Josh Coalson committed
35
============
36
FLAC - 1.0.3
Josh Coalson's avatar
Josh Coalson committed
37
============
Josh Coalson's avatar
Josh Coalson committed
38

39
This is the source release for the FLAC project.  See
Josh Coalson's avatar
Josh Coalson committed
40
41
42
43
44
45
46
47

	doc/index.html

for full documentation.

A brief description of the directory tree:

	doc/       the HTML documentation
48
	man/       the man page for `flac'
Josh Coalson's avatar
Josh Coalson committed
49
50
51
52
53
54
55
56
57
	include/   public include files for libFLAC
	src/       the source code and private headers
	test/      the test scripts


=============================
Building in a GNU environment
=============================

Josh Coalson's avatar
Josh Coalson committed
58
59
60
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
61

Josh Coalson's avatar
Josh Coalson committed
62
./configure && make && make install
Josh Coalson's avatar
Josh Coalson committed
63

64
65
66
67
68
69
70
71
NOTE: automake 1.5 has a bug which will affect the x86 assembly
part of the build.  If you have automake 1.5 and have x86
assembly optimizations turned on, you will need to get a newer
version of automake or patch your /usr/bin/automake using the
included 'automake-1.5.patch' file.

If you still can't get it to work, see the next section on
Makefile.lite.
72

73
74
75
76
77
78
79
80
81
82
83
84
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
C sources.

85
--enable-sse : If you are building for an x86 CPU that supports
86
87
88
89
90
91
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
92
93
configure without --enable-sse.  Note that
--disable-asm-optimizations implies --disable-sse.
94

95
--enable-3dnow : If you are building for an AMD CPU which has 3DNOW!
Josh Coalson's avatar
Josh Coalson committed
96
97
98
support, you can use this flag to enable some assembly routines
which use 3DNOW! instructions.  There have been some reports that
they may cause flac to crash, which is why it is not turned on
Josh Coalson's avatar
Josh Coalson committed
99
by default.  Note that --disable-asm-optimizations overrides
100
--enable-3dnow.
Josh Coalson's avatar
Josh Coalson committed
101

Josh Coalson's avatar
Josh Coalson committed
102

103
104
105
106
107
108
109
110
===========================
Building with Makefile.lite
===========================

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
111
on Gnu systems with few or no adjustments.
112
113
114
115
116
117
118
119
120
121
122
123
124

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.


Josh Coalson's avatar
Josh Coalson committed
125
126
127
128
129
130
==================
Building with MSVC
==================

There is no overall make system for MSVC but the individual
source directories with a 'Makefile.vc' file in them allow
131
132
133
building with MSVC.  Just 'nmake /f Makefile.vc'.  Currently
the Makefile.vc for libFLAC is hardcoded to use nasm.  If
you don't have nasm, or don't want any assembly optimizations,
Josh Coalson's avatar
Josh Coalson committed
134
edit the makefile, adding '/D FLAC__NO_ASM', and delete the
135
rules which compile the .nasm files.
Josh Coalson's avatar
Josh Coalson committed
136
137
138
139
140
141


====================
Building on Mac OS X
====================

Josh Coalson's avatar
Josh Coalson committed
142
143
If you have Fink, the Gnu flow above should work.  Otherwise,
there is a Project Builder project in the top-level source
Josh Coalson's avatar
Josh Coalson committed
144
145
146
147
148
149
directory to build libFLAC and the command-line utilities on
Mac OS X.  In a terminal, cd to the top-level directory (the
one that contains this README file) and type:

	pbxbuild -alltargets

Josh Coalson's avatar
Josh Coalson committed
150
151
This will create everything and leave it in the build/ directory.
Don't worry about the rest of the stuff that is in build/ or
Josh Coalson's avatar
Josh Coalson committed
152
153
154
155
the stuff that was already there before building.

There currently is no install procedure; you will have to
manually copy the tools to wherever you need them.