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.

288 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. kPluginBridgeRtMidiData, // uint/frame, uint/size, char[]
  55. kPluginBridgeRtMidiBank, // uint/frame, byte/chan, ushort
  56. kPluginBridgeRtMidiProgram, // uint/frame, byte/chan, ushort
  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. kPluginBridgeNonRtSetCtrlChannel, // short
  77. kPluginBridgeNonRtSetOption, // uint/option, bool
  78. kPluginBridgeNonRtPrepareForSave,
  79. kPluginBridgeNonRtShowUI,
  80. kPluginBridgeNonRtHideUI,
  81. kPluginBridgeNonRtUiParameterChange, // uint, float
  82. kPluginBridgeNonRtUiProgramChange, // uint
  83. kPluginBridgeNonRtUiMidiProgramChange, // uint
  84. kPluginBridgeNonRtUiNoteOn, // byte, byte, byte
  85. kPluginBridgeNonRtUiNoteOff, // byte, byte
  86. kPluginBridgeNonRtQuit
  87. };
  88. // -----------------------------------------------------------------------
  89. const char* const CARLA_BRIDGE_MSG_HIDE_GUI = "CarlaBridgeHideGUI"; //!< Plugin -> Host configure, tells host GUI is now hidden
  90. const char* const CARLA_BRIDGE_MSG_SAVED = "CarlaBridgeSaved"; //!< Plugin -> Host configure, tells host state is saved
  91. // -----------------------------------------------------------------------
  92. struct BridgeSemaphore {
  93. union {
  94. void* server;
  95. char _padServer[32];
  96. };
  97. union {
  98. void* client;
  99. char _padClient[32];
  100. };
  101. };
  102. struct BridgeTimeInfo {
  103. bool playing;
  104. uint64_t frame;
  105. uint64_t usecs;
  106. uint valid;
  107. // bbt
  108. int32_t bar, beat, tick;
  109. float beatsPerBar, beatType;
  110. double barStartTick, ticksPerBeat, beatsPerMinute;
  111. };
  112. struct BridgeRtData {
  113. BridgeSemaphore sem;
  114. BridgeTimeInfo timeInfo;
  115. StackBuffer ringBuffer;
  116. };
  117. struct BridgeNonRtData {
  118. BigStackBuffer ringBuffer;
  119. };
  120. // -----------------------------------------------------------------------
  121. static inline
  122. const char* PluginBridgeOscInfoType2str(const PluginBridgeOscInfoType type) noexcept
  123. {
  124. switch (type)
  125. {
  126. case kPluginBridgeOscNull:
  127. return "kPluginBridgeOscNull";
  128. case kPluginBridgeOscPong:
  129. return "kPluginBridgeOscPong";
  130. case kPluginBridgeOscPluginInfo1:
  131. return "kPluginBridgeOscPluginInfo1";
  132. case kPluginBridgeOscPluginInfo2:
  133. return "kPluginBridgeOscPluginInfo2";
  134. case kPluginBridgeOscAudioCount:
  135. return "kPluginBridgeOscAudioCount";
  136. case kPluginBridgeOscMidiCount:
  137. return "kPluginBridgeOscMidiCount";
  138. case kPluginBridgeOscParameterCount:
  139. return "kPluginBridgeOscParameterCount";
  140. case kPluginBridgeOscProgramCount:
  141. return "kPluginBridgeOscProgramCount";
  142. case kPluginBridgeOscMidiProgramCount:
  143. return "kPluginBridgeOscMidiProgramCount";
  144. case kPluginBridgeOscParameterData1:
  145. return "kPluginBridgeOscParameterData1";
  146. case kPluginBridgeOscParameterData2:
  147. return "kPluginBridgeOscParameterData2";
  148. case kPluginBridgeOscParameterRanges1:
  149. return "kPluginBridgeOscParameterRanges1";
  150. case kPluginBridgeOscParameterRanges2:
  151. return "kPluginBridgeOscParameterRanges2";
  152. case kPluginBridgeOscParameterValue:
  153. return "kPluginBridgeOscParameterValue";
  154. case kPluginBridgeOscDefaultValue:
  155. return "kPluginBridgeOscDefaultValue";
  156. case kPluginBridgeOscCurrentProgram:
  157. return "kPluginBridgeOscCurrentProgram";
  158. case kPluginBridgeOscCurrentMidiProgram:
  159. return "kPluginBridgeOscCurrentMidiProgram";
  160. case kPluginBridgeOscProgramName:
  161. return "kPluginBridgeOscProgramName";
  162. case kPluginBridgeOscMidiProgramData:
  163. return "kPluginBridgeOscMidiProgramData";
  164. case kPluginBridgeOscConfigure:
  165. return "kPluginBridgeOscConfigure";
  166. case kPluginBridgeOscSetCustomData:
  167. return "kPluginBridgeOscSetCustomData";
  168. case kPluginBridgeOscSetChunkDataFile:
  169. return "kPluginBridgeOscSetChunkDataFile";
  170. case kPluginBridgeOscLatency:
  171. return "kPluginBridgeOscLatency";
  172. case kPluginBridgeOscReady:
  173. return "kPluginBridgeOscReady";
  174. case kPluginBridgeOscError:
  175. return "kPluginBridgeOscError";
  176. }
  177. carla_stderr("CarlaBackend::PluginBridgeOscInfoType2str(%i) - invalid type", type);
  178. return nullptr;
  179. }
  180. static inline
  181. const char* PluginBridgeRtOpcode2str(const PluginBridgeRtOpcode opcode) noexcept
  182. {
  183. switch (opcode)
  184. {
  185. case kPluginBridgeRtNull:
  186. return "kPluginBridgeRtNull";
  187. case kPluginBridgeRtSetAudioPool:
  188. return "kPluginBridgeRtSetAudioPool";
  189. case kPluginBridgeRtSetParameter:
  190. return "kPluginBridgeRtSetParameter";
  191. case kPluginBridgeRtMidiData:
  192. return "kPluginBridgeRtMidiData";
  193. case kPluginBridgeRtMidiBank:
  194. return "kPluginBridgeRtMidiBank";
  195. case kPluginBridgeRtMidiProgram:
  196. return "kPluginBridgeRtMidiProgram";
  197. case kPluginBridgeRtAllSoundOff:
  198. return "kPluginBridgeRtAllSoundOff";
  199. case kPluginBridgeRtAllNotesOff:
  200. return "kPluginBridgeRtAllNotesOff";
  201. case kPluginBridgeRtProcess:
  202. return "kPluginBridgeRtProcess";
  203. }
  204. carla_stderr("CarlaBackend::PluginBridgeRtOpcode2str(%i) - invalid opcode", opcode);
  205. return nullptr;
  206. }
  207. static inline
  208. const char* PluginBridgeNonRtOpcode2str(const PluginBridgeNonRtOpcode opcode) noexcept
  209. {
  210. switch (opcode)
  211. {
  212. case kPluginBridgeNonRtNull:
  213. return "kPluginBridgeNonRtNull";
  214. case kPluginBridgeNonRtPing:
  215. return "kPluginBridgeNonRtPing";
  216. case kPluginBridgeNonRtActivate:
  217. return "kPluginBridgeNonRtActivate";
  218. case kPluginBridgeNonRtDeactivate:
  219. return "kPluginBridgeNonRtDeactivate";
  220. case kPluginBridgeNonRtSetBufferSize:
  221. return "kPluginBridgeNonRtSetBufferSize";
  222. case kPluginBridgeNonRtSetSampleRate:
  223. return "kPluginBridgeNonRtSetSampleRate";
  224. case kPluginBridgeNonRtSetOffline:
  225. return "kPluginBridgeNonRtSetOffline";
  226. case kPluginBridgeNonRtSetOnline:
  227. return "kPluginBridgeNonRtSetOnline";
  228. case kPluginBridgeNonRtSetParameterValue:
  229. return "kPluginBridgeNonRtSetParameterValue";
  230. case kPluginBridgeNonRtSetProgram:
  231. return "kPluginBridgeNonRtSetProgram";
  232. case kPluginBridgeNonRtSetMidiProgram:
  233. return "kPluginBridgeNonRtSetMidiProgram";
  234. case kPluginBridgeNonRtSetCustomData:
  235. return "kPluginBridgeNonRtSetCustomData";
  236. case kPluginBridgeNonRtSetChunkDataFile:
  237. return "kPluginBridgeNonRtSetChunkDataFile";
  238. case kPluginBridgeNonRtSetCtrlChannel:
  239. return "kPluginBridgeNonRtSetCtrlChannel";
  240. case kPluginBridgeNonRtSetOption:
  241. return "kPluginBridgeNonRtSetOption";
  242. case kPluginBridgeNonRtPrepareForSave:
  243. return "kPluginBridgeNonRtPrepareForSave";
  244. case kPluginBridgeNonRtShowUI:
  245. return "kPluginBridgeNonRtShowUI";
  246. case kPluginBridgeNonRtHideUI:
  247. return "kPluginBridgeNonRtHideUI";
  248. case kPluginBridgeNonRtUiParameterChange:
  249. return "kPluginBridgeNonRtUiParameterChange";
  250. case kPluginBridgeNonRtUiProgramChange:
  251. return "kPluginBridgeNonRtUiProgramChange";
  252. case kPluginBridgeNonRtUiMidiProgramChange:
  253. return "kPluginBridgeNonRtUiMidiProgramChange";
  254. case kPluginBridgeNonRtUiNoteOn:
  255. return "kPluginBridgeNonRtUiNoteOn";
  256. case kPluginBridgeNonRtUiNoteOff:
  257. return "kPluginBridgeNonRtUiNoteOff";
  258. case kPluginBridgeNonRtQuit:
  259. return "kPluginBridgeNonRtQuit";
  260. }
  261. carla_stderr("CarlaBackend::PluginBridgeNonRtOpcode2str(%i) - invalid opcode", opcode);
  262. return nullptr;
  263. }
  264. // -----------------------------------------------------------------------
  265. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED