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
  37 ============
  38
  39 This is the source release for the FLAC project.  See
  40
  41         doc/index.html
  42
  43 for full documentation.
  44
  45 A brief description of the directory tree:
  46
  47         doc/          the HTML documentation
  48         flac.pbproj/  the Mac OS X Project Builder project
  49         include/      public include files for libFLAC and libFLAC++
  50         man/          the man page for `flac'
  51         src/          the source code and private headers
  52         test/         the test scripts
  53
  54
  55 =============================
  56 Building in a GNU environment
  57 =============================
  58
  59 FLAC uses autoconf and libtool for configuring and building.
  60 Better documentation for these will be forthcoming, but in
  61 general, this should work:
  62
  63 ./configure && make && make install
  64
  65 NOTE: Despite our best efforts it's entirely possible to have
  66 problems when using older versions of autoconf, automake, or
  67 libtool.  If you have the latest versions and still can't get it
  68 to work, see the next section on Makefile.lite.
  69
  70 There are a few FLAC-specific arguments you can give to
  71 `configure':
  72
  73 --enable-debug : Builds everything with debug symbols and some
  74 extra (and more verbose) error checking.
  75
  76 --disable-asm-optimizations : Disables the compilation of the
  77 assembly routines.  Many routines have assembly versions for
  78 speed and `configure' is pretty good about knowing what is
  79 supported, but you can use this option to build only from the
  80 C sources.
  81
  82 --enable-sse : If you are building for an x86 CPU that supports
  83 SSE instructions, you can enable some of the faster routines
  84 if your operating system also supports SSE instructions.  flac
  85 can tell if the CPU supports the instructions but currently has
  86 no way to test if the OS does, so if it does, you must pass
  87 this argument to configure to use the SSE routines.  If flac
  88 crashes when built with this option you will have to go back and
  89 configure without --enable-sse.  Note that
  90 --disable-asm-optimizations implies --disable-sse.
  91
  92 --enable-3dnow : If you are building for an AMD CPU which has 3DNOW!
  93 support, you can use this flag to enable some assembly routines
  94 which use 3DNOW! instructions.  There have been some reports that
  95 they may cause flac to crash, which is why it is not turned on
  96 by default.  Note that --disable-asm-optimizations overrides
  97 --enable-3dnow.
  98
  99
 100 ===========================
 101 Building with Makefile.lite
 102 ===========================
 103
 104 There is a more lightweight build system for do-it-yourself-ers.
 105 It is also useful if configure isn't working, which may be the
 106 case since lately we've had some problems with different versions
 107 of automake and libtool.  The Makefile.lite system should work
 108 on Gnu systems with few or no adjustments.
 109
 110 From the top level just 'make -f Makefile.lite'.  You can
 111 specify zero or one optional target from 'release', 'debug',
 112 'test', or 'clean'.  The default is 'release'.  There is no
 113 'install' target but everything you need will end up in the
 114 obj/ directory.
 115
 116 If you are not on an x86 system or you don't have nasm, you
 117 may have to change the DEFINES in src/libFLAC/Makefile.lite.  If
 118 you don't have nasm, remove -DFLAC__HAS_NASM.  If your target is
 119 not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.
 120
 121
 122 ==================
 123 Building with MSVC
 124 ==================
 125
 126 There is no overall make system for MSVC but the individual
 127 source directories with a 'Makefile.vc' file in them allow
 128 building with MSVC.  Just 'nmake /f Makefile.vc'.  Currently
 129 the Makefile.vc for libFLAC is hardcoded to use nasm.  If
 130 you don't have nasm, or don't want any assembly optimizations,
 131 edit the makefile, adding '/D FLAC__NO_ASM', and delete the
 132 rules which compile the .nasm files.
 133
 134
 135 ====================
 136 Building on Mac OS X
 137 ====================
 138
 139 If you have Fink, the Gnu flow above should work.  Otherwise,
 140 there is a Project Builder project in the top-level source
 141 directory to build libFLAC and the command-line utilities on
 142 Mac OS X.  In a terminal, cd to the top-level directory (the
 143 one that contains this README file) and type:
 144
 145         pbxbuild -alltargets
 146
 147 This will create everything and leave it in the build/ directory.
 148 Don't worry about the rest of the stuff that is in build/ or
 149 the stuff that was already there before building.
 150
 151 There currently is no install procedure; you will have to
 152 manually copy the tools to wherever you need them.