This file is indexed.

/usr/share/gtk-doc/html/libinstpatch/libinstpatch-IpatchSF2Gen.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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchSF2Gen</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="IpatchSF2Zone.html" title="IpatchSF2Zone">
<link rel="next" href="libinstpatch-IpatchSF2GenItem.html" title="IpatchSF2GenItem">
<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="IpatchSF2Zone.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-IpatchSF2GenItem.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-IpatchSF2Gen.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#libinstpatch-IpatchSF2Gen.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="IpatchSF2Gen">
<a name="libinstpatch-IpatchSF2Gen"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinstpatch-IpatchSF2Gen.top_of_page"></a>IpatchSF2Gen</span></h2>
<p>IpatchSF2Gen — SoundFont generator functions and definitions</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="libinstpatch-IpatchSF2Gen.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libinstpatch-IpatchSF2Gen.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#define             <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IPATCH-SF2-GEN-COUNT--CAPS"
>IPATCH_SF2_GEN_COUNT</a>
                    <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a>;
                    <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenInfo"
>IpatchSF2GenInfo</a>;
#define             <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IPATCH-TYPE-SF2-GEN-ARRAY--CAPS"
>IPATCH_TYPE_SF2_GEN_ARRAY</a>
enum                <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenPropsType"
>IpatchSF2GenPropsType</a>;
#define             <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IPATCH-SF2-GEN-PROPS-GLOBAL-FLAG--CAPS"
>IPATCH_SF2_GEN_PROPS_GLOBAL_FLAG</a>
#define             <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IPATCH-SF2-GEN-PROPS-MASK--CAPS"
>IPATCH_SF2_GEN_PROPS_MASK</a>
union               <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a>;
struct              <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2Gen"
>IpatchSF2Gen</a>;
#define             <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IPATCH-SF2-GENID-SET--CAPS"
>IPATCH_SF2_GENID_SET</a>                (genid)
#define             <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IPATCH-SF2-GEN-ARRAY-TEST-FLAG--CAPS"
>IPATCH_SF2_GEN_ARRAY_TEST_FLAG</a>      (array, genid)
#define             <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IPATCH-SF2-GEN-ARRAY-SET-FLAG--CAPS"
>IPATCH_SF2_GEN_ARRAY_SET_FLAG</a>       (array, genid)
#define             <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IPATCH-SF2-GEN-ARRAY-CLEAR-FLAG--CAPS"
>IPATCH_SF2_GEN_ARRAY_CLEAR_FLAG</a>     (array, genid)
enum                <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenType"
>IpatchSF2GenType</a>;
enum                <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenSampleModes"
>IpatchSF2GenSampleModes</a>;
extern              IpatchSF2GenArray *<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-ofs-array"
>ipatch_sf2_gen_ofs_array</a>;
extern              IpatchSF2GenArray *<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-abs-array"
>ipatch_sf2_gen_abs_array</a>;
extern              guint64 <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-ofs-valid-mask"
>ipatch_sf2_gen_ofs_valid_mask</a>;
extern              guint64 <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-abs-valid-mask"
>ipatch_sf2_gen_abs_valid_mask</a>;
extern              guint64 <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-add-mask"
>ipatch_sf2_gen_add_mask</a>;
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-is-valid"
>ipatch_sf2_gen_is_valid</a>             (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenPropsType"
>IpatchSF2GenPropsType</a> propstype);
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a>               <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-array-get-type"
>ipatch_sf2_gen_array_get_type</a>       (void);
<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> * <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-array-new"
>ipatch_sf2_gen_array_new</a>            (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> clear);
void                <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-array-free"
>ipatch_sf2_gen_array_free</a>           (<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *genarray);
<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> * <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-array-duplicate"
>ipatch_sf2_gen_array_duplicate</a>      (const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array);
void                <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-array-init"
>ipatch_sf2_gen_array_init</a>           (<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> offset,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> set);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-array-offset"
>ipatch_sf2_gen_array_offset</a>         (<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *abs_array,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *ofs_array);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-array-intersect-test"
>ipatch_sf2_gen_array_intersect_test</a> (const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array1,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array2);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a>               <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-array-count-set"
>ipatch_sf2_gen_array_count_set</a>      (<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array);
void                <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-amount-to-value"
>ipatch_sf2_gen_amount_to_value</a>      (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *amt,
                                                         <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value);
void                <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-default-value"
>ipatch_sf2_gen_default_value</a>        (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ispreset,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *out_amt);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-offset"
>ipatch_sf2_gen_offset</a>               (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *dst,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *ofs);
void                <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-clamp"
>ipatch_sf2_gen_clamp</a>                (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
                                                         int *sfval,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ispreset);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-range-intersect"
>ipatch_sf2_gen_range_intersect</a>      (<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *dst,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *src);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-range-intersect-test"
>ipatch_sf2_gen_range_intersect_test</a> (const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *amt1,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *amt2);
const char *        <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#ipatch-sf2-gen-get-prop-name"
>ipatch_sf2_gen_get_prop_name</a>        (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libinstpatch-IpatchSF2Gen.description"></a><h2>Description</h2>
<p>
SoundFont generators are synthesis parameters used by <a
href="../libinstpatch/IpatchSF2Preset.html"
><span class="type">IpatchSF2Preset</span></a>,
<a
href="../libinstpatch/IpatchSF2Inst.html"
><span class="type">IpatchSF2Inst</span></a>, <a
href="../libinstpatch/IpatchSF2PZone.html"
><span class="type">IpatchSF2PZone</span></a> and <a
href="../libinstpatch/IpatchSF2IZone.html"
><span class="type">IpatchSF2IZone</span></a> objects.</p>
</div>
<div class="refsect1" title="Details">
<a name="libinstpatch-IpatchSF2Gen.details"></a><h2>Details</h2>
<div class="refsect2" title="IPATCH_SF2_GEN_COUNT">
<a name="IPATCH-SF2-GEN-COUNT--CAPS"></a><h3>IPATCH_SF2_GEN_COUNT</h3>
<pre class="programlisting">#define IPATCH_SF2_GEN_COUNT 59
</pre>
</div>
<hr>
<div class="refsect2" title="IpatchSF2GenArray">
<a name="IpatchSF2GenArray"></a><h3>IpatchSF2GenArray</h3>
<pre class="programlisting">typedef struct {
  guint64 flags; /* 1 bit for each generator indicating if it is set */
  IpatchSF2GenAmount values[IPATCH_SF2_GEN_COUNT]; /* gen values */
} IpatchSF2GenArray;
</pre>
</div>
<hr>
<div class="refsect2" title="IpatchSF2GenInfo">
<a name="IpatchSF2GenInfo"></a><h3>IpatchSF2GenInfo</h3>
<pre class="programlisting">typedef struct {
  IpatchSF2GenAmount min;	/* minimum value allowed */
  IpatchSF2GenAmount max;	/* maximum value allowed */
  IpatchSF2GenAmount def;	/* default value */
  gint16 unit;			/* #IpatchUnitType type */
  char *label;			/* short descriptive label */
  char *descr;			/* more complete description */
} IpatchSF2GenInfo;
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_TYPE_SF2_GEN_ARRAY">
<a name="IPATCH-TYPE-SF2-GEN-ARRAY--CAPS"></a><h3>IPATCH_TYPE_SF2_GEN_ARRAY</h3>
<pre class="programlisting">#define IPATCH_TYPE_SF2_GEN_ARRAY   (ipatch_sf2_gen_array_get_type ())
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSF2GenPropsType">
<a name="IpatchSF2GenPropsType"></a><h3>enum IpatchSF2GenPropsType</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_SF2_GEN_PROPS_INST = 0,	/* instrument "absolute" properties */
  IPATCH_SF2_GEN_PROPS_PRESET = 1,	/* preset "offset" properties */
  IPATCH_SF2_GEN_PROPS_INST_GLOBAL = 2,	/* inst properties with no sample link */
  IPATCH_SF2_GEN_PROPS_PRESET_GLOBAL = 3  /* preset props with no inst link */
} IpatchSF2GenPropsType;
</pre>
<p>
Generator property type (defines which gens are valid and their ranges).
Note that TRUE/FALSE can be used to designate PRESET/INST (backwards
compatible with previous function).  Also note that global properties can
be treated as a flag: <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IPATCH-SF2-GEN-PROPS-GLOBAL-FLAG--CAPS"
><span class="type">IPATCH_SF2_GEN_PROPS_GLOBAL_FLAG</span></a>.</p>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_GEN_PROPS_GLOBAL_FLAG">
<a name="IPATCH-SF2-GEN-PROPS-GLOBAL-FLAG--CAPS"></a><h3>IPATCH_SF2_GEN_PROPS_GLOBAL_FLAG</h3>
<pre class="programlisting">#define IPATCH_SF2_GEN_PROPS_GLOBAL_FLAG	0x02
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_GEN_PROPS_MASK">
<a name="IPATCH-SF2-GEN-PROPS-MASK--CAPS"></a><h3>IPATCH_SF2_GEN_PROPS_MASK</h3>
<pre class="programlisting">#define IPATCH_SF2_GEN_PROPS_MASK		0x01
</pre>
</div>
<hr>
<div class="refsect2" title="union IpatchSF2GenAmount">
<a name="IpatchSF2GenAmount"></a><h3>union IpatchSF2GenAmount</h3>
<pre class="programlisting">union IpatchSF2GenAmount
{
  /*&lt; public &gt;*/
  gint16 sword;			/* signed 16 bit value */
  guint16 uword;		/* unsigned 16 bit value */
  struct
  {
    guint8 low;			/* low value of range */
    guint8 high;		/* high value of range */
  } range;			/* range values, low - high */
};
</pre>
</div>
<hr>
<div class="refsect2" title="struct IpatchSF2Gen">
<a name="IpatchSF2Gen"></a><h3>struct IpatchSF2Gen</h3>
<pre class="programlisting">struct IpatchSF2Gen {
  guint16 id;			/* generator #IPGenType ID */
  IpatchSF2GenAmount amount;	/* generator value */
};
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_GENID_SET()">
<a name="IPATCH-SF2-GENID-SET--CAPS"></a><h3>IPATCH_SF2_GENID_SET()</h3>
<pre class="programlisting">#define IPATCH_SF2_GENID_SET(genid) ((guint64)0x1 &lt;&lt; (genid))
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_GEN_ARRAY_TEST_FLAG()">
<a name="IPATCH-SF2-GEN-ARRAY-TEST-FLAG--CAPS"></a><h3>IPATCH_SF2_GEN_ARRAY_TEST_FLAG()</h3>
<pre class="programlisting">#define             IPATCH_SF2_GEN_ARRAY_TEST_FLAG(array, genid)</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_GEN_ARRAY_SET_FLAG()">
<a name="IPATCH-SF2-GEN-ARRAY-SET-FLAG--CAPS"></a><h3>IPATCH_SF2_GEN_ARRAY_SET_FLAG()</h3>
<pre class="programlisting">#define             IPATCH_SF2_GEN_ARRAY_SET_FLAG(array, genid)</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SF2_GEN_ARRAY_CLEAR_FLAG()">
<a name="IPATCH-SF2-GEN-ARRAY-CLEAR-FLAG--CAPS"></a><h3>IPATCH_SF2_GEN_ARRAY_CLEAR_FLAG()</h3>
<pre class="programlisting">#define             IPATCH_SF2_GEN_ARRAY_CLEAR_FLAG(array, genid)</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSF2GenType">
<a name="IpatchSF2GenType"></a><h3>enum IpatchSF2GenType</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_SF2_GEN_SAMPLE_START = 0, /* sample start offset */
  IPATCH_SF2_GEN_SAMPLE_END = 1,	/* sample end offset */
  IPATCH_SF2_GEN_SAMPLE_LOOP_START = 2,/* sample loop start offset */
  IPATCH_SF2_GEN_SAMPLE_LOOP_END = 3, /* sample loop end offset */
  IPATCH_SF2_GEN_SAMPLE_COARSE_START = 4, /* sample start coarse offset */
  IPATCH_SF2_GEN_MOD_LFO_TO_PITCH = 5, /* modulation LFO to pitch */
  IPATCH_SF2_GEN_VIB_LFO_TO_PITCH = 6, /* vibrato LFO to pitch */
  IPATCH_SF2_GEN_MOD_ENV_TO_PITCH = 7, /* modulation envelope to pitch */
  IPATCH_SF2_GEN_FILTER_CUTOFF = 8,	/* initial filter cutoff */
  IPATCH_SF2_GEN_FILTER_Q = 9,	/* filter Q */
  IPATCH_SF2_GEN_MOD_LFO_TO_FILTER_CUTOFF = 10, /* mod LFO to filter cutoff */
  IPATCH_SF2_GEN_MOD_ENV_TO_FILTER_CUTOFF = 11, /* mod envelope to filter cutoff */
  IPATCH_SF2_GEN_SAMPLE_COARSE_END = 12, /* sample end course offset */
  IPATCH_SF2_GEN_MOD_LFO_TO_VOLUME = 13, /* modulation LFO to volume */
  IPATCH_SF2_GEN_UNUSED1 = 14,
  IPATCH_SF2_GEN_CHORUS = 15, /* chorus */
  IPATCH_SF2_GEN_REVERB = 16, /* reverb */
  IPATCH_SF2_GEN_PAN = 17,	/* panning */
  IPATCH_SF2_GEN_UNUSED2 = 18,
  IPATCH_SF2_GEN_UNUSED3 = 19,
  IPATCH_SF2_GEN_UNUSED4 = 20,
  IPATCH_SF2_GEN_MOD_LFO_DELAY = 21, /* modulation LFO delay */
  IPATCH_SF2_GEN_MOD_LFO_FREQ = 22, /* modulation LFO frequency */
  IPATCH_SF2_GEN_VIB_LFO_DELAY = 23, /* vibrato LFO delay */
  IPATCH_SF2_GEN_VIB_LFO_FREQ = 24, /* vibrato LFO frequency */
  IPATCH_SF2_GEN_MOD_ENV_DELAY = 25, /* modulation envelope delay */
  IPATCH_SF2_GEN_MOD_ENV_ATTACK = 26, /* modulation envelope attack */
  IPATCH_SF2_GEN_MOD_ENV_HOLD = 27, /* modulation envelope hold */
  IPATCH_SF2_GEN_MOD_ENV_DECAY = 28, /* modulation envelope decay */
  IPATCH_SF2_GEN_MOD_ENV_SUSTAIN = 29, /* modulation envelope sustain */
  IPATCH_SF2_GEN_MOD_ENV_RELEASE = 30, /* modulation envelope release */
  IPATCH_SF2_GEN_NOTE_TO_MOD_ENV_HOLD = 31, /* MIDI note to mod envelope hold */
  IPATCH_SF2_GEN_NOTE_TO_MOD_ENV_DECAY = 32, /* MIDI note to mod env decay */
  IPATCH_SF2_GEN_VOL_ENV_DELAY = 33, /* volume envelope delay */
  IPATCH_SF2_GEN_VOL_ENV_ATTACK = 34, /* volume envelope attack */
  IPATCH_SF2_GEN_VOL_ENV_HOLD = 35, /* volume envelope hold */
  IPATCH_SF2_GEN_VOL_ENV_DECAY = 36, /* volume envelope decay */
  IPATCH_SF2_GEN_VOL_ENV_SUSTAIN = 37, /* volume envelope sustain */
  IPATCH_SF2_GEN_VOL_ENV_RELEASE = 38, /* volume envelope release */
  IPATCH_SF2_GEN_NOTE_TO_VOL_ENV_HOLD = 39, /* MIDI note to vol envelope hold */
  IPATCH_SF2_GEN_NOTE_TO_VOL_ENV_DECAY = 40, /* MIDI note to volume env decay */
  IPATCH_SF2_GEN_INSTRUMENT_ID = 41, /* instrument ID */
  IPATCH_SF2_GEN_RESERVED1 = 42,
  IPATCH_SF2_GEN_NOTE_RANGE = 43,	/* note range */
  IPATCH_SF2_GEN_VELOCITY_RANGE = 44, /* note on velocity range */
  IPATCH_SF2_GEN_SAMPLE_COARSE_LOOP_START = 45, /* sample coarse loop start */
  IPATCH_SF2_GEN_FIXED_NOTE = 46, /* MIDI fixed note */
  IPATCH_SF2_GEN_FIXED_VELOCITY = 47, /* MIDI fixed velocity */
  IPATCH_SF2_GEN_ATTENUATION = 48, /* initial volume attenuation */
  IPATCH_SF2_GEN_RESERVED2 = 49,
  IPATCH_SF2_GEN_SAMPLE_COARSE_LOOP_END = 50, /* sample end loop course ofs */
  IPATCH_SF2_GEN_COARSE_TUNE = 51, /* course tuning */
  IPATCH_SF2_GEN_FINE_TUNE_OVERRIDE = 52,	/* fine tune override */
  IPATCH_SF2_GEN_SAMPLE_ID = 53,	/* sample ID */
  IPATCH_SF2_GEN_SAMPLE_MODES = 54, /* sample flags (IpatchSF2GenSampleModes)*/
  IPATCH_SF2_GEN_RESERVED3 = 55,
  IPATCH_SF2_GEN_SCALE_TUNE = 56, /* scale tuning (tuning per MIDI note) */
  IPATCH_SF2_GEN_EXCLUSIVE_CLASS = 57, /* exclusive class (only 1 at a time) */
  IPATCH_SF2_GEN_ROOT_NOTE_OVERRIDE = 58	/* root note override */
} IpatchSF2GenType;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSF2GenSampleModes">
<a name="IpatchSF2GenSampleModes"></a><h3>enum IpatchSF2GenSampleModes</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_SF2_GEN_SAMPLE_MODE_NOLOOP = 0,
  IPATCH_SF2_GEN_SAMPLE_MODE_LOOP   = 1 &lt;&lt; 0,
  IPATCH_SF2_GEN_SAMPLE_MODE_LOOP_RELEASE = 1 &lt;&lt; 1
} IpatchSF2GenSampleModes;
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_ofs_array">
<a name="ipatch-sf2-gen-ofs-array"></a><h3>ipatch_sf2_gen_ofs_array</h3>
<pre class="programlisting">extern IpatchSF2GenArray *ipatch_sf2_gen_ofs_array;
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_abs_array">
<a name="ipatch-sf2-gen-abs-array"></a><h3>ipatch_sf2_gen_abs_array</h3>
<pre class="programlisting">extern IpatchSF2GenArray *ipatch_sf2_gen_abs_array;
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_ofs_valid_mask">
<a name="ipatch-sf2-gen-ofs-valid-mask"></a><h3>ipatch_sf2_gen_ofs_valid_mask</h3>
<pre class="programlisting">extern guint64 ipatch_sf2_gen_ofs_valid_mask;
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_abs_valid_mask">
<a name="ipatch-sf2-gen-abs-valid-mask"></a><h3>ipatch_sf2_gen_abs_valid_mask</h3>
<pre class="programlisting">extern guint64 ipatch_sf2_gen_abs_valid_mask;
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_add_mask">
<a name="ipatch-sf2-gen-add-mask"></a><h3>ipatch_sf2_gen_add_mask</h3>
<pre class="programlisting">extern guint64 ipatch_sf2_gen_add_mask;
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_is_valid ()">
<a name="ipatch-sf2-gen-is-valid"></a><h3>ipatch_sf2_gen_is_valid ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            ipatch_sf2_gen_is_valid             (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenPropsType"
>IpatchSF2GenPropsType</a> propstype);</pre>
<p>
Checks if a generator is valid for the given <em class="parameter"><code>propstype</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>genid</code></em> :</span></p></td>
<td> Generator ID to check
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>propstype</code></em> :</span></p></td>
<td> Generator property type (instrument/preset + global)
</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 valid, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_array_get_type ()">
<a name="ipatch-sf2-gen-array-get-type"></a><h3>ipatch_sf2_gen_array_get_type ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GType"
>GType</a>               ipatch_sf2_gen_array_get_type       (void);</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_array_new ()">
<a name="ipatch-sf2-gen-array-new"></a><h3>ipatch_sf2_gen_array_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> * ipatch_sf2_gen_array_new            (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> clear);</pre>
<p>
Create a new generator array object. A convenience function really,
because one could just allocate an IpatchSF2GenArray structure instead.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>clear</code></em> :</span></p></td>
<td> If <code class="literal">TRUE</code> then array will be cleared, <code class="literal">FALSE</code> will not initalize it
  and it is up to the caller to do so.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> New generator
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_array_free ()">
<a name="ipatch-sf2-gen-array-free"></a><h3>ipatch_sf2_gen_array_free ()</h3>
<pre class="programlisting">void                ipatch_sf2_gen_array_free           (<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *genarray);</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_array_duplicate ()">
<a name="ipatch-sf2-gen-array-duplicate"></a><h3>ipatch_sf2_gen_array_duplicate ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> * ipatch_sf2_gen_array_duplicate      (const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array);</pre>
<p>
Duplicates a generator array structure.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
<td> Generator array to duplicate
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A newly allocated generator array structure which is a duplicate
  of <em class="parameter"><code>array</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_array_init ()">
<a name="ipatch-sf2-gen-array-init"></a><h3>ipatch_sf2_gen_array_init ()</h3>
<pre class="programlisting">void                ipatch_sf2_gen_array_init           (<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> offset,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> set);</pre>
<p>
Initialize a generator array to default values.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
<td> Generator array
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>offset</code></em> :</span></p></td>
<td> <code class="literal">TRUE</code> = initialize to Preset offset (zero) values,
  <code class="literal">FALSE</code> = initialize to instrument default values
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>set</code></em> :</span></p></td>
<td> <code class="literal">TRUE</code> to set flags indicating generator values are set, <code class="literal">FALSE</code> to
  clear all flag "set" bits
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_array_offset ()">
<a name="ipatch-sf2-gen-array-offset"></a><h3>ipatch_sf2_gen_array_offset ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            ipatch_sf2_gen_array_offset         (<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *abs_array,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *ofs_array);</pre>
<p>
Offsets the generators amount array in <em class="parameter"><code>abs_array</code></em> by adding the
values in <em class="parameter"><code>ofs_array</code></em> to it. Values are clamped to their valid ranges.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>abs_array</code></em> :</span></p></td>
<td> Destination generator amount array that contains absolute
  (Instrument) generator values
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ofs_array</code></em> :</span></p></td>
<td> Source generator amount array that contains offset (Preset)
  generator values
</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 note or velocity range does not intersect (in which case
  the non-intersecting ranges are left unassigned), <code class="literal">TRUE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_array_intersect_test ()">
<a name="ipatch-sf2-gen-array-intersect-test"></a><h3>ipatch_sf2_gen_array_intersect_test ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            ipatch_sf2_gen_array_intersect_test (const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array1,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array2);</pre>
<p>
Checks if the note and velocity ranges in two generator arrays intersect.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>array1</code></em> :</span></p></td>
<td> First generator amount array
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>array2</code></em> :</span></p></td>
<td> Second generator amount array
</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 both ranges intersect, <code class="literal">FALSE</code> if one or both do not.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_array_count_set ()">
<a name="ipatch-sf2-gen-array-count-set"></a><h3>ipatch_sf2_gen_array_count_set ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a>               ipatch_sf2_gen_array_count_set      (<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array);</pre>
<p>
Get count of "set" generators in a generator array.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
<td> Generator array
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Count of "set" generators.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_amount_to_value ()">
<a name="ipatch-sf2-gen-amount-to-value"></a><h3>ipatch_sf2_gen_amount_to_value ()</h3>
<pre class="programlisting">void                ipatch_sf2_gen_amount_to_value      (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *amt,
                                                         <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *value);</pre>
<p>
Converts a generator amount to a GValue. Value will be initialized to
one of two types: G_TYPE_INT for signed/unsigned integers or
IPATCH_TYPE_RANGE for velocity or note split ranges.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>genid</code></em> :</span></p></td>
<td> Generator ID
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>amt</code></em> :</span></p></td>
<td> Generator amount for given <em class="parameter"><code>genid</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td> Uninitialized GValue to set to <em class="parameter"><code>amt</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_default_value ()">
<a name="ipatch-sf2-gen-default-value"></a><h3>ipatch_sf2_gen_default_value ()</h3>
<pre class="programlisting">void                ipatch_sf2_gen_default_value        (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ispreset,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *out_amt);</pre>
<p>
Get default value for a generator ID for the specified (<em class="parameter"><code>ispreset</code></em>) zone
type.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>genid</code></em> :</span></p></td>
<td> Generator ID
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ispreset</code></em> :</span></p></td>
<td> TRUE for preset generators, FALSE for instrument
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>out_amt</code></em> :</span></p></td>
<td> A pointer to store the default amount into
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_offset ()">
<a name="ipatch-sf2-gen-offset"></a><h3>ipatch_sf2_gen_offset ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            ipatch_sf2_gen_offset               (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *dst,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *ofs);</pre>
<p>
Offsets a generator amount. Result of offset is clamped to maximum and
  minimum values for the given generator ID.  In the case of note or
  velocity ranges a return value of <code class="literal">TRUE</code> (clamped) means that the ranges
  don't intersect (contrary return value to other range related functions).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>genid</code></em> :</span></p></td>
<td> ID of Generator to offset. Must be a valid preset generator.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dst</code></em> :</span></p></td>
<td> Pointer to the initial amount to offset, result is stored back
  into this parameter.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ofs</code></em> :</span></p></td>
<td> Pointer to offset amount.
</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 value was clamped, <code class="literal">FALSE</code> otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_clamp ()">
<a name="ipatch-sf2-gen-clamp"></a><h3>ipatch_sf2_gen_clamp ()</h3>
<pre class="programlisting">void                ipatch_sf2_gen_clamp                (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid,
                                                         int *sfval,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> ispreset);</pre>
<p>
Clamp a generators value to its valid range.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>genid</code></em> :</span></p></td>
<td> Generator ID (<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenType"
><span class="type">IpatchSF2GenType</span></a>)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>sfval</code></em> :</span></p></td>
<td> Generator value to clamp (changed in place)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ispreset</code></em> :</span></p></td>
<td> TRUE if its a Preset generator, FALSE if Instrument
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_range_intersect ()">
<a name="ipatch-sf2-gen-range-intersect"></a><h3>ipatch_sf2_gen_range_intersect ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            ipatch_sf2_gen_range_intersect      (<a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *dst,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *src);</pre>
<p>
Find intersection of two generator ranges (common shared range).
If ranges don't share anything in common <em class="parameter"><code>dst</code></em> is not assigned.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dst</code></em> :</span></p></td>
<td> First generator amount range, result is also stored here
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
<td> Second generator amount range
</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 ranges don't share any range in common.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_range_intersect_test ()">
<a name="ipatch-sf2-gen-range-intersect-test"></a><h3>ipatch_sf2_gen_range_intersect_test ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            ipatch_sf2_gen_range_intersect_test (const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *amt1,
                                                         const <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenAmount"
>IpatchSF2GenAmount</a> *amt2);</pre>
<p>
Test if two ranges intersect.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>amt1</code></em> :</span></p></td>
<td> First generator amount range
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>amt2</code></em> :</span></p></td>
<td> Second generator amount range
</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 ranges don't share any range in common, <code class="literal">TRUE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sf2_gen_get_prop_name ()">
<a name="ipatch-sf2-gen-get-prop-name"></a><h3>ipatch_sf2_gen_get_prop_name ()</h3>
<pre class="programlisting">const char *        ipatch_sf2_gen_get_prop_name        (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> genid);</pre>
<p>
Get the GObject property name for a given generator ID.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>genid</code></em> :</span></p></td>
<td> Generator ID
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Property name or <code class="literal">NULL</code> if no property name for <em class="parameter"><code>genid</code></em>.
The returned string is internal 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>