music-transcription 0.8.1 → 0.9.0

data/examples/song2.yml

@@ -7,65 +7,80 @@ start_meter: !ruby/object:Music::Transcription::Meter
   measure_duration: !ruby/object:Rational
     denominator: 1
     numerator: 1
+  check_methods:
+  - :check_beats_per_measure
+  - :check_beat_duration
 start_tempo: 120
 meter_changes: {}
 tempo_changes: {}
 parts:
   1: !ruby/object:Music::Transcription::Part
     notes:
-    - !ruby/object:Music::Transcription::Note::Whole
-      duration: !ruby/object:Rational
+    - !ruby/object:Music::Transcription::Note
+      duration: &1 !ruby/object:Rational
         denominator: 1
         numerator: 1
       pitches:
       - !ruby/object:Music::Transcription::Pitch
         octave: 4
         semitone: 0
+      articulation: :normal
+      accented: false
       links: {}
-      accent: &1 !ruby/class 'Music::Transcription::Accent::None'
-    - !ruby/object:Music::Transcription::Note::Whole
-      duration: !ruby/object:Rational
-        denominator: 1
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *1
       pitches:
-      - &2 !ruby/object:Music::Transcription::Pitch
+      - &3 !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 10
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Whole
-      duration: !ruby/object:Rational
-        denominator: 1
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *1
       pitches:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 8
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Half
-      duration: !ruby/object:Rational
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: &2 !ruby/object:Rational
         denominator: 2
         numerator: 1
       pitches:
       - !ruby/object:Music::Transcription::Pitch
         octave: 3
         semitone: 7
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Half
-      duration: !ruby/object:Rational
-        denominator: 2
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *2
       pitches:
-      - *2
+      - *3
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    start_dynamic: &5 !ruby/object:Music::Transcription::Dynamic::MezzoForte {}
+      check_methods:
+      - :ensure_positive_duration
+    start_dynamic: 0.625
     dynamic_changes: {}
+    check_methods:
+    - :ensure_start_dynamic
+    - :ensure_dynamic_change_values_range
   2: !ruby/object:Music::Transcription::Part
     notes:
-    - !ruby/object:Music::Transcription::Note::DottedQuarter
+    - !ruby/object:Music::Transcription::Note
       duration: !ruby/object:Rational
         denominator: 8
         numerator: 3
@@ -73,156 +88,188 @@ parts:
       - !ruby/object:Music::Transcription::Pitch
         octave: 5
         semitone: 4
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Whole
-      duration: !ruby/object:Rational
-        denominator: 1
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *1
       pitches:
-      - &4 !ruby/object:Music::Transcription::Pitch
+      - &5 !ruby/object:Music::Transcription::Pitch
         octave: 5
         semitone: 2
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Whole
-      duration: !ruby/object:Rational
-        denominator: 1
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *1
       pitches:
-      - &3 !ruby/object:Music::Transcription::Pitch
+      - &4 !ruby/object:Music::Transcription::Pitch
         octave: 5
         semitone: 0
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
+      check_methods:
+      - :ensure_positive_duration
     - !ruby/object:Music::Transcription::Note
       duration: !ruby/object:Rational
         denominator: 8
         numerator: 5
       pitches:
-      - *3
+      - *4
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Half
-      duration: !ruby/object:Rational
-        denominator: 2
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *2
       pitches:
-      - *3
+      - *4
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Half
-      duration: !ruby/object:Rational
-        denominator: 2
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *2
       pitches:
-      - *4
+      - *5
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    start_dynamic: *5
+      check_methods:
+      - :ensure_positive_duration
+    start_dynamic: 0.625
     dynamic_changes: {}
+    check_methods:
+    - :ensure_start_dynamic
+    - :ensure_dynamic_change_values_range
   3: !ruby/object:Music::Transcription::Part
     notes:
-    - !ruby/object:Music::Transcription::Note::Eighth
-      duration: !ruby/object:Rational
+    - !ruby/object:Music::Transcription::Note
+      duration: &9 !ruby/object:Rational
         denominator: 8
         numerator: 1
       pitches: []
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Quarter
-      duration: !ruby/object:Rational
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: &6 !ruby/object:Rational
         denominator: 4
         numerator: 1
       pitches:
       - !ruby/object:Music::Transcription::Pitch
         octave: 5
         semitone: 7
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Half
-      duration: !ruby/object:Rational
-        denominator: 2
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *2
       pitches:
-      - &6 !ruby/object:Music::Transcription::Pitch
+      - &7 !ruby/object:Music::Transcription::Pitch
         octave: 5
         semitone: 5
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Quarter
-      duration: !ruby/object:Rational
-        denominator: 4
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *6
       pitches: []
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Quarter
-      duration: !ruby/object:Rational
-        denominator: 4
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *6
       pitches:
-      - *6
+      - *7
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Half
-      duration: !ruby/object:Rational
-        denominator: 2
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *2
       pitches:
-      - &7 !ruby/object:Music::Transcription::Pitch
+      - &8 !ruby/object:Music::Transcription::Pitch
         octave: 5
         semitone: 3
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Quarter
-      duration: !ruby/object:Rational
-        denominator: 4
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *6
       pitches: []
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Quarter
-      duration: !ruby/object:Rational
-        denominator: 4
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *6
       pitches:
-      - *7
+      - *8
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Half
-      duration: !ruby/object:Rational
-        denominator: 2
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *2
       pitches:
-      - *7
+      - *8
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Eighth
-      duration: !ruby/object:Rational
-        denominator: 8
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *9
       pitches: []
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Half
-      duration: !ruby/object:Rational
-        denominator: 2
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *2
       pitches:
-      - *7
+      - *8
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    - !ruby/object:Music::Transcription::Note::Half
-      duration: !ruby/object:Rational
-        denominator: 2
-        numerator: 1
+      check_methods:
+      - :ensure_positive_duration
+    - !ruby/object:Music::Transcription::Note
+      duration: *2
       pitches:
-      - *6
+      - *7
+      articulation: :normal
+      accented: false
       links: {}
-      accent: *1
-    start_dynamic: *5
+      check_methods:
+      - :ensure_positive_duration
+    start_dynamic: 0.625
     dynamic_changes: {}
+    check_methods:
+    - :ensure_start_dynamic
+    - :ensure_dynamic_change_values_range
 program: !ruby/object:Music::Transcription::Program
   segments:
     :segments:
@@ -234,3 +281,10 @@ program: !ruby/object:Music::Transcription::Program
       begin: 0
       end: 4.0
       excl: true
+  check_methods:
+  - :ensure_increasing_segments
+  - :ensure_nonnegative_segments
+check_methods:
+- :check_start_tempo
+- :check_tempo_changes
+- :check_meter_changes

data/lib/music-transcription/articulations.rb

@@ -3,14 +3,12 @@ module Transcription
 
 module Articulations
   NORMAL = :normal
+  SLUR = :slur
+  LEGATO = :legato
+  TENUTO = :tenuto
+  PORTATO = :portato
   STACCATO = :staccato
   STACCATISSIMO = :staccatissimo
-  TENUTO = :tenuto
-  ACCENTED = :accented
-  ACCENTED_STACCATO = :accented_staccato
-  HAMMERED = ACCENTED_STACCATO
-  ACCENTED_TENUTO = :accented_tenuto
-  ACCENTED_STACCATISSIMO = :accented_staccatissimo
 end
 
 end

data/lib/music-transcription/link.rb

@@ -7,32 +7,34 @@ module Transcription
 #   @return [Pitch] The pitch of the note which is being connected to.
 #
 class Link
-  attr_accessor :target_pitch
-  
-  def initialize target_pitch
-    @target_pitch = target_pitch
+  def clone
+    Marshal.load(Marshal.dump(self))
   end
 
-  def ==(other)
-    self.class == other.class && self.target_pitch == other.target_pitch
-  end
-  
-  def clone
-    self.class.new @target_pitch.clone
+  class Tie < Link
+    def initialize; end
+    
+    def ==(other)
+      self.class == other.class
+    end
   end
   
-  [ :Slur,
-    :Legato,
-    :Glissando,
-    :Portamento,
-  ].each do |name|
-    klass = Class.new(Link) do
-      def initialize target_pitch
-        super(target_pitch)
-      end
+  class TargetedLink < Link
+    attr_accessor :target_pitch
+    
+    def initialize target_pitch
+      @target_pitch = target_pitch
+    end
+    
+    def ==(other)
+      self.class == other.class && @target_pitch == other.target_pitch
     end
-    Link.const_set(name.to_sym, klass)
   end
+  
+  class Glissando < TargetedLink; end
+  class Portamento < TargetedLink; end
+  class SlurGuide < TargetedLink; end
+  class LegatoGuide < TargetedLink; end
 end
 
 end

data/lib/music-transcription/note.rb

@@ -7,16 +7,16 @@ class Note
   include Validatable
   
   attr_reader :pitches, :links
-  attr_accessor :articulation, :duration
+  attr_accessor :articulation, :duration, :accented
 
   DEFAULT_ARTICULATION = Articulations::NORMAL
   
-  def initialize duration, pitches = [], links: {}, articulation: DEFAULT_ARTICULATION
-    self.duration = duration
-    @pitches = Set.new(pitches).sort
-    @links = links
+  def initialize duration, pitches = [], articulation: DEFAULT_ARTICULATION, accented: false, links: {}
     @duration = duration
+    @pitches = Set.new(pitches).sort
     @articulation = articulation
+    @accented = accented
+    @links = links
     
     @check_methods = [ :ensure_positive_duration ]
   end
@@ -31,7 +31,8 @@ class Note
     return (@duration == other.duration) &&
     (self.pitches == other.pitches) &&
     (@links.to_a.sort == other.links.to_a.sort) &&
-    (@articulation == other.articulation)
+    (@articulation == other.articulation) &&
+    (@accented == other.accented)
   end
   
   def clone
@@ -67,8 +68,8 @@ class Note
   end
 
   def self.add_note_method(name, dur)
-    self.class.send(:define_method,name.to_sym) do |pitches = [], articulation: DEFAULT_ARTICULATION, links: {}|
-      Note.new(dur, pitches, articulation: articulation, links: links)
+    self.class.send(:define_method,name.to_sym) do |pitches = [], articulation: DEFAULT_ARTICULATION, links: {}, accented: false|
+      Note.new(dur, pitches, articulation: articulation, links: links, accented: accented)
     end
   end
   

data/lib/music-transcription/version.rb

@@ -2,6 +2,6 @@
 module Music
 module Transcription
   # music-transcription version
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end
 end

data/spec/link_spec.rb

@@ -1,41 +1,98 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe Link do
-  context '#initialize' do
+describe Link::Glissando do
+  describe '#initialize' do
     it 'should assign the given pitch to :target_pitch' do
-      Link.new(C2).target_pitch.should eq(C2)
+      Link::Glissando.new(C2).target_pitch.should eq(C2)
     end
   end
+  
+  describe '#==' do
+    it 'should return true if two links have the same target pitch' do
+      Link::Glissando.new(C2).should eq(Link::Glissando.new(C2))
+    end
     
+    it 'should return false if two links do not have the same target pitch' do
+      Link::Glissando.new(C2).should_not eq(Link::Glissando.new(F5))
+    end
+    
+    it 'should return false if the link type is different' do
+      Link::Glissando.new(C2).should_not eq(Link::Portamento.new(D2))
+    end
+  end
+  
+  describe '#clone' do
+    it 'should return a link equal to original' do
+      l = Link::Glissando.new(C4)
+      l.clone.should eq l
+    end
+  end
+  
+  describe '#to_yaml' do
+    it 'should produce YAML that can be loaded' do
+      l = Link::Glissando.new(C5)
+      YAML.load(l.to_yaml).should eq l
+    end
+  end
+end
+  
+describe Link::Portamento do
+  describe '#initialize' do
+    it 'should assign the given pitch to :target_pitch' do
+      Link::Portamento.new(C2).target_pitch.should eq(C2)
+    end
+  end
+  
   describe '#==' do
     it 'should return true if two links have the same target pitch' do
-      Link.new(C2).should eq(Link.new(C2))
+      Link::Portamento.new(C2).should eq(Link::Portamento.new(C2))
     end
     
     it 'should return false if two links do not have the same target pitch' do
-      Link.new(C2).should_not eq(Link.new(F5))
+      Link::Portamento.new(C2).should_not eq(Link::Portamento.new(F5))
     end
     
     it 'should return false if the link type is different' do
-      Link::Slur.new(C2).should_not eq(Link::Legato.new(D2))
+      Link::Portamento.new(C2).should_not eq(Link::Glissando.new(D2))
     end
   end
   
   describe '#clone' do
-    it 'should return a link with the same target pitch' do
-      l = Link.new(C4)
-      l.clone.target_pitch.should eq(C4)
+    it 'should return a link equal to original' do
+      l = Link::Portamento.new(C4)
+      l.clone.should eq l
+    end
+  end
+  
+  describe '#to_yaml' do
+    it 'should produce YAML that can be loaded' do
+      l = Link::Portamento.new(C5)
+      YAML.load(l.to_yaml).should eq l
+    end
+  end
+end
+
+describe Link::Tie do
+  describe '#==' do
+    it 'should return true if another Tie object is given' do
+      Link::Tie.new.should eq(Link::Tie.new)
     end
     
-    it 'should return a link with the same class' do
-      l = Link::Slur.new(Eb2)
-      l.clone.class.should eq(Link::Slur)
+    it 'should return false if a non-Tie object is given' do
+      Link::Tie.new.should_not eq(Link::Portamento.new(C2))
+    end
+  end
+  
+  describe '#clone' do
+    it 'should return a link equal to original' do
+      l = Link::Tie.new
+      l.clone.should eq l
     end
   end
   
   describe '#to_yaml' do
     it 'should produce YAML that can be loaded' do
-      l = Link::Slur.new(C5)
+      l = Link::Tie.new
       YAML.load(l.to_yaml).should eq l
     end
   end

data/spec/note_spec.rb

@@ -7,13 +7,23 @@ describe Note do
   
   describe '.new' do
     it 'should assign :duration that is given during construction' do
-      note = Note.new 2
-      note.duration.should eq(2)
+      Note.new(2).duration.should eq(2)
+    end
+
+    it "should assign :articulation to Note::DEFAULT_ARTICULATION if not given" do
+      Note.new(2).articulation.should eq(Note::DEFAULT_ARTICULATION)
     end
     
     it "should assign :articulation parameter if given during construction" do
-      note = Note.new 2, articulation: STACCATO
-      note.articulation.should eq(STACCATO)
+      Note.new(2, articulation: STACCATO).articulation.should eq(STACCATO)
+    end
+    
+    it 'should assign :accented to false if not given' do
+      Note.new(2).accented.should be false
+    end
+    
+    it 'should assign :accented if given' do
+      Note.new(2, accented: true).accented.should be true
     end
     
     it 'should have no pitches if not given' do
@@ -57,7 +67,7 @@ describe Note do
   describe '#transpose!' do
     context 'given pitch diff' do
       before(:all) do
-        @note = Note::quarter([C2,F2], links:{C2=>Link::Slur.new(D2)})
+        @note = Note::quarter([C2,F2], links:{C2=>Link::Glissando.new(D2)})
         @diff = Pitch.new(semitone: 4)
         @note.transpose! @diff
       end
@@ -116,7 +126,7 @@ describe Note do
       n = Note.new(1,[C2], articulation: STACCATO)
       YAML.load(n.to_yaml).should eq n
       
-      n = Note.new(1,[E2], links: {E2 => Link::Legato.new(F2)})
+      n = Note.new(1,[E2], links: {E2 => Link::Portamento.new(F2)})
       YAML.load(n.to_yaml).should eq n
     end
   end