midilib 4.0.0 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f41957f8222283fa766d489f32dc603edf23fe904682107e216bb5646325fd27
-  data.tar.gz: 2c55d4cb9c3d2255b721725d622936a59456e87e70df4da77cfb1b82f230a338
+  metadata.gz: 21a0b490f3e0df0eb8208d1b07dd7a2d499a3ea7748bdaf89e05c180adc2db84
+  data.tar.gz: 0bece3bec4a4e48044712dd44d40e899283fd2eec9cac1a30ddd91b3ac29bf15
 SHA512:
-  metadata.gz: 884f3ab3488afa1c717ec571de2ebca279ce1e13caa69039b7e0dec2bcf265c3285169d5abe8500cf9cd60f55d818876774bcd3daa0782f2e76d6c4955b1511f
-  data.tar.gz: fce2b737b8c56017d35e27117bee86f2455a05286df63685b354c8d44666369a28353c4efc4e86a8fe01edbf803bc38a8d8549c8ea94003d66fd30eaea8eb3bd
+  metadata.gz: '069eaeafc603927b80d5764593c7ce63bfb9e5d0e3cf3b7c95dee3d42b3a94c604f753b11f2ea6e6ef71d2a203dfaf0acf377a4087531e713b9b16568b390135'
+  data.tar.gz: 7bf1f098d3bdf2587d5e2a3146df7fcc3d3d06c176c693ec9ef504e4c2e03d66913f1067091961832f848ccb7278e569be424e3d971476481f0927957540a0fc

data/README.rdoc

@@ -322,7 +322,7 @@ describes the format of MIDI commands.
 = Administrivia
 
 Author:: Jim Menard (mailto:jim@jimmenard.com)
-Copyright:: Copyright (c) 2003-2013 Jim Menard
+Copyright:: Copyright (c) 2003-2023 Jim Menard
 License:: Distributed under the same license as Ruby.
 
 
@@ -335,157 +335,12 @@ http://www.ruby-lang.org/en/LICENSE.txt.
 midilib may be freely copied in its entirety providing this notice, all
 source code, all documentation, and all other files are included.
 
-midilib is Copyright (c) 2003-2013 by Jim Menard.
+midilib is Copyright (c) 2003-2023 by Jim Menard.
 
 The song "No Fences" contained in the MIDI file examples/NoFences.mid is
 Copyright (c) 1992 by Jim Menard (jim@jimmenard.com). It may be freely used
 for non-commercial purposes as long as the author is given credit.
 
-
-== Recent Changes
-
-=== Changes for 2.0.5:
-
-Updated +install.rb+ to work with newer versions of Ruby by using
-+fileutils+ instead of +ftools+.
-
-=== Changes for 2.0.3:
-
-New MIDI::Sequence.pulses_to_seconds method.
-
-=== Changes for 2.0.2:
-
-Stop monkeypatching Array in MIDI::Track.
-
-=== Changes for 2.0.0:
-
-MIDI::NoteOnEvent and MIDI::NoteOffEvent renamed to MIDI::NoteOn and
-MIDI::NoteOff. The old names will still work for a while.
-
-The MIDI::Event boolean methods like meta? and note? have been removed. Use
-the event classes themselves (for example, MIDI::MetaEvent === my_event or
-my_event.kind_of?(MIDI::MetaEvent)). Case statements that use classes work,
-too:
-
-  case my_event
-  when MIDI::NoteEvent # superclass of note on, note off, poly press
-    do_this()
-  when MIDI::Controller
-    do_that()
-  end
-
-Introduced Adam Murray's stable sorting code for
-MIDI::Track#recalc_delta_from_times. See
-http://wiki.github.com/adamjmurray/cosy/midilib-notes and
-http://github.com/adamjmurray/cosy/blob/master/lib/cosy/helper/midi_file_renderer_helper.rb
-for details.
-
-Aliased MIDI::Track#sort to MIDI::Track#recalc_delta_from_times, since all
-sort did was sort the events then call recalc_delta_from_times, and
-recalc_delta_from_times sorts the events before doing anything else.
-
-MIDI::Tempo#mpq_to_bpm now returns a float.
-
-=== Changes for 1.2.0:
-
-Use byte arrays instead of strings for passing around data. All tests now pass
-for both Ruby 1.8.X and 1.9.X.
-
-=== New code repository
-
-The midilib code is now hosted at Github (http://github.com/jimm/midilib).
-
-=== Changes for 1.1.4:
-
-* Fixed a bug in KeySig.data_as_bytes. Thanks to Noah Thorp for finding this
-  and the bug fixed in 1.1.3.
-
-=== Changes for 1.1.3:
-
-* Fixed the way midilib detects the behavior of IO.getc.
-
-=== Changes for 1.1.2:
-
-* Define MIDI::IO::MIDIFile.getc differently for different Ruby versions,
-  instead of checking for String.bytes every time we read a byte.
-
-=== Changes for 1.1.1:
-
-* Make MIDI::IO::MIDIFile.getc do the right thing for both Ruby 1.8 and 1.9.
-
-=== Changes for 1.1.0:
-
-* Added test/test.mid to list of files to be included when packaging midifile
-  for distribution.
-
-=== Changes for 1.0.0:
-
-* Fixed the bug in Track#recalc_delta_from_times found by Christopher Rose.
-
-=== Changes for 0.8.7:
-
-* Fixed the misspelled POLY_PRESSURE constant, thanks to Mario Pehle.
-
-=== Changes for 0.8.6:
-
-* Added missing test/test.mid.
-
-=== Changes for 0.8.5:
-
-* Fixed bugs in MIDI::PitchBend reading and writing, thanks to Emanuel
-  Borsboom.
-
-* Fixed a bug in MIDI::Track#quantize.
-
-* The argument to MIDI::Track#quantize has changed: it is now either a note
-  name ("sixteenth", "32nd", "8th triplet") or a length (1 = quarter, 0.25 =
-  sixteenth). This is a drastic change that will break all previous calls to
-  quantize. However, since that method was broken already, I don't feel it's
-  a burden to anybody to change the arguments.
-
-=== Changes for 0.8.4:
-
-* Realtime status bytes now set @is_realtime to true and return true when
-  realtime? is called.
-
-* All system common events now set @is_system to true and return true when
-  system? is called, not just system exclusive events.
-
-* Added examples/from_scratch.rb, which shows how to create a sequence
-  manually.
-
-* New MIDI::Sequence methods that turn note length names like "32nd", "dotted
-  quarter", and "16th triplet" into delta times. See the docs below and
-  MIDI::Sequence::length_to_delta, MIDI::Sequence::note_to_length, and
-  MIDI::Sequence::note_to_delta.
-
-
-=== Changes for 0.8.3:
-
-* Added MIDI::NoteEvent.note_to_s, which returns note name as a string like
-  "C4" or "F#6".
-
-* Added new boolean attributes to MIDI::Event: @print_decimal_numbers and
-  @print_note_names. These are used by all Event to_s methods. See
-  examples/seq2text.rb for an example.
-
-=== Changes for 0.8.2:
-
-* Changed MIDI::MetaEvent.type to MIDI::MetaEvent.event_type to avoid
-  runtime complaints about Object#type calls.
-* Added 'b' binary flag to file open modes for Windows.
-* Fixed $LOAD_PATH in example files.
-* Fixed read and write block arguments.
-* Fixed other example script bugs.
-
-=== Changes for 0.8.1:
-
-* Fixed track sorting.
-* Fixed track's recalc_delta_from_times method.
-* Fixed event quantization.
-* More tests and documentation.
-
-
 == Warranty
 
 This software is provided "as is" and without any express or implied

data/Rakefile

@@ -42,20 +42,11 @@ spec = Gem::Specification.new do |s|
   EOF
 end
 
-if RUBY_VERSION >= '1.9'
-  # Creates a :package task (also named :gem). Also useful are
-  # :clobber_package and :repackage.
-  Gem::PackageTask.new(spec) do |pkg|
-    pkg.need_zip = true
-    pkg.need_tar = true
-  end
-else
-  # Creates a :package task (also named :gem). Also useful are
-  # :clobber_package and :repackage.
-  Rake::GemPackageTask.new(spec) do |pkg|
-    pkg.need_zip = true
-    pkg.need_tar = true
-  end
+# Creates a :package task (also named :gem). Also useful are
+# :clobber_package and :repackage.
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
 end
 
 # creates an "rdoc" task

data/examples/from_scratch.rb

@@ -5,13 +5,8 @@
 # This script shows you how to create a new sequence from scratch and save it
 # to a MIDI file. It creates a file called 'from_scratch.mid'.
 
-# Start looking for MIDI module classes in the directory above this one.
-# This forces us to use the local copy, even if there is a previously
-# installed version out there somewhere.
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'midilib/sequence'
-require 'midilib/consts'
+require_relative '../lib/midilib/sequence'
+require_relative '../lib/midilib/consts'
 include MIDI
 
 seq = Sequence.new

data/examples/measures_mbt.rb

@@ -6,12 +6,7 @@
 # in a "sequencer-style" manner:
 #    Measure:Beat:Tick   Channel: Note-name
 
-# Start looking for MIDI module classes in the directory above this one.
-# This forces us to use the local copy, even if there is a previously
-# installed version out there somewhere.
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'midilib/sequence'
+require_relative '../lib/midilib/sequence'
 
 seq = MIDI::Sequence.new
 File.open(ARGV[0], 'rb') { |file| seq.read(file) }

data/examples/print_program_changes.rb

@@ -2,9 +2,7 @@
 #
 # Shows use of print_decimal_numbers and print_channel_numbers_from_one.
 
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'midilib/sequence'
+require_relative '../lib/midilib/sequence'
 
 DEFAULT_MIDI_TEST_FILE = 'NoFences.mid'
 

data/examples/reader2text.rb

@@ -9,13 +9,8 @@
 # For a simpler way to do the same thing, see seq2text.rb.
 #
 
-# Start looking for MIDI module classes in the directory above this one.
-# This forces us to use the local copy, even if there is a previously
-# installed version out there somewhere.
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'midilib/sequence'
-require 'midilib/io/midifile'
+require_relative '../lib/midilib/sequence'
+require_relative '../lib/midilib/io/midifile'
 
 DEFAULT_MIDI_TEST_FILE = 'NoFences.mid'
 

data/examples/seq2text.rb

@@ -9,12 +9,7 @@
 # reader2tex.rb.
 #
 
-# Start looking for MIDI module classes in the directory above this one.
-# This forces us to use the local copy, even if there is a previously
-# installed version out there somewhere.
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'midilib/sequence'
+require_relative '../lib/midilib/sequence'
 
 DEFAULT_MIDI_TEST_FILE = 'NoFences.mid'
 

data/examples/split.rb

@@ -9,12 +9,7 @@
 # If -x is specified, the 0th temp track is not included in each file.
 # Instead, it is output in a separate file named 'tempo_track.mid'.
 
-# Start looking for MIDI module classes in the directory above this one.
-# This forces us to use the local copy, even if there is a previously
-# installed version out there somewhere.
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'midilib/sequence'
+require_relative '../lib/midilib/sequence'
 
 DEFAULT_MIDI_TEST_FILE = 'NoFences.mid'
 

data/examples/strings.rb

@@ -5,13 +5,8 @@
 # Prints all strings (track names, etc.) found in the MIDI file.
 #
 
-# Start looking for MIDI module classes in the directory above this one.
-# This forces us to use the local copy, even if there is a previously
-# installed version out there somewhere.
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'midilib/sequence'
-require 'midilib/consts'
+require_relative '../lib/midilib/sequence'
+require_relative '../lib/midilib/consts'
 
 DEFAULT_MIDI_TEST_FILE = 'NoFences.mid'
 

data/examples/transpose.rb

@@ -7,15 +7,10 @@
 #   -t half_steps   default = 12 (one octave up)
 #
 
-# Start looking for MIDI module classes in the directory above this one.
-# This forces us to use the local copy, even if there is a previously
-# installed version out there somewhere.
-$LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
-
 require 'getoptlong'
-require 'midilib/sequence'
-require 'midilib/io/seqreader'
-require 'midilib/io/seqwriter'
+require_relative '../lib/midilib/sequence'
+require_relative '../lib/midilib/io/seqreader'
+require_relative '../lib/midilib/io/seqwriter'
 
 def usage
   $stderr.print <<~EOF

data/lib/midilib/consts.rb

@@ -77,6 +77,7 @@ module MIDI
   # = 0 - 31 = continuous, MSB
   # = 32 - 63 = continuous, LSB
   # = 64 - 97 = switches
+  CC_BANK_MSB = 0
   CC_MOD_WHEEL = 1
   CC_BREATH_CONTROLLER = 2
   CC_FOOT_CONTROLLER = 4
@@ -92,6 +93,7 @@ module MIDI
   CC_GEN_PURPOSE_4 = 19
 
   # [32 - 63] are LSB for [0 - 31]
+  CC_BANK_LSB = 32
   CC_DATA_ENTRY_LSB = 38
 
   #--

data/lib/midilib/info.rb

@@ -1,7 +1,7 @@
 module MIDI
   VERSION_MAJOR = 4
   VERSION_MINOR = 0
-  VERSION_TWEAK = 0
+  VERSION_TWEAK = 2
   Version = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_TWEAK}"
   Copyright = 'Copyright (c) 2003-2023 by Jim Menard <jim@jimmenard.com>'
 end

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

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')
@@ -146,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
@@ -166,4 +159,116 @@ class IOTester < Test::Unit::TestCase
     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

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: 4.0.0
+  version: 4.0.2
 platform: ruby
 authors:
 - Jim Menard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-05 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
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - none
-rubygems_version: 3.4.3
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: MIDI file and event manipulation library