c@75: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
c@75: 
c@75: /*
c@75:     Piper C++
c@75: 
c@75:     Centre for Digital Music, Queen Mary, University of London.
c@75:     Copyright 2006-2016 Chris Cannam and QMUL.
c@75:   
c@75:     Permission is hereby granted, free of charge, to any person
c@75:     obtaining a copy of this software and associated documentation
c@75:     files (the "Software"), to deal in the Software without
c@75:     restriction, including without limitation the rights to use, copy,
c@75:     modify, merge, publish, distribute, sublicense, and/or sell copies
c@75:     of the Software, and to permit persons to whom the Software is
c@75:     furnished to do so, subject to the following conditions:
c@75: 
c@75:     The above copyright notice and this permission notice shall be
c@75:     included in all copies or substantial portions of the Software.
c@75: 
c@75:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
c@75:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
c@75:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
c@75:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
c@75:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
c@75:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
c@75:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
c@75: 
c@75:     Except as contained in this notice, the names of the Centre for
c@75:     Digital Music; Queen Mary, University of London; and Chris Cannam
c@75:     shall not be used in advertising or otherwise to promote the sale,
c@75:     use or other dealings in this Software without prior written
c@75:     authorization.
c@75: */
c@75: 
c@75: #ifndef PIPER_PLUGIN_ID_MAPPER_H
c@75: #define PIPER_PLUGIN_ID_MAPPER_H
c@75: 
c@75: #include <vamp-hostsdk/Plugin.h>
c@75: 
c@75: #include <map>
c@75: #include <string>
c@75: 
c@97: namespace piper_vamp {
c@75: 
cannam@265: /**
cannam@265:  * Interface for an object that maps between a plugin's output id (a
cannam@265:  * string) and output index (index of the output in the output list).
cannam@265:  */
c@75: class PluginOutputIdMapper
c@75: {
c@75: public:
c@75:     virtual ~PluginOutputIdMapper() { }
c@75: 
c@75:     /**
c@75:      * Return the index of the given output id in the plugin. The
c@75:      * first output has index 0. If the given output id is unknown,
c@75:      * return -1.
c@75:      */
c@75:     virtual int idToIndex(std::string outputId) const noexcept = 0;
c@75: 
c@75:     /**
c@75:      * Return the id of the output with the given index in the
c@75:      * plugin. If the index is out of range, return the empty string.
c@75:      */
c@75:     virtual std::string indexToId(int index) const noexcept = 0;
c@75: };
c@75: 
c@75: }
c@75: 
c@75: #endif