2 Copyright (C) 2016 Robin Gareus <robin@gareus.org>
3 Copyright (C) 2006 Paul Davis
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)
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
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.
21 #include <glibmm/miscutils.h>
22 #include <glibmm/fileutils.h>
24 #include "pbd/gstdio_compat.h"
25 #include "pbd/locale_guard.h"
26 #include "pbd/pthread_utils.h"
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"
38 #include "LuaBridge/LuaBridge.h"
42 using namespace ARDOUR;
45 LuaProc::LuaProc (AudioEngine& engine,
47 const std::string &script)
48 : Plugin (engine, session)
49 , _mempool ("LuaProc", 2097152)
51 , lua (lua_newstate (&PBD::TLSF::lalloc, &_mempool))
52 #elif defined USE_MALLOC
55 , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
59 , _lua_does_channelmapping (false)
60 , _lua_has_inline_display (false)
61 , _designated_bypass_port (UINT32_MAX)
64 , _has_midi_input (false)
65 , _has_midi_output (false)
69 /* when loading a session, or pasing a processor,
70 * the script is set during set_state();
72 if (!_script.empty () && load_script ()) {
73 throw failed_constructor ();
77 LuaProc::LuaProc (const LuaProc &other)
79 , _mempool ("LuaProc", 2097152)
81 , lua (lua_newstate (&PBD::TLSF::lalloc, &_mempool))
82 #elif defined USE_MALLOC
85 , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
88 , _script (other.script ())
89 , _lua_does_channelmapping (false)
90 , _lua_has_inline_display (false)
91 , _designated_bypass_port (UINT32_MAX)
94 , _has_midi_input (false)
95 , _has_midi_output (false)
100 throw failed_constructor ();
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];
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]);
122 lua.do_command ("collectgarbage();");
124 delete [] _control_data;
125 delete [] _shadow_data;
131 #ifdef WITH_LUAPROC_STATS
132 _stats_avg[0] = _stats_avg[1] = _stats_max[0] = _stats_max[1] = _stats_cnt = 0;
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);
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)
152 // add session to global lua namespace
153 luabridge::push <Session *> (L, &_session);
154 lua_setglobal (L, "Session");
157 luabridge::push <LuaProc *> (L, this);
158 lua_setglobal (L, "self");
161 lua.do_command ("io = nil os = nil loadfile = nil require = nil dofile = nil package = nil debug = nil");
163 lua.do_command ("for n in pairs(_G) do print(n) end print ('----')"); // print global env
165 lua.do_command ("function ardour () end");
169 LuaProc::lua_print (std::string s) {
170 std::cout <<"LuaProc: " << s << "\n";
171 PBD::error << "LuaProc: " << s << "\n";
175 LuaProc::load_script ()
177 assert (!_lua_dsp); // don't allow to re-initialize
178 LuaPluginInfoPtr lpi;
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 }, .. }
189 LuaScriptInfoPtr lsi = LuaScripting::script_info (_script);
190 lpi = LuaPluginInfoPtr (new LuaPluginInfo (lsi));
193 _mempool.set_name ("LuaProc: " + lsi->name);
194 _docs = lsi->description;
195 } catch (failed_constructor& err) {
199 lua_State* L = lua.getState ();
200 lua.do_command (_script);
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");
206 if ((lua_dsp_run.type () != LUA_TFUNCTION) == (lua_dsp_map.type () != LUA_TFUNCTION)) {
210 if (lua_dsp_run.type () == LUA_TFUNCTION) {
211 _lua_dsp = new luabridge::LuaRef (lua_dsp_run);
213 else if (lua_dsp_map.type () == LUA_TFUNCTION) {
214 _lua_dsp = new luabridge::LuaRef (lua_dsp_map);
215 _lua_does_channelmapping = true;
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) {
225 lua_dsp_init (_session.nominal_frame_rate ());
226 } catch (luabridge::LuaException const& e) {
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) {
235 _has_midi_input = lua_dsp_has_midi_in ();
236 } catch (luabridge::LuaException const& e) {
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) {
244 _has_midi_output = lua_dsp_has_midi_out ();
245 } catch (luabridge::LuaException const& e) {
250 _ctrl_params.clear ();
252 luabridge::LuaRef lua_render = luabridge::getGlobal (L, "render_inline");
253 if (lua_render.isFunction ()) {
254 _lua_has_inline_display = true;
257 luabridge::LuaRef lua_params = luabridge::getGlobal (L, "dsp_params");
258 if (lua_params.isFunction ()) {
260 // call function // add try {} catch (luabridge::LuaException const& e)
261 luabridge::LuaRef params = lua_params ();
263 if (params.isTable ()) {
265 for (luabridge::Iterator i (params); !i.isNil (); ++i) {
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; }
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));
280 else if (type == "output") {
281 _ctrl_params.push_back (std::make_pair (true, pn));
285 assert (pn == (int) _ctrl_params.size ());
287 //_param_desc[pn] = boost::shared_ptr<ParameterDescriptor> (new ParameterDescriptor());
288 luabridge::LuaRef lr = i.value ();
290 if (type == "input") {
291 _param_desc[pn].normal = lr["default"].cast<float> ();
293 _param_desc[pn].normal = lr["min"].cast<float> (); // output-port, no default
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> ();
303 if (lr["bypass"].isBoolean () && (lr["bypass"]).cast<bool> ()) {
304 _designated_bypass_port = pn - 1; // lua table starts at 1.
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; }
313 _param_desc[pn].label = (lr["name"]).cast<std::string> ();
314 _param_desc[pn].scale_points = parse_scale_points (&lr);
316 luabridge::LuaRef doc = lr["doc"];
317 if (doc.isString ()) {
318 _param_doc[pn] = doc.cast<std::string> ();
322 assert (!(_param_desc[pn].toggled && _param_desc[pn].logarithmic));
327 _control_data = new float[parameter_count ()];
328 _shadow_data = new float[parameter_count ()];
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);
336 // expose ctrl-ports to global lua namespace
337 luabridge::push <float *> (L, _control_data);
338 lua_setglobal (L, "CtrlPorts");
340 return false; // no error
344 LuaProc::can_support_io_configuration (const ChanCount& in, ChanCount& out, ChanCount* imprecise)
346 // caller must hold process lock (no concurrent calls to interpreter
347 _output_configs.clear ();
349 if (in.n_midi() > 0 && !_has_midi_input && !imprecise) {
353 lua_State* L = lua.getState ();
354 luabridge::LuaRef ioconfig = luabridge::getGlobal (L, "dsp_ioconfig");
355 if (!ioconfig.isFunction ()) {
359 luabridge::LuaRef *_iotable = NULL; // can't use reference :(
361 luabridge::LuaRef iotable = ioconfig ();
362 if (iotable.isTable ()) {
363 _iotable = new luabridge::LuaRef (iotable);
365 } catch (luabridge::LuaException const& e) {
373 // now we can reference it.
374 luabridge::LuaRef iotable (*_iotable);
377 if ((iotable).length () < 1) {
382 bool exact_match = false;
383 const int audio_in = in.n_audio ();
384 int midi_out = _has_midi_output ? 1 : 0;
386 // preferred setting (provided by plugin_insert)
387 assert (out.n_audio () > 0 || midi_out > 0);
388 const int preferred_out = out.n_audio ();
390 for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
391 luabridge::LuaRef io (i.value ());
396 int possible_in = io["audio_in"].isNumber() ? io["audio_in"] : -1;
397 int possible_out = io["audio_out"].isNumber() ? io["audio_out"] : -1;
400 if ((possible_in == audio_in) && (possible_out == preferred_out)) {
401 _output_configs.insert (preferred_out);
408 /* now allow potentially "imprecise" matches */
410 float penalty = 9999;
412 #define FOUNDCFG(nch) { \
413 float p = fabsf ((float)(nch) - preferred_out); \
414 _output_configs.insert (nch); \
415 if ((nch) > preferred_out) { p *= 1.1; } \
423 #define ANYTHINGGOES \
424 _output_configs.insert (0);
426 #define UPTO(nch) { \
427 for (int n = 1; n < nch; ++n) { \
428 _output_configs.insert (n); \
432 for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
433 luabridge::LuaRef io (i.value ());
438 int possible_in = io["audio_in"].isNumber() ? io["audio_in"] : -1;
439 int possible_out = io["audio_out"].isNumber() ? io["audio_out"] : -1;
441 if (possible_out == 0) {
442 if (possible_in == 0) {
443 if (_has_midi_output && audio_in == 0) {
444 // special case midi filters & generators
453 if (possible_in == 0) {
454 /* no inputs, generators & instruments */
455 if (possible_out == -1) {
456 /* any configuration possible, stereo output */
457 FOUNDCFG (preferred_out);
459 } else if (possible_out == -2) {
460 /* invalid, should be (0, -1) */
461 FOUNDCFG (preferred_out);
463 } else if (possible_out < -2) {
464 /* variable number of outputs up to -N, */
465 FOUNDCFG (min (-possible_out, preferred_out));
466 UPTO (-possible_out);
468 /* exact number of outputs */
469 FOUNDCFG (possible_out);
473 if (possible_in == -1) {
474 /* wildcard for input */
475 if (possible_out == -1) {
476 /* out must match in */
478 } else if (possible_out == -2) {
479 /* any configuration possible, pick matching */
480 FOUNDCFG (preferred_out);
482 } else if (possible_out < -2) {
483 /* explicitly variable number of outputs, pick maximum */
484 FOUNDCFG (max (-possible_out, preferred_out));
485 /* and try min, too, in case the penalty is lower */
486 FOUNDCFG (min (-possible_out, preferred_out));
489 /* exact number of outputs */
490 FOUNDCFG (possible_out);
494 if (possible_in == -2) {
495 if (possible_out == -1) {
496 /* any configuration possible, pick matching */
497 FOUNDCFG (preferred_out);
499 } else if (possible_out == -2) {
500 /* invalid. interpret as (-1, -1) */
501 FOUNDCFG (preferred_out);
503 } else if (possible_out < -2) {
504 /* invalid, interpret as (<-2, <-2)
505 * variable number of outputs up to -N, */
506 FOUNDCFG (min (-possible_out, preferred_out));
509 /* exact number of outputs */
510 FOUNDCFG (possible_out);
514 if (possible_in < -2) {
515 /* explicit variable number of inputs */
516 if (audio_in > -possible_in && imprecise != NULL) {
518 imprecise->set (DataType::AUDIO, -possible_in);
521 if (audio_in > -possible_in && imprecise == NULL) {
522 /* request is too large */
523 } else if (possible_out == -1) {
524 /* any output configuration possible */
525 FOUNDCFG (preferred_out);
527 } else if (possible_out == -2) {
528 /* invalid. interpret as (<-2, -1) */
529 FOUNDCFG (preferred_out);
531 } else if (possible_out < -2) {
532 /* variable number of outputs up to -N, */
533 FOUNDCFG (min (-possible_out, preferred_out));
536 /* exact number of outputs */
537 FOUNDCFG (possible_out);
541 if (possible_in && (possible_in == audio_in)) {
542 /* exact number of inputs ... must match obviously */
543 if (possible_out == -1) {
544 /* any output configuration possible */
545 FOUNDCFG (preferred_out);
547 } else if (possible_out == -2) {
548 /* invalid. interpret as (>0, -1) */
549 FOUNDCFG (preferred_out);
551 } else if (possible_out < -2) {
552 /* > 0, < -2 is not specified
553 * interpret as up to -N */
554 FOUNDCFG (min (-possible_out, preferred_out));
557 /* exact number of outputs */
558 FOUNDCFG (possible_out);
563 if (found && imprecise) {
567 if (!found && imprecise) {
569 for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
570 luabridge::LuaRef io (i.value ());
575 int possible_in = io["audio_in"].isNumber() ? io["audio_in"] : -1;
576 int possible_out = io["audio_out"].isNumber() ? io["audio_out"] : -1;
578 if (possible_out == 0 && possible_in == 0 && _has_midi_output) {
579 assert (audio_in > 0); // no input is handled above
580 // TODO hide audio input from plugin
581 imprecise->set (DataType::AUDIO, 0);
587 assert (possible_in > 0); // all other cases will have been matched above
588 assert (possible_out !=0 || possible_in !=0); // already handled above
590 imprecise->set (DataType::AUDIO, possible_in);
591 if (possible_out == -1 || possible_out == -2) {
593 } else if (possible_out < -2) {
594 /* explicitly variable number of outputs, pick maximum */
595 FOUNDCFG (min (-possible_out, preferred_out));
597 /* exact number of outputs */
598 FOUNDCFG (possible_out);
600 // ideally we'll also find the closest, best matching
601 // input configuration with minimal output penalty...
610 imprecise->set (DataType::MIDI, _has_midi_input ? 1 : 0);
611 _selected_in = *imprecise;
617 out.set (DataType::MIDI, midi_out);
618 out.set (DataType::AUDIO, preferred_out);
620 out.set (DataType::MIDI, midi_out);
621 out.set (DataType::AUDIO, audio_out);
629 LuaProc::configure_io (ChanCount in, ChanCount out)
631 in.set (DataType::MIDI, _has_midi_input ? 1 : 0);
632 out.set (DataType::MIDI, _has_midi_output ? 1 : 0);
634 _info->n_inputs = _selected_in;
635 _info->n_outputs = _selected_out;
637 // configure the DSP if needed
638 if (in != _configured_in || out != _configured_out) {
639 lua_State* L = lua.getState ();
640 luabridge::LuaRef lua_dsp_configure = luabridge::getGlobal (L, "dsp_configure");
641 if (lua_dsp_configure.type () == LUA_TFUNCTION) {
643 luabridge::LuaRef io = lua_dsp_configure (&in, &out);
645 ChanCount lin (_selected_in);
646 ChanCount lout (_selected_out);
648 if (io["audio_in"].type() == LUA_TNUMBER) {
649 const int c = io["audio_in"].cast<int> ();
651 lin.set (DataType::AUDIO, c);
654 if (io["audio_out"].type() == LUA_TNUMBER) {
655 const int c = io["audio_out"].cast<int> ();
657 lout.set (DataType::AUDIO, c);
660 if (io["midi_in"].type() == LUA_TNUMBER) {
661 const int c = io["midi_in"].cast<int> ();
663 lin.set (DataType::MIDI, c);
666 if (io["midi_out"].type() == LUA_TNUMBER) {
667 const int c = io["midi_out"].cast<int> ();
669 lout.set (DataType::MIDI, c);
672 _info->n_inputs = lin;
673 _info->n_outputs = lout;
675 } catch (luabridge::LuaException const& e) {
676 PBD::error << "LuaException: " << e.what () << "\n";
678 std::cerr << "LuaException: " << e.what () << "\n";
686 _configured_out = out;
692 LuaProc::connect_and_run (BufferSet& bufs,
693 framepos_t start, framepos_t end, double speed,
694 ChanMapping in, ChanMapping out,
695 pframes_t nframes, framecnt_t offset)
701 Plugin::connect_and_run (bufs, start, end, speed, in, out, nframes, offset);
703 // This is needed for ARDOUR::Session requests :(
704 if (! SessionEvent::has_per_thread_pool ()) {
706 snprintf (name, 64, "Proc-%p", this);
707 pthread_set_name (name);
708 SessionEvent::create_per_thread_pool (name, 64);
709 PBD::notify_event_loops_about_thread_creation (pthread_self(), name, 64);
712 uint32_t const n = parameter_count ();
713 for (uint32_t i = 0; i < n; ++i) {
714 if (parameter_is_control (i) && parameter_is_input (i)) {
715 _control_data[i] = _shadow_data[i];
719 #ifdef WITH_LUAPROC_STATS
720 int64_t t0 = g_get_monotonic_time ();
724 if (_lua_does_channelmapping) {
725 // run the DSP function
726 (*_lua_dsp)(&bufs, in, out, nframes, offset);
729 BufferSet& silent_bufs = _session.get_silent_buffers (ChanCount (DataType::AUDIO, 1));
730 BufferSet& scratch_bufs = _session.get_scratch_buffers (ChanCount (DataType::AUDIO, 1));
732 lua_State* L = lua.getState ();
733 luabridge::LuaRef in_map (luabridge::newTable (L));
734 luabridge::LuaRef out_map (luabridge::newTable (L));
736 const uint32_t audio_in = _configured_in.n_audio ();
737 const uint32_t audio_out = _configured_out.n_audio ();
738 const uint32_t midi_in = _configured_in.n_midi ();
740 for (uint32_t ap = 0; ap < audio_in; ++ap) {
742 const uint32_t buf_index = in.get(DataType::AUDIO, ap, &valid);
744 in_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
746 in_map[ap + 1] = silent_bufs.get_audio (0).data (offset);
749 for (uint32_t ap = 0; ap < audio_out; ++ap) {
751 const uint32_t buf_index = out.get(DataType::AUDIO, ap, &valid);
753 out_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
755 out_map[ap + 1] = scratch_bufs.get_audio (0).data (offset);
759 luabridge::LuaRef lua_midi_src_tbl (luabridge::newTable (L));
760 int e = 1; // > 1 port, we merge events (unsorted)
761 for (uint32_t mp = 0; mp < midi_in; ++mp) {
763 const uint32_t idx = in.get(DataType::MIDI, mp, &valid);
765 for (MidiBuffer::iterator m = bufs.get_midi(idx).begin();
766 m != bufs.get_midi(idx).end(); ++m, ++e) {
767 const Evoral::MIDIEvent<framepos_t> ev(*m, false);
768 luabridge::LuaRef lua_midi_data (luabridge::newTable (L));
769 const uint8_t* data = ev.buffer();
770 for (uint32_t i = 0; i < ev.size(); ++i) {
771 lua_midi_data [i + 1] = data[i];
773 luabridge::LuaRef lua_midi_event (luabridge::newTable (L));
774 lua_midi_event["time"] = 1 + (*m).time();
775 lua_midi_event["data"] = lua_midi_data;
776 lua_midi_src_tbl[e] = lua_midi_event;
781 if (_has_midi_input) {
782 // XXX TODO This needs a better solution than global namespace
783 luabridge::push (L, lua_midi_src_tbl);
784 lua_setglobal (L, "midiin");
787 luabridge::LuaRef lua_midi_sink_tbl (luabridge::newTable (L));
788 if (_has_midi_output) {
789 luabridge::push (L, lua_midi_sink_tbl);
790 lua_setglobal (L, "midiout");
793 // run the DSP function
794 (*_lua_dsp)(in_map, out_map, nframes);
796 // copy back midi events
797 if (_has_midi_output && lua_midi_sink_tbl.isTable ()) {
799 const uint32_t idx = out.get(DataType::MIDI, 0, &valid);
800 if (valid && bufs.count().n_midi() > idx) {
801 MidiBuffer& mbuf = bufs.get_midi(idx);
803 for (luabridge::Iterator i (lua_midi_sink_tbl); !i.isNil (); ++i) {
804 if (!i.key ().isNumber ()) { continue; }
805 if (!i.value ()["time"].isNumber ()) { continue; }
806 if (!i.value ()["data"].isTable ()) { continue; }
807 luabridge::LuaRef data_tbl (i.value ()["data"]);
808 framepos_t tme = i.value ()["time"];
809 if (tme < 1 || tme > nframes) { continue; }
812 for (luabridge::Iterator di (data_tbl); !di.isNil () && size < sizeof(data); ++di, ++size) {
813 data[size] = di.value ();
815 if (size > 0 && size < 64) {
816 mbuf.push_back(tme - 1, size, data);
823 } catch (luabridge::LuaException const& e) {
824 PBD::error << "LuaException: " << e.what () << "\n";
826 std::cerr << "LuaException: " << e.what () << "\n";
830 #ifdef WITH_LUAPROC_STATS
831 int64_t t1 = g_get_monotonic_time ();
834 lua.collect_garbage_step ();
835 #ifdef WITH_LUAPROC_STATS
837 int64_t t2 = g_get_monotonic_time ();
838 int64_t ela0 = t1 - t0;
839 int64_t ela1 = t2 - t1;
840 if (ela0 > _stats_max[0]) _stats_max[0] = ela0;
841 if (ela1 > _stats_max[1]) _stats_max[1] = ela1;
842 _stats_avg[0] += ela0;
843 _stats_avg[1] += ela1;
850 LuaProc::add_state (XMLNode* root) const
856 gchar* b64 = g_base64_encode ((const guchar*)_script.c_str (), _script.size ());
857 std::string b64s (b64);
859 XMLNode* script_node = new XMLNode (X_("script"));
860 script_node->add_property (X_("lua"), LUA_VERSION);
861 script_node->add_content (b64s);
862 root->add_child_nocopy (*script_node);
864 for (uint32_t i = 0; i < parameter_count(); ++i) {
865 if (parameter_is_input(i) && parameter_is_control(i)) {
866 child = new XMLNode("Port");
867 snprintf(buf, sizeof(buf), "%u", i);
868 child->add_property("id", std::string(buf));
869 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
870 child->add_property("value", std::string(buf));
871 root->add_child_nocopy(*child);
877 LuaProc::set_script_from_state (const XMLNode& node)
880 if (node.name () != state_node_name ()) {
884 if ((child = node.child (X_("script"))) != 0) {
885 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
886 if (!(*n)->is_content ()) { continue; }
888 guchar* buf = g_base64_decode ((*n)->content ().c_str (), &size);
889 _script = std::string ((const char*)buf, size);
891 if (load_script ()) {
892 PBD::error << _("Failed to load Lua script from session state.") << endmsg;
894 std::cerr << "Failed Lua Script: " << _script << std::endl;
901 if (_script.empty ()) {
902 PBD::error << _("Session State for LuaProcessor did not include a Lua script.") << endmsg;
906 PBD::error << _("Invalid/incompatible Lua script found for LuaProcessor.") << endmsg;
913 LuaProc::set_state (const XMLNode& node, int version)
915 #ifndef NO_PLUGIN_STATE
917 XMLProperty const * prop;
918 XMLNodeConstIterator iter;
926 if (_script.empty ()) {
927 if (set_script_from_state (node)) {
932 #ifndef NO_PLUGIN_STATE
933 if (node.name() != state_node_name()) {
934 error << _("Bad node sent to LuaProc::set_state") << endmsg;
938 nodes = node.children ("Port");
939 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
941 if ((prop = child->property("id")) != 0) {
942 port = prop->value().c_str();
944 warning << _("LuaProc: port has no symbol, ignored") << endmsg;
947 if ((prop = child->property("value")) != 0) {
948 value = prop->value().c_str();
950 warning << _("LuaProc: port has no value, ignored") << endmsg;
953 sscanf (port, "%" PRIu32, &port_id);
954 set_parameter (port_id, atof(value));
958 return Plugin::set_state (node, version);
962 LuaProc::parameter_count () const
964 return _ctrl_params.size ();
968 LuaProc::default_value (uint32_t port)
970 if (_ctrl_params[port].first) {
974 int lp = _ctrl_params[port].second;
975 return _param_desc[lp].normal;
979 LuaProc::set_parameter (uint32_t port, float val)
981 assert (port < parameter_count ());
982 if (get_parameter (port) == val) {
985 _shadow_data[port] = val;
986 Plugin::set_parameter (port, val);
990 LuaProc::get_parameter (uint32_t port) const
992 if (parameter_is_input (port)) {
993 return _shadow_data[port];
995 return _control_data[port];
1000 LuaProc::get_parameter_descriptor (uint32_t port, ParameterDescriptor& desc) const
1002 assert (port <= parameter_count ());
1003 int lp = _ctrl_params[port].second;
1004 const ParameterDescriptor& d (_param_desc.find(lp)->second);
1006 desc.lower = d.lower;
1007 desc.upper = d.upper;
1008 desc.normal = d.normal;
1009 desc.toggled = d.toggled;
1010 desc.logarithmic = d.logarithmic;
1011 desc.integer_step = d.integer_step;
1012 desc.sr_dependent = d.sr_dependent;
1013 desc.enumeration = d.enumeration;
1015 desc.label = d.label;
1016 desc.scale_points = d.scale_points;
1018 desc.update_steps ();
1023 LuaProc::get_parameter_docs (uint32_t port) const {
1024 assert (port <= parameter_count ());
1025 int lp = _ctrl_params[port].second;
1026 return _param_doc.find(lp)->second;
1030 LuaProc::nth_parameter (uint32_t port, bool& ok) const
1032 if (port < _ctrl_params.size ()) {
1041 LuaProc::parameter_is_input (uint32_t port) const
1043 assert (port < _ctrl_params.size ());
1044 return (!_ctrl_params[port].first);
1048 LuaProc::parameter_is_output (uint32_t port) const
1050 assert (port < _ctrl_params.size ());
1051 return (_ctrl_params[port].first);
1054 std::set<Evoral::Parameter>
1055 LuaProc::automatable () const
1057 std::set<Evoral::Parameter> automatables;
1058 for (uint32_t i = 0; i < _ctrl_params.size (); ++i) {
1059 if (parameter_is_input (i)) {
1060 automatables.insert (automatables.end (), Evoral::Parameter (PluginAutomation, 0, i));
1063 return automatables;
1067 LuaProc::describe_parameter (Evoral::Parameter param)
1069 if (param.type () == PluginAutomation && param.id () < parameter_count ()) {
1070 int lp = _ctrl_params[param.id ()].second;
1071 return _param_desc[lp].label;
1077 LuaProc::print_parameter (uint32_t param, char* buf, uint32_t len) const
1080 if (param < parameter_count ()) {
1081 snprintf (buf, len, "%.3f", get_parameter (param));
1088 boost::shared_ptr<ScalePoints>
1089 LuaProc::parse_scale_points (luabridge::LuaRef* lr)
1091 if (!(*lr)["scalepoints"].isTable()) {
1092 return boost::shared_ptr<ScalePoints> ();
1096 boost::shared_ptr<ScalePoints> rv = boost::shared_ptr<ScalePoints>(new ScalePoints());
1097 luabridge::LuaRef scalepoints ((*lr)["scalepoints"]);
1099 for (luabridge::Iterator i (scalepoints); !i.isNil (); ++i) {
1100 if (!i.key ().isString ()) { continue; }
1101 if (!i.value ().isNumber ()) { continue; }
1102 rv->insert(make_pair(i.key ().cast<std::string> (),
1103 i.value ().cast<float> ()));
1107 if (rv->size() > 0) {
1110 return boost::shared_ptr<ScalePoints> ();
1113 boost::shared_ptr<ScalePoints>
1114 LuaProc::get_scale_points (uint32_t port) const
1116 int lp = _ctrl_params[port].second;
1117 return _param_desc.find(lp)->second.scale_points;
1121 LuaProc::setup_lua_inline_gui (LuaState *lua_gui)
1123 lua_State* LG = lua_gui->getState ();
1124 LuaBindings::stddef (LG);
1125 LuaBindings::common (LG);
1126 LuaBindings::dsp (LG);
1128 lua_gui->Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
1129 lua_gui->do_command ("function ardour () end");
1130 lua_gui->do_command (_script);
1132 // TODO think: use a weak-pointer here ?
1133 // (the GUI itself uses a shared ptr to this plugin, so we should be good)
1134 luabridge::getGlobalNamespace (LG)
1135 .beginNamespace ("Ardour")
1136 .beginClass <LuaProc> ("LuaProc")
1137 .addFunction ("shmem", &LuaProc::instance_shm)
1138 .addFunction ("table", &LuaProc::instance_ref)
1142 luabridge::push <LuaProc *> (LG, this);
1143 lua_setglobal (LG, "self");
1145 luabridge::push <float *> (LG, _shadow_data);
1146 lua_setglobal (LG, "CtrlPorts");
1148 ////////////////////////////////////////////////////////////////////////////////
1150 #include "ardour/search_paths.h"
1154 LuaProc::preset_name_to_uri (const std::string& name) const
1156 std::string uri ("urn:lua:");
1160 sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
1161 sha1_write (&s, (const uint8_t *) _script.c_str(), _script.size ());
1162 sha1_result_hash (&s, hash);
1167 LuaProc::presets_file () const
1169 return string_compose ("lua-%1", _info->unique_id);
1173 LuaProc::presets_tree () const
1175 XMLTree* t = new XMLTree;
1176 std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1178 if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
1179 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
1180 error << _("Unable to create LuaProc presets directory") << endmsg;
1184 p = Glib::build_filename (p, presets_file ());
1186 if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
1187 t->set_root (new XMLNode (X_("LuaPresets")));
1191 t->set_filename (p);
1200 LuaProc::load_preset (PresetRecord r)
1202 boost::shared_ptr<XMLTree> t (presets_tree ());
1207 XMLNode* root = t->root ();
1208 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1209 XMLProperty const * label = (*i)->property (X_("label"));
1211 if (label->value() != r.label) {
1215 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
1216 if ((*j)->name() == X_("Parameter")) {
1217 XMLProperty const * index = (*j)->property (X_("index"));
1218 XMLProperty const * value = (*j)->property (X_("value"));
1222 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
1225 return Plugin::load_preset(r);
1231 LuaProc::do_save_preset (std::string name) {
1233 boost::shared_ptr<XMLTree> t (presets_tree ());
1238 std::string uri (preset_name_to_uri (name));
1240 XMLNode* p = new XMLNode (X_("Preset"));
1241 p->add_property (X_("uri"), uri);
1242 p->add_property (X_("label"), name);
1244 for (uint32_t i = 0; i < parameter_count(); ++i) {
1245 if (parameter_is_input (i)) {
1246 XMLNode* c = new XMLNode (X_("Parameter"));
1247 c->add_property (X_("index"), string_compose ("%1", i));
1248 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
1249 p->add_child_nocopy (*c);
1252 t->root()->add_child_nocopy (*p);
1254 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1255 f = Glib::build_filename (f, presets_file ());
1262 LuaProc::do_remove_preset (std::string name)
1264 boost::shared_ptr<XMLTree> t (presets_tree ());
1268 t->root()->remove_nodes_and_delete (X_("label"), name);
1269 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1270 f = Glib::build_filename (f, presets_file ());
1275 LuaProc::find_presets ()
1277 boost::shared_ptr<XMLTree> t (presets_tree ());
1279 XMLNode* root = t->root ();
1280 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1282 XMLProperty const * uri = (*i)->property (X_("uri"));
1283 XMLProperty const * label = (*i)->property (X_("label"));
1288 PresetRecord r (uri->value(), label->value(), true);
1289 _presets.insert (make_pair (r.uri, r));
1294 ////////////////////////////////////////////////////////////////////////////////
1296 LuaPluginInfo::LuaPluginInfo (LuaScriptInfoPtr lsi) {
1297 if (lsi->type != LuaScriptInfo::DSP) {
1298 throw failed_constructor ();
1303 creator = lsi->author;
1304 category = lsi->category;
1305 unique_id = lsi->unique_id;
1307 n_inputs.set (DataType::AUDIO, 1);
1308 n_outputs.set (DataType::AUDIO, 1);
1311 _is_instrument = category == "Instrument";
1315 LuaPluginInfo::load (Session& session)
1317 std::string script = "";
1318 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
1319 return PluginPtr ();
1323 script = Glib::file_get_contents (path);
1324 } catch (Glib::FileError err) {
1325 return PluginPtr ();
1328 if (script.empty ()) {
1329 return PluginPtr ();
1333 PluginPtr plugin (new LuaProc (session.engine (), session, script));
1335 } catch (failed_constructor& err) {
1338 return PluginPtr ();
1341 std::vector<Plugin::PresetRecord>
1342 LuaPluginInfo::get_presets (bool /*user_only*/) const
1344 std::vector<Plugin::PresetRecord> p;
1345 XMLTree* t = new XMLTree;
1346 std::string pf = Glib::build_filename (ARDOUR::user_config_directory (), "presets", string_compose ("lua-%1", unique_id));
1347 if (Glib::file_test (pf, Glib::FILE_TEST_EXISTS)) {
1348 t->set_filename (pf);
1350 XMLNode* root = t->root ();
1351 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1352 XMLProperty const * uri = (*i)->property (X_("uri"));
1353 XMLProperty const * label = (*i)->property (X_("label"));
1354 p.push_back (Plugin::PresetRecord (uri->value(), label->value(), true));