/usr/share/doc/libopenmpt-doc/html/namespaceopenmpt.html is in libopenmpt-doc 0.3.6-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 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 681 682 683 684 685 | <!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libopenmpt: openmpt Namespace 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>
<script type="text/javascript">
$(document).ready(initResizable);
</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">libopenmpt
 <span id="projectnumber">0.3.6+release.autotools</span>
</div>
<div id="projectbrief">cross-platform C++ and C library to decode tracked music files</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<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>
</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">
$(document).ready(function(){initNavTree('namespaceopenmpt.html','');});
</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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> |
<a href="#nested-classes">Classes</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">openmpt Namespace Reference<div class="ingroups"><a class="el" href="group__libopenmpt__cpp.html">libopenmpt C++</a> | <a class="el" href="group__libopenmpt__ext__cpp.html">libopenmpt_ext C++</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceopenmpt_1_1ext"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt_1_1ext.html">ext</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:namespaceopenmpt_1_1string"><td class="memItemLeft" align="right" valign="top">  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt_1_1string.html">string</a></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 name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenmpt_1_1exception.html">exception</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">libopenmpt exception base class <a href="classopenmpt_1_1exception.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">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenmpt_1_1module.html">module</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classopenmpt_1_1module__ext.html">module_ext</a></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 name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a2bfab5a4d171e48c0de55806174552b1"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#a2bfab5a4d171e48c0de55806174552b1">probe_file_header_result</a> { <a class="el" href="namespaceopenmpt.html#a2bfab5a4d171e48c0de55806174552b1a30801347bba0cd61e700605a10d108b7">probe_file_header_result_success</a> = 1,
<a class="el" href="namespaceopenmpt.html#a2bfab5a4d171e48c0de55806174552b1a31d073e7dc36b213618f635ec90f5d2b">probe_file_header_result_failure</a> = 0,
<a class="el" href="namespaceopenmpt.html#a2bfab5a4d171e48c0de55806174552b1acf3e6c33d72266e9c0d34da84fb7ec1f">probe_file_header_result_wantmoredata</a> = -1
}<tr class="memdesc:a2bfab5a4d171e48c0de55806174552b1"><td class="mdescLeft"> </td><td class="mdescRight">Possible return values for <a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a>. <a href="namespaceopenmpt.html#a2bfab5a4d171e48c0de55806174552b1">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a2bfab5a4d171e48c0de55806174552b1"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aeece2f6ce1045a5f519c93ce19e6eef3"><td class="memItemLeft" align="right" valign="top">LIBOPENMPT_CXX_API std::uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#aeece2f6ce1045a5f519c93ce19e6eef3">get_library_version</a> ()</td></tr>
<tr class="memdesc:aeece2f6ce1045a5f519c93ce19e6eef3"><td class="mdescLeft"> </td><td class="mdescRight">Get the libopenmpt version number. <a href="#aeece2f6ce1045a5f519c93ce19e6eef3">More...</a><br /></td></tr>
<tr class="separator:aeece2f6ce1045a5f519c93ce19e6eef3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac37146367d4849a17a297d388cfb4811"><td class="memItemLeft" align="right" valign="top">LIBOPENMPT_CXX_API std::uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#ac37146367d4849a17a297d388cfb4811">get_core_version</a> ()</td></tr>
<tr class="memdesc:ac37146367d4849a17a297d388cfb4811"><td class="mdescLeft"> </td><td class="mdescRight">Get the core version number. <a href="#ac37146367d4849a17a297d388cfb4811">More...</a><br /></td></tr>
<tr class="separator:ac37146367d4849a17a297d388cfb4811"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa2081245974442462d76e8b9bc9380a"><td class="memItemLeft" align="right" valign="top">LIBOPENMPT_CXX_API std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#aaa2081245974442462d76e8b9bc9380a">get_supported_extensions</a> ()</td></tr>
<tr class="memdesc:aaa2081245974442462d76e8b9bc9380a"><td class="mdescLeft"> </td><td class="mdescRight">Get a list of supported file extensions. <a href="#aaa2081245974442462d76e8b9bc9380a">More...</a><br /></td></tr>
<tr class="separator:aaa2081245974442462d76e8b9bc9380a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aafc5dab5b9c0b8324bbedcc01b59a3c0"><td class="memItemLeft" align="right" valign="top">LIBOPENMPT_CXX_API bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#aafc5dab5b9c0b8324bbedcc01b59a3c0">is_extension_supported</a> (const std::string &extension)</td></tr>
<tr class="memdesc:aafc5dab5b9c0b8324bbedcc01b59a3c0"><td class="mdescLeft"> </td><td class="mdescRight">Query whether a file extension is supported. <a href="#aafc5dab5b9c0b8324bbedcc01b59a3c0">More...</a><br /></td></tr>
<tr class="separator:aafc5dab5b9c0b8324bbedcc01b59a3c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a95fd9b6781cd291b48a1c3e12a3c85e1"><td class="memItemLeft" align="right" valign="top">LIBOPENMPT_CXX_API double </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#a95fd9b6781cd291b48a1c3e12a3c85e1">could_open_probability</a> (std::istream &stream, double effort=1.0, std::ostream &log=std::clog)</td></tr>
<tr class="memdesc:a95fd9b6781cd291b48a1c3e12a3c85e1"><td class="mdescLeft"> </td><td class="mdescRight">Roughly scan the input stream to find out whether libopenmpt might be able to open it. <a href="#a95fd9b6781cd291b48a1c3e12a3c85e1">More...</a><br /></td></tr>
<tr class="separator:a95fd9b6781cd291b48a1c3e12a3c85e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad5e4ff0e24869d7a9808ac4262283f2"><td class="memItemLeft" align="right" valign="top">LIBOPENMPT_ATTR_DEPRECATED LIBOPENMPT_CXX_API double </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#aad5e4ff0e24869d7a9808ac4262283f2">could_open_propability</a> (std::istream &stream, double effort=1.0, std::ostream &log=std::clog)</td></tr>
<tr class="memdesc:aad5e4ff0e24869d7a9808ac4262283f2"><td class="mdescLeft"> </td><td class="mdescRight">Roughly scan the input stream to find out whether libopenmpt might be able to open it. <a href="#aad5e4ff0e24869d7a9808ac4262283f2">More...</a><br /></td></tr>
<tr class="separator:aad5e4ff0e24869d7a9808ac4262283f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af70a8d33fdceca5a821755106e840dcb"><td class="memItemLeft" align="right" valign="top">LIBOPENMPT_CXX_API std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#af70a8d33fdceca5a821755106e840dcb">probe_file_header_get_recommended_size</a> ()</td></tr>
<tr class="memdesc:af70a8d33fdceca5a821755106e840dcb"><td class="mdescLeft"> </td><td class="mdescRight">Get recommended header size for successfull format probing. <a href="#af70a8d33fdceca5a821755106e840dcb">More...</a><br /></td></tr>
<tr class="separator:af70a8d33fdceca5a821755106e840dcb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad77e7cf2361d664fda8ae8461c1dc7a0"><td class="memItemLeft" align="right" valign="top">LIBOPENMPT_CXX_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0">probe_file_header</a> (std::uint64_t flags, const std::uint8_t *data, std::size_t size, std::uint64_t filesize)</td></tr>
<tr class="memdesc:ad77e7cf2361d664fda8ae8461c1dc7a0"><td class="mdescLeft"> </td><td class="mdescRight">Probe the provided bytes from the beginning of a file for supported file format headers to find out whether libopenmpt might be able to open it. <a href="#ad77e7cf2361d664fda8ae8461c1dc7a0">More...</a><br /></td></tr>
<tr class="separator:ad77e7cf2361d664fda8ae8461c1dc7a0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77facf516dd9b626847f91ac26047336"><td class="memItemLeft" align="right" valign="top">LIBOPENMPT_CXX_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#a77facf516dd9b626847f91ac26047336">probe_file_header</a> (std::uint64_t flags, const std::uint8_t *data, std::size_t size)</td></tr>
<tr class="memdesc:a77facf516dd9b626847f91ac26047336"><td class="mdescLeft"> </td><td class="mdescRight">Probe the provided bytes from the beginning of a file for supported file format headers to find out whether libopenmpt might be able to open it. <a href="#a77facf516dd9b626847f91ac26047336">More...</a><br /></td></tr>
<tr class="separator:a77facf516dd9b626847f91ac26047336"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6412e44030e40ca67aaa187691ad8e9c"><td class="memItemLeft" align="right" valign="top">LIBOPENMPT_CXX_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#a6412e44030e40ca67aaa187691ad8e9c">probe_file_header</a> (std::uint64_t flags, std::istream &stream)</td></tr>
<tr class="memdesc:a6412e44030e40ca67aaa187691ad8e9c"><td class="mdescLeft"> </td><td class="mdescRight">Probe the provided bytes from the beginning of a file for supported file format headers to find out whether libopenmpt might be able to open it. <a href="#a6412e44030e40ca67aaa187691ad8e9c">More...</a><br /></td></tr>
<tr class="separator:a6412e44030e40ca67aaa187691ad8e9c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a92c11980bfec1deb5f5d4f8fa6e4e998"><td class="memItemLeft" align="right" valign="top">static const std::uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#a92c11980bfec1deb5f5d4f8fa6e4e998">probe_file_header_flags_modules</a> = 0x1ul</td></tr>
<tr class="memdesc:a92c11980bfec1deb5f5d4f8fa6e4e998"><td class="mdescLeft"> </td><td class="mdescRight">Probe for module formats in <a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a>. <a href="#a92c11980bfec1deb5f5d4f8fa6e4e998">More...</a><br /></td></tr>
<tr class="separator:a92c11980bfec1deb5f5d4f8fa6e4e998"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8b455af763397bc1b331ab5a0e47526"><td class="memItemLeft" align="right" valign="top">static const std::uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#ad8b455af763397bc1b331ab5a0e47526">probe_file_header_flags_containers</a> = 0x2ul</td></tr>
<tr class="memdesc:ad8b455af763397bc1b331ab5a0e47526"><td class="mdescLeft"> </td><td class="mdescRight">Probe for module-specific container formats in <a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a>. <a href="#ad8b455af763397bc1b331ab5a0e47526">More...</a><br /></td></tr>
<tr class="separator:ad8b455af763397bc1b331ab5a0e47526"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae58576f977f7d74f12f37344223a0e78"><td class="memItemLeft" align="right" valign="top">static const std::uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#ae58576f977f7d74f12f37344223a0e78">probe_file_header_flags_default</a> = <a class="el" href="namespaceopenmpt.html#a92c11980bfec1deb5f5d4f8fa6e4e998">probe_file_header_flags_modules</a> | <a class="el" href="namespaceopenmpt.html#ad8b455af763397bc1b331ab5a0e47526">probe_file_header_flags_containers</a></td></tr>
<tr class="memdesc:ae58576f977f7d74f12f37344223a0e78"><td class="mdescLeft"> </td><td class="mdescRight">Probe for the default set of formats in <a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a>. <a href="#ae58576f977f7d74f12f37344223a0e78">More...</a><br /></td></tr>
<tr class="separator:ae58576f977f7d74f12f37344223a0e78"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a631d4fb8e89a9f5f995827b07812c736"><td class="memItemLeft" align="right" valign="top">static const std::uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceopenmpt.html#a631d4fb8e89a9f5f995827b07812c736">probe_file_header_flags_none</a> = 0x0ul</td></tr>
<tr class="memdesc:a631d4fb8e89a9f5f995827b07812c736"><td class="mdescLeft"> </td><td class="mdescRight">Probe for no formats in <a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a>. <a href="#a631d4fb8e89a9f5f995827b07812c736">More...</a><br /></td></tr>
<tr class="separator:a631d4fb8e89a9f5f995827b07812c736"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a2bfab5a4d171e48c0de55806174552b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bfab5a4d171e48c0de55806174552b1">◆ </a></span>probe_file_header_result</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespaceopenmpt.html#a2bfab5a4d171e48c0de55806174552b1">openmpt::probe_file_header_result</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Possible return values for <a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a>. </p>
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a2bfab5a4d171e48c0de55806174552b1a30801347bba0cd61e700605a10d108b7"></a>probe_file_header_result_success </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a2bfab5a4d171e48c0de55806174552b1a31d073e7dc36b213618f635ec90f5d2b"></a>probe_file_header_result_failure </td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a2bfab5a4d171e48c0de55806174552b1acf3e6c33d72266e9c0d34da84fb7ec1f"></a>probe_file_header_result_wantmoredata </td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a95fd9b6781cd291b48a1c3e12a3c85e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95fd9b6781cd291b48a1c3e12a3c85e1">◆ </a></span>could_open_probability()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBOPENMPT_CXX_API double openmpt::could_open_probability </td>
<td>(</td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>effort</em> = <code>1.0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>log</em> = <code>std::clog</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Roughly scan the input stream to find out whether libopenmpt might be able to open it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stream</td><td>Input stream to scan. </td></tr>
<tr><td class="paramname">effort</td><td>Effort to make when validating stream. Effort 0.0 does not even look at stream at all and effort 1.0 completely loads the file from stream. A lower effort requires less data to be loaded but only gives a rough estimate answer. Use an effort of 0.25 to only verify the header data of the module file. </td></tr>
<tr><td class="paramname">log</td><td>Log where warning and errors are written. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Probability between 0.0 and 1.0. </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd><a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a> provides a simpler and faster interface that fits almost all use cases better. It is recommended to use <a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a> instead of <a class="el" href="namespaceopenmpt.html#a95fd9b6781cd291b48a1c3e12a3c85e1" title="Roughly scan the input stream to find out whether libopenmpt might be able to open it...">openmpt::could_open_probability()</a>. </dd>
<dd>
<a class="el" href="namespaceopenmpt.html#a95fd9b6781cd291b48a1c3e12a3c85e1" title="Roughly scan the input stream to find out whether libopenmpt might be able to open it...">openmpt::could_open_probability()</a> can return any value between 0.0 and 1.0. Only 0.0 and 1.0 are definitive answers, all values in between are just estimates. In general, any return value >0.0 means that you should try loading the file, and any value below 1.0 means that loading may fail. If you want a threshold above which you can be reasonably sure that libopenmpt will be able to load the file, use >=0.5. If you see the need for a threshold below which you could reasonably outright reject a file, use <0.25 (Note: Such a threshold for rejecting on the lower end is not recommended, but may be required for better integration into some other framework's probe scoring.). </dd>
<dd>
<a class="el" href="namespaceopenmpt.html#a95fd9b6781cd291b48a1c3e12a3c85e1" title="Roughly scan the input stream to find out whether libopenmpt might be able to open it...">openmpt::could_open_probability()</a> expects the complete file data to be eventually available to it, even if it is asked to just parse the header. Verification will be unreliable (both false positives and false negatives), if you pretend that the file is just some few bytes of initial data threshold in size. In order to really just access the first bytes of a file, check in your std::istream implementation whether data or seeking is requested beyond your initial data threshold, and in that case, return an error. <a class="el" href="namespaceopenmpt.html#a95fd9b6781cd291b48a1c3e12a3c85e1" title="Roughly scan the input stream to find out whether libopenmpt might be able to open it...">openmpt::could_open_probability()</a> will treat this as any other I/O error and return 0.0. You must not expect the correct result in this case. You instead must remember that it asked for more data than you currently want to provide to it and treat this situation as if <a class="el" href="namespaceopenmpt.html#a95fd9b6781cd291b48a1c3e12a3c85e1" title="Roughly scan the input stream to find out whether libopenmpt might be able to open it...">openmpt::could_open_probability()</a> returned 0.5. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="libopenmpt_c_overview.html#libopenmpt_c_fileio">File I/O</a> </dd>
<dd>
<a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
</div>
</div>
<a id="aad5e4ff0e24869d7a9808ac4262283f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad5e4ff0e24869d7a9808ac4262283f2">◆ </a></span>could_open_propability()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBOPENMPT_ATTR_DEPRECATED LIBOPENMPT_CXX_API double openmpt::could_open_propability </td>
<td>(</td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>stream</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>effort</em> = <code>1.0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream & </td>
<td class="paramname"><em>log</em> = <code>std::clog</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Roughly scan the input stream to find out whether libopenmpt might be able to open it. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>Please use <a class="el" href="namespaceopenmpt.html#a95fd9b6781cd291b48a1c3e12a3c85e1" title="Roughly scan the input stream to find out whether libopenmpt might be able to open it...">openmpt::module::could_open_probability()</a>. </dd></dl>
</div>
</div>
<a id="ac37146367d4849a17a297d388cfb4811"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac37146367d4849a17a297d388cfb4811">◆ </a></span>get_core_version()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBOPENMPT_CXX_API std::uint32_t openmpt::get_core_version </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the core version number. </p>
<p>Return the OpenMPT core version number. </p><dl class="section return"><dt>Returns</dt><dd>The value represents (majormajor << 24 + major << 16 + minor << 8 + minorminor). </dd></dl>
</div>
</div>
<a id="aeece2f6ce1045a5f519c93ce19e6eef3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeece2f6ce1045a5f519c93ce19e6eef3">◆ </a></span>get_library_version()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBOPENMPT_CXX_API std::uint32_t openmpt::get_library_version </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the libopenmpt version number. </p>
<p>Returns the libopenmpt version number. </p><dl class="section return"><dt>Returns</dt><dd>The value represents (major << 24 + minor << 16 + patch << 0). </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>libopenmpt < 0.3.0-pre used the following scheme: (major << 24 + minor << 16 + revision). </dd></dl>
</div>
</div>
<a id="aaa2081245974442462d76e8b9bc9380a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa2081245974442462d76e8b9bc9380a">◆ </a></span>get_supported_extensions()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBOPENMPT_CXX_API std::vector<std::string> openmpt::get_supported_extensions </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list of supported file extensions. </p>
<dl class="section return"><dt>Returns</dt><dd>The list of extensions supported by this libopenmpt build. The extensions are returned lower-case without a leading dot. </dd></dl>
</div>
</div>
<a id="aafc5dab5b9c0b8324bbedcc01b59a3c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafc5dab5b9c0b8324bbedcc01b59a3c0">◆ </a></span>is_extension_supported()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBOPENMPT_CXX_API bool openmpt::is_extension_supported </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>extension</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Query whether a file extension is supported. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">extension</td><td>file extension to query without a leading dot. The case is ignored. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the extension is supported by libopenmpt, false otherwise. </dd></dl>
</div>
</div>
<a id="ad77e7cf2361d664fda8ae8461c1dc7a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad77e7cf2361d664fda8ae8461c1dc7a0">◆ </a></span>probe_file_header() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBOPENMPT_CXX_API int openmpt::probe_file_header </td>
<td>(</td>
<td class="paramtype">std::uint64_t </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::uint8_t * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::uint64_t </td>
<td class="paramname"><em>filesize</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Probe the provided bytes from the beginning of a file for supported file format headers to find out whether libopenmpt might be able to open it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>Ored mask of <a class="el" href="namespaceopenmpt.html#a92c11980bfec1deb5f5d4f8fa6e4e998" title="Probe for module formats in openmpt::probe_file_header(). ">openmpt::probe_file_header_flags_modules</a> and <a class="el" href="namespaceopenmpt.html#ad8b455af763397bc1b331ab5a0e47526" title="Probe for module-specific container formats in openmpt::probe_file_header(). ">openmpt::probe_file_header_flags_containers</a>, or <a class="el" href="namespaceopenmpt.html#ae58576f977f7d74f12f37344223a0e78" title="Probe for the default set of formats in openmpt::probe_file_header(). ">openmpt::probe_file_header_flags_default</a>. </td></tr>
<tr><td class="paramname">data</td><td>Beginning of the file data. </td></tr>
<tr><td class="paramname">size</td><td>Size of the beginning of the file data. </td></tr>
<tr><td class="paramname">filesize</td><td>Full size of the file data on disk. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>It is recommended to provide <a class="el" href="namespaceopenmpt.html#af70a8d33fdceca5a821755106e840dcb" title="Get recommended header size for successfull format probing. ">openmpt::probe_file_header_get_recommended_size()</a> bytes of data for data and size. If the file is smaller, only provide the filesize amount and set size and filesize to the file's size. </dd>
<dd>
<a class="el" href="namespaceopenmpt.html#a95fd9b6781cd291b48a1c3e12a3c85e1" title="Roughly scan the input stream to find out whether libopenmpt might be able to open it...">openmpt::could_open_probability()</a> provides a more elaborate interface that might be required for special use cases. It is recommended to use <a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a> though, if possible. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">probe_file_header_result_success</td><td>The file will most likely be supported by libopenmpt. </td></tr>
<tr><td class="paramname">probe_file_header_result_failure</td><td>The file is not supported by libopenmpt. </td></tr>
<tr><td class="paramname">probe_file_header_result_wantmoredata</td><td>An answer could not be determined with the amount of data provided. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceopenmpt.html#af70a8d33fdceca5a821755106e840dcb" title="Get recommended header size for successfull format probing. ">openmpt::probe_file_header_get_recommended_size()</a> </dd>
<dd>
<a class="el" href="namespaceopenmpt.html#a95fd9b6781cd291b48a1c3e12a3c85e1" title="Roughly scan the input stream to find out whether libopenmpt might be able to open it...">openmpt::could_open_probability()</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
</div>
</div>
<a id="a77facf516dd9b626847f91ac26047336"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77facf516dd9b626847f91ac26047336">◆ </a></span>probe_file_header() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBOPENMPT_CXX_API int openmpt::probe_file_header </td>
<td>(</td>
<td class="paramtype">std::uint64_t </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::uint8_t * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Probe the provided bytes from the beginning of a file for supported file format headers to find out whether libopenmpt might be able to open it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>Ored mask of <a class="el" href="namespaceopenmpt.html#a92c11980bfec1deb5f5d4f8fa6e4e998" title="Probe for module formats in openmpt::probe_file_header(). ">openmpt::probe_file_header_flags_modules</a> and <a class="el" href="namespaceopenmpt.html#ad8b455af763397bc1b331ab5a0e47526" title="Probe for module-specific container formats in openmpt::probe_file_header(). ">openmpt::probe_file_header_flags_containers</a>, or <a class="el" href="namespaceopenmpt.html#ae58576f977f7d74f12f37344223a0e78" title="Probe for the default set of formats in openmpt::probe_file_header(). ">openmpt::probe_file_header_flags_default</a>. </td></tr>
<tr><td class="paramname">data</td><td>Beginning of the file data. </td></tr>
<tr><td class="paramname">size</td><td>Size of the beginning of the file data. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>It is recommended to use the overload of this function that also takes the filesize as parameter if at all possile. libopenmpt can provide more accurate answers if the filesize is known. </dd>
<dd>
It is recommended to provide <a class="el" href="namespaceopenmpt.html#af70a8d33fdceca5a821755106e840dcb" title="Get recommended header size for successfull format probing. ">openmpt::probe_file_header_get_recommended_size()</a> bytes of data for data and size. If the file is smaller, only provide the filesize amount and set size to the file's size. </dd>
<dd>
<a class="el" href="namespaceopenmpt.html#a95fd9b6781cd291b48a1c3e12a3c85e1" title="Roughly scan the input stream to find out whether libopenmpt might be able to open it...">openmpt::could_open_probability()</a> provides a more elaborate interface that might be required for special use cases. It is recommended to use <a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a> though, if possible. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">probe_file_header_result_success</td><td>The file will most likely be supported by libopenmpt. </td></tr>
<tr><td class="paramname">probe_file_header_result_failure</td><td>The file is not supported by libopenmpt. </td></tr>
<tr><td class="paramname">probe_file_header_result_wantmoredata</td><td>An answer could not be determined with the amount of data provided. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceopenmpt.html#af70a8d33fdceca5a821755106e840dcb" title="Get recommended header size for successfull format probing. ">openmpt::probe_file_header_get_recommended_size()</a> </dd>
<dd>
<a class="el" href="namespaceopenmpt.html#a95fd9b6781cd291b48a1c3e12a3c85e1" title="Roughly scan the input stream to find out whether libopenmpt might be able to open it...">openmpt::could_open_probability()</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
</div>
</div>
<a id="a6412e44030e40ca67aaa187691ad8e9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6412e44030e40ca67aaa187691ad8e9c">◆ </a></span>probe_file_header() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBOPENMPT_CXX_API int openmpt::probe_file_header </td>
<td>(</td>
<td class="paramtype">std::uint64_t </td>
<td class="paramname"><em>flags</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::istream & </td>
<td class="paramname"><em>stream</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Probe the provided bytes from the beginning of a file for supported file format headers to find out whether libopenmpt might be able to open it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flags</td><td>Ored mask of <a class="el" href="namespaceopenmpt.html#a92c11980bfec1deb5f5d4f8fa6e4e998" title="Probe for module formats in openmpt::probe_file_header(). ">openmpt::probe_file_header_flags_modules</a> and <a class="el" href="namespaceopenmpt.html#ad8b455af763397bc1b331ab5a0e47526" title="Probe for module-specific container formats in openmpt::probe_file_header(). ">openmpt::probe_file_header_flags_containers</a>, or <a class="el" href="namespaceopenmpt.html#ae58576f977f7d74f12f37344223a0e78" title="Probe for the default set of formats in openmpt::probe_file_header(). ">openmpt::probe_file_header_flags_default</a>. </td></tr>
<tr><td class="paramname">stream</td><td>Input stream to scan. </td></tr>
</table>
</dd>
</dl>
<dl class="section remark"><dt>Remarks</dt><dd>stream is left in an unspecified state when this function returns. </dd>
<dd>
<a class="el" href="namespaceopenmpt.html#a95fd9b6781cd291b48a1c3e12a3c85e1" title="Roughly scan the input stream to find out whether libopenmpt might be able to open it...">openmpt::could_open_probability()</a> provides a more elaborate interface that might be required for special use cases. It is recommended to use <a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a> though, if possible. </dd></dl>
<dl class="retval"><dt>Return values</dt><dd>
<table class="retval">
<tr><td class="paramname">probe_file_header_result_success</td><td>The file will most likely be supported by libopenmpt. </td></tr>
<tr><td class="paramname">probe_file_header_result_failure</td><td>The file is not supported by libopenmpt. </td></tr>
<tr><td class="paramname">probe_file_header_result_wantmoredata</td><td>An answer could not be determined with the amount of data provided. </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceopenmpt.html#af70a8d33fdceca5a821755106e840dcb" title="Get recommended header size for successfull format probing. ">openmpt::probe_file_header_get_recommended_size()</a> </dd>
<dd>
<a class="el" href="namespaceopenmpt.html#a95fd9b6781cd291b48a1c3e12a3c85e1" title="Roughly scan the input stream to find out whether libopenmpt might be able to open it...">openmpt::could_open_probability()</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
</div>
</div>
<a id="af70a8d33fdceca5a821755106e840dcb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af70a8d33fdceca5a821755106e840dcb">◆ </a></span>probe_file_header_get_recommended_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LIBOPENMPT_CXX_API std::size_t openmpt::probe_file_header_get_recommended_size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get recommended header size for successfull format probing. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a> </dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="ad8b455af763397bc1b331ab5a0e47526"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8b455af763397bc1b331ab5a0e47526">◆ </a></span>probe_file_header_flags_containers</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::uint64_t openmpt::probe_file_header_flags_containers = 0x2ul</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Probe for module-specific container formats in <a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a>. </p>
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
</div>
</div>
<a id="ae58576f977f7d74f12f37344223a0e78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae58576f977f7d74f12f37344223a0e78">◆ </a></span>probe_file_header_flags_default</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::uint64_t openmpt::probe_file_header_flags_default = <a class="el" href="namespaceopenmpt.html#a92c11980bfec1deb5f5d4f8fa6e4e998">probe_file_header_flags_modules</a> | <a class="el" href="namespaceopenmpt.html#ad8b455af763397bc1b331ab5a0e47526">probe_file_header_flags_containers</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Probe for the default set of formats in <a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a>. </p>
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
</div>
</div>
<a id="a92c11980bfec1deb5f5d4f8fa6e4e998"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92c11980bfec1deb5f5d4f8fa6e4e998">◆ </a></span>probe_file_header_flags_modules</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::uint64_t openmpt::probe_file_header_flags_modules = 0x1ul</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Probe for module formats in <a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a>. </p>
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
</div>
</div>
<a id="a631d4fb8e89a9f5f995827b07812c736"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a631d4fb8e89a9f5f995827b07812c736">◆ </a></span>probe_file_header_flags_none</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const std::uint64_t openmpt::probe_file_header_flags_none = 0x0ul</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Probe for no formats in <a class="el" href="namespaceopenmpt.html#ad77e7cf2361d664fda8ae8461c1dc7a0" title="Probe the provided bytes from the beginning of a file for supported file format headers to find out w...">openmpt::probe_file_header()</a>. </p>
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
</div>
</div>
</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="namespaceopenmpt.html">openmpt</a></li>
<li class="footer">Generated on Sun Feb 4 2018 23:09:22 for libopenmpt by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>
</div>
</body>
</html>
|