add bullet item about renaming of metaflac *-vc-* options
[platform/upstream/flac.git] / doc / html / changelog.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <!-- Copyright (c)  2004  Josh Coalson -->
3 <!-- Permission is granted to copy, distribute and/or modify this document -->
4 <!-- under the terms of the GNU Free Documentation License, Version 1.1 -->
5 <!-- or any later version published by the Free Software Foundation; -->
6 <!-- with no invariant sections. -->
7 <!-- A copy of the license can be found at http://www.gnu.org/copyleft/fdl.html -->
8 <HTML>
9 <HEAD>
10         <TITLE>FLAC - changelog</TITLE>
11 </HEAD>
12
13 <BODY MARGINWIDTH="0" MARGINHEIGHT="0" LEFTMARGIN="0" RIGHTMARGIN="0" TOPMARGIN="0" BGCOLOR="#99CC99" TEXT="#000000" LINK="#336699" VLINK="#336699" ALINK="#336699">
14
15 <TABLE BORDER=0 WIDTH="100%" CELLPADDING=1 CELLSPACING=0>
16         <TR>
17                 <TD ALIGN="CENTER" BGCOLOR="#000000"><A HREF="http://flac.sourceforge.net/"><IMG SRC="images/logo130.gif" ALIGN=CENTER ALT="FLAC Logo" BORDER=0 HSPACE=0></a></TD>
18         </TR>
19 </TABLE>
20
21 <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#99CC99"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="25" ALT=""></TD></TR></TABLE>
22
23 <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="2" ALT=""></TD></TR></TABLE>
24
25 <TABLE WIDTH="100%" CELLPADDING=0 CELLSPACING=0 BORDER=0>
26         <TR>
27                 <TD ALIGN="CENTER" BGCOLOR="#D3D4C5">
28                         <TABLE CELLPADDING=0 CELLSPACING=0 BORDER=0>
29                                 <TR>
30                                         <TD HEIGHT=22 BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="index.html">home</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
31                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="faq.html">faq</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
32                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="news.html">news</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
33                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="download.html">download</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
34                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="features.html">features</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
35                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="goals.html">goals</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
36                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="format.html">format</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
37                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="id.html">id</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
38                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="comparison.html">comparison</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
39                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="documentation.html">documentation</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
40                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;changelog&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
41                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="links.html">links</A>&nbsp;&nbsp;</TD><TD BGCOLOR="#D3D4C5" ALIGN=CENTER>|</TD>
42                                         <TD           BGCOLOR="#D3D4C5" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="developers.html">developers</A>&nbsp;&nbsp;</TD>
43                                 </TR>
44                         </TABLE>
45                 </TD>
46         </TR>
47 </TABLE>
48
49 <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="2" ALT=""></TD></TR></TABLE>
50
51 <TABLE WIDTH="100%" CELLPADDING=0 CELLSPACING=0 BORDER=0>
52         <TR>
53                 <TD ALIGN="CENTER" BGCOLOR="#EEEED4">
54                         <TABLE CELLPADDING=0 CELLSPACING=0 BORDER=0>
55                                 <TR>
56                                         <TD HEIGHT=22 BGCOLOR="#EEEED4" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;english&nbsp;&nbsp;</TD><TD BGCOLOR="#EEEED4" ALIGN=CENTER>|</TD>
57                                         <TD           BGCOLOR="#EEEED4" ALIGN=CENTER NOWRAP>&nbsp;&nbsp;<A CLASS="topnav" HREF="ru/changelog.html">russian</A>&nbsp;&nbsp;</TD>
58                                 </TR>
59                         </TABLE>
60                 </TD>
61         </TR>
62 </TABLE>
63
64 <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="2" ALT=""></TD></TR></TABLE>
65
66 <CENTER>
67
68 <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#99CC99"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="15" ALT=""></TD></TR></TABLE>
69
70
71 <TABLE WIDTH="100%" CELLPADDING="5" CELLSPACING="5" BORDER="0">
72 <TR><TD>
73         <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="1" ALT=""></TD></TR></TABLE>
74         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#D3D4C5">
75                 <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
76                 <B><FONT SIZE="+2">changelog</FONT></B>
77                 </FONT></TD></TR>
78         </TABLE>
79         <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="1" ALT=""></TD></TR></TABLE>
80         <TABLE CELLSPACING="0" CELLPADDING="3" WIDTH="100%" BORDER="0" BGCOLOR="#EEEED4">
81         <TR><TD><FONT FACE="Lucida,Verdana,Helvetica,Arial">
82
83         <P>
84                 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.
85         </P>
86
87         <P>
88                 <A NAME="flac_1_1_1"><B>FLAC 1.1.1</B></A>
89         </P>
90         <P>
91         <UL>
92                 <LI>
93                         General:
94                         <UL>
95                                 <LI>Ogg FLAC seeking now works</LI>
96                                 <LI>New PPC optimizations almost double the decoding speed on OS X</LI>
97                                 <LI>A native OS X release thanks to updated Project Builder and autotools files</LI>
98                         </UL>
99                 </LI>
100                 <LI>
101                         FLAC format:
102                         <UL>
103                                 <LI>Made invalid the metadata block type 127 so that audio frames can always be distinguished from metadata by seeing 0xff as the first byte.</LI>
104                         </UL>
105                 </LI>
106                 <LI>
107                         flac:
108                         <UL>
109                                 <LI>Print an error when output file already exists instead of automatically overwriting.</LI>
110                                 <LI>New option <A HREF="documentation.html#flac_options_force"><TT>-f</TT> (<TT>--force</TT>)</A> to force overwriting if the output file already exists.</LI>
111                                 <LI>New option <A HREF="documentation.html#flac_options_cue"><TT>--cue</TT></A> to select a specific section to decode using cuesheet track/index points.</LI>
112                                 <LI>New option <A HREF="documentation.html#flac_options_totally_silent"><TT>--totally-silent</TT></A> to suppress all output.</LI>
113                                 <LI>New (but undocumented) option <TT>--apply-replaygain-which-is-not-lossless</TT> 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>
114                                 <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>
115                                 <LI>When encoding multiple Ogg FLAC streams, <TT>--serial-number</TT> 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>
116                                 <LI>Decoder no longer exits with an error when writing to stdout and the pipe is broken.</LI>
117                                 <LI>Better explanation of common error messages.</LI>
118                                 <LI>Default extension when writing AIFF files is .aif (before, it was .aiff).</LI>
119                                 <LI>Write more common representation of SANE numbers in AIFF files.</LI>
120                                 <LI>Bug fix: calculating ReplayGain on 48kHz streams.</LI>
121                                 <LI>Bug fix: check for supported block alignments in WAVE files.</LI>
122                                 <LI>Bug fix: <A HREF="http://sourceforge.net/tracker/index.php?func=detail&aid=679166&group_id=13478&atid=113478">#679166</A>: flac doesn't respect RIFF subchunk padding byte.</LI>
123                                 <LI>Bug fix: <A HREF="http://sourceforge.net/tracker/index.php?func=detail&aid=828391&group_id=13478&atid=113478">#828391</A>: --add-replay-gain segfaults.</LI>
124                                 <LI>Bug fix: <A HREF="http://sourceforge.net/tracker/index.php?func=detail&aid=851155&group_id=13478&atid=113478">#851155</A>: Can't seek to position in flac file.</LI>
125                                 <LI>Bug fix: <A HREF="http://sourceforge.net/tracker/index.php?func=detail&aid=851756&group_id=13478&atid=113478">#851756</A>: flac --skip --until reads entire file.</LI>
126                                 <LI>Bug fix: <A HREF="http://sourceforge.net/tracker/index.php?func=detail&aid=877122&group_id=13478&atid=113478">#877122</A>: problem parsing cuesheet with CATALOG entry.</LI>
127                                 <LI>Bug fix: <A HREF="http://sourceforge.net/tracker/index.php?func=detail&aid=896057&group_id=13478&atid=113478">#896057</A>: parsing ISRC number from cuesheet.</LI>
128                         </UL>
129                 </LI>
130                 <LI>
131                         metaflac:
132                         <UL>
133                                 <LI>Renamed the tag editing options as follows (the <TT>...-vc-...</TT> options still work but are deprecated):
134                                         <UL>
135                                                 <LI><TT>--show-vc-vendor</TT> becomes <TT>--show-vendor-tag</TT></LI>
136                                                 <LI><TT>--show-vc-field</TT> becomes <TT>--show-tag</TT></LI>
137                                                 <LI><TT>--remove-vc-all</TT> becomes <TT>--remove-all-tags</TT></LI>
138                                                 <LI><TT>--remove-vc-field</TT> becomes <TT>--remove-tag</TT></LI>
139                                                 <LI><TT>--remove-vc-firstfield</TT> becomes <TT>--remove-first-tag</TT></LI>
140                                                 <LI><TT>--set-vc-field</TT> becomes <TT>--set-tag</TT></LI>
141                                                 <LI><TT>--import-vc-from</TT> becomes <TT>--import-tags-from</TT></LI>
142                                                 <LI><TT>--export-vc-to</TT> becomes <TT>--export-tags-to</TT></LI>
143                                         </UL>
144                                 </LI>
145                                 <LI>Better explanation of common error messages.</LI>
146                                 <LI>Bug fix: calculating ReplayGain on 48kHz streams.</LI>
147                                 <LI>Bug fix: incorrect numbers when printing seek points.</LI>
148                         </UL>
149                 </LI>
150                 <LI>
151                         plugins:
152                         <UL>
153                                 <LI>Speed optimization in ReplayGain synthesis.</LI>
154                                 <LI>Speed optimization in XMMS playback.</LI>
155                                 <LI>Support for big-endian architectures in XMMS plugin.</LI>
156                                 <LI>Bug fix: make hard limiter default to off in XMMS plugin.</LI>
157                                 <LI>Bug fix: stream length calculation bug in XMMS plugin, debian bug #200435; <A HREF="http://sourceforge.net/mailarchive/forum.php?thread_id=2733072&forum_id=6312">see also</A>.</LI>
158                                 <LI>Bug fix: small memory leak in XMMS plugin.</LI>
159                         </UL>
160                 </LI>
161                 <LI>
162                         build system:
163                         <UL>
164                                 <LI><TT>ordinals.h</TT> is now static, not a build-generated file anymore.</LI>
165                         </UL>
166                 </LI>
167                 <LI>
168                         libraries:
169                         <UL>
170                                 <LI>libFLAC: PPC+Altivec optimizations of some decoder routines.</LI>
171                                 <LI>libFLAC: Make stream encoder encode the blocksize and sample rate in the frame header if at all possible (not in STREAMINFO), even if subset encoding was not requested.</LI>
172                                 <LI>libFLAC: Bug fix: fixed seek routine where infinite loop could happen when seeking past end of stream.</LI>
173                                 <LI>libFLAC, libFLAC++: added methods to skip single frames, useful for quickly finding frame boundaries (see interface changes below).</LI>
174                                 <LI>libOggFLAC, libOggFLAC++: New seekable-stream and file encoder and decoder APIs to match native FLAC APIs (see interface changes below).</LI>
175                         </UL>
176                 </LI>
177                 <LI>
178                         Interface changes:
179                         <UL>
180                                 <LI>
181                                         libFLAC:
182                                         <UL>
183                                                 <LI><B>Added</B> FLAC__metadata_get_tags()</LI>
184                                                 <LI><B>Added</B> callback-based versions of metadata editing functions:
185                                                         <UL>
186                                                                 <LI>FLAC__metadata_chain_read_with_callbacks()</LI>
187                                                                 <LI>FLAC__metadata_chain_write_with_callbacks()</LI>
188                                                                 <LI>FLAC__metadata_chain_write_with_callbacks_and_tempfile()</LI>
189                                                                 <LI>FLAC__metadata_chain_check_if_tempfile_needed()</LI>
190                                                         </UL>
191                                                 </LI>
192                                                 <LI><B>Added</B> decoder functions for skipping single frames, also useful for quickly finding frame boundaries:
193                                                         <UL>
194                                                                 <LI>FLAC__stream_decoder_skip_single_frame()</LI>
195                                                                 <LI>FLAC__seekable_stream_decoder_skip_single_frame()</LI>
196                                                                 <LI>FLAC__file_decoder_skip_single_frame()</LI>
197                                                         </UL>
198                                                 </LI>
199                                                 <LI><B>Added</B> new required tell callback on seekable stream encoder:
200                                                         <UL>
201                                                                 <LI>FLAC__SeekableStreamEncoderTellStatus and FLAC__SeekableStreamEncoderTellStatusString[]</LI>
202                                                                 <LI>FLAC__SeekableStreamEncoderTellCallback</LI>
203                                                                 <LI>FLAC__seekable_stream_encoder_set_tell_callback()</LI>
204                                                         </UL>
205                                                 </LI>
206                                                 <LI><B>Changed</B> FLAC__SeekableStreamEncoderState by adding FLAC__SEEKABLE_STREAM_ENCODER_TELL_ERROR</LI>
207                                                 <LI><B>Changed</B> Tell callback is now required to initialize seekable stream encoder</LI>
208                                                 <LI><B>Deleted</B> erroneous and unimplemented FLAC__file_decoder_process_remaining_frames()</LI>
209                                         </UL>
210                                 </LI>
211                                 <LI>
212                                         libFLAC++:
213                                         <UL>
214                                                 <LI><B>Added</B> FLAC::Metadata::get_tags()</LI>
215                                                 <LI><B>Added</B> decoder functions for skipping single frames, also useful for quickly finding frame boundaries:
216                                                         <UL>
217                                                                 <LI>FLAC::Decoder::Stream::skip_single_frame()</LI>
218                                                                 <LI>FLAC::Decoder::SeekableStream::skip_single_frame()</LI>
219                                                                 <LI>FLAC::Decoder::File::skip_single_frame()</LI>
220                                                         </UL>
221                                                 </LI>
222                                                 <LI><B>Added</B> encoder functions for setting metadata:
223                                                         <UL>
224                                                                 <LI>FLAC::Encoder::Stream::set_metadata(FLAC::Metadata::Prototype **metadata, unsigned num_blocks)</LI>
225                                                                 <LI>FLAC::Encoder::SeekableStream::set_metadata(FLAC::Metadata::Prototype **metadata, unsigned num_blocks)</LI>
226                                                                 <LI>FLAC::Encoder::File::set_metadata(FLAC::Metadata::Prototype **metadata, unsigned num_blocks)</LI>
227                                                         </UL>
228                                                 </LI>
229                                                 <LI><B>Added</B> new required tell callback on seekable stream encoder:
230                                                         <UL>
231                                                                 <LI>pure virtual FLAC::Encoder::SeekableStream::tell_callback()</LI>
232                                                         </UL>
233                                                 </LI>
234                                                 <LI><B>Changed</B> Tell callback is now required to initialize seekable stream encoder</LI>
235                                                 <LI><B>Deleted</B> the following methods:
236                                                         <UL>
237                                                                 <LI>FLAC::Decoder::Stream::State::resolved_as_cstring()</LI>
238                                                                 <LI>FLAC::Encoder::Stream::State::resolved_as_cstring()</LI>
239                                                         </UL>
240                                                 </LI>
241                                         </UL>
242                                 </LI>
243                                 <LI>
244                                         libOggFLAC:
245                                         <UL>
246                                                 <LI><B>Added</B> OggFLAC__SeekableStreamDecoder interface</LI>
247                                                 <LI><B>Added</B> OggFLAC__FileDecoder interface</LI>
248                                                 <LI><B>Added</B> OggFLAC__SeekableStreamEncoder interface</LI>
249                                                 <LI><B>Added</B> OggFLAC__FileEncoder interface</LI>
250                                                 <LI><B>Added</B> OggFLAC__stream_decoder_get_resolved_state_string()</LI>
251                                                 <LI><B>Added</B> OggFLAC__stream_encoder_get_resolved_state_string()</LI>
252                                                 <LI><B>Added</B> OggFLAC__stream_encoder_set_metadata_callback()</LI>
253                                                 <LI><B>Changed</B> OggFLAC__StreamDecoderState by adding OggFLAC__STREAM_DECODER_END_OF_STREAM</LI>
254                                         </UL>
255                                 </LI>
256                                 <LI>
257                                         libOggFLAC++:
258                                         <UL>
259                                                 <LI><B>Added</B> OggFLAC::Decoder::SeekableStream interface</LI>
260                                                 <LI><B>Added</B> OggFLAC::Decoder::File interface</LI>
261                                                 <LI><B>Added</B> OggFLAC::Encoder::SeekableStream interface</LI>
262                                                 <LI><B>Added</B> OggFLAC::Encoder::File interface</LI>
263                                                 <LI><B>Added</B> OggFLAC::Decoder::Stream::get_resolved_state_string()</LI>
264                                                 <LI><B>Added</B> OggFLAC::Encoder::Stream::get_resolved_state_string()</LI>
265                                                 <LI><B>Added</B> pure virtual OggFLAC::Encoder::Stream::metadata_callback()</LI>
266                                         </UL>
267                                 </LI>
268                         </UL>
269                 </LI>
270         </UL>
271         </P>
272
273         </FONT>
274         </TD></TR>
275         </TABLE>
276         <TABLE WIDTH="100%" CELLPADDING="0" CELLSPACING="0" BORDER="0"><TR BGCOLOR="#000000"><TD><IMG SRC="images/1x1.gif" WIDTH="1" HEIGHT="1" ALT=""></TD></TR></TABLE>
277 </TD></TR>
278 </TABLE>
279
280
281 </CENTER>
282
283 <P>&nbsp;Copyright (c) 2004 Josh Coalson</P>
284
285 </BODY>
286 </HTML>