README

   1 /* FLAC - Free Lossless Audio Codec
   2  * Copyright (C) 2001,2002  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, licensed under the GNU
  26     Lesser General Public License (LGPL)
  27   * `libFLAC++', a C++ object wrapper library around libFLAC
  28   * `flac', a command-line program for encoding and decoding files,
  29     licensed under the GNU General public License (GPL)
  30   * `metaflac', a command-line program for editing FLAC metadata,
  31     licensed under the GPL
  32   * player plugins for XMMS and Winamp, licensed under the GPL
  33   * documentation, licensed under the GNU Free Documentation License.
  34
  35 ===============================================================================
  36 FLAC - 1.0.3 - Contents
  37 ===============================================================================
  38
  39 - Introduction
  40 - Building in a GNU environment
  41 - Building with Makefile.lite
  42 - Building with MSVC
  43 - Building on Mac OS X
  44 - Note to embedded developers
  45
  46
  47 ===============================================================================
  48 Introduction
  49 ===============================================================================
  50
  51 This is the source release for the FLAC project.  See
  52
  53         doc/index.html
  54
  55 for full documentation.
  56
  57 A brief description of the directory tree:
  58
  59         doc/          the HTML documentation
  60         flac.pbproj/  the Mac OS X Project Builder project
  61         include/      public include files for libFLAC and libFLAC++
  62         man/          the man page for `flac'
  63         src/          the source code and private headers
  64         test/         the test scripts
  65
  66
  67 ===============================================================================
  68 Building in a GNU environment
  69 ===============================================================================
  70
  71 FLAC uses autoconf and libtool for configuring and building.
  72 Better documentation for these will be forthcoming, but in
  73 general, this should work:
  74
  75 ./configure && make && make install
  76
  77 NOTE: Despite our best efforts it's entirely possible to have
  78 problems when using older versions of autoconf, automake, or
  79 libtool.  If you have the latest versions and still can't get it
  80 to work, see the next section on Makefile.lite.
  81
  82 There are a few FLAC-specific arguments you can give to
  83 `configure':
  84
  85 --enable-debug : Builds everything with debug symbols and some
  86 extra (and more verbose) error checking.
  87
  88 --disable-asm-optimizations : Disables the compilation of the
  89 assembly routines.  Many routines have assembly versions for
  90 speed and `configure' is pretty good about knowing what is
  91 supported, but you can use this option to build only from the
  92 C sources.
  93
  94 --enable-sse : If you are building for an x86 CPU that supports
  95 SSE instructions, you can enable some of the faster routines
  96 if your operating system also supports SSE instructions.  flac
  97 can tell if the CPU supports the instructions but currently has
  98 no way to test if the OS does, so if it does, you must pass
  99 this argument to configure to use the SSE routines.  If flac
 100 crashes when built with this option you will have to go back and
 101 configure without --enable-sse.  Note that
 102 --disable-asm-optimizations implies --disable-sse.
 103
 104 --enable-3dnow : If you are building for an AMD CPU which has 3DNOW!
 105 support, you can use this flag to enable some assembly routines
 106 which use 3DNOW! instructions.  There have been some reports that
 107 they may cause flac to crash, which is why it is not turned on
 108 by default.  Note that --disable-asm-optimizations overrides
 109 --enable-3dnow.
 110
 111
 112 ===============================================================================
 113 Building with Makefile.lite
 114 ===============================================================================
 115
 116 There is a more lightweight build system for do-it-yourself-ers.
 117 It is also useful if configure isn't working, which may be the
 118 case since lately we've had some problems with different versions
 119 of automake and libtool.  The Makefile.lite system should work
 120 on Gnu systems with few or no adjustments.
 121
 122 From the top level just 'make -f Makefile.lite'.  You can
 123 specify zero or one optional target from 'release', 'debug',
 124 'test', or 'clean'.  The default is 'release'.  There is no
 125 'install' target but everything you need will end up in the
 126 obj/ directory.
 127
 128 If you are not on an x86 system or you don't have nasm, you
 129 may have to change the DEFINES in src/libFLAC/Makefile.lite.  If
 130 you don't have nasm, remove -DFLAC__HAS_NASM.  If your target is
 131 not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.
 132
 133
 134 ===============================================================================
 135 Building with MSVC
 136 ===============================================================================
 137
 138 There is no overall make system for MSVC but the individual
 139 source directories with a 'Makefile.vc' file in them allow
 140 building with MSVC.  Just 'nmake /f Makefile.vc'.  Currently
 141 the Makefile.vc for libFLAC is hardcoded to use nasm.  If
 142 you don't have nasm, or don't want any assembly optimizations,
 143 edit the makefile, adding '/D FLAC__NO_ASM', and delete the
 144 rules which compile the .nasm files.
 145
 146
 147 ===============================================================================
 148 Building on Mac OS X
 149 ===============================================================================
 150
 151 If you have Fink, the Gnu flow above should work.  Otherwise,
 152 there is a Project Builder project in the top-level source
 153 directory to build libFLAC and the command-line utilities on
 154 Mac OS X.  In a terminal, cd to the top-level directory (the
 155 one that contains this README file) and type:
 156
 157         pbxbuild -alltargets
 158
 159 This will create everything and leave it in the build/ directory.
 160 Don't worry about the rest of the stuff that is in build/ or
 161 the stuff that was already there before building.
 162
 163 There currently is no install procedure; you will have to
 164 manually copy the tools to wherever you need them.
 165
 166
 167 ===============================================================================
 168 Note to embedded developers
 169 ===============================================================================
 170
 171 libFLAC has grown larger over time as more functionality has been
 172 included, but much of it may be unnecessary for a particular embedded
 173 implementation.  Unused parts may be pruned by some simple editing of
 174 configure.in and src/libFLAC/Makefile.am; the following dependency
 175 graph shows which modules may be pruned without breaking things
 176 further down:
 177
 178 file_encoder.h
 179         stream_encoder.h
 180                 format.h
 181
 182 file_decoder.h
 183         seekable_stream_decoder.h
 184                 stream_decoder.h
 185                         format.h
 186
 187 metadata.h
 188         format.h
 189
 190 There is a section dedicated to embedded use in the libFLAC API
 191 HTML documentation (see doc/html/api/index.html).