neve 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9613a72ace63fa45343dbd6fd02999e678df40d2
-  data.tar.gz: f8f1f1fad6958f0475e49ee4bc41ceba76b4df46
+  metadata.gz: 7714e64fbaf457649ef08a5883c70255b596f8b5
+  data.tar.gz: c98083dd190eb30ce2838e5eb6a8dc997393ea06
 SHA512:
-  metadata.gz: e923d4f47fdded4e738de7071570ad577408c184ca852b72d89fe253664e9a95a4910cee56ec9276c1bd7e44ea1c0743d33438dcb7fd077f33e7dbc22a8c8ba5
-  data.tar.gz: bd1e1b578f19c177e003ef89ea026f164c6d558f3ae9fc833ca9e76503394fdd22d223927ec1b3cb4e77afe75f98b0d331619414927d9a8ae3a1cce494348df6
+  metadata.gz: 45f62b653ffafb3da75363536113e44235a42397fa0d24ad6348fa6152805b76a2baac018520fbab1431f29f3085c80c7c3a4200c809113ae2e15c9e064a6c7a
+  data.tar.gz: 1f226b1dd8be7705a452adf1b01e45ba8c33a39d9445ac483767b3717c5f532b181d4d96c4661da00577349212ccbc9c4933e8da202c0291cd973dbb16736afd

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/support/my_awesome_tune.wav

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/README.md

@@ -1,28 +1,60 @@
 # Neve
 
-TODO: Write a gem description
+Friendly audio mixing, on your command line.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Neve depends on [ecasound](http://ecasound.seul.org/ecasound/download.php). On
+a Mac, install via [Homebrew](http://brew.sh/):
 
-    gem 'neve'
+    $ brew install ecasound
+    $ gem install neve
 
-And then execute:
+## Usage
 
-    $ bundle
+Neve expects your files to be organised like this, where `my_awesome_tune` is an
+example song name:
 
-Or install it yourself as:
+    ├── my_awesome_tune
+    │   ├── bass.wav
+    │   ├── drums.wav
+    │   └── guitar.wav
+    └── my_awesome_tune.yml
 
-    $ gem install neve
+All mix settings are contained in `my_awesome_tune.yml`.  For each track,
+the `fader` and `pan` percentages can be set.  Names are expected to match a
+`wav` file within the folder of the same name.
 
-## Usage
+    bass:
+      fader: 33
+      pan: 25
+    drums:
+      fader: 33
+      pan: 50
+    guitar:
+      fader: 33
+      pan: 75
+
+`fader` is an optional value that represents a percentage of the track
+level. Values below `100` will attenuate the track while values above `100` will
+cause the track to be amplified. If no value is set, it will default to `100`.
+
+__Please note that there is no limiting - please use caution when setting fader values,
+especially with many tracks__
+
+`pan` is an optional value that represents the left/right balance of the track.
+`0` is fully left, `100` is fully right. If no value if set, it will default to `50`.
+
+With the configuration and tracks in place, we can bounce the mix to file:
+
+    $ neve mix my_awesome_tune
 
-TODO: Write usage instructions here
+The mixed file name will include a timestamp to avoid replacing any existing mixes,
+so for example `my_awesome_tune_20140502132657.wav`
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/neve/fork )
+1. Fork it ( http://github.com/seenmyfate/neve/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`)

data/bin/neve

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+lib_dir = File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift lib_dir if File.directory?(lib_dir)
+require 'neve'
+
+Neve::CLI.start

data/lib/neve.rb

@@ -1,5 +1,5 @@
-require "neve/version"
+require 'neve/cli'
 
 module Neve
-  # Your code goes here...
+  # Friendly audio mixing, right on your command line.
 end

data/lib/neve/cli.rb

@@ -0,0 +1,13 @@
+require 'thor'
+require 'neve/mix'
+
+module Neve
+  class CLI < Thor
+
+    desc 'mix FILENAME', 'mixes the tracks specified in FILENAME'
+    def mix(filename)
+      Mix.new(filename).run
+    end
+
+  end
+end

data/lib/neve/eca_sound/mix.rb

@@ -0,0 +1,46 @@
+require 'neve/eca_sound/track'
+module Neve
+  module ECASound
+    class Mix
+
+      def initialize(directory, configuration)
+        @directory, @configuration = directory, configuration
+      end
+
+      def to_s
+        [
+          ecasound,
+          mix,
+          output
+        ].join
+      end
+
+      private
+
+      def ecasound
+        'ecasound '
+      end
+
+      def mix
+        tracks.each_with_index.inject('') do |string, (track, i)|
+          string << "-a:#{i+1} -i #{track} "
+        end
+      end
+
+      def output
+        "-a:#{track_list} -o #{@directory}.wav"
+      end
+
+      def track_list
+        (1..tracks.size).to_a.join(',')
+      end
+
+      def tracks
+        @tracks ||= @configuration.map do |track, options|
+          Track.new(@directory, track, options)
+        end
+      end
+
+    end
+  end
+end

data/lib/neve/eca_sound/track.rb

@@ -0,0 +1,34 @@
+require 'pathname'
+module Neve
+  module ECASound
+    class Track
+
+      def initialize(directory, name, options)
+        @directory, @name, @options = directory, name, options
+      end
+
+      def to_s
+        [
+          filename,
+          mix,
+          pan
+        ].join(' ')
+      end
+
+      private
+
+      def filename
+        Pathname.new(@directory).join("#{@name}.wav")
+      end
+
+      def mix
+        "-ea:#{@options.fetch('fader', 100)}"
+      end
+
+      def pan
+        "-epp:#{@options.fetch('pan', 50)}"
+      end
+
+    end
+  end
+end

data/lib/neve/loads_yaml.rb

@@ -0,0 +1,10 @@
+require 'yaml'
+module Neve
+  module LoadsYaml
+
+    def configuration
+      @configuration ||= YAML.load_file(file)
+    end
+
+  end
+end

data/lib/neve/mix.rb

@@ -0,0 +1,23 @@
+require 'neve/runs'
+require 'neve/loads_yaml'
+require 'neve/eca_sound/mix'
+
+module Neve
+  class Mix
+    include Runs
+    include LoadsYaml
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def file
+      "#{@filename}.yml"
+    end
+
+    def command
+      ECASound::Mix.new(@filename, configuration).to_s
+    end
+
+  end
+end

data/lib/neve/runs.rb

@@ -0,0 +1,20 @@
+require 'open3'
+
+module Neve
+
+  class Error < StandardError;end;
+
+  module Runs
+
+    def self.included(includer)
+      includer.send(:attr_accessor, :output, :status)
+      includer.send(:private, :output, :status)
+    end
+
+    def run
+      self.output, self.status = Open3.capture2(command)
+      fail Neve::Error.new(output) unless status.success?
+    end
+
+  end
+end

data/neve.gemspec

@@ -1,23 +1,25 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'neve/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "neve"
-  spec.version       = Neve::VERSION
-  spec.authors       = ["seenmyfate"]
-  spec.email         = ["seenmyfate@gmail.com"]
-  spec.summary       = %q{Command line mixing console}
-  spec.description   = %q{Command line mixing console}
-  spec.homepage      = "https://github.com/seenmyfate/neve"
-  spec.license       = "MIT"
+  spec.name          = 'neve'
+  spec.version       = '0.1.0'
+  spec.authors       = ['seenmyfate']
+  spec.email         = ['seenmyfate@gmail.com']
+  spec.summary       = %q{Friendly audio mixing, right on your command line}
+  spec.description   = %q{Friendly audio mixing, right on your command line}
+  spec.homepage      = 'https://github.com/seenmyfate/neve'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency 'thor'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

data/spec/lib/neve/cli_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+module Neve
+
+  describe CLI do
+    let(:mix) { double }
+    let(:filename) { double }
+
+    describe '#mix' do
+      it 'runs a new Mix instance' do
+        expect(Mix).to receive(:new).with(filename).and_return(mix)
+        expect(mix).to receive(:run)
+
+        CLI.new.mix(filename)
+      end
+    end
+  end
+
+end

data/spec/lib/neve/eca_sound/mix_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module Neve
+  module ECAsound
+    describe Mix do
+      let(:mix) { ECASound::Mix.new(directory, configuration) }
+      let(:directory) { 'spec/support/my_awesome_tune' }
+      let(:configuration) { YAML.load_file('spec/support/my_awesome_tune.yml') }
+
+      describe '.new' do
+        it 'takes the type, configuration' do
+          expect(mix)
+        end
+      end
+
+      describe '#to_s' do
+        let(:ecasound_command) {
+          'ecasound ' \
+          '-a:1 -i spec/support/my_awesome_tune/bass.wav -ea:33 -epp:25 ' \
+          '-a:2 -i spec/support/my_awesome_tune/drums.wav -ea:33 -epp:50 ' \
+          '-a:3 -i spec/support/my_awesome_tune/guitar.wav -ea:33 -epp:75 ' \
+          '-a:1,2,3 -o spec/support/my_awesome_tune.wav'
+        }
+
+        it 'returns the ecasound string' do
+          expect(mix.to_s).to eq ecasound_command
+        end
+      end
+
+    end
+  end
+end

data/spec/lib/neve/eca_sound/track_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module Neve
+  module ECASound
+
+    describe Track do
+      let(:track) { Track.new(directory, name, options) }
+      let(:directory) { 'spec/support/my_awesome_tune' }
+      let(:name) { 'guitar' }
+      let(:options) { YAML.load_file('spec/support/my_awesome_tune.yml')['guitar'] }
+
+      describe '.new' do
+        it 'takes a filename, options' do
+          expect(track)
+        end
+      end
+
+      describe '#to_s' do
+        let(:mix_string) { 'spec/support/my_awesome_tune/guitar.wav -ea:33 -epp:75' }
+
+        it 'returns the mix string' do
+          expect(track.to_s).to eq mix_string
+        end
+      end
+    end
+
+  end
+end

data/spec/lib/neve/loads_yaml_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+module Neve
+
+  class ParsingExample
+    include LoadsYaml
+
+    def file
+      'spec/support/my_awesome_tune.yml'
+    end
+  end
+
+  describe '#configuration' do
+    let(:configuration) { double }
+
+    it 'returns the parsed yaml' do
+      expect(YAML).to receive(:load_file).with('spec/support/my_awesome_tune.yml').
+        and_return(configuration)
+      expect(ParsingExample.new.configuration).to eq configuration
+    end
+  end
+
+end

data/spec/lib/neve/mix_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+module Neve
+
+  describe Mix do
+    let(:mix) { Mix.new(filename) }
+    let(:filename) { 'spec/support/my_awesome_tune' }
+
+    describe '.new' do
+      it 'takes a filename' do
+        expect(mix)
+      end
+    end
+
+    describe '#file' do
+      it 'returns the name of the yaml file' do
+        expect(mix.file).to eq 'spec/support/my_awesome_tune.yml'
+      end
+    end
+
+    describe '#command' do
+      let(:command) { double }
+      let(:configuration) { double }
+
+      it 'returns a command object' do
+        expect(mix).to receive(:configuration).and_return(configuration)
+        expect(ECASound::Mix).to receive(:new).
+          with('spec/support/my_awesome_tune', configuration).
+          and_return(command)
+        expect(mix.command).to eq command.to_s
+      end
+    end
+
+  end
+
+end

data/spec/lib/neve/runs_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+module Neve
+
+  class RunningExample
+    include Runs
+
+    def command
+      'ls'
+    end
+
+  end
+
+  describe '#run' do
+    let(:command) { 'ls' }
+    let(:output) { double }
+    let(:status) { double(:status, success?: success) }
+    let(:success) { true }
+
+    subject { RunningExample.new.run }
+
+    it 'runs the command with `capture2`' do
+      expect(Open3).to receive(:capture2).with(command).
+        and_return([output, status])
+
+      subject
+    end
+
+    context 'where the command is unsuccessful' do
+      let(:success) { false }
+
+      it 'fails with an error' do
+        expect(Open3).to receive(:capture2).with(command).
+          and_return([output, status])
+
+        expect { subject }.to raise_error Neve::Error
+      end
+    end
+
+  end
+end

data/spec/lib/neve_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'fileutils'
+
+module Neve
+
+  describe 'README example' do
+    let(:mix) { 'spec/support/mix.wav' }
+    let(:my_awesome_tune) { 'spec/support/my_awesome_tune.wav' }
+
+    before do
+      `./bin/neve mix spec/support/my_awesome_tune`
+    end
+
+    it 'bounces the mix' do
+      expect(FileUtils.compare_file(mix, my_awesome_tune)).to be_true
+    end
+
+    after do
+      FileUtils.remove(my_awesome_tune)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'neve'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

data/spec/support/my_awesome_tune.yml

@@ -0,0 +1,9 @@
+bass:
+  fader: 33
+  pan: 25
+drums:
+  fader: 33
+  pan: 50
+guitar:
+  fader: 33
+  pan: 75

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: neve
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - seenmyfate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-05-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,21 +52,56 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Command line mixing console
+- !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'
+description: Friendly audio mixing, right on your command line
 email:
 - seenmyfate@gmail.com
-executables: []
+executables:
+- neve
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/neve
 - lib/neve.rb
-- lib/neve/version.rb
+- lib/neve/cli.rb
+- lib/neve/eca_sound/mix.rb
+- lib/neve/eca_sound/track.rb
+- lib/neve/loads_yaml.rb
+- lib/neve/mix.rb
+- lib/neve/runs.rb
 - neve.gemspec
+- spec/lib/neve/cli_spec.rb
+- spec/lib/neve/eca_sound/mix_spec.rb
+- spec/lib/neve/eca_sound/track_spec.rb
+- spec/lib/neve/loads_yaml_spec.rb
+- spec/lib/neve/mix_spec.rb
+- spec/lib/neve/runs_spec.rb
+- spec/lib/neve_spec.rb
+- spec/spec_helper.rb
+- spec/support/mix.wav
+- spec/support/my_awesome_tune.yml
+- spec/support/my_awesome_tune/bass.wav
+- spec/support/my_awesome_tune/drums.wav
+- spec/support/my_awesome_tune/guitar.wav
 homepage: https://github.com/seenmyfate/neve
 licenses:
 - MIT
@@ -76,5 +125,18 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Command line mixing console
-test_files: []
+summary: Friendly audio mixing, right on your command line
+test_files:
+- spec/lib/neve/cli_spec.rb
+- spec/lib/neve/eca_sound/mix_spec.rb
+- spec/lib/neve/eca_sound/track_spec.rb
+- spec/lib/neve/loads_yaml_spec.rb
+- spec/lib/neve/mix_spec.rb
+- spec/lib/neve/runs_spec.rb
+- spec/lib/neve_spec.rb
+- spec/spec_helper.rb
+- spec/support/mix.wav
+- spec/support/my_awesome_tune.yml
+- spec/support/my_awesome_tune/bass.wav
+- spec/support/my_awesome_tune/drums.wav
+- spec/support/my_awesome_tune/guitar.wav

data/lib/neve/version.rb

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