https://github.com/merongivian/tone.rb

Ruby Wrapper for Tone.js
https://github.com/merongivian/tone.rb

opal ruby tonejs web-audio

Last synced: 4 months ago
JSON representation

Ruby Wrapper for Tone.js

• Host: GitHub
• URL: https://github.com/merongivian/tone.rb
• Owner: merongivian
• License: mit
• Created: 2017-11-23T04:33:19.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-09-01T07:40:15.000Z (10 months ago)
• Last Synced: 2024-03-03T08:04:10.110Z (4 months ago)
• Topics: opal, ruby, tonejs, web-audio
• Language: Ruby
• Size: 261 KB
• Stars: 1
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Lists

• awesome-opal - Tone.rb - Ruby wrapper for Tone.js (Uncategorized / Uncategorized)
• awesome-opal - Tone.rb - Ruby wrapper for Tone.js (Uncategorized / Uncategorized)

README

        
# Tone.rb

Ruby wrapper for [Tone.js](https://github.com/feedjira/feedjira). This is used in the live coding environment of [Negasonic](https://negasonic.herokuapp.com/)

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'tone.rb'

```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install tone

## Usage

Tone.rb targets version 11 of Tone.js. This are the current implemented modules:

### Transport

Handles the global execution of elements in Tone.js

```ruby

# play after 0.1 seconds

Tone::Transport.start("+0.1")

# stop now

Tone::Transport.stop

```

### Synth

Adds basic functionality for handling it as an input node, playing notes, as well as the ability

to compare it with other synths

```ruby

# Volume is measured in decibels

synth = Tone::Synth::FM.new(volume: 2)

# Play the E2 note at 0 and release at 0.5 seconds

synth.trigger_attack_release('E2', 0.5, 0)

# Each synths are compared by the volume attribute

synth == Tone::Synth::FM.new(volume: 2) #=> true

synth == Tone::Synth::FM.new(volume: 3) #=> false

synth == Tone::Synth::AM.new(volume: 2) #=> false

# Connect all effects between each other and connect the synth as the input

synth.chain(array_of_effects)

```

### Effect

Similar to `Synth`, you can compare between effects, as well as remove

them trough `Effect#dispose` (good for performance)

```ruby

# each effect has specific attributes

vibrato = Tone::Effect::Vibrato.new(frequency: 5, depth: 0.1)

vibrato == Tone::Effect::Vibrato.new(frequency: 5, depth: 0.2) #=> false

```

### Event

Events schedules a group of notes in a certain order across the `Transport`

```ruby

# schedules notes in order every 2 seconds

Tone::Event::Sequence.new([['E2', 'C1'], 'D2'], 'C2'], 2) do |time, note|

  Tone::Synth::FM.new.trigger_attack_release note, '1', time

end

# schedules notes in a random order

pattern = Tone::Event::Pattern.new(['E2', 'C1', 'D2', 'C2'], :random) do |time, note|

  Tone::Synth::FM.new.trigger_attack_release note, '1', time

end

# every 2 seconds

pattern.interval = 2

# run it in loop mode

pattern.start(0)

pattern.loop = true

```

for more info check the [Tone.js Docs](https://tonejs.github.io/docs/)

## TODO

* Basic tests

* Wrap remaining Tone.js modules

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/merongivian/tone.rb

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).