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.
3764 Commits
16 Branches
330MB
Tree: a472b6dea7
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'a472b6dea7'
${ noResults }
Carla/source/utils/CarlaVstUtils.hpp

419 lines
14KB
Raw Blame History 

  1. /*

  2.  * Carla VST utils

  3.  * Copyright (C) 2011-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_VST_UTILS_HPP_INCLUDED

  19. #define CARLA_VST_UTILS_HPP_INCLUDED

  20. 

  21. #include "CarlaUtils.hpp"

  22. 

  23. // -----------------------------------------------------------------------

  24. // Include fixes

  25. 

  26. // Define __cdecl if needed

  27. #ifndef CARLA_OS_WIN

  28. # ifndef __cdecl

  29. #  define __cdecl

  30. # endif

  31. #endif

  32. 

  33. // Disable deprecated VST features (NOT)

  34. #define VST_2_4_EXTENSIONS 1

  35. #define VST_FORCE_DEPRECATED 0

  36. 

  37. #include "vestige/aeffectx.h"

  38. #define audioMasterGetOutputSpeakerArrangement audioMasterGetSpeakerArrangement

  39. #define effFlagsProgramChunks (1 << 5)

  40. #define effSetProgramName 4

  41. #define effGetParamLabel 6

  42. #define effGetParamDisplay 7

  43. #define effGetVu 9

  44. #define effEditDraw 16

  45. #define effEditMouse 17

  46. #define effEditKey 18

  47. #define effEditSleep 21

  48. #define effIdentify 22

  49. #define effGetChunk 23

  50. #define effSetChunk 24

  51. #define effCanBeAutomated 26

  52. #define effString2Parameter 27

  53. #define effGetNumProgramCategories 28

  54. #define effGetProgramNameIndexed 29

  55. #define effCopyProgram 30

  56. #define effConnectInput 31

  57. #define effConnectOutput 32

  58. #define effGetInputProperties 33

  59. #define effGetOutputProperties 34

  60. #define effGetCurrentPosition 36

  61. #define effGetDestinationBuffer 37

  62. #define effOfflineNotify 38

  63. #define effOfflinePrepare 39

  64. #define effOfflineRun 40

  65. #define effProcessVarIo 41

  66. #define effSetSpeakerArrangement 42

  67. #define effSetBlockSizeAndSampleRate 43

  68. #define effSetBypass 44

  69. #define effGetErrorText 46

  70. #define effVendorSpecific 50

  71. #define effGetTailSize 52

  72. #define effGetIcon 54

  73. #define effSetViewPosition 55

  74. #define effKeysRequired 57

  75. #define effEditKeyDown 59

  76. #define effEditKeyUp 60

  77. #define effSetEditKnobMode 61

  78. #define effGetMidiProgramName 62

  79. #define effGetCurrentMidiProgram 63

  80. #define effGetMidiProgramCategory 64

  81. #define effHasMidiProgramsChanged 65

  82. #define effGetMidiKeyName 66

  83. #define effGetSpeakerArrangement 69

  84. #define effSetTotalSampleToProcess 73

  85. #define effSetPanLaw 74

  86. #define effBeginLoadBank 75

  87. #define effBeginLoadProgram 76

  88. #define effSetProcessPrecision 77

  89. #define effGetNumMidiInputChannels 78

  90. #define effGetNumMidiOutputChannels 79

  91. #define kPlugCategSynth 2

  92. #define kPlugCategAnalysis 3

  93. #define kPlugCategMastering 4

  94. #define kPlugCategRoomFx 6

  95. #define kPlugCategRestoration 8

  96. #define kPlugCategShell 10

  97. #define kPlugCategGenerator 11

  98. #define kVstAutomationOff 1

  99. #define kVstAutomationReadWrite 4

  100. #define kVstProcessLevelUnknown 0

  101. #define kVstProcessLevelUser 1

  102. #define kVstProcessLevelRealtime 2

  103. #define kVstProcessLevelOffline 4

  104. #define kVstProcessPrecision32 0

  105. #define kVstTransportChanged 1

  106. #define kVstVersion 2400

  107. #define DECLARE_VST_DEPRECATED(idx) idx

  108. #define VSTCALLBACK __cdecl

  109. struct ERect {

  110.     int16_t top, left, bottom, right;

  111. };

  112. 

  113. // -----------------------------------------------------------------------

  114. // Plugin callback

  115. 

  116. typedef AEffect* (*VST_Function)(audioMasterCallback);

  117. 

  118. // -----------------------------------------------------------------------

  119. // Check if feature is supported by the plugin

  120. 

  121. static inline

  122. bool vstPluginCanDo(AEffect* const effect, const char* const feature) noexcept

  123. {

  124.     CARLA_SAFE_ASSERT_RETURN(effect != nullptr, false);

  125.     CARLA_SAFE_ASSERT_RETURN(feature != nullptr && feature[0] != '\0', false);

  126. 

  127.     try {

  128.         return (effect->dispatcher(effect, effCanDo, 0, 0, const_cast<char*>(feature), 0.0f) == 1);

  129.     } CARLA_SAFE_EXCEPTION_RETURN("vstPluginCanDo", false);

  130. }

  131. 

  132. // -----------------------------------------------------------------------

  133. // Convert Effect opcode to string

  134. 

  135. static inline

  136. const char* vstEffectOpcode2str(const int32_t opcode) noexcept

  137. {

  138.     switch (opcode)

  139.     {

  140.     case effOpen:

  141.         return "effOpen";

  142.     case effClose:

  143.         return "effClose";

  144.     case effSetProgram:

  145.         return "effSetProgram";

  146.     case effGetProgram:

  147.         return "effGetProgram";

  148.     case effSetProgramName:

  149.         return "effSetProgramName";

  150.     case effGetProgramName:

  151.         return "effGetProgramName";

  152.     case effGetParamLabel:

  153.         return "effGetParamLabel";

  154.     case effGetParamDisplay:

  155.         return "effGetParamDisplay";

  156.     case effGetParamName:

  157.         return "effGetParamName";

  158.     case DECLARE_VST_DEPRECATED(effGetVu):

  159.         return "effGetVu";

  160.     case effSetSampleRate:

  161.         return "effSetSampleRate";

  162.     case effSetBlockSize:

  163.         return "effSetBlockSize";

  164.     case effMainsChanged:

  165.         return "effMainsChanged";

  166.     case effEditGetRect:

  167.         return "effEditGetRect";

  168.     case effEditOpen:

  169.         return "effEditOpen";

  170.     case effEditClose:

  171.         return "effEditClose";

  172.     case DECLARE_VST_DEPRECATED(effEditDraw):

  173.         return "effEditDraw";

  174.     case DECLARE_VST_DEPRECATED(effEditMouse):

  175.         return "effEditMouse";

  176.     case DECLARE_VST_DEPRECATED(effEditKey):

  177.         return "effEditKey";

  178.     case effEditIdle:

  179.         return "effEditIdle";

  180.     case DECLARE_VST_DEPRECATED(effEditTop):

  181.         return "effEditTop";

  182.     case DECLARE_VST_DEPRECATED(effEditSleep):

  183.         return "effEditSleep";

  184.     case DECLARE_VST_DEPRECATED(effIdentify):

  185.         return "effIdentify";

  186.     case effGetChunk:

  187.         return "effGetChunk";

  188.     case effSetChunk:

  189.         return "effSetChunk";

  190.     case effProcessEvents:

  191.         return "effProcessEvents";

  192.     case effCanBeAutomated:

  193.         return "effCanBeAutomated";

  194.     case effString2Parameter:

  195.         return "effString2Parameter";

  196.     case DECLARE_VST_DEPRECATED(effGetNumProgramCategories):

  197.         return "effGetNumProgramCategories";

  198.     case effGetProgramNameIndexed:

  199.         return "effGetProgramNameIndexed";

  200.     case DECLARE_VST_DEPRECATED(effCopyProgram):

  201.         return "effCopyProgram";

  202.     case DECLARE_VST_DEPRECATED(effConnectInput):

  203.         return "effConnectInput";

  204.     case DECLARE_VST_DEPRECATED(effConnectOutput):

  205.         return "effConnectOutput";

  206.     case effGetInputProperties:

  207.         return "effGetInputProperties";

  208.     case effGetOutputProperties:

  209.         return "effGetOutputProperties";

  210.     case effGetPlugCategory:

  211.         return "effGetPlugCategory";

  212.     case DECLARE_VST_DEPRECATED(effGetCurrentPosition):

  213.         return "effGetCurrentPosition";

  214.     case DECLARE_VST_DEPRECATED(effGetDestinationBuffer):

  215.         return "effGetDestinationBuffer";

  216.     case effOfflineNotify:

  217.         return "effOfflineNotify";

  218.     case effOfflinePrepare:

  219.         return "effOfflinePrepare";

  220.     case effOfflineRun:

  221.         return "effOfflineRun";

  222.     case effProcessVarIo:

  223.         return "effProcessVarIo";

  224.     case effSetSpeakerArrangement:

  225.         return "effSetSpeakerArrangement";

  226.     case DECLARE_VST_DEPRECATED(effSetBlockSizeAndSampleRate):

  227.         return "effSetBlockSizeAndSampleRate";

  228.     case effSetBypass:

  229.         return "effSetBypass";

  230.     case effGetEffectName:

  231.         return "effGetEffectName";

  232.     case DECLARE_VST_DEPRECATED(effGetErrorText):

  233.         return "effGetErrorText";

  234.     case effGetVendorString:

  235.         return "effGetVendorString";

  236.     case effGetProductString:

  237.         return "effGetProductString";

  238.     case effGetVendorVersion:

  239.         return "effGetVendorVersion";

  240.     case effVendorSpecific:

  241.         return "effVendorSpecific";

  242.     case effCanDo:

  243.         return "effCanDo";

  244.     case effGetTailSize:

  245.         return "effGetTailSize";

  246.     case DECLARE_VST_DEPRECATED(effIdle):

  247.         return "effIdle";

  248.     case DECLARE_VST_DEPRECATED(effGetIcon):

  249.         return "effGetIcon";

  250.     case DECLARE_VST_DEPRECATED(effSetViewPosition):

  251.         return "effSetViewPosition";

  252.     case effGetParameterProperties:

  253.         return "effGetParameterProperties";

  254.     case DECLARE_VST_DEPRECATED(effKeysRequired):

  255.         return "effKeysRequired";

  256.     case effGetVstVersion:

  257.         return "effGetVstVersion";

  258.     case effEditKeyDown:

  259.         return "effEditKeyDown";

  260.     case effEditKeyUp:

  261.         return "effEditKeyUp";

  262.     case effSetEditKnobMode:

  263.         return "effSetEditKnobMode";

  264.     case effGetMidiProgramName:

  265.         return "effGetMidiProgramName";

  266.     case effGetCurrentMidiProgram:

  267.         return "effGetCurrentMidiProgram";

  268.     case effGetMidiProgramCategory:

  269.         return "effGetMidiProgramCategory";

  270.     case effHasMidiProgramsChanged:

  271.         return "effHasMidiProgramsChanged";

  272.     case effGetMidiKeyName:

  273.         return "effGetMidiKeyName";

  274.     case effBeginSetProgram:

  275.         return "effBeginSetProgram";

  276.     case effEndSetProgram:

  277.         return "effEndSetProgram";

  278.     case effGetSpeakerArrangement:

  279.         return "effGetSpeakerArrangement";

  280.     case effShellGetNextPlugin:

  281.         return "effShellGetNextPlugin";

  282.     case effStartProcess:

  283.         return "effStartProcess";

  284.     case effStopProcess:

  285.         return "effStopProcess";

  286.     case effSetTotalSampleToProcess:

  287.         return "effSetTotalSampleToProcess";

  288.     case effSetPanLaw:

  289.         return "effSetPanLaw";

  290.     case effBeginLoadBank:

  291.         return "effBeginLoadBank";

  292.     case effBeginLoadProgram:

  293.         return "effBeginLoadProgram";

  294.     case effSetProcessPrecision:

  295.         return "effSetProcessPrecision";

  296.     case effGetNumMidiInputChannels:

  297.         return "effGetNumMidiInputChannels";

  298.     case effGetNumMidiOutputChannels:

  299.         return "effGetNumMidiOutputChannels";

  300.     default:

  301.         return "unknown";

  302.     }

  303. }

  304. 

  305. // -----------------------------------------------------------------------

  306. // Convert Host/Master opcode to string

  307. 

  308. static inline

  309. const char* vstMasterOpcode2str(const int32_t opcode) noexcept

  310. {

  311.     switch (opcode)

  312.     {

  313.     case audioMasterAutomate:

  314.         return "audioMasterAutomate";

  315.     case audioMasterVersion:

  316.         return "audioMasterVersion";

  317.     case audioMasterCurrentId:

  318.         return "audioMasterCurrentId";

  319.     case audioMasterIdle:

  320.         return "audioMasterIdle";

  321.     case DECLARE_VST_DEPRECATED(audioMasterPinConnected):

  322.         return "audioMasterPinConnected";

  323.     case DECLARE_VST_DEPRECATED(audioMasterWantMidi):

  324.         return "audioMasterWantMidi";

  325.     case audioMasterGetTime:

  326.         return "audioMasterGetTime";

  327.     case audioMasterProcessEvents:

  328.         return "audioMasterProcessEvents";

  329.     case DECLARE_VST_DEPRECATED(audioMasterSetTime):

  330.         return "audioMasterSetTime";

  331.     case DECLARE_VST_DEPRECATED(audioMasterTempoAt):

  332.         return "audioMasterTempoAt";

  333.     case DECLARE_VST_DEPRECATED(audioMasterGetNumAutomatableParameters):

  334.         return "audioMasterGetNumAutomatableParameters";

  335.     case DECLARE_VST_DEPRECATED(audioMasterGetParameterQuantization):

  336.         return "audioMasterGetParameterQuantization";

  337.     case audioMasterIOChanged:

  338.         return "audioMasterIOChanged";

  339.     case DECLARE_VST_DEPRECATED(audioMasterNeedIdle):

  340.         return "audioMasterNeedIdle";

  341.     case audioMasterSizeWindow:

  342.         return "audioMasterSizeWindow";

  343.     case audioMasterGetSampleRate:

  344.         return "audioMasterGetSampleRate";

  345.     case audioMasterGetBlockSize:

  346.         return "audioMasterGetBlockSize";

  347.     case audioMasterGetInputLatency:

  348.         return "audioMasterGetInputLatency";

  349.     case audioMasterGetOutputLatency:

  350.         return "audioMasterGetOutputLatency";

  351.     case DECLARE_VST_DEPRECATED(audioMasterGetPreviousPlug):

  352.         return "audioMasterGetPreviousPlug";

  353.     case DECLARE_VST_DEPRECATED(audioMasterGetNextPlug):

  354.         return "audioMasterGetNextPlug";

  355.     case DECLARE_VST_DEPRECATED(audioMasterWillReplaceOrAccumulate):

  356.         return "audioMasterWillReplaceOrAccumulate";

  357.     case audioMasterGetCurrentProcessLevel:

  358.         return "audioMasterGetCurrentProcessLevel";

  359.     case audioMasterGetAutomationState:

  360.         return "audioMasterGetAutomationState";

  361.     case audioMasterOfflineStart:

  362.         return "audioMasterOfflineStart";

  363.     case audioMasterOfflineRead:

  364.         return "audioMasterOfflineRead";

  365.     case audioMasterOfflineWrite:

  366.         return "audioMasterOfflineWrite";

  367.     case audioMasterOfflineGetCurrentPass:

  368.         return "audioMasterOfflineGetCurrentPass";

  369.     case audioMasterOfflineGetCurrentMetaPass:

  370.         return "audioMasterOfflineGetCurrentMetaPass";

  371.     case DECLARE_VST_DEPRECATED(audioMasterSetOutputSampleRate):

  372.         return "audioMasterSetOutputSampleRate";

  373.     case DECLARE_VST_DEPRECATED(audioMasterGetOutputSpeakerArrangement):

  374.         return "audioMasterGetOutputSpeakerArrangement";

  375.     case audioMasterGetVendorString:

  376.         return "audioMasterGetVendorString";

  377.     case audioMasterGetProductString:

  378.         return "audioMasterGetProductString";

  379.     case audioMasterGetVendorVersion:

  380.         return "audioMasterGetVendorVersion";

  381.     case audioMasterVendorSpecific:

  382.         return "audioMasterVendorSpecific";

  383.     case DECLARE_VST_DEPRECATED(audioMasterSetIcon):

  384.         return "audioMasterSetIcon";

  385.     case audioMasterCanDo:

  386.         return "audioMasterCanDo";

  387.     case audioMasterGetLanguage:

  388.         return "audioMasterGetLanguage";

  389.     case DECLARE_VST_DEPRECATED(audioMasterOpenWindow):

  390.         return "audioMasterOpenWindow";

  391.     case DECLARE_VST_DEPRECATED(audioMasterCloseWindow):

  392.         return "audioMasterCloseWindow";

  393.     case audioMasterGetDirectory:

  394.         return "audioMasterGetDirectory";

  395.     case audioMasterUpdateDisplay:

  396.         return "audioMasterUpdateDisplay";

  397.     case audioMasterBeginEdit:

  398.         return "audioMasterBeginEdit";

  399.     case audioMasterEndEdit:

  400.         return "audioMasterEndEdit";

  401.     case audioMasterOpenFileSelector:

  402.         return "audioMasterOpenFileSelector";

  403.     case audioMasterCloseFileSelector:

  404.         return "audioMasterCloseFileSelector";

  405.     case DECLARE_VST_DEPRECATED(audioMasterEditFile):

  406.         return "audioMasterEditFile";

  407.     case DECLARE_VST_DEPRECATED(audioMasterGetChunkFile):

  408.         return "audioMasterGetChunkFile";

  409.     case DECLARE_VST_DEPRECATED(audioMasterGetInputSpeakerArrangement):

  410.         return "audioMasterGetInputSpeakerArrangement";

  411.     default:

  412.         return "unknown";

  413.     }

  414. }

  415. 

  416. // -----------------------------------------------------------------------

  417. 

  418. #endif // CARLA_VST_UTILS_HPP_INCLUDED