collavoce 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,5 +1,35 @@
 = collavoce
 
-Powering MIDI through ruby.
+Powering MIDI through JRuby.
 
+= Installation
 
+    gem install collavoce
+
+Or get the repo and run `rake gem` to make your own gem to install. Or point bundler at it, or tweak your load path, your call really.
+
+Oh, and this is JRuby only at the moment. MRI should be doable I just haven't gotten around to it yet.
+
+= Usage
+
+Right now this is still a little raw, but have a look at examples/zelda.rb to get a feel for it.
+
+The basic idea is just a DSL for building melodies from arrays of strings. These notes and timings are then used to send MIDI events. Currently the MIDI device isn't configuratable (see lib/collavoce/voice.rb on that one). But that should get cleaned up soon.
+
+The note syntax is inspired by jFugue. The pattern is:
+
+    NOTE - OCTAVE - TIMING
+
+So note can be "C" or "C#" or "Ebb". Follow that with an optional octave number (default is 4). Then timing characters. Options are "w"hole, "h"alf, "q"uarter, "s"ixteenth, "t"hirtysecond. And you can combine timings. So a dotted quarter note would be "qe".
+
+Additionall if you use "R" as the note it will produce a rest in the melody. Same timing pattern applies. Octave will be, of course, ignored.
+
+So "Twinkle Twinkle little star" could be: %w(C C G G A A Gh)
+
+Each Voice represents a part of the song. It gets a channel and notes, then you can put it in a tracker like this:
+
+    Collavoce::Tracker.new([TwinkleTwinkle]).run
+
+The tracker allows for multiple parallel tracks of voice sequences. This uses threading right now, but I could see moving to Ruck if timing ever got a little off.
+
+If you want a Voice to have more interesting characteristics than just the notes you can override Voice#run and do whatever you want. I've included helpers for diminishing (half step down) and augmenting (half step up) sets of notes. So far this has been enough for me, but I'm sure we'll start adding more helpers once more people try making things with this.

data/lib/collavoce/note.rb

@@ -79,5 +79,9 @@ module Collavoce
       copy.dim!
       copy
     end
+
+    def ==(other)
+      value == other.value && duration == other.duration
+    end
   end
 end

data/lib/collavoce/tracker.rb

@@ -15,5 +15,9 @@ module Collavoce
       end
       @threads.map(&:join)
     end
+
+    def loop(bpm=120)
+      run(bpm) while true
+    end
   end
 end

data/lib/collavoce/voice.rb

@@ -41,13 +41,18 @@ module Collavoce
     end
   
     def send_note(note, channel)
-      noteon = ShortMessage.new
-      noteon.set_message(ShortMessage::NOTE_ON, channel, note.value, 127);
-      noteoff = ShortMessage.new
-      noteoff.set_message(ShortMessage::NOTE_OFF, channel, note.value, 127);
-      receiver.send(noteon, 0)
-      sleep @bar_duration * note.duration
-      receiver.send(noteoff, 0)
+      duration = @bar_duration * note.duration
+      if note.value
+        noteon = ShortMessage.new
+        noteon.set_message(ShortMessage::NOTE_ON, channel, note.value, 127);
+        noteoff = ShortMessage.new
+        noteoff.set_message(ShortMessage::NOTE_OFF, channel, note.value, 127);
+        receiver.send(noteon, 0)
+        sleep duration
+        receiver.send(noteoff, 0)
+      else
+        sleep duration
+      end
     end
   
     def play(this_many = 1)
@@ -57,5 +62,32 @@ module Collavoce
        end
      end
     end
+
+    def run
+      play
+    end
+
+    def mod_notes(*indices)
+      if indices.empty?
+        notes_to_mod = notes
+      else
+        notes_to_mod = notes.values_at(*indices)
+      end
+      notes_to_mod.each do |n|
+        yield n
+      end
+    end
+
+    def dim_notes(*indices)
+      mod_notes(*indices) do |n|
+        n.dim!
+      end
+    end
+
+    def aug_notes(*indices)
+      mod_notes(*indices) do |n|
+        n.aug!
+      end
+    end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
     - 0
     - 0
-    - 2
-  version: 0.0.2
+    - 3
+  version: 0.0.3
 platform: ruby
 authors: 
   - Mat Schaffer
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-01 00:00:00 -05:00
+date: 2010-12-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
   - !ruby/object:Gem::Dependency