~ubuntu-branches/ubuntu/karmic/flac/karmic

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Matt Zimmerman
  • Date: 2005-01-08 15:08:22 UTC
  • mto: (8.1.1 lenny)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20050108150822-yvinilrafylazcyv
Tags: upstream-1.1.1
ImportĀ upstreamĀ versionĀ 1.1.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
/* FLAC - Free Lossless Audio Codec
2
 
 * Copyright (C) 2001,2002,2003  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.
 
2
 * Copyright (C) 2001,2002,2003,2004  Josh Coalson
 
3
 *
 
4
 * This file is part the FLAC project.  FLAC is comprised of several
 
5
 * components distributed under difference licenses.  The codec libraries
 
6
 * are distributed under Xiph.Org's BSD-like license (see the file
 
7
 * COPYING.Xiph in this distribution).  All other programs, libraries, and
 
8
 * plugins are distributed under the GPL (see COPYING.GPL).  The documentation
 
9
 * is distributed under the Gnu FDL (see COPYING.FDL).  Each file in the
 
10
 * FLAC distribution contains at the top the terms under which it may be
 
11
 * distributed.
 
12
 *
 
13
 * Since this particular file is relevant to all components of FLAC,
 
14
 * it may be distributed under the Xiph.Org license, which is the least
 
15
 * restrictive of those mentioned above.  See the file COPYING.Xiph in this
 
16
 * distribution.
17
17
 */
18
18
 
19
19
 
27
27
  * `libOggFLAC' and `libOggFLAC++', which provide encoders and
28
28
    decoders for FLAC streams in an Ogg container
29
29
  * `flac', a command-line program for encoding and decoding files
30
 
  * `metaflac', a command-line program for editing FLAC metadata
 
30
  * `metaflac', a command-line program for viewing and editing FLAC
 
31
    metadata
31
32
  * player plugins for XMMS and Winamp
32
33
  * user and API documentation
33
34
 
34
35
The libraries (libFLAC, libFLAC++, libOggFLAC, and libOggFLAC++) are
35
 
licensed under the GNU Lesser General Public License (LGPL).  All other
 
36
licensed under Xiph.org's BSD-like license (see COPYING.Xiph).  All other
36
37
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).
 
38
(see COPYING.GPL).  The documentation is licensed under the GNU Free
 
39
Documentation License (see COPYING.FDL).
39
40
 
40
41
 
41
42
===============================================================================
42
 
FLAC - 1.1.0 - Contents
 
43
FLAC - 1.1.1 - Contents
43
44
===============================================================================
44
45
 
45
46
- Introduction
 
47
- Prerequisites
46
48
- Building in a GNU environment
47
49
- Building with Makefile.lite
48
50
- Building with MSVC
56
58
 
57
59
This is the source release for the FLAC project.  See
58
60
 
59
 
        doc/index.html
 
61
        doc/html/index.html
60
62
 
61
63
for full documentation.
62
64
 
71
73
 
72
74
 
73
75
===============================================================================
 
76
Prerequisites
 
77
===============================================================================
 
78
 
 
79
To build FLAC with support for Ogg FLAC you must have built and installed
 
80
libogg according to the specific instructions below.  You must have
 
81
libogg 1.1.2 or greater, or there will be seeking problems with Ogg FLAC.
 
82
 
 
83
If you are building on x86 and want the assembly optimizations, you will
 
84
need to have NASM installed according to the specific instructions below.
 
85
 
 
86
 
 
87
===============================================================================
74
88
Building in a GNU environment
75
89
===============================================================================
76
90
 
82
96
 
83
97
The 'make check' step is optional; omit it to skip all the tests,
84
98
which can take several hours and use around 70-80 megs of disk space.
 
99
Even though it will stop with an explicit message on any failure, it
 
100
does print out a lot of stuff so you might want to capture the output
 
101
to a file if you're having a problem.  Also, don't run 'make check'
 
102
as root because it confuses some of the tests.
85
103
 
86
104
NOTE: Despite our best efforts it's entirely possible to have
87
105
problems when using older versions of autoconf, automake, or
115
133
(usually /usr/lib/xmms/Input).
116
134
 
117
135
--with-ogg=
118
 
--with-id3lib=
119
136
--with-xmms-prefix=
120
137
--with-libiconv-prefix=
121
138
Use these if you have these packages but configure can't find them.
157
174
Prerequisite: you must have the Ogg libraries installed as described
158
175
later.
159
176
 
160
 
Prerequisite: you must have nasm installed, and have the environment
161
 
variable FLAC_NASM set to the full path to nasmw.exe, e.g
162
 
 
163
 
C:\nasm\nasmw.exe
 
177
Prerequisite: you must have nasm installed, and nasmw.exe must be in
 
178
your PATH, or the path to nasmw.exe must be added to the list of
 
179
directories for executable files in the MSVC global options.
164
180
 
165
181
To build everything, run Developer Studio, do File|Open Workspace,
166
182
and open FLAC.dsw.  Select "Build | Set active configuration..."
173
189
Everything will end up in the "obj" directory.  DLLs and .exe files
174
190
are all that are needed and can be copied to an installation area and
175
191
added to the PATH.  The plugins have to be copied to their appropriate
176
 
place in the player area.  For Winamp2 this is <winamp2-dir>\Plugins
177
 
and for Winamp3 this is <winamp3-dir>\Wacs.
 
192
place in the player area.  For Winamp2 this is <winamp2-dir>\Plugins.
178
193
 
179
194
By default the code is configured with Ogg support.  Before building FLAC
180
195
you will need to get the Ogg source distribution
201
216
Don't worry about the rest of the stuff that is in build/ or
202
217
the stuff that was already there before building.
203
218
 
 
219
The Project Builder project requires that you have libiconv and
 
220
libogg in /sw, ala fink.  If you don't, you'll need to install
 
221
them somewhere and change the path to them in the Library Paths
 
222
section of several targets.
 
223
 
 
224
It also assumes the CPU supports Altivec instructions.  If it does
 
225
not, you will also have to add -DFLAC__NO_ASM to the CFLAGS in the
 
226
libFLAC target.
 
227
 
204
228
There currently is no install procedure; you will have to
205
229
manually copy the tools to wherever you need them.
206
230