lofty 0.24.0

use crate::config::WriteOptions;
use crate::error::{LoftyError, Result};
use crate::file::FileType;
use crate::macros::err;
use crate::tag::{Tag, TagType};
use crate::util::io::{FileLike, Length, Truncate};
use crate::{aac, ape, flac, iff, mpeg, musepack, wavpack};

use crate::id3::v1::tag::Id3v1TagRef;
use crate::id3::v2::tag::conversion::Id3v2TagRef;
use crate::id3::v2::{self, Id3v2TagFlags};
use crate::mp4::Ilst;
use crate::ogg::tag::{VorbisCommentsRef, create_vorbis_comments_ref};
use ape::tag::ApeTagRef;
use iff::aiff::tag::AiffTextChunksRef;
use iff::wav::tag::RIFFInfoListRef;

use std::borrow::Cow;
use std::io::Write;

#[allow(unreachable_patterns)]
pub(crate) fn write_tag<F>(
	tag: &Tag,
	file: &mut F,
	file_type: FileType,
	write_options: WriteOptions,
) -> Result<()>
where
	F: FileLike,
	LoftyError: From<<F as Truncate>::Error>,
	LoftyError: From<<F as Length>::Error>,
{
	match file_type {
		FileType::Aac => aac::write::write_to(file, tag, write_options),
		FileType::Aiff => iff::aiff::write::write_to(file, tag, write_options),
		FileType::Ape => ape::write::write_to(file, tag, write_options),
		FileType::Flac => flac::write::write_to(file, tag, write_options),
		FileType::Opus | FileType::Speex | FileType::Vorbis => {
			crate::ogg::write::write_to(file, tag, file_type, write_options)
		},
		FileType::Mpc => musepack::write::write_to(file, tag, write_options),
		FileType::Mpeg => mpeg::write::write_to(file, tag, write_options),
		FileType::Mp4 => crate::mp4::ilst::write::write_to(
			file,
			&mut Into::<Ilst>::into(tag.clone()).as_ref(),
			write_options,
		),
		FileType::Wav => iff::wav::write::write_to(file, tag, write_options),
		FileType::WavPack => wavpack::write::write_to(file, tag, write_options),
		_ => err!(UnsupportedTag),
	}
}

#[allow(unreachable_patterns)]
pub(crate) fn dump_tag<W: Write>(
	tag: &Tag,
	writer: &mut W,
	write_options: WriteOptions,
) -> Result<()> {
	match tag.tag_type() {
		TagType::Ape => ApeTagRef {
			read_only: false,
			items: ape::tag::tagitems_into_ape(tag),
		}
		.dump_to(writer, write_options),
		TagType::Id3v1 => Into::<Id3v1TagRef<'_>>::into(tag).dump_to(writer, write_options),
		TagType::Id3v2 => Id3v2TagRef {
			flags: Id3v2TagFlags::default(),
			frames: v2::tag::conversion::tag_frames(tag).peekable(),
		}
		.dump_to(writer, write_options),
		TagType::Mp4Ilst => Into::<Ilst>::into(tag.clone())
			.as_ref()
			.dump_to(writer, write_options),
		TagType::VorbisComments => {
			let (vendor, items, pictures) = create_vorbis_comments_ref(tag);

			VorbisCommentsRef {
				vendor: Cow::from(vendor),
				items,
				pictures,
			}
			.dump_to(writer, write_options)
		},
		TagType::RiffInfo => RIFFInfoListRef {
			items: iff::wav::tag::tagitems_into_riff(tag.items()),
		}
		.dump_to(writer, write_options),
		TagType::AiffText => {
			use crate::tag::item::ItemKey;

			AiffTextChunksRef {
				name: tag.get_string(ItemKey::TrackTitle),
				author: tag.get_string(ItemKey::TrackArtist),
				copyright: tag.get_string(ItemKey::CopyrightMessage),
				annotations: Some(tag.get_strings(ItemKey::Comment)),
				comments: None,
			}
		}
		.dump_to(writer, write_options),
		_ => Ok(()),
	}
}

#[cfg(test)]
// Used for tag conversion tests
pub(crate) mod test_utils {
	use crate::tag::{ItemKey, Tag, TagType};
	use std::fs::File;
	use std::io::Read;

	pub(crate) fn create_tag(tag_type: TagType) -> Tag {
		let mut tag = Tag::new(tag_type);

		tag.insert_text(ItemKey::TrackTitle, String::from("Foo title"));
		tag.insert_text(ItemKey::TrackArtist, String::from("Bar artist"));
		tag.insert_text(ItemKey::AlbumTitle, String::from("Baz album"));
		tag.insert_text(ItemKey::Comment, String::from("Qux comment"));
		tag.insert_text(ItemKey::TrackNumber, String::from("1"));
		tag.insert_text(ItemKey::Genre, String::from("Classical"));

		tag
	}

	pub(crate) fn verify_tag(tag: &Tag, track_number: bool, genre: bool) {
		assert_eq!(tag.get_string(ItemKey::TrackTitle), Some("Foo title"));
		assert_eq!(tag.get_string(ItemKey::TrackArtist), Some("Bar artist"));
		assert_eq!(tag.get_string(ItemKey::AlbumTitle), Some("Baz album"));
		assert_eq!(tag.get_string(ItemKey::Comment), Some("Qux comment"));

		if track_number {
			assert_eq!(tag.get_string(ItemKey::TrackNumber), Some("1"));
		}

		if genre {
			assert_eq!(tag.get_string(ItemKey::Genre), Some("Classical"));
		}
	}

	pub(crate) fn read_path(path: &str) -> Vec<u8> {
		read_file(&mut File::open(path).unwrap())
	}

	pub(crate) fn read_file(file: &mut File) -> Vec<u8> {
		let mut tag = Vec::new();

		file.read_to_end(&mut tag).unwrap();

		tag
	}
}