/*
This file is part of Ingen.
Copyright 2007-2016 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/Log.hpp"
#include "ingen/Store.hpp"
#include "ingen/URIs.hpp"
#include "raul/Maid.hpp"
#include "Broadcaster.hpp"
#include "ControlBindings.hpp"
#include "CreateBlock.hpp"
#include "CreateGraph.hpp"
#include "CreatePort.hpp"
#include "Delta.hpp"
#include "Engine.hpp"
#include "GraphImpl.hpp"
#include "PluginImpl.hpp"
#include "PortImpl.hpp"
#include "PortType.hpp"
#include "SetPortValue.hpp"
#include "events/Get.hpp"
namespace Ingen {
namespace Server {
namespace Events {
typedef Resource::Properties Properties;
Delta::Delta(Engine& engine,
SPtr client,
int32_t id,
SampleCount timestamp,
Type type,
Resource::Graph context,
const Raul::URI& subject,
const Properties& properties,
const Properties& remove)
: Event(engine, client, id, timestamp)
, _create_event(NULL)
, _subject(subject)
, _properties(properties)
, _remove(remove)
, _object(NULL)
, _graph(NULL)
, _compiled_graph(NULL)
, _state(NULL)
, _context(context)
, _type(type)
, _poly_lock(engine.store()->mutex(), std::defer_lock)
{
if (context != Resource::Graph::DEFAULT) {
for (auto& p : _properties) {
p.second.set_context(context);
}
}
}
Delta::~Delta()
{
for (auto& s : _set_events)
delete s;
delete _create_event;
}
void
Delta::add_set_event(const char* port_symbol,
const void* value,
uint32_t size,
uint32_t type)
{
BlockImpl* block = dynamic_cast(_object);
PortImpl* port = block->port_by_symbol(port_symbol);
if (!port) {
_engine.log().warn(fmt("Unknown port `%1%' in state") % port_symbol);
return;
}
SetPortValue* ev = new SetPortValue(
_engine, _request_client, _request_id, _time,
port, Atom(size, type, value), true);
ev->pre_process();
_set_events.push_back(ev);
}
static void
s_add_set_event(const char* port_symbol,
void* user_data,
const void* value,
uint32_t size,
uint32_t type)
{
((Delta*)user_data)->add_set_event(port_symbol, value, size, type);
}
static LilvNode*
get_file_node(LilvWorld* lworld, const URIs& uris, const Atom& value)
{
if (value.type() == uris.atom_Path) {
return lilv_new_file_uri(lworld, NULL, value.ptr());
} else if (uris.forge.is_uri(value)) {
const std::string str = uris.forge.str(value, false);
if (str.substr(0, 5) == "file:") {
return lilv_new_uri(lworld, value.ptr());
}
}
return NULL;
}
/** @page protocol
* @subsection loading Loading and Unloading Bundles
*
* The property ingen:loadedBundle on the engine can be used to load
* or unload bundles from Ingen's world. For example:
*
* @code{.ttl}
* # Load /old.lv2
* []
* a patch:Put ;
* patch:subject > ;
* patch:body [
* ingen:loadedBundle
* ] .
*
* # Replace /old.lv2 with /new.lv2
* []
* a patch:Patch ;
* patch:subject > ;
* patch:remove [
* ingen:loadedBundle
* ];
* patch:add [
* ingen:loadedBundle
* ] .
* @endcode
*/
bool
Delta::pre_process()
{
const Ingen::URIs& uris = _engine.world()->uris();
const bool is_graph_object = Node::uri_is_path(_subject);
const bool is_client = (_subject == "ingen:/clients/this");
const bool is_engine = (_subject == "ingen:/");
const bool is_file = (_subject.substr(0, 5) == "file:");
bool poly_changed = false;
if (_type == Type::PUT && is_file) {
// Ensure type is Preset, the only supported file put
const auto t = _properties.find(uris.rdf_type);
if (t == _properties.end() || t->second != uris.pset_Preset) {
return Event::pre_process_done(Status::BAD_REQUEST, _subject);
}
// Get "prototype" for preset (node to save state for)
const auto p = _properties.find(uris.lv2_prototype);
if (p == _properties.end()) {
return Event::pre_process_done(Status::BAD_REQUEST, _subject);
} else if (!_engine.world()->forge().is_uri(p->second)) {
return Event::pre_process_done(Status::BAD_REQUEST, _subject);
}
const Raul::URI prot(_engine.world()->forge().str(p->second, false));
if (!Node::uri_is_path(prot)) {
return Event::pre_process_done(Status::BAD_URI, _subject);
}
Node* node = _engine.store()->get(Node::uri_to_path(prot));
if (!node) {
return Event::pre_process_done(Status::NOT_FOUND, prot);
}
BlockImpl* block = dynamic_cast(node);
if (!block) {
return Event::pre_process_done(Status::BAD_OBJECT_TYPE, prot);
}
if ((_preset = block->save_preset(_subject, _properties))) {
return Event::pre_process_done(Status::SUCCESS);
} else {
return Event::pre_process_done(Status::FAILURE);
}
}
// Take a writer lock while we modify the store
std::unique_lock lock(_engine.store()->mutex());
_object = is_graph_object
? static_cast(_engine.store()->get(Node::uri_to_path(_subject)))
: static_cast(_engine.block_factory()->plugin(_subject));
if (!_object && !is_client && !is_engine &&
(!is_graph_object || _type != Type::PUT)) {
return Event::pre_process_done(Status::NOT_FOUND, _subject);
}
if (is_graph_object && !_object) {
Raul::Path path(Node::uri_to_path(_subject));
bool is_graph = false, is_block = false, is_port = false, is_output = false;
Ingen::Resource::type(uris, _properties, is_graph, is_block, is_port, is_output);
if (is_graph) {
_create_event = new CreateGraph(
_engine, _request_client, _request_id, _time, path, _properties);
} else if (is_block) {
_create_event = new CreateBlock(
_engine, _request_client, _request_id, _time, path, _properties);
} else if (is_port) {
_create_event = new CreatePort(
_engine, _request_client, _request_id, _time,
path, _properties);
}
if (_create_event) {
if (_create_event->pre_process()) {
_object = _engine.store()->get(path); // Get object for setting
} else {
return Event::pre_process_done(Status::CREATION_FAILED, _subject);
}
} else {
return Event::pre_process_done(Status::BAD_OBJECT_TYPE, _subject);
}
}
_types.reserve(_properties.size());
NodeImpl* obj = dynamic_cast(_object);
// Remove any properties removed in delta
for (const auto& r : _remove) {
const Raul::URI& key = r.first;
const Atom& value = r.second;
if (key == uris.midi_binding && value == uris.patch_wildcard) {
PortImpl* port = dynamic_cast(_object);
if (port)
_old_bindings = _engine.control_bindings()->remove(port);
}
if (_object) {
_removed.emplace(key, value);
_object->remove_property(key, value);
} else if (is_engine && key == uris.ingen_loadedBundle) {
LilvWorld* lworld = _engine.world()->lilv_world();
LilvNode* bundle = get_file_node(lworld, uris, value);
if (bundle) {
for (const auto& p : _engine.block_factory()->plugins()) {
if (p.second->bundle_uri() == lilv_node_as_string(bundle)) {
p.second->set_is_zombie(true);
_update.del(p.second->uri());
}
}
lilv_world_unload_bundle(lworld, bundle);
_engine.block_factory()->refresh();
lilv_node_free(bundle);
} else {
_status = Status::BAD_VALUE;
}
}
}
// Remove all added properties if this is a put or set
if (_object && (_type == Type::PUT || _type == Type::SET)) {
for (auto p = _properties.begin();
p != _properties.end();
p = _properties.upper_bound(p->first)) {
for (auto q = _object->properties().find(p->first);
q != _object->properties().end() && q->first == p->first;) {
auto next = q;
++next;
if (!_properties.contains(q->first, q->second)) {
const auto r = std::make_pair(q->first, q->second);
_object->properties().erase(q);
_object->on_property_removed(r.first, r.second);
_removed.insert(r);
}
q = next;
}
}
}
for (const auto& p : _properties) {
const Raul::URI& key = p.first;
const Resource::Property& value = p.second;
SpecialType op = SpecialType::NONE;
if (obj) {
Resource& resource = *obj;
if (value != uris.patch_wildcard) {
if (resource.add_property(key, value, value.context())) {
_added.emplace(key, value);
}
}
BlockImpl* block = NULL;
PortImpl* port = dynamic_cast(_object);
if (port) {
if (key == uris.ingen_broadcast) {
if (value.type() == uris.forge.Bool) {
op = SpecialType::ENABLE_BROADCAST;
} else {
_status = Status::BAD_VALUE_TYPE;
}
} else if (key == uris.ingen_value || key == uris.ingen_activity) {
SetPortValue* ev = new SetPortValue(
_engine, _request_client, _request_id, _time, port, value);
ev->pre_process();
_set_events.push_back(ev);
} else if (key == uris.midi_binding) {
if (port->is_a(PortType::CONTROL) || port->is_a(PortType::CV)) {
if (value == uris.patch_wildcard) {
_engine.control_bindings()->learn(port);
} else if (value.type() == uris.atom_Object) {
op = SpecialType::CONTROL_BINDING;
} else {
_status = Status::BAD_VALUE_TYPE;
}
} else {
_status = Status::BAD_OBJECT_TYPE;
}
}
} else if ((block = dynamic_cast(_object))) {
if (key == uris.midi_binding && value == uris.patch_wildcard) {
op = SpecialType::CONTROL_BINDING; // Internal block learn
} else if (key == uris.ingen_enabled) {
if (value.type() == uris.forge.Bool) {
op = SpecialType::ENABLE;
} else {
_status = Status::BAD_VALUE_TYPE;
}
} else if (key == uris.pset_preset) {
std::string uri_str;
if (uris.forge.is_uri(value)) {
uri_str = uris.forge.str(value, false);
} else if (value.type() == uris.forge.Path) {
uri_str = Glib::filename_to_uri(value.ptr());
}
if (Raul::URI::is_valid(uri_str)) {
const Raul::URI uri(uri_str);
op = SpecialType::PRESET;
if ((_state = block->load_preset(uri))) {
lilv_state_emit_port_values(
_state, s_add_set_event, this);
} else {
_engine.log().warn(fmt("Failed to load preset <%1%>\n") % uri);
}
} else {
_status = Status::BAD_VALUE;
}
}
}
if ((_graph = dynamic_cast(_object))) {
if (key == uris.ingen_enabled) {
if (value.type() == uris.forge.Bool) {
op = SpecialType::ENABLE;
// FIXME: defer this until all other metadata has been processed
if (value.get() && !_graph->enabled())
_compiled_graph = _graph->compile();
} else {
_status = Status::BAD_VALUE_TYPE;
}
} else if (key == uris.ingen_polyphony) {
if (value.type() == uris.forge.Int) {
if (value.get() < 1 || value.get() > 128) {
_status = Status::INVALID_POLY;
} else {
poly_changed = true;
op = SpecialType::POLYPHONY;
_graph->prepare_internal_poly(
*_engine.buffer_factory(), value.get());
}
} else {
_status = Status::BAD_VALUE_TYPE;
}
}
}
if (!_create_event && key == uris.ingen_polyphonic) {
GraphImpl* parent = dynamic_cast(obj->parent());
if (parent) {
if (value.type() == uris.forge.Bool) {
poly_changed = true;
op = SpecialType::POLYPHONIC;
obj->set_property(key, value, value.context());
BlockImpl* block = dynamic_cast(obj);
if (block)
block->set_polyphonic(value.get());
if (value.get()) {
obj->prepare_poly(*_engine.buffer_factory(), parent->internal_poly());
} else {
obj->prepare_poly(*_engine.buffer_factory(), 1);
}
} else {
_status = Status::BAD_VALUE_TYPE;
}
} else {
_status = Status::BAD_OBJECT_TYPE;
}
}
} else if (is_client && key == uris.ingen_broadcast) {
_engine.broadcaster()->set_broadcast(
_request_client, value.get());
} else if (is_engine && key == uris.ingen_loadedBundle) {
LilvWorld* lworld = _engine.world()->lilv_world();
LilvNode* bundle = get_file_node(lworld, uris, value);
if (bundle) {
lilv_world_load_bundle(lworld, bundle);
const std::set new_plugins =
_engine.block_factory()->refresh();
for (PluginImpl* p : new_plugins) {
if (p->bundle_uri() == lilv_node_as_string(bundle)) {
_update.put_plugin(p);
}
}
lilv_node_free(bundle);
} else {
_status = Status::BAD_VALUE;
}
}
if (_status != Status::NOT_PREPARED) {
break;
}
_types.push_back(op);
}
if (poly_changed) {
lock.unlock();
_poly_lock.lock();
}
return Event::pre_process_done(
_status == Status::NOT_PREPARED ? Status::SUCCESS : _status,
_subject);
}
void
Delta::execute(RunContext& context)
{
if (_status != Status::SUCCESS || _preset) {
return;
}
const Ingen::URIs& uris = _engine.world()->uris();
if (_create_event) {
_create_event->set_time(_time);
_create_event->execute(context);
}
for (auto& s : _set_events) {
s->set_time(_time);
s->execute(context);
}
NodeImpl* const object = dynamic_cast(_object);
BlockImpl* const block = dynamic_cast(_object);
PortImpl* const port = dynamic_cast(_object);
std::vector::const_iterator t = _types.begin();
for (const auto& p : _properties) {
const Raul::URI& key = p.first;
const Atom& value = p.second;
switch (*t++) {
case SpecialType::ENABLE_BROADCAST:
if (port) {
port->enable_monitoring(value.get());
}
break;
case SpecialType::ENABLE:
if (_graph) {
if (value.get()) {
if (_compiled_graph) {
_graph->set_compiled_graph(_compiled_graph);
}
_graph->enable();
} else {
_graph->disable(context);
}
} else if (block) {
block->set_enabled(value.get());
}
break;
case SpecialType::POLYPHONIC: {
GraphImpl* parent = reinterpret_cast(object->parent());
if (value.get()) {
object->apply_poly(
context, *_engine.maid(), parent->internal_poly_process());
} else {
object->apply_poly(context, *_engine.maid(), 1);
}
} break;
case SpecialType::POLYPHONY:
if (!_graph->apply_internal_poly(context,
*_engine.buffer_factory(),
*_engine.maid(),
value.get())) {
_status = Status::INTERNAL_ERROR;
}
break;
case SpecialType::CONTROL_BINDING:
if (port) {
_engine.control_bindings()->port_binding_changed(context, port, value);
} else if (block) {
if (uris.ingen_Internal == block->plugin_impl()->type()) {
block->learn();
}
}
break;
case SpecialType::PRESET:
block->set_enabled(false);
break;
case SpecialType::NONE:
if (port) {
if (key == uris.lv2_minimum) {
port->set_minimum(value);
} else if (key == uris.lv2_maximum) {
port->set_maximum(value);
}
}
case SpecialType::LOADED_BUNDLE:
break;
}
}
}
void
Delta::post_process()
{
if (_poly_lock.owns_lock()) {
_poly_lock.unlock();
}
if (_state) {
BlockImpl* block = dynamic_cast(_object);
if (block) {
block->apply_state(_engine.sync_worker(), _state);
block->set_enabled(true);
}
lilv_state_free(_state);
}
Broadcaster::Transfer t(*_engine.broadcaster());
if (_create_event) {
_create_event->post_process();
if (_create_event->status() != Status::SUCCESS) {
return; // Creation failed, nothing else to do
}
}
for (auto& s : _set_events) {
if (s->synthetic() || s->status() != Status::SUCCESS) {
s->post_process(); // Set failed, report error
}
}
if (respond() == Status::SUCCESS) {
_update.send(_engine.broadcaster());
switch (_type) {
case Type::SET:
/* Kludge to avoid feedback for set events only. The GUI
depends on put responses to e.g. initially place blocks.
Some more sensible way of controlling this is needed. */
if (_mode == Mode::NORMAL) {
_engine.broadcaster()->set_ignore_client(_request_client);
}
_engine.broadcaster()->set_property(
_subject,
_properties.begin()->first,
_properties.begin()->second);
if (_mode == Mode::NORMAL) {
_engine.broadcaster()->clear_ignore_client();
}
break;
case Type::PUT:
if (_type == Type::PUT && _subject.substr(0, 5) == "file:") {
// Preset save
ClientUpdate response;
response.put(_preset->uri(), _preset->properties());
response.send(_engine.broadcaster());
} else {
// Graph object put
_engine.broadcaster()->put(_subject, _properties, _context);
}
break;
case Type::PATCH:
_engine.broadcaster()->delta(_subject, _remove, _properties);
break;
}
}
}
void
Delta::undo(Interface& target)
{
if (_create_event) {
_create_event->undo(target);
} else if (_type == Type::PATCH) {
target.delta(_subject, _added, _removed);
} else if (_type == Type::SET || _type == Type::PUT) {
if (_removed.size() == 1) {
target.set_property(
_subject, _removed.begin()->first, _removed.begin()->second);
} else if (_removed.empty()) {
target.delta(_subject, _added, {});
} else {
target.put(_subject, _removed);
}
}
}
} // namespace Events
} // namespace Server
} // namespace Ingen