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.
2381 Commits
16 Branches
14GB
Tree: 3890ee5a80
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '3890ee5a80'
${ noResults }
Carla/source/utils/CarlaBridgeUtils.hpp

304 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. // -----------------------------------------------------------------------

  106. 

  107. struct BridgeSemaphore {

  108.     union {

  109.         void* server;

  110.         char _padServer[64];

  111.     };

  112.     union {

  113.         void* client;

  114.         char _padClient[64];

  115.     };

  116. };

  117. 

  118. // needs to be 64bit aligned

  119. struct BridgeTimeInfo {

  120.     uint64_t playing;

  121.     uint64_t frame;

  122.     uint64_t usecs;

  123.     uint32_t valid;

  124.     // bbt

  125.     int32_t bar, beat, tick;

  126.     float beatsPerBar, beatType;

  127.     double barStartTick, ticksPerBeat, beatsPerMinute;

  128. };

  129. 

  130. struct BridgeRtData {

  131.     BridgeSemaphore sem;

  132.     BridgeTimeInfo timeInfo;

  133.     StackBuffer ringBuffer;

  134. };

  135. 

  136. struct BridgeNonRtData {

  137.     BigStackBuffer ringBuffer;

  138. };

  139. 

  140. // -----------------------------------------------------------------------

  141. 

  142. static inline

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

  144. {

  145.     switch (type)

  146.     {

  147.     case kPluginBridgeOscNull:

  148.         return "kPluginBridgeOscNull";

  149.     case kPluginBridgeOscPong:

  150.         return "kPluginBridgeOscPong";

  151.     case kPluginBridgeOscPluginInfo1:

  152.         return "kPluginBridgeOscPluginInfo1";

  153.     case kPluginBridgeOscPluginInfo2:

  154.         return "kPluginBridgeOscPluginInfo2";

  155.     case kPluginBridgeOscAudioCount:

  156.         return "kPluginBridgeOscAudioCount";

  157.     case kPluginBridgeOscMidiCount:

  158.         return "kPluginBridgeOscMidiCount";

  159.     case kPluginBridgeOscParameterCount:

  160.         return "kPluginBridgeOscParameterCount";

  161.     case kPluginBridgeOscProgramCount:

  162.         return "kPluginBridgeOscProgramCount";

  163.     case kPluginBridgeOscMidiProgramCount:

  164.         return "kPluginBridgeOscMidiProgramCount";

  165.     case kPluginBridgeOscParameterData1:

  166.         return "kPluginBridgeOscParameterData1";

  167.     case kPluginBridgeOscParameterData2:

  168.         return "kPluginBridgeOscParameterData2";

  169.     case kPluginBridgeOscParameterRanges1:

  170.         return "kPluginBridgeOscParameterRanges1";

  171.     case kPluginBridgeOscParameterRanges2:

  172.         return "kPluginBridgeOscParameterRanges2";

  173.     case kPluginBridgeOscParameterValue:

  174.         return "kPluginBridgeOscParameterValue";

  175.     case kPluginBridgeOscDefaultValue:

  176.         return "kPluginBridgeOscDefaultValue";

  177.     case kPluginBridgeOscCurrentProgram:

  178.         return "kPluginBridgeOscCurrentProgram";

  179.     case kPluginBridgeOscCurrentMidiProgram:

  180.         return "kPluginBridgeOscCurrentMidiProgram";

  181.     case kPluginBridgeOscProgramName:

  182.         return "kPluginBridgeOscProgramName";

  183.     case kPluginBridgeOscMidiProgramData:

  184.         return "kPluginBridgeOscMidiProgramData";

  185.     case kPluginBridgeOscConfigure:

  186.         return "kPluginBridgeOscConfigure";

  187.     case kPluginBridgeOscSetCustomData:

  188.         return "kPluginBridgeOscSetCustomData";

  189.     case kPluginBridgeOscSetChunkDataFile:

  190.         return "kPluginBridgeOscSetChunkDataFile";

  191.     case kPluginBridgeOscLatency:

  192.         return "kPluginBridgeOscLatency";

  193.     case kPluginBridgeOscReady:

  194.         return "kPluginBridgeOscReady";

  195.     case kPluginBridgeOscError:

  196.         return "kPluginBridgeOscError";

  197.     }

  198. 

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

  200.     return nullptr;

  201. }

  202. 

  203. static inline

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

  205. {

  206.     switch (opcode)

  207.     {

  208.     case kPluginBridgeRtNull:

  209.         return "kPluginBridgeRtNull";

  210.     case kPluginBridgeRtSetAudioPool:

  211.         return "kPluginBridgeRtSetAudioPool";

  212.     case kPluginBridgeRtSetCVPool:

  213.         return "kPluginBridgeRtSetCVPool";

  214.     case kPluginBridgeRtControlEventParameter:

  215.         return "kPluginBridgeRtControlEventParameter";

  216.     case kPluginBridgeRtControlEventMidiBank:

  217.         return "kPluginBridgeRtControlEventMidiBank";

  218.     case kPluginBridgeRtControlEventMidiProgram:

  219.         return "kPluginBridgeRtControlEventMidiProgram";

  220.     case kPluginBridgeRtControlEventAllSoundOff:

  221.         return "kPluginBridgeRtControlEventAllSoundOff";

  222.     case kPluginBridgeRtControlEventAllNotesOff:

  223.         return "kPluginBridgeRtControlEventAllNotesOff";

  224.     case kPluginBridgeRtMidiEvent:

  225.         return "kPluginBridgeRtMidiEvent";

  226.     case kPluginBridgeRtProcess:

  227.         return "kPluginBridgeRtProcess";

  228.     case kPluginBridgeRtQuit:

  229.         return "kPluginBridgeRtQuit";

  230.     }

  231. 

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

  233.     return nullptr;

  234. }

  235. 

  236. static inline

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

  238. {

  239.     switch (opcode)

  240.     {

  241.     case kPluginBridgeNonRtNull:

  242.         return "kPluginBridgeNonRtNull";

  243.     case kPluginBridgeNonRtPing:

  244.         return "kPluginBridgeNonRtPing";

  245.     case kPluginBridgeNonRtActivate:

  246.         return "kPluginBridgeNonRtActivate";

  247.     case kPluginBridgeNonRtDeactivate:

  248.         return "kPluginBridgeNonRtDeactivate";

  249.     case kPluginBridgeNonRtSetBufferSize:

  250.         return "kPluginBridgeNonRtSetBufferSize";

  251.     case kPluginBridgeNonRtSetSampleRate:

  252.         return "kPluginBridgeNonRtSetSampleRate";

  253.     case kPluginBridgeNonRtSetOffline:

  254.         return "kPluginBridgeNonRtSetOffline";

  255.     case kPluginBridgeNonRtSetOnline:

  256.         return "kPluginBridgeNonRtSetOnline";

  257.     case kPluginBridgeNonRtSetParameterValue:

  258.         return "kPluginBridgeNonRtSetParameterValue";

  259.     case kPluginBridgeNonRtSetParameterMidiChannel:

  260.         return "kPluginBridgeNonRtSetParameterMidiChannel";

  261.     case kPluginBridgeNonRtSetParameterMidiCC:

  262.         return "kPluginBridgeNonRtSetParameterMidiCC";

  263.     case kPluginBridgeNonRtSetProgram:

  264.         return "kPluginBridgeNonRtSetProgram";

  265.     case kPluginBridgeNonRtSetMidiProgram:

  266.         return "kPluginBridgeNonRtSetMidiProgram";

  267.     case kPluginBridgeNonRtSetCustomData:

  268.         return "kPluginBridgeNonRtSetCustomData";

  269.     case kPluginBridgeNonRtSetChunkDataFile:

  270.         return "kPluginBridgeNonRtSetChunkDataFile";

  271.     case kPluginBridgeNonRtSetCtrlChannel:

  272.         return "kPluginBridgeNonRtSetCtrlChannel";

  273.     case kPluginBridgeNonRtSetOscURL:

  274.         return "kPluginBridgeNonRtSetOscURL";

  275.     case kPluginBridgeNonRtSetOption:

  276.         return "kPluginBridgeNonRtSetOption";

  277.     case kPluginBridgeNonRtPrepareForSave:

  278.         return "kPluginBridgeNonRtPrepareForSave";

  279.     case kPluginBridgeNonRtShowUI:

  280.         return "kPluginBridgeNonRtShowUI";

  281.     case kPluginBridgeNonRtHideUI:

  282.         return "kPluginBridgeNonRtHideUI";

  283.     case kPluginBridgeNonRtUiParameterChange:

  284.         return "kPluginBridgeNonRtUiParameterChange";

  285.     case kPluginBridgeNonRtUiProgramChange:

  286.         return "kPluginBridgeNonRtUiProgramChange";

  287.     case kPluginBridgeNonRtUiMidiProgramChange:

  288.         return "kPluginBridgeNonRtUiMidiProgramChange";

  289.     case kPluginBridgeNonRtUiNoteOn:

  290.         return "kPluginBridgeNonRtUiNoteOn";

  291.     case kPluginBridgeNonRtUiNoteOff:

  292.         return "kPluginBridgeNonRtUiNoteOff";

  293.     case kPluginBridgeNonRtQuit:

  294.         return "kPluginBridgeNonRtQuit";

  295.     }

  296. 

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

  298.     return nullptr;

  299. }

  300. 

  301. // -----------------------------------------------------------------------

  302. 

  303. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED