musicality 0.8.0 → 0.9.0

data/lib/musicality/notation/model/part.rb

@@ -1,17 +1,20 @@
-require 'yaml'
-
 module Musicality
 
 class Part
+  include Packable
   include Validatable
   
-  attr_accessor :start_dynamic, :dynamic_changes, :notes
+  special_packing(:notes) {|notes| notes.map {|n| n.to_s }.join(" ") }
+  special_unpacking(:notes) {|notes_str| Note.split_parse(notes_str) }
+
+  attr_accessor :start_dynamic, :dynamic_changes, :notes, :settings
   
-  def initialize start_dynamic, notes: [], dynamic_changes: {}
+  def initialize start_dynamic, notes: [], dynamic_changes: {}, settings: []
     @notes = notes
     @start_dynamic = start_dynamic
     @dynamic_changes = dynamic_changes
-    
+    @settings = settings
+
     yield(self) if block_given?
   end
   
@@ -49,6 +52,16 @@ class Part
       raise RangeError, "dynamic change values #{outofrange} are not between 0 and 1"
     end
   end
+
+  def transpose interval
+    p = self.clone
+    p.notes.each {|n| n.transpose!(interval) }
+    return p
+  end
+
+  def find_settings settings_class
+    settings.find {|s| s.is_a? settings_class }
+  end
 end
 
 end

data/lib/musicality/notation/model/pitch.rb

@@ -19,11 +19,13 @@ module Musicality
 #
 class Pitch
   include Comparable
+  include Packable
+  
   attr_reader :octave, :semitone, :cent, :total_cents
 
   #The default number of semitones per octave is 12, corresponding to
   # the twelve-tone equal temperment tuning system.
-  SEMITONES_PER_OCTAVE = 12
+  SEMITONES_PER_OCTAVE = PitchClass::MOD
   CENTS_PER_SEMITONE = 100
   CENTS_PER_OCTAVE = SEMITONES_PER_OCTAVE * CENTS_PER_SEMITONE
 
@@ -116,8 +118,12 @@ class Pitch
     Pitch.new(cent: @total_cents)
   end
 
-  def to_s(sharpit = false)
-    letter = case semitone
+  def natural?
+    [0,2,4,5,7,9,11].include?(semitone)
+  end
+
+  def self.pc_str semitone, sharpit
+    case semitone
     when 0 then "C"
     when 1 then sharpit  ? "C#" : "Db"
     when 2 then "D"
@@ -131,7 +137,10 @@ class Pitch
     when 10 then sharpit  ? "A#" : "Bb"
     when 11 then "B"
     end
-    
+  end
+
+  def to_s(sharpit = false)
+    letter = Pitch.pc_str(semitone, sharpit)
     if @cent == 0
       return letter + octave.to_s
     elsif @cent > 0

data/lib/musicality/notation/model/score.rb

@@ -1,8 +1,16 @@
 module Musicality
 
 class Score
+  include Packable
   include Validatable
-  attr_accessor :parts, :program
+
+  special_packing(:program){|p| p.map {|range| range.to_s }}
+  special_unpacking(:program){|p| p.map {|str| parse_numeric_range(str) }}
+  
+  special_packing(:sections){|s| Hash[ s.map {|name,range| [name,range.to_s] } ]}
+  special_unpacking(:sections){|s| Hash[ s.map {|name,str| [name,parse_numeric_range(str)] } ]}
+
+  attr_accessor :parts, :sections, :program, :start_key, :key_changes
   attr_writer :title, :composer
   
   def title value = nil
@@ -20,25 +28,33 @@ class Score
       @composer = value
     end
   end
-  
-  def initialize parts: {}, program: [], title: nil, composer: nil, sections: {}
+
+  def initialize parts: {}, program: [], title: nil, composer: nil, sections: {}, start_key: Keys::C_MAJOR, key_changes: {}
     @parts = parts
     @program = program
     @title = title
     @composer = composer
     @sections = sections
+    @start_key = start_key
+    @key_changes = key_changes
     yield(self) if block_given?
   end
 
   def validatables; @parts.values; end
-  def check_methods; [:check_program, :check_parts ]; end
+  def check_methods
+    [:check_program, :check_parts, :check_start_key, :check_key_changes ]
+  end
   
   def clone
     Marshal.load(Marshal.dump(self))
   end
   
   def ==(other)
-    return @parts == other.parts && @program == other.program
+    return self.class == other.class &&
+      @parts == other.parts && @program == other.program &&
+      @program == other.program && @sections == other.sections &&
+      @title == other.title && @composer == other.composer &&
+      @start_key == other.start_key && @key_changes == other.key_changes
   end
   
   def max_part_duration
@@ -55,72 +71,24 @@ class Score
     end
     alias duration seconds_long
   end
-  
-  class TempoBased < Score
-    attr_accessor :start_tempo, :tempo_changes
+
+  # Tempo-based score with meter, bar lines, and a fixed pulse (beat).
+  # Offsets are measure-based, and tempo values are in beats-per-minute.
+  class Tempo < Score
+    attr_accessor :start_tempo, :tempo_changes, :start_meter, :meter_changes
 
     # See Score#initialize for remaining kwargs
-    def initialize start_tempo, tempo_changes: {}, **kwargs
+    def initialize start_meter, start_tempo, tempo_changes: {}, meter_changes: {}, parts: {}, program: [], title: nil, composer: nil, sections: {}, start_key: Keys::C_MAJOR, key_changes: {}
       @start_tempo = start_tempo
       @tempo_changes = tempo_changes
-      super(**kwargs)
-    end
-    
-    def check_methods
-      super() + [:check_start_tempo, :check_tempo_changes]
-    end
-  
-    def ==(other)
-      return super(other) && @start_tempo == other.start_tempo &&
-      @tempo_changes == other.tempo_changes
-    end
-    
-    def notes_long
-      max_part_duration
-    end
-    
-    private
-    
-    def check_start_tempo
-      if @start_tempo <= 0
-        raise NonPositiveError, "Start tempo (#{@start_tempo}) is not positive"
-      end
-    end
-    
-    def check_tempo_changes
-      badtypes = @tempo_changes.select {|k,v| !v.end_value.is_a?(Numeric) }
-      if badtypes.any?
-        raise TypeError, "Found non-numeric tempo change values: #{badtypes}"
-      end
-      
-      badvalues = @tempo_changes.select {|k,v| v.end_value <= 0 }
-      if badvalues.any?
-        raise NonPositiveError, "Found non-positive tempo changes values: #{badvalues}"
-      end    
-    end
-  end
-  
-  # Tempo-based score without meter, bar lines, or fixed pulse (beat).
-  # Offsets are note-based, and tempo values are in quarter-notes-per-minute.
-  class Unmeasured < Score::TempoBased
-    alias duration notes_long
-  end
-  
-  # Tempo-based score with meter, bar lines, and a fixed pulse (beat).
-  # Offsets are measure-based, and tempo values are in beats-per-minute.
-  class Measured < Score::TempoBased
-    attr_accessor :start_meter, :meter_changes
-    
-    # See Score::TempoBased#initialize for remaining kwargs
-    def initialize start_meter, start_tempo, meter_changes: {}, **kwargs
       @start_meter = start_meter
       @meter_changes = meter_changes
       
-      super(start_tempo, **kwargs)
+      super(parts: parts, program: program, title: title, composer: composer, sections: sections, start_key: start_key, key_changes: key_changes)
     end
     
     def check_methods
-      super() + [:check_start_meter, :check_meter_changes]
+      super() + [:check_start_tempo, :check_tempo_changes, :check_start_meter, :check_meter_changes]
     end
     
     def validatables
@@ -128,10 +96,17 @@ class Score
     end
     
     def ==(other)
-      return super(other) && @start_meter == other.start_meter &&
-        @meter_changes == other.meter_changes
+      return super(other) &&
+      @start_tempo == other.start_tempo &&
+      @tempo_changes == other.tempo_changes
+      @start_meter == other.start_meter &&
+      @meter_changes == other.meter_changes
     end
     
+    def notes_long
+      max_part_duration
+    end
+
     def measures_long note_dur = self.notes_long
       noff_end = note_dur
       noff_prev = 0.to_r
@@ -157,6 +132,24 @@ class Score
     
     private
     
+    def check_start_tempo
+      if @start_tempo <= 0
+        raise NonPositiveError, "Start tempo (#{@start_tempo}) is not positive"
+      end
+    end
+    
+    def check_tempo_changes
+      badtypes = @tempo_changes.select {|k,v| !v.end_value.is_a?(Numeric) }
+      if badtypes.any?
+        raise TypeError, "Found non-numeric tempo change values: #{badtypes}"
+      end
+      
+      badvalues = @tempo_changes.select {|k,v| v.end_value <= 0 }
+      if badvalues.any?
+        raise NonPositiveError, "Found non-positive tempo changes values: #{badvalues}"
+      end    
+    end
+
     def check_start_meter
       unless @start_meter.is_a? Meter
         raise TypeError, "Start meter #{@start_meter} is not a Meter object"
@@ -166,14 +159,14 @@ class Score
     def check_meter_changes
       badtypes = @meter_changes.select {|k,v| !v.end_value.is_a?(Meter) }
       if badtypes.any?
-        raise TypeError, "Found meter change values that are not Meter objects: #{nonmeter_values}"
+        raise TypeError, "Found meter change values that are not Meter objects: #{badtypes}"
       end
-      
+
       badoffsets = @meter_changes.select {|k,v| k != k.to_i }
       if badoffsets.any?
         raise NonIntegerError, "Found meter changes at non-integer offsets: #{badoffsets}"
       end
-      
+
       nonzero_duration = @meter_changes.select {|k,v| !v.is_a?(Change::Immediate) }
       if nonzero_duration.any?
         raise NonZeroError, "Found meter changes that are not immediate: #{nonzero_duration}"
@@ -206,6 +199,51 @@ class Score
       raise TypeError, "Non-Part part value(s) found: #{non_parts}"
     end
   end
+
+  def check_start_key
+    unless @start_key.is_a? Key
+      raise TypeError, "Start key #{@start_key} is not a Key object"
+    end
+  end
+  
+  def check_key_changes
+    badtypes = @key_changes.select {|k,v| !v.end_value.is_a?(Key) }
+    if badtypes.any?
+      raise TypeError, "Found key change values that are not Key objects: #{badtypes}"
+    end
+    
+    badoffsets = @key_changes.select {|k,v| k != k.to_i }
+    if badoffsets.any?
+      raise NonIntegerError, "Found key changes at non-integer offsets: #{badoffsets}"
+    end
+
+    nonzero_duration = @key_changes.select {|k,v| !v.is_a?(Change::Immediate) }
+    if nonzero_duration.any?
+      raise NonZeroError, "Found key changes that are not immediate: #{nonzero_duration}"
+    end
+  end
+
+  private
+
+  def self.parse_numeric str
+    if str.include? "."
+      str.to_f
+    elsif str.include? "/"
+      str.to_r
+    else
+      str.to_i
+    end
+  end
+
+  def self.parse_numeric_range str
+    result = str.match /(\d+([\.\/]\d+)?)([\.]{2,3})(\d+([\.\/]\d+)?)/
+    raise ArgumentError, "string #{str} is not a numeric range" if result.nil?
+    
+    dots = result.values_at(3)
+    l_num = parse_numeric(result.values_at(1)[0])
+    r_num = parse_numeric(result.values_at(4)[0])
+    Range.new l_num, r_num, dots.size == 3
+  end
 end
 
 end

data/lib/musicality/notation/model/symbols.rb

@@ -1,22 +1,27 @@
 module Musicality
 
+# These symbols all need to match the notation parsers
+
 ARTICULATION_SYMBOLS = {
-  Articulations::SLUR => "(",
-  Articulations::LEGATO => "[",
-  Articulations::TENUTO => "_",
-  Articulations::PORTATO => "%",
+  Articulations::TENUTO => "-",
+  Articulations::ACCENT => ">",
+  Articulations::MARCATO => "^",
+  Articulations::PORTATO => "_",
   Articulations::STACCATO => ".",
-  Articulations::STACCATISSIMO => "'"
+  Articulations::STACCATISSIMO => "!",
 }
 
 LINK_SYMBOLS = {
-  Links::TIE => "=",
-  Links::GLISSANDO => "~",
-  Links::PORTAMENTO => "|",
-  Links::SLUR => ARTICULATION_SYMBOLS[Articulations::SLUR],
-  Links::LEGATO => ARTICULATION_SYMBOLS[Articulations::LEGATO],
+  Link::Tie => "~",
+  Link::Glissando => ";",
+  Link::Portamento => ":",
 }
 
-ACCENT_SYMBOL = "!"
+MARK_SYMBOLS = {
+  Mark::Slur::Begin => "(",
+  Mark::Slur::End => ")",
+  Mark::Triplet::Begin => "[",
+  Mark::Triplet::End => "]",
+}
 
 end

data/lib/musicality/notation/parsing/articulation_parsing.rb

@@ -23,17 +23,17 @@ module Articulation
     end
 
     i0 = index
-    r1 = _nt_slur
+    r1 = _nt_tenuto
     if r1
       r1 = SyntaxNode.new(input, (index-1)...index) if r1 == true
       r0 = r1
     else
-      r2 = _nt_legato
+      r2 = _nt_accent
       if r2
         r2 = SyntaxNode.new(input, (index-1)...index) if r2 == true
         r0 = r2
       else
-        r3 = _nt_tenuto
+        r3 = _nt_marcato
         if r3
           r3 = SyntaxNode.new(input, (index-1)...index) if r3 == true
           r0 = r3
@@ -67,95 +67,95 @@ module Articulation
     r0
   end
 
-  module Slur0
+  module Tenuto0
     def to_articulation
-      Musicality::Articulations::SLUR
+      Musicality::Articulations::TENUTO
     end
   end
 
-  def _nt_slur
+  def _nt_tenuto
     start_index = index
-    if node_cache[:slur].has_key?(index)
-      cached = node_cache[:slur][index]
+    if node_cache[:tenuto].has_key?(index)
+      cached = node_cache[:tenuto][index]
       if cached
-        node_cache[:slur][index] = cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+        node_cache[:tenuto][index] = cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
         @index = cached.interval.end
       end
       return cached
     end
 
-    if (match_len = has_terminal?("(", false, index))
+    if (match_len = has_terminal?("-", false, index))
       r0 = instantiate_node(SyntaxNode,input, index...(index + match_len))
-      r0.extend(Slur0)
+      r0.extend(Tenuto0)
       @index += match_len
     else
-      terminal_parse_failure("(")
+      terminal_parse_failure('"-"')
       r0 = nil
     end
 
-    node_cache[:slur][start_index] = r0
+    node_cache[:tenuto][start_index] = r0
 
     r0
   end
 
-  module Legato0
+  module Accent0
     def to_articulation
-      Musicality::Articulations::LEGATO
+      Musicality::Articulations::ACCENT
     end
   end
 
-  def _nt_legato
+  def _nt_accent
     start_index = index
-    if node_cache[:legato].has_key?(index)
-      cached = node_cache[:legato][index]
+    if node_cache[:accent].has_key?(index)
+      cached = node_cache[:accent][index]
       if cached
-        node_cache[:legato][index] = cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+        node_cache[:accent][index] = cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
         @index = cached.interval.end
       end
       return cached
     end
 
-    if (match_len = has_terminal?("[", false, index))
+    if (match_len = has_terminal?(">", false, index))
       r0 = instantiate_node(SyntaxNode,input, index...(index + match_len))
-      r0.extend(Legato0)
+      r0.extend(Accent0)
       @index += match_len
     else
-      terminal_parse_failure("[")
+      terminal_parse_failure('">"')
       r0 = nil
     end
 
-    node_cache[:legato][start_index] = r0
+    node_cache[:accent][start_index] = r0
 
     r0
   end
 
-  module Tenuto0
+  module Marcato0
     def to_articulation
-      Musicality::Articulations::TENUTO
+      Musicality::Articulations::MARCATO
     end
   end
 
-  def _nt_tenuto
+  def _nt_marcato
     start_index = index
-    if node_cache[:tenuto].has_key?(index)
-      cached = node_cache[:tenuto][index]
+    if node_cache[:marcato].has_key?(index)
+      cached = node_cache[:marcato][index]
       if cached
-        node_cache[:tenuto][index] = cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
+        node_cache[:marcato][index] = cached = SyntaxNode.new(input, index...(index + 1)) if cached == true
         @index = cached.interval.end
       end
       return cached
     end
 
-    if (match_len = has_terminal?("_", false, index))
+    if (match_len = has_terminal?("^", false, index))
       r0 = instantiate_node(SyntaxNode,input, index...(index + match_len))
-      r0.extend(Tenuto0)
+      r0.extend(Marcato0)
       @index += match_len
     else
-      terminal_parse_failure("_")
+      terminal_parse_failure('"^"')
       r0 = nil
     end
 
-    node_cache[:tenuto][start_index] = r0
+    node_cache[:marcato][start_index] = r0
 
     r0
   end
@@ -177,12 +177,12 @@ module Articulation
       return cached
     end
 
-    if (match_len = has_terminal?("%", false, index))
+    if (match_len = has_terminal?("_", false, index))
       r0 = instantiate_node(SyntaxNode,input, index...(index + match_len))
       r0.extend(Portato0)
       @index += match_len
     else
-      terminal_parse_failure("%")
+      terminal_parse_failure('"_"')
       r0 = nil
     end
 
@@ -213,7 +213,7 @@ module Articulation
       r0.extend(Staccato0)
       @index += match_len
     else
-      terminal_parse_failure(".")
+      terminal_parse_failure('"."')
       r0 = nil
     end
 
@@ -239,12 +239,12 @@ module Articulation
       return cached
     end
 
-    if (match_len = has_terminal?("'", false, index))
+    if (match_len = has_terminal?("!", false, index))
       r0 = instantiate_node(SyntaxNode,input, index...(index + match_len))
       r0.extend(Staccatissimo0)
       @index += match_len
     else
-      terminal_parse_failure("'")
+      terminal_parse_failure('"!"')
       r0 = nil
     end