-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathgroup__ladspa.html
More file actions
742 lines (694 loc) · 37.8 KB
/
group__ladspa.html
File metadata and controls
742 lines (694 loc) · 37.8 KB
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libfluidsynth: Effect - LADSPA</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libfluidsynth
 <span id="projectnumber">2.5.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__ladspa.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Effect - LADSPA<div class="ingroups"><a class="el" href="group__synth.html">Synthesizer</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Functions for configuring the LADSPA effects unit.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga921dcbb6c18611ec06a8884fcf30aca8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#ga921dcbb6c18611ec06a8884fcf30aca8">fluid_ladspa_activate</a> (<a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> *fx)</td></tr>
<tr class="memdesc:ga921dcbb6c18611ec06a8884fcf30aca8"><td class="mdescLeft"> </td><td class="mdescRight">Activate the LADSPA fx instance and each configured effect. <a href="group__ladspa.html#ga921dcbb6c18611ec06a8884fcf30aca8">More...</a><br /></td></tr>
<tr class="separator:ga921dcbb6c18611ec06a8884fcf30aca8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad875791f751b3672e68ae7fdc9109ab7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#gad875791f751b3672e68ae7fdc9109ab7">fluid_ladspa_add_buffer</a> (<a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> *fx, const char *name)</td></tr>
<tr class="memdesc:gad875791f751b3672e68ae7fdc9109ab7"><td class="mdescLeft"> </td><td class="mdescRight">Create and add a new audio buffer. <a href="group__ladspa.html#gad875791f751b3672e68ae7fdc9109ab7">More...</a><br /></td></tr>
<tr class="separator:gad875791f751b3672e68ae7fdc9109ab7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6efd531e35bdd0296ba57c1d26666e30"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#ga6efd531e35bdd0296ba57c1d26666e30">fluid_ladspa_add_effect</a> (<a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> *fx, const char *effect_name, const char *lib_name, const char *plugin_name)</td></tr>
<tr class="memdesc:ga6efd531e35bdd0296ba57c1d26666e30"><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of a LADSPA plugin as an effect. <a href="group__ladspa.html#ga6efd531e35bdd0296ba57c1d26666e30">More...</a><br /></td></tr>
<tr class="separator:ga6efd531e35bdd0296ba57c1d26666e30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga81ae8f1ff61793984ae4c8b15f39a9ea"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#ga81ae8f1ff61793984ae4c8b15f39a9ea">fluid_ladspa_buffer_exists</a> (<a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> *fx, const char *name)</td></tr>
<tr class="memdesc:ga81ae8f1ff61793984ae4c8b15f39a9ea"><td class="mdescLeft"> </td><td class="mdescRight">Check if a named user buffer exists. <a href="group__ladspa.html#ga81ae8f1ff61793984ae4c8b15f39a9ea">More...</a><br /></td></tr>
<tr class="separator:ga81ae8f1ff61793984ae4c8b15f39a9ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf12a0559b21d55137bd0f7124c045f61"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#gaf12a0559b21d55137bd0f7124c045f61">fluid_ladspa_check</a> (<a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> *fx, char *err, int err_size)</td></tr>
<tr class="memdesc:gaf12a0559b21d55137bd0f7124c045f61"><td class="mdescLeft"> </td><td class="mdescRight">Do a sanity check for problems in the LADSPA setup. <a href="group__ladspa.html#gaf12a0559b21d55137bd0f7124c045f61">More...</a><br /></td></tr>
<tr class="separator:gaf12a0559b21d55137bd0f7124c045f61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7997cd13ebbc492a333a4daae917d0a3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#ga7997cd13ebbc492a333a4daae917d0a3">fluid_ladspa_deactivate</a> (<a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> *fx)</td></tr>
<tr class="memdesc:ga7997cd13ebbc492a333a4daae917d0a3"><td class="mdescLeft"> </td><td class="mdescRight">Deactivate a LADSPA fx instance and all configured effects. <a href="group__ladspa.html#ga7997cd13ebbc492a333a4daae917d0a3">More...</a><br /></td></tr>
<tr class="separator:ga7997cd13ebbc492a333a4daae917d0a3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7a254bb526ab09afd080d00df7aeb98f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#ga7a254bb526ab09afd080d00df7aeb98f">fluid_ladspa_effect_can_mix</a> (<a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> *fx, const char *name)</td></tr>
<tr class="memdesc:ga7a254bb526ab09afd080d00df7aeb98f"><td class="mdescLeft"> </td><td class="mdescRight">Check if the effect plugin supports the run_adding and set_run_adding_gain interfaces necessary for output mixing. <a href="group__ladspa.html#ga7a254bb526ab09afd080d00df7aeb98f">More...</a><br /></td></tr>
<tr class="separator:ga7a254bb526ab09afd080d00df7aeb98f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2d9c7577e1988a605b1e6880b240d2c7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#ga2d9c7577e1988a605b1e6880b240d2c7">fluid_ladspa_effect_link</a> (<a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> *fx, const char *effect_name, const char *port_name, const char *name)</td></tr>
<tr class="memdesc:ga2d9c7577e1988a605b1e6880b240d2c7"><td class="mdescLeft"> </td><td class="mdescRight">Connect an effect audio port to a host port or buffer. <a href="group__ladspa.html#ga2d9c7577e1988a605b1e6880b240d2c7">More...</a><br /></td></tr>
<tr class="separator:ga2d9c7577e1988a605b1e6880b240d2c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa1a41c4d36af0ba8cd726bca198887ee"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#gaa1a41c4d36af0ba8cd726bca198887ee">fluid_ladspa_effect_port_exists</a> (<a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> *fx, const char *effect_name, const char *port_name)</td></tr>
<tr class="memdesc:gaa1a41c4d36af0ba8cd726bca198887ee"><td class="mdescLeft"> </td><td class="mdescRight">Check if the named port exists on an effect. <a href="group__ladspa.html#gaa1a41c4d36af0ba8cd726bca198887ee">More...</a><br /></td></tr>
<tr class="separator:gaa1a41c4d36af0ba8cd726bca198887ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8030cdc642ad1091272000607fc810ca"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#ga8030cdc642ad1091272000607fc810ca">fluid_ladspa_effect_set_control</a> (<a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> *fx, const char *effect_name, const char *port_name, float val)</td></tr>
<tr class="memdesc:ga8030cdc642ad1091272000607fc810ca"><td class="mdescLeft"> </td><td class="mdescRight">Set the value of an effect control port. <a href="group__ladspa.html#ga8030cdc642ad1091272000607fc810ca">More...</a><br /></td></tr>
<tr class="separator:ga8030cdc642ad1091272000607fc810ca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga714b15e7e44663504cc6eff1e66e4ece"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#ga714b15e7e44663504cc6eff1e66e4ece">fluid_ladspa_effect_set_mix</a> (<a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> *fx, const char *name, int mix, float gain)</td></tr>
<tr class="memdesc:ga714b15e7e44663504cc6eff1e66e4ece"><td class="mdescLeft"> </td><td class="mdescRight">Set if the effect should replace everything in the output buffers (mix = 0, default) or add to the buffers with a fixed gain (mix = 1). <a href="group__ladspa.html#ga714b15e7e44663504cc6eff1e66e4ece">More...</a><br /></td></tr>
<tr class="separator:ga714b15e7e44663504cc6eff1e66e4ece"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaac18688f7cadd875730c1829d4851efd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#gaac18688f7cadd875730c1829d4851efd">fluid_ladspa_host_port_exists</a> (<a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> *fx, const char *name)</td></tr>
<tr class="memdesc:gaac18688f7cadd875730c1829d4851efd"><td class="mdescLeft"> </td><td class="mdescRight">Check if a named host port exists. <a href="group__ladspa.html#gaac18688f7cadd875730c1829d4851efd">More...</a><br /></td></tr>
<tr class="separator:gaac18688f7cadd875730c1829d4851efd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9ebc605f00a796a13c4759691a6bb90a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#ga9ebc605f00a796a13c4759691a6bb90a">fluid_ladspa_is_active</a> (<a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> *fx)</td></tr>
<tr class="memdesc:ga9ebc605f00a796a13c4759691a6bb90a"><td class="mdescLeft"> </td><td class="mdescRight">Check if the LADSPA engine is currently used to render audio. <a href="group__ladspa.html#ga9ebc605f00a796a13c4759691a6bb90a">More...</a><br /></td></tr>
<tr class="separator:ga9ebc605f00a796a13c4759691a6bb90a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gac8e612ed5fb7b09f00f061cc04fcba4c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#gac8e612ed5fb7b09f00f061cc04fcba4c">fluid_ladspa_reset</a> (<a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> *fx)</td></tr>
<tr class="memdesc:gac8e612ed5fb7b09f00f061cc04fcba4c"><td class="mdescLeft"> </td><td class="mdescRight">Reset the LADSPA effects engine. <a href="group__ladspa.html#gac8e612ed5fb7b09f00f061cc04fcba4c">More...</a><br /></td></tr>
<tr class="separator:gac8e612ed5fb7b09f00f061cc04fcba4c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1d6efb392f3f8e9a84e37a2536c2de48"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__ladspa.html#ga1d6efb392f3f8e9a84e37a2536c2de48">fluid_synth_get_ladspa_fx</a> (<a class="el" href="group__Types.html#gae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a> *synth)</td></tr>
<tr class="memdesc:ga1d6efb392f3f8e9a84e37a2536c2de48"><td class="mdescLeft"> </td><td class="mdescRight">Return the LADSPA effects instance used by FluidSynth. <a href="group__ladspa.html#ga1d6efb392f3f8e9a84e37a2536c2de48">More...</a><br /></td></tr>
<tr class="separator:ga1d6efb392f3f8e9a84e37a2536c2de48"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions for configuring the LADSPA effects unit. </p>
<p>This header defines useful functions for programmatically manipulating the ladspa effects unit of the synth that can be retrieved via <a class="el" href="group__ladspa.html#ga1d6efb392f3f8e9a84e37a2536c2de48" title="Return the LADSPA effects instance used by FluidSynth.">fluid_synth_get_ladspa_fx()</a>.</p>
<p>Using any of those functions requires fluidsynth to be compiled with LADSPA support. Else all of those functions are useless dummies. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga921dcbb6c18611ec06a8884fcf30aca8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga921dcbb6c18611ec06a8884fcf30aca8">◆ </a></span>fluid_ladspa_activate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_ladspa_activate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td>
<td class="paramname"><em>fx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Activate the LADSPA fx instance and each configured effect. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fx</td><td>LADSPA fx instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FLUID_OK if activation succeeded or already active, otherwise FLUID_FAILED </dd></dl>
</div>
</div>
<a id="gad875791f751b3672e68ae7fdc9109ab7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad875791f751b3672e68ae7fdc9109ab7">◆ </a></span>fluid_ladspa_add_buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_ladspa_add_buffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td>
<td class="paramname"><em>fx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create and add a new audio buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fx</td><td>LADSPA effects instance </td></tr>
<tr><td class="paramname">name</td><td>name of the new buffer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FLUID_OK on success, FLUID_FAILED on error </dd></dl>
</div>
</div>
<a id="ga6efd531e35bdd0296ba57c1d26666e30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6efd531e35bdd0296ba57c1d26666e30">◆ </a></span>fluid_ladspa_add_effect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_ladspa_add_effect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td>
<td class="paramname"><em>fx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>effect_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>lib_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>plugin_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create an instance of a LADSPA plugin as an effect. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fx</td><td>LADSPA effects instance </td></tr>
<tr><td class="paramname">effect_name</td><td>name of the effect </td></tr>
<tr><td class="paramname">lib_name</td><td>filename of ladspa plugin library </td></tr>
<tr><td class="paramname">plugin_name</td><td>optional, plugin name if there is more than one plugin in the library </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FLUID_OK on success, otherwise FLUID_FAILED </dd></dl>
</div>
</div>
<a id="ga81ae8f1ff61793984ae4c8b15f39a9ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga81ae8f1ff61793984ae4c8b15f39a9ea">◆ </a></span>fluid_ladspa_buffer_exists()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_ladspa_buffer_exists </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td>
<td class="paramname"><em>fx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a named user buffer exists. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fx</td><td>LADSPA fx instance </td></tr>
<tr><td class="paramname">name</td><td>the buffer name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if the buffer exists, otherwise FALSE </dd></dl>
</div>
</div>
<a id="gaf12a0559b21d55137bd0f7124c045f61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf12a0559b21d55137bd0f7124c045f61">◆ </a></span>fluid_ladspa_check()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_ladspa_check </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td>
<td class="paramname"><em>fx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>err</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>err_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Do a sanity check for problems in the LADSPA setup. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fx</td><td>LADSPA fx instance </td></tr>
<tr><td class="paramname">err</td><td>externally provided buffer for the error message. Set to NULL if you don't need an error message. </td></tr>
<tr><td class="paramname">err_size</td><td>size of the err buffer </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FLUID_OK if setup is valid, otherwise FLUID_FAILED (err will contain the error message)</dd></dl>
<p>If the check detects problems and the err pointer is not NULL, a description of the first found problem is written to that string (up to err_size - 1 characters). </p>
</div>
</div>
<a id="ga7997cd13ebbc492a333a4daae917d0a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7997cd13ebbc492a333a4daae917d0a3">◆ </a></span>fluid_ladspa_deactivate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_ladspa_deactivate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td>
<td class="paramname"><em>fx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deactivate a LADSPA fx instance and all configured effects. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fx</td><td>LADSPA fx instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FLUID_OK if deactivation succeeded, otherwise FLUID_FAILED</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function may sleep. </dd></dl>
</div>
</div>
<a id="ga7a254bb526ab09afd080d00df7aeb98f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7a254bb526ab09afd080d00df7aeb98f">◆ </a></span>fluid_ladspa_effect_can_mix()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_ladspa_effect_can_mix </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td>
<td class="paramname"><em>fx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the effect plugin supports the run_adding and set_run_adding_gain interfaces necessary for output mixing. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fx</td><td>LADSPA fx </td></tr>
<tr><td class="paramname">name</td><td>the name of the effect </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if mix mode is supported, otherwise FALSE </dd></dl>
</div>
</div>
<a id="ga2d9c7577e1988a605b1e6880b240d2c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2d9c7577e1988a605b1e6880b240d2c7">◆ </a></span>fluid_ladspa_effect_link()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_ladspa_effect_link </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td>
<td class="paramname"><em>fx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>effect_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>port_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Connect an effect audio port to a host port or buffer. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fx</td><td>LADSPA effects instance </td></tr>
<tr><td class="paramname">effect_name</td><td>name of the effect </td></tr>
<tr><td class="paramname">port_name</td><td>the audio port name to connect to (case-insensitive prefix match) </td></tr>
<tr><td class="paramname">name</td><td>the host port or buffer to connect to (case-insensitive) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FLUID_OK on success, otherwise FLUID_FAILED</dd></dl>
<dl class="section note"><dt>Note</dt><dd>There is no corresponding disconnect function. If the connections need to be changed, clear everything with fluid_ladspa_reset and start again from scratch. </dd></dl>
</div>
</div>
<a id="gaa1a41c4d36af0ba8cd726bca198887ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa1a41c4d36af0ba8cd726bca198887ee">◆ </a></span>fluid_ladspa_effect_port_exists()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_ladspa_effect_port_exists </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td>
<td class="paramname"><em>fx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>effect_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>port_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the named port exists on an effect. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fx</td><td>LADSPA fx instance </td></tr>
<tr><td class="paramname">effect_name</td><td>name of the effect </td></tr>
<tr><td class="paramname">port_name</td><td>the port name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if port was found, otherwise FALSE </dd></dl>
</div>
</div>
<a id="ga8030cdc642ad1091272000607fc810ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8030cdc642ad1091272000607fc810ca">◆ </a></span>fluid_ladspa_effect_set_control()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_ladspa_effect_set_control </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td>
<td class="paramname"><em>fx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>effect_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>port_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the value of an effect control port. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fx</td><td>LADSPA fx instance </td></tr>
<tr><td class="paramname">effect_name</td><td>name of the effect </td></tr>
<tr><td class="paramname">port_name</td><td>name of the port </td></tr>
<tr><td class="paramname">val</td><td>floating point value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FLUID_OK on success, FLUID_FAILED on error </dd></dl>
</div>
</div>
<a id="ga714b15e7e44663504cc6eff1e66e4ece"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga714b15e7e44663504cc6eff1e66e4ece">◆ </a></span>fluid_ladspa_effect_set_mix()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_ladspa_effect_set_mix </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td>
<td class="paramname"><em>fx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>mix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>gain</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set if the effect should replace everything in the output buffers (mix = 0, default) or add to the buffers with a fixed gain (mix = 1). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fx</td><td>LADSPA fx instance </td></tr>
<tr><td class="paramname">name</td><td>the name of the effect </td></tr>
<tr><td class="paramname">mix</td><td>(boolean) if to enable mix mode </td></tr>
<tr><td class="paramname">gain</td><td>the gain to apply to the effect output before adding to output. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FLUID_OK on success, otherwise FLUID_FAILED </dd></dl>
</div>
</div>
<a id="gaac18688f7cadd875730c1829d4851efd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaac18688f7cadd875730c1829d4851efd">◆ </a></span>fluid_ladspa_host_port_exists()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_ladspa_host_port_exists </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td>
<td class="paramname"><em>fx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a named host port exists. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fx</td><td>LADSPA fx instance </td></tr>
<tr><td class="paramname">name</td><td>the port name </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if the host port exists, otherwise FALSE </dd></dl>
</div>
</div>
<a id="ga9ebc605f00a796a13c4759691a6bb90a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9ebc605f00a796a13c4759691a6bb90a">◆ </a></span>fluid_ladspa_is_active()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_ladspa_is_active </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td>
<td class="paramname"><em>fx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if the LADSPA engine is currently used to render audio. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fx</td><td>LADSPA fx instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if LADSPA effects engine is active, otherwise FALSE</dd></dl>
<p>If an engine is active, the only allowed user actions are deactivation or setting values of control ports on effects. Anything else, especially adding or removing effects, buffers or ports, is only allowed in deactivated state. </p>
</div>
</div>
<a id="gac8e612ed5fb7b09f00f061cc04fcba4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac8e612ed5fb7b09f00f061cc04fcba4c">◆ </a></span>fluid_ladspa_reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fluid_ladspa_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a> * </td>
<td class="paramname"><em>fx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the LADSPA effects engine. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fx</td><td>LADSPA fx instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>FLUID_OK on success, otherwise FLUID_FAILED</dd></dl>
<p>Deactivate LADSPA if currently active, remove all effects, remove all user nodes and unload all libraries. </p>
</div>
</div>
<a id="ga1d6efb392f3f8e9a84e37a2536c2de48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1d6efb392f3f8e9a84e37a2536c2de48">◆ </a></span>fluid_synth_get_ladspa_fx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Types.html#ga4cb127fbe32ac21781d5252c75661191">fluid_ladspa_fx_t</a>* fluid_synth_get_ladspa_fx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__Types.html#gae265f10ae174a13afe010de50d87e1a4">fluid_synth_t</a> * </td>
<td class="paramname"><em>synth</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the LADSPA effects instance used by FluidSynth. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">synth</td><td>FluidSynth instance </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to LADSPA fx or NULL if compiled without LADSPA support or LADSPA is not active </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
</body>
</html>