/* This file is part of Ingen. * Copyright (C) 2007-2011 David Robillard * * Ingen is free software; you can redistribute it and/or modify it under the * terms of the GNU General Public License as published by the Free Software * Foundation; either version 2 of the License, or (at your option) any later * version. * * Ingen is distributed in the hope that it will be useful, but WITHOUT ANY * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS * FOR A PARTICULAR PURPOSE. See the GNU General Public License for details. * * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ #include #include #include #include #include #include #include #include "raul/Atom.hpp" #include "raul/AtomRDF.hpp" #include "raul/TableImpl.hpp" #include "raul/log.hpp" #include "serd/serd.h" #include "sord/sordmm.hpp" #include "interface/EngineInterface.hpp" #include "module/World.hpp" #include "shared/LV2URIMap.hpp" #include "Parser.hpp" #include "names.hpp" #define LOG(s) s << "[Parser] " #define NS_INGEN "http://drobilla.net/ns/ingen#" #define NS_LV2 "http://lv2plug.in/ns/lv2core#" #define NS_RDF "http://www.w3.org/1999/02/22-rdf-syntax-ns#" #define NS_RDFS "http://www.w3.org/2000/01/rdf-schema#" using namespace std; using namespace Raul; using namespace Ingen::Shared; static const Sord::Node nil; typedef set RDFNodes; namespace Ingen { namespace Serialisation { static Glib::ustring relative_uri(Glib::ustring base, const Glib::ustring uri, bool leading_slash) { if (uri == base) { return leading_slash ? "/" : ""; } SerdURI base_uri; serd_uri_parse((const uint8_t*)base.c_str(), &base_uri); SerdURI normal_base_uri; SerdNode normal_base_uri_node = serd_node_new_uri_from_string( (const uint8_t*)".", &base_uri, &normal_base_uri); Glib::ustring normal_base_str((const char*)normal_base_uri_node.buf); Glib::ustring ret = uri; if (uri.length() >= normal_base_str.length() && uri.substr(0, normal_base_str.length()) == normal_base_str) { ret = uri.substr(normal_base_str.length()); if (leading_slash && ret[0] != '/') ret = Glib::ustring("/") + ret; } return ret; } Parser::PatchRecords Parser::find_patches(Ingen::Shared::World* world, const Glib::ustring& manifest_uri) { Sord::Model model(*world->rdf_world(), manifest_uri); model.load_file(manifest_uri); Sord::URI rdf_type(*world->rdf_world(), NS_RDF "type"); Sord::URI rdfs_seeAlso(*world->rdf_world(), NS_RDFS "seeAlso"); Sord::URI ingen_Patch(*world->rdf_world(), NS_INGEN "Patch"); std::list records; for (Sord::Iter i = model.find(nil, rdf_type, ingen_Patch); !i.end(); ++i) { const Sord::Node patch = i.get_subject(); Sord::Iter f = model.find(patch, rdfs_seeAlso, nil); if (!f.end()) { records.push_back(PatchRecord(patch.to_c_string(), f.get_object().to_c_string())); } else { LOG(error) << "Patch has no rdfs:seeAlso" << endl; } } return records; } /** Parse a patch from RDF into a CommonInterface (engine or client). * @return whether or not load was successful. */ bool Parser::parse_file(Ingen::Shared::World* world, Ingen::Shared::CommonInterface* target, Glib::ustring file_uri, boost::optional parent, boost::optional symbol, boost::optional data) { const size_t colon = file_uri.find(":"); if (colon != Glib::ustring::npos) { const Glib::ustring scheme = file_uri.substr(0, colon); if (scheme != "file") { LOG(error) << (boost::format("Unsupported URI scheme `%1%'") % scheme) << endl; return false; } } else { file_uri = Glib::ustring("file://") + file_uri; } if (file_uri.substr(file_uri.length() - 4) != ".ttl") { // Not a Turtle file, try to open it as a bundle if (file_uri[file_uri.length() - 1] != '/') { file_uri.append("/"); } Parser::PatchRecords records = find_patches(world, file_uri + "manifest.ttl"); if (!records.empty()) { file_uri = records.front().file_uri; } } // Load patch file into model Sord::Model model(*world->rdf_world(), file_uri); model.load_file(file_uri); LOG(info) << "Parsing " << file_uri << endl; if (parent) LOG(info) << "Parent: " << *parent << endl; if (symbol) LOG(info) << "Symbol: " << *symbol << endl; boost::optional parsed_path = parse(world, target, model, file_uri, Path("/"), parent, symbol, data); if (parsed_path) { target->set_property(*parsed_path, "http://drobilla.net/ns/ingen#document", Atom(Atom::URI, file_uri.c_str())); } else { LOG(warn) << "Document URI lost" << endl; } return parsed_path; } bool Parser::parse_string(Ingen::Shared::World* world, Ingen::Shared::CommonInterface* target, const Glib::ustring& str, const Glib::ustring& base_uri, boost::optional parent, boost::optional symbol, boost::optional data) { // Load string into model Sord::Model model(*world->rdf_world(), base_uri); model.load_string(str.c_str(), str.length(), base_uri); LOG(info) << "Parsing string"; if (!base_uri.empty()) info << " (base " << base_uri << ")"; info << endl; boost::optional data_path; bool ret = parse(world, target, model, base_uri, data_path, parent, symbol, data); Sord::URI subject(*world->rdf_world(), base_uri); parse_connections(world, target, model, subject, parent ? *parent : "/"); return ret; } boost::optional Parser::parse(Ingen::Shared::World* world, Ingen::Shared::CommonInterface* target, Sord::Model& model, Glib::ustring document_uri, boost::optional data_path, boost::optional parent, boost::optional symbol, boost::optional data) { const Sord::URI rdf_type (*world->rdf_world(), NS_RDF "type"); const Sord::URI patch_class (*world->rdf_world(), NS_INGEN "Patch"); const Sord::URI node_class (*world->rdf_world(), NS_INGEN "URI"); const Sord::URI internal_class (*world->rdf_world(), NS_INGEN "Internal"); const Sord::URI in_port_class (*world->rdf_world(), NS_LV2 "InputPort"); const Sord::URI out_port_class (*world->rdf_world(), NS_LV2 "OutputPort"); const Sord::URI lv2_class (*world->rdf_world(), NS_LV2 "Plugin"); Sord::Node subject = nil; if (data_path && data_path->is_root()) { subject = model.base_uri(); } else if (data_path) { subject = Sord::URI(*world->rdf_world(), data_path->chop_start("/")); } else { subject = nil; } Raul::Path path("/"); if (data_path) { path = *data_path; } else if (parent && symbol) { path = parent->child(*symbol); } boost::optional ret; boost::optional root_path; for (Sord::Iter i = model.find(subject, rdf_type, nil); !i.end(); ++i) { const Sord::Node& subject = i.get_subject(); const Sord::Node& rdf_class = i.get_object(); if (rdf_class == patch_class) { ret = parse_patch(world, target, model, subject, parent, symbol, data); } else if (rdf_class == node_class) { ret = parse_node(world, target, model, subject, path, data); } else if (rdf_class == in_port_class || rdf_class == out_port_class) { parse_properties(world, target, model, subject, path, data); ret = path; } if (!ret) { LOG(error) << "Failed to parse object " << path << endl; return boost::optional(); } if (data_path && subject.to_string() == data_path->str()) { root_path = ret; } } return path; } boost::optional Parser::parse_patch(Ingen::Shared::World* world, Ingen::Shared::CommonInterface* target, Sord::Model& model, const Sord::Node& subject_node, boost::optional parent, boost::optional a_symbol, boost::optional data) { const LV2URIMap& uris = *world->uris().get(); Sord::URI ingen_polyphony(*world->rdf_world(), NS_INGEN "polyphony"); Sord::URI lv2_port(*world->rdf_world(), NS_LV2 "port"); Sord::URI lv2_symbol(*world->rdf_world(), NS_LV2 "symbol"); const Sord::Node& patch = subject_node; uint32_t patch_poly = 0; /* Use parameter overridden polyphony, if given */ if (data) { GraphObject::Properties::iterator poly_param = data.get().find(uris.ingen_polyphony); if (poly_param != data.get().end() && poly_param->second.type() == Atom::INT) patch_poly = poly_param->second.get_int32(); } /* Load polyphony from file if necessary */ if (patch_poly == 0) { Sord::Iter i = model.find(subject_node, ingen_polyphony, nil); if (!i.end()) { const Sord::Node& poly_node = i.get_object(); if (poly_node.is_int()) patch_poly = poly_node.to_int(); else LOG(warn) << "Patch has non-integer polyphony, assuming 1" << endl; } } /* No polyphony found anywhere, use 1 */ if (patch_poly == 0) patch_poly = 1; const Glib::ustring base_uri = model.base_uri().to_string(); Raul::Symbol symbol = "_"; if (a_symbol) { symbol = *a_symbol; } else { const std::string basename = Glib::path_get_basename(base_uri); symbol = Raul::Symbol::symbolify(basename.substr(0, basename.find('.'))); } string patch_path_str = relative_uri(base_uri, subject_node.to_string(), true); if (parent && a_symbol) patch_path_str = parent->child(*a_symbol).str(); if (!Path::is_valid(patch_path_str)) { LOG(error) << "Patch has invalid path: " << patch_path_str << endl; return boost::optional(); } /* Create patch */ Path patch_path(patch_path_str); Resource::Properties props; props.insert(make_pair(uris.rdf_type, Raul::URI(uris.ingen_Patch))); props.insert(make_pair(uris.ingen_polyphony, Raul::Atom(int32_t(patch_poly)))); target->put(patch_path, props); Sord::URI rdf_type(*world->rdf_world(), NS_RDF "type"); Sord::URI ingen_Patch(*world->rdf_world(), NS_INGEN "Patch"); Sord::URI ingen_node(*world->rdf_world(), NS_INGEN "node"); typedef multimap Properties; typedef map Resources; typedef map Objects; typedef map Types; Objects patch_nodes; Objects plugin_nodes; Resources resources; Types types; /* For each node in this patch */ typedef map Nodes; Nodes nodes; for (Sord::Iter n = model.find(subject_node, ingen_node, nil); !n.end(); ++n) { Sord::Node node = n.get_object(); /* Get all node properties */ Properties node_properties; for (Sord::Iter np = model.find(node, nil, nil); !np.end(); ++np) { const Sord::Node& predicate = np.get_predicate(); const Sord::Node& object = np.get_object(); if (!skip_property(predicate)) { node_properties.insert( make_pair(predicate.to_string(), AtomRDF::node_to_atom(model, object))); } } /* Create node */ const Path node_path = patch_path.child( relative_uri(base_uri, node.to_string(), false)); target->put(node_path, node_properties); /* For each port on this node */ for (Sord::Iter p = model.find(node, lv2_port, nil); !p.end(); ++p) { Sord::Node port = p.get_object(); /* Get all port properties */ Properties port_properties; for (Sord::Iter pp = model.find(port, nil, nil); !pp.end(); ++pp) { const Sord::Node& predicate = pp.get_predicate(); const Sord::Node& object = pp.get_object(); if (!skip_property(predicate)) { port_properties.insert( make_pair(predicate.to_string(), AtomRDF::node_to_atom(model, object))); } } /* Set port properties */ Properties::const_iterator s = port_properties.find(uris.lv2_symbol); if (s == port_properties.end()) { LOG(error) << "Port on " << node_path << " has no symbol" << endl; return boost::optional(); } const Symbol port_sym = s->second.get_string(); const Path port_path = node_path.child(port_sym); target->put(port_path, port_properties); } } /* For each port on this patch */ for (Sord::Iter p = model.find(patch, lv2_port, nil); !p.end(); ++p) { Sord::Node port = p.get_object(); /* Get all port properties */ Properties port_properties; for (Sord::Iter pp = model.find(port, nil, nil); !pp.end(); ++pp) { const Sord::Node& predicate = pp.get_predicate(); const Sord::Node& object = pp.get_object(); if (!skip_property(predicate)) { port_properties.insert( make_pair(predicate.to_string(), AtomRDF::node_to_atom(model, object))); } } /* Set port properties */ Properties::const_iterator s = port_properties.find(uris.lv2_symbol); if (s == port_properties.end()) { LOG(error) << "Port on " << patch_path << " has no symbol" << endl; return boost::optional(); } const Symbol port_sym = s->second.get_string(); const Path port_path = patch_path.child(port_sym); target->put(port_path, port_properties); } parse_properties(world, target, model, subject_node, patch_path, data); parse_connections(world, target, model, subject_node, patch_path); cerr << "FIXME: enable patch" << endl; target->set_property(patch_path, uris.ingen_enabled, (bool)true); #if 0 /* Enable */ query = Sord::Query(*world->rdf_world(), Glib::ustring( "SELECT DISTINCT ?enabled WHERE {\n") + subject + " ingen:enabled ?enabled .\n" "}"); results = query.run(*world->rdf_world(), model, base_uri); for (; !results->finished(); results->next()) { Glib::Mutex::Lock lock(world->rdf_world()->mutex()); const Sord::Node& enabled_node = results->get("enabled"); if (enabled_node.is_bool() && enabled_node) { target->set_property(patch_path, uris.ingen_enabled, (bool)true); break; } else { LOG(warn) << "Unknown type for ingen:enabled" << endl; } } #endif return patch_path; } boost::optional Parser::parse_node(Ingen::Shared::World* world, Ingen::Shared::CommonInterface* target, Sord::Model& model, const Sord::Node& subject, const Raul::Path& path, boost::optional data) { const LV2URIMap& uris = *world->uris().get(); Sord::URI rdf_instanceOf(*world->rdf_world(), NS_RDF "instanceOf"); /* Get plugin */ Sord::Iter i = model.find(subject, rdf_instanceOf, nil); if (i.end()) { LOG(error) << "Node missing mandatory rdf:instanceOf property" << endl; return boost::optional(); } const Sord::Node& plugin_node = i.get_object(); if (plugin_node.type() != Sord::Node::URI) { LOG(error) << "Node's rdf:instanceOf property is not a resource" << endl; return boost::optional(); } Resource::Properties props; props.insert(make_pair(uris.rdf_type, Raul::URI(uris.ingen_Node))); props.insert(make_pair(uris.rdf_instanceOf, AtomRDF::node_to_atom(model, plugin_node))); target->put(path, props); parse_properties(world, target, model, subject, path, data); return path; } bool Parser::parse_connections(Ingen::Shared::World* world, Ingen::Shared::CommonInterface* target, Sord::Model& model, const Sord::Node& subject, const Raul::Path& parent) { Sord::URI ingen_connection(*world->rdf_world(), NS_INGEN "connection"); Sord::URI ingen_source(*world->rdf_world(), NS_INGEN "source"); Sord::URI ingen_destination(*world->rdf_world(), NS_INGEN "destination"); const Glib::ustring& base_uri = model.base_uri().to_string(); RDFNodes connections; for (Sord::Iter i = model.find(subject, ingen_connection, nil); !i.end(); ++i) { connections.insert(i.get_object()); } for (RDFNodes::const_iterator i = connections.begin(); i != connections.end(); ++i) { Sord::Iter s = model.find(*i, ingen_source, nil); Sord::Iter d = model.find(*i, ingen_destination, nil); if (s.end()) { LOG(error) << "Connection has no source" << endl; return false; } else if (d.end()) { LOG(error) << "Connection has no destination" << endl; return false; } const Path src_path( parent.child(relative_uri(base_uri, s.get_object().to_string(), false))); const Path dst_path( parent.child(relative_uri(base_uri, d.get_object().to_string(), false))); if (!(++s).end()) { LOG(error) << "Connection has multiple sources" << endl; return false; } else if (!(++d).end()) { LOG(error) << "Connection has multiple destinations" << endl; return false; } target->connect(src_path, dst_path); } return true; } bool Parser::parse_properties(Ingen::Shared::World* world, Ingen::Shared::CommonInterface* target, Sord::Model& model, const Sord::Node& subject, const Raul::URI& uri, boost::optional data) { Resource::Properties properties; for (Sord::Iter i = model.find(subject, nil, nil); !i.end(); ++i) { const Sord::Node& key = i.get_predicate(); const Sord::Node& val = i.get_object(); if (!skip_property(key)) { properties.insert(make_pair(key.to_string(), AtomRDF::node_to_atom(model, val))); } } target->put(uri, properties); // Set passed properties last to override any loaded values if (data) target->put(uri, data.get()); return true; } bool Parser::skip_property(const Sord::Node& predicate) { return (predicate.to_string() == "http://drobilla.net/ns/ingen#node" || predicate.to_string() == "http://lv2plug.in/ns/lv2core#port"); } } // namespace Serialisation } // namespace Ingen