Josh Coalson | 6b05bc5 | 2001-06-08 00:13:21 +0000 | [diff] [blame] | 1 | /* FLAC - Free Lossless Audio Codec |
Josh Coalson | 9564390 | 2004-01-17 04:14:43 +0000 | [diff] [blame] | 2 | * Copyright (C) 2001,2002,2003,2004 Josh Coalson |
Josh Coalson | 6b05bc5 | 2001-06-08 00:13:21 +0000 | [diff] [blame] | 3 | * |
Josh Coalson | e8a7601 | 2003-02-07 00:14:32 +0000 | [diff] [blame] | 4 | * This file is part the FLAC project. FLAC is comprised of several |
| 5 | * components distributed under difference licenses. The codec libraries |
| 6 | * are distributed under Xiph.Org's BSD-like license (see the file |
| 7 | * COPYING.Xiph in this distribution). All other programs, libraries, and |
| 8 | * plugins are distributed under the GPL (see COPYING.GPL). The documentation |
| 9 | * is distributed under the Gnu FDL (see COPYING.FDL). Each file in the |
| 10 | * FLAC distribution contains at the top the terms under which it may be |
| 11 | * distributed. |
Josh Coalson | 6b05bc5 | 2001-06-08 00:13:21 +0000 | [diff] [blame] | 12 | * |
Josh Coalson | e8a7601 | 2003-02-07 00:14:32 +0000 | [diff] [blame] | 13 | * Since this particular file is relevant to all components of FLAC, |
| 14 | * it may be distributed under the Xiph.Org license, which is the least |
| 15 | * restrictive of those mentioned above. See the file COPYING.Xiph in this |
| 16 | * distribution. |
Josh Coalson | 6b05bc5 | 2001-06-08 00:13:21 +0000 | [diff] [blame] | 17 | */ |
| 18 | |
| 19 | |
| 20 | FLAC (http://flac.sourceforge.net/) is an Open Source lossless audio |
| 21 | codec developed by Josh Coalson. |
| 22 | |
Josh Coalson | bc86950 | 2002-06-14 06:36:16 +0000 | [diff] [blame] | 23 | FLAC is comprised of |
| 24 | * `libFLAC', a library which implements reference encoders and |
Josh Coalson | 0c3524c | 2002-08-22 04:21:54 +0000 | [diff] [blame] | 25 | decoders, and a metadata interface |
Josh Coalson | bc86950 | 2002-06-14 06:36:16 +0000 | [diff] [blame] | 26 | * `libFLAC++', a C++ object wrapper library around libFLAC |
Josh Coalson | 0c3524c | 2002-08-22 04:21:54 +0000 | [diff] [blame] | 27 | * `libOggFLAC' and `libOggFLAC++', which provide encoders and |
| 28 | decoders for FLAC streams in an Ogg container |
| 29 | * `flac', a command-line program for encoding and decoding files |
Josh Coalson | cf3f338 | 2003-09-24 04:36:57 +0000 | [diff] [blame] | 30 | * `metaflac', a command-line program for viewing and editing FLAC |
| 31 | metadata |
Josh Coalson | 0c3524c | 2002-08-22 04:21:54 +0000 | [diff] [blame] | 32 | * player plugins for XMMS and Winamp |
| 33 | * user and API documentation |
| 34 | |
| 35 | The libraries (libFLAC, libFLAC++, libOggFLAC, and libOggFLAC++) are |
Josh Coalson | afd8107 | 2003-01-31 23:34:56 +0000 | [diff] [blame] | 36 | licensed under Xiph.org's BSD-like license (see COPYING.Xiph). All other |
Josh Coalson | 0c3524c | 2002-08-22 04:21:54 +0000 | [diff] [blame] | 37 | programs and plugins are licensed under the GNU General Public License |
Josh Coalson | afd8107 | 2003-01-31 23:34:56 +0000 | [diff] [blame] | 38 | (see COPYING.GPL). The documentation is licensed under the GNU Free |
| 39 | Documentation License (see COPYING.FDL). |
Josh Coalson | 0c3524c | 2002-08-22 04:21:54 +0000 | [diff] [blame] | 40 | |
Josh Coalson | 6b05bc5 | 2001-06-08 00:13:21 +0000 | [diff] [blame] | 41 | |
Josh Coalson | 310b9ec | 2002-07-31 06:39:21 +0000 | [diff] [blame] | 42 | =============================================================================== |
Josh Coalson | 3e2a733 | 2004-03-16 18:18:04 +0000 | [diff] [blame] | 43 | FLAC - CVS-20040316 - Contents |
Josh Coalson | 310b9ec | 2002-07-31 06:39:21 +0000 | [diff] [blame] | 44 | =============================================================================== |
| 45 | |
| 46 | - Introduction |
| 47 | - Building in a GNU environment |
| 48 | - Building with Makefile.lite |
| 49 | - Building with MSVC |
| 50 | - Building on Mac OS X |
| 51 | - Note to embedded developers |
| 52 | |
| 53 | |
| 54 | =============================================================================== |
| 55 | Introduction |
| 56 | =============================================================================== |
Josh Coalson | bb7f6b9 | 2000-12-10 04:09:52 +0000 | [diff] [blame] | 57 | |
Josh Coalson | 6b05bc5 | 2001-06-08 00:13:21 +0000 | [diff] [blame] | 58 | This is the source release for the FLAC project. See |
Josh Coalson | bb7f6b9 | 2000-12-10 04:09:52 +0000 | [diff] [blame] | 59 | |
| 60 | doc/index.html |
| 61 | |
| 62 | for full documentation. |
| 63 | |
| 64 | A brief description of the directory tree: |
| 65 | |
Josh Coalson | 917df86 | 2002-07-03 07:39:05 +0000 | [diff] [blame] | 66 | doc/ the HTML documentation |
| 67 | flac.pbproj/ the Mac OS X Project Builder project |
| 68 | include/ public include files for libFLAC and libFLAC++ |
| 69 | man/ the man page for `flac' |
| 70 | src/ the source code and private headers |
| 71 | test/ the test scripts |
Josh Coalson | bb7f6b9 | 2000-12-10 04:09:52 +0000 | [diff] [blame] | 72 | |
| 73 | |
Josh Coalson | 310b9ec | 2002-07-31 06:39:21 +0000 | [diff] [blame] | 74 | =============================================================================== |
Josh Coalson | bb7f6b9 | 2000-12-10 04:09:52 +0000 | [diff] [blame] | 75 | Building in a GNU environment |
Josh Coalson | 310b9ec | 2002-07-31 06:39:21 +0000 | [diff] [blame] | 76 | =============================================================================== |
Josh Coalson | bb7f6b9 | 2000-12-10 04:09:52 +0000 | [diff] [blame] | 77 | |
Josh Coalson | 172ac00 | 2001-10-31 18:30:19 +0000 | [diff] [blame] | 78 | FLAC uses autoconf and libtool for configuring and building. |
| 79 | Better documentation for these will be forthcoming, but in |
| 80 | general, this should work: |
Josh Coalson | bb7f6b9 | 2000-12-10 04:09:52 +0000 | [diff] [blame] | 81 | |
Josh Coalson | c220cf4 | 2002-08-23 06:41:31 +0000 | [diff] [blame] | 82 | ./configure && make && make check && make install |
| 83 | |
| 84 | The 'make check' step is optional; omit it to skip all the tests, |
Josh Coalson | ccea6aa | 2002-12-17 08:14:42 +0000 | [diff] [blame] | 85 | which can take several hours and use around 70-80 megs of disk space. |
Josh Coalson | 9d260d8 | 2003-08-28 23:47:15 +0000 | [diff] [blame] | 86 | Even though it will stop with an explicit message on any failure, it |
| 87 | does print out a lot of stuff so you might want to capture the output |
| 88 | to a file if you're having a problem. Also, don't run 'make check' |
| 89 | as root because it confuses some of the tests. |
Josh Coalson | bfe42f1 | 2000-12-22 22:42:25 +0000 | [diff] [blame] | 90 | |
Josh Coalson | 917df86 | 2002-07-03 07:39:05 +0000 | [diff] [blame] | 91 | NOTE: Despite our best efforts it's entirely possible to have |
| 92 | problems when using older versions of autoconf, automake, or |
| 93 | libtool. If you have the latest versions and still can't get it |
| 94 | to work, see the next section on Makefile.lite. |
Josh Coalson | 0403256 | 2001-07-20 23:43:15 +0000 | [diff] [blame] | 95 | |
Josh Coalson | 3643db3 | 2001-07-18 00:23:06 +0000 | [diff] [blame] | 96 | There are a few FLAC-specific arguments you can give to |
| 97 | `configure': |
| 98 | |
| 99 | --enable-debug : Builds everything with debug symbols and some |
| 100 | extra (and more verbose) error checking. |
| 101 | |
| 102 | --disable-asm-optimizations : Disables the compilation of the |
| 103 | assembly routines. Many routines have assembly versions for |
| 104 | speed and `configure' is pretty good about knowing what is |
| 105 | supported, but you can use this option to build only from the |
| 106 | C sources. |
| 107 | |
Josh Coalson | e326848 | 2001-12-04 06:46:12 +0000 | [diff] [blame] | 108 | --enable-sse : If you are building for an x86 CPU that supports |
Josh Coalson | 3643db3 | 2001-07-18 00:23:06 +0000 | [diff] [blame] | 109 | SSE instructions, you can enable some of the faster routines |
| 110 | if your operating system also supports SSE instructions. flac |
| 111 | can tell if the CPU supports the instructions but currently has |
| 112 | no way to test if the OS does, so if it does, you must pass |
| 113 | this argument to configure to use the SSE routines. If flac |
| 114 | crashes when built with this option you will have to go back and |
Josh Coalson | e326848 | 2001-12-04 06:46:12 +0000 | [diff] [blame] | 115 | configure without --enable-sse. Note that |
| 116 | --disable-asm-optimizations implies --disable-sse. |
Josh Coalson | 9e6efb6 | 2001-05-29 18:48:42 +0000 | [diff] [blame] | 117 | |
Josh Coalson | 3d73072 | 2003-01-14 06:59:50 +0000 | [diff] [blame] | 118 | --enable-local-xmms-plugin : Installs the FLAC XMMS plugin in |
| 119 | $HOME/.xmms/Plugins, instead of the global XMMS plugin area |
| 120 | (usually /usr/lib/xmms/Input). |
Josh Coalson | c69f878 | 2001-11-13 23:08:22 +0000 | [diff] [blame] | 121 | |
Josh Coalson | 822eef6 | 2002-09-12 06:40:44 +0000 | [diff] [blame] | 122 | --with-ogg= |
| 123 | --with-id3lib= |
| 124 | --with-xmms-prefix= |
| 125 | --with-libiconv-prefix= |
| 126 | Use these if you have these packages but configure can't find them. |
| 127 | |
Josh Coalson | 71fb9ff | 2002-12-03 06:29:10 +0000 | [diff] [blame] | 128 | If you want to build completely from scratch (i.e. starting with just |
| 129 | configure.in and Makefile.am) you should be able to just run 'autogen.sh' |
| 130 | but make sure and read the comments in that file first. |
| 131 | |
Josh Coalson | bb7f6b9 | 2000-12-10 04:09:52 +0000 | [diff] [blame] | 132 | |
Josh Coalson | 310b9ec | 2002-07-31 06:39:21 +0000 | [diff] [blame] | 133 | =============================================================================== |
Josh Coalson | 0403256 | 2001-07-20 23:43:15 +0000 | [diff] [blame] | 134 | Building with Makefile.lite |
Josh Coalson | 310b9ec | 2002-07-31 06:39:21 +0000 | [diff] [blame] | 135 | =============================================================================== |
Josh Coalson | 0403256 | 2001-07-20 23:43:15 +0000 | [diff] [blame] | 136 | |
| 137 | There is a more lightweight build system for do-it-yourself-ers. |
| 138 | It is also useful if configure isn't working, which may be the |
| 139 | case since lately we've had some problems with different versions |
| 140 | of automake and libtool. The Makefile.lite system should work |
Josh Coalson | 71fb9ff | 2002-12-03 06:29:10 +0000 | [diff] [blame] | 141 | on GNU systems with few or no adjustments. |
Josh Coalson | 0403256 | 2001-07-20 23:43:15 +0000 | [diff] [blame] | 142 | |
| 143 | From the top level just 'make -f Makefile.lite'. You can |
| 144 | specify zero or one optional target from 'release', 'debug', |
| 145 | 'test', or 'clean'. The default is 'release'. There is no |
| 146 | 'install' target but everything you need will end up in the |
| 147 | obj/ directory. |
| 148 | |
| 149 | If you are not on an x86 system or you don't have nasm, you |
| 150 | may have to change the DEFINES in src/libFLAC/Makefile.lite. If |
| 151 | you don't have nasm, remove -DFLAC__HAS_NASM. If your target is |
| 152 | not an x86, change -DFLAC__CPU_IA32 to -DFLAC__CPU_UNKNOWN. |
| 153 | |
| 154 | |
Josh Coalson | 310b9ec | 2002-07-31 06:39:21 +0000 | [diff] [blame] | 155 | =============================================================================== |
Josh Coalson | bb7f6b9 | 2000-12-10 04:09:52 +0000 | [diff] [blame] | 156 | Building with MSVC |
Josh Coalson | 310b9ec | 2002-07-31 06:39:21 +0000 | [diff] [blame] | 157 | =============================================================================== |
Josh Coalson | bb7f6b9 | 2000-12-10 04:09:52 +0000 | [diff] [blame] | 158 | |
Josh Coalson | 630d22e | 2003-01-25 18:32:56 +0000 | [diff] [blame] | 159 | There are now .dsp projects and a master FLAC.dsw workspace to build |
| 160 | all the libraries and executables. |
Josh Coalson | 3a17d3c | 2002-10-18 05:49:44 +0000 | [diff] [blame] | 161 | |
Josh Coalson | 630d22e | 2003-01-25 18:32:56 +0000 | [diff] [blame] | 162 | Prerequisite: you must have the Ogg libraries installed as described |
| 163 | later. |
Josh Coalson | 71fb9ff | 2002-12-03 06:29:10 +0000 | [diff] [blame] | 164 | |
Josh Coalson | 630d22e | 2003-01-25 18:32:56 +0000 | [diff] [blame] | 165 | Prerequisite: you must have nasm installed, and have the environment |
| 166 | variable FLAC_NASM set to the full path to nasmw.exe, e.g |
Josh Coalson | a11d5de | 2002-10-18 06:09:38 +0000 | [diff] [blame] | 167 | |
Josh Coalson | 630d22e | 2003-01-25 18:32:56 +0000 | [diff] [blame] | 168 | C:\nasm\nasmw.exe |
Josh Coalson | 3a17d3c | 2002-10-18 05:49:44 +0000 | [diff] [blame] | 169 | |
Josh Coalson | 630d22e | 2003-01-25 18:32:56 +0000 | [diff] [blame] | 170 | To build everything, run Developer Studio, do File|Open Workspace, |
| 171 | and open FLAC.dsw. Select "Build | Set active configuration..." |
| 172 | from the menu, then in the dialog, select "All - Win32 Release" (or |
| 173 | Debug if you prefer). Click "Ok" then hit F7 to build. This will build |
| 174 | all libraries both statically (e.g. obj\release\lib\libFLAC_static.lib) |
| 175 | and as DLLs (e.g. obj\release\bin\libFLAC.dll), and it will build all |
| 176 | binaries, statically linked (e.g. obj\release\bin\flac.exe). |
Josh Coalson | 3a17d3c | 2002-10-18 05:49:44 +0000 | [diff] [blame] | 177 | |
Josh Coalson | 630d22e | 2003-01-25 18:32:56 +0000 | [diff] [blame] | 178 | Everything will end up in the "obj" directory. DLLs and .exe files |
Josh Coalson | 71fb9ff | 2002-12-03 06:29:10 +0000 | [diff] [blame] | 179 | are all that are needed and can be copied to an installation area and |
Josh Coalson | 3a17d3c | 2002-10-18 05:49:44 +0000 | [diff] [blame] | 180 | added to the PATH. The plugins have to be copied to their appropriate |
Josh Coalson | 93c66d7 | 2003-12-17 19:39:21 +0000 | [diff] [blame] | 181 | place in the player area. For Winamp2 this is <winamp2-dir>\Plugins. |
Josh Coalson | 5676eb1 | 2001-11-09 19:23:50 +0000 | [diff] [blame] | 182 | |
Josh Coalson | 71fb9ff | 2002-12-03 06:29:10 +0000 | [diff] [blame] | 183 | By default the code is configured with Ogg support. Before building FLAC |
| 184 | you will need to get the Ogg source distribution |
| 185 | (see http://xiph.org/ogg/vorbis/download/), build ogg_static.lib (load and |
| 186 | build win32\ogg_static.dsp), copy ogg_static.lib into FLAC's |
| 187 | 'obj\release\lib' directory, and copy the entire include\ogg tree into |
| 188 | FLAC's 'include' directory (so that there is an 'ogg' directory in FLAC's |
| 189 | 'include' directory with the files ogg.h, os_types.h and config_types.h). |
| 190 | |
Josh Coalson | 5676eb1 | 2001-11-09 19:23:50 +0000 | [diff] [blame] | 191 | |
Josh Coalson | 310b9ec | 2002-07-31 06:39:21 +0000 | [diff] [blame] | 192 | =============================================================================== |
Josh Coalson | 5676eb1 | 2001-11-09 19:23:50 +0000 | [diff] [blame] | 193 | Building on Mac OS X |
Josh Coalson | 310b9ec | 2002-07-31 06:39:21 +0000 | [diff] [blame] | 194 | =============================================================================== |
Josh Coalson | 5676eb1 | 2001-11-09 19:23:50 +0000 | [diff] [blame] | 195 | |
Josh Coalson | 71fb9ff | 2002-12-03 06:29:10 +0000 | [diff] [blame] | 196 | If you have Fink, the GNU flow above should work. Otherwise, |
Josh Coalson | b83801e | 2002-03-13 04:11:05 +0000 | [diff] [blame] | 197 | there is a Project Builder project in the top-level source |
Josh Coalson | 5676eb1 | 2001-11-09 19:23:50 +0000 | [diff] [blame] | 198 | directory to build libFLAC and the command-line utilities on |
| 199 | Mac OS X. In a terminal, cd to the top-level directory (the |
| 200 | one that contains this README file) and type: |
| 201 | |
| 202 | pbxbuild -alltargets |
| 203 | |
Josh Coalson | b83801e | 2002-03-13 04:11:05 +0000 | [diff] [blame] | 204 | This will create everything and leave it in the build/ directory. |
| 205 | Don't worry about the rest of the stuff that is in build/ or |
Josh Coalson | 5676eb1 | 2001-11-09 19:23:50 +0000 | [diff] [blame] | 206 | the stuff that was already there before building. |
| 207 | |
| 208 | There currently is no install procedure; you will have to |
| 209 | manually copy the tools to wherever you need them. |
Josh Coalson | 310b9ec | 2002-07-31 06:39:21 +0000 | [diff] [blame] | 210 | |
| 211 | |
| 212 | =============================================================================== |
| 213 | Note to embedded developers |
| 214 | =============================================================================== |
| 215 | |
| 216 | libFLAC has grown larger over time as more functionality has been |
| 217 | included, but much of it may be unnecessary for a particular embedded |
| 218 | implementation. Unused parts may be pruned by some simple editing of |
| 219 | configure.in and src/libFLAC/Makefile.am; the following dependency |
| 220 | graph shows which modules may be pruned without breaking things |
| 221 | further down: |
| 222 | |
| 223 | file_encoder.h |
| 224 | stream_encoder.h |
| 225 | format.h |
| 226 | |
| 227 | file_decoder.h |
| 228 | seekable_stream_decoder.h |
| 229 | stream_decoder.h |
| 230 | format.h |
| 231 | |
| 232 | metadata.h |
| 233 | format.h |
| 234 | |
| 235 | There is a section dedicated to embedded use in the libFLAC API |
| 236 | HTML documentation (see doc/html/api/index.html). |