✨ feat(biliass): use tracing for logging and enable tracing in yutto debug mode (#343)

Author: SigureMo

packages/biliass/rust/Cargo.lock

@@ -18,6 +18,8 @@ cached = "0.53.1"
 serde = "1.0.210"
 serde_json = "1.0.128"
 regex = "1.10.6"
+tracing = "0.1.40"
+tracing-subscriber = "0.3.18"
 
 [build-dependencies]
 prost-build = "0.13.3"

packages/biliass/rust/Cargo.toml

@@ -1,6 +1,7 @@
 mod comment;
 mod convert;
 mod error;
+mod logging;
 mod proto;
 mod python;
 mod reader;
@@ -23,5 +24,6 @@ fn biliass_pyo3(m: &Bound<'_, PyModule>) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(python::py_get_danmaku_meta_size, m)?)?;
     m.add_function(wrap_pyfunction!(python::py_xml_to_ass, m)?)?;
     m.add_function(wrap_pyfunction!(python::py_protobuf_to_ass, m)?)?;
+    m.add_function(wrap_pyfunction!(python::py_enable_tracing, m)?)?;
     Ok(())
 }

packages/biliass/rust/src/lib.rs

@@ -0,0 +1,9 @@
+use tracing::Level;
+
+pub fn enable_tracing() {
+    let collector = tracing_subscriber::fmt()
+        .with_max_level(Level::TRACE)
+        .finish();
+
+    tracing::subscriber::set_global_default(collector).expect("setting tracing default failed");
+}

packages/biliass/rust/src/logging.rs

@@ -1,4 +1,5 @@
 use crate::{convert, reader};
+
 use pyo3::{
     prelude::*,
     pybacked::{PyBackedBytes, PyBackedStr},

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

@@ -0,0 +1,6 @@
+use pyo3::prelude::*;
+
+#[pyfunction(name = "enable_tracing")]
+pub fn py_enable_tracing() {
+    crate::logging::enable_tracing();
+}

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

@@ -1,5 +1,6 @@
 mod convert;
+mod logging;
 mod proto;
-
 pub use convert::{py_protobuf_to_ass, py_xml_to_ass};
+pub use logging::py_enable_tracing;
 pub use proto::py_get_danmaku_meta_size;

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

@@ -2,6 +2,7 @@ use crate::comment::{Comment, CommentPosition};
 use crate::reader::special::parse_special_comment;
 use crate::writer::rows;
 use crate::writer::utils;
+use tracing::warn;
 
 pub fn write_head(
     width: u32,
@@ -214,10 +215,10 @@ pub fn write_comment_with_animation(
     .into_iter()
     .any(|x| x.is_nan())
     {
-        // eprintln!(
-        //     "Invalid rotation arguments: {:?}",
-        //     (rotate_y, rotate_z, from_x, from_y)
-        // );
+        warn!(
+            "Invalid rotation arguments: {:?}",
+            (rotate_y, rotate_z, from_x, from_y)
+        );
         return "".to_owned();
     }
     let mut styles = vec![format!("\\org({}, {})", width / 2, height / 2)];
@@ -292,7 +293,7 @@ pub fn write_special_comment(comment: &Comment, width: u32, height: u32, styleid
         utils::get_zoom_factor(crate::reader::special::BILI_PLAYER_SIZE, (width, height));
     let parsed_res = parse_special_comment(&comment.comment, zoom_factor);
     if parsed_res.is_err() {
-        // eprintln!("Invalid comment: {}", comment.comment);
+        warn!("Invalid comment: {}", comment.comment);
         return "".to_owned();
     }
     let (

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

@@ -1,3 +1,5 @@
+use tracing::warn;
+
 use cached::proc_macro::cached;
 
 fn divmod(a: f64, b: f64) -> (f64, f64) {
@@ -150,19 +152,19 @@ pub fn convert_flash_rotation(
     let scale_xy = if fov + trans_z != 0.0 {
         fov / (fov + trans_z)
     } else {
-        // eprintln!(
-        //     "Rotation makes object behind the camera: trZ == {:.0}",
-        //     trans_z
-        // );
+        warn!(
+            "Rotation makes object behind the camera: trZ == {:.0}",
+            trans_z
+        );
         1.
     };
     let trans_x = (trans_x - width / 2.0) * scale_xy + width / 2.0;
     let trans_y = (trans_y - height / 2.0) * scale_xy + height / 2.0;
     let (scale_xy, out_x, out_y) = if scale_xy < 0. {
-        // eprintln!(
-        //     "Rotation makes object behind the camera: trZ == {:.0} < {:.0}",
-        //     trans_z, fov
-        // );
+        warn!(
+            "Rotation makes object behind the camera: trZ == {:.0} < {:.0}",
+            trans_z, fov
+        );
         (-scale_xy, out_x + 180., out_y + 180.)
     } else {
         (scale_xy, out_x, out_y)

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

@@ -1,6 +1,9 @@
 from __future__ import annotations
 
-from biliass._core import get_danmaku_meta_size as get_danmaku_meta_size
+from biliass._core import (
+    enable_tracing as enable_tracing,
+    get_danmaku_meta_size as get_danmaku_meta_size,
+)
 
 from .biliass import (
     Danmaku2ASS as Danmaku2ASS,