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

432 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. #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 effGetCurrentPosition 36

  62. #define effGetDestinationBuffer 37

  63. #define effOfflineNotify 38

  64. #define effOfflinePrepare 39

  65. #define effOfflineRun 40

  66. #define effProcessVarIo 41

  67. #define effSetSpeakerArrangement 42

  68. #define effSetBlockSizeAndSampleRate 43

  69. #define effSetBypass 44

  70. #define effGetErrorText 46

  71. #define effVendorSpecific 50

  72. #define effGetTailSize 52

  73. #define effGetIcon 54

  74. #define effSetViewPosition 55

  75. #define effKeysRequired 57

  76. #define effEditKeyDown 59

  77. #define effEditKeyUp 60

  78. #define effSetEditKnobMode 61

  79. #define effGetMidiProgramName 62

  80. #define effGetCurrentMidiProgram 63

  81. #define effGetMidiProgramCategory 64

  82. #define effHasMidiProgramsChanged 65

  83. #define effGetMidiKeyName 66

  84. #define effGetSpeakerArrangement 69

  85. #define effSetTotalSampleToProcess 73

  86. #define effSetPanLaw 74

  87. #define effBeginLoadBank 75

  88. #define effBeginLoadProgram 76

  89. #define effSetProcessPrecision 77

  90. #define effGetNumMidiInputChannels 78

  91. #define effGetNumMidiOutputChannels 79

  92. #define kPlugCategSynth 2

  93. #define kPlugCategAnalysis 3

  94. #define kPlugCategMastering 4

  95. #define kPlugCategRoomFx 6

  96. #define kPlugCategRestoration 8

  97. #define kPlugCategShell 10

  98. #define kPlugCategGenerator 11

  99. #define kVstAutomationOff 1

  100. #define kVstAutomationReadWrite 4

  101. #define kVstProcessLevelUnknown 0

  102. #define kVstProcessLevelUser 1

  103. #define kVstProcessLevelRealtime 2

  104. #define kVstProcessLevelOffline 4

  105. #define kVstProcessPrecision32 0

  106. #define kVstTransportChanged 1

  107. #define kVstVersion 2400

  108. #define DECLARE_VST_DEPRECATED(idx) idx

  109. #define VSTCALLBACK __cdecl

  110. struct ERect {

  111.     int16_t top, left, bottom, right;

  112. };

  113. #else

  114. #ifdef CARLA_OS_MAC

  115. # undef __ppc__

  116. # define __ppc__ 0

  117. #else

  118. # undef TARGET_API_MAC_CARBON

  119. # define TARGET_API_MAC_CARBON 0

  120. #endif

  121. #undef VST_64BIT_PLATFORM

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

  123. #include "vst2/pluginterfaces/vst2.x/aeffectx.h"

  124. #endif

  125. 

  126. // -----------------------------------------------------------------------

  127. // Plugin callback

  128. 

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

  130. 

  131. // -----------------------------------------------------------------------

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

  133. 

  134. static inline

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

  136. {

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

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

  139. 

  140.     try {

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

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

  143. }

  144. 

  145. // -----------------------------------------------------------------------

  146. // Convert Effect opcode to string

  147. 

  148. static inline

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

  150. {

  151.     switch (opcode)

  152.     {

  153.     case effOpen:

  154.         return "effOpen";

  155.     case effClose:

  156.         return "effClose";

  157.     case effSetProgram:

  158.         return "effSetProgram";

  159.     case effGetProgram:

  160.         return "effGetProgram";

  161.     case effSetProgramName:

  162.         return "effSetProgramName";

  163.     case effGetProgramName:

  164.         return "effGetProgramName";

  165.     case effGetParamLabel:

  166.         return "effGetParamLabel";

  167.     case effGetParamDisplay:

  168.         return "effGetParamDisplay";

  169.     case effGetParamName:

  170.         return "effGetParamName";

  171.     case DECLARE_VST_DEPRECATED(effGetVu):

  172.         return "effGetVu";

  173.     case effSetSampleRate:

  174.         return "effSetSampleRate";

  175.     case effSetBlockSize:

  176.         return "effSetBlockSize";

  177.     case effMainsChanged:

  178.         return "effMainsChanged";

  179.     case effEditGetRect:

  180.         return "effEditGetRect";

  181.     case effEditOpen:

  182.         return "effEditOpen";

  183.     case effEditClose:

  184.         return "effEditClose";

  185.     case DECLARE_VST_DEPRECATED(effEditDraw):

  186.         return "effEditDraw";

  187.     case DECLARE_VST_DEPRECATED(effEditMouse):

  188.         return "effEditMouse";

  189.     case DECLARE_VST_DEPRECATED(effEditKey):

  190.         return "effEditKey";

  191.     case effEditIdle:

  192.         return "effEditIdle";

  193.     case DECLARE_VST_DEPRECATED(effEditTop):

  194.         return "effEditTop";

  195.     case DECLARE_VST_DEPRECATED(effEditSleep):

  196.         return "effEditSleep";

  197.     case DECLARE_VST_DEPRECATED(effIdentify):

  198.         return "effIdentify";

  199.     case effGetChunk:

  200.         return "effGetChunk";

  201.     case effSetChunk:

  202.         return "effSetChunk";

  203.     case effProcessEvents:

  204.         return "effProcessEvents";

  205.     case effCanBeAutomated:

  206.         return "effCanBeAutomated";

  207.     case effString2Parameter:

  208.         return "effString2Parameter";

  209.     case DECLARE_VST_DEPRECATED(effGetNumProgramCategories):

  210.         return "effGetNumProgramCategories";

  211.     case effGetProgramNameIndexed:

  212.         return "effGetProgramNameIndexed";

  213.     case DECLARE_VST_DEPRECATED(effCopyProgram):

  214.         return "effCopyProgram";

  215.     case DECLARE_VST_DEPRECATED(effConnectInput):

  216.         return "effConnectInput";

  217.     case DECLARE_VST_DEPRECATED(effConnectOutput):

  218.         return "effConnectOutput";

  219.     case effGetInputProperties:

  220.         return "effGetInputProperties";

  221.     case effGetOutputProperties:

  222.         return "effGetOutputProperties";

  223.     case effGetPlugCategory:

  224.         return "effGetPlugCategory";

  225.     case DECLARE_VST_DEPRECATED(effGetCurrentPosition):

  226.         return "effGetCurrentPosition";

  227.     case DECLARE_VST_DEPRECATED(effGetDestinationBuffer):

  228.         return "effGetDestinationBuffer";

  229.     case effOfflineNotify:

  230.         return "effOfflineNotify";

  231.     case effOfflinePrepare:

  232.         return "effOfflinePrepare";

  233.     case effOfflineRun:

  234.         return "effOfflineRun";

  235.     case effProcessVarIo:

  236.         return "effProcessVarIo";

  237.     case effSetSpeakerArrangement:

  238.         return "effSetSpeakerArrangement";

  239.     case DECLARE_VST_DEPRECATED(effSetBlockSizeAndSampleRate):

  240.         return "effSetBlockSizeAndSampleRate";

  241.     case effSetBypass:

  242.         return "effSetBypass";

  243.     case effGetEffectName:

  244.         return "effGetEffectName";

  245.     case DECLARE_VST_DEPRECATED(effGetErrorText):

  246.         return "effGetErrorText";

  247.     case effGetVendorString:

  248.         return "effGetVendorString";

  249.     case effGetProductString:

  250.         return "effGetProductString";

  251.     case effGetVendorVersion:

  252.         return "effGetVendorVersion";

  253.     case effVendorSpecific:

  254.         return "effVendorSpecific";

  255.     case effCanDo:

  256.         return "effCanDo";

  257.     case effGetTailSize:

  258.         return "effGetTailSize";

  259.     case DECLARE_VST_DEPRECATED(effIdle):

  260.         return "effIdle";

  261.     case DECLARE_VST_DEPRECATED(effGetIcon):

  262.         return "effGetIcon";

  263.     case DECLARE_VST_DEPRECATED(effSetViewPosition):

  264.         return "effSetViewPosition";

  265.     case effGetParameterProperties:

  266.         return "effGetParameterProperties";

  267.     case DECLARE_VST_DEPRECATED(effKeysRequired):

  268.         return "effKeysRequired";

  269.     case effGetVstVersion:

  270.         return "effGetVstVersion";

  271.     case effEditKeyDown:

  272.         return "effEditKeyDown";

  273.     case effEditKeyUp:

  274.         return "effEditKeyUp";

  275.     case effSetEditKnobMode:

  276.         return "effSetEditKnobMode";

  277.     case effGetMidiProgramName:

  278.         return "effGetMidiProgramName";

  279.     case effGetCurrentMidiProgram:

  280.         return "effGetCurrentMidiProgram";

  281.     case effGetMidiProgramCategory:

  282.         return "effGetMidiProgramCategory";

  283.     case effHasMidiProgramsChanged:

  284.         return "effHasMidiProgramsChanged";

  285.     case effGetMidiKeyName:

  286.         return "effGetMidiKeyName";

  287.     case effBeginSetProgram:

  288.         return "effBeginSetProgram";

  289.     case effEndSetProgram:

  290.         return "effEndSetProgram";

  291.     case effGetSpeakerArrangement:

  292.         return "effGetSpeakerArrangement";

  293.     case effShellGetNextPlugin:

  294.         return "effShellGetNextPlugin";

  295.     case effStartProcess:

  296.         return "effStartProcess";

  297.     case effStopProcess:

  298.         return "effStopProcess";

  299.     case effSetTotalSampleToProcess:

  300.         return "effSetTotalSampleToProcess";

  301.     case effSetPanLaw:

  302.         return "effSetPanLaw";

  303.     case effBeginLoadBank:

  304.         return "effBeginLoadBank";

  305.     case effBeginLoadProgram:

  306.         return "effBeginLoadProgram";

  307.     case effSetProcessPrecision:

  308.         return "effSetProcessPrecision";

  309.     case effGetNumMidiInputChannels:

  310.         return "effGetNumMidiInputChannels";

  311.     case effGetNumMidiOutputChannels:

  312.         return "effGetNumMidiOutputChannels";

  313.     default:

  314.         return "unknown";

  315.     }

  316. }

  317. 

  318. // -----------------------------------------------------------------------

  319. // Convert Host/Master opcode to string

  320. 

  321. static inline

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

  323. {

  324.     switch (opcode)

  325.     {

  326.     case audioMasterAutomate:

  327.         return "audioMasterAutomate";

  328.     case audioMasterVersion:

  329.         return "audioMasterVersion";

  330.     case audioMasterCurrentId:

  331.         return "audioMasterCurrentId";

  332.     case audioMasterIdle:

  333.         return "audioMasterIdle";

  334.     case DECLARE_VST_DEPRECATED(audioMasterPinConnected):

  335.         return "audioMasterPinConnected";

  336.     case DECLARE_VST_DEPRECATED(audioMasterWantMidi):

  337.         return "audioMasterWantMidi";

  338.     case audioMasterGetTime:

  339.         return "audioMasterGetTime";

  340.     case audioMasterProcessEvents:

  341.         return "audioMasterProcessEvents";

  342.     case DECLARE_VST_DEPRECATED(audioMasterSetTime):

  343.         return "audioMasterSetTime";

  344.     case DECLARE_VST_DEPRECATED(audioMasterTempoAt):

  345.         return "audioMasterTempoAt";

  346.     case DECLARE_VST_DEPRECATED(audioMasterGetNumAutomatableParameters):

  347.         return "audioMasterGetNumAutomatableParameters";

  348.     case DECLARE_VST_DEPRECATED(audioMasterGetParameterQuantization):

  349.         return "audioMasterGetParameterQuantization";

  350.     case audioMasterIOChanged:

  351.         return "audioMasterIOChanged";

  352.     case DECLARE_VST_DEPRECATED(audioMasterNeedIdle):

  353.         return "audioMasterNeedIdle";

  354.     case audioMasterSizeWindow:

  355.         return "audioMasterSizeWindow";

  356.     case audioMasterGetSampleRate:

  357.         return "audioMasterGetSampleRate";

  358.     case audioMasterGetBlockSize:

  359.         return "audioMasterGetBlockSize";

  360.     case audioMasterGetInputLatency:

  361.         return "audioMasterGetInputLatency";

  362.     case audioMasterGetOutputLatency:

  363.         return "audioMasterGetOutputLatency";

  364.     case DECLARE_VST_DEPRECATED(audioMasterGetPreviousPlug):

  365.         return "audioMasterGetPreviousPlug";

  366.     case DECLARE_VST_DEPRECATED(audioMasterGetNextPlug):

  367.         return "audioMasterGetNextPlug";

  368.     case DECLARE_VST_DEPRECATED(audioMasterWillReplaceOrAccumulate):

  369.         return "audioMasterWillReplaceOrAccumulate";

  370.     case audioMasterGetCurrentProcessLevel:

  371.         return "audioMasterGetCurrentProcessLevel";

  372.     case audioMasterGetAutomationState:

  373.         return "audioMasterGetAutomationState";

  374.     case audioMasterOfflineStart:

  375.         return "audioMasterOfflineStart";

  376.     case audioMasterOfflineRead:

  377.         return "audioMasterOfflineRead";

  378.     case audioMasterOfflineWrite:

  379.         return "audioMasterOfflineWrite";

  380.     case audioMasterOfflineGetCurrentPass:

  381.         return "audioMasterOfflineGetCurrentPass";

  382.     case audioMasterOfflineGetCurrentMetaPass:

  383.         return "audioMasterOfflineGetCurrentMetaPass";

  384.     case DECLARE_VST_DEPRECATED(audioMasterSetOutputSampleRate):

  385.         return "audioMasterSetOutputSampleRate";

  386.     case DECLARE_VST_DEPRECATED(audioMasterGetOutputSpeakerArrangement):

  387.         return "audioMasterGetOutputSpeakerArrangement";

  388.     case audioMasterGetVendorString:

  389.         return "audioMasterGetVendorString";

  390.     case audioMasterGetProductString:

  391.         return "audioMasterGetProductString";

  392.     case audioMasterGetVendorVersion:

  393.         return "audioMasterGetVendorVersion";

  394.     case audioMasterVendorSpecific:

  395.         return "audioMasterVendorSpecific";

  396.     case DECLARE_VST_DEPRECATED(audioMasterSetIcon):

  397.         return "audioMasterSetIcon";

  398.     case audioMasterCanDo:

  399.         return "audioMasterCanDo";

  400.     case audioMasterGetLanguage:

  401.         return "audioMasterGetLanguage";

  402.     case DECLARE_VST_DEPRECATED(audioMasterOpenWindow):

  403.         return "audioMasterOpenWindow";

  404.     case DECLARE_VST_DEPRECATED(audioMasterCloseWindow):

  405.         return "audioMasterCloseWindow";

  406.     case audioMasterGetDirectory:

  407.         return "audioMasterGetDirectory";

  408.     case audioMasterUpdateDisplay:

  409.         return "audioMasterUpdateDisplay";

  410.     case audioMasterBeginEdit:

  411.         return "audioMasterBeginEdit";

  412.     case audioMasterEndEdit:

  413.         return "audioMasterEndEdit";

  414.     case audioMasterOpenFileSelector:

  415.         return "audioMasterOpenFileSelector";

  416.     case audioMasterCloseFileSelector:

  417.         return "audioMasterCloseFileSelector";

  418.     case DECLARE_VST_DEPRECATED(audioMasterEditFile):

  419.         return "audioMasterEditFile";

  420.     case DECLARE_VST_DEPRECATED(audioMasterGetChunkFile):

  421.         return "audioMasterGetChunkFile";

  422.     case DECLARE_VST_DEPRECATED(audioMasterGetInputSpeakerArrangement):

  423.         return "audioMasterGetInputSpeakerArrangement";

  424.     default:

  425.         return "unknown";

  426.     }

  427. }

  428. 

  429. // -----------------------------------------------------------------------

  430. 

  431. #endif // CARLA_VST_UTILS_HPP_INCLUDED