music-transcription 0.3.0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.rdoc
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,7 @@
+Gemfile.lock
+doc/
+pkg/
+vendor/cache/*.gem
+.yardoc
+*~
+.project

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.yardopts

@@ -0,0 +1 @@
+--markup rdoc --title "music-transcription Documentation" --protected

data/ChangeLog.rdoc

@@ -0,0 +1,4 @@
+=== 0.3.0 / 2013-08-07
+
+* Tear off music transcription-related code from musicality gem, into a separate gem called music-transcription.
+

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 James Tunnell
+
+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.rdoc

@@ -0,0 +1,28 @@
+= music-transcription
+
+* {Homepage}[https://github.com/jamestunnell/music-transcription]
+* {Issues}[https://github.com/jamestunnell/music-transcription/issues]
+* {Documentation}[http://rubydoc.info/gems/music-transcription/frames]
+* {Email}[mailto:jamestunnell@lavabit.com]
+
+== Description
+
+Classes for representing music features, like pitch, note, dynamic, tempo, etc.
+
+== Features
+
+== Examples
+
+  require 'music-transcription'
+
+== Requirements
+
+== Install
+
+  $ gem install music-transcription
+
+== Copyright
+
+Copyright (c) 2012 James Tunnell
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec
+
+require "bundler/gem_tasks"
+
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard
+
+task :make_samples do
+  current_dir = Dir.getwd
+  samples_dir = File.join(File.dirname(__FILE__), 'samples')
+  Dir.chdir samples_dir
+  
+  samples = []
+  Dir.glob('**/make*.rb') do |file|
+    samples.push File.expand_path(file)
+  end
+  
+  samples.each do |sample|
+    dirname = File.dirname(sample)
+    filename = File.basename(sample)
+    
+    Dir.chdir dirname
+    ruby filename
+  end
+
+  Dir.chdir current_dir
+end

data/bin/transcribe

@@ -0,0 +1,176 @@
+#!/usr/bin/env ruby
+
+require 'micro-optparse'
+require 'pry'
+require 'spcore'
+require 'wavefile'
+require 'music-transcription'
+require 'yaml'
+
+include Music::Transcription
+
+options = Parser.new do |p|
+  p.banner = <<-END
+Transcribe notes from an audio file.
+
+Usage:
+      transcribe [options] <audio_file>
+
+Notes:
+  Output directory must already exist.
+  FFT actual_size must be a power of two.
+  Delta (sec) must be > 0.
+  Threshold must be >= 0.
+  
+Options:
+END
+  p.version = "0.1"
+  p.option :outdir, "set output directory", :default => "./", :value_satisfies => lambda { |path| Dir.exist? path }
+  p.option :freq_res, "set min frequency (Hz) resolution in Hz", :default => 1.0, :value_satisfies => lambda { |mfr| mfr > 0 }
+  p.option :time_res, "set time (sec) between FFT samples", :default => 0.01, :value_satisfies => lambda { |dt| dt > 0 }
+  p.option :threshold, "set theshold (minimum signal energy to run FFT)", :default => 0.5, :value_satisfies => lambda { |t| t >= 0 }
+  p.option :min_freq, "set minimum frequency to consider during harmonic series analysis.", :default => PITCHES.first.freq, :value_satisfies => lambda { |f| f > 0 }
+  p.option :verbose, "is verbose?", :default => false
+end.process!
+
+outdir = File.expand_path(options[:outdir])
+freq_res = options[:freq_res]
+time_res = options[:time_res]
+threshold = options[:threshold]
+verbose = options[:verbose]
+min_freq = options[:min_freq]
+
+TIME_RESOLUTION = time_res
+THRESHOLD = threshold
+FREQ_RESOLUTION = freq_res
+
+def force_power_of_two size
+  power_of_two = Math::log2(size)
+  if power_of_two.floor != power_of_two # input size is not an even power of two
+    size = 2**(power_of_two.to_i() + 1)
+  end
+  return size
+end
+
+ARGV.each do |filename|
+
+  if !File.exist?(filename)
+    puts "Could not find file #{filename}, skipping."
+    next
+  end
+
+  if verbose
+    puts
+  end
+
+  outfile = File.basename(filename, ".*") + ".yml"
+  outpath = File.join(outdir, outfile)
+
+  notes = []
+  
+  WaveFile::Reader.new(filename) do |reader|
+    print "Transcribing #{File.basename(filename)} -> #{outfile}   0.0%"
+    
+    if reader.format.channels == 1
+      samples = reader.read(reader.total_sample_frames).samples
+    else
+      puts "Multi-channel audo files not supported yet. Skipping."
+      # TODO handl multi-channel audio
+      break
+    end
+    signal = SPCore::Signal.new(:data => samples, :sample_rate => reader.format.sample_rate)  
+    
+    ideal_size = (TIME_RESOLUTION * signal.sample_rate).to_i
+    fft_size = reader.format.sample_rate / FREQ_RESOLUTION
+    fft_size = force_power_of_two fft_size
+    
+    # more samples are in the chunk than needed by the FFT. Make the FFT size
+    # greater or equal to chunk size.
+    if ideal_size > fft_size
+      fft_size = force_power_of_two ideal_size
+    end
+    
+    i = 0      
+    while(i < signal.size)
+      print "\b" * 6
+      print "%5.1f%%" % (100 * i / signal.size)
+      
+      actual_size = ideal_size
+      if (actual_size + i) > signal.size
+        actual_size = signal.size - i
+      end
+      t = i / signal.sample_rate.to_f
+      puts t if verbose
+      
+      chunk = signal.subset i...(i + actual_size)
+      duration_sec = actual_size / signal.sample_rate.to_f
+      
+      if chunk.energy > THRESHOLD
+        
+        
+        window = SPCore::BlackmanWindow.new(chunk.size)
+        chunk.multiply! window.data
+
+        remaining_before = (fft_size - chunk.size) / 2
+        remaining_after = fft_size - chunk.size - remaining_before
+        
+        if remaining_before > 0
+          chunk.prepend! Array.new(remaining_before, 0)
+        end
+        
+        if remaining_after > 0
+          chunk.append! Array.new(remaining_after, 0)
+        end
+
+        series = chunk.harmonic_series(:min_freq => min_freq)
+        intervals = []
+        if series.nil?
+        if series.any?
+          fundamental = series.min
+          pitch = Pitch.make_from_freq fundamental
+          intervals.push Interval.new(:pitch => pitch)
+        end
+        notes.push Note.new(:duration => duration_sec, :intervals => intervals)
+      else
+        notes.push Note.new(:duration => duration_sec, :intervals => [])
+      end
+      
+      i += ideal_size
+    end
+  end
+  
+  new_notes = []
+  
+  # simplify the part
+  notes.each_index do |i|
+    note = notes[i]
+    
+    if new_notes.any?
+      prev_note = new_notes.last
+      
+      if prev_note.intervals.any? and note.intervals.any?
+        if prev_note.intervals == note.intervals
+          prev_note.duration += note.duration
+        else
+          prev_note.intervals.first.link = slur(note.intervals.first.pitch)
+          new_notes.push note
+        end
+      elsif prev_note.intervals.empty? and note.intervals.empty?
+        prev_note.duration += note.duration
+      else
+        new_notes.push note
+      end
+    else
+      new_notes.push note
+    end
+  end
+  
+  part = Part.new(:notes => new_notes)
+  yaml = part.make_hash.to_yaml
+  
+  File.open(outpath, 'w') do |file|
+    file.write yaml
+  end
+  
+  puts
+end

data/lib/music-transcription.rb

@@ -0,0 +1,20 @@
+require 'hashmake'
+
+# basic core classes
+require 'music-transcription/version'
+
+# code for transcribing (representing) music
+require 'music-transcription/pitch'
+require 'music-transcription/pitch_constants'
+require 'music-transcription/link'
+require 'music-transcription/interval'
+require 'music-transcription/note'
+require 'music-transcription/transition'
+require 'music-transcription/value_change'
+require 'music-transcription/profile'
+require 'music-transcription/part'
+require 'music-transcription/program'
+require 'music-transcription/tempo'
+require 'music-transcription/score'
+require 'music-transcription/instrument_config'
+require 'music-transcription/arrangement'

data/lib/music-transcription/arrangement.rb

@@ -0,0 +1,31 @@
+module Music
+module Transcription
+
+# Contains a Score object, and also instrument configurations to be assigned to
+# score parts.
+class Arrangement
+  include Hashmake::HashMakeable
+  
+  # specifies which hashed args can be used for initialize.
+  ARG_SPECS = {
+    :score => arg_spec(:reqd => true, :type => Score),
+    :instrument_configs => arg_spec_hash(:reqd => false, :type => InstrumentConfig),
+  }
+
+  attr_reader :score, :instrument_configs
+  
+  def initialize args
+    hash_make args, Arrangement::ARG_SPECS
+  end
+  
+  # Assign a new score.
+  # @param [Score] score The new score.
+  # @raise [ArgumentError] if score is not a Score.
+  def score= score
+    Arrangement::ARG_SPECS[:score].validate_value score
+    @score = score
+  end
+end
+
+end
+end

data/lib/music-transcription/instrument_config.rb

@@ -0,0 +1,38 @@
+module Music
+module Transcription
+
+# Contains all the information needed to create the instrument plugin, configure
+# initial settings, and any settings changes.
+#
+# @author James Tunnell
+class InstrumentConfig
+  include Hashmake::HashMakeable
+
+  attr_reader :plugin_name, :initial_settings, :setting_changes
+
+  # hashed-arg specs (for hash-makeable idiom)
+  ARG_SPECS = {
+    :plugin_name => arg_spec(:reqd => true, :type => String),
+    :initial_settings => arg_spec(:reqd => false, :default => ->(){ {} }, :validator => ->(a){ a.is_a?(String) || a.is_a?(Array) || a.is_a?(Hash)} ),
+    :setting_changes => arg_spec_hash(:reqd => false, :type => Hash)
+  }
+  
+  # A new instance of InstrumentConfig.
+  # @param [Hash] args Hashed arguments. Required key is :plugin_name (String).
+  #                    Optional key is :initial_settings and setting_changes.
+  def initialize args={}
+    hash_make args, InstrumentConfig::ARG_SPECS
+    
+    @setting_changes.each do |offset, hash|
+      hash.each do |key, val|
+        # replace plain values with immediate value changes
+        unless val.is_a?(ValueChange)
+          hash[keys] = immediate_change(val)
+        end
+      end
+    end
+  end
+end
+
+end
+end

data/lib/music-transcription/interval.rb

@@ -0,0 +1,66 @@
+module Music
+module Transcription
+
+# Describes a pitch (for one note) that can be linked to a pitch in another note.
+#
+# @author James Tunnell
+#
+# @!attribute [rw] pitch
+#   @return [Pitch] The pitch of the note.
+#
+# @!attribute [rw] link
+#   @return [Link] Shows how the current note is related to a following note.
+#
+class Interval
+  include Hashmake::HashMakeable
+  attr_reader :pitch, :link
+  
+  # hashed-arg specs (for hash-makeable idiom)
+  ARG_SPECS = {
+    :pitch => arg_spec(:type => Pitch, :reqd => true),
+    :link => arg_spec(:type => Link, :reqd => false, :default => ->(){ Link.new } ),
+  }
+  
+  def initialize args
+    hash_make args
+  end
+  
+  # Return true if the @link relationship is not NONE.
+  def linked?
+    @link.relationship != Link::RELATIONSHIP_NONE
+  end
+
+  # Compare the equality of another Interval object.
+  def == other
+    return (@pitch == other.pitch) && (@link == other.link)
+  end
+  
+  # Set the note pitch.
+  # @param [Pitch] pitch The pitch to use.
+  # @raise [ArgumentError] if pitch is not a Pitch.
+  def pitch= pitch
+    ARG_SPECS[:pitch].validate_value pitch
+    @pitch = pitch
+  end
+
+  # Setup the relationship to a following note.
+  # @param [Link] link The Link object to assign.
+  def link= link
+    ARG_SPECS[:link].validate_value link
+    @link = link
+  end
+
+  # Produce an identical Note object.
+  def clone
+    Interval.new(:pitch => @pitch, :link => @link.clone)
+  end
+end
+
+module_function
+
+def interval pitch, link = Link.new
+  Interval.new(:pitch => pitch, :link => link)
+end
+
+end
+end