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.

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