/usr/share/gtk-doc/html/libinstpatch/IpatchRiff.html is in libinstpatch-doc 1.0.0-3.
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 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchRiff</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="libinstpatch Reference Manual">
<link rel="up" href="ch02.html" title="Utility objects and functions">
<link rel="prev" href="IpatchConverterSF2VoiceCache.html" title="IpatchConverterSF2VoiceCache">
<link rel="next" href="IpatchSF2VoiceCache.html" title="IpatchSF2VoiceCache">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Base objects and functions">
<link rel="chapter" href="ch02.html" title="Utility objects and functions">
<link rel="chapter" href="ch03.html" title="Sample data objects and functions">
<link rel="chapter" href="ch04.html" title="DLS patches">
<link rel="chapter" href="ch05.html" title="SoundFont patches">
<link rel="chapter" href="ch06.html" title="GigaSampler patches">
<link rel="chapter" href="ch07.html" title="Virtual banks">
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
<link rel="index" href="api-index-full.html" title="API Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="IpatchConverterSF2VoiceCache.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinstpatch Reference Manual</th>
<td><a accesskey="n" href="IpatchSF2VoiceCache.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchRiff.synopsis" class="shortcut">Top</a>
|
<a href="#IpatchRiff.description" class="shortcut">Description</a>
|
<a href="#IpatchRiff.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="IpatchRiff">
<a name="IpatchRiff"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchRiff.top_of_page"></a>IpatchRiff</span></h2>
<p>IpatchRiff — RIFF file parser/composer object</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchRiff.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchRiff.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunk"
>IpatchRiffChunk</a>;
enum <a
href="../libinstpatch/IpatchRiff.html#IpatchRiffStatus"
>IpatchRiffStatus</a>;
enum <a
href="../libinstpatch/IpatchRiff.html#IpatchRiffMode"
>IpatchRiffMode</a>;
<a
href="../libinstpatch/IpatchRiff.html#IpatchRiff-struct"
>IpatchRiff</a>;
#define <a
href="../libinstpatch/IpatchRiff.html#IPATCH-RIFF-NEED-SWAP--CAPS"
>IPATCH_RIFF_NEED_SWAP</a> (riff)
#define <a
href="../libinstpatch/IpatchRiff.html#IPATCH-RIFF-BIG-ENDIAN--CAPS"
>IPATCH_RIFF_BIG_ENDIAN</a> (riff)
enum <a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunkType"
>IpatchRiffChunkType</a>;
#define <a
href="../libinstpatch/IpatchRiff.html#IPATCH-RIFF-ERROR--CAPS"
>IPATCH_RIFF_ERROR</a>
enum <a
href="../libinstpatch/IpatchRiff.html#IpatchRiffError"
>IpatchRiffError</a>;
#define <a
href="../libinstpatch/IpatchRiff.html#IPATCH-FOURCC--CAPS"
>IPATCH_FOURCC</a> (c1, c2, c3, c4)
#define <a
href="../libinstpatch/IpatchRiff.html#IPATCH-FOURCC-RIFF--CAPS"
>IPATCH_FOURCC_RIFF</a>
#define <a
href="../libinstpatch/IpatchRiff.html#IPATCH-FOURCC-RIFX--CAPS"
>IPATCH_FOURCC_RIFX</a>
#define <a
href="../libinstpatch/IpatchRiff.html#IPATCH-FOURCC-LIST--CAPS"
>IPATCH_FOURCC_LIST</a>
#define <a
href="../libinstpatch/IpatchRiff.html#IPATCH-RIFF-HEADER-SIZE--CAPS"
>IPATCH_RIFF_HEADER_SIZE</a>
#define <a
href="../libinstpatch/IpatchRiff.html#IPATCH-RIFF-FOURCC-SIZE--CAPS"
>IPATCH_RIFF_FOURCC_SIZE</a>
#define <a
href="../libinstpatch/IpatchRiff.html#IPATCH-RIFF-LIST-HEADER-SIZE--CAPS"
>IPATCH_RIFF_LIST_HEADER_SIZE</a>
#define <a
href="../libinstpatch/IpatchRiff.html#IPATCH-RIFF-WAVE-FMT-PCM--CAPS"
>IPATCH_RIFF_WAVE_FMT_PCM</a>
#define <a
href="../libinstpatch/IpatchRiff.html#IPATCH-RIFF-WAVE-FMT-FLOAT--CAPS"
>IPATCH_RIFF_WAVE_FMT_FLOAT</a>
<a
href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"
>GQuark</a> <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-error-quark"
>ipatch_riff_error_quark</a> (void);
<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> * <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-new"
>ipatch_riff_new</a> (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle);
void <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-set-file-handle"
>ipatch_riff_set_file_handle</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle);
<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> * <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-get-file-handle"
>ipatch_riff_get_file_handle</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff);
int <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-get-chunk-level"
>ipatch_riff_get_chunk_level</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff);
<a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunk"
>IpatchRiffChunk</a> * <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-get-chunk-array"
>ipatch_riff_get_chunk_array</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
int *count);
<a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunk"
>IpatchRiffChunk</a> * <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-get-chunk"
>ipatch_riff_get_chunk</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
int level);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
>guint32</a> <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-get-total-size"
>ipatch_riff_get_total_size</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
>guint32</a> <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-get-position"
>ipatch_riff_get_position</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff);
void <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-push-state"
>ipatch_riff_push_state</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-pop-state"
>ipatch_riff_pop_state</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);
<a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunk"
>IpatchRiffChunk</a> * <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-start-read"
>ipatch_riff_start_read</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);
<a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunk"
>IpatchRiffChunk</a> * <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-start-read-chunk"
>ipatch_riff_start_read_chunk</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);
<a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunk"
>IpatchRiffChunk</a> * <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-read-chunk-verify"
>ipatch_riff_read_chunk_verify</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunkType"
>IpatchRiffChunkType</a> type,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
>guint32</a> id,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);
<a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunk"
>IpatchRiffChunk</a> * <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-read-chunk"
>ipatch_riff_read_chunk</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);
#define <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-write-list-chunk"
>ipatch_riff_write_list_chunk</a> (parser, id, err)
#define <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-write-sub-chunk"
>ipatch_riff_write_sub_chunk</a> (parser, id, err)
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-write-chunk"
>ipatch_riff_write_chunk</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunkType"
>IpatchRiffChunkType</a> type,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
>guint32</a> id,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);
#define <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-end-chunk"
>ipatch_riff_end_chunk</a> (parser, err)
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-close-chunk"
>ipatch_riff_close_chunk</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
int level,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);
#define <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-skip-chunk"
>ipatch_riff_skip_chunk</a> (parser, err)
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-skip-chunks"
>ipatch_riff_skip_chunks</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a> count,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-get-error"
>ipatch_riff_get_error</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);
char * <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-message-detail"
>ipatch_riff_message_detail</a> (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
int level,
const char *format,
...);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchRiff.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----IpatchRiff
+----<a
href="../libinstpatch/IpatchDLSReader.html"
>IpatchDLSReader</a>
+----<a
href="../libinstpatch/IpatchDLSWriter.html"
>IpatchDLSWriter</a>
+----<a
href="../libinstpatch/IpatchSF2Reader.html"
>IpatchSF2Reader</a>
+----<a
href="../libinstpatch/IpatchSF2Writer.html"
>IpatchSF2Writer</a>
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchRiff.description"></a><h2>Description</h2>
<p>
A RIFF file parser/composer. Used for DLS, SoundFont and GigaSampler files.</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchRiff.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchRiffChunk">
<a name="IpatchRiffChunk"></a><h3>IpatchRiffChunk</h3>
<pre class="programlisting">typedef struct {
IpatchRiffChunkType type; /* type of chunk */
guint32 id; /* chunk ID in integer format for easy comparison */
char idstr[4]; /* four character chunk ID string */
gint32 position; /* current position in chunk (read or write mode) */
guint32 size; /* size of chunk (read mode only) */
guint32 filepos; /* Position in file object of chunk data */
} IpatchRiffChunk;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchRiffStatus">
<a name="IpatchRiffStatus"></a><h3>enum IpatchRiffStatus</h3>
<pre class="programlisting">typedef enum
{
IPATCH_RIFF_STATUS_FAIL = 0, /* error occured */
IPATCH_RIFF_STATUS_BEGIN, /* parsing has not yet began */
IPATCH_RIFF_STATUS_FINISHED, /* no more parsing to be done */
IPATCH_RIFF_STATUS_NORMAL, /* normal status */
IPATCH_RIFF_STATUS_CHUNK_END /* end of a chunk */
} IpatchRiffStatus;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchRiffMode">
<a name="IpatchRiffMode"></a><h3>enum IpatchRiffMode</h3>
<pre class="programlisting">typedef enum
{
IPATCH_RIFF_READ,
IPATCH_RIFF_WRITE
} IpatchRiffMode;
</pre>
</div>
<hr>
<div class="refsect2" title="IpatchRiff">
<a name="IpatchRiff-struct"></a><h3>IpatchRiff</h3>
<pre class="programlisting">typedef struct _IpatchRiff IpatchRiff;</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_RIFF_NEED_SWAP()">
<a name="IPATCH-RIFF-NEED-SWAP--CAPS"></a><h3>IPATCH_RIFF_NEED_SWAP()</h3>
<pre class="programlisting">#define IPATCH_RIFF_NEED_SWAP(riff) IPATCH_FILE_NEED_SWAP (riff->handle->file)
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_RIFF_BIG_ENDIAN()">
<a name="IPATCH-RIFF-BIG-ENDIAN--CAPS"></a><h3>IPATCH_RIFF_BIG_ENDIAN()</h3>
<pre class="programlisting">#define IPATCH_RIFF_BIG_ENDIAN(riff) IPATCH_FILE_BIG_ENDIAN (riff->handle->file)
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchRiffChunkType">
<a name="IpatchRiffChunkType"></a><h3>enum IpatchRiffChunkType</h3>
<pre class="programlisting">typedef enum
{
IPATCH_RIFF_CHUNK_RIFF, /* toplevel "RIFF" (or "RIFX") list chunk */
IPATCH_RIFF_CHUNK_LIST, /* a "LIST" chunk */
IPATCH_RIFF_CHUNK_SUB /* a sub chunk */
} IpatchRiffChunkType;
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_RIFF_ERROR">
<a name="IPATCH-RIFF-ERROR--CAPS"></a><h3>IPATCH_RIFF_ERROR</h3>
<pre class="programlisting">#define IPATCH_RIFF_ERROR ipatch_riff_error_quark()
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchRiffError">
<a name="IpatchRiffError"></a><h3>enum IpatchRiffError</h3>
<pre class="programlisting">typedef enum
{
IPATCH_RIFF_ERROR_NOT_RIFF, /* not a RIFF file */
IPATCH_RIFF_ERROR_UNEXPECTED_ID, /* unexpected chunk ID */
IPATCH_RIFF_ERROR_UNEXPECTED_CHUNK_END, /* unexpected LIST chunk end */
IPATCH_RIFF_ERROR_INVALID_ID, /* invalid chunk FOURCC ID */
IPATCH_RIFF_ERROR_ODD_SIZE, /* chunk size is ODD */
IPATCH_RIFF_ERROR_SIZE_EXCEEDED, /* chunk size exceeded */
/* convenience errors - not used by the riff object itself */
IPATCH_RIFF_ERROR_SIZE_MISMATCH, /* chunk size mismatch */
IPATCH_RIFF_ERROR_INVALID_DATA /* generic invalid data error */
} IpatchRiffError;
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_FOURCC()">
<a name="IPATCH-FOURCC--CAPS"></a><h3>IPATCH_FOURCC()</h3>
<pre class="programlisting">#define IPATCH_FOURCC(c1, c2, c3, c4)</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_FOURCC_RIFF">
<a name="IPATCH-FOURCC-RIFF--CAPS"></a><h3>IPATCH_FOURCC_RIFF</h3>
<pre class="programlisting">#define IPATCH_FOURCC_RIFF IPATCH_FOURCC ('R','I','F','F')
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_FOURCC_RIFX">
<a name="IPATCH-FOURCC-RIFX--CAPS"></a><h3>IPATCH_FOURCC_RIFX</h3>
<pre class="programlisting">#define IPATCH_FOURCC_RIFX IPATCH_FOURCC ('R','I','F','X') /* big endian */
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_FOURCC_LIST">
<a name="IPATCH-FOURCC-LIST--CAPS"></a><h3>IPATCH_FOURCC_LIST</h3>
<pre class="programlisting">#define IPATCH_FOURCC_LIST IPATCH_FOURCC ('L','I','S','T')
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_RIFF_HEADER_SIZE">
<a name="IPATCH-RIFF-HEADER-SIZE--CAPS"></a><h3>IPATCH_RIFF_HEADER_SIZE</h3>
<pre class="programlisting">#define IPATCH_RIFF_HEADER_SIZE 8 /* size of RIFF chunk headers (ID + size) */
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_RIFF_FOURCC_SIZE">
<a name="IPATCH-RIFF-FOURCC-SIZE--CAPS"></a><h3>IPATCH_RIFF_FOURCC_SIZE</h3>
<pre class="programlisting">#define IPATCH_RIFF_FOURCC_SIZE 4 /* RIFF FOURCC ID size */
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_RIFF_LIST_HEADER_SIZE">
<a name="IPATCH-RIFF-LIST-HEADER-SIZE--CAPS"></a><h3>IPATCH_RIFF_LIST_HEADER_SIZE</h3>
<pre class="programlisting">#define IPATCH_RIFF_LIST_HEADER_SIZE</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_RIFF_WAVE_FMT_PCM">
<a name="IPATCH-RIFF-WAVE-FMT-PCM--CAPS"></a><h3>IPATCH_RIFF_WAVE_FMT_PCM</h3>
<pre class="programlisting">#define IPATCH_RIFF_WAVE_FMT_PCM 0x1
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_RIFF_WAVE_FMT_FLOAT">
<a name="IPATCH-RIFF-WAVE-FMT-FLOAT--CAPS"></a><h3>IPATCH_RIFF_WAVE_FMT_FLOAT</h3>
<pre class="programlisting">#define IPATCH_RIFF_WAVE_FMT_FLOAT 0x3
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_error_quark ()">
<a name="ipatch-riff-error-quark"></a><h3>ipatch_riff_error_quark ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"
>GQuark</a> ipatch_riff_error_quark (void);</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_new ()">
<a name="ipatch-riff-new"></a><h3>ipatch_riff_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> * ipatch_riff_new (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle);</pre>
<p>
Create a new RIFF file riff/composer object</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td> File object handle to parse or <code class="literal">NULL</code> to set later, the handle will be
taken over by the riff object and closed when finalized.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The RIFF object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_set_file_handle ()">
<a name="ipatch-riff-set-file-handle"></a><h3>ipatch_riff_set_file_handle ()</h3>
<pre class="programlisting">void ipatch_riff_set_file_handle (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle);</pre>
<p>
Set the file object handle of a RIFF object. The handle is taken over
by the riff object and will be closed when finalized.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td> File object handle to assign
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_get_file_handle ()">
<a name="ipatch-riff-get-file-handle"></a><h3>ipatch_riff_get_file_handle ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> * ipatch_riff_get_file_handle (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff);</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_get_chunk_level ()">
<a name="ipatch-riff-get-chunk-level"></a><h3>ipatch_riff_get_chunk_level ()</h3>
<pre class="programlisting">int ipatch_riff_get_chunk_level (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff);</pre>
<p>
Gets the current chunk level count (number of embedded chunks) currently
being processed in a RIFF file.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Chunk level count (0 = no open chunks)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_get_chunk_array ()">
<a name="ipatch-riff-get-chunk-array"></a><h3>ipatch_riff_get_chunk_array ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunk"
>IpatchRiffChunk</a> * ipatch_riff_get_chunk_array (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
int *count);</pre>
<p>
Gets the array of open chunk info structures.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
<td> Location to store the number of elements in the returned array
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Array of <a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunk"
><span class="type">IpatchRiffChunk</span></a> structures or <code class="literal">NULL</code> if no chunks
being processed (processing hasn't started). The returned array is
internal and should not be modified or freed. Also note that the
array is valid only while the chunk state is unchanged (riff object or file
operations). The number of elements in the array is stored in <em class="parameter"><code>count</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_get_chunk ()">
<a name="ipatch-riff-get-chunk"></a><h3>ipatch_riff_get_chunk ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunk"
>IpatchRiffChunk</a> * ipatch_riff_get_chunk (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
int level);</pre>
<p>
Get the chunk at the specified <em class="parameter"><code>level</code></em> from a RIFF <em class="parameter"><code>riff</code></em> chunk state
array.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
<td> Level of chunk to get (-1 for current chunk)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Pointer to the chunk or <code class="literal">NULL</code> if invalid level. The returned
chunk is internal and should not be modified or freed. Also note that the
chunk is valid only while the chunk state is unchanged (riff object or file
operations).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_get_total_size ()">
<a name="ipatch-riff-get-total-size"></a><h3>ipatch_riff_get_total_size ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
>guint32</a> ipatch_riff_get_total_size (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff);</pre>
<p>
Get total size of toplevel chunk. This is a convenience function
that just adds the size of the toplevel chunk and its header, the
actual file object size is not checked.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Size of toplevel chunk + header size, in bytes. Actual file size
is not checked.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_get_position ()">
<a name="ipatch-riff-get-position"></a><h3>ipatch_riff_get_position ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
>guint32</a> ipatch_riff_get_position (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff);</pre>
<p>
Get current position in the toplevel RIFF chunk (including header,
i.e., the file position).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The current offset, in bytes, into the toplevel RIFF chunk
(including header).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_push_state ()">
<a name="ipatch-riff-push-state"></a><h3>ipatch_riff_push_state ()</h3>
<pre class="programlisting">void ipatch_riff_push_state (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff);</pre>
<p>
Pushes the current file position and chunk state onto the state stack.
This state can be later restored to return to the same position in a RIFF
file.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_pop_state ()">
<a name="ipatch-riff-pop-state"></a><h3>ipatch_riff_pop_state ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_riff_pop_state (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
Pops the most recent state pushed onto the state stack. This causes the
position in the RIFF file stored by the state to be restored.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise which is fatal
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_start_read ()">
<a name="ipatch-riff-start-read"></a><h3>ipatch_riff_start_read ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunk"
>IpatchRiffChunk</a> * ipatch_riff_start_read (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
Start parsing the <em class="parameter"><code>riff</code></em> file object as if it were at the
beginning of a RIFF file. Clears any current chunk state,
loads a chunk and ensures that it has the "RIFF" or "RIFX" ID. If this call
is sucessful there will be one chunk on the chunk stack with the
secondary ID of the RIFF chunk. If it is desirable to process a
chunk that is not the beginning of a RIFF file,
<a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-start-read-chunk"
><code class="function">ipatch_riff_start_read_chunk()</code></a> can be used. This function will also
automatically enable byte order swapping if needed.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Pointer to the opened RIFF chunk or <code class="literal">NULL</code> on error. The returned
chunk is internal and should not be modified or freed. Also note that the
chunk is valid only while the chunk state is unchanged (riff object or file
operations).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_start_read_chunk ()">
<a name="ipatch-riff-start-read-chunk"></a><h3>ipatch_riff_start_read_chunk ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunk"
>IpatchRiffChunk</a> * ipatch_riff_start_read_chunk (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
Start parsing the <em class="parameter"><code>riff</code></em> file object at an arbitrary chunk.
Clears any current chunk state and loads a chunk. If this
call is sucessful there will be one chunk on the chunk stack. If it
is desirable to start processing from the beginning of a RIFF file
<a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-start-read"
><code class="function">ipatch_riff_start_read()</code></a> should be used instead. An end of file
condition is considered an error. Note that it is up to the caller to
ensure byte order swapping is enabled, if needed.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Pointer to the opened RIFF chunk or <code class="literal">NULL</code> on error. The returned
chunk is internal and should not be modified or freed. Also note that the
chunk is valid only while the chunk state is unchanged (riff object or file
operations).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_read_chunk_verify ()">
<a name="ipatch-riff-read-chunk-verify"></a><h3>ipatch_riff_read_chunk_verify ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunk"
>IpatchRiffChunk</a> * ipatch_riff_read_chunk_verify (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunkType"
>IpatchRiffChunkType</a> type,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
>guint32</a> id,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
Like <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-read-chunk"
><code class="function">ipatch_riff_read_chunk()</code></a> but ensures that the new chunk matches a
specific type and ID. If the chunk is not the expected chunk or no more
chunks in current list chunk, it is considered an error.
<a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-close-chunk"
><code class="function">ipatch_riff_close_chunk()</code></a> should be called when finished parsing the
opened chunk.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> Expected chunk type
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td> Expected chunk ID
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Pointer to new opened chunk or <code class="literal">NULL</code> if current chunk has ended
or on error. Returned chunk pointer is internal and should not be modified
or freed. Also note that the chunk is valid only while the chunk state is
unchanged (riff object or file operations).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_read_chunk ()">
<a name="ipatch-riff-read-chunk"></a><h3>ipatch_riff_read_chunk ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunk"
>IpatchRiffChunk</a> * ipatch_riff_read_chunk (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
Parse next RIFF chunk header. The <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-close-chunk"
><code class="function">ipatch_riff_close_chunk()</code></a>
function should be called at the end of parsing a chunk, otherwise this
function will return NULL if the current chunk has ended. When
the first RIFF chunk is read the IPATCH_RIFF_FLAG_BIG_ENDIAN flag
is cleared or set depending on if its RIFF or RIFX respectively,
endian swapping is also enabled if the file uses non-native endian
format to the host.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Pointer to new opened chunk or <code class="literal">NULL</code> if current chunk has ended
or on error. Returned chunk pointer is internal and should not be modified
or freed. Also note that the chunk is valid only while the chunk state is
unchanged (riff object or file operations).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_write_list_chunk()">
<a name="ipatch-riff-write-list-chunk"></a><h3>ipatch_riff_write_list_chunk()</h3>
<pre class="programlisting">#define ipatch_riff_write_list_chunk(parser, id, err)</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_write_sub_chunk()">
<a name="ipatch-riff-write-sub-chunk"></a><h3>ipatch_riff_write_sub_chunk()</h3>
<pre class="programlisting">#define ipatch_riff_write_sub_chunk(parser, id, err)</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_write_chunk ()">
<a name="ipatch-riff-write-chunk"></a><h3>ipatch_riff_write_chunk ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_riff_write_chunk (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="../libinstpatch/IpatchRiff.html#IpatchRiffChunkType"
>IpatchRiffChunkType</a> type,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"
>guint32</a> id,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
Opens a new chunk and writes a chunk header to the file object in <em class="parameter"><code>riff</code></em>.
The size field of the chunk is set to 0 and will be filled in when the
chunk is closed (see <a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-close-chunk"
><code class="function">ipatch_riff_close_chunk()</code></a>).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td> Chunk type (RIFF, LIST, or SUB)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td> Chunk ID (secondary ID for RIFF and LIST chunks)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_end_chunk()">
<a name="ipatch-riff-end-chunk"></a><h3>ipatch_riff_end_chunk()</h3>
<pre class="programlisting">#define ipatch_riff_end_chunk(parser, err)</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_close_chunk ()">
<a name="ipatch-riff-close-chunk"></a><h3>ipatch_riff_close_chunk ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_riff_close_chunk (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
int level,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
Closes the chunk specified by <em class="parameter"><code>level</code></em> and all its children (if any).
</p>
<p>
In write mode the chunk size is filled in for chunks that get closed and
therefore the file object of <em class="parameter"><code>riff</code></em> must be seekable (anyone need
non-seekable RIFF writing?). The chunk size is padded to an even
number if necessary (by writing a NULL byte).
</p>
<p>
Upon successful completion the file position will be where it was prior to
the call (write mode) or at the beginning of the next chunk (read mode).
There will be <em class="parameter"><code>level</code></em> open chunks (or previous chunk count - 1 if
<em class="parameter"><code>level</code></em> == -1). In read mode the status will be
<span class="type">IPATCH_RIFF_STATUS_NORMAL</span> if open chunks remain or
<span class="type">IPATCH_RIFF_STATUS_FINISHED</span> if toplevel chunk was closed. The status is
not modified in write mode.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
<td> Level of chunk to close (-1 for current chunk)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_skip_chunk()">
<a name="ipatch-riff-skip-chunk"></a><h3>ipatch_riff_skip_chunk()</h3>
<pre class="programlisting">#define ipatch_riff_skip_chunk(parser, err)</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_skip_chunks ()">
<a name="ipatch-riff-skip-chunks"></a><h3>ipatch_riff_skip_chunks ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_riff_skip_chunks (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
>guint</a> count,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
Skips RIFF chunks at the current chunk level (children of the current
chunk).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>count</code></em> :</span></p></td>
<td> Number of chunks to skip
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_get_error ()">
<a name="ipatch-riff-get-error"></a><h3>ipatch_riff_get_error ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_riff_get_error (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
<a
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
Gets error information from a RIFF object.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">FALSE</code> if status is a <span class="type">IPATCH_RIFF_STATUS_FAIL</span> condition and info
can be found in <em class="parameter"><code>err</code></em>, <code class="literal">TRUE</code> if no error has occured.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_riff_message_detail ()">
<a name="ipatch-riff-message-detail"></a><h3>ipatch_riff_message_detail ()</h3>
<pre class="programlisting">char * ipatch_riff_message_detail (<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a> *riff,
int level,
const char *format,
...);</pre>
<p>
Generates a detailed message, including current position in RIFF file
and a chunk trace back. Useful for debugging purposes.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>riff</code></em> :</span></p></td>
<td> RIFF object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>level</code></em> :</span></p></td>
<td> Chunk level to generate detail for (-1 for current chunk)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> Printf style format string of message to display at beginning
of riff detail
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td> Arguments for <em class="parameter"><code>msg</code></em> string
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Detailed message string which is internal to <em class="parameter"><code>riff</code></em> and should
not be modified or freed. Also note that this string is only valid until
the next call to this function.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|