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.
383 Commits
16 Branches
167MB
Tree: 076fbeb72d
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '076fbeb72d'
${ noResults }
Carla/source/backend/CarlaStandalone.hpp

292 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. #include "CarlaJuceUtils.hpp"

  23. 

  24. /*!

  25.  * @defgroup CarlaStandaloneAPI Carla Standalone API

  26.  *

  27.  * The Carla  Standalone API

  28.  *

  29.  * @{

  30.  */

  31. 

  32. typedef CarlaBackend::BinaryType CarlaBinaryType;

  33. typedef CarlaBackend::PluginType CarlaPluginType;

  34. typedef CarlaBackend::PluginCategory CarlaPluginCategory;

  35. typedef CarlaBackend::OptionsType CarlaOptionsType;

  36. typedef CarlaBackend::CallbackFunc CarlaCallbackFunc;

  37. 

  38. struct CarlaPluginInfo {

  39.     CarlaPluginType type;

  40.     CarlaPluginCategory category;

  41.     unsigned int hints;

  42.     unsigned int optionsAvailable;

  43.     unsigned int optionsEnabled;

  44.     const char* binary;

  45.     const char* name;

  46.     const char* label;

  47.     const char* maker;

  48.     const char* copyright;

  49.     long uniqueId;

  50.     uint32_t latency;

  51. 

  52.     CarlaPluginInfo()

  53.         : type(CarlaBackend::PLUGIN_NONE),

  54.           category(CarlaBackend::PLUGIN_CATEGORY_NONE),

  55.           hints(0x0),

  56.           optionsAvailable(0x0),

  57.           optionsEnabled(0x0),

  58.           binary(nullptr),

  59.           name(nullptr),

  60.           label(nullptr),

  61.           maker(nullptr),

  62.           copyright(nullptr),

  63.           uniqueId(0),

  64.           latency(0) {}

  65. 

  66.     ~CarlaPluginInfo()

  67.     {

  68.         if (label != nullptr)

  69.             delete[] label;

  70.         if (maker != nullptr)

  71.             delete[] maker;

  72.         if (copyright != nullptr)

  73.             delete[] copyright;

  74.     }

  75. 

  76.     CARLA_DECLARE_NON_COPY_STRUCT_WITH_LEAK_DETECTOR(CarlaPluginInfo)

  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.     CARLA_DECLARE_NON_COPY_STRUCT_WITH_LEAK_DETECTOR(CarlaNativePluginInfo)

  108. };

  109. 

  110. struct CarlaPortCountInfo {

  111.     uint32_t ins;

  112.     uint32_t outs;

  113.     uint32_t total;

  114. 

  115.     CarlaPortCountInfo()

  116.         : ins(0),

  117.           outs(0),

  118.           total(0) {}

  119. 

  120.     CARLA_DECLARE_NON_COPY_STRUCT_WITH_LEAK_DETECTOR(CarlaPortCountInfo)

  121. };

  122. 

  123. struct CarlaParameterInfo {

  124.     const char* name;

  125.     const char* symbol;

  126.     const char* unit;

  127.     uint32_t scalePointCount;

  128. 

  129.     CarlaParameterInfo()

  130.         : name(nullptr),

  131.           symbol(nullptr),

  132.           unit(nullptr),

  133.           scalePointCount(0) {}

  134. 

  135.     ~CarlaParameterInfo()

  136.     {

  137.         if (name != nullptr)

  138.             delete[] name;

  139.         if (symbol != nullptr)

  140.             delete[] symbol;

  141.         if (unit != nullptr)

  142.             delete[] unit;

  143.     }

  144. 

  145.     CARLA_DECLARE_NON_COPY_STRUCT_WITH_LEAK_DETECTOR(CarlaParameterInfo)

  146. };

  147. 

  148. struct CarlaScalePointInfo {

  149.     float value;

  150.     const char* label;

  151. 

  152.     CarlaScalePointInfo()

  153.         : value(0.0f),

  154.           label(nullptr) {}

  155. 

  156.     ~CarlaScalePointInfo()

  157.     {

  158.         if (label != nullptr)

  159.             delete[] label;

  160.     }

  161. 

  162.     CARLA_DECLARE_NON_COPY_STRUCT_WITH_LEAK_DETECTOR(CarlaScalePointInfo)

  163. };

  164. 

  165. struct CarlaTransportInfo {

  166.     bool playing;

  167.     uint32_t frame;

  168.     int32_t bar;

  169.     int32_t beat;

  170.     int32_t tick;

  171.     double bpm;

  172. 

  173.     CarlaTransportInfo()

  174.         : playing(false),

  175.           frame(0),

  176.           bar(0),

  177.           beat(0),

  178.           bpm(0.0) {}

  179. 

  180.     CARLA_DECLARE_NON_COPY_STRUCT_WITH_LEAK_DETECTOR(CarlaTransportInfo)

  181. };

  182. 

  183. CARLA_EXPORT const char* carla_get_extended_license_text();

  184. CARLA_EXPORT const char* carla_get_supported_file_types();

  185. 

  186. CARLA_EXPORT unsigned int carla_get_engine_driver_count();

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

  188. 

  189. CARLA_EXPORT unsigned int carla_get_internal_plugin_count();

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

  191. 

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

  193. CARLA_EXPORT bool carla_engine_close();

  194. CARLA_EXPORT void carla_engine_idle();

  195. CARLA_EXPORT bool carla_is_engine_running();

  196. CARLA_EXPORT void carla_set_engine_about_to_close();

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

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

  199. 

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

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

  202. 

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

  204. CARLA_EXPORT void carla_patchbay_disconnect(int connectionId);

  205. CARLA_EXPORT void carla_patchbay_refresh();

  206. 

  207. CARLA_EXPORT void carla_transport_play();

  208. CARLA_EXPORT void carla_transport_pause();

  209. CARLA_EXPORT void carla_transport_relocate(uint32_t frames);

  210. CARLA_EXPORT uint32_t carla_get_current_transport_frame();

  211. CARLA_EXPORT const CarlaTransportInfo* carla_get_transport_info();

  212. 

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

  214. CARLA_EXPORT bool carla_remove_plugin(unsigned int pluginId);

  215. CARLA_EXPORT void carla_remove_all_plugins();

  216. 

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

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

  219. 

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

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

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

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

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

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

  226. 

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

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

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

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

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

  232. 

  233. CARLA_EXPORT uint32_t carla_get_parameter_count(unsigned int pluginId);

  234. CARLA_EXPORT uint32_t carla_get_program_count(unsigned int pluginId);

  235. CARLA_EXPORT uint32_t carla_get_midi_program_count(unsigned int pluginId);

  236. CARLA_EXPORT uint32_t carla_get_custom_data_count(unsigned int pluginId);

  237. 

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

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

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

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

  242. 

  243. CARLA_EXPORT int32_t carla_get_current_program_index(unsigned int pluginId);

  244. CARLA_EXPORT int32_t carla_get_current_midi_program_index(unsigned int pluginId);

  245. 

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

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

  248. 

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

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

  251. 

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

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

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

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

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

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

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

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

  260. 

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

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

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

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

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

  266. 

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

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

  269. 

  270. CARLA_EXPORT void carla_prepare_for_save(unsigned int pluginId);

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

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

  273. 

  274. CARLA_EXPORT uint32_t carla_get_buffer_size();

  275. CARLA_EXPORT double   carla_get_sample_rate();

  276. 

  277. CARLA_EXPORT const char* carla_get_last_error();

  278. CARLA_EXPORT const char* carla_get_host_osc_url();

  279. 

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

  281. CARLA_EXPORT void carla_nsm_reply_open();

  282. CARLA_EXPORT void carla_nsm_reply_save();

  283. 

  284. #ifdef BUILD_BRIDGE

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

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

  287. #endif

  288. 

  289. /**@}*/

  290. 

  291. #endif // __CARLA_STANDALONE_HPP__