dsprb 1.0.0

data/sig/dsprb.rbs

@@ -0,0 +1,385 @@
+module DSP
+  VERSION: String
+
+  type samples = ::Array[::Numeric]
+  type frame = ::Array[::Numeric]
+  type spectrum = ::Array[::Float]
+
+  interface _Transform
+    def call: (::Array[::Float], ::Array[::Float]) -> [::Array[::Float], ::Array[::Float]]
+    def size: () -> ::Integer
+  end
+
+  interface _WindowFunction
+    def call: (::Integer) -> ::Array[::Float]
+  end
+
+  type window = _WindowFunction | ::Symbol
+
+  class Error < ::StandardError
+  end
+
+  class FormatError < Error
+  end
+
+  class UnknownStrategyError < Error
+  end
+
+  def self.read: (::String) -> Waveform
+  def self.decode: (::String) -> Waveform
+  def self.pitch: (Waveform, **untyped) -> PitchTrack
+  def self.formants: (Waveform, **untyped) -> ::Array[::Float]
+  def self.decimate: (Waveform, ::Integer) -> Waveform
+  def self.lowpass: (Waveform, cutoff: ::Numeric, ?sections: ::Integer) -> Waveform
+  def self.highpass: (Waveform, cutoff: ::Numeric, ?sections: ::Integer) -> Waveform
+  def self.filter: (Waveform, Biquad, ::Integer) -> Waveform
+
+  def self.mfcc: (
+    Waveform,
+    ?size: ::Integer,
+    ?coefficients: ::Integer,
+    ?window_seconds: ::Float,
+    ?hop_seconds: ::Float,
+    **untyped
+  ) -> ::Array[::Array[::Float]]
+
+  module Resolver
+    def self.call: (untyped, ::Hash[::Symbol, untyped], ::String) -> untyped
+  end
+
+  module Parabolic
+    FLAT_TOLERANCE: ::Float
+
+    def self.vertex_offset: (::Float, ::Float, ::Float) -> ::Float
+  end
+
+  class Waveform
+    attr_reader samples: samples
+    attr_reader sample_rate: ::Float
+
+    def self.new: (samples: samples, sample_rate: ::Numeric) -> Waveform
+    def length: () -> ::Integer
+    def duration: () -> ::Float
+    def nyquist: () -> ::Float
+    def empty?: () -> bool
+    def frames: (window: ::Integer, hop: ::Integer) -> ::Array[frame]
+    def seconds_to_samples: (::Numeric) -> ::Integer
+    def with: (**untyped) -> Waveform
+    def to_h: () -> ::Hash[::Symbol, untyped]
+  end
+
+  module Wav
+    PCM: ::Integer
+    IEEE_FLOAT: ::Integer
+    EXTENSIBLE: ::Integer
+    HEADER_BYTES: ::Integer
+    CHUNK_HEADER_BYTES: ::Integer
+    EIGHT_BIT_MIDPOINT: ::Float
+
+    def self.read: (::String) -> Waveform
+    def self.decode: (::String) -> Waveform
+    def self.assert_riff!: (::String) -> void
+    def self.decode_samples: (::String, ::Integer?, ::Integer?) -> ::Array[::Float]
+    def self.scale: (::Array[::Integer], ::Integer) -> ::Array[::Float]
+    def self.decode_packed_24: (::String) -> ::Array[::Float]
+    def self.downmix: (::Array[::Float], ::Integer?) -> ::Array[::Float]
+  end
+
+  module Window
+    HAMMING: ::Array[::Float]
+    HANN: ::Array[::Float]
+    BLACKMAN: ::Array[::Float]
+    REGISTRY: ::Hash[::Symbol, _WindowFunction]
+    DEFAULT: ::Symbol
+
+    def self.rectangular: (::Integer) -> ::Array[::Float]
+    def self.hamming: (::Integer) -> ::Array[::Float]
+    def self.hann: (::Integer) -> ::Array[::Float]
+    def self.blackman: (::Integer) -> ::Array[::Float]
+    def self.cosine_sum: (::Integer, ::Array[::Float]) -> ::Array[::Float]
+    def self.apply: (frame, ::Array[::Float]) -> ::Array[::Float]
+    def self.assert_length!: (untyped) -> void
+    def self.resolve: (window) -> _WindowFunction
+  end
+
+  module Framing
+    DEFAULT_PREEMPHASIS: ::Float
+
+    def self.frames: (samples, window: ::Integer, hop: ::Integer) -> ::Array[frame]
+    def self.frame_count: (::Integer, window: ::Integer, hop: ::Integer) -> ::Integer
+    def self.preemphasis: (samples, ?coefficient: ::Numeric) -> ::Array[::Float]
+  end
+
+  module Fourier
+    class Radix2
+      attr_reader size: ::Integer
+
+      def initialize: (::Integer) -> void
+      def call: (::Array[::Float], ::Array[::Float]) -> [::Array[::Float], ::Array[::Float]]
+    end
+  end
+
+  class Spectrum
+    attr_reader size: ::Integer
+    attr_reader bins: ::Integer
+    attr_reader transform: _Transform
+
+    def initialize: (::Integer, ?transform: _Transform?) -> void
+    def power: (frame) -> spectrum
+    def magnitude: (frame) -> spectrum
+    def frequencies: (::Numeric) -> ::Array[::Float]
+    def bin_of: (::Numeric, ::Numeric) -> ::Integer
+  end
+
+  module Scales
+    MEL_SCALE: ::Float
+    MEL_BREAK_HZ: ::Float
+    SEMITONES_PER_OCTAVE: ::Float
+
+    def self.hz_to_mel: (::Numeric) -> ::Float
+    def self.mel_to_hz: (::Numeric) -> ::Float
+    def self.hz_to_semitones: (::Numeric, reference: ::Numeric) -> ::Float
+    def self.semitones_to_hz: (::Numeric, reference: ::Numeric) -> ::Float
+  end
+
+  class MelFilterbank
+    class Band
+      attr_reader offset: ::Integer
+      attr_reader weights: ::Array[::Float]
+
+      def self.new: (offset: ::Integer, weights: ::Array[::Float]) -> Band
+      def length: () -> ::Integer
+    end
+
+    DEFAULT_FILTERS: ::Integer
+    DEFAULT_LOW_HZ: ::Float
+    ENERGY_FLOOR: ::Float
+
+    attr_reader sample_rate: ::Float
+    attr_reader size: ::Integer
+    attr_reader filters: ::Integer
+    attr_reader low: ::Float
+    attr_reader high: ::Float
+    attr_reader warp: ::Float
+    attr_reader bands: ::Array[Band]
+
+    def initialize: (
+      sample_rate: ::Numeric,
+      size: ::Integer,
+      ?filters: ::Integer,
+      ?low: ::Numeric,
+      ?high: ::Numeric?,
+      ?warp: ::Numeric
+    ) -> void
+
+    def energies: (spectrum) -> ::Array[::Float]
+    def log_energies: (spectrum) -> ::Array[::Float]
+    def center_frequencies: () -> ::Array[::Float]
+  end
+
+  module Dct
+    def self.two: (::Array[::Numeric], ::Integer) -> ::Array[::Float]
+  end
+
+  class Mfcc
+    DEFAULT_COEFFICIENTS: ::Integer
+    DEFAULT_SIZE: ::Integer
+    DEFAULT_WINDOW_SECONDS: ::Float
+    DEFAULT_HOP_SECONDS: ::Float
+
+    attr_reader filterbank: MelFilterbank
+    attr_reader spectrum: Spectrum
+    attr_reader coefficients: ::Integer
+
+    def self.for: (sample_rate: ::Numeric, ?size: ::Integer, ?coefficients: ::Integer, **untyped) -> Mfcc
+    def initialize: (filterbank: MelFilterbank, ?coefficients: ::Integer, ?spectrum: Spectrum?) -> void
+    def call: (spectrum) -> ::Array[::Float]
+
+    def sequence: (
+      Waveform,
+      ?window_seconds: ::Numeric,
+      ?hop_seconds: ::Numeric,
+      ?window: window,
+      ?preemphasis: ::Numeric?
+    ) -> ::Array[::Array[::Float]]
+  end
+
+  class Decimator
+    DEFAULT_TAPS: ::Integer
+    CUTOFF_RATIO: ::Float
+
+    attr_reader factor: ::Integer
+    attr_reader taps: ::Integer
+    attr_reader kernel: ::Array[::Float]
+
+    def self.factor_for: (::Numeric, ::Numeric) -> ::Integer
+    def initialize: (::Integer, ?taps: ::Integer) -> void
+    def call: (Waveform) -> Waveform
+  end
+
+  module Autocorrelation
+    def self.call: (frame, ::Integer) -> ::Array[::Float]
+  end
+
+  module Lpc
+    DENOMINATOR_FLOOR: ::Float
+    UNBOUNDED_MAGNITUDE: ::Float
+
+    class Model
+      attr_reader coefficients: ::Array[::Float]
+      attr_reader error: ::Float
+
+      def self.new: (coefficients: ::Array[::Float], error: ::Float) -> Model
+      def order: () -> ::Integer
+      def envelope: (points: ::Integer) -> ::Array[::Float]
+    end
+
+    def self.solve: (frame, order: ::Integer) -> Model
+    def self.levinson: (::Array[::Float], ::Integer) -> Model
+    def self.advance: (::Array[::Float], ::Integer, ::Float) -> ::Array[::Float]
+  end
+
+  class Formants
+    class Peak
+      attr_reader frequency: ::Float
+      attr_reader amplitude: ::Float
+
+      def self.new: (frequency: ::Float, amplitude: ::Float) -> Peak
+    end
+
+    DEFAULT_MAXIMUM_HZ: ::Float
+    DEFAULT_COUNT: ::Integer
+    DEFAULT_RESOLUTION: ::Integer
+    DEFAULT_SEPARATION_HZ: ::Float
+    DEFAULT_EDGE_MARGIN_HZ: ::Float
+    MINIMUM_SAMPLES: ::Integer
+    ENERGY_FLOOR: ::Float
+    LOG_FLOOR: ::Float
+
+    attr_reader maximum_frequency: ::Float
+    attr_reader count: ::Integer
+    attr_reader resolution: ::Integer
+    attr_reader separation: ::Float
+    attr_reader edge_margin: ::Float
+
+    def initialize: (
+      ?maximum_frequency: ::Numeric,
+      ?count: ::Integer,
+      ?resolution: ::Integer,
+      ?separation: ::Numeric,
+      ?edge_margin: ::Numeric
+    ) -> void
+
+    def call: (Waveform) -> ::Array[::Float]
+    def peaks: (Waveform) -> ::Array[Peak]
+  end
+
+  class PitchTrack
+    attr_reader f0: ::Array[::Float]
+    attr_reader confidence: ::Array[::Float]
+    attr_reader times: ::Array[::Float]
+    attr_reader hop_seconds: ::Float
+
+    def self.new: (
+      f0: ::Array[::Float],
+      confidence: ::Array[::Float],
+      times: ::Array[::Float],
+      hop_seconds: ::Float
+    ) -> PitchTrack
+
+    def length: () -> ::Integer
+    def empty?: () -> bool
+    def voiced_frames: () -> ::Integer
+    def voiced_ratio: () -> ::Float
+    def voiced_f0: () -> ::Array[::Float]
+    def each_voiced: () { (::Float, ::Float, ::Float) -> void } -> void
+                   | () -> ::Enumerator[[::Float, ::Float, ::Float], void]
+  end
+
+  class Yin
+    DEFAULT_MINIMUM_HZ: ::Float
+    DEFAULT_MAXIMUM_HZ: ::Float
+    DEFAULT_HOP_SECONDS: ::Float
+    DEFAULT_THRESHOLD: ::Float
+    DEFAULT_VOICED_THRESHOLD: ::Float
+    DEFAULT_WORKING_RATE: ::Float
+    MAXIMUM_LAG: ::Integer
+
+    attr_reader minimum_frequency: ::Float
+    attr_reader maximum_frequency: ::Float
+    attr_reader hop_seconds: ::Float
+    attr_reader threshold: ::Float
+    attr_reader voiced_threshold: ::Float
+    attr_reader working_rate: ::Float
+
+    def initialize: (
+      ?minimum_frequency: ::Numeric,
+      ?maximum_frequency: ::Numeric,
+      ?hop_seconds: ::Numeric,
+      ?threshold: ::Numeric,
+      ?voiced_threshold: ::Numeric,
+      ?working_rate: ::Numeric
+    ) -> void
+
+    def call: (Waveform) -> PitchTrack
+  end
+
+  class SpectralMoments
+    ENERGY_FLOOR: ::Float
+    VARIANCE_FLOOR: ::Float
+    DEFAULT_LOW_HZ: ::Float
+    HIGH_MARGIN_HZ: ::Float
+
+    attr_reader centroid: ::Float
+    attr_reader spread: ::Float
+    attr_reader skewness: ::Float
+    attr_reader kurtosis: ::Float
+
+    def self.new: (centroid: ::Float, spread: ::Float, skewness: ::Float, kurtosis: ::Float) -> SpectralMoments
+    def self.zero: () -> SpectralMoments
+
+    def self.of: (
+      spectrum,
+      sample_rate: ::Numeric,
+      size: ::Integer,
+      ?low: ::Numeric,
+      ?high: ::Numeric?
+    ) -> SpectralMoments
+
+    def to_h: () -> ::Hash[::Symbol, ::Float]
+  end
+
+  module Energy
+    FLOOR: ::Float
+
+    def self.frame_db: (frame) -> ::Float
+    def self.zero_crossing_rate: (frame) -> ::Float
+    def self.envelope_db: (samples, window: ::Integer, hop: ::Integer) -> ::Array[::Float]
+    def self.slide: (samples, ::Float, ::Integer, ::Integer, ::Integer) -> ::Float
+    def self.to_db: (::Float) -> ::Float
+  end
+
+  class Biquad
+    BUTTERWORTH_Q: ::Float
+    MINIMUM_NORMALIZED: ::Float
+    MAXIMUM_NORMALIZED: ::Float
+
+    attr_reader b0: ::Float
+    attr_reader b1: ::Float
+    attr_reader b2: ::Float
+    attr_reader a1: ::Float
+    attr_reader a2: ::Float
+
+    def self.new: (b0: ::Float, b1: ::Float, b2: ::Float, a1: ::Float, a2: ::Float) -> Biquad
+    def self.lowpass: (sample_rate: ::Numeric, cutoff: ::Numeric, ?q: ::Numeric) -> Biquad
+    def self.highpass: (sample_rate: ::Numeric, cutoff: ::Numeric, ?q: ::Numeric) -> Biquad
+
+    def call: (samples) -> ::Array[::Float]
+    def apply: (samples, ?sections: ::Integer) -> ::Array[::Float]
+    def to_h: () -> ::Hash[::Symbol, ::Float]
+  end
+
+  module Curve
+    def self.resample: (::Array[::Numeric], ::Integer) -> ::Array[::Float]
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: dsprb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Den Patin
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.4'
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: 'Acoustic analysis of speech in pure Ruby: WAV decoding, radix-2 FFT
+  and power spectra, generalized cosine windows, mel filterbanks and MFCC, the YIN
+  fundamental frequency estimator, linear predictive coding by the Levinson-Durbin
+  recursion with formant extraction from the all-pole envelope, spectral moments,
+  Butterworth biquads, windowed-sinc decimation and short-term energy measures. No
+  dependencies, no native extensions, deterministic output.'
+email: hi@dpat.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/dsprb.rb
+- lib/dsprb/autocorrelation.rb
+- lib/dsprb/biquad.rb
+- lib/dsprb/curve.rb
+- lib/dsprb/dct.rb
+- lib/dsprb/decimator.rb
+- lib/dsprb/energy.rb
+- lib/dsprb/errors.rb
+- lib/dsprb/formants.rb
+- lib/dsprb/fourier.rb
+- lib/dsprb/framing.rb
+- lib/dsprb/lpc.rb
+- lib/dsprb/mel_filterbank.rb
+- lib/dsprb/mfcc.rb
+- lib/dsprb/parabolic.rb
+- lib/dsprb/pitch_track.rb
+- lib/dsprb/resolver.rb
+- lib/dsprb/scales.rb
+- lib/dsprb/spectral_moments.rb
+- lib/dsprb/spectrum.rb
+- lib/dsprb/version.rb
+- lib/dsprb/wav.rb
+- lib/dsprb/waveform.rb
+- lib/dsprb/window.rb
+- lib/dsprb/yin.rb
+- sig/dsprb.rbs
+homepage: https://github.com/taiwancards/dsprb
+licenses:
+- WTFPL
+metadata:
+  source_code_uri: https://github.com/taiwancards/dsprb
+  changelog_uri: https://github.com/taiwancards/dsprb/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/taiwancards/dsprb/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Speech signal processing and acoustic feature extraction for numeric signals
+test_files: []