waveform 0.1.2 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ce38fd32793bd0e734bdd4a4d5fc35d1b23fd61bc7b3336b7cf2e4a3fedfe76
+  data.tar.gz: ed342c1ad243cab828bd48e85ded1d68ef837c5ca7a845779a81cc1d0f1debc5
+SHA512:
+  metadata.gz: 5de7b29d02d0d8fc2890c4dd6e685e3140067c7b24bc48d3a97327d1c3b2dbb75fd386878da0f31035a7f9ba567f1293003d3ccb4119732fb717fedf412e7b3c
+  data.tar.gz: 3c02222c54dbc8561b7ddf5c41c47caebe93e45d8e3e298a32d2737d9e04152b256da595fdcb740a47aeb192f1d8bf30a5a4295aff364b70868f4ba774903aa0

data/README.md

@@ -14,10 +14,12 @@ Then:
 
     $ sudo gem install waveform
 
-Image creation depends on `chunky_png`, which has a faster native library called `oily_png` which will be used if availble.
+Image creation depends on `chunky_png`, which has a faster native library called `oily_png` which will be used if available.
 
     $ sudo gem install oily_png
 
+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
 =========
 
@@ -76,7 +78,7 @@ Tests
 =====
 
     $ rake
-    
+
 If you get an error about not being able to find ruby-audio gem (and you have ruby-audio gem) you might need to let rake know how to load your gems -- if you're using rubygems:
 
     $ export RUBYOPT="rubygems"
@@ -87,6 +89,10 @@ Sample sound file used in tests is in the Public Domain from soundbible.com: <ht
 Changes
 =======
 
+0.1.3
+-----
+  * Update for ruby 3.2 (replace `File.exists?` w/ `File.exist?`)
+
 0.1.2
 -----
   * Added more helpful deprecation notice for non-WAV audio files

data/bin/waveform

@@ -4,9 +4,9 @@ require "optparse"
 
 options = Waveform::DefaultOptions
 optparse = OptionParser.new do |o|
-  o.banner = "Usage: waveform [options] source_audio [ouput.png]"
+  o.banner = "Usage: waveform [options] source_audio [output.png]"
   o.version = Waveform::VERSION
-  
+
   o.on("-W", "--width WIDTH", "Width (in pixels) of generated waveform image -- Default #{Waveform::DefaultOptions[:width]}.") do |width|
     options[:width] = width.to_i
   end
@@ -15,6 +15,10 @@ optparse = OptionParser.new do |o|
     options[:height] = height.to_i
   end
 
+  o.on("-a", "--autowidth MSEC", "Sets the width of the waveform based on the audio length, using a resolution of the given msec per pixel.") do |msec|
+    options[:auto_width] = msec.to_i
+  end
+
   o.on("-c", "--color COLOR", "Color (hex code) to draw the waveform. Can also pass 'transparent' to cut it out of the background -- Default #{Waveform::DefaultOptions[:color]}.") do |color|
     if color == "transparent"
       options[:color] = :transparent
@@ -41,7 +45,7 @@ optparse = OptionParser.new do |o|
   end
 
   options[:force] = false
-  o.on("-F", "--force", "Force generationg of waveform if file exists") do
+  o.on("-F", "--force", "Force generation of waveform if file exists") do
     options[:force] = true
   end
 

data/lib/waveform/version.rb

@@ -1,3 +1,3 @@
 class Waveform
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/waveform.rb

@@ -17,38 +17,43 @@ class Waveform
     :force => false,
     :logger => nil
   }
-  
+
   TransparencyMask = "#00ff00"
   TransparencyAlternate = "#ffff00" # in case the mask is the background color!
-  
+
   attr_reader :source
-  
+
   # 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    
+
+  class << self
     # Generate a Waveform image at 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.
-    # 
+    #
     #   :width => The width (in pixels) of the final waveform image.
     #     Default is 1800.
-    # 
+    #
     #   :height => The height (in pixels) of the final waveform image.
     #     Default is 280.
-    # 
+    #
+    #   :auto_width => msec per pixel. This will overwrite the width of the
+    #     final waveform image depending on the length of the audio file.
+    #     Example:
+    #       100 => 1 pixel per 100 msec; a one minute audio file will result in a width of 600 pixels
+    #
     #   :background_color => Hex code of the background color of the generated
     #     waveform image.
     #     Default is #666666 (gray).
@@ -59,7 +64,7 @@ class Waveform
     #     Default is #00ccff (cyan-ish).
     #
     #   :force => Force generation of waveform, overwriting WAV or PNG file.
-    # 
+    #
     #   :logger => IOStream to log progress to.
     #
     # Example:
@@ -69,15 +74,21 @@ class Waveform
     #
     def generate(source, filename, options={})
       options = DefaultOptions.merge(options)
-      
+
       raise ArgumentError.new("No source audio filename given, must be an existing sound file.") unless source
       raise ArgumentError.new("No destination filename given for waveform") unless filename
       raise RuntimeError.new("Source audio file '#{source}' not found.") unless File.exist?(source)
-      raise RuntimeError.new("Destination file #{filename} exists. Use --force if you want to automatically remove it.") if File.exists?(filename) && !options[:force] === true
+      raise RuntimeError.new("Destination file #{filename} exists. Use --force if you want to automatically remove it.") if File.exist?(filename) && !options[:force] === true
 
       @log = Log.new(options[:logger])
       @log.start!
-      
+
+      if options[:auto_width]
+        RubyAudio::Sound.open(source) do |audio|
+          options[:width] = (audio.info.length * 1000 / options[:auto_width].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
@@ -87,30 +98,30 @@ class Waveform
       samples = frames(source, options[:width], options[:method]).collect do |frame|
         frame.inject(0.0) { |sum, peak| sum + peak } / frame.size
       end
-      
+
       @log.timed("\nDrawing...") do
         # Don't remove the file even if force is true until we're sure the
         # source was readable
-        if File.exists?(filename) && options[:force] === true
+        if File.exist?(filename) && options[:force] === true
           @log.out("Output file #{filename} encountered. Removing.")
           File.unlink(filename)
         end
-        
+
         image = draw samples, options
         image.save filename
       end
-      
-      @log.done!("Generated waveform '#{filename}'")      
+
+      @log.done!("Generated waveform '#{filename}'")
     end
-    
+
     private
-    
+
     # Returns a sampling of frames from the given RubyAudio::Sound using the
     # given method the sample size is determined by the given pixel width --
     # we want one sample frame per horizontal pixel.
     def frames(source, width, method = :peak)
       raise ArgumentError.new("Unknown sampling method #{method}") unless [ :peak, :rms ].include?(method)
-      
+
       frames = []
 
       RubyAudio::Sound.open(source) do |audio|
@@ -125,19 +136,19 @@ class Waveform
           end
         end
       end
-      
+
       frames
     rescue RubyAudio::Error => e
       raise e unless e.message == "File contains data in an unknown format."
       raise Waveform::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
-    
+
     # Draws the given samples using the given options, returns a ChunkyPNG::Image.
-    def draw(samples, options)      
+    def draw(samples, options)
       image = ChunkyPNG::Image.new(options[:width], options[:height],
         options[:background_color] == :transparent ? ChunkyPNG::Color::TRANSPARENT : options[:background_color]
       )
-      
+
       if options[:color] == :transparent
         color = transparent = ChunkyPNG::Color.from_hex(
           # Have to do this little bit because it's possible the color we were
@@ -152,7 +163,7 @@ class Waveform
       # Calling "zero" the middle of the waveform, like there's positive and
       # negative amplitude
       zero = options[:height] / 2.0
-    
+
       samples.each_with_index do |sample, x|
         # Half the amplitude goes above zero, half below
         amplitude = sample * options[:height].to_f / 2.0
@@ -160,7 +171,7 @@ class Waveform
         # go haywire.
         image.line(x, (zero - amplitude).round, x, (zero + amplitude).round, color)
       end
-      
+
       # Simple transparency masking, it just loops over every pixel and makes
       # ones which match the transparency mask color completely clear.
       if transparent
@@ -170,10 +181,10 @@ class Waveform
           end
         end
       end
-      
+
       image
     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).
@@ -194,10 +205,10 @@ class Waveform
       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
@@ -223,7 +234,7 @@ end
 class Waveform
   # A simple class for logging + benchmarking, nice to have good feedback on a
   # long batch operation.
-  # 
+  #
   # There's probably 10,000,000 other bechmarking classes, but writing this was
   # easier than using Google.
   class Log
@@ -245,7 +256,7 @@ class Waveform
     end
 
     # Starts a new benchmark clock and returns the index of the new clock.
-    # 
+    #
     # If .start! is called again before .end! then the time returned will be
     # the elapsed time from the next call to start!, and calling .end! again
     # will return the time from *this* call to start! (that is, the clocks are
@@ -279,4 +290,4 @@ class Waveform
       done!
     end
   end
-end    
+end

data/test/waveform_test.rb

@@ -4,14 +4,14 @@ require "test/unit"
 require "fileutils"
 
 module Helpers
-  def fixture(file)
+  def fixture_asset(file)
     File.join(File.dirname(__FILE__), "fixtures", file)
   end
-  
+
   def output(file)
     File.join(File.dirname(__FILE__), "output", file)
   end
-  
+
   def open_png(file)
     ChunkyPNG::Image.from_datastream(ChunkyPNG::Datastream.from_file(file))
   end
@@ -26,19 +26,19 @@ class WaveformTest < Test::Unit::TestCase
     Dir[output("*.*")].each{ |f| FileUtils.rm(f) }
     FileUtils.mkdir_p(output(""))
   end
-  
+
   def test_generates_waveform
-    Waveform.generate(fixture("sample.wav"), output("waveform_from_audio_source.png"))
-    assert File.exists?(output("waveform_from_audio_source.png"))
-      
+    Waveform.generate(fixture_asset("sample.wav"), output("waveform_from_audio_source.png"))
+    assert File.exist?(output("waveform_from_audio_source.png"))
+
     image = open_png(output("waveform_from_audio_source.png"))
     assert_equal ChunkyPNG::Color.from_hex(Waveform::DefaultOptions[:color]), image[60, 120]
     assert_equal ChunkyPNG::Color.from_hex(Waveform::DefaultOptions[:background_color]), image[0, 0]
   end
-    
+
   def test_generates_waveform_from_mono_audio_source_via_peak
-    Waveform.generate(fixture("mono_sample.wav"), output("waveform_from_mono_audio_source_via_peak.png"))
-    assert File.exists?(output("waveform_from_mono_audio_source_via_peak.png"))
+    Waveform.generate(fixture_asset("mono_sample.wav"), output("waveform_from_mono_audio_source_via_peak.png"))
+    assert File.exist?(output("waveform_from_mono_audio_source_via_peak.png"))
 
     image = open_png(output("waveform_from_mono_audio_source_via_peak.png"))
     assert_equal ChunkyPNG::Color.from_hex(Waveform::DefaultOptions[:color]), image[60, 120]
@@ -46,126 +46,134 @@ class WaveformTest < Test::Unit::TestCase
   end
 
   def test_generates_waveform_from_mono_audio_source_via_rms
-    Waveform.generate(fixture("mono_sample.wav"), output("waveform_from_mono_audio_source_via_rms.png"), :method => :rms)
-    assert File.exists?(output("waveform_from_mono_audio_source_via_rms.png"))
+    Waveform.generate(fixture_asset("mono_sample.wav"), output("waveform_from_mono_audio_source_via_rms.png"), :method => :rms)
+    assert File.exist?(output("waveform_from_mono_audio_source_via_rms.png"))
 
     image = open_png(output("waveform_from_mono_audio_source_via_rms.png"))
     assert_equal ChunkyPNG::Color.from_hex(Waveform::DefaultOptions[:color]), image[60, 120]
     assert_equal ChunkyPNG::Color.from_hex(Waveform::DefaultOptions[:background_color]), image[0, 0]
   end
-        
+
   def test_logs_to_given_io
     File.open(output("waveform.log"), "w") do |io|
-      Waveform.generate(fixture("sample.wav"), output("logged.png"), :logger => io)
+      Waveform.generate(fixture_asset("sample.wav"), output("logged.png"), :logger => io)
     end
-    
+
     assert_match /Generated waveform/, File.read(output("waveform.log"))
   end
-  
+
   def test_uses_rms_instead_of_peak
-    Waveform.generate(fixture("sample.wav"), output("peak.png"))
-    Waveform.generate(fixture("sample.wav"), output("rms.png"), :method => :rms)
+    Waveform.generate(fixture_asset("sample.wav"), output("peak.png"))
+    Waveform.generate(fixture_asset("sample.wav"), output("rms.png"), :method => :rms)
 
     rms = open_png(output("rms.png"))
     peak = open_png(output("peak.png"))
-    
+
     assert_equal ChunkyPNG::Color.from_hex(Waveform::DefaultOptions[:color]), peak[44, 43]
     assert_equal ChunkyPNG::Color.from_hex(Waveform::DefaultOptions[:background_color]), rms[44, 43]
     assert_equal ChunkyPNG::Color.from_hex(Waveform::DefaultOptions[:color]), rms[60, 120]
   end
-  
+
   def test_is_900px_wide
-    Waveform.generate(fixture("sample.wav"), output("width-900.png"), :width => 900)
-    
+    Waveform.generate(fixture_asset("sample.wav"), output("width-900.png"), :width => 900)
+
     image = open_png(output("width-900.png"))
-    
+
     assert_equal 900, image.width
   end
-  
+
   def test_is_100px_tall
-    Waveform.generate(fixture("sample.wav"), output("height-100.png"), :height => 100)
-    
+    Waveform.generate(fixture_asset("sample.wav"), output("height-100.png"), :height => 100)
+
     image = open_png(output("height-100.png"))
-    
+
     assert_equal 100, image.height
   end
-  
+
+  def test_has_auto_width
+    Waveform.generate(fixture_asset("sample.wav"), output("width-auto.png"), :auto_width => 10)
+
+    image = open_png(output("width-auto.png"))
+
+    assert_equal 209, image.width
+  end
+
   def test_has_red_background_color
-    Waveform.generate(fixture("sample.wav"), output("background_color-#ff0000.png"), :background_color => "#ff0000")
-    
+    Waveform.generate(fixture_asset("sample.wav"), output("background_color-#ff0000.png"), :background_color => "#ff0000")
+
     image = open_png(output("background_color-#ff0000.png"))
-    
+
     assert_equal ChunkyPNG::Color.from_hex("#ff0000"), image[0, 0]
   end
-  
+
   def test_has_transparent_background_color
-    Waveform.generate(fixture("sample.wav"), output("background_color-transparent.png"), :background_color => :transparent)
-    
+    Waveform.generate(fixture_asset("sample.wav"), output("background_color-transparent.png"), :background_color => :transparent)
+
     image = open_png(output("background_color-transparent.png"))
-    
+
     assert_equal ChunkyPNG::Color::TRANSPARENT, image[0, 0]
   end
-  
+
   def test_has_black_foreground_color
-    Waveform.generate(fixture("sample.wav"), output("color-#000000.png"), :color => "#000000")
-    
+    Waveform.generate(fixture_asset("sample.wav"), output("color-#000000.png"), :color => "#000000")
+
     image = open_png(output("color-#000000.png"))
-    
+
     assert_equal ChunkyPNG::Color.from_hex("#000000"), image[60, 120]
   end
-  
+
   def test_has_red_background_color_with_transparent_foreground_cutout
-    Waveform.generate(fixture("sample.wav"), output("background_color-#ff0000+color-transparent.png"), :background_color => "#ff0000", :color => :transparent)
-    
+    Waveform.generate(fixture_asset("sample.wav"), output("background_color-#ff0000+color-transparent.png"), :background_color => "#ff0000", :color => :transparent)
+
     image = open_png(output("background_color-#ff0000+color-transparent.png"))
-    
+
     assert_equal ChunkyPNG::Color.from_hex("#ff0000"), image[0, 0]
     assert_equal ChunkyPNG::Color::TRANSPARENT, image[60, 120]
   end
-  
+
   # Bright green is our transparency mask color, so this test ensures that we
   # don't destroy the image if the background also uses the transparency mask
   # color
   def test_has_transparent_foreground_on_bright_green_background
-    Waveform.generate(fixture("sample.wav"), output("background_color-#00ff00+color-transparent.png"), :background_color => "#00ff00", :color => :transparent)
-    
+    Waveform.generate(fixture_asset("sample.wav"), output("background_color-#00ff00+color-transparent.png"), :background_color => "#00ff00", :color => :transparent)
+
     image = open_png(output("background_color-#00ff00+color-transparent.png"))
-    
+
     assert_equal ChunkyPNG::Color.from_hex("#00ff00"), image[0, 0]
     assert_equal ChunkyPNG::Color::TRANSPARENT, image[60, 120]
   end
-  
+
   def test_raises_error_if_not_given_readable_audio_source
     assert_raise(Waveform::RuntimeError) do
-      Waveform.generate(fixture("sample.txt"), output("shouldnt_exist.png"))
+      Waveform.generate(fixture_asset("sample.txt"), output("shouldnt_exist.png"))
     end
   end
-  
+
   def test_overwrites_existing_waveform_if_force_is_true_and_file_exists
     FileUtils.touch output("overwritten.png")
 
-    Waveform.generate(fixture("sample.wav"), output("overwritten.png"), :force => true)
+    Waveform.generate(fixture_asset("sample.wav"), output("overwritten.png"), :force => true)
   end
 
   def test_raises_exception_if_waveform_exists_and_force_is_false
     FileUtils.touch output("wont_be_overwritten.png")
-    
+
     assert_raises Waveform::RuntimeError do
-      Waveform.generate(fixture("sample.wav"), output("wont_be_overwritten.png"), :force => false)
+      Waveform.generate(fixture_asset("sample.wav"), output("wont_be_overwritten.png"), :force => false)
     end
   end
-  
+
   def test_raises_exception_if_waveform_exists
     FileUtils.touch output("wont_be_overwritten_by_default.png")
-    
+
     assert_raises Waveform::RuntimeError do
-      Waveform.generate(fixture("sample.wav"), output("wont_be_overwritten_by_default.png"))
+      Waveform.generate(fixture_asset("sample.wav"), output("wont_be_overwritten_by_default.png"))
     end
   end
-  
+
   def test_raises_deprecation_exception_if_ruby_audio_fails_to_read_source_file
     begin
-      Waveform.generate(fixture("sample.txt"), output("shouldnt_exist.png"))
+      Waveform.generate(fixture_asset("sample.txt"), output("shouldnt_exist.png"))
     rescue Waveform::RuntimeError => e
       assert_match /Hint: non-WAV files are no longer supported, convert to WAV first using something like ffmpeg/, e.message
     end

metadata

@@ -1,38 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: waveform
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.1.3
 platform: ruby
 authors:
 - Ben Alavi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
+date: 2023-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-audio
-  requirement: &70419740 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70419740
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: chunky_png
-  requirement: &70419500 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70419500
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Generate waveform images from audio files. Includes a Waveform class
   for generating waveforms in your code as well as a simple command-line program called
   'waveform' for generating on the command line.
@@ -45,33 +50,31 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
-- lib/waveform/version.rb
+- bin/waveform
 - lib/waveform.rb
-- waveform.gemspec
+- lib/waveform/version.rb
 - test/waveform_test.rb
-- bin/waveform
+- waveform.gemspec
 homepage: http://github.com/benalavi/waveform
 licenses: []
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.11
-signing_key: 
-specification_version: 3
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
 summary: Generate waveform images from audio files
 test_files: []