music-transcription 0.15.0 → 0.16.0

data/examples/song1.yml

@@ -21,6 +21,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 2
         semitone: 0
+        cent: 0
+        total_cents: 2400
       articulation: :normal
       accented: false
       links: {}
@@ -32,6 +34,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 2
         semitone: 3
+        cent: 0
+        total_cents: 2700
       articulation: :normal
       accented: false
       links: {}
@@ -43,6 +47,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 2
         semitone: 5
+        cent: 0
+        total_cents: 2900
       articulation: :normal
       accented: false
       links: {}
@@ -54,6 +60,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 2
         semitone: 3
+        cent: 0
+        total_cents: 2700
       articulation: :normal
       accented: false
       links: {}
@@ -73,6 +81,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 2
         semitone: 0
+        cent: 0
+        total_cents: 2400
       articulation: :normal
       accented: false
       links: {}
@@ -84,6 +94,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 2
         semitone: 3
+        cent: 0
+        total_cents: 2700
       articulation: :normal
       accented: false
       links: {}
@@ -103,6 +115,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 2
         semitone: 0
+        cent: 0
+        total_cents: 2400
       articulation: :normal
       accented: false
       links: {}
@@ -114,6 +128,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 2
         semitone: 3
+        cent: 0
+        total_cents: 2700
       articulation: :normal
       accented: false
       links: {}
@@ -125,6 +141,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 2
         semitone: 5
+        cent: 0
+        total_cents: 2900
       articulation: :normal
       accented: false
       links: {}
@@ -136,6 +154,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 2
         semitone: 3
+        cent: 0
+        total_cents: 2700
       articulation: :normal
       accented: false
       links: {}
@@ -155,6 +175,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 2
         semitone: 0
+        cent: 0
+        total_cents: 2400
       articulation: :normal
       accented: false
       links: {}
@@ -166,6 +188,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 2
         semitone: 3
+        cent: 0
+        total_cents: 2700
       articulation: :normal
       accented: false
       links: {}
@@ -189,6 +213,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 10
+        cent: 0
+        total_cents: 4600
       articulation: :normal
       accented: false
       links: {}
@@ -200,6 +226,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 10
+        cent: 0
+        total_cents: 4600
       articulation: :normal
       accented: false
       links: {}
@@ -211,6 +239,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 10
+        cent: 0
+        total_cents: 4600
       articulation: :normal
       accented: false
       links: {}
@@ -222,6 +252,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 10
+        cent: 0
+        total_cents: 4600
       articulation: :normal
       accented: false
       links: {}
@@ -233,6 +265,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 4
         semitone: 0
+        cent: 0
+        total_cents: 4800
       articulation: :normal
       accented: false
       links: {}
@@ -244,6 +278,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 9
+        cent: 0
+        total_cents: 4500
       articulation: :normal
       accented: false
       links: {}
@@ -255,6 +291,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 7
+        cent: 0
+        total_cents: 4300
       articulation: :normal
       accented: false
       links: {}
@@ -266,6 +304,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 5
+        cent: 0
+        total_cents: 4100
       articulation: :normal
       accented: false
       links: {}
@@ -277,6 +317,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 7
+        cent: 0
+        total_cents: 4300
       articulation: :slur
       accented: false
       links: {}
@@ -288,6 +330,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 5
+        cent: 0
+        total_cents: 4100
       articulation: :slur
       accented: false
       links: {}
@@ -299,6 +343,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 4
+        cent: 0
+        total_cents: 4000
       articulation: :normal
       accented: false
       links: {}
@@ -326,6 +372,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 10
+        cent: 0
+        total_cents: 4600
       articulation: :normal
       accented: false
       links: {}
@@ -337,6 +385,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 10
+        cent: 0
+        total_cents: 4600
       articulation: :normal
       accented: false
       links: {}
@@ -348,6 +398,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 10
+        cent: 0
+        total_cents: 4600
       articulation: :normal
       accented: false
       links: {}
@@ -359,6 +411,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 10
+        cent: 0
+        total_cents: 4600
       articulation: :normal
       accented: false
       links: {}
@@ -370,6 +424,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 4
         semitone: 0
+        cent: 0
+        total_cents: 4800
       articulation: :normal
       accented: false
       links: {}
@@ -381,6 +437,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 9
+        cent: 0
+        total_cents: 4500
       articulation: :normal
       accented: false
       links: {}
@@ -392,6 +450,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 4
         semitone: 4
+        cent: 0
+        total_cents: 5200
       articulation: :normal
       accented: false
       links: {}
@@ -403,6 +463,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 4
         semitone: 4
+        cent: 0
+        total_cents: 5200
       articulation: :slur
       accented: false
       links: {}
@@ -414,6 +476,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 4
         semitone: 2
+        cent: 0
+        total_cents: 5000
       articulation: :slur
       accented: false
       links: {}
@@ -425,6 +489,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 4
         semitone: 0
+        cent: 0
+        total_cents: 4800
       articulation: :normal
       accented: false
       links: {}

data/examples/song2.yml

@@ -21,6 +21,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 4
         semitone: 0
+        cent: 0
+        total_cents: 4800
       articulation: :normal
       accented: false
       links: {}
@@ -32,6 +34,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 10
+        cent: 0
+        total_cents: 4600
       articulation: :normal
       accented: false
       links: {}
@@ -43,6 +47,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 8
+        cent: 0
+        total_cents: 4400
       articulation: :normal
       accented: false
       links: {}
@@ -54,6 +60,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 7
+        cent: 0
+        total_cents: 4300
       articulation: :normal
       accented: false
       links: {}
@@ -65,6 +73,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 10
+        cent: 0
+        total_cents: 4600
       articulation: :normal
       accented: false
       links: {}
@@ -80,6 +90,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 5
         semitone: 4
+        cent: 0
+        total_cents: 6400
       articulation: :normal
       accented: false
       links: {}
@@ -91,6 +103,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 5
         semitone: 2
+        cent: 0
+        total_cents: 6200
       articulation: :normal
       accented: false
       links: {}
@@ -102,6 +116,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 5
         semitone: 0
+        cent: 0
+        total_cents: 6000
       articulation: :normal
       accented: false
       links: {}
@@ -113,6 +129,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 5
         semitone: 0
+        cent: 0
+        total_cents: 6000
       articulation: :normal
       accented: false
       links: {}
@@ -124,6 +142,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 5
         semitone: 0
+        cent: 0
+        total_cents: 6000
       articulation: :normal
       accented: false
       links: {}
@@ -135,6 +155,8 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 5
         semitone: 2
+        cent: 0
+        total_cents: 6200
       articulation: :normal
       accented: false
       links: {}

data/lib/music-transcription/model/link.rb

@@ -30,11 +30,10 @@ class Link
   end
   
   class TargetedLink < Link
-    attr_accessor :target_pitch, :link_char
+    attr_accessor :target_pitch
     
-    def initialize target_pitch, link_char
+    def initialize target_pitch
       @target_pitch = target_pitch
-      @link_char = link_char
     end
     
     def ==(other)
@@ -47,27 +46,28 @@ class Link
     
     def transpose! diff
       @target_pitch = @target_pitch.transpose(diff)
+      return self
     end
     
     def to_s
-      @link_char + @target_pitch.to_s
+      link_char + @target_pitch.to_s
     end
   end
   
   class Glissando < TargetedLink
-    def initialize(target_pitch); super(target_pitch,"~"); end
+    def link_char; "~"; end
   end
   
   class Portamento < TargetedLink
-    def initialize(target_pitch); super(target_pitch,"/"); end
+    def link_char; "/"; end
   end
   
   class Slur < TargetedLink
-    def initialize(target_pitch); super(target_pitch,"="); end
+    def link_char; "="; end
   end
   
   class Legato < TargetedLink
-    def initialize(target_pitch); super(target_pitch,"-"); end
+    def link_char; "|"; end
   end
 end
 

data/lib/music-transcription/model/note.rb

@@ -71,7 +71,7 @@ class Note
     
     art_str = case @articulation
     when Articulations::SLUR then "="
-    when Articulations::LEGATO then "-"
+    when Articulations::LEGATO then "|"
     when Articulations::TENUTO then "_"
     when Articulations::PORTATO then "%"
     when Articulations::STACCATO then "."

data/lib/music-transcription/model/pitch.rb

@@ -3,8 +3,8 @@ module Transcription
 
 # Abstraction of a musical pitch. Contains values for octave and semitone.
 #
-# Octaves represent the largest means of differing two pitches. Each 
-# octave added will double the ratio. At zero octaves, the ratio is 
+# 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 is an increment
 # of less-than-power-of-two.
 #
@@ -12,7 +12,7 @@ module Transcription
 # semitones per octave is 12.
 
 # @author James Tunnell
-# 
+#
 # @!attribute [r] octave
 #   @return [Fixnum] The pitch octave.
 # @!attribute [r] semitone
@@ -20,71 +20,87 @@ module Transcription
 #
 class Pitch
   include Comparable
-  attr_reader :octave, :semitone, :total_semitone
+  attr_reader :octave, :semitone, :cent, :total_cents
 
-  #The default number of semitones per octave is 12, corresponding to 
+  #The default number of semitones per octave is 12, corresponding to
   # the twelve-tone equal temperment tuning system.
   SEMITONES_PER_OCTAVE = 12
+  CENTS_PER_SEMITONE = 100
+  CENTS_PER_OCTAVE = SEMITONES_PER_OCTAVE * CENTS_PER_SEMITONE
 
   # The base ferquency is C0
   BASE_FREQ = 16.351597831287414
-  
-  def initialize octave:0, semitone:0
+
+  def initialize octave:0, semitone:0, cent: 0
+    raise NonIntegerError, "octave #{octave} is not an integer" unless octave.is_a?(Integer)
+    raise NonIntegerError, "semitone #{semitone} is not an integer" unless semitone.is_a?(Integer)
+    raise NonIntegerError, "cent #{cent} is not an integer" unless cent.is_a?(Integer)
+    
     @octave = octave
     @semitone = semitone
+    @cent = cent
+    @total_cents = (@octave*SEMITONES_PER_OCTAVE + @semitone)*CENTS_PER_SEMITONE + @cent
     normalize!
-    @total_semitone = @octave*SEMITONES_PER_OCTAVE + @semitone
   end
 
-  # Return the pitch's frequency, which is determined by multiplying the base 
+  # 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 
+  # but can be set during initialization to something else by specifying the
   # :base_freq key.
   def freq
     return self.ratio() * BASE_FREQ
   end
-  
-  # Calculate the pitch ratio. Raises 2 to the power of the total semitone
-  # count divided by semitones-per-octave.
+
+  # Calculate the pitch ratio. Raises 2 to the power of the total cent
+  # count divided by cents-per-octave.
   # @return [Float] ratio
   def ratio
-    2.0**(@total_semitone.to_f / SEMITONES_PER_OCTAVE)
+    2.0**(@total_cents.to_f / CENTS_PER_OCTAVE)
   end
-  
+
   # Override default hash method.
   def hash
-    return @total_semitone
+    return @total_cents
   end
-  
+
   # Compare pitch equality using total semitone
   def ==(other)
     return (self.class == other.class &&
-      @total_semitone == other.total_semitone)
+      @total_cents == other.total_cents)
   end
-  
+
   def eql?(other)
     self == other
   end
-  
+
   # Compare pitches. A higher ratio or total semitone is considered larger.
   # @param [Pitch] other The pitch object to compare.
   def <=> (other)
-    @total_semitone <=> other.total_semitone
+    @total_cents <=> other.total_cents
+  end
+
+  # rounds to the nearest semitone
+  def round
+    if @cent == 0
+      self.clone
+    else
+      Pitch.new(semitone: (@total_cents / CENTS_PER_SEMITONE.to_f).round)
+    end
   end
-  
+
+  # diff in (rounded) semitones
   def diff other
-    @total_semitone - other.total_semitone
+    Rational(@total_cents - other.total_cents, CENTS_PER_SEMITONE)
   end
-  
-  def transpose interval
-    Pitch.from_semitones @total_semitone + interval
+
+  def transpose semitones
+    Pitch.new(cent: (@total_cents + semitones * CENTS_PER_SEMITONE).round)
   end
-  
-  # Produce an identical Pitch object.
+
   def clone
-    Marshal.load(Marshal.dump(self))  # is this cheating?
+    Pitch.new(cent: @total_cents)
   end
-  
+
   def to_s(sharpit = false)
     letter = case semitone
     when 0 then "C"
@@ -101,34 +117,38 @@ class Pitch
     when 11 then "B"
     end
     
-    return letter + octave.to_s
+    if @cent == 0
+      return letter + octave.to_s
+    elsif @cent > 0
+      return letter + octave.to_s + "+" + @cent.to_s
+    else
+      return letter + octave.to_s + @cent.to_s
+    end
   end
-  
+
   def self.from_ratio ratio
     raise NonPositiveError, "ratio #{ratio} is not > 0" unless ratio > 0
     x = Math.log2 ratio
-    semitones = (x * SEMITONES_PER_OCTAVE).round
-    from_semitones(semitones)
+    new(cent: (x * CENTS_PER_OCTAVE).round)
   end
-  
+
   def self.from_freq freq
     from_ratio(freq / BASE_FREQ)
   end
-  
-  def self.from_semitones semitones
-    Pitch.new(semitone: semitones)
-  end
-  
+
   private
-  
-  # Balance out the octave and semitone count. 
+
+  # Balance out the octave and semitone count.
   def normalize!
-    semitoneTotal = (@octave * SEMITONES_PER_OCTAVE) + @semitone
+    centsTotal = @total_cents
+    
+    @octave = centsTotal / CENTS_PER_OCTAVE
+    centsTotal -= @octave * CENTS_PER_OCTAVE
     
-    @octave = semitoneTotal / SEMITONES_PER_OCTAVE
-    semitoneTotal -= @octave * SEMITONES_PER_OCTAVE
+    @semitone = centsTotal / CENTS_PER_SEMITONE
+    centsTotal -= @semitone * CENTS_PER_SEMITONE
     
-    @semitone = semitoneTotal
+    @cent = centsTotal
     return self
   end
 end