RubyGems - midilib - Versions diffs - 0.8.4 - Mend

midilib 0.8.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (252) hide show

data/ChangeLog +87 -0
data/Credits +8 -0
data/README +361 -0
data/Rakefile +68 -0
data/TODO +25 -0
data/examples/NoFences.mid +0 -0
data/examples/from_scratch.mid +0 -0
data/examples/from_scratch.rb +56 -0
data/examples/reader2text.rb +220 -0
data/examples/seq2text.rb +41 -0
data/examples/strings.rb +34 -0
data/examples/transpose.rb +75 -0
data/html/classes/MIDI.html +738 -0
data/html/classes/MIDI/ActiveSense.html +156 -0
data/html/classes/MIDI/ActiveSense.src/M000136.html +18 -0
data/html/classes/MIDI/ActiveSense.src/M000137.html +18 -0
data/html/classes/MIDI/ChannelEvent.html +179 -0
data/html/classes/MIDI/ChannelEvent.src/M000124.html +20 -0
data/html/classes/MIDI/ChannelEvent.src/M000125.html +18 -0
data/html/classes/MIDI/ChannelPressure.html +184 -0
data/html/classes/MIDI/ChannelPressure.src/M000088.html +19 -0
data/html/classes/MIDI/ChannelPressure.src/M000089.html +21 -0
data/html/classes/MIDI/ChannelPressure.src/M000090.html +18 -0
data/html/classes/MIDI/Clock.html +156 -0
data/html/classes/MIDI/Clock.src/M000134.html +18 -0
data/html/classes/MIDI/Clock.src/M000135.html +18 -0
data/html/classes/MIDI/Continue.html +156 -0
data/html/classes/MIDI/Continue.src/M000132.html +18 -0
data/html/classes/MIDI/Continue.src/M000133.html +18 -0
data/html/classes/MIDI/Controller.html +189 -0
data/html/classes/MIDI/Controller.src/M000129.html +21 -0
data/html/classes/MIDI/Controller.src/M000130.html +22 -0
data/html/classes/MIDI/Controller.src/M000131.html +18 -0
data/html/classes/MIDI/Event.html +424 -0
data/html/classes/MIDI/Event.src/M000145.html +27 -0
data/html/classes/MIDI/Event.src/M000146.html +18 -0
data/html/classes/MIDI/Event.src/M000147.html +18 -0
data/html/classes/MIDI/Event.src/M000148.html +18 -0
data/html/classes/MIDI/Event.src/M000149.html +18 -0
data/html/classes/MIDI/Event.src/M000150.html +18 -0
data/html/classes/MIDI/Event.src/M000151.html +18 -0
data/html/classes/MIDI/Event.src/M000152.html +18 -0
data/html/classes/MIDI/Event.src/M000153.html +18 -0
data/html/classes/MIDI/Event.src/M000154.html +22 -0
data/html/classes/MIDI/Event.src/M000155.html +18 -0
data/html/classes/MIDI/Event.src/M000156.html +18 -0
data/html/classes/MIDI/Event.src/M000157.html +18 -0
data/html/classes/MIDI/IO.html +121 -0
data/html/classes/MIDI/IO/MIDIFile.html +925 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000028.html +22 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000029.html +24 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000030.html +19 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000031.html +19 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000032.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000033.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000034.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000035.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000036.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000037.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000038.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000039.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000040.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000041.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000042.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000043.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000044.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000045.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000046.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000047.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000048.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000049.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000050.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000051.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000052.html +17 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000053.html +43 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000054.html +34 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000055.html +96 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000056.html +18 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000057.html +48 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000058.html +42 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000059.html +19 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000060.html +19 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000061.html +20 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000062.html +21 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000063.html +31 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000064.html +20 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000065.html +22 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000066.html +30 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000067.html +18 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000068.html +20 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000069.html +18 -0
data/html/classes/MIDI/IO/MIDIFile.src/M000070.html +18 -0
data/html/classes/MIDI/IO/SeqReader.html +460 -0
data/html/classes/MIDI/IO/SeqReader.src/M000001.html +22 -0
data/html/classes/MIDI/IO/SeqReader.src/M000002.html +22 -0
data/html/classes/MIDI/IO/SeqReader.src/M000003.html +21 -0
data/html/classes/MIDI/IO/SeqReader.src/M000004.html +34 -0
data/html/classes/MIDI/IO/SeqReader.src/M000005.html +26 -0
data/html/classes/MIDI/IO/SeqReader.src/M000006.html +28 -0
data/html/classes/MIDI/IO/SeqReader.src/M000007.html +21 -0
data/html/classes/MIDI/IO/SeqReader.src/M000008.html +19 -0
data/html/classes/MIDI/IO/SeqReader.src/M000009.html +19 -0
data/html/classes/MIDI/IO/SeqReader.src/M000010.html +19 -0
data/html/classes/MIDI/IO/SeqReader.src/M000011.html +19 -0
data/html/classes/MIDI/IO/SeqReader.src/M000012.html +19 -0
data/html/classes/MIDI/IO/SeqReader.src/M000013.html +18 -0
data/html/classes/MIDI/IO/SeqReader.src/M000014.html +18 -0
data/html/classes/MIDI/IO/SeqReader.src/M000015.html +27 -0
data/html/classes/MIDI/IO/SeqReader.src/M000016.html +18 -0
data/html/classes/MIDI/IO/SeqReader.src/M000017.html +18 -0
data/html/classes/MIDI/IO/SeqReader.src/M000018.html +18 -0
data/html/classes/MIDI/IO/SeqWriter.html +267 -0
data/html/classes/MIDI/IO/SeqWriter.src/M000019.html +19 -0
data/html/classes/MIDI/IO/SeqWriter.src/M000020.html +25 -0
data/html/classes/MIDI/IO/SeqWriter.src/M000021.html +22 -0
data/html/classes/MIDI/IO/SeqWriter.src/M000022.html +54 -0
data/html/classes/MIDI/IO/SeqWriter.src/M000023.html +49 -0
data/html/classes/MIDI/IO/SeqWriter.src/M000024.html +21 -0
data/html/classes/MIDI/IO/SeqWriter.src/M000025.html +19 -0
data/html/classes/MIDI/IO/SeqWriter.src/M000026.html +24 -0
data/html/classes/MIDI/IO/SeqWriter.src/M000027.html +26 -0
data/html/classes/MIDI/Marker.html +139 -0
data/html/classes/MIDI/Marker.src/M000107.html +18 -0
data/html/classes/MIDI/MetaEvent.html +189 -0
data/html/classes/MIDI/MetaEvent.src/M000167.html +21 -0
data/html/classes/MIDI/MetaEvent.src/M000168.html +23 -0
data/html/classes/MIDI/MetaEvent.src/M000169.html +53 -0
data/html/classes/MIDI/NoteEvent.html +233 -0
data/html/classes/MIDI/NoteEvent.src/M000091.html +21 -0
data/html/classes/MIDI/NoteEvent.src/M000092.html +20 -0
data/html/classes/MIDI/NoteEvent.src/M000093.html +18 -0
data/html/classes/MIDI/NoteEvent.src/M000094.html +22 -0
data/html/classes/MIDI/NoteOffEvent.html +169 -0
data/html/classes/MIDI/NoteOffEvent.src/M000086.html +19 -0
data/html/classes/MIDI/NoteOffEvent.src/M000087.html +19 -0
data/html/classes/MIDI/NoteOnEvent.html +169 -0
data/html/classes/MIDI/NoteOnEvent.src/M000102.html +19 -0
data/html/classes/MIDI/NoteOnEvent.src/M000103.html +19 -0
data/html/classes/MIDI/PitchBend.html +184 -0
data/html/classes/MIDI/PitchBend.src/M000104.html +19 -0
data/html/classes/MIDI/PitchBend.src/M000105.html +22 -0
data/html/classes/MIDI/PitchBend.src/M000106.html +18 -0
data/html/classes/MIDI/PolyPressure.html +186 -0
data/html/classes/MIDI/PolyPressure.src/M000170.html +18 -0
data/html/classes/MIDI/PolyPressure.src/M000171.html +18 -0
data/html/classes/MIDI/PolyPressure.src/M000172.html +18 -0
data/html/classes/MIDI/PolyPressure.src/M000173.html +19 -0
data/html/classes/MIDI/ProgramChange.html +184 -0
data/html/classes/MIDI/ProgramChange.src/M000099.html +19 -0
data/html/classes/MIDI/ProgramChange.src/M000100.html +21 -0
data/html/classes/MIDI/ProgramChange.src/M000101.html +18 -0
data/html/classes/MIDI/Realtime.html +171 -0
data/html/classes/MIDI/Realtime.src/M000083.html +19 -0
data/html/classes/MIDI/Realtime.src/M000084.html +20 -0
data/html/classes/MIDI/Realtime.src/M000085.html +18 -0
data/html/classes/MIDI/Sequence.html +469 -0
data/html/classes/MIDI/Sequence.src/M000108.html +28 -0
data/html/classes/MIDI/Sequence.src/M000109.html +21 -0
data/html/classes/MIDI/Sequence.src/M000110.html +22 -0
data/html/classes/MIDI/Sequence.src/M000113.html +18 -0
data/html/classes/MIDI/Sequence.src/M000114.html +27 -0
data/html/classes/MIDI/Sequence.src/M000115.html +18 -0
data/html/classes/MIDI/Sequence.src/M000116.html +19 -0
data/html/classes/MIDI/Sequence.src/M000117.html +19 -0
data/html/classes/MIDI/Sequence.src/M000118.html +20 -0
data/html/classes/MIDI/Sequence.src/M000119.html +19 -0
data/html/classes/MIDI/Sequence.src/M000120.html +18 -0
data/html/classes/MIDI/SongPointer.html +184 -0
data/html/classes/MIDI/SongPointer.src/M000138.html +19 -0
data/html/classes/MIDI/SongPointer.src/M000139.html +22 -0
data/html/classes/MIDI/SongPointer.src/M000140.html +18 -0
data/html/classes/MIDI/SongSelect.html +184 -0
data/html/classes/MIDI/SongSelect.src/M000126.html +19 -0
data/html/classes/MIDI/SongSelect.src/M000127.html +21 -0
data/html/classes/MIDI/SongSelect.src/M000128.html +18 -0
data/html/classes/MIDI/Start.html +156 -0
data/html/classes/MIDI/Start.src/M000097.html +18 -0
data/html/classes/MIDI/Start.src/M000098.html +18 -0
data/html/classes/MIDI/Stop.html +156 -0
data/html/classes/MIDI/Stop.src/M000095.html +18 -0
data/html/classes/MIDI/Stop.src/M000096.html +18 -0
data/html/classes/MIDI/SystemCommon.html +139 -0
data/html/classes/MIDI/SystemCommon.src/M000144.html +19 -0
data/html/classes/MIDI/SystemExclusive.html +184 -0
data/html/classes/MIDI/SystemExclusive.src/M000141.html +19 -0
data/html/classes/MIDI/SystemExclusive.src/M000142.html +23 -0
data/html/classes/MIDI/SystemExclusive.src/M000143.html +18 -0
data/html/classes/MIDI/SystemReset.html +156 -0
data/html/classes/MIDI/SystemReset.src/M000081.html +18 -0
data/html/classes/MIDI/SystemReset.src/M000082.html +18 -0
data/html/classes/MIDI/Tempo.html +250 -0
data/html/classes/MIDI/Tempo.src/M000158.html +18 -0
data/html/classes/MIDI/Tempo.src/M000159.html +18 -0
data/html/classes/MIDI/Tempo.src/M000160.html +18 -0
data/html/classes/MIDI/Tempo.src/M000161.html +18 -0
data/html/classes/MIDI/Tempo.src/M000162.html +18 -0
data/html/classes/MIDI/Tempo.src/M000163.html +25 -0
data/html/classes/MIDI/Tempo.src/M000164.html +18 -0
data/html/classes/MIDI/Track.html +380 -0
data/html/classes/MIDI/Track.src/M000071.html +23 -0
data/html/classes/MIDI/Track.src/M000072.html +21 -0
data/html/classes/MIDI/Track.src/M000073.html +26 -0
data/html/classes/MIDI/Track.src/M000074.html +18 -0
data/html/classes/MIDI/Track.src/M000075.html +22 -0
data/html/classes/MIDI/Track.src/M000076.html +20 -0
data/html/classes/MIDI/Track.src/M000077.html +22 -0
data/html/classes/MIDI/Track.src/M000078.html +22 -0
data/html/classes/MIDI/Track.src/M000079.html +18 -0
data/html/classes/MIDI/Track.src/M000080.html +19 -0
data/html/classes/MIDI/TuneRequest.html +171 -0
data/html/classes/MIDI/TuneRequest.src/M000121.html +18 -0
data/html/classes/MIDI/TuneRequest.src/M000122.html +20 -0
data/html/classes/MIDI/TuneRequest.src/M000123.html +18 -0
data/html/classes/MIDI/Utils.html +190 -0
data/html/classes/MIDI/Utils.src/M000165.html +20 -0
data/html/classes/MIDI/Utils.src/M000166.html +25 -0
data/html/created.rid +1 -0
data/html/files/README.html +599 -0
data/html/files/TODO.html +142 -0
data/html/files/lib/midilib/consts_rb.html +107 -0
data/html/files/lib/midilib/event_rb.html +109 -0
data/html/files/lib/midilib/info_rb.html +101 -0
data/html/files/lib/midilib/io/midifile_rb.html +108 -0
data/html/files/lib/midilib/io/seqreader_rb.html +110 -0
data/html/files/lib/midilib/io/seqwriter_rb.html +115 -0
data/html/files/lib/midilib/sequence_rb.html +109 -0
data/html/files/lib/midilib/track_rb.html +108 -0
data/html/files/lib/midilib/utils_rb.html +101 -0
data/html/files/lib/midilib_rb.html +124 -0
data/html/fr_class_index.html +59 -0
data/html/fr_file_index.html +38 -0
data/html/fr_method_index.html +199 -0
data/html/index.html +24 -0
data/html/rdoc-style.css +208 -0
data/install.rb +57 -0
data/lib/midilib.rb +16 -0
data/lib/midilib/consts.rb +422 -0
data/lib/midilib/event.rb +559 -0
data/lib/midilib/info.rb +9 -0
data/lib/midilib/io/midifile.rb +446 -0
data/lib/midilib/io/seqreader.rb +198 -0
data/lib/midilib/io/seqwriter.rb +151 -0
data/lib/midilib/sequence.rb +144 -0
data/lib/midilib/track.rb +115 -0
data/lib/midilib/utils.rb +36 -0
data/test/event_equality.rb +81 -0
data/test/test_event.rb +116 -0
data/test/test_io.rb +55 -0
data/test/test_sequence.rb +68 -0
data/test/test_track.rb +111 -0
data/test/test_varlen.rb +40 -0
metadata +330 -0

data/html/classes/MIDI/Utils.html ADDED Viewed

@@ -0,0 +1,190 @@
+<?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::Utils</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::Utils</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/midilib/utils_rb.html">
+                lib/midilib/utils.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+Utility methods.
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000166">as_var_len</a>&nbsp;&nbsp;
+      <a href="#M000165">note_to_s</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">NOTE_NAMES</td>
+          <td>=</td>
+          <td class="context-item-value">[         'C', 'C#', 'D', 'D#', 'E', 'F', 'F#', 'G', 'G#', 'A', 'A#', 'B'</td>
+          <td width="3em">&nbsp;</td>
+          <td class="context-item-desc">
+<a href="../MIDI.html">MIDI</a> note names. NOTE_NAMES[0] is
+&#8216;C&#8217;, NOTE_NAMES[1] is &#8216;C#&#8217;, etc.
+</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000166" class="method-detail">
+        <a name="M000166"></a>
+        <div class="method-heading">
+          <a href="Utils.src/M000166.html" target="Code" class="method-signature"
+            onclick="popupCode('Utils.src/M000166.html');return false;">
+          <span class="method-name">as_var_len</span><span class="method-args">(val)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Given an integer, returns it as a variable length array of bytes (the
+format used by <a href="../MIDI.html">MIDI</a> files).
+</p>
+<p>
+The converse operation&#8212;converting a var len into a
+number&#8212;requires input from a stream of bytes. Therefore we
+don&#8217;t supply it here. That is a part of the MIDIFile class.
+</p>
+        </div>
+      </div>
+      <div id="method-M000165" class="method-detail">
+        <a name="M000165"></a>
+        <div class="method-heading">
+          <a href="Utils.src/M000165.html" target="Code" class="method-signature"
+            onclick="popupCode('Utils.src/M000165.html');return false;">
+          <span class="method-name">note_to_s</span><span class="method-args">(num)</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Given a <a href="../MIDI.html">MIDI</a> note number, return the name and
+octave as a string.
+</p>
+        </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/Utils.src/M000165.html ADDED Viewed

@@ -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>note_to_s (MIDI::Utils)</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/utils.rb, line 12</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Utils</span>.<span class="ruby-identifier">note_to_s</span>(<span class="ruby-identifier">num</span>)
+        <span class="ruby-identifier">note</span> = <span class="ruby-identifier">num</span> <span class="ruby-operator">%</span> <span class="ruby-value">12</span>
+        <span class="ruby-identifier">octave</span> = <span class="ruby-identifier">num</span> <span class="ruby-operator">/</span> <span class="ruby-value">12</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-node">&quot;#{NOTE_NAMES[note]}#{octave - 1}&quot;</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/html/classes/MIDI/Utils.src/M000166.html ADDED Viewed

@@ -0,0 +1,25 @@
+<?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>as_var_len (MIDI::Utils)</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/utils.rb, line 24</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Utils</span>.<span class="ruby-identifier">as_var_len</span>(<span class="ruby-identifier">val</span>)
+        <span class="ruby-identifier">buffer</span> = <span class="ruby-value str">''</span>
+        <span class="ruby-identifier">buffer</span> <span class="ruby-operator">&lt;&lt;</span> (<span class="ruby-identifier">val</span> <span class="ruby-operator">&amp;</span> <span class="ruby-value">0x7f</span>)
+        <span class="ruby-identifier">val</span> = (<span class="ruby-identifier">val</span> <span class="ruby-operator">&gt;&gt;</span> <span class="ruby-value">7</span>)
+        <span class="ruby-keyword kw">while</span> <span class="ruby-identifier">val</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
+            <span class="ruby-identifier">buffer</span> <span class="ruby-operator">&lt;&lt;</span> (<span class="ruby-value">0x80</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">val</span> <span class="ruby-operator">&amp;</span> <span class="ruby-value">0x7f</span>))
+            <span class="ruby-identifier">val</span> = (<span class="ruby-identifier">val</span> <span class="ruby-operator">&gt;&gt;</span> <span class="ruby-value">7</span>)
+        <span class="ruby-keyword kw">end</span>
+        <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">buffer</span>.<span class="ruby-identifier">reverse!</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/html/created.rid ADDED Viewed

	@@ -0,0 +1 @@
1	+ Mon Mar 21 21:17:47 EST 2005

data/html/files/README.html ADDED Viewed

@@ -0,0 +1,599 @@
+<?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>File: README</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="fileHeader">
+    <h1>README</h1>
+    <table class="header-table">
+    <tr class="top-aligned-row">
+      <td><strong>Path:</strong></td>
+      <td>README
+      </td>
+    </tr>
+    <tr class="top-aligned-row">
+      <td><strong>Last Update:</strong></td>
+      <td>Mon Mar 21 21:17:03 EST 2005</td>
+    </tr>
+    </table>
+  </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <h1>midilib</h1>
+<p>
+midilib is a pure Ruby <a href="../classes/MIDI.html">MIDI</a> library
+useful for reading and writing standard <a
+href="../classes/MIDI.html">MIDI</a> files and manipulating <a
+href="../classes/MIDI.html">MIDI</a> event data. Classes include <a
+href="../classes/MIDI/Sequence.html">MIDI::Sequence</a>, <a
+href="../classes/MIDI/Track.html">MIDI::Track</a>, <a
+href="../classes/MIDI/Event.html">MIDI::Event</a>, and <a
+href="../classes/MIDI/IO/MIDIFile.html">MIDI::IO::MIDIFile</a> and its
+subclasses <a
+href="../classes/MIDI/IO/SeqReader.html">MIDI::IO::SeqReader</a> and <a
+href="../classes/MIDI/IO/SeqWriter.html">MIDI::IO::SeqWriter</a>.
+</p>
+<p>
+The Web site of midilib is (<a
+href="http://midilib.rubyforge.org">midilib.rubyforge.org</a>). The
+RubyForge project page is <a
+href="http://rubyforge.org/projects/midilib">rubyforge.org/projects/midilib</a>,
+where the latest version of midilib may be downloaded. midilib is also
+available as a RubyGem.
+</p>
+<h3>Recent Changes</h3>
+<h4>Changes for 0.8.4:</h4>
+<ul>
+<li>Realtime status bytes now set @is_realtime to true and return true when
+realtime? is called.
+</li>
+<li>All system common events now set @is_system to true and return true when
+system? is called, not just system exclusive events.
+</li>
+<li>Added examples/from_scratch.rb, which shows how to create a sequence
+manually.
+</li>
+<li>New <a href="../classes/MIDI/Sequence.html">MIDI::Sequence</a> methods that
+turn note length names like &quot;32nd&quot;, &quot;dotted quarter&quot;,
+and &quot;16th triplet&quot; into delta times. See the docs below and
+MIDI::Sequence::length_to_delta, MIDI::Sequence::note_to_length, and
+MIDI::Sequence::note_to_delta.
+</li>
+</ul>
+<h4>Changes for 0.8.3:</h4>
+<ul>
+<li>Added <a
+href="../classes/MIDI/NoteEvent.html#M000093">MIDI::NoteEvent.note_to_s</a>,
+which returns note name as a string like &quot;C4&quot; or &quot;F#6&quot;.
+</li>
+<li>Added new boolean attributes to <a
+href="../classes/MIDI/Event.html">MIDI::Event</a>: @print_decimal_numbers
+and @print_note_names. These are used by all Event to_s methods. See
+examples/seq2text.rb for an example.
+</li>
+</ul>
+<h4>Changes for 0.8.2:</h4>
+<ul>
+<li>Changed MIDI::MetaEvent.type to MIDI::MetaEvent.event_type to avoid runtime
+complaints about Object#type calls.
+</li>
+<li>Added &#8216;b&#8217; binary flag to file open modes for Windows.
+</li>
+<li>Fixed $LOAD_PATH in example files.
+</li>
+<li>Fixed read and write block arguments.
+</li>
+<li>Fixed other example script bugs.
+</li>
+</ul>
+<h4>Changes for 0.8.1:</h4>
+<ul>
+<li>Fixed track sorting.
+</li>
+<li>Fixed track&#8217;s recalc_delta_from_times method.
+</li>
+<li>Fixed event quantization.
+</li>
+<li>More tests and documentation.
+</li>
+</ul>
+<h2>Dependencies</h2>
+<p>
+midilib does not require any other packages. The test suite in the tests
+directory requires the testing framework TestUnit, which comes with Ruby
+1.8 and later and can also be found in the Ruby Application Archive (<a
+href="http://raa.ruby-lang.org">raa.ruby-lang.org</a>).
+</p>
+<p>
+To rebuild the gem or RDocs or run the tests easily, you can use the
+Rakefile which requires Rake (<a
+href="http://rake.rubyforge.org">rake.rubyforge.org</a>).
+</p>
+<h2>Installation</h2>
+<h3>RubyGems Installation</h3>
+<p>
+To install midilib as a gem, type
+</p>
+<pre>
+    % gem install midilib
+</pre>
+<p>
+You may need root privileges to install the gem.
+</p>
+<h3>Manual Installation</h3>
+<p>
+After downloading and expanding the archive, you can install midilib with
+the command
+</p>
+<pre>
+    % ruby install.rb
+</pre>
+<p>
+(or)
+</p>
+<pre>
+    % ruby install.rb --install-dir=my_directory
+</pre>
+<p>
+You may need root privileges to install.
+</p>
+<h2>Testing</h2>
+<pre>
+  % rake test
+</pre>
+<p>
+runs all of the tests in the test directory.
+</p>
+<h2>Overview</h2>
+<p>
+<a href="../classes/MIDI.html">MIDI</a> file IO only understands <a
+href="../classes/MIDI.html">MIDI</a> file format 1, where a sequence is
+made up of multiple tracks. It doesn&#8217;t yet understand format 0 (a
+single track containing all events) or format 2 (a collection of format 0
+files in one file).
+</p>
+<h3><a href="../classes/MIDI/Sequence.html">MIDI::Sequence</a></h3>
+<p>
+A sequence contains a collection of tracks and global information like the
+sequence&#8217;s pulses per quarter note (ppqn) and time signature.
+</p>
+<p>
+The first track in a sequence is special; it holds meta-events like tempo
+and sequence name. Don&#8216;t put any notes in this track.
+</p>
+<p>
+<a href="../classes/MIDI/Sequence.html">MIDI::Sequence</a> also contains
+some convenience methods that let you set and retrieve the sequence&#8217;s
+name, the time signature, and to retrieve the first tempo event&#8217;s
+beats-per-minute value.
+</p>
+<p>
+Normally instances of <a
+href="../classes/MIDI/IO/SeqReader.html">MIDI::IO::SeqReader</a> and <a
+href="../classes/MIDI/IO/SeqWriter.html">MIDI::IO::SeqWriter</a> are used
+when a sequence reads itself from or writes itself to a <a
+href="../classes/MIDI.html">MIDI</a> file. You can change that by setting a
+sequence&#8217;s reader_class or writer_class attributes. Instances of the
+classes contained in those attributes are created and used whenever the
+sequence reads or writes itself.
+</p>
+<h3><a href="../classes/MIDI/Track.html">MIDI::Track</a></h3>
+<p>
+A track contains an array of events.
+</p>
+<p>
+When you modify the <tt>events</tt> array, make sure to call recalc_times
+so each event gets its <tt>time_from_start</tt> recalculated. You
+don&#8217;t have to do that after every event you add; just remember to do
+so before using the track in a way that expects the list of events to be
+ordered correctly.
+</p>
+<p>
+A Track also holds a bit mask that specifies the channels used by the
+track. This bit mask is set when the track is read from the <a
+href="../classes/MIDI.html">MIDI</a> file by a SeqReader but is
+<em>not</em> 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.
+</p>
+<h3><a href="../classes/MIDI/Event.html">MIDI::Event</a></h3>
+<p>
+Each event holds not only its delta time but also its time from the start
+of the track. The track is responsible for recalculating its events&#8217;
+start times. You can call <a
+href="../classes/MIDI/Track.html#M000077">MIDI::Track#recalc_times</a> to
+do so.
+</p>
+<p>
+Events have a number of boolean methods that identify their types, like
+channel?, note?, note_on?, note_off?, meta?, system?, and realtime?.
+</p>
+<p>
+Subclasses of <a href="../classes/MIDI/Event.html">MIDI::Event</a>
+implement the various <a href="../classes/MIDI.html">MIDI</a> messages such
+as note on and off, controller values, system exclusive data, and realtime
+bytes.
+</p>
+<p>
+<a href="../classes/MIDI/Realtime.html">MIDI::Realtime</a> events have
+delta values and start times, just like all the other midilib event types
+do. (<a href="../classes/MIDI.html">MIDI</a> real time status bytes
+don&#8217;t have delta times, but this way we can record when in a track
+the realtime byte was received and should be sent. This is useful for
+start/continue/stop events that control other devices, for example.) Note
+that when a <a href="../classes/MIDI/Realtime.html">MIDI::Realtime</a>
+event is written out to a <a href="../classes/MIDI.html">MIDI</a> file, the
+delta time is not written.
+</p>
+<h2>How To Use</h2>
+<p>
+The following examples show you how to use midilib to read, write, and
+manipulate <a href="../classes/MIDI.html">MIDI</a> files and modify track
+events. See also the files in the examples directory, which are described
+below.
+</p>
+<h3>Reading a <a href="../classes/MIDI.html">MIDI</a> File</h3>
+<p>
+To read a <a href="../classes/MIDI.html">MIDI</a> file, create a <a
+href="../classes/MIDI/Sequence.html">MIDI::Sequence</a> object and call its
+read method, passing in an IO object.
+</p>
+<p>
+The read method takes an optional block. If present, the block is called
+once after each track has finished being read. Each time, it is passed the
+total number of tracks and the number of the current track that has just
+been read. This is useful for notifying the user of progress, for example
+by updating a GUI progress bar.
+</p>
+<pre>
+ require 'midi/io/seqreader'
+ # Create a new, empty sequence.
+ seq = MIDI::Sequence.new()
+ # Read the contents of a MIDI file into the sequence.
+ File.open('my_midi_file.mid', 'rb') { | file |
+     seq.read(file) { | num_tracks, i |
+         # Print something when each track is read.
+         puts &quot;read track #{i} of #{num_tracks}&quot;
+     }
+ }
+</pre>
+<h3>Writing a <a href="../classes/MIDI.html">MIDI</a> File</h3>
+<p>
+To write a <a href="../classes/MIDI.html">MIDI</a> file, call the write
+method, passing in an IO object.
+</p>
+<pre>
+ require 'midi/io/seqwriter'
+ # Start with a sequence that has something worth saving.
+ seq = read_or_create_seq_we_care_not_how()
+ # Write the sequence to a MIDI file.
+ File.open('my_output_file.mid', 'wb') { | file | seq.write(file) }
+</pre>
+<h3>Editing a <a href="../classes/MIDI.html">MIDI</a> File</h3>
+<p>
+Combining the last two examples, here is a script that reads a <a
+href="../classes/MIDI.html">MIDI</a> file, transposes some events, and
+writes the sequence out to a different file. This is a useful template for
+programatically manipulating <a href="../classes/MIDI.html">MIDI</a> data.
+</p>
+<p>
+This code transposes all of the note events (note on, note off, and poly
+pressure) on channel 5 down one octave. It&#8217;s easy to find events that
+need to be transposed: the method note? returns true.
+</p>
+<h4>Transposing One Channel</h4>
+<pre>
+ require 'midi/io/seqreader'
+ require 'midi/io/seqwriter'
+ # Create a new, empty sequence.
+ seq = MIDI::Sequence.new()
+ # Read the contents of a MIDI file into the sequence.
+ File.open('my_input_file.mid', 'rb') { | file |
+     seq.read(file) { | num_tracks, i |
+         # Print something when each track is read.
+         puts &quot;read track #{i} of #{num_tracks}&quot;
+     }
+ }
+ # Iterate over every event in every track.
+ seq.each { | track |
+     track.each { | event |
+         # If the event is a note event (note on, note off, or poly
+         # pressure) and it is on MIDI channel 5 (channels start at
+         # 0, so we use 4), then transpose the event down one octave.
+         if event.note? &amp;&amp; event.channel == 4
+             event.note -= 12
+         end
+     }
+ }
+ # Write the sequence to a MIDI file.
+ File.open('my_output_file.mid', 'wb') { | file | seq.write(file) }
+</pre>
+<h3>Manipulating tracks</h3>
+<p>
+If you modify a track&#8217;s list of events directly, don&#8217;t forget
+to call <a
+href="../classes/MIDI/Track.html#M000077">MIDI::Track#recalc_times</a> when
+you are done.
+</p>
+<pre>
+ track.events[42, 1] = array_of_events
+ track.events &lt;&lt; an_event
+ track.merge(array_of_events)
+ track.recalc_times
+</pre>
+<h3>Calculating delta times</h3>
+<p>
+A few methods in <a href="../classes/MIDI/Sequence.html">MIDI::Sequence</a>
+make it easier to calculate the delta times that represent note lengths. <a
+href="../classes/MIDI/Sequence.html#M000115">MIDI::Sequence#length_to_delta</a>
+takes a note length (a multiple of a quarter note) and returns the delta
+time given the sequence&#8217;s current ppqn (pulses per quarter note)
+setting. 1 is a quarter note, 1.0/32.0 is a 32nd note (use floating-point
+numbers to avoid integer rounding), 1.5 is a dotted quarter, etc. See the
+documentation for that method for more information.
+</p>
+<p>
+MIDI::Sequence::note_to_length takes a note name and returns a length value
+(again, as a multiple of a quarter note). Legal note names are those found
+in MIDI::Sequence::NOTE_TO_LENGTH, and may begin with &quot;dotted&quot;
+and/or end with &quot;triplet&quot;. For example, &quot;whole&quot;,
+&quot;sixteenth&quot;, &quot;32nd&quot;, &quot;quarter triplet&quot;,
+&quot;dotted 16th&quot;, and &quot;dotted 8th triplet&quot; are all legal
+note names.
+</p>
+<p>
+Finally, MIDI::Sequence::note_to_delta takes a note name and returns a
+delta time.
+</p>
+<h3>Example Scripts</h3>
+<p>
+Here are short descriptions of each of the examples found in the examples
+directory.
+</p>
+<ul>
+<li>examples/from_scratch.rb shows you how to create a new sequence from
+scratch and save it to a <a href="../classes/MIDI.html">MIDI</a> file. It
+creates a file called &#8216;from_scratch.mid&#8217;.
+</li>
+<li>examples/seq2text.rb dumps a <a href="../classes/MIDI.html">MIDI</a> file
+as text. It reads in a sequence and uses the to_s method of each event.
+</li>
+<li>examples/reader2text.rb dumps a <a href="../classes/MIDI.html">MIDI</a>
+file as text. It subclasses MIDI::SeqReader instead of creating a sequence
+containing tracks and events.
+</li>
+<li>examples/transpose.rb transposes all note events (note on, note off, poly
+pressure) on a specified channel by a specified amount.
+</li>
+<li>There is also one <a href="../classes/MIDI.html">MIDI</a> file,
+examples/NoFences.mid. It is a little pop ditty I wrote. The instruments in
+this file use General <a href="../classes/MIDI.html">MIDI</a> patch numbers
+and drum note assignments. Since I don&#8217;t normally use GM patches, the
+sounds used here are at best approximations of the sounds I use.
+</li>
+</ul>
+<h2>Resources</h2>
+<p>
+The Ruby Web site (<a
+href="http://www.ruby-lang.org/en/index.html">www.ruby-lang.org/en/index.html</a>)
+contains an introduction to Ruby, the Ruby Application Archive (RAA) at <a
+href="http://raa.ruby-lang.org">raa.ruby-lang.org</a>, and pointers to more
+information.
+</p>
+<p>
+&lt;em&gt;Programming Ruby, The Pragmatic Programmer&#8217;s
+Guide&lt;em&gt;, by David Thomas and Andrew Hunt, is a well-written and
+practical introduction to Ruby. Its Web page at <a
+href="http://www.rubycentral.com/book">www.rubycentral.com/book</a> also
+contains a wealth of Ruby information. Though the book is available online,
+I encourage you to purchase a copy.
+</p>
+<p>
+A description of the <a href="../classes/MIDI.html">MIDI</a> file format
+can be found in a few places such as <a
+href="http://www.borg.com/~jglatt/tech/midifile.htm">www.borg.com/~jglatt/tech/midifile.htm</a>.
+</p>
+<p>
+The <a href="../classes/MIDI.html">MIDI</a> message reference at <a
+href="http://www.io.com/~jimm/midi_ref.html">www.io.com/~jimm/midi_ref.html</a>
+describes the format of <a href="../classes/MIDI.html">MIDI</a> commands.
+</p>
+<h1>To Do</h1>
+<h2>Bugs</h2>
+<ul>
+<li>None known.
+</li>
+</ul>
+<h2>Features</h2>
+<ul>
+<li>Method to translate event&#8217;s time_from_start to number of milliseconds
+from start.
+</li>
+<li>Swing quantizing. (Implied by list email from Carl Youngblood
+&lt;carl.youngblood@gmail.com&gt;)
+</li>
+<li>Implement key signature in SeqReader.
+</li>
+<li>Format 0 files.
+</li>
+<li>Format 2 files(?).
+</li>
+</ul>
+<h2>Documentation</h2>
+<ul>
+<li>Write better docs.
+</li>
+</ul>
+<h2>Tests</h2>
+<ul>
+<li>More needed?
+</li>
+</ul>
+<h1>Support</h1>
+<ul>
+<li>Visit the forums, bug list, and mailing list pages at <a
+href="http://rubyforge.org/projects/midilib">rubyforge.org/projects/midilib</a>
+</li>
+<li>Send email to Jim Menard at <a href="mailto:jimm@io.com">jimm@io.com</a>
+</li>
+<li>Ask on the ruby-talk mailing list
+</li>
+</ul>
+<h1>Administrivia</h1>
+<table>
+<tr><td valign="top">Author:</td><td>Jim Menard (<a href="mailto:jimm@io.com">jimm@io.com</a>)
+</td></tr>
+<tr><td valign="top">Copyright:</td><td>Copyright &#169; 2003-2004 Jim Menard
+</td></tr>
+<tr><td valign="top">License:</td><td>Distributed under the same license as Ruby.
+</td></tr>
+</table>
+<h2>Copying</h2>
+<p>
+midilib is copyrighted free software by Jim Menard and is released under
+the same license as Ruby. See the Ruby license at <a
+href="http://www.ruby-lang.org/en/LICENSE.txt">www.ruby-lang.org/en/LICENSE.txt</a>.
+</p>
+<p>
+midilib may be freely copied in its entirety providing this notice, all
+source code, all documentation, and all other files are included.
+</p>
+<p>
+midilib is Copyright &#169; 2003-2004 by Jim Menard.
+</p>
+<p>
+The song &quot;No Fences&quot; contained in the <a
+href="../classes/MIDI.html">MIDI</a> file examples/NoFences.mid is
+Copyright &#169; 1992 by Jim Menard (jimm@io.com). It may be freely used
+for non-commercial purposes as long as the author is given credit.
+</p>
+<h2>Warranty</h2>
+<p>
+This software is provided &quot;as is&quot; and without any express or
+implied warranties, including, without limitation, the implied warranties
+of merchantability and fitness for a particular purpose.
+</p>
+    </div>
+   </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>