prymula/com: DPF-Prymula-audioplugins/dpf/distrho/src/ladspa/ladspa.h annotate

annotate DPF-Prymula-audioplugins/dpf/distrho/src/ladspa/ladspa.h @ 3:84e66ea83026

DPF-Prymula-audioplugins-0.231015-2

author	prymula <prymula76@outlook.com>
date	Mon, 16 Oct 2023 21:53:34 +0200
parents
children

rev	line source
3 84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1 /* ladspa.h
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	2
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	3 Linux Audio Developer's Simple Plugin API Version 1.1[LGPL].
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	4 Copyright (C) 2000-2002 Richard W.E. Furse, Paul Barton-Davis,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	5 Stefan Westerfeld.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	6
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	7 This library is free software; you can redistribute it and/or
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	8 modify it under the terms of the GNU Lesser General Public License
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	9 as published by the Free Software Foundation; either version 2.1 of
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	10 the License, or (at your option) any later version.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	11
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	12 This library is distributed in the hope that it will be useful, but
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	13 WITHOUT ANY WARRANTY; without even the implied warranty of
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	15 Lesser General Public License for more details.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	16
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	17 You should have received a copy of the GNU Lesser General Public
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	18 License along with this library; if not, write to the Free Software
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	20 USA. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	21
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	22 #ifndef LADSPA_INCLUDED
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	23 #define LADSPA_INCLUDED
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	24
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	25 #define LADSPA_VERSION "1.1"
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	26 #define LADSPA_VERSION_MAJOR 1
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	27 #define LADSPA_VERSION_MINOR 1
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	28
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	29 #ifdef __cplusplus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	30 extern "C" {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	31 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	32
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	33 #ifndef LADSPA_PLUGIN_EXPORT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	34 # ifdef _WIN32
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	35 # define LADSPA_PLUGIN_EXPORT __declspec(dllexport)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	36 # else
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	37 # define LADSPA_PLUGIN_EXPORT __attribute__((visibility("default")))
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	38 # endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	39 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	40
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	41 /*****************************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	42
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	43 /* Overview:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	44
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	45 There is a large number of synthesis packages in use or development
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	46 on the Linux platform at this time. This API (`The Linux Audio
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	47 Developer's Simple Plugin API') attempts to give programmers the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	48 ability to write simple `plugin' audio processors in C/C++ and link
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	49 them dynamically (`plug') into a range of these packages (`hosts').
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	50 It should be possible for any host and any plugin to communicate
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	51 completely through this interface.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	52
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	53 This API is deliberately short and simple. To achieve compatibility
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	54 with a range of promising Linux sound synthesis packages it
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	55 attempts to find the `greatest common divisor' in their logical
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	56 behaviour. Having said this, certain limiting decisions are
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	57 implicit, notably the use of a fixed type (LADSPA_Data) for all
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	58 data transfer and absence of a parameterised `initialisation'
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	59 phase. See below for the LADSPA_Data typedef.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	60
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	61 Plugins are expected to distinguish between control and audio
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	62 data. Plugins have `ports' that are inputs or outputs for audio or
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	63 control data and each plugin is `run' for a `block' corresponding
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	64 to a short time interval measured in samples. Audio data is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	65 communicated using arrays of LADSPA_Data, allowing a block of audio
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	66 to be processed by the plugin in a single pass. Control data is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	67 communicated using single LADSPA_Data values. Control data has a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	68 single value at the start of a call to the `run()' or `run_adding()'
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	69 function, and may be considered to remain this value for its
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	70 duration. The plugin may assume that all its input and output ports
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	71 have been connected to the relevant data location (see the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	72 `connect_port()' function below) before it is asked to run.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	73
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	74 Plugins will reside in shared object files suitable for dynamic
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	75 linking by dlopen() and family. The file will provide a number of
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	76 `plugin types' that can be used to instantiate actual plugins
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	77 (sometimes known as `plugin instances') that can be connected
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	78 together to perform tasks.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	79
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	80 This API contains very limited error-handling. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	81
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	82 /*****************************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	83
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	84 /* Fundamental data type passed in and out of plugin. This data type
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	85 is used to communicate audio samples and control values. It is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	86 assumed that the plugin will work sensibly given any numeric input
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	87 value although it may have a preferred range (see hints below).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	88
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	89 For audio it is generally assumed that 1.0f is the `0dB' reference
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	90 amplitude and is a `normal' signal level. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	91
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	92 typedef float LADSPA_Data;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	93
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	94 /*****************************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	95
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	96 /* Special Plugin Properties:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	97
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	98 Optional features of the plugin type are encapsulated in the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	99 LADSPA_Properties type. This is assembled by ORing individual
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	100 properties together. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	101
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	102 typedef int LADSPA_Properties;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	103
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	104 /* Property LADSPA_PROPERTY_REALTIME indicates that the plugin has a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	105 real-time dependency (e.g. listens to a MIDI device) and so its
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	106 output must not be cached or subject to significant latency. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	107 #define LADSPA_PROPERTY_REALTIME 0x1
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	108
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	109 /* Property LADSPA_PROPERTY_INPLACE_BROKEN indicates that the plugin
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	110 may cease to work correctly if the host elects to use the same data
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	111 location for both input and output (see connect_port()). This
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	112 should be avoided as enabling this flag makes it impossible for
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	113 hosts to use the plugin to process audio `in-place.' */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	114 #define LADSPA_PROPERTY_INPLACE_BROKEN 0x2
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	115
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	116 /* Property LADSPA_PROPERTY_HARD_RT_CAPABLE indicates that the plugin
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	117 is capable of running not only in a conventional host but also in a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	118 `hard real-time' environment. To qualify for this the plugin must
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	119 satisfy all of the following:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	120
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	121 (1) The plugin must not use malloc(), free() or other heap memory
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	122 management within its run() or run_adding() functions. All new
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	123 memory used in run() must be managed via the stack. These
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	124 restrictions only apply to the run() function.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	125
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	126 (2) The plugin will not attempt to make use of any library
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	127 functions with the exceptions of functions in the ANSI standard C
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	128 and C maths libraries, which the host is expected to provide.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	129
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	130 (3) The plugin will not access files, devices, pipes, sockets, IPC
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	131 or any other mechanism that might result in process or thread
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	132 blocking.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	133
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	134 (4) The plugin will take an amount of time to execute a run() or
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	135 run_adding() call approximately of form (A+B*SampleCount) where A
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	136 and B depend on the machine and host in use. This amount of time
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	137 may not depend on input signals or plugin state. The host is left
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	138 the responsibility to perform timings to estimate upper bounds for
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	139 A and B. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	140 #define LADSPA_PROPERTY_HARD_RT_CAPABLE 0x4
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	141
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	142 #define LADSPA_IS_REALTIME(x) ((x) & LADSPA_PROPERTY_REALTIME)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	143 #define LADSPA_IS_INPLACE_BROKEN(x) ((x) & LADSPA_PROPERTY_INPLACE_BROKEN)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	144 #define LADSPA_IS_HARD_RT_CAPABLE(x) ((x) & LADSPA_PROPERTY_HARD_RT_CAPABLE)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	145
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	146 /*****************************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	147
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	148 /* Plugin Ports:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	149
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	150 Plugins have `ports' that are inputs or outputs for audio or
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	151 data. Ports can communicate arrays of LADSPA_Data (for audio
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	152 inputs/outputs) or single LADSPA_Data values (for control
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	153 input/outputs). This information is encapsulated in the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	154 LADSPA_PortDescriptor type which is assembled by ORing individual
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	155 properties together.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	156
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	157 Note that a port must be an input or an output port but not both
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	158 and that a port must be a control or audio port but not both. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	159
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	160 typedef int LADSPA_PortDescriptor;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	161
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	162 /* Property LADSPA_PORT_INPUT indicates that the port is an input. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	163 #define LADSPA_PORT_INPUT 0x1
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	164
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	165 /* Property LADSPA_PORT_OUTPUT indicates that the port is an output. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	166 #define LADSPA_PORT_OUTPUT 0x2
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	167
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	168 /* Property LADSPA_PORT_CONTROL indicates that the port is a control
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	169 port. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	170 #define LADSPA_PORT_CONTROL 0x4
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	171
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	172 /* Property LADSPA_PORT_AUDIO indicates that the port is a audio
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	173 port. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	174 #define LADSPA_PORT_AUDIO 0x8
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	175
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	176 #define LADSPA_IS_PORT_INPUT(x) ((x) & LADSPA_PORT_INPUT)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	177 #define LADSPA_IS_PORT_OUTPUT(x) ((x) & LADSPA_PORT_OUTPUT)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	178 #define LADSPA_IS_PORT_CONTROL(x) ((x) & LADSPA_PORT_CONTROL)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	179 #define LADSPA_IS_PORT_AUDIO(x) ((x) & LADSPA_PORT_AUDIO)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	180
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	181 /*****************************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	182
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	183 /* Plugin Port Range Hints:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	184
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	185 The host may wish to provide a representation of data entering or
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	186 leaving a plugin (e.g. to generate a GUI automatically). To make
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	187 this more meaningful, the plugin should provide `hints' to the host
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	188 describing the usual values taken by the data.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	189
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	190 Note that these are only hints. The host may ignore them and the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	191 plugin must not assume that data supplied to it is meaningful. If
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	192 the plugin receives invalid input data it is expected to continue
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	193 to run without failure and, where possible, produce a sensible
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	194 output (e.g. a high-pass filter given a negative cutoff frequency
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	195 might switch to an all-pass mode).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	196
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	197 Hints are meaningful for all input and output ports but hints for
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	198 input control ports are expected to be particularly useful.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	199
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	200 More hint information is encapsulated in the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	201 LADSPA_PortRangeHintDescriptor type which is assembled by ORing
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	202 individual hint types together. Hints may require further
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	203 LowerBound and UpperBound information.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	204
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	205 All the hint information for a particular port is aggregated in the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	206 LADSPA_PortRangeHint structure. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	207
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	208 typedef int LADSPA_PortRangeHintDescriptor;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	209
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	210 /* Hint LADSPA_HINT_BOUNDED_BELOW indicates that the LowerBound field
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	211 of the LADSPA_PortRangeHint should be considered meaningful. The
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	212 value in this field should be considered the (inclusive) lower
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	213 bound of the valid range. If LADSPA_HINT_SAMPLE_RATE is also
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	214 specified then the value of LowerBound should be multiplied by the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	215 sample rate. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	216 #define LADSPA_HINT_BOUNDED_BELOW 0x1
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	217
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	218 /* Hint LADSPA_HINT_BOUNDED_ABOVE indicates that the UpperBound field
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	219 of the LADSPA_PortRangeHint should be considered meaningful. The
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	220 value in this field should be considered the (inclusive) upper
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	221 bound of the valid range. If LADSPA_HINT_SAMPLE_RATE is also
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	222 specified then the value of UpperBound should be multiplied by the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	223 sample rate. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	224 #define LADSPA_HINT_BOUNDED_ABOVE 0x2
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	225
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	226 /* Hint LADSPA_HINT_TOGGLED indicates that the data item should be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	227 considered a Boolean toggle. Data less than or equal to zero should
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	228 be considered `off' or `false,' and data above zero should be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	229 considered `on' or `true.' LADSPA_HINT_TOGGLED may not be used in
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	230 conjunction with any other hint except LADSPA_HINT_DEFAULT_0 or
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	231 LADSPA_HINT_DEFAULT_1. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	232 #define LADSPA_HINT_TOGGLED 0x4
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	233
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	234 /* Hint LADSPA_HINT_SAMPLE_RATE indicates that any bounds specified
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	235 should be interpreted as multiples of the sample rate. For
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	236 instance, a frequency range from 0Hz to the Nyquist frequency (half
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	237 the sample rate) could be requested by this hint in conjunction
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	238 with LowerBound = 0 and UpperBound = 0.5. Hosts that support bounds
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	239 at all must support this hint to retain meaning. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	240 #define LADSPA_HINT_SAMPLE_RATE 0x8
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	241
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	242 /* Hint LADSPA_HINT_LOGARITHMIC indicates that it is likely that the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	243 user will find it more intuitive to view values using a logarithmic
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	244 scale. This is particularly useful for frequencies and gains. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	245 #define LADSPA_HINT_LOGARITHMIC 0x10
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	246
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	247 /* Hint LADSPA_HINT_INTEGER indicates that a user interface would
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	248 probably wish to provide a stepped control taking only integer
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	249 values. Any bounds set should be slightly wider than the actual
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	250 integer range required to avoid floating point rounding errors. For
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	251 instance, the integer set {0,1,2,3} might be described as [-0.1,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	252 3.1]. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	253 #define LADSPA_HINT_INTEGER 0x20
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	254
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	255 /* The various LADSPA_HINT_HAS_DEFAULT_* hints indicate a `normal'
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	256 value for the port that is sensible as a default. For instance,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	257 this value is suitable for use as an initial value in a user
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	258 interface or as a value the host might assign to a control port
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	259 when the user has not provided one. Defaults are encoded using a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	260 mask so only one default may be specified for a port. Some of the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	261 hints make use of lower and upper bounds, in which case the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	262 relevant bound or bounds must be available and
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	263 LADSPA_HINT_SAMPLE_RATE must be applied as usual. The resulting
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	264 default must be rounded if LADSPA_HINT_INTEGER is present. Default
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	265 values were introduced in LADSPA v1.1. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	266 #define LADSPA_HINT_DEFAULT_MASK 0x3C0
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	267
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	268 /* This default values indicates that no default is provided. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	269 #define LADSPA_HINT_DEFAULT_NONE 0x0
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	270
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	271 /* This default hint indicates that the suggested lower bound for the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	272 port should be used. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	273 #define LADSPA_HINT_DEFAULT_MINIMUM 0x40
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	274
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	275 /* This default hint indicates that a low value between the suggested
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	276 lower and upper bounds should be chosen. For ports with
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	277 LADSPA_HINT_LOGARITHMIC, this should be exp(log(lower) * 0.75 +
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	278 log(upper) * 0.25). Otherwise, this should be (lower * 0.75 + upper
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	279 * 0.25). */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	280 #define LADSPA_HINT_DEFAULT_LOW 0x80
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	281
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	282 /* This default hint indicates that a middle value between the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	283 suggested lower and upper bounds should be chosen. For ports with
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	284 LADSPA_HINT_LOGARITHMIC, this should be exp(log(lower) * 0.5 +
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	285 log(upper) * 0.5). Otherwise, this should be (lower * 0.5 + upper *
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	286 0.5). */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	287 #define LADSPA_HINT_DEFAULT_MIDDLE 0xC0
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	288
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	289 /* This default hint indicates that a high value between the suggested
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	290 lower and upper bounds should be chosen. For ports with
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	291 LADSPA_HINT_LOGARITHMIC, this should be exp(log(lower) * 0.25 +
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	292 log(upper) * 0.75). Otherwise, this should be (lower * 0.25 + upper
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	293 * 0.75). */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	294 #define LADSPA_HINT_DEFAULT_HIGH 0x100
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	295
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	296 /* This default hint indicates that the suggested upper bound for the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	297 port should be used. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	298 #define LADSPA_HINT_DEFAULT_MAXIMUM 0x140
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	299
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	300 /* This default hint indicates that the number 0 should be used. Note
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	301 that this default may be used in conjunction with
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	302 LADSPA_HINT_TOGGLED. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	303 #define LADSPA_HINT_DEFAULT_0 0x200
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	304
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	305 /* This default hint indicates that the number 1 should be used. Note
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	306 that this default may be used in conjunction with
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	307 LADSPA_HINT_TOGGLED. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	308 #define LADSPA_HINT_DEFAULT_1 0x240
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	309
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	310 /* This default hint indicates that the number 100 should be used. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	311 #define LADSPA_HINT_DEFAULT_100 0x280
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	312
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	313 /* This default hint indicates that the Hz frequency of `concert A'
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	314 should be used. This will be 440 unless the host uses an unusual
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	315 tuning convention, in which case it may be within a few Hz. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	316 #define LADSPA_HINT_DEFAULT_440 0x2C0
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	317
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	318 #define LADSPA_IS_HINT_BOUNDED_BELOW(x) ((x) & LADSPA_HINT_BOUNDED_BELOW)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	319 #define LADSPA_IS_HINT_BOUNDED_ABOVE(x) ((x) & LADSPA_HINT_BOUNDED_ABOVE)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	320 #define LADSPA_IS_HINT_TOGGLED(x) ((x) & LADSPA_HINT_TOGGLED)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	321 #define LADSPA_IS_HINT_SAMPLE_RATE(x) ((x) & LADSPA_HINT_SAMPLE_RATE)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	322 #define LADSPA_IS_HINT_LOGARITHMIC(x) ((x) & LADSPA_HINT_LOGARITHMIC)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	323 #define LADSPA_IS_HINT_INTEGER(x) ((x) & LADSPA_HINT_INTEGER)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	324
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	325 #define LADSPA_IS_HINT_HAS_DEFAULT(x) ((x) & LADSPA_HINT_DEFAULT_MASK)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	326 #define LADSPA_IS_HINT_DEFAULT_MINIMUM(x) (((x) & LADSPA_HINT_DEFAULT_MASK) \
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	327 == LADSPA_HINT_DEFAULT_MINIMUM)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	328 #define LADSPA_IS_HINT_DEFAULT_LOW(x) (((x) & LADSPA_HINT_DEFAULT_MASK) \
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	329 == LADSPA_HINT_DEFAULT_LOW)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	330 #define LADSPA_IS_HINT_DEFAULT_MIDDLE(x) (((x) & LADSPA_HINT_DEFAULT_MASK) \
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	331 == LADSPA_HINT_DEFAULT_MIDDLE)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	332 #define LADSPA_IS_HINT_DEFAULT_HIGH(x) (((x) & LADSPA_HINT_DEFAULT_MASK) \
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	333 == LADSPA_HINT_DEFAULT_HIGH)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	334 #define LADSPA_IS_HINT_DEFAULT_MAXIMUM(x) (((x) & LADSPA_HINT_DEFAULT_MASK) \
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	335 == LADSPA_HINT_DEFAULT_MAXIMUM)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	336 #define LADSPA_IS_HINT_DEFAULT_0(x) (((x) & LADSPA_HINT_DEFAULT_MASK) \
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	337 == LADSPA_HINT_DEFAULT_0)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	338 #define LADSPA_IS_HINT_DEFAULT_1(x) (((x) & LADSPA_HINT_DEFAULT_MASK) \
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	339 == LADSPA_HINT_DEFAULT_1)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	340 #define LADSPA_IS_HINT_DEFAULT_100(x) (((x) & LADSPA_HINT_DEFAULT_MASK) \
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	341 == LADSPA_HINT_DEFAULT_100)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	342 #define LADSPA_IS_HINT_DEFAULT_440(x) (((x) & LADSPA_HINT_DEFAULT_MASK) \
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	343 == LADSPA_HINT_DEFAULT_440)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	344
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	345 typedef struct _LADSPA_PortRangeHint {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	346
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	347 /* Hints about the port. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	348 LADSPA_PortRangeHintDescriptor HintDescriptor;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	349
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	350 /* Meaningful when hint LADSPA_HINT_BOUNDED_BELOW is active. When
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	351 LADSPA_HINT_SAMPLE_RATE is also active then this value should be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	352 multiplied by the relevant sample rate. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	353 LADSPA_Data LowerBound;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	354
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	355 /* Meaningful when hint LADSPA_HINT_BOUNDED_ABOVE is active. When
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	356 LADSPA_HINT_SAMPLE_RATE is also active then this value should be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	357 multiplied by the relevant sample rate. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	358 LADSPA_Data UpperBound;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	359
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	360 } LADSPA_PortRangeHint;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	361
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	362 /*****************************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	363
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	364 /* Plugin Handles:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	365
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	366 This plugin handle indicates a particular instance of the plugin
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	367 concerned. It is valid to compare this to NULL (0 for C++) but
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	368 otherwise the host should not attempt to interpret it. The plugin
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	369 may use it to reference internal instance data. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	370
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	371 typedef void * LADSPA_Handle;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	372
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	373 /*****************************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	374
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	375 /* Descriptor for a Type of Plugin:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	376
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	377 This structure is used to describe a plugin type. It provides a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	378 number of functions to examine the type, instantiate it, link it to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	379 buffers and workspaces and to run it. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	380
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	381 typedef struct _LADSPA_Descriptor {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	382
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	383 /* This numeric identifier indicates the plugin type
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	384 uniquely. Plugin programmers may reserve ranges of IDs from a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	385 central body to avoid clashes. Hosts may assume that IDs are
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	386 below 0x1000000. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	387 unsigned long UniqueID;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	388
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	389 /* This identifier can be used as a unique, case-sensitive
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	390 identifier for the plugin type within the plugin file. Plugin
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	391 types should be identified by file and label rather than by index
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	392 or plugin name, which may be changed in new plugin
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	393 versions. Labels must not contain white-space characters. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	394 const char * Label;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	395
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	396 /* This indicates a number of properties of the plugin. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	397 LADSPA_Properties Properties;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	398
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	399 /* This member points to the null-terminated name of the plugin
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	400 (e.g. "Sine Oscillator"). */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	401 const char * Name;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	402
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	403 /* This member points to the null-terminated string indicating the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	404 maker of the plugin. This can be an empty string but not NULL. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	405 const char * Maker;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	406
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	407 /* This member points to the null-terminated string indicating any
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	408 copyright applying to the plugin. If no Copyright applies the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	409 string "None" should be used. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	410 const char * Copyright;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	411
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	412 /* This indicates the number of ports (input AND output) present on
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	413 the plugin. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	414 unsigned long PortCount;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	415
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	416 /* This member indicates an array of port descriptors. Valid indices
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	417 vary from 0 to PortCount-1. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	418 const LADSPA_PortDescriptor * PortDescriptors;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	419
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	420 /* This member indicates an array of null-terminated strings
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	421 describing ports (e.g. "Frequency (Hz)"). Valid indices vary from
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	422 0 to PortCount-1. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	423 const char * const * PortNames;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	424
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	425 /* This member indicates an array of range hints for each port (see
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	426 above). Valid indices vary from 0 to PortCount-1. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	427 const LADSPA_PortRangeHint * PortRangeHints;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	428
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	429 /* This may be used by the plugin developer to pass any custom
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	430 implementation data into an instantiate call. It must not be used
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	431 or interpreted by the host. It is expected that most plugin
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	432 writers will not use this facility as LADSPA_Handle should be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	433 used to hold instance data. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	434 void * ImplementationData;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	435
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	436 /* This member is a function pointer that instantiates a plugin. A
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	437 handle is returned indicating the new plugin instance. The
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	438 instantiation function accepts a sample rate as a parameter. The
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	439 plugin descriptor from which this instantiate function was found
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	440 must also be passed. This function must return NULL if
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	441 instantiation fails.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	442
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	443 Note that instance initialisation should generally occur in
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	444 activate() rather than here. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	445 LADSPA_Handle (instantiate)(const struct _LADSPA_Descriptor Descriptor,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	446 unsigned long SampleRate);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	447
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	448 /* This member is a function pointer that connects a port on an
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	449 instantiated plugin to a memory location at which a block of data
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	450 for the port will be read/written. The data location is expected
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	451 to be an array of LADSPA_Data for audio ports or a single
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	452 LADSPA_Data value for control ports. Memory issues will be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	453 managed by the host. The plugin must read/write the data at these
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	454 locations every time run() or run_adding() is called and the data
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	455 present at the time of this connection call should not be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	456 considered meaningful.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	457
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	458 connect_port() may be called more than once for a plugin instance
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	459 to allow the host to change the buffers that the plugin is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	460 reading or writing. These calls may be made before or after
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	461 activate() or deactivate() calls.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	462
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	463 connect_port() must be called at least once for each port before
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	464 run() or run_adding() is called. When working with blocks of
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	465 LADSPA_Data the plugin should pay careful attention to the block
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	466 size passed to the run function as the block allocated may only
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	467 just be large enough to contain the block of samples.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	468
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	469 Plugin writers should be aware that the host may elect to use the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	470 same buffer for more than one port and even use the same buffer
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	471 for both input and output (see LADSPA_PROPERTY_INPLACE_BROKEN).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	472 However, overlapped buffers or use of a single buffer for both
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	473 audio and control data may result in unexpected behaviour. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	474 void (*connect_port)(LADSPA_Handle Instance,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	475 unsigned long Port,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	476 LADSPA_Data * DataLocation);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	477
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	478 /* This member is a function pointer that initialises a plugin
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	479 instance and activates it for use. This is separated from
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	480 instantiate() to aid real-time support and so that hosts can
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	481 reinitialise a plugin instance by calling deactivate() and then
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	482 activate(). In this case the plugin instance must reset all state
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	483 information dependent on the history of the plugin instance
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	484 except for any data locations provided by connect_port() and any
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	485 gain set by set_run_adding_gain(). If there is nothing for
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	486 activate() to do then the plugin writer may provide a NULL rather
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	487 than an empty function.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	488
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	489 When present, hosts must call this function once before run() (or
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	490 run_adding()) is called for the first time. This call should be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	491 made as close to the run() call as possible and indicates to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	492 real-time plugins that they are now live. Plugins should not rely
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	493 on a prompt call to run() after activate(). activate() may not be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	494 called again unless deactivate() is called first. Note that
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	495 connect_port() may be called before or after a call to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	496 activate(). */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	497 void (*activate)(LADSPA_Handle Instance);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	498
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	499 /* This method is a function pointer that runs an instance of a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	500 plugin for a block. Two parameters are required: the first is a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	501 handle to the particular instance to be run and the second
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	502 indicates the block size (in samples) for which the plugin
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	503 instance may run.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	504
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	505 Note that if an activate() function exists then it must be called
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	506 before run() or run_adding(). If deactivate() is called for a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	507 plugin instance then the plugin instance may not be reused until
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	508 activate() has been called again.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	509
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	510 If the plugin has the property LADSPA_PROPERTY_HARD_RT_CAPABLE
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	511 then there are various things that the plugin should not do
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	512 within the run() or run_adding() functions (see above). */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	513 void (*run)(LADSPA_Handle Instance,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	514 unsigned long SampleCount);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	515
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	516 /* This method is a function pointer that runs an instance of a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	517 plugin for a block. This has identical behaviour to run() except
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	518 in the way data is output from the plugin. When run() is used,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	519 values are written directly to the memory areas associated with
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	520 the output ports. However when run_adding() is called, values
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	521 must be added to the values already present in the memory
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	522 areas. Furthermore, output values written must be scaled by the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	523 current gain set by set_run_adding_gain() (see below) before
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	524 addition.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	525
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	526 run_adding() is optional. When it is not provided by a plugin,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	527 this function pointer must be set to NULL. When it is provided,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	528 the function set_run_adding_gain() must be provided also. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	529 void (*run_adding)(LADSPA_Handle Instance,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	530 unsigned long SampleCount);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	531
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	532 /* This method is a function pointer that sets the output gain for
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	533 use when run_adding() is called (see above). If this function is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	534 never called the gain is assumed to default to 1. Gain
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	535 information should be retained when activate() or deactivate()
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	536 are called.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	537
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	538 This function should be provided by the plugin if and only if the
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	539 run_adding() function is provided. When it is absent this
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	540 function pointer must be set to NULL. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	541 void (*set_run_adding_gain)(LADSPA_Handle Instance,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	542 LADSPA_Data Gain);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	543
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	544 /* This is the counterpart to activate() (see above). If there is
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	545 nothing for deactivate() to do then the plugin writer may provide
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	546 a NULL rather than an empty function.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	547
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	548 Hosts must deactivate all activated units after they have been
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	549 run() (or run_adding()) for the last time. This call should be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	550 made as close to the last run() call as possible and indicates to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	551 real-time plugins that they are no longer live. Plugins should
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	552 not rely on prompt deactivation. Note that connect_port() may be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	553 called before or after a call to deactivate().
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	554
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	555 Deactivation is not similar to pausing as the plugin instance
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	556 will be reinitialised when activate() is called to reuse it. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	557 void (*deactivate)(LADSPA_Handle Instance);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	558
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	559 /* Once an instance of a plugin has been finished with it can be
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	560 deleted using the following function. The instance handle passed
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	561 ceases to be valid after this call.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	562
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	563 If activate() was called for a plugin instance then a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	564 corresponding call to deactivate() must be made before cleanup()
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	565 is called. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	566 void (*cleanup)(LADSPA_Handle Instance);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	567
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	568 } LADSPA_Descriptor;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	569
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	570 /**********************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	571
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	572 /* Accessing a Plugin: */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	573
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	574 /* The exact mechanism by which plugins are loaded is host-dependent,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	575 however all most hosts will need to know is the name of shared
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	576 object file containing the plugin types. To allow multiple hosts to
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	577 share plugin types, hosts may wish to check for environment
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	578 variable LADSPA_PATH. If present, this should contain a
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	579 colon-separated path indicating directories that should be searched
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	580 (in order) when loading plugin types.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	581
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	582 A plugin programmer must include a function called
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	583 "ladspa_descriptor" with the following function prototype within
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	584 the shared object file. This function will have C-style linkage (if
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	585 you are using C++ this is taken care of by the `extern "C"' clause
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	586 at the top of the file).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	587
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	588 A host will find the plugin shared object file by one means or
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	589 another, find the ladspa_descriptor() function, call it, and
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	590 proceed from there.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	591
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	592 Plugin types are accessed by index (not ID) using values from 0
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	593 upwards. Out of range indexes must result in this function
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	594 returning NULL, so the plugin count can be determined by checking
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	595 for the least index that results in NULL being returned. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	596
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	597 LADSPA_PLUGIN_EXPORT const LADSPA_Descriptor * ladspa_descriptor(unsigned long Index);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	598
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	599 /* Datatype corresponding to the ladspa_descriptor() function. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	600 typedef const LADSPA_Descriptor *
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	601 (*LADSPA_Descriptor_Function)(unsigned long Index);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	602
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	603 /**********************************************************************/
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	604
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	605 #ifdef __cplusplus
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	606 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	607 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	608
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	609 #endif /* LADSPA_INCLUDED */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	610
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	611 /* EOF */

Mercurial > hg > pub > prymula > com

annotate DPF-Prymula-audioplugins/dpf/distrho/src/ladspa/ladspa.h @ 3:84e66ea83026