midilib 2.0.5 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a7ad7b3f46a7550efe7a5f33bebc63280704ad12
-  data.tar.gz: 7b03d6a94f4e8de161e54f650bfaa07c325df930
+SHA256:
+  metadata.gz: c7b4ef36d4f1d38a6f2c2bbf00fc34e7400822ab5f3f05242296bb383bf7cd35
+  data.tar.gz: e814f94bccbf648fb8ef7035551996673f6991114000ca7c7199c26cdee0d913
 SHA512:
-  metadata.gz: 626f1286f221899c310571c26f60c1d57abbf51694a5f13b3b2e56d038763388db63e799ecda03bf0d874c84ea85390ea122e3ecab2b6762bff0c5aaa4faf79c
-  data.tar.gz: 088f6fba5f281fd024089f7f919995cd4653abc1f0ee3361fbd0cc3ccb43ebb7120efe4b38e5cf76449fe65072cff8f18376368e7507216a94c3714d386728dd
+  metadata.gz: f9942744aebb170da22efff3c845f9b976f473c6b1584f00abf7da4b680c730eeb597a0aff8fc45b32c965453283a6cb007172183284d9f6116ff89c31dfb57d
+  data.tar.gz: 588a781e7776ca3adf309ba1a1eb6b4668c1767927e832c05963c31c85bacd0aee11b68df6e5d930dae7911b5fca663c48806c90ff8e8f53ecd139aa3753db50

data/ChangeLog

@@ -1,4 +1,5 @@
-For any further change descriptions, see the Git logs.
+This change log is no longer maintaned. For further change descriptions,
+see the Git logs.
 
 2007-12-11  Jim Menard  <jim@iamplify.com>
 

data/Credits

@@ -29,7 +29,7 @@ Jari Williamsson <jari.williamsson@mailbox.swipnet.se>
 Noah Thorp
 
     Found a bug in the code intended to make midilib work under Ruby 1.9.
-    Found another bug in KeySing.data_as_bytes.
+    Found another bug in KeySig.data_as_bytes.
 
 Zach Chadwick (zachad on Github)
 
@@ -48,9 +48,46 @@ Shai Rosenfeld (shaiguitar on Github)
 J (dark-panda on Github)
 
     Instead of monkeypatching ::Array, put sorting methods into new
-    MIDI::Array subclass to avoid clashes with Rails app.
+    MIDI::Array subclass to avoid clashes with Rails apps.
 
 Lucas lfzawacki (lfzawacki on Github)
 
     Found a bug in the MIDI::IO::SeqReader class: the pitch_bend method's
     msb and lsb parameters were reversed.
+
+Parki <parki06780678@gmail.com>
+
+    Reported failure of install.rb with newer versions of Ruby due to use of
+    old 'ftools' standard library component.
+
+Adam Murray (adamjmurray on Github)
+
+    Submitted a patch that avoids writing empty data when writing tracks.
+
+@dylee on Github
+
+    Submitted a patch that improves key signature event code and to_s.
+
+@willm on Github
+
+    Suggested that Sequence.length_to_delta round the result instead of
+    truncating it.
+
+@kaorukobo on Github
+
+    Fixed a bug where the delta offset of META_SEQ_NAME and META_COPYRIGHT
+    events were incorrectly always set to 0. The delta time may be any
+    value (although META_COPYRIGHT should normally be 0).
+
+@rhelsing on Github
+
+    Added the ability to save MIDI format 0 files.
+
+Miika Alonen (@amiika on Github)
+
+    Updated midilib for Ruby 2.7 and 3.0 by using blocks instead of Proc
+    objects and changing require to require_relative where appropriate.
+
+@johnkolen on Github
+
+    Pointed out incorrect values for CC_GEN_PURPOSE_{5,6,7,8}.

data/README.rdoc

@@ -8,7 +8,7 @@ http://github.com/jimm/midilib and the RubyGems.org page is
 http://rubygems.org/gems/midilib, where you can also find all the RDoc
 documentation.
 
-midilib is compatible with Ruby 1.8.x 1.9.x, and 2.x.
+midilib is compatible with Ruby 2.6 and higher.
 
 
 == Dependencies
@@ -55,10 +55,9 @@ runs all of the tests in the test directory.
 
 == Overview
 
-The midilib MIDI file reader only understands MIDI file format 1, where a
-sequence is made up of multiple tracks. It doesn't yet understand format 0
-(a single track containing all events) or format 2 (a collection of format 0
-files in one file).
+midilib can read and write MIDI file formats 0 (one single track) or 1
+multiple tracks. By default, it writes format 1 which is the most common
+format. MIDI file format 2 is not yet supported.
 
 === MIDI::Sequence
 
@@ -290,7 +289,7 @@ information. Though the first edition book is available online, I encourage
 you to purchase a copy of the latest edition.
 
 A description of the MIDI file format can be found in a few places such as
-http://www.borg.com/~jglatt/tech/midifile.htm.
+https://www.csie.ntu.edu.tw/~r92092/ref/midi/.
 
 The MIDI message reference at http://www.jimmenard.com/midi_ref.html
 describes the format of MIDI commands.

data/Rakefile

@@ -1,53 +1,46 @@
 require 'rubygems'
 require 'rake'
-if RUBY_VERSION >= '1.9'
-  require 'rdoc/task'
-  require 'rubygems/package_task'
-  require 'rake/testtask'
-else
-require 'rake/rdoctask'
-  require 'rake/gempackagetask'
-  require 'rake/runtest'
-end
+require 'rdoc/task'
+require 'rubygems/package_task'
+require 'rake/testtask'
 
 PROJECT_NAME = 'midilib'
 RDOC_DIR = 'html'
 
 PKG_FILES = FileList[ 'ChangeLog', 'Credits', 'Rakefile',
-    'README.rdoc', 'TODO.rdoc',
-    'examples/**/*',
-    'html/**/*',
-    'install.rb',
-    'lib/**/*.rb',
-    'test/**/*']
+                      'README.rdoc', 'TODO.rdoc',
+                      'examples/**/*',
+                      'html/**/*',
+                      'install.rb',
+                      'lib/**/*.rb',
+                      'test/**/*']
 
-task :default => [:package]
+task default: [:package]
 
 spec = Gem::Specification.new do |s|
-    s.platform = Gem::Platform::RUBY
-    s.name = PROJECT_NAME
-    s.version = `ruby -Ilib -e 'require "midilib/info"; puts MIDI::Version'`.strip
-    s.requirements << 'none'
+  s.platform = Gem::Platform::RUBY
+  s.name = PROJECT_NAME
+  s.version = `ruby -Ilib -e 'require "midilib/info"; puts MIDI::Version'`.strip
+  s.requirements << 'none'
 
-    s.require_path = 'lib'
+  s.require_path = 'lib'
 
-    s.files = PKG_FILES.to_a
+  s.files = PKG_FILES.to_a
 
-    s.has_rdoc = true
-    s.rdoc_options << '--main' << 'README.rdoc'
-    s.extra_rdoc_files = ['README.rdoc', 'TODO.rdoc']
+  s.rdoc_options << '--main' << 'README.rdoc'
+  s.extra_rdoc_files = ['README.rdoc', 'TODO.rdoc']
 
-    s.author = 'Jim Menard'
-    s.email = 'jim@jimmenard.com'
-    s.homepage = 'http://github.com/jimm/midilib'
-    s.rubyforge_project = PROJECT_NAME
-    s.license = 'Ruby'
+  s.author = 'Jim Menard'
+  s.email = 'jim@jimmenard.com'
+  s.homepage = 'http://github.com/jimm/midilib'
+  s.rubyforge_project = PROJECT_NAME
+  s.license = 'Ruby'
 
-    s.summary = "MIDI file and event manipulation library"
-    s.description = <<EOF
-midilib is a pure Ruby MIDI library useful for reading and
-writing standard MIDI files and manipulating MIDI event data.
-EOF
+  s.summary = 'MIDI file and event manipulation library'
+  s.description = <<~EOF
+    midilib is a pure Ruby MIDI library useful for reading and
+    writing standard MIDI files and manipulating MIDI event data.
+  EOF
 end
 
 if RUBY_VERSION >= '1.9'
@@ -67,24 +60,18 @@ else
 end
 
 # creates an "rdoc" task
-Rake::RDocTask.new do | rd |
-    rd.main = 'README.rdoc'
-    rd.title = PROJECT_NAME
-    rd.rdoc_files.include('README.rdoc', 'TODO.rdoc', 'lib/**/*.rb')
+Rake::RDocTask.new do |rd|
+  rd.main = 'README.rdoc'
+  rd.title = PROJECT_NAME
+  rd.rdoc_files.include('README.rdoc', 'TODO.rdoc', 'lib/**/*.rb')
 end
 
-desc "Publish gem"
-task :publish => [:rdoc, :package] do
+desc 'Publish gem'
+task publish: %i[rdoc package] do
   version = `ruby -Ilib -e 'require "midilib/info"; puts MIDI::Version'`.strip
   system "gem push pkg/midilib-#{version}.gem"
 end
 
-if RUBY_VERSION >= '1.9'
-  Rake::TestTask.new
-else
-  task :test do
-    Rake::run_tests
-  end
-end
+Rake::TestTask.new
 
-task :clean => [:clobber_rdoc, :clobber_package]
+task clean: %i[clobber_rdoc clobber_package]

data/TODO.rdoc

@@ -1,6 +1,17 @@
 == Bugs
 
-No known bugs. (If that's not a challenge, I don't know what is.)
+midilib does not handle tempo changes when calculating +beats_per_minute+.
+The tempo events are correctly handled when reading/writing/moving them
+around, it's just the functions that answer questions about the current
+tempo that are wrong. See https://github.com/jimm/midilib/issues/8. The
+method +beats_per_minute+ and related methods like +pulses_to_seconds+ will
+have to take into account the possibility of more than one tempo event. They
+will probably have to take new arguments specifying where in the sequence
+the beats or pulses are being requested. For example we could have
++beats_per_minute(at_seconds: 0.0, at_beat: 0.0)+ (where the two keyword
+args are mutually exclusive). Perhaps there should be separately named
+public methods like +beats_per_minute_at_seconds+ and
++beats_per_minute_at_beat+ as well.
 
 == Features
 
@@ -15,7 +26,7 @@ No known bugs. (If that's not a challenge, I don't know what is.)
 
 * Implement key signature in SeqReader.
 
-* Format 0 files.
+* Ignore unknown chunks in MIDI files. See the MIDI file spec.
 
 * Format 2 files(?).
 

data/examples/from_scratch.rb

@@ -14,7 +14,7 @@ require 'midilib/sequence'
 require 'midilib/consts'
 include MIDI
 
-seq = Sequence.new()
+seq = Sequence.new
 
 # Create a first track for the sequence. This holds tempo events and stuff
 # like that.

data/examples/measures_mbt.rb

@@ -13,18 +13,18 @@ $LOAD_PATH[0, 0] = File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'midilib/sequence'
 
-seq = MIDI::Sequence.new()
-File.open(ARGV[0], 'rb') { | file | seq.read(file) }
+seq = MIDI::Sequence.new
+File.open(ARGV[0], 'rb') { |file| seq.read(file) }
 
 # Get all measures, so events can be mapped to measures:
 measures = seq.get_measures
 
-seq.each { |track|
-  track.each { |e|
-    if e.kind_of?(MIDI::NoteOn) then
-      # Print out start of notes
-      e.print_note_names = true
-      puts measures.to_mbt(e) + "  ch #{e.channel}:  #{e.note_to_s}"
-    end
-  }
-}
+seq.each do |track|
+  track.each do |e|
+    next unless e.is_a?(MIDI::NoteOn)
+
+    # Print out start of notes
+    e.print_note_names = true
+    puts measures.to_mbt(e) + "  ch #{e.channel}:  #{e.note_to_s}"
+  end
+end

data/examples/print_program_changes.rb

@@ -9,7 +9,7 @@ require 'midilib/sequence'
 DEFAULT_MIDI_TEST_FILE = 'NoFences.mid'
 
 # Read from MIDI file
-seq = MIDI::Sequence.new()
+seq = MIDI::Sequence.new
 
 File.open(ARGV[0] || DEFAULT_MIDI_TEST_FILE, 'rb') do |file|
   # The block we pass in to Sequence.read is called at the end of every
@@ -23,6 +23,6 @@ seq.each do |track|
   track.each do |e|
     e.print_decimal_numbers = true
     e.print_channel_numbers_from_one = true
-    puts e if e.kind_of?(MIDI::ProgramChange)
+    puts e if e.is_a?(MIDI::ProgramChange)
   end
 end

data/examples/reader2text.rb

@@ -20,18 +20,17 @@ require 'midilib/io/midifile'
 DEFAULT_MIDI_TEST_FILE = 'NoFences.mid'
 
 class TextTranslator < MIDI::IO::MIDIFile
-
-  def initialize(seq, proc = nil)
+  def initialize(seq, &block)
     super()
     @seq = seq
     @track = nil
-    @update_block = block_given?() ? Proc.new() : proc
+    @update_block = block
   end
 
   # Generate a unique number for a channel/note combination. This is used
   # to remember pending note on events.
   def note_hash(chan, note)
-    return (chan << 8) + note
+    (chan << 8) + note
   end
 
   # Print a delta time.
@@ -43,27 +42,29 @@ class TextTranslator < MIDI::IO::MIDIFile
 
   def header(format, ntrks, division)
     puts "header: format = #{format}, ntrks = #{ntrks}," +
-      " division = #{division}"
+         " division = #{division}"
 
     @ntrks = ntrks
     @update_block.call(nil, @ntrks, 0) if @update_block
   end
 
-  def start_track()
-    pdelta()
-    puts "track start"
+  def start_track
+    pdelta
+    puts 'track start'
 
     @pending = []
     @chan_mask = 0
   end
 
-  def end_track()
-    pdelta()
+  def end_track
+    pdelta
     puts "track end; chans used bitmask = #{@chan_mask}"
     # Write message for any pending note on messages
     @pending.each_with_index do |num, chan|
-      puts "pending note off missing for chan #{num >> 8}," +
-      " note #{num & 0xff}" if note_obj
+      if note_obj
+        puts "pending note off missing for chan #{num >> 8}," +
+             " note #{num & 0xff}"
+      end
     end
     @pending = nil
 
@@ -72,9 +73,9 @@ class TextTranslator < MIDI::IO::MIDIFile
   end
 
   def note_on(chan, note, vel)
-    pdelta()
+    pdelta
     if vel == 0
-      print "(note on, vel 0) "
+      print '(note on, vel 0) '
       note_off(chan, note, 64)
       return
     end
@@ -85,73 +86,73 @@ class TextTranslator < MIDI::IO::MIDIFile
   end
 
   def note_off(chan, note, vel)
-    pdelta()
+    pdelta
     # Find note on, create note off, connect the two, and remove
     # note on from pending list.
     pnum = note_hash(chan, note)
     @pending.each_with_index do |num, i|
-      if pnum == num
-        puts "note off chan #{chan}, note #{note}, vel #{vel}"
-        @pending.delete_at(i)
-        return
-      end
+      next unless pnum == num
+
+      puts "note off chan #{chan}, note #{note}, vel #{vel}"
+      @pending.delete_at(i)
+      return
     end
     puts "note off with no earlier note on (ch #{chan}, note" +
-      " #{note}, vel #{vel})"
+         " #{note}, vel #{vel})"
   end
 
   def pressure(chan, note, press)
-    pdelta()
+    pdelta
     puts "pressure chan #{chan}, note #{note}, press #{press}"
     track_uses_channel(chan)
   end
 
   def controller(chan, control, value)
-    pdelta()
+    pdelta
     puts "controller chan #{chan}, control #{control}, value #{value}"
     track_uses_channel(chan)
   end
 
   def pitch_bend(chan, msb, lsb)
-    pdelta()
+    pdelta
     puts "pitch bend chan #{chan}, msb #{msb}, lsb #{lsb}"
     track_uses_channel(chan)
   end
 
   def program(chan, program)
-    pdelta()
+    pdelta
     puts "program chan #{chan}, program #{program}"
     track_uses_channel(chan)
   end
 
   def chan_pressure(chan, press)
-    pdelta()
+    pdelta
     puts "chan press chan #{chan}, press #{press}"
     track_uses_channel(chan)
   end
 
   def sysex(msg)
-    pdelta()
+    pdelta
     puts "sysex size #{msg.length}"
   end
 
   def meta_misc(type, msg)
-    pdelta()
+    pdelta
     puts "meta misc type #{type}, length #{msg.length}"
   end
 
   def sequencer_specific(type, msg)
-    pdelta()
+    pdelta
     puts "sequencer specific type #{type}, msg #{msg.length}"
   end
 
   def sequence_number(num)
-    pdelta()
+    pdelta
     puts "sequence number #{num}"
   end
 
   def text(type, msg)
-    pdelta()
+    pdelta
     msg = MIDI::MetaEvent.bytes_as_str(msg)
     case type
     when MIDI::META_SEQ_NAME
@@ -165,54 +166,53 @@ class TextTranslator < MIDI::IO::MIDIFile
     end
   end
 
-  def eot()
-    pdelta()
-    puts "end of track event"
+  def eot
+    pdelta
+    puts 'end of track event'
   end
 
   def time_signature(numer, denom, clocks, qnotes)
-    pdelta()
+    pdelta
     puts "time sig numer #{numer}, denom #{denom}, clocks #{clocks}," +
-      " qnotes #{qnotes}"
+         " qnotes #{qnotes}"
   end
 
   def smpte(hour, min, sec, frame, fract)
-    pdelta()
+    pdelta
     puts "smpte #{hour}:#{min}.#{sec}, frame #{frame}, fract #{fract}"
   end
 
   def tempo(microsecs)
-    pdelta()
-    bpm = 1.0 / microsecs	# quarter notes per microsecond
-    bpm *= 1000000.0	# quarter notes per second
-    bpm *= 60.0		# quarter notes per minute
+    pdelta
+    bpm = 1.0 / microsecs # quarter notes per microsecond
+    bpm *= 1_000_000.0 # quarter notes per second
+    bpm *= 60.0 # quarter notes per minute
     puts "tempo microsecs pqn = #{microsecs} (#{bpm} bpm)"
   end
 
   def key_signature(sharpflat, is_minor)
-    pdelta()
+    pdelta
     puts "key sig sharpflat #{sharpflat}, is_minor #{is_minor}"
   end
 
   def arbitrary(msg)
-    pdelta()
+    pdelta
     puts "arbitrary length = #{msg.length}"
   end
 
   def track_uses_channel(chan)
-    @chan_mask = @chan_mask | (1 << chan)
+    @chan_mask |= (1 << chan)
   end
-
 end
 
 # ================================================================
 
-seq = MIDI::Sequence.new()
+seq = MIDI::Sequence.new
 
 # Specify what class to use when reading the MIDI file.
 seq.reader_class = TextTranslator
 
-File.open(ARGV[0] || DEFAULT_MIDI_TEST_FILE, 'rb') do | file |
+File.open(ARGV[0] || DEFAULT_MIDI_TEST_FILE, 'rb') do |file|
   # The block we pass in to Sequence.read is called at the end of every
   # track read. It is optional, but is useful for progress reports.
   seq.read(file) do |track, num_tracks, i|

data/examples/seq2text.rb

@@ -19,7 +19,7 @@ require 'midilib/sequence'
 DEFAULT_MIDI_TEST_FILE = 'NoFences.mid'
 
 # Read from MIDI file
-seq = MIDI::Sequence.new()
+seq = MIDI::Sequence.new
 
 File.open(ARGV[0] || DEFAULT_MIDI_TEST_FILE, 'rb') do |file|
   # The block we pass in to Sequence.read is called at the end of every

data/examples/split.rb

@@ -27,7 +27,7 @@ if filename == '-x'
 end
 
 # Read from MIDI file
-seq = MIDI::Sequence.new()
+seq = MIDI::Sequence.new
 
 File.open(filename || DEFAULT_MIDI_TEST_FILE, 'rb') do |file|
   # The block we pass in to Sequence.read is called at the end of every
@@ -41,12 +41,13 @@ t0 = seq.tracks[0]
 unless include_tempo_track
   s = MIDI::Sequence.new
   s.tracks << t0
-  File.open("tempo_track.mid", 'wb') { | file | s.write(file) }
+  File.open('tempo_track.mid', 'wb') { |file| s.write(file) }
 end
 seq.each_with_index do |track, i|
   next unless i > 0
+
   s = MIDI::Sequence.new
   s.tracks << t0 if include_tempo_track
   s.tracks << track
-  File.open("#{track.name}.mid", 'wb') { | file | s.write(file) }
+  File.open("#{track.name}.mid", 'wb') { |file| s.write(file) }
 end

data/examples/strings.rb

@@ -15,7 +15,7 @@ require 'midilib/consts'
 
 DEFAULT_MIDI_TEST_FILE = 'NoFences.mid'
 
-seq = MIDI::Sequence.new()
+seq = MIDI::Sequence.new
 File.open(ARGV[0] || DEFAULT_MIDI_TEST_FILE, 'rb') do |file|
   # The block we pass in to Sequence.read is called at the end of every
   # track read. It is optional, but is useful for progress reports.
@@ -27,8 +27,8 @@ end
 include MIDI
 seq.each do |track|
   track.each do |event|
-    puts event.data if event.kind_of?(MIDI::MetaEvent) &&
-    [META_TEXT, META_COPYRIGHT, META_SEQ_NAME, META_INSTRUMENT,
-      META_LYRIC, META_CUE, META_MARKER].include?(event.meta_type)
+    puts event.data if event.is_a?(MIDI::MetaEvent) &&
+                       [META_TEXT, META_COPYRIGHT, META_SEQ_NAME, META_INSTRUMENT,
+                        META_LYRIC, META_CUE, META_MARKER].include?(event.meta_type)
   end
 end