Merge pull request #334 from SPACEX-2022/origin_master

feat: Add a transparent background configuration item
tnfe · Mar 29, 2023 · c21bc6a · c21bc6a
2 parents 3a75e43 + 24b29dd
commit c21bc6a
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 5 deletions.
diff --git a/docs/en/guide/config.md b/docs/en/guide/config.md
@@ -8,6 +8,7 @@
 | fps | None | number (default 30) | Video frame rate |
 | outputDir | dir | string | Video output path |
 | cacheDir | None | string | Cache directory |
+| transparent | None | boolean (default false) | Whether to enable transparent background (used to generate transparent channel video) |
 | output | out | string | Output file name (not required, no need to fill in in FFCenter mode) |
 | parallel | frames | number (default 5) | parallel rendering |
 | highWaterMark | size | string (default 1mb) | node.js [highWaterMark](http://nodejs.cn/api/stream/buffering.html) |

diff --git a/docs/guide/config.md b/docs/guide/config.md
@@ -8,6 +8,7 @@
 | fps          | rfps                  |  number (默认30)         | 视频帧频    |
 | outputDir      | dir                 | string            | 视频输出路径          |
 | cacheDir          | 无              |     string    | 缓存目录                        |
+| transparent          | 无              |     boolean (默认false)    | 是否启用透明背景（用于生成透明通道视频） |
 | output          | out           | string       | 输出文件名(非必须, 在FFCenter模式下不需要填写)                     |
 | parallel          | frames    | number （默认5）      | 并行渲染                     |
 | highWaterMark          | size     | string (默认1mb)               | node.js [highWaterMark](http://nodejs.cn/api/stream/buffering.html)                          |

diff --git a/lib/conf/conf.js b/lib/conf/conf.js
@@ -29,6 +29,7 @@ class Conf {
     this.copyByDefaultVal(conf, 'antialias', false);
     this.copyByDefaultVal(conf, 'audioLoop', true);
     this.copyByDefaultVal(conf, 'ffmpeglog', false);
+    this.copyByDefaultVal(conf, 'transparent', false);
     this.copyByDefaultVal(conf, 'ext', 'mp4');
     this.copyByDefaultVal(conf, 'preset', 'medium');
     this.copyByDefaultVal(conf, 'cacheFormat', 'raw');

diff --git a/lib/creator.js b/lib/creator.js
@@ -53,21 +53,29 @@ class FFCreator extends FFCon {
     this.resetSize();
     const width = this.getConf('width');
     const height = this.getConf('height');
+    const transparent = this.getConf('transparent');
     const render = this.getConf('render');
     const clarity = this.getConf('clarity');
     const antialias = this.getConf('antialias');
     const useGL = render !== 'canvas';
     const key = `${this.type}_${render}`;
     settings.PRECISION_FRAGMENT = `${clarity}p`;
 
+    const appOptions = {
+      useGL,
+      antialias,
+    };
+    // If set to transparent, override the default background color configuration
+    if (transparent) {
+      appOptions.transparent = true;
+    } else {
+      appOptions.backgroundColor = 0x000000;
+    }
+
     const app = Pool.get(
       key,
       () =>
-        new Application(width, height, {
-          backgroundColor: 0x000000,
-          useGL,
-          antialias,
-        }),
+        new Application(width, height, appOptions),
     );
     app.renderer.resize(width, height);
     this.display = app.stage;