Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / flac / f6b5246a8d62897398bfeea68b0937bebf793413 / . / doc / documentation.html
blob: b769a9b2322573226b77897860f827cf6e89dacc [file] [log] [blame]
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]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>
Josh Coalsonf6b52462001-03-02 21:21:08 +0000[diff] [blame^]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>
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]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>
Josh Coalson64e8ef72001-02-23 23:27:59 +0000[diff] [blame]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>.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]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 or 16 bits per sample. This is not a limitation of the FLAC format, just the reference encoder.
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. 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, 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.
113 </P>
114 <P>
Josh Coalsonab477602001-01-26 22:37:10 +0000[diff] [blame]115 <B><TT>flac</TT></B> will be invoked one of four ways, depending on whether you are encoding, decoding, testing, or analyzing:
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]116 <UL>
117 <LI>
Josh Coalsoned840cd2000-12-22 22:43:50 +0000[diff] [blame]118 Encoding: flac [-s] [--skip #] [&lt;format-options&gt;] [&lt;encoding options&gt;] inputfile outputfile
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]119 </LI>
120 <LI>
Josh Coalsoned840cd2000-12-22 22:43:50 +0000[diff] [blame]121 Decoding: flac -d [-s] [--skip #] [&lt;format-options&gt;] inputfile outputfile
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]122 </LI>
Josh Coalsondfad4612001-01-13 00:32:32 +0000[diff] [blame]123 <LI>
124 Testing: flac -t [-s] inputfile
125 </LI>
Josh Coalsonab477602001-01-26 22:37:10 +0000[diff] [blame]126 <LI>
127 Analyzing: flac -a [-s] [--skip #] inputfile outputfile
128 </LI>
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]129 </UL>
130 </P>
131 <P>
Josh Coalson64e8ef72001-02-23 23:27:59 +0000[diff] [blame]132 In either case, <TT>inputfile</TT> may be "-" for stdin, and the <TT>outputfile</TT> "-" 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.
Josh Coalsondfad4612001-01-13 00:32:32 +0000[diff] [blame]133 </P>
134 <P>
135 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.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]136 </P>
137 <P>
138 <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
139 <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
140 <TR>
141 <TD COLSPAN="2" BGCOLOR="#D3D4C5">
142 <FONT SIZE="+1"><B>General Options</B></FONT>
143 </TD>
144 </TR>
145 <TR>
146 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
147 -d
148 </TD>
149 <TD>
Josh Coalsondfad4612001-01-13 00:32:32 +0000[diff] [blame]150 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>.
151 </TD>
152 </TR>
153 <TR>
154 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
155 -t
156 </TD>
157 <TD>
158 Test (same as <B><TT>-d</TT></B> except no decoded file is written). The exit codes are the same as in decode mode.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]159 </TD>
160 </TR>
161 <TR>
162 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonab477602001-01-26 22:37:10 +0000[diff] [blame]163 -a
164 </TD>
165 <TD>
166 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.
167 </TD>
168 </TR>
169 <TR>
170 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]171 -s
172 </TD>
173 <TD>
174 Silent: do not show encoding/decoding statistics.
175 </TD>
176 </TR>
177 <TR>
178 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
179 --skip #
180 </TD>
181 <TD>
Josh Coalsondfad4612001-01-13 00:32:32 +0000[diff] [blame]182 Skip over the first # of samples of the input. This works for both encoding and decoding, but not testing.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]183 </TD>
184 </TR>
185 </TABLE>
186 </TD></TR></TABLE>
187 </P>
188 <P>
189 <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
190 <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
191 <TR>
192 <TD COLSPAN="2" BGCOLOR="#D3D4C5">
193 <FONT SIZE="+1"><B>Encoding Options</B></FONT>
194 </TD>
195 </TR>
196 <TR>
197 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
198 --lax
199 </TD>
200 <TD>
201 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.
202 </TD>
203 </TR>
204 <TR>
205 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonbd85fd62001-02-23 21:26:05 +0000[diff] [blame]206 -P #
207 </TD>
208 <TD>
209 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.
210 </TD>
211 </TR>
212 <TR>
213 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]214 -b #
215 </TD>
216 <TD>
217 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.
218 </TD>
219 </TR>
220 <TR>
221 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
222 -m
223 </TD>
224 <TD>
225 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.
226 </TD>
227 </TR>
228 <TR>
229 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalson5a0e0fa2001-01-28 09:47:22 +0000[diff] [blame]230 -M
231 </TD>
232 <TD>
Josh Coalson11ce4e02001-01-28 09:50:26 +0000[diff] [blame]233 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).
Josh Coalson5a0e0fa2001-01-28 09:47:22 +0000[diff] [blame]234 </TD>
235 </TR>
236 <TR>
237 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]238 -0 .. -9
239 </TD>
240 <TD>
241 Fastest compression .. highest compression. The default is <TT>-6</TT>.
242 </TD>
243 </TR>
244 <TR>
245 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
246 -0
247 </TD>
248 <TD>
249 Synonymous with -l 0
250 </TD>
251 </TR>
252 <TR>
253 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
254 -1
255 </TD>
256 <TD>
Josh Coalson5a0e0fa2001-01-28 09:47:22 +0000[diff] [blame]257 Synonymous with -l 0 -M
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]258 </TD>
259 </TR>
260 <TR>
261 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
262 -2
263 </TD>
264 <TD>
265 Synonymous with -l 0 -m -r # (where # is set based on the blocksize)
266 </TD>
267 </TR>
268 <TR>
269 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
270 -3
271 </TD>
272 <TD>
273 Reserved
274 </TD>
275 </TR>
276 <TR>
277 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
278 -4
279 </TD>
280 <TD>
281 Synonymous with -l 8
282 </TD>
283 </TR>
284 <TR>
285 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
286 -5
287 </TD>
288 <TD>
Josh Coalson5a0e0fa2001-01-28 09:47:22 +0000[diff] [blame]289 Synonymous with -l 8 -M
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]290 </TD>
291 </TR>
292 <TR>
293 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
294 -6
295 </TD>
296 <TD>
297 Synonymous with -l 8 -m -r # (where # is set based on the blocksize)
298 </TD>
299 </TR>
300 <TR>
301 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
302 -7
303 </TD>
304 <TD>
305 Reserved
306 </TD>
307 </TR>
308 <TR>
309 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
310 -8
311 </TD>
312 <TD>
313 Synonymous with -l 32 -m -r # (where # is set based on the blocksize)
314 </TD>
315 </TR>
316 <TR>
317 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
318 -9
319 </TD>
320 <TD>
321 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.
322 </TD>
323 </TR>
324 <TR>
325 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
326 -e
327 </TD>
328 <TD>
329 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%.
330 </TD>
331 </TR>
332 <TR>
333 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
334 -l #
335 </TD>
336 <TD>
337 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.
338 </TD>
339 </TR>
340 <TR>
341 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
342 -q #
343 </TD>
344 <TD>
345 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.
346 </TD>
347 </TR>
348 <TR>
349 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
350 -p
351 </TD>
352 <TD>
Josh Coalsone665f2d2001-02-08 00:29:58 +0000[diff] [blame]353 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.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]354 </TD>
355 </TR>
356 <TR>
357 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
358 -r #
359 </TD>
360 <TD>
361 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.
362 </TD>
363 </TR>
364 <TR>
365 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsoned840cd2000-12-22 22:43:50 +0000[diff] [blame]366 -V
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]367 </TD>
368 <TD>
Josh Coalsoned840cd2000-12-22 22:43:50 +0000[diff] [blame]369 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.
370 </TD>
371 </TR>
372 <TR>
373 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
374 </TD>
375 <TD>
376 -m-, -e-, -p-, -V-, --lax- can all be used to turn off a particular option.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]377 </TD>
378 </TR>
379 </TABLE>
380 </TD></TR></TABLE>
381 </P>
382 <P>
383 <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
384 <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
385 <TR>
386 <TD COLSPAN="2" BGCOLOR="#D3D4C5">
387 <FONT SIZE="+1"><B>Format Options</B></FONT>
388 </TD>
389 </TR>
390 <TR>
391 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
392 -fb | -fl
393 </TD>
394 <TD>
395 Specify big-endian | little-endian byte order in the raw file.
396 </TD>
397 </TR>
398 <TR>
399 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
400 -fc #
401 </TD>
402 <TD>
403 Specify the number of channels in the raw file.
404 </TD>
405 </TR>
406 <TR>
407 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
408 -fp #
409 </TD>
410 <TD>
411 Specify the number of bits per sample in the raw file.
412 </TD>
413 </TR>
414 <TR>
415 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
416 -fs #
417 </TD>
418 <TD>
419 Specify the sample rate of the raw file.
420 </TD>
421 </TR>
422 <TR>
423 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
424 -fu
425 </TD>
426 <TD>
427 Specify that the samples in the raw file are unsigned (the default is signed).
428 </TD>
429 </TR>
430 <TR>
431 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
432 -fr
433 </TD>
434 <TD>
435 Treat the input file (or output file if decoding) as a raw file, regardless of the extension.
436 </TD>
437 </TR>
438 <TR>
439 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
440 -fw
441 </TD>
442 <TD>
443 Treat the input file (or output file if decoding) as a RIFF WAVE file, regardless of the extension.
444 </TD>
445 </TR>
446 </TABLE>
447 </TD></TR></TABLE>
448 </P>
449 </FONT>
450 </TD></TR>
451 </TABLE>
452 <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>
453</TD></TR>
454</TABLE>
455
456
457<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
458<TR><TD>
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="#D3D4C5">
461 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
Josh Coalson64e8ef72001-02-23 23:27:59 +0000[diff] [blame]462 <B><FONT SIZE="+2">metaflac</FONT></B>
463 </FONT></TD></TR>
464 </TABLE>
465 <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>
466 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
467 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
468 <P>
469 <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.
470 </P>
471 <P>
472 Currently <B><TT>metaflac</TT></B> can be invoked only one way:
473 <UL>
474 <LI>
475 Listing: metaflac [-v] inputfile
476 </LI>
477 </UL>
478 </P>
479 <P>
480 <TT>inputfile</TT> may be "-" for stdin. If <TT>-v</TT> is used, you will get verbose output.
481 </P>
482 </FONT>
483 </TD></TR>
484 </TABLE>
485 <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>
486</TD></TR>
487</TABLE>
488
489
490<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
491<TR><TD>
492 <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>
493 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
494 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]495 <A NAME="plugins"><B><FONT SIZE="+2">xmms plugin</FONT></B></A>
496 </FONT></TD></TR>
497 </TABLE>
498 <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>
499 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
500 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
501 <P>
Josh Coalson64e8ef72001-02-23 23:27:59 +0000[diff] [blame]502 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.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]503 </P>
504 </FONT>
505 </TD></TR>
506 </TABLE>
507 <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>
508</TD></TR>
509</TABLE>
510
511
512<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
513<TR><TD>
514 <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>
515 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
516 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
517 <B><FONT SIZE="+2">winamp plugin</FONT></B>
518 </FONT></TD></TR>
519 </TABLE>
520 <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>
521 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
522 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
523 <P>
Josh Coalson64e8ef72001-02-23 23:27:59 +0000[diff] [blame]524 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.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]525 </P>
526 </FONT>
527 </TD></TR>
528 </TABLE>
529 <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>
530</TD></TR>
531</TABLE>
532
533
Josh Coalson4c21cc82001-01-26 22:10:57 +0000[diff] [blame]534<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
535<TR><TD>
536 <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>
537 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
538 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
539 <B><FONT SIZE="+2">known bugs</FONT></B>
540 </FONT></TD></TR>
541 </TABLE>
542 <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>
543 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
544 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
545 <P>
Josh Coalsonbcd8da92001-02-06 00:58:08 +0000[diff] [blame]546 Bug tracking is done on the Sourceforge project page <A HREF="http://sourceforge.net/bugs/?group_id=13478">here</A>.
Josh Coalson4c21cc82001-01-26 22:10:57 +0000[diff] [blame]547 </P>
548 </FONT>
549 </TD></TR>
550 </TABLE>
551 <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>
552</TD></TR>
553</TABLE>
554
555
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]556</CENTER>
557
558</BODY>
559</HTML>