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.
56 Commits
16 Branches
498MB
Tree: d571d368fe
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'd571d368fe'
${ noResults }
Carla/source/backend/carla_standalone.hpp

231 lines
8.4KB
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 "carla_backend.hpp"

  22. 

  23. // TODO - create struct for internal plugin info

  24. // TODO - dont strdup() on const-char* returns, use static char[STR_MAX]

  25. 

  26. /*!

  27.  * @defgroup CarlaBackendStandalone Carla Backend Standalone

  28.  *

  29.  * The Carla Backend Standalone API

  30.  *

  31.  * @{

  32.  */

  33. 

  34. typedef CarlaBackend::BinaryType CarlaBinaryType;

  35. typedef CarlaBackend::PluginType CarlaPluginType;

  36. typedef CarlaBackend::PluginCategory CarlaPluginCategory;

  37. typedef CarlaBackend::OptionsType CarlaOptionsType;

  38. typedef CarlaBackend::CallbackFunc CarlaCallbackFunc;

  39. 

  40. struct CarlaPluginInfo {

  41.     CarlaPluginType type;

  42.     CarlaPluginCategory category;

  43.     unsigned int hints;

  44.     const char* binary;

  45.     const char* name;

  46.     const char* label;

  47.     const char* maker;

  48.     const char* copyright;

  49.     long uniqueId;

  50. 

  51.     CarlaPluginInfo()

  52.         : type(CarlaBackend::PLUGIN_NONE),

  53.           category(CarlaBackend::PLUGIN_CATEGORY_NONE),

  54.           hints(0x0),

  55.           binary(nullptr),

  56.           name(nullptr),

  57.           label(nullptr),

  58.           maker(nullptr),

  59.           copyright(nullptr),

  60.           uniqueId(0) {}

  61. 

  62.     ~CarlaPluginInfo()

  63.     {

  64.         std::free((void*)label);

  65.         std::free((void*)maker);

  66.         std::free((void*)copyright);

  67.     }

  68. };

  69. 

  70. struct CarlaNativePluginInfo {

  71.     CarlaPluginCategory category;

  72.     unsigned int hints;

  73.     uint32_t audioIns;

  74.     uint32_t audioOuts;

  75.     uint32_t midiIns;

  76.     uint32_t midiOuts;

  77.     uint32_t parameterIns;

  78.     uint32_t parameterOuts;

  79.     const char* name;

  80.     const char* label;

  81.     const char* maker;

  82.     const char* copyright;

  83. 

  84.     CarlaNativePluginInfo()

  85.         : category(CarlaBackend::PLUGIN_CATEGORY_NONE),

  86.           hints(0x0),

  87.           audioIns(0),

  88.           audioOuts(0),

  89.           midiIns(0),

  90.           midiOuts(0),

  91.           parameterIns(0),

  92.           parameterOuts(0),

  93.           name(nullptr),

  94.           label(nullptr),

  95.           maker(nullptr),

  96.           copyright(nullptr) {}

  97. };

  98. 

  99. struct CarlaPortCountInfo {

  100.     uint32_t ins;

  101.     uint32_t outs;

  102.     uint32_t total;

  103. 

  104.     CarlaPortCountInfo()

  105.         : ins(0),

  106.           outs(0),

  107.           total(0) {}

  108. };

  109. 

  110. struct CarlaParameterInfo {

  111.     const char* name;

  112.     const char* symbol;

  113.     const char* unit;

  114.     uint32_t scalePointCount;

  115. 

  116.     CarlaParameterInfo()

  117.         : name(nullptr),

  118.           symbol(nullptr),

  119.           unit(nullptr),

  120.           scalePointCount(0) {}

  121. 

  122.     ~CarlaParameterInfo()

  123.     {

  124.         std::free((void*)name);

  125.         std::free((void*)symbol);

  126.         std::free((void*)unit);

  127.     }

  128. };

  129. 

  130. struct CarlaScalePointInfo {

  131.     float value;

  132.     const char* label;

  133. 

  134.     CarlaScalePointInfo()

  135.         : value(0.0f),

  136.           label(nullptr) {}

  137. 

  138.     ~CarlaScalePointInfo()

  139.     {

  140.         std::free((void*)label);

  141.     }

  142. };

  143. 

  144. CARLA_EXPORT const char* carla_get_extended_license_text();

  145. 

  146. CARLA_EXPORT unsigned int carla_get_engine_driver_count();

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

  148. 

  149. CARLA_EXPORT unsigned int carla_get_internal_plugin_count();

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

  151. 

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

  153. CARLA_EXPORT bool carla_engine_close();

  154. CARLA_EXPORT bool carla_is_engine_running();

  155. 

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

  157. CARLA_EXPORT bool carla_remove_plugin(unsigned int pluginId);

  158. 

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

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

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

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

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

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

  165. 

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

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

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

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

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

  171. 

  172. CARLA_EXPORT uint32_t carla_get_parameter_count(unsigned int pluginId);

  173. CARLA_EXPORT uint32_t carla_get_program_count(unsigned int pluginId);

  174. CARLA_EXPORT uint32_t carla_get_midi_program_count(unsigned int pluginId);

  175. CARLA_EXPORT uint32_t carla_get_custom_data_count(unsigned int pluginId);

  176. 

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

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

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

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

  181. 

  182. CARLA_EXPORT int32_t carla_get_current_program_index(unsigned int pluginId);

  183. CARLA_EXPORT int32_t carla_get_current_midi_program_index(unsigned int pluginId);

  184. 

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

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

  187. 

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

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

  190. 

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

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

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

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

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

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

  197. 

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

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

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

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

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

  203. 

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

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

  206. 

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

  208. CARLA_EXPORT void carla_idle_guis();

  209. 

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

  211. CARLA_EXPORT void carla_prepare_for_save(unsigned int pluginId);

  212. 

  213. CARLA_EXPORT uint32_t carla_get_buffer_size();

  214. CARLA_EXPORT double   carla_get_sample_rate();

  215. 

  216. CARLA_EXPORT const char* carla_get_last_error();

  217. CARLA_EXPORT const char* carla_get_host_osc_url();

  218. 

  219. CARLA_EXPORT void carla_set_callback_function(CarlaCallbackFunc func);

  220. CARLA_EXPORT void carla_set_option(CarlaOptionsType option, int value, const char* valueStr);

  221. 

  222. #if 0

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

  224. CARLA_EXPORT void carla_nsm_reply_open();

  225. CARLA_EXPORT void carla_nsm_reply_save();

  226. #endif

  227. 

  228. /**@}*/

  229. 

  230. #endif // __CARLA_STANDALONE_HPP__