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 int32_t audio_in = in.n_audio ();
384 int32_t 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 assert (i.value ().type () == LUA_TTABLE);
392 luabridge::LuaRef io (i.value ());
394 int possible_in = io["audio_in"];
395 int possible_out = io["audio_out"];
398 if ((possible_in == audio_in) && (possible_out == preferred_out)) {
399 _output_configs.insert (preferred_out);
406 /* now allow potentially "imprecise" matches */
407 int32_t audio_out = -1;
408 float penalty = 9999;
410 #define FOUNDCFG(nch) { \
411 float p = fabsf ((float)(nch) - preferred_out); \
412 _output_configs.insert (nch); \
413 if ((nch) > preferred_out) { p *= 1.1; } \
421 #define ANYTHINGGOES \
422 _output_configs.insert (0);
424 #define UPTO(nch) { \
425 for (int n = 1; n < nch; ++n) { \
426 _output_configs.insert (n); \
430 for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
431 assert (i.value ().type () == LUA_TTABLE);
432 luabridge::LuaRef io (i.value ());
434 int possible_in = io["audio_in"];
435 int possible_out = io["audio_out"];
437 if (possible_out == 0) {
438 if (possible_in == 0) {
439 if (_has_midi_output && audio_in == 0) {
440 // special case midi filters & generators
449 if (possible_in == 0) {
450 /* no inputs, generators & instruments */
451 if (possible_out == -1) {
452 /* any configuration possible, stereo output */
453 FOUNDCFG (preferred_out);
455 } else if (possible_out == -2) {
456 /* invalid, should be (0, -1) */
457 FOUNDCFG (preferred_out);
459 } else if (possible_out < -2) {
460 /* variable number of outputs up to -N, */
461 FOUNDCFG (min (-possible_out, preferred_out));
462 UPTO (-possible_out);
464 /* exact number of outputs */
465 FOUNDCFG (possible_out);
469 if (possible_in == -1) {
470 /* wildcard for input */
471 if (possible_out == -1) {
472 /* out must match in */
474 } else if (possible_out == -2) {
475 /* any configuration possible, pick matching */
476 FOUNDCFG (preferred_out);
478 } else if (possible_out < -2) {
479 /* explicitly variable number of outputs, pick maximum */
480 FOUNDCFG (max (-possible_out, preferred_out));
481 /* and try min, too, in case the penalty is lower */
482 FOUNDCFG (min (-possible_out, preferred_out));
485 /* exact number of outputs */
486 FOUNDCFG (possible_out);
490 if (possible_in == -2) {
491 if (possible_out == -1) {
492 /* any configuration possible, pick matching */
493 FOUNDCFG (preferred_out);
495 } else if (possible_out == -2) {
496 /* invalid. interpret as (-1, -1) */
497 FOUNDCFG (preferred_out);
499 } else if (possible_out < -2) {
500 /* invalid, interpret as (<-2, <-2)
501 * variable number of outputs up to -N, */
502 FOUNDCFG (min (-possible_out, preferred_out));
505 /* exact number of outputs */
506 FOUNDCFG (possible_out);
510 if (possible_in < -2) {
511 /* explicit variable number of inputs */
512 if (audio_in > -possible_in && imprecise != NULL) {
514 imprecise->set (DataType::AUDIO, -possible_in);
517 if (audio_in > -possible_in && imprecise == NULL) {
518 /* request is too large */
519 } else if (possible_out == -1) {
520 /* any output configuration possible */
521 FOUNDCFG (preferred_out);
523 } else if (possible_out == -2) {
524 /* invalid. interpret as (<-2, -1) */
525 FOUNDCFG (preferred_out);
527 } else if (possible_out < -2) {
528 /* variable number of outputs up to -N, */
529 FOUNDCFG (min (-possible_out, preferred_out));
532 /* exact number of outputs */
533 FOUNDCFG (possible_out);
537 if (possible_in && (possible_in == audio_in)) {
538 /* exact number of inputs ... must match obviously */
539 if (possible_out == -1) {
540 /* any output configuration possible */
541 FOUNDCFG (preferred_out);
543 } else if (possible_out == -2) {
544 /* invalid. interpret as (>0, -1) */
545 FOUNDCFG (preferred_out);
547 } else if (possible_out < -2) {
548 /* > 0, < -2 is not specified
549 * interpret as up to -N */
550 FOUNDCFG (min (-possible_out, preferred_out));
553 /* exact number of outputs */
554 FOUNDCFG (possible_out);
559 if (found && imprecise) {
563 if (!found && imprecise) {
565 for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
566 assert (i.value ().type () == LUA_TTABLE);
567 luabridge::LuaRef io (i.value ());
569 int possible_in = io["audio_in"];
570 int possible_out = io["audio_out"];
572 if (possible_out == 0 && possible_in == 0 && _has_midi_output) {
573 assert (audio_in > 0); // no input is handled above
574 // TODO hide audio input from plugin
575 imprecise->set (DataType::AUDIO, 0);
581 assert (possible_in > 0); // all other cases will have been matched above
582 assert (possible_out !=0 || possible_in !=0); // already handled above
584 imprecise->set (DataType::AUDIO, possible_in);
585 if (possible_out == -1 || possible_out == -2) {
587 } else if (possible_out < -2) {
588 /* explicitly variable number of outputs, pick maximum */
589 FOUNDCFG (min (-possible_out, preferred_out));
591 /* exact number of outputs */
592 FOUNDCFG (possible_out);
594 // ideally we'll also find the closest, best matching
595 // input configuration with minimal output penalty...
604 imprecise->set (DataType::MIDI, _has_midi_input ? 1 : 0);
605 _selected_in = *imprecise;
611 out.set (DataType::MIDI, midi_out);
612 out.set (DataType::AUDIO, preferred_out);
614 out.set (DataType::MIDI, midi_out);
615 out.set (DataType::AUDIO, audio_out);
623 LuaProc::configure_io (ChanCount in, ChanCount out)
625 in.set (DataType::MIDI, _has_midi_input ? 1 : 0);
626 out.set (DataType::MIDI, _has_midi_output ? 1 : 0);
628 _info->n_inputs = _selected_in;
629 _info->n_outputs = _selected_out;
631 // configure the DSP if needed
632 if (in != _configured_in || out != _configured_out) {
633 lua_State* L = lua.getState ();
634 luabridge::LuaRef lua_dsp_configure = luabridge::getGlobal (L, "dsp_configure");
635 if (lua_dsp_configure.type () == LUA_TFUNCTION) {
637 luabridge::LuaRef io = lua_dsp_configure (&in, &out);
639 ChanCount lin (_selected_in);
640 ChanCount lout (_selected_out);
642 if (io["audio_in"].type() == LUA_TNUMBER) {
643 const int c = io["audio_in"].cast<int> ();
645 lin.set (DataType::AUDIO, c);
648 if (io["audio_out"].type() == LUA_TNUMBER) {
649 const int c = io["audio_out"].cast<int> ();
651 lout.set (DataType::AUDIO, c);
654 if (io["midi_in"].type() == LUA_TNUMBER) {
655 const int c = io["midi_in"].cast<int> ();
657 lin.set (DataType::MIDI, c);
660 if (io["midi_out"].type() == LUA_TNUMBER) {
661 const int c = io["midi_out"].cast<int> ();
663 lout.set (DataType::MIDI, c);
666 _info->n_inputs = lin;
667 _info->n_outputs = lout;
669 } catch (luabridge::LuaException const& e) {
670 PBD::error << "LuaException: " << e.what () << "\n";
672 std::cerr << "LuaException: " << e.what () << "\n";
680 _configured_out = out;
686 LuaProc::connect_and_run (BufferSet& bufs,
687 framepos_t start, framepos_t end, double speed,
688 ChanMapping in, ChanMapping out,
689 pframes_t nframes, framecnt_t offset)
695 Plugin::connect_and_run (bufs, start, end, speed, in, out, nframes, offset);
697 // This is needed for ARDOUR::Session requests :(
698 if (! SessionEvent::has_per_thread_pool ()) {
700 snprintf (name, 64, "Proc-%p", this);
701 pthread_set_name (name);
702 SessionEvent::create_per_thread_pool (name, 64);
703 PBD::notify_event_loops_about_thread_creation (pthread_self(), name, 64);
706 uint32_t const n = parameter_count ();
707 for (uint32_t i = 0; i < n; ++i) {
708 if (parameter_is_control (i) && parameter_is_input (i)) {
709 _control_data[i] = _shadow_data[i];
713 #ifdef WITH_LUAPROC_STATS
714 int64_t t0 = g_get_monotonic_time ();
718 if (_lua_does_channelmapping) {
719 // run the DSP function
720 (*_lua_dsp)(&bufs, in, out, nframes, offset);
723 BufferSet& silent_bufs = _session.get_silent_buffers (ChanCount (DataType::AUDIO, 1));
724 BufferSet& scratch_bufs = _session.get_scratch_buffers (ChanCount (DataType::AUDIO, 1));
726 lua_State* L = lua.getState ();
727 luabridge::LuaRef in_map (luabridge::newTable (L));
728 luabridge::LuaRef out_map (luabridge::newTable (L));
730 const uint32_t audio_in = _configured_in.n_audio ();
731 const uint32_t audio_out = _configured_out.n_audio ();
732 const uint32_t midi_in = _configured_in.n_midi ();
734 for (uint32_t ap = 0; ap < audio_in; ++ap) {
736 const uint32_t buf_index = in.get(DataType::AUDIO, ap, &valid);
738 in_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
740 in_map[ap + 1] = silent_bufs.get_audio (0).data (offset);
743 for (uint32_t ap = 0; ap < audio_out; ++ap) {
745 const uint32_t buf_index = out.get(DataType::AUDIO, ap, &valid);
747 out_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
749 out_map[ap + 1] = scratch_bufs.get_audio (0).data (offset);
753 luabridge::LuaRef lua_midi_src_tbl (luabridge::newTable (L));
754 int e = 1; // > 1 port, we merge events (unsorted)
755 for (uint32_t mp = 0; mp < midi_in; ++mp) {
757 const uint32_t idx = in.get(DataType::MIDI, mp, &valid);
759 for (MidiBuffer::iterator m = bufs.get_midi(idx).begin();
760 m != bufs.get_midi(idx).end(); ++m, ++e) {
761 const Evoral::MIDIEvent<framepos_t> ev(*m, false);
762 luabridge::LuaRef lua_midi_data (luabridge::newTable (L));
763 const uint8_t* data = ev.buffer();
764 for (uint32_t i = 0; i < ev.size(); ++i) {
765 lua_midi_data [i + 1] = data[i];
767 luabridge::LuaRef lua_midi_event (luabridge::newTable (L));
768 lua_midi_event["time"] = 1 + (*m).time();
769 lua_midi_event["data"] = lua_midi_data;
770 lua_midi_src_tbl[e] = lua_midi_event;
775 if (_has_midi_input) {
776 // XXX TODO This needs a better solution than global namespace
777 luabridge::push (L, lua_midi_src_tbl);
778 lua_setglobal (L, "midiin");
781 luabridge::LuaRef lua_midi_sink_tbl (luabridge::newTable (L));
782 if (_has_midi_output) {
783 luabridge::push (L, lua_midi_sink_tbl);
784 lua_setglobal (L, "midiout");
787 // run the DSP function
788 (*_lua_dsp)(in_map, out_map, nframes);
790 // copy back midi events
791 if (_has_midi_output && lua_midi_sink_tbl.isTable ()) {
793 const uint32_t idx = out.get(DataType::MIDI, 0, &valid);
794 if (valid && bufs.count().n_midi() > idx) {
795 MidiBuffer& mbuf = bufs.get_midi(idx);
797 for (luabridge::Iterator i (lua_midi_sink_tbl); !i.isNil (); ++i) {
798 if (!i.key ().isNumber ()) { continue; }
799 if (!i.value ()["time"].isNumber ()) { continue; }
800 if (!i.value ()["data"].isTable ()) { continue; }
801 luabridge::LuaRef data_tbl (i.value ()["data"]);
802 framepos_t tme = i.value ()["time"];
803 if (tme < 1 || tme > nframes) { continue; }
806 for (luabridge::Iterator di (data_tbl); !di.isNil () && size < sizeof(data); ++di, ++size) {
807 data[size] = di.value ();
809 if (size > 0 && size < 64) {
810 mbuf.push_back(tme - 1, size, data);
817 } catch (luabridge::LuaException const& e) {
818 PBD::error << "LuaException: " << e.what () << "\n";
820 std::cerr << "LuaException: " << e.what () << "\n";
824 #ifdef WITH_LUAPROC_STATS
825 int64_t t1 = g_get_monotonic_time ();
828 lua.collect_garbage_step ();
829 #ifdef WITH_LUAPROC_STATS
831 int64_t t2 = g_get_monotonic_time ();
832 int64_t ela0 = t1 - t0;
833 int64_t ela1 = t2 - t1;
834 if (ela0 > _stats_max[0]) _stats_max[0] = ela0;
835 if (ela1 > _stats_max[1]) _stats_max[1] = ela1;
836 _stats_avg[0] += ela0;
837 _stats_avg[1] += ela1;
844 LuaProc::add_state (XMLNode* root) const
850 gchar* b64 = g_base64_encode ((const guchar*)_script.c_str (), _script.size ());
851 std::string b64s (b64);
853 XMLNode* script_node = new XMLNode (X_("script"));
854 script_node->add_property (X_("lua"), LUA_VERSION);
855 script_node->add_content (b64s);
856 root->add_child_nocopy (*script_node);
858 for (uint32_t i = 0; i < parameter_count(); ++i) {
859 if (parameter_is_input(i) && parameter_is_control(i)) {
860 child = new XMLNode("Port");
861 snprintf(buf, sizeof(buf), "%u", i);
862 child->add_property("id", std::string(buf));
863 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
864 child->add_property("value", std::string(buf));
865 root->add_child_nocopy(*child);
871 LuaProc::set_script_from_state (const XMLNode& node)
874 if (node.name () != state_node_name ()) {
878 if ((child = node.child (X_("script"))) != 0) {
879 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
880 if (!(*n)->is_content ()) { continue; }
882 guchar* buf = g_base64_decode ((*n)->content ().c_str (), &size);
883 _script = std::string ((const char*)buf, size);
885 if (load_script ()) {
886 PBD::error << _("Failed to load Lua script from session state.") << endmsg;
888 std::cerr << "Failed Lua Script: " << _script << std::endl;
895 if (_script.empty ()) {
896 PBD::error << _("Session State for LuaProcessor did not include a Lua script.") << endmsg;
900 PBD::error << _("Invalid/incompatible Lua script found for LuaProcessor.") << endmsg;
907 LuaProc::set_state (const XMLNode& node, int version)
909 #ifndef NO_PLUGIN_STATE
911 XMLProperty const * prop;
912 XMLNodeConstIterator iter;
920 if (_script.empty ()) {
921 if (set_script_from_state (node)) {
926 #ifndef NO_PLUGIN_STATE
927 if (node.name() != state_node_name()) {
928 error << _("Bad node sent to LuaProc::set_state") << endmsg;
932 nodes = node.children ("Port");
933 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
935 if ((prop = child->property("id")) != 0) {
936 port = prop->value().c_str();
938 warning << _("LuaProc: port has no symbol, ignored") << endmsg;
941 if ((prop = child->property("value")) != 0) {
942 value = prop->value().c_str();
944 warning << _("LuaProc: port has no value, ignored") << endmsg;
947 sscanf (port, "%" PRIu32, &port_id);
948 set_parameter (port_id, atof(value));
952 return Plugin::set_state (node, version);
956 LuaProc::parameter_count () const
958 return _ctrl_params.size ();
962 LuaProc::default_value (uint32_t port)
964 if (_ctrl_params[port].first) {
968 int lp = _ctrl_params[port].second;
969 return _param_desc[lp].normal;
973 LuaProc::set_parameter (uint32_t port, float val)
975 assert (port < parameter_count ());
976 if (get_parameter (port) == val) {
979 _shadow_data[port] = val;
980 Plugin::set_parameter (port, val);
984 LuaProc::get_parameter (uint32_t port) const
986 if (parameter_is_input (port)) {
987 return _shadow_data[port];
989 return _control_data[port];
994 LuaProc::get_parameter_descriptor (uint32_t port, ParameterDescriptor& desc) const
996 assert (port <= parameter_count ());
997 int lp = _ctrl_params[port].second;
998 const ParameterDescriptor& d (_param_desc.find(lp)->second);
1000 desc.lower = d.lower;
1001 desc.upper = d.upper;
1002 desc.normal = d.normal;
1003 desc.toggled = d.toggled;
1004 desc.logarithmic = d.logarithmic;
1005 desc.integer_step = d.integer_step;
1006 desc.sr_dependent = d.sr_dependent;
1007 desc.enumeration = d.enumeration;
1009 desc.label = d.label;
1010 desc.scale_points = d.scale_points;
1012 desc.update_steps ();
1017 LuaProc::get_parameter_docs (uint32_t port) const {
1018 assert (port <= parameter_count ());
1019 int lp = _ctrl_params[port].second;
1020 return _param_doc.find(lp)->second;
1024 LuaProc::nth_parameter (uint32_t port, bool& ok) const
1026 if (port < _ctrl_params.size ()) {
1035 LuaProc::parameter_is_input (uint32_t port) const
1037 assert (port < _ctrl_params.size ());
1038 return (!_ctrl_params[port].first);
1042 LuaProc::parameter_is_output (uint32_t port) const
1044 assert (port < _ctrl_params.size ());
1045 return (_ctrl_params[port].first);
1048 std::set<Evoral::Parameter>
1049 LuaProc::automatable () const
1051 std::set<Evoral::Parameter> automatables;
1052 for (uint32_t i = 0; i < _ctrl_params.size (); ++i) {
1053 if (parameter_is_input (i)) {
1054 automatables.insert (automatables.end (), Evoral::Parameter (PluginAutomation, 0, i));
1057 return automatables;
1061 LuaProc::describe_parameter (Evoral::Parameter param)
1063 if (param.type () == PluginAutomation && param.id () < parameter_count ()) {
1064 int lp = _ctrl_params[param.id ()].second;
1065 return _param_desc[lp].label;
1071 LuaProc::print_parameter (uint32_t param, char* buf, uint32_t len) const
1074 if (param < parameter_count ()) {
1075 snprintf (buf, len, "%.3f", get_parameter (param));
1082 boost::shared_ptr<ScalePoints>
1083 LuaProc::parse_scale_points (luabridge::LuaRef* lr)
1085 if (!(*lr)["scalepoints"].isTable()) {
1086 return boost::shared_ptr<ScalePoints> ();
1090 boost::shared_ptr<ScalePoints> rv = boost::shared_ptr<ScalePoints>(new ScalePoints());
1091 luabridge::LuaRef scalepoints ((*lr)["scalepoints"]);
1093 for (luabridge::Iterator i (scalepoints); !i.isNil (); ++i) {
1094 if (!i.key ().isString ()) { continue; }
1095 if (!i.value ().isNumber ()) { continue; }
1096 rv->insert(make_pair(i.key ().cast<std::string> (),
1097 i.value ().cast<float> ()));
1101 if (rv->size() > 0) {
1104 return boost::shared_ptr<ScalePoints> ();
1107 boost::shared_ptr<ScalePoints>
1108 LuaProc::get_scale_points (uint32_t port) const
1110 int lp = _ctrl_params[port].second;
1111 return _param_desc.find(lp)->second.scale_points;
1115 LuaProc::setup_lua_inline_gui (LuaState *lua_gui)
1117 lua_State* LG = lua_gui->getState ();
1118 LuaBindings::stddef (LG);
1119 LuaBindings::common (LG);
1120 LuaBindings::dsp (LG);
1122 lua_gui->Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
1123 lua_gui->do_command ("function ardour () end");
1124 lua_gui->do_command (_script);
1126 // TODO think: use a weak-pointer here ?
1127 // (the GUI itself uses a shared ptr to this plugin, so we should be good)
1128 luabridge::getGlobalNamespace (LG)
1129 .beginNamespace ("Ardour")
1130 .beginClass <LuaProc> ("LuaProc")
1131 .addFunction ("shmem", &LuaProc::instance_shm)
1132 .addFunction ("table", &LuaProc::instance_ref)
1136 luabridge::push <LuaProc *> (LG, this);
1137 lua_setglobal (LG, "self");
1139 luabridge::push <float *> (LG, _shadow_data);
1140 lua_setglobal (LG, "CtrlPorts");
1142 ////////////////////////////////////////////////////////////////////////////////
1144 #include "ardour/search_paths.h"
1148 LuaProc::preset_name_to_uri (const std::string& name) const
1150 std::string uri ("urn:lua:");
1154 sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
1155 sha1_write (&s, (const uint8_t *) _script.c_str(), _script.size ());
1156 sha1_result_hash (&s, hash);
1161 LuaProc::presets_file () const
1163 return string_compose ("lua-%1", _info->unique_id);
1167 LuaProc::presets_tree () const
1169 XMLTree* t = new XMLTree;
1170 std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1172 if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
1173 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
1174 error << _("Unable to create LuaProc presets directory") << endmsg;
1178 p = Glib::build_filename (p, presets_file ());
1180 if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
1181 t->set_root (new XMLNode (X_("LuaPresets")));
1185 t->set_filename (p);
1194 LuaProc::load_preset (PresetRecord r)
1196 boost::shared_ptr<XMLTree> t (presets_tree ());
1201 XMLNode* root = t->root ();
1202 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1203 XMLProperty const * label = (*i)->property (X_("label"));
1205 if (label->value() != r.label) {
1209 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
1210 if ((*j)->name() == X_("Parameter")) {
1211 XMLProperty const * index = (*j)->property (X_("index"));
1212 XMLProperty const * value = (*j)->property (X_("value"));
1216 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
1219 return Plugin::load_preset(r);
1225 LuaProc::do_save_preset (std::string name) {
1227 boost::shared_ptr<XMLTree> t (presets_tree ());
1232 std::string uri (preset_name_to_uri (name));
1234 XMLNode* p = new XMLNode (X_("Preset"));
1235 p->add_property (X_("uri"), uri);
1236 p->add_property (X_("label"), name);
1238 for (uint32_t i = 0; i < parameter_count(); ++i) {
1239 if (parameter_is_input (i)) {
1240 XMLNode* c = new XMLNode (X_("Parameter"));
1241 c->add_property (X_("index"), string_compose ("%1", i));
1242 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
1243 p->add_child_nocopy (*c);
1246 t->root()->add_child_nocopy (*p);
1248 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1249 f = Glib::build_filename (f, presets_file ());
1256 LuaProc::do_remove_preset (std::string name)
1258 boost::shared_ptr<XMLTree> t (presets_tree ());
1262 t->root()->remove_nodes_and_delete (X_("label"), name);
1263 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1264 f = Glib::build_filename (f, presets_file ());
1269 LuaProc::find_presets ()
1271 boost::shared_ptr<XMLTree> t (presets_tree ());
1273 XMLNode* root = t->root ();
1274 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1276 XMLProperty const * uri = (*i)->property (X_("uri"));
1277 XMLProperty const * label = (*i)->property (X_("label"));
1282 PresetRecord r (uri->value(), label->value(), true);
1283 _presets.insert (make_pair (r.uri, r));
1288 ////////////////////////////////////////////////////////////////////////////////
1290 LuaPluginInfo::LuaPluginInfo (LuaScriptInfoPtr lsi) {
1291 if (lsi->type != LuaScriptInfo::DSP) {
1292 throw failed_constructor ();
1297 creator = lsi->author;
1298 category = lsi->category;
1299 unique_id = lsi->unique_id;
1301 n_inputs.set (DataType::AUDIO, 1);
1302 n_outputs.set (DataType::AUDIO, 1);
1305 _is_instrument = category == "Instrument";
1309 LuaPluginInfo::load (Session& session)
1311 std::string script = "";
1312 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
1313 return PluginPtr ();
1317 script = Glib::file_get_contents (path);
1318 } catch (Glib::FileError err) {
1319 return PluginPtr ();
1322 if (script.empty ()) {
1323 return PluginPtr ();
1327 PluginPtr plugin (new LuaProc (session.engine (), session, script));
1329 } catch (failed_constructor& err) {
1332 return PluginPtr ();
1335 std::vector<Plugin::PresetRecord>
1336 LuaPluginInfo::get_presets (bool /*user_only*/) const
1338 std::vector<Plugin::PresetRecord> p;
1339 XMLTree* t = new XMLTree;
1340 std::string pf = Glib::build_filename (ARDOUR::user_config_directory (), "presets", string_compose ("lua-%1", unique_id));
1341 if (Glib::file_test (pf, Glib::FILE_TEST_EXISTS)) {
1342 t->set_filename (pf);
1344 XMLNode* root = t->root ();
1345 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1346 XMLProperty const * uri = (*i)->property (X_("uri"));
1347 XMLProperty const * label = (*i)->property (X_("label"));
1348 p.push_back (Plugin::PresetRecord (uri->value(), label->value(), true));