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