chore: Align interpolation strategy params, tests, and Storybook docs

Author: cutterbl

packages/audio-worklet/src/SoundTouchNode.spec.ts

@@ -84,7 +84,7 @@ describe('SoundTouchNode', () => {
     const node = new SoundTouchNode({ context });
 
     node.setInterpolationStrategy('lanczos');
-    node.setInterpolationStrategyParams({ radius: 6 });
+    node.setInterpolationStrategyParams({ zeroCrossings: 6 });
 
     const port = (
       node as unknown as { port: { postMessage: ReturnType<typeof vi.fn> } }

packages/core/src/RateTransposer.spec.ts

@@ -492,11 +492,11 @@ describe('RateTransposer', () => {
         },
       });
 
-      expect(rt.strategyParams['radius']).toBe(4);
+      expect(rt.strategyParams['zeroCrossings']).toBe(4);
 
-      rt.setInterpolationStrategyParams({ radius: 7 });
+      rt.setInterpolationStrategyParams({ zeroCrossings: 7 });
 
-      expect(rt.strategyParams['radius']).toBe(7);
+      expect(rt.strategyParams['zeroCrossings']).toBe(7);
     });
 
     it('preserves strategy params when cloned', () => {
@@ -511,7 +511,7 @@ describe('RateTransposer', () => {
       const cloned = rt.clone();
 
       expect(cloned.strategy).toBe('lanczos');
-      expect(cloned.strategyParams['radius']).toBe(5);
+      expect(cloned.strategyParams['zeroCrossings']).toBe(5);
     });
   });
 

packages/core/src/interpolationStrategyRegistry.ts

@@ -23,7 +23,7 @@ export interface InterpolationKernel {
   createState?: () => unknown;
 }
 
-export type InterpolationStrategyParams = Record<string, number>;
+export type InterpolationStrategyParams = Record<string, number | boolean>;
 
 export type RateTransposerInterpolationStrategyId = string;
 

packages/interpolation-strategy-blackman/src/index.ts

@@ -16,14 +16,14 @@ export interface InterpolationStrategyRegistration {
   readonly id: string;
   readonly baseStrategy?: BuiltInInterpolationStrategy;
   readonly kernel?: InterpolationKernel;
-  readonly defaultParams?: Record<string, number>;
+  readonly defaultParams?: Record<string, number | boolean>;
   readonly normalizeParams?: (
-    params: Partial<Record<string, number>> | undefined,
-    defaults: Record<string, number>,
-  ) => Record<string, number>;
+    params: Partial<Record<string, number | boolean>> | undefined,
+    defaults: Record<string, number | boolean>,
+  ) => Record<string, number | boolean>;
   readonly applyParams?: (
     state: unknown,
-    params: Record<string, number>,
+    params: Record<string, number | boolean>,
   ) => void;
 }
 
@@ -39,7 +39,6 @@ interface BlackmanKernelState {
   params: BlackmanStrategyParams;
 }
 
-
 /**
  * Parameters for the Blackman interpolation strategy.
  *
@@ -49,12 +48,15 @@ interface BlackmanKernelState {
  * @property beta Blackman window beta coefficient (default: 0.5)
  * @property gamma Blackman window gamma coefficient (default: 0.08)
  */
-export interface BlackmanStrategyParams extends Record<string, number | boolean> {
+export interface BlackmanStrategyParams extends Record<
+  string,
+  number | boolean
+> {
   zeroCrossings: number;
-  normalize?: boolean;
-  alpha?: number;
-  beta?: number;
-  gamma?: number;
+  normalize: boolean;
+  alpha: number;
+  beta: number;
+  gamma: number;
 }
 
 const BLACKMAN_DEFAULT_PARAMS: BlackmanStrategyParams = {
@@ -75,7 +77,12 @@ function normalizeBlackmanParams(
   };
   const zeroCrossings = Math.max(
     2,
-    Math.min(8, Math.round(Number(merged['zeroCrossings'] ?? defaults['zeroCrossings'] ?? 4))),
+    Math.min(
+      8,
+      Math.round(
+        Number(merged['zeroCrossings'] ?? defaults['zeroCrossings'] ?? 4),
+      ),
+    ),
   );
   const normalize = Boolean(merged['normalize']);
   const alpha = Number(merged['alpha'] ?? 0.42);
@@ -93,7 +100,10 @@ function applyBlackmanParams(
   }
   const record = state as BlackmanKernelState;
   record.params = {
-    zeroCrossings: Math.max(2, Math.round(Number(params['zeroCrossings'] ?? 4))),
+    zeroCrossings: Math.max(
+      2,
+      Math.round(Number(params['zeroCrossings'] ?? 4)),
+    ),
     normalize: Boolean(params['normalize']),
     alpha: Number(params['alpha'] ?? 0.42),
     beta: Number(params['beta'] ?? 0.5),
@@ -129,7 +139,13 @@ function normalizedSinc(x: number): number {
   return Math.sin(value) / value;
 }
 
-function blackmanWindow(distance: number, radius: number, alpha: number, beta: number, gamma: number): number {
+function blackmanWindow(
+  distance: number,
+  radius: number,
+  alpha: number,
+  beta: number,
+  gamma: number,
+): number {
   const absDistance = Math.abs(distance);
   if (absDistance >= radius) {
     return 0;
@@ -142,11 +158,19 @@ function blackmanWindow(distance: number, radius: number, alpha: number, beta: n
   );
 }
 
-function blackmanWeight(distance: number, radius: number, alpha: number, beta: number, gamma: number): number {
-  return normalizedSinc(distance) * blackmanWindow(distance, radius, alpha, beta, gamma);
+function blackmanWeight(
+  distance: number,
+  radius: number,
+  alpha: number,
+  beta: number,
+  gamma: number,
+): number {
+  return (
+    normalizedSinc(distance) *
+    blackmanWindow(distance, radius, alpha, beta, gamma)
+  );
 }
 
-
 export const blackmanKernel: InterpolationKernel = (
   src,
   srcOffset,
@@ -158,9 +182,16 @@ export const blackmanKernel: InterpolationKernel = (
   const kernelState = state as BlackmanKernelState;
   const radius = kernelState.params.zeroCrossings;
   const normalize = Boolean(kernelState.params.normalize);
-  const alpha = typeof kernelState.params.alpha === 'number' ? kernelState.params.alpha : 0.42;
-  const beta = typeof kernelState.params.beta === 'number' ? kernelState.params.beta : 0.5;
-  const gamma = typeof kernelState.params.gamma === 'number' ? kernelState.params.gamma : 0.08;
+  const alpha =
+    typeof kernelState.params.alpha === 'number'
+      ? kernelState.params.alpha
+      : 0.42;
+  const beta =
+    typeof kernelState.params.beta === 'number' ? kernelState.params.beta : 0.5;
+  const gamma =
+    typeof kernelState.params.gamma === 'number'
+      ? kernelState.params.gamma
+      : 0.08;
   const center = Math.floor(position);
   const start = center - (radius - 1);
   const end = center + radius;

packages/interpolation-strategy-hann/src/index.ts

@@ -16,14 +16,14 @@ export interface InterpolationStrategyRegistration {
   readonly id: string;
   readonly baseStrategy?: BuiltInInterpolationStrategy;
   readonly kernel?: InterpolationKernel;
-  readonly defaultParams?: Record<string, number>;
+  readonly defaultParams?: Record<string, number | boolean>;
   readonly normalizeParams?: (
-    params: Partial<Record<string, number>> | undefined,
-    defaults: Record<string, number>,
-  ) => Record<string, number>;
+    params: Partial<Record<string, number | boolean>> | undefined,
+    defaults: Record<string, number | boolean>,
+  ) => Record<string, number | boolean>;
   readonly applyParams?: (
     state: unknown,
-    params: Record<string, number>,
+    params: Record<string, number | boolean>,
   ) => void;
 }
 
@@ -39,7 +39,6 @@ interface HannKernelState {
   params: HannStrategyParams;
 }
 
-
 /**
  * Parameters for the Hann interpolation strategy.
  *
@@ -49,8 +48,8 @@ interface HannKernelState {
  */
 export interface HannStrategyParams extends Record<string, number | boolean> {
   zeroCrossings: number;
-  normalize?: boolean;
-  windowPower?: number;
+  normalize: boolean;
+  windowPower: number;
 }
 
 const HANN_DEFAULT_PARAMS: HannStrategyParams = {
@@ -69,20 +68,31 @@ function normalizeHannParams(
   };
   const zeroCrossings = Math.max(
     2,
-    Math.min(8, Math.round(Number(merged['zeroCrossings'] ?? defaults['zeroCrossings'] ?? 4))),
+    Math.min(
+      8,
+      Math.round(
+        Number(merged['zeroCrossings'] ?? defaults['zeroCrossings'] ?? 4),
+      ),
+    ),
   );
   const normalize = Boolean(merged['normalize']);
   const windowPower = Math.max(0.1, Number(merged['windowPower'] ?? 1));
   return { zeroCrossings, normalize, windowPower };
 }
 
-function applyHannParams(state: unknown, params: Record<string, number | boolean>): void {
+function applyHannParams(
+  state: unknown,
+  params: Record<string, number | boolean>,
+): void {
   if (typeof state !== 'object' || state === null) {
     return;
   }
   const record = state as HannKernelState;
   record.params = {
-    zeroCrossings: Math.max(2, Math.round(Number(params['zeroCrossings'] ?? 4))),
+    zeroCrossings: Math.max(
+      2,
+      Math.round(Number(params['zeroCrossings'] ?? 4)),
+    ),
     normalize: Boolean(params['normalize']),
     windowPower: Math.max(0.1, Number(params['windowPower'] ?? 1)),
   };
@@ -116,7 +126,11 @@ function normalizedSinc(x: number): number {
   return Math.sin(value) / value;
 }
 
-function hannWindow(distance: number, radius: number, windowPower: number): number {
+function hannWindow(
+  distance: number,
+  radius: number,
+  windowPower: number,
+): number {
   const absDistance = Math.abs(distance);
   if (absDistance >= radius) {
     return 0;
@@ -125,11 +139,14 @@ function hannWindow(distance: number, radius: number, windowPower: number): numb
   return Math.pow(base, windowPower);
 }
 
-function hannWeight(distance: number, radius: number, windowPower: number): number {
+function hannWeight(
+  distance: number,
+  radius: number,
+  windowPower: number,
+): number {
   return normalizedSinc(distance) * hannWindow(distance, radius, windowPower);
 }
 
-
 export const hannKernel: InterpolationKernel = (
   src,
   srcOffset,
@@ -141,7 +158,10 @@ export const hannKernel: InterpolationKernel = (
   const kernelState = state as HannKernelState;
   const radius = kernelState.params.zeroCrossings;
   const normalize = Boolean(kernelState.params.normalize);
-  const windowPower = typeof kernelState.params.windowPower === 'number' ? kernelState.params.windowPower : 1;
+  const windowPower =
+    typeof kernelState.params.windowPower === 'number'
+      ? kernelState.params.windowPower
+      : 1;
   const center = Math.floor(position);
   const start = center - (radius - 1);
   const end = center + radius;

packages/interpolation-strategy-kaiser/src/index.ts

@@ -16,14 +16,14 @@ export interface InterpolationStrategyRegistration {
   readonly id: string;
   readonly baseStrategy?: BuiltInInterpolationStrategy;
   readonly kernel?: InterpolationKernel;
-  readonly defaultParams?: Record<string, number>;
+  readonly defaultParams?: Record<string, number | boolean>;
   readonly normalizeParams?: (
-    params: Partial<Record<string, number>> | undefined,
-    defaults: Record<string, number>,
-  ) => Record<string, number>;
+    params: Partial<Record<string, number | boolean>> | undefined,
+    defaults: Record<string, number | boolean>,
+  ) => Record<string, number | boolean>;
   readonly applyParams?: (
     state: unknown,
-    params: Record<string, number>,
+    params: Record<string, number | boolean>,
   ) => void;
 }
 
@@ -39,7 +39,6 @@ interface KaiserKernelState {
   params: KaiserStrategyParams;
 }
 
-
 /**
  * Parameters for the Kaiser interpolation strategy.
  *
@@ -51,8 +50,8 @@ interface KaiserKernelState {
 export interface KaiserStrategyParams extends Record<string, number | boolean> {
   zeroCrossings: number;
   beta: number;
-  normalize?: boolean;
-  windowPower?: number;
+  normalize: boolean;
+  windowPower: number;
 }
 
 const KAISER_DEFAULT_PARAMS: KaiserStrategyParams = {
@@ -72,7 +71,12 @@ function normalizeKaiserParams(
   };
   const zeroCrossings = Math.max(
     2,
-    Math.min(16, Math.round(Number(merged['zeroCrossings'] ?? defaults['zeroCrossings'] ?? 4))),
+    Math.min(
+      16,
+      Math.round(
+        Number(merged['zeroCrossings'] ?? defaults['zeroCrossings'] ?? 4),
+      ),
+    ),
   );
   const beta = Math.max(0, Math.min(20, Number(merged['beta'] ?? 8.6)));
   const normalize = Boolean(merged['normalize']);
@@ -89,7 +93,10 @@ function applyKaiserParams(
   }
   const record = state as KaiserKernelState;
   record.params = {
-    zeroCrossings: Math.max(2, Math.round(Number(params['zeroCrossings'] ?? 4))),
+    zeroCrossings: Math.max(
+      2,
+      Math.round(Number(params['zeroCrossings'] ?? 4)),
+    ),
     beta: Math.max(0, Math.min(20, Number(params['beta'] ?? 8.6))),
     normalize: Boolean(params['normalize']),
     windowPower: Math.max(0.1, Number(params['windowPower'] ?? 1)),
@@ -163,7 +170,6 @@ function kaiserWindow(
   return Math.pow(base, windowPower);
 }
 
-
 export const kaiserKernel: InterpolationKernel = (
   src,
   srcOffset,