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

307 lines
12KB
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. // carla-plugin receives these via osc

  26. enum PluginBridgeOscInfoType {

  27.     kPluginBridgeOscNull = 0,

  28.     kPluginBridgeOscPong,

  29.     kPluginBridgeOscPluginInfo1,          // uuuuh => category, hints, optionsAvailable, optionsEnabled, uniqueId

  30.     kPluginBridgeOscPluginInfo2,          // ssss  => realName, label, maker, copyright

  31.     kPluginBridgeOscAudioCount,           // uu    => ins, outs

  32.     kPluginBridgeOscMidiCount,            // uu    => ins, outs

  33.     kPluginBridgeOscParameterCount,       // uu    => ins, outs

  34.     kPluginBridgeOscProgramCount,         // u     => count

  35.     kPluginBridgeOscMidiProgramCount,     // u     => count

  36.     kPluginBridgeOscParameterData1,       // uiuui => index, rindex, type, hints, cc

  37.     kPluginBridgeOscParameterData2,       // uss   => index, name, unit

  38.     kPluginBridgeOscParameterRanges1,     // ufff  => index, def, min, max

  39.     kPluginBridgeOscParameterRanges2,     // ufff  => index, step, stepSmall, stepLarge

  40.     kPluginBridgeOscParameterValue,       // uf    => index, value

  41.     kPluginBridgeOscDefaultValue,         // uf    => index, value

  42.     kPluginBridgeOscCurrentProgram,       // i     => index

  43.     kPluginBridgeOscCurrentMidiProgram,   // i     => index

  44.     kPluginBridgeOscProgramName,          // us    => index, name

  45.     kPluginBridgeOscMidiProgramData,      // uuus  => index, bank, program, name

  46.     kPluginBridgeOscConfigure,            // ss    => key, value

  47.     kPluginBridgeOscSetCustomData,        // sss   => type, key, value

  48.     kPluginBridgeOscSetChunkDataFile,     // s     => chunkFile

  49.     kPluginBridgeOscLatency,              // u     => value

  50.     kPluginBridgeOscReady,

  51.     kPluginBridgeOscError

  52. };

  53. 

  54. // carla-plugin sends these during RT

  55. enum PluginBridgeRtOpcode {

  56.     kPluginBridgeRtNull = 0,

  57.     kPluginBridgeRtSetAudioPool,            // ulong/ptr

  58.     kPluginBridgeRtSetCVPool,               // ulong/ptr

  59.     kPluginBridgeRtControlEventParameter,   // uint/frame, byte/chan, ushort, float

  60.     kPluginBridgeRtControlEventMidiBank,    // uint/frame, byte/chan, ushort

  61.     kPluginBridgeRtControlEventMidiProgram, // uint/frame, byte/chan, ushort

  62.     kPluginBridgeRtControlEventAllSoundOff, // uint/frame, byte/chan

  63.     kPluginBridgeRtControlEventAllNotesOff, // uint/frame, byte/chan

  64.     kPluginBridgeRtMidiEvent,               // uint/frame, byte/port, byte/size, byte[]/data

  65.     kPluginBridgeRtProcess,

  66.     kPluginBridgeRtQuit

  67. };

  68. 

  69. // carla-plugin sends these during non-RT

  70. enum PluginBridgeNonRtOpcode {

  71.     kPluginBridgeNonRtNull = 0,

  72.     kPluginBridgeNonRtPing,

  73.     kPluginBridgeNonRtActivate,

  74.     kPluginBridgeNonRtDeactivate,

  75.     kPluginBridgeNonRtSetBufferSize,           // uint

  76.     kPluginBridgeNonRtSetSampleRate,           // double

  77.     kPluginBridgeNonRtSetOffline,

  78.     kPluginBridgeNonRtSetOnline,

  79.     kPluginBridgeNonRtSetParameterValue,       // uint, float

  80.     kPluginBridgeNonRtSetParameterMidiChannel, // uint, byte

  81.     kPluginBridgeNonRtSetParameterMidiCC,      // uint, short

  82.     kPluginBridgeNonRtSetProgram,              // int

  83.     kPluginBridgeNonRtSetMidiProgram,          // int

  84.     kPluginBridgeNonRtSetCustomData,           // uint/size, str[], uint/size, str[], uint/size, str[] TODO plugin

  85.     kPluginBridgeNonRtSetChunkDataFile,        // uint/size, str[]/file

  86.     kPluginBridgeNonRtSetCtrlChannel,          // short

  87.     kPluginBridgeNonRtSetOscURL,               // uint/size, str[]/url

  88.     kPluginBridgeNonRtSetOption,               // uint/option, bool

  89.     kPluginBridgeNonRtPrepareForSave,

  90.     kPluginBridgeNonRtShowUI,

  91.     kPluginBridgeNonRtHideUI,

  92.     kPluginBridgeNonRtUiParameterChange,       // uint, float

  93.     kPluginBridgeNonRtUiProgramChange,         // uint

  94.     kPluginBridgeNonRtUiMidiProgramChange,     // uint

  95.     kPluginBridgeNonRtUiNoteOn,                // byte, byte, byte

  96.     kPluginBridgeNonRtUiNoteOff,               // byte, byte

  97.     kPluginBridgeNonRtQuit

  98. };

  99. 

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

  101. 

  102. const char* const CARLA_BRIDGE_MSG_HIDE_GUI = "CarlaBridgeHideGUI"; //!< Plugin -> Host configure, tells host GUI is now hidden

  103. const char* const CARLA_BRIDGE_MSG_SAVED    = "CarlaBridgeSaved";   //!< Plugin -> Host configure, tells host state is saved

  104. 

  105. static const std::size_t kBridgeRtDataMidiOutSize = 512*4;

  106. 

  107. // -----------------------------------------------------------------------

  108. 

  109. struct BridgeSemaphore {

  110.     union {

  111.         void* server;

  112.         char _padServer[64];

  113.     };

  114.     union {

  115.         void* client;

  116.         char _padClient[64];

  117.     };

  118. };

  119. 

  120. // needs to be 64bit aligned

  121. struct BridgeTimeInfo {

  122.     uint64_t playing;

  123.     uint64_t frame;

  124.     uint64_t usecs;

  125.     uint32_t valid;

  126.     // bbt

  127.     int32_t bar, beat, tick;

  128.     float beatsPerBar, beatType;

  129.     double barStartTick, ticksPerBeat, beatsPerMinute;

  130. };

  131. 

  132. struct BridgeRtData {

  133.     BridgeSemaphore sem;

  134.     BridgeTimeInfo timeInfo;

  135.     StackBuffer ringBuffer;

  136.     uint8_t midiOut[kBridgeRtDataMidiOutSize];

  137. };

  138. 

  139. struct BridgeNonRtData {

  140.     BigStackBuffer ringBuffer;

  141. };

  142. 

  143. // -----------------------------------------------------------------------

  144. 

  145. static inline

  146. const char* PluginBridgeOscInfoType2str(const PluginBridgeOscInfoType type) noexcept

  147. {

  148.     switch (type)

  149.     {

  150.     case kPluginBridgeOscNull:

  151.         return "kPluginBridgeOscNull";

  152.     case kPluginBridgeOscPong:

  153.         return "kPluginBridgeOscPong";

  154.     case kPluginBridgeOscPluginInfo1:

  155.         return "kPluginBridgeOscPluginInfo1";

  156.     case kPluginBridgeOscPluginInfo2:

  157.         return "kPluginBridgeOscPluginInfo2";

  158.     case kPluginBridgeOscAudioCount:

  159.         return "kPluginBridgeOscAudioCount";

  160.     case kPluginBridgeOscMidiCount:

  161.         return "kPluginBridgeOscMidiCount";

  162.     case kPluginBridgeOscParameterCount:

  163.         return "kPluginBridgeOscParameterCount";

  164.     case kPluginBridgeOscProgramCount:

  165.         return "kPluginBridgeOscProgramCount";

  166.     case kPluginBridgeOscMidiProgramCount:

  167.         return "kPluginBridgeOscMidiProgramCount";

  168.     case kPluginBridgeOscParameterData1:

  169.         return "kPluginBridgeOscParameterData1";

  170.     case kPluginBridgeOscParameterData2:

  171.         return "kPluginBridgeOscParameterData2";

  172.     case kPluginBridgeOscParameterRanges1:

  173.         return "kPluginBridgeOscParameterRanges1";

  174.     case kPluginBridgeOscParameterRanges2:

  175.         return "kPluginBridgeOscParameterRanges2";

  176.     case kPluginBridgeOscParameterValue:

  177.         return "kPluginBridgeOscParameterValue";

  178.     case kPluginBridgeOscDefaultValue:

  179.         return "kPluginBridgeOscDefaultValue";

  180.     case kPluginBridgeOscCurrentProgram:

  181.         return "kPluginBridgeOscCurrentProgram";

  182.     case kPluginBridgeOscCurrentMidiProgram:

  183.         return "kPluginBridgeOscCurrentMidiProgram";

  184.     case kPluginBridgeOscProgramName:

  185.         return "kPluginBridgeOscProgramName";

  186.     case kPluginBridgeOscMidiProgramData:

  187.         return "kPluginBridgeOscMidiProgramData";

  188.     case kPluginBridgeOscConfigure:

  189.         return "kPluginBridgeOscConfigure";

  190.     case kPluginBridgeOscSetCustomData:

  191.         return "kPluginBridgeOscSetCustomData";

  192.     case kPluginBridgeOscSetChunkDataFile:

  193.         return "kPluginBridgeOscSetChunkDataFile";

  194.     case kPluginBridgeOscLatency:

  195.         return "kPluginBridgeOscLatency";

  196.     case kPluginBridgeOscReady:

  197.         return "kPluginBridgeOscReady";

  198.     case kPluginBridgeOscError:

  199.         return "kPluginBridgeOscError";

  200.     }

  201. 

  202.     carla_stderr("CarlaBackend::PluginBridgeOscInfoType2str(%i) - invalid type", type);

  203.     return nullptr;

  204. }

  205. 

  206. static inline

  207. const char* PluginBridgeRtOpcode2str(const PluginBridgeRtOpcode opcode) noexcept

  208. {

  209.     switch (opcode)

  210.     {

  211.     case kPluginBridgeRtNull:

  212.         return "kPluginBridgeRtNull";

  213.     case kPluginBridgeRtSetAudioPool:

  214.         return "kPluginBridgeRtSetAudioPool";

  215.     case kPluginBridgeRtSetCVPool:

  216.         return "kPluginBridgeRtSetCVPool";

  217.     case kPluginBridgeRtControlEventParameter:

  218.         return "kPluginBridgeRtControlEventParameter";

  219.     case kPluginBridgeRtControlEventMidiBank:

  220.         return "kPluginBridgeRtControlEventMidiBank";

  221.     case kPluginBridgeRtControlEventMidiProgram:

  222.         return "kPluginBridgeRtControlEventMidiProgram";

  223.     case kPluginBridgeRtControlEventAllSoundOff:

  224.         return "kPluginBridgeRtControlEventAllSoundOff";

  225.     case kPluginBridgeRtControlEventAllNotesOff:

  226.         return "kPluginBridgeRtControlEventAllNotesOff";

  227.     case kPluginBridgeRtMidiEvent:

  228.         return "kPluginBridgeRtMidiEvent";

  229.     case kPluginBridgeRtProcess:

  230.         return "kPluginBridgeRtProcess";

  231.     case kPluginBridgeRtQuit:

  232.         return "kPluginBridgeRtQuit";

  233.     }

  234. 

  235.     carla_stderr("CarlaBackend::PluginBridgeRtOpcode2str(%i) - invalid opcode", opcode);

  236.     return nullptr;

  237. }

  238. 

  239. static inline

  240. const char* PluginBridgeNonRtOpcode2str(const PluginBridgeNonRtOpcode opcode) noexcept

  241. {

  242.     switch (opcode)

  243.     {

  244.     case kPluginBridgeNonRtNull:

  245.         return "kPluginBridgeNonRtNull";

  246.     case kPluginBridgeNonRtPing:

  247.         return "kPluginBridgeNonRtPing";

  248.     case kPluginBridgeNonRtActivate:

  249.         return "kPluginBridgeNonRtActivate";

  250.     case kPluginBridgeNonRtDeactivate:

  251.         return "kPluginBridgeNonRtDeactivate";

  252.     case kPluginBridgeNonRtSetBufferSize:

  253.         return "kPluginBridgeNonRtSetBufferSize";

  254.     case kPluginBridgeNonRtSetSampleRate:

  255.         return "kPluginBridgeNonRtSetSampleRate";

  256.     case kPluginBridgeNonRtSetOffline:

  257.         return "kPluginBridgeNonRtSetOffline";

  258.     case kPluginBridgeNonRtSetOnline:

  259.         return "kPluginBridgeNonRtSetOnline";

  260.     case kPluginBridgeNonRtSetParameterValue:

  261.         return "kPluginBridgeNonRtSetParameterValue";

  262.     case kPluginBridgeNonRtSetParameterMidiChannel:

  263.         return "kPluginBridgeNonRtSetParameterMidiChannel";

  264.     case kPluginBridgeNonRtSetParameterMidiCC:

  265.         return "kPluginBridgeNonRtSetParameterMidiCC";

  266.     case kPluginBridgeNonRtSetProgram:

  267.         return "kPluginBridgeNonRtSetProgram";

  268.     case kPluginBridgeNonRtSetMidiProgram:

  269.         return "kPluginBridgeNonRtSetMidiProgram";

  270.     case kPluginBridgeNonRtSetCustomData:

  271.         return "kPluginBridgeNonRtSetCustomData";

  272.     case kPluginBridgeNonRtSetChunkDataFile:

  273.         return "kPluginBridgeNonRtSetChunkDataFile";

  274.     case kPluginBridgeNonRtSetCtrlChannel:

  275.         return "kPluginBridgeNonRtSetCtrlChannel";

  276.     case kPluginBridgeNonRtSetOscURL:

  277.         return "kPluginBridgeNonRtSetOscURL";

  278.     case kPluginBridgeNonRtSetOption:

  279.         return "kPluginBridgeNonRtSetOption";

  280.     case kPluginBridgeNonRtPrepareForSave:

  281.         return "kPluginBridgeNonRtPrepareForSave";

  282.     case kPluginBridgeNonRtShowUI:

  283.         return "kPluginBridgeNonRtShowUI";

  284.     case kPluginBridgeNonRtHideUI:

  285.         return "kPluginBridgeNonRtHideUI";

  286.     case kPluginBridgeNonRtUiParameterChange:

  287.         return "kPluginBridgeNonRtUiParameterChange";

  288.     case kPluginBridgeNonRtUiProgramChange:

  289.         return "kPluginBridgeNonRtUiProgramChange";

  290.     case kPluginBridgeNonRtUiMidiProgramChange:

  291.         return "kPluginBridgeNonRtUiMidiProgramChange";

  292.     case kPluginBridgeNonRtUiNoteOn:

  293.         return "kPluginBridgeNonRtUiNoteOn";

  294.     case kPluginBridgeNonRtUiNoteOff:

  295.         return "kPluginBridgeNonRtUiNoteOff";

  296.     case kPluginBridgeNonRtQuit:

  297.         return "kPluginBridgeNonRtQuit";

  298.     }

  299. 

  300.     carla_stderr("CarlaBackend::PluginBridgeNonRtOpcode2str(%i) - invalid opcode", opcode);

  301.     return nullptr;

  302. }

  303. 

  304. // -----------------------------------------------------------------------

  305. 

  306. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED