FLAC is comprised of
* `libFLAC', a library which implements reference encoders and
- decoders, and a metadata interface, licensed under the GNU
- Lesser General Public License (LGPL)
+ decoders, and a metadata interface
* `libFLAC++', a C++ object wrapper library around libFLAC
- * `flac', a command-line program for encoding and decoding files,
- licensed under the GNU General public License (GPL)
- * `metaflac', a command-line program for editing FLAC metadata,
- licensed under the GPL
- * player plugins for XMMS and Winamp, licensed under the GPL
- * documentation, licensed under the GNU Free Documentation License.
+ * `libOggFLAC' and `libOggFLAC++', which provide encoders and
+ decoders for FLAC streams in an Ogg container
+ * `flac', a command-line program for encoding and decoding files
+ * `metaflac', a command-line program for editing FLAC metadata
+ * player plugins for XMMS and Winamp
+ * user and API documentation
-============
-FLAC - 1.0.3
-============
+The libraries (libFLAC, libFLAC++, libOggFLAC, and libOggFLAC++) are
+licensed under the GNU Lesser General Public License (LGPL). All other
+programs and plugins are licensed under the GNU General Public License
+(GPL). The documentation is licensed under the GNU Free Documentation
+License (GFDL).
+
+
+===============================================================================
+FLAC - 1.0.4 - Contents
+===============================================================================
+
+- Introduction
+- Building in a GNU environment
+- Building with Makefile.lite
+- Building with MSVC
+- Building on Mac OS X
+- Note to embedded developers
+
+
+===============================================================================
+Introduction
+===============================================================================
This is the source release for the FLAC project. See
test/ the test scripts
-=============================
+===============================================================================
Building in a GNU environment
-=============================
+===============================================================================
FLAC uses autoconf and libtool for configuring and building.
Better documentation for these will be forthcoming, but in
general, this should work:
-./configure && make && make install
+./configure && make && make check && make install
+
+The 'make check' step is optional; omit it to skip all the tests,
+which can take several hours.
NOTE: Despite our best efforts it's entirely possible to have
problems when using older versions of autoconf, automake, or
by default. Note that --disable-asm-optimizations overrides
--enable-3dnow.
+--with-ogg=
+--with-id3lib=
+--with-xmms-prefix=
+--with-libiconv-prefix=
+Use these if you have these packages but configure can't find them.
-===========================
+
+===============================================================================
Building with Makefile.lite
-===========================
+===============================================================================
There is a more lightweight build system for do-it-yourself-ers.
It is also useful if configure isn't working, which may be the
not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN.
-==================
+===============================================================================
Building with MSVC
-==================
+===============================================================================
+
+There are two ways to build with MSVC:
+@@@@Prerequisite: Ogg headers/libs
+
+ 1. Project Files
+ ----------------
+ Prerequisite: you must have nasm installed, and have the environment
+ variable FLAC_NASM set to the full path to nasmw.exe, e.g
+
+ C:\nasm\nasmw.exe
+
+ To build everything, run Developer Studio, do File|Open Workspace,
+ and open FLAC.dsw. Switch to the 'Files' tab, select 'all files'
+ from the tree, do right-mouse-button and 'Set as active project'.
+ The default build mode will probably be Debug; to change to release
+ do Build|Set Active Configuration and select 'all - Win32 Release'.
+ Then do Project|Build. The libraries will be built as and DLLs and
+ you'll need to install these as well.
+
+ 2. nmake
+ --------
+ Prerequisite: you must have nasm installed and nasmw.exe must be in
+ your path.
-There is no overall make system for MSVC but the individual
-source directories with a 'Makefile.vc' file in them allow
-building with MSVC. Just 'nmake /f Makefile.vc'. Currently
-the Makefile.vc for libFLAC is hardcoded to use nasm. If
-you don't have nasm, or don't want any assembly optimizations,
-edit the makefile, adding '/D FLAC__NO_ASM', and delete the
-rules which compile the .nasm files.
+ To build everything, open a Command window, cd to the top-level
+ directory (where this README is) and do
+ nmake /f Makefile.vc
-====================
+ This will recur into all the source directories in the right order
+ and build everything. The libraries will be build only as static
+ libs. You need only to install the binaries. To clean up everything
+ you can do
+
+ nmake /f Makefile.vc clean
+
+ from the top level directory, or any directory which has a
+ Makefile.vc
+
+Everything will end up in the 'obj' directory. DLLs and .exe files
+are all that are needed and can be copied to an installation area an
+added to the PATH. The plugins have to be copied to their appropriate
+place in the player area. For Winamp2 this is <winamp2-dir>\Plugins
+and for Winamp3 this is <winamp3-dir>\Wacs.
+
+
+===============================================================================
Building on Mac OS X
-====================
+===============================================================================
If you have Fink, the Gnu flow above should work. Otherwise,
there is a Project Builder project in the top-level source
There currently is no install procedure; you will have to
manually copy the tools to wherever you need them.
+
+
+===============================================================================
+Note to embedded developers
+===============================================================================
+
+libFLAC has grown larger over time as more functionality has been
+included, but much of it may be unnecessary for a particular embedded
+implementation. Unused parts may be pruned by some simple editing of
+configure.in and src/libFLAC/Makefile.am; the following dependency
+graph shows which modules may be pruned without breaking things
+further down:
+
+file_encoder.h
+ stream_encoder.h
+ format.h
+
+file_decoder.h
+ seekable_stream_decoder.h
+ stream_decoder.h
+ format.h
+
+metadata.h
+ format.h
+
+There is a section dedicated to embedded use in the libFLAC API
+HTML documentation (see doc/html/api/index.html).