spcore 0.1.0

data/spec/lib/gain_spec.rb

@@ -0,0 +1,48 @@
+require 'pry'
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPCore::Gain do
+  before :all do
+    @conversions = [
+      { :linear => Math::sqrt(2.0), :db => 3.01 },
+      { :linear => 2.0, :db => 6.02 },
+      { :linear => 4.0, :db => 12.04 },
+    ]
+  end
+  
+  describe '.db_to_linear' do
+    it 'should convert decibel (logarithmic) unit to linear' do
+      @conversions.each do |conversion|
+        SPCore::Gain::db_to_linear(conversion[:db]).should be_within(0.01).of(conversion[:linear])
+      end
+    end
+
+    it 'should prove to be the inverse of .db_to_linear' do
+      20.times do
+        x = SPCore::Interpolation.linear(0.0, -SPCore::Gain::MAX_DB_ABS, 1.0, SPCore::Gain::MAX_DB_ABS, rand)
+        y = SPCore::Gain::db_to_linear(x)
+        z = SPCore::Gain::linear_to_db(y)
+        ((z - x).abs / x).should be_within(1e-5).of(0.0)
+      end
+    end
+  end
+  
+  describe '.linear_to_db' do
+    it 'should convert linear unit to decibel (logarithmic)' do
+      @conversions.each do |conversion|
+        SPCore::Gain::linear_to_db(conversion[:linear]).should be_within(0.01).of(conversion[:db])
+      end
+    end
+
+    it 'should prove to be the inverse of .db_to_linear' do
+      20.times do
+        max_gain_linear = SPCore::Gain::db_to_linear(SPCore::Gain::MAX_DB_ABS)
+        min_gain_linear = SPCore::Gain::db_to_linear(-SPCore::Gain::MAX_DB_ABS)
+        x = SPCore::Interpolation.linear(0.0, min_gain_linear, 1.0, max_gain_linear, rand)
+        y = SPCore::Gain::linear_to_db(x)
+        z = SPCore::Gain::db_to_linear(y)
+        ((z - x).abs / x).should be_within(1e-5).of(0.0)
+      end
+    end
+  end
+end

data/spec/lib/interpolation_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe SPCore::Interpolation do
+  context '.interpolate_linear' do
+    it 'should interpolate floating-point values' do
+      x1, y1 = 0.0, 2.0
+      x2, y2 = 1.0, 4.0
+      x3, y3 = 0.5, 3.0
+      result = SPCore::Interpolation.linear x1, y1, x2, y2, x3
+      result.should eq(y3)
+    end
+
+    it 'should interpolate integer values' do
+      x1, y1 = 0, 20
+      x2, y2 = 10, 40
+      x3, y3 = 5, 30
+      result = SPCore::Interpolation.linear x1, y1, x2, y2, x3
+      result.should eq(y3)
+    end
+  end
+end

data/spec/lib/oscillator_spec.rb

@@ -0,0 +1,146 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'gnuplot'
+require 'pry'
+
+describe SPCore::Oscillator do
+  #it 'should look like a ...' do
+  #  sample_rate = 44000.0
+  #  test_freq = 100.0
+  #  osc = SPCore::Oscillator.new :sample_rate => sample_rate, :frequency => test_freq, :wave_type => SPCore::Oscillator::WAVE_SQUARE
+  #  N = (5 * sample_rate / test_freq).to_i
+  #  period = 1.0 / N
+  #  
+  #  x, y = [], []
+  #  N.times do |n|
+  #    x << (n * period)
+  #    y << osc.sample
+  #  end
+  #
+  #  Gnuplot.open do |gp|
+  #    Gnuplot::Plot.new(gp) do |plot|
+  #      plot.title  "#{osc.frequency} Hz #{osc.wave_type} oscillator"
+  #      plot.xlabel "time (x)"
+  #      plot.ylabel "f(x)"
+  #    
+  #      plot.data << Gnuplot::DataSet.new( [x, y] ) do |ds|
+  #        ds.with = "linespoints"
+  #        #ds.linewidth = 4
+  #      end
+  #    end
+  #  end
+  #  
+  #end
+  
+  before :each do
+    @sample_rate = 40000.0
+    @freqs = [ 20.0, 200.0, 400.0 ]
+  end
+  
+  describe '#triangle' do
+    it "should produce increasing samples during first half-period, and decreasing samples during the second half-period" do
+      @freqs.each do |freq|
+        wave = SPCore::Oscillator.new(
+          :sample_rate => @sample_rate,
+          :frequency => freq,
+          :wave_type => SPCore::Oscillator::WAVE_TRIANGLE
+        )
+        
+        samples_in_half_period = @sample_rate / (2.0 * freq)
+        
+        prev = wave.sample
+        prev.should eq(-1)
+        
+        (samples_in_half_period - 1).to_i.times do
+          current = wave.sample
+          current.should be > prev
+          prev = current
+        end
+  
+        prev = wave.sample
+        prev.should be_within(0.01).of(1)
+        
+        (samples_in_half_period - 1).to_i.times do
+          current = wave.sample
+          current.should be < prev
+          prev = current
+        end
+        
+        wave.sample.should be_within(0.01).of(-1)
+      end
+    end
+  end
+
+  describe '#square' do
+      it "should produce 1 during first half-period, and -1 during second half-period" do
+      @freqs.each do |freq|
+        wave = SPCore::Oscillator.new(
+          :sample_rate => @sample_rate,
+          :frequency => freq,
+          :wave_type => SPCore::Oscillator::WAVE_SQUARE
+        )
+    
+        samples_in_half_period = @sample_rate / (2.0 * freq)
+        fails = 0
+        
+        samples_in_half_period.to_i.times do
+          if wave.sample != 1.0 then fails += 1 end
+        end
+        
+        samples_in_half_period.to_i.times do
+          if wave.sample != -1.0 then fails += 1 end
+        end
+        
+        (fails <= 2).should be_true
+      end
+    end
+  end
+
+  describe '#sawtooth' do
+    it "should produce increasing samples" do
+
+      @freqs.each do |freq|
+        wave = SPCore::Oscillator.new(
+          :sample_rate => @sample_rate,
+          :frequency => freq,
+          :wave_type => SPCore::Oscillator::WAVE_SAWTOOTH
+        )
+
+        samples_in_period = (@sample_rate / freq).to_i
+        fails = 0
+        
+        prev = wave.sample
+        (samples_in_period - 1).times do
+          current = wave.sample
+          if current < prev
+            fails += 1
+          end
+          prev = current
+        end
+        
+        fails.should be <= 3
+      end
+    end
+  end
+  
+  describe '#sine' do
+    it "should produce zero during every half-period, and non-zeros between" do
+      @freqs.each do |freq|
+        wave = SPCore::Oscillator.new(
+          :sample_rate => @sample_rate,
+          :frequency => freq,
+          :wave_type => SPCore::Oscillator::WAVE_SINE
+        )
+        
+        samples_in_half_period = @sample_rate / (2.0 * freq)
+        
+        wave.sample.should be_within(0.01).of(0.0)
+        (samples_in_half_period - 1).to_i.times do
+          wave.sample.should_not eq(0)
+        end
+        wave.sample.should be_within(0.01).of(0.0)
+        
+      end
+    end
+  end
+
+end

data/spec/lib/saturate_spec.rb

@@ -0,0 +1,100 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'gnuplot'
+
+describe SPCore::Saturation do
+  describe '.tanh' do
+    it 'should not saturate below the threshold' do
+      t = 1.0 # threshold
+      
+      x_data = []
+      y_data = []
+      z_data = []
+      
+      osc = SPCore::Oscillator.new(
+        :sample_rate => 100.0,
+        :frequency => 1.0,
+        :wave_type => SPCore::Oscillator::WAVE_SINE,
+        :amplitude => 2.5
+      )
+      
+      (4 * osc.sample_rate / osc.frequency).to_i.times do |n|
+        x = n / osc.sample_rate
+        y = osc.sample
+        z = SPCore::Saturation.sigmoid y, t
+        
+        if y.abs < t
+          z.should eq(y)
+        end
+        
+        x_data << x
+        y_data << y
+        z_data << z
+      end
+
+      #Gnuplot.open do |gp|
+      #  Gnuplot::Plot.new(gp) do |plot|
+      #    plot.title  "signal and saturated signal"
+      #    plot.xlabel "input"
+      #    plot.ylabel "output"
+      #  
+      #    plot.data = [
+      #      Gnuplot::DataSet.new( [x_data, y_data] ){ |ds|
+      #        ds.with = "lines"
+      #        ds.title = "Signal"
+      #        #ds.linewidth = 4
+      #      },
+      #      Gnuplot::DataSet.new( [x_data, z_data] ){ |ds|
+      #        ds.with = "lines"
+      #        ds.title = "Saturated signal"
+      #        #ds.linewidth = 4
+      #      }
+      #    ]
+      #  end
+      #end
+    end
+  end
+  
+  describe '.gompertz' do
+    it 'should...saturate' do
+      t = 1.0 # threshold
+      
+      x_data = []
+      y_data = []
+      z_data = []
+      
+      osc = SPCore::Oscillator.new :sample_rate => 100.0, :frequency => 1.0, :wave_type => SPCore::Oscillator::WAVE_SINE, :amplitude => 2.5
+      (4 * osc.sample_rate / osc.frequency).to_i.times do |n|
+        x = n / osc.sample_rate
+        y = osc.sample
+        z = SPCore::Saturation.gompertz y, t
+        
+        #z.should ???
+
+        x_data << x
+        y_data << y
+        z_data << z
+      end
+      
+      #Gnuplot.open do |gp|
+      #  Gnuplot::Plot.new(gp) do |plot|
+      #    plot.title  "signal and saturated signal"
+      #    plot.xlabel "input"
+      #    plot.ylabel "output"
+      #  
+      #    plot.data = [
+      #      Gnuplot::DataSet.new( [x_data, y_data] ){ |ds|
+      #        ds.with = "lines"
+      #        ds.title = "Signal"
+      #        #ds.linewidth = 4
+      #      },
+      #      Gnuplot::DataSet.new( [x_data, z_data] ){ |ds|
+      #        ds.with = "lines"
+      #        ds.title = "Saturated signal"
+      #        #ds.linewidth = 4
+      #      }
+      #    ]
+      #  end
+      #end
+    end
+  end
+end

data/spec/sigproc_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'spcore'
+
+describe SPCore do
+  it "should have a VERSION constant" do
+    subject.const_get('VERSION').should_not be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'spcore'
+
+include SPCore

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: spcore
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- James Tunnell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashmake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gnuplot
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "Contains core signal processing functions, including:\n  Delay line\n
+  \ Biquad filters\n  Envelope detector\n  Conversion from dB-linear and linear-dB\n
+  \ Linear interpolation\n  Oscillator with selectable wave type (sine, square, triangle,
+  sawtooth)\n\n"
+email: jamestunnell@lavabit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .yardopts
+- ChangeLog.rdoc
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/spcore.rb
+- lib/spcore/core/constants.rb
+- lib/spcore/core/limiters.rb
+- lib/spcore/lib/biquad_filter.rb
+- lib/spcore/lib/circular_buffer.rb
+- lib/spcore/lib/cookbook_allpass_filter.rb
+- lib/spcore/lib/cookbook_bandpass_filter.rb
+- lib/spcore/lib/cookbook_highpass_filter.rb
+- lib/spcore/lib/cookbook_lowpass_filter.rb
+- lib/spcore/lib/cookbook_notch_filter.rb
+- lib/spcore/lib/delay_line.rb
+- lib/spcore/lib/envelope_detector.rb
+- lib/spcore/lib/gain.rb
+- lib/spcore/lib/interpolation.rb
+- lib/spcore/lib/oscillator.rb
+- lib/spcore/lib/saturation.rb
+- lib/spcore/version.rb
+- spcore.gemspec
+- spec/core/limiters_spec.rb
+- spec/lib/circular_buffer_spec.rb
+- spec/lib/cookbook_filter_spec.rb
+- spec/lib/delay_line_spec.rb
+- spec/lib/envelope_detector_spec.rb
+- spec/lib/gain_spec.rb
+- spec/lib/interpolation_spec.rb
+- spec/lib/oscillator_spec.rb
+- spec/lib/saturate_spec.rb
+- spec/sigproc_spec.rb
+- spec/spec_helper.rb
+homepage: https://rubygems.org/gems/spcore
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 324932257
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 324932257
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Perform basic signal processing functions (delay line, filters, envelope
+  detection, etc...).
+test_files:
+- spec/core/limiters_spec.rb
+- spec/lib/circular_buffer_spec.rb
+- spec/lib/cookbook_filter_spec.rb
+- spec/lib/delay_line_spec.rb
+- spec/lib/envelope_detector_spec.rb
+- spec/lib/gain_spec.rb
+- spec/lib/interpolation_spec.rb
+- spec/lib/oscillator_spec.rb
+- spec/lib/saturate_spec.rb
+- spec/sigproc_spec.rb
+- spec/spec_helper.rb
+has_rdoc: