cannam@232: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
cannam@232: /*
cannam@232:     Piper C++
cannam@232: 
cannam@232:     An API for audio analysis and feature extraction plugins.
cannam@232: 
cannam@232:     Centre for Digital Music, Queen Mary, University of London.
cannam@232:     Copyright 2006-2016 Chris Cannam and QMUL.
cannam@232:   
cannam@232:     Permission is hereby granted, free of charge, to any person
cannam@232:     obtaining a copy of this software and associated documentation
cannam@232:     files (the "Software"), to deal in the Software without
cannam@232:     restriction, including without limitation the rights to use, copy,
cannam@232:     modify, merge, publish, distribute, sublicense, and/or sell copies
cannam@232:     of the Software, and to permit persons to whom the Software is
cannam@232:     furnished to do so, subject to the following conditions:
cannam@232: 
cannam@232:     The above copyright notice and this permission notice shall be
cannam@232:     included in all copies or substantial portions of the Software.
cannam@232: 
cannam@232:     THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@232:     EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@232:     MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
cannam@232:     NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
cannam@232:     ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@232:     CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@232:     WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@232: 
cannam@232:     Except as contained in this notice, the names of the Centre for
cannam@232:     Digital Music; Queen Mary, University of London; and Chris Cannam
cannam@232:     shall not be used in advertising or otherwise to promote the sale,
cannam@232:     use or other dealings in this Software without prior written
cannam@232:     authorization.
cannam@232: */
cannam@232: 
cannam@232: #include "vamp-json/VampJson.h"
cannam@232: #include "vamp-support/RequestOrResponse.h"
cannam@232: #include "vamp-support/LoaderRequests.h"
cannam@232: #include "vamp-support/RdfTypes.h"
cannam@232: 
cannam@232: #include <iostream>
cannam@232: #include <sstream>
cannam@232: #include <stdexcept>
cannam@232: 
cannam@232: #include <map>
cannam@232: #include <set>
cannam@232: 
cannam@232: // for _setmode stuff and _dup
cannam@232: #ifdef _WIN32
cannam@232: #include <io.h>
cannam@232: #include <fcntl.h>
cannam@232: #endif
cannam@232: 
cannam@232: // for dup, open etc
cannam@232: #ifndef _WIN32
cannam@232: #include <fcntl.h>
cannam@232: #include <unistd.h>
cannam@232: #endif
cannam@232: 
cannam@232: using namespace std;
cannam@232: using namespace json11;
cannam@232: using namespace piper_vamp;
cannam@232: using namespace Vamp;
cannam@232: 
cannam@232: static string myname = "piper-vamp-simple-server";
cannam@232: 
cannam@232: static void version()
cannam@232: {
cannam@232:     cout << "1.0" << endl;
cannam@232:     exit(0);
cannam@232: }
cannam@232: 
cannam@232: static void usage(bool successful = false)
cannam@232: {
cannam@232:     cerr << "\n" << myname <<
cannam@232:         ": Emit stub version of main code\nfor a Piper Adapter implementation of a Vamp plugin library\n\n"
cannam@232:         "    Usage: " << myname << " [-d] <soname>\n"
cannam@232:         "           " << myname << " -v\n"
cannam@232:         "           " << myname << " -h\n\n"
cannam@232:         "    where\n"
cannam@232:         "       <soname>: the Vamp plugin library name to emit stub conversion code for\n"
cannam@232:         "       -d: also print debug information to stderr\n"
cannam@232:         "       -v: print version number to stdout and exit\n"
cannam@232:         "       -h: print this text to stderr and exit\n\n";
cannam@232:     if (successful) exit(0);
cannam@232:     else exit(2);
cannam@232: }
cannam@232: 
cannam@232: // We write our output to stdout, but want to ensure that the plugin
cannam@232: // doesn't write anything itself. To do this we open a null file
cannam@232: // descriptor and dup2() it into place of stdout in the gaps between
cannam@232: // our own output activity.
cannam@232: 
cannam@232: static int normalFd = -1;
cannam@232: static int suspendedFd = -1;
cannam@232: 
cannam@232: static void initFds(bool binary)
cannam@232: {
cannam@232: #ifdef _WIN32
cannam@232:     if (binary) {
cannam@232:         int result = _setmode(0, _O_BINARY);
cannam@232:         if (result == -1) {
cannam@232:             throw runtime_error("Failed to set binary mode on stdin");
cannam@232:         }
cannam@232:         result = _setmode(1, _O_BINARY);
cannam@232:         if (result == -1) {
cannam@232:             throw runtime_error("Failed to set binary mode on stdout");
cannam@232:         }
cannam@232:     }
cannam@232:     normalFd = _dup(1);
cannam@232:     suspendedFd = _open("NUL", _O_WRONLY);
cannam@232: #else
cannam@232:     (void)binary;
cannam@232:     normalFd = dup(1);
cannam@232:     suspendedFd = open("/dev/null", O_WRONLY);
cannam@232: #endif
cannam@232:     
cannam@232:     if (normalFd < 0 || suspendedFd < 0) {
cannam@232:         throw runtime_error("Failed to initialise fds for stdio suspend/resume");
cannam@232:     }
cannam@232: }
cannam@232: 
cannam@232: static void suspendOutput()
cannam@232: {
cannam@232: #ifdef _WIN32
cannam@232:     _dup2(suspendedFd, 1);
cannam@232: #else
cannam@232:     dup2(suspendedFd, 1);
cannam@232: #endif
cannam@232: }
cannam@232: 
cannam@232: static void resumeOutput()
cannam@232: {
cannam@232: #ifdef _WIN32
cannam@232:     _dup2(normalFd, 1);
cannam@232: #else
cannam@232:     dup2(normalFd, 1);
cannam@232: #endif
cannam@232: }
cannam@232: 
cannam@232: ListResponse
cannam@232: makeRequest(string soname, bool debug)
cannam@232: {
cannam@232:     ListRequest req;
cannam@232:     req.from.push_back(soname);
cannam@232:     return LoaderRequests().listPluginData(req);
cannam@232: }
cannam@232: 
cannam@232: struct PlausibleMetadata
cannam@232: {
cannam@232:     string className;
cannam@232:     string adapterName;
cannam@232: };
cannam@232: 
cannam@232: PlausibleMetadata
cannam@232: inventPlausibleMetadata(string key)
cannam@232: {
cannam@232:     PlausibleMetadata pm;
cannam@232:     pm.className = "MyPlugin";//!!!
cannam@232:     pm.adapterName = "myPluginAdapter";//!!!
cannam@232:     return pm;
cannam@232: }
cannam@232: 
cannam@232: void
cannam@232: emitFor(string soname, const ListResponse &resp, bool debug)
cannam@232: {
cannam@232:     cout <<
cannam@232:         "\n#include \"PiperExport.h\"\n"
cannam@232:         "\n"
cannam@232:         "// #include your own plugin headers here\n"
cannam@232:         "\n"
cannam@232:         "using piper_vamp_js::PiperAdapter;\n"
cannam@232:         "using piper_vamp_js::PiperPluginLibrary;\n"
cannam@232:         "\n"
cannam@232:         "static std::string soname(\"" << soname << "\");\n"
cannam@232:         "\n";
cannam@232: 
cannam@232:     bool first = true;
cannam@232:     
cannam@232:     for (const auto &plugin: resp.available) {
cannam@232:         PlausibleMetadata pm = inventPlausibleMetadata(plugin.pluginKey);
cannam@232:         cout << "static PiperAdapter<"
cannam@232:              << pm.className
cannam@232:              << "> // replace with the actual Vamp plugin class name for \""
cannam@232:              << plugin.basic.identifier << "\" plugin\n" << pm.adapterName
cannam@232:              << "(\n    soname,\n    ";
cannam@232:         
cannam@232:         string catString = "{ ";
cannam@232:         first = true;
cannam@232:         for (auto c: plugin.category) {
cannam@232:             if (!first) catString += ", ";
cannam@232:             catString += "\"" + c + "\"";
cannam@232:             first = false;
cannam@232:         }
cannam@232:         catString += " }";
cannam@232:         cout << catString << ",\n    ";
cannam@232: 
cannam@232:         cout << "{\n    ";
cannam@232:         first = true;
cannam@232:         for (auto o: plugin.staticOutputInfo) {
cannam@232:             if (!first) {
cannam@232:                 cout << ",\n    ";
cannam@232:             }
cannam@232:             cout << "    ";
cannam@232:             string outputId = o.first;
cannam@232:             const StaticOutputDescriptor &desc = o.second;
cannam@235:             cout << "{ \"" << outputId << "\",\n            { \""
cannam@235:                  << desc.typeURI << "\" }\n        }";
cannam@232:             first = false;
cannam@232:         }
cannam@232:         cout << "\n    }\n";
cannam@232:         cout << "    );\n\n";
cannam@232:     }
cannam@232: 
cannam@232:     cout << "static PiperPluginLibrary library({\n    ";
cannam@232:     first = true;
cannam@232:     for (const auto &plugin: resp.available) {
cannam@232:         PlausibleMetadata pm = inventPlausibleMetadata(plugin.pluginKey);
cannam@232:         if (!first) {
cannam@232:             cout << ",\n    ";
cannam@232:         }
cannam@232:         cout << "&" << pm.adapterName;
cannam@232:         first = false;
cannam@232:     }
cannam@232:     cout << "\n});\n\n";
cannam@232:     cout << "PIPER_EXPORT_LIBRARY(library);\n" << endl;
cannam@232: }    
cannam@232: 
cannam@232: int main(int argc, char **argv)
cannam@232: {
cannam@232:     if (argc != 2 && argc != 3) {
cannam@232:         usage();
cannam@232:     }
cannam@232: 
cannam@232:     bool debug = false;
cannam@232:     
cannam@232:     string arg = argv[1];
cannam@232:     if (arg == "-h") {
cannam@232:         if (argc == 2) {
cannam@232:             usage(true);
cannam@232:         } else {
cannam@232:             usage();
cannam@232:         }
cannam@232:     } else if (arg == "-v") {
cannam@232:         if (argc == 2) {
cannam@232:             version();
cannam@232:         } else {
cannam@232:             usage();
cannam@232:         }
cannam@232:     } else if (arg == "-d") {
cannam@232:         if (argc == 2) {
cannam@232:             usage();
cannam@232:         } else {
cannam@232:             debug = true;
cannam@232:             arg = argv[2];
cannam@232:         }
cannam@232:     }
cannam@232:     
cannam@232:     string soname = arg;
cannam@232: 
cannam@232:     try {            
cannam@232:         initFds(false);
cannam@232:     } catch (exception &e) {
cannam@232:         cerr << "ERROR: " << e.what() << endl;
cannam@232:         exit(1);
cannam@232:     }
cannam@232: 
cannam@232:     suspendOutput();
cannam@232: 
cannam@232:     ListResponse resp = makeRequest(soname, debug);
cannam@232: 
cannam@232:     resumeOutput();
cannam@232: 
cannam@232:     emitFor(soname, resp, debug);
cannam@232:     
cannam@232:     exit(0);
cannam@232: }