music-transcription 0.17.1 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5a8173f71d182fdb10c274aa8aa4be1084313fc
-  data.tar.gz: 0ff97739c5721cdc104f627fe221b920e3f63f6f
+  metadata.gz: f5b490ee5916154f2376f07568ccd234ff6fb82a
+  data.tar.gz: 2a2fff2f3b7e94deacc2438d510f1d803cf6efcb
 SHA512:
-  metadata.gz: 1f021993759bce36baeb58e0123a7ce74a2b3c6663a308b6fc02e78c643a0af666056406be5e847102b80729b938366c494669390bd152450e726b456238dc8a
-  data.tar.gz: d746f77a31bf4b795bfffaef789fdd4ba828bd9e29aede3fa305f31c52e7570401309e5b205bfa93d0646c9f50ca4d5853a156aeccaf4c6c3cfc32bb7aeb20db
+  metadata.gz: 797d3b962ded3291e92d8ba49a390072663d1ae37b0e7e957b3acc562d2d1793d569a7c117fd750de3bb99e03ed4d935cc0b13338c95e669993128acbd246902
+  data.tar.gz: e0ae19e64aa43b0dc274d61601db32cbcccf87b33226c312e4f76407f7e87b7694a4f678c32de08bf17a714da5aa2e113a7ca15b470dbc2e8b48dbab07360489

data/examples/hip.rb

@@ -10,14 +10,14 @@ include Parsing
 score = Score.new(FOUR_FOUR,120) do |s|
   s.program = Program.new([0...2, 0...2,2...4,0...2])
   s.parts["lead"] = Part.new(Dynamics::MF) do |p|
-    riff = notes("/6Bb3 /4 /12Db4= /6Db4= /36Db4 /36Eb4 /36Db4 /6Ab3 /12Db4 \
-                  /6Bb3 /4 /12Db4= /4Db4=                      /8=Db4 /8C4")
+    riff = "/6Bb3 /4 /12Db4= /6Db4= /36Db4 /36Eb4 /36Db4 /6Ab3 /12Db4 \
+            /6Bb3 /4 /12Db4= /4Db4=                      /8=Db4 /8C4".to_notes
     p.notes = riff + riff.map {|n| n.transpose(2) }
   end
   
   s.parts["bass"] = Part.new(Dynamics::MP) do |p|
-    riff = notes("/6Bb2 /4 /3Ab2 /6F2 /12Ab2 \
-                  /6Bb2 /4 /3Ab2 /4Ab2")
+    riff = "/6Bb2 /4 /3Ab2 /6F2 /12Ab2 \
+            /6Bb2 /4 /3Ab2 /4Ab2".to_notes
     p.notes = riff + riff.map {|n| n.transpose(2) }
   end
 end

data/examples/missed_connection.rb

@@ -10,9 +10,9 @@ include Parsing
 score = Score.new(FOUR_FOUR, 120) do |s|
   s.program = Program.new([0...2,0...6])
   s.parts["bass"] = Part.new(Dynamics::MF) do |p|
-    p.notes =  notes("/4Eb2 /4 /4Bb2 /4 /4Eb2 /8 /8B2 /4Bb2 /4Ab2")
-    p.notes += notes("/4Bb2 /8 /8F3= /2F3 /4Bb2 /8 /8F3= /2F3")
-    p.notes += notes("/4B2 /8 /8Gb3= /2Gb3 /8 /8Gb3= /2Gb3")
+    p.notes =  "/4Eb2 /4 /4Bb2 /4 /4Eb2 /8 /8B2 /4Bb2 /4Ab2".to_notes
+    p.notes += "/4Bb2 /8 /8F3= /2F3 /4Bb2 /8 /8F3= /2F3".to_notes
+    p.notes += "/4B2 /8 /8Gb3= /2Gb3 /8 /8Gb3= /2Gb3".to_notes
   end
 end
 

data/examples/song1.rb

@@ -11,15 +11,15 @@ score = Score.new(FOUR_FOUR, 120) do |s|
   s.program = Program.new([ 0...4.0, 0...4.0 ])
   
   s.parts[1] = Part.new(Dynamics::MF) do |p|
-    p.notes = notes("3/8C2 /4Eb2 5/16F2 /16Eb2 \
-                     /8 /4C2 /4Eb2 3/8 \
-                     3/8C2 /4Eb2 5/16F2 /16Eb2 \
-                     /8 /4C2 /4Eb2")
+    p.notes = "3/8C2 /4Eb2 5/16F2 /16Eb2 \
+               /8 /4C2 /4Eb2 3/8 \
+               3/8C2 /4Eb2 5/16F2 /16Eb2 \
+               /8 /4C2 /4Eb2".to_notes
   end
   
   s.parts[2] = Part.new(Dynamics::MF) do |p|
-    p.notes = notes("/8 /8Bb3 /8Bb3 /8Bb3 /8Bb3 /4C4 /4A3 /8G3 /8F3 5/16=G3 /16=F3 /8E3 /8 \
-                     /8 /8Bb3 /8Bb3 /8Bb3 /8Bb3 /4C4 /8A3 /8E4 /8=E4 /8=D4 /8C4")
+    p.notes = "/8 /8Bb3 /8Bb3 /8Bb3 /8Bb3 /4C4 /4A3 /8G3 /8F3 5/16=G3 /16=F3 /8E3 /8 \
+               /8 /8Bb3 /8Bb3 /8Bb3 /8Bb3 /4C4 /8A3 /8E4 /8=E4 /8=D4 /8C4".to_notes
   end
 end
 

data/examples/song2.rb

@@ -10,15 +10,15 @@ score = Score.new(FOUR_FOUR, 120) do |s|
   s.program = Program.new([0...4.0, 0...4.0 ])
   
   s.parts[1] = Part.new(Dynamics::MF) do |p|
-    p.notes = notes("1C4 1Bb3 1Ab3 /2G3 /2Bb3")
+    p.notes = "1C4 1Bb3 1Ab3 /2G3 /2Bb3".to_notes
   end
   
   s.parts[2] = Part.new(Dynamics::MF) do |p|
-    p.notes = notes("3/8E5 1D5 1C5 5/8C5 /2C5 /2D5")
+    p.notes = "3/8E5 1D5 1C5 5/8C5 /2C5 /2D5".to_notes
   end
   
   s.parts[3] = Part.new(Dynamics::MF) do |p|
-    p.notes = notes("/8 /4G5 /2F5 /4 /4F5 /2Eb5 /4 /4Eb5 /2Eb5 /8 /2Eb5 /2F5")
+    p.notes = "/8 /4G5 /2F5 /4 /4F5 /2Eb5 /4 /4Eb5 /2Eb5 /8 /2Eb5 /2F5".to_notes
   end
 end
 

data/lib/music-transcription.rb

@@ -14,13 +14,16 @@ require 'music-transcription/model/change'
 require 'music-transcription/model/part'
 require 'music-transcription/model/program'
 require 'music-transcription/model/tempo'
+require 'music-transcription/model/note_score'
 require 'music-transcription/model/meter'
 require 'music-transcription/model/meters'
-require 'music-transcription/model/score'
+require 'music-transcription/model/measure_score'
 
 require 'treetop'
 require 'music-transcription/parsing/numbers/nonnegative_integer_parsing'
 require 'music-transcription/parsing/numbers/positive_integer_parsing'
+require 'music-transcription/parsing/numbers/positive_float_parsing'
+require 'music-transcription/parsing/numbers/positive_rational_parsing'
 require 'music-transcription/parsing/numbers/nonnegative_float_parsing'
 require 'music-transcription/parsing/numbers/nonnegative_rational_parsing'
 require 'music-transcription/parsing/pitch_parsing'
@@ -34,9 +37,12 @@ require 'music-transcription/parsing/note_parsing'
 require 'music-transcription/parsing/note_node'
 require 'music-transcription/parsing/meter_parsing'
 require 'music-transcription/parsing/segment_parsing'
+require 'music-transcription/parsing/tempo_parsing'
+require 'music-transcription/parsing/parseable'
 require 'music-transcription/parsing/convenience_methods'
 
 require 'music-transcription/packing/change_packing'
 require 'music-transcription/packing/part_packing'
 require 'music-transcription/packing/program_packing'
-require 'music-transcription/packing/score_packing'
+require 'music-transcription/packing/note_score_packing'
+require 'music-transcription/packing/measure_score_packing'

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

@@ -17,12 +17,15 @@ class Change
 
   class Immediate < Change
     include Validatable
-    
-    @@check_methods = [ :ensure_zero_duration ]
+
     def initialize value
       super(value,0)
     end
     
+    def check_methods
+      [ :ensure_zero_duration ]
+    end
+    
     def ensure_zero_duration
       unless @duration == 0
         raise NonZeroError, "immediate change duration #{self.duration} must be 0"
@@ -33,11 +36,14 @@ class Change
   class Gradual < Change
     include Validatable
     
-    @@check_methods = [ :ensure_nonnegative_duration ]
     def initialize value, transition_duration
       super(value, transition_duration)
     end
     
+    def check_methods
+      [ :ensure_nonnegative_duration ]
+    end
+    
     def ensure_nonnegative_duration
       if @duration < 0
         raise NegativeError, "gradual change duration #{self.duration} must be non-negative"

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

@@ -0,0 +1,62 @@
+module Music
+module Transcription
+
+class MeasureScore < NoteScore
+  attr_accessor :start_meter, :meter_changes
+  
+  def initialize start_meter, start_tempo, meter_changes: {}, tempo_changes: {}, parts: {}, program: Program.new
+    @start_meter = start_meter
+    @meter_changes = meter_changes
+    
+    super(start_tempo, tempo_changes: tempo_changes, program: program, parts: parts)
+    yield(self) if block_given?
+  end
+  
+  def check_methods
+    super() + [:check_startmeter_type, :check_meterchange_types, :check_meterchange_durs]
+  end
+  
+  def validatables
+    super() + [ @start_meter ] + @meter_changes.values +
+      @meter_changes.values.map {|v| v.value}
+  end
+  
+  def valid_tempo_types
+    super() + [ Tempo::BPM ]
+  end
+  
+  def check_startmeter_type
+    unless @start_meter.is_a? Meter
+      raise TypeError, "start meter #{@start_meter} is not a Meter object"
+    end
+  end
+  
+  def check_meterchange_types
+    badtypes = @meter_changes.select {|k,v| !v.value.is_a?(Meter) }
+    if badtypes.any?
+      raise TypeError, "meter change values #{nonmeter_values} are not Meter objects"
+    end
+  end
+  
+  def check_meterchange_durs
+    nonzero_duration = @meter_changes.select {|k,v| v.duration != 0 }
+    if nonzero_duration.any?
+      raise NonZeroError, "meter changes #{nonzero_duration} have non-zero duration"
+    end
+  end
+  
+  def ==(other)
+    return super() && @start_meter == other.start_meter &&
+      @meter_changes == other.meter_changes
+  end
+    
+  # Convert to NoteScore object by first converting measure-based offsets to
+  # note-based offsets, and eliminating the use of meters. Also, tempo is
+  # converted from beats-per-minute to notes-per-minute.
+  def to_note_score
+    
+  end
+end
+
+end
+end

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

@@ -3,15 +3,19 @@ module Transcription
 
 class Meter
   include Validatable
+
   attr_reader :measure_duration, :beat_duration, :beats_per_measure
   
-  @@check_methods = [ :check_beats_per_measure, :check_beat_duration ]
   def initialize beats_per_measure, beat_duration
     @beats_per_measure = beats_per_measure
     @beat_duration = beat_duration
     @measure_duration = beats_per_measure * beat_duration    
   end
   
+  def check_methods
+    [ :check_beats_per_measure, :check_beat_duration ]
+  end
+  
   def check_beats_per_measure
     unless @beats_per_measure > 0
       raise NonPositiveError, "beats per measure #{@beats_per_measure} is not positive"

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

@@ -11,7 +11,6 @@ class Note
 
   DEFAULT_ARTICULATION = Articulations::NORMAL
   
-  @@check_methods = [ :ensure_positive_duration ]
   def initialize duration, pitches = [], articulation: DEFAULT_ARTICULATION, accented: false, links: {}
     @duration = duration
     @pitches = Set.new(pitches).sort
@@ -20,6 +19,10 @@ class Note
     @links = links
   end
   
+  def check_methods
+    [ :ensure_positive_duration ]
+  end
+  
   def ensure_positive_duration
     unless @duration > 0
       raise NonPositiveError, "duration #{@duration} is not positive"

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

@@ -0,0 +1,60 @@
+module Music
+module Transcription
+
+class NoteScore
+  include Validatable
+  
+  attr_accessor :start_tempo, :parts, :program, :tempo_changes
+  
+  def initialize start_tempo, tempo_changes: {}, parts: {}, program: Program.new
+    @start_tempo = start_tempo
+    @tempo_changes = tempo_changes
+    @parts = parts
+    @program = program
+    
+    yield(self) if block_given?
+  end
+
+  def check_methods
+    [ :check_start_tempo_type, :check_tempo_change_types ]
+  end
+  
+  def validatables
+    [ @program ] + @tempo_changes.values + @parts.values
+  end
+  
+  def valid_tempo_types
+    [ Tempo::QNPM, Tempo::NPM, Tempo::NPS ]
+  end
+  
+  def check_start_tempo_type
+    unless valid_tempo_types.include?(@start_tempo.class)
+      raise TypeError, "type of start tempo #{@start_tempo} is not one of valid tempo types: #{valid_tempo_types}"
+    end
+  end
+
+  def check_tempo_change_types
+    baddtypes = @tempo_changes.select {|k,v| !valid_tempo_types.include?(v.value.class) }
+    if baddtypes.any?
+      raise NonPositiveError, "type of tempo change values #{baddtypes} are not one of valid tempo types: #{valid_tempo_types}"
+    end
+  end
+  
+  def clone
+    Marshal.load(Marshal.dump(self))
+  end
+  
+  def ==(other)
+    return @start_tempo == other.start_tempo &&
+    @tempo_changes == other.tempo_changes &&
+    @parts == other.parts &&
+    @program == other.program
+  end
+    
+  def duration
+    @parts.map {|p| p.duration }.max
+  end
+end
+
+end
+end

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

@@ -8,7 +8,6 @@ class Part
   
   attr_accessor :start_dynamic, :dynamic_changes, :notes
   
-  @@check_methods = [:ensure_start_dynamic, :ensure_dynamic_change_values_range ]
   def initialize start_dynamic, notes: [], dynamic_changes: {}
     @notes = notes
     @start_dynamic = start_dynamic
@@ -17,6 +16,10 @@ class Part
     yield(self) if block_given?
   end
   
+  def check_methods
+    [:ensure_start_dynamic, :ensure_dynamic_change_values_range ]
+  end
+  
   def validatables
     @notes + @dynamic_changes.values
   end

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

@@ -9,12 +9,15 @@ class Program
   include Validatable
   
   attr_accessor :segments
-
-  @@check_methods = [:ensure_increasing_segments, :ensure_nonnegative_segments]
+  
   def initialize segments = []
     @segments = segments
   end
 
+  def check_methods
+    [:ensure_increasing_segments, :ensure_nonnegative_segments]
+  end
+  
   # @return [Float] the sum of all program segment lengths
   def length
     segments.inject(0.0) { |length, segment| length + (segment.last - segment.first) }

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

@@ -1,37 +1,27 @@
 module Music
 module Transcription
 
-# Represent the musical tempo, with beats ber minute and beat duration.
 class Tempo
-  include Comparable
-  attr_reader :beats_per_minute, :beat_duration
-  
-  def initialize beats_per_minute, beat_duration = Rational(1,4)
-    @beats_per_minute = beats_per_minute
-    @beat_duration = beat_duration
+  attr_reader :value
+  def initialize value
+    raise NonPositiveError, "Given tempo value #{value} is not positive" if value <= 0
+    @value = value
   end
   
   def ==(other)
-    (other.beats_per_minute == @beats_per_minute) &&
-    (other.beat_duration == @beat_duration)
-  end
-  
-  def notes_per_second
-    (@beats_per_minute * @beat_duration) / 60.0
+    self.class == other.class && self.value == other.value
   end
   
-  def between? a, b
-    notes_per_second.between? a, b
-  end
-  
-  def <=>(other)
-    if other.is_a? Tempo
-      notes_per_second <=> other.notes_per_second
-    else
-      notes_per_second <=> other
+  [ :qnpm, :bpm, :npm, :nps ].each do |sym|
+    klass = Class.new(Tempo) do
+      def to_s
+        "#{@value}#{self.class::PRINT_SYM}"
+      end
     end
+    klass.const_set(:PRINT_SYM,sym)
+    Tempo.const_set(sym.upcase,klass)
   end
 end
 
 end
-end
+end

data/lib/music-transcription/packing/measure_score_packing.rb

@@ -0,0 +1,34 @@
+module Music
+module Transcription
+
+class MeasureScore
+  def pack
+    hash = super()
+    hash["start_meter"] = start_meter.to_s
+    hash["meter_changes"] = Hash[ meter_changes.map do |offset,change|
+      a = change.pack
+      a[0] = a[0].to_s
+      [offset,a]
+    end ]
+    return hash
+  end
+  
+  def self.unpack packing
+    unpacked_start_meter = Meter.parse(packing["start_meter"])
+    unpacked_mcs = Hash[ packing["meter_changes"].map do |k,v|
+      v = v.clone
+      v[0] = Meter.parse(v[0])
+      [k, Change.from_ary(v) ]
+    end ]
+    
+    note_score = NoteScore.unpack(packing)
+    
+    new(unpacked_start_meter, note_score.start_tempo,
+      meter_changes: unpacked_mcs, tempo_changes: note_score.tempo_changes,
+      program: note_score.program, parts: note_score.parts
+    )
+  end
+end
+  
+end
+end

data/lib/music-transcription/packing/{score_packing.rb → note_score_packing.rb}

@@ -1,19 +1,15 @@
 module Music
 module Transcription
 
-class Score
+class NoteScore
   def pack
-    packed_start_meter = start_meter.to_s
-    packed_mcs = Hash[ meter_changes.map do |offset,change|
+    packed_starttempo = start_tempo.to_s
+    packed_tcs = Hash[ tempo_changes.map do |offset,change|
       a = change.pack
       a[0] = a[0].to_s
       [offset,a]
     end ]
 
-    packed_tcs = Hash[ tempo_changes.map do |k,v|
-      [k,v.to_ary]
-    end ]
-
     packed_parts = Hash[
       @parts.map do |name,part|
         [ name, part.pack ]
@@ -21,9 +17,7 @@ class Score
     ]
     packed_prog = program.pack
     
-    { "start_meter" => packed_start_meter,
-      "meter_changes" => packed_mcs,
-      "start_tempo" => start_tempo,
+    { "start_tempo" => packed_starttempo,
       "tempo_changes" => packed_tcs,
       "program" => packed_prog,
       "parts" => packed_parts,
@@ -31,27 +25,24 @@ class Score
   end
   
   def self.unpack packing
-    unpacked_start_meter = Parsing::meter(packing["start_meter"])
-    unpacked_mcs = Hash[ packing["meter_changes"].map do |k,v|
+    unpacked_starttempo = Tempo.parse(packing["start_tempo"])
+    unpacked_tcs = Hash[ packing["tempo_changes"].map do |k,v|
       v = v.clone
-      v[0] = Parsing::meter(v[0])
+      v[0] = Tempo.parse(v[0])
       [k, Change.from_ary(v) ]
     end ]
     
-    unpacked_tcs = Hash[ packing["tempo_changes"].map do |k,v|
-      [k, Change.from_ary(v)]
-    end ]
-    
     unpacked_parts = Hash[ packing["parts"].map do |name,packed|
       [name, Part.unpack(packed)]
     end ]
     
     unpacked_prog = Program.unpack packing["program"]
     
-    new(unpacked_start_meter, packing["start_tempo"],
-      meter_changes: unpacked_mcs, tempo_changes: unpacked_tcs,
-      program: unpacked_prog, parts: unpacked_parts
-    )    
+    new(unpacked_starttempo,
+      tempo_changes: unpacked_tcs,
+      program: unpacked_prog,
+      parts: unpacked_parts
+    )
   end
 end