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.
228 Commits
16 Branches
3.6GB
Tree: c712e587ca
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'c712e587ca'
${ noResults }
Carla/source/backend/CarlaStandalone.hpp

256 lines
9.5KB
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 CarlaBackendStandalone Carla Backend Standalone

  25.  *

  26.  * The Carla Backend 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. 

  76. struct CarlaNativePluginInfo {

  77.     CarlaPluginCategory category;

  78.     unsigned int hints;

  79.     uint32_t audioIns;

  80.     uint32_t audioOuts;

  81.     uint32_t midiIns;

  82.     uint32_t midiOuts;

  83.     uint32_t parameterIns;

  84.     uint32_t parameterOuts;

  85.     const char* name;

  86.     const char* label;

  87.     const char* maker;

  88.     const char* copyright;

  89. 

  90.     CarlaNativePluginInfo()

  91.         : category(CarlaBackend::PLUGIN_CATEGORY_NONE),

  92.           hints(0x0),

  93.           audioIns(0),

  94.           audioOuts(0),

  95.           midiIns(0),

  96.           midiOuts(0),

  97.           parameterIns(0),

  98.           parameterOuts(0),

  99.           name(nullptr),

  100.           label(nullptr),

  101.           maker(nullptr),

  102.           copyright(nullptr) {}

  103. };

  104. 

  105. struct CarlaPortCountInfo {

  106.     uint32_t ins;

  107.     uint32_t outs;

  108.     uint32_t total;

  109. 

  110.     CarlaPortCountInfo()

  111.         : ins(0),

  112.           outs(0),

  113.           total(0) {}

  114. };

  115. 

  116. struct CarlaParameterInfo {

  117.     const char* name;

  118.     const char* symbol;

  119.     const char* unit;

  120.     uint32_t scalePointCount;

  121. 

  122.     CarlaParameterInfo()

  123.         : name(nullptr),

  124.           symbol(nullptr),

  125.           unit(nullptr),

  126.           scalePointCount(0) {}

  127. 

  128.     ~CarlaParameterInfo()

  129.     {

  130.         if (name != nullptr)

  131.             delete[] name;

  132.         if (symbol != nullptr)

  133.             delete[] symbol;

  134.         if (unit != nullptr)

  135.             delete[] unit;

  136.     }

  137. };

  138. 

  139. struct CarlaScalePointInfo {

  140.     float value;

  141.     const char* label;

  142. 

  143.     CarlaScalePointInfo()

  144.         : value(0.0f),

  145.           label(nullptr) {}

  146. 

  147.     ~CarlaScalePointInfo()

  148.     {

  149.         if (label != nullptr)

  150.             delete[] label;

  151.     }

  152. };

  153. 

  154. CARLA_EXPORT const char* carla_get_extended_license_text();

  155. 

  156. CARLA_EXPORT unsigned int carla_get_engine_driver_count();

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

  158. 

  159. CARLA_EXPORT unsigned int carla_get_internal_plugin_count();

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

  161. 

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

  163. CARLA_EXPORT bool carla_engine_close();

  164. CARLA_EXPORT void carla_engine_idle();

  165. CARLA_EXPORT bool carla_is_engine_running();

  166. CARLA_EXPORT void carla_set_engine_about_to_close();

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

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

  169. 

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

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

  172. 

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

  174. CARLA_EXPORT void carla_patchbay_disconnect(int connectionId);

  175. 

  176. CARLA_EXPORT void carla_transport_play();

  177. CARLA_EXPORT void carla_transport_pause();

  178. CARLA_EXPORT void carla_transport_relocate(uint32_t frames);

  179. 

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

  181. CARLA_EXPORT bool carla_remove_plugin(unsigned int pluginId);

  182. CARLA_EXPORT void carla_remove_all_plugins();

  183. 

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

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

  186. 

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

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

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

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

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

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

  193. 

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

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

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

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

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

  199. 

  200. CARLA_EXPORT uint32_t carla_get_parameter_count(unsigned int pluginId);

  201. CARLA_EXPORT uint32_t carla_get_program_count(unsigned int pluginId);

  202. CARLA_EXPORT uint32_t carla_get_midi_program_count(unsigned int pluginId);

  203. CARLA_EXPORT uint32_t carla_get_custom_data_count(unsigned int pluginId);

  204. 

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

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

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

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

  209. 

  210. CARLA_EXPORT int32_t carla_get_current_program_index(unsigned int pluginId);

  211. CARLA_EXPORT int32_t carla_get_current_midi_program_index(unsigned int pluginId);

  212. 

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

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

  215. 

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

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

  218. 

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

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

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

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

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

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

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

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

  227. 

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

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

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

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

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

  233. 

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

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

  236. 

  237. CARLA_EXPORT void carla_prepare_for_save(unsigned int pluginId);

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

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

  240. 

  241. CARLA_EXPORT uint32_t carla_get_buffer_size();

  242. CARLA_EXPORT double   carla_get_sample_rate();

  243. 

  244. CARLA_EXPORT const char* carla_get_last_error();

  245. CARLA_EXPORT const char* carla_get_host_osc_url();

  246. 

  247. #if 0

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

  249. CARLA_EXPORT void carla_nsm_reply_open();

  250. CARLA_EXPORT void carla_nsm_reply_save();

  251. #endif

  252. 

  253. /**@}*/

  254. 

  255. #endif // __CARLA_STANDALONE_HPP__