diff options
| author | Josh Coalson <jcoalson@users.sourceforce.net> | 2006-12-22 02:53:20 +0000 |
|---|---|---|
| committer | Josh Coalson <jcoalson@users.sourceforce.net> | 2006-12-22 02:53:20 +0000 |
| commit | 34cc68f24abfab632ed211237a52aaa61270234a (patch) | |
| tree | 4613439ecf47a4c3d8f8820fda8a920b7a8a7feb /doc/html | |
| parent | 83b37dbf6f480846beda9e289d8df440b3f3cba4 (diff) | |
| download | flac-34cc68f24abfab632ed211237a52aaa61270234a.tar.gz | |
reorganize to be more novice-friendly, add more docs
Diffstat (limited to 'doc/html')
| -rw-r--r-- | doc/html/Makefile.am | 9 | ||||
| -rw-r--r-- | doc/html/changelog.html | 43 | ||||
| -rw-r--r-- | doc/html/comparison.html | 7 | ||||
| -rw-r--r-- | doc/html/developers.html | 82 | ||||
| -rw-r--r-- | doc/html/documentation.html | 1491 | ||||
| -rw-r--r-- | doc/html/documentation_bugs.html | 107 | ||||
| -rw-r--r-- | doc/html/documentation_format_overview.html | 130 | ||||
| -rw-r--r-- | doc/html/documentation_tasks.html | 222 | ||||
| -rw-r--r-- | doc/html/documentation_tools.html | 92 | ||||
| -rw-r--r-- | doc/html/documentation_tools_flac.html | 1039 | ||||
| -rw-r--r-- | doc/html/documentation_tools_metaflac.html | 570 | ||||
| -rw-r--r-- | doc/html/documentation_tools_plugins.html | 94 | ||||
| -rw-r--r-- | doc/html/download.html | 76 | ||||
| -rw-r--r-- | doc/html/faq.html | 28 | ||||
| -rw-r--r-- | doc/html/features.html | 32 | ||||
| -rw-r--r-- | doc/html/format.html | 8 | ||||
| -rw-r--r-- | doc/html/id.html | 6 | ||||
| -rw-r--r-- | doc/html/index.html | 109 | ||||
| -rw-r--r-- | doc/html/itunes.html (renamed from doc/html/goals.html) | 56 | ||||
| -rw-r--r-- | doc/html/license.html | 6 | ||||
| -rw-r--r-- | doc/html/links.html | 8 | ||||
| -rw-r--r-- | doc/html/news.html | 8 | ||||
| -rw-r--r-- | doc/html/ogg_mapping.html | 6 |
23 files changed, 2482 insertions, 1747 deletions
diff --git a/doc/html/Makefile.am b/doc/html/Makefile.am index c5f27574..adbcc30d 100644 --- a/doc/html/Makefile.am +++ b/doc/html/Makefile.am @@ -26,15 +26,22 @@ doc_DATA = \ comparison.html \ developers.html \ documentation.html \ + documentation_bugs.html \ + documentation_format_overview.html \ + documentation_tasks.html \ + documentation_tools.html \ + documentation_tools_flac.html \ + documentation_tools_metaflac.html \ + documentation_tools_plugins.html \ download.html \ faq.html \ favicon.ico \ features.html \ flac.css \ format.html \ - goals.html \ id.html \ index.html \ + itunes.html \ license.html \ links.html \ news.html \ diff --git a/doc/html/changelog.html b/doc/html/changelog.html index 961b096b..5d247637 100644 --- a/doc/html/changelog.html +++ b/doc/html/changelog.html @@ -29,12 +29,8 @@ <a href="faq.html">faq</a> | <a href="news.html">news</a> | <a href="download.html">download</a> | - <a href="features.html">features</a> | - <a href="goals.html">goals</a> | - <a href="format.html">format</a> | - <a href="id.html">id</a> | - <a href="comparison.html">comparison</a> | <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | changelog | <a href="links.html">links</a> | <a href="developers.html">developers</a> @@ -53,7 +49,7 @@ </div> <div class="box_header"></div> <div class="box_body"> - This is an informal changelog, a summary of changes in each release. (See also <a href="documentation.html#bugs">known bugs</a>.) Particulary important for developers is the precise description of changes to the library interfaces. See also the <a href="api/group__porting.html">porting guide</a> for specific instructions on porting to newer versions of FLAC.<br /> + This is an informal changelog, a summary of changes in each release. (See also <a href="documentation_bugs.html">known bugs</a>.) Particulary important for developers is the precise description of changes to the library interfaces. See also the <a href="api/group__porting.html">porting guide</a> for specific instructions on porting to newer versions of FLAC.<br /> <br /> @@ -86,7 +82,7 @@ <ul> <li>Fixed a bug that caused suboptimal default compression settings in some locales (<a href="https://sourceforge.net/tracker/index.php?func=detail&aid=1608883&group_id=13478&atid=113478">SF #1608883</a>).</li> <li>Fixed a bug where FLAC-to-FLAC transcoding of a corrupted FLAC file would truncate the transcoded file at the first error (<a href="http://sourceforge.net/tracker/index.php?func=detail&aid=1615019&group_id=13478&atid=113478">SF #1615019</a>).</li> - <li>Fixed a bug where using <span class="argument"><a href="documentation.html#flac_options_decode_through_errors">-F</a></span> with FLAC-to-FLAC transcoding of a corrupted FLAC would have no effect (<a href="http://sourceforge.net/tracker/index.php?func=detail&aid=1615391&group_id=13478&atid=113478">SF #1615391</a>).</li> + <li>Fixed a bug where using <span class="argument"><a href="documentation_tools_flac.html#flac_options_decode_through_errors">-F</a></span> with FLAC-to-FLAC transcoding of a corrupted FLAC would have no effect (<a href="http://sourceforge.net/tracker/index.php?func=detail&aid=1615391&group_id=13478&atid=113478">SF #1615391</a>).</li> </ul> </li> <li> @@ -154,7 +150,7 @@ <li>Better multichannel support</li> <li>Large file (>2GB) support everywhere</li> <li><span class="commandname">flac</span> now supports FLAC and Ogg FLAC as input to the encoder (e.g. can re-encode FLAC to FLAC) and preserve all the metadata like tags, etc.</li> - <li>New <span class="code"><a href="format.html#def_PICTURE">PICTURE</a></span> metadata block for storing things like cover art, new <span class="argument"><a href="documentation.html#flac_options_picture">--picture</a></span> option to <span class="commandname">flac</span> and <span class="argument"><a href="documentation.html#metaflac_shorthand_import_picture_from">--import-picture-from</a></span> option to <span class="commandname">metaflac</span> for importing pictures, new <span class="argument"><a href="documentation.html#metaflac_shorthand_export_picture_to">--export-picture-to</a></span> option to <span class="commandname">metaflac</span> for exporting pictures, and metadata API <a href="api/group__flac__metadata__level0.html#ga3">additions</a> for searching for suitable pictures based on type, size and color constraints.</li> + <li>New <span class="code"><a href="format.html#def_PICTURE">PICTURE</a></span> metadata block for storing things like cover art, new <span class="argument"><a href="documentation_tools_flac.html#flac_options_picture">--picture</a></span> option to <span class="commandname">flac</span> and <span class="argument"><a href="documentation_tools_metaflac.html#metaflac_shorthand_import_picture_from">--import-picture-from</a></span> option to <span class="commandname">metaflac</span> for importing pictures, new <span class="argument"><a href="documentation_tools_metaflac.html#metaflac_shorthand_export_picture_to">--export-picture-to</a></span> option to <span class="commandname">metaflac</span> for exporting pictures, and metadata API <a href="api/group__flac__metadata__level0.html#ga3">additions</a> for searching for suitable pictures based on type, size and color constraints.</li> <li>Support for new <tt>REPLAYGAIN_REFERENCE_LOUDNESS</tt> tag.</li> <li>Fixed a bug in Ogg FLAC encoding where metadata was not being updated properly. Existing Ogg FLAC files should be recoded to fix up the metadata, e.g. <span class="command">flac -Vf -S 10s --ogg file.ogg</span></li> <li>In the developer libraries, the interface has been simplfied by merging the three decoding layers into a single class; ditto for the encoders. Also, libOggFLAC has been merged into libFLAC and libOggFLAC++ has been merged into libFLAC++ so there is a single API supporting both native FLAC and Ogg FLAC.</li> @@ -177,14 +173,14 @@ <li> flac: <ul> - <li>Improved the <span class="argument"><a href="documentation.html#flac_options_decode_through_errors">-F</a></span> option to allow decoding of FLAC files whose metadata is corrupted, and other kinds of severe corruption.</li> + <li>Improved the <span class="argument"><a href="documentation_tools_flac.html#flac_options_decode_through_errors">-F</a></span> option to allow decoding of FLAC files whose metadata is corrupted, and other kinds of severe corruption.</li> <li>Encoder can now take FLAC and Ogg FLAC as input. The output FLAC file will have all the same metadata as the original unless overridden with options on the command line.</li> <li>Encoder can now take WAVEFORMATEXTENSIBLE WAVE files as input; decoder will output WAVEFORMATEXTENSIBLE WAVE files when necessary to conform to the latest Microsoft specifications.</li> <li>Now properly supports AIFF and WAVEFORMATEXTENSIBLE multichannel input, performing necessary channel reordering both for encoding and decoding. WAVEFORMATEXTENSIBLE channel mask is also saved to a tag on encoding and restored on decoding for situations when there is no natural mapping to FLAC channel assignments.</li> <li>Expanded support for "odd" sample resolutions to WAVE and AIFF input; all resolutions from 4 to 24 bits-per-sample now supported for all input types.</li> - <li>Added a new option <span class="argument"><a href="documentation.html#flac_options_tag_from_file">--tag-from-file</a></span> for setting a tag from file (e.g. for importing a cuesheet as a tag).</li> - <li>Added a new option <span class="argument"><a href="documentation.html#flac_options_picture">--picture</a></span> for adding pictures.</li> - <li>Added a new option <span class="argument"><a href="documentation.html#flac_options_apodization">--apodization</a></span> for specifying the window function(s) to be used in LPC analysis.</li> + <li>Added a new option <span class="argument"><a href="documentation_tools_flac.html#flac_options_tag_from_file">--tag-from-file</a></span> for setting a tag from file (e.g. for importing a cuesheet as a tag).</li> + <li>Added a new option <span class="argument"><a href="documentation_tools_flac.html#flac_options_picture">--picture</a></span> for adding pictures.</li> + <li>Added a new option <span class="argument"><a href="documentation_tools_flac.html#flac_options_apodization">--apodization</a></span> for specifying the window function(s) to be used in LPC analysis.</li> <li>Added support for encoding from non-compressed AIFF-C (<a href="https://sourceforge.net/tracker/?func=detail&atid=113478&aid=1090933&group_id=13478">SF #1090933</a>).</li> <li>Importing of non-CDDA-compliant cuesheets now only issues a warning, not an error (see <a href="http://www.hydrogenaudio.org/forums/index.php?showtopic=31282">here</a>).</li> <li>MD5 comparison failures on decoding are now an error instead of a warning and will also return a non-zero exit code (<a href="https://sourceforge.net/tracker/index.php?func=detail&aid=1493725&group_id=13478&atid=113478">SF #1493725</a>).</li> @@ -205,11 +201,11 @@ metaflac: <ul> <li>Added support for read-only operations on Ogg FLAC files.</li> - <li>Added a new option <span class="argument"><a href="documentation.html#metaflac_shorthand_set_tag_from_file">--set-tag-from-file</a></span> for setting a tag from file (e.g. for importing a cuesheet as a tag).</li> - <li>Added a new option <span class="argument"><a href="documentation.html#metaflac_shorthand_import_picture_from">--import-picture-from</a></span> for importing pictures.</li> - <li>Added a new option <span class="argument"><a href="documentation.html#metaflac_shorthand_export_picture_to">--export-picture-to</a></span> for exporting pictures.</li> - <li>Added shorthand operation <span class="argument"><a href="documentation.html#metaflac_shorthand_remove_replay_gain">--remove-replay-gain</a></span> for removing ReplayGain tags.</li> - <li><span class="argument"><a href="documentation.html#metaflac_shorthand_export_cuesheet_to">--export-cuesheet-to</a></span> now properly specifies the FLAC file name (<a href="https://sourceforge.net/tracker/index.php?func=detail&aid=1272825&group_id=13478&atid=363478">SF #1272825</a>).</li> + <li>Added a new option <span class="argument"><a href="documentation_tools_metaflac.html#metaflac_shorthand_set_tag_from_file">--set-tag-from-file</a></span> for setting a tag from file (e.g. for importing a cuesheet as a tag).</li> + <li>Added a new option <span class="argument"><a href="documentation_tools_metaflac.html#metaflac_shorthand_import_picture_from">--import-picture-from</a></span> for importing pictures.</li> + <li>Added a new option <span class="argument"><a href="documentation_tools_metaflac.html#metaflac_shorthand_export_picture_to">--export-picture-to</a></span> for exporting pictures.</li> + <li>Added shorthand operation <span class="argument"><a href="documentation_tools_metaflac.html#metaflac_shorthand_remove_replay_gain">--remove-replay-gain</a></span> for removing ReplayGain tags.</li> + <li><span class="argument"><a href="documentation_tools_metaflac.html#metaflac_shorthand_export_cuesheet_to">--export-cuesheet-to</a></span> now properly specifies the FLAC file name (<a href="https://sourceforge.net/tracker/index.php?func=detail&aid=1272825&group_id=13478&atid=363478">SF #1272825</a>).</li> <li>Importing of non-CDDA-compliant cuesheets now issues a warning.</li> <li>Removed the following deprecated tag editing options; you should use the new option names shown instead: <ul> @@ -329,7 +325,7 @@ <li>Sped up decoding by a few percent overall.</li> <li>Sped up encoding when not using LPC (i.e. when using <span class="commandname">flac</span> options <span class="argument">-0</span>, <span class="argument">-1</span>, <span class="argument">-2</span>, or <span class="argument">-l 0</span>).</li> <li>Fixed a decoding bug that could cause sync errors with some ID3v1-tagged FLAC files.</li> - <li>Added <a href="documentation.html#metaflac">HTML documentation for metaflac</a>.</li> + <li>Added <a href="documentation_tools_metaflac.html#metaflac">HTML documentation for metaflac</a>.</li> </ul> </li> <li> @@ -347,7 +343,7 @@ <li> flac: <ul> - <li>New option <span class="argument"><a href="documentation.html#flac_options_input_size">--input-size</a></span> to manually specify the input size when encoding raw samples from stdin.</li> + <li>New option <span class="argument"><a href="documentation_tools_flac.html#flac_options_input_size">--input-size</a></span> to manually specify the input size when encoding raw samples from stdin.</li> </ul> </li> <li> @@ -454,16 +450,16 @@ <li> Ogg FLAC format: <ul> - <li>First official FLAC->Ogg bitstream mapping standardized (see new <a href="ogg_mapping.html">FLAC-to-Ogg mapping specification</a>). See the documentation for the <span class="argument"><a href="documentation.html#flac_options_ogg">--ogg</a></span> switch about having to re-encode older Ogg FLAC files.</li> + <li>First official FLAC->Ogg bitstream mapping standardized (see new <a href="ogg_mapping.html">FLAC-to-Ogg mapping specification</a>). See the documentation for the <span class="argument"><a href="documentation_tools_flac.html#flac_options_ogg">--ogg</a></span> switch about having to re-encode older Ogg FLAC files.</li> </ul> </li> <li> flac: <ul> <li>Print an error when output file already exists instead of automatically overwriting.</li> - <li>New option <span class="argument"><a href="documentation.html#flac_options_force">-f</a></span> (<span class="argument"><a href="documentation.html#flac_options_force">--force</a></span>) to force overwriting if the output file already exists.</li> - <li>New option <span class="argument"><a href="documentation.html#flac_options_cue">--cue</a></span> to select a specific section to decode using cuesheet track/index points.</li> - <li>New option <span class="argument"><a href="documentation.html#flac_options_totally_silent">--totally-silent</a></span> to suppress all output.</li> + <li>New option <span class="argument"><a href="documentation_tools_flac.html#flac_options_force">-f</a></span> (<span class="argument"><a href="documentation_tools_flac.html#flac_options_force">--force</a></span>) to force overwriting if the output file already exists.</li> + <li>New option <span class="argument"><a href="documentation_tools_flac.html#flac_options_cue">--cue</a></span> to select a specific section to decode using cuesheet track/index points.</li> + <li>New option <span class="argument"><a href="documentation_tools_flac.html#flac_options_totally_silent">--totally-silent</a></span> to suppress all output.</li> <li>New (but undocumented) option <span class="argument">--apply-replaygain-which-is-not-lossless</span> which applies ReplayGain to the decoded output. See <a href="http://www.hydrogenaudio.org/forums/index.php?showtopic=17293&st=11">this thread</a> for usage and caveats.</li> <li>When encoding to Ogg FLAC, use a random serial number (instead of 0 as was done before) when a serial number is not specified.</li> <li>When encoding multiple Ogg FLAC streams, <span class="argument">--serial-number</span> or random serial number sets the first number, which is then incremented for subsequent streams (before, the same serial number was used for all streams).</li> @@ -628,6 +624,7 @@ <div class="box_footer"></div> </div> + <div class="copyright"> <!-- @@@ oh so hacky --> <table> diff --git a/doc/html/comparison.html b/doc/html/comparison.html index cf8930e6..62bc7fb9 100644 --- a/doc/html/comparison.html +++ b/doc/html/comparison.html @@ -29,12 +29,8 @@ <a href="faq.html">faq</a> | <a href="news.html">news</a> | <a href="download.html">download</a> | - <a href="features.html">features</a> | - <a href="goals.html">goals</a> | - <a href="format.html">format</a> | - <a href="id.html">id</a> | - comparison | <a href="documentation.html">documentation</a> | + comparison | <a href="changelog.html">changelog</a> | <a href="links.html">links</a> | <a href="developers.html">developers</a> @@ -67,6 +63,7 @@ Note: the comparison tables are getting a little stale for some of the other encoders; for some alternate comparisons and other lossless information see these links: <ul> <li><a href="http://web.inter.nl.net/users/hvdh/lossless/lossless.htm">Hans Heijden's</a> lossless comparison</li> + <li><a href="http://www.synthetic-soul.co.uk/comparison/lossless/">Synthetic Soul</a> lossless comparison</li> <li><a href="http://wiki.hydrogenaudio.org/index.php?title=Lossless_comparison">Roberto Amorim's</a> lossless comparison on Hydrogenaudio</li> <li><a href="http://www.hydrogenaudio.org/forums/index.php?showtopic=33226">"Which is the best lossless codec?"</a> thread on Hydrogenaudio</li> <li><a href="http://www.losslessaudioblog.com/">Lossless Audio Blog</a></li> diff --git a/doc/html/developers.html b/doc/html/developers.html index 1734c58b..a4b7980b 100644 --- a/doc/html/developers.html +++ b/doc/html/developers.html @@ -29,12 +29,8 @@ <a href="faq.html">faq</a> | <a href="news.html">news</a> | <a href="download.html">download</a> | - <a href="features.html">features</a> | - <a href="goals.html">goals</a> | - <a href="format.html">format</a> | - <a href="id.html">id</a> | - <a href="comparison.html">comparison</a> | <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | <a href="changelog.html">changelog</a> | <a href="links.html">links</a> | developers @@ -49,31 +45,27 @@ <div class="box"> <div class="box_title"> - FLAC developers + developers </div> <div class="box_header"></div> <div class="box_body"> - FLAC is an open source project and we are happy to enlist the help of anyone who wants to contribute. The preferred method for transmitting improvements is patch files (in "diff -c" format) sent to the <a href="http://lists.xiph.org/mailman/listinfo/flac-dev">developer mailing list</a>, but zipped up sources are OK. Make sure to read the <a href="goals.html">FLAC goals</a> first; there are some thing the we <b>don't</b> want added to FLAC, like copy protection and lossy compression.<br /> + FLAC is an open source project and we are happy to enlist the help of anyone who wants to contribute, or to help with FLAC support in other programs and devices. The preferred method of communication is the <a href="http://lists.xiph.org/mailman/listinfo/flac-dev">developer mailing list</a>.<br /> <br /> - High priority items are: - <ul> - <li> - Support in the plugins for using the CUESHEET metadata block. The plugin should be able to see a CUESHEET in a FLAC file and present the individual tracks in the player, and fetch metadata from CDDB or CDindex by computing the hash from the CUESHEET and looking up either in a local database or over the net. - </li> - </ul> - Some other "nice-to-haves": + FLAC is open to third-party developers who want to add support for FLAC into their programs. All the necessary functionality is contained the libFLAC libraries which are licensed under <a href="license.html">Xiph.org's BSD license</a>.<br /> + <br /> + Some pointers to developer documentation and code:<br /> <ul> - <li> - FLAC module for <a href="http://www.68k.org/~michael/audiofile/">Audiofile</a>. - </li> - <li> - <a href="http://java.sun.com/products/java-media/jmf/">JMF</a> plugin. - </li> - <li> - Streaming support in the Winamp plugin. - </li> + <li><a href="license.html">License</a> - The license under which the official tools are distributed.</li> + <li><a href="api/index.html">libFLAC and libFLAC++ APIs</a> - Complete library documentation.</li> + <li><a href="format.html">FLAC Format Specification</a> - The formal specification.</li> + <li><a href="ogg_mapping.html">Ogg FLAC Mapping</a> - How FLAC should be embedded in an Ogg container.</li> + <li><a href="id.html">ID Registration</a> - Register an ID if you need to write custom metadata.</li> + <li><a href="http://sourceforge.net/cvs/?group_id=13478">CVS Access</a> - instructions for checking out the source code.</li> + <li><a href="http://flac.cvs.sourceforge.net/flac">Browse the CVS repository</a> from your web browser.</li> </ul> - See also the <a href="http://sourceforge.net/projects/flac">FLAC project page</a> on Sourceforge.net. + There also are several examples in the FLAC code base of API usage that may also be helpful. Visit the <a href="download.html">download page</a> for instructions on how to get the source code. + <br /> + Finally, more resources are available on the <a href="http://sourceforge.net/projects/flac">FLAC project page</a> on Sourceforge.net. </div> <div class="box_footer"></div> </div> @@ -82,19 +74,45 @@ <div class="box"> <div class="box_title"> - third-party developers + goals </div> <div class="box_header"></div> <div class="box_body"> - FLAC is open to third-party developers who want to add support for FLAC into their programs. All the necessary functionality is contained the lib*FLAC libraries which are licensed under Xiph.org's BSD license. The relevant documentation here is: + Since FLAC is an open-source project, it's important to have a set of goals that everyone works to. They may change slightly from time to time but they're a good guideline. Changes should be in line with the goals and should not attempt to embrace any of the anti-goals.<br /> + <br /> + <b>Goals</b> <ul> - <li>The <a href="license.html">license page</a>.</li> - <li>The <a href="api/index.html">API documentation</a>.</li> - <li>The <a href="format.html">formal description</a> of the FLAC format.</li> - <li>The <a href="ogg_mapping.html">Ogg FLAC mapping</a> document.</li> - <li>The <a href="id.html">ID registration page</a> for registering an ID if you need to write custom metadata.</li> + <li> + FLAC should be and stay an open format with an open-source reference implementation. + </li> + <li> + FLAC should be lossless. This seems obvious but lossy compression seems to creep into every audio codec. This goal also means that <span class="commandname">flac</span> should stay archival quality and be truly lossless for all input. Testing of releases should be thorough. + </li> + <li> + FLAC should yield respectable compression, on par or better than other lossless codecs. + </li> + <li> + FLAC should allow at least realtime decoding on even modest hardware. + </li> + <li> + FLAC should support fast sample-accurate seeking. + </li> + <li> + FLAC should allow gapless playback of consecutive streams. This follows from the lossless goal. + </li> + <li> + The FLAC project owes a lot to the many people who have advanced the audio compression field so freely, and aims also to contribute through the open-source development of new ideas. + </li> + </ul> + <b>Anti-goals</b><br /> + <ul> + <li> + Lossy compression. There are already many suitable lossy formats (<a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a>, <a href="http://www.mp3-tech.org/">MP3</a>, etc.). + </li> + <li> + Copy prevention, DRM, etc. There is no intention to add any copy prevention methods. Of course, we can't stop someone from encrypting a FLAC stream in another container (e.g. the way Apple encrypts AAC in MP4 with FairPlay), that is the choice of the user. + </li> </ul> - There also are several examples in the FLAC code base of API usage that may also be helpful. Visit the <a href="download.html">download page</a> for instructions on how to get the source. </div> <div class="box_footer"></div> </div> diff --git a/doc/html/documentation.html b/doc/html/documentation.html index a4272ba0..6301ef3f 100644 --- a/doc/html/documentation.html +++ b/doc/html/documentation.html @@ -29,12 +29,8 @@ <a href="faq.html">faq</a> | <a href="news.html">news</a> | <a href="download.html">download</a> | - <a href="features.html">features</a> | - <a href="goals.html">goals</a> | - <a href="format.html">format</a> | - <a href="id.html">id</a> | - <a href="comparison.html">comparison</a> | documentation | + <a href="comparison.html">comparison</a> | <a href="changelog.html">changelog</a> | <a href="links.html">links</a> | <a href="developers.html">developers</a> @@ -53,1477 +49,32 @@ </div> <div class="box_header"></div> <div class="box_body"> - This page is broken up into the following sections: - <ul> - <li><a href="#format">format</a> - the user-level view of the FLAC format (for a more detailed explanation see the <a href="format.html">format page</a>).</li> - <li><a href="#flac">flac</a> - the usage of the command-line file encoder/decoder <span class="commandname">flac</span>.</li> - <li><a href="#metaflac">metaflac</a> - the usage of the command-line FLAC metadata editor <span class="commandname">metaflac</span>.</li> - <li><a href="#plugins">plugins</a> - documentation for the various input plugins.</li> - <li><a href="api/index.html">libFLAC and libFLAC++ APIs</a> - for developers who want to add FLAC support to their programs.</li> - <li><a href="#bugs">bugs</a> - known bugs.</li> - <li><a href="http://www.losslessaudioblog.com/wmpmce-lossless-guide/">How to add FLAC support to Windows Media Player</a></li> - <li><a href="#monkey">How to add FLAC support to the Monkey's Audio GUI</a></li> - </ul> - 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. - </div> - <div class="box_footer"></div> -</div> - -<br /> - -<div class="box"> - <div class="box_title"> - <a name="format">format</a> - </div> - <div class="box_header"></div> - <div class="box_body"> - <span class="commandname">flac</span> 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>.<br /> - <br /> - The basic structure of a FLAC stream is: - <ul> - <li>The four byte string "<span class="code">fLaC</span>"</li> - <li>The <a href="format.html#def_STREAMINFO"><span class="code">STREAMINFO</span></a> metadata block</li> - <li>Zero or more other metadata blocks</li> - <li>One or more audio frames</li> - </ul> - 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.<br /> - <br /> - <b>METADATA</b><br /> - <br /> - 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 <span class="code">STREAMINFO</span> 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 <span class="code">STREAMINFO</span> block is the MD5 signature of the <i>unencoded</i> audio data. This is useful for checking an entire stream for transmission errors.<br /> - <br /> - Other blocks allow for padding, seek tables, tags, cuesheets, and application-specific data. You can see <span class="commandname">flac</span> options below for adding <span class="code">PADDING</span> 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.<br /> - <br /> - 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 <span class="code">PADDING</span> block of the correct size when encoding, and overwrite the padding block with your <span class="code">APPLICATION</span> 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.<br /> - <br /> - <b>AUDIO DATA</b><br /> - <br /> - 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.<br /> - <br /> - <b>BLOCKING</b><br /> - <br /> - 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. <span class="commandname">flac</span> 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.<br /> - <br /> - <b>INTER-CHANNEL DECORRELATION</b><br /> - <br /> - 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. <span class="commandname">flac</span> has two options for this: <span class="argument">-m</span> always compresses both the left-right and mid-side versions of the block and takes the smallest frame, and <span class="argument">-M</span>, which adaptively switches between left-right and mid-side.<br /> - <br /> - <b>MODELING</b><br /> - <br /> - 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.<br /> - <br /> - First, fixed polynomial prediction (specified with <span class="argument">-l 0</span>) 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 (usually 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 <span class="argument">-e</span> to overcome this, which is significantly slower.<br /> - <br /> - 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.<br /> - <br /> - <b>RESIDUAL CODING</b><br /> - <br /> - 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.<br /> - <br /> - 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. <span class="commandname">flac</span> allows you to specify how the partitioning is done with the <span class="argument">-r</span> option. The residual can be broken into 2^<i>n</i> partitions, by using the option <span class="argument">-r n,n</span>. 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 <span class="argument">-r m,n</span>. 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.<br /> - <br /> - <b>FRAMING</b><br /> - <br /> - 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.<br /> - <br /> - <b>MISCELLANEOUS</b><br /> - <br /> - As a convenience, the reference decoder knows how to skip <a href="http://www.id3.org/">ID3v1 and ID3v2 tags</a>. Note however that the FLAC specification does not require compliant implementations to support ID3 in any form and their use is discouraged.<br /> - <br /> - <span class="commandname">flac</span> has a verify option <span class="argument">-V</span> 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 <span class="commandname">flac</span> will stop with an error. - </div> - <div class="box_footer"></div> -</div> - -<br /> - -<div class="box"> - <div class="box_title"> - <a name="flac">flac</a> - </div> - <div class="box_header"></div> - <div class="box_body"> - <span class="commandname">flac</span> is the command-line file encoder/decoder. The encoder currently supports as input RIFF WAVE, AIFF, FLAC or Ogg FLAC format, or raw interleaved samples. The decoder currently can output to RIFF WAVE or AIFF format, or raw interleaved samples. <span class="commandname">flac</span> only supports linear PCM samples (in other words, no A-LAW, uLAW, etc.), and the input must be between 4 and 24 bits per sample. This is not a limitation of the FLAC format, just the reference encoder/decoder.<br /> - <br /> - <span class="commandname">flac</span> assumes that files ending in ".wav" or that have the RIFF WAVE header present are WAVE files, files ending in ".aif" or ".aiff" or have the AIFF header present are AIFF files, and files ending in ".flac" or have the FLAC header present are FLAC files. This assumption may be overridden with a command-line option. It also assumes that files ending in ".ogg" of have the Ogg FLAC header present are Ogg FLAC files. Other than this, <span class="commandname">flac</span> makes no assumptions about file extensions, though the convention is that FLAC files have the extension ".flac" (or ".fla" on ancient "8.3" file systems like FAT-16).<br /> - <br /> - Before going into the full command-line description, a few other things help to sort it out: 1) <span class="commandname">flac</span> encodes by default, so you must use <b>-d</b> to decode; 2) the options <span class="argument">-0</span> .. <span class="argument">-8</span> (or <span class="argument">--fast</span> and <span class="argument">--best</span>) 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) <span class="commandname">flac</span> behaves similarly to gzip in the way it handles input and output files.<br /> - <br /> - <span class="commandname">flac</span> will be invoked one of four ways, depending on whether you are encoding, decoding, testing, or analyzing: - <ul> - <li> - Encoding: flac [<i><a href="#general_options"><general-options></a></i>] [<i><a href="#format_options"><format-options></a></i>] [<i><a href="#encoding_options"><encoding options></a></i>] [inputfile [...]] - </li> - <li> - Decoding: flac -d [<i><a href="#general_options"><general-options></a></i>] [<i><a href="#format_options"><format-options></a></i>] [<i><a href="#decoding_options"><decoding options></a></i>] [FLACfile [...]] - </li> - <li> - Testing: flac -t [<i><a href="#general_options"><general-options></a></i>] [FLACfile [...]] - </li> - <li> - Analyzing: flac -a [<i><a href="#general_options"><general-options></a></i>] [<i><a href="#analysis_options"><analysis-options></a></i>] [FLACfile [...]] - </li> - </ul> - In any case, if no <span class="argument">inputfile</span> is specified, stdin is assumed. If only one inputfile is specified, it may be "-" for stdin. When stdin is used as input, <span class="commandname">flac</span> will write to stdout. Otherwise <span class="commandname">flac</span> 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.<br /> - <br /> - If you are encoding/decoding from stdin to a file, you should use the -o option like so: - <ul> - <li> - flac [options] -o outputfile - </li> - <li> - flac -d [options] -o outputfile - </li> - </ul> - which are better than: - <ul> - <li> - flac [options] > outputfile - </li> - <li> - flac -d [options] > outputfile - </li> - </ul> - since the former allows flac to seek backwards to write the <span class="code">STREAMINFO</span> or RIFF WAVE header contents when necessary.<br /> - <br /> - Also, you can force output data to go to stdout using <span class="argument">-c</span>.<br /> - <br /> - To encode or decode files that start with a dash, use <span class="argument">--</span> to signal the end of options, to keep the filenames themselves from being treated as options: - <ul> - <li> - <span class="code">flac -V -- -01-filename.wav</span> - </li> - </ul> - The encoding options affect the compression ratio and encoding speed. The format options are used to tell <span class="commandname">flac</span> the arrangement of samples if the input file (or output file when decoding) is a raw file. If it is a RIFF WAVE or AIFF file the format options are not needed since they are read from the AIFF/WAVE header.<br /> - <br /> - In test mode, <span class="commandname">flac</span> 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.<br /> - <br /> - <span class="commandname">flac</span> can also re-encode FLAC files. In other words, you can specify a FLAC or Ogg FLAC file as an input to the encoder and it will decoder it and re-encode it according to the options you specify. It will also preserve all the metadata unless you override it with other options (e.g. specifying new tags, seekpoints, cuesheet, padding, etc.).<br /> - <br /> - - <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> - <table width="100%" border="1" bgcolor="#EEEED4"> - <tr> - <td colspan="2" bgcolor="#D3D4C5"> - <a name="general_options"><font size="+1"><b>General Options</b></font></a> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_version" /> - <span class="argument">-v</span>, <span class="argument">--version</span> - </td> - <td> - Show the <span class="commandname">flac</span> version number. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_help" /> - <span class="argument">-h</span>, <span class="argument">--help</span> - </td> - <td> - Show basic usage and a list of all options. Running <span class="commandname">flac</span> without arguments shows the short help screen by default. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_explain" /> - <span class="argument">-H</span>, <span class="argument">--explain</span> - </td> - <td> - Show detailed explanation of usage and all options. Running <span class="commandname">flac</span> without arguments shows the short help screen by default. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_decode" /> - <span class="argument">-d</span>, <span class="argument">--decode</span> - </td> - <td> - Decode (<span class="commandname">flac</span> encodes by default). <span class="commandname">flac</span> will exit with an exit code of <span class="argument">1</span> (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 <span class="argument">0</span>. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_test" /> - <span class="argument">-t</span>, <span class="argument">--test</span> - </td> - <td> - Test (same as <span class="argument">-d</span> except no decoded file is written). The exit codes are the same as in decode mode. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_analyze" /> - <span class="argument">-a</span>, <span class="argument">--analyze</span> - </td> - <td> - Analyze (same as <span class="argument">-d</span> 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. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_stdout" /> - <span class="argument">-c</span>, <span class="argument">--stdout</span> - </td> - <td> - Write output to stdout. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_silent" /> - <span class="argument">-s</span>, <span class="argument">--silent</span> - </td> - <td> - Silent: do not show encoding/decoding statistics. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_totally_silent" /> - <span class="argument">--totally-silent</span> - </td> - <td> - Do not print anything of any kind, including warnings or errors. The exit code will be the only way to determine successful completion. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_force" /> - <span class="argument">-f</span>, <span class="argument">--force</span> - </td> - <td> - Force overwriting of output files. By default, <span class="commandname">flac</span> warns that the output file already exists and continues to the next file. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_output_name" /> - <span class="argument">-o filename</span>,<br /><span class="argument">--output-name=filename</span> - </td> - <td> - Force the output file name (usually <span class="commandname">flac</span> just changes the extension). May only be used when encoding a single file. May not be used in conjunction with <a href="#flac_options_output_prefix"><span class="argument">--output-prefix</span></a>. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_output_prefix" /> - <span class="argument">--output-prefix=string</span> - </td> - <td> - Prefix each output file name with the given string. This can be useful for encoding/decoding files to a different directory. Make sure if your string is a path name that it ends with a trailing '<span class="argument">/</span>' slash. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_delete_input_file" /> - <span class="argument">--delete-input-file</span> - </td> - <td> - 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. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_skip" /> - <span class="argument">--skip={#|mm:ss.ss}</span> - </td> - <td> - Skip over the first # of samples of the input. This works for both encoding and decoding, but not testing. The alternative form <span class="argument">mm:ss.ss</span> can be used to specify minutes, seconds, and fractions of a second.<br /> - <br /> - Examples:<br /> - <br /> - <span class="argument">--skip=123</span> : skip the first 123 samples of the input<br /> - <span class="argument">--skip=1:23.45</span> : skip the first 1 minute and 23.45 seconds of the input - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_until" /> - <span class="argument">--until={#|[+|-]mm:ss.ss}</span> - </td> - <td> - Stop at the given sample number for each input file. This works for both encoding and decoding, but not testing. The given sample number is not included in the decoded output. The alternative form <span class="argument">mm:ss.ss</span> can be used to specify minutes, seconds, and fractions of a second. If a <span class="argument">+</span> sign is at the beginning, the <span class="argument">--until</span> point is relative to the <span class="argument">--skip</span> point. If a <span class="argument">-</span> sign is at the beginning, the <span class="argument">--until</span> point is relative to end of the audio.<br /> - <br /> - Examples:<br /> - <br /> - <span class="argument">--until=123</span> : decode only the first 123 samples of the input (samples 0-122, stopping at 123)<br /> - <span class="argument">--until=1:23.45</span> : decode only the first 1 minute and 23.45 seconds of the input<br /> - <span class="argument">--skip=1:00 --until=+1:23.45</span> : decode 1:00.00 to 2:23.45<br /> - <span class="argument">--until=-1:23.45</span> : decode everything except the last 1 minute and 23.45 seconds<br /> - <span class="argument">--until=-0:00</span> : decode until the end of the input (the same as not specifying <span class="argument">--until</span>) - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_ogg" /> - <span class="argument">--ogg</span> - </td> - <td> - When encoding, generate Ogg FLAC output instead of native FLAC. Ogg FLAC streams are FLAC streams wrapped in an Ogg transport layer. The resulting file should have an '.ogg' extension and will still be decodable by <span class="commandname">flac</span>.<br /> - <br /> - When decoding, force the input to be treated as Ogg FLAC. This is useful when piping input from stdin or when the filename does not end in '.ogg'.<br /> - <br /> - <b>NOTE:</b> Ogg FLAC files created prior to <span class="commandname">flac</span> 1.1.1 used an ad-hoc mapping and do not support seeking. They should be decoded and re-encoded with <span class="commandname">flac</span> 1.1.1 or later. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_serial_number" /> - <span class="argument">--serial-number=#</span> - </td> - <td> - When used with --ogg, specifies the serial number to use for the first Ogg FLAC stream, which is then incremented for each additional stream. When encoding and no serial number is given, <span class="commandname">flac</span> uses a random number for the first stream, then increments it for each additional stream. When decoding and no number is given, <span class="commandname">flac</span> uses the serial number of the first page. - </td> - </tr> - </table> - </td></tr></table> - - <br /> - - <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> - <table width="100%" border="1" bgcolor="#EEEED4"> - <tr> - <td colspan="2" bgcolor="#D3D4C5"> - <a name="analysis_options"><font size="+1"><b>Analysis Options</b></font></a> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_residual_text" /> - <span class="argument">--residual-text</span> - </td> - <td> - Includes the residual signal in the analysis file. This will make the file <b>very</b> big, much larger than even the decoded file. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_residual_gnuplot" /> - <span class="argument">--residual-gnuplot</span> - </td> - <td> - 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. - </td> - </tr> - </table> - </td></tr></table> - - <br /> - - <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> - <table width="100%" border="1" bgcolor="#EEEED4"> - <tr> - <td colspan="2" bgcolor="#D3D4C5"> - <a name="decoding_options"><font size="+1"><b>Decoding Options</b></font></a> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_cue" /> - <span class="argument">--cue=[#.#][-[#.#]]</span> - </td> - <td> - Set the beginning and ending cuepoints to decode. The optional first <span class="argument">#.#</span> is the track and index point at which decoding will start; the default is the beginning of the stream. The optional second <span class="argument">#.#</span> is the track and index point at which decoding will end; the default is the end of the stream. If the cuepoint does not exist, the closest one before it (for the start point) or after it (for the end point) will be used. If those don't exist, the start of the stream (for the start point) or end of the stream (for the end point) will be used. The cuepoints are merely translated into sample numbers then used as --skip and --until.<br /> - <br /> - Examples:<br /> - <br /> - <span class="argument">--cue=-</span> : decode the entire stream<br /> - <span class="argument">--cue=4.1</span> : decode from track 4, index 1 to the end of the stream<br /> - <span class="argument">--cue=4.1-</span> : decode from track 4, index 1 to the end of the stream<br /> - <span class="argument">--cue=-4.1</span> : decode from the beginning of the stream up to, but not including, track 4, index 1<br /> - <span class="argument">--cue=2.1-2.4</span> : decode from track 2, index 1, up to, but not including, track 2, index 4<br /> - <span class="argument">--cue=9.1-10.1</span> : decode from track 9 the way it would be played on a CD player; this works even if the CD has no 10th track. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_decode_through_errors" /> - <span class="argument">-F</span>,<br /><span class="argument">--decode-through-errors</span> - </td> - <td> - By default <span class="commandname">flac</span> stops decoding with an error and removes the partially decoded file if it encounters a bitstream error. With <span class="argument">-F</span>, errors are still printed but <span class="commandname">flac</span> will continue decoding to completion. Note that errors may cause the decoded audio to be missing some samples or have silent sections. - </td> - </tr> - <!-- @@@ undocumented, also not in the man page yet - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_apply_replaygain_which_is_not_lossless" /> - <span class="argument">-@@@-apply-replaygain-which-is-not-lossless[=<specification>]</span> - </td> - <td> - Applies ReplayGain values while decoding.<br /> - <br /> - <b>WARNING: THIS IS NOT LOSSLESS. DECODED AUDIO WILL NOT BE IDENTICAL TO THE ORIGINAL WITH THIS OPTION</b>.<br /> - <br /> - The equals sign and <specification> is optional. If omitted, the default is <span class="argument">0aLn1</span>.<br /> - <br /> - The <span class="argument"><specification></span> is a shorthand notation for describing how to apply ReplayGain. All components are optional but order is important. '<span class="argument">[]</span>' means 'optional'. '<span class="argument">|</span>' means 'or'. '<span class="argument">{}</span>' means required. The format is:<br /> - <br /> - <span class="argument">[<preamp>][a|t][l|L][n{0|1|2|3}]</span> - <ul> - <li> - <span class="argument"><preamp></span><br /> - A floating point number in dB. This is added to the existing gain value. - </li> - <li> - <span class="argument">a|t</span><br /> - Specify '<span class="argument">a</span>' to use the album gain, or '<span class="argument">t</span>' to use the track gain. If tags for the preferred kind (album/track) do not exist but tags for the other (track/album) do, those will be used instead. - </li> - <li> - <span class="argument">l|L</span><br /> - Specify '<span class="argument">l</span>' to peak-limit the output, so that the ReplayGain peak value is full-scale. Specify '<span class="argument">L</span>' to use a 6dB hard limiter that kicks in when the signal approaches full-scale. - </li> - <li> - <span class="argument">n{0|1|2|3}</span><br /> - Specify the amount of noise shaping. ReplayGain synthesis happens in floating point; the result is dithered before converting back to integer. This quantization adds noise. Noise shaping tries to move the noise where you won't hear it as much. <span class="argument">0</span> means no noise shaping, <span class="argument">1</span> means 'low', <span class="argument">2</span> means 'medium', <span class="argument">3</span> means 'high'. - </li> - </ul> - For example, the default of <span class="argument">0aLn1</span> means 0dB preamp, use album gain, 6dB hard limit, low noise shaping.<br /> - <br /> - <span class="argument">-@@@-apply-replaygain-which-is-not-lossless=3</span> means 3dB preamp, use album gain, no limiting, no noise shaping.<br /> - <br /> - <span class="commandname">flac</span> uses the ReplayGain tags for the calculation. If a stream does not have the required tags or they can't be parsed, decoding will continue with a warning, and no ReplayGain is applied to that stream. - </td> - </tr> - --> - </table> - </td></tr></table> - - <br /> - - <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> - <table width="100%" border="1" bgcolor="#EEEED4"> - <tr> - <td colspan="2" bgcolor="#D3D4C5"> - <a name="encoding_options"><font size="+1"><b>Encoding Options</b></font></a> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_verify" /> - <span class="argument">-V</span>, <span class="argument">--verify</span> - </td> - <td> - Verify the encoding process. With this option, <span class="commandname">flac</span> 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. <span class="argument">-V</span> increases the total encoding time but is guaranteed to catch any unforseen bug in the encoding process. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_lax" /> - <span class="argument">--lax</span> - </td> - <td> - Allow encoder to generate non-<a href="format.html#subset">Subset</a> files. The resulting FLAC file may not be streamable or might have trouble being played in all players (especially hardware devices), so you should only use this option in combination with custom encoding options meant for archival. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_replay_gain" /> - <span class="argument">--replay-gain</span> - </td> - <td> - Calculate <a href="http://www.replaygain.org/">ReplayGain</a> values and store them as FLAC tags, similar to <a href="http://packages.qa.debian.org/v/vorbisgain.html">VorbisGain</a>. Title gains/peaks will be computed for each input file, and an album gain/peak will be computed for all files. All input files must have the same resolution, sample rate, and number of channels. Only mono and stereo files are allowed, and the sample rate must be one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48 kHz. Also note that this option may leave a few extra bytes in a <span class="code">PADDING</span> block as the exact size of the tags is not known until all files are processed.<br /> - <br /> - Note that this option cannot be used when encoding to standard output (stdout). - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_cuesheet" /> - <span class="argument">--cuesheet=FILENAME</span> - </td> - <td> - Import the given cuesheet file and store it in a <a href="format.html#def_CUESHEET"><span class="code">CUESHEET</span></a> metadata block. This option may only be used when encoding a single file. A seekpoint will be added for each index point in the cuesheet to the <a href="format.html#def_SEEKTABLE"><span class="code">SEEKTABLE</span></a> unless <span class="argument">--no-cued-seekpoints</span> is specified.<br /> - <br /> - The cuesheet file must be of the sort written by <a href="http://www.goldenhawk.com/cdrwin.htm">CDRwin</a>, <a href="http://www.dcsoft.com/prod03.htm">CDRcue</a>, <a href="http://www.exactaudiocopy.de/">EAC</a>, etc. See also <a href="http://digitalx.org/cuesheetsyntax.php">cuesheet syntax</a>. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_picture" /> - <span class="argument">--picture=SPECIFICATION</span> - </td> - <td> - Import a picture and store it in a <a href="format.html#def_PICTURE"><span class="code">PICTURE</span></a> metadata block. More than one <span class="argument">--picture</span> command can be specified. The <span class="argument">SPECIFICATION</span> is a string whose parts are separated by <span class="argument">|</span> (pipe) characters. Some parts may be left empty to invoke default values. The format of <span class="argument">SPECIFICATION</span> is<br /> - <br /> - <tt> [TYPE]|MIME-TYPE|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE</tt><br /> - <br /> - <span class="argument">TYPE</span> is optional; it is a number from one of:<br /> - <ul> - <li><tt>0: Other</tt></li> - <li><tt>1: 32x32 pixels 'file icon' (PNG only)</tt></li> - <li><tt>2: Other file icon</tt></li> - <li><tt>3: Cover (front)</tt></li> - <li><tt>4: Cover (back)</tt></li> - <li><tt>5: Leaflet page</tt></li> - <li><tt>6: Media (e.g. label side of CD)</tt></li> - <li><tt>7: Lead artist/lead performer/soloist</tt></li> - <li><tt>8: Artist/performer</tt></li> - <li><tt>9: Conductor</tt></li> - <li><tt>10: Band/Orchestra</tt></li> - <li><tt>11: Composer</tt></li> - <li><tt>12: Lyricist/text writer</tt></li> - <li><tt>13: Recording Location</tt></li> - <li><tt>14: During recording</tt></li> - <li><tt>15: During performance</tt></li> - <li><tt>16: Movie/video screen capture</tt></li> - <li><tt>17: A bright coloured fish</tt></li> - <li><tt>18: Illustration</tt></li> - <li><tt>19: Band/artist logotype</tt></li> - <li><tt>20: Publisher/Studio logotype</tt></li> - </ul> - The default is 3 (front cover). There may only be one picture each of type 1 and 2 in a file.<br/> - <br /> - <span class="argument">MIME-TYPE</span> is mandatory; for best compatibility with players, use pictures with MIME type <tt>image/jpeg</tt> or <tt>image/png</tt>. The MIME type can also be --> to mean that <span class="argument">FILE</span> is actually a URL to an image, though this use is discouraged.<br /> - <br /> - <span class="argument">DESCRIPTION</span> is optional; the default is an empty string.<br /> - <br /> - The next part specfies the resolution and color information. If the <span class="argument">MIME-TYPE</span> is <tt>image/jpeg</tt>, <tt>image/png</tt>, or <tt>image/gif</tt>, you can usually leave this empty and they can be detected from the file. Otherwise, you must specify the width in pixels, height in pixels, and color depth in bits-per-pixel. If the image has indexed colors you should also specify the number of colors used. When manually specified, it is not checked against the file for accuracy.<br /> - <br /> - <span class="argument">FILE</span> is the path to the picture file to be imported, or the URL if MIME type is --><br /> - <br /> - For example, the specification <span class="argument">|image/jpeg|||../cover.jpg</span> will embed the JPEG file at <tt>../cover.jpg</tt>, defaulting to type 3 (front cover) and an empty description. The resolution and color info will be retrieved from the file itself.<br /> - <br /> - The specification <span class="argument">4|-->|CD|320x300x24/173|http://blah.blah/backcover.tiff</span> will embed the given URL, with type 4 (back cover), description "CD", and a manually specified resolution of 320x300, 24 bits-per-pixel, and 173 colors. The file at the URL will not be fetched; the URL itself is stored in the PICTURE metadata block. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_sector_align" /> - <span class="argument">--sector-align</span> - </td> - <td> - Align encoding of multiple CD format files on sector boundaries. This option is only allowed when encoding files all of which have a 44.1kHz sample rate and 2 channels. With <span class="argument">--sector-align</span>, the encoder will align the resulting .flac streams so that their lengths are even multiples of a CD sector (1/75th of a second, or 588 samples). It does this by carrying over any partial sector at the end of each file to the next stream. The last stream will be padded to alignment with zeroes.<br /> - <br /> - This option will have no effect if the files are already aligned (as is the normally the case with WAVE files ripped from a CD). <span class="commandname">flac</span> can only align a set of files given in one invocation of <span class="commandname">flac</span>.<br /> - <br /> - <b>WARNING:</b> The ordering of files is important! If you give a command like '<span class="code">flac --sector-align *.wav</span>' the shell may not expand the wildcard to the order you expect. To be safe you should '<span class="code">echo *.wav</span>' first to confirm the order, or be explicit like '<span class="code">flac --sector-align 8.wav 9.wav 10.wav</span>'. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_seekpoint" /> - <span class="argument">-S {#|X|#x|#s}</span>,<br /><span class="argument">--seekpoint={#|X|#x|#s}</span> - </td> - <td> - Include a point or points in a <span class="code">SEEKTABLE</span>:<br /> - <ul> - <li> - <span class="argument"># </span> : a specific sample number for a seek point - </li> - <li> - <span class="argument">X </span> : a placeholder point (always goes at the end of the <span class="code">SEEKTABLE</span>) - </li> - <li> - <span class="argument">#x</span> : # evenly spaced seekpoints, the first being at sample 0 - </li> - <li> - <span class="argument">#s</span> : a seekpoint every # seconds; # does not have to be a whole number, it can be, for example, <span class="argument">9.5</span>, meaning a seekpoint every 9.5 seconds - </li> - </ul> - You may use many -S options; the resulting <span class="code">SEEKTABLE</span> will be the unique-ified union of all such values.<br /> - With no -S options, flac defaults to '-S 10s'. Use --no-seektable for no <span class="code">SEEKTABLE</span>.<br /> - <b>NOTE:</b> -S #x and -S #s will not work if the encoder can't determine the input size before starting.<br /> - <b>NOTE:</b> 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 /> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_padding" /> - <span class="argument">-P #</span>, <span class="argument">--padding=#</span> - </td> - <td> - Tell the encoder to write a <span class="code">PADDING</span> metadata block of the given length (in bytes) after the <span class="code">STREAMINFO</span> block. This is useful if you plan to tag the file later with an <span class="code">APPLICATION</span> block; instead of having to rewrite the entire file later just to insert your block, you can write directly over the <span class="code">PADDING</span> block. Note that the total length of the <span class="code">PADDING</span> block will be 4 bytes longer than the length given because of the 4 metadata block header bytes. You can force no <span class="code">PADDING</span> block at all to be written with <span class="argument">--no-padding</span>. The encoder writes a <span class="code">PADDING</span> block of 8192 bytes by default (or 65536 bytes if the input audio stream is more than 20 minutes long). - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_tag" /> - <span class="argument">-T FIELD=VALUE</span>,<br /><span class="argument">--tag=FIELD=VALUE</span> - </td> - <td> - Add a FLAC tag. The comment must adhere to the Vorbis comment spec (which FLAC tags implement), i.e. the FIELD must contain only legal characters, terminated by an 'equals' sign. Make sure to quote the comment if necessary. This option may appear more than once to add several comments. NOTE: all tags will be added to all encoded files. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_tag_from_file" /> - <span class="argument">--tag-from-file=FIELD=FILENAME</span> - </td> - <td> - Like <a href="#flac_options_tag"><span class="argument">--tag</span></a>, except FILENAME is a file whose contents will be read verbatim to set the tag value. The contents will be converted to UTF-8 from the local charset. This can be used to store a cuesheet in a tag (e.g. <span class="argument">--tag-from-file="CUESHEET=image.cue"</span>). Do not try to store binary data in tag fields! Use APPLICATION blocks for that. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_blocksize" /> - <span class="argument">-b #</span>, <span class="argument">--blocksize=#</span> - </td> - <td> - Specify the block size in samples. Subset streams must use one of 192/576/1152/2304/4608/256/512/1024/2048/4096 (and 8192/16384 if the sample rate is >48kHz). The reference encoder uses the same block size for the entire stream. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_mid_side" /> - <span class="argument">-m</span>, <span class="argument">--mid-side</span> - </td> - <td> - 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. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_adaptive_mid_side" /> - <span class="argument">-M</span>, <span class="argument">--adaptive-mid-side</span> - </td> - <td> - Enable adaptive mid-side coding (only for stereo streams). Like <span class="argument">-m</span> but the encoder adaptively switches between independent and mid-side coding, which is faster but yields less compression than <span class="argument">-m</span> (which does an exhaustive search). - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_levels" /> - <span class="argument">-0 .. -8</span> - </td> - <td> - Fastest compression .. highest compression. The default is <span class="argument">-5</span>. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_level_0" /> - <span class="argument">-0</span>, <span class="argument">--compression-level-0</span> - </td> - <td> - Synonymous with <span class="argument">-l 0 -b 1152 -r 2,2</span> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_level_1" /> - <span class="argument">-1</span>, <span class="argument">--compression-level-1</span> - </td> - <td> - Synonymous with <span class="argument">-l 0 -b 1152 -M -r 2,2</span> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_level_2" /> - <span class="argument">-2</span>, <span class="argument">--compression-level-2</span> - </td> - <td> - Synonymous with <span class="argument">-l 0 -b 1152 -m -r 3</span> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_level_3" /> - <span class="argument">-3</span>, <span class="argument">--compression-level-3</span> - </td> - <td> - Synonymous with <span class="argument">-l 6 -b 4608 -r 3,3</span> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_level_4" /> - <span class="argument">-4</span>, <span class="argument">--compression-level-4</span> - </td> - <td> - Synonymous with <span class="argument">-l 8 -b 4608 -M -r 3,3</span> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_level_5" /> - <span class="argument">-5</span>, <span class="argument">--compression-level-5</span> - </td> - <td> - Synonymous with <span class="argument">-l 8 -b 4608 -m -r 3,3</span> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_level_6" /> - <span class="argument">-6</span>, <span class="argument">--compression-level-6</span> - </td> - <td> - Synonymous with <span class="argument">-l 8 -b 4608 -m -r 4</span> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_level_7" /> - <span class="argument">-7</span>, <span class="argument">--compression-level-7</span> - </td> - <td> - Synonymous with <span class="argument">-l 8 -b 4608 -m -e -r 6</span> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_level_8" /> - <span class="argument">-8</span>, <span class="argument">--compression-level-8</span> - </td> - <td> - Synonymous with <span class="argument">-l 12 -b 4608 -m -e -r 6</span> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_fast" /> - <span class="argument">--fast</span> - </td> - <td> - Fastest compression. Currently synonymous with <span class="argument">-0</span> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_best" /> - <span class="argument">--best</span> - </td> - <td> - Highest compression. Currently synonymous with <span class="argument">-8</span> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_exhaustive_model_search" /> - <span class="argument">-e</span>,<br /><span class="argument">--exhaustive-model-search</span> - </td> - <td> - 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%. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_apodization" /> - <span class="argument">-A "function"</span>, <span class="argument">--apodization="function"</span> - </td> - <td> - Window audio data with given the apodization function. The functions are: bartlett, bartlett_hann, blackman, blackman_harris_4term_92db, connes, flattop, gauss(STDDEV), hamming, hann, kaiser_bessel, nuttall, rectangle, triangle, tukey(P), welch.<br /> - For gauss(STDDEV), STDDEV is the standard deviation (0<STDDEV<=0.5).<br /> - For tukey(P), P specifies the fraction of the window that is tapered (0<=P<=1; P=0 corresponds to "rectangle" and P=1 corresponds to "hann").<br /> - More than one -A option (up to 32) may be used. Any function that is specified erroneously is silently dropped. The encoder chooses suitable defaults in the absence of any -A options; any -A option specified replaces the default(s).<br /> - When more than one function is specified, then for every subframe the encoder will try each of them separately and choose the window that results in the smallest compressed subframe. Multiple functions can greatly increase the encoding time.<br /> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_max_lpc_order" /> - <span class="argument">-l #</span>, <span class="argument">--max-lpc-order=#</span> - </td> - <td> - Specifies the maximum LPC order. This number must be <= 32. For Subset streams, it must be <=12 if the sample rate is <=48kHz. 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. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_qlp_coeff_precision" /> - <span class="argument">-q #</span>,<br /><span class="argument">--qlp-coeff-precision=#</span> - </td> - <td> - Specifies the precision of the quantized LP coefficients, in bits. The default is <span class="argument">-q 0</span>, 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. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_qlp_coeff_precision_search" /> - <span class="argument">-p</span>,<br /><span class="argument">--qlp-coeff-precision-search</span> - </td> - <td> - Do exhaustive LP coefficient quantization optimization. This option overrides any <span class="argument">-q</span> option. It is expensive and typically will only improve the compression a tiny fraction of a percent. <span class="argument">-q</span> has no effect when <span class="argument">-l 0</span> is used. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_rice_partition_order" /> - <span class="argument">-r [#,]#</span>,<br /><span class="argument">--rice-partition-order=[#,]#</span> - </td> - <td> - Set the [min,]max residual partition order. The min value defaults to 0 if unspecified.<br /> - <br /> - 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 <span class="argument">-r 2,2</span> (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 <span class="argument">-r 0,16</span> to force the highest degree of optimization. - </td> - </tr> - </table> - </td></tr></table> - - <br /> - - <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> - <table width="100%" border="1" bgcolor="#EEEED4"> - <tr> - <td colspan="2" bgcolor="#D3D4C5"> - <a name="format_options"><font size="+1"><b>Format Options</b></font></a> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_endian" /> - <span class="argument">--endian={big|little}</span> - </td> - <td> - Specify big-endian or little-endian byte order in the raw file. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_channels" /> - <span class="argument">--channels=#</span> - </td> - <td> - Specify the number of channels in the raw file. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_bps" /> - <span class="argument">--bps=#</span> - </td> - <td> - Specify the number of bits per sample in the raw file. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_sample_rate" /> - <span class="argument">--sample-rate=#</span> - </td> - <td> - Specify the sample rate of the raw file. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_sign" /> - <span class="argument">--sign={signed|unsigned}</span> - </td> - <td> - Specify that the samples in the raw file are signed or unsigned (the default is signed). - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_input_size" /> - <span class="argument">--input-size=#</span> - </td> - <td> - Specify the size of the raw input in bytes. If you are encoding raw samples from stdin, you must set this option in order to be able to use --skip, --until, --cue-sheet, or other options that need to know the size of the input beforehand. If the size given is greater than what is found in the input stream, the encoder will complain about an unexpected end-of-file. If the size given is less, samples will be truncated. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_force_aiff_format" /> - <span class="argument">--force-aiff-format</span> - </td> - <td> - Force the decoder to output AIFF format. This option is not needed if the output filename (as set by -o) ends with .aiff. Also, this option has no effect when encoding since input AIFF is auto-detected. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="flac_options_force_raw_format" /> - <span class="argument">--force-raw-format</span> - </td> - <td> - Treat the input file (or output file if decoding) as a raw file, regardless of the extension. - </td> - </tr> - </table> - </td></tr></table> - - <br /> - - <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> - <table width="100%" border="1" bgcolor="#EEEED4"> - <tr> - <td colspan="2" bgcolor="#D3D4C5"> - <a name="negative_options"><font size="+1"><b>Negative Options</b></font></a> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <span class="argument">--no-adaptive-mid-side</span><br /> - <span class="argument">--no-decode-through-errors</span><br /> - <span class="argument">--no-delete-input-file</span><br /> - <span class="argument">--no-escape-coding</span><br /> - <span class="argument">--no-exhaustive-model-search</span><br /> - <span class="argument">--no-lax</span><br /> - <span class="argument">--no-mid-side</span><br /> - <span class="argument">--no-ogg</span><br /> - <span class="argument">--no-padding</span><br /> - <span class="argument">--no-qlp-coeff-precision-search</span><br /> - <span class="argument">--no-residual-gnuplot</span><br /> - <span class="argument">--no-residual-text</span><br /> - <span class="argument">--no-sector-align</span><br /> - <span class="argument">--no-seektable</span><br /> - <span class="argument">--no-silent</span><br /> - <span class="argument">--no-verify</span> - </td> - <td> - Can all be used to turn off a particular option. - </td> - </tr> - </table> - </td></tr></table> - - </div> - <div class="box_footer"></div> -</div> - -<br /> - -<div class="box"> - <div class="box_title"> - <a name="metaflac">metaflac</a> - </div> - <div class="box_header"></div> - <div class="box_body"> - <span class="commandname">metaflac</span> is the command-line <span class="code">.flac</span> file metadata editor. You can use it to list the contents of metadata blocks, edit, delete or insert blocks, and manage padding.<br /> - <br /> - <span class="commandname">metaflac</span> takes a set of "options" (though some are not optional) and a set of FLAC files to operate on. There are three kinds of "options": - <ul> - <li> - Major operations, which specify a mode of operation like listing blocks, removing blocks, etc. These will have sub-operations describing exactly what is to be done. - </li> - <li> - Shorthand operations, which are convenient synonyms for major operations. For example, there is a shorthand operation <span class="argument">--show-sample-rate</span> that shows just the sample rate field from the <span class="code">STREAMINFO</span> metadata block. - </li> - <li> - Global options, which affect all the operations. - </li> - </ul> - All of these are described in the tables below. At least one shorthand or major operation must be supplied. You can use multiple shorthand operations to do more than one thing to a file or set of files. Most of the common things to do to metadata have shorthand operations. As an example, here is how to show the MD5 signatures for a set of three FLAC files:<br /> - <br /> - <span class="code">metaflac --show-md5sum file1.flac file2.flac file3.flac</span><br /> - <br /> - Another example; this removes all DESCRIPTION and COMMENT tags in a set of FLAC files, and uses the <span class="argument">--preserve-modtime</span> global option to keep the FLAC file modification times the same (usually when files are edited the modification time is set to the current time):<br /> - <br /> - <span class="code">metaflac --preserve-modtime --remove-tag=DESCRIPTION --remove-tag=COMMENT file1.flac file2.flac file3.flac</span><br /> - <br /> - - <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> - <table width="100%" border="1" bgcolor="#EEEED4"> - <tr> - <td colspan="2" bgcolor="#D3D4C5"> - <a name="global_options"><font size="+1"><b>Global Options</b></font></a> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_options_preserve_modtime" /> - <span class="argument">--preserve-modtime</span> - </td> - <td> - Preserve the original modification time in spite of edits. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_options_with_filename" /> - <span class="argument">--with-filename</span> - </td> - <td> - Prefix each output line with the FLAC file name (the default if more than one FLAC file is specified). - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_options_no_filename" /> - <span class="argument">--no-filename</span> - </td> - <td> - Do not prefix each output line with the FLAC file name (the default if only one FLAC file is specified) - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_options_no_utf8_convert" /> - <span class="argument">--no-utf8-convert</span> - </td> - <td> - Do not convert tags from UTF-8 to local charset, or vice versa. This is useful for scripts. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_options_dont_use_padding" /> - <span class="argument">--dont-use-padding</span> - </td> - <td> - By default <span class="commandname">metaflac</span> tries to use padding where possible to avoid rewriting the entire file if the metadata size changes. Use this option to tell metaflac to not take advantage of padding this way. - </td> - </tr> - </table> - </td></tr></table> - - <br /> - - <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> - <table width="100%" border="1" bgcolor="#EEEED4"> - <tr> - <td colspan="2" bgcolor="#D3D4C5"> - <a name="shorthand_operations"><font size="+1"><b>Shorthand Operations</b></font></a> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_show_md5sum" /> - <span class="argument">--show-md5sum</span> - </td> - <td> - Show the MD5 signature from the <span class="code">STREAMINFO</span> block. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_show_min_blocksize" /> - <span class="argument">--show-min-blocksize</span> - </td> - <td> - Show the minimum block size from the <span class="code">STREAMINFO</span> block. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_show_max_blocksize" /> - <span class="argument">--show-max-blocksize</span> - </td> - <td> - Show the maximum block size from the <span class="code">STREAMINFO</span> block. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_show_min_framesize" /> - <span class="argument">--show-min-framesize</span> - </td> - <td> - Show the minimum frame size from the <span class="code">STREAMINFO</span> block. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_show_max_framesize" /> - <span class="argument">--show-max-framesize</span> - </td> - <td> - Show the maximum frame size from the <span class="code">STREAMINFO</span> block. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_show_sample_rate" /> - <span class="argument">--show-sample-rate</span> - </td> - <td> - Show the sample rate from the <span class="code">STREAMINFO</span> block. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_show_channels" /> - <span class="argument">--show-channels</span> - </td> - <td> - Show the number of channels from the <span class="code">STREAMINFO</span> block. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_show_bps" /> - <span class="argument">--show-bps</span> - </td> - <td> - Show the # of bits per sample from the <span class="code">STREAMINFO</span> block. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_show_total_samples" /> - <span class="argument">--show-total-samples</span> - </td> - <td> - Show the total # of samples from the <span class="code">STREAMINFO</span> block. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_show_vendor_tag" /> - <span class="argument">--show-vendor-tag</span> - </td> - <td> - Show the vendor string from the <span class="code">VORBIS_COMMENT</span> block. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_show_tag" /> - <span class="argument">--show-tag=NAME</span> - </td> - <td> - Show all tags where the the field name matches <span class="argument">NAME</span>. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_remove_tag" /> - <span class="argument">--remove-tag=NAME</span> - </td> - <td> - Remove all tags whose field name is <span class="argument">NAME</span>. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_remove_first_tag" /> - <span class="argument">--remove-first-tag=NAME</span> - </td> - <td> - Remove first tag whose field name is <span class="argument">NAME</span>. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_remove_all_tags" /> - <span class="argument">--remove-all-tags</span> - </td> - <td> - Remove all tags, leaving only the vendor string. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_set_tag" /> - <span class="argument">--set-tag=FIELD</span> - </td> - <td> - Add a tag. The <span class="argument">FIELD</span> must comply with the Vorbis comment spec, of the form <span class="argument">NAME=VALUE</span>. If there is currently no tag block, one will be created. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_set_tag_from_file" /> - <span class="argument">--set-tag-from-file=FIELD</span> - </td> - <td> - Like <a href="#metaflac_shorthand_set_tag"><span class="argument">--set-tag</span></a>, except the VALUE is a filename whose contents will be read verbatim to set the tag value. Unless <a href="#metaflac_options_no_utf8_convert"><span class="argument">--no-utf8-convert</span></a> is specified, the contents will be converted to UTF-8 from the local charset. This can be used to store a cuesheet in a tag (e.g. <span class="argument">--set-tag-from-file="CUESHEET=image.cue"</span>). Do not try to store binary data in tag fields! Use APPLICATION blocks for that. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_import_tags_from" /> - <span class="argument">--import-tags-from=FILE</span> - </td> - <td> - Import tags from a file. Use <span class="argument">-</span> for stdin. Each line should be of the form <span class="argument">NAME=VALUE</span>. Multi-line comments are currently not supported. Specify <span class="argument">--remove-all-tags</span> and/or <a href="#metaflac_options_no_utf8_convert"><span class="argument">--no-utf8-convert</span></a> before <span class="argument">--import-tags-from</span> if necessary. If <span class="argument">FILE</span> is <span class="argument">-</span> (stdin), only one FLAC file may be specified. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_export_tags_to" /> - <span class="argument">--export-tags-to=FILE</span> - </td> - <td> - Export tags to a file. Use <span class="argument">-</span> for stdin. Each line will be of the form <span class="argument">NAME=VALUE</span>. Specify <a href="#metaflac_options_no_utf8_convert"><span class="argument">--no-utf8-convert</span></a> if necessary. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_import_cuesheet_from" /> - <span class="argument">--import-cuesheet-from=FILE</span> - </td> - <td> - Import a cuesheet from a file. Use <span class="argument">-</span> for stdin. Only one FLAC file may be specified. A seekpoint will be added for each index point in the cuesheet to the <span class="code">SEEKTABLE</span> unless <span class="argument">--no-cued-seekpoints</span> is specified. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_export_cuesheet_to" /> - <span class="argument">--export-cuesheet-to=FILE</span> - </td> - <td> - Export <span class="code">CUESHEET</span> block to a cuesheet file, suitable for use by CD authoring software. Use <span class="argument">-</span> for stdout. Only one FLAC file may be specified on the command line. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_import_picture_from" /> - <span class="argument">--import-picture-from=SPECIFICATION</span> - </td> - <td> - Import a picture and store it in a <a href="format.html#def_PICTURE"><span class="code">PICTURE</span></a> metadata block. See the <span class="commandname">flac</span> option <span class="argument"><a href="#flac_options_picture">--picture</a></span> for an explanation of the <span class="argument">SPECIFICATION</span> syntax. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_export_picture_to" /> - <span class="argument">--export-picture-to=FILE</span> - </td> - <td> - Export <span class="code">PICTURE</span> block to a file. Use <span class="argument">-</span> for stdout. Only one FLAC file may be specified on the command line. The first <span class="code">PICTURE</span> block will be exported unless <span class="argument">--export-picture-to</span> is preceded by a <span class="argument">--block-number=#</span> option to specify the exact metadata block to extract. Note that the block number is the one shown by --list. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_add_replay_gain" /> - <span class="argument">--add-replay-gain</span> - </td> - <td> - Calculates the title and album gains/peaks of the given FLAC files as if all the files were part of one album, then stores them in the <span class="code">VORBIS_COMMENT</span> block. The tags are the same as those used by <span class="commandname">vorbisgain</span>. Existing ReplayGain tags will be replaced. If only one FLAC file is given, the album and title gains will be the same. Since this operation requires two passes, it is always executed last, after all other operations have been completed and written to disk. All FLAC files specified must have the same resolution, sample rate, and number of channels. The sample rate must be one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48 kHz. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_remove_replay_gain" /> - <span class="argument">--remove-replay-gain</span> - </td> - <td> - Removes the ReplayGain tags. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_add_seekpoint" /> - <span class="argument">--add-seekpoint={#|X|#x|#s}</span> - </td> - <td> - Add seek points to a <span class="code">SEEKTABLE</span> block:<br /> - <ul> - <li> - <span class="argument"># </span> : a specific sample number for a seek point - </li> - <li> - <span class="argument">X </span> : a placeholder point (always goes at the end of the <span class="code">SEEKTABLE</span>) - </li> - <li> - <span class="argument">#x</span> : # evenly spaced seekpoints, the first being at sample 0 - </li> - <li> - <span class="argument">#s</span> : a seekpoint every # seconds; # does not have to be a whole number, it can be, for example, <span class="argument">9.5</span>, meaning a seekpoint every 9.5 seconds - </li> - </ul> - If no <span class="code">SEEKTABLE</span> block exists, one will be created. If one already exists, points will be added to the existing table, and any duplicates will be turned into placeholder points.<br /> - You may use many <span class="argument">--add-seekpoint</span> options; the resulting <span class="code">SEEKTABLE</span> will be the unique-ified union of all such values. Example: <span class="argument">--add-seekpoint=100x --add-seekpoint=3.5s</span> will add 100 evenly spaced seekpoints and a seekpoint every 3.5 seconds.<br /> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_shorthand_add_padding" /> - <span class="argument">--add-padding=#</span> - </td> - <td> - Add a padding block of the given length (in bytes). The overall length of the new block will be 4 + length; the extra 4 bytes is for the metadata block header. - </td> - </tr> - </table> - </td></tr></table> - - <br /> - - <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> - <table width="100%" border="1" bgcolor="#EEEED4"> - <tr> - <td colspan="2" bgcolor="#D3D4C5"> - <a name="major_operations"><font size="+1"><b>Major Operations</b></font></a> - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_operations_version" /> - <span class="argument">--version</span> - </td> - <td> - Show the metaflac version number. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_operations_list" /> - <span class="argument">--list</span> - </td> - <td> - List the contents of one or more metadata blocks to stdout. By default, all metadata blocks are listed in text format. Use the following options to change this behavior:<br /> - <br /> - - <span class="argument">--block-number=#[,#[...]]</span><br /> - An optional comma-separated list of block numbers to display. The first block, the <span class="code">STREAMINFO</span> block, is block 0.<br /> - <br /> - - <span class="argument">--block-type=type[,type[...]]</span><br /> - <span class="argument">--except-block-type=type[,type[...]]</span><br /> - An optional comma-separated list of block types to be included or ignored with this option. Use only one of <span class="argument">--block-type</span> or <span class="argument">--except-block-type</span>. The valid block types are: <span class="code">STREAMINFO</span>, <span class="code">PADDING</span>, <span class="code">APPLICATION</span>, <span class="code">SEEKTABLE</span>, <span class="code">VORBIS_COMMENT</span>. You may narrow down the types of <span class="code">APPLICATION</span> blocks displayed as follows:<br /> - <table border="1"> - <tr> - <td><span class="argument">APPLICATION:abcd</span></td> - <td>The <span class="code">APPLICATION</span> block(s) whose textual representation of the 4-byte ID is "abcd"</td> - </tr> - <tr> - <td><span class="argument">APPLICATION:0xXXXXXXXX</span></td> - <td>The <span class="code">APPLICATION</span> block(s) whose hexadecimal big- endian representation of the 4-byte ID is "0xXXXXXXXX". For the example "abcd" above the hexadecimal equivalalent is 0x61626364</td> - </tr> - </table> - <br /> - - NOTE: if both <span class="argument">--block-number</span> and <span class="argument">--[except-]block-type</span> are specified, the result is the logical AND of both arguments.<br /> - <br /> - - <span class="argument">--application-data-format=hexdump|text</span><br /> - If the application block you are displaying contains binary data but your <span class="argument">--data-format=text</span>, you can display a hex dump of the application data contents instead using <span class="argument">--application-data-format=hexdump</span>. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_operations_remove" /> - <span class="argument">--remove</span> - </td> - <td> - Remove one or more metadata blocks from the metadata. Unless <span class="argument">--dont-use-padding</span> is specified, the blocks will be replaced with padding. You may not remove the <span class="code">STREAMINFO</span> block.<br /> - <br /> - - <span class="argument">--block-number=#[,#[...]]</span><br /> - <span class="argument">--block-type=type[,type[...]]</span><br /> - <span class="argument">--except-block-type=type[,type[...]]</span><br /> - See <a href="#metaflac_operations_list"><span class="argument">--list</span></a> above for usage.<br /> - <br /> - - NOTE: if both <span class="argument">--block-number</span> and <span class="argument">--[except-]block-type</span> are specified, the result is the logical AND of both arguments. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_operations_remove_all" /> - <span class="argument">--remove-all</span> - </td> - <td> - Remove all metadata blocks (except the <span class="code">STREAMINFO</span> block) from the metadata. Unless <span class="argument">--dont-use-padding</span> is specified, the blocks will be replaced with padding. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_operations_merge_padding" /> - <span class="argument">--merge-padding</span> - </td> - <td> - Merge adjacent <span class="code">PADDING</span> blocks into single blocks. - </td> - </tr> - <tr> - <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> - <a name="metaflac_operations_sort_padding" /> - <span class="argument">--sort-padding</span> - </td> - <td> - Move all <span class="code">PADDING</span> blocks to the end of the metadata and merge them into a single block. - </td> - </tr> - </table> - </td></tr></table> - - </div> - <div class="box_footer"></div> -</div> - -<br /> - -<div class="box"> - <div class="box_title"> - <a name="plugins"></a><a name="xmms_plugin">xmms plugin</a> - </div> - <div class="box_header"></div> - <div class="box_body"> - All that is necessary is to copy <span class="code">libxmms-flac.so</span> to the directory where XMMS looks for input plugins (usually <span class="code">/usr/lib/xmms/Input</span> or <span class="code">$HOME/.xmms/Input</span>). There is nothing else to configure. Make sure to restart XMMS before trying to play any <span class="code">.flac</span> files. - </div> - <div class="box_footer"></div> -</div> - -<br /> - -<div class="box"> - <div class="box_title"> - <a name="winamp2_plugin">winamp2 plugin</a> - </div> - <div class="box_header"></div> - <div class="box_body"> - The Winamp plugin should work for both Winamp2 and Winamp5. If you are using Winamp 2.x, all that is necessary is to copy <span class="code">in_flac.dll</span> to the <span class="code">Plugins/</span> directory of your Winamp installation. There is nothing else to configure. Make sure to restart Winamp before trying to play any <span class="code">.flac</span> files. - </div> - <div class="box_footer"></div> -</div> - -<br /> - -<div class="box"> - <div class="box_title"> - <a name="bugs">known bugs</a> - </div> - <div class="box_header"></div> - <div class="box_body"> - 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, make sure and provide an email contact or use the Monitor feature.<br /> - <br /> - The following are major known bugs in the current (1.1.3) release: - <ul> - <li> - If your locale does not use "." for the decimal point, there is a bug that causes the default compression settings to be sub-optimal. You should add <span class="argument">-A "tukey(0,5)"</span> to your <span class="command">flac</span> command string (or however "0.5" should be formatted for your locale). - </li> - <li> - If a corrupted FLAC file is used as input in FLAC-to-FLAC encoding, the transcoded FLAC file will have the audio data truncated after the first error. - </li> - <li> - When encoding to Ogg FLAC, if there are too many seek points (>240), the seek table will not have the offsets written back properly after encoding. - </li> - </ul> - The following are major known bugs in the 1.1.0 release: + FLAC is a general purpose audio format supported by many programs. Most of the documentation here is about the FLAC format itself and the tools we provide, but there is also information on using other programs that support FLAC. <ul> - <li> - If you change the FLAC configuration options in the XMMS plugin while a FLAC file is playing, it can cause a crash or other bad things to happen. - </li> + <li><a href="features.html">Introduction</a> - What is FLAC?</li> + <li><a href="download.html">Getting FLAC</a> - How to download what you need to play or make FLAC files.</li> + <li><a href="documentation_tasks.html">Using FLAC</a> - If you have some FLAC files and want to do something with them, or want to create FLAC files, look here.</li> + <li><a href="faq.html">FAQ</a> - Frequently Asked Questions</li> </ul> - The following are major known bugs in the 1.0.4 release: + In more detail: <ul> - <li> - All decoders prior to and including 1.0.4 have a bug that prevents them from skipping unknown metadata blocks properly. A FLAC file created by flac 1.1.0 containing a <span class="code">CUESHEET</span> metadata block will not decode in 1.0.x decoders. - </li> - <li> - <span class="commandname">metaflac</span> has a bug where, if --import-vc-from is used on a FLAC file that has no Vorbis comment block, the FLAC file can be corrupted. All FLAC files generated by 1.0.4 have a Vorbis comment block added automatically but files from 1.0.3 and before do not. This is fixed in CVS. - </li> - <li> - There is an odd bug in <span class="commandname">metaflac</span> such that you must always use the <span class="argument">--dont-use-padding</span> option with <span class="argument">--add-padding</span> or the padding block won't be written. This is fixed in CVS. - </li> + <li><a href="documentation_format_overview.html">About the FLAC Format</a> - An overview of the FLAC format for power users.</li> + <li><a href="documentation_tools.html">Official Tools</a> - How to use the <span class="commandname">flac</span> and <span class="commandname">metaflac</span> command-line tools.</li> + <li><a href="comparison.html">Comparison</a> - A comparison of FLAC with other lossless codecs.</li> + <li><a href="documentation_bugs.html">Bugs</a> - How to report bugs and request features, and a list of known bugs in the FLAC tools.</li> + <li><a href="http://sourceforge.net/tracker/?group_id=13478&atid=213478">Request Support</a> - Support for the official FLAC tools. For other programs, use <a href="http://www.hydrogenaudio.org/">hydrogenaudio.org</a> + <li><a href="http://lists.xiph.org/mailman/listinfo/flac">FLAC Mailing List</a> - General discussion about FLAC, tools, releases, etc.</li> </ul> - </div> - <div class="box_footer"></div> -</div> - -<br /> - -<div class="box"> - <div class="box_title"> - <a name="monkey">monkey</a> - </div> - <div class="box_header"></div> - <div class="box_body"> - Monkey's Audio comes with a nice GUI that many people are familiar with. It supports some external encoders, but not FLAC. However, the FLAC Windows distribution comes with a utility that allows you to replace one the of the supported lossless external codecs with FLAC. Here's how: + For developers who want to add FLAC support to their programs: <ul> - <li>Copy <span class="commandname">flac.exe</span> and <span class="commandname">flac_ren.exe</span> to the <span class="code">External/</span> directory of the Monkey's Audio installation.</li> - <li> - Choose a supported encoder to replace: - <ul> - <li>Shorten - copy <span class="commandname">flac_mac.exe</span> on top of <span class="commandname">External/shortn32.exe</span></li> - <li>WavPack - copy <span class="commandname">flac_mac.exe</span> on top of both <span class="commandname">External/wavpack.exe</span> and <span class="commandname">External/wvunpack.exe</span></li> - <li>RKAU - copy <span class="commandname">flac_mac.exe</span> on top of <span class="commandname">External/rkau.exe</span></li> - </ul> - If you choose WavPack you will also be able to use the WavPack Configuration menu to add flac options. - </li> - <li>Now you can encode FLAC files as if you were using the replaced encoder. The renamed <span class="commandname">flac_mac.exe</span> utility will call <span class="commandname">flac.exe</span> and afterwards, <span class="commandname">flac_ren.exe</span> will rename the resulting file to have the .flac extension.</li> + <li><a href="documentation_format_overview.html">About the FLAC Format</a> - An overview of the FLAC format for power users.</li> + <li><a href="format.html">FLAC Format Specification</a> - The formal specification.</li> + <li><a href="ogg_mapping.html">Ogg FLAC Mapping</a> - How FLAC should be embedded in an Ogg container.</li> + <li><a href="api/index.html">libFLAC and libFLAC++ APIs</a> - Complete library documentation.</li> + <li><a href="license.html">License</a> - The license under which the official tools are distributed.</li> + <li>(see also the <a href="developer.html">developer page</a>)</li> </ul> - Other front-ends may be wedged in the same way; if you have one in mind, post it to the <a href="http://lists.xiph.org/mailman/listinfo/flac-dev">flac-dev</a> mailing list. + Keep in mind that the online version of the documentation will always apply to the latest release. For older releases, check the documentation included with the release package. </div> <div class="box_footer"></div> </div> diff --git a/doc/html/documentation_bugs.html b/doc/html/documentation_bugs.html new file mode 100644 index 00000000..516350e5 --- /dev/null +++ b/doc/html/documentation_bugs.html @@ -0,0 +1,107 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006 Josh Coalson --> +<!-- Permission is granted to copy, distribute and/or modify this document --> +<!-- under the terms of the GNU Free Documentation License, Version 1.1 --> +<!-- or any later version published by the Free Software Foundation; --> +<!-- with no invariant sections. --> +<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html --> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> + <meta name="author" content="Josh Coalson" /> + <meta name="description" content="A free, open source codec for lossless audio compression and decompression" /> + <meta name="keywords" content="free,lossless,audio,codec,encoder,decoder,compression,compressor,archival,archive,archiving,backup,music" /> + <link rel="shortcut icon" type="image/x-icon" href="favicon.ico" /> + <link rel="stylesheet" type="text/css" href="flac.css" /> + <title>FLAC - documentation</title> +</head> + +<body> + +<div class="logo"> + <a href="http://flac.sourceforge.net/"><img src="images/logo130.gif" alt="FLAC Logo" align="middle" border="0" hspace="0" /></a> +</div> + +<div class="above_nav"></div> + +<div class="navbar"> + <a href="index.html">home</a> | + <a href="faq.html">faq</a> | + <a href="news.html">news</a> | + <a href="download.html">download</a> | + <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | + <a href="changelog.html">changelog</a> | + <a href="links.html">links</a> | + <a href="developers.html">developers</a> +</div> + +<div class="langbar"> + english | + <a href="ru/documentation.html">russian</a> +</div> + +<div class="below_nav"></div> + +<div class="box"> + <div class="box_title"> + <a name="bugs">known bugs</a> + </div> + <div class="box_header"></div> + <div class="box_body"> + The following are major known bugs in the current (1.1.3) release: + <ul> + <li> + If your locale does not use "." for the decimal point, there is a bug that causes the default compression settings to be sub-optimal. You should add <span class="argument">-A "tukey(0,5)"</span> to your <span class="command">flac</span> command string (or however "0.5" should be formatted for your locale). + </li> + <li> + If a corrupted FLAC file is used as input in FLAC-to-FLAC encoding, the transcoded FLAC file will have the audio data truncated after the first error. + </li> + <li> + When encoding to Ogg FLAC, if there are too many seek points (>240), the seek table will not have the offsets written back properly after encoding. + </li> + </ul> + </div> + <div class="box_footer"></div> +</div> + +<br /> + +<div class="box"> + <div class="box_title"> + <a name="bug_reporting">reporting bugs</a> + </div> + <div class="box_header"></div> + <div class="box_body"> + To report a bug, please go to the <a href="http://sourceforge.net/tracker/?group_id=13478&atid=113478">FLAC bug tracker</a> (or appropriately the <a href="http://sourceforge.net/tracker/?group_id=13478&atid=363478">feature request tracker</a>, <a href="http://sourceforge.net/tracker/?group_id=13478&atid=313478">patch page</a>, or <a href="http://sourceforge.net/tracker/?group_id=13478&atid=213478">support page</a>).<br /> + <br /> + First check that there is not already an existing request. If you do submit a new request, make sure and provide an email contact <b>and</b> use the Monitor feature.<br /> + <br /> + Note that we get many false bug reports from people with faulty hardware or who overclock their machines that FLAC is not working. Please do due diligence if you are getting FLAC encoding or decoding errors that it is not the fault of the hardware. FLAC encoding tends to highlight problems with bad RAM, corrupted files, and excessive overclocking. + </div> + <div class="box_footer"></div> +</div> + + +<div class="copyright"> + <!-- @@@ oh so hacky --> + <table> + <tr> + <td align="left"> + Copyright (c) 2000,2001,2002,2003,2004,2005,2006 Josh Coalson + </td> + <td width="1%" align="right"> + <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a> + </td> + <td width="1%" align="right"> + <a href="http://www.eff.org/cafe/"><img src="images/cafebug.gif" alt="CAFE Logo" border="0" /></a><br /> + </td> + <td width="1%" align="right"> + <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" border="0" hspace="0" /></a> + </td> + </tr> + </table> +</div> + +</body> +</html> diff --git a/doc/html/documentation_format_overview.html b/doc/html/documentation_format_overview.html new file mode 100644 index 00000000..f8e000d6 --- /dev/null +++ b/doc/html/documentation_format_overview.html @@ -0,0 +1,130 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006 Josh Coalson --> +<!-- Permission is granted to copy, distribute and/or modify this document --> +<!-- under the terms of the GNU Free Documentation License, Version 1.1 --> +<!-- or any later version published by the Free Software Foundation; --> +<!-- with no invariant sections. --> +<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html --> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> + <meta name="author" content="Josh Coalson" /> + <meta name="description" content="A free, open source codec for lossless audio compression and decompression" /> + <meta name="keywords" content="free,lossless,audio,codec,encoder,decoder,compression,compressor,archival,archive,archiving,backup,music" /> + <link rel="shortcut icon" type="image/x-icon" href="favicon.ico" /> + <link rel="stylesheet" type="text/css" href="flac.css" /> + <title>FLAC - documentation</title> +</head> + +<body> + +<div class="logo"> + <a href="http://flac.sourceforge.net/"><img src="images/logo130.gif" alt="FLAC Logo" align="middle" border="0" hspace="0" /></a> +</div> + +<div class="above_nav"></div> + +<div class="navbar"> + <a href="index.html">home</a> | + <a href="faq.html">faq</a> | + <a href="news.html">news</a> | + <a href="download.html">download</a> | + <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | + <a href="changelog.html">changelog</a> | + <a href="links.html">links</a> | + <a href="developers.html">developers</a> +</div> + +<div class="langbar"> + english | + <a href="ru/documentation.html">russian</a> +</div> + +<div class="below_nav"></div> + +<div class="box"> + <div class="box_title"> + <a name="format">format</a> + </div> + <div class="box_header"></div> + <div class="box_body"> + The basic structure of a FLAC stream is: + <ul> + <li>The four byte string "<span class="code">fLaC</span>"</li> + <li>The <a href="format.html#def_STREAMINFO"><span class="code">STREAMINFO</span></a> metadata block</li> + <li>Zero or more other metadata blocks</li> + <li>One or more audio frames</li> + </ul> + 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.<br /> + <br /> + <b>METADATA</b><br /> + <br /> + 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 <span class="code">STREAMINFO</span> 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 <span class="code">STREAMINFO</span> block is the MD5 signature of the <i>unencoded</i> audio data. This is useful for checking an entire stream for transmission errors.<br /> + <br /> + Other blocks allow for padding, seek tables, tags, cuesheets, and application-specific data. There are <a href="documentation_tools_flac.html"><span class="commandname">flac</span> options</a> for adding <span class="code">PADDING</span> 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.<br /> + <br /> + 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 <span class="code">PADDING</span> block of the correct size when encoding, and overwrite the padding block with your <span class="code">APPLICATION</span> 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.<br /> + <br /> + <b>AUDIO DATA</b><br /> + <br /> + 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.<br /> + <br /> + <b>BLOCKING</b><br /> + <br /> + 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. <span class="commandname">flac</span> 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.<br /> + <br /> + <b>INTER-CHANNEL DECORRELATION</b><br /> + <br /> + 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. <span class="commandname">flac</span> has two options for this: <span class="argument">-m</span> always compresses both the left-right and mid-side versions of the block and takes the smallest frame, and <span class="argument">-M</span>, which adaptively switches between left-right and mid-side.<br /> + <br /> + <b>MODELING</b><br /> + <br /> + 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.<br /> + <br /> + First, fixed polynomial prediction (specified with <span class="argument">-l 0</span>) 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 (usually 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 <span class="argument">-e</span> to overcome this, which is significantly slower.<br /> + <br /> + 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.<br /> + <br /> + <b>RESIDUAL CODING</b><br /> + <br /> + 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.<br /> + <br /> + 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. <span class="commandname">flac</span> allows you to specify how the partitioning is done with the <span class="argument">-r</span> option. The residual can be broken into 2^<i>n</i> partitions, by using the option <span class="argument">-r n,n</span>. 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 <span class="argument">-r m,n</span>. 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.<br /> + <br /> + <b>FRAMING</b><br /> + <br /> + 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.<br /> + <br /> + <b>MISCELLANEOUS</b><br /> + <br /> + As a convenience, the reference decoder knows how to skip <a href="http://www.id3.org/">ID3v1 and ID3v2 tags</a>. Note however that the FLAC specification does not require compliant implementations to support ID3 in any form and their use is strongly discouraged.<br /> + <br /> + <span class="commandname">flac</span> has a verify option <span class="argument">-V</span> 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 <span class="commandname">flac</span> will stop with an error. + </div> + <div class="box_footer"></div> +</div> + + +<div class="copyright"> + <!-- @@@ oh so hacky --> + <table> + <tr> + <td align="left"> + Copyright (c) 2000,2001,2002,2003,2004,2005,2006 Josh Coalson + </td> + <td width="1%" align="right"> + <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a> + </td> + <td width="1%" align="right"> + <a href="http://www.eff.org/cafe/"><img src="images/cafebug.gif" alt="CAFE Logo" border="0" /></a><br /> + </td> + <td width="1%" align="right"> + <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" border="0" hspace="0" /></a> + </td> + </tr> + </table> +</div> + +</body> +</html> diff --git a/doc/html/documentation_tasks.html b/doc/html/documentation_tasks.html new file mode 100644 index 00000000..bc8d8fbe --- /dev/null +++ b/doc/html/documentation_tasks.html @@ -0,0 +1,222 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006 Josh Coalson --> +<!-- Permission is granted to copy, distribute and/or modify this document --> +<!-- under the terms of the GNU Free Documentation License, Version 1.1 --> +<!-- or any later version published by the Free Software Foundation; --> +<!-- with no invariant sections. --> +<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html --> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> + <meta name="author" content="Josh Coalson" /> + <meta name="description" content="A free, open source codec for lossless audio compression and decompression" /> + <meta name="keywords" content="free,lossless,audio,codec,encoder,decoder,compression,compressor,archival,archive,archiving,backup,music" /> + <link rel="shortcut icon" type="image/x-icon" href="favicon.ico" /> + <link rel="stylesheet" type="text/css" href="flac.css" /> + <title>FLAC - documentation</title> +</head> + +<body> + +<div class="logo"> + <a href="http://flac.sourceforge.net/"><img src="images/logo130.gif" alt="FLAC Logo" align="middle" border="0" hspace="0" /></a> +</div> + +<div class="above_nav"></div> + +<div class="navbar"> + <a href="index.html">home</a> | + <a href="faq.html">faq</a> | + <a href="news.html">news</a> | + <a href="download.html">download</a> | + <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | + <a href="changelog.html">changelog</a> | + <a href="links.html">links</a> | + <a href="developers.html">developers</a> +</div> + +<div class="langbar"> + english | + <a href="ru/documentation.html">russian</a> +</div> + +<div class="below_nav"></div> + +<div class="box"> + <div class="box_title"> + using flac + </div> + <div class="box_header"></div> + <div class="box_body"> + Since FLAC is supported by so many different programs, it can be a daunting task for the new user to choose a suitable program. This page will walk you through the steps. First, choose your operating system: + <ul> + <li><a href="#windows">Windows</a></li> + <li><a href="#osx">Mac OS X</a></li> + <li><a href="#unix">Linux, *BSD, and other Unixes</a></li> + </ul> + </div> + <div class="box_footer"></div> +</div> + +<br /> + +<div class="box"> + <div class="box_title"> + <a name="windows">windows</a> + </div> + <div class="box_header"></div> + <div class="box_body"> + <br /> + <b>Using iTunes</b>? Sorry, due to iTunes' design we can't add FLAC support; <a href="itunes.html">ask Apple to support FLAC!</a><br /> + <br /> + <b>If you want to play FLAC files</b>, here is how with some popular players: + <ul> + <li><b>Windows Media Player (WMP)</b> - Microsoft does not make it easy, but it is possible if you follow this guide: <a href="http://www.losslessaudioblog.com/wmpmce-lossless-guide/">How to add FLAC support to Windows Media Player</a></li> + <li><a href="http://winamp.com/"><b>Winamp</b></a> - Winamp plays FLAC out of the box since version 5.31 if you download the Full version (not Lite).</li> + <li><a href="http://dbpoweramp.com/dbpoweramp.htm"><b>dbPowerAMP Audio Player</b></a> - Install the <a href="http://www.dbpoweramp.com/codec-central-flac.htm">FLAC plugin</a>.</li> + <li><a href="http://www.jrmediacenter.com/"><b>Media Center</b></a>/<a href="http://www.mediajukebox.com/"><b>Media Jukebox</b></a> - Install the <a href="http://mcplugins.sourceforge.net/in_flac.html">in_FLAC plugin</a>.</li> + <li><a href="http://mediamonkey.com/"><b>MediaMonkey</b></a> - Plays FLAC out of the box.</li> + <li>(<a href="download.html#extras_players_windows">more</a>)</li> + </ul> + <b>If you want to rip CDs to FLAC</b>, here is a short list of the most popular programs. Experts generally prefer EAC for the most accurate ripping. dbPowerAMP also does a fine job and is easier to set up. + <ul> + <li><b>Windows Media Player (WMP)</b> - Sorry, Microsoft has made it impossible to rip to FLAC in WMP; hopefully this will change eventually.</li> + <li><a href="http://winamp.com/"><b>Winamp</b></a> - Winamp can rip to FLAC out of the box since version 5.31 if you download the Full version (not Lite).</li> + <li><a href="http://dbpoweramp.com/dmc.htm"><b>dbPowerAMP Music Converter</b></a> - Install the <a href="http://www.dbpoweramp.com/codec-central-flac.htm">FLAC plugin</a>.</li> + <li><a href="http://www.jrmediacenter.com/"><b>Media Center</b></a>/<a href="http://www.mediajukebox.com/"><b>Media Jukebox</b></a> - Install the <a href="http://mcplugins.sourceforge.net/enc_flac.html">Enc_FLAC plugin</a>.</li> + <li><a href="http://www.exactaudiocopy.de/"><b>Exact Audio Copy (EAC)</b></a> - First <a href="http://cyberial.com/flacinstaller.asp">install the official FLAC tools</a>, then follow <a href="http://wiki.hydrogenaudio.org/index.php?title=EAC_and_Flac">this guide</a>. EAC is notoriously complex so here are some other guides: <a href="http://www.hydrogenaudio.org/forums/index.php?showtopic=30959">guide</a> <a href="http://wiki.slimdevices.com/index.cgi?EACBeginners">guide</a> <a href="http://www.saunalahti.fi/cse/EAC/index.html">guide</a> <a href="http://www.teqnilogik.com/tutorials/eac.htm">guide</a>. EAC can also be set up with <a href="http://www.legroom.net/modules.php?op=modload&name=Open_Source&file=index&page=software&app=autoflac">AutoFLAC</a>, <a href="http://omniencoder.autobotcity.net/">Omni Encoder</a>, or <a href="http://mareo.netfirms.com/">MAREO</a> to rip to FLAC or multiple formats at once.</li> + <li><a href="http://cdexos.sourceforge.net/"><b>CDex</b></a> - First <a href="http://cyberial.com/flacinstaller.asp">install the official FLAC tools</a>, then follow <a href="http://www.pfarrell.com/music/slimserver/cdextip.html">this guide</a>.</li> + <li>(<a href="download.html#extras_gui_windows">more</a>)</li> + </ul> + <b>If you want to burn FLAC files to CD</b>, here is a short list of the most popular programs: + <ul> + <li><b>Windows Media Player (WMP)</b> - Sorry, Microsoft has made it impossible to burn FLAC to CD in WMP; hopefully this will change eventually.</li> + <!-- works? + <li><a href="http://winamp.com/"><b>Winamp</b></a> - Winamp can rip to FLAC out of the box since version 5.31 if you download the Full version (not Lite).</li> + --> + <li><a href="http://dbpoweramp.com/cdwriter.htm"><b>dbPowerAMP CD Writer</b></a> - Install the <a href="http://www.dbpoweramp.com/codec-central-flac.htm">FLAC plugin</a>.</li> + <li><a href="http://www.burrrn.net/?page_id=4">Burrrn</a> - Supports burning from FLAC out of the box.</li> + <li>(<a href="download.html#extras_burning_windows">more</a>)</li> + </ul> + <b>If you want to convert audio files to/from FLAC</b>, there are quite a few programs: + <ul> + <!-- + <li><b>Windows Media Player (WMP)</b> - Sorry, Microsoft has made it impossible to burn FLAC to CD in WMP; hopefully this will change eventually.</li> + --> + <li><a href="http://winamp.com/"><b>Winamp</b></a> - Winamp can convert to/from FLAC out of the box since version 5.31 if you download the Full version (not Lite).</li> + <li><a href="http://dbpoweramp.com/dmc.htm"><b>dbPowerAMP Music Converter</b></a> - Install the <a href="http://www.dbpoweramp.com/codec-central-flac.htm">FLAC plugin</a>.</li> + <li>FLAC Frontend - A simple GUI that comes in our <a href="http://cyberial.com/flacinstaller.asp">FLAC Installer</a> for Windows. Also includes <a href="documentation_tools.html">command-line programs</a> for converting FLAC files and editing metadata.</li> + <li><a href="http://foobar2000.org/">foobar2000</a> - A swiss army knife that supports FLAC out of the box.</li> + <li><a href="http://mediamonkey.com/"><b>MediaMonkey</b></a></li> + <li>(<a href="download.html#extras_gui_windows">more</a>)</li> + </ul> + </div> + <div class="box_footer"></div> +</div> + +<br /> + +<div class="box"> + <div class="box_title"> + <a name="osx">mac os x</a> + </div> + <div class="box_header"></div> + <div class="box_body"> + <br /> + <b>Using iTunes</b>? Sorry, due to iTunes' design we can't add FLAC support; <a href="itunes.html">ask Apple to support FLAC!</a><br /> + <br /> + <b>If you want to play FLAC files</b>, here is how with some popular players: + <ul> + <li><a href="http://cogosx.sourceforge.net/">Cog</a></li> + <li><a href="http://arcticlounge.com/maltx/">MacAmp Lite X</a></li> + <li><a href="http://www.songbirdnest.com/">Songbird</a></li> + <li><a href="http://www.videolan.org/vlc/index.html">VLC</a></li> + <li>(<a href="download.html#extras_players_osx">more</a>)</li> + </ul> + <b>If you want to rip CDs to FLAC</b>, there are a few options: + <ul> + <li>Roxio's <a href="http://www.roxio.com/en/products/toast/index.jhtml">Toast 7 Titanium</a>.</li> + <li><a href="http://sbooth.org/Max/">Max</a>.</li> + </ul> + <b>If you want to burn FLAC files to CD</b>: + <ul> + <li>Roxio's <a href="http://www.roxio.com/en/products/toast/index.jhtml">Toast 7 Titanium</a>.</li> + </ul> + <b>If you want to convert audio files to/from FLAC</b>: + <ul> + <li>Roxio's <a href="http://www.roxio.com/en/products/toast/index.jhtml">Toast 7 Titanium</a>.</li> + <li><a href="http://mac.softpedia.com/get/Audio/MacFLAC.shtml">MacFLAC</a>. Also includes <a href="documentation_tools.html">command-line programs</a> for converting FLAC files and editing metadata.</li> + <li><a href="http://www.chaoticsoftware.com/ProductPages/MediaRage.html">MediaRage</a> can edit FLAC tags.</li> + </ul> + </div> + <div class="box_footer"></div> +</div> + +<br /> + +<div class="box"> + <div class="box_title"> + <a name="unix">*nix</a> + </div> + <div class="box_header"></div> + <div class="box_body"> + In the Unix world, FLAC support is quite widespread and it's usually only a matter of installing packages, so here are a few pointers. See the <a href="links.html#software">software links section</a> for many more.<br /> + <br /> + <b>To play FLAC files</b>: + <ul> + <li><a href="http://alsaplayer.org/">AlsaPlayer</a></li> + <li><a href="http://www.giantdisc.org/">GiantDisc</a>: Linux jukebox + Palm remote</li> + <li><a href="http://www.mplayerhq.hu/">MPlayer</a></li> + <li><a href="http://muine.gooeylinux.org/">Muine</a>: a music player for GNOME</li> + <li><a href="http://musik.berlios.de/">Musik</a>: an open-source, cross-platform multimedia player and library</li> + <li><a href="http://www.videolan.org/">VideoLAN</a> client</li> + <li><a href="http://xine.sourceforge.net/">Xine</a> multimedia player</li> + <li><a href="http://www.amb.org/xmcd/">xmcd</a>: X CD player</li> + <li><a href="http://www.xmms.org/">XMMS</a>: X MultiMedia System</li> + <li>(<a href="links.html#software">more</a>)</li> + </ul> + <b>To rip CDs to FLAC</b>: + <ul> + <li><a href="http://www.nostatic.org/grip/">Grip</a> is a great ripping and encoding front end and can be easily configured to use flac. See <a href="http://sourceforge.net/mailarchive/forum.php?thread_id=1634089&forum_id=5443">this message</a> on how to configure Grip for FLAC.</li> + <li><a href="http://www.amb.org/xmcd/">xmcd</a> is a CD ripper with CDDB support as well as a player.</li> + <li>(<a href="links.html#software">more</a>)</li> + </ul> + <b>To burn FLAC files to CD</b>, here is a short list of the most popular programs: + <ul> + <li><a href="http://arson.sourceforge.net/">Arson</a>: KDE ripper/burner</li> + <li><a href="http://www.k3b.org/">K3B</a>: CD/DVD creator for Linux</li> + <li>(<a href="links.html#software">more</a>)</li> + </ul> + <b>To convert audio files to/from FLAC</b>, there are quite a few programs: + <ul> + <li>Official <a href="download.html">FLAC tools</a> have the command-line programs.</li> + <li>(<a href="links.html#software">more</a>)</li> + </ul> + </div> + <div class="box_footer"></div> +</div> + + +<div class="copyright"> + <!-- @@@ oh so hacky --> + <table> + <tr> + <td align="left"> + Copyright (c) 2006 Josh Coalson + </td> + <td width="1%" align="right"> + <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a> + </td> + <td width="1%" align="right"> + <a href="http://www.eff.org/cafe/"><img src="images/cafebug.gif" alt="CAFE Logo" border="0" /></a><br /> + </td> + <td width="1%" align="right"> + <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" border="0" hspace="0" /></a> + </td> + </tr> + </table> +</div> + +</body> +</html> diff --git a/doc/html/documentation_tools.html b/doc/html/documentation_tools.html new file mode 100644 index 00000000..bdedb673 --- /dev/null +++ b/doc/html/documentation_tools.html @@ -0,0 +1,92 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006 Josh Coalson --> +<!-- Permission is granted to copy, distribute and/or modify this document --> +<!-- under the terms of the GNU Free Documentation License, Version 1.1 --> +<!-- or any later version published by the Free Software Foundation; --> +<!-- with no invariant sections. --> +<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html --> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> + <meta name="author" content="Josh Coalson" /> + <meta name="description" content="A free, open source codec for lossless audio compression and decompression" /> + <meta name="keywords" content="free,lossless,audio,codec,encoder,decoder,compression,compressor,archival,archive,archiving,backup,music" /> + <link rel="shortcut icon" type="image/x-icon" href="favicon.ico" /> + <link rel="stylesheet" type="text/css" href="flac.css" /> + <title>FLAC - documentation</title> +</head> + +<body> + +<div class="logo"> + <a href="http://flac.sourceforge.net/"><img src="images/logo130.gif" alt="FLAC Logo" align="middle" border="0" hspace="0" /></a> +</div> + +<div class="above_nav"></div> + +<div class="navbar"> + <a href="index.html">home</a> | + <a href="faq.html">faq</a> | + <a href="news.html">news</a> | + <a href="download.html">download</a> | + <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | + <a href="changelog.html">changelog</a> | + <a href="links.html">links</a> | + <a href="developers.html">developers</a> +</div> + +<div class="langbar"> + english | + <a href="ru/documentation.html">russian</a> +</div> + +<div class="below_nav"></div> + +<div class="box"> + <div class="box_title"> + tools + </div> + <div class="box_header"></div> + <div class="box_body"> + FLAC is a general purpose audio format supported by many programs, but in this section we are concentrating on just the official tools provided by the FLAC project: + <ul> + <li><a href="documentation_tools_flac.html">flac</a> - The command-line encoder and decoder.</li> + <li><a href="documentation_tools_metaflac.html">metaflac</a> - The command-line metadata editor.</li> + <li><a href="documentation_tools_plugins.html">plugins</a> - Setting up the Winamp and XMMS plugins.</li> + </ul> + Other resources: + <ul> + <li><a href="documentation_bugs.html">Bugs</a> - How to report bugs and request features, and a list of known bugs in the FLAC tools.</li> + <li><a href="http://sourceforge.net/tracker/?group_id=13478&atid=213478">Request Support</a> - Support for the official FLAC tools. For other programs, use <a href="http://www.hydrogenaudio.org/">hydrogenaudio.org</a> + <li><a href="http://lists.xiph.org/mailman/listinfo/flac">FLAC Mailing List</a> - General discussion about FLAC, tools, releases, etc.</li> + </ul> + <br /> + See <a href="download.html">Getting FLAC</a> for instructions on downloading and installing the official FLAC tools, or <a href="documentation_tasks.html">Using FLAC</a> for instructions and guides on playing FLAC files, ripping CDs to FLAC, etc. + </div> + <div class="box_footer"></div> +</div> + + +<div class="copyright"> + <!-- @@@ oh so hacky --> + <table> + <tr> + <td align="left"> + Copyright (c) 2006 Josh Coalson + </td> + <td width="1%" align="right"> + <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a> + </td> + <td width="1%" align="right"> + <a href="http://www.eff.org/cafe/"><img src="images/cafebug.gif" alt="CAFE Logo" border="0" /></a><br /> + </td> + <td width="1%" align="right"> + <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" border="0" hspace="0" /></a> + </td> + </tr> + </table> +</div> + +</body> +</html> diff --git a/doc/html/documentation_tools_flac.html b/doc/html/documentation_tools_flac.html new file mode 100644 index 00000000..b23ba11d --- /dev/null +++ b/doc/html/documentation_tools_flac.html @@ -0,0 +1,1039 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006 Josh Coalson --> +<!-- Permission is granted to copy, distribute and/or modify this document --> +<!-- under the terms of the GNU Free Documentation License, Version 1.1 --> +<!-- or any later version published by the Free Software Foundation; --> +<!-- with no invariant sections. --> +<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html --> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> + <meta name="author" content="Josh Coalson" /> + <meta name="description" content="A free, open source codec for lossless audio compression and decompression" /> + <meta name="keywords" content="free,lossless,audio,codec,encoder,decoder,compression,compressor,archival,archive,archiving,backup,music" /> + <link rel="shortcut icon" type="image/x-icon" href="favicon.ico" /> + <link rel="stylesheet" type="text/css" href="flac.css" /> + <title>FLAC - documentation</title> +</head> + +<body> + +<div class="logo"> + <a href="http://flac.sourceforge.net/"><img src="images/logo130.gif" alt="FLAC Logo" align="middle" border="0" hspace="0" /></a> +</div> + +<div class="above_nav"></div> + +<div class="navbar"> + <a href="index.html">home</a> | + <a href="faq.html">faq</a> | + <a href="news.html">news</a> | + <a href="download.html">download</a> | + <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | + <a href="changelog.html">changelog</a> | + <a href="links.html">links</a> | + <a href="developers.html">developers</a> +</div> + +<div class="langbar"> + english | + <a href="ru/documentation.html">russian</a> +</div> + +<div class="below_nav"></div> + +<div class="box"> + <div class="box_title"> + <a name="flac">flac</a> + </div> + <div class="box_header"></div> + <div class="box_body"> + <a name="toc"><font size="+1"><b><u>Table of Contents</u></b></font></a> + <ul> + <li><a href="#usage">General Usage</a></li> + <li><a href="#general_options">General Options</a></li> + <li><a href="#analysis_options">Analysis Options</a></li> + <li><a href="#decoding_options">Decoding Options</a></li> + <li><a href="#encoding_options">Encoding Options</a></li> + <li><a href="#format_options">Format Options</a></li> + <li><a href="#negative_options">Negative Options</a></li> + <li><a href="#option_index">Option Index</a></li> + </ul> + <a name="usage"><font size="+1"><b><u>General Usage</u></b></font></a><br /> + <br /> + <span class="commandname">flac</span> is the command-line file encoder/decoder. The encoder currently supports as input RIFF WAVE, AIFF, FLAC or Ogg FLAC format, or raw interleaved samples. The decoder currently can output to RIFF WAVE or AIFF format, or raw interleaved samples. <span class="commandname">flac</span> only supports linear PCM samples (in other words, no A-LAW, uLAW, etc.), and the input must be between 4 and 24 bits per sample. This is not a limitation of the FLAC format, just the reference encoder/decoder.<br /> + <br /> + <span class="commandname">flac</span> assumes that files ending in ".wav" or that have the RIFF WAVE header present are WAVE files, files ending in ".aif" or ".aiff" or have the AIFF header present are AIFF files, and files ending in ".flac" or have the FLAC header present are FLAC files. This assumption may be overridden with a command-line option. It also assumes that files ending in ".ogg" of have the Ogg FLAC header present are Ogg FLAC files. Other than this, <span class="commandname">flac</span> makes no assumptions about file extensions, though the convention is that FLAC files have the extension ".flac" (or ".fla" on ancient "8.3" file systems like FAT-16).<br /> + <br /> + Before going into the full command-line description, a few other things help to sort it out: 1) <span class="commandname">flac</span> encodes by default, so you must use <b>-d</b> to decode; 2) the options <span class="argument">-0</span> .. <span class="argument">-8</span> (or <span class="argument">--fast</span> and <span class="argument">--best</span>) 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) <span class="commandname">flac</span> behaves similarly to gzip in the way it handles input and output files.<br /> + <br /> + <span class="commandname">flac</span> will be invoked one of four ways, depending on whether you are encoding, decoding, testing, or analyzing: + <ul> + <li> + Encoding: flac [<i><a href="#general_options"><general-options></a></i>] [<i><a href="#format_options"><format-options></a></i>] [<i><a href="#encoding_options"><encoding options></a></i>] [inputfile [...]] + </li> + <li> + Decoding: flac -d [<i><a href="#general_options"><general-options></a></i>] [<i><a href="#format_options"><format-options></a></i>] [<i><a href="#decoding_options"><decoding options></a></i>] [FLACfile [...]] + </li> + <li> + Testing: flac -t [<i><a href="#general_options"><general-options></a></i>] [FLACfile [...]] + </li> + <li> + Analyzing: flac -a [<i><a href="#general_options"><general-options></a></i>] [<i><a href="#analysis_options"><analysis-options></a></i>] [FLACfile [...]] + </li> + </ul> + In any case, if no <span class="argument">inputfile</span> is specified, stdin is assumed. If only one inputfile is specified, it may be "-" for stdin. When stdin is used as input, <span class="commandname">flac</span> will write to stdout. Otherwise <span class="commandname">flac</span> 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.<br /> + <br /> + If you are encoding/decoding from stdin to a file, you should use the -o option like so: + <ul> + <li> + flac [options] -o outputfile + </li> + <li> + flac -d [options] -o outputfile + </li> + </ul> + which are better than: + <ul> + <li> + flac [options] > outputfile + </li> + <li> + flac -d [options] > outputfile + </li> + </ul> + since the former allows flac to seek backwards to write the <span class="code">STREAMINFO</span> or RIFF WAVE header contents when necessary.<br /> + <br /> + Also, you can force output data to go to stdout using <span class="argument">-c</span>.<br /> + <br /> + To encode or decode files that start with a dash, use <span class="argument">--</span> to signal the end of options, to keep the filenames themselves from being treated as options: + <ul> + <li> + <span class="code">flac -V -- -01-filename.wav</span> + </li> + </ul> + The encoding options affect the compression ratio and encoding speed. The format options are used to tell <span class="commandname">flac</span> the arrangement of samples if the input file (or output file when decoding) is a raw file. If it is a RIFF WAVE or AIFF file the format options are not needed since they are read from the AIFF/WAVE header.<br /> + <br /> + In test mode, <span class="commandname">flac</span> 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.<br /> + <br /> + <span class="commandname">flac</span> can also re-encode FLAC files. In other words, you can specify a FLAC or Ogg FLAC file as an input to the encoder and it will decoder it and re-encode it according to the options you specify. It will also preserve all the metadata unless you override it with other options (e.g. specifying new tags, seekpoints, cuesheet, padding, etc.).<br /> + <br /> + <span class="commandname">flac</span> has been tuned so that the default settings 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, see <a href="documentation_format_overview.html">About the FLAC Format</a>.<br /> + <br /> + + <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> + <table width="100%" border="1" bgcolor="#EEEED4"> + <tr> + <td colspan="2" bgcolor="#D3D4C5"> + <a name="general_options"><font size="+1"><b>General Options</b></font></a> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_version" /> + <span class="argument">-v</span>, <span class="argument">--version</span> + </td> + <td> + Show the <span class="commandname">flac</span> version number. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_help" /> + <span class="argument">-h</span>, <span class="argument">--help</span> + </td> + <td> + Show basic usage and a list of all options. Running <span class="commandname">flac</span> without arguments shows the short help screen by default. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_explain" /> + <span class="argument">-H</span>, <span class="argument">--explain</span> + </td> + <td> + Show detailed explanation of usage and all options. Running <span class="commandname">flac</span> without arguments shows the short help screen by default. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_decode" /> + <span class="argument">-d</span>, <span class="argument">--decode</span> + </td> + <td> + Decode (<span class="commandname">flac</span> encodes by default). <span class="commandname">flac</span> will exit with an exit code of <span class="argument">1</span> (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 <span class="argument">0</span>. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_test" /> + <span class="argument">-t</span>, <span class="argument">--test</span> + </td> + <td> + Test (same as <span class="argument">-d</span> except no decoded file is written). The exit codes are the same as in decode mode. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_analyze" /> + <span class="argument">-a</span>, <span class="argument">--analyze</span> + </td> + <td> + Analyze (same as <span class="argument">-d</span> 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. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_stdout" /> + <span class="argument">-c</span>, <span class="argument">--stdout</span> + </td> + <td> + Write output to stdout. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_silent" /> + <span class="argument">-s</span>, <span class="argument">--silent</span> + </td> + <td> + Silent: do not show encoding/decoding statistics. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_totally_silent" /> + <span class="argument">--totally-silent</span> + </td> + <td> + Do not print anything of any kind, including warnings or errors. The exit code will be the only way to determine successful completion. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_force" /> + <span class="argument">-f</span>, <span class="argument">--force</span> + </td> + <td> + Force overwriting of output files. By default, <span class="commandname">flac</span> warns that the output file already exists and continues to the next file. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_output_name" /> + <span class="argument">-o filename</span>,<br /><span class="argument">--output-name=filename</span> + </td> + <td> + Force the output file name (usually <span class="commandname">flac</span> just changes the extension). May only be used when encoding a single file. May not be used in conjunction with <a href="#flac_options_output_prefix"><span class="argument">--output-prefix</span></a>. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_output_prefix" /> + <span class="argument">--output-prefix=string</span> + </td> + <td> + Prefix each output file name with the given string. This can be useful for encoding/decoding files to a different directory. Make sure if your string is a path name that it ends with a trailing '<span class="argument">/</span>' slash. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_delete_input_file" /> + <span class="argument">--delete-input-file</span> + </td> + <td> + 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. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_skip" /> + <span class="argument">--skip={#|mm:ss.ss}</span> + </td> + <td> + Skip over the first # of samples of the input. This works for both encoding and decoding, but not testing. The alternative form <span class="argument">mm:ss.ss</span> can be used to specify minutes, seconds, and fractions of a second.<br /> + <br /> + Examples:<br /> + <br /> + <span class="argument">--skip=123</span> : skip the first 123 samples of the input<br /> + <span class="argument">--skip=1:23.45</span> : skip the first 1 minute and 23.45 seconds of the input + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_until" /> + <span class="argument">--until={#|[+|-]mm:ss.ss}</span> + </td> + <td> + Stop at the given sample number for each input file. This works for both encoding and decoding, but not testing. The given sample number is not included in the decoded output. The alternative form <span class="argument">mm:ss.ss</span> can be used to specify minutes, seconds, and fractions of a second. If a <span class="argument">+</span> sign is at the beginning, the <span class="argument">--until</span> point is relative to the <span class="argument">--skip</span> point. If a <span class="argument">-</span> sign is at the beginning, the <span class="argument">--until</span> point is relative to end of the audio.<br /> + <br /> + Examples:<br /> + <br /> + <span class="argument">--until=123</span> : decode only the first 123 samples of the input (samples 0-122, stopping at 123)<br /> + <span class="argument">--until=1:23.45</span> : decode only the first 1 minute and 23.45 seconds of the input<br /> + <span class="argument">--skip=1:00 --until=+1:23.45</span> : decode 1:00.00 to 2:23.45<br /> + <span class="argument">--until=-1:23.45</span> : decode everything except the last 1 minute and 23.45 seconds<br /> + <span class="argument">--until=-0:00</span> : decode until the end of the input (the same as not specifying <span class="argument">--until</span>) + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_ogg" /> + <span class="argument">--ogg</span> + </td> + <td> + When encoding, generate Ogg FLAC output instead of native FLAC. Ogg FLAC streams are FLAC streams wrapped in an Ogg transport layer. The resulting file should have an '.ogg' extension and will still be decodable by <span class="commandname">flac</span>.<br /> + <br /> + When decoding, force the input to be treated as Ogg FLAC. This is useful when piping input from stdin or when the filename does not end in '.ogg'.<br /> + <br /> + <b>NOTE:</b> Ogg FLAC files created prior to <span class="commandname">flac</span> 1.1.1 used an ad-hoc mapping and do not support seeking. They should be decoded and re-encoded with <span class="commandname">flac</span> 1.1.1 or later. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_serial_number" /> + <span class="argument">--serial-number=#</span> + </td> + <td> + When used with --ogg, specifies the serial number to use for the first Ogg FLAC stream, which is then incremented for each additional stream. When encoding and no serial number is given, <span class="commandname">flac</span> uses a random number for the first stream, then increments it for each additional stream. When decoding and no number is given, <span class="commandname">flac</span> uses the serial number of the first page. + </td> + </tr> + </table> + </td></tr></table> + + <br /> + + <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> + <table width="100%" border="1" bgcolor="#EEEED4"> + <tr> + <td colspan="2" bgcolor="#D3D4C5"> + <a name="analysis_options"><font size="+1"><b>Analysis Options</b></font></a> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_residual_text" /> + <span class="argument">--residual-text</span> + </td> + <td> + Includes the residual signal in the analysis file. This will make the file <b>very</b> big, much larger than even the decoded file. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_residual_gnuplot" /> + <span class="argument">--residual-gnuplot</span> + </td> + <td> + 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. + </td> + </tr> + </table> + </td></tr></table> + + <br /> + + <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> + <table width="100%" border="1" bgcolor="#EEEED4"> + <tr> + <td colspan="2" bgcolor="#D3D4C5"> + <a name="decoding_options"><font size="+1"><b>Decoding Options</b></font></a> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_cue" /> + <span class="argument">--cue=[#.#][-[#.#]]</span> + </td> + <td> + Set the beginning and ending cuepoints to decode. The optional first <span class="argument">#.#</span> is the track and index point at which decoding will start; the default is the beginning of the stream. The optional second <span class="argument">#.#</span> is the track and index point at which decoding will end; the default is the end of the stream. If the cuepoint does not exist, the closest one before it (for the start point) or after it (for the end point) will be used. If those don't exist, the start of the stream (for the start point) or end of the stream (for the end point) will be used. The cuepoints are merely translated into sample numbers then used as --skip and --until.<br /> + <br /> + Examples:<br /> + <br /> + <span class="argument">--cue=-</span> : decode the entire stream<br /> + <span class="argument">--cue=4.1</span> : decode from track 4, index 1 to the end of the stream<br /> + <span class="argument">--cue=4.1-</span> : decode from track 4, index 1 to the end of the stream<br /> + <span class="argument">--cue=-4.1</span> : decode from the beginning of the stream up to, but not including, track 4, index 1<br /> + <span class="argument">--cue=2.1-2.4</span> : decode from track 2, index 1, up to, but not including, track 2, index 4<br /> + <span class="argument">--cue=9.1-10.1</span> : decode from track 9 the way it would be played on a CD player; this works even if the CD has no 10th track. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_decode_through_errors" /> + <span class="argument">-F</span>,<br /><span class="argument">--decode-through-errors</span> + </td> + <td> + By default <span class="commandname">flac</span> stops decoding with an error and removes the partially decoded file if it encounters a bitstream error. With <span class="argument">-F</span>, errors are still printed but <span class="commandname">flac</span> will continue decoding to completion. Note that errors may cause the decoded audio to be missing some samples or have silent sections. + </td> + </tr> + <!-- @@@ undocumented, also not in the man page yet + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_apply_replaygain_which_is_not_lossless" /> + <span class="argument">-@@@-apply-replaygain-which-is-not-lossless[=<specification>]</span> + </td> + <td> + Applies ReplayGain values while decoding.<br /> + <br /> + <b>WARNING: THIS IS NOT LOSSLESS. DECODED AUDIO WILL NOT BE IDENTICAL TO THE ORIGINAL WITH THIS OPTION</b>.<br /> + <br /> + The equals sign and <specification> is optional. If omitted, the default is <span class="argument">0aLn1</span>.<br /> + <br /> + The <span class="argument"><specification></span> is a shorthand notation for describing how to apply ReplayGain. All components are optional but order is important. '<span class="argument">[]</span>' means 'optional'. '<span class="argument">|</span>' means 'or'. '<span class="argument">{}</span>' means required. The format is:<br /> + <br /> + <span class="argument">[<preamp>][a|t][l|L][n{0|1|2|3}]</span> + <ul> + <li> + <span class="argument"><preamp></span><br /> + A floating point number in dB. This is added to the existing gain value. + </li> + <li> + <span class="argument">a|t</span><br /> + Specify '<span class="argument">a</span>' to use the album gain, or '<span class="argument">t</span>' to use the track gain. If tags for the preferred kind (album/track) do not exist but tags for the other (track/album) do, those will be used instead. + </li> + <li> + <span class="argument">l|L</span><br /> + Specify '<span class="argument">l</span>' to peak-limit the output, so that the ReplayGain peak value is full-scale. Specify '<span class="argument">L</span>' to use a 6dB hard limiter that kicks in when the signal approaches full-scale. + </li> + <li> + <span class="argument">n{0|1|2|3}</span><br /> + Specify the amount of noise shaping. ReplayGain synthesis happens in floating point; the result is dithered before converting back to integer. This quantization adds noise. Noise shaping tries to move the noise where you won't hear it as much. <span class="argument">0</span> means no noise shaping, <span class="argument">1</span> means 'low', <span class="argument">2</span> means 'medium', <span class="argument">3</span> means 'high'. + </li> + </ul> + For example, the default of <span class="argument">0aLn1</span> means 0dB preamp, use album gain, 6dB hard limit, low noise shaping.<br /> + <br /> + <span class="argument">-@@@-apply-replaygain-which-is-not-lossless=3</span> means 3dB preamp, use album gain, no limiting, no noise shaping.<br /> + <br /> + <span class="commandname">flac</span> uses the ReplayGain tags for the calculation. If a stream does not have the required tags or they can't be parsed, decoding will continue with a warning, and no ReplayGain is applied to that stream. + </td> + </tr> + --> + </table> + </td></tr></table> + + <br /> + + <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> + <table width="100%" border="1" bgcolor="#EEEED4"> + <tr> + <td colspan="2" bgcolor="#D3D4C5"> + <a name="encoding_options"><font size="+1"><b>Encoding Options</b></font></a> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_verify" /> + <span class="argument">-V</span>, <span class="argument">--verify</span> + </td> + <td> + Verify the encoding process. With this option, <span class="commandname">flac</span> 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. <span class="argument">-V</span> increases the total encoding time but is guaranteed to catch any unforseen bug in the encoding process. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_lax" /> + <span class="argument">--lax</span> + </td> + <td> + Allow encoder to generate non-<a href="format.html#subset">Subset</a> files. The resulting FLAC file may not be streamable or might have trouble being played in all players (especially hardware devices), so you should only use this option in combination with custom encoding options meant for archival. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_replay_gain" /> + <span class="argument">--replay-gain</span> + </td> + <td> + Calculate <a href="http://www.replaygain.org/">ReplayGain</a> values and store them as FLAC tags, similar to <a href="http://packages.qa.debian.org/v/vorbisgain.html">VorbisGain</a>. Title gains/peaks will be computed for each input file, and an album gain/peak will be computed for all files. All input files must have the same resolution, sample rate, and number of channels. Only mono and stereo files are allowed, and the sample rate must be one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48 kHz. Also note that this option may leave a few extra bytes in a <span class="code">PADDING</span> block as the exact size of the tags is not known until all files are processed.<br /> + <br /> + Note that this option cannot be used when encoding to standard output (stdout). + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_cuesheet" /> + <span class="argument">--cuesheet=FILENAME</span> + </td> + <td> + Import the given cuesheet file and store it in a <a href="format.html#def_CUESHEET"><span class="code">CUESHEET</span></a> metadata block. This option may only be used when encoding a single file. A seekpoint will be added for each index point in the cuesheet to the <a href="format.html#def_SEEKTABLE"><span class="code">SEEKTABLE</span></a> unless <span class="argument">--no-cued-seekpoints</span> is specified.<br /> + <br /> + The cuesheet file must be of the sort written by <a href="http://www.goldenhawk.com/cdrwin.htm">CDRwin</a>, <a href="http://www.dcsoft.com/prod03.htm">CDRcue</a>, <a href="http://www.exactaudiocopy.de/">EAC</a>, etc. See also <a href="http://digitalx.org/cuesheetsyntax.php">cuesheet syntax</a>. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_picture" /> + <span class="argument">--picture=SPECIFICATION</span> + </td> + <td> + Import a picture and store it in a <a href="format.html#def_PICTURE"><span class="code">PICTURE</span></a> metadata block. More than one <span class="argument">--picture</span> command can be specified. The <span class="argument">SPECIFICATION</span> is a string whose parts are separated by <span class="argument">|</span> (pipe) characters. Some parts may be left empty to invoke default values. The format of <span class="argument">SPECIFICATION</span> is<br /> + <br /> + <tt> [TYPE]|MIME-TYPE|[DESCRIPTION]|[WIDTHxHEIGHTxDEPTH[/COLORS]]|FILE</tt><br /> + <br /> + <span class="argument">TYPE</span> is optional; it is a number from one of:<br /> + <ul> + <li><tt>0: Other</tt></li> + <li><tt>1: 32x32 pixels 'file icon' (PNG only)</tt></li> + <li><tt>2: Other file icon</tt></li> + <li><tt>3: Cover (front)</tt></li> + <li><tt>4: Cover (back)</tt></li> + <li><tt>5: Leaflet page</tt></li> + <li><tt>6: Media (e.g. label side of CD)</tt></li> + <li><tt>7: Lead artist/lead performer/soloist</tt></li> + <li><tt>8: Artist/performer</tt></li> + <li><tt>9: Conductor</tt></li> + <li><tt>10: Band/Orchestra</tt></li> + <li><tt>11: Composer</tt></li> + <li><tt>12: Lyricist/text writer</tt></li> + <li><tt>13: Recording Location</tt></li> + <li><tt>14: During recording</tt></li> + <li><tt>15: During performance</tt></li> + <li><tt>16: Movie/video screen capture</tt></li> + <li><tt>17: A bright coloured fish</tt></li> + <li><tt>18: Illustration</tt></li> + <li><tt>19: Band/artist logotype</tt></li> + <li><tt>20: Publisher/Studio logotype</tt></li> + </ul> + The default is 3 (front cover). There may only be one picture each of type 1 and 2 in a file.<br/> + <br /> + <span class="argument">MIME-TYPE</span> is mandatory; for best compatibility with players, use pictures with MIME type <tt>image/jpeg</tt> or <tt>image/png</tt>. The MIME type can also be --> to mean that <span class="argument">FILE</span> is actually a URL to an image, though this use is discouraged.<br /> + <br /> + <span class="argument">DESCRIPTION</span> is optional; the default is an empty string.<br /> + <br /> + The next part specfies the resolution and color information. If the <span class="argument">MIME-TYPE</span> is <tt>image/jpeg</tt>, <tt>image/png</tt>, or <tt>image/gif</tt>, you can usually leave this empty and they can be detected from the file. Otherwise, you must specify the width in pixels, height in pixels, and color depth in bits-per-pixel. If the image has indexed colors you should also specify the number of colors used. When manually specified, it is not checked against the file for accuracy.<br /> + <br /> + <span class="argument">FILE</span> is the path to the picture file to be imported, or the URL if MIME type is --><br /> + <br /> + For example, the specification <span class="argument">|image/jpeg|||../cover.jpg</span> will embed the JPEG file at <tt>../cover.jpg</tt>, defaulting to type 3 (front cover) and an empty description. The resolution and color info will be retrieved from the file itself.<br /> + <br /> + The specification <span class="argument">4|-->|CD|320x300x24/173|http://blah.blah/backcover.tiff</span> will embed the given URL, with type 4 (back cover), description "CD", and a manually specified resolution of 320x300, 24 bits-per-pixel, and 173 colors. The file at the URL will not be fetched; the URL itself is stored in the PICTURE metadata block. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_sector_align" /> + <span class="argument">--sector-align</span> + </td> + <td> + Align encoding of multiple CD format files on sector boundaries. This option is only allowed when encoding files all of which have a 44.1kHz sample rate and 2 channels. With <span class="argument">--sector-align</span>, the encoder will align the resulting .flac streams so that their lengths are even multiples of a CD sector (1/75th of a second, or 588 samples). It does this by carrying over any partial sector at the end of each file to the next stream. The last stream will be padded to alignment with zeroes.<br /> + <br /> + This option will have no effect if the files are already aligned (as is the normally the case with WAVE files ripped from a CD). <span class="commandname">flac</span> can only align a set of files given in one invocation of <span class="commandname">flac</span>.<br /> + <br /> + <b>WARNING:</b> The ordering of files is important! If you give a command like '<span class="code">flac --sector-align *.wav</span>' the shell may not expand the wildcard to the order you expect. To be safe you should '<span class="code">echo *.wav</span>' first to confirm the order, or be explicit like '<span class="code">flac --sector-align 8.wav 9.wav 10.wav</span>'. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_seekpoint" /> + <span class="argument">-S {#|X|#x|#s}</span>,<br /><span class="argument">--seekpoint={#|X|#x|#s}</span> + </td> + <td> + Include a point or points in a <span class="code">SEEKTABLE</span>:<br /> + <ul> + <li> + <span class="argument"># </span> : a specific sample number for a seek point + </li> + <li> + <span class="argument">X </span> : a placeholder point (always goes at the end of the <span class="code">SEEKTABLE</span>) + </li> + <li> + <span class="argument">#x</span> : # evenly spaced seekpoints, the first being at sample 0 + </li> + <li> + <span class="argument">#s</span> : a seekpoint every # seconds; # does not have to be a whole number, it can be, for example, <span class="argument">9.5</span>, meaning a seekpoint every 9.5 seconds + </li> + </ul> + You may use many -S options; the resulting <span class="code">SEEKTABLE</span> will be the unique-ified union of all such values.<br /> + With no -S options, flac defaults to '-S 10s'. Use --no-seektable for no <span class="code">SEEKTABLE</span>.<br /> + <b>NOTE:</b> -S #x and -S #s will not work if the encoder can't determine the input size before starting.<br /> + <b>NOTE:</b> 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 /> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_padding" /> + <span class="argument">-P #</span>, <span class="argument">--padding=#</span> + </td> + <td> + Tell the encoder to write a <span class="code">PADDING</span> metadata block of the given length (in bytes) after the <span class="code">STREAMINFO</span> block. This is useful if you plan to tag the file later with an <span class="code">APPLICATION</span> block; instead of having to rewrite the entire file later just to insert your block, you can write directly over the <span class="code">PADDING</span> block. Note that the total length of the <span class="code">PADDING</span> block will be 4 bytes longer than the length given because of the 4 metadata block header bytes. You can force no <span class="code">PADDING</span> block at all to be written with <span class="argument">--no-padding</span>. The encoder writes a <span class="code">PADDING</span> block of 8192 bytes by default (or 65536 bytes if the input audio stream is more than 20 minutes long). + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_tag" /> + <span class="argument">-T FIELD=VALUE</span>,<br /><span class="argument">--tag=FIELD=VALUE</span> + </td> + <td> + Add a FLAC tag. The comment must adhere to the Vorbis comment spec (which FLAC tags implement), i.e. the FIELD must contain only legal characters, terminated by an 'equals' sign. Make sure to quote the comment if necessary. This option may appear more than once to add several comments. NOTE: all tags will be added to all encoded files. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_tag_from_file" /> + <span class="argument">--tag-from-file=FIELD=FILENAME</span> + </td> + <td> + Like <a href="#flac_options_tag"><span class="argument">--tag</span></a>, except FILENAME is a file whose contents will be read verbatim to set the tag value. The contents will be converted to UTF-8 from the local charset. This can be used to store a cuesheet in a tag (e.g. <span class="argument">--tag-from-file="CUESHEET=image.cue"</span>). Do not try to store binary data in tag fields! Use APPLICATION blocks for that. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_blocksize" /> + <span class="argument">-b #</span>, <span class="argument">--blocksize=#</span> + </td> + <td> + Specify the block size in samples. Subset streams must use one of 192/576/1152/2304/4608/256/512/1024/2048/4096 (and 8192/16384 if the sample rate is >48kHz). The reference encoder uses the same block size for the entire stream. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_mid_side" /> + <span class="argument">-m</span>, <span class="argument">--mid-side</span> + </td> + <td> + 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. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_adaptive_mid_side" /> + <span class="argument">-M</span>, <span class="argument">--adaptive-mid-side</span> + </td> + <td> + Enable adaptive mid-side coding (only for stereo streams). Like <span class="argument">-m</span> but the encoder adaptively switches between independent and mid-side coding, which is faster but yields less compression than <span class="argument">-m</span> (which does an exhaustive search). + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_levels" /> + <span class="argument">-0 .. -8</span> + </td> + <td> + Fastest compression .. highest compression. The default is <span class="argument">-5</span>. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_level_0" /> + <span class="argument">-0</span>, <span class="argument">--compression-level-0</span> + </td> + <td> + Synonymous with <span class="argument">-l 0 -b 1152 -r 2,2</span> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_level_1" /> + <span class="argument">-1</span>, <span class="argument">--compression-level-1</span> + </td> + <td> + Synonymous with <span class="argument">-l 0 -b 1152 -M -r 2,2</span> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_level_2" /> + <span class="argument">-2</span>, <span class="argument">--compression-level-2</span> + </td> + <td> + Synonymous with <span class="argument">-l 0 -b 1152 -m -r 3</span> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_level_3" /> + <span class="argument">-3</span>, <span class="argument">--compression-level-3</span> + </td> + <td> + Synonymous with <span class="argument">-l 6 -b 4608 -r 3,3</span> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_level_4" /> + <span class="argument">-4</span>, <span class="argument">--compression-level-4</span> + </td> + <td> + Synonymous with <span class="argument">-l 8 -b 4608 -M -r 3,3</span> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_level_5" /> + <span class="argument">-5</span>, <span class="argument">--compression-level-5</span> + </td> + <td> + Synonymous with <span class="argument">-l 8 -b 4608 -m -r 3,3</span> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_level_6" /> + <span class="argument">-6</span>, <span class="argument">--compression-level-6</span> + </td> + <td> + Synonymous with <span class="argument">-l 8 -b 4608 -m -r 4</span> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_level_7" /> + <span class="argument">-7</span>, <span class="argument">--compression-level-7</span> + </td> + <td> + Synonymous with <span class="argument">-l 8 -b 4608 -m -e -r 6</span> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_level_8" /> + <span class="argument">-8</span>, <span class="argument">--compression-level-8</span> + </td> + <td> + Synonymous with <span class="argument">-l 12 -b 4608 -m -e -r 6</span> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_fast" /> + <span class="argument">--fast</span> + </td> + <td> + Fastest compression. Currently synonymous with <span class="argument">-0</span> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_best" /> + <span class="argument">--best</span> + </td> + <td> + Highest compression. Currently synonymous with <span class="argument">-8</span> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_exhaustive_model_search" /> + <span class="argument">-e</span>,<br /><span class="argument">--exhaustive-model-search</span> + </td> + <td> + 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%. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_apodization" /> + <span class="argument">-A "function"</span>, <span class="argument">--apodization="function"</span> + </td> + <td> + Window audio data with given the apodization function. The functions are: bartlett, bartlett_hann, blackman, blackman_harris_4term_92db, connes, flattop, gauss(STDDEV), hamming, hann, kaiser_bessel, nuttall, rectangle, triangle, tukey(P), welch.<br /> + For gauss(STDDEV), STDDEV is the standard deviation (0<STDDEV<=0.5).<br /> + For tukey(P), P specifies the fraction of the window that is tapered (0<=P<=1; P=0 corresponds to "rectangle" and P=1 corresponds to "hann").<br /> + More than one -A option (up to 32) may be used. Any function that is specified erroneously is silently dropped. The encoder chooses suitable defaults in the absence of any -A options; any -A option specified replaces the default(s).<br /> + When more than one function is specified, then for every subframe the encoder will try each of them separately and choose the window that results in the smallest compressed subframe. Multiple functions can greatly increase the encoding time.<br /> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_max_lpc_order" /> + <span class="argument">-l #</span>, <span class="argument">--max-lpc-order=#</span> + </td> + <td> + Specifies the maximum LPC order. This number must be <= 32. For Subset streams, it must be <=12 if the sample rate is <=48kHz. 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. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_qlp_coeff_precision" /> + <span class="argument">-q #</span>,<br /><span class="argument">--qlp-coeff-precision=#</span> + </td> + <td> + Specifies the precision of the quantized LP coefficients, in bits. The default is <span class="argument">-q 0</span>, 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. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_qlp_coeff_precision_search" /> + <span class="argument">-p</span>,<br /><span class="argument">--qlp-coeff-precision-search</span> + </td> + <td> + Do exhaustive LP coefficient quantization optimization. This option overrides any <span class="argument">-q</span> option. It is expensive and typically will only improve the compression a tiny fraction of a percent. <span class="argument">-q</span> has no effect when <span class="argument">-l 0</span> is used. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_rice_partition_order" /> + <span class="argument">-r [#,]#</span>,<br /><span class="argument">--rice-partition-order=[#,]#</span> + </td> + <td> + Set the [min,]max residual partition order. The min value defaults to 0 if unspecified.<br /> + <br /> + 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 <span class="argument">-r 2,2</span> (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 <span class="argument">-r 0,16</span> to force the highest degree of optimization. + </td> + </tr> + </table> + </td></tr></table> + + <br /> + + <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> + <table width="100%" border="1" bgcolor="#EEEED4"> + <tr> + <td colspan="2" bgcolor="#D3D4C5"> + <a name="format_options"><font size="+1"><b>Format Options</b></font></a> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_endian" /> + <span class="argument">--endian={big|little}</span> + </td> + <td> + Specify big-endian or little-endian byte order in the raw file. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_channels" /> + <span class="argument">--channels=#</span> + </td> + <td> + Specify the number of channels in the raw file. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_bps" /> + <span class="argument">--bps=#</span> + </td> + <td> + Specify the number of bits per sample in the raw file. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_sample_rate" /> + <span class="argument">--sample-rate=#</span> + </td> + <td> + Specify the sample rate of the raw file. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_sign" /> + <span class="argument">--sign={signed|unsigned}</span> + </td> + <td> + Specify that the samples in the raw file are signed or unsigned (the default is signed). + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_input_size" /> + <span class="argument">--input-size=#</span> + </td> + <td> + Specify the size of the raw input in bytes. If you are encoding raw samples from stdin, you must set this option in order to be able to use --skip, --until, --cue-sheet, or other options that need to know the size of the input beforehand. If the size given is greater than what is found in the input stream, the encoder will complain about an unexpected end-of-file. If the size given is less, samples will be truncated. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_force_aiff_format" /> + <span class="argument">--force-aiff-format</span> + </td> + <td> + Force the decoder to output AIFF format. This option is not needed if the output filename (as set by -o) ends with .aiff. Also, this option has no effect when encoding since input AIFF is auto-detected. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="flac_options_force_raw_format" /> + <span class="argument">--force-raw-format</span> + </td> + <td> + Treat the input file (or output file if decoding) as a raw file, regardless of the extension. + </td> + </tr> + </table> + </td></tr></table> + + <br /> + + <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> + <table width="100%" border="1" bgcolor="#EEEED4"> + <tr> + <td colspan="2" bgcolor="#D3D4C5"> + <a name="negative_options"><font size="+1"><b>Negative Options</b></font></a> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <span class="argument">--no-adaptive-mid-side</span><br /> + <span class="argument">--no-decode-through-errors</span><br /> + <span class="argument">--no-delete-input-file</span><br /> + <span class="argument">--no-escape-coding</span><br /> + <span class="argument">--no-exhaustive-model-search</span><br /> + <span class="argument">--no-lax</span><br /> + <span class="argument">--no-mid-side</span><br /> + <span class="argument">--no-ogg</span><br /> + <span class="argument">--no-padding</span><br /> + <span class="argument">--no-qlp-coeff-precision-search</span><br /> + <span class="argument">--no-residual-gnuplot</span><br /> + <span class="argument">--no-residual-text</span><br /> + <span class="argument">--no-sector-align</span><br /> + <span class="argument">--no-seektable</span><br /> + <span class="argument">--no-silent</span><br /> + <span class="argument">--no-verify</span> + </td> + <td> + Can all be used to turn off a particular option. + </td> + </tr> + </table> + </td></tr></table> + + <br /> + <a name="option_index"><font size="+1"><b><u>Option Index</u></b></font></a><br /> + <br /> + <a href="#flac_options_level_0" /><span class="argument">-0</span></a><br /> + <a href="#flac_options_level_1" /><span class="argument">-1</span></a><br /> + <a href="#flac_options_level_2" /><span class="argument">-2</span></a><br /> + <a href="#flac_options_level_3" /><span class="argument">-3</span></a><br /> + <a href="#flac_options_level_4" /><span class="argument">-4</span></a><br /> + <a href="#flac_options_level_5" /><span class="argument">-5</span></a><br /> + <a href="#flac_options_level_6" /><span class="argument">-6</span></a><br /> + <a href="#flac_options_level_7" /><span class="argument">-7</span></a><br /> + <a href="#flac_options_level_8" /><span class="argument">-8</span></a><br /> + <a href="#flac_options_apodization" /><span class="argument">-A</span></a><br /> + <a href="#flac_options_analyze" /><span class="argument">-a</span></a><br /> + <a href="#flac_options_adaptive_mid_side" /><span class="argument">--adaptive-mid-side</span></a><br /> + <a href="#flac_options_analyze" /><span class="argument">--analyze</span></a><br /> + <a href="#flac_options_apodization" /><span class="argument">--apodization</span></a><br /> + <!-- @@@ undocumented, also not in the man page yet + <a href="#flac_options_apply_replaygain_which_is_not_lossless" /><span class="argument">-@@@-apply-replaygain-which-is-not-lossless</span></a><br /> + --> + <a href="#flac_options_blocksize" /><span class="argument">-b</span></a><br /> + <a href="#flac_options_best" /><span class="argument">--best</span></a><br /> + <a href="#flac_options_blocksize" /><span class="argument">--blocksize</span></a><br /> + <a href="#flac_options_bps" /><span class="argument">--bps</span></a><br /> + <a href="#flac_options_stdout" /><span class="argument">-c</span></a><br /> + <a href="#flac_options_channels" /><span class="argument">--channels</span></a><br /> + <a href="#flac_options_level_0" /><span class="argument">--compression-level-0</span></a><br /> + <a href="#flac_options_level_1" /><span class="argument">--compression-level-1</span></a><br /> + <a href="#flac_options_level_2" /><span class="argument">--compression-level-2</span></a><br /> + <a href="#flac_options_level_3" /><span class="argument">--compression-level-3</span></a><br /> + <a href="#flac_options_level_4" /><span class="argument">--compression-level-4</span></a><br /> + <a href="#flac_options_level_5" /><span class="argument">--compression-level-5</span></a><br /> + <a href="#flac_options_level_6" /><span class="argument">--compression-level-6</span></a><br /> + <a href="#flac_options_level_7" /><span class="argument">--compression-level-7</span></a><br /> + <a href="#flac_options_level_8" /><span class="argument">--compression-level-8</span></a><br /> + <a href="#flac_options_cue" /><span class="argument">--cue</span></a><br /> + <a href="#flac_options_cuesheet" /><span class="argument">--cuesheet</span></a><br /> + <a href="#flac_options_decode" /><span class="argument">-d</span></a><br /> + <a href="#flac_options_decode" /><span class="argument">--decode</span></a><br /> + <a href="#flac_options_decode_through_errors" /><span class="argument">--decode-through-errors</span></a><br /> + <a href="#flac_options_delete_input_file" /><span class="argument">--delete-input-file</span></a><br /> + <a href="#flac_options_exhaustive_model_search" /><span class="argument">-e</span></a><br /> + <a href="#flac_options_endian" /><span class="argument">--endian</span></a><br /> + <a href="#flac_options_exhaustive_model_search" /><span class="argument">--exhaustive-model-search</span></a><br /> + <a href="#flac_options_explain" /><span class="argument">--explain</span></a><br /> + <a href="#flac_options_decode_through_errors" /><span class="argument">-F</span></a><br /> + <a href="#flac_options_force" /><span class="argument">-f</span></a><br /> + <a href="#flac_options_fast" /><span class="argument">--fast</span></a><br /> + <a href="#flac_options_force_aiff_format" /><span class="argument">--force-aiff-format</span></a><br /> + <a href="#flac_options_force_raw_format" /><span class="argument">--force-raw-format</span></a><br /> + <a href="#flac_options_force" /><span class="argument">--force</span></a><br /> + <a href="#flac_options_explain" /><span class="argument">-H</span></a><br /> + <a href="#flac_options_help" /><span class="argument">-h</span></a><br /> + <a href="#flac_options_help" /><span class="argument">--help</span></a><br /> + <a href="#flac_options_input_size" /><span class="argument">--input-size</span></a><br /> + <a href="#flac_options_max_lpc_order" /><span class="argument">-l</span></a><br /> + <a href="#flac_options_lax" /><span class="argument">--lax</span></a><br /> + <a href="#flac_options_adaptive_mid_side" /><span class="argument">-M</span></a><br /> + <a href="#flac_options_mid_side" /><span class="argument">-m</span></a><br /> + <a href="#flac_options_max_lpc_order" /><span class="argument">--max-lpc-order</span></a><br /> + <a href="#flac_options_mid_side" /><span class="argument">--mid-side</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-adaptive-mid-side</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-decode-through-errors</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-delete-input-file</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-escape-coding</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-exhaustive-model-search</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-lax</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-mid-side</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-ogg</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-padding</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-qlp-coeff-precision-search</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-residual-gnuplot</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-residual-text</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-sector-align</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-seektable</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-silent</span></a><br /> + <a href="#negative_options" /><span class="argument">--no-verify</span></a><br /> + <a href="#flac_options_output_name" /><span class="argument">-o</span></a><br /> + <a href="#flac_options_ogg" /><span class="argument">--ogg</span></a><br /> + <a href="#flac_options_output_name" /><span class="argument">--output-name</span></a><br /> + <a href="#flac_options_output_prefix" /><span class="argument">--output-prefix</span></a><br /> + <a href="#flac_options_padding" /><span class="argument">-P</span></a><br /> + <a href="#flac_options_qlp_coeff_precision_search" /><span class="argument">-p</span></a><br /> + <a href="#flac_options_padding" /><span class="argument">--padding</span></a><br /> + <a href="#flac_options_picture" /><span class="argument">--picture</span></a><br /> + <a href="#flac_options_qlp_coeff_precision" /><span class="argument">-q</span></a><br /> + <a href="#flac_options_qlp_coeff_precision" /><span class="argument">--qlp-coeff-precision</span></a><br /> + <a href="#flac_options_qlp_coeff_precision_search" /><span class="argument">--qlp-coeff-precision-search</span></a><br /> + <a href="#flac_options_rice_partition_order" /><span class="argument">-r</span></a><br /> + <a href="#flac_options_replay_gain" /><span class="argument">--replay-gain</span></a><br /> + <a href="#flac_options_residual_gnuplot" /><span class="argument">--residual-gnuplot</span></a><br /> + <a href="#flac_options_residual_text" /><span class="argument">--residual-text</span></a><br /> + <a href="#flac_options_rice_partition_order" /><span class="argument">--rice-partition-order</span></a><br /> + <a href="#flac_options_seekpoint" /><span class="argument">-S</span></a><br /> + <a href="#flac_options_silent" /><span class="argument">-s</span></a><br /> + <a href="#flac_options_sample_rate" /><span class="argument">--sample-rate</span></a><br /> + <a href="#flac_options_sector_align" /><span class="argument">--sector-align</span></a><br /> + <a href="#flac_options_seekpoint" /><span class="argument">--seekpoint</span></a><br /> + <a href="#flac_options_serial_number" /><span class="argument">--serial-number</span></a><br /> + <a href="#flac_options_sign" /><span class="argument">--sign</span></a><br /> + <a href="#flac_options_silent" /><span class="argument">--silent</span></a><br /> + <a href="#flac_options_skip" /><span class="argument">--skip</span></a><br /> + <a href="#flac_options_stdout" /><span class="argument">--stdout</span></a><br /> + <a href="#flac_options_tag" /><span class="argument">-T</span></a><br /> + <a href="#flac_options_test" /><span class="argument">-t</span></a><br /> + <a href="#flac_options_tag" /><span class="argument">--tag</span></a><br /> + <a href="#flac_options_tag_from_file" /><span class="argument">--tag-from-file</span></a><br /> + <a href="#flac_options_test" /><span class="argument">--test</span></a><br /> + <a href="#flac_options_totally_silent" /><span class="argument">--totally-silent</span></a><br /> + <a href="#flac_options_until" /><span class="argument">--until</span></a><br /> + <a href="#flac_options_verify" /><span class="argument">-V</span></a><br /> + <a href="#flac_options_version" /><span class="argument">-v</span></a><br /> + <a href="#flac_options_verify" /><span class="argument">--verify</span></a><br /> + <a href="#flac_options_version" /><span class="argument">--version</span></a><br /> + + </div> + <div class="box_footer"></div> +</div> + + +<div class="copyright"> + <!-- @@@ oh so hacky --> + <table> + <tr> + <td align="left"> + Copyright (c) 2000,2001,2002,2003,2004,2005,2006 Josh Coalson + </td> + <td width="1%" align="right"> + <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a> + </td> + <td width="1%" align="right"> + <a href="http://www.eff.org/cafe/"><img src="images/cafebug.gif" alt="CAFE Logo" border="0" /></a><br /> + </td> + <td width="1%" align="right"> + <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" border="0" hspace="0" /></a> + </td> + </tr> + </table> +</div> + +</body> +</html> diff --git a/doc/html/documentation_tools_metaflac.html b/doc/html/documentation_tools_metaflac.html new file mode 100644 index 00000000..376846a0 --- /dev/null +++ b/doc/html/documentation_tools_metaflac.html @@ -0,0 +1,570 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006 Josh Coalson --> +<!-- Permission is granted to copy, distribute and/or modify this document --> +<!-- under the terms of the GNU Free Documentation License, Version 1.1 --> +<!-- or any later version published by the Free Software Foundation; --> +<!-- with no invariant sections. --> +<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html --> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> + <meta name="author" content="Josh Coalson" /> + <meta name="description" content="A free, open source codec for lossless audio compression and decompression" /> + <meta name="keywords" content="free,lossless,audio,codec,encoder,decoder,compression,compressor,archival,archive,archiving,backup,music" /> + <link rel="shortcut icon" type="image/x-icon" href="favicon.ico" /> + <link rel="stylesheet" type="text/css" href="flac.css" /> + <title>FLAC - documentation</title> +</head> + +<body> + +<div class="logo"> + <a href="http://flac.sourceforge.net/"><img src="images/logo130.gif" alt="FLAC Logo" align="middle" border="0" hspace="0" /></a> +</div> + +<div class="above_nav"></div> + +<div class="navbar"> + <a href="index.html">home</a> | + <a href="faq.html">faq</a> | + <a href="news.html">news</a> | + <a href="download.html">download</a> | + <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | + <a href="changelog.html">changelog</a> | + <a href="links.html">links</a> | + <a href="developers.html">developers</a> +</div> + +<div class="langbar"> + english | + <a href="ru/documentation.html">russian</a> +</div> + +<div class="below_nav"></div> + +<div class="box"> + <div class="box_title"> + <a name="metaflac">metaflac</a> + </div> + <div class="box_header"></div> + <div class="box_body"> + <a name="toc"><font size="+1"><b><u>Table of Contents</u></b></font></a> + <ul> + <li><a href="#usage">General Usage</a></li> + <li><a href="#global_options">Global Options</a></li> + <li><a href="#shorthand_operations">Shorthand Operations</a></li> + <li><a href="#major_operations">Major Operations</a></li> + <li><a href="#option_index">Option Index</a></li> + </ul> + <a name="usage"><font size="+1"><b><u>General Usage</u></b></font></a><br /> + <br /> + <span class="commandname">metaflac</span> is the command-line <span class="code">.flac</span> file metadata editor. You can use it to list the contents of metadata blocks, edit, delete or insert blocks, and manage padding.<br /> + <br /> + <span class="commandname">metaflac</span> takes a set of "options" (though some are not optional) and a set of FLAC files to operate on. There are three kinds of "options": + <ul> + <li> + Major operations, which specify a mode of operation like listing blocks, removing blocks, etc. These will have sub-operations describing exactly what is to be done. + </li> + <li> + Shorthand operations, which are convenient synonyms for major operations. For example, there is a shorthand operation <span class="argument">--show-sample-rate</span> that shows just the sample rate field from the <span class="code">STREAMINFO</span> metadata block. + </li> + <li> + Global options, which affect all the operations. + </li> + </ul> + All of these are described in the tables below. At least one shorthand or major operation must be supplied. You can use multiple shorthand operations to do more than one thing to a file or set of files. Most of the common things to do to metadata have shorthand operations. As an example, here is how to show the MD5 signatures for a set of three FLAC files:<br /> + <br /> + <span class="code">metaflac --show-md5sum file1.flac file2.flac file3.flac</span><br /> + <br /> + Another example; this removes all DESCRIPTION and COMMENT tags in a set of FLAC files, and uses the <span class="argument">--preserve-modtime</span> global option to keep the FLAC file modification times the same (usually when files are edited the modification time is set to the current time):<br /> + <br /> + <span class="code">metaflac --preserve-modtime --remove-tag=DESCRIPTION --remove-tag=COMMENT file1.flac file2.flac file3.flac</span><br /> + <br /> + + <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> + <table width="100%" border="1" bgcolor="#EEEED4"> + <tr> + <td colspan="2" bgcolor="#D3D4C5"> + <a name="global_options"><font size="+1"><b>Global Options</b></font></a> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_options_preserve_modtime" /> + <span class="argument">--preserve-modtime</span> + </td> + <td> + Preserve the original modification time in spite of edits. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_options_with_filename" /> + <span class="argument">--with-filename</span> + </td> + <td> + Prefix each output line with the FLAC file name (the default if more than one FLAC file is specified). + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_options_no_filename" /> + <span class="argument">--no-filename</span> + </td> + <td> + Do not prefix each output line with the FLAC file name (the default if only one FLAC file is specified) + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_options_no_utf8_convert" /> + <span class="argument">--no-utf8-convert</span> + </td> + <td> + Do not convert tags from UTF-8 to local charset, or vice versa. This is useful for scripts. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_options_dont_use_padding" /> + <span class="argument">--dont-use-padding</span> + </td> + <td> + By default <span class="commandname">metaflac</span> tries to use padding where possible to avoid rewriting the entire file if the metadata size changes. Use this option to tell metaflac to not take advantage of padding this way. + </td> + </tr> + </table> + </td></tr></table> + + <br /> + + <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> + <table width="100%" border="1" bgcolor="#EEEED4"> + <tr> + <td colspan="2" bgcolor="#D3D4C5"> + <a name="shorthand_operations"><font size="+1"><b>Shorthand Operations</b></font></a> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_show_md5sum" /> + <span class="argument">--show-md5sum</span> + </td> + <td> + Show the MD5 signature from the <span class="code">STREAMINFO</span> block. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_show_min_blocksize" /> + <span class="argument">--show-min-blocksize</span> + </td> + <td> + Show the minimum block size from the <span class="code">STREAMINFO</span> block. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_show_max_blocksize" /> + <span class="argument">--show-max-blocksize</span> + </td> + <td> + Show the maximum block size from the <span class="code">STREAMINFO</span> block. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_show_min_framesize" /> + <span class="argument">--show-min-framesize</span> + </td> + <td> + Show the minimum frame size from the <span class="code">STREAMINFO</span> block. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_show_max_framesize" /> + <span class="argument">--show-max-framesize</span> + </td> + <td> + Show the maximum frame size from the <span class="code">STREAMINFO</span> block. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_show_sample_rate" /> + <span class="argument">--show-sample-rate</span> + </td> + <td> + Show the sample rate from the <span class="code">STREAMINFO</span> block. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_show_channels" /> + <span class="argument">--show-channels</span> + </td> + <td> + Show the number of channels from the <span class="code">STREAMINFO</span> block. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_show_bps" /> + <span class="argument">--show-bps</span> + </td> + <td> + Show the # of bits per sample from the <span class="code">STREAMINFO</span> block. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_show_total_samples" /> + <span class="argument">--show-total-samples</span> + </td> + <td> + Show the total # of samples from the <span class="code">STREAMINFO</span> block. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_show_vendor_tag" /> + <span class="argument">--show-vendor-tag</span> + </td> + <td> + Show the vendor string from the <span class="code">VORBIS_COMMENT</span> block. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_show_tag" /> + <span class="argument">--show-tag=NAME</span> + </td> + <td> + Show all tags where the the field name matches <span class="argument">NAME</span>. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_remove_tag" /> + <span class="argument">--remove-tag=NAME</span> + </td> + <td> + Remove all tags whose field name is <span class="argument">NAME</span>. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_remove_first_tag" /> + <span class="argument">--remove-first-tag=NAME</span> + </td> + <td> + Remove first tag whose field name is <span class="argument">NAME</span>. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_remove_all_tags" /> + <span class="argument">--remove-all-tags</span> + </td> + <td> + Remove all tags, leaving only the vendor string. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_set_tag" /> + <span class="argument">--set-tag=FIELD</span> + </td> + <td> + Add a tag. The <span class="argument">FIELD</span> must comply with the Vorbis comment spec, of the form <span class="argument">NAME=VALUE</span>. If there is currently no tag block, one will be created. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_set_tag_from_file" /> + <span class="argument">--set-tag-from-file=FIELD</span> + </td> + <td> + Like <a href="#metaflac_shorthand_set_tag"><span class="argument">--set-tag</span></a>, except the VALUE is a filename whose contents will be read verbatim to set the tag value. Unless <a href="#metaflac_options_no_utf8_convert"><span class="argument">--no-utf8-convert</span></a> is specified, the contents will be converted to UTF-8 from the local charset. This can be used to store a cuesheet in a tag (e.g. <span class="argument">--set-tag-from-file="CUESHEET=image.cue"</span>). Do not try to store binary data in tag fields! Use APPLICATION blocks for that. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_import_tags_from" /> + <span class="argument">--import-tags-from=FILE</span> + </td> + <td> + Import tags from a file. Use <span class="argument">-</span> for stdin. Each line should be of the form <span class="argument">NAME=VALUE</span>. Multi-line comments are currently not supported. Specify <span class="argument">--remove-all-tags</span> and/or <a href="#metaflac_options_no_utf8_convert"><span class="argument">--no-utf8-convert</span></a> before <span class="argument">--import-tags-from</span> if necessary. If <span class="argument">FILE</span> is <span class="argument">-</span> (stdin), only one FLAC file may be specified. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_export_tags_to" /> + <span class="argument">--export-tags-to=FILE</span> + </td> + <td> + Export tags to a file. Use <span class="argument">-</span> for stdin. Each line will be of the form <span class="argument">NAME=VALUE</span>. Specify <a href="#metaflac_options_no_utf8_convert"><span class="argument">--no-utf8-convert</span></a> if necessary. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_import_cuesheet_from" /> + <span class="argument">--import-cuesheet-from=FILE</span> + </td> + <td> + Import a cuesheet from a file. Use <span class="argument">-</span> for stdin. Only one FLAC file may be specified. A seekpoint will be added for each index point in the cuesheet to the <span class="code">SEEKTABLE</span> unless <span class="argument">--no-cued-seekpoints</span> is specified. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_export_cuesheet_to" /> + <span class="argument">--export-cuesheet-to=FILE</span> + </td> + <td> + Export <span class="code">CUESHEET</span> block to a cuesheet file, suitable for use by CD authoring software. Use <span class="argument">-</span> for stdout. Only one FLAC file may be specified on the command line. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_import_picture_from" /> + <span class="argument">--import-picture-from=SPECIFICATION</span> + </td> + <td> + Import a picture and store it in a <a href="format.html#def_PICTURE"><span class="code">PICTURE</span></a> metadata block. See the <span class="commandname">flac</span> option <span class="argument"><a href="documentation_tools_flac.html#flac_options_picture">--picture</a></span> for an explanation of the <span class="argument">SPECIFICATION</span> syntax. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_export_picture_to" /> + <span class="argument">--export-picture-to=FILE</span> + </td> + <td> + Export <span class="code">PICTURE</span> block to a file. Use <span class="argument">-</span> for stdout. Only one FLAC file may be specified on the command line. The first <span class="code">PICTURE</span> block will be exported unless <span class="argument">--export-picture-to</span> is preceded by a <span class="argument">--block-number=#</span> option to specify the exact metadata block to extract. Note that the block number is the one shown by --list. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_add_replay_gain" /> + <span class="argument">--add-replay-gain</span> + </td> + <td> + Calculates the title and album gains/peaks of the given FLAC files as if all the files were part of one album, then stores them in the <span class="code">VORBIS_COMMENT</span> block. The tags are the same as those used by <span class="commandname">vorbisgain</span>. Existing ReplayGain tags will be replaced. If only one FLAC file is given, the album and title gains will be the same. Since this operation requires two passes, it is always executed last, after all other operations have been completed and written to disk. All FLAC files specified must have the same resolution, sample rate, and number of channels. The sample rate must be one of 8, 11.025, 12, 16, 22.05, 24, 32, 44.1, or 48 kHz. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_remove_replay_gain" /> + <span class="argument">--remove-replay-gain</span> + </td> + <td> + Removes the ReplayGain tags. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_add_seekpoint" /> + <span class="argument">--add-seekpoint={#|X|#x|#s}</span> + </td> + <td> + Add seek points to a <span class="code">SEEKTABLE</span> block:<br /> + <ul> + <li> + <span class="argument"># </span> : a specific sample number for a seek point + </li> + <li> + <span class="argument">X </span> : a placeholder point (always goes at the end of the <span class="code">SEEKTABLE</span>) + </li> + <li> + <span class="argument">#x</span> : # evenly spaced seekpoints, the first being at sample 0 + </li> + <li> + <span class="argument">#s</span> : a seekpoint every # seconds; # does not have to be a whole number, it can be, for example, <span class="argument">9.5</span>, meaning a seekpoint every 9.5 seconds + </li> + </ul> + If no <span class="code">SEEKTABLE</span> block exists, one will be created. If one already exists, points will be added to the existing table, and any duplicates will be turned into placeholder points.<br /> + You may use many <span class="argument">--add-seekpoint</span> options; the resulting <span class="code">SEEKTABLE</span> will be the unique-ified union of all such values. Example: <span class="argument">--add-seekpoint=100x --add-seekpoint=3.5s</span> will add 100 evenly spaced seekpoints and a seekpoint every 3.5 seconds.<br /> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_shorthand_add_padding" /> + <span class="argument">--add-padding=#</span> + </td> + <td> + Add a padding block of the given length (in bytes). The overall length of the new block will be 4 + length; the extra 4 bytes is for the metadata block header. + </td> + </tr> + </table> + </td></tr></table> + + <br /> + + <table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="#EEEED4"><tr><td> + <table width="100%" border="1" bgcolor="#EEEED4"> + <tr> + <td colspan="2" bgcolor="#D3D4C5"> + <a name="major_operations"><font size="+1"><b>Major Operations</b></font></a> + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_operations_version" /> + <span class="argument">--version</span> + </td> + <td> + Show the metaflac version number. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_operations_list" /> + <span class="argument">--list</span> + </td> + <td> + List the contents of one or more metadata blocks to stdout. By default, all metadata blocks are listed in text format. Use the following options to change this behavior:<br /> + <br /> + + <span class="argument">--block-number=#[,#[...]]</span><br /> + An optional comma-separated list of block numbers to display. The first block, the <span class="code">STREAMINFO</span> block, is block 0.<br /> + <br /> + + <span class="argument">--block-type=type[,type[...]]</span><br /> + <span class="argument">--except-block-type=type[,type[...]]</span><br /> + An optional comma-separated list of block types to be included or ignored with this option. Use only one of <span class="argument">--block-type</span> or <span class="argument">--except-block-type</span>. The valid block types are: <span class="code">STREAMINFO</span>, <span class="code">PADDING</span>, <span class="code">APPLICATION</span>, <span class="code">SEEKTABLE</span>, <span class="code">VORBIS_COMMENT</span>. You may narrow down the types of <span class="code">APPLICATION</span> blocks displayed as follows:<br /> + <table border="1"> + <tr> + <td><span class="argument">APPLICATION:abcd</span></td> + <td>The <span class="code">APPLICATION</span> block(s) whose textual representation of the 4-byte ID is "abcd"</td> + </tr> + <tr> + <td><span class="argument">APPLICATION:0xXXXXXXXX</span></td> + <td>The <span class="code">APPLICATION</span> block(s) whose hexadecimal big- endian representation of the 4-byte ID is "0xXXXXXXXX". For the example "abcd" above the hexadecimal equivalalent is 0x61626364</td> + </tr> + </table> + <br /> + + NOTE: if both <span class="argument">--block-number</span> and <span class="argument">--[except-]block-type</span> are specified, the result is the logical AND of both arguments.<br /> + <br /> + + <span class="argument">--application-data-format=hexdump|text</span><br /> + If the application block you are displaying contains binary data but your <span class="argument">--data-format=text</span>, you can display a hex dump of the application data contents instead using <span class="argument">--application-data-format=hexdump</span>. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_operations_remove" /> + <span class="argument">--remove</span> + </td> + <td> + Remove one or more metadata blocks from the metadata. Unless <span class="argument">--dont-use-padding</span> is specified, the blocks will be replaced with padding. You may not remove the <span class="code">STREAMINFO</span> block.<br /> + <br /> + + <span class="argument">--block-number=#[,#[...]]</span><br /> + <span class="argument">--block-type=type[,type[...]]</span><br /> + <span class="argument">--except-block-type=type[,type[...]]</span><br /> + See <a href="#metaflac_operations_list"><span class="argument">--list</span></a> above for usage.<br /> + <br /> + + NOTE: if both <span class="argument">--block-number</span> and <span class="argument">--[except-]block-type</span> are specified, the result is the logical AND of both arguments. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_operations_remove_all" /> + <span class="argument">--remove-all</span> + </td> + <td> + Remove all metadata blocks (except the <span class="code">STREAMINFO</span> block) from the metadata. Unless <span class="argument">--dont-use-padding</span> is specified, the blocks will be replaced with padding. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_operations_merge_padding" /> + <span class="argument">--merge-padding</span> + </td> + <td> + Merge adjacent <span class="code">PADDING</span> blocks into single blocks. + </td> + </tr> + <tr> + <td nowrap="nowrap" align="right" valign="top" bgcolor="#F4F4CC"> + <a name="metaflac_operations_sort_padding" /> + <span class="argument">--sort-padding</span> + </td> + <td> + Move all <span class="code">PADDING</span> blocks to the end of the metadata and merge them into a single block. + </td> + </tr> + </table> + </td></tr></table> + + <br /> + <a name="option_index"><font size="+1"><b><u>Option Index</u></b></font></a><br /> + <br /> + <a href="#metaflac_shorthand_add_padding" /><span class="argument">--add-padding</span></a><br /> + <a href="#metaflac_shorthand_add_replay_gain" /><span class="argument">--add-replay-gain</span></a><br /> + <a href="#metaflac_shorthand_add_seekpoint" /><span class="argument">--add-seekpoint</span></a><br /> + <a href="#metaflac_options_dont_use_padding" /><span class="argument">--dont-use-padding</span></a><br /> + <a href="#metaflac_shorthand_export_cuesheet_to" /><span class="argument">--export-cuesheet-to</span></a><br /> + <a href="#metaflac_shorthand_export_picture_to" /><span class="argument">--export-picture-to</span></a><br /> + <a href="#metaflac_shorthand_export_tags_to" /><span class="argument">--export-tags-to</span></a><br /> + <a href="#metaflac_shorthand_import_cuesheet_from" /><span class="argument">--import-cuesheet-from</span></a><br /> + <a href="#metaflac_shorthand_import_picture_from" /><span class="argument">--import-picture-from</span></a><br /> + <a href="#metaflac_shorthand_import_tags_from" /><span class="argument">--import-tags-from</span></a><br /> + <a href="#metaflac_operations_list" /><span class="argument">--list</span></a><br /> + <a href="#metaflac_operations_merge_padding" /><span class="argument">--merge-padding</span></a><br /> + <a href="#metaflac_options_no_filename" /><span class="argument">--no-filename</span></a><br /> + <a href="#metaflac_options_no_utf8_convert" /><span class="argument">--no-utf8-convert</span></a><br /> + <a href="#metaflac_options_preserve_modtime" /><span class="argument">--preserve-modtime</span></a><br /> + <a href="#metaflac_shorthand_remove_all_tags" /><span class="argument">--remove-all-tags</span></a><br /> + <a href="#metaflac_operations_remove_all" /><span class="argument">--remove-all</span></a><br /> + <a href="#metaflac_shorthand_remove_first_tag" /><span class="argument">--remove-first-tag</span></a><br /> + <a href="#metaflac_shorthand_remove_replay_gain" /><span class="argument">--remove-replay-gain</span></a><br /> + <a href="#metaflac_shorthand_remove_tag" /><span class="argument">--remove-tag</span></a><br /> + <a href="#metaflac_operations_remove" /><span class="argument">--remove</span></a><br /> + <a href="#metaflac_shorthand_set_tag_from_file" /><span class="argument">--set-tag-from-file</span></a><br /> + <a href="#metaflac_shorthand_set_tag" /><span class="argument">--set-tag</span></a><br /> + <a href="#metaflac_shorthand_show_bps" /><span class="argument">--show-bps</span></a><br /> + <a href="#metaflac_shorthand_show_channels" /><span class="argument">--show-channels</span></a><br /> + <a href="#metaflac_shorthand_show_max_blocksize" /><span class="argument">--show-max-blocksize</span></a><br /> + <a href="#metaflac_shorthand_show_max_framesize" /><span class="argument">--show-max-framesize</span></a><br /> + <a href="#metaflac_shorthand_show_md5sum" /><span class="argument">--show-md5sum</span></a><br /> + <a href="#metaflac_shorthand_show_min_blocksize" /><span class="argument">--show-min-blocksize</span></a><br /> + <a href="#metaflac_shorthand_show_min_framesize" /><span class="argument">--show-min-framesize</span></a><br /> + <a href="#metaflac_shorthand_show_sample_rate" /><span class="argument">--show-sample-rate</span></a><br /> + <a href="#metaflac_shorthand_show_tag" /><span class="argument">--show-tag</span></a><br /> + <a href="#metaflac_shorthand_show_total_samples" /><span class="argument">--show-total-samples</span></a><br /> + <a href="#metaflac_shorthand_show_vendor_tag" /><span class="argument">--show-vendor-tag</span></a><br /> + <a href="#metaflac_operations_sort_padding" /><span class="argument">--sort-padding</span></a><br /> + <a href="#metaflac_operations_version" /><span class="argument">--version</span></a><br /> + <a href="#metaflac_options_with_filename" /><span class="argument">--with-filename</span></a><br /> + + </div> + <div class="box_footer"></div> +</div> + + +<div class="copyright"> + <!-- @@@ oh so hacky --> + <table> + <tr> + <td align="left"> + Copyright (c) 2000,2001,2002,2003,2004,2005,2006 Josh Coalson + </td> + <td width="1%" align="right"> + <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a> + </td> + <td width="1%" align="right"> + <a href="http://www.eff.org/cafe/"><img src="images/cafebug.gif" alt="CAFE Logo" border="0" /></a><br /> + </td> + <td width="1%" align="right"> + <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" border="0" hspace="0" /></a> + </td> + </tr> + </table> +</div> + +</body> +</html> diff --git a/doc/html/documentation_tools_plugins.html b/doc/html/documentation_tools_plugins.html new file mode 100644 index 00000000..d9c33a70 --- /dev/null +++ b/doc/html/documentation_tools_plugins.html @@ -0,0 +1,94 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!-- Copyright (c) 2000,2001,2002,2003,2004,2005,2006 Josh Coalson --> +<!-- Permission is granted to copy, distribute and/or modify this document --> +<!-- under the terms of the GNU Free Documentation License, Version 1.1 --> +<!-- or any later version published by the Free Software Foundation; --> +<!-- with no invariant sections. --> +<!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html --> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> + <meta name="author" content="Josh Coalson" /> + <meta name="description" content="A free, open source codec for lossless audio compression and decompression" /> + <meta name="keywords" content="free,lossless,audio,codec,encoder,decoder,compression,compressor,archival,archive,archiving,backup,music" /> + <link rel="shortcut icon" type="image/x-icon" href="favicon.ico" /> + <link rel="stylesheet" type="text/css" href="flac.css" /> + <title>FLAC - documentation</title> +</head> + +<body> + +<div class="logo"> + <a href="http://flac.sourceforge.net/"><img src="images/logo130.gif" alt="FLAC Logo" align="middle" border="0" hspace="0" /></a> +</div> + +<div class="above_nav"></div> + +<div class="navbar"> + <a href="index.html">home</a> | + <a href="faq.html">faq</a> | + <a href="news.html">news</a> | + <a href="download.html">download</a> | + <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | + <a href="changelog.html">changelog</a> | + <a href="links.html">links</a> | + <a href="developers.html">developers</a> +</div> + +<div class="langbar"> + english | + <a href="ru/documentation.html">russian</a> +</div> + +<div class="below_nav"></div> + +<div class="box"> + <div class="box_title"> + <a name="plugins"></a><a name="xmms_plugin">xmms plugin</a> + </div> + <div class="box_header"></div> + <div class="box_body"> + Normally the FLAC plugin for XMMS is installed with a package, but some of the <a href="download.html">binary builds</a> have a compiled plugin. All that is necessary is to copy <span class="code">libxmms-flac.so</span> to the directory where XMMS looks for input plugins (usually <span class="code">/usr/lib/xmms/Input</span> or <span class="code">$HOME/.xmms/Input</span>). There is nothing else to configure. Make sure to restart XMMS before trying to play any <span class="code">.flac</span> files. + </div> + <div class="box_footer"></div> +</div> + +<br /> + +<div class="box"> + <div class="box_title"> + <a name="winamp_plugin">winamp plugin</a> + </div> + <div class="box_header"></div> + <div class="box_body"> + Since Winamp 5.31, Nullsoft has supplied a FLAC plugin with their Full install; nothing else is needed to get FLAC to play in Wnamp.<br /> + <br /> + Before Winamp 5.31 it was necessary to use our FLAC plugin. If you have an older version of Winamp, our plugin is still available in the <a href="http://cyberial.com/flacinstaller.asp">FLAC Installer for Windows</a>. The Winamp plugin should work for both Winamp2 and Winamp5. All that is necessary is to copy <span class="code">in_flac.dll</span> to the <span class="code">Plugins/</span> directory of your Winamp installation. There is nothing else to configure. Make sure to restart Winamp before trying to play any <span class="code">.flac</span> files. + </div> + <div class="box_footer"></div> +</div> + + +<div class="copyright"> + <!-- @@@ oh so hacky --> + <table> + <tr> + <td align="left"> + Copyright (c) 2000,2001,2002,2003,2004,2005,2006 Josh Coalson + </td> + <td width="1%" align="right"> + <a href="http://sourceforge.net"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=13478&type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a> + </td> + <td width="1%" align="right"> + <a href="http://www.eff.org/cafe/"><img src="images/cafebug.gif" alt="CAFE Logo" border="0" /></a><br /> + </td> + <td width="1%" align="right"> + <a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" border="0" hspace="0" /></a> + </td> + </tr> + </table> +</div> + +</body> +</html> diff --git a/doc/html/download.html b/doc/html/download.html index cf303a7d..4d4b0856 100644 --- a/doc/html/download.html +++ b/doc/html/download.html @@ -29,12 +29,8 @@ <a href="faq.html">faq</a> | <a href="news.html">news</a> | download | - <a href="features.html">features</a> | - <a href="goals.html">goals</a> | - <a href="format.html">format</a> | - <a href="id.html">id</a> | - <a href="comparison.html">comparison</a> | <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | <a href="changelog.html">changelog</a> | <a href="links.html">links</a> | <a href="developers.html">developers</a> @@ -53,6 +49,10 @@ </div> <div class="box_header"></div> <div class="box_body"> + Many different programs support FLAC. If you are not sure what to download, see <a href="documentation_tasks.html">Using FLAC</a> for instructions and guides on playing FLAC files, ripping CDs to FLAC, etc.<br /> + <br /> + This section is for the <a href="documentation_tools.html">official FLAC tools</a>. See the <a href="#extras">extras section</a> below for other third-party tools.<br /> + <br /> All source code and binaries are freely available and distributed under <a href="http://www.opensource.org/docs/definition.php">Open Source</a> licenses. The codec libraries are distributed under Xiph.org's BSD license, and the plugins and command-line utilites (<span class="commandname">flac</span> and <span class="commandname">metaflac</span>) are distributed under the <a href="http://www.opensource.org/licenses/gpl-license.html">GPL</a>. If you would like to redistribute parts or all of FLAC under different terms, <a href="mailto:jcoalson@users.sourceforge.net">contact Josh Coalson</a>. (For more information, see the <a href="license.html">license page</a>.) <ul> <li> @@ -76,7 +76,7 @@ <li> <b>Windows</b> <ul> - <li><a href="http://cyberial.com/flacinstaller.asp">FLAC for Windows with installer</a> (<a href="http://downloads.sourceforge.net/flac/flac113b.exe?use_mirror=superb-west">alternate link</a>). <b>NOTE: </b>Several virus scanners are reporting that FLAC contains a trojan; this is a FALSE POSITIVE. For more info see <a href="http://nsis.sourceforge.net/index.php?id=2&backPID=2&tt_news=14">here</a>, <a href="http://servicenews.symantec.com/cgi-bin/displayArticle.cgi?article=29991&group=symantec.support.generic.virus_corporate.general&tpre=ent">here</a>, <a href="http://forums.mcafeehelp.com/viewtopic.php?p=164312">here</a>.</li> + <li><a href="http://cyberial.com/flacinstaller.asp">FLAC for Windows with installer</a> (<a href="http://downloads.sourceforge.net/flac/flac113b.exe?use_mirror=superb-west">alternate link</a>)</li> <li><a href="http://sourceforge.net/project/showfiles.php?group_id=13478&package_id=12675">FLAC for Windows (tools only)</a></li> </ul> </li> @@ -119,10 +119,10 @@ <br /> <b>NOTE: </b> make sure to check out the <a href="links.html">links page</a> for a large list of open-source software supporting FLAC.<br /> <br /> - <b>GUI encoding/decoding front-ends:</b> + <a name="extras_gui"><b>GUI encoding/decoding front-ends:</b></a> <ul> <li> - <b>Windows</b> + <a name="extras_gui_windows"><b>Windows</b></a> <ul> <li><a href="http://www.legroom.net/modules.php?op=modload&name=Open_Source&file=index&page=software&app=autoflac">AutoFLAC</a> for automated ripping and encoding to FLAC with EAC (ExactAudioCopy); also has a write mode for burning back to CD for an exact copy</li> <li><a href="http://www.dbpoweramp.com/">dBpowerAMP</a>, a swiss army knife that can convert and play many formats, including FLAC.</li> @@ -133,20 +133,12 @@ <li><a href="http://home.vxu.se/mdati00/frontah/">Frontah</a>, a new frontend to many codecs, including FLAC. Still in beta but has good reviews.</li> <li><a href="http://www.germanixsoft.de/">GX::Transcoder</a></li> <li><a href="http://mareo.netfirms.com/">MAREO</a> is a "virtual" encoder that can be used with ExactAudioCopy to encode to multiple formats (including FLAC) at once while ripping.</li> - <li><a href="http://www.monkeysaudio.com/">Monkey's Audio</a> can be fooled into supporting FLAC as an external encoder; <a href="documentation.html#monkey">here's how</a>.</li> <li><a href="http://www.unifront.boereck.de/">UniversalFront</a>, an encoding/decoding/transcoding GUI that is also scriptable.</li> <li><a href="http://music.yahoo.com/musicengine/">Yahoo! Music Engine</a></li> </ul> </li> <li> - <b>Unix</b> - <ul> - <li><a href="http://www.nostatic.org/grip/">Grip</a> is a great ripping and encoding front end and can be easily configured to use flac. See <a href="http://sourceforge.net/mailarchive/forum.php?thread_id=1634089&forum_id=5443">this message</a> on how to configure Grip for FLAC.</li> - <li><a href="http://www.amb.org/xmcd/">xmcd</a> is a CD ripper with CDDB support as well as a player.</li> - </ul> - </li> - <li> - <b>Mac OS X</b> + <a name="extras_gui_osx"><b>Mac OS X</b></a> <ul> <li><a href="http://www.lexial.ca/alex/applescripts/iTunes_to_flac.html">iTunes-to-FLAC</a>, an AppleScript for converting between FLAC and WAVE/AIFF with tagging via iTunes.</li> <li><!-- <a href="http://www.danrules.com/macflac/"><a href="http://www.versiontracker.com/dyn/moreinfo/macosx/15883"> --><a href="http://mac.softpedia.com/get/Audio/MacFLAC.shtml">MacFLAC</a>, a FLAC distribution which also includes nice graphical front-end.</li> @@ -157,16 +149,24 @@ </ul> </li> <li> - <b>Pocket PC</b> + <a name="extras_gui_unix"><b>Unix</b></a> + <ul> + <li><a href="http://www.nostatic.org/grip/">Grip</a> is a great ripping and encoding front end and can be easily configured to use flac. See <a href="http://sourceforge.net/mailarchive/forum.php?thread_id=1634089&forum_id=5443">this message</a> on how to configure Grip for FLAC.</li> + <li><a href="http://www.amb.org/xmcd/">xmcd</a> is a CD ripper with CDDB support as well as a player.</li> + <li>(<a href="links.html#software">many more</a>)</li> + </ul> + </li> + <li> + <a name="extras_gui_pocketpc"><b>Pocket PC</b></a> <ul> <li>[$] <a href="http://www.gidluckmastering.com/live2496.html">Live2496</a>, a program that can record 24-bit audio up to 96kHz on a Pocket PC (using <a href="http://www.core-sound.com/">Core Sound's PDAudio interface</a>) can record directly to FLAC.</li> </ul> </li> </ul> - <b>CD burning:</b> + <a name="extras_burning"><b>CD burning:</b></a> <ul> <li> - <b>Windows</b> + <a name="extras_burning_windows"><b>Windows</b></a> <ul> <li><a href="http://www.burnatonce.com/">burnatonce</a>, a CD burning GUI that wraps around <a href="http://sourceforge.net/projects/cdrdao/">cdrdao</a> and <a href="http://freshmeat.net/projects/cdrecord/">mkisofs</a>.</li> <li><a href="http://www.burrrn.net/?page_id=4">Burrrn</a> supports burning CDs from cuesheets directly from many formats, including FLAC, and supports most tag formats.</li> @@ -174,24 +174,27 @@ <li><a href="http://dbpoweramp.com/cdwriter.htm">dBpowerAMP CD Writer</a>.</li> <li>[$] <a href="http://www.poikosoft.com/">Easy CD-DA Extractor</a>.</li> <li>[$] <a href="http://www.roxio.com/enu/products/creator/suite/features.html">Easy Media Creator 9 Suite</a> from Roxio.</li> - <li>[$] <a href="http://www.nero.com/">Nero</a> (as a <a href="http://neroplugins.cd-rw.org/">plugin</a>); allows you to burn FLAC files directly to audio CDs.</li> </ul> - <b>Mac OS X</b> + </li> + <li> + <a name="extras_burning_osx"><b>Mac OS X</b></a> <ul> <li>[$] Roxio's <a href="http://www.roxio.com/en/products/toast/index.jhtml">Toast 7 Titanium</a> supports encoding to FLAC and CD/DVD burning from FLAC.</li> </ul> </li> <li> - <b>Unix</b> + <a name="extras_burning_unix"><b>Unix</b></a> <ul> - <li><a href="http://arson.sourceforge.net/">Arson</a>, a front-end to various CD burning and ripping tools.</li> + <li><a href="http://arson.sourceforge.net/">Arson</a>: KDE ripper/burner</li> + <li><a href="http://www.k3b.org/">K3B</a>: CD/DVD creator for Linux</li> + <li>(<a href="links.html#software">more</a>)</li> </ul> </li> </ul> - <b>Players and plugins:</b> + <a name="extras_players"><b>Players and plugins:</b></a> <ul> <li> - <b>Windows</b> + <a name="extras_players_windows"><b>Windows</b></a> <ul> <!-- case's page disappeared, use temporary links <li><a href="http://www.saunalahti.fi/~cse/files/cool_flac.zip">Cooledit FLAC filter</a> (source code <a href="http://www.saunalahti.fi/cse/files/cool_flac_src.zip">here</a>).</li> @@ -215,7 +218,7 @@ </ul> </li> <li> - <b>Mac OS X</b> + <a name="extras_players_osx"><b>Mac OS X</b></a> <ul> <li><a href="http://cogosx.sourceforge.net/">Cog</a></li> <li><a href="http://freshmeat.net/projects/cynthiune/">Cynthiune</a> music player</li> @@ -223,11 +226,26 @@ <li><a href="http://homepage.mac.com/steve_bryan/Personal12.html">PureMusic Audio Player</a></li> <li><a href="http://www.songbirdnest.com/">Songbird</a></li> <li><a href="http://www.videolan.org/vlc/index.html">VLC</a></li> - <li><a href="http://www.xiph.org/quicktime/">XiphQT</a> component for Quicktime/iTunes that supports Ogg FLAC</li> + <li><a href="http://www.xiph.org/quicktime/">XiphQT</a> component for Quicktime/iTunes that supports Ogg FLAC playback</li> + </ul> + </li> + <li> + <a name="extras_players_unix"><b>Unix</b></a> + <ul> + <li><a href="http://alsaplayer.org/">AlsaPlayer</a></li> + <li><a href="http://www.giantdisc.org/">GiantDisc</a>: Linux jukebox + Palm remote</li> + <li><a href="http://www.mplayerhq.hu/">MPlayer</a></li> + <li><a href="http://muine.gooeylinux.org/">Muine</a>: a music player for GNOME</li> + <li><a href="http://musik.berlios.de/">Musik</a>: an open-source, cross-platform multimedia player and library</li> + <li><a href="http://www.videolan.org/">VideoLAN</a> client</li> + <li><a href="http://xine.sourceforge.net/">Xine</a> multimedia player</li> + <li><a href="http://www.amb.org/xmcd/">xmcd</a>: X CD player</li> + <li><a href="http://www.xmms.org/">XMMS</a>: X MultiMedia System</li> + <li>(<a href="links.html#software">many more</a>)</li> </ul> </li> <li> - <b>Java</b> + <a name="extras_players_java"><b>Java</b></a> <ul> <li><a href="http://jflac.sourceforge.net/">jFLAC</a>: a Java native-FLAC decoder library and player application.</li> <li><a href="http://www.j-ogg.de/">J-Ogg</a>: Java libraries for Ogg decoding, including Ogg FLAC.</li> diff --git a/doc/html/faq.html b/doc/html/faq.html index b66e8e3d..18eccbe6 100644 --- a/doc/html/faq.html +++ b/doc/html/faq.html @@ -29,12 +29,8 @@ faq | <a href="news.html">news</a> | <a href="download.html">download</a> | - <a href="features.html">features</a> | - <a href="goals.html">goals</a> | - <a href="format.html">format</a> | - <a href="id.html">id</a> | - <a href="comparison.html">comparison</a> | <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | <a href="changelog.html">changelog</a> | <a href="links.html">links</a> | <a href="developers.html">developers</a> @@ -56,6 +52,15 @@ <b>General</b> <ul> <li> + <a href="#general__what_is"><b>What is FLAC?</b></a> + </li> + <li> + <a href="#general__how_to"><b>I have a FLAC file, how do I play it?</b></a> + </li> + <li> + <a href="#general__how_to"><b>How can I create FLAC files?</b></a> + </li> + <li> <a href="#general__license"><b>What licensing applies to the FLAC format and software?</b></a> </li> <li> @@ -169,6 +174,17 @@ <b>General</b> </h2> + <a name="general__what_is"><b>What is FLAC?</b></a><br /> + <br /> + FLAC stands for Free Lossless Audio Codec, an audio format similar to MP3, but lossless, meaning that audio is compressed in FLAC without any loss in quality. This is similar to how Zip works, except with FLAC you will get much better compression because it is designed specifically for audio, and you can play back compressed FLAC files in your favorite player (or your car or home stereo, see <a href="links.html#hardware">supported devices</a>) just like you would an MP3 file.<br /> + <br /> + For more details, see <a href="features.html">What is FLAC?</a><br /> + <br /> + <a name="general__how_to"><b>I have a FLAC file, how do I play it?</b></a><br /> + <b>How can I create FLAC files?</b></a><br /> + <br /> + See <a href="documentation_tasks.html">Using FLAC</a>.<br /> + <br /> <a name="general__license"><b>What licensing applies to the FLAC format and software?</b></a><br /> <br /> See the <a href="license.html">license page</a>.<br /> @@ -271,7 +287,7 @@ <a name="tools__eac_and_flac"><b>How do I set up EAC to rip directly to FLAC?</b></a><br /> <br /> - See Case's excellent <a href="http://www.saunalahti.fi/cse/EAC/index.html">EAC configuration page</a>. Or use <a href="http://mareo.netfirms.com/">MAREO</a> to rip to multiple formats at once.<br /> + See Case's excellent <a href="http://www.saunalahti.fi/cse/EAC/index.html">EAC configuration page</a>. Or use <a href="http://www.legroom.net/modules.php?op=modload&name=Open_Source&file=index&page=software&app=autoflac">AutoFLAC</a>, <a href="http://omniencoder.autobotcity.net/">Omni Encoder</a>, or <a href="http://mareo.netfirms.com/">MAREO</a> to rip to FLAC or multiple formats at once.<br /> <br /> <a name="tools__option_blocking"><b>How do I encode a file that starts with a dash?</b></a><br /> <br /> diff --git a/doc/html/features.html b/doc/html/features.html index da6fbafd..cbe27289 100644 --- a/doc/html/features.html +++ b/doc/html/features.html @@ -29,12 +29,8 @@ <a href="faq.html">faq</a> | <a href="news.html">news</a> | <a href="download.html">download</a> | - features | - <a href="goals.html">goals</a> | - <a href="format.html">format</a> | - <a href="id.html">id</a> | - <a href="comparison.html">comparison</a> | <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | <a href="changelog.html">changelog</a> | <a href="links.html">links</a> | <a href="developers.html">developers</a> @@ -49,22 +45,16 @@ <div class="box"> <div class="box_title"> - features + <a name="introduction">introduction</a> </div> <div class="box_header"></div> <div class="box_body"> - FLAC stands for Free Lossless Audio Codec. Grossly oversimplified, FLAC is similar to MP3, but lossless, meaning that audio is compressed in FLAC without any loss in quality. This is similar to how Zip works, except with FLAC you will get much better compression because it is designed specifically for audio, and you can play back compressed FLAC files in your favorite player (or your car or home stereo, see <a href="links.html#hardware">supported devices</a>) just like you would an MP3 file.<br /> + FLAC stands for Free Lossless Audio Codec, an audio format similar to MP3, but lossless, meaning that audio is compressed in FLAC without any loss in quality. This is similar to how Zip works, except with FLAC you will get much better compression because it is designed specifically for audio, and you can play back compressed FLAC files in your favorite player (or your car or home stereo, see <a href="links.html#hardware">supported devices</a>) just like you would an MP3 file.<br /> <br /> - FLAC is freely available and supported on most operating systems, including Windows, "unix" (Linux, *BSD, Solaris, OS X, IRIX), BeOS, OS/2, and Amiga. There are build systems for autotools, MSVC, Watcom C, and Project Builder.<br /> + FLAC supports tagging, cover art, and fast seeking. FLAC is freely available and supported on most operating systems, including Windows, "unix" (Linux, *BSD, Solaris, OS X, IRIX), BeOS, OS/2, and Amiga.<br /> + <br /> + There are <a href="links.html">many programs and devices that support FLAC</a>, but the core FLAC project here maintains the format and provides <a href="documentation_tools.html">programs</a> and <a href="developers.html">libraries</a> for working with FLAC files. See <a href="download.html">Getting FLAC</a> for instructions on downloading and installing the official FLAC tools, or <a href="documentation_tasks.html">Using FLAC</a> for instructions and guides on playing FLAC files, ripping CDs to FLAC, etc.<br /> <br /> - The FLAC project consists of: - <ul> - <li>the stream format</li> - <li>reference encoders and decoders in library form</li> - <li><span class="commandname">flac</span>, a command-line program to encode and decode FLAC files</li> - <li><span class="commandname">metaflac</span>, a command-line metadata editor for FLAC files</li> - <li>input plugins for various music players</li> - </ul> When we say that FLAC is "Free" it means more than just that it is available at no cost. It means that the specification of the format is fully open to the public to be used for any purpose (the FLAC project reserves the right to set the FLAC specification and certify compliance), and that neither the FLAC format nor any of the implemented encoding/decoding methods are covered by any known patent. It also means that all the source code is available under open-source licenses. It is the first truly open and free lossless audio format. (For more information, see the <a href="license.html">license page</a>.)<br /> <br /> Notable features of FLAC: @@ -76,16 +66,16 @@ <b>Fast</b>: FLAC is asymmetric in favor of decode speed. Decoding requires only integer arithmetic, and is much less compute-intensive than for most perceptual codecs. Real-time decode performance is easily achievable on even modest hardware. </li> <li> - <b>Hardware support</b>: Because of FLAC's free reference implementation and low decoding complexity, FLAC is currently the only lossless codec that has any kind of hardware support. + <b>Hardware support</b>: FLAC is supported by <a href="links.html#hardware">dozens of consumer electronic devices</a>, from portable players, to home stereo equipment, to car stereo. </li> <li> - <b>Streamable</b>: Each FLAC frame contains enough data to decode that frame. FLAC does not even rely on previous or following frames. FLAC uses sync codes and CRCs (similar to MPEG and other formats), which, along with framing, allow decoders to pick up in the middle of a stream with a minimum of delay. + <b>Flexible metadata</b>: FLAC's metadata system supports tags, cover art, seek tables, and cue sheets. Applications can write their own <a href="format.html#def_APPLICATION">APPLICATION</a> metadata once they <a href="id.html">register an ID</a>. New metadata blocks can be defined and implemented in future versions of FLAC without breaking older streams or decoders. </li> <li> <b>Seekable</b>: FLAC supports fast sample-accurate seeking. Not only is this useful for playback, it makes FLAC files suitable for use in editing applications. </li> <li> - <b>Flexible metadata</b>: New metadata blocks can be defined and implemented in future versions of FLAC without breaking older streams or decoders. Currently there are metadata types for tags, cue sheets, and seek tables. Applications can write their own <a href="format.html#def_APPLICATION">APPLICATION</a> metadata once they <a href="id.html">register an ID</a> + <b>Streamable</b>: Each FLAC frame contains enough data to decode that frame. FLAC does not even rely on previous or following frames. FLAC uses sync codes and CRCs (similar to MPEG and other formats), which, along with framing, allow decoders to pick up in the middle of a stream with a minimum of delay. </li> <li> <b>Suitable for archiving</b>: FLAC is an open format, and there is no generation loss if you need to convert your data to another format in the future. In addition to the frame CRCs and MD5 signature, <span class="commandname">flac</span> has a verify option that decodes the encoded stream in parallel with the encoding process and compares the result to the original, aborting with an error if there is a mismatch. @@ -100,10 +90,10 @@ What FLAC is <b>not</b>: <ul> <li> - Lossy. FLAC is intended for lossless compression only, as there are many good lossy formats already, such as <a href="http://www.xiph.org/ogg/vorbis/index.html">Vorbis</a>, <!-- a href="http://musepack.org/" -->MPC<!-- /a -->, and <a href="http://www.mp3-tech.org/">MP3</a> (see <a href="http://www.mp3dev.org/mp3/">LAME</a> for an excellent open-source implementation). + Lossy. FLAC is intended for lossless compression only, as there are many good lossy formats already, such as <a href="http://www.xiph.org/ogg/vorbis/index.html">Vorbis</a>, <a href="http://www.musepack.net/">MPC</a>, and <a href="http://www.mp3-tech.org/">MP3</a> (see <a href="http://www.mp3dev.org/mp3/">LAME</a> for an excellent open-source implementation). </li> <li> - SDMI compliant, et cetera. There is no intention to support any methods of copy protection, which are, for all practical purposes, a complete waste of bits. (Another way to look at it is that since copy protection is futile, it really carries no information, so you might say FLAC already losslessly compresses all possible copy protection information down to zero bits!) Of course, we can't stop what some misguided person does with proprietary metadata blocks, but then again, non-proprietary decoders will skip them anyway. + DRM. There is no intention to add any copy prevention methods. Of course, we can't stop someone from encrypting a FLAC stream in another container (e.g. the way Apple encrypts AAC in MP4 with FairPlay), that is the choice of the user. </li> </ul> </div> diff --git a/doc/html/format.html b/doc/html/format.html index 98531148..80b85c11 100644 --- a/doc/html/format.html +++ b/doc/html/format.html @@ -29,12 +29,8 @@ <a href="faq.html">faq</a> | <a href="news.html">news</a> | <a href="download.html">download</a> | - <a href="features.html">features</a> | - <a href="goals.html">goals</a> | - format | - <a href="id.html">id</a> | - <a href="comparison.html">comparison</a> | <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | <a href="changelog.html">changelog</a> | <a href="links.html">links</a> | <a href="developers.html">developers</a> @@ -55,6 +51,8 @@ <div class="box_body"> This is a detailed description of the FLAC format. There is also a companion document that describes <a href="ogg_mapping.html">FLAC-to-Ogg mapping</a>.<br /> <br /> + For a user-oriented overview, see <a href="documentation_format_overview.html">About the FLAC Format</a>.<br /> + <br /> <a name="toc"><font size="+1"><b><u>Table of Contents</u></b></font></a> <ul> <li><a href="#acknowledgments">Acknowledgments</a></li> diff --git a/doc/html/id.html b/doc/html/id.html index dcc3fe70..9beee7cf 100644 --- a/doc/html/id.html +++ b/doc/html/id.html @@ -29,12 +29,8 @@ <a href="faq.html">faq</a> | <a href="news.html">news</a> | <a href="download.html">download</a> | - <a href="features.html">features</a> | - <a href="goals.html">goals</a> | - <a href="format.html">format</a> | - id | - <a href="comparison.html">comparison</a> | <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | <a href="changelog.html">changelog</a> | <a href="links.html">links</a> | <a href="developers.html">developers</a> diff --git a/doc/html/index.html b/doc/html/index.html index 235fada8..9c239f2b 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -29,12 +29,8 @@ <a href="faq.html">faq</a> | <a href="news.html">news</a> | <a href="download.html">download</a> | - <a href="features.html">features</a> | - <a href="goals.html">goals</a> | - <a href="format.html">format</a> | - <a href="id.html">id</a> | - <a href="comparison.html">comparison</a> | <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | <a href="changelog.html">changelog</a> | <a href="links.html">links</a> | <a href="developers.html">developers</a> @@ -53,27 +49,13 @@ <div class="box"> <div class="box_title"> - <a name="status">status</a> + <a name="what_is_flac">what is FLAC?</a> </div> <div class="box_header"></div> <div class="box_body"> - <a href="http://www.sonos.com/">Sonos, Inc.</a> has sent us a complete <a href="http://www.sonos.com/products/">Sonos Digital Music System</a> for review. Aside from being just plain cool, FLAC support is excellent; see <a href="links.html#review_sonos">our writeup</a> for details.<br /> - <br /> - Pearl Jam is selling recordings of many of their live shows <a href="https://bootlegs2.pearljam.com/">in FLAC format</a>.<br /> - <br /> - Two new portables support FLAC, the Meizu <a href="http://www.miniplayer.info/miniplayer_specifications.asp">M6 Miniplayer</a> and the <a href="http://www.gizmodo.com/gadgets/portable-media/teclast-tl29-pmp-pretty-face-pure-of-heart-198859.php">Teclast TL-29</a>.<br /> - <br /> - <b>FLAC 1.1.3 released</b> Almost 2 years in the making, FLAC 1.1.3 is a <a href="faq.html#api__release_versioning">major release</a> with improved compression, improved cover art and multichannel support, better recovery for corrupted files, many new features and options in the command-line tools, and several bug fixes. For developers, the decoder and encoder APIs have also been simplified and there is a new <a href="api/group__porting.html">porting guide</a>. See the <a href="changelog.html#flac_1_1_3">changelog entry</a> for complete details. If your locale does not use "." for the decimal point, <a href="documentation.html#bugs">see this note</a>.<br /> - <br /> - <a href="http://winamp.com/player/">Winamp 5.31</a> now includes Nullsoft FLAC plugins for encoding and decoding. The decoder is based on our reference decoder plugin. However the current encoder plugin is based on a pre-release of <a href="http://flake-enc.sourceforge.net/">flake</a> and we <a href="http://www.hydrogenaudio.org/forums/index.php?s=&showtopic=45013&view=findpost&p=443961">recommend to not use it for archival</a> yet.<br /> - <br /> - The new <a href="http://www.neodigits.com/new/body/products/Xline/x5000.asp">Helios X5000</a> HD network media player from Neodigits supports FLAC.<br /> - <br /> - The <a href="http://www.thephiladelphiaorchestra.com/">Philadelphia Orchestra</a> is making many recordings <a href="http://www.losslessaudioblog.com/?p=109">available in FLAC</a>.<br /> + FLAC stands for Free Lossless Audio Codec, an audio format similar to MP3, but lossless, meaning that audio is compressed in FLAC without any loss in quality. This is similar to how Zip works, except with FLAC you will get much better compression because it is designed specifically for audio, and you can play back compressed FLAC files in your favorite player (or your car or home stereo, see <a href="links.html#hardware">supported devices</a>) just like you would an MP3 file.<br /> <br /> - A whole new batch of devices and stores support FLAC: for portables there are the <a href="http://www.cowonamerica.com/products/iaudio/t2/">iAUDIO T2</a> and <a href="http://www.cowonglobal.com/product/product_F2_feature.php">iAUDIO F2</a>, TrekStor's <a href="http://www.trekstor.de/en/products/detail_mp3.php?pid=66">Vibez</a>, the <a href="http://www.anythingbutipod.com/archives/2006/09/onda-vx737-gaming-pmp.php">Onda VX737</a>, and the <a href="http://www.apod.com.cn/show_products.asp?photoID=437">AP3000</a> from Green Apple. For the home stereo, Slim Devices' <a href="http://www.slimdevices.com/pi_transporter.html">Transporter</a> and Ziova's <a href="http://www.ziova.com/cs510.php">CS510</a> and <a href="http://www.ziova.com/cs505.php">CS505</a>. For music in FLAC format check out <a href="http://www.digital-tunes.net/">digital-tunes</a> for electronic and underground, or <a href="http://festivalink.net/">FestivaLink.net</a> for live shows.<br /> - <br /> - <i>last updated 2006-Dec-18</i> <!-- @@@ update date after changes --> + See <a href="features.html">About FLAC</a> for more, or <a href="documentation_tasks.html">Using FLAC</a> for how to play FLAC files, rip CDs to FLAC, etc. </div> <div class="box_footer"></div> </div> @@ -82,66 +64,27 @@ <div class="box"> <div class="box_title"> - <a name="what_is_flac">what is FLAC?</a> + <a name="latest">the latest</a> </div> <div class="box_header"></div> <div class="box_body"> - FLAC stands for Free Lossless Audio Codec. Grossly oversimplified, FLAC is similar to MP3, but lossless, meaning that audio is compressed in FLAC without any loss in quality. This is similar to how Zip works, except with FLAC you will get much better compression because it is designed specifically for audio, and you can play back compressed FLAC files in your favorite player (or your car or home stereo, see <a href="links.html#hardware">supported devices</a>) just like you would an MP3 file.<br /> + Want iTunes to support FLAC? <a href="itunes.html">Visit our iTunes page</a> to make your request known!<br /> <br /> - FLAC is freely available and supported on most operating systems, including Windows, "unix" (Linux, *BSD, Solaris, OS X, IRIX), BeOS, OS/2, and Amiga. There are build systems for autotools, MSVC, Watcom C, and Project Builder.<br /> + <a href="http://www.sonos.com/">Sonos, Inc.</a> has sent us a complete <a href="http://www.sonos.com/products/">Sonos Digital Music System</a> for review. Aside from being just plain cool, FLAC support is excellent; see <a href="links.html#review_sonos">our writeup</a> for details.<br /> <br /> - See the <a href="features.html">features page</a> for a complete list of features, or the <a href="comparison.html">comparison page</a> to see how FLAC compares with other lossless codecs.<br /> + Pearl Jam is selling recordings of many of their live shows <a href="https://bootlegs2.pearljam.com/">in FLAC format</a>.<br /> <br /> - The FLAC project consists of:<br /> + Two new portables support FLAC, the Meizu <a href="http://www.miniplayer.info/miniplayer_specifications.asp">M6 Miniplayer</a> and the <a href="http://www.gizmodo.com/gadgets/portable-media/teclast-tl29-pmp-pretty-face-pure-of-heart-198859.php">Teclast TL-29</a>.<br /> <br /> - <ul> - <li>the stream format</li> - <li>reference encoders and decoders in library form</li> - <li><span class="commandname">flac</span>, a command-line program to encode and decode FLAC files</li> - <li><span class="commandname">metaflac</span>, a command-line metadata editor for FLAC files</li> - <li>input plugins for various music players</li> - </ul><br /> + <b>FLAC 1.1.3 released</b> Almost 2 years in the making, FLAC 1.1.3 is a <a href="faq.html#api__release_versioning">major release</a> with improved compression, improved cover art and multichannel support, better recovery for corrupted files, many new features and options in the command-line tools, and several bug fixes. For developers, the decoder and encoder APIs have also been simplified and there is a new <a href="api/group__porting.html">porting guide</a>. See the <a href="changelog.html#flac_1_1_3">changelog entry</a> for complete details. If your locale does not use "." for the decimal point, <a href="documentation_bugs.html">see this note</a>.<br /> <br /> - When we say that FLAC is "Free" it means more than just that it is available at no cost. It means that the specification of the format is fully open to the public to be used for any purpose (the FLAC project reserves the right to set the FLAC specification and certify compliance), and that neither the FLAC format nor any of the implemented encoding/decoding methods are covered by any known patent. It also means that all the source code is available under open-source licenses. It is the first truly open and free lossless audio format. (For more information, see the <a href="license.html">license page</a>.) - </div> - <div class="box_footer"></div> - </div> - - <br /> - - <div class="box"> - <div class="box_title"> - <a name="download">download</a> - </div> - <div class="box_header"></div> - <div class="box_body"> - Visit the <a href="download.html">download page</a> for links to the source code or pre-built binaries. - </div> - <div class="box_footer"></div> - </div> - - <br /> - - <div class="box"> - <div class="box_title"> - <a name="documentation">documentation</a> - </div> - <div class="box_header"></div> - <div class="box_body"> - The documentation is available online as well as in the distributions. The general installation and usage documentation for <span class="commandname">flac</span> and the plugins is <a href="documentation.html">here</a>. For a detailed description of the FLAC format and reference encoder see the <a href="format.html">FLAC format page</a>. - </div> - <div class="box_footer"></div> - </div> - - <br /> - - <div class="box"> - <div class="box_title"> - <a name="id">id registration</a> - </div> - <div class="box_header"></div> - <div class="box_body"> - If you have an application that uses FLAC and would like it to be able to tag FLAC files with custom metadata, visit the <a href="id.html">registration page</a> to register an ID for your application. + <a href="http://winamp.com/player/">Winamp 5.31</a> now includes Nullsoft FLAC plugins for encoding and decoding. The decoder is based on our reference decoder plugin. However the current encoder plugin is based on a pre-release of <a href="http://flake-enc.sourceforge.net/">flake</a> and we <a href="http://www.hydrogenaudio.org/forums/index.php?s=&showtopic=45013&view=findpost&p=443961">recommend to not use it for archival</a> yet.<br /> + <br /> + The new <a href="http://www.neodigits.com/new/body/products/Xline/x5000.asp">Helios X5000</a> HD network media player from Neodigits supports FLAC.<br /> + <br /> + The <a href="http://www.thephiladelphiaorchestra.com/">Philadelphia Orchestra</a> is making many recordings <a href="http://www.losslessaudioblog.com/?p=109">available in FLAC</a>.<br /> + <br /> + <i>last updated 2006-Dec-21</i> </div> <div class="box_footer"></div> </div> @@ -168,23 +111,6 @@ <a href="news.html#20050423">23-Apr-2005</a> :<br />iAUDIO X5 portable supports FLAC and Vorbis<br /><br /> <a href="news.html#20050309">09-Mar-2005</a> :<br />Squeezebox2 supports FLAC on the box<br /><br /> <a href="news.html#20050205">05-Feb-2005</a> :<br />Version 1.1.2 released<br /><br /> - <a href="news.html#20050117">17-Jan-2005</a> :<br />Several new devices support FLAC<br /><br /> - <a href="news.html#20041112">12-Nov-2004</a> :<br />Escient's new FireBall E2-300 supports FLAC<br /><br /> - <a href="news.html#20041102">02-Nov-2004</a> :<br />New Mindawn music store offers FLAC and Vorbis<br /><br /> - <a href="news.html#20041001">01-Oct-2004</a> :<br />Version 1.1.1 released<br /><br /> - <a href="news.html#20040727">27-Jul-2004</a> :<br />The Furthur network now supports FLAC<br /><br /> - <a href="news.html#20040621">21-Jun-2004</a> :<br />Bonnaroo soundboard recordings available in FLAC<br /><br /> - <a href="news.html#20040303">03-Mar-2004</a> :<br />Metallica offers live shows in FLAC<br /><br /> - <a href="news.html#20040203">03-Feb-2004</a> :<br />Charlie Hunter makes select albums available in FLAC<br /><br /> - <a href="news.html#20031119">19-Nov-2003</a> :<br />PhatNoise's new Home Digital Media Player supports FLAC<br /><br /> - <a href="news.html#20031118">18-Nov-2003</a> :<br />Slim's new 'Squeezebox' supports FLAC<br /><br /> - <a href="news.html#20031111">11-Nov-2003</a> :<br />Primus offers live shows in FLAC<br /><br /> - <a href="news.html#20031013">13-Oct-2003</a> :<br />Magnatune catalog available in FLAC<br /><br /> - <a href="news.html#20030811">11-Aug-2003</a> :<br />New Rio Karma supports FLAC<br /><br /> - <a href="news.html#20030623">23-Jun-2003</a> :<br />livephish.com offers FLAC shows<br /><br /> - <a href="news.html#20030209">09-Feb-2003</a> :<br />ReQuest adds FLAC support<br /><br /> - <a href="news.html#20030129">29-Jan-2003</a> :<br />FLAC joins Xiph.org!<br /><br /> - <a href="news.html#20030126">26-Jan-2003</a> :<br />Version 1.1.0 released<br /><br /> <a href="news.html">(all news)</a> </div> <div class="smallbox_footer"></div> @@ -194,6 +120,7 @@ </tr> </table> + <div class="copyright"> <!-- @@@ oh so hacky --> <table> diff --git a/doc/html/goals.html b/doc/html/itunes.html index 0bf70924..a3903727 100644 --- a/doc/html/goals.html +++ b/doc/html/itunes.html @@ -13,7 +13,7 @@ <meta name="keywords" content="free,lossless,audio,codec,encoder,decoder,compression,compressor,archival,archive,archiving,backup,music" /> <link rel="shortcut icon" type="image/x-icon" href="favicon.ico" /> <link rel="stylesheet" type="text/css" href="flac.css" /> - <title>FLAC - goals</title> + <title>FLAC - id</title> </head> <body> @@ -29,12 +29,8 @@ <a href="faq.html">faq</a> | <a href="news.html">news</a> | <a href="download.html">download</a> | - <a href="features.html">features</a> | - goals | - <a href="format.html">format</a> | - <a href="id.html">id</a> | - <a href="comparison.html">comparison</a> | <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | <a href="changelog.html">changelog</a> | <a href="links.html">links</a> | <a href="developers.html">developers</a> @@ -42,52 +38,30 @@ <div class="langbar"> english | - <a href="ru/goals.html">russian</a> + russian </div> <div class="below_nav"></div> <div class="box"> <div class="box_title"> - goals + flac + itunes </div> <div class="box_header"></div> <div class="box_body"> - Since FLAC is an open-source project, it's important to have a set of goals that everyone works to. They may change slightly from time to time but they're a good guideline. Changes should be in line with the goals and should not attempt to embrace any of the anti-goals!<br /> + Would you like iTunes to support FLAC? So would we!<br /> <br /> - <b>Goals</b> - <ul> - <li> - FLAC should be and stay an open format with an open-source reference implementation. - </li> - <li> - FLAC should be lossless. This seems obvious but lossy compression seems to creep into every audio codec. This goal also means that flac should stay archival quality and be truly lossless for all input. Testing of releases should be thorough. - </li> - <li> - FLAC should yield respectable compression, on par or better than other lossless codecs. - </li> - <li> - FLAC should allow at least realtime decoding on even modest hardware. - </li> - <li> - FLAC should support fast sample-accurate seeking. - </li> - <li> - FLAC should allow gapless playback of consecutive streams. This follows from the lossless goal. - </li> - <li> - The FLAC project owes a lot to the many people who have advanced the audio compression field so freely, and aims also to contribute through the open-source development of new ideas. - </li> - </ul> - <b>Anti-goals</b><br /> - <ul> - <li> - Lossy compression. There are already many suitable lossy formats (<a href="http://www.xiph.org/ogg/vorbis/index.html">Ogg Vorbis</a>, <a href="http://www.mp3-tech.org/">MP3</a>, etc.). - </li> - <li> - Copy prevention of any kind. - </li> + Due to the design of iTunes, only Apple can add support for FLAC <a href="#footnote1">[1]</a>. And why wouldn't they? FLAC usage is accelerating, <a href="links.html#music">many bands</a> -- the same hip, influential people Apple courts -- are already distributing music in FLAC format, and users are demanding it in the iTunes forums:<br /> + <ul style="list-style-type: none"> + <li><a href="http://discussions.apple.com/thread.jspa?messageID=784174&#784174">[2]</a> <i>"I have seen a lot of people on live music message boards turn away from the iPod because there are other music players that support FLAC. I am on the verge... and I am an Apple die-hard!"</i></li> + <li><a href="http://discussions.apple.com/thread.jspa?messageID=799873&#799873">[3]</a> <i>"If your source material is FLAC (as many bands have gone this way to distribute online music) your choice is to use another music player ..."</i></li> + <li><a href="http://discussions.apple.com/search.jspa?threadID=&q=flac&objID=c149&dateRange=all&userID=&numResults=30">[4]</a> (many more requests)</li> </ul> + Make your voice heard! <a href="http://www.apple.com/feedback/itunes.html">Fill out the iTunes feedback form</a> (politely!) and let them know. Feel free to also direct them to this page. We at the FLAC project <a href="developers.html">stand ready to help</a> as well.<br /> + <br /> + <br /> + <br /> + <a name="footnote1" />[1] <a href="http://xiph.org/quicktime">XiphQT</a>, through tremendous effort by developers, goes as far as possible in allowing some playback capability via QuickTime. But proper iTunes support -- tag handling, no import delays, etc. -- is not possible.<br /> </div> <div class="box_footer"></div> </div> diff --git a/doc/html/license.html b/doc/html/license.html index 8fe30f47..44a9d3bf 100644 --- a/doc/html/license.html +++ b/doc/html/license.html @@ -29,12 +29,8 @@ <a href="faq.html">faq</a> | <a href="news.html">news</a> | <a href="download.html">download</a> | - <a href="features.html">features</a> | - <a href="goals.html">goals</a> | - <a href="format.html">format</a> | - <a href="id.html">id</a> | - <a href="comparison.html">comparison</a> | <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | <a href="changelog.html">changelog</a> | <a href="links.html">links</a> | <a href="developers.html">developers</a> diff --git a/doc/html/links.html b/doc/html/links.html index 9ca518ce..2cb1140a 100644 --- a/doc/html/links.html +++ b/doc/html/links.html @@ -29,8 +29,8 @@ <a href="faq.html">faq</a> | <a href="news.html">news</a> | <a href="download.html">download</a> | - <a href="comparison.html">comparison</a> | <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | <a href="changelog.html">changelog</a> | links | <a href="developers.html">developers</a> @@ -266,10 +266,14 @@ <ul> <li><a href="http://arson.sourceforge.net/">Arson</a>: KDE ripper/burner</li> <li><a href="http://www.legroom.net/modules.php?op=modload&name=Open_Source&file=index&page=software&app=autoflac">AutoFLAC</a>: automated ripping and encoding to FLAC with EAC (ExactAudioCopy); also has a write mode for burning back to CD for an exact copy</li> + <li><a href="http://cdexos.sourceforge.net/">CDex</a>: ripper for Windows can rip to FLAC via external command</li> <li><a href="http://bach.dynet.com/crip/index.html">crip</a>: console ripper/encoder/tagger</li> <li><a href="http://www.uninformative.com/flacattack/">Flacattack</a>: an all-in-one tool that works with EAC (ExactAudioCopy) to encode a CD image to FLAC, embed the cuesheet, add ReplayGain, create lossy files, etc. all in a customizable directory structure</li> + <li><a href="http://nostatic.org/grip/">grip</a>: ripper for Linux can rip to FLAC via external command</li> + <li><a href="http://www.k3b.org/">K3B</a>: CD/DVD creator for Linux</li> <li><a href="http://mareo.netfirms.com/">MAREO</a> multi-format encoder for EAC</li> <li><a href="http://sbooth.org/Max/">Max</a>, a CD ripper and encoder for OS X</li> + <li><a href="http://omniencoder.autobotcity.net/">Omni Encoder</a>, a graphical multi-format encoder for EAC</li> <li><a href="http://rip.sourceforge.net/">rip</a> command-line ripper/encoder</li> <li><a href="http://www.suwald.com/ripit/ripit.html">RipIT</a>, a console-based front-end to several ripping and encoding tools</li> <li><a href="http://www.uninformative.com/wack/">Wack</a>, the successor to <a href="http://www.uninformative.com/flacattack/">Flacattack</a> which can encode to multiple formats at once</li> @@ -298,7 +302,7 @@ <li><a href="http://ptarmigan.sourceforge.net/">Ptarmigan</a> media parser for XML</li> <li><a href="http://www.icculus.org/SDL_sound/">SDL_sound</a> audio add-on to SDL</li> <li><a href="http://wmptagext.sourceforge.net/">WMP Tag Support Extender</a> plugs in to Windows Media Player to allow access to FLAC tags</li> - <li><a href="http://www.xiph.org/quicktime/">XiphQT</a> component for Quicktime/iTunes that supports Ogg FLAC</li> + <li><a href="http://www.xiph.org/quicktime/">XiphQT</a> component for Quicktime/iTunes that supports Ogg FLAC playback</li> </ul> <b>Scientific, Audio Analysis:</b> <ul> diff --git a/doc/html/news.html b/doc/html/news.html index e89706ae..34133635 100644 --- a/doc/html/news.html +++ b/doc/html/news.html @@ -29,12 +29,8 @@ <a href="faq.html">faq</a> | news | <a href="download.html">download</a> | - <a href="features.html">features</a> | - <a href="goals.html">goals</a> | - <a href="format.html">format</a> | - <a href="id.html">id</a> | - <a href="comparison.html">comparison</a> | <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | <a href="changelog.html">changelog</a> | <a href="links.html">links</a> | <a href="developers.html">developers</a> @@ -490,7 +486,7 @@ <ul> <li>Support for Ogg-FLAC, i.e. <span class="commandname">flac</span> can now read and write FLAC streams using Ogg as the transport layer.</li> <li>New Winamp 3 plugin based on the Wasabi Beta 1 SDK.</li> - <li>New utilities for adding FLAC support to the Monkey's Audio GUI (see <a href="documentation.html#monkey">how</a>).</li> + <li>New utilities for adding FLAC support to the Monkey's Audio GUI (see <a href="documentation_tasks.html#monkey">how</a>).</li> <li>Mac OS X support. The download area now contains an OS X binary release.</li> <li>Mingw32 support.</li> <li>Better handling of MS-specific 'fmt' chunks in WAVE files.</li> diff --git a/doc/html/ogg_mapping.html b/doc/html/ogg_mapping.html index 97dac034..3e9c0f85 100644 --- a/doc/html/ogg_mapping.html +++ b/doc/html/ogg_mapping.html @@ -29,12 +29,8 @@ <a href="faq.html">faq</a> | <a href="news.html">news</a> | <a href="download.html">download</a> | - <a href="features.html">features</a> | - <a href="goals.html">goals</a> | - <a href="format.html">format</a> | - <a href="id.html">id</a> | - <a href="comparison.html">comparison</a> | <a href="documentation.html">documentation</a> | + <a href="comparison.html">comparison</a> | <a href="changelog.html">changelog</a> | <a href="links.html">links</a> | <a href="developers.html">developers</a> |