json-waveform 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6865a7f5c7f07c8c15f4f58a06b1c6ff840dae4e
+  data.tar.gz: 3b6d9f92cdc05efc309b0125e7480149620c6aba
+SHA512:
+  metadata.gz: 6147921f5a577d809f1fff7ebc1adfb5d29177c030bb1882d7043768ceb5e8705976fbb8a53e632c2a72f1eb3e4cf63591b8094ab44596ed47e69a40aaab11d3
+  data.tar.gz: aaeea25e81dd1e3a7d68090e8398e191b2c37234a11263f05d625f0b3708407ec741d42b9f113559d91e82e44d3f6c004bc71c75257cb74b65bb324707703b4e

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Esteban Pastorino
+
+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,65 @@
+JsonWaveform
+========
+
+JsonWaveform is a class to generate waveform json files from audio files. You can combine it with http://waveformjs.org/ to create awesome waveforms in webpages. It also comes with a handy CLI you can use to generate waveform json files on the command line.
+
+It is *heavily* influenced by https://github.com/benalavi/waveform
+
+Installation
+============
+
+Waveform depends on `ruby-audio`, which in turn depends on libsndfile.
+
+Build libsndfile from (http://www.mega-nerd.com/libsndfile/), install it via `apt` (`sudo apt-get install libsndfile1-dev`), `libsndfile` in brew, etc...
+
+Then:
+
+    $ gem install json-waveform
+
+NOTE: If `ruby-audio` fails to compile and you have `libsndfile` available, it may be because of this: http://stackoverflow.com/questions/19919640/ruby-audio-1-6-1-install-error-with-installed-libsndfile-1-0-25
+
+CLI Usage
+=========
+
+    $ json-waveform song.wav
+
+There are some nifty options you can supply to switch things up:
+
+    -s sets the samples of the waveform.
+    -A sets the max amplitude.
+    -m sets the method used to sample the source audio file, it can either be
+        'peak' or 'rms'. 'peak' is probably what you want because it looks
+        cooler, but 'rms' is closer to what you actually hear.
+
+And to see (almost) this same info:
+
+    -h will print out a help screen with all this info.
+
+    $ json-waveform Motley\ Crüe/Kickstart\ my\ Heart.wav
+
+Usage in code
+=============
+
+The CLI is really just a thin wrapper around the JsonWaveform class, which you can also use in your programs for reasons I haven't thought of. The JsonWaveform class takes pretty much the same options as the CLI when generating waveforms.
+
+```ruby
+JsonWaveform("foo.wav", samples: 1000) # => [ 0, 0.1, 0.15, ... ]
+```
+
+Requirements
+============
+
+`ruby-audio`
+
+The gem version, *not* the old outdated library listed on RAA. `ruby-audio` is a wrapper for `libsndfile`. To install the necessary libs to build `ruby-audio` you can do `sudo apt-get install libsndfile1-dev` on Ubuntu or `brew install libsndfile` on OSX.
+
+
+Tests
+=====
+
+**They are not there yet, but will be run using: **
+
+    $ make
+
+Sample sound file used in tests is in the Public Domain from soundbible.com: <http://soundbible.com/1598-Electronic-Chime.html>.
+

data/bin/json-waveform

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+require "json-waveform"
+require "optparse"
+
+options = JsonWaveform::DEFAULT_OPTIONS
+optparse = OptionParser.new do |o|
+  o.banner = "Usage: waveform [options] source_audio"
+  o.version = Waveform::VERSION
+
+  o.on("-s", "--samples SAMPLES", "Samples generated from the original file (i.e.: waveform width) -- Default #{Waveform::DefaultOptions[:samples]}.") do |samples|
+    options[:samples] = samples.to_i
+  end
+
+  o.on("-A", "--amplitude AMPLITUDE", "Max amplitude of the waveform values-- Default #{Waveform::DefaultOptions[:amplitude]}.") do |amplitude|
+    options[:amplitude] = amplitude.to_i
+  end
+
+  o.on("-a", "--autosample MSEC", "Sets the width of the waveform based on the audio length, using a resolution of the given msec per sample.") do |msec|
+    options[:auto_sample] = msec.to_i
+  end
+
+  o.on("-m", "--method METHOD", "Wave analyzation method (can be 'peak' or 'rms') -- Default '#{Waveform::DefaultOptions[:method]}'.") do |method|
+    options[:method] = method.to_sym
+  end
+
+  o.on("-h", "--help", "Display this screen") do
+    puts o
+    exit
+  end
+end
+
+optparse.parse!
+
+begin
+  result = Waveform.generate(ARGV[0], options)
+  puts result
+rescue Waveform::ArgumentError => e
+  puts e.message + "\n\n"
+  puts optparse
+rescue Waveform::RuntimeError => e
+  puts e.message
+end
+

data/json-waveform.gemspec

@@ -0,0 +1,25 @@
+require "./lib/json-waveform/version"
+
+Gem::Specification.new do |s|
+  s.name              = "json-waveform"
+  s.version           = JsonWaveform::VERSION
+  s.summary           = "Generate waveform JSON files from audio files"
+  s.description       = "Generate waveform JSON information from audio files, compatible with http://waveformjs.org/."
+  s.authors           = ["Esteban pastorino"]
+  s.email             = ["ejpastorino@gmail.com"]
+  s.homepage          = "http://github.com/kitop/json-waveform"
+
+  s.files = Dir[
+    "LICENSE",
+    "README.md",
+    "makefile",
+    "lib/**/*.rb",
+    "*.gemspec",
+    "test/**/*.rb",
+    "bin/*"
+  ]
+
+  s.executables << "json-waveform"
+
+  s.add_dependency "ruby-audio"
+end

data/lib/json-waveform/version.rb

@@ -0,0 +1,3 @@
+class JsonWaveform
+  VERSION = "0.0.1".freeze
+end

data/lib/json-waveform.rb

@@ -0,0 +1,150 @@
+require File.join(File.dirname(__FILE__), "json-waveform/version")
+
+require "ruby-audio"
+
+class JsonWaveform
+  DEFAULT_OPTIONS = {
+    :method => :peak,
+    :samples => 1800,
+    :amplitude => 1
+  }
+
+  # Scope these under Waveform so you can catch the ones generated by just this
+  # class.
+  class RuntimeError < ::RuntimeError;end;
+  class ArgumentError < ::ArgumentError;end;
+
+  class << self
+    # Generate a Waveform JSON file from the given filename with the given options.
+    #
+    # Available options (all optional) are:
+    #
+    #   :method => The method used to read sample frames, available methods
+    #     are peak and rms. peak is probably what you're used to seeing, it uses
+    #     the maximum amplitude per sample to generate the waveform, so the
+    #     waveform looks more dynamic. RMS gives a more fluid waveform and
+    #     probably more accurately reflects what you hear, but isn't as
+    #     pronounced (typically).
+    #
+    #     Can be :rms or :peak
+    #     Default is :peak.
+    #
+    #   :samples => The amount of samples wanted
+    #     Default is 1800.
+    #
+    #   :amplitude => The amplitude of the final values
+    #     Default is 1.
+    #
+    #   :auto_width => msec per sample. This will overwrite the sample of the
+    #     final waveform depending on the length of the audio file.
+    #     Example:
+    #       100 => 1 sample per 100 msec; a one minute audio file will result in a width of 600 samples
+    #
+    # Example:
+    #   JsonWaveform.generate("Kickstart My Heart.wav")
+    #   JsonWaveform.generate("Kickstart My Heart.wav", :method => :rms)
+    #
+    def generate(source, options={})
+      options = DEFAULT_OPTIONS.merge(options)
+
+      raise ArgumentError.new("No source audio filename given, must be an existing sound file.") unless source
+      raise RuntimeError.new("Source audio file '#{source}' not found.") unless File.exist?(source)
+
+      if options[:auto_samples]
+        RubyAudio::Sound.open(source) do |audio|
+          options[:samples] = (audio.info.length * 1000 / options[:auto_samples].to_i).ceil
+        end
+      end
+
+      # Frames gives the amplitudes for each channel, for our waveform we're
+      # saying the "visual" amplitude is the average of the amplitude across all
+      # the channels. This might be a little weird w/ the "peak" method if the
+      # frames are very wide (i.e. the image width is very small) -- I *think*
+      # the larger the frames are, the more "peaky" the waveform should get,
+      # perhaps to the point of inaccurately reflecting the actual sound.
+      samples = frames(source, options[:samples], options[:method]).collect do |frame|
+        frame.inject(0.0) { |sum, peak| sum + peak } / frame.size
+      end
+
+      normalize(samples, options)
+    end
+
+    private
+
+    # Returns a sampling of frames from the given RubyAudio::Sound using the
+    # given method
+    def frames(source, samples, method = :peak)
+      raise ArgumentError.new("Unknown sampling method #{method}") unless [ :peak, :rms ].include?(method)
+
+      frames = []
+
+      RubyAudio::Sound.open(source) do |audio|
+        frames_read = 0
+        frames_per_sample = (audio.info.frames.to_f / samples.to_f).to_i
+        sample = RubyAudio::Buffer.new("float", frames_per_sample, audio.info.channels)
+
+        while(frames_read = audio.read(sample)) > 0
+          frames << send(method, sample, audio.info.channels)
+        end
+      end
+
+      frames
+    rescue RubyAudio::Error => e
+      raise e unless e.message == "File contains data in an unknown format."
+      raise JsonWaveform::RuntimeError.new("Source audio file #{source} could not be read by RubyAudio library -- Hint: non-WAV files are no longer supported, convert to WAV first using something like ffmpeg (RubyAudio: #{e.message})")
+    end
+
+    def normalize(samples, options)
+      samples.map do |sample|
+        # Half the amplitude goes above zero, half below
+        amplitude = sample * options[:amplitude].to_f
+        rounded = amplitude.round(2)
+        rounded.zero? || rounded == 1 ? rounded.to_i : rounded
+      end
+    end
+
+    # Returns an array of the peak of each channel for the given collection of
+    # frames -- the peak is individual to the channel, and the returned collection
+    # of peaks are not (necessarily) from the same frame(s).
+    def peak(frames, channels=1)
+      peak_frame = []
+      (0..channels-1).each do |channel|
+        peak_frame << channel_peak(frames, channel)
+      end
+      peak_frame
+    end
+
+    # Returns an array of rms values for the given frameset where each rms value is
+    # the rms value for that channel.
+    def rms(frames, channels=1)
+      rms_frame = []
+      (0..channels-1).each do |channel|
+        rms_frame << channel_rms(frames, channel)
+      end
+      rms_frame
+    end
+
+    # Returns the peak voltage reached on the given channel in the given collection
+    # of frames.
+    #
+    # TODO: Could lose some resolution and only sample every other frame, would
+    # likely still generate the same waveform as the waveform is so comparitively
+    # low resolution to the original input (in most cases), and would increase
+    # the analyzation speed (maybe).
+    def channel_peak(frames, channel=0)
+      peak = 0.0
+      frames.each do |frame|
+        next if frame.nil?
+        frame = Array(frame)
+        peak = frame[channel].abs if frame[channel].abs > peak
+      end
+      peak
+    end
+
+    # Returns the rms value across the given collection of frames for the given
+    # channel.
+    def channel_rms(frames, channel=0)
+      Math.sqrt(frames.inject(0.0){ |sum, frame| sum += (frame ? Array(frame)[channel] ** 2 : 0) } / frames.size)
+    end
+  end
+end

data/makefile

@@ -0,0 +1,4 @@
+.PHONY: console
+
+console: 
+	irb -I./lib -r json-waveform

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: json-waveform
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Esteban pastorino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-audio
+  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'
+description: Generate waveform JSON information from audio files, compatible with
+  http://waveformjs.org/.
+email:
+- ejpastorino@gmail.com
+executables:
+- json-waveform
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/json-waveform
+- json-waveform.gemspec
+- lib/json-waveform.rb
+- lib/json-waveform/version.rb
+- makefile
+homepage: http://github.com/kitop/json-waveform
+licenses: []
+metadata: {}
+post_install_message: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Generate waveform JSON files from audio files
+test_files: []