README

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