midilib 2.0.2 → 3.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7b4ef36d4f1d38a6f2c2bbf00fc34e7400822ab5f3f05242296bb383bf7cd35
+  data.tar.gz: e814f94bccbf648fb8ef7035551996673f6991114000ca7c7199c26cdee0d913
+SHA512:
+  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,4 +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

@@ -1,16 +1,14 @@
 = midilib
 
 midilib is a pure Ruby MIDI library useful for reading and writing standard
-MIDI files and manipulating MIDI event data. Classes include MIDI::Sequence,
-MIDI::Track, MIDI::Event, and MIDI::IO::MIDIFile and its subclasses
-MIDI::IO::SeqReader and MIDI::IO::SeqWriter.
+MIDI files and manipulating MIDI event data.
 
 The GitHub project page and Web site of midilib is
 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 both Ruby 1.8.x and 1.9.x.
+midilib is compatible with Ruby 2.6 and higher.
 
 
 == Dependencies
@@ -31,11 +29,10 @@ which requires Rake (http://rake.rubyforge.org).
 To install midilib as a gem, type
 
     % gem install midilib
-or
+or, if you already have a previous version, use
     % gem update midilib
 
-if you already have a previous version. You may need root privileges to
-install or update the gem.
+You may need root privileges to install or update the gem.
 
 === Manual Installation
 
@@ -58,10 +55,9 @@ runs all of the tests in the test directory.
 
 == Overview
 
-MIDI file IO 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
 
@@ -293,10 +289,10 @@ 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.io.com/~jimm/midi_ref.html describes
-the format of MIDI commands.
+The MIDI message reference at http://www.jimmenard.com/midi_ref.html
+describes the format of MIDI commands.
 
 
 = To Do
@@ -317,7 +313,7 @@ the format of MIDI commands.
 = Administrivia
 
 Author:: Jim Menard (mailto:jim@jimmenard.com)
-Copyright:: Copyright (c) 2003-2012 Jim Menard
+Copyright:: Copyright (c) 2003-2013 Jim Menard
 License:: Distributed under the same license as Ruby.
 
 
@@ -330,16 +326,29 @@ 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-2012 by Jim Menard.
+midilib is Copyright (c) 2003-2013 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
+== Recent Changes
 
-==== Changes for 2.0.0:
+=== 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.
@@ -368,51 +377,51 @@ 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:
+=== 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
+=== New code repository
 
 The midilib code is now hosted at Github (http://github.com/jimm/midilib).
 
-==== Changes for 1.1.4:
+=== 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:
+=== Changes for 1.1.3:
 
 * Fixed the way midilib detects the behavior of IO.getc.
 
-==== Changes for 1.1.2:
+=== 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:
+=== 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:
+=== 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:
+=== Changes for 1.0.0:
 
 * Fixed the bug in Track#recalc_delta_from_times found by Christopher Rose.
 
-==== Changes for 0.8.7:
+=== Changes for 0.8.7:
 
 * Fixed the misspelled POLY_PRESSURE constant, thanks to Mario Pehle.
 
-==== Changes for 0.8.6:
+=== Changes for 0.8.6:
 
 * Added missing test/test.mid.
 
-==== Changes for 0.8.5:
+=== Changes for 0.8.5:
 
 * Fixed bugs in MIDI::PitchBend reading and writing, thanks to Emanuel
   Borsboom.
@@ -425,7 +434,7 @@ The midilib code is now hosted at Github (http://github.com/jimm/midilib).
   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:
+=== Changes for 0.8.4:
 
 * Realtime status bytes now set @is_realtime to true and return true when
   realtime? is called.
@@ -442,7 +451,7 @@ The midilib code is now hosted at Github (http://github.com/jimm/midilib).
   MIDI::Sequence::note_to_delta.
 
 
-==== Changes for 0.8.3:
+=== Changes for 0.8.3:
 
 * Added MIDI::NoteEvent.note_to_s, which returns note name as a string like
   "C4" or "F#6".
@@ -451,7 +460,7 @@ The midilib code is now hosted at Github (http://github.com/jimm/midilib).
   @print_note_names. These are used by all Event to_s methods. See
   examples/seq2text.rb for an example.
 
-==== Changes for 0.8.2:
+=== Changes for 0.8.2:
 
 * Changed MIDI::MetaEvent.type to MIDI::MetaEvent.event_type to avoid
   runtime complaints about Object#type calls.
@@ -460,7 +469,7 @@ The midilib code is now hosted at Github (http://github.com/jimm/midilib).
 * Fixed read and write block arguments.
 * Fixed other example script bugs.
 
-==== Changes for 0.8.1:
+=== Changes for 0.8.1:
 
 * Fixed track sorting.
 * Fixed track's recalc_delta_from_times method.

data/Rakefile

@@ -1,52 +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.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'
@@ -66,29 +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 do |t|
-    t.libs << File.join(File.dirname(__FILE__), 'test')
-    t.libs << File.join(File.dirname(__FILE__), 'lib')
-    t.ruby_opts << '-rubygems'
-    t.pattern = "test/**/test_*.rb"
-  end
-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.
@@ -40,10 +40,10 @@ track.events << Controller.new(0, CC_VOLUME, 127)
 # delta time length of a single quarter note.
 track.events << ProgramChange.new(0, 1, 0)
 quarter_note_length = seq.note_to_delta('quarter')
-[0, 2, 4, 5, 7, 9, 11, 12].each { | offset |
+[0, 2, 4, 5, 7, 9, 11, 12].each do |offset|
   track.events << NoteOn.new(0, 64 + offset, 127, 0)
   track.events << NoteOff.new(0, 64 + offset, 127, quarter_note_length)
-}
+end
 
 # Calling recalc_times is not necessary, because that only sets the events'
 # start times, which are not written out to the MIDI file. The delta times are
@@ -51,6 +51,4 @@ quarter_note_length = seq.note_to_delta('quarter')
 
 # track.recalc_times
 
-File.open('from_scratch.mid', 'wb') { | file |
-	seq.write(file)
-}
+File.open('from_scratch.mid', 'wb') { |file| seq.write(file) }

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,20 +9,20 @@ 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') { | 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)
-}
+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)
+end
 
-seq.each { | track |
+seq.each do |track|
   puts
   puts "*** track name \"#{track.name}\", \"#{track.instrument}\""
-  track.each { | e |
+  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