-
Notifications
You must be signed in to change notification settings - Fork 0
/
classmidi.html
391 lines (357 loc) · 19.3 KB
/
classmidi.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: midi Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classmidi.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="classmidi-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">midi Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="midi__driver_8h_source.html">midi_driver.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmidi_1_1midi__messages.html">midi_messages</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Struct that holds useful messgae template information. <a href="structmidi_1_1midi__messages.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmidi_1_1midi__struct.html">midi_struct</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Struct that contains information relating to this particular instance of midi. <a href="structmidi_1_1midi__struct.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a95b6d2cee1581813195eb4db27978ef5"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmidi_1_1midi__struct.html">midi::midi_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi.html#a95b6d2cee1581813195eb4db27978ef5">midi_t</a></td></tr>
<tr class="memdesc:a95b6d2cee1581813195eb4db27978ef5"><td class="mdescLeft"> </td><td class="mdescRight">Struct that contains information relating to this particular instance of midi. <br /></td></tr>
<tr class="separator:a95b6d2cee1581813195eb4db27978ef5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae1d4ba35efda38f2cdb719c273650742"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structmidi_1_1midi__messages.html">midi::midi_messages</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi.html#ae1d4ba35efda38f2cdb719c273650742">midi_messages</a></td></tr>
<tr class="memdesc:ae1d4ba35efda38f2cdb719c273650742"><td class="mdescLeft"> </td><td class="mdescRight">Struct that holds useful messgae template information. <br /></td></tr>
<tr class="separator:ae1d4ba35efda38f2cdb719c273650742"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9d55e64790d5f583ddd43e334f38dd90"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi.html#a9d55e64790d5f583ddd43e334f38dd90">note_on</a> (uint32_t note)</td></tr>
<tr class="memdesc:a9d55e64790d5f583ddd43e334f38dd90"><td class="mdescLeft"> </td><td class="mdescRight">Create and buffer a MIDI note on message. <br /></td></tr>
<tr class="separator:a9d55e64790d5f583ddd43e334f38dd90"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19a2d1b07bf812eb5b718d120643b984"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi.html#a19a2d1b07bf812eb5b718d120643b984">note_off</a> (uint32_t note)</td></tr>
<tr class="memdesc:a19a2d1b07bf812eb5b718d120643b984"><td class="mdescLeft"> </td><td class="mdescRight">Create and buffer a MIDI note on message. <br /></td></tr>
<tr class="separator:a19a2d1b07bf812eb5b718d120643b984"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acbebc3ed13d35e40d0c53623a53bde17"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi.html#acbebc3ed13d35e40d0c53623a53bde17">cc_msg</a> (uint32_t cc_num, uint32_t value)</td></tr>
<tr class="memdesc:acbebc3ed13d35e40d0c53623a53bde17"><td class="mdescLeft"> </td><td class="mdescRight">Create and buffer a MIDI CC message. <br /></td></tr>
<tr class="separator:acbebc3ed13d35e40d0c53623a53bde17"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75ed95f176cb7a82a3e21a5419e70561"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi.html#a75ed95f176cb7a82a3e21a5419e70561">send_midi</a> ()</td></tr>
<tr class="memdesc:a75ed95f176cb7a82a3e21a5419e70561"><td class="mdescLeft"> </td><td class="mdescRight">Create and buffer a MIDI CC message. <br /></td></tr>
<tr class="separator:a75ed95f176cb7a82a3e21a5419e70561"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a12a57df6ce6e50032a46aa08ce6bd1ad"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi.html#a12a57df6ce6e50032a46aa08ce6bd1ad">midi</a> (uint32_t channel, <a class="el" href="group__UART__Exported__Types.html#ga5de4a49eb132735325e706f406c69d6e">UART_HandleTypeDef</a> *uart_ptr)</td></tr>
<tr class="separator:a12a57df6ce6e50032a46aa08ce6bd1ad"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a2dd8fd17f3cd84a602e33c7591b73acb"><td class="memItemLeft" align="right" valign="top">std::vector< uint8_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi.html#a2dd8fd17f3cd84a602e33c7591b73acb">msg_buf</a></td></tr>
<tr class="memdesc:a2dd8fd17f3cd84a602e33c7591b73acb"><td class="mdescLeft"> </td><td class="mdescRight">Buffer that holds all of the messages to be sent. <br /></td></tr>
<tr class="separator:a2dd8fd17f3cd84a602e33c7591b73acb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af00c1edb7fe442a77b27dbeb9db94600"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmidi.html#a95b6d2cee1581813195eb4db27978ef5">midi_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmidi.html#af00c1edb7fe442a77b27dbeb9db94600">midi_struct</a> {0,0}</td></tr>
<tr class="separator:af00c1edb7fe442a77b27dbeb9db94600"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ae1d4ba35efda38f2cdb719c273650742" name="ae1d4ba35efda38f2cdb719c273650742"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1d4ba35efda38f2cdb719c273650742">◆ </a></span>midi_messages</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structmidi_1_1midi__messages.html">midi::midi_messages</a> <a class="el" href="structmidi_1_1midi__messages.html">midi::midi_messages</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Struct that holds useful messgae template information. </p>
</div>
</div>
<a id="a95b6d2cee1581813195eb4db27978ef5" name="a95b6d2cee1581813195eb4db27978ef5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95b6d2cee1581813195eb4db27978ef5">◆ </a></span>midi_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structmidi_1_1midi__struct.html">midi::midi_struct</a> <a class="el" href="classmidi.html#a95b6d2cee1581813195eb4db27978ef5">midi::midi_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Struct that contains information relating to this particular instance of midi. </p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a12a57df6ce6e50032a46aa08ce6bd1ad" name="a12a57df6ce6e50032a46aa08ce6bd1ad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12a57df6ce6e50032a46aa08ce6bd1ad">◆ </a></span>midi()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">midi::midi </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>channel</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__UART__Exported__Types.html#ga5de4a49eb132735325e706f406c69d6e">UART_HandleTypeDef</a> * </td>
<td class="paramname"><em>uart_ptr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="acbebc3ed13d35e40d0c53623a53bde17" name="acbebc3ed13d35e40d0c53623a53bde17"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbebc3ed13d35e40d0c53623a53bde17">◆ </a></span>cc_msg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void midi::cc_msg </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>cc_num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>cc_val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create and buffer a MIDI CC message. </p>
<pre class="fragment">These messages tell the device to change a parameter.
The byte structure is as follows:
0xb* **** **** **** ****
MIDI CC, or MIDI Continuous Control, allows for non-note parameters of an instrument to be changed.
This would be akin to turning a knob on the instrument remotely. In practice, this can be taken
much further, with LFOs, pseudo-envelopes, and other control signals possible. There are 127 total
CC messages, which while not defined in any formal standard, have widely been standardized to
ensure consistent control between devices.
@param cc_num The particular CC number to be sent.
@param cc_val The CC value to be sent.
</pre>
</div>
</div>
<a id="a19a2d1b07bf812eb5b718d120643b984" name="a19a2d1b07bf812eb5b718d120643b984"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19a2d1b07bf812eb5b718d120643b984">◆ </a></span>note_off()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void midi::note_off </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>note</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create and buffer a MIDI note on message. </p>
<pre class="fragment">These messages tell the device that a note has been released.
The byte structure is as follows:
0x8* **** **** **** ****
Without sending a note off command, a note will keep playing as if it were held down - the actual
behaviour this creates is defined by the device being controlled. Interestingly, an 'on' note can
be given another note on command, in which case the note will retrigger. If this happens, it will
still just need one note off command to turn off.
@param note The note number to be turned off.
</pre>
</div>
</div>
<a id="a9d55e64790d5f583ddd43e334f38dd90" name="a9d55e64790d5f583ddd43e334f38dd90"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d55e64790d5f583ddd43e334f38dd90">◆ </a></span>note_on()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void midi::note_on </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>note</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create and buffer a MIDI note on message. </p>
<pre class="fragment">These messages tell the device that a note has been played
The byte structure is as follows:
0x9* **** **** **** ****
The first half of the status byte is the type of command (note on in this case). The second half is
the channel to send the message on. The data bytes give note and velocity, respectively. the
following example sends a middle C with velocity 100 on channel 10:
0x9A 0x3C 0x64
@param note The note number to be turned off.
</pre>
</div>
</div>
<a id="a75ed95f176cb7a82a3e21a5419e70561" name="a75ed95f176cb7a82a3e21a5419e70561"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75ed95f176cb7a82a3e21a5419e70561">◆ </a></span>send_midi()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void midi::send_midi </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create and buffer a MIDI CC message. </p>
<pre class="fragment">This function sends all queued messages in the buffer.
</pre>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="af00c1edb7fe442a77b27dbeb9db94600" name="af00c1edb7fe442a77b27dbeb9db94600"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af00c1edb7fe442a77b27dbeb9db94600">◆ </a></span>midi_struct</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmidi.html#a95b6d2cee1581813195eb4db27978ef5">midi_t</a> <a class="el" href="structmidi_1_1midi__struct.html">midi::midi_struct</a> {0,0}</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2dd8fd17f3cd84a602e33c7591b73acb" name="a2dd8fd17f3cd84a602e33c7591b73acb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2dd8fd17f3cd84a602e33c7591b73acb">◆ </a></span>msg_buf</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector<uint8_t> midi::msg_buf</td>
</tr>
</table>
</div><div class="memdoc">
<p>Buffer that holds all of the messages to be sent. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Core/Inc/<a class="el" href="midi__driver_8h_source.html">midi_driver.h</a></li>
<li>Core/Src/<a class="el" href="midi__driver_8cpp.html">midi_driver.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classmidi.html">midi</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
</ul>
</div>
</body>
</html>