Commit 93fbb4b0 authored by Martijn van Beurden's avatar Martijn van Beurden Committed by Erik de Castro Lopo

Various documentation fixes, merge with html docs

The html documentation was diff'ed to the current website pages
and all difference were merged into the page they weren't yet
incorporated. This includes lots of small fixes and
improvements.
Signed-off-by: default avatarErik de Castro Lopo <erikd@mega-nerd.com>
parent a4d3be5c
......@@ -79,9 +79,9 @@
<li>
flac:
<ul>
<li>Added support for encoding from and decoding to the RF64 format, and a new corresponding option <span class="argument"><a href="#flac_options_force_rf64_format">--force-rf64-format</a></span>. (<a href="http://sourceforge.net/p/flac/feature-requests/78/">SF #1762502</a>). <span class="argument"><a href="documentation_tools_flac.html#flac_options_keep_foreign_metadata">--keep-foreign-metadata</a></span> is also supported.</li>
<li>Added support for encoding from and decoding to the Sony Wave64 format, and a new corresponding option <span class="argument"><a href="#flac_options_force_wave64_format">--force-wave64-format</a></span>. (<a href="http://sourceforge.net/p/flac/feature-requests/79/">SF #1769582</a>). <span class="argument"><a href="documentation_tools_flac.html#flac_options_keep_foreign_metadata">--keep-foreign-metadata</a></span> is also supported.</li>
<li>Added new options <span class="argument"><a href="documentation_tools_flac.html#flac_options_preserve_modtime">--preserve-modtime</a></span> and <span class="argument"><a href="documentation_tools_flac.html#flac_options_no_preserve_modtime">--no-preserve-modtime</a></span> to specify whether or not output files should copy the timestamp and permissions from their input files. The default is <span class="argument"><a href="documentation_tools_flac.html#flac_options_preserve_modtime">--preserve-modtime</a></span> as in previous versions. (<a href="http://sourceforge.net/p/flac/feature-requests/85/">SF #1805428</a>).</li>
<li>Added support for encoding from and decoding to the RF64 format, and a new corresponding option <span class="argument"><a href="documentation_tools_flac.html#flac_options_force_rf64_format">--force-rf64-format</a></span>. (<a href="http://sourceforge.net/p/flac/feature-requests/78/">SF #1762502</a>). <span class="argument"><a href="documentation_tools_flac.html#flac_options_keep_foreign_metadata">--keep-foreign-metadata</a></span> is also supported.</li>
<li>Added support for encoding from and decoding to the Sony Wave64 format, and a new corresponding option <span class="argument"><a href="documentation_tools_flac.html#flac_options_force_wave64_format">--force-wave64-format</a></span>. (<a href="http://sourceforge.net/p/flac/feature-requests/79/">SF #1769582</a>). <span class="argument"><a href="documentation_tools_flac.html#flac_options_keep_foreign_metadata">--keep-foreign-metadata</a></span> is also supported.</li>
<li>Added new options <span class="argument"><a href="documentation_tools_flac.html#flac_options_preserve_modtime">--preserve-modtime</a></span> and <span class="argument"><a href="documentation_tools_flac.html#negative_options">--no-preserve-modtime</a></span> to specify whether or not output files should copy the timestamp and permissions from their input files. The default is <span class="argument"><a href="documentation_tools_flac.html#flac_options_preserve_modtime">--preserve-modtime</a></span> as in previous versions. (<a href="http://sourceforge.net/p/flac/feature-requests/85/">SF #1805428</a>).</li>
<li>Allow MM:SS:FF and MM:SS.SS time formats in non-CD-DA cuesheets. (<a href="http://sourceforge.net/p/flac/feature-requests/95/">SF #1947353</a>, <a href="http://sourceforge.net/p/flac/bugs/338/">SF #2182432</a>)</li>
<li>The <span class="argument"><a href="documentation_tools_flac.html#flac_options_sector_align">--sector-align</a></span> option of <span class="commandname">flac</span> has been deprecated and may not exist in future versions. <a href="http://www.etree.org/shnutils/shntool/">shntool</a> provides similar functionality. (<a href="http://sourceforge.net/p/flac/feature-requests/86/">SF #1805946</a>)</li>
<li>Improved error message when user attempts to decode a non-FLAC file (<a href="http://sourceforge.net/p/flac/bugs/341/">SF #2222789</a>).</li>
......@@ -277,7 +277,7 @@
<li>
FLAC format:
<ul>
<li>One of the reserved bits in the FLAC frame header has been assigned for future use; make sure to refer to the <a href="http://flac.sourceforge.net/api/group__porting__1__1__4__to__1__2__0.html">porting guide</a> if you parse FLAC streams manually.</li>
<li>One of the reserved bits in the FLAC frame header has been assigned for future use; make sure to refer to the <a href="api/group__porting__1__1__4__to__1__2__0.html">porting guide</a> if you parse FLAC streams manually.</li>
</ul>
</li>
<li>
......@@ -320,7 +320,7 @@
</ul>
</li>
<li>
Interface changes (see also the <a href="http://flac.sourceforge.net/api/group__porting__1__1__4__to__1__2__0.html">porting guide</a> for specific instructions on porting to FLAC 1.2.0):
Interface changes (see also the <a href="api/group__porting__1__1__4__to__1__2__0.html">porting guide</a> for specific instructions on porting to FLAC 1.2.0):
<ul>
<li>
libFLAC:
......@@ -546,7 +546,7 @@
</ul>
</li>
<li>
Interface changes (see also the <a href="http://flac.sourceforge.net/api/group__porting__1__1__2__to__1__1__3.html">porting guide</a> for specific instructions on porting to FLAC 1.1.3):
Interface changes (see also the <a href="api/group__porting__1__1__2__to__1__1__3.html">porting guide</a> for specific instructions on porting to FLAC 1.1.3):
<ul>
<li>
all libraries;
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - comparison</title>
</head>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - developers</title>
</head>
......@@ -60,7 +59,6 @@
<li><a href="https://git.xiph.org/?p=flac.git;a%3Dsummary">Git access</a> - for checking out the source code.</li>
<li><a href="http://sourceforge.net/p/flac/bugs/">Bug Tracker</a> - to submit bug reports and patches</li>
</ul>
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>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - documentation</title>
</head>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - documentation</title>
</head>
......@@ -72,9 +71,7 @@
<div class="box_body">
To report a bug, please go to the <a href="http://sourceforge.net/p/flac/bugs/">FLAC bug tracker</a> (or appropriately the <a href="http://sourceforge.net/p/flac/feature-requests/">feature request tracker</a>, <a href="http://sourceforge.net/p/flac/patches/">patch page</a>, or <a href="http://sourceforge.net/p/flac/support-requests/">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.
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.
</div>
<div class="box_footer"></div>
</div>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - developers</title>
</head>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - documentation</title>
</head>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - documentation</title>
</head>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - documentation</title>
</head>
......
This diff is collapsed.
This diff is collapsed.
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - download</title>
</head>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - faq</title>
</head>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - features</title>
</head>
......@@ -88,7 +87,7 @@
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/vorbis/">Vorbis</a>, <a href="http://www.musepack.net/">MPC</a>, and <a href="http://www.mp3-tech.org/">MP3</a> (see <a href="http://lame.sourceforge.net/">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://xiph.org/vorbis/">Vorbis</a>, <a href="http://www.musepack.net/">MPC</a>, and <a href="http://www.mp3-tech.org/">MP3</a> (see <a href="http://lame.sourceforge.net/">LAME</a> for an excellent open-source implementation).
</li>
<li>
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.
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - format</title>
</head>
......@@ -1117,7 +1116,7 @@
&lt;1&gt;
</td>
<td>
Reserved:<br />
Reserved: <a href="#frame_header_notes">[1]</a><br />
<ul>
<li>
<tt>0</tt> : mandatory value
......@@ -1133,7 +1132,7 @@
&lt;1&gt;
</td>
<td>
Blocking strategy:<br />
Blocking strategy: <a href="#frame_header_notes">[2]</a> <a href="#frame_header_notes">[3]</a><br />
<ul>
<li>
<tt>0</tt> : fixed-blocksize stream; frame header encodes the frame number
......@@ -1321,9 +1320,9 @@
</td>
<td>
if(variable blocksize)<br />
&nbsp;&nbsp;&nbsp;&lt;8-56&gt;:"UTF-8" coded sample number (decoded number is 36 bits)<br />
&nbsp;&nbsp;&nbsp;&lt;8-56&gt;:"UTF-8" coded sample number (decoded number is 36 bits) <a href="#frame_header_notes">[4]</a><br />
else<br />
&nbsp;&nbsp;&nbsp;&lt;8-48&gt;:"UTF-8" coded frame number (decoded number is 31 bits)
&nbsp;&nbsp;&nbsp;&lt;8-48&gt;:"UTF-8" coded frame number (decoded number is 31 bits) <a href="#frame_header_notes">[4]</a>
</td>
</tr>
<tr>
......@@ -1356,8 +1355,11 @@
<td>
</td>
<td bgcolor="#F4F4CC">
<font size="+1">NOTES</font><br />
<ul>
<a name="frame_header_notes"><font size="+1">NOTES</font></a><br />
<ol>
<li>
This bit must remain reserved for <tt>0</tt> in order for a FLAC frame's initial 15 bits to be distinguishable from the start of an MPEG audio frame (<a href="http://lists.xiph.org/pipermail/flac-dev/2008-December/002607.html">see also</a>).
</li>
<li>
The "blocking strategy" bit must be the same throughout the entire stream.
</li>
......@@ -1367,7 +1369,7 @@
<li>
The "UTF-8" coding used for the sample/frame number is the same variable length code used to store compressed UCS-2, extended to handle larger input.
</li>
</ul>
</ol>
</td>
</tr>
</table>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - id</title>
</head>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - itunes</title>
</head>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - license</title>
</head>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - links</title>
</head>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - news</title>
......
......@@ -13,7 +13,6 @@
<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" />
<link rel="alternate" type="application/atom+xml" title="FLAC News" href="feeds/news-atom1.xml"/>
<title>FLAC - ogg mapping</title>
</head>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment