mtk 0.0.3.2 → 0.0.3.3

data/.yardopts

@@ -4,7 +4,7 @@
 --protected
 --no-private
 lib/**/*.rb
-- *.md
-- examples/*
+- INTRO.md
 - lib/**/*.citrus
 - LICENSE.txt
+- examples/**/*.rb

data/DEVELOPMENT_NOTES.md

@@ -113,3 +113,23 @@ or, to automatically refresh the documentation as you work:
 
      bundle exec yard server -r
      open http://localhost:8808
+
+
+### Release the gems ###
+
+To better handle the differing depdencies between CRuby and JRuby, there are two gems, mtk and jmtk.
+You can build both gems with:
+
+     bundle exec gem:build
+
+Do a local sanity check by installing
+
+     # Using CRuby 1.9 or 2.0:
+     gem install mtk-0.x.x.gem
+     ... test mtk command ...
+
+     rvm use jruby
+     jgem install jmtk-0.x.x-java.gem
+     ... test jmtk command ...
+
+And then authorized users can push gems to rubygems.org.

data/README.md

@@ -19,20 +19,26 @@ Features
 Getting Started
 ---------------
 
-MTK works with Ruby 1.9, Ruby 2.0, and JRuby
+MTK works with Ruby 1.9, Ruby 2.0, and JRuby 1.7+.
+
+JRuby is recommended for Windows users.
 
 0. Install
 
         gem install mtk
 
-    or if using JRuby:
+    Or for JRuby:
 
-        jgem install mtk
+        jgem install jmtk
 
 0. Learn the command-line interface:
 
         mtk --help
 
+    Or for JRuby:
+
+        jmtk --help
+
 0. Learn the MTK syntax: TODO... documentation forthcoming. In the meantime, see the unit tests @ https://github.com/adamjmurray/mtk/blob/master/spec/mtk/lang/parser_spec.rb
 
 0. Check out examples: https://github.com/adamjmurray/mtk/tree/master/examples

data/Rakefile

@@ -1,12 +1,14 @@
 require 'rspec/core/rake_task'
 require 'rake/clean'
 
+GEM_VERSION = '0.0.3.3'
+
 SUPPORTED_RUBIES = %w[ 1.9.3  2.0  jruby-1.7.4 ]
-ENV['JRUBY_OPTS'] = '--1.9'
+
+CLEAN.include('html','doc','coverage.data','coverage', '*.gemspec', '*.gem') # clean and clobber do the same thing for now
 
 task :default => :test
 
-CLEAN.include('html','doc','coverage.data','coverage', '*.gem') # clean and clobber do the same thing for now
 
 desc "Run RSpec tests with full output"
 RSpec::Core::RakeTask.new('test') do |spec|
@@ -16,17 +18,7 @@ RSpec::Core::RakeTask.new('test') do |spec|
     spec.pattern = "spec/**/#{ARGV[1]}*"
   end
 end
-
-task :spec => :test
-
-
-namespace :gem do
-  desc "Install gems for supported versions of Ruby: #{SUPPORTED_RUBIES.join ', '}"
-  task :install_dependencies do
-    fail unless system("rvm #{SUPPORTED_RUBIES.join ','} do bundle install")
-  end
-end
-
+task :spec => :test  # alias test task as spec task
 
 namespace :test do
   desc "Run RSpec tests with summary output and fast failure"
@@ -64,3 +56,45 @@ begin
   end
 rescue Exception # yard is optional, so don't cause rake to fail if it's missing
 end
+
+
+namespace :gem do
+  desc "Install gems for supported versions of Ruby: #{SUPPORTED_RUBIES.join ', '}"
+  task :install_dependencies do
+    fail unless system("rvm #{SUPPORTED_RUBIES.join ','} do bundle install")
+  end
+
+  desc "Build the CRuby and JRuby gems for distribution"
+  task :build do
+    gem_version = GEM_VERSION
+
+    gem_name = 'mtk'
+    platform_specific_depedencies = {unimidi:'~> 0.3'}
+    additional_gem_specifications = {}
+    generate_gemspec(binding)
+
+    gem_name = 'jmtk'
+    platform_specific_depedencies = {jsound:'~> 0.1'}
+    additional_gem_specifications = {platform:'java'}
+    generate_gemspec(binding)
+  end
+
+  def generate_gemspec(erb_bindings)
+    gem_name = erb_bindings.eval('gem_name')
+
+    erb = ERB.new(IO.read 'mtk.gemspec.erb')
+    gemspec = erb.result(erb_bindings)
+
+    gemspec_filename = "#{gem_name}.gemspec"
+    puts "Generating #{gemspec_filename}"
+    IO.write(gemspec_filename, gemspec)
+
+    if gem_name == 'jmtk'
+      `cp bin/mtk bin/jmtk` # jmtk gem uses this as the binary
+    end
+    puts "Building gem"
+    puts `gem build #{gemspec_filename}`
+  ensure
+    `rm bin/jmtk`
+  end
+end

data/bin/mtk

@@ -23,13 +23,12 @@ option_parser = OptionParser.new do |opts|
 
   opts.on('-e [syntax]', '--eval [syntax]', 'Convert the given MTK syntax String to MIDI',
           'or start an interactive interpreter when [syntax] is omitted',
-          'if a --file is given, write the MIDI to a file',
-          'if an --output is given, play the MIDI',
-          'otherwise print the MIDI') {|syntax| options[:eval] = syntax }
+          'Behaves like --convert when a --file or --output is given') {|syntax| options[:eval] = syntax }
 
   opts.separator ''
 
-  opts.on('-f FILE', '--file FILE', 'Write the output of --convert, --eval, or --input to a file') {|file| options[:file] = file }
+  opts.on('-f FILE', '--file FILE', 'Write the output of --convert, --eval, --input, or --watch to a file'
+         ) {|file| options[:file] = file }
 
   opts.separator ''
 
@@ -63,6 +62,9 @@ option_parser = OptionParser.new do |opts|
   #
   #opts.separator ''
 
+  opts.on('-w FILE', '--watch FILE', 'Watch an MTK syntax file for changes and automatically convert to MIDI',
+          'Behaves like --convert when a --file or --output is given') {|file| options[:watch] = file }
+
 end
 
 
@@ -79,7 +81,7 @@ ERROR_INPUT_NOT_FOUND  = 4
 
 # Immediately trying to play output while Ruby is still "warming up" can cause timing issues with
 # the first couple notes. So we play this "empty" Timeline containing a rest to address that issue.
-WARMUP = MTK::Timeline.from_hash( {0 => MTK::Events::Note.new(MTK::Pitch(60), MTK::Duration(-1))} )
+WARMUP = MTK::Events::Timeline.from_h( {0 => MTK.Note(60,-1)} )
 
 #######################################################################
 
@@ -88,20 +90,25 @@ begin
 rescue OptionParser::MissingArgument, OptionParser::InvalidOption
   puts "Invalid command, #{$!}"
   puts "For command line help: #{$0} --help"
+  puts "For command line help: #{$0} --help"
   exit ERROR_INVALID_COMMAND
 end
 
 
 def setup_io
-  require 'mtk/midi/input'
-  require 'mtk/midi/output'
+  require 'mtk/io/midi_input'
+  require 'mtk/io/midi_output'
 end
 
 
 def convert(mtk_syntax)
   sequencer = MTK::Lang::Parser.parse(mtk_syntax)
-  timeline = sequencer.to_timeline
-  output(timeline)
+  if sequencer
+    timeline = sequencer.to_timeline
+    output(timeline)
+  end
+rescue Citrus::ParseError
+  STDERR.puts $!
 end
 
 
@@ -111,8 +118,8 @@ def output(timelines, print_header='Timeline')
     @output.play WARMUP
     @output.play timelines.first # TODO: support multiple timelines
   elsif @file
-    require 'mtk/midi/file'
-    MTK::MIDI_File(@file).write timelines
+    require 'mtk/io/midi_file'
+    MTK.MIDIFile(@file).write timelines
   else
     puts print_header, timelines
     puts
@@ -136,12 +143,20 @@ def record
 end
 
 
+def watch_file_updated?
+  mtime = File.stat(@watch_file).mtime
+  updated = @watch_file_mtime.nil? || @watch_file_mtime < mtime
+  @watch_file_mtime = mtime
+  updated
+end
+
+
 #######################################################################
 
 if options[:list]
   setup_io
-  input_names  = MTK::MIDI::Input.devices_by_name.keys
-  output_names = MTK::MIDI::Output.devices_by_name.keys
+  input_names  = MTK::IO::MIDIInput.devices_by_name.keys
+  output_names = MTK::IO::MIDIOutput.devices_by_name.keys
   puts
   puts (['INPUTS:'] + input_names).join("\n * ")
   puts
@@ -158,7 +173,7 @@ end
 if options[:input]
   setup_io
   input_name = options[:input]
-  @input = MTK::MIDI::Input.find_by_name /#{input_name}/
+  @input = MTK::IO::MIDIInput.find_by_name /#{input_name}/
   if @input
     puts "Using input '#{@input.name}'"
   else
@@ -170,7 +185,7 @@ end
 if options[:output]
   setup_io
   output_name = options[:output]
-  @output = MTK::MIDI::Output.find_by_name /#{output_name}/
+  @output = MTK::IO::MIDIOutput.find_by_name /#{output_name}/
   if @output
     puts "Using output '#{@output.name}'"
   else
@@ -184,8 +199,8 @@ file = options[:file]
 
 if options[:play]
   filename = options[:play]
-  require 'mtk/midi/file'
-  timelines = MTK::MIDI_File(filename).to_timelines
+  require 'mtk/io/midi_file'
+  timelines = MTK.MIDIFile(filename).to_timelines
   output(timelines, "Timeline for #{filename}")
 end
 
@@ -193,9 +208,13 @@ if options.has_key? :eval
   mtk_syntax = options[:eval]
   if mtk_syntax.nil?
     puts "Starting the interactive interpreter."
-    loop do
-      puts "Enter MTK syntax. Press Ctrl+C to exit."
-      convert(gets)
+    begin
+      loop do
+        puts "Enter MTK syntax. Press Ctrl+C to exit."
+        convert(gets)
+      end
+    rescue SystemExit,Interrupt
+      Kernel.exit
     end
   else
     convert(mtk_syntax)
@@ -208,6 +227,22 @@ if options[:convert]
   convert(mtk_syntax)
 end
 
+if options[:watch]
+  @watch_file = options[:watch]
+  puts "Watching #{@watch_file}. Press Ctrl+C to exit."
+  watch_file_updated? # prime the watcher
+  begin
+    loop do
+      mtk_syntax = IO.read(@watch_file)
+      convert(mtk_syntax)
+      Kernel.sleep(0.5) until watch_file_updated?
+      puts "#{Time.new}: #{@watch_file} updated"
+    end
+  rescue SystemExit,Interrupt
+    Kernel.exit
+  end
+end
+
 #if options.has_key? :tutorial
 #  puts "TODO: tutorial"
 #end

data/examples/crescendo.rb

@@ -3,10 +3,10 @@
 # NOTE: this blindly overwrites any existing MTK-crescendo.mid file, unless an argument is provided
 
 require 'mtk'
-require 'mtk/midi/file'
+require 'mtk/io/midi_file'
 include MTK
-include Constants::Pitches
-include Constants::Intensities
+include Lang::Pitches
+include Lang::Intensities
 
 file = ARGV[0] || 'MTK-crescendo.mid'
 
@@ -16,5 +16,5 @@ crescendo = Patterns.Lines pp, [fff, scale.length-1] # step from pp to fff over
 sequencer = Sequencers.StepSequencer scale, crescendo
 timeline = sequencer.to_timeline
 
-MIDI_File(file).write timeline
+MIDIFile(file).write timeline
 

data/examples/{drum_pattern1.rb → drum_pattern.rb}

@@ -1,8 +1,8 @@
 require 'mtk'
-require 'mtk/midi/file'
+require 'mtk/io/midi_file'
 include MTK
-include Constants::Pitches
-include Constants::Intensities
+include Lang::Pitches
+include Lang::Intensities
 
 file = ARGV[0] || "MTK-#{File.basename(__FILE__,'.rb')}.mid"
 
@@ -10,14 +10,14 @@ _ = nil # defines _ as a rest
 
 pattern = {# 0   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15
   C2  =>  [fff,  _,  _,  _, mf,  _,  _,  _,  o,  _,  _,  _, mp,  _,  _,  _], # kick
-  Db2 =>  [  _,  _,  o,  _,  _,  _, mp,  _,  _,  _,  o,  _,  _,  _, mf,  _], # snare
-  D2  =>  [  _, mp,  _, mp,  _, mp,  _, mf,  _, mp,  _, mp,  _, pp,  _, mf]  # hat
+  Db2 =>  [  _,  _,  o,  _,  _,  _, mp,  _,  _,  _,  o,  _,  _,  _, mf,  _], # rim shot
+  D2  =>  [  _, mp,  _, mp,  _, mp,  _, mf,  _, mp,  _, mp,  _, pp,  _, mf]  # snare
 }
 
-timeline = Timeline.new
+timeline = Events::Timeline.new
 for pitch,intensities in pattern
-  track = Sequencers::StepSequencer( Patterns.Sequence(intensities), default_pitch: pitch )
+  track = Sequencers::StepSequencer( Patterns.Sequence(intensities), default_pitch:pitch, channel:10 )
   timeline.merge track.to_timeline
 end
 
-MIDI_File(file).write timeline
+MIDIFile(file).write timeline

data/examples/dynamic_pattern.rb

@@ -3,11 +3,11 @@
 # NOTE: this blindly overwrites any existing MTK-dynamic_pattern.mid file, unless an argument is provided
 
 require 'mtk'
-require 'mtk/midi/file'
+require 'mtk/io/midi_file'
 include MTK
-include MTK::Constants::Pitches
-include MTK::Constants::Intensities
-include MTK::Constants::Intervals
+include MTK::Lang::Pitches
+include MTK::Lang::Intensities
+include MTK::Lang::Intervals
 
 file = ARGV[0] || "MTK-#{File.basename __FILE__,'.rb'}.mid"
 
@@ -33,4 +33,4 @@ intensities = Patterns.Choice( mp,mf,o,ff,fff, weights: [1,2,3,2,1], max_cycles:
 
 sequencer = Sequencers.StepSequencer( pitches,intensities, step_size: 0.5, max_interval: 17 )
 
-MIDI_File(file).write( sequencer.to_timeline )
+MIDIFile(file).write( sequencer.to_timeline )

data/examples/gets_and_play.rb

@@ -1,10 +1,11 @@
 # Enter space-separated pitch classes (A,B,C,D,E,F,G) at the prompt and hear them play.
 
 require 'mtk'
-require 'mtk/helpers/output_selector'
+require_relative 'helpers/output_selector'
 include MTK
+include MTK::Core
 
-output = Helpers::OutputSelector.ensure_output ARGV[0]
+output = OutputSelector.ensure_output ARGV[0]
 
 def get_pitch_classes
   puts "Enter pitch classes:"

data/examples/notation.rb

@@ -1,5 +1,5 @@
 require 'mtk'
-require 'mtk/helpers/lilypond'
+require 'mtk/io/notation'
 include MTK
 
 def arg_error(error)
@@ -18,5 +18,5 @@ arg_error "The output_file must end in '.png', '.pdf', or '.ps'" unless file
 
 sequencer = MTK::Lang::Parser.parse(syntax)
 timeline = sequencer.to_timeline
-# Helpers::Lilypond.open(file).write(timeline)
-Helpers::Lilypond.open(file, dpi:300).write(timeline) # higher resolution PNG
+# MTK::IO::Notation.open(file).write(timeline)
+MTK::IO::Notation.open(file, dpi:300).write(timeline) # higher resolution PNG

data/examples/play_midi.rb

@@ -7,11 +7,11 @@ unless file
 end
 
 require 'mtk'
-require 'mtk/midi/file'
-require 'mtk/helpers/output_selector'
+require 'mtk/io/midi_file'
+require_relative 'helpers/output_selector'
 
-output = MTK::Helpers::OutputSelector.ensure_output(output_name)
+output = OutputSelector.ensure_output(output_name)
 
-timeline = MTK.MIDI_File(file).to_timelines
+timeline = MTK.MIDIFile(file).to_timelines
 
 output.play(timeline)

data/examples/print_midi.rb

@@ -7,7 +7,7 @@ unless file
 end
 
 require 'mtk'
-require 'mtk/midi/file'
+require 'mtk/io/midi_file'
 include MTK
 
-puts MIDI_File(file).to_timelines
+puts MIDIFile(file).to_timelines

data/examples/random_tone_row.rb

@@ -3,16 +3,16 @@
 # NOTE: this blindly overwrites any existing MTK-random_tone_row.mid file, unless an argument is provided
 
 require 'mtk'
-require 'mtk/midi/file'
+require 'mtk/io/midi_file'
 include MTK
 
 file = ARGV[0] || 'MTK-random_tone_row.mid'
 
-row = PitchClassSet.random_row
+row = Groups::PitchClassSet.random_row
 sequence = Patterns.Sequence *row
 
 sequencer = Sequencers.StepSequencer sequence
 timeline = sequencer.to_timeline
 
-MIDI_File(file).write timeline
+MIDIFile(file).write timeline
 

data/examples/syntax_to_midi.rb

@@ -3,7 +3,7 @@
 # NOTE: this blindly overwrites any existing MTK-syntax_to_midi.mid file, unless a second argument is provided
 
 require 'mtk'
-require 'mtk/midi/file'
+require 'mtk/io/midi_file'
 
 input = ARGV[0]
 if input.nil?
@@ -24,5 +24,5 @@ syntax = IO.read(input)
 sequencer = MTK::Lang::Parser.parse(syntax)
 timeline = sequencer.to_timeline
 
-MTK::MIDI_File(output).write timeline
+MTK::MIDIFile(output).write timeline
 

data/examples/test_output.rb

@@ -1,8 +1,7 @@
 require 'mtk'
-require 'mtk/helpers/output_selector'
-include MTK
-include Constants::Pitches
+require_relative 'helpers/output_selector'
+include MTK::Lang::Pitches
 
-output = Helpers::OutputSelector.ensure_output ARGV[0]
+output = OutputSelector.ensure_output ARGV[0]
 
-output.play Note(C4,1,2)
+output.play MTK.Note(C4,2,1)

data/examples/tone_row_melody.rb

@@ -3,10 +3,10 @@
 # NOTE: this blindly overwrites any existing MTK-tone_row_melody.mid file, unless an argument is provided
 
 require 'mtk'
-require 'mtk/midi/file'
+require 'mtk/io/midi_file'
 include MTK
-include MTK::Constants::PitchClasses
-include MTK::Constants::Durations
+include MTK::Lang::PitchClasses
+include MTK::Lang::Durations
 
 file = ARGV[0] || 'MTK-tone_row_melody.mid'
 
@@ -14,8 +14,10 @@ row = PitchClassSet Db, G, Ab, F, Eb, E, D, C, B, Gb, A, Bb
 pitch_pattern = Patterns.Cycle *row
 rhythm_pattern = Patterns.Choice s, i, i+s, q # choose between sixteenth, eighth, dotted eighth, and quarter
 
-sequencer = Sequencers.LegatoSequencer pitch_pattern, rhythm_pattern, max_steps: 36
+chain = Patterns.Chain pitch_pattern, rhythm_pattern, min_elements: 36, max_elements: 36
+
+sequencer = Sequencers.LegatoSequencer chain
 timeline = sequencer.to_timeline
 
-MIDI_File(file).write timeline
+MIDIFile(file).write timeline