libs/ardour/luaproc.cc

   1 /*
   2     Copyright (C) 2016 Robin Gareus <robin@gareus.org>
   3     Copyright (C) 2006 Paul Davis
   4
   5     This program is free software; you can redistribute it and/or modify it
   6     under the terms of the GNU General Public License as published by the Free
   7     Software Foundation; either version 2 of the License, or (at your option)
   8     any later version.
   9
  10     This program is distributed in the hope that it will be useful, but WITHOUT
  11     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13     for more details.
  14
  15     You should have received a copy of the GNU General Public License along
  16     with this program; if not, write to the Free Software Foundation, Inc.,
  17     675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #include <glib.h>
  21 #include <glibmm/miscutils.h>
  22 #include <glibmm/fileutils.h>
  23
  24 #include "pbd/gstdio_compat.h"
  25 #include "pbd/locale_guard.h"
  26 #include "pbd/pthread_utils.h"
  27
  28 #include "ardour/audio_buffer.h"
  29 #include "ardour/buffer_set.h"
  30 #include "ardour/filesystem_paths.h"
  31 #include "ardour/luabindings.h"
  32 #include "ardour/luaproc.h"
  33 #include "ardour/luascripting.h"
  34 #include "ardour/midi_buffer.h"
  35 #include "ardour/plugin.h"
  36 #include "ardour/session.h"
  37
  38 #include "LuaBridge/LuaBridge.h"
  39
  40 #include "pbd/i18n.h"
  41
  42 using namespace ARDOUR;
  43 using namespace PBD;
  44
  45 LuaProc::LuaProc (AudioEngine& engine,
  46                   Session& session,
  47                   const std::string &script)
  48         : Plugin (engine, session)
  49         , _mempool ("LuaProc", 2097152)
  50 #ifdef USE_TLSF
  51         , lua (lua_newstate (&PBD::TLSF::lalloc, &_mempool))
  52 #elif defined USE_MALLOC
  53         , lua ()
  54 #else
  55         , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
  56 #endif
  57         , _lua_dsp (0)
  58         , _script (script)
  59         , _lua_does_channelmapping (false)
  60         , _lua_has_inline_display (false)
  61         , _designated_bypass_port (UINT32_MAX)
  62         , _control_data (0)
  63         , _shadow_data (0)
  64         , _has_midi_input (false)
  65         , _has_midi_output (false)
  66 {
  67         init ();
  68
  69         /* when loading a session, or pasing a processor,
  70          * the script is set during set_state();
  71          */
  72         if (!_script.empty () && load_script ()) {
  73                 throw failed_constructor ();
  74         }
  75 }
  76
  77 LuaProc::LuaProc (const LuaProc &other)
  78         : Plugin (other)
  79         , _mempool ("LuaProc", 2097152)
  80 #ifdef USE_TLSF
  81         , lua (lua_newstate (&PBD::TLSF::lalloc, &_mempool))
  82 #elif defined USE_MALLOC
  83         , lua ()
  84 #else
  85         , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
  86 #endif
  87         , _lua_dsp (0)
  88         , _script (other.script ())
  89         , _lua_does_channelmapping (false)
  90         , _lua_has_inline_display (false)
  91         , _designated_bypass_port (UINT32_MAX)
  92         , _control_data (0)
  93         , _shadow_data (0)
  94         , _has_midi_input (false)
  95         , _has_midi_output (false)
  96 {
  97         init ();
  98
  99         if (load_script ()) {
 100                 throw failed_constructor ();
 101         }
 102
 103         for (uint32_t i = 0; i < parameter_count (); ++i) {
 104                 _control_data[i] = other._shadow_data[i];
 105                 _shadow_data[i]  = other._shadow_data[i];
 106         }
 107 }
 108
 109 LuaProc::~LuaProc () {
 110 #ifdef WITH_LUAPROC_STATS
 111         if (_info && _stats_cnt > 0) {
 112                 printf ("LuaProc: '%s' run()  avg: %.3f  max: %.3f [ms]\n",
 113                                 _info->name.c_str (),
 114                                 0.0001f * _stats_avg[0] / (float) _stats_cnt,
 115                                 0.0001f * _stats_max[0]);
 116                 printf ("LuaProc: '%s' gc()   avg: %.3f  max: %.3f [ms]\n",
 117                                 _info->name.c_str (),
 118                                 0.0001f * _stats_avg[1] / (float) _stats_cnt,
 119                                 0.0001f * _stats_max[1]);
 120         }
 121 #endif
 122         lua.do_command ("collectgarbage();");
 123         delete (_lua_dsp);
 124         delete [] _control_data;
 125         delete [] _shadow_data;
 126 }
 127
 128 void
 129 LuaProc::init ()
 130 {
 131 #ifdef WITH_LUAPROC_STATS
 132         _stats_avg[0] = _stats_avg[1] = _stats_max[0] = _stats_max[1] = _stats_cnt = 0;
 133 #endif
 134
 135         lua.tweak_rt_gc ();
 136         lua.Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
 137         // register session object
 138         lua_State* L = lua.getState ();
 139         LuaBindings::stddef (L);
 140         LuaBindings::common (L);
 141         LuaBindings::dsp (L);
 142
 143         luabridge::getGlobalNamespace (L)
 144                 .beginNamespace ("Ardour")
 145                 .beginClass <LuaProc> ("LuaProc")
 146                 .addFunction ("queue_draw", &LuaProc::queue_draw)
 147                 .addFunction ("shmem", &LuaProc::instance_shm)
 148                 .addFunction ("table", &LuaProc::instance_ref)
 149                 .endClass ()
 150                 .endNamespace ();
 151
 152         // add session to global lua namespace
 153         luabridge::push <Session *> (L, &_session);
 154         lua_setglobal (L, "Session");
 155
 156         // instance
 157         luabridge::push <LuaProc *> (L, this);
 158         lua_setglobal (L, "self");
 159
 160         // sandbox
 161         lua.do_command ("io = nil os = nil loadfile = nil require = nil dofile = nil package = nil debug = nil");
 162 #if 0
 163         lua.do_command ("for n in pairs(_G) do print(n) end print ('----')"); // print global env
 164 #endif
 165         lua.do_command ("function ardour () end");
 166 }
 167
 168 void
 169 LuaProc::lua_print (std::string s) {
 170         std::cout <<"LuaProc: " << s << "\n";
 171         PBD::error << "LuaProc: " << s << "\n";
 172 }
 173
 174 bool
 175 LuaProc::load_script ()
 176 {
 177         assert (!_lua_dsp); // don't allow to re-initialize
 178         LuaPluginInfoPtr lpi;
 179
 180         // TODO: refine APIs; function arguments..
 181         // - perform channel-map in ardour (silent/scratch buffers) ?
 182         // - control-port API (explicit get/set functions ??)
 183         // - latency reporting (global var? ctrl-port? set-function ?)
 184         // - MIDI -> sparse table of events
 185         //     { [sample] => { Event }, .. }
 186         //   or  { { sample, Event }, .. }
 187
 188         try {
 189                 LuaScriptInfoPtr lsi = LuaScripting::script_info (_script);
 190                 lpi = LuaPluginInfoPtr (new LuaPluginInfo (lsi));
 191                 assert (lpi);
 192                 set_info (lpi);
 193                 _mempool.set_name ("LuaProc: " + lsi->name);
 194                 _docs = lsi->description;
 195         } catch (failed_constructor& err) {
 196                 return true;
 197         }
 198
 199         lua_State* L = lua.getState ();
 200         lua.do_command (_script);
 201
 202         // check if script has a DSP callback
 203         luabridge::LuaRef lua_dsp_run = luabridge::getGlobal (L, "dsp_run");
 204         luabridge::LuaRef lua_dsp_map = luabridge::getGlobal (L, "dsp_runmap");
 205
 206         if ((lua_dsp_run.type () != LUA_TFUNCTION) == (lua_dsp_map.type () != LUA_TFUNCTION)) {
 207                 return true;
 208         }
 209
 210         if (lua_dsp_run.type () == LUA_TFUNCTION) {
 211                 _lua_dsp = new luabridge::LuaRef (lua_dsp_run);
 212         }
 213         else if (lua_dsp_map.type () == LUA_TFUNCTION) {
 214                 _lua_dsp = new luabridge::LuaRef (lua_dsp_map);
 215                 _lua_does_channelmapping = true;
 216         }
 217         else {
 218                 assert (0);
 219         }
 220
 221         // initialize the DSP if needed
 222         luabridge::LuaRef lua_dsp_init = luabridge::getGlobal (L, "dsp_init");
 223         if (lua_dsp_init.type () == LUA_TFUNCTION) {
 224                 try {
 225                         lua_dsp_init (_session.nominal_frame_rate ());
 226                 } catch (luabridge::LuaException const& e) {
 227                         ;
 228                 }
 229         }
 230
 231         // query midi i/o
 232         luabridge::LuaRef lua_dsp_has_midi_in = luabridge::getGlobal (L, "dsp_has_midi_input");
 233         if (lua_dsp_has_midi_in.type () == LUA_TFUNCTION) {
 234                 try {
 235                         _has_midi_input = lua_dsp_has_midi_in ();
 236                 } catch (luabridge::LuaException const& e) {
 237                         ;
 238                 }
 239         }
 240
 241         luabridge::LuaRef lua_dsp_has_midi_out = luabridge::getGlobal (L, "dsp_has_midi_output");
 242         if (lua_dsp_has_midi_out.type () == LUA_TFUNCTION) {
 243                 try {
 244                         _has_midi_output = lua_dsp_has_midi_out ();
 245                 } catch (luabridge::LuaException const& e) {
 246                         ;
 247                 }
 248         }
 249
 250         _ctrl_params.clear ();
 251
 252         luabridge::LuaRef lua_render = luabridge::getGlobal (L, "render_inline");
 253         if (lua_render.isFunction ()) {
 254                 _lua_has_inline_display = true;
 255         }
 256
 257         luabridge::LuaRef lua_params = luabridge::getGlobal (L, "dsp_params");
 258         if (lua_params.isFunction ()) {
 259
 260                 // call function // add try {} catch (luabridge::LuaException const& e)
 261                 luabridge::LuaRef params = lua_params ();
 262
 263                 if (params.isTable ()) {
 264
 265                         for (luabridge::Iterator i (params); !i.isNil (); ++i) {
 266                                 // required fields
 267                                 if (!i.key ().isNumber ())           { return false; }
 268                                 if (!i.value ().isTable ())          { return false; }
 269                                 if (!i.value ()["type"].isString ()) { return false; }
 270                                 if (!i.value ()["name"].isString ()) { return false; }
 271                                 if (!i.value ()["min"].isNumber ())  { return false; }
 272                                 if (!i.value ()["max"].isNumber ())  { return false; }
 273
 274                                 int pn = i.key ().cast<int> ();
 275                                 std::string type = i.value ()["type"].cast<std::string> ();
 276                                 if (type == "input") {
 277                                         if (!i.value ()["default"].isNumber ()) { return false; }
 278                                         _ctrl_params.push_back (std::make_pair (false, pn));
 279                                 }
 280                                 else if (type == "output") {
 281                                         _ctrl_params.push_back (std::make_pair (true, pn));
 282                                 } else {
 283                                         return false;
 284                                 }
 285                                 assert (pn == (int) _ctrl_params.size ());
 286
 287                                 //_param_desc[pn] = boost::shared_ptr<ParameterDescriptor> (new ParameterDescriptor());
 288                                 luabridge::LuaRef lr = i.value ();
 289
 290                                 if (type == "input") {
 291                                         _param_desc[pn].normal     = lr["default"].cast<float> ();
 292                                 } else {
 293                                         _param_desc[pn].normal     = lr["min"].cast<float> (); // output-port, no default
 294                                 }
 295                                 _param_desc[pn].lower        = lr["min"].cast<float> ();
 296                                 _param_desc[pn].upper        = lr["max"].cast<float> ();
 297                                 _param_desc[pn].toggled      = lr["toggled"].isBoolean () && (lr["toggled"]).cast<bool> ();
 298                                 _param_desc[pn].logarithmic  = lr["logarithmic"].isBoolean () && (lr["logarithmic"]).cast<bool> ();
 299                                 _param_desc[pn].integer_step = lr["integer"].isBoolean () && (lr["integer"]).cast<bool> ();
 300                                 _param_desc[pn].sr_dependent = lr["ratemult"].isBoolean () && (lr["ratemult"]).cast<bool> ();
 301                                 _param_desc[pn].enumeration  = lr["enum"].isBoolean () && (lr["enum"]).cast<bool> ();
 302
 303                                 if (lr["bypass"].isBoolean () && (lr["bypass"]).cast<bool> ()) {
 304                                         _designated_bypass_port = pn - 1; // lua table starts at 1.
 305                                 }
 306
 307                                 if (lr["unit"].isString ()) {
 308                                         std::string unit = lr["unit"].cast<std::string> ();
 309                                         if (unit == "dB")             { _param_desc[pn].unit = ParameterDescriptor::DB; }
 310                                         else if (unit == "Hz")        { _param_desc[pn].unit = ParameterDescriptor::HZ; }
 311                                         else if (unit == "Midi Note") { _param_desc[pn].unit = ParameterDescriptor::MIDI_NOTE; }
 312                                 }
 313                                 _param_desc[pn].label        = (lr["name"]).cast<std::string> ();
 314                                 _param_desc[pn].scale_points = parse_scale_points (&lr);
 315
 316                                 luabridge::LuaRef doc = lr["doc"];
 317                                 if (doc.isString ()) {
 318                                         _param_doc[pn] = doc.cast<std::string> ();
 319                                 } else {
 320                                         _param_doc[pn] = "";
 321                                 }
 322                                 assert (!(_param_desc[pn].toggled && _param_desc[pn].logarithmic));
 323                         }
 324                 }
 325         }
 326
 327         _control_data = new float[parameter_count ()];
 328         _shadow_data  = new float[parameter_count ()];
 329
 330         for (uint32_t i = 0; i < parameter_count (); ++i) {
 331                 if (parameter_is_input (i)) {
 332                         _control_data[i] = _shadow_data[i] = default_value (i);
 333                 }
 334         }
 335
 336         // expose ctrl-ports to global lua namespace
 337         luabridge::push <float *> (L, _control_data);
 338         lua_setglobal (L, "CtrlPorts");
 339
 340         return false; // no error
 341 }
 342
 343 bool
 344 LuaProc::can_support_io_configuration (const ChanCount& in, ChanCount& out, ChanCount* imprecise)
 345 {
 346         // caller must hold process lock (no concurrent calls to interpreter
 347         _output_configs.clear ();
 348
 349         lua_State* L = lua.getState ();
 350         luabridge::LuaRef ioconfig = luabridge::getGlobal (L, "dsp_ioconfig");
 351         if (!ioconfig.isFunction ()) {
 352                 return false;
 353         }
 354
 355         luabridge::LuaRef *_iotable = NULL; // can't use reference :(
 356         try {
 357                 luabridge::LuaRef iotable = ioconfig ();
 358                 if (iotable.isTable ()) {
 359                         _iotable = new luabridge::LuaRef (iotable);
 360                 }
 361         } catch (luabridge::LuaException const& e) {
 362                 return false;
 363         }
 364
 365         if (!_iotable) {
 366                 return false;
 367         }
 368
 369         // now we can reference it.
 370         luabridge::LuaRef iotable (*_iotable);
 371         delete _iotable;
 372
 373         if ((iotable).length () < 1) {
 374                 return false;
 375         }
 376
 377         const int audio_in = in.n_audio ();
 378         const int midi_in = in.n_midi ();
 379
 380         // preferred setting (provided by plugin_insert)
 381         const int preferred_out = out.n_audio ();
 382
 383         int midi_out = -1;
 384         int audio_out = -1;
 385         float penalty = 9999;
 386         bool found = false;
 387
 388 #define FOUNDCFG_PENALTY(in, out, p) {                              \
 389   _output_configs.insert (out);                                     \
 390   if (p < penalty) {                                                \
 391     audio_out = (out);                                              \
 392     midi_out = possible_midiout;                                    \
 393     if (imprecise) {                                                \
 394       imprecise->set (DataType::AUDIO, (in));                       \
 395       imprecise->set (DataType::MIDI, possible_midiin);             \
 396     }                                                               \
 397     penalty = p;                                                    \
 398     found = true;                                                   \
 399   }                                                                 \
 400 }
 401
 402 #define FOUNDCFG_IMPRECISE(in, out) {                               \
 403   const float p = fabsf ((float)(out) - preferred_out) *            \
 404                       (((out) > preferred_out) ? 1.1 : 1)           \
 405                 + fabsf ((float)(in) - audio_in) *                  \
 406                       (((in) > audio_in) ? 275 : 250);              \
 407   FOUNDCFG_PENALTY(in, out, p);                                     \
 408 }
 409
 410 #define FOUNDCFG(out)                                               \
 411   FOUNDCFG_IMPRECISE(audio_in, out)
 412
 413 #define ANYTHINGGOES                                                \
 414   _output_configs.insert (0);
 415
 416 #define UPTO(nch) {                                                 \
 417   for (int n = 1; n < nch; ++n) {                                   \
 418     _output_configs.insert (n);                                     \
 419   }                                                                 \
 420 }
 421
 422         if (imprecise) {
 423                 *imprecise = in;
 424         }
 425
 426         for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
 427                 luabridge::LuaRef io (i.value ());
 428                 if (!io.isTable()) {
 429                         continue;
 430                 }
 431
 432                 int possible_in = io["audio_in"].isNumber() ? io["audio_in"] : -1;
 433                 int possible_out = io["audio_out"].isNumber() ? io["audio_out"] : -1;
 434                 int possible_midiin = _has_midi_input ? 1 : 0;
 435                 int possible_midiout = _has_midi_output ? 1 : 0;
 436
 437                 if (midi_in > 0 && possible_midiin == 0 && !imprecise) {
 438                         continue;
 439                 }
 440
 441                 // exact match
 442                 if ((possible_in == audio_in) && (possible_out == preferred_out)) {
 443                         /* Set penalty so low that this output configuration
 444                          * will trump any other one */
 445                         FOUNDCFG_PENALTY(audio_in, preferred_out, -1);
 446                 }
 447
 448                 if (possible_out == 0 && possible_midiout == 0) {
 449                         /* skip configurations with no output at all */
 450                         continue;
 451                 }
 452
 453                 if (possible_in == -1 || possible_in == -2) {
 454                         /* wildcard for input */
 455                         if (possible_out == possible_in) {
 456                                 /* either both -1 or both -2 (invalid and
 457                                  * interpreted as both -1): out must match in */
 458                                 FOUNDCFG (audio_in);
 459                         } else if (possible_out == -3 - possible_in) {
 460                                 /* one is -1, the other is -2: any output configuration
 461                                  * possible, pick what the insert prefers */
 462                                 FOUNDCFG (preferred_out);
 463                                 ANYTHINGGOES;
 464                         } else if (possible_out < -2) {
 465                                 /* variable number of outputs up to -N,
 466                                  * invalid if in == -2 but we accept it anyway */
 467                                 FOUNDCFG (min (-possible_out, preferred_out));
 468                                 UPTO (-possible_out)
 469                         } else {
 470                                 /* exact number of outputs */
 471                                 FOUNDCFG (possible_out);
 472                         }
 473                 }
 474
 475                 if (possible_in < -2 || possible_in >= 0) {
 476                         /* specified number, exact or up to */
 477                         int desired_in;
 478                         if (possible_in >= 0) {
 479                                 /* configuration can only match possible_in */
 480                                 desired_in = possible_in;
 481                         } else {
 482                                 /* configuration can match up to -possible_in */
 483                                 desired_in = min (-possible_in, audio_in);
 484                         }
 485                         if (!imprecise && audio_in != desired_in) {
 486                                 /* skip that configuration, it cannot match
 487                                  * the required audio input count, and we
 488                                  * cannot ask for change via \imprecise */
 489                         } else if (possible_out == -1 || possible_out == -2) {
 490                                 /* any output configuration possible
 491                                  * out == -2 is invalid, interpreted as out == -1.
 492                                  * Really imprecise only if desired_in != audio_in */
 493                                 FOUNDCFG_IMPRECISE (desired_in, preferred_out);
 494                                 ANYTHINGGOES;
 495                         } else if (possible_out < -2) {
 496                                 /* variable number of outputs up to -N
 497                                  * not specified if in > 0, but we accept it anyway.
 498                                  * Really imprecise only if desired_in != audio_in */
 499                                 FOUNDCFG_IMPRECISE (desired_in, min (-possible_out, preferred_out));
 500                                 UPTO (-possible_out)
 501                         } else {
 502                                 /* exact number of outputs
 503                                  * Really imprecise only if desired_in != audio_in */
 504                                 FOUNDCFG_IMPRECISE (desired_in, possible_out);
 505                         }
 506                         // ideally we'll also find the closest, best matching
 507                         // input configuration with minimal output penalty...
 508                 }
 509
 510         }
 511
 512         if (!found) {
 513                 return false;
 514         }
 515
 516         if (imprecise) {
 517                 _selected_in = *imprecise;
 518         } else {
 519                 _selected_in = in;
 520         }
 521
 522         out.set (DataType::MIDI, midi_out);
 523         out.set (DataType::AUDIO, audio_out);
 524         _selected_out = out;
 525
 526         return true;
 527 }
 528
 529 bool
 530 LuaProc::configure_io (ChanCount in, ChanCount out)
 531 {
 532         in.set (DataType::MIDI, _has_midi_input ? 1 : 0);
 533         out.set (DataType::MIDI, _has_midi_output ? 1 : 0);
 534
 535         _info->n_inputs = _selected_in;
 536         _info->n_outputs = _selected_out;
 537
 538         // configure the DSP if needed
 539         if (in != _configured_in || out != _configured_out) {
 540                 lua_State* L = lua.getState ();
 541                 luabridge::LuaRef lua_dsp_configure = luabridge::getGlobal (L, "dsp_configure");
 542                 if (lua_dsp_configure.type () == LUA_TFUNCTION) {
 543                         try {
 544                                 luabridge::LuaRef io = lua_dsp_configure (&in, &out);
 545                                 if (io.isTable ()) {
 546                                         ChanCount lin (_selected_in);
 547                                         ChanCount lout (_selected_out);
 548
 549                                         if (io["audio_in"].type() == LUA_TNUMBER) {
 550                                                 const int c = io["audio_in"].cast<int> ();
 551                                                 if (c >= 0) {
 552                                                         lin.set (DataType::AUDIO, c);
 553                                                 }
 554                                         }
 555                                         if (io["audio_out"].type() == LUA_TNUMBER) {
 556                                                 const int c = io["audio_out"].cast<int> ();
 557                                                 if (c >= 0) {
 558                                                         lout.set (DataType::AUDIO, c);
 559                                                 }
 560                                         }
 561                                         if (io["midi_in"].type() == LUA_TNUMBER) {
 562                                                 const int c = io["midi_in"].cast<int> ();
 563                                                 if (c >= 0) {
 564                                                         lin.set (DataType::MIDI, c);
 565                                                 }
 566                                         }
 567                                         if (io["midi_out"].type() == LUA_TNUMBER) {
 568                                                 const int c = io["midi_out"].cast<int> ();
 569                                                 if (c >= 0) {
 570                                                         lout.set (DataType::MIDI, c);
 571                                                 }
 572                                         }
 573                                         _info->n_inputs = lin;
 574                                         _info->n_outputs = lout;
 575                                 }
 576                         } catch (luabridge::LuaException const& e) {
 577                                 PBD::error << "LuaException: " << e.what () << "\n";
 578 #ifndef NDEBUG
 579                                 std::cerr << "LuaException: " << e.what () << "\n";
 580 #endif
 581                                 return false;
 582                         }
 583                 }
 584         }
 585
 586         _configured_in = in;
 587         _configured_out = out;
 588
 589         return true;
 590 }
 591
 592 int
 593 LuaProc::connect_and_run (BufferSet& bufs,
 594                 framepos_t start, framepos_t end, double speed,
 595                 ChanMapping in, ChanMapping out,
 596                 pframes_t nframes, framecnt_t offset)
 597 {
 598         if (!_lua_dsp) {
 599                 return 0;
 600         }
 601
 602         Plugin::connect_and_run (bufs, start, end, speed, in, out, nframes, offset);
 603
 604         // This is needed for ARDOUR::Session requests :(
 605         if (! SessionEvent::has_per_thread_pool ()) {
 606                 char name[64];
 607                 snprintf (name, 64, "Proc-%p", this);
 608                 pthread_set_name (name);
 609                 SessionEvent::create_per_thread_pool (name, 64);
 610                 PBD::notify_event_loops_about_thread_creation (pthread_self(), name, 64);
 611         }
 612
 613         uint32_t const n = parameter_count ();
 614         for (uint32_t i = 0; i < n; ++i) {
 615                 if (parameter_is_control (i) && parameter_is_input (i)) {
 616                         _control_data[i] = _shadow_data[i];
 617                 }
 618         }
 619
 620 #ifdef WITH_LUAPROC_STATS
 621         int64_t t0 = g_get_monotonic_time ();
 622 #endif
 623
 624         try {
 625                 if (_lua_does_channelmapping) {
 626                         // run the DSP function
 627                         (*_lua_dsp)(&bufs, in, out, nframes, offset);
 628                 } else {
 629                         // map buffers
 630                         BufferSet& silent_bufs  = _session.get_silent_buffers (ChanCount (DataType::AUDIO, 1));
 631                         BufferSet& scratch_bufs = _session.get_scratch_buffers (ChanCount (DataType::AUDIO, 1));
 632
 633                         lua_State* L = lua.getState ();
 634                         luabridge::LuaRef in_map (luabridge::newTable (L));
 635                         luabridge::LuaRef out_map (luabridge::newTable (L));
 636
 637                         const uint32_t audio_in = _configured_in.n_audio ();
 638                         const uint32_t audio_out = _configured_out.n_audio ();
 639                         const uint32_t midi_in = _configured_in.n_midi ();
 640
 641                         for (uint32_t ap = 0; ap < audio_in; ++ap) {
 642                                 bool valid;
 643                                 const uint32_t buf_index = in.get(DataType::AUDIO, ap, &valid);
 644                                 if (valid) {
 645                                         in_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
 646                                 } else {
 647                                         in_map[ap + 1] = silent_bufs.get_audio (0).data (offset);
 648                                 }
 649                         }
 650                         for (uint32_t ap = 0; ap < audio_out; ++ap) {
 651                                 bool valid;
 652                                 const uint32_t buf_index = out.get(DataType::AUDIO, ap, &valid);
 653                                 if (valid) {
 654                                         out_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
 655                                 } else {
 656                                         out_map[ap + 1] = scratch_bufs.get_audio (0).data (offset);
 657                                 }
 658                         }
 659
 660                         luabridge::LuaRef lua_midi_src_tbl (luabridge::newTable (L));
 661                         int e = 1; // > 1 port, we merge events (unsorted)
 662                         for (uint32_t mp = 0; mp < midi_in; ++mp) {
 663                                 bool valid;
 664                                 const uint32_t idx = in.get(DataType::MIDI, mp, &valid);
 665                                 if (valid) {
 666                                         for (MidiBuffer::iterator m = bufs.get_midi(idx).begin();
 667                                                         m != bufs.get_midi(idx).end(); ++m, ++e) {
 668                                                 const Evoral::MIDIEvent<framepos_t> ev(*m, false);
 669                                                 luabridge::LuaRef lua_midi_data (luabridge::newTable (L));
 670                                                 const uint8_t* data = ev.buffer();
 671                                                 for (uint32_t i = 0; i < ev.size(); ++i) {
 672                                                         lua_midi_data [i + 1] = data[i];
 673                                                 }
 674                                                 luabridge::LuaRef lua_midi_event (luabridge::newTable (L));
 675                                                 lua_midi_event["time"] = 1 + (*m).time();
 676                                                 lua_midi_event["data"] = lua_midi_data;
 677                                                 lua_midi_src_tbl[e] = lua_midi_event;
 678                                         }
 679                                 }
 680                         }
 681
 682                         if (_has_midi_input) {
 683                                 // XXX TODO This needs a better solution than global namespace
 684                                 luabridge::push (L, lua_midi_src_tbl);
 685                                 lua_setglobal (L, "midiin");
 686                         }
 687
 688                         luabridge::LuaRef lua_midi_sink_tbl (luabridge::newTable (L));
 689                         if (_has_midi_output) {
 690                                 luabridge::push (L, lua_midi_sink_tbl);
 691                                 lua_setglobal (L, "midiout");
 692                         }
 693
 694                         // run the DSP function
 695                         (*_lua_dsp)(in_map, out_map, nframes);
 696
 697                         // copy back midi events
 698                         if (_has_midi_output && lua_midi_sink_tbl.isTable ()) {
 699                                 bool valid;
 700                                 const uint32_t idx = out.get(DataType::MIDI, 0, &valid);
 701                                 if (valid && bufs.count().n_midi() > idx) {
 702                                         MidiBuffer& mbuf = bufs.get_midi(idx);
 703                                         mbuf.silence(0, 0);
 704                                         for (luabridge::Iterator i (lua_midi_sink_tbl); !i.isNil (); ++i) {
 705                                                 if (!i.key ().isNumber ()) { continue; }
 706                                                 if (!i.value ()["time"].isNumber ()) { continue; }
 707                                                 if (!i.value ()["data"].isTable ()) { continue; }
 708                                                 luabridge::LuaRef data_tbl (i.value ()["data"]);
 709                                                 framepos_t tme = i.value ()["time"];
 710                                                 if (tme < 1 || tme > nframes) { continue; }
 711                                                 uint8_t data[64];
 712                                                 size_t size = 0;
 713                                                 for (luabridge::Iterator di (data_tbl); !di.isNil () && size < sizeof(data); ++di, ++size) {
 714                                                         data[size] = di.value ();
 715                                                 }
 716                                                 if (size > 0 && size < 64) {
 717                                                         mbuf.push_back(tme - 1, size, data);
 718                                                 }
 719                                         }
 720
 721                                 }
 722                         }
 723                 }
 724         } catch (luabridge::LuaException const& e) {
 725                 PBD::error << "LuaException: " << e.what () << "\n";
 726 #ifndef NDEBUG
 727                 std::cerr << "LuaException: " << e.what () << "\n";
 728 #endif
 729                 return -1;
 730         }
 731 #ifdef WITH_LUAPROC_STATS
 732         int64_t t1 = g_get_monotonic_time ();
 733 #endif
 734
 735         lua.collect_garbage_step ();
 736 #ifdef WITH_LUAPROC_STATS
 737         ++_stats_cnt;
 738         int64_t t2 = g_get_monotonic_time ();
 739         int64_t ela0 = t1 - t0;
 740         int64_t ela1 = t2 - t1;
 741         if (ela0 > _stats_max[0]) _stats_max[0] = ela0;
 742         if (ela1 > _stats_max[1]) _stats_max[1] = ela1;
 743         _stats_avg[0] += ela0;
 744         _stats_avg[1] += ela1;
 745 #endif
 746         return 0;
 747 }
 748
 749
 750 void
 751 LuaProc::add_state (XMLNode* root) const
 752 {
 753         XMLNode*    child;
 754         char        buf[32];
 755         LocaleGuard lg;
 756
 757         gchar* b64 = g_base64_encode ((const guchar*)_script.c_str (), _script.size ());
 758         std::string b64s (b64);
 759         g_free (b64);
 760         XMLNode* script_node = new XMLNode (X_("script"));
 761         script_node->add_property (X_("lua"), LUA_VERSION);
 762         script_node->add_content (b64s);
 763         root->add_child_nocopy (*script_node);
 764
 765         for (uint32_t i = 0; i < parameter_count(); ++i) {
 766                 if (parameter_is_input(i) && parameter_is_control(i)) {
 767                         child = new XMLNode("Port");
 768                         snprintf(buf, sizeof(buf), "%u", i);
 769                         child->add_property("id", std::string(buf));
 770                         snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
 771                         child->add_property("value", std::string(buf));
 772                         root->add_child_nocopy(*child);
 773                 }
 774         }
 775 }
 776
 777 int
 778 LuaProc::set_script_from_state (const XMLNode& node)
 779 {
 780         XMLNode* child;
 781         if (node.name () != state_node_name ()) {
 782                 return -1;
 783         }
 784
 785         if ((child = node.child (X_("script"))) != 0) {
 786                 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
 787                         if (!(*n)->is_content ()) { continue; }
 788                         gsize size;
 789                         guchar* buf = g_base64_decode ((*n)->content ().c_str (), &size);
 790                         _script = std::string ((const char*)buf, size);
 791                         g_free (buf);
 792                         if (load_script ()) {
 793                                 PBD::error << _("Failed to load Lua script from session state.") << endmsg;
 794 #ifndef NDEBUG
 795                                 std::cerr << "Failed Lua Script: " << _script << std::endl;
 796 #endif
 797                                 _script = "";
 798                         }
 799                         break;
 800                 }
 801         }
 802         if (_script.empty ()) {
 803                 PBD::error << _("Session State for LuaProcessor did not include a Lua script.") << endmsg;
 804                 return -1;
 805         }
 806         if (!_lua_dsp) {
 807                 PBD::error << _("Invalid/incompatible Lua script found for LuaProcessor.") << endmsg;
 808                 return -1;
 809         }
 810         return 0;
 811 }
 812
 813 int
 814 LuaProc::set_state (const XMLNode& node, int version)
 815 {
 816 #ifndef NO_PLUGIN_STATE
 817         XMLNodeList nodes;
 818         XMLProperty const * prop;
 819         XMLNodeConstIterator iter;
 820         XMLNode *child;
 821         const char *value;
 822         const char *port;
 823         uint32_t port_id;
 824 #endif
 825         LocaleGuard lg;
 826
 827         if (_script.empty ()) {
 828                 if (set_script_from_state (node)) {
 829                         return -1;
 830                 }
 831         }
 832
 833 #ifndef NO_PLUGIN_STATE
 834         if (node.name() != state_node_name()) {
 835                 error << _("Bad node sent to LuaProc::set_state") << endmsg;
 836                 return -1;
 837         }
 838
 839         nodes = node.children ("Port");
 840         for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
 841                 child = *iter;
 842                 if ((prop = child->property("id")) != 0) {
 843                         port = prop->value().c_str();
 844                 } else {
 845                         warning << _("LuaProc: port has no symbol, ignored") << endmsg;
 846                         continue;
 847                 }
 848                 if ((prop = child->property("value")) != 0) {
 849                         value = prop->value().c_str();
 850                 } else {
 851                         warning << _("LuaProc: port has no value, ignored") << endmsg;
 852                         continue;
 853                 }
 854                 sscanf (port, "%" PRIu32, &port_id);
 855                 set_parameter (port_id, atof(value));
 856         }
 857 #endif
 858
 859         return Plugin::set_state (node, version);
 860 }
 861
 862 uint32_t
 863 LuaProc::parameter_count () const
 864 {
 865         return _ctrl_params.size ();
 866 }
 867
 868 float
 869 LuaProc::default_value (uint32_t port)
 870 {
 871         if (_ctrl_params[port].first) {
 872                 assert (0);
 873                 return 0;
 874         }
 875         int lp = _ctrl_params[port].second;
 876         return _param_desc[lp].normal;
 877 }
 878
 879 void
 880 LuaProc::set_parameter (uint32_t port, float val)
 881 {
 882         assert (port < parameter_count ());
 883         if (get_parameter (port) == val) {
 884                 return;
 885         }
 886         _shadow_data[port] = val;
 887         Plugin::set_parameter (port, val);
 888 }
 889
 890 float
 891 LuaProc::get_parameter (uint32_t port) const
 892 {
 893         if (parameter_is_input (port)) {
 894                 return _shadow_data[port];
 895         } else {
 896                 return _control_data[port];
 897         }
 898 }
 899
 900 int
 901 LuaProc::get_parameter_descriptor (uint32_t port, ParameterDescriptor& desc) const
 902 {
 903         assert (port <= parameter_count ());
 904         int lp = _ctrl_params[port].second;
 905         const ParameterDescriptor& d (_param_desc.find(lp)->second);
 906
 907         desc.lower        = d.lower;
 908         desc.upper        = d.upper;
 909         desc.normal       = d.normal;
 910         desc.toggled      = d.toggled;
 911         desc.logarithmic  = d.logarithmic;
 912         desc.integer_step = d.integer_step;
 913         desc.sr_dependent = d.sr_dependent;
 914         desc.enumeration  = d.enumeration;
 915         desc.unit         = d.unit;
 916         desc.label        = d.label;
 917         desc.scale_points = d.scale_points;
 918
 919         desc.update_steps ();
 920         return 0;
 921 }
 922
 923 std::string
 924 LuaProc::get_parameter_docs (uint32_t port) const {
 925         assert (port <= parameter_count ());
 926         int lp = _ctrl_params[port].second;
 927         return _param_doc.find(lp)->second;
 928 }
 929
 930 uint32_t
 931 LuaProc::nth_parameter (uint32_t port, bool& ok) const
 932 {
 933         if (port < _ctrl_params.size ()) {
 934                 ok = true;
 935                 return port;
 936         }
 937         ok = false;
 938         return 0;
 939 }
 940
 941 bool
 942 LuaProc::parameter_is_input (uint32_t port) const
 943 {
 944         assert (port < _ctrl_params.size ());
 945         return (!_ctrl_params[port].first);
 946 }
 947
 948 bool
 949 LuaProc::parameter_is_output (uint32_t port) const
 950 {
 951         assert (port < _ctrl_params.size ());
 952         return (_ctrl_params[port].first);
 953 }
 954
 955 std::set<Evoral::Parameter>
 956 LuaProc::automatable () const
 957 {
 958         std::set<Evoral::Parameter> automatables;
 959         for (uint32_t i = 0; i < _ctrl_params.size (); ++i) {
 960                 if (parameter_is_input (i)) {
 961                         automatables.insert (automatables.end (), Evoral::Parameter (PluginAutomation, 0, i));
 962                 }
 963         }
 964         return automatables;
 965 }
 966
 967 std::string
 968 LuaProc::describe_parameter (Evoral::Parameter param)
 969 {
 970         if (param.type () == PluginAutomation && param.id () < parameter_count ()) {
 971                 int lp = _ctrl_params[param.id ()].second;
 972                 return _param_desc[lp].label;
 973         }
 974         return "??";
 975 }
 976
 977 void
 978 LuaProc::print_parameter (uint32_t param, char* buf, uint32_t len) const
 979 {
 980         if (buf && len) {
 981                 if (param < parameter_count ()) {
 982                         snprintf (buf, len, "%.3f", get_parameter (param));
 983                 } else {
 984                         strcat (buf, "0");
 985                 }
 986         }
 987 }
 988
 989 boost::shared_ptr<ScalePoints>
 990 LuaProc::parse_scale_points (luabridge::LuaRef* lr)
 991 {
 992         if (!(*lr)["scalepoints"].isTable()) {
 993                 return boost::shared_ptr<ScalePoints> ();
 994         }
 995
 996         int cnt = 0;
 997         boost::shared_ptr<ScalePoints> rv = boost::shared_ptr<ScalePoints>(new ScalePoints());
 998         luabridge::LuaRef scalepoints ((*lr)["scalepoints"]);
 999
1000         for (luabridge::Iterator i (scalepoints); !i.isNil (); ++i) {
1001                 if (!i.key ().isString ())    { continue; }
1002                 if (!i.value ().isNumber ())  { continue; }
1003                 rv->insert(make_pair(i.key ().cast<std::string> (),
1004                                         i.value ().cast<float> ()));
1005                 ++cnt;
1006         }
1007
1008         if (rv->size() > 0) {
1009                 return rv;
1010         }
1011         return boost::shared_ptr<ScalePoints> ();
1012 }
1013
1014 boost::shared_ptr<ScalePoints>
1015 LuaProc::get_scale_points (uint32_t port) const
1016 {
1017         int lp = _ctrl_params[port].second;
1018         return _param_desc.find(lp)->second.scale_points;
1019 }
1020
1021 void
1022 LuaProc::setup_lua_inline_gui (LuaState *lua_gui)
1023 {
1024         lua_State* LG = lua_gui->getState ();
1025         LuaBindings::stddef (LG);
1026         LuaBindings::common (LG);
1027         LuaBindings::dsp (LG);
1028
1029         lua_gui->Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
1030         lua_gui->do_command ("function ardour () end");
1031         lua_gui->do_command (_script);
1032
1033         // TODO think: use a weak-pointer here ?
1034         // (the GUI itself uses a shared ptr to this plugin, so we should be good)
1035         luabridge::getGlobalNamespace (LG)
1036                 .beginNamespace ("Ardour")
1037                 .beginClass <LuaProc> ("LuaProc")
1038                 .addFunction ("shmem", &LuaProc::instance_shm)
1039                 .addFunction ("table", &LuaProc::instance_ref)
1040                 .endClass ()
1041                 .endNamespace ();
1042
1043         luabridge::push <LuaProc *> (LG, this);
1044         lua_setglobal (LG, "self");
1045
1046         luabridge::push <float *> (LG, _shadow_data);
1047         lua_setglobal (LG, "CtrlPorts");
1048 }
1049 ////////////////////////////////////////////////////////////////////////////////
1050
1051 #include "ardour/search_paths.h"
1052 #include "sha1.c"
1053
1054 std::string
1055 LuaProc::preset_name_to_uri (const std::string& name) const
1056 {
1057         std::string uri ("urn:lua:");
1058         char hash[41];
1059         Sha1Digest s;
1060         sha1_init (&s);
1061         sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
1062         sha1_write (&s, (const uint8_t *) _script.c_str(), _script.size ());
1063         sha1_result_hash (&s, hash);
1064         return uri + hash;
1065 }
1066
1067 std::string
1068 LuaProc::presets_file () const
1069 {
1070         return string_compose ("lua-%1", _info->unique_id);
1071 }
1072
1073 XMLTree*
1074 LuaProc::presets_tree () const
1075 {
1076         XMLTree* t = new XMLTree;
1077         std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1078
1079         if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
1080                 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
1081                         error << _("Unable to create LuaProc presets directory") << endmsg;
1082                 };
1083         }
1084
1085         p = Glib::build_filename (p, presets_file ());
1086
1087         if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
1088                 t->set_root (new XMLNode (X_("LuaPresets")));
1089                 return t;
1090         }
1091
1092         t->set_filename (p);
1093         if (!t->read ()) {
1094                 delete t;
1095                 return 0;
1096         }
1097         return t;
1098 }
1099
1100 bool
1101 LuaProc::load_preset (PresetRecord r)
1102 {
1103         boost::shared_ptr<XMLTree> t (presets_tree ());
1104         if (t == 0) {
1105                 return false;
1106         }
1107
1108         XMLNode* root = t->root ();
1109         for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1110                 XMLProperty const * label = (*i)->property (X_("label"));
1111                 assert (label);
1112                 if (label->value() != r.label) {
1113                         continue;
1114                 }
1115
1116                 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
1117                         if ((*j)->name() == X_("Parameter")) {
1118                                 XMLProperty const * index = (*j)->property (X_("index"));
1119                                 XMLProperty const * value = (*j)->property (X_("value"));
1120                                 assert (index);
1121                                 assert (value);
1122                                 LocaleGuard lg;
1123                                 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
1124                         }
1125                 }
1126                 return Plugin::load_preset(r);
1127         }
1128         return false;
1129 }
1130
1131 std::string
1132 LuaProc::do_save_preset (std::string name) {
1133
1134         boost::shared_ptr<XMLTree> t (presets_tree ());
1135         if (t == 0) {
1136                 return "";
1137         }
1138
1139         std::string uri (preset_name_to_uri (name));
1140
1141         XMLNode* p = new XMLNode (X_("Preset"));
1142         p->add_property (X_("uri"), uri);
1143         p->add_property (X_("label"), name);
1144
1145         for (uint32_t i = 0; i < parameter_count(); ++i) {
1146                 if (parameter_is_input (i)) {
1147                         XMLNode* c = new XMLNode (X_("Parameter"));
1148                         c->add_property (X_("index"), string_compose ("%1", i));
1149                         c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
1150                         p->add_child_nocopy (*c);
1151                 }
1152         }
1153         t->root()->add_child_nocopy (*p);
1154
1155         std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1156         f = Glib::build_filename (f, presets_file ());
1157
1158         t->write (f);
1159         return uri;
1160 }
1161
1162 void
1163 LuaProc::do_remove_preset (std::string name)
1164 {
1165         boost::shared_ptr<XMLTree> t (presets_tree ());
1166         if (t == 0) {
1167                 return;
1168         }
1169         t->root()->remove_nodes_and_delete (X_("label"), name);
1170         std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1171         f = Glib::build_filename (f, presets_file ());
1172         t->write (f);
1173 }
1174
1175 void
1176 LuaProc::find_presets ()
1177 {
1178         boost::shared_ptr<XMLTree> t (presets_tree ());
1179         if (t) {
1180                 XMLNode* root = t->root ();
1181                 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1182
1183                         XMLProperty const * uri = (*i)->property (X_("uri"));
1184                         XMLProperty const * label = (*i)->property (X_("label"));
1185
1186                         assert (uri);
1187                         assert (label);
1188
1189                         PresetRecord r (uri->value(), label->value(), true);
1190                         _presets.insert (make_pair (r.uri, r));
1191                 }
1192         }
1193 }
1194
1195 ////////////////////////////////////////////////////////////////////////////////
1196
1197 LuaPluginInfo::LuaPluginInfo (LuaScriptInfoPtr lsi) {
1198         if (lsi->type != LuaScriptInfo::DSP) {
1199                 throw failed_constructor ();
1200         }
1201
1202         path = lsi->path;
1203         name = lsi->name;
1204         creator = lsi->author;
1205         category = lsi->category;
1206         unique_id = lsi->unique_id;
1207
1208         n_inputs.set (DataType::AUDIO, 1);
1209         n_outputs.set (DataType::AUDIO, 1);
1210         type = Lua;
1211
1212         _is_instrument = category == "Instrument";
1213 }
1214
1215 PluginPtr
1216 LuaPluginInfo::load (Session& session)
1217 {
1218         std::string script = "";
1219         if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
1220                 return PluginPtr ();
1221         }
1222
1223         try {
1224                 script = Glib::file_get_contents (path);
1225         } catch (Glib::FileError err) {
1226                 return PluginPtr ();
1227         }
1228
1229         if (script.empty ()) {
1230                 return PluginPtr ();
1231         }
1232
1233         try {
1234                 PluginPtr plugin (new LuaProc (session.engine (), session, script));
1235                 return plugin;
1236         } catch (failed_constructor& err) {
1237                 ;
1238         }
1239         return PluginPtr ();
1240 }
1241
1242 std::vector<Plugin::PresetRecord>
1243 LuaPluginInfo::get_presets (bool /*user_only*/) const
1244 {
1245         std::vector<Plugin::PresetRecord> p;
1246         XMLTree* t = new XMLTree;
1247         std::string pf = Glib::build_filename (ARDOUR::user_config_directory (), "presets", string_compose ("lua-%1", unique_id));
1248         if (Glib::file_test (pf, Glib::FILE_TEST_EXISTS)) {
1249                 t->set_filename (pf);
1250                 if (t->read ()) {
1251                         XMLNode* root = t->root ();
1252                         for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1253                                 XMLProperty const * uri = (*i)->property (X_("uri"));
1254                                 XMLProperty const * label = (*i)->property (X_("label"));
1255                                 p.push_back (Plugin::PresetRecord (uri->value(), label->value(), true));
1256                         }
1257                 }
1258         }
1259         delete t;
1260         return p;
1261 }