xsound 2.27.0 → 3.0.0-alpha

package/README.md

@@ -4,7 +4,6 @@
 ![node-current](https://img.shields.io/node/v/xsound?color=brightgreen)
 [![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
 [![npm](https://img.shields.io/npm/dt/xsound.svg)](https://www.npmjs.com/package/xsound)
-![David Dev](https://img.shields.io/david/dev/Korilakkuma/XSound.svg)
 [![jsDelivr](https://data.jsdelivr.com/v1/package/npm/xsound/badge)](https://www.jsdelivr.com/package/npm/xsound)
   
 ## Overview
@@ -37,7 +36,7 @@ XSound don't depend on other libraries or frameworks (For example, jQuery, React
 In the case of using as **full stack** (For example, use oscillator) ...
 
 ```JavaScript
-X('oscillator').setup(true).ready().start(440);
+X('oscillator').setup([true, true, false, false]).ready().start([440, 880]);
 ```
 
 or, in the case of using as **module base** (For example, use chorus effector) ...
@@ -47,8 +46,7 @@ or, in the case of using as **module base** (For example, use chorus effector) .
 const context = X.get();
 
 // Create the instance of `Chorus` that is defined by XSound
-// (The 2nd argument is buffer size for `ScriptProcessorNode`)
-const chorus = new X.Chorus(context, 0);
+const chorus = new X.Chorus(context);
 
 const oscillator = context.createOscillator();
 
@@ -65,7 +63,7 @@ chorus.param({
 });
 
 // Activate
-chorus.state(true);
+chorus.activate();
 
 oscillator.start(0);
 ```
@@ -73,32 +71,32 @@ oscillator.start(0);
 XSound enable to using the following classes (Refer to [API Documentation](https://xsound.dev) for details).
 
 ```TypeScript
+// These type aliases are defined by XSound
 type BufferSize = 0 | 256 | 512 | 1024 | 2048 | 4096 | 8192 | 16384;
+type RecordType = 1 | 2;  // Monaural | Stereo
+
+X.Analyser(context: AudioContext);
+X.Recorder(context: AudioContext, bufferSize: BufferSize, numberOfInputs: RecordType, numberOfOutputs: RecordType);
+X.Session(context: AudioContext);
 
 // Effectors
-X.Autopanner(context: AudioContext, size: BufferSize);
-X.Chorus(context: AudioContext, size: BufferSize);
-X.Compressor(context: AudioContext, size: BufferSize);
-X.Delay(context: AudioContext, size: BufferSize);
-X.Distortion(context: AudioContext, size: BufferSize);
-X.Equalizer(context: AudioContext, size: BufferSize);
-X.Filter(context: AudioContext, size: BufferSize);
-X.Flanger(context: AudioContext, size: BufferSize);
-X.Listener(context: AudioContext, size: BufferSize);
-X.Panner(context: AudioContext, size: BufferSize);
-X.Phaser(context: AudioContext, size: BufferSize);
+X.Autopanner(context: AudioContext);
+X.Chorus(context: AudioContext);
+X.Compressor(context: AudioContext);
+X.Delay(context: AudioContext);
+X.Distortion(context: AudioContext);
+X.Equalizer(context: AudioContext);
+X.Filter(context: AudioContext);
+X.Flanger(context: AudioContext);
+X.Listener(context: AudioContext);
+X.Panner(context: AudioContext);
+X.Phaser(context: AudioContext);
 X.PitchShifter(context: AudioContext, size: BufferSize);
-X.Reverb(context: AudioContext, size: BufferSize);
-X.Ringmodulator(context: AudioContext, size: BufferSize);
+X.Reverb(context: AudioContext);
+X.Ringmodulator(context: AudioContext);
 X.Stereo(context: AudioContext, size, size: BufferSize);
-X.Tremolo(context: AudioContext, size: BufferSize);
-X.Wah(context: AudioContext, size: BufferSize);
-
-X.Analyser(context: AudioContext);
-
-X.Recorder(context: AudioContext, size: BufferSize, numberOfInputs: number, numberOfOutputs: number);
-
-X.Session(context: AudioContext, size: BufferSize, numberOfInputs: number, numberOfOutputs, analyser: X.Analyser);
+X.Tremolo(context: AudioContext);
+X.Wah(context: AudioContext);
 ```
 
 ## Demo
@@ -106,8 +104,6 @@ X.Session(context: AudioContext, size: BufferSize, numberOfInputs: number, numbe
 The application that uses XSound is in the following URLs.
   
 - [XSound.app](https://xsound.app)
-- [x-piano](https://korilakkuma.github.io/x-piano/)
-- [Music V](https://weblike-curtaincall.ssl-lolipop.jp/portfolio-music-v/)
 - [Music Tweet](https://github.com/Korilakkuma/Music-Tweet)
 - [Chrome EQUALIZER](https://github.com/Korilakkuma/Chrome-EQUALIZER)
   
@@ -135,7 +131,7 @@ In the case of using CDN,
 <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/xsound@latest/build/xsound.min.js"></script>
 ```
 
-In the case of using ESModules for SSR ... etc,
+In the case of using ES Modules for SSR ... etc,
 
 ```JavaScript
 import { XSound, X } from 'xsound';
@@ -168,6 +164,38 @@ $ open http://localhost:8080/playground/
   
 - [XSound API Documentation](https://xsound.dev)
   
+## Migration to v3
+
+Please refer to [API Documentation](#api-documentation) for details.
+
+### Case sensitive
+
+```JavaScript
+// Bad (v2 or earlier)
+X('audio').module('panner').param({ coneinnerangle: 240 });
+
+// Good (v3)
+X('audio').module('panner').param({ coneInnerAngle: 240 });
+```
+
+### Use plain object if parameters setter
+
+```JavaScript
+// Bad (v2 or earlier)
+X('oscillator').get(0).param('type', 'sawtooth');
+
+// Good (v3)
+X('oscillator').get(0).param({ type: 'sawtooth' });
+```
+
+### Validate parameters on the application side
+
+```JavaScript
+if ((type === 'sine') || (type === 'square') || (type === 'sawtooth') || (type === 'triangle')) {
+  X('oscillator').get(0).param({ type });
+}
+```
+
 ## Pickups
   
 - [9 libraries to kickstart your Web Audio stuff - DEV Community](https://dev.to/areknawo/9-libraries-to-kickstart-your-web-audio-stuff-460p)

package/build/types/AudioModule/index.d.ts

@@ -0,0 +1,198 @@
+import { BufferSize } from '../types';
+import { SoundModule, SoundModuleParams } from '../SoundModule';
+import { Analyser } from '../SoundModule/Analyser';
+import { Recorder } from '../SoundModule/Recorder';
+import { Session } from '../SoundModule/Session';
+import { Autopanner } from '../SoundModule/Effectors/Autopanner';
+import { Chorus } from '../SoundModule/Effectors/Chorus';
+import { Compressor } from '../SoundModule/Effectors/Compressor';
+import { Delay } from '../SoundModule/Effectors/Delay';
+import { Distortion } from '../SoundModule/Effectors/Distortion';
+import { EnvelopeGenerator } from '../SoundModule/Effectors/EnvelopeGenerator';
+import { Equalizer } from '../SoundModule/Effectors/Equalizer';
+import { Filter } from '../SoundModule/Effectors/Filter';
+import { Flanger } from '../SoundModule/Effectors/Flanger';
+import { Listener } from '../SoundModule/Effectors/Listener';
+import { Panner } from '../SoundModule/Effectors/Panner';
+import { Phaser } from '../SoundModule/Effectors/Phaser';
+import { PitchShifter } from '../SoundModule/Effectors/PitchShifter';
+import { Reverb } from '../SoundModule/Effectors/Reverb';
+import { Ringmodulator } from '../SoundModule/Effectors/Ringmodulator';
+import { Stereo } from '../SoundModule/Effectors/Stereo';
+import { Tremolo } from '../SoundModule/Effectors/Tremolo';
+import { Wah } from '../SoundModule/Effectors/Wah';
+import { VocalCanceler, VocalCancelerParams } from '../SoundModule/Effectors/VocalCanceler';
+export declare type AudioBufferSprite = {
+    [spriteName: string]: AudioBuffer;
+};
+export declare type AudioModuleParams = SoundModuleParams & {
+    vocalcanceler: VocalCancelerParams;
+    playbackRate?: number;
+    detune?: number;
+    loop?: boolean;
+    currentTime?: number;
+    readonly duration?: number;
+    readonly sampleRate?: number;
+    readonly numberOfChannels?: number;
+};
+declare type Params = Partial<Pick<AudioModuleParams, 'mastervolume' | 'playbackRate' | 'detune' | 'loop' | 'currentTime' | 'duration' | 'sampleRate' | 'numberOfChannels'>>;
+/**
+ * This subclass is for playing single audio.
+ * This class enables to create audio player that has higher features than `HTMLAudioElement`.
+ * But, this class is disadvantage to play many one shot audios.
+ * In that case, developer should use `OneshotModule`.
+ * @constructor
+ * @extends {SoundModule}
+ */
+export declare class AudioModule extends SoundModule {
+    private source;
+    private buffer;
+    private vocalcanceler;
+    private currentTime;
+    private stopped;
+    private decodeCallback;
+    private updateCallback;
+    private endedCallback;
+    private errorCallback;
+    /**
+     * @param {AudioContext} context This argument is in order to use the interfaces of Web Audio API.
+     * @param {BufferSize} bufferSize This argument is buffer size for `ScriptProcessorNode`.
+     */
+    constructor(context: AudioContext, bufferSize: BufferSize);
+    /**
+     * This method sets up envelope generator for fade-in and fade-out.
+     * @return {AudioModule} Return value is for method chain.
+     */
+    setup(callbacks?: {
+        decodeCallback?(buffer: AudioBuffer): void;
+        updateCallback?(source: AudioBufferSourceNode, currentTime: number): void;
+        endedCallback?(source: AudioBufferSourceNode, currentTime: number): void;
+        errorCallback?(error: Error): void;
+    }): AudioModule;
+    /**
+     * This method decodes instance of `ArrayBuffer` to `ArrayBuffer` or sets instanceof `AudioBuffer`.
+     * @param {ArrayBuffer|AudioBuffer} buffer This argument is instance of `ArrayBuffer` or `AudioBuffer`.
+     *     If this is `ArrayBuffer`, this method executes decode.
+     * @return {AudioModule} Return value is for method chain.
+     */
+    ready(buffer: ArrayBuffer | AudioBuffer): AudioModule;
+    /**
+     * This method starts audio from designated time.
+     * @param {number} startTime This argument is time that audio is started at. The default value is `0`.
+     * @param {number} endTime This argument is time that audio is ended at. The default value is audio duration.
+     * @return {AudioModule} This is returned for method chain.
+     */
+    start(startTime?: number, endTime?: number): AudioModule;
+    /**
+     * This method stops audio.
+     * @return {AudioModule} Return value is for method chain.
+     */
+    stop(): AudioModule;
+    /**
+     * This method gets or sets parameters for audio module.
+     * This method is overloaded for type interface and type check.
+     * @param {keyof Params|Params} params This argument is string if getter. Otherwise, setter.
+     * @return {Params[keyof Params]|Params} Return value is parameter for audio module if getter.
+     *     Otherwise, return value is for method chain.
+     */
+    param(params: 'mastervolume'): number;
+    param(params: 'playbackRate'): number;
+    param(params: 'detune'): number;
+    param(params: 'loop'): boolean;
+    param(params: 'currentTime'): number;
+    param(params: 'duration'): number;
+    param(params: 'sampleRate'): number;
+    param(params: 'numberOfChannels'): number;
+    param(params: 'numberOfChannels'): number;
+    param(params: Params): AudioModule;
+    /**
+     * This method gets instance of `AudioBufferSourceNode`.
+     * @return {AudioBufferSourceNode}
+     */
+    get(): AudioBufferSourceNode;
+    /**
+     * This method rewinds audio.
+     * @return {AudioModule} Return value is for method chain.
+     */
+    end(): AudioModule;
+    /**
+     * This method determines whether instance of `AudioBuffer` exists.
+     * @return {boolean} If instance of `AudioBuffer` already exists, this value is `true`. Otherwise, this value is `false`.
+     */
+    has(): boolean;
+    /**
+     * This method determines whether audio is paused.
+     * @return {boolean} If audio is paused, this value is `true`. Otherwise, this value is `false`.
+     */
+    paused(): boolean;
+    /**
+     * This method gets or sets fade-in time.
+     * @param {number} time This argument is fade-in time. If this argument is omitted, this method is getter.
+     * @return {number|AudioModule} Return value is fade-in time. Otherwise, return value is for method chain.
+     */
+    fadeIn(time?: number): number | AudioModule;
+    /**
+     * This method gets or sets fade-out time.
+     * @param {number} time This argument is fade-out time. If this argument is omitted, this method is getter.
+     * @return {number|AudioModule} Return value is fade-out time. Otherwise, return value is for method chain.
+     */
+    fadeOut(time?: number): number | AudioModule;
+    /**
+     *  This method slices instance of `AudioBuffer`.
+     *  @param {number} startTime This argument is start time [sec] on `AudioBuffer`.
+     *  @param {number} endTime This argument is end time [sec] on `AudioBuffer`.
+     *  @return {AudioBuffer} Return value is sliced `AudioBuffer`.
+     */
+    slice(startTime?: number, endTime?: number): AudioBuffer | null;
+    /**
+     *  This method sprites audio.
+     *  @param {Object<string, Array<number>>} sprites This argument is associative array that contains sprite times.
+     *  @return {AudioBufferSprite} Return value is associative array that contains sprited `AudioBuffer`.
+     */
+    sprite(sprites: {
+        [spriteName: string]: [number, number];
+    }): AudioBufferSprite | null;
+    /**
+     * This method gets instance of `Module` (Analyser, Recorder, Effector ... etc).
+     * @param {ModuleName|'vocalcanceler'} moduleName This argument selects module.
+     * @return {Module|VocalCanceler}
+     */
+    module(moduleName: 'analyser'): Analyser;
+    module(moduleName: 'recorder'): Recorder;
+    module(moduleName: 'session'): Session;
+    module(moduleName: 'autopanner'): Autopanner;
+    module(moduleName: 'chorus'): Chorus;
+    module(moduleName: 'compressor'): Compressor;
+    module(moduleName: 'delay'): Delay;
+    module(moduleName: 'distortion'): Distortion;
+    module(moduleName: 'equalizer'): Equalizer;
+    module(moduleName: 'filter'): Filter;
+    module(moduleName: 'flanger'): Flanger;
+    module(moduleName: 'listener'): Listener;
+    module(moduleName: 'panner'): Panner;
+    module(moduleName: 'phaser'): Phaser;
+    module(moduleName: 'pitchshifter'): PitchShifter;
+    module(moduleName: 'reverb'): Reverb;
+    module(moduleName: 'ringmodulator'): Ringmodulator;
+    module(moduleName: 'stereo'): Stereo;
+    module(moduleName: 'tremolo'): Tremolo;
+    module(moduleName: 'wah'): Wah;
+    module(moduleName: 'envelopegenerator'): EnvelopeGenerator;
+    module(moduleName: 'vocalcanceler'): VocalCanceler;
+    /** @override */
+    resize(bufferSize: BufferSize): AudioModule;
+    /** @override */
+    on(startTime?: number): AudioModule;
+    /** @override */
+    off(stopTime?: number): AudioModule;
+    /** @override */
+    suspend(): AudioModule;
+    /**
+     * This method gets audio module parameters as associative array.
+     * @return {AudioModuleParams}
+     * @override
+     */
+    params(): AudioModuleParams;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/build/types/AudioModule/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/AudioModule/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAsB,MAAM,gBAAgB,CAAC;AACpF,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AACjE,OAAO,EAAE,KAAK,EAAE,MAAM,gCAAgC,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,4CAA4C,CAAC;AAC/E,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AAC/D,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,kCAAkC,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,mCAAmC,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AACzD,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AACrE,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,wCAAwC,CAAC;AACvE,OAAO,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,kCAAkC,CAAC;AAC3D,OAAO,EAAE,GAAG,EAAE,MAAM,8BAA8B,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAE5F,oBAAY,iBAAiB,GAAG;IAAE,CAAC,UAAU,EAAE,MAAM,GAAG,WAAW,CAAA;CAAE,CAAC;AAEtE,oBAAY,iBAAiB,GAAG,iBAAiB,GAAG;IAClD,aAAa,EAAE,mBAAmB,CAAC;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAA;CACnC,CAAC;AAEF,aAAK,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,iBAAiB,EAAE,cAAc,GAAG,cAAc,GAAG,QAAQ,GAAG,MAAM,GAAG,aAAa,GAAG,UAAU,GAAG,YAAY,GAAG,kBAAkB,CAAC,CAAC,CAAC;AAErK;;;;;;;GAOG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C,OAAO,CAAC,MAAM,CAAwB;IACtC,OAAO,CAAC,MAAM,CAA4B;IAE1C,OAAO,CAAC,aAAa,CAAgB;IAErC,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,OAAO,CAAQ;IAEvB,OAAO,CAAC,cAAc;IACtB,OAAO,CAAC,cAAc;IACtB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,aAAa;IAErB;;;OAGG;gBACS,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,UAAU;IAOzD;;;OAGG;IACI,KAAK,CAAC,SAAS,CAAC,EAAE;QACvB,cAAc,CAAC,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;QAC3C,cAAc,CAAC,CAAC,MAAM,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1E,aAAa,CAAC,CAAC,MAAM,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QACzE,aAAa,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;KACpC,GAAG,WAAW;IA8Bf;;;;;OAKG;IACI,KAAK,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,GAAG,WAAW;IAuB5D;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW;IAsG/D;;;OAGG;IACI,IAAI,IAAI,WAAW;IAyB1B;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM;IACrC,KAAK,CAAC,MAAM,EAAE,cAAc,GAAG,MAAM;IACrC,KAAK,CAAC,MAAM,EAAE,QAAQ,GAAG,MAAM;IAC/B,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAC9B,KAAK,CAAC,MAAM,EAAE,aAAa,GAAG,MAAM;IACpC,KAAK,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM;IACjC,KAAK,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM;IACnC,KAAK,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM;IACzC,KAAK,CAAC,MAAM,EAAE,kBAAkB,GAAG,MAAM;IACzC,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW;IAuFzC;;;OAGG;IACI,GAAG,IAAI,qBAAqB;IAInC;;;OAGG;IACI,GAAG,IAAI,WAAW;IAWzB;;;OAGG;IACI,GAAG,IAAI,OAAO;IAIrB;;;OAGG;IACI,MAAM,IAAI,OAAO;IAIxB;;;;OAIG;IACI,MAAM,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW;IAkBlD;;;;OAIG;IACI,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW;IAkBnD;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI;IA8DtE;;;;OAIG;IACI,MAAM,CAAC,OAAO,EAAE;QAAE,CAAC,UAAU,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,GAAG,iBAAiB,GAAG,IAAI;IAkB5F;;;;OAIG;IACI,MAAM,CAAC,UAAU,EAAE,UAAU,GAAG,QAAQ;IACxC,MAAM,CAAC,UAAU,EAAE,UAAU,GAAG,QAAQ;IACxC,MAAM,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO;IACtC,MAAM,CAAC,UAAU,EAAE,YAAY,GAAG,UAAU;IAC5C,MAAM,CAAC,UAAU,EAAE,QAAQ,GAAG,MAAM;IACpC,MAAM,CAAC,UAAU,EAAE,YAAY,GAAG,UAAU;IAC5C,MAAM,CAAC,UAAU,EAAE,OAAO,GAAG,KAAK;IAClC,MAAM,CAAC,UAAU,EAAE,YAAY,GAAG,UAAU;IAC5C,MAAM,CAAC,UAAU,EAAE,WAAW,GAAG,SAAS;IAC1C,MAAM,CAAC,UAAU,EAAE,QAAQ,GAAG,MAAM;IACpC,MAAM,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO;IACtC,MAAM,CAAC,UAAU,EAAE,UAAU,GAAG,QAAQ;IACxC,MAAM,CAAC,UAAU,EAAE,QAAQ,GAAG,MAAM;IACpC,MAAM,CAAC,UAAU,EAAE,QAAQ,GAAG,MAAM;IACpC,MAAM,CAAC,UAAU,EAAE,cAAc,GAAG,YAAY;IAChD,MAAM,CAAC,UAAU,EAAE,QAAQ,GAAG,MAAM;IACpC,MAAM,CAAC,UAAU,EAAE,eAAe,GAAG,aAAa;IAClD,MAAM,CAAC,UAAU,EAAE,QAAQ,GAAG,MAAM;IACpC,MAAM,CAAC,UAAU,EAAE,SAAS,GAAG,OAAO;IACtC,MAAM,CAAC,UAAU,EAAE,KAAK,GAAG,GAAG;IAC9B,MAAM,CAAC,UAAU,EAAE,mBAAmB,GAAG,iBAAiB;IAC1D,MAAM,CAAC,UAAU,EAAE,eAAe,GAAG,aAAa;IAoDzD,gBAAgB;IACA,MAAM,CAAC,UAAU,EAAE,UAAU,GAAG,WAAW;IAK3D,gBAAgB;IACA,EAAE,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,WAAW;IAKnD,gBAAgB;IACA,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW;IAKnD,gBAAgB;IACA,OAAO,IAAI,WAAW;IAKtC;;;;OAIG;IACa,MAAM,IAAI,iBAAiB;CAe5C"}

package/build/types/MIDI/index.d.ts

@@ -0,0 +1,48 @@
+export interface MIDIOptions {
+    sysex: boolean;
+}
+export interface MIDIMessageEvent {
+    data: Uint8Array;
+    receivedTime: number;
+}
+export interface MIDIInput {
+    onmidimessage(event: MIDIMessageEvent): void;
+}
+export interface MIDIOutput {
+    clear(): void;
+    send(data: Uint8Array, timestamp?: number): void;
+}
+export interface MIDIAccess {
+    inputs: Map<string, MIDIInput>;
+    outputs: Map<string, MIDIOutput>;
+    onstatechang(): void;
+    sysexEnabled: boolean;
+}
+/**
+ * This class is for using Web MIDI API.
+ * @constructor
+ */
+export declare class MIDI {
+    private midiAccess;
+    private inputs;
+    private outputs;
+    constructor();
+    /**
+     * This method invokes `requestMIDIAccess` and gets instance of `MIDIAccess`.
+     * @param {MIDIOptions} options This argument is object based on `MIDIOptions` dictionary.
+     * @param {function} successCallback This argument is invoked on `requestMIDIAccess` success.
+     * @param {function} errorCallback This argument is invoked on `requestMIDIAccess` failure.
+     * @return {Promise<MIDIAccess|void>} Return value is `Promise` that `requestMIDIAccess` method returns.
+     */
+    setup(params: {
+        options?: MIDIOptions;
+        successCallback?(midiAccess: MIDIAccess, midiInputs: MIDIInput[], midiOutputs: MIDIOutput[]): void;
+        errorCallback?(error: Error): void;
+    }): Promise<MIDIAccess | void>;
+    /**
+     * This method gets instance of `MIDIAccess`.
+     * @return {MIDIAccess|null}
+     */
+    get(): MIDIAccess | null;
+}
+//# sourceMappingURL=index.d.ts.map

package/build/types/MIDI/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/MIDI/index.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,UAAU,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,SAAS;IACxB,aAAa,CAAC,KAAK,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAC9C;AAGD,MAAM,WAAW,UAAU;IACzB,KAAK,IAAI,IAAI,CAAC;IACd,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClD;AAGD,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC/B,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACjC,YAAY,IAAI,IAAI,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;CACvB;AAED;;;GAGG;AACH,qBAAa,IAAI;IACf,OAAO,CAAC,UAAU,CAA2B;IAC7C,OAAO,CAAC,MAAM,CAAmB;IACjC,OAAO,CAAC,OAAO,CAAoB;;IAMnC;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,EAAE;QACnB,OAAO,CAAC,EAAE,WAAW,CAAC;QACtB,eAAe,CAAC,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC;QACnG,aAAa,CAAC,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;KACpC,GAAG,OAAO,CAAC,UAAU,GAAC,IAAI,CAAC;IAmC5B;;;OAGG;IACI,GAAG,IAAI,UAAU,GAAG,IAAI;CAGhC"}

package/build/types/MML/Part.d.ts

@@ -0,0 +1,78 @@
+import { OscillatorModule } from '../OscillatorModule';
+import { OneshotModule } from '../OneshotModule';
+import { NoiseModule } from '../NoiseModule';
+import { MMLSyntaxError } from './Tree';
+import { Sequence } from './Sequence';
+/**
+ * This class starts and stops each MML part.
+ * @constructor
+ */
+export declare class Part {
+    private sequences;
+    private source;
+    private mml;
+    private previous;
+    private timerId;
+    private currentIndex;
+    private currentPosition;
+    private offset;
+    private startCallback;
+    private stopCallback;
+    private endedCallback;
+    private errorCallback;
+    /**
+     * @param {OscillatorModule|OneshotModule|NoiseModule} source This argument selects sound source.
+     * @param {string} mml This argument is MML string.
+     * @param {number} offset This argument corrects index of one-shot audio.
+     * @param {function} startCallback This argument is invoked on start musical note.
+     * @param {function} stopCallback This argument is invoked on stop musical note.
+     * @param {function} endedCallback This argument is invoked on ended.
+     * @param {function} errorCallback This argument is invoked on syntax error.
+     */
+    constructor(params: {
+        source: OscillatorModule | OneshotModule | NoiseModule;
+        mml: string;
+        offset?: number;
+        startCallback?(sequence: Sequence, offset?: number): void;
+        stopCallback?(sequence: Sequence, offset?: number): void;
+        endedCallback?(): void;
+        errorCallback?(error: MMLSyntaxError): void;
+    });
+    /**
+     * This method starts MML. Moreover, this method schedules next sequence.
+     * @param {boolean} highlight This argument is `true` in case of surrounding by `span.x-highlight` HTML.
+     */
+    start(highlight: boolean): void;
+    /**
+     * This method stops MML.
+     */
+    stop(): void;
+    /**
+     * This method is getter for MML string.
+     */
+    getMML(): string;
+    /**
+     * This method is getter for array that contains sequence.
+     */
+    getSequences(): Sequence[];
+    /**
+     * This method determines whether sequence exists.
+     * @return {boolean} If sequence exists, this value is `true`. Otherwise, this value is `false`.
+     */
+    has(): boolean;
+    /**
+     * This method determines whether MML part is paused.
+     * @return {boolean} If MML part are paused, this value is `true`. Otherwise, this value is `false`.
+     */
+    paused(): boolean;
+    /**
+     * This method is getter for current sequence index.
+     */
+    getCurrentIndex(): number;
+    /**
+     * This method is setter for current sequence index.
+     * @param {number} index This argument is new sequence index.
+     */
+    setCurrentIndex(index: number): void;
+}
+//# sourceMappingURL=Part.d.ts.map

package/build/types/MML/Part.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Part.d.ts","sourceRoot":"","sources":["../../../src/MML/Part.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAIxC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;GAGG;AACH,qBAAa,IAAI;IACf,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,MAAM,CAA6C;IAC3D,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,QAAQ,CAAyB;IACzC,OAAO,CAAC,OAAO,CAAuB;IACtC,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,MAAM,CAAK;IACnB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,YAAY;IACpB,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,aAAa;IAErB;;;;;;;;OAQG;gBACS,MAAM,EAAE;QAClB,MAAM,EAAE,gBAAgB,GAAG,aAAa,GAAG,WAAW,CAAC;QACvD,GAAG,EAAE,MAAM,CAAC;QACZ,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,aAAa,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1D,YAAY,CAAC,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzD,aAAa,CAAC,IAAI,IAAI,CAAC;QACvB,aAAa,CAAC,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI,CAAC;KAC7C;IA6CD;;;OAGG;IACI,KAAK,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI;IA8EtC;;OAEG;IACI,IAAI,IAAI,IAAI;IAoCnB;;OAEG;IACI,MAAM,IAAI,MAAM;IAIvB;;OAEG;IACI,YAAY,IAAI,QAAQ,EAAE;IAIjC;;;OAGG;IACI,GAAG,IAAI,OAAO;IAIrB;;;OAGG;IACI,MAAM,IAAI,OAAO;IAIxB;;OAEG;IACI,eAAe,IAAI,MAAM;IAIhC;;;OAGG;IACI,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;CAK5C"}

package/build/types/MML/Sequence.d.ts

@@ -0,0 +1,66 @@
+/**
+ * This class is entity for sequence that has musical note.
+ * @constructor
+ */
+export declare class Sequence {
+    private _id;
+    private _note;
+    private _indexes;
+    private _frequencies;
+    private _start;
+    private _stop;
+    private _duration;
+    /**
+     * @param {string} id This argument is string that identifies sequence.
+     * @param {string} note This argument is string that corresponds to MML token.
+     * @param {Array<number>} indexes This argument is array that contains index that corresponds to 12 equal temperament.
+     * @param {Array<number>} frequencies This argument is array that contains frequency.
+     * @param {number} start This argument is start time.
+     * @param {number} stop This argument is stop time.
+     * @param {number} duration This argument is duration.
+     */
+    constructor(params: {
+        id: string;
+        note: string;
+        indexes: number[];
+        frequencies: number[];
+        start: number;
+        stop: number;
+        duration: number;
+    });
+    /**
+     * This method concatenates sequence in case of tie.
+     * @param {Sequence} sequence This argument is instance of `Sequence`.
+     * @return {Sequence} Return value is new instance of `Sequence` that concatenates previous sequence.
+     */
+    concat(sequence: Sequence): Sequence;
+    /**
+     * This method is getter for musical note as MML token.
+     */
+    get note(): string;
+    /**
+     * This method is getter for array that contains index that corresponds to 12 equal temperament.
+     */
+    get indexes(): number[];
+    /**
+     * This method is getter for array that contains frequency.
+     */
+    get frequencies(): number[];
+    /**
+     * This method is getter for start time.
+     */
+    get start(): number;
+    /**
+     * This method is getter for stop time.
+     */
+    get stop(): number;
+    /**
+     * This method is getter for duration,
+     */
+    get duration(): number;
+    /**
+     * This method returns fields that `Sequence` has as JSON.
+     */
+    toString(): string;
+}
+//# sourceMappingURL=Sequence.d.ts.map

package/build/types/MML/Sequence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Sequence.d.ts","sourceRoot":"","sources":["../../../src/MML/Sequence.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,YAAY,CAAW;IAC/B,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,SAAS,CAAS;IAE1B;;;;;;;;OAQG;gBACS,MAAM,EAAE;QAClB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,EAAE,CAAC;QAClB,WAAW,EAAE,MAAM,EAAE,CAAC;QACtB,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;KAClB;IAYD;;;;OAIG;IACI,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,QAAQ;IAY3C;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,MAAM,EAAE,CAE7B;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,MAAM,EAAE,CAEjC;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,MAAM,CAE5B;IAED;;OAEG;IACI,QAAQ,IAAI,MAAM;CAW1B"}

package/build/types/MML/Sequencer.d.ts

@@ -0,0 +1,34 @@
+import { MMLSyntaxError } from './Tree';
+import { TreeConstructor } from './TreeConstructor';
+import { Sequence } from './Sequence';
+/**
+ * This class converts syntax tree to array that contains musical note.
+ * @constructor
+ */
+export declare class Sequencer {
+    private sequences;
+    private treeConstructor;
+    private timeOf4note;
+    private octave;
+    private currentTime;
+    /**
+     * @param {TreeConstructor} treeConstructor This argument is instance of `TreeConstructor`.
+     */
+    constructor(treeConstructor: TreeConstructor);
+    /**
+     * This method calculates pitch and music time from Parse Tree.
+     * @return {Array<Sequence>|MMLSyntaxError} Return value is array that contains instance of `Sequence`.
+     *     If error occurs, return value is `MMLSyntaxError`.
+     */
+    get(): Sequence[] | MMLSyntaxError;
+    /**
+     * This method constructs syntax tree.
+     * @param {Tree|null} tree This argument is instance of `Tree` that is added to syntax tree.
+     */
+    private push;
+    /**
+     * This method concatenates previous sequence and current sequence in case of tie.
+     */
+    private concat;
+}
+//# sourceMappingURL=Sequencer.d.ts.map

package/build/types/MML/Sequencer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Sequencer.d.ts","sourceRoot":"","sources":["../../../src/MML/Sequencer.ts"],"names":[],"mappings":"AAWA,OAAO,EAAQ,cAAc,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;GAGG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,eAAe,CAAkB;IAEzC,OAAO,CAAC,WAAW,CAAK;IACxB,OAAO,CAAC,MAAM,CAAW;IACzB,OAAO,CAAC,WAAW,CAAK;IAExB;;OAEG;gBACS,eAAe,EAAE,eAAe;IAI5C;;;;OAIG;IACI,GAAG,IAAI,QAAQ,EAAE,GAAG,cAAc;IAgFzC;;;OAGG;IACH,OAAO,CAAC,IAAI;IAwKZ;;OAEG;IACH,OAAO,CAAC,MAAM;CAQf"}

package/build/types/MML/Token.d.ts

@@ -0,0 +1,40 @@
+export declare type TokenType = 'TEMPO' | 'OCTAVE' | 'NOTE' | 'REST' | 'NUMBER' | 'TIE' | 'SPACE' | 'EOS' | 'UNKNOWN';
+/**
+ * MML characters are corresponds to tokens by this map.
+ * Namely, this map is definitions of MML Tokens.
+ */
+export declare const TokenMap: Map<string | undefined, TokenType>;
+/**
+ * This class is entity for MML token.
+ * This class has token type, token data and token value if token is number.
+ * @constructor
+ */
+export declare class Token {
+    private _id;
+    private _type;
+    private _token;
+    private _value;
+    /**
+     * @param {string} id This argument is string that identifies MML token.
+     * @param {TokenType} type This argument is one of 'TEMPO', 'OCTAVE', 'NOTE', 'REST', 'NUMBER', 'TIE', 'SPACE', 'EOS', 'UNKNOWN'.
+     * @param {string|undefined} token This argument is string that constructs of token.
+     */
+    constructor(id: string, type: TokenType, token: string | undefined);
+    /**
+     * This method is getter for token type.
+     */
+    get type(): TokenType;
+    /**
+     * This method is getter for token.
+     */
+    get token(): string | undefined;
+    /**
+     * This method is getter for token value if token is number.
+     */
+    get value(): number;
+    /**
+     * This method returns fields that `Token` has as JSON.
+     */
+    toString(): string;
+}
+//# sourceMappingURL=Token.d.ts.map

package/build/types/MML/Token.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Token.d.ts","sourceRoot":"","sources":["../../../src/MML/Token.ts"],"names":[],"mappings":"AAAA,oBAAY,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,CAAC;AAE9G;;;GAGG;AACH,eAAO,MAAM,QAAQ,oCA4BnB,CAAC;AAEH;;;;GAIG;AACH,qBAAa,KAAK;IAChB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,KAAK,CAAY;IACzB,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,MAAM,CAAS;IAEvB;;;;OAIG;gBACS,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS;IAOlE;;OAEG;IACH,IAAW,IAAI,IAAI,SAAS,CAE3B;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,MAAM,GAAG,SAAS,CAErC;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED;;OAEG;IACI,QAAQ,IAAI,MAAM;CAQ1B"}

package/build/types/MML/Tokenizer.d.ts

@@ -0,0 +1,21 @@
+import { Token } from './Token';
+/**
+ * This class is for MML Tokenization.
+ * @constructor
+ */
+export declare class Tokenizer {
+    static id: number;
+    private tokens;
+    private notes;
+    private numbers;
+    /**
+     * @param {string} mml This argument is MML string.
+     */
+    constructor(mml: string);
+    /**
+     * This method executes tokenization from MML.
+     * @return {Token|null} Return value is instance of `Token`.
+     */
+    get(): Token | null;
+}
+//# sourceMappingURL=Tokenizer.d.ts.map