blob: 36f1c66a911812c70facee8b3d734a30fc59ddfc [file] [log] [blame]
Josh Coalsonbb7f6b92000-12-10 04:09:52 +00001<!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 +000030 <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 +000031 <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 +000059 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 +000060 </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>
Josh Coalsonade18252001-05-02 01:07:48 +0000106 <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.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000107 </P>
108 <P>
Josh Coalsonade18252001-05-02 01:07:48 +0000109 <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).
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000110 </P>
111 <P>
Josh Coalsonade18252001-05-02 01:07:48 +0000112 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.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000113 </P>
114 <P>
Josh Coalsonab477602001-01-26 22:37:10 +0000115 <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 +0000116 <UL>
117 <LI>
Josh Coalsonade18252001-05-02 01:07:48 +0000118 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 [...]]
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000119 </LI>
120 <LI>
Josh Coalsonade18252001-05-02 01:07:48 +0000121 Decoding: flac -d [-s] [--skip #] [<I><A HREF="#format_options">&lt;format-options&gt;</A></I>] [inputfile [...]]
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000122 </LI>
Josh Coalsondfad4612001-01-13 00:32:32 +0000123 <LI>
Josh Coalsonade18252001-05-02 01:07:48 +0000124 Testing: flac -t [-s] [inputfile [...]]
Josh Coalsondfad4612001-01-13 00:32:32 +0000125 </LI>
Josh Coalsonab477602001-01-26 22:37:10 +0000126 <LI>
Josh Coalsonade18252001-05-02 01:07:48 +0000127 Analyzing: flac -a [-s] [--skip #] [<I><A HREF="#analysis_options">&lt;analysis-options&gt;</A></I>] [inputfile [...]]
Josh Coalsonab477602001-01-26 22:37:10 +0000128 </LI>
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000129 </UL>
130 </P>
131 <P>
Josh Coalsonade18252001-05-02 01:07:48 +0000132 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.
133 </P>
134 <P>
135 There are special forms for encoding/decoding from stdin to a file:
136 <UL>
137 <LI>
138 flac [options] - outputfile
139 </LI>
140 <LI>
141 flac -d [options] - 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.
Josh Coalsondfad4612001-01-13 00:32:32 +0000159 </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.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000162 </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">
Josh Coalson57b65bb2001-03-22 23:35:22 +0000168 <A NAME="general_options"><FONT SIZE="+1"><B>General Options</B></FONT></A>
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000169 </TD>
170 </TR>
171 <TR>
172 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
173 -d
174 </TD>
175 <TD>
Josh Coalsondfad4612001-01-13 00:32:32 +0000176 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 -t
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.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000185 </TD>
186 </TR>
187 <TR>
188 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonab477602001-01-26 22:37:10 +0000189 -a
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">
Josh Coalsonade18252001-05-02 01:07:48 +0000197 -c
198 </TD>
199 <TD>
200 Write output to stdout
201 </TD>
202 </TR>
203 <TR>
204 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000205 -s
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 --skip #
214 </TD>
215 <TD>
Josh Coalsondfad4612001-01-13 00:32:32 +0000216 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 +0000217 </TD>
218 </TR>
219 </TABLE>
220 </TD></TR></TABLE>
221 </P>
222 <P>
223 <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
224 <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
225 <TR>
226 <TD COLSPAN="2" BGCOLOR="#D3D4C5">
Josh Coalson57b65bb2001-03-22 23:35:22 +0000227 <A NAME="analysis_options"><FONT SIZE="+1"><B>Analysis Options</B></FONT></A>
Josh Coalson0b7fde92001-03-15 23:25:54 +0000228 </TD>
229 </TR>
230 <TR>
231 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsone43d5552001-03-16 23:33:00 +0000232 --a-rtext
Josh Coalson0b7fde92001-03-15 23:25:54 +0000233 </TD>
234 <TD>
Josh Coalsone43d5552001-03-16 23:33:00 +0000235 Includes the residual signal in the analysis file. This will make the file <B>very</B> big, much larger than even the decoded file.
236 </TD>
237 </TR>
238 <TR>
239 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
240 --a-rgp
241 </TD>
242 <TD>
243 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.
Josh Coalson0b7fde92001-03-15 23:25:54 +0000244 </TD>
245 </TR>
246 </TABLE>
247 </TD></TR></TABLE>
248 </P>
249 <P>
250 <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
251 <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
252 <TR>
253 <TD COLSPAN="2" BGCOLOR="#D3D4C5">
Josh Coalson57b65bb2001-03-22 23:35:22 +0000254 <A NAME="encoding_options"><FONT SIZE="+1"><B>Encoding Options</B></FONT></A>
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000255 </TD>
256 </TR>
257 <TR>
258 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
259 --lax
260 </TD>
261 <TD>
262 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.
263 </TD>
264 </TR>
265 <TR>
266 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalson99b44c22001-04-16 23:18:06 +0000267 -S { # | X | #x }
268 </TD>
269 <TD>
270 Include a point or points in a SEEKTABLE:<BR>
271 <UL>
272 <LI>
273 <TT>#&nbsp;</TT> : a specific sample number for a seek point
274 </LI>
275 <LI>
276 <TT>X&nbsp;</TT> : a placeholder point (always goes at the end of the SEEKTABLE)
277 </LI>
278 <LI>
279 <TT>#x</TT> : # evenly spaced seekpoints, the first being at sample 0
280 </LI>
281 </UL>
282 You may use many -S options; the resulting SEEKTABLE will be the unique-ified union of all such values.<BR>
283 With no -S options, flac defaults to '-S 100x'. Use -S- for no SEEKTABLE.<BR>
284 NOTE: -S #x will not work if the encoder can't determine the input size before starting.<BR>
285 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>
286 </TD>
287 </TR>
288 <TR>
289 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonbd85fd62001-02-23 21:26:05 +0000290 -P #
291 </TD>
292 <TD>
293 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.
294 </TD>
295 </TR>
296 <TR>
297 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000298 -b #
299 </TD>
300 <TD>
Josh Coalson99b44c22001-04-16 23:18:06 +0000301 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 current encoder uses the same blocksize for the entire stream.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000302 </TD>
303 </TR>
304 <TR>
305 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
306 -m
307 </TD>
308 <TD>
309 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.
310 </TD>
311 </TR>
312 <TR>
313 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalson5a0e0fa2001-01-28 09:47:22 +0000314 -M
315 </TD>
316 <TD>
Josh Coalson11ce4e02001-01-28 09:50:26 +0000317 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 +0000318 </TD>
319 </TR>
320 <TR>
321 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000322 -0 .. -9
323 </TD>
324 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000325 Fastest compression .. highest compression. The default is <TT>-5</TT>.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000326 </TD>
327 </TR>
328 <TR>
329 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
330 -0
331 </TD>
332 <TD>
Josh Coalson99b44c22001-04-16 23:18:06 +0000333 Synonymous with -l 0 -b 1152
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000334 </TD>
335 </TR>
336 <TR>
337 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
338 -1
339 </TD>
340 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000341 Synonymous with -l 0 -b 1152 -M -r 2,2
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000342 </TD>
343 </TR>
344 <TR>
345 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
346 -2
347 </TD>
348 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000349 Synonymous with -l 0 -b 1152 -m -r 3
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000350 </TD>
351 </TR>
352 <TR>
353 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
354 -3
355 </TD>
356 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000357 Synonymous with -l 6 -b 4608 -r 3,3
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000358 </TD>
359 </TR>
360 <TR>
361 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
362 -4
363 </TD>
364 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000365 Synonymous with -l 8 -b 4608 -M -r 3,3
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000366 </TD>
367 </TR>
368 <TR>
369 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
370 -5
371 </TD>
372 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000373 Synonymous with -l 8 -b 4608 -m -r 3,3
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000374 </TD>
375 </TR>
376 <TR>
377 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
378 -6
379 </TD>
380 <TD>
Josh Coalson99b44c22001-04-16 23:18:06 +0000381 Synonymous with -l 8 -b 4608 -m -r 4
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000382 </TD>
383 </TR>
384 <TR>
385 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
386 -7
387 </TD>
388 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000389 Synonymous with -l 8 -b 4608 -m -e -r 6
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000390 </TD>
391 </TR>
392 <TR>
393 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
394 -8
395 </TD>
396 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000397 Synonymous with -l 12 -b 4608 -m -e -r 6
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000398 </TD>
399 </TR>
400 <TR>
401 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
402 -9
403 </TD>
404 <TD>
Josh Coalsonade18252001-05-02 01:07:48 +0000405 Synonymous with -l 32 -b 4608 -m -e -r 16 -R 32 -p. This is painfully slow but gives you the maximum compression <B><TT>flac</TT></B> can do for the given blocksize.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000406 </TD>
407 </TR>
408 <TR>
409 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
410 -e
411 </TD>
412 <TD>
413 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%.
414 </TD>
415 </TR>
416 <TR>
417 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
418 -l #
419 </TD>
420 <TD>
421 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.
422 </TD>
423 </TR>
424 <TR>
425 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
426 -q #
427 </TD>
428 <TD>
429 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.
430 </TD>
431 </TR>
432 <TR>
433 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
434 -p
435 </TD>
436 <TD>
Josh Coalsone665f2d2001-02-08 00:29:58 +0000437 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 +0000438 </TD>
439 </TR>
440 <TR>
441 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonade18252001-05-02 01:07:48 +0000442 -r [#,]#
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000443 </TD>
444 <TD>
Josh Coalsonade18252001-05-02 01:07:48 +0000445 Set the [min,]max residual partition order. The min value defaults to 0 if unspecified.<BR>
446 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.
447 </TD>
448 </TR>
449 <TR>
450 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
451 -R #
452 </TD>
453 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000454 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.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000455 </TD>
456 </TR>
457 <TR>
458 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsoned840cd2000-12-22 22:43:50 +0000459 -V
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000460 </TD>
461 <TD>
Josh Coalsoned840cd2000-12-22 22:43:50 +0000462 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.
463 </TD>
464 </TR>
465 <TR>
466 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
467 </TD>
468 <TD>
Josh Coalson99b44c22001-04-16 23:18:06 +0000469 -S-, -m-, -e-, -p-, -V-, --lax- can all be used to turn off a particular option.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000470 </TD>
471 </TR>
472 </TABLE>
473 </TD></TR></TABLE>
474 </P>
475 <P>
476 <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
477 <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
478 <TR>
479 <TD COLSPAN="2" BGCOLOR="#D3D4C5">
Josh Coalson57b65bb2001-03-22 23:35:22 +0000480 <A NAME="format_options"><FONT SIZE="+1"><B>Format Options</B></FONT></A>
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000481 </TD>
482 </TR>
483 <TR>
484 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
485 -fb | -fl
486 </TD>
487 <TD>
488 Specify big-endian | little-endian byte order in the raw file.
489 </TD>
490 </TR>
491 <TR>
492 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
493 -fc #
494 </TD>
495 <TD>
496 Specify the number of channels in the raw file.
497 </TD>
498 </TR>
499 <TR>
500 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
501 -fp #
502 </TD>
503 <TD>
504 Specify the number of bits per sample in the raw file.
505 </TD>
506 </TR>
507 <TR>
508 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
509 -fs #
510 </TD>
511 <TD>
512 Specify the sample rate of the raw file.
513 </TD>
514 </TR>
515 <TR>
516 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
517 -fu
518 </TD>
519 <TD>
520 Specify that the samples in the raw file are unsigned (the default is signed).
521 </TD>
522 </TR>
523 <TR>
524 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
525 -fr
526 </TD>
527 <TD>
528 Treat the input file (or output file if decoding) as a raw file, regardless of the extension.
529 </TD>
530 </TR>
531 <TR>
532 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
533 -fw
534 </TD>
535 <TD>
536 Treat the input file (or output file if decoding) as a RIFF WAVE file, regardless of the extension.
537 </TD>
538 </TR>
539 </TABLE>
540 </TD></TR></TABLE>
541 </P>
542 </FONT>
543 </TD></TR>
544 </TABLE>
545 <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>
546</TD></TR>
547</TABLE>
548
549
550<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
551<TR><TD>
552 <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>
553 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
554 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
Josh Coalson64e8ef72001-02-23 23:27:59 +0000555 <B><FONT SIZE="+2">metaflac</FONT></B>
556 </FONT></TD></TR>
557 </TABLE>
558 <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>
559 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
560 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
561 <P>
562 <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.
563 </P>
564 <P>
565 Currently <B><TT>metaflac</TT></B> can be invoked only one way:
566 <UL>
567 <LI>
568 Listing: metaflac [-v] inputfile
569 </LI>
570 </UL>
571 </P>
572 <P>
573 <TT>inputfile</TT> may be "-" for stdin. If <TT>-v</TT> is used, you will get verbose output.
574 </P>
575 </FONT>
576 </TD></TR>
577 </TABLE>
578 <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>
579</TD></TR>
580</TABLE>
581
582
583<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
584<TR><TD>
585 <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>
586 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
587 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000588 <A NAME="plugins"><B><FONT SIZE="+2">xmms plugin</FONT></B></A>
589 </FONT></TD></TR>
590 </TABLE>
591 <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>
592 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
593 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
594 <P>
Josh Coalson64e8ef72001-02-23 23:27:59 +0000595 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 +0000596 </P>
597 </FONT>
598 </TD></TR>
599 </TABLE>
600 <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>
601</TD></TR>
602</TABLE>
603
604
605<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
606<TR><TD>
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="#D3D4C5">
609 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
610 <B><FONT SIZE="+2">winamp plugin</FONT></B>
611 </FONT></TD></TR>
612 </TABLE>
613 <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>
614 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
615 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
616 <P>
Josh Coalson64e8ef72001-02-23 23:27:59 +0000617 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 +0000618 </P>
619 </FONT>
620 </TD></TR>
621 </TABLE>
622 <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>
623</TD></TR>
624</TABLE>
625
626
Josh Coalson4c21cc82001-01-26 22:10:57 +0000627<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
628<TR><TD>
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="#D3D4C5">
631 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
632 <B><FONT SIZE="+2">known bugs</FONT></B>
633 </FONT></TD></TR>
634 </TABLE>
635 <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>
636 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
637 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
638 <P>
Josh Coalson2d647902001-04-24 22:24:22 +0000639 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.
Josh Coalson4c21cc82001-01-26 22:10:57 +0000640 </P>
641 </FONT>
642 </TD></TR>
643 </TABLE>
644 <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>
645</TD></TR>
646</TABLE>
647
648
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000649</CENTER>
650
651</BODY>
652</HTML>