feat: add subtitle style

Author: ankit-v2-3

videodb/__init__.py

@@ -16,7 +16,7 @@
 
 logger: logging.Logger = logging.getLogger("videodb")
 
-__version__ = "0.0.3"
+__version__ = "0.0.4"
 __author__ = "videodb"
 
 __all__ = [

videodb/_constants.py

@@ -58,3 +58,45 @@ class HttpClientDefaultValues:
 
 class MaxSupported:
     fade_duration = 5
+
+
+class SubtitleBorderStyle:
+    no_border = 1
+    opaque_box = 3
+    outline = 4
+
+
+class SubtitleAlignment:
+    bottom_left = 1
+    bottom_center = 2
+    bottom_right = 3
+    middle_left = 4
+    middle_center = 5
+    middle_right = 6
+    top_left = 7
+    top_center = 8
+    top_right = 9
+
+
+class SubtitleStyleDefaultValues:
+    font_name: str = "Arial"
+    font_size: float = 18
+    primary_colour: str = "&H00FFFFFF"  # white
+    secondary_colour: str = "&H000000FF"  # blue
+    outline_colour: str = "&H00000000"  # black
+    back_colour: str = "&H00000000"  # black
+    bold: bool = False
+    italic: bool = False
+    underline: bool = False
+    strike_out: bool = False
+    scale_x: float = 1.0
+    scale_y: float = 1.0
+    spacing: float = 0
+    angle: float = 0
+    border_style: int = SubtitleBorderStyle.outline
+    outline: float = 1.0
+    shadow: float = 0.0
+    alignment: int = SubtitleAlignment.bottom_center
+    margin_l: int = 10
+    margin_r: int = 10
+    margin_v: int = 10

videodb/video.py

@@ -5,6 +5,7 @@
     SearchType,
     IndexType,
     Workflows,
+    SubtitleStyleDefaultValues,
 )
 from videodb.search import SearchFactory, SearchResult
 from videodb.shot import Shot
@@ -129,11 +130,57 @@ def index_spoken_words(self) -> None:
             },
         )
 
-    def add_subtitle(self) -> str:
+    def add_subtitle(
+        self,
+        font_name: str = SubtitleStyleDefaultValues.font_name,
+        font_size: float = SubtitleStyleDefaultValues.font_size,
+        primary_colour: str = SubtitleStyleDefaultValues.primary_colour,
+        secondary_colour: str = SubtitleStyleDefaultValues.secondary_colour,
+        outline_colour: str = SubtitleStyleDefaultValues.outline_colour,
+        back_colour: str = SubtitleStyleDefaultValues.back_colour,
+        bold: bool = SubtitleStyleDefaultValues.bold,
+        italic: bool = SubtitleStyleDefaultValues.italic,
+        underline: bool = SubtitleStyleDefaultValues.underline,
+        strike_out: bool = SubtitleStyleDefaultValues.strike_out,
+        scale_x: float = SubtitleStyleDefaultValues.scale_x,
+        scale_y: float = SubtitleStyleDefaultValues.scale_x,
+        spacing: float = SubtitleStyleDefaultValues.spacing,
+        angle: float = SubtitleStyleDefaultValues.angle,
+        border_style: int = SubtitleStyleDefaultValues.border_style,
+        outline: float = SubtitleStyleDefaultValues.outline,
+        shadow: float = SubtitleStyleDefaultValues.shadow,
+        alignment: int = SubtitleStyleDefaultValues.alignment,
+        margin_l: int = SubtitleStyleDefaultValues.margin_l,
+        margin_r: int = SubtitleStyleDefaultValues.margin_r,
+        margin_v: int = SubtitleStyleDefaultValues.margin_v,
+    ) -> str:
         subtitle_data = self._connection.post(
             path=f"{ApiPath.video}/{self.id}/{ApiPath.workflow}",
             data={
                 "type": Workflows.add_subtitles,
+                "subtitle_style": {
+                    "font_name": font_name,
+                    "font_size": font_size,
+                    "primary_colour": primary_colour,
+                    "secondary_colour": secondary_colour,
+                    "outline_colour": outline_colour,
+                    "back_colour": back_colour,
+                    "bold": bold,
+                    "italic": italic,
+                    "underline": underline,
+                    "strike_out": strike_out,
+                    "scale_x": scale_x,
+                    "scale_y": scale_y,
+                    "spacing": spacing,
+                    "angle": angle,
+                    "border_style": border_style,
+                    "outline": outline,
+                    "shadow": shadow,
+                    "alignment": alignment,
+                    "margin_l": margin_l,
+                    "margin_r": margin_r,
+                    "margin_v": margin_v,
+                },
             },
         )
         return subtitle_data.get("stream_url", None)