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

341 lines
15KB
Raw Blame History 

  1. /*

  2.  * Carla Bridge utils

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

  22. 

  23. #if defined(CARLA_OS_WIN) && defined(BUILDING_CARLA_FOR_WINDOWS)

  24. # define PLUGIN_BRIDGE_NAMEPREFIX_AUDIO_POOL    "Global\\carla-bridge_shm_ap_"

  25. # define PLUGIN_BRIDGE_NAMEPREFIX_RT_CLIENT     "Global\\carla-bridge_shm_rtC_"

  26. # define PLUGIN_BRIDGE_NAMEPREFIX_NON_RT_CLIENT "Global\\carla-bridge_shm_nonrtC_"

  27. # define PLUGIN_BRIDGE_NAMEPREFIX_NON_RT_SERVER "Global\\carla-bridge_shm_nonrtS_"

  28. #else

  29. # define PLUGIN_BRIDGE_NAMEPREFIX_AUDIO_POOL    "/crlbrdg_shm_ap_"

  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. // Server sends these to client during RT

  38. enum PluginBridgeRtClientOpcode {

  39.     kPluginBridgeRtClientNull = 0,

  40.     kPluginBridgeRtClientSetAudioPool,            // ulong/ptr

  41.     kPluginBridgeRtClientControlEventParameter,   // uint/frame, byte/chan, ushort, float

  42.     kPluginBridgeRtClientControlEventMidiBank,    // uint/frame, byte/chan, ushort

  43.     kPluginBridgeRtClientControlEventMidiProgram, // uint/frame, byte/chan, ushort

  44.     kPluginBridgeRtClientControlEventAllSoundOff, // uint/frame, byte/chan

  45.     kPluginBridgeRtClientControlEventAllNotesOff, // uint/frame, byte/chan

  46.     kPluginBridgeRtClientMidiEvent,               // uint/frame, byte/port, byte/size, byte[]/data

  47.     kPluginBridgeRtClientProcess,

  48.     kPluginBridgeRtClientQuit

  49. };

  50. 

  51. // Server sends these to client during non-RT

  52. enum PluginBridgeNonRtClientOpcode {

  53.     kPluginBridgeNonRtClientNull = 0,

  54.     kPluginBridgeNonRtClientPing,

  55.     kPluginBridgeNonRtClientPingOnOff,               // bool

  56.     kPluginBridgeNonRtClientActivate,

  57.     kPluginBridgeNonRtClientDeactivate,

  58.     kPluginBridgeNonRtClientSetBufferSize,           // uint

  59.     kPluginBridgeNonRtClientSetSampleRate,           // double

  60.     kPluginBridgeNonRtClientSetOffline,

  61.     kPluginBridgeNonRtClientSetOnline,

  62.     kPluginBridgeNonRtClientSetParameterValue,       // uint, float

  63.     kPluginBridgeNonRtClientSetParameterMidiChannel, // uint, byte

  64.     kPluginBridgeNonRtClientSetParameterMidiCC,      // uint, short

  65.     kPluginBridgeNonRtClientSetProgram,              // int

  66.     kPluginBridgeNonRtClientSetMidiProgram,          // int

  67.     kPluginBridgeNonRtClientSetCustomData,           // uint/size, str[], uint/size, str[], uint/size, str[]

  68.     kPluginBridgeNonRtClientSetChunkDataFile,        // uint/size, str[] (filename, base64 content)

  69.     kPluginBridgeNonRtClientSetCtrlChannel,          // short

  70.     kPluginBridgeNonRtClientSetOption,               // uint/option, bool

  71.     kPluginBridgeNonRtClientPrepareForSave,

  72.     kPluginBridgeNonRtClientShowUI,

  73.     kPluginBridgeNonRtClientHideUI,

  74.     kPluginBridgeNonRtClientUiParameterChange,       // uint, float

  75.     kPluginBridgeNonRtClientUiProgramChange,         // uint

  76.     kPluginBridgeNonRtClientUiMidiProgramChange,     // uint

  77.     kPluginBridgeNonRtClientUiNoteOn,                // byte, byte, byte

  78.     kPluginBridgeNonRtClientUiNoteOff,               // byte, byte

  79.     kPluginBridgeNonRtClientQuit

  80. };

  81. 

  82. // Client sends these to server during non-RT

  83. enum PluginBridgeNonRtServerOpcode {

  84.     kPluginBridgeNonRtServerNull = 0,

  85.     kPluginBridgeNonRtServerPong,

  86.     kPluginBridgeNonRtServerPluginInfo1,        // uint/category, uint/hints, uint/optionsAvailable, uint/optionsEnabled, long/uniqueId

  87.     kPluginBridgeNonRtServerPluginInfo2,        // uint/size, str[] (realName), uint/size, str[] (label), uint/size, str[] (maker), uint/size, str[] (copyright)

  88.     kPluginBridgeNonRtServerAudioCount,         // uint/ins, uint/outs

  89.     kPluginBridgeNonRtServerMidiCount,          // uint/ins, uint/outs

  90.     kPluginBridgeNonRtServerCvCount,            // uint/ins, uint/outs

  91.     kPluginBridgeNonRtServerParameterCount,     // uint/count

  92.     kPluginBridgeNonRtServerProgramCount,       // uint/count

  93.     kPluginBridgeNonRtServerMidiProgramCount,   // uint/count

  94.     kPluginBridgeNonRtServerPortName,           // byte/type, uint/index, uint/size, str[] (name)

  95.     kPluginBridgeNonRtServerParameterData1,     // uint/index, int/rindex, uint/type, uint/hints, short/cc

  96.     kPluginBridgeNonRtServerParameterData2,     // uint/index, uint/size, str[] (name), uint/size, str[] (symbol), uint/size, str[] (unit)

  97.     kPluginBridgeNonRtServerParameterRanges,    // uint/index, float/def, float/min, float/max, float/step, float/stepSmall, float/stepLarge

  98.     kPluginBridgeNonRtServerParameterValue,     // uint/index, float/value

  99.     kPluginBridgeNonRtServerParameterValue2,    // uint/index, float/value (used for init/output parameters only, don't resend values)

  100.     kPluginBridgeNonRtServerDefaultValue,       // uint/index, float/value

  101.     kPluginBridgeNonRtServerCurrentProgram,     // int/index

  102.     kPluginBridgeNonRtServerCurrentMidiProgram, // int/index

  103.     kPluginBridgeNonRtServerProgramName,        // uint/index, uint/size, str[] (name)

  104.     kPluginBridgeNonRtServerMidiProgramData,    // uint/index, uint/bank, uint/program, uint/size, str[] (name)

  105.     kPluginBridgeNonRtServerSetCustomData,      // uint/size, str[], uint/size, str[], uint/size, str[]

  106.     kPluginBridgeNonRtServerSetChunkDataFile,   // uint/size, str[] (filename, base64 content)

  107.     kPluginBridgeNonRtServerSetLatency,         // uint

  108.     kPluginBridgeNonRtServerReady,

  109.     kPluginBridgeNonRtServerSaved,

  110.     kPluginBridgeNonRtServerUiClosed,

  111.     kPluginBridgeNonRtServerError               // uint/size, str[]

  112. };

  113. 

  114. // used for kPluginBridgeNonRtServerPortName

  115. enum PluginBridgePortType {

  116.     kPluginBridgePortNull = 0,

  117.     kPluginBridgePortAudioInput,

  118.     kPluginBridgePortAudioOutput,

  119.     kPluginBridgePortCvInput,

  120.     kPluginBridgePortCvOutput,

  121.     kPluginBridgePortMidiInput,

  122.     kPluginBridgePortMidiOutput,

  123.     kPluginBridgePortTypeCount

  124. };

  125. 

  126. // -----------------------------------------------------------------------

  127. 

  128. struct BridgeSemaphore {

  129.     union {

  130.         void* server;

  131.         char _padServer[64];

  132.     };

  133.     union {

  134.         void* client;

  135.         char _padClient[64];

  136.     };

  137. };

  138. 

  139. // needs to be 64bit aligned

  140. struct BridgeTimeInfo {

  141.     uint64_t playing;

  142.     uint64_t frame;

  143.     uint64_t usecs;

  144.     uint32_t valid;

  145.     // bbt

  146.     int32_t bar, beat, tick;

  147.     float beatsPerBar, beatType;

  148.     double barStartTick, ticksPerBeat, beatsPerMinute;

  149. };

  150. 

  151. // -----------------------------------------------------------------------

  152. 

  153. static const std::size_t kBridgeRtClientDataMidiOutSize = 512*4;

  154. 

  155. // Server => Client RT

  156. struct BridgeRtClientData {

  157.     BridgeSemaphore sem;

  158.     BridgeTimeInfo timeInfo;

  159.     SmallStackBuffer ringBuffer;

  160.     uint8_t midiOut[kBridgeRtClientDataMidiOutSize];

  161. };

  162. 

  163. // Server => Client Non-RT

  164. struct BridgeNonRtClientData {

  165.     BigStackBuffer ringBuffer;

  166. };

  167. 

  168. // Client => Server Non-RT

  169. struct BridgeNonRtServerData {

  170.     HugeStackBuffer ringBuffer;

  171. };

  172. 

  173. // -----------------------------------------------------------------------

  174. 

  175. static inline

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

  177. {

  178.     switch (opcode)

  179.     {

  180.     case kPluginBridgeRtClientNull:

  181.         return "kPluginBridgeRtClientNull";

  182.     case kPluginBridgeRtClientSetAudioPool:

  183.         return "kPluginBridgeRtClientSetAudioPool";

  184.     case kPluginBridgeRtClientControlEventParameter:

  185.         return "kPluginBridgeRtClientControlEventParameter";

  186.     case kPluginBridgeRtClientControlEventMidiBank:

  187.         return "kPluginBridgeRtClientControlEventMidiBank";

  188.     case kPluginBridgeRtClientControlEventMidiProgram:

  189.         return "kPluginBridgeRtClientControlEventMidiProgram";

  190.     case kPluginBridgeRtClientControlEventAllSoundOff:

  191.         return "kPluginBridgeRtClientControlEventAllSoundOff";

  192.     case kPluginBridgeRtClientControlEventAllNotesOff:

  193.         return "kPluginBridgeRtClientControlEventAllNotesOff";

  194.     case kPluginBridgeRtClientMidiEvent:

  195.         return "kPluginBridgeRtClientMidiEvent";

  196.     case kPluginBridgeRtClientProcess:

  197.         return "kPluginBridgeRtClientProcess";

  198.     case kPluginBridgeRtClientQuit:

  199.         return "kPluginBridgeRtClientQuit";

  200.     }

  201. 

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

  203.     return nullptr;

  204. }

  205. 

  206. static inline

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

  208. {

  209.     switch (opcode)

  210.     {

  211.     case kPluginBridgeNonRtClientNull:

  212.         return "kPluginBridgeNonRtClientNull";

  213.     case kPluginBridgeNonRtClientPing:

  214.         return "kPluginBridgeNonRtClientPing";

  215.     case kPluginBridgeNonRtClientPingOnOff:

  216.         return "kPluginBridgeNonRtClientPingOnOff";

  217.     case kPluginBridgeNonRtClientActivate:

  218.         return "kPluginBridgeNonRtClientActivate";

  219.     case kPluginBridgeNonRtClientDeactivate:

  220.         return "kPluginBridgeNonRtClientDeactivate";

  221.     case kPluginBridgeNonRtClientSetBufferSize:

  222.         return "kPluginBridgeNonRtClientSetBufferSize";

  223.     case kPluginBridgeNonRtClientSetSampleRate:

  224.         return "kPluginBridgeNonRtClientSetSampleRate";

  225.     case kPluginBridgeNonRtClientSetOffline:

  226.         return "kPluginBridgeNonRtClientSetOffline";

  227.     case kPluginBridgeNonRtClientSetOnline:

  228.         return "kPluginBridgeNonRtClientSetOnline";

  229.     case kPluginBridgeNonRtClientSetParameterValue:

  230.         return "kPluginBridgeNonRtClientSetParameterValue";

  231.     case kPluginBridgeNonRtClientSetParameterMidiChannel:

  232.         return "kPluginBridgeNonRtClientSetParameterMidiChannel";

  233.     case kPluginBridgeNonRtClientSetParameterMidiCC:

  234.         return "kPluginBridgeNonRtClientSetParameterMidiCC";

  235.     case kPluginBridgeNonRtClientSetProgram:

  236.         return "kPluginBridgeNonRtClientSetProgram";

  237.     case kPluginBridgeNonRtClientSetMidiProgram:

  238.         return "kPluginBridgeNonRtClientSetMidiProgram";

  239.     case kPluginBridgeNonRtClientSetCustomData:

  240.         return "kPluginBridgeNonRtClientSetCustomData";

  241.     case kPluginBridgeNonRtClientSetChunkDataFile:

  242.         return "kPluginBridgeNonRtClientSetChunkDataFile";

  243.     case kPluginBridgeNonRtClientSetCtrlChannel:

  244.         return "kPluginBridgeNonRtClientSetCtrlChannel";

  245.     case kPluginBridgeNonRtClientSetOption:

  246.         return "kPluginBridgeNonRtClientSetOption";

  247.     case kPluginBridgeNonRtClientPrepareForSave:

  248.         return "kPluginBridgeNonRtClientPrepareForSave";

  249.     case kPluginBridgeNonRtClientShowUI:

  250.         return "kPluginBridgeNonRtClientShowUI";

  251.     case kPluginBridgeNonRtClientHideUI:

  252.         return "kPluginBridgeNonRtClientHideUI";

  253.     case kPluginBridgeNonRtClientUiParameterChange:

  254.         return "kPluginBridgeNonRtClientUiParameterChange";

  255.     case kPluginBridgeNonRtClientUiProgramChange:

  256.         return "kPluginBridgeNonRtClientUiProgramChange";

  257.     case kPluginBridgeNonRtClientUiMidiProgramChange:

  258.         return "kPluginBridgeNonRtClientUiMidiProgramChange";

  259.     case kPluginBridgeNonRtClientUiNoteOn:

  260.         return "kPluginBridgeNonRtClientUiNoteOn";

  261.     case kPluginBridgeNonRtClientUiNoteOff:

  262.         return "kPluginBridgeNonRtClientUiNoteOff";

  263.     case kPluginBridgeNonRtClientQuit:

  264.         return "kPluginBridgeNonRtClientQuit";

  265.     }

  266. 

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

  268.     return nullptr;

  269. }

  270. 

  271. static inline

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

  273. {

  274.     switch (opcode)

  275.     {

  276.     case kPluginBridgeNonRtServerNull:

  277.         return "kPluginBridgeNonRtServerNull";

  278.     case kPluginBridgeNonRtServerPong:

  279.         return "kPluginBridgeNonRtServerPong";

  280.     case kPluginBridgeNonRtServerPluginInfo1:

  281.         return "kPluginBridgeNonRtServerPluginInfo1";

  282.     case kPluginBridgeNonRtServerPluginInfo2:

  283.         return "kPluginBridgeNonRtServerPluginInfo2";

  284.     case kPluginBridgeNonRtServerAudioCount:

  285.         return "kPluginBridgeNonRtServerAudioCount";

  286.     case kPluginBridgeNonRtServerMidiCount:

  287.         return "kPluginBridgeNonRtServerMidiCount";

  288.     case kPluginBridgeNonRtServerCvCount:

  289.         return "kPluginBridgeNonRtServerCvCount";

  290.     case kPluginBridgeNonRtServerParameterCount:

  291.         return "kPluginBridgeNonRtServerParameterCount";

  292.     case kPluginBridgeNonRtServerProgramCount:

  293.         return "kPluginBridgeNonRtServerProgramCount";

  294.     case kPluginBridgeNonRtServerMidiProgramCount:

  295.         return "kPluginBridgeNonRtServerMidiProgramCount";

  296.     case kPluginBridgeNonRtServerPortName:

  297.         return "kPluginBridgeNonRtServerPortName";

  298.     case kPluginBridgeNonRtServerParameterData1:

  299.         return "kPluginBridgeNonRtServerParameterData1";

  300.     case kPluginBridgeNonRtServerParameterData2:

  301.         return "kPluginBridgeNonRtServerParameterData2";

  302.     case kPluginBridgeNonRtServerParameterRanges:

  303.         return "kPluginBridgeNonRtServerParameterRanges";

  304.     case kPluginBridgeNonRtServerParameterValue:

  305.         return "kPluginBridgeNonRtServerParameterValue";

  306.     case kPluginBridgeNonRtServerParameterValue2:

  307.         return "kPluginBridgeNonRtServerParameterValue2";

  308.     case kPluginBridgeNonRtServerDefaultValue:

  309.         return "kPluginBridgeNonRtServerDefaultValue";

  310.     case kPluginBridgeNonRtServerCurrentProgram:

  311.         return "kPluginBridgeNonRtServerCurrentProgram";

  312.     case kPluginBridgeNonRtServerCurrentMidiProgram:

  313.         return "kPluginBridgeNonRtServerCurrentMidiProgram";

  314.     case kPluginBridgeNonRtServerProgramName:

  315.         return "kPluginBridgeNonRtServerProgramName";

  316.     case kPluginBridgeNonRtServerMidiProgramData:

  317.         return "kPluginBridgeNonRtServerMidiProgramData";

  318.     case kPluginBridgeNonRtServerSetCustomData:

  319.         return "kPluginBridgeNonRtServerSetCustomData";

  320.     case kPluginBridgeNonRtServerSetChunkDataFile:

  321.         return "kPluginBridgeNonRtServerSetChunkDataFile";

  322.     case kPluginBridgeNonRtServerSetLatency:

  323.         return "kPluginBridgeNonRtServerSetLatency";

  324.     case kPluginBridgeNonRtServerReady:

  325.         return "kPluginBridgeNonRtServerReady";

  326.     case kPluginBridgeNonRtServerSaved:

  327.         return "kPluginBridgeNonRtServerSaved";

  328.     case kPluginBridgeNonRtServerUiClosed:

  329.         return "kPluginBridgeNonRtServerUiClosed";

  330.     case kPluginBridgeNonRtServerError:

  331.         return "kPluginBridgeNonRtServerError";

  332.     }

  333. 

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

  335.     return nullptr;

  336. }

  337. 

  338. // -----------------------------------------------------------------------

  339. 

  340. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED