music-transcription 0.3.0 → 0.4.0

data/lib/music-transcription/part.rb

@@ -3,35 +3,22 @@ require 'yaml'
 module Music
 module Transcription
 
-# Abstraction of a musical part. Contains start offset, notes, and loudness_profile settings.
+# Abstraction of a musical part. Contains notes and loudness_profile settings.
 #
 # @author James Tunnell
 #
-# @!attribute [rw] offset
-#   @return [Numeric] The offset where the part begins.
-#
-# @!attribute [rw] notes
+# @!attribute [r] notes
 #   @return [Array] The notes to be played.
 #
-# @!attribute [rw] loudness_profile
+# @!attribute [r] loudness_profile
 #   @return [Profile] The parts loudness_profile profile.
 #
 class Part
-  include Hashmake::HashMakeable
-  attr_reader :offset, :loudness_profile, :notes
-  
-  # hashed-arg specs (for hash-makeable idiom)
-  ARG_SPECS = {
-    :offset => arg_spec(:reqd => false, :type => Numeric, :default => 0),
-    :loudness_profile => arg_spec(:reqd => false, :type => Profile, :validator => ->(a){ a.values_between?(0.0,1.0) }, :default => ->(){ Profile.new(:start_value => 0.5) }),
-    :notes => arg_spec_array(:reqd => false, :type => Note),
-  }
+  attr_reader :loudness_profile, :notes
   
-  # A new instance of Part.
-  # @param [Hash] args Hashed arguments. Valid optional keys are :loudness_profile, 
-  #                    :notes, and :offset.
-  def initialize args = {}
-    hash_make args, Part::ARG_SPECS
+  def initialize notes: [], loudness_profile: Profile.new(0.5)
+    @notes = notes
+    @loudness_profile = loudness_profile
   end
   
   # Produce an exact copy of the current object
@@ -41,41 +28,13 @@ class Part
   
   # Compare the equality of another Part object.
   def ==(other)
-    return (@offset == other.offset) &&
-    (@loudness_profile == other.loudness_profile) &&
-    (@notes == other.notes)
-  end
-
-  # Set the start offset of the part.
-  # @param [Numeric] offset The start offset of the part.
-  # @raise [ArgumentError] unless offset is a Numeric.
-  def offset= offset
-    ARG_SPECS[:offset].validate_value offset
-    @offset = offset
-  end
-
-  # Set the loudness_profile Profile.
-  # @param [Tempo] loudness_profile The Profile for part loudness_profile.
-  # @raise [ArgumentError] if loudness_profile is not a Profile.
-  def loudness_profile= loudness_profile
-    ARG_SPECS[:loudness_profile].validate_value loudness_profile
-    @loudness_profile = loudness_profile
+    return (@notes == other.notes) &&
+    (@loudness_profile == other.loudness_profile)    
   end
 
   # Duration of part notes.
   def duration
-    total_duration = @notes.inject(0) { |sum, note| sum + note.duration }
-    return @offset + total_duration
-  end
-  
-  # offset where part begins
-  def start
-    return @offset
-  end
-
-  # offset where part ends
-  def end
-    return @offset + duration
+    return @notes.inject(0) { |sum, note| sum + note.duration }
   end
   
   def transpose pitch_diff
@@ -83,45 +42,12 @@ class Part
   end
 
   def transpose! pitch_diff
-    @notes.each do |note|
-      note.transpose! pitch_diff
+    @notes[0...-1].each do |note|
+      note.transpose_pitches_and_links! pitch_diff
     end
+    @notes[-1].transpose_pitches_only! pitch_diff
     return self
-  end 
-end
-
-class PartFile < Part
-  include Hashmake::HashMakeable
-  attr_reader :file_path
-  
-  # hashed-arg specs (for hash-makeable idiom)
-  ARG_SPECS = {
-    :file_path => arg_spec(:reqd => true, :type => String, :validator => ->(a){ File.exist? a })
-  }
-  
-  # A new instance of Part.
-  # @param [Hash] args Hashed arguments. Only valid keys is :file_path.
-  def initialize args
-    hash_make args, PartFile::ARG_SPECS
-    
-    unless @file_path.nil?
-      obj = YAML.load_file @file_path
-      
-      if obj.is_a?(Part)
-        super(:offset => obj.offset, :notes => obj.notes, :loudness_profile => obj.loudness_profile)
-      elsif obj.is_a?(Hash)
-        super(obj)
-      else
-        raise ArgumentError, "Expected a Hash or Part object"
-      end
-    end
-  end
-
-  # Produce an exact copy of the current object
-  def clone
-    Marshal.load(Marshal.dump(self))
-  end
-
+  end  
 end
 
 end

data/lib/music-transcription/pitch.rb

@@ -46,7 +46,6 @@ module Transcription
 #
 class Pitch
   include Comparable
-  include Hashmake::HashMakeable
   attr_reader :cents_per_octave, :base_freq, :octave, :semitone, :cent
 
   #The default number of semitones per octave is 12, corresponding to 
@@ -60,49 +59,40 @@ class Pitch
   # The default base ferquency is C0
   DEFAULT_BASE_FREQ = 16.351597831287414
 
-  # hashed-arg specs (for hash-makeable idiom)
-  ARG_SPECS = {
-    :octave => arg_spec(:reqd => false, :type => Fixnum, :default => 0),
-    :semitone => arg_spec(:reqd => false, :type => Fixnum, :default => 0), 
-    :cent => arg_spec(:reqd => false, :type => Fixnum, :default => 0), 
-    :base_freq => arg_spec(:reqd => false, :type => Numeric, :validator => ->(a){ a > 0.0 }, :default => DEFAULT_BASE_FREQ)
-  }
-  
   # A new instance of Pitch.
-  # @param [Hash] args Hashed args. See ARG_SPECS for details.
-  # @raise [ArgumentError] if any of :octave, :semitone, or :cent is
-  #                        not a Fixnum.
-  def initialize args={}
+  # @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
-    hash_make args
-    normalize!
-  end
-
-  # Set @base_freq, which is used with the pitch ratio to produce the
-  # pitch frequency.
-  def base_freq= base_freq
-    ARG_SPECS[:base_freq].validate_value base_freq
-    @base_freq = base_freq
-  end
-  
-  # Set @octave.
-  def octave= octave
-    ARG_SPECS[:octave].validate_value octave
     @octave = octave
-  end
-  
-  # Set semitone.
-  def semitone= semitone
-    ARG_SPECS[:semitone].validate_value semitone
     @semitone = semitone
-  end
-  
-  # Set @cent.
-  def cent= cent
-    ARG_SPECS[:cent].validate_value cent
     @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 
@@ -191,18 +181,26 @@ class Pitch
   # Add pitches by adding the total cent 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)
+    self.class.new(
+      octave: (@octave + other.octave),
+      semitone: (@semitone + other.semitone),
+      cent: (@cent + other.cent)
+    )
   end
 
   # Add pitches by subtracting the total cent 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)
+    self.class.new(
+      octave: (@octave - other.octave),
+      semitone: (@semitone - other.semitone),
+      cent: (@cent - other.cent)
+    )
   end
   
   # Produce an identical Pitch object.
   def clone
-    Marshal.load(Marshal.dump(self))
+    Marshal.load(Marshal.dump(self))  # is this cheating?
   end
   
   # Balance out the octave, semitone, and cent count. 
@@ -294,4 +292,4 @@ class String
     return semitone
   end
 
-end
+end

data/lib/music-transcription/pitch_constants.rb

@@ -4,189 +4,189 @@ module Transcription
 # Define twelve pitch constants for each octave from octave 0 through 8.
 
 # A pitch on octave 0
-A0  = Pitch.new :octave => 0, :semitone => 9
+A0  = Pitch.new octave: 0, semitone: 9
 # Bb pitch on octave 
-Bb0 = Pitch.new :octave => 0, :semitone => 10
+Bb0 = Pitch.new octave: 0, semitone: 10
 # B pitch on octave 0
-B0  = Pitch.new :octave => 0, :semitone => 11
+B0  = Pitch.new octave: 0, semitone: 11
 
 # C pitch on octave 1
-C1  = Pitch.new :octave => 1, :semitone => 0
+C1  = Pitch.new octave: 1, semitone: 0
 # Db pitch on octave 1
-Db1 = Pitch.new :octave => 1, :semitone => 1
+Db1 = Pitch.new octave: 1, semitone: 1
 # E pitch on octave 1
-D1  = Pitch.new :octave => 1, :semitone => 2
+D1  = Pitch.new octave: 1, semitone: 2
 # Eb pitch on octave 1
-Eb1 = Pitch.new :octave => 1, :semitone => 3
+Eb1 = Pitch.new octave: 1, semitone: 3
 # E pitch on octave 1
-E1  = Pitch.new :octave => 1, :semitone => 4
+E1  = Pitch.new octave: 1, semitone: 4
 # F pitch on octave 1
-F1  = Pitch.new :octave => 1, :semitone => 5
+F1  = Pitch.new octave: 1, semitone: 5
 # Gb pitch on octave 1
-Gb1 = Pitch.new :octave => 1, :semitone => 6
+Gb1 = Pitch.new octave: 1, semitone: 6
 # G pitch on octave 1
-G1  = Pitch.new :octave => 1, :semitone => 7
+G1  = Pitch.new octave: 1, semitone: 7
 # Ab pitch on octave 1
-Ab1 = Pitch.new :octave => 1, :semitone => 8
+Ab1 = Pitch.new octave: 1, semitone: 8
 # A pitch on octave 1
-A1  = Pitch.new :octave => 1, :semitone => 9
+A1  = Pitch.new octave: 1, semitone: 9
 # Bb pitch on octave 
-Bb1 = Pitch.new :octave => 1, :semitone => 10
+Bb1 = Pitch.new octave: 1, semitone: 10
 # B pitch on octave 1
-B1  = Pitch.new :octave => 1, :semitone => 11
+B1  = Pitch.new octave: 1, semitone: 11
 
 # C pitch on octave 2
-C2  = Pitch.new :octave => 2, :semitone => 0
+C2  = Pitch.new octave: 2, semitone: 0
 # Db pitch on octave 2
-Db2 = Pitch.new :octave => 2, :semitone => 1
+Db2 = Pitch.new octave: 2, semitone: 1
 # E pitch on octave 2
-D2  = Pitch.new :octave => 2, :semitone => 2
+D2  = Pitch.new octave: 2, semitone: 2
 # Eb pitch on octave 2
-Eb2 = Pitch.new :octave => 2, :semitone => 3
+Eb2 = Pitch.new octave: 2, semitone: 3
 # E pitch on octave 2
-E2  = Pitch.new :octave => 2, :semitone => 4
+E2  = Pitch.new octave: 2, semitone: 4
 # F pitch on octave 2
-F2  = Pitch.new :octave => 2, :semitone => 5
+F2  = Pitch.new octave: 2, semitone: 5
 # Gb pitch on octave 2
-Gb2 = Pitch.new :octave => 2, :semitone => 6
+Gb2 = Pitch.new octave: 2, semitone: 6
 # G pitch on octave 2
-G2  = Pitch.new :octave => 2, :semitone => 7
+G2  = Pitch.new octave: 2, semitone: 7
 # Ab pitch on octave 2
-Ab2 = Pitch.new :octave => 2, :semitone => 8
+Ab2 = Pitch.new octave: 2, semitone: 8
 # A pitch on octave 2
-A2  = Pitch.new :octave => 2, :semitone => 9
+A2  = Pitch.new octave: 2, semitone: 9
 # Bb pitch on octave 
-Bb2 = Pitch.new :octave => 2, :semitone => 10
+Bb2 = Pitch.new octave: 2, semitone: 10
 # B pitch on octave 2
-B2  = Pitch.new :octave => 2, :semitone => 11
+B2  = Pitch.new octave: 2, semitone: 11
 
 # C pitch on octave 3
-C3  = Pitch.new :octave => 3, :semitone => 0
+C3  = Pitch.new octave: 3, semitone: 0
 # Db pitch on octave 3
-Db3 = Pitch.new :octave => 3, :semitone => 1
+Db3 = Pitch.new octave: 3, semitone: 1
 # E pitch on octave 3
-D3  = Pitch.new :octave => 3, :semitone => 2
+D3  = Pitch.new octave: 3, semitone: 2
 # Eb pitch on octave 3
-Eb3 = Pitch.new :octave => 3, :semitone => 3
+Eb3 = Pitch.new octave: 3, semitone: 3
 # E pitch on octave 3
-E3  = Pitch.new :octave => 3, :semitone => 4
+E3  = Pitch.new octave: 3, semitone: 4
 # F pitch on octave 3
-F3  = Pitch.new :octave => 3, :semitone => 5
+F3  = Pitch.new octave: 3, semitone: 5
 # Gb pitch on octave 3
-Gb3 = Pitch.new :octave => 3, :semitone => 6
+Gb3 = Pitch.new octave: 3, semitone: 6
 # G pitch on octave 3
-G3  = Pitch.new :octave => 3, :semitone => 7
+G3  = Pitch.new octave: 3, semitone: 7
 # Ab pitch on octave 3
-Ab3 = Pitch.new :octave => 3, :semitone => 8
+Ab3 = Pitch.new octave: 3, semitone: 8
 # A pitch on octave 3
-A3  = Pitch.new :octave => 3, :semitone => 9
+A3  = Pitch.new octave: 3, semitone: 9
 # Bb pitch on octave 
-Bb3 = Pitch.new :octave => 3, :semitone => 10
+Bb3 = Pitch.new octave: 3, semitone: 10
 # B pitch on octave 3
-B3  = Pitch.new :octave => 3, :semitone => 11
+B3  = Pitch.new octave: 3, semitone: 11
 
 # C pitch on octave 4
-C4  = Pitch.new :octave => 4, :semitone => 0
+C4  = Pitch.new octave: 4, semitone: 0
 # Db pitch on octave 4
-Db4 = Pitch.new :octave => 4, :semitone => 1
+Db4 = Pitch.new octave: 4, semitone: 1
 # E pitch on octave 4
-D4  = Pitch.new :octave => 4, :semitone => 2
+D4  = Pitch.new octave: 4, semitone: 2
 # Eb pitch on octave 4
-Eb4 = Pitch.new :octave => 4, :semitone => 3
+Eb4 = Pitch.new octave: 4, semitone: 3
 # E pitch on octave 4
-E4  = Pitch.new :octave => 4, :semitone => 4
+E4  = Pitch.new octave: 4, semitone: 4
 # F pitch on octave 4
-F4  = Pitch.new :octave => 4, :semitone => 5
+F4  = Pitch.new octave: 4, semitone: 5
 # Gb pitch on octave 4
-Gb4 = Pitch.new :octave => 4, :semitone => 6
+Gb4 = Pitch.new octave: 4, semitone: 6
 # G pitch on octave 4
-G4  = Pitch.new :octave => 4, :semitone => 7
+G4  = Pitch.new octave: 4, semitone: 7
 # Ab pitch on octave 4
-Ab4 = Pitch.new :octave => 4, :semitone => 8
+Ab4 = Pitch.new octave: 4, semitone: 8
 # A pitch on octave 4
-A4  = Pitch.new :octave => 4, :semitone => 9
+A4  = Pitch.new octave: 4, semitone: 9
 # Bb pitch on octave 
-Bb4 = Pitch.new :octave => 4, :semitone => 10
+Bb4 = Pitch.new octave: 4, semitone: 10
 # B pitch on octave 4
-B4  = Pitch.new :octave => 4, :semitone => 11
+B4  = Pitch.new octave: 4, semitone: 11
 
 # C pitch on octave 5
-C5  = Pitch.new :octave => 5, :semitone => 0
+C5  = Pitch.new octave: 5, semitone: 0
 # Db pitch on octave 5
-Db5 = Pitch.new :octave => 5, :semitone => 1
+Db5 = Pitch.new octave: 5, semitone: 1
 # E pitch on octave 5
-D5  = Pitch.new :octave => 5, :semitone => 2
+D5  = Pitch.new octave: 5, semitone: 2
 # Eb pitch on octave 5
-Eb5 = Pitch.new :octave => 5, :semitone => 3
+Eb5 = Pitch.new octave: 5, semitone: 3
 # E pitch on octave 5
-E5  = Pitch.new :octave => 5, :semitone => 4
+E5  = Pitch.new octave: 5, semitone: 4
 # F pitch on octave 5
-F5  = Pitch.new :octave => 5, :semitone => 5
+F5  = Pitch.new octave: 5, semitone: 5
 # Gb pitch on octave 5
-Gb5 = Pitch.new :octave => 5, :semitone => 6
+Gb5 = Pitch.new octave: 5, semitone: 6
 # G pitch on octave 5
-G5  = Pitch.new :octave => 5, :semitone => 7
+G5  = Pitch.new octave: 5, semitone: 7
 # Ab pitch on octave 5
-Ab5 = Pitch.new :octave => 5, :semitone => 8
+Ab5 = Pitch.new octave: 5, semitone: 8
 # A pitch on octave 5
-A5  = Pitch.new :octave => 5, :semitone => 9
+A5  = Pitch.new octave: 5, semitone: 9
 # Bb pitch on octave 
-Bb5 = Pitch.new :octave => 5, :semitone => 10
+Bb5 = Pitch.new octave: 5, semitone: 10
 # B pitch on octave 5
-B5  = Pitch.new :octave => 5, :semitone => 11
+B5  = Pitch.new octave: 5, semitone: 11
 
 # C pitch on octave 6
-C6  = Pitch.new :octave => 6, :semitone => 0
+C6  = Pitch.new octave: 6, semitone: 0
 # Db pitch on octave 6
-Db6 = Pitch.new :octave => 6, :semitone => 1
+Db6 = Pitch.new octave: 6, semitone: 1
 # E pitch on octave 6
-D6  = Pitch.new :octave => 6, :semitone => 2
+D6  = Pitch.new octave: 6, semitone: 2
 # Eb pitch on octave 6
-Eb6 = Pitch.new :octave => 6, :semitone => 3
+Eb6 = Pitch.new octave: 6, semitone: 3
 # E pitch on octave 6
-E6  = Pitch.new :octave => 6, :semitone => 4
+E6  = Pitch.new octave: 6, semitone: 4
 # F pitch on octave 6
-F6  = Pitch.new :octave => 6, :semitone => 5
+F6  = Pitch.new octave: 6, semitone: 5
 # Gb pitch on octave 6
-Gb6 = Pitch.new :octave => 6, :semitone => 6
+Gb6 = Pitch.new octave: 6, semitone: 6
 # G pitch on octave 6
-G6  = Pitch.new :octave => 6, :semitone => 7
+G6  = Pitch.new octave: 6, semitone: 7
 # Ab pitch on octave 6
-Ab6 = Pitch.new :octave => 6, :semitone => 8
+Ab6 = Pitch.new octave: 6, semitone: 8
 # A pitch on octave 6
-A6  = Pitch.new :octave => 6, :semitone => 9
+A6  = Pitch.new octave: 6, semitone: 9
 # Bb pitch on octave 
-Bb6 = Pitch.new :octave => 6, :semitone => 10
+Bb6 = Pitch.new octave: 6, semitone: 10
 # B pitch on octave 6
-B6  = Pitch.new :octave => 6, :semitone => 11
+B6  = Pitch.new octave: 6, semitone: 11
 
 # C pitch on octave 7
-C7  = Pitch.new :octave => 7, :semitone => 0
+C7  = Pitch.new octave: 7, semitone: 0
 # Db pitch on octave 7
-Db7 = Pitch.new :octave => 7, :semitone => 1
+Db7 = Pitch.new octave: 7, semitone: 1
 # E pitch on octave 7
-D7  = Pitch.new :octave => 7, :semitone => 2
+D7  = Pitch.new octave: 7, semitone: 2
 # Eb pitch on octave 7
-Eb7 = Pitch.new :octave => 7, :semitone => 3
+Eb7 = Pitch.new octave: 7, semitone: 3
 # E pitch on octave 7
-E7  = Pitch.new :octave => 7, :semitone => 4
+E7  = Pitch.new octave: 7, semitone: 4
 # F pitch on octave 7
-F7  = Pitch.new :octave => 7, :semitone => 5
+F7  = Pitch.new octave: 7, semitone: 5
 # Gb pitch on octave 7
-Gb7 = Pitch.new :octave => 7, :semitone => 6
+Gb7 = Pitch.new octave: 7, semitone: 6
 # G pitch on octave 7
-G7  = Pitch.new :octave => 7, :semitone => 7
+G7  = Pitch.new octave: 7, semitone: 7
 # Ab pitch on octave 7
-Ab7 = Pitch.new :octave => 7, :semitone => 8
+Ab7 = Pitch.new octave: 7, semitone: 8
 # A pitch on octave 7
-A7  = Pitch.new :octave => 7, :semitone => 9
+A7  = Pitch.new octave: 7, semitone: 9
 # Bb pitch on octave 
-Bb7 = Pitch.new :octave => 7, :semitone => 10
+Bb7 = Pitch.new octave: 7, semitone: 10
 # B pitch on octave 7
-B7  = Pitch.new :octave => 7, :semitone => 11
+B7  = Pitch.new octave: 7, semitone: 11
 
 # C pitch on octave 8
-C8  = Pitch.new :octave => 8, :semitone => 0
+C8  = Pitch.new octave: 8, semitone: 0
 
 # Contain pitch objects from A0 to C8
 PITCHES = [