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

320 lines
14KB
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    "/carla-bridge_shm_ap_"

  30. # define PLUGIN_BRIDGE_NAMEPREFIX_RT_CLIENT     "/carla-bridge_shm_rtC_"

  31. # define PLUGIN_BRIDGE_NAMEPREFIX_NON_RT_CLIENT "/carla-bridge_shm_nonrtC_"

  32. # define PLUGIN_BRIDGE_NAMEPREFIX_NON_RT_SERVER "/carla-bridge_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.     kPluginBridgeNonRtClientActivate,

  56.     kPluginBridgeNonRtClientDeactivate,

  57.     kPluginBridgeNonRtClientSetBufferSize,           // uint

  58.     kPluginBridgeNonRtClientSetSampleRate,           // double

  59.     kPluginBridgeNonRtClientSetOffline,

  60.     kPluginBridgeNonRtClientSetOnline,

  61.     kPluginBridgeNonRtClientSetParameterValue,       // uint, float

  62.     kPluginBridgeNonRtClientSetParameterMidiChannel, // uint, byte

  63.     kPluginBridgeNonRtClientSetParameterMidiCC,      // uint, short

  64.     kPluginBridgeNonRtClientSetProgram,              // int

  65.     kPluginBridgeNonRtClientSetMidiProgram,          // int

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

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

  68.     kPluginBridgeNonRtClientSetCtrlChannel,          // short

  69.     kPluginBridgeNonRtClientSetOption,               // uint/option, bool

  70.     kPluginBridgeNonRtClientPrepareForSave,

  71.     kPluginBridgeNonRtClientShowUI,

  72.     kPluginBridgeNonRtClientHideUI,

  73.     kPluginBridgeNonRtClientUiParameterChange,       // uint, float

  74.     kPluginBridgeNonRtClientUiProgramChange,         // uint

  75.     kPluginBridgeNonRtClientUiMidiProgramChange,     // uint

  76.     kPluginBridgeNonRtClientUiNoteOn,                // byte, byte, byte

  77.     kPluginBridgeNonRtClientUiNoteOff,               // byte, byte

  78.     kPluginBridgeNonRtClientQuit

  79. };

  80. 

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

  82. enum PluginBridgeNonRtServerOpcode {

  83.     kPluginBridgeNonRtServerNull = 0,

  84.     kPluginBridgeNonRtServerPong,

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

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

  87.     kPluginBridgeNonRtServerAudioCount,         // uint/ins, uint/outs

  88.     kPluginBridgeNonRtServerMidiCount,          // uint/ins, uint/outs

  89.     kPluginBridgeNonRtServerParameterCount,     // uint/count

  90.     kPluginBridgeNonRtServerProgramCount,       // uint/count

  91.     kPluginBridgeNonRtServerMidiProgramCount,   // uint/count

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

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

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

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

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

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

  98.     kPluginBridgeNonRtServerCurrentProgram,     // int/index

  99.     kPluginBridgeNonRtServerCurrentMidiProgram, // int/index

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

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

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

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

  104.     kPluginBridgeNonRtServerSetLatency,         // uint

  105.     kPluginBridgeNonRtServerReady,

  106.     kPluginBridgeNonRtServerSaved,

  107.     kPluginBridgeNonRtServerUiClosed,

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

  109. };

  110. 

  111. // -----------------------------------------------------------------------

  112. 

  113. struct BridgeSemaphore {

  114.     union {

  115.         void* server;

  116.         char _padServer[64];

  117.     };

  118.     union {

  119.         void* client;

  120.         char _padClient[64];

  121.     };

  122. };

  123. 

  124. // needs to be 64bit aligned

  125. struct BridgeTimeInfo {

  126.     uint64_t playing;

  127.     uint64_t frame;

  128.     uint64_t usecs;

  129.     uint32_t valid;

  130.     // bbt

  131.     int32_t bar, beat, tick;

  132.     float beatsPerBar, beatType;

  133.     double barStartTick, ticksPerBeat, beatsPerMinute;

  134. };

  135. 

  136. // -----------------------------------------------------------------------

  137. 

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

  139. 

  140. // Server => Client RT

  141. struct BridgeRtClientData {

  142.     BridgeSemaphore sem;

  143.     BridgeTimeInfo timeInfo;

  144.     SmallStackBuffer ringBuffer;

  145.     uint8_t midiOut[kBridgeRtClientDataMidiOutSize];

  146. };

  147. 

  148. // Server => Client Non-RT

  149. struct BridgeNonRtClientData {

  150.     BigStackBuffer ringBuffer;

  151. };

  152. 

  153. // Client => Server Non-RT

  154. struct BridgeNonRtServerData {

  155.     HugeStackBuffer ringBuffer;

  156. };

  157. 

  158. // -----------------------------------------------------------------------

  159. 

  160. static inline

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

  162. {

  163.     switch (opcode)

  164.     {

  165.     case kPluginBridgeRtClientNull:

  166.         return "kPluginBridgeRtClientNull";

  167.     case kPluginBridgeRtClientSetAudioPool:

  168.         return "kPluginBridgeRtClientSetAudioPool";

  169.     case kPluginBridgeRtClientControlEventParameter:

  170.         return "kPluginBridgeRtClientControlEventParameter";

  171.     case kPluginBridgeRtClientControlEventMidiBank:

  172.         return "kPluginBridgeRtClientControlEventMidiBank";

  173.     case kPluginBridgeRtClientControlEventMidiProgram:

  174.         return "kPluginBridgeRtClientControlEventMidiProgram";

  175.     case kPluginBridgeRtClientControlEventAllSoundOff:

  176.         return "kPluginBridgeRtClientControlEventAllSoundOff";

  177.     case kPluginBridgeRtClientControlEventAllNotesOff:

  178.         return "kPluginBridgeRtClientControlEventAllNotesOff";

  179.     case kPluginBridgeRtClientMidiEvent:

  180.         return "kPluginBridgeRtClientMidiEvent";

  181.     case kPluginBridgeRtClientProcess:

  182.         return "kPluginBridgeRtClientProcess";

  183.     case kPluginBridgeRtClientQuit:

  184.         return "kPluginBridgeRtClientQuit";

  185.     }

  186. 

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

  188.     return nullptr;

  189. }

  190. 

  191. static inline

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

  193. {

  194.     switch (opcode)

  195.     {

  196.     case kPluginBridgeNonRtClientNull:

  197.         return "kPluginBridgeNonRtClientNull";

  198.     case kPluginBridgeNonRtClientPing:

  199.         return "kPluginBridgeNonRtClientPing";

  200.     case kPluginBridgeNonRtClientActivate:

  201.         return "kPluginBridgeNonRtClientActivate";

  202.     case kPluginBridgeNonRtClientDeactivate:

  203.         return "kPluginBridgeNonRtClientDeactivate";

  204.     case kPluginBridgeNonRtClientSetBufferSize:

  205.         return "kPluginBridgeNonRtClientSetBufferSize";

  206.     case kPluginBridgeNonRtClientSetSampleRate:

  207.         return "kPluginBridgeNonRtClientSetSampleRate";

  208.     case kPluginBridgeNonRtClientSetOffline:

  209.         return "kPluginBridgeNonRtClientSetOffline";

  210.     case kPluginBridgeNonRtClientSetOnline:

  211.         return "kPluginBridgeNonRtClientSetOnline";

  212.     case kPluginBridgeNonRtClientSetParameterValue:

  213.         return "kPluginBridgeNonRtClientSetParameterValue";

  214.     case kPluginBridgeNonRtClientSetParameterMidiChannel:

  215.         return "kPluginBridgeNonRtClientSetParameterMidiChannel";

  216.     case kPluginBridgeNonRtClientSetParameterMidiCC:

  217.         return "kPluginBridgeNonRtClientSetParameterMidiCC";

  218.     case kPluginBridgeNonRtClientSetProgram:

  219.         return "kPluginBridgeNonRtClientSetProgram";

  220.     case kPluginBridgeNonRtClientSetMidiProgram:

  221.         return "kPluginBridgeNonRtClientSetMidiProgram";

  222.     case kPluginBridgeNonRtClientSetCustomData:

  223.         return "kPluginBridgeNonRtClientSetCustomData";

  224.     case kPluginBridgeNonRtClientSetChunkDataFile:

  225.         return "kPluginBridgeNonRtClientSetChunkDataFile";

  226.     case kPluginBridgeNonRtClientSetCtrlChannel:

  227.         return "kPluginBridgeNonRtClientSetCtrlChannel";

  228.     case kPluginBridgeNonRtClientSetOption:

  229.         return "kPluginBridgeNonRtClientSetOption";

  230.     case kPluginBridgeNonRtClientPrepareForSave:

  231.         return "kPluginBridgeNonRtClientPrepareForSave";

  232.     case kPluginBridgeNonRtClientShowUI:

  233.         return "kPluginBridgeNonRtClientShowUI";

  234.     case kPluginBridgeNonRtClientHideUI:

  235.         return "kPluginBridgeNonRtClientHideUI";

  236.     case kPluginBridgeNonRtClientUiParameterChange:

  237.         return "kPluginBridgeNonRtClientUiParameterChange";

  238.     case kPluginBridgeNonRtClientUiProgramChange:

  239.         return "kPluginBridgeNonRtClientUiProgramChange";

  240.     case kPluginBridgeNonRtClientUiMidiProgramChange:

  241.         return "kPluginBridgeNonRtClientUiMidiProgramChange";

  242.     case kPluginBridgeNonRtClientUiNoteOn:

  243.         return "kPluginBridgeNonRtClientUiNoteOn";

  244.     case kPluginBridgeNonRtClientUiNoteOff:

  245.         return "kPluginBridgeNonRtClientUiNoteOff";

  246.     case kPluginBridgeNonRtClientQuit:

  247.         return "kPluginBridgeNonRtClientQuit";

  248.     }

  249. 

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

  251.     return nullptr;

  252. }

  253. 

  254. static inline

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

  256. {

  257.     switch (opcode)

  258.     {

  259.     case kPluginBridgeNonRtServerNull:

  260.         return "kPluginBridgeNonRtServerNull";

  261.     case kPluginBridgeNonRtServerPong:

  262.         return "kPluginBridgeNonRtServerPong";

  263.     case kPluginBridgeNonRtServerPluginInfo1:

  264.         return "kPluginBridgeNonRtServerPluginInfo1";

  265.     case kPluginBridgeNonRtServerPluginInfo2:

  266.         return "kPluginBridgeNonRtServerPluginInfo2";

  267.     case kPluginBridgeNonRtServerAudioCount:

  268.         return "kPluginBridgeNonRtServerAudioCount";

  269.     case kPluginBridgeNonRtServerMidiCount:

  270.         return "kPluginBridgeNonRtServerMidiCount";

  271.     case kPluginBridgeNonRtServerParameterCount:

  272.         return "kPluginBridgeNonRtServerParameterCount";

  273.     case kPluginBridgeNonRtServerProgramCount:

  274.         return "kPluginBridgeNonRtServerProgramCount";

  275.     case kPluginBridgeNonRtServerMidiProgramCount:

  276.         return "kPluginBridgeNonRtServerMidiProgramCount";

  277.     case kPluginBridgeNonRtServerParameterData1:

  278.         return "kPluginBridgeNonRtServerParameterData1";

  279.     case kPluginBridgeNonRtServerParameterData2:

  280.         return "kPluginBridgeNonRtServerParameterData2";

  281.     case kPluginBridgeNonRtServerParameterRanges:

  282.         return "kPluginBridgeNonRtServerParameterRanges";

  283.     case kPluginBridgeNonRtServerParameterValue:

  284.         return "kPluginBridgeNonRtServerParameterValue";

  285.     case kPluginBridgeNonRtServerParameterValue2:

  286.         return "kPluginBridgeNonRtServerParameterValue2";

  287.     case kPluginBridgeNonRtServerDefaultValue:

  288.         return "kPluginBridgeNonRtServerDefaultValue";

  289.     case kPluginBridgeNonRtServerCurrentProgram:

  290.         return "kPluginBridgeNonRtServerCurrentProgram";

  291.     case kPluginBridgeNonRtServerCurrentMidiProgram:

  292.         return "kPluginBridgeNonRtServerCurrentMidiProgram";

  293.     case kPluginBridgeNonRtServerProgramName:

  294.         return "kPluginBridgeNonRtServerProgramName";

  295.     case kPluginBridgeNonRtServerMidiProgramData:

  296.         return "kPluginBridgeNonRtServerMidiProgramData";

  297.     case kPluginBridgeNonRtServerSetCustomData:

  298.         return "kPluginBridgeNonRtServerSetCustomData";

  299.     case kPluginBridgeNonRtServerSetChunkDataFile:

  300.         return "kPluginBridgeNonRtServerSetChunkDataFile";

  301.     case kPluginBridgeNonRtServerSetLatency:

  302.         return "kPluginBridgeNonRtServerSetLatency";

  303.     case kPluginBridgeNonRtServerReady:

  304.         return "kPluginBridgeNonRtServerReady";

  305.     case kPluginBridgeNonRtServerSaved:

  306.         return "kPluginBridgeNonRtServerSaved";

  307.     case kPluginBridgeNonRtServerUiClosed:

  308.         return "kPluginBridgeNonRtServerUiClosed";

  309.     case kPluginBridgeNonRtServerError:

  310.         return "kPluginBridgeNonRtServerError";

  311.     }

  312. 

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

  314.     return nullptr;

  315. }

  316. 

  317. // -----------------------------------------------------------------------

  318. 

  319. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED