head_music 0.19.1 → 0.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 838a7ebfc5a6873d62ac2d484b655bcc5fe37302
-  data.tar.gz: 669f4f3f9ab721dc93208b39ef22ac7170951ba9
+  metadata.gz: 2261f261fb02f64ef7142d521b9ac01c1cb1e2c8
+  data.tar.gz: de8ced9611c0b4c4db2e7e4449341095eaa82986
 SHA512:
-  metadata.gz: 0ca1b44616d4aed6f76e5838b99a546b28889fed30802fec1c8e5ee713af89352e1326e89bf9e5195104722a574c7f8db47755fa6b561685c1b18b190fc38525
-  data.tar.gz: cc2a14f96a3ec7e7590c59e2b81023ed41a5e9b2f7fb8fd5d25a860c929ece23fa8e2df32adf15faa508b1ed21856a774642d3e4ba40ec4299ce3d2d640df6dd
+  metadata.gz: 5e8b3efc74e53e4a3ab83c56c16879c974111a5da9de8abe9c2b362ddea98c96ff43df38d06e6ec110ea00133fd5a208a4b41897b10a76ab01d3799173c1d508
+  data.tar.gz: a9765c3240a4cca996d25532d9d513fa3f4a0d0984209cbba2599fd1b7f221a6159e0ac6729e503f65861fdd0f259b9ad8bedc4f66379bbc2cbb895f2a29a97e

data/lib/head_music/content/note.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-# Note is like a placement, except:
+# Note quacks like a placement, but requires a different set of construction arguments
 #   - always has a pitch
-#   - doesn't require voice and position
+#   - receives a voice and position if unspecified
 class HeadMusic::Note
   attr_accessor :pitch, :rhythmic_value, :voice, :position
 

data/lib/head_music/key_signature.rb

@@ -57,6 +57,9 @@ class HeadMusic::KeySignature
     flats.any? ? flats : sharps
   end
 
+  alias sharps_and_flats signs
+  alias accidentals signs
+
   def name
     [tonic_spelling, scale_type].join(' ')
   end

data/lib/head_music/pitch.rb

@@ -14,14 +14,26 @@ class HeadMusic::Pitch
 
   delegate :smallest_interval_to, to: :pitch_class
 
+  delegate :enharmonic_equivalent?, :enharmonic?, to: :enharmonic_equivalence
+  delegate :octave_equivalent?, to: :octave_equivalence
+
   def self.get(value)
-    from_name(value) || from_number(value)
+    from_pitch_class(value) || from_name(value) || from_number(value)
   end
 
   def self.middle_c
     get('C4')
   end
 
+  def self.concert_a
+    get('A4')
+  end
+
+  def self.from_pitch_class(pitch_class)
+    return nil unless pitch_class.is_a?(HeadMusic::PitchClass)
+    fetch_or_create(pitch_class.sharp_spelling)
+  end
+
   def self.from_name(name)
     return nil unless name == name.to_s
     fetch_or_create(HeadMusic::Spelling.get(name), HeadMusic::Octave.get(name).to_i)
@@ -49,7 +61,8 @@ class HeadMusic::Pitch
     get(natural_letter_pitch)
   end
 
-  def self.fetch_or_create(spelling, octave)
+  def self.fetch_or_create(spelling, octave = nil)
+    octave ||= HeadMusic::Octave::DEFAULT
     return unless spelling && (-1..9).cover?(octave)
     @pitches ||= {}
     hash_key = [spelling, octave].join
@@ -84,10 +97,6 @@ class HeadMusic::Pitch
     HeadMusic::Pitch.get(to_s.gsub(/[#b]/, ''))
   end
 
-  def enharmonic?(other)
-    midi_note_number == other.midi_note_number
-  end
-
   def +(other)
     HeadMusic::Pitch.get(to_i + other.to_i)
   end
@@ -119,10 +128,26 @@ class HeadMusic::Pitch
     HeadMusic::Pitch.get([target_letter_name(num_steps), octave + octaves_delta(num_steps)].join)
   end
 
+  def frequency
+    tuning.frequency_for(self)
+  end
+
   private_class_method :new
 
   private
 
+  def enharmonic_equivalence
+    @enharmonic_equivalence ||= EnharmonicEquivalence.get(self)
+  end
+
+  def octave_equivalence
+    @octave_equivalence ||= OctaveEquivalence.get(self)
+  end
+
+  def tuning
+    @tuning ||= HeadMusic::Tuning.new
+  end
+
   def octaves_delta(num_steps)
     octaves_delta = (num_steps.abs / 7) * (num_steps >= 0 ? 1 : -1)
     if wrapped_down?(num_steps)
@@ -145,4 +170,54 @@ class HeadMusic::Pitch
     @target_letter_name ||= {}
     @target_letter_name[num_steps] ||= letter_name.steps(num_steps)
   end
+
+  # Enharmonic equivalence occurs when two pitches are spelled differently but refer to the same frequency, such as D♯ and E♭.
+  class EnharmonicEquivalence
+    def self.get(pitch)
+      pitch = HeadMusic::Pitch.get(pitch)
+      @enharmonic_equivalences ||= {}
+      @enharmonic_equivalences[pitch.to_s] ||= new(pitch)
+    end
+
+    attr_reader :pitch
+
+    delegate :pitch_class, to: :pitch
+
+    def initialize(pitch)
+      @pitch = HeadMusic::Pitch.get(pitch)
+    end
+
+    def enharmonic_equivalent?(other)
+      other = HeadMusic::Pitch.get(other)
+      pitch.midi_note_number == other.midi_note_number && pitch.spelling != other.spelling
+    end
+
+    alias enharmonic? enharmonic_equivalent?
+    alias equivalent? enharmonic_equivalent?
+
+    private_class_method :new
+  end
+
+  # Octave equivalence is the functional equivalence of pitches with the same spelling separated by one or more octaves.
+  class OctaveEquivalence
+    def self.get(pitch)
+      @octave_equivalences ||= {}
+      @octave_equivalences[pitch.to_s] ||= new(pitch)
+    end
+
+    attr_reader :pitch
+
+    def initialize(pitch)
+      @pitch = pitch
+    end
+
+    def octave_equivalent?(other)
+      other = HeadMusic::Pitch.get(other)
+      pitch.spelling == other.spelling && pitch.octave != other.octave
+    end
+
+    alias equivalent? octave_equivalent?
+
+    private_class_method :new
+  end
 end

data/lib/head_music/pitch_class.rb

@@ -1,15 +1,19 @@
 # frozen_string_literal: true
 
-# A pitch class is a set of notes separated by octaves.
+# A pitch class is a set of pitches separated by octaves.
 class HeadMusic::PitchClass
   attr_reader :number
+  attr_reader :spelling
 
   SHARP_SPELLINGS = %w[C C# D D# E F F# G G# A A# B].freeze
   FLAT_SPELLINGS = %w[C Db D Eb E F Gb G Ab A Bb B].freeze
 
   def self.get(identifier)
     @pitch_classes ||= {}
-    number = HeadMusic::Spelling.get(identifier).pitch_class.to_i if HeadMusic::Spelling.matching_string(identifier)
+    if HeadMusic::Spelling.matching_string(identifier)
+      spelling = HeadMusic::Spelling.get(identifier)
+      number = spelling.pitch_class.to_i
+    end
     number ||= identifier.to_i % 12
     @pitch_classes[number] ||= new(number)
   end
@@ -26,6 +30,14 @@ class HeadMusic::PitchClass
     number
   end
 
+  def sharp_spelling
+    SHARP_SPELLINGS[number]
+  end
+
+  def flat_spelling
+    FLAT_SPELLINGS[number]
+  end
+
   # Pass in the number of semitones
   def +(other)
     HeadMusic::PitchClass.get(to_i + other.to_i)
@@ -51,5 +63,13 @@ class HeadMusic::PitchClass
     intervals_to(other).first
   end
 
+  def white_key?
+    [0,2,4,5,7,9,11].include?(number)
+  end
+
+  def black_key?
+    !white_key?
+  end
+
   private_class_method :new
 end

data/lib/head_music/spelling.rb

@@ -87,4 +87,29 @@ class HeadMusic::Spelling
   end
 
   private_class_method :new
+
+  # Enharmonic equivalence occurs when two spellings refer to the same pitch class, such as D♯ and E♭.
+  class EnharmonicEquivalence
+    def self.get(spelling)
+      spelling = HeadMusic::Spelling.get(spelling)
+      @enharmonic_equivalences ||= {}
+      @enharmonic_equivalences[spelling.to_s] ||= new(spelling)
+    end
+
+    attr_reader :spelling
+
+    def initialize(spelling)
+      @spelling = HeadMusic::Spelling.get(spelling)
+    end
+
+    def enharmonic_equivalent?(other)
+      other = HeadMusic::Spelling.get(other)
+      spelling != other && spelling.pitch_class_number == other.pitch_class_number
+    end
+
+    alias enharmonic? enharmonic_equivalent?
+    alias equivalent? enharmonic_equivalent?
+
+    private_class_method :new
+  end
 end

data/lib/head_music/tuning.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# A tuning has a reference pitch and frequency and provides frequencies for all pitches
+# The base class assumes equal temperament tuning. By default, A4 = 440.0 Hz
+class HeadMusic::Tuning
+  REFERENCE_FREQUENCY = 440.0
+  REFERENCE_PITCH_NAME = 'A4'
+
+  attr_reader :reference_pitch, :reference_frequency
+
+  def initialize(reference_pitch: nil, reference_frequency: nil)
+    @reference_pitch = reference_pitch || HeadMusic::Pitch.get(REFERENCE_PITCH_NAME)
+    @reference_frequency = reference_frequency || REFERENCE_FREQUENCY
+  end
+
+  def frequency_for(pitch)
+    pitch = HeadMusic::Pitch.get(pitch) unless pitch.is_a?(HeadMusic::Pitch)
+    reference_frequency * (2**(1.0 / 12))**(pitch - reference_pitch).semitones
+  end
+end

data/lib/head_music/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HeadMusic
-  VERSION = '0.19.1'
+  VERSION = '0.19.2'
 end

data/lib/head_music.rb

@@ -46,6 +46,7 @@ require 'head_music/scale_type'
 require 'head_music/sign'
 require 'head_music/spelling'
 require 'head_music/staff'
+require 'head_music/tuning'
 
 # content
 require 'head_music/content/bar'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: head_music
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.19.2
 platform: ruby
 authors:
 - Rob Head
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-18 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -190,6 +190,7 @@ files:
 - lib/head_music/style/guides/fux_cantus_firmus.rb
 - lib/head_music/style/guides/modern_cantus_firmus.rb
 - lib/head_music/style/mark.rb
+- lib/head_music/tuning.rb
 - lib/head_music/utilities/hash_key.rb
 - lib/head_music/version.rb
 homepage: https://github.com/roberthead/head_music