falkTX
/
Carla
mirror of https://github.com/falkTX/Carla
1
0
Fork 0
Code Releases 42 Activity
Audio plugin host https://kx.studio/carla
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
341 Commits
16 Branches
14GB
Tree: e5057a1c48
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'e5057a1c48'
${ noResults }
Carla/source/backend/CarlaStandalone.hpp

298 lines
11KB
Raw Blame History 

  1. /*

  2.  * Carla Standalone API

  3.  * Copyright (C) 2011-2013 Filipe Coelho <falktx@falktx.com>

  4.  *

  5.  * This program is free software; you can redistribute it and/or

  6.  * modify it under the terms of the GNU General Public License as

  7.  * published by the Free Software Foundation; either version 2 of

  8.  * the License, or any later version.

  9.  *

  10.  * This program is distributed in the hope that it will be useful,

  11.  * but WITHOUT ANY WARRANTY; without even the implied warranty of

  12.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

  13.  * GNU General Public License for more details.

  14.  *

  15.  * For a full copy of the GNU General Public License see the GPL.txt file

  16.  */

  17. 

  18. #ifndef __CARLA_STANDALONE_HPP__

  19. #define __CARLA_STANDALONE_HPP__

  20. 

  21. #include "CarlaBackend.hpp"

  22. 

  23. /*!

  24.  * @defgroup CarlaStandaloneAPI Carla Standalone API

  25.  *

  26.  * The Carla  Standalone API

  27.  *

  28.  * @{

  29.  */

  30. 

  31. typedef CarlaBackend::BinaryType CarlaBinaryType;

  32. typedef CarlaBackend::PluginType CarlaPluginType;

  33. typedef CarlaBackend::PluginCategory CarlaPluginCategory;

  34. typedef CarlaBackend::OptionsType CarlaOptionsType;

  35. typedef CarlaBackend::CallbackFunc CarlaCallbackFunc;

  36. 

  37. struct CarlaPluginInfo {

  38.     CarlaPluginType type;

  39.     CarlaPluginCategory category;

  40.     unsigned int hints;

  41.     unsigned int optionsAvailable;

  42.     unsigned int optionsEnabled;

  43.     const char* binary;

  44.     const char* name;

  45.     const char* label;

  46.     const char* maker;

  47.     const char* copyright;

  48.     long uniqueId;

  49.     uint32_t latency;

  50. 

  51.     CarlaPluginInfo()

  52.         : type(CarlaBackend::PLUGIN_NONE),

  53.           category(CarlaBackend::PLUGIN_CATEGORY_NONE),

  54.           hints(0x0),

  55.           optionsAvailable(0x0),

  56.           optionsEnabled(0x0),

  57.           binary(nullptr),

  58.           name(nullptr),

  59.           label(nullptr),

  60.           maker(nullptr),

  61.           copyright(nullptr),

  62.           uniqueId(0),

  63.           latency(0) {}

  64. 

  65.     ~CarlaPluginInfo()

  66.     {

  67.         if (label != nullptr)

  68.             delete[] label;

  69.         if (maker != nullptr)

  70.             delete[] maker;

  71.         if (copyright != nullptr)

  72.             delete[] copyright;

  73.     }

  74. 

  75.     CarlaPluginInfo(CarlaPluginInfo&) = delete;

  76.     CarlaPluginInfo(const CarlaPluginInfo&) = delete;

  77. };

  78. 

  79. struct CarlaNativePluginInfo {

  80.     CarlaPluginCategory category;

  81.     unsigned int hints;

  82.     uint32_t audioIns;

  83.     uint32_t audioOuts;

  84.     uint32_t midiIns;

  85.     uint32_t midiOuts;

  86.     uint32_t parameterIns;

  87.     uint32_t parameterOuts;

  88.     const char* name;

  89.     const char* label;

  90.     const char* maker;

  91.     const char* copyright;

  92. 

  93.     CarlaNativePluginInfo()

  94.         : category(CarlaBackend::PLUGIN_CATEGORY_NONE),

  95.           hints(0x0),

  96.           audioIns(0),

  97.           audioOuts(0),

  98.           midiIns(0),

  99.           midiOuts(0),

  100.           parameterIns(0),

  101.           parameterOuts(0),

  102.           name(nullptr),

  103.           label(nullptr),

  104.           maker(nullptr),

  105.           copyright(nullptr) {}

  106. 

  107.     CarlaNativePluginInfo(CarlaNativePluginInfo&) = delete;

  108.     CarlaNativePluginInfo(const CarlaNativePluginInfo&) = delete;

  109. };

  110. 

  111. struct CarlaPortCountInfo {

  112.     uint32_t ins;

  113.     uint32_t outs;

  114.     uint32_t total;

  115. 

  116.     CarlaPortCountInfo()

  117.         : ins(0),

  118.           outs(0),

  119.           total(0) {}

  120. 

  121.     CarlaPortCountInfo(CarlaPortCountInfo&) = delete;

  122.     CarlaPortCountInfo(const CarlaPortCountInfo&) = delete;

  123. };

  124. 

  125. struct CarlaParameterInfo {

  126.     const char* name;

  127.     const char* symbol;

  128.     const char* unit;

  129.     uint32_t scalePointCount;

  130. 

  131.     CarlaParameterInfo()

  132.         : name(nullptr),

  133.           symbol(nullptr),

  134.           unit(nullptr),

  135.           scalePointCount(0) {}

  136. 

  137.     ~CarlaParameterInfo()

  138.     {

  139.         if (name != nullptr)

  140.             delete[] name;

  141.         if (symbol != nullptr)

  142.             delete[] symbol;

  143.         if (unit != nullptr)

  144.             delete[] unit;

  145.     }

  146. 

  147.     CarlaParameterInfo(CarlaParameterInfo&) = delete;

  148.     CarlaParameterInfo(const CarlaParameterInfo&) = delete;

  149. };

  150. 

  151. struct CarlaScalePointInfo {

  152.     float value;

  153.     const char* label;

  154. 

  155.     CarlaScalePointInfo()

  156.         : value(0.0f),

  157.           label(nullptr) {}

  158. 

  159.     ~CarlaScalePointInfo()

  160.     {

  161.         if (label != nullptr)

  162.             delete[] label;

  163.     }

  164. 

  165.     CarlaScalePointInfo(CarlaScalePointInfo&) = delete;

  166.     CarlaScalePointInfo(const CarlaScalePointInfo&) = delete;

  167. };

  168. 

  169. struct CarlaTransportInfo {

  170.     bool playing;

  171.     uint32_t frame;

  172.     int32_t bar;

  173.     int32_t beat;

  174.     int32_t tick;

  175.     double bpm;

  176. 

  177.     CarlaTransportInfo()

  178.         : playing(false),

  179.           frame(0),

  180.           bar(0),

  181.           beat(0),

  182.           bpm(0.0) {}

  183. 

  184.     CarlaTransportInfo(CarlaTransportInfo&) = delete;

  185.     CarlaTransportInfo(const CarlaTransportInfo&) = delete;

  186. };

  187. 

  188. 

  189. CARLA_EXPORT const char* carla_get_extended_license_text();

  190. CARLA_EXPORT const char* carla_get_supported_file_types();

  191. 

  192. CARLA_EXPORT unsigned int carla_get_engine_driver_count();

  193. CARLA_EXPORT const char* carla_get_engine_driver_name(unsigned int index);

  194. 

  195. CARLA_EXPORT unsigned int carla_get_internal_plugin_count();

  196. CARLA_EXPORT const CarlaNativePluginInfo* carla_get_internal_plugin_info(unsigned int internalPluginId);

  197. 

  198. CARLA_EXPORT bool carla_engine_init(const char* driverName, const char* clientName);

  199. CARLA_EXPORT bool carla_engine_close();

  200. CARLA_EXPORT void carla_engine_idle();

  201. CARLA_EXPORT bool carla_is_engine_running();

  202. CARLA_EXPORT void carla_set_engine_about_to_close();

  203. CARLA_EXPORT void carla_set_engine_callback(CarlaCallbackFunc func, void* ptr);

  204. CARLA_EXPORT void carla_set_engine_option(CarlaOptionsType option, int value, const char* valueStr);

  205. 

  206. CARLA_EXPORT bool carla_load_project(const char* filename);

  207. CARLA_EXPORT bool carla_save_project(const char* filename);

  208. 

  209. CARLA_EXPORT void carla_patchbay_connect(int portA, int portB);

  210. CARLA_EXPORT void carla_patchbay_disconnect(int connectionId);

  211. CARLA_EXPORT void carla_patchbay_refresh();

  212. 

  213. CARLA_EXPORT void carla_transport_play();

  214. CARLA_EXPORT void carla_transport_pause();

  215. CARLA_EXPORT void carla_transport_relocate(uint32_t frames);

  216. CARLA_EXPORT uint32_t carla_get_current_transport_frame();

  217. CARLA_EXPORT const CarlaTransportInfo* carla_get_transport_info();

  218. 

  219. CARLA_EXPORT bool carla_add_plugin(CarlaBinaryType btype, CarlaPluginType ptype, const char* filename, const char* name, const char* label, const void* extraPtr);

  220. CARLA_EXPORT bool carla_remove_plugin(unsigned int pluginId);

  221. CARLA_EXPORT void carla_remove_all_plugins();

  222. 

  223. CARLA_EXPORT bool carla_load_plugin_state(unsigned int pluginId, const char* filename);

  224. CARLA_EXPORT bool carla_save_plugin_state(unsigned int pluginId, const char* filename);

  225. 

  226. CARLA_EXPORT const CarlaPluginInfo* carla_get_plugin_info(unsigned int pluginId);

  227. CARLA_EXPORT const CarlaPortCountInfo* carla_get_audio_port_count_info(unsigned int pluginId);

  228. CARLA_EXPORT const CarlaPortCountInfo* carla_get_midi_port_count_info(unsigned int pluginId);

  229. CARLA_EXPORT const CarlaPortCountInfo* carla_get_parameter_count_info(unsigned int pluginId);

  230. CARLA_EXPORT const CarlaParameterInfo* carla_get_parameter_info(unsigned int pluginId, uint32_t parameterId);

  231. CARLA_EXPORT const CarlaScalePointInfo* carla_get_parameter_scalepoint_info(unsigned int pluginId, uint32_t parameterId, uint32_t scalePointId);

  232. 

  233. CARLA_EXPORT const CarlaBackend::ParameterData* carla_get_parameter_data(unsigned int pluginId, uint32_t parameterId);

  234. CARLA_EXPORT const CarlaBackend::ParameterRanges* carla_get_parameter_ranges(unsigned int pluginId, uint32_t parameterId);

  235. CARLA_EXPORT const CarlaBackend::MidiProgramData* carla_get_midi_program_data(unsigned int pluginId, uint32_t midiProgramId);

  236. CARLA_EXPORT const CarlaBackend::CustomData* carla_get_custom_data(unsigned int pluginId, uint32_t customDataId);

  237. CARLA_EXPORT const char* carla_get_chunk_data(unsigned int pluginId);

  238. 

  239. CARLA_EXPORT uint32_t carla_get_parameter_count(unsigned int pluginId);

  240. CARLA_EXPORT uint32_t carla_get_program_count(unsigned int pluginId);

  241. CARLA_EXPORT uint32_t carla_get_midi_program_count(unsigned int pluginId);

  242. CARLA_EXPORT uint32_t carla_get_custom_data_count(unsigned int pluginId);

  243. 

  244. CARLA_EXPORT const char* carla_get_parameter_text(unsigned int pluginId, uint32_t parameterId);

  245. CARLA_EXPORT const char* carla_get_program_name(unsigned int pluginId, uint32_t programId);

  246. CARLA_EXPORT const char* carla_get_midi_program_name(unsigned int pluginId, uint32_t midiProgramId);

  247. CARLA_EXPORT const char* carla_get_real_plugin_name(unsigned int pluginId);

  248. 

  249. CARLA_EXPORT int32_t carla_get_current_program_index(unsigned int pluginId);

  250. CARLA_EXPORT int32_t carla_get_current_midi_program_index(unsigned int pluginId);

  251. 

  252. CARLA_EXPORT float carla_get_default_parameter_value(unsigned int pluginId, uint32_t parameterId);

  253. CARLA_EXPORT float carla_get_current_parameter_value(unsigned int pluginId, uint32_t parameterId);

  254. 

  255. CARLA_EXPORT float carla_get_input_peak_value(unsigned int pluginId, unsigned short portId);

  256. CARLA_EXPORT float carla_get_output_peak_value(unsigned int pluginId, unsigned short portId);

  257. 

  258. CARLA_EXPORT void carla_set_option(unsigned int pluginId, unsigned int option, bool yesNo);

  259. CARLA_EXPORT void carla_set_active(unsigned int pluginId, bool onOff);

  260. CARLA_EXPORT void carla_set_drywet(unsigned int pluginId, float value);

  261. CARLA_EXPORT void carla_set_volume(unsigned int pluginId, float value);

  262. CARLA_EXPORT void carla_set_balance_left(unsigned int pluginId, float value);

  263. CARLA_EXPORT void carla_set_balance_right(unsigned int pluginId, float value);

  264. CARLA_EXPORT void carla_set_panning(unsigned int pluginId, float value);

  265. CARLA_EXPORT void carla_set_ctrl_channel(unsigned int pluginId, int8_t channel);

  266. 

  267. CARLA_EXPORT void carla_set_parameter_value(unsigned int pluginId, uint32_t parameterId, float value);

  268. CARLA_EXPORT void carla_set_parameter_midi_channel(unsigned int pluginId, uint32_t parameterId, uint8_t channel);

  269. CARLA_EXPORT void carla_set_parameter_midi_cc(unsigned int pluginId, uint32_t parameterId, int16_t cc);

  270. CARLA_EXPORT void carla_set_program(unsigned int pluginId, uint32_t programId);

  271. CARLA_EXPORT void carla_set_midi_program(unsigned int pluginId, uint32_t midiProgramId);

  272. 

  273. CARLA_EXPORT void carla_set_custom_data(unsigned int pluginId, const char* type, const char* key, const char* value);

  274. CARLA_EXPORT void carla_set_chunk_data(unsigned int pluginId, const char* chunkData);

  275. 

  276. CARLA_EXPORT void carla_prepare_for_save(unsigned int pluginId);

  277. CARLA_EXPORT void carla_send_midi_note(unsigned int pluginId, uint8_t channel, uint8_t note, uint8_t velocity);

  278. CARLA_EXPORT void carla_show_gui(unsigned int pluginId, bool yesNo);

  279. 

  280. CARLA_EXPORT uint32_t carla_get_buffer_size();

  281. CARLA_EXPORT double   carla_get_sample_rate();

  282. 

  283. CARLA_EXPORT const char* carla_get_last_error();

  284. CARLA_EXPORT const char* carla_get_host_osc_url();

  285. 

  286. CARLA_EXPORT void carla_nsm_announce(const char* url, int pid);

  287. CARLA_EXPORT void carla_nsm_reply_open();

  288. CARLA_EXPORT void carla_nsm_reply_save();

  289. 

  290. #ifdef BUILD_BRIDGE

  291. CARLA_EXPORT bool carla_engine_init_bridge(const char* audioBaseName, const char* controlBaseName, const char* clientName);

  292. CARLA_EXPORT CarlaBackend::CarlaEngine* carla_get_standalone_engine();

  293. #endif

  294. 

  295. /**@}*/

  296. 

  297. #endif // __CARLA_STANDALONE_HPP__