reorganize to be more novice-friendly, add more docs
[flac.git] / doc / html / changelog.html
index 35c5a78..5d24763 100644 (file)
        &nbsp;<a href="faq.html">faq</a>&nbsp;&nbsp;|
        &nbsp;<a href="news.html">news</a>&nbsp;&nbsp;|
        &nbsp;<a href="download.html">download</a>&nbsp;&nbsp;|
-       &nbsp;<a href="features.html">features</a>&nbsp;&nbsp;|
-       &nbsp;<a href="goals.html">goals</a>&nbsp;&nbsp;|
-       &nbsp;<a href="format.html">format</a>&nbsp;&nbsp;|
-       &nbsp;<a href="id.html">id</a>&nbsp;&nbsp;|
-       &nbsp;<a href="comparison.html">comparison</a>&nbsp;&nbsp;|
        &nbsp;<a href="documentation.html">documentation</a>&nbsp;&nbsp;|
+       &nbsp;<a href="comparison.html">comparison</a>&nbsp;&nbsp;|
        &nbsp;changelog&nbsp;&nbsp;|
        &nbsp;<a href="links.html">links</a>&nbsp;&nbsp;|
        &nbsp;<a href="developers.html">developers</a>&nbsp;
        </div>
        <div class="box_header"></div>
        <div class="box_body">
-               This is an informal changelog, a summary of changes in each release.  Particulary important for developers is the precise description of changes to the library interfaces.  See also the <a href="http://flac.sourceforge.net/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 />
+
+<!--
+               <a name="flac_1_1_4"><b>FLAC 1.1.4</b></a>
+
+               <br />
+
+               <ul>
+                       <li>
+                               General:
+                               <ul>
+                                       <li>(none)</li>
+                               </ul>
+                       </li>
+                       <li>
+                               FLAC format:
+                               <ul>
+                                       <li>(none)</li>
+                               </ul>
+                       </li>
+                       <li>
+                               Ogg FLAC format:
+                               <ul>
+                                       <li>(none)</li>
+                               </ul>
+                       </li>
+                       <li>
+                               flac:
+                               <ul>
+                                       <li>Fixed a bug that caused suboptimal default compression settings in some locales (<a href="https://sourceforge.net/tracker/index.php?func=detail&amp;aid=1608883&amp;group_id=13478&amp;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&amp;aid=1615019&amp;group_id=13478&amp;atid=113478">SF #1615019</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&amp;aid=1615391&amp;group_id=13478&amp;atid=113478">SF #1615391</a>).</li>
+                               </ul>
+                       </li>
+                       <li>
+                               metaflac:
+                               <ul>
+                                       <li>(none)</li>
+                               </ul>
+                       </li>
+                       <li>
+                               plugins:
+                               <ul>
+                                       <li>(none)</li>
+                               </ul>
+                       </li>
+                       <li>
+                               build system:
+                               <ul>
+                                       <li>Fixed a makefile linkage bug with libogg (<a href="http://sourceforge.net/tracker/index.php?func=detail&amp;aid=1611414&amp;group_id=13478&amp;atid=113478">SF #1611414</a>).</li>
+                               </ul>
+                       </li>
+                       <li>
+                               libraries:
+                               <ul>
+                                       <li>Fixed a bug with default apodization settings that were erroneous in some locales (<a href="https://sourceforge.net/tracker/index.php?func=detail&amp;aid=1608883&amp;group_id=13478&amp;atid=113478">SF #1608883</a>).</li>
+                               </ul>
+                       </li>
+                       <li>
+                               Interface changes (see also the <a href="http://flac.sourceforge.net/api/group__porting__1__1__3__to__1__1__4.html">porting guide</a> for specific instructions on porting to FLAC 1.1.4):
+                               <ul>
+                                       <li>
+                                               all libraries;
+                                               <ul>
+                                                       <li>(none)</li>
+                                               </ul>
+                                       </li>
+                                       <li>
+                                               libFLAC:
+                                               <ul>
+                                                       <li>(none)</li>
+                                               </ul>
+                                       </li>
+                                       <li>
+                                               libFLAC++:
+                                               <ul>
+                                                       <li>(none)</li>
+                                               </ul>
+                                       </li>
+                               </ul>
+                       </li>
+               </ul>
 
                <br />
 
+-->
                <a name="flac_1_1_3"><b>FLAC 1.1.3</b></a>
 
                <br />
                                        <li>Better multichannel support</li>
                                        <li>Large file (&gt;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>
                        <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&amp;atid=113478&amp;aid=1090933&amp;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&amp;aid=1493725&amp;group_id=13478&amp;atid=113478">SF #1493725</a>).</li>
                                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&amp;aid=1272825&amp;group_id=13478&amp;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&amp;aid=1272825&amp;group_id=13478&amp;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>
                                        <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>
                        <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>
                        <li>
                                Ogg FLAC format:
                                <ul>
-                                       <li>First official FLAC-&gt;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-&gt;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&amp;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>
        <div class="box_footer"></div>
 </div>
 
+
 <div class="copyright">
        <!-- @@@ oh so hacky -->
        <table>