carrierwave-audio-waveform 1.0.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b817a62eeaac43003254b3790fdc864faf0a0980
-  data.tar.gz: 84176297d0547e499d84bedef2e22585618e1e8e
+  metadata.gz: 9b978937b699c8840ed808da400cc75406b850c7
+  data.tar.gz: e8ea1146faf2a37a1fcdb7c98172c1a241008bfc
 SHA512:
-  metadata.gz: c321c0dcaf6d14e6a8c6526c532eca40cb30ecf5690fae3896c1185d308344621974d310fff12cda3446ff210a8747c536de918fed7d13cacca7262e8851f49f
-  data.tar.gz: 42ce80dacf18c25b68f7732e5983f4547a505bd991c50b9b7eddcaf62fce51c549e200c2dd7af6b5e8b41fbdd592456a16733ffb4ee13f88d437e526a1490dd2
+  metadata.gz: 763f2a8d2b40333712f256cf8f8cac5e2a75559a30d24857a3075f1f8cb30f5ee1ac825b97d719b8d7bf46f09542fcf1432ba67f2d34a327a1ccf75062e5ff42
+  data.tar.gz: 377f117014e72cc62fb6c3dafb1a1882a77ce43100b548c10690da7c2f6f79c6564b5f80ca95c4f34503f6df2cf51f1afbb718e30ea7d8c956e2b12de2a116c7

data/lib/carrierwave/audio_waveform.rb

@@ -1,5 +1,6 @@
 require 'carrierwave'
 require 'carrierwave/audio_waveform/waveformer'
+require 'carrierwave/audio_waveform/waveform_data'
 
 module CarrierWave
   module AudioWaveform
@@ -9,6 +10,10 @@ module CarrierWave
       def waveform options={}
         process waveform: [ options ]
       end
+
+      def waveform_data options={}
+        process waveform_data: [ options ]
+      end
     end
 
     def waveform options={}
@@ -16,6 +21,15 @@ module CarrierWave
 
       image_filename = Waveformer.generate(current_path, options)
       File.rename image_filename, current_path
+      self.file.instance_variable_set(:@content_type, "image/png")
+    end
+
+    def waveform_data options={}
+      cache_stored_file! if !cached?
+
+      data_filename = WaveformData.generate(current_path, options)
+      File.rename data_filename, current_path
+      self.file.instance_variable_set(:@content_type, "application/json")
     end
   end
-end
+end

data/lib/carrierwave/audio_waveform/version.rb

@@ -1,5 +1,5 @@
 module CarrierWave
   module AudioWaveform
-    VERSION = '1.0.0'
+    VERSION = '1.0.3'
   end
 end

data/lib/carrierwave/audio_waveform/waveform_data.rb

@@ -0,0 +1,197 @@
+require 'ruby-sox'
+require 'fileutils'
+
+module CarrierWave
+  module AudioWaveform
+    class WaveformData
+      DefaultOptions = {
+        pixels_per_second: 10,
+        bits: 16
+      }
+
+      # 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 image at the given filename with the given options.
+        #
+        # Available options (all optional) are:
+        #
+        #   :convert_to_extension_before_processing => Symbolized extension (:wav, :mp3, etc.)
+        #   Useful if .wav or .mp3 isn't being passed in--you can convert to that format first.
+        #
+        #   :set_extension_before_processing => Symbolized extension (:wav, :mp3, etc.)
+        #   This is useful because CarrierWave will send files in with the wrong extension sometimes.
+        #   For instance, if this is nested under a version, that version may be an .mp3, but its parent
+        #
+        #   :pixels_per_second => The number of pixels per second to evaluate.
+        #
+        #   :bits => 8 or 16 bit precision
+        #
+        #   :logger => IOStream to log progress to.
+        #
+        # Example:
+        #   CarrierWave::AudioWaveform::Waveformer.generate("Kickstart My Heart.wav")
+        #   CarrierWave::AudioWaveform::Waveformer.generate("Kickstart My Heart.wav", :method => :rms)
+        #   CarrierWave::AudioWaveform::Waveformer.generate("Kickstart My Heart.wav", :color => "#ff00ff", :logger => $stdout)
+        #
+        def generate(source, options={})
+          options = DefaultOptions.merge(options)
+          options[:filename] ||= self.generate_json_filename(source)
+          old_source = source
+          if options[:convert_to_extension_before_processing]
+            source = generate_valid_source(source, options[:convert_to_extension_before_processing])
+          elsif options[:set_extension_before_processing]
+            source = generate_proper_source(source, options[:set_extension_before_processing])
+          end
+
+          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 options[:filename]
+          raise RuntimeError.new("Source audio file '#{source}' not found.") unless File.exist?(source)
+
+          @log = Log.new(options[:logger])
+          @log.start!
+
+          @log.timed("\nGenerating...") do
+            stdout_str, stderr_str, status = self.generate_waveform_data(source, options)
+            if stderr_str.present? && !stderr_str.include?("Recoverable")
+              raise RuntimeError.new(stderr_str)
+            end
+          end
+
+          if source != old_source && options[:convert_to_extension_before_processing]
+            @log.out("Removing temporary file at #{source}")
+            FileUtils.rm(source)
+          elsif source != old_source && options[:set_extension_before_processing]
+            @log.out("Renaming file at #{source}")
+            old_ext = File.extname(source).gsub(/\./, '').to_sym
+            generate_proper_source(source, old_ext)
+          end
+
+          @log.done!("Generated waveform data '#{options[:filename]}'")
+
+          options[:filename]
+        end
+
+        def generate_json_filename(source)
+          ext = File.extname(source)
+          source_file_path_without_extension = File.join File.dirname(source), File.basename(source, ext)
+          "#{source_file_path_without_extension}.json"
+        end
+
+        def generate_waveform_data(source, options = DefaultOptions)
+          options[:filename] ||= self.generate_json_filename(source)
+          Open3.capture3(
+            "audiowaveform -i #{source} --pixels-per-second #{options[:pixels_per_second]} -b #{options[:bits]} -o #{options[:filename]}"
+          )
+        end
+
+        private
+
+        # Returns the proper file type if the one passed in was
+        # wrong, or the original if it wasn't.
+        def generate_proper_source(source, proper_ext)
+          ext = File.extname(source)
+          ext_gsubbed = ext.gsub(/\./, '')
+
+          if ext_gsubbed != proper_ext.to_s
+            filename_with_proper_extension = "#{source.chomp(File.extname(source))}.#{proper_ext}"
+            File.rename source, filename_with_proper_extension
+            filename_with_proper_extension
+          else
+            source
+          end
+        rescue Sox::Error => e
+          raise e unless e.message.include?("FAIL formats:")
+          raise RuntimeError.new("Source file #{source} could not be converted to .wav by Sox (Sox: #{e.message})")
+        end
+
+        # Returns a converted file.
+        def generate_valid_source(source, proper_ext)
+          ext = File.extname(source)
+          ext_gsubbed = ext.gsub(/\./, '')
+
+          if ext_gsubbed != proper_ext.to_s
+            input_options = { type: ext_gsubbed }
+            output_options = { type: proper_ext.to_s }
+            source_filename_without_extension = File.basename(source, ext)
+            output_file_path = File.join File.dirname(source), "tmp_#{source_filename_without_extension}_#{Time.now.to_i}.#{proper_ext}"
+            converter = Sox::Cmd.new
+            converter.add_input source, input_options
+            converter.set_output output_file_path, output_options
+            converter.run
+            output_file_path
+          else
+            source
+          end
+        rescue Sox::Error => e
+          raise e unless e.message.include?("FAIL formats:")
+          raise RuntimeError.new("Source file #{source} could not be converted to .wav by Sox (Sox: #{e.message})")
+        end
+      end
+    end
+
+    class WaveformData
+      # 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
+        attr_accessor :io
+
+        def initialize(io=$stdout)
+          @io = io
+        end
+
+        # Prints the given message to the log
+        def out(msg)
+          io.print(msg) if io
+        end
+
+        # Prints the given message to the log followed by the most recent benchmark
+        # (note that it calls .end! which will stop the benchmark)
+        def done!(msg="")
+          out "#{msg} (#{self.end!}s)\n"
+        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
+        # LIFO)
+        def start!
+          (@benchmarks ||= []) << Time.now
+          @current = @benchmarks.size - 1
+        end
+
+        # Returns the elapsed time from the most recently started benchmark clock
+        # and ends the benchmark, so that a subsequent call to .end! will return
+        # the elapsed time from the previously started benchmark clock.
+        def end!
+          elapsed = (Time.now - @benchmarks[@current])
+          @current -= 1
+          elapsed
+        end
+
+        # Returns the elapsed time from the benchmark clock w/ the given index (as
+        # returned from when .start! was called).
+        def time?(index)
+          Time.now - @benchmarks[index]
+        end
+
+        # Benchmarks the given block, printing out the given message first (if
+        # given).
+        def timed(message=nil, &block)
+          start!
+          out(message) if message
+          yield
+          done!
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-audio-waveform
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Trevor Hinesley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-20 00:00:00.000000000 Z
+date: 2017-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -120,6 +120,7 @@ files:
 - lib/carrierwave-audio-waveform.rb
 - lib/carrierwave/audio_waveform.rb
 - lib/carrierwave/audio_waveform/version.rb
+- lib/carrierwave/audio_waveform/waveform_data.rb
 - lib/carrierwave/audio_waveform/waveformer.rb
 homepage: https://github.com/TrevorHinesley/carrierwave-audio-waveform
 licenses:
@@ -146,3 +147,4 @@ signing_key:
 specification_version: 4
 summary: Generate waveform images from audio files within Carrierwave
 test_files: []
+has_rdoc: