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

439 lines
15KB
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. #ifdef VESTIGE_HEADER

  38. #include "vestige/aeffectx.h"

  39. #define audioMasterGetOutputSpeakerArrangement audioMasterGetSpeakerArrangement

  40. #define effFlagsProgramChunks (1 << 5)

  41. #define effSetProgramName 4

  42. #define effGetParamLabel 6

  43. #define effGetParamDisplay 7

  44. #define effGetVu 9

  45. #define effEditDraw 16

  46. #define effEditMouse 17

  47. #define effEditKey 18

  48. #define effEditSleep 21

  49. #define effIdentify 22

  50. #define effGetChunk 23

  51. #define effSetChunk 24

  52. #define effCanBeAutomated 26

  53. #define effString2Parameter 27

  54. #define effGetNumProgramCategories 28

  55. #define effGetProgramNameIndexed 29

  56. #define effCopyProgram 30

  57. #define effConnectInput 31

  58. #define effConnectOutput 32

  59. #define effGetInputProperties 33

  60. #define effGetOutputProperties 34

  61. #define effGetPlugCategory 35

  62. #define effGetCurrentPosition 36

  63. #define effGetDestinationBuffer 37

  64. #define effOfflineNotify 38

  65. #define effOfflinePrepare 39

  66. #define effOfflineRun 40

  67. #define effProcessVarIo 41

  68. #define effSetSpeakerArrangement 42

  69. #define effSetBlockSizeAndSampleRate 43

  70. #define effSetBypass 44

  71. #define effGetErrorText 46

  72. #define effVendorSpecific 50

  73. #define effGetTailSize 52

  74. #define effIdle 53

  75. #define effGetIcon 54

  76. #define effSetViewPosition 55

  77. #define effKeysRequired 57

  78. #define effEditKeyDown 59

  79. #define effEditKeyUp 60

  80. #define effSetEditKnobMode 61

  81. #define effGetMidiProgramName 62

  82. #define effGetCurrentMidiProgram 63

  83. #define effGetMidiProgramCategory 64

  84. #define effHasMidiProgramsChanged 65

  85. #define effGetMidiKeyName 66

  86. #define effBeginSetProgram 67

  87. #define effEndSetProgram 68

  88. #define effGetSpeakerArrangement 69

  89. #define effShellGetNextPlugin 70

  90. #define effStartProcess 71

  91. #define effStopProcess 72

  92. #define effSetTotalSampleToProcess 73

  93. #define effSetPanLaw 74

  94. #define effBeginLoadBank 75

  95. #define effBeginLoadProgram 76

  96. #define effSetProcessPrecision 77

  97. #define effGetNumMidiInputChannels 78

  98. #define effGetNumMidiOutputChannels 79

  99. #define kPlugCategSynth 2

  100. #define kPlugCategAnalysis 3

  101. #define kPlugCategMastering 4

  102. #define kPlugCategRoomFx 6

  103. #define kPlugCategRestoration 8

  104. #define kPlugCategShell 10

  105. #define kPlugCategGenerator 11

  106. #define kVstAutomationOff 1

  107. #define kVstAutomationReadWrite 4

  108. #define kVstProcessLevelUnknown 0

  109. #define kVstProcessLevelUser 1

  110. #define kVstProcessLevelRealtime 2

  111. #define kVstProcessLevelOffline 4

  112. #define kVstProcessPrecision32 0

  113. #define kVstTransportChanged 1

  114. #define kVstVersion 2400

  115. #define DECLARE_VST_DEPRECATED(idx) idx

  116. #define VSTCALLBACK __cdecl

  117. struct ERect {

  118.     int16_t top, left, bottom, right;

  119. };

  120. #else

  121. #ifdef CARLA_OS_MAC

  122. # undef __ppc__

  123. # define __ppc__ 0

  124. #else

  125. # undef TARGET_API_MAC_CARBON

  126. # define TARGET_API_MAC_CARBON 0

  127. #endif

  128. #undef VST_64BIT_PLATFORM

  129. #define VST_64BIT_PLATFORM (defined(_WIN64) || defined(__LP64__) || defined (_LP64))

  130. #include "vst/pluginterfaces/vst2.x/aeffectx.h"

  131. #endif

  132. 

  133. // -----------------------------------------------------------------------

  134. // Plugin callback

  135. 

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

  137. 

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

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

  140. 

  141. static inline

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

  143. {

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

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

  146. 

  147.     try {

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

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

  150. }

  151. 

  152. // -----------------------------------------------------------------------

  153. // Convert Effect opcode to string

  154. 

  155. static inline

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

  157. {

  158.     switch (opcode)

  159.     {

  160.     case effOpen:

  161.         return "effOpen";

  162.     case effClose:

  163.         return "effClose";

  164.     case effSetProgram:

  165.         return "effSetProgram";

  166.     case effGetProgram:

  167.         return "effGetProgram";

  168.     case effSetProgramName:

  169.         return "effSetProgramName";

  170.     case effGetProgramName:

  171.         return "effGetProgramName";

  172.     case effGetParamLabel:

  173.         return "effGetParamLabel";

  174.     case effGetParamDisplay:

  175.         return "effGetParamDisplay";

  176.     case effGetParamName:

  177.         return "effGetParamName";

  178.     case DECLARE_VST_DEPRECATED(effGetVu):

  179.         return "effGetVu";

  180.     case effSetSampleRate:

  181.         return "effSetSampleRate";

  182.     case effSetBlockSize:

  183.         return "effSetBlockSize";

  184.     case effMainsChanged:

  185.         return "effMainsChanged";

  186.     case effEditGetRect:

  187.         return "effEditGetRect";

  188.     case effEditOpen:

  189.         return "effEditOpen";

  190.     case effEditClose:

  191.         return "effEditClose";

  192.     case DECLARE_VST_DEPRECATED(effEditDraw):

  193.         return "effEditDraw";

  194.     case DECLARE_VST_DEPRECATED(effEditMouse):

  195.         return "effEditMouse";

  196.     case DECLARE_VST_DEPRECATED(effEditKey):

  197.         return "effEditKey";

  198.     case effEditIdle:

  199.         return "effEditIdle";

  200.     case DECLARE_VST_DEPRECATED(effEditTop):

  201.         return "effEditTop";

  202.     case DECLARE_VST_DEPRECATED(effEditSleep):

  203.         return "effEditSleep";

  204.     case DECLARE_VST_DEPRECATED(effIdentify):

  205.         return "effIdentify";

  206.     case effGetChunk:

  207.         return "effGetChunk";

  208.     case effSetChunk:

  209.         return "effSetChunk";

  210.     case effProcessEvents:

  211.         return "effProcessEvents";

  212.     case effCanBeAutomated:

  213.         return "effCanBeAutomated";

  214.     case effString2Parameter:

  215.         return "effString2Parameter";

  216.     case DECLARE_VST_DEPRECATED(effGetNumProgramCategories):

  217.         return "effGetNumProgramCategories";

  218.     case effGetProgramNameIndexed:

  219.         return "effGetProgramNameIndexed";

  220.     case DECLARE_VST_DEPRECATED(effCopyProgram):

  221.         return "effCopyProgram";

  222.     case DECLARE_VST_DEPRECATED(effConnectInput):

  223.         return "effConnectInput";

  224.     case DECLARE_VST_DEPRECATED(effConnectOutput):

  225.         return "effConnectOutput";

  226.     case effGetInputProperties:

  227.         return "effGetInputProperties";

  228.     case effGetOutputProperties:

  229.         return "effGetOutputProperties";

  230.     case effGetPlugCategory:

  231.         return "effGetPlugCategory";

  232.     case DECLARE_VST_DEPRECATED(effGetCurrentPosition):

  233.         return "effGetCurrentPosition";

  234.     case DECLARE_VST_DEPRECATED(effGetDestinationBuffer):

  235.         return "effGetDestinationBuffer";

  236.     case effOfflineNotify:

  237.         return "effOfflineNotify";

  238.     case effOfflinePrepare:

  239.         return "effOfflinePrepare";

  240.     case effOfflineRun:

  241.         return "effOfflineRun";

  242.     case effProcessVarIo:

  243.         return "effProcessVarIo";

  244.     case effSetSpeakerArrangement:

  245.         return "effSetSpeakerArrangement";

  246.     case DECLARE_VST_DEPRECATED(effSetBlockSizeAndSampleRate):

  247.         return "effSetBlockSizeAndSampleRate";

  248.     case effSetBypass:

  249.         return "effSetBypass";

  250.     case effGetEffectName:

  251.         return "effGetEffectName";

  252.     case DECLARE_VST_DEPRECATED(effGetErrorText):

  253.         return "effGetErrorText";

  254.     case effGetVendorString:

  255.         return "effGetVendorString";

  256.     case effGetProductString:

  257.         return "effGetProductString";

  258.     case effGetVendorVersion:

  259.         return "effGetVendorVersion";

  260.     case effVendorSpecific:

  261.         return "effVendorSpecific";

  262.     case effCanDo:

  263.         return "effCanDo";

  264.     case effGetTailSize:

  265.         return "effGetTailSize";

  266.     case DECLARE_VST_DEPRECATED(effIdle):

  267.         return "effIdle";

  268.     case DECLARE_VST_DEPRECATED(effGetIcon):

  269.         return "effGetIcon";

  270.     case DECLARE_VST_DEPRECATED(effSetViewPosition):

  271.         return "effSetViewPosition";

  272.     case effGetParameterProperties:

  273.         return "effGetParameterProperties";

  274.     case DECLARE_VST_DEPRECATED(effKeysRequired):

  275.         return "effKeysRequired";

  276.     case effGetVstVersion:

  277.         return "effGetVstVersion";

  278.     case effEditKeyDown:

  279.         return "effEditKeyDown";

  280.     case effEditKeyUp:

  281.         return "effEditKeyUp";

  282.     case effSetEditKnobMode:

  283.         return "effSetEditKnobMode";

  284.     case effGetMidiProgramName:

  285.         return "effGetMidiProgramName";

  286.     case effGetCurrentMidiProgram:

  287.         return "effGetCurrentMidiProgram";

  288.     case effGetMidiProgramCategory:

  289.         return "effGetMidiProgramCategory";

  290.     case effHasMidiProgramsChanged:

  291.         return "effHasMidiProgramsChanged";

  292.     case effGetMidiKeyName:

  293.         return "effGetMidiKeyName";

  294.     case effBeginSetProgram:

  295.         return "effBeginSetProgram";

  296.     case effEndSetProgram:

  297.         return "effEndSetProgram";

  298.     case effGetSpeakerArrangement:

  299.         return "effGetSpeakerArrangement";

  300.     case effShellGetNextPlugin:

  301.         return "effShellGetNextPlugin";

  302.     case effStartProcess:

  303.         return "effStartProcess";

  304.     case effStopProcess:

  305.         return "effStopProcess";

  306.     case effSetTotalSampleToProcess:

  307.         return "effSetTotalSampleToProcess";

  308.     case effSetPanLaw:

  309.         return "effSetPanLaw";

  310.     case effBeginLoadBank:

  311.         return "effBeginLoadBank";

  312.     case effBeginLoadProgram:

  313.         return "effBeginLoadProgram";

  314.     case effSetProcessPrecision:

  315.         return "effSetProcessPrecision";

  316.     case effGetNumMidiInputChannels:

  317.         return "effGetNumMidiInputChannels";

  318.     case effGetNumMidiOutputChannels:

  319.         return "effGetNumMidiOutputChannels";

  320.     default:

  321.         return "unknown";

  322.     }

  323. }

  324. 

  325. // -----------------------------------------------------------------------

  326. // Convert Host/Master opcode to string

  327. 

  328. static inline

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

  330. {

  331.     switch (opcode)

  332.     {

  333.     case audioMasterAutomate:

  334.         return "audioMasterAutomate";

  335.     case audioMasterVersion:

  336.         return "audioMasterVersion";

  337.     case audioMasterCurrentId:

  338.         return "audioMasterCurrentId";

  339.     case audioMasterIdle:

  340.         return "audioMasterIdle";

  341.     case DECLARE_VST_DEPRECATED(audioMasterPinConnected):

  342.         return "audioMasterPinConnected";

  343.     case DECLARE_VST_DEPRECATED(audioMasterWantMidi):

  344.         return "audioMasterWantMidi";

  345.     case audioMasterGetTime:

  346.         return "audioMasterGetTime";

  347.     case audioMasterProcessEvents:

  348.         return "audioMasterProcessEvents";

  349.     case DECLARE_VST_DEPRECATED(audioMasterSetTime):

  350.         return "audioMasterSetTime";

  351.     case DECLARE_VST_DEPRECATED(audioMasterTempoAt):

  352.         return "audioMasterTempoAt";

  353.     case DECLARE_VST_DEPRECATED(audioMasterGetNumAutomatableParameters):

  354.         return "audioMasterGetNumAutomatableParameters";

  355.     case DECLARE_VST_DEPRECATED(audioMasterGetParameterQuantization):

  356.         return "audioMasterGetParameterQuantization";

  357.     case audioMasterIOChanged:

  358.         return "audioMasterIOChanged";

  359.     case DECLARE_VST_DEPRECATED(audioMasterNeedIdle):

  360.         return "audioMasterNeedIdle";

  361.     case audioMasterSizeWindow:

  362.         return "audioMasterSizeWindow";

  363.     case audioMasterGetSampleRate:

  364.         return "audioMasterGetSampleRate";

  365.     case audioMasterGetBlockSize:

  366.         return "audioMasterGetBlockSize";

  367.     case audioMasterGetInputLatency:

  368.         return "audioMasterGetInputLatency";

  369.     case audioMasterGetOutputLatency:

  370.         return "audioMasterGetOutputLatency";

  371.     case DECLARE_VST_DEPRECATED(audioMasterGetPreviousPlug):

  372.         return "audioMasterGetPreviousPlug";

  373.     case DECLARE_VST_DEPRECATED(audioMasterGetNextPlug):

  374.         return "audioMasterGetNextPlug";

  375.     case DECLARE_VST_DEPRECATED(audioMasterWillReplaceOrAccumulate):

  376.         return "audioMasterWillReplaceOrAccumulate";

  377.     case audioMasterGetCurrentProcessLevel:

  378.         return "audioMasterGetCurrentProcessLevel";

  379.     case audioMasterGetAutomationState:

  380.         return "audioMasterGetAutomationState";

  381.     case audioMasterOfflineStart:

  382.         return "audioMasterOfflineStart";

  383.     case audioMasterOfflineRead:

  384.         return "audioMasterOfflineRead";

  385.     case audioMasterOfflineWrite:

  386.         return "audioMasterOfflineWrite";

  387.     case audioMasterOfflineGetCurrentPass:

  388.         return "audioMasterOfflineGetCurrentPass";

  389.     case audioMasterOfflineGetCurrentMetaPass:

  390.         return "audioMasterOfflineGetCurrentMetaPass";

  391.     case DECLARE_VST_DEPRECATED(audioMasterSetOutputSampleRate):

  392.         return "audioMasterSetOutputSampleRate";

  393.     case DECLARE_VST_DEPRECATED(audioMasterGetOutputSpeakerArrangement):

  394.         return "audioMasterGetOutputSpeakerArrangement";

  395.     case audioMasterGetVendorString:

  396.         return "audioMasterGetVendorString";

  397.     case audioMasterGetProductString:

  398.         return "audioMasterGetProductString";

  399.     case audioMasterGetVendorVersion:

  400.         return "audioMasterGetVendorVersion";

  401.     case audioMasterVendorSpecific:

  402.         return "audioMasterVendorSpecific";

  403.     case DECLARE_VST_DEPRECATED(audioMasterSetIcon):

  404.         return "audioMasterSetIcon";

  405.     case audioMasterCanDo:

  406.         return "audioMasterCanDo";

  407.     case audioMasterGetLanguage:

  408.         return "audioMasterGetLanguage";

  409.     case DECLARE_VST_DEPRECATED(audioMasterOpenWindow):

  410.         return "audioMasterOpenWindow";

  411.     case DECLARE_VST_DEPRECATED(audioMasterCloseWindow):

  412.         return "audioMasterCloseWindow";

  413.     case audioMasterGetDirectory:

  414.         return "audioMasterGetDirectory";

  415.     case audioMasterUpdateDisplay:

  416.         return "audioMasterUpdateDisplay";

  417.     case audioMasterBeginEdit:

  418.         return "audioMasterBeginEdit";

  419.     case audioMasterEndEdit:

  420.         return "audioMasterEndEdit";

  421.     case audioMasterOpenFileSelector:

  422.         return "audioMasterOpenFileSelector";

  423.     case audioMasterCloseFileSelector:

  424.         return "audioMasterCloseFileSelector";

  425.     case DECLARE_VST_DEPRECATED(audioMasterEditFile):

  426.         return "audioMasterEditFile";

  427.     case DECLARE_VST_DEPRECATED(audioMasterGetChunkFile):

  428.         return "audioMasterGetChunkFile";

  429.     case DECLARE_VST_DEPRECATED(audioMasterGetInputSpeakerArrangement):

  430.         return "audioMasterGetInputSpeakerArrangement";

  431.     default:

  432.         return "unknown";

  433.     }

  434. }

  435. 

  436. // -----------------------------------------------------------------------

  437. 

  438. #endif // CARLA_VST_UTILS_HPP_INCLUDED