README

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