c@10: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
c@10: 
c@10: /*
c@10:     Vampipe
c@10: 
c@10:     Centre for Digital Music, Queen Mary, University of London.
c@10:     Copyright 2006-2016 Chris Cannam and QMUL.
c@10:   
c@10:     Permission is hereby granted, free of charge, to any person
c@10:     obtaining a copy of this software and associated documentation
c@10:     files (the "Software"), to deal in the Software without
c@10:     restriction, including without limitation the rights to use, copy,
c@10:     modify, merge, publish, distribute, sublicense, and/or sell copies
c@10:     of the Software, and to permit persons to whom the Software is
c@10:     furnished to do so, subject to the following conditions:
c@10: 
c@10:     The above copyright notice and this permission notice shall be
c@10:     included in all copies or substantial portions of the Software.
c@10: 
c@10:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
c@10:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
c@10:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
c@10:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
c@10:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
c@10:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
c@10:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
c@10: 
c@10:     Except as contained in this notice, the names of the Centre for
c@10:     Digital Music; Queen Mary, University of London; and Chris Cannam
c@10:     shall not be used in advertising or otherwise to promote the sale,
c@10:     use or other dealings in this Software without prior written
c@10:     authorization.
c@10: */
c@10: 
c@10: #ifndef VAMPIPE_PLUGIN_HANDLE_MAPPER_H
c@10: #define VAMPIPE_PLUGIN_HANDLE_MAPPER_H
c@10: 
c@57: #include "PluginOutputIdMapper.h"
c@57: 
c@10: #include <vamp-hostsdk/Plugin.h>
c@57: #include <memory>
c@51: 
c@10: namespace vampipe {
c@19: 
c@60: /**
c@60:  * Convert plugin pointers to handles within some scope defined by the
c@60:  * individual PluginHandleMapper implementation.
c@60:  *
c@60:  * The special handle 0 and the NULL plugin pointer are both used to
c@60:  * represent "not found" and will be returned in any case where an
c@60:  * unknown handle or plugin is requested.
c@60:  *
c@60:  * Note that the handle type must be representable as a JSON number,
c@60:  * hence the use of a 32-bit rather than 64-bit int.
c@60:  *
c@60:  * This interface also includes methods for obtaining a
c@60:  * PluginOutputIdMapper, \see PluginOutputIdMapper.
c@60:  */
c@60: 
c@10: class PluginHandleMapper
c@10: {
c@10: public:
c@51:     typedef int32_t Handle;
c@60:     const Handle INVALID_HANDLE = 0;
c@51: 
c@60:     virtual ~PluginHandleMapper() noexcept { }
c@51: 
c@60:     /**
c@60:      * Look up and return the handle for a given plugin pointer.
c@60:      * If the given pointer is null or not known, return INVALID_HANDLE.
c@60:      */
c@60:     virtual Handle pluginToHandle(Vamp::Plugin *) const noexcept = 0;
c@60: 
c@60:     /**
c@60:      * Look up and return the plugin for a given handle.
c@60:      * If the given handle is INVALID_HANDLE or not known, return nullptr.
c@60:      */
c@60:     virtual Vamp::Plugin *handleToPlugin(Handle)  const noexcept = 0;
c@60: 
c@60:     /**
c@60:      * Return a shared pointer to a PluginOutputIdMapper
c@60:      * implementation for the given plugin pointer.  If the given
c@60:      * pointer is null or not known, return the null shared_ptr.
c@60:      */
c@57:     virtual const std::shared_ptr<PluginOutputIdMapper> pluginToOutputIdMapper
c@60:     (Vamp::Plugin *p) const noexcept = 0;
c@57: 
c@60:     /**
c@60:      * Return a shared pointer to a PluginOutputIdMapper
c@60:      * implementation for the given plugin handle.  If the given
c@60:      * handle is INVALID_HANDLE or not known, return the null shared_ptr.
c@60:      */
c@57:     virtual const std::shared_ptr<PluginOutputIdMapper> handleToOutputIdMapper
c@60:     (Handle h) const noexcept = 0;
c@10: };
c@19: 
c@10: }
c@10: 
c@10: #endif
c@10: