@omnimedia/omnitool 1.1.0-96 → 1.1.0-97

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-97",
 	"description": "open source video processing tools",
 	"license": "MIT",
 	"author": "Przemysław Gałęzki",

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"