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   float p = fabsf ((float)(out) - preferred_out) ;                  \
 404   if (in != audio_in) {                                             \
 405     p += 1000;                                                      \
 406   }                                                                 \
 407   if ((out) > preferred_out) { p *= 1.1; }                          \
 408   FOUNDCFG_PENALTY(in, out, p);                                     \
 409 }
 410
 411 #define FOUNDCFG(out)                                               \
 412   FOUNDCFG_IMPRECISE(audio_in, out)
 413
 414 #define ANYTHINGGOES                                                \
 415   _output_configs.insert (0);
 416
 417 #define UPTO(nch) {                                                 \
 418   for (int n = 1; n < nch; ++n) {                                   \
 419     _output_configs.insert (n);                                     \
 420   }                                                                 \
 421 }
 422
 423         if (imprecise) {
 424                 *imprecise = in;
 425         }
 426
 427         for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
 428                 luabridge::LuaRef io (i.value ());
 429                 if (!io.isTable()) {
 430                         continue;
 431                 }
 432
 433                 int possible_in = io["audio_in"].isNumber() ? io["audio_in"] : -1;
 434                 int possible_out = io["audio_out"].isNumber() ? io["audio_out"] : -1;
 435                 int possible_midiin = _has_midi_input ? 1 : 0;
 436                 int possible_midiout = _has_midi_output ? 1 : 0;
 437
 438                 if (midi_in > 0 && possible_midiin == 0 && !imprecise) {
 439                         continue;
 440                 }
 441
 442                 // exact match
 443                 if ((possible_in == audio_in) && (possible_out == preferred_out)) {
 444                         /* Set penalty so low that this output configuration
 445                          * will trump any other one */
 446                         FOUNDCFG_PENALTY(audio_in, preferred_out, -1);
 447                 }
 448
 449                 // "imprecise" matches
 450                 if (possible_out == 0) {
 451                         /* skip configurations with no audio output, unless
 452                          * the plugin is a midi filter or generator */
 453                         if (possible_in == 0 && _has_midi_output) {
 454                                 if (audio_in == 0) {
 455                                         FOUNDCFG(possible_out);
 456                                         break;
 457                                 } else if (imprecise) {
 458                                         // TODO hide audio input from plugin
 459                                         FOUNDCFG_IMPRECISE (possible_in, possible_out);
 460                                 }
 461                         }
 462                         continue;
 463                 }
 464
 465                 if (possible_in == -1 || possible_in == -2) {
 466                         /* wildcard for input */
 467                         if (possible_out == possible_in) {
 468                                 /* either both -1 or both -2 (invalid and
 469                                  * interpreted as both -1): out must match in */
 470                                 FOUNDCFG (audio_in);
 471                         } else if (possible_out == -3 - possible_in) {
 472                                 /* one is -1, the other is -2: any output configuration
 473                                  * possible, pick what the insert prefers */
 474                                 FOUNDCFG (preferred_out);
 475                                 ANYTHINGGOES;
 476                         } else if (possible_out < -2) {
 477                                 /* variable number of outputs up to -N,
 478                                  * invalid if in == -2 but we accept it anyway */
 479                                 FOUNDCFG (min (-possible_out, preferred_out));
 480                                 UPTO (-possible_out)
 481                         } else {
 482                                 /* exact number of outputs */
 483                                 FOUNDCFG (possible_out);
 484                         }
 485                 }
 486
 487                 if (possible_in < -2 || possible_in >= 0) {
 488                         /* specified number, exact or up to */
 489                         int desired_in;
 490                         if (possible_in >= 0) {
 491                                 /* configuration can only match possible_in */
 492                                 desired_in = possible_in;
 493                         } else {
 494                                 /* configuration can match up to -possible_in */
 495                                 desired_in = min (-possible_in, audio_in);
 496                         }
 497                         if (!imprecise && audio_in != desired_in) {
 498                                 /* skip that configuration, it cannot match
 499                                  * the required audio input count, and we
 500                                  * cannot ask for change via \imprecise */
 501                         } else if (possible_out == -1 || possible_out == -2) {
 502                                 /* any output configuration possible
 503                                  * out == -2 is invalid, interpreted as out == -1.
 504                                  * Really imprecise only if desired_in != audio_in */
 505                                 FOUNDCFG_IMPRECISE (desired_in, preferred_out);
 506                                 ANYTHINGGOES;
 507                         } else if (possible_out < -2) {
 508                                 /* variable number of outputs up to -N
 509                                  * not specified if in > 0, but we accept it anyway.
 510                                  * Really imprecise only if desired_in != audio_in */
 511                                 FOUNDCFG_IMPRECISE (desired_in, min (-possible_out, preferred_out));
 512                                 UPTO (-possible_out)
 513                         } else {
 514                                 /* exact number of outputs
 515                                  * Really imprecise only if desired_in != audio_in */
 516                                 FOUNDCFG_IMPRECISE (desired_in, possible_out);
 517                         }
 518                         // ideally we'll also find the closest, best matching
 519                         // input configuration with minimal output penalty...
 520                 }
 521
 522         }
 523
 524         if (!found) {
 525                 return false;
 526         }
 527
 528         if (imprecise) {
 529                 _selected_in = *imprecise;
 530         } else {
 531                 _selected_in = in;
 532         }
 533
 534         out.set (DataType::MIDI, midi_out);
 535         out.set (DataType::AUDIO, audio_out);
 536         _selected_out = out;
 537
 538         return true;
 539 }
 540
 541 bool
 542 LuaProc::configure_io (ChanCount in, ChanCount out)
 543 {
 544         in.set (DataType::MIDI, _has_midi_input ? 1 : 0);
 545         out.set (DataType::MIDI, _has_midi_output ? 1 : 0);
 546
 547         _info->n_inputs = _selected_in;
 548         _info->n_outputs = _selected_out;
 549
 550         // configure the DSP if needed
 551         if (in != _configured_in || out != _configured_out) {
 552                 lua_State* L = lua.getState ();
 553                 luabridge::LuaRef lua_dsp_configure = luabridge::getGlobal (L, "dsp_configure");
 554                 if (lua_dsp_configure.type () == LUA_TFUNCTION) {
 555                         try {
 556                                 luabridge::LuaRef io = lua_dsp_configure (&in, &out);
 557                                 if (io.isTable ()) {
 558                                         ChanCount lin (_selected_in);
 559                                         ChanCount lout (_selected_out);
 560
 561                                         if (io["audio_in"].type() == LUA_TNUMBER) {
 562                                                 const int c = io["audio_in"].cast<int> ();
 563                                                 if (c >= 0) {
 564                                                         lin.set (DataType::AUDIO, c);
 565                                                 }
 566                                         }
 567                                         if (io["audio_out"].type() == LUA_TNUMBER) {
 568                                                 const int c = io["audio_out"].cast<int> ();
 569                                                 if (c >= 0) {
 570                                                         lout.set (DataType::AUDIO, c);
 571                                                 }
 572                                         }
 573                                         if (io["midi_in"].type() == LUA_TNUMBER) {
 574                                                 const int c = io["midi_in"].cast<int> ();
 575                                                 if (c >= 0) {
 576                                                         lin.set (DataType::MIDI, c);
 577                                                 }
 578                                         }
 579                                         if (io["midi_out"].type() == LUA_TNUMBER) {
 580                                                 const int c = io["midi_out"].cast<int> ();
 581                                                 if (c >= 0) {
 582                                                         lout.set (DataType::MIDI, c);
 583                                                 }
 584                                         }
 585                                         _info->n_inputs = lin;
 586                                         _info->n_outputs = lout;
 587                                 }
 588                         } catch (luabridge::LuaException const& e) {
 589                                 PBD::error << "LuaException: " << e.what () << "\n";
 590 #ifndef NDEBUG
 591                                 std::cerr << "LuaException: " << e.what () << "\n";
 592 #endif
 593                                 return false;
 594                         }
 595                 }
 596         }
 597
 598         _configured_in = in;
 599         _configured_out = out;
 600
 601         return true;
 602 }
 603
 604 int
 605 LuaProc::connect_and_run (BufferSet& bufs,
 606                 framepos_t start, framepos_t end, double speed,
 607                 ChanMapping in, ChanMapping out,
 608                 pframes_t nframes, framecnt_t offset)
 609 {
 610         if (!_lua_dsp) {
 611                 return 0;
 612         }
 613
 614         Plugin::connect_and_run (bufs, start, end, speed, in, out, nframes, offset);
 615
 616         // This is needed for ARDOUR::Session requests :(
 617         if (! SessionEvent::has_per_thread_pool ()) {
 618                 char name[64];
 619                 snprintf (name, 64, "Proc-%p", this);
 620                 pthread_set_name (name);
 621                 SessionEvent::create_per_thread_pool (name, 64);
 622                 PBD::notify_event_loops_about_thread_creation (pthread_self(), name, 64);
 623         }
 624
 625         uint32_t const n = parameter_count ();
 626         for (uint32_t i = 0; i < n; ++i) {
 627                 if (parameter_is_control (i) && parameter_is_input (i)) {
 628                         _control_data[i] = _shadow_data[i];
 629                 }
 630         }
 631
 632 #ifdef WITH_LUAPROC_STATS
 633         int64_t t0 = g_get_monotonic_time ();
 634 #endif
 635
 636         try {
 637                 if (_lua_does_channelmapping) {
 638                         // run the DSP function
 639                         (*_lua_dsp)(&bufs, in, out, nframes, offset);
 640                 } else {
 641                         // map buffers
 642                         BufferSet& silent_bufs  = _session.get_silent_buffers (ChanCount (DataType::AUDIO, 1));
 643                         BufferSet& scratch_bufs = _session.get_scratch_buffers (ChanCount (DataType::AUDIO, 1));
 644
 645                         lua_State* L = lua.getState ();
 646                         luabridge::LuaRef in_map (luabridge::newTable (L));
 647                         luabridge::LuaRef out_map (luabridge::newTable (L));
 648
 649                         const uint32_t audio_in = _configured_in.n_audio ();
 650                         const uint32_t audio_out = _configured_out.n_audio ();
 651                         const uint32_t midi_in = _configured_in.n_midi ();
 652
 653                         for (uint32_t ap = 0; ap < audio_in; ++ap) {
 654                                 bool valid;
 655                                 const uint32_t buf_index = in.get(DataType::AUDIO, ap, &valid);
 656                                 if (valid) {
 657                                         in_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
 658                                 } else {
 659                                         in_map[ap + 1] = silent_bufs.get_audio (0).data (offset);
 660                                 }
 661                         }
 662                         for (uint32_t ap = 0; ap < audio_out; ++ap) {
 663                                 bool valid;
 664                                 const uint32_t buf_index = out.get(DataType::AUDIO, ap, &valid);
 665                                 if (valid) {
 666                                         out_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
 667                                 } else {
 668                                         out_map[ap + 1] = scratch_bufs.get_audio (0).data (offset);
 669                                 }
 670                         }
 671
 672                         luabridge::LuaRef lua_midi_src_tbl (luabridge::newTable (L));
 673                         int e = 1; // > 1 port, we merge events (unsorted)
 674                         for (uint32_t mp = 0; mp < midi_in; ++mp) {
 675                                 bool valid;
 676                                 const uint32_t idx = in.get(DataType::MIDI, mp, &valid);
 677                                 if (valid) {
 678                                         for (MidiBuffer::iterator m = bufs.get_midi(idx).begin();
 679                                                         m != bufs.get_midi(idx).end(); ++m, ++e) {
 680                                                 const Evoral::MIDIEvent<framepos_t> ev(*m, false);
 681                                                 luabridge::LuaRef lua_midi_data (luabridge::newTable (L));
 682                                                 const uint8_t* data = ev.buffer();
 683                                                 for (uint32_t i = 0; i < ev.size(); ++i) {
 684                                                         lua_midi_data [i + 1] = data[i];
 685                                                 }
 686                                                 luabridge::LuaRef lua_midi_event (luabridge::newTable (L));
 687                                                 lua_midi_event["time"] = 1 + (*m).time();
 688                                                 lua_midi_event["data"] = lua_midi_data;
 689                                                 lua_midi_src_tbl[e] = lua_midi_event;
 690                                         }
 691                                 }
 692                         }
 693
 694                         if (_has_midi_input) {
 695                                 // XXX TODO This needs a better solution than global namespace
 696                                 luabridge::push (L, lua_midi_src_tbl);
 697                                 lua_setglobal (L, "midiin");
 698                         }
 699
 700                         luabridge::LuaRef lua_midi_sink_tbl (luabridge::newTable (L));
 701                         if (_has_midi_output) {
 702                                 luabridge::push (L, lua_midi_sink_tbl);
 703                                 lua_setglobal (L, "midiout");
 704                         }
 705
 706                         // run the DSP function
 707                         (*_lua_dsp)(in_map, out_map, nframes);
 708
 709                         // copy back midi events
 710                         if (_has_midi_output && lua_midi_sink_tbl.isTable ()) {
 711                                 bool valid;
 712                                 const uint32_t idx = out.get(DataType::MIDI, 0, &valid);
 713                                 if (valid && bufs.count().n_midi() > idx) {
 714                                         MidiBuffer& mbuf = bufs.get_midi(idx);
 715                                         mbuf.silence(0, 0);
 716                                         for (luabridge::Iterator i (lua_midi_sink_tbl); !i.isNil (); ++i) {
 717                                                 if (!i.key ().isNumber ()) { continue; }
 718                                                 if (!i.value ()["time"].isNumber ()) { continue; }
 719                                                 if (!i.value ()["data"].isTable ()) { continue; }
 720                                                 luabridge::LuaRef data_tbl (i.value ()["data"]);
 721                                                 framepos_t tme = i.value ()["time"];
 722                                                 if (tme < 1 || tme > nframes) { continue; }
 723                                                 uint8_t data[64];
 724                                                 size_t size = 0;
 725                                                 for (luabridge::Iterator di (data_tbl); !di.isNil () && size < sizeof(data); ++di, ++size) {
 726                                                         data[size] = di.value ();
 727                                                 }
 728                                                 if (size > 0 && size < 64) {
 729                                                         mbuf.push_back(tme - 1, size, data);
 730                                                 }
 731                                         }
 732
 733                                 }
 734                         }
 735                 }
 736         } catch (luabridge::LuaException const& e) {
 737                 PBD::error << "LuaException: " << e.what () << "\n";
 738 #ifndef NDEBUG
 739                 std::cerr << "LuaException: " << e.what () << "\n";
 740 #endif
 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         char        buf[32];
 767         LocaleGuard lg;
 768
 769         gchar* b64 = g_base64_encode ((const guchar*)_script.c_str (), _script.size ());
 770         std::string b64s (b64);
 771         g_free (b64);
 772         XMLNode* script_node = new XMLNode (X_("script"));
 773         script_node->add_property (X_("lua"), LUA_VERSION);
 774         script_node->add_content (b64s);
 775         root->add_child_nocopy (*script_node);
 776
 777         for (uint32_t i = 0; i < parameter_count(); ++i) {
 778                 if (parameter_is_input(i) && parameter_is_control(i)) {
 779                         child = new XMLNode("Port");
 780                         snprintf(buf, sizeof(buf), "%u", i);
 781                         child->add_property("id", std::string(buf));
 782                         snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
 783                         child->add_property("value", std::string(buf));
 784                         root->add_child_nocopy(*child);
 785                 }
 786         }
 787 }
 788
 789 int
 790 LuaProc::set_script_from_state (const XMLNode& node)
 791 {
 792         XMLNode* child;
 793         if (node.name () != state_node_name ()) {
 794                 return -1;
 795         }
 796
 797         if ((child = node.child (X_("script"))) != 0) {
 798                 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
 799                         if (!(*n)->is_content ()) { continue; }
 800                         gsize size;
 801                         guchar* buf = g_base64_decode ((*n)->content ().c_str (), &size);
 802                         _script = std::string ((const char*)buf, size);
 803                         g_free (buf);
 804                         if (load_script ()) {
 805                                 PBD::error << _("Failed to load Lua script from session state.") << endmsg;
 806 #ifndef NDEBUG
 807                                 std::cerr << "Failed Lua Script: " << _script << std::endl;
 808 #endif
 809                                 _script = "";
 810                         }
 811                         break;
 812                 }
 813         }
 814         if (_script.empty ()) {
 815                 PBD::error << _("Session State for LuaProcessor did not include a Lua script.") << endmsg;
 816                 return -1;
 817         }
 818         if (!_lua_dsp) {
 819                 PBD::error << _("Invalid/incompatible Lua script found for LuaProcessor.") << endmsg;
 820                 return -1;
 821         }
 822         return 0;
 823 }
 824
 825 int
 826 LuaProc::set_state (const XMLNode& node, int version)
 827 {
 828 #ifndef NO_PLUGIN_STATE
 829         XMLNodeList nodes;
 830         XMLProperty const * prop;
 831         XMLNodeConstIterator iter;
 832         XMLNode *child;
 833         const char *value;
 834         const char *port;
 835         uint32_t port_id;
 836 #endif
 837         LocaleGuard lg;
 838
 839         if (_script.empty ()) {
 840                 if (set_script_from_state (node)) {
 841                         return -1;
 842                 }
 843         }
 844
 845 #ifndef NO_PLUGIN_STATE
 846         if (node.name() != state_node_name()) {
 847                 error << _("Bad node sent to LuaProc::set_state") << endmsg;
 848                 return -1;
 849         }
 850
 851         nodes = node.children ("Port");
 852         for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
 853                 child = *iter;
 854                 if ((prop = child->property("id")) != 0) {
 855                         port = prop->value().c_str();
 856                 } else {
 857                         warning << _("LuaProc: port has no symbol, ignored") << endmsg;
 858                         continue;
 859                 }
 860                 if ((prop = child->property("value")) != 0) {
 861                         value = prop->value().c_str();
 862                 } else {
 863                         warning << _("LuaProc: port has no value, ignored") << endmsg;
 864                         continue;
 865                 }
 866                 sscanf (port, "%" PRIu32, &port_id);
 867                 set_parameter (port_id, atof(value));
 868         }
 869 #endif
 870
 871         return Plugin::set_state (node, version);
 872 }
 873
 874 uint32_t
 875 LuaProc::parameter_count () const
 876 {
 877         return _ctrl_params.size ();
 878 }
 879
 880 float
 881 LuaProc::default_value (uint32_t port)
 882 {
 883         if (_ctrl_params[port].first) {
 884                 assert (0);
 885                 return 0;
 886         }
 887         int lp = _ctrl_params[port].second;
 888         return _param_desc[lp].normal;
 889 }
 890
 891 void
 892 LuaProc::set_parameter (uint32_t port, float val)
 893 {
 894         assert (port < parameter_count ());
 895         if (get_parameter (port) == val) {
 896                 return;
 897         }
 898         _shadow_data[port] = val;
 899         Plugin::set_parameter (port, val);
 900 }
 901
 902 float
 903 LuaProc::get_parameter (uint32_t port) const
 904 {
 905         if (parameter_is_input (port)) {
 906                 return _shadow_data[port];
 907         } else {
 908                 return _control_data[port];
 909         }
 910 }
 911
 912 int
 913 LuaProc::get_parameter_descriptor (uint32_t port, ParameterDescriptor& desc) const
 914 {
 915         assert (port <= parameter_count ());
 916         int lp = _ctrl_params[port].second;
 917         const ParameterDescriptor& d (_param_desc.find(lp)->second);
 918
 919         desc.lower        = d.lower;
 920         desc.upper        = d.upper;
 921         desc.normal       = d.normal;
 922         desc.toggled      = d.toggled;
 923         desc.logarithmic  = d.logarithmic;
 924         desc.integer_step = d.integer_step;
 925         desc.sr_dependent = d.sr_dependent;
 926         desc.enumeration  = d.enumeration;
 927         desc.unit         = d.unit;
 928         desc.label        = d.label;
 929         desc.scale_points = d.scale_points;
 930
 931         desc.update_steps ();
 932         return 0;
 933 }
 934
 935 std::string
 936 LuaProc::get_parameter_docs (uint32_t port) const {
 937         assert (port <= parameter_count ());
 938         int lp = _ctrl_params[port].second;
 939         return _param_doc.find(lp)->second;
 940 }
 941
 942 uint32_t
 943 LuaProc::nth_parameter (uint32_t port, bool& ok) const
 944 {
 945         if (port < _ctrl_params.size ()) {
 946                 ok = true;
 947                 return port;
 948         }
 949         ok = false;
 950         return 0;
 951 }
 952
 953 bool
 954 LuaProc::parameter_is_input (uint32_t port) const
 955 {
 956         assert (port < _ctrl_params.size ());
 957         return (!_ctrl_params[port].first);
 958 }
 959
 960 bool
 961 LuaProc::parameter_is_output (uint32_t port) const
 962 {
 963         assert (port < _ctrl_params.size ());
 964         return (_ctrl_params[port].first);
 965 }
 966
 967 std::set<Evoral::Parameter>
 968 LuaProc::automatable () const
 969 {
 970         std::set<Evoral::Parameter> automatables;
 971         for (uint32_t i = 0; i < _ctrl_params.size (); ++i) {
 972                 if (parameter_is_input (i)) {
 973                         automatables.insert (automatables.end (), Evoral::Parameter (PluginAutomation, 0, i));
 974                 }
 975         }
 976         return automatables;
 977 }
 978
 979 std::string
 980 LuaProc::describe_parameter (Evoral::Parameter param)
 981 {
 982         if (param.type () == PluginAutomation && param.id () < parameter_count ()) {
 983                 int lp = _ctrl_params[param.id ()].second;
 984                 return _param_desc[lp].label;
 985         }
 986         return "??";
 987 }
 988
 989 void
 990 LuaProc::print_parameter (uint32_t param, char* buf, uint32_t len) const
 991 {
 992         if (buf && len) {
 993                 if (param < parameter_count ()) {
 994                         snprintf (buf, len, "%.3f", get_parameter (param));
 995                 } else {
 996                         strcat (buf, "0");
 997                 }
 998         }
 999 }
1000
1001 boost::shared_ptr<ScalePoints>
1002 LuaProc::parse_scale_points (luabridge::LuaRef* lr)
1003 {
1004         if (!(*lr)["scalepoints"].isTable()) {
1005                 return boost::shared_ptr<ScalePoints> ();
1006         }
1007
1008         int cnt = 0;
1009         boost::shared_ptr<ScalePoints> rv = boost::shared_ptr<ScalePoints>(new ScalePoints());
1010         luabridge::LuaRef scalepoints ((*lr)["scalepoints"]);
1011
1012         for (luabridge::Iterator i (scalepoints); !i.isNil (); ++i) {
1013                 if (!i.key ().isString ())    { continue; }
1014                 if (!i.value ().isNumber ())  { continue; }
1015                 rv->insert(make_pair(i.key ().cast<std::string> (),
1016                                         i.value ().cast<float> ()));
1017                 ++cnt;
1018         }
1019
1020         if (rv->size() > 0) {
1021                 return rv;
1022         }
1023         return boost::shared_ptr<ScalePoints> ();
1024 }
1025
1026 boost::shared_ptr<ScalePoints>
1027 LuaProc::get_scale_points (uint32_t port) const
1028 {
1029         int lp = _ctrl_params[port].second;
1030         return _param_desc.find(lp)->second.scale_points;
1031 }
1032
1033 void
1034 LuaProc::setup_lua_inline_gui (LuaState *lua_gui)
1035 {
1036         lua_State* LG = lua_gui->getState ();
1037         LuaBindings::stddef (LG);
1038         LuaBindings::common (LG);
1039         LuaBindings::dsp (LG);
1040
1041         lua_gui->Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
1042         lua_gui->do_command ("function ardour () end");
1043         lua_gui->do_command (_script);
1044
1045         // TODO think: use a weak-pointer here ?
1046         // (the GUI itself uses a shared ptr to this plugin, so we should be good)
1047         luabridge::getGlobalNamespace (LG)
1048                 .beginNamespace ("Ardour")
1049                 .beginClass <LuaProc> ("LuaProc")
1050                 .addFunction ("shmem", &LuaProc::instance_shm)
1051                 .addFunction ("table", &LuaProc::instance_ref)
1052                 .endClass ()
1053                 .endNamespace ();
1054
1055         luabridge::push <LuaProc *> (LG, this);
1056         lua_setglobal (LG, "self");
1057
1058         luabridge::push <float *> (LG, _shadow_data);
1059         lua_setglobal (LG, "CtrlPorts");
1060 }
1061 ////////////////////////////////////////////////////////////////////////////////
1062
1063 #include "ardour/search_paths.h"
1064 #include "sha1.c"
1065
1066 std::string
1067 LuaProc::preset_name_to_uri (const std::string& name) const
1068 {
1069         std::string uri ("urn:lua:");
1070         char hash[41];
1071         Sha1Digest s;
1072         sha1_init (&s);
1073         sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
1074         sha1_write (&s, (const uint8_t *) _script.c_str(), _script.size ());
1075         sha1_result_hash (&s, hash);
1076         return uri + hash;
1077 }
1078
1079 std::string
1080 LuaProc::presets_file () const
1081 {
1082         return string_compose ("lua-%1", _info->unique_id);
1083 }
1084
1085 XMLTree*
1086 LuaProc::presets_tree () const
1087 {
1088         XMLTree* t = new XMLTree;
1089         std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1090
1091         if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
1092                 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
1093                         error << _("Unable to create LuaProc presets directory") << endmsg;
1094                 };
1095         }
1096
1097         p = Glib::build_filename (p, presets_file ());
1098
1099         if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
1100                 t->set_root (new XMLNode (X_("LuaPresets")));
1101                 return t;
1102         }
1103
1104         t->set_filename (p);
1105         if (!t->read ()) {
1106                 delete t;
1107                 return 0;
1108         }
1109         return t;
1110 }
1111
1112 bool
1113 LuaProc::load_preset (PresetRecord r)
1114 {
1115         boost::shared_ptr<XMLTree> t (presets_tree ());
1116         if (t == 0) {
1117                 return false;
1118         }
1119
1120         XMLNode* root = t->root ();
1121         for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1122                 XMLProperty const * label = (*i)->property (X_("label"));
1123                 assert (label);
1124                 if (label->value() != 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                                 XMLProperty const * index = (*j)->property (X_("index"));
1131                                 XMLProperty const * value = (*j)->property (X_("value"));
1132                                 assert (index);
1133                                 assert (value);
1134                                 LocaleGuard lg;
1135                                 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
1136                         }
1137                 }
1138                 return Plugin::load_preset(r);
1139         }
1140         return false;
1141 }
1142
1143 std::string
1144 LuaProc::do_save_preset (std::string name) {
1145
1146         boost::shared_ptr<XMLTree> t (presets_tree ());
1147         if (t == 0) {
1148                 return "";
1149         }
1150
1151         std::string uri (preset_name_to_uri (name));
1152
1153         XMLNode* p = new XMLNode (X_("Preset"));
1154         p->add_property (X_("uri"), uri);
1155         p->add_property (X_("label"), name);
1156
1157         for (uint32_t i = 0; i < parameter_count(); ++i) {
1158                 if (parameter_is_input (i)) {
1159                         XMLNode* c = new XMLNode (X_("Parameter"));
1160                         c->add_property (X_("index"), string_compose ("%1", i));
1161                         c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
1162                         p->add_child_nocopy (*c);
1163                 }
1164         }
1165         t->root()->add_child_nocopy (*p);
1166
1167         std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1168         f = Glib::build_filename (f, presets_file ());
1169
1170         t->write (f);
1171         return uri;
1172 }
1173
1174 void
1175 LuaProc::do_remove_preset (std::string name)
1176 {
1177         boost::shared_ptr<XMLTree> t (presets_tree ());
1178         if (t == 0) {
1179                 return;
1180         }
1181         t->root()->remove_nodes_and_delete (X_("label"), name);
1182         std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1183         f = Glib::build_filename (f, presets_file ());
1184         t->write (f);
1185 }
1186
1187 void
1188 LuaProc::find_presets ()
1189 {
1190         boost::shared_ptr<XMLTree> t (presets_tree ());
1191         if (t) {
1192                 XMLNode* root = t->root ();
1193                 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1194
1195                         XMLProperty const * uri = (*i)->property (X_("uri"));
1196                         XMLProperty const * label = (*i)->property (X_("label"));
1197
1198                         assert (uri);
1199                         assert (label);
1200
1201                         PresetRecord r (uri->value(), label->value(), true);
1202                         _presets.insert (make_pair (r.uri, r));
1203                 }
1204         }
1205 }
1206
1207 ////////////////////////////////////////////////////////////////////////////////
1208
1209 LuaPluginInfo::LuaPluginInfo (LuaScriptInfoPtr lsi) {
1210         if (lsi->type != LuaScriptInfo::DSP) {
1211                 throw failed_constructor ();
1212         }
1213
1214         path = lsi->path;
1215         name = lsi->name;
1216         creator = lsi->author;
1217         category = lsi->category;
1218         unique_id = lsi->unique_id;
1219
1220         n_inputs.set (DataType::AUDIO, 1);
1221         n_outputs.set (DataType::AUDIO, 1);
1222         type = Lua;
1223
1224         _is_instrument = category == "Instrument";
1225 }
1226
1227 PluginPtr
1228 LuaPluginInfo::load (Session& session)
1229 {
1230         std::string script = "";
1231         if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
1232                 return PluginPtr ();
1233         }
1234
1235         try {
1236                 script = Glib::file_get_contents (path);
1237         } catch (Glib::FileError err) {
1238                 return PluginPtr ();
1239         }
1240
1241         if (script.empty ()) {
1242                 return PluginPtr ();
1243         }
1244
1245         try {
1246                 PluginPtr plugin (new LuaProc (session.engine (), session, script));
1247                 return plugin;
1248         } catch (failed_constructor& err) {
1249                 ;
1250         }
1251         return PluginPtr ();
1252 }
1253
1254 std::vector<Plugin::PresetRecord>
1255 LuaPluginInfo::get_presets (bool /*user_only*/) const
1256 {
1257         std::vector<Plugin::PresetRecord> p;
1258         XMLTree* t = new XMLTree;
1259         std::string pf = Glib::build_filename (ARDOUR::user_config_directory (), "presets", string_compose ("lua-%1", unique_id));
1260         if (Glib::file_test (pf, Glib::FILE_TEST_EXISTS)) {
1261                 t->set_filename (pf);
1262                 if (t->read ()) {
1263                         XMLNode* root = t->root ();
1264                         for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1265                                 XMLProperty const * uri = (*i)->property (X_("uri"));
1266                                 XMLProperty const * label = (*i)->property (X_("label"));
1267                                 p.push_back (Plugin::PresetRecord (uri->value(), label->value(), true));
1268                         }
1269                 }
1270         }
1271         delete t;
1272         return p;
1273 }