TAP-plugins
Tom's Audio Processing plugins
for audio engineering on the Linux platform

[ Home ] [ LADSPA plugins ] [ TAP Reverb Editor ]

[ Releases ] [ CVS ] [ General Info ] [ Plugin Manuals ]

> [ TAP AutoPanner ] [ TAP Chorus/Flanger ] [ TAP DeEsser ] [ TAP Dynamics (Mono & Stereo) ] [ TAP Equalizer and TAP Equalizer/BW ] [ TAP Fractal Doubler ] [ TAP Pink/Fractal Noise ] [ TAP Pitch Shifter ] [ TAP Reflector ] [ TAP Reverberator ] [ TAP Rotary Speaker ] [ TAP Scaling Limiter ] [ TAP Sigmoid Booster ] [ TAP Stereo Echo ] [ TAP Tremolo ] [ TAP TubeWarmth ] [ TAP Vibrato ]

# LADSPA Plugin Manuals

This section contains detailed information, benchmarks and usage tips for each available LADSPA plugin. It is intended to serve as a reference manual for the TAP-plugins package.

If you are new to TAP-plugins, please read through the plugin manuals to gain some basic understanding of these plugins. Some plugin settings can be rather tricky and you may not achieve the desired effect easily if you have not at least skimmed through the manuals, or you are not an experienced audio engineer. You have been warned.

For every plugin, some general information is provided in a table. The Unique ID is an identification number that each and every LADSPA plugin must uniquely have. See the LADSPA homepage for details. I/O ports describes the number of input and output audio ports. A plugin is mono if it has 1 input and 1 output, and it is stereo if it has 2 inputs and 2 outputs. The CPU usage measures were explained in a previous section.

A plugin qualifies as hard RT capable (suitable for use in hard realtime environments) if it satisfies all of the following:

- it does not use `malloc()`, `free()` or other heap management within its buffer processing functions;
- does not call any library functions (except for functions in the ANSI standard C and C math libraries);
- does not access files, devices, pipes, sockets, IPC or any other mechanism that might result in process or thread blocking;
- the time needed to process a buffer can be approximated in the form (A+B*SampleCount) where A and B depend on the machine and host in use -- the time may not depend on input signals and plugin state.

A plugin is capable of in-place operation if it does not get confused when it is asked to use the same memory buffer for both input and output sample data. Finally, the run_adding() function is an optional buffer processing function described in the LADSPA specification. When provided, this may make life of some hosts easier.

$Id: manuals.html,v 1.3 2004/08/17 13:05:16 tszilagyi Exp $