Skip to content

Commit 97f081f

Browse files
Serial-ATASerial-ATA
committed
Tags: Support ReplayGain keys
ID3v2: Properly store user defined frames after `Tag` conversion
1 parent 69436e5 commit 97f081f

File tree

3 files changed

+186
-100
lines changed

3 files changed

+186
-100
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99
### Added
1010
- **FileType**: `FileType::from_ext` detects MP1/MP2 as `FileType::MP3`, allowing these files to be read with
1111
`read_from_path`/`Probe::open`.
12+
- **ItemKey**: `ItemKey::{REPLAYGAIN_ALBUM_GAIN, REPLAYGAIN_ALBUM_PEAK, REPLAYGAIN_TRACK_GAIN, REPLAYGAIN_TRACK_PEAK}`
13+
14+
### Changed
15+
- **ID3v2**: `TXXX`/`WXXX` frames will be stored by their descriptions in `ID3v2Tag` -> `Tag` conversions
1216

1317
### Fixed
1418
- **Tag**: The `Accessor::set_*` methods will stop falling through, and adding empty strings

‎src/id3/v2/tag.rs‎

Lines changed: 95 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -488,53 +488,91 @@ impl From<ID3v2Tag> for Tag {
488488

489489
let mut tag = Self::new(TagType::ID3v2);
490490

491-
'outer: for frame in input.frames {
492-
let id = frame.id_str();
491+
for frame in input.frames {
492+
let id = frame.id;
493493

494494
// The text pairs need some special treatment
495-
match (id, frame.content()) {
495+
match (id.as_str(), frame.value) {
496496
("TRCK", FrameValue::Text { value: content, .. })
497-
if split_pair(content, &mut tag, ItemKey::TrackNumber, ItemKey::TrackTotal)
498-
.is_some() =>
497+
if split_pair(
498+
&content,
499+
&mut tag,
500+
ItemKey::TrackNumber,
501+
ItemKey::TrackTotal,
502+
)
503+
.is_some() =>
499504
{
500505
continue
501506
},
502507
("TPOS", FrameValue::Text { value: content, .. })
503-
if split_pair(content, &mut tag, ItemKey::DiscNumber, ItemKey::DiscTotal)
508+
if split_pair(&content, &mut tag, ItemKey::DiscNumber, ItemKey::DiscTotal)
504509
.is_some() =>
505510
{
506511
continue
507512
},
508-
_ => {},
509-
}
510-
511-
let item_key = ItemKey::from_key(TagType::ID3v2, id);
512-
513-
let item_value = match frame.value {
514-
FrameValue::Comment(LanguageFrame { content, .. })
515-
| FrameValue::UnSyncText(LanguageFrame { content, .. })
516-
| FrameValue::Text { value: content, .. }
517-
| FrameValue::UserText(EncodedTextFrame { content, .. }) => {
513+
// Store TXXX/WXXX frames by their descriptions, rather than their IDs
514+
(
515+
"TXXX",
516+
FrameValue::UserText(EncodedTextFrame {
517+
ref description,
518+
ref content,
519+
..
520+
}),
521+
) => {
522+
let item_key = ItemKey::from_key(TagType::ID3v2, description);
518523
for c in content.split(&['\0', '/'][..]) {
519524
tag.items.push(TagItem::new(
520525
item_key.clone(),
521526
ItemValue::Text(c.to_string()),
522527
));
523528
}
524-
525-
continue 'outer;
526529
},
527-
FrameValue::URL(content)
528-
| FrameValue::UserURL(EncodedTextFrame { content, .. }) => ItemValue::Locator(content),
529-
FrameValue::Picture { picture, .. } => {
530-
tag.push_picture(picture);
531-
continue;
530+
(
531+
"WXXX",
532+
FrameValue::UserText(EncodedTextFrame {
533+
ref description,
534+
ref content,
535+
..
536+
}),
537+
) => {
538+
let item_key = ItemKey::from_key(TagType::ID3v2, description);
539+
for c in content.split(&['\0', '/'][..]) {
540+
tag.items.push(TagItem::new(
541+
item_key.clone(),
542+
ItemValue::Locator(c.to_string()),
543+
));
544+
}
532545
},
533-
FrameValue::Popularimeter(_) => continue,
534-
FrameValue::Binary(binary) => ItemValue::Binary(binary),
535-
};
546+
(id, value) => {
547+
let item_key = ItemKey::from_key(TagType::ID3v2, id);
548+
549+
let item_value = match value {
550+
FrameValue::Comment(LanguageFrame { content, .. })
551+
| FrameValue::UnSyncText(LanguageFrame { content, .. })
552+
| FrameValue::Text { value: content, .. }
553+
| FrameValue::UserText(EncodedTextFrame { content, .. }) => {
554+
for c in content.split(&['\0', '/'][..]) {
555+
tag.items.push(TagItem::new(
556+
item_key.clone(),
557+
ItemValue::Text(c.to_string()),
558+
));
559+
}
560+
561+
continue;
562+
},
563+
FrameValue::URL(content)
564+
| FrameValue::UserURL(EncodedTextFrame { content, .. }) => ItemValue::Locator(content),
565+
FrameValue::Picture { picture, .. } => {
566+
tag.push_picture(picture);
567+
continue;
568+
},
569+
FrameValue::Popularimeter(_) => continue,
570+
FrameValue::Binary(binary) => ItemValue::Binary(binary),
571+
};
536572

537-
tag.items.push(TagItem::new(item_key, item_value));
573+
tag.items.push(TagItem::new(item_key, item_value));
574+
},
575+
}
538576
}
539577

540578
tag
@@ -644,8 +682,8 @@ impl<'a, I: Iterator<Item = FrameRef<'a>> + 'a> Id3v2TagRef<'a, I> {
644682
mod tests {
645683
use crate::id3::v2::items::popularimeter::Popularimeter;
646684
use crate::id3::v2::{
647-
read_id3v2_header, Frame, FrameFlags, FrameID, FrameValue, ID3v2Tag, ID3v2Version,
648-
LanguageFrame, TextEncoding,
685+
read_id3v2_header, EncodedTextFrame, Frame, FrameFlags, FrameID, FrameValue, ID3v2Tag,
686+
ID3v2Version, LanguageFrame, TextEncoding,
649687
};
650688
use crate::tag::utils::test_utils::read_path;
651689
use crate::{
@@ -1064,4 +1102,32 @@ mod tests {
10641102
fn utf16_txxx_with_single_bom() {
10651103
let _ = read_tag("tests/tags/assets/id3v2/issue_53.id3v24");
10661104
}
1105+
1106+
#[test]
1107+
fn replaygain_tag_conversion() {
1108+
let mut tag = ID3v2Tag::default();
1109+
tag.insert(
1110+
Frame::new(
1111+
"TXXX",
1112+
FrameValue::UserText(EncodedTextFrame {
1113+
encoding: TextEncoding::UTF8,
1114+
description: String::from("REPLAYGAIN_ALBUM_GAIN"),
1115+
content: String::from("-10.43 dB"),
1116+
}),
1117+
FrameFlags::default(),
1118+
)
1119+
.unwrap(),
1120+
);
1121+
1122+
let tag: Tag = tag.into();
1123+
1124+
assert_eq!(tag.item_count(), 1);
1125+
assert_eq!(
1126+
tag.items[0],
1127+
TagItem {
1128+
item_key: ItemKey::ReplayGainAlbumGain,
1129+
item_value: ItemValue::Text(String::from("-10.43 dB"))
1130+
}
1131+
);
1132+
}
10671133
}

‎src/tag/item.rs‎

Lines changed: 87 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,10 @@ gen_map!(
110110
"Compilation" => FlagCompilation,
111111
"Media" => OriginalMediaType,
112112
"EncodedBy" => EncodedBy,
113+
"REPLAYGAIN_ALBUM_GAIN" => ReplayGainAlbumGain,
114+
"REPLAYGAIN_ALBUM_PEAK" => ReplayGainAlbumPeak,
115+
"REPLAYGAIN_TRACK_GAIN" => ReplayGainTrackGain,
116+
"REPLAYGAIN_TRACK_PEAK" => ReplayGainTrackPeak,
113117
"Genre" => Genre,
114118
"Mood" => Mood,
115119
"Copyright" => CopyrightMessage,
@@ -123,77 +127,81 @@ gen_map! (
123127
#[cfg(feature = "id3v2")]
124128
ID3V2_MAP;
125129

126-
"TALB" => AlbumTitle,
127-
"TSST" => SetSubtitle,
128-
"TIT1" | "GRP1" => ContentGroup,
129-
"TIT2" => TrackTitle,
130-
"TIT3" => TrackSubtitle,
131-
"TOAL" => OriginalAlbumTitle,
132-
"TOPE" => OriginalArtist,
133-
"TOLY" => OriginalLyricist,
134-
"TSOA" => AlbumTitleSortOrder,
135-
"TSO2" => AlbumArtistSortOrder,
136-
"TSOT" => TrackTitleSortOrder,
137-
"TSOP" => TrackArtistSortOrder,
138-
"TSOC" => ComposerSortOrder,
139-
"TPE2" => AlbumArtist,
140-
"TPE1" => TrackArtist,
141-
"TEXT" => Writer,
142-
"TCOM" => Composer,
143-
"TPE3" => Conductor,
144-
"TIPL" => InvolvedPeople,
145-
"TEXT" => Lyricist,
146-
"TMCL" => MusicianCredits,
147-
"IPRO" => Producer,
148-
"TPUB" => Publisher,
149-
"TPUB" => Label,
150-
"TRSN" => InternetRadioStationName,
151-
"TRSO" => InternetRadioStationOwner,
152-
"TPE4" => Remixer,
153-
"TPOS" => DiscNumber,
154-
"TPOS" => DiscTotal,
155-
"TRCK" => TrackNumber,
156-
"TRCK" => TrackTotal,
157-
"POPM" => Popularimeter,
158-
"TDRC" => RecordingDate,
159-
"TDOR" => OriginalReleaseDate,
160-
"TSRC" => ISRC,
161-
"MVNM" => Movement,
162-
"MVIN" => MovementIndex,
163-
"TCMP" => FlagCompilation,
164-
"PCST" => FlagPodcast,
165-
"TFLT" => FileType,
166-
"TOWN" => FileOwner,
167-
"TDTG" => TaggingTime,
168-
"TLEN" => Length,
169-
"TOFN" => OriginalFileName,
170-
"TMED" => OriginalMediaType,
171-
"TENC" => EncodedBy,
172-
"TSSE" => EncoderSoftware,
173-
"TSSE" => EncoderSettings,
174-
"TDEN" => EncodingTime,
175-
"WOAF" => AudioFileURL,
176-
"WOAS" => AudioSourceURL,
177-
"WCOM" => CommercialInformationURL,
178-
"WCOP" => CopyrightURL,
179-
"WOAR" => TrackArtistURL,
180-
"WORS" => RadioStationURL,
181-
"WPAY" => PaymentURL,
182-
"WPUB" => PublisherURL,
183-
"TCON" => Genre,
184-
"TLEY" => InitialKey,
185-
"TMOO" => Mood,
186-
"TBPM" => BPM,
187-
"TCOP" => CopyrightMessage,
188-
"TDES" => PodcastDescription,
189-
"TCAT" => PodcastSeriesCategory,
190-
"WFED" => PodcastURL,
191-
"TDRL" => PodcastReleaseDate,
192-
"TGID" => PodcastGlobalUniqueID,
193-
"TKWD" => PodcastKeywords,
194-
"COMM" => Comment,
195-
"TLAN" => Language,
196-
"USLT" => Lyrics
130+
"TALB" => AlbumTitle,
131+
"TSST" => SetSubtitle,
132+
"TIT1" | "GRP1" => ContentGroup,
133+
"TIT2" => TrackTitle,
134+
"TIT3" => TrackSubtitle,
135+
"TOAL" => OriginalAlbumTitle,
136+
"TOPE" => OriginalArtist,
137+
"TOLY" => OriginalLyricist,
138+
"TSOA" => AlbumTitleSortOrder,
139+
"TSO2" => AlbumArtistSortOrder,
140+
"TSOT" => TrackTitleSortOrder,
141+
"TSOP" => TrackArtistSortOrder,
142+
"TSOC" => ComposerSortOrder,
143+
"TPE2" => AlbumArtist,
144+
"TPE1" => TrackArtist,
145+
"TEXT" => Writer,
146+
"TCOM" => Composer,
147+
"TPE3" => Conductor,
148+
"TIPL" => InvolvedPeople,
149+
"TEXT" => Lyricist,
150+
"TMCL" => MusicianCredits,
151+
"IPRO" => Producer,
152+
"TPUB" => Publisher,
153+
"TPUB" => Label,
154+
"TRSN" => InternetRadioStationName,
155+
"TRSO" => InternetRadioStationOwner,
156+
"TPE4" => Remixer,
157+
"TPOS" => DiscNumber,
158+
"TPOS" => DiscTotal,
159+
"TRCK" => TrackNumber,
160+
"TRCK" => TrackTotal,
161+
"POPM" => Popularimeter,
162+
"TDRC" => RecordingDate,
163+
"TDOR" => OriginalReleaseDate,
164+
"TSRC" => ISRC,
165+
"MVNM" => Movement,
166+
"MVIN" => MovementIndex,
167+
"TCMP" => FlagCompilation,
168+
"PCST" => FlagPodcast,
169+
"TFLT" => FileType,
170+
"TOWN" => FileOwner,
171+
"TDTG" => TaggingTime,
172+
"TLEN" => Length,
173+
"TOFN" => OriginalFileName,
174+
"TMED" => OriginalMediaType,
175+
"TENC" => EncodedBy,
176+
"TSSE" => EncoderSoftware,
177+
"TSSE" => EncoderSettings,
178+
"TDEN" => EncodingTime,
179+
"REPLAYGAIN_ALBUM_GAIN" => ReplayGainAlbumGain,
180+
"REPLAYGAIN_ALBUM_PEAK" => ReplayGainAlbumPeak,
181+
"REPLAYGAIN_TRACK_GAIN" => ReplayGainTrackGain,
182+
"REPLAYGAIN_TRACK_PEAK" => ReplayGainTrackPeak,
183+
"WOAF" => AudioFileURL,
184+
"WOAS" => AudioSourceURL,
185+
"WCOM" => CommercialInformationURL,
186+
"WCOP" => CopyrightURL,
187+
"WOAR" => TrackArtistURL,
188+
"WORS" => RadioStationURL,
189+
"WPAY" => PaymentURL,
190+
"WPUB" => PublisherURL,
191+
"TCON" => Genre,
192+
"TLEY" => InitialKey,
193+
"TMOO" => Mood,
194+
"TBPM" => BPM,
195+
"TCOP" => CopyrightMessage,
196+
"TDES" => PodcastDescription,
197+
"TCAT" => PodcastSeriesCategory,
198+
"WFED" => PodcastURL,
199+
"TDRL" => PodcastReleaseDate,
200+
"TGID" => PodcastGlobalUniqueID,
201+
"TKWD" => PodcastKeywords,
202+
"COMM" => Comment,
203+
"TLAN" => Language,
204+
"USLT" => Lyrics
197205
);
198206

199207
gen_map! (
@@ -322,6 +330,10 @@ gen_map!(
322330
"ENCODED-BY" => EncodedBy,
323331
"ENCODER" => EncoderSoftware,
324332
"ENCODING" | "ENCODERSETTINGS" => EncoderSettings,
333+
"REPLAYGAIN_ALBUM_GAIN" => ReplayGainAlbumGain,
334+
"REPLAYGAIN_ALBUM_PEAK" => ReplayGainAlbumPeak,
335+
"REPLAYGAIN_TRACK_GAIN" => ReplayGainTrackGain,
336+
"REPLAYGAIN_TRACK_PEAK" => ReplayGainTrackPeak,
325337
"GENRE" => Genre,
326338
"MOOD" => Mood,
327339
"BPM" => BPM,
@@ -501,6 +513,10 @@ gen_item_keys!(
501513
EncoderSoftware,
502514
EncoderSettings,
503515
EncodingTime,
516+
ReplayGainAlbumGain,
517+
ReplayGainAlbumPeak,
518+
ReplayGainTrackGain,
519+
ReplayGainTrackPeak,
504520

505521
// URLs
506522
AudioFileURL,

0 commit comments

Comments
 (0)