@omnimedia/omnitool 1.1.0-96 → 1.1.0-98

package/README.md

@@ -207,6 +207,42 @@ Caption options:
 
 import `captionPresets` to list available caption looks.
 
+## 🧼 Background Remover
+
+```ts
+import {makeBgRemover, defaultBgRemoverSpec} from "@omnimedia/omnitool"
+
+const bgRemover = await makeBgRemover({
+	spec: defaultBgRemoverSpec(),
+	workerUrl: new URL("/features/bg-remover/worker.bundle.min.js", import.meta.url),
+	onLoading: loading => console.log("loading", loading),
+})
+
+const outputFrame = await bgRemover.remove({frame: inputFrame})
+
+bgRemover.dispose()
+```
+
+Use it on image or while decoding a video:
+
+```ts
+const bgRemover = await makeBgRemover({
+	spec: defaultBgRemoverSpec(),
+	workerUrl: new URL("/features/bg-remover/worker.bundle.min.js", import.meta.url),
+	onLoading: loading => console.log("loading", loading),
+})
+
+const video = driver.decodeVideo({
+	source: file,
+	onFrame: frame => bgRemover.remove({frame}),
+})
+```
+
+Notes:
+- `defaultBgRemoverSpec()` uses `Xenova/modnet` on `webgpu` with `auto` dtype.
+- `model`, `device`, and `dtype` are passed to Transformers.js and depend on browser/runtime support.
+- Call `dispose()` when the remover is no longer needed.
+
 ## 🎛 Filters
 
 Filter application:

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@omnimedia/omnitool",
-	"version": "1.1.0-96",
+	"version": "1.1.0-98",
 	"description": "open source video processing tools",
 	"license": "MIT",
 	"author": "Przemysław Gałęzki",

package/s/features/bg-remover/worker.bundle.ts

@@ -6,6 +6,7 @@ import {BackgroundRemovalPipeline} from "@huggingface/transformers"
 import {PipelineSpec} from "../parts/types.js"
 import {BgRemoverSchematic} from "./types.js"
 import {loadPipe} from "../parts/load-pipe.js"
+import {exposeErrors} from "../parts/expose-errors.js"
 
 const deferred = defer<{spec: PipelineSpec, pipe: BackgroundRemovalPipeline}>()
 const makePrepare = (host: Host<BgRemoverSchematic>) => once(async(spec: PipelineSpec) => {
@@ -25,8 +26,8 @@ const ctx = canvas.getContext("2d")
 await Comrade.worker<BgRemoverSchematic>(shell => {
 	const prepare = makePrepare(shell.host)
 	return {
-		prepare,
-		async remove(request) {
+		prepare: exposeErrors(prepare),
+		remove: exposeErrors(async(request) => {
 			const {pipe} = await deferred.promise
 
 			canvas.width = request.displayWidth
@@ -44,7 +45,7 @@ await Comrade.worker<BgRemoverSchematic>(shell => {
 			request.close()
 			shell.transfer = [frame]
 			return frame
-		}
+		})
 	}
 })
 

package/s/features/parts/expose-errors.ts

@@ -0,0 +1,41 @@
+import {ExposedError} from "@e280/renraku"
+
+export function exposeError(error: unknown) {
+	if (error instanceof ExposedError)
+		return error
+
+	const exposed = new ExposedError(errorToString(error))
+
+	if (error instanceof Error)
+		exposed.stack = error.stack
+
+	return exposed
+}
+
+export function exposeErrors<Args extends unknown[], Result>(
+	fn: (...args: Args) => Result | Promise<Result>
+) {
+	return async(...args: Args) => {
+		try {
+			return await fn(...args)
+		}
+		catch (error) {
+			throw exposeError(error)
+		}
+	}
+}
+
+function errorToString(error: unknown) {
+	if (error instanceof Error)
+		return error.message
+
+	if (typeof error === "string")
+		return error
+
+	try {
+		return JSON.stringify(error) ?? String(error)
+	}
+	catch {
+		return String(error)
+	}
+}

package/s/features/speech/transcribe/worker.bundle.ts

@@ -5,6 +5,7 @@ import {AutomaticSpeechRecognitionPipeline, Pipeline} from "@huggingface/transfo
 
 import {loadPipe} from "../../parts/load-pipe.js"
 import {transcribe} from "./parts/transcribe.js"
+import {exposeErrors} from "../../parts/expose-errors.js"
 import {TranscriberSchematic, TranscriberSpec} from "./types.js"
 
 const deferred = defer<{pipe: Pipeline, spec: TranscriberSpec}>()
@@ -23,8 +24,8 @@ const makePrepare = (host: Host<TranscriberSchematic>) => once(async(spec: Trans
 await Comrade.worker<TranscriberSchematic>(shell => {
 	const prepare = makePrepare(shell.host)
 	return {
-		prepare,
-		async transcribe(request) {
+		prepare: exposeErrors(prepare),
+		transcribe: exposeErrors(async(request) => {
 			const {pipe, spec} = await deferred.promise
 			return transcribe({
 				pipe,
@@ -35,7 +36,7 @@ await Comrade.worker<TranscriberSchematic>(shell => {
 					onTranscription: transcription => shell.host.deliverTranscription(transcription),
 				},
 			})
-		}
+		})
 	}
 })
 

package/s/timeline/index.ts

@@ -12,6 +12,9 @@ export {captionPresets} from "./parts/captions.js"
 export * from "../features/speech/transcribe/default-spec.js"
 export * from "../features/speech/transcribe/transcriber.js"
 export * from "../features/speech/transcribe/types.js"
+export * from "../features/bg-remover/default-spec.js"
+export * from "../features/bg-remover/bg-remover.js"
+export * from "../features/bg-remover/types.js"
 
 export * from "./parts/waveform/waveform.js"
 export * from "./parts/waveform/parts/types.js"