head_music 4.0.1 → 5.0.0

data/lib/head_music/diatonic_interval.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A diatonic interval is the distance between two spelled pitches.
 class HeadMusic::DiatonicInterval
   include Comparable

data/lib/head_music/harmonic_interval.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A harmonic interval is the diatonic interval between two notes sounding together.
 class HeadMusic::HarmonicInterval
   attr_reader :voice1, :voice2, :position

data/lib/head_music/instrument/pitch_configuration.rb

@@ -0,0 +1,35 @@
+class HeadMusic::Instrument::PitchConfiguration
+  attr_reader :key, :attributes
+
+  def initialize(key, attributes = {})
+    @key = key.to_s.to_sym
+    @attributes = attributes
+  end
+
+  def fundamental_pitch_spelling
+    return unless attributes["fundamental_pitch_spelling"].to_s != ""
+
+    @fundamental_pitch_spelling ||=
+      HeadMusic::Spelling.get(attributes["fundamental_pitch_spelling"])
+  end
+
+  def staff_configurations
+    @staff_configurations ||=
+      (attributes["staff_configurations"] || {}).map do |key, list|
+        HeadMusic::Instrument::StaffConfiguration.new(
+          key: key,
+          pitch_configuration: self,
+          list: list
+        )
+      end
+  end
+
+  def default?
+    key.to_s == "default"
+  end
+
+  def default_staff_configuration
+    @default_staff_configuration ||=
+      staff_configurations.find(&:default?) || staff_configurations.first
+  end
+end

data/lib/head_music/instrument/staff.rb

@@ -0,0 +1,30 @@
+class HeadMusic::Instrument::Staff
+  DEFAULT_CLEF = "treble_clef"
+
+  attr_reader :staff_configuration, :attributes
+
+  def initialize(staff_configuration, attributes)
+    @staff_configuration = staff_configuration
+    @attributes = attributes || {}
+  end
+
+  def clef
+    HeadMusic::Clef.get(smart_clef_key)
+  end
+
+  def smart_clef_key
+    "#{attributes["clef"]}_clef".gsub(/_clef_clef$/, "_clef")
+  end
+
+  def sounding_transposition
+    attributes["sounding_transposition"] || 0
+  end
+
+  def name_key
+    attributes["name_key"]
+  end
+
+  def name
+    name_key.to_s.tr("_", " ")
+  end
+end

data/lib/head_music/instrument/staff_configuration.rb

@@ -0,0 +1,19 @@
+class HeadMusic::Instrument::StaffConfiguration
+  attr_reader :pitch_configuration, :key, :list
+
+  def initialize(pitch_configuration:, key:, list:)
+    @pitch_configuration = pitch_configuration
+    @key = key || "default"
+    @list = list
+  end
+
+  def default?
+    key.to_s == "default"
+  end
+
+  def staves
+    @staves ||= list.map do |attributes|
+      HeadMusic::Instrument::Staff.new(self, attributes)
+    end
+  end
+end

data/lib/head_music/instrument.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A musical instrument.
 # An instrument object can be assigned to a staff object.
 # Attributes:
@@ -8,14 +6,11 @@
 #   orchestra_section_key: the section of the orchestra (e.g. "strings")
 #   family_key: the key for the family of the instrument (e.g. "saxophone")
 #   classification_keys: an array of classification_keys
-#   transposition: the number of semitones between the written and the sounding pitch (optional, default: 0)
 #   default_clefs: the default clef or system of clefs for the instrument
 #     - [treble] for instruments that use the treble clef
 #     - [treble, bass] for instruments that use the grand staff
-#   notation:
-#     a hash of default and alternative notation systems,
-#     each with a staff's key with an array of hashes
-#     including clef and transposition (where applicable)
+#   pitch_configurations:
+#     a hash of default and alternative fundamental pitches.
 # Associations:
 #   family: the family of the instrument (e.g. "saxophone")
 #   orchestra_section: the section of the orchestra (e.g. "strings")
@@ -25,8 +20,7 @@ class HeadMusic::Instrument
   INSTRUMENTS = YAML.load_file(File.expand_path("data/instruments.yml", __dir__)).freeze
 
   def self.get(name)
-    result = get_by_name(name) || get_by_name(key_for_name(name)) || get_by_alias(name)
-    result || new(name)
+    get_by_name(name)
   end
 
   def self.all
@@ -38,9 +32,7 @@ class HeadMusic::Instrument
   attr_reader(
     :name_key, :alias_name_keys,
     :family_key, :orchestra_section_key,
-    :notation, :classification_keys,
-    :fundamental_pitch_spelling, :transposition,
-    :default_staves, :default_clefs
+    :pitch_configurations, :classification_keys
   )
 
   def ==(other)
@@ -61,12 +53,12 @@ class HeadMusic::Instrument
 
   # Returns true if the instrument sounds at a different pitch than written.
   def transposing?
-    transposition != 0
+    default_sounding_transposition != 0
   end
 
   # Returns true if the instrument sounds at a different register than written.
   def transposing_at_the_octave?
-    transposing? && transposition % 12 == 0
+    transposing? && default_sounding_transposition % 12 == 0
   end
 
   def single_staff?
@@ -78,11 +70,31 @@ class HeadMusic::Instrument
   end
 
   def pitched?
-    return false if default_clefs.compact.uniq == ["percussion"]
+    return false if default_clefs.compact.uniq == [HeadMusic::Clef.get("neutral_clef")]
 
     default_clefs.any?
   end
 
+  def default_pitch_configuration
+    pitch_configurations.find(&:default?) || pitch_configurations.first
+  end
+
+  def default_staff_configuration
+    default_pitch_configuration&.default_staff_configuration
+  end
+
+  def default_staves
+    default_staff_configuration&.staves || []
+  end
+
+  def default_clefs
+    default_staves&.map(&:clef) || []
+  end
+
+  def default_sounding_transposition
+    default_staves&.first&.sounding_transposition || 0
+  end
+
   private_class_method :new
 
   private
@@ -146,10 +158,10 @@ class HeadMusic::Instrument
   def initialize_attributes(record)
     @orchestra_section_key ||= record["orchestra_section_key"]
     @classification_keys = [@classification_keys, record["classification_keys"]].flatten.compact.uniq
-    @fundamental_pitch_spelling = record["fundamental_pitch_spelling"]
-    @default_staves = (record.dig("notation", "default", "staves") || [])
-    @default_clefs = @default_staves.map { |staff| staff["clef"] }
-    @transposition = @default_staves&.first&.[]("transposition") || 0
+    @pitch_configurations =
+      (record["pitch_configurations"] || {}).map do |key, attributes|
+        HeadMusic::Instrument::PitchConfiguration.new(key, attributes)
+      end
   end
 
   def inferred_name

data/lib/head_music/interval_cycle.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # An Interval Cycle is a collection of pitch classes created from a sequence of the same interval class.
 class HeadMusic::IntervalCycle
   attr_reader :interval, :starting_pitch

data/lib/head_music/key_signature.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Represents a key signature.
 # In French, sharps and flats in the key signature are called "altérations".
 class HeadMusic::KeySignature

data/lib/head_music/letter_name.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Music has seven lette names that are used to identify pitches and pitch classes.
 class HeadMusic::LetterName
   NAMES = %w[C D E F G A B].freeze

data/lib/head_music/locales/en.yml

@@ -103,6 +103,7 @@ en:
     instrument_voices:
       piccolo: piccolo
       soprano: soprano
+      mezzo_soprano: mezzo-soprano
       alto: alto
       tenor: tenor
       baritone: baritone
@@ -252,6 +253,7 @@ en:
       sydney_symphony_orchestra: Sydney Symphony Orchestra
       verdi: Verdi tuning
     rudiments:
+      alteration: alteration
       chromatic_interval: chromatic interval
       circle: circle
       clef: clef
@@ -279,7 +281,6 @@ en:
       scale: scale
       scale_degree: scale degree
       scale_type: scale type
-      sign: sign
       solmization: solmization
       sonority: sonority
       spelling: spelling

data/lib/head_music/melodic_interval.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A melodic interval is the distance between one note and the next.
 class HeadMusic::MelodicInterval
   attr_reader :first_note, :second_note

data/lib/head_music/meter.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Meter is the rhythmic size of a measure, such as 4/4 or 6/8
 class HeadMusic::Meter
   attr_reader :top_number, :bottom_number

data/lib/head_music/motion.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Motion defines the relative pitch direction of the upper and lower voices of subsequence intervals.
 class HeadMusic::Motion
   attr_reader :first_harmonic_interval, :second_harmonic_interval

data/lib/head_music/musical_symbol.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A symbol is a mark or sign that signifies a particular rudiment of music
 class HeadMusic::MusicalSymbol
   attr_reader :ascii, :unicode, :html_entity

data/lib/head_music/named.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # NameRudiment is a module to be included in classes whose instances may be identified by name.
 module HeadMusic::Named
   delegate :to_s, to: :name

data/lib/head_music/pitch/enharmonic_equivalence.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # An enharmonic equivalent pitch is the same frequency spelled differently, such as D# and Eb.
 class HeadMusic::Pitch::EnharmonicEquivalence
   def self.get(pitch)

data/lib/head_music/pitch/octave_equivalence.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Octave equivalence is the functional equivalence of pitches with the same spelling separated by one or more octaves.
 class HeadMusic::Pitch::OctaveEquivalence
   def self.get(pitch)

data/lib/head_music/pitch.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A pitch is a named frequency represented by a spelling and a register.
 class HeadMusic::Pitch
   include Comparable
@@ -8,11 +6,11 @@ class HeadMusic::Pitch
 
   delegate :letter_name, to: :spelling
   delegate :series_ascending, :series_descending, to: :letter_name, prefix: true
-  delegate :sign, :sharp?, :flat?, to: :spelling
+  delegate :alteration, :sharp?, :flat?, to: :spelling
   delegate :pitch_class, to: :spelling
   delegate :number, to: :pitch_class, prefix: true
   delegate :pitch_class_number, to: :natural, prefix: true
-  delegate :semitones, to: :sign, prefix: true, allow_nil: true
+  delegate :semitones, to: :alteration, prefix: true, allow_nil: true
   delegate :steps_to, to: :letter_name, prefix: true
 
   delegate :smallest_interval_to, to: :pitch_class
@@ -62,9 +60,9 @@ class HeadMusic::Pitch
   def self.from_number_and_letter(number, letter_name)
     letter_name = HeadMusic::LetterName.get(letter_name)
     natural_letter_pitch = natural_letter_pitch(number, letter_name)
-    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)
+    alteration_interval = natural_letter_pitch.smallest_interval_to(HeadMusic::PitchClass.get(number))
+    alteration = HeadMusic::Alteration.by(:semitones, alteration_interval) if alteration_interval != 0
+    spelling = HeadMusic::Spelling.fetch_or_create(letter_name, alteration)
     fetch_or_create(spelling, natural_letter_pitch.register)
   end
 
@@ -94,7 +92,7 @@ class HeadMusic::Pitch
   end
 
   def midi_note_number
-    (register + 1) * 12 + letter_name.pitch_class.to_i + sign_semitones.to_i
+    (register + 1) * 12 + letter_name.pitch_class.to_i + alteration_semitones.to_i
   end
 
   alias_method :midi, :midi_note_number
@@ -113,7 +111,7 @@ class HeadMusic::Pitch
   end
 
   def natural
-    HeadMusic::Pitch.get(to_s.gsub(HeadMusic::Sign.matcher, ""))
+    HeadMusic::Pitch.get(to_s.gsub(HeadMusic::Alteration.matcher, ""))
   end
 
   def +(other)

data/lib/head_music/pitch_class.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A pitch class is a set of pitches separated by octaves.
 class HeadMusic::PitchClass
   include Comparable

data/lib/head_music/pitch_class_set.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A PitchClassSet represents a pitch-class set or pitch collection.
 # See also: PitchSet, PitchClass
 class HeadMusic::PitchClassSet

data/lib/head_music/pitch_set.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A PitchSet is a collection of one or more pitches.
 # See also: PitchClassSet
 class HeadMusic::PitchSet

data/lib/head_music/quality.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A quality is a categorization of an interval.
 class HeadMusic::Quality
   SHORTHAND = {

data/lib/head_music/reference_pitch.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A reference pitch has a pitch and a frequency
 # With no arguments, it assumes that A4 = 440.0 Hz
 class HeadMusic::ReferencePitch

data/lib/head_music/register.rb

@@ -1,5 +1,3 @@
-# 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.

data/lib/head_music/rhythm.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module HeadMusic::Rhythm
   PPQN = PULSES_PER_QUARTER_NOTE = 960
 end

data/lib/head_music/rhythmic_unit.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A rhythmic unit is a rudiment of duration consisting of doublings and divisions of a whole note.
 class HeadMusic::RhythmicUnit
   include HeadMusic::Named

data/lib/head_music/scale.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A scale contains ordered pitches starting at a tonal center.
 class HeadMusic::Scale
   SCALE_REGEX = /^[A-G][#b]?\s+\w+$/

data/lib/head_music/scale_degree.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A scale degree is a number indicating the ordinality of the spelling in the key signature.
 # TODO: Rewrite to accept a tonal_center and a scale type.
 class HeadMusic::ScaleDegree
@@ -21,20 +19,20 @@ class HeadMusic::ScaleDegree
     scale.letter_name_series_ascending.index(spelling.letter_name.to_s) + 1
   end
 
-  def sign
-    sign_semitones = spelling.sign&.semitones || 0
-    usual_sign_semitones = scale_degree_usual_spelling.sign&.semitones || 0
-    delta = sign_semitones - usual_sign_semitones
-    HeadMusic::Sign.by(:semitones, delta) if delta != 0
+  def alteration
+    alteration_semitones = spelling.alteration&.semitones || 0
+    usual_sign_semitones = scale_degree_usual_spelling.alteration&.semitones || 0
+    delta = alteration_semitones - usual_sign_semitones
+    HeadMusic::Alteration.by(:semitones, delta) if delta != 0
   end
 
   def to_s
-    "#{sign}#{degree}"
+    "#{alteration}#{degree}"
   end
 
   def <=>(other)
     if other.is_a?(HeadMusic::ScaleDegree)
-      [degree, sign.semitones] <=> [other.degree, other.sign.semitones]
+      [degree, alteration.semitones] <=> [other.degree, other.alteration.semitones]
     else
       to_s <=> other.to_s
     end
@@ -44,7 +42,7 @@ class HeadMusic::ScaleDegree
     return unless scale_type.diatonic?
 
     NAME_FOR_DIATONIC_DEGREE[degree] ||
-      ((scale_type.intervals.last == 1 || sign == "#") ? "leading tone" : "subtonic")
+      ((scale_type.intervals.last == 1 || alteration == "#") ? "leading tone" : "subtonic")
   end
 
   private

data/lib/head_music/scale_type.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A ScaleType represents a particular scale pattern, such as major, lydian, or minor pentatonic.
 class HeadMusic::ScaleType
   H = 1 # whole step

data/lib/head_music/solmization.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A scale degree is a number indicating the ordinality of the spelling in the key signature.
 # TODO: Rewrite to accept a tonal_center and a scale type.
 class HeadMusic::Solmization

data/lib/head_music/sonority.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A Sonority describes a set of pitch class intervalic relationships.
 # For example, a minor triad, or a major-minor seventh chord.
 # The Sonority class is a factory for returning one of its subclasses.

data/lib/head_music/spelling.rb

@@ -1,18 +1,16 @@
-# frozen_string_literal: true
-
 # Represents the spelling of a pitch, such as C# or Db.
-# Composite of a LetterName and an optional Sign.
+# Composite of a LetterName and an optional Alteration.
 # Does not include the octave. See Pitch for that.
 class HeadMusic::Spelling
-  MATCHER = /^\s*([A-G])(#{HeadMusic::Sign.matcher}?)(-?\d+)?\s*$/i
+  MATCHER = /^\s*([A-G])(#{HeadMusic::Alteration.matcher}?)(-?\d+)?\s*$/i
 
-  attr_reader :pitch_class, :letter_name, :sign
+  attr_reader :pitch_class, :letter_name, :alteration
 
   delegate :number, to: :pitch_class, prefix: true
   delegate :to_i, to: :pitch_class_number
   delegate :series_ascending, :series_descending, to: :letter_name, prefix: true
   delegate :enharmonic?, to: :enharmonic_equivalence
-  delegate :sharp?, :flat?, :double_sharp?, :double_flat?, to: :sign, allow_nil: true
+  delegate :sharp?, :flat?, :double_sharp?, :double_flat?, to: :alteration, allow_nil: true
 
   def self.get(identifier)
     return identifier if identifier.is_a?(HeadMusic::Spelling)
@@ -31,8 +29,8 @@ class HeadMusic::Spelling
     letter_name = HeadMusic::LetterName.get(letter_name)
     return nil unless letter_name
 
-    sign = HeadMusic::Sign.get(sign_string)
-    fetch_or_create(letter_name, sign)
+    alteration = HeadMusic::Alteration.get(sign_string)
+    fetch_or_create(letter_name, alteration)
   end
 
   def self.from_number(number)
@@ -46,26 +44,26 @@ class HeadMusic::Spelling
   def self.from_number_and_letter(number, letter_name)
     letter_name = HeadMusic::LetterName.get(letter_name)
     natural_letter_pitch_class = letter_name.pitch_class
-    sign_interval = natural_letter_pitch_class.smallest_interval_to(HeadMusic::PitchClass.get(number))
-    sign = HeadMusic::Sign.by(:semitones, sign_interval) if sign_interval != 0
-    fetch_or_create(letter_name, sign)
+    alteration_interval = natural_letter_pitch_class.smallest_interval_to(HeadMusic::PitchClass.get(number))
+    alteration = HeadMusic::Alteration.by(:semitones, alteration_interval) if alteration_interval != 0
+    fetch_or_create(letter_name, alteration)
   end
 
-  def self.fetch_or_create(letter_name, sign)
+  def self.fetch_or_create(letter_name, alteration)
     @spellings ||= {}
-    hash_key = [letter_name, sign].join
-    @spellings[hash_key] ||= new(letter_name, sign)
+    hash_key = [letter_name, alteration].join
+    @spellings[hash_key] ||= new(letter_name, alteration)
   end
 
-  def initialize(letter_name, sign = nil)
+  def initialize(letter_name, alteration = nil)
     @letter_name = HeadMusic::LetterName.get(letter_name.to_s)
-    @sign = HeadMusic::Sign.get(sign)
-    sign_semitones = @sign ? @sign.semitones : 0
-    @pitch_class = HeadMusic::PitchClass.get(letter_name.pitch_class + sign_semitones)
+    @alteration = HeadMusic::Alteration.get(alteration)
+    alteration_semitones = @alteration ? @alteration.semitones : 0
+    @pitch_class = HeadMusic::PitchClass.get(letter_name.pitch_class + alteration_semitones)
   end
 
   def name
-    [letter_name, sign].join
+    [letter_name, alteration].join
   end
 
   def to_s
@@ -82,7 +80,7 @@ class HeadMusic::Spelling
   end
 
   def natural?
-    !sign || sign.natural?
+    !alteration || alteration.natural?
   end
 
   private_class_method :new

data/lib/head_music/staff.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A staff is a set of lines and spaces that provides context for a pitch
 class HeadMusic::Staff
   DEFAULT_LINE_COUNT = 5

data/lib/head_music/style/analysis.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # A module for style analysis and guidelines.
 module HeadMusic::Style; end
 

data/lib/head_music/style/annotation.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # An Annotation encapsulates an issue with or comment on a voice
 class HeadMusic::Style::Annotation
   MESSAGE = "Write music."

data/lib/head_music/style/guidelines/always_move.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Module for style guidelines.
 module HeadMusic::Style::Guidelines; end
 

data/lib/head_music/style/guidelines/approach_perfection_contrarily.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Module for style guidelines.
 module HeadMusic::Style::Guidelines; end
 

data/lib/head_music/style/guidelines/at_least_eight_notes.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Module for style guidelines.
 module HeadMusic::Style::Guidelines; end
 

data/lib/head_music/style/guidelines/avoid_crossing_voices.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Module for style guidelines.
 module HeadMusic::Style::Guidelines; end
 

data/lib/head_music/style/guidelines/avoid_overlapping_voices.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Module for style guidelines.
 module HeadMusic::Style::Guidelines; end
 

data/lib/head_music/style/guidelines/consonant_climax.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Module for style guidelines.
 module HeadMusic::Style::Guidelines; end
 

data/lib/head_music/style/guidelines/consonant_downbeats.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Module for style guidelines.
 module HeadMusic::Style::Guidelines; end
 

data/lib/head_music/style/guidelines/diatonic.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Module for style guidelines.
 module HeadMusic::Style::Guidelines; end
 
@@ -17,7 +15,7 @@ class HeadMusic::Style::Guidelines::Diatonic < HeadMusic::Style::Annotation
     notes_not_in_key.reject do |note|
       penultimate_note &&
         note == penultimate_note &&
-        HeadMusic::ScaleDegree.new(key_signature, note.pitch.spelling).sign == "#"
+        HeadMusic::ScaleDegree.new(key_signature, note.pitch.spelling).alteration == "#"
     end
   end
 

data/lib/head_music/style/guidelines/direction_changes.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # Module for style guidelines.
 module HeadMusic::Style::Guidelines; end