/*
This file is part of Ingen.
Copyright 2007-2012 David Robillard
Ingen is free software: you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or 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 Affero General Public License for details.
You should have received a copy of the GNU Affero General Public License
along with Ingen. If not, see .
*/
#include
#include
#include
#include "ingen/EngineBase.hpp"
#include "ingen/Interface.hpp"
#include "ingen/shared/Configuration.hpp"
#include "ingen/shared/LV2Features.hpp"
#include "ingen/shared/Module.hpp"
#include "ingen/shared/URIMap.hpp"
#include "ingen/shared/URIs.hpp"
#include "ingen/shared/World.hpp"
#include "ingen/shared/runtime_paths.hpp"
#include "lilv/lilv.h"
#include "raul/Atom.hpp"
#include "raul/log.hpp"
#include "sord/sordmm.hpp"
#define LOG(s) (s("[World] "))
using namespace std;
namespace Ingen {
namespace Shared {
/** Load a dynamic module from the default path.
*
* This will check in the directories specified in the environment variable
* INGEN_MODULE_PATH (typical colon delimited format), then the default module
* installation directory (ie /usr/local/lib/ingen), in that order.
*
* \param name The base name of the module, e.g. "ingen_serialisation"
*/
static SharedPtr
ingen_load_module(const string& name)
{
Glib::Module* module = NULL;
// Search INGEN_MODULE_PATH first
bool module_path_found;
string module_path = Glib::getenv("INGEN_MODULE_PATH", module_path_found);
if (module_path_found) {
string dir;
istringstream iss(module_path);
while (getline(iss, dir, ':')) {
string filename = Shared::module_path(name, dir);
if (Glib::file_test(filename, Glib::FILE_TEST_EXISTS)) {
module = new Glib::Module(filename, Glib::MODULE_BIND_LAZY);
if (*module) {
LOG(Raul::info)(Raul::fmt("Loading %1%\n") % filename);
return SharedPtr(module);
} else {
delete module;
Raul::error << Glib::Module::get_last_error() << endl;
}
}
}
}
// Try default directory if not found
module = new Glib::Module(Shared::module_path(name), Glib::MODULE_BIND_LAZY);
// FIXME: SEGV on exit without this
module->make_resident();
if (*module) {
LOG(Raul::info)(Raul::fmt("Loading %1%\n") % Shared::module_path(name));
return SharedPtr(module);
} else if (!module_path_found) {
LOG(Raul::error)(Raul::fmt("Unable to find %1% (%2%)\n")
% name % Glib::Module::get_last_error());
return SharedPtr();
} else {
LOG(Raul::error)(Raul::fmt("Unable to load %1% from %2% (%3%)\n")
% name % module_path % Glib::Module::get_last_error());
LOG(Raul::error)("Is Ingen installed?\n");
return SharedPtr();
}
}
class World::Impl {
public:
Impl(int& a_argc,
char**& a_argv,
LV2_URID_Map* map,
LV2_URID_Unmap* unmap)
: argc(a_argc)
, argv(a_argv)
, lv2_features(NULL)
, rdf_world(new Sord::World())
, uri_map(new Ingen::Shared::URIMap(map, unmap))
, forge(new Ingen::Forge(*uri_map))
, uris(new Shared::URIs(*forge, uri_map))
, lilv_world(lilv_world_new())
{
conf.parse(argc, argv);
lv2_features = new Ingen::Shared::LV2Features();
lv2_features->add_feature(uri_map->urid_map_feature());
lv2_features->add_feature(uri_map->urid_unmap_feature());
lilv_world_load_all(lilv_world);
// Set up RDF namespaces
rdf_world->add_prefix("atom", "http://lv2plug.in/ns/ext/atom#");
rdf_world->add_prefix("patch", "http://lv2plug.in/ns/ext/patch#");
rdf_world->add_prefix("doap", "http://usefulinc.com/ns/doap#");
rdf_world->add_prefix("ingen", "http://drobilla.net/ns/ingen#");
rdf_world->add_prefix("lv2", "http://lv2plug.in/ns/lv2core#");
rdf_world->add_prefix("lv2ev", "http://lv2plug.in/ns/ext/event#");
rdf_world->add_prefix("midi", "http://lv2plug.in/ns/ext/midi#");
rdf_world->add_prefix("owl", "http://www.w3.org/2002/07/owl#");
rdf_world->add_prefix("rdfs", "http://www.w3.org/2000/01/rdf-schema#");
rdf_world->add_prefix("xsd", "http://www.w3.org/2001/XMLSchema#");
}
virtual ~Impl()
{
serialiser.reset();
parser.reset();
engine.reset();
store.reset();
modules.clear();
interface_factories.clear();
script_runners.clear();
lilv_world_free(lilv_world);
delete rdf_world;
delete lv2_features;
delete uris;
delete forge;
delete uri_map;
}
typedef std::map< const std::string, SharedPtr > Modules;
Modules modules;
typedef std::map InterfaceFactories;
InterfaceFactories interface_factories;
typedef bool (*ScriptRunner)(World* world, const char* filename);
typedef std::map ScriptRunners;
ScriptRunners script_runners;
int& argc;
char**& argv;
Shared::Configuration conf;
LV2Features* lv2_features;
Sord::World* rdf_world;
URIMap* uri_map;
Ingen::Forge* forge;
URIs* uris;
SharedPtr interface;
SharedPtr engine;
SharedPtr serialiser;
SharedPtr parser;
SharedPtr store;
LilvWorld* lilv_world;
std::string jack_uuid;
};
World::World(int& argc,
char**& argv,
LV2_URID_Map* map,
LV2_URID_Unmap* unmap)
: _impl(new Impl(argc, argv, map, unmap))
{
}
World::~World()
{
unload_modules();
delete _impl;
}
void World::set_engine(SharedPtr e) { _impl->engine = e; }
void World::set_interface(SharedPtr i) { _impl->interface = i; }
void World::set_parser(SharedPtr p) { _impl->parser = p; }
void World::set_serialiser(SharedPtr s) { _impl->serialiser = s; }
void World::set_store(SharedPtr s) { _impl->store = s; }
SharedPtr World::engine() { return _impl->engine; }
SharedPtr World::interface() { return _impl->interface; }
SharedPtr World::parser() { return _impl->parser; }
SharedPtr World::serialiser() { return _impl->serialiser; }
SharedPtr World::store() { return _impl->store; }
int& World::argc() { return _impl->argc; }
char**& World::argv() { return _impl->argv; }
Shared::Configuration& World::conf() { return _impl->conf; }
Sord::World* World::rdf_world() { return _impl->rdf_world; }
LilvWorld* World::lilv_world() { return _impl->lilv_world; }
LV2Features& World::lv2_features() { return *_impl->lv2_features; }
Ingen::Forge& World::forge() { return *_impl->forge; }
URIs& World::uris() { return *_impl->uris; }
URIMap& World::uri_map() { return *_impl->uri_map; }
bool
World::load_module(const char* name)
{
Impl::Modules::iterator i = _impl->modules.find(name);
if (i != _impl->modules.end()) {
LOG(Raul::info)(Raul::fmt("Module `%1%' already loaded\n") % name);
return true;
}
SharedPtr lib = ingen_load_module(name);
Ingen::Shared::Module* (*module_load)() = NULL;
if (lib && lib->get_symbol("ingen_module_load", (void*&)module_load)) {
Module* module = module_load();
module->library = lib;
module->load(this);
_impl->modules.insert(make_pair(string(name), module));
return true;
} else {
LOG(Raul::error)(Raul::fmt("Failed to load module `%1%'\n") % name);
return false;
}
}
bool
World::run_module(const char* name)
{
Impl::Modules::iterator i = _impl->modules.find(name);
if (i == _impl->modules.end()) {
LOG(Raul::error) << "Attempt to run unloaded module `" << name << "'" << endl;
return false;
}
i->second->run(this);
return true;
}
void
World::unload_modules()
{
_impl->modules.clear();
}
/** Get an interface for a remote engine at @a url
*/
SharedPtr
World::new_interface(const std::string& engine_url,
SharedPtr respondee)
{
const string scheme = engine_url.substr(0, engine_url.find(":"));
const Impl::InterfaceFactories::const_iterator i = _impl->interface_factories.find(scheme);
if (i == _impl->interface_factories.end()) {
Raul::warn << "Unknown URI scheme `" << scheme << "'" << endl;
return SharedPtr();
}
return i->second(this, engine_url, respondee);
}
/** Run a script of type @a mime_type at filename @a filename */
bool
World::run(const std::string& mime_type, const std::string& filename)
{
const Impl::ScriptRunners::const_iterator i = _impl->script_runners.find(mime_type);
if (i == _impl->script_runners.end()) {
Raul::warn << "Unknown script MIME type `" << mime_type << "'" << endl;
return false;
}
return i->second(this, filename.c_str());
}
void
World::add_interface_factory(const std::string& scheme, InterfaceFactory factory)
{
_impl->interface_factories.insert(make_pair(scheme, factory));
}
void
World::set_jack_uuid(const std::string& uuid)
{
_impl->jack_uuid = uuid;
}
std::string
World::jack_uuid()
{
return _impl->jack_uuid;
}
} // namespace Shared
} // namespace Ingen