midilib 1.0.0 → 1.1.1

data/ChangeLog

@@ -1,3 +1,26 @@
+2007-12-11  Jim Menard  <jim@iamplify.com>
+
+	* lib/midilib/io/seqreader.rb: Fixed text method and added default
+	implementation of key_signature.
+
+2007-12-09  Jim Menard  <jim@iamplify.com>
+
+	* examples/measures_mbt.rb: Added.
+
+2007-12-09  Jim Menard  <jim@iamplify.com>
+
+	* lib/midilib/event.rb: Added code that fixes bpm calculation
+	bugs, and his TimeSig and KeySig classes.
+
+	* lib/midilib/measure.rb: Added.
+
+	* lib/midilib/sequence.rb: Fixed clock. Added get_measures method.
+
+2007-12-09  Jim Menard  <jim@iamplify.com>
+
+	* lib/midilib/event.rb: added program_change? and
+	print_channel_numbers_from_one to Event.
+
 2007-03-17  Jim Menard  <jimm@io.com>
 
 	* Version 1.0.0 released. I will no longer be maintaining this

data/Credits

@@ -19,3 +19,9 @@ Emanuel Borsboom <emanuel.borsboom@gmail.com>
 Christopher Rose <cmr@synopsys.com>
 
     Found bug in Track#recalc_delta_from_times.
+
+Jari Williamsson <jari.williamsson@mailbox.swipnet.se>
+
+    Contributed Measure and Measures, TimeSig and KeySig, and fixes to events.
+    Added get_measures to Sequence. Added default implementaiton of
+    key_signature in SeqReader. Contributed the measures_mbt.rb example.

data/README

@@ -92,6 +92,24 @@ This bit mask is set when the track is read from the MIDI file by a SeqReader
 but is _not_ kept up to date by any other methods. Specifically, if you add
 events to a track at any other time, the bit mask will not be updated.
 
+=== MIDI::Measure
+
+This class contains information about a measure from the sequence. Measure
+data is based on the time signature information from the sequence and is not
+stored in the sequence itself.
+
+=== MIDI::Measures
+
+The class MIDI::Sequence method get_measures returns a MIDI::Measures object.
+MIDI::Measures is a subclass of Array. It is a specialized container for
+MIDI::Measure objects, which can be use to map event times to measure numbers.
+Please note that this object has to be remade when events are deleted/added in
+the sequence.
+
+MIDI::Measure and MIDI::Measures are brought to us by Jari Williamsson
+<jari.williamsson@mailbox.swipnet.se>, who also contributed some improvements
+to the MIDI::Event and MIDI::Track classes.
+
 === MIDI::Event
 
 Each event holds not only its delta time but also its time from the start of
@@ -99,7 +117,12 @@ the track. The track is responsible for recalculating its events' start times.
 You can call MIDI::Track#recalc_times to do so.
 
 Events have a number of boolean methods that identify their types, like
-channel?, note?, note_on?, note_off?, meta?, system?, and realtime?.
+channel?, note?, note_on?, note_off?, meta?, system?, realtime?, and
+program_change?. Events know how to print themselves. By default, all numbers
+are printed as hexidecimal and channel numbers are printed from 0-15. Setting
+print_decimal_numbers to true will output decimal numbers and setting
+print_channel_numbers_from_one will output channel numbers from 1-16.
+
 
 Subclasses of MIDI::Event implement the various MIDI messages such as note on
 and off, controller values, system exclusive data, and realtime bytes.
@@ -315,6 +338,15 @@ non-commercial purposes as long as the author is given credit.
 
 === Recent Changes
 
+==== Changes for 1.1.1:
+
+* Mak 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.

data/Rakefile

@@ -14,7 +14,7 @@ PKG_FILES = FileList[ 'ChangeLog', 'Credits', 'README', 'Rakefile', 'TODO',
     'html/**/*',
     'install.rb',
     'lib/**/*.rb',
-    'test/**/*.rb']
+    'test/**/*']
 
 task :default => [:package]
 

data/examples/measures_mbt.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+#
+# usage: measure_mbt.rb midi_file
+#
+# This program loads a sequences and prints out all start-of-notes
+# 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'
+
+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.note_on? then
+      # Print out start of notes
+      e.print_note_names = true
+      puts measures.to_mbt(e) + "  ch #{e.channel}:  #{e.note_to_s}"
+    end        
+  }    
+}

data/examples/print_program_changes.rb

@@ -0,0 +1,28 @@
+#! /usr/bin/env ruby
+#
+# 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'
+
+DEFAULT_MIDI_TEST_FILE = 'NoFences.mid'
+
+# Read from MIDI file
+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)
+}
+
+seq.each { | track |
+  puts
+  puts "*** track name \"#{track.name}\", \"#{track.instrument}\""
+  track.each { | e |
+    e.print_decimal_numbers = true
+    e.print_channel_numbers_from_one = true
+    puts e if e.program_change?
+  }
+}

data/html/classes/MIDI/ActiveSense.html

@@ -0,0 +1,156 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: MIDI::ActiveSense</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">MIDI::ActiveSense</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/midilib/event_rb.html">
+                lib/midilib/event.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="Realtime.html">
+                Realtime
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000157">new</a>&nbsp;&nbsp;
+      <a href="#M000158">to_s</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000157" class="method-detail">
+        <a name="M000157"></a>
+
+        <div class="method-heading">
+          <a href="ActiveSense.src/M000157.html" target="Code" class="method-signature"
+            onclick="popupCode('ActiveSense.src/M000157.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(delta_time = 0)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000158" class="method-detail">
+        <a name="M000158"></a>
+
+        <div class="method-heading">
+          <a href="ActiveSense.src/M000158.html" target="Code" class="method-signature"
+            onclick="popupCode('ActiveSense.src/M000158.html');return false;">
+          <span class="method-name">to_s</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/html/classes/MIDI/ActiveSense.src/M000157.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>new (MIDI::ActiveSense)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/midilib/event.rb, line 464</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">delta_time</span> = <span class="ruby-value">0</span>)
+        <span class="ruby-keyword kw">super</span>(<span class="ruby-constant">ACTIVE_SENSE</span>, <span class="ruby-identifier">delta_time</span>)
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/html/classes/MIDI/ActiveSense.src/M000158.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>to_s (MIDI::ActiveSense)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/midilib/event.rb, line 467</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">super</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;act sens&quot;</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/html/classes/MIDI/ChannelEvent.html

@@ -0,0 +1,179 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: MIDI::ChannelEvent</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">MIDI::ChannelEvent</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/midilib/event_rb.html">
+                lib/midilib/event.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="Event.html">
+                Event
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+The abstract superclass of all channel events (events that have a <a
+href="../MIDI.html">MIDI</a> channel, like notes and program changes).
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000129">new</a>&nbsp;&nbsp;
+      <a href="#M000130">to_s</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">channel</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc">
+<a href="../MIDI.html">MIDI</a> channel, 0-15.
+
+</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000129" class="method-detail">
+        <a name="M000129"></a>
+
+        <div class="method-heading">
+          <a href="ChannelEvent.src/M000129.html" target="Code" class="method-signature"
+            onclick="popupCode('ChannelEvent.src/M000129.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(status, channel, delta_time)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000130" class="method-detail">
+        <a name="M000130"></a>
+
+        <div class="method-heading">
+          <a href="ChannelEvent.src/M000130.html" target="Code" class="method-signature"
+            onclick="popupCode('ChannelEvent.src/M000130.html');return false;">
+          <span class="method-name">to_s</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/html/classes/MIDI/ChannelEvent.src/M000129.html

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>new (MIDI::ChannelEvent)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/midilib/event.rb, line 148</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">status</span>, <span class="ruby-identifier">channel</span>, <span class="ruby-identifier">delta_time</span>)
+        <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">status</span>, <span class="ruby-identifier">delta_time</span>)
+        <span class="ruby-ivar">@channel</span> = <span class="ruby-identifier">channel</span>
+        <span class="ruby-ivar">@is_channel</span> = <span class="ruby-keyword kw">true</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/html/classes/MIDI/ChannelEvent.src/M000130.html

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+  <title>to_s (MIDI::ChannelEvent)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/midilib/event.rb, line 155</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_s</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">super</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;ch #{channel_to_s(@channel)} &quot;</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>