Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / flac / 276ad891d5884e41d04cb53de926e4698e29b732 / . / doc / documentation.html
blob: 85151823ad672d0e1db98ff0f2fb90343f9a2dd0 [file] [log] [blame]
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
Josh Coalson6b05bc52001-06-08 00:13:21 +0000[diff] [blame]2<!-- Copyright (c) 2000,2001 Josh Coalson -->
3<!-- Permission is granted to copy, distribute and/or modify this document -->
4<!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
5<!-- or any later version published by the Free Software Foundation; -->
6<!-- with no invariant sections. -->
7<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]8<HTML>
9<HEAD>
10 <TITLE>FLAC - documentation</TITLE>
11</HEAD>
12
13<BODY MARGINWIDTH="0" MARGINHEIGHT="0" LEFTMARGIN="0" RIGHTMARGIN="0" TOPMARGIN="0" BGCOLOR="#99CC99" TEXT="#000000" LINK="#336699" VLINK="#336699" ALINK="#336699">
14
15<TABLE BORDER=0 WIDTH="100%" CELLPADDING=1 CELLSPACING=0>
16 <TR>
17 <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>
18 </TR>
19</TABLE>
20
21<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>
22
23<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>
24
25<TABLE WIDTH="100%" CELLPADDING=0 CELLSPACING=0 BORDER=0>
26 <TR>
27 <TD ALIGN="CENTER" BGCOLOR="#D3D4C5">
28 <TABLE CELLPADDING=0 CELLSPACING=0 BORDER=0>
29 <TR>
30 <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>
31 <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>
32 <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>
33 <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>
34 <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>
35 <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]36 <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]37 <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>
38 <TD BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;documentation&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
39 <TD BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="developers.html">developers</A>&nbsp;&nbsp;</TD>
40 </TR>
41 </TABLE>
42 </TD>
43 </TR>
44</TABLE>
45
46<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>
47
48<CENTER>
49
50<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>
51
52
53<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
54<TR><TD>
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="#D3D4C5">
57 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
58 <B><FONT SIZE="+2">documentation</FONT></B>
59 </FONT></TD></TR>
60 </TABLE>
61 <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>
62 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
63 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
64 <P>
Josh Coalson64e8ef72001-02-23 23:27:59 +0000[diff] [blame]65 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]66 </P>
67 <P>
68 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.
69 </P>
70 </FONT>
71 </TD></TR>
72 </TABLE>
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</TD></TR>
75</TABLE>
76
77
78<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
79<TR><TD>
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="#D3D4C5">
82 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
83 <B><FONT SIZE="+2">format</FONT></B>
84 </FONT></TD></TR>
85 </TABLE>
86 <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>
87 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
88 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
89 <P>
Josh Coalsonac1e70a2001-06-07 02:41:39 +0000[diff] [blame]90 <B><TT>flac</TT></B> has been tuned so that the default options yield a good speed vs. compression tradeoff for many kinds of input. However, if you are looking to maximize the compression rate or speed, or want to use the full power of FLAC's metadata system, this section is for you. If not, just skip to the <A HREF="#flac">next section</A>.
91 </P>
92 <P>
93 The basic structure of a FLAC stream is:
94 <UL>
95 <LI>The four byte string "fLaC"</LI>
96 <LI>The <A HREF="format.html#def_STREAMINFO">STREAMINFO</A> metadata block</LI>
97 <LI>Zero or more other metadata blocks</LI>
98 <LI>One or more audio frames</LI>
99 </UL>
100 </P>
101 <P>
102 The first four bytes are to identify the FLAC stream. The metadata that follows contains all the information about the stream except for the audio data itself. After the metadata comes the encoded audio data.
103 </P>
104 <P>
105 <B>METADATA</B>
106 </P>
107 <P>
108 FLAC defines several types of metadata blocks (see the <A HREF="format.html">format</A> page for the complete list. Metadata blocks can be any length and new ones can be defined. A decoder is allowed to skip any metadata types it does not understand. Only one is mandatory: the STREAMINFO block. This block has information like the sample rate, number of channels, etc., and data that can help the decoder manage its buffers, like the minimum and maximum data rate and minimum and maximum block size. Also included in the STREAMINFO block is the MD5 signature of the <I>unencoded</I> audio data. This is useful for checking an entire stream for transmission errors.
109 </P>
110 <P>
111 Other blocks allow for padding, seek tables, and application-specific data. You can see <B><TT>flac</TT></B> options below for adding PADDING blocks or specifying seek points. FLAC does not require seek points for seeking but they can speed up seeks, or be used for cueing in editing applications.
112 <P>
113 </P>
114 Also, if you have a need of a custom metadata block, you can define your own and request an ID <A HREF="id.html">here</A>. Then you can reserve a PADDING block of the correct size when encoding, and overwrite the padding block with your APPLICATION block after encoding. The resulting stream will be FLAC compatible; decoders that are aware of your metadata can use it and the rest will safely ignore it.
115 </P>
116 <P>
117 <B>AUDIO DATA</B>
118 </P>
119 <P>
120 After the metadata comes the encoded audio data. Audio data and metadata are not interleaved. Like most audio codecs, FLAC splits the unencoded audio data into blocks, and encodes each block separately. The encoded block is packed into a frame and appended to the stream. The reference encoder uses a single block size for the whole stream but the FLAC format does not require it.
121 </P>
122 <P>
123 <B>BLOCKING</B>
124 </P>
125 <P>
126 The block size is an important parameter to encoding. If it is too small, the frame overhead will lower the compression. If it is too large, the modeling stage of the compressor will not be able to generate an efficient model. Understanding FLAC's modeling will help you to improve compression for some kinds of input by varying the block size. In the most general case, using linear prediction on 44.1kHz audio, the optimal block size will be between 2-6 ksamples. <B><TT>flac</TT></B> defaults to a block size of 4608 in this case. Using the fast fixed predictors, a smaller block size is usually preferable because of the smaller frame header.
127 </P>
128 <P>
129 <B>INTER-CHANNEL DECORRELATION</B>
130 </P>
131 <P>
132 In the case of stereo input, once the data is blocked it is optionally passed through an inter-channel decorrelation stage. The left and right channels are converted to center and side channels through the following transformation: mid = (left + right) / 2, side = left - right. This is a lossless process, unlike joint stereo. For normal CD audio this can result in significant extra compression. <B><TT>flac</TT></B> has two options for this: <TT>-m</TT> always compresses both the left-right and mid-side versions of the block and takes the smallest frame, and <TT>-M</TT>, which adaptively switches between left-right and mid-side.
133 </P>
134 <P>
135 <B>MODELING</B>
136 </P>
137 <P>
138 In the next stage, the encoder tries to approximate the signal with a function in such a way that when the approximation is subracted, the result (called the <I>residual</I>, <I>residue</I>, or <I>error</I>) requires fewer bits-per-sample to encode. The function's parameters also have to be transmitted so they should not be so complex as to eat up the savings. FLAC has two methods of forming approximations: 1) fitting a simple polynomial to the signal; and 2) general linear predictive coding (LPC). I will not go into the details here, only some generalities that involve the encoding options.
139 </P>
140 <P>
141 First, fixed polynomial prediction (specified with <TT>-l 0</TT>) is much faster, but less accurate than LPC. The higher the maximum LPC order, the slower, but more accurate, the model will be. However, there are diminishing returns with increasing orders. Also, at some point (around order 9) the part of the encoder that guesses what is the best order to use will start to get it wrong and the compression will actually decrease slightly; at that point you will have to you will have to use the exhaustive search option <TT>-e</TT> to overcome this, which is significantly slower.
142 </P>
143 <P>
144 Second, the parameters for the fixed predictors can be transmitted in 3 bits whereas the parameters for the LPC model depend on the bits-per-sample and LPC order. This means the frame header length varies depending on the method and order you choose and can affect the optimal block size.
145 </P>
146 <P>
147 <B>RESIDUAL CODING</B>
148 </P>
149 <P>
150 Once the model is generated, the encoder subracts the approximation from the original signal to get the residual (error) signal. The error signal is then losslessly coded. To do this, FLAC takes advantage of the fact that the error signal generally has a Laplacian (two-sided geometric) distribution, and that there are a set of special Huffman codes called Rice codes that can be used to efficiently encode these kind of signals quickly and without needing a dictionary.
151 </P>
152 <P>
153 Rice coding involves finding a single parameter that matches a signal's distribution, then using that parameter to generate the codes. As the distribution changes, the optimal parameter changes, so FLAC supports a method that allows the parameter to change as needed. The residual can be broken into several <I>contexts</I> or <I>partitions</I>, each with it's own Rice parameter. <B><TT>flac</TT></B> allows you to specify how the partitioning is done with the <TT>-r</TT> option. The residual can be broken into 2^<I>n</I> partitions, by using the option <TT>-r n,n</TT>. The parameter <I>n</I> is called the <I>partition order</I>. Furthermore, the encoder can be made to search through <I>m</I> to <I>n</I> partition orders, taking the best one, by specifying <TT>-r m,n</TT>. Generally, the choice of n does not affect encoding speed but m,n does. The larger the difference between m and n, the more time it will take the encoder to search for the best order. The block size will also affect the optimal order.
154 </P>
155 <P>
156 <B>FRAMING</B>
157 </P>
158 <P>
159 An audio frame is preceded by a frame header and trailed by a frame footer. The header starts with a sync code, and contains the minimum information necessary for a decoder to play the stream, like sample rate, bits per sample, etc. It also contains the block or sample number and an 8-bit CRC of the frame header. The sync code, frame header CRC, and block/sample number allow resynchronization and seeking even in the absence of seek points. The frame footer contains a 16-bit CRC of the entire encoded frame for error detection. If the reference decoder detects a CRC error it will generate a silent block.
160 </P>
161 <P>
162 <B>MISCELLANEOUS</B>
163 </P>
164 <P>
165 In order to support come common types of metadata, the reference decoder knows how to skip ID3V1 and ID3V2 tags so it is safe to tag FLAC files in this way. ID3V2 tags must come at the beginning of the file (before the "fLaC" marker) and ID3V1 tags must come at the end of the file.
166 </P>
167 <P>
168 <B><TT>flac</TT></B> has a verify option <TT>-V</TT> that verifies the output while encoding. With this option, a decoder is run in parallel to the encoder and its output is compared against the original input. If a difference is found <B><TT>flac</TT></B> will stop with an error.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]169 </P>
170 </FONT>
171 </TD></TR>
172 </TABLE>
173 <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>
174</TD></TR>
175</TABLE>
176
177
178<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
179<TR><TD>
180 <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>
181 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
182 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
Josh Coalsonac1e70a2001-06-07 02:41:39 +0000[diff] [blame]183 <A NAME="flac"><B><FONT SIZE="+2">flac</FONT></B>
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]184 </FONT></TD></TR>
185 </TABLE>
186 <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>
187 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
188 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
189 <P>
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]190 <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 +0000[diff] [blame]191 </P>
192 <P>
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]193 <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 +0000[diff] [blame]194 </P>
195 <P>
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]196 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 +0000[diff] [blame]197 </P>
198 <P>
Josh Coalsonab477602001-01-26 22:37:10 +0000[diff] [blame]199 <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]200 <UL>
201 <LI>
Josh Coalsonac1e70a2001-06-07 02:41:39 +0000[diff] [blame]202 Encoding: flac [-s] [--skip #] [-V] [<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 +0000[diff] [blame]203 </LI>
204 <LI>
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]205 Decoding: flac -d [-s] [--skip #] [<I><A HREF="#format_options">&lt;format-options&gt;</A></I>] [inputfile [...]]
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]206 </LI>
Josh Coalsondfad4612001-01-13 00:32:32 +0000[diff] [blame]207 <LI>
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]208 Testing: flac -t [-s] [inputfile [...]]
Josh Coalsondfad4612001-01-13 00:32:32 +0000[diff] [blame]209 </LI>
Josh Coalsonab477602001-01-26 22:37:10 +0000[diff] [blame]210 <LI>
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]211 Analyzing: flac -a [-s] [--skip #] [<I><A HREF="#analysis_options">&lt;analysis-options&gt;</A></I>] [inputfile [...]]
Josh Coalsonab477602001-01-26 22:37:10 +0000[diff] [blame]212 </LI>
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]213 </UL>
214 </P>
215 <P>
Josh Coalsond2e0e0e2001-06-06 19:27:48 +0000[diff] [blame]216 In any case, if no <TT>inputfile</TT> is specified, stdin is assumed. If only one inputfile is specified, it may be "-" for stdin. When stdin is used as input, <B><TT>flac</TT></B> will write to stdout. Otherwise <B><TT>flac</TT></B> will perform the desired operation on each input file to similarly named output files (meaning for encoding, the extension will be replaced with ".flac", or appended with ".flac" if the input file has no extension, and for decoding, the extension will be ".wav" for WAVE output and ".raw" for raw output). The original file is not deleted unless --delete-input-file is specified.
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]217 </P>
218 <P>
Josh Coalsond2e0e0e2001-06-06 19:27:48 +0000[diff] [blame]219 If you are encoding/decoding from stdin to a file, you should use the -o option like so:
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]220 <UL>
221 <LI>
Josh Coalsond2e0e0e2001-06-06 19:27:48 +0000[diff] [blame]222 flac [options] -o outputfile
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]223 </LI>
224 <LI>
Josh Coalsond2e0e0e2001-06-06 19:27:48 +0000[diff] [blame]225 flac -d [options] -o outputfile
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]226 </LI>
227 </UL>
Josh Coalsond2e0e0e2001-06-06 19:27:48 +0000[diff] [blame]228 which are better than:
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]229 <UL>
230 <LI>
231 flac [options] &gt; outputfile
232 </LI>
233 <LI>
234 flac -d [options] &gt; outputfile
235 </LI>
236 </UL>
237 since the former allows flac to seek backwards to write the STREAMINFO or RIFF WAVE header contents when necessary.
238 </P>
239 <P>
240 Also, you can force output data to go to stdout using <TT>-c</TT>.
241 </P>
242 <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 +0000[diff] [blame]243 </P>
244 <P>
245 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]246 </P>
247 <P>
248 <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
249 <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
250 <TR>
251 <TD COLSPAN="2" BGCOLOR="#D3D4C5">
Josh Coalson57b65bb2001-03-22 23:35:22 +0000[diff] [blame]252 <A NAME="general_options"><FONT SIZE="+1"><B>General Options</B></FONT></A>
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]253 </TD>
254 </TR>
255 <TR>
256 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsond2e0e0e2001-06-06 19:27:48 +0000[diff] [blame]257 <TT>-d</TT>
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]258 </TD>
259 <TD>
Josh Coalsondfad4612001-01-13 00:32:32 +0000[diff] [blame]260 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>.
261 </TD>
262 </TR>
263 <TR>
264 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsond2e0e0e2001-06-06 19:27:48 +0000[diff] [blame]265 <TT>-t</TT>
Josh Coalsondfad4612001-01-13 00:32:32 +0000[diff] [blame]266 </TD>
267 <TD>
268 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]269 </TD>
270 </TR>
271 <TR>
272 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsond2e0e0e2001-06-06 19:27:48 +0000[diff] [blame]273 <TT>-a</TT>
Josh Coalsonab477602001-01-26 22:37:10 +0000[diff] [blame]274 </TD>
275 <TD>
276 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.
277 </TD>
278 </TR>
279 <TR>
280 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsond2e0e0e2001-06-06 19:27:48 +0000[diff] [blame]281 <TT>-c</TT>
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]282 </TD>
283 <TD>
284 Write output to stdout
285 </TD>
286 </TR>
287 <TR>
288 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsond2e0e0e2001-06-06 19:27:48 +0000[diff] [blame]289 <TT>-s</TT>
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]290 </TD>
291 <TD>
292 Silent: do not show encoding/decoding statistics.
293 </TD>
294 </TR>
295 <TR>
296 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsond2e0e0e2001-06-06 19:27:48 +0000[diff] [blame]297 <TT>-o filename</TT>
298 </TD>
299 <TD>
Josh Coalsonf3a3c552001-06-06 19:30:49 +0000[diff] [blame]300 Force the output file name (usually <TT><B>flac</B></TT> just changes the extension).
Josh Coalsond2e0e0e2001-06-06 19:27:48 +0000[diff] [blame]301 </TD>
302 </TR>
303 <TR>
304 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
305 <TT>--delete-input-file</TT>
306 </TD>
307 <TD>
308 Automatically delete the input file after a successful encode or decode. If there was an error (including a verify error) the input file is left intact.
309 </TD>
310 </TR>
311 <TR>
312 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
313 <TT>--skip #</TT>
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]314 </TD>
315 <TD>
Josh Coalsondfad4612001-01-13 00:32:32 +0000[diff] [blame]316 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]317 </TD>
318 </TR>
319 </TABLE>
320 </TD></TR></TABLE>
321 </P>
322 <P>
323 <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
324 <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
325 <TR>
326 <TD COLSPAN="2" BGCOLOR="#D3D4C5">
Josh Coalson57b65bb2001-03-22 23:35:22 +0000[diff] [blame]327 <A NAME="analysis_options"><FONT SIZE="+1"><B>Analysis Options</B></FONT></A>
Josh Coalson0b7fde92001-03-15 23:25:54 +0000[diff] [blame]328 </TD>
329 </TR>
330 <TR>
331 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsone43d5552001-03-16 23:33:00 +0000[diff] [blame]332 --a-rtext
Josh Coalson0b7fde92001-03-15 23:25:54 +0000[diff] [blame]333 </TD>
334 <TD>
Josh Coalsone43d5552001-03-16 23:33:00 +0000[diff] [blame]335 Includes the residual signal in the analysis file. This will make the file <B>very</B> big, much larger than even the decoded file.
336 </TD>
337 </TR>
338 <TR>
339 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
340 --a-rgp
341 </TD>
342 <TD>
343 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 +0000[diff] [blame]344 </TD>
345 </TR>
346 </TABLE>
347 </TD></TR></TABLE>
348 </P>
349 <P>
350 <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
351 <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
352 <TR>
353 <TD COLSPAN="2" BGCOLOR="#D3D4C5">
Josh Coalson57b65bb2001-03-22 23:35:22 +0000[diff] [blame]354 <A NAME="encoding_options"><FONT SIZE="+1"><B>Encoding Options</B></FONT></A>
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]355 </TD>
356 </TR>
357 <TR>
358 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
359 --lax
360 </TD>
361 <TD>
362 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.
363 </TD>
364 </TR>
365 <TR>
366 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalson99b44c22001-04-16 23:18:06 +0000[diff] [blame]367 -S { # | X | #x }
368 </TD>
369 <TD>
370 Include a point or points in a SEEKTABLE:<BR>
371 <UL>
372 <LI>
373 <TT>#&nbsp;</TT> : a specific sample number for a seek point
374 </LI>
375 <LI>
376 <TT>X&nbsp;</TT> : a placeholder point (always goes at the end of the SEEKTABLE)
377 </LI>
378 <LI>
379 <TT>#x</TT> : # evenly spaced seekpoints, the first being at sample 0
380 </LI>
381 </UL>
382 You may use many -S options; the resulting SEEKTABLE will be the unique-ified union of all such values.<BR>
383 With no -S options, flac defaults to '-S 100x'. Use -S- for no SEEKTABLE.<BR>
384 NOTE: -S #x will not work if the encoder can't determine the input size before starting.<BR>
Josh Coalson4c4aed92001-06-05 23:34:38 +0000[diff] [blame]385 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>
Josh Coalson99b44c22001-04-16 23:18:06 +0000[diff] [blame]386 </TD>
387 </TR>
388 <TR>
389 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonbd85fd62001-02-23 21:26:05 +0000[diff] [blame]390 -P #
391 </TD>
392 <TD>
393 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.
394 </TD>
395 </TR>
396 <TR>
397 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]398 -b #
399 </TD>
400 <TD>
Josh Coalsonac1e70a2001-06-07 02:41:39 +0000[diff] [blame]401 Specify the block size in samples. The default is 1152 for -l 0, otherwise 4608. Subset streams must use one of 192/576/1152/2304/4608/256/512/1024/2048/4096/8192/16384/32768. The reference encoder uses the same block size for the entire stream.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]402 </TD>
403 </TR>
404 <TR>
405 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
406 -m
407 </TD>
408 <TD>
409 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.
410 </TD>
411 </TR>
412 <TR>
413 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalson5a0e0fa2001-01-28 09:47:22 +0000[diff] [blame]414 -M
415 </TD>
416 <TD>
Josh Coalson11ce4e02001-01-28 09:50:26 +0000[diff] [blame]417 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]418 </TD>
419 </TR>
420 <TR>
421 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]422 -0 .. -9
423 </TD>
424 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000[diff] [blame]425 Fastest compression .. highest compression. The default is <TT>-5</TT>.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]426 </TD>
427 </TR>
428 <TR>
429 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
430 -0
431 </TD>
432 <TD>
Josh Coalson67bb28d2001-06-05 22:36:20 +0000[diff] [blame]433 Synonymous with -l 0 -b 1152 -r 2,2
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]434 </TD>
435 </TR>
436 <TR>
437 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
438 -1
439 </TD>
440 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000[diff] [blame]441 Synonymous with -l 0 -b 1152 -M -r 2,2
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]442 </TD>
443 </TR>
444 <TR>
445 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
446 -2
447 </TD>
448 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000[diff] [blame]449 Synonymous with -l 0 -b 1152 -m -r 3
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]450 </TD>
451 </TR>
452 <TR>
453 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
454 -3
455 </TD>
456 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000[diff] [blame]457 Synonymous with -l 6 -b 4608 -r 3,3
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]458 </TD>
459 </TR>
460 <TR>
461 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
462 -4
463 </TD>
464 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000[diff] [blame]465 Synonymous with -l 8 -b 4608 -M -r 3,3
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]466 </TD>
467 </TR>
468 <TR>
469 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
470 -5
471 </TD>
472 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000[diff] [blame]473 Synonymous with -l 8 -b 4608 -m -r 3,3
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]474 </TD>
475 </TR>
476 <TR>
477 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
478 -6
479 </TD>
480 <TD>
Josh Coalson99b44c22001-04-16 23:18:06 +0000[diff] [blame]481 Synonymous with -l 8 -b 4608 -m -r 4
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]482 </TD>
483 </TR>
484 <TR>
485 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
486 -7
487 </TD>
488 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000[diff] [blame]489 Synonymous with -l 8 -b 4608 -m -e -r 6
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]490 </TD>
491 </TR>
492 <TR>
493 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
494 -8
495 </TD>
496 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000[diff] [blame]497 Synonymous with -l 12 -b 4608 -m -e -r 6
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]498 </TD>
499 </TR>
500 <TR>
501 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
502 -9
503 </TD>
504 <TD>
Josh Coalsonac1e70a2001-06-07 02:41:39 +0000[diff] [blame]505 Synonymous with -l 32 -b 4608 -m -e -r 16 -p. This is painfully slow but gives you the maximum compression <B><TT>flac</TT></B> can do for the given block size.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]506 </TD>
507 </TR>
508 <TR>
509 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
510 -e
511 </TD>
512 <TD>
513 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%.
514 </TD>
515 </TR>
516 <TR>
517 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
518 -l #
519 </TD>
520 <TD>
521 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.
522 </TD>
523 </TR>
524 <TR>
525 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
526 -q #
527 </TD>
528 <TD>
529 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.
530 </TD>
531 </TR>
532 <TR>
533 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
534 -p
535 </TD>
536 <TD>
Josh Coalsone665f2d2001-02-08 00:29:58 +0000[diff] [blame]537 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]538 </TD>
539 </TR>
540 <TR>
541 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]542 -r [#,]#
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]543 </TD>
544 <TD>
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]545 Set the [min,]max residual partition order. The min value defaults to 0 if unspecified.<BR>
Josh Coalsonac1e70a2001-06-07 02:41:39 +0000[diff] [blame]546 By default the encoder uses a single Rice parameter for the subframe's entire residual. With this option, the residual is iteratively partitioned into 2^min# .. 2^max# pieces, each with its own Rice parameter. Higher values of max# yield diminishing returns. The most bang for the buck is usually with <B><TT>-r 2,2</TT></B> (more for higher block sizes). This usually shaves off about 1.5%. The technique tends to peak out about when blocksize/(2^n)=128. Use <B><TT>-r 0,16</TT></B> to force the highest degree of optimization.
Josh Coalsonade18252001-05-02 01:07:48 +0000[diff] [blame]547 </TD>
548 </TR>
549 <TR>
550 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
551 -R #
552 </TD>
553 <TD>
Josh Coalson6f8134b2001-05-03 00:09:18 +0000[diff] [blame]554 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 +0000[diff] [blame]555 </TD>
556 </TR>
557 <TR>
558 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
Josh Coalsoned840cd2000-12-22 22:43:50 +0000[diff] [blame]559 -V
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]560 </TD>
561 <TD>
Josh Coalsoned840cd2000-12-22 22:43:50 +0000[diff] [blame]562 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.
563 </TD>
564 </TR>
565 <TR>
566 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
567 </TD>
568 <TD>
Josh Coalsond2e0e0e2001-06-06 19:27:48 +0000[diff] [blame]569 <TT>-S-</TT>, <TT>-m-</TT>, <TT>-e-</TT>, <TT>-p-</TT>, <TT>-V-</TT>, <TT>--delete-input-file-</TT>, <TT>--lax-</TT> can all be used to turn off a particular option.
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]570 </TD>
571 </TR>
572 </TABLE>
573 </TD></TR></TABLE>
574 </P>
575 <P>
576 <TABLE WIDTH="100%" BORDER="0" CELLSPACING="0" CELLPADDING="0" BGCOLOR="#EEEED4"><TR><TD>
577 <TABLE WIDTH="100%" BORDER="1" BGCOLOR="#EEEED4">
578 <TR>
579 <TD COLSPAN="2" BGCOLOR="#D3D4C5">
Josh Coalson57b65bb2001-03-22 23:35:22 +0000[diff] [blame]580 <A NAME="format_options"><FONT SIZE="+1"><B>Format Options</B></FONT></A>
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]581 </TD>
582 </TR>
583 <TR>
584 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
585 -fb | -fl
586 </TD>
587 <TD>
588 Specify big-endian | little-endian byte order in the raw file.
589 </TD>
590 </TR>
591 <TR>
592 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
593 -fc #
594 </TD>
595 <TD>
596 Specify the number of channels in the raw file.
597 </TD>
598 </TR>
599 <TR>
600 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
601 -fp #
602 </TD>
603 <TD>
604 Specify the number of bits per sample in the raw file.
605 </TD>
606 </TR>
607 <TR>
608 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
609 -fs #
610 </TD>
611 <TD>
612 Specify the sample rate of the raw file.
613 </TD>
614 </TR>
615 <TR>
616 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
617 -fu
618 </TD>
619 <TD>
620 Specify that the samples in the raw file are unsigned (the default is signed).
621 </TD>
622 </TR>
623 <TR>
624 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
625 -fr
626 </TD>
627 <TD>
628 Treat the input file (or output file if decoding) as a raw file, regardless of the extension.
629 </TD>
630 </TR>
631 <TR>
632 <TD NOWRAP ALIGN="RIGHT" VALIGN="TOP" BGCOLOR="#F4F4CC">
633 -fw
634 </TD>
635 <TD>
636 Treat the input file (or output file if decoding) as a RIFF WAVE file, regardless of the extension.
637 </TD>
638 </TR>
639 </TABLE>
640 </TD></TR></TABLE>
641 </P>
642 </FONT>
643 </TD></TR>
644 </TABLE>
645 <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="1" ALT=""></TD></TR></TABLE>
646</TD></TR>
647</TABLE>
648
649
650<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
651<TR><TD>
652 <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>
653 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
654 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
Josh Coalson64e8ef72001-02-23 23:27:59 +0000[diff] [blame]655 <B><FONT SIZE="+2">metaflac</FONT></B>
656 </FONT></TD></TR>
657 </TABLE>
658 <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>
659 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
660 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
661 <P>
662 <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.
663 </P>
664 <P>
665 Currently <B><TT>metaflac</TT></B> can be invoked only one way:
666 <UL>
667 <LI>
668 Listing: metaflac [-v] inputfile
669 </LI>
670 </UL>
671 </P>
672 <P>
673 <TT>inputfile</TT> may be "-" for stdin. If <TT>-v</TT> is used, you will get verbose output.
674 </P>
675 </FONT>
676 </TD></TR>
677 </TABLE>
678 <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>
679</TD></TR>
680</TABLE>
681
682
683<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
684<TR><TD>
685 <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>
686 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
687 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]688 <A NAME="plugins"><B><FONT SIZE="+2">xmms plugin</FONT></B></A>
689 </FONT></TD></TR>
690 </TABLE>
691 <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>
692 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
693 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
694 <P>
Josh Coalson64e8ef72001-02-23 23:27:59 +0000[diff] [blame]695 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]696 </P>
697 </FONT>
698 </TD></TR>
699 </TABLE>
700 <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>
701</TD></TR>
702</TABLE>
703
704
705<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
706<TR><TD>
707 <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>
708 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
709 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
710 <B><FONT SIZE="+2">winamp plugin</FONT></B>
711 </FONT></TD></TR>
712 </TABLE>
713 <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>
714 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
715 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
716 <P>
Josh Coalson64e8ef72001-02-23 23:27:59 +0000[diff] [blame]717 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]718 </P>
719 </FONT>
720 </TD></TR>
721 </TABLE>
722 <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>
723</TD></TR>
724</TABLE>
725
726
Josh Coalson4c21cc82001-01-26 22:10:57 +0000[diff] [blame]727<TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
728<TR><TD>
729 <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>
730 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
731 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
732 <B><FONT SIZE="+2">known bugs</FONT></B>
733 </FONT></TD></TR>
734 </TABLE>
735 <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>
736 <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
737 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
738 <P>
Josh Coalson2d647902001-04-24 22:24:22 +0000[diff] [blame]739 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 +0000[diff] [blame]740 </P>
741 </FONT>
742 </TD></TR>
743 </TABLE>
744 <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>
745</TD></TR>
746</TABLE>
747
748
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]749</CENTER>
750
Josh Coalson276ad892001-06-10 20:58:08 +0000[diff] [blame^]751<P>&nbsp;Copyright (c) 2000,2001 Josh Coalson</P>
Josh Coalson6b05bc52001-06-08 00:13:21 +0000[diff] [blame]752
Josh Coalsonbb7f6b92000-12-10 04:09:52 +0000[diff] [blame]753</BODY>
754</HTML>