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