midilib 1.2.1 → 2.0.0

data/install.rb

@@ -5,7 +5,7 @@
 # This script installs midilib into the Ruby site-local library directory.
 #
 # Author:: Jim Menard (mailto:jimm@io.com)
-# Copyright:: Copyright (c) 2003-2009 by Jim Menard
+# Copyright:: Copyright (c) 2003-2010 by Jim Menard
 # License:: Distributed under the same license as Ruby.
 #
 

data/lib/midilib/event.rb

@@ -30,16 +30,6 @@ class Event
     def initialize(status = 0, delta_time = 0)
 	@status = status
 	@delta_time = delta_time
-	@is_channel = false	# the majority of events are channel events
-	@is_note = false	# note on, note off, and poly press return true
-	@is_note_on = false
-	@is_note_off = false
-	@is_meta = false
-	@is_system = false
-	@is_realtime = false
-        @is_timesig = false
-        @is_keysig = false        
-	@is_program_change = false
 	@time_from_start = 0	# maintained by tracks
     end
     protected :initialize
@@ -51,57 +41,6 @@ class Event
 	raise "subclass responsibility"
     end
 
-    # Returns +true+ if this is a channel event.
-    def channel?
-	return @is_channel
-    end
-
-    # Returns +true+ if this is a note on, note off, or polyphonic pressure
-    # event.
-    def note?
-	return @is_note
-    end
-
-    # Returns +true+ if this is a note on event.
-    def note_on?
-	@is_note_on
-    end
-
-    # Returns +true+ if this is a note off event.
-    def note_off?
-	@is_note_off
-    end
-
-    # Returns +true+ if this is a meta event.
-    def meta?
-	return @is_meta
-    end
-
-    # Returns +true+ if this is a system message event.
-    def system?
-	return @is_system
-    end
-    
-    # Returns +true+ if this is a time signature event.
-    def timesig?
-       return @is_timesig
-    end
-    
-    # Returns +true+ if this is a key signature event.
-    def keysig?
-        return @is_keysig
-    end
-
-    # Returns +true+ if this is a realtime status byte.
-    def realtime?
-	return @is_realtime
-    end
-
-    # Returns +true+ if this is a program change.
-    def program_change?
-	return @is_program_change        
-    end
-
     # Quantize this event's time_from_start by moving it to the nearest
     # multiple of +boundary+. See MIDI::Track#quantize. *Note*: does not
     # modify the event's delta_time, though MIDI::Track#quantize calls
@@ -148,7 +87,6 @@ class ChannelEvent < Event
     def initialize(status, channel, delta_time)
 	super(status, delta_time)
 	@channel = channel
-	@is_channel = true
     end
     protected :initialize
 
@@ -166,7 +104,6 @@ class NoteEvent < ChannelEvent
 	super(status, channel, delta_time)
 	@note = note
 	@velocity = velocity
-	@is_note = true
     end
     protected :initialize
 
@@ -193,30 +130,36 @@ class NoteEvent < ChannelEvent
     end
 end
 
-class NoteOnEvent < NoteEvent
+class NoteOn < NoteEvent
     attr_accessor :off
     def initialize(channel = 0, note = 64, velocity = 64, delta_time = 0)
 	super(NOTE_ON, channel, note, velocity, delta_time)
-	@is_note_on = true
     end
+
     def to_s
 	return super <<
 	    "on #{note_to_s} #{number_to_s(@velocity)}"
     end
 end
 
-class NoteOffEvent < NoteEvent
+# Old class name for compatability
+NoteOnEvent = NoteOn
+
+class NoteOff < NoteEvent
     attr_accessor :on
     def initialize(channel = 0, note = 64, velocity = 64, delta_time = 0)
 	super(NOTE_OFF, channel, note, velocity, delta_time)
-	@is_note_off = true
     end
+
     def to_s
 	return super <<
 	    "off #{note_to_s} #{number_to_s(@velocity)}"
     end
 end
 
+# Old class name for compatability
+NoteOffEvent = NoteOff
+
 class PolyPressure < NoteEvent
     def initialize(channel = 0, note = 64, value = 0, delta_time = 0)
 	super(POLY_PRESSURE, channel, note, value, delta_time)
@@ -241,7 +184,6 @@ class Controller < ChannelEvent
 	super(CONTROLLER, channel, delta_time)
 	@controller = controller
 	@value = value
-	@is_controller = true
     end
 
     def data_as_bytes
@@ -262,7 +204,6 @@ class ProgramChange < ChannelEvent
     def initialize(channel = 0, program = 0, delta_time = 0)
 	super(PROGRAM_CHANGE, channel, delta_time)
 	@program = program
-	@is_program_change = true
     end
 
     def data_as_bytes
@@ -318,7 +259,6 @@ end
 class SystemCommon < Event
     def initialize(status, delta_time)
 	super(status, delta_time)
-	@is_system = true
     end
 end
 
@@ -401,7 +341,6 @@ end
 class Realtime < Event
     def initialize(status, delta_time)
 	super(status, delta_time)
-	@is_realtime = true
     end
 
     def data_as_bytes
@@ -490,7 +429,6 @@ class MetaEvent < Event
     def initialize(meta_type, data = nil, delta_time = 0)
 	super(META_EVENT, delta_time)
 	@meta_type = meta_type
-	@is_meta = true
 	self.data=(data)
     end
 
@@ -573,9 +511,7 @@ class Tempo < MetaEvent
 
     # Translates microseconds per quarter note (beat) to beats per minute.
     def Tempo.mpq_to_bpm(mpq)
-        # Nov 17 2007: Fixed integer rounding error issue:
-        # 110 bpm (as 545455 msecs) becomes 109.999 (which became 109 bpm)
-	return Integer(MICROSECS_PER_MINUTE.to_f / mpq + 0.49)
+	return MICROSECS_PER_MINUTE.to_f / mpq.to_f
     end
 
     def initialize(msecs_per_qnote, delta_time = 0)
@@ -611,7 +547,6 @@ class TimeSig < MetaEvent
     # Constructor
     def initialize(numer, denom, clocks, qnotes, delta_time = 0)
        super(META_TIME_SIG, [numer, denom, clocks, qnotes], delta_time)
-       @is_timesig = true
     end
     
     # Returns the complete event as stored in the sequence
@@ -661,7 +596,6 @@ class KeySig < MetaEvent
     # Constructor
     def initialize(sharpflat, is_minor, delta_time = 0)
        super(META_KEY_SIG, [sharpflat, is_minor], delta_time)   
-       @is_keysig = true
     end
     
     # Returns the complete event as stored in the sequence

data/lib/midilib/info.rb

@@ -1,9 +1,9 @@
 module MIDI
 
-    VERSION_MAJOR = 1
-    VERSION_MINOR = 2
-    VERSION_TWEAK = 1
+    VERSION_MAJOR = 2
+    VERSION_MINOR = 0
+    VERSION_TWEAK = 0
     Version = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_TWEAK}"
-    Copyright = 'Copyright (c) 2003-2009 by Jim Menard <jimm@io.com>'
+    Copyright = 'Copyright (c) 2003-2010 by Jim Menard <jimm@io.com>'
 
 end

data/lib/midilib/io/seqreader.rb

@@ -75,7 +75,7 @@ class SeqReader < MIDIFile
 	    return
 	end
 
-	on = NoteOnEvent.new(chan, note, vel, @curr_ticks)
+	on = NoteOn.new(chan, note, vel, @curr_ticks)
 	@track.events << on
 	@pending << on
 	track_uses_channel(chan)
@@ -96,7 +96,7 @@ class SeqReader < MIDIFile
     end
 
     def make_note_off(on, vel)
-	off = NoteOffEvent.new(on.channel, on.note, vel, @curr_ticks)
+	off = NoteOff.new(on.channel, on.note, vel, @curr_ticks)
 	@track.events << off
 	on.off = off
 	off.on = on

data/lib/midilib/io/seqwriter.rb

@@ -91,7 +91,7 @@ class SeqWriter
 	# exactly the same, the rest is trivial. If it's note on/note off,
 	# we can combine those further.
 	if status == prev_status
-	    data[0,1] = nil	# delete status byte from data
+	    data[0,1] = []	# delete status byte from data
 	    return status + chan
 	elsif status == NOTE_OFF && data[2] == 64
 	    # If we see a note off and the velocity is 64, we can store

data/lib/midilib/sequence.rb

@@ -153,7 +153,7 @@ class Sequence
        max_pos = 0
        @tracks.each  { |t|
          t.each { |e| 
-           time_sigs << e if e.timesig?           
+           time_sigs << e if e.kind_of?(MIDI::TimeSig)
            max_pos = e.time_from_start if e.time_from_start > max_pos
          }
        }

data/lib/midilib/track.rb

@@ -1,5 +1,47 @@
 require 'midilib/event'
 
+# This is taken from
+# http://github.com/adamjmurray/cosy/blob/master/lib/cosy/helper/midi_file_renderer_helper.rb
+# with permission from Adam Murray, who originally suggested this fix.
+# See http://wiki.github.com/adamjmurray/cosy/midilib-notes for details.
+# First we need to add some API infrastructure:
+class Array
+  # This code borrowed from 'Moser' http://codesnippets.joyent.com/posts/show/1699
+  
+  # A stable sorting algorithm that maintains the relative order of equal elements
+  def mergesort(&cmp)
+    if cmp == nil
+      cmp = lambda { |a, b| a <=> b }
+    end
+    if size <= 1
+      self.dup
+    else
+      halves = split.map{ |half|
+        half.mergesort(&cmp)
+      }
+      merge(*halves, &cmp)
+    end
+  end
+
+  protected
+  def split
+    n = (length / 2).floor - 1
+    [self[0..n], self[n+1..-1]]
+  end
+
+  def merge(first, second, &predicate)
+    result = []
+    until first.empty? || second.empty?
+      if predicate.call(first.first, second.first) <= 0
+        result << first.shift
+      else
+        result << second.shift
+      end
+    end
+    result.concat(first).concat(second)
+  end
+end
+
 module MIDI
 
 # A Track is a list of events.
@@ -32,7 +74,7 @@ class Track
     # Return track name. If there is no name, return UNNAMED.
     def name
 	event = @events.detect { | e |
-	    e.meta? && e.meta_type == META_SEQ_NAME
+	    e.kind_of?(MetaEvent) && e.meta_type == META_SEQ_NAME
 	}
 	return event ? event.data_as_str : UNNAMED
     end
@@ -40,7 +82,7 @@ class Track
     # Set track name. Replaces or creates a name meta-event.
     def name=(name)
 	event = @events.detect { | e |
-	    e.meta? && e.meta_type == META_SEQ_NAME
+	    e.kind_of?(MetaEvent) && e.meta_type == META_SEQ_NAME
 	}
 	if event
 	    event.data = name
@@ -74,7 +116,7 @@ class Track
     def merge_event_lists(list1, list2)
 	recalc_times(0, list1)
 	recalc_times(0, list2)
-	list = (list1 + list2).sort_by { | e | e.time_from_start }
+        list = list1 + list2
 	recalc_delta_from_times(0, list)
 	return list
     end
@@ -113,7 +155,10 @@ class Track
     def recalc_delta_from_times(starting_at=0, list=@events)
 	prev_time_from_start = 0
 	# We need to sort the sublist. sublist.sort! does not do what we want.
-	list[starting_at .. -1] = list[starting_at .. -1].sort { | e1, e2 |
+        # We call mergesort instead of Array.sort because sort is not stable
+        # (it can mix up the order of events that have the same start time).
+        # See http://wiki.github.com/adamjmurray/cosy/midilib-notes for details.
+	list[starting_at .. -1] = list[starting_at .. -1].mergesort { | e1, e2 |
 	    e1.time_from_start <=> e2.time_from_start
 	}
 	list[starting_at .. -1].each { | e |
@@ -130,10 +175,11 @@ class Track
     # Sort events by their time_from_start. After sorting,
     # recalc_delta_from_times is called to make sure that the delta times
     # reflect the possibly new event order.
-    def sort
-	@events = @events.sort_by { | e | e.time_from_start }
-	recalc_delta_from_times()
-    end
+    #
+    # Note: this method is redundant, since recalc_delta_from_times sorts
+    # the events first. This method may go away in a future release, or at
+    # least be aliased to recalc_delta_from_times.
+    alias_method :sort, :recalc_delta_from_times
 end
 
 end

data/test/test_event.rb

@@ -9,7 +9,7 @@ require 'midilib'
 class EventTester < Test::Unit::TestCase
 
     def test_note_on
-	e = MIDI::NoteOnEvent.new
+	e = MIDI::NoteOn.new
 	assert_equal(MIDI::NOTE_ON, e.status)
 	assert_equal(0, e.channel)
 	assert_equal(64, e.note)
@@ -19,7 +19,7 @@ class EventTester < Test::Unit::TestCase
     end
 
     def test_quantize
-	e = MIDI::NoteOnEvent.new
+	e = MIDI::NoteOn.new
 	e.quantize_to(4)
 	assert_equal(0, e.time_from_start)
 
@@ -45,7 +45,7 @@ class EventTester < Test::Unit::TestCase
     end
 
     def test_to_s
-	e = MIDI::NoteOnEvent.new
+	e = MIDI::NoteOn.new
 	assert_equal("0: ch 00 on 40 40", e.to_s)
 	e.print_decimal_numbers = true
 	assert_equal("0: ch 0 on 64 64", e.to_s)
@@ -55,64 +55,6 @@ class EventTester < Test::Unit::TestCase
 	assert_equal("0: ch 00 on E4 40", e.to_s)
     end
 
-    def test_bools_note_on
-      e = MIDI::NoteOnEvent.new
-      assert(e.channel?)
-      assert(e.note?)
-      assert(e.note_on?)
-      assert(!e.note_off?)
-      assert(!e.meta?)
-      assert(!e.system?)
-      assert(!e.realtime?)
-    end
-
-    def test_bools_note_off
-      e = MIDI::NoteOffEvent.new
-      assert(e.channel?)
-      assert(e.note?)
-      assert(!e.note_on?)
-      assert(e.note_off?)
-      assert(!e.meta?)
-      assert(!e.system?)
-      assert(!e.realtime?)
-    end
-
-    def test_bools_realtime
-      e = MIDI::Clock.new
-      assert(!e.channel?)
-      assert(!e.note?)
-      assert(!e.meta?)
-      assert(!e.system?)
-      assert(e.realtime?)
-    end
-
-    def test_bools_controller
-      e = MIDI::Controller.new
-      assert(e.channel?)
-      assert(!e.note?)
-      assert(!e.meta?)
-      assert(!e.system?)
-      assert(!e.realtime?)
-    end
-
-    def test_bools_meta
-      e = MIDI::MetaEvent.new(MIDI::META_SEQ_NUM)
-      assert(!e.channel?)
-      assert(!e.note?)
-      assert(e.meta?)
-      assert(!e.system?)
-      assert(!e.realtime?)
-    end
-
-    def test_bools_system
-      e = MIDI::TuneRequest.new
-      assert(!e.channel?)
-      assert(!e.note?)
-      assert(!e.meta?)
-      assert(e.system?)
-      assert(!e.realtime?)
-    end
-
     def test_pitch_bend
       e = MIDI::PitchBend.new(0, 128)
       b = e.data_as_bytes
@@ -126,7 +68,7 @@ class EventTester < Test::Unit::TestCase
     end
 
     def test_quantize
-	e = MIDI::NoteOnEvent.new(0, 64, 64, 0)
+	e = MIDI::NoteOn.new(0, 64, 64, 0)
 	e.quantize_to(80)
 	assert_equal(0, e.time_from_start)