zappa 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9023032146667f3a56103972668db8b509523a40
+  data.tar.gz: 0518855d8507741d5b9b46f294fcef41c74bb09e
+SHA512:
+  metadata.gz: 15d39fad530e36503cd55f22c91293d01d68d67280bbe56c24095d76b5fba34de4bf4d429b265620cc7eabf0d082a7d8a32bc3544f80432ecf0f9bb817bb7ca3
+  data.tar.gz: 8cc0ff30f8583cdc5a0d917ea552183a71f4fd6df5fdedd85fc6c9b1d046672ae71f2dec33341668bbeef42b62438a774397f4b93b30d0fa8482878bd39ec072

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zappa.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Varun Srinivasan
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Varun Srinivasan
+
+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,51 @@
+# Zappa
+
+Zappa is a high level audio manipulation library for Ruby, inspired by pydub.
+
+## Installation
+
+First install ffmpeg:
+
+    brew install ffmpeg
+
+Add this line to your application's Gemfile:
+
+    gem 'zappa'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zappa
+
+## Usage
+
+You can open a wave file:
+
+```
+include 'zappa'
+s = Segment.from_file('this_is_a_song.wav')
+```
+
+and then read any of its properties:
+
+```
+puts s.format
+```
+
+and save it to a different location:
+
+```
+s.to_file('output.wav')
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/zappa/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/ROADMAP.md

@@ -0,0 +1,62 @@
+0.0.1 - Basic editing
+-------------------
+- Install ffmpeg + dependencies on MacOS X
+- Import: WAV
+- Export: WAV
+
+
+0.0.2 - Slicing
+-------------
+- Slice segments into smaller parts (by time or samples)
+- Join segments
+
+
+0.0.3 - DSP - Basic
+----------------
+- Amplify signals by DB
+- Calculate RMS
+- Calculate Max
+- Normalize
+- Phase Invert
+
+
+0.0.4 - Multi Format Exporting
+----------------------------
+- Import: MP3, OGG, M4A, FLAC, AIFF
+- Export: MP3, OGG, M4A, FLAC, AIFF
+
+0.0.5 - OS Support
+----------------
+- OS: Windows, Linux, Mac Support
+
+
+Release - 0.1 Basic DSP Platform
+==============================
+
+
+0.1.1 - DSP - Filters - Basic
+---------------------------
+
+- DSP: Low Pass Filter
+- DSP: High Pass Filter
+- DSP: Notch Filter
+
+
+0.1.2 DSP - Time Effects
+----------------------
+- Speed Up / Down
+- Reverse
+- Fade In / Fade Out
+
+
+0.1.3 - DSP - Equalizer
+---------------------
+- 8 Chan EQ
+
+
+0.1.4 - DSP - Dynamics
+----------------------
+
+- DSP: Compressor
+- DSP: Remove Silence
+- DSP: Limiter

data/Rakefile

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

data/lib/zappa/errors.rb

@@ -0,0 +1,7 @@
+module Zappa
+  class FileFormatError < StandardError
+  end
+
+  class FileError < StandardError
+  end
+end

data/lib/zappa/segment.rb

@@ -0,0 +1,40 @@
+require 'tempfile'
+
+module Zappa
+  class Segment
+    attr_reader :source
+
+    def initialize(path = nil)
+      if path
+        from_file(path)
+      else
+        @source = nil
+      end
+    end
+
+    def from_file(path)
+      @source = Wave.new(safe_copy(path))
+    end
+
+    def to_file(path, format = 'wav')
+      raise FileError.new('No data in Segment') if @source.nil?
+      out = system('ffmpeg', '-i', @source.file_path, '-y', '-f', format, path)
+      raise ('Cannot export to' + path ) if out == false
+      raise FileError.new('ffmpeg not installed') if out.nil?
+    end
+
+    def ==(other)
+      source == other.source
+    end
+
+    private
+
+    def safe_copy(path)
+      tmp = Tempfile.new('zappa')
+      out = system('ffmpeg', '-i', path, '-vn', '-y', '-f', 'wav', tmp.path)
+      raise 'Cannot open file' if out == false
+      raise 'ffmpeg not installed' if out.nil?
+      tmp.path
+    end
+  end
+end

data/lib/zappa/version.rb

@@ -0,0 +1,3 @@
+module Zappa
+  VERSION = '0.0.1'
+end

data/lib/zappa/wave.rb

@@ -0,0 +1,73 @@
+# http://soundfile.sapp.org/doc/WaveFormat/
+
+module Zappa
+  class Wave
+    attr_accessor :format, :data, :data_size, :file_path
+    SUBCHUNKS = %w('fmt', 'data')
+    KNOWN_FMT_SIZE = 16
+
+    def initialize(path)
+      @format = {}
+      @data = {}
+
+      begin
+        @file = File.new(path, 'rb')
+      rescue
+        raise FileError.new('Could not find ' + path)
+      else
+        @file_path = @file.path
+        unpack_wav
+      end
+    end
+
+    def unpack_wav
+      unpack_riff_header
+      while @data[:data].nil?
+        unpack_subchunk
+      end
+    end
+
+    def unpack_riff_header
+      chunk_id = @file.read(4)
+      _ = @file.read(4).unpack('V').first # chunk_size
+      format = @file.read(4)
+      raise FileFormatError.new('Format is not WAVE') unless format == 'WAVE'
+      raise FileFormatError.new('ID is not RIFF') unless chunk_id == 'RIFF'
+    end
+
+    def unpack_subchunk
+      id = @file.read(4).strip
+      if SUBCHUNKS.include?(id)
+        send('unpack_' + id)
+      else
+        unpack_unknown
+      end
+    end
+
+    def unpack_fmt
+      size                      = @file.read(4).unpack('V').first
+      @format[:audio_format]    = @file.read(2).unpack('v').first
+      @format[:channels]        = @file.read(2).unpack('v').first
+      @format[:sample_rate]     = @file.read(4).unpack('V').first
+      @format[:byte_rate]       = @file.read(4).unpack('V').first
+      @format[:block_align]     = @file.read(2).unpack('v').first
+      @format[:bits_per_sample] = @file.read(2).unpack('v').first
+      unread = size - KNOWN_FMT_SIZE
+      @format[:unknown] = @file.read(unread) if unread > 0
+    end
+
+    def unpack_data
+      @data[:size]  = @file.read(4).unpack('V').first
+      @data[:data]  = @file.read(@data_size)
+    end
+
+    def unpack_unknown
+      size = @file.read(4).unpack('V').first
+      @file.read(size)
+    end
+
+    def ==(other)
+      other.format == format && other.data == data
+    end
+  end
+end

data/lib/zappa.rb

@@ -0,0 +1,4 @@
+require 'zappa/version'
+require 'zappa/segment'
+require 'zappa/wave'
+require 'zappa/errors'

data/spec/segment_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'tempfile'
+
+WAV_IN  = 'spec/audio/basic-5s.wav'
+
+describe Zappa::Segment do
+  before do
+    subject.from_file(WAV_IN)
+  end
+
+  describe '#from_file' do
+    it 'makes a safe copy of the source wav file' do
+      expect(Zappa::Wave.new(WAV_IN))
+        .to eq(Zappa::Wave.new(subject.source.file_path))
+    end
+
+    it 'raises error if file does not exist' do
+      expect { Zappa::Segment.new('some_foo') }.to raise_error(RuntimeError)
+    end
+
+    pending 'raises error if ffmpeg is not installed'
+    pending 'only permits wav files'
+  end
+
+  describe '#to_file' do
+    it 'exports the segment to a wav file' do
+      tmp = Tempfile.new('zappa-spec')
+      subject.to_file(tmp.path, 'wav')
+      expect(Zappa::Wave.new(WAV_IN)).to eq(Zappa::Wave.new(tmp.path))
+    end
+
+    it 'raises error if segment is empty' do
+      w = Zappa::Segment.new
+      expect { w.to_file('foo.wav') }.to raise_error(Zappa::FileError)
+    end
+
+    it 'raises error for invalid path' do
+      expect { subject.to_file('some:foo') }.to raise_error(RuntimeError)
+    end
+
+    pending 'raises error if ffmpeg is not installed'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'zappa'
+
+RSpec.configure do |config|
+  # config
+end
+
+def wav_data(encoded_wav)
+  encoded_wav.split('dataPu').last
+end

data/spec/wave_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'tempfile'
+
+WAV_IN  = 'spec/audio/basic-5s.wav'
+WAV_EX  = 'does-not-exist.wav'
+
+describe Zappa::Wave do
+  it 'reads format headers correctly' do
+    fmt_header = { audio_format: 1,
+                   channels: 2,
+                   sample_rate: 44_100,
+                   byte_rate: 176_400,
+                   block_align: 4,
+                   bits_per_sample: 16 }
+    w = Zappa::Wave.new(WAV_IN)
+    expect(w.format).to eq(fmt_header)
+  end
+
+  it 'raises error for incorrect path' do
+    expect { Zappa::Wave.new(WAV_EX) }.to raise_error(Zappa::FileError)
+  end
+
+  pending 'handles wave files with unknown subchunks'
+  pending 'handles wave files with optional tmp data'
+end

data/zappa.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zappa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'zappa'
+  spec.version       = Zappa::VERSION
+  spec.authors       = ['Varun Srinivasan']
+  spec.email         = ['varunsrin@gmail.com']
+  spec.summary       = 'Ruby gem for manipulating audio files.'
+  spec.description   = ''
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: zappa
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Varun Srinivasan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- varunsrin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- ROADMAP.md
+- Rakefile
+- lib/zappa.rb
+- lib/zappa/errors.rb
+- lib/zappa/segment.rb
+- lib/zappa/version.rb
+- lib/zappa/wave.rb
+- spec/audio/basic-5s.wav
+- spec/segment_spec.rb
+- spec/spec_helper.rb
+- spec/wave_spec.rb
+- zappa.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby gem for manipulating audio files.
+test_files:
+- spec/audio/basic-5s.wav
+- spec/segment_spec.rb
+- spec/spec_helper.rb
+- spec/wave_spec.rb