Go to the source code of this file.
Chris@1:Chris@6: Macros | |
| #define | _VAMP_IN_PLUGINSDK 1 |
| Normal usage should be: More... | |
| #define | VAMP_SDK_VERSION "2.7" |
| #define | VAMP_SDK_MAJOR_VERSION 2 |
| #define | VAMP_SDK_MINOR_VERSION 7 |
| #define | _VAMP_SDK_PLUGSPACE_BEGIN(h) |
| #define | _VAMP_SDK_PLUGSPACE_END(h) |
Macro Definition Documentation
Chris@6: Chris@6:◆ _VAMP_IN_PLUGINSDK
Chris@6: Chris@1:| #define _VAMP_IN_PLUGINSDK 1 | Chris@1:
Normal usage should be:
Chris@1:-
Chris@1:
- Plugins include vamp-sdk/Plugin.h or vamp-sdk/PluginBase.h. These files include this header, which specifies an appropriate namespace for the plugin classes to avoid any risk of conflict with non-plugin class implementations in the host on load. Chris@1:
- Hosts include vamp-hostsdk/Plugin.h, vamp-hostsdk/PluginBase.h, vamp-hostsdk/PluginHostAdapter, vamp-hostsdk/PluginLoader.h etc. These files include vamp-hostsdk/hostguard.h, which makes a note that we are in a host. A file such as vamp-hostsdk/Plugin.h then simply includes vamp-sdk/Plugin.h, and this guard header takes notice of the fact that it has been included from a host and leaves the plugin namespace unset. Chris@1:
Problems will occur when a host includes files directly from the vamp-sdk directory. There are two reasons this might happen: mistake, perhaps owing to ignorance of the fact that this isn't allowed (particularly since it was the normal mechanism in v1 of the SDK); and a wish to incorporate plugin code directly into the host rather than having to load it.
Chris@1:What if the host does include a vamp-sdk header by mistake? We can catch it if it's included before something from vamp-hostsdk. If it's included after something from vamp-hostsdk, it will work OK anyway. The remaining problem case is where nothing from vamp-hostsdk is included in the same file. We can't catch that.
Chris@1: Chris@6:Definition at line 72 of file plugguard.h.
Chris@1: Chris@1:◆ VAMP_SDK_VERSION
Chris@6: Chris@1:| #define VAMP_SDK_VERSION "2.7" | Chris@3:
Definition at line 74 of file plugguard.h.
Chris@3: Chris@6:Referenced by main().
Chris@3: Chris@3:◆ VAMP_SDK_MAJOR_VERSION
Chris@6: Chris@3:| #define VAMP_SDK_MAJOR_VERSION 2 | Chris@3:
Definition at line 75 of file plugguard.h.
Chris@3: Chris@3:◆ VAMP_SDK_MINOR_VERSION
Chris@6: Chris@3:| #define VAMP_SDK_MINOR_VERSION 7 | Chris@3:
Definition at line 76 of file plugguard.h.
Chris@3: Chris@3:◆ _VAMP_SDK_PLUGSPACE_BEGIN
Chris@6: Chris@3:| #define _VAMP_SDK_PLUGSPACE_BEGIN | Chris@1:( | Chris@1:Chris@1: | h | ) | Chris@1:Chris@1: |
Definition at line 79 of file plugguard.h.
Chris@1: Chris@1:◆ _VAMP_SDK_PLUGSPACE_END
Chris@6: Chris@1:| #define _VAMP_SDK_PLUGSPACE_END | Chris@1:( | Chris@1:Chris@1: | h | ) | Chris@1:Chris@1: |
Definition at line 80 of file plugguard.h.
Chris@6: Chris@6:Referenced by Vamp::PluginAdapter< P >::createPlugin(), and Vamp::PluginBase::selectProgram().
Chris@1: Chris@1: