tonal-tools 8.5.3 → 8.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d35ccfb34bc36393de62b66954048131b48eff9a9aa0c3af8c9f5d97d79d8406
-  data.tar.gz: 16b2e4235caeaf796ddd7ceec8e6b881eb2291b4ec0f7f6389ac2faaca1fe243
+  metadata.gz: 65ae90958bc67835b5792e9d248eebf51ef5625f5bf3e1fa2da75064f76865d9
+  data.tar.gz: b9620ff46f3ded909da90d12af35326fa85387000f1432b768d8377b205f78c4
 SHA512:
-  metadata.gz: 6849510f855a326970cf7a7ad4ee619b05251b15331659192c4a7d1cf17a08eb64cdd55e70232300587f6f263cb906ddde329fba2d7923002b34f303f1ee4bd1
-  data.tar.gz: ab77a51fb2c82acf98fb1b65b1d33ace5baac0fbfc4c823140fb1a746995468f8cf3621824af17b07f0f099300dd7b4b244da4578711705e8a62f9d22c1976cd
+  metadata.gz: d73630cb8dec599a68d9f85731f676c3193d0f4f038f5757ace29a77ae8af65b5c74a5808f808605baa0e7392137b3200a4241b22f73870a788de4afb6c4f11a
+  data.tar.gz: 18977208ddb36b81b446e5559acf7e1618baf360fdf49f75b567e0c6407727077840846b0ce0ada874a428e1c2ae3d281abe484d4f0d27c115c905cc76c1b191

data/lib/tonal/attributions.rb

@@ -1,4 +1,4 @@
 module Tonal
   TOOLS_PRODUCER = "mTonal"
-  TOOLS_VERSION = "8.5.3"
+  TOOLS_VERSION = "8.7.0"
 end

data/lib/tonal/hertz.rb

@@ -10,7 +10,7 @@ class Tonal::Hertz
   #
   def initialize(arg)
     raise ArgumentError, "Argument is not Numeric or Tonal::Hertz" unless arg.kind_of?(Numeric) || arg.kind_of?(self.class)
-    @value = arg.kind_of?(self.class) ? arg.inspect : arg
+    @value = arg.kind_of?(self.class) ? arg.value : arg
   end
 
   # @return [Tonal::Hertz] 440 Hz
@@ -46,6 +46,16 @@ class Tonal::Hertz
     Tonal::Cents.new(ratio: to_r / reference.to_r)
   end
 
+  # @return [Tonal::Midi::Note] the midi representation of self
+  # @example
+  #   Tonal::Hertz.new(440).to_midi => 69.0 MIDI
+  # @param reference [Tonal::Hertz, Numeric] the reference frequency to compare to
+  #
+  def to_midi_note
+    Tonal::Midi::Note.new(frequency: to_f)
+  end
+  alias :to_midi :to_midi_note
+
   # @return [String] the string representation of Tonal::Hertz
   # @example
   #   Tonal::Hertz(1000.0).inspect => "1000.0 Hz"

data/lib/tonal/midi.rb

@@ -0,0 +1,39 @@
+module Tonal::Midi
+  class Note
+    include Comparable
+
+    REFERENCE_FREQUENCY = 440.0
+    A4_MIDI_NUMBER = 69
+    C4_MIDI_NUMBER = 60
+
+    attr_reader :number, :frequency
+
+    # @return [Tonal::Midi::Note]
+    # @example
+    #   Tonal::Midi::Note.new(number:60) => 60.0 MIDI
+    # @param arg [Numeric, Tonal::Midi::Note]
+    #
+    def initialize(number: A4_MIDI_NUMBER, frequency: nil)
+      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
+      else
+        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)))
+      end
+    end
+
+    alias :value :number
+
+    # @return [String] representation of self
+    def inspect
+      "#{number} MIDI"
+    end
+
+    def <=>(other)
+      number <=> (other.kind_of?(self.class) ? other.number : other)
+    end
+  end
+end

data/lib/tonal/step.rb

@@ -29,7 +29,7 @@ class Tonal::Scale
     end
     alias :to_s :inspect
 
-    # @return [Tonal::Scale::Step] new step with the ratio mapped to the new modulo
+    # @return a new [Tonal::Scale::Step] with the ratio mapped to the new modulo
     # @example
     #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).convert(12)
     #   => 7\12
@@ -38,7 +38,7 @@ class Tonal::Scale
       self.class.new(log: log, modulo: new_modulo)
     end
 
-    # @return [Rational] of the step
+    # @return the [Rational] representation of the step/modulo of self
     # @example
     #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).step_to_r
     #   => (18/31)
@@ -49,7 +49,7 @@ class Tonal::Scale
       Rational(step, modulo)
     end
 
-    # @return [Tonal::Ratio] of the step/modulo
+    # @return the [Tonal::Ratio] representation of the step/modulo of self
     # @example
     #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).step_to_ratio
     #   => 18/31
@@ -58,7 +58,23 @@ class Tonal::Scale
       Tonal::Ratio.new(step, modulo)
     end
 
-    # @return [Rational] of the ratio
+    # @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
     #   => (3/2)
@@ -67,7 +83,7 @@ class Tonal::Scale
       ratio.to_r
     end
 
-    # @return [Tonal::Cents] measure of tempered in cents
+    # @return the [Tonal::Cents] measure of tempered in cents
     # @example
     #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).tempered_to_cents
     #   => 696.77
@@ -76,7 +92,7 @@ class Tonal::Scale
       tempered.to_cents
     end
 
-    # @return [Tonal::Cents] measure of ratio in cents
+    # @return the [Tonal::Cents] measure of ratio in cents
     # @example
     #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).ratio_to_cents
     #   => 701.96
@@ -85,7 +101,7 @@ class Tonal::Scale
       ratio.to_cents
     end
 
-    # @return [Tonal::Cents] the difference between the tempered number and the ratio
+    # @return the [Tonal::Cents] measure of the difference between the tempered number and the ratio
     # @example
     #   Tonal::Scale::Step.new(ratio: 3/2r, modulo: 31).efficiency => 5.19 ¢
     #
@@ -104,6 +120,10 @@ class Tonal::Scale
       step.coprime?(modulo)
     end
 
+    # @return a new [Tonal::Scale::Step] with the step added to the current step
+    # @example
+    #   Tonal::Scale::Step.new(step: 5, modulo: 12) + Tonal::Scale::Step.new(step: 7, modulo: 12) => 0\12
+    #
     def +(rhs)
       self.class.new(step: (rhs % modulo), modulo: modulo)
     end

data/lib/tonal/tools.rb

@@ -12,6 +12,7 @@ module Tonal
   require "tonal/log"
   require "tonal/log2"
   require "tonal/approximation"
+  require "tonal/midi"
   require "tonal/ratio"
   require "tonal/reduced_ratio"
   require "tonal/extended_ratio"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tonal-tools
 version: !ruby/object:Gem::Version
-  version: 8.5.3
+  version: 8.7.0
 platform: ruby
 authors:
 - Jose Hales-Garcia
 bindir: bin
 cert_chain: []
-date: 2026-05-03 00:00:00.000000000 Z
+date: 2026-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaml
@@ -168,6 +168,7 @@ files:
 - lib/tonal/irb_helpers.rb
 - lib/tonal/log.rb
 - lib/tonal/log2.rb
+- lib/tonal/midi.rb
 - lib/tonal/ratio.rb
 - lib/tonal/reduced_ratio.rb
 - lib/tonal/step.rb