ruby_dsp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1e6d776eecb15e90862b43ef2db1be0e05f9e0fc9be930cb7ba50164daf424da
+  data.tar.gz: 6c34fdbb2eab40ce50a95df9d2676fc6ba1113e72f3eba4d1988e027da996981
+SHA512:
+  metadata.gz: be8f2b87ef6dd6b5f0f830379b820778035b13eb89ee6c83660f48e4c02cf70917ed40bdcf5d43740e9ef13d7d746b7edcd24cddc4f690499a50625ab21da7dc
+  data.tar.gz: 3f7b06d06f1f7e5b457c044777033b58d123a7c1a8c02b4e35c5fbf76ff732995f6ee905442329283bd6bcc9ce0fe95c64e71cb2bfade703e7c35e345ad0f008

data/.gitignore

@@ -0,0 +1,10 @@
+tmp
+pkg
+Gemfile.lock
+doc
+.*
+*.gem
+*.o
+*.so
+*.bundle
+Makefile

data/Gemfile

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

data/README.md

@@ -0,0 +1,80 @@
+# RubyDSP
+
+> 🚧 **Status:** This project is currently in early development. It is fully functional, but API changes are expected.
+
+**RubyDSP** is an audio processing and DSP Ruby gem. Ultimately, it aims to be `librosa`-wannabe for Ruby. It uses C++ under the hood, utilizing [miniaudio](https://miniaud.io/) and [Rice](https://github.com/jasonroelofs/rice)
+
+## Features
+
+* **Fast:** Basically all of the code is written in C++. While not extremely optimized currently, it still absolutely shreds native Ruby.
+* **Format Agnostic Loading:** Automatically decodes standard audio formats (WAV, MP3, FLAC) via `miniaudio`.
+* **Zero-Dependency Native Build:** No need to install `ffmpeg` or `libsndfile` on your system.
+* **YARD Support:** Includes pure-Ruby stubs (in `stubs`, duh) for IDE autocomplete and inline documentation.
+
+## Installation
+
+Since the gem is currently in pre-release, you can install it directly from GitHub by adding this line to your application's `Gemfile`:
+
+```ruby
+source "https://rubygems.org"
+
+gem 'ruby_dsp', github: 'cichrrad/rubyDSP'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+*(Note: Installing this gem requires a modern C++ compiler, as it builds the native extensions directly on your machine upon installation. It requires Ruby 3.0+).*
+
+After this, you can run your scripts with
+
+```bash
+$ bundle exec ruby script.rb
+```
+
+## Quick Start
+
+Here is a quick look at what you can do with a loaded `AudioTrack`:
+
+```ruby
+require 'ruby_dsp'
+
+# Load an audio file
+track = RubyDSP::AudioTrack.new("raw_vocals.wav")
+
+puts track 
+# => ['raw_vocals.wav', 12.450s duration, 2 channel(s), 48000Hz sample rate]
+
+# Do stuff!
+track.to_mono!             # Averages channels into mono
+track.resample!(44100)     # Linearly resamples to target rate
+track.trim_silence!(-60.0) # Strips leading/trailing silence below -60dB
+
+# Analysis & Math
+puts "Peak Amp: #{track.peak_amp}"
+puts "Overall RMS: #{track.rms}"
+puts "Overall ZCR: #{track.zcr}"
+
+# You can also get framed analysis for time-series data:
+# framed_rms_data = track.framed_rms(2048, 512) also works
+framed_rms_data = track.framed_rms(frame_length: 2048, hop_length: 512)
+
+
+# Save the results
+track.save_track("processed_vocals.wav")
+```
+
+## Development
+
+If you want to clone the repo and hack on the C++ guts, we have fully automated the compilation and testing steps.
+
+1. Clone the repo and run `bundle install` to grab the development dependencies.
+2. Run `rake test` — this will automatically compile the C++ `extconf.rb` and run the Minitest suite.
+3. Run `rake doc:generate ; rake doc:server` — this will compile the YARD stubs into HTML and boot a live-reloading local web server at `http://localhost:8808` so you can read the docs!
+
+## License
+
+The gem is available as open source under the terms of the **MIT License**.

data/Rakefile

@@ -0,0 +1,31 @@
+# Rakefile
+require 'bundler/gem_tasks'
+require 'rake/extensiontask'
+require 'rake/testtask'
+
+Rake::ExtensionTask.new('ruby_dsp') do |ext|
+  ext.lib_dir = 'lib/ruby_dsp'
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task test: :compile
+
+namespace :doc do
+  desc 'Generate static HTML documentation in the doc/ folder'
+  task :generate do
+    puts 'Generating YARD documentation...'
+    sh 'yard doc'
+  end
+
+  desc 'Start the YARD documentation server with live reload'
+  task :server do
+    puts 'Starting YARD live server...'
+    puts 'Open http://localhost:8808 in your browser.'
+    puts 'Press Ctrl+C to stop.'
+    exec 'yard server --reload'
+  end
+end

data/ext/ruby_dsp/extconf.rb

@@ -0,0 +1,6 @@
+# ext/ruby_dsp/extconf.rb
+require 'mkmf-rice'
+
+$CXXFLAGS += ' -std=c++17 -O3'
+
+create_makefile('ruby_dsp/ruby_dsp')