libinstpatch-doc 1.0.0-4 / usr / share / gtk-doc / html / libinstpatch / libinstpatch-IpatchUnit-DLS.html

This file is indexed.

/usr/share/gtk-doc/html/libinstpatch/libinstpatch-IpatchUnit-DLS.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchUnit_DLS</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="ch04.html" title="DLS patches">
<link rel="prev" href="IpatchDLS2Sample.html" title="IpatchDLS2Sample">
<link rel="next" href="ch05.html" title="SoundFont patches">
<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="IpatchDLS2Sample.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.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="ch05.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-IpatchUnit-DLS.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#libinstpatch-IpatchUnit-DLS.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="IpatchUnit_DLS">
<a name="libinstpatch-IpatchUnit-DLS"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinstpatch-IpatchUnit-DLS.top_of_page"></a>IpatchUnit_DLS</span></h2>
<p>IpatchUnit_DLS — Unit types and conversions for DLS</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="libinstpatch-IpatchUnit-DLS.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libinstpatch-IpatchUnit-DLS.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#define             <a
href="../libinstpatch/libinstpatch-IpatchUnit-DLS.html#IPATCH-UNIT-DLS-ABS-TIME-0SECS--CAPS"
>IPATCH_UNIT_DLS_ABS_TIME_0SECS</a>
int                 <a
href="../libinstpatch/libinstpatch-IpatchUnit-DLS.html#ipatch-unit-dls-class-convert"
>ipatch_unit_dls_class_convert</a>       (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"
>guint16</a> src_units,
                                                         const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *src_val);
double              <a
href="../libinstpatch/libinstpatch-IpatchUnit-DLS.html#ipatch-unit-dls-percent-to-percent"
>ipatch_unit_dls_percent_to_percent</a>  (int dls_percent);
int                 <a
href="../libinstpatch/libinstpatch-IpatchUnit-DLS.html#ipatch-unit-percent-to-dls-percent"
>ipatch_unit_percent_to_dls_percent</a>  (double percent);
double              <a
href="../libinstpatch/libinstpatch-IpatchUnit-DLS.html#ipatch-unit-dls-gain-to-decibels"
>ipatch_unit_dls_gain_to_decibels</a>    (int dls_gain);
int                 <a
href="../libinstpatch/libinstpatch-IpatchUnit-DLS.html#ipatch-unit-decibels-to-dls-gain"
>ipatch_unit_decibels_to_dls_gain</a>    (double db);
double              <a
href="../libinstpatch/libinstpatch-IpatchUnit-DLS.html#ipatch-unit-dls-abs-time-to-seconds"
>ipatch_unit_dls_abs_time_to_seconds</a> (int dls_abs_time);
int                 <a
href="../libinstpatch/libinstpatch-IpatchUnit-DLS.html#ipatch-unit-seconds-to-dls-abs-time"
>ipatch_unit_seconds_to_dls_abs_time</a> (double seconds);
double              <a
href="../libinstpatch/libinstpatch-IpatchUnit-DLS.html#ipatch-unit-dls-rel-time-to-time-cents"
>ipatch_unit_dls_rel_time_to_time_cents</a>
                                                        (int dls_rel_time);
int                 <a
href="../libinstpatch/libinstpatch-IpatchUnit-DLS.html#ipatch-unit-time-cents-to-dls-rel-time"
>ipatch_unit_time_cents_to_dls_rel_time</a>
                                                        (double time_cents);
double              <a
href="../libinstpatch/libinstpatch-IpatchUnit-DLS.html#ipatch-unit-dls-abs-pitch-to-hertz"
>ipatch_unit_dls_abs_pitch_to_hertz</a>  (int dls_abs_pitch);
int                 <a
href="../libinstpatch/libinstpatch-IpatchUnit-DLS.html#ipatch-unit-hertz-to-dls-abs-pitch"
>ipatch_unit_hertz_to_dls_abs_pitch</a>  (double hertz);
double              <a
href="../libinstpatch/libinstpatch-IpatchUnit-DLS.html#ipatch-unit-dls-rel-pitch-to-cents"
>ipatch_unit_dls_rel_pitch_to_cents</a>  (int dls_rel_pitch);
int                 <a
href="../libinstpatch/libinstpatch-IpatchUnit-DLS.html#ipatch-unit-cents-to-dls-rel-pitch"
>ipatch_unit_cents_to_dls_rel_pitch</a>  (double cents);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libinstpatch-IpatchUnit-DLS.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="libinstpatch-IpatchUnit-DLS.details"></a><h2>Details</h2>
<div class="refsect2" title="IPATCH_UNIT_DLS_ABS_TIME_0SECS">
<a name="IPATCH-UNIT-DLS-ABS-TIME-0SECS--CAPS"></a><h3>IPATCH_UNIT_DLS_ABS_TIME_0SECS</h3>
<pre class="programlisting">#define IPATCH_UNIT_DLS_ABS_TIME_0SECS 0x80000000L
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_unit_dls_class_convert ()">
<a name="ipatch-unit-dls-class-convert"></a><h3>ipatch_unit_dls_class_convert ()</h3>
<pre class="programlisting">int                 ipatch_unit_dls_class_convert       (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint16"
>guint16</a> src_units,
                                                         const <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-Generic-values.html#GValue"
>GValue</a> *src_val);</pre>
<p>
Converts a value to "DLS" units.  DLS units are unit types that
are used by DLS (Downloadable Sounds) patches.  The <span class="type">IPATCH_UNIT_CLASS_DLS</span>
map is used to lookup the corresponding type to convert to.
Only some types have an associated DLS type.  It is an error to pass a
<em class="parameter"><code>src_units</code></em> type that has no DLS mapping (note that this is contrary to the
behavior of <a
href="../libinstpatch/libinstpatch-IpatchUnit.html#ipatch-unit-user-class-convert"
><code class="function">ipatch_unit_user_class_convert()</code></a>).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>src_units</code></em> :</span></p></td>
<td> Source unit type ID
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>src_val</code></em> :</span></p></td>
<td> Source value (type should be compatible with the source unit's
  value type)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The value converted to DLS units.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_unit_dls_percent_to_percent ()">
<a name="ipatch-unit-dls-percent-to-percent"></a><h3>ipatch_unit_dls_percent_to_percent ()</h3>
<pre class="programlisting">double              ipatch_unit_dls_percent_to_percent  (int dls_percent);</pre>
<p>
Convert value in DLS percent units to percent.
</p>
<p>
percent = dls_percent / (10 * 65536)</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dls_percent</code></em> :</span></p></td>
<td> Value in DLS percent units
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Value in percent
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_unit_percent_to_dls_percent ()">
<a name="ipatch-unit-percent-to-dls-percent"></a><h3>ipatch_unit_percent_to_dls_percent ()</h3>
<pre class="programlisting">int                 ipatch_unit_percent_to_dls_percent  (double percent);</pre>
<p>
Convert percent to DLS percent.
</p>
<p>
dls_percent = percent * 10 * 65536</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>percent</code></em> :</span></p></td>
<td> Value in percent
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Converted integer in DLS percent
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_unit_dls_gain_to_decibels ()">
<a name="ipatch-unit-dls-gain-to-decibels"></a><h3>ipatch_unit_dls_gain_to_decibels ()</h3>
<pre class="programlisting">double              ipatch_unit_dls_gain_to_decibels    (int dls_gain);</pre>
<p>
Converts a value from DLS gain to decibels.
</p>
<p>
dls_gain = 200 * 65536 * log10 (V / v)
decibels = 20 * log10 (V / v)</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dls_gain</code></em> :</span></p></td>
<td> Value in DLS gain units
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Value converted to decibels
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_unit_decibels_to_dls_gain ()">
<a name="ipatch-unit-decibels-to-dls-gain"></a><h3>ipatch_unit_decibels_to_dls_gain ()</h3>
<pre class="programlisting">int                 ipatch_unit_decibels_to_dls_gain    (double db);</pre>
<p>
Converts a value from decibels to DLS gain.
See <code class="function">ipatch_unit_dls_gain_to_decibel()</code></p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>db</code></em> :</span></p></td>
<td> Value in decibels
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Value converted to DLS gain
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_unit_dls_abs_time_to_seconds ()">
<a name="ipatch-unit-dls-abs-time-to-seconds"></a><h3>ipatch_unit_dls_abs_time_to_seconds ()</h3>
<pre class="programlisting">double              ipatch_unit_dls_abs_time_to_seconds (int dls_abs_time);</pre>
<p>
Converts a value from DLS absolute time to seconds.
seconds = 2^(dls_abs_time / (1200 * 65536))
</p>
<p>
0x80000000 is used as a 0 value.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dls_abs_time</code></em> :</span></p></td>
<td> Value in DLS absolute time
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Value converted to seconds
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_unit_seconds_to_dls_abs_time ()">
<a name="ipatch-unit-seconds-to-dls-abs-time"></a><h3>ipatch_unit_seconds_to_dls_abs_time ()</h3>
<pre class="programlisting">int                 ipatch_unit_seconds_to_dls_abs_time (double seconds);</pre>
<p>
Converts a value from seconds to DLS absolute time.
dls_rel_time = 1200 * log2 (seconds) * 65536</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>seconds</code></em> :</span></p></td>
<td> Value in seconds
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Value converted to DLS relative time
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_unit_dls_rel_time_to_time_cents ()">
<a name="ipatch-unit-dls-rel-time-to-time-cents"></a><h3>ipatch_unit_dls_rel_time_to_time_cents ()</h3>
<pre class="programlisting">double              ipatch_unit_dls_rel_time_to_time_cents
                                                        (int dls_rel_time);</pre>
<p>
Converts a value from DLS relative time to time cents.
time_cents = dls_rel_time / 65536</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dls_rel_time</code></em> :</span></p></td>
<td> Value in DLS relative time
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Value converted to time cents
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_unit_time_cents_to_dls_rel_time ()">
<a name="ipatch-unit-time-cents-to-dls-rel-time"></a><h3>ipatch_unit_time_cents_to_dls_rel_time ()</h3>
<pre class="programlisting">int                 ipatch_unit_time_cents_to_dls_rel_time
                                                        (double time_cents);</pre>
<p>
Converts a value from time_cents to DLS relative time.
dls_rel_time = time_cents * 65536</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>time_cents</code></em> :</span></p></td>
<td> Value in time cents
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Value converted to DLS relative time
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_unit_dls_abs_pitch_to_hertz ()">
<a name="ipatch-unit-dls-abs-pitch-to-hertz"></a><h3>ipatch_unit_dls_abs_pitch_to_hertz ()</h3>
<pre class="programlisting">double              ipatch_unit_dls_abs_pitch_to_hertz  (int dls_abs_pitch);</pre>
<p>
Converts a value from DLS absolute pitch to hertz.
hertz = 440 * 2^((dls_abs_pitch / 65536 - 6900) / 1200)</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dls_abs_pitch</code></em> :</span></p></td>
<td> Value in DLS absolute pitch
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Value converted to hertz
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_unit_hertz_to_dls_abs_pitch ()">
<a name="ipatch-unit-hertz-to-dls-abs-pitch"></a><h3>ipatch_unit_hertz_to_dls_abs_pitch ()</h3>
<pre class="programlisting">int                 ipatch_unit_hertz_to_dls_abs_pitch  (double hertz);</pre>
<p>
Converts a value from hertz to DLS absolute pitch.
dls_abs_pitch = (1200 * log2(hertz/440) + 6900) * 65536</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hertz</code></em> :</span></p></td>
<td> Value in hertz
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Value converted to DLS absolute pitch
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_unit_dls_rel_pitch_to_cents ()">
<a name="ipatch-unit-dls-rel-pitch-to-cents"></a><h3>ipatch_unit_dls_rel_pitch_to_cents ()</h3>
<pre class="programlisting">double              ipatch_unit_dls_rel_pitch_to_cents  (int dls_rel_pitch);</pre>
<p>
Converts a value from DLS relative pitch to cents.
cents = dls_rel_pitch / 65536</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dls_rel_pitch</code></em> :</span></p></td>
<td> Value in DLS relative pitch
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Value converted to cents
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_unit_cents_to_dls_rel_pitch ()">
<a name="ipatch-unit-cents-to-dls-rel-pitch"></a><h3>ipatch_unit_cents_to_dls_rel_pitch ()</h3>
<pre class="programlisting">int                 ipatch_unit_cents_to_dls_rel_pitch  (double cents);</pre>
<p>
Converts a value from cents to DLS relative pitch.
dls_rel_pitch = cents * 65536</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cents</code></em> :</span></p></td>
<td> Value in cents
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Value converted to DLS relative pitch
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.