sethares-dissonance 4.0.0 → 5.0.0

package/dist/classes/DissonanceCurve.d.ts

@@ -74,18 +74,20 @@ export declare class DissonanceCurve {
      */
     get(ratio: FractionInput): DissonanceCurvePoint | undefined;
     /**
-     * Normalize dissonance values in place to the range [0, 1].
+     * Normalize dissonance values in place to a target range.
      *
      * **Destructive:** This method mutates the curve permanently. All dissonance values
-     * are divided by the maximum dissonance, and the original raw values cannot be
-     * recovered. Use {@link recalculate} to rebuild the curve with raw values.
+     * are scaled from [0, maxDissonance] to [min, max], and the original raw values
+     * cannot be recovered. Use {@link recalculate} to rebuild the curve with raw values.
      *
      * After normalization, `points`, `get`, `plot`, `plotCents`, `toJSON`, and
-     * `toString` will all return normalized dissonance values (0–1 range).
+     * `toString` will all return normalized dissonance values in the [min, max] range.
      *
+     * @param min - Target minimum value (default: 0)
+     * @param max - Target maximum value (default: 1)
      * @returns `this` for method chaining
      */
-    normalize(): this;
+    normalize(min?: number, max?: number): this;
     /**
      * Get plot points with intervals as ratio values (decimal numbers).
      * @returns Array of [ratio, dissonance] tuples suitable for plotting

package/dist/classes/DissonanceCurve.js

@@ -118,27 +118,32 @@ export class DissonanceCurve {
         return this._data.get(new Fraction(ratio).toFraction());
     }
     /**
-     * Normalize dissonance values in place to the range [0, 1].
+     * Normalize dissonance values in place to a target range.
      *
      * **Destructive:** This method mutates the curve permanently. All dissonance values
-     * are divided by the maximum dissonance, and the original raw values cannot be
-     * recovered. Use {@link recalculate} to rebuild the curve with raw values.
+     * are scaled from [0, maxDissonance] to [min, max], and the original raw values
+     * cannot be recovered. Use {@link recalculate} to rebuild the curve with raw values.
      *
      * After normalization, `points`, `get`, `plot`, `plotCents`, `toJSON`, and
-     * `toString` will all return normalized dissonance values (0–1 range).
+     * `toString` will all return normalized dissonance values in the [min, max] range.
      *
+     * @param min - Target minimum value (default: 0)
+     * @param max - Target maximum value (default: 1)
      * @returns `this` for method chaining
      */
-    normalize() {
+    normalize(min = 0, max = 1) {
+        if (max <= min)
+            throw new Error('max must be greater than min');
         if (this.maxDissonance === 0)
             return this;
+        const range = max - min;
         for (const [key, point] of this._data) {
             this._data.set(key, {
                 interval: point.interval,
-                dissonance: point.dissonance / this.maxDissonance,
+                dissonance: (point.dissonance / this.maxDissonance) * range + min,
             });
         }
-        this.maxDissonance = 1;
+        this.maxDissonance = max;
         return this;
     }
     /**

package/dist/lib/const.d.ts

@@ -7,6 +7,8 @@ export declare const SETHARES_DISSONANCE_PARAMS: {
     readonly b2: 5.75;
     readonly x_star: 0.24;
     readonly magnitude: 1;
+    /** At 0: no decay (constant magnitude). Higher values = faster decay with minFrequency. */
+    readonly magnitudeFrequencyDecay: 0;
 };
 export declare const DEFAULT_FIRST_ORDER_DISSONANCE_PARAMS: {
     s1: 0.021;
@@ -15,9 +17,11 @@ export declare const DEFAULT_FIRST_ORDER_DISSONANCE_PARAMS: {
     b2: 5.75;
     x_star: 0.24;
     magnitude: 1;
+    magnitudeFrequencyDecay: 0;
 };
 export declare const DEFAULT_SECOND_ORDER_DISSONANCE_PARAMS: {
     magnitude: number;
+    magnitudeFrequencyDecay: number;
     s1: 0.021;
     s2: 19;
     b1: 3.5;
@@ -26,10 +30,11 @@ export declare const DEFAULT_SECOND_ORDER_DISSONANCE_PARAMS: {
 };
 export declare const DEFAULT_THIRD_ORDER_DISSONANCE_PARAMS: {
     magnitude: number;
+    magnitudeFrequencyDecay: number;
     s1: 0.021;
     s2: 19;
     b1: 3.5;
     b2: 5.75;
     x_star: 0.24;
 };
-export declare const DEFAULT_PHANTOM_HARMONICS_NUMBER = 0;
+export declare const DEFAULT_PHANTOM_HARMONICS_NUMBER = 3;

package/dist/lib/const.js

@@ -7,8 +7,10 @@ export const SETHARES_DISSONANCE_PARAMS = {
     b2: 5.75,
     x_star: 0.24,
     magnitude: 1,
+    /** At 0: no decay (constant magnitude). Higher values = faster decay with minFrequency. */
+    magnitudeFrequencyDecay: 0,
 };
 export const DEFAULT_FIRST_ORDER_DISSONANCE_PARAMS = { ...SETHARES_DISSONANCE_PARAMS };
-export const DEFAULT_SECOND_ORDER_DISSONANCE_PARAMS = { ...SETHARES_DISSONANCE_PARAMS, magnitude: 0.25 };
-export const DEFAULT_THIRD_ORDER_DISSONANCE_PARAMS = { ...SETHARES_DISSONANCE_PARAMS, magnitude: 0.1 };
-export const DEFAULT_PHANTOM_HARMONICS_NUMBER = 0;
+export const DEFAULT_SECOND_ORDER_DISSONANCE_PARAMS = { ...SETHARES_DISSONANCE_PARAMS, magnitude: 0.75, magnitudeFrequencyDecay: 0.75 };
+export const DEFAULT_THIRD_ORDER_DISSONANCE_PARAMS = { ...SETHARES_DISSONANCE_PARAMS, magnitude: 0.5, magnitudeFrequencyDecay: 1.75 };
+export const DEFAULT_PHANTOM_HARMONICS_NUMBER = 3;

package/dist/lib/utils.js

@@ -12,6 +12,7 @@ export function getPlompLeveltDissonance(h1, h2, params) {
     const s2 = params?.s2 ?? SETHARES_DISSONANCE_PARAMS.s2;
     const b1 = params?.b1 ?? SETHARES_DISSONANCE_PARAMS.b1;
     const b2 = params?.b2 ?? SETHARES_DISSONANCE_PARAMS.b2;
+    const magnitudeFrequencyDecay = params?.magnitudeFrequencyDecay ?? SETHARES_DISSONANCE_PARAMS.magnitudeFrequencyDecay;
     if (h1.frequency.equals(h2.frequency))
         return 0;
     const minLoudness = Math.min("loudness" in h1 ? h1.loudness : getLoudness(h1.amplitude), "loudness" in h2 ? h2.loudness : getLoudness(h2.amplitude));
@@ -20,9 +21,11 @@ export function getPlompLeveltDissonance(h1, h2, params) {
     const minFrequency = Math.min(h1.frequencyNum, h2.frequencyNum);
     if (minFrequency <= 0)
         return 0;
+    const magnitudeDecayFactor = Math.exp(-magnitudeFrequencyDecay * (minFrequency / 1000));
     const frequencyDifference = Math.abs(h1.frequencyNum - h2.frequencyNum);
     const s = x_star / (s1 * minFrequency + s2);
     return (magnitude *
+        magnitudeDecayFactor *
         minLoudness *
         (Math.exp(-1 * b1 * s * frequencyDifference) -
             Math.exp(-1 * b2 * s * frequencyDifference)));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sethares-dissonance",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "type": "module",
   "devDependencies": {
     "@types/bun": "latest"