@remotion/effects 4.0.538 → 4.0.540

package/dist/esm/color-key.mjs

@@ -1,110 +1,79 @@
+import {
+  assertOptionalFiniteNumber,
+  validateUnitInterval,
+  parseColorRgba
+} from "./index-wxhvgv2s.mjs";
+import {
+  WEBGPU_SINGLE_PASS_VERTEX,
+  setupWebGpuSinglePass,
+  cleanupWebGpuSinglePass,
+  applyWebGpuSinglePass
+} from "./index-tvfexb7s.mjs";
+import {
+  assertEffectParamsObject,
+  assertOptionalColor
+} from "./index-4fvp93ps.mjs";
+
 // src/color-key.ts
 import { Internals } from "remotion";
 
-// src/validate-effect-param.ts
-var assertEffectParamsObject = (params, effectLabel) => {
-  if (params === null || typeof params !== "object") {
-    throw new TypeError(`${effectLabel} effect requires a parameters object, but got ${JSON.stringify(params)}`);
-  }
-};
-var assertRequiredFiniteNumber = (value, name) => {
-  if (typeof value !== "number" || !Number.isFinite(value)) {
-    throw new TypeError(`"${name}" must be a finite number, but got ${JSON.stringify(value)}`);
-  }
-};
-var assertRequiredColor = (value, name) => {
-  if (typeof value !== "string" || value.length === 0) {
-    throw new TypeError(`"${name}" must be a non-empty string, but got ${JSON.stringify(value)}`);
-  }
-};
-var assertOptionalColor = (value, name) => {
-  if (value === undefined) {
-    return;
-  }
-  assertRequiredColor(value, name);
-};
-var assertOptionalBoolean = (value, name) => {
-  if (value === undefined) {
-    return;
-  }
-  if (typeof value !== "boolean") {
-    throw new TypeError(`"${name}" must be a boolean, but got ${JSON.stringify(value)}`);
-  }
-};
+// src/color-key-webgpu-shader.ts
+var COLOR_KEY_WEBGPU_SHADER = `
+${WEBGPU_SINGLE_PASS_VERTEX}
 
-// src/color-utils.ts
-var DEFAULT_AMOUNT = 1;
-var DEFAULT_BRIGHTNESS_AMOUNT = 0;
-var DEFAULT_HUE_DEGREES = 0;
-var colorAmountSchema = {
-  type: "number",
-  min: 0,
-  max: 1,
-  step: 0.01,
-  default: DEFAULT_AMOUNT,
-  description: "Amount",
-  hiddenFromList: false
-};
-var colorMultiplierSchema = {
-  type: "number",
-  min: 0,
-  step: 0.01,
-  default: DEFAULT_AMOUNT,
-  description: "Amount",
-  hiddenFromList: false
-};
-var brightnessAmountSchema = {
-  type: "number",
-  min: -1,
-  max: 1,
-  step: 0.01,
-  default: DEFAULT_BRIGHTNESS_AMOUNT,
-  description: "Amount",
-  hiddenFromList: false
-};
-var hueDegreesSchema = {
-  type: "rotation-degrees",
-  step: 1,
-  default: DEFAULT_HUE_DEGREES,
-  description: "Degrees"
-};
-var assertOptionalFiniteNumber = (value, name) => {
-  if (value === undefined) {
-    return;
-  }
-  assertRequiredFiniteNumber(value, name);
-};
-var validateUnitInterval = (value, name) => {
-  if (value < 0) {
-    throw new TypeError(`"${name}" must be >= 0, but got ${JSON.stringify(value)}`);
-  }
-  if (value > 1) {
-    throw new TypeError(`"${name}" must be <= 1, but got ${JSON.stringify(value)}`);
-  }
-};
-var validateNonNegative = (value, name) => {
-  if (value < 0) {
-    throw new TypeError(`"${name}" must be >= 0, but got ${JSON.stringify(value)}`);
+struct Params {
+  keyColor: vec3f,
+  similarity: f32,
+  smoothness: f32,
+  spillSuppression: f32,
+}
+@group(0) @binding(0) var source: texture_2d<f32>;
+@group(0) @binding(1) var sourceSampler: sampler;
+@group(0) @binding(2) var<uniform> params: Params;
+
+fn suppressSpill(rgb: vec3f, keyColor: vec3f, amount: f32) -> vec3f {
+  var color = rgb;
+  if (keyColor.g > keyColor.r && keyColor.g > keyColor.b) {
+    let limit = (color.r + color.b) * 0.5;
+    color.g = mix(color.g, min(color.g, limit), amount);
+  } else if (keyColor.r > keyColor.g && keyColor.r > keyColor.b) {
+    let limit = (color.g + color.b) * 0.5;
+    color.r = mix(color.r, min(color.r, limit), amount);
+  } else if (keyColor.b > keyColor.r && keyColor.b > keyColor.g) {
+    let limit = (color.r + color.g) * 0.5;
+    color.b = mix(color.b, min(color.b, limit), amount);
   }
-};
-var validateSignedUnitInterval = (value, name) => {
-  if (value < -1) {
-    throw new TypeError(`"${name}" must be >= -1, but got ${JSON.stringify(value)}`);
+  return color;
+}
+
+@fragment fn fragment(input: VertexOutput) -> @location(0) vec4f {
+  let texColor = textureSampleLevel(source, sourceSampler, input.uv, 0);
+  let alpha = texColor.a;
+  if (alpha <= 0.001) { return vec4f(0); }
+
+  let rgb = texColor.rgb / alpha;
+  let distanceNormalized = distance(rgb, params.keyColor) / 1.7320508075688772;
+  var keepMask: f32;
+  if (params.smoothness <= 0.0001) {
+    keepMask = step(params.similarity, distanceNormalized);
+  } else {
+    let edge0 = max(0.0, params.similarity - params.smoothness);
+    let edge1 = min(1.0, params.similarity + params.smoothness);
+    if (edge1 <= edge0 + 0.0001) {
+      keepMask = step(params.similarity, distanceNormalized);
+    } else {
+      keepMask = smoothstep(edge0, edge1, distanceNormalized);
+    }
   }
-  if (value > 1) {
-    throw new TypeError(`"${name}" must be <= 1, but got ${JSON.stringify(value)}`);
+
+  var cleanRgb = rgb;
+  if (params.spillSuppression > 0.0) {
+    cleanRgb = suppressSpill(rgb, params.keyColor, params.spillSuppression);
   }
-};
-var clampColorChannel = (value) => {
-  return Math.max(0, Math.min(255, value));
-};
-var parseColorRgba = (ctx, color) => {
-  ctx.clearRect(0, 0, 1, 1);
-  ctx.fillStyle = color;
-  ctx.fillRect(0, 0, 1, 1);
-  const { data } = ctx.getImageData(0, 0, 1, 1);
-  return [data[0], data[1], data[2], data[3]];
-};
+  let keyedAlpha = alpha * keepMask;
+  return vec4f(cleanRgb * keyedAlpha, keyedAlpha);
+}
+`;
 
 // src/color-key.ts
 var { createEffect, createWebGL2ContextError } = Internals;
@@ -377,46 +346,90 @@ var colorKey = createEffect({
   type: "dev.remotion.effects.colorKey",
   label: "colorKey()",
   documentationLink: "https://www.remotion.dev/docs/effects/color-key",
-  backend: "webgl2",
   calculateKey: (params) => {
     const r = resolve(params);
     return `color-key-${r.keyColor}-${r.similarity}-${r.smoothness}-${r.spillSuppression}`;
   },
-  setup: (target) => setupColorKey(target),
-  apply: ({ source, width, height, params, state, flipSourceY }) => {
-    const r = resolve(params);
-    const keyColor = parseKeyColor(state, r.keyColor);
-    const { gl, program, textureSource, uniforms, vao } = state;
-    gl.viewport(0, 0, width, height);
-    gl.bindFramebuffer(gl.FRAMEBUFFER, null);
-    gl.clearColor(0, 0, 0, 0);
-    gl.clear(gl.COLOR_BUFFER_BIT);
-    gl.activeTexture(gl.TEXTURE0);
-    gl.bindTexture(gl.TEXTURE_2D, textureSource);
-    gl.pixelStorei(gl.UNPACK_FLIP_Y_WEBGL, flipSourceY);
-    gl.texImage2D(gl.TEXTURE_2D, 0, gl.RGBA, gl.RGBA, gl.UNSIGNED_BYTE, source);
-    gl.useProgram(program);
-    if (uniforms.uSource)
-      gl.uniform1i(uniforms.uSource, 0);
-    if (uniforms.uKeyColor)
-      gl.uniform3f(uniforms.uKeyColor, keyColor[0], keyColor[1], keyColor[2]);
-    if (uniforms.uSimilarity)
-      gl.uniform1f(uniforms.uSimilarity, r.similarity);
-    if (uniforms.uSmoothness)
-      gl.uniform1f(uniforms.uSmoothness, r.smoothness);
-    if (uniforms.uSpillSuppression)
-      gl.uniform1f(uniforms.uSpillSuppression, r.spillSuppression);
-    gl.bindVertexArray(vao);
-    gl.drawArrays(gl.TRIANGLE_STRIP, 0, 4);
-    gl.bindVertexArray(null);
-    gl.bindTexture(gl.TEXTURE_2D, null);
-    gl.useProgram(null);
-  },
-  cleanup: ({ gl, program, vao, vbo, textureSource }) => {
-    gl.deleteTexture(textureSource);
-    gl.deleteBuffer(vbo);
-    gl.deleteProgram(program);
-    gl.deleteVertexArray(vao);
+  implementations: {
+    webgpu: Internals.createEffectImplementation({
+      setup: (target) => {
+        const colorCanvas = document.createElement("canvas");
+        colorCanvas.width = 1;
+        colorCanvas.height = 1;
+        const colorCtx = colorCanvas.getContext("2d", {
+          willReadFrequently: true
+        });
+        if (!colorCtx)
+          throw new Error("Failed to acquire 2D context for color parsing");
+        return {
+          ...setupWebGpuSinglePass(target, "color key"),
+          colorCtx,
+          cachedColor: "",
+          cachedColorRgba: [0, 255, 0, 255]
+        };
+      },
+      apply: ({ source, width, height, params, state, gpuDevice }) => {
+        if (!gpuDevice)
+          throw new Error("A WebGPU device is required for the color key effect");
+        const r = resolve(params);
+        const keyColor = parseKeyColor(state, r.keyColor);
+        applyWebGpuSinglePass({
+          state,
+          source,
+          width,
+          height,
+          device: gpuDevice,
+          shader: COLOR_KEY_WEBGPU_SHADER,
+          uniformData: new Float32Array([
+            ...keyColor,
+            r.similarity,
+            r.smoothness,
+            r.spillSuppression,
+            0,
+            0
+          ])
+        });
+      },
+      cleanup: cleanupWebGpuSinglePass
+    }),
+    webgl2: Internals.createEffectImplementation({
+      setup: (target) => setupColorKey(target),
+      apply: ({ source, width, height, params, state, flipSourceY }) => {
+        const r = resolve(params);
+        const keyColor = parseKeyColor(state, r.keyColor);
+        const { gl, program, textureSource, uniforms, vao } = state;
+        gl.viewport(0, 0, width, height);
+        gl.bindFramebuffer(gl.FRAMEBUFFER, null);
+        gl.clearColor(0, 0, 0, 0);
+        gl.clear(gl.COLOR_BUFFER_BIT);
+        gl.activeTexture(gl.TEXTURE0);
+        gl.bindTexture(gl.TEXTURE_2D, textureSource);
+        gl.pixelStorei(gl.UNPACK_FLIP_Y_WEBGL, flipSourceY);
+        gl.texImage2D(gl.TEXTURE_2D, 0, gl.RGBA, gl.RGBA, gl.UNSIGNED_BYTE, source);
+        gl.useProgram(program);
+        if (uniforms.uSource)
+          gl.uniform1i(uniforms.uSource, 0);
+        if (uniforms.uKeyColor)
+          gl.uniform3f(uniforms.uKeyColor, keyColor[0], keyColor[1], keyColor[2]);
+        if (uniforms.uSimilarity)
+          gl.uniform1f(uniforms.uSimilarity, r.similarity);
+        if (uniforms.uSmoothness)
+          gl.uniform1f(uniforms.uSmoothness, r.smoothness);
+        if (uniforms.uSpillSuppression)
+          gl.uniform1f(uniforms.uSpillSuppression, r.spillSuppression);
+        gl.bindVertexArray(vao);
+        gl.drawArrays(gl.TRIANGLE_STRIP, 0, 4);
+        gl.bindVertexArray(null);
+        gl.bindTexture(gl.TEXTURE_2D, null);
+        gl.useProgram(null);
+      },
+      cleanup: ({ gl, program, vao, vbo, textureSource }) => {
+        gl.deleteTexture(textureSource);
+        gl.deleteBuffer(vbo);
+        gl.deleteProgram(program);
+        gl.deleteVertexArray(vao);
+      }
+    })
   },
   schema: colorKeySchema,
   validateParams: validateColorKeyParams