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