add link to hans' comparison page
[flac.git] / doc / html / documentation.html
index b269f59..df69ea3 100644 (file)
@@ -1,5 +1,5 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
-<!-- Copyright (c)  2000,2001,2002  Josh Coalson -->
+<!-- Copyright (c)  2000,2001,2002,2003  Josh Coalson -->
 <!-- Permission is granted to copy, distribute and/or modify this document -->
 <!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
 <!-- or any later version published by the Free Software Foundation; -->
@@ -14,7 +14,7 @@
 
 <TABLE BORDER=0 WIDTH="100%" CELLPADDING=1 CELLSPACING=0>
        <TR>
-               <TD ALIGN="CENTER" BGCOLOR="#000000"><A HREF="http://flac.sourceforge.net/"><IMG SRC="images/logo.jpg" ALIGN=CENTER ALT="FLAC Logo" BORDER=0 HSPACE=0></a></TD>
+               <TD ALIGN="CENTER" BGCOLOR="#000000"><A HREF="http://flac.sourceforge.net/"><IMG SRC="images/logo130.gif" ALIGN=CENTER ALT="FLAC Logo" BORDER=0 HSPACE=0></a></TD>
        </TR>
 </TABLE>
 
@@ -28,6 +28,7 @@
                        <TABLE CELLPADDING=0 CELLSPACING=0 BORDER=0>
                                <TR>
                                        <TD HEIGHT=22 BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="index.html">home</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
+                                       <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="faq.html">faq</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
                                        <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="news.html">news</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
                                        <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="download.html">download</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
                                        <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="features.html">features</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
@@ -83,8 +84,7 @@
                        <LI><A HREF="#flac">flac</A> - the usage of the command-line file encoder/decoder <B><TT>flac</TT></B>.</LI>
                        <LI><A HREF="#metaflac">metaflac</A> - the usage of the command-line FLAC metadata editor <B><TT>metaflac</TT></B>.</LI>
                        <LI><A HREF="#plugins">plugins</A> - documentation for the various input plugins.</LI>
-                       <LI><A HREF="#libflac">libFLAC API</A> - for developers who want to add FLAC support to their programs.</LI>
-                       <LI><A HREF="#libflacpp">libFLAC++ API</A> - the documentation for object layer around libFLAC.</LI>
+                       <LI><A HREF="api/index.html">libFLAC and libFLAC++ APIs</A> - for developers who want to add FLAC support to their programs.</LI>
                        <LI><A HREF="#bugs">bugs</A> - known bugs.</LI>
                        <LI><A HREF="#monkey">How to add FLAC support to the Monkey's Audio GUI</A></LI>
                </UL>
                <B>METADATA</B>
        </P>
        <P>
-               FLAC defines several types of metadata blocks (see the <A HREF="format.html">format</A> page for the complete list.  Metadata blocks can be any length and new ones can be defined.  A decoder is allowed to skip any metadata types it does not understand.  Only one is mandatory: the STREAMINFO block.  This block has information like the sample rate, number of channels, etc., and data that can help the decoder manage its buffers, like the minimum and maximum data rate and minimum and maximum block size.  Also included in the STREAMINFO block is the MD5 signature of the <I>unencoded</I> audio data.  This is useful for checking an entire stream for transmission errors.
+               FLAC defines several types of metadata blocks (see the <A HREF="format.html">format</A> page for the complete list).  Metadata blocks can be any length and new ones can be defined.  A decoder is allowed to skip any metadata types it does not understand.  Only one is mandatory: the STREAMINFO block.  This block has information like the sample rate, number of channels, etc., and data that can help the decoder manage its buffers, like the minimum and maximum data rate and minimum and maximum block size.  Also included in the STREAMINFO block is the MD5 signature of the <I>unencoded</I> audio data.  This is useful for checking an entire stream for transmission errors.
        </P>
        <P>
-               Other blocks allow for padding, seek tables, and application-specific data.  You can see <B><TT>flac</TT></B> options below for adding PADDING blocks or specifying seek points.  FLAC does not require seek points for seeking but they can speed up seeks, or be used for cueing in editing applications.
+               Other blocks allow for padding, seek tables, tags, cuesheets, and application-specific data.  You can see <B><TT>flac</TT></B> options below for adding PADDING blocks or specifying seek points.  FLAC does not require seek points for seeking but they can speed up seeks, or be used for cueing in editing applications.
        <P>
        </P>
                Also, if you have a need of a custom metadata block, you can define your own and request an ID <A HREF="id.html">here</A>.  Then you can reserve a PADDING block of the correct size when encoding, and overwrite the padding block with your APPLICATION block after encoding.  The resulting stream will be FLAC compatible; decoders that are aware of your metadata can use it and the rest will safely ignore it.
                <B>MISCELLANEOUS</B>
        </P>
        <P>
-               In order to support come common types of metadata, the reference decoder knows how to skip ID3V1 and ID3V2 tags so it is safe to tag FLAC files in this way.  ID3V2 tags must come at the beginning of the file (before the "fLaC" marker) and ID3V1 tags must come at the end of the file.
+               In order to support come common types of metadata, the reference decoder knows how to skip <A HREF="http://www.id3.org/">ID3v1 and ID3v2 tags</A>.  Note however that the FLAC specification does not require compliant implementations to support ID3 in any form.  The XMMS and Winamp plugins support them out of convenience but other applications need not.
        </P>
        <P>
                <B><TT>flac</TT></B> has a verify option <TT>-V</TT> that verifies the output while encoding.  With this option, a decoder is run in parallel to the encoder and its output is compared against the original input.  If a difference is found <B><TT>flac</TT></B> will stop with an error.
                <B><TT>flac</TT></B> will be invoked one of four ways, depending on whether you are encoding, decoding, testing, or analyzing:
                <UL>
                <LI>
-                       Encoding: flac [-s] [--skip #] [-V] [<I><A HREF="#format_options">&lt;format-options&gt;</A></I>] [<I><A HREF="#encoding_options">&lt;encoding options&gt;</A></I>] [inputfile [...]]
+                       Encoding: flac [<I><A HREF="#general_options">&lt;general-options&gt;</A></I>] [<I><A HREF="#format_options">&lt;format-options&gt;</A></I>] [<I><A HREF="#encoding_options">&lt;encoding options&gt;</A></I>] [inputfile [...]]
                </LI>
                <LI>
-                       Decoding: flac -d [-s] [--skip #] [-F] [<I><A HREF="#format_options">&lt;format-options&gt;</A></I>] [inputfile [...]]
+                       Decoding: flac -d [<I><A HREF="#general_options">&lt;general-options&gt;</A></I>] [<I><A HREF="#format_options">&lt;format-options&gt;</A></I>] [<I><A HREF="#decoding_options">&lt;decoding options&gt;</A></I>]  [FLACfile [...]]
                </LI>
                <LI>
-                       Testing: flac -t [-s] [inputfile [...]]
+                       Testing: flac -t [<I><A HREF="#general_options">&lt;general-options&gt;</A></I>] [FLACfile [...]]
                </LI>
                <LI>
-                       Analyzing: flac -a [-s] [--skip #] [<I><A HREF="#analysis_options">&lt;analysis-options&gt;</A></I>] [inputfile [...]]
+                       Analyzing: flac -a [<I><A HREF="#general_options">&lt;general-options&gt;</A></I>] [<I><A HREF="#analysis_options">&lt;analysis-options&gt;</A></I>] [FLACfile [...]]
                </LI>
                </UL>
        </P>
        <P>
                Also, you can force output data to go to stdout using <TT>-c</TT>.
        </P>
+       <P>
+               To encode or decode files that start with a dash, use <TT>--</TT> to signal the end of options, to keep the filenames themselves from being treated as options:
+               <UL>
+               <LI>
+                       <TT>flac -V -- -01-filename.wav</TT>
+               </LI>
+               </UL>
+       </P>
        <P>The encoding options affect the compression ratio and encoding speed.  The format options are used to tell <B><TT>flac</TT></B> the arrangement of samples if the input file (or output file when decoding) is a raw file.  If it is a RIFF WAVE or AIFF file the format options are not needed since they are read from the AIFF/WAVE header.
        </P>
        <P>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-H</TT>
+                               <TT>-v</TT>, <TT>--version</TT>
                        </TD>
                        <TD>
-                               Show the long usage screen.  Running <B><TT>flac</TT></B> without arguments shows the short help screen by default.
+                               Show the <B><TT>flac</TT></B> version number.
                        </TD>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-d</TT>
+                               <TT>-h</TT>, <TT>--help</TT>
+                       </TD>
+                       <TD>
+                               Show basic usage and a list of all options.  Running <B><TT>flac</TT></B> without arguments shows the short help screen by default.
+                       </TD>
+               </TR>
+               <TR>
+                       <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
+                               <TT>-H</TT>, <TT>--explain</TT>
+                       </TD>
+                       <TD>
+                               Show detailed explanation of usage and all options.  Running <B><TT>flac</TT></B> without arguments shows the short help screen by default.
+                       </TD>
+               </TR>
+               <TR>
+                       <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
+                               <TT>-d</TT>, <TT>--decode</TT>
                        </TD>
                        <TD>
                                Decode (<B><TT>flac</TT></B> encodes by default).  <B><TT>flac</TT></B> will exit with an exit code of <TT>1</TT> (and print a message, even in silent mode) if there were any errors during decoding, including when the MD5 checksum does not match the decoded output.  Otherwise the exit code will be <TT>0</TT>.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-t</TT>
+                               <TT>-t</TT>, <TT>--test</TT>
                        </TD>
                        <TD>
                                Test (same as <B><TT>-d</TT></B> except no decoded file is written).  The exit codes are the same as in decode mode.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-a</TT>
+                               <TT>-a</TT>, <TT>--analyze</TT>
                        </TD>
                        <TD>
                                Analyze (same as <B><TT>-d</TT></B> except an analysis file is written).  The exit codes are the same as in decode mode.  This option is mainly for developers; the output will be a text file that has data about each frame and subframe.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-c</TT>
+                               <TT>-c</TT>, <TT>--stdout</TT>
                        </TD>
                        <TD>
-                               Write output to stdout
+                               Write output to stdout.
                        </TD>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-s</TT>
+                               <TT>-s</TT>, <TT>--silent</TT>
                        </TD>
                        <TD>
                                Silent: do not show encoding/decoding statistics.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-o filename</TT>
+                               <TT>-o filename</TT>,<BR><TT>--output-name=filename</TT>
                        </TD>
                        <TD>
                                Force the output file name (usually <TT><B>flac</B></TT> just changes the extension).  May only be used when encoding a single file.  May not be used in conjunction with <TT>--output-prefix</T>.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>--output-prefix string</TT>
+                               <TT>--output-prefix=string</TT>
                        </TD>
                        <TD>
                                Prefix each output file name with the given string.  This can be useful for encoding/decoding files to a different directory.  Make sure if your string is a path name that it ends with a trailing '<TT>/</TT>' slash.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>--skip #</TT>
+                               <TT>--skip={#|mm:ss.ss}</TT>
+                       </TD>
+                       <TD>
+                               Skip over the first # of samples of the input.  This works for both encoding and decoding, but not testing.  The alternative form <TT>mm:ss.ss</TT> can be used to specify minutes, seconds, and fractions of a second.<P>
+                               Examples:<P>
+                               <TT>--skip=123</TT> : skip the first 123 samples of the input<P>
+                               <TT>--skip=1:23.45</TT> : skip the first 1 minute and 23.45 seconds of the input
+                       </TD>
+               </TR>
+               <TR>
+                       <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
+                               <TT>--until={#|[+|-]mm:ss.ss}</TT>
+                       </TD>
+                       <TD>
+                               Stop at the given sample number for each input file.  This works for both encoding and decoding, but not testing.  The given sample number is not included in the decoded output.  The alternative form <TT>mm:ss.ss</TT> can be used to specify minutes, seconds, and fractions of a second.  If a <TT>+</TT> sign is at the beginning, the <TT>--until</TT> point is relative to the <TT>--skip</TT> point.  If a <TT>-</TT> sign is at the beginning, the <TT>--until</TT> point is relative to end of the audio.<P>
+                               Examples:<P>
+                               <TT>--until=123</TT> : decode only the first 123 samples of the input (samples 0-122, stopping at 123)<P>
+                               <TT>--until=1:23.45</TT> : decode only the first 1 minute and 23.45 seconds of the input<P>
+                               <TT>--skip=1:00 --until=+1:23.45</TT> : decode 1:00.00 to 2:23.45<P>
+                               <TT>--until=-1:23.45</TT> : decode everything except the last 1 minute and 23.45 seconds<P>
+                               <TT>--until=-0:00</TT> : decode until the end of the input (the same as not specifying <TT>--until</TT>)
+                       </TD>
+               </TR>
+               <TR>
+                       <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
+                               <TT>--ogg</TT>
                        </TD>
                        <TD>
-                               Skip over the first # of samples of the input.  This works for both encoding and decoding, but not testing.
+                               When encoding, generate Ogg-FLAC output instead of native-FLAC.  Ogg-FLAC streams are FLAC streams wrapped in an Ogg transport layer.  The resulting file should have an '.ogg' extension and will still be decodable by <TT><B>flac</B></TT>.<P>
+                               When decoding, force the input to be treated as Ogg-FLAC.  This is useful when piping input from stdin or when the filename does not end in '.ogg'.
+                       </TD>
+               </TR>
+               <TR>
+                       <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
+                               <TT>--serial-number=#</TT>
+                       </TD>
+                       <TD>
+                               When used with --ogg, specifies the serial number to use the for the FLAC stream.  When encoding and no serial number is given, flac uses '0'.  When decoding and no number is given, flac uses the serial number of the first page.<P>
                        </TD>
                </TR>
        </TABLE>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>--a-rtext</TT>
+                               <TT>--residual-text</TT>
                        </TD>
                        <TD>
                                Includes the residual signal in the analysis file.  This will make the file <B>very</B> big, much larger than even the decoded file.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>--a-rgp</TT>
+                               <TT>--residual-gnuplot</TT>
                        </TD>
                        <TD>
                                Generates a gnuplot file for every subframe; each file will contain the residual distribution of the subframe.  This will create a <B>lot</B> of files.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-F</TT>
+                               <TT>-F</TT>,<BR><TT>--decode-through-errors</TT>
                        </TD>
                        <TD>
                                By default <B><TT>flac</TT></B> stops decoding with an error and removes the partially decoded file if it encounters a bitstream error.  With <TT>-F</TT>, errors are still printed but <B><TT>flac</TT></B> will continue decoding to completion.  Note that errors may cause the decoded audio to be missing some samples or have silent sections.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>--ogg</TT>
+                               <TT>-V</TT>, <TT>--verify</TT>
                        </TD>
                        <TD>
-                               When encoding, generate Ogg-FLAC output instead of native-FLAC.  Ogg-FLAC streams are FLAC streams wrapped in an Ogg transport layer.  The resulting file should have an '.ogg' extension and will still be decodable by <TT><B>flac</B></TT>.<P>
-                               When decoding, force the input to be treated as Ogg-FLAC.  This is useful when piping input from stdin or when the filename does not end in '.ogg'.
+                               Verify the encoding process.  With this option, <B><TT>flac</TT></B> will create a parallel decoder that decodes the output of the encoder and compares the result against the original.  It will abort immediately with an error if a mismatch occurs.  <B><TT>-V</TT></B> increases the total encoding time but is guaranteed to catch any unforseen bug in the encoding process.
                        </TD>
                </TR>
                <TR>
                                <TT>--lax</TT>
                        </TD>
                        <TD>
-                               Allow encoder to generate non-Subset files.  The resulting FLAC file may not be streamable, so you should only use this option in combination with custom encoding options meant for archival.  File decoders will still be able play (and seek in) such files.
+                               Allow encoder to generate non-<A HREF="format.html#subset">Subset</A> files.  The resulting FLAC file may not be streamable, so you should only use this option in combination with custom encoding options meant for archival.  File decoders will still be able play (and seek in) such files.
+                       </TD>
+               </TR>
+               <TR>
+                       <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
+                               <TT>--replay-gain</TT>
+                       </TD>
+                       <TD>
+                               Calculate <A HREF="http://www.replaygain.org/">ReplayGain</A> values and store in Vorbis comments, similar to <A HREF="http://packages.qa.debian.org/v/vorbisgain.html">VorbisGain</A>.  Title gains/peaks will be computed for each input file, and an album gain/peak will be computed for all files.  All input files must have the same resolution, sample rate, and number of channels.  Only mono and stereo files are allowed, and the sample rate must be one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48 kHz.  Also note that this option may leave a few extra bytes in a PADDING block as the exact size of the tags is not known until all files are processed.<P>
+                               Note that this option cannot be used when encoding to standard output (stdout).
+                       </TD>
+               </TR>
+               <TR>
+                       <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
+                               <TT>--cuesheet=FILENAME</TT>
+                       </TD>
+                       <TD>
+                               Import the given cuesheet file and store it in a <A HREF="format.html#def_CUESHEET">CUESHEET</A> metadata block.  This option may only be used when encoding a single file.  A seekpoint will be added for each index point in the cuesheet to the <A HREF="format.html#def_SEEKTABLE">SEEKTABLE</A> unless <TT>--no-cued-seekpoints</TT> is specified.<P>
+                               The cuesheet file must be of the sort written by <A HREF="http://www.goldenhawk.com/cdrwin.htm">CDRwin</A>, <A HREF="http://www.dcsoft.com/prod03.htm">CDRcue</A>, <A HREF="http://www.exactaudiocopy.de/">EAC</A>, et al.
                        </TD>
                </TR>
                <TR>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-S { # | X | #x }</TT>
+                               <TT>-S {#|X|#x|#s}</TT>,<BR><TT>--seekpoint={#|X|#x|#s}</TT>
                        </TD>
                        <TD>
                                Include a point or points in a SEEKTABLE:<BR>
                                <LI>
                                        <TT>#x</TT> : # evenly spaced seekpoints, the first being at sample 0
                                </LI>
+                               <LI>
+                                       <TT>#s</TT> : a seekpoint every # seconds; # does not have to be a whole number, it can be, for example, <TT>9.5</TT>, meaning a seekpoint every 9.5 seconds
+                               </LI>
                                </UL>
                                You may use many -S options; the resulting SEEKTABLE will be the unique-ified union of all such values.<BR>
-                               With no -S options, flac defaults to '-S 100x'.  Use -S- for no SEEKTABLE.<BR>
-                               <B>NOTE:</B> -S #x will not work if the encoder can't determine the input size before starting.<BR>
-                               <B>NOTE:</B> if you use -S # and # is >= samples in the input, there will be either no seek point entered (if the input size is determinable before encoding starts) or a placeholder point (if input size is not determinable).<BR>
+                               With no -S options, flac defaults to '-S 10s'.  Use --no-seektable for no SEEKTABLE.<BR>
+                               <B>NOTE:</B> -S #x and -S #s will not work if the encoder can't determine the input size before starting.<BR>
+                               <B>NOTE:</B> if you use -S # and # is &gt;= samples in the input, there will be either no seek point entered (if the input size is determinable before encoding starts) or a placeholder point (if input size is not determinable).<BR>
                        </TD>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-P #</TT>
+                               <TT>-P #</TT>, <TT>--padding=#</TT>
                        </TD>
                        <TD>
-                               Tell the encoder to write a <TT>PADDING</TT> metadata block of the given length (in bytes) after the <TT>STREAMINFO</TT> block.  This is useful if you plan to tag the file later with an <TT>APPLICATION</TT> block; instead of having to rewrite the entire file later just to insert your block, you can write directly over the <TT>PADDING</TT> block.  Note that the total length of the <TT>PADDING</TT> block will be 4 bytes longer than the length given because of the 4 metadata block header bytes.  You can force no <TT>PADDING</TT> block at all to be written with <TT>-P-</TT>, which is the default.
+                               Tell the encoder to write a <TT>PADDING</TT> metadata block of the given length (in bytes) after the <TT>STREAMINFO</TT> block.  This is useful if you plan to tag the file later with an <TT>APPLICATION</TT> block; instead of having to rewrite the entire file later just to insert your block, you can write directly over the <TT>PADDING</TT> block.  Note that the total length of the <TT>PADDING</TT> block will be 4 bytes longer than the length given because of the 4 metadata block header bytes.  You can force no <TT>PADDING</TT> block at all to be written with <TT>--no-padding</TT>.  The encoder writes a PADDING block of 4096 bytes by default.
                        </TD>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-b #</TT>
+                               <TT>-T FIELD=VALUE</TT>, <TT>--tag=FIELD=VALUE</TT>
+                       </TD>
+                       <TD>
+                               Add a Vorbis comment.  The comment must adhere to the Vorbis comment spec; i.e. the FIELD must contain only legal characters, terminated by an 'equals' sign.  Make sure to quote the comment if necessary.  This option may appear more than once to add several comments.  NOTE: all tags will be added to all encoded files.
+                       </TD>
+               </TR>
+               <TR>
+                       <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
+                               <TT>-b #</TT>, <TT>--blocksize=#</TT>
                        </TD>
                        <TD>
                                Specify the block size in samples.  The default is 1152 for -l 0, otherwise 4608.  Subset streams must use one of 192/576/1152/2304/4608/256/512/1024/2048/4096/8192/16384/32768.  The reference encoder uses the same block size for the entire stream.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-m</TT>
+                               <TT>-m</TT>, <TT>--mid-side</TT>
                        </TD>
                        <TD>
-                               Enable mid-side coding (only for stereo streams).  Tends to increase compression by a few percent on average.  For each block both the stereo pair and mid-side versions of the block will be encoded, and smallest resulting frame will be stored.  Currently mid-side encoding is only available when bits-per-sample <= 16.
+                               Enable mid-side coding (only for stereo streams).  Tends to increase compression by a few percent on average.  For each block both the stereo pair and mid-side versions of the block will be encoded, and smallest resulting frame will be stored.  Currently mid-side encoding is only available when bits-per-sample &lt;= 16.
                        </TD>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-M</TT>
+                               <TT>-M</TT>, <TT>--adaptive-mid-side</TT>
                        </TD>
                        <TD>
-                               Enable loose mid-side coding (only for stereo streams).  Like <TT>-m</TT> but the encoder adaptively switches between independent and mid-side coding, which is faster but yields less compression than <TT>-m</TT> (which does an exhaustive search).
+                               Enable adaptive mid-side coding (only for stereo streams).  Like <TT>-m</TT> but the encoder adaptively switches between independent and mid-side coding, which is faster but yields less compression than <TT>-m</TT> (which does an exhaustive search).
                        </TD>
                </TR>
                <TR>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-0</TT>
+                               <TT>-0</TT>, <TT>--compression-level-0</TT>
                        </TD>
                        <TD>
                                Synonymous with <TT>-l 0 -b 1152 -r 2,2</TT>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-1</TT>
+                               <TT>-1</TT>, <TT>--compression-level-1</TT>
                        </TD>
                        <TD>
                                Synonymous with <TT>-l 0 -b 1152 -M -r 2,2</TT>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-2</TT>
+                               <TT>-2</TT>, <TT>--compression-level-2</TT>
                        </TD>
                        <TD>
                                Synonymous with <TT>-l 0 -b 1152 -m -r 3</TT>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-3</TT>
+                               <TT>-3</TT>, <TT>--compression-level-3</TT>
                        </TD>
                        <TD>
                                Synonymous with <TT>-l 6 -b 4608 -r 3,3</TT>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-4</TT>
+                               <TT>-4</TT>, <TT>--compression-level-4</TT>
                        </TD>
                        <TD>
                                Synonymous with <TT>-l 8 -b 4608 -M -r 3,3</TT>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-5</TT>
+                               <TT>-5</TT>, <TT>--compression-level-5</TT>
                        </TD>
                        <TD>
                                Synonymous with <TT>-l 8 -b 4608 -m -r 3,3</TT>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-6</TT>
+                               <TT>-6</TT>, <TT>--compression-level-6</TT>
                        </TD>
                        <TD>
                                Synonymous with <TT>-l 8 -b 4608 -m -r 4</TT>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-7</TT>
+                               <TT>-7</TT>, <TT>--compression-level-7</TT>
                        </TD>
                        <TD>
                                Synonymous with <TT>-l 8 -b 4608 -m -e -r 6</TT>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-8</TT>
+                               <TT>-8</TT>, <TT>--compression-level-8</TT>
                        </TD>
                        <TD>
                                Synonymous with <TT>-l 12 -b 4608 -m -e -r 6</TT>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-e</TT>
+                               <TT>-e</TT>,<BR><TT>--exhaustive-model-search</TT>
                        </TD>
                        <TD>
                                Exhaustive model search (expensive!).  Normally the encoder estimates the best model to use and encodes once based on the estimate.  With an exhaustive model search, the encoder will generate subframes for every order and use the smallest.  If the max LPC order is high this can significantly increase the encode time but can shave off another 0.5%.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-E</TT>
+                               <TT>-l #</TT>, <TT>--max-lpc-order=#</TT>
                        </TD>
                        <TD>
-                               Do escape coding in the entropy coder.  This causes the encoder to use an unencoded representation of the residual in a partition if it is smaller.  It increases the runtime and usually results in an improvement of less than 1%.
+                               Specifies the maximum LPC order.  This number must be &lt;= 32.  If 0, the encoder will not attempt generic linear prediction, and use only fixed predictors.  Using fixed predictors is faster but usually results in files being 5-10% larger.
                        </TD>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-l #</TT>
-                       </TD>
-                       <TD>
-                               Specifies the maximum LPC order.  This number must be <= 32.  If 0, the encoder will not attempt generic linear prediction, and use only fixed predictors.  Using fixed predictors is faster but usually results in files being 5-10% larger.
-                       </TD>
-               </TR>
-               <TR>
-                       <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-q #</TT>
+                               <TT>-q #</TT>,<BR><TT>--qlp-coeff-precision=#</TT>
                        </TD>
                        <TD>
                                Specifies the precision of the quantized LP coefficients, in bits.  The default is <B><TT>-q 0</TT></B>, which means let the encoder decide based on the signal.  Unless you really know your input file it's best to leave this up to the encoder.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-p</TT>
+                               <TT>-p</TT>,<BR><TT>--qlp-coeff-precision-search</TT>
                        </TD>
                        <TD>
                                Do exhaustive LP coefficient quantization optimization.  This option overrides any <B><TT>-q</TT></B> option.  It is expensive and typically will only improve the compression a tiny fraction of a percent.  <B><TT>-q</TT></B> has no effect when <B><TT>-l 0</TT></B> is used.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-r [#,]#</TT>
+                               <TT>-r [#,]#</TT>,<BR><TT>--rice-partition-order=[#,]#</TT>
                        </TD>
                        <TD>
                                Set the [min,]max residual partition order.  The min value defaults to 0 if unspecified.<P>
                                By default the encoder uses a single Rice parameter for the subframe's entire residual.  With this option, the residual is iteratively partitioned into 2^min# .. 2^max# pieces, each with its own Rice parameter.  Higher values of max# yield diminishing returns.  The most bang for the buck is usually with <B><TT>-r 2,2</TT></B> (more for higher block sizes).  This usually shaves off about 1.5%.  The technique tends to peak out about when blocksize/(2^n)=128.  Use <B><TT>-r 0,16</TT></B> to force the highest degree of optimization.
                        </TD>
                </TR>
-               <TR>
-                       <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-V</TT>
-                       </TD>
-                       <TD>
-                               Verify the encoding process.  With this option, <B><TT>flac</TT></B> will create a parallel decoder that decodes the output of the encoder and compares the result against the original.  It will abort immediately with an error if a mismatch occurs.  <B><TT>-V</TT></B> increases the total encoding time but is guaranteed to catch any unforseen bug in the encoding process.
-                       </TD>
-               </TR>
-               <TR>
-                       <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                       </TD>
-                       <TD>
-                               <TT>-F-</TT>, <TT>-S-</TT>, <TT>-P-</TT>, <TT>-m-</TT>, <TT>-e-</TT>, <TT>-E-</TT>, <TT>-p-</TT>, <TT>-V-</TT>, <TT>--delete-input-file-</TT>, <TT>--lax-</TT>, <TT>--sector-align-</TT> can all be used to turn off a particular option.
-                       </TD>
-               </TR>
        </TABLE>
        </TD></TR></TABLE>
        </P>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-fb | -fl</TT>
+                               <TT>--endian={big|little}</TT>
                        </TD>
                        <TD>
-                               Specify big-endian | little-endian byte order in the raw file.
+                               Specify big-endian or little-endian byte order in the raw file.
                        </TD>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-fc #</TT>
+                               <TT>--channels=#</TT>
                        </TD>
                        <TD>
                                Specify the number of channels in the raw file.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-fp #</TT>
+                               <TT>--bps=#</TT>
                        </TD>
                        <TD>
                                Specify the number of bits per sample in the raw file.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-fs #</TT>
+                               <TT>--sample-rate=#</TT>
                        </TD>
                        <TD>
                                Specify the sample rate of the raw file.
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-fu</TT>
+                               <TT>--sign={signed|unsigned}</TT>
                        </TD>
                        <TD>
-                               Specify that the samples in the raw file are unsigned (the default is signed).
+                               Specify that the samples in the raw file are signed or unsigned (the default is signed).
                        </TD>
                </TR>
                <TR>
                        <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
-                               <TT>-fr</TT>
+                               <TT>--force-aiff-format</TT>
+                       </TD>
+                       <TD>
+                               Force the decoder to output AIFF format.  This option is not needed if the output filename (as set by -o) ends with .aiff.  Also, this option has no effect when encoding since input AIFF is auto-detected.
+                       </TD>
+               </TR>
+               <TR>
+                       <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
+                               <TT>--force-raw-format</TT>
                        </TD>
                        <TD>
                                Treat the input file (or output file if decoding) as a raw file, regardless of the extension.
        </TABLE>
        </TD></TR></TABLE>
        </P>
+       <P>
+       <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
+       <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
+               <TR>
+                       <TD COLSPAN="2" BGCOLOR="#D3D4C5">
+                               <A NAME="format_options"><FONT SIZE="+1"><B>Negative Options</B></FONT></A>
+                       </TD>
+               </TR>
+               <TR>
+                       <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
+                               <TT>--no-adaptive-mid-side</TT><BR>
+                               <TT>--no-decode-through-errors</TT><BR>
+                               <TT>--no-delete-input-file</TT><BR>
+                               <TT>--no-escape-coding</TT><BR>
+                               <TT>--no-exhaustive-model-search</TT><BR>
+                               <TT>--no-lax</TT><BR>
+                               <TT>--no-mid-side</TT><BR>
+                               <TT>--no-ogg</TT><BR>
+                               <TT>--no-padding</TT><BR>
+                               <TT>--no-qlp-coeff-precision-search</TT><BR>
+                               <TT>--no-residual-gnuplot</TT><BR>
+                               <TT>--no-residual-text</TT><BR>
+                               <TT>--no-sector-align</TT><BR>
+                               <TT>--no-seektable</TT><BR>
+                               <TT>--no-silent</TT><BR>
+                               <TT>--no-verify</TT>
+                       </TD>
+                       <TD>
+                               can all be used to turn off a particular option.
+                       </TD>
+               </TR>
+       </TABLE>
+       </TD></TR></TABLE>
+       </P>
        </FONT>
        </TD></TR>
        </TABLE>
                <B><TT>metaflac</TT></B> is the command-line <TT>.flac</TT> file metadata editor.  You can use it to list the contents of blocks, delete or insert blocks, and manage padding.
        </P>
        <P>
-               The documentation for <B><TT>metaflac</TT></B> is currently being rewritten, but the usage screen should explain it pretty well.  Do <TT>metaflac --help</TT> to see the full usage.
+               The HTML documentation for <B><TT>metaflac</TT></B> is currently being rewritten, but the usage screen should explain it pretty well, and there is a man page.  Do <TT>metaflac --help</TT> to see the full usage.
        </P>
        </FONT>
        </TD></TR>
        <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="1" ALT=""></TD></TR></TABLE>
        <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
                <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
-               <A NAME="libflac"><B><FONT SIZE="+2">libFLAC</FONT></B>
+               <A NAME="bugs"><B><FONT SIZE="+2">known bugs</FONT></B>
                </FONT></TD></TR>
        </TABLE>
        <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="1" ALT=""></TD></TR></TABLE>
        <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
        <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
        <P>
-               The FLAC library <B><TT>libFLAC</TT></B> is a C implementation of reference encoders and decoders, and a metadata interface.  By linking against <B><TT>libFLAC</TT></B> and writing a little code, it is relatively easy to add FLAC support to another program.  The library is licensed under the <A HREF="http://www.gnu.org/copyleft/lesser.html">LGPL</A>.  Complete source code of <B><TT>libFLAC</TT></B> as well as the command-line encoder and plugins is available and is a useful source of examples.
-       </P>
-       <P>
-               There is also a C++ object wrapper around <B><TT>libFLAC</TT></B> called <B><TT>libFLAC++</TT></B>; see the documentation <A HREF="#libflacpp">below</A>.
-       </P>
-       <P>
-               <B><TT>libFLAC</TT></B> usually only requires the standard C library and C math library.  In particular, threading is not used so there is no dependency on a thread library.  However, <B><TT>libFLAC</TT></B> does not use global variables and should be thread-safe.
-       </P>
-       <P>
-               The <B><TT>libFLAC</TT></B> interface is described in the public header files in the <TT>include/FLAC/</TT> directory.  The public headers and the compiled library are all that is needed to compile and link against the library.  Note that none of the code in <TT>src/libFLAC/</TT>, including the private header files in <TT>src/libFLAC/include/</TT> is required.
-       </P>
-       <P>
-               Aside from encoders and decoders, <B><TT>libFLAC</TT></B> provides a powerful metadata interface for manipulating metadata in FLAC files.  It allows the user to add, delete, and modify FLAC metadata blocks and it can automatically take advantage of PADDING blocks to avoid rewriting the entire FLAC file when changing the size of the metadata.  The documentation for the metadata interface is currently being rewritten but there are extensive usage comments in the header file <TT>include/FLAC/metadata.h</TT>.
-       </P>
-       <P>
-               The basic usage of a <B><TT>libFLAC</TT></B> encoder or decoder is as follows:
-               <OL>
-                       <LI>The program creates an instance of a decoder or encoder using <TT>*_new()</TT>.</LI>
-                       <LI>The program sets the parameters of the instance and callbacks for reading, writing, error reporting, and metadata reporting using <TT>*_set_*()</TT> functions.</LI>
-                       <LI>The program initializes the instance to validate the parameters and prepare for decoding/encoding using <TT>*_init()</TT>.</LI>
-                       <LI>The program calls <TT>*_process_*()</TT> functions to encode or decode data, which subsequently calls the callbacks.</LI>
-                       <LI>The program finishes the instance with <TT>*_finish()</TT>, which flushes the input and output and resets the encoder/decoder to the unitialized state.</LI>
-                       <LI>The instance may be used again or deleted with <TT>*_delete()</TT>.</LI>
-               </OL>
-       </P>
-       <P>
-               For decoding, <B><TT>libFLAC</TT></B> provides three layers of access.  The lowest layer is non-seekable stream-level decoding, the next is seekable stream-level decoding, and the highest layer is file-level decoding.  The interfaces are described in <TT>stream_decoder.h</TT>, <TT>seekable_stream_decoder.h</TT>, and <TT>file_decoder.h</TT> respectively.  Typically you will choose the highest layer that your input source will support.
-       </P>
-       <P>
-               The stream decoder relies on callbacks for all input and output and has no provisions for seeking.  The seekable stream decoder wraps the stream decoder and exposes functions for seeking.  However, you must provide extra callbacks for seek-related operations on your stream, like seek and tell.  The file decoder wraps the seekable stream decoder and supplies most of the callbacks internally, simplifying the processing of standard files.
-       </P>
-       <P>
-               Currently there is only one level of encoder implementation which is at the stream level (<TT>stream_encoder.h</TT>).  There is currently no file encoder because seeking within a file while encoding seemed like too obscure a feature.
-       </P>
-       <P>
-               Structures and constants related to the format are defined in <TT>format.h</TT>.
-       </P>
-       <P>
-               <B>STREAM DECODER</B>
-       </P>
-       <P>
-               First we discuss the stream decoder.  The instance type is <TT>FLAC__StreamDecoder</TT>.  Typically the program will create a new instance by calling <TT>FLAC__stream_decoder_new()</TT>, then call <TT>FLAC__stream_decoder_set_*()</TT> functions to set the callbacks and client data, and call <TT>FLAC__stream_decoder_init()</TT>.  The required callbacks are:
-               <UL>
-                       <LI>Read callback - This function will be called when the decoder needs more input data.  The address of the buffer to be filled is supplied, along with the number of bytes the buffer can hold.  The callback may choose to supply less data and modify the byte count but must be careful not to overflow the buffer.  The callback then returns a status code chosen from FLAC__StreamDecoderReadStatus.</LI>
-                       <LI>Write callback - This function will be called when the decoder has decoded a single frame of data.  The decoder will pass the frame metadata as well as an array of pointers (one for each channel) pointing to the decoded audio.</LI>
-                       <LI>Metadata callback - This function will be called when the decoder has decoded a metadata block.  There will always be one STREAMINFO block per stream, followed by zero or more other metadata blocks.  These will be supplied by the decoder in the same order as they appear in the stream and always before the first audio frame (i.e. write callback).  The metadata block that is passed in must not be modified, and it doesn't live beyond the callback, so you should make a copy of it with <TT>FLAC__metadata_object_clone()</TT> if you will need it elsewhere.  Since metadata blocks can potentially be large, by default the decoder only calls the metadata callback for the STREAMINFO block; you can instruct the decoder to pass or filter other blocks with <TT>FLAC__stream_decoder_set_metadata_*()</TT> calls.</LI>
-                       <LI>Error callback - This function will be called whenever an error occurs during decoding.</LI>
-               </UL>
-       </P>
-       <P>
-               Once the decoder is initialized, your program will call one of several functions to start the decoding process:
-               <UL>
-                       <LI><B><TT>FLAC__stream_decoder_process_whole_stream()</TT></B> - Tells the decoder to start and continue processing the stream until the read callback says <TT>FLAC__STREAM_DECODER_READ_END_OF_STREAM</TT> or <TT>FLAC__STREAM_DECODER_READ_ABORT</TT>.</LI>
-                       <LI><B><TT>FLAC__stream_decoder_process_metadata()</TT></B> - Tells the decoder to start processing the stream and stop upon reaching the first audio frame.</LI>
-                       <LI><B><TT>FLAC__stream_decoder_process_one_frame()</TT></B> - Tells the decoder to process one audio frame and return.  The decoder must have processed all metadata first before calling this function.</LI>
-                       <LI><B><TT>FLAC__stream_decoder_process_remaining_frames()</TT></B> - Tells the decoder to process all remaining frames.  The decoder must have processed all metadata first but may also have processed frames with <TT>FLAC__stream_decoder_process_one_frame()</TT>.</LI>
-               </UL>
-       </P>
-       <P>
-               When the decoder has finished decoding (normally or through an abort), the instance is finished by calling <TT>FLAC__stream_decoder_finish()</TT>, which ensures the decoder is in the correct state and frees memory.  Then the instance may be deleted with <TT>FLAC__stream_decoder_delete()</TT> or initialized again to decode another stream.
-       </P>
-       <P>
-               Note that the stream decoder has no real concept of stream position, it just converts data.  To seek within a stream the callbacks have only to flush the decoder using <TT>FLAC__stream_decoder_flush()</TT> and start feeding data from the new position through the read callback.  The seekable stream decoder does just this.
-       </P>
-       <P>
-               <B>SEEKABLE STREAM DECODER</B>
-       </P>
-       <P>
-               The seekable stream decoder is a wrapper around the stream decoder which also provides seeking capability.  The instance type is <TT>FLAC__SeekableStreamDecoder</TT>.  In addition to the Read/Write/Metadata/Error callbacks of the stream decoder, the user must also provide the following:
-               <UL>
-                       <LI>Seek callback - This function will be called when the decoder wants to seek to an absolute position in the stream.</LI>
-                       <LI>Tell callback - This function will be called when the decoder wants to know the current absolute position of the stream.</LI>
-                       <LI>Length callback - This function will be called when the decoder wants to know length of the stream.  The seeking algorithm currently requires that the overall stream length be known.</LI>
-                       <LI>EOF callback - This function will be called when the decoder wants to know if it is at the end of the stream.  This could be determined from the tell and length callbacks but it may be more expensive that way.</LI>
-               </UL>
-       </P>
-       <P>
-               Seeking is exposed through the <TT>FLAC__seekable_stream_decoder_seek_absolute()</TT> method.  At any point after the seekable stream decoder has been initialized, the user can call this function to seek to an exact sample within the stream.  Subsequently, the first time the write callback is called it will contain a (possibly partial) block starting at that sample.
-       </P>
-       <P>
-               The seekable stream decoder also provides MD5 signature checking.  If this is turned on before initialization, <TT>FLAC__seekable_stream_decoder_finish()</TT> will report when the decoded MD5 signature does not match the one stored in the STREAMINFO block.  MD5 checking is automatically turned off if there is no signature in the STREAMINFO block or when a seek is attempted.
-       </P>
-       <P>
-               <B>FILE DECODER</B>
-       </P>
-       <P>
-               The file decoder is a trivial wrapper around the seekable stream decoder meant to simplfy the process of decoding from a standard file.  The instance type is <TT>FLAC__FileDecoder</TT>.  The file decoder supplies all but the Write/Metadata/Error callbacks.  The user needs only to provide the path to the file and the file decoder handles the rest.
-       </P>
-       <P>
-               Like the seekable stream decoder, seeking is exposed through the <TT>FLAC__file_decoder_seek_absolute()</TT> method.  At any point after the file decoder has been initialized, the user can call this function to seek to an exact sample within the file.  Subsequently, the first time the write callback is called it will contain a (possibly partial) block starting at that sample.
-       </P>
-       <P>
-               The file decoder also inherits MD5 signature checking from the seekable stream decoder.  If this is turned on before initialization, <TT>FLAC__file_decoder_finish()</TT> will report when the decoded MD5 signature does not match the one stored in the STREAMINFO block.  MD5 checking is automatically turned off if there is no signature in the STREAMINFO block or when a seek is attempted.
-       </P>
-       <P>
-               <B>STREAM ENCODER</B>
+               Bug tracking is done on the Sourceforge project page <A HREF="http://sourceforge.net/bugs/?group_id=13478">here</A>.  If you submit a bug, make sure and provide an email contact or use the Monitor feature.
        </P>
        <P>
-               The stream encoder functions similarly to the stream decoder, but has fewer callbacks and more options.  The instance type is <TT>FLAC__StreamEncoder</TT>.  Typically the user will create a new instance by calling <TT>FLAC__stream_encoder_new()</TT>, then set the necessary parameters with <TT>FLAC__stream_encoder_set_*()</TT>, and initialize it by calling <TT>FLAC__stream_encoder_init()</TT>.
+               The following are major known bugs in the current (1.1.0) release:
        </P>
        <P>
-               Unlike the decoding process, FLAC encoding has many options that can affect the speed and compression ratio.  When the user calls <TT>FLAC__stream_encoder_init()</TT> the encoder will validate the values, so you should make sure to check the returned state to see that it is FLAC__STREAM_ENCODER_OK.  When setting these parameters you should have some basic knowledge of the format (see the <A HREF="#format">user-level documentation</A> or the <A HREF="format.html">formal description</A>) but the required parameters are summarized here:
                <UL>
-                       <LI><B><TT>streamable_subset</TT></B> - true to force the encoder to generate a <A HREF="format.html#subset">Subset stream</A>, else false.</LI>
-                       <LI><B><TT>do_mid_side_stereo</TT></B> - true to try mid-side encoding on stereo input, else false.  <TT>channels</TT> must be 2.</LI>
-                       <LI><B><TT>loose_mid_side_stereo</TT></B> - true to do adaptive mid-side switching, else false.  <TT>do_mid_side_stereo</TT> must be true.</LI>
-                       <LI><B><TT>channels</TT></B> - must be &lt;= <TT>FLAC__MAX_CHANNELS</TT>.</LI>
-                       <LI><B><TT>bits_per_sample</TT></B> - do not give the encoder wider data than what you specify here or bad things will happen.</LI>
-                       <LI><B><TT>sample_rate</TT></B> - must be &lt;= <TT>FLAC__MAX_SAMPLE_RATE</TT>.</LI>
-                       <LI><B><TT>blocksize</TT></B> - must be between <TT>FLAC__MIN_BLOCKSIZE</TT> and <TT>FLAC__MAX_BLOCKSIZE</TT>.</LI>
-                       <LI><B><TT>max_lpc_order</TT></B> - 0 implies encoder will not try general LPC, only fixed predictors; must be &lt;= <TT>FLAC__MAX_LPC_ORDER</TT>.</LI>
-                       <LI><B><TT>qlp_coeff_precision</TT></B> - must be &gt;= <TT>FLAC__MIN_QLP_COEFF_PRECISION</TT>, or 0 to let encoder select based on blocksize.  In the current imlementation <TT>qlp_coeff_precision</TT>+<TT>bits_per_sample</TT> must be &lt; 32.</LI>
-                       <LI><B><TT>do_qlp_coeff_prec_search</TT></B> - false to use <TT>qlp_coeff_precision</TT>; true to search around <TT>qlp_coeff_precision</TT> and take best.</LI>
-                       <LI><B><TT>do_escape_coding</TT></B> - true => search for escape codes in the entropy coding stage for slightly better compression.</LI>
-                       <LI><B><TT>do_exhaustive_model_search</TT></B> - false to use estimated bits per residual for scoring; true to generate all and take shortest.</LI>
-                       <LI><B><TT>min_residual_partition_order</TT></B>, <B><TT>max_residual_partition_order</TT></B> - 0 to estimate Rice parameter based on residual variance; &gt; 0 to partition the residual and use parameter for each based on mean; <TT>min_residual_partition_order</TT> and <TT>max_residual_partition_order</TT> specify the min and max Rice partition order.</LI>
-                       <LI><B><TT>rice_parameter_search_dist</TT></B> - 0 to try only calculated parameter k; else try all [k-<TT>rice_parameter_search_dist</TT>..k+<TT>rice_parameter_search_dist</TT>] parameters and use the best.</LI>
-                       <LI><B><TT>total_samples_estimate</TT></B> - May be set to 0 if unknown.  Otherwise, set this to the number of samples to be encoded.  This will allow the STREAMINFO block to be more accurate during the first pass in the event that the encoder can't seek back to the beginning of the output file to write the updated STREAMINFO block.</LI>
-                       <LI><B><TT>metadata</TT></B> - Optional array of pointers to metadata blocks to be written; NULL implies no metadata.  The STREAMINFO block is always written automatically and must not be present in the array of pointers.</LI>
+                       <LI>
+                               If you change the FLAC configuration options in the XMMS plugin while a FLAC file is playing, it can cause a crash or other bad things to happen.
+                       </LI>
                </UL>
        </P>
        <P>
-               The user provides addresses for the following callbacks:
-               <UL>
-                       <LI>Write callback - This function is called anytime there is raw encoded data to write.  It may include metadata mixed with encoded audio frames and the data is not guaranteed to be aligned on frame or metadata block boundaries.</LI>
-                       <LI>Metadata callback - This function is called once at the end of encoding with the populated STREAMINFO structure.  This is so file encoders can seek back to the beginning of the file and write the STREAMINFO block with the correct statistics after encoding (like minimum/maximum frame size).</LI>
-               </UL>
-               The call to <TT>FLAC__stream_encoder_init()</TT> currently will also immediately call the write callback with the "fLaC" signature and all the encoded metadata.
-       </P>
-       <P>
-               After initializing the instance, the user may feed audio data to the encoder in one of two ways:
-               <UL>
-                       <LI>Channel separate, through <B><TT>FLAC__stream_encoder_process()</TT></B> - The user will pass an array of pointers to buffers, one for each channel, to the encoder, each of the same length.  The samples need not be block-aligned.</LI>
-                       <LI>Channel interleaved, through <B><TT>FLAC__stream_encoder_process_interleaved()</TT></B> - The user will pass a single pointer to data that is channel-interleaved (i.e. <TT>channel0_sample0, channel1_sample0, ... , channelN_sample0, channel0_sample1, ...</TT>).  Again, the samples need not be block-aligned but they must be sample-aligned, i.e. the first value should be channel0_sampleX and the last value channelN_sampleY.</LI>
-               </UL>
-       </P>
-       <P>
-               When the user is finished encoding data, it calls <TT>FLAC__stream_encoder_finish()</TT>, which causes the encoder to encode any data still in its input pipe, and call the metadata callback with the final encoding statistics.  Then the instance may be deleted with <TT>FLAC__stream_encoder_delete()</TT> or initialized again to encode another stream.
-       </P>
-       <P>
-               <B>MISCELLANEOUS</B>
-       </P>
-       <P>
-               It should be noted that any time an array of pointers to audio data is passed, the channel order currently only has meaning for stereo streams.  Channel 0 corresponds to the left channel and channel 1 corresponds to the right channel.
-       </P>
-       <P>
-               <B>METADATA</B>
-       </P>
-       <P>
-               For programs that write their own metadata, but that do not know the actual metadata until after encoding, it is advantageous to instruct the encoder to write a PADDING block of the correct size, so that instead of rewriting the whole stream after encoding, the program can just overwrite the PADDING block.  If only the maximum size of the metadata is known, the program can write a slightly larger padding block, then split it after encoding.
-       </P>
-       <P>
-               Make sure you understand how lengths are calculated.  All FLAC metadata blocks have a 4 byte header which contains the type and length.  This length does not include the 4 bytes of the header.  See the <A HREF="format.html#metadata_block">format page</A> for the specification of metadata blocks and their lengths.
-       </P>
-       </FONT>
-       </TD></TR>
-       </TABLE>
-       <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="1" ALT=""></TD></TR></TABLE>
-</TD></TR>
-</TABLE>
-
-
-<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
-<TR><TD>
-       <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="1" ALT=""></TD></TR></TABLE>
-       <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
-               <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
-               <A NAME="libflacpp"><B><FONT SIZE="+2">libFLAC++</FONT></B>
-               </FONT></TD></TR>
-       </TABLE>
-       <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="1" ALT=""></TD></TR></TABLE>
-       <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
-       <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
-       <P>
-               <B><TT>libFLAC++</TT></B> is a C++ object wrapper around <B><TT>libFLAC</TT></B>.  It provides classed for the encoders and decoders as well as the metadata interface.
-       </P>
-       <P>
-               The documentation for <B><TT>libFLAC++</TT></B> is currently being rewritten.  As a wrapper it is actually quite simple.  The method names and semantics generally follow those in the C layer and comments in the header files specify where there are differences.
-       </P>
-       </FONT>
-       </TD></TR>
-       </TABLE>
-       <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="1" ALT=""></TD></TR></TABLE>
-</TD></TR>
-</TABLE>
-
-
-<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
-<TR><TD>
-       <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="1" ALT=""></TD></TR></TABLE>
-       <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
-               <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
-               <A NAME="bugs"><B><FONT SIZE="+2">known bugs</FONT></B>
-               </FONT></TD></TR>
-       </TABLE>
-       <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="1" ALT=""></TD></TR></TABLE>
-       <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
-       <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
-       <P>
-               Bug tracking is done on the Sourceforge project page <A HREF="http://sourceforge.net/bugs/?group_id=13478">here</A>.  If you submit a bug, make sure and provide an email contact or use the Monitor feature.
-       </P>
-       <P>
-               The following are major known bugs in the current (1.0.3) release:
+               The following are major known bugs in the 1.0.4:
        </P>
        <P>
                <UL>
                        <LI>
-                               The Winamp2 plugin has a bug where it shows a dialog "ERROR: invalid/missing FLAC metadata" for any .flac file.  This has been fixed; you can download the plugin <A HREF="http://sourceforge.net/project/shownotes.php?release_id=98266">here</A>.  The fixed source code is in CVS.
+                               All decoders prior to and including 1.0.4 have a bug that prevents them from skipping unknown metadata blocks properly.  A FLAC file created by flac 1.1.0 containing a CUESHEET metadata block will not decode in 1.0.x decoders.
+                       </LI>
+                       <LI>
+                               <B><TT>metaflac</TT></B> has a bug where, if --import-vc-from is used on a FLAC file that has no Vorbis comment block, the FLAC file can be corrupted.  All FLAC files generated by 1.0.4 have a Vorbis comment block added automatically but files from 1.0.3 and before do not.  This is fixed in CVS.
+                       </LI>
+                       <LI>
+                               There is an odd bug in <B><TT>metaflac</TT></B> such that you must always use the <TT>--dont-use-padding</TT> option with <TT>--add-padding</TT> or the padding block won't be written.  This is fixed in CVS.
                        </LI>
                </UL>
        </P>
 
 </CENTER>
 
-<P>&nbsp;Copyright (c) 2000,2001,2002 Josh Coalson</P>
+<P>&nbsp;Copyright (c) 2000,2001,2002,2003 Josh Coalson</P>
 
 </BODY>
 </HTML>