midilib 3.1.0 → 4.0.2

data/lib/midilib/track.rb

@@ -59,11 +59,48 @@ module MIDI
                     end
     end
 
+    # Iterates over events, yielding each one.
+    def each(&block) # :yields: event
+      @events.each(&block)
+    end
+
+    # If `event` exists in @events, deletes it, updates the delta time of
+    # the event after it, and calls `recalc_times` by default.
+    def delete_event(event, call_recalc_times = true)
+      i = @events.index(event)
+      return unless i
+
+      @events[i + 1].delta_time += @events[i].delta_time if i != (@events.length - 1)
+      @events.delete_at(i)
+      recalc_times if call_recalc_times
+    end
+
+    # Makes sure that we have one and only one end track meta event at the
+    # end of this track.
+    def ensure_track_end_meta_event
+      track_ends = @events.select { |e| e.is_a?(MetaEvent) && e.meta_type == META_TRACK_END }
+      has_end = !@events.empty? && track_ends[-1] == @events.last
+
+      # If we only have one end event and it's the last one, there's nothing
+      # to do.
+      return if track_ends.length == 1 && has_end
+
+      # If we have an end of track event already, leave it alone.
+      track_ends.pop if has_end
+      track_ends.each { |track_end| delete_event(track_end, false) }
+      return if has_end
+
+      mte = MetaEvent.new(META_TRACK_END, nil, 0)
+      mte.time_from_start = @events.last.time_from_start + mte.delta_time if @events.last
+      @events << mte
+    end
+
     # Merges an array of events into our event list. After merging, the
     # events' time_from_start values are correct so you don't need to worry
-    # about calling recalc_times.
+    # about calling #recalc_times.
     def merge(event_list)
       @events = merge_event_lists(@events, event_list)
+      ensure_track_end_meta_event
     end
 
     # Merges two event arrays together. Does not modify this track.
@@ -121,11 +158,6 @@ module MIDI
       end
     end
 
-    # Iterate over events.
-    def each(&block) # :yields: event
-      @events.each(&block)
-    end
-
     # 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.

data/test/test_event.rb

@@ -1,10 +1,5 @@
-# Start looking for MIDI classes in the directory above this one.
-# This forces us to use the local copy of MIDI, even if there is
-# a previously installed version out there somewhere.
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
 require 'test/unit'
-require 'midilib'
+require_relative '../lib/midilib'
 
 class EventTester < Test::Unit::TestCase
   def test_note_on
@@ -130,4 +125,16 @@ class EventTester < Test::Unit::TestCase
     assert_equal('foobar', e.data_as_str)
     assert_equal(foobar_as_array, e.data)
   end
+
+  def test_song_pointer
+    e = MIDI::SongPointer.new(1)
+    b = e.data_as_bytes
+    assert_equal(1, b[1])       # lsb, 7 bits
+    assert_equal(0, b[2])       # msb, 7 bits
+
+    e.pointer = (3 << 7) + 42
+    b = e.data_as_bytes
+    assert_equal(42, b[1])      # lsb, 7 bits
+    assert_equal(3, b[2])       # msb, 7 bits
+  end
 end

data/test/test_io.rb

@@ -1,14 +1,7 @@
-# Start looking for MIDI classes in the directory above this one.
-# This forces us to use the local copy of MIDI, even if there is
-# a previously installed version out there somewhere.
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-# Add current directory so we can find event_equality
-$LOAD_PATH[0, 0] = File.dirname(__FILE__)
-
 require 'test/unit'
-require 'midilib'
-require 'midilib/consts'
-require 'event_equality'
+require_relative '../lib/midilib'
+require_relative '../lib/midilib/consts'
+require_relative 'event_equality'
 
 class IOTester < Test::Unit::TestCase
   SEQ_TEST_FILE = File.join(File.dirname(__FILE__), 'test.mid')
@@ -35,7 +28,12 @@ class IOTester < Test::Unit::TestCase
     assert_equal(1, format0_seq.tracks.length, 'number of tracks differ')
     format_1_count = multitrack_seq.tracks.map { |t| t.events.count }.reduce(:+)
     format_0_count = format0_seq.tracks.map { |t| t.events.count }.reduce(:+)
-    assert_equal(format_1_count, format_0_count, 'same number of total events')
+
+    # The format 1 file will have one more event because there is an end of
+    # track meta event at the end of each track (the track 0 metadata track
+    # and track 1 with the notes), whereas the format 0 file only has one
+    # track, thus one end of track meta event.
+    assert_equal(format_1_count, format_0_count + 1, 'different number of total events')
   end
 
   def test_read_and_write
@@ -101,6 +99,22 @@ class IOTester < Test::Unit::TestCase
     assert_equal(MIDI::GM_PATCH_NAMES[0], seq.tracks[1].instrument)
   end
 
+  # This is a regression test.
+  def test_read_eot_preserves_delta
+    seq = MIDI::Sequence.new
+    File.open(SEQ_TEST_FILE, 'rb') { |f| seq.read(f) }
+    track = seq.tracks.last
+    mte = MIDI::MetaEvent.new(MIDI::META_TRACK_END, nil, 123)
+    track.events << mte
+    track.recalc_times
+    File.open(OUTPUT_FILE, 'wb') { |f| seq.write(f) }
+    File.open(OUTPUT_FILE, 'rb') { |f| seq.read(f) }
+
+    assert_equal(mte, seq.tracks.last.events.last)
+  ensure
+    File.delete(OUTPUT_FILE) if File.exist?(OUTPUT_FILE)
+  end
+
   def test_preserve_deltas_in_some_situations
     out_seq = MIDI::Sequence.new
     out_track = MIDI::Track.new(out_seq)
@@ -125,7 +139,7 @@ class IOTester < Test::Unit::TestCase
       out_track.events << MIDI::NoteOff.new(0, 65, 127, 230)
     end
 
-    File.open('/tmp/midilib_test.mid', 'wb') { |file| out_seq.write(file) }
+    File.open(TEMPFILE, 'wb') { |file| out_seq.write(file) }
 
     # Although start times are not written out to the MIDI file, we
     # calculate them because we are about to compare the out events with the
@@ -135,9 +149,126 @@ class IOTester < Test::Unit::TestCase
     in_seq = MIDI::Sequence.new
     File.open(TEMPFILE, 'rb') { |file| in_seq.read(file) }
     in_track = in_seq.tracks[0]
-    assert_equal(out_track.events.length, in_track.events.length)
+    assert_equal(out_track.events.length + 1, in_track.events.length) # read added end of track meta event
     out_track.events.each_with_index do |event, i|
       assert_equal(event, in_track.events[i])
     end
+
+    # Last event is a end of track meta event
+    e = in_track.events.last
+    assert(e.is_a?(MIDI::MetaEvent))
+    assert(e.meta_type == MIDI::META_TRACK_END)
+  end
+
+  def test_preserve_deltas_multiple_note_offs
+    out_seq = MIDI::Sequence.new
+    out_track = MIDI::Track.new(out_seq)
+    out_seq.tracks << out_track
+    out_track.events << MIDI::Tempo.new(MIDI::Tempo.bpm_to_mpq(120))
+
+    out_track = MIDI::Track.new(out_seq)
+    out_seq.tracks << out_track
+    out_track.events << MIDI::NoteOn.new(0, 65, 127, 100)
+    out_track.events << MIDI::NoteOff.new(0, 65, 127, 100)
+    out_track.events << MIDI::NoteOff.new(0, 65, 127, 100)
+
+    File.open(TEMPFILE, 'wb') { |file| out_seq.write(file) }
+
+    in_seq = MIDI::Sequence.new
+    File.open(TEMPFILE, 'rb') { |file| in_seq.read(file) }
+    in_track = in_seq.tracks[1]
+
+    out_track.recalc_times # so that start times are correct
+
+    assert_equal(out_track.events.length + 1, in_track.events.length)
+    out_track.events.each_with_index do |event, i|
+      assert_equal(event.data_as_bytes, in_track.events[i].data_as_bytes)
+      assert_equal(event.delta_time, in_track.events[i].delta_time)
+      assert_equal(event.time_from_start, in_track.events[i].time_from_start)
+    end
+
+    # Last event is a end of track meta event
+    e = in_track.events.last
+    assert(e.is_a?(MIDI::MetaEvent))
+    assert(e.meta_type == MIDI::META_TRACK_END)
+  end
+
+  def test_preserve_deltas_multiple_note_on_zero_velocity
+    out_seq = MIDI::Sequence.new
+    out_track = MIDI::Track.new(out_seq)
+    out_seq.tracks << out_track
+    out_track.events << MIDI::Tempo.new(MIDI::Tempo.bpm_to_mpq(120))
+
+    out_track = MIDI::Track.new(out_seq)
+    out_seq.tracks << out_track
+    out_track.events << MIDI::NoteOn.new(0, 65, 127, 100)
+    out_track.events << MIDI::NoteOn.new(0, 65, 0, 100)
+    out_track.events << MIDI::NoteOn.new(0, 65, 0, 100)
+
+    File.open(TEMPFILE, 'wb') { |file| out_seq.write(file) }
+
+    in_seq = MIDI::Sequence.new
+    File.open(TEMPFILE, 'rb') { |file| in_seq.read(file) }
+    in_track = in_seq.tracks[1]
+
+    # Turn the note ons with zero velocity into note offs, and recalc start
+    # times so that time_from_start is correct.
+    [1, 2].each do |i|
+      out_track.events[i] = MIDI::NoteOff.new(0, 65, 64, 100)
+    end
+    out_track.recalc_times # so that start times are correct
+
+    assert_equal(out_track.events.length + 1, in_track.events.length)
+    out_track.events.zip(in_track.events).each do |out_event, in_event|
+      assert_equal(out_event.data_as_bytes, in_event.data_as_bytes)
+      assert_equal(out_event.delta_time, in_event.delta_time)
+      assert_equal(out_event.time_from_start, in_event.time_from_start)
+    end
+
+    # Last event is a end of track meta event
+    e = in_track.events.last
+    assert(e.is_a?(MIDI::MetaEvent))
+    assert(e.meta_type == MIDI::META_TRACK_END)
+  end
+
+  # Regression test. Running status output when writing a track's events was
+  # broken.
+  def test_running_status_output
+    out_seq = MIDI::Sequence.new
+    out_track = MIDI::Track.new(out_seq)
+    out_seq.tracks << out_track
+    out_track.events << MIDI::Tempo.new(MIDI::Tempo.bpm_to_mpq(120))
+
+    out_track = MIDI::Track.new(out_seq)
+    out_seq.tracks << out_track
+    out_track.events << MIDI::NoteOn.new(0, 65, 127, 100)
+    out_track.events << MIDI::NoteOn.new(0, 65, 0, 100)
+    out_track.events << MIDI::NoteOn.new(0, 65, 0, 100)
+
+    File.open(TEMPFILE, 'wb') { |file| out_seq.write(file) }
+
+    in_seq = MIDI::Sequence.new
+    File.open(TEMPFILE, 'rb') { |file| in_seq.read(file) }
+    in_track = in_seq.tracks[1]
+
+    # Turn the note ons with zero velocity into note offs, and recalc start
+    # times so that time_from_start is correct.
+    [1, 2].each do |i|
+      out_track.events[i] = MIDI::NoteOff.new(0, 65, 64, 100)
+    end
+    out_track.recalc_times # so that start times are correct
+
+    assert_equal(out_track.events.length + 1, in_track.events.length)
+    out_track.events.each_with_index do |event, i|
+      in_event = in_track.events[i]
+      assert_equal(event.data_as_bytes, in_track.events[i].data_as_bytes)
+      assert_equal(event.delta_time, in_track.events[i].delta_time)
+      assert_equal(event.time_from_start, in_track.events[i].time_from_start)
+    end
+
+    # Last event is a end of track meta event
+    e = in_track.events.last
+    assert(e.is_a?(MIDI::MetaEvent))
+    assert(e.meta_type == MIDI::META_TRACK_END)
   end
 end

data/test/test_mergesort.rb

@@ -1,10 +1,5 @@
-# Start looking for MIDI classes in the directory above this one.
-# This forces us to use the local copy of MIDI, even if there is
-# a previously installed version out there somewhere.
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
 require 'test/unit'
-require 'midilib/mergesort'
+require_relative '../lib/midilib/mergesort'
 
 class MergesortTester < Test::Unit::TestCase
   def test_mergesort

data/test/test_midifile.rb

@@ -1,11 +1,6 @@
-# Start looking for MIDI classes in the directory above this one.
-# This forces us to use the local copy of MIDI, even if there is
-# a previously installed version out there somewhere.
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
 require 'test/unit'
 require 'stringio'
-require 'midilib'
+require_relative '../lib/midilib'
 
 class MIDI::IO::MIDIFile
   attr_writer :io

data/test/test_sequence.rb

@@ -1,10 +1,5 @@
-# Start looking for MIDI classes in the directory above this one.
-# This forces us to use the local copy of MIDI, even if there is
-# a previously installed version out there somewhere.
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
 require 'test/unit'
-require 'midilib'
+require_relative '../lib/midilib'
 
 class SequenceTester < Test::Unit::TestCase
   def setup

data/test/test_track.rb

@@ -1,10 +1,5 @@
-# Start looking for MIDI classes in the directory above this one.
-# This forces us to use the local copy of MIDI, even if there is
-# a previously installed version out there somewhere.
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
 require 'test/unit'
-require 'midilib'
+require_relative '../lib/midilib'
 
 class TrackTester < Test::Unit::TestCase
   def setup
@@ -61,7 +56,8 @@ class TrackTester < Test::Unit::TestCase
   def test_merge
     list = (1..12).collect { |i| MIDI::NoteOn.new(0, 64, 64, 10) }
     @track.merge(list)
-    assert_equal(15, @track.events.length)
+    # We merged 15 events, but an end of track meta event was added by merge
+    assert_equal(16, @track.events.length)
     assert_equal(10, @track.events[0].time_from_start)
     assert_equal(10, @track.events[0].delta_time)
     assert_equal(20, @track.events[1].time_from_start)
@@ -79,6 +75,7 @@ class TrackTester < Test::Unit::TestCase
     assert_equal(120, @track.events[12].time_from_start)
     assert_equal(200, @track.events[13].time_from_start)
     assert_equal(300, @track.events[14].time_from_start)
+    assert_equal(300, @track.events[15].time_from_start) # end of track meta event
   end
 
   def test_recalc_delta_from_times
@@ -140,4 +137,66 @@ class TrackTester < Test::Unit::TestCase
     x = MIDI::NoteOff.new(0, 64, 64, 10)
     assert(x.is_a?(MIDI::NoteOffEvent)) # old name
   end
+
+  def test_delete_event
+    # Event is not in the track; nothing happens
+    @track.delete_event(MIDI::Controller.new(0, 64, 64, 200))
+    assert_equal(3, @track.events.length)
+
+    # Make sure we update delta times and that start times are preserved
+    e = @track.events[1]
+    @track.delete_event(e)
+    assert_equal(2, @track.events.length)
+    assert(@track.events.index(e).nil?)
+    assert_equal([100, 200], @track.events.map(&:delta_time))
+    assert_equal([100, 300], @track.events.map(&:time_from_start))
+  end
+
+  def test_ensure_track_end_meta_event
+    @track.ensure_track_end_meta_event
+    assert_equal(4, @track.events.length)
+    e = @track.events.last
+    assert(e.is_a?(MIDI::MetaEvent))
+    assert_equal(MIDI::META_TRACK_END, e.meta_type)
+    assert_equal(0, e.delta_time)
+    assert_equal(@track.events[-2].time_from_start, e.time_from_start)
+  end
+
+  def test_ensure_track_end_meta_event_removes_duplicates
+    mte = MIDI::MetaEvent.new(MIDI::META_TRACK_END, nil, 0)
+    @track.events << mte
+    @track.events.unshift(mte.dup)
+    @track.events.unshift(mte.dup)
+
+    @track.ensure_track_end_meta_event
+    mtes = @track.events.select { |e| e.is_a?(MIDI::MetaEvent) && e.meta_type == MIDI::META_TRACK_END }
+    assert_equal(1, mtes.length)
+    assert(@track.events.last.is_a?(MIDI::MetaEvent) && @track.events.last.meta_type == MIDI::META_TRACK_END)
+  end
+
+  def test_ensure_track_end_with_dupes_does_not_shrink_track
+    mte = MIDI::MetaEvent.new(MIDI::META_TRACK_END, nil, 123)
+    @track.events.unshift(mte.dup)
+    @track.events << mte
+    @track.recalc_times
+    start_time = @track.events.last.time_from_start
+
+    @track.ensure_track_end_meta_event
+    mtes = @track.events.select { |e| e.is_a?(MIDI::MetaEvent) && e.meta_type == MIDI::META_TRACK_END }
+    assert_equal(1, mtes.length)
+    assert_equal(mte, mtes[0])
+
+    # As a side effect, ensure_track_end_meta_event calls recalc_times which
+    # in this case will modify the start time of mte.
+    assert_equal(start_time, mte.time_from_start)
+  end
+
+  def test_ensure_track_end_adds_to_empty_track
+    t = MIDI::Track.new(@seq)
+    t.ensure_track_end_meta_event
+
+    assert_equal(1, t.events.length)
+    mte = t.events.first
+    assert(mte.is_a?(MIDI::MetaEvent) && mte.meta_type == MIDI::META_TRACK_END)
+  end
 end

data/test/test_varlen.rb

@@ -1,10 +1,5 @@
-# Start looking for MIDI classes in the directory above this one.
-# This forces us to use the local copy of MIDI, even if there is
-# a previously installed version out there somewhere.
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
 require 'test/unit'
-require 'midilib'
+require_relative '../lib/midilib'
 
 class VarLenTester < Test::Unit::TestCase
   VAR_LEN_TEST_DATA = {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: midilib
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.0.2
 platform: ruby
 authors:
 - Jim Menard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-04 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies: []
 description: |
   midilib is a pure Ruby MIDI library useful for reading and
@@ -35,90 +35,6 @@ files:
 - examples/split.rb
 - examples/strings.rb
 - examples/transpose.rb
-- html/MIDI.html
-- html/MIDI/ActiveSense.html
-- html/MIDI/ChannelEvent.html
-- html/MIDI/ChannelPressure.html
-- html/MIDI/Clock.html
-- html/MIDI/Continue.html
-- html/MIDI/Controller.html
-- html/MIDI/Event.html
-- html/MIDI/IO.html
-- html/MIDI/IO/MIDIFile.html
-- html/MIDI/IO/SeqReader.html
-- html/MIDI/IO/SeqWriter.html
-- html/MIDI/KeySig.html
-- html/MIDI/Marker.html
-- html/MIDI/Measure.html
-- html/MIDI/Measures.html
-- html/MIDI/MetaEvent.html
-- html/MIDI/NoteEvent.html
-- html/MIDI/NoteOff.html
-- html/MIDI/NoteOn.html
-- html/MIDI/PitchBend.html
-- html/MIDI/PolyPressure.html
-- html/MIDI/ProgramChange.html
-- html/MIDI/Realtime.html
-- html/MIDI/Sequence.html
-- html/MIDI/SongPointer.html
-- html/MIDI/SongSelect.html
-- html/MIDI/Start.html
-- html/MIDI/Stop.html
-- html/MIDI/SystemCommon.html
-- html/MIDI/SystemExclusive.html
-- html/MIDI/SystemReset.html
-- html/MIDI/Tempo.html
-- html/MIDI/TimeSig.html
-- html/MIDI/Track.html
-- html/MIDI/TuneRequest.html
-- html/MIDI/Utils.html
-- html/Object.html
-- html/README_rdoc.html
-- html/TODO_rdoc.html
-- html/created.rid
-- html/css/fonts.css
-- html/css/rdoc.css
-- html/fonts/Lato-Light.ttf
-- html/fonts/Lato-LightItalic.ttf
-- html/fonts/Lato-Regular.ttf
-- html/fonts/Lato-RegularItalic.ttf
-- html/fonts/SourceCodePro-Bold.ttf
-- html/fonts/SourceCodePro-Regular.ttf
-- html/images/add.png
-- html/images/arrow_up.png
-- html/images/brick.png
-- html/images/brick_link.png
-- html/images/bug.png
-- html/images/bullet_black.png
-- html/images/bullet_toggle_minus.png
-- html/images/bullet_toggle_plus.png
-- html/images/date.png
-- html/images/delete.png
-- html/images/find.png
-- html/images/loadingAnimation.gif
-- html/images/macFFBgHack.png
-- html/images/package.png
-- html/images/page_green.png
-- html/images/page_white_text.png
-- html/images/page_white_width.png
-- html/images/plugin.png
-- html/images/ruby.png
-- html/images/tag_blue.png
-- html/images/tag_green.png
-- html/images/transparent.png
-- html/images/wrench.png
-- html/images/wrench_orange.png
-- html/images/zoom.png
-- html/index.html
-- html/js/darkfish.js
-- html/js/navigation.js
-- html/js/navigation.js.gz
-- html/js/search.js
-- html/js/search_index.js
-- html/js/search_index.js.gz
-- html/js/searcher.js
-- html/js/searcher.js.gz
-- html/table_of_contents.html
 - install.rb
 - lib/midilib.rb
 - lib/midilib/consts.rb
@@ -163,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - none
-rubygems_version: 3.3.7
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: MIDI file and event manipulation library