music-transcription 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a54e9f73ce558bd8c64f6a7e8931e4d0572dcdaf
-  data.tar.gz: bde6d1183b854e50dcbaa677154f8f9349e5d36f
+  metadata.gz: 5041a24490fc0a9178e61905b5febb392d081428
+  data.tar.gz: 95223ce876d78e49ba61b232af70ef08805b20cf
 SHA512:
-  metadata.gz: 99e008bc37f2f2c92b202217636e67f6ab93c14eaeee8a2c824323df9da36e92f859fb8d1c0a7fabc3bc93338c11fb5065a2c25b4c28bff6f1c61843708744cf
-  data.tar.gz: 4cb6c971e49c05a797aed7ee913ffd2c6337d3b3baea2de317132cdea97f389df1c792fbcec6bf99a8863e72dbf071739d575034d5480226d386d4bd3a413d34
+  metadata.gz: ba123f27fc90869a0741e6f7232b875ac7bf48df1757cf2409fedd91f8c79b5fcd516bf521888f361204e63aae6632c9e836096e2b591bd0cd34060086c8bfeb
+  data.tar.gz: 2b24520d8a6a7c9a5b6d8c210d30046e0159316ea92c45fcdb2c6e8139e437e5d9119988076122a51f3d6036704c66d9059190be702a4ea187fc4d57cdb4a472

data/lib/music-transcription/note.rb

@@ -56,30 +56,38 @@ class Note
     Marshal.load(Marshal.dump(self))
   end
 
-  def transpose_pitches_only pitch_diff
+  def transpose_pitches_only diff
     self.clone.transpose_pitches! pitch_diff, transpose_link
   end
 
-  def transpose_pitches_only! pitch_diff
-    @pitches = @pitches.map {|pitch| pitch + pitch_diff}
-    new_links = {}
-    @links.each_pair do |k,v|
-      new_links[k + pitch_diff] = v
-    end
-    @links = new_links
-    return self
+  def transpose_pitches_only! diff
+    self.transpose! diff, false
   end
   
-  def transpose_pitches_and_links pitch_diff
-    self.clone.transpose_pitches_and_links! pitch_diff
+  def transpose_pitches_and_links diff
+    self.clone.transpose_pitches_and_links! diff
   end
 
-  def transpose_pitches_and_links! pitch_diff
-    @pitches = @pitches.map {|pitch| pitch + pitch_diff}
+  def transpose_pitches_and_links! diff
+    self.transpose! diff, true
+  end
+  
+  def transpose diff, transpose_links
+    self.clone.transpose! diff, transpose_links
+  end
+  
+  def transpose! diff, transpose_link_targets
+    unless diff.is_a?(Pitch)
+      diff = Pitch.make_from_semitone(diff)
+    end
+    
+    @pitches = @pitches.map {|pitch| pitch + diff}
     new_links = {}
     @links.each_pair do |k,v|
-      v.target_pitch += pitch_diff
-      new_links[k + pitch_diff] = v
+      if transpose_link_targets
+        v.target_pitch += diff
+      end
+      new_links[k + diff] = v
     end
     @links = new_links
     return self

data/lib/music-transcription/part.rb

@@ -46,15 +46,15 @@ class Part
     return @notes.inject(0) { |sum, note| sum + note.duration }
   end
   
-  def transpose pitch_diff
-    self.clone.transpose! pitch_diff
+  def transpose diff
+    self.clone.transpose! diff
   end
 
-  def transpose! pitch_diff
+  def transpose! diff
     @notes[0...-1].each do |note|
-      note.transpose_pitches_and_links! pitch_diff
+      note.transpose_pitches_and_links! diff
     end
-    @notes[-1].transpose_pitches_only! pitch_diff
+    @notes[-1].transpose_pitches_only! diff
     return self
   end
   

data/lib/music-transcription/pitch.rb

@@ -1,134 +1,77 @@
 module Music
 module Transcription
 
-# Abstraction of a musical pitch. Contains values for octave, semitone, 
-# and cent. These values are useful because they allow simple mapping to
-# both the abstract (musical scales) and concrete (audio data).
+# Abstraction of a musical pitch. Contains values for octave and semitone.
 #
-# Fundamentally, pitch can be considered a ratio to some base number. 
-# For music, this is a base frequency. The pitch frequency can be 
-# determined by multiplying the base frequency by the pitch ratio. For 
-# the standard musical scale, the base frequency of C0 is 16.35 Hz.
-# 
 # Octaves represent the largest means of differing two pitches. Each 
 # octave added will double the ratio. At zero octaves, the ratio is 
-# 1.0. At one octave, the ratio will be 2.0. Each semitone and cent 
-# is an increment of less-than-power-of-two.
-#
-# Semitones are the primary steps between octaves. By default, the 
-# number of semitones per octave is 12, corresponding to the twelve-tone equal 
-# temperment tuning system. The number of semitones per octave can be 
-# modified at runtime by overriding the Pitch::SEMITONES_PER_OCTAVE 
-# constant.
-#
-# Cents are the smallest means of differing two pitches. By default, the 
-# number of cents per semitone is 100 (hence the name cent, as in per-
-# cent). This number can be modified at runtime by overriding the 
-# Pitch::CENTS_PER_SEMITONE constant.
+# 1.0. At one octave, the ratio will be 2.0. Each semitone is an increment
+# of less-than-power-of-two.
 #
+# Semitones are the primary steps between octaves. The number of
+# semitones per octave is 12.
+
 # @author James Tunnell
 # 
 # @!attribute [r] octave
 #   @return [Fixnum] The pitch octave.
 # @!attribute [r] semitone
 #   @return [Fixnum] The pitch semitone.
-# @!attribute [r] cent
-#   @return [Fixnum] The pitch cent.
-# @!attribute [r] cents_per_octave
-#   @return [Fixnum] The number of cents per octave. Default is 1200 
-#    				 (12 x 100). If a different scale is required, 
-#                    modify CENTS_PER_SEMITONE (default 12) and/or 
-#                    SEMITONES_PER_OCTAVE (default 100).
-# @!attribute [r] base_freq
-#   @return [Numeric] Multiplied with pitch ratio to determine the final frequency
-#                   of the pitch. Defaults to DEFAULT_BASE_FREQ, but can be set 
-#                   during initialization to something else using the :base_freq key.
 #
 class Pitch
   include Comparable
-  attr_reader :cents_per_octave, :base_freq, :octave, :semitone, :cent
+  attr_reader :octave, :semitone
 
   #The default number of semitones per octave is 12, corresponding to 
   # the twelve-tone equal temperment tuning system.
   SEMITONES_PER_OCTAVE = 12
 
-  #The default number of cents per semitone is 100 (hence the name cent,
-  # as in percent).
-  CENTS_PER_SEMITONE = 100
-  
-  # The default base ferquency is C0
-  DEFAULT_BASE_FREQ = 16.351597831287414
+  # The base ferquency is C0
+  BASE_FREQ = 16.351597831287414
 
   # A new instance of Pitch.
   # @raise [NonPositiveFrequencyError] if base_freq is not > 0.
-  def initialize octave:0, semitone:0, cent:0, base_freq:DEFAULT_BASE_FREQ
-    @cents_per_octave = CENTS_PER_SEMITONE * SEMITONES_PER_OCTAVE
+  def initialize octave:0, semitone:0
     @octave = octave
     @semitone = semitone
-    @cent = cent
-    raise ValueNonPositiveError if base_freq <= 0
-    @base_freq = base_freq
     normalize!
   end
 
-  ## Set @base_freq, which is used with the pitch ratio to produce the
-  ## pitch frequency.
-  #def base_freq= base_freq
-  #  raise NonPositiveFrequencyError if base_freq <= 0
-  #  @base_freq = base_freq
-  #end
-  #
-  ## Set @octave.
-  #def octave= octave
-  #  @octave = octave
-  #end
-  #
-  ## Set semitone.
-  #def semitone= semitone
-  #  @semitone = semitone
-  #end
-  #
-  ## Set @cent.
-  #def cent= cent
-  #  @cent = cent
-  #end
-
   # Return the pitch's frequency, which is determined by multiplying the base 
   # frequency and the pitch ratio. Base frequency defaults to DEFAULT_BASE_FREQ,
   # but can be set during initialization to something else by specifying the 
   # :base_freq key.
   def freq
-    return self.ratio() * @base_freq
+    return self.ratio() * BASE_FREQ
   end
   
   # Set the pitch according to the given frequency. Uses the current base_freq 
   # to determine what the pitch ratio should be, and sets it accordingly.
   def freq= freq
-    self.ratio = freq / @base_freq
+    self.ratio = freq / BASE_FREQ
   end
 
-  # Calculate the total cent count. Converts octave and semitone count
-  # to cent count before adding to existing cent count.
-  # @return [Fixnum] total cent count
-  def total_cent
-    return (@octave * @cents_per_octave) +
-            (@semitone * CENTS_PER_SEMITONE) + @cent
+  # Calculate the total semitone count. Converts octave to semitone count
+  # before adding to existing semitone count.
+  # @return [Fixnum] total semitone count
+  def total_semitone
+    return (@octave * SEMITONES_PER_OCTAVE) + @semitone
   end
   
-  # Set the Pitch ratio according to a total number of cents.
-  # @param [Fixnum] cent The total number of cents to use.
-  # @raise [ArgumentError] if cent is not a Fixnum
-  def total_cent= cent
-    raise ArgumentError, "cent is not a Fixnum" if !cent.is_a?(Fixnum)
-    @octave, @semitone, @cent = 0, 0, cent
+  # Set the Pitch ratio according to a total number of semitones.
+  # @param [Fixnum] semitone The total number of semitones to use.
+  # @raise [ArgumentError] if semitone is not an Integer
+  def total_semitone= semitone
+    raise ArgumentError, "semitone is not a Integer" if !semitone.is_a?(Integer)
+    @octave, @semitone = 0, semitone
     normalize!
   end
 
-  # Calculate the pitch ratio. Raises 2 to the power of the total cent 
-  # count divided by cents-per-octave.
+  # Calculate the pitch ratio. Raises 2 to the power of the total semitone
+  # count divided by semitones-per-octave.
   # @return [Float] ratio
   def ratio
-    2.0**(self.total_cent.to_f / @cents_per_octave)
+    2.0**(self.total_semitone.to_f / SEMITONES_PER_OCTAVE)
   end
 
   # Represent the Pitch ratio according to a ratio.
@@ -138,7 +81,7 @@ class Pitch
     raise RangeError, "ratio #{ratio} is less than or equal to 0.0" if ratio <= 0.0
     
     x = Math.log2 ratio
-    self.total_cent = (x * @cents_per_octave).round
+    self.total_semitone = (x * SEMITONES_PER_OCTAVE).round
   end
 
   # Round to the nearest semitone.
@@ -146,55 +89,47 @@ class Pitch
     self.clone.round!
   end
 
-  # Round to the nearest semitone.
-  def round!
-    if @cent >= (CENTS_PER_SEMITONE / 2)
-      @semitone += 1
-    end
-    @cent = 0
-    normalize!
-    return self
-  end
-  
   # Calculates the number of semitones which would represent the pitch's
-  # octave and semitone count. Excludes cents.
+  # octave and semitone count
   def total_semitone
     return (@octave * SEMITONES_PER_OCTAVE) + @semitone
   end
   
   # Override default hash method.
   def hash
-    return self.total_cent
+    return self.total_semitone
   end
   
-  # Compare pitch equality using total cent
+  # Compare pitch equality using total semitone
   def ==(other)
-    self.total_cent == other.total_cent
+    self.total_semitone == other.total_semitone
+  end
+  
+  def eql?(other)
+    self == other
   end
   
-  # Compare pitches. A higher ratio or total cent is considered larger.
+  # Compare pitches. A higher ratio or total semitone is considered larger.
   # @param [Pitch] other The pitch object to compare.
   def <=> (other)
-    self.total_cent <=> other.total_cent
+    self.total_semitone <=> other.total_semitone
   end
 
-  # Add pitches by adding the total cent count of each.
+  # Add pitches by adding the total semitone count of each.
   # @param [Pitch] other The pitch object to add. 
   def + (other)
     self.class.new(
       octave: (@octave + other.octave),
-      semitone: (@semitone + other.semitone),
-      cent: (@cent + other.cent)
+      semitone: (@semitone + other.semitone)
     )
   end
 
-  # Add pitches by subtracting the total cent count.
+  # Add pitches by subtracting the total semitone count.
   # @param [Pitch] other The pitch object to subtract.
   def - (other)
     self.class.new(
       octave: (@octave - other.octave),
       semitone: (@semitone - other.semitone),
-      cent: (@cent - other.cent)
     )
   end
   
@@ -203,26 +138,19 @@ class Pitch
     Marshal.load(Marshal.dump(self))  # is this cheating?
   end
   
-  # Balance out the octave, semitone, and cent count. 
+  # Balance out the octave and semitone count. 
   def normalize!
-    centTotal = (@octave * @cents_per_octave) + (@semitone * CENTS_PER_SEMITONE) + @cent
-    
-    @octave = centTotal / @cents_per_octave
-    centTotal -= @octave * @cents_per_octave
+    semitoneTotal = (@octave * SEMITONES_PER_OCTAVE) + @semitone
     
-    @semitone = centTotal / CENTS_PER_SEMITONE
-    centTotal -= @semitone * CENTS_PER_SEMITONE
+    @octave = semitoneTotal / SEMITONES_PER_OCTAVE
+    semitoneTotal -= @octave * SEMITONES_PER_OCTAVE
     
-    @cent = centTotal
+    @semitone = semitoneTotal
     return self
   end
 
   # Produce a string representation of a pitch (e.g. "C2")
   def to_s
-    if @cents_per_octave != 1200
-      raise "Don't know how to produce a string representation since cents_per_octave is not 1200."
-    end
-    
     semitone_str = case @semitone
     when 0 then "C"
     when 1 then "Db"
@@ -241,11 +169,19 @@ class Pitch
     return semitone_str + @octave.to_s
   end
   
-  def self.make_from_freq(freq, base_freq = DEFAULT_BASE_FREQ)
+  def self.make_from_freq(freq)
     pitch = Pitch.new()
-    pitch.ratio = freq / base_freq
+    pitch.ratio = freq / BASE_FREQ
     return pitch
   end
+  
+  def self.make_from_semitone semitones
+    if semitones.is_a?(Integer)
+      return Pitch.new(semitone: semitones)
+    else
+      raise ArgumentError, "Cannot make Pitch from #{semitones}"
+    end
+  end
 end
 
 end

data/lib/music-transcription/version.rb

@@ -2,6 +2,6 @@
 module Music
 module Transcription
   # music-transcription version
-  VERSION = "0.5.6"
+  VERSION = "0.5.7"
 end
 end

data/spec/note_spec.rb

@@ -5,7 +5,7 @@ describe Note do
     @pitch = C4
   end
   
-  context '.new' do
+  describe '.new' do
     it 'should assign :duration that is given during construction' do
       note = Note.new 2
       note.duration.should eq(2)
@@ -28,11 +28,47 @@ describe Note do
     end
   end
   
-  context '#duration=' do
+  describe '#duration=' do
     it 'should assign duration' do
       note = Note.new 2, [@pitch]
       note.duration = 3
       note.duration.should eq 3
     end
-  end  
+  end
+  
+  describe '#transpose!' do
+    context 'transpose_link_targets set false' do
+      context 'given pitch diff' do
+        before(:all) do
+          @note = Note::Quarter.new([C2,F2], links:{C2=>Link::Slur.new(D2)})
+          @diff = Pitch.new(semitone: 4)
+          @note.transpose! @diff, false
+        end
+        
+        it 'should modifiy pitches by adding pitch diff' do
+          @note.pitches[0].should eq E2
+          @note.pitches[1].should eq A2
+        end
+        
+        it 'should not affect link targets' do
+          @note.links.should have_key(E2)
+          @note.links[E2].target_pitch.should eq(D2)
+        end
+      end
+      
+      context 'given integer diff' do
+        it 'should transpose the given number of semitones' do
+          Note::Quarter.new([C2]).transpose!(4,false).pitches[0].should eq(E2)
+        end
+      end
+    end
+  end
+  
+  context 'transpose_link_targets set true' do
+    it 'should also transpose link targets' do
+      note = Note::Quarter.new([C2,F2], links:{C2=>Link::Slur.new(D2)})
+      note.transpose!(2,true)
+      note.links[D2].target_pitch.should eq(E2)
+    end
+  end
 end

data/spec/pitch_spec.rb

@@ -5,17 +5,15 @@ describe Pitch do
   before :each do
     @cases = 
     [
-      { octave: 1, semitone: 0, cent: 0, :ratio => 2.0, :total_cent => 1200 },
-      { octave: 2, semitone: 0, cent: 0, :ratio => 4.0, :total_cent => 2400 },
-      { octave: 1, semitone: 6, cent: 0, :ratio => 2.8284, :total_cent => 1800 },
-      { octave: 2, semitone: 6, cent: 0, :ratio => 5.6569, :total_cent => 3000 },
-      { octave: 1, semitone: 6, cent: 20, :ratio => 2.8613, :total_cent => 1820 },
-      { octave: 2, semitone: 6, cent: 20, :ratio => 5.7226, :total_cent => 3020 },
-      { octave: 3, semitone: 7, cent: 77, :ratio => 12.5316, :total_cent => 4377 },
-      { octave: -1, semitone: 0, cent: 0, :ratio => 0.5, :total_cent => -1200 },
-      { octave: -2, semitone: 0, cent: 0, :ratio => 0.25, :total_cent => -2400 },
-      { octave: -2, semitone: 7, cent: 55, :ratio => 0.3867, :total_cent => -1645 },
-      { octave: -1, semitone: 9, cent: 23, :ratio => 0.8521, :total_cent => -277 },
+      { octave: 1, semitone: 0, :ratio => 2.0, :total_semitone => 12 },
+      { octave: 2, semitone: 0, :ratio => 4.0, :total_semitone => 24 },
+      { octave: 1, semitone: 6, :ratio => 2.828, :total_semitone => 18 },
+      { octave: 2, semitone: 6, :ratio => 5.657, :total_semitone => 30 },
+      { octave: 3, semitone: 7, :ratio => 11.986, :total_semitone => 43 },
+      { octave: -1, semitone: 0, :ratio => 0.5, :total_semitone => -12 },
+      { octave: -2, semitone: 0, :ratio => 0.25, :total_semitone => -24 },
+      { octave: -2, semitone: 7, :ratio => 0.375, :total_semitone => -17 },
+      { octave: -1, semitone: 9, :ratio => 0.841, :total_semitone => -3 },
     ]
   end
   
@@ -27,20 +25,19 @@ describe Pitch do
     obj = Pitch.new octave: 4, semitone: 3
     obj.octave.should eq(4)
     obj.semitone.should eq(3)
-    obj.cent.should eq(0)
   end
   
-  it "should use default octave, semitone, and cent in none is given" do
+  it "should use default octave and semitone if none is given" do
     p = Pitch.new
     p.ratio.should be_within(0.01).of(1.0)
-    p.total_cent.should eq(0)
+    p.total_semitone.should eq(0)
   end
   
-  it "should use the octave, semitone, and cent given during construction" do
+  it "should use the octave and semitone given during construction" do
     @cases.each do |case_data|
-      p = Pitch.new octave: case_data[:octave], semitone: case_data[:semitone], cent: case_data[:cent]
+      p = Pitch.new octave: case_data[:octave], semitone: case_data[:semitone]
       p.ratio.should be_within(0.01).of case_data[:ratio]
-      p.total_cent.should be case_data[:total_cent]
+      p.total_semitone.should be case_data[:total_semitone]
     end
   end
 
@@ -51,20 +48,18 @@ describe Pitch do
             
       p.octave.should eq case_data[:octave]
       p.semitone.should eq case_data[:semitone]
-      p.cent.should eq case_data[:cent]
-      p.total_cent.should eq case_data[:total_cent]
+      p.total_semitone.should eq case_data[:total_semitone]
     end
   end
 
-  it "should setting by total_cent" do    
+  it "should setting by total_semitone" do    
     @cases.each do |case_data|
       p = Pitch.new
-      p.total_cent = case_data[:total_cent] 
+      p.total_semitone = case_data[:total_semitone] 
       
       p.octave.should eq case_data[:octave]
       p.semitone.should eq case_data[:semitone]
-      p.cent.should eq case_data[:cent]
-      p.total_cent.should eq case_data[:total_cent]
+      p.total_semitone.should eq case_data[:total_semitone]
     end
   end
   
@@ -106,7 +101,7 @@ describe Pitch do
     a4.freq.should be_within(0.01).of(440.0)
   end
   
-  context 'String#to_pitch' do
+  describe 'String#to_pitch' do
     it 'should create a Pitch object that matches the musical note' do
       {
 	"Ab2" => Pitch.new(octave: 2, semitone: 8),
@@ -122,17 +117,21 @@ describe Pitch do
     end
   end
   
-  context '.make_from_freq' do
+  describe '.make_from_freq' do
     it 'should make a pitch whose freq is approximately the given freq' do
-      one_cent = Pitch.new(cent: 1)
-      [1.0, 25.0, 200.0, 3500.0].each do |given_freq|
+      [16.35, 440.0, 987.77].each do |given_freq|
 	pitch = Pitch.make_from_freq given_freq
-	freq = pitch.freq
-	if freq > given_freq
-	  (freq / given_freq).should be < one_cent.ratio
-	elsif freq < given_freq
-	  (given_freq / freq).should be < one_cent.ratio
-	end
+	pitch.freq.should be_within(0.01).of(given_freq)
+      end
+    end
+  end
+  
+  describe '.make_from_semitone' do
+    context 'given an integer less than 12' do
+      before(:all) { @pitch = Pitch.make_from_semitone(11) }
+      
+      it 'semitone should equal given integer' do
+	@pitch.semitone.should eq 11
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: music-transcription
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors:
 - James Tunnell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-02 00:00:00.000000000 Z
+date: 2014-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler