feat: add SubtitleStyle

Author: ankit-v2-3

videodb/__init__.py

@@ -5,7 +5,13 @@
 
 from typing import Optional
 from videodb._utils._video import play_stream
-from videodb._constants import VIDEO_DB_API, MediaType
+from videodb._constants import (
+    VIDEO_DB_API,
+    MediaType,
+    SubtitleAlignment,
+    SubtitleBorderStyle,
+    SubtitleStyle,
+)
 from videodb.client import Connection
 from videodb.exceptions import (
     VideodbError,
@@ -26,6 +32,9 @@
     "SearchError",
     "play_stream",
     "MediaType",
+    "SubtitleAlignment",
+    "SubtitleBorderStyle",
+    "SubtitleStyle",
 ]
 
 

videodb/_constants.py

@@ -1,5 +1,6 @@
 """Constants used in the videodb package."""
 
+from dataclasses import dataclass
 
 VIDEO_DB_API: str = "https://api.videodb.io"
 
@@ -78,7 +79,8 @@ class SubtitleAlignment:
     top_right = 9
 
 
-class SubtitleStyleDefaultValues:
+@dataclass
+class SubtitleStyle:
     font_name: str = "Arial"
     font_size: float = 18
     primary_colour: str = "&H00FFFFFF"  # white

videodb/asset.py

@@ -93,16 +93,16 @@ def __init__(
         asset_id: str,
         width: Optional[int] = 100,
         height: Optional[int] = 100,
-        position_x: Optional[int] = 80,
-        position_y: Optional[int] = 20,
-        end: Optional[Union[int, None]] = None,
+        x: Optional[int] = 80,
+        y: Optional[int] = 20,
+        duration: Optional[Union[int, None]] = None,
     ) -> None:
         super().__init__(asset_id)
         self.width = width
         self.height = height
-        self.position_x = position_x
-        self.position_y = position_y
-        self.end = end
+        self.x = x
+        self.y = y
+        self.duration = duration
 
     def to_json(self) -> dict:
         return copy.deepcopy(self.__dict__)
@@ -113,7 +113,7 @@ def __repr__(self) -> str:
             f"asset_id={self.asset_id}, "
             f"width={self.width}, "
             f"height={self.height}, "
-            f"position_x={self.position_x}, "
-            f"position_y={self.position_y}, "
-            f"end={self.end})"
+            f"x={self.x}, "
+            f"y={self.y}, "
+            f"duration={self.duration})"
         )

videodb/client.py

@@ -57,9 +57,10 @@ def upload(
             description,
             callback_url,
         )
-        if upload_data.get("id", "").startswith("m-"):
-            return Video(self, **upload_data) if upload_data else None
-        elif upload_data.get("id", "").startswith("a-"):
-            return Audio(self, **upload_data) if upload_data else None
-        elif upload_data.get("id", "").startswith("i-"):
-            return Image(self, **upload_data) if upload_data else None
+        media_id = upload_data.get("id", "")
+        if media_id.startswith("m-"):
+            return Video(self, **upload_data)
+        elif media_id.startswith("a-"):
+            return Audio(self, **upload_data)
+        elif media_id.startswith("img-"):
+            return Image(self, **upload_data)

videodb/collection.py

@@ -101,9 +101,10 @@ def upload(
             description,
             callback_url,
         )
-        if upload_data.get("id", "").startswith("m-"):
-            return Video(self._connection, **upload_data) if upload_data else None
-        elif upload_data.get("id", "").startswith("a-"):
-            return Audio(self._connection, **upload_data) if upload_data else None
-        elif upload_data.get("id", "").startswith("i-"):
-            return Image(self._connection, **upload_data) if upload_data else None
+        media_id = upload_data.get("id", "")
+        if media_id.startswith("m-"):
+            return Video(self, **upload_data)
+        elif media_id.startswith("a-"):
+            return Audio(self, **upload_data)
+        elif media_id.startswith("img-"):
+            return Image(self, **upload_data)

videodb/video.py

@@ -5,7 +5,7 @@
     SearchType,
     IndexType,
     Workflows,
-    SubtitleStyleDefaultValues,
+    SubtitleStyle,
 )
 from videodb.search import SearchFactory, SearchResult
 from videodb.shot import Shot
@@ -130,57 +130,14 @@ def index_spoken_words(self) -> None:
             },
         )
 
-    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:
+    def add_subtitle(self, style: SubtitleStyle = SubtitleStyle()) -> str:
+        if not isinstance(style, SubtitleStyle):
+            raise ValueError("style must be of type SubtitleStyle")
         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,
-                },
+                "subtitle_style": style.__dict__,
             },
         )
         return subtitle_data.get("stream_url", None)