Add WORKERFS support

LostBeard · Sep 12, 2023 · 8d7246c · 8d7246c
1 parent faf13d1
commit 8d7246c
Show file tree

Hide file tree

Showing 7 changed files with 95 additions and 9 deletions.
diff --git a/build/ffmpeg-wasm.sh b/build/ffmpeg-wasm.sh
@@ -39,6 +39,7 @@ CONF_FLAGS=(
   -sEXPORT_NAME="$EXPORT_NAME"             # required in browser env, so that user can access this module from window object
   -sEXPORTED_FUNCTIONS=$(node src/bind/ffmpeg/export.js) # exported functions
   -sEXPORTED_RUNTIME_METHODS=$(node src/bind/ffmpeg/export-runtime.js) # exported built-in functions
+  -lworkerfs.js
   --pre-js src/bind/ffmpeg/bind.js        # extra bindings, contains most of the ffmpeg.wasm javascript code
   # ffmpeg source code
   src/fftools/cmdutils.c 

diff --git a/packages/ffmpeg/src/classes.ts b/packages/ffmpeg/src/classes.ts
@@ -52,6 +52,8 @@ export class FFmpeg {
             this.loaded = true;
             this.#resolves[id](data);
             break;
+          case FFMessageType.MOUNT:
+          case FFMessageType.UNMOUNT:
           case FFMessageType.EXEC:
           case FFMessageType.WRITE_FILE:
           case FFMessageType.READ_FILE:
@@ -171,7 +173,7 @@ export class FFmpeg {
         this.#worker = new Worker(config.workerLoadURL, {
           type: "module",
         });
-      }      
+      }
       this.#registerHandlers();
     }
     return this.#send({
@@ -264,6 +266,39 @@ export class FFmpeg {
     ) as Promise<OK>;
   };
 
+  public mount = (path: string, data: WorkerFSMountData): Promise<OK> => {
+    const trans: Transferable[] = [];
+    // TODO - handle transferables
+    if (data.blobs){
+      for(let blob in data.blobs){
+        trans.push(data.buffer);
+      }
+    }
+    if (data.files){
+      for(let file in data.files){
+
+      }
+    }
+    return this.#send(
+      {
+        type: FFMessageType.MOUNT,
+        data: { path, data },
+      },
+      trans
+    ) as Promise<OK>;
+  };
+
+  public unmount = (path: string): Promise<OK> => {
+    const trans: Transferable[] = [];
+    return this.#send(
+      {
+        type: FFMessageType.UNMOUNT,
+        data: { path },
+      },
+      trans
+    ) as Promise<OK>;
+  };
+
   /**
    * Read data from ffmpeg.wasm.
    *

diff --git a/packages/ffmpeg/src/const.ts b/packages/ffmpeg/src/const.ts
@@ -19,4 +19,8 @@ export enum FFMessageType {
   DOWNLOAD = "DOWNLOAD",
   PROGRESS = "PROGRESS",
   LOG = "LOG",
+
+  MOUNT = "MOUNT",
+  UNMOUNT = "UNMOUNT",
+  FILESYSTEMS = "FILESYSTEMS",
 }
diff --git a/packages/ffmpeg/src/types.ts b/packages/ffmpeg/src/types.ts
@@ -22,12 +22,12 @@ export interface FFMessageLoadConfig {
    * @defaultValue `https://unpkg.com/@ffmpeg/core-mt@${CORE_VERSION}/dist/umd/ffmpeg-core.worker.js`;
    */
   workerURL?: string;
-    /**
-   * `worker.js` URL.
-   *
-   * @defaultValue `new URL('./worker.js')`;
-   */
-    workerLoadURL?: string;
+  /**
+ * `worker.js` URL.
+ *
+ * @defaultValue `new URL('./worker.js')`;
+ */
+  workerLoadURL?: string;
 }
 
 export interface FFMessageExecData {
@@ -70,6 +70,28 @@ export interface FFMessageDeleteDirData {
   path: FFFSPath;
 }
 
+export type WorkerFSFileEntry =
+  | File;
+
+export interface WorkerFSBlobEntry {
+  name: string;
+  data: Blob;
+}
+
+export interface WorkerFSMountData {
+  blobs?: WorkerFSBlobEntry[];
+  files?: WorkerFSFileEntry[];
+}
+
+export interface FFMessageMountData {
+  path: FFFSPath;
+  data: WorkerFSMountData;
+}
+
+export interface FFMessageUnmountData {
+  path: FFFSPath;
+}
+
 export type FFMessageData =
   | FFMessageLoadConfig
   | FFMessageExecData
@@ -79,7 +101,9 @@ export type FFMessageData =
   | FFMessageRenameData
   | FFMessageCreateDirData
   | FFMessageListDirData
-  | FFMessageDeleteDirData;
+  | FFMessageDeleteDirData
+  | FFMessageMountData
+  | FFMessageUnmountData;
 
 export interface Message {
   type: string;
@@ -140,4 +164,4 @@ export interface FFMessageEventCallback {
     type: string;
     data: CallbackData;
   };
-}
+}
diff --git a/packages/ffmpeg/src/worker.ts b/packages/ffmpeg/src/worker.ts
@@ -137,6 +137,16 @@ const deleteDir = ({ path }: FFMessageDeleteDirData): OK => {
   return true;
 };
 
+const mount = ({ path, data }: FFMessageMountData): OK => {
+  ffmpeg.FS.mount(ffmpeg.FS.WORKERFS, data, path);
+  return true;
+};
+
+const unmount = ({ path }: FFMessageUnmountData): OK => {
+  ffmpeg.FS.unmount(path);
+  return true;
+};
+
 self.onmessage = async ({
   data: { id, type, data: _data },
 }: FFMessageEvent): Promise<void> => {
@@ -173,6 +183,12 @@ self.onmessage = async ({
       case FFMessageType.DELETE_DIR:
         data = deleteDir(_data as FFMessageDeleteDirData);
         break;
+      case FFMessageType.MOUNT:
+        data = mount(_data as FFMessageMountData);
+        break;
+      case FFMessageType.UNMOUNT:
+        data = unmount(_data as FFMessageUnmountData);
+        break;
       default:
         throw ERROR_UNKNOWN_MESSAGE_TYPE;
     }

diff --git a/packages/types/types/index.d.ts b/packages/types/types/index.d.ts
@@ -58,6 +58,9 @@ export interface FS {
   isFile: (mode: number) => boolean;
   /** mode is a numeric notation of permission, @see [Numeric Notation](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation) */
   isDir: (mode: number) => boolean;
+  mount: (fileSystemType: number, data: WorkerFSMountConfig, path: string) => void;
+  unmount: (path: string) => void;
+  WORKERFS: number;
 }
 
 /**

diff --git a/src/bind/ffmpeg/export-runtime.js b/src/bind/ffmpeg/export-runtime.js
@@ -1,5 +1,8 @@
 const EXPORTED_RUNTIME_METHODS = [
   "FS",
+  "FS_mount",
+  "FS_unmount",
+  "FS_filesystems",
   "setValue",
   "getValue",
   "UTF8ToString",