sethares-dissonance 5.0.0 → 5.1.0

package/dist/classes/private/SpectrumWithLoudness.d.ts

@@ -14,6 +14,7 @@ export declare class SpectrumWithLoudness extends Spectrum {
     toTransposed(ratio: FractionInput): SpectrumWithLoudness;
     toJSON(): SpectrumWithLoudnessData;
     get(frequency: FractionInput): HarmonicWithLoudness | undefined;
+    static fromFrequencies(frequencies: FractionInput[], amplitudes?: number[], phases?: number[]): SpectrumWithLoudness;
     /**
    * Multiply this spectrum by another spectrum.
    * Each harmonic of this spectrum is multiplied by each harmonic of the other
@@ -28,4 +29,5 @@ export declare class SpectrumWithLoudness extends Spectrum {
    */
     mul(other: SpectrumWithLoudness): SpectrumWithLoudness;
     static harmonic(count: number, fundamentalHz: FractionInput, phantom?: boolean): SpectrumWithLoudness;
+    static stretched(count: number, fundamentalHz: FractionInput, pseudoOctaveRatio: FractionInput, phantom?: boolean): SpectrumWithLoudness;
 }

package/dist/classes/private/SpectrumWithLoudness.js

@@ -51,6 +51,13 @@ export class SpectrumWithLoudness extends Spectrum {
     get(frequency) {
         return super.get(frequency);
     }
+    static fromFrequencies(frequencies, amplitudes, phases) {
+        const spectrum = new SpectrumWithLoudness();
+        for (let i = 0; i < frequencies.length; i++) {
+            spectrum.add(new HarmonicWithLoudness(frequencies[i], amplitudes?.[i] ?? 1, phases?.[i] ?? 0, false));
+        }
+        return spectrum;
+    }
     /**
    * Multiply this spectrum by another spectrum.
    * Each harmonic of this spectrum is multiplied by each harmonic of the other
@@ -102,4 +109,12 @@ export class SpectrumWithLoudness extends Spectrum {
         }
         return result;
     }
+    static stretched(count, fundamentalHz, pseudoOctaveRatio, phantom) {
+        const spectrum = super.stretched(count, fundamentalHz, pseudoOctaveRatio);
+        const result = new SpectrumWithLoudness();
+        for (const harmonic of spectrum.getHarmonics()) {
+            result.add(new HarmonicWithLoudness({ harmonic, phantom: phantom ?? false }));
+        }
+        return result;
+    }
 }

package/dist/lib/const.d.ts

@@ -9,6 +9,8 @@ export declare const SETHARES_DISSONANCE_PARAMS: {
     readonly magnitude: 1;
     /** At 0: no decay (constant magnitude). Higher values = faster decay with minFrequency. */
     readonly magnitudeFrequencyDecay: 0;
+    /** At 0: flat (no mid-frequency notch). At 1: full cut at the notch center. */
+    readonly phantomNotchDepth: 0;
 };
 export declare const DEFAULT_FIRST_ORDER_DISSONANCE_PARAMS: {
     s1: 0.021;
@@ -18,6 +20,7 @@ export declare const DEFAULT_FIRST_ORDER_DISSONANCE_PARAMS: {
     x_star: 0.24;
     magnitude: 1;
     magnitudeFrequencyDecay: 0;
+    phantomNotchDepth: 0;
 };
 export declare const DEFAULT_SECOND_ORDER_DISSONANCE_PARAMS: {
     magnitude: number;
@@ -27,10 +30,12 @@ export declare const DEFAULT_SECOND_ORDER_DISSONANCE_PARAMS: {
     b1: 3.5;
     b2: 5.75;
     x_star: 0.24;
+    phantomNotchDepth: 0;
 };
 export declare const DEFAULT_THIRD_ORDER_DISSONANCE_PARAMS: {
     magnitude: number;
     magnitudeFrequencyDecay: number;
+    phantomNotchDepth: number;
     s1: 0.021;
     s2: 19;
     b1: 3.5;

package/dist/lib/const.js

@@ -9,8 +9,15 @@ export const SETHARES_DISSONANCE_PARAMS = {
     magnitude: 1,
     /** At 0: no decay (constant magnitude). Higher values = faster decay with minFrequency. */
     magnitudeFrequencyDecay: 0,
+    /** At 0: flat (no mid-frequency notch). At 1: full cut at the notch center. */
+    phantomNotchDepth: 0,
 };
 export const DEFAULT_FIRST_ORDER_DISSONANCE_PARAMS = { ...SETHARES_DISSONANCE_PARAMS };
 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_THIRD_ORDER_DISSONANCE_PARAMS = {
+    ...SETHARES_DISSONANCE_PARAMS,
+    magnitude: 0.5,
+    magnitudeFrequencyDecay: 0,
+    phantomNotchDepth: 1,
+};
 export const DEFAULT_PHANTOM_HARMONICS_NUMBER = 3;

package/dist/lib/utils.d.ts

@@ -3,6 +3,8 @@ import type { DissonanceParams, SetharesDissonanceParams } from "./types";
 import type { HarmonicWithLoudness } from "../classes/private/HarmonicWithLoudness";
 import { SpectrumWithLoudness } from "../classes/private/SpectrumWithLoudness";
 export { getLoudness } from "./loudness";
+export declare function getExponentialMagnitudeDecayFactor(minFrequency: number, decay: number): number;
+export declare function getGaussianNotchMagnitudeDecayFactor(maxFrequency: number, depth: number): number;
 /** The formula to calculate sensory dissoannce proposed by Sethares in the appendix "How to Draw Dissonance Curves" */
 export declare function getPlompLeveltDissonance(h1: Harmonic, h2: Harmonic, params: SetharesDissonanceParams): number;
 /**

package/dist/lib/utils.js

@@ -2,6 +2,21 @@ import { DEFAULT_FIRST_ORDER_DISSONANCE_PARAMS, DEFAULT_SECOND_ORDER_DISSONANCE_
 import { getLoudness } from "./loudness";
 import { SpectrumWithLoudness } from "../classes/private/SpectrumWithLoudness";
 export { getLoudness } from "./loudness";
+export function getExponentialMagnitudeDecayFactor(minFrequency, decay) {
+    return Math.exp(-decay * (minFrequency / 1000));
+}
+/** Third-order (both phantom): log-Gaussian notch. Lower q = narrower notch. */
+const PHANTOM_NOTCH_CENTER_HZ = 880;
+const PHANTOM_NOTCH_Q = 0.75;
+/** Transposes notch for 2nd×3rd phantom pairs: 1760 Hz max → 880 Hz effective center. */
+const PHANTOM_NOTCH_FREQUENCY_MULTIPLIER = 2;
+export function getGaussianNotchMagnitudeDecayFactor(maxFrequency, depth) {
+    if (depth <= 0)
+        return 1;
+    const logRatio = Math.log(maxFrequency / (PHANTOM_NOTCH_CENTER_HZ * PHANTOM_NOTCH_FREQUENCY_MULTIPLIER));
+    const notchShape = Math.exp(-(logRatio ** 2) / (2 * PHANTOM_NOTCH_Q ** 2));
+    return 1 - depth * notchShape;
+}
 /** The formula to calculate sensory dissoannce proposed by Sethares in the appendix "How to Draw Dissonance Curves" */
 export function getPlompLeveltDissonance(h1, h2, params) {
     const magnitude = params?.magnitude ?? SETHARES_DISSONANCE_PARAMS.magnitude;
@@ -13,15 +28,18 @@ export function getPlompLeveltDissonance(h1, h2, params) {
     const b1 = params?.b1 ?? SETHARES_DISSONANCE_PARAMS.b1;
     const b2 = params?.b2 ?? SETHARES_DISSONANCE_PARAMS.b2;
     const magnitudeFrequencyDecay = params?.magnitudeFrequencyDecay ?? SETHARES_DISSONANCE_PARAMS.magnitudeFrequencyDecay;
+    const phantomNotchDepth = params?.phantomNotchDepth ?? SETHARES_DISSONANCE_PARAMS.phantomNotchDepth;
     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));
     if (minLoudness <= 0)
         return 0;
     const minFrequency = Math.min(h1.frequencyNum, h2.frequencyNum);
+    const maxFrequency = Math.max(h1.frequencyNum, h2.frequencyNum);
     if (minFrequency <= 0)
         return 0;
-    const magnitudeDecayFactor = Math.exp(-magnitudeFrequencyDecay * (minFrequency / 1000));
+    const magnitudeDecayFactor = getExponentialMagnitudeDecayFactor(minFrequency, magnitudeFrequencyDecay) *
+        getGaussianNotchMagnitudeDecayFactor(maxFrequency, phantomNotchDepth);
     const frequencyDifference = Math.abs(h1.frequencyNum - h2.frequencyNum);
     const s = x_star / (s1 * minFrequency + s2);
     return (magnitude *

package/dist/manual-testing/decay-factors.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/manual-testing/decay-factors.js

@@ -0,0 +1,20 @@
+import { DEFAULT_SECOND_ORDER_DISSONANCE_PARAMS, DEFAULT_THIRD_ORDER_DISSONANCE_PARAMS } from "../lib/const";
+import { getExponentialMagnitudeDecayFactor, getGaussianNotchMagnitudeDecayFactor, } from "../lib/utils";
+const exponentialDecay = DEFAULT_SECOND_ORDER_DISSONANCE_PARAMS.magnitudeFrequencyDecay;
+const notchDepth = DEFAULT_THIRD_ORDER_DISSONANCE_PARAMS.phantomNotchDepth;
+const frequencies = new Set();
+for (let f = 50; f <= 2000; f += 10) {
+    frequencies.add(f);
+}
+for (const f of [147, 440, 880, 1320, 1760]) {
+    frequencies.add(f);
+}
+const sortedFrequencies = [...frequencies].sort((a, b) => a - b);
+const lines = ["max_frequency_hz,exponential,gaussian_notch,combined_third_order"];
+for (const frequency of sortedFrequencies) {
+    const exponential = getExponentialMagnitudeDecayFactor(frequency, exponentialDecay);
+    const gaussianNotch = getGaussianNotchMagnitudeDecayFactor(frequency, notchDepth);
+    const combined = exponential * gaussianNotch;
+    lines.push(`${frequency},${exponential},${gaussianNotch},${combined}`);
+}
+Bun.write("./manual-testing/decay-factors.csv", lines.join("\n"));

package/dist/manual-testing/index.js

@@ -1,16 +1,41 @@
 import { Spectrum } from "tuning-core";
 import { DissonanceCurve } from "../classes";
-const context = Spectrum.harmonic(1, 440);
-const complement = Spectrum.harmonic(1, 440);
-const curve = new DissonanceCurve({
-    context,
-    complement,
+const spectrum_140 = Spectrum.harmonic(1, 140);
+const spectrum_440 = Spectrum.harmonic(1, 440);
+const spectrum_1320 = Spectrum.harmonic(1, 1320);
+const curve_140 = new DissonanceCurve({
+    context: spectrum_140,
+    complement: spectrum_140.clone(),
     start: 1,
     end: 2,
     firstOrderDissonance: { magnitude: 1 },
     secondOrderDissonance: { magnitude: 0.3 },
     thirdOrderDissonance: { magnitude: 0.1 },
-    phantomHarmonicsNumber: 2,
-    maxGapCents: 20,
+    phantomHarmonicsNumber: 3,
+    maxGapCents: 1,
 });
-Bun.write("./manual-testing/curve.csv", curve.normalize().toCsvFileBuffer());
+const curve_440 = new DissonanceCurve({
+    context: spectrum_440,
+    complement: spectrum_440.clone(),
+    start: 1,
+    end: 2,
+    firstOrderDissonance: { magnitude: 1 },
+    secondOrderDissonance: { magnitude: 0.3 },
+    thirdOrderDissonance: { magnitude: 0.1 },
+    phantomHarmonicsNumber: 3,
+    maxGapCents: 1,
+});
+const curve_1320 = new DissonanceCurve({
+    context: spectrum_1320,
+    complement: spectrum_1320.clone(),
+    start: 1,
+    end: 2,
+    firstOrderDissonance: { magnitude: 1 },
+    secondOrderDissonance: { magnitude: 0.3 },
+    thirdOrderDissonance: { magnitude: 0.1 },
+    phantomHarmonicsNumber: 3,
+    maxGapCents: 1,
+});
+Bun.write("./manual-testing/curve_140.csv", curve_140.normalize().toCsvFileBuffer());
+Bun.write("./manual-testing/curve_440.csv", curve_440.normalize().toCsvFileBuffer());
+Bun.write("./manual-testing/curve_1320.csv", curve_1320.normalize().toCsvFileBuffer());

package/dist/test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test.js

@@ -0,0 +1,17 @@
+import { Spectrum } from "tuning-core";
+import { SpectrumWithLoudness } from "./classes/private/SpectrumWithLoudness";
+import { getIntrinsicDissonance } from "./lib";
+const harmonic = SpectrumWithLoudness.harmonic(6, 261.63);
+const stretchedOld = SpectrumWithLoudness.fromFrequencies([
+    261.63, 544.851, 835.837, 1134.665, 1448.987, 1740.652
+], [
+    1, 0.560, 0.4, 0.314, 0.259, 0.224
+]);
+const stretchedNew = Spectrum.stretched(6, 261.63, 544.851 / 261.63);
+const phantomHarmonics = SpectrumWithLoudness.harmonic(3, 1, true);
+const harmonicDissonance = getIntrinsicDissonance(harmonic.mul(phantomHarmonics));
+const stretchedOldDissonance = getIntrinsicDissonance(stretchedOld.mul(phantomHarmonics));
+const stretchedNewDissonance = getIntrinsicDissonance(stretchedOld.mul(phantomHarmonics));
+console.log('stretchedNewDissonance', stretchedNewDissonance);
+console.log('stretchedOldDissonance', stretchedOldDissonance);
+console.log('harmonicDissonance', harmonicDissonance);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sethares-dissonance",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "type": "module",
   "devDependencies": {
     "@types/bun": "latest"
@@ -21,6 +21,6 @@
   },
   "dependencies": {
     "fraction.js": "^5.3.4",
-    "tuning-core": "^1.2.0"
+    "tuning-core": "^1.5.2"
   }
 }