Skip to content

dssiinit

Loads an instance of a LADSPA or DSSI plugin.

These opcodes require the optional dssi4cs module on Linux. See DSSI and LADSPA plugins for build requirements and setup.

Syntax

ihandle = dssiinit(Slibrary, iplugindex [, iverbose])

ihandle dssiinit Slibrary, iplugindex [, iverbose]

Initialization

Slibrary names the plugin's shared library, usually a .so file. An absolute path selects the file directly. For a library name, the loader searches LADSPA_PATH, then DSSI_PATH. If LADSPA_PATH is unset, it uses /usr/lib/ladspa/, or /usr/lib64/ladspa/ in a build with LIB64 defined. It also tries adding .so when needed and falls back to the system library loader.

iplugindex is the plugin's zero-based index within the library. It is required. A library may contain several plugins. Use a valid index from the plugin's documentation or dssilist. The index is different from the plugin's UniqueID.

iverbose defaults to 1. A nonzero value prints plugin details and numbered ports. Zero reduces this output but does not silence every message.

ihandle identifies the new instance. Pass it unchanged to the other DSSI opcodes. Each call creates a separate instance, even when the library and index match.

The instance starts inactive, with control values set to zero. Set the required controls with dssictls, then activate it with dssiactivate before processing audio. Plugin default-value hints do not set the initial controls.

Load plugins before real-time playback to avoid delays while opening libraries and allocating buffers. Use the same ksmps when loading and processing an instance.

The plugin must provide a LADSPA run function. DSSI plugins that only provide synth callbacks cannot run through this interface.

Examples

This example loads the LADSPA SDK mono amplifier from amp.so at index 0 and prints its ports. Install the plugin and adjust its absolute path as described in the setup guide. It does not process audio.

dssiinit example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
<CsoundSynthesizer>
<CsOptions>
-n -d
</CsOptions>
<CsInstruments>
sr = 48000
ksmps = 32
nchnls = 2
0dbfs = 1

giHandle = dssiinit("/usr/lib/ladspa/amp.so", 0, 1)

instr 1
  // Loading the instance prints its ports. It remains inactive.
endin
</CsInstruments>
<CsScore>
i 1 0 1
e
</CsScore>
</CsoundSynthesizer>

See also

dssiinit, dssiactivate, dssictls, dssiaudio, dssilist, DSSI and LADSPA plugins

Credits

Author Andres Cabrera, 2005. Uses code from Richard Furse's LADSPA SDK.