Add a config allow ffmpeg to use external font from a directory (#34)

.gitignore

@@ -10,4 +10,5 @@ yarn-error.log
 test.json
 start-scheduler.sh
 start-executor.sh
-start-e2ehelper.sh
+start-e2ehelper.sh
+fonts/

config.yml

@@ -57,4 +57,7 @@ jobLogPath: '${project_root}/log/jobs'
 jobExpireTime:
   Canceled: 1
   UnrecoverableError: 7
-  Finished: 2
+  Finished: 2
+
+# fonts directory that can be used by ffmpeg
+fontsDir: ${project_root}/fonts

package.json

@@ -1,6 +1,6 @@
 {
    "name": "mira-video-manager",
-   "version": "1.1.2",
+   "version": "1.2.0",
    "description": "Video Process for mira project",
    "main": "index.js",
    "scripts": {

src/processors/profiles/BaseProfile.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 IROHA LAB
+ * Copyright 2023 IROHA LAB
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,7 @@
 import { ConvertAction } from '../../domains/ConvertAction';
 
 export abstract class BaseProfile {
-    protected constructor(protected action: ConvertAction) {
+    protected constructor(protected action: ConvertAction, protected fontsDir: string) {
     }
 
     /**
@@ -44,7 +44,11 @@ export abstract class BaseProfile {
             cmd = cmd.concat(['-i', this.action.audioFilePath]);
         }
         if (this.action.subtitlePath) {
-            cmd = cmd.concat(['-i', this.action.audioFilePath]);
+            if (this.fontsDir) {
+                cmd = cmd.concat(['-vf', `subtitles='${this.action.subtitlePath}':fontsdir='${this.fontsDir}'`]);
+            } else {
+                cmd = cmd.concat(['-vf', `subtitles='${this.action.subtitlePath}'`]);
+            }
         }
         return cmd;
     }

src/processors/profiles/ContainerOnlyProfile.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 IROHA LAB
+ * Copyright 2023 IROHA LAB
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,8 +20,8 @@ import { ConvertAction } from '../../domains/ConvertAction';
 export class ContainerOnlyProfile extends BaseProfile {
     public static profileName = 'container_only';
 
-    constructor(action: ConvertAction) {
-        super(action);
+    constructor(action: ConvertAction, fontsDir: string) {
+        super(action, fontsDir);
     }
 
     public getCommandArgs(): Promise<string[]> {

src/processors/profiles/DefaultProfile.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 IROHA LAB
+ * Copyright 2023 IROHA LAB
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,27 +18,13 @@ import { BaseProfile } from "./BaseProfile";
 import { ConvertAction } from '../../domains/ConvertAction';
 
 export class DefaultProfile extends BaseProfile {
-    constructor(action: ConvertAction) {
-        super(action);
+    constructor(action: ConvertAction, fontsDir: string) {
+        super(action, fontsDir);
     }
 
     public static profileName = 'default';
 
     public getCommandArgs(): Promise<string[]> {
         return Promise.resolve([...this.getInputCommandArgs(), '-strict', '-2']);
     }
-
-    protected getInputCommandArgs(): string[] {
-        let cmd = [];
-        if (this.action.videoFilePath) {
-            cmd = cmd.concat(['-i', this.action.videoFilePath]);
-        }
-        if (this.action.audioFilePath) {
-            cmd = cmd.concat(['-i', this.action.audioFilePath]);
-        }
-        if (this.action.subtitlePath) {
-            cmd = cmd.concat(['-vf', `subtitles='${this.action.subtitlePath}'`]);
-        }
-        return cmd;
-    }
 }

src/processors/profiles/ProfileFactory.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 IROHA LAB
+ * Copyright 2023 IROHA LAB
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,19 +21,23 @@ import { interfaces } from "inversify";
 import { BaseProfile } from "./BaseProfile";
 import { ContainerOnlyProfile } from './ContainerOnlyProfile';
 import { ConvertAction } from '../../domains/ConvertAction';
+import { ConfigManager } from '../../utils/ConfigManager';
+import { TYPES } from '@irohalab/mira-shared';
 
 export function ProfileFactory(context: interfaces.Context): ProfileFactoryInitiator {
+    const configManager = context.container.get<ConfigManager>(TYPES.ConfigManager);
+    const fontsDir = configManager.fontsDir();
     return (profileName: string, action: ConvertAction, profileExtraData?: any) => {
         switch (profileName) {
             case SoundOnlyProfile.profileName:
-                return new SoundOnlyProfile(action, profileExtraData.data);
+                return new SoundOnlyProfile(action, profileExtraData.data, fontsDir);
             case VideoOnlyProfile.profileName:
-                return new VideoOnlyProfile(action);
+                return new VideoOnlyProfile(action, fontsDir);
             case ContainerOnlyProfile.profileName:
-                return new ContainerOnlyProfile(action);
+                return new ContainerOnlyProfile(action, fontsDir);
             case DefaultProfile.profileName:
             default:
-                return new DefaultProfile(action);
+                return new DefaultProfile(action, fontsDir);
         }
     };
 }

src/processors/profiles/SoundOnlyProfile.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 IROHA LAB
+ * Copyright 2023 IROHA LAB
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -31,8 +31,8 @@ const DEFAULT_BIT_RATE_PER_CHANNEL = 64; // kbit/s
 export class SoundOnlyProfile extends BaseProfile {
     public static profileName = 'sound_only'
 
-    constructor(action: ConvertAction, private _preferredTrack: string) {
-        super(action);
+    constructor(action: ConvertAction, private _preferredTrack: string, fontsDir: string) {
+        super(action, fontsDir);
     }
 
     private static isPropertyEqual(prop1: any, prop2: string): boolean {

src/processors/profiles/VideoOnlyProfile.ts

@@ -18,8 +18,8 @@ import { ConvertAction } from '../../domains/ConvertAction';
 import { DefaultProfile } from './DefaultProfile';
 
 export class VideoOnlyProfile extends DefaultProfile {
-    constructor(action: ConvertAction) {
-        super(action);
+    constructor(action: ConvertAction, fontsDir: string) {
+        super(action, fontsDir);
     }
 
     public static profileName = 'video_only'

src/test-helpers/FakeConfigManager.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 IROHA LAB
+ * Copyright 2023 IROHA LAB
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -111,4 +111,8 @@ export class FakeConfigManager implements ConfigManager {
     public getJobExpireTime(): { Canceled: number; UnrecoverableError: number; Finished: number } {
         return {Canceled: 1, Finished: 1, UnrecoverableError: 1};
     }
+
+    public fontsDir(): string {
+        return '';
+    }
 }

src/utils/ConfigManager.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 IROHA LAB
+ * Copyright 2023 IROHA LAB
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -65,4 +65,9 @@ export interface ConfigManager extends BaseConfigManager {
      * Unit is days
      */
     getJobExpireTime(): {Canceled: number, UnrecoverableError: number, Finished: number};
+
+    /**
+     * Get fonts directory
+     */
+    fontsDir(): string;
 }

src/utils/ConfigManagerImpl.ts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2022 IROHA LAB
+ * Copyright 2023 IROHA LAB
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -57,6 +57,7 @@ type AppConfg = {
     };
     jobLogPath: string;
     jobExpireTime: {Canceled: number, UnrecoverableError: number, Finished: number};
+    fontsDir: string;
 };
 
 const CWD_PATTERN = /\${cwd}/;
@@ -239,4 +240,12 @@ export class ConfigManagerImpl implements ConfigManager {
             return {Canceled: 1, UnrecoverableError: 5, Finished: 3};
         }
     }
+
+    public fontsDir(): string {
+        const fontsDirStr = this._config.fontsDir;
+        if (fontsDirStr) {
+            return ConfigManagerImpl.processPath(fontsDirStr);
+        }
+        return null;
+    }
 }