@remotion/effects 4.0.484 → 4.0.486

package/dist/esm/venetian-blinds.mjs

@@ -0,0 +1,389 @@
+// src/venetian-blinds.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-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)}`);
+  }
+};
+var validateSignedUnitInterval = (value, name) => {
+  if (value < -1) {
+    throw new TypeError(`"${name}" must be >= -1, but got ${JSON.stringify(value)}`);
+  }
+  if (value > 1) {
+    throw new TypeError(`"${name}" must be <= 1, but got ${JSON.stringify(value)}`);
+  }
+};
+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]];
+};
+
+// src/venetian-blinds.ts
+var { createEffect, createWebGL2ContextError } = Internals;
+var VENETIAN_BLINDS_DIRECTIONS = ["vertical", "horizontal"];
+var DEFAULT_PROGRESS = 0.5;
+var DEFAULT_DIRECTION = "vertical";
+var DEFAULT_SLATS = 12;
+var venetianBlindsSchema = {
+  progress: {
+    type: "number",
+    min: 0,
+    max: 1,
+    step: 0.01,
+    default: DEFAULT_PROGRESS,
+    description: "Progress",
+    hiddenFromList: false
+  },
+  direction: {
+    type: "enum",
+    variants: {
+      vertical: {},
+      horizontal: {}
+    },
+    default: DEFAULT_DIRECTION,
+    description: "Direction"
+  },
+  slats: {
+    type: "number",
+    min: 1,
+    max: 100,
+    step: 1,
+    default: DEFAULT_SLATS,
+    description: "Slats",
+    hiddenFromList: false
+  }
+};
+var formatEnum = (variants) => {
+  if (variants.length === 2) {
+    return `"${variants[0]}" or "${variants[1]}"`;
+  }
+  return `${variants.slice(0, -1).map((variant) => `"${variant}"`).join(", ")} or "${variants[variants.length - 1]}"`;
+};
+var assertOptionalEnum = (value, name, variants) => {
+  if (value === undefined) {
+    return;
+  }
+  if (!variants.includes(value)) {
+    throw new TypeError(`"${name}" must be ${formatEnum(variants)}, but got ${JSON.stringify(value)}`);
+  }
+};
+var resolve = (p) => ({
+  progress: p.progress ?? DEFAULT_PROGRESS,
+  direction: p.direction ?? DEFAULT_DIRECTION,
+  slats: p.slats ?? DEFAULT_SLATS
+});
+var validatePositiveInteger = (value, name) => {
+  if (!Number.isInteger(value)) {
+    throw new TypeError(`"${name}" must be an integer, but got ${JSON.stringify(value)}`);
+  }
+  if (value < 1) {
+    throw new TypeError(`"${name}" must be >= 1, but got ${JSON.stringify(value)}`);
+  }
+};
+var validateVenetianBlindsParams = (params) => {
+  assertEffectParamsObject(params, "Venetian blinds");
+  assertOptionalFiniteNumber(params.progress, "progress");
+  assertOptionalFiniteNumber(params.slats, "slats");
+  assertOptionalEnum(params.direction, "direction", VENETIAN_BLINDS_DIRECTIONS);
+  const r = resolve(params);
+  validateUnitInterval(r.progress, "progress");
+  validatePositiveInteger(r.slats, "slats");
+};
+var VENETIAN_BLINDS_VS = `#version 300 es
+in vec2 aPos;
+in vec2 aUv;
+out vec2 vUv;
+
+void main() {
+	vUv = aUv;
+	gl_Position = vec4(aPos, 0.0, 1.0);
+}
+`;
+var VENETIAN_BLINDS_FS = `#version 300 es
+precision highp float;
+
+in vec2 vUv;
+out vec4 fragColor;
+
+uniform sampler2D uSource;
+uniform float uProgress;
+uniform int uDirection;
+uniform float uSlats;
+
+float maskValue(float distanceToCenter, float progress) {
+	float p = clamp(progress, 0.0, 1.0);
+
+	if (p <= 0.000001) {
+		return 0.0;
+	}
+
+	if (p >= 0.999999) {
+		return 1.0;
+	}
+
+	return step(distanceToCenter, p);
+}
+
+void main() {
+	vec4 source = texture(uSource, vUv);
+	float axis = uDirection == 0 ? vUv.x : vUv.y;
+	float local = fract(axis * max(uSlats, 1.0));
+	float distanceToCenter = abs(local - 0.5) * 2.0;
+	float mask = maskValue(distanceToCenter, uProgress);
+
+	fragColor = vec4(source.rgb * mask, source.a * mask);
+}
+`;
+var compileShader = (gl, type, source) => {
+  const shader = gl.createShader(type);
+  if (!shader) {
+    throw new Error("Failed to create WebGL shader");
+  }
+  gl.shaderSource(shader, source);
+  gl.compileShader(shader);
+  if (!gl.getShaderParameter(shader, gl.COMPILE_STATUS)) {
+    const log = gl.getShaderInfoLog(shader);
+    gl.deleteShader(shader);
+    throw new Error(`Venetian blinds shader compile failed: ${log ?? "(no log)"}`);
+  }
+  return shader;
+};
+var linkProgram = (gl, vs, fs) => {
+  const program = gl.createProgram();
+  if (!program) {
+    throw new Error("Failed to create WebGL program");
+  }
+  gl.attachShader(program, vs);
+  gl.attachShader(program, fs);
+  gl.linkProgram(program);
+  if (!gl.getProgramParameter(program, gl.LINK_STATUS)) {
+    const log = gl.getProgramInfoLog(program);
+    gl.deleteProgram(program);
+    throw new Error(`Venetian blinds program link failed: ${log ?? "(no log)"}`);
+  }
+  return program;
+};
+var setupVenetianBlinds = (target) => {
+  const gl = target.getContext("webgl2", {
+    premultipliedAlpha: true,
+    alpha: true,
+    preserveDrawingBuffer: true
+  });
+  if (!gl) {
+    throw createWebGL2ContextError("venetian blinds effect");
+  }
+  gl.pixelStorei(gl.UNPACK_PREMULTIPLY_ALPHA_WEBGL, true);
+  const vs = compileShader(gl, gl.VERTEX_SHADER, VENETIAN_BLINDS_VS);
+  const fs = compileShader(gl, gl.FRAGMENT_SHADER, VENETIAN_BLINDS_FS);
+  const program = linkProgram(gl, vs, fs);
+  gl.deleteShader(vs);
+  gl.deleteShader(fs);
+  const vao = gl.createVertexArray();
+  if (!vao) {
+    throw new Error("Failed to create WebGL vertex array");
+  }
+  gl.bindVertexArray(vao);
+  const data = new Float32Array([
+    -1,
+    -1,
+    0,
+    0,
+    1,
+    -1,
+    1,
+    0,
+    -1,
+    1,
+    0,
+    1,
+    1,
+    1,
+    1,
+    1
+  ]);
+  const vbo = gl.createBuffer();
+  if (!vbo) {
+    throw new Error("Failed to create WebGL buffer");
+  }
+  gl.bindBuffer(gl.ARRAY_BUFFER, vbo);
+  gl.bufferData(gl.ARRAY_BUFFER, data, gl.STATIC_DRAW);
+  const aPos = gl.getAttribLocation(program, "aPos");
+  const aUv = gl.getAttribLocation(program, "aUv");
+  gl.enableVertexAttribArray(aPos);
+  gl.vertexAttribPointer(aPos, 2, gl.FLOAT, false, 16, 0);
+  gl.enableVertexAttribArray(aUv);
+  gl.vertexAttribPointer(aUv, 2, gl.FLOAT, false, 16, 8);
+  gl.bindVertexArray(null);
+  const texture = gl.createTexture();
+  if (!texture) {
+    throw new Error("Failed to create WebGL texture");
+  }
+  gl.bindTexture(gl.TEXTURE_2D, texture);
+  gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MIN_FILTER, gl.LINEAR);
+  gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_MAG_FILTER, gl.LINEAR);
+  gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_WRAP_S, gl.CLAMP_TO_EDGE);
+  gl.texParameteri(gl.TEXTURE_2D, gl.TEXTURE_WRAP_T, gl.CLAMP_TO_EDGE);
+  gl.bindTexture(gl.TEXTURE_2D, null);
+  return {
+    gl,
+    program,
+    vao,
+    vbo,
+    texture,
+    uniforms: {
+      uSource: gl.getUniformLocation(program, "uSource"),
+      uProgress: gl.getUniformLocation(program, "uProgress"),
+      uDirection: gl.getUniformLocation(program, "uDirection"),
+      uSlats: gl.getUniformLocation(program, "uSlats")
+    }
+  };
+};
+var directionToInt = (direction) => {
+  switch (direction) {
+    case "vertical":
+      return 0;
+    case "horizontal":
+      return 1;
+    default: {
+      const exhaustiveCheck = direction;
+      return exhaustiveCheck;
+    }
+  }
+};
+var venetianBlinds = createEffect({
+  type: "dev.remotion.effects.venetianBlinds",
+  label: "venetianBlinds()",
+  documentationLink: "https://www.remotion.dev/docs/effects/venetian-blinds",
+  backend: "webgl2",
+  calculateKey: (params) => {
+    const r = resolve(params);
+    return `venetian-blinds-${r.progress}-${r.direction}-${r.slats}`;
+  },
+  setup: (target) => setupVenetianBlinds(target),
+  apply: ({ source, width, height, params, state, flipSourceY }) => {
+    const r = resolve(params);
+    const { gl, program, texture, 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, texture);
+    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.uProgress)
+      gl.uniform1f(uniforms.uProgress, r.progress);
+    if (uniforms.uDirection)
+      gl.uniform1i(uniforms.uDirection, directionToInt(r.direction));
+    if (uniforms.uSlats)
+      gl.uniform1f(uniforms.uSlats, r.slats);
+    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, texture }) => {
+    gl.deleteTexture(texture);
+    gl.deleteBuffer(vbo);
+    gl.deleteProgram(program);
+    gl.deleteVertexArray(vao);
+  },
+  schema: venetianBlindsSchema,
+  validateParams: validateVenetianBlindsParams
+});
+export {
+  venetianBlindsSchema,
+  venetianBlinds
+};

package/dist/paper.d.ts

@@ -0,0 +1,35 @@
+export type PaperParams = {
+    /** Strength of the paper texture from `0` to `1`. Defaults to `1`. */
+    readonly amount?: number;
+    /** Light-facing paper color. Defaults to `#9fadbc`. */
+    readonly colorFront?: string;
+    /** Shadow-facing paper color. Defaults to `#ffffff`. */
+    readonly colorBack?: string;
+    /** Sharpness of light and color transitions from `0` to `1`. Defaults to `0.3`. */
+    readonly contrast?: number;
+    /** Fine pixel noise from `0` to `1`. Defaults to `0.4`. */
+    readonly roughness?: number;
+    /** Curly fiber intensity from `0` to `1`. Defaults to `0.3`. */
+    readonly fiber?: number;
+    /** Curly fiber scale from `0.01` to `1`. Defaults to `0.2`. */
+    readonly fiberSize?: number;
+    /** Cell-based crumple intensity from `0` to `1`. Defaults to `0.3`. */
+    readonly crumples?: number;
+    /** Cell-based crumple scale from `0.01` to `1`. Defaults to `0.35`. */
+    readonly crumpleSize?: number;
+    /** Fold lighting intensity from `0` to `1`. Defaults to `0.65`. */
+    readonly folds?: number;
+    /** Number of generated folds from `0` to `15`. Defaults to `5`. */
+    readonly foldCount?: number;
+    /** Speckle visibility from `0` to `1`. Defaults to `0.2`. */
+    readonly drops?: number;
+    /** Large-scale mask applied to the paper pattern from `0` to `1`. Defaults to `0`. */
+    readonly fade?: number;
+    /** Seed for the generated paper pattern from `0` to `1000`. Defaults to `6`. */
+    readonly seed?: number;
+    /** Scale of the generated paper texture from `0.01` to `4`. Defaults to `0.6`. */
+    readonly scale?: number;
+};
+export declare const paper: (params?: (PaperParams & {
+    readonly disabled?: boolean | undefined;
+}) | undefined) => import("remotion").EffectDescriptor<unknown>;

package/dist/venetian-blinds.d.ts

@@ -0,0 +1,43 @@
+declare const VENETIAN_BLINDS_DIRECTIONS: readonly ["vertical", "horizontal"];
+export type VenetianBlindsDirection = (typeof VENETIAN_BLINDS_DIRECTIONS)[number];
+export declare const venetianBlindsSchema: {
+    readonly progress: {
+        readonly type: "number";
+        readonly min: 0;
+        readonly max: 1;
+        readonly step: 0.01;
+        readonly default: 0.5;
+        readonly description: "Progress";
+        readonly hiddenFromList: false;
+    };
+    readonly direction: {
+        readonly type: "enum";
+        readonly variants: {
+            readonly vertical: {};
+            readonly horizontal: {};
+        };
+        readonly default: "vertical";
+        readonly description: "Direction";
+    };
+    readonly slats: {
+        readonly type: "number";
+        readonly min: 1;
+        readonly max: 100;
+        readonly step: 1;
+        readonly default: 12;
+        readonly description: "Slats";
+        readonly hiddenFromList: false;
+    };
+};
+export type VenetianBlindsParams = {
+    /** Reveal progress from `0` (hidden) to `1` (fully revealed). Defaults to `0.5`. */
+    readonly progress?: number;
+    /** Slat orientation. Defaults to `vertical`. */
+    readonly direction?: VenetianBlindsDirection;
+    /** Number of blinds across the source. Defaults to `12`. */
+    readonly slats?: number;
+};
+export declare const venetianBlinds: (params?: (VenetianBlindsParams & {
+    readonly disabled?: boolean | undefined;
+}) | undefined) => import("remotion").EffectDescriptor<unknown>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remotion/effects",
-	"version": "4.0.484",
+	"version": "4.0.486",
 	"description": "Effects that can be applied to Remotion-based canvas components",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -26,7 +26,7 @@
 		"url": "https://github.com/remotion-dev/remotion/issues"
 	},
 	"dependencies": {
-		"remotion": "4.0.484"
+		"remotion": "4.0.486"
 	},
 	"exports": {
 		".": {
@@ -199,6 +199,11 @@
 			"module": "./dist/esm/noise-displacement.mjs",
 			"import": "./dist/esm/noise-displacement.mjs"
 		},
+		"./paper": {
+			"types": "./dist/paper.d.ts",
+			"module": "./dist/esm/paper.mjs",
+			"import": "./dist/esm/paper.mjs"
+		},
 		"./pattern": {
 			"types": "./dist/pattern.d.ts",
 			"module": "./dist/esm/pattern.mjs",
@@ -264,6 +269,11 @@
 			"module": "./dist/esm/tv-signal-off.mjs",
 			"import": "./dist/esm/tv-signal-off.mjs"
 		},
+		"./venetian-blinds": {
+			"types": "./dist/venetian-blinds.d.ts",
+			"module": "./dist/esm/venetian-blinds.mjs",
+			"import": "./dist/esm/venetian-blinds.mjs"
+		},
 		"./vignette": {
 			"types": "./dist/vignette.d.ts",
 			"module": "./dist/esm/vignette.mjs",
@@ -397,6 +407,9 @@
 			"noise-displacement": [
 				"dist/noise-displacement.d.ts"
 			],
+			"paper": [
+				"dist/paper.d.ts"
+			],
 			"pattern": [
 				"dist/pattern.d.ts"
 			],
@@ -436,6 +449,9 @@
 			"tv-signal-off": [
 				"dist/tv-signal-off.d.ts"
 			],
+			"venetian-blinds": [
+				"dist/venetian-blinds.d.ts"
+			],
 			"vignette": [
 				"dist/vignette.d.ts"
 			],
@@ -458,7 +474,7 @@
 	},
 	"homepage": "https://www.remotion.dev/docs/effects/api",
 	"devDependencies": {
-		"@remotion/eslint-config-internal": "4.0.484",
+		"@remotion/eslint-config-internal": "4.0.486",
 		"@vitest/browser-playwright": "4.0.9",
 		"eslint": "9.19.0",
 		"vitest": "4.0.9",