sethares-dissonance 0.1.2 → 0.2.0

package/dist/classes/DissonanceCurve.d.ts

@@ -0,0 +1,23 @@
+import { SETHARES_DISSONANCE_PARAMS, type SpectrumPartial } from "../lib";
+export type DissonanceCurveOptions = Partial<typeof SETHARES_DISSONANCE_PARAMS> & {
+    context: SpectrumPartial[];
+    complement: SpectrumPartial[];
+    step?: number;
+    rangeMin?: number;
+    rangeMax?: number;
+};
+export declare class DissonanceCurve {
+    private _data;
+    readonly rangeMin: NonNullable<DissonanceCurveOptions["rangeMin"]>;
+    readonly rangeMax: NonNullable<DissonanceCurveOptions["rangeMax"]>;
+    readonly step: NonNullable<DissonanceCurveOptions["step"]>;
+    readonly context: DissonanceCurveOptions["context"];
+    readonly complement: DissonanceCurveOptions["complement"];
+    readonly maxDissonance: number;
+    readonly change: number;
+    constructor(opts: DissonanceCurveOptions);
+    get points(): [number, number][];
+    get(cent: number): number | undefined;
+    private getRowString;
+    toFileString(): string;
+}

package/dist/classes/DissonanceCurve.js

@@ -0,0 +1,57 @@
+import { getSetharesDissonance, SETHARES_DISSONANCE_PARAMS, transpose } from "../lib";
+export class DissonanceCurve {
+    _data = new Map();
+    rangeMin;
+    rangeMax;
+    step;
+    context;
+    complement;
+    maxDissonance = 0;
+    change = 0;
+    constructor(opts) {
+        const { context, complement, rangeMin, rangeMax, step, ...dissonanceParams } = opts;
+        this.context = context;
+        this.complement = complement;
+        this.rangeMin = rangeMin ?? 0;
+        this.rangeMax = rangeMax ?? 1200;
+        this.step = step ?? 1;
+        if (this.rangeMin > this.rangeMax)
+            throw Error("rangeMin should be less or equal to rangeMax");
+        if (this.step <= 0)
+            throw Error("precision should be greater than zero");
+        for (let cent = this.rangeMin; cent <= this.rangeMax; cent += this.step) {
+            const dissonance = getSetharesDissonance(this.context, transpose(this.complement, cent), dissonanceParams);
+            if (dissonance > this.maxDissonance)
+                this.maxDissonance = dissonance;
+            this._data.set(cent, dissonance);
+        }
+    }
+    get points() {
+        return Array.from(this._data.entries()).sort((a, b) => a[0] - b[0]);
+    }
+    get(cent) {
+        return this._data.get(cent);
+    }
+    getRowString(row) {
+        if (row.length === 0)
+            return "";
+        let result = `${row[0]}`;
+        for (let i = 1; i < row.length; i += 1) {
+            result += `\t${row[i]}`;
+        }
+        return result;
+    }
+    toFileString() {
+        if (this._data.size === 0)
+            return "";
+        const headerRow = this.getRowString([
+            "Interval (cents)",
+            "Sensory dissonance",
+        ]);
+        let result = headerRow + "\n";
+        for (const point of this.points) {
+            result += this.getRowString(point);
+        }
+        return result;
+    }
+}

package/dist/classes/index.d.ts

@@ -0,0 +1 @@
+export * from "./DissonanceCurve";

package/dist/classes/index.js

@@ -0,0 +1 @@
+export * from "./DissonanceCurve";

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./classes";
+export * from "./lib";

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./classes";
+export * from "./lib";

package/dist/lib/index.d.ts

@@ -0,0 +1 @@
+export * from "./utils";

package/dist/lib/index.js

@@ -0,0 +1 @@
+export * from "./utils";

package/dist/lib/utils.d.ts

@@ -0,0 +1,32 @@
+export type SpectrumPartial = {
+    rate: number;
+    amplitude: number;
+    phase?: number;
+};
+/**
+ * The formula to calculate loudness from amplitude. The converstion to SPL (phons) is done according to Sethares in the appendix "How to Draw Dissonance Curves". The converstion to loudness is done according to https://sengpielaudio.com/calculatorSonephon.htm
+ * @param {number} amplitude - the normalized peak value where 0.001 corresponds to SPL of 40 db or 1 sone and 1 to SPL of 100db and 64 sones. Normalisation is done for the simplicity of providing harmonic spectrum with amplitudes 1, 1/2, 1/3, ...
+ */
+export declare function getLoudness(amplitude: number): number;
+/** Fitting parameters proposed by Sethares in the appendix "How to Draw Dissonance Curves" */
+export declare const SETHARES_DISSONANCE_PARAMS: {
+    s1: number;
+    s2: number;
+    b1: number;
+    b2: number;
+    x_star: number;
+};
+export type SetharesDissonanceParams = Partial<typeof SETHARES_DISSONANCE_PARAMS>;
+/** The formula to calculate sensory dissoannce proposed by Sethares in the appendix "How to Draw Dissonance Curves" */
+export declare function getPlompLeveltDissonance(partial1: SpectrumPartial, partial2: SpectrumPartial, params?: {
+    s1: number;
+    s2: number;
+    b1: number;
+    b2: number;
+    x_star: number;
+}): number;
+export declare function getIntrinsicDissonance(spectrum: SpectrumPartial[], params?: SetharesDissonanceParams): number;
+export declare function getSetharesDissonance(spectrum1: SpectrumPartial[], spectrum2: SpectrumPartial[], params?: SetharesDissonanceParams): number;
+export declare function ratioToCents(ratio: number): number;
+export declare function centsToRatio(cents: number): number;
+export declare function transpose(partials: SpectrumPartial[], cents: number): SpectrumPartial[];

package/dist/lib/utils.js

@@ -0,0 +1,85 @@
+const NORMALISATION_PRESSURE_UNIT = 2.8284271247461905;
+/**
+ * The formula to calculate loudness from amplitude. The converstion to SPL (phons) is done according to Sethares in the appendix "How to Draw Dissonance Curves". The converstion to loudness is done according to https://sengpielaudio.com/calculatorSonephon.htm
+ * @param {number} amplitude - the normalized peak value where 0.001 corresponds to SPL of 40 db or 1 sone and 1 to SPL of 100db and 64 sones. Normalisation is done for the simplicity of providing harmonic spectrum with amplitudes 1, 1/2, 1/3, ...
+ */
+export function getLoudness(amplitude) {
+    const rms = amplitude / Math.SQRT2;
+    const pressure = rms * NORMALISATION_PRESSURE_UNIT;
+    const referencePressure = 2e-5;
+    const phons = 20 * Math.log10(pressure / referencePressure);
+    if (phons < 8)
+        return 0;
+    if (phons < 40)
+        return Math.pow(phons / 40, 2.86) - 0.005;
+    return Math.pow(2, (phons - 40) / 10);
+}
+/** Fitting parameters proposed by Sethares in the appendix "How to Draw Dissonance Curves" */
+export const SETHARES_DISSONANCE_PARAMS = {
+    s1: 0.021,
+    s2: 19,
+    b1: 3.5,
+    b2: 5.75,
+    x_star: 0.24,
+};
+/** The formula to calculate sensory dissoannce proposed by Sethares in the appendix "How to Draw Dissonance Curves" */
+export function getPlompLeveltDissonance(partial1, partial2, params = SETHARES_DISSONANCE_PARAMS) {
+    if (partial1.rate === partial2.rate)
+        return 0;
+    const minLoudness = Math.min(getLoudness(partial1.amplitude), getLoudness(partial2.amplitude));
+    if (minLoudness <= 0)
+        return 0;
+    const minFrequency = Math.min(partial1.rate, partial2.rate);
+    const frequencyDifference = Math.abs(partial1.rate - partial2.rate);
+    if (minFrequency <= 0)
+        return 0;
+    const s = params.x_star / (params.s1 * minFrequency + params.s2);
+    return (minLoudness *
+        (Math.exp(-1 * params.b1 * s * frequencyDifference) -
+            Math.exp(-1 * params.b2 * s * frequencyDifference)));
+}
+export function getIntrinsicDissonance(spectrum, params) {
+    let dissonance = 0;
+    for (let i = 0; i < spectrum.length; i++) {
+        for (let j = i + 1; j < spectrum.length; j++) {
+            const partial1 = spectrum[i];
+            const partial2 = spectrum[j];
+            dissonance += getPlompLeveltDissonance(partial1, partial2, {
+                ...SETHARES_DISSONANCE_PARAMS,
+                ...params,
+            });
+        }
+    }
+    return dissonance;
+}
+export function getSetharesDissonance(spectrum1, spectrum2, params) {
+    let dissonance = getIntrinsicDissonance(spectrum1, params) +
+        getIntrinsicDissonance(spectrum2, params);
+    for (let i = 0; i < spectrum1.length; i++) {
+        for (let j = 0; j < spectrum2.length; j++) {
+            const partial1 = spectrum1[i];
+            const partial2 = spectrum2[j];
+            dissonance += getPlompLeveltDissonance(partial1, partial2, {
+                ...SETHARES_DISSONANCE_PARAMS,
+                ...params,
+            });
+        }
+    }
+    return dissonance;
+}
+export function ratioToCents(ratio) {
+    return ratio > 0 ? 1200 * Math.log2(ratio) : 0;
+}
+export function centsToRatio(cents) {
+    return Math.pow(2, cents / 1200);
+}
+export function transpose(partials, cents) {
+    const result = [];
+    for (const partial of partials) {
+        result.push({
+            rate: partial.rate * centsToRatio(cents),
+            amplitude: partial.amplitude,
+        });
+    }
+    return result;
+}

package/dist/tests/utils.test.d.ts

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

package/dist/tests/utils.test.js

@@ -0,0 +1,16 @@
+import { expect, test, describe } from "bun:test";
+import * as Utils from "../lib/utils";
+import { DissonanceCurve } from "../classes";
+describe("lib/utils", () => {
+    test("Should calculate loudness", () => {
+        const amplitudes = [1, 0.001, 0.000025];
+        const expectedOutcome = [64, 1, 0];
+        expect(amplitudes.map(Utils.getLoudness)).toEqual(expectedOutcome);
+    });
+});
+describe("classes/DissoannceCurve", () => {
+    test("Should construct Dissoancne curve", () => {
+        const curve = new DissonanceCurve({ context: [], complement: [] });
+        expect(curve).toBeInstanceOf(DissonanceCurve);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sethares-dissonance",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "module": "index.ts",
   "type": "module",
   "devDependencies": {
@@ -8,5 +8,11 @@
   },
   "peerDependencies": {
     "typescript": "^5"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": ["./dist"],
+  "scripts": {
+    "build": "npx tsc"
   }
 }

package/classes/DissonanceCurve.ts

@@ -1,99 +0,0 @@
-import {
-  getSetharesDissonance,
-  SETHARES_DISSONANCE_PARAMS,
-  transpose,
-} from "../lib";
-import type { SpectrumPartial } from "../lib";
-
-export type DissonanceCurveOptions = Partial<
-  typeof SETHARES_DISSONANCE_PARAMS
-> & {
-  context: SpectrumPartial[];
-  complement: SpectrumPartial[];
-  step?: number;
-  rangeMin?: number;
-  rangeMax?: number;
-};
-
-export class DissonanceCurve {
-  private _data: Map<number, number> = new Map();
-
-  public readonly rangeMin: NonNullable<DissonanceCurveOptions["rangeMin"]>;
-  public readonly rangeMax: NonNullable<DissonanceCurveOptions["rangeMax"]>;
-  public readonly step: NonNullable<DissonanceCurveOptions["step"]>;
-  public readonly context: DissonanceCurveOptions["context"];
-  public readonly complement: DissonanceCurveOptions["complement"];
-  public readonly maxDissonance: number = 0;
-  public readonly change: number = 0;
-
-  constructor(opts: DissonanceCurveOptions) {
-    const {
-      context,
-      complement,
-      rangeMin,
-      rangeMax,
-      step,
-      ...dissonanceParams
-    } = opts;
-
-    this.context = context;
-    this.complement = complement;
-
-    this.rangeMin = rangeMin ?? 0;
-    this.rangeMax = rangeMax ?? 1200;
-    this.step = step ?? 1;
-
-    if (this.rangeMin > this.rangeMax)
-      throw Error("rangeMin should be less or equal to rangeMax");
-    if (this.step <= 0) throw Error("precision should be greater than zero");
-
-    for (let cent = this.rangeMin; cent <= this.rangeMax; cent += this.step) {
-      const dissonance = getSetharesDissonance(
-        this.context,
-        transpose(this.complement, cent),
-        dissonanceParams
-      );
-
-      if (dissonance > this.maxDissonance) this.maxDissonance = dissonance;
-
-      this._data.set(cent, dissonance);
-    }
-  }
-
-  public get points() {
-    return Array.from(this._data.entries()).sort((a, b) => a[0] - b[0]);
-  }
-
-  public get(cent: number) {
-    return this._data.get(cent);
-  }
-
-  private getRowString(row: Array<number | string>) {
-    if (row.length === 0) return "";
-
-    let result = `${row[0]}`;
-
-    for (let i = 1; i < row.length; i += 1) {
-      result += `\t${row[i]}`;
-    }
-
-    return result;
-  }
-
-  public toFileString() {
-    if (this._data.size === 0) return "";
-
-    const headerRow = this.getRowString([
-      "Interval (cents)",
-      "Sensory dissonance",
-    ]);
-
-    let result = headerRow + "\n";
-
-    for (const point of this.points) {
-      result += this.getRowString(point);
-    }
-
-    return result;
-  }
-}

package/classes/index.ts

@@ -1 +0,0 @@
-export * from "./DissonanceCurve"

package/index.ts

@@ -1,2 +0,0 @@
-export * from "./classes"
-export * from "./lib"

package/lib/index.ts

@@ -1 +0,0 @@
-export * from "./utils"

package/lib/utils.ts

@@ -1,130 +0,0 @@
-export type SpectrumPartial = {
-  rate: number;
-  amplitude: number;
-  phase?: number;
-};
-
-const NORMALISATION_PRESSURE_UNIT = 2.8284271247461905;
-
-/**
- * The formula to calculate loudness from amplitude. The converstion to SPL (phons) is done according to Sethares in the appendix "How to Draw Dissonance Curves". The converstion to loudness is done according to https://sengpielaudio.com/calculatorSonephon.htm
- * @param {number} amplitude - the normalized peak value where 0.001 corresponds to SPL of 40 db or 1 sone and 1 to SPL of 100db and 64 sones. Normalisation is done for the simplicity of providing harmonic spectrum with amplitudes 1, 1/2, 1/3, ...
- */
-export function getLoudness(amplitude: number): number {
-  const rms = amplitude / Math.SQRT2;
-  const pressure = rms * NORMALISATION_PRESSURE_UNIT;
-  const referencePressure = 2e-5;
-
-  const phons = 20 * Math.log10(pressure / referencePressure);
-
-  if (phons < 8) return 0;
-  if (phons < 40) return Math.pow(phons / 40, 2.86) - 0.005;
-  return Math.pow(2, (phons - 40) / 10);
-}
-
-/** Fitting parameters proposed by Sethares in the appendix "How to Draw Dissonance Curves" */
-export const SETHARES_DISSONANCE_PARAMS = {
-  s1: 0.021,
-  s2: 19,
-  b1: 3.5,
-  b2: 5.75,
-  x_star: 0.24,
-};
-
-export type SetharesDissonanceParams = Partial<
-  typeof SETHARES_DISSONANCE_PARAMS
->;
-
-/** The formula to calculate sensory dissoannce proposed by Sethares in the appendix "How to Draw Dissonance Curves" */
-export function getPlompLeveltDissonance(
-  partial1: SpectrumPartial,
-  partial2: SpectrumPartial,
-  params = SETHARES_DISSONANCE_PARAMS
-): number {
-  if (partial1.rate === partial2.rate) return 0;
-
-  const minLoudness = Math.min(
-    getLoudness(partial1.amplitude),
-    getLoudness(partial2.amplitude)
-  );
-  if (minLoudness <= 0) return 0;
-
-  const minFrequency = Math.min(partial1.rate, partial2.rate);
-  const frequencyDifference = Math.abs(partial1.rate - partial2.rate);
-
-  if (minFrequency <= 0) return 0;
-
-  const s = params.x_star / (params.s1 * minFrequency + params.s2);
-
-  return (
-    minLoudness *
-    (Math.exp(-1 * params.b1 * s * frequencyDifference) -
-      Math.exp(-1 * params.b2 * s * frequencyDifference))
-  );
-}
-
-export function getIntrinsicDissonance(
-  spectrum: SpectrumPartial[],
-  params?: SetharesDissonanceParams
-) {
-  let dissonance = 0;
-
-  for (let i = 0; i < spectrum.length; i++) {
-    for (let j = i + 1; j < spectrum.length; j++) {
-      const partial1 = spectrum[i]!;
-      const partial2 = spectrum[j]!;
-
-      dissonance += getPlompLeveltDissonance(partial1, partial2, {
-        ...SETHARES_DISSONANCE_PARAMS,
-        ...params,
-      });
-    }
-  }
-
-  return dissonance;
-}
-
-export function getSetharesDissonance(
-  spectrum1: SpectrumPartial[],
-  spectrum2: SpectrumPartial[],
-  params?: SetharesDissonanceParams
-) {
-  let dissonance =
-    getIntrinsicDissonance(spectrum1, params) +
-    getIntrinsicDissonance(spectrum2, params);
-
-  for (let i = 0; i < spectrum1.length; i++) {
-    for (let j = 0; j < spectrum2.length; j++) {
-      const partial1 = spectrum1[i]!;
-      const partial2 = spectrum2[j]!;
-
-      dissonance += getPlompLeveltDissonance(partial1, partial2, {
-        ...SETHARES_DISSONANCE_PARAMS,
-        ...params,
-      });
-    }
-  }
-
-  return dissonance;
-}
-
-export function ratioToCents(ratio: number): number {
-  return ratio > 0 ? 1200 * Math.log2(ratio) : 0;
-}
-
-export function centsToRatio(cents: number): number {
-  return Math.pow(2, cents / 1200);
-}
-
-export function transpose(partials: SpectrumPartial[], cents: number) {
-  const result: SpectrumPartial[] = [];
-
-  for (const partial of partials) {
-    result.push({
-      rate: partial.rate * centsToRatio(cents),
-      amplitude: partial.amplitude,
-    });
-  }
-
-  return result;
-}

package/tests/utils.test.ts

@@ -1,21 +0,0 @@
-import { expect, test, describe } from "bun:test";
-
-import * as Utils from "../lib/utils";
-import { DissonanceCurve } from "../classes";
-
-describe("lib/utils", () => {
-  test("Should calculate loudness", () => {
-    const amplitudes = [1, 0.001, 0.000025];
-    const expectedOutcome = [64, 1, 0];
-
-    expect(amplitudes.map(Utils.getLoudness)).toEqual(expectedOutcome);
-  });
-});
-
-describe("classes/DissoannceCurve", () => {
-  test("Should construct Dissoancne curve", () => {
-    const curve = new DissonanceCurve({context: [], complement: []})
-
-    expect(curve).toBeInstanceOf(DissonanceCurve);
-  });
-});

package/tsconfig.json

@@ -1,29 +0,0 @@
-{
-  "compilerOptions": {
-    // Environment setup & latest features
-    "lib": ["ESNext"],
-    "target": "ESNext",
-    "module": "Preserve",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false
-  }
-}