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

298 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. };

  66. 

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

  68. enum PluginBridgeNonRtOpcode {

  69.     kPluginBridgeNonRtNull = 0,

  70.     kPluginBridgeNonRtPing,

  71.     kPluginBridgeNonRtActivate,

  72.     kPluginBridgeNonRtDeactivate,

  73.     kPluginBridgeNonRtSetBufferSize,           // uint

  74.     kPluginBridgeNonRtSetSampleRate,           // double

  75.     kPluginBridgeNonRtSetOffline,

  76.     kPluginBridgeNonRtSetOnline,

  77.     kPluginBridgeNonRtSetParameterValue,       // uint, float

  78.     kPluginBridgeNonRtSetParameterMidiChannel, // uint, byte

  79.     kPluginBridgeNonRtSetParameterMidiCC,      // uint, short

  80.     kPluginBridgeNonRtSetProgram,              // int

  81.     kPluginBridgeNonRtSetMidiProgram,          // int

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

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

  84.     kPluginBridgeNonRtSetCtrlChannel,          // short

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

  86.     kPluginBridgeNonRtSetOption,               // uint/option, bool

  87.     kPluginBridgeNonRtPrepareForSave,

  88.     kPluginBridgeNonRtShowUI,

  89.     kPluginBridgeNonRtHideUI,

  90.     kPluginBridgeNonRtUiParameterChange,       // uint, float

  91.     kPluginBridgeNonRtUiProgramChange,         // uint

  92.     kPluginBridgeNonRtUiMidiProgramChange,     // uint

  93.     kPluginBridgeNonRtUiNoteOn,                // byte, byte, byte

  94.     kPluginBridgeNonRtUiNoteOff,               // byte, byte

  95.     kPluginBridgeNonRtQuit

  96. };

  97. 

  98. // -----------------------------------------------------------------------

  99. 

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

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

  102. 

  103. // -----------------------------------------------------------------------

  104. 

  105. struct BridgeSemaphore {

  106.     union {

  107.         void* server;

  108.         char _padServer[32];

  109.     };

  110.     union {

  111.         void* client;

  112.         char _padClient[32];

  113.     };

  114. };

  115. 

  116. // needs to be 64bit aligned

  117. struct BridgeTimeInfo {

  118.     bool     playing : 64; // 8 bytes

  119.     uint64_t frame;

  120.     uint64_t usecs;

  121.     uint32_t valid;

  122.     // bbt

  123.     int32_t bar, beat, tick;

  124.     float beatsPerBar, beatType;

  125.     double barStartTick, ticksPerBeat, beatsPerMinute;

  126. };

  127. 

  128. struct BridgeRtData {

  129.     BridgeSemaphore sem;

  130.     BridgeTimeInfo timeInfo;

  131.     StackBuffer ringBuffer;

  132. };

  133. 

  134. struct BridgeNonRtData {

  135.     BigStackBuffer ringBuffer;

  136. };

  137. 

  138. // -----------------------------------------------------------------------

  139. 

  140. static inline

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

  142. {

  143.     switch (type)

  144.     {

  145.     case kPluginBridgeOscNull:

  146.         return "kPluginBridgeOscNull";

  147.     case kPluginBridgeOscPong:

  148.         return "kPluginBridgeOscPong";

  149.     case kPluginBridgeOscPluginInfo1:

  150.         return "kPluginBridgeOscPluginInfo1";

  151.     case kPluginBridgeOscPluginInfo2:

  152.         return "kPluginBridgeOscPluginInfo2";

  153.     case kPluginBridgeOscAudioCount:

  154.         return "kPluginBridgeOscAudioCount";

  155.     case kPluginBridgeOscMidiCount:

  156.         return "kPluginBridgeOscMidiCount";

  157.     case kPluginBridgeOscParameterCount:

  158.         return "kPluginBridgeOscParameterCount";

  159.     case kPluginBridgeOscProgramCount:

  160.         return "kPluginBridgeOscProgramCount";

  161.     case kPluginBridgeOscMidiProgramCount:

  162.         return "kPluginBridgeOscMidiProgramCount";

  163.     case kPluginBridgeOscParameterData1:

  164.         return "kPluginBridgeOscParameterData1";

  165.     case kPluginBridgeOscParameterData2:

  166.         return "kPluginBridgeOscParameterData2";

  167.     case kPluginBridgeOscParameterRanges1:

  168.         return "kPluginBridgeOscParameterRanges1";

  169.     case kPluginBridgeOscParameterRanges2:

  170.         return "kPluginBridgeOscParameterRanges2";

  171.     case kPluginBridgeOscParameterValue:

  172.         return "kPluginBridgeOscParameterValue";

  173.     case kPluginBridgeOscDefaultValue:

  174.         return "kPluginBridgeOscDefaultValue";

  175.     case kPluginBridgeOscCurrentProgram:

  176.         return "kPluginBridgeOscCurrentProgram";

  177.     case kPluginBridgeOscCurrentMidiProgram:

  178.         return "kPluginBridgeOscCurrentMidiProgram";

  179.     case kPluginBridgeOscProgramName:

  180.         return "kPluginBridgeOscProgramName";

  181.     case kPluginBridgeOscMidiProgramData:

  182.         return "kPluginBridgeOscMidiProgramData";

  183.     case kPluginBridgeOscConfigure:

  184.         return "kPluginBridgeOscConfigure";

  185.     case kPluginBridgeOscSetCustomData:

  186.         return "kPluginBridgeOscSetCustomData";

  187.     case kPluginBridgeOscSetChunkDataFile:

  188.         return "kPluginBridgeOscSetChunkDataFile";

  189.     case kPluginBridgeOscLatency:

  190.         return "kPluginBridgeOscLatency";

  191.     case kPluginBridgeOscReady:

  192.         return "kPluginBridgeOscReady";

  193.     case kPluginBridgeOscError:

  194.         return "kPluginBridgeOscError";

  195.     }

  196. 

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

  198.     return nullptr;

  199. }

  200. 

  201. static inline

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

  203. {

  204.     switch (opcode)

  205.     {

  206.     case kPluginBridgeRtNull:

  207.         return "kPluginBridgeRtNull";

  208.     case kPluginBridgeRtSetAudioPool:

  209.         return "kPluginBridgeRtSetAudioPool";

  210.     case kPluginBridgeRtControlEventParameter:

  211.         return "kPluginBridgeRtControlEventParameter";

  212.     case kPluginBridgeRtControlEventMidiBank:

  213.         return "kPluginBridgeRtControlEventMidiBank";

  214.     case kPluginBridgeRtControlEventMidiProgram:

  215.         return "kPluginBridgeRtControlEventMidiProgram";

  216.     case kPluginBridgeRtControlEventAllSoundOff:

  217.         return "kPluginBridgeRtControlEventAllSoundOff";

  218.     case kPluginBridgeRtControlEventAllNotesOff:

  219.         return "kPluginBridgeRtControlEventAllNotesOff";

  220.     case kPluginBridgeRtMidiEvent:

  221.         return "kPluginBridgeRtMidiEvent";

  222.     case kPluginBridgeRtProcess:

  223.         return "kPluginBridgeRtProcess";

  224.     }

  225. 

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

  227.     return nullptr;

  228. }

  229. 

  230. static inline

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

  232. {

  233.     switch (opcode)

  234.     {

  235.     case kPluginBridgeNonRtNull:

  236.         return "kPluginBridgeNonRtNull";

  237.     case kPluginBridgeNonRtPing:

  238.         return "kPluginBridgeNonRtPing";

  239.     case kPluginBridgeNonRtActivate:

  240.         return "kPluginBridgeNonRtActivate";

  241.     case kPluginBridgeNonRtDeactivate:

  242.         return "kPluginBridgeNonRtDeactivate";

  243.     case kPluginBridgeNonRtSetBufferSize:

  244.         return "kPluginBridgeNonRtSetBufferSize";

  245.     case kPluginBridgeNonRtSetSampleRate:

  246.         return "kPluginBridgeNonRtSetSampleRate";

  247.     case kPluginBridgeNonRtSetOffline:

  248.         return "kPluginBridgeNonRtSetOffline";

  249.     case kPluginBridgeNonRtSetOnline:

  250.         return "kPluginBridgeNonRtSetOnline";

  251.     case kPluginBridgeNonRtSetParameterValue:

  252.         return "kPluginBridgeNonRtSetParameterValue";

  253.     case kPluginBridgeNonRtSetParameterMidiChannel:

  254.         return "kPluginBridgeNonRtSetParameterMidiChannel";

  255.     case kPluginBridgeNonRtSetParameterMidiCC:

  256.         return "kPluginBridgeNonRtSetParameterMidiCC";

  257.     case kPluginBridgeNonRtSetProgram:

  258.         return "kPluginBridgeNonRtSetProgram";

  259.     case kPluginBridgeNonRtSetMidiProgram:

  260.         return "kPluginBridgeNonRtSetMidiProgram";

  261.     case kPluginBridgeNonRtSetCustomData:

  262.         return "kPluginBridgeNonRtSetCustomData";

  263.     case kPluginBridgeNonRtSetChunkDataFile:

  264.         return "kPluginBridgeNonRtSetChunkDataFile";

  265.     case kPluginBridgeNonRtSetCtrlChannel:

  266.         return "kPluginBridgeNonRtSetCtrlChannel";

  267.     case kPluginBridgeNonRtSetOscURL:

  268.         return "kPluginBridgeNonRtSetOscURL";

  269.     case kPluginBridgeNonRtSetOption:

  270.         return "kPluginBridgeNonRtSetOption";

  271.     case kPluginBridgeNonRtPrepareForSave:

  272.         return "kPluginBridgeNonRtPrepareForSave";

  273.     case kPluginBridgeNonRtShowUI:

  274.         return "kPluginBridgeNonRtShowUI";

  275.     case kPluginBridgeNonRtHideUI:

  276.         return "kPluginBridgeNonRtHideUI";

  277.     case kPluginBridgeNonRtUiParameterChange:

  278.         return "kPluginBridgeNonRtUiParameterChange";

  279.     case kPluginBridgeNonRtUiProgramChange:

  280.         return "kPluginBridgeNonRtUiProgramChange";

  281.     case kPluginBridgeNonRtUiMidiProgramChange:

  282.         return "kPluginBridgeNonRtUiMidiProgramChange";

  283.     case kPluginBridgeNonRtUiNoteOn:

  284.         return "kPluginBridgeNonRtUiNoteOn";

  285.     case kPluginBridgeNonRtUiNoteOff:

  286.         return "kPluginBridgeNonRtUiNoteOff";

  287.     case kPluginBridgeNonRtQuit:

  288.         return "kPluginBridgeNonRtQuit";

  289.     }

  290. 

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

  292.     return nullptr;

  293. }

  294. 

  295. // -----------------------------------------------------------------------

  296. 

  297. #endif // CARLA_BRIDGE_UTILS_HPP_INCLUDED