README

   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.
  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.5_beta2 - 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 @@@@ NOTE @@@@
  58 This is a beta release.  The CUESHEET metadata block specification has not
  59 been finalized.
  60
  61 This is the source release for the FLAC project.  See
  62
  63         doc/index.html
  64
  65 for full documentation.
  66
  67 A brief description of the directory tree:
  68
  69         doc/          the HTML documentation
  70         flac.pbproj/  the Mac OS X Project Builder project
  71         include/      public include files for libFLAC and libFLAC++
  72         man/          the man page for `flac'
  73         src/          the source code and private headers
  74         test/         the test scripts
  75
  76
  77 ===============================================================================
  78 Building in a GNU environment
  79 ===============================================================================
  80
  81 FLAC uses autoconf and libtool for configuring and building.
  82 Better documentation for these will be forthcoming, but in
  83 general, this should work:
  84
  85 ./configure && make && make check && make install
  86
  87 The 'make check' step is optional; omit it to skip all the tests,
  88 which can take several hours and use around 70-80 megs of disk space.
  89
  90 NOTE: Despite our best efforts it's entirely possible to have
  91 problems when using older versions of autoconf, automake, or
  92 libtool.  If you have the latest versions and still can't get it
  93 to work, see the next section on Makefile.lite.
  94
  95 There are a few FLAC-specific arguments you can give to
  96 `configure':
  97
  98 --enable-debug : Builds everything with debug symbols and some
  99 extra (and more verbose) error checking.
 100
 101 --disable-asm-optimizations : Disables the compilation of the
 102 assembly routines.  Many routines have assembly versions for
 103 speed and `configure' is pretty good about knowing what is
 104 supported, but you can use this option to build only from the
 105 C sources.
 106
 107 --enable-sse : If you are building for an x86 CPU that supports
 108 SSE instructions, you can enable some of the faster routines
 109 if your operating system also supports SSE instructions.  flac
 110 can tell if the CPU supports the instructions but currently has
 111 no way to test if the OS does, so if it does, you must pass
 112 this argument to configure to use the SSE routines.  If flac
 113 crashes when built with this option you will have to go back and
 114 configure without --enable-sse.  Note that
 115 --disable-asm-optimizations implies --disable-sse.
 116
 117 --enable-local-xmms-plugin : Installs the FLAC XMMS plugin in
 118 $HOME/.xmms/Plugins, instead of the global XMMS plugin area
 119 (usually /usr/lib/xmms/Input).
 120
 121 --with-ogg=
 122 --with-id3lib=
 123 --with-xmms-prefix=
 124 --with-libiconv-prefix=
 125 Use these if you have these packages but configure can't find them.
 126
 127 If you want to build completely from scratch (i.e. starting with just
 128 configure.in and Makefile.am) you should be able to just run 'autogen.sh'
 129 but make sure and read the comments in that file first.
 130
 131
 132 ===============================================================================
 133 Building with Makefile.lite
 134 ===============================================================================
 135
 136 There is a more lightweight build system for do-it-yourself-ers.
 137 It is also useful if configure isn't working, which may be the
 138 case since lately we've had some problems with different versions
 139 of automake and libtool.  The Makefile.lite system should work
 140 on GNU systems with few or no adjustments.
 141
 142 From the top level just 'make -f Makefile.lite'.  You can
 143 specify zero or one optional target from 'release', 'debug',
 144 'test', or 'clean'.  The default is 'release'.  There is no
 145 'install' target but everything you need will end up in the
 146 obj/ directory.
 147
 148 If you are not on an x86 system or you don't have nasm, you
 149 may have to change the DEFINES in src/libFLAC/Makefile.lite.  If
 150 you don't have nasm, remove -DFLAC__HAS_NASM.  If your target is
 151 not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.
 152
 153
 154 ===============================================================================
 155 Building with MSVC
 156 ===============================================================================
 157
 158 There are two ways to build with MSVC:
 159
 160   1. Project Files
 161   ----------------
 162   Prerequisite: you must have the Ogg libraries installed as described
 163   later.
 164
 165   Prerequisite: you must have nasm installed, and have the environment
 166   variable FLAC_NASM set to the full path to nasmw.exe, e.g
 167
 168     C:\nasm\nasmw.exe
 169
 170   To build everything, run Developer Studio, do File|Open Workspace,
 171   and open FLAC.dsw.  Switch to the 'Files' tab, select 'all files'
 172   from the tree, do right-mouse-button and 'Set as active project'.
 173   The default build mode will probably be Debug; to change to release
 174   do Build|Set Active Configuration and select 'all - Win32 Release'.
 175   Then do Project|Build.  This will build all libraries both statically
 176   (e.g. obj\debug\lib\libFLAC_static.lib) and as DLLs (e.g.
 177   obj\debug\bin\libFLAC.dll), and it will build all binaries, statically
 178   linked (e.g. obj\debug\bin\flac.exe).
 179
 180   2. nmake
 181   --------
 182   Prerequisite: you must have the Ogg libraries installed as described
 183   later.
 184
 185   Prerequisite: you must have nasm installed and nasmw.exe must be in
 186   your path.
 187
 188   To build everything, open a Command window, cd to the top-level
 189   directory (where this README is) and do
 190
 191     nmake /f Makefile.vc
 192
 193   This will recur into all the source directories in the right order
 194   and build everything.  The libraries will be build only as static
 195   libs.  You need only to install the binaries.  To clean up everything
 196   you can do
 197
 198     nmake /f Makefile.vc clean
 199
 200   from the top level directory, or any directory which has a
 201   Makefile.vc
 202
 203 Everything will end up in the 'obj' directory.  DLLs and .exe files
 204 are all that are needed and can be copied to an installation area and
 205 added to the PATH.  The plugins have to be copied to their appropriate
 206 place in the player area.  For Winamp2 this is <winamp2-dir>\Plugins
 207 and for Winamp3 this is <winamp3-dir>\Wacs.
 208
 209 By default the code is configured with Ogg support.  Before building FLAC
 210 you will need to get the Ogg source distribution
 211 (see http://xiph.org/ogg/vorbis/download/), build ogg_static.lib (load and
 212 build win32\ogg_static.dsp), copy ogg_static.lib into FLAC's
 213 'obj\release\lib' directory, and copy the entire include\ogg tree into
 214 FLAC's 'include' directory (so that there is an 'ogg' directory in FLAC's
 215 'include' directory with the files ogg.h, os_types.h and config_types.h).
 216
 217
 218 ===============================================================================
 219 Building on Mac OS X
 220 ===============================================================================
 221
 222 If you have Fink, the GNU flow above should work.  Otherwise,
 223 there is a Project Builder project in the top-level source
 224 directory to build libFLAC and the command-line utilities on
 225 Mac OS X.  In a terminal, cd to the top-level directory (the
 226 one that contains this README file) and type:
 227
 228         pbxbuild -alltargets
 229
 230 This will create everything and leave it in the build/ directory.
 231 Don't worry about the rest of the stuff that is in build/ or
 232 the stuff that was already there before building.
 233
 234 There currently is no install procedure; you will have to
 235 manually copy the tools to wherever you need them.
 236
 237
 238 ===============================================================================
 239 Note to embedded developers
 240 ===============================================================================
 241
 242 libFLAC has grown larger over time as more functionality has been
 243 included, but much of it may be unnecessary for a particular embedded
 244 implementation.  Unused parts may be pruned by some simple editing of
 245 configure.in and src/libFLAC/Makefile.am; the following dependency
 246 graph shows which modules may be pruned without breaking things
 247 further down:
 248
 249 file_encoder.h
 250         stream_encoder.h
 251                 format.h
 252
 253 file_decoder.h
 254         seekable_stream_decoder.h
 255                 stream_decoder.h
 256                         format.h
 257
 258 metadata.h
 259         format.h
 260
 261 There is a section dedicated to embedded use in the libFLAC API
 262 HTML documentation (see doc/html/api/index.html).