/usr/share/gtk-doc/html/libinstpatch/IpatchSF2VoiceCache.html is in libinstpatch-doc 1.0.0-7.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchSF2VoiceCache</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="IpatchRiff.html" title="IpatchRiff">
<link rel="next" href="libinstpatch-IpatchParamProp.html" title="IpatchParamProp">
<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="IpatchRiff.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="libinstpatch-IpatchParamProp.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchSF2VoiceCache.synopsis" class="shortcut">Top</a>
|
<a href="#IpatchSF2VoiceCache.description" class="shortcut">Description</a>
|
<a href="#IpatchSF2VoiceCache.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="IpatchSF2VoiceCache">
<a name="IpatchSF2VoiceCache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchSF2VoiceCache.top_of_page"></a>IpatchSF2VoiceCache</span></h2>
<p>IpatchSF2VoiceCache — SoundFont voice cache object</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchSF2VoiceCache.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchSF2VoiceCache.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2Voice"
>IpatchSF2Voice</a>;
<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2VoiceUpdate"
>IpatchSF2VoiceUpdate</a>;
<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2VoiceSelInfo"
>IpatchSF2VoiceSelInfo</a>;
void (<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2VoiceCacheItemFunc"
>*IpatchSF2VoiceCacheItemFunc</a>) (<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *item);
<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2VoiceCache-struct"
>IpatchSF2VoiceCache</a>;
int (<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2VoiceCacheUpdateHandler"
>*IpatchSF2VoiceCacheUpdateHandler</a>) (<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache,
int *select_values,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *cache_item,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *item,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *pspec,
const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value,
<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2VoiceUpdate"
>IpatchSF2VoiceUpdate</a> *updates,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> max_updates);
enum <a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2VoiceSelType"
>IpatchSF2VoiceSelType</a>;
#define <a
href="../libinstpatch/IpatchSF2VoiceCache.html#IPATCH-SF2-VOICE-CACHE-MAX-SEL-VALUES--CAPS"
>IPATCH_SF2_VOICE_CACHE_MAX_SEL_VALUES</a>
#define <a
href="../libinstpatch/IpatchSF2VoiceCache.html#IPATCH-SF2-VOICE-SEL-WILDCARD--CAPS"
>IPATCH_SF2_VOICE_SEL_WILDCARD</a>
#define <a
href="../libinstpatch/IpatchSF2VoiceCache.html#ipatch-sf2-voice-cache-declare-item"
>ipatch_sf2_voice_cache_declare_item</a> (cache, item)
#define <a
href="../libinstpatch/IpatchSF2VoiceCache.html#IPATCH-SF2-VOICE-CACHE-GET-VOICE--CAPS"
>IPATCH_SF2_VOICE_CACHE_GET_VOICE</a> (cache, index)
<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> * <a
href="../libinstpatch/IpatchSF2VoiceCache.html#ipatch-sf2-voice-cache-new"
>ipatch_sf2_voice_cache_new</a> (<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2VoiceSelInfo"
>IpatchSF2VoiceSelInfo</a> *info,
int sel_count);
void <a
href="../libinstpatch/IpatchSF2VoiceCache.html#ipatch-sf2-voice-cache-set-default-mods"
>ipatch_sf2_voice_cache_set_default_mods</a>
(<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *mods);
<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2Voice"
>IpatchSF2Voice</a> * <a
href="../libinstpatch/IpatchSF2VoiceCache.html#ipatch-sf2-voice-cache-add-voice"
>ipatch_sf2_voice_cache_add_voice</a> (<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache);
void <a
href="../libinstpatch/IpatchSF2VoiceCache.html#ipatch-sf2-voice-cache-set-voice-range"
>ipatch_sf2_voice_cache_set_voice_range</a>
(<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache,
<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2Voice"
>IpatchSF2Voice</a> *voice,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> sel_index,
int low,
int high);
void <a
href="../libinstpatch/IpatchSF2VoiceCache.html#ipatch-sf2-voice-set-sample-data"
>ipatch_sf2_voice_set_sample_data</a> (<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2Voice"
>IpatchSF2Voice</a> *voice,
<a
href="../libinstpatch/IpatchSampleData.html"
>IpatchSampleData</a> *sample_data);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/IpatchSF2VoiceCache.html#ipatch-sf2-voice-cache-sample-data"
>ipatch_sf2_voice_cache_sample_data</a> (<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2Voice"
>IpatchSF2Voice</a> *voice,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err);
void <a
href="../libinstpatch/IpatchSF2VoiceCache.html#ipatch-sf2-voice-copy"
>ipatch_sf2_voice_copy</a> (<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2Voice"
>IpatchSF2Voice</a> *dest,
<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2Voice"
>IpatchSF2Voice</a> *src);
void <a
href="../libinstpatch/IpatchSF2VoiceCache.html#ipatch-sf2-voice-cache-optimize"
>ipatch_sf2_voice_cache_optimize</a> (<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache);
int <a
href="../libinstpatch/IpatchSF2VoiceCache.html#ipatch-sf2-voice-cache-select"
>ipatch_sf2_voice_cache_select</a> (<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache,
int *select_values,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"
>guint16</a> *index_array,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"
>guint16</a> max_indexes);
int <a
href="../libinstpatch/IpatchSF2VoiceCache.html#ipatch-sf2-voice-cache-update"
>ipatch_sf2_voice_cache_update</a> (<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache,
int *select_values,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *cache_item,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *item,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *pspec,
const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value,
<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2VoiceUpdate"
>IpatchSF2VoiceUpdate</a> *updates,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> max_updates);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchSF2VoiceCache.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----IpatchSF2VoiceCache
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchSF2VoiceCache.description"></a><h2>Description</h2>
<p>
This is used for pre-processing instruments into arrays of SoundFont
compatible voices which can then be accessed very quickly without
multi-thread locking or other issues (during synthesis for example).</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchSF2VoiceCache.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchSF2Voice">
<a name="IpatchSF2Voice"></a><h3>IpatchSF2Voice</h3>
<pre class="programlisting">typedef struct {
/* Set by SF2VoiceCache converter via ipatch_sf2_voice_set_sample_data() */
IpatchSampleData *sample_data; /* sample data for voice */
IpatchSampleStore *sample_store; /* Cached store */
guint32 sample_size; /* size of sample in frames */
/* Set by SF2VoiceCache converter */
guint32 loop_start; /* loop start offset (in samples) */
guint32 loop_end; /* loop end offset (in samples, 1st sample after loop) */
guint32 rate; /* sample rate */
guint8 root_note; /* MIDI root note of sample */
gint8 fine_tune; /* fine tune (in cents, -99 - 99) */
guint16 reserved; /* reserved (should be 0) */
IpatchSF2GenArray gen_array; /* generator effect values */
GSList *mod_list; /* modulator list */
/* IpatchSF2VoiceCache user defined */
gpointer user_data; /* Arbitrary data defined by IpatchSF2VoiceCache user */
/* Set internally */
int range_index; /* index in ranges array (int *) to first selection range */
} IpatchSF2Voice;
</pre>
</div>
<hr>
<div class="refsect2" title="IpatchSF2VoiceUpdate">
<a name="IpatchSF2VoiceUpdate"></a><h3>IpatchSF2VoiceUpdate</h3>
<pre class="programlisting">typedef struct {
guint16 voice; /* index of voice with parameter to update */
union /* new value for parameter */
{
gint16 ival;
guint16 uval;
} IpatchSF2VoiceUpdate;
</pre>
</div>
<hr>
<div class="refsect2" title="IpatchSF2VoiceSelInfo">
<a name="IpatchSF2VoiceSelInfo"></a><h3>IpatchSF2VoiceSelInfo</h3>
<pre class="programlisting">typedef struct {
IpatchSF2VoiceSelType type;
int param1;
int param2; /* currently not used */
} IpatchSF2VoiceSelInfo;
</pre>
</div>
<hr>
<div class="refsect2" title="IpatchSF2VoiceCacheItemFunc ()">
<a name="IpatchSF2VoiceCacheItemFunc"></a><h3>IpatchSF2VoiceCacheItemFunc ()</h3>
<pre class="programlisting">void (*IpatchSF2VoiceCacheItemFunc) (<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *item);</pre>
<p>
A callback function type which is called during voice cache population
for each item which the voice cache is dependent on. This can be useful
for determining when a voice cache needs to be updated or for real time
effects.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cache</code></em> :</span></p></td>
<td> Voice cache
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Item which voice cache is dependent on
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IpatchSF2VoiceCache">
<a name="IpatchSF2VoiceCache-struct"></a><h3>IpatchSF2VoiceCache</h3>
<pre class="programlisting">typedef struct _IpatchSF2VoiceCache IpatchSF2VoiceCache;</pre>
</div>
<hr>
<div class="refsect2" title="IpatchSF2VoiceCacheUpdateHandler ()">
<a name="IpatchSF2VoiceCacheUpdateHandler"></a><h3>IpatchSF2VoiceCacheUpdateHandler ()</h3>
<pre class="programlisting">int (*IpatchSF2VoiceCacheUpdateHandler) (<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache,
int *select_values,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *cache_item,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *item,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *pspec,
const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value,
<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2VoiceUpdate"
>IpatchSF2VoiceUpdate</a> *updates,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> max_updates);</pre>
<p>
Function prototype used to re-calculate SoundFont effect generators for a
single object property change. Useful for real time effect changes.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cache</code></em> :</span></p></td>
<td> Voice cache to get updates for
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>select_values</code></em> :</span></p></td>
<td> The voice selection criteria to use, should be the same
number of select values as in <em class="parameter"><code>cache</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cache_item</code></em> :</span></p></td>
<td> Original item <em class="parameter"><code>cache</code></em> was created from
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>item</code></em> :</span></p></td>
<td> Object for which a property changed
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pspec</code></em> :</span></p></td>
<td> Parameter specification of property which changed
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td> The new value of the property
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>updates</code></em> :</span></p></td>
<td> Output array to store updates to
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max_updates</code></em> :</span></p></td>
<td> Size of <em class="parameter"><code>updates</code></em> array (max possible update values).
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Should return number of updates stored to <em class="parameter"><code>updates</code></em> array.
Will be 0 if no updates required.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum IpatchSF2VoiceSelType">
<a name="IpatchSF2VoiceSelType"></a><h3>enum IpatchSF2VoiceSelType</h3>
<pre class="programlisting">typedef enum
{
IPATCH_SF2_VOICE_SEL_NOTE, /* MIDI note range */
IPATCH_SF2_VOICE_SEL_VELOCITY, /* MIDI velocity range */
IPATCH_SF2_VOICE_SEL_AFTER_TOUCH, /* MIDI aftertouch range */
IPATCH_SF2_VOICE_SEL_MIDI_CC /* MIDI custom controller (param1: ctrlnum) */
} IpatchSF2VoiceSelType;
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_VOICE_CACHE_MAX_SEL_VALUES">
<a name="IPATCH-SF2-VOICE-CACHE-MAX-SEL-VALUES--CAPS"></a><h3>IPATCH_SF2_VOICE_CACHE_MAX_SEL_VALUES</h3>
<pre class="programlisting">#define IPATCH_SF2_VOICE_CACHE_MAX_SEL_VALUES 32
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_VOICE_SEL_WILDCARD">
<a name="IPATCH-SF2-VOICE-SEL-WILDCARD--CAPS"></a><h3>IPATCH_SF2_VOICE_SEL_WILDCARD</h3>
<pre class="programlisting">#define IPATCH_SF2_VOICE_SEL_WILDCARD (G_MININT)
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_voice_cache_declare_item()">
<a name="ipatch-sf2-voice-cache-declare-item"></a><h3>ipatch_sf2_voice_cache_declare_item()</h3>
<pre class="programlisting">#define ipatch_sf2_voice_cache_declare_item(cache, item)</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_VOICE_CACHE_GET_VOICE()">
<a name="IPATCH-SF2-VOICE-CACHE-GET-VOICE--CAPS"></a><h3>IPATCH_SF2_VOICE_CACHE_GET_VOICE()</h3>
<pre class="programlisting">#define IPATCH_SF2_VOICE_CACHE_GET_VOICE(cache, index)</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_voice_cache_new ()">
<a name="ipatch-sf2-voice-cache-new"></a><h3>ipatch_sf2_voice_cache_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> * ipatch_sf2_voice_cache_new (<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2VoiceSelInfo"
>IpatchSF2VoiceSelInfo</a> *info,
int sel_count);</pre>
<p>
Create a new SoundFont voice cache object. The <em class="parameter"><code>sel_count</code></em> parameter
defines the number of selection ranges for the cache. Examples of selection
ranges include MIDI note and velocity ranges for a voice. The <em class="parameter"><code>info</code></em>
parameter should be a pointer to an array of selection info structures
which describes each selection type.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td> Array of selection info structures (length should be <em class="parameter"><code>sel_count</code></em>), use
<code class="literal">NULL</code> for default selection info (MIDI note and velocity)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sel_count</code></em> :</span></p></td>
<td> Count of selection ranges for this cache (ignored if <em class="parameter"><code>info</code></em> is
<code class="literal">NULL</code>)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New SoundFont voice cache with a reference count of 1 which the
caller owns.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_voice_cache_set_default_mods ()">
<a name="ipatch-sf2-voice-cache-set-default-mods"></a><h3>ipatch_sf2_voice_cache_set_default_mods ()</h3>
<pre class="programlisting">void ipatch_sf2_voice_cache_set_default_mods
(<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *mods);</pre>
<p>
Set the default modulator list for the voice cache. Modulator list is used
directly and the allocation of the list is taken over by the voice cache.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cache</code></em> :</span></p></td>
<td> Voice cache
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mods</code></em> :</span></p></td>
<td> SoundFont modulator list to use as default (used directly)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_voice_cache_add_voice ()">
<a name="ipatch-sf2-voice-cache-add-voice"></a><h3>ipatch_sf2_voice_cache_add_voice ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2Voice"
>IpatchSF2Voice</a> * ipatch_sf2_voice_cache_add_voice (<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache);</pre>
<p>
Adds a new initialized voice to a SoundFont voice cache.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cache</code></em> :</span></p></td>
<td> Voice cache to create voice for
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Newly allocated and initialized SoundFont voice structure.
The sample pointer is set to NULL, generator array is initialized to default
absolute unset values, selection ranges are set to G_MININT-G_MAXINT and
all other fields are initialized to defaults.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_voice_cache_set_voice_range ()">
<a name="ipatch-sf2-voice-cache-set-voice-range"></a><h3>ipatch_sf2_voice_cache_set_voice_range ()</h3>
<pre class="programlisting">void ipatch_sf2_voice_cache_set_voice_range
(<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache,
<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2Voice"
>IpatchSF2Voice</a> *voice,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> sel_index,
int low,
int high);</pre>
<p>
Set a voice selection range. Selection ranges are used for selection criteria
such as MIDI velocity and note ranges.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cache</code></em> :</span></p></td>
<td> Voice cache object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>voice</code></em> :</span></p></td>
<td> Voice pointer in cache
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sel_index</code></em> :</span></p></td>
<td> Selection index
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>low</code></em> :</span></p></td>
<td> Range low value
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>high</code></em> :</span></p></td>
<td> Range high value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_voice_set_sample_data ()">
<a name="ipatch-sf2-voice-set-sample-data"></a><h3>ipatch_sf2_voice_set_sample_data ()</h3>
<pre class="programlisting">void ipatch_sf2_voice_set_sample_data (<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2Voice"
>IpatchSF2Voice</a> *voice,
<a
href="../libinstpatch/IpatchSampleData.html"
>IpatchSampleData</a> *sample_data);</pre>
<p>
Assign sample data to a SoundFont voice.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>voice</code></em> :</span></p></td>
<td> SoundFont voice structure
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sample_data</code></em> :</span></p></td>
<td> Sample data to assign to voice
</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> to ignore
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_voice_cache_sample_data ()">
<a name="ipatch-sf2-voice-cache-sample-data"></a><h3>ipatch_sf2_voice_cache_sample_data ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_sf2_voice_cache_sample_data (<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2Voice"
>IpatchSF2Voice</a> *voice,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
Cache an already assigned sample data object of a voice. The sample data is
cached as 16 bit mono native endian format, if not already cached, and the
new cached sample is assigned to the sample_store field.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>voice</code></em> :</span></p></td>
<td> SoundFont voice structure
</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> to ignore
</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 (in which case <em class="parameter"><code>err</code></em> may be set)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_voice_copy ()">
<a name="ipatch-sf2-voice-copy"></a><h3>ipatch_sf2_voice_copy ()</h3>
<pre class="programlisting">void ipatch_sf2_voice_copy (<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2Voice"
>IpatchSF2Voice</a> *dest,
<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2Voice"
>IpatchSF2Voice</a> *src);</pre>
<p>
Copy a source (<em class="parameter"><code>src</code></em>) voice's information to a destination voice (<em class="parameter"><code>dest</code></em>).
Does not copy selection criteria integers in parent <a
href="../libinstpatch/IpatchSF2VoiceCache.html"
><span class="type">IpatchSF2VoiceCache</span></a>
objects.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
<td> Destination voice to copy to (initialized to 0s or already valid)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
<td> Source voice to copy from
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_voice_cache_optimize ()">
<a name="ipatch-sf2-voice-cache-optimize"></a><h3>ipatch_sf2_voice_cache_optimize ()</h3>
<pre class="programlisting">void ipatch_sf2_voice_cache_optimize (<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache);</pre>
<p>
Can be called after all voices have been added to a voice cache.
Will optimize voice cache for use with <a
href="../libinstpatch/IpatchSF2VoiceCache.html#ipatch-sf2-voice-cache-select"
><code class="function">ipatch_sf2_voice_cache_select()</code></a>.
NOTE: Currently does nothing, but will in the future..</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>cache</code></em> :</span></p></td>
<td> SoundFont voice cache
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_voice_cache_select ()">
<a name="ipatch-sf2-voice-cache-select"></a><h3>ipatch_sf2_voice_cache_select ()</h3>
<pre class="programlisting">int ipatch_sf2_voice_cache_select (<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache,
int *select_values,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"
>guint16</a> *index_array,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"
>guint16</a> max_indexes);</pre>
<p>
Stores pointers to voices matching <em class="parameter"><code>select_values</code></em> criteria.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cache</code></em> :</span></p></td>
<td> SoundFont voice cache
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>select_values</code></em> :</span></p></td>
<td> Array of select values which must be the same length as
the voice cache was initialized with. Each selection value is tested
against each voice's selection ranges (use <a
href="../libinstpatch/IpatchSF2VoiceCache.html#IPATCH-SF2-VOICE-SEL-WILDCARD--CAPS"
><span class="type">IPATCH_SF2_VOICE_SEL_WILDCARD</span></a>
as a wildcard selection value).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>index_array</code></em> :</span></p></td>
<td> Voice indexes are stored in this array.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max_indexes</code></em> :</span></p></td>
<td> Maximum number of voices to match. <em class="parameter"><code>index_array</code></em> should be
at least this value in size.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Number of indexes stored to <em class="parameter"><code>index_array</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_voice_cache_update ()">
<a name="ipatch-sf2-voice-cache-update"></a><h3>ipatch_sf2_voice_cache_update ()</h3>
<pre class="programlisting">int ipatch_sf2_voice_cache_update (<a
href="../libinstpatch/IpatchSF2VoiceCache.html"
>IpatchSF2VoiceCache</a> *cache,
int *select_values,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *cache_item,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *item,
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-GParamSpec.html#GParamSpec"
>GParamSpec</a> *pspec,
const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value,
<a
href="../libinstpatch/IpatchSF2VoiceCache.html#IpatchSF2VoiceUpdate"
>IpatchSF2VoiceUpdate</a> *updates,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> max_updates);</pre>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|