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

301 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.     kPluginBridgeRtControlEventParameter,   // uint/frame, byte/chan, ushort, float

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

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

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

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

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

  64.     kPluginBridgeRtProcess,

  65.     kPluginBridgeRtQuit

  66. };

  67. 

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

  69. enum PluginBridgeNonRtOpcode {

  70.     kPluginBridgeNonRtNull = 0,

  71.     kPluginBridgeNonRtPing,

  72.     kPluginBridgeNonRtActivate,

  73.     kPluginBridgeNonRtDeactivate,

  74.     kPluginBridgeNonRtSetBufferSize,           // uint

  75.     kPluginBridgeNonRtSetSampleRate,           // double

  76.     kPluginBridgeNonRtSetOffline,

  77.     kPluginBridgeNonRtSetOnline,

  78.     kPluginBridgeNonRtSetParameterValue,       // uint, float

  79.     kPluginBridgeNonRtSetParameterMidiChannel, // uint, byte

  80.     kPluginBridgeNonRtSetParameterMidiCC,      // uint, short

  81.     kPluginBridgeNonRtSetProgram,              // int

  82.     kPluginBridgeNonRtSetMidiProgram,          // int

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

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

  85.     kPluginBridgeNonRtSetCtrlChannel,          // short

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

  87.     kPluginBridgeNonRtSetOption,               // uint/option, bool

  88.     kPluginBridgeNonRtPrepareForSave,

  89.     kPluginBridgeNonRtShowUI,

  90.     kPluginBridgeNonRtHideUI,

  91.     kPluginBridgeNonRtUiParameterChange,       // uint, float

  92.     kPluginBridgeNonRtUiProgramChange,         // uint

  93.     kPluginBridgeNonRtUiMidiProgramChange,     // uint

  94.     kPluginBridgeNonRtUiNoteOn,                // byte, byte, byte

  95.     kPluginBridgeNonRtUiNoteOff,               // byte, byte

  96.     kPluginBridgeNonRtQuit

  97. };

  98. 

  99. // -----------------------------------------------------------------------

  100. 

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

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

  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. struct BridgeRtData {

  130.     BridgeSemaphore sem;

  131.     BridgeTimeInfo timeInfo;

  132.     StackBuffer ringBuffer;

  133. };

  134. 

  135. struct BridgeNonRtData {

  136.     BigStackBuffer ringBuffer;

  137. };

  138. 

  139. // -----------------------------------------------------------------------

  140. 

  141. static inline

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

  143. {

  144.     switch (type)

  145.     {

  146.     case kPluginBridgeOscNull:

  147.         return "kPluginBridgeOscNull";

  148.     case kPluginBridgeOscPong:

  149.         return "kPluginBridgeOscPong";

  150.     case kPluginBridgeOscPluginInfo1:

  151.         return "kPluginBridgeOscPluginInfo1";

  152.     case kPluginBridgeOscPluginInfo2:

  153.         return "kPluginBridgeOscPluginInfo2";

  154.     case kPluginBridgeOscAudioCount:

  155.         return "kPluginBridgeOscAudioCount";

  156.     case kPluginBridgeOscMidiCount:

  157.         return "kPluginBridgeOscMidiCount";

  158.     case kPluginBridgeOscParameterCount:

  159.         return "kPluginBridgeOscParameterCount";

  160.     case kPluginBridgeOscProgramCount:

  161.         return "kPluginBridgeOscProgramCount";

  162.     case kPluginBridgeOscMidiProgramCount:

  163.         return "kPluginBridgeOscMidiProgramCount";

  164.     case kPluginBridgeOscParameterData1:

  165.         return "kPluginBridgeOscParameterData1";

  166.     case kPluginBridgeOscParameterData2:

  167.         return "kPluginBridgeOscParameterData2";

  168.     case kPluginBridgeOscParameterRanges1:

  169.         return "kPluginBridgeOscParameterRanges1";

  170.     case kPluginBridgeOscParameterRanges2:

  171.         return "kPluginBridgeOscParameterRanges2";

  172.     case kPluginBridgeOscParameterValue:

  173.         return "kPluginBridgeOscParameterValue";

  174.     case kPluginBridgeOscDefaultValue:

  175.         return "kPluginBridgeOscDefaultValue";

  176.     case kPluginBridgeOscCurrentProgram:

  177.         return "kPluginBridgeOscCurrentProgram";

  178.     case kPluginBridgeOscCurrentMidiProgram:

  179.         return "kPluginBridgeOscCurrentMidiProgram";

  180.     case kPluginBridgeOscProgramName:

  181.         return "kPluginBridgeOscProgramName";

  182.     case kPluginBridgeOscMidiProgramData:

  183.         return "kPluginBridgeOscMidiProgramData";

  184.     case kPluginBridgeOscConfigure:

  185.         return "kPluginBridgeOscConfigure";

  186.     case kPluginBridgeOscSetCustomData:

  187.         return "kPluginBridgeOscSetCustomData";

  188.     case kPluginBridgeOscSetChunkDataFile:

  189.         return "kPluginBridgeOscSetChunkDataFile";

  190.     case kPluginBridgeOscLatency:

  191.         return "kPluginBridgeOscLatency";

  192.     case kPluginBridgeOscReady:

  193.         return "kPluginBridgeOscReady";

  194.     case kPluginBridgeOscError:

  195.         return "kPluginBridgeOscError";

  196.     }

  197. 

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

  199.     return nullptr;

  200. }

  201. 

  202. static inline

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

  204. {

  205.     switch (opcode)

  206.     {

  207.     case kPluginBridgeRtNull:

  208.         return "kPluginBridgeRtNull";

  209.     case kPluginBridgeRtSetAudioPool:

  210.         return "kPluginBridgeRtSetAudioPool";

  211.     case kPluginBridgeRtControlEventParameter:

  212.         return "kPluginBridgeRtControlEventParameter";

  213.     case kPluginBridgeRtControlEventMidiBank:

  214.         return "kPluginBridgeRtControlEventMidiBank";

  215.     case kPluginBridgeRtControlEventMidiProgram:

  216.         return "kPluginBridgeRtControlEventMidiProgram";

  217.     case kPluginBridgeRtControlEventAllSoundOff:

  218.         return "kPluginBridgeRtControlEventAllSoundOff";

  219.     case kPluginBridgeRtControlEventAllNotesOff:

  220.         return "kPluginBridgeRtControlEventAllNotesOff";

  221.     case kPluginBridgeRtMidiEvent:

  222.         return "kPluginBridgeRtMidiEvent";

  223.     case kPluginBridgeRtProcess:

  224.         return "kPluginBridgeRtProcess";

  225.     case kPluginBridgeRtQuit:

  226.         return "kPluginBridgeRtQuit";

  227.     }

  228. 

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

  230.     return nullptr;

  231. }

  232. 

  233. static inline

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

  235. {

  236.     switch (opcode)

  237.     {

  238.     case kPluginBridgeNonRtNull:

  239.         return "kPluginBridgeNonRtNull";

  240.     case kPluginBridgeNonRtPing:

  241.         return "kPluginBridgeNonRtPing";

  242.     case kPluginBridgeNonRtActivate:

  243.         return "kPluginBridgeNonRtActivate";

  244.     case kPluginBridgeNonRtDeactivate:

  245.         return "kPluginBridgeNonRtDeactivate";

  246.     case kPluginBridgeNonRtSetBufferSize:

  247.         return "kPluginBridgeNonRtSetBufferSize";

  248.     case kPluginBridgeNonRtSetSampleRate:

  249.         return "kPluginBridgeNonRtSetSampleRate";

  250.     case kPluginBridgeNonRtSetOffline:

  251.         return "kPluginBridgeNonRtSetOffline";

  252.     case kPluginBridgeNonRtSetOnline:

  253.         return "kPluginBridgeNonRtSetOnline";

  254.     case kPluginBridgeNonRtSetParameterValue:

  255.         return "kPluginBridgeNonRtSetParameterValue";

  256.     case kPluginBridgeNonRtSetParameterMidiChannel:

  257.         return "kPluginBridgeNonRtSetParameterMidiChannel";

  258.     case kPluginBridgeNonRtSetParameterMidiCC:

  259.         return "kPluginBridgeNonRtSetParameterMidiCC";

  260.     case kPluginBridgeNonRtSetProgram:

  261.         return "kPluginBridgeNonRtSetProgram";

  262.     case kPluginBridgeNonRtSetMidiProgram:

  263.         return "kPluginBridgeNonRtSetMidiProgram";

  264.     case kPluginBridgeNonRtSetCustomData:

  265.         return "kPluginBridgeNonRtSetCustomData";

  266.     case kPluginBridgeNonRtSetChunkDataFile:

  267.         return "kPluginBridgeNonRtSetChunkDataFile";

  268.     case kPluginBridgeNonRtSetCtrlChannel:

  269.         return "kPluginBridgeNonRtSetCtrlChannel";

  270.     case kPluginBridgeNonRtSetOscURL:

  271.         return "kPluginBridgeNonRtSetOscURL";

  272.     case kPluginBridgeNonRtSetOption:

  273.         return "kPluginBridgeNonRtSetOption";

  274.     case kPluginBridgeNonRtPrepareForSave:

  275.         return "kPluginBridgeNonRtPrepareForSave";

  276.     case kPluginBridgeNonRtShowUI:

  277.         return "kPluginBridgeNonRtShowUI";

  278.     case kPluginBridgeNonRtHideUI:

  279.         return "kPluginBridgeNonRtHideUI";

  280.     case kPluginBridgeNonRtUiParameterChange:

  281.         return "kPluginBridgeNonRtUiParameterChange";

  282.     case kPluginBridgeNonRtUiProgramChange:

  283.         return "kPluginBridgeNonRtUiProgramChange";

  284.     case kPluginBridgeNonRtUiMidiProgramChange:

  285.         return "kPluginBridgeNonRtUiMidiProgramChange";

  286.     case kPluginBridgeNonRtUiNoteOn:

  287.         return "kPluginBridgeNonRtUiNoteOn";

  288.     case kPluginBridgeNonRtUiNoteOff:

  289.         return "kPluginBridgeNonRtUiNoteOff";

  290.     case kPluginBridgeNonRtQuit:

  291.         return "kPluginBridgeNonRtQuit";

  292.     }

  293. 

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

  295.     return nullptr;

  296. }

  297. 

  298. // -----------------------------------------------------------------------

  299. 

  300. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED