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.

282 lines
11KB

  1. /*
  2. * Carla Bridge utils
  3. * Copyright (C) 2013-2014 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 doc/GPL.txt file.
  16. */
  17. #ifndef CARLA_BRIDGE_UTILS_HPP_INCLUDED
  18. #define CARLA_BRIDGE_UTILS_HPP_INCLUDED
  19. #include "CarlaRingBuffer.hpp"
  20. // -----------------------------------------------------------------------
  21. // carla-plugin receives these via osc
  22. enum PluginBridgeOscInfoType {
  23. kPluginBridgeOscNull = 0,
  24. kPluginBridgeOscPong,
  25. kPluginBridgeOscPluginInfo1, // uuuuh => category, hints, optionsAvailable, optionsEnabled, uniqueId
  26. kPluginBridgeOscPluginInfo2, // ssss => realName, label, maker, copyright
  27. kPluginBridgeOscAudioCount, // uu => ins, outs
  28. kPluginBridgeOscMidiCount, // uu => ins, outs
  29. kPluginBridgeOscParameterCount, // uu => ins, outs
  30. kPluginBridgeOscProgramCount, // u => count
  31. kPluginBridgeOscMidiProgramCount, // u => count
  32. kPluginBridgeOscParameterData1, // uiuui => index, rindex, type, hints, cc
  33. kPluginBridgeOscParameterData2, // uss => index, name, unit
  34. kPluginBridgeOscParameterRanges1, // ufff => index, def, min, max
  35. kPluginBridgeOscParameterRanges2, // ufff => index, step, stepSmall, stepLarge
  36. kPluginBridgeOscParameterValue, // uf => index, value
  37. kPluginBridgeOscDefaultValue, // uf => index, value
  38. kPluginBridgeOscCurrentProgram, // i => index
  39. kPluginBridgeOscCurrentMidiProgram, // i => index
  40. kPluginBridgeOscProgramName, // us => index, name
  41. kPluginBridgeOscMidiProgramData, // uuus => index, bank, program, name
  42. kPluginBridgeOscConfigure, // ss => key, value
  43. kPluginBridgeOscSetCustomData, // sss => type, key, value
  44. kPluginBridgeOscSetChunkDataFile, // s => chunkFile
  45. kPluginBridgeOscLatency, // u => value
  46. kPluginBridgeOscReady,
  47. kPluginBridgeOscError
  48. };
  49. // carla-plugin sends these during RT
  50. enum PluginBridgeRtOpcode {
  51. kPluginBridgeRtNull = 0,
  52. kPluginBridgeRtSetAudioPool, // ulong/ptr
  53. kPluginBridgeRtSetParameter, // uint, float
  54. kPluginBridgeRtSetProgram, // int
  55. kPluginBridgeRtSetMidiProgram, // int
  56. kPluginBridgeRtMidiEvent, // uint/frame, uint/size, char[]
  57. kPluginBridgeRtAllSoundOff, // uint/frame
  58. kPluginBridgeRtAllNotesOff, // uint/frame
  59. kPluginBridgeRtProcess
  60. };
  61. // carla-plugin sends these during non-RT
  62. enum PluginBridgeNonRtOpcode {
  63. kPluginBridgeNonRtNull = 0,
  64. kPluginBridgeNonRtPing,
  65. kPluginBridgeNonRtActivate,
  66. kPluginBridgeNonRtDeactivate,
  67. kPluginBridgeNonRtSetBufferSize, // uint
  68. kPluginBridgeNonRtSetSampleRate, // double
  69. kPluginBridgeNonRtSetOffline,
  70. kPluginBridgeNonRtSetOnline,
  71. kPluginBridgeNonRtSetParameterValue, // uint, float
  72. kPluginBridgeNonRtSetProgram, // int
  73. kPluginBridgeNonRtSetMidiProgram, // int
  74. kPluginBridgeNonRtSetCustomData, // uint/size, str, uint/size, str, uint/size, str
  75. kPluginBridgeNonRtSetChunkDataFile, // uint/size, str/file
  76. kPluginBridgeNonRtPrepareForSave,
  77. kPluginBridgeNonRtShowUI,
  78. kPluginBridgeNonRtHideUI,
  79. kPluginBridgeNonRtUiParameterChange, // uint, float
  80. kPluginBridgeNonRtUiProgramChange, // uint
  81. kPluginBridgeNonRtUiMidiProgramChange, // uint
  82. kPluginBridgeNonRtUiNoteOn, // byte, byte, byte
  83. kPluginBridgeNonRtUiNoteOff, // byte, byte
  84. kPluginBridgeNonRtQuit
  85. };
  86. // -----------------------------------------------------------------------
  87. const char* const CARLA_BRIDGE_MSG_HIDE_GUI = "CarlaBridgeHideGUI"; //!< Plugin -> Host configure, tells host GUI is now hidden
  88. const char* const CARLA_BRIDGE_MSG_SAVED = "CarlaBridgeSaved"; //!< Plugin -> Host configure, tells host state is saved
  89. // -----------------------------------------------------------------------
  90. struct BridgeSemaphore {
  91. union {
  92. void* server;
  93. char _padServer[32];
  94. };
  95. union {
  96. void* client;
  97. char _padClient[32];
  98. };
  99. };
  100. struct BridgeTimeInfo {
  101. bool playing;
  102. uint64_t frame;
  103. uint64_t usecs;
  104. uint valid;
  105. // bbt
  106. int32_t bar, beat, tick;
  107. float beatsPerBar, beatType;
  108. double barStartTick, ticksPerBeat, beatsPerMinute;
  109. };
  110. struct BridgeRtData {
  111. BridgeSemaphore sem;
  112. BridgeTimeInfo timeInfo;
  113. StackBuffer ringBuffer;
  114. };
  115. struct BridgeNonRtData {
  116. BigStackBuffer ringBuffer;
  117. };
  118. // -----------------------------------------------------------------------
  119. static inline
  120. const char* PluginBridgeOscInfoType2str(const PluginBridgeOscInfoType type) noexcept
  121. {
  122. switch (type)
  123. {
  124. case kPluginBridgeOscNull:
  125. return "kPluginBridgeOscNull";
  126. case kPluginBridgeOscPong:
  127. return "kPluginBridgeOscPong";
  128. case kPluginBridgeOscPluginInfo1:
  129. return "kPluginBridgeOscPluginInfo1";
  130. case kPluginBridgeOscPluginInfo2:
  131. return "kPluginBridgeOscPluginInfo2";
  132. case kPluginBridgeOscAudioCount:
  133. return "kPluginBridgeOscAudioCount";
  134. case kPluginBridgeOscMidiCount:
  135. return "kPluginBridgeOscMidiCount";
  136. case kPluginBridgeOscParameterCount:
  137. return "kPluginBridgeOscParameterCount";
  138. case kPluginBridgeOscProgramCount:
  139. return "kPluginBridgeOscProgramCount";
  140. case kPluginBridgeOscMidiProgramCount:
  141. return "kPluginBridgeOscMidiProgramCount";
  142. case kPluginBridgeOscParameterData1:
  143. return "kPluginBridgeOscParameterData1";
  144. case kPluginBridgeOscParameterData2:
  145. return "kPluginBridgeOscParameterData2";
  146. case kPluginBridgeOscParameterRanges1:
  147. return "kPluginBridgeOscParameterRanges1";
  148. case kPluginBridgeOscParameterRanges2:
  149. return "kPluginBridgeOscParameterRanges2";
  150. case kPluginBridgeOscParameterValue:
  151. return "kPluginBridgeOscParameterValue";
  152. case kPluginBridgeOscDefaultValue:
  153. return "kPluginBridgeOscDefaultValue";
  154. case kPluginBridgeOscCurrentProgram:
  155. return "kPluginBridgeOscCurrentProgram";
  156. case kPluginBridgeOscCurrentMidiProgram:
  157. return "kPluginBridgeOscCurrentMidiProgram";
  158. case kPluginBridgeOscProgramName:
  159. return "kPluginBridgeOscProgramName";
  160. case kPluginBridgeOscMidiProgramData:
  161. return "kPluginBridgeOscMidiProgramData";
  162. case kPluginBridgeOscConfigure:
  163. return "kPluginBridgeOscConfigure";
  164. case kPluginBridgeOscSetCustomData:
  165. return "kPluginBridgeOscSetCustomData";
  166. case kPluginBridgeOscSetChunkDataFile:
  167. return "kPluginBridgeOscSetChunkDataFile";
  168. case kPluginBridgeOscLatency:
  169. return "kPluginBridgeOscLatency";
  170. case kPluginBridgeOscReady:
  171. return "kPluginBridgeOscReady";
  172. case kPluginBridgeOscError:
  173. return "kPluginBridgeOscError";
  174. }
  175. carla_stderr("CarlaBackend::PluginBridgeOscInfoType2str(%i) - invalid type", type);
  176. return nullptr;
  177. }
  178. static inline
  179. const char* PluginBridgeRtOpcode2str(const PluginBridgeRtOpcode opcode) noexcept
  180. {
  181. switch (opcode)
  182. {
  183. case kPluginBridgeRtNull:
  184. return "kPluginBridgeRtNull";
  185. case kPluginBridgeRtSetAudioPool:
  186. return "kPluginBridgeRtSetAudioPool";
  187. case kPluginBridgeRtSetParameter:
  188. return "kPluginBridgeRtSetParameter";
  189. case kPluginBridgeRtSetProgram:
  190. return "kPluginBridgeRtSetProgram";
  191. case kPluginBridgeRtSetMidiProgram:
  192. return "kPluginBridgeRtSetMidiProgram";
  193. case kPluginBridgeRtMidiEvent:
  194. return "kPluginBridgeRtMidiEvent";
  195. case kPluginBridgeRtAllSoundOff:
  196. return "kPluginBridgeRtAllSoundOff";
  197. case kPluginBridgeRtAllNotesOff:
  198. return "kPluginBridgeRtAllNotesOff";
  199. case kPluginBridgeRtProcess:
  200. return "kPluginBridgeRtProcess";
  201. }
  202. carla_stderr("CarlaBackend::PluginBridgeRtOpcode2str(%i) - invalid opcode", opcode);
  203. return nullptr;
  204. }
  205. static inline
  206. const char* PluginBridgeNonRtOpcode2str(const PluginBridgeNonRtOpcode opcode) noexcept
  207. {
  208. switch (opcode)
  209. {
  210. case kPluginBridgeNonRtNull:
  211. return "kPluginBridgeNonRtNull";
  212. case kPluginBridgeNonRtPing:
  213. return "kPluginBridgeNonRtPing";
  214. case kPluginBridgeNonRtActivate:
  215. return "kPluginBridgeNonRtActivate";
  216. case kPluginBridgeNonRtDeactivate:
  217. return "kPluginBridgeNonRtDeactivate";
  218. case kPluginBridgeNonRtSetBufferSize:
  219. return "kPluginBridgeNonRtSetBufferSize";
  220. case kPluginBridgeNonRtSetSampleRate:
  221. return "kPluginBridgeNonRtSetSampleRate";
  222. case kPluginBridgeNonRtSetOffline:
  223. return "kPluginBridgeNonRtSetOffline";
  224. case kPluginBridgeNonRtSetOnline:
  225. return "kPluginBridgeNonRtSetOnline";
  226. case kPluginBridgeNonRtSetParameterValue:
  227. return "kPluginBridgeNonRtSetParameterValue";
  228. case kPluginBridgeNonRtSetProgram:
  229. return "kPluginBridgeNonRtSetProgram";
  230. case kPluginBridgeNonRtSetMidiProgram:
  231. return "kPluginBridgeNonRtSetMidiProgram";
  232. case kPluginBridgeNonRtSetCustomData:
  233. return "kPluginBridgeNonRtSetCustomData";
  234. case kPluginBridgeNonRtSetChunkDataFile:
  235. return "kPluginBridgeNonRtSetChunkDataFile";
  236. case kPluginBridgeNonRtPrepareForSave:
  237. return "kPluginBridgeNonRtPrepareForSave";
  238. case kPluginBridgeNonRtShowUI:
  239. return "kPluginBridgeNonRtShowUI";
  240. case kPluginBridgeNonRtHideUI:
  241. return "kPluginBridgeNonRtHideUI";
  242. case kPluginBridgeNonRtUiParameterChange:
  243. return "kPluginBridgeNonRtUiParameterChange";
  244. case kPluginBridgeNonRtUiProgramChange:
  245. return "kPluginBridgeNonRtUiProgramChange";
  246. case kPluginBridgeNonRtUiMidiProgramChange:
  247. return "kPluginBridgeNonRtUiMidiProgramChange";
  248. case kPluginBridgeNonRtUiNoteOn:
  249. return "kPluginBridgeNonRtUiNoteOn";
  250. case kPluginBridgeNonRtUiNoteOff:
  251. return "kPluginBridgeNonRtUiNoteOff";
  252. case kPluginBridgeNonRtQuit:
  253. return "kPluginBridgeNonRtQuit";
  254. }
  255. carla_stderr("CarlaBackend::PluginBridgeNonRtOpcode2str(%i) - invalid opcode", opcode);
  256. return nullptr;
  257. }
  258. // -----------------------------------------------------------------------
  259. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED