rescript-tone 0.1.0

package/README.md

@@ -0,0 +1,175 @@
+# rescript-tone
+
+ReScript bindings for [Tone.js](https://tonejs.github.io/), a Web Audio framework for creating interactive music in the browser.
+
+## Installation
+
+```bash
+npm install rescript-tone tone
+```
+
+Add to your `rescript.json`:
+
+```json
+{
+  "bs-dependencies": ["rescript-tone"]
+}
+```
+
+## Quick Start
+
+```rescript
+open RescriptTone
+
+// Create a synth and connect it to the speakers
+let synth = ToneJs_Synth.make()
+let node = synth->ToneJs_Synth.asAudioNode->ToneJs_AudioNode.toDestination
+
+// Play a note
+let _ = synth->ToneJs_Synth.triggerAttackRelease(440.0, ToneJs_Types.Time.seconds(0.5))
+
+// Start the audio context (required by browsers)
+let _ = ToneJs_Tone.start()
+```
+
+## Usage Examples
+
+### Playing Notes with a Synth
+
+```rescript
+open RescriptTone
+
+let synth = ToneJs_Synth.makeWithOptions({
+  oscillator: ?Some({\"type": ?Some(ToneJs_Types.Sawtooth)}),
+  envelope: ?Some({
+    attack: ?Some(ToneJs_Types.Time.seconds(0.1)),
+    decay: ?Some(ToneJs_Types.Time.seconds(0.2)),
+    sustain: ?Some(0.5),
+    release: ?Some(ToneJs_Types.Time.seconds(0.8)),
+  }),
+})
+
+let _ = synth->ToneJs_Synth.asAudioNode->ToneJs_AudioNode.toDestination
+let _ = synth->ToneJs_Synth.triggerAttackRelease(440.0, ToneJs_Types.Time.seconds(0.5))
+```
+
+### Chaining Effects
+
+```rescript
+open RescriptTone
+
+let synth = ToneJs_Synth.make()
+let reverb = ToneJs_Reverb.makeWithDecay(1.5)
+let delay = ToneJs_FeedbackDelay.makeWithTimeFeedback(ToneJs_Types.Time.notation("8n"), 0.5)
+let dest = ToneJs_Tone.getDestination()
+
+// Chain: synth -> delay -> reverb -> destination
+let _ = synth
+  ->ToneJs_Synth.asAudioNode
+  ->ToneJs_AudioNode.chain([
+    delay->ToneJs_FeedbackDelay.asAudioNode,
+    reverb->ToneJs_Reverb.asAudioNode,
+    dest->ToneJs_Destination.asAudioNode,
+  ])
+```
+
+### Scheduling with Transport
+
+```rescript
+open RescriptTone
+
+let synth = ToneJs_Synth.make()
+let _ = synth->ToneJs_Synth.asAudioNode->ToneJs_AudioNode.toDestination
+
+let transport = ToneJs_Tone.getTransport()
+
+// Set BPM
+let bpm = transport->ToneJs_Transport.bpm
+ToneJs_Param.setValue(bpm, 120.0)
+
+// Schedule a repeating note
+let _ = transport->ToneJs_Transport.scheduleRepeat(
+  _time => {
+    let _ = synth->ToneJs_Synth.triggerAttackRelease(440.0, ToneJs_Types.Time.notation("8n"))
+  },
+  ToneJs_Types.Time.notation("4n"),
+)
+
+// Start the transport
+let _ = transport->ToneJs_Transport.start
+```
+
+### Looping Patterns
+
+```rescript
+open RescriptTone
+
+let synth = ToneJs_Synth.make()
+let _ = synth->ToneJs_Synth.asAudioNode->ToneJs_AudioNode.toDestination
+
+let notes = ["C4", "E4", "G4", "B4"]
+
+let seq = ToneJs_Sequence.makeWithSubdivision(
+  (time, note) => {
+    let _ = synth->ToneJs_Synth.triggerAttackReleaseAt(
+      ToneJs_Types.Frequency.fromNotation(note),
+      ToneJs_Types.Time.notation("8n"),
+      ~time=ToneJs_Types.Time.fromFloat(time),
+    )
+  },
+  notes,
+  ToneJs_Types.Time.notation("4n"),
+)
+
+let _ = seq->ToneJs_Sequence.start
+let _ = ToneJs_Tone.getTransport()->ToneJs_Transport.start
+```
+
+### Polyphonic Synth
+
+```rescript
+open RescriptTone
+
+let poly = ToneJs_PolySynth.makeWithOptions({maxPolyphony: ?Some(4)})
+let _ = poly->ToneJs_PolySynth.asAudioNode->ToneJs_AudioNode.toDestination
+
+// Play a chord
+let _ = poly->ToneJs_PolySynth.triggerAttackRelease(
+  [261.63, 329.63, 392.0],
+  ToneJs_Types.Time.seconds(1.0),
+)
+```
+
+## API Reference
+
+See [docs/API.md](docs/API.md) for the complete API reference.
+
+## Architecture
+
+The library is organized into modules that mirror Tone.js's structure:
+
+| Category | Modules |
+|----------|---------|
+| **Core** | `Tone`, `Context`, `Transport`, `Destination`, `Param`, `AudioNode`, `Types` |
+| **Instruments** | `Synth`, `AMSynth`, `FMSynth`, `MonoSynth`, `PolySynth` |
+| **Sources** | `Oscillator`, `Player`, `Noise` |
+| **Effects** | `Reverb`, `FeedbackDelay`, `Chorus`, `Distortion`, `AutoFilter`, `AutoPanner`, `AutoWah`, `BitCrusher`, `Chebyshev`, `Freeverb`, `JCReverb`, `Phaser`, `PingPongDelay`, `PitchShift`, `Tremolo`, `Vibrato`, `FrequencyShifter`, `StereoWidener` |
+| **Components** | `Compressor`, `Limiter`, `Gate`, `Filter`, `EQ3`, `Panner` |
+| **Signal & Channel** | `Signal`, `Volume`, `Gain`, `Channel`, `CrossFade` |
+| **Scheduling** | `Loop`, `Event`, `Part`, `Sequence` |
+
+Each Tone.js class maps to a ReScript module with an abstract `type t`. Modules expose:
+- `make` / `makeWithOptions` constructors
+- `@send` methods for instance operations
+- `@get` / `@set` for properties
+- `asAudioNode` for casting to the base `ToneJs_AudioNode.t` type (for `connect`, `chain`, etc.)
+
+## Requirements
+
+- ReScript >= 12.0.0
+- Tone.js >= 15.0.0
+- A browser environment with Web Audio API support
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "rescript-tone",
+  "version": "0.1.0",
+  "description": "ReScript bindings for Tone.js",
+  "repository": {
+    "url": "https://github.com/brnrdog/rescript-tone.git",
+    "type": "git"
+  },
+  "keywords": [
+    "rescript",
+    "tonejs",
+    "tone",
+    "audio",
+    "web-audio",
+    "bindings"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "files": [
+    "src/**/*.res"
+  ],
+  "main": "src/ToneJs.res.js",
+  "scripts": {
+    "res:build": "rescript",
+    "res:dev": "rescript -w",
+    "test": "rescript && node tests/Tests.res.js",
+    "vite:dev": "vite",
+    "vite:build": "vite build",
+    "semantic-release": "semantic-release"
+  },
+  "peerDependencies": {
+    "rescript": "^12.0.0",
+    "tone": "^15.0.0"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "rescript": "^12.2.0",
+    "semantic-release": "^25.0.3",
+    "tone": "^15.1.22",
+    "vite": "^6.0.0",
+    "zekr": "^1.8.0"
+  }
+}

package/src/ToneJs.res

@@ -0,0 +1,64 @@
+// ReScript bindings for Tone.js
+// This is the main entry point - re-exports all modules
+
+// Core
+module Types = ToneJs_Types
+module Tone = ToneJs_Tone
+module Context = ToneJs_Context
+module Transport = ToneJs_Transport
+module Destination = ToneJs_Destination
+module Param = ToneJs_Param
+module AudioNode = ToneJs_AudioNode
+
+// Instruments
+module Synth = ToneJs_Synth
+module AMSynth = ToneJs_AMSynth
+module FMSynth = ToneJs_FMSynth
+module MonoSynth = ToneJs_MonoSynth
+module PolySynth = ToneJs_PolySynth
+
+// Sources
+module Oscillator = ToneJs_Oscillator
+module Player = ToneJs_Player
+module Noise = ToneJs_Noise
+
+// Effects
+module Reverb = ToneJs_Reverb
+module FeedbackDelay = ToneJs_FeedbackDelay
+module Chorus = ToneJs_Chorus
+module Distortion = ToneJs_Distortion
+module AutoFilter = ToneJs_AutoFilter
+module AutoPanner = ToneJs_AutoPanner
+module AutoWah = ToneJs_AutoWah
+module BitCrusher = ToneJs_BitCrusher
+module Chebyshev = ToneJs_Chebyshev
+module Freeverb = ToneJs_Freeverb
+module JCReverb = ToneJs_JCReverb
+module Phaser = ToneJs_Phaser
+module PingPongDelay = ToneJs_PingPongDelay
+module PitchShift = ToneJs_PitchShift
+module Tremolo = ToneJs_Tremolo
+module Vibrato = ToneJs_Vibrato
+module FrequencyShifter = ToneJs_FrequencyShifter
+module StereoWidener = ToneJs_StereoWidener
+
+// Components
+module Compressor = ToneJs_Compressor
+module Limiter = ToneJs_Limiter
+module Gate = ToneJs_Gate
+module Filter = ToneJs_Filter
+module EQ3 = ToneJs_EQ3
+module Panner = ToneJs_Panner
+
+// Signal & Channel
+module Signal = ToneJs_Signal
+module Volume = ToneJs_Volume
+module Gain = ToneJs_Gain
+module Channel = ToneJs_Channel
+module CrossFade = ToneJs_CrossFade
+
+// Scheduling
+module Loop = ToneJs_Loop
+module Event = ToneJs_Event
+module Part = ToneJs_Part
+module Sequence = ToneJs_Sequence

package/src/ToneJs.res.js

@@ -0,0 +1,150 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+
+let Types;
+
+let Tone;
+
+let Context;
+
+let Transport;
+
+let Destination;
+
+let Param;
+
+let AudioNode;
+
+let Synth;
+
+let AMSynth;
+
+let FMSynth;
+
+let MonoSynth;
+
+let PolySynth;
+
+let Oscillator;
+
+let Player;
+
+let Noise;
+
+let Reverb;
+
+let FeedbackDelay;
+
+let Chorus;
+
+let Distortion;
+
+let AutoFilter;
+
+let AutoPanner;
+
+let AutoWah;
+
+let BitCrusher;
+
+let Chebyshev;
+
+let Freeverb;
+
+let JCReverb;
+
+let Phaser;
+
+let PingPongDelay;
+
+let PitchShift;
+
+let Tremolo;
+
+let Vibrato;
+
+let FrequencyShifter;
+
+let StereoWidener;
+
+let Compressor;
+
+let Limiter;
+
+let Gate;
+
+let Filter;
+
+let EQ3;
+
+let Panner;
+
+let Signal;
+
+let Volume;
+
+let Gain;
+
+let Channel;
+
+let CrossFade;
+
+let Loop;
+
+let Event;
+
+let Part;
+
+let Sequence;
+
+export {
+  Types,
+  Tone,
+  Context,
+  Transport,
+  Destination,
+  Param,
+  AudioNode,
+  Synth,
+  AMSynth,
+  FMSynth,
+  MonoSynth,
+  PolySynth,
+  Oscillator,
+  Player,
+  Noise,
+  Reverb,
+  FeedbackDelay,
+  Chorus,
+  Distortion,
+  AutoFilter,
+  AutoPanner,
+  AutoWah,
+  BitCrusher,
+  Chebyshev,
+  Freeverb,
+  JCReverb,
+  Phaser,
+  PingPongDelay,
+  PitchShift,
+  Tremolo,
+  Vibrato,
+  FrequencyShifter,
+  StereoWidener,
+  Compressor,
+  Limiter,
+  Gate,
+  Filter,
+  EQ3,
+  Panner,
+  Signal,
+  Volume,
+  Gain,
+  Channel,
+  CrossFade,
+  Loop,
+  Event,
+  Part,
+  Sequence,
+}
+/* No side effect */

package/src/ToneJs_AMSynth.res

@@ -0,0 +1,34 @@
+// Bindings for Tone.AMSynth - AM synthesis
+open ToneJs_Types
+
+type t
+
+type options = {
+  harmonicity?: positive,
+  oscillator?: oscillatorOptions,
+  modulation?: oscillatorOptions,
+  envelope?: envelopeOptions,
+  modulationEnvelope?: envelopeOptions,
+  volume?: decibels,
+}
+
+@module("tone") @new external make: unit => t = "AMSynth"
+@module("tone") @new external makeWithOptions: options => t = "AMSynth"
+
+@send external triggerAttack: (t, frequency) => t = "triggerAttack"
+@send external triggerAttackAt: (t, frequency, ~time: time=?) => t = "triggerAttack"
+@send external triggerAttackAtVel: (t, frequency, ~time: time=?, ~velocity: normalRange=?) => t = "triggerAttack"
+@send external triggerRelease: (t, ~time: time=?) => t = "triggerRelease"
+@send external triggerAttackRelease: (t, frequency, time) => t = "triggerAttackRelease"
+@send external triggerAttackReleaseAt: (t, frequency, time, ~time: time=?) => t = "triggerAttackRelease"
+@send external triggerAttackReleaseAtVel: (t, frequency, time, ~time: time=?, ~velocity: normalRange=?) => t = "triggerAttackRelease"
+
+@get external volume: t => ToneJs_Param.t = "volume"
+@get external frequency: t => ToneJs_Param.t = "frequency"
+@get external detune: t => ToneJs_Param.t = "detune"
+
+@send external dispose: t => t = "dispose"
+@send external sync: t => t = "sync"
+@send external unsync: t => t = "unsync"
+
+external asAudioNode: t => ToneJs_AudioNode.t = "%identity"

package/src/ToneJs_AudioNode.res

@@ -0,0 +1,20 @@
+// Bindings for ToneAudioNode - the base class for all audio nodes
+// All audio nodes (instruments, effects, sources, etc.) extend this
+
+type t
+
+@send external connect: (t, t) => t = "connect"
+@send external connectWithOutput: (t, t, ~outputNum: int) => t = "connect"
+@send external connectWithOutputInput: (t, t, ~outputNum: int, ~inputNum: int) => t = "connect"
+@send external disconnect: t => t = "disconnect"
+@send external disconnectFrom: (t, t) => t = "disconnect"
+@send external toDestination: t => t = "toDestination"
+@send external dispose: t => t = "dispose"
+
+@send @variadic external chain: (t, array<t>) => t = "chain"
+@send @variadic external fan: (t, array<t>) => t = "fan"
+
+@get external numberOfInputs: t => int = "numberOfInputs"
+@get external numberOfOutputs: t => int = "numberOfOutputs"
+@get external channelCount: t => int = "channelCount"
+@set external setChannelCount: (t, int) => unit = "channelCount"

package/src/ToneJs_AutoFilter.res

@@ -0,0 +1,33 @@
+// Bindings for Tone.AutoFilter
+open ToneJs_Types
+
+type t
+
+type options = {
+  frequency?: frequency,
+  \"type"?: oscillatorType,
+  depth?: normalRange,
+  baseFrequency?: frequency,
+  octaves?: positive,
+  filter?: filterOptions,
+  wet?: normalRange,
+}
+
+@module("tone") @new external make: unit => t = "AutoFilter"
+@module("tone") @new external makeWithOptions: options => t = "AutoFilter"
+
+@get external frequency: t => ToneJs_Param.t = "frequency"
+@get external depth: t => ToneJs_Param.t = "depth"
+@get external wet: t => ToneJs_Param.t = "wet"
+@get external octaves: t => positive = "octaves"
+@set external setOctaves: (t, positive) => unit = "octaves"
+@get external baseFrequency: t => frequency = "baseFrequency"
+@set external setBaseFrequency: (t, frequency) => unit = "baseFrequency"
+
+@send external start: (t, ~time: time=?) => t = "start"
+@send external stop: (t, ~time: time=?) => t = "stop"
+@send external sync: t => t = "sync"
+@send external unsync: t => t = "unsync"
+@send external dispose: t => t = "dispose"
+
+external asAudioNode: t => ToneJs_AudioNode.t = "%identity"

package/src/ToneJs_AutoPanner.res

@@ -0,0 +1,26 @@
+// Bindings for Tone.AutoPanner
+open ToneJs_Types
+
+type t
+
+type options = {
+  frequency?: frequency,
+  \"type"?: oscillatorType,
+  depth?: normalRange,
+  wet?: normalRange,
+}
+
+@module("tone") @new external make: unit => t = "AutoPanner"
+@module("tone") @new external makeWithOptions: options => t = "AutoPanner"
+
+@get external frequency: t => ToneJs_Param.t = "frequency"
+@get external depth: t => ToneJs_Param.t = "depth"
+@get external wet: t => ToneJs_Param.t = "wet"
+
+@send external start: (t, ~time: time=?) => t = "start"
+@send external stop: (t, ~time: time=?) => t = "stop"
+@send external sync: t => t = "sync"
+@send external unsync: t => t = "unsync"
+@send external dispose: t => t = "dispose"
+
+external asAudioNode: t => ToneJs_AudioNode.t = "%identity"

package/src/ToneJs_AutoWah.res

@@ -0,0 +1,31 @@
+// Bindings for Tone.AutoWah
+open ToneJs_Types
+
+type t
+
+type options = {
+  baseFrequency?: frequency,
+  octaves?: positive,
+  sensitivity?: decibels,
+  q?: positive,
+  gain?: float,
+  follower?: float,
+  wet?: normalRange,
+}
+
+@module("tone") @new external make: unit => t = "AutoWah"
+@module("tone") @new external makeWithOptions: options => t = "AutoWah"
+
+@get external gain: t => ToneJs_Param.t = "gain"
+@get external q: t => ToneJs_Param.t = "Q"
+@get external wet: t => ToneJs_Param.t = "wet"
+@get external octaves: t => positive = "octaves"
+@set external setOctaves: (t, positive) => unit = "octaves"
+@get external baseFrequency: t => frequency = "baseFrequency"
+@set external setBaseFrequency: (t, frequency) => unit = "baseFrequency"
+@get external sensitivity: t => decibels = "sensitivity"
+@set external setSensitivity: (t, decibels) => unit = "sensitivity"
+
+@send external dispose: t => t = "dispose"
+
+external asAudioNode: t => ToneJs_AudioNode.t = "%identity"

package/src/ToneJs_BitCrusher.res

@@ -0,0 +1,20 @@
+// Bindings for Tone.BitCrusher
+open ToneJs_Types
+
+type t
+
+type options = {
+  bits?: positive,
+  wet?: normalRange,
+}
+
+@module("tone") @new external make: unit => t = "BitCrusher"
+@module("tone") @new external makeWithBits: positive => t = "BitCrusher"
+@module("tone") @new external makeWithOptions: options => t = "BitCrusher"
+
+@get external bits: t => ToneJs_Param.t = "bits"
+@get external wet: t => ToneJs_Param.t = "wet"
+
+@send external dispose: t => t = "dispose"
+
+external asAudioNode: t => ToneJs_AudioNode.t = "%identity"

package/src/ToneJs_Channel.res

@@ -0,0 +1,33 @@
+// Bindings for Tone.Channel - routing and mixing
+open ToneJs_Types
+
+type t
+
+type options = {
+  pan?: audioRange,
+  volume?: decibels,
+  solo?: bool,
+  mute?: bool,
+  channelCount?: int,
+}
+
+@module("tone") @new external make: unit => t = "Channel"
+@module("tone") @new external makeWithVolume: decibels => t = "Channel"
+@module("tone") @new external makeWithVolumePan: (decibels, audioRange) => t = "Channel"
+@module("tone") @new external makeWithOptions: options => t = "Channel"
+
+@get external pan: t => ToneJs_Param.t = "pan"
+@get external volume: t => ToneJs_Param.t = "volume"
+@get external solo: t => bool = "solo"
+@set external setSolo: (t, bool) => unit = "solo"
+@get external mute: t => bool = "mute"
+@set external setMute: (t, bool) => unit = "mute"
+@get external muted: t => bool = "muted"
+
+@send external send: (t, string) => ToneJs_Gain.t = "send"
+@send external sendWithVolume: (t, string, ~volume: decibels=?) => ToneJs_Gain.t = "send"
+@send external receive: (t, string) => t = "receive"
+
+@send external dispose: t => t = "dispose"
+
+external asAudioNode: t => ToneJs_AudioNode.t = "%identity"

package/src/ToneJs_Chebyshev.res

@@ -0,0 +1,24 @@
+// Bindings for Tone.Chebyshev - waveshaping distortion
+open ToneJs_Types
+
+type t
+
+type options = {
+  order?: int,
+  oversample?: oversampleType,
+  wet?: normalRange,
+}
+
+@module("tone") @new external make: unit => t = "Chebyshev"
+@module("tone") @new external makeWithOrder: int => t = "Chebyshev"
+@module("tone") @new external makeWithOptions: options => t = "Chebyshev"
+
+@get external order: t => int = "order"
+@set external setOrder: (t, int) => unit = "order"
+@get external oversample: t => oversampleType = "oversample"
+@set external setOversample: (t, oversampleType) => unit = "oversample"
+@get external wet: t => ToneJs_Param.t = "wet"
+
+@send external dispose: t => t = "dispose"
+
+external asAudioNode: t => ToneJs_AudioNode.t = "%identity"

package/src/ToneJs_Chorus.res

@@ -0,0 +1,37 @@
+// Bindings for Tone.Chorus
+open ToneJs_Types
+
+type t
+
+type options = {
+  frequency?: frequency,
+  delayTime?: milliseconds,
+  depth?: normalRange,
+  \"type"?: oscillatorType,
+  spread?: degrees,
+  feedback?: normalRange,
+  wet?: normalRange,
+}
+
+@module("tone") @new external make: unit => t = "Chorus"
+@module("tone") @new external makeWithArgs: (frequency, milliseconds, normalRange) => t = "Chorus"
+@module("tone") @new external makeWithOptions: options => t = "Chorus"
+
+@get external frequency: t => ToneJs_Param.t = "frequency"
+@get external depth: t => normalRange = "depth"
+@set external setDepth: (t, normalRange) => unit = "depth"
+@get external delayTime: t => milliseconds = "delayTime"
+@set external setDelayTime: (t, milliseconds) => unit = "delayTime"
+@get external getType: t => oscillatorType = "type"
+@set external setType: (t, oscillatorType) => unit = "type"
+@get external spread: t => degrees = "spread"
+@set external setSpread: (t, degrees) => unit = "spread"
+@get external wet: t => ToneJs_Param.t = "wet"
+
+@send external start: (t, ~time: time=?) => t = "start"
+@send external stop: (t, ~time: time=?) => t = "stop"
+@send external sync: t => t = "sync"
+@send external unsync: t => t = "unsync"
+@send external dispose: t => t = "dispose"
+
+external asAudioNode: t => ToneJs_AudioNode.t = "%identity"