rsox-command 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*~

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rsox-command.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/silent-file

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'rsox-command'
+
+file = ARGV.first
+stats = Sox::Stats.new(file)
+
+begin
+  $stderr.puts "#{file} rms_level:#{stats.rms_level}dB rms_peak:#{stats.rms_peak}dB" if $DEBUG
+
+  if stats.silent?
+    puts "silent"
+    exit 0
+  else
+    puts "not silent"
+    exit 1
+  end
+rescue => e
+  $stderr.puts "Error: #{file}, #{e}"
+  exit 2
+end

data/bin/silent-files

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'rsox-command'
+
+ARGV.each do |file|
+  Sox::Stats.new(file).tap do |stats|
+    begin
+      $stderr.puts "#{file} rms_level:#{stats.rms_level}dB rms_peak:#{stats.rms_peak}dB" if $DEBUG
+      puts file if stats.silent?
+    rescue => e
+      $stderr.puts "Error: #{file}, #{e}"
+    end
+  end
+end

data/lib/rsox-command.rb

@@ -0,0 +1,13 @@
+
+module Sox
+
+end
+
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/enumerable'
+require 'active_support/core_ext/module/delegation'
+
+require 'sox/command'
+require 'sox/stats'
+

data/lib/sox/command.rb

@@ -0,0 +1,200 @@
+require 'tempfile'
+require 'cocaine'
+
+module Sox
+
+  @@logger = nil
+  mattr_accessor :logger
+
+  def self.command
+    command = Command.new
+    yield command
+    command.run
+  end
+
+  def self.command!
+    command = Command.new
+    yield command
+    command.run!
+  end
+
+  #  Sox.command do |sox|
+  #    sox.input "input1.wav"
+  #    sox.input "input2", :type => "ogg"
+  #    
+  #    sox.output "output", :type => "ogg", :compression => 8
+  #  end
+  class Command
+
+    attr_accessor :inputs, :effects
+    attr_writer :output
+    attr_accessor :run_output
+
+    def initialize(&block)
+      @inputs = []
+      @effects = []
+      yield self if block_given?
+    end
+
+    def input(filename, options = {})
+      inputs << File.new(filename, options)
+    end
+
+    def output(*arguments)
+      if arguments.empty?
+        @output
+      else
+        self.output=File.new(*arguments)
+      end
+    end
+
+    def effect(name, *arguments)
+      effects << Effect.new(name, *arguments)
+    end
+
+    def command_line
+      Cocaine::CommandLine.new("sox", "#{command_arguments} 2>&1")
+    end
+
+    def command_arguments
+      [].tap do |arguments|
+        unless inputs.empty?
+          if playlist.useful?
+            arguments << playlist.create
+          else
+            arguments << inputs.collect(&:command_arguments)
+          end
+        else
+          arguments << "-n"
+        end
+
+        unless output.blank?
+          arguments << output.command_arguments
+        else
+          arguments << "-n"
+        end
+
+        arguments << effects.collect(&:command_arguments).join(' : ')
+      end.flatten.delete_if(&:blank?).join(' ')
+    end
+
+    def playlist
+      @playlist ||= Playlist.new(inputs)
+    end
+
+    def run
+      begin
+        run!
+        true
+      rescue Cocaine::CommandLineError => e
+        false
+      end
+    end
+
+    def run!
+      Sox.logger.debug "Run '#{command_line.command}'" if Sox.logger
+      
+      begin
+        self.run_output = command_line.run
+      ensure
+        playlist.delete
+      end
+
+      self
+    end
+
+    class Playlist
+
+      attr_accessor :inputs
+
+      def initialize(inputs)
+        @inputs = inputs
+      end
+
+      def file
+        @file ||= Tempfile.new(['sox-command-playlist','.m3u'])
+      end
+
+      def path
+        file.path
+      end
+      
+      def create
+        ::File.open(file.path,"w") do |playlist|
+          inputs.each do |input|
+            playlist.puts input.filename
+          end
+        end
+
+        file.path
+      end
+
+      def delete
+        if @file
+          @file.close(true)
+          @file = nil
+        end
+      end
+
+      def useful?
+        inputs.all? { |input| input.options.empty? } and
+          inputs.sum { |i| i.filename.size } > 500
+      end
+
+    end
+
+    class File 
+
+      attr_accessor :filename, :options
+
+      def initialize(filename, options = {})
+        @filename = filename
+        @options = options
+      end
+
+      def command_arguments
+        unless options.empty?
+          format_options = sorted_options.collect do |name, value|
+            "--#{name} #{value}"
+          end.join(' ') + " "
+        end
+        "#{format_options}#{filename}"
+      end
+
+      def sorted_options
+        options.to_a.sort_by { |pair| pair.first.to_s }
+      end
+
+      def ==(other)
+        other and 
+          other.filename == filename and 
+          other.options == options
+      end
+
+    end
+
+    class Effect
+
+      attr_accessor :name, :arguments
+
+      def initialize(name, *arguments)
+        @name = name
+        @arguments = arguments
+      end
+
+      def ==(other)
+        other and 
+          other.name == name and 
+          other.arguments == arguments
+      end
+
+      def command_arguments
+        [ @name, *arguments].join(' ')
+      end
+
+    end
+
+  end
+
+
+end

data/lib/sox/stats.rb

@@ -0,0 +1,51 @@
+module Sox
+  class Stats
+
+    attr_reader :command
+
+    def initialize(file = nil)
+      @command = Sox::Command.new.tap do |command|
+        command.effect "stats"
+        command.input file if file
+      end
+    end
+
+    delegate :input, :to => :command
+
+    def raw_output
+      command.run!.run_output
+    end
+
+    def raw_values
+      if raw_output.chomp == "sox WARN stats: no audio"
+        raise "No audio found by sox"
+      else
+        raw_output.scan(/^(\w+( \w+)*) +([\w.-]+)/i)
+      end
+    end
+
+    def attributes
+      @attributes ||=
+        begin
+          paires = raw_values.collect do |key, _, value|
+            value = value.to_f if value =~ /^-?[0-9.]+$/
+            [key, value]
+          end
+          Hash[paires]
+        end
+    end
+
+    def rms_level
+      attributes['RMS lev dB']
+    end
+
+    def rms_peak
+      attributes['RMS Pk dB']
+    end
+
+    def silent?
+      rms_peak < -45
+    end
+
+  end
+end

data/rsox-command.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "rsox-command"
+  s.version     = "0.0.1"
+  s.authors     = ["Alban Peignier"]
+  s.email       = ["alban@tryphon.eu"]
+  s.homepage    = "http://projects.tryphon.eu/rsox-command"
+  s.summary     = %q{Wrapper to run sox}
+  s.description = %q{Ruby wrapper to run SoX, a sound command line utility}
+
+  s.rubyforge_project = "rsox-command"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "guard"
+  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "rake"
+
+  s.add_runtime_dependency "activesupport"
+  s.add_runtime_dependency "cocaine"
+end

data/spec/fixtures/test.stats

@@ -0,0 +1,16 @@
+             Overall     Left      Right
+DC offset   0.000010  0.000010  0.000010
+Min level  -1.000000 -1.000000 -1.000000
+Max level   0.999969  0.999969  0.999969
+Pk lev dB       0.00      0.00      0.00
+RMS lev dB     -2.98     -2.98     -2.98
+RMS Pk dB      -2.91     -2.92     -2.91
+RMS Tr dB      -3.06     -3.06     -3.06
+Crest factor       -      1.41      1.41
+Flat factor     6.70      6.69      6.70
+Pk count       37.8k     37.8k     37.8k
+Bit-depth      16/16     16/16     16/16
+Num samples     664k
+Length s      15.050
+Scale max   1.000000
+Window s       0.050

data/spec/lib/sox/command_spec.rb

@@ -0,0 +1,288 @@
+require 'spec_helper'
+
+describe Sox, "command" do
+
+  before(:each) do
+    @command = mock(Sox::Command, :run => true)
+    Sox::Command.stub!(:new).and_return(@command)
+  end
+
+  it "should create a new Sox::Command" do
+    Sox::Command.should_receive(:new).and_return(@command)
+    Sox.command {}
+  end
+
+  it "should yield the created Sox::Command" do
+    Sox.command { |sox| sox.should == @command }
+  end
+  
+  it "should run the Sox::Command" do
+    @command.should_receive(:run).and_return(true)
+    Sox.command {}.should be_true
+  end
+  
+end
+
+describe Sox::Command do
+
+  it {
+    Sox::Command.new do |sox|
+      sox.input "input1.wav"
+      sox.input "input2", :type => "ogg"
+      
+      sox.output "output", :type => "ogg", :compression => 8
+    end.command_line.command.should == "sox input1.wav --type ogg input2 --compression 8 --type ogg output 2>&1"
+  }
+
+  before(:each) do
+    @command = Sox::Command.new
+
+    @filename = "filename"
+    @options = { :option1 => "value1" }
+  end
+
+  describe "input" do
+    
+    it "should create a File with specified arguments and adds it in command inputs" do
+      @command.input @filename, @options
+      @command.inputs.should == [ Sox::Command::File.new(@filename, @options) ]
+    end
+
+  end
+
+  describe "output" do
+    
+    it "should create a File with specified arguments and adds it in command output" do
+      @command.output @filename, @options
+      @command.output.should == Sox::Command::File.new(@filename, @options)
+    end
+
+  end
+
+  describe "effect" do
+
+    before(:each) do
+      @arguments = Array.new(3) { |n| "argument#{n}" }
+    end
+    
+    it "should create an Effect with specified argument and adds it in command effects" do
+      @command.effect :effect_name, @arguments
+      @command.effects.should == [ Sox::Command::Effect.new(:effect_name, @arguments) ]
+    end
+
+  end
+
+  describe "command_arguments" do
+
+    def mock_file(command_arguments)
+      mock(Sox::Command::File, :command_arguments => command_arguments, :options => {}, :filename => "dummy")
+    end
+
+    def mock_effect(command_arguments)
+      mock(Sox::Command::Effect, :command_arguments => command_arguments)
+    end
+
+    before(:each) do
+      @command.inputs = Array.new(3) { |n| mock_file "input#{n}" }
+      @command.output = mock_file("output")
+      @command.effects = Array.new(3) { |n| mock_effect "effect#{n}" }
+    end
+    
+    it "should concat inputs, output and effects command arguments" do
+      @command.command_arguments.should == "input0 input1 input2 output effect0 : effect1 : effect2"
+    end
+
+    it "should support null file in input" do
+      @command.inputs = []
+      @command.command_arguments.should match(/^-n output/)
+    end
+
+    it "should support null file in output" do
+      @command.output = nil
+      @command.command_arguments.should match(/^input0 input1 input2 -n/)
+    end
+
+    context "when playlist is useful " do
+      before(:each) do
+        @command.playlist.stub :useful? => true
+      end
+
+      it "should concat playlist path, output and effects command arguments" do
+        @command.command_arguments.should == "#{@command.playlist.path} output effect0 : effect1 : effect2" 
+      end
+
+      it "should create playlist if needed" do
+        @command.playlist.should_receive(:create)
+        @command.command_arguments
+      end
+    end
+
+  end
+
+  describe "command_line" do
+    
+    it "should concat sox binary path and command_arguments" do
+      @command.stub!(:command_arguments).and_return("command_arguments")
+      @command.command_line.command.should == "sox command_arguments 2>&1"
+    end
+    
+  end
+
+  describe "run!" do
+
+    before(:each) do
+      @command.stub!(:command_line).and_return(mock(:run => "ok"))
+    end
+    
+    it "should run the command_line" do
+      @command.command_line.should_receive(:run)
+      @command.run!
+    end
+
+    it "should delete playlist" do
+      @command.playlist.should_receive(:delete)
+      @command.run!
+    end
+
+    it "should not raise error when the command line is successful" do
+      @command.command_line.stub :run => "ok"
+      lambda { @command.run! }.should_not raise_error
+    end
+
+    it "should raise an error if command line fails" do
+      @command.command_line.stub(:run).and_raise(Cocaine::ExitStatusError)
+      lambda { @command.run! }.should raise_error
+    end
+
+    it "should capture sox output" do
+      @command.command_line.stub :run => "ok"
+      @command.run!
+      @command.run_output.should == "ok"
+    end
+
+    it "should return the Command instance" do
+      @command.run!.should == @command
+    end
+
+  end
+
+  describe "run" do
+
+    it "should return false when Cocaine command line fails" do
+      @command.stub(:run!).and_raise(Cocaine::CommandLineError)
+      @command.run.should be_false
+    end
+    
+    it "should return true when run! doesn't fail" do
+      @command.stub :run! => true
+      @command.run.should be_true
+    end
+
+  end
+
+  describe "playlist" do
+    
+    it "should have .m3u extension (sox requirement)" do
+      @command.playlist.path.should match(/\.m3u$/)
+    end
+
+    after(:each) do
+      @command.playlist.delete
+    end
+
+  end
+
+  describe Sox::Command::File do
+
+    before(:each) do
+      @file = Sox::Command::File.new("test")
+    end
+
+    it "should create command_arguments filename only without options" do 
+      @file.filename = "filename"
+      @file.options = {}
+
+      @file.command_arguments.should == "filename"
+    end
+    
+    it "should create command_arguments with options and filename (--option1 value1 --option2 value2 ... filename)" do
+      @file.filename = "filename"
+      @file.options = {:option1 => "value1", :option2 => "value2"}
+
+      @file.command_arguments.should == "--option1 value1 --option2 value2 filename"
+    end
+
+  end
+
+  describe Sox::Command::Effect do
+
+    before(:each) do
+      @effect = Sox::Command::Effect.new("test")
+    end
+
+    it "should create command_arguments with name and arguments" do 
+      @effect.name = "name"
+      @effect.arguments = ["argument1", "argument2"]
+
+      @effect.command_arguments.should == "name argument1 argument2"
+    end
+    
+  end
+
+  describe Sox::Command::Playlist do
+
+    def mock_file(name, options = {})
+      mock Sox::Command::File, :filename => name, :options => options
+    end
+
+    subject { Sox::Command::Playlist.new [mock_file("input")] }
+
+    describe "create" do
+      
+      it "should create a playlist file with input files" do
+        subject.stub :inputs => [mock_file("input1"), mock_file("input2")]
+        IO.read(subject.create).should == "input1\ninput2\n"
+      end
+
+      after(:each) do
+        subject.delete
+      end
+
+    end
+
+    describe "delete" do
+      
+      it "should close playlist if exists" do
+        subject.instance_variable_set("@file", file = mock)
+        file.should_receive(:close).with(true)
+        subject.delete
+      end
+
+      it "should do nothing when file doesn't exist'" do
+        lambda { subject.delete }.should_not raise_error
+      end
+
+    end
+
+    describe "useful? " do
+
+      it "should be useful if concatenated filenames are longer than 500 characters" do
+        subject.stub :inputs => Array.new(51) { mock_file("a" * 10) }
+        subject.should be_useful
+      end
+
+      it "should not be useful if one of the input file has an option" do
+        subject.stub :inputs => [ mock_file("dummy", :option => true) ]
+        subject.should_not be_useful
+      end
+
+      it "should not be useful if concatenated filenames use less than 500 characters" do
+        subject.stub :inputs => Array.new(50) { mock_file("a" * 10) }
+        subject.should_not be_useful
+      end
+
+    end
+
+  end
+
+end

data/spec/lib/sox/stats_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Sox::Stats do
+
+  subject { Sox::Stats.new }
+  
+  describe "#raw_output" do
+    
+    it "should return sox command output" do
+      subject.input("spec/fixtures/test.ogg")
+      subject.raw_output.should == IO.read("spec/fixtures/test.stats")
+    end
+
+  end
+
+  describe "#attributes" do
+    
+    it "should read name and first value from raw output" do
+      subject.stub :raw_output => "A key in dB  -3"
+      subject.attributes["A key in dB"].should == -3
+    end
+
+    it "should read standard sox output" do
+      subject.stub :raw_output => IO.read("spec/fixtures/test.stats")
+      subject.attributes.should == {
+        "DC offset" => 0.000010,
+        "Min level" =>  -1.0,
+        "Max level" => 0.999969,
+        "Pk lev dB" => 0.0,
+        "RMS lev dB" => -2.98,
+        "RMS Pk dB" => -2.91,
+        "RMS Tr dB" => -3.06,
+        "Crest factor" => "-",
+        "Flat factor" => 6.70,
+        "Pk count" => "37.8k",
+        # "Bit-depth" => "16/16",
+        "Num samples" => "664k",
+        "Length s" => 15.050,
+        "Scale max" =>  1.0,
+        "Window s" => 0.050
+      }
+    end
+
+  end
+
+  describe "rms_level" do
+    
+    it "should return 'RMS lev dB' found by sox" do
+      subject.stub :attributes => { 'RMS lev dB' => -3.0 }
+      subject.rms_level.should == -3.0
+    end
+
+  end
+                    
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rsox-command' # and any other gems you need
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification 
+name: rsox-command
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alban Peignier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rspec
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: guard
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: guard-rspec
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rake
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: activesupport
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: cocaine
+  version_requirements: *id006
+description: Ruby wrapper to run SoX, a sound command line utility
+email: 
+- alban@tryphon.eu
+executables: 
+- silent-file
+- silent-files
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Guardfile
+- Rakefile
+- bin/silent-file
+- bin/silent-files
+- lib/rsox-command.rb
+- lib/sox/command.rb
+- lib/sox/stats.rb
+- rsox-command.gemspec
+- spec/fixtures/test.ogg
+- spec/fixtures/test.stats
+- spec/lib/sox/command_spec.rb
+- spec/lib/sox/stats_spec.rb
+- spec/spec_helper.rb
+homepage: http://projects.tryphon.eu/rsox-command
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rsox-command
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Wrapper to run sox
+test_files: 
+- spec/fixtures/test.ogg
+- spec/fixtures/test.stats
+- spec/lib/sox/command_spec.rb
+- spec/lib/sox/stats_spec.rb
+- spec/spec_helper.rb