Upload README.md

new_transcribe/README.md

@@ -0,0 +1,203 @@
+# RealTimeTranscribe
+
+CPU のみで動作する、Windows 向けリアルタイム音声文字起こしツールです。  
+`sounddevice` + `faster_whisper` を中心に構成し、オプションで英語→日本語翻訳も行えます。
+
+---
+
+## 機能
+
+| 機能 | 説明 |
+| ---- | ---- |
+| デバイス選択 | 起動時にマイクまたはシステム音声（ステレオミキサー等）を選択できる |
+| 仮表示（リアルタイム） | 3 秒ごとに現在のバッファを速報表示し、同じ行に上書き更新する |
+| 2 段階確定 | 無音検出で確定すると `[速]`（高速）→ 正確テキストで上書きする 2 パス処理 |
+| 翻訳（英語→日本語） | `LANGUAGE="en"` かつ翻訳モデルが存在するとき、確定テキストを自動翻訳して表示する |
+| ハルシネーション抑制 | ノイズ・無音時に Whisper が出力しがちな "you" 等の誤認識を自動でフィルタリングする |
+
+---
+
+## ディレクトリ構成
+
+```text
+RealTimeTranscribe/
+├── transcribe.py            # メインスクリプト（文字起こし）
+├── LFM_FAST_MT.py           # 翻訳モジュール（ONNX ベース LLM）
+├── test.py                  # 翻訳モジュールの動作確認スクリプト
+├── distil-whisper-small/    # Whisper ローカルモデル（要配置）
+│   ├── model.bin
+│   ├── config.json
+│   ├── tokenizer.json
+│   └── ...
+└── LFM2-350M-ENJP-MT-ONNX/ # 翻訳ローカルモデル（任意・要配置）
+    ├── onnx/
+    │   └── model_quantized.onnx
+    ├── tokenizer.json
+    └── ...
+```
+
+---
+
+## 必要なライブラリ
+
+```bash
+pip install sounddevice faster-whisper numpy onnxruntime tokenizers
+```
+
+> **注意:** `sounddevice` の動作には PortAudio が必要です。  
+> Windows では通常インストール不要ですが、問題が出た場合は `pipwin install pyaudio` を試してください。
+
+---
+
+## モデルの配置
+
+### 文字起こしモデル（必須）
+
+[distil-whisper/distil-small.en](https://huggingface.co/distil-whisper/distil-small.en) または多言語版をダウンロードし、  
+プロジェクトルートに `distil-whisper-small/` として配置してください。
+
+### 翻訳モデル（任意）
+
+英語→日本語翻訳が必要な場合は `LFM2-350M-ENJP-MT-ONNX/` を配置してください。  
+モデルフォルダが存在しない場合、翻訳機能はスキップされます。
+
+---
+
+## 使い方
+
+```bash
+python transcribe.py
+```
+
+起動するとデバイス一覧が表示されます。番号を入力して入力デバイスを選択してください。
+
+```text
+============================================================
+  リアルタイム文字起こし - デバイス選択
+============================================================
+
+[マイク / 入力デバイス]
+   1. マイク配列 (Realtek High Defini...)  (Windows WASAPI)
+
+[システム音声 / ステレオミキサー系]
+   2. ステレオ ミキサー (Realtek ...)      (Windows WASAPI)
+
+デバイス番号を選択してください [1]:
+```
+
+選択後、文字起こしが自動的に開始されます。`Ctrl+C` で終了します。
+
+---
+
+## 表示の見かた
+
+| プレフィックス | 意味 |
+| ------------- | ---- |
+| `[仮] ...` | 話し中のリアルタイム仮表示（同じ行に上書き更新） |
+| `[速] ...` | 無音確定直後の速報テキスト（beam_size=1） |
+| テキストのみ | 最終確定テキスト（beam_size=5 で上書き） |
+| `  → ...` | 翻訳結果（日本語） |
+
+---
+
+## 設定パラメータ
+
+[transcribe.py](transcribe.py) 冒頭の定数を編集することで動作を調整できます。
+
+### モデル・言語
+
+| パラメータ | デフォルト値 | 説明 |
+| --------- | ---------- | ---- |
+| `MODEL_PATH` | `./distil-whisper-small` | Whisper モデルが格納されているフォルダパス。別のモデルを使う場合はここを変更する。 |
+| `TRANSLATOR_MODEL_PATH` | `./LFM2-350M-ENJP-MT-ONNX` | 翻訳モデルのフォルダパス。フォルダが存在しない場合は翻訳機能が自動でスキップされる。 |
+| `LANGUAGE` | `"en"` | 音声の言語コード。日本語音声なら `"ja"`、英語なら `"en"`。Whisper が対応している言語コードをそのまま指定できる。 |
+| `ENABLE_TRANSLATION` | `True` | 翻訳機能の有効/無効。`True` かつ `LANGUAGE != "ja"` のときのみ翻訳が実行される。日本語モードでは翻訳しない。 |
+
+### 音声キャプチャ
+
+| パラメータ | デフォルト値 | 説明 |
+| --------- | ---------- | ---- |
+| `SAMPLE_RATE` | `16000` | Whisper への入力サンプリングレート（Hz）。Whisper の仕様上 16000 Hz 固定のため変更不要。デバイスのネイティブレートから自動リサンプリングされる。 |
+
+### リアルタイム表示
+
+| パラメータ | デフォルト値 | 説明 |
+| --------- | ---------- | ---- |
+| `INTERIM_INTERVAL` | `3.0` | 話し中に `[仮]` テキストを更新する間隔（秒）。小さくするほど表示が頻繁になるが CPU 負荷が上がる。 |
+
+### 無音検出・セグメント確定
+
+文字起こしは「無音を検出したタイミング」でセグメントが確定し、文字起こし処理が走ります。  
+以下のパラメータでその挙動を調整します。
+
+```text
+音声あり ─── 話し続ける ──────────────────→ [仮] 更新
+            │
+            └─ 無音が続く (SILENCE_DURATION 秒)
+                  │
+                  ├─ バッファが MIN_SEGMENT_SEC 以上 → 通常確定
+                  │
+                  └─ バッファが短くても FORCE_SILENCE_SEC 秒 → 強制確定
+```
+
+| パラメータ | デフォルト値 | 説明 |
+| --------- | ---------- | ---- |
+| `SILENCE_THRESHOLD` | `0.01` | 無音と判定する音量の閾値（RMS 値）。マイク環境の背景ノイズが多い場合は少し大きくすると誤判定が減る。 |
+| `SILENCE_DURATION` | `2.0` | この秒数以上の無音が続いたとき、セグメントの確定を試みる。短くすると反応が速くなるが、文の途中で区切れることがある。 |
+| `MIN_SEGMENT_SEC` | `5.0` | 通常確定に必要なバッファの最小長（秒）。これより短いバッファは `FORCE_SILENCE_SEC` に達するまで確定されない。短い発話が断片化するのを防ぐ。 |
+| `FORCE_SILENCE_SEC` | `6.0` | この秒数以上の無音が続いた場合、バッファが `MIN_SEGMENT_SEC` 未満でも強制的に確定する。長い沈黙の後に確定が来ない状況を防ぐ。 |
+| `MAX_BUFFER_SEC` | `30.0` | バッファの最大長（秒）。無音が来なくてもこの長さに達したら強制的に確定する。Whisper の処理限界を超えないための上限。 |
+
+### 文字起こし精度
+
+| パラメータ | デフォルト値 | 説明 |
+| --------- | ---------- | ---- |
+| `NO_SPEECH_PROB_THRESHOLD` | `0.6` | Whisper が各セグメントに付与する「無音確率」の閾値。この値以上のセグメントは無音とみなして出力をスキップする。下げると感度が上がるが誤認識も増える。 |
+| `BEAM_SIZE_FAST` | `1` | 速報表示（`[速]`）に使うビームサイズ。`1` が最速。数値を上げると精度が上がるが遅くなる。 |
+| `BEAM_SIZE_ACCURATE` | `5` | 最終確定テキストに使うビームサイズ。`5` は精度と速度のバランスが良い標準値。数値を上げると精度が上がるが CPU 負荷と待ち時間が増える。 |
+
+### チューニング例
+
+**環境が静かでマイクの感度が高い場合（誤検知が多い）**
+
+```python
+SILENCE_THRESHOLD = 0.02        # 少し上げてノイズを無音扱いにする
+NO_SPEECH_PROB_THRESHOLD = 0.5  # Whisper の無音判定も厳しくする
+```
+
+**すぐに文字を確定させたい（短い発話が多い）**
+
+```python
+SILENCE_DURATION = 1.0    # 1秒の無音で確定を試みる
+MIN_SEGMENT_SEC = 2.0     # 2秒以上のバッファがあれば確定
+FORCE_SILENCE_SEC = 3.0   # 3秒の無音で強制確定
+```
+
+**精度より速さを優先したい**
+
+```python
+BEAM_SIZE_FAST = 1        # 変更不要（既に最速）
+BEAM_SIZE_ACCURATE = 2    # 確定パスも速さ重視に下げる
+```
+
+---
+
+## システム音声（ステレオミキサー）を使うには
+
+Windows の場合、ステレオミキサーがデフォルトで無効になっていることがあります。
+
+1. タスクバーのスピーカーアイコンを右クリック →「サウンドの設定」を開く
+2. 「録音」タブを開く
+3. 空欄を右クリック →「無効なデバイスの表示」をオンにする
+4. 「ステレオ ミキサー」を右クリック →「有効化」
+
+有効化後、`transcribe.py` を再起動するとデバイス一覧に表示されます。
+
+---
+
+## 動作環境
+
+- OS: Windows 10 / 11
+- Python: 3.12
+- 動作方式: CPU のみ（GPU 不要）
+- スタンドアロン動作（インターネット接続不要）