/
index.html
executable file
·680 lines (622 loc) · 72.1 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
<!DOCTYPE html><html lang="en" class=" js content-loading loading"><head>
<meta charset="utf-8">
<meta name="author" content="stephband">
<meta name="description" content="Documentation for MIDI. Receive, monitor, manipulate and transmit MIDI messages in the browser.">
<meta name="viewport" content="width=device-width">
<meta name="twitter:card" content="summary">
<meta name="twitter:site" content="@stephband">
<meta property="og:url" content="http://stephen.band/midi/">
<meta property="og:title" content="MIDI">
<meta property="og:description" content="Receive, monitor, manipulate and transmit MIDI messages in the browser.">
<meta property="og:image" content="https://stephen.band/midi/images/logo-bg-128x128.png">
<title>MIDI</title>
<script title="load">
document.documentElement.className += ' js content-loading loading';
window.addEventListener('DOMContentLoaded', () => document.documentElement.classList.remove('content-loading'));
// Wait for other load handlers to run first - Bolt does a few things on
// load (eg. locateable scrolls) and we want them to run before the loading
// class is removed
window.addEventListener('load', () => window.requestAnimationFrame(() => document.documentElement.classList.remove('loading')));
</script>
<link rel="shortcut icon" href="images/logo-64x64.ico">
<link rel="icon" type="image/png" href="images/logo-32x32.png" sizes="32x32">
<link rel="icon" type="image/png" href="images/logo-64x64.png" sizes="64x64">
<link rel="icon" type="image/png" href="images/logo-128x128.png" sizes="128x128">
<link rel="stylesheet" href="style.min.css">
<!--link rel="stylesheet" href="style.css" /-->
</head>
<body class="grid @1-6x-grid @3-9x-grid">
<header class="grid x-1 @1-5x @2-4x @3-x-2 @3-4x" id="header">
<h1 class="x-1 x-start midi-icon">MIDI <span class="doctext-06">1.0.0</span></h1>
<div class="x-1">
<p class="doctext-08">
Receive, monitor, manipulate and transmit MIDI messages in the browser.
<span id="support-hint" style="color: #bf004c;"></span>
Currently <a href="https://brave.com/">Brave</a> and Chrome support the <a href="https://caniuse.com/#feat=midi">WebMIDI API</a>.
Firefox have had it <a href="https://github.com/mozilla/standards-positions/issues/58">under consideration</a> for some time.
</p>
<ul class="link-index index doctext-08">
<li><strong>repo:</strong> <a href="https://github.com/stephband/midi.git">https://github.com/stephband/midi.git</a></li>
<li><strong>bugs:</strong> <a href="https://github.com/stephband/midi/issues">https://github.com/stephband/midi/issues</a></li>
</ul>
</div>
</header>
<!--div class="docdemo-block block grid x-bleed @1-6x @3-9x">
<div class="midi-graph grid-1" id="midi-graph">
<p class="doctext-08 hint" id="instrument-hint">Plug in a MIDI instrument to try out the <code><midi-graph></code> component…</p>
<midi-graph/>
</div>
</div-->
<section class="grid @1-5x @2-4x @3-x-2 @3-4x">
<header class="x-1 @2-x-1 @2-3x">
<h2 class="doctext-02" style="font-size: 1.875rem;">Quick start</h2>
<pre class=" language-js"><code class=" language-js"><span class="token keyword">import</span> <span class="token punctuation">{</span> on<span class="token punctuation">,</span> toNoteName<span class="token punctuation">,</span> int7ToFloat <span class="token punctuation">}</span> <span class="token keyword">from</span> <span class="token string">'./midi/module.js'</span><span class="token punctuation">;</span>
<span class="token comment">// Listen to incoming 'noteon' and 'noteoff' messages on channel 1</span>
<span class="token function">on</span><span class="token punctuation">(</span><span class="token punctuation">{</span> channel<span class="token punctuation">:</span> <span class="token number">1</span><span class="token punctuation">,</span> type<span class="token punctuation">:</span> <span class="token string">'note'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">(</span>e<span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token punctuation">{</span>
<span class="token comment">// Time, port and message are standard properties of the DOM event</span>
<span class="token keyword">const</span> time <span class="token operator">=</span> e<span class="token punctuation">.</span>timeStamp<span class="token punctuation">;</span>
<span class="token keyword">const</span> port <span class="token operator">=</span> e<span class="token punctuation">.</span>target<span class="token punctuation">;</span>
<span class="token keyword">const</span> message <span class="token operator">=</span> e<span class="token punctuation">.</span>data<span class="token punctuation">;</span>
<span class="token comment">// Get the note name</span>
<span class="token keyword">const</span> name <span class="token operator">=</span> <span class="token function">toNoteName</span><span class="token punctuation">(</span>message<span class="token punctuation">[</span><span class="token number">1</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// Normalise velocity to the range 0-1</span>
<span class="token keyword">const</span> velocity <span class="token operator">=</span> <span class="token function">int7ToFloat</span><span class="token punctuation">(</span>message<span class="token punctuation">[</span><span class="token number">2</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre>
<p class="doctext-08">Note that on this page functions have been imported to the object <code>MIDI</code> so that you may try them in the console.</p>
</header>
</section>
<section class="grid @1-6x @3-x-2 @3-6x">
<header class="x-1">
<h2 class="doctext-02" style="font-size: 1.875rem;">Functions</h2>
</header>
<section class="x-1 @1-x-1 @2-x-1">
<h3 class="doctext-03">availability</h3>
<!--article--><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="request">
<h3 class="doctext-05 ">
<a href="#request">
<code class="language-js"><span class="token function">request</span><span class="token punctuation">(</span><span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns a promise that resolves to the midiAccess object where it is
available. Where the underlying <code>navigator.requestMIDIAccess()</code> method is
undefined, or where MIDI is unavailable for some reason, returns a rejected
promise.</p>
<pre><code><span class="token function">request</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token keyword">catch</span><span class="token punctuation">(</span><span class="token keyword">function</span><span class="token punctuation">(</span>error<span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token comment">// Alert the user they don't have MIDI</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code></pre></article>
</section>
<section class="x-1 @1-x-2 @2-x-2">
<h3 class="doctext-03">receive</h3>
<!--article--><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="inputs">
<h3 class="doctext-05 ">
<a href="#inputs">
<code class="language-js"><span class="token function">inputs</span><span class="token punctuation">(</span><span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns the map of MIDI input ports from the underlying MIDIAccess object.</p>
</article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="getinput-id">
<h3 class="doctext-05 ">
<a href="#getinput-id">
<code class="language-js"><span class="token function">getInput</span><span class="token punctuation">(</span>id<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns an input port by id.</p>
</article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="on-selector-fn">
<h3 class="doctext-05 ">
<a href="#on-selector-fn">
<code class="language-js"><span class="token function">on</span><span class="token punctuation">(</span>selector<span class="token punctuation">,</span> fn<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Registers a handler <code>fn</code> for incoming MIDI events that match object <code>selector</code>.
A selector is either an array (or array-like) in the form of a MIDI message
<code>[status, data1, data2]</code>:</p>
<pre><code><span class="token comment">// Call fn on CH1 NOTEON events</span>
<span class="token function">on</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token number">144</span><span class="token punctuation">]</span><span class="token punctuation">,</span> fn<span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// Call fn on CH1 NOTEON C4 events</span>
<span class="token function">on</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token number">144</span><span class="token punctuation">,</span> <span class="token number">60</span><span class="token punctuation">]</span><span class="token punctuation">,</span> fn<span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// Call fn on CH1 NOTEON C4 127 events</span>
<span class="token function">on</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token number">144</span><span class="token punctuation">,</span> <span class="token number">60</span><span class="token punctuation">,</span> <span class="token number">127</span><span class="token punctuation">]</span><span class="token punctuation">,</span> fn<span class="token punctuation">)</span><span class="token punctuation">;</span></code></pre><p>or a bit more conveniently an object of interpretive data of the form
<code>{channel, type, name, value}</code>:</p>
<pre><code><span class="token comment">// Call fn on CH2 NOTEON events</span>
<span class="token function">on</span><span class="token punctuation">(</span><span class="token punctuation">{</span> channel<span class="token punctuation">:</span> <span class="token number">2</span><span class="token punctuation">,</span> type<span class="token punctuation">:</span> <span class="token string">'noteon'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> fn<span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// Call fn on CH2 NOTEOFF C4 events</span>
<span class="token function">on</span><span class="token punctuation">(</span><span class="token punctuation">{</span> channel<span class="token punctuation">:</span> <span class="token number">2</span><span class="token punctuation">,</span> type<span class="token punctuation">:</span> <span class="token string">'noteoff'</span><span class="token punctuation">,</span> name<span class="token punctuation">:</span> <span class="token string">'C4'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> fn<span class="token punctuation">)</span>
<span class="token comment">// Call fn on CH2 NOTEON and NOTEOFF C4 events</span>
<span class="token function">on</span><span class="token punctuation">(</span><span class="token punctuation">{</span> channel<span class="token punctuation">:</span> <span class="token number">2</span><span class="token punctuation">,</span> type<span class="token punctuation">:</span> <span class="token string">'note'</span><span class="token punctuation">,</span> name<span class="token punctuation">:</span> <span class="token string">'C4'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> fn<span class="token punctuation">)</span>
<span class="token comment">// Call fn on CH4 CONTROL 1 0 events</span>
<span class="token function">on</span><span class="token punctuation">(</span><span class="token punctuation">{</span> channel<span class="token punctuation">:</span> <span class="token number">4</span><span class="token punctuation">,</span> type<span class="token punctuation">:</span> <span class="token string">'control'</span><span class="token punctuation">,</span> name<span class="token punctuation">:</span> <span class="token string">'modulation'</span><span class="token punctuation">,</span> value<span class="token punctuation">:</span> <span class="token number">0</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> fn<span class="token punctuation">)</span></code></pre><p>Note that these selector properties are progressive. A selector may not have
a <code>type</code> if it has no <code>channel</code>, it may not have a <code>name</code> without a <code>type</code>,
and may not have a <code>value</code> without a <code>name</code> property. Selectors pre-create
paths in a distribution tree that is optimised for incoming events to flow
through.</p>
<p>Finally, a selector may optionally have a property <code>port</code>, the id of an
input port.</p>
<pre><code><span class="token comment">// Call fn on CH4 CC 64 events from port '0123'</span>
<span class="token function">on</span><span class="token punctuation">(</span><span class="token punctuation">{</span> port<span class="token punctuation">:</span> <span class="token string">'0123'</span><span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">:</span> <span class="token number">179</span><span class="token punctuation">,</span> <span class="token number">1</span><span class="token punctuation">:</span> <span class="token number">64</span> <span class="token punctuation">}</span><span class="token punctuation">}</span><span class="token punctuation">,</span> fn<span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token comment">// Call fn on CH4 CC 64 events from port '0123'</span>
<span class="token function">on</span><span class="token punctuation">(</span><span class="token punctuation">{</span> port<span class="token punctuation">:</span> <span class="token string">'0123'</span><span class="token punctuation">,</span> channel<span class="token punctuation">:</span> <span class="token number">4</span><span class="token punctuation">,</span> type<span class="token punctuation">:</span> <span class="token string">'control'</span><span class="token punctuation">,</span> name<span class="token punctuation">:</span> <span class="token number">64</span> <span class="token punctuation">}</span><span class="token punctuation">}</span><span class="token punctuation">,</span> fn<span class="token punctuation">)</span><span class="token punctuation">;</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="off-selector-fn">
<h3 class="doctext-05 ">
<a href="#off-selector-fn">
<code class="language-js"><span class="token function">off</span><span class="token punctuation">(</span>selector<span class="token punctuation">,</span> fn<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Removes an event listener ‘fn’ from MIDI events matching object ‘selector’. Where
‘fn’ is not given, removes all handlers from events matching the selector.</p>
<pre><code><span class="token function">off</span><span class="token punctuation">(</span><span class="token punctuation">{</span> channel<span class="token punctuation">:</span> <span class="token number">1</span><span class="token punctuation">,</span> type<span class="token punctuation">:</span> <span class="token string">'note'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> fn<span class="token punctuation">)</span><span class="token punctuation">;</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="trigger-port-message">
<h3 class="doctext-05 ">
<a href="#trigger-port-message">
<code class="language-js"><span class="token function">trigger</span><span class="token punctuation">(</span>port<span class="token punctuation">,</span> message<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Simulates an incoming MIDI event and fires listeners with matching selectors.
Useful for debugging.</p>
<pre><code><span class="token function">trigger</span><span class="token punctuation">(</span><span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token punctuation">[</span><span class="token number">128</span><span class="token punctuation">,</span> <span class="token number">69</span><span class="token punctuation">,</span> <span class="token number">88</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="trigger-port-chan-type-name-value">
<h3 class="doctext-05 ">
<a href="#trigger-port-chan-type-name-value">
<code class="language-js"><span class="token function">trigger</span><span class="token punctuation">(</span>port<span class="token punctuation">,</span> chan<span class="token punctuation">,</span> type<span class="token punctuation">,</span> name<span class="token punctuation">,</span> value<span class="token punctuation">)</span></code>
</a>
</h3>
<p>As <code>trigger(port, message)</code>, where the last 4 parameters are passed to
<code>createMessage()</code> to create the MIDI message before triggering.</p>
<pre><code><span class="token function">trigger</span><span class="token punctuation">(</span><span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token string">'noteon'</span><span class="token punctuation">,</span> <span class="token string">'A4'</span><span class="token punctuation">,</span> <span class="token number">0.75</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code></pre></article>
</section>
<section class="x-1 @1-x-1 @2-x-3">
<h3 class="doctext-03">send</h3>
<!--article--><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="outputs">
<h3 class="doctext-05 ">
<a href="#outputs">
<code class="language-js"><span class="token function">outputs</span><span class="token punctuation">(</span><span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns the map of MIDI output ports from the underlying MIDIAccess object.</p>
</article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="getoutput-id">
<h3 class="doctext-05 ">
<a href="#getoutput-id">
<code class="language-js"><span class="token function">getOutput</span><span class="token punctuation">(</span>id<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns an output port by id.</p>
</article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="send-event">
<h3 class="doctext-05 ">
<a href="#send-event">
<code class="language-js"><span class="token function">send</span><span class="token punctuation">(</span>event<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Cues a message to be sent to an output port. The object <code>event</code> must have the
same structure as an incoming MIDI event object:</p>
<pre><code><span class="token function">send</span><span class="token punctuation">(</span><span class="token punctuation">{</span>
target<span class="token punctuation">:</span> <span class="token comment">// a MIDI output port</span>
timeStamp<span class="token punctuation">:</span> <span class="token comment">// a DOM timeStamp</span>
data<span class="token punctuation">:</span> <span class="token comment">// a MIDI message</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code></pre><p>If <code>timeStamp</code> is in the past the message is sent immediately.</p>
</article>
</section>
<section class="x-1 @1-x-2 @2-x-1">
<h3 class="doctext-03">messages</h3>
<!--article--><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="createmessage-channel-type-name-value">
<h3 class="doctext-05 ">
<a href="#createmessage-channel-type-name-value">
<code class="language-js"><span class="token function">createMessage</span><span class="token punctuation">(</span>channel<span class="token punctuation">,</span> type<span class="token punctuation">,</span> name<span class="token punctuation">,</span> value<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Creates a MIDI message – a Uint8Array of three values – where <code>channel</code> is an
integer in the range <code>1</code>-<code>16</code> and <code>type</code> is a string that determines the meaning
of <code>name</code> and <code>value</code>…</p>
<h4 id="for-type-noteon-or-noteoff-">for type <code>'noteon'</code> or <code>'noteoff'</code>:</h4>
<ul>
<li><code>name</code>: an integer in the range <code>0</code>-<code>127</code>, or a note name string eg. <code>'Eb4'</code>.</li>
<li><code>value</code>: a float in the range <code>0</code>-<code>1</code> representing velocity.</li>
</ul>
<pre><code><span class="token function">createMessage</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token string">'noteon'</span><span class="token punctuation">,</span> <span class="token string">'C3'</span><span class="token punctuation">,</span> <span class="token number">0.75</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code></pre><h4 id="for-type-control-">for type <code>'control'</code>:</h4>
<ul>
<li><code>name</code>: an integer in the range <code>0</code>-<code>127</code>, or a control name string eg. <code>'modulation'</code>.</li>
<li><code>value</code>: a float in the range <code>0</code>-<code>1</code> representing control value.</li>
</ul>
<pre><code><span class="token function">createMessage</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token string">'control'</span><span class="token punctuation">,</span> <span class="token string">'modulation'</span><span class="token punctuation">,</span> <span class="token number">1</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code></pre><h4 id="for-type-pitch-">for type <code>'pitch'</code>:</h4>
<ul>
<li><code>name</code>: a bend range in semitones.</li>
<li><code>value</code>: a positive or negative float within that range representing a pitch
bend in semitones.</li>
</ul>
<pre><code><span class="token function">createMessage</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token string">'pitch'</span><span class="token punctuation">,</span> <span class="token number">2</span><span class="token punctuation">,</span> <span class="token number">0.25</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code></pre><h4 id="for-type-polytouch-">for type <code>'polytouch'</code>:</h4>
<ul>
<li><code>name</code>: an integer in the range <code>0</code>-<code>127</code>, or a note name string eg. <code>'Eb4'</code>.</li>
<li><code>value</code>: a float in the range <code>0</code>-<code>1</code> representing force.</li>
</ul>
<pre><code><span class="token function">createMessage</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token string">'polytouch'</span><span class="token punctuation">,</span> <span class="token string">'C3'</span><span class="token punctuation">,</span> <span class="token number">0.25</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code></pre><h4 id="for-type-channeltouch-">for type <code>'channeltouch'</code>:</h4>
<ul>
<li><code>name</code>: an integer in the range <code>0</code>-<code>1</code>.</li>
<li><code>value</code>: unused.</li>
</ul>
<pre><code><span class="token function">createMessage</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token string">'channeltouch'</span><span class="token punctuation">,</span> <span class="token number">0.5</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code></pre><h4 id="for-type-program-">for type <code>'program'</code>:</h4>
<ul>
<li><code>name</code>: an integer in the range <code>0</code>-<code>127</code>.</li>
<li><code>value</code>: unused.</li>
</ul>
<pre><code><span class="token function">createMessage</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token string">'program'</span><span class="token punctuation">,</span> <span class="token number">24</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="iscontrol-message">
<h3 class="doctext-05 ">
<a href="#iscontrol-message">
<code class="language-js"><span class="token function">isControl</span><span class="token punctuation">(</span>message<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns <code>true</code> if message is a control change, otherwise <code>false</code>.</p>
<pre><code><span class="token function">isControl</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token number">145</span><span class="token punctuation">,</span><span class="token number">80</span><span class="token punctuation">,</span><span class="token number">20</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// false</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="isnote-message">
<h3 class="doctext-05 ">
<a href="#isnote-message">
<code class="language-js"><span class="token function">isNote</span><span class="token punctuation">(</span>message<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns <code>true</code> where message is a noteon or noteoff, otherwise <code>false</code>.</p>
<pre><code><span class="token function">isNote</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token number">145</span><span class="token punctuation">,</span><span class="token number">80</span><span class="token punctuation">,</span><span class="token number">20</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// true</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="ispitch-message">
<h3 class="doctext-05 ">
<a href="#ispitch-message">
<code class="language-js"><span class="token function">isPitch</span><span class="token punctuation">(</span>message<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns <code>true</code> message is a pitch bend, otherwise <code>false</code>.</p>
<pre><code><span class="token function">isPitch</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token number">145</span><span class="token punctuation">,</span><span class="token number">80</span><span class="token punctuation">,</span><span class="token number">20</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// false</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="normalise-message">
<h3 class="doctext-05 ">
<a href="#normalise-message">
<code class="language-js"><span class="token function">normalise</span><span class="token punctuation">(</span>message<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Many keyboards transmit <code>'noteon'</code> with velocity <code>0</code> rather than <code>'noteoff'</code>
messages. This is because MIDI allows messages with the same type to be sent
together, omitting the status byte and saving bandwidth. The MIDI spec requires
that both forms are treated identically. <code>normalise()</code> <em>mutates</em>
<code>'noteon'</code> messages with velocity <code>0</code> to <code>'noteoff'</code> messages.</p>
<pre><code><span class="token function">normalise</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token number">145</span><span class="token punctuation">,</span><span class="token number">80</span><span class="token punctuation">,</span><span class="token number">0</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// [129,80,0]</span></code></pre><p>Note that the MIDI library automatically normalises incoming messages.</p>
</article>
</section>
<section class="x-1 @1-x-1 @2-x-2">
<h3 class="doctext-03">data</h3>
<!--article--><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="floattofrequency-ref-n">
<h3 class="doctext-05 ">
<a href="#floattofrequency-ref-n">
<code class="language-js"><span class="token function">floatToFrequency</span><span class="token punctuation">(</span>ref<span class="token punctuation">,</span> n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Given a note number <code>n</code>, returns the frequency of the fundamental tone of that
note. <code>ref</code> is a reference frequency for middle A4/69 (usually <code>440</code>).</p>
<pre><code><span class="token function">floatToFrequency</span><span class="token punctuation">(</span><span class="token number">440</span><span class="token punctuation">,</span> <span class="token number">69</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 440</span>
<span class="token function">floatToFrequency</span><span class="token punctuation">(</span><span class="token number">440</span><span class="token punctuation">,</span> <span class="token number">60</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 261.625565</span>
<span class="token function">floatToFrequency</span><span class="token punctuation">(</span><span class="token number">442</span><span class="token punctuation">,</span> <span class="token number">69</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 442</span>
<span class="token function">floatToFrequency</span><span class="token punctuation">(</span><span class="token number">442</span><span class="token punctuation">,</span> <span class="token number">60</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 262.814772</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="frequencytofloat-ref-frequency">
<h3 class="doctext-05 ">
<a href="#frequencytofloat-ref-frequency">
<code class="language-js"><span class="token function">frequencyToFloat</span><span class="token punctuation">(</span>ref<span class="token punctuation">,</span> frequency<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns <code>frequency</code> as a float on the note number scale. <code>ref</code> is a reference
frequency for middle A4/69 (usually <code>440</code>).</p>
<pre><code><span class="token function">frequencyToFloat</span><span class="token punctuation">(</span><span class="token number">440</span><span class="token punctuation">,</span> <span class="token number">220</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 57 (A3)</span>
<span class="token function">frequencyToFloat</span><span class="token punctuation">(</span><span class="token number">440</span><span class="token punctuation">,</span> <span class="token number">110</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 45 (A2)</span></code></pre><p>Output is rounded to 32 bits to mitigate floating point rounding errors.</p>
</article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="normalisenotename-name">
<h3 class="doctext-05 ">
<a href="#normalisenotename-name">
<code class="language-js"><span class="token function">normaliseNoteName</span><span class="token punctuation">(</span>name<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Replaces the characters <code>'b'</code> and <code>'#'</code> with the unicode musical characters <code>'♭'</code>
and <code>'♯'</code> respectively.</p>
<pre><code><span class="token function">normaliseNoteName</span><span class="token punctuation">(</span><span class="token string">'Eb6'</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 'E♭6'</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="tocontrolname-n">
<h3 class="doctext-05 ">
<a href="#tocontrolname-n">
<code class="language-js"><span class="token function">toControlName</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns a shorthand controller name from a value in the range <code>0</code>-<code>127</code>. Not all
contollers have a standardised name, and this library implements only the
more common ones. Where a name is not found, returns the controller number as a
string.</p>
<pre><code><span class="token function">toControlName</span><span class="token punctuation">(</span><span class="token number">7</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 'volume'</span>
<span class="token function">toControlName</span><span class="token punctuation">(</span><span class="token number">64</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 'sustain'</span>
<span class="token function">toControlName</span><span class="token punctuation">(</span><span class="token number">98</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// '98'</span></code></pre><p>Standardised controller names are defined at
<a href="https://www.midi.org/specifications-old/item/table-3-control-change-messages-data-bytes-2">midi.org/specifications-old/</a>.</p>
</article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="tocontrolnumber-name">
<h3 class="doctext-05 ">
<a href="#tocontrolnumber-name">
<code class="language-js"><span class="token function">toControlNumber</span><span class="token punctuation">(</span>name<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns a value in the range <code>0</code>-<code>127</code> from a shorthand controller <code>name</code>.</p>
<pre><code><span class="token function">toControlNumber</span><span class="token punctuation">(</span><span class="token string">'volume'</span><span class="token punctuation">)</span> <span class="token comment">// 7</span>
<span class="token function">toControlNumber</span><span class="token punctuation">(</span><span class="token string">'sustain'</span><span class="token punctuation">)</span> <span class="token comment">// 64</span>
<span class="token function">toControlNumber</span><span class="token punctuation">(</span><span class="token string">'98'</span><span class="token punctuation">)</span> <span class="token comment">// 98</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="tonotename-n">
<h3 class="doctext-05 ">
<a href="#tonotename-n">
<code class="language-js"><span class="token function">toNoteName</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns note name from a value in the range 0-127.</p>
<pre><code><span class="token function">toNoteName</span><span class="token punctuation">(</span><span class="token number">69</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 'A4'</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="tonotenumber-name">
<h3 class="doctext-05 ">
<a href="#tonotenumber-name">
<code class="language-js"><span class="token function">toNoteNumber</span><span class="token punctuation">(</span>name<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Given a note name, returns a value in the range 0-127.</p>
<pre><code><span class="token function">toNoteNumber</span><span class="token punctuation">(</span><span class="token string">'D6'</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 86</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="tonoteoctave-n">
<h3 class="doctext-05 ">
<a href="#tonoteoctave-n">
<code class="language-js"><span class="token function">toNoteOctave</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Where <code>n</code> is a note number, returns the numerical octave.</p>
<pre><code><span class="token function">toNoteOctave</span><span class="token punctuation">(</span><span class="token number">69</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 4</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="tostatus-channel-type">
<h3 class="doctext-05 ">
<a href="#tostatus-channel-type">
<code class="language-js"><span class="token function">toStatus</span><span class="token punctuation">(</span>channel<span class="token punctuation">,</span> type<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Given a <code>channel</code> in the range <code>1</code>-<code>16</code> and type, returns the MIDI message
status byte.</p>
<pre><code><span class="token function">toStatus</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token string">'noteon'</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 144</span>
<span class="token function">toStatus</span><span class="token punctuation">(</span><span class="token number">7</span><span class="token punctuation">,</span> <span class="token string">'control'</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 183</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="tochannel-status">
<h3 class="doctext-05 ">
<a href="#tochannel-status">
<code class="language-js"><span class="token function">toChannel</span><span class="token punctuation">(</span>status<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns the MIDI channel as a number between <code>1</code> and <code>16</code>.</p>
<pre><code><span class="token function">toChannel</span><span class="token punctuation">(</span><span class="token number">145</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 2</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="totype-status">
<h3 class="doctext-05 ">
<a href="#totype-status">
<code class="language-js"><span class="token function">toType</span><span class="token punctuation">(</span>status<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns message type as one of the strings <code>'noteoff'</code>, <code>'noteon'</code>, <code>'polytouch'</code>,
<code>'control'</code>, <code>'program'</code>, <code>'channeltouch'</code> or <code>'pitch'</code>.</p>
<pre><code><span class="token function">toType</span><span class="token punctuation">(</span><span class="token number">145</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 'noteon'.</span></code></pre></article>
</section>
<section class="x-1 @1-x-2 @2-x-3">
<h3 class="doctext-03">maths</h3>
<!--article--><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="bytestoint14-lsb-msb">
<h3 class="doctext-05 ">
<a href="#bytestoint14-lsb-msb">
<code class="language-js"><span class="token function">bytesToInt14</span><span class="token punctuation">(</span>lsb<span class="token punctuation">,</span> msb<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Given two 7-bit values for <code>lsb</code> (least significant byte) and <code>msb</code> (most
significant byte), returns a 14-bit integer in the range <code>0</code>-<code>16383</code>.</p>
<pre><code><span class="token function">bytesToInt14</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">64</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 8192</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="bytestofloat-lsb-msb">
<h3 class="doctext-05 ">
<a href="#bytestofloat-lsb-msb">
<code class="language-js"><span class="token function">bytesToFloat</span><span class="token punctuation">(</span>lsb<span class="token punctuation">,</span> msb<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Given two 7-bit values for <code>lsb</code> (least significant byte) and <code>msb</code> (most
significant byte), returns a float in the range <code>0</code>-<code>1</code>.</p>
<pre><code><span class="token function">bytesToFloat</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0</span>
<span class="token function">bytesToFloat</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">64</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0.50003051944</span>
<span class="token function">bytesToFloat</span><span class="token punctuation">(</span><span class="token number">127</span><span class="token punctuation">,</span> <span class="token number">127</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 1</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="bytestosignedfloat-lsb-msb">
<h3 class="doctext-05 ">
<a href="#bytestosignedfloat-lsb-msb">
<code class="language-js"><span class="token function">bytesToSignedFloat</span><span class="token punctuation">(</span>lsb<span class="token punctuation">,</span> msb<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Given two 7-bit values for <code>lsb</code> (least significant byte) and <code>msb</code> (most
significant byte), returns a float in the range <code>-1</code>-<code>1</code>, weighted so that
an input of (<code>0</code>, <code>64</code>) maps to <code>0</code>.</p>
<pre><code><span class="token function">bytesToSignedFloat</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// -1</span>
<span class="token function">bytesToSignedFloat</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">64</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0</span>
<span class="token function">bytesToSignedFloat</span><span class="token punctuation">(</span><span class="token number">127</span><span class="token punctuation">,</span> <span class="token number">127</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 1</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="bytestoweightedfloat-lsb-msb">
<h3 class="doctext-05 ">
<a href="#bytestoweightedfloat-lsb-msb">
<code class="language-js"><span class="token function">bytesToWeightedFloat</span><span class="token punctuation">(</span>lsb<span class="token punctuation">,</span> msb<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Given two 7-bit values for <code>lsb</code> (least significant byte) and <code>msb</code> (most
significant byte), returns a float in the range <code>0</code>-<code>1</code>, weighted so that
an input of (<code>0</code>, <code>64</code>) maps to <code>0.5</code>.</p>
<pre><code><span class="token function">bytesToWeightedFloat</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">0</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0</span>
<span class="token function">bytesToWeightedFloat</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span> <span class="token number">64</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0.5</span>
<span class="token function">bytesToWeightedFloat</span><span class="token punctuation">(</span><span class="token number">127</span><span class="token punctuation">,</span> <span class="token number">127</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 1</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="floattoint7-n">
<h3 class="doctext-05 ">
<a href="#floattoint7-n">
<code class="language-js"><span class="token function">floatToInt7</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns an integer in the 7-bit range <code>0</code>-<code>127</code> for values of <code>n</code> between <code>0</code>-<code>1</code>.
Values lower than <code>0</code> return <code>0</code>, while values greater than <code>1</code> return <code>127</code>.</p>
<pre><code><span class="token function">floatToInt7</span><span class="token punctuation">(</span><span class="token number">0.5</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 64</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="floattoint14-n">
<h3 class="doctext-05 ">
<a href="#floattoint14-n">
<code class="language-js"><span class="token function">floatToInt14</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns an integer in the 14-bit range <code>0</code>-<code>16383</code> for values of <code>n</code> between <code>0</code>-<code>1</code>.
Values lower than <code>0</code> return <code>0</code>, while values greater than <code>1</code> return <code>16383</code>.</p>
<pre><code><span class="token function">floatToInt14</span><span class="token punctuation">(</span><span class="token number">0.5</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 8192</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="int7tofloat-n">
<h3 class="doctext-05 ">
<a href="#int7tofloat-n">
<code class="language-js"><span class="token function">int7ToFloat</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns a float in the range <code>0</code>-<code>1</code> for values of <code>n</code> in the range <code>0</code>-<code>127</code>.</p>
<pre><code><span class="token function">int7ToFloat</span><span class="token punctuation">(</span><span class="token number">64</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0.503937</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="int7toweightedfloat-n">
<h3 class="doctext-05 ">
<a href="#int7toweightedfloat-n">
<code class="language-js"><span class="token function">int7ToWeightedFloat</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns a float in the range <code>0</code>-<code>1</code> for values of <code>n</code> in the range <code>0</code>-<code>127</code>.
The input integer is mapped so that the value <code>64</code> returns exactly <code>0.5</code>, the
centre of the range, as per the MIDI spec for controller values and their ilk.</p>
<pre><code><span class="token function">int7ToSignedFloat</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0</span>
<span class="token function">int7ToSignedFloat</span><span class="token punctuation">(</span><span class="token number">64</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0.5</span>
<span class="token function">int7ToSignedFloat</span><span class="token punctuation">(</span><span class="token number">127</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 1</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="int7tosignedfloat-n">
<h3 class="doctext-05 ">
<a href="#int7tosignedfloat-n">
<code class="language-js"><span class="token function">int7ToSignedFloat</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns a float in the range <code>-1</code>-<code>1</code> for values of <code>n</code> in the range <code>0</code>-<code>127</code>.
The input integer is mapped so that the value <code>64</code> returns <code>0</code>, the centre of
the range, as per the MIDI spec for controller values and their ilk.</p>
<pre><code><span class="token function">int7ToSignedFloat</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// -1</span>
<span class="token function">int7ToSignedFloat</span><span class="token punctuation">(</span><span class="token number">64</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0</span>
<span class="token function">int7ToSignedFloat</span><span class="token punctuation">(</span><span class="token number">127</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 1</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="int14tofloat-n">
<h3 class="doctext-05 ">
<a href="#int14tofloat-n">
<code class="language-js"><span class="token function">int14ToFloat</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns a float in the range <code>0</code>-<code>1</code> for values of <code>n</code> in the range <code>0</code>-<code>16383</code>.</p>
<pre><code><span class="token function">int14ToFloat</span><span class="token punctuation">(</span><span class="token number">8192</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0.500031</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="int14toweightedfloat-n">
<h3 class="doctext-05 ">
<a href="#int14toweightedfloat-n">
<code class="language-js"><span class="token function">int14ToWeightedFloat</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns a float in the range <code>0</code>-<code>1</code> for values of <code>n</code> in the range <code>0</code>-<code>16383</code>.
The input integer is mapped so that the value <code>8192</code> returns <code>0.5</code>, the centre of
the range, as per the MIDI spec for pitch bend values and their ilk.</p>
<pre><code><span class="token function">int14ToWeightedFloat</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0</span>
<span class="token function">int14ToWeightedFloat</span><span class="token punctuation">(</span><span class="token number">8192</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0.5</span>
<span class="token function">int14ToWeightedFloat</span><span class="token punctuation">(</span><span class="token number">16383</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 1</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="int14tosignedfloat-n">
<h3 class="doctext-05 ">
<a href="#int14tosignedfloat-n">
<code class="language-js"><span class="token function">int14ToSignedFloat</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns a float in the range <code>-1</code>-<code>1</code> for values of <code>n</code> in the range <code>0</code>-<code>16383</code>.
The input integer is mapped so that the value <code>8192</code> returns <code>0</code>, the centre of
the range, as per the MIDI spec for pitch bend values and their ilk.</p>
<pre><code><span class="token function">int14ToSignedFloat</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// -1</span>
<span class="token function">int14ToSignedFloat</span><span class="token punctuation">(</span><span class="token number">8192</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0</span>
<span class="token function">int14ToSignedFloat</span><span class="token punctuation">(</span><span class="token number">16383</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 1</span></code></pre></article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="int14tolsb-n">
<h3 class="doctext-05 ">
<a href="#int14tolsb-n">
<code class="language-js"><span class="token function">int14ToLSB</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns the least significant 7-bit data byte of an unsigned 14-bit integer.</p>
<pre><code><span class="token function">int14ToLSB</span><span class="token punctuation">(</span><span class="token number">8192</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0</span></code></pre><p>Out-of-range input values will return spurious results.</p>
</article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="int14tomsb-n">
<h3 class="doctext-05 ">
<a href="#int14tomsb-n">
<code class="language-js"><span class="token function">int14ToMSB</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns the most significant 7-bit data byte of an unsigned 14-bit integer in
the range <code>0</code>-<code>16383</code></p>
<pre><code><span class="token function">int14ToMSB</span><span class="token punctuation">(</span><span class="token number">8192</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 64</span></code></pre><p>Out-of-range input values will return spurious results.</p>
</article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="signedfloattoint7-n">
<h3 class="doctext-05 ">
<a href="#signedfloattoint7-n">
<code class="language-js"><span class="token function">signedFloatToInt7</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns an integer in the 7-bit range <code>0</code>-<code>127</code> for values of <code>n</code> between
<code>-1</code>-<code>1</code>. The input value <code>0</code> maps exactly to the value <code>64</code>, as per
the MIDI spec for modulation control values and their ilk.</p>
<pre><code><span class="token function">signedFloatToInt7</span><span class="token punctuation">(</span><span class="token operator">-</span><span class="token number">1</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0</span>
<span class="token function">signedFloatToInt7</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 64</span>
<span class="token function">signedFloatToInt7</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 127</span></code></pre><p>Values lower than <code>-1</code> return <code>0</code>, while values greater than <code>1</code> return <code>127</code>.</p>
</article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="signedfloattoint14-n">
<h3 class="doctext-05 ">
<a href="#signedfloattoint14-n">
<code class="language-js"><span class="token function">signedFloatToInt14</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns an integer in the 14-bit range <code>0</code>-<code>16383</code> for values of <code>n</code> between
<code>-1</code>-<code>1</code>. The input value <code>0</code> maps exactly to the value <code>8192</code>, as per
the MIDI spec for pitch bend values and their ilk.</p>
<pre><code><span class="token function">signedFloatToInt14</span><span class="token punctuation">(</span><span class="token operator">-</span><span class="token number">1</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0</span>
<span class="token function">signedFloatToInt14</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 8192</span>
<span class="token function">signedFloatToInt14</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 16383</span></code></pre><p>Values lower than <code>-1</code> return <code>0</code>, while values greater than <code>1</code> return <code>16383</code>.</p>
</article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="weightedfloattoint7-n">
<h3 class="doctext-05 ">
<a href="#weightedfloattoint7-n">
<code class="language-js"><span class="token function">weightedFloatToInt7</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns an integer in the 7-bit range <code>0</code>-<code>127</code> for values of <code>n</code> between
<code>0</code>-<code>1</code>. The input value <code>0.5</code> maps exactly to the value <code>64</code>, as per
the MIDI spec for modulation control values and their ilk.</p>
<pre><code><span class="token function">weightedFloatToInt7</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0</span>
<span class="token function">weightedFloatToInt7</span><span class="token punctuation">(</span><span class="token number">0.5</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 64</span>
<span class="token function">weightedFloatToInt7</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 127</span></code></pre><p>Values lower than <code>-1</code> return <code>0</code>, while values greater than <code>1</code> return <code>127</code>.</p>
</article><article class="doc-toggle-block toggle-block block doctext-08" toggleable="" id="weightedfloattoint14-n">
<h3 class="doctext-05 ">
<a href="#weightedfloattoint14-n">
<code class="language-js"><span class="token function">weightedFloatToInt14</span><span class="token punctuation">(</span>n<span class="token punctuation">)</span></code>
</a>
</h3>
<p>Returns an integer in the 14-bit range <code>0</code>-<code>16383</code> for values of <code>n</code> between
<code>-1</code>-<code>1</code>. The input value <code>0</code> maps exactly to the value <code>8192</code>, as per
the MIDI spec for pitch bend values and their ilk.</p>
<pre><code><span class="token function">weightedFloatToInt14</span><span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 0</span>
<span class="token function">weightedFloatToInt14</span><span class="token punctuation">(</span><span class="token number">0.5</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 8192</span>
<span class="token function">weightedFloatToInt14</span><span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 16383</span></code></pre><p>Values lower than <code>-1</code> return <code>0</code>, while values greater than <code>1</code> return <code>16383</code>.</p>
</article>
</section>
</section>
<section class="grid @1-6x @3-x-2 @3-6x">
<header class="x-1">
<h2 class="doctext-02" style="font-size: 1.875rem;">Custom elements</h2>
</header>
<!--article--><article class="x-1 @1-x-1" id="midi-graph">
<h3 class="doctext-03">
<a href="#midi-graph">
<code class="language-html"><span class="token tag"><span class="token tag"><span class="token punctuation"><</span>midi-graph</span><span class="token punctuation">></span></span></code>
</a>
</h3>
<p>The <code><midi-graph></code> element plots incoming note, control change and pitch bend
messages on a graph.</p>
<pre><code class="language-html"><span class="token tag"><span class="token tag"><span class="token punctuation"><</span>script</span> <span class="token attr-name">type</span><span class="token attr-value"><span class="token punctuation">=</span><span class="token punctuation">"</span>module<span class="token punctuation">"</span></span> <span class="token attr-name">src</span><span class="token attr-value"><span class="token punctuation">=</span><span class="token punctuation">"</span>./elements/midi-graph/midi-graph.js<span class="token punctuation">"</span></span><span class="token punctuation">></span></span><span class="token script language-javascript"></span><span class="token tag"><span class="token tag"><span class="token punctuation"></</span>script</span><span class="token punctuation">></span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation"><</span>midi-graph</span><span class="token punctuation">></span></span></code></pre>
<p><midi-graph></midi-graph></p>
<p>This module has external dependencies.</p>
</article>
<!--article--><article class="x-1 @1-x-2" id="midi-monitor">
<h3 class="doctext-03">
<a href="#midi-monitor">
<code class="language-html"><span class="token tag"><span class="token tag"><span class="token punctuation"><</span>midi-monitor</span><span class="token punctuation">></span></span></code>
</a>
</h3>
<p>The <code><midi-monitor></code> element displays all incoming messages in a rolling list.</p>
<pre><code class="language-html"><span class="token tag"><span class="token tag"><span class="token punctuation"><</span>script</span> <span class="token attr-name">type</span><span class="token attr-value"><span class="token punctuation">=</span><span class="token punctuation">"</span>module<span class="token punctuation">"</span></span> <span class="token attr-name">src</span><span class="token attr-value"><span class="token punctuation">=</span><span class="token punctuation">"</span>//stephen.band/midi/elements/midi-monitor/midi-monitor.js<span class="token punctuation">"</span></span><span class="token punctuation">></span></span><span class="token script language-javascript"></span><span class="token tag"><span class="token tag"><span class="token punctuation"></</span>script</span><span class="token punctuation">></span></span>
<span class="token tag"><span class="token tag"><span class="token punctuation"><</span>midi-monitor</span><span class="token punctuation">></span></span></code></pre>
<p><midi-monitor></midi-monitor></p>
<p>This module has external depencies.
There is a full-page MIDI monitor at <a href="http://stephen.band/midi/monitor/">stephen.band/midi/monitor/</a>.</p>
</article>
</section>
<!-- Document interactivity -->
<script type="module">
import '../bolt/module.js';
import './elements/midi-graph/midi-graph.js';
import './elements/midi-monitor/midi-monitor.js';
import * as MIDI from './module.js';
window.MIDI = MIDI;
import { classes, get } from '../dom/module.js';
MIDI
.request()
.catch(function() {
get('support-hint').innerHTML = 'This browser does not support MIDI.';
});
/*
setTimeout(function() {
var cls = classes(get('instrument-hint'));
cls.add('active');
MIDI.on([], function removeHint(e) {
// Test events have no port, and we want to ignore them
if (!e.target || !e.target.onmidimessage) { return; }
MIDI.off([], removeHint);
cls.remove('active');
});
}, 2000);
*/
</script>
<!-- Tests -->
<script type="module">
import './test/maths.js';
import './test/data.js';
import './test/messages.js';
import './test/events.js';
import './test/midi.js';
</script>
</body></html>