EBML: Stub implement EbmlFile and EbmlTag

Author: Serial-ATA

lofty_attr/src/internal.rs

@@ -9,9 +9,9 @@ use quote::quote;
 pub(crate) fn opt_internal_file_type(
 	struct_name: String,
 ) -> Option<(proc_macro2::TokenStream, bool)> {
-	const LOFTY_FILE_TYPES: [&str; 12] = [
-		"Aac", "Aiff", "Ape", "Flac", "Mpeg", "Mp4", "Mpc", "Opus", "Vorbis", "Speex", "Wav",
-		"WavPack",
+	const LOFTY_FILE_TYPES: [&str; 13] = [
+		"Aac", "Aiff", "Ape", "Ebml", "Flac", "Mpeg", "Mp4", "Mpc", "Opus", "Vorbis", "Speex",
+		"Wav", "WavPack",
 	];
 
 	const ID3V2_STRIPPABLE: [&str; 2] = ["Flac", "Ape"];

src/ebml/mod.rs

@@ -0,0 +1,22 @@
+//! EBML specific items
+mod properties;
+mod read;
+mod tag;
+
+use lofty_attr::LoftyFile;
+
+// Exports
+
+pub use properties::EbmlProperties;
+pub use tag::EbmlTag;
+
+/// An EBML file
+#[derive(LoftyFile, Default)]
+#[lofty(read_fn = "read::read_from")]
+pub struct EbmlFile {
+	/// An ID3v2 tag
+	#[lofty(tag_type = "Id3v2")]
+	pub(crate) ebml_tag: Option<EbmlTag>,
+	/// The file's audio properties
+	pub(crate) properties: EbmlProperties,
+}

src/ebml/properties.rs

@@ -0,0 +1,11 @@
+use crate::properties::FileProperties;
+
+/// EBML audio properties
+#[derive(Debug, Clone, PartialEq, Default)]
+pub struct EbmlProperties {}
+
+impl From<EbmlProperties> for FileProperties {
+	fn from(input: EbmlProperties) -> Self {
+		todo!()
+	}
+}

src/ebml/read.rs

@@ -0,0 +1,12 @@
+use super::EbmlFile;
+use crate::error::Result;
+use crate::probe::ParseOptions;
+
+use std::io::{Read, Seek};
+
+pub(super) fn read_from<R>(reader: &mut R, parse_options: ParseOptions) -> Result<EbmlFile>
+where
+	R: Read + Seek,
+{
+	todo!()
+}

src/ebml/tag/mod.rs

@@ -0,0 +1,99 @@
+use crate::error::LoftyError;
+use crate::tag::Tag;
+use crate::traits::{Accessor, MergeTag, SplitTag, TagExt};
+
+use std::fs::File;
+use std::io::Write;
+use std::ops::Deref;
+use std::path::Path;
+
+use lofty_attr::tag;
+
+/// TODO
+#[derive(Default, Debug, PartialEq, Eq, Clone)]
+#[tag(description = "An `EBML` tag", supported_formats(Ebml))]
+pub struct EbmlTag {}
+
+impl Accessor for EbmlTag {}
+
+impl TagExt for EbmlTag {
+	type Err = LoftyError;
+	type RefKey<'a> = &'a str;
+
+	fn len(&self) -> usize {
+		todo!()
+	}
+
+	fn contains<'a>(&'a self, key: Self::RefKey<'a>) -> bool {
+		todo!()
+	}
+
+	fn is_empty(&self) -> bool {
+		todo!()
+	}
+
+	fn save_to(&self, file: &mut File) -> std::result::Result<(), Self::Err> {
+		todo!()
+	}
+
+	fn dump_to<W: Write>(&self, writer: &mut W) -> std::result::Result<(), Self::Err> {
+		todo!()
+	}
+
+	fn remove_from_path<P: AsRef<Path>>(&self, path: P) -> std::result::Result<(), Self::Err> {
+		todo!()
+	}
+
+	fn remove_from(&self, file: &mut File) -> std::result::Result<(), Self::Err> {
+		todo!()
+	}
+
+	fn clear(&mut self) {
+		todo!()
+	}
+}
+
+#[derive(Debug, Clone, Default)]
+pub struct SplitTagRemainder(EbmlTag);
+
+impl From<SplitTagRemainder> for EbmlTag {
+	fn from(from: SplitTagRemainder) -> Self {
+		from.0
+	}
+}
+
+impl Deref for SplitTagRemainder {
+	type Target = EbmlTag;
+
+	fn deref(&self) -> &Self::Target {
+		&self.0
+	}
+}
+
+impl SplitTag for EbmlTag {
+	type Remainder = SplitTagRemainder;
+
+	fn split_tag(mut self) -> (Self::Remainder, Tag) {
+		todo!()
+	}
+}
+
+impl MergeTag for SplitTagRemainder {
+	type Merged = EbmlTag;
+
+	fn merge_tag(self, tag: Tag) -> Self::Merged {
+		todo!()
+	}
+}
+
+impl From<EbmlTag> for Tag {
+	fn from(input: EbmlTag) -> Self {
+		input.split_tag().1
+	}
+}
+
+impl From<Tag> for EbmlTag {
+	fn from(input: Tag) -> Self {
+		SplitTagRemainder::default().merge_tag(input)
+	}
+}

src/file.rs

@@ -717,6 +717,7 @@ pub enum FileType {
 	Aac,
 	Aiff,
 	Ape,
+	Ebml,
 	Flac,
 	Mpeg,
 	Mp4,
@@ -755,6 +756,7 @@ impl FileType {
 		match self {
 			FileType::Aiff | FileType::Mpeg | FileType::Wav | FileType::Aac => TagType::Id3v2,
 			FileType::Ape | FileType::Mpc | FileType::WavPack => TagType::Ape,
+			FileType::Ebml => TagType::Ebml,
 			FileType::Flac | FileType::Opus | FileType::Vorbis | FileType::Speex => {
 				TagType::VorbisComments
 			},
@@ -791,13 +793,14 @@ impl FileType {
 		}
 
 		match tag_type {
+			TagType::AiffText => crate::iff::aiff::AIFFTextChunks::SUPPORTED_FORMATS.contains(self),
 			TagType::Ape => crate::ape::ApeTag::SUPPORTED_FORMATS.contains(self),
+			TagType::Ebml => crate::ebml::EbmlTag::SUPPORTED_FORMATS.contains(self),
 			TagType::Id3v1 => crate::id3::v1::Id3v1Tag::SUPPORTED_FORMATS.contains(self),
 			TagType::Id3v2 => crate::id3::v2::Id3v2Tag::SUPPORTED_FORMATS.contains(self),
 			TagType::Mp4Ilst => crate::mp4::Ilst::SUPPORTED_FORMATS.contains(self),
-			TagType::VorbisComments => crate::ogg::VorbisComments::SUPPORTED_FORMATS.contains(self),
 			TagType::RiffInfo => crate::iff::wav::RIFFInfoList::SUPPORTED_FORMATS.contains(self),
-			TagType::AiffText => crate::iff::aiff::AIFFTextChunks::SUPPORTED_FORMATS.contains(self),
+			TagType::VorbisComments => crate::ogg::VorbisComments::SUPPORTED_FORMATS.contains(self),
 		}
 	}
 
@@ -827,6 +830,7 @@ impl FileType {
 			"opus" => Some(Self::Opus),
 			"flac" => Some(Self::Flac),
 			"ogg" => Some(Self::Vorbis),
+			"mka" | "mkv" | "webm" => Some(Self::Ebml),
 			"mp4" | "m4a" | "m4b" | "m4p" | "m4r" | "m4v" | "3gp" => Some(Self::Mp4),
 			"mpc" | "mp+" | "mpp" => Some(Self::Mpc),
 			"spx" => Some(Self::Speex),
@@ -1002,6 +1006,7 @@ impl FileType {
 				None
 			},
 			119 if buf.len() >= 4 && &buf[..4] == b"wvpk" => Some(Self::WavPack),
+			26 if buf.starts_with(&[0x1A, 0x45, 0xDF, 0xA3]) => Some(Self::Ebml),
 			_ if buf.len() >= 8 && &buf[4..8] == b"ftyp" => Some(Self::Mp4),
 			_ if buf.starts_with(b"MPCK") || buf.starts_with(b"MP+") => Some(Self::Mpc),
 			_ => None,

src/lib.rs

@@ -147,6 +147,7 @@ pub(crate) mod _this_is_internal {}
 
 pub mod aac;
 pub mod ape;
+pub mod ebml;
 pub mod error;
 pub(crate) mod file;
 pub mod flac;

src/probe.rs

@@ -16,6 +16,7 @@ use crate::ogg::vorbis::VorbisFile;
 use crate::resolve::CUSTOM_RESOLVERS;
 use crate::wavpack::WavPackFile;
 
+use crate::ebml::EbmlFile;
 use std::fs::File;
 use std::io::{BufReader, Cursor, Read, Seek, SeekFrom};
 use std::path::Path;
@@ -554,6 +555,7 @@ impl<R: Read + Seek> Probe<R> {
 				FileType::Aac => AacFile::read_from(reader, options)?.into(),
 				FileType::Aiff => AiffFile::read_from(reader, options)?.into(),
 				FileType::Ape => ApeFile::read_from(reader, options)?.into(),
+				FileType::Ebml => EbmlFile::read_from(reader, options)?.into(),
 				FileType::Flac => FlacFile::read_from(reader, options)?.into(),
 				FileType::Mpeg => MpegFile::read_from(reader, options)?.into(),
 				FileType::Opus => OpusFile::read_from(reader, options)?.into(),

src/tag/mod.rs

@@ -609,20 +609,22 @@ impl MergeTag for SplitTagRemainder {
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 #[non_exhaustive]
 pub enum TagType {
+	/// Represents AIFF text chunks
+	AiffText,
 	/// This covers both APEv1 and APEv2 as it doesn't matter much
 	Ape,
+	/// Represents an EBML tag element
+	Ebml,
 	/// Represents an ID3v1 tag
 	Id3v1,
 	/// This covers all ID3v2 versions since they all get upgraded to ID3v2.4
 	Id3v2,
 	/// Represents an MP4 ilst atom
 	Mp4Ilst,
-	/// Represents vorbis comments
-	VorbisComments,
 	/// Represents a RIFF INFO LIST
 	RiffInfo,
-	/// Represents AIFF text chunks
-	AiffText,
+	/// Represents vorbis comments
+	VorbisComments,
 }
 
 impl TagType {