mirror of
https://github.com/Serial-ATA/lofty-rs
synced 2024-12-14 06:32:33 +00:00
553d16fa88
This also makes property reading take `ParsingMode` into account.
572 lines
31 KiB
Markdown
572 lines
31 KiB
Markdown
# Changelog
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
## [Unreleased]
|
|
|
|
## Added
|
|
- **ID3v2**: Support for "RVA2", "OWNE", "ETCO", and "PRIV" frames through
|
|
`id3::v2::{RelativeVolumeAdjustmentFrame, OwnershipFrame, EventTimingCodesFrame, PrivateFrame}`
|
|
- **MP4**:
|
|
- `Atom::into_data`
|
|
- `Atom::merge`
|
|
|
|
## Changed
|
|
- **ID3v2**:
|
|
- For spec compliance, `Id3v2Tag::insert` will now check for frames that are only meant to appear
|
|
in a tag once and remove them. Those frames are: "MCDI", "ETCO", "MLLT", "SYTC", "RVRB", "PCNT", "RBUF", "POSS", "OWNE", "SEEK", and "ASPI".
|
|
- `Id3v2Tag::remove` will now take a `FrameId` rather than `&str`
|
|
- `FrameId` now implements `Into<Cow<'_, str>>`, making it possible to use it in `Frame::new`
|
|
- **MP4**:
|
|
- `Ilst::remove` will now return all of the removed atoms
|
|
- `Ilst::insert_picture` will now combine all pictures into a single `covr` atom
|
|
- `Ilst::insert` will now merge atoms with the same identifier into a single atom
|
|
- **FLAC**: Allow multiple Vorbis Comment blocks when not using `ParsingMode::Strict`
|
|
- This is not allowed [by spec](https://xiph.org/flac/format.html#def_VORBIS_COMMENT), but is still possible
|
|
to encounter in the wild. Now we will just tag whichever tag happens to be latest in the stream and
|
|
use it, they **will not be merged**.
|
|
|
|
## Fixed
|
|
- **WavPack**: Custom sample rates will no longer be overwritten
|
|
- When a custom sample rate (or multiplier) was encountered, it would accidentally be overwritten with 0, causing
|
|
incorrect duration and bitrate values.
|
|
- **APE**: Reading properties on older files will no longer error
|
|
- Older APE stream versions were not properly handled, leading to incorrect properties and errors.
|
|
|
|
## [0.15.0] - 2023-07-11
|
|
|
|
## Added
|
|
- **ID3v2**:
|
|
- `Id3v2ErrorKind::UnsupportedFrameId` ([PR](https://github.com/Serial-ATA/lofty-rs/pull/212))
|
|
- `FrameValue::KeyValue` for TIPL/TMCL frames ([PR](https://github.com/Serial-ATA/lofty-rs/pull/214))
|
|
- `Id3v2Tag::get_user_text`, `Id3v2Tag::insert_user_text`, and `Id3v2Tag::remove_user_text` for working with TXXX frames ([PR](https://github.com/Serial-ATA/lofty-rs/pull/232))
|
|
- **ParseOptions**: `ParseOptions::max_junk_bytes`, allowing the parser to sift through junk bytes to find required information, rather than
|
|
immediately declare a file invalid. ([discussion](https://github.com/Serial-ATA/lofty-rs/discussions/219)) ([PR](https://github.com/Serial-ATA/lofty-rs/pull/227))
|
|
- **WavPack**: `WavPackProperties` now contains the channel mask, accessible through `WavPackProperties::channel_mask()` ([PR](https://github.com/Serial-ATA/lofty-rs/pull/230))
|
|
- **AIFF**:
|
|
- `AiffProperties` to hold additional AIFF-specific information
|
|
- AIFC compression types are now exposed through `AiffCompressionType`
|
|
|
|
## Changed
|
|
- **ID3v2**:
|
|
- `Id3v2ErrorKind::BadFrameId` now contains the frame ID ([PR](https://github.com/Serial-ATA/lofty-rs/pull/212))
|
|
- Bad frame IDs will no longer error when using `ParsingMode::{Relaxed, BestAttempt}`. The parser will now just move on to the next frame. ([PR](https://github.com/Serial-ATA/lofty-rs/pull/214))
|
|
- **APE**: The default track/disk number is now `0` to line up with ID3v2.
|
|
This is only used when `set_{track, disk}_total` is used without a corresponding `set_{track, disk}`.
|
|
- **VorbisComments**: When writing, items larger than `u32::MAX` will throw `ErrorKind::TooMuchData`, rather than be silently discarded.
|
|
- **AIFF**: `AiffFile` will no longer use `FileProperties`. It now uses `AiffProperties`.
|
|
|
|
## Fixed
|
|
- **APE**: Track/Disk number pairs are properly converted when writing ([issue](https://github.com/Serial-ATA/lofty-rs/issues/159)) ([PR](https://github.com/Serial-ATA/lofty-rs/pull/216))
|
|
- **ID3v2**: TIPL/TMCL frames will no longer be read as a single terminated string ([issue](https://github.com/Serial-ATA/lofty-rs/pull/213)) ([PR](https://github.com/Serial-ATA/lofty-rs/pull/214))
|
|
- **WavPack**: Multichannel files will no longer be marked as mono, supporting up to 4095 channels ([PR](https://github.com/Serial-ATA/lofty-rs/pull/230))
|
|
|
|
## [0.14.0] - 2023-06-08
|
|
|
|
### Added
|
|
- **ParsingMode**: A new variant, `BestAttempt` will attempt to fill holes in otherwise valid tag items ([PR](https://github.com/Serial-ATA/lofty-rs/pull/205))
|
|
- **🎉 Support for Musepack files** ([issue](https://github.com/Serial-ATA/lofty-rs/issues/199)) ([PR](https://github.com/Serial-ATA/lofty-rs/pull/200))
|
|
|
|
### Changed
|
|
- **Probe**: The default `ParsingMode` is now `ParsingMode::BestAttempt` (It was previously `ParsingMode::Strict`)
|
|
- **Alloc**:
|
|
- ⚠️ Important ⚠️: The allocation limit for any single tag item is now **8MB** ([PR](https://github.com/Serial-ATA/lofty-rs/pull/207)).
|
|
This is not configurable yet ([issue](https://github.com/Serial-ATA/lofty-rs/issues/208)).
|
|
|
|
### Fixed
|
|
- **MP4**: Fixed potential panic with malformed `plID` atoms ([issue](https://github.com/Serial-ATA/lofty-rs/issues/201)) ([PR](https://github.com/Serial-ATA/lofty-rs/pull/202))
|
|
|
|
### Removed
|
|
- **ID3v2**: Removed `id3::util::synchsafe::unsynch_content`. This has been replaced with [UnsynchronizedStream](https://docs.rs/lofty/latest/lofty/id3/v2/util/synchsafe/struct.UnsynchronizedStream.html).
|
|
|
|
## [0.13.0] - 2023-05-08
|
|
|
|
### Added
|
|
- **Tag**/**ItemValue**: `Tag::remove_empty`/`ItemValue::is_empty` ([PR](https://github.com/Serial-ATA/lofty-rs/pull/181))
|
|
- **ItemKey**: Variants for MusicBrainz Release group/Artist/Release artist/Work IDs ([PR](https://github.com/Serial-ATA/lofty-rs/pull/182))
|
|
- **ID3v2**:
|
|
- `ItemKey::{Barcode, CatalogNumber}` mappings ([PR](https://github.com/Serial-ATA/lofty-rs/pull/183))
|
|
- `SynchsafeInteger` trait to convert multiple integer types to/from their unsynchronized variants ([PR](https://github.com/Serial-ATA/lofty-rs/pull/187))
|
|
- Concrete types for all `FrameValue` variants ([PR](https://github.com/Serial-ATA/lofty-rs/pull/184))
|
|
- Support for the audio-text accessibility (ATXT) frame ([PR](https://github.com/Serial-ATA/lofty-rs/pull/188))
|
|
- **VorbisComments**: `ItemKey::Barcode` mapping ([PR](https://github.com/Serial-ATA/lofty-rs/pull/183))
|
|
|
|
### Changed
|
|
- **ID3v1**: `ID3v1Tag` -> `Id3v1Tag`
|
|
- **ID3v2**:
|
|
- `SyncTextInformation` no longer uses a String for its language ([PR](https://github.com/Serial-ATA/lofty-rs/pull/184))
|
|
- `FrameID` -> `FrameId`
|
|
- `ID3v2Version` -> `Id3v2Version`
|
|
- `ID3v2TagFlags` -> `Id3v2TagFlags`
|
|
- `ID3v2Tag` -> `Id3v2Tag`
|
|
- There are fewer redundant, intermediate allocations ([PR](https://github.com/Serial-ATA/lofty-rs/pull/194))
|
|
- **FileType/TagType/ItemKey**: All variants have been changed to UpperCamelCase ([PR](https://github.com/Serial-ATA/lofty-rs/pull/190))
|
|
- **MPEG**:
|
|
- `MPEGFile` -> `MpegFile`
|
|
- `MPEGProperties` -> `MpegProperties`
|
|
|
|
### Fixed
|
|
- **ID3v2**: Compressed frames are now properly handled ([PR](https://github.com/Serial-ATA/lofty-rs/pull/191))
|
|
|
|
### Removed
|
|
- **ID3v2**:
|
|
- All uses of `ID3v2ErrorKind::Other` have been replaced with concrete errors
|
|
- `SyncTextInformation` and `GEOBInformation` have been flattened into their respective items ([PR](https://github.com/Serial-ATA/lofty-rs/pull/196))
|
|
|
|
## [0.12.1] - 2023-04-10
|
|
|
|
### Fixed
|
|
- **WAV**: Fix division by zero when reading the properties of an empty stream ([issue](https://github.com/Serial-ATA/lofty-rs/issues/174)) ([PR](https://github.com/Serial-ATA/lofty-rs/pull/175))
|
|
- **ID3v2** ([PR](https://github.com/Serial-ATA/lofty-rs/pull/177)):
|
|
- Export `id3::v2::UniqueFileIdentifierFrame`
|
|
- Export `id3::v2::Popularimeter`
|
|
|
|
## [0.12.0] - 2023-04-04
|
|
|
|
### Added
|
|
- **Properties**: Expose channel mask (only supported for WAV and MPEG for now) ([PR](https://github.com/Serial-ATA/lofty-rs/pull/155))
|
|
- **ItemKey**: `InitialKey` mapping for Vorbis Comments ([PR](https://github.com/Serial-ATA/lofty-rs/pull/156))
|
|
- **VorbisComments**: `VorbisComments::push` to allow for a non-replacing insertion ([PR](https://github.com/Serial-ATA/lofty-rs/pull/169))
|
|
- **Tags**: `<Tag>::new()` as an alias for `<Tag>::default()` ([PR](https://github.com/Serial-ATA/lofty-rs/pull/170))
|
|
- **Picture**: `Picture::into_data()` ([PR](https://github.com/Serial-ATA/lofty-rs/pull/173))
|
|
|
|
### Changed
|
|
- **APE**/**ID3v1**/**ID3v2**/**Tag**:
|
|
- Allow empty strings as values instead of removing the corresponding item when empty ([PR](https://github.com/Serial-ATA/lofty-rs/pull/134))
|
|
- Separated the trait `SplitAndMergeTag` into `SplitTag` and `MergeTag` to prevent any unexpected or undefined behavior at runtime ([PR](https://github.com/Serial-ATA/lofty-rs/pull/143))
|
|
- **VorbisComments** ([PR](https://github.com/Serial-ATA/lofty-rs/pull/169)):
|
|
- Keys will now be verified according to spec before insertion
|
|
- Getters will now case-insensitively search for keys
|
|
- `TRACKNUM` will now be considered in the `Accessor::*track` methods
|
|
- **Tags**: Method names are more consistent ([PR](https://github.com/Serial-ATA/lofty-rs/pull/171))
|
|
|
|
### Fixed
|
|
- **ID3v2**:
|
|
- Fix conversion of user defined frames when using `Tag` writing interface ([issue](https://github.com/Serial-ATA/lofty-rs/issues/140)) ([PR](https://github.com/Serial-ATA/lofty-rs/issues/142))
|
|
- Fix writing of tag/disk numbers when using `Tag` writing interface ([issue](https://github.com/Serial-ATA/lofty-rs/issues/145)) ([PR](https://github.com/Serial-ATA/lofty-rs/pull/149))
|
|
- **MP4** ([PR](https://github.com/Serial-ATA/lofty-rs/pull/163)):
|
|
- Fix the incorrect size being written for newly created `moov.udta.meta` atoms
|
|
- Previously, the 8 bytes for the size and identifier were not accounted for
|
|
- The parser has been further restricted to avoid going out of bounds
|
|
- This was only an issue if there was garbage data after the `moov` item *and* the parser had not yet found
|
|
the `moov.udta` atom.
|
|
- **WavPack** ([PR](https://github.com/Serial-ATA/lofty-rs/pull/168)):
|
|
- Fewer errors are suppressed
|
|
- Metadata sub-blocks are now properly parsed
|
|
- Bitrate calculation will now properly round down
|
|
|
|
## [0.11.0] - 2023-01-29
|
|
|
|
### Added
|
|
- **MP4**:
|
|
- The `InitialKey`, `ReplayGain*`, and "precise BPM" identifiers now have `ItemKey` mappings ([PR](https://github.com/Serial-ATA/lofty-rs/pull/93))
|
|
- `AtomIdent` now implements `TryFrom<ItemKey>` ([PR](https://github.com/Serial-ATA/lofty-rs/pull/96))
|
|
- Added support for the vendor-supplied XID in files from the Apple iTunes store as `ItemKey::AppleXid`. ([PR](https://github.com/Serial-ATA/lofty-rs/pull/98))
|
|
- Added support for `ItemKey::FlagCompilation` ([PR](https://github.com/Serial-ATA/lofty-rs/pull/103))
|
|
- **Vorbis Comments**:
|
|
- Additional mappings for the `Label`, `Remixer`, and `EncodedBy` `ItemKey` variants ([PR](https://github.com/Serial-ATA/lofty-rs/pull/94))
|
|
- **ID3v2**: A new `id3v2_compression_support` feature to optionally depend on `flate2` for decompressing frames
|
|
- **ItemKey**:
|
|
- New Variants: `AppleXid`, `Director`, `Color`
|
|
- **AudioFile**: `AudioFile::save_to{_path}` ([PR](https://github.com/Serial-ATA/lofty-rs/pull/104))
|
|
- **Files**: `<File>::set_{tag}`
|
|
- **FLAC**: `FlacProperties`
|
|
- Previously, FLAC files used `FileProperties`. `FlacProperties` was added to support getting the MD5 signature
|
|
of the audio data.
|
|
- **OGG**: `OggPictureStorage`
|
|
- This was added to cover the overlap in functionality between `VorbisComments` and `FlacFile` in that they both
|
|
store `(Picture, PictureInformation)`.
|
|
- **TagExt**: `TagExt::len`
|
|
|
|
### Changed
|
|
- **MP4**: `AtomIdent` stores freeform identifiers as `Cow<str>` opposed to `String` ([PR](https://github.com/Serial-ATA/lofty-rs/pull/95))
|
|
- This allows freeform identifiers to be constructed in a const context.
|
|
- **ID3v2**: `FrameID` now uses `Cow<str>` opposed to `String` ([PR](https://github.com/Serial-ATA/lofty-rs/pull/102))
|
|
- **FLAC**: `FlacFile` now stores pictures separately from its `VorbisComments` tag
|
|
|
|
### Removed
|
|
- **Metadata format features** ([PR](https://github.com/Serial-ATA/lofty-rs/pull/97)):
|
|
- All of the format-specific features have been removed, as they served no purpose. They used to bring in
|
|
optional dependencies, but they have long since been removed.
|
|
|
|
### Fixed
|
|
- **Tag**: Handling of the `Year` tag has been improved.
|
|
- Previously, setting a year with `Tag::set_year` required a `RecordingDate`. Now it will check if the format
|
|
supports the `Year` tag, and if not, then it will set a `RecordingDate`.
|
|
- **OGG**: Writing of large packets would corrupt the stream ([issue](https://github.com/Serial-ATA/lofty-rs/issues/130)) ([PR](https://github.com/Serial-ATA/lofty-rs/issues/131))
|
|
|
|
### ogg_pager
|
|
See [ogg_pager's changelog](ogg_pager/CHANGELOG.md).
|
|
|
|
## [0.10.0] - 2022-12-27
|
|
|
|
### Added
|
|
- **TagExt**: `TagExt::contains`
|
|
- **Ilst**: `AtomData::Bool` for the various flag atoms such as `cpil`, `pcst`, etc.
|
|
- **BoundTaggedFile**: A `TaggedFile` variant bound to a `File` handle. ([issue](https://github.com/Serial-ATA/lofty-rs/issues/73)) ([PR](https://github.com/Serial-ATA/lofty-rs/pull/80))
|
|
|
|
### Changed
|
|
- **Files**: Return the removed tag from `<File>::remove(TagType)` ([PR](https://github.com/Serial-ATA/lofty-rs/pull/74))
|
|
- Previously, the only way to remove and take ownership of a tag was through `TaggedFile::take`.
|
|
This was not possible when using a concrete type, such as `OpusFile`.
|
|
- **TaggedFile**: Renamed `TaggedFile::take` to `TaggedFile::remove` ([PR](https://github.com/Serial-ATA/lofty-rs/pull/74))
|
|
- **lofty_attr**: The `lofty_attr::LoftyFile` derive proc macro is now exported as `lofty::LoftyFile`.
|
|
- **TaggedFile**: All methods have been split out into a new trait, `TaggedFileExt`. ([PR](https://github.com/Serial-ATA/lofty-rs/pull/80))
|
|
- **Accessor**: All methods returning string values now return `Cow<str>`. ([PR](https://github.com/Serial-ATA/lofty-rs/pull/83))
|
|
- This is an unfortunate change that needed to be made in order to accommodate the handling of the different
|
|
possible text separators between ID3v2 versions.
|
|
- **ID3v2**: Support reading of duplicate tags ([issue](https://github.com/Serial-ATA/lofty-rs/issues/87)) ([PR](https://github.com/Serial-ATA/lofty-rs/pull/88))
|
|
- Previously, if we were reading a file and encountered an ID3v2 tag after having already read one,
|
|
we would overwrite the last one, losing all of its information. Now we preserve all of the information,
|
|
overwriting frames as necessary.
|
|
|
|
### Fixed
|
|
- **ID3v2**: The `'/'` character is no longer used as a separator ([issue](https://github.com/Serial-ATA/lofty-rs/issues/82))
|
|
- **MP4**: Stopped expecting certain flags for the `gnre` atom prior to upgrading it ([issue](https://github.com/Serial-ATA/lofty-rs/issues/84)) ([PR](https://github.com/Serial-ATA/lofty-rs/pull/85))
|
|
|
|
### ogg_pager
|
|
See [ogg_pager's changelog](ogg_pager/CHANGELOG.md).
|
|
|
|
## [0.9.0] - 2022-10-30
|
|
|
|
### Added
|
|
- `ParseOptions` ([issue](https://github.com/Serial-ATA/lofty-rs/issues/50)) ([PR](https://github.com/Serial-ATA/lofty-rs/pull/70)):
|
|
- ⚠️ Important ⚠️: This update introduces `ParseOptions` to allow for finer grained control over error
|
|
eagerness and other settings. Previously, when reading a file the only option available was
|
|
`read_properties`, specified with a `bool` in `read_from{_path}`. This will now default to `true`,
|
|
and can be overridden when using `Probe`.
|
|
- **🎉 Support for AAC (ADTS) files** ([issue](https://github.com/Serial-ATA/lofty-rs/issues/58)) ([PR](https://github.com/Serial-ATA/lofty-rs/pull/71))
|
|
- **FileProperties**: `FileProperties::new`
|
|
- Debug logging via the [log](https://crates.io/crates/log) crate for exposing recoverable errors.
|
|
- **Error**: `ErrorKind::SizeMismatch`
|
|
|
|
### Changed
|
|
- **ID3v2**:
|
|
- Frame/tag flags with optional additional data are now `Option<T>` instead of `(bool, T)`
|
|
- `id3::v2::TextEncoding` is now exported as `lofty::TextEncoding`
|
|
- `read_from{_path}` will no longer take a `bool` for reading properties, and will do it by default. To
|
|
change this behavior, you must now use `Probe`.
|
|
- **FileType**: `primary_tag_type` will no longer change its return depending on the enabled features.
|
|
- **lofty_attr**: Simplified the `file_type` attribute:
|
|
- Before, you had to specify custom file types as `#[lofty(file_type = "Custom(\"MyFile\")")]`. Now
|
|
you can simply do `#[lofty(file_type = "MyFile")]` and it will infer the rest.
|
|
- **IFF**: `WAV` and `AIFF` items are no longer combined in the `iff` module. They are now separated
|
|
into their own modules at `iff::wav` and `iff::aiff` respectively.
|
|
|
|
### Fixed
|
|
- **ID3v2**: Populate the `Populatimeter` field in the `ID3v2` -> `Tag` conversion ([issue](https://github.com/Serial-ATA/lofty-rs/issues/63)) ([PR](https://github.com/Serial-ATA/lofty-rs/pull/64))
|
|
|
|
### Removed
|
|
- **lofty_attr**: The `#[lofty(always_present)]` attribute has been removed, and is now inferred.
|
|
|
|
## [0.8.1] - 2022-09-09
|
|
|
|
### Added
|
|
- **VorbisComments**: `VorbisComments::get_all`, same as `Tag::get_strings` ([issue](https://github.com/Serial-ATA/lofty-rs/issues/66))
|
|
|
|
### Fixed
|
|
- **ID3v2**: Handle tag-wide unsynchronisation flag ([amberol#235](https://gitlab.gnome.org/World/amberol/-/issues/235))
|
|
- **MP3**: Stop using partial frame headers ([PR](https://github.com/Serial-ATA/lofty-rs/pull/67))
|
|
|
|
## [0.8.0] - 2022-08-10
|
|
|
|
### Added
|
|
- **A new file resolver system**:
|
|
- New module: `lofty::resolve`
|
|
- With this, you will be able to create your own `FileType`s, while continuing
|
|
to use lofty's traditional API. Read the module docs for more info.
|
|
- **A proc macro for file creation**:
|
|
- With the new `lofty_attr` crate, file creation has been simplified significantly.
|
|
It is available for both internal and external usage.
|
|
- **ID3v2**: Exposed internal functions `id3::v2::util::{synch_u32, unsynch_u32}`
|
|
- **MP4**: `Atom::push_data`
|
|
|
|
### Changed
|
|
- **TaggedFile**: `tag{_mut}` no longer takes a reference to `TagType`
|
|
- **ID3v2**: `LanguageFrame`'s `lang` field has changed type - `String` -> `[u8; 3]`
|
|
- **MP3**:
|
|
- Renamed `lofty::mp3` -> `lofty::mpeg`
|
|
- Renamed `MP3File` -> `MPEGFile`
|
|
- Renamed `MP3Properties` -> `MPEGProperties`
|
|
- **MP4**: `Atom::data` will now return all values
|
|
- **Vorbis Comments**: Recognize lowercase `METADATA_BLOCK_PICTURE` as a picture ([issue](https://github.com/Serial-ATA/lofty-rs/issues/60))
|
|
|
|
### Fixed
|
|
- **ID3v2**: `ItemKey::InitialKey` now maps to `TKEY` ([PR](https://github.com/Serial-ATA/lofty-rs/pull/61))
|
|
|
|
## [0.7.3] - 2022-07-22
|
|
|
|
### Added
|
|
- **FileType**: `FileType::from_ext` detects MP1/MP2 as `FileType::MP3`, allowing these files to be read with
|
|
`read_from_path`/`Probe::open`.
|
|
- **ItemKey**: `ItemKey::{REPLAYGAIN_ALBUM_GAIN, REPLAYGAIN_ALBUM_PEAK, REPLAYGAIN_TRACK_GAIN, REPLAYGAIN_TRACK_PEAK}`
|
|
|
|
### Changed
|
|
- **ID3v2**:
|
|
- `TXXX`/`WXXX` frames will be stored by their descriptions in `ID3v2Tag` -> `Tag` conversions
|
|
- Stopped allowing empty strings in `Accessor::set_*`
|
|
|
|
### Fixed
|
|
- **Tag**: The `Accessor::set_*` methods will stop falling through, and adding empty strings
|
|
|
|
## [0.7.2] - 2022-07-13
|
|
|
|
This release mostly addresses issues uncovered by fuzzing, thanks to [@5225225](https://github.com/5225225)!
|
|
|
|
### Changed
|
|
- **Tag**: The `Accessor::set_*` methods will now remove the item when given an empty string
|
|
|
|
### Fixed
|
|
- **AIFF/WAV**: Stop relying on the file-provided size when reading (Fixes OOM)
|
|
- **MP3/APE**: Stop trusting the lengths of APE tag items (Fixes OOM)
|
|
- **PictureInformation**: Fix potential integer overflow in `{from_jpeg, from_png}`
|
|
- **MP4**: The parser has received a major facelift, and shouldn't be so eager to allocate or trust user data (Fixes OOM)
|
|
- **FLAC**: Return early when encountering invalid zero-sized blocks
|
|
- **FLAC/Opus/Vorbis/Speex**: Add better length validity checks while reading Vorbis Comments (Fixes OOM)
|
|
|
|
## [0.7.1] - 2022-07-08
|
|
|
|
### Added
|
|
- **Vorbis Comments**: `VorbisComments::{pictures, set_picture, remove_picture}`
|
|
- **Tag**: `Tag::{set_picture, remove_picture}`
|
|
- **MP4**: Support property reading for files with FLAC audio
|
|
|
|
### Changed
|
|
- **ID3v2**: `ID3v2Tag` now derives `Eq`
|
|
|
|
## [0.7.0] - 2022-06-27
|
|
|
|
### Added
|
|
- **WavPack** support
|
|
- **Accessor**:
|
|
- The following new accessor methods have been added:
|
|
- `track`
|
|
- `track_total`
|
|
- `disk`
|
|
- `disk_total`
|
|
- `year`
|
|
- `comment`
|
|
|
|
### Changed
|
|
- Bitrates in properties will be rounded up, similar to FFmpeg and TagLib
|
|
- **ID3v1**: Renamed `Id3v1Tag` -> `ID3v1Tag`
|
|
- **ID3v2**:
|
|
- Insert multi-value frames separately when converting to `Tag`
|
|
- E.g. An artist of "foo/bar/baz" will become 3 different `TagItem`s with `ItemKey::TrackArtist`
|
|
- Join multiple artists with "/" during `Tag` -> `Id3v2Tag` conversion
|
|
- Inverse of the previous entry
|
|
- Properly capitalized the following:
|
|
- `Id3v2Error` -> `ID3v2Error`
|
|
- `Id3v2ErrorKind` -> `ID3v2ErrorKind`
|
|
- `ErrorKind::Id3v2` -> `ErrorKind::ID3v2`
|
|
- `Id3v2TagFlags` -> `ID3v2TagFlags`
|
|
- `Id3v2Version` -> `ID3v2Version`
|
|
- `Id3v2Tag` -> `ID3v2Tag`
|
|
- Properly capitalized the variants of `TagType`
|
|
- `Ape` -> `APE`
|
|
- `Id3v1` -> `ID3v1`
|
|
- `Id3v2` -> `ID3v2`
|
|
- `Mp4Ilst` -> `MP4ilst`
|
|
- `RiffInfo` -> `RIFFInfo`
|
|
- `AiffText` -> `AIFFText`
|
|
- All types implementing `PartialEq` now implement `Eq`
|
|
- **MP4**: `Ilst::track_number` has been moved to the `Accessor::track` implementation
|
|
- **Tag**: Renamed `Tag::get_texts` to `Tag::get_strings`
|
|
- **AIFF**: Renamed `AiffTextChunks` -> `AIFFTextChunks`
|
|
- **WAV**: Renamed `RiffInfoList` -> `RIFFInfoList`
|
|
|
|
### Fixed
|
|
- **AIFF**: Fixed division by zero panic during property reading ([issue](https://github.com/Serial-ATA/lofty-rs/issues/56))
|
|
- **ID3v2**: Support decoding UTF-16 T/WXXX frames with missing content BOM ([issue](https://github.com/Serial-ATA/lofty-rs/issues/53))
|
|
|
|
## [0.6.3] - 2022-05-18
|
|
|
|
### Added
|
|
- **MP4**:
|
|
- Support atoms with multiple values ([issue](https://github.com/Serial-ATA/lofty-rs/issues/48))
|
|
- `Atom::from_collection`
|
|
|
|
### Changed
|
|
- **ID3v2**: Discard empty frames, rather than error
|
|
- **APE**: Allow empty tag items
|
|
- Rather than error on empty items, they will just be discarded
|
|
|
|
### Fixed
|
|
- **Pictures**: Treat "image/jpg" as `MimeType::Jpeg` ([PR](https://github.com/Serial-ATA/lofty-rs/pull/41))
|
|
- **MP3**:
|
|
- Properly validate the contents of Xing/LAME/VBRI headers ([issue](https://github.com/Serial-ATA/lofty-rs/issues/42))
|
|
- A header with any field zeroed out would result in a division by zero panic
|
|
- Fix duration estimation for files with Xing headers without the necessary flags
|
|
- **FLAC**: Fix property reading of zero-length files ([issue](https://github.com/Serial-ATA/lofty-rs/issues/46))
|
|
- **Vorbis Comments**: Fix reading of vendor strings with invalid mixed UTF-8 and UTF-16 encodings
|
|
- **ID3v2**:
|
|
- Fix reading of zero-size tags
|
|
- Attempt to read invalid v2 frame IDs in v3 tags
|
|
- For some reason, some apps write v2 frame IDs in otherwise valid v3 frames
|
|
- Attempt to decode invalid `COMM` languages
|
|
- **MP4**:
|
|
- Fix hang when reading invalid padding ([issue](https://github.com/Serial-ATA/lofty-rs/issues/44))
|
|
- If invalid padding was encountered at the end of the file, the reader would get stuck in an infinite loop
|
|
attempting to read zero size atoms
|
|
- Fallback to bitrate calculation from `mdat` when necessary ([issue](https://github.com/Serial-ATA/lofty-rs/issues/43))
|
|
- When reading a file that doesn't provide a valid bitrate or duration, a division by zero panic would occur.
|
|
Now, it attempts to calculate the bitrate from the `mdat` atom.
|
|
|
|
## [0.6.2] - 2022-04-24
|
|
|
|
### Fixed
|
|
- **MP3**: Fix panic when reading files with no MPEG frames ([issue](https://github.com/Serial-ATA/lofty-rs/issues/39))
|
|
- Attempting to read an MP3 file with `read_properties = true` would result in a panic if the file contained no
|
|
MPEG frames
|
|
|
|
## [0.6.1] - 2022-04-09
|
|
|
|
### Fixed
|
|
- **MP3**: Fix reading of ID3v2 tags with an extended header
|
|
- Restrictions were unnecessarily put on the reader, keeping it from continuing to read into the extended header
|
|
if it was present
|
|
- **ID3v2**: Fix reading of tags with an extended header
|
|
- The size of the extended header was not being subtracted from the total tag size, causing the reading to continue
|
|
outside the tag boundaries
|
|
|
|
## [0.6.0] - 2022-04-05
|
|
|
|
### Added
|
|
- `TagItem::{into_key, into_value, consume}`
|
|
- **MP4**: `Mp4Codec::MP3`
|
|
- **MP4**: `mp4::AudioObjectType`
|
|
- This new type is used in `mp4::Mp4Properties`, accessible with `Mp4Properties::audio_object_type`.
|
|
This provides additional information for the type of audio being dealt with.
|
|
- `TagExt::clear`
|
|
- This allows tags to be cleared of any items or pictures, while retaining any flags (if applicable)
|
|
- **ID3v2**: Respect `Id3v2TagFlags::crc` when writing
|
|
- Previously, this flag was ignored, but it will now calculate a CRC for the extended header
|
|
- **ID3v2**: `FrameValue::Popularimeter`
|
|
- `ItemValue::{into_string, into_binary}`
|
|
- `Tag::take_strings`
|
|
- `TaggedFile` now implements `AudioFile`
|
|
|
|
### Changed
|
|
- **MP4**: Sample rates and channels are now retrieved from the [audio specific config](https://wiki.multimedia.cx/index.php?title=MPEG-4_Audio#Audio_Specific_Config) (if possible).
|
|
If the information is invalid or unavailable, the existing value from the `mp4a` box will be used instead.
|
|
- **Vorbis Comments**: Support non-PNG/JPEG images in `PictureInformation::from_picture`
|
|
- The method still only supports PNG and JPEG, but rather than error when it encounters an unknown image, it will return
|
|
`PictureInformation::default`
|
|
- `lofty::read_from` will now wrap the `File` in a `BufReader`
|
|
- **FLAC**: FLAC now has its own module at `lofty::flac`
|
|
- **ID3v2**: `FrameValue` is now `#[non_exhaustive]`
|
|
- `TagType::remove_from` now works for ID3v2 tags in APE and FLAC files
|
|
- This previously verified that the `FileType` supported the tag. It now has special exceptions for these formats to
|
|
allow stripping out these unsupported tags
|
|
- **MP4**: Renamed `AdvisoryRating::None` to `AdvisoryRating::Inoffensive`
|
|
- Renamed `TaggedFile::remove_tag` to `TaggedFile::take`
|
|
- **Vorbis Comments**: `VorbisComments::insert_picture` now accepts a user provided `PictureInformation`
|
|
- **Vorbis Comments**: Rename `VorbisComments::{get_item, insert_item, remove_key}` to `VorbisComments::{get, insert, remove}`
|
|
- **Vorbis Comments**: `VorbisComments::remove` now returns an iterator over the removed items
|
|
|
|
### Fixed
|
|
- **MP4**: Non-full `meta` atoms are now properly handled.
|
|
- It is possible for these to be a regular atom (no version or flags).
|
|
This information was assumed to be present and would get skipped,
|
|
which would affect the reading of subsequent atoms.
|
|
|
|
This behavior has been noticed by:
|
|
- https://leo-van-stee.github.io/
|
|
- https://github.com/axiomatic-systems/Bento4/blob/v1.6.0-639/Source/C%2B%2B/Core/Ap4ContainerAtom.cpp#L60
|
|
- https://github.com/taglib/taglib/issues/1041
|
|
- **MP4**: Properly search for `soun` atom
|
|
- The search wasn't adding read bytes correctly, but tests passed due to the atom being immediately available.
|
|
It would attempt to read until it reached an EOF if it managed to make it through multiple iterations.
|
|
- **FLAC**: Support files with an ID3v2 tag
|
|
- This will be read only just like APE, but will allow such files to be read
|
|
- **ID3v2**: Fix writing certain proprietary Apple frames
|
|
- When writing, frame IDs are verified with their content. The Apple specific frames "MVNM" and "MVIN" were missing,
|
|
causing an error if they were written with their proper type (`FrameValue::Text`)
|
|
- **ID3v2**: Stop writing a BOM for `TextEncoding::UTF16BE`
|
|
|
|
## [0.5.3] - 2022-03-03
|
|
|
|
### ogg_pager
|
|
See [ogg_pager's changelog](ogg_pager/CHANGELOG.md).
|
|
|
|
## [0.5.2] - 2022-02-26
|
|
|
|
### Added
|
|
- **MP4**: `Ilst::{atoms, retain}`
|
|
|
|
### Fixed
|
|
- **ID3v2**: The footer flag is written to the tag
|
|
- **ID3v2**: Pictures are written when using `Tag`
|
|
|
|
## [0.5.1] - 2022-02-21
|
|
|
|
### Changed
|
|
- **MP4**: Padding atoms (`free`) are used when writing
|
|
- **Opus**: Channel count is verified in accordance to the channel mapping family
|
|
|
|
### Fixed
|
|
- **MP4**: `meta` atoms are written correctly
|
|
|
|
## [0.5.0] - 2022-02-20
|
|
|
|
### Added
|
|
- Support for Speex files
|
|
- `TagExt` trait to unify tag behavior
|
|
- `doc_cfg` feature for docs.rs
|
|
- Fallible allocation with `ErrorKind::Alloc` to help prevent OOM
|
|
- New dependency: `cfg-if`
|
|
- **MP3**: Emphasis struct (`mp3::Emphasis`) for use in `Mp3Properties`
|
|
- **ID3v2**: Respect the footer flag (`id3::v2::Id3v2TagFlags::footer`) when writing
|
|
- **MP4**: Constants for all well-known data types (`mp4::constants`)
|
|
- **MP4**: Support `rtng` (Parental advisory) atom, with corresponding `mp4::AdvisoryRating` enum
|
|
|
|
### Changed
|
|
- Added `#[non_exhaustive]` to `MimeType`
|
|
- Added `#[non_exhaustive]` to `PictureType`
|
|
- Added `#[non_exhaustive]` to `Mp4Codec`
|
|
- **APE**: Clarify why ID3v2 is read only
|
|
- **MP3**: No longer error on missing Xing/VBRI header when reading properties
|
|
- **MP3**: Read the entire MPEG frame header, which is exposed in `Mp3Properties`
|
|
- `AudioFile` now requires `Into<TaggedFile>`
|
|
- **MP4**: Empty atoms are discarded
|
|
- **MP4**: Variable-size integers are shrunk when writing
|
|
|
|
### Fixed
|
|
- **MP4**: Panic in `Mp4File::read_from` ([commit](https://github.com/Serial-ATA/lofty-rs/commit/9e18616a6882c659ba2d5ca6bdad9bf41171135d))
|
|
- **WAV/AIFF**: Chunk reading now makes use of fallible allocation, preventing OOM
|
|
- **ID3v2**: Text is properly encoded when writing
|
|
- **ID3v2**: `MVNM` and `MVIN` frames are now treated as text frames
|
|
- **ID3v2**: Text encodings are verified for V2 tags
|
|
- **MP4**: `plID` atom is properly treated as a 64-bit signed integer ([issue](https://github.com/Serial-ATA/lofty-rs/issues/34))
|
|
- **MP4**: `rate` and `rtng` now map to the correct `ItemKey`
|
|
- **MP4**: Integer pairs are now written correctly
|
|
- `TagType` and `FileType` are no longer taken by reference in any method
|
|
|
|
### Removed
|
|
- `ErrorKind::BadExtension`
|
|
|
|
[Unreleased]: https://github.com/Serial-ATA/lofty-rs/compare/0.15.0...HEAD
|
|
[0.15.0]: https://github.com/Serial-ATA/lofty-rs/compare/0.14.0...0.15.0
|
|
[0.14.0]: https://github.com/Serial-ATA/lofty-rs/compare/0.13.0...0.14.0
|
|
[0.13.0]: https://github.com/Serial-ATA/lofty-rs/compare/0.12.1...0.13.0
|
|
[0.12.1]: https://github.com/Serial-ATA/lofty-rs/compare/0.12.0...0.12.1
|
|
[0.12.0]: https://github.com/Serial-ATA/lofty-rs/compare/0.11.0...0.12.0
|
|
[0.11.0]: https://github.com/Serial-ATA/lofty-rs/compare/0.10.0...0.11.0
|
|
[0.10.0]: https://github.com/Serial-ATA/lofty-rs/compare/0.9.0...0.10.0
|
|
[0.9.0]: https://github.com/Serial-ATA/lofty-rs/compare/0.8.1...0.9.0
|
|
[0.8.1]: https://github.com/Serial-ATA/lofty-rs/compare/0.8.0...0.8.1
|
|
[0.8.0]: https://github.com/Serial-ATA/lofty-rs/compare/0.7.3...0.8.0
|
|
[0.7.3]: https://github.com/Serial-ATA/lofty-rs/compare/0.7.2...0.7.3
|
|
[0.7.2]: https://github.com/Serial-ATA/lofty-rs/compare/0.7.1...0.7.2
|
|
[0.7.1]: https://github.com/Serial-ATA/lofty-rs/compare/0.7.0...0.7.1
|
|
[0.7.0]: https://github.com/Serial-ATA/lofty-rs/compare/0.6.3...0.7.0
|
|
[0.6.3]: https://github.com/Serial-ATA/lofty-rs/compare/0.6.2...0.6.3
|
|
[0.6.2]: https://github.com/Serial-ATA/lofty-rs/compare/0.6.1...0.6.2
|
|
[0.6.1]: https://github.com/Serial-ATA/lofty-rs/compare/0.6.0...0.6.1
|
|
[0.6.0]: https://github.com/Serial-ATA/lofty-rs/compare/0.5.3...0.6.0
|
|
[0.5.3]: https://github.com/Serial-ATA/lofty-rs/compare/0.5.2...0.5.3
|
|
[0.5.2]: https://github.com/Serial-ATA/lofty-rs/compare/0.5.1...0.5.2
|
|
[0.5.1]: https://github.com/Serial-ATA/lofty-rs/compare/0.5.0...0.5.1
|
|
[0.5.0]: https://github.com/Serial-ATA/lofty-rs/compare/64f0eff...0.5.0
|