This file is indexed.

/usr/share/gtk-doc/html/libinstpatch/libinstpatch-sample.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>sample</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="ch03.html" title="Sample data objects and functions">
<link rel="prev" href="libinstpatch-IpatchSampleTransform.html" title="IpatchSampleTransform">
<link rel="next" href="libinstpatch-IpatchSampleList.html" title="IpatchSampleList">
<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-IpatchSampleTransform.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.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-IpatchSampleList.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-sample.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#libinstpatch-sample.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="sample">
<a name="libinstpatch-sample"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinstpatch-sample.top_of_page"></a>sample</span></h2>
<p>sample — Audio sample format conversion functions and defines.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="libinstpatch-sample.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libinstpatch-sample.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-MAX-TRANSFORM-FUNCS--CAPS"
>IPATCH_SAMPLE_MAX_TRANSFORM_FUNCS</a>
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-FORMAT-MASK--CAPS"
>IPATCH_SAMPLE_FORMAT_MASK</a>
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-FORMAT-BITCOUNT--CAPS"
>IPATCH_SAMPLE_FORMAT_BITCOUNT</a>
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-WIDTH-MASK--CAPS"
>IPATCH_SAMPLE_WIDTH_MASK</a>
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-CHANNEL-MASK--CAPS"
>IPATCH_SAMPLE_CHANNEL_MASK</a>
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-SIGN-MASK--CAPS"
>IPATCH_SAMPLE_SIGN_MASK</a>
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-ENDIAN-MASK--CAPS"
>IPATCH_SAMPLE_ENDIAN_MASK</a>
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-WIDTH-SHIFT--CAPS"
>IPATCH_SAMPLE_WIDTH_SHIFT</a>
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-CHANNEL-SHIFT--CAPS"
>IPATCH_SAMPLE_CHANNEL_SHIFT</a>
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-SIGN-SHIFT--CAPS"
>IPATCH_SAMPLE_SIGN_SHIFT</a>
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-ENDIAN-SHIFT--CAPS"
>IPATCH_SAMPLE_ENDIAN_SHIFT</a>
enum                <a
href="../libinstpatch/libinstpatch-sample.html#IpatchSampleWidth"
>IpatchSampleWidth</a>;
enum                <a
href="../libinstpatch/libinstpatch-sample.html#IpatchSampleChannel"
>IpatchSampleChannel</a>;
enum                <a
href="../libinstpatch/libinstpatch-sample.html#IpatchSampleChannelType"
>IpatchSampleChannelType</a>;
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-MAX-CHANNELS--CAPS"
>IPATCH_SAMPLE_MAX_CHANNELS</a>
enum                <a
href="../libinstpatch/libinstpatch-sample.html#IpatchSampleSign"
>IpatchSampleSign</a>;
enum                <a
href="../libinstpatch/libinstpatch-sample.html#IpatchSampleEndian"
>IpatchSampleEndian</a>;
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-ENDIAN-HOST--CAPS"
>IPATCH_SAMPLE_ENDIAN_HOST</a>
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-FORMAT-GET-WIDTH--CAPS"
>IPATCH_SAMPLE_FORMAT_GET_WIDTH</a>      (format)
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-FORMAT-GET-CHANNELS--CAPS"
>IPATCH_SAMPLE_FORMAT_GET_CHANNELS</a>   (format)
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-FORMAT-GET-CHANNEL-COUNT--CAPS"
>IPATCH_SAMPLE_FORMAT_GET_CHANNEL_COUNT</a>(format)
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-FORMAT-IS-SIGNED--CAPS"
>IPATCH_SAMPLE_FORMAT_IS_SIGNED</a>      (format)
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-FORMAT-IS-UNSIGNED--CAPS"
>IPATCH_SAMPLE_FORMAT_IS_UNSIGNED</a>    (format)
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-FORMAT-IS-LENDIAN--CAPS"
>IPATCH_SAMPLE_FORMAT_IS_LENDIAN</a>     (format)
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-FORMAT-IS-BENDIAN--CAPS"
>IPATCH_SAMPLE_FORMAT_IS_BENDIAN</a>     (format)
#define             <a
href="../libinstpatch/libinstpatch-sample.html#ipatch-sample-format-size"
>ipatch_sample_format_size</a>           (format)
#define             <a
href="../libinstpatch/libinstpatch-sample.html#ipatch-sample-format-width"
>ipatch_sample_format_width</a>          (format)
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-MAP-CHANNEL--CAPS"
>IPATCH_SAMPLE_MAP_CHANNEL</a>           (dest, src)
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-MAP-GET-CHANNEL--CAPS"
>IPATCH_SAMPLE_MAP_GET_CHANNEL</a>       (map, dest)
#define             <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-UNITY-CHANNEL-MAP--CAPS"
>IPATCH_SAMPLE_UNITY_CHANNEL_MAP</a>
int                 <a
href="../libinstpatch/libinstpatch-sample.html#ipatch-sample-format-bit-width"
>ipatch_sample_format_bit_width</a>      (int format);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a
href="../libinstpatch/libinstpatch-sample.html#ipatch-sample-format-verify"
>ipatch_sample_format_verify</a>         (int format);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a
href="../libinstpatch/libinstpatch-sample.html#ipatch-sample-format-transform-verify"
>ipatch_sample_format_transform_verify</a>
                                                        (int src_format,
                                                         int dest_format,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
>guint32</a> channel_map);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a>               <a
href="../libinstpatch/libinstpatch-sample.html#ipatch-sample-get-transform-funcs"
>ipatch_sample_get_transform_funcs</a>   (int src_format,
                                                         int dest_format,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
>guint32</a> channel_map,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> *buf1_max_frame,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> *buf2_max_frame,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSampleTransform.html#IpatchSampleTransformFunc"
>IpatchSampleTransformFunc</a> *funcs);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libinstpatch-sample.description"></a><h2>Description</h2>
<p>
This module provides functions for converting audio formats as well as a system
for defining audio formats with a single integer composed of multiple fields
for sample width, channel count, sign and endian byte order.</p>
</div>
<div class="refsect1" title="Details">
<a name="libinstpatch-sample.details"></a><h2>Details</h2>
<div class="refsect2" title="IPATCH_SAMPLE_MAX_TRANSFORM_FUNCS">
<a name="IPATCH-SAMPLE-MAX-TRANSFORM-FUNCS--CAPS"></a><h3>IPATCH_SAMPLE_MAX_TRANSFORM_FUNCS</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_MAX_TRANSFORM_FUNCS	16
</pre>
<p>
Maximum number of transform functions returned by
<a
href="../libinstpatch/libinstpatch-sample.html#ipatch-sample-get-transform-funcs"
><code class="function">ipatch_sample_get_transform_funcs()</code></a>.  Is larger than current actual maximum
to allow for future backwards compatible expansion (8 is the real current
maximum).</p>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_FORMAT_MASK">
<a name="IPATCH-SAMPLE-FORMAT-MASK--CAPS"></a><h3>IPATCH_SAMPLE_FORMAT_MASK</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_FORMAT_MASK   0x1FF
</pre>
<p>
Mask for all fields of sample format integers (width, sign, endian, channel).</p>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_FORMAT_BITCOUNT">
<a name="IPATCH-SAMPLE-FORMAT-BITCOUNT--CAPS"></a><h3>IPATCH_SAMPLE_FORMAT_BITCOUNT</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_FORMAT_BITCOUNT  9
</pre>
<p>
Number of bits used for sample format integers.</p>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_WIDTH_MASK">
<a name="IPATCH-SAMPLE-WIDTH-MASK--CAPS"></a><h3>IPATCH_SAMPLE_WIDTH_MASK</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_WIDTH_MASK    0x00F  /* total of 16 formats (8 reserved) */
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_CHANNEL_MASK">
<a name="IPATCH-SAMPLE-CHANNEL-MASK--CAPS"></a><h3>IPATCH_SAMPLE_CHANNEL_MASK</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_CHANNEL_MASK  0x070  /* channel count (8 channels max) */
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_SIGN_MASK">
<a name="IPATCH-SAMPLE-SIGN-MASK--CAPS"></a><h3>IPATCH_SAMPLE_SIGN_MASK</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_SIGN_MASK     0x080  /* sign or unsigned (for PCM formats) */
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_ENDIAN_MASK">
<a name="IPATCH-SAMPLE-ENDIAN-MASK--CAPS"></a><h3>IPATCH_SAMPLE_ENDIAN_MASK</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_ENDIAN_MASK   0x100  /* endian byte order */
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_WIDTH_SHIFT">
<a name="IPATCH-SAMPLE-WIDTH-SHIFT--CAPS"></a><h3>IPATCH_SAMPLE_WIDTH_SHIFT</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_WIDTH_SHIFT   0
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_CHANNEL_SHIFT">
<a name="IPATCH-SAMPLE-CHANNEL-SHIFT--CAPS"></a><h3>IPATCH_SAMPLE_CHANNEL_SHIFT</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_CHANNEL_SHIFT 4
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_SIGN_SHIFT">
<a name="IPATCH-SAMPLE-SIGN-SHIFT--CAPS"></a><h3>IPATCH_SAMPLE_SIGN_SHIFT</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_SIGN_SHIFT    7
</pre>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_ENDIAN_SHIFT">
<a name="IPATCH-SAMPLE-ENDIAN-SHIFT--CAPS"></a><h3>IPATCH_SAMPLE_ENDIAN_SHIFT</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_ENDIAN_SHIFT  8
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchSampleWidth">
<a name="IpatchSampleWidth"></a><h3>enum IpatchSampleWidth</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_SAMPLE_INVALID = 0,
  IPATCH_SAMPLE_8BIT  = 1,
  IPATCH_SAMPLE_16BIT = 2,
  IPATCH_SAMPLE_24BIT = 3,
  IPATCH_SAMPLE_32BIT = 4,
  IPATCH_SAMPLE_FLOAT = 5,
  IPATCH_SAMPLE_DOUBLE = 6,
  IPATCH_SAMPLE_REAL24BIT = 7
} IpatchSampleWidth;
</pre>
<p>
Sample data widths/formats.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="IPATCH-SAMPLE-INVALID--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_INVALID</code></span></p></td>
<td> Invalid format (so 0 can be used to indicate a NULL state)
</td>
</tr>
<tr>
<td><p><a name="IPATCH-SAMPLE-8BIT--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_8BIT</code></span></p></td>
<td> 8 bit integer PCM
</td>
</tr>
<tr>
<td><p><a name="IPATCH-SAMPLE-16BIT--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_16BIT</code></span></p></td>
<td> 16 bit integer PCM
</td>
</tr>
<tr>
<td><p><a name="IPATCH-SAMPLE-24BIT--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_24BIT</code></span></p></td>
<td> 24 bit integer PCM (32 bit ints)
</td>
</tr>
<tr>
<td><p><a name="IPATCH-SAMPLE-32BIT--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_32BIT</code></span></p></td>
<td> 32 bit integer PCM
</td>
</tr>
<tr>
<td><p><a name="IPATCH-SAMPLE-FLOAT--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_FLOAT</code></span></p></td>
<td> 32 bit IEEE float (-1.0 - 1.0)
</td>
</tr>
<tr>
<td><p><a name="IPATCH-SAMPLE-DOUBLE--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_DOUBLE</code></span></p></td>
<td> 64 bit IEEE double (-1.0 - 1.0)
</td>
</tr>
<tr>
<td><p><a name="IPATCH-SAMPLE-REAL24BIT--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_REAL24BIT</code></span></p></td>
<td> Real 3 byte 24 bit data (not padded to 32 bits)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum IpatchSampleChannel">
<a name="IpatchSampleChannel"></a><h3>enum IpatchSampleChannel</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_SAMPLE_MONO    = 0 &lt;&lt; IPATCH_SAMPLE_CHANNEL_SHIFT,
  IPATCH_SAMPLE_STEREO  = 1 &lt;&lt; IPATCH_SAMPLE_CHANNEL_SHIFT
} IpatchSampleChannel;
</pre>
<p>
Descriptive enums for common audio channel configurations.  These values
are actually channel count - 1 (0 = mono, 1 = stereo, etc) and can be compared
with the macro <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-FORMAT-GET-CHANNELS--CAPS"
><code class="function">IPATCH_SAMPLE_FORMAT_GET_CHANNELS()</code></a>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="IPATCH-SAMPLE-MONO--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_MONO</code></span></p></td>
<td> Mono audio
</td>
</tr>
<tr>
<td><p><a name="IPATCH-SAMPLE-STEREO--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_STEREO</code></span></p></td>
<td> Stereo audio
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum IpatchSampleChannelType">
<a name="IpatchSampleChannelType"></a><h3>enum IpatchSampleChannelType</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_SAMPLE_LEFT =  0,
  IPATCH_SAMPLE_RIGHT = 1
} IpatchSampleChannelType;
</pre>
<p>
Channel designation.  Currently there are only 2 designated channels,
though the remaining 6 supported channels may be defined to be surround
sound channels in the future.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="IPATCH-SAMPLE-LEFT--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_LEFT</code></span></p></td>
<td> Left channel comes first
</td>
</tr>
<tr>
<td><p><a name="IPATCH-SAMPLE-RIGHT--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_RIGHT</code></span></p></td>
<td> Right channel comes second
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_MAX_CHANNELS">
<a name="IPATCH-SAMPLE-MAX-CHANNELS--CAPS"></a><h3>IPATCH_SAMPLE_MAX_CHANNELS</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_MAX_CHANNELS      8
</pre>
<p>
Maximum number of audio channels handled by libInstPatch.</p>
</div>
<hr>
<div class="refsect2" title="enum IpatchSampleSign">
<a name="IpatchSampleSign"></a><h3>enum IpatchSampleSign</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_SAMPLE_SIGNED   = 0 &lt;&lt; IPATCH_SAMPLE_SIGN_SHIFT,
  IPATCH_SAMPLE_UNSIGNED = 1 &lt;&lt; IPATCH_SAMPLE_SIGN_SHIFT
} IpatchSampleSign;
</pre>
<p>
Defines the sign of PCM integer audio data.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="IPATCH-SAMPLE-SIGNED--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_SIGNED</code></span></p></td>
<td> Signed PCM audio data.
</td>
</tr>
<tr>
<td><p><a name="IPATCH-SAMPLE-UNSIGNED--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_UNSIGNED</code></span></p></td>
<td> Unsigned PCM audio data.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum IpatchSampleEndian">
<a name="IpatchSampleEndian"></a><h3>enum IpatchSampleEndian</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_SAMPLE_LENDIAN = 0 &lt;&lt; IPATCH_SAMPLE_ENDIAN_SHIFT,
  IPATCH_SAMPLE_BENDIAN = 1 &lt;&lt; IPATCH_SAMPLE_ENDIAN_SHIFT
} IpatchSampleEndian;
</pre>
<p>
Defines the byte order of multi-byte audio data.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="IPATCH-SAMPLE-LENDIAN--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_LENDIAN</code></span></p></td>
<td> Little endian byte order
</td>
</tr>
<tr>
<td><p><a name="IPATCH-SAMPLE-BENDIAN--CAPS"></a><span class="term"><code class="literal">IPATCH_SAMPLE_BENDIAN</code></span></p></td>
<td> Big endian byte order
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_ENDIAN_HOST">
<a name="IPATCH-SAMPLE-ENDIAN-HOST--CAPS"></a><h3>IPATCH_SAMPLE_ENDIAN_HOST</h3>
<pre class="programlisting">#define             IPATCH_SAMPLE_ENDIAN_HOST</pre>
<p>
Host byte order value (<span class="type">IPATCH_SAMPLE_LENDIAN</span> or <span class="type">IPATCH_SAMPLE_BENDIAN</span>).</p>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_FORMAT_GET_WIDTH()">
<a name="IPATCH-SAMPLE-FORMAT-GET-WIDTH--CAPS"></a><h3>IPATCH_SAMPLE_FORMAT_GET_WIDTH()</h3>
<pre class="programlisting">#define             IPATCH_SAMPLE_FORMAT_GET_WIDTH(format)</pre>
<p>
Get <a
href="../libinstpatch/libinstpatch-sample.html#IpatchSampleWidth"
><span class="type">IpatchSampleWidth</span></a> enum from a sample format integer.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> Sample format integer
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Format field of sample format integer.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_FORMAT_GET_CHANNELS()">
<a name="IPATCH-SAMPLE-FORMAT-GET-CHANNELS--CAPS"></a><h3>IPATCH_SAMPLE_FORMAT_GET_CHANNELS()</h3>
<pre class="programlisting">#define             IPATCH_SAMPLE_FORMAT_GET_CHANNELS(format)</pre>
<p>
Get the channel field from a sample format integer.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> Sample format integer
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Channel field value (see <a
href="../libinstpatch/libinstpatch-sample.html#IpatchSampleChannel"
><span class="type">IpatchSampleChannel</span></a>)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_FORMAT_GET_CHANNEL_COUNT()">
<a name="IPATCH-SAMPLE-FORMAT-GET-CHANNEL-COUNT--CAPS"></a><h3>IPATCH_SAMPLE_FORMAT_GET_CHANNEL_COUNT()</h3>
<pre class="programlisting">#define             IPATCH_SAMPLE_FORMAT_GET_CHANNEL_COUNT(format)</pre>
<p>
Get the channel count from a sample format integer.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> Sample format integer
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Channel count (starting at 1 for mono).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_FORMAT_IS_SIGNED()">
<a name="IPATCH-SAMPLE-FORMAT-IS-SIGNED--CAPS"></a><h3>IPATCH_SAMPLE_FORMAT_IS_SIGNED()</h3>
<pre class="programlisting">#define             IPATCH_SAMPLE_FORMAT_IS_SIGNED(format)</pre>
<p>
Check if a sample format integer defines signed audio.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> Sample format integer
</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 sample format is signed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_FORMAT_IS_UNSIGNED()">
<a name="IPATCH-SAMPLE-FORMAT-IS-UNSIGNED--CAPS"></a><h3>IPATCH_SAMPLE_FORMAT_IS_UNSIGNED()</h3>
<pre class="programlisting">#define             IPATCH_SAMPLE_FORMAT_IS_UNSIGNED(format)</pre>
<p>
Check if a sample format integer defines unsigned audio.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> Sample format integer
</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 sample format is unsigned.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_FORMAT_IS_LENDIAN()">
<a name="IPATCH-SAMPLE-FORMAT-IS-LENDIAN--CAPS"></a><h3>IPATCH_SAMPLE_FORMAT_IS_LENDIAN()</h3>
<pre class="programlisting">#define             IPATCH_SAMPLE_FORMAT_IS_LENDIAN(format)</pre>
<p>
Check if a sample format integer defines little endian audio.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> Sample format integer
</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 sample format is little endian.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_FORMAT_IS_BENDIAN()">
<a name="IPATCH-SAMPLE-FORMAT-IS-BENDIAN--CAPS"></a><h3>IPATCH_SAMPLE_FORMAT_IS_BENDIAN()</h3>
<pre class="programlisting">#define             IPATCH_SAMPLE_FORMAT_IS_BENDIAN(format)</pre>
<p>
Check if a sample format integer defines big endian audio.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> Sample format integer
</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 sample format is big endian.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_format_size()">
<a name="ipatch-sample-format-size"></a><h3>ipatch_sample_format_size()</h3>
<pre class="programlisting">#define             ipatch_sample_format_size(format)</pre>
<p>
Get frame byte size for a given sample format (sample byte size * channels).</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> Sample format integer
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Size in bytes of a single sample frame.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_format_width()">
<a name="ipatch-sample-format-width"></a><h3>ipatch_sample_format_width()</h3>
<pre class="programlisting">#define             ipatch_sample_format_width(format)</pre>
<p>
Gets the number of bytes used for storing a single sample for <em class="parameter"><code>format</code></em>.
Doesn't take into account channels.  This is the number of bytes used
to store the samples, not the effective bit width.  For example:
<span class="type">IPATCH_SAMPLE_24BIT</span> uses 4 bytes for each sample.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> Sample format
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Byte width of a single sample (not including channels).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_MAP_CHANNEL()">
<a name="IPATCH-SAMPLE-MAP-CHANNEL--CAPS"></a><h3>IPATCH_SAMPLE_MAP_CHANNEL()</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_MAP_CHANNEL(dest, src)   ((src) &lt;&lt; (3 * (dest)))
</pre>
<p>
Macro to calculate a channel mapping value for a given destination and
source.  A channel mapping is composed of up to 24 bits
(3 bits * 8 channels = 24).  Channel mappings are used for sample
conversions to route channels from a source format to a destination format.
Multiple channel map values should be OR'd together.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
<td> Destination channel in mapping bit field (0-7)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
<td> Source channel (0-7)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_MAP_GET_CHANNEL()">
<a name="IPATCH-SAMPLE-MAP-GET-CHANNEL--CAPS"></a><h3>IPATCH_SAMPLE_MAP_GET_CHANNEL()</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_MAP_GET_CHANNEL(map, dest)   (((map) &gt;&gt; ((dest) * 3)) &amp; 0x07)
</pre>
<p>
Macro to get a source channel value given a destination channel.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>map</code></em> :</span></p></td>
<td> Channel map value (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
><span class="type">guint32</span></a> - only 24 bits are used)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
<td> Destination channel in <em class="parameter"><code>map</code></em> bit field (0-7)
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Source channel for <em class="parameter"><code>dest</code></em> (0-7)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="IPATCH_SAMPLE_UNITY_CHANNEL_MAP">
<a name="IPATCH-SAMPLE-UNITY-CHANNEL-MAP--CAPS"></a><h3>IPATCH_SAMPLE_UNITY_CHANNEL_MAP</h3>
<pre class="programlisting">#define IPATCH_SAMPLE_UNITY_CHANNEL_MAP   0xFAC688
</pre>
<p>
Unity channel mapping which routes each input channel to the same output
channel.</p>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_format_bit_width ()">
<a name="ipatch-sample-format-bit-width"></a><h3>ipatch_sample_format_bit_width ()</h3>
<pre class="programlisting">int                 ipatch_sample_format_bit_width      (int format);</pre>
<p>
Like <a
href="../libinstpatch/libinstpatch-sample.html#ipatch-sample-format-width"
><code class="function">ipatch_sample_format_width()</code></a> but gets the effective bit width of the
format.  Of note is this is not always equivelant to the format width * 8.
For example: <span class="type">IPATCH_SAMPLE_FLOAT</span> has an effective bit width of 23,
<span class="type">IPATCH_SAMPLE_24BIT</span> has an effective bit width of 24 but is stored in 32
bits.  This function is really only useful for comparing the relative
"quality" of formats, and the actual returned values may change in the
future.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> Sample format
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Effective bit width of format.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_format_verify ()">
<a name="ipatch-sample-format-verify"></a><h3>ipatch_sample_format_verify ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            ipatch_sample_format_verify         (int format);</pre>
<p>
Verify a sample format integer.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td> Sample format (<a
href="../libinstpatch/libinstpatch-sample.html#IpatchSampleWidth"
><span class="type">IpatchSampleWidth</span></a> | <a
href="../libinstpatch/libinstpatch-sample.html#IpatchSampleSign"
><span class="type">IpatchSampleSign</span></a>
  | <a
href="../libinstpatch/libinstpatch-sample.html#IpatchSampleEndian"
><span class="type">IpatchSampleEndian</span></a> | <a
href="../libinstpatch/libinstpatch-sample.html#IpatchSampleChannel"
><span class="type">IpatchSampleChannel</span></a>).
</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_sample_format_transform_verify ()">
<a name="ipatch-sample-format-transform-verify"></a><h3>ipatch_sample_format_transform_verify ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            ipatch_sample_format_transform_verify
                                                        (int src_format,
                                                         int dest_format,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
>guint32</a> channel_map);</pre>
<p>
Verify source and destination sample formats and channel map for a sample
transform operation.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>src_format</code></em> :</span></p></td>
<td> Source sample format
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_format</code></em> :</span></p></td>
<td> Destination sample format
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>channel_map</code></em> :</span></p></td>
<td> Channel mapping (use <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-UNITY-CHANNEL-MAP--CAPS"
><span class="type">IPATCH_SAMPLE_UNITY_CHANNEL_MAP</span></a>
  to map all input channels to the same output channels, see
  <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-MAP-CHANNEL--CAPS"
><span class="type">IPATCH_SAMPLE_MAP_CHANNEL</span></a> macro for constructing channel map 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> on success, <code class="literal">FALSE</code> otherwise
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_sample_get_transform_funcs ()">
<a name="ipatch-sample-get-transform-funcs"></a><h3>ipatch_sample_get_transform_funcs ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a>               ipatch_sample_get_transform_funcs   (int src_format,
                                                         int dest_format,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
>guint32</a> channel_map,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> *buf1_max_frame,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"
>guint</a> *buf2_max_frame,
                                                         <a
href="../libinstpatch/libinstpatch-IpatchSampleTransform.html#IpatchSampleTransformFunc"
>IpatchSampleTransformFunc</a> *funcs);</pre>
<p>
Get transform function array for converting from <em class="parameter"><code>src_format</code></em> to
<em class="parameter"><code>dest_format</code></em>.
</p>
<p>
<em class="parameter"><code>func_count</code></em>: Count of function pointers stored to <em class="parameter"><code>funcs</code></em>.  Can be 0 if no
  transform is required.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>src_format</code></em> :</span></p></td>
<td> Source audio format to convert from
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest_format</code></em> :</span></p></td>
<td> Destination audio format to convert to
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>channel_map</code></em> :</span></p></td>
<td> Channel mapping (use <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-UNITY-CHANNEL-MAP--CAPS"
><span class="type">IPATCH_SAMPLE_UNITY_CHANNEL_MAP</span></a>
  to map all input channels to the same output channels, 3 bits times
  <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-MAX-CHANNELS--CAPS"
><span class="type">IPATCH_SAMPLE_MAX_CHANNELS</span></a> (8) = 24 bits total, see
  <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-MAP-CHANNEL--CAPS"
><span class="type">IPATCH_SAMPLE_MAP_CHANNEL</span></a> macro for constructing channel map values)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buf1_max_frame</code></em> :</span></p></td>
<td> Output - maximum sample frame size for first buffer
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buf2_max_frame</code></em> :</span></p></td>
<td> Output - maximum sample frame size for second buffer
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>funcs</code></em> :</span></p></td>
<td> Caller provided array to store transform functions to.  It should
  have at least <a
href="../libinstpatch/libinstpatch-sample.html#IPATCH-SAMPLE-MAX-TRANSFORM-FUNCS--CAPS"
><span class="type">IPATCH_SAMPLE_MAX_TRANSFORM_FUNCS</span></a> elements.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>