waveform 0.0.1 → 0.0.2

data/README.md

@@ -6,6 +6,26 @@ combine it with jPlayer to make a soundcloud.com style MP3 player. It also
 comes with a handy CLI you can use to generate waveform images on the command
 line.
 
+Installation
+============
+
+Build libsndfile (http://www.mega-nerd.com/libsndfile/), or install it via `apt`
+(`sudo apt-get install libsndfile1-dev`), or `libsndfile` in macports.
+
+    $ sudo gem install waveform
+
+You might also want to, but don't have to:
+
+    $ sudo gem install oily_png
+    
+to make things a bit faster, and:
+
+    $ sudo apt-get install ffmpeg
+    
+if you want Waveform to convert non WAV audio for you.
+
+_See Requirements below for more info_
+
 CLI Usage
 =========
 
@@ -23,11 +43,11 @@ There are some nifty options you can supply to switch things up:
         'peak' or 'rms'. 'peak' is probably what you want because it looks
         cooler, but 'rms' is closer to what you actually hear.
 
-There's also some less-nifty options:
+There are also some less-nifty options:
 
     -q will generate your waveform without printing out a bunch of stuff.
     -h will prit out a help screen with all this info.
-    
+
 Generating a small waveform "cut out" of a white background is pretty useful,
 then you can overlay it on a web-gradient on the website for your new startup
 and it will look really cool. To make it you could use:
@@ -68,18 +88,15 @@ format converters to convert your files to WAV before generating waveforms.
 
 Or you could be all retro and use WAV audio for everything in the first place.
 
-Some notes
-==========
+Tests
+=====
 
-I threw the original version of this together in a day, and then made this
-second version in another couple. During those days I committed a cardinal sin
-and didn't write any tests, because decoding sound files and drawing pictures
-of them is more fun than writing tests. `ChunkyPNG` is cool though and will let
-you read raw pixel data, so it should be pretty easy to write some tests that
-actually read the pixel data of a waveform generated from a known source and
-ensure everything went according to plan. I'll do that later.
+Tests require `contest` gem & `ffmpeg` (to test conversion), run via:
 
-Also, please refactor this/make it faster.
+    $ rake
+
+Sample sound file is in Public Domain from soundbible.com.
+<http://soundbible.com/1598-Electronic-Chime.html>
 
 References
 ==========
@@ -92,10 +109,22 @@ References
 License
 =======
 
-Copyright (c) 2010 Ben Alavi
-
-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.
+Copyright (c) 2010-2011 Ben Alavi
+
+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/Rakefile

@@ -1,5 +1,5 @@
 task :default => :test
 
 task :test do
-  system "cutest test/*.rb"
+  system "ruby test/*.rb"
 end

data/lib/waveform.rb

@@ -7,7 +7,7 @@ rescue LoadError
 end
 
 class Waveform
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
   
   DefaultOptions = {
     :method => :peak,

data/test/waveform_test.rb

@@ -0,0 +1,119 @@
+require "contest"
+require "fileutils"
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "lib", "waveform"))
+
+class WaveformTest < Test::Unit::TestCase
+  def self.fixture(file)
+    File.join(File.dirname(__FILE__), "fixtures", file)
+  end
+  def fixture(file);self.class.fixture(file);end;
+  
+  def self.output(file)
+    File.join(File.dirname(__FILE__), "output", file)
+  end
+  def output(file);self.class.output(file);end;
+  
+  def open_png(file)
+    ChunkyPNG::Image.from_datastream(ChunkyPNG::Datastream.from_file(file))
+  end
+  
+  puts "Removing existing testing artifacts..."
+  FileUtils.rm_rf(output("")) if File.exists?(output(""))
+  FileUtils.mkdir(output(""))
+  sample_wav = fixture("sample_mp3.wav")
+  FileUtils.rm(sample_wav) if File.exists?(sample_wav)
+  
+  context "generating waveform" do
+    setup do
+      @waveform = Waveform.new(fixture("sample.wav"))
+    end
+    
+    should "generate waveform from audio source" do
+      @waveform.generate(output("waveform_from_audio_source.png"))
+      assert File.exists?(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
+    
+    should "convert non-wav audio source before generation" do
+      Waveform.new(fixture("sample_mp3.mp3")).generate(output("from_mp3.png"))
+
+      assert File.exists?(output("from_mp3.png"))
+    end
+
+    should "log to given io" do
+      File.open(output("waveform.log"), "w") do |io|
+        Waveform.new(fixture("sample.wav"), io).generate(output("logged.png"))
+      end
+      
+      assert_match /Generated waveform/, File.read(output("waveform.log"))
+    end
+            
+    should "generate waveform using rms method instead of peak" do
+      @waveform.generate(output("peak.png"))
+      @waveform.generate(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
+    
+    should "generate waveform 900px wide" do
+      @waveform.generate(output("width-900.png"), :width => 900)
+      image = open_png(output("width-900.png"))
+      
+      assert_equal 900, image.width
+    end
+    
+    should "generate waveform 100px tall" do
+      @waveform.generate(output("height-100.png"), :height => 100)
+      image = open_png(output("height-100.png"))
+      
+      assert_equal 100, image.height
+    end
+    
+    should "generate waveform on red background color" do
+      @waveform.generate(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
+    
+    should "generate waveform on transparent background color" do
+      @waveform.generate(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
+    
+    should "generate waveform in black foreground color" do
+      @waveform.generate(output("color-#000000.png"), :color => "#000000")
+      image = open_png(output("color-#000000.png"))
+      
+      assert_equal ChunkyPNG::Color.from_hex("#000000"), image[60, 120]
+    end
+    
+    should "generate waveform on red background color with transparent foreground cut-out" do
+      @waveform.generate(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
+    should "generate waveform with transparent foreground on bright green background" do
+      @waveform.generate(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
+  end
+end

data/waveform.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency "ruby-audio"
   s.add_dependency "chunky_png"
+  
+  s.add_development_dependency "contest"
 end

metadata

@@ -2,7 +2,7 @@
 name: waveform
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Ben Alavi
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-16 00:00:00 Z
+date: 2011-07-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ruby-audio
@@ -34,6 +34,17 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: contest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: Generate waveform images from WAV and MP3 files -- in your code or via included CLI.
 email: 
 - benalavi@gmail.com
@@ -48,6 +59,7 @@ files:
 - Rakefile
 - lib/waveform.rb
 - waveform.gemspec
+- test/waveform_test.rb
 - bin/waveform
 homepage: http://github.com/benalavi/waveform
 licenses: []