pipeline for ja scripts and voice parallel corpus

.gitignore

@@ -3,3 +3,4 @@ __pycache__/
 
 /conversation/
 /scenario*/
+/sound*/

README.md

@@ -1,8 +1,9 @@
 ---
-pretty_name: 夜羊L系列简中脚本
+pretty_name: 夜羊L系列脚本
 language:
 - zh
-language_details: zho_Hans
+- ja
+language_details: zho_Hans, jpn
 license: cc-by-nc-4.0
 annotations_creators:
 - expert-generated
@@ -19,26 +20,39 @@ tags:
 ## ⚠️注意
 
 - **请注意，数据来自 R18 的视觉小说，并且包含可能被认为是不适当、令人震惊、令人不安、令人反感和极端的主题。如果您不确定在您的国家拥有任何形式的虚构文字内容的法律后果，请不要下载。**
-- **本项目内的所有数据及基于这些数据的衍生作品禁止用作商业性目的。** 我不拥有 `scenario-raw` 里的 krkr2 脚本源文件，而其余的数据处理方法按照 CC BY-NC 4.0 协议开放。
-- 按照数据预处理的先后次序，依次是：`scenario-raw` 里是 krkr2 脚本源文件，`scenario` 里是清理后的结构化脚本，`conversation` 里是我主观分段制作的对话格式数据。
-- 对于主观分段，一部分是手动的，其余是基于文本相似度的不太靠谱自动分段（我还没推的那部分，我不想被剧透啊啊啊）。手动分段道且阻且长，慢慢做吧，进度记录在 [manual_seg-progress.md](manual_seg-progress.md)。
-- 2015-2017 的前四作是单女主，后面的作品都是双女主的，脚本格式也略微不同。
+- **本项目内的所有数据及基于这些数据的衍生作品禁止用作商业性目的。** 我不拥有 `scenario-raw` 和 `scenario_ja-raw` 里的 krkr2 脚本源文件，而其余的数据处理方法按照 CC BY-NC 4.0 协议开放。
 - 🔑 压缩包已加密，解压密码是 yorunohitsuji
 
+## 文件结构
+
+```
+yoruno-vn.7z          # (zh)
+ ├── scenario-raw/     # krkr2 脚本源文件
+ ├── scenario/         # 清理后的结构化脚本
+ └── conversation/     # 我主观分段制作的对话格式数据
+yoruno_ja-vn.7z       # (ja)
+ ├── scenario_ja-raw/  # krkr2 脚本源文件
+ ├── scenario_ja/      # 清理后的结构化脚本
+ └── sound_ja/         # （并不存在的语音和）我手工标注的分类元信息
+```
 
+- 对于主观分段，一部分是手动的，其余是基于文本相似度的不太靠谱自动分段（我还没推的那部分，我不想被剧透啊啊啊）。手动分段道且阻且长，慢慢做吧，进度记录在 [manual_seg-progress.md](manual_seg-progress.md)。
+- 2015-2017 的前四作是单女主，后面的作品都是双女主的，脚本格式也略微不同。
+- 主观分段内容排除了一些与 npc 的对话、改了错别字，所以和原脚本不完全一致。
+- 语音文件果然还是不放了，不过我有标注元信息，用来分离出含有喘和或口腔音的语音。
 
 ## 给我自己看的预处理流程
 
-0. 各作的脚本提取出来放在 `scenario-raw/` 里，用 `script/transcode.sh` 转成 UTF-8，`2015-sssa` 额外需要 `script/dos2unix.sh` 转成 LF
+0. 各作的脚本提取出来放在 `scenario[_ja]-raw/` 里，用 `script/transcode.sh` 转成 UTF-8，`2015-sssa` 额外需要 `script/dos2unix.sh` 转成 LF
 1. 修复格式小问题 `cd scenario-raw && bash patch.sh`
-2. 运行 `python ks-parse-all.py` 得到 `scenario/`
+2. 运行 `python ks-parse-all.py --voice scenario[_ja]-raw/ scenario[_ja]/` 得到 `scenario[_ja]/`
 3. 分段，再转成 `conversation/`
     a. 自动分段：`python -m segment.auto path/to/scenario.jsonl`
     b. 手动分段后，`python -m segment.manual path/to/scenario-manual_seg.jsonl`
 
 添加新卷：
 
-0. 脚本放在 `scenario-raw/` 里
+0. 脚本放在 `scenario[_ja]-raw/` 里
 1. 在 `ks-parse-all.py` 里添加新卷的元数据
 
 ## 致谢

ks-parse-all.py

@@ -1,7 +1,8 @@
 from ks_parse.__main__ import parse_file
 
-from attrs import define, Factory
+from attrs import define
 
+import argparse
 from pathlib import Path
 
 
@@ -9,28 +10,36 @@ from pathlib import Path
 class Volume:
     name: str
     stype: str
-    # ロリ妊娠はダメ、下江コハル.jpg
-    ignore_list: list[str] = Factory(list)
 
 
 ALL_VOLUMES = [
     Volume(name="2015-sssa", stype="novel"),
-    Volume(name="2016a-yubikiri", stype="novel", ignore_list=["C000"]),
+    Volume(name="2016a-yubikiri", stype="novel"),
     Volume(name="2016b-sssa2", stype="novel"),
-    Volume(name="2017-otomari", stype="novel", ignore_list=["C000"]),
-    Volume(name="2018-harem", stype="adv", ignore_list=["Z000"]),
-    Volume(name="2019-aiyoku", stype="adv", ignore_list=["B003_2", "Z000"]),
-    Volume(name="2020-yuuwaku", stype="adv", ignore_list=["B000"]),
-    Volume(name="2022-mainichi", stype="adv", ignore_list=["Z000"]),
+    Volume(name="2017-otomari", stype="novel"),
+    Volume(name="2018-harem", stype="adv"),
+    Volume(name="2019-aiyoku", stype="adv"),
+    Volume(name="2020-yuuwaku", stype="adv"),
+    Volume(name="2022-mainichi", stype="adv"),
 ]
 BASE = Path("./scenario-raw")
 
 if __name__ == "__main__":
+    argp = argparse.ArgumentParser()
+    argp.add_argument(
+        "ks_base", type=Path, help="Base directory of .ks files, e.g. ./scenario-raw"
+    )
+    argp.add_argument(
+        "output_base",
+        type=Path,
+        help="Base directory of output .jsonl files, e.g. ./scenario",
+    )
+    argp.add_argument("--voice", action="store_true", help="Include voice file name")
+    args = argp.parse_args()
+
     for vol in ALL_VOLUMES:
         print(f"Processing {vol.name}...", end="")
-        for ks_path in sorted((BASE / vol.name).glob("*.ks")):
-            if ks_path.stem in vol.ignore_list:
-                continue
+        for ks_path in sorted((args.ks_base / vol.name).glob("*.ks")):
             print(f" {ks_path.stem}", end="")
-            parse_file(ks_path, vol.stype)
+            parse_file(ks_path, args.output_base, vol.stype, args.voice)
         print()

script/transcode.sh

@@ -1,10 +1,20 @@
 #!/usr/bin/env bash
 
 BASE=$1
+if [[ $BASE == *ja* ]]; then
+	ENCODING=shift-jis
+	if [[ $BASE == *2022-mainichi* ]]; then
+		ENCODING=unicode
+	fi
+else
+	ENCODING=unicode
+	if [[ $BASE == *2016a-yubikiri-old* ]]; then
+		ENCODING=gbk
+	fi
+fi
 
 for f in $BASE/*.ks; do
-	iconv -f unicode -t utf-8 < $f > $f.tmp
-	#iconv -f gbk -t utf-8 < $f > $f.tmp  # for 2016a-yubikiri-old
+	iconv -f $ENCODING -t utf-8 < $f > $f.tmp
 	mv $f.tmp $f
 done
 

voice-assemble.py

@@ -0,0 +1,85 @@
+"""Compile zh/ja parallel voice list
+
+label legend:
+n - normal
+h - h
+i - interjection
+o - oral
+"""
+from pathlib import Path
+import re
+import json
+import argparse
+import csv
+from typing import Iterable
+
+
+RE_PARANTHESIS = re.compile(r"（.+?）|【.+?】")
+RE_SINGLE_RM = re.compile(r"「|」|“|”|〜|—|♪")
+RE_QPREFIX = re.compile(r"^(…*？)")
+SET_INTJ = set("呜唔嗯哈啊呃呣呼咕咚唉嘿嘻噗啾噜")
+SET_INTJP = {*SET_INTJ, *"…―～。、，！？"}
+
+
+def gather_voice(fi: Iterable[str], d: dict[str, str], lang: str):
+    for line in fi:
+        if '"voice"' not in line:
+            continue
+        jl = json.loads(line)
+        d[jl["voice"]] = clean_text(jl["text"], lang)
+
+
+def clean_text(s: str, lang: str) -> str:
+    s = RE_PARANTHESIS.sub(r"", s)
+    s = RE_SINGLE_RM.sub(r"", s)
+    if lang == "zh":
+        s = RE_QPREFIX.sub(r"嗯\1", s)
+    else:
+        s = RE_QPREFIX.sub(r"ん\1", s)
+    return s
+
+
+def label_voice(
+    voice_map_zh: dict[str, str], voice_map_ja: dict[str, str]
+) -> Iterable[list[str]]:
+    for k, vja in sorted(voice_map_ja.items()):
+        if (vzh := voice_map_zh.get(k)) is None:
+            raise ValueError(f"Voice entry {k} not found in zh")
+        label = label_rule(vzh)
+        yield [k, vja, vzh, label]
+
+
+def label_rule(s: str) -> str:
+    """Simple heuristic to label voice entry;
+    needs manual labeling for "h" and "o" and manual check
+    """
+    if not (set(s) - SET_INTJP):
+        return "i"
+    i_stat = sum(c in SET_INTJ for c in s)
+    if i_stat >= 3 or (i_stat / len(s) > 0.1):
+        return "ni"
+    return "n"
+
+
+if __name__ == "__main__":
+    argp = argparse.ArgumentParser(description="Compile zh/ja parallel voice list")
+    argp.add_argument("volume", type=str, help="Volume name (e.g. 2019-aiyoku)")
+    args = argp.parse_args()
+
+    scenario_zh: Path = Path("scenario") / args.volume
+    scenario_ja: Path = Path("scenario_ja") / args.volume
+
+    voice_map_zh = {}
+    voice_map_ja = {}
+    for scenario, voice_map, lang in (
+        (scenario_zh, voice_map_zh, "zh"),
+        (scenario_ja, voice_map_ja, "ja"),
+    ):
+        for sc in scenario.glob("*.jsonl"):
+            with sc.open("r") as fi:
+                gather_voice(fi, voice_map, lang)
+
+    with open(f"{args.volume}.csv", "w", newline="") as csvfile:
+        cw = csv.writer(csvfile)
+        for row in label_voice(voice_map_zh, voice_map_ja):
+            cw.writerow(row)