@modplayjs/fmt-mo3 0.0.0-stage → 0.2.2

package/README.md

@@ -1,3 +1,39 @@
-# Temporary Holding Version
+# @modplayjs/fmt-mo3
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**Un4seen MO3 container plugin** for `@modplayjs/core` — MO3 v1–v5
+wrapping XM/IT/S3M/MOD/MTM inner formats. Ported 1:1 from OpenMPT's
+`Load_mo3.cpp` plus unmo3's LZ depacker:
+
+- Container + Lempel-Ziv depacker: **byte-exact** vs the C reference
+- Uncompressed / delta / delta-prediction samples: exact decoders
+- **Ogg-compressed samples: bit-exact** via `@modplayjs/stb-vorbis`
+  (incl. MO3 v5 shared-Ogg-header remux)
+- MP3-compressed samples via the bundled minimp3 Layer-3 port (correct
+  playback; decoder-internal rounding differs from the C reference's
+  mpg123 path)
+- OpenMPT semantic glue: effTrans CMD table, envelope mapping, note
+  conventions, InstrumentSynth pitch mapping
+
+## Install
+
+```sh
+npm install @modplayjs/fmt-mo3
+```
+
+## Usage
+
+```ts
+import { CorePlayer } from '@modplayjs/core';
+import { plugin as mo3Plugin } from '@modplayjs/fmt-mo3';
+
+const core = new CorePlayer();
+core.registries.registerFormat(mo3Plugin);
+core.loadModule(bytes);   // .mo3 file
+```
+
+## Also exports
+
+`mp3decInit` / `mp3decDecodeFrame` — the raw minimp3 L3 decoder (used by
+`@modplayjs/stream-audio` for MP3 files).
+
+Part of the [modplayjs monorepo](../../README.md). BSD-3-Clause.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { mo3Test, mo3Load, plugin } from './mo3.js';
+export { mp3decInit, mp3decDecodeFrame, type Mp3Dec, type Mp3FrameInfo } from './minimp3.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEpD,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,KAAK,MAAM,EAAE,KAAK,YAAY,EAAE,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -0,0 +1,7 @@
+// SPDX-License-Identifier: BSD-3-Clause
+// Copyright (c) 2026 Bitti09 — modplayjs contributors
+// @modplayjs/fmt-mo3 — Un4seen MO3 container (XM/IT/S3M/MOD/MTM inner).
+export { mo3Test, mo3Load, plugin } from './mo3.js';
+// Shared MP3 decoder used by @modplayjs/stream-audio.
+export { mp3decInit, mp3decDecodeFrame } from './minimp3.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,wCAAwC;AACxC,sDAAsD;AACtD,wEAAwE;AAExE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACpD,sDAAsD;AACtD,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAkC,MAAM,cAAc,CAAC"}

package/dist/minimp3.d.ts

@@ -0,0 +1,18 @@
+export interface Mp3Dec {
+    mdctOverlap: Float32Array[];
+    qmfState: Float32Array;
+    reserv: number;
+    freeFormatBytes: number;
+    header: Uint8Array;
+    reservBuf: Uint8Array;
+}
+export declare function mp3decInit(dec: Mp3Dec): void;
+export interface Mp3FrameInfo {
+    frameBytes: number;
+    channels: number;
+    hz: number;
+    layer: number;
+    bitrateKbps: number;
+}
+export declare function mp3decDecodeFrame(dec: Mp3Dec, mp3: Uint8Array, mp3Bytes: number, pcm: Int16Array, info: Mp3FrameInfo): number;
+//# sourceMappingURL=minimp3.d.ts.map

package/dist/minimp3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"minimp3.d.ts","sourceRoot":"","sources":["../src/minimp3.ts"],"names":[],"mappings":"AAiMA,MAAM,WAAW,MAAM;IACrB,WAAW,EAAE,YAAY,EAAE,CAAC;IAC5B,QAAQ,EAAE,YAAY,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,UAAU,CAAC;IACnB,SAAS,EAAE,UAAU,CAAC;CACvB;AAED,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAO5C;AA+2BD,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY,GAAG,MAAM,CAiE7H"}