tonal-tools 8.7.0 → 8.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65ae90958bc67835b5792e9d248eebf51ef5625f5bf3e1fa2da75064f76865d9
-  data.tar.gz: b9620ff46f3ded909da90d12af35326fa85387000f1432b768d8377b205f78c4
+  metadata.gz: 6a2b3699a8ff06f96c208824d04c62c5ea28db3915bcabf73d0ff0860fbf677f
+  data.tar.gz: e5fb5120820a4bf96d4489cdf0034a43de897d7dab7a040d6cfc94698ec6bb7e
 SHA512:
-  metadata.gz: d73630cb8dec599a68d9f85731f676c3193d0f4f038f5757ace29a77ae8af65b5c74a5808f808605baa0e7392137b3200a4241b22f73870a788de4afb6c4f11a
-  data.tar.gz: 18977208ddb36b81b446e5559acf7e1618baf360fdf49f75b567e0c6407727077840846b0ce0ada874a428e1c2ae3d281abe484d4f0d27c115c905cc76c1b191
+  metadata.gz: d85688a692e9cdf24bc776d2da3faf817015c9b72d31f2c5a4000f05a29db97bf3c13b78307c92496bd9fac1a3a1da9d34a02f250792af25aaf890a5f646d723
+  data.tar.gz: 0a21eff54af842f1a640d4fe6b6081a4679359c72f4e03fb06c782724c573b1ec2b1bcc78fbc8538413a464a8ad35ae18c0d5c72669b74d2a6fb7e86ec3ec566

data/lib/tonal/attributions.rb

@@ -1,4 +1,4 @@
 module Tonal
   TOOLS_PRODUCER = "mTonal"
-  TOOLS_VERSION = "8.7.0"
+  TOOLS_VERSION = "8.8.1"
 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
@@ -49,10 +51,12 @@ class Tonal::Hertz
   # @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
+  # @param modulo [Integer] the modulo to use for the MIDI note calculation
+  # @param reference_number [Integer] the MIDI note number that anchors the conversion
+  # @param reference_frequency [Numeric] the frequency (Hz) that anchors the conversion
   #
-  def to_midi_note
-    Tonal::Midi::Note.new(frequency: to_f)
+  def to_midi_note(modulo: Tonal::Midi::Note::DEFAULT_MODULO, reference_number: Tonal::Midi::Note::A4_MIDI_NUMBER, reference_frequency: Tonal::Hertz::REFERENCE_FREQUENCY)
+    Tonal::Midi::Note.new(frequency: to_f, modulo: modulo, reference_number: reference_number, reference_frequency: reference_frequency)
   end
   alias :to_midi :to_midi_note
 

data/lib/tonal/midi.rb

@@ -2,31 +2,51 @@ 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, :reference_number, :reference_frequency
 
     # @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
+    # @param reference_number [Integer] the MIDI note number that anchors the number/frequency conversion
+    # @param reference_frequency [Numeric] the frequency (Hz) that anchors the number/frequency conversion
     #
-    def initialize(number: A4_MIDI_NUMBER, frequency: nil)
+    def initialize(number: nil, frequency: nil, modulo: DEFAULT_MODULO, reference_number: A4_MIDI_NUMBER, reference_frequency: Tonal::Hertz::REFERENCE_FREQUENCY)
+      raise ArgumentError, "Provide either number: or frequency:, not both" if number && frequency
+
+      @modulo = modulo
+      @reference_number = reference_number
+      @reference_frequency = reference_frequency.to_f
       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 = (@reference_number + modulo * Math.log2(frequency.to_f / @reference_frequency)).round
       else
+        number = @reference_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(@reference_frequency * (2 ** ((number - @reference_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"

data/lib/tonal/ratio.rb

@@ -174,6 +174,28 @@ 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 number of steps per octave used to scale self's offset from reference. The
+  #   reference frequency's own MIDI note number is always computed independently of modulo.
+  #
+  def to_midi(reference: Tonal::Hertz.reference, modulo: Tonal::Midi::Note::DEFAULT_MODULO)
+    reference_hertz = Tonal::Hertz.new(reference)
+    reference_number = reference_hertz.to_midi_note.number
+    to_hertz(reference: reference_hertz).to_midi_note(modulo: modulo, reference_number: reference_number, reference_frequency: reference_hertz.to_f)
+  end
+
   # @return [Integer] the step of self in the given modulo
   # @example
   #   Tonal::ReducedRatio.new(3,2).step(12) => 7\12

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tonal-tools
 version: !ruby/object:Gem::Version
-  version: 8.7.0
+  version: 8.8.1
 platform: ruby
 authors:
 - Jose Hales-Garcia
 bindir: bin
 cert_chain: []
-date: 2026-06-02 00:00:00.000000000 Z
+date: 2026-07-03 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: []