musicality 0.8.0 → 0.9.0

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

@@ -0,0 +1,111 @@
+module Musicality
+module Instruments
+  DEFAULT_INSTRUMENT = ACOUSTIC_GRAND_PIANO = Instrument.treble_bass("Acoustic Grand Piano", 1)
+  BRIGHT_ACOUSTIC_PIANO = Instrument.treble_bass("Bright Acoustic Piano", 2)
+  ELECTRIC_GRAND_PIANO = Instrument.treble_bass("Electric Grand Piano", 3)
+  HONKY_TONK_PIANO = Instrument.treble_bass("Honky Tonk Piano", 4)
+  ELECTRIC_PIANO_1 = Instrument.treble_bass("Electric Piano", 5)
+  ELECTRIC_PIANO_2 = Instrument.treble_bass("Electric Piano", 6)
+  HARPSICHORD = Instrument.treble_bass("Harpsichord", 7)
+  CLAVINET = Instrument.treble_bass("Clavinet", 8)
+  CELESTA = Instrument.treble_bass("Celesta", 9, -12)
+
+  GLOCKENSPIEL = Instrument.treble_bass("Glockenspiel", 10, -24)
+  MUSIC_BOX = Instrument.treble_bass("Music Box", 11)
+  VIBRAPHONE = Instrument.treble_bass("Virbaphone",12)
+  MARIMBA = Instrument.treble_bass("Marimba",13)
+  XYLOPHONE = Instrument.treble_bass("Xylophone",14, -12)
+  TUBULAR_BELLS = Instrument.treble_bass("Tubular Bells",15)
+  DULCIMER = Instrument.treble("Dulcimer",16)
+
+  DRAWBAR_ORGAN = Instrument.treble_bass("Drawbar Organ", 17)
+  PERCUSSIVE_ORGAN = Instrument.treble_bass("Percussive Organ", 18)
+  ROCK_ORGAN = Instrument.treble_bass("Rock Organ", 19)
+  CHURCH_ORGAN = Instrument.treble_bass("Church Organ", 20)
+  REED_ORGAN = Instrument.treble_bass("Reed Organ", 21)
+  ACCORDIAN = Instrument.treble_bass("Accordion", 22)
+  HARMONICA = Instrument.treble("Harmonica", 23)
+  TANGO_ACCORDIAN = Instrument.treble_bass("Tango Accordion", 24)
+
+  ACOUSTIC_GUITAR_NYLON = Instrument.guitar('Acoustic Guitar (nylon)', 25)
+  ACOUSTIC_GUITAR_STEEL = Instrument.guitar('Acoustic Guitar (steel)', 26)
+  ELECTRIC_GUITAR_JAZZ = Instrument.guitar('Electric Guitar (jazz)', 27)
+  ELECTRIC_GUITAR_CLEAN = Instrument.guitar('Electric Guitar (clean)', 28)
+  ELECTRIC_GUITAR_MUTED = Instrument.guitar('Electric Guitar (muted)', 29)
+  OVERDRIVEN_GUITAR = Instrument.guitar('Overdriven Guitar', 30)
+  DISTORTION_GUITAR = Instrument.guitar('Distortion Guitar', 31)
+  GUITAR_HARMONICS = Instrument.guitar('Guitar Harmonics', 32)
+  
+  ACOUSTIC_BASS = Instrument.bass_guitar('Acoustic Bass', 33)
+  ELECTRIC_BASS_FINGER = Instrument.bass_guitar('Electric Bass (finger)', 34)
+  ELECTRIC_BASS_PICK = Instrument.bass_guitar('Electric Bass (pick)', 35)
+  FRETLESS_BASS = Instrument.bass_guitar('Fretless Bass', 36)
+  SLAP_BASS_1 = Instrument.bass_guitar('Slap Bass', 37)
+  SLAP_BASS_2 = Instrument.bass_guitar('Slap Bass', 38)
+  SYNTH_BASS_1 = Instrument.bass_guitar('Synth Bass', 39)
+  SYNTH_BASS_2 = Instrument.bass_guitar('Synth Bass', 40)
+
+  VIOLIN = Instrument.treble('Violin', 41)
+  VIOLA = Instrument.treble_alto('Viola', 42)
+  CELLO = Instrument.tenor_bass('Cello', 43)
+  CONTRABASS = Instrument.bass('Contrabass', 44, 12)
+  TREMOLO_STRINGS = Instrument.treble_bass('Tremolo Strings', 45)
+  PIZZICATO_STRINGS = Instrument.treble_bass('Pizzicato Strings', 46)
+  ORCHESTRAL_HARP = Instrument.treble_bass('Orchestral Harp', 47)
+  TIMPANI = Instrument.bass('Timpani', 48)
+  STRING_ENSEMBLE_1 = Instrument.treble_bass('String Ensemble', 49)
+  STRING_ENSEMBLE_2 = Instrument.treble_bass('String Ensemble', 50)
+  SYNTH_STRINGS_1 = Instrument.treble_bass('Synth Strings', 51)
+  SYNTH_STRINGS_2 = Instrument.treble_bass('Synth Strings', 52)
+  
+  CHOIR_AAHS = Instrument.treble_bass('Choir Aahs', 53)
+  VOICE_OOHS = Instrument.treble_bass('Voice Oohs', 54)
+  SYNTH_VOICE = Instrument.treble_bass('Synth Voice', 55)
+  ORCHESTRA_HIT = Instrument.treble_bass('Orchestra Hit', 56)
+  
+  TRUMPET = Instrument.treble('Trumpet', 57, 2)
+  TROMBONE = Instrument.tenor_bass('Trombone', 58)
+  TUBA = Instrument.bass('Tuba', 59)
+  MUTED_TRUMPET = Instrument.treble('Muted Trumpet', 60)
+  FRENCH_HORN = Instrument.bass('French Horn', 61)
+  BRASS_SECTION = Instrument.treble_bass('Brass Section', 62)
+  SYNTH_BRASS_1 = Instrument.treble_bass('Synth Brass', 63)
+  SYNTH_BRASS_2 = Instrument.treble_bass('Synth Brass', 64)
+  
+  SOPRANO_SAX = Instrument.treble('Soprano Sax', 65, 2)
+  ALTO_SAX = Instrument.treble('Alto Sax', 66, 9)
+  TENOR_SAX = Instrument.treble('Tenor Sax', 67, 14)
+  BARITONE_SAX = Instrument.treble('Baritone Sax', 68, 21)
+  OBOE = Instrument.treble('Oboe', 69)
+  ENGLISH_HORN = Instrument.treble('English Horn', 70, 7)
+  BASSOON = Instrument.bass('Bassoon', 71)
+  CLARINET = Instrument.treble('Clarinet', 72, 2)
+  
+  PICCOLO = Instrument.treble('Piccolo', 73, -12)
+  FLUTE = Instrument.treble('Flute', 74)
+  RECORDER = Instrument.treble('Recorder', 75)
+  PAN_FLUTE = Instrument.treble_bass('Pan Flute', 76)
+  BLOWN_BOTTLE = Instrument.treble_bass('Blown Bottle', 77)
+  SHAKUHACHI = Instrument.treble_bass('Shakuhachi', 78)
+  WHISTLE = Instrument.treble_bass('Whistle', 79)
+  OCARINA = Instrument.treble_bass('Ocarina', 80)
+  
+  LEAD_SQUARE = Instrument.treble_bass('Lead (square)', 81)
+  LEAD_SAWTOOTH = Instrument.treble_bass('Lead (sawtooth)', 82)
+  LEAD_CALLIOPE = Instrument.treble_bass('Lead (calliope)', 83)
+  LEAD_CHIFF = Instrument.treble_bass('Lead (chiff)', 84)
+  LEAD_CHARANG = Instrument.treble_bass('Lead (charang)', 85)
+  LEAD_VOICE = Instrument.treble_bass('Lead (voice)', 86)
+  LEAD_FIFTHS = Instrument.treble_bass('Lead (fifths)', 87)
+  LEAD_PLUS_BASS = Instrument.treble_bass('Lead (bass+lead)', 88)
+  
+  PAD_NEW_AGE = Instrument.treble_bass('Pad (new age)', 89)
+  PAD_WARM = Instrument.treble_bass('Pad (warm)', 90)
+  PAD_POLYSYNTH = Instrument.treble_bass('Pad (polysynth)', 91)
+  PAD_CHOIR = Instrument.treble_bass('Pad (choir)', 92)
+  PAD_BOWED = Instrument.treble_bass('Pad (bowed)', 93)
+  PAD_METALLIC = Instrument.treble_bass('Pad (metallic)', 94)
+  PAD_HALO = Instrument.treble_bass('Pad (halo)', 95)
+  PAD_SWEEP = Instrument.treble_bass('Pad (sweep)', 96)
+end
+end

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

@@ -0,0 +1,137 @@
+module Musicality
+
+class Key
+  include Packable
+  
+  FLAT = :flat
+  SHARP = :sharp
+  ACCIDENTAL_TYPES = [FLAT, SHARP]
+  
+  MAJOR = :major
+  MINOR = :minor
+  TRIAD_TYPES = [MAJOR, MINOR]
+  
+  TONICS = {
+    MAJOR => {
+      FLAT => [PitchClasses::F, PitchClasses::Bb, PitchClasses::Eb,
+        PitchClasses::Ab, PitchClasses::Db, PitchClasses::Gb, PitchClasses::Cb],
+      SHARP => [PitchClasses::G,PitchClasses::D,PitchClasses::A,
+        PitchClasses::E,PitchClasses::B,PitchClasses::Fs,PitchClasses::Cs]
+    },
+    MINOR => {
+      FLAT => [PitchClasses::D,PitchClasses::G,PitchClasses::C,
+        PitchClasses::F,PitchClasses::Bb,PitchClasses::Eb,PitchClasses::Ab],
+      SHARP => [PitchClasses::E,PitchClasses::B,PitchClasses::Fs,
+        PitchClasses::Cs,PitchClasses::Gs,PitchClasses::Ds,PitchClasses::As]
+    }
+  }
+
+  ACCIDENTALS = {
+    FLAT => [PitchClasses::Bb,PitchClasses::Eb,PitchClasses::Ab,PitchClasses::Db,
+      PitchClasses::Gb,PitchClasses::Cb,PitchClasses::Fb],
+    SHARP => [PitchClasses::Fs,PitchClasses::Cs,PitchClasses::Gs,
+      PitchClasses::Ds,PitchClasses::As,PitchClasses::Es,PitchClasses::Bs]
+  }
+
+  attr_reader :tonic_pc, :triad, :accidental_pref
+  
+  def initialize tonic_pc, triad: MAJOR, accidental_pref: FLAT
+    self.tonic_pc = tonic_pc
+    self.triad = triad
+    self.accidental_pref = accidental_pref
+  end
+  
+  def self.major_flat tonic_pc
+    Key.new(tonic_pc, triad: MAJOR, accidental_pref: FLAT)
+  end
+  
+  def self.major_sharp tonic_pc
+    Key.new(tonic_pc, triad: MAJOR, accidental_pref: SHARP)
+  end
+  
+  def self.minor_flat tonic_pc
+    Key.new(tonic_pc, triad: MINOR, accidental_pref: FLAT)
+  end
+  
+  def self.minor_sharp tonic_pc
+    Key.new(tonic_pc, triad: MINOR, accidental_pref: SHARP)
+  end
+  
+  def major?; @triad == MAJOR; end
+  def minor?; @triad == MINOR; end
+  
+  def flat?; accidental_type == FLAT; end
+  def sharp?; accidental_type == SHARP; end
+  
+  def accidental_free?
+    (major? && @tonic_pc == PitchClasses::C) || (minor? && @tonic_pc == PitchClasses::A)
+  end
+
+  def triad= triad
+    if triad != @triad
+      unless TRIAD_TYPES.include? triad
+        raise ArgumentError, "Triad type #{triad} is not supported"
+      end
+      @triad = triad
+      reset_accidentals
+    end
+  end
+
+  def accidental_pref= accidental_pref
+    if accidental_pref != @accidental_pref
+      unless ACCIDENTAL_TYPES.include? accidental_pref
+        raise ArgumentError, "Accidental type #{accidental_pref} is not supported"
+      end
+      @accidental_pref = accidental_pref
+      reset_accidentals
+    end
+  end
+
+  def tonic_pc= tonic_pc
+    if tonic_pc != @tonic_pc
+      @tonic_pc = PitchClass.from_i(tonic_pc)
+      reset_accidentals
+    end
+  end
+  
+  def ==(other)
+    return @tonic_pc == other.tonic_pc && @triad == other.triad && 
+      @accidental_pref == other.accidental_pref
+  end
+
+  def clone
+    Marshal.load(Marshal.dump(self))
+  end
+  
+  def accidentals
+    unless @accidentals
+      @accidentals = []
+      unless accidental_free?
+        acc_type = accidental_type
+        idx = TONICS[@triad][acc_type].index(@tonic_pc)
+        @accidentals = ACCIDENTALS[acc_type].take(idx+1)
+      end
+    end
+    return @accidentals
+  end
+  
+  def accidental_type
+    if accidental_free? || TONICS[@triad][@accidental_pref].include?(@tonic_pc)
+      @accidental_pref
+    else
+      (@accidental_pref == FLAT) ? SHARP : FLAT
+    end
+  end
+
+  def transpose interval
+    new_key = self.clone
+    new_key.tonic_pc += interval
+    return new_key
+  end
+
+  private
+
+  def reset_accidentals; @accidentals = nil; end
+end
+
+end

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

@@ -0,0 +1,37 @@
+module Musicality
+module Keys
+  C_MAJOR = Key.major_sharp(PitchClasses::C)
+  G_MAJOR = Key.major_sharp(PitchClasses::G)
+  D_MAJOR = Key.major_sharp(PitchClasses::D)
+  A_MAJOR = Key.major_sharp(PitchClasses::A)
+  E_MAJOR = Key.major_sharp(PitchClasses::E)
+  B_MAJOR = Key.major_sharp(PitchClasses::B)
+  F_SHARP_MAJOR = Key.major_sharp(PitchClasses::Fs)
+  C_SHARP_MAJOR = Key.major_sharp(PitchClasses::Cs)
+  
+  F_MAJOR = Key.major_flat(PitchClasses::F)
+  B_FLAT_MAJOR = Key.major_flat(PitchClasses::Bb)
+  E_FLAT_MAJOR = Key.major_flat(PitchClasses::Eb)
+  A_FLAT_MAJOR = Key.major_flat(PitchClasses::Ab)
+  D_FLAT_MAJOR = Key.major_flat(PitchClasses::Db)
+  G_FLAT_MAJOR = Key.major_flat(PitchClasses::Gb)
+  C_FLAT_MAJOR = Key.major_flat(PitchClasses::Cb)
+  
+  A_MINOR = Key.minor_sharp(PitchClasses::A)
+  E_MINOR = Key.minor_sharp(PitchClasses::E)
+  B_MINOR = Key.minor_sharp(PitchClasses::B)
+  F_SHARP_MINOR = Key.minor_sharp(PitchClasses::Fs)
+  C_SHARP_MINOR = Key.minor_sharp(PitchClasses::Cs)
+  G_SHARP_MINOR = Key.minor_sharp(PitchClasses::Gs)
+  D_SHARP_MINOR = Key.minor_sharp(PitchClasses::Ds)
+  A_SHARP_MINOR = Key.minor_sharp(PitchClasses::As)
+  
+  D_MINOR = Key.minor_flat(PitchClasses::D)
+  G_MINOR = Key.minor_flat(PitchClasses::G)
+  C_MINOR = Key.minor_flat(PitchClasses::C)
+  F_MINOR = Key.minor_flat(PitchClasses::F)
+  B_FLAT_MINOR = Key.minor_flat(PitchClasses::Bb)
+  E_FLAT_MINOR = Key.minor_flat(PitchClasses::Eb)
+  A_FLAT_MINOR = Key.minor_flat(PitchClasses::Ab)
+end
+end

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

@@ -6,6 +6,8 @@ module Musicality
 #   @return [Pitch] The pitch of the note which is being connected to.
 #
 class Link
+  include Packable
+  
   def clone
     Marshal.load(Marshal.dump(self))
   end
@@ -23,12 +25,10 @@ class Link
   end
 
   def to_s
-    self.class::LINK_CHAR
+    LINK_SYMBOLS[self.class]
   end
 
-  class Tie < Link
-    LINK_CHAR = LINK_SYMBOLS[Links::TIE]
-  end
+  class Tie < Link; end
 
   class TargetedLink < Link
     attr_accessor :target_pitch
@@ -55,21 +55,8 @@ class Link
     end
   end
   
-  class Glissando < TargetedLink
-    LINK_CHAR = LINK_SYMBOLS[Links::GLISSANDO]
-  end
-  
-  class Portamento < TargetedLink
-    LINK_CHAR = LINK_SYMBOLS[Links::PORTAMENTO]
-  end
-
-  class Slur < TargetedLink
-    LINK_CHAR = LINK_SYMBOLS[Links::SLUR]
-  end
-
-  class Legato < TargetedLink
-    LINK_CHAR = LINK_SYMBOLS[Links::LEGATO]
-  end
+  class Glissando < TargetedLink; end
+  class Portamento < TargetedLink; end
 end
 
 end

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

@@ -0,0 +1,43 @@
+module Musicality
+
+class Mark
+  include Packable
+  
+  def clone
+    self.class.new
+  end
+
+  def to_s
+    MARK_SYMBOLS[self.class]
+  end
+
+  def ==(other)
+    self.class == other.class
+  end
+
+  class Slur < Mark
+    class Begin < Slur
+      def begins?; true; end
+      def ends?; false; end
+    end
+
+    class End < Slur
+      def begins?; false; end
+      def ends?; true; end
+    end
+  end
+
+  class Triplet < Mark
+    class Begin < Triplet
+      def begins?; true; end
+      def ends?; false; end
+    end
+
+    class End < Triplet
+      def begins?; false; end
+      def ends?; true; end
+    end
+  end
+end
+
+end

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

@@ -0,0 +1,11 @@
+module Musicality
+
+module Marks
+  BEGIN_SLUR = Mark::Slur::Begin.new
+  END_SLUR = Mark::Slur::End.new
+
+  BEGIN_TRIPLET = Mark::Triplet::Begin.new
+  END_TRIPLET = Mark::Triplet::End.new
+end
+
+end

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

@@ -1,8 +1,12 @@
 module Musicality
 
 class Meter
+  include Packable
   include Validatable
 
+  special_packing(:beat_duration){|r| r.to_s}
+  special_unpacking(:beat_duration){|s| s.to_r}
+
   attr_reader :measure_duration, :beat_duration, :beats_per_measure
   
   def initialize beats_per_measure, beat_duration

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

@@ -3,32 +3,25 @@ module Musicality
 require 'set'
 
 class Note
+  include Packable
   include Validatable
   
-  attr_reader :pitches, :links
-  attr_accessor :articulation, :duration, :accented
-
-  DEFAULT_ARTICULATION = Articulations::NORMAL
+  attr_reader :pitches, :links, :duration, :marks
+  attr_accessor :articulation
   
-  def initialize duration, pitches = [], articulation: DEFAULT_ARTICULATION, accented: false, links: {}
-    @duration = duration
+  def initialize duration, pitches = [], links: {}, articulation: Articulations::NORMAL, marks: []
+    self.duration = duration
     if !pitches.is_a? Enumerable
       pitches = [ pitches ]
     end
     @pitches = Set.new(pitches).sort
-    @articulation = articulation
-    @accented = accented
     @links = links
+    @articulation = articulation
+    @marks = marks
   end
   
   def check_methods
-    [ :ensure_positive_duration, :check_pitches ]
-  end
-  
-  def ensure_positive_duration
-    unless @duration > 0
-      raise NonPositiveError, "duration #{@duration} is not positive"
-    end
+    [ :check_pitches ]
   end
   
   def check_pitches
@@ -43,13 +36,25 @@ class Note
     (self.pitches == other.pitches) &&
     (@links.to_a.sort == other.links.to_a.sort) &&
     (@articulation == other.articulation) &&
-    (@accented == other.accented)
+    (@marks == marks)
   end
   
   def clone
     Marshal.load(Marshal.dump(self))
   end
 
+  def duration=  duration
+    raise NonPositiveError, "duration #{duration} is not positive" unless duration > 0
+    #@duration = duration.is_a?(Duration) ? duration : duration.to_dur
+    @duration = duration
+  end
+
+  def resize duration
+    new_note = self.clone
+    new_note.duration = duration
+    return new_note
+  end
+
   def transpose diff
     self.clone.transpose! diff
   end
@@ -61,16 +66,23 @@ class Note
     end ]
     return self
   end
-  
-  def stretch ratio
-    self.clone.stretch! ratio
+
+  def begins_slur?
+    marks.count {|m| m.is_a?(Mark::Slur::Begin) } > 0
   end
-  
-  def stretch! ratio
-    @duration *= ratio
-    return self
+
+  def ends_slur?
+    marks.count {|m| m.is_a?(Mark::Slur::End) } > 0
   end
-  
+
+  def begins_triplet?
+    marks.count {|m| m.is_a?(Mark::Triplet::Begin) } > 0
+  end
+
+  def ends_triplet?
+    marks.count {|m| m.is_a?(Mark::Triplet::End) } > 0
+  end
+
   def to_s
     d = @duration.to_r
     if d.denominator == 1
@@ -90,14 +102,16 @@ class Note
     end.join(",")
 
     art_str = ARTICULATION_SYMBOLS[@articulation] || ""
-    acc_str = @accented ? ACCENT_SYMBOL : ""
 
-    return dur_str + pitch_links_str + art_str + acc_str
+    begin_marks_str = marks.select {|m| m.begins? }.map {|m| m.to_s }.join
+    end_marks_str = marks.select {|m| m.ends? }.map {|m| m.to_s }.join
+
+    return begin_marks_str + dur_str + pitch_links_str + art_str + end_marks_str
   end
 
   def self.add_note_method(name, dur)
-    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)
+    self.class.send(:define_method,name.to_sym) do |pitches = [], links: {}, articulation: Articulations::NORMAL, marks: []|
+      Note.new(dur, pitches, articulation: articulation, links: links, marks: marks)
     end
   end