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 , _origin (other._origin)
91 , _lua_does_channelmapping (false)
92 , _lua_has_inline_display (false)
93 , _designated_bypass_port (UINT32_MAX)
97 , _has_midi_input (false)
98 , _has_midi_output (false)
102 if (load_script ()) {
103 throw failed_constructor ();
106 for (uint32_t i = 0; i < parameter_count (); ++i) {
107 _control_data[i] = other._shadow_data[i];
108 _shadow_data[i] = other._shadow_data[i];
112 LuaProc::~LuaProc () {
113 #ifdef WITH_LUAPROC_STATS
114 if (_info && _stats_cnt > 0) {
115 printf ("LuaProc: '%s' run() avg: %.3f max: %.3f [ms]\n",
116 _info->name.c_str (),
117 0.0001f * _stats_avg[0] / (float) _stats_cnt,
118 0.0001f * _stats_max[0]);
119 printf ("LuaProc: '%s' gc() avg: %.3f max: %.3f [ms]\n",
120 _info->name.c_str (),
121 0.0001f * _stats_avg[1] / (float) _stats_cnt,
122 0.0001f * _stats_max[1]);
125 lua.do_command ("collectgarbage();");
127 delete [] _control_data;
128 delete [] _shadow_data;
134 #ifdef WITH_LUAPROC_STATS
135 _stats_avg[0] = _stats_avg[1] = _stats_max[0] = _stats_max[1] = _stats_cnt = 0;
139 lua.Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
140 // register session object
141 lua_State* L = lua.getState ();
142 LuaBindings::stddef (L);
143 LuaBindings::common (L);
144 LuaBindings::dsp (L);
146 luabridge::getGlobalNamespace (L)
147 .beginNamespace ("Ardour")
148 .deriveClass <LuaProc, PBD::StatefulDestructible> ("LuaProc")
149 .addFunction ("queue_draw", &LuaProc::queue_draw)
150 .addFunction ("shmem", &LuaProc::instance_shm)
151 .addFunction ("table", &LuaProc::instance_ref)
152 .addFunction ("route", &LuaProc::route)
153 .addFunction ("unique_id", &LuaProc::unique_id)
154 .addFunction ("name", &LuaProc::name)
158 // add session to global lua namespace
159 luabridge::push <Session *> (L, &_session);
160 lua_setglobal (L, "Session");
163 luabridge::push <LuaProc *> (L, this);
164 lua_setglobal (L, "self");
167 lua.do_command ("io = nil os = nil loadfile = nil require = nil dofile = nil package = nil debug = nil");
169 lua.do_command ("for n in pairs(_G) do print(n) end print ('----')"); // print global env
171 lua.do_command ("function ardour () end");
174 boost::weak_ptr<Route>
175 LuaProc::route () const
177 return static_cast<Route*>(_owner)->weakroute ();
181 LuaProc::lua_print (std::string s) {
182 std::cout <<"LuaProc: " << s << "\n";
183 PBD::error << "LuaProc: " << s << "\n";
187 LuaProc::load_script ()
189 assert (!_lua_dsp); // don't allow to re-initialize
190 LuaPluginInfoPtr lpi;
192 // TODO: refine APIs; function arguments..
193 // - perform channel-map in ardour (silent/scratch buffers) ?
194 // - control-port API (explicit get/set functions ??)
195 // - latency reporting (global var? ctrl-port? set-function ?)
196 // - MIDI -> sparse table of events
197 // { [sample] => { Event }, .. }
198 // or { { sample, Event }, .. }
201 LuaScriptInfoPtr lsi = LuaScripting::script_info (_script);
202 lpi = LuaPluginInfoPtr (new LuaPluginInfo (lsi));
205 _mempool.set_name ("LuaProc: " + lsi->name);
206 _docs = lsi->description;
207 } catch (failed_constructor& err) {
211 lua_State* L = lua.getState ();
212 lua.do_command (_script);
214 // check if script has a DSP callback
215 luabridge::LuaRef lua_dsp_run = luabridge::getGlobal (L, "dsp_run");
216 luabridge::LuaRef lua_dsp_map = luabridge::getGlobal (L, "dsp_runmap");
218 if ((lua_dsp_run.type () != LUA_TFUNCTION) == (lua_dsp_map.type () != LUA_TFUNCTION)) {
222 if (lua_dsp_run.type () == LUA_TFUNCTION) {
223 _lua_dsp = new luabridge::LuaRef (lua_dsp_run);
225 else if (lua_dsp_map.type () == LUA_TFUNCTION) {
226 _lua_dsp = new luabridge::LuaRef (lua_dsp_map);
227 _lua_does_channelmapping = true;
233 // initialize the DSP if needed
234 luabridge::LuaRef lua_dsp_init = luabridge::getGlobal (L, "dsp_init");
235 if (lua_dsp_init.type () == LUA_TFUNCTION) {
237 lua_dsp_init (_session.nominal_frame_rate ());
238 } catch (luabridge::LuaException const& e) {
243 _ctrl_params.clear ();
245 luabridge::LuaRef lua_render = luabridge::getGlobal (L, "render_inline");
246 if (lua_render.isFunction ()) {
247 _lua_has_inline_display = true;
250 luabridge::LuaRef lua_params = luabridge::getGlobal (L, "dsp_params");
251 if (lua_params.isFunction ()) {
253 // call function // add try {} catch (luabridge::LuaException const& e)
254 luabridge::LuaRef params = lua_params ();
256 if (params.isTable ()) {
258 for (luabridge::Iterator i (params); !i.isNil (); ++i) {
260 if (!i.key ().isNumber ()) { return false; }
261 if (!i.value ().isTable ()) { return false; }
262 if (!i.value ()["type"].isString ()) { return false; }
263 if (!i.value ()["name"].isString ()) { return false; }
264 if (!i.value ()["min"].isNumber ()) { return false; }
265 if (!i.value ()["max"].isNumber ()) { return false; }
267 int pn = i.key ().cast<int> ();
268 std::string type = i.value ()["type"].cast<std::string> ();
269 if (type == "input") {
270 if (!i.value ()["default"].isNumber ()) { return false; }
271 _ctrl_params.push_back (std::make_pair (false, pn));
273 else if (type == "output") {
274 _ctrl_params.push_back (std::make_pair (true, pn));
278 assert (pn == (int) _ctrl_params.size ());
280 //_param_desc[pn] = boost::shared_ptr<ParameterDescriptor> (new ParameterDescriptor());
281 luabridge::LuaRef lr = i.value ();
283 if (type == "input") {
284 _param_desc[pn].normal = lr["default"].cast<float> ();
286 _param_desc[pn].normal = lr["min"].cast<float> (); // output-port, no default
288 _param_desc[pn].lower = lr["min"].cast<float> ();
289 _param_desc[pn].upper = lr["max"].cast<float> ();
290 _param_desc[pn].toggled = lr["toggled"].isBoolean () && (lr["toggled"]).cast<bool> ();
291 _param_desc[pn].logarithmic = lr["logarithmic"].isBoolean () && (lr["logarithmic"]).cast<bool> ();
292 _param_desc[pn].integer_step = lr["integer"].isBoolean () && (lr["integer"]).cast<bool> ();
293 _param_desc[pn].sr_dependent = lr["ratemult"].isBoolean () && (lr["ratemult"]).cast<bool> ();
294 _param_desc[pn].enumeration = lr["enum"].isBoolean () && (lr["enum"]).cast<bool> ();
296 if (lr["bypass"].isBoolean () && (lr["bypass"]).cast<bool> ()) {
297 _designated_bypass_port = pn - 1; // lua table starts at 1.
300 if (lr["unit"].isString ()) {
301 std::string unit = lr["unit"].cast<std::string> ();
302 if (unit == "dB") { _param_desc[pn].unit = ParameterDescriptor::DB; }
303 else if (unit == "Hz") { _param_desc[pn].unit = ParameterDescriptor::HZ; }
304 else if (unit == "Midi Note") { _param_desc[pn].unit = ParameterDescriptor::MIDI_NOTE; }
306 _param_desc[pn].label = (lr["name"]).cast<std::string> ();
307 _param_desc[pn].scale_points = parse_scale_points (&lr);
309 luabridge::LuaRef doc = lr["doc"];
310 if (doc.isString ()) {
311 _param_doc[pn] = doc.cast<std::string> ();
315 assert (!(_param_desc[pn].toggled && _param_desc[pn].logarithmic));
320 _control_data = new float[parameter_count ()];
321 _shadow_data = new float[parameter_count ()];
323 for (uint32_t i = 0; i < parameter_count (); ++i) {
324 if (parameter_is_input (i)) {
325 _control_data[i] = _shadow_data[i] = default_value (i);
329 // expose ctrl-ports to global lua namespace
330 luabridge::push <float *> (L, _control_data);
331 lua_setglobal (L, "CtrlPorts");
333 return false; // no error
337 LuaProc::can_support_io_configuration (const ChanCount& in, ChanCount& out, ChanCount* imprecise)
339 // caller must hold process lock (no concurrent calls to interpreter
340 _output_configs.clear ();
342 lua_State* L = lua.getState ();
343 luabridge::LuaRef ioconfig = luabridge::getGlobal (L, "dsp_ioconfig");
345 luabridge::LuaRef *_iotable = NULL; // can't use reference :(
347 if (ioconfig.isFunction ()) {
349 luabridge::LuaRef iotable = ioconfig ();
350 if (iotable.isTable ()) {
351 _iotable = new luabridge::LuaRef (iotable);
353 } catch (luabridge::LuaException const& e) {
359 /* empty table as default */
360 luabridge::LuaRef iotable = luabridge::newTable(L);
361 _iotable = new luabridge::LuaRef (iotable);
364 // now we can reference it.
365 luabridge::LuaRef iotable (*_iotable);
368 if ((iotable).length () < 1) {
369 /* empty table as only config, to get default values */
370 luabridge::LuaRef ioconf = luabridge::newTable(L);
374 const int audio_in = in.n_audio ();
375 const int midi_in = in.n_midi ();
377 // preferred setting (provided by plugin_insert)
378 const int preferred_out = out.n_audio ();
379 const int preferred_midiout = out.n_midi ();
383 float penalty = 9999;
386 #define FOUNDCFG_PENALTY(in, out, p) { \
387 _output_configs.insert (out); \
390 midi_out = possible_midiout; \
392 imprecise->set (DataType::AUDIO, (in)); \
393 imprecise->set (DataType::MIDI, possible_midiin); \
395 _has_midi_input = (possible_midiin > 0); \
396 _has_midi_output = (possible_midiout > 0); \
402 #define FOUNDCFG_IMPRECISE(in, out) { \
403 const float p = fabsf ((float)(out) - preferred_out) * \
404 (((out) > preferred_out) ? 1.1 : 1) \
405 + fabsf ((float)possible_midiout - preferred_midiout) * \
406 ((possible_midiout - preferred_midiout) ? 0.6 : 0.5) \
407 + fabsf ((float)(in) - audio_in) * \
408 (((in) > audio_in) ? 275 : 250) \
409 + fabsf ((float)possible_midiin - midi_in) * \
410 ((possible_midiin - midi_in) ? 100 : 110); \
411 FOUNDCFG_PENALTY(in, out, p); \
414 #define FOUNDCFG(out) \
415 FOUNDCFG_IMPRECISE(audio_in, out)
417 #define ANYTHINGGOES \
418 _output_configs.insert (0);
420 #define UPTO(nch) { \
421 for (int n = 1; n < nch; ++n) { \
422 _output_configs.insert (n); \
430 for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
431 luabridge::LuaRef io (i.value ());
436 int possible_in = io["audio_in"].isNumber() ? io["audio_in"] : -1;
437 int possible_out = io["audio_out"].isNumber() ? io["audio_out"] : -1;
438 int possible_midiin = io["midi_in"].isNumber() ? io["midi_in"] : 0;
439 int possible_midiout = io["midi_out"].isNumber() ? io["midi_out"] : 0;
441 if (midi_in != possible_midiin && !imprecise) {
446 if ((possible_in == audio_in) && (possible_out == preferred_out)) {
447 /* Set penalty so low that this output configuration
448 * will trump any other one */
449 FOUNDCFG_PENALTY(audio_in, preferred_out, -1);
452 if (possible_out == 0 && possible_midiout == 0) {
453 /* skip configurations with no output at all */
457 if (possible_in == -1 || possible_in == -2) {
458 /* wildcard for input */
459 if (possible_out == possible_in) {
460 /* either both -1 or both -2 (invalid and
461 * interpreted as both -1): out must match in */
463 } else if (possible_out == -3 - possible_in) {
464 /* one is -1, the other is -2: any output configuration
465 * possible, pick what the insert prefers */
466 FOUNDCFG (preferred_out);
468 } else if (possible_out < -2) {
469 /* variable number of outputs up to -N,
470 * invalid if in == -2 but we accept it anyway */
471 FOUNDCFG (min (-possible_out, preferred_out));
474 /* exact number of outputs */
475 FOUNDCFG (possible_out);
479 if (possible_in < -2 || possible_in >= 0) {
480 /* specified number, exact or up to */
482 if (possible_in >= 0) {
483 /* configuration can only match possible_in */
484 desired_in = possible_in;
486 /* configuration can match up to -possible_in */
487 desired_in = min (-possible_in, audio_in);
489 if (!imprecise && audio_in != desired_in) {
490 /* skip that configuration, it cannot match
491 * the required audio input count, and we
492 * cannot ask for change via \imprecise */
493 } else if (possible_out == -1 || possible_out == -2) {
494 /* any output configuration possible
495 * out == -2 is invalid, interpreted as out == -1.
496 * Really imprecise only if desired_in != audio_in */
497 FOUNDCFG_IMPRECISE (desired_in, preferred_out);
499 } else if (possible_out < -2) {
500 /* variable number of outputs up to -N
501 * not specified if in > 0, but we accept it anyway.
502 * Really imprecise only if desired_in != audio_in */
503 FOUNDCFG_IMPRECISE (desired_in, min (-possible_out, preferred_out));
506 /* exact number of outputs
507 * Really imprecise only if desired_in != audio_in */
508 FOUNDCFG_IMPRECISE (desired_in, possible_out);
519 _selected_in = *imprecise;
524 out.set (DataType::MIDI, midi_out);
525 out.set (DataType::AUDIO, audio_out);
532 LuaProc::configure_io (ChanCount in, ChanCount out)
534 in.set (DataType::MIDI, _has_midi_input ? 1 : 0);
535 out.set (DataType::MIDI, _has_midi_output ? 1 : 0);
537 _info->n_inputs = _selected_in;
538 _info->n_outputs = _selected_out;
540 // configure the DSP if needed
541 if (in != _configured_in || out != _configured_out || !_configured) {
542 lua_State* L = lua.getState ();
543 luabridge::LuaRef lua_dsp_configure = luabridge::getGlobal (L, "dsp_configure");
544 if (lua_dsp_configure.type () == LUA_TFUNCTION) {
546 luabridge::LuaRef io = lua_dsp_configure (&in, &out);
548 ChanCount lin (_selected_in);
549 ChanCount lout (_selected_out);
551 if (io["audio_in"].type() == LUA_TNUMBER) {
552 const int c = io["audio_in"].cast<int> ();
554 lin.set (DataType::AUDIO, c);
557 if (io["audio_out"].type() == LUA_TNUMBER) {
558 const int c = io["audio_out"].cast<int> ();
560 lout.set (DataType::AUDIO, c);
563 if (io["midi_in"].type() == LUA_TNUMBER) {
564 const int c = io["midi_in"].cast<int> ();
566 lin.set (DataType::MIDI, c);
569 if (io["midi_out"].type() == LUA_TNUMBER) {
570 const int c = io["midi_out"].cast<int> ();
572 lout.set (DataType::MIDI, c);
575 _info->n_inputs = lin;
576 _info->n_outputs = lout;
579 } catch (luabridge::LuaException const& e) {
580 PBD::error << "LuaException: " << e.what () << "\n";
582 std::cerr << "LuaException: " << e.what () << "\n";
590 _configured_out = out;
596 LuaProc::connect_and_run (BufferSet& bufs,
597 framepos_t start, framepos_t end, double speed,
598 ChanMapping in, ChanMapping out,
599 pframes_t nframes, framecnt_t offset)
605 Plugin::connect_and_run (bufs, start, end, speed, in, out, nframes, offset);
607 // This is needed for ARDOUR::Session requests :(
608 if (! SessionEvent::has_per_thread_pool ()) {
610 snprintf (name, 64, "Proc-%p", this);
611 pthread_set_name (name);
612 SessionEvent::create_per_thread_pool (name, 64);
613 PBD::notify_event_loops_about_thread_creation (pthread_self(), name, 64);
616 uint32_t const n = parameter_count ();
617 for (uint32_t i = 0; i < n; ++i) {
618 if (parameter_is_control (i) && parameter_is_input (i)) {
619 _control_data[i] = _shadow_data[i];
623 #ifdef WITH_LUAPROC_STATS
624 int64_t t0 = g_get_monotonic_time ();
628 if (_lua_does_channelmapping) {
629 // run the DSP function
630 (*_lua_dsp)(&bufs, in, out, nframes, offset);
633 BufferSet& silent_bufs = _session.get_silent_buffers (ChanCount (DataType::AUDIO, 1));
634 BufferSet& scratch_bufs = _session.get_scratch_buffers (ChanCount (DataType::AUDIO, 1));
636 lua_State* L = lua.getState ();
637 luabridge::LuaRef in_map (luabridge::newTable (L));
638 luabridge::LuaRef out_map (luabridge::newTable (L));
640 const uint32_t audio_in = _configured_in.n_audio ();
641 const uint32_t audio_out = _configured_out.n_audio ();
642 const uint32_t midi_in = _configured_in.n_midi ();
644 for (uint32_t ap = 0; ap < audio_in; ++ap) {
646 const uint32_t buf_index = in.get(DataType::AUDIO, ap, &valid);
648 in_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
650 in_map[ap + 1] = silent_bufs.get_audio (0).data (offset);
653 for (uint32_t ap = 0; ap < audio_out; ++ap) {
655 const uint32_t buf_index = out.get(DataType::AUDIO, ap, &valid);
657 out_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
659 out_map[ap + 1] = scratch_bufs.get_audio (0).data (offset);
663 luabridge::LuaRef lua_midi_src_tbl (luabridge::newTable (L));
664 int e = 1; // > 1 port, we merge events (unsorted)
665 for (uint32_t mp = 0; mp < midi_in; ++mp) {
667 const uint32_t idx = in.get(DataType::MIDI, mp, &valid);
669 for (MidiBuffer::iterator m = bufs.get_midi(idx).begin();
670 m != bufs.get_midi(idx).end(); ++m, ++e) {
671 const Evoral::Event<framepos_t> ev(*m, false);
672 luabridge::LuaRef lua_midi_data (luabridge::newTable (L));
673 const uint8_t* data = ev.buffer();
674 for (uint32_t i = 0; i < ev.size(); ++i) {
675 lua_midi_data [i + 1] = data[i];
677 luabridge::LuaRef lua_midi_event (luabridge::newTable (L));
678 lua_midi_event["time"] = 1 + (*m).time();
679 lua_midi_event["data"] = lua_midi_data;
680 lua_midi_event["bytes"] = data;
681 lua_midi_event["size"] = ev.size();
682 lua_midi_src_tbl[e] = lua_midi_event;
687 if (_has_midi_input) {
688 // XXX TODO This needs a better solution than global namespace
689 luabridge::push (L, lua_midi_src_tbl);
690 lua_setglobal (L, "midiin");
693 luabridge::LuaRef lua_midi_sink_tbl (luabridge::newTable (L));
694 if (_has_midi_output) {
695 luabridge::push (L, lua_midi_sink_tbl);
696 lua_setglobal (L, "midiout");
699 // run the DSP function
700 (*_lua_dsp)(in_map, out_map, nframes);
702 // copy back midi events
703 if (_has_midi_output && lua_midi_sink_tbl.isTable ()) {
705 const uint32_t idx = out.get(DataType::MIDI, 0, &valid);
706 if (valid && bufs.count().n_midi() > idx) {
707 MidiBuffer& mbuf = bufs.get_midi(idx);
709 for (luabridge::Iterator i (lua_midi_sink_tbl); !i.isNil (); ++i) {
710 if (!i.key ().isNumber ()) { continue; }
711 if (!i.value ()["time"].isNumber ()) { continue; }
712 if (!i.value ()["data"].isTable ()) { continue; }
713 luabridge::LuaRef data_tbl (i.value ()["data"]);
714 framepos_t tme = i.value ()["time"];
715 if (tme < 1 || tme > nframes) { continue; }
718 for (luabridge::Iterator di (data_tbl); !di.isNil () && size < sizeof(data); ++di, ++size) {
719 data[size] = di.value ();
721 if (size > 0 && size < 64) {
722 mbuf.push_back(tme - 1, size, data);
729 } catch (luabridge::LuaException const& e) {
730 PBD::error << "LuaException: " << e.what () << "\n";
732 std::cerr << "LuaException: " << e.what () << "\n";
736 #ifdef WITH_LUAPROC_STATS
737 int64_t t1 = g_get_monotonic_time ();
740 lua.collect_garbage_step ();
741 #ifdef WITH_LUAPROC_STATS
743 int64_t t2 = g_get_monotonic_time ();
744 int64_t ela0 = t1 - t0;
745 int64_t ela1 = t2 - t1;
746 if (ela0 > _stats_max[0]) _stats_max[0] = ela0;
747 if (ela1 > _stats_max[1]) _stats_max[1] = ela1;
748 _stats_avg[0] += ela0;
749 _stats_avg[1] += ela1;
756 LuaProc::add_state (XMLNode* root) const
762 gchar* b64 = g_base64_encode ((const guchar*)_script.c_str (), _script.size ());
763 std::string b64s (b64);
765 XMLNode* script_node = new XMLNode (X_("script"));
766 script_node->add_property (X_("lua"), LUA_VERSION);
767 script_node->add_property (X_("origin"), _origin);
768 script_node->add_content (b64s);
769 root->add_child_nocopy (*script_node);
771 for (uint32_t i = 0; i < parameter_count(); ++i) {
772 if (parameter_is_input(i) && parameter_is_control(i)) {
773 child = new XMLNode("Port");
774 snprintf(buf, sizeof(buf), "%u", i);
775 child->add_property("id", std::string(buf));
776 snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
777 child->add_property("value", std::string(buf));
778 root->add_child_nocopy(*child);
784 LuaProc::set_script_from_state (const XMLNode& node)
787 if (node.name () != state_node_name ()) {
791 if ((child = node.child (X_("script"))) != 0) {
792 XMLProperty const* prop;
793 if ((prop = node.property ("origin")) != 0) {
794 _origin = prop->value();
796 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
797 if (!(*n)->is_content ()) { continue; }
799 guchar* buf = g_base64_decode ((*n)->content ().c_str (), &size);
800 _script = std::string ((const char*)buf, size);
802 if (load_script ()) {
803 PBD::error << _("Failed to load Lua script from session state.") << endmsg;
805 std::cerr << "Failed Lua Script: " << _script << std::endl;
812 if (_script.empty ()) {
813 PBD::error << _("Session State for LuaProcessor did not include a Lua script.") << endmsg;
817 PBD::error << _("Invalid/incompatible Lua script found for LuaProcessor.") << endmsg;
824 LuaProc::set_state (const XMLNode& node, int version)
826 #ifndef NO_PLUGIN_STATE
828 XMLProperty const * prop;
829 XMLNodeConstIterator iter;
837 if (_script.empty ()) {
838 if (set_script_from_state (node)) {
843 #ifndef NO_PLUGIN_STATE
844 if (node.name() != state_node_name()) {
845 error << _("Bad node sent to LuaProc::set_state") << endmsg;
849 nodes = node.children ("Port");
850 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
852 if ((prop = child->property("id")) != 0) {
853 port = prop->value().c_str();
855 warning << _("LuaProc: port has no symbol, ignored") << endmsg;
858 if ((prop = child->property("value")) != 0) {
859 value = prop->value().c_str();
861 warning << _("LuaProc: port has no value, ignored") << endmsg;
864 sscanf (port, "%" PRIu32, &port_id);
865 set_parameter (port_id, atof(value));
869 return Plugin::set_state (node, version);
873 LuaProc::parameter_count () const
875 return _ctrl_params.size ();
879 LuaProc::default_value (uint32_t port)
881 if (_ctrl_params[port].first) {
885 int lp = _ctrl_params[port].second;
886 return _param_desc[lp].normal;
890 LuaProc::set_parameter (uint32_t port, float val)
892 assert (port < parameter_count ());
893 if (get_parameter (port) == val) {
896 _shadow_data[port] = val;
897 Plugin::set_parameter (port, val);
901 LuaProc::get_parameter (uint32_t port) const
903 if (parameter_is_input (port)) {
904 return _shadow_data[port];
906 return _control_data[port];
911 LuaProc::get_parameter_descriptor (uint32_t port, ParameterDescriptor& desc) const
913 assert (port <= parameter_count ());
914 int lp = _ctrl_params[port].second;
915 const ParameterDescriptor& d (_param_desc.find(lp)->second);
917 desc.lower = d.lower;
918 desc.upper = d.upper;
919 desc.normal = d.normal;
920 desc.toggled = d.toggled;
921 desc.logarithmic = d.logarithmic;
922 desc.integer_step = d.integer_step;
923 desc.sr_dependent = d.sr_dependent;
924 desc.enumeration = d.enumeration;
926 desc.label = d.label;
927 desc.scale_points = d.scale_points;
929 desc.update_steps ();
934 LuaProc::get_parameter_docs (uint32_t port) const {
935 assert (port <= parameter_count ());
936 int lp = _ctrl_params[port].second;
937 return _param_doc.find(lp)->second;
941 LuaProc::nth_parameter (uint32_t port, bool& ok) const
943 if (port < _ctrl_params.size ()) {
952 LuaProc::parameter_is_input (uint32_t port) const
954 assert (port < _ctrl_params.size ());
955 return (!_ctrl_params[port].first);
959 LuaProc::parameter_is_output (uint32_t port) const
961 assert (port < _ctrl_params.size ());
962 return (_ctrl_params[port].first);
965 std::set<Evoral::Parameter>
966 LuaProc::automatable () const
968 std::set<Evoral::Parameter> automatables;
969 for (uint32_t i = 0; i < _ctrl_params.size (); ++i) {
970 if (parameter_is_input (i)) {
971 automatables.insert (automatables.end (), Evoral::Parameter (PluginAutomation, 0, i));
978 LuaProc::describe_parameter (Evoral::Parameter param)
980 if (param.type () == PluginAutomation && param.id () < parameter_count ()) {
981 int lp = _ctrl_params[param.id ()].second;
982 return _param_desc[lp].label;
988 LuaProc::print_parameter (uint32_t param, char* buf, uint32_t len) const
991 if (param < parameter_count ()) {
992 snprintf (buf, len, "%.3f", get_parameter (param));
999 boost::shared_ptr<ScalePoints>
1000 LuaProc::parse_scale_points (luabridge::LuaRef* lr)
1002 if (!(*lr)["scalepoints"].isTable()) {
1003 return boost::shared_ptr<ScalePoints> ();
1007 boost::shared_ptr<ScalePoints> rv = boost::shared_ptr<ScalePoints>(new ScalePoints());
1008 luabridge::LuaRef scalepoints ((*lr)["scalepoints"]);
1010 for (luabridge::Iterator i (scalepoints); !i.isNil (); ++i) {
1011 if (!i.key ().isString ()) { continue; }
1012 if (!i.value ().isNumber ()) { continue; }
1013 rv->insert(make_pair(i.key ().cast<std::string> (),
1014 i.value ().cast<float> ()));
1018 if (rv->size() > 0) {
1021 return boost::shared_ptr<ScalePoints> ();
1024 boost::shared_ptr<ScalePoints>
1025 LuaProc::get_scale_points (uint32_t port) const
1027 int lp = _ctrl_params[port].second;
1028 return _param_desc.find(lp)->second.scale_points;
1032 LuaProc::setup_lua_inline_gui (LuaState *lua_gui)
1034 lua_State* LG = lua_gui->getState ();
1035 LuaBindings::stddef (LG);
1036 LuaBindings::common (LG);
1037 LuaBindings::dsp (LG);
1038 LuaBindings::osc (LG);
1040 lua_gui->Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
1041 lua_gui->do_command ("function ardour () end");
1042 lua_gui->do_command (_script);
1044 // TODO think: use a weak-pointer here ?
1045 // (the GUI itself uses a shared ptr to this plugin, so we should be good)
1046 luabridge::getGlobalNamespace (LG)
1047 .beginNamespace ("Ardour")
1048 .beginClass <LuaProc> ("LuaProc")
1049 .addFunction ("shmem", &LuaProc::instance_shm)
1050 .addFunction ("table", &LuaProc::instance_ref)
1054 luabridge::push <LuaProc *> (LG, this);
1055 lua_setglobal (LG, "self");
1057 luabridge::push <float *> (LG, _control_data);
1058 lua_setglobal (LG, "CtrlPorts");
1060 ////////////////////////////////////////////////////////////////////////////////
1062 #include "ardour/search_paths.h"
1066 LuaProc::preset_name_to_uri (const std::string& name) const
1068 std::string uri ("urn:lua:");
1072 sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
1073 sha1_write (&s, (const uint8_t *) _script.c_str(), _script.size ());
1074 sha1_result_hash (&s, hash);
1079 LuaProc::presets_file () const
1081 return string_compose ("lua-%1", _info->unique_id);
1085 LuaProc::presets_tree () const
1087 XMLTree* t = new XMLTree;
1088 std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1090 if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
1091 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
1092 error << _("Unable to create LuaProc presets directory") << endmsg;
1096 p = Glib::build_filename (p, presets_file ());
1098 if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
1099 t->set_root (new XMLNode (X_("LuaPresets")));
1103 t->set_filename (p);
1112 LuaProc::load_preset (PresetRecord r)
1114 boost::shared_ptr<XMLTree> t (presets_tree ());
1119 XMLNode* root = t->root ();
1120 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1121 XMLProperty const * label = (*i)->property (X_("label"));
1123 if (label->value() != r.label) {
1127 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
1128 if ((*j)->name() == X_("Parameter")) {
1129 XMLProperty const * index = (*j)->property (X_("index"));
1130 XMLProperty const * value = (*j)->property (X_("value"));
1134 const uint32_t p = atoi (index->value().c_str());
1135 const float v = atof (value->value().c_str ());
1136 set_parameter (p, v);
1137 PresetPortSetValue (p, v); /* EMIT SIGNAL */
1140 return Plugin::load_preset(r);
1146 LuaProc::do_save_preset (std::string name) {
1148 boost::shared_ptr<XMLTree> t (presets_tree ());
1153 // prevent dups -- just in case
1154 t->root()->remove_nodes_and_delete (X_("label"), name);
1156 std::string uri (preset_name_to_uri (name));
1158 XMLNode* p = new XMLNode (X_("Preset"));
1159 p->add_property (X_("uri"), uri);
1160 p->add_property (X_("label"), name);
1162 for (uint32_t i = 0; i < parameter_count(); ++i) {
1163 if (parameter_is_input (i)) {
1164 XMLNode* c = new XMLNode (X_("Parameter"));
1165 c->add_property (X_("index"), string_compose ("%1", i));
1166 c->add_property (X_("value"), string_compose ("%1", get_parameter (i)));
1167 p->add_child_nocopy (*c);
1170 t->root()->add_child_nocopy (*p);
1172 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1173 f = Glib::build_filename (f, presets_file ());
1180 LuaProc::do_remove_preset (std::string name)
1182 boost::shared_ptr<XMLTree> t (presets_tree ());
1186 t->root()->remove_nodes_and_delete (X_("label"), name);
1187 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1188 f = Glib::build_filename (f, presets_file ());
1193 LuaProc::find_presets ()
1195 boost::shared_ptr<XMLTree> t (presets_tree ());
1197 XMLNode* root = t->root ();
1198 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1200 XMLProperty const * uri = (*i)->property (X_("uri"));
1201 XMLProperty const * label = (*i)->property (X_("label"));
1206 PresetRecord r (uri->value(), label->value(), true);
1207 _presets.insert (make_pair (r.uri, r));
1212 ////////////////////////////////////////////////////////////////////////////////
1214 LuaPluginInfo::LuaPluginInfo (LuaScriptInfoPtr lsi) {
1215 if (lsi->type != LuaScriptInfo::DSP) {
1216 throw failed_constructor ();
1221 creator = lsi->author;
1222 category = lsi->category;
1223 unique_id = lsi->unique_id;
1225 n_inputs.set (DataType::AUDIO, 1);
1226 n_outputs.set (DataType::AUDIO, 1);
1229 _is_instrument = category == "Instrument";
1233 LuaPluginInfo::load (Session& session)
1235 std::string script = "";
1236 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
1237 return PluginPtr ();
1241 script = Glib::file_get_contents (path);
1242 } catch (Glib::FileError err) {
1243 return PluginPtr ();
1246 if (script.empty ()) {
1247 return PluginPtr ();
1251 LuaProc* lp = new LuaProc (session.engine (), session, script);
1252 lp->set_origin (path);
1253 PluginPtr plugin (lp);
1255 } catch (failed_constructor& err) {
1258 return PluginPtr ();
1261 std::vector<Plugin::PresetRecord>
1262 LuaPluginInfo::get_presets (bool /*user_only*/) const
1264 std::vector<Plugin::PresetRecord> p;
1265 XMLTree* t = new XMLTree;
1266 std::string pf = Glib::build_filename (ARDOUR::user_config_directory (), "presets", string_compose ("lua-%1", unique_id));
1267 if (Glib::file_test (pf, Glib::FILE_TEST_EXISTS)) {
1268 t->set_filename (pf);
1270 XMLNode* root = t->root ();
1271 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1272 XMLProperty const * uri = (*i)->property (X_("uri"));
1273 XMLProperty const * label = (*i)->property (X_("label"));
1274 p.push_back (Plugin::PresetRecord (uri->value(), label->value(), true));