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