feat: superchat fontsize (#27)

* feat: superchat fontsize
* docs: update docs

Author: timerring

README-en.md

@@ -47,11 +47,13 @@ More details:
 
 ```bash
 dmconvert -h
-# optional arguments:
+# options:
 #   -h, --help            show this help message and exit
 #   -V, --version         Print version information
 #   -f FONTSIZE, --fontsize FONTSIZE
 #                         The font size of the danmaku, default is 38
+#   -sf SCFONTSIZE, --scfontsize SCFONTSIZE
+#                         The font size of the superchat and gift, default is 38
 #   -x RESOLUTIONX, --resolutionx RESOLUTIONX
 #                         The resolution x of the danmaku, default is 1920
 #   -y RESOLUTIONY, --resolutiony RESOLUTIONY
@@ -60,7 +62,8 @@ dmconvert -h
 #   -o ASS, --ass ASS     The output ass file
 
 # Example:
-# dmconvert -f 38 -x 1920 -y 1080 -i sample.xml -o sample.ass
+# dmconvert -i input.xml -o output.ass
+# dmconvert -f 38 -sf 30 -x 1920 -y 1080 -i input.xml -o output.ass
 ```
 
 ### Source Version
@@ -72,9 +75,10 @@ from dmconvert.convert import convert_xml_to_ass
 # xml_file = "sample.xml"
 # ass_file = "sample.ass"
 # font_size = 38
+# sc_font_size = 30
 # resolution_x = 720
 # resolution_y = 1280
-convert_xml_to_ass(font_size, resolution_x, resolution_y, xml_file, ass_file)
+convert_xml_to_ass(font_size, sc_font_size, resolution_x, resolution_y, xml_file, ass_file)
 ```
 
 ## The implementation algorithm
@@ -465,13 +469,13 @@ As we can see, the superchat show up and disappear in chronological order, so ho
 My solution is: calculate the position of the superchat message box every time the superchat changes its position in its life cycle. The concrete algorithm is as follows:
 
 ```python
-def render_superchat(ass_file, font_size, resolution_y, data):
+def render_superchat(ass_file, sc_font_size, resolution_y, data):
     """
     Render superchat events to the ass file.
 
     Args:
         ass_file (str): The path to the ass file.
-        font_size (int): The font size, which is used to calculate some render parameters.
+        sc_font_size (int): The superchat font size, which is used to calculate some render parameters.
         resolution_y (int): The resolution y, which is used to calculate the initial y coordinate.
         data (list): The data to render, which is a list of superchat events.
     """
@@ -535,7 +539,7 @@ def render_superchat(ass_file, font_size, resolution_y, data):
     ) in enumerate(data):
         # print(f"\nSC {i} ({start}-{end}):")
         # Initial y coordinate
-        previous_y = resolution_y - font_size * 2
+        previous_y = resolution_y - sc_font_size * 2
         current_y = previous_y - sc_height
         current_time = start
         # print(f"Time {start}: y = {current_y}, previous_y = {previous_y}")
@@ -558,6 +562,7 @@ def render_superchat(ass_file, font_size, resolution_y, data):
                     current_y,
                     previous_y,
                     text,
+                    sc_font_size,
                 ).write_superchat(ass_file)
                 previous_y = current_y
                 if delta_y[0] == "-":
@@ -576,6 +581,7 @@ def render_superchat(ass_file, font_size, resolution_y, data):
             current_y,
             previous_y,
             text,
+            sc_font_size,
         ).write_superchat(ass_file)
 ```
 

README.md

@@ -45,11 +45,13 @@ dmconvert -i sample.xml
 
 ```bash
 dmconvert -h
-# optional arguments:
+# options:
 #   -h, --help            show this help message and exit
 #   -V, --version         Print version information
 #   -f FONTSIZE, --fontsize FONTSIZE
 #                         The font size of the danmaku, default is 38
+#   -sf SCFONTSIZE, --scfontsize SCFONTSIZE
+#                         The font size of the superchat and gift, default is 38
 #   -x RESOLUTIONX, --resolutionx RESOLUTIONX
 #                         The resolution x of the danmaku, default is 1920
 #   -y RESOLUTIONY, --resolutiony RESOLUTIONY
@@ -58,7 +60,8 @@ dmconvert -h
 #   -o ASS, --ass ASS     The output ass file
 
 # Example:
-# dmconvert -f 38 -x 1920 -y 1080 -i sample.xml -o sample.ass
+# dmconvert -i input.xml -o output.ass
+# dmconvert -f 38 -sf 30 -x 1920 -y 1080 -i input.xml -o output.ass
 ```
 
 ### 直接引用
@@ -70,9 +73,10 @@ from dmconvert.convert import convert_xml_to_ass
 # xml_file = "sample.xml"
 # ass_file = "sample.ass"
 # font_size = 38
+# sc_font_size = 30
 # resolution_x = 720
 # resolution_y = 1280
-convert_xml_to_ass(font_size, resolution_x, resolution_y, xml_file, ass_file)
+convert_xml_to_ass(font_size, sc_font_size, resolution_x, resolution_y, xml_file, ass_file)
 ```
 
 ## 实现原理
@@ -460,13 +464,13 @@ Dialogue: 1,0:00:59.20,0:01:10.00,message_box,,0000,0000,0000,,{\pos(20,904.0)\c
 我的解决方案是：每次付费留言在其生命周期中改变位置时计算付费留言消息框的位置。具体的算法如下：
 
 ```python
-def render_superchat(ass_file, font_size, resolution_y, data):
+def render_superchat(ass_file, sc_font_size, resolution_y, data):
     """
-    将付费留言事件渲染到 ASS 文件中。
+    Render superchat events to the ass file.
 
     Args:
         ass_file (str): The path to the ass file.
-        font_size (int): The font size, which is used to calculate some render parameters.
+        sc_font_size (int): The superchat font size, which is used to calculate some render parameters.
         resolution_y (int): The resolution y, which is used to calculate the initial y coordinate.
         data (list): The data to render, which is a list of superchat events.
     """
@@ -530,7 +534,7 @@ def render_superchat(ass_file, font_size, resolution_y, data):
     ) in enumerate(data):
         # print(f"\nSC {i} ({start}-{end}):")
         # Initial y coordinate
-        previous_y = resolution_y - font_size * 2
+        previous_y = resolution_y - sc_font_size * 2
         current_y = previous_y - sc_height
         current_time = start
         # print(f"Time {start}: y = {current_y}, previous_y = {previous_y}")
@@ -553,6 +557,7 @@ def render_superchat(ass_file, font_size, resolution_y, data):
                     current_y,
                     previous_y,
                     text,
+                    sc_font_size,
                 ).write_superchat(ass_file)
                 previous_y = current_y
                 if delta_y[0] == "-":
@@ -571,6 +576,7 @@ def render_superchat(ass_file, font_size, resolution_y, data):
             current_y,
             previous_y,
             text,
+            sc_font_size,
         ).write_superchat(ass_file)
 ```
 

dmconvert/cli.py

@@ -18,7 +18,8 @@ def cli():
         '''),
         epilog=textwrap.dedent('''
         Example:
-        dmconvert -f 38 -x 1920 -y 1080 -i input.xml -o output.ass
+        dmconvert -i input.xml -o output.ass
+        dmconvert -f 38 -sf 30 -x 1920 -y 1080 -i input.xml -o output.ass
         '''),
     )
     parser.add_argument(
@@ -35,6 +36,13 @@ def cli():
         type=int,
         help="The font size of the danmaku, default is 38",
     )
+    parser.add_argument(
+        "-sf",
+        "--scfontsize",
+        default=38,
+        type=int,
+        help="The font size of the superchat and gift, default is 38",
+    )
     parser.add_argument(
         "-x",
         "--resolutionx",
@@ -57,10 +65,11 @@ def cli():
     args = parser.parse_args()
 
     if os.path.splitext(args.xml)[1] == ".xml":
-        xml_file = args.xml
-        ass_file = args.ass if args.ass else os.path.splitext(xml_file)[0] + ".ass"
+        xml_file = os.path.abspath(args.xml)
+        ass_file = os.path.abspath(args.ass) if args.ass else os.path.abspath(os.path.splitext(xml_file)[0] + ".ass")
         convert_xml_to_ass(
             args.fontsize,
+            args.scfontsize,
             args.resolutionx,
             args.resolutiony,
             xml_file,

dmconvert/convert.py

@@ -11,24 +11,24 @@
 from dmconvert.header.header import draw_ass_header
 
 
-def convert_xml_to_ass(font_size, resolution_x, resolution_y, xml_file, ass_file):
+def convert_xml_to_ass(font_size, sc_font_size, resolution_x, resolution_y, xml_file, ass_file):
     # Parse XML
     print("DanmakuConvert v0.0.2", flush=True)
     print("https://github.com/timerring/DanmakuConvert", flush=True)
     tree = ET.parse(xml_file)
     root = tree.getroot()
     roll_array = DanmakuArray(resolution_x, resolution_y)
     btm_array = DanmakuArray(resolution_x, resolution_y)
-    draw_ass_header(ass_file, resolution_x, resolution_y, font_size)
+    draw_ass_header(ass_file, resolution_x, resolution_y, font_size, sc_font_size)
     draw_normal_danmaku(
         ass_file, root, font_size, roll_array, btm_array, resolution_x, resolution_y
     )
-    draw_gift_and_guard(ass_file, root, font_size, resolution_y)
-    draw_superchat(ass_file, font_size, resolution_y, root)
+    draw_gift_and_guard(ass_file, root, sc_font_size, resolution_y)
+    draw_superchat(ass_file, sc_font_size, resolution_y, root)
     print(f"Convert {xml_file} to {ass_file} successfully.", flush=True)
 
 
 if __name__ == "__main__":
     xml_file = "sample.xml"
     ass_file = "sample.ass"
-    convert_xml_to_ass(38, 720, 1280, xml_file, ass_file)
+    convert_xml_to_ass(38, 38, 720, 1280, xml_file, ass_file)

dmconvert/guardgift/gg_handler.py

@@ -26,7 +26,7 @@ def extract_gift_data(element):
     return data
 
 
-def draw_gift_and_guard(ass_file, root, font_size, resolution_y):
+def draw_gift_and_guard(ass_file, root, sc_font_size, resolution_y):
     with open(ass_file, "a", encoding="utf-8") as f:
         # Convert gifts and guards
         raw_gifts = [
@@ -41,6 +41,6 @@ def draw_gift_and_guard(ass_file, root, font_size, resolution_y):
         # generate the output
         for gift in processed:
             lines = generate_ass_line(
-                gift, resolution_y, font_size
+                gift, resolution_y, sc_font_size
             )  # example parameters
             f.writelines(lines)

dmconvert/header/header.py

@@ -1,7 +1,7 @@
 # Copyright (c) 2025 DanmakuConvert
 
 
-def draw_ass_header(ass_file, resolution_x, resolution_y, font_size):
+def draw_ass_header(ass_file, resolution_x, resolution_y, font_size, sc_font_size):
     # Write ASS header
     ass_header = f"""[Script Info]
 ScriptType: v4.00+
@@ -20,8 +20,8 @@ def draw_ass_header(ass_file, resolution_x, resolution_y, font_size):
 Style: TOP,Microsoft YaHei,{font_size},&H4BFFFFFF,&H00FFFFFF,&H00000000,&H1E6A5149,0,0,0,0,100.00,100.00,0.00,0.00,1,0.0,1.0,8,0,0,0,1
 Style: BTM,Microsoft YaHei,{font_size},&H4BFFFFFF,&H00FFFFFF,&H00000000,&H1E6A5149,0,0,0,0,100.00,100.00,0.00,0.00,1,0.0,1.0,8,0,0,0,1
 Style: SP,Microsoft YaHei,{font_size},&H00FFFFFF,&H00FFFFFF,&H00000000,&H1E6A5149,0,0,0,0,100.00,100.00,0.00,0.00,1,0.0,1.0,7,0,0,0,1
-Style: message_box,Microsoft YaHei,{font_size},&H00FFFFFF,&H00FFFFFF,&H00000000,&H1E6A5149,0,0,0,0,100.00,100.00,0.00,0.00,1,0.0,0.7,7,0,0,0,1
-Style: price,Microsoft YaHei,{int(font_size * 0.7)},&H00FFFFFF,&H00FFFFFF,&H00000000,&H1E6A5149,0,0,0,0,100.00,100.00,0.00,0.00,1,0.0,0.7,7,0,0,0,1
+Style: message_box,Microsoft YaHei,{sc_font_size},&H00FFFFFF,&H00FFFFFF,&H00000000,&H1E6A5149,0,0,0,0,100.00,100.00,0.00,0.00,1,0.0,0.7,7,0,0,0,1
+Style: price,Microsoft YaHei,{int(sc_font_size * 0.7)},&H00FFFFFF,&H00FFFFFF,&H00000000,&H1E6A5149,0,0,0,0,100.00,100.00,0.00,0.00,1,0.0,0.7,7,0,0,0,1
 
 [Events]
 Format: Layer, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text

dmconvert/superchat/superchat_handler.py

@@ -27,7 +27,7 @@ def get_sc_height(line_num, sc_font_size):
     return sc_height, top_box_height, btm_box_height
 
 
-def draw_superchat(ass_file, font_size, resolution_y, root):
+def draw_superchat(ass_file, sc_font_size, resolution_y, root):
     sc_list = []
     all_superchat = root.findall(".//sc")
     superchat_count = len(all_superchat)
@@ -39,7 +39,7 @@ def draw_superchat(ass_file, font_size, resolution_y, root):
         disapper_time = float(sc.get("ts")) + float(sc.get("time"))
         text = sc.text
         processed_text, line_num = get_text_line_num(text)
-        sc_height, _, btm_box_height = get_sc_height(line_num, font_size)
+        sc_height, _, btm_box_height = get_sc_height(line_num, sc_font_size)
         process = ""
         sc_list.append(
             [
@@ -54,16 +54,16 @@ def draw_superchat(ass_file, font_size, resolution_y, root):
             ]
         )
 
-    render_superchat(ass_file, font_size, resolution_y, sc_list)
+    render_superchat(ass_file, sc_font_size, resolution_y, sc_list)
 
 
-def render_superchat(ass_file, font_size, resolution_y, data):
+def render_superchat(ass_file, sc_font_size, resolution_y, data):
     """
     Render superchat events to the ass file.
 
     Args:
         ass_file (str): The path to the ass file.
-        font_size (int): The font size, which is used to calculate some render parameters.
+        sc_font_size (int): The superchat font size, which is used to calculate some render parameters.
         resolution_y (int): The resolution y, which is used to calculate the initial y coordinate.
         data (list): The data to render, which is a list of superchat events.
     """
@@ -127,7 +127,7 @@ def render_superchat(ass_file, font_size, resolution_y, data):
     ) in enumerate(data):
         # print(f"\nSC {i} ({start}-{end}):")
         # Initial y coordinate
-        previous_y = resolution_y - font_size * 2
+        previous_y = resolution_y - sc_font_size * 2
         current_y = previous_y - sc_height
         current_time = start
         # print(f"Time {start}: y = {current_y}, previous_y = {previous_y}")
@@ -150,7 +150,7 @@ def render_superchat(ass_file, font_size, resolution_y, data):
                     current_y,
                     previous_y,
                     text,
-                    font_size,
+                    sc_font_size,
                 ).write_superchat(ass_file)
                 previous_y = current_y
                 if delta_y[0] == "-":
@@ -169,5 +169,5 @@ def render_superchat(ass_file, font_size, resolution_y, data):
             current_y,
             previous_y,
             text,
-            font_size,
+            sc_font_size,
         ).write_superchat(ass_file)