note_frequencies 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in note_frequencies.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Choan Galvez
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# NoteFrequencies
+
+A library to get frequencies from pitch names. Mainly:
+
+    NoteFrequencies.frequency_from_name("e'") # => 326.93
+
+The naming accepts both Helmholtz (middle C is `c'`) and scientific notacion (middle C is `c4`).
+
+Alterations accepted include Lilypond’s style (`es`, `is`, `eses`, `isis`) and ASCII style (`b`, `#`, `bb`, `##`, `x`).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'note_frequencies'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install note_frequencies
+
+## Usage
+
+To get the frequency from a named note:
+
+    NoteFrequencies.frequency_from_name("e'") # => 326.93
+
+To get the frequency from a delta (from middle A)
+
+    NoteFrequencies.frequency_from_delta(-5) # => 326.93
+
+Fork tuning is configurable:
+
+    NoteFrequencies.frequency_from_name("a", :tuning => 443) # => 221.5
+    
+Frequencies are rounded by default to 2 decimal places. Should you need more precission:
+
+    NoteFrequencies.frequency_from_name("e'", :round => 5) # => 329.62756 
+    
+
+Both scientific notation and Helmholtz’s notation are accepted:
+
+    NoteFrequencies.frequency_from_name("a4") # => 440.0
+    NoteFrequencies.frequency_from_name("a'") # => 440.0
+
+Alterations are accepted as `b` (flat), `bb` (double flat), `es` (flat), `eses` (double flat), `#` (sharp), `##` (double sharp), `x` (double sharp), `is` (sharp) and `isis` (double sharp).
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/note_frequencies.rb

@@ -0,0 +1,75 @@
+require "note_frequencies/version"
+
+module NoteFrequencies
+
+  DEFAULT_TUNING = 440
+  DEFAULT_ROUND = 2
+  
+  # frequency from delta
+  def self.frequency(delta_from_a, conf = {})
+    conf = {
+      :tuning => DEFAULT_TUNING,
+      :round => DEFAULT_ROUND
+    }.update(conf)
+    tuning = conf[:tuning]
+    freq = tuning * (2**(delta_from_a.to_f/12))
+    round(freq, conf[:round])
+  end
+  
+  # delta in steps from a' (absolute)
+  def self.delta_from_name(name)
+    note, alt, octave = name.scan(/([a-g])(eses|isis|bb|##|es|is|b|#|x)?(\d|(,+)|('+))?/).first
+    # puts octave.inspect
+    octave_delta = if octave
+      if octave.start_with?("'")
+        octave.length - 1
+      elsif octave.start_with?(",")
+        -octave.length - 1
+      else
+        octave.to_i - 4
+      end
+    else
+      -1
+    end
+    # puts octave_delta.inspect
+    alt_delta = if (alt == 'is' || alt == '#')
+      1
+    elsif (alt == 'isis' || alt == '##' || alt == 'x')
+      2
+    elsif (alt == 'es' || alt == 'b')
+      -1
+    else
+      0
+    end
+    delta(note) + alt_delta + 12 * octave_delta
+  end
+  
+  def self.round(q, r)
+    pow = 10**r
+    (q*pow).round/pow.to_f
+  end
+  
+  # delta in steps from A (relative)
+  def self.delta(name)
+    @deltas ||= begin
+      {
+        :a => 0,
+        :b => 2,
+        :c => -9,
+        :d => -7,
+        :e => -5, 
+        :f => -4,
+        :g => -2
+      }
+    end
+    @deltas[name.to_sym]
+  end
+  
+  def self.frequency_from_name(name, conf = {})
+    conf = {
+      :tuning => DEFAULT_TUNING,
+      :round => DEFAULT_ROUND
+    }.update(conf)
+    frequency(delta_from_name(name), conf)
+  end
+end

data/lib/note_frequencies/version.rb

@@ -0,0 +1,3 @@
+module NoteFrequencies
+  VERSION = "0.0.1"
+end

data/note_frequencies.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'note_frequencies/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "note_frequencies"
+  spec.version       = NoteFrequencies::VERSION
+  spec.authors       = ["Choan Gálvez"]
+  spec.email         = ["choan.galvez@gmail.com"]
+  spec.description   = %q{Convert musical note names to frequencies}
+  spec.summary       = %q{A tool for converting musical note names to it vibrating frequencies. Accepts input in both Helmholtz (`a'`, `a,`) and scientific notation (`a4`, `a3`)}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/test_note_frequencies.rb

@@ -0,0 +1,79 @@
+require 'test/unit'
+require 'note_frequencies'
+
+class NoteFrequenciesTest < Test::Unit::TestCase
+  def test_round_up
+    assert_equal 333.34, NoteFrequencies.round(333.335, 2)
+  end
+  
+  def test_round_down
+    assert_equal 333.33, NoteFrequencies.round(333.334, 2)
+  end
+  
+  def test_a_from_delta
+    assert_equal 440, NoteFrequencies.frequency(0)
+  end
+  
+  def test_low_a_from_delta
+    assert_equal 220, NoteFrequencies.frequency(-12)
+  end
+
+  def test_high_a_from_delta
+    assert_equal 880, NoteFrequencies.frequency(12)
+  end
+  
+  def test_e_from_delta
+    assert_equal 329.63, NoteFrequencies.frequency(-5)
+  end
+  
+  def test_delta_octave
+    assert_equal 0, NoteFrequencies.delta_from_name("a'")
+    assert_equal 12, NoteFrequencies.delta_from_name("a''")
+    assert_equal -12, NoteFrequencies.delta_from_name("a")
+    assert_equal -24, NoteFrequencies.delta_from_name("a,")
+    assert_equal -36, NoteFrequencies.delta_from_name("a,,")
+  end
+  
+  def test_delta_alt
+    assert_equal 1, NoteFrequencies.delta_from_name("ais'")
+    assert_equal 1, NoteFrequencies.delta_from_name("a#'")
+    assert_equal -1, NoteFrequencies.delta_from_name("aes'")
+    assert_equal -1, NoteFrequencies.delta_from_name("ab'")
+  end
+  
+  def test_delta_double_alt
+    assert_equal 2, NoteFrequencies.delta_from_name("aisis'")
+    assert_equal 2, NoteFrequencies.delta_from_name("ax'")
+    assert_equal 2, NoteFrequencies.delta_from_name("a##'")
+  end
+  
+  def test_jump_octave
+    assert_equal 3, NoteFrequencies.delta_from_name("bis'")
+  end
+  
+  def test_delta_other
+    assert_equal -9, NoteFrequencies.delta_from_name("c'")
+    assert_equal -5, NoteFrequencies.delta_from_name("e'")
+  end
+  
+  def test_delta_enharmonics
+    assert_equal NoteFrequencies.delta_from_name("g#'"), NoteFrequencies.delta_from_name("ab'")
+  end
+  
+  def test_scientific_octave
+    assert_equal 0, NoteFrequencies.delta_from_name('a4')
+    assert_equal -9, NoteFrequencies.delta_from_name('c4')
+    assert_equal -12, NoteFrequencies.delta_from_name('a3')
+    assert_equal 12, NoteFrequencies.delta_from_name('a5')
+  end
+  
+  def test_frequency_from_name
+    assert_equal 440, NoteFrequencies.frequency_from_name("a'")
+    assert_equal 880, NoteFrequencies.frequency_from_name("a''")
+    assert_equal 220, NoteFrequencies.frequency_from_name("a")
+    assert_equal 110, NoteFrequencies.frequency_from_name("a,")
+    assert_equal 329.63, NoteFrequencies.frequency_from_name("e'")
+    assert_equal 440, NoteFrequencies.frequency_from_name("gx'")
+  end
+  
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: note_frequencies
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Choan Gálvez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Convert musical note names to frequencies
+email:
+- choan.galvez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/note_frequencies.rb
+- lib/note_frequencies/version.rb
+- note_frequencies.gemspec
+- test/test_note_frequencies.rb
+homepage: ''
+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: 234481389
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 234481389
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A tool for converting musical note names to it vibrating frequencies. Accepts
+  input in both Helmholtz (`a'`, `a,`) and scientific notation (`a4`, `a3`)
+test_files:
+- test/test_note_frequencies.rb