README

   1 /* FLAC - Free Lossless Audio Codec
   2  * Copyright (C) 2001,2002,2003  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  */
  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 Xiph.org's BSD-like license (see COPYING.Xiph).  All other
  36 programs and plugins are licensed under the GNU General Public License
  37 (see COPYING.GPL).  The documentation is licensed under the GNU Free
  38 Documentation License (see COPYING.FDL).
  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 Even though it will stop with an explicit message on any failure, it
  86 does print out a lot of stuff so you might want to capture the output
  87 to a file if you're having a problem.  Also, don't run 'make check'
  88 as root because it confuses some of the tests.
  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 now .dsp projects and a master FLAC.dsw workspace to build
 159 all the libraries and executables.
 160
 161 Prerequisite: you must have the Ogg libraries installed as described
 162 later.
 163
 164 Prerequisite: you must have nasm installed, and have the environment
 165 variable FLAC_NASM set to the full path to nasmw.exe, e.g
 166
 167 C:\nasm\nasmw.exe
 168
 169 To build everything, run Developer Studio, do File|Open Workspace,
 170 and open FLAC.dsw.  Select "Build | Set active configuration..."
 171 from the menu, then in the dialog, select "All - Win32 Release" (or
 172 Debug if you prefer).  Click "Ok" then hit F7 to build. This will build
 173 all libraries both statically (e.g. obj\release\lib\libFLAC_static.lib)
 174 and as DLLs (e.g.  obj\release\bin\libFLAC.dll), and it will build all
 175 binaries, statically linked (e.g. obj\release\bin\flac.exe).
 176
 177 Everything will end up in the "obj" directory.  DLLs and .exe files
 178 are all that are needed and can be copied to an installation area and
 179 added to the PATH.  The plugins have to be copied to their appropriate
 180 place in the player area.  For Winamp2 this is <winamp2-dir>\Plugins
 181 and for Winamp3 this is <winamp3-dir>\Wacs.
 182
 183 By default the code is configured with Ogg support.  Before building FLAC
 184 you will need to get the Ogg source distribution
 185 (see http://xiph.org/ogg/vorbis/download/), build ogg_static.lib (load and
 186 build win32\ogg_static.dsp), copy ogg_static.lib into FLAC's
 187 'obj\release\lib' directory, and copy the entire include\ogg tree into
 188 FLAC's 'include' directory (so that there is an 'ogg' directory in FLAC's
 189 'include' directory with the files ogg.h, os_types.h and config_types.h).
 190
 191
 192 ===============================================================================
 193 Building on Mac OS X
 194 ===============================================================================
 195
 196 If you have Fink, the GNU flow above should work.  Otherwise,
 197 there is a Project Builder project in the top-level source
 198 directory to build libFLAC and the command-line utilities on
 199 Mac OS X.  In a terminal, cd to the top-level directory (the
 200 one that contains this README file) and type:
 201
 202         pbxbuild -alltargets
 203
 204 This will create everything and leave it in the build/ directory.
 205 Don't worry about the rest of the stuff that is in build/ or
 206 the stuff that was already there before building.
 207
 208 There currently is no install procedure; you will have to
 209 manually copy the tools to wherever you need them.
 210
 211
 212 ===============================================================================
 213 Note to embedded developers
 214 ===============================================================================
 215
 216 libFLAC has grown larger over time as more functionality has been
 217 included, but much of it may be unnecessary for a particular embedded
 218 implementation.  Unused parts may be pruned by some simple editing of
 219 configure.in and src/libFLAC/Makefile.am; the following dependency
 220 graph shows which modules may be pruned without breaking things
 221 further down:
 222
 223 file_encoder.h
 224         stream_encoder.h
 225                 format.h
 226
 227 file_decoder.h
 228         seekable_stream_decoder.h
 229                 stream_decoder.h
 230                         format.h
 231
 232 metadata.h
 233         format.h
 234
 235 There is a section dedicated to embedded use in the libFLAC API
 236 HTML documentation (see doc/html/api/index.html).