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.
6251 Commits
17 Branches
381MB
Tree: c397f32066
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'c397f32066'
${ noResults }
Carla/source/utils/CarlaBridgeUtils.hpp

363 lines
14KB
Raw Blame History 

  1. /*

  2.  * Carla Bridge utils

  3.  * Copyright (C) 2013-2022 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 "CarlaRingBuffer.hpp"

  24. #include "CarlaString.hpp"

  25. 

  26. // -------------------------------------------------------------------------------------------------------------------

  27. 

  28. static inline

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

  30. {

  31.     switch (opcode)

  32.     {

  33.     case kPluginBridgeRtClientNull:

  34.         return "kPluginBridgeRtClientNull";

  35.     case kPluginBridgeRtClientSetAudioPool:

  36.         return "kPluginBridgeRtClientSetAudioPool";

  37.     case kPluginBridgeRtClientSetBufferSize:

  38.         return "kPluginBridgeRtClientSetBufferSize";

  39.     case kPluginBridgeRtClientSetSampleRate:

  40.         return "kPluginBridgeRtClientSetSampleRate";

  41.     case kPluginBridgeRtClientSetOnline:

  42.         return "kPluginBridgeRtClientSetOnline";

  43.     case kPluginBridgeRtClientControlEventParameter:

  44.         return "kPluginBridgeRtClientControlEventParameter";

  45.     case kPluginBridgeRtClientControlEventMidiBank:

  46.         return "kPluginBridgeRtClientControlEventMidiBank";

  47.     case kPluginBridgeRtClientControlEventMidiProgram:

  48.         return "kPluginBridgeRtClientControlEventMidiProgram";

  49.     case kPluginBridgeRtClientControlEventAllSoundOff:

  50.         return "kPluginBridgeRtClientControlEventAllSoundOff";

  51.     case kPluginBridgeRtClientControlEventAllNotesOff:

  52.         return "kPluginBridgeRtClientControlEventAllNotesOff";

  53.     case kPluginBridgeRtClientMidiEvent:

  54.         return "kPluginBridgeRtClientMidiEvent";

  55.     case kPluginBridgeRtClientProcess:

  56.         return "kPluginBridgeRtClientProcess";

  57.     case kPluginBridgeRtClientQuit:

  58.         return "kPluginBridgeRtClientQuit";

  59.     }

  60. 

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

  62.     return nullptr;

  63. }

  64. 

  65. static inline

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

  67. {

  68.     switch (opcode)

  69.     {

  70.     case kPluginBridgeNonRtClientNull:

  71.         return "kPluginBridgeNonRtClientNull";

  72.     case kPluginBridgeNonRtClientVersion:

  73.         return "kPluginBridgeNonRtClientVersion";

  74.     case kPluginBridgeNonRtClientPing:

  75.         return "kPluginBridgeNonRtClientPing";

  76.     case kPluginBridgeNonRtClientPingOnOff:

  77.         return "kPluginBridgeNonRtClientPingOnOff";

  78.     case kPluginBridgeNonRtClientActivate:

  79.         return "kPluginBridgeNonRtClientActivate";

  80.     case kPluginBridgeNonRtClientDeactivate:

  81.         return "kPluginBridgeNonRtClientDeactivate";

  82.     case kPluginBridgeNonRtClientInitialSetup:

  83.         return "kPluginBridgeNonRtClientInitialSetup";

  84.     case kPluginBridgeNonRtClientSetParameterValue:

  85.         return "kPluginBridgeNonRtClientSetParameterValue";

  86.     case kPluginBridgeNonRtClientSetParameterMidiChannel:

  87.         return "kPluginBridgeNonRtClientSetParameterMidiChannel";

  88.     case kPluginBridgeNonRtClientSetParameterMappedControlIndex:

  89.         return "kPluginBridgeNonRtClientSetParameterMappedControlIndex";

  90.     case kPluginBridgeNonRtClientSetProgram:

  91.         return "kPluginBridgeNonRtClientSetProgram";

  92.     case kPluginBridgeNonRtClientSetMidiProgram:

  93.         return "kPluginBridgeNonRtClientSetMidiProgram";

  94.     case kPluginBridgeNonRtClientSetCustomData:

  95.         return "kPluginBridgeNonRtClientSetCustomData";

  96.     case kPluginBridgeNonRtClientSetChunkDataFile:

  97.         return "kPluginBridgeNonRtClientSetChunkDataFile";

  98.     case kPluginBridgeNonRtClientSetCtrlChannel:

  99.         return "kPluginBridgeNonRtClientSetCtrlChannel";

  100.     case kPluginBridgeNonRtClientSetOption:

  101.         return "kPluginBridgeNonRtClientSetOption";

  102.     case kPluginBridgeNonRtClientGetParameterText:

  103.         return "kPluginBridgeNonRtClientGetParameterText";

  104.     case kPluginBridgeNonRtClientPrepareForSave:

  105.         return "kPluginBridgeNonRtClientPrepareForSave";

  106.     case kPluginBridgeNonRtClientRestoreLV2State:

  107.         return "kPluginBridgeNonRtClientRestoreLV2State";

  108.     case kPluginBridgeNonRtClientShowUI:

  109.         return "kPluginBridgeNonRtClientShowUI";

  110.     case kPluginBridgeNonRtClientHideUI:

  111.         return "kPluginBridgeNonRtClientHideUI";

  112.     case kPluginBridgeNonRtClientUiParameterChange:

  113.         return "kPluginBridgeNonRtClientUiParameterChange";

  114.     case kPluginBridgeNonRtClientUiProgramChange:

  115.         return "kPluginBridgeNonRtClientUiProgramChange";

  116.     case kPluginBridgeNonRtClientUiMidiProgramChange:

  117.         return "kPluginBridgeNonRtClientUiMidiProgramChange";

  118.     case kPluginBridgeNonRtClientUiNoteOn:

  119.         return "kPluginBridgeNonRtClientUiNoteOn";

  120.     case kPluginBridgeNonRtClientUiNoteOff:

  121.         return "kPluginBridgeNonRtClientUiNoteOff";

  122.     case kPluginBridgeNonRtClientQuit:

  123.         return "kPluginBridgeNonRtClientQuit";

  124.     case kPluginBridgeNonRtClientSetParameterMappedRange:

  125.         return "kPluginBridgeNonRtClientSetParameterMappedRange";

  126.     case kPluginBridgeNonRtClientSetOptions:

  127.         return "kPluginBridgeNonRtClientSetOptions";

  128.     case kPluginBridgeNonRtClientSetWindowTitle:

  129.         return "kPluginBridgeNonRtClientSetWindowTitle";

  130.     case kPluginBridgeNonRtClientEmbedUI:

  131.         return "kPluginBridgeNonRtClientEmbedUI";

  132.     }

  133. 

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

  135.     return nullptr;

  136. }

  137. 

  138. static inline

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

  140. {

  141.     switch (opcode)

  142.     {

  143.     case kPluginBridgeNonRtServerNull:

  144.         return "kPluginBridgeNonRtServerNull";

  145.     case kPluginBridgeNonRtServerPong:

  146.         return "kPluginBridgeNonRtServerPong";

  147.     case kPluginBridgeNonRtServerPluginInfo1:

  148.         return "kPluginBridgeNonRtServerPluginInfo1";

  149.     case kPluginBridgeNonRtServerPluginInfo2:

  150.         return "kPluginBridgeNonRtServerPluginInfo2";

  151.     case kPluginBridgeNonRtServerAudioCount:

  152.         return "kPluginBridgeNonRtServerAudioCount";

  153.     case kPluginBridgeNonRtServerMidiCount:

  154.         return "kPluginBridgeNonRtServerMidiCount";

  155.     case kPluginBridgeNonRtServerCvCount:

  156.         return "kPluginBridgeNonRtServerCvCount";

  157.     case kPluginBridgeNonRtServerParameterCount:

  158.         return "kPluginBridgeNonRtServerParameterCount";

  159.     case kPluginBridgeNonRtServerProgramCount:

  160.         return "kPluginBridgeNonRtServerProgramCount";

  161.     case kPluginBridgeNonRtServerMidiProgramCount:

  162.         return "kPluginBridgeNonRtServerMidiProgramCount";

  163.     case kPluginBridgeNonRtServerPortName:

  164.         return "kPluginBridgeNonRtServerPortName";

  165.     case kPluginBridgeNonRtServerParameterData1:

  166.         return "kPluginBridgeNonRtServerParameterData1";

  167.     case kPluginBridgeNonRtServerParameterData2:

  168.         return "kPluginBridgeNonRtServerParameterData2";

  169.     case kPluginBridgeNonRtServerParameterRanges:

  170.         return "kPluginBridgeNonRtServerParameterRanges";

  171.     case kPluginBridgeNonRtServerParameterValue:

  172.         return "kPluginBridgeNonRtServerParameterValue";

  173.     case kPluginBridgeNonRtServerParameterValue2:

  174.         return "kPluginBridgeNonRtServerParameterValue2";

  175.     case kPluginBridgeNonRtServerParameterTouch:

  176.         return "kPluginBridgeNonRtServerParameterTouch";

  177.     case kPluginBridgeNonRtServerDefaultValue:

  178.         return "kPluginBridgeNonRtServerDefaultValue";

  179.     case kPluginBridgeNonRtServerCurrentProgram:

  180.         return "kPluginBridgeNonRtServerCurrentProgram";

  181.     case kPluginBridgeNonRtServerCurrentMidiProgram:

  182.         return "kPluginBridgeNonRtServerCurrentMidiProgram";

  183.     case kPluginBridgeNonRtServerProgramName:

  184.         return "kPluginBridgeNonRtServerProgramName";

  185.     case kPluginBridgeNonRtServerMidiProgramData:

  186.         return "kPluginBridgeNonRtServerMidiProgramData";

  187.     case kPluginBridgeNonRtServerSetCustomData:

  188.         return "kPluginBridgeNonRtServerSetCustomData";

  189.     case kPluginBridgeNonRtServerSetChunkDataFile:

  190.         return "kPluginBridgeNonRtServerSetChunkDataFile";

  191.     case kPluginBridgeNonRtServerSetLatency:

  192.         return "kPluginBridgeNonRtServerSetLatency";

  193.     case kPluginBridgeNonRtServerSetParameterText:

  194.         return "kPluginBridgeNonRtServerSetParameterText";

  195.     case kPluginBridgeNonRtServerReady:

  196.         return "kPluginBridgeNonRtServerReady";

  197.     case kPluginBridgeNonRtServerSaved:

  198.         return "kPluginBridgeNonRtServerSaved";

  199.     case kPluginBridgeNonRtServerUiClosed:

  200.         return "kPluginBridgeNonRtServerUiClosed";

  201.     case kPluginBridgeNonRtServerError:

  202.         return "kPluginBridgeNonRtServerError";

  203.     case kPluginBridgeNonRtServerVersion:

  204.         return "kPluginBridgeNonRtServerVersion";

  205.     case kPluginBridgeNonRtServerRespEmbedUI:

  206.         return "kPluginBridgeNonRtServerRespEmbedUI";

  207.     case kPluginBridgeNonRtServerResizeEmbedUI:

  208.         return "kPluginBridgeNonRtServerResizeEmbedUI";

  209.     }

  210. 

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

  212.     return nullptr;

  213. }

  214. 

  215. // -------------------------------------------------------------------------------------------------------------------

  216. 

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

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

  219. 

  220. // Server => Client RT

  221. struct BridgeRtClientData {

  222.     BridgeSemaphore sem;

  223.     BridgeTimeInfo timeInfo;

  224.     SmallStackBuffer ringBuffer;

  225.     uint8_t midiOut[kBridgeRtClientDataMidiOutSize];

  226.     uint32_t procFlags;

  227. };

  228. 

  229. // Server => Client Non-RT

  230. struct BridgeNonRtClientData {

  231.     BigStackBuffer ringBuffer;

  232. };

  233. 

  234. // Client => Server Non-RT

  235. struct BridgeNonRtServerData {

  236.     HugeStackBuffer ringBuffer;

  237. };

  238. 

  239. // -------------------------------------------------------------------------------------------------------------------

  240. 

  241. struct BridgeAudioPool {

  242.     float* data;

  243.     std::size_t dataSize;

  244.     CarlaString filename;

  245.     char shm[64];

  246.     bool isServer;

  247. 

  248.     BridgeAudioPool() noexcept;

  249.     ~BridgeAudioPool() noexcept;

  250. 

  251.     bool initializeServer() noexcept;

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

  253.     void clear() noexcept;

  254. 

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

  256. 

  257.     const char* getFilenameSuffix() const noexcept;

  258. 

  259.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeAudioPool)

  260. };

  261. 

  262. // -------------------------------------------------------------------------------------------------------------------

  263. 

  264. struct BridgeRtClientControl : public CarlaRingBufferControl<SmallStackBuffer> {

  265.     BridgeRtClientData* data;

  266.     CarlaString filename;

  267.     bool needsSemDestroy; // client only

  268.     char shm[64];

  269.     bool isServer;

  270. 

  271.     BridgeRtClientControl() noexcept;

  272.     ~BridgeRtClientControl() 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.     // non-bridge, server

  282.     bool waitForClient(const uint msecs) noexcept;

  283.     bool writeOpcode(const PluginBridgeRtClientOpcode opcode) noexcept;

  284. 

  285.     // bridge, client

  286.     PluginBridgeRtClientOpcode readOpcode() noexcept;

  287. 

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

  289.     struct WaitHelper {

  290.         BridgeRtClientData* const data;

  291.         const bool ok;

  292. 

  293.         WaitHelper(BridgeRtClientControl& c) noexcept;

  294.         ~WaitHelper() noexcept;

  295. 

  296.         CARLA_DECLARE_NON_COPY_STRUCT(WaitHelper)

  297.     };

  298. 

  299.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeRtClientControl)

  300. };

  301. 

  302. // -------------------------------------------------------------------------------------------------------------------

  303. 

  304. struct BridgeNonRtClientControl : public CarlaRingBufferControl<BigStackBuffer> {

  305.     BridgeNonRtClientData* data;

  306.     CarlaString filename;

  307.     CarlaMutex mutex;

  308.     char shm[64];

  309.     bool isServer;

  310. 

  311.     BridgeNonRtClientControl() noexcept;

  312.     ~BridgeNonRtClientControl() noexcept override;

  313. 

  314.     bool initializeServer() noexcept;

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

  316.     void clear() noexcept;

  317. 

  318.     bool mapData() noexcept;

  319.     void unmapData() noexcept;

  320. 

  321.     // non-bridge, server

  322.     void waitIfDataIsReachingLimit() noexcept;

  323.     bool writeOpcode(const PluginBridgeNonRtClientOpcode opcode) noexcept;

  324. 

  325.     // bridge, client

  326.     PluginBridgeNonRtClientOpcode readOpcode() noexcept;

  327. 

  328.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtClientControl)

  329. };

  330. 

  331. // -------------------------------------------------------------------------------------------------------------------

  332. 

  333. struct BridgeNonRtServerControl : public CarlaRingBufferControl<HugeStackBuffer> {

  334.     BridgeNonRtServerData* data;

  335.     CarlaString filename;

  336.     CarlaMutex mutex;

  337.     char shm[64];

  338.     bool isServer;

  339. 

  340.     BridgeNonRtServerControl() noexcept;

  341.     ~BridgeNonRtServerControl() noexcept override;

  342. 

  343.     bool initializeServer() noexcept;

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

  345.     void clear() noexcept;

  346. 

  347.     bool mapData() noexcept;

  348.     void unmapData() noexcept;

  349. 

  350.     // non-bridge, server

  351.     PluginBridgeNonRtServerOpcode readOpcode() noexcept;

  352. 

  353.     // bridge, client

  354.     void waitIfDataIsReachingLimit() noexcept;

  355.     bool writeOpcode(const PluginBridgeNonRtServerOpcode opcode) noexcept;

  356. 

  357.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtServerControl)

  358. };

  359. 

  360. // -------------------------------------------------------------------------------------------------------------------

  361. 

  362. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED