diff --git a/unshackle/core/config.py b/unshackle/core/config.py index 6017114..d102471 100644 --- a/unshackle/core/config.py +++ b/unshackle/core/config.py @@ -90,8 +90,7 @@ class Config: self.tmdb_api_key: str = kwargs.get("tmdb_api_key") or "" self.update_checks: bool = kwargs.get("update_checks", True) self.update_check_interval: int = kwargs.get("update_check_interval", 24) - self.scene_naming: bool = kwargs.get("scene_naming", True) - self.series_year: bool = kwargs.get("series_year", True) + self.output_template: dict = kwargs.get("output_template") or {} self.title_cache_time: int = kwargs.get("title_cache_time", 1800) # 30 minutes default self.title_cache_max_retention: int = kwargs.get("title_cache_max_retention", 86400) # 24 hours default diff --git a/unshackle/core/titles/episode.py b/unshackle/core/titles/episode.py index f66bcb7..619066b 100644 --- a/unshackle/core/titles/episode.py +++ b/unshackle/core/titles/episode.py @@ -12,6 +12,7 @@ from unshackle.core.config import config from unshackle.core.constants import AUDIO_CODEC_MAP, DYNAMIC_RANGE_MAP, VIDEO_CODEC_MAP from unshackle.core.titles.title import Title from unshackle.core.utilities import sanitize_filename +from unshackle.core.utils.template_formatter import TemplateFormatter class Episode(Title): @@ -78,117 +79,123 @@ class Episode(Title): self.year = year self.description = description + def _build_template_context(self, media_info: MediaInfo, show_service: bool = True) -> dict: + """Build template context dictionary from MediaInfo.""" + primary_video_track = next(iter(media_info.video_tracks), None) + primary_audio_track = next(iter(media_info.audio_tracks), None) + unique_audio_languages = len({x.language.split("-")[0] for x in media_info.audio_tracks if x.language}) + + context = { + "title": self.title.replace("$", "S"), + "year": self.year or "", + "season": f"S{self.season:02}", + "episode": f"E{self.number:02}", + "season_episode": f"S{self.season:02}E{self.number:02}", + "episode_name": self.name or "", + "tag": config.tag or "", + "source": self.service.__name__ if show_service else "", + } + + # Video information + if primary_video_track: + resolution = primary_video_track.height + aspect_ratio = [int(float(plane)) for plane in primary_video_track.other_display_aspect_ratio[0].split(":")] + if len(aspect_ratio) == 1: + aspect_ratio.append(1) + if aspect_ratio[0] / aspect_ratio[1] not in (16 / 9, 4 / 3): + resolution = int(primary_video_track.width * (9 / 16)) + + context.update( + { + "quality": f"{resolution}p", + "resolution": str(resolution), + "video": VIDEO_CODEC_MAP.get(primary_video_track.format, primary_video_track.format), + } + ) + + # HDR information + hdr_format = primary_video_track.hdr_format_commercial + trc = primary_video_track.transfer_characteristics or primary_video_track.transfer_characteristics_original + if hdr_format: + if (primary_video_track.hdr_format or "").startswith("Dolby Vision"): + context["hdr"] = "DV" + base_layer = DYNAMIC_RANGE_MAP.get(hdr_format) + if base_layer and base_layer != "DV": + context["hdr"] += f".{base_layer}" + else: + context["hdr"] = DYNAMIC_RANGE_MAP.get(hdr_format, "") + elif trc and "HLG" in trc: + context["hdr"] = "HLG" + else: + context["hdr"] = "" + + # High frame rate + frame_rate = float(primary_video_track.frame_rate) + context["hfr"] = "HFR" if frame_rate > 30 else "" + + # Audio information + if primary_audio_track: + codec = primary_audio_track.format + channel_layout = primary_audio_track.channel_layout or primary_audio_track.channellayout_original + + if channel_layout: + channels = float(sum({"LFE": 0.1}.get(position.upper(), 1) for position in channel_layout.split(" "))) + else: + channel_count = primary_audio_track.channel_s or primary_audio_track.channels or 0 + channels = float(channel_count) + + features = primary_audio_track.format_additionalfeatures or "" + + context.update( + { + "audio": AUDIO_CODEC_MAP.get(codec, codec), + "audio_channels": f"{channels:.1f}", + "audio_full": f"{AUDIO_CODEC_MAP.get(codec, codec)}{channels:.1f}", + "atmos": "Atmos" if ("JOC" in features or primary_audio_track.joc) else "", + } + ) + + # Multi-language audio + if unique_audio_languages == 2: + context["dual"] = "DUAL" + context["multi"] = "" + elif unique_audio_languages > 2: + context["dual"] = "" + context["multi"] = "MULTi" + else: + context["dual"] = "" + context["multi"] = "" + + return context + def __str__(self) -> str: return "{title}{year} S{season:02}E{number:02} {name}".format( title=self.title, - year=f" {self.year}" if self.year and config.series_year else "", + year=f" {self.year}" if self.year else "", season=self.season, number=self.number, name=self.name or "", ).strip() def get_filename(self, media_info: MediaInfo, folder: bool = False, show_service: bool = True) -> str: - primary_video_track = next(iter(media_info.video_tracks), None) - primary_audio_track = next(iter(media_info.audio_tracks), None) - unique_audio_languages = len({x.language.split("-")[0] for x in media_info.audio_tracks if x.language}) - - # Title [Year] SXXEXX Name (or Title [Year] SXX if folder) if folder: + # For folders, use simple naming: "Title Year S01" name = f"{self.title}" - if self.year and config.series_year: + if self.year: name += f" {self.year}" name += f" S{self.season:02}" - else: - name = "{title}{year} S{season:02}E{number:02} {name}".format( - title=self.title.replace("$", "S"), # e.g., Arli$$ - year=f" {self.year}" if self.year and config.series_year else "", - season=self.season, - number=self.number, - name=self.name or "", - ).strip() - - if config.scene_naming: - # Resolution - if primary_video_track: - resolution = primary_video_track.height - aspect_ratio = [ - int(float(plane)) for plane in primary_video_track.other_display_aspect_ratio[0].split(":") - ] - if len(aspect_ratio) == 1: - # e.g., aspect ratio of 2 (2.00:1) would end up as `(2.0,)`, add 1 - aspect_ratio.append(1) - if aspect_ratio[0] / aspect_ratio[1] not in (16 / 9, 4 / 3): - # We want the resolution represented in a 4:3 or 16:9 canvas. - # If it's not 4:3 or 16:9, calculate as if it's inside a 16:9 canvas, - # otherwise the track's height value is fine. - # We are assuming this title is some weird aspect ratio so most - # likely a movie or HD source, so it's most likely widescreen so - # 16:9 canvas makes the most sense. - resolution = int(primary_video_track.width * (9 / 16)) - name += f" {resolution}p" - - # Service - if show_service: - name += f" {self.service.__name__}" - - # 'WEB-DL' - name += " WEB-DL" - - # DUAL - if unique_audio_languages == 2: - name += " DUAL" - - # MULTi - if unique_audio_languages > 2: - name += " MULTi" - - # Audio Codec + Channels (+ feature) - if primary_audio_track: - codec = primary_audio_track.format - channel_layout = primary_audio_track.channel_layout or primary_audio_track.channellayout_original - if channel_layout: - channels = float( - sum({"LFE": 0.1}.get(position.upper(), 1) for position in channel_layout.split(" ")) - ) - else: - channel_count = primary_audio_track.channel_s or primary_audio_track.channels or 0 - channels = float(channel_count) - - features = primary_audio_track.format_additionalfeatures or "" - name += f" {AUDIO_CODEC_MAP.get(codec, codec)}{channels:.1f}" - if "JOC" in features or primary_audio_track.joc: - name += " Atmos" - - # Video (dynamic range + hfr +) Codec - if primary_video_track: - codec = primary_video_track.format - hdr_format = primary_video_track.hdr_format_commercial - trc = ( - primary_video_track.transfer_characteristics - or primary_video_track.transfer_characteristics_original - ) - frame_rate = float(primary_video_track.frame_rate) - if hdr_format: - if (primary_video_track.hdr_format or "").startswith("Dolby Vision"): - name += " DV" - if DYNAMIC_RANGE_MAP.get(hdr_format) and DYNAMIC_RANGE_MAP.get(hdr_format) != "DV": - name += " HDR" - else: - name += f" {DYNAMIC_RANGE_MAP.get(hdr_format)} " - elif trc and "HLG" in trc: - name += " HLG" - if frame_rate > 30: - name += " HFR" - name += f" {VIDEO_CODEC_MAP.get(codec, codec)}" - - if config.tag: - name += f"-{config.tag}" - - return sanitize_filename(name) - else: - # Simple naming style without technical details - use spaces instead of dots return sanitize_filename(name, " ") + # Use custom template if defined, otherwise use default scene-style template + template = ( + config.output_template.get("series") + or "{title}.{year?}.{season_episode}.{episode_name?}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{audio_full}.{atmos?}.{hdr?}.{hfr?}.{video}-{tag}" + ) + + formatter = TemplateFormatter(template) + context = self._build_template_context(media_info, show_service) + return formatter.format(context) + class Series(SortedKeyList, ABC): def __init__(self, iterable: Optional[Iterable] = None): @@ -197,7 +204,7 @@ class Series(SortedKeyList, ABC): def __str__(self) -> str: if not self: return super().__str__() - return self[0].title + (f" ({self[0].year})" if self[0].year and config.series_year else "") + return self[0].title + (f" ({self[0].year})" if self[0].year else "") def tree(self, verbose: bool = False) -> Tree: seasons = Counter(x.season for x in self) diff --git a/unshackle/core/titles/movie.py b/unshackle/core/titles/movie.py index 3d552d2..6024eda 100644 --- a/unshackle/core/titles/movie.py +++ b/unshackle/core/titles/movie.py @@ -9,7 +9,7 @@ from sortedcontainers import SortedKeyList from unshackle.core.config import config from unshackle.core.constants import AUDIO_CODEC_MAP, DYNAMIC_RANGE_MAP, VIDEO_CODEC_MAP from unshackle.core.titles.title import Title -from unshackle.core.utilities import sanitize_filename +from unshackle.core.utils.template_formatter import TemplateFormatter class Movie(Title): @@ -45,100 +45,106 @@ class Movie(Title): self.year = year self.description = description + def _build_template_context(self, media_info: MediaInfo, show_service: bool = True) -> dict: + """Build template context dictionary from MediaInfo.""" + primary_video_track = next(iter(media_info.video_tracks), None) + primary_audio_track = next(iter(media_info.audio_tracks), None) + unique_audio_languages = len({x.language.split("-")[0] for x in media_info.audio_tracks if x.language}) + + context = { + "title": self.name.replace("$", "S"), + "year": self.year or "", + "tag": config.tag or "", + "source": self.service.__name__ if show_service else "", + } + + # Video information + if primary_video_track: + resolution = primary_video_track.height + aspect_ratio = [int(float(plane)) for plane in primary_video_track.other_display_aspect_ratio[0].split(":")] + if len(aspect_ratio) == 1: + aspect_ratio.append(1) + if aspect_ratio[0] / aspect_ratio[1] not in (16 / 9, 4 / 3): + resolution = int(primary_video_track.width * (9 / 16)) + + context.update( + { + "quality": f"{resolution}p", + "resolution": str(resolution), + "video": VIDEO_CODEC_MAP.get(primary_video_track.format, primary_video_track.format), + } + ) + + # HDR information + hdr_format = primary_video_track.hdr_format_commercial + trc = primary_video_track.transfer_characteristics or primary_video_track.transfer_characteristics_original + if hdr_format: + if (primary_video_track.hdr_format or "").startswith("Dolby Vision"): + context["hdr"] = "DV" + base_layer = DYNAMIC_RANGE_MAP.get(hdr_format) + if base_layer and base_layer != "DV": + context["hdr"] += f".{base_layer}" + else: + context["hdr"] = DYNAMIC_RANGE_MAP.get(hdr_format, "") + elif trc and "HLG" in trc: + context["hdr"] = "HLG" + else: + context["hdr"] = "" + + # High frame rate + frame_rate = float(primary_video_track.frame_rate) + context["hfr"] = "HFR" if frame_rate > 30 else "" + + # Audio information + if primary_audio_track: + codec = primary_audio_track.format + channel_layout = primary_audio_track.channel_layout or primary_audio_track.channellayout_original + + if channel_layout: + channels = float(sum({"LFE": 0.1}.get(position.upper(), 1) for position in channel_layout.split(" "))) + else: + channel_count = primary_audio_track.channel_s or primary_audio_track.channels or 0 + channels = float(channel_count) + + features = primary_audio_track.format_additionalfeatures or "" + + context.update( + { + "audio": AUDIO_CODEC_MAP.get(codec, codec), + "audio_channels": f"{channels:.1f}", + "audio_full": f"{AUDIO_CODEC_MAP.get(codec, codec)}{channels:.1f}", + "atmos": "Atmos" if ("JOC" in features or primary_audio_track.joc) else "", + } + ) + + # Multi-language audio + if unique_audio_languages == 2: + context["dual"] = "DUAL" + context["multi"] = "" + elif unique_audio_languages > 2: + context["dual"] = "" + context["multi"] = "MULTi" + else: + context["dual"] = "" + context["multi"] = "" + + return context + def __str__(self) -> str: if self.year: return f"{self.name} ({self.year})" return self.name def get_filename(self, media_info: MediaInfo, folder: bool = False, show_service: bool = True) -> str: - primary_video_track = next(iter(media_info.video_tracks), None) - primary_audio_track = next(iter(media_info.audio_tracks), None) - unique_audio_languages = len({x.language.split("-")[0] for x in media_info.audio_tracks if x.language}) + # Use custom template if defined, otherwise use default scene-style template + template = ( + config.output_template.get("movies") + or "{title}.{year}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{audio_full}.{atmos?}.{hdr?}.{hfr?}.{video}-{tag}" + ) - # Name (Year) - name = str(self).replace("$", "S") # e.g., Arli$$ - - if config.scene_naming: - # Resolution - if primary_video_track: - resolution = primary_video_track.height - aspect_ratio = [ - int(float(plane)) for plane in primary_video_track.other_display_aspect_ratio[0].split(":") - ] - if len(aspect_ratio) == 1: - # e.g., aspect ratio of 2 (2.00:1) would end up as `(2.0,)`, add 1 - aspect_ratio.append(1) - if aspect_ratio[0] / aspect_ratio[1] not in (16 / 9, 4 / 3): - # We want the resolution represented in a 4:3 or 16:9 canvas. - # If it's not 4:3 or 16:9, calculate as if it's inside a 16:9 canvas, - # otherwise the track's height value is fine. - # We are assuming this title is some weird aspect ratio so most - # likely a movie or HD source, so it's most likely widescreen so - # 16:9 canvas makes the most sense. - resolution = int(primary_video_track.width * (9 / 16)) - name += f" {resolution}p" - - # Service - if show_service: - name += f" {self.service.__name__}" - - # 'WEB-DL' - name += " WEB-DL" - - # DUAL - if unique_audio_languages == 2: - name += " DUAL" - - # MULTi - if unique_audio_languages > 2: - name += " MULTi" - - # Audio Codec + Channels (+ feature) - if primary_audio_track: - codec = primary_audio_track.format - channel_layout = primary_audio_track.channel_layout or primary_audio_track.channellayout_original - if channel_layout: - channels = float( - sum({"LFE": 0.1}.get(position.upper(), 1) for position in channel_layout.split(" ")) - ) - else: - channel_count = primary_audio_track.channel_s or primary_audio_track.channels or 0 - channels = float(channel_count) - - features = primary_audio_track.format_additionalfeatures or "" - name += f" {AUDIO_CODEC_MAP.get(codec, codec)}{channels:.1f}" - if "JOC" in features or primary_audio_track.joc: - name += " Atmos" - - # Video (dynamic range + hfr +) Codec - if primary_video_track: - codec = primary_video_track.format - hdr_format = primary_video_track.hdr_format_commercial - trc = ( - primary_video_track.transfer_characteristics - or primary_video_track.transfer_characteristics_original - ) - frame_rate = float(primary_video_track.frame_rate) - if hdr_format: - if (primary_video_track.hdr_format or "").startswith("Dolby Vision"): - name += " DV" - if DYNAMIC_RANGE_MAP.get(hdr_format) and DYNAMIC_RANGE_MAP.get(hdr_format) != "DV": - name += " HDR" - else: - name += f" {DYNAMIC_RANGE_MAP.get(hdr_format)} " - elif trc and "HLG" in trc: - name += " HLG" - if frame_rate > 30: - name += " HFR" - name += f" {VIDEO_CODEC_MAP.get(codec, codec)}" - - if config.tag: - name += f"-{config.tag}" - - return sanitize_filename(name) - else: - # Simple naming style without technical details - use spaces instead of dots - return sanitize_filename(name, " ") + formatter = TemplateFormatter(template) + context = self._build_template_context(media_info, show_service) + return formatter.format(context) class Movies(SortedKeyList, ABC): diff --git a/unshackle/core/utils/template_formatter.py b/unshackle/core/utils/template_formatter.py new file mode 100644 index 0000000..2232548 --- /dev/null +++ b/unshackle/core/utils/template_formatter.py @@ -0,0 +1,114 @@ +import re +from typing import Dict, Any, List, Optional + +from unshackle.core.utilities import sanitize_filename + + +class TemplateFormatter: + """ + Template formatter for custom filename patterns. + + Supports variable substitution and conditional variables. + Example: '{title}.{year}.{quality?}.{source}-{tag}' + """ + + def __init__(self, template: str): + """Initialize the template formatter. + + Args: + template: Template string with variables in {variable} format + """ + self.template = template + self.variables = self._extract_variables() + + def _extract_variables(self) -> List[str]: + """Extract all variables from the template.""" + pattern = r'\{([^}]+)\}' + matches = re.findall(pattern, self.template) + return [match.strip() for match in matches] + + def format(self, context: Dict[str, Any]) -> str: + """Format the template with the provided context. + + Args: + context: Dictionary containing variable values + + Returns: + Formatted filename string + """ + result = self.template + + for variable in self.variables: + placeholder = '{' + variable + '}' + is_conditional = variable.endswith('?') + + if is_conditional: + # Remove the ? for conditional variables + var_name = variable[:-1] + value = context.get(var_name, '') + + if value: + # Replace with actual value + result = result.replace(placeholder, str(value)) + else: + # Remove the placeholder entirely for empty conditional variables + result = result.replace(placeholder, '') + else: + # Regular variable + value = context.get(variable, '') + result = result.replace(placeholder, str(value)) + + # Clean up multiple consecutive dots/separators and other artifacts + result = re.sub(r'\.{2,}', '.', result) # Multiple dots -> single dot + result = re.sub(r'\s{2,}', ' ', result) # Multiple spaces -> single space + result = re.sub(r'^[\.\s]+|[\.\s]+$', '', result) # Remove leading/trailing dots and spaces + result = re.sub(r'\.-', '-', result) # Remove dots before dashes (for dot-based templates) + result = re.sub(r'[\.\s]+\)', ')', result) # Remove dots/spaces before closing parentheses + + # Determine the appropriate separator based on template style + # If the template contains spaces (like Plex-friendly), preserve them + if ' ' in self.template and '.' not in self.template: + # Space-based template (Plex-friendly) - use space separator + result = sanitize_filename(result, spacer=' ') + else: + # Dot-based template (scene-style) - use dot separator + result = sanitize_filename(result, spacer='.') + + return result + + def validate(self, context: Dict[str, Any]) -> tuple[bool, List[str]]: + """Validate that all required variables are present in context. + + Args: + context: Dictionary containing variable values + + Returns: + Tuple of (is_valid, missing_variables) + """ + missing = [] + + for variable in self.variables: + is_conditional = variable.endswith('?') + var_name = variable[:-1] if is_conditional else variable + + # Only check non-conditional variables + if not is_conditional and var_name not in context: + missing.append(var_name) + + return len(missing) == 0, missing + + def get_required_variables(self) -> List[str]: + """Get list of required (non-conditional) variables.""" + required = [] + for variable in self.variables: + if not variable.endswith('?'): + required.append(variable) + return required + + def get_optional_variables(self) -> List[str]: + """Get list of optional (conditional) variables.""" + optional = [] + for variable in self.variables: + if variable.endswith('?'): + optional.append(variable[:-1]) # Remove the ? + return optional \ No newline at end of file diff --git a/unshackle/unshackle-example.yaml b/unshackle/unshackle-example.yaml index 1b937e3..29525ce 100644 --- a/unshackle/unshackle-example.yaml +++ b/unshackle/unshackle-example.yaml @@ -10,15 +10,40 @@ tag_imdb_tmdb: true # Set terminal background color (custom option not in CONFIG.md) set_terminal_bg: false -# Set file naming convention -# true for style - Prime.Suspect.S07E01.The.Final.Act.Part.One.1080p.ITV.WEB-DL.AAC2.0.H.264 -# false for style - Prime Suspect S07E01 The Final Act - Part One -scene_naming: true +# File naming is now controlled via output_template (see below) +# Default behavior provides scene-style naming similar to the old scene_naming: true -# Whether to include the year in series names for episodes and folders (default: true) -# true for style - Show Name (2023) S01E01 Episode Name -# false for style - Show Name S01E01 Episode Name -series_year: true +# Custom output templates for filenames +# When not defined, defaults to scene-style naming equivalent to the old scene_naming: true +# Available variables: {title}, {year}, {season}, {episode}, {season_episode}, {episode_name}, +# {quality}, {resolution}, {source}, {audio}, {audio_channels}, {audio_full}, +# {video}, {hdr}, {hfr}, {atmos}, {dual}, {multi}, {tag} +# Conditional variables (included only if present): Add ? suffix like {year?}, {episode_name?}, {hdr?} +# Uncomment and customize the templates below: +# +# output_template: +# # Scene-style naming (dot-separated) - Default behavior when no template is defined +# movies: '{title}.{year}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{audio_full}.{atmos?}.{hdr?}.{hfr?}.{video}-{tag}' +# series: '{title}.{year?}.{season_episode}.{episode_name?}.{quality}.{source}.WEB-DL.{dual?}.{multi?}.{audio_full}.{atmos?}.{hdr?}.{hfr?}.{video}-{tag}' +# +# # Plex-friendly naming (space-separated, clean format) +# # movies: '{title} ({year}) {quality}' +# # series: '{title} {season_episode} {episode_name?}' +# +# # Minimal naming (basic info only) +# # movies: '{title}.{year}.{quality}' +# # series: '{title}.{season_episode}.{episode_name?}' +# +# # Custom scene-style with specific elements +# # movies: '{title}.{year}.{quality}.{hdr?}.{source}.WEB-DL.{audio_full}.{video}-{tag}' +# # series: '{title}.{year?}.{season_episode}.{episode_name?}.{quality}.{hdr?}.{source}.WEB-DL.{audio_full}.{atmos?}.{video}-{tag}' +# +# Example outputs: +# Scene movies: 'The.Matrix.1999.1080p.NF.WEB-DL.DDP5.1.H.264-EXAMPLE' +# Scene movies (HDR): 'Dune.2021.2160p.HBO.WEB-DL.DDP5.1.HDR10.H.265-EXAMPLE' +# Scene series: 'Breaking.Bad.2008.S01E01.Pilot.1080p.NF.WEB-DL.DDP5.1.H.264-EXAMPLE' +# Plex movies: 'The Matrix (1999) 1080p' +# Plex series: 'Breaking Bad S01E01 Pilot' # Check for updates from GitHub repository on startup (default: true) update_checks: true @@ -28,9 +53,9 @@ update_check_interval: 24 # Title caching configuration # Cache title metadata to reduce redundant API calls -title_cache_enabled: true # Enable/disable title caching globally (default: true) -title_cache_time: 1800 # Cache duration in seconds (default: 1800 = 30 minutes) -title_cache_max_retention: 86400 # Maximum cache retention for fallback when API fails (default: 86400 = 24 hours) +title_cache_enabled: true # Enable/disable title caching globally (default: true) +title_cache_time: 1800 # Cache duration in seconds (default: 1800 = 30 minutes) +title_cache_max_retention: 86400 # Maximum cache retention for fallback when API fails (default: 86400 = 24 hours) # Muxing configuration muxing: