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

313 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. #define PLUGIN_BRIDGE_NAMEPREFIX_AUDIO_POOL    "/carla-bridge_shm_ap_"

  24. #define PLUGIN_BRIDGE_NAMEPREFIX_RT_CLIENT     "/carla-bridge_shm_rtC_"

  25. #define PLUGIN_BRIDGE_NAMEPREFIX_NON_RT_CLIENT "/carla-bridge_shm_nonrtC_"

  26. #define PLUGIN_BRIDGE_NAMEPREFIX_NON_RT_SERVER "/carla-bridge_shm_nonrtS_"

  27. 

  28. // -----------------------------------------------------------------------

  29. 

  30. // Server sends these to client during RT

  31. enum PluginBridgeRtClientOpcode {

  32.     kPluginBridgeRtClientNull = 0,

  33.     kPluginBridgeRtClientSetAudioPool,            // ulong/ptr

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

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

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

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

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

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

  40.     kPluginBridgeRtClientProcess,

  41.     kPluginBridgeRtClientQuit

  42. };

  43. 

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

  45. enum PluginBridgeNonRtClientOpcode {

  46.     kPluginBridgeNonRtClientNull = 0,

  47.     kPluginBridgeNonRtClientPing,

  48.     kPluginBridgeNonRtClientActivate,

  49.     kPluginBridgeNonRtClientDeactivate,

  50.     kPluginBridgeNonRtClientSetBufferSize,           // uint

  51.     kPluginBridgeNonRtClientSetSampleRate,           // double

  52.     kPluginBridgeNonRtClientSetOffline,

  53.     kPluginBridgeNonRtClientSetOnline,

  54.     kPluginBridgeNonRtClientSetParameterValue,       // uint, float

  55.     kPluginBridgeNonRtClientSetParameterMidiChannel, // uint, byte

  56.     kPluginBridgeNonRtClientSetParameterMidiCC,      // uint, short

  57.     kPluginBridgeNonRtClientSetProgram,              // int

  58.     kPluginBridgeNonRtClientSetMidiProgram,          // int

  59.     kPluginBridgeNonRtClientSetCustomData,           // uint/size, str[], uint/size, str[], uint/size, str[] (compressed)

  60.     kPluginBridgeNonRtClientSetChunkDataFile,        // uint/size, str[] (filename)

  61.     kPluginBridgeNonRtClientSetCtrlChannel,          // short

  62.     kPluginBridgeNonRtClientSetOption,               // uint/option, bool

  63.     kPluginBridgeNonRtClientPrepareForSave,

  64.     kPluginBridgeNonRtClientShowUI,

  65.     kPluginBridgeNonRtClientHideUI,

  66.     kPluginBridgeNonRtClientUiParameterChange,       // uint, float

  67.     kPluginBridgeNonRtClientUiProgramChange,         // uint

  68.     kPluginBridgeNonRtClientUiMidiProgramChange,     // uint

  69.     kPluginBridgeNonRtClientUiNoteOn,                // byte, byte, byte

  70.     kPluginBridgeNonRtClientUiNoteOff,               // byte, byte

  71.     kPluginBridgeNonRtClientQuit

  72. };

  73. 

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

  75. enum PluginBridgeNonRtServerOpcode {

  76.     kPluginBridgeNonRtServerNull = 0,

  77.     kPluginBridgeNonRtServerPong,

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

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

  80.     kPluginBridgeNonRtServerAudioCount,           // uint/ins, uint/outs

  81.     kPluginBridgeNonRtServerMidiCount,            // uint/ins, uint/outs

  82.     kPluginBridgeNonRtServerParameterCount,       // uint/ins, uint/outs

  83.     kPluginBridgeNonRtServerProgramCount,         // uint/count

  84.     kPluginBridgeNonRtServerMidiProgramCount,     // uint/count

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

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

  87.     kPluginBridgeNonRtServerParameterRanges1,     // uint/index, float/def, float/min, float/max

  88.     kPluginBridgeNonRtServerParameterRanges2,     // uint/index float/step, float/stepSmall, float/stepLarge

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

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

  91.     kPluginBridgeNonRtServerCurrentProgram,       // int/index

  92.     kPluginBridgeNonRtServerCurrentMidiProgram,   // int/index

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

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

  95.     kPluginBridgeNonRtServerSetCustomData,        // uint/size, str[], uint/size, str[], uint/size, str[] (compressed)

  96.     kPluginBridgeNonRtServerSetChunkDataFile,     // uint/size, str[] (filename)

  97.     kPluginBridgeNonRtServerSetLatency,           // uint

  98.     kPluginBridgeNonRtServerReady,

  99.     kPluginBridgeNonRtServerSaved,

  100.     kPluginBridgeNonRtServerUiClosed,

  101.     kPluginBridgeNonRtServerError

  102. };

  103. 

  104. // -----------------------------------------------------------------------

  105. 

  106. struct BridgeSemaphore {

  107.     union {

  108.         void* server;

  109.         char _padServer[64];

  110.     };

  111.     union {

  112.         void* client;

  113.         char _padClient[64];

  114.     };

  115. };

  116. 

  117. // needs to be 64bit aligned

  118. struct BridgeTimeInfo {

  119.     uint64_t playing;

  120.     uint64_t frame;

  121.     uint64_t usecs;

  122.     uint32_t valid;

  123.     // bbt

  124.     int32_t bar, beat, tick;

  125.     float beatsPerBar, beatType;

  126.     double barStartTick, ticksPerBeat, beatsPerMinute;

  127. };

  128. 

  129. // -----------------------------------------------------------------------

  130. 

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

  132. 

  133. // Server => Client RT

  134. struct BridgeRtClientData {

  135.     BridgeSemaphore sem;

  136.     BridgeTimeInfo timeInfo;

  137.     SmallStackBuffer ringBuffer;

  138.     uint8_t midiOut[kBridgeRtClientDataMidiOutSize];

  139. };

  140. 

  141. // Server => Client Non-RT

  142. struct BridgeNonRtClientData {

  143.     BigStackBuffer ringBuffer;

  144. };

  145. 

  146. // Client => Server Non-RT

  147. struct BridgeNonRtServerData {

  148.     HugeStackBuffer ringBuffer;

  149. };

  150. 

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

  152. 

  153. static inline

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

  155. {

  156.     switch (opcode)

  157.     {

  158.     case kPluginBridgeRtClientNull:

  159.         return "kPluginBridgeRtClientNull";

  160.     case kPluginBridgeRtClientSetAudioPool:

  161.         return "kPluginBridgeRtClientSetAudioPool";

  162.     case kPluginBridgeRtClientControlEventParameter:

  163.         return "kPluginBridgeRtClientControlEventParameter";

  164.     case kPluginBridgeRtClientControlEventMidiBank:

  165.         return "kPluginBridgeRtClientControlEventMidiBank";

  166.     case kPluginBridgeRtClientControlEventMidiProgram:

  167.         return "kPluginBridgeRtClientControlEventMidiProgram";

  168.     case kPluginBridgeRtClientControlEventAllSoundOff:

  169.         return "kPluginBridgeRtClientControlEventAllSoundOff";

  170.     case kPluginBridgeRtClientControlEventAllNotesOff:

  171.         return "kPluginBridgeRtClientControlEventAllNotesOff";

  172.     case kPluginBridgeRtClientMidiEvent:

  173.         return "kPluginBridgeRtClientMidiEvent";

  174.     case kPluginBridgeRtClientProcess:

  175.         return "kPluginBridgeRtClientProcess";

  176.     case kPluginBridgeRtClientQuit:

  177.         return "kPluginBridgeRtClientQuit";

  178.     }

  179. 

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

  181.     return nullptr;

  182. }

  183. 

  184. static inline

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

  186. {

  187.     switch (opcode)

  188.     {

  189.     case kPluginBridgeNonRtClientNull:

  190.         return "kPluginBridgeNonRtClientNull";

  191.     case kPluginBridgeNonRtClientPing:

  192.         return "kPluginBridgeNonRtClientPing";

  193.     case kPluginBridgeNonRtClientActivate:

  194.         return "kPluginBridgeNonRtClientActivate";

  195.     case kPluginBridgeNonRtClientDeactivate:

  196.         return "kPluginBridgeNonRtClientDeactivate";

  197.     case kPluginBridgeNonRtClientSetBufferSize:

  198.         return "kPluginBridgeNonRtClientSetBufferSize";

  199.     case kPluginBridgeNonRtClientSetSampleRate:

  200.         return "kPluginBridgeNonRtClientSetSampleRate";

  201.     case kPluginBridgeNonRtClientSetOffline:

  202.         return "kPluginBridgeNonRtClientSetOffline";

  203.     case kPluginBridgeNonRtClientSetOnline:

  204.         return "kPluginBridgeNonRtClientSetOnline";

  205.     case kPluginBridgeNonRtClientSetParameterValue:

  206.         return "kPluginBridgeNonRtClientSetParameterValue";

  207.     case kPluginBridgeNonRtClientSetParameterMidiChannel:

  208.         return "kPluginBridgeNonRtClientSetParameterMidiChannel";

  209.     case kPluginBridgeNonRtClientSetParameterMidiCC:

  210.         return "kPluginBridgeNonRtClientSetParameterMidiCC";

  211.     case kPluginBridgeNonRtClientSetProgram:

  212.         return "kPluginBridgeNonRtClientSetProgram";

  213.     case kPluginBridgeNonRtClientSetMidiProgram:

  214.         return "kPluginBridgeNonRtClientSetMidiProgram";

  215.     case kPluginBridgeNonRtClientSetCustomData:

  216.         return "kPluginBridgeNonRtClientSetCustomData";

  217.     case kPluginBridgeNonRtClientSetChunkDataFile:

  218.         return "kPluginBridgeNonRtClientSetChunkDataFile";

  219.     case kPluginBridgeNonRtClientSetCtrlChannel:

  220.         return "kPluginBridgeNonRtClientSetCtrlChannel";

  221.     case kPluginBridgeNonRtClientSetOption:

  222.         return "kPluginBridgeNonRtClientSetOption";

  223.     case kPluginBridgeNonRtClientPrepareForSave:

  224.         return "kPluginBridgeNonRtClientPrepareForSave";

  225.     case kPluginBridgeNonRtClientShowUI:

  226.         return "kPluginBridgeNonRtClientShowUI";

  227.     case kPluginBridgeNonRtClientHideUI:

  228.         return "kPluginBridgeNonRtClientHideUI";

  229.     case kPluginBridgeNonRtClientUiParameterChange:

  230.         return "kPluginBridgeNonRtClientUiParameterChange";

  231.     case kPluginBridgeNonRtClientUiProgramChange:

  232.         return "kPluginBridgeNonRtClientUiProgramChange";

  233.     case kPluginBridgeNonRtClientUiMidiProgramChange:

  234.         return "kPluginBridgeNonRtClientUiMidiProgramChange";

  235.     case kPluginBridgeNonRtClientUiNoteOn:

  236.         return "kPluginBridgeNonRtClientUiNoteOn";

  237.     case kPluginBridgeNonRtClientUiNoteOff:

  238.         return "kPluginBridgeNonRtClientUiNoteOff";

  239.     case kPluginBridgeNonRtClientQuit:

  240.         return "kPluginBridgeNonRtClientQuit";

  241.     }

  242. 

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

  244.     return nullptr;

  245. }

  246. 

  247. static inline

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

  249. {

  250.     switch (opcode)

  251.     {

  252.     case kPluginBridgeNonRtServerNull:

  253.         return "kPluginBridgeNonRtServerNull";

  254.     case kPluginBridgeNonRtServerPong:

  255.         return "kPluginBridgeNonRtServerPong";

  256.     case kPluginBridgeNonRtServerPluginInfo1:

  257.         return "kPluginBridgeNonRtServerPluginInfo1";

  258.     case kPluginBridgeNonRtServerPluginInfo2:

  259.         return "kPluginBridgeNonRtServerPluginInfo2";

  260.     case kPluginBridgeNonRtServerAudioCount:

  261.         return "kPluginBridgeNonRtServerAudioCount";

  262.     case kPluginBridgeNonRtServerMidiCount:

  263.         return "kPluginBridgeNonRtServerMidiCount";

  264.     case kPluginBridgeNonRtServerParameterCount:

  265.         return "kPluginBridgeNonRtServerParameterCount";

  266.     case kPluginBridgeNonRtServerProgramCount:

  267.         return "kPluginBridgeNonRtServerProgramCount";

  268.     case kPluginBridgeNonRtServerMidiProgramCount:

  269.         return "kPluginBridgeNonRtServerMidiProgramCount";

  270.     case kPluginBridgeNonRtServerParameterData1:

  271.         return "kPluginBridgeNonRtServerParameterData1";

  272.     case kPluginBridgeNonRtServerParameterData2:

  273.         return "kPluginBridgeNonRtServerParameterData2";

  274.     case kPluginBridgeNonRtServerParameterRanges1:

  275.         return "kPluginBridgeNonRtServerParameterRanges1";

  276.     case kPluginBridgeNonRtServerParameterRanges2:

  277.         return "kPluginBridgeNonRtServerParameterRanges2";

  278.     case kPluginBridgeNonRtServerParameterValue:

  279.         return "kPluginBridgeNonRtServerParameterValue";

  280.     case kPluginBridgeNonRtServerDefaultValue:

  281.         return "kPluginBridgeNonRtServerDefaultValue";

  282.     case kPluginBridgeNonRtServerCurrentProgram:

  283.         return "kPluginBridgeNonRtServerCurrentProgram";

  284.     case kPluginBridgeNonRtServerCurrentMidiProgram:

  285.         return "kPluginBridgeNonRtServerCurrentMidiProgram";

  286.     case kPluginBridgeNonRtServerProgramName:

  287.         return "kPluginBridgeNonRtServerProgramName";

  288.     case kPluginBridgeNonRtServerMidiProgramData:

  289.         return "kPluginBridgeNonRtServerMidiProgramData";

  290.     case kPluginBridgeNonRtServerSetCustomData:

  291.         return "kPluginBridgeNonRtServerSetCustomData";

  292.     case kPluginBridgeNonRtServerSetChunkDataFile:

  293.         return "kPluginBridgeNonRtServerSetChunkDataFile";

  294.     case kPluginBridgeNonRtServerSetLatency:

  295.         return "kPluginBridgeNonRtServerSetLatency";

  296.     case kPluginBridgeNonRtServerReady:

  297.         return "kPluginBridgeNonRtServerReady";

  298.     case kPluginBridgeNonRtServerSaved:

  299.         return "kPluginBridgeNonRtServerSaved";

  300.     case kPluginBridgeNonRtServerUiClosed:

  301.         return "kPluginBridgeNonRtServerUiClosed";

  302.     case kPluginBridgeNonRtServerError:

  303.         return "kPluginBridgeNonRtServerError";

  304.     }

  305. 

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

  307.     return nullptr;

  308. }

  309. 

  310. // -----------------------------------------------------------------------

  311. 

  312. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED