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

324 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 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 kPluginBridgeNonRtClientPrepareForSave:

  112.         return "kPluginBridgeNonRtClientPrepareForSave";

  113.     case kPluginBridgeNonRtClientShowUI:

  114.         return "kPluginBridgeNonRtClientShowUI";

  115.     case kPluginBridgeNonRtClientHideUI:

  116.         return "kPluginBridgeNonRtClientHideUI";

  117.     case kPluginBridgeNonRtClientUiParameterChange:

  118.         return "kPluginBridgeNonRtClientUiParameterChange";

  119.     case kPluginBridgeNonRtClientUiProgramChange:

  120.         return "kPluginBridgeNonRtClientUiProgramChange";

  121.     case kPluginBridgeNonRtClientUiMidiProgramChange:

  122.         return "kPluginBridgeNonRtClientUiMidiProgramChange";

  123.     case kPluginBridgeNonRtClientUiNoteOn:

  124.         return "kPluginBridgeNonRtClientUiNoteOn";

  125.     case kPluginBridgeNonRtClientUiNoteOff:

  126.         return "kPluginBridgeNonRtClientUiNoteOff";

  127.     case kPluginBridgeNonRtClientQuit:

  128.         return "kPluginBridgeNonRtClientQuit";

  129.     }

  130. 

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

  132.     return nullptr;

  133. }

  134. 

  135. static inline

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

  137. {

  138.     switch (opcode)

  139.     {

  140.     case kPluginBridgeNonRtServerNull:

  141.         return "kPluginBridgeNonRtServerNull";

  142.     case kPluginBridgeNonRtServerPong:

  143.         return "kPluginBridgeNonRtServerPong";

  144.     case kPluginBridgeNonRtServerPluginInfo1:

  145.         return "kPluginBridgeNonRtServerPluginInfo1";

  146.     case kPluginBridgeNonRtServerPluginInfo2:

  147.         return "kPluginBridgeNonRtServerPluginInfo2";

  148.     case kPluginBridgeNonRtServerAudioCount:

  149.         return "kPluginBridgeNonRtServerAudioCount";

  150.     case kPluginBridgeNonRtServerMidiCount:

  151.         return "kPluginBridgeNonRtServerMidiCount";

  152.     case kPluginBridgeNonRtServerCvCount:

  153.         return "kPluginBridgeNonRtServerCvCount";

  154.     case kPluginBridgeNonRtServerParameterCount:

  155.         return "kPluginBridgeNonRtServerParameterCount";

  156.     case kPluginBridgeNonRtServerProgramCount:

  157.         return "kPluginBridgeNonRtServerProgramCount";

  158.     case kPluginBridgeNonRtServerMidiProgramCount:

  159.         return "kPluginBridgeNonRtServerMidiProgramCount";

  160.     case kPluginBridgeNonRtServerPortName:

  161.         return "kPluginBridgeNonRtServerPortName";

  162.     case kPluginBridgeNonRtServerParameterData1:

  163.         return "kPluginBridgeNonRtServerParameterData1";

  164.     case kPluginBridgeNonRtServerParameterData2:

  165.         return "kPluginBridgeNonRtServerParameterData2";

  166.     case kPluginBridgeNonRtServerParameterRanges:

  167.         return "kPluginBridgeNonRtServerParameterRanges";

  168.     case kPluginBridgeNonRtServerParameterValue:

  169.         return "kPluginBridgeNonRtServerParameterValue";

  170.     case kPluginBridgeNonRtServerParameterValue2:

  171.         return "kPluginBridgeNonRtServerParameterValue2";

  172.     case kPluginBridgeNonRtServerDefaultValue:

  173.         return "kPluginBridgeNonRtServerDefaultValue";

  174.     case kPluginBridgeNonRtServerCurrentProgram:

  175.         return "kPluginBridgeNonRtServerCurrentProgram";

  176.     case kPluginBridgeNonRtServerCurrentMidiProgram:

  177.         return "kPluginBridgeNonRtServerCurrentMidiProgram";

  178.     case kPluginBridgeNonRtServerProgramName:

  179.         return "kPluginBridgeNonRtServerProgramName";

  180.     case kPluginBridgeNonRtServerMidiProgramData:

  181.         return "kPluginBridgeNonRtServerMidiProgramData";

  182.     case kPluginBridgeNonRtServerSetCustomData:

  183.         return "kPluginBridgeNonRtServerSetCustomData";

  184.     case kPluginBridgeNonRtServerSetChunkDataFile:

  185.         return "kPluginBridgeNonRtServerSetChunkDataFile";

  186.     case kPluginBridgeNonRtServerSetLatency:

  187.         return "kPluginBridgeNonRtServerSetLatency";

  188.     case kPluginBridgeNonRtServerReady:

  189.         return "kPluginBridgeNonRtServerReady";

  190.     case kPluginBridgeNonRtServerSaved:

  191.         return "kPluginBridgeNonRtServerSaved";

  192.     case kPluginBridgeNonRtServerUiClosed:

  193.         return "kPluginBridgeNonRtServerUiClosed";

  194.     case kPluginBridgeNonRtServerError:

  195.         return "kPluginBridgeNonRtServerError";

  196.     }

  197. 

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

  199.     return nullptr;

  200. }

  201. 

  202. // -------------------------------------------------------------------------------------------------------------------

  203. 

  204. struct BridgeAudioPool {

  205.     float* data;

  206.     std::size_t dataSize;

  207.     CarlaString filename;

  208.     char shm[64];

  209.     bool isServer;

  210. 

  211.     BridgeAudioPool() noexcept;

  212.     ~BridgeAudioPool() noexcept;

  213. 

  214.     bool initializeServer() noexcept;

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

  216.     void clear() noexcept;

  217. 

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

  219. 

  220.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeAudioPool)

  221. };

  222. 

  223. // -------------------------------------------------------------------------------------------------------------------

  224. 

  225. struct BridgeRtClientControl : public CarlaRingBufferControl<SmallStackBuffer> {

  226.     BridgeRtClientData* data;

  227.     CarlaString filename;

  228.     bool needsSemDestroy; // client only

  229.     char shm[64];

  230.     bool isServer;

  231. 

  232.     BridgeRtClientControl() noexcept;

  233.     ~BridgeRtClientControl() noexcept override;

  234. 

  235.     bool initializeServer() noexcept;

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

  237.     void clear() noexcept;

  238. 

  239.     bool mapData() noexcept;

  240.     void unmapData() noexcept;

  241. 

  242.     // non-bridge, server

  243.     bool waitForClient(const uint msecs) noexcept;

  244.     void writeOpcode(const PluginBridgeRtClientOpcode opcode) noexcept;

  245. 

  246.     // bridge, client

  247.     PluginBridgeRtClientOpcode readOpcode() noexcept;

  248. 

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

  250.     struct WaitHelper {

  251.         BridgeRtClientData* const data;

  252.         const bool ok;

  253. 

  254.         WaitHelper(BridgeRtClientControl& c) noexcept;

  255.         ~WaitHelper() noexcept;

  256. 

  257.         CARLA_DECLARE_NON_COPY_STRUCT(WaitHelper)

  258.     };

  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.     bool isServer;

  271. 

  272.     BridgeNonRtClientControl() noexcept;

  273.     ~BridgeNonRtClientControl() noexcept override;

  274. 

  275.     bool initializeServer() noexcept;

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

  277.     void clear() noexcept;

  278. 

  279.     bool mapData() noexcept;

  280.     void unmapData() noexcept;

  281. 

  282.     // non-bridge, server

  283.     void waitIfDataIsReachingLimit() noexcept;

  284.     void writeOpcode(const PluginBridgeNonRtClientOpcode opcode) noexcept;

  285. 

  286.     // bridge, client

  287.     PluginBridgeNonRtClientOpcode readOpcode() noexcept;

  288. 

  289.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtClientControl)

  290. };

  291. 

  292. // -------------------------------------------------------------------------------------------------------------------

  293. 

  294. struct BridgeNonRtServerControl : public CarlaRingBufferControl<HugeStackBuffer> {

  295.     BridgeNonRtServerData* data;

  296.     CarlaString filename;

  297.     CarlaMutex mutex;

  298.     char shm[64];

  299.     bool isServer;

  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.     // non-bridge, server

  312.     PluginBridgeNonRtServerOpcode readOpcode() noexcept;

  313. 

  314.     // bridge, client

  315.     void waitIfDataIsReachingLimit() noexcept;

  316.     void writeOpcode(const PluginBridgeNonRtServerOpcode opcode) noexcept;

  317. 

  318.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtServerControl)

  319. };

  320. 

  321. // -------------------------------------------------------------------------------------------------------------------

  322. 

  323. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED