waveform 0.0.2 → 0.0.3

data/README.md

@@ -46,7 +46,8 @@ There are some nifty options you can supply to switch things up:
 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.
+    -h will print out a help screen with all this info.
+    -F will automatically overwrite destination file.
 
 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

data/bin/waveform

@@ -39,6 +39,11 @@ optparse = OptionParser.new do |o|
     options[:quiet] = true
   end
 
+  options[:force] = false
+  o.on("-F", "--force", "Force generationg of waveform if file exists") do
+    options[:force] = true
+  end
+
   o.on("-h", "--help", "Display this screen") do
     puts o
     exit

data/lib/waveform.rb

@@ -1,4 +1,5 @@
 require "ruby-audio"
+require "tempfile"
 
 begin
   require "oily_png"
@@ -7,20 +8,21 @@ rescue LoadError
 end
 
 class Waveform
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
   
   DefaultOptions = {
     :method => :peak,
     :width => 1800,
     :height => 280,
     :background_color => "#666666",
-    :color => "#00ccff"
+    :color => "#00ccff",
+    :force => false
   }
   
   TransparencyMask = "#00ff00"
   TransparencyAlternate = "#ffff00" # in case the mask is the background color!
   
-  attr_reader :audio
+  attr_reader :source
   
   # Scope these under Waveform so you can catch the ones generated by just this
   # class.
@@ -42,18 +44,30 @@ class Waveform
   #   Waveform.new("mp3s/Kickstart My Heart.mp3")
   #   Waveform.new("mp3s/Kickstart My Heart.mp3", $stdout)
   # 
-  def initialize(audio, log=nil)
-    raise ArgumentError.new("No source audio filename given, must be an existing sound file.") unless audio
-    raise RuntimeError.new("Source audio file '#{audio}' not found.") unless File.exist?(audio)
+  def initialize(source, log=nil)
+    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)
     
     @log = Log.new(log)
-
-    if File.extname(audio) != ".wav"
-      @audio = audio.sub /(.+)\.(.+)/, "\\1.wav"
-      raise RuntimeError.new("Unable to decode source '#{audio}' to WAV. Do you have ffmpeg installed with an appropriate decoder for your source file?") unless to_wav(audio, @audio)
+    @log.start!
+    
+    # @source is the path to the given source file, whatever it may be
+    @source = source
+    
+    # @audio is the path to the actual audio file we will process, always wav
+    if File.extname(source) == ".wav"
+      @audio = File.open(source, "rb")
     else
-      @audio = audio
+      # This happens in initialize so you can generate multiple waveforms from
+      # the same audio without decoding multiple times
+      # 
+      # Note that we're leaving it up to the ruby/system GC to clean up these
+      # tempfiles because someone may be generating multiple waveform images
+      # from a single audio source so we can't explicitly unlink the tempfile.
+      @audio = to_wav(source)
     end
+    
+    raise RuntimeError.new("Unable to decode source \'#{@source}\' to WAV. Do you have ffmpeg installed with an appropriate decoder for your source file?") unless @audio
   end
   
   # Generate a Waveform image at the given filename with the given options.
@@ -85,21 +99,29 @@ class Waveform
   #     color background to achieve a "cutout" effect).
   #     Default is #00ccff (cyan-ish).
   #
+  #   :force => Force generation of waveform, overwriting WAV or PNG file.
+  #
   # Example:
   #   waveform = Waveform.new("mp3s/Kickstart My Heart.mp3")
-  # 
+  #
   #   waveform.generate("waves/Kickstart My Heart.png")
   #   waveform.generate("waves/Kickstart My Heart.png", :method => :rms)
   #   waveform.generate("waves/Kickstart My Heart.png", :color => "#ff00ff")
-  # 
+  #
   def generate(filename, options={})
     raise ArgumentError.new("No destination filename given for waveform") unless filename
-    raise RuntimeError.new("Destination file #{filename} exists") if File.exists?(filename)
+
+    if File.exists?(filename)
+      if options[:force]
+        @log.out("Output file #{filename} encountered. Removing.")
+        File.unlink(filename)
+      else
+        raise RuntimeError.new("Destination file #{filename} exists. Use --force if you want to automatically remove it.")
+      end
+    end    
 
     options = DefaultOptions.merge(options)
-    
-    @log.start!
-    
+
     # 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
@@ -161,7 +183,7 @@ class Waveform
     
     frames = []
     
-    RubyAudio::Sound.open(audio) do |snd|
+    RubyAudio::Sound.open(@audio.path) do |snd|
       frames_read       = 0
       frames_per_sample = (snd.info.frames.to_f / width.to_f).to_i
       sample            = RubyAudio::Buffer.new("float", frames_per_sample, snd.info.channels)
@@ -179,18 +201,17 @@ class Waveform
   
   private
   
-  # Decode audio to a wav file, returns true if the decode succeeded or false
-  # otherwise.
-  def to_wav(src, dest)
-    @log.start!
-    @log.out("Decoding source audio '#{src}' to WAV...")
-
-    raise RuntimeError.new("Destination WAV file '#{dest}' exists!") if File.exists?(dest)
+  # Decode given src file to a wav Tempfile. Returns the Tempfile if the decode
+  # succeeded, or false if the decode failed.
+  def to_wav(src, force=false)
+    wav = nil
     
-    system %Q{ffmpeg -i "#{src}" -f wav "#{dest}" > /dev/null 2>&1}
-    @log.done!
+    @log.timed("Decoding source audio '#{src}' to WAV...") do    
+      wav = Tempfile.new(File.basename(src))
+      system %Q{ffmpeg -y -i "#{src}" -f wav "#{wav.path}" > /dev/null 2>&1}
+    end
     
-    File.exists?(dest)
+    return wav.size == 0 ? false : wav
   end
   
   # Returns an array of the peak of each channel for the given collection of

data/test/waveform_test.rb

@@ -115,5 +115,60 @@ class WaveformTest < Test::Unit::TestCase
       assert_equal ChunkyPNG::Color.from_hex("#00ff00"), image[0, 0]
       assert_equal ChunkyPNG::Color::TRANSPARENT, image[60, 120]
     end
+
+    # Not sure how to best test this as it's totally dependent on the ruby and
+    # system GC when the tempfiles are removed (as we're not explicitly
+    # unlinking them).
+    # should "use a tempfile when generating a temporary wav" do
+    #   tempfiles = Dir[File.join(Dir.tmpdir(), "sample_mp3*")].size
+    #   Waveform.new(fixture("sample_mp3.mp3")).generate(output("cleanup_temporary_wav.png"))
+    #   assert_equal tempfiles + 1, Dir[File.join(Dir.tmpdir(), "sample_mp3*")].size
+    # end
+    
+    should "not delete source wav file if one was given" do
+      assert File.exists?(fixture("sample.wav"))
+      Waveform.new(fixture("sample.wav")).generate(output("keep_source_wav.png"))
+      assert File.exists?(fixture("sample.wav"))
+    end
+    
+    should "raise an error if unable to decode to wav" do
+      assert_raise(Waveform::RuntimeError) do
+        Waveform.new(fixture("sample.txt")).generate(output("shouldnt_exist.png"))
+      end
+    end
+
+    context "with existing PNG files" do
+      setup do
+        @existing = output("existing.png")
+        FileUtils.touch @existing
+      end
+
+      should "generate waveform if :force is true and PNG exists" do
+        @waveform.generate(@existing, :force => true)
+      end
+
+      should "raise an exception if PNG exists and :force is false" do
+        assert_raises Waveform::RuntimeError do
+          @waveform.generate(@existing, :force => false)
+        end
+      end
+    end
+
+    context "with existing WAV files" do
+      setup do
+        @existing = output("existing.wav")
+        FileUtils.touch @existing
+      end
+
+      should "generate waveform if :force is true and WAV exists" do
+        @waveform.generate(@existing, :force => true)
+      end
+
+      should "raise an exception if WAV exists and :force is false" do
+        assert_raises Waveform::RuntimeError do
+          @waveform.generate(@existing, :force => false)
+        end
+      end
+    end
   end
 end

data/waveform.gemspec

@@ -3,8 +3,8 @@ require "./lib/waveform"
 Gem::Specification.new do |s|
   s.name              = "waveform"
   s.version           = Waveform::VERSION
-  s.summary           = "Generate waveform images from WAV and MP3 files"
-  s.description       = "Generate waveform images from WAV and MP3 files -- in your code or via included CLI."
+  s.summary           = "Generate waveform images from WAV, MP3, etc... files"
+  s.description       = "Generate waveform images from WAV, MP3, etc... files - as a gem or via CLI."
   s.authors           = ["Ben Alavi"]
   s.email             = ["benalavi@gmail.com"]
   s.homepage          = "http://github.com/benalavi/waveform"

metadata

@@ -2,7 +2,7 @@
 name: waveform
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Ben Alavi
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-18 00:00:00 Z
+date: 2011-07-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ruby-audio
@@ -45,7 +45,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-description: Generate waveform images from WAV and MP3 files -- in your code or via included CLI.
+description: Generate waveform images from WAV, MP3, etc... files - as a gem or via CLI.
 email: 
 - benalavi@gmail.com
 executables: 
@@ -84,9 +84,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: Generate waveform images from WAV and MP3 files
+summary: Generate waveform images from WAV, MP3, etc... files
 test_files: []