Plex
/
Plex-Meta-Manager
mirror of https://github.com/meisnate12/Plex-Meta-Manager.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

[2] changed `overlay_artwork_filetype` to accept `webp_lossy` and `webp_lossless`

Browse Source
pull/2038/head
meisnate12 7 months ago
parent f1ea92d653
commit 2aac1cd1ae
6 changed files with 38 additions and 28 deletions
Show Stats Download Patch File Download Diff File

1
CHANGELOG
Unescape View File

@ -6,6 +6,7 @@
Checks requirement versions to print a message if one needs to be updated Checks requirement versions to print a message if one needs to be updated
# Updates # Updates
Changed the `overlay_artwork_filetype` Setting to accept `webp_lossy` and `webp_lossless` while the old attribute `webp` will be treated as `webp_lossy`.
# Defaults # Defaults

2
VERSION
Unescape View File

@ -1 +1 @@
2.0.1-develop1 2.0.1-develop2

13
docs/config/settings.md
Unescape View File

@ -1001,7 +1001,8 @@ The available setting attributes which can be set at each level are outlined bel
<table class="clearTable"> <table class="clearTable">
<tr><td>`jpg`</td><td>Use JPG files for saving Overlays</td></tr> <tr><td>`jpg`</td><td>Use JPG files for saving Overlays</td></tr>
<tr><td>`png`</td><td>Use PNG files for saving Overlays</td></tr> <tr><td>`png`</td><td>Use PNG files for saving Overlays</td></tr>
<tr><td>`webp`</td><td>Use WEBP files for saving Overlays</td></tr> <tr><td>`webp_lossy`</td><td>Use Lossy WEBP files for saving Overlays</td></tr>
<tr><td>`webp_lossless`</td><td>Use Lossless WEBP files for saving Overlays</td></tr>
</table> </table>
**Default Value:** `jpg` **Default Value:** `jpg`
@ -1013,9 +1014,10 @@ The available setting attributes which can be set at each level are outlined bel
overlay_artwork_filetype: png overlay_artwork_filetype: png
``` ```
??? blank "`overlay_artwork_quality` - Used to control the JPG or WEBP quality used with overlay images.<a class="headerlink" href="#overlay-quality" title="Permanent link"></a>" ??? blank "`overlay_artwork_quality` - Used to control the JPG or Lossy WEBP quality used with overlay images.<a class="headerlink" href="#overlay-quality" title="Permanent link"></a>"
<div id="overlay-quality" />Used to control the JPG or WEBP quality used with overlay images. This setting will only be applied to images generated after the value is added to your config. <div id="overlay-quality" />Used to control the JPG or Lossy WEBP quality used with overlay images. This setting
will only be applied to images generated after the value is added to your config.
<hr style="margin: 0px;"> <hr style="margin: 0px;">
@ -1023,9 +1025,10 @@ The available setting attributes which can be set at each level are outlined bel
**Levels with this Attribute:** Global/Library **Levels with this Attribute:** Global/Library
**Accepted Values:** Any Integer 1-100 [Values over 95 are not recommended and may result in excessive image size, perhaps too large to be uploaded to Plex. **Accepted Values:** Any Integer 1-100 [Values over 95 are not recommended and may result in excessive image size,
perhaps too large to be uploaded to Plex.
**Default Value:** `75` [this default value will be used if no value is provided on this setting] **Default Value:** `None` [when no value is provided the standard 75 is used]
???+ example "Example" ???+ example "Example"

4
json-schema/config-schema.json
Unescape View File

@ -898,10 +898,10 @@
}, },
"overlay_artwork_filetype": { "overlay_artwork_filetype": {
"description": "Used to control the filetype used with overlay images.", "description": "Used to control the filetype used with overlay images.",
"enum": ["jpg", "png", "webp"] "enum": ["jpg", "png", "webp_lossy", "webp_lossless"]
}, },
"overlay_artwork_quality": { "overlay_artwork_quality": {
"description": "Used to control the JPG or WEBP quality used with overlay images.", "description": "Used to control the JPG or Lossy WEBP quality used with overlay images.",
"type": "integer", "type": "integer",
"minimum": 1, "minimum": 1,
"maximum": 100 "maximum": 100

42
modules/config.py
Unescape View File

@ -44,7 +44,8 @@ sync_modes = {"append": "Only Add Items to the Collection or Playlist", "sync":
filetype_list = { filetype_list = {
"jpg": "Use JPG files for saving Overlays", "jpg": "Use JPG files for saving Overlays",
"png": "Use PNG files for saving Overlays", "png": "Use PNG files for saving Overlays",
"webp": "Use WEBP files for saving Overlays" "webp_lossy": "Use Lossy WEBP files for saving Overlays",
"webp_lossless": "Use Lossless WEBP files for saving Overlays"
} }
imdb_label_options = { imdb_label_options = {
"remove": "Remove All IMDb Parental Labels", "remove": "Remove All IMDb Parental Labels",
@ -345,7 +346,7 @@ class ConfigFile:
if self.secrets: if self.secrets:
check_next(self.data) check_next(self.data)
def check_for_attribute(data, attribute, parent=None, test_list=None, default=None, do_print=True, default_is_none=False, req_default=False, var_type="str", throw=False, save=True, int_min=0, int_max=None): def check_for_attribute(data, attribute, parent=None, test_list=None, translations=None, default=None, do_print=True, default_is_none=False, req_default=False, var_type="str", throw=False, save=True, int_min=0, int_max=None):
endline = "" endline = ""
if parent is not None: if parent is not None:
if data and parent in data: if data and parent in data:
@ -354,6 +355,9 @@ class ConfigFile:
data = None data = None
do_print = False do_print = False
save = False save = False
final_value = data[attribute] if data and attribute in data else None
if translations and final_value in translations:
final_value = translations[final_value]
if self.read_only: if self.read_only:
save = False save = False
text = f"{attribute} attribute" if parent is None else f"{parent} sub-attribute {attribute}" text = f"{attribute} attribute" if parent is None else f"{parent} sub-attribute {attribute}"
@ -367,27 +371,27 @@ class ConfigFile:
else: endline = "" else: endline = ""
yaml.save() yaml.save()
if default_is_none and var_type in ["list", "int_list", "lower_list", "list_path"]: return default if default else [] if default_is_none and var_type in ["list", "int_list", "lower_list", "list_path"]: return default if default else []
elif data[attribute] is None: elif final_value is None:
if default_is_none and var_type in ["list", "int_list", "lower_list", "list_path"]: return default if default else [] if default_is_none and var_type in ["list", "int_list", "lower_list", "list_path"]: return default if default else []
elif default_is_none: return None elif default_is_none: return None
else: message = f"{text} is blank" else: message = f"{text} is blank"
elif var_type == "url": elif var_type == "url":
if data[attribute].endswith(("\\", "/")): return data[attribute][:-1] if final_value.endswith(("\\", "/")): return final_value[:-1]
else: return data[attribute] else: return final_value
elif var_type == "bool": elif var_type == "bool":
if isinstance(data[attribute], bool): return data[attribute] if isinstance(final_value, bool): return final_value
else: message = f"{text} must be either true or false" else: message = f"{text} must be either true or false"
elif var_type == "int": elif var_type == "int":
if isinstance(data[attribute], int) and data[attribute] >= int_min and (not int_max or data[attribute] <= int_max): if isinstance(final_value, int) and final_value >= int_min and (not int_max or final_value <= int_max):
return data[attribute] return final_value
else: else:
message = f"{text} must an integer greater than or equal to {int_min}{f' and less than or equal to {int_max}'}" message = f"{text} must an integer greater than or equal to {int_min}{f' and less than or equal to {int_max}'}"
elif var_type == "path": elif var_type == "path":
if os.path.exists(os.path.abspath(data[attribute])): return data[attribute] if os.path.exists(os.path.abspath(final_value)): return final_value
else: message = f"Path {os.path.abspath(data[attribute])} does not exist" else: message = f"Path {os.path.abspath(final_value)} does not exist"
elif var_type in ["list", "lower_list", "int_list"]: elif var_type in ["list", "lower_list", "int_list"]:
output_list = [] output_list = []
for output_item in util.get_list(data[attribute], lower=var_type == "lower_list", split=var_type != "list", int_list=var_type == "int_list"): for output_item in util.get_list(final_value, lower=var_type == "lower_list", split=var_type != "list", int_list=var_type == "int_list"):
if output_item not in output_list: if output_item not in output_list:
output_list.append(output_item) output_list.append(output_item)
failed_items = [o for o in output_list if o not in test_list] if test_list else [] failed_items = [o for o in output_list if o not in test_list] if test_list else []
@ -398,7 +402,7 @@ class ConfigFile:
elif var_type == "list_path": elif var_type == "list_path":
temp_list = [] temp_list = []
warning_message = "" warning_message = ""
for p in util.get_list(data[attribute], split=False): for p in util.get_list(final_value, split=False):
if os.path.exists(os.path.abspath(p)): if os.path.exists(os.path.abspath(p)):
temp_list.append(p) temp_list.append(p)
else: else:
@ -409,13 +413,13 @@ class ConfigFile:
logger.warning(warning_message) logger.warning(warning_message)
if len(temp_list) > 0: return temp_list if len(temp_list) > 0: return temp_list
else: message = "No Paths exist" else: message = "No Paths exist"
elif test_list is None or data[attribute] in test_list: return data[attribute] elif test_list is None or final_value in test_list: return final_value
else: message = f"{text}: {data[attribute]} is an invalid input" else: message = f"{text}: {final_value} is an invalid input"
if var_type == "path" and default and os.path.exists(os.path.abspath(default)): if var_type == "path" and default and os.path.exists(os.path.abspath(default)):
return default return default
elif var_type == "path" and default: elif var_type == "path" and default:
if data and attribute in data and data[attribute]: if final_value:
message = f"neither {data[attribute]} or the default path {default} could be found" message = f"neither {final_value} or the default path {default} could be found"
else: else:
message = f"no {text} found and the default path {default} could not be found" message = f"no {text} found and the default path {default} could not be found"
default = None default = None
@ -436,7 +440,7 @@ class ConfigFile:
raise Failed(f"Config Error: {message}") raise Failed(f"Config Error: {message}")
if do_print: if do_print:
logger.warning(f"Config Warning: {message}") logger.warning(f"Config Warning: {message}")
if data and attribute in data and data[attribute] and test_list is not None and data[attribute] not in test_list: if final_value and test_list is not None and final_value not in test_list:
logger.warning(options) logger.warning(options)
return default return default
@ -478,7 +482,7 @@ class ConfigFile:
"playlist_report": check_for_attribute(self.data, "playlist_report", parent="settings", var_type="bool", default=True), "playlist_report": check_for_attribute(self.data, "playlist_report", parent="settings", var_type="bool", default=True),
"verify_ssl": check_for_attribute(self.data, "verify_ssl", parent="settings", var_type="bool", default=True), "verify_ssl": check_for_attribute(self.data, "verify_ssl", parent="settings", var_type="bool", default=True),
"custom_repo": check_for_attribute(self.data, "custom_repo", parent="settings", default_is_none=True), "custom_repo": check_for_attribute(self.data, "custom_repo", parent="settings", default_is_none=True),
"overlay_artwork_filetype": check_for_attribute(self.data, "overlay_artwork_filetype", parent="settings", test_list=filetype_list, default="jpg"), "overlay_artwork_filetype": check_for_attribute(self.data, "overlay_artwork_filetype", parent="settings", test_list=filetype_list, translations={"webp": "webp_lossy"}, default="jpg"),
"overlay_artwork_quality": check_for_attribute(self.data, "overlay_artwork_quality", parent="settings", var_type="int", default_is_none=True, int_min=1, int_max=100), "overlay_artwork_quality": check_for_attribute(self.data, "overlay_artwork_quality", parent="settings", var_type="int", default_is_none=True, int_min=1, int_max=100),
"assets_for_all": check_for_attribute(self.data, "assets_for_all", parent="settings", var_type="bool", default=False, save=False, do_print=False) "assets_for_all": check_for_attribute(self.data, "assets_for_all", parent="settings", var_type="bool", default=False, save=False, do_print=False)
} }
@ -858,7 +862,7 @@ class ConfigFile:
params["ignore_ids"].extend([i for i in self.general["ignore_ids"] if i not in params["ignore_ids"]]) params["ignore_ids"].extend([i for i in self.general["ignore_ids"] if i not in params["ignore_ids"]])
params["ignore_imdb_ids"] = check_for_attribute(lib, "ignore_imdb_ids", parent="settings", var_type="lower_list", default_is_none=True, do_print=False, save=False) params["ignore_imdb_ids"] = check_for_attribute(lib, "ignore_imdb_ids", parent="settings", var_type="lower_list", default_is_none=True, do_print=False, save=False)
params["ignore_imdb_ids"].extend([i for i in self.general["ignore_imdb_ids"] if i not in params["ignore_imdb_ids"]]) params["ignore_imdb_ids"].extend([i for i in self.general["ignore_imdb_ids"] if i not in params["ignore_imdb_ids"]])
params["overlay_artwork_filetype"] = check_for_attribute(lib, "overlay_artwork_filetype", parent="settings", test_list=filetype_list, default=self.general["overlay_artwork_filetype"], do_print=False, save=False) params["overlay_artwork_filetype"] = check_for_attribute(lib, "overlay_artwork_filetype", parent="settings", test_list=filetype_list, translations={"webp": "webp_lossy"}, default=self.general["overlay_artwork_filetype"], do_print=False, save=False)
params["overlay_artwork_quality"] = check_for_attribute(lib, "overlay_artwork_quality", parent="settings", var_type="int", default=self.general["overlay_artwork_quality"], default_is_none=True, int_min=1, int_max=100, do_print=False, save=False) params["overlay_artwork_quality"] = check_for_attribute(lib, "overlay_artwork_quality", parent="settings", var_type="int", default=self.general["overlay_artwork_quality"], default_is_none=True, int_min=1, int_max=100, do_print=False, save=False)
params["changes_webhooks"] = check_for_attribute(lib, "changes", parent="webhooks", var_type="list", default=self.webhooks["changes"], do_print=False, save=False, default_is_none=True) params["changes_webhooks"] = check_for_attribute(lib, "changes", parent="webhooks", var_type="list", default=self.webhooks["changes"], do_print=False, save=False, default_is_none=True)
params["report_path"] = None params["report_path"] = None

4
modules/overlays.py
Unescape View File

@ -513,8 +513,10 @@ class Overlays:
overlay_box = current_overlay.get_coordinates((canvas_width, canvas_height), box=current_overlay.image.size, new_cords=cord) overlay_box = current_overlay.get_coordinates((canvas_width, canvas_height), box=current_overlay.image.size, new_cords=cord)
new_poster.paste(current_overlay.image, overlay_box, current_overlay.image) new_poster.paste(current_overlay.image, overlay_box, current_overlay.image)
temp = os.path.join(self.library.overlay_folder, f"temp.{self.library.overlay_artwork_filetype}") temp = os.path.join(self.library.overlay_folder, f"temp.{self.library.overlay_artwork_filetype}")
if self.library.overlay_artwork_quality and self.library.overlay_artwork_filetype in ["jpg", "webp"]: if self.library.overlay_artwork_quality and self.library.overlay_artwork_filetype in ["jpg", "webp_lossy"]:
new_poster.save(temp, exif=exif_tags, quality=self.library.overlay_artwork_quality) new_poster.save(temp, exif=exif_tags, quality=self.library.overlay_artwork_quality)
elif self.library.overlay_artwork_filetype == "webp_lossless":
new_poster.save(temp, exif=exif_tags, lossless=True)
else: else:
new_poster.save(temp, exif=exif_tags) new_poster.save(temp, exif=exif_tags)
self.library.upload_poster(item, temp) self.library.upload_poster(item, temp)

Write Preview
Loading…
Cancel
Save