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"
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)
50 , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
53 , _lua_does_channelmapping (false)
54 , _lua_has_inline_display (false)
55 , _designated_bypass_port (UINT32_MAX)
58 , _has_midi_input (false)
59 , _has_midi_output (false)
63 /* when loading a session, or pasing a processor,
64 * the script is set during set_state();
66 if (!_script.empty () && load_script ()) {
67 throw failed_constructor ();
71 LuaProc::LuaProc (const LuaProc &other)
73 , _mempool ("LuaProc", 2097152)
74 , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
76 , _script (other.script ())
77 , _lua_does_channelmapping (false)
78 , _lua_has_inline_display (false)
79 , _designated_bypass_port (UINT32_MAX)
82 , _has_midi_input (false)
83 , _has_midi_output (false)
88 throw failed_constructor ();
91 for (uint32_t i = 0; i < parameter_count (); ++i) {
92 _control_data[i] = other._shadow_data[i];
93 _shadow_data[i] = other._shadow_data[i];
97 LuaProc::~LuaProc () {
98 #ifdef WITH_LUAPROC_STATS
99 if (_info && _stats_cnt > 0) {
100 printf ("LuaProc: '%s' run() avg: %.3f max: %.3f [ms]\n",
101 _info->name.c_str (),
102 0.0001f * _stats_avg[0] / (float) _stats_cnt,
103 0.0001f * _stats_max[0]);
104 printf ("LuaProc: '%s' gc() avg: %.3f max: %.3f [ms]\n",
105 _info->name.c_str (),
106 0.0001f * _stats_avg[1] / (float) _stats_cnt,
107 0.0001f * _stats_max[1]);
110 lua.do_command ("collectgarbage();");
112 delete [] _control_data;
113 delete [] _shadow_data;
119 #ifdef WITH_LUAPROC_STATS
120 _stats_avg[0] = _stats_avg[1] = _stats_max[0] = _stats_max[1] = _stats_cnt = 0;
124 lua.Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
125 // register session object
126 lua_State* L = lua.getState ();
127 LuaBindings::stddef (L);
128 LuaBindings::common (L);
129 LuaBindings::dsp (L);
131 luabridge::getGlobalNamespace (L)
132 .beginNamespace ("Ardour")
133 .beginClass <LuaProc> ("LuaProc")
134 .addFunction ("queue_draw", &LuaProc::queue_draw)
135 .addFunction ("shmem", &LuaProc::instance_shm)
136 .addFunction ("table", &LuaProc::instance_ref)
140 // add session to global lua namespace
141 luabridge::push <Session *> (L, &_session);
142 lua_setglobal (L, "Session");
145 luabridge::push <LuaProc *> (L, this);
146 lua_setglobal (L, "self");
149 lua.do_command ("io = nil os = nil loadfile = nil require = nil dofile = nil package = nil debug = nil");
151 lua.do_command ("for n in pairs(_G) do print(n) end print ('----')"); // print global env
153 lua.do_command ("function ardour () end");
157 LuaProc::lua_print (std::string s) {
158 std::cout <<"LuaProc: " << s << "\n";
159 PBD::error << "LuaProc: " << s << "\n";
163 LuaProc::load_script ()
165 assert (!_lua_dsp); // don't allow to re-initialize
166 LuaPluginInfoPtr lpi;
168 // TODO: refine APIs; function arguments..
169 // - perform channel-map in ardour (silent/scratch buffers) ?
170 // - control-port API (explicit get/set functions ??)
171 // - latency reporting (global var? ctrl-port? set-function ?)
172 // - MIDI -> sparse table of events
173 // { [sample] => { Event }, .. }
174 // or { { sample, Event }, .. }
177 LuaScriptInfoPtr lsi = LuaScripting::script_info (_script);
178 lpi = LuaPluginInfoPtr (new LuaPluginInfo (lsi));
181 _mempool.set_name ("LuaProc: " + lsi->name);
182 _docs = lsi->description;
183 } catch (failed_constructor& err) {
187 lua_State* L = lua.getState ();
188 lua.do_command (_script);
190 // check if script has a DSP callback
191 luabridge::LuaRef lua_dsp_run = luabridge::getGlobal (L, "dsp_run");
192 luabridge::LuaRef lua_dsp_map = luabridge::getGlobal (L, "dsp_runmap");
194 if ((lua_dsp_run.type () != LUA_TFUNCTION) == (lua_dsp_map.type () != LUA_TFUNCTION)) {
198 if (lua_dsp_run.type () == LUA_TFUNCTION) {
199 _lua_dsp = new luabridge::LuaRef (lua_dsp_run);
201 else if (lua_dsp_map.type () == LUA_TFUNCTION) {
202 _lua_dsp = new luabridge::LuaRef (lua_dsp_map);
203 _lua_does_channelmapping = true;
209 // initialize the DSP if needed
210 luabridge::LuaRef lua_dsp_init = luabridge::getGlobal (L, "dsp_init");
211 if (lua_dsp_init.type () == LUA_TFUNCTION) {
213 lua_dsp_init (_session.nominal_frame_rate ());
214 } catch (luabridge::LuaException const& e) {
220 luabridge::LuaRef lua_dsp_has_midi_in = luabridge::getGlobal (L, "dsp_has_midi_input");
221 if (lua_dsp_has_midi_in.type () == LUA_TFUNCTION) {
223 _has_midi_input = lua_dsp_has_midi_in ();
224 } catch (luabridge::LuaException const& e) {
229 luabridge::LuaRef lua_dsp_has_midi_out = luabridge::getGlobal (L, "dsp_has_midi_output");
230 if (lua_dsp_has_midi_out.type () == LUA_TFUNCTION) {
232 _has_midi_output = lua_dsp_has_midi_out ();
233 } catch (luabridge::LuaException const& e) {
238 _ctrl_params.clear ();
240 luabridge::LuaRef lua_render = luabridge::getGlobal (L, "render_inline");
241 if (lua_render.isFunction ()) {
242 _lua_has_inline_display = true;
245 luabridge::LuaRef lua_params = luabridge::getGlobal (L, "dsp_params");
246 if (lua_params.isFunction ()) {
248 // call function // add try {} catch (luabridge::LuaException const& e)
249 luabridge::LuaRef params = lua_params ();
251 if (params.isTable ()) {
253 for (luabridge::Iterator i (params); !i.isNil (); ++i) {
255 if (!i.key ().isNumber ()) { return false; }
256 if (!i.value ().isTable ()) { return false; }
257 if (!i.value ()["type"].isString ()) { return false; }
258 if (!i.value ()["name"].isString ()) { return false; }
259 if (!i.value ()["min"].isNumber ()) { return false; }
260 if (!i.value ()["max"].isNumber ()) { return false; }
262 int pn = i.key ().cast<int> ();
263 std::string type = i.value ()["type"].cast<std::string> ();
264 if (type == "input") {
265 if (!i.value ()["default"].isNumber ()) { return false; }
266 _ctrl_params.push_back (std::make_pair (false, pn));
268 else if (type == "output") {
269 _ctrl_params.push_back (std::make_pair (true, pn));
273 assert (pn == (int) _ctrl_params.size ());
275 //_param_desc[pn] = boost::shared_ptr<ParameterDescriptor> (new ParameterDescriptor());
276 luabridge::LuaRef lr = i.value ();
278 if (type == "input") {
279 _param_desc[pn].normal = lr["default"].cast<float> ();
281 _param_desc[pn].normal = lr["min"].cast<float> (); // output-port, no default
283 _param_desc[pn].lower = lr["min"].cast<float> ();
284 _param_desc[pn].upper = lr["max"].cast<float> ();
285 _param_desc[pn].toggled = lr["toggled"].isBoolean () && (lr["toggled"]).cast<bool> ();
286 _param_desc[pn].logarithmic = lr["logarithmic"].isBoolean () && (lr["logarithmic"]).cast<bool> ();
287 _param_desc[pn].integer_step = lr["integer"].isBoolean () && (lr["integer"]).cast<bool> ();
288 _param_desc[pn].sr_dependent = lr["ratemult"].isBoolean () && (lr["ratemult"]).cast<bool> ();
289 _param_desc[pn].enumeration = lr["enum"].isBoolean () && (lr["enum"]).cast<bool> ();
291 if (lr["bypass"].isBoolean () && (lr["bypass"]).cast<bool> ()) {
292 _designated_bypass_port = pn - 1; // lua table starts at 1.
295 if (lr["unit"].isString ()) {
296 std::string unit = lr["unit"].cast<std::string> ();
297 if (unit == "dB") { _param_desc[pn].unit = ParameterDescriptor::DB; }
298 else if (unit == "Hz") { _param_desc[pn].unit = ParameterDescriptor::HZ; }
299 else if (unit == "Midi Note") { _param_desc[pn].unit = ParameterDescriptor::MIDI_NOTE; }
301 _param_desc[pn].label = (lr["name"]).cast<std::string> ();
302 _param_desc[pn].scale_points = parse_scale_points (&lr);
304 luabridge::LuaRef doc = lr["doc"];
305 if (doc.isString ()) {
306 _param_doc[pn] = doc.cast<std::string> ();
310 assert (!(_param_desc[pn].toggled && _param_desc[pn].logarithmic));
315 _control_data = new float[parameter_count ()];
316 _shadow_data = new float[parameter_count ()];
318 for (uint32_t i = 0; i < parameter_count (); ++i) {
319 if (parameter_is_input (i)) {
320 _control_data[i] = _shadow_data[i] = default_value (i);
324 // expose ctrl-ports to global lua namespace
325 luabridge::push <float *> (L, _control_data);
326 lua_setglobal (L, "CtrlPorts");
328 return false; // no error
332 LuaProc::can_support_io_configuration (const ChanCount& in, ChanCount& out, ChanCount* imprecise)
334 // caller must hold process lock (no concurrent calls to interpreter
335 _output_configs.clear ();
337 if (in.n_midi() > 0 && !_has_midi_input && !imprecise) {
341 lua_State* L = lua.getState ();
342 luabridge::LuaRef ioconfig = luabridge::getGlobal (L, "dsp_ioconfig");
343 if (!ioconfig.isFunction ()) {
347 luabridge::LuaRef *_iotable = NULL; // can't use reference :(
349 luabridge::LuaRef iotable = ioconfig ();
350 if (iotable.isTable ()) {
351 _iotable = new luabridge::LuaRef (iotable);
353 } catch (luabridge::LuaException const& e) {
361 // now we can reference it.
362 luabridge::LuaRef iotable (*_iotable);
365 if ((iotable).length () < 1) {
370 bool exact_match = false;
371 const int32_t audio_in = in.n_audio ();
372 int32_t midi_out = _has_midi_output ? 1 : 0;
374 // preferred setting (provided by plugin_insert)
375 assert (out.n_audio () > 0 || midi_out > 0);
376 const int preferred_out = out.n_audio ();
378 for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
379 assert (i.value ().type () == LUA_TTABLE);
380 luabridge::LuaRef io (i.value ());
382 int possible_in = io["audio_in"];
383 int possible_out = io["audio_out"];
386 if ((possible_in == audio_in) && (possible_out == preferred_out)) {
387 _output_configs.insert (preferred_out);
394 /* now allow potentially "imprecise" matches */
395 int32_t audio_out = -1;
396 float penalty = 9999;
398 #define FOUNDCFG(nch) { \
399 float p = fabsf ((float)(nch) - preferred_out); \
400 _output_configs.insert (nch); \
401 if ((nch) > preferred_out) { p *= 1.1; } \
409 #define ANYTHINGGOES \
410 _output_configs.insert (0);
412 #define UPTO(nch) { \
413 for (int n = 1; n < nch; ++n) { \
414 _output_configs.insert (n); \
418 for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
419 assert (i.value ().type () == LUA_TTABLE);
420 luabridge::LuaRef io (i.value ());
422 int possible_in = io["audio_in"];
423 int possible_out = io["audio_out"];
425 if (possible_out == 0) {
426 if (possible_in == 0) {
427 if (_has_midi_output && audio_in == 0) {
428 // special case midi filters & generators
437 if (possible_in == 0) {
438 /* no inputs, generators & instruments */
439 if (possible_out == -1) {
440 /* any configuration possible, stereo output */
441 FOUNDCFG (preferred_out);
443 } else if (possible_out == -2) {
444 /* invalid, should be (0, -1) */
445 FOUNDCFG (preferred_out);
447 } else if (possible_out < -2) {
448 /* variable number of outputs up to -N, */
449 FOUNDCFG (min (-possible_out, preferred_out));
450 UPTO (-possible_out);
452 /* exact number of outputs */
453 FOUNDCFG (possible_out);
457 if (possible_in == -1) {
458 /* wildcard for input */
459 if (possible_out == -1) {
460 /* out must match in */
462 } else if (possible_out == -2) {
463 /* any configuration possible, pick matching */
464 FOUNDCFG (preferred_out);
466 } else if (possible_out < -2) {
467 /* explicitly variable number of outputs, pick maximum */
468 FOUNDCFG (max (-possible_out, preferred_out));
469 /* and try min, too, in case the penalty is lower */
470 FOUNDCFG (min (-possible_out, preferred_out));
473 /* exact number of outputs */
474 FOUNDCFG (possible_out);
478 if (possible_in == -2) {
479 if (possible_out == -1) {
480 /* any configuration possible, pick matching */
481 FOUNDCFG (preferred_out);
483 } else if (possible_out == -2) {
484 /* invalid. interpret as (-1, -1) */
485 FOUNDCFG (preferred_out);
487 } else if (possible_out < -2) {
488 /* invalid, interpret as (<-2, <-2)
489 * variable number of outputs up to -N, */
490 FOUNDCFG (min (-possible_out, preferred_out));
493 /* exact number of outputs */
494 FOUNDCFG (possible_out);
498 if (possible_in < -2) {
499 /* explicit variable number of inputs */
500 if (audio_in > -possible_in && imprecise != NULL) {
502 imprecise->set (DataType::AUDIO, -possible_in);
505 if (audio_in > -possible_in && imprecise == NULL) {
506 /* request is too large */
507 } else if (possible_out == -1) {
508 /* any output configuration possible */
509 FOUNDCFG (preferred_out);
511 } else if (possible_out == -2) {
512 /* invalid. interpret as (<-2, -1) */
513 FOUNDCFG (preferred_out);
515 } else if (possible_out < -2) {
516 /* variable number of outputs up to -N, */
517 FOUNDCFG (min (-possible_out, preferred_out));
520 /* exact number of outputs */
521 FOUNDCFG (possible_out);
525 if (possible_in && (possible_in == audio_in)) {
526 /* exact number of inputs ... must match obviously */
527 if (possible_out == -1) {
528 /* any output configuration possible */
529 FOUNDCFG (preferred_out);
531 } else if (possible_out == -2) {
532 /* invalid. interpret as (>0, -1) */
533 FOUNDCFG (preferred_out);
535 } else if (possible_out < -2) {
536 /* > 0, < -2 is not specified
537 * interpret as up to -N */
538 FOUNDCFG (min (-possible_out, preferred_out));
541 /* exact number of outputs */
542 FOUNDCFG (possible_out);
547 if (found && imprecise) {
549 imprecise->set (DataType::MIDI, _has_midi_input ? 1 : 0);
552 if (!found && imprecise) {
554 for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
555 assert (i.value ().type () == LUA_TTABLE);
556 luabridge::LuaRef io (i.value ());
558 int possible_in = io["audio_in"];
559 int possible_out = io["audio_out"];
561 if (possible_out == 0 && possible_in == 0 && _has_midi_output) {
562 assert (audio_in > 0); // no input is handled above
563 // TODO hide audio input from plugin
564 imprecise->set (DataType::AUDIO, 0);
570 assert (possible_in > 0); // all other cases will have been matched above
571 assert (possible_out !=0 || possible_in !=0); // already handled above
573 imprecise->set (DataType::AUDIO, possible_in);
574 if (possible_out == -1 || possible_out == -2) {
576 } else if (possible_out < -2) {
577 /* explicitly variable number of outputs, pick maximum */
578 FOUNDCFG (min (-possible_out, preferred_out));
580 /* exact number of outputs */
581 FOUNDCFG (possible_out);
583 // ideally we'll also find the closest, best matching
584 // input configuration with minimal output penalty...
593 imprecise->set (DataType::MIDI, _has_midi_input ? 1 : 0);
594 _selected_in = *imprecise;
600 out.set (DataType::MIDI, midi_out);
601 out.set (DataType::AUDIO, preferred_out);
603 out.set (DataType::MIDI, midi_out);
604 out.set (DataType::AUDIO, audio_out);
612 LuaProc::configure_io (ChanCount in, ChanCount out)
614 in.set (DataType::MIDI, _has_midi_input ? 1 : 0);
615 out.set (DataType::MIDI, _has_midi_output ? 1 : 0);
617 _info->n_inputs = _selected_in;
618 _info->n_outputs = _selected_out;
620 // configure the DSP if needed
621 if (in != _configured_in || out != _configured_out) {
622 lua_State* L = lua.getState ();
623 luabridge::LuaRef lua_dsp_configure = luabridge::getGlobal (L, "dsp_configure");
624 if (lua_dsp_configure.type () == LUA_TFUNCTION) {
626 luabridge::LuaRef io = lua_dsp_configure (&in, &out);
628 ChanCount lin (_selected_in);
629 ChanCount lout (_selected_out);
631 if (io["audio_in"].type() == LUA_TNUMBER) {
632 const int c = io["audio_in"].cast<int> ();
634 lin.set (DataType::AUDIO, c);
637 if (io["audio_out"].type() == LUA_TNUMBER) {
638 const int c = io["audio_out"].cast<int> ();
640 lout.set (DataType::AUDIO, c);
643 if (io["midi_in"].type() == LUA_TNUMBER) {
644 const int c = io["midi_in"].cast<int> ();
646 lin.set (DataType::MIDI, c);
649 _info->n_inputs = lin;
650 if (io["midi_out"].type() == LUA_TNUMBER) {
651 const int c = io["midi_out"].cast<int> ();
653 lout.set (DataType::MIDI, c);
656 _info->n_inputs = lin;
657 _info->n_outputs = lout;
659 } catch (luabridge::LuaException const& e) {
660 PBD::error << "LuaException: " << e.what () << "\n";
662 std::cerr << "LuaException: " << e.what () << "\n";
670 _configured_out = out;
676 LuaProc::connect_and_run (BufferSet& bufs,
677 framepos_t start, framepos_t end, double speed,
678 ChanMapping in, ChanMapping out,
679 pframes_t nframes, framecnt_t offset)
685 Plugin::connect_and_run (bufs, start, end, speed, in, out, nframes, offset);
687 // This is needed for ARDOUR::Session requests :(
688 if (! SessionEvent::has_per_thread_pool ()) {
690 snprintf (name, 64, "Proc-%p", this);
691 pthread_set_name (name);
692 SessionEvent::create_per_thread_pool (name, 64);
693 PBD::notify_event_loops_about_thread_creation (pthread_self(), name, 64);
696 uint32_t const n = parameter_count ();
697 for (uint32_t i = 0; i < n; ++i) {
698 if (parameter_is_control (i) && parameter_is_input (i)) {
699 _control_data[i] = _shadow_data[i];
703 #ifdef WITH_LUAPROC_STATS
704 int64_t t0 = g_get_monotonic_time ();
708 if (_lua_does_channelmapping) {
709 // run the DSP function
710 (*_lua_dsp)(&bufs, in, out, nframes, offset);
713 BufferSet& silent_bufs = _session.get_silent_buffers (ChanCount (DataType::AUDIO, 1));
714 BufferSet& scratch_bufs = _session.get_scratch_buffers (ChanCount (DataType::AUDIO, 1));
716 lua_State* L = lua.getState ();
717 luabridge::LuaRef in_map (luabridge::newTable (L));
718 luabridge::LuaRef out_map (luabridge::newTable (L));
720 const uint32_t audio_in = _configured_in.n_audio ();
721 const uint32_t audio_out = _configured_out.n_audio ();
722 const uint32_t midi_in = _configured_in.n_midi ();
724 for (uint32_t ap = 0; ap < audio_in; ++ap) {
726 const uint32_t buf_index = in.get(DataType::AUDIO, ap, &valid);
728 in_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
730 in_map[ap + 1] = silent_bufs.get_audio (0).data (offset);
733 for (uint32_t ap = 0; ap < audio_out; ++ap) {
735 const uint32_t buf_index = out.get(DataType::AUDIO, ap, &valid);
737 out_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
739 out_map[ap + 1] = scratch_bufs.get_audio (0).data (offset);
743 luabridge::LuaRef lua_midi_src_tbl (luabridge::newTable (L));
744 int e = 1; // > 1 port, we merge events (unsorted)
745 for (uint32_t mp = 0; mp < midi_in; ++mp) {
747 const uint32_t idx = in.get(DataType::MIDI, mp, &valid);
749 for (MidiBuffer::iterator m = bufs.get_midi(idx).begin();
750 m != bufs.get_midi(idx).end(); ++m, ++e) {
751 const Evoral::MIDIEvent<framepos_t> ev(*m, false);
752 luabridge::LuaRef lua_midi_data (luabridge::newTable (L));
753 const uint8_t* data = ev.buffer();
754 for (uint32_t i = 0; i < ev.size(); ++i) {
755 lua_midi_data [i + 1] = data[i];
757 luabridge::LuaRef lua_midi_event (luabridge::newTable (L));
758 lua_midi_event["time"] = 1 + (*m).time();
759 lua_midi_event["data"] = lua_midi_data;
760 lua_midi_src_tbl[e] = lua_midi_event;
765 if (_has_midi_input) {
766 // XXX TODO This needs a better solution than global namespace
767 luabridge::push (L, lua_midi_src_tbl);
768 lua_setglobal (L, "midiin");
771 luabridge::LuaRef lua_midi_sink_tbl (luabridge::newTable (L));
772 if (_has_midi_output) {
773 luabridge::push (L, lua_midi_sink_tbl);
774 lua_setglobal (L, "midiout");
777 // run the DSP function
778 (*_lua_dsp)(in_map, out_map, nframes);
780 // copy back midi events
781 if (_has_midi_output && lua_midi_sink_tbl.isTable ()) {
783 const uint32_t idx = out.get(DataType::MIDI, 0, &valid);
784 if (valid && bufs.count().n_midi() > idx) {
785 MidiBuffer& mbuf = bufs.get_midi(idx);
787 for (luabridge::Iterator i (lua_midi_sink_tbl); !i.isNil (); ++i) {
788 if (!i.key ().isNumber ()) { continue; }
789 if (!i.value ()["time"].isNumber ()) { continue; }
790 if (!i.value ()["data"].isTable ()) { continue; }
791 luabridge::LuaRef data_tbl (i.value ()["data"]);
792 framepos_t tme = i.value ()["time"];
793 if (tme < 1 || tme > nframes) { continue; }
796 for (luabridge::Iterator di (data_tbl); !di.isNil () && size < sizeof(data); ++di, ++size) {
797 data[size] = di.value ();
799 if (size > 0 && size < 64) {
800 mbuf.push_back(tme - 1, size, data);
807 } catch (luabridge::LuaException const& e) {
808 PBD::error << "LuaException: " << e.what () << "\n";
810 std::cerr << "LuaException: " << e.what () << "\n";
814 #ifdef WITH_LUAPROC_STATS
815 int64_t t1 = g_get_monotonic_time ();
818 lua.collect_garbage_step ();
819 #ifdef WITH_LUAPROC_STATS
821 int64_t t2 = g_get_monotonic_time ();
822 int64_t ela0 = t1 - t0;
823 int64_t ela1 = t2 - t1;
824 if (ela0 > _stats_max[0]) _stats_max[0] = ela0;
825 if (ela1 > _stats_max[1]) _stats_max[1] = ela1;
826 _stats_avg[0] += ela0;
827 _stats_avg[1] += ela1;
834 LuaProc::add_state (XMLNode* root) const
840 gchar* b64 = g_base64_encode ((const guchar*)_script.c_str (), _script.size ());
841 std::string b64s (b64);
843 XMLNode* script_node = new XMLNode (X_("script"));
844 script_node->add_property (X_("lua"), LUA_VERSION);
845 script_node->add_content (b64s);
846 root->add_child_nocopy (*script_node);
848 for (uint32_t i = 0; i < parameter_count(); ++i) {
849 if (parameter_is_input(i) && parameter_is_control(i)) {
850 child = new XMLNode("Port");
851 snprintf(buf, sizeof(buf), "%u", i);
852 child->add_property("id", std::string(buf));
853 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
854 child->add_property("value", std::string(buf));
855 root->add_child_nocopy(*child);
861 LuaProc::set_script_from_state (const XMLNode& node)
864 if (node.name () != state_node_name ()) {
868 if ((child = node.child (X_("script"))) != 0) {
869 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
870 if (!(*n)->is_content ()) { continue; }
872 guchar* buf = g_base64_decode ((*n)->content ().c_str (), &size);
873 _script = std::string ((const char*)buf, size);
875 if (load_script ()) {
876 PBD::error << _("Failed to load Lua script from session state.") << endmsg;
878 std::cerr << "Failed Lua Script: " << _script << std::endl;
885 if (_script.empty ()) {
886 PBD::error << _("Session State for LuaProcessor did not include a Lua script.") << endmsg;
890 PBD::error << _("Invalid/incompatible Lua script found for LuaProcessor.") << endmsg;
897 LuaProc::set_state (const XMLNode& node, int version)
899 #ifndef NO_PLUGIN_STATE
901 XMLProperty const * prop;
902 XMLNodeConstIterator iter;
910 if (_script.empty ()) {
911 if (set_script_from_state (node)) {
916 #ifndef NO_PLUGIN_STATE
917 if (node.name() != state_node_name()) {
918 error << _("Bad node sent to LuaProc::set_state") << endmsg;
922 nodes = node.children ("Port");
923 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
925 if ((prop = child->property("id")) != 0) {
926 port = prop->value().c_str();
928 warning << _("LuaProc: port has no symbol, ignored") << endmsg;
931 if ((prop = child->property("value")) != 0) {
932 value = prop->value().c_str();
934 warning << _("LuaProc: port has no value, ignored") << endmsg;
937 sscanf (port, "%" PRIu32, &port_id);
938 set_parameter (port_id, atof(value));
942 return Plugin::set_state (node, version);
946 LuaProc::parameter_count () const
948 return _ctrl_params.size ();
952 LuaProc::default_value (uint32_t port)
954 if (_ctrl_params[port].first) {
958 int lp = _ctrl_params[port].second;
959 return _param_desc[lp].normal;
963 LuaProc::set_parameter (uint32_t port, float val)
965 assert (port < parameter_count ());
966 if (get_parameter (port) == val) {
969 _shadow_data[port] = val;
970 Plugin::set_parameter (port, val);
974 LuaProc::get_parameter (uint32_t port) const
976 if (parameter_is_input (port)) {
977 return _shadow_data[port];
979 return _control_data[port];
984 LuaProc::get_parameter_descriptor (uint32_t port, ParameterDescriptor& desc) const
986 assert (port <= parameter_count ());
987 int lp = _ctrl_params[port].second;
988 const ParameterDescriptor& d (_param_desc.find(lp)->second);
990 desc.lower = d.lower;
991 desc.upper = d.upper;
992 desc.normal = d.normal;
993 desc.toggled = d.toggled;
994 desc.logarithmic = d.logarithmic;
995 desc.integer_step = d.integer_step;
996 desc.sr_dependent = d.sr_dependent;
997 desc.enumeration = d.enumeration;
999 desc.label = d.label;
1000 desc.scale_points = d.scale_points;
1002 desc.update_steps ();
1007 LuaProc::get_parameter_docs (uint32_t port) const {
1008 assert (port <= parameter_count ());
1009 int lp = _ctrl_params[port].second;
1010 return _param_doc.find(lp)->second;
1014 LuaProc::nth_parameter (uint32_t port, bool& ok) const
1016 if (port < _ctrl_params.size ()) {
1025 LuaProc::parameter_is_input (uint32_t port) const
1027 assert (port < _ctrl_params.size ());
1028 return (!_ctrl_params[port].first);
1032 LuaProc::parameter_is_output (uint32_t port) const
1034 assert (port < _ctrl_params.size ());
1035 return (_ctrl_params[port].first);
1038 std::set<Evoral::Parameter>
1039 LuaProc::automatable () const
1041 std::set<Evoral::Parameter> automatables;
1042 for (uint32_t i = 0; i < _ctrl_params.size (); ++i) {
1043 if (parameter_is_input (i)) {
1044 automatables.insert (automatables.end (), Evoral::Parameter (PluginAutomation, 0, i));
1047 return automatables;
1051 LuaProc::describe_parameter (Evoral::Parameter param)
1053 if (param.type () == PluginAutomation && param.id () < parameter_count ()) {
1054 int lp = _ctrl_params[param.id ()].second;
1055 return _param_desc[lp].label;
1061 LuaProc::print_parameter (uint32_t param, char* buf, uint32_t len) const
1064 if (param < parameter_count ()) {
1065 snprintf (buf, len, "%.3f", get_parameter (param));
1072 boost::shared_ptr<ScalePoints>
1073 LuaProc::parse_scale_points (luabridge::LuaRef* lr)
1075 if (!(*lr)["scalepoints"].isTable()) {
1076 return boost::shared_ptr<ScalePoints> ();
1080 boost::shared_ptr<ScalePoints> rv = boost::shared_ptr<ScalePoints>(new ScalePoints());
1081 luabridge::LuaRef scalepoints ((*lr)["scalepoints"]);
1083 for (luabridge::Iterator i (scalepoints); !i.isNil (); ++i) {
1084 if (!i.key ().isString ()) { continue; }
1085 if (!i.value ().isNumber ()) { continue; }
1086 rv->insert(make_pair(i.key ().cast<std::string> (),
1087 i.value ().cast<float> ()));
1091 if (rv->size() > 0) {
1094 return boost::shared_ptr<ScalePoints> ();
1097 boost::shared_ptr<ScalePoints>
1098 LuaProc::get_scale_points (uint32_t port) const
1100 int lp = _ctrl_params[port].second;
1101 return _param_desc.find(lp)->second.scale_points;
1105 LuaProc::setup_lua_inline_gui (LuaState *lua_gui)
1107 lua_State* LG = lua_gui->getState ();
1108 LuaBindings::stddef (LG);
1109 LuaBindings::common (LG);
1110 LuaBindings::dsp (LG);
1112 lua_gui->Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
1113 lua_gui->do_command ("function ardour () end");
1114 lua_gui->do_command (_script);
1116 // TODO think: use a weak-pointer here ?
1117 // (the GUI itself uses a shared ptr to this plugin, so we should be good)
1118 luabridge::getGlobalNamespace (LG)
1119 .beginNamespace ("Ardour")
1120 .beginClass <LuaProc> ("LuaProc")
1121 .addFunction ("shmem", &LuaProc::instance_shm)
1122 .addFunction ("table", &LuaProc::instance_ref)
1126 luabridge::push <LuaProc *> (LG, this);
1127 lua_setglobal (LG, "self");
1129 luabridge::push <float *> (LG, _shadow_data);
1130 lua_setglobal (LG, "CtrlPorts");
1132 ////////////////////////////////////////////////////////////////////////////////
1134 #include "ardour/search_paths.h"
1138 LuaProc::preset_name_to_uri (const std::string& name) const
1140 std::string uri ("urn:lua:");
1144 sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
1145 sha1_write (&s, (const uint8_t *) _script.c_str(), _script.size ());
1146 sha1_result_hash (&s, hash);
1151 LuaProc::presets_file () const
1153 return string_compose ("lua-%1", _info->unique_id);
1157 LuaProc::presets_tree () const
1159 XMLTree* t = new XMLTree;
1160 std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1162 if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
1163 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
1164 error << _("Unable to create LuaProc presets directory") << endmsg;
1168 p = Glib::build_filename (p, presets_file ());
1170 if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
1171 t->set_root (new XMLNode (X_("LuaPresets")));
1175 t->set_filename (p);
1184 LuaProc::load_preset (PresetRecord r)
1186 boost::shared_ptr<XMLTree> t (presets_tree ());
1191 XMLNode* root = t->root ();
1192 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1193 XMLProperty const * label = (*i)->property (X_("label"));
1195 if (label->value() != r.label) {
1199 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
1200 if ((*j)->name() == X_("Parameter")) {
1201 XMLProperty const * index = (*j)->property (X_("index"));
1202 XMLProperty const * value = (*j)->property (X_("value"));
1205 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
1214 LuaProc::do_save_preset (std::string name) {
1216 boost::shared_ptr<XMLTree> t (presets_tree ());
1221 std::string uri (preset_name_to_uri (name));
1223 XMLNode* p = new XMLNode (X_("Preset"));
1224 p->add_property (X_("uri"), uri);
1225 p->add_property (X_("label"), name);
1227 for (uint32_t i = 0; i < parameter_count(); ++i) {
1228 if (parameter_is_input (i)) {
1229 XMLNode* c = new XMLNode (X_("Parameter"));
1230 c->add_property (X_("index"), string_compose ("%1", i));
1231 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
1232 p->add_child_nocopy (*c);
1235 t->root()->add_child_nocopy (*p);
1237 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1238 f = Glib::build_filename (f, presets_file ());
1245 LuaProc::do_remove_preset (std::string name)
1247 boost::shared_ptr<XMLTree> t (presets_tree ());
1251 t->root()->remove_nodes_and_delete (X_("label"), name);
1252 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1253 f = Glib::build_filename (f, presets_file ());
1258 LuaProc::find_presets ()
1260 boost::shared_ptr<XMLTree> t (presets_tree ());
1262 XMLNode* root = t->root ();
1263 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1265 XMLProperty const * uri = (*i)->property (X_("uri"));
1266 XMLProperty const * label = (*i)->property (X_("label"));
1271 PresetRecord r (uri->value(), label->value(), true);
1272 _presets.insert (make_pair (r.uri, r));
1277 ////////////////////////////////////////////////////////////////////////////////
1279 LuaPluginInfo::LuaPluginInfo (LuaScriptInfoPtr lsi) {
1280 if (lsi->type != LuaScriptInfo::DSP) {
1281 throw failed_constructor ();
1286 creator = lsi->author;
1287 category = lsi->category;
1288 unique_id = lsi->unique_id;
1290 n_inputs.set (DataType::AUDIO, 1);
1291 n_outputs.set (DataType::AUDIO, 1);
1294 _is_instrument = category == "Instrument";
1298 LuaPluginInfo::load (Session& session)
1300 std::string script = "";
1301 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
1302 return PluginPtr ();
1306 script = Glib::file_get_contents (path);
1307 } catch (Glib::FileError err) {
1308 return PluginPtr ();
1311 if (script.empty ()) {
1312 return PluginPtr ();
1316 PluginPtr plugin (new LuaProc (session.engine (), session, script));
1318 } catch (failed_constructor& err) {
1321 return PluginPtr ();
1324 std::vector<Plugin::PresetRecord>
1325 LuaPluginInfo::get_presets (bool /*user_only*/) const
1327 std::vector<Plugin::PresetRecord> p;
1328 XMLTree* t = new XMLTree;
1329 std::string pf = Glib::build_filename (ARDOUR::user_config_directory (), "presets", string_compose ("lua-%1", unique_id));
1330 if (Glib::file_test (pf, Glib::FILE_TEST_EXISTS)) {
1331 t->set_filename (pf);
1333 XMLNode* root = t->root ();
1334 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1335 XMLProperty const * uri = (*i)->property (X_("uri"));
1336 XMLProperty const * label = (*i)->property (X_("label"));
1337 p.push_back (Plugin::PresetRecord (uri->value(), label->value(), true));