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