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/pthread_utils.h"
27 #include "ardour/audio_buffer.h"
28 #include "ardour/buffer_set.h"
29 #include "ardour/filesystem_paths.h"
30 #include "ardour/luabindings.h"
31 #include "ardour/luaproc.h"
32 #include "ardour/luascripting.h"
33 #include "ardour/midi_buffer.h"
34 #include "ardour/plugin.h"
35 #include "ardour/session.h"
37 #include "LuaBridge/LuaBridge.h"
41 using namespace ARDOUR;
44 LuaProc::LuaProc (AudioEngine& engine,
46 const std::string &script)
47 : Plugin (engine, session)
48 , _mempool ("LuaProc", 3145728)
50 , lua (lua_newstate (&PBD::TLSF::lalloc, &_mempool))
51 #elif defined USE_MALLOC
54 , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
59 , _lua_does_channelmapping (false)
60 , _lua_has_inline_display (false)
61 , _designated_bypass_port (UINT32_MAX)
66 , _has_midi_input (false)
67 , _has_midi_output (false)
71 /* when loading a session, or pasing a processor,
72 * the script is set during set_state();
74 if (!_script.empty () && load_script ()) {
75 throw failed_constructor ();
79 LuaProc::LuaProc (const LuaProc &other)
81 , _mempool ("LuaProc", 3145728)
83 , lua (lua_newstate (&PBD::TLSF::lalloc, &_mempool))
84 #elif defined USE_MALLOC
87 , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
91 , _script (other.script ())
92 , _origin (other._origin)
93 , _lua_does_channelmapping (false)
94 , _lua_has_inline_display (false)
95 , _designated_bypass_port (UINT32_MAX)
100 , _has_midi_input (false)
101 , _has_midi_output (false)
105 if (load_script ()) {
106 throw failed_constructor ();
109 for (uint32_t i = 0; i < parameter_count (); ++i) {
110 _control_data[i] = other._shadow_data[i];
111 _shadow_data[i] = other._shadow_data[i];
115 LuaProc::~LuaProc () {
116 #ifdef WITH_LUAPROC_STATS
117 if (_info && _stats_cnt > 0) {
118 printf ("LuaProc: '%s' run() avg: %.3f max: %.3f [ms] p: %.1f\n",
119 _info->name.c_str (),
120 0.0001f * _stats_avg[0] / (float) _stats_cnt,
121 0.0001f * _stats_max[0],
122 _stats_max[0] * (float)_stats_cnt / _stats_avg[0]);
123 printf ("LuaProc: '%s' gc() avg: %.3f max: %.3f [ms] p: %.1f\n",
124 _info->name.c_str (),
125 0.0001f * _stats_avg[1] / (float) _stats_cnt,
126 0.0001f * _stats_max[1],
127 _stats_max[1] * (float)_stats_cnt / _stats_avg[1]);
130 lua.do_command ("collectgarbage();");
132 delete (_lua_latency);
133 delete [] _control_data;
134 delete [] _shadow_data;
140 #ifdef WITH_LUAPROC_STATS
141 _stats_avg[0] = _stats_avg[1] = _stats_max[0] = _stats_max[1] = 0;
145 lua.Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
146 // register session object
147 lua_State* L = lua.getState ();
149 LuaBindings::stddef (L);
150 LuaBindings::common (L);
151 LuaBindings::dsp (L);
153 luabridge::getGlobalNamespace (L)
154 .beginNamespace ("Ardour")
155 .deriveClass <LuaProc, PBD::StatefulDestructible> ("LuaProc")
156 .addFunction ("queue_draw", &LuaProc::queue_draw)
157 .addFunction ("shmem", &LuaProc::instance_shm)
158 .addFunction ("table", &LuaProc::instance_ref)
159 .addFunction ("route", &LuaProc::route)
160 .addFunction ("unique_id", &LuaProc::unique_id)
161 .addFunction ("name", &LuaProc::name)
166 // add session to global lua namespace
167 luabridge::push <Session *> (L, &_session);
168 lua_setglobal (L, "Session");
171 luabridge::push <LuaProc *> (L, this);
172 lua_setglobal (L, "self");
177 lua.do_command ("for n in pairs(_G) do print(n) end print ('----')"); // print global env
179 lua.do_command ("function ardour () end");
182 boost::weak_ptr<Route>
183 LuaProc::route () const
186 return boost::weak_ptr<Route>();
188 return static_cast<Route*>(_owner)->weakroute ();
192 LuaProc::lua_print (std::string s) {
193 std::cout <<"LuaProc: " << s << "\n";
194 PBD::error << "LuaProc: " << s << "\n";
198 LuaProc::load_script ()
200 assert (!_lua_dsp); // don't allow to re-initialize
201 LuaPluginInfoPtr lpi;
203 // TODO: refine APIs; function arguments..
204 // - perform channel-map in ardour (silent/scratch buffers) ?
205 // - control-port API (explicit get/set functions ??)
206 // - latency reporting (global var? ctrl-port? set-function ?)
207 // - MIDI -> sparse table of events
208 // { [sample] => { Event }, .. }
209 // or { { sample, Event }, .. }
212 LuaScriptInfoPtr lsi = LuaScripting::script_info (_script);
213 lpi = LuaPluginInfoPtr (new LuaPluginInfo (lsi));
216 _mempool.set_name ("LuaProc: " + lsi->name);
217 _docs = lsi->description;
218 } catch (failed_constructor& err) {
222 lua_State* L = lua.getState ();
223 lua.do_command (_script);
225 // check if script has a DSP callback
226 luabridge::LuaRef lua_dsp_run = luabridge::getGlobal (L, "dsp_run");
227 luabridge::LuaRef lua_dsp_map = luabridge::getGlobal (L, "dsp_runmap");
229 if ((lua_dsp_run.type () != LUA_TFUNCTION) == (lua_dsp_map.type () != LUA_TFUNCTION)) {
233 if (lua_dsp_run.type () == LUA_TFUNCTION) {
234 _lua_dsp = new luabridge::LuaRef (lua_dsp_run);
236 else if (lua_dsp_map.type () == LUA_TFUNCTION) {
237 _lua_dsp = new luabridge::LuaRef (lua_dsp_map);
238 _lua_does_channelmapping = true;
244 luabridge::LuaRef lua_dsp_latency = luabridge::getGlobal (L, "dsp_latency");
245 if (lua_dsp_latency.type () == LUA_TFUNCTION) {
246 _lua_latency = new luabridge::LuaRef (lua_dsp_latency);
249 // initialize the DSP if needed
250 luabridge::LuaRef lua_dsp_init = luabridge::getGlobal (L, "dsp_init");
251 if (lua_dsp_init.type () == LUA_TFUNCTION) {
253 lua_dsp_init (_session.nominal_sample_rate ());
254 } catch (luabridge::LuaException const& e) {
258 _ctrl_params.clear ();
260 luabridge::LuaRef lua_render = luabridge::getGlobal (L, "render_inline");
261 if (lua_render.isFunction ()) {
262 _lua_has_inline_display = true;
265 luabridge::LuaRef lua_params = luabridge::getGlobal (L, "dsp_params");
266 if (lua_params.isFunction ()) {
268 // call function // add try {} catch (luabridge::LuaException const& e)
269 luabridge::LuaRef params = lua_params ();
271 if (params.isTable ()) {
273 for (luabridge::Iterator i (params); !i.isNil (); ++i) {
275 if (!i.key ().isNumber ()) { return false; }
276 if (!i.value ().isTable ()) { return false; }
277 if (!i.value ()["type"].isString ()) { return false; }
278 if (!i.value ()["name"].isString ()) { return false; }
279 if (!i.value ()["min"].isNumber ()) { return false; }
280 if (!i.value ()["max"].isNumber ()) { return false; }
282 int pn = i.key ().cast<int> ();
283 std::string type = i.value ()["type"].cast<std::string> ();
284 if (type == "input") {
285 if (!i.value ()["default"].isNumber ()) { return false; }
286 _ctrl_params.push_back (std::make_pair (false, pn));
288 else if (type == "output") {
289 _ctrl_params.push_back (std::make_pair (true, pn));
293 assert (pn == (int) _ctrl_params.size ());
295 //_param_desc[pn] = boost::shared_ptr<ParameterDescriptor> (new ParameterDescriptor());
296 luabridge::LuaRef lr = i.value ();
298 if (type == "input") {
299 _param_desc[pn].normal = lr["default"].cast<float> ();
301 _param_desc[pn].normal = lr["min"].cast<float> (); // output-port, no default
303 _param_desc[pn].lower = lr["min"].cast<float> ();
304 _param_desc[pn].upper = lr["max"].cast<float> ();
305 _param_desc[pn].toggled = lr["toggled"].isBoolean () && (lr["toggled"]).cast<bool> ();
306 _param_desc[pn].logarithmic = lr["logarithmic"].isBoolean () && (lr["logarithmic"]).cast<bool> ();
307 _param_desc[pn].integer_step = lr["integer"].isBoolean () && (lr["integer"]).cast<bool> ();
308 _param_desc[pn].sr_dependent = lr["ratemult"].isBoolean () && (lr["ratemult"]).cast<bool> ();
309 _param_desc[pn].enumeration = lr["enum"].isBoolean () && (lr["enum"]).cast<bool> ();
311 if (lr["bypass"].isBoolean () && (lr["bypass"]).cast<bool> ()) {
312 _designated_bypass_port = pn - 1; // lua table starts at 1.
315 if (lr["unit"].isString ()) {
316 std::string unit = lr["unit"].cast<std::string> ();
317 if (unit == "dB") { _param_desc[pn].unit = ParameterDescriptor::DB; }
318 else if (unit == "Hz") { _param_desc[pn].unit = ParameterDescriptor::HZ; }
319 else if (unit == "Midi Note") { _param_desc[pn].unit = ParameterDescriptor::MIDI_NOTE; }
321 _param_desc[pn].label = (lr["name"]).cast<std::string> ();
322 _param_desc[pn].scale_points = parse_scale_points (&lr);
324 luabridge::LuaRef doc = lr["doc"];
325 if (doc.isString ()) {
326 _param_doc[pn] = doc.cast<std::string> ();
330 assert (!(_param_desc[pn].toggled && _param_desc[pn].logarithmic));
335 _control_data = new float[parameter_count ()];
336 _shadow_data = new float[parameter_count ()];
338 for (uint32_t i = 0; i < parameter_count (); ++i) {
339 if (parameter_is_input (i)) {
340 _control_data[i] = _shadow_data[i] = default_value (i);
344 // expose ctrl-ports to global lua namespace
345 luabridge::push <float *> (L, _control_data);
346 lua_setglobal (L, "CtrlPorts");
348 return false; // no error
352 LuaProc::can_support_io_configuration (const ChanCount& in, ChanCount& out, ChanCount* imprecise)
354 // caller must hold process lock (no concurrent calls to interpreter
355 _output_configs.clear ();
357 lua_State* L = lua.getState ();
358 luabridge::LuaRef ioconfig = luabridge::getGlobal (L, "dsp_ioconfig");
360 luabridge::LuaRef *_iotable = NULL; // can't use reference :(
362 if (ioconfig.isFunction ()) {
364 luabridge::LuaRef iotable = ioconfig ();
365 if (iotable.isTable ()) {
366 _iotable = new luabridge::LuaRef (iotable);
368 } catch (luabridge::LuaException const& e) {
376 /* empty table as default */
377 luabridge::LuaRef iotable = luabridge::newTable(L);
378 _iotable = new luabridge::LuaRef (iotable);
381 // now we can reference it.
382 luabridge::LuaRef iotable (*_iotable);
385 if ((iotable).length () < 1) {
386 /* empty table as only config, to get default values */
387 luabridge::LuaRef ioconf = luabridge::newTable(L);
391 const int audio_in = in.n_audio ();
392 const int midi_in = in.n_midi ();
394 // preferred setting (provided by plugin_insert)
395 const int preferred_out = out.n_audio ();
396 const int preferred_midiout = out.n_midi ();
400 float penalty = 9999;
403 #define FOUNDCFG_PENALTY(in, out, p) { \
404 _output_configs.insert (out); \
407 midi_out = possible_midiout; \
409 imprecise->set (DataType::AUDIO, (in)); \
410 imprecise->set (DataType::MIDI, possible_midiin); \
412 _has_midi_input = (possible_midiin > 0); \
413 _has_midi_output = (possible_midiout > 0); \
419 #define FOUNDCFG_IMPRECISE(in, out) { \
420 const float p = fabsf ((float)(out) - preferred_out) * \
421 (((out) > preferred_out) ? 1.1 : 1) \
422 + fabsf ((float)possible_midiout - preferred_midiout) * \
423 ((possible_midiout - preferred_midiout) ? 0.6 : 0.5) \
424 + fabsf ((float)(in) - audio_in) * \
425 (((in) > audio_in) ? 275 : 250) \
426 + fabsf ((float)possible_midiin - midi_in) * \
427 ((possible_midiin - midi_in) ? 100 : 110); \
428 FOUNDCFG_PENALTY(in, out, p); \
431 #define FOUNDCFG(out) \
432 FOUNDCFG_IMPRECISE(audio_in, out)
434 #define ANYTHINGGOES \
435 _output_configs.insert (0);
437 #define UPTO(nch) { \
438 for (int n = 1; n < nch; ++n) { \
439 _output_configs.insert (n); \
447 for (luabridge::Iterator i (iotable); !i.isNil (); ++i) {
448 luabridge::LuaRef io (i.value ());
453 int possible_in = io["audio_in"].isNumber() ? io["audio_in"] : -1;
454 int possible_out = io["audio_out"].isNumber() ? io["audio_out"] : -1;
455 int possible_midiin = io["midi_in"].isNumber() ? io["midi_in"] : 0;
456 int possible_midiout = io["midi_out"].isNumber() ? io["midi_out"] : 0;
458 if (midi_in != possible_midiin && !imprecise) {
463 if ((possible_in == audio_in) && (possible_out == preferred_out)) {
464 /* Set penalty so low that this output configuration
465 * will trump any other one */
466 FOUNDCFG_PENALTY(audio_in, preferred_out, -1);
469 if (possible_out == 0 && possible_midiout == 0) {
470 /* skip configurations with no output at all */
474 if (possible_in == -1 || possible_in == -2) {
475 /* wildcard for input */
476 if (possible_out == possible_in) {
477 /* either both -1 or both -2 (invalid and
478 * interpreted as both -1): out must match in */
480 } else if (possible_out == -3 - possible_in) {
481 /* one is -1, the other is -2: any output configuration
482 * possible, pick what the insert prefers */
483 FOUNDCFG (preferred_out);
485 } else if (possible_out < -2) {
486 /* variable number of outputs up to -N,
487 * invalid if in == -2 but we accept it anyway */
488 FOUNDCFG (min (-possible_out, preferred_out));
491 /* exact number of outputs */
492 FOUNDCFG (possible_out);
496 if (possible_in < -2 || possible_in >= 0) {
497 /* specified number, exact or up to */
499 if (possible_in >= 0) {
500 /* configuration can only match possible_in */
501 desired_in = possible_in;
503 /* configuration can match up to -possible_in */
504 desired_in = min (-possible_in, audio_in);
506 if (!imprecise && audio_in != desired_in) {
507 /* skip that configuration, it cannot match
508 * the required audio input count, and we
509 * cannot ask for change via \imprecise */
510 } else if (possible_out == -1 || possible_out == -2) {
511 /* any output configuration possible
512 * out == -2 is invalid, interpreted as out == -1.
513 * Really imprecise only if desired_in != audio_in */
514 FOUNDCFG_IMPRECISE (desired_in, preferred_out);
516 } else if (possible_out < -2) {
517 /* variable number of outputs up to -N
518 * not specified if in > 0, but we accept it anyway.
519 * Really imprecise only if desired_in != audio_in */
520 FOUNDCFG_IMPRECISE (desired_in, min (-possible_out, preferred_out));
523 /* exact number of outputs
524 * Really imprecise only if desired_in != audio_in */
525 FOUNDCFG_IMPRECISE (desired_in, possible_out);
536 _selected_in = *imprecise;
541 out.set (DataType::MIDI, midi_out);
542 out.set (DataType::AUDIO, audio_out);
549 LuaProc::configure_io (ChanCount in, ChanCount out)
551 in.set (DataType::MIDI, _has_midi_input ? 1 : 0);
552 out.set (DataType::MIDI, _has_midi_output ? 1 : 0);
554 _info->n_inputs = _selected_in;
555 _info->n_outputs = _selected_out;
557 // configure the DSP if needed
558 if (in != _configured_in || out != _configured_out || !_configured) {
559 lua_State* L = lua.getState ();
560 luabridge::LuaRef lua_dsp_configure = luabridge::getGlobal (L, "dsp_configure");
561 if (lua_dsp_configure.type () == LUA_TFUNCTION) {
563 luabridge::LuaRef io = lua_dsp_configure (&in, &out);
565 ChanCount lin (_selected_in);
566 ChanCount lout (_selected_out);
568 if (io["audio_in"].type() == LUA_TNUMBER) {
569 const int c = io["audio_in"].cast<int> ();
571 lin.set (DataType::AUDIO, c);
574 if (io["audio_out"].type() == LUA_TNUMBER) {
575 const int c = io["audio_out"].cast<int> ();
577 lout.set (DataType::AUDIO, c);
580 if (io["midi_in"].type() == LUA_TNUMBER) {
581 const int c = io["midi_in"].cast<int> ();
583 lin.set (DataType::MIDI, c);
586 if (io["midi_out"].type() == LUA_TNUMBER) {
587 const int c = io["midi_out"].cast<int> ();
589 lout.set (DataType::MIDI, c);
592 _info->n_inputs = lin;
593 _info->n_outputs = lout;
596 } catch (luabridge::LuaException const& e) {
597 PBD::error << "LuaException: " << e.what () << "\n";
599 std::cerr << "LuaException: " << e.what () << "\n";
609 _configured_out = out;
615 LuaProc::connect_and_run (BufferSet& bufs,
616 samplepos_t start, samplepos_t end, double speed,
617 ChanMapping const& in, ChanMapping const& out,
618 pframes_t nframes, samplecnt_t offset)
624 Plugin::connect_and_run (bufs, start, end, speed, in, out, nframes, offset);
626 // This is needed for ARDOUR::Session requests :(
627 if (! SessionEvent::has_per_thread_pool ()) {
629 snprintf (name, 64, "Proc-%p", this);
630 pthread_set_name (name);
631 SessionEvent::create_per_thread_pool (name, 64);
632 PBD::notify_event_loops_about_thread_creation (pthread_self(), name, 64);
635 uint32_t const n = parameter_count ();
636 for (uint32_t i = 0; i < n; ++i) {
637 if (parameter_is_control (i) && parameter_is_input (i)) {
638 _control_data[i] = _shadow_data[i];
642 #ifdef WITH_LUAPROC_STATS
643 int64_t t0 = g_get_monotonic_time ();
647 if (_lua_does_channelmapping) {
648 // run the DSP function
649 (*_lua_dsp)(&bufs, in, out, nframes, offset);
652 BufferSet& silent_bufs = _session.get_silent_buffers (ChanCount (DataType::AUDIO, 1));
653 BufferSet& scratch_bufs = _session.get_scratch_buffers (ChanCount (DataType::AUDIO, 1));
655 lua_State* L = lua.getState ();
656 luabridge::LuaRef in_map (luabridge::newTable (L));
657 luabridge::LuaRef out_map (luabridge::newTable (L));
659 const uint32_t audio_in = _configured_in.n_audio ();
660 const uint32_t audio_out = _configured_out.n_audio ();
661 const uint32_t midi_in = _configured_in.n_midi ();
663 for (uint32_t ap = 0; ap < audio_in; ++ap) {
665 const uint32_t buf_index = in.get(DataType::AUDIO, ap, &valid);
667 in_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
669 in_map[ap + 1] = silent_bufs.get_audio (0).data (offset);
672 for (uint32_t ap = 0; ap < audio_out; ++ap) {
674 const uint32_t buf_index = out.get(DataType::AUDIO, ap, &valid);
676 out_map[ap + 1] = bufs.get_audio (buf_index).data (offset);
678 out_map[ap + 1] = scratch_bufs.get_audio (0).data (offset);
682 luabridge::LuaRef lua_midi_src_tbl (luabridge::newTable (L));
683 int e = 1; // > 1 port, we merge events (unsorted)
684 for (uint32_t mp = 0; mp < midi_in; ++mp) {
686 const uint32_t idx = in.get(DataType::MIDI, mp, &valid);
688 for (MidiBuffer::iterator m = bufs.get_midi(idx).begin();
689 m != bufs.get_midi(idx).end(); ++m, ++e) {
690 const Evoral::Event<samplepos_t> ev(*m, false);
691 luabridge::LuaRef lua_midi_data (luabridge::newTable (L));
692 const uint8_t* data = ev.buffer();
693 for (uint32_t i = 0; i < ev.size(); ++i) {
694 lua_midi_data [i + 1] = data[i];
696 luabridge::LuaRef lua_midi_event (luabridge::newTable (L));
697 lua_midi_event["time"] = 1 + (*m).time();
698 lua_midi_event["data"] = lua_midi_data;
699 lua_midi_event["bytes"] = data;
700 lua_midi_event["size"] = ev.size();
701 lua_midi_src_tbl[e] = lua_midi_event;
706 if (_has_midi_input) {
707 // XXX TODO This needs a better solution than global namespace
708 luabridge::push (L, lua_midi_src_tbl);
709 lua_setglobal (L, "midiin");
712 luabridge::LuaRef lua_midi_sink_tbl (luabridge::newTable (L));
713 if (_has_midi_output) {
714 luabridge::push (L, lua_midi_sink_tbl);
715 lua_setglobal (L, "midiout");
718 // run the DSP function
719 (*_lua_dsp)(in_map, out_map, nframes);
721 // copy back midi events
722 if (_has_midi_output && lua_midi_sink_tbl.isTable ()) {
724 const uint32_t idx = out.get(DataType::MIDI, 0, &valid);
725 if (valid && bufs.count().n_midi() > idx) {
726 MidiBuffer& mbuf = bufs.get_midi(idx);
728 for (luabridge::Iterator i (lua_midi_sink_tbl); !i.isNil (); ++i) {
729 if (!i.key ().isNumber ()) { continue; }
730 if (!i.value ()["time"].isNumber ()) { continue; }
731 if (!i.value ()["data"].isTable ()) { continue; }
732 luabridge::LuaRef data_tbl (i.value ()["data"]);
733 samplepos_t tme = i.value ()["time"];
734 if (tme < 1 || tme > nframes) { continue; }
737 for (luabridge::Iterator di (data_tbl); !di.isNil () && size < sizeof(data); ++di, ++size) {
738 data[size] = di.value ();
740 if (size > 0 && size < 64) {
741 mbuf.push_back(tme - 1, size, data);
750 _signal_latency = (*_lua_latency)();
753 } catch (luabridge::LuaException const& e) {
754 PBD::error << "LuaException: " << e.what () << "\n";
756 std::cerr << "LuaException: " << e.what () << "\n";
762 #ifdef WITH_LUAPROC_STATS
763 int64_t t1 = g_get_monotonic_time ();
766 lua.collect_garbage_step ();
767 #ifdef WITH_LUAPROC_STATS
768 if (++_stats_cnt > 0) {
769 int64_t t2 = g_get_monotonic_time ();
770 int64_t ela0 = t1 - t0;
771 int64_t ela1 = t2 - t1;
772 if (ela0 > _stats_max[0]) _stats_max[0] = ela0;
773 if (ela1 > _stats_max[1]) _stats_max[1] = ela1;
774 _stats_avg[0] += ela0;
775 _stats_avg[1] += ela1;
783 LuaProc::add_state (XMLNode* root) const
787 gchar* b64 = g_base64_encode ((const guchar*)_script.c_str (), _script.size ());
788 std::string b64s (b64);
790 XMLNode* script_node = new XMLNode (X_("script"));
791 script_node->set_property (X_("lua"), LUA_VERSION);
792 script_node->set_property (X_("origin"), _origin);
793 script_node->add_content (b64s);
794 root->add_child_nocopy (*script_node);
796 for (uint32_t i = 0; i < parameter_count(); ++i) {
797 if (parameter_is_input(i) && parameter_is_control(i)) {
798 child = new XMLNode("Port");
799 child->set_property("id", i);
800 child->set_property("value", _shadow_data[i]);
801 root->add_child_nocopy(*child);
807 LuaProc::set_script_from_state (const XMLNode& node)
810 if (node.name () != state_node_name ()) {
814 if ((child = node.child (X_("script"))) != 0) {
815 XMLProperty const* prop;
816 if ((prop = node.property ("origin")) != 0) {
817 _origin = prop->value();
819 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
820 if (!(*n)->is_content ()) { continue; }
822 guchar* buf = g_base64_decode ((*n)->content ().c_str (), &size);
823 _script = std::string ((const char*)buf, size);
825 if (load_script ()) {
826 PBD::error << _("Failed to load Lua script from session state.") << endmsg;
828 std::cerr << "Failed Lua Script: " << _script << std::endl;
835 if (_script.empty ()) {
836 PBD::error << _("Session State for LuaProcessor did not include a Lua script.") << endmsg;
840 PBD::error << _("Invalid/incompatible Lua script found for LuaProcessor.") << endmsg;
847 LuaProc::set_state (const XMLNode& node, int version)
849 #ifndef NO_PLUGIN_STATE
851 XMLNodeConstIterator iter;
855 if (_script.empty ()) {
856 if (set_script_from_state (node)) {
861 #ifndef NO_PLUGIN_STATE
862 if (node.name() != state_node_name()) {
863 error << _("Bad node sent to LuaProc::set_state") << endmsg;
867 nodes = node.children ("Port");
868 for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
874 if (!child->get_property("id", port_id)) {
875 warning << _("LuaProc: port has no symbol, ignored") << endmsg;
879 if (!child->get_property("value", value)) {
880 warning << _("LuaProc: port has no value, ignored") << endmsg;
884 set_parameter (port_id, value);
888 return Plugin::set_state (node, version);
892 LuaProc::parameter_count () const
894 return _ctrl_params.size ();
898 LuaProc::default_value (uint32_t port)
900 if (_ctrl_params[port].first) {
904 int lp = _ctrl_params[port].second;
905 return _param_desc[lp].normal;
909 LuaProc::set_parameter (uint32_t port, float val)
911 assert (port < parameter_count ());
912 if (get_parameter (port) == val) {
915 _shadow_data[port] = val;
916 Plugin::set_parameter (port, val);
920 LuaProc::get_parameter (uint32_t port) const
922 if (parameter_is_input (port)) {
923 return _shadow_data[port];
925 return _control_data[port];
930 LuaProc::get_parameter_descriptor (uint32_t port, ParameterDescriptor& desc) const
932 assert (port <= parameter_count ());
933 int lp = _ctrl_params[port].second;
934 const ParameterDescriptor& d (_param_desc.find(lp)->second);
936 desc.lower = d.lower;
937 desc.upper = d.upper;
938 desc.normal = d.normal;
939 desc.toggled = d.toggled;
940 desc.logarithmic = d.logarithmic;
941 desc.integer_step = d.integer_step;
942 desc.sr_dependent = d.sr_dependent;
943 desc.enumeration = d.enumeration;
945 desc.label = d.label;
946 desc.scale_points = d.scale_points;
948 desc.update_steps ();
953 LuaProc::get_parameter_docs (uint32_t port) const {
954 assert (port <= parameter_count ());
955 int lp = _ctrl_params[port].second;
956 return _param_doc.find(lp)->second;
960 LuaProc::nth_parameter (uint32_t port, bool& ok) const
962 if (port < _ctrl_params.size ()) {
971 LuaProc::parameter_is_input (uint32_t port) const
973 assert (port < _ctrl_params.size ());
974 return (!_ctrl_params[port].first);
978 LuaProc::parameter_is_output (uint32_t port) const
980 assert (port < _ctrl_params.size ());
981 return (_ctrl_params[port].first);
984 std::set<Evoral::Parameter>
985 LuaProc::automatable () const
987 std::set<Evoral::Parameter> automatables;
988 for (uint32_t i = 0; i < _ctrl_params.size (); ++i) {
989 if (parameter_is_input (i)) {
990 automatables.insert (automatables.end (), Evoral::Parameter (PluginAutomation, 0, i));
997 LuaProc::describe_parameter (Evoral::Parameter param)
999 if (param.type () == PluginAutomation && param.id () < parameter_count ()) {
1000 int lp = _ctrl_params[param.id ()].second;
1001 return _param_desc[lp].label;
1007 LuaProc::print_parameter (uint32_t param, char* buf, uint32_t len) const
1010 if (param < parameter_count ()) {
1011 snprintf (buf, len, "%.3f", get_parameter (param));
1018 boost::shared_ptr<ScalePoints>
1019 LuaProc::parse_scale_points (luabridge::LuaRef* lr)
1021 if (!(*lr)["scalepoints"].isTable()) {
1022 return boost::shared_ptr<ScalePoints> ();
1026 boost::shared_ptr<ScalePoints> rv = boost::shared_ptr<ScalePoints>(new ScalePoints());
1027 luabridge::LuaRef scalepoints ((*lr)["scalepoints"]);
1029 for (luabridge::Iterator i (scalepoints); !i.isNil (); ++i) {
1030 if (!i.key ().isString ()) { continue; }
1031 if (!i.value ().isNumber ()) { continue; }
1032 rv->insert(make_pair(i.key ().cast<std::string> (),
1033 i.value ().cast<float> ()));
1037 if (rv->size() > 0) {
1040 return boost::shared_ptr<ScalePoints> ();
1043 boost::shared_ptr<ScalePoints>
1044 LuaProc::get_scale_points (uint32_t port) const
1046 int lp = _ctrl_params[port].second;
1047 return _param_desc.find(lp)->second.scale_points;
1051 LuaProc::setup_lua_inline_gui (LuaState *lua_gui)
1053 lua_State* LG = lua_gui->getState ();
1054 LuaBindings::stddef (LG);
1055 LuaBindings::common (LG);
1056 LuaBindings::dsp (LG);
1057 LuaBindings::osc (LG);
1059 lua_gui->Print.connect (sigc::mem_fun (*this, &LuaProc::lua_print));
1060 lua_gui->do_command ("function ardour () end");
1061 lua_gui->do_command (_script);
1063 // TODO think: use a weak-pointer here ?
1064 // (the GUI itself uses a shared ptr to this plugin, so we should be good)
1065 luabridge::getGlobalNamespace (LG)
1066 .beginNamespace ("Ardour")
1067 .beginClass <LuaProc> ("LuaProc")
1068 .addFunction ("shmem", &LuaProc::instance_shm)
1069 .addFunction ("table", &LuaProc::instance_ref)
1073 luabridge::push <LuaProc *> (LG, this);
1074 lua_setglobal (LG, "self");
1076 luabridge::push <float *> (LG, _control_data);
1077 lua_setglobal (LG, "CtrlPorts");
1079 ////////////////////////////////////////////////////////////////////////////////
1081 #include "ardour/search_paths.h"
1085 LuaProc::preset_name_to_uri (const std::string& name) const
1087 std::string uri ("urn:lua:");
1091 sha1_write (&s, (const uint8_t *) name.c_str(), name.size ());
1092 sha1_write (&s, (const uint8_t *) _script.c_str(), _script.size ());
1093 sha1_result_hash (&s, hash);
1098 LuaProc::presets_file () const
1100 return string_compose ("lua-%1", _info->unique_id);
1104 LuaProc::presets_tree () const
1106 XMLTree* t = new XMLTree;
1107 std::string p = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1109 if (!Glib::file_test (p, Glib::FILE_TEST_IS_DIR)) {
1110 if (g_mkdir_with_parents (p.c_str(), 0755) != 0) {
1111 error << _("Unable to create LuaProc presets directory") << endmsg;
1115 p = Glib::build_filename (p, presets_file ());
1117 if (!Glib::file_test (p, Glib::FILE_TEST_EXISTS)) {
1118 t->set_root (new XMLNode (X_("LuaPresets")));
1122 t->set_filename (p);
1131 LuaProc::load_preset (PresetRecord r)
1133 boost::shared_ptr<XMLTree> t (presets_tree ());
1138 XMLNode* root = t->root ();
1139 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1141 if (!(*i)->get_property (X_("label"), str)) {
1144 if (str != r.label) {
1148 for (XMLNodeList::const_iterator j = (*i)->children().begin(); j != (*i)->children().end(); ++j) {
1149 if ((*j)->name() == X_("Parameter")) {
1152 if (!(*j)->get_property (X_("index"), index) ||
1153 !(*j)->get_property (X_("value"), value)) {
1156 set_parameter (index, value);
1157 PresetPortSetValue (index, value); /* EMIT SIGNAL */
1160 return Plugin::load_preset(r);
1166 LuaProc::do_save_preset (std::string name) {
1168 boost::shared_ptr<XMLTree> t (presets_tree ());
1173 // prevent dups -- just in case
1174 t->root()->remove_nodes_and_delete (X_("label"), name);
1176 std::string uri (preset_name_to_uri (name));
1178 XMLNode* p = new XMLNode (X_("Preset"));
1179 p->set_property (X_("uri"), uri);
1180 p->set_property (X_("label"), name);
1182 for (uint32_t i = 0; i < parameter_count(); ++i) {
1183 if (parameter_is_input (i)) {
1184 XMLNode* c = new XMLNode (X_("Parameter"));
1185 c->set_property (X_("index"), i);
1186 c->set_property (X_("value"), get_parameter (i));
1187 p->add_child_nocopy (*c);
1190 t->root()->add_child_nocopy (*p);
1192 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1193 f = Glib::build_filename (f, presets_file ());
1200 LuaProc::do_remove_preset (std::string name)
1202 boost::shared_ptr<XMLTree> t (presets_tree ());
1206 t->root()->remove_nodes_and_delete (X_("label"), name);
1207 std::string f = Glib::build_filename (ARDOUR::user_config_directory (), "presets");
1208 f = Glib::build_filename (f, presets_file ());
1213 LuaProc::find_presets ()
1215 boost::shared_ptr<XMLTree> t (presets_tree ());
1217 XMLNode* root = t->root ();
1218 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1222 if (!(*i)->get_property (X_("uri"), uri) || !(*i)->get_property (X_("label"), label)) {
1226 PresetRecord r (uri, label, true);
1227 _presets.insert (make_pair (r.uri, r));
1232 ////////////////////////////////////////////////////////////////////////////////
1234 LuaPluginInfo::LuaPluginInfo (LuaScriptInfoPtr lsi) {
1235 if (lsi->type != LuaScriptInfo::DSP) {
1236 throw failed_constructor ();
1241 creator = lsi->author;
1242 category = lsi->category;
1243 unique_id = lsi->unique_id;
1245 n_inputs.set (DataType::AUDIO, 1);
1246 n_outputs.set (DataType::AUDIO, 1);
1252 LuaPluginInfo::load (Session& session)
1254 std::string script = "";
1255 if (!Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
1256 return PluginPtr ();
1260 script = Glib::file_get_contents (path);
1261 } catch (Glib::FileError const& err) {
1262 return PluginPtr ();
1265 if (script.empty ()) {
1266 return PluginPtr ();
1270 LuaProc* lp = new LuaProc (session.engine (), session, script);
1271 lp->set_origin (path);
1272 PluginPtr plugin (lp);
1274 } catch (failed_constructor& err) {
1277 return PluginPtr ();
1280 std::vector<Plugin::PresetRecord>
1281 LuaPluginInfo::get_presets (bool /*user_only*/) const
1283 std::vector<Plugin::PresetRecord> p;
1284 XMLTree* t = new XMLTree;
1285 std::string pf = Glib::build_filename (ARDOUR::user_config_directory (), "presets", string_compose ("lua-%1", unique_id));
1286 if (Glib::file_test (pf, Glib::FILE_TEST_EXISTS)) {
1287 t->set_filename (pf);
1289 XMLNode* root = t->root ();
1290 for (XMLNodeList::const_iterator i = root->children().begin(); i != root->children().end(); ++i) {
1291 XMLProperty const * uri = (*i)->property (X_("uri"));
1292 XMLProperty const * label = (*i)->property (X_("label"));
1293 p.push_back (Plugin::PresetRecord (uri->value(), label->value(), true));