falkTX
/
Carla
mirror of https://github.com/falkTX/Carla
1
0
Fork 0
Code Releases 43 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.
7010 Commits
17 Branches
940MB
Tree: 7eaf104d3d
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '7eaf104d3d'
${ noResults }
Carla/source/utils/CarlaBridgeUtils.hpp

352 lines
13KB
Raw Blame History 

  1. // SPDX-FileCopyrightText: 2011-2025 Filipe Coelho <falktx@falktx.com>

  2. // SPDX-License-Identifier: GPL-2.0-or-later

  3. 

  4. #ifndef CARLA_BRIDGE_UTILS_HPP_INCLUDED

  5. #define CARLA_BRIDGE_UTILS_HPP_INCLUDED

  6. 

  7. #include "CarlaBridgeDefines.hpp"

  8. #include "CarlaMutex.hpp"

  9. #include "CarlaRingBuffer.hpp"

  10. 

  11. #include "distrho/extra/String.hpp"

  12. 

  13. // -------------------------------------------------------------------------------------------------------------------

  14. 

  15. static inline

  16. const char* PluginBridgeRtClientOpcode2str(const PluginBridgeRtClientOpcode opcode) noexcept

  17. {

  18.     switch (opcode)

  19.     {

  20.     case kPluginBridgeRtClientNull:

  21.         return "kPluginBridgeRtClientNull";

  22.     case kPluginBridgeRtClientSetAudioPool:

  23.         return "kPluginBridgeRtClientSetAudioPool";

  24.     case kPluginBridgeRtClientSetBufferSize:

  25.         return "kPluginBridgeRtClientSetBufferSize";

  26.     case kPluginBridgeRtClientSetSampleRate:

  27.         return "kPluginBridgeRtClientSetSampleRate";

  28.     case kPluginBridgeRtClientSetOnline:

  29.         return "kPluginBridgeRtClientSetOnline";

  30.     case kPluginBridgeRtClientControlEventParameter:

  31.         return "kPluginBridgeRtClientControlEventParameter";

  32.     case kPluginBridgeRtClientControlEventMidiBank:

  33.         return "kPluginBridgeRtClientControlEventMidiBank";

  34.     case kPluginBridgeRtClientControlEventMidiProgram:

  35.         return "kPluginBridgeRtClientControlEventMidiProgram";

  36.     case kPluginBridgeRtClientControlEventAllSoundOff:

  37.         return "kPluginBridgeRtClientControlEventAllSoundOff";

  38.     case kPluginBridgeRtClientControlEventAllNotesOff:

  39.         return "kPluginBridgeRtClientControlEventAllNotesOff";

  40.     case kPluginBridgeRtClientMidiEvent:

  41.         return "kPluginBridgeRtClientMidiEvent";

  42.     case kPluginBridgeRtClientProcess:

  43.         return "kPluginBridgeRtClientProcess";

  44.     case kPluginBridgeRtClientQuit:

  45.         return "kPluginBridgeRtClientQuit";

  46.     }

  47. 

  48.     carla_stderr("CarlaBackend::PluginBridgeRtClientOpcode2str(%i) - invalid opcode", opcode);

  49.     return "";

  50. }

  51. 

  52. static inline

  53. const char* PluginBridgeNonRtClientOpcode2str(const PluginBridgeNonRtClientOpcode opcode) noexcept

  54. {

  55.     switch (opcode)

  56.     {

  57.     case kPluginBridgeNonRtClientNull:

  58.         return "kPluginBridgeNonRtClientNull";

  59.     case kPluginBridgeNonRtClientVersion:

  60.         return "kPluginBridgeNonRtClientVersion";

  61.     case kPluginBridgeNonRtClientPing:

  62.         return "kPluginBridgeNonRtClientPing";

  63.     case kPluginBridgeNonRtClientPingOnOff:

  64.         return "kPluginBridgeNonRtClientPingOnOff";

  65.     case kPluginBridgeNonRtClientActivate:

  66.         return "kPluginBridgeNonRtClientActivate";

  67.     case kPluginBridgeNonRtClientDeactivate:

  68.         return "kPluginBridgeNonRtClientDeactivate";

  69.     case kPluginBridgeNonRtClientInitialSetup:

  70.         return "kPluginBridgeNonRtClientInitialSetup";

  71.     case kPluginBridgeNonRtClientSetParameterValue:

  72.         return "kPluginBridgeNonRtClientSetParameterValue";

  73.     case kPluginBridgeNonRtClientSetParameterMidiChannel:

  74.         return "kPluginBridgeNonRtClientSetParameterMidiChannel";

  75.     case kPluginBridgeNonRtClientSetParameterMappedControlIndex:

  76.         return "kPluginBridgeNonRtClientSetParameterMappedControlIndex";

  77.     case kPluginBridgeNonRtClientSetProgram:

  78.         return "kPluginBridgeNonRtClientSetProgram";

  79.     case kPluginBridgeNonRtClientSetMidiProgram:

  80.         return "kPluginBridgeNonRtClientSetMidiProgram";

  81.     case kPluginBridgeNonRtClientSetCustomData:

  82.         return "kPluginBridgeNonRtClientSetCustomData";

  83.     case kPluginBridgeNonRtClientSetChunkDataFile:

  84.         return "kPluginBridgeNonRtClientSetChunkDataFile";

  85.     case kPluginBridgeNonRtClientSetCtrlChannel:

  86.         return "kPluginBridgeNonRtClientSetCtrlChannel";

  87.     case kPluginBridgeNonRtClientSetOption:

  88.         return "kPluginBridgeNonRtClientSetOption";

  89.     case kPluginBridgeNonRtClientGetParameterText:

  90.         return "kPluginBridgeNonRtClientGetParameterText";

  91.     case kPluginBridgeNonRtClientPrepareForSave:

  92.         return "kPluginBridgeNonRtClientPrepareForSave";

  93.     case kPluginBridgeNonRtClientRestoreLV2State:

  94.         return "kPluginBridgeNonRtClientRestoreLV2State";

  95.     case kPluginBridgeNonRtClientShowUI:

  96.         return "kPluginBridgeNonRtClientShowUI";

  97.     case kPluginBridgeNonRtClientHideUI:

  98.         return "kPluginBridgeNonRtClientHideUI";

  99.     case kPluginBridgeNonRtClientUiParameterChange:

  100.         return "kPluginBridgeNonRtClientUiParameterChange";

  101.     case kPluginBridgeNonRtClientUiProgramChange:

  102.         return "kPluginBridgeNonRtClientUiProgramChange";

  103.     case kPluginBridgeNonRtClientUiMidiProgramChange:

  104.         return "kPluginBridgeNonRtClientUiMidiProgramChange";

  105.     case kPluginBridgeNonRtClientUiNoteOn:

  106.         return "kPluginBridgeNonRtClientUiNoteOn";

  107.     case kPluginBridgeNonRtClientUiNoteOff:

  108.         return "kPluginBridgeNonRtClientUiNoteOff";

  109.     case kPluginBridgeNonRtClientQuit:

  110.         return "kPluginBridgeNonRtClientQuit";

  111.     case kPluginBridgeNonRtClientSetParameterMappedRange:

  112.         return "kPluginBridgeNonRtClientSetParameterMappedRange";

  113.     case kPluginBridgeNonRtClientSetOptions:

  114.         return "kPluginBridgeNonRtClientSetOptions";

  115.     case kPluginBridgeNonRtClientSetWindowTitle:

  116.         return "kPluginBridgeNonRtClientSetWindowTitle";

  117.     case kPluginBridgeNonRtClientEmbedUI:

  118.         return "kPluginBridgeNonRtClientEmbedUI";

  119.     case kPluginBridgeNonRtClientReload:

  120.         return "kPluginBridgeNonRtClientReload";

  121.     }

  122. 

  123.     carla_stderr("CarlaBackend::PluginBridgeNonRtClientOpcode2str(%i) - invalid opcode", opcode);

  124.     return "";

  125. }

  126. 

  127. static inline

  128. const char* PluginBridgeNonRtServerOpcode2str(const PluginBridgeNonRtServerOpcode opcode) noexcept

  129. {

  130.     switch (opcode)

  131.     {

  132.     case kPluginBridgeNonRtServerNull:

  133.         return "kPluginBridgeNonRtServerNull";

  134.     case kPluginBridgeNonRtServerPong:

  135.         return "kPluginBridgeNonRtServerPong";

  136.     case kPluginBridgeNonRtServerPluginInfo1:

  137.         return "kPluginBridgeNonRtServerPluginInfo1";

  138.     case kPluginBridgeNonRtServerPluginInfo2:

  139.         return "kPluginBridgeNonRtServerPluginInfo2";

  140.     case kPluginBridgeNonRtServerAudioCount:

  141.         return "kPluginBridgeNonRtServerAudioCount";

  142.     case kPluginBridgeNonRtServerMidiCount:

  143.         return "kPluginBridgeNonRtServerMidiCount";

  144.     case kPluginBridgeNonRtServerCvCount:

  145.         return "kPluginBridgeNonRtServerCvCount";

  146.     case kPluginBridgeNonRtServerParameterCount:

  147.         return "kPluginBridgeNonRtServerParameterCount";

  148.     case kPluginBridgeNonRtServerProgramCount:

  149.         return "kPluginBridgeNonRtServerProgramCount";

  150.     case kPluginBridgeNonRtServerMidiProgramCount:

  151.         return "kPluginBridgeNonRtServerMidiProgramCount";

  152.     case kPluginBridgeNonRtServerPortName:

  153.         return "kPluginBridgeNonRtServerPortName";

  154.     case kPluginBridgeNonRtServerParameterData1:

  155.         return "kPluginBridgeNonRtServerParameterData1";

  156.     case kPluginBridgeNonRtServerParameterData2:

  157.         return "kPluginBridgeNonRtServerParameterData2";

  158.     case kPluginBridgeNonRtServerParameterRanges:

  159.         return "kPluginBridgeNonRtServerParameterRanges";

  160.     case kPluginBridgeNonRtServerParameterValue:

  161.         return "kPluginBridgeNonRtServerParameterValue";

  162.     case kPluginBridgeNonRtServerParameterValue2:

  163.         return "kPluginBridgeNonRtServerParameterValue2";

  164.     case kPluginBridgeNonRtServerParameterTouch:

  165.         return "kPluginBridgeNonRtServerParameterTouch";

  166.     case kPluginBridgeNonRtServerDefaultValue:

  167.         return "kPluginBridgeNonRtServerDefaultValue";

  168.     case kPluginBridgeNonRtServerCurrentProgram:

  169.         return "kPluginBridgeNonRtServerCurrentProgram";

  170.     case kPluginBridgeNonRtServerCurrentMidiProgram:

  171.         return "kPluginBridgeNonRtServerCurrentMidiProgram";

  172.     case kPluginBridgeNonRtServerProgramName:

  173.         return "kPluginBridgeNonRtServerProgramName";

  174.     case kPluginBridgeNonRtServerMidiProgramData:

  175.         return "kPluginBridgeNonRtServerMidiProgramData";

  176.     case kPluginBridgeNonRtServerSetCustomData:

  177.         return "kPluginBridgeNonRtServerSetCustomData";

  178.     case kPluginBridgeNonRtServerSetChunkDataFile:

  179.         return "kPluginBridgeNonRtServerSetChunkDataFile";

  180.     case kPluginBridgeNonRtServerSetLatency:

  181.         return "kPluginBridgeNonRtServerSetLatency";

  182.     case kPluginBridgeNonRtServerSetParameterText:

  183.         return "kPluginBridgeNonRtServerSetParameterText";

  184.     case kPluginBridgeNonRtServerReady:

  185.         return "kPluginBridgeNonRtServerReady";

  186.     case kPluginBridgeNonRtServerSaved:

  187.         return "kPluginBridgeNonRtServerSaved";

  188.     case kPluginBridgeNonRtServerUiClosed:

  189.         return "kPluginBridgeNonRtServerUiClosed";

  190.     case kPluginBridgeNonRtServerError:

  191.         return "kPluginBridgeNonRtServerError";

  192.     case kPluginBridgeNonRtServerVersion:

  193.         return "kPluginBridgeNonRtServerVersion";

  194.     case kPluginBridgeNonRtServerRespEmbedUI:

  195.         return "kPluginBridgeNonRtServerRespEmbedUI";

  196.     case kPluginBridgeNonRtServerResizeEmbedUI:

  197.         return "kPluginBridgeNonRtServerResizeEmbedUI";

  198.     }

  199. 

  200.     carla_stderr("CarlaBackend::PluginBridgeNonRtServerOpcode2str%i) - invalid opcode", opcode);

  201.     return "";

  202. }

  203. 

  204. // -------------------------------------------------------------------------------------------------------------------

  205. 

  206. static constexpr const std::size_t kBridgeRtClientDataMidiOutSize = 511*4;

  207. static constexpr const std::size_t kBridgeBaseMidiOutHeaderSize   = 6U /* time, port and size */;

  208. 

  209. // Server => Client RT

  210. struct BridgeRtClientData {

  211.     BridgeSemaphore sem;

  212.     BridgeTimeInfo timeInfo;

  213.     SmallStackBuffer ringBuffer;

  214.     uint8_t midiOut[kBridgeRtClientDataMidiOutSize];

  215.     uint32_t procFlags;

  216. };

  217. 

  218. // Server => Client Non-RT

  219. struct BridgeNonRtClientData {

  220.     BigStackBuffer ringBuffer;

  221. };

  222. 

  223. // Client => Server Non-RT

  224. struct BridgeNonRtServerData {

  225.     HugeStackBuffer ringBuffer;

  226. };

  227. 

  228. // -------------------------------------------------------------------------------------------------------------------

  229. 

  230. struct CARLA_API BridgeAudioPool {

  231.     float* data;

  232.     std::size_t dataSize;

  233.     String filename;

  234.     char shm[64];

  235.     bool isServer;

  236. 

  237.     BridgeAudioPool() noexcept;

  238.     ~BridgeAudioPool() noexcept;

  239. 

  240.     bool initializeServer() noexcept;

  241.     bool attachClient(const char* const fname) noexcept;

  242.     void clear() noexcept;

  243. 

  244.     void resize(const uint32_t bufferSize, const uint32_t audioPortCount, const uint32_t cvPortCount) noexcept;

  245. 

  246.     const char* getFilenameSuffix() const noexcept;

  247. 

  248.     CARLA_DECLARE_NON_COPYABLE(BridgeAudioPool)

  249. };

  250. 

  251. // -------------------------------------------------------------------------------------------------------------------

  252. 

  253. struct CARLA_API BridgeRtClientControl : public CarlaRingBufferControl<SmallStackBuffer> {

  254.     BridgeRtClientData* data;

  255.     String filename;

  256.     bool needsSemDestroy; // client only

  257.     char shm[64];

  258.     bool isServer;

  259. 

  260.     BridgeRtClientControl() noexcept;

  261.     ~BridgeRtClientControl() noexcept override;

  262. 

  263.     bool initializeServer() noexcept;

  264.     bool attachClient(const char* const basename) noexcept;

  265.     void clear() noexcept;

  266. 

  267.     bool mapData() noexcept;

  268.     void unmapData() noexcept;

  269. 

  270.     // non-bridge, server

  271.     bool waitForClient(const uint msecs) noexcept;

  272.     bool writeOpcode(const PluginBridgeRtClientOpcode opcode) noexcept;

  273. 

  274.     // bridge, client

  275.     PluginBridgeRtClientOpcode readOpcode() noexcept;

  276. 

  277.     // helper class that automatically posts semaphore on destructor

  278.     struct WaitHelper {

  279.         BridgeRtClientData* const data;

  280.         const bool ok;

  281. 

  282.         WaitHelper(BridgeRtClientControl& c) noexcept;

  283.         ~WaitHelper() noexcept;

  284. 

  285.         CARLA_DECLARE_NON_COPYABLE(WaitHelper)

  286.     };

  287. 

  288.     CARLA_DECLARE_NON_COPYABLE(BridgeRtClientControl)

  289. };

  290. 

  291. // -------------------------------------------------------------------------------------------------------------------

  292. 

  293. struct CARLA_API BridgeNonRtClientControl : public CarlaRingBufferControl<BigStackBuffer> {

  294.     BridgeNonRtClientData* data;

  295.     String filename;

  296.     CarlaMutex mutex;

  297.     char shm[64];

  298.     bool isServer;

  299. 

  300.     BridgeNonRtClientControl() noexcept;

  301.     ~BridgeNonRtClientControl() noexcept override;

  302. 

  303.     bool initializeServer() noexcept;

  304.     bool attachClient(const char* const basename) noexcept;

  305.     void clear() noexcept;

  306. 

  307.     bool mapData() noexcept;

  308.     void unmapData() noexcept;

  309. 

  310.     // non-bridge, server

  311.     void waitIfDataIsReachingLimit() noexcept;

  312.     bool writeOpcode(const PluginBridgeNonRtClientOpcode opcode) noexcept;

  313. 

  314.     // bridge, client

  315.     PluginBridgeNonRtClientOpcode readOpcode() noexcept;

  316. 

  317.     CARLA_DECLARE_NON_COPYABLE(BridgeNonRtClientControl)

  318. };

  319. 

  320. // -------------------------------------------------------------------------------------------------------------------

  321. 

  322. struct CARLA_API BridgeNonRtServerControl : public CarlaRingBufferControl<HugeStackBuffer> {

  323.     BridgeNonRtServerData* data;

  324.     String filename;

  325.     CarlaMutex mutex;

  326.     char shm[64];

  327.     bool isServer;

  328. 

  329.     BridgeNonRtServerControl() noexcept;

  330.     ~BridgeNonRtServerControl() noexcept override;

  331. 

  332.     bool initializeServer() noexcept;

  333.     bool attachClient(const char* const basename) noexcept;

  334.     void clear() noexcept;

  335. 

  336.     bool mapData() noexcept;

  337.     void unmapData() noexcept;

  338. 

  339.     // non-bridge, server

  340.     PluginBridgeNonRtServerOpcode readOpcode() noexcept;

  341. 

  342.     // bridge, client

  343.     void waitIfDataIsReachingLimit() noexcept;

  344.     bool writeOpcode(const PluginBridgeNonRtServerOpcode opcode) noexcept;

  345. 

  346.     CARLA_DECLARE_NON_COPYABLE(BridgeNonRtServerControl)

  347. };

  348. 

  349. // -------------------------------------------------------------------------------------------------------------------

  350. 

  351. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED