README

   1 /* FLAC - Free Lossless Audio Codec
   2  * Copyright (C) 2001,2002,2003,2004,2005,2006,2007  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 LGPL or GPL (see COPYING.LGPL and
   9  * COPYING.GPL).  The documentation is distributed under the Gnu FDL (see
  10  * COPYING.FDL).  Each file in the FLAC distribution contains at the top the
  11  * terms under which it may be 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  */
  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 for native FLAC and Ogg FLAC, and a metadata interface
  26   * `libFLAC++', a C++ object wrapper library around libFLAC
  27   * `flac', a command-line program for encoding and decoding files
  28   * `metaflac', a command-line program for viewing and editing FLAC
  29     metadata
  30   * player plugins for XMMS and Winamp
  31   * user and API documentation
  32
  33 The libraries (libFLAC, libFLAC++) are
  34 licensed under Xiph.org's BSD-like license (see COPYING.Xiph).  All other
  35 programs and plugins are licensed under the GNU General Public License
  36 (see COPYING.GPL).  The documentation is licensed under the GNU Free
  37 Documentation License (see COPYING.FDL).
  38
  39
  40 ===============================================================================
  41 FLAC - 1.2.0 - Contents
  42 ===============================================================================
  43
  44 - Introduction
  45 - Prerequisites
  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/html/index.html
  60
  61 for full documentation.
  62
  63 A brief description of the directory tree:
  64
  65         doc/          the HTML documentation
  66         include/      public include files for libFLAC and libFLAC++
  67         man/          the man page for `flac'
  68         src/          the source code and private headers
  69         test/         the test scripts
  70
  71
  72 ===============================================================================
  73 Prerequisites
  74 ===============================================================================
  75
  76 To build FLAC with support for Ogg FLAC you must have built and installed
  77 libogg according to the specific instructions below.  You must have
  78 libogg 1.1.2 or greater, or there will be seeking problems with Ogg FLAC.
  79
  80 If you are building on x86 and want the assembly optimizations, you will
  81 need to have NASM >= 0.98.30 installed according to the specific instructions
  82 below.
  83
  84
  85 ===============================================================================
  86 Building in a GNU environment
  87 ===============================================================================
  88
  89 FLAC uses autoconf and libtool for configuring and building.
  90 Better documentation for these will be forthcoming, but in
  91 general, this should work:
  92
  93 ./configure && make && make check && make install
  94
  95 The 'make check' step is optional; omit it to skip all the tests,
  96 which can take several hours and use around 70-80 megs of disk space.
  97 Even though it will stop with an explicit message on any failure, it
  98 does print out a lot of stuff so you might want to capture the output
  99 to a file if you're having a problem.  Also, don't run 'make check'
 100 as root because it confuses some of the tests.
 101
 102 NOTE: Despite our best efforts it's entirely possible to have
 103 problems when using older versions of autoconf, automake, or
 104 libtool.  If you have the latest versions and still can't get it
 105 to work, see the next section on Makefile.lite.
 106
 107 There are a few FLAC-specific arguments you can give to
 108 `configure':
 109
 110 --enable-debug : Builds everything with debug symbols and some
 111 extra (and more verbose) error checking.
 112
 113 --disable-asm-optimizations : Disables the compilation of the
 114 assembly routines.  Many routines have assembly versions for
 115 speed and `configure' is pretty good about knowing what is
 116 supported, but you can use this option to build only from the
 117 C sources.
 118
 119 --enable-sse : If you are building for an x86 CPU that supports
 120 SSE instructions, you can enable some of the faster routines
 121 if your operating system also supports SSE instructions.  flac
 122 can tell if the CPU supports the instructions but currently has
 123 no way to test if the OS does, so if it does, you must pass
 124 this argument to configure to use the SSE routines.  If flac
 125 crashes when built with this option you will have to go back and
 126 configure without --enable-sse.  Note that
 127 --disable-asm-optimizations implies --disable-sse.
 128
 129 --enable-local-xmms-plugin : Installs the FLAC XMMS plugin in
 130 $HOME/.xmms/Plugins, instead of the global XMMS plugin area
 131 (usually /usr/lib/xmms/Input).
 132
 133 --with-ogg=
 134 --with-xmms-prefix=
 135 --with-libiconv-prefix=
 136 Use these if you have these packages but configure can't find them.
 137
 138 If you want to build completely from scratch (i.e. starting with just
 139 configure.in and Makefile.am) you should be able to just run 'autogen.sh'
 140 but make sure and read the comments in that file first.
 141
 142
 143 ===============================================================================
 144 Building with Makefile.lite
 145 ===============================================================================
 146
 147 There is a more lightweight build system for do-it-yourself-ers.
 148 It is also useful if configure isn't working, which may be the
 149 case since lately we've had some problems with different versions
 150 of automake and libtool.  The Makefile.lite system should work
 151 on GNU systems with few or no adjustments.
 152
 153 From the top level just 'make -f Makefile.lite'.  You can
 154 specify zero or one optional target from 'release', 'debug',
 155 'test', or 'clean'.  The default is 'release'.  There is no
 156 'install' target but everything you need will end up in the
 157 obj/ directory.
 158
 159 If you are not on an x86 system or you don't have nasm, you
 160 may have to change the DEFINES in src/libFLAC/Makefile.lite.  If
 161 you don't have nasm, remove -DFLAC__HAS_NASM.  If your target is
 162 not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.
 163
 164
 165 ===============================================================================
 166 Building with MSVC
 167 ===============================================================================
 168
 169 There are .dsp projects and a master FLAC.dsw workspace to build all
 170 the libraries and executables with MSVC6.  There are also .vcproj
 171 projects and a master FLAC.sln solution to build all the libraries and
 172 executables with VC++ 2005.
 173
 174 Prerequisite: you must have the Ogg libraries installed as described
 175 later.
 176
 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.
 180
 181 MSVC6:
 182 To build everything, run Developer Studio, do File|Open Workspace,
 183 and open FLAC.dsw.  Select "Build | Set active configuration..."
 184 from the menu, then in the dialog, select "All - Win32 Release" (or
 185 Debug if you prefer).  Click "Ok" then hit F7 to build.
 186
 187 VC++ 2005:
 188 To build everything, run Visual Studio, do File|Open and open FLAC.sln.
 189 From the dropdown in the toolbar, select "Release" instead of "Debug",
 190 then hit F7 to build.
 191
 192 Either way, this will build all libraries both statically (e.g.
 193 obj\release\lib\libFLAC_static.lib) and as DLLs (e.g.
 194 obj\release\lib\libFLAC.dll), and it will build all binaries, statically
 195 linked (e.g. obj\release\bin\flac.exe).
 196
 197 Everything will end up in the "obj" directory.  DLLs and .exe files
 198 are all that are needed and can be copied to an installation area and
 199 added to the PATH.  The plugins have to be copied to their appropriate
 200 place in the player area.  For Winamp2 this is <winamp2-dir>\Plugins.
 201
 202 By default the code is configured with Ogg support.  Before building FLAC
 203 you will need to get the Ogg source distribution
 204 (see http://xiph.org/ogg/vorbis/download/), build ogg_static.lib (load and
 205 build win32\ogg_static.dsp), copy ogg_static.lib into FLAC's
 206 'obj\release\lib' directory, and copy the entire include\ogg tree into
 207 FLAC's 'include' directory (so that there is an 'ogg' directory in FLAC's
 208 'include' directory with the files ogg.h, os_types.h and config_types.h).
 209
 210 If you want to build without Ogg support, instead edit all .dsp or
 211 .vcproj files and remove any occurrences of "/D FLAC__HAS_OGG".
 212
 213
 214 ===============================================================================
 215 Building on Mac OS X
 216 ===============================================================================
 217
 218 If you have Fink or a recent version of OS X with the proper autotooles,
 219 the GNU flow above should work.  The Project Builder project has been
 220 deprecated but we are working on replacing it with an Xcode equivalent.
 221
 222
 223 ===============================================================================
 224 Note to embedded developers
 225 ===============================================================================
 226
 227 libFLAC has grown larger over time as more functionality has been
 228 included, but much of it may be unnecessary for a particular embedded
 229 implementation.  Unused parts may be pruned by some simple editing of
 230 configure.in and src/libFLAC/Makefile.am; the following dependency
 231 graph shows which modules may be pruned without breaking things
 232 further down:
 233
 234 stream_encoder.h
 235         stream_decoder.h
 236         format.h
 237
 238 stream_decoder.h
 239         format.h
 240
 241 metadata.h
 242         format.h
 243
 244 In other words, for pure decoding applications, both the stream encoder
 245 and metadata editing interfaces can be safely removed.
 246
 247 There is a section dedicated to embedded use in the libFLAC API
 248 HTML documentation (see doc/html/api/index.html).