6d2c45781c59119a76331a7409ed31157cc780b3
[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="comparison.html">comparison</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
31                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;documentation&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
32                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="developers.html">developers</A>&nbsp;&nbsp;</TD>
33                                 </TR>
34                         </TABLE>
35                 </TD>
36         </TR>
37 </TABLE>
38
39 <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>
40
41 <CENTER>
42
43 <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>
44
45
46 <TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
47 <TR><TD>
48         <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>
49         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
50                 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
51                 <B><FONT SIZE="+2">documentation</FONT></B>
52                 </FONT></TD></TR>
53         </TABLE>
54         <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>
55         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
56         <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
57         <P>
58                 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, and the <A HREF="#plugins">input plugins</A>.
59         </P>
60         <P>
61                 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.
62         </P>
63         </FONT>
64         </TD></TR>
65         </TABLE>
66         <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>
67 </TD></TR>
68 </TABLE>
69
70
71 <TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
72 <TR><TD>
73         <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>
74         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
75                 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
76                 <B><FONT SIZE="+2">format</FONT></B>
77                 </FONT></TD></TR>
78         </TABLE>
79         <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>
80         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
81         <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
82         <P>
83                 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.
84         </P>
85         </FONT>
86         </TD></TR>
87         </TABLE>
88         <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>
89 </TD></TR>
90 </TABLE>
91
92
93 <TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
94 <TR><TD>
95         <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>
96         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
97                 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
98                 <B><FONT SIZE="+2">flac</FONT></B>
99                 </FONT></TD></TR>
100         </TABLE>
101         <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>
102         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
103         <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
104         <P>
105                 <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 or 16 bits per sample.  This is not a limitation of the FLAC format, just the reference encoder.
106         </P>
107         <P>
108                 <B><TT>flac</TT></B> assumes that RIFF WAVE files will have the extension ".wav"; this may be overridden with a command-line option.  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).
109         </P>
110         <P>
111                 Before going into the full command-line description, two 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 coding options (described later).  You can get the same effect by using the same options.
112         </P>
113         <P>
114                 <B><TT>flac</TT></B> will be invoked one of three ways, depending on whether you are encoding, decoding, or testing:
115                 <UL>
116                 <LI>
117                         Encoding: flac [-s] [--skip #] [&lt;format-options&gt;] [&lt;encoding options&gt;] inputfile outputfile
118                 </LI>
119                 <LI>
120                         Decoding: flac -d [-s] [--skip #] [&lt;format-options&gt;] inputfile outputfile
121                 </LI>
122                 <LI>
123                         Testing: flac -t [-s] inputfile
124                 </LI>
125                 </UL>
126         </P>
127         <P>
128                 In either case, inputfile may be "-" for stdin, and the outputfile "-" for stdout.  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.
129         </P>
130         <P>
131                 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.
132         </P>
133         <P>
134         <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
135         <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
136                 <TR>
137                         <TD COLSPAN="2" BGCOLOR="#D3D4C5">
138                                 <FONT SIZE="+1"><B>General Options</B></FONT>
139                         </TD>
140                 </TR>
141                 <TR>
142                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
143                                 -d
144                         </TD>
145                         <TD>
146                                 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>.
147                         </TD>
148                 </TR>
149                 <TR>
150                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
151                                 -t
152                         </TD>
153                         <TD>
154                                 Test (same as <B><TT>-d</TT></B> except no decoded file is written).  The exit codes are the same as in decode mode.
155                         </TD>
156                 </TR>
157                 <TR>
158                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
159                                 -s
160                         </TD>
161                         <TD>
162                                 Silent: do not show encoding/decoding statistics.
163                         </TD>
164                 </TR>
165                 <TR>
166                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
167                                 --skip #
168                         </TD>
169                         <TD>
170                                 Skip over the first # of samples of the input.  This works for both encoding and decoding, but not testing.
171                         </TD>
172                 </TR>
173         </TABLE>
174         </TD></TR></TABLE>
175         </P>
176         <P>
177         <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
178         <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
179                 <TR>
180                         <TD COLSPAN="2" BGCOLOR="#D3D4C5">
181                                 <FONT SIZE="+1"><B>Encoding Options</B></FONT>
182                         </TD>
183                 </TR>
184                 <TR>
185                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
186                                 --lax
187                         </TD>
188                         <TD>
189                                 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.
190                         </TD>
191                 </TR>
192                 <TR>
193                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
194                                 -b #
195                         </TD>
196                         <TD>
197                                 Set the blocksize.  The default is 1152 for -l 0, otherwise 4608.  Subset streams must use one of 192/576/1152/2304/4608.  The current encoder uses the same blocksize for the entire stream.
198                         </TD>
199                 </TR>
200                 <TR>
201                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
202                                 -m
203                         </TD>
204                         <TD>
205                                 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.
206                         </TD>
207                 </TR>
208                 <TR>
209                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
210                                 -0 .. -9
211                         </TD>
212                         <TD>
213                                 Fastest compression .. highest compression.  The default is <TT>-6</TT>.
214                         </TD>
215                 </TR>
216                 <TR>
217                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
218                                 -0
219                         </TD>
220                         <TD>
221                                 Synonymous with -l 0
222                         </TD>
223                 </TR>
224                 <TR>
225                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
226                                 -1
227                         </TD>
228                         <TD>
229                                 Synonymous with -l 0 -m
230                         </TD>
231                 </TR>
232                 <TR>
233                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
234                                 -2
235                         </TD>
236                         <TD>
237                                 Synonymous with -l 0 -m -r # (where # is set based on the blocksize)
238                         </TD>
239                 </TR>
240                 <TR>
241                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
242                                 -3
243                         </TD>
244                         <TD>
245                                 Reserved
246                         </TD>
247                 </TR>
248                 <TR>
249                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
250                                 -4
251                         </TD>
252                         <TD>
253                                 Synonymous with -l 8
254                         </TD>
255                 </TR>
256                 <TR>
257                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
258                                 -5
259                         </TD>
260                         <TD>
261                                 Synonymous with -l 8 -m
262                         </TD>
263                 </TR>
264                 <TR>
265                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
266                                 -6
267                         </TD>
268                         <TD>
269                                 Synonymous with -l 8 -m -r # (where # is set based on the blocksize)
270                         </TD>
271                 </TR>
272                 <TR>
273                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
274                                 -7
275                         </TD>
276                         <TD>
277                                 Reserved
278                         </TD>
279                 </TR>
280                 <TR>
281                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
282                                 -8
283                         </TD>
284                         <TD>
285                                 Synonymous with -l 32 -m -r # (where # is set based on the blocksize)
286                         </TD>
287                 </TR>
288                 <TR>
289                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
290                                 -9
291                         </TD>
292                         <TD>
293                                 Synonymous with -l 32 -m -e -r 99 -p.  This is painfully slow but gives you the maximum compression <B><TT>flac</TT></B> can do for a given blocksize.
294                         </TD>
295                 </TR>
296                 <TR>
297                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
298                                 -e
299                         </TD>
300                         <TD>
301                                 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%.
302                         </TD>
303                 </TR>
304                 <TR>
305                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
306                                 -l #
307                         </TD>
308                         <TD>
309                                 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.
310                         </TD>
311                 </TR>
312                 <TR>
313                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
314                                 -q #
315                         </TD>
316                         <TD>
317                                 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.
318                         </TD>
319                 </TR>
320                 <TR>
321                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
322                                 -p
323                         </TD>
324                         <TD>
325                                 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.
326                         </TD>
327                 </TR>
328                 <TR>
329                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
330                                 -r #
331                         </TD>
332                         <TD>
333                                 Do Rice parameter optimization.  By default the encoder uses a single Rice parameter for the subframe's entire residual.  With this option, the residual is partitioned into 2^n pieces, each with its own Rice parameter.  Higher values of n yield diminishing returns.  The most bang for the buck is usually with <B><TT>-r 2</TT></B> (more for higher blocksizes).  This usually shaves off another 1.5%.  The technique tends to peak out about when blocksize/(2^n)=128.  Use <B><TT>-r 99</TT></B> to force the highest degree of optimization.
334                         </TD>
335                 </TR>
336                 <TR>
337                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
338                                 -V
339                         </TD>
340                         <TD>
341                                 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.
342                         </TD>
343                 </TR>
344                 <TR>
345                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
346                         </TD>
347                         <TD>
348                                 -m-, -e-, -p-, -V-, --lax- can all be used to turn off a particular option.
349                         </TD>
350                 </TR>
351         </TABLE>
352         </TD></TR></TABLE>
353         </P>
354         <P>
355         <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
356         <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
357                 <TR>
358                         <TD COLSPAN="2" BGCOLOR="#D3D4C5">
359                                 <FONT SIZE="+1"><B>Format Options</B></FONT>
360                         </TD>
361                 </TR>
362                 <TR>
363                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
364                                 -fb | -fl
365                         </TD>
366                         <TD>
367                                 Specify big-endian | little-endian byte order in the raw file.
368                         </TD>
369                 </TR>
370                 <TR>
371                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
372                                 -fc #
373                         </TD>
374                         <TD>
375                                 Specify the number of channels in the raw file.
376                         </TD>
377                 </TR>
378                 <TR>
379                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
380                                 -fp #
381                         </TD>
382                         <TD>
383                                 Specify the number of bits per sample in the raw file.
384                         </TD>
385                 </TR>
386                 <TR>
387                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
388                                 -fs #
389                         </TD>
390                         <TD>
391                                 Specify the sample rate of the raw file.
392                         </TD>
393                 </TR>
394                 <TR>
395                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
396                                 -fu
397                         </TD>
398                         <TD>
399                                 Specify that the samples in the raw file are unsigned (the default is signed).
400                         </TD>
401                 </TR>
402                 <TR>
403                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
404                                 -fr
405                         </TD>
406                         <TD>
407                                 Treat the input file (or output file if decoding) as a raw file, regardless of the extension.
408                         </TD>
409                 </TR>
410                 <TR>
411                         <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
412                                 -fw
413                         </TD>
414                         <TD>
415                                 Treat the input file (or output file if decoding) as a RIFF WAVE file, regardless of the extension.
416                         </TD>
417                 </TR>
418         </TABLE>
419         </TD></TR></TABLE>
420         </P>
421         </FONT>
422         </TD></TR>
423         </TABLE>
424         <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>
425 </TD></TR>
426 </TABLE>
427
428
429 <TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
430 <TR><TD>
431         <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>
432         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
433                 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
434                 <A NAME="plugins"><B><FONT SIZE="+2">xmms plugin</FONT></B></A>
435                 </FONT></TD></TR>
436         </TABLE>
437         <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>
438         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
439         <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
440         <P>
441                 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 .flac files.
442         </P>
443         </FONT>
444         </TD></TR>
445         </TABLE>
446         <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>
447 </TD></TR>
448 </TABLE>
449
450
451 <TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
452 <TR><TD>
453         <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>
454         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
455                 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
456                 <B><FONT SIZE="+2">winamp plugin</FONT></B>
457                 </FONT></TD></TR>
458         </TABLE>
459         <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>
460         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
461         <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
462         <P>
463                 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 .flac files.
464         </P>
465         </FONT>
466         </TD></TR>
467         </TABLE>
468         <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>
469 </TD></TR>
470 </TABLE>
471
472
473 <TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
474 <TR><TD>
475         <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>
476         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
477                 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
478                 <B><FONT SIZE="+2">known bugs</FONT></B>
479                 </FONT></TD></TR>
480         </TABLE>
481         <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>
482         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
483         <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
484         <P>
485                 Here's the list of the known bugs.  None of them threaten the archival quality of <B><TT>flac</TT></B>.
486                 <UL>
487                         <LI>Encoding/decoding to/from pipes in the MSVC version of <B><TT>flac</TT></B> is broken.  I assume a Cygwin version would be fine but I haven't got around to checking that yet.</LI>
488                         <LI>The Winamp 2 plugin sporadically hangs at the end of a file.  This one has been low priority since I'm focusing on Winamp 3, which has a better plugin architecture.</LI>
489                 </UL>
490         </P>
491         </FONT>
492         </TD></TR>
493         </TABLE>
494         <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>
495 </TD></TR>
496 </TABLE>
497
498
499 </CENTER>
500
501 </BODY>
502 </HTML>