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