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 - 0.10
  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 now uses autoconf and libtool for configuring and
  55 building.  Better documentation for these will be
  56 forthcoming, but in general, this should work:
  57
  58 ./configure ; make ; make install
  59
  60 To disable all assembly optimizations, pass the
  61 --disable-asm-optimizations flag to configure.
  62
  63
  64 ==================
  65 Building with MSVC
  66 ==================
  67
  68 There is no overall make system for MSVC but the individual
  69 source directories with a 'Makefile.vc' file in them allow
  70 building with MSVC.  Just 'nmake /f Makefile.vc'.  Currently
  71 the Makefile.vc for libFLAC is hardcoded to use nasm.  If
  72 you don't have nasm, or don't want any assembly optimizations,
  73 edit the makefile, adding '/D FLAC__NO_ASM' and delete the
  74 rules which compile the .s files.