tonal-tools 8.6.0 → 8.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25126d841103214bbe0a1fe1dcd861460ff4bf7b108ac3e0854032e037f64ab1
-  data.tar.gz: 3f3941c9a097f937d08f5c0b9fc1edec5df331b45d12599b0dcedfaa275ed6b4
+  metadata.gz: ad355622f7095fece5a99d754e0769935e66757f5d0fdae60ca21f9edfed35f3
+  data.tar.gz: 6b1ac2a795e4650a2dfc28634a05db3501e76cea05ff999b3958cebe63a37094
 SHA512:
-  metadata.gz: 4c8828863ca77987db6837fbbff67a8f74029d8b817418596a3a0ce6959fbd09ffb174a7dc4142a1d67ed8fadc5d85e3694ee87155c1ea064b6760cf73d3baae
-  data.tar.gz: 54122f26528a2fa0866abc7e9c2e23ffee7dbb64a8d9ed192c48c205b233b365b9064847d667a7e95cfd90b23f0424bc9799ff098426e27b4be727d45cc6c489
+  metadata.gz: 39fbd7a2445f7290f446f808e185c7291b6d7edf889e57cc5a6a8c7925a51940f9e374de6041dd92b03d244f65a1921b93d532e0fee211e467f6ce26dd926252
+  data.tar.gz: adcd55527c91b82f3723f32df38163c747aea3c492eb67d57a8a245a2565302f96cf1c84de2e91a33d533442da8ce88bf07c223789b957f48a965dc4deba926b

data/lib/tonal/attributions.rb

@@ -1,4 +1,4 @@
 module Tonal
   TOOLS_PRODUCER = "mTonal"
-  TOOLS_VERSION = "8.6.0"
+  TOOLS_VERSION = "8.8.0"
 end

data/lib/tonal/hertz.rb

@@ -1,6 +1,8 @@
 class Tonal::Hertz
   include Comparable
 
+  REFERENCE_FREQUENCY = 440.0
+
   attr_reader :value
 
   # @return [Tonal::Hertz]
@@ -18,7 +20,7 @@ class Tonal::Hertz
   #   Tonal::Hertz.reference => 440.0 Hz
   #
   def self.reference
-    self.new(440.0)
+    self.new(REFERENCE_FREQUENCY)
   end
 
   # @return [Rational] self as a rational
@@ -50,9 +52,10 @@ class Tonal::Hertz
   # @example
   #   Tonal::Hertz.new(440).to_midi => 69.0 MIDI
   # @param reference [Tonal::Hertz, Numeric] the reference frequency to compare to
+  # @param modulo [Integer] the modulo to use for the MIDI note calculation
   #
-  def to_midi_note
-    Tonal::Midi::Note.new(frequency: to_f)
+  def to_midi_note(modulo: Tonal::Midi::Note::DEFAULT_MODULO)
+    Tonal::Midi::Note.new(frequency: to_f, modulo: modulo)
   end
   alias :to_midi :to_midi_note
 

data/lib/tonal/midi.rb

@@ -2,37 +2,54 @@ module Tonal::Midi
   class Note
     include Comparable
 
-    REFERENCE_FREQUENCY = 440.0
     A4_MIDI_NUMBER = 69
+    C4_MIDI_NUMBER = 60
+    DEFAULT_MODULO = 12
 
-    attr_reader :number, :frequency
+    attr_reader :number, :modulo
 
     # @return [Tonal::Midi::Note]
     # @example
-    #   Tonal::Midi::Note.new(number:60) => 60.0 MIDI
-    # @param arg [Numeric, Tonal::Midi::Note]
+    #   Tonal::Midi::Note.new(number: 60) => 60 MIDI
+    #   Tonal::Midi::Note.new(frequency: 261.63) => 60 MIDI
+    # @param number [Integer, nil] the MIDI note number. Mutually exclusive with frequency:
+    # @param frequency [Numeric, Tonal::Hertz, nil] the frequency in Hz. Mutually exclusive with number:
+    # @param modulo [Integer] the number of steps per octave
     #
-    def initialize(number: A4_MIDI_NUMBER, frequency: nil)
+    def initialize(number: nil, frequency: nil, modulo: DEFAULT_MODULO)
+      raise ArgumentError, "Provide either number: or frequency:, not both" if number && frequency
+
+      @modulo = modulo
       if frequency
         raise ArgumentError, "Frequency argument is not Numeric or Tonal::Hertz" unless frequency.kind_of?(Numeric) || frequency.kind_of?(Tonal::Hertz)
         @frequency = Tonal::Hertz.new(frequency)
-        @number = (A4_MIDI_NUMBER + 12 * Math.log2(frequency.to_f / REFERENCE_FREQUENCY)).round
+        @number = (A4_MIDI_NUMBER + modulo * Math.log2(frequency.to_f / Tonal::Hertz::REFERENCE_FREQUENCY)).round
       else
+        number = A4_MIDI_NUMBER if number.nil?
         raise ArgumentError, "Number argument is not Integer" unless number.kind_of?(Integer)
-        @number = number.kind_of?(self.class) ? number.inspect : number
-        @frequency = Tonal::Hertz.new(REFERENCE_FREQUENCY * (2 ** ((number - A4_MIDI_NUMBER) / 12.0)))
+        @number = number
+        @frequency = Tonal::Hertz.new(Tonal::Hertz::REFERENCE_FREQUENCY * (2 ** ((number - A4_MIDI_NUMBER) / modulo.to_f)))
       end
     end
 
     alias :value :number
 
+    # @return [Float] the frequency corresponding to the MIDI note number
+    # @example
+    #   Tonal::Midi::Note.new(number:60).frequency => 261.6255653005986
+    # @param round [Integer, nil] the number of decimal places to round the frequency to, or nil for no rounding
+    #
+    def frequency(round: nil)
+      round ? @frequency.to_f.round(round) : @frequency.to_f
+    end
+
     # @return [String] representation of self
     def inspect
       "#{number} MIDI"
     end
 
     def <=>(other)
-      number <=> other.number
+      number <=> (other.kind_of?(self.class) ? other.number : other)
     end
   end
 end

data/lib/tonal/ratio.rb

@@ -174,6 +174,25 @@ class Tonal::Ratio
   end
   alias :cents :to_cents
 
+  # @return [Tonal::Hertz] the hertz of self with respect to a reference frequency
+  # @example
+  #   Tonal::Ratio.new(3,2).to_hertz => 660.0
+  # @param reference [Numeric] the reference frequency
+  #
+  def to_hertz(reference: Tonal::Hertz.reference)
+    Tonal::Hertz.new(reference.to_f * to_f)
+  end
+
+  # @return [Tonal::Midi::Note] the midi representation of self with respect to a reference frequency
+  # @example
+  #   Tonal::Ratio.new(3,2).to_midi => 76 MIDI
+  # @param reference [Numeric] the reference frequency
+  # @param modulo [Integer] the modulo for the MIDI note
+  #
+  def to_midi(reference: Tonal::Hertz.reference, modulo: Tonal::Midi::Note::DEFAULT_MODULO)
+    to_hertz(reference: reference).to_midi(modulo: modulo)
+  end
+
   # @return [Integer] the step of self in the given modulo
   # @example
   #   Tonal::ReducedRatio.new(3,2).step(12) => 7\12

data/lib/tonal/step.rb

@@ -58,6 +58,22 @@ class Tonal::Scale
       Tonal::Ratio.new(step, modulo)
     end
 
+    # @return the [Tonal::Midi::Note] representation of the step
+    #
+    # @example
+    #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).step_to_midi
+    #   => 78
+    #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 12).step_to_midi
+    #   => 67
+    #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 12).step_to_midi(midi_root: Tonal::Midi::Note::A4_MIDI_NUMBER)
+    #   => 76
+    #
+    # @param midi_root [Integer] the MIDI number that corresponds to the 0 step of the scale. Default is C4 (60 MIDI).
+    #
+    def step_to_midi(midi_root: Tonal::Midi::Note::C4_MIDI_NUMBER)
+      Tonal::Midi::Note.new(number: step + midi_root)
+    end
+
     # @return the [Rational] representation of the ratio of self
     # @example
     #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).ratio_to_r

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tonal-tools
 version: !ruby/object:Gem::Version
-  version: 8.6.0
+  version: 8.8.0
 platform: ruby
 authors:
 - Jose Hales-Garcia
 bindir: bin
 cert_chain: []
-date: 2026-05-26 00:00:00.000000000 Z
+date: 2026-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaml
@@ -193,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '3.1'
 requirements: []
-rubygems_version: 4.0.11
+rubygems_version: 4.0.14
 specification_version: 4
 summary: Tonal tools
 test_files: []