midilib 2.0.2 → 2.0.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 (85) hide show
  1. data/Credits +5 -0
  2. data/README.rdoc +35 -30
  3. data/examples/reader2text.rb +1 -0
  4. data/html/IO.html +259 -0
  5. data/html/MIDI.html +665 -0
  6. data/html/MIDI/ActiveSense.html +295 -0
  7. data/html/MIDI/ChannelEvent.html +319 -0
  8. data/html/MIDI/ChannelPressure.html +350 -0
  9. data/html/MIDI/Clock.html +295 -0
  10. data/html/MIDI/Continue.html +295 -0
  11. data/html/MIDI/Controller.html +365 -0
  12. data/html/MIDI/Event.html +573 -0
  13. data/html/MIDI/IO.html +207 -0
  14. data/html/MIDI/IO/MIDIFile.html +1996 -0
  15. data/html/MIDI/IO/SeqReader.html +946 -0
  16. data/html/MIDI/IO/SeqWriter.html +648 -0
  17. data/html/MIDI/KeySig.html +435 -0
  18. data/html/MIDI/MIDI.html +204 -0
  19. data/html/MIDI/MIDI/MIDI.html +204 -0
  20. data/html/MIDI/MIDI/MIDI/Array.html +353 -0
  21. data/html/MIDI/Marker.html +257 -0
  22. data/html/MIDI/Measure.html +423 -0
  23. data/html/MIDI/Measures.html +375 -0
  24. data/html/MIDI/MetaEvent.html +534 -0
  25. data/html/MIDI/NoteEvent.html +417 -0
  26. data/html/MIDI/NoteOff.html +316 -0
  27. data/html/MIDI/NoteOn.html +316 -0
  28. data/html/MIDI/PitchBend.html +351 -0
  29. data/html/MIDI/PolyPressure.html +360 -0
  30. data/html/MIDI/ProgramChange.html +350 -0
  31. data/html/MIDI/Realtime.html +328 -0
  32. data/html/MIDI/Sequence.html +961 -0
  33. data/html/MIDI/SongPointer.html +351 -0
  34. data/html/MIDI/SongSelect.html +350 -0
  35. data/html/MIDI/Start.html +295 -0
  36. data/html/MIDI/Stop.html +295 -0
  37. data/html/MIDI/SystemCommon.html +257 -0
  38. data/html/MIDI/SystemExclusive.html +353 -0
  39. data/html/MIDI/SystemReset.html +295 -0
  40. data/html/MIDI/Tempo.html +474 -0
  41. data/html/MIDI/TimeSig.html +467 -0
  42. data/html/MIDI/Track.html +769 -0
  43. data/html/MIDI/TuneRequest.html +328 -0
  44. data/html/MIDI/Utils.html +320 -0
  45. data/html/README_rdoc.html +751 -0
  46. data/html/TODO_rdoc.html +200 -0
  47. data/html/created.rid +14 -0
  48. data/html/images/add.png +0 -0
  49. data/html/images/brick.png +0 -0
  50. data/html/images/brick_link.png +0 -0
  51. data/html/images/bug.png +0 -0
  52. data/html/images/bullet_black.png +0 -0
  53. data/html/images/bullet_toggle_minus.png +0 -0
  54. data/html/images/bullet_toggle_plus.png +0 -0
  55. data/html/images/date.png +0 -0
  56. data/html/images/delete.png +0 -0
  57. data/html/images/find.png +0 -0
  58. data/html/images/loadingAnimation.gif +0 -0
  59. data/html/images/macFFBgHack.png +0 -0
  60. data/html/images/package.png +0 -0
  61. data/html/images/page_green.png +0 -0
  62. data/html/images/page_white_text.png +0 -0
  63. data/html/images/page_white_width.png +0 -0
  64. data/html/images/plugin.png +0 -0
  65. data/html/images/ruby.png +0 -0
  66. data/html/images/tag_blue.png +0 -0
  67. data/html/images/tag_green.png +0 -0
  68. data/html/images/transparent.png +0 -0
  69. data/html/images/wrench.png +0 -0
  70. data/html/images/wrench_orange.png +0 -0
  71. data/html/images/zoom.png +0 -0
  72. data/html/index.html +750 -0
  73. data/html/js/darkfish.js +153 -0
  74. data/html/js/jquery.js +18 -0
  75. data/html/js/navigation.js +142 -0
  76. data/html/js/search.js +94 -0
  77. data/html/js/search_index.js +1 -0
  78. data/html/js/searcher.js +228 -0
  79. data/html/rdoc.css +543 -0
  80. data/html/table_of_contents.html +652 -0
  81. data/lib/midilib/info.rb +1 -1
  82. data/lib/midilib/io/seqreader.rb +1 -1
  83. data/lib/midilib/sequence.rb +7 -0
  84. data/test/test_sequence.rb +11 -0
  85. metadata +80 -3
data/html/MIDI/TimeSig.html ADDED
@@ -0,0 +1,467 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=US-ASCII" http-equiv="Content-Type">
6
+
7
+ <title>class MIDI::TimeSig - midilib</title>
8
+
9
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "../";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="../index.html">Home</a>
28
+ <a href="../table_of_contents.html#classes">Classes</a>
29
+ <a href="../table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+ <div id="file-metadata">
47
+ <nav id="file-list-section" class="section">
48
+ <h3 class="section-header">Defined In</h3>
49
+ <ul>
50
+ <li>lib/midilib/event.rb
51
+ </ul>
52
+ </nav>
53
+
54
+
55
+ </div>
56
+
57
+ <div id="class-metadata">
58
+
59
+ <nav id="parent-class-section" class="section">
60
+ <h3 class="section-header">Parent</h3>
61
+
62
+ <p class="link"><a href="MetaEvent.html">MIDI::MetaEvent</a>
63
+
64
+ </nav>
65
+
66
+
67
+ <!-- Method Quickref -->
68
+ <nav id="method-list-section" class="section">
69
+ <h3 class="section-header">Methods</h3>
70
+
71
+ <ul class="link-list">
72
+
73
+ <li><a href="#method-c-new">::new</a>
74
+
75
+ <li><a href="#method-i-data_as_bytes">#data_as_bytes</a>
76
+
77
+ <li><a href="#method-i-denominator">#denominator</a>
78
+
79
+ <li><a href="#method-i-measure_duration">#measure_duration</a>
80
+
81
+ <li><a href="#method-i-metronome_ticks">#metronome_ticks</a>
82
+
83
+ <li><a href="#method-i-numerator">#numerator</a>
84
+
85
+ <li><a href="#method-i-to_s">#to_s</a>
86
+
87
+ </ul>
88
+ </nav>
89
+
90
+ </div>
91
+
92
+ <div id="project-metadata">
93
+ <nav id="fileindex-section" class="section project-section">
94
+ <h3 class="section-header">Pages</h3>
95
+
96
+ <ul>
97
+
98
+ <li class="file"><a href="../README_rdoc.html">README</a>
99
+
100
+ <li class="file"><a href="../TODO_rdoc.html">TODO</a>
101
+
102
+ </ul>
103
+ </nav>
104
+
105
+ <nav id="classindex-section" class="section project-section">
106
+ <h3 class="section-header">Class and Module Index</h3>
107
+
108
+ <ul class="link-list">
109
+
110
+ <li><a href="../MIDI.html">MIDI</a>
111
+
112
+ <li><a href="../MIDI/ActiveSense.html">MIDI::ActiveSense</a>
113
+
114
+ <li><a href="../MIDI/ChannelEvent.html">MIDI::ChannelEvent</a>
115
+
116
+ <li><a href="../MIDI/ChannelPressure.html">MIDI::ChannelPressure</a>
117
+
118
+ <li><a href="../MIDI/Clock.html">MIDI::Clock</a>
119
+
120
+ <li><a href="../MIDI/Continue.html">MIDI::Continue</a>
121
+
122
+ <li><a href="../MIDI/Controller.html">MIDI::Controller</a>
123
+
124
+ <li><a href="../MIDI/Event.html">MIDI::Event</a>
125
+
126
+ <li><a href="../MIDI/IO.html">MIDI::IO</a>
127
+
128
+ <li><a href="../MIDI/IO/MIDIFile.html">MIDI::IO::MIDIFile</a>
129
+
130
+ <li><a href="../MIDI/IO/SeqReader.html">MIDI::IO::SeqReader</a>
131
+
132
+ <li><a href="../MIDI/IO/SeqWriter.html">MIDI::IO::SeqWriter</a>
133
+
134
+ <li><a href="../MIDI/KeySig.html">MIDI::KeySig</a>
135
+
136
+ <li><a href="../MIDI/MIDI.html">MIDI::MIDI</a>
137
+
138
+ <li><a href="../MIDI/MIDI/MIDI.html">MIDI::MIDI::MIDI</a>
139
+
140
+ <li><a href="../MIDI/MIDI/MIDI/Array.html">MIDI::MIDI::MIDI::Array</a>
141
+
142
+ <li><a href="../MIDI/Marker.html">MIDI::Marker</a>
143
+
144
+ <li><a href="../MIDI/Measure.html">MIDI::Measure</a>
145
+
146
+ <li><a href="../MIDI/Measures.html">MIDI::Measures</a>
147
+
148
+ <li><a href="../MIDI/MetaEvent.html">MIDI::MetaEvent</a>
149
+
150
+ <li><a href="../MIDI/NoteEvent.html">MIDI::NoteEvent</a>
151
+
152
+ <li><a href="../MIDI/NoteOff.html">MIDI::NoteOff</a>
153
+
154
+ <li><a href="../MIDI/NoteOff.html">MIDI::NoteOffEvent</a>
155
+
156
+ <li><a href="../MIDI/NoteOn.html">MIDI::NoteOn</a>
157
+
158
+ <li><a href="../MIDI/NoteOn.html">MIDI::NoteOnEvent</a>
159
+
160
+ <li><a href="../MIDI/PitchBend.html">MIDI::PitchBend</a>
161
+
162
+ <li><a href="../MIDI/PolyPressure.html">MIDI::PolyPressure</a>
163
+
164
+ <li><a href="../MIDI/ProgramChange.html">MIDI::ProgramChange</a>
165
+
166
+ <li><a href="../MIDI/Realtime.html">MIDI::Realtime</a>
167
+
168
+ <li><a href="../MIDI/Sequence.html">MIDI::Sequence</a>
169
+
170
+ <li><a href="../MIDI/SongPointer.html">MIDI::SongPointer</a>
171
+
172
+ <li><a href="../MIDI/SongSelect.html">MIDI::SongSelect</a>
173
+
174
+ <li><a href="../MIDI/Start.html">MIDI::Start</a>
175
+
176
+ <li><a href="../MIDI/Stop.html">MIDI::Stop</a>
177
+
178
+ <li><a href="../MIDI/SystemCommon.html">MIDI::SystemCommon</a>
179
+
180
+ <li><a href="../MIDI/SystemExclusive.html">MIDI::SystemExclusive</a>
181
+
182
+ <li><a href="../MIDI/SystemReset.html">MIDI::SystemReset</a>
183
+
184
+ <li><a href="../MIDI/Tempo.html">MIDI::Tempo</a>
185
+
186
+ <li><a href="../MIDI/TimeSig.html">MIDI::TimeSig</a>
187
+
188
+ <li><a href="../MIDI/Track.html">MIDI::Track</a>
189
+
190
+ <li><a href="../MIDI/TuneRequest.html">MIDI::TuneRequest</a>
191
+
192
+ <li><a href="../MIDI/Utils.html">MIDI::Utils</a>
193
+
194
+ <li><a href="../IO.html">IO</a>
195
+
196
+ </ul>
197
+ </nav>
198
+
199
+ </div>
200
+ </nav>
201
+
202
+ <div id="documentation">
203
+ <h1 class="class">class MIDI::TimeSig</h1>
204
+
205
+ <div id="description" class="description">
206
+
207
+ <p>Container for time signature events</p>
208
+
209
+ </div><!-- description -->
210
+
211
+
212
+
213
+
214
+ <section id="5Buntitled-5D" class="documentation-section">
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+ <!-- Methods -->
224
+
225
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
226
+ <h3 class="section-header">Public Class Methods</h3>
227
+
228
+
229
+ <div id="method-c-new" class="method-detail ">
230
+
231
+ <div class="method-heading">
232
+ <span class="method-name">new</span><span
233
+ class="method-args">(numer, denom, clocks, qnotes, delta_time = 0)</span>
234
+ <span class="method-click-advice">click to toggle source</span>
235
+ </div>
236
+
237
+
238
+ <div class="method-description">
239
+
240
+ <p>Constructor</p>
241
+
242
+
243
+
244
+ <div class="method-source-code" id="new-source">
245
+ <pre><span class="ruby-comment"># File lib/midilib/event.rb, line 548</span>
246
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">numer</span>, <span class="ruby-identifier">denom</span>, <span class="ruby-identifier">clocks</span>, <span class="ruby-identifier">qnotes</span>, <span class="ruby-identifier">delta_time</span> = <span class="ruby-value">0</span>)
247
+ <span class="ruby-keyword">super</span>(<span class="ruby-constant">META_TIME_SIG</span>, [<span class="ruby-identifier">numer</span>, <span class="ruby-identifier">denom</span>, <span class="ruby-identifier">clocks</span>, <span class="ruby-identifier">qnotes</span>], <span class="ruby-identifier">delta_time</span>)
248
+ <span class="ruby-keyword">end</span></pre>
249
+ </div><!-- new-source -->
250
+
251
+ </div>
252
+
253
+
254
+
255
+
256
+ </div><!-- new-method -->
257
+
258
+
259
+ </section><!-- public-class-method-details -->
260
+
261
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
262
+ <h3 class="section-header">Public Instance Methods</h3>
263
+
264
+
265
+ <div id="method-i-data_as_bytes" class="method-detail ">
266
+
267
+ <div class="method-heading">
268
+ <span class="method-name">data_as_bytes</span><span
269
+ class="method-args">()</span>
270
+ <span class="method-click-advice">click to toggle source</span>
271
+ </div>
272
+
273
+
274
+ <div class="method-description">
275
+
276
+ <p>Returns the complete event as stored in the sequence</p>
277
+
278
+
279
+
280
+ <div class="method-source-code" id="data_as_bytes-source">
281
+ <pre><span class="ruby-comment"># File lib/midilib/event.rb, line 553</span>
282
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">data_as_bytes</span>
283
+ <span class="ruby-identifier">data</span> = []
284
+ <span class="ruby-identifier">data</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@status</span>
285
+ <span class="ruby-identifier">data</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@meta_type</span>
286
+ <span class="ruby-identifier">data</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value">4</span>
287
+ <span class="ruby-identifier">data</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@data</span>[<span class="ruby-value">0</span>]
288
+ <span class="ruby-identifier">data</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@data</span>[<span class="ruby-value">1</span>]
289
+ <span class="ruby-identifier">data</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@data</span>[<span class="ruby-value">2</span>]
290
+ <span class="ruby-identifier">data</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-ivar">@data</span>[<span class="ruby-value">3</span>]
291
+ <span class="ruby-keyword">end</span></pre>
292
+ </div><!-- data_as_bytes-source -->
293
+
294
+ </div>
295
+
296
+
297
+
298
+
299
+ </div><!-- data_as_bytes-method -->
300
+
301
+
302
+ <div id="method-i-denominator" class="method-detail ">
303
+
304
+ <div class="method-heading">
305
+ <span class="method-name">denominator</span><span
306
+ class="method-args">()</span>
307
+ <span class="method-click-advice">click to toggle source</span>
308
+ </div>
309
+
310
+
311
+ <div class="method-description">
312
+
313
+ <p>Returns the denominator of the time signature. Use it as a power of 2 to
314
+ get the displayed (lower-part) digit of the time signature.</p>
315
+
316
+
317
+
318
+ <div class="method-source-code" id="denominator-source">
319
+ <pre><span class="ruby-comment"># File lib/midilib/event.rb, line 576</span>
320
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">denominator</span>
321
+ <span class="ruby-ivar">@data</span>[<span class="ruby-value">1</span>]
322
+ <span class="ruby-keyword">end</span></pre>
323
+ </div><!-- denominator-source -->
324
+
325
+ </div>
326
+
327
+
328
+
329
+
330
+ </div><!-- denominator-method -->
331
+
332
+
333
+ <div id="method-i-measure_duration" class="method-detail ">
334
+
335
+ <div class="method-heading">
336
+ <span class="method-name">measure_duration</span><span
337
+ class="method-args">(ppqn)</span>
338
+ <span class="method-click-advice">click to toggle source</span>
339
+ </div>
340
+
341
+
342
+ <div class="method-description">
343
+
344
+ <p>Calculates the duration (in ticks) for a full measure</p>
345
+
346
+
347
+
348
+ <div class="method-source-code" id="measure_duration-source">
349
+ <pre><span class="ruby-comment"># File lib/midilib/event.rb, line 565</span>
350
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">measure_duration</span>(<span class="ruby-identifier">ppqn</span>)
351
+ (<span class="ruby-value">4</span> * <span class="ruby-identifier">ppqn</span> * <span class="ruby-ivar">@data</span>[<span class="ruby-value">0</span>]) <span class="ruby-operator">/</span> (<span class="ruby-value">2</span><span class="ruby-operator">**</span><span class="ruby-ivar">@data</span>[<span class="ruby-value">1</span>])
352
+ <span class="ruby-keyword">end</span></pre>
353
+ </div><!-- measure_duration-source -->
354
+
355
+ </div>
356
+
357
+
358
+
359
+
360
+ </div><!-- measure_duration-method -->
361
+
362
+
363
+ <div id="method-i-metronome_ticks" class="method-detail ">
364
+
365
+ <div class="method-heading">
366
+ <span class="method-name">metronome_ticks</span><span
367
+ class="method-args">()</span>
368
+ <span class="method-click-advice">click to toggle source</span>
369
+ </div>
370
+
371
+
372
+ <div class="method-description">
373
+
374
+ <p>Returns the metronome tick duration for the time signature. On each quarter
375
+ note, there's 24 ticks.</p>
376
+
377
+
378
+
379
+ <div class="method-source-code" id="metronome_ticks-source">
380
+ <pre><span class="ruby-comment"># File lib/midilib/event.rb, line 582</span>
381
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">metronome_ticks</span>
382
+ <span class="ruby-ivar">@data</span>[<span class="ruby-value">2</span>]
383
+ <span class="ruby-keyword">end</span></pre>
384
+ </div><!-- metronome_ticks-source -->
385
+
386
+ </div>
387
+
388
+
389
+
390
+
391
+ </div><!-- metronome_ticks-method -->
392
+
393
+
394
+ <div id="method-i-numerator" class="method-detail ">
395
+
396
+ <div class="method-heading">
397
+ <span class="method-name">numerator</span><span
398
+ class="method-args">()</span>
399
+ <span class="method-click-advice">click to toggle source</span>
400
+ </div>
401
+
402
+
403
+ <div class="method-description">
404
+
405
+ <p>Returns the numerator (the top digit) for the time signature</p>
406
+
407
+
408
+
409
+ <div class="method-source-code" id="numerator-source">
410
+ <pre><span class="ruby-comment"># File lib/midilib/event.rb, line 570</span>
411
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">numerator</span>
412
+ <span class="ruby-ivar">@data</span>[<span class="ruby-value">0</span>]
413
+ <span class="ruby-keyword">end</span></pre>
414
+ </div><!-- numerator-source -->
415
+
416
+ </div>
417
+
418
+
419
+
420
+
421
+ </div><!-- numerator-method -->
422
+
423
+
424
+ <div id="method-i-to_s" class="method-detail ">
425
+
426
+ <div class="method-heading">
427
+ <span class="method-name">to_s</span><span
428
+ class="method-args">()</span>
429
+ <span class="method-click-advice">click to toggle source</span>
430
+ </div>
431
+
432
+
433
+ <div class="method-description">
434
+
435
+ <p>Returns the time signature for the event as a string. Example: "time sig
436
+ 3/4"</p>
437
+
438
+
439
+
440
+ <div class="method-source-code" id="to_s-source">
441
+ <pre><span class="ruby-comment"># File lib/midilib/event.rb, line 588</span>
442
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span>
443
+ <span class="ruby-node">&quot;time sig #{@data[0]}/#{2**@data[1]}&quot;</span>
444
+ <span class="ruby-keyword">end</span></pre>
445
+ </div><!-- to_s-source -->
446
+
447
+ </div>
448
+
449
+
450
+
451
+
452
+ </div><!-- to_s-method -->
453
+
454
+
455
+ </section><!-- public-instance-method-details -->
456
+
457
+ </section><!-- 5Buntitled-5D -->
458
+
459
+ </div><!-- documentation -->
460
+
461
+
462
+ <footer id="validator-badges">
463
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
464
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
465
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
466
+ </footer>
467
+