♻️ refactor: use rust binding struct OptionComment (#318)

Author: SigureMo

packages/biliass/rust/src/comment.rs

@@ -1,4 +1,4 @@
-#[derive(Debug, PartialEq)]
+#[derive(Debug, PartialEq, Clone)]
 pub enum CommentPosition {
     /// Regular moving comment
     Scroll,
@@ -12,7 +12,7 @@ pub enum CommentPosition {
     Special,
 }
 
-#[derive(Debug)]
+#[derive(Debug, PartialEq, Clone)]
 pub struct Comment {
     /// The position when the comment is replayed
     pub timeline: f64,

packages/biliass/rust/src/lib.rs

@@ -22,6 +22,7 @@ fn biliass_pyo3(m: &Bound<'_, PyModule>) -> PyResult<()> {
     m.add_class::<python::PyDmSegMobileReply>()?;
     m.add_class::<python::PyDanmakuElem>()?;
     m.add_class::<python::PyComment>()?;
+    m.add_class::<python::PyOptionComment>()?;
     m.add_class::<python::PyCommentPosition>()?;
     m.add_function(wrap_pyfunction!(python::py_read_comments_from_xml, m)?)?;
     m.add_function(wrap_pyfunction!(python::py_read_comments_from_protobuf, m)?)?;

packages/biliass/rust/src/python/comment.rs

@@ -93,3 +93,45 @@ impl PyComment {
         format!("Comment({:?})", self.inner)
     }
 }
+
+#[pyclass(name = "OptionComment", frozen)]
+pub struct PyOptionComment {
+    inner: Option<comment::Comment>,
+}
+
+impl PyOptionComment {
+    pub fn new(inner: Option<comment::Comment>) -> Self {
+        PyOptionComment { inner }
+    }
+}
+
+#[pymethods]
+impl PyOptionComment {
+    fn is_none(&self) -> bool {
+        self.inner.is_none()
+    }
+
+    fn is_some(&self) -> bool {
+        self.inner.is_some()
+    }
+
+    fn unwrap(&self) -> PyComment {
+        PyComment::new(self.inner.clone().unwrap())
+    }
+
+    #[staticmethod]
+    fn from_comment(comment: &PyComment) -> Self {
+        PyOptionComment {
+            inner: Some(comment.inner.clone()),
+        }
+    }
+
+    #[staticmethod]
+    fn none() -> Self {
+        PyOptionComment { inner: None }
+    }
+
+    fn __eq__(&self, other: &PyOptionComment) -> bool {
+        self.inner == other.inner
+    }
+}

packages/biliass/rust/src/python/mod.rs

@@ -3,7 +3,7 @@ mod proto;
 mod reader;
 mod writer;
 
-pub use comment::{PyComment, PyCommentPosition};
+pub use comment::{PyComment, PyCommentPosition, PyOptionComment};
 pub use proto::{PyDanmakuElem, PyDmSegMobileReply};
 pub use reader::{py_read_comments_from_protobuf, py_read_comments_from_xml};
 pub use writer::{

packages/biliass/rust/src/python/writer.rs

@@ -39,3 +39,8 @@ pub fn py_convert_flash_rotation(
         rot_y, rot_z, x, y, width, height,
     ))
 }
+
+// #[pyfunction(name = "test_rows")]
+// pub fn py_test_rows(rows: Vec<Vec<PyRef<crate::python::PyOptionComment>>>) -> PyResult<()> {
+//     Ok(())
+// }

packages/biliass/src/biliass/_core.pyi

@@ -55,6 +55,15 @@ class Comment:
     height: float
     width: float
 
+class OptionComment:
+    def is_none(self) -> bool: ...
+    def is_some(self) -> bool: ...
+    def unwrap(self) -> Comment: ...
+    @staticmethod
+    def from_comment(comment: Comment) -> OptionComment: ...
+    @staticmethod
+    def none() -> OptionComment: ...
+
 def read_comments_from_xml(text: str, fontsize: float) -> list[Comment]: ...
 def read_comments_from_protobuf(data: bytes, fontsize: float) -> list[Comment]: ...
 def convert_timestamp(timestamp: float) -> float: ...

packages/biliass/src/biliass/biliass.py

@@ -7,11 +7,12 @@
 import math
 import random
 import re
-from typing import TYPE_CHECKING, TypeVar, Union
+from typing import TYPE_CHECKING, TypeVar
 
 from biliass._core import (
     Comment,
     CommentPosition,
+    OptionComment,
     ass_escape,
     convert_color,
     convert_flash_rotation,
@@ -26,7 +27,7 @@
 
 
 T = TypeVar("T")
-Rows = list[list[Union[Comment, None]]]
+Rows = list[list[OptionComment]]
 
 
 def read_comments_bilibili_xml(text: str | bytes, fontsize: float) -> list[Comment]:
@@ -228,23 +229,23 @@ def to_string(self):
 
 
 def process_comments(
-    comments,
-    width,
-    height,
-    bottom_reserved,
+    comments: list[Comment],
+    width: int,
+    height: int,
+    bottom_reserved: int,
     fontface,
     fontsize,
     alpha,
-    duration_marquee,
-    duration_still,
+    duration_marquee: float,
+    duration_still: float,
     filters_regex,
     reduced,
     progress_callback,
 ):
     styleid = f"biliass_{random.randint(0, 0xFFFF):04x}"
     ass = AssText()
     ass.write_head(width, height, fontface, fontsize, alpha, styleid)
-    rows = [[None] * (height - bottom_reserved + 1) for i in range(4)]
+    rows = [[OptionComment.none()] * (height - bottom_reserved + 1) for i in range(4)]
     for idx, comment in enumerate(comments):
         if progress_callback and idx % 1000 == 0:
             progress_callback(idx, len(comments))
@@ -318,21 +319,21 @@ def test_free_rows(
     rows: Rows,
     comment: Comment,
     row: int,
-    width,
-    height,
-    bottom_reserved,
-    duration_marquee,
-    duration_still,
-):
+    width: int,
+    height: int,
+    bottom_reserved: int,
+    duration_marquee: float,
+    duration_still: float,
+) -> int:
     res = 0
     rowmax = height - bottom_reserved
-    target_row = None
+    target_row = OptionComment.none()
     comment_pos_id = comment.pos.id
     if comment.pos in (CommentPosition.Bottom, CommentPosition.Top):
         while row < rowmax and res < comment.height:
             if target_row != rows[comment_pos_id][row]:
                 target_row = rows[comment_pos_id][row]
-                if target_row and target_row.timeline + duration_still > comment.timeline:
+                if target_row.is_some() and target_row.unwrap().timeline + duration_still > comment.timeline:
                     break
             row += 1
             res += 1
@@ -345,9 +346,10 @@ def test_free_rows(
             if target_row != rows[comment_pos_id][row]:
                 target_row = rows[comment_pos_id][row]
                 try:
-                    if target_row and (
-                        target_row.timeline > threshold_time
-                        or target_row.timeline + target_row.width * duration_marquee / (target_row.width + width)
+                    if target_row.is_some() and (
+                        target_row.unwrap().timeline > threshold_time
+                        or target_row.unwrap().timeline
+                        + target_row.unwrap().width * duration_marquee / (target_row.unwrap().width + width)
                         > comment.timeline
                     ):
                         break
@@ -362,9 +364,9 @@ def find_alternative_row(rows: Rows, comment: Comment, height, bottom_reserved):
     res = 0
     comment_pos_id = comment.pos.id
     for row in range(height - bottom_reserved - math.ceil(comment.height)):
-        if not rows[comment_pos_id][row]:
+        if rows[comment_pos_id][row].is_none():
             return row
-        elif rows[comment_pos_id][row].timeline < rows[comment_pos_id][res].timeline:
+        elif rows[comment_pos_id][row].unwrap().timeline < rows[comment_pos_id][res].unwrap().timeline:
             res = row
     return res
 
@@ -373,7 +375,7 @@ def mark_comment_row(rows: Rows, comment: Comment, row: int):
     comment_pos_id = comment.pos.id
     try:
         for i in range(row, row + math.ceil(comment.height)):
-            rows[comment_pos_id][i] = comment
+            rows[comment_pos_id][i] = OptionComment.from_comment(comment)
     except IndexError:
         pass
 
@@ -402,7 +404,7 @@ def Danmaku2ASS(
     stage_width: int,
     stage_height: int,
     input_format: str = "xml",
-    reserve_blank: float = 0,
+    reserve_blank: int = 0,
     font_face: str = "sans-serif",
     font_size: float = 25.0,
     text_opacity: float = 1.0,