cannam@244: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@244: 
cannam@244: /*
cannam@244:     Piper C++
cannam@244: 
cannam@244:     An API for audio analysis and feature extraction plugins.
cannam@244: 
cannam@244:     Centre for Digital Music, Queen Mary, University of London.
cannam@244:     Copyright 2006-2017 Chris Cannam and QMUL.
cannam@244:   
cannam@244:     Permission is hereby granted, free of charge, to any person
cannam@244:     obtaining a copy of this software and associated documentation
cannam@244:     files (the "Software"), to deal in the Software without
cannam@244:     restriction, including without limitation the rights to use, copy,
cannam@244:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@244:     of the Software, and to permit persons to whom the Software is
cannam@244:     furnished to do so, subject to the following conditions:
cannam@244: 
cannam@244:     The above copyright notice and this permission notice shall be
cannam@244:     included in all copies or substantial portions of the Software.
cannam@244: 
cannam@244:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@244:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@244:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@244:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@244:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@244:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@244:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@244: 
cannam@244:     Except as contained in this notice, the names of the Centre for
cannam@244:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@244:     shall not be used in advertising or otherwise to promote the sale,
cannam@244:     use or other dealings in this Software without prior written
cannam@244:     authorization.
cannam@244: */
cannam@244: 
cannam@244: #ifndef PIPER_STATIC_OUTPUT_RDF_H
cannam@244: #define PIPER_STATIC_OUTPUT_RDF_H
cannam@244: 
cannam@244: #include "StaticOutputDescriptor.h"
cannam@244: 
cannam@244: #include <vamp-hostsdk/PluginLoader.h>
cannam@244: 
cannam@244: #include <sord/sord.h>
cannam@244: 
cannam@244: #include <mutex>
cannam@244: 
cannam@244: namespace piper_vamp {
cannam@244: 
cannam@244: //!!! todo: better (+ optional) error reporting; check whether file
cannam@244: //!!! exists before parsing it to avoid spurious error messages;
cannam@244: //!!! refactoring
cannam@244: 
cannam@244: class StaticOutputRdf
cannam@244: {
cannam@244: public:
cannam@244:     StaticOutputRdf() :
cannam@244:         m_world(sord_world_new())
cannam@244:     {}
cannam@244: 
cannam@244:     ~StaticOutputRdf() {
cannam@244:         sord_world_free(m_world);
cannam@244:     }
cannam@244:     
cannam@244:     StaticOutputInfo loadStaticOutputInfo(Vamp::HostExt::PluginLoader::PluginKey
cannam@244:                                           pluginKey) {
cannam@244: 
cannam@244:         StaticOutputInfo info;
cannam@244:         SordModel *model = sord_new(m_world, SORD_SPO|SORD_OPS|SORD_POS, false);
cannam@244:         if (loadRdf(model, candidateRdfFilesFor(pluginKey))) {
cannam@244:             loadStaticOutputInfoFromModel(model, pluginKey, info);
cannam@244:         }
cannam@244:         sord_free(model);
cannam@244:         return info;
cannam@244:     }
cannam@244: 
cannam@244: private:
cannam@244:     SordWorld *m_world;
cannam@244: 
cannam@244:     bool loadRdf(SordModel *targetModel, std::vector<std::string> filenames) {
cannam@244:         for (auto f: filenames) {
cannam@244:             if (loadRdfFile(targetModel, f)) {
cannam@244:                 return true;
cannam@244:             }
cannam@244:         }
cannam@244:         return false;
cannam@244:     }
cannam@244: 
cannam@244:     bool loadRdfFile(SordModel *targetModel, std::string filename) {
cannam@244:         std::string base = "file://" + filename;
cannam@244:         SerdURI bu;
cannam@244:         if (serd_uri_parse((const uint8_t *)base.c_str(), &bu) !=
cannam@244:             SERD_SUCCESS) {
cannam@244:             std::cerr << "Failed to parse base URI " << base << std::endl;
cannam@244:             return false;
cannam@244:         }
cannam@244:         SerdNode bn = serd_node_from_string(SERD_URI,
cannam@244:                                             (const uint8_t *)base.c_str());
cannam@244:         SerdEnv *env = serd_env_new(&bn);
cannam@244:         SerdReader *reader = sord_new_reader(targetModel, env, SERD_TURTLE, 0);
cannam@244:         SerdStatus rv = serd_reader_read_file
cannam@244:             (reader, (const uint8_t *)filename.c_str());
cannam@244:         bool success = (rv == SERD_SUCCESS);
cannam@244:         if (!success) {
cannam@244:             // We are asking Serd to parse the file without having
cannam@244:             // checked whether it actually exists or not (in order to
cannam@244:             // avoid duplicating ugly platform/encoding-specific stuff
cannam@244:             // in this file). So don't bleat if the file is simply not
cannam@244:             // found, but only if there's a real parse error
cannam@244:             if (rv != SERD_ERR_NOT_FOUND &&
cannam@244:                 rv != SERD_ERR_UNKNOWN) {
cannam@244:                 std::cerr << "Failed to import RDF from " << filename
cannam@244:                           << ": " << serd_strerror(rv) << std::endl;
cannam@244:             }
cannam@244:         }
cannam@244:         serd_reader_free(reader);
cannam@244:         serd_env_free(env);
cannam@244:         return success;
cannam@244:     }
cannam@244:     
cannam@244:     std::vector<std::string> candidateRdfFilesFor(Vamp::HostExt::
cannam@244:                                                   PluginLoader::PluginKey key) {
cannam@244: 
cannam@244:         std::string library = Vamp::HostExt::PluginLoader::getInstance()->
cannam@244:             getLibraryPathForPlugin(key);
cannam@244: 	
cannam@244:         auto li = library.rfind('.');
cannam@244:         if (li == std::string::npos) return {};
cannam@244:         auto withoutSuffix = library.substr(0, li);
cannam@244: 
cannam@244:         std::vector<std::string> suffixes { "n3", "N3", "ttl", "TTL" };
cannam@244:         std::vector<std::string> candidates;
cannam@244: 
cannam@244:         for (auto suffix : suffixes) {
cannam@244:             candidates.push_back(withoutSuffix + "." + suffix);
cannam@244:         }
cannam@244: 
cannam@244:         return candidates;
cannam@244:     }
cannam@244: 
cannam@244:     void
cannam@244:     loadStaticOutputInfoFromModel(SordModel *model,
cannam@244:                                   std::string pluginKey,
cannam@244:                                   StaticOutputInfo &info) {
cannam@244:         
cannam@244:         // we want to find a graph like
cannam@244:         //
cannam@244:         // :plugin a vamp:Plugin
cannam@244:         // :plugin vamp:identifier "pluginId"
cannam@244:         // :library vamp:available_plugin :plugin
cannam@244:         // :library vamp:identifier "libraryId"
cannam@244:         // :plugin vamp:output :output1
cannam@244:         // :plugin vamp:output :output2
cannam@244:         // :plugin vamp:output :output3
cannam@244:         // :output1 vamp:computes_event_type :event
cannam@244:         // :output2 vamp:computes_feature :feature
cannam@244:         // :output3 vamp:computes_signal_type :signal
cannam@244:         //
cannam@244:         // in which pluginKey == libraryId + ":" + pluginId
cannam@244:         
cannam@244:         std::string libraryId, pluginId;
cannam@259:         if (!decomposePluginKey(pluginKey, libraryId, pluginId)) {
cannam@259:             std::cerr << "Failed to decompose plugin key \"" << pluginKey
cannam@259:                       << "\"" << std::endl;
cannam@259:             return;
cannam@259:         }
cannam@244: 
cannam@244:         typedef const uint8_t *S;
cannam@244:         
cannam@244:         SordNode *a = sord_new_uri
cannam@244:             (m_world, S("http://www.w3.org/1999/02/22-rdf-syntax-ns#type"));
cannam@244: 
cannam@244:         SordNode *pluginType = sord_new_uri
cannam@244:             (m_world, S("http://purl.org/ontology/vamp/Plugin"));
cannam@244: 
cannam@244:         SordNode *identProp = sord_new_uri
cannam@244:             (m_world, S("http://purl.org/ontology/vamp/identifier"));
cannam@244:         SordNode *availProp = sord_new_uri
cannam@244:             (m_world, S("http://purl.org/ontology/vamp/available_plugin"));
cannam@244:         SordNode *outputProp = sord_new_uri
cannam@244:             (m_world, S("http://purl.org/ontology/vamp/output"));
cannam@244: 
cannam@244:         SordNode *computesEventProp = sord_new_uri
cannam@244:             (m_world, S("http://purl.org/ontology/vamp/computes_event_type"));
cannam@244:         SordNode *computesFeatureProp = sord_new_uri
cannam@244:             (m_world, S("http://purl.org/ontology/vamp/computes_feature"));
cannam@244:         SordNode *computesSignalProp = sord_new_uri
cannam@244:             (m_world, S("http://purl.org/ontology/vamp/computes_signal_type"));
cannam@244: 
cannam@244:         SordIter *pluginItr = 0;
cannam@244: 
cannam@244:         for (pluginItr = sord_search(model, 0, a, pluginType, 0);
cannam@244:              !sord_iter_end(pluginItr);
cannam@244:              sord_iter_next(pluginItr)) {
cannam@244: 
cannam@244:             const SordNode *pluginNode =
cannam@244:                 sord_iter_get_node(pluginItr, SORD_SUBJECT);
cannam@244: 
cannam@244:             SordNode *pluginIdNode =
cannam@244:                 sord_get(model, pluginNode, identProp, 0, 0);
cannam@244: 
cannam@244:             if (!pluginIdNode ||
cannam@244:                 sord_node_get_type(pluginIdNode) != SORD_LITERAL ||
cannam@244:                 (const char *)sord_node_get_string(pluginIdNode) != pluginId) {
cannam@244:                 // This is a plugin node, but it's not the plugin node
cannam@244:                 // we're looking for. (We have to check both the type
cannam@244:                 // property, vamp:Plugin, and the identifier,
cannam@244:                 // vamp:identifier, because the identifier is just a
cannam@244:                 // string and it's possible it could be used for an
cannam@244:                 // output or parameter rather than just a plugin.)
cannam@244:                 continue;
cannam@244:             }
cannam@244:             
cannam@244:             SordNode *libraryNode =
cannam@244:                 sord_get(model, 0, availProp, pluginNode, 0);
cannam@244: 
cannam@244:             if (!libraryNode) {
cannam@244:                 std::cerr << "Plugin is not listed as being in a library, "
cannam@244:                           << "skipping library id check" << std::endl;
cannam@244:             } else {
cannam@244:                 SordNode *libIdNode =
cannam@244:                     sord_get(model, libraryNode, identProp, 0, 0);
cannam@244:                 if (!libIdNode ||
cannam@244:                     sord_node_get_type(libIdNode) != SORD_LITERAL ||
cannam@244:                     (const char *)sord_node_get_string(libIdNode) != libraryId) {
cannam@244:                     std::cerr << "Ignoring plugin in wrong library" << std::endl;
cannam@244:                     continue;
cannam@244:                 }
cannam@244:             }
cannam@244: 
cannam@244:             SordIter *outputItr = 0;
cannam@244: 
cannam@244:             for (outputItr = sord_search(model, pluginNode, outputProp, 0, 0);
cannam@244:                  !sord_iter_end(outputItr);
cannam@244:                  sord_iter_next(outputItr)) {
cannam@244: 
cannam@244:                 const SordNode *outputNode =
cannam@244:                     sord_iter_get_node(outputItr, SORD_OBJECT);
cannam@244: 
cannam@244:                 SordNode *outputIdNode =
cannam@244:                     sord_get(model, outputNode, identProp, 0, 0);
cannam@244: 
cannam@244:                 if (!outputIdNode ||
cannam@244:                     sord_node_get_type(outputIdNode) != SORD_LITERAL ||
cannam@244:                     !sord_node_get_string(outputIdNode)) {
cannam@244:                     std::cerr << "Ignoring output with no id" << std::endl;
cannam@244:                     continue;
cannam@244:                 }
cannam@244: 
cannam@244:                 std::string outputId =
cannam@244:                     (const char *)sord_node_get_string(outputIdNode);
cannam@244: 
cannam@244:                 SordIter *propItr = 0;
cannam@244: 
cannam@244:                 for (propItr = sord_search(model, outputNode, 0, 0, 0);
cannam@244:                      !sord_iter_end(propItr);
cannam@244:                      sord_iter_next(propItr)) {
cannam@244: 
cannam@244:                     const SordNode *propNode =
cannam@244:                         sord_iter_get_node(propItr, SORD_PREDICATE);
cannam@244: 
cannam@244:                     if (sord_node_equals(propNode, computesEventProp) ||
cannam@244:                         sord_node_equals(propNode, computesFeatureProp) ||
cannam@244:                         sord_node_equals(propNode, computesSignalProp)) {
cannam@244: 
cannam@244:                         const SordNode *computesNode =
cannam@244:                             sord_iter_get_node(propItr, SORD_OBJECT);
cannam@244: 
cannam@244:                         if (sord_node_get_type(computesNode) != SORD_URI ||
cannam@244:                             !sord_node_get_string(computesNode)) {
cannam@244:                             std::cerr << "Ignoring non-URI computes node"
cannam@244:                                       << std::endl;
cannam@244:                             continue;
cannam@244:                         }
cannam@244: 
cannam@244:                         std::string typeURI =
cannam@244:                             (const char *)sord_node_get_string(computesNode);
cannam@244: 
cannam@244:                         std::cerr << "Found type <" << typeURI
cannam@244:                                   << "> for output \"" << outputId
cannam@244:                                   << "\" of plugin \"" << pluginId
cannam@244:                                   << "\" in library " << libraryId
cannam@244:                                   << std::endl;
cannam@244:                         
cannam@244:                         StaticOutputDescriptor desc;
cannam@244:                         desc.typeURI = typeURI;
cannam@244:                         info[outputId] = desc;
cannam@244: 
cannam@244:                         break; // only interested in one "computes" property
cannam@244:                     }
cannam@244:                 }
cannam@244:                         
cannam@244:                 sord_iter_free(propItr);
cannam@244:             }
cannam@244: 
cannam@244:             sord_iter_free(outputItr);
cannam@244:         }
cannam@244:             
cannam@244:         sord_iter_free(pluginItr);
cannam@244:     }
cannam@244: 
cannam@244:     bool decomposePluginKey(std::string pluginKey,
cannam@244:                             std::string &libraryId,
cannam@244:                             std::string &pluginId) {
cannam@244:         auto i = pluginKey.find(':');
cannam@244:         if (i == std::string::npos || i == 0 || i + 1 == pluginKey.length()) {
cannam@244:             return false;
cannam@244:         }
cannam@244:         libraryId = pluginKey.substr(0, i);
cannam@244:         pluginId = pluginKey.substr(i + 1);
cannam@244:         return true;
cannam@244:     }
cannam@244: };
cannam@244: 
cannam@244: }
cannam@244: 
cannam@244: #endif