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.

243 lines
8.8KB

  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. #ifndef __CARLA_STANDALONE_HPP__
  18. #define __CARLA_STANDALONE_HPP__
  19. #include "CarlaBackend.hpp"
  20. /*!
  21. * @defgroup CarlaBackendStandalone Carla Backend Standalone
  22. *
  23. * The Carla Backend Standalone API
  24. *
  25. * @{
  26. */
  27. typedef CarlaBackend::BinaryType CarlaBinaryType;
  28. typedef CarlaBackend::PluginType CarlaPluginType;
  29. typedef CarlaBackend::PluginCategory CarlaPluginCategory;
  30. typedef CarlaBackend::OptionsType CarlaOptionsType;
  31. typedef CarlaBackend::CallbackFunc CarlaCallbackFunc;
  32. struct CarlaPluginInfo {
  33. CarlaPluginType type;
  34. CarlaPluginCategory category;
  35. unsigned int hints;
  36. const char* binary;
  37. const char* name;
  38. const char* label;
  39. const char* maker;
  40. const char* copyright;
  41. long uniqueId;
  42. uint32_t latency;
  43. CarlaPluginInfo()
  44. : type(CarlaBackend::PLUGIN_NONE),
  45. category(CarlaBackend::PLUGIN_CATEGORY_NONE),
  46. hints(0x0),
  47. binary(nullptr),
  48. name(nullptr),
  49. label(nullptr),
  50. maker(nullptr),
  51. copyright(nullptr),
  52. uniqueId(0),
  53. latency(0) {}
  54. ~CarlaPluginInfo()
  55. {
  56. if (label != nullptr)
  57. delete[] label;
  58. if (maker != nullptr)
  59. delete[] maker;
  60. if (copyright != nullptr)
  61. delete[] copyright;
  62. }
  63. };
  64. struct CarlaNativePluginInfo {
  65. CarlaPluginCategory category;
  66. unsigned int hints;
  67. uint32_t audioIns;
  68. uint32_t audioOuts;
  69. uint32_t midiIns;
  70. uint32_t midiOuts;
  71. uint32_t parameterIns;
  72. uint32_t parameterOuts;
  73. const char* name;
  74. const char* label;
  75. const char* maker;
  76. const char* copyright;
  77. CarlaNativePluginInfo()
  78. : category(CarlaBackend::PLUGIN_CATEGORY_NONE),
  79. hints(0x0),
  80. audioIns(0),
  81. audioOuts(0),
  82. midiIns(0),
  83. midiOuts(0),
  84. parameterIns(0),
  85. parameterOuts(0),
  86. name(nullptr),
  87. label(nullptr),
  88. maker(nullptr),
  89. copyright(nullptr) {}
  90. };
  91. struct CarlaPortCountInfo {
  92. uint32_t ins;
  93. uint32_t outs;
  94. uint32_t total;
  95. CarlaPortCountInfo()
  96. : ins(0),
  97. outs(0),
  98. total(0) {}
  99. };
  100. struct CarlaParameterInfo {
  101. const char* name;
  102. const char* symbol;
  103. const char* unit;
  104. uint32_t scalePointCount;
  105. CarlaParameterInfo()
  106. : name(nullptr),
  107. symbol(nullptr),
  108. unit(nullptr),
  109. scalePointCount(0) {}
  110. ~CarlaParameterInfo()
  111. {
  112. if (name != nullptr)
  113. delete[] name;
  114. if (symbol != nullptr)
  115. delete[] symbol;
  116. if (unit != nullptr)
  117. delete[] unit;
  118. }
  119. };
  120. struct CarlaScalePointInfo {
  121. float value;
  122. const char* label;
  123. CarlaScalePointInfo()
  124. : value(0.0f),
  125. label(nullptr) {}
  126. ~CarlaScalePointInfo()
  127. {
  128. if (label != nullptr)
  129. delete[] label;
  130. }
  131. };
  132. CARLA_EXPORT const char* carla_get_extended_license_text();
  133. CARLA_EXPORT unsigned int carla_get_engine_driver_count();
  134. CARLA_EXPORT const char* carla_get_engine_driver_name(unsigned int index);
  135. CARLA_EXPORT unsigned int carla_get_internal_plugin_count();
  136. CARLA_EXPORT const CarlaNativePluginInfo* carla_get_internal_plugin_info(unsigned int internalPluginId);
  137. CARLA_EXPORT bool carla_engine_init(const char* driverName, const char* clientName);
  138. CARLA_EXPORT bool carla_engine_close();
  139. CARLA_EXPORT void carla_engine_idle();
  140. CARLA_EXPORT bool carla_is_engine_running();
  141. CARLA_EXPORT bool carla_load_project(const char* filename);
  142. CARLA_EXPORT bool carla_save_project(const char* filename);
  143. CARLA_EXPORT bool carla_add_plugin(CarlaBinaryType btype, CarlaPluginType ptype, const char* filename, const char* name, const char* label, void* extraPtr);
  144. CARLA_EXPORT bool carla_remove_plugin(unsigned int pluginId);
  145. CARLA_EXPORT void carla_remove_all_plugins();
  146. //CARLA_EXPORT bool carla_load_plugin_state(unsigned int pluginId, const char* filename);
  147. //CARLA_EXPORT bool carla_save_plugin_state(unsigned int pluginId, const char* filename);
  148. CARLA_EXPORT const CarlaPluginInfo* carla_get_plugin_info(unsigned int pluginId);
  149. CARLA_EXPORT const CarlaPortCountInfo* carla_get_audio_port_count_info(unsigned int pluginId);
  150. CARLA_EXPORT const CarlaPortCountInfo* carla_get_midi_port_count_info(unsigned int pluginId);
  151. CARLA_EXPORT const CarlaPortCountInfo* carla_get_parameter_count_info(unsigned int pluginId);
  152. CARLA_EXPORT const CarlaParameterInfo* carla_get_parameter_info(unsigned int pluginId, uint32_t parameterId);
  153. CARLA_EXPORT const CarlaScalePointInfo* carla_get_parameter_scalepoint_info(unsigned int pluginId, uint32_t parameterId, uint32_t scalePointId);
  154. CARLA_EXPORT const CarlaBackend::ParameterData* carla_get_parameter_data(unsigned int pluginId, uint32_t parameterId);
  155. CARLA_EXPORT const CarlaBackend::ParameterRanges* carla_get_parameter_ranges(unsigned int pluginId, uint32_t parameterId);
  156. CARLA_EXPORT const CarlaBackend::MidiProgramData* carla_get_midi_program_data(unsigned int pluginId, uint32_t midiProgramId);
  157. CARLA_EXPORT const CarlaBackend::CustomData* carla_get_custom_data(unsigned int pluginId, uint32_t customDataId);
  158. CARLA_EXPORT const char* carla_get_chunk_data(unsigned int pluginId);
  159. CARLA_EXPORT uint32_t carla_get_parameter_count(unsigned int pluginId);
  160. CARLA_EXPORT uint32_t carla_get_program_count(unsigned int pluginId);
  161. CARLA_EXPORT uint32_t carla_get_midi_program_count(unsigned int pluginId);
  162. CARLA_EXPORT uint32_t carla_get_custom_data_count(unsigned int pluginId);
  163. CARLA_EXPORT const char* carla_get_parameter_text(unsigned int pluginId, uint32_t parameterId);
  164. CARLA_EXPORT const char* carla_get_program_name(unsigned int pluginId, uint32_t programId);
  165. CARLA_EXPORT const char* carla_get_midi_program_name(unsigned int pluginId, uint32_t midiProgramId);
  166. CARLA_EXPORT const char* carla_get_real_plugin_name(unsigned int pluginId);
  167. CARLA_EXPORT int32_t carla_get_current_program_index(unsigned int pluginId);
  168. CARLA_EXPORT int32_t carla_get_current_midi_program_index(unsigned int pluginId);
  169. CARLA_EXPORT float carla_get_default_parameter_value(unsigned int pluginId, uint32_t parameterId);
  170. CARLA_EXPORT float carla_get_current_parameter_value(unsigned int pluginId, uint32_t parameterId);
  171. CARLA_EXPORT float carla_get_input_peak_value(unsigned int pluginId, unsigned short portId);
  172. CARLA_EXPORT float carla_get_output_peak_value(unsigned int pluginId, unsigned short portId);
  173. CARLA_EXPORT void carla_set_active(unsigned int pluginId, bool onOff);
  174. CARLA_EXPORT void carla_set_drywet(unsigned int pluginId, float value);
  175. CARLA_EXPORT void carla_set_volume(unsigned int pluginId, float value);
  176. CARLA_EXPORT void carla_set_balance_left(unsigned int pluginId, float value);
  177. CARLA_EXPORT void carla_set_balance_right(unsigned int pluginId, float value);
  178. CARLA_EXPORT void carla_set_panning(unsigned int pluginId, float value);
  179. CARLA_EXPORT void carla_set_parameter_value(unsigned int pluginId, uint32_t parameterId, float value);
  180. CARLA_EXPORT void carla_set_parameter_midi_channel(unsigned int pluginId, uint32_t parameterId, uint8_t channel);
  181. CARLA_EXPORT void carla_set_parameter_midi_cc(unsigned int pluginId, uint32_t parameterId, int16_t cc);
  182. CARLA_EXPORT void carla_set_program(unsigned int pluginId, uint32_t programId);
  183. CARLA_EXPORT void carla_set_midi_program(unsigned int pluginId, uint32_t midiProgramId);
  184. CARLA_EXPORT void carla_set_custom_data(unsigned int pluginId, const char* type, const char* key, const char* value);
  185. CARLA_EXPORT void carla_set_chunk_data(unsigned int pluginId, const char* chunkData);
  186. CARLA_EXPORT void carla_prepare_for_save(unsigned int pluginId);
  187. CARLA_EXPORT void carla_send_midi_note(unsigned int pluginId, uint8_t channel, uint8_t note, uint8_t velocity);
  188. CARLA_EXPORT void carla_show_gui(unsigned int pluginId, bool yesNo);
  189. CARLA_EXPORT uint32_t carla_get_buffer_size();
  190. CARLA_EXPORT double carla_get_sample_rate();
  191. CARLA_EXPORT const char* carla_get_last_error();
  192. CARLA_EXPORT const char* carla_get_host_osc_url();
  193. CARLA_EXPORT void carla_set_callback_function(CarlaCallbackFunc func);
  194. CARLA_EXPORT void carla_set_option(CarlaOptionsType option, int value, const char* valueStr);
  195. #if 0
  196. CARLA_EXPORT void carla_nsm_announce(const char* url, int pid);
  197. CARLA_EXPORT void carla_nsm_reply_open();
  198. CARLA_EXPORT void carla_nsm_reply_save();
  199. #endif
  200. /**@}*/
  201. #endif // __CARLA_STANDALONE_HPP__