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

330 lines
13KB
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 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 kPluginBridgeNonRtClientShowUI:

  116.         return "kPluginBridgeNonRtClientShowUI";

  117.     case kPluginBridgeNonRtClientHideUI:

  118.         return "kPluginBridgeNonRtClientHideUI";

  119.     case kPluginBridgeNonRtClientUiParameterChange:

  120.         return "kPluginBridgeNonRtClientUiParameterChange";

  121.     case kPluginBridgeNonRtClientUiProgramChange:

  122.         return "kPluginBridgeNonRtClientUiProgramChange";

  123.     case kPluginBridgeNonRtClientUiMidiProgramChange:

  124.         return "kPluginBridgeNonRtClientUiMidiProgramChange";

  125.     case kPluginBridgeNonRtClientUiNoteOn:

  126.         return "kPluginBridgeNonRtClientUiNoteOn";

  127.     case kPluginBridgeNonRtClientUiNoteOff:

  128.         return "kPluginBridgeNonRtClientUiNoteOff";

  129.     case kPluginBridgeNonRtClientQuit:

  130.         return "kPluginBridgeNonRtClientQuit";

  131.     }

  132. 

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

  134.     return nullptr;

  135. }

  136. 

  137. static inline

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

  139. {

  140.     switch (opcode)

  141.     {

  142.     case kPluginBridgeNonRtServerNull:

  143.         return "kPluginBridgeNonRtServerNull";

  144.     case kPluginBridgeNonRtServerPong:

  145.         return "kPluginBridgeNonRtServerPong";

  146.     case kPluginBridgeNonRtServerPluginInfo1:

  147.         return "kPluginBridgeNonRtServerPluginInfo1";

  148.     case kPluginBridgeNonRtServerPluginInfo2:

  149.         return "kPluginBridgeNonRtServerPluginInfo2";

  150.     case kPluginBridgeNonRtServerAudioCount:

  151.         return "kPluginBridgeNonRtServerAudioCount";

  152.     case kPluginBridgeNonRtServerMidiCount:

  153.         return "kPluginBridgeNonRtServerMidiCount";

  154.     case kPluginBridgeNonRtServerCvCount:

  155.         return "kPluginBridgeNonRtServerCvCount";

  156.     case kPluginBridgeNonRtServerParameterCount:

  157.         return "kPluginBridgeNonRtServerParameterCount";

  158.     case kPluginBridgeNonRtServerProgramCount:

  159.         return "kPluginBridgeNonRtServerProgramCount";

  160.     case kPluginBridgeNonRtServerMidiProgramCount:

  161.         return "kPluginBridgeNonRtServerMidiProgramCount";

  162.     case kPluginBridgeNonRtServerPortName:

  163.         return "kPluginBridgeNonRtServerPortName";

  164.     case kPluginBridgeNonRtServerParameterData1:

  165.         return "kPluginBridgeNonRtServerParameterData1";

  166.     case kPluginBridgeNonRtServerParameterData2:

  167.         return "kPluginBridgeNonRtServerParameterData2";

  168.     case kPluginBridgeNonRtServerParameterRanges:

  169.         return "kPluginBridgeNonRtServerParameterRanges";

  170.     case kPluginBridgeNonRtServerParameterValue:

  171.         return "kPluginBridgeNonRtServerParameterValue";

  172.     case kPluginBridgeNonRtServerParameterValue2:

  173.         return "kPluginBridgeNonRtServerParameterValue2";

  174.     case kPluginBridgeNonRtServerDefaultValue:

  175.         return "kPluginBridgeNonRtServerDefaultValue";

  176.     case kPluginBridgeNonRtServerCurrentProgram:

  177.         return "kPluginBridgeNonRtServerCurrentProgram";

  178.     case kPluginBridgeNonRtServerCurrentMidiProgram:

  179.         return "kPluginBridgeNonRtServerCurrentMidiProgram";

  180.     case kPluginBridgeNonRtServerProgramName:

  181.         return "kPluginBridgeNonRtServerProgramName";

  182.     case kPluginBridgeNonRtServerMidiProgramData:

  183.         return "kPluginBridgeNonRtServerMidiProgramData";

  184.     case kPluginBridgeNonRtServerSetCustomData:

  185.         return "kPluginBridgeNonRtServerSetCustomData";

  186.     case kPluginBridgeNonRtServerSetChunkDataFile:

  187.         return "kPluginBridgeNonRtServerSetChunkDataFile";

  188.     case kPluginBridgeNonRtServerSetLatency:

  189.         return "kPluginBridgeNonRtServerSetLatency";

  190.     case kPluginBridgeNonRtServerSetParameterText:

  191.         return "kPluginBridgeNonRtServerSetParameterText";

  192.     case kPluginBridgeNonRtServerReady:

  193.         return "kPluginBridgeNonRtServerReady";

  194.     case kPluginBridgeNonRtServerSaved:

  195.         return "kPluginBridgeNonRtServerSaved";

  196.     case kPluginBridgeNonRtServerUiClosed:

  197.         return "kPluginBridgeNonRtServerUiClosed";

  198.     case kPluginBridgeNonRtServerError:

  199.         return "kPluginBridgeNonRtServerError";

  200.     }

  201. 

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

  203.     return nullptr;

  204. }

  205. 

  206. // -------------------------------------------------------------------------------------------------------------------

  207. 

  208. struct BridgeAudioPool {

  209.     float* data;

  210.     std::size_t dataSize;

  211.     CarlaString filename;

  212.     char shm[64];

  213.     bool isServer;

  214. 

  215.     BridgeAudioPool() noexcept;

  216.     ~BridgeAudioPool() noexcept;

  217. 

  218.     bool initializeServer() noexcept;

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

  220.     void clear() noexcept;

  221. 

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

  223. 

  224.     const char* getFilenameSuffix() const noexcept;

  225. 

  226.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeAudioPool)

  227. };

  228. 

  229. // -------------------------------------------------------------------------------------------------------------------

  230. 

  231. struct BridgeRtClientControl : public CarlaRingBufferControl<SmallStackBuffer> {

  232.     BridgeRtClientData* data;

  233.     CarlaString filename;

  234.     bool needsSemDestroy; // client only

  235.     char shm[64];

  236.     bool isServer;

  237. 

  238.     BridgeRtClientControl() noexcept;

  239.     ~BridgeRtClientControl() noexcept override;

  240. 

  241.     bool initializeServer() noexcept;

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

  243.     void clear() noexcept;

  244. 

  245.     bool mapData() noexcept;

  246.     void unmapData() noexcept;

  247. 

  248.     // non-bridge, server

  249.     bool waitForClient(const uint msecs) noexcept;

  250.     bool writeOpcode(const PluginBridgeRtClientOpcode opcode) noexcept;

  251. 

  252.     // bridge, client

  253.     PluginBridgeRtClientOpcode readOpcode() noexcept;

  254. 

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

  256.     struct WaitHelper {

  257.         BridgeRtClientData* const data;

  258.         const bool ok;

  259. 

  260.         WaitHelper(BridgeRtClientControl& c) noexcept;

  261.         ~WaitHelper() noexcept;

  262. 

  263.         CARLA_DECLARE_NON_COPY_STRUCT(WaitHelper)

  264.     };

  265. 

  266.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeRtClientControl)

  267. };

  268. 

  269. // -------------------------------------------------------------------------------------------------------------------

  270. 

  271. struct BridgeNonRtClientControl : public CarlaRingBufferControl<BigStackBuffer> {

  272.     BridgeNonRtClientData* data;

  273.     CarlaString filename;

  274.     CarlaMutex mutex;

  275.     char shm[64];

  276.     bool isServer;

  277. 

  278.     BridgeNonRtClientControl() noexcept;

  279.     ~BridgeNonRtClientControl() noexcept override;

  280. 

  281.     bool initializeServer() noexcept;

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

  283.     void clear() noexcept;

  284. 

  285.     bool mapData() noexcept;

  286.     void unmapData() noexcept;

  287. 

  288.     // non-bridge, server

  289.     void waitIfDataIsReachingLimit() noexcept;

  290.     bool writeOpcode(const PluginBridgeNonRtClientOpcode opcode) noexcept;

  291. 

  292.     // bridge, client

  293.     PluginBridgeNonRtClientOpcode readOpcode() noexcept;

  294. 

  295.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtClientControl)

  296. };

  297. 

  298. // -------------------------------------------------------------------------------------------------------------------

  299. 

  300. struct BridgeNonRtServerControl : public CarlaRingBufferControl<HugeStackBuffer> {

  301.     BridgeNonRtServerData* data;

  302.     CarlaString filename;

  303.     CarlaMutex mutex;

  304.     char shm[64];

  305.     bool isServer;

  306. 

  307.     BridgeNonRtServerControl() noexcept;

  308.     ~BridgeNonRtServerControl() noexcept override;

  309. 

  310.     bool initializeServer() noexcept;

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

  312.     void clear() noexcept;

  313. 

  314.     bool mapData() noexcept;

  315.     void unmapData() noexcept;

  316. 

  317.     // non-bridge, server

  318.     PluginBridgeNonRtServerOpcode readOpcode() noexcept;

  319. 

  320.     // bridge, client

  321.     void waitIfDataIsReachingLimit() noexcept;

  322.     bool writeOpcode(const PluginBridgeNonRtServerOpcode opcode) noexcept;

  323. 

  324.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtServerControl)

  325. };

  326. 

  327. // -------------------------------------------------------------------------------------------------------------------

  328. 

  329. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED