mtk 0.0.3.3 → 0.4

data/lib/mtk/io/midi_input.rb

@@ -80,7 +80,7 @@ module MTK
       end
 
       def to_timeline
-        Timeline.new
+        MTK::Events::Timeline.new
       end
 
     end

data/lib/mtk/io/midi_output.rb

@@ -105,8 +105,12 @@ module MTK
                 pitch = event.midi_pitch
                 velocity = event.velocity
                 duration = event.duration.to_f
-                @scheduler.at(time) { note_on(pitch,velocity,channel) }
-                @scheduler.at(time + duration) { note_off(pitch,velocity,channel) }
+                # Set a lower priority (via level:1) for note-ons, so legato notes at the same pitch don't
+                # prematurely chop off the next note, by ensuring all note-offs at the same timepoint occur first.
+                @scheduler.at(time, level: 1) { note_on(pitch,velocity,channel) }
+                @scheduler.at(time + duration) { note_on(pitch,0,channel) }
+                # TODO: use a proper note off message whenever we support off velocities
+                #@scheduler.at(time + duration) { note_off(pitch,velocity,channel) }
 
               when :control
                 @scheduler.at(time) { control(event.number, event.midi_value, channel) }
@@ -127,7 +131,10 @@ module MTK
           end
         end
 
-        end_time = timeline.times.last + trailing_buffer
+        end_time = timeline.times.last
+        final_events = timeline[end_time]
+        max_length = final_events.inject(0) {|max,event| len = event.length; max > len ? max : len } || 0
+        end_time += max_length + trailing_buffer
         @scheduler.at(end_time) { @scheduler.stop }
 
         thread = @scheduler.run
@@ -192,4 +199,88 @@ unless $__RUNNING_RSPEC_TESTS__ # I can't get this working on Travis-CI, problem
   else
     require 'mtk/io/unimidi_output'
   end
-end
+end
+
+
+
+####################################################################################
+# MONKEY PATCHING gamelan to ensure note-offs come before note-ons
+# when they occur at the same scheduler time.
+# This patch applies https://github.com/jvoorhis/gamelan/commit/20d93f4e5d86517bd5c6f9212a0dcdbf371d1ea1
+# to provide the priority/level feature for the scheduler (see @scheduler.at() calls for notes above).
+# This patch should not be necessary when gamelan gem > 0.3 is released
+
+# @private
+module Gamelan
+
+  DEFAULT_PRIORITY = 0
+  NOTEON_PRIORITY  = 0
+  CC_PRIORITY      = -1
+  PC_PRIORITY      = -2
+  NOTEOFF_PRIORITY = -3
+
+  class Priority < Struct.new(:time, :level)
+    include Comparable
+    def <=>(prio)
+      self.to_a <=> prio.to_a
+    end
+  end
+
+  if defined?(JRUBY_VERSION)
+
+    class Queue
+      def initialize(scheduler)
+        @scheduler = scheduler
+        @queue     = PriorityQueue.new(10000) { |a,b|
+          a.priority <=> b.priority
+        }
+      end
+
+      def ready?
+        if top = @queue.peek
+          top.delay < @scheduler.phase
+        else
+          false
+        end
+      end
+    end
+
+  else
+
+    class Queue
+      def push(task)
+        @queue.push(task, task.priority)
+      end
+      alias << push
+
+      def ready?
+        if top = @queue.min
+          top[1].time < @scheduler.phase
+        else
+          false
+        end
+      end
+    end
+
+  end
+
+  class Scheduler < Timer
+    def at(delay, options = {}, &task)
+      options = { :delay => delay, :scheduler => self }.merge(options)
+      @queue << Task.new(options, &task)
+    end
+  end
+
+  class Task
+    attr_reader :level, :priority
+
+    def initialize(options, &block)
+      @scheduler = options[:scheduler]
+      @delay     = options[:delay].to_f
+      @level     = options[:level] || DEFAULT_PRIORITY
+      @priority  = Priority.new(@delay, @level)
+      @proc      = block
+      @args      = options[:args] || []
+    end
+  end
+end

data/lib/mtk/io/unimidi_input.rb

@@ -59,7 +59,7 @@ module MTK
 
         bpm = options.fetch :bmp, 120
         beats_per_second = bpm.to_f/60
-        timeline = Timeline.new
+        timeline = MTK::Events::Timeline.new
         note_ons = {}
         start = nil
 
@@ -69,9 +69,13 @@ module MTK
           time /= beats_per_second
 
           if message.is_a? MTK::Events::Event
-            timeline.add time,message
+            timeline.add time,message unless message.type == :unknown
           else
-            case message.type
+            message_type = message.type
+            message_type = :note_off if message_type == :note_on and message.velocity == 0
+            # TODO: this will need to be made more robust when we support off velocities
+
+            case message_type
             when :note_on
               pitch = message.pitch
               note_ons[pitch] = [message,time]

data/lib/mtk/lang/durations.rb

@@ -5,51 +5,56 @@ module MTK
 
     # Defines duration constants using abbreviations for standard rhythm values ('w' for whole note, 'h' for half note, etc).
     #
-    # In order to avoid conflict with pitch class 'e', the constant for eighth note is 'i'
+    # These can be thought of like constants, but in order to support the lower case names,
+    # it was necessary to define them as "pseudo constant" methods.
+    # Like constants, these methods are available either through the module (MTK::Lang::Durations::q) or
+    # via mixin (include MTK::Lang::Durations; q). They are listed under the "Instance Attribute Summary" of this page.
     #
-    # These can be thought of like constants, but they
-    # use lower-case names and therefore define them as "pseudo constant" methods.
-    # The methods are available either through the module (MTK::Core::Durations::e) or via mixin (include MTK::Core::Durations; q)
-    #
-    # These values assume the quarter note is one beat (1.0), so they work best with 4/4 and other */4 time signatures.
+    # These values assume the quarter note is one beat, so you may find they work best with 4/4 and other */4 time signatures
+    # (although it's certainly possible to use them with less common time signatures like 5/8).
     #
     # @note Including this module defines a bunch of single-character variables, which may shadow existing variable names.
     #       Just be mindful of what is defined in this module when including it.
     #
-    # @see Note
+    # @see Core::Duration
+    # @see Events::Note
     module Durations
       extend MTK::Lang::PseudoConstants
 
-      # NOTE: the yard doc macros here only fill in [$2] with the actual value when generating docs under Ruby 1.9+
-
+      # @private
+      # @!macro [attach] define_duration
+      #   $3: $4 beat(s)
+      #   @!attribute [r]
+      #   @return [MTK::Core::Duration] duration of $4 beat(s)
+      def self.define_duration name, value, description, beats
+        define_constant name, value
+      end
+      
+      
       # whole note
-      # @macro [attach] durations.define_constant
+      # @macro [attach] durations.define_duration
       #   @attribute [r]
-      #   @return [$2] number of beats for $1
-      define_constant 'w', MTK::Core::Duration[4]
+      #   @return [$2] duration for $1
+      define_duration 'w', MTK::Core::Duration[4], 'whole note', 4
+
+      define_duration 'h', MTK::Core::Duration[2], 'half note', 2
 
-      # half note
-      define_constant 'h', MTK::Core::Duration[2]
+      define_duration 'q', MTK::Core::Duration[1], 'quarter note', 1
 
-      # quarter note
-      define_constant 'q', MTK::Core::Duration[1]
+      define_duration 'e', MTK::Core::Duration[Rational(1,2)], 'eighth note', '1/2'
 
-      # eight note
-      define_constant 'i', MTK::Core::Duration[Rational(1,2)]
+      define_duration 's', MTK::Core::Duration[Rational(1,4)], 'sixteenth note', '1/4'
 
-      # sixteenth note
-      define_constant 's', MTK::Core::Duration[Rational(1,4)]
+      define_duration 'r', MTK::Core::Duration[Rational(1,8)], 'thirty-second note', '1/8'
 
-      # thirty-second note
-      define_constant 'r', MTK::Core::Duration[Rational(1,8)]
+      define_duration 'x', MTK::Core::Duration[Rational(1,16)], 'sixty-fourth note', '1/16'
 
-      # sixty-fourth note
-      define_constant 'x', MTK::Core::Duration[Rational(1,16)]
 
-      # The values of all "psuedo constants" defined in this module
-      DURATIONS = [w, h, q, i, s, r, x].freeze
+      # All "psuedo constants" defined in this module
+      DURATIONS = [w, h, q, e, s, r, x].freeze
 
       # The names of all "psuedo constants" defined in this module
+      # @see MTK::Core::Duration::NAMES
       DURATION_NAMES = MTK::Core::Duration::NAMES
 
     end

data/lib/mtk/lang/intensities.rb

@@ -3,57 +3,56 @@ module MTK
 
     # Defines intensity constants using standard dynamic symbols.
     #
-    # These can be thought of like constants, but in order to distinguish 'f' (forte) from the {PitchClass} 'F'
-    # it was necessary to use lower-case names and therefore define them as "pseudo constant" methods.
-    # The methods are available either through the module (MTK::Intensities::f) or via mixin (include MTK::Intensities;  f)
+    # These can be thought of like constants, but in order to support the lower case names,
+    # it was necessary to define them as "pseudo constant" methods.
+    # Like constants, these methods are available either through the module (MTK::Lang::Intensities::f) or
+    # via mixin (include MTK::Lang::Intensities; f). They are listed under the "Instance Attribute Summary" of this page.
     #
     # These values are intensities in the range 0.125 - 1.0 (in increments of 1/8), so they can be easily scaled (unlike MIDI velocities).
     #
-    # It is also possible to retrieve values in increments of 1/24 by using the '+' and '-' suffix when looking
-    # up values via the {.[]} method.
-    #
     # @note Including this module shadows Ruby's built-in p() method.
-    #   If you include this module, you can access the built-in p() method via Kernel.p()
+    #       If you include this module, you can access the built-in p() method via Kernel.p()
+    #       Also be aware you might shadow existing variable names, like f.
     #
-    # @see Note
+    # @see Core::Intensity
+    # @see Events::Note
     module Intensities
       extend MTK::Lang::PseudoConstants
 
-      # NOTE: the yard doc macros here only fill in [$2] with the actual value when generating docs under Ruby 1.9+
+      # @private
+      # @!macro [attach] define_intensity
+      #   $3: $4% intensity
+      #   @!attribute [r]
+      #   @return [MTK::Core::Interval] intensity of $4%
+      def self.define_intensity name, value, description, percentage_intensity
+        define_constant name, value
+      end
+
 
-      # pianississimo
-      # @macro [attach] intensities.define_constant
-      #   @attribute [r]
-      #   @return [$2] intensity value for $1
-      define_constant 'ppp', MTK::Core::Intensity[0.125]
+      define_intensity 'ppp', MTK::Core::Intensity[0.125], 'pianississimo', '12.5'
 
-      # pianissimo
-      define_constant 'pp', MTK::Core::Intensity[0.25]
+      define_intensity 'pp', MTK::Core::Intensity[0.25], 'pianissimo', 25
 
-      # piano
       # @note Including this module shadows Ruby's built-in p() method.
       #   If you include this module, you can access the built-in p() method via Kernel.p()
-      define_constant 'p', MTK::Core::Intensity[0.375]
+      define_intensity 'p', MTK::Core::Intensity[0.375], 'piano', '37.5'
+
+      define_intensity 'mp', MTK::Core::Intensity[0.5], 'mezzo-piano', 50
 
-      # mezzo-piano
-      define_constant 'mp', MTK::Core::Intensity[0.5]
+      define_intensity 'mf', MTK::Core::Intensity[0.625], 'mezzo-forte', '62.5'
 
-      # mezzo-forte
-      define_constant 'mf', MTK::Core::Intensity[0.625]
+      define_intensity 'f', MTK::Core::Intensity[0.75], 'forte', 75
 
-      # forte
-      define_constant 'o', MTK::Core::Intensity[0.75]
+      define_intensity 'ff', MTK::Core::Intensity[0.875], 'fortissimo', '87.5'
 
-      # fortissimo
-      define_constant 'ff', MTK::Core::Intensity[0.875]
+      define_intensity 'fff', MTK::Core::Intensity[1.0], 'fortississimo', 100
 
-      # fortississimo
-      define_constant 'fff', MTK::Core::Intensity[1.0]
 
-      # The values of all "psuedo constants" defined in this module
-      INTENSITIES = [ppp, pp, p, mp, mf, o, ff, fff].freeze
+      # All "psuedo constants" defined in this module
+      INTENSITIES = [ppp, pp, p, mp, mf, f, ff, fff].freeze
 
       # The names of all "psuedo constants" defined in this module
+      # @see MTK::Core::Intensity::NAMES
       INTENSITY_NAMES = MTK::Core::Intensity::NAMES
 
     end

data/lib/mtk/lang/intervals.rb

@@ -1,72 +1,139 @@
 module MTK
   module Lang
 
-    # Defines a constant for intervals up to an octave using diatonic naming conventions (see http://en.wikipedia.org/wiki/Interval_(music)#Main_intervals)
+    # Defines a constant for {Core::Interval}s up to an octave using diatonic naming conventions
     #
     # Naming conventions
     #   P#: perfect interval
     #   M#: major interval
     #   m#: minor interval
-    #   TT: tritone (AKA augmented 4th or diminished 5th)
+    #   TT: tritone
+    #   a#: augmented interval
+    #   d#: diminished interval
     #
-    # These can be thought of like constants, but in order to succinctly distinguish 'm2' (minor) from 'M2' (major),
-    # it was necessary to use lower-case names for some of the values and therefore define them as "pseudo constant" methods.
-    # The methods are available either through the module (MTK::Core::Intervals::m2) or via mixin (include MTK::Core::Intervals; m2)
+    # These can be thought of like constants, but in order to support the lower case names,
+    # it was necessary to define them as "pseudo constant" methods.
+    # Like constants, these methods are available either through the module (MTK::Lang::Intervals::m2) or
+    # via mixin (include MTK::Lang::Intervals; m2). They are listed under the "Instance Attribute Summary" of this page.
+    #
+    # @see Core::Interval
+    # @see http://en.wikipedia.org/wiki/Interval_(music)#Main_intervals
     module Intervals
       extend MTK::Lang::PseudoConstants
 
-      # NOTE: the yard doc macros here only fill in [$2] with the actual value when generating docs under Ruby 1.9+
+      # @private
+      # @!macro [attach] define_interval
+      #   $3: $4 semitones
+      #   @!attribute [r]
+      #   @return [MTK::Core::Interval] interval of $4 semitones
+      def self.define_interval name, value, description, semitones
+        define_constant name, value
+      end
+
+
+      # @see #d2
+      define_interval 'P1', MTK::Core::Interval[0], 'perfect unison', 0
+
+      # @see #P1
+      define_interval 'd2', MTK::Core::Interval[0], 'diminished second', 0
+
+
+      # @see #a1
+      define_interval 'm2', MTK::Core::Interval[1], 'minor second', 1
+
+      # @see #m2
+      define_interval 'a1', MTK::Core::Interval[1], 'augmented unison', 1
+
+
+      # @see #d3
+      define_interval 'M2', MTK::Core::Interval[2], 'major second', 2
+
+      # @see #M2
+      define_interval 'd3', MTK::Core::Interval[2], 'diminished third', 2
+
+
+      # @see #a2
+      define_interval 'm3', MTK::Core::Interval[3], 'minor third', 3
+
+      # @see #m3
+      define_interval 'a2', MTK::Core::Interval[3], 'augmented second', 3
+
+
+      # @see #d4
+      define_interval 'M3', MTK::Core::Interval[4], 'major third', 4
+
+      # @see #M3
+      define_interval 'd4', MTK::Core::Interval[4], 'diminished fourth', 4
+
+
+      # @see #a3
+      define_interval 'P4', MTK::Core::Interval[5], 'perfect fourth', 5
+
+      # @see #P4
+      define_interval 'a3', MTK::Core::Interval[5], 'augmented third', 5
+
+
+      # @see #a4
+      # @see #d5
+      define_interval 'TT', MTK::Core::Interval[6], 'tritone', 6
+
+      # @see #TT
+      # @see #d5
+      define_interval 'a4', MTK::Core::Interval[6], 'augmented fourth', 6
+
+      # @see #TT
+      # @see #a4
+      define_interval 'd5', MTK::Core::Interval[6], 'diminished fifth', 6
+
+
+      # @see #d6
+      define_interval 'P5', MTK::Core::Interval[7], 'perfect fifth', 7
+
+      # @see #P5
+      define_interval 'd6', MTK::Core::Interval[7], 'diminished sixth', 7
+
+
+      # @see #a5
+      define_interval 'm6', MTK::Core::Interval[8], 'minor sixth', 8
+
+      # @see #m6
+      define_interval 'a5', MTK::Core::Interval[8], 'augmented fifth', 8
 
-      # perfect unison
-      # @macro [attach] interval.define_constant
-      #   @attribute [r]
-      #   @return [$2] number of semitones in the interval $1
-      define_constant 'P1', MTK::Core::Interval[0]
 
-      # minor second
-      # @macro [attach] interval.define_constant
-      #   @attribute [r]
-      #   @return [$2] number of semitones in the interval $1
-      define_constant 'm2', MTK::Core::Interval[1]
+      # @see #d7
+      define_interval 'M6', MTK::Core::Interval[9], 'major sixth', 9
 
-      # major second
-      define_constant 'M2', MTK::Core::Interval[2]
+      # @see #M6
+      define_interval 'd7', MTK::Core::Interval[9], 'diminished seventh', 9
 
-      # minor third
-      define_constant 'm3', MTK::Core::Interval[3]
 
-      # major third
-      define_constant 'M3', MTK::Core::Interval[4]
+      # @see #a6
+      define_interval 'm7', MTK::Core::Interval[10], 'minor seventh', 10
 
-      # pefect fourth
-      define_constant 'P4', MTK::Core::Interval[5]
+      # @see #m7
+      define_interval 'a6', MTK::Core::Interval[10], 'augmented sixth', 10
 
-      # tritone (AKA augmented fourth or diminished fifth)
-      define_constant 'TT', MTK::Core::Interval[6]
 
-      # perfect fifth
-      define_constant 'P5', MTK::Core::Interval[7]
+      # @see #d8
+      define_interval 'M7', MTK::Core::Interval[11], 'major seventh', 11
 
-      # minor sixth
-      define_constant 'm6', MTK::Core::Interval[8]
+      # @see #M7
+      define_interval 'd8', MTK::Core::Interval[11], 'diminished octave', 11
 
-      # major sixth
-      define_constant 'M6', MTK::Core::Interval[9]
 
-      # minor seventh
-      define_constant 'm7', MTK::Core::Interval[10]
+      # @see #a7
+      define_interval 'P8', MTK::Core::Interval[12], 'perfect octave', 12
 
-      # major seventh
-      define_constant 'M7', MTK::Core::Interval[11]
+      # @see #P8
+      define_interval 'a7', MTK::Core::Interval[12], 'augmented seventh', 12
 
-      # pefect octave
-      define_constant 'P8', MTK::Core::Interval[12]
 
-      # The values of all "psuedo constants" defined in this module
-      INTERVALS = [P1, m2, M2, m3, M3, P4, TT, P5, m6, M6, m7, M7, P8].freeze
+      # All "psuedo constants" defined in this module
+      INTERVALS = [P1, d2, m2, a1, M2, d3, m3, a2, M3, d4, P4, a3, TT, a4, d5, P5, d6, m6, a5, M6, d7, m7, a6, M7, d8, P8, a7].freeze
 
       # The names of all "psuedo constants" defined in this module
-      INTERVAL_NAMES = MTK::Core::Interval::NAMES
+      # @see MTK::Core::Interval::NAMES_BY_VALUE
+      INTERVAL_NAMES = MTK::Core::Interval::ALL_NAMES
 
     end
   end