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.
3573 Commits
16 Branches
3.6GB
Tree: 8e5c2e292e
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '8e5c2e292e'
${ noResults }
Carla/source/utils/CarlaBridgeUtils.hpp

326 lines
12KB
Raw Blame History 

  1. /*

  2.  * Carla Bridge utils

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

  47.         return "kPluginBridgeRtClientControlEventParameter";

  48.     case kPluginBridgeRtClientControlEventMidiBank:

  49.         return "kPluginBridgeRtClientControlEventMidiBank";

  50.     case kPluginBridgeRtClientControlEventMidiProgram:

  51.         return "kPluginBridgeRtClientControlEventMidiProgram";

  52.     case kPluginBridgeRtClientControlEventAllSoundOff:

  53.         return "kPluginBridgeRtClientControlEventAllSoundOff";

  54.     case kPluginBridgeRtClientControlEventAllNotesOff:

  55.         return "kPluginBridgeRtClientControlEventAllNotesOff";

  56.     case kPluginBridgeRtClientMidiEvent:

  57.         return "kPluginBridgeRtClientMidiEvent";

  58.     case kPluginBridgeRtClientProcess:

  59.         return "kPluginBridgeRtClientProcess";

  60.     case kPluginBridgeRtClientQuit:

  61.         return "kPluginBridgeRtClientQuit";

  62.     }

  63. 

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

  65.     return nullptr;

  66. }

  67. 

  68. static inline

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

  70. {

  71.     switch (opcode)

  72.     {

  73.     case kPluginBridgeNonRtClientNull:

  74.         return "kPluginBridgeNonRtClientNull";

  75.     case kPluginBridgeNonRtClientPing:

  76.         return "kPluginBridgeNonRtClientPing";

  77.     case kPluginBridgeNonRtClientPingOnOff:

  78.         return "kPluginBridgeNonRtClientPingOnOff";

  79.     case kPluginBridgeNonRtClientActivate:

  80.         return "kPluginBridgeNonRtClientActivate";

  81.     case kPluginBridgeNonRtClientDeactivate:

  82.         return "kPluginBridgeNonRtClientDeactivate";

  83.     case kPluginBridgeNonRtClientSetBufferSize:

  84.         return "kPluginBridgeNonRtClientSetBufferSize";

  85.     case kPluginBridgeNonRtClientSetSampleRate:

  86.         return "kPluginBridgeNonRtClientSetSampleRate";

  87.     case kPluginBridgeNonRtClientSetOffline:

  88.         return "kPluginBridgeNonRtClientSetOffline";

  89.     case kPluginBridgeNonRtClientSetOnline:

  90.         return "kPluginBridgeNonRtClientSetOnline";

  91.     case kPluginBridgeNonRtClientSetParameterValue:

  92.         return "kPluginBridgeNonRtClientSetParameterValue";

  93.     case kPluginBridgeNonRtClientSetParameterMidiChannel:

  94.         return "kPluginBridgeNonRtClientSetParameterMidiChannel";

  95.     case kPluginBridgeNonRtClientSetParameterMidiCC:

  96.         return "kPluginBridgeNonRtClientSetParameterMidiCC";

  97.     case kPluginBridgeNonRtClientSetProgram:

  98.         return "kPluginBridgeNonRtClientSetProgram";

  99.     case kPluginBridgeNonRtClientSetMidiProgram:

  100.         return "kPluginBridgeNonRtClientSetMidiProgram";

  101.     case kPluginBridgeNonRtClientSetCustomData:

  102.         return "kPluginBridgeNonRtClientSetCustomData";

  103.     case kPluginBridgeNonRtClientSetChunkDataFile:

  104.         return "kPluginBridgeNonRtClientSetChunkDataFile";

  105.     case kPluginBridgeNonRtClientSetCtrlChannel:

  106.         return "kPluginBridgeNonRtClientSetCtrlChannel";

  107.     case kPluginBridgeNonRtClientSetOption:

  108.         return "kPluginBridgeNonRtClientSetOption";

  109.     case kPluginBridgeNonRtClientPrepareForSave:

  110.         return "kPluginBridgeNonRtClientPrepareForSave";

  111.     case kPluginBridgeNonRtClientShowUI:

  112.         return "kPluginBridgeNonRtClientShowUI";

  113.     case kPluginBridgeNonRtClientHideUI:

  114.         return "kPluginBridgeNonRtClientHideUI";

  115.     case kPluginBridgeNonRtClientUiParameterChange:

  116.         return "kPluginBridgeNonRtClientUiParameterChange";

  117.     case kPluginBridgeNonRtClientUiProgramChange:

  118.         return "kPluginBridgeNonRtClientUiProgramChange";

  119.     case kPluginBridgeNonRtClientUiMidiProgramChange:

  120.         return "kPluginBridgeNonRtClientUiMidiProgramChange";

  121.     case kPluginBridgeNonRtClientUiNoteOn:

  122.         return "kPluginBridgeNonRtClientUiNoteOn";

  123.     case kPluginBridgeNonRtClientUiNoteOff:

  124.         return "kPluginBridgeNonRtClientUiNoteOff";

  125.     case kPluginBridgeNonRtClientQuit:

  126.         return "kPluginBridgeNonRtClientQuit";

  127.     }

  128. 

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

  130.     return nullptr;

  131. }

  132. 

  133. static inline

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

  135. {

  136.     switch (opcode)

  137.     {

  138.     case kPluginBridgeNonRtServerNull:

  139.         return "kPluginBridgeNonRtServerNull";

  140.     case kPluginBridgeNonRtServerPong:

  141.         return "kPluginBridgeNonRtServerPong";

  142.     case kPluginBridgeNonRtServerPluginInfo1:

  143.         return "kPluginBridgeNonRtServerPluginInfo1";

  144.     case kPluginBridgeNonRtServerPluginInfo2:

  145.         return "kPluginBridgeNonRtServerPluginInfo2";

  146.     case kPluginBridgeNonRtServerAudioCount:

  147.         return "kPluginBridgeNonRtServerAudioCount";

  148.     case kPluginBridgeNonRtServerMidiCount:

  149.         return "kPluginBridgeNonRtServerMidiCount";

  150.     case kPluginBridgeNonRtServerCvCount:

  151.         return "kPluginBridgeNonRtServerCvCount";

  152.     case kPluginBridgeNonRtServerParameterCount:

  153.         return "kPluginBridgeNonRtServerParameterCount";

  154.     case kPluginBridgeNonRtServerProgramCount:

  155.         return "kPluginBridgeNonRtServerProgramCount";

  156.     case kPluginBridgeNonRtServerMidiProgramCount:

  157.         return "kPluginBridgeNonRtServerMidiProgramCount";

  158.     case kPluginBridgeNonRtServerPortName:

  159.         return "kPluginBridgeNonRtServerPortName";

  160.     case kPluginBridgeNonRtServerParameterData1:

  161.         return "kPluginBridgeNonRtServerParameterData1";

  162.     case kPluginBridgeNonRtServerParameterData2:

  163.         return "kPluginBridgeNonRtServerParameterData2";

  164.     case kPluginBridgeNonRtServerParameterRanges:

  165.         return "kPluginBridgeNonRtServerParameterRanges";

  166.     case kPluginBridgeNonRtServerParameterValue:

  167.         return "kPluginBridgeNonRtServerParameterValue";

  168.     case kPluginBridgeNonRtServerParameterValue2:

  169.         return "kPluginBridgeNonRtServerParameterValue2";

  170.     case kPluginBridgeNonRtServerDefaultValue:

  171.         return "kPluginBridgeNonRtServerDefaultValue";

  172.     case kPluginBridgeNonRtServerCurrentProgram:

  173.         return "kPluginBridgeNonRtServerCurrentProgram";

  174.     case kPluginBridgeNonRtServerCurrentMidiProgram:

  175.         return "kPluginBridgeNonRtServerCurrentMidiProgram";

  176.     case kPluginBridgeNonRtServerProgramName:

  177.         return "kPluginBridgeNonRtServerProgramName";

  178.     case kPluginBridgeNonRtServerMidiProgramData:

  179.         return "kPluginBridgeNonRtServerMidiProgramData";

  180.     case kPluginBridgeNonRtServerSetCustomData:

  181.         return "kPluginBridgeNonRtServerSetCustomData";

  182.     case kPluginBridgeNonRtServerSetChunkDataFile:

  183.         return "kPluginBridgeNonRtServerSetChunkDataFile";

  184.     case kPluginBridgeNonRtServerSetLatency:

  185.         return "kPluginBridgeNonRtServerSetLatency";

  186.     case kPluginBridgeNonRtServerReady:

  187.         return "kPluginBridgeNonRtServerReady";

  188.     case kPluginBridgeNonRtServerSaved:

  189.         return "kPluginBridgeNonRtServerSaved";

  190.     case kPluginBridgeNonRtServerUiClosed:

  191.         return "kPluginBridgeNonRtServerUiClosed";

  192.     case kPluginBridgeNonRtServerError:

  193.         return "kPluginBridgeNonRtServerError";

  194.     }

  195. 

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

  197.     return nullptr;

  198. }

  199. 

  200. // -------------------------------------------------------------------------------------------------------------------

  201. 

  202. struct BridgeAudioPool {

  203.     float* data;

  204.     std::size_t dataSize;

  205.     CarlaString filename;

  206.     char shm[64];

  207. 

  208.     BridgeAudioPool() noexcept;

  209.     ~BridgeAudioPool() noexcept;

  210. 

  211.     bool initializeServer() noexcept;

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

  213.     void clear() noexcept;

  214. 

  215. #ifndef BUILD_BRIDGE

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

  217. #endif

  218. 

  219.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeAudioPool)

  220. };

  221. 

  222. // -------------------------------------------------------------------------------------------------------------------

  223. 

  224. struct BridgeRtClientControl : public CarlaRingBufferControl<SmallStackBuffer> {

  225.     BridgeRtClientData* data;

  226.     CarlaString filename;

  227.     bool needsSemDestroy; // client only

  228.     char shm[64];

  229. 

  230.     BridgeRtClientControl() noexcept;

  231.     ~BridgeRtClientControl() noexcept override;

  232. 

  233.     bool initializeServer() noexcept;

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

  235.     void clear() noexcept;

  236. 

  237.     bool mapData() noexcept;

  238.     void unmapData() noexcept;

  239. 

  240. #ifndef BUILD_BRIDGE

  241.     // non-bridge, server

  242.     bool waitForClient(const uint msecs) noexcept;

  243.     void writeOpcode(const PluginBridgeRtClientOpcode opcode) noexcept;

  244. #else

  245.     // bridge, client

  246.     PluginBridgeRtClientOpcode readOpcode() noexcept;

  247. 

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

  249.     struct WaitHelper {

  250.         BridgeRtClientData* const data;

  251.         const bool ok;

  252. 

  253.         WaitHelper(BridgeRtClientControl& c) noexcept;

  254.         ~WaitHelper() noexcept;

  255. 

  256.         CARLA_DECLARE_NON_COPY_STRUCT(WaitHelper)

  257.     };

  258. #endif

  259. 

  260.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeRtClientControl)

  261. };

  262. 

  263. // -------------------------------------------------------------------------------------------------------------------

  264. 

  265. struct BridgeNonRtClientControl : public CarlaRingBufferControl<BigStackBuffer> {

  266.     BridgeNonRtClientData* data;

  267.     CarlaString filename;

  268.     CarlaMutex mutex;

  269.     char shm[64];

  270. 

  271.     BridgeNonRtClientControl() noexcept;

  272.     ~BridgeNonRtClientControl() noexcept override;

  273. 

  274.     bool initializeServer() noexcept;

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

  276.     void clear() noexcept;

  277. 

  278.     bool mapData() noexcept;

  279.     void unmapData() noexcept;

  280. 

  281. #ifndef BUILD_BRIDGE

  282.     // non-bridge, server

  283.     void waitIfDataIsReachingLimit() noexcept;

  284.     void writeOpcode(const PluginBridgeNonRtClientOpcode opcode) noexcept;

  285. #else

  286.     // bridge, client

  287.     PluginBridgeNonRtClientOpcode readOpcode() noexcept;

  288. #endif

  289. 

  290.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtClientControl)

  291. };

  292. 

  293. // -------------------------------------------------------------------------------------------------------------------

  294. 

  295. struct BridgeNonRtServerControl : public CarlaRingBufferControl<HugeStackBuffer> {

  296.     BridgeNonRtServerData* data;

  297.     CarlaString filename;

  298.     CarlaMutex mutex;

  299.     char shm[64];

  300. 

  301.     BridgeNonRtServerControl() noexcept;

  302.     ~BridgeNonRtServerControl() noexcept override;

  303. 

  304.     bool initializeServer() noexcept;

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

  306.     void clear() noexcept;

  307. 

  308.     bool mapData() noexcept;

  309.     void unmapData() noexcept;

  310. 

  311. #ifndef BUILD_BRIDGE

  312.     // non-bridge, server

  313.     PluginBridgeNonRtServerOpcode readOpcode() noexcept;

  314. #else

  315.     // bridge, client

  316.     void waitIfDataIsReachingLimit() noexcept;

  317.     void writeOpcode(const PluginBridgeNonRtServerOpcode opcode) noexcept;

  318. #endif

  319. 

  320.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtServerControl)

  321. };

  322. 

  323. // -------------------------------------------------------------------------------------------------------------------

  324. 

  325. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED