feat(docs): 更新文档、添加 macOS 平台适配指南

2026-02-04 04:14:42 +08:00 · 2025-07-08 22:44:11 +08:00
parent cbbaaa95a3
commit 3c9138f115
15 changed files with 463 additions and 244 deletions
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 <div align="center" >
-    <img src="./resources/icon.png" width="100px" height="100px"/>
+    <img src="./build/icon.png" width="100px" height="100px"/>
    <h1 align="center">auto-caption</h1>
    <p>Auto Caption 是一个跨平台的实时字幕显示软件。</p>
    <p>
@@ -7,7 +7,7 @@
        | <a href="./README_en.md">English</a>
        | <a href="./README_ja.md">日本語</a> |
    </p>
-    <p><i>v0.2.0版本已经发布。预计将添加本地字幕引擎的v1.0.0版本正在开发中...</i></p>
+    <p><i>v0.3.0版本已经发布。预计将添加本地字幕引擎的v1.0.0版本仍正在开发中...</i></p>
 </div>

 ![](./assets/media/main_zh.png)
@@ -26,29 +26,30 @@

 ## 📖 基本使用

-目前仅提供了 Windows 平台的可安装版本。如果要使用默认的 Gummy 字幕引擎，首先需要获取阿里云百炼平台的 API KEY 并配置到环境变量中，这样才能正常使用该模型。
+目前提供了 Windows 和 macOS 平台的可安装版本。如果要使用默认的 Gummy 字幕引擎，首先需要获取阿里云百炼平台的 API KEY，然后将 API KEY 添加到软件设置中或者配置到环境变量中（仅 Windows 平台支持读取环境变量中的 API KEY），这样才能正常使用该模型。
+
+![](./assets/media/api_zh.png)

 **国际版的阿里云服务并没有提供 Gummy 模型，因此目前非中国用户无法使用默认字幕引擎。我正在开发新的本地字幕引擎，以确保所有用户都有默认字幕引擎可以使用。**

 相关教程：

 - [获取 API KEY](https://help.aliyun.com/zh/model-studio/get-api-key)
- [将 API Key 配置到环境变量](https://help.aliyun.com/zh/model-studio/configure-api-key-through-environment-variables)。
+- [将 API Key 配置到环境变量](https://help.aliyun.com/zh/model-studio/configure-api-key-through-environment-variables)

 如果你想了解字幕引擎的工作原理，或者你想开发自己的字幕引擎，请参考[字幕引擎说明文档](./docs/engine-manual/zh.md)。
 ## ✨ 特性

- 多界面语言支持
+- 跨平台、多界面语言支持
 - 丰富的字幕样式设置
 - 灵活的字幕引擎选择
 - 多语言识别与翻译
 - 字幕记录展示与导出
- 生成音频输出和麦克风输入的字幕
+- 生成音频输出或麦克风输入的字幕

 说明：
- Windows 平台支持生成音频输出和麦克风输入的字幕
- Linux 平台目前仅支持生成麦克风输入的字幕
- 目前还没有适配 macOS 平台
+- Windows 和 macOS 平台支持生成音频输出和麦克风输入的字幕，但是 **macOS 平台获取系统音频输出需要进行设置，详见[Auto Caption 用户手册](./docs/user-manual/zh.md)**
+- Linux 平台目前无法获取系统音频输出，仅支持生成麦克风输入的字幕

 ## ⚙️ 自带字幕引擎说明

@@ -74,10 +75,10 @@
 字幕引擎使用原生采样率（假设为 48kHz）进行采样，样本位深为 16bit，上传音频为为单通道，因此上传速率约为：

 $$
-48000\, \text{samples/second} \times 2\,\text{bytes/sample} \times 1\, \text{channel}  = 93.75\,\text{KB/s}
+48000\ \text{samples/second} \times 2\ \text{bytes/sample} \times 1\ \text{channel}  = 93.75\ \text{KB/s}
 $$

-而且引擎只会获取到音频流的时候才会上传数据，因此实际上传速率可能更小。模型结果回传流量消耗较小，可以不纳入考虑。
+而且引擎只会获取到音频流的时候才会上传数据，因此实际上传速率可能更小。模型结果回传流量消耗较小，没有纳入考虑。

 ### Vosk 字幕引擎（本地）

@@ -117,7 +118,9 @@ subenv/Scripts/activate
 source subenv/bin/activate
 ```

-然后安装依赖（注意如果是 Linux 或 macOS 环境，需要注释掉 `requirements.txt` 中的 `PyAudioWPatch`，该模块仅适用于 Windows 环境）。这一步可能会报错，一般是因为构建失败，需要根据报错信息安装对应的构建工具包。
+然后安装依赖（注意如果是 Linux 或 macOS 环境，需要注释掉 `requirements.txt` 中的 `PyAudioWPatch`，该模块仅适用于 Windows 环境）。
+
+> 这一步可能会报错，一般是因为构建失败，需要根据报错信息安装对应的构建工具包。

 ```bash
 pip install -r requirements.txt
@@ -138,12 +141,12 @@ npm run dev
 ```
 ### 构建项目

-注意目前软件没有适配 macOS 平台，请使用 Windows 或 Linux 系统进行构建，更建议使用实现了完整功能的 Windows 平台。
+注意目前软件只在 Windows 和 macOS 平台上进行了构建和测试，无法保证软件在 Linux 平台下的正确性。

 ```bash
 # For windows
 npm run build:win
-# For macOS, not avaliable yet
+# For macOS
 npm run build:mac
 # For Linux
 npm run build:linux
--- a/README_en.md
+++ b/README_en.md
@@ -1,13 +1,13 @@
 <div align="center" >
-    <img src="./resources/icon.png" width="100px" height="100px"/>
+    <img src="./build/icon.png" width="100px" height="100px"/>
    <h1 align="center">auto-caption</h1>
    <p>Auto Caption is a cross-platform real-time caption display software.</p>
    <p>
-        | <a href="./README.md">Chinese</a>
+        | <a href="./README.md">简体中文</a>
        | <b>English</b>
-        | <a href="./README_ja.md">Japanese</a> |
+        | <a href="./README_ja.md">日本語</a> |
    </p>
-    <p><i>Version v0.2.0 has been released. Version v1.0.0, which is expected to add a local caption engine, is under development...</i></p>
+    <p><i>Version v0.3.0 has been released. Version v1.0.0, which is expected to add a local caption engine, is still under development...</i></p>
 </div>

 ![](./assets/media/main_en.png)
@@ -16,51 +16,54 @@

 [GitHub Releases](https://github.com/HiMeditator/auto-caption/releases)

-## 📚 Related Documentation
+## 📚 Documentation

 [Auto Caption User Manual](./docs/user-manual/en.md)

-[Caption Engine Explanation Document](./docs/engine-manual/en.md)
+[Caption Engine Documentation](./docs/engine-manual/en.md)

 [Project API Documentation (Chinese)](./docs/api-docs/electron-ipc.md)

 ## 📖 Basic Usage

-Currently, only an installable version for the Windows platform is provided. If you want to use the default Gummy caption engine, you first need to obtain an API KEY from the Alibaba Cloud Model Studio and configure it in the environment variables. This is necessary to use the model properly.
+Currently, installable versions are provided for Windows and macOS platforms. To use the default Gummy caption engine, you first need to obtain an API KEY from Alibaba Cloud Bailian platform, then add the API KEY to the software settings or configure it in environment variables (only Windows platform supports reading API KEY from environment variables) to enable normal usage of this model.

-**The international version of Alibaba Cloud does not provide the Gummy model, so non-Chinese users currently cannot use the default caption engine. I am trying to develop a new local caption engine to ensure that all users have access to a default caption engine.**
+![](./assets/media/api_en.png)
+
+**The international version of Alibaba Cloud services does not provide the Gummy model, so currently non-Chinese users cannot use the default caption engine. I'm developing a new local caption engine to ensure all users have a default caption engine available.**
+
+Related tutorials:

-Relevant tutorials:
 - [Obtain API KEY (Chinese)](https://help.aliyun.com/zh/model-studio/get-api-key)
- [Configure API Key in Environment Variables (Chinese)](https://help.aliyun.com/zh/model-studio/configure-api-key-through-environment-variables).
+- [Configure API Key in Environment Variables (Chinese)](https://help.aliyun.com/zh/model-studio/configure-api-key-through-environment-variables)
+
+If you want to understand how the caption engine works, or if you want to develop your own caption engine, please refer to [Caption Engine Documentation](./docs/engine-manual/en.md).

-If you want to understand how the caption engine works or if you want to develop your own caption engine, please refer to the [Caption Engine Explanation Document](./docs/engine-manual/en.md).
 ## ✨ Features

- Multi-language interface support
+- Cross-platform, multi-language UI support
 - Rich caption style settings
 - Flexible caption engine selection
 - Multi-language recognition and translation
- Caption record display and export
- Generate captions for audio output and microphone input
+- Caption recording display and export
+- Generate captions for audio output or microphone input

 Notes:
- The Windows platform supports generating captions for both audio output and microphone input.
- The Linux platform currently only supports generating captions for microphone input.
- The macOS platform is not yet supported.
+- Windows and macOS platforms support generating captions for both audio output and microphone input, but **macOS requires additional setup to capture system audio output. See [Auto Caption User Manual](./docs/user-manual/en.md) for details.**
+- Linux platform currently cannot capture system audio output, only supports generating subtitles for microphone input.

-## ⚙️ Subtitle Engine Description
+## ⚙️ Built-in Subtitle Engines

-Currently, the software comes with 1 subtitle engine, and 2 new engines are being planned. The details of these engines are as follows.
+Currently, the software comes with 1 subtitle engine, with 2 new engines planned. Details are as follows.

-### Gummy Subtitle Engine (Cloud-based)
+### Gummy Subtitle Engine (Cloud)

-Developed based on the [Gummy Speech Translation Large Model](https://help.aliyun.com/zh/model-studio/gummy-speech-recognition-translation/) from Tongyi Lab, this cloud-based model is invoked through the API provided by [Aliyun Bailing](https://bailian.console.aliyun.com).
+Developed based on Tongyi Lab's [Gummy Speech Translation Model](https://help.aliyun.com/zh/model-studio/gummy-speech-recognition-translation/), using [Alibaba Cloud Bailian](https://bailian.console.aliyun.com) API to call this cloud model.

-**Model Detailed Parameters:**
+**Model Parameters:**

- Supported audio sampling rates: 16kHz and above
- Audio bit depth: 16bit
+- Supported audio sample rate: 16kHz and above
+- Audio sample depth: 16bit
 - Supported audio channels: Mono
 - Recognizable languages: Chinese, English, Japanese, Korean, German, French, Russian, Italian, Spanish
 - Supported translations:
@@ -70,24 +73,23 @@ Developed based on the [Gummy Speech Translation Large Model](https://help.aliyu

 **Network Traffic Consumption:**

-The subtitle engine uses the native sampling rate (assuming 48kHz) for sampling, with a sample bit depth of 16bit and single-channel audio, so the upload rate is approximately:
+The subtitle engine uses native sample rate (assumed to be 48kHz) for sampling, with 16bit sample depth and mono channel, so the upload rate is approximately:

 $$
-48000\, \text{samples/second} \times 2\,\text{bytes/sample} \times 1\, \text{channel} = 93.75\,\text{KB/s}
+48000\ \text{samples/second} \times 2\ \text{bytes/sample} \times 1\ \text{channel}  = 93.75\ \text{KB/s}
 $$

-Moreover, the engine only uploads data when it gets an audio stream, so the actual upload speed may be smaller. The traffic consumption for returning the model results is relatively small and can be disregarded.
+The engine only uploads data when receiving audio streams, so the actual upload rate may be lower. The return traffic consumption of model results is small and not considered here.

 ### Vosk Subtitle Engine (Local)

-Expected to be developed based on [vosk-api](https://github.com/alphacep/vosk-api), currently under experimentation.
+Planned to be developed based on [vosk-api](https://github.com/alphacep/vosk-api), currently in experimentation.

 ### FunASR Subtitle Engine (Local)

-If feasible, it will be developed based on [FunASR](https://github.com/modelscope/FunASR). Research and feasibility verification have not yet been conducted.
+If feasible, will be developed based on [FunASR](https://github.com/modelscope/FunASR). Not yet researched or verified for feasibility.

-
-## 🚀 Project Execution
+## 🚀 Project Setup

 ![](./assets/media/structure_en.png)

@@ -97,12 +99,15 @@ If feasible, it will be developed based on [FunASR](https://github.com/modelscop
 npm install
 ```

-### Build Caption Engine
+### Build Subtitle Engine

-First, navigate to the `caption-engine` folder and execute the following command to create a virtual environment:
+First enter the `caption-engine` folder and execute the following commands to create a virtual environment:

 ```bash
+# in ./caption-engine folder
 python -m venv subenv
+# or
+python3 -m venv subenv
 ```

 Then activate the virtual environment:
@@ -110,37 +115,40 @@ Then activate the virtual environment:
 ```bash
 # Windows
 subenv/Scripts/activate
-# Linux
+# Linux or macOS
 source subenv/bin/activate
 ```

-Next, install the dependencies (note that if you are in a Linux environment, you should comment out `PyAudioWPatch` in `requirements.txt`, as this module is only applicable to the Windows environment):
+Then install dependencies (note: for Linux or macOS environments, you need to comment out `PyAudioWPatch` in `requirements.txt`, as this module is only for Windows environments).
+
+> This step may report errors, usually due to build failures. You need to install corresponding build tools based on the error messages.

 ```bash
 pip install -r requirements.txt
 ```

-Then build the project using `pyinstaller`:
+Then use `pyinstaller` to build the project:

 ```bash
 pyinstaller --onefile main-gummy.py
 ```

-At this point, the project is built. You can find the executable file in the `caption-engine/dist` folder and proceed with further operations.
+After the build completes, you can find the executable file in the `caption-engine/dist` folder. Then proceed with subsequent operations.

-### Run the Project
+### Run Project

 ```bash
 npm run dev
 ```
-### Build the Project

-Note that the software is currently not adapted for the macOS platform. Please use Windows or Linux systems for building, with Windows being more recommended due to its full functionality.
+### Build Project
+
+Note: Currently the software has only been built and tested on Windows and macOS platforms. Correct operation on Linux platform is not guaranteed.

 ```bash
-# For Windows
+# For windows
 npm run build:win
-# For macOS, not avaliable yet
+# For macOS
 npm run build:mac
 # For Linux
 npm run build:linux
--- a/README_ja.md
+++ b/README_ja.md
@@ -1,13 +1,13 @@
 <div align="center" >
-    <img src="./resources/icon.png" width="100px" height="100px"/>
+    <img src="./build/icon.png" width="100px" height="100px"/>
    <h1 align="center">auto-caption</h1>
    <p>Auto Caption はクロスプラットフォームのリアルタイム字幕表示ソフトウェアです。</p>
    <p>
-        | <a href="./README.md">簡体中文</a>
-        | <a href="./README_en.md">英語</a>
+        | <a href="./README.md">简体中文</a>
+        | <a href="./README_en.md">English</a>
        | <b>日本語</b> |
    </p>
-    <p><i>v0.2.0 バージョンがリリースされました。ローカル字幕エンジンを追加予定の v1.0.0 バージョンが開発中...</i></p>
+    <p><i>v0.3.0 バージョンがリリースされました。ローカル字幕エンジンを追加予定の v1.0.0 バージョンを現在開発中...</i></p>
 </div>

 ![](./assets/media/main_ja.png)
@@ -20,49 +20,50 @@

 [Auto Caption ユーザーマニュアル](./docs/user-manual/ja.md)

-[字幕エンジン説明文書](./docs/engine-manual/ja.md)
+[字幕エンジン説明ドキュメント](./docs/engine-manual/ja.md)

 [プロジェクト API ドキュメント（中国語）](./docs/api-docs/electron-ipc.md)

-## 📖 基本的な使用方法
+現在、Windows と macOS プラットフォーム向けのインストール可能なバージョンを提供しています。デフォルトの Gummy 字幕エンジンを使用するには、まず Alibaba Cloud Bailian プラットフォームから API KEY を取得し、その API KEY をソフトウェア設定に追加するか、環境変数に設定する必要があります（Windows プラットフォームのみ環境変数からの API KEY 読み取りをサポートしています）。

-現在、Windows プラットフォーム向けのインストール可能なバージョンのみ提供されています。デフォルトの Gummy 字幕エンジンを使用する場合、まず Alibaba Cloud 百煉プラットフォームの API キーを取得し、環境変数に設定する必要があります。これによりモデルが正常に動作します。
+![](./assets/media/api_ja.png)

-**アリババクラウドの国際版には Gummy モデルが提供されていないため、中国以外のユーザーは現在、デフォルトの字幕エンジンを使用できません。すべてのユーザーが利用できるように、新しいローカルの字幕エンジンを開発中です。**
+**国際版の Alibaba Cloud サービスには Gummy モデルが提供されていないため、現在中国以外のユーザーはデフォルトの字幕エンジンを使用できません。すべてのユーザーがデフォルトの字幕エンジンを使用できるように、新しいローカル字幕エンジンを開発中です。**

 関連チュートリアル：
- [API キーの取得（中国語）](https://help.aliyun.com/zh/model-studio/get-api-key)
- [環境変数への API キーの設定（中国語）](https://help.aliyun.com/zh/model-studio/configure-api-key-through-environment-variables)。

-字幕エンジンの仕組みを理解したい場合、または独自の字幕エンジンを開発したい場合は、[字幕エンジン説明文書](./docs/engine-manual/ja.md)を参照してください。
+- [API KEY の取得（中国語）](https://help.aliyun.com/zh/model-studio/get-api-key)
+- [環境変数への API Key 設定（中国語）](https://help.aliyun.com/zh/model-studio/configure-api-key-through-environment-variables)
+
+字幕エンジンの動作原理を理解したい場合、または独自の字幕エンジンを開発したい場合は、[字幕エンジン説明ドキュメント](./docs/engine-manual/ja.md)を参照してください。
+
 ## ✨ 特徴

- 複数言語のインターフェースサポート
+- クロスプラットフォーム、多言語 UI サポート
 - 豊富な字幕スタイル設定
 - 柔軟な字幕エンジン選択
- 複数言語の認識と翻訳
+- 多言語認識と翻訳
 - 字幕記録の表示とエクスポート
- オーディオ出力とマイク入力の字幕生成
+- オーディオ出力またはマイク入力からの字幕生成

-注意事項：
- Windows プラットフォームでは、オーディオ出力とマイク入力の両方の字幕生成がサポートされています。
- Linux プラットフォームでは、現在マイク入力の字幕生成のみがサポートされています。
- 現在、macOS プラットフォームには対応していません。
+注記：
+- Windows と macOS プラットフォームはオーディオ出力とマイク入力の両方からの字幕生成をサポートしていますが、**macOS プラットフォームでシステムオーディオ出力を取得するには設定が必要です。詳細は[Auto Caption ユーザーマニュアル](./docs/user-manual/ja.md)をご覧ください。**
+- Linux プラットフォームは現在システムオーディオ出力を取得できず、マイク入力からの字幕生成のみをサポートしています。

-## ⚙️ 搭載字幕エンジンの説明
+## ⚙️ 字幕エンジン説明

-現在のソフトウェアには 1 つの字幕エンジンが搭載されており、新しい 2 つのエンジンが計画されています。それぞれの詳細情報は以下の通りです。
+現在ソフトウェアには1つの字幕エンジンが組み込まれており、2つの新しいエンジンを計画中です。詳細は以下の通りです。

 ### Gummy 字幕エンジン（クラウド）

-通義実験室の [Gummy音声翻訳大規模モデル](https://help.aliyun.com/zh/model-studio/gummy-speech-recognition-translation/) を基に開発され、[阿里云百煉](https://bailian.console.aliyun.com) の API 経由でこのクラウドモデルを呼び出します。
+Tongyi Lab の [Gummy 音声翻訳大規模モデル](https://help.aliyun.com/zh/model-studio/gummy-speech-recognition-translation/)をベースに開発され、[Alibaba Cloud Bailian](https://bailian.console.aliyun.com) の APIを使用してこのクラウドモデルを呼び出します。

-**モデルの詳細パラメータ：**
+**モデル詳細パラメータ：**

- 音声サンプリングレートのサポート：16kHz以上
- 音声サンプル深度：16bit
- 音声チャンネル数のサポート：シングルチャンネル
- 識別可能な言語：中国語、英語、日本語、韓国語、ドイツ語、フランス語、ロシア語、イタリア語、スペイン語
+- サポートするオーディオサンプルレート：16kHz以上
+- オーディオサンプルビット深度：16bit
+- サポートするオーディオチャンネル：モノラル
+- 認識可能な言語：中国語、英語、日本語、韓国語、ドイツ語、フランス語、ロシア語、イタリア語、スペイン語
 - サポートする翻訳：
  - 中国語 → 英語、日本語、韓国語
  - 英語 → 中国語、日本語、韓国語
@@ -70,23 +71,23 @@

 **ネットワークトラフィック消費量：**

-字幕エンジンはネイティブサンプリングレート（48kHzと仮定）を使用してサンプリングを行い、サンプル深度は16bitであり、アップロードされる音声はシングルチャンネルであるため、アップロード速度は約：
+字幕エンジンはネイティブサンプルレート（48kHz と仮定）でサンプリングを行い、サンプルビット深度は 16bit、アップロードオーディオはモノラルチャンネルのため、アップロードレートは約：

 $$
-48000\, \text{samples/second} \times 2\,\text{bytes/sample} \times 1\, \text{channel} = 93.75\,\text{KB/s}
+48000\ \text{samples/second} \times 2\ \text{bytes/sample} \times 1\ \text{channel}  = 93.75\ \text{KB/s}
 $$

-また、エンジンは音声ストリームを取得したときのみデータをアップロードするため、実際のアップロード速度はさらに小さくなる可能性があります。モデルからの結果返送によるトラフィック消費は小さく、考慮する必要はありません。
+また、エンジンはオーディオストームを取得したときのみデータをアップロードするため、実際のアップロードレートはさらに小さくなる可能性があります。モデル結果の返信トラフィック消費量は小さく、ここでは考慮していません。

-### Vosk 字幕エンジン（ローカル）
+### Vosk字幕エンジン（ローカル）

-[vosk-api](https://github.com/alphacep/vosk-api) をベースにした開発を予定しており、現在試験段階にあります。
+[vosk-api](https://github.com/alphacep/vosk-api) をベースに開発予定で、現在実験中です。

-### FunASR 字幕エンジン（ローカル）
+### FunASR字幕エンジン（ローカル）

-可能であれば、[FunASR](https://github.com/modelscope/FunASR) をベースに開発を行う予定です。まだ調査および実現可能性の検証が行われていません。
+可能であれば、[FunASR](https://github.com/modelscope/FunASR) をベースに開発予定です。まだ調査と実現可能性の検証を行っていません。

-## 🚀 プロジェクトの実行
+## 🚀 プロジェクト実行

 ![](./assets/media/structure_ja.png)

@@ -96,51 +97,57 @@ $$
 npm install
 ```

-### 字幕エンジンのビルド
+### 字幕エンジンの構築

-まず、`caption-engine` フォルダに移動し、以下のコマンドを実行して仮想環境を作成します：
+まず `caption-engine` フォルダに入り、以下のコマンドを実行して仮想環境を作成します：

 ```bash
+# ./caption-engine フォルダ内
 python -m venv subenv
+# または
+python3 -m venv subenv
 ```

-次に、仮想環境をアクティブ化します：
+次に仮想環境をアクティブにします：

 ```bash
 # Windows
 subenv/Scripts/activate
-# Linux
+# Linux または macOS
 source subenv/bin/activate
 ```

-次に、依存関係をインストールします（Linux 環境の場合、`requirements.txt` の `PyAudioWPatch` をコメントアウトする必要があります。このモジュールは Windows 環境でのみ適用されます）：
+その後、依存関係をインストールします（Linux または macOS 環境の場合、`requirements.txt` 内の `PyAudioWPatch` をコメントアウトする必要があります。このモジュールは Windows 環境専用です）。
+
+> このステップでエラーが発生する場合があります。一般的にはビルド失敗が原因で、エラーメッセージに基づいて対応するビルドツールパッケージをインストールする必要があります。

 ```bash
 pip install -r requirements.txt
 ```

-次に、`pyinstaller` を使用してプロジェクトをビルドします：
+その後、`pyinstaller` を使用してプロジェクトをビルドします：

 ```bash
 pyinstaller --onefile main-gummy.py
 ```

-この時点でプロジェクトのビルドが完了し、`caption-engine/dist` フォルダで対応する実行ファイルを見つけることができます。その後、必要な操作を行ってください。
+これでプロジェクトのビルドが完了し、`caption-engine/dist` フォルダ内に対応する実行可能ファイルが確認できます。その後、次の操作に進むことができます。

-### プロジェクトの実行
+### プロジェクト実行

 ```bash
 npm run dev
 ```
-### プロジェクトのビルド

-現在、ソフトウェアは macOS プラットフォームに対応していません。Windows または Linux システムを使用してビルドしてください。完全な機能を備えた Windows プラットフォームが推奨されます。
+### プロジェクト構築
+
+現在、ソフトウェアは Windows と macOS プラットフォームでのみ構築とテストが行われており、Linux プラットフォームでの正しい動作は保証できません。

 ```bash
-# For Windows
+# Windows 用
 npm run build:win
-# For macOS, not avaliable yet
+# macOS 用
 npm run build:mac
-# For Linux
+# Linux 用
 npm run build:linux
 ```
--- a/assets/media/api_en.png
+++ b/assets/media/api_en.png
--- a/assets/media/api_ja.png
+++ b/assets/media/api_ja.png
--- a/assets/media/api_zh.png
+++ b/assets/media/api_zh.png
--- a/docs/CHANGELOG.md
+++ b/docs/CHANGELOG.md
@@ -47,3 +47,64 @@
 - 新增日语说明文档
 - 新增英语、日语字幕引擎说明文档和用户手册
 - 新增 electron ipc api 文档
+
+
+
+
+Here are the translations of the selected macOS audio output configuration section:
+
+### English Translation:
+```markdown
+### Capturing System Audio Output on macOS
+
+The subtitle engine cannot directly capture system audio output on macOS platform and requires additional driver installation. The current subtitle engine uses [BlackHole](https://github.com/ExistentialAudio/BlackHole). First open Terminal and execute one of the following commands (recommended to choose the first one):
+
+```bash
+brew install blackhole-2ch
+brew install blackhole-16ch
+brew install blackhole-64ch
+```
+
+After installation completes, open `Audio MIDI Setup` (searchable via `cmd + space`). Check if BlackHole appears in the device list - if not, restart your computer.
+
+Once BlackHole is confirmed installed, in the `Audio MIDI Setup` page, click the plus (+) button at bottom left and select "Create Multi-Output Device". Include both BlackHole and your desired audio output destination in the outputs. Finally, set this multi-output device as your default audio output device.
+
+Now the subtitle engine can capture system audio output and generate subtitles.
+```
+
+### Japanese Translation:
+```markdown
+### macOSでのシステムオーディオ出力の取得方法
+
+字幕エンジンはmacOSプラットフォームで直接システムオーディオ出力を取得できず、追加のドライバーインストールが必要です。現在の字幕エンジンでは[BlackHole](https://github.com/ExistentialAudio/BlackHole)を使用しています。まずターミナルを開き、以下のいずれかのコマンドを実行してください（最初のオプションを推奨します）：
+
+```bash
+brew install blackhole-2ch
+brew install blackhole-16ch
+brew install blackhole-64ch
+```
+
+インストール完了後、`オーディオMIDI設定`（`cmd + space`で検索可能）を開きます。デバイスリストにBlackHoleが表示されているか確認してください - 表示されていない場合はコンピュータを再起動してください。
+
+BlackHoleのインストールが確認できたら、`オーディオMIDI設定`ページで左下のプラス(+)ボタンをクリックし、「マルチ出力デバイスを作成」を選択します。出力にBlackHoleと希望するオーディオ出力先の両方を含めてください。最後に、このマルチ出力デバイスをデフォルトのオーディオ出力デバイスに設定します。
+
+これで字幕エンジンがシステムオーディオ出力をキャプチャし、字幕を生成できるようになります。
+```
+
+Key translation notes:
+1. Technical terms:
+   - "Audio MIDI Setup" → "オーディオMIDI設定" (Japanese)
+   - "Multi-Output Device" → "マルチ出力デバイス" (Japanese)
+   - Maintained "BlackHole" and "brew" commands as-is
+
+2. Structure:
+   - Kept the same section hierarchy with ### headers
+   - Preserved all code blocks and formatting
+   - Maintained the step-by-step instruction flow
+
+3. Localization:
+   - Used appropriate Japanese technical terms
+   - Adjusted phrasing for natural reading in each language
+   - Kept all terminal commands and interface elements unchanged
+
+Both translations accurately convey the technical procedures while adapting naturally to their target languages.
--- a/docs/TODO.md
+++ b/docs/TODO.md
@@ -7,6 +7,7 @@
 - [x] 增强字幕窗口顶置优先级 *2025/07/07*
 - [x] 添加对自带字幕引擎的详细规格说明 *2025/07/07*
 - [x] 添加复制字幕到剪贴板功能 *2025/07/08*
+- [x] 适配 macOS 平台 *2025/07/08*

 ## 待完成

--- a/docs/engine-manual/en.md
+++ b/docs/engine-manual/en.md
@@ -1,67 +1,102 @@
 # Caption Engine Documentation

+Corresponding Version: v0.3.0
+
 ![](../../assets/media/structure_en.png)

 ## Introduction to the Caption Engine

-The so-called caption engine is actually a subprocess that fetches real-time streaming audio data from system audio input (recording) or output (playing sound) and calls an audio-to-text model to generate captions for the corresponding audio. The generated captions are converted into JSON formatted string data and passed to the main program via standard output (it must be ensured that the string read by the main program can be correctly interpreted as a JSON object). The main program reads and interprets the caption data, processes it, and displays it on the window.
+The so-called caption engine is actually a subprogram that captures real-time streaming data from the system's audio input (recording) or output (playing sound) and calls an audio-to-text model to generate captions for the corresponding audio. The generated captions are converted into a JSON-formatted string and passed to the main program through standard output (it must be ensured that the string read by the main program can be correctly interpreted as a JSON object). The main program reads and interprets the caption data, processes it, and then displays it on the window.

-## Features the Caption Engine Needs to Implement
+## Functions Required by the Caption Engine

 ### Audio Acquisition

-First, your caption engine needs to acquire streaming audio data from system audio input (recording) or output (playing sound). If developing with Python, you can use the PyAudio library to get microphone audio input data (cross-platform). Use the PyAudioWPatch library to get system audio output (only applicable to Windows platform).
+First, your caption engine needs to capture streaming data from the system's audio input (recording) or output (playing sound). If using Python for development, you can use the PyAudio library to obtain microphone audio input data (cross-platform). Use the PyAudioWPatch library to get system audio output (Windows platform only).

-The acquired audio stream data is usually in the form of short audio chunks, and the size of these chunks should be adjusted according to the model. For example, Alibaba Cloud's Gummy model performs better with 0.05-second audio chunks than with 0.2-second audio chunks.
+Generally, the captured audio stream data consists of short audio chunks, and the size of these chunks should be adjusted according to the model. For example, Alibaba Cloud's Gummy model performs better with 0.05-second audio chunks compared to 0.2-second ones.

 ### Audio Processing

-The acquired audio stream may need preprocessing before being converted to text. For instance, Alibaba Cloud's Gummy model can only recognize single-channel audio streams, while the collected audio streams are generally dual-channel, so you need to convert the dual-channel audio stream to a single channel. The conversion of channels can be achieved using methods from the NumPy library.
+The acquired audio stream may need preprocessing before being converted to text. For instance, Alibaba Cloud's Gummy model can only recognize single-channel audio streams, while the collected audio streams are typically dual-channel, thus requiring conversion from dual-channel to single-channel. Channel conversion can be achieved using methods in the NumPy library.

-You can directly use the audio acquisition and processing modules I've developed (path: `caption-engine/sysaudio`):
-
-```python
-if sys.platform == 'win32':
-    from sysaudio.win import AudioStream, mergeStreamChannels
-elif sys.platform == 'linux':
-    from sysaudio.linux import AudioStream, mergeStreamChannels
-else:
-    raise NotImplementedError(f"Unsupported platform: {sys.platform}")
-
-# Create an instance of the audio stream object
-stream = AudioStream(audio_type)
-# Open the audio stream
-stream.openStream()
-while True:  # Loop to read audio data
-    # Read audio data
-    data = stream.stream.read(stream.CHUNK)
-    # Convert dual-channel audio data to single-channel
-    data = mergeStreamChannels(data, stream.CHANNELS)
-    # Call the audio-to-text model
-    # ... ...
-```
+You can directly use the audio acquisition (`caption-engine/sysaudio`) and audio processing (`caption-engine/audioprcs`) modules I have developed.

 ### Audio to Text Conversion

-Once you have the appropriate audio stream, you can convert it to text. Various models are typically used to achieve this. You can choose the model based on your requirements.
+After obtaining the appropriate audio stream, you can convert it into text. This is generally done using various models based on your requirements.
+
+A nearly complete implementation of a caption engine is as follows:
+
+```python
+import sys
+import argparse
+
+# Import system audio acquisition module
+if sys.platform == 'win32':
+    from sysaudio.win import AudioStream
+elif sys.platform == 'darwin':
+    from sysaudio.darwin import AudioStream
+elif sys.platform == 'linux':
+    from sysaudio.linux import AudioStream
+else:
+    raise NotImplementedError(f"Unsupported platform: {sys.platform}")
+
+# Import audio processing functions
+from audioprcs import mergeChunkChannels
+# Import audio-to-text module
+from audio2text import InvalidParameter, GummyTranslator
+
+
+def convert_audio_to_text(s_lang, t_lang, audio_type, chunk_rate, api_key):
+    # Set standard output to line buffering
+    sys.stdout.reconfigure(line_buffering=True) # type: ignore
+
+    # Create instances for audio acquisition and speech-to-text
+    stream = AudioStream(audio_type, chunk_rate)
+    if t_lang == 'none':
+        gummy = GummyTranslator(stream.RATE, s_lang, None, api_key)
+    else:
+        gummy = GummyTranslator(stream.RATE, s_lang, t_lang, api_key)
+
+    # Start instances
+    stream.openStream()
+    gummy.start()
+
+    while True:
+        try:
+            # Read audio stream data
+            chunk = stream.read_chunk()
+            chunk_mono = mergeChunkChannels(chunk, stream.CHANNELS)
+            try:
+                # Call the model for translation
+                gummy.send_audio_frame(chunk_mono)
+            except InvalidParameter:
+                gummy.start()
+                gummy.send_audio_frame(chunk_mono)
+        except KeyboardInterrupt:
+            stream.closeStream()
+            gummy.stop()
+            break
+```

 ### Data Transmission

-After obtaining the text for the current audio stream, you need to pass the text to the main program. The caption engine process passes the caption data to the Electron main process through standard output.
+After obtaining the text of the current audio stream, it needs to be transmitted to the main program. The caption engine process passes the caption data to the Electron main process through standard output.

-The content transmitted must be a JSON string, where the JSON object should include the following parameters:
+The content transmitted must be a JSON string, where the JSON object must contain the following parameters:

 ```typescript
 export interface CaptionItem {
  index: number, // Caption sequence number
-  time_s: string, // Start time of the current caption
-  time_t: string, // End time of the current caption
+  time_s: string, // Caption start time
+  time_t: string, // Caption end time
  text: string, // Caption content
  translation: string // Caption translation
 }
 ```

-**It is essential to ensure that every time a caption JSON data is output, the buffer is flushed, ensuring that the string received by the Electron main process each time can be interpreted as a JSON object.**
+**It is essential to ensure that each time we output caption JSON data, the buffer is flushed, ensuring that the string received by the Electron main process can always be interpreted as a JSON object.**

 If using Python, you can refer to the following method to pass data to the main program:

@@ -84,7 +119,8 @@ sys.stdout.reconfigure(line_buffering=True)
 ...
 ```

-The code for the data receiving end is as follows:
+Data receiver code is as follows:
+

 ```typescript
 // src\main\utils\engine.ts
@@ -97,7 +133,7 @@ The code for the data receiving end is as follows:
            const caption = JSON.parse(line);
            addCaptionLog(caption);
          } catch (e) {
-            controlWindow.sendErrorMessage('Cannot parse caption engine output as JSON object: ' + e)
+            controlWindow.sendErrorMessage('Unable to parse the output from the caption engine as a JSON object: ' + e)
            console.error('[ERROR] Error parsing JSON:', e);
          }
        }
@@ -111,6 +147,6 @@ The code for the data receiving end is as follows:
 ...
 ```

-## Code Reference
+## Reference Code

-The default caption engine entry point code is located in the `main-gummy.py` file under the `caption-engine` folder of this project. The `src\main\utils\engine.ts` file contains the server-side code for acquiring and processing caption engine data. You can read and understand the implementation details and the complete runtime process of the caption engine as needed.
+The `main-gummy.py` file under the `caption-engine` folder in this project serves as the entry point for the default caption engine. The `src\main\utils\engine.ts` file contains the server-side code for acquiring and processing data from the caption engine. You can read and understand the implementation details and the complete execution process of the caption engine as needed.
--- a/docs/engine-manual/ja.md
+++ b/docs/engine-manual/ja.md
@@ -1,71 +1,106 @@
-# キャプションエンジンの説明文書
+# 字幕エンジンの説明文書

-![](../../assets/media/structure_ja.png)
+対応バージョン：v0.3.0

 この文書は大規模モデルを使用して翻訳されていますので、内容に正確でない部分があるかもしれません。

-## キャプションエンジンの紹介
+![](../../assets/media/structure_ja.png)

-キャプションエンジンとは、実際にはサブプログラムであり、システムの音声入力（録音）または出力（音声再生）のストリーミングデータをリアルタイムで取得し、音声をテキストに変換するモデルを呼び出して対応する音声のキャプションを生成します。生成されたキャプションはJSON形式の文字列データに変換され、標準出力を通じてメインプログラムに渡されます（メインプログラムが読み取った文字列がJSONオブジェクトとして正しく解釈できるようにする必要があります）。メインプログラムはキャプションデータを読み取り、解釈し、処理してウィンドウ上に表示します。
+## 字幕エンジンの紹介

-## キャプションエンジンが必要とする機能
+所謂字幕エンジンは実際にはサブプログラムであり、システムの音声入力（録音）または出力（音声再生）のストリーミングデータをリアルタイムで取得し、音声からテキストへの変換モデルを使って対応する音声の字幕を生成します。生成された字幕はJSON形式の文字列データに変換され、標準出力を通じてメインプログラムに渡されます（メインプログラムが読み取った文字列が正しいJSONオブジェクトとして解釈されることが保証される必要があります）。メインプログラムは字幕データを読み取り、解釈して処理し、ウィンドウ上に表示します。
+
+## 字幕エンジンが必要な機能

 ### 音声の取得

-まず、あなたのキャプションエンジンはシステムの音声入力（録音）または出力（音声再生）のストリーミングデータを取得する必要があります。Pythonを使用して開発する場合、PyAudioライブラリを使用してマイクからの音声入力データを取得できます（全プラットフォーム対応）。PyAudioWPatchライブラリを使用してシステムの音声出力を取得することができます（Windowsプラットフォームのみ対応）。
+まず、あなたの字幕エンジンはシステムの音声入力（録音）または出力（音声再生）のストリーミングデータを取得する必要があります。Pythonを使用して開発する場合、PyAudioライブラリを使ってマイクからの音声入力データを取得できます（全プラットフォーム共通）。また、WindowsプラットフォームではPyAudioWPatchライブラリを使ってシステムの音声出力を取得することもできます。

-一般的に取得される音声ストリームデータは、比較的短い時間の音声ブロックで構成されています。モデルに合わせて音声ブロックのサイズを調整する必要があります。例えば、アリババクラウドのGummyモデルでは、0.05秒の音声ブロックを使用した認識精度が0.2秒の音声ブロックよりも優れています。
+一般的に取得される音声ストリームデータは、比較的短い時間間隔の音声ブロックで構成されています。モデルに合わせて音声ブロックのサイズを調整する必要があります。例えば、アリババクラウドのGummyモデルでは、0.05秒の音声ブロックを使用した認識結果の方が0.2秒の音声ブロックよりも優れています。

 ### 音声の処理

-取得した音声ストリームは、テキストに変換する前に前処理を行う必要があるかもしれません。例えば、アリババクラウドのGummyモデルは単一チャンネルの音声ストリームしか認識できませんが、収集された音声ストリームは通常二重チャンネルです。そのため、二重チャンネルの音声ストリームを単一チャンネルに変換する必要があります。チャンネル数の変換はNumPyライブラリのメソッドを使用して行うことができます。
+取得した音声ストリームは、テキストに変換する前に前処理が必要な場合があります。例えば、アリババクラウドのGummyモデルは単一チャンネルの音声ストリームしか認識できませんが、収集された音声ストリームは通常二重チャンネルであるため、二重チャンネルの音声ストリームを単一チャンネルに変換する必要があります。チャンネル数の変換はNumPyライブラリのメソッドを使って行うことができます。

-既に開発済みの音声取得と音声処理モジュール（パス：`caption-engine/sysaudio`）を使用することもできます：
-
-```python
-if sys.platform == 'win32':
-    from sysaudio.win import AudioStream, mergeStreamChannels
-elif sys.platform == 'linux':
-    from sysaudio.linux import AudioStream, mergeStreamChannels
-else:
-    raise NotImplementedError(f"サポートされていないプラットフォーム: {sys.platform}")
-
-# 音声ストリームオブジェクトのインスタンスを作成
-stream = AudioStream(audio_type)
-# 音声ストリームを開く
-stream.openStream()
-while True:  # 音声データを繰り返し読み込む
-    # 音声データを読み込む
-    data = stream.stream.read(stream.CHUNK)
-    # 二重チャンネルの音声データを単一チャンネルに変換
-    data = mergeStreamChannels(data, stream.CHANNELS)
-    # 音声をテキストに変換するモデルを呼び出す
-    # ... ...
-```
+あなたは私によって開発された音声の取得（`caption-engine/sysaudio`）と音声の処理（`caption-engine/audioprcs`）モジュールを直接使用することができます。

 ### 音声からテキストへの変換

-適切な音声ストリームを得た後、それをテキストに変換することができます。通常、様々なモデルを使用してこの変換を行います。必要に応じてモデルを選択してください。
+適切な音声ストリームを得た後、それをテキストに変換することができます。通常、様々なモデルを使って音声ストリームをテキストに変換します。必要に応じてモデルを選択することができます。
+
+ほぼ完全な字幕エンジンの実装例：
+
+```python
+import sys
+import argparse
+
+# システム音声の取得に関する設定
+if sys.platform == 'win32':
+    from sysaudio.win import AudioStream
+elif sys.platform == 'darwin':
+    from sysaudio.darwin import AudioStream
+elif sys.platform == 'linux':
+    from sysaudio.linux import AudioStream
+else:
+    raise NotImplementedError(f"Unsupported platform: {sys.platform}")
+
+# 音声処理関数のインポート
+from audioprcs import mergeChunkChannels
+# 音声からテキストへの変換モジュールのインポート
+from audio2text import InvalidParameter, GummyTranslator
+
+
+def convert_audio_to_text(s_lang, t_lang, audio_type, chunk_rate, api_key):
+    # 標準出力をラインバッファリングに設定
+    sys.stdout.reconfigure(line_buffering=True) # type: ignore
+
+    # 音声の取得と音声からテキストへの変換のインスタンスを作成
+    stream = AudioStream(audio_type, chunk_rate)
+    if t_lang == 'none':
+        gummy = GummyTranslator(stream.RATE, s_lang, None, api_key)
+    else:
+        gummy = GummyTranslator(stream.RATE, s_lang, t_lang, api_key)
+
+    # インスタンスを開始
+    stream.openStream()
+    gummy.start()
+
+    while True:
+        try:
+            # 音声ストリームデータを読み込む
+            chunk = stream.read_chunk()
+            chunk_mono = mergeChunkChannels(chunk, stream.CHANNELS)
+            try:
+                # モデルを使って翻訳を行う
+                gummy.send_audio_frame(chunk_mono)
+            except InvalidParameter:
+                gummy.start()
+                gummy.send_audio_frame(chunk_mono)
+        except KeyboardInterrupt:
+            stream.closeStream()
+            gummy.stop()
+            break
+```

 ### データの伝送

-現在の音声ストリームのテキストを取得したら、それをメインプログラムに伝送する必要があります。キャプションエンジンプロセスは標準出力を通じてキャプションデータをElectronのメインプロセスに伝送します。
+現在の音声ストリームのテキストを得たら、それをメインプログラムに渡す必要があります。字幕エンジンプロセスは標準出力を通じて電子メール主プロセスに字幕データを渡します。

-伝送する内容はJSON文字列でなければならず、JSONオブジェクトには以下のパラメータを含める必要があります：
+渡す内容はJSON文字列でなければなりません。JSONオブジェクトには以下のパラメータを含める必要があります：

 ```typescript
 export interface CaptionItem {
-  index: number, // キャプション番号
-  time_s: string, // 現在のキャプションの開始時間
-  time_t: string, // 現在のキャプションの終了時間
-  text: string, // キャプションの内容
-  translation: string // キャプションの翻訳
+  index: number, // 字幕番号
+  time_s: string, // 現在の字幕開始時間
+  time_t: string, // 現在の字幕終了時間
+  text: string, // 字幕内容
+  translation: string // 字幕翻訳
 }
 ```

-**注意：キャプションJSONデータを出力するたびに必ずバッファをフラッシュし、Electronのメインプロセスが受け取る文字列が常にJSONオブジェクトとして解釈できるようにする必要があります。**
+**必ず、字幕JSONデータを出力するたびにバッファをフラッシュし、electron主プロセスが受け取る文字列が常にJSONオブジェクトとして解釈できるようにする必要があります。**

-Pythonを使用する場合、以下のようにデータをメインプログラムに伝送できます：
+Python言語を使用する場合、以下の方法でデータをメインプログラムに渡すことができます：

 ```python
 # caption-engine\main-gummy.py
@@ -75,44 +110,15 @@ sys.stdout.reconfigure(line_buffering=True)
 ...
    def send_to_node(self, data):
        """
-        データをNode.jsプロセスに送信
+        Node.jsプロセスにデータを送信する
        """
        try:
            json_data = json.dumps(data) + '\n'
            sys.stdout.write(json_data)
            sys.stdout.flush()
        except Exception as e:
-            print(f"Node.jsへのデータ送信エラー: {e}", file=sys.stderr)
+            print(f"Error sending data to Node.js: {e}", file=sys.stderr)
 ...
 ```

-データ受信側のコードは以下の通りです：
-
-```typescript
-// src\main\utils\engine.ts
-...
-    this.process.stdout.on('data', (data) => {
-      const lines = data.toString().split('\n');
-      lines.forEach((line: string) => {
-        if (line.trim()) {
-          try {
-            const caption = JSON.parse(line);
-            addCaptionLog(caption);
-          } catch (e) {
-            controlWindow.sendErrorMessage('キャプションエンジンの出力内容がJSONオブジェクトとして解析できません: ' + e)
-            console.error('[ERROR] JSON解析エラー:', e);
-          }
-        }
-      });
-    });
-
-    this.process.stderr.on('data', (data) => {
-      controlWindow.sendErrorMessage('キャプションエンジンエラー: ' + data)
-      console.error(`[ERROR] サブプロセスエラー: ${data}`);
-    });
-...
-```
-
-## 参考コード
-
-本プロジェクトの `caption-engine` フォルダにある `main-gummy.py` ファイルは、デフォルトのキャプションエンジンのエントリポイントコードです。`src\main\utils\engine.ts` はサーバーサイドでキャプションエンジンのデータを取得および処理するためのコードです。必要に応じて、キャプションエンジンの実装詳細と完全な実行プロセスを理解するために読み込むことができます。
+データ受信側のコードは
--- a/docs/engine-manual/zh.md
+++ b/docs/engine-manual/zh.md
@@ -1,5 +1,7 @@
 # 字幕引擎说明文档

+对应版本：v0.3.0
+
 ![](../../assets/media/structure_zh.png)

 ## 字幕引擎介绍
@@ -18,33 +20,66 @@

 获取到的音频流在转文字之前可能需要进行预处理。比如阿里云的 Gummy 模型只能识别单通道的音频流，而收集的音频流一般是双通道的，因此要将双通道音频流转换为单通道。通道数的转换可以使用 NumPy 库中的方法实现。

-你可以直接使用我开发好的音频获取和音频处理模块（路径：`caption-engine/sysaudio`）：
-
-```python
-if sys.platform == 'win32':
-    from sysaudio.win import AudioStream, mergeStreamChannels
-elif sys.platform == 'linux':
-    from sysaudio.linux import AudioStream, mergeStreamChannels
-else:
-    raise NotImplementedError(f"Unsupported platform: {sys.platform}")
-
-# 创建音频流对象实例
-stream = AudioStream(audio_type)
-# 打开音频流
-stream.openStream()
-while True: # 循环读取音频数据
-    # 读取音频数据
-    data = stream.stream.read(stream.CHUNK)
-    # 将双通道音频数据转换为单通道
-    data = mergeStreamChannels(data, stream.CHANNELS)
-    # 调用音频转文字模型
-    # ... ...
-```
+你可以直接使用我开发好的音频获取（`caption-engine/sysaudio`）和音频处理（`caption-engine/audioprcs`）模块。

 ### 音频转文字

 在得到了合适的音频流后，就可以将音频流转换为文字了。一般使用各种模型来实现音频流转文字。可根据需求自行选择模型。

+一个接近完整的字幕引擎实例如下：
+
+```python
+import sys
+import argparse
+
+# 引入系统音频获取勒
+if sys.platform == 'win32':
+    from sysaudio.win import AudioStream
+elif sys.platform == 'darwin':
+    from sysaudio.darwin import AudioStream
+elif sys.platform == 'linux':
+    from sysaudio.linux import AudioStream
+else:
+    raise NotImplementedError(f"Unsupported platform: {sys.platform}")
+
+# 引入音频处理函数
+from audioprcs import mergeChunkChannels
+# 引入音频转文本模块
+from audio2text import InvalidParameter, GummyTranslator
+
+
+def convert_audio_to_text(s_lang, t_lang, audio_type, chunk_rate, api_key):
+    # 设置标准输出为行缓冲
+    sys.stdout.reconfigure(line_buffering=True) # type: ignore
+
+    # 创建音频获取和语音转文字实例
+    stream = AudioStream(audio_type, chunk_rate)
+    if t_lang == 'none':
+        gummy = GummyTranslator(stream.RATE, s_lang, None, api_key)
+    else:
+        gummy = GummyTranslator(stream.RATE, s_lang, t_lang, api_key)
+
+    # 启动实例
+    stream.openStream()
+    gummy.start()
+
+    while True:
+        try:
+            # 读取音频流数据
+            chunk = stream.read_chunk()
+            chunk_mono = mergeChunkChannels(chunk, stream.CHANNELS)
+            try:
+                # 调用模型进行翻译
+                gummy.send_audio_frame(chunk_mono)
+            except InvalidParameter:
+                gummy.start()
+                gummy.send_audio_frame(chunk_mono)
+        except KeyboardInterrupt:
+            stream.closeStream()
+            gummy.stop()
+            break
+```
+
 ### 数据传递

 在获取到当前音频流的文字后，需要将文字传递给主程序。字幕引擎进程通过标准输出将字幕数据传递给 electron 主进程。
--- a/docs/user-manual/en.md
+++ b/docs/user-manual/en.md
@@ -1,12 +1,14 @@
 # Auto Caption User Manual

-Corresponding Version: v0.2.0
+Corresponding Version: v0.3.0

 ## Software Introduction

 Auto Caption is a cross-platform caption display software that can real-time capture system audio input (recording) or output (playback) streaming data and use an audio-to-text model to generate captions for the corresponding audio. The default caption engine provided by the software (using Alibaba Cloud Gummy model) supports recognition and translation in nine languages (Chinese, English, Japanese, Korean, German, French, Russian, Spanish, Italian).

-Currently, the default caption engine only has full functionality on the Windows platform. On the Linux platform, it can only generate captions for audio input (microphone) and does not support generating captions for audio output (playback).
+Currently, the default caption engine of the software only has full functionality on Windows and macOS platforms. Additional configuration is required to capture system audio output on macOS.
+
+On Linux platforms, it can only generate captions for audio input (microphone), and currently does not support generating captions for audio output (playback).

 ![](../../assets/media/main_en.png)

@@ -14,6 +16,8 @@ Currently, the default caption engine only has full functionality on the Windows

 To use the default caption service, you need to obtain an API KEY from Alibaba Cloud.

+Additional configuration is required to capture audio output on macOS platform.
+
 The software is built using Electron, so the software size is inevitably large.

 ## Software Usage
@@ -29,6 +33,22 @@ Alibaba Cloud provides detailed tutorials for this:
 - [Obtain API KEY (Chinese)](https://help.aliyun.com/zh/model-studio/get-api-key)
 - [Configure API Key in Environment Variables (Chinese)](https://help.aliyun.com/zh/model-studio/configure-api-key-through-environment-variables)

+### Capturing System Audio Output on macOS
+
+The caption engine cannot directly capture system audio output on macOS platform and requires additional driver installation. The current caption engine uses [BlackHole](https://github.com/ExistentialAudio/BlackHole). First open Terminal and execute one of the following commands (recommended to choose the first one):
+
+```bash
+brew install blackhole-2ch
+brew install blackhole-16ch
+brew install blackhole-64ch
+```
+
+After installation completes, open `Audio MIDI Setup` (searchable via `cmd + space`). Check if BlackHole appears in the device list - if not, restart your computer.
+
+Once BlackHole is confirmed installed, in the `Audio MIDI Setup` page, click the plus (+) button at bottom left and select "Create Multi-Output Device". Include both BlackHole and your desired audio output destination in the outputs. Finally, set this multi-output device as your default audio output device.
+
+Now the caption engine can capture system audio output and generate captions.
+
 ### Modifying Settings

 Caption settings can be divided into three categories: general settings, caption engine settings, and caption style settings. Note that changes to general settings take effect immediately. For the other two categories, after making changes, you need to click the "Apply" option in the upper right corner of the corresponding settings module for the changes to take effect. If you click "Cancel Changes," the current modifications will not be saved and will revert to the previous state.
--- a/docs/user-manual/ja.md
+++ b/docs/user-manual/ja.md
@@ -1,6 +1,6 @@
 # Auto Caption ユーザーマニュアル

-対応バージョン：v0.2.0
+対応バージョン：v0.3.0

 この文書は大規模モデルを使用して翻訳されていますので、内容に正確でない部分があるかもしれません。

@@ -8,7 +8,9 @@

 Auto Caption は、クロスプラットフォームの字幕表示ソフトウェアで、システムの音声入力（録音）または出力（音声再生）のストリーミングデータをリアルタイムで取得し、音声からテキストに変換するモデルを利用して対応する音声の字幕を生成します。このソフトウェアが提供するデフォルトの字幕エンジン（アリババクラウド Gummy モデルを使用）は、9つの言語（中国語、英語、日本語、韓国語、ドイツ語、フランス語、ロシア語、スペイン語、イタリア語）の認識と翻訳をサポートしています。

-現在、デフォルトの字幕エンジンは Windows プラットフォームでのみ完全な機能を利用できます。Linux プラットフォームでは、音声入力（マイク）からの字幕生成のみがサポートされており、音声出力（音声再生）からの字幕生成はまだサポートされていません。
+現在、ソフトウェアのデフォルト字幕エンジンは Windows と macOS プラットフォームでのみ完全な機能を有しています。macOS でシステムオーディオ出力を取得するには追加の設定が必要です。
+
+Linux プラットフォームでは、オーディオ入力（マイク）からの字幕生成のみ可能で、現在オーディオ出力（再生音）からの字幕生成はサポートしていません。

 ![](../../assets/media/main_ja.png)

@@ -16,11 +18,13 @@ Auto Caption は、クロスプラットフォームの字幕表示ソフトウ

 デフォルトの字幕サービスを使用するには、アリババクラウドの API KEY を取得する必要があります。

+macOS プラットフォームでオーディオ出力を取得するには追加の設定が必要です。
+
 ソフトウェアは Electron で構築されているため、そのサイズは避けられないほど大きいです。

 ## ソフトウェアの使用方法

-### アリババクラウド百炼プラットフォームの API KEY の準備
+### 百炼プラットフォームの API KEY の準備

 ソフトウェアが提供するデフォルトの字幕エンジン（アリババクラウド Gummy）を使用するには、アリババクラウド百炼プラットフォームから API KEY を取得し、ローカル環境変数に設定する必要があります。

@@ -31,6 +35,22 @@ Auto Caption は、クロスプラットフォームの字幕表示ソフトウ
 - [API KEY の取得（中国語）](https://help.aliyun.com/zh/model-studio/get-api-key)
 - [環境変数を通じて API Key を設定する（中国語）](https://help.aliyun.com/zh/model-studio/configure-api-key-through-environment-variables)

+### macOS でのシステムオーディオ出力の取得方法
+
+字幕エンジンは macOS プラットフォームで直接システムオーディオ出力を取得できず、追加のドライバーインストールが必要です。現在の字幕エンジンでは [BlackHole](https://github.com/ExistentialAudio/BlackHole) を使用しています。まずターミナルを開き、以下のいずれかのコマンドを実行してください（最初のオプションを推奨します）：
+
+```bash
+brew install blackhole-2ch
+brew install blackhole-16ch
+brew install blackhole-64ch
+```
+
+インストール完了後、`オーディオMIDI設定`（`cmd + space`で検索可能）を開きます。デバイスリストにBlackHoleが表示されているか確認してください - 表示されていない場合はコンピュータを再起動してください。
+
+BlackHoleのインストールが確認できたら、`オーディオ MIDI 設定`ページで左下のプラス(+)ボタンをクリックし、「マルチ出力デバイスを作成」を選択します。出力に BlackHole と希望するオーディオ出力先の両方を含めてください。最後に、このマルチ出力デバイスをデフォルトのオーディオ出力デバイスに設定します。
+
+これで字幕エンジンがシステムオーディオ出力をキャプチャし、字幕を生成できるようになります。
+
 ### 設定の変更

 字幕の設定は3つのカテゴリーに分かれます：一般的な設定、字幕エンジンの設定、字幕スタイルの設定。注意すべき点として、一般的な設定の変更は即座に適用されます。しかし、他の2つの設定については、変更後に該当する設定モジュール右上の「適用」オプションをクリックすることで初めて変更が有効になります。「変更を取り消す」を選択すると、現在の変更は保存されず、前回の状態に戻ります。
--- a/docs/user-manual/zh.md
+++ b/docs/user-manual/zh.md
@@ -1,12 +1,14 @@
 # Auto Caption 用户手册

-对应版本：v0.2.0
+对应版本：v0.3.0

 ## 软件简介

 Auto Caption 是一个跨平台的字幕显示软件，能够实时获取系统音频输入（录音）或输出（播放声音）的流式数据，并调用音频转文字的模型生成对应音频的字幕。软件提供的默认字幕引擎（使用阿里云 Gummy 模型）支持九种语言（中、英、日、韩、德、法、俄、西、意）的识别与翻译。

-目前软件默认字幕引擎只有在 Windows 平台下才拥有完整功能。在 Linux 平台下只能生成音频输入（麦克风）的字幕，暂不支持音频输出（播放声音）的字幕生成。
+目前软件默认字幕引擎只有在 Windows 和 macOS 平台下才拥有完整功能，在 macOS 要获取系统音频输出需要额外配置。
+
+在 Linux 平台下只能生成音频输入（麦克风）的字幕，暂不支持音频输出（播放声音）的字幕生成。

 ![](../../assets/media/main_zh.png)

@@ -14,13 +16,17 @@ Auto Caption 是一个跨平台的字幕显示软件，能够实时获取系统

 要使用默认字幕服务需要获取阿里云的 API KEY。

+在 macOS 平台获取音频输出需要额外配置。
+
 软件使用 Electron 构建，因此软件体积不可避免的较大。

 ## 软件使用

 ### 准备阿里云百炼平台 API KEY

-要使用软件提供的默认字幕引擎（阿里云 Gummy），需要从阿里云百炼平台获取 API KEY 并在本机环境变量中配置。
+要使用软件提供的默认字幕引擎（阿里云 Gummy），需要从阿里云百炼平台获取 API KEY，然后将 API KEY 添加到软件设置中或者配置到环境变量中（仅 Windows 平台支持读取环境变量中的 API KEY）。
+
+![](../../assets/media/api_zh.png)

 **国际版的阿里云服务并没有提供 Gummy 模型，因此目前非中国用户无法使用默认字幕引擎。我正在开发新的本地字幕引擎，以确保所有用户都有默认字幕引擎可以使用。**

@@ -30,6 +36,22 @@ Auto Caption 是一个跨平台的字幕显示软件，能够实时获取系统

 - [将 API Key 配置到环境变量](https://help.aliyun.com/zh/model-studio/configure-api-key-through-environment-variables)

+### macOS 获取系统音频输出
+
+字幕引擎无法在 macOS 平台直接获取系统的音频输出，需要安装额外的驱动。目前字幕引擎采用的是 [BlackHole](https://github.com/ExistentialAudio/BlackHole)。首先打开终端，执行以下命令中的其中一个（建议选择第一个）：
+
+```bash
+brew install blackhole-2ch
+brew install blackhole-16ch
+brew install blackhole-64ch
+```
+
+安装完成后打开 `音频 MIDI 设置`（`cmd + space` 打开搜索，可以搜索到）。观察设备列表中是否有 BlackHole 设备，如果没有需要重启电脑。
+
+在确定安装好 BlackHole 设备后，在 `音频 MIDI 设置` 页面，点击左下角的加号，选择“创建多输出设备”。在输出中包含 BlackHole 和你想要的音频输出目标。最后将该多输出设备设置为默认音频输出设备。
+
+现在字幕引擎就能捕获系统的音频输出并生成字幕了。
+
 ### 修改设置

 字幕设置可以分为三类：通用设置、字幕引擎设置、字幕样式设置。需要注意的是，修改通用设置是立即生效的。但是对于其他两类设置，修改后需要点击对应设置模块右上角的“应用”选项，更改才会真正生效。如果点击“取消更改”那么当前修改将不会被保存，而是回退到上次修改的状态。
--- a/src/renderer/src/components/CaptionStyle.vue
+++ b/src/renderer/src/components/CaptionStyle.vue
@@ -115,7 +115,7 @@
        backgroundColor: addOpicityToColor(currentBackground, currentOpacity)
      }"
    >
-      <p :class="[captionStyle.lineBreak?'':'left-ellipsis']"
+      <p :class="[currentLineBreak?'':'left-ellipsis']"
        :style="{
          fontFamily: currentFontFamily,
          fontSize: currentFontSize + 'px',
@@ -124,7 +124,7 @@
        <span v-if="captionData.length">{{ captionData[captionData.length-1].text }}</span>
        <span v-else>{{ $t('example.original') }}</span>
      </p>
-      <p :class="[captionStyle.lineBreak?'':'left-ellipsis']"
+      <p :class="[currentLineBreak?'':'left-ellipsis']"
        v-if="currentTransDisplay"
        :style="{
          fontFamily: currentTransFontFamily,