libs/ardour/lua_api.cc

   1 /*
   2  * Copyright (C) 2016 Robin Gareus <robin@gareus.org>
   3  *
   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.
   8  *
   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.
  13  *
  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.
  17  *
  18  */
  19 #include <cstring>
  20
  21 #include "pbd/error.h"
  22 #include "pbd/compose.h"
  23
  24 #include "ardour/lua_api.h"
  25 #include "ardour/luaproc.h"
  26 #include "ardour/luascripting.h"
  27 #include "ardour/plugin.h"
  28 #include "ardour/plugin_insert.h"
  29 #include "ardour/plugin_manager.h"
  30
  31 #include "LuaBridge/LuaBridge.h"
  32
  33 #include "pbd/i18n.h"
  34
  35 using namespace ARDOUR;
  36 using namespace PBD;
  37 using namespace std;
  38
  39 int
  40 ARDOUR::LuaAPI::datatype_ctor_null (lua_State *L)
  41 {
  42         DataType dt (DataType::NIL);
  43         luabridge::Stack <DataType>::push (L, dt);
  44         return 1;
  45 }
  46
  47 int
  48 ARDOUR::LuaAPI::datatype_ctor_audio (lua_State *L)
  49 {
  50         DataType dt (DataType::AUDIO);
  51         // NB luabridge will copy construct the object and manage lifetime.
  52         luabridge::Stack <DataType>::push (L, dt);
  53         return 1;
  54 }
  55
  56 int
  57 ARDOUR::LuaAPI::datatype_ctor_midi (lua_State *L)
  58 {
  59         DataType dt (DataType::MIDI);
  60         luabridge::Stack <DataType>::push (L, dt);
  61         return 1;
  62 }
  63
  64 boost::shared_ptr<Processor>
  65 ARDOUR::LuaAPI::nil_processor ()
  66 {
  67         return boost::shared_ptr<Processor> ();
  68 }
  69
  70 boost::shared_ptr<Processor>
  71 ARDOUR::LuaAPI::new_luaproc (Session *s, const string& name)
  72 {
  73         if (!s) {
  74                 return boost::shared_ptr<Processor> ();
  75         }
  76
  77         LuaScriptInfoPtr spi;
  78         ARDOUR::LuaScriptList & _scripts (LuaScripting::instance ().scripts (LuaScriptInfo::DSP));
  79         for (LuaScriptList::const_iterator i = _scripts.begin(); i != _scripts.end(); ++i) {
  80                 if (name == (*i)->name) {
  81                         spi = *i;
  82                         break;
  83                 }
  84         }
  85
  86         if (!spi) {
  87                 warning << _("Script with given name was not found\n");
  88                 return boost::shared_ptr<Processor> ();
  89         }
  90
  91         PluginPtr p;
  92         try {
  93                 LuaPluginInfoPtr lpi (new LuaPluginInfo(spi));
  94                 p = (lpi->load (*s));
  95         } catch (...) {
  96                 warning << _("Failed to instantiate Lua Processor\n");
  97                 return boost::shared_ptr<Processor> ();
  98         }
  99
 100         return boost::shared_ptr<Processor> (new PluginInsert (*s, p));
 101 }
 102
 103 PluginInfoPtr
 104 ARDOUR::LuaAPI::new_plugin_info (const string& name, ARDOUR::PluginType type)
 105 {
 106         PluginManager& manager = PluginManager::instance();
 107         PluginInfoList all_plugs;
 108         all_plugs.insert(all_plugs.end(), manager.ladspa_plugin_info().begin(), manager.ladspa_plugin_info().end());
 109         all_plugs.insert(all_plugs.end(), manager.lua_plugin_info().begin(), manager.lua_plugin_info().end());
 110 #ifdef WINDOWS_VST_SUPPORT
 111         all_plugs.insert(all_plugs.end(), manager.windows_vst_plugin_info().begin(), manager.windows_vst_plugin_info().end());
 112 #endif
 113 #ifdef LXVST_SUPPORT
 114         all_plugs.insert(all_plugs.end(), manager.lxvst_plugin_info().begin(), manager.lxvst_plugin_info().end());
 115 #endif
 116 #ifdef AUDIOUNIT_SUPPORT
 117         all_plugs.insert(all_plugs.end(), manager.au_plugin_info().begin(), manager.au_plugin_info().end());
 118 #endif
 119 #ifdef LV2_SUPPORT
 120         all_plugs.insert(all_plugs.end(), manager.lv2_plugin_info().begin(), manager.lv2_plugin_info().end());
 121 #endif
 122
 123         for (PluginInfoList::const_iterator i = all_plugs.begin(); i != all_plugs.end(); ++i) {
 124                 if (((*i)->name == name || (*i)->unique_id == name) && (*i)->type == type) {
 125                         return *i;
 126                 }
 127         }
 128         return PluginInfoPtr ();
 129 }
 130
 131 boost::shared_ptr<Processor>
 132 ARDOUR::LuaAPI::new_plugin (Session *s, const string& name, ARDOUR::PluginType type, const string& preset)
 133 {
 134         if (!s) {
 135                 return boost::shared_ptr<Processor> ();
 136         }
 137
 138         PluginInfoPtr pip = new_plugin_info (name, type);
 139
 140         if (!pip) {
 141                 return boost::shared_ptr<Processor> ();
 142         }
 143
 144         PluginPtr p = pip->load (*s);
 145         if (!p) {
 146                 return boost::shared_ptr<Processor> ();
 147         }
 148
 149         if (!preset.empty()) {
 150                 const Plugin::PresetRecord *pr = p->preset_by_label (preset);
 151                 if (pr) {
 152                         p->load_preset (*pr);
 153                 }
 154         }
 155
 156         return boost::shared_ptr<Processor> (new PluginInsert (*s, p));
 157 }
 158
 159 bool
 160 ARDOUR::LuaAPI::set_plugin_insert_param (boost::shared_ptr<PluginInsert> pi, uint32_t which, float val)
 161 {
 162         boost::shared_ptr<Plugin> plugin = pi->plugin();
 163         if (!plugin) { return false; }
 164
 165         bool ok=false;
 166         uint32_t controlid = plugin->nth_parameter (which, ok);
 167         if (!ok) { return false; }
 168         if (!plugin->parameter_is_input (controlid)) { return false; }
 169
 170         ParameterDescriptor pd;
 171         if (plugin->get_parameter_descriptor (controlid, pd) != 0) { return false; }
 172         if (val < pd.lower || val > pd.upper) { return false; }
 173
 174         boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));
 175         c->set_value (val, PBD::Controllable::NoGroup);
 176         return true;
 177 }
 178
 179 bool
 180 ARDOUR::LuaAPI::set_processor_param (boost::shared_ptr<Processor> proc, uint32_t which, float val)
 181 {
 182         boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (proc);
 183         if (!pi) { return false; }
 184         return set_plugin_insert_param (pi, which, val);
 185 }
 186
 187 int
 188 ARDOUR::LuaAPI::plugin_automation (lua_State *L)
 189 {
 190         typedef boost::shared_ptr<Processor> T;
 191
 192         int top = lua_gettop(L);
 193         if (top < 2) {
 194                 return luaL_argerror (L, 1, "invalid number of arguments, :plugin_automation (plugin, parameter_number)");
 195         }
 196         T* const p = luabridge::Userdata::get<T>(L, 1, false);
 197         uint32_t which = luabridge::Stack<uint32_t>::get (L, 2);
 198         if (!p) {
 199                 return luaL_error (L, "Invalid pointer to Ardour:Processor");
 200         }
 201         boost::shared_ptr<PluginInsert> pi = boost::dynamic_pointer_cast<PluginInsert> (*p);
 202         if (!pi) {
 203                 return luaL_error (L, "Given Processor is not a Plugin Insert");
 204         }
 205         boost::shared_ptr<Plugin> plugin = pi->plugin();
 206         if (!plugin) {
 207                 return luaL_error (L, "Given Processor is not a Plugin");
 208         }
 209
 210         bool ok=false;
 211         uint32_t controlid = plugin->nth_parameter (which, ok);
 212         if (!ok) {
 213                 return luaL_error (L, "Invalid Parameter");
 214         }
 215         if (!plugin->parameter_is_input (controlid)) {
 216                 return luaL_error (L, "Given Parameter is not an input");
 217         }
 218
 219         ParameterDescriptor pd;
 220         if (plugin->get_parameter_descriptor (controlid, pd) != 0) {
 221                 return luaL_error (L, "Cannot describe parameter");
 222         }
 223
 224         boost::shared_ptr<AutomationControl> c = pi->automation_control (Evoral::Parameter(PluginAutomation, 0, controlid));
 225
 226         luabridge::Stack<boost::shared_ptr<AutomationList> >::push (L, c->alist());
 227         luabridge::Stack<boost::shared_ptr<Evoral::ControlList> >::push (L, c->list());
 228         luabridge::Stack<ParameterDescriptor>::push (L, pd);
 229         return 3;
 230 }
 231
 232 int
 233 ARDOUR::LuaOSC::Address::send (lua_State *L)
 234 {
 235         Address * const luaosc = luabridge::Userdata::get <Address> (L, 1, false);
 236         if (!luaosc) {
 237                 return luaL_error (L, "Invalid pointer to OSC.Address");
 238         }
 239         if (!luaosc->_addr) {
 240                 return luaL_error (L, "Invalid Destination Address");
 241         }
 242
 243         int top = lua_gettop(L);
 244         if (top < 3) {
 245     return luaL_argerror (L, 1, "invalid number of arguments, :send (path, type, ...)");
 246         }
 247
 248         const char* path = luaL_checkstring (L, 2);
 249         const char* type = luaL_checkstring (L, 3);
 250         assert (path && type);
 251
 252         if ((int) strlen(type) != top - 3) {
 253     return luaL_argerror (L, 3, "type description does not match arguments");
 254         }
 255
 256         lo_message msg = lo_message_new ();
 257
 258         for (int i = 4; i <= top; ++i) {
 259                 char t = type[i - 4];
 260                 int lt = lua_type(L, i);
 261                 int ok = -1;
 262                 switch(lt) {
 263                         case LUA_TSTRING:
 264                                 if (t == LO_STRING) {
 265                                         ok = lo_message_add_string (msg, luaL_checkstring(L, i));
 266                                 } else if (t ==  LO_CHAR) {
 267                                         char c = luaL_checkstring (L, i) [0];
 268                                         ok = lo_message_add_char (msg, c);
 269                                 }
 270                                 break;
 271                         case LUA_TBOOLEAN:
 272                                 if (t == LO_TRUE || t == LO_FALSE) {
 273                                         if (lua_toboolean (L, i)) {
 274                                                 ok = lo_message_add_true (msg);
 275                                         } else {
 276                                                 ok = lo_message_add_false (msg);
 277                                         }
 278                                 }
 279                                 break;
 280                         case LUA_TNUMBER:
 281                                 if (t == LO_INT32) {
 282                                         ok = lo_message_add_int32 (msg, (int32_t) luaL_checkinteger(L, i));
 283                                 }
 284                                 else if (t == LO_FLOAT) {
 285                                         ok = lo_message_add_float (msg, (float) luaL_checknumber(L, i));
 286                                 }
 287                                 else if (t == LO_DOUBLE) {
 288                                         ok = lo_message_add_double (msg, (double) luaL_checknumber(L, i));
 289                                 }
 290                                 else if (t == LO_INT64) {
 291                                         ok = lo_message_add_double (msg, (int64_t) luaL_checknumber(L, i));
 292                                 }
 293                                 break;
 294                         default:
 295                                 break;
 296                 }
 297                 if (ok != 0) {
 298                         return luaL_argerror (L, i, "type description does not match parameter");
 299                 }
 300         }
 301
 302         int rv = lo_send_message (luaosc->_addr, path, msg);
 303         lo_message_free (msg);
 304         luabridge::Stack<bool>::push (L, (rv == 0));
 305         return 1;
 306 }
 307
 308 static double hue2rgb (const double p, const double q, double t) {
 309         if (t < 0.0) t += 1.0;
 310         if (t > 1.0) t -= 1.0;
 311         if (t < 1.0 / 6.0) return p + (q - p) * 6.0 * t;
 312         if (t < 1.0 / 2.0) return q;
 313         if (t < 2.0 / 3.0) return p + (q - p) * (2.0 / 3.0 - t) * 6.0;
 314         return p;
 315 }
 316
 317 int
 318 ARDOUR::LuaAPI::hsla_to_rgba (lua_State *L)
 319 {
 320         int top = lua_gettop(L);
 321         if (top < 3) {
 322                 return luaL_argerror (L, 1, "invalid number of arguments, :hsla_to_rgba (h, s, l [,a])");
 323         }
 324         double h = luabridge::Stack<double>::get (L, 1);
 325         double s = luabridge::Stack<double>::get (L, 2);
 326         double l = luabridge::Stack<double>::get (L, 3);
 327         double a = 1.0;
 328         if (top > 3) {
 329                 a = luabridge::Stack<double>::get (L, 4);
 330         }
 331
 332         // we can't use ArdourCanvas::hsva_to_color here
 333         // besides we want HSL not HSV and without intermediate
 334         // color_to_rgba (rgba_to_color ())
 335         double r,g,b;
 336         const double cq = l < 0.5 ? l * (1 + s) : l + s - l * s;
 337         const double cp = 2.f * l - cq;
 338         r = hue2rgb (cp, cq, h + 1.0 / 3.0);
 339         g = hue2rgb (cp, cq, h);
 340         b = hue2rgb (cp, cq, h - 1.0 / 3.0);
 341
 342         luabridge::Stack<double>::push (L, r);
 343         luabridge::Stack<double>::push (L, g);
 344         luabridge::Stack<double>::push (L, b);
 345         luabridge::Stack<double>::push (L, a);
 346         return 4;
 347 }
 348
 349 int
 350 ARDOUR::LuaAPI::build_filename (lua_State *L)
 351 {
 352         std::vector<std::string> elem;
 353         int top = lua_gettop(L);
 354         if (top < 1) {
 355     return luaL_argerror (L, 1, "invalid number of arguments, build_filename (path, ...)");
 356         }
 357         for (int i = 1; i <= top; ++i) {
 358                 int lt = lua_type (L, i);
 359                 if (lt != LUA_TSTRING) {
 360                         return luaL_argerror (L, i, "invalid argument type, expected string");
 361                 }
 362                 elem.push_back (luaL_checkstring(L, i));
 363         }
 364
 365         luabridge::Stack<std::string>::push (L, Glib::build_filename (elem));
 366         return 1;
 367 }
 368
 369 luabridge::LuaRef::Proxy&
 370 luabridge::LuaRef::Proxy::clone_instance (const void* classkey, void* p) {
 371   lua_rawgeti (m_L, LUA_REGISTRYINDEX, m_tableRef);
 372   lua_rawgeti (m_L, LUA_REGISTRYINDEX, m_keyRef);
 373
 374         luabridge::UserdataPtr::push_raw (m_L, p, classkey);
 375
 376   lua_rawset (m_L, -3);
 377   lua_pop (m_L, 1);
 378   return *this;
 379 }
 380
 381 LuaTableRef::LuaTableRef () {}
 382 LuaTableRef::~LuaTableRef () {}
 383
 384 int
 385 LuaTableRef::get (lua_State* L)
 386 {
 387         luabridge::LuaRef rv (luabridge::newTable (L));
 388         for (std::vector<LuaTableEntry>::const_iterator i = _data.begin (); i != _data.end (); ++i) {
 389                 switch ((*i).keytype) {
 390                         case LUA_TSTRING:
 391                                 assign(&rv, i->k_s, *i);
 392                                 break;
 393                         case LUA_TNUMBER:
 394                                 assign(&rv, i->k_n, *i);
 395                                 break;
 396                 }
 397         }
 398         luabridge::push (L, rv);
 399         return 1;
 400 }
 401
 402 int
 403 LuaTableRef::set (lua_State* L)
 404 {
 405         if (!lua_istable (L, -1)) { return luaL_error (L, "argument is not a table"); }
 406         _data.clear ();
 407
 408         lua_pushvalue (L, -1);
 409         lua_pushnil (L);
 410         while (lua_next (L, -2)) {
 411                 lua_pushvalue (L, -2);
 412
 413                 LuaTableEntry s (lua_type(L, -1), lua_type(L, -2));
 414                 switch (lua_type(L, -1)) {
 415                         case LUA_TSTRING:
 416                                 s.k_s = luabridge::Stack<std::string>::get (L, -1);
 417                                 break;
 418                                 ;
 419                         case LUA_TNUMBER:
 420                                 s.k_n = luabridge::Stack<unsigned int>::get (L, -1);
 421                                 break;
 422                         default:
 423                                 // invalid key
 424                                 lua_pop (L, 2);
 425                                 continue;
 426                 }
 427
 428                 switch(lua_type(L, -2)) {
 429                         case LUA_TSTRING:
 430                                 s.s = luabridge::Stack<std::string>::get (L, -2);
 431                                 break;
 432                         case LUA_TBOOLEAN:
 433                                 s.b = lua_toboolean (L, -2);
 434                                 break;
 435                         case LUA_TNUMBER:
 436                                 s.n = lua_tonumber (L, -2);
 437                                 break;
 438                         case LUA_TUSERDATA:
 439                                 {
 440                                         bool ok = false;
 441                                         lua_getmetatable (L, -2);
 442                                         lua_rawgetp (L, -1, luabridge::getIdentityKey ());
 443                                         if (lua_isboolean (L, -1)) {
 444                                                 lua_pop (L, 1);
 445                                                 const void* key = lua_topointer (L, -1);
 446                                                 lua_pop (L, 1);
 447                                                 void const* classkey = findclasskey (L, key);
 448
 449                                                 if (classkey) {
 450                                                         ok = true;
 451                                                         s.c = classkey;
 452                                                         s.p = luabridge::Userdata::get_ptr (L, -2);
 453                                                 }
 454                                         }  else {
 455                                                 lua_pop (L, 2);
 456                                         }
 457
 458                                         if (ok) {
 459                                                 break;
 460                                         }
 461                                         // invalid userdata -- fall through
 462                                 }
 463                                 // no break
 464                         case LUA_TFUNCTION: // no support -- we could... string.format("%q", string.dump(value, true))
 465                         case LUA_TTABLE: // no nested tables, sorry.
 466                         case LUA_TNIL: // fallthrough
 467                         default:
 468                                 // invalid value
 469                                 lua_pop (L, 2);
 470                                 continue;
 471                 }
 472
 473                 _data.push_back(s);
 474                 lua_pop (L, 2);
 475         }
 476         return 0;
 477 }
 478
 479 void*
 480 LuaTableRef::findclasskey (lua_State *L, const void* key)
 481 {
 482         lua_pushvalue(L, LUA_REGISTRYINDEX);
 483         lua_pushnil (L);
 484         while (lua_next (L, -2)) {
 485                 lua_pushvalue (L, -2);
 486                 if (lua_topointer(L, -2) == key) {
 487                         void* rv = lua_touserdata (L, -1);
 488                         lua_pop (L, 4);
 489                         return rv;
 490                 }
 491                 lua_pop (L, 2);
 492         }
 493         lua_pop (L, 1);
 494         return NULL;
 495 }
 496
 497 template<typename T>
 498 void LuaTableRef::assign (luabridge::LuaRef* rv, T key, const LuaTableEntry& s)
 499 {
 500         switch (s.valuetype) {
 501                 case LUA_TSTRING:
 502                         (*rv)[key] = s.s;
 503                         break;
 504                 case LUA_TBOOLEAN:
 505                         (*rv)[key] = s.b;
 506                         break;
 507                 case LUA_TNUMBER:
 508                         (*rv)[key] = s.n;
 509                         break;
 510                 case LUA_TUSERDATA:
 511                         (*rv)[key].clone_instance (s.c, s.p);
 512                         break;
 513                 default:
 514                         assert (0);
 515                         break;
 516         }
 517 }