music-transcription 0.7.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bbc3d1440e2ac88166f035060fda110df18aeb5
-  data.tar.gz: 53b0c934d092ca5a176a481b1a00a532e4201ea7
+  metadata.gz: 2821d70c7615da2fa7bb4e67bd8920faeeeffb53
+  data.tar.gz: 6dc0c2d04dcc3ea530f91a182d3978d6acee9176
 SHA512:
-  metadata.gz: ec1b59468978c4561be944b5c4f61f892399e34a72f5bc790037f3c67f297e64ae7d625a1a69a7cb967239fc20e432d5d2aebe1d9358d792d56cc573747b05a4
-  data.tar.gz: 5bd9cd9b7dd02043d28c94ca569ecef5ae1e0ae5dd1990a4dff20ce6aaf0207fb94811805bfc37c5abf0eede7afbce6fc8963c731abf4327da3347af46b7b3c7
+  metadata.gz: a8fb5105567403e4e8de4708fab50c55db5bb5a2b47a3d2de5a0463a4d9017185e58ed424ab19c1112099c738994aa6962f8c4bbc68cdd4f7cac9181f29209c1
+  data.tar.gz: 69675371f0024504bdf343810cea94f0fb818ac4a348347b67ea6a2dd3e875dd8bdbb665314e02a3aab4725f27064685b002d4f2d9e6cb1215c2f99be5b8254a

data/lib/music-transcription.rb

@@ -7,11 +7,10 @@ require 'music-transcription/errors'
 require 'music-transcription/pitch'
 require 'music-transcription/pitches'
 require 'music-transcription/link'
-require 'music-transcription/accent'
-require 'music-transcription/accents'
-require 'music-transcription/change'
+require 'music-transcription/articulations'
 require 'music-transcription/note'
 require 'music-transcription/dynamics'
+require 'music-transcription/change'
 require 'music-transcription/part'
 require 'music-transcription/program'
 require 'music-transcription/tempo'

data/lib/music-transcription/articulations.rb

@@ -0,0 +1,16 @@
+module Music
+module Transcription
+
+module Articulations
+  NORMAL = :normal
+  STACCATO = :staccato
+  STACCATISSIMO = :staccatissimo
+  TENUTO = :tenuto
+  ACCENTED = :accented
+  HAMMERED = :hammered
+  ACCENTED_TENUTO = :accented_tenuto
+  ACCENTED_STACCATISSIMO = :accented_staccatissimo
+end
+
+end
+end

data/lib/music-transcription/change.rb

@@ -25,7 +25,7 @@ class Change
     
     def ensure_zero_duration
       unless @duration == 0
-        raise ValueNotZeroError, "immediate change duration #{self.duration} must be 0"
+        raise NonZeroError, "immediate change duration #{self.duration} must be 0"
       end
     end
   end
@@ -34,13 +34,13 @@ class Change
     include Validatable
     
     def initialize value, transition_duration
-      @check_methods = [ :ensure_positive_duration ]
+      @check_methods = [ :ensure_nonnegative_duration ]
       super(value, transition_duration)
     end
     
-    def ensure_positive_duration
+    def ensure_nonnegative_duration
       if @duration < 0
-        raise ValueNotPositiveError, "gradual change duration #{self.duration} must be >= 0"
+        raise NegativeError, "gradual change duration #{self.duration} must be non-negative"
       end
     end
   end

data/lib/music-transcription/errors.rb

@@ -1,10 +1,10 @@
 module Music
 module Transcription
-  class ValueNotPositiveError < StandardError; end
-  class ValueOutOfRangeError < StandardError; end
-  class ValueNotZeroError < StandardError; end
-  class NotPositiveIntegerError < StandardError; end
-  class SegmentNotIncreasingError < StandardError; end
-  class SegmentNegativeError < StandardError; end
+  class NonZeroError < StandardError; end
+  class NegativeError < StandardError; end
+  class NonPositiveError < StandardError; end
+  class NonIntegerError < StandardError; end
+  class NonRationalError < StandardError; end
+  class NonIncreasingError < StandardError; end
 end
 end

data/lib/music-transcription/link.rb

@@ -1,9 +1,7 @@
 module Music
 module Transcription
 
-# Defines a relationship (tie, slur, legato, etc.) to a note with a certain pitch.
-#
-# @author James Tunnell
+# Connect one note pitch to the target pitch of the next note, via slur, legato, etc.
 #
 # @!attribute [rw] target_pitch
 #   @return [Pitch] The pitch of the note which is being connected to.

data/lib/music-transcription/meter.rb

@@ -14,14 +14,22 @@ class Meter
   end
   
   def check_beats_per_measure
-    unless @beats_per_measure.is_a?(Integer) && @beats_per_measure > 0
-      raise NotPositiveIntegerError, "beats per measure #{@beats_per_measure} is not a positive integer"
+    unless @beats_per_measure > 0
+      raise NonPositiveError, "beats per measure #{@beats_per_measure} is not positive"
+    end
+    
+    unless @beats_per_measure.is_a?(Integer)
+      raise NonIntegerError, "beats per measure #{@beats_per_measure} is not an integer"
     end
   end
     
   def check_beat_duration
     unless @beat_duration > 0
-      raise ValueNotPositiveError, "beat duration #{@beat_duration} is not positive"
+      raise NonPositiveError, "beat duration #{@beat_duration} is not positive"
+    end
+    
+    unless @beat_duration > 0
+      raise NonRationalError, "beat duration #{@beat_duration} is a rational"
     end
   end
   

data/lib/music-transcription/note.rb

@@ -7,21 +7,23 @@ class Note
   include Validatable
   
   attr_reader :pitches, :links
-  attr_accessor :accent, :duration
+  attr_accessor :articulation, :duration
 
-  def initialize duration, pitches = [], links: {}, accent: Accents::NONE
+  DEFAULT_ARTICULATION = Articulations::NORMAL
+  
+  def initialize duration, pitches = [], links: {}, articulation: DEFAULT_ARTICULATION
     self.duration = duration
     @pitches = Set.new(pitches).sort
     @links = links
     @duration = duration
-    @accent = accent
+    @articulation = articulation
     
     @check_methods = [ :ensure_positive_duration ]
   end
   
   def ensure_positive_duration
     unless @duration > 0
-      raise ValueNotPositiveError, "duration #{@duration} is not positive"
+      raise NonPositiveError, "duration #{@duration} is not positive"
     end
   end
   
@@ -29,16 +31,12 @@ class Note
     return (@duration == other.duration) &&
     (self.pitches == other.pitches) &&
     (@links.to_a.sort == other.links.to_a.sort) &&
-    (@accent == other.accent)
+    (@articulation == other.articulation)
   end
   
   def clone
     Marshal.load(Marshal.dump(self))
   end
-  
-  def clear_links
-    @links = {}
-  end
 
   def transpose diff
     self.clone.transpose! diff
@@ -67,59 +65,25 @@ class Note
     @duration *= ratio
     return self
   end
-  
-  class Sixteenth < Note
-    def initialize pitches = [], links: {}, accent: Accents::NONE
-      super(Rational(1,16),pitches,links:links,accent:accent)
-    end
-  end
-  
-  class DottedSixteenth < Note
-    def initialize pitches = [], links: {}, accent: Accents::NONE
-      super(Rational(3,32),pitches,links:links,accent:accent)
-    end
-  end
-  
-  class Eighth < Note
-    def initialize pitches = [], links: {}, accent: Accents::NONE
-      super(Rational(1,8),pitches,links:links,accent:accent)
-    end
-  end
-  
-  class DottedEighth < Note
-    def initialize pitches = [], links: {}, accent: Accents::NONE
-      super(Rational(3,16),pitches,links:links,accent:accent)
-    end
-  end
-  
-  class Quarter < Note
-    def initialize pitches = [], links: {}, accent: Accents::NONE
-      super(Rational(1,4),pitches,links:links,accent:accent)
-    end
-  end
-  
-  class DottedQuarter < Note
-    def initialize pitches = [], links: {}, accent: Accents::NONE
-      super(Rational(3,8),pitches,links:links,accent:accent)
-    end
-  end
-  
-  class Half < Note
-    def initialize pitches = [], links: {}, accent: Accents::NONE
-      super(Rational(1,2),pitches,links:links,accent:accent)
+
+  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)
     end
   end
   
-  class DottedHalf < Note
-    def initialize pitches = [], links: {}, accent: Accents::NONE
-      super(Rational(3,4),pitches,links:links,accent:accent)
-    end
-  end
-    
-  class Whole < Note
-    def initialize pitches = [], links: {}, accent: Accents::NONE
-      super(Rational(1,1),pitches,links:links,accent:accent)
-    end
+  {
+    :sixteenth => Rational(1,16),
+    :dotted_SIXTEENTH => Rational(3,32),
+    :eighth => Rational(1,8),
+    :dotted_eighth => Rational(3,16),
+    :quarter => Rational(1,4),
+    :dotted_quarter => Rational(3,8),
+    :half => Rational(1,2),
+    :dotted_half => Rational(3,4),
+    :whole => Rational(1),
+  }.each do |meth_name, dur|
+    add_note_method meth_name, dur
   end
 end
 

data/lib/music-transcription/part.rb

@@ -41,14 +41,6 @@ class Part
       raise RangeError, "start dynamic #{@start_dynamic} is not between 0 and 1"
     end
   end
-
-  #def ensure_dynamic_change_offsets
-  #  d = self.duration
-  #  outofrange = @dynamic_changes.keys.select {|k| !k.between?(0,d) }
-  #  if outofrange.any?
-  #    raise RangeError, "dynamic change offsets #{outofrange} are not between 0 and #{d}"
-  #  end
-  #end
   
   def ensure_dynamic_change_values_range
     outofrange = @dynamic_changes.values.select {|v| !v.value.between?(0,1) }

data/lib/music-transcription/pitch.rb

@@ -28,9 +28,7 @@ class Pitch
 
   # The base ferquency is C0
   BASE_FREQ = 16.351597831287414
-
-  # A new instance of Pitch.
-  # @raise [NonPositiveFrequencyError] if base_freq is not > 0.
+  
   def initialize octave:0, semitone:0
     @octave = octave
     @semitone = semitone
@@ -60,9 +58,11 @@ class Pitch
   
   # Set the Pitch ratio according to a total number of semitones.
   # @param [Fixnum] semitone The total number of semitones to use.
-  # @raise [ArgumentError] if semitone is not an Integer
+  # @raise [NonIntegerError] if semitone is not an Integer
   def total_semitone= semitone
-    raise ArgumentError, "semitone is not a Integer" if !semitone.is_a?(Integer)
+    unless semitone.is_a?(Integer)
+      raise NonIntegerError, "semitone #{semitone} is not a Integer"
+    end
     @octave, @semitone = 0, semitone
     normalize!
   end
@@ -76,9 +76,9 @@ class Pitch
 
   # Represent the Pitch ratio according to a ratio.
   # @param [Numeric] ratio The ratio to represent.
-  # @raise [RangeError] if ratio is less than or equal to 0.0
+  # @raise [NonPositiveError] unless ratio is > 0
   def ratio= ratio
-    raise RangeError, "ratio #{ratio} is less than or equal to 0.0" if ratio <= 0.0
+    raise NonPositiveError, "ratio #{ratio} is not > 0" unless ratio > 0
     
     x = Math.log2 ratio
     self.total_semitone = (x * SEMITONES_PER_OCTAVE).round
@@ -157,11 +157,9 @@ class Pitch
   end
   
   def self.make_from_semitone semitones
-    if semitones.is_a?(Integer)
-      return Pitch.new(semitone: semitones)
-    else
-      raise ArgumentError, "Cannot make Pitch from #{semitones}"
-    end
+    pitch = Pitch.new()
+    pitch.total_semitone = semitones
+    return pitch
   end
 end
 

data/lib/music-transcription/program.rb

@@ -39,14 +39,14 @@ class Program
   def ensure_increasing_segments
     non_increasing = @segments.select {|seg| seg.first >= seg.last }
     if non_increasing.any?
-      raise SegmentNotIncreasingError, "Non-increasing segments found #{non_increasing}"
+      raise NonIncreasingError, "Non-increasing segments found #{non_increasing}"
     end
   end
   
   def ensure_nonnegative_segments
     negative = @segments.select {|seg| seg.first < 0 || seg.last < 0 }
     if negative.any?
-      raise SegmentNegativeError, "Negative segments found #{negative}"
+      raise NegativeError, "Segments #{negative} have negative values"
     end
   end
 end

data/lib/music-transcription/score.rb

@@ -29,37 +29,21 @@ class Score
   
   def check_start_tempo
     unless @start_tempo > 0
-      raise ValueNotPositiveError, "start tempo #{@start_tempo} is not positive"
+      raise NonPositiveError, "start tempo #{@start_tempo} is not positive"
     end
   end
   
   def check_tempo_changes
-    negative = @tempo_changes.select {|k,v| v.value <= 0}
-    if negative.any?
-      raise ValueNotPositiveError, "tempo changes #{negative} are not positive"
+    not_positive = @tempo_changes.select {|k,v| v.value <= 0}
+    if not_positive.any?
+      raise NonPositiveError, "tempo changes #{not_positive} are not positive"
     end
   end
   
-  #def check_tempo_change_offsets
-  #  d = self.duration
-  #  outofrange = @tempo_changes.keys.select {|k| !k.between?(0,d) }
-  #  if outofrange.any?
-  #    raise RangeError, "tempo change offsets #{outofrange} are not between 0 and #{d}"
-  #  end
-  #end
-  #
-  #def check_meter_change_offsets
-  #  d = self.duration
-  #  outofrange = @meter_changes.keys.select {|k| !k.between?(0,d) }
-  #  if outofrange.any?
-  #    raise RangeError, "meter change offsets #{outofrange} are not between 0 and #{d}"
-  #  end
-  #end
-  
   def check_meter_changes
     nonzero_duration = @meter_changes.select {|k,v| v.duration != 0 }
     if nonzero_duration.any?
-      raise ValueNotZeroError, "meter changes #{nonzero_duration} have non-zero duration"
+      raise NonZeroError, "meter changes #{nonzero_duration} have non-zero duration"
     end
   end
 

data/lib/music-transcription/version.rb

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

data/spec/link_spec.rb

@@ -15,12 +15,21 @@ describe Link do
     it 'should return false if two links do not have the same target pitch' do
       Link.new(C2).should_not eq(Link.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))
+    end
   end
   
   describe '#clone' do
     it 'should return a link with the same target pitch' do
       l = Link.new(C4)
-      l.clone.should eq(l)
+      l.clone.target_pitch.should eq(C4)
+    end
+    
+    it 'should return a link with the same class' do
+      l = Link::Slur.new(Eb2)
+      l.clone.class.should eq(Link::Slur)
     end
   end
   

data/spec/note_spec.rb

@@ -11,9 +11,9 @@ describe Note do
       note.duration.should eq(2)
     end
     
-    it "should assign :accent parameter if given during construction" do
-      note = Note.new 2, accent: Accent::Staccato.new
-      note.accent.class.should eq(Accent::Staccato)
+    it "should assign :articulation parameter if given during construction" do
+      note = Note.new 2, articulation: STACCATO
+      note.articulation.should eq(STACCATO)
     end
     
     it 'should have no pitches if not given' do
@@ -36,18 +36,28 @@ describe Note do
     end
   end
   
-  describe '#clear_links' do
-    it 'should remove all links' do
-      n = Note.new(2,[C2,E2],links: {C2 => Link::Slur.new(D2)})
-      n.clear_links
-      n.links.should be_empty
+  {
+    :sixteenth => Rational(1,16),
+    :dotted_SIXTEENTH => Rational(3,32),
+    :eighth => Rational(1,8),
+    :dotted_eighth => Rational(3,16),
+    :quarter => Rational(1,4),
+    :dotted_quarter => Rational(3,8),
+    :half => Rational(1,2),
+    :dotted_half => Rational(3,4),
+    :whole => Rational(1)
+  }.each do |fn_name,tgt_dur|
+    describe ".#{fn_name}" do
+      it "should make a note with duration #{tgt_dur}" do
+        Note.send(fn_name).duration.should eq tgt_dur
+      end
     end
   end
   
   describe '#transpose!' do
     context 'given pitch diff' do
       before(:all) do
-        @note = Note::Quarter.new([C2,F2], links:{C2=>Link::Slur.new(D2)})
+        @note = Note::quarter([C2,F2], links:{C2=>Link::Slur.new(D2)})
         @diff = Pitch.new(semitone: 4)
         @note.transpose! @diff
       end
@@ -65,32 +75,32 @@ describe Note do
     
     context 'given integer diff' do
       it 'should transpose the given number of semitones' do
-        Note::Quarter.new([C2]).transpose!(4).pitches[0].should eq(E2)
+        Note::quarter([C2]).transpose!(4).pitches[0].should eq(E2)
       end
     end
     
     it 'should return self' do
-      n = Note::Quarter.new
+      n = Note::quarter
       n.transpose!(0).should eq n
     end
   end
   
   describe '#stretch!' do
     it 'should multiply note duration by ratio' do
-      note = Note::Quarter.new
+      note = Note::quarter
       note.stretch!(2)
       note.duration.should eq(Rational(1,2))
       
-      note = Note::Quarter.new
+      note = Note::quarter
       note.stretch!(Rational(1,2))
       note.duration.should eq(Rational(1,8))
-      note = Note::Quarter.new
+      note = Note::quarter
       note.stretch!(2)
       note.duration.should eq(Rational(1,2))
     end
     
     it 'should return self' do
-      note = Note::Quarter.new
+      note = Note::quarter
       note.stretch!(1).should be note
     end
   end
@@ -103,7 +113,7 @@ describe Note do
       n = Note.new(1,[C2,E2])
       YAML.load(n.to_yaml).should eq n
       
-      n = Note.new(1,[C2], accent: Accents::STACCATO)
+      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)})

data/spec/part_spec.rb

@@ -12,7 +12,7 @@ describe Part do
       p = Part.new(Dynamics::PPP)
       p.start_dynamic.should eq Dynamics::PPP
       
-      notes = [Note::Whole.new([A2]), Note::Half.new]
+      notes = [Note::whole([A2]), Note::half]
       dcs = { "1/2".to_r => Change::Immediate.new(Dynamics::P), 1 => Change::Gradual.new(Dynamics::MF,1) }
       p = Part.new(Dynamics::FF, notes: notes, dynamic_changes: dcs)
       p.notes.should eq notes
@@ -31,13 +31,13 @@ describe Part do
     { 'negative start dynamic' => [-0.01],
       'start dynamic > 1' => [1.01],
       #'dynamic change offsets outside 0..d' => [
-      #  0.5, :notes => [ Note::Whole.new ],
+      #  0.5, :notes => [ Note::whole ],
       #  :dynamic_changes => { 1.2 => Change::Immediate.new(0.5) }],
       #'dynamic change offsets outside 0..d' => [
-      #  0.5, :notes => [ Note::Whole.new ],
+      #  0.5, :notes => [ Note::whole ],
       #  :dynamic_changes => { -0.2 => Change::Immediate.new(0.5) }],
       'dynamic change values outside 0..1' => [
-        0.5, :notes => [ Note::Whole.new ],
+        0.5, :notes => [ Note::whole ],
         :dynamic_changes => { 0.2 => Change::Immediate.new(-0.01), 0.3 => Change::Gradual.new(1.01,0.2) }],
       'notes with 0 duration' => [ 0.5, :notes => [ Note.new(0) ]],
       'notes with negative duration' => [ 0.5, :notes => [ Note.new(-1) ]],
@@ -54,9 +54,9 @@ describe Part do
     
     {
       'valid notes' => [ Dynamics::PP,
-        :notes => [ Note::Whole.new, Note::Quarter.new([C5]) ]],
+        :notes => [ Note::whole, quarter([C5]) ]],
       'valid dynamic values' => [ Dynamics::MF,
-        :notes => [ Note::Whole.new([C4]), Note::Quarter.new ],
+        :notes => [ Note::whole([C4]), Note::quarter ],
         :dynamic_changes => {
           0.5 => Change::Immediate.new(Dynamics::MP),
           1.2 => Change::Gradual.new(Dynamics::FF, 0.05) } ],

data/spec/spec_helper.rb

@@ -4,14 +4,15 @@ require 'music-transcription'
 include Music::Transcription
 include Pitches
 include Meters
+include Articulations
 
 class Samples
   SAMPLE_PART = Part.new(
     Dynamics::P,
     notes: [
-      Note::Quarter.new([ C1, D1 ]),
-      Note::Quarter.new([ C2, D2 ]),
-      Note::Whole.new([ C3, D3 ])
+      Note::quarter([ C1, D1 ]),
+      Note::quarter([ C2, D2 ]),
+      Note::whole([ C3, D3 ])
     ],
     dynamic_changes: {1.0 => Change::Immediate.new(Dynamics::MP)}
   )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: music-transcription
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
 platform: ruby
 authors:
 - James Tunnell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-22 00:00:00.000000000 Z
+date: 2014-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,8 +151,7 @@ files:
 - examples/song1.yml
 - examples/song2.yml
 - lib/music-transcription.rb
-- lib/music-transcription/accent.rb
-- lib/music-transcription/accents.rb
+- lib/music-transcription/articulations.rb
 - lib/music-transcription/change.rb
 - lib/music-transcription/dynamics.rb
 - lib/music-transcription/errors.rb

data/lib/music-transcription/accent.rb

@@ -1,25 +0,0 @@
-module Music
-module Transcription
-
-# Defines a note accent (stacatto, tenuto, etc.)
-#
-# @author James Tunnell
-#
-class Accent
-  def ==(other)
-    self.class == other.class
-  end
-  
-  def clone
-    self.class.new
-  end
-  
-  [
-    :None, :Staccato, :Staccatissimo, :Marcato, :Martellato, :Tenuto
-  ].each do |name|
-    Accent.const_set(name, Class.new(Accent))
-  end
-end
-
-end
-end

data/lib/music-transcription/accents.rb

@@ -1,12 +0,0 @@
-module Music
-module Transcription
-module Accents
-  NONE = Accent::None
-  STACCATO = Accent::Staccato.new
-  STACCATISSIMO = Accent::Staccatissimo.new
-  MARCATO = Accent::Marcato.new
-  MARTELLATO = Accent::Martellato.new
-  TENUTO = Accent::Tenuto.new
-end
-end
-end