@sudobility/music_codecs 0.1.1

package/dist/test/platform.js

@@ -0,0 +1,191 @@
+/**
+ * The platform pieces these tests need, owned here.
+ *
+ * They used to come from `@sudobility/music_io/mocks`, which made the codecs
+ * package depend on the platform package for tests alone — a restricted
+ * dependency, in the wrong direction, that dragged in `@tonejs/midi`
+ * transitively and failed the moment it was not installed beside it.
+ *
+ * **This file is test scaffolding and is never shipped.** `@tonejs/midi` is on
+ * `__architecture.test.ts`'s forbidden list for the package's own source, and
+ * rightly: `music_api` and `music_lib` both consume this package, so it takes
+ * its codecs by injection rather than implementing them. A test still needs a
+ * real one to round-trip bytes, which is what this provides.
+ *
+ * XML is `jsdom`, already a dev dependency. `XmlElement` is satisfied
+ * *structurally* by a DOM element — five members, chosen so a real parser needs
+ * no adapter — so that half is a parse call and an error check.
+ */
+import { JSDOM } from 'jsdom';
+import { XmlParseError } from '@sudobility/music_types';
+import * as midiModule from '@tonejs/midi';
+/**
+ * `@tonejs/midi` publishes CommonJS as `main` and ESM only via `module`, with
+ * no `exports` map — so whether a named import works depends entirely on which
+ * build the resolver picked. Bun and Vite pick the ESM build and a named import
+ * is fine; Node's ESM loader takes `main` and cannot always detect the named
+ * exports of a bundled CommonJS file, which fails at import time with
+ * "Named export 'Midi' not found".
+ *
+ * Reading the constructor off the namespace instead works under every resolver.
+ * This is the concrete cost of the one CommonJS dependency in the family.
+ */
+const namespace = midiModule;
+const Midi = namespace.Midi ?? namespace.default?.Midi ?? missingMidi();
+function missingMidi() {
+    throw new Error('@tonejs/midi did not export Midi under any known module shape.');
+}
+function controlChangesFor(track) {
+    return Object.fromEntries(Object.entries(track.controlChanges).map(([number, events]) => [
+        Number(number),
+        (events ?? []).map((cc) => ({
+            number: cc.number,
+            ticks: cc.ticks,
+            value: cc.value,
+        })),
+    ]));
+}
+function isTickZeroSetupTrack(track) {
+    return (track.notes.length === 0 &&
+        track.durationTicks === 0 &&
+        Object.values(track.controlChanges).some(events => events.some(event => event.ticks === 0)));
+}
+/**
+ * Format-0 files sometimes decode through `@tonejs/midi` as alternating
+ * control-only setup tracks and note tracks. The setup track has the CC7/CC10
+ * values from the original channel, while the following note track has the
+ * program/channel but no controllers. Copy those tick-0 controllers forward so
+ * import/playback keeps the source mix.
+ */
+function withFormatZeroSetupControls(tracks) {
+    return tracks.map((track, index) => {
+        if (track.notes.length === 0)
+            return track;
+        const previous = tracks[index - 1];
+        if (!previous || !isTickZeroSetupTrack(previous))
+            return track;
+        const controlChanges = { ...track.controlChanges };
+        let changed = false;
+        for (const [number, events] of Object.entries(previous.controlChanges)) {
+            const ccNumber = Number(number);
+            if (controlChanges[ccNumber]?.length)
+                continue;
+            controlChanges[ccNumber] = events;
+            changed = true;
+        }
+        return changed ? { ...track, controlChanges } : track;
+    });
+}
+/** The same encoding the platform packages ship, so round trips are real. */
+class ToneJsMidiCodec {
+    decode(data) {
+        const midi = new Midi(data);
+        const tracks = midi.tracks.map((track) => ({
+            name: track.name,
+            channel: track.channel,
+            instrument: {
+                number: track.instrument.number,
+                name: track.instrument.name,
+            },
+            notes: track.notes.map(note => ({
+                midi: note.midi,
+                ticks: note.ticks,
+                durationTicks: note.durationTicks,
+                velocity: note.velocity,
+            })),
+            // Kept keyed by CC number: the importer looks up sustain (64),
+            // volume (7) and pan (10) directly, and flattening them here would
+            // lose volume and pan silently.
+            controlChanges: controlChangesFor(track),
+            durationTicks: track.durationTicks,
+            durationSeconds: track.duration,
+        }));
+        return {
+            header: {
+                ppq: midi.header.ppq,
+                name: midi.header.name,
+                tempos: midi.header.tempos.map(tempo => ({
+                    ticks: tempo.ticks,
+                    bpm: tempo.bpm,
+                })),
+                timeSignatures: midi.header.timeSignatures.map(signature => ({
+                    ticks: signature.ticks,
+                    timeSignature: [
+                        signature.timeSignature[0],
+                        signature.timeSignature[1],
+                    ],
+                })),
+            },
+            tracks: withFormatZeroSetupControls(tracks),
+            duration: midi.duration,
+        };
+    }
+    encode(file) {
+        const midi = new Midi();
+        midi.header.fromJSON({
+            name: file.header.name ?? '',
+            ppq: file.header.ppq,
+            meta: [],
+            tempos: file.header.tempos.map(tempo => ({
+                ticks: tempo.ticks,
+                bpm: tempo.bpm,
+            })),
+            timeSignatures: file.header.timeSignatures.map(signature => ({
+                ticks: signature.ticks,
+                timeSignature: signature.timeSignature,
+            })),
+            keySignatures: [],
+        });
+        for (const track of file.tracks) {
+            const midiTrack = midi.addTrack();
+            midiTrack.name = track.name;
+            midiTrack.channel = track.channel;
+            midiTrack.instrument.number = track.instrument.number;
+            for (const events of Object.values(track.controlChanges)) {
+                for (const cc of events) {
+                    midiTrack.addCC({
+                        number: cc.number,
+                        ticks: cc.ticks,
+                        value: cc.value,
+                    });
+                }
+            }
+            for (const note of track.notes) {
+                midiTrack.addNote({
+                    midi: note.midi,
+                    ticks: note.ticks,
+                    durationTicks: note.durationTicks,
+                    velocity: note.velocity,
+                });
+            }
+        }
+        return midi.toArray();
+    }
+}
+/** The real MIDI codec. Encoding is pure byte manipulation, so nothing is faked. */
+export function testMidiCodec() {
+    return new ToneJsMidiCodec();
+}
+/**
+ * A real XML parser, via jsdom.
+ *
+ * `DOMParser` reports malformed input by returning a document rooted at
+ * `<parsererror>` rather than by throwing, so that is checked explicitly —
+ * otherwise a broken document reads as a successful parse of a strange element.
+ */
+export function testXmlParser() {
+    return {
+        parse(text) {
+            const { window } = new JSDOM('');
+            const doc = new window.DOMParser().parseFromString(text, 'application/xml');
+            const root = doc.documentElement;
+            if (!root ||
+                root.tagName === 'parsererror' ||
+                root.getElementsByTagName('parsererror').length > 0) {
+                throw new XmlParseError('Malformed XML');
+            }
+            return root;
+        },
+    };
+}
+//# sourceMappingURL=platform.js.map

package/dist/test/platform.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"platform.js","sourceRoot":"","sources":["../../src/test/platform.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAExD,OAAO,KAAK,UAAU,MAAM,cAAc,CAAC;AAW3C;;;;;;;;;;GAUG;AACH,MAAM,SAAS,GAAG,UAGjB,CAAC;AACF,MAAM,IAAI,GACR,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC,OAAO,EAAE,IAAI,IAAI,WAAW,EAAE,CAAC;AAE7D,SAAS,WAAW;IAClB,MAAM,IAAI,KAAK,CACb,gEAAgE,CACjE,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CACxB,KAAoB;IAEpB,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC;QAC7D,MAAM,CAAC,MAAM,CAAC;QACd,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAqB,EAAE,CAAC,CAAC;YAC7C,MAAM,EAAE,EAAE,CAAC,MAAM;YACjB,KAAK,EAAE,EAAE,CAAC,KAAK;YACf,KAAK,EAAE,EAAE,CAAC,KAAK;SAChB,CAAC,CAAC;KACJ,CAAC,CACH,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAoB;IAChD,OAAO,CACL,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;QACxB,KAAK,CAAC,aAAa,KAAK,CAAC;QACzB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAChD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,CAAC,CAAC,CACxC,CACF,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,SAAS,2BAA2B,CAAC,MAAuB;IAC1D,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;QACjC,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;QAE3C,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QACnC,IAAI,CAAC,QAAQ,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC;YAAE,OAAO,KAAK,CAAC;QAE/D,MAAM,cAAc,GAAG,EAAE,GAAG,KAAK,CAAC,cAAc,EAAE,CAAC;QACnD,IAAI,OAAO,GAAG,KAAK,CAAC;QACpB,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YACvE,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;YAChC,IAAI,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM;gBAAE,SAAS;YAC/C,cAAc,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;YAClC,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;QAED,OAAO,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IACxD,CAAC,CAAC,CAAC;AACL,CAAC;AAED,6EAA6E;AAC7E,MAAM,eAAe;IACnB,MAAM,CAAC,IAAiB;QACtB,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAiB,EAAE,CAAC,CAAC;YACxD,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,UAAU,EAAE;gBACV,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,MAAM;gBAC/B,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,IAAI;aAC5B;YACD,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAC9B,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,aAAa,EAAE,IAAI,CAAC,aAAa;gBACjC,QAAQ,EAAE,IAAI,CAAC,QAAQ;aACxB,CAAC,CAAC;YACH,+DAA+D;YAC/D,mEAAmE;YACnE,gCAAgC;YAChC,cAAc,EAAE,iBAAiB,CAAC,KAAK,CAAC;YACxC,aAAa,EAAE,KAAK,CAAC,aAAa;YAClC,eAAe,EAAE,KAAK,CAAC,QAAQ;SAChC,CAAC,CAAC,CAAC;QAEJ,OAAO;YACL,MAAM,EAAE;gBACN,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG;gBACpB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;gBACtB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;oBACvC,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,GAAG,EAAE,KAAK,CAAC,GAAG;iBACf,CAAC,CAAC;gBACH,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;oBAC3D,KAAK,EAAE,SAAS,CAAC,KAAK;oBACtB,aAAa,EAAE;wBACb,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;wBAC1B,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;qBACP;iBACtB,CAAC,CAAC;aACJ;YACD,MAAM,EAAE,2BAA2B,CAAC,MAAM,CAAC;YAC3C,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,IAAc;QACnB,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;YACnB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,EAAE;YAC5B,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG;YACpB,IAAI,EAAE,EAAE;YACR,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACvC,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,GAAG,EAAE,KAAK,CAAC,GAAG;aACf,CAAC,CAAC;YACH,cAAc,EAAE,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;gBAC3D,KAAK,EAAE,SAAS,CAAC,KAAK;gBACtB,aAAa,EAAE,SAAS,CAAC,aAAa;aACvC,CAAC,CAAC;YACH,aAAa,EAAE,EAAE;SAClB,CAAC,CAAC;QAEH,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClC,SAAS,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;YAC5B,SAAS,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;YAClC,SAAS,CAAC,UAAU,CAAC,MAAM,GAAG,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC;YACtD,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,CAAC;gBACzD,KAAK,MAAM,EAAE,IAAI,MAAM,EAAE,CAAC;oBACxB,SAAS,CAAC,KAAK,CAAC;wBACd,MAAM,EAAE,EAAE,CAAC,MAAM;wBACjB,KAAK,EAAE,EAAE,CAAC,KAAK;wBACf,KAAK,EAAE,EAAE,CAAC,KAAK;qBAChB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YACD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;gBAC/B,SAAS,CAAC,OAAO,CAAC;oBAChB,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,aAAa,EAAE,IAAI,CAAC,aAAa;oBACjC,QAAQ,EAAE,IAAI,CAAC,QAAQ;iBACxB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;CACF;AAED,oFAAoF;AACpF,MAAM,UAAU,aAAa;IAC3B,OAAO,IAAI,eAAe,EAAE,CAAC;AAC/B,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO;QACL,KAAK,CAAC,IAAY;YAChB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC,CAAC;YACjC,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC,eAAe,CAChD,IAAI,EACJ,iBAAiB,CAClB,CAAC;YACF,MAAM,IAAI,GAAG,GAAG,CAAC,eAAe,CAAC;YACjC,IACE,CAAC,IAAI;gBACL,IAAI,CAAC,OAAO,KAAK,aAAa;gBAC9B,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC,EACnD,CAAC;gBACD,MAAM,IAAI,aAAa,CAAC,eAAe,CAAC,CAAC;YAC3C,CAAC;YACD,OAAO,IAA6B,CAAC;QACvC,CAAC;KACF,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@sudobility/music_codecs",
+  "version": "0.1.1",
+  "description": "Score encoders and decoders for ScoreSmith - MIDI, MusicXML and tracker modules. Shared by frontend and backend; no UI, no audio, no platform.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.esm.json",
+    "clean": "rimraf dist",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint src",
+    "format": "prettier --write src/**/*.ts",
+    "format:check": "prettier --check src/**/*.ts",
+    "typecheck": "tsc --noEmit",
+    "verify": "bun run format:check && bun run typecheck && bun run lint && bun run test && bun run build",
+    "prepublishOnly": "bun run clean && bun run verify"
+  },
+  "files": [
+    "dist/**/*",
+    "CLAUDE.md"
+  ],
+  "keywords": [
+    "typescript",
+    "music",
+    "midi",
+    "musicxml",
+    "tracker",
+    "scoresmith",
+    "codec"
+  ],
+  "author": "Sudobility",
+  "license": "BUSL-1.1",
+  "peerDependencies": {
+    "@sudobility/music_types": "^0.11.22"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.38.0",
+    "@sudobility/music_types": "^0.11.22",
+    "@sudobility/types": "^1.9.65",
+    "@tonejs/midi": "^2.0.28",
+    "@types/jsdom": "^30.0.0",
+    "@typescript-eslint/eslint-plugin": "^8.46.2",
+    "@typescript-eslint/parser": "^8.46.2",
+    "eslint": "^9.38.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "globals": "^16.4.0",
+    "jsdom": "^25.0.0",
+    "prettier": "^3.6.2",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.15"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/johnqh/music_codecs.git"
+  },
+  "dependencies": {}
+}