git/src/ladspa.h

4    Copyright (C) 2000-2002 Richard W.E. Furse, Paul Barton-Davis,
19    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
53    Plugins are expected to distinguish between control and audio
55    control data and each plugin is `run' for a `block' corresponding
58    to be processed by the plugin in a single pass. Control data is
59    communicated using single LADSPA_Data values. Control data has a
60    single value at the start of a call to the `run()' or `run_adding()'
64    `connect_port()' function below) before it is asked to run.
72    This API contains very limited error-handling. */
77    is used to communicate audio samples and control values. It is
97    real-time dependency (e.g. listens to a MIDI device) and so its
105    hosts to use the plugin to process audio `in-place.' */
110    `hard real-time' environment. To qualify for this the plugin must
114    management within its run() or run_adding() functions. All new
115    memory used in run() must be managed via the stack. These
116    restrictions only apply to the run() function.
126    (4) The plugin will take an amount of time to execute a run() or
144    inputs/outputs) or single LADSPA_Data values (for control
150    and that a port must be a control or audio port but not both. */
160 /* Property LADSPA_PORT_CONTROL indicates that the port is a control
185    to run without failure and, where possible, produce a sensible
186    output (e.g. a high-pass filter given a negative cutoff frequency
187    might switch to an all-pass mode).
190    input control ports are expected to be particularly useful.
240    probably wish to provide a stepped control taking only integer
243    instance, the integer set {0,1,2,3} might be described as [-0.1,
250    interface or as a value the host might assign to a control port
371    buffers and workspaces and to run it. */
381   /* This identifier can be used as a unique, case-sensitive
385      versions. Labels must not contain white-space characters. */
391   /* This member points to the null-terminated name of the plugin
395   /* This member points to the null-terminated string indicating the
399   /* This member points to the null-terminated string indicating any
409      vary from 0 to PortCount-1. */
412   /* This member indicates an array of null-terminated strings
414      0 to PortCount-1. */
418      above). Valid indices vary from 0 to PortCount-1. */
444      LADSPA_Data value for control ports. Memory issues will be
446      locations every time run() or run_adding() is called and the data
456      run() or run_adding() is called. When working with blocks of
458      size passed to the run function as the block allocated may only
465      audio and control data may result in unexpected behaviour. */
472      instantiate() to aid real-time support and so that hosts can
481      When present, hosts must call this function once before run() (or
483      made as close to the run() call as possible and indicates to
484      real-time plugins that they are now live. Plugins should not rely
485      on a prompt call to run() after activate(). activate() may not be
493      handle to the particular instance to be run and the second
495      instance may run.
498      before run() or run_adding(). If deactivate() is called for a
504      within the run() or run_adding() functions (see above). */
505   void (*run)(LADSPA_Handle Instance,  member
509      plugin for a block. This has identical behaviour to run() except
510      in the way data is output from the plugin. When run() is used,
541      run() (or run_adding()) for the last time. This call should be
542      made as close to the last run() call as possible and indicates to
543      real-time plugins that they are no longer live. Plugins should
566 /* The exact mechanism by which plugins are loaded is host-dependent,
571    colon-separated path indicating directories that should be searched
576    the shared object file. This function will have C-style linkage (if