2 * Copyright (C) 2016 Robin Gareus <robin@gareus.org>
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 #include <vamp-hostsdk/PluginLoader.h>
22 #include "pbd/compose.h"
23 #include "pbd/error.h"
24 #include "pbd/failed_constructor.h"
26 #include "ardour/lua_api.h"
27 #include "ardour/luaproc.h"
28 #include "ardour/luascripting.h"
29 #include "ardour/plugin.h"
30 #include "ardour/plugin_insert.h"
31 #include "ardour/plugin_manager.h"
32 #include "ardour/readable.h"
34 #include "LuaBridge/LuaBridge.h"
38 using namespace ARDOUR;
43 ARDOUR::LuaAPI::datatype_ctor_null (lua_State *L)
45 DataType dt (DataType::NIL);
46 luabridge::Stack <DataType>::push (L, dt);
51 ARDOUR::LuaAPI::datatype_ctor_audio (lua_State *L)
53 DataType dt (DataType::AUDIO);
54 // NB luabridge will copy construct the object and manage lifetime.
55 luabridge::Stack <DataType>::push (L, dt);
60 ARDOUR::LuaAPI::datatype_ctor_midi (lua_State *L)
62 DataType dt (DataType::MIDI);
63 luabridge::Stack <DataType>::push (L, dt);
67 boost::shared_ptr<Processor>
68 ARDOUR::LuaAPI::nil_processor ()
70 return boost::shared_ptr<Processor> ();
73 boost::shared_ptr<Processor>
74 ARDOUR::LuaAPI::new_luaproc (Session *s, const string& name)
77 return boost::shared_ptr<Processor> ();
81 ARDOUR::LuaScriptList & _scripts (LuaScripting::instance ().scripts (LuaScriptInfo::DSP));
82 for (LuaScriptList::const_iterator i = _scripts.begin (); i != _scripts.end (); ++i) {
83 if (name == (*i)->name) {
90 warning << _("Script with given name was not found\n");
91 return boost::shared_ptr<Processor> ();
96 LuaPluginInfoPtr lpi (new LuaPluginInfo (spi));
99 warning << _("Failed to instantiate Lua Processor\n");
100 return boost::shared_ptr<Processor> ();
103 return boost::shared_ptr<Processor> (new PluginInsert (*s, p));
107 ARDOUR::LuaAPI::new_plugin_info (const string& name, ARDOUR::PluginType type)
109 PluginManager& manager = PluginManager::instance ();
110 PluginInfoList all_plugs;
111 all_plugs.insert (all_plugs.end (), manager.ladspa_plugin_info ().begin (), manager.ladspa_plugin_info ().end ());
112 all_plugs.insert (all_plugs.end (), manager.lua_plugin_info ().begin (), manager.lua_plugin_info ().end ());
113 #ifdef WINDOWS_VST_SUPPORT
114 all_plugs.insert (all_plugs.end (), manager.windows_vst_plugin_info ().begin (), manager.windows_vst_plugin_info ().end ());
117 all_plugs.insert (all_plugs.end (), manager.lxvst_plugin_info ().begin (), manager.lxvst_plugin_info ().end ());
119 #ifdef AUDIOUNIT_SUPPORT
120 all_plugs.insert (all_plugs.end (), manager.au_plugin_info ().begin (), manager.au_plugin_info ().end ());
123 all_plugs.insert (all_plugs.end (), manager.lv2_plugin_info ().begin (), manager.lv2_plugin_info ().end ());
126 for (PluginInfoList::const_iterator i = all_plugs.begin (); i != all_plugs.end (); ++i) {
127 if (((*i)->name == name || (*i)->unique_id == name) && (*i)->type == type) {
131 return PluginInfoPtr ();
134 boost::shared_ptr<Processor>
135 ARDOUR::LuaAPI::new_plugin (Session *s, const string& name, ARDOUR::PluginType type, const string& preset)
138 return boost::shared_ptr<Processor> ();
141 PluginInfoPtr pip = new_plugin_info (name, type);
144 return boost::shared_ptr<Processor> ();
147 PluginPtr p = pip->load (*s);
149 return boost::shared_ptr<Processor> ();
152 if (!preset.empty ()) {
153 const Plugin::PresetRecord *pr = p->preset_by_label (preset);
155 p->load_preset (*pr);
159 return boost::shared_ptr<Processor> (new PluginInsert (*s, p));
163 ARDOUR::LuaAPI::set_plugin_insert_param (boost::shared_ptr<PluginInsert> pi, uint32_t which, float val)
165 boost::shared_ptr<Plugin> plugin = pi->plugin ();
166 if (!plugin) { return false; }
169 uint32_t controlid = plugin->nth_parameter (which, ok);
170 if (!ok) { return false; }
171 if (!plugin->parameter_is_input (controlid)) { return false; }
173 ParameterDescriptor pd;
174 if (plugin->get_parameter_descriptor (controlid, pd) != 0) { return false; }
175 if (val < pd.lower || val > pd.upper) { return false; }
177 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter (PluginAutomation, 0, controlid));
178 c->set_value (val, PBD::Controllable::NoGroup);
183 ARDOUR::LuaAPI::get_plugin_insert_param (boost::shared_ptr<PluginInsert> pi, uint32_t which, bool &ok)
186 boost::shared_ptr<Plugin> plugin = pi->plugin ();
187 if (!plugin) { return 0; }
188 uint32_t controlid = plugin->nth_parameter (which, ok);
189 if (!ok) { return 0; }
190 return plugin->get_parameter ( controlid );
194 ARDOUR::LuaAPI::set_processor_param (boost::shared_ptr<Processor> proc, uint32_t which, float val)
196 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
197 if (!pi) { return false; }
198 return set_plugin_insert_param (pi, which, val);
202 ARDOUR::LuaAPI::get_processor_param (boost::shared_ptr<Processor> proc, uint32_t which, bool &ok)
205 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
206 if (!pi) { return false; }
207 return get_plugin_insert_param (pi, which, ok);
211 ARDOUR::LuaAPI::plugin_automation (lua_State *L)
213 typedef boost::shared_ptr<Processor> T;
215 int top = lua_gettop (L);
217 return luaL_argerror (L, 1, "invalid number of arguments, :plugin_automation (plugin, parameter_number)");
219 T* const p = luabridge::Userdata::get<T> (L, 1, false);
220 uint32_t which = luabridge::Stack<uint32_t>::get (L, 2);
222 return luaL_error (L, "Invalid pointer to Ardour:Processor");
224 boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (*p);
226 return luaL_error (L, "Given Processor is not a Plugin Insert");
228 boost::shared_ptr<Plugin> plugin = pi->plugin ();
230 return luaL_error (L, "Given Processor is not a Plugin");
234 uint32_t controlid = plugin->nth_parameter (which, ok);
236 return luaL_error (L, "Invalid Parameter");
238 if (!plugin->parameter_is_input (controlid)) {
239 return luaL_error (L, "Given Parameter is not an input");
242 ParameterDescriptor pd;
243 if (plugin->get_parameter_descriptor (controlid, pd) != 0) {
244 return luaL_error (L, "Cannot describe parameter");
247 boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter (PluginAutomation, 0, controlid));
249 luabridge::Stack<boost::shared_ptr<AutomationList> >::push (L, c->alist ());
250 luabridge::Stack<boost::shared_ptr<Evoral::ControlList> >::push (L, c->list ());
251 luabridge::Stack<ParameterDescriptor>::push (L, pd);
256 ARDOUR::LuaOSC::Address::send (lua_State *L)
258 Address * const luaosc = luabridge::Userdata::get <Address> (L, 1, false);
260 return luaL_error (L, "Invalid pointer to OSC.Address");
262 if (!luaosc->_addr) {
263 return luaL_error (L, "Invalid Destination Address");
266 int top = lua_gettop (L);
268 return luaL_argerror (L, 1, "invalid number of arguments, :send (path, type, ...)");
271 const char* path = luaL_checkstring (L, 2);
272 const char* type = luaL_checkstring (L, 3);
273 assert (path && type);
275 if ((int) strlen (type) != top - 3) {
276 return luaL_argerror (L, 3, "type description does not match arguments");
279 lo_message msg = lo_message_new ();
281 for (int i = 4; i <= top; ++i) {
282 char t = type[i - 4];
283 int lt = lua_type (L, i);
287 if (t == LO_STRING) {
288 ok = lo_message_add_string (msg, luaL_checkstring (L, i));
289 } else if (t == LO_CHAR) {
290 char c = luaL_checkstring (L, i) [0];
291 ok = lo_message_add_char (msg, c);
295 if (t == LO_TRUE || t == LO_FALSE) {
296 if (lua_toboolean (L, i)) {
297 ok = lo_message_add_true (msg);
299 ok = lo_message_add_false (msg);
305 ok = lo_message_add_int32 (msg, (int32_t) luaL_checkinteger (L, i));
307 else if (t == LO_FLOAT) {
308 ok = lo_message_add_float (msg, (float) luaL_checknumber (L, i));
310 else if (t == LO_DOUBLE) {
311 ok = lo_message_add_double (msg, (double) luaL_checknumber (L, i));
313 else if (t == LO_INT64) {
314 ok = lo_message_add_double (msg, (int64_t) luaL_checknumber (L, i));
321 return luaL_argerror (L, i, "type description does not match parameter");
325 int rv = lo_send_message (luaosc->_addr, path, msg);
326 lo_message_free (msg);
327 luabridge::Stack<bool>::push (L, (rv == 0));
331 static double hue2rgb (const double p, const double q, double t) {
332 if (t < 0.0) t += 1.0;
333 if (t > 1.0) t -= 1.0;
334 if (t < 1.0 / 6.0) return p + (q - p) * 6.0 * t;
335 if (t < 1.0 / 2.0) return q;
336 if (t < 2.0 / 3.0) return p + (q - p) * (2.0 / 3.0 - t) * 6.0;
341 ARDOUR::LuaAPI::hsla_to_rgba (lua_State *L)
343 int top = lua_gettop (L);
345 return luaL_argerror (L, 1, "invalid number of arguments, :hsla_to_rgba (h, s, l [,a])");
347 double h = luabridge::Stack<double>::get (L, 1);
348 double s = luabridge::Stack<double>::get (L, 2);
349 double l = luabridge::Stack<double>::get (L, 3);
352 a = luabridge::Stack<double>::get (L, 4);
355 // we can't use ArdourCanvas::hsva_to_color here
356 // besides we want HSL not HSV and without intermediate
357 // color_to_rgba (rgba_to_color ())
359 const double cq = l < 0.5 ? l * (1 + s) : l + s - l * s;
360 const double cp = 2.f * l - cq;
361 r = hue2rgb (cp, cq, h + 1.0 / 3.0);
362 g = hue2rgb (cp, cq, h);
363 b = hue2rgb (cp, cq, h - 1.0 / 3.0);
365 luabridge::Stack<double>::push (L, r);
366 luabridge::Stack<double>::push (L, g);
367 luabridge::Stack<double>::push (L, b);
368 luabridge::Stack<double>::push (L, a);
373 ARDOUR::LuaAPI::build_filename (lua_State *L)
375 std::vector<std::string> elem;
376 int top = lua_gettop (L);
378 return luaL_argerror (L, 1, "invalid number of arguments, build_filename (path, ...)");
380 for (int i = 1; i <= top; ++i) {
381 int lt = lua_type (L, i);
382 if (lt != LUA_TSTRING) {
383 return luaL_argerror (L, i, "invalid argument type, expected string");
385 elem.push_back (luaL_checkstring (L, i));
388 luabridge::Stack<std::string>::push (L, Glib::build_filename (elem));
392 luabridge::LuaRef::Proxy&
393 luabridge::LuaRef::Proxy::clone_instance (const void* classkey, void* p) {
394 lua_rawgeti (m_L, LUA_REGISTRYINDEX, m_tableRef);
395 lua_rawgeti (m_L, LUA_REGISTRYINDEX, m_keyRef);
397 luabridge::UserdataPtr::push_raw (m_L, p, classkey);
399 lua_rawset (m_L, -3);
404 LuaTableRef::LuaTableRef () {}
405 LuaTableRef::~LuaTableRef () {}
408 LuaTableRef::get (lua_State* L)
410 luabridge::LuaRef rv (luabridge::newTable (L));
411 for (std::vector<LuaTableEntry>::const_iterator i = _data.begin (); i != _data.end (); ++i) {
412 switch ((*i).keytype) {
414 assign (&rv, i->k_s, *i);
417 assign (&rv, i->k_n, *i);
421 luabridge::push (L, rv);
426 LuaTableRef::set (lua_State* L)
428 if (!lua_istable (L, -1)) { return luaL_error (L, "argument is not a table"); }
431 lua_pushvalue (L, -1);
433 while (lua_next (L, -2)) {
434 lua_pushvalue (L, -2);
436 LuaTableEntry s (lua_type (L, -1), lua_type (L, -2));
437 switch (lua_type (L, -1)) {
439 s.k_s = luabridge::Stack<std::string>::get (L, -1);
443 s.k_n = luabridge::Stack<unsigned int>::get (L, -1);
451 switch (lua_type (L, -2)) {
453 s.s = luabridge::Stack<std::string>::get (L, -2);
456 s.b = lua_toboolean (L, -2);
459 s.n = lua_tonumber (L, -2);
464 lua_getmetatable (L, -2);
465 lua_rawgetp (L, -1, luabridge::getIdentityKey ());
466 if (lua_isboolean (L, -1)) {
468 const void* key = lua_topointer (L, -1);
470 void const* classkey = findclasskey (L, key);
475 s.p = luabridge::Userdata::get_ptr (L, -2);
484 // invalid userdata -- fall through
487 case LUA_TFUNCTION: // no support -- we could... string.format("%q", string.dump(value, true))
488 case LUA_TTABLE: // no nested tables, sorry.
489 case LUA_TNIL: // fallthrough
503 LuaTableRef::findclasskey (lua_State *L, const void* key)
505 lua_pushvalue (L, LUA_REGISTRYINDEX);
507 while (lua_next (L, -2)) {
508 lua_pushvalue (L, -2);
509 if (lua_topointer (L, -2) == key) {
510 void* rv = lua_touserdata (L, -1);
521 void LuaTableRef::assign (luabridge::LuaRef* rv, T key, const LuaTableEntry& s)
523 switch (s.valuetype) {
534 (*rv)[key].clone_instance (s.c, s.p);
542 std::vector<std::string>
543 LuaAPI::Vamp::list_plugins ()
545 using namespace ::Vamp::HostExt;
546 PluginLoader* loader (PluginLoader::getInstance());
547 return loader->listPlugins ();
550 LuaAPI::Vamp::Vamp (const std::string& key, float sample_rate)
552 , _sample_rate (sample_rate)
555 , _initialized (false)
557 using namespace ::Vamp::HostExt;
559 PluginLoader* loader (PluginLoader::getInstance());
560 _plugin = loader->loadPlugin (key, _sample_rate, PluginLoader::ADAPT_ALL_SAFE);
563 PBD::error << string_compose (_("VAMP Plugin \"%1\" could not be loaded"), key) << endmsg;
564 throw failed_constructor ();
568 LuaAPI::Vamp::~Vamp ()
574 LuaAPI::Vamp::reset ()
576 _initialized = false;
583 LuaAPI::Vamp::initialize ()
585 if (!_plugin || _plugin->getMinChannelCount() > 1) {
588 if (!_plugin->initialise (1, _stepsize, _bufsize)) {
596 LuaAPI::Vamp::analyze (boost::shared_ptr<ARDOUR::Readable> r, uint32_t channel, luabridge::LuaRef cb)
599 if (!initialize ()) {
603 assert (_initialized);
605 ::Vamp::Plugin::FeatureSet features;
606 float* data = new float[_bufsize];
607 float* bufs[1] = { data };
609 framecnt_t len = r->readable_length();
614 framecnt_t to_read = std::min ((len - pos), _bufsize);
615 if (r->read (data, pos, to_read, channel) != to_read) {
619 if (to_read != _bufsize) {
620 memset (data + to_read, 0, (_bufsize - to_read) * sizeof (float));
623 features = _plugin->process (bufs, ::Vamp::RealTime::fromSeconds ((double) pos / _sample_rate));
625 if (cb.type () == LUA_TFUNCTION) {
629 pos += std::min (_stepsize, to_read);
640 ::Vamp::Plugin::FeatureSet
641 LuaAPI::Vamp::process (const std::vector<float*>& d, ::Vamp::RealTime rt)
643 if (!_plugin || d.size() == 0) {
644 return ::Vamp::Plugin::FeatureSet ();
646 const float* const* bufs = &d[0];
647 return _plugin->process (bufs, rt);