This file is indexed.

/usr/share/gtk-doc/html/libinstpatch/libinstpatch-IpatchGigEffects.html is in libinstpatch-doc 1.0.0-6.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchGigEffects</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="ch06.html" title="GigaSampler patches">
<link rel="prev" href="IpatchGigSubRegion.html" title="IpatchGigSubRegion">
<link rel="next" href="IpatchGigSample.html" title="IpatchGigSample">
<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="IpatchGigSubRegion.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch06.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="IpatchGigSample.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-IpatchGigEffects.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#libinstpatch-IpatchGigEffects.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="IpatchGigEffects">
<a name="libinstpatch-IpatchGigEffects"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinstpatch-IpatchGigEffects.top_of_page"></a>IpatchGigEffects</span></h2>
<p>IpatchGigEffects — GigaSampler instrument parameters and effects</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="libinstpatch-IpatchGigEffects.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libinstpatch-IpatchGigEffects.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#IpatchGigEffects"
>IpatchGigEffects</a>;
enum                <a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#IpatchGigFilterType"
>IpatchGigFilterType</a>;
enum                <a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#IpatchGigControlType"
>IpatchGigControlType</a>;
void                <a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#ipatch-gig-parse-effects"
>ipatch_gig_parse_effects</a>            (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#IpatchGigEffects"
>IpatchGigEffects</a> *effects);
void                <a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#ipatch-gig-store-effects"
>ipatch_gig_store_effects</a>            (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#IpatchGigEffects"
>IpatchGigEffects</a> *effects);
void                <a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#ipatch-gig-effects-init"
>ipatch_gig_effects_init</a>             (<a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#IpatchGigEffects"
>IpatchGigEffects</a> *effects);
void                <a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#ipatch-gig-effects-to-gen-array"
>ipatch_gig_effects_to_gen_array</a>     (<a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#IpatchGigEffects"
>IpatchGigEffects</a> *effects,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"
>guint16</a>             <a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#ipatch-gig-to-sf2-timecents"
>ipatch_gig_to_sf2_timecents</a>         (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> gig_tc);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"
>guint16</a>             <a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#ipatch-gig-volsust-to-sf2-centibels"
>ipatch_gig_volsust_to_sf2_centibels</a> (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> gig_tperc);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libinstpatch-IpatchGigEffects.description"></a><h2>Description</h2>
<p>
Functions and types for GigaSampler instrument parameters and effects.</p>
</div>
<div class="refsect1" title="Details">
<a name="libinstpatch-IpatchGigEffects.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchGigEffects">
<a name="IpatchGigEffects"></a><h3>IpatchGigEffects</h3>
<pre class="programlisting">typedef struct {
  guint32 unknown1;		/* byte 0-3, always 0x0000008C? */
  guint32 unknown7;		/* byte 44-47 */
  guint32 unknown14;		/* byte 100-103 */

  guint16 unknown2;		/* byte 12-13 */
  guint16 unknown3;		/* byte 16-17 */
  guint16 unknown4;		/* byte 20-21 */
  guint16 unknown5;		/* byte 24-25 */
  guint16 unknown6;		/* byte 36-37 */
  guint16 unknown8;		/* byte 60-61 */
  guint16 unknown9;		/* byte 68-69 */
  guint16 unknown10;		/* byte 76-77 */
  guint16 unknown11;		/* byte 84-85 */
  guint16 unknown13;		/* byte 98-99 */
  guint16 unknown15;		/* byte 106-107 */
  guint16 unknown17;		/* byte 116-117 */
  guint16 unknown18;		/* byte 122-123 */
  guint16 unknown20;		/* byte 126-127 */

  guint8 unknown12;		/* byte 93 */
  guint8 unknown16;		/* byte 111 */
  guint8 unknown19;		/* byte 125 */
  guint8 unknown21;		/* byte 129 */
  guint8 unknown22;		/* byte 130 */
  guint8 unknown23;		/* byte 135 */

  /* EG1 - Volume envelope */
  guint16 eg1_pre_attack;	/* 10th percent */
  guint16 eg1_sustain;		/* 10th percent */
  guint32 eg1_attack;		/* timecents */
  guint32 eg1_decay;		/* timecents */
  guint32 eg1_decay2;		/* timecents (where is the "inf" flag?) */
  guint32 eg1_release;		/* timecents */
  guint8 eg1_hold;		/* bit 8=1:true */

  /* EG2 - Filter envelope */
  guint16 eg2_pre_attack;	/* 10th percent */
  guint16 eg2_sustain;		/* 10th percent */
  guint32 eg2_attack;		/* timecents */
  guint32 eg2_decay;		/* timecents */
  guint32 eg2_decay2;		/* timecents */
  guint32 eg2_release;		/* timecents */

  /* EG3 - Pitch envelope */
  guint32 eg3_attack;		/* timecents */
  guint16 eg3_depth;		/* 12 bit signed (cents) */

  /* LFO1 - Volume LFO */
  guint16 lfo1_internal_depth;	/* 0-1200 */
  guint32 lfo1_freq;		/* pitch cents */
  guint16 lfo1_ctrl_depth;	/* 0-1200 */
  guint8 lfo1_ctrl;
  /* 0=internal, 1=mod wheel, 2=breath ctrl, 3=internal/mod wheel,
     4=internal/breath ctrl */
  /* bit 8=1:flip phase */
  /* bit 7=1:synch */
  /* bits 5 en 6: Res midictrl: 0=18, 1=19, 2=80, 3=81 */

  /* LFO2 - Filter LFO */
  guint8 lfo2_ctrl;
  /* 0=internal, 1=mod wheel, 2=breath ctrl, 3=internal/mod wheel,
     4=internal/breath ctrl */
  /* bit 6=1:synch */
  /* bit 8=1:flip phase */
  /* bit 7=1:Resonance midi ctrl */

  guint32 lfo2_freq;		/* pitch cents */
  guint16 lfo2_internal_depth;	/* 0-1200 */
  guint16 lfo2_ctrl_depth;	/* 0-1200 */

  /* LFO3 - Pitch LFO */
  guint32 lfo3_freq;		/* pitch cents */
  guint16 lfo3_internal_depth;	/* cents */
  guint16 lfo3_ctrl_depth;	/* cents */
  guint8 lfo3_ctrl; /* bit 6: LFO3 synch  bit 8:invert attentuation ctrl */


  /* filter parameters */
  guint8 filter_type; /* 0=lowpass, 1=bandpass, 2=highpass, 3=bandreject */
  guint8 turbo_lowpass; /* bit 7=0: on */
  guint8 filter_cutoff; /* bit 8=1:on */
  guint8 filter_midi_ctrl; /* bit 8=1:use ctrl  rest 0:aftertouch */
  guint8 filter_vel_scale;
  guint8 filter_resonance; /* bit 8=0:dynamic */
  guint8 filter_breakpoint; /* bit 8=1:keyboard tracking */

  /* velocity parameters */
  guint8 vel_response; /* 0-4 = nonlinear, 5-9 = linear, 10-14 = special */
  guint8 vel_dyn_range;

  /* release velocity paramaters */
  guint8 release_vel_response; /* 0-4 = nonlinear, 5-9 = linear, 10-14 = special */
  /* release velocity dynamic range? */

  guint8 release_trigger_decay;

  guint8 attn_ctrl;	      /* bit 1:on, rest=ctrl, 0xFF=velocity */
  guint8 max_velocity;		/* Used for velocity split */

  guint16 sample_offset;
  guint8 pitch_track_dim_bypass; /* bit 0=0: pitch track */
				/* 0x10/0x20=dim bypass ctrl 94/95 */
  guint8 layer_pan;		/* 7-bit signed */
  guint8 self_mask;		/* 1=true */
  guint8 channel_offset;	/* (*4) */
  guint8 sust_defeat;		/* 2=on */
} IpatchGigEffects;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchGigFilterType">
<a name="IpatchGigFilterType"></a><h3>enum IpatchGigFilterType</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_GIG_FILTER_LOWPASS = 0,
  IPATCH_GIG_FILTER_BANDPASS = 1,
  IPATCH_GIG_FILTER_HIGHPASS = 2,
  IPATCH_GIG_FILTER_BANDREJECT = 3
} IpatchGigFilterType;
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchGigControlType">
<a name="IpatchGigControlType"></a><h3>enum IpatchGigControlType</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_GIG_CTRL_MOD_WHEEL       = 0x01,
  IPATCH_GIG_CTRL_BREATH          = 0x02,
  IPATCH_GIG_CTRL_FOOT            = 0x04,
  IPATCH_GIG_CTRL_PORTAMENTO_TIME = 0x05,
  IPATCH_GIG_CTRL_EFFECT_1        = 0x0C,
  IPATCH_GIG_CTRL_EFFECT_2        = 0x0D,
  IPATCH_GIG_CTRL_GEN_PURPOSE_1   = 0x10,
  IPATCH_GIG_CTRL_GEN_PURPOSE_2   = 0x11,
  IPATCH_GIG_CTRL_GEN_PURPOSE_3   = 0x12,
  IPATCH_GIG_CTRL_GEN_PURPOSE_4   = 0x13,
  IPATCH_GIG_CTRL_SUSTAIN_PEDAL   = 0x40,
  IPATCH_GIG_CTRL_PORTAMENTO      = 0x41,
  IPATCH_GIG_CTRL_SOSTENUTO       = 0x42,
  IPATCH_GIG_CTRL_SOFT_PEDAL      = 0x43,
  IPATCH_GIG_CTRL_GEN_PURPOSE_5   = 0x50,
  IPATCH_GIG_CTRL_GEN_PURPOSE_6   = 0x51,
  IPATCH_GIG_CTRL_GEN_PURPOSE_7   = 0x52,
  IPATCH_GIG_CTRL_GEN_PURPOSE_8   = 0x53,
  IPATCH_GIG_CTRL_EFFECT_DEPTH_1  = 0x5B,
  IPATCH_GIG_CTRL_EFFECT_DEPTH_2  = 0x5C,
  IPATCH_GIG_CTRL_EFFECT_DEPTH_3  = 0x5D,
  IPATCH_GIG_CTRL_EFFECT_DEPTH_4  = 0x5E,
  IPATCH_GIG_CTRL_EFFECT_DEPTH_5  = 0x5F
} IpatchGigControlType;
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_gig_parse_effects ()">
<a name="ipatch-gig-parse-effects"></a><h3>ipatch_gig_parse_effects ()</h3>
<pre class="programlisting">void                ipatch_gig_parse_effects            (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#IpatchGigEffects"
>IpatchGigEffects</a> *effects);</pre>
<p>
Parse an 3ewa GigaSampler effects chunk into 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>handle</code></em> :</span></p></td>
<td> File handle containing buffered 3ewa data
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>effects</code></em> :</span></p></td>
<td> Pointer to a user supplied GigaSampler effects structure to fill
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_gig_store_effects ()">
<a name="ipatch-gig-store-effects"></a><h3>ipatch_gig_store_effects ()</h3>
<pre class="programlisting">void                ipatch_gig_store_effects            (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#IpatchGigEffects"
>IpatchGigEffects</a> *effects);</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_gig_effects_init ()">
<a name="ipatch-gig-effects-init"></a><h3>ipatch_gig_effects_init ()</h3>
<pre class="programlisting">void                ipatch_gig_effects_init             (<a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#IpatchGigEffects"
>IpatchGigEffects</a> *effects);</pre>
<p>
Initialize GigaSampler effects structure 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>effects</code></em> :</span></p></td>
<td> GigaSampler effects structure
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_gig_effects_to_gen_array ()">
<a name="ipatch-gig-effects-to-gen-array"></a><h3>ipatch_gig_effects_to_gen_array ()</h3>
<pre class="programlisting">void                ipatch_gig_effects_to_gen_array     (<a
href="../libinstpatch/libinstpatch-IpatchGigEffects.html#IpatchGigEffects"
>IpatchGigEffects</a> *effects,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSF2Gen.html#IpatchSF2GenArray"
>IpatchSF2GenArray</a> *array);</pre>
<p>
Convert GigaSampler effects structure to SoundFont 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>effects</code></em> :</span></p></td>
<td> GigaSampler effects structure
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
<td> SoundFont generator array
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_gig_to_sf2_timecents ()">
<a name="ipatch-gig-to-sf2-timecents"></a><h3>ipatch_gig_to_sf2_timecents ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"
>guint16</a>             ipatch_gig_to_sf2_timecents         (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a> gig_tc);</pre>
<p>
Convert GigaSampler timecents to SoundFont timecents.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gig_tc</code></em> :</span></p></td>
<td> Amount in GigaSampler timecents
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> SoundFont timecent value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_gig_volsust_to_sf2_centibels ()">
<a name="ipatch-gig-volsust-to-sf2-centibels"></a><h3>ipatch_gig_volsust_to_sf2_centibels ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"
>guint16</a>             ipatch_gig_volsust_to_sf2_centibels (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> gig_tperc);</pre>
<p>
Convert GigaSampler volume sustain (tenth percent units) to
centibels (10th of a decibel).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gig_tperc</code></em> :</span></p></td>
<td> Tenth percent sustain level
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> SoundFont centibels value
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>