music-transcription 0.3.0

data/lib/music-transcription/pitch_constants.rb

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

data/lib/music-transcription/profile.rb

@@ -0,0 +1,105 @@
+module Music
+module Transcription
+
+# Represent a setting that can change over time.
+# 
+# @author James Tunnell
+#
+class Profile
+  include Hashmake::HashMakeable
+  
+  attr_accessor :start_value, :value_changes
+  
+  # hashed-arg specs (for hash-makeable idiom)
+  ARG_SPECS = {
+    :start_value => arg_spec(:reqd => true),
+    :value_changes => arg_spec_hash(:reqd => false, :type => ValueChange)
+  }
+
+  # A new instance of Profile.
+  #
+  # @param [Hash] args Hashed args. Required key is :start_value. Optional key is :value_changes.
+  def initialize args
+    hash_make args, Profile::ARG_SPECS
+  end
+  
+  # Compare to another Profile object.
+  def == other
+    (self.class == other.class) && 
+    (self.start_value == other.start_value) &&
+    (self.value_changes == other.value_changes)
+  end
+  
+  # Produce an identical Profile object.
+  def clone
+    Profile.new(:start_value => @start_value, :value_changes => @value_changes.clone)
+  end
+  
+  # Returns true if start value and value changes all are between given A and B.
+  def values_between? a, b
+    is_ok = self.start_value.between?(a,b)
+    
+    if is_ok
+      self.value_changes.each do |offset, setting|
+        setting.value.between?(a,b)
+      end
+    end
+    return is_ok
+  end
+
+  # Returns true if start value and value changes all are greater than zero.
+  def values_positive?
+    is_ok = self.start_value > 0.0
+    
+    if is_ok
+      self.value_changes.each do |offset, setting|
+        setting.value > 0.0
+      end
+    end
+    return is_ok
+  end
+  
+  def clone_and_collate computer_class, program_segments
+    new_profile = Profile.new :start_value => start_value
+    
+    segment_start_offset = 0.0
+    comp = computer_class.new(self)
+    
+    program_segments.each do |seg|
+      # figure which dynamics to keep/modify
+      changes = Marshal.load(Marshal.dump(value_changes))
+      changes.keep_if {|offset,change| seg.include?(offset) }
+      changes.each do |offset, change|
+	if(offset + change.transition.duration) > seg.last
+	  change.transition.duration = seg.last - offset
+	  change.value = comp.value_at seg.last
+	end
+      end
+      
+      # find & add segment start value first
+      value = comp.value_at seg.first
+      offset = segment_start_offset
+      new_profile.value_changes[offset] = value_change(value)
+      
+      # add changes to part, adjusting for segment start offset
+      changes.each do |offset2, change|
+	offset3 = (offset2 - seg.first) + segment_start_offset
+	new_profile.value_changes[offset3] = change
+      end
+      
+      segment_start_offset += (seg.last - seg.first)
+    end
+    
+    return new_profile
+  end
+end
+
+module_function
+
+# Create a Profile object
+def profile start_value, value_changes = {}
+  return Profile.new(:start_value => start_value, :value_changes => value_changes)
+end
+
+end
+end

data/lib/music-transcription/program.rb

@@ -0,0 +1,136 @@
+module Music
+module Transcription
+
+# Program defines markers (by starting note offset) and subprograms (list which markers are played).
+#
+# @author James Tunnell
+#
+class Program
+  include Hashmake::HashMakeable
+  attr_reader :segments
+
+  # hashed-arg specs (for hash-makeable idiom)
+  ARG_SPECS = {
+    :segments => arg_spec_array(:reqd => false, :type => Range)
+  }
+
+  # A new instance of Program.
+  # @param [Hash] args Hashed arguments. Required key is :segments.
+  def initialize args={}
+    hash_make args
+  end
+
+  # Assign program segments. Each segment is a Range to specify which range of 
+  # notes from a score should be played.
+  #
+  # @param [Array] segments An array of program segements. Each segment is a 
+  #                         Range to specify which range of 
+  # @raise [ArgumentError] if segments is not an Array.
+  # @raise [ArgumentError] if segments contains a non-Range
+  #
+  def segments= segments
+    ARG_SPECS[:segments].validate_value segments
+    @segments = segments
+  end
+
+  # @return [Float] the starting note offset for the program
+  def start
+    @segments.first.first
+  end
+
+  # @return [Float] the ending note offset for the program
+  def stop
+    @segments.last.last
+  end
+
+  # @return [Float] the sum of all program segment lengths
+  def length
+    segments.inject(0.0) { |length, segment| length + (segment.last - segment.first) }
+  end
+  
+    # compare to another Program
+  def == other
+#    raise ArgumentError, "program is invalid" if !self.valid?    
+    return @segments == other.segments
+  end
+
+  def include? offset
+    @segments.each do |segment|
+      if segment.include?(offset)
+        return true
+      end
+    end
+    return false
+  end
+
+  # For the given note elapsed, what will the note offset be?
+  #
+  def note_offset_for elapsed
+    raise ArgumentError, "elapsed #{elapsed} is less than 0.0" if elapsed < 0.0
+    raise ArgumentError, "elapsed #{elapsed} is greater than program length" if elapsed > self.length
+    
+    so_far = 0.0
+    
+    @segments.each do |segment|
+      segment_length = segment.last - segment.first
+      
+      if (segment_length + so_far) > elapsed
+        return segment.first + (elapsed - so_far)
+      else
+        so_far += segment_length
+      end
+    end
+    
+    raise "offset not determined even though the given elapsed is less than program length!"
+  end
+  
+  # For the given note offset in the score, how much note will have elapsed to 
+  # get there according to the program?
+  #
+  def note_elapsed_at offset
+    raise ArgumentError, "offset #{offset} is not included in program" if !self.include?(offset)
+    
+    elapsed = 0.0
+    
+    @segments.each do |segment|
+      if segment.include?(offset)
+        elapsed += (offset - segment.first)
+        break
+      else
+        elapsed += (segment.last - segment.first)
+      end
+    end
+    
+    return elapsed
+  end
+  
+  # For the given note offset in the score, how much time will have elapsed to 
+  # get there according to the program?
+  #
+  def time_elapsed_at offset, note_time_converter
+    raise ArgumentError, "offset #{offset} is not included in program" if !self.include?(offset)
+
+    elapsed = 0.0
+    
+    @segments.each do |segment|
+      if segment.include?(offset)
+        elapsed += note_time_converter.time_elapsed(segment.first, offset)
+        break
+      else
+        elapsed += note_time_converter.time_elapsed(segment.first, segment.last)
+      end
+    end
+    
+    return elapsed
+  end
+  
+end
+
+module_function
+
+def program segments
+  Program.new(:segments => segments)
+end
+
+end
+end

data/lib/music-transcription/score.rb

@@ -0,0 +1,122 @@
+module Music
+module Transcription
+
+# Abstraction of a musical score. Contains parts and a program.
+#
+# @author James Tunnell
+#
+# @!attribute [rw] parts
+#   @return [Array] Score parts.
+# 
+# @!attribute [rw] program
+#   @return [Array] Score program.
+#
+class Score
+  include Hashmake::HashMakeable
+  attr_reader :parts, :program
+
+  # hashed-arg specs (for hash-makeable idiom)
+  ARG_SPECS = {
+    :parts => arg_spec_hash(:reqd => false, :type => Part),
+    :program => arg_spec(:reqd => false, :type => Program, :default => ->(){ Program.new }),
+  }
+  
+  # A new instance of Score.
+  # @param [Hash] args Hashed arguments. Optional keys are :program and :parts.
+  def initialize args={}
+    hash_make args, ARG_SPECS
+  end
+  
+  def clone
+    Marshal.load(Marshal.dump(self))
+  end
+  
+  # Compare the equality of another Score object.
+  def ==(other)
+    return (@program == other.program) &&
+    (@parts == other.parts)
+  end
+  
+  # Set the score parts.
+  # @param [Hash] parts The score parts, mapped to IDs.
+  # @raise [ArgumentError] if notes is not a Hash.
+  # @raise [ArgumentError] if parts contain a non-Part object.
+  def parts= parts
+    Score::ARG_SPECS[:parts].validate_value parts
+    @parts = parts
+  end
+
+  # Set the score program, which determines which defines sections and how they 
+  # are played.
+  # @param [Program] program The score program.
+  # @raise [ArgumentError] if tempos is not a Program.
+  def program= program
+    Score::ARG_SPECS[:program].validate_value program
+    @program = program
+  end
+
+  # Find the start of a score. The start will be at then start of whichever part begins
+  # first, or 0 if no parts have been added.
+  def start
+    sos = 0.0
+    
+    @parts.each do |id,part|
+      sop = part.start
+      sos = sop if sop > sos
+    end
+    
+    return sos
+  end
+  
+  # Find the end of a score. The end will be at then end of whichever part ends 
+  # last, or 0 if no parts have been added.
+  def end
+    eos = 0.0
+    
+    @parts.each do |id,part|
+      eop = part.end
+      eos = eop if eop > eos
+    end
+    
+    return eos
+  end
+end
+
+# Score with a tempo profile.
+#
+# @author James Tunnell
+#
+# @!attribute [rw] tempo_profile
+#   @return [Profile] The tempo profile.
+#
+class TempoScore < Score
+  include Hashmake::HashMakeable
+  attr_reader :tempo_profile
+
+  # hashed-arg specs (for hash-makeable idiom)
+  ARG_SPECS = {
+    :tempo_profile => arg_spec(:reqd => true, :type => Profile, :validator => ->(a){ a.values_positive? }),
+  }
+  
+  # A new instance of Score.
+  # @param [Hash] args Hashed arguments. Required key is :tempo_profile.
+  def initialize args={}
+    hash_make args
+    super(args)
+  end
+  
+  def clone
+    Marshal.load(Marshal.dump(self))
+  end
+  
+  # Set the score tempo Profile.
+  # @param [Profile] tempo_profile The tempo profile for the score.
+  # @raise [ArgumentError] if tempo_profile is not a Profile.
+  def tempo_profile= tempo_profile
+    TempoScore::ARG_SPECS[:tempo_profile].validate_value tempo_profile
+    @tempo_profile = tempo_profile
+  end
+end
+
+end
+end