add --sector-align option
diff --git a/doc/documentation.html b/doc/documentation.html
index 5baa07b..b23d76f 100644
--- a/doc/documentation.html
+++ b/doc/documentation.html
@@ -337,7 +337,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- --a-rtext
+ <TT>--a-rtext</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.
@@ -345,7 +345,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- --a-rgp
+ <TT>--a-rgp</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.
@@ -364,7 +364,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- --lax
+ <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.
@@ -372,7 +372,17 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -S { # | X | #x }
+ <TT>--sector-align</TT>
+ </TD>
+ <TD>
+ Align encoding of multiple CD format WAVE files on sector boundaries. This option is only allowed when encoding WAVE files, all of which have a 44.1kHz sample rate and 2 channels. With <TT>--sector-align</TT>, the encoder will align the resulting .flac streams so that their lengths are even multiples of a CD sector (1/75th of a second, or 588 samples). It does this by carrying over any partial sector at the end of each WAVE file to the next stream. The last stream will be padded to alignment with zeroes.<P>
+ This option will have no effect if the files are already aligned (as is the normally the case with WAVE files ripped from a CD). <TT><B>flac</B></TT> can only align a set of files given in one invocation of <TT><B>flac</B></TT>.<P>
+ <B>WARNING:</B> The ordering of files is important! If you give a command like '<TT>flac --sector-align *.wav</TT>' the shell may not expand the wildcard to the order you expect. To be safe you should '<TT>echo *.wav</TT>' first to confirm the order, or be explicit like '<TT>flac --sector-align 8.wav 9.wav 10.wav</TT>'.
+ </TD>
+ </TR>
+ <TR>
+ <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
+ <TT>-S { # | X | #x }</TT>
</TD>
<TD>
Include a point or points in a SEEKTABLE:<BR>
@@ -389,13 +399,13 @@
</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>
- NOTE: -S #x will not work if the encoder can't determine the input size before starting.<BR>
- NOTE: 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>
+ <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>
</TD>
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -P #
+ <TT>-P #</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. <TT>-P 0</TT> implies no <TT>PADDING</TT> block, which is the default. 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.
@@ -403,7 +413,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -b #
+ <TT>-b #</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.
@@ -411,7 +421,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -m
+ <TT>-m</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.
@@ -419,7 +429,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -M
+ <TT>-M</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).
@@ -427,7 +437,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -0 .. -9
+ <TT>-0 .. -9</TT>
</TD>
<TD>
Fastest compression .. highest compression. The default is <TT>-5</TT>.
@@ -435,7 +445,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -0
+ <TT>-0</TT>
</TD>
<TD>
Synonymous with -l 0 -b 1152 -r 2,2
@@ -443,7 +453,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -1
+ <TT>-1</TT>
</TD>
<TD>
Synonymous with -l 0 -b 1152 -M -r 2,2
@@ -451,7 +461,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -2
+ <TT>-2</TT>
</TD>
<TD>
Synonymous with -l 0 -b 1152 -m -r 3
@@ -459,7 +469,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -3
+ <TT>-3</TT>
</TD>
<TD>
Synonymous with -l 6 -b 4608 -r 3,3
@@ -467,7 +477,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -4
+ <TT>-4</TT>
</TD>
<TD>
Synonymous with -l 8 -b 4608 -M -r 3,3
@@ -475,7 +485,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -5
+ <TT>-5</TT>
</TD>
<TD>
Synonymous with -l 8 -b 4608 -m -r 3,3
@@ -483,7 +493,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -6
+ <TT>-6</TT>
</TD>
<TD>
Synonymous with -l 8 -b 4608 -m -r 4
@@ -491,7 +501,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -7
+ <TT>-7</TT>
</TD>
<TD>
Synonymous with -l 8 -b 4608 -m -e -r 6
@@ -499,7 +509,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -8
+ <TT>-8</TT>
</TD>
<TD>
Synonymous with -l 12 -b 4608 -m -e -r 6
@@ -507,7 +517,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -9
+ <TT>-9</TT>
</TD>
<TD>
Synonymous with -l 32 -b 4608 -m -e -r 16 -p. This is painfully slow but gives you the maximum compression <B><TT>flac</TT></B> can do for the given block size.
@@ -515,7 +525,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -e
+ <TT>-e</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%.
@@ -523,7 +533,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -l #
+ <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.
@@ -531,7 +541,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -q #
+ <TT>-q #</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.
@@ -539,7 +549,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -p
+ <TT>-p</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.
@@ -547,16 +557,16 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -r [#,]#
+ <TT>-r [#,]#</TT>
</TD>
<TD>
- Set the [min,]max residual partition order. The min value defaults to 0 if unspecified.<BR>
+ 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">
- -R #
+ <TT>-R #</TT>
</TD>
<TD>
Set the Rice parameter search distance. Defaults to 0. The residual coder will search for the best Rice parameter +/- this number for each residual partition. This option is expensive (run time for -R n will typically be (2n)*30% over that of -R 0) and doesn't give much of a gain. As a matter of fact, none of the -0..-9 options currently use it since -R > 1 is not consistently better like it should be.
@@ -564,7 +574,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -V
+ <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.
@@ -574,7 +584,7 @@
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
</TD>
<TD>
- <TT>-S-</TT>, <TT>-m-</TT>, <TT>-e-</TT>, <TT>-p-</TT>, <TT>-V-</TT>, <TT>--delete-input-file-</TT>, <TT>--lax-</TT> can all be used to turn off a particular option.
+ <TT>-S-</TT>, <TT>-m-</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>
@@ -590,7 +600,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -fb | -fl
+ <TT>-fb | -fl</TT>
</TD>
<TD>
Specify big-endian | little-endian byte order in the raw file.
@@ -598,7 +608,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -fc #
+ <TT>-fc #</TT>
</TD>
<TD>
Specify the number of channels in the raw file.
@@ -606,7 +616,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -fp #
+ <TT>-fp #</TT>
</TD>
<TD>
Specify the number of bits per sample in the raw file.
@@ -614,7 +624,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -fs #
+ <TT>-fs #</TT>
</TD>
<TD>
Specify the sample rate of the raw file.
@@ -622,7 +632,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -fu
+ <TT>-fu</TT>
</TD>
<TD>
Specify that the samples in the raw file are unsigned (the default is signed).
@@ -630,7 +640,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -fr
+ <TT>-fr</TT>
</TD>
<TD>
Treat the input file (or output file if decoding) as a raw file, regardless of the extension.
@@ -638,7 +648,7 @@
</TR>
<TR>
<TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
- -fw
+ <TT>-fw</TT>
</TD>
<TD>
Treat the input file (or output file if decoding) as a RIFF WAVE file, regardless of the extension.