head_music 8.3.0 → 11.0.0

data/lib/head_music/instruments/instrument_configuration_option.rb

@@ -0,0 +1,38 @@
+module HeadMusic::Instruments; end
+
+# An option for an instrument configuration.
+#
+# Examples:
+#   - Piccolo trumpet leadpipe: "a" option with transposition_semitones: -1
+#   - Bass trombone F attachment: "engaged" option with lowest_pitch_semitones: -6
+#   - Trumpet mute: "straight", "cup", "harmon" options (no pitch effects)
+class HeadMusic::Instruments::InstrumentConfigurationOption
+  attr_reader :name_key, :default, :transposition_semitones, :lowest_pitch_semitones
+
+  def initialize(name_key:, default: false, transposition_semitones: nil, lowest_pitch_semitones: nil)
+    @name_key = name_key.to_sym
+    @default = default
+    @transposition_semitones = transposition_semitones
+    @lowest_pitch_semitones = lowest_pitch_semitones
+  end
+
+  def default?
+    @default == true
+  end
+
+  def affects_transposition?
+    !transposition_semitones.nil?
+  end
+
+  def affects_range?
+    !lowest_pitch_semitones.nil?
+  end
+
+  def ==(other)
+    to_s == other.to_s
+  end
+
+  def to_s
+    name_key.to_s
+  end
+end

data/lib/head_music/instruments/instrument_configurations.yml

@@ -0,0 +1,288 @@
+# Instrument configurations define optional equipment or settings
+# that modify an instrument's characteristics.
+#
+# Structure:
+#   instrument_key:
+#     configuration_name:
+#       options:
+#         option_name:
+#           default: true/false
+#           transposition_semitones: integer (optional)
+#           lowest_pitch_semitones: integer (optional)
+
+piccolo_trumpet:
+  leadpipe:
+    options:
+      b_flat:
+        default: true
+      a:
+        transposition_semitones: -1
+
+trumpet:
+  mute:
+    options:
+      open:
+        default: true
+      straight:
+      cup:
+      harmon:
+      bucket:
+      plunger:
+
+trombone:
+  mute:
+    options:
+      open:
+        default: true
+      straight:
+      cup:
+      harmon:
+      bucket:
+      plunger:
+
+bass_trombone:
+  f_attachment:
+    options:
+      disengaged:
+        default: true
+      engaged:
+        lowest_pitch_semitones: -6
+  mute:
+    options:
+      open:
+        default: true
+      straight:
+      bucket:
+
+cornet:
+  mute:
+    options:
+      open:
+        default: true
+      straight:
+      cup:
+      harmon:
+      bucket:
+      plunger:
+
+flugelhorn:
+  mute:
+    options:
+      open:
+        default: true
+      straight:
+      cup:
+      bucket:
+
+french_horn:
+  mute:
+    options:
+      open:
+        default: true
+      straight:
+      stopping:
+
+euphonium:
+  mute:
+    options:
+      open:
+        default: true
+      straight:
+
+baritone_horn:
+  mute:
+    options:
+      open:
+        default: true
+      straight:
+
+tuba:
+  mute:
+    options:
+      open:
+        default: true
+      straight:
+
+sousaphone:
+  mute:
+    options:
+      open:
+        default: true
+      straight:
+
+violin:
+  mute:
+    options:
+      open:
+        default: true
+      orchestral:
+
+viola:
+  mute:
+    options:
+      open:
+        default: true
+      orchestral:
+
+cello:
+  mute:
+    options:
+      open:
+        default: true
+      orchestral:
+
+double_bass:
+  c_extension:
+    options:
+      without:
+        default: true
+      with:
+        lowest_pitch_semitones: -4
+  mute:
+    options:
+      open:
+        default: true
+      orchestral:
+
+natural_horn:
+  crook:
+    options:
+      f:
+        default: true
+      e_flat:
+        transposition_semitones: -1
+      e:
+        transposition_semitones: -2
+      d:
+        transposition_semitones: -3
+      c:
+        transposition_semitones: -5
+      b_flat_basso:
+        transposition_semitones: -7
+
+guitar:
+  capo:
+    options:
+      none:
+        default: true
+      fret_1:
+        transposition_semitones: 1
+      fret_2:
+        transposition_semitones: 2
+      fret_3:
+        transposition_semitones: 3
+      fret_4:
+        transposition_semitones: 4
+      fret_5:
+        transposition_semitones: 5
+      fret_6:
+        transposition_semitones: 6
+      fret_7:
+        transposition_semitones: 7
+      fret_8:
+        transposition_semitones: 8
+      fret_9:
+        transposition_semitones: 9
+
+banjo:
+  capo:
+    options:
+      none:
+        default: true
+      fret_1:
+        transposition_semitones: 1
+      fret_2:
+        transposition_semitones: 2
+      fret_3:
+        transposition_semitones: 3
+      fret_4:
+        transposition_semitones: 4
+      fret_5:
+        transposition_semitones: 5
+      fret_6:
+        transposition_semitones: 6
+      fret_7:
+        transposition_semitones: 7
+      fret_8:
+        transposition_semitones: 8
+      fret_9:
+        transposition_semitones: 9
+
+ukulele:
+  capo:
+    options:
+      none:
+        default: true
+      fret_1:
+        transposition_semitones: 1
+      fret_2:
+        transposition_semitones: 2
+      fret_3:
+        transposition_semitones: 3
+      fret_4:
+        transposition_semitones: 4
+      fret_5:
+        transposition_semitones: 5
+      fret_6:
+        transposition_semitones: 6
+      fret_7:
+        transposition_semitones: 7
+      fret_8:
+        transposition_semitones: 8
+      fret_9:
+        transposition_semitones: 9
+      fret_10:
+        transposition_semitones: 10
+      fret_11:
+        transposition_semitones: 11
+      fret_12:
+        transposition_semitones: 12
+
+mandolin:
+  capo:
+    options:
+      none:
+        default: true
+      fret_1:
+        transposition_semitones: 1
+      fret_2:
+        transposition_semitones: 2
+      fret_3:
+        transposition_semitones: 3
+      fret_4:
+        transposition_semitones: 4
+      fret_5:
+        transposition_semitones: 5
+      fret_6:
+        transposition_semitones: 6
+      fret_7:
+        transposition_semitones: 7
+      fret_8:
+        transposition_semitones: 8
+      fret_9:
+        transposition_semitones: 9
+
+
+lute:
+  tied_fret:
+    options:
+      none:
+        default: true
+      fret_1:
+        transposition_semitones: 1
+      fret_2:
+        transposition_semitones: 2
+      fret_3:
+        transposition_semitones: 3
+      fret_4:
+        transposition_semitones: 4
+      fret_5:
+        transposition_semitones: 5
+      fret_6:
+        transposition_semitones: 6
+      fret_7:
+        transposition_semitones: 7
+      fret_8:
+        transposition_semitones: 8
+      fret_9:
+        transposition_semitones: 9

data/lib/head_music/instruments/instrument_families.yml

@@ -7,6 +7,12 @@ accordion:
     - keyboard
     - wind
   orchestra_section_key: keyboard
+arpeggione:
+  classification_keys:
+    - bowed
+    - chordophone
+    - string
+  orchestra_section_key: string
 bagpipe:
   classification_keys:
     - aerophone
@@ -14,6 +20,12 @@ bagpipe:
     - wind
     - woodwind
   orchestra_section_key: woodwind
+banjo:
+  classification_keys:
+    - plucked
+    - chordophone
+    - string
+  orchestra_section_key: string
 bass_drum:
   classification_keys:
     - percussion
@@ -28,6 +40,11 @@ bassoon:
     - wind
     - woodwind
   orchestra_section_key: woodwind
+castanets:
+  classification_keys:
+    - percussion
+    - idiophone
+  orchestra_section_key: percussion
 celesta:
   classification_keys:
     - idiophone
@@ -51,6 +68,11 @@ clavichord:
     - keyboard
     - string
   orchestra_section_key: keyboard
+chimes:
+  classification_keys:
+    - percussion
+    - idiophone
+  orchestra_section_key: percussion
 cornet:
   classification_keys:
     - aerophone
@@ -58,6 +80,16 @@ cornet:
     - valve
     - wind
   orchestra_section_key: brass
+cowbell:
+  classification_keys:
+    - percussion
+    - idiophone
+  orchestra_section_key: percussion
+crotales:
+  classification_keys:
+    - percussion
+    - idiophone
+  orchestra_section_key: percussion
 cymbal:
   classification_keys:
     - percussion
@@ -75,6 +107,13 @@ double_bass:
     - unfretted
     - string
   orchestra_section_key: string
+drum_kit:
+  classification_keys:
+    - percussion
+    - membranophone
+    - idiophone
+    - unpitched
+  orchestra_section_key: percussion
 flute:
   classification_keys:
     - aerophone
@@ -105,6 +144,13 @@ guitar:
     - fretted
     - string
   orchestra_section_key: string
+hammered_dulcimer:
+  classification_keys:
+    - percussion
+    - chordophone
+    - string
+    - struck
+  orchestra_section_key: percussion
 harmonica:
   classification_keys:
     - reed
@@ -124,6 +170,12 @@ harpsichord:
     - keyboard
     - string
   orchestra_section_key: keyboard
+hi_hat:
+  classification_keys:
+    - percussion
+    - idiophone
+    - unpitched
+  orchestra_section_key: percussion
 horn:
   classification_keys:
     - aerophone
@@ -151,6 +203,12 @@ mandolin:
     - fretted
     - string
   orchestra_section_key: string
+maracas:
+  classification_keys:
+    - percussion
+    - shaken
+    - idiophone
+  orchestra_section_key: percussion
 marimba:
   classification_keys:
     - idiophone
@@ -243,9 +301,28 @@ tambourine:
     - idiophone
     - unpitched
   orchestra_section_key: percussion
+tenor_drum:
+  classification_keys:
+    - percussion
+    - struck
+    - membranophone
+  orchestra_section_key: percussion
 theremin:
   classification_keys:
     - electronic
+tom_tom:
+  classification_keys:
+    - percussion
+    - membranophone
+    - struck
+    - unpitched
+  orchestra_section_key: percussion
+triangle:
+  classification_keys:
+    - percussion
+    - struck
+    - idiophone
+  orchestra_section_key: percussion
 trombone:
   classification_keys:
     - aerophone

data/lib/head_music/instruments/instrument_family.rb

@@ -1,10 +1,20 @@
-# Namespace for instrument definitions, categorization, and configuration
 module HeadMusic::Instruments; end
 
 # An *InstrumentFamily* is a species of instrument
 # that may exist in a variety of keys or other variations.
-# For example, _saxophone_ is an instrument family, while
-# _alto saxophone_ and _baritone saxophone_ are specific instruments.
+# For example:
+# - _saxophone_ is an instrument family, while
+#   _alto saxophone_ and _baritone saxophone_ are specific instruments.
+# - _oboe_ is an instrument family, while
+#   _oboe d'amore_ and _English horn_ are specific instruments.
+#
+# Instrument families are categorized by:
+# - orchestra section (e.g. woodwind, brass, percussion, strings)
+# - classification (e.g. bowed string, plucked string, double reed, single reed, brass, keyboard, electronic, percussion)
+#
+# Instrument families are defined in `lib/head_music/instruments/instrument_families.yml`.
+#
+# @see HeadMusic::Instruments::Instrument
 class HeadMusic::Instruments::InstrumentFamily
   include HeadMusic::Named
 
@@ -20,8 +30,8 @@ class HeadMusic::Instruments::InstrumentFamily
   end
 
   def self.all
-    @all ||=
-      INSTRUMENT_FAMILIES.map { |key, _data| get(key) }.sort_by(&:name)
+    INSTRUMENT_FAMILIES.map { |key, _data| get(key) }
+    @all ||= @instances.values.compact.sort_by(&:name)
   end
 
   private_class_method :new