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