pitch 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f4dcf63953fb2bbbed2b83a7572997df807789064f2a693ff04943af4d894bb6
+  data.tar.gz: 0b5738fc7f5f6b1c0858f80e0f181dac6948d9865b0a5a932b46c003d456e027
+SHA512:
+  metadata.gz: 9460a4205f88d03894653d2e7b518da11022e272b7aa54d2ae932d6aea31ff4e727ba7a982eed1eb0f36311c5a6de5c7afee37ee26fe45bee108156f61826df2
+  data.tar.gz: ad4edec8f1fcf51ac8764628123d72651d775d08419b7a75f07b22415e367eaa0ec9f31776ff98bc768845fe5acd4fefa31081fb845ba91265dc3972c2db6cf2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,46 @@
+# Pitch
+
+Pitch is a Ruby gem that provides a way to generate audio tones, writes them to files, and detects those tones. It can be used in applications that need to test whether audio data is being written properly. For example, it is used in the [HD24Dig](https://github.com/jslabovitz/hd24dig.git) gem to build a test harness for testing audio extraction from a multitrack digital recorder.
+
+Pitches can be created from scientific pitch notation (SPN), where 'C4' is designated to be middle C. Or from MIDI notation where either the string 'C3' or the value 60 is middle C. Pitches can be converted between various forms, as well as added to or subtracted from. Finally, pitches can be written to files as audio tones, and generated by analyzing files with audio tones.
+
+
+## Usage
+
+```ruby
+require 'pitch'
+
+# make a pitch of C4 (SPN)
+pitch = Pitch.new_from_spn('C4')
+
+# make a file containing a tone with the pitch
+pitch.write_to_file('tone.wav', rate: 48000, depth: 24)
+
+# read the file to determine the pitch
+pitch = Pitch.read_from_file('tone.wav')
+```
+
+
+## Installation
+
+Install as a gem:
+
+    gem install pitch
+
+...or add to your `Gemfile` or `.gemspec` file as needed.
+
+
+## Requirements
+
+This gem was written to use Ruby 3.3. It should work with versions of Ruby that are close to that.
+
+Under the hood, Pitch uses [SoX](https://sox.sourceforge.net/) to generate tones and write audio files, and [Aubio](https://aubio.org) to analyze and detect tones from those files. You will need to install the appropriate package in order for the `write_to_file` and `read_from_file` methods to work properly. On macOS using Homebrew, that looks like this:
+
+    brew install sox
+    brew install aubio
+
+
+## References
+
+- [Scientific pitch notation (Wikipedia)](https://en.wikipedia.org/wiki/Scientific_pitch_notation)
+- [MIDI Note/Key Number Chart](https://computermusicresource.com/midikeys.html)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+Bundler.require
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*test.rb']
+end
+
+task :default => :test

data/TODO.md

@@ -0,0 +1,4 @@
+# TODO
+
+- Add frequency.
+    https://kagi.com/assistant?mode=4&sub_mode=12&thread=juUmb5tS3L8rCZ7ISpG2Y6KbdbtzZYU8

data/lib/pitch.rb

@@ -0,0 +1,120 @@
+require 'tty-command'
+
+class Pitch
+
+  attr_accessor :semitone
+  attr_accessor :octave
+
+  SEMITONE_NAMES = %w[C C# D D# E F F# G G# A A# B]
+  NUM_SEMITONES = SEMITONE_NAMES.count
+
+  def self.read_from_file(file)
+    out, _ = run_command(
+      'aubiopitch',
+      '--samplerate', 48000,  # doesn't work with higher sample rates?
+      '--input', file,
+      '--pitch-unit', 'midi',
+    )
+    values = out.split(/\n/).map { |line| line.split(/\s+/).last.to_f }.reject(&:zero?)
+    raise "Couldn't detect pitches" if values.empty?
+    value = (values.sum / values.count).round
+    new_from_midi_num(value)
+  end
+
+  def self.run_command(*args)
+    TTY::Command.new(printer: :quiet).run(
+      *args.flatten.compact.map(&:to_s),
+      only_output_on_error: true)
+  end
+
+  def self.new_from_midi(arg)
+    case arg
+    when Numeric
+      new_from_midi_num(arg)
+    when String
+      new_from_midi_name(arg)
+    else
+      raise ArgumentError
+    end
+  end
+
+  def self.new_from_midi_num(num)
+    semitone, octave = SEMITONE_NAMES[num % NUM_SEMITONES], (num / NUM_SEMITONES)
+    new(semitone, octave - 1)
+  end
+
+  def self.new_from_midi_name(name)
+    semitone, octave = parse_name(name)
+    new(semitone, octave + 1)
+  end
+
+  def self.new_from_spn(spn)
+    semitone, octave = parse_name(spn)
+    new(semitone, octave)
+  end
+
+  def self.parse_name(name)
+    semitone_name, octave = name.match(/^(.*?)(-?\d+)$/).captures
+    semitone = SEMITONE_NAMES.index(semitone_name)
+    octave = octave.to_i
+    [semitone, octave]
+  end
+
+  def initialize(semitone, octave)
+    @semitone = case semitone
+    when Numeric
+      semitone
+    when String
+      SEMITONE_NAMES.index(semitone)
+    else
+      raise ArgumentError
+    end
+    @octave = octave
+  end
+
+  def ==(other)
+    other &&
+      @octave == other.octave &&
+      @semitone == other.semitone
+  end
+
+  def to_midi_name
+    to_s(offset: -1)
+  end
+
+  def to_midi_num
+    ((@octave + 1) * NUM_SEMITONES) + @semitone
+  end
+
+  def to_spn
+    to_s
+  end
+
+  def to_s(offset: 0)
+    '%s%d' % [
+      SEMITONE_NAMES[@semitone],
+      @octave + offset,
+    ]
+  end
+
+  def +(n)
+    self.class.new_from_midi_num(to_midi_num + n)
+  end
+
+  def -(n)
+    self + (-n)
+  end
+
+  def write_to_file(file, duration: 5, rate: 48000, depth: 24)
+    self.class.run_command(
+      'sox',
+      '--null',
+      '--rate', rate,
+      '--bits', depth,
+      file,
+      'synth', duration, 'pluck', to_spn,
+    )
+    file
+  end
+
+end

data/pitch.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |gem|
+  gem.name          = 'pitch'
+  gem.version       = '0.1'
+  gem.authors       = 'John Labovitz'
+  gem.email         = 'johnl@johnlabovitz.com'
+  gem.summary       = %q{Create and analyze musical pitches from MIDI names/numbers and scientific pitch notation (SPN)}
+  gem.description   = %q{Create and analyze musical pitches from MIDI names/numbers and scientific pitch notation (SPN)..}
+  gem.homepage      = 'https://github.com/jslabovitz/pitch.git'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'tty-command', '~> 0.10'
+
+  gem.add_development_dependency 'bundler', '~> 2.5'
+  gem.add_development_dependency 'minitest', '~> 5.23'
+  gem.add_development_dependency 'minitest-power_assert', '~> 0.3'
+  gem.add_development_dependency 'rake', '~> 13.2'
+
+end

data/test/pitch_test.rb

@@ -0,0 +1,63 @@
+$VERBOSE = false
+
+require 'minitest/autorun'
+require 'minitest/power_assert'
+
+require_relative '../lib/pitch'
+
+class Pitch
+
+  class Test < Minitest::Test
+
+    def test_spn
+      pitch = Pitch.new_from_spn('C4')
+      assert { pitch.semitone == 0 }
+      assert { pitch.octave == 4 }
+      assert { pitch.to_spn == 'C4' }
+    end
+
+    def test_midi_num
+      pitch = Pitch.new_from_midi(60)
+      assert { pitch.semitone == 0 }
+      assert { pitch.octave == 4 }
+      assert { pitch.to_midi_num == 60 }
+      assert { pitch.to_midi_name == 'C3' }
+      assert { pitch.to_spn == 'C4' }
+    end
+
+    def test_midi_name
+      pitch = Pitch.new_from_midi('C3')
+      assert { pitch.semitone == 0 }
+      assert { pitch.octave == 4 }
+      assert { pitch.to_midi_num == 60 }
+      assert { pitch.to_spn == 'C4' }
+    end
+
+    def test_increment
+      pitch = Pitch.new_from_spn('C4')
+      pitch += 1
+      assert { pitch.to_spn == 'C#4' }
+      pitch -= 12
+      assert { pitch.to_spn == 'C#3' }
+    end
+
+    def test_equals
+      pitch1 = Pitch.new_from_spn('C4')
+      pitch2 = Pitch.new_from_midi('C3')
+      assert { pitch1 == pitch2 }
+    end
+
+    OUTPUT_FILE = 'test/tmp/output.wav'
+
+    def test_analyze
+      File.unlink(OUTPUT_FILE) if File.exist?(OUTPUT_FILE)
+      FileUtils.mkpath(File.dirname(OUTPUT_FILE))
+      pitch = Pitch.new_from_spn('C4')
+      pitch.write_to_file(OUTPUT_FILE)
+      pitch2 = Pitch.read_from_file(OUTPUT_FILE)
+      assert { pitch2 == pitch }
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: pitch
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- John Labovitz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-command
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.23'
+- !ruby/object:Gem::Dependency
+  name: minitest-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+description: Create and analyze musical pitches from MIDI names/numbers and scientific
+  pitch notation (SPN)..
+email: johnl@johnlabovitz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- TODO.md
+- lib/pitch.rb
+- pitch.gemspec
+- test/pitch_test.rb
+homepage: https://github.com/jslabovitz/pitch.git
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Create and analyze musical pitches from MIDI names/numbers and scientific
+  pitch notation (SPN)
+test_files:
+- test/pitch_test.rb