ruby_dsp 0.0.1

data/lib/ruby_dsp/version.rb

@@ -0,0 +1,6 @@
+# lib/ruby_dsp/version.rb
+# frozen_string_literal: true
+
+module RubyDSP
+  VERSION = '0.0.1'
+end

data/lib/ruby_dsp.rb

@@ -0,0 +1,10 @@
+# lib/ruby_dsp.rb
+require 'ruby_dsp/version'
+require 'ruby_dsp/ruby_dsp'
+
+module RubyDSP
+  # In-Ruby code
+  class AudioTrack
+    # ...
+  end
+end

data/ruby_dsp.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ruby_dsp/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'ruby_dsp'
+  s.version     = RubyDSP::VERSION
+  s.summary     = 'Very basic audio/DSP gem with C++ guts for speed'
+  s.description = 'Basically just a Ruby wrapper for miniaudio + some audio/DSP features.'
+  s.authors     = ['Radek C.']
+  s.email       = 'cichrrad@cvut.cz'
+  s.homepage    = 'https://github.com/cichrrad/ruby_dsp'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 3.0.0'
+
+  s.require_paths = ['lib', 'stubs/ruby_dsp']
+  s.extensions    = ['ext/ruby_dsp/extconf.rb']
+
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  s.add_dependency 'rice', '~> 4.11.2'
+
+  s.add_development_dependency 'rack', '~> 3.2'
+  s.add_development_dependency 'rackup', '~> 2.3'
+  s.add_development_dependency 'rake-compiler', '~> 1.3'
+  s.add_development_dependency 'webrick', '~> 1.9'
+  s.add_development_dependency 'yard', '~> 0.9'
+end

data/stubs/ruby_dsp/audio_track.rb

@@ -0,0 +1,131 @@
+# stubs/ruby_dsp/audio_track.rb
+
+module RubyDSP
+  # A high-performance audio track processor backed by miniaudio.
+  class AudioTrack
+    # @return [String] the path to the loaded audio file
+    attr_reader :file_name
+
+    # @return [Integer] the number of audio channels
+    attr_reader :channels
+
+    # @return [Integer] the sample rate of the track in Hz
+    attr_reader :sample_rate
+
+    # @return [Boolean] true if the track has exactly 1 channel
+    attr_reader :is_mono?
+
+    # Initializes a new AudioTrack and decodes the given file.
+    #
+    # @param file_name [String] Path to the audio file.
+    # @param target_channels [Integer] Optional. Force a specific number of channels (0 = original).
+    # @param target_sample_rate [Integer] Optional. Force a specific sample rate (0 = original).
+    # @raise [RuntimeError] if the file cannot be processed or read.
+    def initialize(file_name = 'default.wav', target_channels = 0, target_sample_rate = 0)
+    end
+
+    # Saves the audio track to disk.
+    #
+    # The format can be inferred from the `out_file` extension, or explicitly forced
+    # via the `format` argument. If no extension or format is provided, it defaults
+    # to saving as a WAV file and will append the `.wav` extension automatically.
+    #
+    # Note: Currently, only the WAV format (`:wav`) is supported for encoding.
+    #
+    # @example Save with inferred extension
+    #   track.save_track("output.wav")
+    #
+    # @example Save without extension (auto-appends .wav)
+    #   track.save_track("my_beat")
+    #
+    # @example Force format on an unknown extension
+    #   track.save_track("audio.data", :wav)
+    #
+    # @param out_file [String] The destination path and filename.
+    # @param format [Symbol] Optional. Forces a specific format (e.g., `:wav`). Defaults to `:auto`.
+    # @return [Boolean] true if the file was successfully written.
+    # @raise [RuntimeError] if the track is empty, encoder fails, or an unsupported format is requested.
+    def save_track(out_file, format = :auto)
+    end
+
+    # Calculates the total duration of the track.
+    #
+    # @return [Float] duration in seconds.
+    def duration
+    end
+
+    # Finds the maximum absolute amplitude across all channels.
+    #
+    # @return [Float] the peak amplitude.
+    def peak_amp
+    end
+
+    # Destructively converts the track to mono by averaging the channels.
+    #
+    # @return [Boolean] true if conversion happened, false if already mono.
+    # @raise [RuntimeError] if channel count is invalid.
+    def to_mono!
+    end
+
+    # Destructively resamples the track to the target rate using linear resampling.
+    #
+    # @param target_rate [Integer] The new sample rate in Hz.
+    # @return [Boolean] true if resampling happened, false if the rate was unchanged.
+    # @raise [RuntimeError] if the resampler fails to initialize or process.
+    def resample!(target_rate = 0)
+    end
+
+    # Calculates the Root Mean Square (RMS) for the entire track, per channel.
+    #
+    # @return [Array<Float>] An array containing the RMS value for each channel.
+    def rms
+    end
+
+    # Calculates the framed Root Mean Square (RMS) over time.
+    #
+    # @param frame_length [Integer] The number of samples per frame.
+    # @param hop_length [Integer] The number of samples to advance each frame.
+    # @return [Array<Array<Float>>] A 2D array of RMS values `[channel][frame]`.
+    def framed_rms(frame_length = 2048, hop_length = 512)
+    end
+
+    # Calculates the Zero Crossing Rate (ZCR) for the entire track, per channel.
+    #
+    # @return [Array<Float>] An array containing the ZCR value for each channel.
+    def zcr
+    end
+
+    # Calculates the framed Zero Crossing Rate (ZCR) over time.
+    #
+    # @param frame_length [Integer] The number of samples per frame.
+    # @param hop_length [Integer] The number of samples to advance each frame.
+    # @return [Array<Array<Float>>] A 2D array of ZCR values `[channel][frame]`.
+    def framed_zcr(frame_length = 2048, hop_length = 512)
+    end
+
+    # Finds the start and end sample indices of non-silent audio.
+    #
+    # This scans the track's framed RMS energy and compares it against the global peak.
+    # Any frame that falls below the top_db threshold relative to the peak is considered silent.
+    #
+    # @param threshold_db [Float] The threshold in decibels below the peak RMS to consider as silence. Default is -60.0.
+    # @param frame_length [Integer] The number of samples per frame. Default is 2048.
+    # @param hop_length [Integer] The number of samples to advance each frame. Default is 512.
+    # @return [Array<Integer>] A 2-element array containing the [start_sample, end_sample] indices.
+    def silence_bounds(threshold_db = -60.0, frame_length = 2048, hop_length = 512)
+    end
+
+    # Destructively trims leading and trailing silence from the track's internal sample array.
+    #
+    # @param threshold_db [Float] The threshold in decibels below the peak RMS to consider as silence. Default is -60.0.
+    # @param frame_length [Integer] The number of samples per frame. Default is 2048.
+    # @param hop_length [Integer] The number of samples to advance each frame. Default is 512.
+    # @return [Boolean] true if the track was trimmed, false if no trimming occurred.
+    def trim_silence!(threshold_db = -60.0, frame_length = 2048, hop_length = 512)
+    end
+
+    # @return [String] a formatted summary of the track.
+    def to_s
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: ruby_dsp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Radek C.
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rice
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.11.2
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Basically just a Ruby wrapper for miniaudio + some audio/DSP features.
+email: cichrrad@cvut.cz
+executables: []
+extensions:
+- ext/ruby_dsp/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- ext/ruby_dsp/extconf.rb
+- ext/ruby_dsp/ruby_dsp.cpp
+- ext/ruby_dsp/vendor/miniaudio.h
+- lib/ruby_dsp.rb
+- lib/ruby_dsp/version.rb
+- ruby_dsp.gemspec
+- stubs/ruby_dsp/audio_track.rb
+homepage: https://github.com/cichrrad/ruby_dsp
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- stubs/ruby_dsp
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Very basic audio/DSP gem with C++ guts for speed
+test_files: []