[97] rename coordinate variable

VERSION

@@ -1 +1 @@
-1.16.5-develop96
+1.16.5-develop97

docs/metadata/overlay.md

@@ -55,7 +55,7 @@ Each overlay definition needs to specify what overlay to use. This can happen in
 3. Using a dictionary for more overlay location options.
 
 | Attribute           | Description                                                                                                     | Required |
-|:---------------|:--------------------------------------------------------------------------------------------------------------|:--------:|
+|:--------------------|:----------------------------------------------------------------------------------------------------------------|:--------:|
 | `name`              | Name of the overlay. Each overlay name should be unique.                                                        | ✅  |
 | `file`              | Local location of the Overlay Image.                                                                            | ❌ |
 | `url`               | URL of Overlay Image Online.                                                                                    | ❌ |
@@ -63,10 +63,10 @@ Each overlay definition needs to specify what overlay to use. This can happen in
 | `repo`              | Location in the [Custom Repo](../config/settings.md#custom-repo) of the Overlay Image.                          | ❌ |
 | `group`             | Name of the Grouping for this overlay. **`weight` is required when using `group`**                              | ❌ |
 | `weight`            | Weight of this overlay in its group. **`group` is required when using `weight`**                                | ❌ |
-| `x_coordinate` | X Coordinate of this overlay. Can be a %. **`y_coordinate` is required when using `x_coordinate`**            | ❌ |
+| `horizontal_offset` | Horizontal Offset of this overlay. Can be a %. **`vertical_offset` is required when using `horizontal_offset`** | ❌ |
-| `x_align`      | Where the `x_coordinate` is calculated from. **Values:** `left`, `center`, `right`                            | ❌ |
+| `horizontal_align`  | Horizontal Alignment of the overlay. **Values:** `left`, `center`, `right`                                      | ❌ |
-| `y_coordinate` | Y Coordinate of this overlay. Can be a %. **`x_coordinate` is required when using `y_coordinate`**            | ❌ |
+| `vertical_offset`   | Vertical Offset of this overlay. Can be a %. **`horizontal_offset` is required when using `vertical_offset`**   | ❌ |
-| `y_align`      | Where the `y_coordinate` is calculated from. **Values:** `top`, `center`, `bottom`                            | ❌ |
+| `vertical_align`    | Vertical Alignment of the overlay. **Values:** `top`, `center`, `bottom`                                        | ❌ |
 | `font`              | System Font Filename or path to font file for the Text Overlay                                                  | ❌ |
 | `font_size`         | Font Size for the Text Overlay. **Value:** Integer greater than 0                                               | ❌ |
 | `font_color`        | Font Color for the Text Overlay. **Value:** Color Hex Code. ex `#00FF00`                                        | ❌ |
@@ -104,7 +104,7 @@ You can add text as an overlay using the special `text()` overlay name. Anything
 
 You can control the font, font size and font color using the `font`, `font_size`, and `font_color` overlay attributes.
 
-The `x_coordinate` and `y_coordinate` overlay attributes are required when using Text Overlays.
+The `horizontal_offset` and `vertical_offset` overlay attributes are required when using Text Overlays.
 
 You can add an items rating number (`8.7`) to the image by using `text(audience_rating)`, `text(critic_rating)`, or `text(user_rating)` 
 
@@ -117,8 +117,8 @@ overlays:
   audience_rating:
     overlay:
       name: text(audience_rating)
-      x_coordinate: 15
+      horizontal_offset: 15
-      y_coordinate: 15
+      vertical_offset: 15
       font: Salma.otf
       font_size: 200
     plex_all: true

modules/overlays.py

@@ -169,11 +169,9 @@ class Overlays:
                                 new_poster = new_poster.filter(ImageFilter.GaussianBlur(blur_num))
                             for over_name in normal_overlays:
                                 overlay = properties[over_name]
-                                if overlay.coordinates:
+                                if not overlay.has_coordinates():
-                                    new_poster.paste(overlay.image, overlay.get_coordinates(image_width, image_height), overlay.image)
-                                else:
                                     new_poster = new_poster.resize(overlay.image.size, Image.ANTIALIAS)
-                                    new_poster.paste(overlay.image, (0, 0), overlay.image)
+                                new_poster.paste(overlay.image, overlay.get_coordinates(image_width, image_height), overlay.image)
                             if text_names:
                                 drawing = ImageDraw.Draw(new_poster)
                                 for over_name in text_names:

modules/util.py

@@ -838,7 +838,6 @@ class Overlay:
         self.group = None
         self.weight = None
         self.path = None
-        self.coordinates = None
         self.font = None
         self.font_name = None
         self.font_size = 12
@@ -864,54 +863,49 @@ class Overlay:
         if ("group" in self.data or "weight" in self.data) and (self.weight is None or not self.group):
             raise Failed(f"Overlay Error: overlay attribute's group and weight must be used together")
 
-        self.x_align = parse("Overlay", "x_align", self.data["x_align"], options=["left", "center", "right"]) if "x_align" in self.data else "left"
+        self.horizontal_align = parse("Overlay", "horizontal_align", self.data["horizontal_align"], options=["left", "center", "right"]) if "horizontal_align" in self.data else "left"
-        self.y_align = parse("Overlay", "y_align", self.data["y_align"], options=["top", "center", "bottom"]) if "y_align" in self.data else "top"
+        self.vertical_align = parse("Overlay", "vertical_align", self.data["vertical_align"], options=["top", "center", "bottom"]) if "vertical_align" in self.data else "top"
 
-        x_cord = None
+        self.horizontal_offset = None
-        if "x_coordinate" in self.data and self.data["x_coordinate"] is not None:
+        if "horizontal_offset" in self.data and self.data["horizontal_offset"] is not None:
-            x_cord = self.data["x_coordinate"]
+            x_off = self.data["horizontal_offset"]
             per = False
-            if str(x_cord).endswith("%"):
+            if str(x_off).endswith("%"):
-                x_cord = x_cord[:-1]
+                x_off = x_off[:-1]
                 per = True
-            x_cord = check_num(x_cord)
+            x_off = check_num(x_off)
-            error = f"Overlay Error: overlay x_coordinate: {self.data['x_coordinate']} must be a number"
+            error = f"Overlay Error: overlay horizontal_offset: {self.data['horizontal_offset']} must be a number"
-            if x_cord is None:
+            if x_off is None:
                 raise Failed(error)
-            if self.x_align != "center" and not per and x_cord < 0:
+            if self.horizontal_align != "center" and not per and x_off < 0:
                 raise Failed(f"{error} 0 or greater")
-            elif self.x_align != "center" and per and x_cord > 100:
+            elif self.horizontal_align != "center" and per and x_off > 100:
                 raise Failed(f"{error} between 0% and 100%")
-            elif self.x_align == "center" and per and (x_cord > 50 or x_cord < -50):
+            elif self.horizontal_align == "center" and per and (x_off > 50 or x_off < -50):
                 raise Failed(f"{error} between -50% and 50%")
-            if per:
+            self.horizontal_offset = f"{x_off}%" if per else x_off
-                x_cord = f"{x_cord}%"
 
-        y_cord = None
+        self.vertical_offset = None
-        if "y_coordinate" in self.data and self.data["y_coordinate"] is not None:
+        if "vertical_offset" in self.data and self.data["vertical_offset"] is not None:
-            y_cord = self.data["y_coordinate"]
+            y_off = self.data["vertical_offset"]
             per = False
-            if str(y_cord).endswith("%"):
+            if str(y_off).endswith("%"):
-                y_cord = y_cord[:-1]
+                y_off = y_off[:-1]
                 per = True
-            y_cord = check_num(y_cord)
+            y_off = check_num(y_off)
-            error = f"Overlay Error: overlay y_coordinate: {self.data['y_coordinate']} must be a number"
+            error = f"Overlay Error: overlay vertical_offset: {self.data['vertical_offset']} must be a number"
-            if y_cord is None:
+            if y_off is None:
                 raise Failed(error)
-            if self.y_align != "center" and not per and y_cord < 0:
+            if self.vertical_align != "center" and not per and y_off < 0:
                 raise Failed(f"{error} 0 or greater")
-            elif self.y_align != "center" and per and y_cord > 100:
+            elif self.vertical_align != "center" and per and y_off > 100:
                 raise Failed(f"{error} between 0% and 100%")
-            elif self.y_align == "center" and per and (y_cord > 50 or y_cord < -50):
+            elif self.vertical_align == "center" and per and (y_off > 50 or y_off < -50):
                 raise Failed(f"{error} between -50% and 50%")
-            if per:
+            self.vertical_offset = f"{y_off}%" if per else y_off
-                y_cord = f"{y_cord}%"
 
-        if ("x_coordinate" in self.data or "y_coordinate" in self.data) and (x_cord is None or y_cord is None):
+        if ("horizontal_offset" in self.data or "vertical_offset" in self.data) and (self.horizontal_offset is None or self.vertical_offset is None):
-            raise Failed(f"Overlay Error: overlay x_coordinate and overlay y_coordinate must be used together")
+            raise Failed(f"Overlay Error: overlay horizontal_offset and overlay vertical_offset must be used together")
-
-        if x_cord is not None or y_cord is not None:
-            self.coordinates = (x_cord, y_cord)
 
         def get_and_save_image(image_url):
             response = self.config.get(image_url)
@@ -952,8 +946,8 @@ class Overlay:
                 logger.error(f"Overlay Error: failed to parse overlay blur name: {self.name} defaulting to blur(50)")
                 self.name = "blur(50)"
         elif self.name.startswith("text"):
-            if not self.coordinates:
+            if not self.has_coordinates():
-                raise Failed(f"Overlay Error: overlay attribute's x_coordinate and y_coordinate are required when using text")
+                raise Failed(f"Overlay Error: overlay attribute's horizontal_offset and vertical_offset are required when using text")
             match = re.search("\\(([^)]+)\\)", self.name)
             if not match:
                 raise Failed(f"Overlay Error: failed to parse overlay text name: {self.name}")
@@ -1005,30 +999,35 @@ class Overlay:
         output = self.name
         if self.group:
             output += f"{self.group}{self.weight}"
-        if self.coordinates:
+        if self.has_coordinates():
-            output += f"{self.coordinates}{self.x_align}{self.y_align}"
+            output += f"{self.horizontal_align}{self.horizontal_offset}{self.vertical_offset}{self.vertical_align}"
         if self.font_name:
             output += f"{self.font_name}{self.font_size}"
         if self.font_color:
             output += str(self.font_color)
         return output
 
-    def get_coordinates(self, image_width, image_length, text=None):
+    def has_coordinates(self):
+        return self.horizontal_offset is None or self.vertical_offset is None
+
+    def get_coordinates(self, image_width, image_height, text=None):
+        if not self.has_coordinates():
+            return 0, 0
         if text:
             _, _, width, height = ImageDraw.Draw(Image.new("RGB", (0, 0))).textbbox((0, 0), text, font=self.font)
         else:
             width, height = self.image.size
-        x_cord, y_cord = self.coordinates
+
-        if str(x_cord).endswith("%"):
+        def get_cord(value, image_value, over_value, align):
-            x_cord = image_width * 0.01 * int(x_cord[:-1])
+            value = image_value * 0.01 * int(value[:-1]) if str(value).endswith("%") else value
-        if str(y_cord).endswith("%"):
+            if align in ["right", "bottom"]:
-            y_cord = image_length * 0.01 * int(y_cord[:-1])
+                return image_value - over_value - value
-        if self.x_align == "right":
+            elif align == "center":
-            x_cord = image_width - width - x_cord
+                return (image_value / 2) - (over_value / 2) + value
-        elif self.x_align == "center":
+            else:
-            x_cord = (image_width / 2) - (width / 2) + x_cord
+                return value
-        if self.x_align == "bottom":
+
-            y_cord = image_length - height - y_cord
+        x_cord = get_cord(self.horizontal_offset, image_width, width, self.horizontal_align)
-        elif self.x_align == "center":
+        y_cord = get_cord(self.vertical_offset, image_height, height, self.vertical_align)
-            y_cord = (image_length / 2) - (height / 2) + y_cord
+
         return x_cord, y_cord