/usr/share/gtk-doc/html/libinstpatch/libinstpatch-IpatchSF2Mod.html is in libinstpatch-doc 1.0.0-4.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchSF2Mod</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="ch05.html" title="SoundFont patches">
<link rel="prev" href="libinstpatch-IpatchSF2GenItem.html" title="IpatchSF2GenItem">
<link rel="next" href="libinstpatch-IpatchSF2ModItem.html" title="IpatchSF2ModItem">
<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="libinstpatch-IpatchSF2GenItem.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.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-IpatchSF2ModItem.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libinstpatch-IpatchSF2Mod.synopsis" class="shortcut">Top</a>
|
<a href="#libinstpatch-IpatchSF2Mod.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="IpatchSF2Mod">
<a name="libinstpatch-IpatchSF2Mod"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinstpatch-IpatchSF2Mod.top_of_page"></a>IpatchSF2Mod</span></h2>
<p>IpatchSF2Mod — SoundFont modulators</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="libinstpatch-IpatchSF2Mod.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libinstpatch-IpatchSF2Mod.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a>;
typedef <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2ModList"
>IpatchSF2ModList</a>;
#define <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IPATCH-TYPE-SF2-MOD--CAPS"
>IPATCH_TYPE_SF2_MOD</a>
#define <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IPATCH-TYPE-SF2-MOD-LIST--CAPS"
>IPATCH_TYPE_SF2_MOD_LIST</a>
#define <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IPATCH-SF2-MOD-ARE-IDENTICAL--CAPS"
>IPATCH_SF2_MOD_ARE_IDENTICAL</a> (a, b)
#define <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IPATCH-SF2-MOD-ARE-IDENTICAL-AMOUNT--CAPS"
>IPATCH_SF2_MOD_ARE_IDENTICAL_AMOUNT</a> (a, b)
enum <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2ModFieldMasks"
>IpatchSF2ModFieldMasks</a>;
enum <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2ModFieldShifts"
>IpatchSF2ModFieldShifts</a>;
enum <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2ModControl"
>IpatchSF2ModControl</a>;
enum <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2ModControlPalette"
>IpatchSF2ModControlPalette</a>;
enum <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2ModDirection"
>IpatchSF2ModDirection</a>;
enum <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2ModPolarity"
>IpatchSF2ModPolarity</a>;
enum <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2ModType"
>IpatchSF2ModType</a>;
enum <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2ModTransform"
>IpatchSF2ModTransform</a>;
enum <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2ModFlags"
>IpatchSF2ModFlags</a>;
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-get-type"
>ipatch_sf2_mod_get_type</a> (void);
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-get-type"
>ipatch_sf2_mod_list_get_type</a> (void);
<a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> * <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-new"
>ipatch_sf2_mod_new</a> (void);
void <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-free"
>ipatch_sf2_mod_free</a> (<a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *mod);
<a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> * <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-duplicate"
>ipatch_sf2_mod_duplicate</a> (const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *mod);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> * <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-duplicate"
>ipatch_sf2_mod_list_duplicate</a> (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *list);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> * <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-override"
>ipatch_sf2_mod_list_override</a> (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *alist,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *blist,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> copy);
void <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-boxed-free"
>ipatch_sf2_mod_list_boxed_free</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *list);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> * <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-insert"
>ipatch_sf2_mod_list_insert</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *mods,
const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *modvals,
int pos);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> * <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-remove"
>ipatch_sf2_mod_list_remove</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *mods,
const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *modvals,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> *changed);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-change"
>ipatch_sf2_mod_list_change</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *mods,
const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *oldvals,
const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *newvals);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> * <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-offset"
>ipatch_sf2_mod_list_offset</a> (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *alist,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *blist);
void <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-free"
>ipatch_sf2_mod_list_free</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *list,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> free_mods);
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> * <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-get-default"
>ipatch_sf2_mod_list_get_default</a> (void);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libinstpatch-IpatchSF2Mod.description"></a><h2>Description</h2>
<p>
SoundFont modulators are used to define real time MIDI effect controls.</p>
</div>
<div class="refsect1" title="Details">
<a name="libinstpatch-IpatchSF2Mod.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchSF2Mod">
<a name="IpatchSF2Mod"></a><h3>IpatchSF2Mod</h3>
<pre class="programlisting">typedef struct {
guint16 src; /* source modulator (MIDI controller, etc) */
guint16 dest; /* destination generator */
gint16 amount; /* degree of modulation */
guint16 amtsrc; /* second source controls amount of first */
guint16 trans; /* transform function applied to source */
} IpatchSF2Mod;
</pre>
</div>
<hr>
<div class="refsect2" title="IpatchSF2ModList">
<a name="IpatchSF2ModList"></a><h3>IpatchSF2ModList</h3>
<pre class="programlisting">typedef GSList IpatchSF2ModList;
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_TYPE_SF2_MOD">
<a name="IPATCH-TYPE-SF2-MOD--CAPS"></a><h3>IPATCH_TYPE_SF2_MOD</h3>
<pre class="programlisting">#define IPATCH_TYPE_SF2_MOD (ipatch_sf2_mod_get_type ())
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_TYPE_SF2_MOD_LIST">
<a name="IPATCH-TYPE-SF2-MOD-LIST--CAPS"></a><h3>IPATCH_TYPE_SF2_MOD_LIST</h3>
<pre class="programlisting">#define IPATCH_TYPE_SF2_MOD_LIST (ipatch_sf2_mod_list_get_type ())
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_MOD_ARE_IDENTICAL()">
<a name="IPATCH-SF2-MOD-ARE-IDENTICAL--CAPS"></a><h3>IPATCH_SF2_MOD_ARE_IDENTICAL()</h3>
<pre class="programlisting">#define IPATCH_SF2_MOD_ARE_IDENTICAL(a, b)</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_MOD_ARE_IDENTICAL_AMOUNT()">
<a name="IPATCH-SF2-MOD-ARE-IDENTICAL-AMOUNT--CAPS"></a><h3>IPATCH_SF2_MOD_ARE_IDENTICAL_AMOUNT()</h3>
<pre class="programlisting">#define IPATCH_SF2_MOD_ARE_IDENTICAL_AMOUNT(a, b)</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSF2ModFieldMasks">
<a name="IpatchSF2ModFieldMasks"></a><h3>enum IpatchSF2ModFieldMasks</h3>
<pre class="programlisting">typedef enum
{
IPATCH_SF2_MOD_MASK_CONTROL = 0x007F,
IPATCH_SF2_MOD_MASK_CC = 0x0080,
IPATCH_SF2_MOD_MASK_DIRECTION = 0x0100,
IPATCH_SF2_MOD_MASK_POLARITY = 0x0200,
IPATCH_SF2_MOD_MASK_TYPE = 0xFC00
} IpatchSF2ModFieldMasks;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSF2ModFieldShifts">
<a name="IpatchSF2ModFieldShifts"></a><h3>enum IpatchSF2ModFieldShifts</h3>
<pre class="programlisting">typedef enum
{
IPATCH_SF2_MOD_SHIFT_CONTROL = 0,
IPATCH_SF2_MOD_SHIFT_CC = 7,
IPATCH_SF2_MOD_SHIFT_DIRECTION = 8,
IPATCH_SF2_MOD_SHIFT_POLARITY = 9,
IPATCH_SF2_MOD_SHIFT_TYPE = 10
} IpatchSF2ModFieldShifts;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSF2ModControl">
<a name="IpatchSF2ModControl"></a><h3>enum IpatchSF2ModControl</h3>
<pre class="programlisting">typedef enum
{
IPATCH_SF2_MOD_CONTROL_NONE = 0,
IPATCH_SF2_MOD_CONTROL_NOTE_ON_VELOCITY = 2,
IPATCH_SF2_MOD_CONTROL_NOTE_NUMBER = 3,
IPATCH_SF2_MOD_CONTROL_POLY_PRESSURE = 10,
IPATCH_SF2_MOD_CONTROL_CHAN_PRESSURE = 13,
IPATCH_SF2_MOD_CONTROL_PITCH_WHEEL = 14,
IPATCH_SF2_MOD_CONTROL_BEND_RANGE = 16
} IpatchSF2ModControl;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSF2ModControlPalette">
<a name="IpatchSF2ModControlPalette"></a><h3>enum IpatchSF2ModControlPalette</h3>
<pre class="programlisting">typedef enum
{
IPATCH_SF2_MOD_CC_GENERAL = (0 << IPATCH_SF2_MOD_SHIFT_CC),
IPATCH_SF2_MOD_CC_MIDI = (1 << IPATCH_SF2_MOD_SHIFT_CC)
} IpatchSF2ModControlPalette;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSF2ModDirection">
<a name="IpatchSF2ModDirection"></a><h3>enum IpatchSF2ModDirection</h3>
<pre class="programlisting">typedef enum
{
IPATCH_SF2_MOD_DIRECTION_POSITIVE = (0 << IPATCH_SF2_MOD_SHIFT_DIRECTION),
IPATCH_SF2_MOD_DIRECTION_NEGATIVE = (1 << IPATCH_SF2_MOD_SHIFT_DIRECTION)
} IpatchSF2ModDirection;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSF2ModPolarity">
<a name="IpatchSF2ModPolarity"></a><h3>enum IpatchSF2ModPolarity</h3>
<pre class="programlisting">typedef enum
{
IPATCH_SF2_MOD_POLARITY_UNIPOLAR = (0 << IPATCH_SF2_MOD_SHIFT_POLARITY),
IPATCH_SF2_MOD_POLARITY_BIPOLAR = (1 << IPATCH_SF2_MOD_SHIFT_POLARITY)
} IpatchSF2ModPolarity;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSF2ModType">
<a name="IpatchSF2ModType"></a><h3>enum IpatchSF2ModType</h3>
<pre class="programlisting">typedef enum
{
IPATCH_SF2_MOD_TYPE_LINEAR = (0 << IPATCH_SF2_MOD_SHIFT_TYPE),
IPATCH_SF2_MOD_TYPE_CONCAVE = (1 << IPATCH_SF2_MOD_SHIFT_TYPE),
IPATCH_SF2_MOD_TYPE_CONVEX = (2 << IPATCH_SF2_MOD_SHIFT_TYPE),
IPATCH_SF2_MOD_TYPE_SWITCH = (3 << IPATCH_SF2_MOD_SHIFT_TYPE)
} IpatchSF2ModType;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSF2ModTransform">
<a name="IpatchSF2ModTransform"></a><h3>enum IpatchSF2ModTransform</h3>
<pre class="programlisting">typedef enum
{
IPATCH_SF2_MOD_TRANSFORM_LINEAR = 0
} IpatchSF2ModTransform;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSF2ModFlags">
<a name="IpatchSF2ModFlags"></a><h3>enum IpatchSF2ModFlags</h3>
<pre class="programlisting">typedef enum
{
IPATCH_SF2_MOD_NO_DUPLICATE = 1 << 0, /* don't duplicate mod list (owned!) */
IPATCH_SF2_MOD_NO_NOTIFY = 1 << 1 /* don't do item property notify */
} IpatchSF2ModFlags;
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_get_type ()">
<a name="ipatch-sf2-mod-get-type"></a><h3>ipatch_sf2_mod_get_type ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> ipatch_sf2_mod_get_type (void);</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_list_get_type ()">
<a name="ipatch-sf2-mod-list-get-type"></a><h3>ipatch_sf2_mod_list_get_type ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a> ipatch_sf2_mod_list_get_type (void);</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_new ()">
<a name="ipatch-sf2-mod-new"></a><h3>ipatch_sf2_mod_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> * ipatch_sf2_mod_new (void);</pre>
<p>
Create a new modulator</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New modulator
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_free ()">
<a name="ipatch-sf2-mod-free"></a><h3>ipatch_sf2_mod_free ()</h3>
<pre class="programlisting">void ipatch_sf2_mod_free (<a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *mod);</pre>
<p>
Free an <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
><span class="type">IpatchSF2Mod</span></a> structure</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>mod</code></em> :</span></p></td>
<td> Modulator to free, should not be referenced by any zones.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_duplicate ()">
<a name="ipatch-sf2-mod-duplicate"></a><h3>ipatch_sf2_mod_duplicate ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> * ipatch_sf2_mod_duplicate (const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *mod);</pre>
<p>
Duplicate a modulator</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mod</code></em> :</span></p></td>
<td> Modulator to duplicate
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New duplicate modulator
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_list_duplicate ()">
<a name="ipatch-sf2-mod-list-duplicate"></a><h3>ipatch_sf2_mod_list_duplicate ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> * ipatch_sf2_mod_list_duplicate (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *list);</pre>
<p>
Duplicates a modulator list (GSList and modulator data).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td> Modulator list to duplicate
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New duplicate modulator list which should be freed with
<a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-free"
><code class="function">ipatch_sf2_mod_list_free()</code></a> with <em class="parameter"><code>free_mods</code></em> set to <code class="literal">TRUE</code> when finished with it.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_list_override ()">
<a name="ipatch-sf2-mod-list-override"></a><h3>ipatch_sf2_mod_list_override ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> * ipatch_sf2_mod_list_override (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *alist,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *blist,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> copy);</pre>
<p>
Creates a new modulator list by combining <em class="parameter"><code>alist</code></em> and <em class="parameter"><code>blist</code></em>. Modulators
in <em class="parameter"><code>blist</code></em> override identical modulators in <em class="parameter"><code>alist</code></em>. If <em class="parameter"><code>copy</code></em> is set then
the modulator data is also duplicated (a new GSList is created).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>alist</code></em> :</span></p></td>
<td> First modulator list
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>blist</code></em> :</span></p></td>
<td> Second modulator list
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>copy</code></em> :</span></p></td>
<td> If <code class="literal">TRUE</code> then modulator data is duplicated
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New GSList of combined modulator lists. Should be freed with
<a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-free"
><code class="function">ipatch_sf2_mod_list_free()</code></a> with the free_mods parameter set to the value of
<em class="parameter"><code>copy</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_list_boxed_free ()">
<a name="ipatch-sf2-mod-list-boxed-free"></a><h3>ipatch_sf2_mod_list_boxed_free ()</h3>
<pre class="programlisting">void ipatch_sf2_mod_list_boxed_free (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *list);</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_list_insert ()">
<a name="ipatch-sf2-mod-list-insert"></a><h3>ipatch_sf2_mod_list_insert ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> * ipatch_sf2_mod_list_insert (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *mods,
const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *modvals,
int pos);</pre>
<p>
Inserts a modulator into a modulator list. Does not check for
duplicates! The modulator is not used directly, a new one is created and
the values in <em class="parameter"><code>mod</code></em> are copied to it.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mods</code></em> :</span></p></td>
<td> Modulator list to insert into
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>modvals</code></em> :</span></p></td>
<td> Modulator values to insert (a new modulator is created and the values
are copied to it)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pos</code></em> :</span></p></td>
<td> Index position in zone's modulator list to insert
(0 = first, < 0 = last)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New start (root) of <em class="parameter"><code>mods</code></em> list.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_list_remove ()">
<a name="ipatch-sf2-mod-list-remove"></a><h3>ipatch_sf2_mod_list_remove ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> * ipatch_sf2_mod_list_remove (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *mods,
const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *modvals,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> *changed);</pre>
<p>
Remove a modulator from a modulator list. The modulator values in <em class="parameter"><code>modvals</code></em>
are used to search the modulator list. The first modulator
that matches all fields in <em class="parameter"><code>modvals</code></em> is removed.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mods</code></em> :</span></p></td>
<td> Modulator list to remove from
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>modvals</code></em> :</span></p></td>
<td> Values of modulator to remove
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>changed</code></em> :</span></p></td>
<td> Pointer to store bool of whether the list was changed
(<code class="literal">NULL</code> to ignore)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_list_change ()">
<a name="ipatch-sf2-mod-list-change"></a><h3>ipatch_sf2_mod_list_change ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ipatch_sf2_mod_list_change (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *mods,
const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *oldvals,
const <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#IpatchSF2Mod"
>IpatchSF2Mod</a> *newvals);</pre>
<p>
Sets the values of an existing modulator in a modulator list. The list
is searched for a modulator that matches the values in <em class="parameter"><code>oldvals</code></em>. If a
modulator is found its values are set to those in <em class="parameter"><code>newvals</code></em>. If it is not
found, nothing is done.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mods</code></em> :</span></p></td>
<td> Modulator list to change a modulator in
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>oldvals</code></em> :</span></p></td>
<td> Current values of modulator to set
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>newvals</code></em> :</span></p></td>
<td> New modulator values
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <code class="literal">TRUE</code> if changed, <code class="literal">FALSE</code> otherwise (no match)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_list_offset ()">
<a name="ipatch-sf2-mod-list-offset"></a><h3>ipatch_sf2_mod_list_offset ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> * ipatch_sf2_mod_list_offset (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *alist,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *blist);</pre>
<p>
Creates a new modulator list by combining <em class="parameter"><code>list</code></em> and <em class="parameter"><code>blist</code></em>. Modulators
in <em class="parameter"><code>blist</code></em> offset (amounts are added) identical modulators in <em class="parameter"><code>alist</code></em>.
Operation is non-destructive as a new list is created and modulator data
is duplicated.
</p>
<p>
NOTE: Optimized for empty <em class="parameter"><code>blist</code></em>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>alist</code></em> :</span></p></td>
<td> First modulator list
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>blist</code></em> :</span></p></td>
<td> Second modulator list
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New GSList of combined modulator lists. Should be freed with
<a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-free"
><code class="function">ipatch_sf2_mod_list_free()</code></a> with <em class="parameter"><code>free_mods</code></em> set to <code class="literal">TRUE</code> when finished with it.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_list_free ()">
<a name="ipatch-sf2-mod-list-free"></a><h3>ipatch_sf2_mod_list_free ()</h3>
<pre class="programlisting">void ipatch_sf2_mod_list_free (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> *list,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> free_mods);</pre>
<p>
Like <a
href="../libinstpatch/libinstpatch-IpatchSF2Mod.html#ipatch-sf2-mod-list-free"
><code class="function">ipatch_sf2_mod_list_free()</code></a> but used for boxed type declaration and so
therefore frees all modulators in the list.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td> Modulator list to free
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_mod_list_get_default ()">
<a name="ipatch-sf2-mod-list-get-default"></a><h3>ipatch_sf2_mod_list_get_default ()</h3>
<pre class="programlisting">const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"
>GSList</a> * ipatch_sf2_mod_list_get_default (void);</pre>
<p>
Get the list of default instrument modulators.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The list of default modulators. The same modulator list is
returned on subsequent calls and should not be modified or freed.
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|