libs/ardour/luaproc.cc

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