scruby 0.2.7

data/lib/scruby/ugens/ugen_operations.rb

@@ -0,0 +1,57 @@
+module Scruby
+  module Ugens
+    # This module enables Ugen operations for Ugens, Numeric and Arrays, when any instance of this classes executes an operation with an Ugen a BinaryUgenOp 
+    # is instantiated where both objects are the inputs of the operation, an UnaryUgenOp is instantiated for unary operations
+    # This are the permited operations:
+    #
+    # Binary: 
+    # +, -, *, div, /, mod, <=, >=, minimum, maximum, lcm, gcd, round, roundUp, trunc, atan2, hypot, hypotApx, pow, leftShift, rightShift, unsignedRightShift, ring1, ring2, ring3, ring4, difsqr, sumsqr, sqrsum, sqrdif, absdif, thresh, amclip, scaleneg, clip2, excess, fold2, wrap2, rrand and exprand 
+    # 
+    # Unary:
+    # neg, bitNot, abs, asFloat, ceil, floor, frac, sign, squared, cubed, sqrt, exp, reciprocal, midicps, cpsmidi, midiratio, ratiomidi, dbamp, ampdb, octcps, cpsoct, log, log2, log10, sin, cos, tam, asin, acos, atan, sinh, cosh, tanh, rand, rand2, linrand, bilinrand, sum3rand, distort, softclip, coin, rectWindow, hanWindow, welWindow, triWindow, ramp and scurve 
+    # 
+    module UgenOperations
+      operation_indices = YAML::load File.open( File.dirname(__FILE__) + "/operation_indices.yaml" )
+      UNARY      = operation_indices['unary']
+      BINARY     = operation_indices['binary']
+      SAFE_NAMES = { :+ => :plus, :- => :minus, :* => :mult, :/ => :div2, :<= => :less_than_or_eql, :>= => :more_than_or_eql }
+
+      def self.included klass
+        # Define unary operations
+        UNARY.each_key do |op| 
+          define_method(op){ UnaryOpUGen.new op, self } unless klass.instance_methods.include? op
+        end
+
+        # Define binary operations
+        ugen_subclass = klass.ancestors.include? Ugen
+        meth_def =
+        if ugen_subclass
+          proc do |safe, op|
+            proc{ |input| BinaryOpUGen.new op, self, input }
+          end
+        else
+          proc do |safe, op|
+            proc do |input|
+              if input.kind_of? Ugen
+                BinaryOpUGen.new op, self, input
+              else
+                __send__ "__original_#{ safe }", input
+              end
+            end
+          end
+        end
+
+        BINARY.each_key do |op|
+          safe = SAFE_NAMES[op]
+          define_method "__ugenop_#{ safe || op }", &meth_def.call(safe || op, op)
+          klass.send :alias_method, "__original_#{ safe || op }", op if safe unless ugen_subclass
+          klass.send :alias_method, op, "__ugenop_#{ safe || op }"
+        end
+      end
+    end
+
+    [Ugen, Fixnum, Float].each{ |k| k.send :include, UgenOperations }
+  end
+end
+
+

data/lib/scruby/ugens/ugens.rb

@@ -0,0 +1,95 @@
+module Scruby
+  module Ugens
+
+    #
+    # Default SuperCollider Ugens definitions are stored in the ugen_defs.yml file and are defined as Ruby classes on the fly, the yml format is:
+    # 
+    #   NewUgen: 
+    #     :control: 
+    #     - - :input
+    #       - 
+    #     - - :freq
+    #       - 440
+    #     :audio: 
+    #     - - :input
+    #       - 
+    #     - - :freq
+    #       - 440
+    #
+    # To define a Ruby class corresponding to an Ugen +name+ should be passed and a hash of +rates+, inputs and default values, default values can be nil
+    # 
+    #   Ugens.define_ugen( 'NewUgen', {:control => [[:input, nil], [:freq, 440]], :audio => [[:input, nil], [:freq, 440]]} )
+    #
+    # The previous is equivalent as the following ruby code:
+    # 
+    #   class NewUgen < Ugen
+    #     class << self
+    #       def kr( input, freq = 440 )
+    #         new :control, input, freq
+    #       end
+    #     
+    #       def ar( input, freq = 440)
+    #         new :audio, input, freq
+    #       end
+    #       # Makes possible passing args either in order or as argument hash
+    #       named_arguments_for :ar, :kr
+    #     end
+    #   end
+    #       
+    # In future versions Ugen definitions will be loaded from ~/Ugens or ~/.Ugens directories either as yml files or rb files
+    #
+    def self.define_ugen name, rates
+      rate_name = {:audio => :ar, :control => :kr, :scalar => :ir, :demand => :new}
+
+      methods = rates.collect do |rate, args|
+        if rate == :demand or rate == :scalar
+          <<-RUBY_EVAL
+            def new #{ args.collect{ |a, v| "#{ a } = #{ v.inspect }"  }.join(', ') }
+              super #{ args.unshift([rate.inspect]).collect{ |a| a.first }.join(', ') }
+            end
+          RUBY_EVAL
+        else
+          args ||= []
+          args.push [:mul, 1], [:add, 0]
+          args.uniq!
+          assigns = []
+          args.each_with_index do |arg, index|
+            key, val = arg
+            assigns << %{  
+              #{ key } = opts[:#{ key }] || args[#{ index }] || #{ val }
+              raise( ArgumentError.new("`#{ key }` value must be provided") ) unless #{ key }
+            }
+          end
+
+          new_args = [":#{ rate }"] + args[0...-2].collect{ |a| a.first }
+          <<-RUBY_EVAL
+          def #{ rate_name[rate] } *args
+            raise ArgumentError.new("wrong number of arguments (\#{ args } for #{ args.size })") if args.size > #{args.size}
+            opts = args.last.kind_of?( Hash ) ? args.pop : {}
+            #{ assigns.join("\n") }
+            new( #{ new_args.join(', ') } ).muladd( mul, add )
+          end
+
+          def params
+            @params
+          end
+          RUBY_EVAL
+        end
+      end.join("\n")
+
+      self.class_eval <<-RUBY_EVAL
+      class #{ name } < Ugen
+        @params = #{ rates.inspect }
+        class << self
+          #{ methods }
+        end
+      end
+      RUBY_EVAL
+      # # TODO: Load from ~/Ugens directory
+    end
+
+    YAML::load( File.open( File.dirname(__FILE__) + "/ugen_defs.yaml" ) ).each_pair do |key, value| 
+      self.define_ugen key, value
+    end
+  end
+end

data/lib/scruby/version.rb

@@ -0,0 +1,3 @@
+module Scruby
+  VERSION = "0.2.7"
+end

data/lib/scruby.rb

@@ -0,0 +1,65 @@
+#--
+# Copyright (c) 2008 Macario Ortega
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'date'
+require 'rubygems'
+require 'arguments'
+require 'ruby-osc'
+require 'eventmachine'
+require 'yaml'
+
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require "scruby/version"
+
+require "scruby/core_ext/object"
+require "scruby/core_ext/array"
+require "scruby/core_ext/fixnum"
+require "scruby/core_ext/numeric"
+require "scruby/core_ext/proc"
+require "scruby/core_ext/string"
+require "scruby/core_ext/symbol"
+require "scruby/core_ext/typed_array"
+require "scruby/core_ext/delegator_array"
+require "scruby/env"
+require "scruby/control_name"
+
+require "scruby/ugens/ugen"
+require "scruby/ugens/ugen_operations"
+require "scruby/ugens/multi_out"
+require "scruby/ugens/panner"
+require "scruby/ugens/buffer_read_write"
+require "scruby/ugens/disk_in_out"
+require "scruby/ugens/in_out"
+
+require "scruby/ugens/operation_ugens"
+
+require "scruby/ugens/ugens"
+require "scruby/synthdef"
+
+require "scruby/server"
+require "scruby/ugens/env_gen"
+
+require "scruby/node"
+require "scruby/synth"
+require "scruby/bus"
+require "scruby/buffer"
+
+require "scruby/ticker"
+
+include Scruby
+include Ugens

data/scruby.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "scruby/version"
+
+Gem::Specification.new do |s|
+  s.name        = "scruby"
+  s.version     = Scruby::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Macario Ortega"]
+  s.email       = ["macarui@gmail.com"]
+  s.homepage    = "http://github.com/maca/scruby"
+  s.summary     = %q{SuperCollider client for Ruby}
+  s.description = %q{SuperCollider client for Ruby}
+
+  s.rubyforge_project = "scruby"
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'bundler'
+  s.add_dependency 'ruby-osc', '~> 0.3'
+  s.add_dependency 'arguments', '~> 0.6'
+  s.add_dependency 'live', '~> 0.1'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/buffer_read_write_spec.rb

@@ -0,0 +1,333 @@
+require File.expand_path(File.dirname(__FILE__)) + "/helper"
+
+require "scruby/core_ext/delegator_array"
+require "scruby/control_name"
+require "scruby/env"
+require "scruby/ugens/ugen" 
+require "scruby/ugens/ugen_operations"
+require "scruby/ugens/operation_ugens" 
+require "scruby/ugens/multi_out"
+require "scruby/ugens/ugens" 
+require "scruby/ugens/buffer_read_write"
+
+include Scruby
+include Ugens
+
+class MockUgen < Ugen
+  class << self; public :new; end
+end
+
+
+describe 'Buffer Read Ugens' do
+  shared_examples_for 'Buffer reader Ugen' do
+    before do
+      @proxies  = @class.send @method, *@params
+      @inputs ||= @params
+      @instance = @proxies.first.source
+    end
+    
+    it "should output a DelegatorArray" do
+      @proxies.should be_a(DelegatorArray)
+    end
+    
+    it "should have correct rate" do
+      @instance.rate.should == @rate
+    end
+
+    it "should return an array of output proxies" do
+      @proxies.should be_a(Array)
+      @proxies.should have(@channels).proxies
+      @proxies.each_with_index do |proxy, i|
+        proxy.source.should be_a(@class)
+        proxy.should be_a(OutputProxy)
+        proxy.output_index.should == i
+      end
+    end
+
+    it "should set inputs" do
+      @instance.inputs.should == @inputs
+    end
+  end
+
+  shared_examples_for 'Buffer reader Ugen with control rate' do
+    before do
+      @method = :kr
+      @rate   = :control
+    end
+    it_should_behave_like 'Buffer reader Ugen'
+  end
+
+  shared_examples_for 'Buffer reader Ugen with audio rate' do
+    before do
+      @method = :ar
+      @rate   = :audio
+    end
+    it_should_behave_like 'Buffer reader Ugen'
+
+    it "should just accept audio inputs if rate is audio" # do
+    #      lambda { @class.new( :audio, MockUgen.new(:control) ) }.should raise_error(ArgumentError)
+    #    end
+  end
+
+  describe PlayBuf, 'Two channel' do
+    before do
+      @class    = PlayBuf
+      @channels = 2
+      @inputs   = 1.0, 1.0, 1.0, 1.0, 1.0, 1.0
+      @params   = @channels, *@inputs
+    end
+
+    it_should_behave_like 'Buffer reader Ugen with control rate'
+    it_should_behave_like 'Buffer reader Ugen with audio rate'
+  end
+
+  describe PlayBuf, 'Four channel' do
+    before do
+      @class    = PlayBuf
+      @channels = 4
+      @inputs   = 1.0, 1.0, 1.0, 1.0, 1.0, 1.0
+      @params   = @channels, *@inputs
+    end
+
+    it_should_behave_like 'Buffer reader Ugen with control rate'
+    it_should_behave_like 'Buffer reader Ugen with audio rate'
+  end
+
+  describe TGrains, 'Two Channel' do
+    before do
+      @class    = TGrains
+      @channels = 2
+      @inputs   = 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0
+      @params   = @channels, *@inputs
+    end
+
+    it_should_behave_like 'Buffer reader Ugen with audio rate'
+
+    it "should require at least two channels" do
+      lambda { @class.ar 1, *@params[1..-1] }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe TGrains, 'Four Channel' do
+    before do
+      @class    = TGrains
+      @channels = 4
+      @inputs   = 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0
+      @params   = @channels, *@inputs
+    end
+
+    it_should_behave_like 'Buffer reader Ugen with audio rate'
+
+    it "should require at least two channels" do
+      lambda { @class.ar 1, *@params[1..-1] }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe BufRd, 'Two channel' do
+    before do
+      @class    = BufRd
+      @channels = 2
+      @inputs   = 1.0, 1.0, 1.0, 1.0
+      @params   = @channels, *@inputs
+    end
+
+    it_should_behave_like 'Buffer reader Ugen with control rate'
+    it_should_behave_like 'Buffer reader Ugen with audio rate'
+
+    it "should require audio rate for phase"
+  end
+
+  describe BufRd, 'Four channel' do
+    before do
+      @class    = BufRd
+      @channels = 4
+      @inputs   = 1.0, 1.0, 1.0, 1.0
+      @params   = @channels, *@inputs
+    end
+
+    it_should_behave_like 'Buffer reader Ugen with control rate'
+    it_should_behave_like 'Buffer reader Ugen with audio rate'
+  end
+
+end
+
+describe 'Buffer write Ugens' do
+  shared_examples_for 'Buffer writter Ugen' do
+    before do
+      @buff_ugen = @class.send @method, *@params
+    end
+
+    it "should have correct rate" do
+      @buff_ugen.rate.should == @rate
+    end
+
+    it "should set inputs" do
+      @buff_ugen.inputs.should == @inputs
+    end
+  end
+
+  shared_examples_for 'Buffer writter Ugen with control rate' do
+    before do
+      @rate   = :control
+      @method = :kr
+    end
+    it_should_behave_like 'Buffer writter Ugen'
+  end
+
+  shared_examples_for 'Buffer writter Ugen with audio rate' do
+    before do
+      @rate   = :audio
+      @method = :ar
+    end
+    it_should_behave_like 'Buffer writter Ugen'
+  end
+
+  describe BufWr, 'array input' do
+    before do
+      @class  = BufWr
+      @array  = [MockUgen.new(:audio, 1, 2)]*4
+      @inputs = 1, 2, 3, *@array
+      @params = @array, 1, 2, 3
+    end
+    it_should_behave_like 'Buffer writter Ugen with audio rate'
+    it_should_behave_like 'Buffer writter Ugen with control rate'
+
+    it "should require phase to be audio rate"
+  end
+
+  describe BufWr, 'single input' do
+    before do
+      @class  = BufWr
+      @array  = MockUgen.new(:audio, 1, 2)
+      @inputs = 1, 2, 3, @array
+      @params = @array, 1, 2, 3
+    end
+    it_should_behave_like 'Buffer writter Ugen with audio rate'
+    it_should_behave_like 'Buffer writter Ugen with control rate'
+
+    it "should require phase to be audio rate"
+  end
+
+  describe RecordBuf, 'array input' do
+    before do
+      @class  = RecordBuf
+      @array  = [MockUgen.new(:audio, 1, 2)]*4
+      @inputs = 1, 2, 3, 4, 5, 6, 7, 8, *@array
+      @params = @array, 1, 2, 3, 4, 5, 6, 7, 8
+    end
+    it_should_behave_like 'Buffer writter Ugen with audio rate'
+    it_should_behave_like 'Buffer writter Ugen with control rate'
+
+    it "should require phase to be audio rate"
+  end
+
+  describe RecordBuf, 'single input' do
+    before do
+      @class  = RecordBuf
+      @array  = MockUgen.new(:audio, 1, 2)
+      @inputs = 1, 2, 3, 4, 5, 6, 7, 8, @array
+      @params = @array, 1, 2, 3, 4, 5, 6, 7, 8
+    end
+    it_should_behave_like 'Buffer writter Ugen with audio rate'
+    it_should_behave_like 'Buffer writter Ugen with control rate'
+
+    it "should require phase to be audio rate"
+  end
+
+  describe ScopeOut, 'array input' do
+    before do
+      @class  = ScopeOut
+      @array  = [MockUgen.new(:audio, 1, 2)]*4
+      @inputs = 1, *@array
+      @params = @array, 1
+    end
+    it_should_behave_like 'Buffer writter Ugen with audio rate'
+    it_should_behave_like 'Buffer writter Ugen with control rate'
+
+    it "should require phase to be audio rate"
+  end
+
+  describe ScopeOut, 'single input' do
+    before do
+      @class  = ScopeOut
+      @array  = MockUgen.new(:audio, 1, 2)
+      @inputs = 1, @array
+      @params = @array, 1
+    end
+    it_should_behave_like 'Buffer writter Ugen with audio rate'
+    it_should_behave_like 'Buffer writter Ugen with control rate'
+
+    it "should require phase to be audio rate"
+  end
+  
+  describe Tap, 'single input' do
+    before do
+      @inputs    = 5, 1, 0, SampleRate.ir.neg * 3, 1, 0
+      @buff_ugen = Tap.ar( 5, 2, 3 ).first.source
+    end
+
+    it "should be instance of PlayBuf" do
+      @buff_ugen.should be_a(PlayBuf)
+    end
+
+    it "should have correct rate" do
+      @buff_ugen.rate.should == :audio
+    end
+
+    it "should set inputs" do
+      @buff_ugen.inputs.should == @inputs
+    end
+  end
+  
+  describe Tap, 'single input' do
+    before do
+      @inputs    = 5, 1, 0, SampleRate.ir.neg * 3, 1, 0
+      @channels  = 1
+      @proxies   = Tap.ar( 5, @channels, 3 )
+    end
+    
+    it "should have one proxy" do
+      @proxies.should have(@channels).proxy
+    end
+
+    it "should be instance of PlayBuf" do
+      @proxies.each{ |p| p.source.should be_a(PlayBuf) }
+    end
+
+    it "should have correct rate" do
+      @proxies.each{ |p| p.source.rate.should == :audio }
+    end
+
+    it "should set inputs" do
+      @proxies.each{ |p| p.source.inputs == @inputs }
+    end
+  end
+  
+  describe Tap, 'multi input' do
+    before do
+      @inputs    = 5, 1, 0, SampleRate.ir.neg * 3, 1, 0
+      @channels  = 4
+      @proxies   = Tap.ar( 5, @channels, 3 )
+    end
+    
+    it "should have one proxy" do
+      @proxies.should have(@channels).proxy
+    end
+
+    it "should be instance of PlayBuf" do
+      @proxies.each{ |p| p.source.should be_a(PlayBuf) }
+    end
+
+    it "should have correct rate" do
+      @proxies.each{ |p| p.source.rate.should == :audio }
+    end
+
+    it "should set inputs" do
+      @proxies.each{ |p| p.source.inputs == @inputs }
+    end
+  end
+  
+  #LocalBuf
+  #MaxLocalBufs
+  #ClearBuf
+end