head_music 0.25.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59d262194fb0642a00c0f6a491f0225ac8e637fc1b81fb210e202bb71f38d37d
-  data.tar.gz: b28f1d54a1f51a8500e2448fd5e64a8fcd2a901ef085ca2a378add0277a65c9b
+  metadata.gz: 4274cb71a70fcab6904e99afc282bb1db756e2a1cce0c1e1e50c601e0e848edf
+  data.tar.gz: 47566a6db5b0836686fd789cf2e0b052416a68f8f2ed67b2f6582266a141ea1a
 SHA512:
-  metadata.gz: 963a048a8b771cc8c3dd5d1a5735744bbed9ea1ba90028d1e152f8649aa4f08d37c4e9c91d87b07872fc9ea65557a4d7d124b2c1a1c62747279188b7ca64db13
-  data.tar.gz: 6b27b0330b5b8d9dbdb18934baa8b2e5e1b2992b580f8e930d9979f2da08be19ba1274c2eba1d251e57c9c026cd871d05cc9d6f5e58e0b52ce57ba49f7809d61
+  metadata.gz: b85d9dbd114b70bfea1fa9ce8cb964f6780ad9f64325a75baba02df48e416475f33e26a9dab22309740ff6e7f033fca756906a4fd5935af1f22e6fd325a775d4
+  data.tar.gz: 60a75acc692a1e1014f6042f9b167ecd7a0f6ec8eb98ca5dccb4c16a9bbcc79deff0b56481a713941caad779b7cc17b8487c89f4b4839bb31e3b453cff7558b5

data/lib/head_music.rb

@@ -17,7 +17,7 @@ require 'i18n/backend/fallbacks'
 
 I18n::Backend::Simple.include I18n::Backend::Fallbacks
 I18n.load_path << Dir[File.join(File.dirname(__dir__), 'lib', 'head_music', 'locales', '*.yml')]
-I18n.config.available_locales = %i[en de fr it es en_US en_GB]
+I18n.config.available_locales = %i[en fr de it ru es en_US en_GB]
 I18n.default_locale = :en
 I18n.fallbacks[:de] = %i[de en_GB en]
 I18n.fallbacks[:en_US] = %i[en_US en en_GB]
@@ -25,6 +25,7 @@ I18n.fallbacks[:en_GB] = %i[en_GB en en_US]
 I18n.fallbacks[:es] = %i[es en]
 I18n.fallbacks[:fr] = %i[fr en_GB en]
 I18n.fallbacks[:it] = %i[it en_GB en]
+I18n.fallbacks[:ru] = %i[ru en_GB en]
 
 # utilities
 require 'head_music/utilities/hash_key'
@@ -48,7 +49,6 @@ require 'head_music/melodic_interval'
 require 'head_music/meter'
 require 'head_music/motion'
 require 'head_music/musical_symbol'
-require 'head_music/octave'
 require 'head_music/pitch'
 require 'head_music/pitch/enharmonic_equivalence'
 require 'head_music/pitch/octave_equivalence'
@@ -57,6 +57,7 @@ require 'head_music/pitch_class_set'
 require 'head_music/pitch_set'
 require 'head_music/quality'
 require 'head_music/reference_pitch'
+require 'head_music/register'
 require 'head_music/rhythm'
 require 'head_music/rhythmic_unit'
 require 'head_music/scale'

data/lib/head_music/data/instruments.yml

@@ -1,83 +1,145 @@
 ---
-guitar:
-  family: string
-  classifications:
-    - string
-    - chordophone
-  default_clefs:
-    - treble_clef
-  voice: tenor
-piano:
-  family: string
+bassoon:
   classifications:
-    - string
-    - chordophone
-    - keyboard
-  default_clefs:
-    - treble_clef
+    - aerophone
+    - reed
+    - double_reed
+    - wind
+    - woodwind
+  family: woodwind
+  standard_staves:
     - bass_clef
-violin:
-  family: string
+cello:
   alias_name_keys:
-    - fiddle
+    - violoncello
   classifications:
-    - string
-    - chordophone
     - bowed
-  default_clefs:
-    - treble_clef
-  voice: soprano
-viola:
-  family: string
-  classifications:
-    - string
     - chordophone
-    - bowed
-  default_clefs:
-    - alto_clef
-  voice: alto
-cello:
-  family: string
-  classifications:
     - string
-    - chordophone
-    - bowed
-  default_clefs:
+  family: string
+  standard_staves:
     - bass_clef
-  voice: tenor
+clarinet:
+  classifications:
+    - aerophone
+    - reed
+    - single_reed
+    - wind
+    - woodwind
+  family: woodwind
+  standard_staves:
+    - treble_clef
 double_bass:
-  family: string
   classifications:
     - string
     - chordophone
     - bowed
-  default_clefs:
+  family: string
+  standard_staves:
     - bass_clef
-  voice: bass
+flute:
+  classifications:
+    - aerophone
+    - edge-blown aerophone
+    - wind
+    - woodwind
+  family: woodwind
+  standard_staves:
+    - treble_clef
+french_horn:
+  alias_name_keys:
+    - horn
+  classifications:
+    - aerophone
+    - brass
+    - wind
+  family: brass
+  standard_staves:
+    - treble_clef
+guitar:
+  classifications:
+    - chordophone
+    - plucked
+    - string
+  family: string
+  standard_staves:
+    - treble_clef
 harp:
   family: string
   classifications:
-    - string
     - chordophone
     - plucked
-  default_clefs:
+    - string
+  standard_staves:
     - treble_clef
     - bass_clef
-flute:
-  family: woodwind
+oboe:
   classifications:
-    - woodwind
-    - wind
     - aerophone
-    - edge-blown aerophone
-  default_clefs:
+    - reed
+    - double_reed
+    - wind
+    - woodwind
+  family: woodwind
+  standard_staves:
     - treble_clef
-  voice: soprano
 organ:
   classifications:
     - aerophone
     - keyboard
-  default_clefs:
+  standard_staves:
+    - treble_clef
+    - bass_clef
+    - bass_clef
+piano:
+  classifications:
+    - chordophone
+    - keyboard
+    - percussion
+    - string
+  family: percussion
+  standard_staves:
     - treble_clef
     - bass_clef
+trombone:
+  classifications:
+    - aerophone
+    - brass
+    - wind
+  family: brass
+  standard_staves:
+    - bass_clef
+trumpet:
+  classifications:
+    - aerophone
+    - brass
+    - wind
+  family: brass
+  standard_staves:
+    - treble_clef
+tuba:
+  classifications:
+    - aerophone
+    - brass
+    - wind
+  family: brass
+  standard_staves:
     - bass_clef
+viola:
+  family: string
+  classifications:
+    - bowed
+    - chordophone
+    - string
+  standard_staves:
+    - alto_clef
+violin:
+  alias_name_keys:
+    - fiddle
+  classifications:
+    - bowed
+    - chordophone
+    - string
+  family: string
+  standard_staves:
+    - treble_clef

data/lib/head_music/diatonic_interval.rb

@@ -304,7 +304,7 @@ class HeadMusic::DiatonicInterval
   def inversion
     inverted_low_pitch = lower_pitch
     while inverted_low_pitch < higher_pitch
-      inverted_low_pitch = HeadMusic::Pitch.fetch_or_create(lower_pitch.spelling, inverted_low_pitch.octave + 1)
+      inverted_low_pitch = HeadMusic::Pitch.fetch_or_create(lower_pitch.spelling, inverted_low_pitch.register + 1)
     end
     HeadMusic::DiatonicInterval.new(higher_pitch, inverted_low_pitch)
   end

data/lib/head_music/instrument.rb

@@ -17,7 +17,7 @@ class HeadMusic::Instrument
     INSTRUMENTS.map { |key, _data| get(key) }.sort_by(&:name)
   end
 
-  attr_reader :name_key, :family, :default_clefs, :classifications, :voice
+  attr_reader :name_key, :family, :standard_staves, :classifications
 
   def ==(other)
     to_s == other.to_s
@@ -67,9 +67,8 @@ class HeadMusic::Instrument
   def initialize_data_from_record(record)
     @name_key = record['name_key'].to_sym
     @family = record['family']
-    @default_clefs = record['default_clefs'] || []
+    @standard_staves = record['standard_staves'] || []
     @classifications = record['classifications'] || []
-    @voice = record['voice'].to_s
     self.name = I18n.translate(name_key, scope: 'instruments', locale: 'en', default: inferred_name)
   end
 

data/lib/head_music/locales/de.yml

@@ -86,6 +86,7 @@ de:
     hammered_dulcimer: Hackbrett
     harp: Harfe
     harpsichord: Cembalo
+    horn: Horn
     lute: Laute
     mandolin: Mandoline
     marimba: Marimbaphon

data/lib/head_music/locales/en.yml

@@ -124,6 +124,7 @@ en:
     hammered_dulcimer: hammered dulcimer
     harp: harp
     harpsichord: harpsichord
+    horn: horn
     lute: lute
     mandolin: mandolin
     maracas: maracas

data/lib/head_music/locales/es.yml

@@ -80,6 +80,7 @@ es:
     hammered_dulcimer: dulcémele
     harp: arpa
     harpsichord: clavecémbalo
+    horn: corno
     lute: laúd
     mandolin: mandolina
     marimba: marimba

data/lib/head_music/locales/fr.yml

@@ -92,6 +92,7 @@ fr:
     hammered_dulcimer: tympanon
     harp: harpe
     harpsichord: clavecin
+    horn: cor
     lute: luth
     mandolin: mandoline
     marimba: marimba

data/lib/head_music/locales/it.yml

@@ -84,6 +84,7 @@ it:
     hammered_dulcimer: salterio
     harp: arpa
     harpsichord: clavicembalo
+    horn: corno
     lute: liuto
     mandolin: mandolino
     marimba: marimba

data/lib/head_music/locales/ru.yml

@@ -40,6 +40,7 @@ ru:
     hammered_dulcimer: tsimbaly
     harp: arfa
     harpsichord: klavesin
+    horn: gorn
     lute: liutnia
     mandolin: mandolina
     marimba: marimba

data/lib/head_music/pitch.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-# A pitch is a named frequency represented by a spelling and an octive.
+# A pitch is a named frequency represented by a spelling and a register.
 class HeadMusic::Pitch
   include Comparable
 
-  attr_reader :spelling
-  attr_reader :octave
+  attr_reader :spelling, :register
 
   delegate :letter_name, to: :spelling
   delegate :series_ascending, :series_descending, to: :letter_name, prefix: true
@@ -51,7 +50,7 @@ class HeadMusic::Pitch
   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)
+    fetch_or_create(HeadMusic::Spelling.get(name), HeadMusic::Register.get(name).to_i)
   end
 
   def self.from_number(number)
@@ -66,7 +65,7 @@ class HeadMusic::Pitch
     sign_interval = natural_letter_pitch.smallest_interval_to(HeadMusic::PitchClass.get(number))
     sign = HeadMusic::Sign.by(:semitones, sign_interval) if sign_interval != 0
     spelling = HeadMusic::Spelling.fetch_or_create(letter_name, sign)
-    fetch_or_create(spelling, natural_letter_pitch.octave)
+    fetch_or_create(spelling, natural_letter_pitch.register)
   end
 
   def self.natural_letter_pitch(number, letter_name)
@@ -76,26 +75,26 @@ class HeadMusic::Pitch
     get(natural_letter_pitch)
   end
 
-  def self.fetch_or_create(spelling, octave = nil)
-    octave ||= HeadMusic::Octave::DEFAULT
-    return unless spelling && (-1..9).cover?(octave)
+  def self.fetch_or_create(spelling, register = nil)
+    register ||= HeadMusic::Register::DEFAULT
+    return unless spelling && (-1..9).cover?(register)
 
     @pitches ||= {}
-    hash_key = [spelling, octave].join
-    @pitches[hash_key] ||= new(spelling, octave)
+    hash_key = [spelling, register].join
+    @pitches[hash_key] ||= new(spelling, register)
   end
 
-  def initialize(spelling, octave)
+  def initialize(spelling, register)
     @spelling = HeadMusic::Spelling.get(spelling.to_s)
-    @octave = octave.to_i
+    @register = register.to_i
   end
 
   def name
-    [spelling, octave].join
+    [spelling, register].join
   end
 
   def midi_note_number
-    (octave + 1) * 12 + letter_name.pitch_class.to_i + sign_semitones.to_i
+    (register + 1) * 12 + letter_name.pitch_class.to_i + sign_semitones.to_i
   end
 
   alias midi midi_note_number
@@ -109,6 +108,10 @@ class HeadMusic::Pitch
     midi_note_number
   end
 
+  def helmholtz_notation
+    helmholtz_letter_name + helmholtz_marks
+  end
+
   def natural
     HeadMusic::Pitch.get(to_s.gsub(HeadMusic::Sign.matcher, ''))
   end
@@ -150,7 +153,7 @@ class HeadMusic::Pitch
   end
 
   def natural_steps(num_steps)
-    HeadMusic::Pitch.get([target_letter_name(num_steps), octave + octaves_delta(num_steps)].join)
+    HeadMusic::Pitch.get([target_letter_name(num_steps), register + octaves_delta(num_steps)].join)
   end
 
   def frequency
@@ -167,7 +170,7 @@ class HeadMusic::Pitch
   private
 
   def octave_changes_to(other)
-    other.octave - octave - octave_adjustment_to(other)
+    other.register - register - octave_adjustment_to(other)
   end
 
   def octave_adjustment_to(other)
@@ -212,4 +215,14 @@ class HeadMusic::Pitch
     @target_letter_name ||= {}
     @target_letter_name[num_steps] ||= letter_name.steps_up(num_steps)
   end
+
+  def helmholtz_letter_name
+    return spelling.to_s.downcase if HeadMusic::Register.get(register).helmholtz_case == :lower
+
+    spelling.to_s
+  end
+
+  def helmholtz_marks
+    HeadMusic::Register.get(register).helmholtz_marks
+  end
 end

data/lib/head_music/pitch/octave_equivalence.rb

@@ -15,7 +15,7 @@ class HeadMusic::Pitch::OctaveEquivalence
 
   def octave_equivalent?(other)
     other = HeadMusic::Pitch.get(other)
-    pitch.spelling == other.spelling && pitch.octave != other.octave
+    pitch.spelling == other.spelling && pitch.register != other.register
   end
 
   alias equivalent? octave_equivalent?

data/lib/head_music/pitch_set.rb

@@ -187,7 +187,7 @@ class HeadMusic::PitchSet
 
   def reduction_pitches
     pitches.map do |pitch|
-      pitch = HeadMusic::Pitch.fetch_or_create(pitch.spelling, pitch.octave - 1) while pitch > bass_pitch + 12
+      pitch = HeadMusic::Pitch.fetch_or_create(pitch.spelling, pitch.register - 1) while pitch > bass_pitch + 12
       pitch
     end.sort
   end

data/lib/head_music/register.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# The register is a numeric octave identifier used in scientific pitch notation.
+#
+# A pitch is a spelling plus a register. For example, C4 is middle C and C5 is the C one octave higher.
+# The number changes between the letter names B and C regardless of sharps and flats,
+# so as an extreme example, Cb5 is actually a semitone below B#4.
+class HeadMusic::Register
+  include Comparable
+
+  DEFAULT = 4
+
+  def self.get(identifier)
+    from_number(identifier) || from_name(identifier) || default
+  end
+
+  def self.from_number(identifier)
+    return nil unless identifier.to_s == identifier.to_i.to_s
+    return nil unless (-2..12).cover?(identifier.to_i)
+
+    @registers ||= {}
+    @registers[identifier.to_i] ||= new(identifier.to_i)
+  end
+
+  def self.from_name(string)
+    return unless string.to_s.match?(HeadMusic::Spelling::MATCHER)
+
+    _letter, _sign, register_string = string.to_s.match(HeadMusic::Spelling::MATCHER).captures
+    @registers ||= {}
+    @registers[register_string.to_i] ||= new(register_string.to_i) if register_string
+  end
+
+  def self.default
+    @registers[DEFAULT] ||= new(DEFAULT)
+  end
+
+  attr_reader :number
+
+  delegate :to_i, :to_s, to: :number
+
+  def initialize(number)
+    @number = number
+  end
+
+  def <=>(other)
+    to_i <=> other.to_i
+  end
+
+  def +(other)
+    self.class.get(to_i + other.to_i)
+  end
+
+  def -(other)
+    self.class.get(to_i - other.to_i)
+  end
+
+  def helmholtz_case
+    return :upper if number < 3
+
+    :lower
+  end
+
+  def helmholtz_marks
+    return ',' * (2 - number) if number < 2
+    return "'" * (number - 3) if number > 3
+
+    ''
+  end
+
+  private_class_method :new
+end

data/lib/head_music/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: head_music
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Rob Head
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-14 00:00:00.000000000 Z
+date: 2021-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -166,7 +166,6 @@ files:
 - lib/head_music/motion.rb
 - lib/head_music/musical_symbol.rb
 - lib/head_music/named.rb
-- lib/head_music/octave.rb
 - lib/head_music/pitch.rb
 - lib/head_music/pitch/enharmonic_equivalence.rb
 - lib/head_music/pitch/octave_equivalence.rb
@@ -175,6 +174,7 @@ files:
 - lib/head_music/pitch_set.rb
 - lib/head_music/quality.rb
 - lib/head_music/reference_pitch.rb
+- lib/head_music/register.rb
 - lib/head_music/rhythm.rb
 - lib/head_music/rhythmic_unit.rb
 - lib/head_music/scale.rb

data/lib/head_music/octave.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-# The Octave identifier is a number used in scientific pitch notation.
-class HeadMusic::Octave
-  include Comparable
-
-  DEFAULT = 4
-
-  def self.get(identifier)
-    from_number(identifier) || from_name(identifier) || default
-  end
-
-  def self.from_number(identifier)
-    return nil unless identifier.to_s == identifier.to_i.to_s
-    return nil unless (-2..12).cover?(identifier.to_i)
-
-    @octaves ||= {}
-    @octaves[identifier.to_i] ||= new(identifier.to_i)
-  end
-
-  def self.from_name(string)
-    return unless string.to_s.match?(HeadMusic::Spelling::MATCHER)
-
-    _letter, _sign, octave_string = string.to_s.match(HeadMusic::Spelling::MATCHER).captures
-    @octaves ||= {}
-    @octaves[octave_string.to_i] ||= new(octave_string.to_i) if octave_string
-  end
-
-  def self.default
-    @octaves[DEFAULT] ||= new(DEFAULT)
-  end
-
-  attr_reader :number
-
-  delegate :to_i, :to_s, to: :number
-
-  def initialize(number)
-    @number = number
-  end
-
-  def <=>(other)
-    to_i <=> other.to_i
-  end
-
-  def +(other)
-    self.class.get(to_i + other.to_i)
-  end
-
-  def -(other)
-    self.class.get(to_i - other.to_i)
-  end
-
-  private_class_method :new
-end