libs/ardour/luaproc.cc

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