tetorica-fm2612 0.2.7 → 0.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (229) hide show
  1. package/README.md +39 -2
  2. package/adpcm_b_sample.d.ts +22 -0
  3. package/adpcm_b_sample.js +1 -0
  4. package/ay8910.d.ts +93 -0
  5. package/ay8910.js +1 -1
  6. package/ay8910audioengine.d.ts +81 -0
  7. package/ay8910audioengine.js +1 -0
  8. package/bitcrusher-worklet.d.ts +1 -0
  9. package/chip_pcm_renderer.d.ts +41 -0
  10. package/chip_pcm_renderer.js +1 -0
  11. package/chip_worklet_transport.d.ts +23 -0
  12. package/chip_worklet_transport.js +1 -0
  13. package/custom_fx.d.ts +15 -0
  14. package/gameboyapu.d.ts +85 -0
  15. package/gameboyapu.js +1 -1
  16. package/gameboyapuaudioengine.d.ts +81 -0
  17. package/gameboyapuaudioengine.js +1 -0
  18. package/gameboysynth.d.ts +52 -0
  19. package/gameboysynth.js +1 -0
  20. package/generated/ay8910_wasm.d.ts +2 -0
  21. package/generated/gameboy_apu_wasm.d.ts +2 -0
  22. package/generated/huc6280_wasm.d.ts +2 -0
  23. package/generated/k051649_wasm.d.ts +2 -0
  24. package/generated/nuked_opn2_wasm.d.ts +2 -0
  25. package/generated/okim6258_wasm.d.ts +2 -0
  26. package/generated/rf5c164_wasm.d.ts +2 -0
  27. package/generated/segapcm_wasm.d.ts +2 -0
  28. package/generated/segapsg_wasm.d.ts +2 -0
  29. package/generated/y8950_wasm.d.ts +2 -0
  30. package/generated/ym2151_wasm.d.ts +2 -0
  31. package/generated/ym2203_wasm.d.ts +2 -0
  32. package/generated/ym2413_wasm.d.ts +2 -0
  33. package/generated/ym2608_wasm.d.ts +2 -0
  34. package/generated/ym2610b_wasm.d.ts +2 -0
  35. package/generated/ym2612_wasm.d.ts +2 -0
  36. package/generated/ym3438_wasm.d.ts +2 -0
  37. package/generated/ym3526_wasm.d.ts +2 -0
  38. package/generated/ym3812_wasm.d.ts +2 -0
  39. package/generated/ymf262_wasm.d.ts +2 -0
  40. package/generated/ymf276_wasm.d.ts +2 -0
  41. package/generated/ymf278b_wasm.d.ts +2 -0
  42. package/generated/ymf288_wasm.d.ts +2 -0
  43. package/genesisaudioengine.d.ts +140 -0
  44. package/huc6280audioengine.d.ts +89 -0
  45. package/huc6280audioengine.js +1 -0
  46. package/k051649.d.ts +89 -0
  47. package/k051649.js +2 -1
  48. package/k051649audioengine.d.ts +79 -0
  49. package/k051649audioengine.js +1 -0
  50. package/looper.d.ts +247 -0
  51. package/megasynth-fm-presets.d.ts +248 -0
  52. package/megasynth.d.ts +432 -0
  53. package/megasynth.js +3 -2
  54. package/megasynth_fx.d.ts +402 -0
  55. package/megasynth_looper.d.ts +6 -0
  56. package/megasynth_offline.d.ts +84 -0
  57. package/megasynth_offline.js +6 -0
  58. package/megasynth_pcm_looper.d.ts +23 -0
  59. package/megasynth_recording.d.ts +41 -0
  60. package/megasynth_session.d.ts +53 -0
  61. package/megasynth_session.js +3 -0
  62. package/midi_file.d.ts +18 -0
  63. package/midi_song.d.ts +17 -0
  64. package/midi_source.d.ts +27 -0
  65. package/msxaudioengine.d.ts +34 -0
  66. package/multichipaudioengine.d.ts +61 -0
  67. package/native-fx-worklet.d.ts +33 -0
  68. package/native_fx.d.ts +125 -0
  69. package/native_fx.js +1 -0
  70. package/native_fx_engine.d.ts +28 -0
  71. package/native_fx_graph.d.ts +41 -0
  72. package/native_fx_rack.d.ts +77 -0
  73. package/native_noise.d.ts +20 -0
  74. package/native_sample.d.ts +31 -0
  75. package/native_sample_processor.d.ts +6 -0
  76. package/node/README.md +8 -0
  77. package/node/chip_transports.d.mts +94 -0
  78. package/node/chip_transports.mjs +9 -0
  79. package/node/megasynth.d.mts +96 -0
  80. package/node/megasynth.mjs +30 -1
  81. package/node/megasynth_worker.d.mts +1 -0
  82. package/node/output_audify.d.mts +26 -0
  83. package/node/output_thread.d.mts +9 -0
  84. package/node/pcm_output_worker.d.mts +1 -0
  85. package/okim6258audioengine.d.ts +88 -0
  86. package/okim6258audioengine.js +1 -0
  87. package/okim6295audioengine.d.ts +46 -0
  88. package/opn_fm_synth.d.ts +155 -0
  89. package/opn_fm_synth.js +1 -0
  90. package/opn_fm_vgm.d.ts +4 -0
  91. package/opn_runtime_synth.d.ts +55 -0
  92. package/opn_variant.d.ts +80 -0
  93. package/opn_variant_synth.d.ts +29 -0
  94. package/package.json +78 -15
  95. package/package_assets.d.ts +6 -0
  96. package/package_assets.js +1 -0
  97. package/pitch.d.ts +37 -0
  98. package/playground_async_tasks.d.ts +12 -0
  99. package/playground_audio_scheduler.d.ts +21 -0
  100. package/playground_audio_scheduler.js +1 -1
  101. package/playground_chip_port.d.ts +4 -0
  102. package/playground_clock.d.ts +33 -0
  103. package/playground_clock.js +1 -0
  104. package/playground_duration.d.ts +2 -0
  105. package/playground_execution.d.ts +10 -0
  106. package/playground_gameboy.d.ts +3 -0
  107. package/playground_gameboy_audio.d.ts +4 -0
  108. package/playground_gameboy_worklet.d.ts +1 -0
  109. package/playground_live.d.ts +18 -0
  110. package/playground_logic_worker.d.ts +1 -0
  111. package/playground_midi.d.ts +50 -0
  112. package/playground_music.d.ts +27 -0
  113. package/playground_noise.d.ts +9 -0
  114. package/playground_opn.d.ts +5 -0
  115. package/playground_opn_audio.d.ts +4 -0
  116. package/playground_opn_worklet.d.ts +1 -0
  117. package/playground_pwm_audio.d.ts +5 -0
  118. package/playground_pwm_worklet.d.ts +1 -0
  119. package/playground_rf5c164.d.ts +25 -0
  120. package/playground_rf5c164.js +1 -0
  121. package/playground_rf5c164_audio.d.ts +5 -0
  122. package/playground_runtime.d.ts +599 -0
  123. package/playground_runtime.js +1 -0
  124. package/playground_segapsg.d.ts +4 -0
  125. package/playground_segapsg_audio.d.ts +4 -0
  126. package/playground_segapsg_worklet.d.ts +1 -0
  127. package/playground_soundchips.d.ts +7 -0
  128. package/playground_sync.d.ts +39 -0
  129. package/playground_worker_chip.d.ts +22 -0
  130. package/playground_worker_dac.d.ts +21 -0
  131. package/playground_ym2151.d.ts +16 -0
  132. package/playground_ym2151_audio.d.ts +4 -0
  133. package/playground_ym2151_worklet.d.ts +1 -0
  134. package/playground_ym2608.d.ts +1 -0
  135. package/playground_ym2608_audio.d.ts +4 -0
  136. package/playground_ym2608_timeline.d.ts +24 -0
  137. package/playground_ym2608_worklet.d.ts +1 -0
  138. package/pwm32x.d.ts +54 -0
  139. package/pwm32x.js +6 -0
  140. package/pwm32x_playback.d.ts +55 -0
  141. package/pwm32x_playback.js +11 -1
  142. package/pwm32x_transport.d.ts +56 -0
  143. package/pwm32x_transport.js +23 -2
  144. package/rf5c164-worklet.d.ts +1 -0
  145. package/rf5c164.d.ts +115 -0
  146. package/rf5c164_pcm.d.ts +10 -0
  147. package/rf5c164synth.d.ts +58 -0
  148. package/rf5c164synth.js +1 -1
  149. package/s98_file.d.ts +23 -0
  150. package/sample_clock.d.ts +12 -0
  151. package/segapcm.d.ts +110 -0
  152. package/segapcm.js +1 -1
  153. package/segapcmaudioengine.d.ts +92 -0
  154. package/segapcmaudioengine.js +1 -0
  155. package/segapsg.d.ts +106 -0
  156. package/segapsg_api.d.ts +5 -0
  157. package/segapsgsynth.d.ts +68 -0
  158. package/soundchip-output-worklet.d.ts +1 -0
  159. package/soundchip.d.ts +89 -0
  160. package/soundchip.js +50 -0
  161. package/soundchip_factory.d.ts +10 -0
  162. package/soundchip_worklet.d.ts +20 -0
  163. package/soundchip_worklet.js +14 -0
  164. package/ssgsynth.d.ts +55 -0
  165. package/ssgsynth.js +1 -1
  166. package/stereo-width-worklet.d.ts +1 -0
  167. package/tetorica_audio_runtime.d.ts +370 -0
  168. package/tetorica_synth.d.ts +28 -0
  169. package/tfi.d.ts +136 -0
  170. package/vgi.d.ts +17 -0
  171. package/vgm-output-worklet.d.ts +1 -0
  172. package/vgm_file.d.ts +20 -0
  173. package/vgm_runtime.d.ts +94 -0
  174. package/vgm_runtime.js +1 -1
  175. package/vgmplayer.d.ts +337 -0
  176. package/wav.d.ts +18 -0
  177. package/wav.js +3 -0
  178. package/y8950.d.ts +130 -0
  179. package/y8950audioengine.d.ts +103 -0
  180. package/y8950audioengine.js +1 -0
  181. package/ym2151.d.ts +124 -0
  182. package/ym2151audioengine.d.ts +123 -0
  183. package/ym2151audioengine.js +1 -0
  184. package/ym2203-worklet.d.ts +1 -0
  185. package/ym2203.d.ts +122 -0
  186. package/ym2203audioengine.d.ts +98 -0
  187. package/ym2203synth.d.ts +30 -0
  188. package/ym2203vgm.d.ts +10 -0
  189. package/ym2413.d.ts +116 -0
  190. package/ym2413audioengine.d.ts +94 -0
  191. package/ym2413audioengine.js +1 -0
  192. package/ym2608-worklet.d.ts +1 -0
  193. package/ym2608.d.ts +125 -0
  194. package/ym2608audioengine.d.ts +97 -0
  195. package/ym2608synth.d.ts +162 -0
  196. package/ym2608synth.js +2 -2
  197. package/ym2608vgm.d.ts +9 -0
  198. package/ym2610b-worklet.d.ts +1 -0
  199. package/ym2610b.d.ts +112 -0
  200. package/ym2610b.js +1 -1
  201. package/ym2610baudioengine.d.ts +86 -0
  202. package/ym2610bsynth.d.ts +172 -0
  203. package/ym2610bsynth.js +3 -2
  204. package/ym2610bvgm.d.ts +7 -0
  205. package/ym2612-worklet-nuked.d.ts +1 -0
  206. package/ym2612-worklet.d.ts +1 -0
  207. package/ym2612.d.ts +354 -0
  208. package/ym2612.js +5 -5
  209. package/ym2612_dac.d.ts +73 -0
  210. package/ym2612synth.d.ts +449 -0
  211. package/ym2612synth.js +1 -1
  212. package/ym2612vgm.d.ts +453 -0
  213. package/ym3438.d.ts +24 -0
  214. package/ym3438.js +1 -1
  215. package/ym3526.d.ts +116 -0
  216. package/ym3526audioengine.d.ts +95 -0
  217. package/ym3526audioengine.js +1 -0
  218. package/ym3812.d.ts +116 -0
  219. package/ym3812audioengine.d.ts +95 -0
  220. package/ym3812audioengine.js +1 -0
  221. package/ymf262.d.ts +124 -0
  222. package/ymf262audioengine.d.ts +98 -0
  223. package/ymf262audioengine.js +1 -0
  224. package/ymf276.d.ts +24 -0
  225. package/ymf276.js +1 -1
  226. package/ymf278b.d.ts +137 -0
  227. package/ymf278baudioengine.d.ts +101 -0
  228. package/ymf278baudioengine.js +1 -0
  229. package/ymf288.d.ts +24 -0
package/README.md CHANGED
@@ -253,10 +253,10 @@ FM/PSG/PCM mixing, stop/reset and close/restart. Playwright is a development
253
253
  dependency; it is not required by users of the sound-chip runtime.
254
254
 
255
255
  The build is staged in `dist/fm2612/`; packing produces
256
- `tetorica-fm2612-0.2.7.tgz`. To install a local build in another project:
256
+ `tetorica-fm2612-0.2.8.tgz`. To install a local build in another project:
257
257
 
258
258
  ```sh
259
- npm install /absolute/path/to/tetorica-fm2612-0.2.7.tgz
259
+ npm install /absolute/path/to/tetorica-fm2612-0.2.8.tgz
260
260
  ```
261
261
 
262
262
  The existing `tetorica-vgm` CLI package is built separately. This first package
@@ -272,6 +272,13 @@ and generator. External instrument/sample ROMs are not included.
272
272
 
273
273
  ## Release notes
274
274
 
275
+ `0.2.8` includes JSDoc-generated TypeScript declarations for browser and Node
276
+ entry points, typed Direct/Worklet chip creation and async Worker APIs.
277
+ The build validates every declaration and strict installed-package examples
278
+ under NodeNext/Bundler resolution, including a browser without Node types.
279
+ This release also adds npm discovery keywords.
280
+
281
+
275
282
  `0.2.7` adds the MAME-derived 32X PWM core, output-frame scheduling,
276
283
  MegaSynth/MegaSynthNode integration, Playground support and PWM Worklet/Audify/Direct
277
284
  transports. Integrated output uses cycle-normalized amplitude; the low-level
@@ -321,3 +328,33 @@ The integrated default is `duty` output, gain 1; `pwmOptions` can select `clock`
321
328
  Standalone `PWM32XWorkletTransport`, `PWM32XAudifyTransport` and PCM-only
322
329
  `PWM32XDirectTransport` use the same MAME-derived core.
323
330
  See [implementation and validation](https://github.com/kyorohiro/hello_ymfm_wasm/blob/main/docs/issues/pwm32x_01.md).
331
+
332
+ ## TypeScript (0.2.8)
333
+
334
+ Version 0.2.8 generates `.d.ts` and Node `.d.mts` declarations from
335
+ JSDoc and includes them in the npm tarball. `types` export conditions cover the
336
+ root, assets, Node APIs, transports and both extensionless and `.js` subpaths.
337
+ These declarations are available from 0.2.8; 0.2.7 predates this change.
338
+
339
+ ```ts
340
+ import {createSoundChip} from 'tetorica-fm2612';
341
+ import {YM2612Synth, YM2612WorkletTransport} from 'tetorica-fm2612/ym2612synth.js';
342
+
343
+ const chip = await createSoundChip('ym2612', {execution: 'worklet'});
344
+ const transport = new YM2612WorkletTransport(chip);
345
+ const fm = new YM2612Synth({transport});
346
+ await transport.start();
347
+ fm.noteOn(0, 4, 553);
348
+ // await transport.close() when finished.
349
+ ```
350
+
351
+ `createSoundChip('ym2612')` infers the direct `Ym2612` core;
352
+ `execution: 'worklet'` infers the remote endpoint. Browser APIs require DOM
353
+ library types. Node APIs use Node's `EventEmitter` types; Node TypeScript
354
+ projects should include `@types/node`. The emitted declarations use generic
355
+ TypedArray types, supported by TypeScript 5.7 and later.
356
+
357
+ Development validation: `npm run build:fm2612` generates and checks every
358
+ declaration; `npm run test:fm2612:types` verifies strict consumer examples under
359
+ NodeNext and Bundler resolution, including expected errors. The tarball
360
+ installation check also runs the consumer type tests against the installed package.
@@ -0,0 +1,22 @@
1
+ /** Browser / Worker / Node: decode PCM WAV and encode Yamaha ADPCM-B.
2
+ * No AudioContext is created. Other formats can use an injected decodeAudio.
3
+ */
4
+ /** @param {unknown} source @param {{signal?: AbortSignal, decodeAudio?: (bytes: ArrayBuffer) => Promise<AudioBuffer | import("./wav.js").ChannelPCM>}} [options] */
5
+ export declare function readSamplePCM(source: unknown, { signal, decodeAudio }?: {
6
+ signal?: AbortSignal;
7
+ decodeAudio?: (bytes: ArrayBuffer) => Promise<AudioBuffer | import("./wav.js").ChannelPCM>;
8
+ }): Promise<{}>;
9
+ /** Greedy encoder matching ymfm ADPCM-B: high nibble first, signed 16-bit
10
+ * predictor, initial step 127 and Yamaha's multiplicative step adjustment.
11
+ * Linear interpolation handles rate conversion; pad with encoded silence to
12
+ * the chip's 32-byte addressing boundary (64 decoded frames).
13
+ */
14
+ export declare function encodeAdpcmB({ channels, sampleRate }: {
15
+ channels: any;
16
+ sampleRate: any;
17
+ }, outputRate: any, maxBytes?: number): {
18
+ bytes: Uint8Array<ArrayBuffer>;
19
+ frames: number;
20
+ paddedFrames: number;
21
+ sampleRate: any;
22
+ };
package/adpcm_b_sample.js CHANGED
@@ -1,6 +1,7 @@
1
1
  /** Browser / Worker / Node: decode PCM WAV and encode Yamaha ADPCM-B.
2
2
  * No AudioContext is created. Other formats can use an injected decodeAudio.
3
3
  */
4
+ /** @param {unknown} source @param {{signal?: AbortSignal, decodeAudio?: (bytes: ArrayBuffer) => Promise<AudioBuffer | import("./wav.js").ChannelPCM>}} [options] */
4
5
  export async function readSamplePCM(source, {signal, decodeAudio} = {}) {
5
6
  signal?.throwIfAborted();
6
7
  if (source?.channels) return source;
package/ay8910.d.ts ADDED
@@ -0,0 +1,93 @@
1
+ /**
2
+ * @file ay8910.js
3
+ * 実行環境: Browser / Node.js
4
+ * 依存: WASM(moduleFactory と moduleOptions で読み込み方法を注入)。
5
+ * チップ操作・PCM 生成に DOM・AudioContext は不要。ローダーは実行環境に合わせて渡す。
6
+ */
7
+ export declare const AY8910_CLOCK = 1789773;
8
+ export declare function validateAy8910({ clock, sampleRate, type, flags }?: {
9
+ clock?: number | undefined;
10
+ flags?: number | undefined;
11
+ sampleRate?: number | undefined;
12
+ type?: number | undefined;
13
+ }): void;
14
+ /**
15
+ * Ay8910 chip instance backed by WASM. No AudioContext or playback device is created.
16
+ * Use create() to initialize and dispose() to release native resources.
17
+ * Register writes program the chip; generateStereo() advances it to produce PCM.
18
+ */
19
+ export declare class Ay8910 {
20
+ module: Object;
21
+ handle: number;
22
+ api: Object;
23
+ ptr: number;
24
+ capacity: number;
25
+ /**
26
+ * Initialize Ay8910 and its native WASM module.
27
+ * The generated module factory is injected so browser and Node callers can choose asset loading.
28
+ * @param {import("./soundchip.js").SoundChipOptions} [options={}] Chip and Emscripten initialization settings.
29
+ * @param {function(Object): (Object|Promise<Object>)} options.moduleFactory Generated WASM module factory.
30
+ * @param {Object} [options.moduleOptions] Forwarded loader options, e.g. wasmBinary or locateFile.
31
+ * @param {number} [options.clock] Input chip clock in Hz.
32
+ * @param {number} [options.sampleRate=44100] Generated PCM frames per second.
33
+ * @returns {Promise<Ay8910>} Ready-to-use chip; the caller must dispose it.
34
+ */
35
+ static create({ moduleFactory, moduleOptions, clock, sampleRate, type, flags }?: import("./soundchip.js").SoundChipOptions): Promise<Ay8910>;
36
+ /**
37
+ * Wrap native resources allocated by create(); prefer the asynchronous factory.
38
+ * @param {Object} module Initialized Emscripten module.
39
+ * @param {number} handle Native chip handle owned by this instance.
40
+ * @param {Object} api Bound native entry points.
41
+ */
42
+ constructor(module: Object, handle: number, api: Object);
43
+ /**
44
+ * Reject operations on a disposed native handle.
45
+ * @returns {void}
46
+ * @throws {Error} When the chip has been disposed.
47
+ */
48
+ assertAlive(): void;
49
+ /**
50
+ * Reset synthesis state for a new playback pass. Reapply voice and key registers afterward.
51
+ * @returns {void}
52
+ */
53
+ reset(): void;
54
+ /**
55
+ * Write a register directly without rendering audio.
56
+ * @param {number} register AY register index, 0..15.
57
+ * @param {number} value Register byte, 0..255.
58
+ * @returns {void}
59
+ */
60
+ writeRegister(register: number, value: number): void;
61
+ /**
62
+ * Read the selected PSG register.
63
+ * @param {number} register Register number.
64
+ * @returns {number} Register byte.
65
+ */
66
+ read(register: number): number;
67
+ /**
68
+ * Set native channel mute bits; a set bit suppresses that channel.
69
+ * @param {number} mask Integer bit mask in the native chip channel layout.
70
+ * @returns {void}
71
+ */
72
+ setMuteMask(mask: number): void;
73
+ /**
74
+ * Return the configured PCM output rate.
75
+ * @returns {number} Stereo frames per second.
76
+ */
77
+ sampleRate(): number;
78
+ /**
79
+ * Generate PCM synchronously, advancing the chip by the requested number of frames.
80
+ * Returned arrays are copied from WASM memory and survive later generation/disposal.
81
+ * @param {number} frames Nonnegative integer stereo frame count.
82
+ * @returns {{left: Float32Array, right: Float32Array}} Owned PCM arrays at sampleRate().
83
+ */
84
+ generateStereo(frames: number): {
85
+ left: Float32Array;
86
+ right: Float32Array;
87
+ };
88
+ /**
89
+ * Release native chip state and allocated WASM buffers. Do not use the chip afterward.
90
+ * @returns {void}
91
+ */
92
+ dispose(): void;
93
+ }
package/ay8910.js CHANGED
@@ -21,7 +21,7 @@ export class Ay8910 {
21
21
  /**
22
22
  * Initialize Ay8910 and its native WASM module.
23
23
  * The generated module factory is injected so browser and Node callers can choose asset loading.
24
- * @param {Object} [options={}] Chip and Emscripten initialization settings.
24
+ * @param {import("./soundchip.js").SoundChipOptions} [options={}] Chip and Emscripten initialization settings.
25
25
  * @param {function(Object): (Object|Promise<Object>)} options.moduleFactory Generated WASM module factory.
26
26
  * @param {Object} [options.moduleOptions] Forwarded loader options, e.g. wasmBinary or locateFile.
27
27
  * @param {number} [options.clock] Input chip clock in Hz.
@@ -0,0 +1,81 @@
1
+ /**
2
+ * Ay8910AudioEngine adapter for synchronous stereo rendering and VGM register dispatch.
3
+ * Output timing uses sampleRate() frames per second. No browser audio device is opened.
4
+ * Dispose the engine when done to release its underlying chips.
5
+ */
6
+ export declare class Ay8910AudioEngine {
7
+ ay8910: any;
8
+ channelMask: number;
9
+ muted: boolean;
10
+ volume: number | undefined;
11
+ /**
12
+ * Create the chip instances required by this engine.
13
+ * @param {Object} [options={}] Chip factories, clocks in Hz and loader settings.
14
+ * @param {number} [options.outputSampleRate=44100] Output stereo frames per second.
15
+ * @param {number} [options.masterVolume=1] Linear output gain, not dB.
16
+ * @returns {Promise<Ay8910AudioEngine>} Initialized engine owned by the caller.
17
+ */
18
+ /** @param {{moduleFactory: Function, moduleOptions?: Record<string, unknown>, clock: number, type?: number, flags?: number, outputSampleRate?: number, masterVolume?: number}} options */
19
+ static create({ moduleFactory, moduleOptions, clock, type, flags, outputSampleRate, masterVolume }?: {
20
+ moduleFactory: Function;
21
+ moduleOptions?: Record<string, unknown>;
22
+ clock: number;
23
+ type?: number;
24
+ flags?: number;
25
+ outputSampleRate?: number;
26
+ masterVolume?: number;
27
+ }): Promise<Ay8910AudioEngine>;
28
+ constructor(chip: any, volume?: number);
29
+ /**
30
+ * Return the rate used by process() and processFrames().
31
+ * @returns {number} Output stereo frames per second (Hz).
32
+ */
33
+ sampleRate(): number;
34
+ /**
35
+ * Reset chip/playback state for a new pass. This is not pause/resume; replay setup writes afterward.
36
+ * @returns {void}
37
+ */
38
+ reset(): void;
39
+ /**
40
+ * Release the underlying chips and their resources. Do not render after disposal.
41
+ * @returns {void}
42
+ */
43
+ dispose(): void;
44
+ /**
45
+ * Dispatch a VGM register/command write to the corresponding sound chip.
46
+ * @param {number} register Register address within the selected chip bank.
47
+ * @param {number} value Register/command data value.
48
+ */
49
+ writeAy8910(register: number, value: number): void;
50
+ setAyMuted(muted: any): void;
51
+ setAyChannelMuted(channel: any, muted: any): void;
52
+ applyMute(): void;
53
+ /**
54
+ * Set the linear master gain; validation/clamping follows this engine.
55
+ * @param {number} value Gain multiplier, not dB.
56
+ */
57
+ setMasterVolume(value: number): number;
58
+ /**
59
+ * Read the current linear master gain.
60
+ * @returns {number} Gain multiplier, not a dB value.
61
+ */
62
+ getMasterVolume(): number;
63
+ /**
64
+ * Allocate stereo output and advance synthesis.
65
+ * @param {number} frames Nonnegative integer frame count at sampleRate().
66
+ * @returns {{left:Float32Array,right:Float32Array}} Rendered stereo output.
67
+ */
68
+ processFrames(frames: number): {
69
+ left: Float32Array;
70
+ right: Float32Array;
71
+ };
72
+ /**
73
+ * Advance synthesis and fill caller-owned stereo buffers.
74
+ * @param {Float32Array} left Left output buffer with capacity for frames samples.
75
+ * @param {Float32Array} right Right output buffer with capacity for frames samples.
76
+ * @param {number} frames Nonnegative integer output frame count; not VGM wait samples.
77
+ */
78
+ process(left: Float32Array, right: Float32Array, frames: number): void;
79
+ }
80
+ export declare const createAy8910AudioEngine: (options: any) => Promise<Ay8910AudioEngine>;
81
+ export declare function validateAyPlaybackHeader(header: any): void;
@@ -18,6 +18,7 @@ export class Ay8910AudioEngine {
18
18
  * @param {number} [options.masterVolume=1] Linear output gain, not dB.
19
19
  * @returns {Promise<Ay8910AudioEngine>} Initialized engine owned by the caller.
20
20
  */
21
+ /** @param {{moduleFactory: Function, moduleOptions?: Record<string, unknown>, clock: number, type?: number, flags?: number, outputSampleRate?: number, masterVolume?: number}} options */
21
22
  static async create({moduleFactory,moduleOptions,clock,type=0,flags=1,outputSampleRate=44100,masterVolume=1}={}) {
22
23
  const chip=await Ay8910.create({moduleFactory,moduleOptions,clock,type,flags,sampleRate:outputSampleRate});
23
24
  try{return new Ay8910AudioEngine(chip,masterVolume);}catch(error){chip.dispose();throw error;}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,41 @@
1
+ /** Shared sample-rate conversion for chip output transports. No audio device. */
2
+ export declare class ChipPCMRenderer {
3
+ chip: {
4
+ sampleRate(): number;
5
+ generateStereo(frames: number): {
6
+ left: Float32Array;
7
+ right: Float32Array;
8
+ };
9
+ };
10
+ rate: number;
11
+ sampleRate: number;
12
+ gain: number;
13
+ generate: any;
14
+ idleLeft: number;
15
+ idleRight: number;
16
+ phase: number | undefined;
17
+ left: number | undefined;
18
+ right: number | undefined;
19
+ /** @param {{sampleRate(): number, generateStereo(frames: number): {left: Float32Array, right: Float32Array}}} chip @param {{sampleRate: number, gain?: number, generate?: (frames: number) => {left: Float32Array, right: Float32Array}, removeIdleOffset?: boolean}} options */
20
+ constructor(chip: {
21
+ sampleRate(): number;
22
+ generateStereo(frames: number): {
23
+ left: Float32Array;
24
+ right: Float32Array;
25
+ };
26
+ }, { sampleRate, gain, generate, removeIdleOffset }?: {
27
+ sampleRate: number;
28
+ gain?: number;
29
+ generate?: (frames: number) => {
30
+ left: Float32Array;
31
+ right: Float32Array;
32
+ };
33
+ removeIdleOffset?: boolean;
34
+ });
35
+ resetHistory(): void;
36
+ render(frames: any): {
37
+ left: Float32Array<any>;
38
+ right: Float32Array<any>;
39
+ sampleRate: number;
40
+ };
41
+ }
@@ -1,5 +1,6 @@
1
1
  /** Shared sample-rate conversion for chip output transports. No audio device. */
2
2
  export class ChipPCMRenderer {
3
+ /** @param {{sampleRate(): number, generateStereo(frames: number): {left: Float32Array, right: Float32Array}}} chip @param {{sampleRate: number, gain?: number, generate?: (frames: number) => {left: Float32Array, right: Float32Array}, removeIdleOffset?: boolean}} options */
3
4
  constructor(chip, {sampleRate, gain = .25, generate, removeIdleOffset = false} = {}) {
4
5
  if (!Number.isInteger(sampleRate) || sampleRate <= 0) throw new RangeError('Invalid output sample rate');
5
6
  if (!Number.isFinite(gain) || gain < 0 || gain > 4) throw new RangeError('Invalid output gain');
@@ -0,0 +1,23 @@
1
+ /** Register transports: Synth stays on the caller thread, chip runs in AudioWorklet. */
2
+ export declare class ChipWorkletTransport {
3
+ endpoint: MessagePort | import("./soundchip_worklet.js").WorkletSoundChip | null;
4
+ port: any;
5
+ disposed: boolean;
6
+ /** @param {import("./soundchip_worklet.js").WorkletSoundChip | MessagePort} endpoint */
7
+ constructor(endpoint: import("./soundchip_worklet.js").WorkletSoundChip | MessagePort);
8
+ send(method: any, args: any): void;
9
+ reset(): void;
10
+ write(...args: any[]): void;
11
+ writeRegister(...args: any[]): void;
12
+ start(): void | Promise<void>;
13
+ stop(): any;
14
+ flush(): any;
15
+ dispose(): void;
16
+ close(): Promise<void>;
17
+ }
18
+ export declare class GameboyWorkletTransport extends ChipWorkletTransport {
19
+ }
20
+ export declare class SegaPSGWorkletTransport extends ChipWorkletTransport {
21
+ }
22
+ export declare class YM2151WorkletTransport extends ChipWorkletTransport {
23
+ }
@@ -1,5 +1,6 @@
1
1
  /** Register transports: Synth stays on the caller thread, chip runs in AudioWorklet. */
2
2
  export class ChipWorkletTransport {
3
+ /** @param {import("./soundchip_worklet.js").WorkletSoundChip | MessagePort} endpoint */
3
4
  constructor(endpoint) {
4
5
  this.endpoint = endpoint?.execution === 'worklet' ? endpoint : null;
5
6
  this.port = endpoint?.port ?? endpoint;
package/custom_fx.d.ts ADDED
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Browser AudioWorklet / Node. Named JavaScript effects applied after native FX,
3
+ * in registration order. User code must be synchronous and bounded.
4
+ */
5
+ export declare class LiveFX {
6
+ rate: any;
7
+ effects: Map<any, any>;
8
+ hasProcessed: boolean;
9
+ input: any;
10
+ output: any;
11
+ constructor(rate: any);
12
+ command(d: any): void;
13
+ clear(): void;
14
+ process(channels: any, report: any, observe: any): void;
15
+ }
@@ -0,0 +1,85 @@
1
+ /**
2
+ * @file gameboyapu.js
3
+ * 実行環境: Browser / Node.js
4
+ * 依存: WASM(moduleFactory と moduleOptions で読み込み方法を注入)。
5
+ * チップ操作・PCM 生成に DOM・AudioContext は不要。ローダーは実行環境に合わせて渡す。
6
+ */
7
+ export declare const GAMEBOY_APU_CLOCK = 4194304;
8
+ export declare function validateGameboyApu({ clock, sampleRate }?: {
9
+ clock?: number | undefined;
10
+ sampleRate?: number | undefined;
11
+ }): void;
12
+ /**
13
+ * GameboyApu chip instance backed by WASM. No AudioContext or playback device is created.
14
+ * Use create() to initialize and dispose() to release native resources.
15
+ * Register writes program the chip; generateStereo() advances it to produce PCM.
16
+ */
17
+ export declare class GameboyApu {
18
+ module: Object;
19
+ handle: number;
20
+ api: Object;
21
+ ptr: number;
22
+ capacity: number;
23
+ /**
24
+ * Initialize GameboyApu and its native WASM module.
25
+ * The generated module factory is injected so browser and Node callers can choose asset loading.
26
+ * @param {import("./soundchip.js").SoundChipOptions} [options={}] Chip and Emscripten initialization settings.
27
+ * @param {function(Object): (Object|Promise<Object>)} options.moduleFactory Generated WASM module factory.
28
+ * @param {Object} [options.moduleOptions] Forwarded loader options, e.g. wasmBinary or locateFile.
29
+ * @param {number} [options.clock] Input chip clock in Hz.
30
+ * @param {number} [options.sampleRate=44100] Generated PCM frames per second.
31
+ * @returns {Promise<GameboyApu>} Ready-to-use chip; the caller must dispose it.
32
+ */
33
+ static create({ moduleFactory, moduleOptions, clock, sampleRate }?: import("./soundchip.js").SoundChipOptions): Promise<GameboyApu>;
34
+ /**
35
+ * Wrap native resources allocated by create(); prefer the asynchronous factory.
36
+ * @param {Object} module Initialized Emscripten module.
37
+ * @param {number} handle Native chip handle owned by this instance.
38
+ * @param {Object} api Bound native entry points.
39
+ */
40
+ constructor(module: Object, handle: number, api: Object);
41
+ /**
42
+ * Reject operations on a disposed native handle.
43
+ * @returns {void}
44
+ * @throws {Error} When the chip has been disposed.
45
+ */
46
+ assertAlive(): void;
47
+ /**
48
+ * Reset synthesis state for a new playback pass. Reapply voice and key registers afterward.
49
+ * @returns {void}
50
+ */
51
+ reset(): void;
52
+ /**
53
+ * Write a register directly without rendering audio.
54
+ * @param {number} offset I/O address relative to 0xFF10; sound registers occupy 0x00..0x2F.
55
+ * @param {number} value Register byte, 0..255.
56
+ * @returns {void}
57
+ */
58
+ writeRegister(offset: number, value: number): void;
59
+ /**
60
+ * Set native channel mute bits; a set bit suppresses that channel.
61
+ * @param {number} mask Integer bit mask in the native chip channel layout.
62
+ * @returns {void}
63
+ */
64
+ setMuteMask(mask: number): void;
65
+ /**
66
+ * Return the configured PCM output rate.
67
+ * @returns {number} Stereo frames per second.
68
+ */
69
+ sampleRate(): number;
70
+ /**
71
+ * Generate PCM synchronously, advancing the chip by the requested number of frames.
72
+ * Returned arrays are copied from WASM memory and survive later generation/disposal.
73
+ * @param {number} frames Nonnegative integer stereo frame count.
74
+ * @returns {{left: Float32Array, right: Float32Array}} Owned PCM arrays at sampleRate().
75
+ */
76
+ generateStereo(frames: number): {
77
+ left: Float32Array;
78
+ right: Float32Array;
79
+ };
80
+ /**
81
+ * Release native chip state and allocated WASM buffers. Do not use the chip afterward.
82
+ * @returns {void}
83
+ */
84
+ dispose(): void;
85
+ }
package/gameboyapu.js CHANGED
@@ -18,7 +18,7 @@ export class GameboyApu {
18
18
  /**
19
19
  * Initialize GameboyApu and its native WASM module.
20
20
  * The generated module factory is injected so browser and Node callers can choose asset loading.
21
- * @param {Object} [options={}] Chip and Emscripten initialization settings.
21
+ * @param {import("./soundchip.js").SoundChipOptions} [options={}] Chip and Emscripten initialization settings.
22
22
  * @param {function(Object): (Object|Promise<Object>)} options.moduleFactory Generated WASM module factory.
23
23
  * @param {Object} [options.moduleOptions] Forwarded loader options, e.g. wasmBinary or locateFile.
24
24
  * @param {number} [options.clock] Input chip clock in Hz.
@@ -0,0 +1,81 @@
1
+ /**
2
+ * GameboyApuAudioEngine adapter for synchronous stereo rendering and VGM register dispatch.
3
+ * Output timing uses sampleRate() frames per second. No browser audio device is opened.
4
+ * Dispose the engine when done to release its underlying chips.
5
+ */
6
+ export declare class GameboyApuAudioEngine {
7
+ gameboy: any;
8
+ channelMask: number;
9
+ volume: number | undefined;
10
+ /**
11
+ * Create the chip instances required by this engine.
12
+ * @param {Object} [options={}] Chip factories, clocks in Hz and loader settings.
13
+ * @param {number} [options.outputSampleRate=44100] Output stereo frames per second.
14
+ * @param {number} [options.masterVolume=1] Linear output gain, not dB.
15
+ * @returns {Promise<GameboyApuAudioEngine>} Initialized engine owned by the caller.
16
+ */
17
+ /** @param {{moduleFactory: Function, moduleOptions?: Record<string, unknown>, clock: number, outputSampleRate?: number, masterVolume?: number}} options */
18
+ static create({ moduleFactory, moduleOptions, clock, outputSampleRate, masterVolume }?: {
19
+ moduleFactory: Function;
20
+ moduleOptions?: Record<string, unknown>;
21
+ clock: number;
22
+ outputSampleRate?: number;
23
+ masterVolume?: number;
24
+ }): Promise<GameboyApuAudioEngine>;
25
+ constructor(chip: any, volume?: number);
26
+ /**
27
+ * Return the rate used by process() and processFrames().
28
+ * @returns {number} Output stereo frames per second (Hz).
29
+ */
30
+ sampleRate(): number;
31
+ /**
32
+ * Reset chip/playback state for a new pass. This is not pause/resume; replay setup writes afterward.
33
+ * @returns {void}
34
+ */
35
+ reset(): void;
36
+ /**
37
+ * Release the underlying chips and their resources. Do not render after disposal.
38
+ * @returns {void}
39
+ */
40
+ dispose(): void;
41
+ /**
42
+ * Dispatch a VGM register/command write to the corresponding sound chip.
43
+ * @param {number} offset Chip address offset.
44
+ * @param {number} value Register/command data value.
45
+ */
46
+ writeGameboyApu(offset: number, value: number): void;
47
+ /**
48
+ * Change one physical channel mute flag.
49
+ * @param {number} channel Zero-based physical channel index, not a MIDI part.
50
+ * @param {boolean} muted True to suppress the channel.
51
+ * @returns {void}
52
+ */
53
+ setChannelMuted(channel: number, muted: boolean): void;
54
+ /**
55
+ * Set the linear master gain; validation/clamping follows this engine.
56
+ * @param {number} value Gain multiplier, not dB.
57
+ */
58
+ setMasterVolume(value: number): number;
59
+ /**
60
+ * Read the current linear master gain.
61
+ * @returns {number} Gain multiplier, not a dB value.
62
+ */
63
+ getMasterVolume(): number;
64
+ /**
65
+ * Allocate stereo output and advance synthesis.
66
+ * @param {number} frames Nonnegative integer frame count at sampleRate().
67
+ * @returns {{left:Float32Array,right:Float32Array}} Rendered stereo output.
68
+ */
69
+ processFrames(frames: number): {
70
+ left: Float32Array;
71
+ right: Float32Array;
72
+ };
73
+ /**
74
+ * Advance synthesis and fill caller-owned stereo buffers.
75
+ * @param {Float32Array} left Left output buffer with capacity for frames samples.
76
+ * @param {Float32Array} right Right output buffer with capacity for frames samples.
77
+ * @param {number} frames Nonnegative integer output frame count; not VGM wait samples.
78
+ */
79
+ process(left: Float32Array, right: Float32Array, frames: number): void;
80
+ }
81
+ export declare const createGameboyApuAudioEngine: (options: any) => Promise<GameboyApuAudioEngine>;
@@ -18,6 +18,7 @@ export class GameboyApuAudioEngine {
18
18
  * @param {number} [options.masterVolume=1] Linear output gain, not dB.
19
19
  * @returns {Promise<GameboyApuAudioEngine>} Initialized engine owned by the caller.
20
20
  */
21
+ /** @param {{moduleFactory: Function, moduleOptions?: Record<string, unknown>, clock: number, outputSampleRate?: number, masterVolume?: number}} options */
21
22
  static async create({moduleFactory,moduleOptions,clock,outputSampleRate=44100,masterVolume=1}={}) {
22
23
  const chip=await GameboyApu.create({moduleFactory,moduleOptions,clock,sampleRate:outputSampleRate});
23
24
  try{return new GameboyApuAudioEngine(chip,masterVolume);}catch(error){chip.dispose();throw error;}
@@ -0,0 +1,52 @@
1
+ /** Borrows the core. Disposing a Synth never destroys this transport's chip. */
2
+ export declare class GameboyDirectTransport {
3
+ chip: any;
4
+ constructor(chip: any);
5
+ writeRegister(offset: any, value: any): void;
6
+ reset(): void;
7
+ }
8
+ export declare class GameboySynth {
9
+ #private;
10
+ pulse: Readonly<{
11
+ setVoice: (ch: any, value: any) => void;
12
+ setDuty: (ch: any, duty: any) => void;
13
+ setEnvelope: (ch: any, value: any) => void;
14
+ setSweep: (value: any) => void;
15
+ setFrequency: (ch: any, hz: any) => number;
16
+ setNote: (ch: any, note: any) => number;
17
+ keyOn: (ch: any) => void;
18
+ keyOff: (ch: any) => void;
19
+ }>;
20
+ wave: Readonly<{
21
+ stopAndSetWaveform: (samples: any) => void;
22
+ setWaveform: (samples: any) => void;
23
+ setLevel: (level: any) => void;
24
+ setFrequency: (hz: any) => number;
25
+ setNote: (note: any) => number;
26
+ keyOn: () => void;
27
+ keyOff: () => void;
28
+ }>;
29
+ noise: Readonly<{
30
+ setVoice: (value: any) => void;
31
+ setEnvelope: (value: any) => void;
32
+ setParameters: (value: any) => void;
33
+ keyOn: () => void;
34
+ keyOff: () => void;
35
+ }>;
36
+ /** @param {{transport: {writeRegister(offset: number, value: number): void, reset(): void}, clock?: number}} [options] */
37
+ constructor({ transport, clock }?: {
38
+ transport: {
39
+ writeRegister(offset: number, value: number): void;
40
+ reset(): void;
41
+ };
42
+ clock?: number;
43
+ });
44
+ writeRegister(offset: any, value: any): void;
45
+ /** Adopt writes made through this Synth without resetting or writing defaults. */
46
+ adoptRegisterState(): void;
47
+ reset(): void;
48
+ initialize(): void;
49
+ setPan(ch: any, left: any, right: any): void;
50
+ setMasterVolume(left: any, right: any): void;
51
+ dispose(): void;
52
+ }
package/gameboysynth.js CHANGED
@@ -39,6 +39,7 @@ export class GameboySynth {
39
39
  #transport; #clock; #disposed = false; #initialized = false;
40
40
  // Sent registers and configured values retained across keyOff. Neither is core status.
41
41
  #shadow = new Uint8Array(48); #voice = new Uint8Array(48);
42
+ /** @param {{transport: {writeRegister(offset: number, value: number): void, reset(): void}, clock?: number}} [options] */
42
43
  constructor({transport, clock = GAMEBOY_APU_CLOCK} = {}) {
43
44
  if (!transport || typeof transport.writeRegister !== 'function' || typeof transport.reset !== 'function') throw new TypeError('Expected transport');
44
45
  integer(clock, 1, 0x3fffffff);
@@ -0,0 +1,2 @@
1
+ declare function Module(moduleArg?: {}): Promise<{}>;
2
+ export default Module;
@@ -0,0 +1,2 @@
1
+ declare function Module(moduleArg?: {}): Promise<{}>;
2
+ export default Module;
@@ -0,0 +1,2 @@
1
+ declare function Module(moduleArg?: {}): Promise<{}>;
2
+ export default Module;
@@ -0,0 +1,2 @@
1
+ declare function Module(moduleArg?: {}): Promise<{}>;
2
+ export default Module;
@@ -0,0 +1,2 @@
1
+ declare function Module(moduleArg?: {}): Promise<{}>;
2
+ export default Module;
@@ -0,0 +1,2 @@
1
+ declare function Module(moduleArg?: {}): Promise<{}>;
2
+ export default Module;