head_music 0.23.2 → 0.24.2

data/lib/head_music/data/instruments.yml

@@ -0,0 +1,36 @@
+---
+- name_key: alto_flute
+- name_key: guitar
+  family: string
+  classifications:
+  - string
+  - chordophone
+  default_clefs:
+  - treble_clef
+- name_key: piano
+  family: string
+  classifications:
+  - string
+  - chordophone
+  - keyboard
+  default_clefs:
+  - treble_clef
+  - bass_clef
+- name_key: violin
+  alias_name_keys:
+  - fiddle
+  family: string
+  classifications:
+  - string
+  - chordophone
+  - bowed
+  default_clefs:
+  - treble_clef
+- name_key: viola
+  family: string
+  classifications:
+  - string
+  - chordophone
+  - bowed
+  default_clefs:
+  - alto_clef

data/lib/head_music/diatonic_interval.rb

@@ -4,6 +4,7 @@
 class HeadMusic::DiatonicInterval
   include Comparable
 
+  # TODO: include Named module
   NUMBER_NAMES = %w[
     unison second third fourth fifth sixth seventh octave
     ninth tenth eleventh twelfth thirteenth fourteenth fifteenth
@@ -280,6 +281,8 @@ class HeadMusic::DiatonicInterval
     to: :naming
   )
 
+  alias to_i semitones
+
   # Accepts a name and returns the interval with middle c on the bottom
   def self.get(identifier)
     name = Parser.new(identifier)

data/lib/head_music/grand_staff.rb

@@ -6,16 +6,16 @@ class HeadMusic::GrandStaff
     piano: {
       instrument: :piano,
       staves: [
-        { clef: :treble, instrument: :piano },
-        { clef: :bass, instrument: :piano },
+        { clef: :treble_clef, instrument: :piano },
+        { clef: :bass_clef, instrument: :piano },
       ],
     },
     organ: {
       instrument: :organ,
       staves: [
-        { clef: :treble, instrument: :organ },
-        { clef: :bass, instrument: :organ },
-        { clef: :bass, instrument: :pedals },
+        { clef: :treble_clef, instrument: :organ },
+        { clef: :bass_clef, instrument: :organ },
+        { clef: :bass_clef, instrument: :pedals },
       ],
     },
   }.freeze
@@ -41,7 +41,12 @@ class HeadMusic::GrandStaff
 
   def staves
     @staves ||=
-      data[:staves].map { |staff| HeadMusic::Staff.new(staff[:clef], instrument: staff[:instrument] || instrument) }
+      data[:staves].map do |staff|
+        HeadMusic::Staff.new(
+          staff[:clef],
+          instrument: staff[:instrument] || instrument
+        )
+      end
   end
 
   def brace_staves_index_first

data/lib/head_music/instrument.rb

@@ -2,46 +2,59 @@
 
 # An instrument can be assigned to a staff.
 class HeadMusic::Instrument
-  include HeadMusic::NamedRudiment
-
-  INSTRUMENTS = {
-    violin: {
-      name: 'violin',
-      family: :string,
-      default_clef: :treble,
-    },
-    piano: {
-      name: 'piano',
-      family: :string,
-      default_system: %i[treble bass],
-    },
-  }.freeze
+  include HeadMusic::Named
+
+  INSTRUMENTS = YAML.load_file(File.expand_path('data/instruments.yml', __dir__)).freeze
 
   def self.get(name)
-    get_by_name(name)
+    return get_by_name(name) if get_by_name(name)
+    return get_by_name(key_for_name(name)) if key_for_name(name)
+
+    new(name)
   end
 
-  def initialize(name)
-    @name = name.to_s
+  attr_reader :name_key, :family, :default_clefs
+
+  def ==(other)
+    to_s == other.to_s
   end
 
-  def data
-    @data ||= INSTRUMENTS[hash_key]
+  private_class_method :new
+
+  private
+
+  def initialize(name)
+    record = record_for_name(name)
+    if record
+      initialize_data_from_record(record)
+    else
+      self.name = name
+    end
   end
 
-  def family
-    data[:family]
+  def record_for_name(name)
+    key = HeadMusic::Utilities::HashKey.for(name)
+    record_for_key(key) || record_for_key(key_for_name(name))
   end
 
-  def default_system
-    data[:default_system]
+  def key_for_name(name)
+    INSTRUMENTS.each do |instrument|
+      I18n.config.available_locales.each do |locale|
+        translation = I18n.t("instruments.#{instrument['name_key']}", locale: locale)
+        return instrument['name_key'] if translation.downcase == name.downcase
+      end
+    end
+    nil
   end
 
-  def default_clef
-    data[:default_clef]
+  def record_for_key(key)
+    INSTRUMENTS.detect { |instrument| instrument['name_key'] == key }
   end
 
-  def ==(other)
-    to_s == other.to_s
+  def initialize_data_from_record(record)
+    @family = record['family']
+    @default_clefs = record['default_clefs']
+    @name_key = record['name_key'].to_sym
+    self.name = I18n.translate(name_key, scope: 'instruments', locale: 'en')
   end
 end

data/lib/head_music/interval_cycle.rb

@@ -2,35 +2,56 @@
 
 # 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
+
   def self.get(interval = 7)
-    @circles ||= {}
+    @interval_cycles ||= {}
     interval = interval.to_s.gsub(/^C/i, '').to_i
-    @circles[interval.to_i] ||= new(interval)
+    interval = HeadMusic::ChromaticInterval.get(interval)
+    @interval_cycles[interval.to_i] ||= new(interval: interval, starting_pitch: 'C4')
   end
 
-  attr_reader :interval, :pitch_classes
+  def initialize(interval:, starting_pitch: 'C4')
+    @interval = interval if interval.is_a?(HeadMusic::DiatonicInterval)
+    @interval ||= interval if interval.is_a?(HeadMusic::ChromaticInterval)
+    @interval ||= HeadMusic::ChromaticInterval.get(interval) if interval.to_s.match?(/\d/)
+    @interval ||= HeadMusic::DiatonicInterval.get(interval)
+    @starting_pitch = HeadMusic::Pitch.get(starting_pitch)
+  end
 
-  def initialize(interval)
-    @interval = interval.to_i
-    @pitch_classes = pitch_classes_by_interval
+  def pitches
+    @pitches ||= pitches_up
   end
 
-  def index(pitch_class)
-    @pitch_classes.index(HeadMusic::Spelling.get(pitch_class).pitch_class)
+  def pitch_classes
+    @pitch_classes ||= pitches.map(&:pitch_class)
   end
 
-  private_class_method :new
+  def pitch_class_set
+    @pitch_class_set ||= HeadMusic::PitchClassSet.new(pitches)
+  end
 
-  private
+  def spellings
+    @spellings ||= pitches.map(&:spelling)
+  end
 
-  def pitch_classes_by_interval
-    [HeadMusic::PitchClass.get(0)].tap do |list|
-      loop do
-        next_pitch_class = list.last + interval
-        break if next_pitch_class == list.first
+  protected
 
-        list << next_pitch_class
+  def pitches_up
+    @pitches_up ||= begin
+      [starting_pitch].tap do |list|
+        loop do
+          next_pitch = list.last + interval
+          next_pitch -= octave while next_pitch - starting_pitch > 12
+          break if next_pitch.pitch_class == list.first.pitch_class
+
+          list << next_pitch
+        end
       end
     end
   end
+
+  def octave
+    @octave ||= HeadMusic::DiatonicInterval.get(:perfect_octave)
+  end
 end

data/lib/head_music/key_signature.rb

@@ -6,8 +6,8 @@ class HeadMusic::KeySignature
   attr_reader :scale_type
   attr_reader :scale
 
-  SHARPS = %w[F♯ C♯ G♯ D♯ A♯ E♯ B♯].freeze
-  FLATS = %w[B♭ E♭ A♭ D♭ G♭ C♭ F♭].freeze
+  ORDERED_LETTER_NAMES_OF_SHARPS = %w[F C G D A E B].freeze
+  ORDERED_LETTER_NAMES_OF_FLATS = ORDERED_LETTER_NAMES_OF_SHARPS.reverse.freeze
 
   def self.default
     @default ||= new('C', :major)
@@ -39,19 +39,35 @@ class HeadMusic::KeySignature
   end
 
   def sharps
-    spellings.select(&:sharp?).sort_by { |sharp| SHARPS.index(sharp.to_s) }
+    spellings.select(&:sharp?).sort_by do |spelling|
+      ORDERED_LETTER_NAMES_OF_SHARPS.index(spelling.letter_name.to_s)
+    end
+  end
+
+  def double_sharps
+    spellings.select(&:double_sharp?).sort_by do |spelling|
+      ORDERED_LETTER_NAMES_OF_SHARPS.index(spelling.letter_name.to_s)
+    end
   end
 
   def flats
-    spellings.select(&:flat?).sort_by { |flat| FLATS.index(flat.to_s) }
+    spellings.select(&:flat?).sort_by do |spelling|
+      ORDERED_LETTER_NAMES_OF_FLATS.index(spelling.letter_name.to_s)
+    end
+  end
+
+  def double_flats
+    spellings.select(&:double_flat?).sort_by do |spelling|
+      ORDERED_LETTER_NAMES_OF_FLATS.index(spelling.letter_name.to_s)
+    end
   end
 
   def num_sharps
-    sharps.length
+    sharps.length + double_sharps.length * 2
   end
 
   def num_flats
-    flats.length
+    flats.length + double_flats.length * 2
   end
 
   def signs

data/lib/head_music/locales/de.yml

@@ -0,0 +1,63 @@
+de:
+  rudiments:
+    clef: Notenschlüssel
+    consonance: Konsonanz
+  clefs:
+    alto_clef: Altschlüssel
+    baritone_c_clef: Baritonschlüssel
+    baritone_clef: Baritonschlüssel
+    baritone_f_clef: Baritonschlüssel
+    bass_clef: Bassschlüssel
+    c_clef: C-Schlüssel
+    choral_tenor_clef: oktavierten Violinschlüssel
+    contrabass_clef: contrabass clef
+    countertenor_clef: countertenor clef
+    double_treble_clef: double treble clef
+    drum_clef: Schlagzeugschlüssel
+    f_clef: F-Schlüssel
+    fifth_line_c_clef: fifth-line C-clef
+    fifth_line_f_clef: fifth-line F-clef
+    first_line_c_clef: Sopranschlüssel
+    first_line_g_clef: first-line G-clef
+    fourth_line_c_clef: fourth-line C-clef
+    fourth_line_f_clef: fourth-line F-clef
+    french_clef: French clef
+    french_violin_clef: French violin clef
+    g_clef: G-Schlüssel
+    indefinite_pitch_clef: indefinite pitch clef
+    mezzo_soprano_clef: Mezzosopranschlüssel
+    neutral_clef: Schlagzeugschlüssel
+    percussion_clef: Schlagzeugschlüssel
+    second_line_c_clef: second-line C-clef
+    second_line_g_clef: second-line G-clef
+    soprano_clef: Sopranschlüssel
+    sub_bass_clef: Subbassschlüssel
+    tenor_c_clef: Tenorschlüssel
+    tenor_clef: Tenorschlüssel
+    tenor_g_clef: tenor G-clef
+    third_line_c_clef: third-line C-clef
+    third_line_f_clef: third-line F-clef
+    treble_clef: Violinschlüssel
+    viola_clef: Bratschenschlüssel
+    violin_clef: Violinschlüssel
+  reference_pitches:
+    chamber_tone: Kammerton
+    choir_tone: Chorton
+  instruments:
+    accordian: Akkordeon
+    alto_flute: Altflöte
+    alto_voice: Alt
+    arpeggione: Arpeggione
+    bagpipe: Dudelsack
+    baritone_voice: Bariton
+    bass_voice: Bass
+    bass_clarinet: clarinette basse
+    fiddle: Geige
+    guitar: Gitarre
+    piano: Piano
+    viola: Bratsche
+    violin: Violine
+  instrument_voices:
+    alto: Alt
+    baritone: Bariton
+    bass: Bass

data/lib/head_music/locales/en.yml

@@ -0,0 +1,198 @@
+en:
+  rudiments:
+    chromatic_interval: chromatic interval
+    circle: circle
+    clef: clef
+    consonance: consonance
+    diatonic_interval: diatonic interval
+    grand_staff: grand staff
+    harmonic_interval: harmonic interval
+    instrument: instrument
+    interval_cycle: interval cycle
+    key_signature: key signature
+    letter_name: letter name
+    melodic_interval: melodic interval
+    meter: meter
+    motion: motion
+    musical_symbol: musical symbol
+    octave: octave
+    pitch: pitch
+    pitch_class: pitch class
+    pitch_class_set: pitch class set
+    pitch_set: pitch set
+    quality: quality
+    reference_pitch: reference pitch
+    rhythm: rhythm
+    rhythmic_unit: rhythmic unit
+    scale: scale
+    scale_degree: scale degree
+    scale_type: scale type
+    sign: sign
+    solmization: solmization
+    sonority: sonority
+    spelling: spelling
+    staff: staff
+    tuning: tuning
+  clefs:
+    alto_clef: alto clef
+    baritone_c_clef: baritone C-clef
+    baritone_clef: baritone clef
+    baritone_f_clef: baritone F-clef
+    bass_clef: bass clef
+    c_clef: C-clef
+    choral_tenor_clef: choral tenor clef
+    contrabass_clef: contrabass clef
+    countertenor_clef: countertenor clef
+    double_treble_clef: double treble clef
+    drum_clef: drum clef
+    f_clef: F-clef
+    fifth_line_c_clef: fifth-line C-clef
+    fifth_line_f_clef: fifth-line F-clef
+    first_line_c_clef: first-line C-clef
+    first_line_g_clef: first-line G-clef
+    fourth_line_c_clef: fourth-line C-clef
+    fourth_line_f_clef: fourth-line F-clef
+    french_clef: French clef
+    french_violin_clef: French violin clef
+    g_clef: G-clef
+    indefinite_pitch_clef: indefinite pitch clef
+    mezzo_soprano_clef: mezzo-soprano clef
+    neutral_clef: neutral clef
+    percussion_clef: percussion clef
+    second_line_c_clef: second-line C-clef
+    second_line_g_clef: second-line G-clef
+    soprano_clef: soprano clef
+    sub_bass_clef: sub-bass clef
+    tenor_c_clef: tenor C-clef
+    tenor_clef: tenor clef
+    tenor_g_clef: tenor G-clef
+    third_line_c_clef: third-line C-clef
+    third_line_f_clef: third-line F-clef
+    treble_clef: treble clef
+    viola_clef: viola clef
+    violin_clef: treble clef
+  reference_pitches:
+    a440: A440
+    baroque: Baroque pitch
+    berlin_philharmonic: Berlin Philharmonic
+    boston_symphony_orchestra: Boston Symphony Orchestra
+    chamber_tone: chamber tone
+    choir: choir tone
+    classical: classical pitch
+    concert: concert pitch
+    continental: continental pitch
+    french: French pitch
+    haydn: Haydn pitch
+    high: high pitch
+    international: international pitch
+    iso_16: ISO 16
+    low: low pitch
+    mozart: Mozart pitch
+    new_philharmonic: new philharmonic pitch
+    new_york_philharmonic: New York Philharmonic
+    old_philharmonic: old philharmonic pitch
+    philosophical: philosophical pitch
+    sauveur: Sauveur pitch
+    scheibler: Scheibler pitch
+    scientific: scientific pitch
+    stuttgart: Stuttgart pitch
+    sydney_symphony_orchestra: Sydney Symphony Orchestra
+    verdi: Verdi tuning
+  instruments:
+    accordian: accordian
+    alto_flute: alto flute
+    alto_voice: alto
+    arpeggione: arpeggione
+    bagpipe: bagpipe
+    baritone_voice: baritone
+    bass_clarinet: bass clarinet
+    bass_drum: bass drum
+    bass_guitar: bass guitar
+    bass_oboe: bass oboe
+    bass_trombone: bass trombone
+    bass_tuba: bass tuba
+    bass_voice: bass
+    bassoon: bassoon
+    castanets: castanets
+    chimes: chimes
+    clarinet: clarinet
+    clash_cymbals: clash cymbals
+    cornet: cornet
+    contrabassoon: contrabassoon
+    contra_bass_clarinet: contra bass clarinet
+    cor_anglais: cor anglais
+    cowbell: cowbell
+    cymbal: cymbal
+    crotales: crotales
+    double_bass: double bass
+    english_horn: English horn
+    euphonium: euphonium
+    flugel_horn: flugel horn
+    flute: flute
+    french_horn: French horn
+    glockenspiel: glockenspiel
+    guitar: guitar
+    harp: harp
+    harpsichord: harpsichord
+    mandolin: mandolin
+    maracas: maracas
+    marimba: marimba
+    metal_block: metal block
+    oboe: oboe
+    piano: piano
+    piccolo: piccolo
+    piccolo_trumpet: piccolo trumpet
+    side_drum: side drum
+    suspended_cymbal: suspended cymbal
+    synthesizer: synthesizer
+    tam_tam: tam-tam
+    tambourine: tambourine
+    temple_blocks: temple blocks
+    tenor_drum: tenor drum
+    tenor_trombone: tenor trombone
+    timpani: timpani
+    triangle: triangle
+    trumpet: trumpet
+    tuba: tuba
+    tubular_bells: tubular bells
+    vibraphone: vibraphone
+    viola: viola
+    violin: violin
+    violincello: cello
+    woodblock: woodblock
+    xylophone: xylophone
+  instrument_abbreviations:
+    accordian:
+    - acc
+    alto_flute:
+    - afl
+    alto_voice:
+    - alt
+    bagpipe:
+    - bag
+    baritone_voice:
+    - bar
+    bass_voice:
+    - bass
+    bass_clarinet:
+    - bcl
+  instrument_classifications:
+    aerophone: aerophone
+    bowed: bowed
+    brass: brass
+    double_reed: double-reed
+    keyboard: keyboard
+    percussion: percussion
+    single_reed: single-reed
+    string: string
+    wind: wind
+    woodwind: woodwind
+  instrument_voices:
+    piccolo: piccolo
+    soprano: soprano
+    alto: alto
+    tenor: tenor
+    baritone: baritone
+    bass: bass
+    contrabass: contrabass
+    octobass: octobass