/*
This file is part of Ingen.
Copyright 2007-2015 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 "ingen_config.h"
#include
#include
#include "lv2/lv2plug.in/ns/ext/buf-size/buf-size.h"
#include "events/CreatePort.hpp"
#include "ingen/Configuration.hpp"
#include "ingen/Log.hpp"
#include "ingen/Store.hpp"
#include "ingen/URIs.hpp"
#include "ingen/World.hpp"
#include "ingen/types.hpp"
#include "raul/Maid.hpp"
#include "BlockFactory.hpp"
#include "Broadcaster.hpp"
#include "BufferFactory.hpp"
#include "ControlBindings.hpp"
#include "DirectDriver.hpp"
#include "Driver.hpp"
#include "Engine.hpp"
#include "Event.hpp"
#include "EventWriter.hpp"
#include "GraphImpl.hpp"
#include "LV2Options.hpp"
#include "PostProcessor.hpp"
#include "PreProcessor.hpp"
#include "ProcessContext.hpp"
#include "ThreadManager.hpp"
#include "Worker.hpp"
#ifdef HAVE_SOCKET
#include "SocketListener.hpp"
#endif
using namespace std;
namespace Ingen {
namespace Server {
Raul::ThreadVar ThreadManager::flags(0);
bool ThreadManager::single_threaded(true);
Engine::Engine(Ingen::World* world)
: _world(world)
, _block_factory(new BlockFactory(world))
, _broadcaster(new Broadcaster())
, _buffer_factory(new BufferFactory(*this, world->uris()))
, _control_bindings(NULL)
, _event_writer(new EventWriter(*this))
, _maid(new Raul::Maid())
, _options(new LV2Options(world->uris()))
, _pre_processor(new PreProcessor())
, _post_processor(new PostProcessor(*this))
, _root_graph(NULL)
, _worker(new Worker(world->log(), event_queue_size()))
, _listener(NULL)
, _process_context(*this)
, _rand_engine(0)
, _uniform_dist(0.0f, 1.0f)
, _quit_flag(false)
, _direct_driver(true)
{
if (!world->store()) {
world->set_store(SPtr(new Store()));
}
_control_bindings = new ControlBindings(*this);
_world->lv2_features().add_feature(_worker->schedule_feature());
_world->lv2_features().add_feature(_options);
_world->lv2_features().add_feature(
SPtr(
new LV2Features::EmptyFeature(LV2_BUF_SIZE__powerOf2BlockLength)));
_world->lv2_features().add_feature(
SPtr(
new LV2Features::EmptyFeature(LV2_BUF_SIZE__fixedBlockLength)));
_world->lv2_features().add_feature(
SPtr(
new LV2Features::EmptyFeature(LV2_BUF_SIZE__boundedBlockLength)));
}
Engine::~Engine()
{
_root_graph = NULL;
deactivate();
// Process all pending events
const FrameTime end = std::numeric_limits::max();
_process_context.locate(_process_context.end(), end - _process_context.end());
_post_processor->set_end_time(end);
_post_processor->process();
while (!_pre_processor->empty()) {
_pre_processor->process(_process_context, *_post_processor, 1);
_post_processor->process();
}
const SPtr store = this->store();
if (store) {
for (auto& s : *store.get()) {
if (!dynamic_ptr_cast(s.second)->parent()) {
s.second.reset();
}
}
store->clear();
}
_world->set_store(SPtr());
#ifdef HAVE_SOCKET
delete _listener;
#endif
delete _pre_processor;
delete _post_processor;
delete _block_factory;
delete _control_bindings;
delete _broadcaster;
delete _event_writer;
delete _worker;
delete _maid;
_driver.reset();
delete _buffer_factory;
munlockall();
}
void
Engine::listen()
{
#ifdef HAVE_SOCKET
_listener = new SocketListener(*this);
#endif
}
SPtr
Engine::store() const
{
return _world->store();
}
size_t
Engine::event_queue_size() const
{
return world()->conf().option("queue-size").get();
}
void
Engine::quit()
{
_quit_flag = true;
}
bool
Engine::main_iteration()
{
_post_processor->process();
_maid->cleanup();
return !_quit_flag;
}
void
Engine::set_driver(SPtr driver)
{
_driver = driver;
}
SampleCount
Engine::event_time()
{
if (ThreadManager::single_threaded) {
return 0;
}
const SampleCount start = _direct_driver
? _process_context.start()
: _driver->frame_time();
/* Exactly one cycle latency (some could run ASAP if we get lucky, but not
always, and a slight constant latency is far better than jittery lower
(average) latency */
return start + _driver->block_length();
}
static void
execute_and_delete_event(ProcessContext& context, Event* ev)
{
ev->pre_process();
if (ev->time() < context.start()) {
// Didn't get around to executing in time, oh well...
ev->set_time(context.start());
}
ev->execute(context);
ev->post_process();
delete ev;
}
void
Engine::init(double sample_rate, uint32_t block_length)
{
set_driver(SPtr(new DirectDriver(sample_rate, block_length)));
_direct_driver = true;
}
bool
Engine::activate()
{
if (!_driver) {
return false;
}
ThreadManager::single_threaded = true;
_buffer_factory->set_block_length(_driver->block_length());
_options->set(driver()->sample_rate(),
driver()->block_length(),
buffer_factory()->default_size(_world->uris().atom_Sequence));
const Ingen::URIs& uris = world()->uris();
Forge& forge = world()->forge();
// Create root graph
if (!_root_graph) {
_root_graph = new GraphImpl(
*this, Raul::Symbol("root"), 1, NULL, _driver->sample_rate(), 1);
_root_graph->set_property(
uris.rdf_type,
Resource::Property(uris.ingen_Graph, Resource::Graph::INTERNAL));
_root_graph->set_property(
uris.ingen_polyphony,
Resource::Property(_world->forge().make(int32_t(1)),
Resource::Graph::INTERNAL));
_root_graph->activate(*_buffer_factory);
_world->store()->add(_root_graph);
_root_graph->set_compiled_graph(_root_graph->compile());
ProcessContext context(*this);
Resource::Properties control_properties;
control_properties.insert(
make_pair(uris.lv2_name, forge.alloc("Control")));
control_properties.insert(
make_pair(uris.rdf_type,
Resource::Property(uris.atom_AtomPort)));
control_properties.insert(
make_pair(uris.atom_bufferType,
Resource::Property(uris.atom_Sequence)));
control_properties.insert(
make_pair(uris.rsz_minimumSize,
forge.make(4096)));
// Add control input
Resource::Properties in_properties(control_properties);
in_properties.insert(
make_pair(uris.rdf_type,
Resource::Property(uris.lv2_InputPort)));
in_properties.insert(make_pair(uris.lv2_index, forge.make(0)));
in_properties.insert(
make_pair(uris.lv2_portProperty,
Resource::Property(uris.lv2_connectionOptional)));
in_properties.insert(
make_pair(uris.ingen_canvasX,
Resource::Property(forge.make(32.0f),
Resource::Graph::EXTERNAL)));
in_properties.insert(
make_pair(uris.ingen_canvasY,
Resource::Property(forge.make(32.0f),
Resource::Graph::EXTERNAL)));
SPtr respondee;
execute_and_delete_event(
context, new Events::CreatePort(
*this, respondee, -1, 0, Raul::Path("/control_in"),
false, in_properties));
// Add control out
Resource::Properties out_properties(control_properties);
out_properties.insert(
make_pair(uris.rdf_type,
Resource::Property(uris.lv2_OutputPort)));
out_properties.insert(make_pair(uris.lv2_index, forge.make(1)));
in_properties.insert(
make_pair(uris.lv2_portProperty,
Resource::Property(uris.lv2_connectionOptional)));
out_properties.insert(
make_pair(uris.ingen_canvasX,
Resource::Property(forge.make(128.0f),
Resource::Graph::EXTERNAL)));
out_properties.insert(
make_pair(uris.ingen_canvasY,
Resource::Property(forge.make(32.0f),
Resource::Graph::EXTERNAL)));
execute_and_delete_event(
context, new Events::CreatePort(
*this, respondee, -1, 0, Raul::Path("/control_out"),
true, out_properties));
}
_driver->activate();
_root_graph->enable();
ThreadManager::single_threaded = false;
return true;
}
void
Engine::deactivate()
{
if (_driver) {
_driver->deactivate();
}
if (_root_graph) {
_root_graph->deactivate();
}
ThreadManager::single_threaded = true;
}
unsigned
Engine::run(uint32_t sample_count)
{
_process_context.locate(_process_context.end(), sample_count);
// Apply control bindings to input
control_bindings()->pre_process(
_process_context, _root_graph->port_impl(0)->buffer(0).get());
post_processor()->set_end_time(_process_context.end());
// Process events that came in during the last cycle
// (Aiming for jitter-free 1 block event latency, ideally)
const unsigned n_processed_events = process_events();
// Run root graph
if (_root_graph) {
_root_graph->process(_process_context);
// Emit control binding feedback
control_bindings()->post_process(
_process_context, _root_graph->port_impl(1)->buffer(0).get());
}
return n_processed_events;
}
bool
Engine::pending_events()
{
return !_pre_processor->empty();
}
void
Engine::enqueue_event(Event* ev)
{
_pre_processor->event(ev);
}
unsigned
Engine::process_events()
{
const size_t MAX_EVENTS_PER_CYCLE = _process_context.nframes() / 8;
return _pre_processor->process(
_process_context, *_post_processor, MAX_EVENTS_PER_CYCLE);
}
void
Engine::register_client(const Raul::URI& uri, SPtr client)
{
log().info(fmt("Registering client <%1%>\n") % uri.c_str());
_broadcaster->register_client(uri, client);
}
bool
Engine::unregister_client(const Raul::URI& uri)
{
log().info(fmt("Unregistering client <%1%>\n") % uri.c_str());
return _broadcaster->unregister_client(uri);
}
} // namespace Server
} // namespace Ingen