gtcrn 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 684bab48a155c6ad43d42479fd8c361632a4c51d1ecf19f388e7487e575c3ce4
+  data.tar.gz: 78655c56cf93b6839ba193112534c02a4e8d73084c89ec6536dc9db6cfb12032
+SHA512:
+  metadata.gz: e71548aba12e685361ab24a6f2a1574a151cce46c622bf281f54254273b9f8e83ad7ced377ff0ad0b9096e530fef2c1dab289f6a3f1bd3457d511599960ecc64
+  data.tar.gz: a8ad7d5e076c0257a79a7952fc96ab15f001280113cbc05f7e0d49d6b4ddb95ae562a02ffc15e25d94b4b8b84a6390eaaae434cd5899b91fd0622af1a2e1f43f

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+.bundle/
+vendor/

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "gtcrn"]
+	path = gtcrn
+	url = https://github.com/Xiaobin-Rong/gtcrn.git

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kitaiti Makoto
+
+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,52 @@
+GTCRN
+=====
+
+Speech enhancement (denoising) using [GTCRN model](https://github.com/Xiaobin-Rong/gtcrn).
+
+SYNOPSIS
+--------
+
+```ruby
+require "gtcrn"
+
+output = GTCRN.new.enhance_speech("path/to/audio.wav", "path/to/output.wav")
+
+# You may omit output path
+output = GTCRN.new.enhance_speech("path/to/audio.wav")
+# => <Pathname:path/to/audio.enhanced.wav>
+````
+
+Audio file must be monoral WAV with 16kHz sampling rate and 16-bit per sample..
+
+CLI
+---
+
+This gem ships with `gtcrn` command.
+
+    % gtcrn path/to/audio.wav path/to/output.wav
+    Enhanced file written to
+    path/to/output.wav
+
+You may omit output path
+
+    % gtcrn path/to/audio.wav
+    Enhanced file written to
+    path/to/audio.enhanced.wav
+
+ENHANCE AUDIO DATA
+------------------
+
+You can also enhance audio data in memory:
+
+```ruby
+waveform, sample_rate = TorchAudio.load("path/to/audio.wav")
+enhanced = GTCRN.new.enhance_speech_waveform(waveform)
+TorchAudio.save("path/to/output.wav", enhanced.squeeze, sample_rate)
+```
+
+LICENSE
+-------
+
+MIT license. See LICENSE file.
+
+GTCRN ONNX model under vendor/gtcrn directory is distributed under MIT license by Rong Xiaobin. See vendor/gtcrn/LICENSE file.

data/Rakefile

@@ -0,0 +1,21 @@
+require "rake/testtask"
+require "rubygems/tasks"
+
+task default: :test
+
+gem_tasks = Gem::Tasks.new
+gemspec = gem_tasks.build.gem.project.gemspecs["gtcrn"]
+
+vendor_files = FileList[gemspec.files.select {|path| path.start_with?("vendor/gtcrn/")}]
+vendor_files.each do |f|
+  src = f.pathmap("%{vendor/,./}p")
+  dir = f.pathmap("%d")
+
+  directory dir
+  file f => [src, dir] do |t|
+    copy t.source, t.name
+  end
+end
+
+Rake::TestTask.new test: vendor_files
+task build: vendor_files

data/bin/gtcrn

@@ -0,0 +1,11 @@
+require "gtcrn"
+
+def main(argv)
+  input = argv.shift
+  abort "Specify input file" unless input
+  output = GTCRN.new.enhance_speech(input, argv.shift)
+  $stderr.puts "Enhanced file written to"
+  $stderr.puts output
+end
+
+main ARGV

data/gtcrn.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name = "gtcrn"
+  s.version = "0.0.1"
+  s.authors = ["Kitaiti Makoto"]
+  s.email = ["KitaitiMakoto@gmail.com"]
+  s.summary = "Denoises audio"
+  s.description = "Denoises audio (Speech Enhancement) using GTCRN model"
+  s.license = "MIT"
+  s.homepage = "https://gitlab.com/KitaitiMakoto/gtcrn"
+
+  s.files = `git ls-files -z`.split("\x0") + %w[
+    vendor/gtcrn/LICENSE
+    vendor/gtcrn/stream/onnx_models/gtcrn_simple.onnx
+  ]
+  s.executables = s.files.filter_map {|f| File.basename(f) if f.start_with?("bin/")}
+
+  s.add_runtime_dependency "onnxruntime"
+  s.add_runtime_dependency "torch-rb"
+  s.add_runtime_dependency "torchaudio"
+  s.add_runtime_dependency "numo-narray-alt"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rubygems-tasks"
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "test-unit-notify"
+  s.add_development_dependency "terminal-notifier" if RUBY_PLATFORM.match?(/darwin/)
+  s.add_development_dependency "wavefile"
+end

data/lib/gtcrn.rb

@@ -0,0 +1,71 @@
+require "pathname"
+require "torchaudio"
+require "torch"
+require "onnxruntime"
+require "numo/narray/alt"
+
+class GTCRN
+  MODEL_PATH = File.join(__dir__, "../vendor/gtcrn/stream/onnx_models/gtcrn_simple.onnx").freeze
+  ISTFT_OPTS = {
+    n_fft: 512,
+    hop_length: 256,
+    win_length: 512,
+    window: Torch.hann_window(512).pow(0.5)
+  }
+  STFT_OPTS = ISTFT_OPTS.merge(
+    pad_mode: "reflect",
+    return_complex: true
+  )
+
+  def initialize
+    @session = OnnxRuntime::InferenceSession.new(MODEL_PATH)
+  end
+
+  def enhance_speech(path, dest=nil)
+    path = Pathname(path)
+    if dest
+      dest = Pathname(dest)
+      if dest.directory?
+        dest = dest/path.basename.sub_ext(".enhanced" + path.extname)
+      end
+    else
+      dest = path.sub_ext(".enhanced" + path.extname)
+    end
+
+    waveform, sample_rate = TorchAudio.load(path.to_path)
+    raise "Sampling rate must be 16000 Hz, but given: #{sample_rate} Hz" unless sample_rate == 16000
+    enhanced = enhance_speech_waveform(waveform)
+    TorchAudio.save(dest.to_path, enhanced.squeeze, sample_rate)
+
+    dest
+  end
+
+  def enhance_speech_waveform(waveform)
+    conv_cache, tra_cache, inter_cache = 1.upto(3).collect {|i| Numo::SFloat.zeros(*@session.inputs[i][:shape]) }
+    inputs = Torch.view_as_real(
+      Torch.stft(waveform[0], **STFT_OPTS)[nil]
+    ).numo
+    outputs = []
+    inputs.shape[-2].times do |i|
+      enh, conv_cache, tra_cache, inter_cache = @session.run(
+        @session.outputs.collect {|output| output[:name]},
+        {
+          mix: OnnxRuntime::OrtValue.from_numo(inputs[0.., 0.., i..i, 0..]),
+          conv_cache: OnnxRuntime::OrtValue.from_numo(conv_cache),
+          tra_cache: OnnxRuntime::OrtValue.from_numo(tra_cache),
+          inter_cache: OnnxRuntime::OrtValue.from_numo(inter_cache)
+        },
+        output_type: :numo
+      )
+      outputs << enh
+    end
+    concated = Numo::NArray.concatenate(outputs, axis: 2)
+    real = concated[0.., 0.., 0.., 0]
+    imag = concated[0.., 0.., 0.., 1]
+    enhanced = Torch.istft(
+      Torch.from_numo(real) + 1i * Torch.from_numo(imag),
+      **ISTFT_OPTS
+    )
+    enhanced
+  end
+end

data/test/helper.rb

@@ -0,0 +1,5 @@
+require "test/unit"
+require "test/unit/notify"
+require "terminal-notifier" if RUBY_PLATFORM.match?(/darwin/)
+
+require "gtcrn"

data/test/test_gtcrn.rb

@@ -0,0 +1,22 @@
+require_relative "helper"
+require "tmpdir"
+require "wavefile"
+
+class TestGTCRN < Test::Unit::TestCase
+  def test_enhance_speech
+    Dir.mktmpdir do |dir|
+      audio = "gtcrn/test_wavs/mix.wav"
+      dest = GTCRN.new.enhance_speech(audio, dir)
+      assert_path_exist dest
+
+      source = WaveFile::Reader.new(audio)
+      source.class
+      enhanced = WaveFile::Reader.new(dest.to_path)
+      enhanced.close
+      assert enhanced.format.mono?
+      assert_equal 16, enhanced.format.bits_per_sample
+      assert_equal 16000, enhanced.format.sample_rate
+      assert source.total_sample_frames - enhanced.total_sample_frames < 512
+    end
+  end
+end

data/vendor/gtcrn/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Rong Xiaobin
+
+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.

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: gtcrn
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kitaiti Makoto
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: onnxruntime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: torch-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: torchaudio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: numo-narray-alt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit-notify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wavefile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Denoises audio (Speech Enhancement) using GTCRN model
+email:
+- KitaitiMakoto@gmail.com
+executables:
+- gtcrn
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitmodules"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/gtcrn
+- gtcrn.gemspec
+- lib/gtcrn.rb
+- test/helper.rb
+- test/test_gtcrn.rb
+- vendor/gtcrn/LICENSE
+- vendor/gtcrn/stream/onnx_models/gtcrn_simple.onnx
+homepage: https://gitlab.com/KitaitiMakoto/gtcrn
+licenses:
+- MIT
+metadata: {}
+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: 4.0.3
+specification_version: 4
+summary: Denoises audio
+test_files: []