Carla/source/backend/CarlaBackend.hpp

/*
 * Carla Backend API
 * Copyright (C) 2011-2013 Filipe Coelho <falktx@falktx.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * For a full copy of the GNU General Public License see the doc/GPL.txt file.
 */

#ifndef CARLA_BACKEND_HPP_INCLUDED
#define CARLA_BACKEND_HPP_INCLUDED

#include "CarlaDefines.hpp"

#ifdef CARLA_PROPER_CPP11_SUPPORT
# define SIZE_INT : int
# include <cstdint>
#else
# define SIZE_INT
# include <stdint.h>
#endif

#define CARLA_BACKEND_START_NAMESPACE namespace CarlaBackend {
#define CARLA_BACKEND_END_NAMESPACE }
#define CARLA_BACKEND_USE_NAMESPACE using namespace CarlaBackend;

#define STR_MAX 0xFF

CARLA_BACKEND_START_NAMESPACE

/*!
 * @defgroup CarlaBackendAPI Carla Backend API
 *
 * The Carla Backend API.\n
 * This is the base definitions for everything in the Carla backend code.
 * @{
 */

const unsigned int MAX_DEFAULT_PLUGINS    = 99;  //!< Maximum default number of loadable plugins.
const unsigned int MAX_RACK_PLUGINS       = 16;  //!< Maximum number of loadable plugins in rack mode.
const unsigned int MAX_PATCHBAY_PLUGINS   = 255; //!< Maximum number of loadable plugins in patchbay mode.
const unsigned int MAX_DEFAULT_PARAMETERS = 200; //!< Maximum default number of parameters allowed.\see ENGINE_OPTION_MAX_PARAMETERS

/*!
 * @defgroup EngineDriverHints Engine Driver Hints
 *
 * Various engine driver hints.
 * \see CarlaEngine::hints()
 * @{
 */
const unsigned int ENGINE_DRIVER_HAS_CONTROL_PANEL    = 0x1; //!< Engine driver has custom control-panel.
const unsigned int ENGINE_DRIVER_VARIABLE_BUFFER_SIZE = 0x2; //!< Engine driver can change buffer-size on the fly.
const unsigned int ENGINE_DRIVER_VARIABLE_SAMPLE_RATE = 0x4; //!< Engine driver can change sample-rate on the fly.
/**@}*/

/*!
 * @defgroup PluginHints Plugin Hints
 *
 * Various plugin hints.
 * \see CarlaPlugin::hints()
 * @{
 */
const unsigned int PLUGIN_IS_BRIDGE   = 0x001; //!< Plugin is a bridge. This hint is required because "bridge" itself is not a plugin type.
const unsigned int PLUGIN_IS_RTSAFE   = 0x002; //!< Plugin is hard real-time safe.
const unsigned int PLUGIN_IS_SYNTH    = 0x004; //!< Plugin is hard real-time safe.
const unsigned int PLUGIN_HAS_GUI     = 0x008; //!< Plugin has its own custom GUI.
const unsigned int PLUGIN_CAN_DRYWET  = 0x010; //!< Plugin can use internal Dry/Wet control.
const unsigned int PLUGIN_CAN_VOLUME  = 0x020; //!< Plugin can use internal Volume control.
const unsigned int PLUGIN_CAN_BALANCE = 0x040; //!< Plugin can use internal Left & Right Balance controls.
const unsigned int PLUGIN_CAN_PANNING = 0x080; //!< Plugin can use internal Panning control.
const unsigned int PLUGIN_NEEDS_FIXED_BUFFERS = 0x100; //!< Plugin needs constant/fixed-size audio buffers.
const unsigned int PLUGIN_NEEDS_SINGLE_THREAD = 0x200; //!< Plugin needs a single thread for all UI events.
/**@}*/

/*!
 * @defgroup PluginOptions Plugin Options
 *
 * Various plugin options.
 * \see CarlaPlugin::availableOptions() and CarlaPlugin::options()
 * @{
 */
const unsigned int PLUGIN_OPTION_FIXED_BUFFERS         = 0x001; //!< Use constant/fixed-size audio buffers.
const unsigned int PLUGIN_OPTION_FORCE_STEREO          = 0x002; //!< Force mono plugin as stereo.
const unsigned int PLUGIN_OPTION_MAP_PROGRAM_CHANGES   = 0x004; //!< Map MIDI-Programs to plugin programs.
const unsigned int PLUGIN_OPTION_USE_CHUNKS            = 0x008; //!< Use chunks to save&restore data.
const unsigned int PLUGIN_OPTION_SEND_CONTROL_CHANGES  = 0x010; //!< Send MIDI control change events.
const unsigned int PLUGIN_OPTION_SEND_CHANNEL_PRESSURE = 0x020; //!< Send MIDI channel pressure events.
const unsigned int PLUGIN_OPTION_SEND_NOTE_AFTERTOUCH  = 0x040; //!< Send MIDI note aftertouch events.
const unsigned int PLUGIN_OPTION_SEND_PITCHBEND        = 0x080; //!< Send MIDI pitchbend events.
const unsigned int PLUGIN_OPTION_SEND_ALL_SOUND_OFF    = 0x100; //!< Send MIDI all-sounds/notes-off events, single note-offs otherwise.
/**@}*/

/*!
 * @defgroup ParameterHints Parameter Hints
 *
 * Various parameter hints.
 * \see CarlaPlugin::parameterData()
 * @{
 */
const unsigned int PARAMETER_IS_BOOLEAN       = 0x001; //!< Parameter values are boolean (always at minimum or maximum values).
const unsigned int PARAMETER_IS_INTEGER       = 0x002; //!< Parameter values are integer.
const unsigned int PARAMETER_IS_LOGARITHMIC   = 0x004; //!< Parameter values are logarithmic.
const unsigned int PARAMETER_IS_ENABLED       = 0x010; //!< Parameter is enabled (can be viewed, changed and stored).
const unsigned int PARAMETER_IS_AUTOMABLE     = 0x020; //!< Parameter is automable (realtime safe).
const unsigned int PARAMETER_IS_READ_ONLY     = 0x040; //!< Parameter is read-only.
const unsigned int PARAMETER_USES_SAMPLERATE  = 0x100; //!< Parameter needs sample rate to work (value and ranges are multiplied by SR on usage, divided by SR on save).
const unsigned int PARAMETER_USES_SCALEPOINTS = 0x200; //!< Parameter uses scalepoints to define internal values in a meaningful way.
const unsigned int PARAMETER_USES_CUSTOM_TEXT = 0x400; //!< Parameter uses custom text for displaying its value.\see CarlaPlugin::getParameterText()
/**@}*/

/*!
 * @defgroup CustomDataTypes Custom Data Types
 *
 * The type defines how the \param value in the CustomData struct is stored.\n
 * Types are valid URIs. Any non-string or non-simple type (not integral) is saved in a base64 encoded format.
 * \see CustomData
 * @{
 */
const char* const CUSTOM_DATA_TYPE_CHUNK  = "http://kxstudio.sf.net/ns/carla/chunk";  //!< Chunk type URI.
const char* const CUSTOM_DATA_TYPE_STRING = "http://kxstudio.sf.net/ns/carla/string"; //!< String type URI.
/**@}*/

/*!
 * @defgroup CustomDataKeys Custom Data Keys
 *
 * \see CustomData
 * @{
 */
const char* const CUSTOM_DATA_KEY_OPTIONS    = "CarlaOptions";    //!< Options URI.
const char* const CUSTOM_DATA_KEY_UI_X       = "CarlaUI:X";       //!< UI X URI.
const char* const CUSTOM_DATA_KEY_UI_Y       = "CarlaUI:Y";       //!< UI Y URI.
const char* const CUSTOM_DATA_KEY_UI_WIDTH   = "CarlaUI:Width";   //!< UI width URI.
const char* const CUSTOM_DATA_KEY_UI_HEIGHT  = "CarlaUI:Height";  //!< UI height URI.
const char* const CUSTOM_DATA_KEY_UI_VISIBLE = "CarlaUI:Visible"; //!< UI visible URI.
/**@}*/

/*!
 * @defgroup PatchbayPortHints Patchbay Port Hints
 *
 * Various patchbay port hints.
 * @{
 */
const unsigned int PATCHBAY_PORT_IS_INPUT     = 0x01; //!< Patchbay port is input.
const unsigned int PATCHBAY_PORT_IS_OUTPUT    = 0x02; //!< Patchbay port is output.
const unsigned int PATCHBAY_PORT_IS_AUDIO     = 0x10; //!< Patchbay port is of Audio type.
const unsigned int PATCHBAY_PORT_IS_CV        = 0x20; //!< Patchbay port is of CV type.
const unsigned int PATCHBAY_PORT_IS_MIDI      = 0x40; //!< Patchbay port is of MIDI type.
/**@}*/

/*!
 * The binary type of a plugin.
 */
enum BinaryType SIZE_INT {
    BINARY_NONE    = 0, //!< Null binary type.
    BINARY_POSIX32 = 1, //!< POSIX 32bit.
    BINARY_POSIX64 = 2, //!< POSIX 64bit.
    BINARY_WIN32   = 3, //!< Windows 32bit.
    BINARY_WIN64   = 4, //!< Windows 64bit.
    BINARY_OTHER   = 5  //!< Other.
};

/*!
 * All the available plugin types, provided by subclasses of CarlaPlugin.\n
 * Some plugin classes might provide more than 1 plugin type.
 */
enum PluginType SIZE_INT {
    PLUGIN_NONE     =  0, //!< Null plugin type.
    PLUGIN_INTERNAL =  1, //!< Internal plugin.
    PLUGIN_LADSPA   =  2, //!< LADSPA plugin.
    PLUGIN_DSSI     =  3, //!< DSSI plugin.
    PLUGIN_LV2      =  4, //!< LV2 plugin.
    PLUGIN_VST      =  5, //!< VST plugin.
    PLUGIN_AU       =  6, //!< AU plugin.
    PLUGIN_CSOUND   =  7, //!< Csound file.
    PLUGIN_GIG      =  8, //!< GIG sound kit.
    PLUGIN_SF2      =  9, //!< SF2 sound kit (aka SoundFont).
    PLUGIN_SFZ      = 10  //!< SFZ sound kit.
};

/*!
 * Plugin category, describing the funtionality of a plugin.\n
 * When a plugin fails to tell its own category, one is atributted to it based on its name.
 */
enum PluginCategory SIZE_INT {
    PLUGIN_CATEGORY_NONE       = 0, //!< Null plugin category.
    PLUGIN_CATEGORY_SYNTH      = 1, //!< A synthesizer or generator.
    PLUGIN_CATEGORY_DELAY      = 2, //!< A delay or reverberator.
    PLUGIN_CATEGORY_EQ         = 3, //!< An equalizer.
    PLUGIN_CATEGORY_FILTER     = 4, //!< A filter.
    PLUGIN_CATEGORY_DISTORTION = 5, //!< A distortion plugin.
    PLUGIN_CATEGORY_DYNAMICS   = 6, //!< A 'dynamic' plugin (amplifier, compressor, gate, etc).
    PLUGIN_CATEGORY_MODULATOR  = 7, //!< A 'modulator' plugin (chorus, flanger, phaser, etc).
    PLUGIN_CATEGORY_UTILITY    = 8, //!< An 'utility' plugin (analyzer, converter, mixer, etc).
    PLUGIN_CATEGORY_OTHER      = 9  //!< Misc plugin (used to check if the plugin has a category).
};

/*!
 * Plugin parameter type.
 */
enum ParameterType SIZE_INT {
    PARAMETER_UNKNOWN = 0, //!< Null parameter type.
    PARAMETER_INPUT   = 1, //!< Input parameter.
    PARAMETER_OUTPUT  = 2, //!< Ouput parameter.
    PARAMETER_SPECIAL = 3  //!< Special parameter, used to report info in LADSPA, DSSI or LV2 plugins.
};

/*!
 * Internal parameter indexes.\n
 * These are special parameters used internally, plugins do not know about their existence.
 */
enum InternalParameterIndex SIZE_INT {
    PARAMETER_NULL          = -1, //!< Null parameter.
    PARAMETER_ACTIVE        = -2, //!< Active parameter, can only be 'true' or 'false'; default is 'false'.
    PARAMETER_DRYWET        = -3, //!< Dry/Wet parameter, range 0.0...1.0; default is 1.0.
    PARAMETER_VOLUME        = -4, //!< Volume parameter, range 0.0...1.27; default is 1.0.
    PARAMETER_BALANCE_LEFT  = -5, //!< Stereo Balance-Left parameter, range -1.0...1.0; default is -1.0.
    PARAMETER_BALANCE_RIGHT = -6, //!< Stereo Balance-Right parameter, range -1.0...1.0; default is 1.0.
    PARAMETER_PANNING       = -7, //!< Mono Panning parameter, range -1.0...1.0; default is 0.0.
    PARAMETER_CTRL_CHANNEL  = -8, //!< MIDI Control channel, range -1...15 (-1 = off).
    PARAMETER_MAX           = -9  //!< Max value, defined for convenience.
};

/*!
 * Opcodes sent from the engine callback to the GUI, as defined by EngineCallbackFunc.
 * \see CarlaEngine::setCallback()
 */
enum EngineCallbackOpcode SIZE_INT {
    /*!
     * Debug.\n
     * This opcode is undefined and used only for testing purposes.
     */
    ENGINE_CALLBACK_DEBUG = 0,

    /*!
     * A plugin has been added.
     * \param valueStr Plugin name
     */
    ENGINE_CALLBACK_PLUGIN_ADDED = 1,

    /*!
     * A plugin has been removed.
     */
    ENGINE_CALLBACK_PLUGIN_REMOVED = 2,

    /*!
     * A plugin has been renamed.
     * \param valueStr New plugin name
     */
    ENGINE_CALLBACK_PLUGIN_RENAMED = 3,

    /*!
     * A plugin has been disabled.
     * \param valueStr Error details
     */
    ENGINE_CALLBACK_PLUGIN_DISABLED = 4,

    /*!
     * A parameter value has been changed.
     * \param value1 Parameter index
     * \param value3 Parameter value
     */
    ENGINE_CALLBACK_PARAMETER_VALUE_CHANGED = 5,

    /*!
     * A parameter default has changed.
     * \param value1 Parameter index
     * \param value3 New default value
     */
    ENGINE_CALLBACK_PARAMETER_DEFAULT_CHANGED = 6,

    /*!
     * A parameter's MIDI channel has been changed.
     * \param value1 Parameter index
     * \param value2 MIDI channel
     */
    ENGINE_CALLBACK_PARAMETER_MIDI_CHANNEL_CHANGED = 7,

    /*!
     * A parameter's MIDI CC has been changed.
     * \param value1 Parameter index
     * \param value2 MIDI CC
     */
    ENGINE_CALLBACK_PARAMETER_MIDI_CC_CHANGED = 8,

    /*!
     * The current program has has been changed.
     * \param value1 Program index
     */
    ENGINE_CALLBACK_PROGRAM_CHANGED = 9,

    /*!
     * The current MIDI program has been changed.
     * \param value1 MIDI bank
     * \param value2 MIDI program
     */
    ENGINE_CALLBACK_MIDI_PROGRAM_CHANGED = 10,

    /*!
     * The plugin's custom UI state has changed.
     * \param value1 State, as follows:\n
     *                0: UI has been closed or hidden\n
     *                1: UI has been shown\n
     *               -1: UI has crashed and should not be shown again
     */
    ENGINE_CALLBACK_UI_STATE_CHANGED = 11,

    /*!
     * A note has been pressed.
     * \param value1 Channel
     * \param value2 Note
     * \param value3 Velocity
     */
    ENGINE_CALLBACK_NOTE_ON = 12,

    /*!
     * A note has been released.
     * \param value1 Channel
     * \param value2 Note
     */
    ENGINE_CALLBACK_NOTE_OFF = 13,

    /*!
     * The plugin needs update.
     */
    ENGINE_CALLBACK_UPDATE = 14,

    /*!
     * The plugin's data/information has changed.
     */
    ENGINE_CALLBACK_RELOAD_INFO = 15,

    /*!
     * The plugin's parameters have changed.
     */
    ENGINE_CALLBACK_RELOAD_PARAMETERS = 16,

    /*!
     * The plugin's programs have changed.
     */
    ENGINE_CALLBACK_RELOAD_PROGRAMS = 17,

    /*!
     * The plugin's state has changed.
     */
    ENGINE_CALLBACK_RELOAD_ALL = 18,

    /*!
     * Canvas client added.
     * \param pluginId Client Id
     * \param valueStr Client name
     */
    ENGINE_CALLBACK_PATCHBAY_CLIENT_ADDED = 19,

    /*!
     * Canvas client removed.
     * \param pluginId Client Id
     */
    ENGINE_CALLBACK_PATCHBAY_CLIENT_REMOVED = 20,

    /*!
     * Canvas client renamed.
     * \param pluginId Client Id
     * \param valueStr New client name
     */
    ENGINE_CALLBACK_PATCHBAY_CLIENT_RENAMED = 21,

    /*!
     * Canvas port added.
     * \param pluginId Client Id
     * \param value1   Port Id
     * \param value2   Port flags
     * \param valueStr Port name
     */
    ENGINE_CALLBACK_PATCHBAY_PORT_ADDED = 22,

    /*!
     * Canvas port removed.
     * \param pluginId Client Id
     * \param value1   Port Id
     */
    ENGINE_CALLBACK_PATCHBAY_PORT_REMOVED = 23,

    /*!
     * Canvas port renamed.
     * \param pluginId Client Id
     * \param value1   Port Id
     * \param valueStr New port name
     */
    ENGINE_CALLBACK_PATCHBAY_PORT_RENAMED = 24,

    /*!
     * Canvas port connection added.
     * \param value1 Output port Id
     * \param value2 Input port Id
     */
    ENGINE_CALLBACK_PATCHBAY_CONNECTION_ADDED = 25,

    /*!
     * Canvas port connection removed.
     * \param value1 Output port Id
     * \param value2 Input port Id
     */
    ENGINE_CALLBACK_PATCHBAY_CONNECTION_REMOVED = 26,

    /*!
     * Canvas client icon changed.
     * \param pluginId Client Id
     * \param valueStr New icon name
     */
    ENGINE_CALLBACK_PATCHBAY_ICON_CHANGED = 27,

    /*!
     * Engine buffer-size changed.
     * \param value1 New buffer size
     */
    ENGINE_CALLBACK_BUFFER_SIZE_CHANGED = 28,

    /*!
     * Engine sample-rate changed.
     * \param value3 New sample rate
     */
    ENGINE_CALLBACK_SAMPLE_RATE_CHANGED = 29,

    /*!
     * Engine process mode changed.
     * \param value1 New process mode
     * \see ProcessMode
     */
    ENGINE_CALLBACK_PROCESS_MODE_CHANGED = 30,

    /*!
     * Engine started.
     * \param valuestr Engine driver
     */
    ENGINE_CALLBACK_ENGINE_STARTED = 31,

    /*!
     * Engine stopped.
     */
    ENGINE_CALLBACK_ENGINE_STOPPED = 32,

    /*!
     * Non-Session-Manager Announce message.
     */
    ENGINE_CALLBACK_NSM_ANNOUNCE = 33,

    /*!
     * Non-Session-Manager Open message.
     */
    ENGINE_CALLBACK_NSM_OPEN = 34,

    /*!
     * Non-Session-Manager Save message.
     */
    ENGINE_CALLBACK_NSM_SAVE = 35,

    /*!
     * Show \a valueStr as info to user.
     */
    ENGINE_CALLBACK_INFO = 36,

    /*!
     * Show \a valueStr as an error to user.
     */
    ENGINE_CALLBACK_ERROR = 37,

    /*!
     * The engine has crashed or malfunctioned and will no longer work.
     */
    ENGINE_CALLBACK_QUIT = 38
};

/*!
 * Options used in the CarlaEngine::setOption() calls.\n
 * All options except paths must be set before initiliazing or after closing the engine.
 */
enum EngineOption SIZE_INT {
    /*!
     * Set the current process name.\n
     * This is a convenience option, as Python lacks this functionality.
     */
    ENGINE_OPTION_PROCESS_NAME = 0,

    /*!
     * Set the engine processing mode.\n
     * Default is PROCESS_MODE_MULTIPLE_CLIENTS on Linux and PROCESS_MODE_CONTINUOUS_RACK for all other OSes.
     * \see ProcessMode
     */
    ENGINE_OPTION_PROCESS_MODE = 1,

    /*!
     * Set the engine transport mode.\n
     * Default is TRANSPORT_MODE_INTERNAL.
     * \see TransportMode
     */
    ENGINE_OPTION_TRANSPORT_MODE = 2,

    /*!
     * Force mono plugins as stereo, by running 2 instances at the same time.
     * \note Not supported by all plugins.
     * \see PLUGIN_OPTION_FORCE_STEREO
     */
    ENGINE_OPTION_FORCE_STEREO = 3,

    /*!
     * Use plugin bridges whenever possible.\n
     * Default is no, EXPERIMENTAL.
     */
    ENGINE_OPTION_PREFER_PLUGIN_BRIDGES = 4,

    /*!
     * Use UI bridges whenever possible, otherwise UIs will be handled in the main thread.\n
     * Default is yes.
     */
    ENGINE_OPTION_PREFER_UI_BRIDGES = 5,

    /*!
     * Make plugin UIs always-on-top.\n
     * Default is yes.
     */
    ENGINE_OPTION_UIS_ALWAYS_ON_TOP = 6,

    /*!
     * Maximum number of parameters allowed.\n
     * Default is MAX_DEFAULT_PARAMETERS.
     */
    ENGINE_OPTION_MAX_PARAMETERS = 7,

    /*!
     * Timeout value in ms for how much to wait for UI-Bridges to respond.\n
     * Default is 4000 (4 secs).
     */
    ENGINE_OPTION_UI_BRIDGES_TIMEOUT = 8,

    /*!
     * Audio number of periods.
     */
    ENGINE_OPTION_AUDIO_NUM_PERIODS = 9,

    /*!
     * Audio buffer size.
     */
    ENGINE_OPTION_AUDIO_BUFFER_SIZE = 10,

    /*!
     * Audio sample rate.
     */
    ENGINE_OPTION_AUDIO_SAMPLE_RATE = 11,

    /*!
     * Audio device.
     */
    ENGINE_OPTION_AUDIO_DEVICE = 12,

    /*!
     * Set path to the resource files.\n
     * Default unset.
     *
     * \note Must be set for some internal plugins to work!
     */
    ENGINE_OPTION_PATH_RESOURCES = 13,

#ifndef BUILD_BRIDGE
    /*!
     * Set path to the native plugin bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_NATIVE = 14,

    /*!
     * Set path to the POSIX 32bit plugin bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_POSIX32 = 15,

    /*!
     * Set path to the POSIX 64bit plugin bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_POSIX64 = 16,

    /*!
     * Set path to the Windows 32bit plugin bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_WIN32 = 17,

    /*!
     * Set path to the Windows 64bit plugin bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_WIN64 = 18,
#endif

#ifdef WANT_LV2
    /*!
     * Set path to the LV2 External UI bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_LV2_EXTERNAL = 19,

    /*!
     * Set path to the LV2 Gtk2 UI bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_LV2_GTK2 = 20,

    /*!
     * Set path to the LV2 Gtk3 UI bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_LV2_GTK3 = 21,

    /*!
     * Set path to the LV2 Ntk UI bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_LV2_NTK = 22,

    /*!
     * Set path to the LV2 Qt4 UI bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_LV2_QT4 = 23,

    /*!
     * Set path to the LV2 Qt5 UI bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_LV2_QT5 = 24,

    /*!
     * Set path to the LV2 Cocoa UI bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_LV2_COCOA = 25,

    /*!
     * Set path to the LV2 Windows UI bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_LV2_WINDOWS = 26,

    /*!
     * Set path to the LV2 X11 UI bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_LV2_X11 = 27,
#endif

#ifdef WANT_VST
    /*!
     * Set path to the VST Mac UI bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_VST_MAC = 28,

    /*!
     * Set path to the VST HWND UI bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_VST_HWND = 29,

    /*!
     * Set path to the VST X11 UI bridge executable.\n
     * Default unset.
     */
    ENGINE_OPTION_PATH_BRIDGE_VST_X11 = 30
#endif
};

/*!
 * Engine process mode.
 * \see ENGINE_OPTION_PROCESS_MODE
 */
enum EngineProcessMode SIZE_INT {
    ENGINE_PROCESS_MODE_SINGLE_CLIENT    = 0, //!< Single client mode (dynamic input/outputs as needed by plugins).
    ENGINE_PROCESS_MODE_MULTIPLE_CLIENTS = 1, //!< Multiple client mode (1 master client + 1 client per plugin).
    ENGINE_PROCESS_MODE_CONTINUOUS_RACK  = 2, //!< Single client, 'rack' mode. Processes plugins in order of Id, with forced stereo.
    ENGINE_PROCESS_MODE_PATCHBAY         = 3, //!< Single client, 'patchbay' mode.
    ENGINE_PROCESS_MODE_BRIDGE           = 4  //!< Special mode, used in plugin-bridges only.
};

/*!
 * All the available transport modes
 */
enum EngineTransportMode SIZE_INT {
    ENGINE_TRANSPORT_MODE_INTERNAL = 0, //!< Internal transport mode.
    ENGINE_TRANSPORT_MODE_JACK     = 1, //!< Transport from JACK, only available if driver name is "JACK".
    ENGINE_TRANSPORT_MODE_PLUGIN   = 2, //!< Transport from host, used when Carla is a plugin.
    ENGINE_TRANSPORT_MODE_BRIDGE   = 3  //!< Special mode, used in plugin-bridges only.
};

/*!
 * Opcodes sent from the backend to the frontend, asking for file related tasks.
 */
enum FileCallbackOpcode SIZE_INT {
    /*!
     * Debug.\n
     * This opcode is undefined and used only for testing purposes.
     */
    FILE_CALLBACK_DEBUG = 0,

    /*!
     * Open file or folder.
     */
    FILE_CALLBACK_OPEN = 1,

    /*!
     * Save file or folder.
     */
    FILE_CALLBACK_SAVE = 2
};

/*!
 * Engine callback function.
 * \see EngineCallbackType
 */
typedef void (*EngineCallbackFunc)(void* ptr, EngineCallbackOpcode action, unsigned int pluginId, int value1, int value2, float value3, const char* valueStr);

/*!
 * File callback function.
 * \see FileCallbackType
 */
typedef const char* (*FileCallbackFunc)(void* ptr, FileCallbackOpcode action, bool isDir, const char* title, const char* filter);

/*!
 * Parameter data.
 */
struct ParameterData {
    ParameterType type;
    int32_t  index;
    int32_t  rindex;
    unsigned int hints;
    uint8_t  midiChannel;
    int16_t  midiCC;

#ifndef DOXYGEN
    ParameterData() noexcept
        : type(PARAMETER_UNKNOWN),
          index(PARAMETER_NULL),
          rindex(-1),
          hints(0x0),
          midiChannel(0),
          midiCC(-1) {}
#endif
};

/*!
 * Parameter ranges.
 */
struct ParameterRanges {
    float def;
    float min;
    float max;
    float step;
    float stepSmall;
    float stepLarge;

#ifndef DOXYGEN
    ParameterRanges() noexcept
        : def(0.0f),
          min(0.0f),
          max(1.0f),
          step(0.01f),
          stepSmall(0.0001f),
          stepLarge(0.1f) {}
#endif

    void fixDefault() noexcept
    {
        fixValue(def);
    }

    void fixValue(float& value) const noexcept
    {
        if (value <= min)
            value = min;
        else if (value > max)
            value = max;
    }

    float getFixedValue(const float& value) const noexcept
    {
        if (value <= min)
            return min;
        if (value >= max)
            return max;
        return value;
    }

    float getNormalizedValue(const float& value) const noexcept
    {
        const float normValue((value - min) / (max - min));

        if (normValue <= 0.0f)
            return 0.0f;
        if (normValue >= 1.0f)
            return 1.0f;
        return normValue;
    }

    float getFixedAndNormalizedValue(const float& value) const noexcept
    {
        if (value <= min)
            return 0.0f;
        if (value >= max)
            return 1.0f;

        const float normValue((value - min) / (max - min));

        if (normValue <= 0.0f)
            return 0.0f;
        if (normValue >= 1.0f)
            return 1.0f;

        return normValue;
    }

    float getUnnormalizedValue(const float& value) const noexcept
    {
        return value * (max - min) + min;
    }
};

/*!
 * MIDI Program data.
 */
struct MidiProgramData {
    uint32_t bank;
    uint32_t program;
    const char* name;

#ifndef DOXYGEN
    MidiProgramData() noexcept
        : bank(0),
          program(0),
          name(nullptr) {}
#endif
};

/*!
 * Custom data, for saving key:value 'dictionaries'.\n
 * \a type is an URI which defines the \a value type.
 * \see CustomDataTypes
 */
struct CustomData {
    const char* type;
    const char* key;
    const char* value;

#ifndef DOXYGEN
    CustomData() noexcept
        : type(nullptr),
          key(nullptr),
          value(nullptr) {}
#endif
};

/*!
 * Engine driver device information.
 */
struct EngineDriverDeviceInfo {
    unsigned int hints;
    const uint32_t* bufferSizes; // terminated with 0
    const double* sampleRates;   // terminated with 0.0

#ifndef DOXYGEN
    EngineDriverDeviceInfo()
        : hints(0x0),
          bufferSizes(nullptr),
          sampleRates(nullptr) {}
#endif
};

/**@}*/

// forward declarations of commonly used Carla classes
class CarlaEngine;
class CarlaPlugin;

CARLA_BACKEND_END_NAMESPACE

#undef SIZE_INT

#endif // CARLA_BACKEND_HPP_INCLUDED