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

355 lines
13KB
Raw Blame History 

  1. /*

  2.  * Carla Bridge utils

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

  129. 

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

  131.     return nullptr;

  132. }

  133. 

  134. static inline

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

  136. {

  137.     switch (opcode)

  138.     {

  139.     case kPluginBridgeNonRtServerNull:

  140.         return "kPluginBridgeNonRtServerNull";

  141.     case kPluginBridgeNonRtServerPong:

  142.         return "kPluginBridgeNonRtServerPong";

  143.     case kPluginBridgeNonRtServerPluginInfo1:

  144.         return "kPluginBridgeNonRtServerPluginInfo1";

  145.     case kPluginBridgeNonRtServerPluginInfo2:

  146.         return "kPluginBridgeNonRtServerPluginInfo2";

  147.     case kPluginBridgeNonRtServerAudioCount:

  148.         return "kPluginBridgeNonRtServerAudioCount";

  149.     case kPluginBridgeNonRtServerMidiCount:

  150.         return "kPluginBridgeNonRtServerMidiCount";

  151.     case kPluginBridgeNonRtServerCvCount:

  152.         return "kPluginBridgeNonRtServerCvCount";

  153.     case kPluginBridgeNonRtServerParameterCount:

  154.         return "kPluginBridgeNonRtServerParameterCount";

  155.     case kPluginBridgeNonRtServerProgramCount:

  156.         return "kPluginBridgeNonRtServerProgramCount";

  157.     case kPluginBridgeNonRtServerMidiProgramCount:

  158.         return "kPluginBridgeNonRtServerMidiProgramCount";

  159.     case kPluginBridgeNonRtServerPortName:

  160.         return "kPluginBridgeNonRtServerPortName";

  161.     case kPluginBridgeNonRtServerParameterData1:

  162.         return "kPluginBridgeNonRtServerParameterData1";

  163.     case kPluginBridgeNonRtServerParameterData2:

  164.         return "kPluginBridgeNonRtServerParameterData2";

  165.     case kPluginBridgeNonRtServerParameterRanges:

  166.         return "kPluginBridgeNonRtServerParameterRanges";

  167.     case kPluginBridgeNonRtServerParameterValue:

  168.         return "kPluginBridgeNonRtServerParameterValue";

  169.     case kPluginBridgeNonRtServerParameterValue2:

  170.         return "kPluginBridgeNonRtServerParameterValue2";

  171.     case kPluginBridgeNonRtServerParameterTouch:

  172.         return "kPluginBridgeNonRtServerParameterTouch";

  173.     case kPluginBridgeNonRtServerDefaultValue:

  174.         return "kPluginBridgeNonRtServerDefaultValue";

  175.     case kPluginBridgeNonRtServerCurrentProgram:

  176.         return "kPluginBridgeNonRtServerCurrentProgram";

  177.     case kPluginBridgeNonRtServerCurrentMidiProgram:

  178.         return "kPluginBridgeNonRtServerCurrentMidiProgram";

  179.     case kPluginBridgeNonRtServerProgramName:

  180.         return "kPluginBridgeNonRtServerProgramName";

  181.     case kPluginBridgeNonRtServerMidiProgramData:

  182.         return "kPluginBridgeNonRtServerMidiProgramData";

  183.     case kPluginBridgeNonRtServerSetCustomData:

  184.         return "kPluginBridgeNonRtServerSetCustomData";

  185.     case kPluginBridgeNonRtServerSetChunkDataFile:

  186.         return "kPluginBridgeNonRtServerSetChunkDataFile";

  187.     case kPluginBridgeNonRtServerSetLatency:

  188.         return "kPluginBridgeNonRtServerSetLatency";

  189.     case kPluginBridgeNonRtServerSetParameterText:

  190.         return "kPluginBridgeNonRtServerSetParameterText";

  191.     case kPluginBridgeNonRtServerReady:

  192.         return "kPluginBridgeNonRtServerReady";

  193.     case kPluginBridgeNonRtServerSaved:

  194.         return "kPluginBridgeNonRtServerSaved";

  195.     case kPluginBridgeNonRtServerUiClosed:

  196.         return "kPluginBridgeNonRtServerUiClosed";

  197.     case kPluginBridgeNonRtServerError:

  198.         return "kPluginBridgeNonRtServerError";

  199.     case kPluginBridgeNonRtServerVersion:

  200.         return "kPluginBridgeNonRtServerVersion";

  201.     }

  202. 

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

  204.     return nullptr;

  205. }

  206. 

  207. // -------------------------------------------------------------------------------------------------------------------

  208. 

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

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

  211. 

  212. // Server => Client RT

  213. struct BridgeRtClientData {

  214.     BridgeSemaphore sem;

  215.     BridgeTimeInfo timeInfo;

  216.     SmallStackBuffer ringBuffer;

  217.     uint8_t midiOut[kBridgeRtClientDataMidiOutSize];

  218.     uint32_t procFlags;

  219. };

  220. 

  221. // Server => Client Non-RT

  222. struct BridgeNonRtClientData {

  223.     BigStackBuffer ringBuffer;

  224. };

  225. 

  226. // Client => Server Non-RT

  227. struct BridgeNonRtServerData {

  228.     HugeStackBuffer ringBuffer;

  229. };

  230. 

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

  232. 

  233. struct BridgeAudioPool {

  234.     float* data;

  235.     std::size_t dataSize;

  236.     CarlaString filename;

  237.     char shm[64];

  238.     bool isServer;

  239. 

  240.     BridgeAudioPool() noexcept;

  241.     ~BridgeAudioPool() noexcept;

  242. 

  243.     bool initializeServer() noexcept;

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

  245.     void clear() noexcept;

  246. 

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

  248. 

  249.     const char* getFilenameSuffix() const noexcept;

  250. 

  251.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeAudioPool)

  252. };

  253. 

  254. // -------------------------------------------------------------------------------------------------------------------

  255. 

  256. struct BridgeRtClientControl : public CarlaRingBufferControl<SmallStackBuffer> {

  257.     BridgeRtClientData* data;

  258.     CarlaString filename;

  259.     bool needsSemDestroy; // client only

  260.     char shm[64];

  261.     bool isServer;

  262. 

  263.     BridgeRtClientControl() noexcept;

  264.     ~BridgeRtClientControl() noexcept override;

  265. 

  266.     bool initializeServer() noexcept;

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

  268.     void clear() noexcept;

  269. 

  270.     bool mapData() noexcept;

  271.     void unmapData() noexcept;

  272. 

  273.     // non-bridge, server

  274.     bool waitForClient(const uint msecs) noexcept;

  275.     bool writeOpcode(const PluginBridgeRtClientOpcode opcode) noexcept;

  276. 

  277.     // bridge, client

  278.     PluginBridgeRtClientOpcode readOpcode() noexcept;

  279. 

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

  281.     struct WaitHelper {

  282.         BridgeRtClientData* const data;

  283.         const bool ok;

  284. 

  285.         WaitHelper(BridgeRtClientControl& c) noexcept;

  286.         ~WaitHelper() noexcept;

  287. 

  288.         CARLA_DECLARE_NON_COPY_STRUCT(WaitHelper)

  289.     };

  290. 

  291.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeRtClientControl)

  292. };

  293. 

  294. // -------------------------------------------------------------------------------------------------------------------

  295. 

  296. struct BridgeNonRtClientControl : public CarlaRingBufferControl<BigStackBuffer> {

  297.     BridgeNonRtClientData* data;

  298.     CarlaString filename;

  299.     CarlaMutex mutex;

  300.     char shm[64];

  301.     bool isServer;

  302. 

  303.     BridgeNonRtClientControl() noexcept;

  304.     ~BridgeNonRtClientControl() noexcept override;

  305. 

  306.     bool initializeServer() noexcept;

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

  308.     void clear() noexcept;

  309. 

  310.     bool mapData() noexcept;

  311.     void unmapData() noexcept;

  312. 

  313.     // non-bridge, server

  314.     void waitIfDataIsReachingLimit() noexcept;

  315.     bool writeOpcode(const PluginBridgeNonRtClientOpcode opcode) noexcept;

  316. 

  317.     // bridge, client

  318.     PluginBridgeNonRtClientOpcode readOpcode() noexcept;

  319. 

  320.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtClientControl)

  321. };

  322. 

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

  324. 

  325. struct BridgeNonRtServerControl : public CarlaRingBufferControl<HugeStackBuffer> {

  326.     BridgeNonRtServerData* data;

  327.     CarlaString filename;

  328.     CarlaMutex mutex;

  329.     char shm[64];

  330.     bool isServer;

  331. 

  332.     BridgeNonRtServerControl() noexcept;

  333.     ~BridgeNonRtServerControl() noexcept override;

  334. 

  335.     bool initializeServer() noexcept;

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

  337.     void clear() noexcept;

  338. 

  339.     bool mapData() noexcept;

  340.     void unmapData() noexcept;

  341. 

  342.     // non-bridge, server

  343.     PluginBridgeNonRtServerOpcode readOpcode() noexcept;

  344. 

  345.     // bridge, client

  346.     void waitIfDataIsReachingLimit() noexcept;

  347.     bool writeOpcode(const PluginBridgeNonRtServerOpcode opcode) noexcept;

  348. 

  349.     CARLA_DECLARE_NON_COPY_STRUCT(BridgeNonRtServerControl)

  350. };

  351. 

  352. // -------------------------------------------------------------------------------------------------------------------

  353. 

  354. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED