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