falkTX
/
Carla
mirror of https://github.com/falkTX/Carla
1
0
Fork 0
Code Releases 42 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.
4228 Commits
16 Branches
14GB
Tree: baa3758159
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'baa3758159'
${ noResults }
Carla/source/utils/CarlaBridgeUtils.hpp

332 lines
13KB
Raw Blame History 

  1. /*

  2.  * Carla Bridge utils

  3.  * Copyright (C) 2013-2018 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. 

  18. #ifndef CARLA_BRIDGE_UTILS_HPP_INCLUDED

  19. #define CARLA_BRIDGE_UTILS_HPP_INCLUDED

  20. 

  21. #include "CarlaBridgeDefines.hpp"

  22. #include "CarlaMutex.hpp"

  23. #include "CarlaString.hpp"

  24. 

  25. #if defined(CARLA_OS_WIN) && defined(BUILDING_CARLA_FOR_WINDOWS)

  26. # define PLUGIN_BRIDGE_NAMEPREFIX_RT_CLIENT     "Global\\carla-bridge_shm_rtC_"

  27. # define PLUGIN_BRIDGE_NAMEPREFIX_NON_RT_CLIENT "Global\\carla-bridge_shm_nonrtC_"

  28. # define PLUGIN_BRIDGE_NAMEPREFIX_NON_RT_SERVER "Global\\carla-bridge_shm_nonrtS_"

  29. #else

  30. # define PLUGIN_BRIDGE_NAMEPREFIX_RT_CLIENT     "/crlbrdg_shm_rtC_"

  31. # define PLUGIN_BRIDGE_NAMEPREFIX_NON_RT_CLIENT "/crlbrdg_shm_nonrtC_"

  32. # define PLUGIN_BRIDGE_NAMEPREFIX_NON_RT_SERVER "/crlbrdg_shm_nonrtS_"

  33. #endif

  34. 

  35. // -------------------------------------------------------------------------------------------------------------------

  36. 

  37. static inline

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

  39. {

  40.     switch (opcode)

  41.     {

  42.     case kPluginBridgeRtClientNull:

  43.         return "kPluginBridgeRtClientNull";

  44.     case kPluginBridgeRtClientSetAudioPool:

  45.         return "kPluginBridgeRtClientSetAudioPool";

  46.     case kPluginBridgeRtClientSetBufferSize:

  47.         return "kPluginBridgeRtClientSetBufferSize";

  48.     case kPluginBridgeRtClientSetSampleRate:

  49.         return "kPluginBridgeRtClientSetSampleRate";

  50.     case kPluginBridgeRtClientSetOnline:

  51.         return "kPluginBridgeRtClientSetOnline";

  52.     case kPluginBridgeRtClientControlEventParameter:

  53.         return "kPluginBridgeRtClientControlEventParameter";

  54.     case kPluginBridgeRtClientControlEventMidiBank:

  55.         return "kPluginBridgeRtClientControlEventMidiBank";

  56.     case kPluginBridgeRtClientControlEventMidiProgram:

  57.         return "kPluginBridgeRtClientControlEventMidiProgram";

  58.     case kPluginBridgeRtClientControlEventAllSoundOff:

  59.         return "kPluginBridgeRtClientControlEventAllSoundOff";

  60.     case kPluginBridgeRtClientControlEventAllNotesOff:

  61.         return "kPluginBridgeRtClientControlEventAllNotesOff";

  62.     case kPluginBridgeRtClientMidiEvent:

  63.         return "kPluginBridgeRtClientMidiEvent";

  64.     case kPluginBridgeRtClientProcess:

  65.         return "kPluginBridgeRtClientProcess";

  66.     case kPluginBridgeRtClientQuit:

  67.         return "kPluginBridgeRtClientQuit";

  68.     }

  69. 

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

  71.     return nullptr;

  72. }

  73. 

  74. static inline

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

  76. {

  77.     switch (opcode)

  78.     {

  79.     case kPluginBridgeNonRtClientNull:

  80.         return "kPluginBridgeNonRtClientNull";

  81.     case kPluginBridgeNonRtClientVersion:

  82.         return "kPluginBridgeNonRtClientVersion";

  83.     case kPluginBridgeNonRtClientPing:

  84.         return "kPluginBridgeNonRtClientPing";

  85.     case kPluginBridgeNonRtClientPingOnOff:

  86.         return "kPluginBridgeNonRtClientPingOnOff";

  87.     case kPluginBridgeNonRtClientActivate:

  88.         return "kPluginBridgeNonRtClientActivate";

  89.     case kPluginBridgeNonRtClientDeactivate:

  90.         return "kPluginBridgeNonRtClientDeactivate";

  91.     case kPluginBridgeNonRtClientInitialSetup:

  92.         return "kPluginBridgeNonRtClientInitialSetup";

  93.     case kPluginBridgeNonRtClientSetParameterValue:

  94.         return "kPluginBridgeNonRtClientSetParameterValue";

  95.     case kPluginBridgeNonRtClientSetParameterMidiChannel:

  96.         return "kPluginBridgeNonRtClientSetParameterMidiChannel";

  97.     case kPluginBridgeNonRtClientSetParameterMidiCC:

  98.         return "kPluginBridgeNonRtClientSetParameterMidiCC";

  99.     case kPluginBridgeNonRtClientSetProgram:

  100.         return "kPluginBridgeNonRtClientSetProgram";

  101.     case kPluginBridgeNonRtClientSetMidiProgram:

  102.         return "kPluginBridgeNonRtClientSetMidiProgram";

  103.     case kPluginBridgeNonRtClientSetCustomData:

  104.         return "kPluginBridgeNonRtClientSetCustomData";

  105.     case kPluginBridgeNonRtClientSetChunkDataFile:

  106.         return "kPluginBridgeNonRtClientSetChunkDataFile";

  107.     case kPluginBridgeNonRtClientSetCtrlChannel:

  108.         return "kPluginBridgeNonRtClientSetCtrlChannel";

  109.     case kPluginBridgeNonRtClientSetOption:

  110.         return "kPluginBridgeNonRtClientSetOption";

  111.     case kPluginBridgeNonRtClientGetParameterText:

  112.         return "kPluginBridgeNonRtClientGetParameterText";

  113.     case kPluginBridgeNonRtClientPrepareForSave:

  114.         return "kPluginBridgeNonRtClientPrepareForSave";

  115.     case kPluginBridgeNonRtClientRestoreLV2State:

  116.         return "kPluginBridgeNonRtClientRestoreLV2State";

  117.     case kPluginBridgeNonRtClientShowUI:

  118.         return "kPluginBridgeNonRtClientShowUI";

  119.     case kPluginBridgeNonRtClientHideUI:

  120.         return "kPluginBridgeNonRtClientHideUI";

  121.     case kPluginBridgeNonRtClientUiParameterChange:

  122.         return "kPluginBridgeNonRtClientUiParameterChange";

  123.     case kPluginBridgeNonRtClientUiProgramChange:

  124.         return "kPluginBridgeNonRtClientUiProgramChange";

  125.     case kPluginBridgeNonRtClientUiMidiProgramChange:

  126.         return "kPluginBridgeNonRtClientUiMidiProgramChange";

  127.     case kPluginBridgeNonRtClientUiNoteOn:

  128.         return "kPluginBridgeNonRtClientUiNoteOn";

  129.     case kPluginBridgeNonRtClientUiNoteOff:

  130.         return "kPluginBridgeNonRtClientUiNoteOff";

  131.     case kPluginBridgeNonRtClientQuit:

  132.         return "kPluginBridgeNonRtClientQuit";

  133.     }

  134. 

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

  136.     return nullptr;

  137. }

  138. 

  139. static inline

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

  141. {

  142.     switch (opcode)

  143.     {

  144.     case kPluginBridgeNonRtServerNull:

  145.         return "kPluginBridgeNonRtServerNull";

  146.     case kPluginBridgeNonRtServerPong:

  147.         return "kPluginBridgeNonRtServerPong";

  148.     case kPluginBridgeNonRtServerPluginInfo1:

  149.         return "kPluginBridgeNonRtServerPluginInfo1";

  150.     case kPluginBridgeNonRtServerPluginInfo2:

  151.         return "kPluginBridgeNonRtServerPluginInfo2";

  152.     case kPluginBridgeNonRtServerAudioCount:

  153.         return "kPluginBridgeNonRtServerAudioCount";

  154.     case kPluginBridgeNonRtServerMidiCount:

  155.         return "kPluginBridgeNonRtServerMidiCount";

  156.     case kPluginBridgeNonRtServerCvCount:

  157.         return "kPluginBridgeNonRtServerCvCount";

  158.     case kPluginBridgeNonRtServerParameterCount:

  159.         return "kPluginBridgeNonRtServerParameterCount";

  160.     case kPluginBridgeNonRtServerProgramCount:

  161.         return "kPluginBridgeNonRtServerProgramCount";

  162.     case kPluginBridgeNonRtServerMidiProgramCount:

  163.         return "kPluginBridgeNonRtServerMidiProgramCount";

  164.     case kPluginBridgeNonRtServerPortName:

  165.         return "kPluginBridgeNonRtServerPortName";

  166.     case kPluginBridgeNonRtServerParameterData1:

  167.         return "kPluginBridgeNonRtServerParameterData1";

  168.     case kPluginBridgeNonRtServerParameterData2:

  169.         return "kPluginBridgeNonRtServerParameterData2";

  170.     case kPluginBridgeNonRtServerParameterRanges:

  171.         return "kPluginBridgeNonRtServerParameterRanges";

  172.     case kPluginBridgeNonRtServerParameterValue:

  173.         return "kPluginBridgeNonRtServerParameterValue";

  174.     case kPluginBridgeNonRtServerParameterValue2:

  175.         return "kPluginBridgeNonRtServerParameterValue2";

  176.     case kPluginBridgeNonRtServerDefaultValue:

  177.         return "kPluginBridgeNonRtServerDefaultValue";

  178.     case kPluginBridgeNonRtServerCurrentProgram:

  179.         return "kPluginBridgeNonRtServerCurrentProgram";

  180.     case kPluginBridgeNonRtServerCurrentMidiProgram:

  181.         return "kPluginBridgeNonRtServerCurrentMidiProgram";

  182.     case kPluginBridgeNonRtServerProgramName:

  183.         return "kPluginBridgeNonRtServerProgramName";

  184.     case kPluginBridgeNonRtServerMidiProgramData:

  185.         return "kPluginBridgeNonRtServerMidiProgramData";

  186.     case kPluginBridgeNonRtServerSetCustomData:

  187.         return "kPluginBridgeNonRtServerSetCustomData";

  188.     case kPluginBridgeNonRtServerSetChunkDataFile:

  189.         return "kPluginBridgeNonRtServerSetChunkDataFile";

  190.     case kPluginBridgeNonRtServerSetLatency:

  191.         return "kPluginBridgeNonRtServerSetLatency";

  192.     case kPluginBridgeNonRtServerSetParameterText:

  193.         return "kPluginBridgeNonRtServerSetParameterText";

  194.     case kPluginBridgeNonRtServerReady:

  195.         return "kPluginBridgeNonRtServerReady";

  196.     case kPluginBridgeNonRtServerSaved:

  197.         return "kPluginBridgeNonRtServerSaved";

  198.     case kPluginBridgeNonRtServerUiClosed:

  199.         return "kPluginBridgeNonRtServerUiClosed";

  200.     case kPluginBridgeNonRtServerError:

  201.         return "kPluginBridgeNonRtServerError";

  202.     }

  203. 

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

  205.     return nullptr;

  206. }

  207. 

  208. // -------------------------------------------------------------------------------------------------------------------

  209. 

  210. struct BridgeAudioPool {

  211.     float* data;

  212.     std::size_t dataSize;

  213.     CarlaString filename;

  214.     char shm[64];

  215.     bool isServer;

  216. 

  217.     BridgeAudioPool() noexcept;

  218.     ~BridgeAudioPool() noexcept;

  219. 

  220.     bool initializeServer() noexcept;

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

  222.     void clear() noexcept;

  223. 

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

  225. 

  226.     const char* getFilenameSuffix() const noexcept;

  227. 

  228.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeAudioPool)

  229. };

  230. 

  231. // -------------------------------------------------------------------------------------------------------------------

  232. 

  233. struct BridgeRtClientControl : public CarlaRingBufferControl<SmallStackBuffer> {

  234.     BridgeRtClientData* data;

  235.     CarlaString filename;

  236.     bool needsSemDestroy; // client only

  237.     char shm[64];

  238.     bool isServer;

  239. 

  240.     BridgeRtClientControl() noexcept;

  241.     ~BridgeRtClientControl() noexcept override;

  242. 

  243.     bool initializeServer() noexcept;

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

  245.     void clear() noexcept;

  246. 

  247.     bool mapData() noexcept;

  248.     void unmapData() noexcept;

  249. 

  250.     // non-bridge, server

  251.     bool waitForClient(const uint msecs) noexcept;

  252.     bool writeOpcode(const PluginBridgeRtClientOpcode opcode) noexcept;

  253. 

  254.     // bridge, client

  255.     PluginBridgeRtClientOpcode readOpcode() noexcept;

  256. 

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

  258.     struct WaitHelper {

  259.         BridgeRtClientData* const data;

  260.         const bool ok;

  261. 

  262.         WaitHelper(BridgeRtClientControl& c) noexcept;

  263.         ~WaitHelper() noexcept;

  264. 

  265.         CARLA_DECLARE_NON_COPY_STRUCT(WaitHelper)

  266.     };

  267. 

  268.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeRtClientControl)

  269. };

  270. 

  271. // -------------------------------------------------------------------------------------------------------------------

  272. 

  273. struct BridgeNonRtClientControl : public CarlaRingBufferControl<BigStackBuffer> {

  274.     BridgeNonRtClientData* data;

  275.     CarlaString filename;

  276.     CarlaMutex mutex;

  277.     char shm[64];

  278.     bool isServer;

  279. 

  280.     BridgeNonRtClientControl() noexcept;

  281.     ~BridgeNonRtClientControl() noexcept override;

  282. 

  283.     bool initializeServer() noexcept;

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

  285.     void clear() noexcept;

  286. 

  287.     bool mapData() noexcept;

  288.     void unmapData() noexcept;

  289. 

  290.     // non-bridge, server

  291.     void waitIfDataIsReachingLimit() noexcept;

  292.     bool writeOpcode(const PluginBridgeNonRtClientOpcode opcode) noexcept;

  293. 

  294.     // bridge, client

  295.     PluginBridgeNonRtClientOpcode readOpcode() noexcept;

  296. 

  297.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtClientControl)

  298. };

  299. 

  300. // -------------------------------------------------------------------------------------------------------------------

  301. 

  302. struct BridgeNonRtServerControl : public CarlaRingBufferControl<HugeStackBuffer> {

  303.     BridgeNonRtServerData* data;

  304.     CarlaString filename;

  305.     CarlaMutex mutex;

  306.     char shm[64];

  307.     bool isServer;

  308. 

  309.     BridgeNonRtServerControl() noexcept;

  310.     ~BridgeNonRtServerControl() noexcept override;

  311. 

  312.     bool initializeServer() noexcept;

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

  314.     void clear() noexcept;

  315. 

  316.     bool mapData() noexcept;

  317.     void unmapData() noexcept;

  318. 

  319.     // non-bridge, server

  320.     PluginBridgeNonRtServerOpcode readOpcode() noexcept;

  321. 

  322.     // bridge, client

  323.     void waitIfDataIsReachingLimit() noexcept;

  324.     bool writeOpcode(const PluginBridgeNonRtServerOpcode opcode) noexcept;

  325. 

  326.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtServerControl)

  327. };

  328. 

  329. // -------------------------------------------------------------------------------------------------------------------

  330. 

  331. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED