You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
StreamDecoder: decodes native FLAC, raw frames or Ogg FLAC from any std::io::Read, one DecodedBlock (a frame, or gap silence) at a time, so
memory stays bounded for long streams and untrusted input. Chained Ogg links
via next_link; the header (StreamHeader), gaps and MD5 result are available
as it goes. Frames over 16 MiB (the STREAMINFO limit) are rejected.
decode_with with DecodeOptions { max_samples }: decode into memory, but fail
with DecodeError::LimitExceeded before the output passes the limit. A small
file can otherwise legitimately expand to gigabytes (measured: 36 bytes per
2 MiB of silence, 72 bytes to 84 MB through a filled gap).
Encoder input validation (EncodeError): Encoder::try_new and try_encode, try_encode_frames, try_encode_with_metadata, try_encode_ogg
reject what libFLAC rejects — channels outside 1–8, bit depths outside 4–32,
sample rates above 1 048 575 Hz, block sizes outside 16–65535, samples that do
not fit the bit depth, input not a whole number of samples per channel, and
metadata libFLAC's init refuses (duplicate SEEKTABLE or VORBIS_COMMENT,
unsorted seek points, illegal cue sheets or pictures) or the format cannot hold
(blocks of 16 MiB or more, more than 255 cue sheet tracks or index points,
Vorbis comments that are not NAME=value).
Every bit depth from 4 to 32, in the encoder (byte-identical to libFLAC) and the
decoder.
truncated on DecodedStream, DecodedFrames, SeekResult and StreamDecoder::truncated() (see below).
Fuzz targets (fuzz/, cargo-fuzz): decoder robustness, encoder round trips,
and differential encoding and decoding against libFLAC.
Changed
Input that ends in the middle of a frame (or Ogg page) ends the stream after
the last complete frame, as in libFLAC, instead of failing; truncated says so
and the MD5 check fails. Junk or damaged pages between Ogg pages are skipped, as
libogg does.
The decoder reconstructs samples with libFLAC's arithmetic (32-bit, wrapping,
where libFLAC uses 32 bits), so damaged frames with a valid CRC decode to the
same samples, and it checks frame and subframe headers as libFLAC does
(reserved bits, invalid UTF-8 numbers, block size 65536, reserved subframe
types, a set padding bit, predictor orders not below the block size; a frame
number counts as a sample number when STREAMINFO's block sizes differ, zero
padding before the CRC-16, Rice quotients that fit 32 bits). Invalid header
fields that libFLAC only rejects once the header is complete count as truncation
if the input ends first.
Metadata and stream start as in libFLAC: a SEEKTABLE whose length is not a
multiple of 18, or an APPLICATION block shorter than 4 bytes, stops decoding; a
stream without STREAMINFO is decoded like raw frames; ID3v2 tags before fLaC
are skipped; junk before the stream start is skipped (find_metadata_).
Ogg FLAC is decoded as libFLAC does: the packets of the FLAC logical stream are
concatenated (mapping headers stripped) and parsed as a native stream, with
libogg's handling of sequence gaps and continued packets. A lost metadata page
therefore has libFLAC's effect. These rules were found by differential
fuzzing; every finding so far decodes as in libFLAC.
Encoder::new and the encode* methods panic with the EncodeError on
invalid settings or input. Before, they wrote a corrupt stream or decoded to
different samples without notice.
Decoding stops at STREAMINFO's sample count when it is set: data after the
declared end is no longer read (before, it was decoded and then discarded, and
trailing garbage made decoding fail).
The whole-buffer decode functions run on StreamDecoder.
Fixed
Samples outside the bit depth were encoded without error and decoded to
different values; metadata blocks of 16 MiB or more overflowed their length
field and corrupted the stream. Both are now rejected.
The decoder rejected valid FLAC at bit depths other than 8/12/16/20/24/32 (frame
headers that defer the depth to STREAMINFO), e.g. libFLAC's 18- or 28-bit
output.
A total sample count beyond STREAMINFO's 36 bits is written as 0 ("unknown"),
as in libFLAC.
The decoder no longer panics on malformed input. It now rejects what libFLAC
rejects (wasted bits not below the bit depth, residual partitions smaller than
the predictor order or not dividing the block, reserved coding methods, FIXED
orders and LPC precisions, negative LPC shifts) and uses wrapping arithmetic
where garbage can overflow; such input makes decode* return None. Found by
fuzzing; tests/malformed_input.rs decodes 30 000 mutated streams in CI.
Development
CI runs with a read-only token, actions are pinned to commit SHAs and kept
current by Dependabot, and oracle/fetch-sources.sh refuses libFLAC/libogg
checkouts that are not at the expected commits.