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.
2539 Commits
17 Branches
1.0GB
Tree: 503314968f
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '503314968f'
${ noResults }
Carla/source/utils/CarlaBridgeUtils.hpp

311 lines
13KB
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. // -----------------------------------------------------------------------

  24. 

  25. // Server sends these to client during RT

  26. enum PluginBridgeRtClientOpcode {

  27.     kPluginBridgeRtClientNull = 0,

  28.     kPluginBridgeRtClientSetAudioPool,            // ulong/ptr

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

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

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

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

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

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

  35.     kPluginBridgeRtClientProcess,

  36.     kPluginBridgeRtClientQuit

  37. };

  38. 

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

  40. enum PluginBridgeNonRtClientOpcode {

  41.     kPluginBridgeNonRtClientNull = 0,

  42.     kPluginBridgeNonRtClientPing,

  43.     kPluginBridgeNonRtClientActivate,

  44.     kPluginBridgeNonRtClientDeactivate,

  45.     kPluginBridgeNonRtClientSetBufferSize,           // uint

  46.     kPluginBridgeNonRtClientSetSampleRate,           // double

  47.     kPluginBridgeNonRtClientSetOffline,

  48.     kPluginBridgeNonRtClientSetOnline,

  49.     kPluginBridgeNonRtClientSetParameterValue,       // uint, float

  50.     kPluginBridgeNonRtClientSetParameterMidiChannel, // uint, byte

  51.     kPluginBridgeNonRtClientSetParameterMidiCC,      // uint, short

  52.     kPluginBridgeNonRtClientSetProgram,              // int

  53.     kPluginBridgeNonRtClientSetMidiProgram,          // int

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

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

  56.     kPluginBridgeNonRtClientSetCtrlChannel,          // short

  57.     kPluginBridgeNonRtClientSetOption,               // uint/option, bool

  58.     kPluginBridgeNonRtClientPrepareForSave,

  59.     kPluginBridgeNonRtClientShowUI,

  60.     kPluginBridgeNonRtClientHideUI,

  61.     kPluginBridgeNonRtClientUiParameterChange,       // uint, float

  62.     kPluginBridgeNonRtClientUiProgramChange,         // uint

  63.     kPluginBridgeNonRtClientUiMidiProgramChange,     // uint

  64.     kPluginBridgeNonRtClientUiNoteOn,                // byte, byte, byte

  65.     kPluginBridgeNonRtClientUiNoteOff,               // byte, byte

  66.     kPluginBridgeNonRtClientQuit

  67. };

  68. 

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

  70. enum PluginBridgeNonRtServerOpcode {

  71.     kPluginBridgeNonRtServerNull = 0,

  72.     kPluginBridgeNonRtServerPong,

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

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

  75.     kPluginBridgeNonRtServerAudioCount,           // uint/ins, uint/outs

  76.     kPluginBridgeNonRtServerMidiCount,            // uint/ins, uint/outs

  77.     kPluginBridgeNonRtServerParameterCount,       // uint/ins, uint/outs

  78.     kPluginBridgeNonRtServerProgramCount,         // uint/count

  79.     kPluginBridgeNonRtServerMidiProgramCount,     // uint/count

  80.     kPluginBridgeNonRtServerParameterData1,       // uint/index, int/rindex, uint/type, uint/hints, int/cc

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

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

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

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

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

  86.     kPluginBridgeNonRtServerCurrentProgram,       // int/index

  87.     kPluginBridgeNonRtServerCurrentMidiProgram,   // int/index

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

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

  90.     kPluginBridgeNonRtServerConfigure,            // uint/size, str[], uint/size, str[]

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

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

  93.     kPluginBridgeNonRtServerSetLatency,           // uint

  94.     kPluginBridgeNonRtServerReady,

  95.     kPluginBridgeNonRtServerSaved,

  96.     kPluginBridgeNonRtServerUiClosed,

  97.     kPluginBridgeNonRtServerError

  98. };

  99. 

  100. // -----------------------------------------------------------------------

  101. 

  102. struct BridgeSemaphore {

  103.     union {

  104.         void* server;

  105.         char _padServer[64];

  106.     };

  107.     union {

  108.         void* client;

  109.         char _padClient[64];

  110.     };

  111. };

  112. 

  113. // needs to be 64bit aligned

  114. struct BridgeTimeInfo {

  115.     uint64_t playing;

  116.     uint64_t frame;

  117.     uint64_t usecs;

  118.     uint32_t valid;

  119.     // bbt

  120.     int32_t bar, beat, tick;

  121.     float beatsPerBar, beatType;

  122.     double barStartTick, ticksPerBeat, beatsPerMinute;

  123. };

  124. 

  125. // -----------------------------------------------------------------------

  126. 

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

  128. 

  129. // Server => Client RT

  130. struct BridgeRtClientData {

  131.     BridgeSemaphore sem;

  132.     BridgeTimeInfo timeInfo;

  133.     SmallStackBuffer ringBuffer;

  134.     uint8_t midiOut[kBridgeRtClientDataMidiOutSize];

  135. };

  136. 

  137. // Server => Client Non-RT

  138. struct BridgeNonRtClientData {

  139.     BigStackBuffer ringBuffer;

  140. };

  141. 

  142. // Client => Server Non-RT

  143. struct BridgeNonRtServerData {

  144.     HugeStackBuffer ringBuffer;

  145. };

  146. 

  147. // -----------------------------------------------------------------------

  148. 

  149. static inline

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

  151. {

  152.     switch (opcode)

  153.     {

  154.     case kPluginBridgeRtClientNull:

  155.         return "kPluginBridgeRtClientNull";

  156.     case kPluginBridgeRtClientSetAudioPool:

  157.         return "kPluginBridgeRtClientSetAudioPool";

  158.     case kPluginBridgeRtClientControlEventParameter:

  159.         return "kPluginBridgeRtClientControlEventParameter";

  160.     case kPluginBridgeRtClientControlEventMidiBank:

  161.         return "kPluginBridgeRtClientControlEventMidiBank";

  162.     case kPluginBridgeRtClientControlEventMidiProgram:

  163.         return "kPluginBridgeRtClientControlEventMidiProgram";

  164.     case kPluginBridgeRtClientControlEventAllSoundOff:

  165.         return "kPluginBridgeRtClientControlEventAllSoundOff";

  166.     case kPluginBridgeRtClientControlEventAllNotesOff:

  167.         return "kPluginBridgeRtClientControlEventAllNotesOff";

  168.     case kPluginBridgeRtClientMidiEvent:

  169.         return "kPluginBridgeRtClientMidiEvent";

  170.     case kPluginBridgeRtClientProcess:

  171.         return "kPluginBridgeRtClientProcess";

  172.     case kPluginBridgeRtClientQuit:

  173.         return "kPluginBridgeRtClientQuit";

  174.     }

  175. 

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

  177.     return nullptr;

  178. }

  179. 

  180. static inline

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

  182. {

  183.     switch (opcode)

  184.     {

  185.     case kPluginBridgeNonRtClientNull:

  186.         return "kPluginBridgeNonRtClientNull";

  187.     case kPluginBridgeNonRtClientPing:

  188.         return "kPluginBridgeNonRtClientPing";

  189.     case kPluginBridgeNonRtClientActivate:

  190.         return "kPluginBridgeNonRtClientActivate";

  191.     case kPluginBridgeNonRtClientDeactivate:

  192.         return "kPluginBridgeNonRtClientDeactivate";

  193.     case kPluginBridgeNonRtClientSetBufferSize:

  194.         return "kPluginBridgeNonRtClientSetBufferSize";

  195.     case kPluginBridgeNonRtClientSetSampleRate:

  196.         return "kPluginBridgeNonRtClientSetSampleRate";

  197.     case kPluginBridgeNonRtClientSetOffline:

  198.         return "kPluginBridgeNonRtClientSetOffline";

  199.     case kPluginBridgeNonRtClientSetOnline:

  200.         return "kPluginBridgeNonRtClientSetOnline";

  201.     case kPluginBridgeNonRtClientSetParameterValue:

  202.         return "kPluginBridgeNonRtClientSetParameterValue";

  203.     case kPluginBridgeNonRtClientSetParameterMidiChannel:

  204.         return "kPluginBridgeNonRtClientSetParameterMidiChannel";

  205.     case kPluginBridgeNonRtClientSetParameterMidiCC:

  206.         return "kPluginBridgeNonRtClientSetParameterMidiCC";

  207.     case kPluginBridgeNonRtClientSetProgram:

  208.         return "kPluginBridgeNonRtClientSetProgram";

  209.     case kPluginBridgeNonRtClientSetMidiProgram:

  210.         return "kPluginBridgeNonRtClientSetMidiProgram";

  211.     case kPluginBridgeNonRtClientSetCustomData:

  212.         return "kPluginBridgeNonRtClientSetCustomData";

  213.     case kPluginBridgeNonRtClientSetChunkDataFile:

  214.         return "kPluginBridgeNonRtClientSetChunkDataFile";

  215.     case kPluginBridgeNonRtClientSetCtrlChannel:

  216.         return "kPluginBridgeNonRtClientSetCtrlChannel";

  217.     case kPluginBridgeNonRtClientSetOption:

  218.         return "kPluginBridgeNonRtClientSetOption";

  219.     case kPluginBridgeNonRtClientPrepareForSave:

  220.         return "kPluginBridgeNonRtClientPrepareForSave";

  221.     case kPluginBridgeNonRtClientShowUI:

  222.         return "kPluginBridgeNonRtClientShowUI";

  223.     case kPluginBridgeNonRtClientHideUI:

  224.         return "kPluginBridgeNonRtClientHideUI";

  225.     case kPluginBridgeNonRtClientUiParameterChange:

  226.         return "kPluginBridgeNonRtClientUiParameterChange";

  227.     case kPluginBridgeNonRtClientUiProgramChange:

  228.         return "kPluginBridgeNonRtClientUiProgramChange";

  229.     case kPluginBridgeNonRtClientUiMidiProgramChange:

  230.         return "kPluginBridgeNonRtClientUiMidiProgramChange";

  231.     case kPluginBridgeNonRtClientUiNoteOn:

  232.         return "kPluginBridgeNonRtClientUiNoteOn";

  233.     case kPluginBridgeNonRtClientUiNoteOff:

  234.         return "kPluginBridgeNonRtClientUiNoteOff";

  235.     case kPluginBridgeNonRtClientQuit:

  236.         return "kPluginBridgeNonRtClientQuit";

  237.     }

  238. 

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

  240.     return nullptr;

  241. }

  242. 

  243. static inline

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

  245. {

  246.     switch (opcode)

  247.     {

  248.     case kPluginBridgeNonRtServerNull:

  249.         return "kPluginBridgeNonRtServerNull";

  250.     case kPluginBridgeNonRtServerPong:

  251.         return "kPluginBridgeNonRtServerPong";

  252.     case kPluginBridgeNonRtServerPluginInfo1:

  253.         return "kPluginBridgeNonRtServerPluginInfo1";

  254.     case kPluginBridgeNonRtServerPluginInfo2:

  255.         return "kPluginBridgeNonRtServerPluginInfo2";

  256.     case kPluginBridgeNonRtServerAudioCount:

  257.         return "kPluginBridgeNonRtServerAudioCount";

  258.     case kPluginBridgeNonRtServerMidiCount:

  259.         return "kPluginBridgeNonRtServerMidiCount";

  260.     case kPluginBridgeNonRtServerParameterCount:

  261.         return "kPluginBridgeNonRtServerParameterCount";

  262.     case kPluginBridgeNonRtServerProgramCount:

  263.         return "kPluginBridgeNonRtServerProgramCount";

  264.     case kPluginBridgeNonRtServerMidiProgramCount:

  265.         return "kPluginBridgeNonRtServerMidiProgramCount";

  266.     case kPluginBridgeNonRtServerParameterData1:

  267.         return "kPluginBridgeNonRtServerParameterData1";

  268.     case kPluginBridgeNonRtServerParameterData2:

  269.         return "kPluginBridgeNonRtServerParameterData2";

  270.     case kPluginBridgeNonRtServerParameterRanges1:

  271.         return "kPluginBridgeNonRtServerParameterRanges1";

  272.     case kPluginBridgeNonRtServerParameterRanges2:

  273.         return "kPluginBridgeNonRtServerParameterRanges2";

  274.     case kPluginBridgeNonRtServerParameterValue:

  275.         return "kPluginBridgeNonRtServerParameterValue";

  276.     case kPluginBridgeNonRtServerDefaultValue:

  277.         return "kPluginBridgeNonRtServerDefaultValue";

  278.     case kPluginBridgeNonRtServerCurrentProgram:

  279.         return "kPluginBridgeNonRtServerCurrentProgram";

  280.     case kPluginBridgeNonRtServerCurrentMidiProgram:

  281.         return "kPluginBridgeNonRtServerCurrentMidiProgram";

  282.     case kPluginBridgeNonRtServerProgramName:

  283.         return "kPluginBridgeNonRtServerProgramName";

  284.     case kPluginBridgeNonRtServerMidiProgramData:

  285.         return "kPluginBridgeNonRtServerMidiProgramData";

  286.     case kPluginBridgeNonRtServerConfigure:

  287.         return "kPluginBridgeNonRtServerConfigure";

  288.     case kPluginBridgeNonRtServerSetCustomData:

  289.         return "kPluginBridgeNonRtServerSetCustomData";

  290.     case kPluginBridgeNonRtServerSetChunkDataFile:

  291.         return "kPluginBridgeNonRtServerSetChunkDataFile";

  292.     case kPluginBridgeNonRtServerSetLatency:

  293.         return "kPluginBridgeNonRtServerSetLatency";

  294.     case kPluginBridgeNonRtServerReady:

  295.         return "kPluginBridgeNonRtServerReady";

  296.     case kPluginBridgeNonRtServerSaved:

  297.         return "kPluginBridgeNonRtServerSaved";

  298.     case kPluginBridgeNonRtServerUiClosed:

  299.         return "kPluginBridgeNonRtServerUiClosed";

  300.     case kPluginBridgeNonRtServerError:

  301.         return "kPluginBridgeNonRtServerError";

  302.     }

  303. 

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

  305.     return nullptr;

  306. }

  307. 

  308. // -----------------------------------------------------------------------

  309. 

  310. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED