road_to_rubykaigi 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7a2caaae541ce4ed72641c27f4b9df735cbaf1592839a962dca1595a63158a8
-  data.tar.gz: f01bf3be60571a84dcb809059e3630b0d58fb61b570dabb5e8c83d576164b9c5
+  metadata.gz: 8e1c9d75458d0964d5a7016dffb3cd8b80a7528e6dd6988400e54b37d307a2ae
+  data.tar.gz: 645ba606e44b14f7065136dc22b8dfd7f33fd8af5f0c7d0c2fcf94f928b54997
 SHA512:
-  metadata.gz: 524c0ed14385b286b2c4d201881331ee4ccde2ff3a4c7f35fd113f29f8dc813214eb60c32b9881028e8bc5f028e4b973cdaab43e5c005248cba3d7b3e64403e8
-  data.tar.gz: 514ab937338bc63709ebbe3924b33b3b81e78e46b5b1e50f27c634c5ef04d0403312cc9446d7420e7b079f240e24555f5cd9ec902fbc1528e94d83c92624ec83
+  metadata.gz: cc76ee396cf3a522c4aca51b02a4fc3009e7f7dea49c4ca59bcaa4161c70e8bc9a1276549e8777385a9baa4b1960f682ee0415b3534a06f22bc2f5d6bd71780a
+  data.tar.gz: a6f482e2a301be08a089b978950a1d890417653243e63b985b24e2f2c94a7c1bb64a61fde9b47d0eb885d531b778f10f94c0c280e45a81a2184dd69b6e3aa33d

data/.standard.yml

@@ -10,9 +10,20 @@ ignore:
     - Naming/MethodParameterName
     - Style/IfInsideElse
     - Style/EmptyCaseCondition
+    - Style/NestedTernaryOperator
     - Style/StringLiterals
+    - Style/TernaryParentheses
     - Style/TrailingCommaInArguments
     - Style/TrailingCommaInArrayLiteral
     - Style/TrailingCommaInHashLiteral
+    - Style/WhenThen
   - '**/**/ansi.rb':
     - Style/RedundantSelf
+  - 'lib/road_to_rubykaigi/audio/audio_engine.rb':
+    - Naming/VariableName
+    - Security/Open
+  - 'lib/road_to_rubykaigi/audio/sequencer.rb':
+    - Layout/HashAlignment
+  - 'util/audio.rake':
+    - Lint/RedundantSplatExpansion
+    - Style/PercentLiteralDelimiters

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.2.1] - 2025-04-15
+
+- Fix bug to fail to resolve sound effect files paths
+
+## [0.2.0] - 2025-04-15
+
+- Play BGM
+- Add attack action
+- Add shooting action
+
 ## [0.1.0] - 2025-02-27
 
 - Initial release

data/README.md

@@ -19,6 +19,13 @@
 
 ## Installation
 
+Install portaudio like:
+
+```bash
+# e.g. macOS
+brew install portaudio
+```
+
 ```bash
 gem install road_to_rubykaigi
 ```
@@ -28,13 +35,20 @@ gem install road_to_rubykaigi
 Run the game from your terminal:
 
 ```bash
-bundle exec road_to_rubykaigi
+road_to_rubykaigi
 ```
 
 ## Requirements
 
 - Ruby 3.4.0 or later
 - A terminal that supports ANSI escape sequences and 256-color mode
+- PortAudio
+
+## SoundEffects Creators
+
+- Yasuhiro Tsuchiya / https://snd.dev
+- PANICPUMPKIN / https://pansound.com/panicpumpkin
+- タダノオト / https://tadanote.tokyo
 
 ## License
 

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+import "util/audio.rake"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/road_to_rubykaigi/audio/audio_engine.rb

@@ -0,0 +1,70 @@
+require 'ffi-portaudio'
+
+module RoadToRubykaigi
+  module Audio
+    class AudioEngine < FFI::PortAudio::Stream
+      include FFI::PortAudio
+
+      def process(_input, output, framesPerBuffer, _timeInfo, _statusFlags, _userData)
+        samples = Array.new(framesPerBuffer, 0.0)
+
+        unless @muted
+          @sources.each do |source|
+            framesPerBuffer.times do |i|
+              sample = source.generate * source.gain
+              samples[i] += sample
+            end
+            remove_source(source) if source.finished?
+          end
+        end
+
+        output.write_array_of_float(samples)
+        :paContinue
+      end
+
+      def add_source(source)
+        @sources << source.rewind
+      end
+
+      def remove_source(source)
+        @sources.delete(source)
+      end
+
+      def mute
+        @muted = true
+      end
+
+      def unmute
+        @muted = false
+      end
+
+      private
+
+      def initialize(bass_sequencer, melody_sequencer)
+        frame_size = 2 ** 12 # 4096
+        @sources = [bass_sequencer, melody_sequencer]
+        @muted = false
+        API.Pa_Initialize
+        open(nil, output, bass_sequencer.sample_rate, frame_size)
+        start
+
+        at_exit do
+          @muted = true
+          sleep 0.5
+          close
+          API.Pa_Terminate
+        end
+      end
+
+      def output
+        output = API::PaStreamParameters.new
+        output[:device] = API.Pa_GetDefaultOutputDevice
+        output[:suggestedLatency] = API.Pa_GetDeviceInfo(output[:device])[:defaultHighOutputLatency]
+        output[:hostApiSpecificStreamInfo] = nil
+        output[:channelCount] = 1 # monaural
+        output[:sampleFormat] = API::Float32
+        output
+      end
+    end
+  end
+end

data/lib/road_to_rubykaigi/audio/oscillator.rb

@@ -0,0 +1,159 @@
+module RoadToRubykaigi
+  module Audio
+    module Phasor
+      def sample_rate
+        44_100
+      end
+
+      def gain
+        0.2
+      end
+
+      private
+
+      def initialize
+        @phases = Hash.new { |h, k| h[k] = rand }
+      end
+
+      def tick(frequency:)
+        phase = @phases[frequency]
+        phase += frequency.to_f / sample_rate
+        phase -= 1.0 if phase >= 1.0
+        @phases[frequency] = phase
+      end
+    end
+
+    class TriangleOscillator
+      include Phasor
+
+      def generate(frequencies:)
+        samples = frequencies.map do |frequency|
+          phase = tick(frequency: frequency)
+          if phase < 0.5
+            4 * phase - 1
+          else
+            -4 * phase + 3
+          end
+        end
+        samples.sum / samples.size
+      end
+    end
+
+    class RoughTriangleOscillator
+      include Phasor
+
+      TABLE_SIZE = 32
+
+      def generate(frequencies:)
+        samples = frequencies.map do |frequency|
+          phase = tick(frequency: frequency)
+          index = (TABLE_SIZE * phase).floor % TABLE_SIZE
+          @table[index]
+        end
+        samples.sum / samples.size
+      end
+
+      private
+
+      def initialize
+        super
+        @table = generate_table
+      end
+
+      def generate_table
+        half = TABLE_SIZE / 2
+        # up：-1 -> +1
+        #   i = 0: -1.0, i = half-1: +1.0
+        up = (0...half).map { |i| -1.0 + (2.0 * i) / (half - 1) }
+        # down：+1 -> -1
+        #   i = 0: +1.0, i = half-1: -1.0
+        down = (0...half).map { |i| 1.0 - (2.0 * i) / (half - 1) }
+        up + down
+      end
+    end
+
+    class SquareOscillator
+      include Phasor
+      DUTY_CYCLE = {
+        d0: 0.125,
+        d1: 0.25,
+        d2: 0.5,
+      }
+
+      def generate(frequencies:)
+        samples = frequencies.map do |frequency|
+          phase = tick(frequency: frequency)
+          phase < duty_cycle ? 1.0 : -1.0
+        end
+        samples.sum / samples.size
+      end
+
+      def duty_cycle=(duty_cycle)
+        @duty_cycle = (DUTY_CYCLE.key?(duty_cycle) ? duty_cycle : :d0)
+      end
+
+      private
+
+      def initialize
+        @duty_cycle = :d1
+        super
+      end
+
+      def duty_cycle
+        DUTY_CYCLE[@duty_cycle]
+      end
+    end
+
+    class RoundedSquareOscillator
+      include Phasor
+      DUTY_CYCLE = {
+        d0: 0.125,
+        d1: 0.25,
+        d2: 0.5,
+      }
+      SMOOTH_WIDTH = 0.05
+
+      def generate(frequencies:)
+        samples = frequencies.map do |frequency|
+          phase = tick(frequency: frequency)
+          off_to_on_end = SMOOTH_WIDTH / 2.0
+          on_to_off_start = duty_cycle - SMOOTH_WIDTH / 2.0
+          on_to_off_end = duty_cycle + SMOOTH_WIDTH / 2.0
+
+          case phase
+          when 0..off_to_on_end
+            t = phase / off_to_on_end
+            smoothstep_weight = t ** 2 * (3 - 2 * t)
+            -1.0 + smoothstep_weight * 2
+          when off_to_on_end..on_to_off_start
+            1.0
+          when on_to_off_start..on_to_off_end
+            t = (phase - on_to_off_start) / SMOOTH_WIDTH
+            cos_weight = 1 - Math.cos(Math::PI * t)
+            1.0 - cos_weight
+          else
+            # We don't need interpolate off_to_on_start..1
+            # because 1 is essentially contiguous with 0.
+            -1.0
+          end
+        end
+        samples.sum / samples.size
+      end
+
+      def duty_cycle=(duty_cycle)
+        @duty_cycle = (DUTY_CYCLE.key?(duty_cycle) ? duty_cycle : :d0)
+      end
+
+      private
+
+      def initialize
+        @duty_cycle = :d1
+        super
+      end
+
+      def duty_cycle
+        DUTY_CYCLE[@duty_cycle]
+      end
+    end
+  end
+end

data/lib/road_to_rubykaigi/audio/sequencer.rb

@@ -0,0 +1,263 @@
+module RoadToRubykaigi
+  module Audio
+    class SequencerBase
+      BPM = 100
+      NOTES = {
+        REST: 0.0,
+        C4: 261.63, C4s: 277.18, # ド
+        D4: 293.66, D4s: 311.13,
+        E4: 329.63,
+        F4: 349.23, F4s: 369.99,
+        G4: 392.00, G4s: 415.30, # ソ
+        A4: 440.00, A4s: 466.16,
+        B4: 493.88,
+        C5: 523.25, C5s: 554.37,
+        D5: 587.33, D5s: 622.25,
+        E5: 659.25,
+        F5: 698.46, F5s: 739.99,
+        G5: 783.99, G5s: 830.61,
+        A5: 880.00, A5s: 932.33,
+        B5: 987.77,
+        C6: 1046.50,
+      }
+      ENVELOPE = {
+        bass:        { a: 0.2, d: 0.2, s: 0.6, sl: 0.6, rl: 0.9 },
+        bass_short:  { a: 0.2, d: 0.2, s: 0.05, sl: 0.6, rl: 0.9 },
+        melody:      { a: 0.05, d: 0.1, s: 0.1, sl: 0.75, rl: 1.35 },
+        melody_long: { a: 0.5, d: 0.2, s: 0.7, sl: 0.6, rl: 1.0 },
+        fanfare:     { a: 0.2, d: 0.1, s: 0.35, sl: 0.6, rl: 1.5 },
+      }
+
+      def generate
+        process
+        env = envelope
+        sample = if (current_note[:frequency] != [:REST]) &&
+            (@current_note_sample_count < (@samples_per_note * staccato_ratio))
+          @generator.generate(frequencies: current_frequencies)
+        else
+          0.0
+        end
+        increment_current_note_sample_count
+        sample * env
+      end
+
+      def sample_rate
+        @generator.sample_rate
+      end
+
+      def gain
+        @generator.gain
+      end
+
+      def rewind
+        self
+      end
+
+      def finished?
+        !loop? && @current_note_index >= @notes.size
+      end
+
+      private
+
+      def initialize
+        @bpm = BPM
+        @notes = self.class::SCORE
+        @current_note_index = 0
+        @current_note_sample_count = 0
+        @generator = self.class::GENERATOR.new
+        change_note
+      end
+
+      def process
+        if @current_note_sample_count >= @samples_per_note
+          @current_note_index += 1
+          @current_note_sample_count = 0
+          if loop? && @current_note_index >= @notes.size
+            @current_note_index -= @notes.size
+          end
+          change_note
+        end
+      end
+
+      def envelope
+        note_progress = @current_note_sample_count.to_f / (@samples_per_note * staccato_ratio)
+        current_envelop = Hash === current_note[:envelope] ? current_note[:envelope] : ENVELOPE[current_note[:envelope] || default_envelop_key]
+        attack = current_envelop[:a]
+        decay = current_envelop[:d]
+        sustain_level = current_envelop[:sl]
+        release_level = current_envelop[:rl]
+        sustain = current_envelop[:s]
+
+        if note_progress < attack
+          note_progress / attack
+        elsif note_progress < (attack + decay)
+          1 - ((note_progress - attack) / decay) * (1 - sustain_level)
+        elsif note_progress < sustain
+          sustain_level
+        else
+          (1 - note_progress) / release_level
+        end
+      end
+
+      def current_note
+        @notes[@current_note_index]
+      end
+
+      def current_frequencies
+        current_note[:frequency].map { |frequency| NOTES[frequency] }
+      end
+
+      def staccato_ratio
+        current_note[:staccato] || self.class::STACCATO_RATIO
+      end
+
+      def change_note
+        quarter_duration = 60.0 / @bpm
+        @samples_per_note = (@generator.sample_rate * quarter_duration * current_note[:duration]).to_i
+      end
+
+      def increment_current_note_sample_count
+        @current_note_sample_count += 1
+      end
+    end
+
+    class BassSequencer < SequencerBase
+      GENERATOR = RoughTriangleOscillator
+      STACCATO_RATIO = 0.85
+      SCORE = ([
+        { frequency: %i[F4 A4], duration: 1.0 },
+        { frequency: %i[F4 A4], duration: 0.5, envelope: :bass_short, staccato: 0.7 },
+        { frequency: %i[C4 F4], duration: 1.0 },
+        { frequency: %i[C4 F4], duration: 0.5, envelope: :bass_short, staccato: 0.7 },
+      ] * 5 + [
+        { frequency: %i[F4], duration: 1.0 },
+        { frequency: %i[C4], duration: 1.0 },
+        { frequency: %i[E4], duration: 1.0, staccato: 1.0 },
+      ] +
+      [
+        { frequency: %i[F4 A4], duration: 1.0 },
+        { frequency: %i[F4 A4], duration: 0.5, envelope: :bass_short, staccato: 0.7 },
+        { frequency: %i[C4 F4], duration: 1.0 },
+        { frequency: %i[C4 F4], duration: 0.5, envelope: :bass_short, staccato: 0.7 },
+      ] * 4 + [
+        { frequency: %i[F4 A4], duration: 1.0 },
+        { frequency: %i[C4 F4], duration: 1.0 },
+        { frequency: %i[F4], duration: 1.0 },
+
+        { frequency: %i[E4], duration: 1.0 },
+        { frequency: %i[D4], duration: 1.0 },
+        { frequency: %i[C4], duration: 1.0, staccato: 1.0 },
+      ])
+
+      private
+
+      def default_envelop_key
+        :bass
+      end
+
+      def loop?
+        true
+      end
+    end
+
+    class MelodySequencer < SequencerBase
+      GENERATOR = RoundedSquareOscillator
+      STACCATO_RATIO = 0.35
+      SCORE = [ # 6 Measures
+        { frequency: %i[F5], duration: 0.5, envelope: { a: 0.05, d: 0.0, s: 0.5, sl: 0.4, rl: 1.0 } },
+        { frequency: %i[C5], duration: 0.5 },
+        { frequency: %i[F5], duration: 0.5 },
+        { frequency: %i[F5], duration: 0.5 },
+        { frequency: %i[C5], duration: 0.5 },
+        { frequency: %i[F5], duration: 0.5 },
+
+        { frequency: %i[C5], duration: 0.5 },
+        { frequency: %i[F5], duration: 0.25 },
+        { frequency: %i[F5], duration: 0.25 },
+        { frequency: %i[G5], duration: 0.5 },
+        { frequency: %i[F5], duration: 0.5 },
+        { frequency: %i[C5], duration: 0.5 },
+        { frequency: %i[F5], duration: 0.5 },
+
+        { frequency: %i[REST], duration: 0.5 },
+        { frequency: %i[A5], duration: 0.5 },
+        { frequency: %i[G5], duration: 0.5 },
+        { frequency: %i[F5], duration: 0.5 },
+        { frequency: %i[E5], duration: 1.0, envelope: :melody_long, staccato: 0.95 },
+
+        { frequency: %i[F5], duration: 0.5, envelope: { a: 0.15, d: 0.15, s: 0.5, sl: 0.4, rl: 0.9 } },
+        { frequency: %i[C5], duration: 0.5 },
+        { frequency: %i[A4], duration: 0.5 },
+        { frequency: %i[C5], duration: 0.25 },
+        { frequency: %i[F5], duration: 0.25 },
+        { frequency: %i[D5], duration: 0.25 },
+        { frequency: %i[F5], duration: 0.25 },
+        { frequency: %i[C5], duration: 0.25 },
+        { frequency: %i[F5], duration: 0.25 },
+
+        { frequency: %i[C5], duration: 1.0, envelope: { a: 0.5, d: 0.15, s: 0.7, sl: 0.5, rl: 0.5 }, staccato: 0.95 },
+        { frequency: %i[F5], duration: 0.25, envelope: { a: 0.05, d: 0.0, s: 0.5, sl: 0.4, rl: 1.0 } },
+        { frequency: %i[A5], duration: 0.25 },
+        { frequency: %i[C5], duration: 0.25 },
+        { frequency: %i[F5], duration: 0.25 },
+        { frequency: %i[C5], duration: 0.25 },
+        { frequency: %i[F5], duration: 0.25 },
+        { frequency: %i[C5], duration: 0.25 },
+        { frequency: %i[F5], duration: 0.25 },
+
+        { frequency: %i[C5], duration: 0.5 },
+        { frequency: %i[F5], duration: 0.5 },
+        { frequency: %i[A5], duration: 0.25 },
+        { frequency: %i[G5], duration: 0.25 },
+        { frequency: %i[F5], duration: 0.25 },
+        { frequency: %i[E5], duration: 0.25 },
+        { frequency: %i[F5], duration: 1.0, envelope: :melody_long, staccato: 0.95 },
+      ]
+
+      def loop?
+        true
+      end
+
+      private
+
+      def default_envelop_key
+        :melody
+      end
+    end
+
+    class FanfareSequencer < SequencerBase
+      GENERATOR = RoundedSquareOscillator
+      STACCATO_RATIO = 0.35
+      SCORE = [ # 4.75 Measures
+        { frequency: %i[REST], duration: 0.75 },
+
+        { frequency: %i[F5], duration: 1.00 },
+        { frequency: %i[F5], duration: 0.25 },
+        { frequency: %i[F5], duration: 0.25 },
+
+        { frequency: %i[G5], duration: 0.5 },
+        { frequency: %i[F5], duration: 0.5 },
+        { frequency: %i[G5], duration: 0.5 },
+
+        { frequency: %i[C5], duration: 0.25 },
+        { frequency: %i[D5], duration: 0.25 },
+        { frequency: %i[F5], duration: 0.25 },
+        { frequency: %i[G5], duration: 0.25 },
+        { frequency: %i[A5], duration: 0.25 },
+        { frequency: %i[B5], duration: 0.25 },
+
+        { frequency: %i[C6], duration: 1.8, envelope: { a: 0.2, d: 0.2, s: 0.6, sl: 0.6, rl: 0.9 } },
+      ]
+
+      private
+
+      def default_envelop_key
+        :fanfare
+      end
+
+      def loop?
+        false
+      end
+    end
+  end
+end

data/lib/road_to_rubykaigi/audio/wav_source.rb

@@ -0,0 +1,55 @@
+require 'wavefile'
+
+module RoadToRubykaigi
+  module Audio
+    class WavSource
+      include WaveFile
+
+      def sample_rate
+        44_100
+      end
+
+      def gain
+        0.3
+      end
+
+      def generate
+        if @position < @buffer.size
+          sample = @buffer[@position]
+          @position += 1
+          sample
+        else
+          0.0
+        end
+      end
+
+      def rewind
+        @position = 0
+        self
+      end
+
+      def finished?
+        @position >= @buffer.size
+      end
+
+      private
+
+      def initialize(path)
+        @buffer = read_samples(path)
+        @position = 0
+      end
+
+      def read_samples(path)
+        samples = []
+        pcm_rate = 2 ** (16 - 1)
+        Reader.new(path).each_buffer(1024) do |buffer|
+          buffer.samples.each do |sample|
+            normalized = (sample.is_a?(Array) ? sample[0] : sample).to_f / pcm_rate
+            samples << normalized
+          end
+        end
+        samples
+      end
+    end
+  end
+end