EBML: Add more generic tag mappings

Serial-ATA · Serial-ATA · commit f69c4d5521f9 · 2025-07-08T18:25:24.000-04:00
diff --git a/lofty/src/ebml/tag/generic.rs b/lofty/src/ebml/tag/generic.rs
@@ -56,19 +56,28 @@ macro_rules! matroska_mapping_tables {
 
 matroska_mapping_tables!(
 	Shot => [];
-	Scene => [];
+	Scene => [
+		// Identifiers
+		"TITLE"       <=> Movement,
+		"PART_NUMBER" <=> MovementNumber,
+		"TOTAL_PARTS" <=> MovementTotal,
+	];
 	Track => [
 		// Organization Information
 		"PART_NUMBER"         <=> TrackNumber,
 
 		// Titles
+		// TODO: This should be T=50 for MKV
 		"TITLE"               <=> TrackTitle,
+		// TODO: This should be T=50 for MKV
 		"SUBTITLE"            <=> TrackSubtitle,
 
 		// Nested Information
+		// TODO: This should be T=50 for MKV
 		"SORT_WITH"           <=> TrackTitleSortOrder,
 
 		// Entities
+		// TODO: This should be T=50 for MKV
 		"ARTIST"              <=> TrackArtist,
 		"LYRICS"              <=> Lyrics,
 		"COMPOSER"            <=> Composer,
@@ -77,6 +86,7 @@ matroska_mapping_tables!(
 		"CONDUCTOR"           <=> Conductor,
 		"DIRECTOR"            <=> Director,
 		"PRODUCER"            <=> Producer,
+		// TODO: This should be T=50 for MKV
 		"ENCODED_BY"          <=> EncodedBy,
 		"MIXED_BY"            <=> MixDj,
 		"REMIXED_BY"          <=> Remixer,
@@ -89,12 +99,45 @@ matroska_mapping_tables!(
 		"INITIAL_KEY"         <=> InitialKey,
 		"ORIGINAL_MEDIA_TYPE" <=> OriginalMediaType,
 
+		// Flags
+		"COMPILATION"         <=> FlagCompilation,
+		"PODCAST"             <=> FlagPodcast,
+
+		// File Information
+		"FILETYPE"            <=> FileType,
+		// TODO: Should be T=50 for MKV
+		"PURCHASE_OWNER"      <=> FileOwner,
+		"TAGGINGTIME"         <=> TaggingTime,
+		"LENGTH"              <=> Length,
+		"ORIGFILENAME"        <=> OriginalFileName,
+		"ORIGINAL_MEDIA_TYPE" <=> OriginalMediaType,
+
+		// URLs
+		"WWWAUDIOFILE"        <=> AudioFileUrl,
+		"WWWAUDIOSOURCE"      <=> AudioSourceUrl,
+		// TODO: Should be T=50 for MKV
+		"PURCHASE_INFO"       <=> CommercialInformationUrl,
+		"WWWCOPYRIGHT"        <=> CopyrightUrl,
+		"WWWARTIST"           <=> TrackArtistUrl,
+		"WWWRADIOPAGE"        <=> RadioStationUrl,
+		// TODO: Should be T=50 for MKV
+		"PURCHASE_ITEM"       <=> PaymentUrl,
+		"WWWPUBLISHER"        <=> PublisherUrl,
+
 		// Technical Information
 		"ENCODER"             <=> EncoderSoftware,
+		// TODO: This should be T=50 for MKV
 		"ENCODER_SETTINGS"    <=> EncoderSettings,
 		"BPM"                 <=> Bpm,
 		// TODO: ReplayGain? The values are binary in Matroska
 
+		// Podcast
+		"PODCASTDESC"         <=> PodcastDescription,
+		"PODCASTCATEGORY"     <=> PodcastSeriesCategory,
+		"PODCASTURL"          <=> PodcastUrl,
+		"PODCASTID"           <=> PodcastGlobalUniqueId,
+		"PODCASTKEYWORDS"     <=> PodcastKeywords,
+
 		// Identifiers
 		"ISRC"                <=> Isrc,
 		"BARCODE"             <=> Barcode,
@@ -106,12 +149,17 @@ matroska_mapping_tables!(
 		"TOTAL_PARTS"    <=> TrackTotal,
 
 		// Titles
+		// TODO: This should be T=60 for MKV
 		"TITLE"          <=> AlbumTitle,
+		// TODO: This should be T=60 for MKV
+		"SUBTITLE"       <=> SetSubtitle,
 
 		// Nested Information
+		// TODO: This should be T=60 for MKV
 		"SORT_WITH"      <=> AlbumTitleSortOrder,
 
 		// Entities
+		// TODO: This should be T=60 for MKV
 		"ARTIST"         <=> AlbumArtist,
 
 		// Temporal Information
diff --git a/lofty/src/ebml/tag/mod.rs b/lofty/src/ebml/tag/mod.rs
@@ -16,12 +16,12 @@ pub use tag_name::*;
 pub use target::*;
 
 use crate::config::{WriteOptions, global_options};
+use crate::ebml::tag::write::{ElementWriterCtx, WriteableElement};
 use crate::error::{LoftyError, Result};
 use crate::io::{FileLike, Length, Truncate};
 use crate::picture::Picture;
 use crate::tag::companion_tag::CompanionTag;
 use crate::tag::{Accessor, MergeTag, SplitTag, TagExt, TagType};
-use crate::ebml::tag::write::{ElementWriterCtx, WriteableElement};
 
 use std::borrow::Cow;
 use std::collections::HashMap;
@@ -35,7 +35,7 @@ macro_rules! impl_accessor {
 		paste::paste! {
 			$(
 				fn $method(&self) -> Option<Cow<'_, str>> {
-					self.get_str(MatroskaTagKey(TargetType::$target, $name.into()))
+					self.get_str(TargetType::$target, $name)
 				}
 
 				fn [<set_ $method>](&mut self, value: String) {
@@ -72,8 +72,11 @@ pub struct MatroskaTag {
 pub struct MatroskaTagKey<'a>(TargetType, Cow<'a, str>);
 
 impl MatroskaTag {
-	fn get(&self, key: MatroskaTagKey<'_>) -> Option<&SimpleTag<'_>> {
-		let MatroskaTagKey(target, key) = key;
+	fn get<'a, K>(&self, target: TargetType, key: K) -> Option<&SimpleTag<'_>>
+	where
+		K: Into<Cow<'a, str>>,
+	{
+		let key = key.into();
 
 		let applicable_tags = self.tags.iter().filter(|tag| tag.matches_target(target));
 		for applicable_tag in applicable_tags {
@@ -112,8 +115,11 @@ impl MatroskaTag {
 		self.tags.get_mut(pos.unwrap()).unwrap()
 	}
 
-	fn get_str(&self, key: MatroskaTagKey<'_>) -> Option<Cow<'_, str>> {
-		let simple_tag = self.get(key)?;
+	fn get_str<'a, K>(&self, target: TargetType, key: K) -> Option<Cow<'_, str>>
+	where
+		K: Into<Cow<'a, str>>,
+	{
+		let simple_tag = self.get(target, key)?;
 		simple_tag.get_str().map(Cow::from)
 	}
 
@@ -279,39 +285,60 @@ impl Accessor for MatroskaTag {
 	);
 
 	fn track(&self) -> Option<u32> {
-		self.get(MatroskaTagKey(
-			TargetType::Track,
-			Cow::Borrowed("PART_NUMBER"),
-		))
-		.and_then(SimpleTag::get_str)
-		.and_then(|val| val.parse::<u32>().ok())
+		self.get_str(TargetType::Track, TagName::PartNumber)
+			.and_then(|val| val.parse::<u32>().ok())
 	}
 
-	fn set_track(&mut self, _value: u32) {
-		todo!()
+	fn set_track(&mut self, value: u32) {
+		let tag = SimpleTag::new(TagName::PartNumber, value.to_string());
+		self.push(TargetType::Track, tag);
 	}
 
 	fn remove_track(&mut self) {
 		todo!()
 	}
 
 	fn track_total(&self) -> Option<u32> {
-		self.get(MatroskaTagKey(
-			TargetType::Album,
-			Cow::Borrowed("TOTAL_PARTS"),
-		))
-		.and_then(SimpleTag::get_str)
-		.and_then(|val| val.parse::<u32>().ok())
+		self.get(TargetType::Album, TagName::TotalParts)
+			.and_then(SimpleTag::get_str)
+			.and_then(|val| val.parse::<u32>().ok())
 	}
 
-	fn set_track_total(&mut self, _value: u32) {
-		todo!()
+	fn set_track_total(&mut self, value: u32) {
+		let tag = SimpleTag::new(TagName::TotalParts, value.to_string());
+		self.push(TargetType::Album, tag);
 	}
 
 	fn remove_track_total(&mut self) {
 		todo!()
 	}
 
+	fn disk(&self) -> Option<u32> {
+		self.get(TargetType::Edition, TagName::PartNumber)
+			.and_then(SimpleTag::get_str)
+			.and_then(|val| val.parse::<u32>().ok())
+	}
+
+	fn set_disk(&mut self, value: u32) {
+		let tag = SimpleTag::new(TagName::PartNumber, value.to_string());
+		self.push(TargetType::Edition, tag);
+	}
+
+	fn remove_disk(&mut self) {}
+
+	fn disk_total(&self) -> Option<u32> {
+		self.get(TargetType::Edition, TagName::TotalParts)
+			.and_then(SimpleTag::get_str)
+			.and_then(|val| val.parse::<u32>().ok())
+	}
+
+	fn set_disk_total(&mut self, value: u32) {
+		let tag = SimpleTag::new(TagName::TotalParts, value.to_string());
+		self.push(TargetType::Edition, tag);
+	}
+
+	fn remove_disk_total(&mut self) {}
+
 	fn year(&self) -> Option<u32> {
 		// `DATE_RELEASED`
 		todo!()
@@ -441,15 +468,14 @@ impl From<crate::tag::Tag> for MatroskaTag {
 	}
 }
 
-pub(crate) struct MatroskaTagRef<'a>
-{
+pub(crate) struct MatroskaTagRef<'a> {
 	pub(crate) tags: Vec<TagRef<'a>>,
 }
 
 impl<'a> From<&'a MatroskaTag> for MatroskaTagRef<'a> {
 	fn from(value: &'a MatroskaTag) -> Self {
 		Self {
-			tags: value.tags.iter().map(Into::into).collect::<Vec<_>>()
+			tags: value.tags.iter().map(Into::into).collect::<Vec<_>>(),
 		}
 	}
 }
@@ -459,7 +485,9 @@ impl<'a> From<&'a crate::tag::Tag> for MatroskaTagRef<'static> {
 		let mut mapped_tags: HashMap<TargetType, Vec<Cow<'static, SimpleTag<'static>>>> =
 			HashMap::new();
 		for item in &value.items {
-			if let Some((simple_tag, target_type)) = generic::simple_tag_for_item(Cow::Borrowed(item)) {
+			if let Some((simple_tag, target_type)) =
+				generic::simple_tag_for_item(Cow::Borrowed(item))
+			{
 				mapped_tags
 					.entry(target_type)
 					.or_default()
@@ -472,16 +500,14 @@ impl<'a> From<&'a crate::tag::Tag> for MatroskaTagRef<'static> {
 			.map(|(target_type, simple_tags)| TagRef {
 				targets: TargetDescriptor::Basic(target_type),
 				simple_tags,
-			}).collect::<Vec<_>>();
+			})
+			.collect::<Vec<_>>();
 
-		Self {
-			tags
-		}
+		Self { tags }
 	}
 }
 
-impl<'a> MatroskaTagRef<'a>
-{
+impl<'a> MatroskaTagRef<'a> {
 	pub(crate) fn write_to<F>(&mut self, file: &mut F, write_options: WriteOptions) -> Result<()>
 	where
 		F: FileLike,
diff --git a/lofty/src/ebml/tag/write/elements/mod.rs b/lofty/src/ebml/tag/write/elements/mod.rs
@@ -2,6 +2,6 @@
 
 pub(super) mod attached_file;
 pub(super) mod simple_tag;
+mod tag;
 pub(super) mod tags;
 pub(super) mod target;
-mod tag;
diff --git a/lofty/src/ebml/tag/write/elements/tag.rs b/lofty/src/ebml/tag/write/elements/tag.rs
@@ -29,4 +29,4 @@ impl WriteableElement for TagRef<'_> {
 
 		Ok(())
 	}
-}
+}
diff --git a/lofty/src/ebml/tag/write/elements/tags.rs b/lofty/src/ebml/tag/write/elements/tags.rs
@@ -1,12 +1,11 @@
-use crate::ebml::tag::write::{write_element, ElementWriterCtx, WriteableElement};
+use crate::ebml::tag::write::{ElementWriterCtx, WriteableElement, write_element};
 use crate::ebml::{ElementId, MatroskaTagRef};
 use crate::io::FileLike;
 
 use std::io::Cursor;
 
 // Segment\Tags
-impl<'a> WriteableElement for MatroskaTagRef<'a>
-{
+impl<'a> WriteableElement for MatroskaTagRef<'a> {
 	const ID: ElementId = ElementId(0x1254_C367);
 
 	fn write_element<F: FileLike>(
diff --git a/lofty/src/ebml/tag/write/elements/target.rs b/lofty/src/ebml/tag/write/elements/target.rs
@@ -93,10 +93,7 @@ mod tests {
 		let mut buf = Cursor::new(Vec::new());
 		let target_descriptor = TargetDescriptor::from(&target);
 		target_descriptor
-			.write_element(
-				ElementWriterCtx::default(),
-				&mut buf,
-			)
+			.write_element(ElementWriterCtx::default(), &mut buf)
 			.unwrap();
 
 		let expected = vec![0x63, 0xC0, 0x80];
diff --git a/lofty/src/ebml/tag/write/mod.rs b/lofty/src/ebml/tag/write/mod.rs
@@ -1,11 +1,10 @@
 mod elements;
 mod type_encodings;
 
-use crate::ebml::{ElementId, VInt};
-use crate::error::Result;
 use super::MatroskaTagRef;
 use crate::config::WriteOptions;
-use crate::error::LoftyError;
+use crate::ebml::{ElementId, VInt};
+use crate::error::{LoftyError, Result};
 use crate::io::{FileLike, Truncate};
 
 use std::io::Write;
diff --git a/lofty/src/tag/utils.rs b/lofty/src/tag/utils.rs
@@ -99,8 +99,7 @@ pub(crate) fn dump_tag<W: Write>(
 			}
 		}
 		.dump_to(writer, write_options),
-		TagType::Matroska => ebml::tag::MatroskaTagRef::from(tag)
-		.dump_to(writer, write_options),
+		TagType::Matroska => ebml::tag::MatroskaTagRef::from(tag).dump_to(writer, write_options),
 		_ => Ok(()),
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -29,4 +29,4 @@ impl WriteableElement for TagRef<'_> {`
`29`	`29`
`30`	`30`	`Ok(())`
`31`	`31`	`}`
`32`		`-}`
	`32`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -99,8 +99,7 @@ pub(crate) fn dump_tag<W: Write>(`
`99`	`99`	`}`
`100`	`100`	`}`
`101`	`101`	`.dump_to(writer, write_options),`
`102`		`- TagType::Matroska => ebml::tag::MatroskaTagRef::from(tag)`
`103`		`- .dump_to(writer, write_options),`
	`102`	`+ TagType::Matroska => ebml::tag::MatroskaTagRef::from(tag).dump_to(writer, write_options),`
`104`	`103`	`_ => Ok(()),`
`105`	`104`	`}`
`106`	`105`	`}`