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