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", 3145728)
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)
65 , _has_midi_input (false)
66 , _has_midi_output (false)
70 /* when loading a session, or pasing a processor,
71 * the script is set during set_state();
73 if (!_script.empty () && load_script ()) {
74 throw failed_constructor ();
78 LuaProc::LuaProc (const LuaProc &other)
80 , _mempool ("LuaProc", 3145728)
82 , lua (lua_newstate (&PBD::TLSF::lalloc, &_mempool))
83 #elif defined USE_MALLOC
86 , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
89 , _script (other.script ())
90 , _lua_does_channelmapping (false)
91 , _lua_has_inline_display (false)
92 , _designated_bypass_port (UINT32_MAX)
96 , _has_midi_input (false)
97 , _has_midi_output (false)
101 if (load_script ()) {
102 throw failed_constructor ();
105 for (uint32_t i = 0; i < parameter_count (); ++i) {
106 _control_data[i] = other._shadow_data[i];
107 _shadow_data[i] = other._shadow_data[i];
111 LuaProc::~LuaProc () {
112 #ifdef WITH_LUAPROC_STATS
113 if (_info && _stats_cnt > 0) {
114 printf ("LuaProc: '%s' run() avg: %.3f max: %.3f [ms]\n",
115 _info->name.c_str (),
116 0.0001f * _stats_avg[0] / (float) _stats_cnt,
117 0.0001f * _stats_max[0]);
118 printf ("LuaProc: '%s' gc() avg: %.3f max: %.3f [ms]\n",
119 _info->name.c_str (),
120 0.0001f * _stats_avg[1] / (float) _stats_cnt,
121 0.0001f * _stats_max[1]);
124 lua.do_command ("collectgarbage();");
126 delete [] _control_data;
127 delete [] _shadow_data;
133 #ifdef WITH_LUAPROC_STATS
134 _stats_avg[0] = _stats_avg[1] = _stats_max[0] = _stats_max[1] = _stats_cnt = 0;
138 lua.Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
139 // register session object
140 lua_State* L = lua.getState ();
141 LuaBindings::stddef (L);
142 LuaBindings::common (L);
143 LuaBindings::dsp (L);
145 luabridge::getGlobalNamespace (L)
146 .beginNamespace ("Ardour")
147 .beginClass <LuaProc> ("LuaProc")
148 .addFunction ("queue_draw", &LuaProc::queue_draw)
149 .addFunction ("shmem", &LuaProc::instance_shm)
150 .addFunction ("table", &LuaProc::instance_ref)
154 // add session to global lua namespace
155 luabridge::push <Session *> (L, &_session);
156 lua_setglobal (L, "Session");
159 luabridge::push <LuaProc *> (L, this);
160 lua_setglobal (L, "self");
163 lua.do_command ("io = nil os = nil loadfile = nil require = nil dofile = nil package = nil debug = nil");
165 lua.do_command ("for n in pairs(_G) do print(n) end print ('----')"); // print global env
167 lua.do_command ("function ardour () end");
171 LuaProc::lua_print (std::string s) {
172 std::cout <<"LuaProc: " << s << "\n";
173 PBD::error << "LuaProc: " << s << "\n";
177 LuaProc::load_script ()
179 assert (!_lua_dsp); // don't allow to re-initialize
180 LuaPluginInfoPtr lpi;
182 // TODO: refine APIs; function arguments..
183 // - perform channel-map in ardour (silent/scratch buffers) ?
184 // - control-port API (explicit get/set functions ??)
185 // - latency reporting (global var? ctrl-port? set-function ?)
186 // - MIDI -> sparse table of events
187 // { [sample] => { Event }, .. }
188 // or { { sample, Event }, .. }
191 LuaScriptInfoPtr lsi = LuaScripting::script_info (_script);
192 lpi = LuaPluginInfoPtr (new LuaPluginInfo (lsi));
195 _mempool.set_name ("LuaProc: " + lsi->name);
196 _docs = lsi->description;
197 } catch (failed_constructor& err) {
201 lua_State* L = lua.getState ();
202 lua.do_command (_script);
204 // check if script has a DSP callback
205 luabridge::LuaRef lua_dsp_run = luabridge::getGlobal (L, "dsp_run");
206 luabridge::LuaRef lua_dsp_map = luabridge::getGlobal (L, "dsp_runmap");
208 if ((lua_dsp_run.type () != LUA_TFUNCTION) == (lua_dsp_map.type () != LUA_TFUNCTION)) {
212 if (lua_dsp_run.type () == LUA_TFUNCTION) {
213 _lua_dsp = new luabridge::LuaRef (lua_dsp_run);
215 else if (lua_dsp_map.type () == LUA_TFUNCTION) {
216 _lua_dsp = new luabridge::LuaRef (lua_dsp_map);
217 _lua_does_channelmapping = true;
223 // initialize the DSP if needed
224 luabridge::LuaRef lua_dsp_init = luabridge::getGlobal (L, "dsp_init");
225 if (lua_dsp_init.type () == LUA_TFUNCTION) {
227 lua_dsp_init (_session.nominal_frame_rate ());
228 } catch (luabridge::LuaException const& e) {
233 _ctrl_params.clear ();
235 luabridge::LuaRef lua_render = luabridge::getGlobal (L, "render_inline");
236 if (lua_render.isFunction ()) {
237 _lua_has_inline_display = true;
240 luabridge::LuaRef lua_params = luabridge::getGlobal (L, "dsp_params");
241 if (lua_params.isFunction ()) {
243 // call function // add try {} catch (luabridge::LuaException const& e)
244 luabridge::LuaRef params = lua_params ();
246 if (params.isTable ()) {
248 for (luabridge::Iterator i (params); !i.isNil (); ++i) {
250 if (!i.key ().isNumber ()) { return false; }
251 if (!i.value ().isTable ()) { return false; }
252 if (!i.value ()["type"].isString ()) { return false; }
253 if (!i.value ()["name"].isString ()) { return false; }
254 if (!i.value ()["min"].isNumber ()) { return false; }
255 if (!i.value ()["max"].isNumber ()) { return false; }
257 int pn = i.key ().cast<int> ();
258 std::string type = i.value ()["type"].cast<std::string> ();
259 if (type == "input") {
260 if (!i.value ()["default"].isNumber ()) { return false; }
261 _ctrl_params.push_back (std::make_pair (false, pn));
263 else if (type == "output") {
264 _ctrl_params.push_back (std::make_pair (true, pn));
268 assert (pn == (int) _ctrl_params.size ());
270 //_param_desc[pn] = boost::shared_ptr<ParameterDescriptor> (new ParameterDescriptor());
271 luabridge::LuaRef lr = i.value ();
273 if (type == "input") {
274 _param_desc[pn].normal = lr["default"].cast<float> ();
276 _param_desc[pn].normal = lr["min"].cast<float> (); // output-port, no default
278 _param_desc[pn].lower = lr["min"].cast<float> ();
279 _param_desc[pn].upper = lr["max"].cast<float> ();
280 _param_desc[pn].toggled = lr["toggled"].isBoolean () && (lr["toggled"]).cast<bool> ();
281 _param_desc[pn].logarithmic = lr["logarithmic"].isBoolean () && (lr["logarithmic"]).cast<bool> ();
282 _param_desc[pn].integer_step = lr["integer"].isBoolean () && (lr["integer"]).cast<bool> ();
283 _param_desc[pn].sr_dependent = lr["ratemult"].isBoolean () && (lr["ratemult"]).cast<bool> ();
284 _param_desc[pn].enumeration = lr["enum"].isBoolean () && (lr["enum"]).cast<bool> ();
286 if (lr["bypass"].isBoolean () && (lr["bypass"]).cast<bool> ()) {
287 _designated_bypass_port = pn - 1; // lua table starts at 1.
290 if (lr["unit"].isString ()) {
291 std::string unit = lr["unit"].cast<std::string> ();
292 if (unit == "dB") { _param_desc[pn].unit = ParameterDescriptor::DB; }
293 else if (unit == "Hz") { _param_desc[pn].unit = ParameterDescriptor::HZ; }
294 else if (unit == "Midi Note") { _param_desc[pn].unit = ParameterDescriptor::MIDI_NOTE; }
296 _param_desc[pn].label = (lr["name"]).cast<std::string> ();
297 _param_desc[pn].scale_points = parse_scale_points (&lr);
299 luabridge::LuaRef doc = lr["doc"];
300 if (doc.isString ()) {
301 _param_doc[pn] = doc.cast<std::string> ();
305 assert (!(_param_desc[pn].toggled && _param_desc[pn].logarithmic));
310 _control_data = new float[parameter_count ()];
311 _shadow_data = new float[parameter_count ()];
313 for (uint32_t i = 0; i < parameter_count (); ++i) {
314 if (parameter_is_input (i)) {
315 _control_data[i] = _shadow_data[i] = default_value (i);
319 // expose ctrl-ports to global lua namespace
320 luabridge::push <float *> (L, _control_data);
321 lua_setglobal (L, "CtrlPorts");
323 return false; // no error
327 LuaProc::can_support_io_configuration (const ChanCount& in, ChanCount& out, ChanCount* imprecise)
329 // caller must hold process lock (no concurrent calls to interpreter
330 _output_configs.clear ();
332 lua_State* L = lua.getState ();
333 luabridge::LuaRef ioconfig = luabridge::getGlobal (L, "dsp_ioconfig");
335 luabridge::LuaRef *_iotable = NULL; // can't use reference :(
337 if (ioconfig.isFunction ()) {
339 luabridge::LuaRef iotable = ioconfig ();
340 if (iotable.isTable ()) {
341 _iotable = new luabridge::LuaRef (iotable);
343 } catch (luabridge::LuaException const& e) {
349 /* empty table as default */
350 luabridge::LuaRef iotable = luabridge::newTable(L);
351 _iotable = new luabridge::LuaRef (iotable);
354 // now we can reference it.
355 luabridge::LuaRef iotable (*_iotable);
358 if ((iotable).length () < 1) {
359 /* empty table as only config, to get default values */
360 luabridge::LuaRef ioconf = luabridge::newTable(L);
364 const int audio_in = in.n_audio ();
365 const int midi_in = in.n_midi ();
367 // preferred setting (provided by plugin_insert)
368 const int preferred_out = out.n_audio ();
369 const int preferred_midiout = out.n_midi ();
373 float penalty = 9999;
376 #define FOUNDCFG_PENALTY(in, out, p) { \
377 _output_configs.insert (out); \
380 midi_out = possible_midiout; \
382 imprecise->set (DataType::AUDIO, (in)); \
383 imprecise->set (DataType::MIDI, possible_midiin); \
385 _has_midi_input = (possible_midiin > 0); \
386 _has_midi_output = (possible_midiout > 0); \
392 #define FOUNDCFG_IMPRECISE(in, out) { \
393 const float p = fabsf ((float)(out) - preferred_out) * \
394 (((out) > preferred_out) ? 1.1 : 1) \
395 + fabsf ((float)possible_midiout - preferred_midiout) * \
396 ((possible_midiout - preferred_midiout) ? 0.6 : 0.5) \
397 + fabsf ((float)(in) - audio_in) * \
398 (((in) > audio_in) ? 275 : 250) \
399 + fabsf ((float)possible_midiin - midi_in) * \
400 ((possible_midiin - midi_in) ? 100 : 110); \
401 FOUNDCFG_PENALTY(in, out, p); \
404 #define FOUNDCFG(out) \
405 FOUNDCFG_IMPRECISE(audio_in, out)
407 #define ANYTHINGGOES \
408 _output_configs.insert (0);
410 #define UPTO(nch) { \
411 for (int n = 1; n < nch; ++n) { \
412 _output_configs.insert (n); \
420 for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
421 luabridge::LuaRef io (i.value ());
426 int possible_in = io["audio_in"].isNumber() ? io["audio_in"] : -1;
427 int possible_out = io["audio_out"].isNumber() ? io["audio_out"] : -1;
428 int possible_midiin = io["midi_in"].isNumber() ? io["midi_in"] : 0;
429 int possible_midiout = io["midi_out"].isNumber() ? io["midi_out"] : 0;
431 if (midi_in != possible_midiin && !imprecise) {
436 if ((possible_in == audio_in) && (possible_out == preferred_out)) {
437 /* Set penalty so low that this output configuration
438 * will trump any other one */
439 FOUNDCFG_PENALTY(audio_in, preferred_out, -1);
442 if (possible_out == 0 && possible_midiout == 0) {
443 /* skip configurations with no output at all */
447 if (possible_in == -1 || possible_in == -2) {
448 /* wildcard for input */
449 if (possible_out == possible_in) {
450 /* either both -1 or both -2 (invalid and
451 * interpreted as both -1): out must match in */
453 } else if (possible_out == -3 - possible_in) {
454 /* one is -1, the other is -2: any output configuration
455 * possible, pick what the insert prefers */
456 FOUNDCFG (preferred_out);
458 } else if (possible_out < -2) {
459 /* variable number of outputs up to -N,
460 * invalid if in == -2 but we accept it anyway */
461 FOUNDCFG (min (-possible_out, preferred_out));
464 /* exact number of outputs */
465 FOUNDCFG (possible_out);
469 if (possible_in < -2 || possible_in >= 0) {
470 /* specified number, exact or up to */
472 if (possible_in >= 0) {
473 /* configuration can only match possible_in */
474 desired_in = possible_in;
476 /* configuration can match up to -possible_in */
477 desired_in = min (-possible_in, audio_in);
479 if (!imprecise && audio_in != desired_in) {
480 /* skip that configuration, it cannot match
481 * the required audio input count, and we
482 * cannot ask for change via \imprecise */
483 } else if (possible_out == -1 || possible_out == -2) {
484 /* any output configuration possible
485 * out == -2 is invalid, interpreted as out == -1.
486 * Really imprecise only if desired_in != audio_in */
487 FOUNDCFG_IMPRECISE (desired_in, preferred_out);
489 } else if (possible_out < -2) {
490 /* variable number of outputs up to -N
491 * not specified if in > 0, but we accept it anyway.
492 * Really imprecise only if desired_in != audio_in */
493 FOUNDCFG_IMPRECISE (desired_in, min (-possible_out, preferred_out));
496 /* exact number of outputs
497 * Really imprecise only if desired_in != audio_in */
498 FOUNDCFG_IMPRECISE (desired_in, possible_out);
509 _selected_in = *imprecise;
514 out.set (DataType::MIDI, midi_out);
515 out.set (DataType::AUDIO, audio_out);
522 LuaProc::configure_io (ChanCount in, ChanCount out)
524 in.set (DataType::MIDI, _has_midi_input ? 1 : 0);
525 out.set (DataType::MIDI, _has_midi_output ? 1 : 0);
527 _info->n_inputs = _selected_in;
528 _info->n_outputs = _selected_out;
530 // configure the DSP if needed
531 if (in != _configured_in || out != _configured_out || !_configured) {
532 lua_State* L = lua.getState ();
533 luabridge::LuaRef lua_dsp_configure = luabridge::getGlobal (L, "dsp_configure");
534 if (lua_dsp_configure.type () == LUA_TFUNCTION) {
536 luabridge::LuaRef io = lua_dsp_configure (&in, &out);
538 ChanCount lin (_selected_in);
539 ChanCount lout (_selected_out);
541 if (io["audio_in"].type() == LUA_TNUMBER) {
542 const int c = io["audio_in"].cast<int> ();
544 lin.set (DataType::AUDIO, c);
547 if (io["audio_out"].type() == LUA_TNUMBER) {
548 const int c = io["audio_out"].cast<int> ();
550 lout.set (DataType::AUDIO, c);
553 if (io["midi_in"].type() == LUA_TNUMBER) {
554 const int c = io["midi_in"].cast<int> ();
556 lin.set (DataType::MIDI, c);
559 if (io["midi_out"].type() == LUA_TNUMBER) {
560 const int c = io["midi_out"].cast<int> ();
562 lout.set (DataType::MIDI, c);
565 _info->n_inputs = lin;
566 _info->n_outputs = lout;
569 } catch (luabridge::LuaException const& e) {
570 PBD::error << "LuaException: " << e.what () << "\n";
572 std::cerr << "LuaException: " << e.what () << "\n";
580 _configured_out = out;
586 LuaProc::connect_and_run (BufferSet& bufs,
587 framepos_t start, framepos_t end, double speed,
588 ChanMapping in, ChanMapping out,
589 pframes_t nframes, framecnt_t offset)
595 Plugin::connect_and_run (bufs, start, end, speed, in, out, nframes, offset);
597 // This is needed for ARDOUR::Session requests :(
598 if (! SessionEvent::has_per_thread_pool ()) {
600 snprintf (name, 64, "Proc-%p", this);
601 pthread_set_name (name);
602 SessionEvent::create_per_thread_pool (name, 64);
603 PBD::notify_event_loops_about_thread_creation (pthread_self(), name, 64);
606 uint32_t const n = parameter_count ();
607 for (uint32_t i = 0; i < n; ++i) {
608 if (parameter_is_control (i) && parameter_is_input (i)) {
609 _control_data[i] = _shadow_data[i];
613 #ifdef WITH_LUAPROC_STATS
614 int64_t t0 = g_get_monotonic_time ();
618 if (_lua_does_channelmapping) {
619 // run the DSP function
620 (*_lua_dsp)(&bufs, in, out, nframes, offset);
623 BufferSet& silent_bufs = _session.get_silent_buffers (ChanCount (DataType::AUDIO, 1));
624 BufferSet& scratch_bufs = _session.get_scratch_buffers (ChanCount (DataType::AUDIO, 1));
626 lua_State* L = lua.getState ();
627 luabridge::LuaRef in_map (luabridge::newTable (L));
628 luabridge::LuaRef out_map (luabridge::newTable (L));
630 const uint32_t audio_in = _configured_in.n_audio ();
631 const uint32_t audio_out = _configured_out.n_audio ();
632 const uint32_t midi_in = _configured_in.n_midi ();
634 for (uint32_t ap = 0; ap < audio_in; ++ap) {
636 const uint32_t buf_index = in.get(DataType::AUDIO, ap, &valid);
638 in_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
640 in_map[ap + 1] = silent_bufs.get_audio (0).data (offset);
643 for (uint32_t ap = 0; ap < audio_out; ++ap) {
645 const uint32_t buf_index = out.get(DataType::AUDIO, ap, &valid);
647 out_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
649 out_map[ap + 1] = scratch_bufs.get_audio (0).data (offset);
653 luabridge::LuaRef lua_midi_src_tbl (luabridge::newTable (L));
654 int e = 1; // > 1 port, we merge events (unsorted)
655 for (uint32_t mp = 0; mp < midi_in; ++mp) {
657 const uint32_t idx = in.get(DataType::MIDI, mp, &valid);
659 for (MidiBuffer::iterator m = bufs.get_midi(idx).begin();
660 m != bufs.get_midi(idx).end(); ++m, ++e) {
661 const Evoral::MIDIEvent<framepos_t> ev(*m, false);
662 luabridge::LuaRef lua_midi_data (luabridge::newTable (L));
663 const uint8_t* data = ev.buffer();
664 for (uint32_t i = 0; i < ev.size(); ++i) {
665 lua_midi_data [i + 1] = data[i];
667 luabridge::LuaRef lua_midi_event (luabridge::newTable (L));
668 lua_midi_event["time"] = 1 + (*m).time();
669 lua_midi_event["data"] = lua_midi_data;
670 lua_midi_event["bytes"] = data;
671 lua_midi_event["size"] = ev.size();
672 lua_midi_src_tbl[e] = lua_midi_event;
677 if (_has_midi_input) {
678 // XXX TODO This needs a better solution than global namespace
679 luabridge::push (L, lua_midi_src_tbl);
680 lua_setglobal (L, "midiin");
683 luabridge::LuaRef lua_midi_sink_tbl (luabridge::newTable (L));
684 if (_has_midi_output) {
685 luabridge::push (L, lua_midi_sink_tbl);
686 lua_setglobal (L, "midiout");
689 // run the DSP function
690 (*_lua_dsp)(in_map, out_map, nframes);
692 // copy back midi events
693 if (_has_midi_output && lua_midi_sink_tbl.isTable ()) {
695 const uint32_t idx = out.get(DataType::MIDI, 0, &valid);
696 if (valid && bufs.count().n_midi() > idx) {
697 MidiBuffer& mbuf = bufs.get_midi(idx);
699 for (luabridge::Iterator i (lua_midi_sink_tbl); !i.isNil (); ++i) {
700 if (!i.key ().isNumber ()) { continue; }
701 if (!i.value ()["time"].isNumber ()) { continue; }
702 if (!i.value ()["data"].isTable ()) { continue; }
703 luabridge::LuaRef data_tbl (i.value ()["data"]);
704 framepos_t tme = i.value ()["time"];
705 if (tme < 1 || tme > nframes) { continue; }
708 for (luabridge::Iterator di (data_tbl); !di.isNil () && size < sizeof(data); ++di, ++size) {
709 data[size] = di.value ();
711 if (size > 0 && size < 64) {
712 mbuf.push_back(tme - 1, size, data);
719 } catch (luabridge::LuaException const& e) {
720 PBD::error << "LuaException: " << e.what () << "\n";
722 std::cerr << "LuaException: " << e.what () << "\n";
726 #ifdef WITH_LUAPROC_STATS
727 int64_t t1 = g_get_monotonic_time ();
730 lua.collect_garbage_step ();
731 #ifdef WITH_LUAPROC_STATS
733 int64_t t2 = g_get_monotonic_time ();
734 int64_t ela0 = t1 - t0;
735 int64_t ela1 = t2 - t1;
736 if (ela0 > _stats_max[0]) _stats_max[0] = ela0;
737 if (ela1 > _stats_max[1]) _stats_max[1] = ela1;
738 _stats_avg[0] += ela0;
739 _stats_avg[1] += ela1;
746 LuaProc::add_state (XMLNode* root) const
752 gchar* b64 = g_base64_encode ((const guchar*)_script.c_str (), _script.size ());
753 std::string b64s (b64);
755 XMLNode* script_node = new XMLNode (X_("script"));
756 script_node->add_property (X_("lua"), LUA_VERSION);
757 script_node->add_content (b64s);
758 root->add_child_nocopy (*script_node);
760 for (uint32_t i = 0; i < parameter_count(); ++i) {
761 if (parameter_is_input(i) && parameter_is_control(i)) {
762 child = new XMLNode("Port");
763 snprintf(buf, sizeof(buf), "%u", i);
764 child->add_property("id", std::string(buf));
765 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
766 child->add_property("value", std::string(buf));
767 root->add_child_nocopy(*child);
773 LuaProc::set_script_from_state (const XMLNode& node)
776 if (node.name () != state_node_name ()) {
780 if ((child = node.child (X_("script"))) != 0) {
781 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
782 if (!(*n)->is_content ()) { continue; }
784 guchar* buf = g_base64_decode ((*n)->content ().c_str (), &size);
785 _script = std::string ((const char*)buf, size);
787 if (load_script ()) {
788 PBD::error << _("Failed to load Lua script from session state.") << endmsg;
790 std::cerr << "Failed Lua Script: " << _script << std::endl;
797 if (_script.empty ()) {
798 PBD::error << _("Session State for LuaProcessor did not include a Lua script.") << endmsg;
802 PBD::error << _("Invalid/incompatible Lua script found for LuaProcessor.") << endmsg;
809 LuaProc::set_state (const XMLNode& node, int version)
811 #ifndef NO_PLUGIN_STATE
813 XMLProperty const * prop;
814 XMLNodeConstIterator iter;
822 if (_script.empty ()) {
823 if (set_script_from_state (node)) {
828 #ifndef NO_PLUGIN_STATE
829 if (node.name() != state_node_name()) {
830 error << _("Bad node sent to LuaProc::set_state") << endmsg;
834 nodes = node.children ("Port");
835 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
837 if ((prop = child->property("id")) != 0) {
838 port = prop->value().c_str();
840 warning << _("LuaProc: port has no symbol, ignored") << endmsg;
843 if ((prop = child->property("value")) != 0) {
844 value = prop->value().c_str();
846 warning << _("LuaProc: port has no value, ignored") << endmsg;
849 sscanf (port, "%" PRIu32, &port_id);
850 set_parameter (port_id, atof(value));
854 return Plugin::set_state (node, version);
858 LuaProc::parameter_count () const
860 return _ctrl_params.size ();
864 LuaProc::default_value (uint32_t port)
866 if (_ctrl_params[port].first) {
870 int lp = _ctrl_params[port].second;
871 return _param_desc[lp].normal;
875 LuaProc::set_parameter (uint32_t port, float val)
877 assert (port < parameter_count ());
878 if (get_parameter (port) == val) {
881 _shadow_data[port] = val;
882 Plugin::set_parameter (port, val);
886 LuaProc::get_parameter (uint32_t port) const
888 if (parameter_is_input (port)) {
889 return _shadow_data[port];
891 return _control_data[port];
896 LuaProc::get_parameter_descriptor (uint32_t port, ParameterDescriptor& desc) const
898 assert (port <= parameter_count ());
899 int lp = _ctrl_params[port].second;
900 const ParameterDescriptor& d (_param_desc.find(lp)->second);
902 desc.lower = d.lower;
903 desc.upper = d.upper;
904 desc.normal = d.normal;
905 desc.toggled = d.toggled;
906 desc.logarithmic = d.logarithmic;
907 desc.integer_step = d.integer_step;
908 desc.sr_dependent = d.sr_dependent;
909 desc.enumeration = d.enumeration;
911 desc.label = d.label;
912 desc.scale_points = d.scale_points;
914 desc.update_steps ();
919 LuaProc::get_parameter_docs (uint32_t port) const {
920 assert (port <= parameter_count ());
921 int lp = _ctrl_params[port].second;
922 return _param_doc.find(lp)->second;
926 LuaProc::nth_parameter (uint32_t port, bool& ok) const
928 if (port < _ctrl_params.size ()) {
937 LuaProc::parameter_is_input (uint32_t port) const
939 assert (port < _ctrl_params.size ());
940 return (!_ctrl_params[port].first);
944 LuaProc::parameter_is_output (uint32_t port) const
946 assert (port < _ctrl_params.size ());
947 return (_ctrl_params[port].first);
950 std::set<Evoral::Parameter>
951 LuaProc::automatable () const
953 std::set<Evoral::Parameter> automatables;
954 for (uint32_t i = 0; i < _ctrl_params.size (); ++i) {
955 if (parameter_is_input (i)) {
956 automatables.insert (automatables.end (), Evoral::Parameter (PluginAutomation, 0, i));
963 LuaProc::describe_parameter (Evoral::Parameter param)
965 if (param.type () == PluginAutomation && param.id () < parameter_count ()) {
966 int lp = _ctrl_params[param.id ()].second;
967 return _param_desc[lp].label;
973 LuaProc::print_parameter (uint32_t param, char* buf, uint32_t len) const
976 if (param < parameter_count ()) {
977 snprintf (buf, len, "%.3f", get_parameter (param));
984 boost::shared_ptr<ScalePoints>
985 LuaProc::parse_scale_points (luabridge::LuaRef* lr)
987 if (!(*lr)["scalepoints"].isTable()) {
988 return boost::shared_ptr<ScalePoints> ();
992 boost::shared_ptr<ScalePoints> rv = boost::shared_ptr<ScalePoints>(new ScalePoints());
993 luabridge::LuaRef scalepoints ((*lr)["scalepoints"]);
995 for (luabridge::Iterator i (scalepoints); !i.isNil (); ++i) {
996 if (!i.key ().isString ()) { continue; }
997 if (!i.value ().isNumber ()) { continue; }
998 rv->insert(make_pair(i.key ().cast<std::string> (),
999 i.value ().cast<float> ()));
1003 if (rv->size() > 0) {
1006 return boost::shared_ptr<ScalePoints> ();
1009 boost::shared_ptr<ScalePoints>
1010 LuaProc::get_scale_points (uint32_t port) const
1012 int lp = _ctrl_params[port].second;
1013 return _param_desc.find(lp)->second.scale_points;
1017 LuaProc::setup_lua_inline_gui (LuaState *lua_gui)
1019 lua_State* LG = lua_gui->getState ();
1020 LuaBindings::stddef (LG);
1021 LuaBindings::common (LG);
1022 LuaBindings::dsp (LG);
1023 LuaBindings::osc (LG);
1025 lua_gui->Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
1026 lua_gui->do_command ("function ardour () end");
1027 lua_gui->do_command (_script);
1029 // TODO think: use a weak-pointer here ?
1030 // (the GUI itself uses a shared ptr to this plugin, so we should be good)
1031 luabridge::getGlobalNamespace (LG)
1032 .beginNamespace ("Ardour")
1033 .beginClass <LuaProc> ("LuaProc")
1034 .addFunction ("shmem", &LuaProc::instance_shm)
1035 .addFunction ("table", &LuaProc::instance_ref)
1039 luabridge::push <LuaProc *> (LG, this);
1040 lua_setglobal (LG, "self");
1042 luabridge::push <float *> (LG, _control_data);
1043 lua_setglobal (LG, "CtrlPorts");
1045 ////////////////////////////////////////////////////////////////////////////////
1047 #include "ardour/search_paths.h"
1051 LuaProc::preset_name_to_uri (const std::string& name) const
1053 std::string uri ("urn:lua:");
1057 sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
1058 sha1_write (&s, (const uint8_t *) _script.c_str(), _script.size ());
1059 sha1_result_hash (&s, hash);
1064 LuaProc::presets_file () const
1066 return string_compose ("lua-%1", _info->unique_id);
1070 LuaProc::presets_tree () const
1072 XMLTree* t = new XMLTree;
1073 std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1075 if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
1076 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
1077 error << _("Unable to create LuaProc presets directory") << endmsg;
1081 p = Glib::build_filename (p, presets_file ());
1083 if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
1084 t->set_root (new XMLNode (X_("LuaPresets")));
1088 t->set_filename (p);
1097 LuaProc::load_preset (PresetRecord r)
1099 boost::shared_ptr<XMLTree> t (presets_tree ());
1104 XMLNode* root = t->root ();
1105 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1106 XMLProperty const * label = (*i)->property (X_("label"));
1108 if (label->value() != r.label) {
1112 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
1113 if ((*j)->name() == X_("Parameter")) {
1114 XMLProperty const * index = (*j)->property (X_("index"));
1115 XMLProperty const * value = (*j)->property (X_("value"));
1119 set_parameter (atoi (index->value().c_str()), atof (value->value().c_str ()));
1122 return Plugin::load_preset(r);
1128 LuaProc::do_save_preset (std::string name) {
1130 boost::shared_ptr<XMLTree> t (presets_tree ());
1135 std::string uri (preset_name_to_uri (name));
1137 XMLNode* p = new XMLNode (X_("Preset"));
1138 p->add_property (X_("uri"), uri);
1139 p->add_property (X_("label"), name);
1141 for (uint32_t i = 0; i < parameter_count(); ++i) {
1142 if (parameter_is_input (i)) {
1143 XMLNode* c = new XMLNode (X_("Parameter"));
1144 c->add_property (X_("index"), string_compose ("%1", i));
1145 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
1146 p->add_child_nocopy (*c);
1149 t->root()->add_child_nocopy (*p);
1151 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1152 f = Glib::build_filename (f, presets_file ());
1159 LuaProc::do_remove_preset (std::string name)
1161 boost::shared_ptr<XMLTree> t (presets_tree ());
1165 t->root()->remove_nodes_and_delete (X_("label"), name);
1166 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1167 f = Glib::build_filename (f, presets_file ());
1172 LuaProc::find_presets ()
1174 boost::shared_ptr<XMLTree> t (presets_tree ());
1176 XMLNode* root = t->root ();
1177 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1179 XMLProperty const * uri = (*i)->property (X_("uri"));
1180 XMLProperty const * label = (*i)->property (X_("label"));
1185 PresetRecord r (uri->value(), label->value(), true);
1186 _presets.insert (make_pair (r.uri, r));
1191 ////////////////////////////////////////////////////////////////////////////////
1193 LuaPluginInfo::LuaPluginInfo (LuaScriptInfoPtr lsi) {
1194 if (lsi->type != LuaScriptInfo::DSP) {
1195 throw failed_constructor ();
1200 creator = lsi->author;
1201 category = lsi->category;
1202 unique_id = lsi->unique_id;
1204 n_inputs.set (DataType::AUDIO, 1);
1205 n_outputs.set (DataType::AUDIO, 1);
1208 _is_instrument = category == "Instrument";
1212 LuaPluginInfo::load (Session& session)
1214 std::string script = "";
1215 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
1216 return PluginPtr ();
1220 script = Glib::file_get_contents (path);
1221 } catch (Glib::FileError err) {
1222 return PluginPtr ();
1225 if (script.empty ()) {
1226 return PluginPtr ();
1230 PluginPtr plugin (new LuaProc (session.engine (), session, script));
1232 } catch (failed_constructor& err) {
1235 return PluginPtr ();
1238 std::vector<Plugin::PresetRecord>
1239 LuaPluginInfo::get_presets (bool /*user_only*/) const
1241 std::vector<Plugin::PresetRecord> p;
1242 XMLTree* t = new XMLTree;
1243 std::string pf = Glib::build_filename (ARDOUR::user_config_directory (), "presets", string_compose ("lua-%1", unique_id));
1244 if (Glib::file_test (pf, Glib::FILE_TEST_EXISTS)) {
1245 t->set_filename (pf);
1247 XMLNode* root = t->root ();
1248 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1249 XMLProperty const * uri = (*i)->property (X_("uri"));
1250 XMLProperty const * label = (*i)->property (X_("label"));
1251 p.push_back (Plugin::PresetRecord (uri->value(), label->value(), true));