Chris@25: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@25: 
Chris@25: /*
Chris@25:     Vamp
Chris@25: 
Chris@25:     An API for audio analysis and feature extraction plugins.
Chris@25: 
Chris@25:     Centre for Digital Music, Queen Mary, University of London.
Chris@25:     Copyright 2006 Chris Cannam.
Chris@25:   
Chris@25:     Permission is hereby granted, free of charge, to any person
Chris@25:     obtaining a copy of this software and associated documentation
Chris@25:     files (the "Software"), to deal in the Software without
Chris@25:     restriction, including without limitation the rights to use, copy,
Chris@25:     modify, merge, publish, distribute, sublicense, and/or sell copies
Chris@25:     of the Software, and to permit persons to whom the Software is
Chris@25:     furnished to do so, subject to the following conditions:
Chris@25: 
Chris@25:     The above copyright notice and this permission notice shall be
Chris@25:     included in all copies or substantial portions of the Software.
Chris@25: 
Chris@25:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@25:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@25:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Chris@25:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
Chris@25:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
Chris@25:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@25:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@25: 
Chris@25:     Except as contained in this notice, the names of the Centre for
Chris@25:     Digital Music; Queen Mary, University of London; and Chris Cannam
Chris@25:     shall not be used in advertising or otherwise to promote the sale,
Chris@25:     use or other dealings in this Software without prior written
Chris@25:     authorization.
Chris@25: */
Chris@25: 
Chris@25: #ifndef _VAMP_SDK_PLUGGUARD_H_
Chris@25: #define _VAMP_SDK_PLUGGUARD_H_
Chris@25: 
Chris@25: /**
Chris@25:  * Normal usage should be:
Chris@25:  *
Chris@25:  * - Plugins include vamp-sdk/Plugin.h or vamp-sdk/PluginBase.h.
Chris@25:  *   These files include this header, which specifies an appropriate
Chris@25:  *   namespace for the plugin classes to avoid any risk of conflict
Chris@25:  *   with non-plugin class implementations in the host on load.
Chris@25:  *
Chris@25:  * - Hosts include vamp-hostsdk/Plugin.h, vamp-hostsdk/PluginBase.h,
Chris@25:  *   vamp-hostsdk/PluginHostAdapter, vamp-hostsdk/PluginLoader.h etc.
Chris@25:  *   These files include vamp-hostsdk/hostguard.h, which makes a note
Chris@25:  *   that we are in a host.  A file such as vamp-hostsdk/Plugin.h
Chris@25:  *   then simply includes vamp-sdk/Plugin.h, and this guard header
Chris@25:  *   takes notice of the fact that it has been included from a host
Chris@25:  *   and leaves the plugin namespace unset.
Chris@25:  *
Chris@25:  * Problems will occur when a host includes files directly from the
Chris@25:  * vamp-sdk directory.  There are two reasons this might happen:
Chris@25:  * mistake, perhaps owing to ignorance of the fact that this isn't
Chris@25:  * allowed (particularly since it was the normal mechanism in v1 of
Chris@25:  * the SDK); and a wish to incorporate plugin code directly into the
Chris@25:  * host rather than having to load it.
Chris@25:  *
Chris@25:  * What if the host does include a vamp-sdk header by mistake?  We can
Chris@25:  * catch it if it's included before something from vamp-hostsdk.  If
Chris@25:  * it's included after something from vamp-hostsdk, it will work OK
Chris@25:  * anyway.  The remaining problem case is where nothing from
Chris@25:  * vamp-hostsdk is included in the same file.  We can't catch that.
Chris@25:  */
Chris@25: 
Chris@25: #ifndef _VAMP_IN_HOSTSDK
Chris@25: 
Chris@25: #define _VAMP_IN_PLUGINSDK 1
Chris@25: 
Chris@25: #define VAMP_SDK_VERSION "2.5"
Chris@25: #define VAMP_SDK_MAJOR_VERSION 2
Chris@25: #define VAMP_SDK_MINOR_VERSION 5
Chris@25: 
Chris@25: #ifdef _VAMP_NO_PLUGIN_NAMESPACE
Chris@25: #define _VAMP_SDK_PLUGSPACE_BEGIN(h)
Chris@25: #define _VAMP_SDK_PLUGSPACE_END(h)
Chris@25: #else
Chris@25: #ifdef _VAMP_PLUGIN_IN_HOST_NAMESPACE
Chris@25: #define _VAMP_SDK_PLUGSPACE_BEGIN(h) \
Chris@25: 	namespace _VampHost {
Chris@25: 
Chris@25: #define _VAMP_SDK_PLUGSPACE_END(h) \
Chris@25: 	} \
Chris@25: 	using namespace _VampHost;
Chris@25: #else
Chris@25: #define _VAMP_SDK_PLUGSPACE_BEGIN(h) \
Chris@25: 	namespace _VampPlugin {
Chris@25: 
Chris@25: #define _VAMP_SDK_PLUGSPACE_END(h) \
Chris@25: 	} \
Chris@25: 	using namespace _VampPlugin;
Chris@25: #endif
Chris@25: #endif
Chris@25: 
Chris@25: #endif
Chris@25: 
Chris@25: #endif
Chris@25: