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