document the new -o and --delete-input-file options
[flac.git] / doc / documentation.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <HTML>
3 <HEAD>
4         <TITLE>FLAC - documentation</TITLE>
5 </HEAD>
6
7 <BODY MARGINWIDTH="0" MARGINHEIGHT="0" LEFTMARGIN="0" RIGHTMARGIN="0" TOPMARGIN="0" BGCOLOR="#99CC99" TEXT="#000000" LINK="#336699" VLINK="#336699" ALINK="#336699">
8
9 <TABLE BORDER=0 WIDTH="100%" CELLPADDING=1 CELLSPACING=0>
10         <TR>
11                 <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>
12         </TR>
13 </TABLE>
14
15 <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#99CC99"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="25" ALT=""></TD></TR></TABLE>
16
17 <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="2" ALT=""></TD></TR></TABLE>
18
19 <TABLE WIDTH="100%" CELLPADDING=0 CELLSPACING=0 BORDER=0>
20         <TR>
21                 <TD ALIGN="CENTER" BGCOLOR="#D3D4C5">
22                         <TABLE CELLPADDING=0 CELLSPACING=0 BORDER=0>
23                                 <TR>
24                                         <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>
25                                         <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>
26                                         <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>
27                                         <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>
28                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="goals.html">goals</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
29                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="format.html">format</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
30                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="id.html">id</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
31                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="comparison.html">comparison</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
32                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;documentation&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
33                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="developers.html">developers</A>&nbsp;&nbsp;</TD>
34                                 </TR>
35                         </TABLE>
36                 </TD>
37         </TR>
38 </TABLE>
39
40 <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="2" ALT=""></TD></TR></TABLE>
41
42 <CENTER>
43
44 <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#99CC99"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="15" ALT=""></TD></TR></TABLE>
45
46
47 <TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
48 <TR><TD>
49         <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>
50         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
51                 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
52                 <B><FONT SIZE="+2">documentation</FONT></B>
53                 </FONT></TD></TR>
54         </TABLE>
55         <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>
56         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
57         <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
58         <P>
59                 This page describes the user-level view of the FLAC format (for a more detailed explanation see the <A HREF="format.html">format page</A>).  It also contains the user documentation for <B><TT>flac</TT></B>, which is the command-line file encoder/decoder, <B><TT>metaflac</TT></B>, the FLAC metadata editor, and the <A HREF="#plugins">input plugins</A>.
60         </P>
61         <P>
62                 Keep in mind that the online version of this document will always apply to the latest release.  For older releases, check the documentation included with the release package.
63         </P>
64         </FONT>
65         </TD></TR>
66         </TABLE>
67         <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>
68 </TD></TR>
69 </TABLE>
70
71
72 <TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
73 <TR><TD>
74         <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>
75         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
76                 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
77                 <B><FONT SIZE="+2">format</FONT></B>
78                 </FONT></TD></TR>
79         </TABLE>
80         <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>
81         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
82         <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
83         <P>
84                 See the <A HREF="format.html#scope">Scope</A>, <A HREF="format.html#architecture">Architecture</A>, <A HREF="format.html#definitions">Definitions</A>, and <A HREF="format.html#overview">Overview</A> sections of the <A HREF="format.html">format page</A> for a good introduction.  This section will be expanded in the future.
85         </P>
86         </FONT>
87         </TD></TR>
88         </TABLE>
89         <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>
90 </TD></TR>
91 </TABLE>
92
93
94 <TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
95 <TR><TD>
96         <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>
97         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
98                 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
99                 <B><FONT SIZE="+2">flac</FONT></B>
100                 </FONT></TD></TR>
101         </TABLE>
102         <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>
103         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
104         <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
105         <P>
106                 <B><TT>flac</TT></B> is the command-line file encoder/decoder.  The input to the encoder and the output to the decoder must either be RIFF WAVE format, or raw interleaved sample data.  <B><TT>flac</TT></B> only supports linear PCM samples (in other words, no A-LAW, uLAW, etc.).  Another restriction (hopefully short-term) is that the input must be 8, 16, or 24 bits per sample.  This is not a limitation of the FLAC format, just the reference encoder/decoder.
107         </P>
108         <P>
109                 <B><TT>flac</TT></B> assumes that RIFF WAVE files will have the extension ".wav"; this may be overridden with a command-line option.  For piped-in data, <B><TT>flac</TT></B> tries to determine the type by looking at the beginning of the file.  Other than this, <B><TT>flac</TT></B> makes no assumptions about file extensions, though the convention is that FLAC files have the extension ".flac" (or ".fla" on ancient file systems like FAT-16).
110         </P>
111         <P>
112                 Before going into the full command-line description, a few other things help to sort it out: 1) <B><TT>flac</TT></B> encodes by default, so you must use <B>-d</B> to decode; 2) the options <B><TT>-0</TT></B> .. <B><TT>-9</TT></B> that control the compression level actually are just synonyms for different groups of specific encoding options (described later) and you can get the same effect by using the same options; 3) <B><TT>flac</TT></B> behaves similarly to gzip in the way it handles input and output files.
113         </P>
114         <P>
115                 <B><TT>flac</TT></B> will be invoked one of four ways, depending on whether you are encoding, decoding, testing, or analyzing:
116                 <UL>
117                 <LI>
118                         Encoding: flac [-s] [--skip #] [<I><A HREF="#format_options">&lt;format-options&gt;</A></I>] [<I><A HREF="#encoding_options">&lt;encoding options&gt;</A></I>] [inputfile [...]]
119                 </LI>
120                 <LI>
121                         Decoding: flac -d [-s] [--skip #] [<I><A HREF="#format_options">&lt;format-options&gt;</A></I>] [inputfile [...]]
122                 </LI>
123                 <LI>
124                         Testing: flac -t [-s] [inputfile [...]]
125                 </LI>
126                 <LI>
127                         Analyzing: flac -a [-s] [--skip #] [<I><A HREF="#analysis_options">&lt;analysis-options&gt;</A></I>] [inputfile [...]]
128                 </LI>
129                 </UL>
130         </P>
131         <P>
132                 In any case, if no <TT>inputfile</TT> is specified, stdin is assumed.  If only one inputfile is specified, it may be "-" for stdin.  When stdin is used as input, <B><TT>flac</TT></B> will write to stdout.  Otherwise <B><TT>flac</TT></B> will perform the desired operation on each input file to similarly named output files (meaning for encoding, the extension will be replaced with ".flac", or appended with ".flac" if the input file has no extension, and for decoding, the extension will be ".wav" for WAVE output and ".raw" for raw output).  The original file is not deleted unless --delete-input-file is specified.
133         </P>
134         <P>
135                 If you are encoding/decoding from stdin to a file, you should use the -o option like so:
136                 <UL>
137                 <LI>
138                         flac [options] -o outputfile
139                 </LI>
140                 <LI>
141                         flac -d [options] -o outputfile
142                 </LI>
143                 </UL>
144                 which are better than:
145                 <UL>
146                 <LI>
147                         flac [options] &gt; outputfile
148                 </LI>
149                 <LI>
150                         flac -d [options] &gt; outputfile
151                 </LI>
152                 </UL>
153                 since the former allows flac to seek backwards to write the STREAMINFO or RIFF WAVE header contents when necessary.
154         </P>
155         <P>
156                 Also, you can force output data to go to stdout using <TT>-c</TT>.
157         </P>
158         <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 file the format options are not needed since they are read from the WAVE header.
159         </P>
160         <P>
161                 In test mode, <B><TT>flac</TT></B> acts just like in decode mode, except no output file is written.  Both decode and test modes detect errors in the stream, but they also detect when the MD5 signature of the decoded audio does not match the stored MD5 signature, even when the bitstream is valid.
162         </P>
163         <P>
164         <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
165         <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
166                 <TR>
167                         <TD COLSPAN="2" BGCOLOR="#D3D4C5">
168                                 <A NAME="general_options"><FONT SIZE="+1"><B>General Options</B></FONT></A>
169                         </TD>
170                 </TR>
171                 <TR>
172                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
173                                 <TT>-d</TT>
174                         </TD>
175                         <TD>
176                                 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>.
177                         </TD>
178                 </TR>
179                 <TR>
180                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
181                                 <TT>-t</TT>
182                         </TD>
183                         <TD>
184                                 Test (same as <B><TT>-d</TT></B> except no decoded file is written).  The exit codes are the same as in decode mode.
185                         </TD>
186                 </TR>
187                 <TR>
188                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
189                                 <TT>-a</TT>
190                         </TD>
191                         <TD>
192                                 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.
193                         </TD>
194                 </TR>
195                 <TR>
196                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
197                                 <TT>-c</TT>
198                         </TD>
199                         <TD>
200                                 Write output to stdout
201                         </TD>
202                 </TR>
203                 <TR>
204                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
205                                 <TT>-s</TT>
206                         </TD>
207                         <TD>
208                                 Silent: do not show encoding/decoding statistics.
209                         </TD>
210                 </TR>
211                 <TR>
212                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
213                                 <TT>-o filename</TT>
214                         </TD>
215                         <TD>
216                                 Force the output file name (usually <TT>flac</TT> just changes the extension).
217                         </TD>
218                 </TR>
219                 <TR>
220                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
221                                 <TT>--delete-input-file</TT>
222                         </TD>
223                         <TD>
224                                 Automatically delete the input file after a successful encode or decode.  If there was an error (including a verify error) the input file is left intact.
225                         </TD>
226                 </TR>
227                 <TR>
228                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
229                                 <TT>--skip #</TT>
230                         </TD>
231                         <TD>
232                                 Skip over the first # of samples of the input.  This works for both encoding and decoding, but not testing.
233                         </TD>
234                 </TR>
235         </TABLE>
236         </TD></TR></TABLE>
237         </P>
238         <P>
239         <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
240         <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
241                 <TR>
242                         <TD COLSPAN="2" BGCOLOR="#D3D4C5">
243                                 <A NAME="analysis_options"><FONT SIZE="+1"><B>Analysis Options</B></FONT></A>
244                         </TD>
245                 </TR>
246                 <TR>
247                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
248                                 --a-rtext
249                         </TD>
250                         <TD>
251                                 Includes the residual signal in the analysis file.  This will make the file <B>very</B> big, much larger than even the decoded file.
252                         </TD>
253                 </TR>
254                 <TR>
255                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
256                                 --a-rgp
257                         </TD>
258                         <TD>
259                                 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.
260                         </TD>
261                 </TR>
262         </TABLE>
263         </TD></TR></TABLE>
264         </P>
265         <P>
266         <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
267         <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
268                 <TR>
269                         <TD COLSPAN="2" BGCOLOR="#D3D4C5">
270                                 <A NAME="encoding_options"><FONT SIZE="+1"><B>Encoding Options</B></FONT></A>
271                         </TD>
272                 </TR>
273                 <TR>
274                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
275                                 --lax
276                         </TD>
277                         <TD>
278                                 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.
279                         </TD>
280                 </TR>
281                 <TR>
282                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
283                                 -S { # | X | #x }
284                         </TD>
285                         <TD>
286                                 Include a point or points in a SEEKTABLE:<BR>
287                                 <UL>
288                                 <LI>
289                                         <TT>#&nbsp;</TT> : a specific sample number for a seek point
290                                 </LI>
291                                 <LI>
292                                         <TT>X&nbsp;</TT> : a placeholder point (always goes at the end of the SEEKTABLE)
293                                 </LI>
294                                 <LI>
295                                         <TT>#x</TT> : # evenly spaced seekpoints, the first being at sample 0
296                                 </LI>
297                                 </UL>
298                                 You may use many -S options; the resulting SEEKTABLE will be the unique-ified union of all such values.<BR>
299                                 With no -S options, flac defaults to '-S 100x'.  Use -S- for no SEEKTABLE.<BR>
300                                 NOTE: -S #x will not work if the encoder can't determine the input size before starting.<BR>
301                                 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>
302                         </TD>
303                 </TR>
304                 <TR>
305                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
306                                 -P #
307                         </TD>
308                         <TD>
309                                   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.
310                         </TD>
311                 </TR>
312                 <TR>
313                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
314                                 -b #
315                         </TD>
316                         <TD>
317                                 Specify the blocksize 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 blocksize for the entire stream.
318                         </TD>
319                 </TR>
320                 <TR>
321                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
322                                 -m
323                         </TD>
324                         <TD>
325                                 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.
326                         </TD>
327                 </TR>
328                 <TR>
329                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
330                                 -M
331                         </TD>
332                         <TD>
333                                 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).
334                         </TD>
335                 </TR>
336                 <TR>
337                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
338                                 -0 .. -9
339                         </TD>
340                         <TD>
341                                 Fastest compression .. highest compression.  The default is <TT>-5</TT>.
342                         </TD>
343                 </TR>
344                 <TR>
345                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
346                                 -0
347                         </TD>
348                         <TD>
349                                 Synonymous with -l 0 -b 1152 -r 2,2
350                         </TD>
351                 </TR>
352                 <TR>
353                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
354                                 -1
355                         </TD>
356                         <TD>
357                                 Synonymous with -l 0 -b 1152 -M -r 2,2
358                         </TD>
359                 </TR>
360                 <TR>
361                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
362                                 -2
363                         </TD>
364                         <TD>
365                                 Synonymous with -l 0 -b 1152 -m -r 3
366                         </TD>
367                 </TR>
368                 <TR>
369                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
370                                 -3
371                         </TD>
372                         <TD>
373                                 Synonymous with -l 6 -b 4608 -r 3,3
374                         </TD>
375                 </TR>
376                 <TR>
377                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
378                                 -4
379                         </TD>
380                         <TD>
381                                 Synonymous with -l 8 -b 4608 -M -r 3,3
382                         </TD>
383                 </TR>
384                 <TR>
385                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
386                                 -5
387                         </TD>
388                         <TD>
389                                 Synonymous with -l 8 -b 4608 -m -r 3,3
390                         </TD>
391                 </TR>
392                 <TR>
393                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
394                                 -6
395                         </TD>
396                         <TD>
397                                 Synonymous with -l 8 -b 4608 -m -r 4
398                         </TD>
399                 </TR>
400                 <TR>
401                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
402                                 -7
403                         </TD>
404                         <TD>
405                                 Synonymous with -l 8 -b 4608 -m -e -r 6
406                         </TD>
407                 </TR>
408                 <TR>
409                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
410                                 -8
411                         </TD>
412                         <TD>
413                                 Synonymous with -l 12 -b 4608 -m -e -r 6
414                         </TD>
415                 </TR>
416                 <TR>
417                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
418                                 -9
419                         </TD>
420                         <TD>
421                                 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 blocksize.
422                         </TD>
423                 </TR>
424                 <TR>
425                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
426                                 -e
427                         </TD>
428                         <TD>
429                                 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%.
430                         </TD>
431                 </TR>
432                 <TR>
433                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
434                                 -l #
435                         </TD>
436                         <TD>
437                                 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.
438                         </TD>
439                 </TR>
440                 <TR>
441                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
442                                 -q #
443                         </TD>
444                         <TD>
445                                 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.
446                         </TD>
447                 </TR>
448                 <TR>
449                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
450                                 -p
451                         </TD>
452                         <TD>
453                                 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.
454                         </TD>
455                 </TR>
456                 <TR>
457                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
458                                 -r [#,]#
459                         </TD>
460                         <TD>
461                                 Set the [min,]max residual partition order.  The min value defaults to 0 if unspecified.<BR>
462                                 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 blocksizes).  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.
463                         </TD>
464                 </TR>
465                 <TR>
466                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
467                                 -R #
468                         </TD>
469                         <TD>
470                                 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.
471                         </TD>
472                 </TR>
473                 <TR>
474                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
475                                 -V
476                         </TD>
477                         <TD>
478                                 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.
479                         </TD>
480                 </TR>
481                 <TR>
482                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
483                         </TD>
484                         <TD>
485                                 <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.
486                         </TD>
487                 </TR>
488         </TABLE>
489         </TD></TR></TABLE>
490         </P>
491         <P>
492         <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
493         <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
494                 <TR>
495                         <TD COLSPAN="2" BGCOLOR="#D3D4C5">
496                                 <A NAME="format_options"><FONT SIZE="+1"><B>Format Options</B></FONT></A>
497                         </TD>
498                 </TR>
499                 <TR>
500                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
501                                 -fb | -fl
502                         </TD>
503                         <TD>
504                                 Specify big-endian | little-endian byte order in the raw file.
505                         </TD>
506                 </TR>
507                 <TR>
508                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
509                                 -fc #
510                         </TD>
511                         <TD>
512                                 Specify the number of channels in the raw file.
513                         </TD>
514                 </TR>
515                 <TR>
516                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
517                                 -fp #
518                         </TD>
519                         <TD>
520                                 Specify the number of bits per sample in the raw file.
521                         </TD>
522                 </TR>
523                 <TR>
524                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
525                                 -fs #
526                         </TD>
527                         <TD>
528                                 Specify the sample rate of the raw file.
529                         </TD>
530                 </TR>
531                 <TR>
532                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
533                                 -fu
534                         </TD>
535                         <TD>
536                                 Specify that the samples in the raw file are unsigned (the default is signed).
537                         </TD>
538                 </TR>
539                 <TR>
540                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
541                                 -fr
542                         </TD>
543                         <TD>
544                                 Treat the input file (or output file if decoding) as a raw file, regardless of the extension.
545                         </TD>
546                 </TR>
547                 <TR>
548                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
549                                 -fw
550                         </TD>
551                         <TD>
552                                 Treat the input file (or output file if decoding) as a RIFF WAVE file, regardless of the extension.
553                         </TD>
554                 </TR>
555         </TABLE>
556         </TD></TR></TABLE>
557         </P>
558         </FONT>
559         </TD></TR>
560         </TABLE>
561         <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>
562 </TD></TR>
563 </TABLE>
564
565
566 <TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
567 <TR><TD>
568         <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>
569         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
570                 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
571                 <B><FONT SIZE="+2">metaflac</FONT></B>
572                 </FONT></TD></TR>
573         </TABLE>
574         <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>
575         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
576         <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
577         <P>
578                 <B><TT>metaflac</TT></B> is the command-line <TT>.flac</TT> file metadata editor.  Right now it just lists the contents of all metadata blocks in a .flac file, but soon it will allow you to insert, delete, and edit blocks.
579         </P>
580         <P>
581                 Currently <B><TT>metaflac</TT></B> can be invoked only one way:
582                 <UL>
583                 <LI>
584                         Listing: metaflac [-v] inputfile
585                 </LI>
586                 </UL>
587         </P>
588         <P>
589                 <TT>inputfile</TT> may be "-" for stdin.  If <TT>-v</TT> is used, you will get verbose output.
590         </P>
591         </FONT>
592         </TD></TR>
593         </TABLE>
594         <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>
595 </TD></TR>
596 </TABLE>
597
598
599 <TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
600 <TR><TD>
601         <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>
602         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
603                 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
604                 <A NAME="plugins"><B><FONT SIZE="+2">xmms plugin</FONT></B></A>
605                 </FONT></TD></TR>
606         </TABLE>
607         <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>
608         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
609         <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
610         <P>
611                 All that is necessary is to copy <B><TT>libxmms-flac.so</TT></B> to the directory where XMMS looks for input plugins (usually <B><TT>/usr/lib/xmms/Input</TT></B>).  There is nothing else to configure.  Make sure to restart XMMS before trying to play any <TT>.flac</TT> files.
612         </P>
613         </FONT>
614         </TD></TR>
615         </TABLE>
616         <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>
617 </TD></TR>
618 </TABLE>
619
620
621 <TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
622 <TR><TD>
623         <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>
624         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
625                 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
626                 <B><FONT SIZE="+2">winamp plugin</FONT></B>
627                 </FONT></TD></TR>
628         </TABLE>
629         <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>
630         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
631         <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
632         <P>
633                 All that is necessary is to copy <B><TT>in_flac.dll</TT></B> to the <B><TT>Plugins/</TT></B> directory of your Winamp installation.  There is nothing else to configure.  Make sure to restart Winamp before trying to play any <TT>.flac</TT> files.
634         </P>
635         </FONT>
636         </TD></TR>
637         </TABLE>
638         <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>
639 </TD></TR>
640 </TABLE>
641
642
643 <TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
644 <TR><TD>
645         <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>
646         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
647                 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
648                 <B><FONT SIZE="+2">known bugs</FONT></B>
649                 </FONT></TD></TR>
650         </TABLE>
651         <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>
652         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
653         <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
654         <P>
655                 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, please provide an email contact and/or use the Monitor feature.
656         </P>
657         </FONT>
658         </TD></TR>
659         </TABLE>
660         <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>
661 </TD></TR>
662 </TABLE>
663
664
665 </CENTER>
666
667 </BODY>
668 </HTML>