@evio/ffai 1.0.6 → 1.0.7

package/README.md

@@ -92,6 +92,7 @@ ffai build task.json
 | `narration` | `string` | ✅ | 字幕文件路径，使用自定义时间格式 |
 | `videoTranscodeable` | `boolean` | ❌ | 是否对视频进行转码，默认 `false`。启用后会将所有视频统一转码为 H.264/AAC 格式 |
 | `videoPackMode` | `'random' \| 'all'` | ❌ | 视频打包模式，默认 `'all'`<br>- `random`: 根据音频时长随机选择视频片段<br>- `all`: 使用所有视频文件 |
+| `fontFile` | `string` | ❌ | 自定义字幕字体文件路径。如果不指定，macOS 默认使用宋体，其他系统需要提供字体路径 |
 
 ### 字幕文件格式
 
@@ -115,7 +116,12 @@ ffai build task.json
 - 字体颜色：白色
 - 文字效果：黑色描边 + 阴影，确保在任何背景下清晰可见
 - 位置：视频底部居中（距底部 300px）
-- 字体：macOS 使用宋体，其他系统需在 `src/task.ts` 中修改 `fontfile` 变量
+- 字体：可通过 `fontFile` 参数自定义，如果不指定则使用系统默认字体
+
+**跨平台字体路径参考：**
+- **macOS**: `/System/Library/Fonts/Supplemental/Songti.ttc`（宋体）
+- **Windows**: `C:/Windows/Fonts/simhei.ttf`（黑体）或 `C:/Windows/Fonts/msyh.ttc`（微软雅黑）
+- **Linux**: `/usr/share/fonts/truetype/wqy/wqy-zenhei.ttc`（文泉驿正黑）
 
 ## 🔄 工作流程
 
@@ -178,12 +184,13 @@ task-0/
 - 从 `clips/` 目录随机选择视频片段，直到总时长匹配音频
 - 转码所有视频为统一格式（H.264/AAC）
 - 添加字幕并输出到 `task-0/video.mp4`
+- 使用系统默认字体
 
 **适用场景：** 制作短视频、Vlog、产品宣传片等需要随机素材组合的场景
 
 ---
 
-### 示例 2：使用所有视频 + Glob 模式
+### 示例 2：使用所有视频 + 自定义字体
 
 ```json
 [
@@ -191,7 +198,8 @@ task-0/
     "audios": "audio/*.mp3",
     "videos": ["intro.mp4", "content.mp4", "outro.mp4"],
     "narration": "subtitle.txt",
-    "videoPackMode": "all"
+    "videoPackMode": "all",
+    "fontFile": "/path/to/your/font.ttf"
   }
 ]
 ```
@@ -200,6 +208,7 @@ task-0/
 - 混合 `audio/` 目录下的所有 MP3 文件
 - 按顺序拼接三个视频文件（片头 + 内容 + 片尾）
 - 不进行视频转码（使用原始格式，需确保格式一致）
+- 使用自定义字体文件渲染字幕
 - 添加字幕并输出到 `task-0/video.mp4`
 
 **适用场景：** 固定结构的视频制作，如教程视频、演讲录制等
@@ -220,7 +229,8 @@ task-0/
     "audios": "task2/audio.mp3",
     "videos": "task2/videos/*.mp4",
     "narration": "task2/subtitle.txt",
-    "videoPackMode": "all"
+    "videoPackMode": "all",
+    "fontFile": "C:/Windows/Fonts/msyh.ttc"
   },
   {
     "audios": ["task3/bgm1.mp3", "task3/bgm2.mp3"],
@@ -235,6 +245,7 @@ task-0/
 **这个配置会：**
 - 依次处理三个独立任务
 - 每个任务输出到对应的 `task-0/`、`task-1/`、`task-2/` 目录
+- 第二个任务使用 Windows 微软雅黑字体
 - 支持不同的配置组合
 
 **适用场景：** 批量生产系列视频、多语言版本视频等
@@ -264,6 +275,30 @@ task-0/
 
 **适用场景：** 旅游 Vlog、纪录片、风景视频等需要旁白 + 背景音乐的场景
 
+---
+
+### 示例 5：跨平台字体配置
+
+```json
+[
+  {
+    "audios": "audio.mp3",
+    "videos": "videos/*.mp4",
+    "narration": "subtitle.txt",
+    "fontFile": "/usr/share/fonts/truetype/wqy/wqy-zenhei.ttc"
+  }
+]
+```
+
+**这个配置会：**
+- 在 Linux 系统上使用文泉驿正黑字体
+- 确保中文字幕正确显示
+
+**跨平台字体路径：**
+- macOS: `/System/Library/Fonts/Supplemental/Songti.ttc`
+- Windows: `C:/Windows/Fonts/simhei.ttf` 或 `C:/Windows/Fonts/msyh.ttc`
+- Linux: `/usr/share/fonts/truetype/wqy/wqy-zenhei.ttc`（需先安装：`sudo apt install fonts-wqy-zenhei`）
+
 ## 🛠️ 开发
 
 ```bash
@@ -442,7 +477,10 @@ if (!available) {
 ## ⚠️ 注意事项
 
 1. **FFmpeg 必须安装** - 工具依赖 FFmpeg，请确保已正确安装并配置到环境变量
-2. **字幕字体路径** - macOS 默认使用宋体（`/System/Library/Fonts/Supplemental/Songti.ttc`），其他系统需要在 `src/task.ts` 中修改 `fontfile` 变量
+2. **字幕字体配置** - 可通过 `fontFile` 参数自定义字体路径，支持跨平台配置：
+   - macOS: `/System/Library/Fonts/Supplemental/Songti.ttc`
+   - Windows: `C:/Windows/Fonts/simhei.ttf` 或 `C:/Windows/Fonts/msyh.ttc`
+   - Linux: `/usr/share/fonts/truetype/wqy/wqy-zenhei.ttc`
 3. **视频格式统一** - 强烈建议启用 `videoTranscodeable` 以确保所有视频格式统一，避免拼接时出现黑屏、卡顿或音画不同步
 4. **文件路径规则** - 所有路径都相对于执行命令的当前目录（`process.cwd()`）
 5. **临时文件清理** - 处理完成后会自动清理中间过程文件（`video_concat.mp4`、`video_concat_audio.mp4`、`videofiles.txt`），仅保留最终成品
@@ -486,12 +524,18 @@ if (!available) {
    - 字幕文本不要过长，建议每行不超过 20 个汉字
    - 预留字幕间隔时间，避免连续出现
 
-5. **性能优化**
+5. **字体文件配置**
+   - 在配置文件中使用 `fontFile` 参数指定字体路径
+   - 确保字体文件存在且可读
+   - 使用支持中文的字体文件
+   - 不同操作系统使用对应的字体路径
+
+6. **性能优化**
    - 如果不需要转码，关闭 `videoTranscodeable` 可以大幅提升速度
    - 批量任务建议分批处理，避免一次处理过多任务
    - 使用 SSD 硬盘可以显著提升处理速度
 
-6. **质量控制**
+7. **质量控制**
    - 处理完成后检查输出视频的音画同步
    - 验证字幕显示时间和内容是否正确
    - 检查音频混音效果，确保旁白清晰可听
@@ -516,10 +560,11 @@ A: FFmpeg 的 `amix` 滤镜会自动调整音量。如需手动控制，可以
 
 **Q: 字幕字体显示异常或乱码**  
 A: 
-- macOS 默认使用宋体，路径为 `/System/Library/Fonts/Supplemental/Songti.ttc`
-- Windows 可以使用 `C:/Windows/Fonts/simhei.ttf`（黑体）
-- Linux 需要安装中文字体，如 `sudo apt install fonts-wqy-zenhei`
-- 修改 `src/task.ts` 中的 `fontfile` 变量指向正确的字体文件
+- 使用 `fontFile` 参数指定正确的字体文件路径
+- macOS 可以使用 `/System/Library/Fonts/Supplemental/Songti.ttc`（宋体）
+- Windows 可以使用 `C:/Windows/Fonts/simhei.ttf`（黑体）或 `C:/Windows/Fonts/msyh.ttc`（微软雅黑）
+- Linux 需要安装中文字体，如 `sudo apt install fonts-wqy-zenhei`，然后使用 `/usr/share/fonts/truetype/wqy/wqy-zenhei.ttc`
+- 确保字体文件支持中文字符
 
 **Q: 任务配置文件必须是 .json 后缀吗？**  
 A: 是的，工具会检查文件扩展名，必须使用 `.json` 后缀。

package/dist/interface.d.ts

@@ -4,4 +4,5 @@ export interface TaskProps {
     narration: string;
     videoTranscodeable?: boolean;
     videoPackMode?: 'random' | 'all';
+    fontFile?: string;
 }

package/dist/task.js

@@ -6,7 +6,6 @@ const glob_1 = require("glob");
 const node_fs_1 = require("node:fs");
 const signale_1 = require("signale");
 const lib_1 = require("./lib");
-const fontfile = '/System/Library/Fonts/Supplemental/Songti.ttc';
 async function RunTask(props, index, total) {
     const cmd = new signale_1.Signale({
         interactive: true,
@@ -46,7 +45,7 @@ async function RunTask(props, index, total) {
     cmd.await(`[%d/7] - 正在添加背景音频...`, 5);
     await (0, lib_1.addBackgroundAudio)(output_concat, output_concat_audio, audioData.file);
     cmd.await(`[%d/7] - 正在添加旁白...`, 6);
-    await (0, lib_1.addSubTitles)(output_concat_audio, output_concat_audio_subtitle, narrationFile, fontfile);
+    await (0, lib_1.addSubTitles)(output_concat_audio, output_concat_audio_subtitle, narrationFile, props.fontFile);
     // 清理
     (0, node_fs_1.unlinkSync)((0, node_path_1.resolve)(videoTmpDir, 'videofiles.txt'));
     (0, node_fs_1.rmdirSync)(videoTmpDir);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evio/ffai",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "一个基于 FFmpeg 的命令行工具，用于批量处理视频和音频文件，支持视频转码、音频合并、字幕添加等功能。",
   "main": "dist/lib.js",
   "scripts": {
@@ -30,7 +30,6 @@
     "@types/fs-extra": "^11.0.4",
     "@types/node": "^22.0.0",
     "@types/signale": "^1.4.7",
-    "dayjs": "1.11.19",
     "fix-esm-import-path": "^1.10.1",
     "glob": "^13.0.0",
     "ts-node": "^10.9.2",