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/pthread_utils.h"
  26
  27 #include "ardour/audio_buffer.h"
  28 #include "ardour/buffer_set.h"
  29 #include "ardour/filesystem_paths.h"
  30 #include "ardour/luabindings.h"
  31 #include "ardour/luaproc.h"
  32 #include "ardour/luascripting.h"
  33 #include "ardour/midi_buffer.h"
  34 #include "ardour/plugin.h"
  35 #include "ardour/session.h"
  36
  37 #include "LuaBridge/LuaBridge.h"
  38
  39 #include "pbd/i18n.h"
  40
  41 using namespace ARDOUR;
  42 using namespace PBD;
  43
  44 LuaProc::LuaProc (AudioEngine& engine,
  45                   Session& session,
  46                   const std::string &script)
  47         : Plugin (engine, session)
  48         , _mempool ("LuaProc", 3145728)
  49 #ifdef USE_TLSF
  50         , lua (lua_newstate (&PBD::TLSF::lalloc, &_mempool))
  51 #elif defined USE_MALLOC
  52         , lua ()
  53 #else
  54         , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
  55 #endif
  56         , _lua_dsp (0)
  57         , _script (script)
  58         , _lua_does_channelmapping (false)
  59         , _lua_has_inline_display (false)
  60         , _designated_bypass_port (UINT32_MAX)
  61         , _control_data (0)
  62         , _shadow_data (0)
  63         , _configured (false)
  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", 3145728)
  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         , _origin (other._origin)
  90         , _lua_does_channelmapping (false)
  91         , _lua_has_inline_display (false)
  92         , _designated_bypass_port (UINT32_MAX)
  93         , _control_data (0)
  94         , _shadow_data (0)
  95         , _configured (false)
  96         , _has_midi_input (false)
  97         , _has_midi_output (false)
  98 {
  99         init ();
 100
 101         if (load_script ()) {
 102                 throw failed_constructor ();
 103         }
 104
 105         for (uint32_t i = 0; i < parameter_count (); ++i) {
 106                 _control_data[i] = other._shadow_data[i];
 107                 _shadow_data[i]  = other._shadow_data[i];
 108         }
 109 }
 110
 111 LuaProc::~LuaProc () {
 112 #ifdef WITH_LUAPROC_STATS
 113         if (_info && _stats_cnt > 0) {
 114                 printf ("LuaProc: '%s' run()  avg: %.3f  max: %.3f [ms]\n",
 115                                 _info->name.c_str (),
 116                                 0.0001f * _stats_avg[0] / (float) _stats_cnt,
 117                                 0.0001f * _stats_max[0]);
 118                 printf ("LuaProc: '%s' gc()   avg: %.3f  max: %.3f [ms]\n",
 119                                 _info->name.c_str (),
 120                                 0.0001f * _stats_avg[1] / (float) _stats_cnt,
 121                                 0.0001f * _stats_max[1]);
 122         }
 123 #endif
 124         lua.do_command ("collectgarbage();");
 125         delete (_lua_dsp);
 126         delete [] _control_data;
 127         delete [] _shadow_data;
 128 }
 129
 130 void
 131 LuaProc::init ()
 132 {
 133 #ifdef WITH_LUAPROC_STATS
 134         _stats_avg[0] = _stats_avg[1] = _stats_max[0] = _stats_max[1] = _stats_cnt = 0;
 135 #endif
 136
 137         lua.tweak_rt_gc ();
 138         lua.Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
 139         // register session object
 140         lua_State* L = lua.getState ();
 141         LuaBindings::stddef (L);
 142         LuaBindings::common (L);
 143         LuaBindings::dsp (L);
 144
 145         luabridge::getGlobalNamespace (L)
 146                 .beginNamespace ("Ardour")
 147                 .deriveClass <LuaProc, PBD::StatefulDestructible> ("LuaProc")
 148                 .addFunction ("queue_draw", &LuaProc::queue_draw)
 149                 .addFunction ("shmem", &LuaProc::instance_shm)
 150                 .addFunction ("table", &LuaProc::instance_ref)
 151                 .addFunction ("route", &LuaProc::route)
 152                 .addFunction ("unique_id", &LuaProc::unique_id)
 153                 .addFunction ("name", &LuaProc::name)
 154                 .endClass ()
 155                 .endNamespace ();
 156
 157         // add session to global lua namespace
 158         luabridge::push <Session *> (L, &_session);
 159         lua_setglobal (L, "Session");
 160
 161         // instance
 162         luabridge::push <LuaProc *> (L, this);
 163         lua_setglobal (L, "self");
 164
 165         // sandbox
 166         lua.sandbox (true);
 167 #if 0
 168         lua.do_command ("for n in pairs(_G) do print(n) end print ('----')"); // print global env
 169 #endif
 170         lua.do_command ("function ardour () end");
 171 }
 172
 173 boost::weak_ptr<Route>
 174 LuaProc::route () const
 175 {
 176         if (!_owner) {
 177                 return boost::weak_ptr<Route>();
 178         }
 179         return static_cast<Route*>(_owner)->weakroute ();
 180 }
 181
 182 void
 183 LuaProc::lua_print (std::string s) {
 184         std::cout <<"LuaProc: " << s << "\n";
 185         PBD::error << "LuaProc: " << s << "\n";
 186 }
 187
 188 bool
 189 LuaProc::load_script ()
 190 {
 191         assert (!_lua_dsp); // don't allow to re-initialize
 192         LuaPluginInfoPtr lpi;
 193
 194         // TODO: refine APIs; function arguments..
 195         // - perform channel-map in ardour (silent/scratch buffers) ?
 196         // - control-port API (explicit get/set functions ??)
 197         // - latency reporting (global var? ctrl-port? set-function ?)
 198         // - MIDI -> sparse table of events
 199         //     { [sample] => { Event }, .. }
 200         //   or  { { sample, Event }, .. }
 201
 202         try {
 203                 LuaScriptInfoPtr lsi = LuaScripting::script_info (_script);
 204                 lpi = LuaPluginInfoPtr (new LuaPluginInfo (lsi));
 205                 assert (lpi);
 206                 set_info (lpi);
 207                 _mempool.set_name ("LuaProc: " + lsi->name);
 208                 _docs = lsi->description;
 209         } catch (failed_constructor& err) {
 210                 return true;
 211         }
 212
 213         lua_State* L = lua.getState ();
 214         lua.do_command (_script);
 215
 216         // check if script has a DSP callback
 217         luabridge::LuaRef lua_dsp_run = luabridge::getGlobal (L, "dsp_run");
 218         luabridge::LuaRef lua_dsp_map = luabridge::getGlobal (L, "dsp_runmap");
 219
 220         if ((lua_dsp_run.type () != LUA_TFUNCTION) == (lua_dsp_map.type () != LUA_TFUNCTION)) {
 221                 return true;
 222         }
 223
 224         if (lua_dsp_run.type () == LUA_TFUNCTION) {
 225                 _lua_dsp = new luabridge::LuaRef (lua_dsp_run);
 226         }
 227         else if (lua_dsp_map.type () == LUA_TFUNCTION) {
 228                 _lua_dsp = new luabridge::LuaRef (lua_dsp_map);
 229                 _lua_does_channelmapping = true;
 230         }
 231         else {
 232                 assert (0);
 233         }
 234
 235         // initialize the DSP if needed
 236         luabridge::LuaRef lua_dsp_init = luabridge::getGlobal (L, "dsp_init");
 237         if (lua_dsp_init.type () == LUA_TFUNCTION) {
 238                 try {
 239                         lua_dsp_init (_session.nominal_frame_rate ());
 240                 } catch (luabridge::LuaException const& e) {
 241                 } catch (...) { }
 242         }
 243
 244         _ctrl_params.clear ();
 245
 246         luabridge::LuaRef lua_render = luabridge::getGlobal (L, "render_inline");
 247         if (lua_render.isFunction ()) {
 248                 _lua_has_inline_display = true;
 249         }
 250
 251         luabridge::LuaRef lua_params = luabridge::getGlobal (L, "dsp_params");
 252         if (lua_params.isFunction ()) {
 253
 254                 // call function // add try {} catch (luabridge::LuaException const& e)
 255                 luabridge::LuaRef params = lua_params ();
 256
 257                 if (params.isTable ()) {
 258
 259                         for (luabridge::Iterator i (params); !i.isNil (); ++i) {
 260                                 // required fields
 261                                 if (!i.key ().isNumber ())           { return false; }
 262                                 if (!i.value ().isTable ())          { return false; }
 263                                 if (!i.value ()["type"].isString ()) { return false; }
 264                                 if (!i.value ()["name"].isString ()) { return false; }
 265                                 if (!i.value ()["min"].isNumber ())  { return false; }
 266                                 if (!i.value ()["max"].isNumber ())  { return false; }
 267
 268                                 int pn = i.key ().cast<int> ();
 269                                 std::string type = i.value ()["type"].cast<std::string> ();
 270                                 if (type == "input") {
 271                                         if (!i.value ()["default"].isNumber ()) { return false; }
 272                                         _ctrl_params.push_back (std::make_pair (false, pn));
 273                                 }
 274                                 else if (type == "output") {
 275                                         _ctrl_params.push_back (std::make_pair (true, pn));
 276                                 } else {
 277                                         return false;
 278                                 }
 279                                 assert (pn == (int) _ctrl_params.size ());
 280
 281                                 //_param_desc[pn] = boost::shared_ptr<ParameterDescriptor> (new ParameterDescriptor());
 282                                 luabridge::LuaRef lr = i.value ();
 283
 284                                 if (type == "input") {
 285                                         _param_desc[pn].normal     = lr["default"].cast<float> ();
 286                                 } else {
 287                                         _param_desc[pn].normal     = lr["min"].cast<float> (); // output-port, no default
 288                                 }
 289                                 _param_desc[pn].lower        = lr["min"].cast<float> ();
 290                                 _param_desc[pn].upper        = lr["max"].cast<float> ();
 291                                 _param_desc[pn].toggled      = lr["toggled"].isBoolean () && (lr["toggled"]).cast<bool> ();
 292                                 _param_desc[pn].logarithmic  = lr["logarithmic"].isBoolean () && (lr["logarithmic"]).cast<bool> ();
 293                                 _param_desc[pn].integer_step = lr["integer"].isBoolean () && (lr["integer"]).cast<bool> ();
 294                                 _param_desc[pn].sr_dependent = lr["ratemult"].isBoolean () && (lr["ratemult"]).cast<bool> ();
 295                                 _param_desc[pn].enumeration  = lr["enum"].isBoolean () && (lr["enum"]).cast<bool> ();
 296
 297                                 if (lr["bypass"].isBoolean () && (lr["bypass"]).cast<bool> ()) {
 298                                         _designated_bypass_port = pn - 1; // lua table starts at 1.
 299                                 }
 300
 301                                 if (lr["unit"].isString ()) {
 302                                         std::string unit = lr["unit"].cast<std::string> ();
 303                                         if (unit == "dB")             { _param_desc[pn].unit = ParameterDescriptor::DB; }
 304                                         else if (unit == "Hz")        { _param_desc[pn].unit = ParameterDescriptor::HZ; }
 305                                         else if (unit == "Midi Note") { _param_desc[pn].unit = ParameterDescriptor::MIDI_NOTE; }
 306                                 }
 307                                 _param_desc[pn].label        = (lr["name"]).cast<std::string> ();
 308                                 _param_desc[pn].scale_points = parse_scale_points (&lr);
 309
 310                                 luabridge::LuaRef doc = lr["doc"];
 311                                 if (doc.isString ()) {
 312                                         _param_doc[pn] = doc.cast<std::string> ();
 313                                 } else {
 314                                         _param_doc[pn] = "";
 315                                 }
 316                                 assert (!(_param_desc[pn].toggled && _param_desc[pn].logarithmic));
 317                         }
 318                 }
 319         }
 320
 321         _control_data = new float[parameter_count ()];
 322         _shadow_data  = new float[parameter_count ()];
 323
 324         for (uint32_t i = 0; i < parameter_count (); ++i) {
 325                 if (parameter_is_input (i)) {
 326                         _control_data[i] = _shadow_data[i] = default_value (i);
 327                 }
 328         }
 329
 330         // expose ctrl-ports to global lua namespace
 331         luabridge::push <float *> (L, _control_data);
 332         lua_setglobal (L, "CtrlPorts");
 333
 334         return false; // no error
 335 }
 336
 337 bool
 338 LuaProc::can_support_io_configuration (const ChanCount& in, ChanCount& out, ChanCount* imprecise)
 339 {
 340         // caller must hold process lock (no concurrent calls to interpreter
 341         _output_configs.clear ();
 342
 343         lua_State* L = lua.getState ();
 344         luabridge::LuaRef ioconfig = luabridge::getGlobal (L, "dsp_ioconfig");
 345
 346         luabridge::LuaRef *_iotable = NULL; // can't use reference :(
 347
 348         if (ioconfig.isFunction ()) {
 349                 try {
 350                         luabridge::LuaRef iotable = ioconfig ();
 351                         if (iotable.isTable ()) {
 352                                 _iotable = new luabridge::LuaRef (iotable);
 353                         }
 354                 } catch (luabridge::LuaException const& e) {
 355                         _iotable = NULL;
 356                 } catch (...) {
 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                         } catch (...) {
 589                                 return false;
 590                         }
 591                 }
 592         }
 593
 594         _configured_in = in;
 595         _configured_out = out;
 596
 597         return true;
 598 }
 599
 600 int
 601 LuaProc::connect_and_run (BufferSet& bufs,
 602                 framepos_t start, framepos_t end, double speed,
 603                 ChanMapping in, ChanMapping out,
 604                 pframes_t nframes, framecnt_t offset)
 605 {
 606         if (!_lua_dsp) {
 607                 return 0;
 608         }
 609
 610         Plugin::connect_and_run (bufs, start, end, speed, in, out, nframes, offset);
 611
 612         // This is needed for ARDOUR::Session requests :(
 613         if (! SessionEvent::has_per_thread_pool ()) {
 614                 char name[64];
 615                 snprintf (name, 64, "Proc-%p", this);
 616                 pthread_set_name (name);
 617                 SessionEvent::create_per_thread_pool (name, 64);
 618                 PBD::notify_event_loops_about_thread_creation (pthread_self(), name, 64);
 619         }
 620
 621         uint32_t const n = parameter_count ();
 622         for (uint32_t i = 0; i < n; ++i) {
 623                 if (parameter_is_control (i) && parameter_is_input (i)) {
 624                         _control_data[i] = _shadow_data[i];
 625                 }
 626         }
 627
 628 #ifdef WITH_LUAPROC_STATS
 629         int64_t t0 = g_get_monotonic_time ();
 630 #endif
 631
 632         try {
 633                 if (_lua_does_channelmapping) {
 634                         // run the DSP function
 635                         (*_lua_dsp)(&bufs, in, out, nframes, offset);
 636                 } else {
 637                         // map buffers
 638                         BufferSet& silent_bufs  = _session.get_silent_buffers (ChanCount (DataType::AUDIO, 1));
 639                         BufferSet& scratch_bufs = _session.get_scratch_buffers (ChanCount (DataType::AUDIO, 1));
 640
 641                         lua_State* L = lua.getState ();
 642                         luabridge::LuaRef in_map (luabridge::newTable (L));
 643                         luabridge::LuaRef out_map (luabridge::newTable (L));
 644
 645                         const uint32_t audio_in = _configured_in.n_audio ();
 646                         const uint32_t audio_out = _configured_out.n_audio ();
 647                         const uint32_t midi_in = _configured_in.n_midi ();
 648
 649                         for (uint32_t ap = 0; ap < audio_in; ++ap) {
 650                                 bool valid;
 651                                 const uint32_t buf_index = in.get(DataType::AUDIO, ap, &valid);
 652                                 if (valid) {
 653                                         in_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
 654                                 } else {
 655                                         in_map[ap + 1] = silent_bufs.get_audio (0).data (offset);
 656                                 }
 657                         }
 658                         for (uint32_t ap = 0; ap < audio_out; ++ap) {
 659                                 bool valid;
 660                                 const uint32_t buf_index = out.get(DataType::AUDIO, ap, &valid);
 661                                 if (valid) {
 662                                         out_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
 663                                 } else {
 664                                         out_map[ap + 1] = scratch_bufs.get_audio (0).data (offset);
 665                                 }
 666                         }
 667
 668                         luabridge::LuaRef lua_midi_src_tbl (luabridge::newTable (L));
 669                         int e = 1; // > 1 port, we merge events (unsorted)
 670                         for (uint32_t mp = 0; mp < midi_in; ++mp) {
 671                                 bool valid;
 672                                 const uint32_t idx = in.get(DataType::MIDI, mp, &valid);
 673                                 if (valid) {
 674                                         for (MidiBuffer::iterator m = bufs.get_midi(idx).begin();
 675                                                         m != bufs.get_midi(idx).end(); ++m, ++e) {
 676                                                 const Evoral::Event<framepos_t> ev(*m, false);
 677                                                 luabridge::LuaRef lua_midi_data (luabridge::newTable (L));
 678                                                 const uint8_t* data = ev.buffer();
 679                                                 for (uint32_t i = 0; i < ev.size(); ++i) {
 680                                                         lua_midi_data [i + 1] = data[i];
 681                                                 }
 682                                                 luabridge::LuaRef lua_midi_event (luabridge::newTable (L));
 683                                                 lua_midi_event["time"] = 1 + (*m).time();
 684                                                 lua_midi_event["data"] = lua_midi_data;
 685                                                 lua_midi_event["bytes"] = data;
 686                                                 lua_midi_event["size"] = ev.size();
 687                                                 lua_midi_src_tbl[e] = lua_midi_event;
 688                                         }
 689                                 }
 690                         }
 691
 692                         if (_has_midi_input) {
 693                                 // XXX TODO This needs a better solution than global namespace
 694                                 luabridge::push (L, lua_midi_src_tbl);
 695                                 lua_setglobal (L, "midiin");
 696                         }
 697
 698                         luabridge::LuaRef lua_midi_sink_tbl (luabridge::newTable (L));
 699                         if (_has_midi_output) {
 700                                 luabridge::push (L, lua_midi_sink_tbl);
 701                                 lua_setglobal (L, "midiout");
 702                         }
 703
 704                         // run the DSP function
 705                         (*_lua_dsp)(in_map, out_map, nframes);
 706
 707                         // copy back midi events
 708                         if (_has_midi_output && lua_midi_sink_tbl.isTable ()) {
 709                                 bool valid;
 710                                 const uint32_t idx = out.get(DataType::MIDI, 0, &valid);
 711                                 if (valid && bufs.count().n_midi() > idx) {
 712                                         MidiBuffer& mbuf = bufs.get_midi(idx);
 713                                         mbuf.silence(0, 0);
 714                                         for (luabridge::Iterator i (lua_midi_sink_tbl); !i.isNil (); ++i) {
 715                                                 if (!i.key ().isNumber ()) { continue; }
 716                                                 if (!i.value ()["time"].isNumber ()) { continue; }
 717                                                 if (!i.value ()["data"].isTable ()) { continue; }
 718                                                 luabridge::LuaRef data_tbl (i.value ()["data"]);
 719                                                 framepos_t tme = i.value ()["time"];
 720                                                 if (tme < 1 || tme > nframes) { continue; }
 721                                                 uint8_t data[64];
 722                                                 size_t size = 0;
 723                                                 for (luabridge::Iterator di (data_tbl); !di.isNil () && size < sizeof(data); ++di, ++size) {
 724                                                         data[size] = di.value ();
 725                                                 }
 726                                                 if (size > 0 && size < 64) {
 727                                                         mbuf.push_back(tme - 1, size, data);
 728                                                 }
 729                                         }
 730
 731                                 }
 732                         }
 733                 }
 734         } catch (luabridge::LuaException const& e) {
 735                 PBD::error << "LuaException: " << e.what () << "\n";
 736 #ifndef NDEBUG
 737                 std::cerr << "LuaException: " << e.what () << "\n";
 738 #endif
 739                 return -1;
 740         } catch (...) {
 741                 return -1;
 742         }
 743 #ifdef WITH_LUAPROC_STATS
 744         int64_t t1 = g_get_monotonic_time ();
 745 #endif
 746
 747         lua.collect_garbage_step ();
 748 #ifdef WITH_LUAPROC_STATS
 749         ++_stats_cnt;
 750         int64_t t2 = g_get_monotonic_time ();
 751         int64_t ela0 = t1 - t0;
 752         int64_t ela1 = t2 - t1;
 753         if (ela0 > _stats_max[0]) _stats_max[0] = ela0;
 754         if (ela1 > _stats_max[1]) _stats_max[1] = ela1;
 755         _stats_avg[0] += ela0;
 756         _stats_avg[1] += ela1;
 757 #endif
 758         return 0;
 759 }
 760
 761
 762 void
 763 LuaProc::add_state (XMLNode* root) const
 764 {
 765         XMLNode*    child;
 766
 767         gchar* b64 = g_base64_encode ((const guchar*)_script.c_str (), _script.size ());
 768         std::string b64s (b64);
 769         g_free (b64);
 770         XMLNode* script_node = new XMLNode (X_("script"));
 771         script_node->set_property (X_("lua"), LUA_VERSION);
 772         script_node->set_property (X_("origin"), _origin);
 773         script_node->add_content (b64s);
 774         root->add_child_nocopy (*script_node);
 775
 776         for (uint32_t i = 0; i < parameter_count(); ++i) {
 777                 if (parameter_is_input(i) && parameter_is_control(i)) {
 778                         child = new XMLNode("Port");
 779                         child->set_property("id", i);
 780                         child->set_property("value", _shadow_data[i]);
 781                         root->add_child_nocopy(*child);
 782                 }
 783         }
 784 }
 785
 786 int
 787 LuaProc::set_script_from_state (const XMLNode& node)
 788 {
 789         XMLNode* child;
 790         if (node.name () != state_node_name ()) {
 791                 return -1;
 792         }
 793
 794         if ((child = node.child (X_("script"))) != 0) {
 795                 XMLProperty const* prop;
 796                 if ((prop = node.property ("origin")) != 0) {
 797                         _origin = prop->value();
 798                 }
 799                 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
 800                         if (!(*n)->is_content ()) { continue; }
 801                         gsize size;
 802                         guchar* buf = g_base64_decode ((*n)->content ().c_str (), &size);
 803                         _script = std::string ((const char*)buf, size);
 804                         g_free (buf);
 805                         if (load_script ()) {
 806                                 PBD::error << _("Failed to load Lua script from session state.") << endmsg;
 807 #ifndef NDEBUG
 808                                 std::cerr << "Failed Lua Script: " << _script << std::endl;
 809 #endif
 810                                 _script = "";
 811                         }
 812                         break;
 813                 }
 814         }
 815         if (_script.empty ()) {
 816                 PBD::error << _("Session State for LuaProcessor did not include a Lua script.") << endmsg;
 817                 return -1;
 818         }
 819         if (!_lua_dsp) {
 820                 PBD::error << _("Invalid/incompatible Lua script found for LuaProcessor.") << endmsg;
 821                 return -1;
 822         }
 823         return 0;
 824 }
 825
 826 int
 827 LuaProc::set_state (const XMLNode& node, int version)
 828 {
 829 #ifndef NO_PLUGIN_STATE
 830         XMLNodeList nodes;
 831         XMLNodeConstIterator iter;
 832         XMLNode *child;
 833 #endif
 834
 835         if (_script.empty ()) {
 836                 if (set_script_from_state (node)) {
 837                         return -1;
 838                 }
 839         }
 840
 841 #ifndef NO_PLUGIN_STATE
 842         if (node.name() != state_node_name()) {
 843                 error << _("Bad node sent to LuaProc::set_state") << endmsg;
 844                 return -1;
 845         }
 846
 847         nodes = node.children ("Port");
 848         for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
 849                 child = *iter;
 850
 851                 uint32_t port_id;
 852                 float value;
 853
 854                 if (!child->get_property("id", port_id)) {
 855                         warning << _("LuaProc: port has no symbol, ignored") << endmsg;
 856                         continue;
 857                 }
 858
 859                 if (!child->get_property("value", value)) {
 860                         warning << _("LuaProc: port has no value, ignored") << endmsg;
 861                         continue;
 862                 }
 863
 864                 set_parameter (port_id, value);
 865         }
 866 #endif
 867
 868         return Plugin::set_state (node, version);
 869 }
 870
 871 uint32_t
 872 LuaProc::parameter_count () const
 873 {
 874         return _ctrl_params.size ();
 875 }
 876
 877 float
 878 LuaProc::default_value (uint32_t port)
 879 {
 880         if (_ctrl_params[port].first) {
 881                 assert (0);
 882                 return 0;
 883         }
 884         int lp = _ctrl_params[port].second;
 885         return _param_desc[lp].normal;
 886 }
 887
 888 void
 889 LuaProc::set_parameter (uint32_t port, float val)
 890 {
 891         assert (port < parameter_count ());
 892         if (get_parameter (port) == val) {
 893                 return;
 894         }
 895         _shadow_data[port] = val;
 896         Plugin::set_parameter (port, val);
 897 }
 898
 899 float
 900 LuaProc::get_parameter (uint32_t port) const
 901 {
 902         if (parameter_is_input (port)) {
 903                 return _shadow_data[port];
 904         } else {
 905                 return _control_data[port];
 906         }
 907 }
 908
 909 int
 910 LuaProc::get_parameter_descriptor (uint32_t port, ParameterDescriptor& desc) const
 911 {
 912         assert (port <= parameter_count ());
 913         int lp = _ctrl_params[port].second;
 914         const ParameterDescriptor& d (_param_desc.find(lp)->second);
 915
 916         desc.lower        = d.lower;
 917         desc.upper        = d.upper;
 918         desc.normal       = d.normal;
 919         desc.toggled      = d.toggled;
 920         desc.logarithmic  = d.logarithmic;
 921         desc.integer_step = d.integer_step;
 922         desc.sr_dependent = d.sr_dependent;
 923         desc.enumeration  = d.enumeration;
 924         desc.unit         = d.unit;
 925         desc.label        = d.label;
 926         desc.scale_points = d.scale_points;
 927
 928         desc.update_steps ();
 929         return 0;
 930 }
 931
 932 std::string
 933 LuaProc::get_parameter_docs (uint32_t port) const {
 934         assert (port <= parameter_count ());
 935         int lp = _ctrl_params[port].second;
 936         return _param_doc.find(lp)->second;
 937 }
 938
 939 uint32_t
 940 LuaProc::nth_parameter (uint32_t port, bool& ok) const
 941 {
 942         if (port < _ctrl_params.size ()) {
 943                 ok = true;
 944                 return port;
 945         }
 946         ok = false;
 947         return 0;
 948 }
 949
 950 bool
 951 LuaProc::parameter_is_input (uint32_t port) const
 952 {
 953         assert (port < _ctrl_params.size ());
 954         return (!_ctrl_params[port].first);
 955 }
 956
 957 bool
 958 LuaProc::parameter_is_output (uint32_t port) const
 959 {
 960         assert (port < _ctrl_params.size ());
 961         return (_ctrl_params[port].first);
 962 }
 963
 964 std::set<Evoral::Parameter>
 965 LuaProc::automatable () const
 966 {
 967         std::set<Evoral::Parameter> automatables;
 968         for (uint32_t i = 0; i < _ctrl_params.size (); ++i) {
 969                 if (parameter_is_input (i)) {
 970                         automatables.insert (automatables.end (), Evoral::Parameter (PluginAutomation, 0, i));
 971                 }
 972         }
 973         return automatables;
 974 }
 975
 976 std::string
 977 LuaProc::describe_parameter (Evoral::Parameter param)
 978 {
 979         if (param.type () == PluginAutomation && param.id () < parameter_count ()) {
 980                 int lp = _ctrl_params[param.id ()].second;
 981                 return _param_desc[lp].label;
 982         }
 983         return "??";
 984 }
 985
 986 void
 987 LuaProc::print_parameter (uint32_t param, char* buf, uint32_t len) const
 988 {
 989         if (buf && len) {
 990                 if (param < parameter_count ()) {
 991                         snprintf (buf, len, "%.3f", get_parameter (param));
 992                 } else {
 993                         strcat (buf, "0");
 994                 }
 995         }
 996 }
 997
 998 boost::shared_ptr<ScalePoints>
 999 LuaProc::parse_scale_points (luabridge::LuaRef* lr)
1000 {
1001         if (!(*lr)["scalepoints"].isTable()) {
1002                 return boost::shared_ptr<ScalePoints> ();
1003         }
1004
1005         int cnt = 0;
1006         boost::shared_ptr<ScalePoints> rv = boost::shared_ptr<ScalePoints>(new ScalePoints());
1007         luabridge::LuaRef scalepoints ((*lr)["scalepoints"]);
1008
1009         for (luabridge::Iterator i (scalepoints); !i.isNil (); ++i) {
1010                 if (!i.key ().isString ())    { continue; }
1011                 if (!i.value ().isNumber ())  { continue; }
1012                 rv->insert(make_pair(i.key ().cast<std::string> (),
1013                                         i.value ().cast<float> ()));
1014                 ++cnt;
1015         }
1016
1017         if (rv->size() > 0) {
1018                 return rv;
1019         }
1020         return boost::shared_ptr<ScalePoints> ();
1021 }
1022
1023 boost::shared_ptr<ScalePoints>
1024 LuaProc::get_scale_points (uint32_t port) const
1025 {
1026         int lp = _ctrl_params[port].second;
1027         return _param_desc.find(lp)->second.scale_points;
1028 }
1029
1030 void
1031 LuaProc::setup_lua_inline_gui (LuaState *lua_gui)
1032 {
1033         lua_State* LG = lua_gui->getState ();
1034         LuaBindings::stddef (LG);
1035         LuaBindings::common (LG);
1036         LuaBindings::dsp (LG);
1037         LuaBindings::osc (LG);
1038
1039         lua_gui->Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
1040         lua_gui->do_command ("function ardour () end");
1041         lua_gui->do_command (_script);
1042
1043         // TODO think: use a weak-pointer here ?
1044         // (the GUI itself uses a shared ptr to this plugin, so we should be good)
1045         luabridge::getGlobalNamespace (LG)
1046                 .beginNamespace ("Ardour")
1047                 .beginClass <LuaProc> ("LuaProc")
1048                 .addFunction ("shmem", &LuaProc::instance_shm)
1049                 .addFunction ("table", &LuaProc::instance_ref)
1050                 .endClass ()
1051                 .endNamespace ();
1052
1053         luabridge::push <LuaProc *> (LG, this);
1054         lua_setglobal (LG, "self");
1055
1056         luabridge::push <float *> (LG, _control_data);
1057         lua_setglobal (LG, "CtrlPorts");
1058 }
1059 ////////////////////////////////////////////////////////////////////////////////
1060
1061 #include "ardour/search_paths.h"
1062 #include "sha1.c"
1063
1064 std::string
1065 LuaProc::preset_name_to_uri (const std::string& name) const
1066 {
1067         std::string uri ("urn:lua:");
1068         char hash[41];
1069         Sha1Digest s;
1070         sha1_init (&s);
1071         sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
1072         sha1_write (&s, (const uint8_t *) _script.c_str(), _script.size ());
1073         sha1_result_hash (&s, hash);
1074         return uri + hash;
1075 }
1076
1077 std::string
1078 LuaProc::presets_file () const
1079 {
1080         return string_compose ("lua-%1", _info->unique_id);
1081 }
1082
1083 XMLTree*
1084 LuaProc::presets_tree () const
1085 {
1086         XMLTree* t = new XMLTree;
1087         std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1088
1089         if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
1090                 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
1091                         error << _("Unable to create LuaProc presets directory") << endmsg;
1092                 };
1093         }
1094
1095         p = Glib::build_filename (p, presets_file ());
1096
1097         if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
1098                 t->set_root (new XMLNode (X_("LuaPresets")));
1099                 return t;
1100         }
1101
1102         t->set_filename (p);
1103         if (!t->read ()) {
1104                 delete t;
1105                 return 0;
1106         }
1107         return t;
1108 }
1109
1110 bool
1111 LuaProc::load_preset (PresetRecord r)
1112 {
1113         boost::shared_ptr<XMLTree> t (presets_tree ());
1114         if (t == 0) {
1115                 return false;
1116         }
1117
1118         XMLNode* root = t->root ();
1119         for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1120                 std::string str;
1121                 if (!(*i)->get_property (X_("label"), str)) {
1122                         assert (false);
1123                 }
1124                 if (str != r.label) {
1125                         continue;
1126                 }
1127
1128                 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
1129                         if ((*j)->name() == X_("Parameter")) {
1130                                 uint32_t index;
1131                                 float value;
1132                                 if (!(*j)->get_property (X_("index"), index) ||
1133                                     !(*j)->get_property (X_("value"), value)) {
1134                                         assert (false);
1135                                 }
1136                                 set_parameter (index, value);
1137                                 PresetPortSetValue (index, value); /* EMIT SIGNAL */
1138                         }
1139                 }
1140                 return Plugin::load_preset(r);
1141         }
1142         return false;
1143 }
1144
1145 std::string
1146 LuaProc::do_save_preset (std::string name) {
1147
1148         boost::shared_ptr<XMLTree> t (presets_tree ());
1149         if (t == 0) {
1150                 return "";
1151         }
1152
1153         // prevent dups -- just in case
1154         t->root()->remove_nodes_and_delete (X_("label"), name);
1155
1156         std::string uri (preset_name_to_uri (name));
1157
1158         XMLNode* p = new XMLNode (X_("Preset"));
1159         p->set_property (X_("uri"), uri);
1160         p->set_property (X_("label"), name);
1161
1162         for (uint32_t i = 0; i < parameter_count(); ++i) {
1163                 if (parameter_is_input (i)) {
1164                         XMLNode* c = new XMLNode (X_("Parameter"));
1165                         c->set_property (X_("index"), i);
1166                         c->set_property (X_("value"), get_parameter (i));
1167                         p->add_child_nocopy (*c);
1168                 }
1169         }
1170         t->root()->add_child_nocopy (*p);
1171
1172         std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1173         f = Glib::build_filename (f, presets_file ());
1174
1175         t->write (f);
1176         return uri;
1177 }
1178
1179 void
1180 LuaProc::do_remove_preset (std::string name)
1181 {
1182         boost::shared_ptr<XMLTree> t (presets_tree ());
1183         if (t == 0) {
1184                 return;
1185         }
1186         t->root()->remove_nodes_and_delete (X_("label"), name);
1187         std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1188         f = Glib::build_filename (f, presets_file ());
1189         t->write (f);
1190 }
1191
1192 void
1193 LuaProc::find_presets ()
1194 {
1195         boost::shared_ptr<XMLTree> t (presets_tree ());
1196         if (t) {
1197                 XMLNode* root = t->root ();
1198                 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1199                         std::string uri;
1200                         std::string label;
1201
1202                         if (!(*i)->get_property (X_("uri"), uri) || !(*i)->get_property (X_("label"), label)) {
1203                                 assert (false);
1204                         }
1205
1206                         PresetRecord r (uri, label, true);
1207                         _presets.insert (make_pair (r.uri, r));
1208                 }
1209         }
1210 }
1211
1212 ////////////////////////////////////////////////////////////////////////////////
1213
1214 LuaPluginInfo::LuaPluginInfo (LuaScriptInfoPtr lsi) {
1215         if (lsi->type != LuaScriptInfo::DSP) {
1216                 throw failed_constructor ();
1217         }
1218
1219         path = lsi->path;
1220         name = lsi->name;
1221         creator = lsi->author;
1222         category = lsi->category;
1223         unique_id = lsi->unique_id;
1224
1225         n_inputs.set (DataType::AUDIO, 1);
1226         n_outputs.set (DataType::AUDIO, 1);
1227         type = Lua;
1228
1229         _is_instrument = category == "Instrument";
1230 }
1231
1232 PluginPtr
1233 LuaPluginInfo::load (Session& session)
1234 {
1235         std::string script = "";
1236         if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
1237                 return PluginPtr ();
1238         }
1239
1240         try {
1241                 script = Glib::file_get_contents (path);
1242         } catch (Glib::FileError err) {
1243                 return PluginPtr ();
1244         }
1245
1246         if (script.empty ()) {
1247                 return PluginPtr ();
1248         }
1249
1250         try {
1251                 LuaProc* lp = new LuaProc (session.engine (), session, script);
1252                 lp->set_origin (path);
1253                 PluginPtr plugin (lp);
1254                 return plugin;
1255         } catch (failed_constructor& err) {
1256                 ;
1257         }
1258         return PluginPtr ();
1259 }
1260
1261 std::vector<Plugin::PresetRecord>
1262 LuaPluginInfo::get_presets (bool /*user_only*/) const
1263 {
1264         std::vector<Plugin::PresetRecord> p;
1265         XMLTree* t = new XMLTree;
1266         std::string pf = Glib::build_filename (ARDOUR::user_config_directory (), "presets", string_compose ("lua-%1", unique_id));
1267         if (Glib::file_test (pf, Glib::FILE_TEST_EXISTS)) {
1268                 t->set_filename (pf);
1269                 if (t->read ()) {
1270                         XMLNode* root = t->root ();
1271                         for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1272                                 XMLProperty const * uri = (*i)->property (X_("uri"));
1273                                 XMLProperty const * label = (*i)->property (X_("label"));
1274                                 p.push_back (Plugin::PresetRecord (uri->value(), label->value(), true));
1275                         }
1276                 }
1277         }
1278         delete t;
1279         return p;
1280 }