c@116: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
c@118: /*
c@118:     Piper C++
c@118: 
c@118:     An API for audio analysis and feature extraction plugins.
c@118: 
c@118:     Centre for Digital Music, Queen Mary, University of London.
c@118:     Copyright 2006-2016 Chris Cannam and QMUL.
c@118:   
c@118:     Permission is hereby granted, free of charge, to any person
c@118:     obtaining a copy of this software and associated documentation
c@118:     files (the "Software"), to deal in the Software without
c@118:     restriction, including without limitation the rights to use, copy,
c@118:     modify, merge, publish, distribute, sublicense, and/or sell copies
c@118:     of the Software, and to permit persons to whom the Software is
c@118:     furnished to do so, subject to the following conditions:
c@118: 
c@118:     The above copyright notice and this permission notice shall be
c@118:     included in all copies or substantial portions of the Software.
c@118: 
c@118:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
c@118:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
c@118:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
c@118:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
c@118:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
c@118:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
c@118:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
c@118: 
c@118:     Except as contained in this notice, the names of the Centre for
c@118:     Digital Music; Queen Mary, University of London; and Chris Cannam
c@118:     shall not be used in advertising or otherwise to promote the sale,
c@118:     use or other dealings in this Software without prior written
c@118:     authorization.
c@118: */
c@75: 
c@116: #include "vamp-json/VampJson.h"
c@75: #include "vamp-capnp/VampnProto.h"
c@75: #include "vamp-support/RequestOrResponse.h"
c@75: #include "vamp-support/CountingPluginHandleMapper.h"
c@97: #include "vamp-support/LoaderRequests.h"
c@75: 
c@75: #include <iostream>
c@75: #include <sstream>
c@75: #include <stdexcept>
c@75: 
c@91: #include <capnp/serialize.h>
c@91: 
c@75: #include <map>
c@75: #include <set>
c@75: 
c@109: // pid for logging
c@109: #ifdef _WIN32
c@109: #include <process.h>
c@109: static int pid = _getpid();
c@109: #else
c@109: #include <unistd.h>
c@109: static int pid = getpid();
c@109: #endif
c@103: 
c@75: using namespace std;
c@116: using namespace json11;
c@97: using namespace piper_vamp;
c@75: using namespace Vamp;
c@75: 
c@102: //!!! This could be faster and lighter:
c@102: //  - Use Capnp structures directly rather than converting to vamp-support ones
c@102: //  - Use Vamp C API (vamp.h) directly rather than converting to C++
c@102: //!!! Doing the above for process() and finish() alone would be a good start
c@102: 
c@116: static string myname = "piper-vamp-server";
c@116: 
c@116: static void version()
c@75: {
c@116:     cout << "1.0" << endl;
c@116:     exit(0);
c@116: }
c@116: 
c@116: static void usage(bool successful = false)
c@116: {
c@75:     cerr << "\n" << myname <<
c@116:         ": Load and run Vamp plugins in response to Piper messages\n\n"
c@116:         "    Usage: " << myname << " [-d] <format>\n"
c@116:         "           " << myname << " -v\n"
c@116:         "           " << myname << " -h\n\n"
c@116:         "    where\n"
c@116:         "       <format>: the format to read and write messages in (\"json\" or \"capnp\")\n"
c@116:         "       -d: also print debug information to stderr\n"
c@116:         "       -v: print version number to stdout and exit\n"
c@116:         "       -h: print this text to stderr and exit\n\n"
c@116:         "Expects Piper request messages in either Cap'n Proto or JSON format on stdin,\n"
c@116:         "and writes response messages in the same format to stdout.\n\n";
c@116:     if (successful) exit(0);
c@116:     else exit(2);
c@75: }
c@75: 
c@75: static CountingPluginHandleMapper mapper;
c@75: 
c@116: static RequestOrResponse::RpcId
c@116: readId(const piper::RpcRequest::Reader &r)
c@75: {
c@75:     int number;
c@75:     string tag;
c@75:     switch (r.getId().which()) {
c@97:     case piper::RpcRequest::Id::Which::NUMBER:
c@75:         number = r.getId().getNumber();
c@75:         return { RequestOrResponse::RpcId::Number, number, "" };
c@97:     case piper::RpcRequest::Id::Which::TAG:
c@75:         tag = r.getId().getTag();
c@75:         return { RequestOrResponse::RpcId::Tag, 0, tag };
c@97:     case piper::RpcRequest::Id::Which::NONE:
c@75:         return { RequestOrResponse::RpcId::Absent, 0, "" };
c@75:     }
c@75:     return {};
c@75: }
c@75: 
c@116: static void
c@116: buildId(piper::RpcResponse::Builder &b, const RequestOrResponse::RpcId &id)
c@75: {
c@75:     switch (id.type) {
c@75:     case RequestOrResponse::RpcId::Number:
c@75:         b.getId().setNumber(id.number);
c@75:         break;
c@75:     case RequestOrResponse::RpcId::Tag:
c@75:         b.getId().setTag(id.tag);
c@75:         break;
c@75:     case RequestOrResponse::RpcId::Absent:
c@75:         b.getId().setNone();
c@75:         break;
c@75:     }
c@75: }
c@75: 
c@116: static RequestOrResponse::RpcId
c@116: readJsonId(const Json &j)
c@116: {
c@116:     RequestOrResponse::RpcId id;
c@116: 
c@116:     if (j["id"].is_number()) {
c@116:         id.type = RequestOrResponse::RpcId::Number;
c@116:         id.number = j["id"].number_value();
c@116:     } else if (j["id"].is_string()) {
c@116:         id.type = RequestOrResponse::RpcId::Tag;
c@116:         id.tag = j["id"].string_value();
c@116:     } else {
c@116:         id.type = RequestOrResponse::RpcId::Absent;
c@116:     }
c@116: 
c@116:     return id;
c@116: }
c@116: 
c@116: static Json
c@116: writeJsonId(const RequestOrResponse::RpcId &id)
c@116: {
c@116:     if (id.type == RequestOrResponse::RpcId::Number) {
c@116:         return id.number;
c@116:     } else if (id.type == RequestOrResponse::RpcId::Tag) {
c@116:         return id.tag;
c@116:     } else {
c@116:         return Json();
c@116:     }
c@116: }
c@116: 
c@116: static Json
c@116: convertRequestJson(string input, string &err)
c@116: {
c@116:     Json j = Json::parse(input, err);
c@116:     if (err != "") {
c@116:         err = "invalid json: " + err;
c@116:         return {};
c@116:     }
c@116:     if (!j.is_object()) {
c@116:         err = "object expected at top level";
c@116:     } else if (!j["method"].is_string()) {
c@116:         err = "string expected for method field";
c@116:     } else if (!j["params"].is_null() && !j["params"].is_object()) {
c@116:         err = "object expected for params field";
c@116:     }
c@116:     return j;
c@116: }
c@116: 
c@116: RequestOrResponse
c@116: readRequestJson(string &err)
c@116: {
c@116:     RequestOrResponse rr;
c@116:     rr.direction = RequestOrResponse::Request;
c@116: 
c@116:     string input;
c@116:     if (!getline(cin, input)) {
c@116:         // the EOF case, not actually an error
c@116:         rr.type = RRType::NotValid;
c@116:         return rr;
c@116:     }
c@116:     
c@116:     Json j = convertRequestJson(input, err);
c@116:     if (err != "") return {};
c@116: 
c@116:     rr.type = VampJson::getRequestResponseType(j, err);
c@116:     if (err != "") return {};
c@116: 
c@116:     rr.id = readJsonId(j);
c@116: 
c@116:     VampJson::BufferSerialisation serialisation =
c@116:         VampJson::BufferSerialisation::Array;
c@116: 
c@116:     switch (rr.type) {
c@116: 
c@116:     case RRType::List:
c@116:         VampJson::toRpcRequest_List(j, err); // type check only
c@116:         break;
c@116:     case RRType::Load:
c@116:         rr.loadRequest = VampJson::toRpcRequest_Load(j, err);
c@116:         break;
c@116:     case RRType::Configure:
c@116:         rr.configurationRequest = VampJson::toRpcRequest_Configure(j, mapper, err);
c@116:         break;
c@116:     case RRType::Process:
c@116:         rr.processRequest = VampJson::toRpcRequest_Process(j, mapper, serialisation, err);
c@116:         break;
c@116:     case RRType::Finish:
c@116:         rr.finishRequest = VampJson::toRpcRequest_Finish(j, mapper, err);
c@116:         break;
c@116:     case RRType::NotValid:
c@116:         break;
c@116:     }
c@116: 
c@116:     return rr;
c@116: }
c@116: 
c@116: void
c@116: writeResponseJson(RequestOrResponse &rr, bool useBase64)
c@116: {
c@116:     Json j;
c@116: 
c@116:     VampJson::BufferSerialisation serialisation =
c@116:         (useBase64 ?
c@116:          VampJson::BufferSerialisation::Base64 :
c@116:          VampJson::BufferSerialisation::Array);
c@116: 
c@116:     Json id = writeJsonId(rr.id);
c@116: 
c@116:     if (!rr.success) {
c@116: 
c@116:         j = VampJson::fromError(rr.errorText, rr.type, id);
c@116: 
c@116:     } else {
c@116:     
c@116:         switch (rr.type) {
c@116: 
c@116:         case RRType::List:
c@116:             j = VampJson::fromRpcResponse_List(rr.listResponse, id);
c@116:             break;
c@116:         case RRType::Load:
c@116:             j = VampJson::fromRpcResponse_Load(rr.loadResponse, mapper, id);
c@116:             break;
c@116:         case RRType::Configure:
c@116:             j = VampJson::fromRpcResponse_Configure(rr.configurationResponse,
c@116:                                                     mapper, id);
c@116:             break;
c@116:         case RRType::Process:
c@116:             j = VampJson::fromRpcResponse_Process
c@116:                 (rr.processResponse, mapper, serialisation, id);
c@116:             break;
c@116:         case RRType::Finish:
c@116:             j = VampJson::fromRpcResponse_Finish
c@116:                 (rr.finishResponse, mapper, serialisation, id);
c@116:             break;
c@116:         case RRType::NotValid:
c@116:             break;
c@116:         }
c@116:     }
c@116:     
c@116:     cout << j.dump() << endl;
c@116: }
c@116: 
c@116: void
c@116: writeExceptionJson(const std::exception &e, RRType type)
c@116: {
c@116:     Json j = VampJson::fromError(e.what(), type, Json());
c@116:     cout << j.dump() << endl;
c@116: }
c@116: 
c@75: RequestOrResponse
c@75: readRequestCapnp()
c@75: {
c@75:     RequestOrResponse rr;
c@75:     rr.direction = RequestOrResponse::Request;
c@75: 
c@75:     static kj::FdInputStream stream(0); // stdin
c@75:     static kj::BufferedInputStreamWrapper buffered(stream);
c@75: 
c@75:     if (buffered.tryGetReadBuffer() == nullptr) {
c@116:         rr.type = RRType::NotValid;
c@116:         return rr;
c@75:     }
c@75: 
c@97:     capnp::InputStreamMessageReader message(buffered);
c@97:     piper::RpcRequest::Reader reader = message.getRoot<piper::RpcRequest>();
c@75:     
c@75:     rr.type = VampnProto::getRequestResponseType(reader);
c@75:     rr.id = readId(reader);
c@75: 
c@75:     switch (rr.type) {
c@75: 
c@75:     case RRType::List:
c@116:         VampnProto::readRpcRequest_List(reader); // type check only
c@116:         break;
c@75:     case RRType::Load:
c@116:         VampnProto::readRpcRequest_Load(rr.loadRequest, reader);
c@116:         break;
c@75:     case RRType::Configure:
c@116:         VampnProto::readRpcRequest_Configure(rr.configurationRequest,
c@116:                                              reader, mapper);
c@116:         break;
c@75:     case RRType::Process:
c@116:         VampnProto::readRpcRequest_Process(rr.processRequest, reader, mapper);
c@116:         break;
c@75:     case RRType::Finish:
c@116:         VampnProto::readRpcRequest_Finish(rr.finishRequest, reader, mapper);
c@116:         break;
c@75:     case RRType::NotValid:
c@116:         break;
c@75:     }
c@75: 
c@75:     return rr;
c@75: }
c@75: 
c@75: void
c@75: writeResponseCapnp(RequestOrResponse &rr)
c@75: {
c@97:     capnp::MallocMessageBuilder message;
c@97:     piper::RpcResponse::Builder builder = message.initRoot<piper::RpcResponse>();
c@75: 
c@75:     buildId(builder, rr.id);
c@75:     
c@75:     if (!rr.success) {
c@75: 
c@116:         VampnProto::buildRpcResponse_Error(builder, rr.errorText, rr.type);
c@75: 
c@75:     } else {
c@116:         
c@116:         switch (rr.type) {
c@75: 
c@116:         case RRType::List:
c@116:             VampnProto::buildRpcResponse_List(builder, rr.listResponse);
c@116:             break;
c@116:         case RRType::Load:
c@116:             VampnProto::buildRpcResponse_Load(builder, rr.loadResponse, mapper);
c@116:             break;
c@116:         case RRType::Configure:
c@116:             VampnProto::buildRpcResponse_Configure(builder, rr.configurationResponse, mapper);
c@116:             break;
c@116:         case RRType::Process:
c@116:             VampnProto::buildRpcResponse_Process(builder, rr.processResponse, mapper);
c@116:             break;
c@116:         case RRType::Finish:
c@116:             VampnProto::buildRpcResponse_Finish(builder, rr.finishResponse, mapper);
c@116:             break;
c@116:         case RRType::NotValid:
c@116:             break;
c@116:         }
c@75:     }
c@75:     
c@75:     writeMessageToFd(1, message);
c@75: }
c@75: 
c@75: void
c@75: writeExceptionCapnp(const std::exception &e, RRType type)
c@75: {
c@97:     capnp::MallocMessageBuilder message;
c@97:     piper::RpcResponse::Builder builder = message.initRoot<piper::RpcResponse>();
c@75:     VampnProto::buildRpcResponse_Exception(builder, e, type);
c@75:     
c@75:     writeMessageToFd(1, message);
c@75: }
c@75: 
c@75: RequestOrResponse
c@116: handleRequest(const RequestOrResponse &request, bool debug)
c@75: {
c@75:     RequestOrResponse response;
c@75:     response.direction = RequestOrResponse::Response;
c@75:     response.type = request.type;
c@75: 
c@75:     switch (request.type) {
c@75: 
c@75:     case RRType::List:
c@116:         response.listResponse = LoaderRequests().listPluginData();
c@116:         response.success = true;
c@116:         break;
c@75: 
c@75:     case RRType::Load:
c@116:         response.loadResponse = LoaderRequests().loadPlugin(request.loadRequest);
c@116:         if (response.loadResponse.plugin != nullptr) {
c@116:             mapper.addPlugin(response.loadResponse.plugin);
c@116:             if (debug) {
c@116:                 cerr << "piper-vamp-server " << pid << ": loaded plugin, handle = " << mapper.pluginToHandle(response.loadResponse.plugin) << endl;
c@116:             }
c@116:             response.success = true;
c@116:         }
c@116:         break;
c@116:         
c@75:     case RRType::Configure:
c@75:     {
c@116:         auto &creq = request.configurationRequest;
c@116:         auto h = mapper.pluginToHandle(creq.plugin);
c@116:         if (mapper.isConfigured(h)) {
c@116:             throw runtime_error("plugin has already been configured");
c@116:         }
c@75: 
c@116:         response.configurationResponse = LoaderRequests().configurePlugin(creq);
c@116:         
c@116:         if (!response.configurationResponse.outputs.empty()) {
c@116:             mapper.markConfigured
c@116:                 (h, creq.configuration.channelCount, creq.configuration.blockSize);
c@116:             response.success = true;
c@116:         }
c@116:         break;
c@75:     }
c@75: 
c@75:     case RRType::Process:
c@75:     {
c@116:         auto &preq = request.processRequest;
c@116:         auto h = mapper.pluginToHandle(preq.plugin);
c@116:         if (!mapper.isConfigured(h)) {
c@116:             throw runtime_error("plugin has not been configured");
c@116:         }
c@75: 
c@116:         int channels = int(preq.inputBuffers.size());
c@116:         if (channels != mapper.getChannelCount(h)) {
c@116:             throw runtime_error("wrong number of channels supplied to process");
c@116:         }
c@116:                 
c@116:         const float **fbuffers = new const float *[channels];
c@116:         for (int i = 0; i < channels; ++i) {
c@116:             if (int(preq.inputBuffers[i].size()) != mapper.getBlockSize(h)) {
c@116:                 delete[] fbuffers;
c@116:                 throw runtime_error("wrong block size supplied to process");
c@116:             }
c@116:             fbuffers[i] = preq.inputBuffers[i].data();
c@116:         }
c@75: 
c@116:         response.processResponse.plugin = preq.plugin;
c@116:         response.processResponse.features =
c@116:             preq.plugin->process(fbuffers, preq.timestamp);
c@116:         response.success = true;
c@75: 
c@116:         delete[] fbuffers;
c@116:         break;
c@75:     }
c@75: 
c@75:     case RRType::Finish:
c@75:     {
c@116:         auto &freq = request.finishRequest;
c@116:         response.finishResponse.plugin = freq.plugin;
c@77: 
c@116:         auto h = mapper.pluginToHandle(freq.plugin);
c@77:         // Finish can be called (to unload the plugin) even if the
c@77:         // plugin has never been configured or used. But we want to
c@77:         // make sure we call getRemainingFeatures only if we have
c@77:         // actually configured the plugin.
c@116:         if (mapper.isConfigured(h)) {
c@77:             response.finishResponse.features = freq.plugin->getRemainingFeatures();
c@116:         }
c@75: 
c@116:         // We do not delete the plugin here -- we need it in the
c@116:         // mapper when converting the features. It gets deleted in the
c@116:         // calling function.
c@116:         response.success = true;
c@116:         break;
c@75:     }
c@75: 
c@75:     case RRType::NotValid:
c@116:         break;
c@75:     }
c@75:     
c@75:     return response;
c@75: }
c@75: 
c@116: RequestOrResponse
c@116: readRequest(string format)
c@75: {
c@116:     if (format == "capnp") {
c@116:         return readRequestCapnp();
c@116:     } else if (format == "json") {
c@116:         string err;
c@116:         auto result = readRequestJson(err);
c@116:         if (err != "") throw runtime_error(err);
c@116:         else return result;
c@116:     } else {
c@116:         throw runtime_error("unknown input format \"" + format + "\"");
c@116:     }
c@116: }
c@116: 
c@116: void
c@116: writeResponse(string format, RequestOrResponse &rr)
c@116: {
c@116:     if (format == "capnp") {
c@116:         writeResponseCapnp(rr);
c@116:     } else if (format == "json") {
c@116:         writeResponseJson(rr, false);
c@116:     } else {
c@116:         throw runtime_error("unknown output format \"" + format + "\"");
c@116:     }
c@116: }
c@116: 
c@116: void
c@116: writeException(string format, const std::exception &e, RRType type)
c@116: {
c@116:     if (format == "capnp") {
c@116:         writeExceptionCapnp(e, type);
c@116:     } else if (format == "json") {
c@116:         writeExceptionJson(e, type);
c@116:     } else {
c@116:         throw runtime_error("unknown output format \"" + format + "\"");
c@116:     }
c@116: }
c@116: 
c@116: int main(int argc, char **argv)
c@116: {
c@116:     if (argc != 2 && argc != 3) {
c@116:         usage();
c@75:     }
c@75: 
c@116:     bool debug = false;
c@112:     
c@116:     string arg = argv[1];
c@116:     if (arg == "-h") {
c@116:         if (argc == 2) {
c@116:             usage(true);
c@116:         } else {
c@116:             usage();
c@116:         }
c@116:     } else if (arg == "-v") {
c@116:         if (argc == 2) {
c@116:             version();
c@116:         } else {
c@116:             usage();
c@116:         }
c@116:     } else if (arg == "-d") {
c@116:         if (argc == 2) {
c@116:             usage();
c@116:         } else {
c@116:             debug = true;
c@116:             arg = argv[2];
c@116:         }
c@116:     }
c@116:     
c@116:     string format = arg;
c@116: 
c@116:     if (format != "capnp" && format != "json") {
c@116:         usage();
c@116:     }
c@116: 
c@116:     if (debug) {
c@116:         cerr << myname << " " << pid << ": waiting for format: " << format << endl;
c@116:     }
c@116: 
c@75:     while (true) {
c@75: 
c@116:         RequestOrResponse request;
c@116:         
c@116:         try {
c@75: 
c@116:             request = readRequest(format);
c@116:             
c@116:             // NotValid without an exception indicates EOF:
c@116:             if (request.type == RRType::NotValid) {
c@116:                 if (debug) {
c@116:                     cerr << myname << " " << pid << ": eof reached, exiting" << endl;
c@116:                 }
c@116:                 break;
c@116:             }
c@75: 
c@116:             if (debug) {
c@116:                 cerr << myname << " " << pid << ": request received, of type "
c@116:                      << int(request.type)
c@116:                      << endl;
c@116:             }
c@75: 
c@116:             RequestOrResponse response = handleRequest(request, debug);
c@75:             response.id = request.id;
c@75: 
c@116:             if (debug) {
c@116:                 cerr << myname << " " << pid << ": request handled, writing response"
c@116:                      << endl;
c@116:             }
c@116:             
c@116:             writeResponse(format, response);
c@75: 
c@116:             if (debug) {
c@116:                 cerr << myname << " " << pid << ": response written" << endl;
c@116:             }
c@75: 
c@116:             if (request.type == RRType::Finish) {
c@116:                 auto h = mapper.pluginToHandle(request.finishRequest.plugin);
c@116:                 if (debug) {
c@116:                     cerr << myname << " " << pid << ": deleting the plugin with handle " << h << endl;
c@116:                 }
c@116:                 mapper.removePlugin(h);
c@116:                 delete request.finishRequest.plugin;
c@116:             }
c@116:             
c@116:         } catch (std::exception &e) {
c@75: 
c@116:             if (debug) {
c@116:                 cerr << myname << " " << pid << ": error: " << e.what() << endl;
c@116:             }
c@75: 
c@116:             writeException(format, e, request.type);
c@116:             
c@116:             exit(1);
c@116:         }
c@75:     }
c@75: 
c@75:     exit(0);
c@75: }