FLAC - changelog

changelog

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.

FLAC 1.1.3

General:
- (none)
FLAC format:
- (none)
Ogg FLAC format:
- (none)
flac:
- Add support for encoding from non-compressed AIFF-C (SF #1090933).
- Importing of non-CDDA-compliant cuesheets now only issues a warning, not an error (see here).
- Fixed a bug in cuesheet parsing where it would return an error if the last line of the cuesheet did not end with a newline.
- Fixed a bug with --sector-align where appended samples were not always totally silent (SF #1237707).
- Fixed bugs with --sector-align and raw input files.
metaflac:
- Importing of non-CDDA-compliant cuesheets now issues a warning.
plugins:
- Fixed UTF-8 decoder to disallow non-shortest-form and surrogate sequences (see here).
build system:
- (none)
libraries:
- libFLAC: Fixed a bug in cuesheet parsing where it would return an error if the last line of the cuesheet did not end with a newline.
- libFLAC: Fixed UTF-8 decoder to disallow non-shortest-form and surrogate sequences (see here).
Interface changes:
- libFLAC:
  - (none)
- libFLAC++:
  - (none)
- libOggFLAC:
  - (none)
- libOggFLAC++:
  - (none)

FLAC 1.1.2

General:
- Sped up decoding by a few percent overall.
- Sped up encoding when not using LPC (i.e. when using flac options -0, -1, -2, or -l 0).
- Fixed a decoding bug that could cause sync errors with some ID3v1-tagged FLAC files.
- Added HTML documentation for metaflac.
FLAC format:
- (none)
Ogg FLAC format:
- (none)
flac:
- New option --input-size to manually specify the input size when encoding raw samples from stdin.
metaflac:
- (none)
plugins:
- Added support for HTTP streaming in XMMS plugin. NOTE: there is a bug in the XMMS mpg123 plugin that hijacks FLAC streams; to fix it you will need to add the '.flac' extension to the list of exceptions in Input/mpg123/mpg123.c:is_our_file() in the XMMS sources and recompile.
build system:
- (none)
libraries:
- libFLAC: Sped up Rice block decoding in the bitbuffer, resulting in decoding speed gains of a few percent.
- libFLAC: Sped up encoding when not using LPC (i.e. max_lpc_order == 0).
- libFLAC: Trailing NUL characters maintained on Vorbis comment entries so they can be treated like C strings.
- libFLAC: More FLAC tag (i.e. Vorbis comment) validation.
- libFLAC: Fixed a bug in the logic that determines the frame or sample number in a frame header; the bug could cause sync errors with some ID3v1-tagged FLAC files.
- libFLAC, libOggFLAC: Can now be compiled to use only integer instructions, including encoding. The decoder is almost completely integer anyway but there were a couple places that needed a fixed-point replacement. There is no fixed-point version of LPC analysis yet, so if libFLAC is compiled integer-only, the encoder will behave as if the max LPC order is 0 (i.e. used fixed predictors only). LPC decoding is supported in all cases as it always was integer-only.
Interface changes:
- libFLAC:
  - Changed: Metadata object interface now maintains a trailing NUL on Vorbis comment entries for convenience.
  - Changed: Metadata object interface now validates all Vorbis comment entries on input and returns false if an entry does not conform to the Vorbis comment spec.
  - Added FLAC__format_vorbiscomment_entry_name_is_legal()
  - Added FLAC__format_vorbiscomment_entry_value_is_legal()
  - Added FLAC__format_vorbiscomment_entry_is_legal()
  - Added FLAC__metadata_object_vorbiscomment_entry_from_name_value_pair()
  - Added FLAC__metadata_object_vorbiscomment_entry_to_name_value_pair()
  - Changed the signature of FLAC__metadata_object_vorbiscomment_entry_matches(): the first argument is now FLAC__StreamMetadata_VorbisComment_Entry entry (was const FLAC__StreamMetadata_VorbisComment_Entry *entry), i.e. entry is now pass-by-value.
- libFLAC++:
  - Changed: Metadata object interface now maintains a trailing NUL on Vorbis comment values for convenience.
  - Changed: Metadata object interface now validates all Vorbis comment entries on input and returns false if an entry does not conform to the Vorbis comment spec.
  - Changed: All Metadata objects' operator=() methods now return a reference to themselves.
  - Added methods to FLAC::Metadata::VorbisComment::Entry for setting comment values from null-terminated strings:
    - Entry(const char *field)
    - Entry(const char *field_name, const char *field_value)
    - bool set_field(const char *field)
    - bool set_field_value(const char *field_value)
  - Changed the signature of FLAC::Metadata::VorbisComment::get_vendor_string() and FLAC::Metadata::VorbisComment::set_vendor_string() to use a UTF-8, NUL-terminated string const FLAC__byte * for the vendor string instead of FLAC::Metadata::VorbisComment::Entry.
  - Added FLAC::Metadata::*::assign() to all Metadata objects.
  - Added bool FLAC::Metadata::get_tags(const char *filename, VorbisComment &tags)
- libOggFLAC:
  - (none)
- libOggFLAC++:
  - (none)

FLAC 1.1.1

General:
- Ogg FLAC seeking now works
- New optimizations almost double the decoding speed on PowerPC (e.g. Mac G4/G5)
- A native OS X release thanks to updated Project Builder and autotools files
FLAC format:
- Made invalid the metadata block type 127 so that audio frames can always be distinguished from metadata by seeing 0xff as the first byte. (This was also required for the Ogg FLAC mapping.)
Ogg FLAC format:
- First official FLAC->Ogg bitstream mapping standardized (see new FLAC-to-Ogg mapping specification). See the documentation for the --ogg switch about having to re-encode older Ogg FLAC files.
flac:
- Print an error when output file already exists instead of automatically overwriting.
- New option -f (--force) to force overwriting if the output file already exists.
- New option --cue to select a specific section to decode using cuesheet track/index points.
- New option --totally-silent to suppress all output.
- New (but undocumented) option --apply-replaygain-which-is-not-lossless which applies ReplayGain to the decoded output. See this thread for usage and caveats.
- When encoding to Ogg FLAC, use a random serial number (instead of 0 as was done before) when a serial number is not specified.
- When encoding multiple Ogg FLAC streams, --serial-number 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).
- Decoder no longer exits with an error when writing to stdout and the pipe is broken.
- Better explanation of common error messages.
- Default extension when writing AIFF files is .aif (before, it was .aiff).
- Write more common representation of SANE numbers in AIFF files.
- Bug fix: calculating ReplayGain on 48kHz streams.
- Bug fix: check for supported block alignments in WAVE files.
- Bug fix: "offset" field in AIFF SSND chunk properly handled.
- Bug fix: #679166: flac doesn't respect RIFF subchunk padding byte.
- Bug fix: #828391: --add-replay-gain segfaults.
- Bug fix: #851155: Can't seek to position in flac file.
- Bug fix: #851756: flac --skip --until reads entire file.
- Bug fix: #877122: problem parsing cuesheet with CATALOG entry.
- Bug fix: #896057: parsing ISRC number from cuesheet.
metaflac:
- Renamed the tag editing options as follows (the ...-vc-... options still work but are deprecated):
  - --show-vc-vendor becomes --show-vendor-tag
  - --show-vc-field becomes --show-tag
  - --remove-vc-all becomes --remove-all-tags
  - --remove-vc-field becomes --remove-tag
  - --remove-vc-firstfield becomes --remove-first-tag
  - --set-vc-field becomes --set-tag
  - --import-vc-from becomes --import-tags-from
  - --export-vc-to becomes --export-tags-to
- Better explanation of common error messages.
- Bug fix: calculating ReplayGain on 48kHz streams.
- Bug fix: incorrect numbers when printing seek points.
plugins:
- Speed optimization in ReplayGain synthesis.
- Speed optimization in XMMS playback.
- Support for big-endian architectures in XMMS plugin.
- Removed support for ID3 tags.
- Bug fix: make hard limiter default to off in XMMS plugin.
- Bug fix: stream length calculation bug in XMMS plugin, debian bug #200435; see also.
- Bug fix: small memory leak in XMMS plugin.
build system:
- ordinals.h is now static, not a build-generated file anymore.
libraries:
- libFLAC: PPC+Altivec optimizations of some decoder routines.
- 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.
- libFLAC: Bug fix: fixed seek routine where infinite loop could happen when seeking past end of stream.
- libFLAC, libFLAC++: added methods to skip single frames, useful for quickly finding frame boundaries (see interface changes below).
- libOggFLAC, libOggFLAC++: New seekable-stream and file encoder and decoder APIs to match native FLAC APIs (see interface changes below).
Interface changes:
- libFLAC:
  - Added FLAC__metadata_get_tags()
  - Added callback-based versions of metadata editing functions:
    - FLAC__metadata_chain_read_with_callbacks()
    - FLAC__metadata_chain_write_with_callbacks()
    - FLAC__metadata_chain_write_with_callbacks_and_tempfile()
    - FLAC__metadata_chain_check_if_tempfile_needed()
  - Added decoder functions for skipping single frames, also useful for quickly finding frame boundaries:
    - FLAC__stream_decoder_skip_single_frame()
    - FLAC__seekable_stream_decoder_skip_single_frame()
    - FLAC__file_decoder_skip_single_frame()
  - Added new required tell callback on seekable stream encoder:
    - FLAC__SeekableStreamEncoderTellStatus and FLAC__SeekableStreamEncoderTellStatusString[]
    - FLAC__SeekableStreamEncoderTellCallback
    - FLAC__seekable_stream_encoder_set_tell_callback()
  - Changed FLAC__SeekableStreamEncoderState by adding FLAC__SEEKABLE_STREAM_ENCODER_TELL_ERROR
  - Changed Tell callback is now required to initialize seekable stream encoder
  - Deleted erroneous and unimplemented FLAC__file_decoder_process_remaining_frames()
- libFLAC++:
  - Added FLAC::Metadata::get_tags()
  - Added decoder functions for skipping single frames, also useful for quickly finding frame boundaries:
    - FLAC::Decoder::Stream::skip_single_frame()
    - FLAC::Decoder::SeekableStream::skip_single_frame()
    - FLAC::Decoder::File::skip_single_frame()
  - Added encoder functions for setting metadata:
    - FLAC::Encoder::Stream::set_metadata(FLAC::Metadata::Prototype **metadata, unsigned num_blocks)
    - FLAC::Encoder::SeekableStream::set_metadata(FLAC::Metadata::Prototype **metadata, unsigned num_blocks)
    - FLAC::Encoder::File::set_metadata(FLAC::Metadata::Prototype **metadata, unsigned num_blocks)
  - Added new required tell callback on seekable stream encoder:
    - pure virtual FLAC::Encoder::SeekableStream::tell_callback()
  - Changed Tell callback is now required to initialize seekable stream encoder
  - Deleted the following methods:
    - FLAC::Decoder::Stream::State::resolved_as_cstring()
    - FLAC::Encoder::Stream::State::resolved_as_cstring()
- libOggFLAC:
  - Added OggFLAC__SeekableStreamDecoder interface
  - Added OggFLAC__FileDecoder interface
  - Added OggFLAC__SeekableStreamEncoder interface
  - Added OggFLAC__FileEncoder interface
  - Added OggFLAC__stream_decoder_get_resolved_state_string()
  - Added OggFLAC__stream_encoder_get_resolved_state_string()
  - Added OggFLAC__stream_encoder_set_metadata_callback()
  - Changed OggFLAC__StreamDecoderState by adding OggFLAC__STREAM_DECODER_END_OF_STREAM
- libOggFLAC++:
  - Added OggFLAC::Decoder::SeekableStream interface
  - Added OggFLAC::Decoder::File interface
  - Added OggFLAC::Encoder::SeekableStream interface
  - Added OggFLAC::Encoder::File interface
  - Added OggFLAC::Decoder::Stream::get_resolved_state_string()
  - Added OggFLAC::Encoder::Stream::get_resolved_state_string()
  - Added pure virtual OggFLAC::Encoder::Stream::metadata_callback()