dssiinit

dssiinit — Loads a DSSI or LADSPA plugin.

Syntax

ihandle dssiinit ilibraryname, iplugindex [, iverbose] 

Description

dssiinit is used to load a DSSI or LADSPA plugin into memory for use with the other dssi4cs opcodes. Both LADSPA effects and DSSI instruments can be used.

Initialization

ihandle - the number which identifies the plugin, to be passed to other dssi4cs opcodes.

ilibraryname - the name of the .so (shared object) file to load.

iplugindex - The index of the plugin to be used.

iverbose (optional) - show plugin information and parameters when loading. (default = 1)

dssiinit looks for ilibraryname on LADSPA_PATH and DSSI_PATH. One of these variables must be set, otherwise dssiinit will return an error. LADSPA and DSSI libraries may contain more than one plugin which must be referenced by its index. dssiinit then attempts to find plugin index iplugindex in the library and load the plugin into memory if it is found. To find out which plugins you have available and their index numbers you can use: dssilist

If iverbose is not 0 (the default), information about the plugin detailing its characteristics and its ports will be shown. This information is important for opcodes like dssictls.

Plugins are set to inactive by default, so you *must* use dssiactivate to get the plugin to produce sound. This is required even if the plugin doesn't provide an active() function.

dssiinit may cause audio stream breakups when used in realtime, so it is recommended to load all plugins to be used before playing.

Examples

Here is an example of the dssinit opcode. It uses the files vmult.csd.

Example 1. Example of the dssiinit opcode. (Remember to change the Library name)

<xi>:include href="examples/dssi4cs.csd" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude"/></xi>
        

Credits

2005

By: Andres Cabrera

Uses code from Richard Furse's LADSPA sdk.