scissor 0.0.22

data/ChangeLog

@@ -0,0 +1,4 @@
+== 0.0.1 / 2009-03-29
+
+* initial release
+

data/README.rdoc

@@ -0,0 +1,78 @@
+= Scissor
+
+== Description
+
+utility to chop sound files
+
+supported file format:
+
+* mp3
+* wav
+
+== Installation
+
+=== Requirements
+
+* {FFmpeg}[http://ffmpeg.mplayerhq.hu/]
+* {Ecasound}[http://www.eca.cx/ecasound/] 2.5.0 or higher
+
+=== Archive Installation
+
+ rake install
+
+=== Gem Installation
+
+ gem update --system
+ gem install gemcutter
+ gem tumble
+ gem install scissor
+
+== Features/Problems
+
+* When you concatenate two or more files, format(sample rate, bit rate, ...) mismatch causes unexpected changes to output file.
+
+== Synopsis
+
+=== instantiate
+
+ foo = Scissor('foo.mp3')
+ bar = Scissor('bar.wav')
+  
+=== concat
+
+ foo + bar > 'foobar.mp3'
+
+=== slice + concat
+
+ foo[10, 1] + bar[2, 3] > 'slicefoobar.mp3'
+
+=== slice + concat + loop
+
+ (foo[10, 1] + bar[2, 3]) * 4 > 'slicefoobarloop.mp3'
+
+=== split
+
+ (Scissor('sequence.mp3') / 16).first.to_file('split.mp3')
+
+=== replace first 10 seconds with 30 seconds of silence
+
+ foo.replace(0, 10, Scissor.silence(30)).to_file('replace.mp3')
+
+=== sequence + loop
+
+ seq = Scissor.sequence('x y  xyz', 0.2)
+ seq.apply(:x => foo, :y => Proc.new { bar }, :z => foo.reverse) * 4 > 'sequence.wav'
+
+=== half the pitch
+
+ foo.pitch(50)
+
+=== mix
+
+ Scissor.mix([foo, bar], 'mix.mp3')
+
+== Copyright
+
+Author:: youpy <youpy@buycheapviagraonlinenow.com>
+Copyright:: Copyright (c) 2009 youpy
+License:: MIT

data/Rakefile

@@ -0,0 +1,107 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'spec/rake/spectask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/sshpublisher'
+require 'fileutils'
+include FileUtils
+
+NAME              = "scissor"
+AUTHOR            = "youpy"
+EMAIL             = "youpy@buycheapviagraonlinenow.com"
+DESCRIPTION       = "utility to chop sound files"
+RUBYFORGE_PROJECT = "scissor"
+HOMEPATH          = "http://github.com/youpy/scissor"
+BIN_FILES         = %w(  )
+VERS              = "0.0.22"
+
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = [
+  '--title', "#{NAME} documentation",
+  "--charset", "utf-8",
+  "--opname", "index.html",
+  "--line-numbers",
+  "--main", "README.rdoc",
+  "--inline-source",
+]
+
+task :default => [:spec]
+task :package => [:clean]
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb']
+  t.rcov = true
+end
+
+spec = Gem::Specification.new do |s|
+  s.name              = NAME
+  s.version           = VERS
+  s.platform          = Gem::Platform::RUBY
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = ["README.rdoc", "ChangeLog"]
+  s.rdoc_options     += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
+  s.summary           = DESCRIPTION
+  s.description       = DESCRIPTION
+  s.author            = AUTHOR
+  s.email             = EMAIL
+  s.executables       = BIN_FILES
+  s.rubyforge_project = RUBYFORGE_PROJECT
+  s.bindir            = "bin"
+  s.require_path      = "lib"
+  s.homepage          = HOMEPATH
+  s.test_files        = Dir["test/test_*.rb"]
+
+  s.add_dependency('open4')
+  s.add_dependency('ruby-mp3info')
+  s.add_dependency('riff')
+  s.add_dependency('tempdir')
+  #s.required_ruby_version = '>= 1.8.2'
+
+  s.files = %w(README.rdoc ChangeLog Rakefile) +
+    Dir.glob("{bin,doc,test,lib,data,templates,generator,extras,website,script}/**/*") + 
+    Dir.glob("ext/**/*.{h,c,rb}") +
+    Dir.glob("examples/**/*.rb") +
+    Dir.glob("tools/*.rb")
+
+  s.extensions = FileList["ext/**/extconf.rb"].to_a
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.need_tar = true
+  p.gem_spec = spec
+end
+
+task :install do
+  name = "#{NAME}-#{VERS}.gem"
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{name}}
+end
+
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{NAME}}
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'html'
+  rdoc.options += RDOC_OPTS
+  rdoc.template = "resh"
+  #rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+  if ENV['DOC_FILES']
+    rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,\s*/))
+  else
+    rdoc.rdoc_files.include('README.rdoc', 'ChangeLog')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+    rdoc.rdoc_files.include('ext/**/*.c')
+  end
+end
+
+desc 'Show information about the gem.'
+task :debug_gem do
+  puts spec.to_ruby
+end

data/lib/scissor/chunk.rb

@@ -0,0 +1,183 @@
+module Scissor
+  class Chunk
+    class Error < StandardError; end
+    class EmptyFragment < Error; end
+    class OutOfDuration < Error; end
+
+    attr_reader :fragments
+
+    def initialize(filename = nil)
+      @fragments = []
+
+      if filename
+        @fragments << Fragment.new(
+          filename,
+          0,
+          SoundFile.new(filename).length)
+      end
+    end
+
+    def add_fragment(fragment)
+      @fragments << fragment
+    end
+
+    def add_fragments(fragments)
+      fragments.each do |fragment|
+        add_fragment(fragment)
+      end
+    end
+
+    def duration
+      @fragments.inject(0) do |memo, fragment|
+        memo += fragment.duration
+      end
+    end
+
+    def slice(start, length)
+      if start + length > duration
+        length = duration - start
+      end
+
+      new_instance = self.class.new
+      remaining_start = start.to_f
+      remaining_length = length.to_f
+
+      @fragments.each do |fragment|
+        new_fragment, remaining_start, remaining_length =
+          fragment.create(remaining_start, remaining_length)
+
+        if new_fragment
+          new_instance.add_fragment(new_fragment)
+        end
+
+        if remaining_length == 0
+          break
+        end
+      end
+
+      new_instance
+    end
+
+    alias [] slice
+
+    def concat(other)
+      add_fragments(other.fragments)
+
+      self
+    end
+
+    alias << concat
+
+    def +(other)
+      new_instance = Scissor()
+      new_instance.add_fragments(@fragments + other.fragments)
+      new_instance
+    end
+
+    def loop(count)
+      orig_fragments = @fragments.clone
+
+      (count - 1).times do
+        add_fragments(orig_fragments)
+      end
+
+      self
+    end
+
+    alias * loop
+
+    def split(count)
+      splitted_duration = duration / count.to_f
+      results = []
+
+      count.times do |i|
+        results << slice(i * splitted_duration, splitted_duration)
+      end
+
+      results
+    end
+
+    alias / split
+
+    def fill(filled_duration)
+      if @fragments.empty?
+        raise EmptyFragment
+      end
+
+      remain = filled_duration
+      new_instance = self.class.new
+
+      while !remain.zero? && filled_duration > new_instance.duration
+        if remain < duration
+          added = slice(0, remain)
+        else
+          added = self
+        end
+
+        new_instance += added
+        remain -= added.duration
+      end
+
+
+      new_instance
+    end
+
+    def replace(start, length, replaced)
+      new_instance = self.class.new
+      offset = start + length
+
+      if offset > duration
+        raise OutOfDuration
+      end
+
+      if start > 0
+        new_instance += slice(0, start)
+      end
+
+      new_instance += replaced
+      new_instance += slice(offset, duration - offset)
+
+      new_instance
+    end
+
+    def reverse
+      new_instance = self.class.new
+
+      @fragments.reverse.each do |fragment|
+        new_instance.add_fragment(Fragment.new(
+            fragment.filename,
+            fragment.start,
+            fragment.true_duration,
+            !fragment.reversed?,
+            fragment.pitch))
+      end
+
+      new_instance
+    end
+
+    def pitch(pitch)
+      new_instance = self.class.new
+
+      @fragments.each do |fragment|
+        new_instance.add_fragment(Fragment.new(
+            fragment.filename,
+            fragment.start,
+            fragment.true_duration,
+            fragment.reversed?,
+            fragment.pitch * (pitch.to_f / 100)))
+      end
+
+      new_instance
+    end
+
+    def to_file(filename, options = {})
+      Scissor.mix([self], filename, options)
+    end
+
+    alias > to_file
+
+    def >>(filename)
+      to_file(filename, :overwrite => true)
+    end
+  end
+end

data/lib/scissor/fragment.rb

@@ -0,0 +1,61 @@
+require 'pathname'
+
+module Scissor
+  class Fragment
+    attr_reader :filename, :start, :pitch
+
+    def initialize(filename, start, duration, reverse = false, pitch = 100)
+      @filename = Pathname.new(filename).realpath
+      @start = start
+      @duration = duration
+      @reverse = reverse
+      @pitch = pitch
+
+      freeze
+    end
+
+    def duration
+      @duration * (100 / pitch.to_f)
+    end
+
+    def true_duration
+      @duration
+    end
+
+    def reversed?
+      @reverse
+    end
+
+    def create(remaining_start, remaining_length)
+      new_fragment = nil
+
+      if remaining_start >= duration
+        remaining_start -= duration
+      else
+        if remaining_start + remaining_length >= duration
+          new_fragment = self.class.new(
+            filename,
+            start + remaining_start * pitch.to_f / 100,
+            (duration - remaining_start) * pitch.to_f / 100,
+            false,
+            pitch)
+
+          remaining_length -= duration - remaining_start
+          remaining_start = 0
+        else
+          new_fragment = self.class.new(
+            filename,
+            start + remaining_start * pitch.to_f / 100,
+            remaining_length * pitch.to_f / 100,
+            false,
+            pitch)
+
+          remaining_start = 0
+          remaining_length = 0
+        end
+      end
+
+      return new_fragment, remaining_start, remaining_length
+    end
+  end
+end

data/lib/scissor/loggable.rb

@@ -0,0 +1,7 @@
+module Scissor
+  module Loggable
+    def logger
+      Scissor.logger
+    end
+  end
+end

data/lib/scissor/sequence.rb

@@ -0,0 +1,30 @@
+module Scissor
+  class Sequence
+    def initialize(pattern, duration_per_step)
+      @pattern = pattern
+      @duration_per_step = duration_per_step
+    end
+
+    def apply(instruments)
+      @pattern.split(//).inject(Scissor()) do |result, c|
+        if instruments.include?(c.to_sym)
+          instrument = instruments[c.to_sym]
+
+          if instrument.is_a?(Proc)
+            instrument = instrument.call(c)
+          end
+
+          if @duration_per_step > instrument.duration
+            result += instrument + Scissor.silence(@duration_per_step - instrument.duration)
+          else
+            result += instrument.slice(0, @duration_per_step)
+          end
+        else
+          result += Scissor.silence(@duration_per_step)
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/scissor/sound_file.rb

@@ -0,0 +1,34 @@
+require 'mp3info'
+require 'pathname'
+require 'riff/reader'
+
+module Scissor
+  class SoundFile
+    SUPPORTED_FORMATS = %w/mp3 wav/
+
+    class Error < StandardError; end
+    class UnknownFormat < Error; end
+
+    def initialize(filename)
+      @filename = Pathname.new(filename)
+      @ext = @filename.extname.sub(/^\./, '').downcase
+
+      unless SUPPORTED_FORMATS.include?(@ext)
+        raise UnknownFormat
+      end
+    end
+
+    def length
+      case @ext
+      when 'mp3'
+        Mp3Info.new(@filename).length
+      when 'wav'
+        riff = Riff::Reader.open(@filename ,"r")
+        data = riff.root_chunk['data']
+        fmt = riff.root_chunk['fmt ']
+
+        data.length / fmt.body.unpack('s2i2')[3].to_f
+      end
+    end
+  end
+end

data/lib/scissor/writer.rb

@@ -0,0 +1,132 @@
+require 'digest/md5'
+require 'pathname'
+require 'open4'
+require 'temp_dir'
+
+module Scissor
+  class Writer
+    include Loggable
+
+    class Error < StandardError; end
+    class FileExists < Error; end
+    class EmptyFragment < Error; end
+    class CommandFailed < Error; end
+
+    def initialize
+      @tracks = []
+
+      which('ecasound')
+      which('ffmpeg')
+    end
+
+    def add_track(fragments)
+      @tracks << fragments
+    end
+
+    def fragments_to_file(fragments, outfile, tmpdir)
+      position = 0.0
+      cmd = %w/ecasound/
+
+      fragments.each_with_index do |fragment, index|
+        fragment_filename = fragment.filename
+        fragment_duration = fragment.duration
+
+        if !index.zero? && (index % 80).zero?
+          run_command(cmd.join(' '))
+          cmd = %w/ecasound/
+        end
+
+        fragment_outfile =
+          fragment_filename.extname.downcase == '.wav' ? fragment_filename :
+          tmpdir + (Digest::MD5.hexdigest(fragment_filename) + '.wav')
+
+        unless fragment_outfile.exist?
+          run_command("ffmpeg -i \"#{fragment_filename}\" \"#{fragment_outfile}\"")
+        end
+
+        cmd <<
+          "-a:#{index} " +
+          "-i:" +
+          (fragment.reversed? ? 'reverse,' : '') +
+          "select,#{fragment.start},#{fragment.true_duration},\"#{fragment_outfile}\" " +
+          "-o:#{outfile} " +
+          (fragment.pitch.to_f == 100.0 ? "" : "-ei:#{fragment.pitch} ") +
+          "-y:#{position}"
+
+        position += fragment_duration
+      end
+
+      run_command(cmd.join(' '))
+    end
+
+    def mix_files(filenames, outfile)
+      cmd = %w/ecasound/
+
+      filenames.each_with_index do |tf, index|
+        cmd << "-a:#{index} -i:#{tf}"
+      end
+
+      cmd << "-a:all -o:#{outfile}"
+      run_command(cmd.join(' '))
+    end
+
+    def to_file(filename, options)
+      filename = Pathname.new(filename)
+
+      if @tracks.flatten.empty?
+        raise EmptyFragment
+      end
+
+      options = {
+        :overwrite => false,
+        :bitrate => '128k'
+      }.merge(options)
+
+      if filename.exist?
+        if options[:overwrite]
+          filename.unlink
+        else
+          raise FileExists
+        end
+      end
+
+      TempDir.create do |dir|
+        tmpdir = Pathname.new(dir)
+        tmpfiles = []
+
+        @tracks.each_with_index do |fragments, track_index|
+          tmpfiles << tmpfile = tmpdir + 'track_%s.wav' % track_index.to_s
+          fragments_to_file(fragments, tmpfile, tmpdir)
+        end
+
+        mix_files(tmpfiles, final_tmpfile = tmpdir + 'tmp.wav')
+
+        if filename.extname == '.wav'
+          File.rename(final_tmpfile, filename)
+        else
+          run_command("ffmpeg -ab #{options[:bitrate]} -i \"#{final_tmpfile}\" \"#{filename}\"")
+        end
+      end
+    end
+
+    def which(command)
+      run_command("which #{command}")
+    end
+
+    def run_command(cmd)
+      logger.debug("run_command: #{cmd}")
+
+      result = ''
+      status = Open4.popen4(cmd) do |pid, stdin, stdout, stderr|
+        logger.debug(stderr.read)
+        result = stdout.read
+      end
+
+      if status.exitstatus != 0
+        raise CommandFailed.new(cmd)
+      end
+
+      return result
+    end
+  end
+end

data/lib/scissor.rb

@@ -0,0 +1,55 @@
+require 'scissor/loggable'
+require 'scissor/chunk'
+require 'scissor/fragment'
+require 'scissor/sound_file'
+require 'scissor/sequence'
+require 'scissor/writer'
+
+def Scissor(*args)
+  Scissor::Chunk.new(*args)
+end
+
+require 'logger'
+
+module Scissor
+  @logger = Logger.new(STDOUT)
+  @logger.level = Logger::INFO
+
+  class << self
+    attr_accessor :logger
+  end
+
+  def logger
+    self.class.logger
+  end
+
+  class << self
+    def silence(duration)
+      Scissor(File.dirname(__FILE__) + '/../data/silence.mp3').
+        slice(0, 1).
+        fill(duration)
+    end
+
+    def sequence(*args)
+      Scissor::Sequence.new(*args)
+    end
+
+    def join(scissor_array)
+      scissor_array.inject(Scissor()) do |m, scissor|
+        m + scissor
+      end
+    end
+
+    def mix(scissor_array, filename, options = {})
+      writer = Scissor::Writer.new
+
+      scissor_array.each do |scissor|
+        writer.add_track(scissor.fragments)
+      end
+
+      writer.to_file(filename, options)
+
+      Scissor(filename)
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: scissor
+version: !ruby/object:Gem::Version 
+  version: 0.0.22
+platform: ruby
+authors: 
+- youpy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-11 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby-mp3info
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: riff
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: tempdir
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: utility to chop sound files
+email: youpy@buycheapviagraonlinenow.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- ChangeLog
+files: 
+- README.rdoc
+- ChangeLog
+- Rakefile
+- lib/scissor/chunk.rb
+- lib/scissor/fragment.rb
+- lib/scissor/loggable.rb
+- lib/scissor/sequence.rb
+- lib/scissor/sound_file.rb
+- lib/scissor/writer.rb
+- lib/scissor.rb
+- data/silence.mp3
+has_rdoc: true
+homepage: http://github.com/youpy/scissor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- scissor documentation
+- --charset
+- utf-8
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README.rdoc
+- --inline-source
+- --exclude
+- ^(examples|extras)/
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: scissor
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: utility to chop sound files
+test_files: []
+