speak_slow 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in speak_slow.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Yoichiro Hasebe
+
+MIT License
+
+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/README.md

@@ -0,0 +1,23 @@
+# SpeakSlow
+
+## Description
+
+SpeakSlow modifies audio files adding pauses and/or altering speed to suit for language study
+
+## Installation
+
+*SpeakSlow requires [SoX - Sound eXchange](http://sox.sourceforge.net/) with LAME support installed to the system.  Then `gem install`*
+
+    $ gem install speak_slow 
+
+## Usage
+
+    Usage: speak_slow [options] <input file> <output file>
+    where: <input file> and <output file> are paths to a wav or mp3 file
+    
+    [options]:
+        --speed, -s <f>:   Speed of output file [0.1 - 100] (default: 1.0)
+      --silence, -i <i>:   Length (secondes) of a pause added to each utterance [0.1 - 120]
+                           (default: 1)
+          --version, -v:   Print version and exit
+             --help, -h:   Show this message

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/bin/speak_slow

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'rubygems'
+require 'trollop'
+require 'speak_slow'
+
+################ parse options ##########
+
+opts = Trollop::options do
+  version SpeakSlow::VERSION
+  banner <<-EOS
+  
+SpeakSlow modifies audio files adding pauses and/or altering speed to suit for language study
+
+Usage: speak_slow [options] <input file> <output file>
+where: <input file> and <output file> are paths to a wav or mp3 file
+
+[options]:
+EOS
+
+  opt :speed, "Speed of output file [0.1 - 100]", :default => 1.0
+  opt :silence, "Length (secondes) of a pause added to each utterance [0.1 - 120]", :default=> 1
+
+end
+Trollop::die :speed, "must between 0.1 to 100" unless opts[:speed] >= 0.1 and opts[:speed] <= 100
+Trollop::die :silence, "must be 0 to 120" unless opts[:silence] >= 0.1 and opts[:silence] <= 120
+
+############### main program ############### 
+
+if ARGV.size != 2
+  puts "Both input and output file paths must be specified"
+  exit
+end
+
+infile  = ARGV[0]
+outfile = ARGV[1]
+speed     = opts[:speed]
+silence    = opts[:silence]
+
+speakslow = SpeakSlow::Converter.new(infile, outfile)
+speakslow.execute(speed, silence)

data/lib/speak_slow.rb

@@ -0,0 +1,159 @@
+require "speak_slow/version"
+require "rubygems"
+require "progressbar"
+
+SOX = "/usr/local/bin/sox"
+SOXI = "/usr/local/bin/soxi"
+
+module SpeakSlow
+  DATA_DIR = File.expand_path(File.dirname(__FILE__) + "/../data")
+  
+  class Converter
+    def initialize(in_filepath, out_filepath)
+      
+      @sox = check_command(SOX)
+      @soxi = check_command(SOXI)
+            
+      if /([^\/]+)\.([^\.]+)\z/ =~ in_filepath and File.exists?(in_filepath)
+        @in_filepath = in_filepath
+        @basename = File.basename(in_filepath, ".*")
+        @in_format = $2
+      else
+        puts "The filename does not exist or not have a valid format"
+        exit
+      end
+      
+      if /([^\/]+)\.([^\.]+)\z/ =~ out_filepath
+        @out_filepath = out_filepath
+        @out_format = $2
+        @outdir = File.dirname(out_filepath)        
+      else
+        puts "The filename does not have a valid format"
+        exit
+      end
+
+      unless File.exists?(@outdir) && File::ftype(@outdir) == "directory"
+        puts "The output directory does not exist"
+        exit
+      end
+            
+      unless ["wav", "mp3"].index @out_format
+        puts "The output format specified is not available"
+        exit
+      end
+    end
+    
+    def execute(speed = 1, silence = 0)
+      @silence = silence
+      @speed = speed
+      temp_wav_original = @outdir + "/" + @basename + "-temp-original.wav"
+      temp_wav_result = @outdir + "/" + @basename + "-temp-result.wav"
+      if @in_format != "wav" # @in_format == "mp3"
+        convert_to_wav(@in_filepath, temp_wav_original)
+      elsif @in_format == "wav"
+        `cp #{@in_filepath} #{temp_wav_original}`        
+      end
+      
+      apply_sox_to_wav(temp_wav_original, temp_wav_result)
+      # split_wav(temp_wav_original)
+      # merge_wav(temp_wav_result)
+      
+      if @out_format == "mp3"
+        convert_to_mp3(temp_wav_result, @out_filepath)
+        `rm #{temp_wav_original} #{temp_wav_result}`
+      elsif @out_format == "wav"
+        `mv #{temp_wav_result} #{@out_filepath}; rm #{temp_wav_original}`   
+      end
+    end
+    
+    # def split_wav(in_filepath)
+    #   puts "Splitting WAV to segments"
+    #   result = `#{@sox} #{in_filepath} #{@outdir}/split-.wav silence 0 1 0.3 -32d : newfile : restart`
+    # end
+    # 
+    # def merge_wav(out_filepath)
+    #   temp_filepath = @outdir + "/temp.wav"
+    #   files = []
+    #   Dir.foreach(@outdir) do |file|
+    #     next unless /^split\-\d+\.wav$/ =~ file
+    #     files << @outdir + "/" + file      
+    #   end
+    #   index = 0
+    #   puts "Merging segments back to one WAV file"
+    #   bar = ProgressBar.new(@basename, files.size)        
+    #   files.sort.each do |filepath|
+    #     length = `#{@soxi} -D #{filepath}`.to_f
+    #     num_seconds = @silence == "auto" ? length.to_i + 1 : @silence.to_i
+    #     index += 1      
+    #     bar.inc(1)
+    #     if index == 1
+    #       File.rename(filepath, out_filepath)
+    #       next
+    #     end
+    # 
+    #     if length == 0 or @silence.to_f == 0
+    #       `#{@sox} #{out_filepath} #{filepath} #{temp_filepath} ; mv #{temp_filepath} #{out_filepath} ; rm #{filepath}`          
+    #     else
+    #       if @silence == "auto"
+    #         silence_length =  length
+    #       elsif @speed and @speed != 1
+    #         silence_length = @silence.to_f / @speed * 1
+    #       else 
+    #         silence_length = @silence
+    #       end
+    #       `#{@sox} #{out_filepath} -p pad 0 #{silence_length} | #{@sox} - #{filepath} #{temp_filepath} ; mv #{temp_filepath} #{out_filepath} ; rm #{filepath}`
+    #     end
+    #   end
+    #   print "\n"
+    #   puts "Changing speed of the resulting WAV"
+    #   if @speed and @speed.to_f != 1.0
+    #     `#{@sox} #{out_filepath} #{temp_filepath} tempo -s #{@speed}`
+    #     `mv #{temp_filepath} #{out_filepath}`
+    #   end      
+    # end
+    
+    def apply_sox_to_wav(in_filepath, out_filepath)
+      puts "Applying SoX functions to WAV (this might take a few minutes or more)"
+      # silence = "silence 0 1 0.3 -32d"
+      # silence = "silence 1 0.005 -32d 1 0.3 -32d"
+      silence = "silence 1 0.01 1% 1 0.3 1%"
+      if @speed and @speed != 1
+        speed = "tempo -s #{@speed}"
+        pad = "pad 0 #{@silence.to_f * @speed}"
+        `#{@sox} #{in_filepath} -p #{silence} #{pad} : restart | #{@sox} - -p | #{@sox} - #{out_filepath} #{speed}`
+      else
+        pad = "pad 0 #{@silence.to_f}"
+        `#{@sox} #{in_filepath} -p #{silence} #{pad} : restart | #{@sox} - #{out_filepath} `
+      end
+    end
+
+    def convert_to_wav(in_filepath, out_filepath)
+      basename = File.basename(in_filepath )
+      puts "Converting to WAV: #{basename}"      
+      `#{@sox} #{in_filepath} #{out_filepath}`
+    end
+    
+    def convert_to_mp3(in_filepath, out_filepath)
+      basename = File.basename(out_filepath)
+      puts "Converting WAV to MP3: #{basename}"
+      `#{@sox} #{in_filepath} #{out_filepath}`
+    end
+    
+    def check_command(command)
+      basename = File.basename(command)
+      path = ""
+      print "Checking #{basename} command: "
+      if open("| which #{command} 2>/dev/null"){ |f| path = f.gets }
+        puts "detected at #{path}"
+        return path.strip
+      elsif open("| which #{basename} 2>/dev/null"){ |f| path = f.gets }
+        puts "detected at #{path}"
+        return path.strip
+      else
+        puts "not installed to the system"
+        exit
+      end
+    end
+        
+  end # of class
+end # of module

data/lib/speak_slow/version.rb

@@ -0,0 +1,3 @@
+module SpeakSlow
+  VERSION = "0.0.1"
+end

data/speak_slow.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'speak_slow/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "speak_slow"
+  gem.version       = SpeakSlow::VERSION
+  gem.authors       = ["Yoichiro Hasebe"]
+  gem.email         = ["yohasebe@gmail.com"]
+  gem.description   = "SpeakSlow modifies audio files adding pauses and/or altering speed to suit for language study"
+  gem.summary       = "SpeakSlow modify audio files changing speed and adding pauses"
+  gem.homepage      = "http://github.com/yohasebe/speak_slow"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency "minitest"
+  gem.add_runtime_dependency "progressbar"
+  gem.add_runtime_dependency "trollop"  
+end

data/test/speak_slow_test.rb

@@ -0,0 +1,22 @@
+require 'minitest/autorun'
+require 'speak_slow'
+
+class TestSpeakSlow < MiniTest::Unit::TestCase
+  
+  def setup
+    @infile = SpeakSlow::DATA_DIR + "/MLK_Dream.mp3"
+    @outdir  = File.expand_path(File.dirname(__FILE__)) + "/result"
+    `rm -rf #{@outdir}` if File.exists? @outdir    
+    `mkdir #{@outdir}` unless File.exists? @outdir        
+    @outfile  = @outdir + "/result.mp3"
+    @speakslow = SpeakSlow::Converter.new(@infile, @outfile)
+  end
+  
+  def test_execution
+    @speakslow.execute(speed = 1.5, silence = 2)
+  end
+
+  def teardown
+    # `rm -rf #{@outdir}` if File.exists?(@outdir)
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: speak_slow
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Yoichiro Hasebe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: progressbar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SpeakSlow modifies audio files adding pauses and/or altering speed to
+  suit for language study
+email:
+- yohasebe@gmail.com
+executables:
+- speak_slow
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/speak_slow
+- data/MLK_Dream.mp3
+- data/MLK_Dream.wav
+- lib/speak_slow.rb
+- lib/speak_slow/version.rb
+- speak_slow.gemspec
+- test/speak_slow_test.rb
+homepage: http://github.com/yohasebe/speak_slow
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: SpeakSlow modify audio files changing speed and adding pauses
+test_files:
+- test/speak_slow_test.rb