ruck 0.1.2 → 0.2.0

data/README

@@ -1,67 +1,35 @@
 A port of ChucK's strong timing to Ruby!
 
-Use Ruck's "shreds" to coordinate interleaved execution
-of threads (continuations) with precise virtual timing.
-Actual run-time is abstracted and shreds declare how much
-virtual time they took to execute. Scheduling of shreds
-is done by a ...
+ruck lets you easily create a virtual clock against
+which precise timing of execution can be guaranteed. The
+virtual clock can be kept roughly in sync with real time
+if you want it to, but you don't have to. For example, in
+ChucK, even if your scripts take too long to generate
+samples in real time, the audio stream isn't compromised
+because it's timed against the virtual clock.
 
-  SHREDULER
+ruck provides an easily extended scheduler for non-preemptive
+shreds (threads) implemented using continuations.
+Cooperatively scheduled threads usually don't require
+synchronization since execution is never interrupted.
 
-UGenShreduler:
-
-  This shreduler calculates an audio unit generator graph's
-  output in virtual time. The graph can be modified by
-  shreds all the while.
-
-  The graph is written in Ruby for flexibility, so it's
-  too slow (on my computer) for real time, so there is no
-  real-time playback. You can use WavOut, though.
-  (See ex01.rb)
-
-  Check out the library of built-in unit generators in ugen/
-  and make your own.
+A few example shredulers (schedulers) are provided:
 
-  Unit Generator Usage
-  ====================
-
-  Play a sine wave (ex02.rb):
-
-    s = SinOsc.new(:freq => 440)
-    w = WavOut.new(:filename => "ex02.wav")
-    s >> w >> blackhole
-    play 3.seconds
-
-  Attach lambdas to unit generator attributes (ex03.rb):
+UGenShreduler:
 
-    wav = WavOut.new(:filename => "ex03.wav")
-    sin2 = SinOsc.new(:freq => 3)
-    sin = SinOsc.new(:freq => L{ sin2.last * 220 + 660 },
-                     :gain => L{ 0.5 + sin2.last * 0.5 })
-    [sin >> wav, sin2] >> blackhole
-    play 3.seconds
+  Recently moved to its own gem: ruck-ugen
 
 RealTimeShreduler
 
-  This shreduler attempts to keep virtual time in line with
-  real time.
-  (See ex10.rb)
+  Recently moved to its own gem: ruck-realtime
 
 MIDIShreduler
 
-  This shreduler uses MIDIator and midilib to support live
-  MIDI playback and saving MIDI to disk. An example runner
-  is provided in midi_runner.rb which you invoke like this:
-  
-    $ ruck_midi MIDI_FILENAME NUM_TRACKS LIVE SCRIPT_FILENAME [...]
-  
-  where LIVE is "no" to only save the MIDI output, or "yes"
-  to also play in real-time.
+  Recently moved to its own gem: ruck-midi
 
 GLAppShreduler
 
-  You don't want to know. (But the scripts are included so
-  you can find them if you're really curious.)
+  You don't want to know. But see ruck-glapp if you do.
 
 USAGE
 =====
@@ -77,4 +45,4 @@ examples/ directory. Those scripts contain no boilerplate includes
 because they are written to be invoked on the command line by
 one of the bin/ scripts. For example:
 
-  $ ruck_ugen examples/ex01.rb
+  $ ruck_ugen examples/ugen/ex01.rb

data/Rakefile

@@ -1,25 +1,25 @@
+require 'rubygems'
+require 'rake'
 
 begin
   require "jeweler"
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "ruck"
-    gemspec.email = "tom@alltom.com"
-    gemspec.homepage = "http://github.com/alltom/ruck"
-    gemspec.authors = ["Tom Lieber"]
-    gemspec.summary = "strong timing for Ruby: cooperative threads on a virtual clock"
-    gemspec.description = <<-EOF
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ruck"
+    gem.email = "tom@alltom.com"
+    gem.homepage = "http://github.com/alltom/ruck"
+    gem.authors = ["Tom Lieber"]
+    gem.summary = "strong timing for Ruby: cooperative threads on a virtual clock"
+    gem.description = <<-EOF
       Ruck uses continuations and a simple scheduler to ensure "shreds"
-      (threads in Ruck) are woken at precisely the right time according
+      (Ruck threads) are woken at precisely the right time according
       to its virtual clock. Schedulers can map virtual time to samples
       in a WAV file, real time, time in a MIDI file, or anything else
       by overriding "sim_to" in the Shreduler class.
-      
-      A small library of useful unit generators and plenty of examples
-      are provided. See the README or the web page for details.
     EOF
-    gemspec.has_rdoc = false
+    gem.has_rdoc = false
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jewler not available. Install it with: sudo gem install jeweler"
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/ruck/shreduling.rb

@@ -4,6 +4,7 @@ module Ruck
   class Shred
     attr_accessor :now
     attr_accessor :finished
+    attr_accessor :name
 
     def initialize(shreduler, now, name, &block)
       @shreduler = shreduler
@@ -28,6 +29,7 @@ module Ruck
       end
       
       @finished = true
+      @shreduler.remove_shred self
     end
 
     def yield(samples)
@@ -41,7 +43,12 @@ module Ruck
     end
 
     def finish
-      @resume.call # last save point
+      @finished = true
+      @shreduler.remove_shred self
+      
+      if @shreduler.current_shred == self
+        @resume.call # last save point
+      end
     end
 
     # shreds sort in order of position in time
@@ -66,14 +73,15 @@ module Ruck
       @running = false
     end
 
-    def spork(name = "", &shred)
-      LOG.debug "Adding shred \"#{name}\" at #{@now}"
-      @shreds << Shred.new(self, @now, name, &shred)
-      @shred
+    def spork(name = "", &shred_block)
+      shred = Shred.new(self, @now, name, &shred_block)
+      LOG.debug "Adding shred \"#{shred.name}\" at #{@now}"
+      @shreds << shred
+      shred
     end
 
     def remove_shred(shred)
-      LOG.debug "Removing shred \"#{name}\" at #{@now}"
+      LOG.debug "Removing shred \"#{shred.name}\" at #{@now}"
       @shreds.delete shred
     end
     
@@ -82,7 +90,7 @@ module Ruck
     end
 
     # called when shreds allow time to pass
-    # a convnient method to override
+    # a convenient method to override
     def sim_to(new_now)
       @now = new_now
     end
@@ -101,11 +109,11 @@ module Ruck
       
       sim_to(shred.now)
       
-      invoke_shred shred
+      invoke_shred(shred)
 
       if @current_shred.finished
         LOG.debug "#{shred} finished"
-        @shreds.delete(shred)
+        remove_shred(shred)
       end
     end
 
@@ -123,36 +131,5 @@ module Ruck
       @running = false
     end
   end
-  
-  class UGenShreduler < Shreduler
-    def run
-      require File.join(File.dirname(__FILE__), "misc", "pcm_time_helpers")
-      super
-    end
-    
-    def sim_to(new_now)
-      while @now < new_now.to_i
-        BLACKHOLE.next @now
-        @now += 1
-      end
-    end
-  end
-  
-  class RealTimeShreduler < Shreduler
-    def run
-      @start_time = Time.now
-      super
-    end
-    
-    def sim_to(new_now)
-      actual_now = Time.now
-      simulated_now = @start_time + (new_now.to_f / SAMPLE_RATE)
-      if simulated_now > actual_now
-        sleep(simulated_now - actual_now)
-      end
-      
-      @now = new_now
-    end
-  end
 
 end

data/lib/ruck.rb

@@ -6,8 +6,3 @@ module Ruck
 end
 
 require File.join(File.dirname(__FILE__), "ruck", "shreduling")
-require File.join(File.dirname(__FILE__), "ruck", "misc", "metaid")
-require File.join(File.dirname(__FILE__), "ruck", "misc", "linkage")
-require File.join(File.dirname(__FILE__), "ruck", "ugen", "general")
-require File.join(File.dirname(__FILE__), "ruck", "ugen", "wav")
-require File.join(File.dirname(__FILE__), "ruck", "ugen", "oscillators")

data/ruck.gemspec

@@ -5,22 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruck}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tom Lieber"]
-  s.date = %q{2009-11-21}
+  s.date = %q{2010-07-10}
   s.description = %q{      Ruck uses continuations and a simple scheduler to ensure "shreds"
-      (threads in Ruck) are woken at precisely the right time according
+      (Ruck threads) are woken at precisely the right time according
       to its virtual clock. Schedulers can map virtual time to samples
       in a WAV file, real time, time in a MIDI file, or anything else
       by overriding "sim_to" in the Shreduler class.
-      
-      A small library of useful unit generators and plenty of examples
-      are provided. See the README or the web page for details.
 }
   s.email = %q{tom@alltom.com}
-  s.executables = ["ruck_glapp", "ruck_midi", "ruck_sleep", "ruck_ugen"]
   s.extra_rdoc_files = [
     "README"
   ]
@@ -29,64 +25,15 @@ Gem::Specification.new do |s|
      "README",
      "Rakefile",
      "VERSION",
-     "bin/ruck_glapp",
-     "bin/ruck_midi",
-     "bin/ruck_sleep",
-     "bin/ruck_ugen",
-     "examples/glapp/ex01.rb",
-     "examples/glapp/ex02.rb",
-     "examples/glapp/ex03.rb",
-     "examples/midi/ex01.rb",
-     "examples/midi/ex02.rb",
-     "examples/ugen/ex01.rb",
-     "examples/ugen/ex02.rb",
-     "examples/ugen/ex03.rb",
-     "examples/ugen/ex04.rb",
-     "examples/ugen/ex05.rb",
-     "examples/ugen/ex06.rb",
-     "examples/ugen/ex07.rb",
-     "examples/ugen/ex08.rb",
-     "examples/ugen/ex09.rb",
-     "examples/ugen/ex10.rb",
-     "examples/ugen/ex11.rb",
-     "examples/ugen/ex12.rb",
      "lib/ruck.rb",
-     "lib/ruck/bench.rb",
-     "lib/ruck/misc/linkage.rb",
-     "lib/ruck/misc/metaid.rb",
-     "lib/ruck/misc/pcm_time_helpers.rb",
-     "lib/ruck/misc/riff.rb",
-     "lib/ruck/misc/wavparse.rb",
      "lib/ruck/shreduling.rb",
-     "lib/ruck/ugen/general.rb",
-     "lib/ruck/ugen/oscillators.rb",
-     "lib/ruck/ugen/wav.rb",
      "ruck.gemspec"
   ]
   s.homepage = %q{http://github.com/alltom/ruck}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{strong timing for Ruby: cooperative threads on a virtual clock}
-  s.test_files = [
-    "examples/glapp/ex01.rb",
-     "examples/glapp/ex02.rb",
-     "examples/glapp/ex03.rb",
-     "examples/midi/ex01.rb",
-     "examples/midi/ex02.rb",
-     "examples/ugen/ex01.rb",
-     "examples/ugen/ex02.rb",
-     "examples/ugen/ex03.rb",
-     "examples/ugen/ex04.rb",
-     "examples/ugen/ex05.rb",
-     "examples/ugen/ex06.rb",
-     "examples/ugen/ex07.rb",
-     "examples/ugen/ex08.rb",
-     "examples/ugen/ex09.rb",
-     "examples/ugen/ex10.rb",
-     "examples/ugen/ex11.rb",
-     "examples/ugen/ex12.rb"
-  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: ruck
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Tom Lieber
@@ -9,17 +14,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-21 00:00:00 -08:00
+date: 2010-07-10 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: "      Ruck uses continuations and a simple scheduler to ensure \"shreds\"\n      (threads in Ruck) are woken at precisely the right time according\n      to its virtual clock. Schedulers can map virtual time to samples\n      in a WAV file, real time, time in a MIDI file, or anything else\n      by overriding \"sim_to\" in the Shreduler class.\n      \n      A small library of useful unit generators and plenty of examples\n      are provided. See the README or the web page for details.\n"
+description: "      Ruck uses continuations and a simple scheduler to ensure \"shreds\"\n      (Ruck threads) are woken at precisely the right time according\n      to its virtual clock. Schedulers can map virtual time to samples\n      in a WAV file, real time, time in a MIDI file, or anything else\n      by overriding \"sim_to\" in the Shreduler class.\n"
 email: tom@alltom.com
-executables: 
-- ruck_glapp
-- ruck_midi
-- ruck_sleep
-- ruck_ugen
+executables: []
+
 extensions: []
 
 extra_rdoc_files: 
@@ -29,38 +31,8 @@ files:
 - README
 - Rakefile
 - VERSION
-- bin/ruck_glapp
-- bin/ruck_midi
-- bin/ruck_sleep
-- bin/ruck_ugen
-- examples/glapp/ex01.rb
-- examples/glapp/ex02.rb
-- examples/glapp/ex03.rb
-- examples/midi/ex01.rb
-- examples/midi/ex02.rb
-- examples/ugen/ex01.rb
-- examples/ugen/ex02.rb
-- examples/ugen/ex03.rb
-- examples/ugen/ex04.rb
-- examples/ugen/ex05.rb
-- examples/ugen/ex06.rb
-- examples/ugen/ex07.rb
-- examples/ugen/ex08.rb
-- examples/ugen/ex09.rb
-- examples/ugen/ex10.rb
-- examples/ugen/ex11.rb
-- examples/ugen/ex12.rb
 - lib/ruck.rb
-- lib/ruck/bench.rb
-- lib/ruck/misc/linkage.rb
-- lib/ruck/misc/metaid.rb
-- lib/ruck/misc/pcm_time_helpers.rb
-- lib/ruck/misc/riff.rb
-- lib/ruck/misc/wavparse.rb
 - lib/ruck/shreduling.rb
-- lib/ruck/ugen/general.rb
-- lib/ruck/ugen/oscillators.rb
-- lib/ruck/ugen/wav.rb
 - ruck.gemspec
 has_rdoc: true
 homepage: http://github.com/alltom/ruck
@@ -75,36 +47,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: "strong timing for Ruby: cooperative threads on a virtual clock"
-test_files: 
-- examples/glapp/ex01.rb
-- examples/glapp/ex02.rb
-- examples/glapp/ex03.rb
-- examples/midi/ex01.rb
-- examples/midi/ex02.rb
-- examples/ugen/ex01.rb
-- examples/ugen/ex02.rb
-- examples/ugen/ex03.rb
-- examples/ugen/ex04.rb
-- examples/ugen/ex05.rb
-- examples/ugen/ex06.rb
-- examples/ugen/ex07.rb
-- examples/ugen/ex08.rb
-- examples/ugen/ex09.rb
-- examples/ugen/ex10.rb
-- examples/ugen/ex11.rb
-- examples/ugen/ex12.rb
+test_files: []
+

data/bin/ruck_glapp

@@ -1,162 +0,0 @@
-#!/usr/bin/env ruby
-$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-
-# requires glapp gem
-# sudo gem install alltom-glapp
-# see http://alltom.com/pages/glapp for more details
-# UPDATE: ugh, github stopped producing gems.
-#         find a way to get it on your own 'til I fix that.
-
-require "ruck"
-
-require "rubygems"
-require "glapp"
-
-class GLAppShreduler < Ruck::Shreduler
-  def initialize
-    @shred_queues = {}
-    [:frame,
-     :key_down, :key_up,
-     :mouse_down, :mouse_up, :mouse_move].each do |q|
-      @shred_queues[q] = []
-    end
-    super
-  end
-  
-  def starting
-    @start_time = Time.now
-  end
-  
-  def actual_now
-    Time.now - @start_time
-  end
-  
-  def sleep_current_til(queue)
-    shred = current_shred
-    @shreds.delete(shred)
-    @shred_queues[queue] << shred
-    shred.yield(0)
-    
-    @ev
-  end
-  
-  def raise_event(ev, queue)
-    # should use actual_now,
-    # but we don't want to put it into the future
-    new_now = actual_now
-    new_now = [new_now, next_shred.now].min if next_shred
-    @now = new_now
-    
-    @ev = ev # returned by sleep_current_til
-    
-    shreds = @shred_queues[queue]
-    @shred_queues[queue] = []
-    
-    shreds.each do |shred|
-      shred.now = new_now
-      @shreds << shred
-      invoke_shred shred
-    end
-  end
-  
-  def catch_up
-    while shreds.length > 0 && next_shred.now < actual_now
-      run_one
-    end
-  end
-end
-
-module ShredLocal
-  def spork(name = "unnamed", &shred)
-    SHREDULER.spork(name, &shred)
-  end
-  
-  def wait(seconds)
-    SHREDULER.current_shred.yield(seconds)
-  end
-  
-  def wait_for_frame
-    SHREDULER.sleep_current_til(:frame)
-  end
-  
-  def wait_for_key_down
-    SHREDULER.sleep_current_til(:key_down)
-  end
-  
-  def wait_for_key_up
-    SHREDULER.sleep_current_til(:key_down)
-  end
-  
-  def wait_for_mouse_down
-    SHREDULER.sleep_current_til(:mouse_down)
-  end
-  
-  def wait_for_mouse_up
-    SHREDULER.sleep_current_til(:mouse_up)
-  end
-  
-  def wait_for_mouse_move
-    SHREDULER.sleep_current_til(:mouse_move)
-  end
-end
-
-class MySketch
-  include GLApp
-  
-  def setup
-    ARGV.each do |filename|
-      SHREDULER.spork(filename) do
-        require filename
-      end
-    end
-    @events = []
-    
-    SHREDULER.starting
-  end
-  
-  def draw
-    @events.each do |pair|
-      ev, queue = pair
-      SHREDULER.raise_event ev, queue
-    end
-    @events = []
-    
-    SHREDULER.catch_up # execute shreds whose time came while drawing previous frame
-    
-    SHREDULER.raise_event Object.new, :frame
-  end
-  
-  def keyboard_down(key, modifiers)
-    @events << [Struct.new(:key).new(key), :key_down]
-  end
-  
-  def keyboard_up(key, modifiers)
-    @events << [Struct.new(:key).new(key), :key_up]
-  end
-  
-  def special_keyboard_down(key, modifiers)
-    @events << [Struct.new(:key).new(key), :key_down]
-  end
-  
-  def special_keyboard_up(key, modifiers)
-    @events << [Struct.new(:key).new(key), :key_up]
-  end
-  
-  def mouse_click(button, state, x, y)
-    if state == 0
-      @events << [Struct.new(:button, :x, :y).new(button, x, y), :mouse_down]
-    else
-      @events << [Struct.new(:button, :x, :y).new(button, x, y), :mouse_up]
-    end
-  end
-  
-  def mouse_motion(x, y)
-    @events << [Struct.new(:x, :y).new(x, y), :mouse_move]
-  end
-end
-
-SHREDULER = GLAppShreduler.new
-
-include GLApp::Helpers
-include ShredLocal
-MySketch.new.show 800, 600, "My Sketch"