capacitor-native-video-compressor 2.0.0 → 2.1.0

package/dist/esm/opfs-output.js

@@ -0,0 +1,94 @@
+/**
+ * WebCodecs output goes to the origin private file system so a long video
+ * never sits whole in memory. The File handed back stays readable only while
+ * its OPFS entry exists, and callers keep it well past `compressVideo` (until
+ * the upload is done, or longer for a retry), so a successful output stays
+ * until the caller releases it with `finishUpload({ jobId })` or the tab
+ * closes. Each tab writes under its own directory and holds a Web Lock named
+ * after it for its whole life; every compress removes the directories whose
+ * lock nobody holds any more, i.e. those of closed tabs. A failed or cancelled
+ * job deletes its own file straight away.
+ */
+const OPFS_ROOT = 'native-video-compressor';
+const lockName = (tabId) => `${OPFS_ROOT}:${tabId}`;
+let tabId = null;
+const getTabId = () => (tabId !== null && tabId !== void 0 ? tabId : (tabId = crypto.randomUUID()));
+let fileCount = 0;
+// Memoised apart from the directories: they are reopened after site data is
+// cleared, but this tab still holds its lock, and requesting it again would
+// wait forever on ourselves.
+let tabLock = null;
+let tabDirsPromise = null;
+// A rejected request (e.g. a sandboxed iframe) rejects here, so openTabDirs
+// fails and the caller buffers in memory instead of waiting forever.
+const holdTabLock = () => new Promise((granted, rejected) => {
+    navigator.locks
+        .request(lockName(getTabId()), () => {
+        granted();
+        return new Promise(() => undefined);
+    })
+        .catch(rejected);
+});
+const sweepClosedTabs = async (base) => {
+    // Names first, locks second: a tab that creates its directory between the two
+    // reads already holds its lock, so it is never mistaken for a closed one.
+    const names = [];
+    for await (const name of base.keys())
+        names.push(name);
+    const { held = [] } = await navigator.locks.query();
+    const live = new Set(held.map((l) => l.name));
+    for (const name of names) {
+        if (!live.has(lockName(name)))
+            await base.removeEntry(name, { recursive: true }).catch(() => undefined);
+    }
+};
+const openTabDirs = async () => {
+    const base = await (await navigator.storage.getDirectory()).getDirectoryHandle(OPFS_ROOT, { create: true });
+    if (navigator.locks) {
+        await (tabLock !== null && tabLock !== void 0 ? tabLock : (tabLock = holdTabLock().catch((e) => {
+            tabLock = null;
+            throw e;
+        })));
+    }
+    return { base, dir: await base.getDirectoryHandle(getTabId(), { create: true }) };
+};
+/** Null when OPFS or `createWritable` (missing on Safari's main thread) isn't there. */
+export const createOpfsOutput = async () => {
+    var _a;
+    try {
+        if (typeof navigator === 'undefined' || !((_a = navigator.storage) === null || _a === void 0 ? void 0 : _a.getDirectory))
+            return null;
+        const { base, dir } = await (tabDirsPromise !== null && tabDirsPromise !== void 0 ? tabDirsPromise : (tabDirsPromise = openTabDirs().catch((e) => {
+            tabDirsPromise = null;
+            throw e;
+        })));
+        // Without Web Locks another tab's live files can't be told apart: no sweep.
+        if (navigator.locks)
+            await sweepClosedTabs(base).catch(() => undefined);
+        const name = `${++fileCount}.mp4`;
+        const handle = await dir.getFileHandle(name, { create: true }).catch((e) => {
+            // The directory was removed under us (site data cleared): reopen it next time.
+            if ((e === null || e === void 0 ? void 0 : e.name) === 'NotFoundError')
+                tabDirsPromise = null;
+            throw e;
+        });
+        if (typeof handle.createWritable !== 'function') {
+            await dir.removeEntry(name).catch(() => undefined);
+            return null;
+        }
+        const writable = await handle.createWritable();
+        const discard = async () => {
+            // Rejects harmlessly once mediabunny holds the writer; it closes it then.
+            await writable.abort().catch(() => undefined);
+            await dir.removeEntry(name).catch(() => undefined);
+        };
+        // OPFS files carry no MIME type, and callers derive the extension from it.
+        const read = async () => (await handle.getFile()).slice(0, undefined, 'video/mp4');
+        return { writable, read, discard };
+    }
+    catch (e) {
+        console.warn('[compress] OPFS unavailable, buffering output in memory:', e);
+        return null;
+    }
+};
+//# sourceMappingURL=opfs-output.js.map

package/dist/esm/opfs-output.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"opfs-output.js","sourceRoot":"","sources":["../../src/opfs-output.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,MAAM,SAAS,GAAG,yBAAyB,CAAC;AAC5C,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,GAAG,SAAS,IAAI,KAAK,EAAE,CAAC;AAE5D,IAAI,KAAK,GAAkB,IAAI,CAAC;AAChC,MAAM,QAAQ,GAAG,GAAG,EAAE,CAAC,CAAC,KAAK,aAAL,KAAK,cAAL,KAAK,IAAL,KAAK,GAAK,MAAM,CAAC,UAAU,EAAE,EAAC,CAAC;AACvD,IAAI,SAAS,GAAG,CAAC,CAAC;AAElB,4EAA4E;AAC5E,4EAA4E;AAC5E,6BAA6B;AAC7B,IAAI,OAAO,GAAyB,IAAI,CAAC;AACzC,IAAI,cAAc,GAAwF,IAAI,CAAC;AAE/G,4EAA4E;AAC5E,qEAAqE;AACrE,MAAM,WAAW,GAAG,GAAG,EAAE,CACvB,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE;IACtC,SAAS,CAAC,KAAK;SACZ,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,EAAE,GAAG,EAAE;QAClC,OAAO,EAAE,CAAC;QACV,OAAO,IAAI,OAAO,CAAQ,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC7C,CAAC,CAAC;SACD,KAAK,CAAC,QAAQ,CAAC,CAAC;AACrB,CAAC,CAAC,CAAC;AAEL,MAAM,eAAe,GAAG,KAAK,EAAE,IAA+B,EAAE,EAAE;IAChE,8EAA8E;IAC9E,0EAA0E;IAC1E,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE;QAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvD,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACpD,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAAE,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IAC1G,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,KAAK,IAAI,EAAE;IAC7B,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,SAAS,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,kBAAkB,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5G,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;QACpB,MAAM,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,IAAP,OAAO,GAAK,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YAC3C,OAAO,GAAG,IAAI,CAAC;YACf,MAAM,CAAC,CAAC;QACV,CAAC,CAAC,EAAC,CAAC;IACN,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,IAAI,CAAC,kBAAkB,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;AACpF,CAAC,CAAC;AAQF,wFAAwF;AACxF,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,IAAgC,EAAE;;IACrE,IAAI,CAAC;QACH,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,CAAC,CAAA,MAAA,SAAS,CAAC,OAAO,0CAAE,YAAY,CAAA;YAAE,OAAO,IAAI,CAAC;QACtF,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,CAAC,cAAc,aAAd,cAAc,cAAd,cAAc,IAAd,cAAc,GAAK,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACxE,cAAc,GAAG,IAAI,CAAC;YACtB,MAAM,CAAC,CAAC;QACV,CAAC,CAAC,EAAC,CAAC;QACJ,4EAA4E;QAC5E,IAAI,SAAS,CAAC,KAAK;YAAE,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACxE,MAAM,IAAI,GAAG,GAAG,EAAE,SAAS,MAAM,CAAC;QAClC,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACzE,+EAA+E;YAC/E,IAAI,CAAA,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,IAAI,MAAK,eAAe;gBAAE,cAAc,GAAG,IAAI,CAAC;YACvD,MAAM,CAAC,CAAC;QACV,CAAC,CAAC,CAAC;QACH,IAAI,OAAO,MAAM,CAAC,cAAc,KAAK,UAAU,EAAE,CAAC;YAChD,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YACnD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,cAAc,EAAE,CAAC;QAC/C,MAAM,OAAO,GAAG,KAAK,IAAI,EAAE;YACzB,0EAA0E;YAC1E,MAAM,QAAQ,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAC9C,MAAM,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACrD,CAAC,CAAC;QACF,2EAA2E;QAC3E,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;QACnF,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IACrC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,IAAI,CAAC,0DAA0D,EAAE,CAAC,CAAC,CAAC;QAC5E,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC,CAAC","sourcesContent":["/**\n * WebCodecs output goes to the origin private file system so a long video\n * never sits whole in memory. The File handed back stays readable only while\n * its OPFS entry exists, and callers keep it well past `compressVideo` (until\n * the upload is done, or longer for a retry), so a successful output stays\n * until the caller releases it with `finishUpload({ jobId })` or the tab\n * closes. Each tab writes under its own directory and holds a Web Lock named\n * after it for its whole life; every compress removes the directories whose\n * lock nobody holds any more, i.e. those of closed tabs. A failed or cancelled\n * job deletes its own file straight away.\n */\nconst OPFS_ROOT = 'native-video-compressor';\nconst lockName = (tabId: string) => `${OPFS_ROOT}:${tabId}`;\n\nlet tabId: string | null = null;\nconst getTabId = () => (tabId ??= crypto.randomUUID());\nlet fileCount = 0;\n\n// Memoised apart from the directories: they are reopened after site data is\n// cleared, but this tab still holds its lock, and requesting it again would\n// wait forever on ourselves.\nlet tabLock: Promise<void> | null = null;\nlet tabDirsPromise: Promise<{ base: FileSystemDirectoryHandle; dir: FileSystemDirectoryHandle }> | null = null;\n\n// A rejected request (e.g. a sandboxed iframe) rejects here, so openTabDirs\n// fails and the caller buffers in memory instead of waiting forever.\nconst holdTabLock = () =>\n  new Promise<void>((granted, rejected) => {\n    navigator.locks\n      .request(lockName(getTabId()), () => {\n        granted();\n        return new Promise<never>(() => undefined);\n      })\n      .catch(rejected);\n  });\n\nconst sweepClosedTabs = async (base: FileSystemDirectoryHandle) => {\n  // Names first, locks second: a tab that creates its directory between the two\n  // reads already holds its lock, so it is never mistaken for a closed one.\n  const names: string[] = [];\n  for await (const name of base.keys()) names.push(name);\n  const { held = [] } = await navigator.locks.query();\n  const live = new Set(held.map((l) => l.name));\n  for (const name of names) {\n    if (!live.has(lockName(name))) await base.removeEntry(name, { recursive: true }).catch(() => undefined);\n  }\n};\n\nconst openTabDirs = async () => {\n  const base = await (await navigator.storage.getDirectory()).getDirectoryHandle(OPFS_ROOT, { create: true });\n  if (navigator.locks) {\n    await (tabLock ??= holdTabLock().catch((e) => {\n      tabLock = null;\n      throw e;\n    }));\n  }\n  return { base, dir: await base.getDirectoryHandle(getTabId(), { create: true }) };\n};\n\nexport interface OpfsOutput {\n  writable: FileSystemWritableFileStream;\n  read: () => Promise<Blob>;\n  discard: () => Promise<void>;\n}\n\n/** Null when OPFS or `createWritable` (missing on Safari's main thread) isn't there. */\nexport const createOpfsOutput = async (): Promise<OpfsOutput | null> => {\n  try {\n    if (typeof navigator === 'undefined' || !navigator.storage?.getDirectory) return null;\n    const { base, dir } = await (tabDirsPromise ??= openTabDirs().catch((e) => {\n      tabDirsPromise = null;\n      throw e;\n    }));\n    // Without Web Locks another tab's live files can't be told apart: no sweep.\n    if (navigator.locks) await sweepClosedTabs(base).catch(() => undefined);\n    const name = `${++fileCount}.mp4`;\n    const handle = await dir.getFileHandle(name, { create: true }).catch((e) => {\n      // The directory was removed under us (site data cleared): reopen it next time.\n      if (e?.name === 'NotFoundError') tabDirsPromise = null;\n      throw e;\n    });\n    if (typeof handle.createWritable !== 'function') {\n      await dir.removeEntry(name).catch(() => undefined);\n      return null;\n    }\n    const writable = await handle.createWritable();\n    const discard = async () => {\n      // Rejects harmlessly once mediabunny holds the writer; it closes it then.\n      await writable.abort().catch(() => undefined);\n      await dir.removeEntry(name).catch(() => undefined);\n    };\n    // OPFS files carry no MIME type, and callers derive the extension from it.\n    const read = async () => (await handle.getFile()).slice(0, undefined, 'video/mp4');\n    return { writable, read, discard };\n  } catch (e) {\n    console.warn('[compress] OPFS unavailable, buffering output in memory:', e);\n    return null;\n  }\n};\n"]}

package/dist/esm/web.d.ts

@@ -1,18 +1,30 @@
 import { WebPlugin } from '@capacitor/core';
 import type { NativeVideoCompressorPlugin, CompressOptions, CompressResult, CancelOptions, CancelResult } from './definitions';
+export declare const webCodecsSize: (displayWidth: number, displayHeight: number, shortSide: number) => {
+    width: number;
+} | {
+    height: number;
+};
+export declare const ffmpegScaleFilter: (shortSide: number) => string;
+export declare const capBitrate: (target: number, sourceBitrate: number | undefined, floor: number, headroom?: number) => number;
+export declare const codecHeadroom: (codec: string | null | undefined) => number;
 export declare class NativeVideoCompressorWeb extends WebPlugin implements NativeVideoCompressorPlugin {
     private ffmpeg;
     private isLoaded;
     /** The mediabunny conversion running now, so `cancel()` can abort it. */
     private activeConversion;
-    /** The job `compressVideo` is running right now, for `cancel({ jobId })`. */
-    private currentJobId;
+    /** The job `compressVideo` is running right now; a fresh object per call, so two calls never look alike. */
+    private currentJob;
     private cancelRequested;
+    /** Kept OPFS outputs by jobId, deleted by `finishUpload`. */
+    private keptOutputs;
     initialize(): Promise<{
         success: boolean;
         message?: string;
     }>;
-    finishUpload(): Promise<{
+    finishUpload({ jobId }: {
+        jobId: string;
+    }): Promise<{
         released: boolean;
     }>;
     compressVideo(options: CompressOptions): Promise<CompressResult>;
@@ -21,16 +33,19 @@ export declare class NativeVideoCompressorWeb extends WebPlugin implements Nativ
      * so acting on both is safe.
      *
      * WebCodecs: `conversion.cancel()` makes the in-flight `execute()` reject
-     * with `ConversionCanceledError`, surfaced as a `CancelledError` below.
+     * with `ConversionCanceledError`, surfaced as a CANCELLED `CompressError` below.
      * ffmpeg: `exec()` runs synchronously inside the worker and never reaches a
      * message poll while encoding, so `worker.terminate()` is the only way to
      * stop it — its cost is the loaded core, which is why the core URLs are
      * cached above.
      */
     cancel(options?: CancelOptions): Promise<CancelResult>;
+    private stopEngines;
     private fetchSourceBlob;
     private canUseWebCodecs;
     private compressWithWebCodecs;
+    /** False when mediabunny can't convert this input. */
+    private runConversion;
     private loadFFmpeg;
     private compressWithFfmpeg;
 }