danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[FEATURE] Add mp3 id3v2.4 multi-tag support

Browse source
This commit is contained in:
Jesse Bannon 2022-11-24 00:04:49 -08:00
parent 5d9fe2eaae
commit c281970e1f
4 changed files with 60 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

74
src/ytdl_sub/plugins/music_tags.py
View file

@ -1,5 +1,7 @@
from collections import defaultdict
from typing import Any
from typing import Dict
from typing import List
import mediafile
@ -7,10 +9,40 @@ from ytdl_sub.entries.entry import Entry
from ytdl_sub.plugins.plugin import Plugin
from ytdl_sub.plugins.plugin import PluginOptions
from ytdl_sub.utils.file_handler import FileMetadata
from ytdl_sub.utils.logger import Logger
from ytdl_sub.utils.thumbnail import convert_download_thumbnail
from ytdl_sub.validators.string_formatter_validators import DictFormatterValidator
from ytdl_sub.validators.strict_dict_validator import StrictDictValidator
from ytdl_sub.validators.string_formatter_validators import ListFormatterValidator
from ytdl_sub.validators.string_formatter_validators import StringFormatterValidator
from ytdl_sub.validators.validators import BoolValidator
logger = Logger.get("music_tags")
class MusicTagsValidator(StrictDictValidator):
"""
Validator for the music_tag's `tags` field. Treat each value as a list.
Can still specify it like a single value but under-the-hood it's a list of a single element.
"""
_optional_keys = set(list(mediafile.MediaFile.sorted_fields()))
def __init__(self, name, value):
super().__init__(name, value)
self._tags: Dict[str, List[StringFormatterValidator]] = {}
for key in self._keys:
self._tags[key] = self._validate_key(key=key, validator=ListFormatterValidator).list
@property
def as_lists(self) -> Dict[str, List[StringFormatterValidator]]:
"""
Returns
-------
Tag formatter(s) as a list
"""
return self._tags
class MusicTagsOptions(PluginOptions):
"""
@ -32,7 +64,10 @@ class MusicTagsOptions(PluginOptions):
tags:
artist: "{artist}"
album: "{album}"
genre: "ytdl downloaded music"
# Supports id3v2.4 multi-tags
genre:
- "Lofi"
- "ytdl-sub"
# Optional
embed_thumbnail: False
"""
@ -52,13 +87,13 @@ class MusicTagsOptions(PluginOptions):
def __init__(self, name, value):
super().__init__(name, value)
self._tags = self._validate_key(key="tags", validator=DictFormatterValidator)
self._tags = self._validate_key(key="tags", validator=MusicTagsValidator)
self._embed_thumbnail = self._validate_key_if_present(
key="embed_thumbnail", validator=BoolValidator, default=False
).value
@property
def tags(self) -> DictFormatterValidator:
def tags(self) -> MusicTagsValidator:
"""
Key/values of tag names/tag values. Supports source and override variables.
"""
@ -79,32 +114,29 @@ class MusicTagsPlugin(Plugin[MusicTagsOptions]):
"""
Tags the entry's audio file using values defined in the metadata options
"""
supported_fields = list(mediafile.MediaFile.sorted_fields())
tags_to_write: Dict[str, str] = {}
for tag_name, tag_formatter in self.plugin_options.tags.dict.items():
if tag_name not in supported_fields:
# TODO: Add support for custom fields
self._logger.warning(
"tag '%s' is not supported for %s files. Supported tags: %s",
tag_name,
entry.ext,
", ".join(sorted(supported_fields)),
)
continue
# Resolve the tags into this dict
tags_to_write: Dict[str, List[str]] = defaultdict(list)
for tag_name, tag_formatters in self.plugin_options.tags.as_lists.items():
for tag_formatter in tag_formatters:
tag_value = self.overrides.apply_formatter(formatter=tag_formatter, entry=entry)
tags_to_write[tag_name] = tag_value
tags_to_write[tag_name].append(tag_value)
# write the actual tags if its not a dry run
if not self.is_dry_run:
audio_file = mediafile.MediaFile(entry.get_download_file_path())
for tag_name, tag_value in tags_to_write.items():
# If the attribute is a List-type, set it as the first element of the list
# If the attribute is a List-type, set it as the list type
if isinstance(getattr(audio_file, tag_name), list):
setattr(audio_file, tag_name, [tag_value])
setattr(audio_file, tag_name, tag_value)
# Otherwise, set as single value
else:
setattr(audio_file, tag_name, tag_value)
if len(tag_value) > 1:
logger.warning(
"Music tag '%s' does not support lists. "
"Only setting the first element",
tag_name,
)
setattr(audio_file, tag_name, tag_value[0])
if self.plugin_options.embed_thumbnail:
# convert the entry thumbnail so it is embedded as jpg

3
tests/e2e/plugins/test_audio_extract.py
View file

@ -11,7 +11,8 @@ def single_song_preset_dict(output_directory):
"preset": "song",
"download": {"url": "https://www.youtube.com/watch?v=2lAe1cqCOXo"},
"output_options": {"output_directory": output_directory},
"music_tags": {"embed_thumbnail": True},
# test multi-tags
"music_tags": {"embed_thumbnail": True, "tags": {"genres": ["multi_tag_1", "multi_tag_2"]}},
# download the worst format so it is fast
"ytdl_options": {
"format": "worst[ext=mp4]",

2
tests/resources/expected_downloads_summaries/plugins/test_audio_extract_single.json
View file

@ -1,3 +1,3 @@
{
"YouTube Rewind 2019： For the Record ｜ #YouTubeRewind.mp3": "5df65e724b3c305195473c42bbc53da9"
"YouTube Rewind 2019： For the Record ｜ #YouTubeRewind.mp3": "05bd1d218f5a0c942ddb1448d939a1dc"
}

3
tests/resources/transaction_log_summaries/plugins/test_audio_extract_single.txt
View file

@ -9,6 +9,9 @@ Files created:
artist: YouTube
artists: YouTube
genre: Unset
genres:
- multi_tag_1
- multi_tag_2
title: YouTube Rewind 2019: For the Record | #YouTubeRewind
track: 1
year: 2019