libs/vamp-sdk/vamp-sdk/plugguard.h

   1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
   2
   3 /*
   4     Vamp
   5
   6     An API for audio analysis and feature extraction plugins.
   7
   8     Centre for Digital Music, Queen Mary, University of London.
   9     Copyright 2006 Chris Cannam.
  10
  11     Permission is hereby granted, free of charge, to any person
  12     obtaining a copy of this software and associated documentation
  13     files (the "Software"), to deal in the Software without
  14     restriction, including without limitation the rights to use, copy,
  15     modify, merge, publish, distribute, sublicense, and/or sell copies
  16     of the Software, and to permit persons to whom the Software is
  17     furnished to do so, subject to the following conditions:
  18
  19     The above copyright notice and this permission notice shall be
  20     included in all copies or substantial portions of the Software.
  21
  22     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  23     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  25     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  26     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  27     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  28     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29
  30     Except as contained in this notice, the names of the Centre for
  31     Digital Music; Queen Mary, University of London; and Chris Cannam
  32     shall not be used in advertising or otherwise to promote the sale,
  33     use or other dealings in this Software without prior written
  34     authorization.
  35 */
  36
  37 #ifndef _VAMP_SDK_PLUGGUARD_H_
  38 #define _VAMP_SDK_PLUGGUARD_H_
  39
  40 /**
  41  * Normal usage should be:
  42  *
  43  * - Plugins include vamp-sdk/Plugin.h or vamp-sdk/PluginBase.h.
  44  *   These files include this header, which specifies an appropriate
  45  *   namespace for the plugin classes to avoid any risk of conflict
  46  *   with non-plugin class implementations in the host on load.
  47  *
  48  * - Hosts include vamp-hostsdk/Plugin.h, vamp-hostsdk/PluginBase.h,
  49  *   vamp-hostsdk/PluginHostAdapter, vamp-hostsdk/PluginLoader.h etc.
  50  *   These files include vamp-hostsdk/hostguard.h, which makes a note
  51  *   that we are in a host.  A file such as vamp-hostsdk/Plugin.h
  52  *   then simply includes vamp-sdk/Plugin.h, and this guard header
  53  *   takes notice of the fact that it has been included from a host
  54  *   and leaves the plugin namespace unset.
  55  *
  56  * Problems will occur when a host includes files directly from the
  57  * vamp-sdk directory.  There are two reasons this might happen:
  58  * mistake, perhaps owing to ignorance of the fact that this isn't
  59  * allowed (particularly since it was the normal mechanism in v1 of
  60  * the SDK); and a wish to incorporate plugin code directly into the
  61  * host rather than having to load it.
  62  *
  63  * What if the host does include a vamp-sdk header by mistake?  We can
  64  * catch it if it's included before something from vamp-hostsdk.  If
  65  * it's included after something from vamp-hostsdk, it will work OK
  66  * anyway.  The remaining problem case is where nothing from
  67  * vamp-hostsdk is included in the same file.  We can't catch that.
  68  */
  69
  70 #ifndef _VAMP_IN_HOSTSDK
  71
  72 #define _VAMP_IN_PLUGINSDK 1
  73
  74 #ifdef _VAMP_NO_PLUGIN_NAMESPACE
  75 #define _VAMP_SDK_PLUGSPACE_BEGIN(h)
  76 #define _VAMP_SDK_PLUGSPACE_END(h)
  77 #else
  78 #ifdef _VAMP_PLUGIN_IN_HOST_NAMESPACE
  79 #define _VAMP_SDK_PLUGSPACE_BEGIN(h) \
  80         namespace _VampHost {
  81
  82 #define _VAMP_SDK_PLUGSPACE_END(h) \
  83         } \
  84         using namespace _VampHost;
  85 #else
  86 #define _VAMP_SDK_PLUGSPACE_BEGIN(h) \
  87         namespace _VampPlugin {
  88
  89 #define _VAMP_SDK_PLUGSPACE_END(h) \
  90         } \
  91         using namespace _VampPlugin;
  92 #endif
  93 #endif
  94
  95 #endif
  96
  97 #endif
  98