playnote 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 62a214c59bec51ba07ed57311fa9dc2c03a891ed1735e8e3a8010a4f0ff7e815
+  data.tar.gz: ee76f5db51cac164310d97738bf3ebe5d5f44f0a46b4e174a4677af09346be71
+SHA512:
+  metadata.gz: 5f332337bc9ea437b642c714968279ba4c979aa81ba6e565aedf0ffce221a42841b42efbce6c13df05fbd14885e1f758c21a4b46f0395a0b1fc5c54cb7121347
+  data.tar.gz: e002225bbf5bc59ef716ea9130e9bd8eff2b4e0162317d80c36c4710fb4fb0e21dbd810e601e78af21cf902b113d068f4aa940238cdc625a3cd602a23d598d77

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2025 asciodev
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Playnote
+
+Playnote is a utility for ergonomically playing tones from the CLI.
+
+## Dependencies
+
+* Ruby 3.4 or later
+* ffplay 7.1.1 or later
+
+## Installation
+
+```bash
+gem install playnote
+```
+
+## Usage
+
+```manpage
+Usage: playnote [options] <notes>
+
+Playnote is a utility for ergonomically playing tones from the CLI.
+
+Each note is a string taking the form <tone>[semitone][octave], with
+sharps denoted by `#`, and flats denoted by `%`. Both semitones and octaves
+are optional; by default, notes are neither flat nor sharp, and each inherits
+the octave of the previous note if its octave is unspecified. (If no notes
+specify an octave, the octave for all notes is 0.) There is no delimiter character.
+
+    -q, --quiet                      Suppresses all terminal output from command
+    -p, --print-only                 Prints the given notes with their frequencies,
+                                     without audio playback (overrides -q)
+    -d, --duration [DURATION]        Time in seconds to play the given notes
+    -h, --help                       Prints this message and exits
+    -v, --[no-]verbose               Run verbosely (overrides -q and -p)
+
+EXAMPLES
+    playnote c3eg                    Play a C Major Chord in the 3rd Octave
+
+    playnote c3e%4g                  Play a C Minor Chord, with C in 3rd Octave,
+                                     and E♭ and G in the 4th
+
+    playnote g#5                     Play a G♯ Note in the 5th Octave
+
+    playnote -p f2ac                 Print the notes comprising an F Major chord
+                                     along with their frequencies, and exit
+                                     without audio playback
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/asciodev/playnote.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/exe/playnote

@@ -0,0 +1,280 @@
+#!/usr/bin/env ruby
+require 'optparse'
+require 'curses'
+
+Note = Struct.new(:letter, :semitone, :octave, :frequency, :pretty, :original)
+
+class NotePlayer
+  @@hz_map = {
+    "C0": 16.35,
+    "C#0": 17.32,
+    "D0": 18.35,
+    "E%0": 19.45,
+    "E0": 20.6,
+    "F0": 21.83,
+    "F#0": 23.12,
+    "G0": 24.5,
+    "A%0": 25.96,
+    "A0": 27.5,
+    "B%0": 29.14,
+    "B0": 30.87,
+    "C1": 32.7,
+    "C#1": 34.65,
+    "D1": 36.71,
+    "E%1": 38.89,
+    "E1": 41.2,
+    "F1": 43.65,
+    "F#1": 46.25,
+    "G1": 49,
+    "A%1": 51.91,
+    "A1": 55,
+    "B%1": 58.27,
+    "B1": 61.74,
+    "C2": 65.41,
+    "C#2": 69.3,
+    "D2": 73.42,
+    "E%2": 77.78,
+    "E2": 82.41,
+    "F2": 87.31,
+    "F#2": 92.5,
+    "G2": 98,
+    "A%2": 103.83,
+    "A2": 110,
+    "B%2": 116.54,
+    "B2": 123.47,
+    "C3": 130.81,
+    "C#3": 138.59,
+    "D3": 146.83,
+    "E%3": 155.56,
+    "E3": 164.81,
+    "F3": 174.61,
+    "F#3": 185,
+    "G3": 196,
+    "A%3": 207.65,
+    "A3": 220,
+    "B%3": 233.08,
+    "B3": 246.94,
+    "C4": 261.63,
+    "C#4": 277.18,
+    "D4": 293.66,
+    "E%4": 311.13,
+    "E4": 329.63,
+    "F4": 349.23,
+    "F#4": 369.99,
+    "G4": 392,
+    "A%4": 415.3,
+    "A4": 440,
+    "B%4": 466.16,
+    "B4": 493.88,
+    "C5": 523.25,
+    "C#5": 554.37,
+    "D5": 587.33,
+    "E%5": 622.25,
+    "E5": 659.25,
+    "F5": 698.46,
+    "F#5": 739.99,
+    "G5": 783.99,
+    "A%5": 830.61,
+    "A5": 880,
+    "B%5": 932.33,
+    "B5": 987.77,
+    "C6": 1046.5,
+    "C#6": 1108.73,
+    "D6": 1174.66,
+    "E%6": 1244.51,
+    "E6": 1318.51,
+    "F6": 1396.91,
+    "F#6": 1479.98,
+    "G6": 1567.98,
+    "A%6": 1661.22,
+    "A6": 1760,
+    "B%6": 1864.66,
+    "B6": 1975.53,
+    "C7": 2093,
+    "C#7": 2217.46,
+    "D7": 2349.32,
+    "E%7": 2489.02,
+    "E7": 2637.02,
+    "F7": 2793.83,
+    "F#7": 2959.96,
+    "G7": 3135.96,
+    "A%7": 3322.44,
+    "A7": 3520,
+    "B%7": 3729.31,
+    "B7": 3951.07,
+    "C8": 4186.01,
+    "C#8": 4434.92,
+    "D8": 4698.63,
+    "E%8": 4978.03,
+    "E8": 5274.04,
+    "F8": 5587.65,
+    "F#8": 5919.91,
+    "G8": 6271.93,
+    "A%8": 6644.88,
+    "A8": 7040,
+    "B%8": 7458.62,
+    "B8": 7902.13
+  }
+
+  def initialize(args=ARGV)
+    @pids = []
+    @duration = :infinite
+    @options = {duration: @duration}
+    @optionsparser = OptionParser.new do |opts|
+      opts.banner = "Usage: #{opts.program_name} [options] <notes>"
+      opts.on_tail("\nAUTHORS", "    asciodev")
+      opts.on("\nPlaynote is a utility for ergonomically playing tones from the CLI.")
+      opts.on("\nEach note is a string taking the form <tone>[semitone][octave], with")
+      opts.on("sharps denoted by `#`, and flats denoted by `%`. Both semitones and octaves")
+      opts.on("are optional; by default, notes are neither flat nor sharp, and each inherits")
+      opts.on("the octave of the previous note if its octave is unspecified. (If no notes")
+      opts.on("specify an octave, the octave for all notes is 0.) There is no delimiter character.")
+      opts.on("")
+      opts.on("-q", "--quiet", FalseClass, "Suppresses all terminal output from command") { @options[:quiet] = @quiet = true }
+      opts.on("-p", "--print-only", FalseClass, "Prints the given notes with their frequencies,", "without audio playback (overrides -q)") { @options[:print_only] = @print_only = true }
+      opts.on("-d", "--duration [DURATION]", Float, "Time in seconds to play the given notes") { @options[:duration] = @duration = it }
+      opts.on("-h", "--help", "Prints this message and exits") { @options[:help] = true }
+      opts.on("-v", "--[no-]verbose", FalseClass, "Run verbosely (overrides -q and -z)") { @options[:verbose] = @verbose = true }
+      opts.on("-V", "--version", "Prints the currently running version of #{opts.program_name}", "and exits") { @options[:version] = @version = true }
+      opts.on(
+        "\nEXAMPLES",
+        sprintf("    %-#{opts.summary_width}s %s", "#{opts.program_name} c3eg", "Play a C Major Chord in the 3rd Octave"),
+        sprintf("\n    %-#{opts.summary_width}s %s", "#{opts.program_name} c3e%4g", "Play a C Minor Chord, with C in 3rd Octave,"),
+        sprintf("    %-#{opts.summary_width}s %s", "", "and E♭ and G in the 4th"),
+        sprintf("\n    %-#{opts.summary_width}s %s", "#{opts.program_name} g#5", "Play a G♯ Note in the 5th Octave"),
+        sprintf("\n    %-#{opts.summary_width}s %s", "#{opts.program_name} -p f2ac", "Print the notes comprising an F Major chord"),
+        sprintf("    %-#{opts.summary_width}s %s", "", "along with their frequencies, and exit"), 
+        sprintf("    %-#{opts.summary_width}s %s", "", "without audio playback"),
+      )
+      @raw_notes = opts.permute(args)
+    end
+    version! if @options[:version]
+    help! if @options[:help]
+    if(@raw_notes.is_a?(Array) && @raw_notes.first.is_a?(String))
+      @options[:notes] = @raw_notes.first.scan(/[a-gA-G][#%nN]?\d?/).map(&:downcase)
+    else
+      help!
+    end
+    @optionsparser.parse!
+    octave = 0
+    @notes = @options[:notes].map do
+      note = it.upcase
+      _has_octave = _octave = note[/\d$/]
+      octave = _octave if _has_octave
+      note = "#{note}#{octave}" unless _has_octave
+      hz = @@hz_map[note.to_sym]
+      if hz
+        Note.new(note[/^[a-gA-G]/], note[/^[a-gA-G]([#%nN])/, 1], note[/\d$/], hz, pretty_note(note), pretty_note(it))
+      else
+        alt = alternate_note(note)
+        hz = @@hz_map[alternate_note(note).to_sym]
+        Note.new(alt[/^[a-gA-G]/], alt[/^[a-gA-G]([#%nN])/, 1], alt[/\d$/], hz, pretty_note(alt), pretty_note(it))
+      end
+    end
+  end
+
+  def show_message
+    message = self.to_s
+    Curses::init_screen
+    msgwidth = message.lines.map(&:length).max
+    msgheight = @notes.length + 1
+    winwidth = msgwidth + 6
+    winheight = msgheight * 3
+    current_line = 0
+    win = Curses::Window.new(winheight, winwidth, (Curses::lines - winheight) / 2, (Curses::cols - winwidth) / 2)
+    win.box(?|, ?-)
+    message.lines.each do |it|
+      win.setpos(current_line + (winheight - msgheight) / 2, 1 + (winwidth - msgwidth) / 2)
+      win.addstr "#{it.strip}"
+      current_line += 1
+    end
+    Curses::curs_set(0)
+    win.refresh
+    Curses::cbreak
+    win.getch
+    Curses::curs_set(1)
+    win.close
+    Curses::nocbreak
+  end
+
+  def play
+    puts self if !@quiet || @print_only || @verbose
+    ffargs = [
+      "ffplay",
+      "-autoexit",
+      "-nodisp",
+      "-loglevel",
+      (@verbose ? "verbose" : "error"),
+      (@verbose ? nil : "-hide_banner"),
+      "-f", "lavfi",
+      "-i", ffplay_cmd_str,
+      [:out, :err] => (@verbose ? :out : File::NULL)
+    ].reject(&:nil?)
+    puts ffargs.inspect if @verbose
+    return if @print_only
+    @pids.push spawn(*ffargs)
+    show_message
+    until @pids.empty?
+      pid = @pids.pop
+      Process.kill "TERM", pid
+      Process.wait pid
+    end
+    exit
+  end
+
+  def inspect
+    to_str
+  end
+
+  def to_str
+    @notes.map { sprintf "%-5s %-9s %d", it.pretty, it.original, it.frequency }.join("\n").then do
+      [sprintf("%-5s %-9s %s", "note", "original", "frequency"), it].join("\n")
+    end
+  end
+
+  def to_s
+    to_str
+  end
+
+  private
+
+  def version!
+    printf "%s v%s\n", @optionsparser.program_name, Gem.loaded_specs["playnote"].version
+    exit
+  end
+
+  def help!
+    puts @optionsparser
+    exit
+  end
+
+  def alternate_note(note)
+    return note if note.length < 2 || @@hz_map[note.to_sym]
+    flat = note[1] == "%"
+    sharp = note[1] == "#"
+    letter = note[0]
+    octave = note[2..-1].to_i
+    return note unless flat || sharp
+    step = (flat ? -1 : 0) + (sharp ? 1 : 0) + 0
+    scale = ("A".."G").to_a
+    return "#{scale[(scale.index(letter) + step) % scale.length]}#{flat ? "#" : "%"}#{octave + step}"
+  end
+
+  def pretty_note(note)
+    note.gsub("#","♯").gsub("%","♭").gsub(/[nN]/, "♮")
+  end
+
+  def ffplay_cmd_str
+    alphabet = ("a".."z").to_a
+    arg_count = @notes.reject{it.frequency.nil?}.length
+    raise "Too many notes!" if arg_count > 26
+    @notes.each_with_index.map {|note,n| note.frequency ? "sine=f=#{note.frequency.to_i}[#{alphabet[n]}];" : ""}.join("").then do
+      used_letters = alphabet[0..arg_count-1]
+      dirstr = @duration == :infinite ? "" : "=end=#@duration"
+      [it, used_letters.map{"[#{it}]"}, "amerge=inputs=#{arg_count},atrim", dirstr].join("")
+    end
+  end
+
+end
+
+NotePlayer.new().play if(caller.empty? || caller&.last&.match(/bin\/playnote/))

data/lib/playnote/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Playnote
+  VERSION = "0.1.0"
+end

data/lib/playnote.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "playnote/version"
+
+module Playnote
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/playnote.rbs

@@ -0,0 +1,4 @@
+module Playnote
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: playnote
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- asciodev
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+email:
+- 81930475+asciodev@users.noreply.github.com
+executables:
+- playnote
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- exe/playnote
+- lib/playnote.rb
+- lib/playnote/version.rb
+- sig/playnote.rbs
+homepage: https://github.com/asciodev/playnote
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/asciodev/playnote
+  source_code_uri: https://github.com/asciodev/playnote
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Playnote is a utility for ergonomically playing tones from the CLI.
+test_files: []