/usr/share/doc/libjuce/apiref/classMidiFile.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: MidiFile 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="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" />
</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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- 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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classMidiFile-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">MidiFile Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Reads/writes standard midi format files.
<a href="classMidiFile.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a989fec6d479c0ebf68ef72224e58e894"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#a989fec6d479c0ebf68ef72224e58e894">MidiFile</a> ()</td></tr>
<tr class="memdesc:a989fec6d479c0ebf68ef72224e58e894"><td class="mdescLeft"> </td><td class="mdescRight">Creates an empty <a class="el" href="classMidiFile.html" title="Reads/writes standard midi format files. ">MidiFile</a> object. <a href="#a989fec6d479c0ebf68ef72224e58e894">More...</a><br /></td></tr>
<tr class="separator:a989fec6d479c0ebf68ef72224e58e894"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d14e6df12f54918a8caf500f03fd78e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#a8d14e6df12f54918a8caf500f03fd78e">~MidiFile</a> ()</td></tr>
<tr class="memdesc:a8d14e6df12f54918a8caf500f03fd78e"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a8d14e6df12f54918a8caf500f03fd78e">More...</a><br /></td></tr>
<tr class="separator:a8d14e6df12f54918a8caf500f03fd78e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a908f8db88d0740c8de225c31660d71a0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#a908f8db88d0740c8de225c31660d71a0">getNumTracks</a> () const noexcept</td></tr>
<tr class="memdesc:a908f8db88d0740c8de225c31660d71a0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of tracks in the file. <a href="#a908f8db88d0740c8de225c31660d71a0">More...</a><br /></td></tr>
<tr class="separator:a908f8db88d0740c8de225c31660d71a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a334aa932bc738914eb3e1578a7ee1d7c"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classMidiMessageSequence.html">MidiMessageSequence</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#a334aa932bc738914eb3e1578a7ee1d7c">getTrack</a> (int index) const noexcept</td></tr>
<tr class="memdesc:a334aa932bc738914eb3e1578a7ee1d7c"><td class="mdescLeft"> </td><td class="mdescRight">Returns a pointer to one of the tracks in the file. <a href="#a334aa932bc738914eb3e1578a7ee1d7c">More...</a><br /></td></tr>
<tr class="separator:a334aa932bc738914eb3e1578a7ee1d7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ff930286a6fa4531df163480b22a313"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#a9ff930286a6fa4531df163480b22a313">addTrack</a> (const <a class="el" href="classMidiMessageSequence.html">MidiMessageSequence</a> &trackSequence)</td></tr>
<tr class="memdesc:a9ff930286a6fa4531df163480b22a313"><td class="mdescLeft"> </td><td class="mdescRight">Adds a midi track to the file. <a href="#a9ff930286a6fa4531df163480b22a313">More...</a><br /></td></tr>
<tr class="separator:a9ff930286a6fa4531df163480b22a313"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab676af68f56e7cc8b2e0a4afdaf52d20"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#ab676af68f56e7cc8b2e0a4afdaf52d20">clear</a> ()</td></tr>
<tr class="memdesc:ab676af68f56e7cc8b2e0a4afdaf52d20"><td class="mdescLeft"> </td><td class="mdescRight">Removes all midi tracks from the file. <a href="#ab676af68f56e7cc8b2e0a4afdaf52d20">More...</a><br /></td></tr>
<tr class="separator:ab676af68f56e7cc8b2e0a4afdaf52d20"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a084eacf906fca71b2c9436aa1c14ed16"><td class="memItemLeft" align="right" valign="top">short </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#a084eacf906fca71b2c9436aa1c14ed16">getTimeFormat</a> () const noexcept</td></tr>
<tr class="memdesc:a084eacf906fca71b2c9436aa1c14ed16"><td class="mdescLeft"> </td><td class="mdescRight">Returns the raw time format code that will be written to a stream. <a href="#a084eacf906fca71b2c9436aa1c14ed16">More...</a><br /></td></tr>
<tr class="separator:a084eacf906fca71b2c9436aa1c14ed16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab18143cad013db21a71735b01aef2a9f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#ab18143cad013db21a71735b01aef2a9f">setTicksPerQuarterNote</a> (int ticksPerQuarterNote) noexcept</td></tr>
<tr class="memdesc:ab18143cad013db21a71735b01aef2a9f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the time format to use when this file is written to a stream. <a href="#ab18143cad013db21a71735b01aef2a9f">More...</a><br /></td></tr>
<tr class="separator:ab18143cad013db21a71735b01aef2a9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab63f442d05b8d7c2742de4515f6e8917"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#ab63f442d05b8d7c2742de4515f6e8917">setSmpteTimeFormat</a> (int framesPerSecond, int subframeResolution) noexcept</td></tr>
<tr class="memdesc:ab63f442d05b8d7c2742de4515f6e8917"><td class="mdescLeft"> </td><td class="mdescRight">Sets the time format to use when this file is written to a stream. <a href="#ab63f442d05b8d7c2742de4515f6e8917">More...</a><br /></td></tr>
<tr class="separator:ab63f442d05b8d7c2742de4515f6e8917"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a4026fb09fb725ab233ca0c996aa4e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#a7a4026fb09fb725ab233ca0c996aa4e8">findAllTempoEvents</a> (<a class="el" href="classMidiMessageSequence.html">MidiMessageSequence</a> &tempoChangeEvents) const</td></tr>
<tr class="memdesc:a7a4026fb09fb725ab233ca0c996aa4e8"><td class="mdescLeft"> </td><td class="mdescRight">Makes a list of all the tempo-change meta-events from all tracks in the midi file. <a href="#a7a4026fb09fb725ab233ca0c996aa4e8">More...</a><br /></td></tr>
<tr class="separator:a7a4026fb09fb725ab233ca0c996aa4e8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54507b67317e683303a28ae7ad863737"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#a54507b67317e683303a28ae7ad863737">findAllTimeSigEvents</a> (<a class="el" href="classMidiMessageSequence.html">MidiMessageSequence</a> &timeSigEvents) const</td></tr>
<tr class="memdesc:a54507b67317e683303a28ae7ad863737"><td class="mdescLeft"> </td><td class="mdescRight">Makes a list of all the time-signature meta-events from all tracks in the midi file. <a href="#a54507b67317e683303a28ae7ad863737">More...</a><br /></td></tr>
<tr class="separator:a54507b67317e683303a28ae7ad863737"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aadf60b9be97a44d09f5f4ec244767687"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#aadf60b9be97a44d09f5f4ec244767687">findAllKeySigEvents</a> (<a class="el" href="classMidiMessageSequence.html">MidiMessageSequence</a> &keySigEvents) const</td></tr>
<tr class="memdesc:aadf60b9be97a44d09f5f4ec244767687"><td class="mdescLeft"> </td><td class="mdescRight">Makes a list of all the time-signature meta-events from all tracks in the midi file. <a href="#aadf60b9be97a44d09f5f4ec244767687">More...</a><br /></td></tr>
<tr class="separator:aadf60b9be97a44d09f5f4ec244767687"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a268504f50fcb8cc49f716259cfae0033"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#a268504f50fcb8cc49f716259cfae0033">getLastTimestamp</a> () const</td></tr>
<tr class="memdesc:a268504f50fcb8cc49f716259cfae0033"><td class="mdescLeft"> </td><td class="mdescRight">Returns the latest timestamp in any of the tracks. <a href="#a268504f50fcb8cc49f716259cfae0033">More...</a><br /></td></tr>
<tr class="separator:a268504f50fcb8cc49f716259cfae0033"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a541d03108b4bcbaf2124eee401b2d92f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#a541d03108b4bcbaf2124eee401b2d92f">readFrom</a> (<a class="el" href="classInputStream.html">InputStream</a> &sourceStream)</td></tr>
<tr class="memdesc:a541d03108b4bcbaf2124eee401b2d92f"><td class="mdescLeft"> </td><td class="mdescRight">Reads a midi file format stream. <a href="#a541d03108b4bcbaf2124eee401b2d92f">More...</a><br /></td></tr>
<tr class="separator:a541d03108b4bcbaf2124eee401b2d92f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2673604f2af21a69361fa6b4c8c35949"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#a2673604f2af21a69361fa6b4c8c35949">writeTo</a> (<a class="el" href="classOutputStream.html">OutputStream</a> &destStream, int midiFileType=1)</td></tr>
<tr class="memdesc:a2673604f2af21a69361fa6b4c8c35949"><td class="mdescLeft"> </td><td class="mdescRight">Writes the midi tracks as a standard midi file. <a href="#a2673604f2af21a69361fa6b4c8c35949">More...</a><br /></td></tr>
<tr class="separator:a2673604f2af21a69361fa6b4c8c35949"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af66c3497ec6109a9c7c1cf1f474c8b95"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiFile.html#af66c3497ec6109a9c7c1cf1f474c8b95">convertTimestampTicksToSeconds</a> ()</td></tr>
<tr class="memdesc:af66c3497ec6109a9c7c1cf1f474c8b95"><td class="mdescLeft"> </td><td class="mdescRight">Converts the timestamp of all the midi events from midi ticks to seconds. <a href="#af66c3497ec6109a9c7c1cf1f474c8b95">More...</a><br /></td></tr>
<tr class="separator:af66c3497ec6109a9c7c1cf1f474c8b95"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Reads/writes standard midi format files. </p>
<p>To read a midi file, create a <a class="el" href="classMidiFile.html" title="Reads/writes standard midi format files. ">MidiFile</a> object and call its <a class="el" href="classMidiFile.html#a541d03108b4bcbaf2124eee401b2d92f" title="Reads a midi file format stream. ">readFrom()</a> method. You can then get the individual midi tracks from it using the <a class="el" href="classMidiFile.html#a334aa932bc738914eb3e1578a7ee1d7c" title="Returns a pointer to one of the tracks in the file. ">getTrack()</a> method.</p>
<p>To write a file, create a <a class="el" href="classMidiFile.html" title="Reads/writes standard midi format files. ">MidiFile</a> object, add some <a class="el" href="classMidiMessageSequence.html" title="A sequence of timestamped midi messages. ">MidiMessageSequence</a> objects to it using the <a class="el" href="classMidiFile.html#a9ff930286a6fa4531df163480b22a313" title="Adds a midi track to the file. ">addTrack()</a> method, and then call its <a class="el" href="classMidiFile.html#a2673604f2af21a69361fa6b4c8c35949" title="Writes the midi tracks as a standard midi file. ">writeTo()</a> method to stream it out.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMidiMessageSequence.html" title="A sequence of timestamped midi messages. ">MidiMessageSequence</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a989fec6d479c0ebf68ef72224e58e894"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a989fec6d479c0ebf68ef72224e58e894">§ </a></span>MidiFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MidiFile::MidiFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an empty <a class="el" href="classMidiFile.html" title="Reads/writes standard midi format files. ">MidiFile</a> object. </p>
</div>
</div>
<a id="a8d14e6df12f54918a8caf500f03fd78e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d14e6df12f54918a8caf500f03fd78e">§ </a></span>~MidiFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MidiFile::~MidiFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a908f8db88d0740c8de225c31660d71a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a908f8db88d0740c8de225c31660d71a0">§ </a></span>getNumTracks()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int MidiFile::getNumTracks </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the number of tracks in the file. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMidiFile.html#a334aa932bc738914eb3e1578a7ee1d7c" title="Returns a pointer to one of the tracks in the file. ">getTrack</a>, <a class="el" href="classMidiFile.html#a9ff930286a6fa4531df163480b22a313" title="Adds a midi track to the file. ">addTrack</a> </dd></dl>
</div>
</div>
<a id="a334aa932bc738914eb3e1578a7ee1d7c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a334aa932bc738914eb3e1578a7ee1d7c">§ </a></span>getTrack()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classMidiMessageSequence.html">MidiMessageSequence</a>* MidiFile::getTrack </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a pointer to one of the tracks in the file. </p>
<dl class="section return"><dt>Returns</dt><dd>a pointer to the track, or nullptr if the index is out-of-range </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMidiFile.html#a908f8db88d0740c8de225c31660d71a0" title="Returns the number of tracks in the file. ">getNumTracks</a>, <a class="el" href="classMidiFile.html#a9ff930286a6fa4531df163480b22a313" title="Adds a midi track to the file. ">addTrack</a> </dd></dl>
</div>
</div>
<a id="a9ff930286a6fa4531df163480b22a313"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ff930286a6fa4531df163480b22a313">§ </a></span>addTrack()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiFile::addTrack </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classMidiMessageSequence.html">MidiMessageSequence</a> & </td>
<td class="paramname"><em>trackSequence</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a midi track to the file. </p>
<p>This will make its own internal copy of the sequence that is passed-in. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classMidiFile.html#a908f8db88d0740c8de225c31660d71a0" title="Returns the number of tracks in the file. ">getNumTracks</a>, <a class="el" href="classMidiFile.html#a334aa932bc738914eb3e1578a7ee1d7c" title="Returns a pointer to one of the tracks in the file. ">getTrack</a> </dd></dl>
</div>
</div>
<a id="ab676af68f56e7cc8b2e0a4afdaf52d20"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab676af68f56e7cc8b2e0a4afdaf52d20">§ </a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiFile::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes all midi tracks from the file. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMidiFile.html#a908f8db88d0740c8de225c31660d71a0" title="Returns the number of tracks in the file. ">getNumTracks</a> </dd></dl>
</div>
</div>
<a id="a084eacf906fca71b2c9436aa1c14ed16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a084eacf906fca71b2c9436aa1c14ed16">§ </a></span>getTimeFormat()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">short MidiFile::getTimeFormat </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the raw time format code that will be written to a stream. </p>
<p>After reading a midi file, this method will return the time-format that was read from the file's header. It can be changed using the <a class="el" href="classMidiFile.html#ab18143cad013db21a71735b01aef2a9f" title="Sets the time format to use when this file is written to a stream. ">setTicksPerQuarterNote()</a> or <a class="el" href="classMidiFile.html#ab63f442d05b8d7c2742de4515f6e8917" title="Sets the time format to use when this file is written to a stream. ">setSmpteTimeFormat()</a> methods.</p>
<p>If the value returned is positive, it indicates the number of midi ticks per quarter-note - see <a class="el" href="classMidiFile.html#ab18143cad013db21a71735b01aef2a9f" title="Sets the time format to use when this file is written to a stream. ">setTicksPerQuarterNote()</a>.</p>
<p>It it's negative, the upper byte indicates the frames-per-second (but negative), and the lower byte is the number of ticks per frame - see <a class="el" href="classMidiFile.html#ab63f442d05b8d7c2742de4515f6e8917" title="Sets the time format to use when this file is written to a stream. ">setSmpteTimeFormat()</a>. </p>
</div>
</div>
<a id="ab18143cad013db21a71735b01aef2a9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab18143cad013db21a71735b01aef2a9f">§ </a></span>setTicksPerQuarterNote()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MidiFile::setTicksPerQuarterNote </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>ticksPerQuarterNote</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the time format to use when this file is written to a stream. </p>
<p>If this is called, the file will be written as bars/beats using the specified resolution, rather than SMPTE absolute times, as would be used if <a class="el" href="classMidiFile.html#ab63f442d05b8d7c2742de4515f6e8917" title="Sets the time format to use when this file is written to a stream. ">setSmpteTimeFormat()</a> had been called instead.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ticksPerQuarterNote</td><td>e.g. 96, 960 </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classMidiFile.html#ab63f442d05b8d7c2742de4515f6e8917" title="Sets the time format to use when this file is written to a stream. ">setSmpteTimeFormat</a> </dd></dl>
</div>
</div>
<a id="ab63f442d05b8d7c2742de4515f6e8917"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab63f442d05b8d7c2742de4515f6e8917">§ </a></span>setSmpteTimeFormat()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void MidiFile::setSmpteTimeFormat </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>framesPerSecond</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>subframeResolution</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">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the time format to use when this file is written to a stream. </p>
<p>If this is called, the file will be written using absolute times, rather than bars/beats as would be the case if setTicksPerBeat() had been called instead.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">framesPerSecond</td><td>must be 24, 25, 29 or 30 </td></tr>
<tr><td class="paramname">subframeResolution</td><td>the sub-second resolution, e.g. 4 (midi time code), 8, 10, 80 (SMPTE bit resolution), or 100. For millisecond timing, setSmpteTimeFormat (25, 40) </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd>setTicksPerBeat </dd></dl>
</div>
</div>
<a id="a7a4026fb09fb725ab233ca0c996aa4e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a4026fb09fb725ab233ca0c996aa4e8">§ </a></span>findAllTempoEvents()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiFile::findAllTempoEvents </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classMidiMessageSequence.html">MidiMessageSequence</a> & </td>
<td class="paramname"><em>tempoChangeEvents</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes a list of all the tempo-change meta-events from all tracks in the midi file. </p>
<p>Useful for finding the positions of all the tempo changes in a file. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">tempoChangeEvents</td><td>a list to which all the events will be added </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a54507b67317e683303a28ae7ad863737"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54507b67317e683303a28ae7ad863737">§ </a></span>findAllTimeSigEvents()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiFile::findAllTimeSigEvents </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classMidiMessageSequence.html">MidiMessageSequence</a> & </td>
<td class="paramname"><em>timeSigEvents</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes a list of all the time-signature meta-events from all tracks in the midi file. </p>
<p>Useful for finding the positions of all the tempo changes in a file. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timeSigEvents</td><td>a list to which all the events will be added </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aadf60b9be97a44d09f5f4ec244767687"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadf60b9be97a44d09f5f4ec244767687">§ </a></span>findAllKeySigEvents()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiFile::findAllKeySigEvents </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classMidiMessageSequence.html">MidiMessageSequence</a> & </td>
<td class="paramname"><em>keySigEvents</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Makes a list of all the time-signature meta-events from all tracks in the midi file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keySigEvents</td><td>a list to which all the events will be added </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a268504f50fcb8cc49f716259cfae0033"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a268504f50fcb8cc49f716259cfae0033">§ </a></span>getLastTimestamp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double MidiFile::getLastTimestamp </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the latest timestamp in any of the tracks. </p>
<p>(Useful for finding the length of the file). </p>
</div>
</div>
<a id="a541d03108b4bcbaf2124eee401b2d92f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a541d03108b4bcbaf2124eee401b2d92f">§ </a></span>readFrom()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool MidiFile::readFrom </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classInputStream.html">InputStream</a> & </td>
<td class="paramname"><em>sourceStream</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a midi file format stream. </p>
<p>After calling this, you can get the tracks that were read from the file by using the <a class="el" href="classMidiFile.html#a908f8db88d0740c8de225c31660d71a0" title="Returns the number of tracks in the file. ">getNumTracks()</a> and <a class="el" href="classMidiFile.html#a334aa932bc738914eb3e1578a7ee1d7c" title="Returns a pointer to one of the tracks in the file. ">getTrack()</a> methods.</p>
<p>The timestamps of the midi events in the tracks will represent their positions in terms of midi ticks. To convert them to seconds, use the <a class="el" href="classMidiFile.html#af66c3497ec6109a9c7c1cf1f474c8b95" title="Converts the timestamp of all the midi events from midi ticks to seconds. ">convertTimestampTicksToSeconds()</a> method.</p>
<dl class="section return"><dt>Returns</dt><dd>true if the stream was read successfully </dd></dl>
</div>
</div>
<a id="a2673604f2af21a69361fa6b4c8c35949"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2673604f2af21a69361fa6b4c8c35949">§ </a></span>writeTo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool MidiFile::writeTo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOutputStream.html">OutputStream</a> & </td>
<td class="paramname"><em>destStream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>midiFileType</em> = <code>1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes the midi tracks as a standard midi file. </p>
<p>The midiFileType value is written as the file's format type, which can be 0, 1 or 2 - see the midi file spec for more info about that. </p><dl class="section return"><dt>Returns</dt><dd>true if the operation succeeded. </dd></dl>
</div>
</div>
<a id="af66c3497ec6109a9c7c1cf1f474c8b95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af66c3497ec6109a9c7c1cf1f474c8b95">§ </a></span>convertTimestampTicksToSeconds()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiFile::convertTimestampTicksToSeconds </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Converts the timestamp of all the midi events from midi ticks to seconds. </p>
<p>This will use the midi time format and tempo/time signature info in the tracks to convert all the timestamps to absolute values in seconds. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__MidiFile_8h.html">juce_MidiFile.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|