gtk2_ardour/luainstance.cc

   1 /*
   2  * Copyright (C) 2016-2019 Paul Davis <paul@linuxaudiosystems.com>
   3  * Copyright (C) 2016-2019 Robin Gareus <robin@gareus.org>
   4  * Copyright (C) 2016 Tim Mayberry <mojofunk@gmail.com>
   5  * Copyright (C) 2017-2018 Ben Loftis <ben@harrisonconsoles.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #include <cairomm/context.h>
  23 #include <cairomm/surface.h>
  24 #include <pango/pangocairo.h>
  25
  26 #include "pbd/file_utils.h"
  27 #include "pbd/strsplit.h"
  28
  29 #include "gtkmm2ext/bindings.h"
  30 #include "gtkmm2ext/gui_thread.h"
  31
  32 #include "ardour/audioengine.h"
  33 #include "ardour/disk_reader.h"
  34 #include "ardour/disk_writer.h"
  35 #include "ardour/filesystem_paths.h"
  36 #include "ardour/plugin_manager.h"
  37 #include "ardour/route.h"
  38 #include "ardour/session.h"
  39 #include "ardour/system_exec.h"
  40
  41 #include "LuaBridge/LuaBridge.h"
  42
  43 #include "ardour_http.h"
  44 #include "ardour_ui.h"
  45 #include "public_editor.h"
  46 #include "region_selection.h"
  47 #include "luadialog.h"
  48 #include "luainstance.h"
  49 #include "luasignal.h"
  50 #include "marker.h"
  51 #include "mixer_ui.h"
  52 #include "region_view.h"
  53 #include "processor_box.h"
  54 #include "time_axis_view.h"
  55 #include "time_axis_view_item.h"
  56 #include "selection.h"
  57 #include "script_selector.h"
  58 #include "timers.h"
  59 #include "utils_videotl.h"
  60
  61 #include "pbd/i18n.h"
  62
  63 static const char* ui_scripts_file_name = "ui_scripts";
  64
  65 namespace LuaCairo {
  66 /** wrap RefPtr< Cairo::ImageSurface >
  67  *
  68  * Image surfaces provide the ability to render to memory buffers either
  69  * allocated by cairo or by the calling code. The supported image formats are
  70  * those defined in Cairo::Format.
  71  */
  72 class ImageSurface {
  73         public:
  74                 /**
  75                  * Creates an image surface of the specified format and dimensions. Initially
  76                  * the surface contents are all 0. (Specifically, within each pixel, each
  77                  * color or alpha channel belonging to format will be 0. The contents of bits
  78                  * within a pixel, but not belonging to the given format are undefined).
  79                  *
  80                  * @param format  format of pixels in the surface to create
  81                  * @param width   width of the surface, in pixels
  82                  * @param height  height of the surface, in pixels
  83                  */
  84                 ImageSurface (Cairo::Format format, int width, int height)
  85                         : _surface (Cairo::ImageSurface::create (format, width, height))
  86                         , _ctx (Cairo::Context::create (_surface))
  87                         , ctx (_ctx->cobj ()) {}
  88
  89                 ~ImageSurface () {}
  90
  91                 /**
  92                  * Set this surface as source for another context.
  93                  * This allows to draw this surface
  94                  */
  95                 void set_as_source (Cairo::Context* c, int x, int y) {
  96                         _surface->flush ();
  97                         c->set_source (_surface, x, y);
  98                 }
  99
 100                 /**
 101                  * Returns a context object to perform operations on the surface
 102                  */
 103                 Cairo::Context* context () {
 104                         return (Cairo::Context *)&ctx;
 105                 }
 106
 107                 /**
 108                  * Returns the stride of the image surface in bytes (or 0 if surface is not
 109                  * an image surface). The stride is the distance in bytes from the beginning
 110                  * of one row of the image data to the beginning of the next row.
 111                  */
 112                 int get_stride () const {
 113                         return _surface->get_stride ();
 114                 }
 115
 116                 /** Gets the width of the ImageSurface in pixels */
 117                 int get_width () const {
 118                         return _surface->get_width ();
 119                 }
 120
 121                 /** Gets the height of the ImageSurface in pixels */
 122                 int get_height () const {
 123                         return _surface->get_height ();
 124                 }
 125
 126                 /**
 127                  * Get a pointer to the data of the image surface, for direct
 128                  * inspection or modification.
 129                  *
 130                  * Return value: a pointer to the image data of this surface or NULL
 131                  * if @surface is not an image surface.
 132                  *
 133                  */
 134                 unsigned char* get_data () {
 135                         return _surface->get_data ();
 136                 }
 137
 138                 /** Tells cairo to consider the data buffer dirty.
 139                  *
 140                  * In particular, if you've created an ImageSurface with a data buffer that
 141                  * you've allocated yourself and you draw to that data buffer using means
 142                  * other than cairo, you must call mark_dirty() before doing any additional
 143                  * drawing to that surface with cairo.
 144                  *
 145                  * Note that if you do draw to the Surface outside of cairo, you must call
 146                  * flush() before doing the drawing.
 147                  */
 148                 void mark_dirty () {
 149                         _surface->mark_dirty ();
 150                 }
 151
 152                 /** Marks a rectangular area of the given surface dirty.
 153                  *
 154                  * @param x X coordinate of dirty rectangle
 155                  * @param y Y coordinate of dirty rectangle
 156                  * @param width width of dirty rectangle
 157                  * @param height height of dirty rectangle
 158                  */
 159                 void mark_dirty (int x, int y, int width, int height) {
 160                         _surface->mark_dirty (x, y, width, height);
 161                 }
 162
 163         private:
 164                 Cairo::RefPtr<Cairo::ImageSurface> _surface;
 165                 Cairo::RefPtr<Cairo::Context> _ctx;
 166                 Cairo::Context ctx;
 167 };
 168
 169 class PangoLayout {
 170         public:
 171                 /** Create a new PangoLayout Text Display
 172                  * @param c CairoContext for the layout
 173                  * @param font_name a font-description e.g. "Mono 8px"
 174                  */
 175                 PangoLayout (Cairo::Context* c, std::string font_name) {
 176                         ::PangoLayout* pl = pango_cairo_create_layout (c->cobj ());
 177                         _layout = Glib::wrap (pl);
 178                         Pango::FontDescription fd (font_name);
 179                         _layout->set_font_description (fd);
 180                 }
 181
 182                 ~PangoLayout () {}
 183
 184                 /** Gets the text in the layout. The returned text should not
 185                  * be freed or modified.
 186                  *
 187                  * @return The text in the @a layout.
 188                  */
 189                 std::string get_text () const {
 190                         return _layout->get_text ();
 191                 }
 192                 /** Set the text of the layout.
 193                  * @param text The text for the layout.
 194                  */
 195                 void set_text (const std::string& text) {
 196                         _layout->set_text (text);
 197                 }
 198
 199                 /** Sets the layout text and attribute list from marked-up text (see markup format).
 200                  * Replaces the current text and attribute list.
 201                  * @param markup Some marked-up text.
 202                  */
 203                 void set_markup (const std::string& markup) {
 204                         _layout->set_markup (markup);
 205                 }
 206
 207                 /** Sets the width to which the lines of the Pango::Layout should wrap or
 208                  * ellipsized.  The default value is -1: no width set.
 209                  *
 210                  * @param width The desired width in Pango units, or -1 to indicate that no
 211                  * wrapping or ellipsization should be performed.
 212                  */
 213                 void set_width (int width) {
 214                         _layout->set_width (width * PANGO_SCALE);
 215                 }
 216
 217                 /** Gets the width to which the lines of the Pango::Layout should wrap.
 218                  *
 219                  * @return The width in Pango units, or -1 if no width set.
 220                  */
 221                 int get_width () const {
 222                         return _layout->get_width () / PANGO_SCALE;
 223                 }
 224
 225                 /** Sets the type of ellipsization being performed for @a layout.
 226                  * Depending on the ellipsization mode @a ellipsize text is
 227                  * removed from the start, middle, or end of text so they
 228                  * fit within the width and height of layout set with
 229                  * set_width() and set_height().
 230                  *
 231                  * If the layout contains characters such as newlines that
 232                  * force it to be layed out in multiple paragraphs, then whether
 233                  * each paragraph is ellipsized separately or the entire layout
 234                  * is ellipsized as a whole depends on the set height of the layout.
 235                  * See set_height() for details.
 236                  *
 237                  * @param ellipsize The new ellipsization mode for @a layout.
 238                  */
 239                 void set_ellipsize (Pango::EllipsizeMode ellipsize) {
 240                         _layout->set_ellipsize (ellipsize);
 241                 }
 242
 243                 /** Gets the type of ellipsization being performed for @a layout.
 244                  * See set_ellipsize()
 245                  *
 246                  * @return The current ellipsization mode for @a layout.
 247                  *
 248                  * Use is_ellipsized() to query whether any paragraphs
 249                  * were actually ellipsized.
 250                  */
 251                 Pango::EllipsizeMode get_ellipsize () const {
 252                         return _layout->get_ellipsize ();
 253                 }
 254
 255                 /** Queries whether the layout had to ellipsize any paragraphs.
 256                  *
 257                  * This returns <tt>true</tt> if the ellipsization mode for @a layout
 258                  * is not Pango::ELLIPSIZE_NONE, a positive width is set on @a layout,
 259                  * and there are paragraphs exceeding that width that have to be
 260                  * ellipsized.
 261                  *
 262                  * @return <tt>true</tt> if any paragraphs had to be ellipsized, <tt>false</tt>
 263                  * otherwise.
 264                  */
 265                 bool is_ellipsized () const {
 266                         return _layout->is_ellipsized ();
 267                 }
 268
 269                 /** Sets the alignment for the layout: how partial lines are
 270                  * positioned within the horizontal space available.
 271                  * @param alignment The alignment.
 272                  */
 273                 void set_alignment(Pango::Alignment alignment) {
 274                         _layout->set_alignment (alignment);
 275                 }
 276
 277                 /** Gets the alignment for the layout: how partial lines are
 278                  * positioned within the horizontal space available.
 279                  * @return The alignment.
 280                  */
 281                 Pango::Alignment get_alignment() const {
 282                         return _layout->get_alignment ();
 283                 }
 284
 285                 /** Sets the wrap mode; the wrap mode only has effect if a width
 286                  * is set on the layout with set_width().
 287                  * To turn off wrapping, set the width to -1.
 288                  *
 289                  * @param wrap The wrap mode.
 290                  */
 291                 void set_wrap (Pango::WrapMode wrap) {
 292                         _layout->set_width (wrap);
 293                 }
 294
 295                 /** Gets the wrap mode for the layout.
 296                  *
 297                  * Use is_wrapped() to query whether any paragraphs
 298                  * were actually wrapped.
 299                  *
 300                  * @return Active wrap mode.
 301                  */
 302                 Pango::WrapMode get_wrap () const {
 303                         return _layout->get_wrap ();
 304                 }
 305
 306                 /** Queries whether the layout had to wrap any paragraphs.
 307                  *
 308                  * This returns <tt>true</tt> if a positive width is set on @a layout,
 309                  * ellipsization mode of @a layout is set to Pango::ELLIPSIZE_NONE,
 310                  * and there are paragraphs exceeding the layout width that have
 311                  * to be wrapped.
 312                  *
 313                  * @return <tt>true</tt> if any paragraphs had to be wrapped, <tt>false</tt>
 314                  * otherwise.
 315                  */
 316                 bool is_wrapped () const {
 317                         return _layout->is_wrapped ();
 318                 }
 319
 320                 /** Determines the logical width and height of a Pango::Layout
 321                  * in device units.
 322                  */
 323                 int get_pixel_size (lua_State *L) {
 324                         int width, height;
 325                         _layout->get_pixel_size (width, height);
 326                         luabridge::Stack<int>::push (L, width);
 327                         luabridge::Stack<int>::push (L, height);
 328                         return 2;
 329                 }
 330
 331                 /** Draws a Layout in the specified Cairo @a context. The top-left
 332                  *  corner of the Layout will be drawn at the current point of the
 333                  *  cairo context.
 334                  *
 335                  * @param context A Cairo context.
 336                  */
 337                 void show_in_cairo_context (Cairo::Context* c) {
 338                         pango_cairo_update_layout (c->cobj (), _layout->gobj());
 339                         pango_cairo_show_layout (c->cobj (), _layout->gobj());
 340                 }
 341
 342                 void layout_cairo_path (Cairo::Context* c) {
 343                         pango_cairo_update_layout (c->cobj (), _layout->gobj());
 344                         pango_cairo_layout_path (c->cobj (), _layout->gobj());
 345                 }
 346
 347         private:
 348                 Glib::RefPtr<Pango::Layout> _layout;
 349 };
 350
 351 }; // namespace
 352
 353 ////////////////////////////////////////////////////////////////////////////////
 354
 355 namespace LuaSignal {
 356
 357 #define STATIC(name,c,p) else if (!strcmp(type, #name)) {return name;}
 358 #define SESSION(name,c,p) else if (!strcmp(type, #name)) {return name;}
 359 #define ENGINE(name,c,p) else if (!strcmp(type, #name)) {return name;}
 360
 361 LuaSignal
 362 str2luasignal (const std::string &str) {
 363         const char* type = str.c_str();
 364         if (0) { }
 365 #       include "luasignal_syms.h"
 366         else {
 367                 PBD::fatal << string_compose (_("programming error: %1: %2"), "Impossible LuaSignal type", str) << endmsg;
 368                 abort(); /*NOTREACHED*/
 369         }
 370 }
 371 #undef STATIC
 372 #undef SESSION
 373 #undef ENGINE
 374
 375 #define STATIC(name,c,p) N_(#name),
 376 #define SESSION(name,c,p) N_(#name),
 377 #define ENGINE(name,c,p) N_(#name),
 378 const char *luasignalstr[] = {
 379 #       include "luasignal_syms.h"
 380         0
 381 };
 382
 383 #undef STATIC
 384 #undef SESSION
 385 #undef ENGINE
 386 }; // namespace
 387
 388
 389 static std::string http_get_unlogged (const std::string& url) { return ArdourCurl::http_get (url, false); }
 390
 391 /** special cases for Ardour's Mixer UI */
 392 namespace LuaMixer {
 393
 394         ProcessorBox::ProcSelection
 395         processor_selection () {
 396                 return ProcessorBox::current_processor_selection ();
 397         }
 398
 399 };
 400
 401 static void mixer_screenshot (const std::string& fn) {
 402         Mixer_UI::instance()->screenshot (fn);
 403 }
 404
 405 ////////////////////////////////////////////////////////////////////////////////
 406
 407 static PBD::ScopedConnectionList _luaexecs;
 408
 409 static void reaper (ARDOUR::SystemExec* x)
 410 {
 411         delete x;
 412 }
 413
 414 static int
 415 lua_forkexec (lua_State *L)
 416 {
 417         int argc = lua_gettop (L);
 418         if (argc == 0) {
 419                 return luaL_argerror (L, 1, "invalid number of arguments, forkexec (command, ...)");
 420         }
 421         // args are free()ed in ~SystemExec
 422         char** args = (char**) malloc ((argc + 1) * sizeof(char*));
 423         for (int i = 0; i < argc; ++i) {
 424                 args[i] = strdup (luaL_checkstring (L, i + 1));
 425         }
 426         args[argc] = 0;
 427
 428         ARDOUR::SystemExec* x = new ARDOUR::SystemExec (args[0], args);
 429         x->Terminated.connect (_luaexecs, MISSING_INVALIDATOR, boost::bind (&reaper, x), gui_context());
 430
 431         if (x->start()) {
 432                 reaper (x);
 433                 luabridge::Stack<bool>::push (L, false);
 434                 return -1;
 435         } else {
 436                 luabridge::Stack<bool>::push (L, false);
 437         }
 438         return 1;
 439 }
 440
 441 #ifndef PLATFORM_WINDOWS
 442 static int
 443 lua_exec (std::string cmd)
 444 {
 445         // args are free()ed in ~SystemExec
 446         char** args = (char**) malloc (4 * sizeof(char*));
 447         args[0] = strdup ("/bin/sh");
 448         args[1] = strdup ("-c");
 449         args[2] = strdup (cmd.c_str());
 450         args[3] = 0;
 451         ARDOUR::SystemExec x ("/bin/sh", args);
 452         if (x.start()) {
 453                 return -1;
 454         }
 455         x.wait ();
 456         return 0;
 457 }
 458 #endif
 459
 460 ////////////////////////////////////////////////////////////////////////////////
 461
 462 static int
 463 lua_actionlist (lua_State *L)
 464 {
 465         using namespace std;
 466
 467         vector<string> paths;
 468         vector<string> labels;
 469         vector<string> tooltips;
 470         vector<string> keys;
 471         vector<Glib::RefPtr<Gtk::Action> > actions;
 472         ActionManager::get_all_actions (paths, labels, tooltips, keys, actions);
 473
 474         vector<string>::iterator p;
 475         vector<string>::iterator l;
 476
 477         luabridge::LuaRef action_tbl (luabridge::newTable (L));
 478
 479         for (l = labels.begin(), p = paths.begin(); l != labels.end(); ++p, ++l) {
 480                 if (l->empty ()) {
 481                         continue;
 482                 }
 483
 484                 vector<string> parts;
 485                 split (*p, parts, '/');
 486
 487                 if (parts.empty()) {
 488                         continue;
 489                 }
 490
 491                 //kinda kludgy way to avoid displaying menu items as mappable
 492                 if (parts[1] == _("Main_menu"))
 493                         continue;
 494                 if (parts[1] == _("JACK"))
 495                         continue;
 496                 if (parts[1] == _("redirectmenu"))
 497                         continue;
 498                 if (parts[1] == _("RegionList"))
 499                         continue;
 500                 if (parts[1] == _("ProcessorMenu"))
 501                         continue;
 502
 503                 if (!action_tbl[parts[1]].isTable()) {
 504                         action_tbl[parts[1]] = luabridge::newTable (L);
 505                 }
 506                 assert (action_tbl[parts[1]].isTable());
 507                 luabridge::LuaRef tbl (action_tbl[parts[1]]);
 508                 assert (tbl.isTable());
 509                 tbl[*l] = *p;
 510         }
 511
 512         luabridge::push (L, action_tbl);
 513         return 1;
 514 }
 515
 516 ////////////////////////////////////////////////////////////////////////////////
 517
 518 // ARDOUR_UI and instance() are not exposed.
 519 ARDOUR::PresentationInfo::order_t
 520 lua_translate_order (RouteDialogs::InsertAt place)
 521 {
 522         return ARDOUR_UI::instance()->translate_order (place);
 523 }
 524
 525 ////////////////////////////////////////////////////////////////////////////////
 526
 527 #define xstr(s) stringify(s)
 528 #define stringify(s) #s
 529
 530 using namespace ARDOUR;
 531
 532 PBD::Signal0<void> LuaInstance::LuaTimerS;
 533 PBD::Signal0<void> LuaInstance::LuaTimerDS;
 534 PBD::Signal0<void> LuaInstance::SetSession;
 535
 536 void
 537 LuaInstance::register_hooks (lua_State* L)
 538 {
 539
 540 #define ENGINE(name,c,p) .addConst (stringify(name), (LuaSignal::LuaSignal)LuaSignal::name)
 541 #define STATIC(name,c,p) .addConst (stringify(name), (LuaSignal::LuaSignal)LuaSignal::name)
 542 #define SESSION(name,c,p) .addConst (stringify(name), (LuaSignal::LuaSignal)LuaSignal::name)
 543         luabridge::getGlobalNamespace (L)
 544                 .beginNamespace ("LuaSignal")
 545 #               include "luasignal_syms.h"
 546                 .endNamespace ();
 547 #undef ENGINE
 548 #undef SESSION
 549 #undef STATIC
 550
 551         luabridge::getGlobalNamespace (L)
 552                 .beginNamespace ("LuaSignal")
 553                 .beginStdBitSet <LuaSignal::LAST_SIGNAL> ("Set")
 554                 .endClass()
 555                 .endNamespace ();
 556
 557 #if 0 // Dump size -> libs/ardour/luabindings.cc
 558         printf ("LuaInstance: registered %d signals\n", LuaSignal::LAST_SIGNAL);
 559 #endif
 560 }
 561
 562 void
 563 LuaInstance::bind_cairo (lua_State* L)
 564 {
 565         /* std::vector<double> for set_dash()
 566          * for Windows (DLL, .exe) this needs to be bound in the same memory context as "Cairo".
 567          *
 568          * The std::vector<> argument in set_dash() has a fixed address in ardour.exe, while
 569          * the address of the one in libardour.dll is mapped when loading the .dll
 570          *
 571          * see LuaBindings::set_session() for a detailed explanation
 572          */
 573         luabridge::getGlobalNamespace (L)
 574                 .beginNamespace ("C")
 575                 .beginStdVector <double> ("DoubleVector")
 576                 .endClass ()
 577                 .endNamespace ();
 578
 579         luabridge::getGlobalNamespace (L)
 580                 .beginNamespace ("Cairo")
 581                 .beginClass <Cairo::Context> ("Context")
 582                 .addFunction ("save", &Cairo::Context::save)
 583                 .addFunction ("restore", &Cairo::Context::restore)
 584                 .addFunction ("set_operator", &Cairo::Context::set_operator)
 585                 //.addFunction ("set_source", &Cairo::Context::set_operator) // needs RefPtr
 586                 .addFunction ("set_source_rgb", &Cairo::Context::set_source_rgb)
 587                 .addFunction ("set_source_rgba", &Cairo::Context::set_source_rgba)
 588                 .addFunction ("set_line_width", &Cairo::Context::set_line_width)
 589                 .addFunction ("set_line_cap", &Cairo::Context::set_line_cap)
 590                 .addFunction ("set_line_join", &Cairo::Context::set_line_join)
 591                 .addFunction ("set_dash", (void (Cairo::Context::*)(const std::vector<double>&, double))&Cairo::Context::set_dash)
 592                 .addFunction ("unset_dash", &Cairo::Context::unset_dash)
 593                 .addFunction ("translate", &Cairo::Context::translate)
 594                 .addFunction ("scale", &Cairo::Context::scale)
 595                 .addFunction ("rotate", &Cairo::Context::rotate)
 596                 .addFunction ("begin_new_path", &Cairo::Context::begin_new_path)
 597                 .addFunction ("begin_new_sub_path", &Cairo::Context::begin_new_sub_path)
 598                 .addFunction ("move_to", &Cairo::Context::move_to)
 599                 .addFunction ("line_to", &Cairo::Context::line_to)
 600                 .addFunction ("curve_to", &Cairo::Context::curve_to)
 601                 .addFunction ("arc", &Cairo::Context::arc)
 602                 .addFunction ("arc_negative", &Cairo::Context::arc_negative)
 603                 .addFunction ("rel_move_to", &Cairo::Context::rel_move_to)
 604                 .addFunction ("rel_line_to", &Cairo::Context::rel_line_to)
 605                 .addFunction ("rel_curve_to", &Cairo::Context::rel_curve_to)
 606                 .addFunction ("rectangle", (void (Cairo::Context::*)(double, double, double, double))&Cairo::Context::rectangle)
 607                 .addFunction ("close_path", &Cairo::Context::close_path)
 608                 .addFunction ("paint", &Cairo::Context::paint)
 609                 .addFunction ("paint_with_alpha", &Cairo::Context::paint_with_alpha)
 610                 .addFunction ("stroke", &Cairo::Context::stroke)
 611                 .addFunction ("stroke_preserve", &Cairo::Context::stroke_preserve)
 612                 .addFunction ("fill", &Cairo::Context::fill)
 613                 .addFunction ("fill_preserve", &Cairo::Context::fill_preserve)
 614                 .addFunction ("reset_clip", &Cairo::Context::reset_clip)
 615                 .addFunction ("clip", &Cairo::Context::clip)
 616                 .addFunction ("clip_preserve", &Cairo::Context::clip_preserve)
 617                 .addFunction ("set_font_size", &Cairo::Context::set_font_size)
 618                 .addFunction ("show_text", &Cairo::Context::show_text)
 619                 .endClass ()
 620                 /* enums */
 621                 // LineCap, LineJoin, Operator
 622                 .beginNamespace ("LineCap")
 623                 .addConst ("Butt", CAIRO_LINE_CAP_BUTT)
 624                 .addConst ("Round", CAIRO_LINE_CAP_ROUND)
 625                 .addConst ("Square", CAIRO_LINE_CAP_SQUARE)
 626                 .endNamespace ()
 627
 628                 .beginNamespace ("LineJoin")
 629                 .addConst ("Miter", CAIRO_LINE_JOIN_MITER)
 630                 .addConst ("Round", CAIRO_LINE_JOIN_ROUND)
 631                 .addConst ("Bevel", CAIRO_LINE_JOIN_BEVEL)
 632                 .endNamespace ()
 633
 634                 .beginNamespace ("Operator")
 635                 .addConst ("Clear", CAIRO_OPERATOR_CLEAR)
 636                 .addConst ("Source", CAIRO_OPERATOR_SOURCE)
 637                 .addConst ("Over", CAIRO_OPERATOR_OVER)
 638                 .addConst ("Add", CAIRO_OPERATOR_ADD)
 639                 .endNamespace ()
 640
 641                 .beginNamespace ("Format")
 642                 .addConst ("ARGB32", CAIRO_FORMAT_ARGB32)
 643                 .addConst ("RGB24", CAIRO_FORMAT_RGB24)
 644                 .endNamespace ()
 645
 646                 .beginClass <LuaCairo::ImageSurface> ("ImageSurface")
 647                 .addConstructor <void (*) (Cairo::Format, int, int)> ()
 648                 .addFunction ("set_as_source", &LuaCairo::ImageSurface::set_as_source)
 649                 .addFunction ("context", &LuaCairo::ImageSurface::context)
 650                 .addFunction ("get_stride", &LuaCairo::ImageSurface::get_stride)
 651                 .addFunction ("get_width", &LuaCairo::ImageSurface::get_width)
 652                 .addFunction ("get_height", &LuaCairo::ImageSurface::get_height)
 653                 //.addFunction ("get_data", &LuaCairo::ImageSurface::get_data) // uint8_t* array is n/a
 654                 .endClass ()
 655
 656                 .beginClass <LuaCairo::PangoLayout> ("PangoLayout")
 657                 .addConstructor <void (*) (Cairo::Context*, std::string)> ()
 658                 .addCFunction ("get_pixel_size", &LuaCairo::PangoLayout::get_pixel_size)
 659                 .addFunction ("get_text", &LuaCairo::PangoLayout::get_text)
 660                 .addFunction ("set_text", &LuaCairo::PangoLayout::set_text)
 661                 .addFunction ("show_in_cairo_context", &LuaCairo::PangoLayout::show_in_cairo_context)
 662                 .addFunction ("layout_cairo_path", &LuaCairo::PangoLayout::layout_cairo_path)
 663                 .addFunction ("set_markup", &LuaCairo::PangoLayout::set_markup)
 664                 .addFunction ("set_width", &LuaCairo::PangoLayout::set_width)
 665                 .addFunction ("set_ellipsize", &LuaCairo::PangoLayout::set_ellipsize)
 666                 .addFunction ("get_ellipsize", &LuaCairo::PangoLayout::get_ellipsize)
 667                 .addFunction ("is_ellipsized", &LuaCairo::PangoLayout::is_ellipsized)
 668                 .addFunction ("set_alignment", &LuaCairo::PangoLayout::set_alignment)
 669                 .addFunction ("get_alignment", &LuaCairo::PangoLayout::get_alignment)
 670                 .addFunction ("set_wrap", &LuaCairo::PangoLayout::set_wrap)
 671                 .addFunction ("get_wrap", &LuaCairo::PangoLayout::get_wrap)
 672                 .addFunction ("is_wrapped", &LuaCairo::PangoLayout::is_wrapped)
 673                 .endClass ()
 674
 675                 /* enums */
 676                 .beginNamespace ("EllipsizeMode")
 677                 .addConst ("None", Pango::ELLIPSIZE_NONE)
 678                 .addConst ("Start", Pango::ELLIPSIZE_START)
 679                 .addConst ("Middle", Pango::ELLIPSIZE_MIDDLE)
 680                 .addConst ("End", Pango::ELLIPSIZE_END)
 681                 .endNamespace ()
 682
 683                 .beginNamespace ("Alignment")
 684                 .addConst ("Left", Pango::ALIGN_LEFT)
 685                 .addConst ("Center", Pango::ALIGN_CENTER)
 686                 .addConst ("Right", Pango::ALIGN_RIGHT)
 687                 .endNamespace ()
 688
 689                 .beginNamespace ("WrapMode")
 690                 .addConst ("Word", Pango::WRAP_WORD)
 691                 .addConst ("Char", Pango::WRAP_CHAR)
 692                 .addConst ("WordChar", Pango::WRAP_WORD_CHAR)
 693                 .endNamespace ()
 694
 695                 .endNamespace ();
 696
 697 /* Lua/cairo bindings operate on Cairo::Context, there is no Cairo::RefPtr wrapper [yet].
 698   one can work around this as follows:
 699
 700   LuaState lua;
 701   LuaInstance::register_classes (lua.getState());
 702   lua.do_command (
 703       "function render (ctx)"
 704       "  ctx:rectangle (0, 0, 100, 100)"
 705       "  ctx:set_source_rgba (0.1, 1.0, 0.1, 1.0)"
 706       "  ctx:fill ()"
 707       " end"
 708       );
 709   {
 710                 Cairo::RefPtr<Cairo::Context> context = get_window ()->create_cairo_context ();
 711     Cairo::Context ctx (context->cobj ());
 712
 713     luabridge::LuaRef lua_render = luabridge::getGlobal (lua.getState(), "render");
 714     lua_render ((Cairo::Context *)&ctx);
 715   }
 716 */
 717
 718 }
 719
 720 void
 721 LuaInstance::bind_dialog (lua_State* L)
 722 {
 723         luabridge::getGlobalNamespace (L)
 724                 .beginNamespace ("LuaDialog")
 725
 726                 .beginClass <LuaDialog::Message> ("Message")
 727                 .addConstructor <void (*) (std::string const&, std::string const&, LuaDialog::Message::MessageType, LuaDialog::Message::ButtonType)> ()
 728                 .addFunction ("run", &LuaDialog::Message::run)
 729                 .endClass ()
 730
 731                 .beginClass <LuaDialog::Dialog> ("Dialog")
 732                 .addConstructor <void (*) (std::string const&, luabridge::LuaRef)> ()
 733                 .addCFunction ("run", &LuaDialog::Dialog::run)
 734                 .endClass ()
 735
 736                 /* enums */
 737                 .beginNamespace ("MessageType")
 738                 .addConst ("Info", LuaDialog::Message::Info)
 739                 .addConst ("Warning", LuaDialog::Message::Warning)
 740                 .addConst ("Question", LuaDialog::Message::Question)
 741                 .addConst ("Error", LuaDialog::Message::Error)
 742                 .endNamespace ()
 743
 744                 .beginNamespace ("ButtonType")
 745                 .addConst ("OK", LuaDialog::Message::OK)
 746                 .addConst ("Close", LuaDialog::Message::Close)
 747                 .addConst ("Cancel", LuaDialog::Message::Cancel)
 748                 .addConst ("Yes_No", LuaDialog::Message::Yes_No)
 749                 .addConst ("OK_Cancel", LuaDialog::Message::OK_Cancel)
 750                 .endNamespace ()
 751
 752                 .beginNamespace ("Response")
 753                 .addConst ("OK", 0)
 754                 .addConst ("Cancel", 1)
 755                 .addConst ("Close", 2)
 756                 .addConst ("Yes", 3)
 757                 .addConst ("No", 4)
 758                 .addConst ("None", -1)
 759                 .endNamespace ()
 760
 761                 .endNamespace ();
 762
 763 }
 764
 765 void
 766 LuaInstance::register_classes (lua_State* L)
 767 {
 768         LuaBindings::stddef (L);
 769         LuaBindings::common (L);
 770         LuaBindings::session (L);
 771         LuaBindings::osc (L);
 772
 773         bind_cairo (L);
 774         bind_dialog (L);
 775
 776         luabridge::getGlobalNamespace (L)
 777                 .beginNamespace ("ArdourUI")
 778
 779                 .addFunction ("http_get", &http_get_unlogged)
 780
 781                 .addFunction ("mixer_screenshot", &mixer_screenshot)
 782
 783                 .addFunction ("processor_selection", &LuaMixer::processor_selection)
 784
 785                 .beginStdCPtrList <ArdourMarker> ("ArdourMarkerList")
 786                 .endClass ()
 787
 788                 .beginClass <ArdourMarker> ("ArdourMarker")
 789                 .addFunction ("name", &ArdourMarker::name)
 790                 .addFunction ("position", &ArdourMarker::position)
 791                 .addFunction ("_type", &ArdourMarker::type)
 792                 .endClass ()
 793
 794                 .beginClass <AxisView> ("AxisView")
 795                 .endClass ()
 796
 797                 .deriveClass <TimeAxisView, AxisView> ("TimeAxisView")
 798                 .endClass ()
 799
 800                 .deriveClass <StripableTimeAxisView, TimeAxisView> ("StripableTimeAxisView")
 801                 .endClass ()
 802
 803                 .beginClass <Selectable> ("Selectable")
 804                 .endClass ()
 805
 806                 .deriveClass <TimeAxisViewItem, Selectable> ("TimeAxisViewItem")
 807                 .endClass ()
 808
 809                 .deriveClass <RegionView, TimeAxisViewItem> ("RegionView")
 810                 .endClass ()
 811
 812                 .deriveClass <RouteUI, Selectable> ("RouteUI")
 813                 .endClass ()
 814
 815                 .deriveClass <RouteTimeAxisView, RouteUI> ("RouteTimeAxisView")
 816                 .addCast<StripableTimeAxisView> ("to_stripabletimeaxisview")
 817                 .addCast<TimeAxisView> ("to_timeaxisview") // deprecated
 818                 .endClass ()
 819
 820                 // std::list<Selectable*>
 821                 .beginStdCPtrList <Selectable> ("SelectionList")
 822                 .endClass ()
 823
 824                 // std::list<TimeAxisView*>
 825                 .beginStdCPtrList <TimeAxisView> ("TrackViewStdList")
 826                 .endClass ()
 827
 828
 829                 .beginClass <RegionSelection> ("RegionSelection")
 830                 .addFunction ("start", &RegionSelection::start)
 831                 .addFunction ("end_sample", &RegionSelection::end_sample)
 832                 .addFunction ("n_midi_regions", &RegionSelection::n_midi_regions)
 833                 .addFunction ("regionlist", &RegionSelection::regionlist) // XXX check windows binding (libardour)
 834                 .endClass ()
 835
 836                 .deriveClass <TimeSelection, std::list<ARDOUR::AudioRange> > ("TimeSelection")
 837                 .addFunction ("start", &TimeSelection::start)
 838                 .addFunction ("end_sample", &TimeSelection::end_sample)
 839                 .addFunction ("length", &TimeSelection::length)
 840                 .endClass ()
 841
 842                 .deriveClass <MarkerSelection, std::list<ArdourMarker*> > ("MarkerSelection")
 843                 .endClass ()
 844
 845                 .deriveClass <TrackViewList, std::list<TimeAxisView*> > ("TrackViewList")
 846                 .addFunction ("contains", &TrackViewList::contains)
 847                 .addFunction ("routelist", &TrackViewList::routelist)
 848                 .endClass ()
 849
 850                 .deriveClass <TrackSelection, TrackViewList> ("TrackSelection")
 851                 .endClass ()
 852
 853                 .beginClass <Selection> ("Selection")
 854                 .addFunction ("clear", &Selection::clear)
 855                 .addFunction ("clear_all", &Selection::clear_all)
 856                 .addFunction ("empty", &Selection::empty)
 857                 .addData ("tracks", &Selection::tracks)
 858                 .addData ("regions", &Selection::regions)
 859                 .addData ("time", &Selection::time)
 860                 .addData ("markers", &Selection::markers)
 861 #if 0
 862                 .addData ("lines", &Selection::lines)
 863                 .addData ("playlists", &Selection::playlists)
 864                 .addData ("points", &Selection::points)
 865                 .addData ("midi_regions", &Selection::midi_regions)
 866                 .addData ("midi_notes", &Selection::midi_notes) // cut buffer only
 867 #endif
 868                 .endClass ()
 869
 870                 .beginClass <PublicEditor> ("Editor")
 871                 .addFunction ("grid_type", &PublicEditor::grid_type)
 872                 .addFunction ("snap_mode", &PublicEditor::snap_mode)
 873                 .addFunction ("set_snap_mode", &PublicEditor::set_snap_mode)
 874
 875                 .addFunction ("undo", &PublicEditor::undo)
 876                 .addFunction ("redo", &PublicEditor::redo)
 877
 878                 .addFunction ("set_mouse_mode", &PublicEditor::set_mouse_mode)
 879                 .addFunction ("current_mouse_mode", &PublicEditor::current_mouse_mode)
 880
 881                 .addFunction ("consider_auditioning", &PublicEditor::consider_auditioning)
 882
 883                 .addFunction ("new_region_from_selection", &PublicEditor::new_region_from_selection)
 884                 .addFunction ("separate_region_from_selection", &PublicEditor::separate_region_from_selection)
 885                 .addFunction ("pixel_to_sample", &PublicEditor::pixel_to_sample)
 886                 .addFunction ("sample_to_pixel", &PublicEditor::sample_to_pixel)
 887
 888                 .addFunction ("get_selection", &PublicEditor::get_selection)
 889                 .addFunction ("get_cut_buffer", &PublicEditor::get_cut_buffer)
 890                 .addRefFunction ("get_selection_extents", &PublicEditor::get_selection_extents)
 891
 892                 .addFunction ("set_selection", &PublicEditor::set_selection)
 893
 894                 .addFunction ("play_selection", &PublicEditor::play_selection)
 895                 .addFunction ("play_with_preroll", &PublicEditor::play_with_preroll)
 896                 .addFunction ("maybe_locate_with_edit_preroll", &PublicEditor::maybe_locate_with_edit_preroll)
 897                 .addFunction ("goto_nth_marker", &PublicEditor::goto_nth_marker)
 898
 899                 .addFunction ("add_location_from_playhead_cursor", &PublicEditor::add_location_from_playhead_cursor)
 900                 .addFunction ("remove_location_at_playhead_cursor", &PublicEditor::remove_location_at_playhead_cursor)
 901
 902                 .addFunction ("update_grid", &PublicEditor::update_grid)
 903                 .addFunction ("remove_tracks", &PublicEditor::remove_tracks)
 904
 905                 .addFunction ("set_loop_range", &PublicEditor::set_loop_range)
 906                 .addFunction ("set_punch_range", &PublicEditor::set_punch_range)
 907
 908                 .addFunction ("effective_mouse_mode", &PublicEditor::effective_mouse_mode)
 909
 910                 .addRefFunction ("do_import", &PublicEditor::do_import)
 911                 .addRefFunction ("do_embed", &PublicEditor::do_embed)
 912
 913                 .addFunction ("export_audio", &PublicEditor::export_audio)
 914                 .addFunction ("stem_export", &PublicEditor::stem_export)
 915                 .addFunction ("export_selection", &PublicEditor::export_selection)
 916                 .addFunction ("export_range", &PublicEditor::export_range)
 917
 918                 .addFunction ("set_zoom_focus", &PublicEditor::set_zoom_focus)
 919                 .addFunction ("get_zoom_focus", &PublicEditor::get_zoom_focus)
 920                 .addFunction ("get_current_zoom", &PublicEditor::get_current_zoom)
 921                 .addFunction ("reset_zoom", &PublicEditor::reset_zoom)
 922
 923                 .addFunction ("clear_playlist", &PublicEditor::clear_playlist)
 924                 .addFunction ("new_playlists", &PublicEditor::new_playlists)
 925                 .addFunction ("copy_playlists", &PublicEditor::copy_playlists)
 926                 .addFunction ("clear_playlists", &PublicEditor::clear_playlists)
 927
 928                 .addFunction ("select_all_tracks", &PublicEditor::select_all_tracks)
 929                 .addFunction ("deselect_all", &PublicEditor::deselect_all)
 930
 931 #if 0 // TimeAxisView&  can't be bound (pure virtual fn)
 932                 .addFunction ("set_selected_track", &PublicEditor::set_selected_track)
 933                 .addFunction ("set_selected_mixer_strip", &PublicEditor::set_selected_mixer_strip)
 934                 .addFunction ("ensure_time_axis_view_is_visible", &PublicEditor::ensure_time_axis_view_is_visible)
 935 #endif
 936                 .addFunction ("hide_track_in_display", &PublicEditor::hide_track_in_display)
 937                 .addFunction ("show_track_in_display", &PublicEditor::show_track_in_display)
 938                 .addFunction ("set_visible_track_count", &PublicEditor::set_visible_track_count)
 939                 .addFunction ("fit_selection", &PublicEditor::fit_selection)
 940
 941                 .addFunction ("regionview_from_region", &PublicEditor::regionview_from_region)
 942                 .addFunction ("set_stationary_playhead", &PublicEditor::set_stationary_playhead)
 943                 .addFunction ("stationary_playhead", &PublicEditor::stationary_playhead)
 944                 .addFunction ("set_follow_playhead", &PublicEditor::set_follow_playhead)
 945                 .addFunction ("follow_playhead", &PublicEditor::follow_playhead)
 946
 947                 .addFunction ("dragging_playhead", &PublicEditor::dragging_playhead)
 948                 .addFunction ("leftmost_sample", &PublicEditor::leftmost_sample)
 949                 .addFunction ("current_page_samples", &PublicEditor::current_page_samples)
 950                 .addFunction ("visible_canvas_height", &PublicEditor::visible_canvas_height)
 951                 .addFunction ("temporal_zoom_step", &PublicEditor::temporal_zoom_step)
 952                 .addFunction ("override_visible_track_count", &PublicEditor::override_visible_track_count)
 953
 954                 .addFunction ("scroll_tracks_down_line", &PublicEditor::scroll_tracks_down_line)
 955                 .addFunction ("scroll_tracks_up_line", &PublicEditor::scroll_tracks_up_line)
 956                 .addFunction ("scroll_down_one_track", &PublicEditor::scroll_down_one_track)
 957                 .addFunction ("scroll_up_one_track", &PublicEditor::scroll_up_one_track)
 958
 959                 .addFunction ("reset_x_origin", &PublicEditor::reset_x_origin)
 960                 .addFunction ("get_y_origin", &PublicEditor::get_y_origin)
 961                 .addFunction ("reset_y_origin", &PublicEditor::reset_y_origin)
 962
 963                 .addFunction ("remove_last_capture", &PublicEditor::remove_last_capture)
 964
 965                 .addFunction ("maximise_editing_space", &PublicEditor::maximise_editing_space)
 966                 .addFunction ("restore_editing_space", &PublicEditor::restore_editing_space)
 967                 .addFunction ("toggle_meter_updating", &PublicEditor::toggle_meter_updating)
 968
 969                 //.addFunction ("get_preferred_edit_position", &PublicEditor::get_preferred_edit_position)
 970                 //.addFunction ("split_regions_at", &PublicEditor::split_regions_at)
 971
 972                 .addRefFunction ("get_nudge_distance", &PublicEditor::get_nudge_distance)
 973                 .addFunction ("get_paste_offset", &PublicEditor::get_paste_offset)
 974                 .addFunction ("get_grid_beat_divisions", &PublicEditor::get_grid_beat_divisions)
 975                 .addRefFunction ("get_grid_type_as_beats", &PublicEditor::get_grid_type_as_beats)
 976
 977                 .addFunction ("toggle_ruler_video", &PublicEditor::toggle_ruler_video)
 978                 .addFunction ("toggle_xjadeo_proc", &PublicEditor::toggle_xjadeo_proc)
 979                 .addFunction ("get_videotl_bar_height", &PublicEditor::get_videotl_bar_height)
 980                 .addFunction ("set_video_timeline_height", &PublicEditor::set_video_timeline_height)
 981
 982 #if 0
 983                 .addFunction ("get_equivalent_regions", &PublicEditor::get_equivalent_regions)
 984                 .addFunction ("drags", &PublicEditor::drags)
 985 #endif
 986
 987                 .addFunction ("get_stripable_time_axis_by_id", &PublicEditor::get_stripable_time_axis_by_id)
 988                 .addFunction ("get_track_views", &PublicEditor::get_track_views)
 989                 .addFunction ("rtav_from_route", &PublicEditor::rtav_from_route)
 990                 .addFunction ("axis_views_from_routes", &PublicEditor::axis_views_from_routes)
 991
 992                 .addFunction ("center_screen", &PublicEditor::center_screen)
 993
 994                 .addFunction ("get_smart_mode", &PublicEditor::get_smart_mode)
 995                 .addRefFunction ("get_pointer_position", &PublicEditor::get_pointer_position)
 996
 997                 .addRefFunction ("find_location_from_marker", &PublicEditor::find_location_from_marker)
 998                 .addFunction ("find_marker_from_location_id", &PublicEditor::find_marker_from_location_id)
 999                 .addFunction ("mouse_add_new_marker", &PublicEditor::mouse_add_new_marker)
1000 #if 0
1001                 .addFunction ("get_regions_at", &PublicEditor::get_regions_at)
1002                 .addFunction ("get_regions_after", &PublicEditor::get_regions_after)
1003                 .addFunction ("get_regions_from_selection_and_mouse", &PublicEditor::get_regions_from_selection_and_mouse)
1004                 .addFunction ("get_regionviews_by_id", &PublicEditor::get_regionviews_by_id)
1005                 .addFunction ("get_per_region_note_selection", &PublicEditor::get_per_region_note_selection)
1006 #endif
1007
1008 #if 0
1009                 .addFunction ("mouse_add_new_tempo_event", &PublicEditor::mouse_add_new_tempo_event)
1010                 .addFunction ("mouse_add_new_meter_event", &PublicEditor::mouse_add_new_meter_event)
1011                 .addFunction ("edit_tempo_section", &PublicEditor::edit_tempo_section)
1012                 .addFunction ("edit_meter_section", &PublicEditor::edit_meter_section)
1013 #endif
1014
1015                 .addFunction ("access_action", &PublicEditor::access_action)
1016                 .addFunction ("set_toggleaction", &PublicEditor::set_toggleaction)
1017                 .endClass ()
1018
1019                 .addFunction ("translate_order", &lua_translate_order)
1020
1021                 /* ArdourUI enums */
1022                 .beginNamespace ("InsertAt")
1023                 .addConst ("BeforeSelection", RouteDialogs::InsertAt(RouteDialogs::BeforeSelection))
1024                 .addConst ("AfterSelection", RouteDialogs::InsertAt(RouteDialogs::AfterSelection))
1025                 .addConst ("First", RouteDialogs::InsertAt(RouteDialogs::First))
1026                 .addConst ("Last", RouteDialogs::InsertAt(RouteDialogs::Last))
1027                 .endNamespace ()
1028
1029                 .beginNamespace ("MarkerType")
1030                 .addConst ("Mark", ArdourMarker::Type(ArdourMarker::Mark))
1031                 .addConst ("Tempo", ArdourMarker::Type(ArdourMarker::Tempo))
1032                 .addConst ("Meter", ArdourMarker::Type(ArdourMarker::Meter))
1033                 .addConst ("SessionStart", ArdourMarker::Type(ArdourMarker::SessionStart))
1034                 .addConst ("SessionEnd", ArdourMarker::Type(ArdourMarker::SessionEnd))
1035                 .addConst ("RangeStart", ArdourMarker::Type(ArdourMarker::RangeStart))
1036                 .addConst ("RangeEnd", ArdourMarker::Type(ArdourMarker::RangeEnd))
1037                 .addConst ("LoopStart", ArdourMarker::Type(ArdourMarker::LoopStart))
1038                 .addConst ("LoopEnd", ArdourMarker::Type(ArdourMarker::LoopEnd))
1039                 .addConst ("PunchIn", ArdourMarker::Type(ArdourMarker::PunchIn))
1040                 .addConst ("PunchOut", ArdourMarker::Type(ArdourMarker::PunchOut))
1041                 .endNamespace ()
1042
1043                 .beginNamespace ("SelectionOp")
1044                 .addConst ("Toggle", Selection::Operation(Selection::Toggle))
1045                 .addConst ("Set", Selection::Operation(Selection::Set))
1046                 .addConst ("Extend", Selection::Operation(Selection::Extend))
1047                 .addConst ("Add", Selection::Operation(Selection::Add))
1048                 .endNamespace ()
1049
1050                 .addCFunction ("actionlist", &lua_actionlist)
1051
1052                 .endNamespace () // end ArdourUI
1053
1054                 .beginNamespace ("os")
1055 #ifndef PLATFORM_WINDOWS
1056                 .addFunction ("execute", &lua_exec)
1057 #endif
1058                 .addCFunction ("forkexec", &lua_forkexec)
1059                 .endNamespace ();
1060
1061         // Editing Symbols
1062
1063 #undef ZOOMFOCUS
1064 #undef GRIDTYPE
1065 #undef SNAPMODE
1066 #undef MOUSEMODE
1067 #undef DISPLAYCONTROL
1068 #undef IMPORTMODE
1069 #undef IMPORTPOSITION
1070 #undef IMPORTDISPOSITION
1071
1072 #define ZOOMFOCUS(NAME) .addConst (stringify(NAME), (Editing::ZoomFocus)Editing::NAME)
1073 #define GRIDTYPE(NAME) .addConst (stringify(NAME), (Editing::GridType)Editing::NAME)
1074 #define SNAPMODE(NAME) .addConst (stringify(NAME), (Editing::SnapMode)Editing::NAME)
1075 #define MOUSEMODE(NAME) .addConst (stringify(NAME), (Editing::MouseMode)Editing::NAME)
1076 #define DISPLAYCONTROL(NAME) .addConst (stringify(NAME), (Editing::DisplayControl)Editing::NAME)
1077 #define IMPORTMODE(NAME) .addConst (stringify(NAME), (Editing::ImportMode)Editing::NAME)
1078 #define IMPORTPOSITION(NAME) .addConst (stringify(NAME), (Editing::ImportPosition)Editing::NAME)
1079 #define IMPORTDISPOSITION(NAME) .addConst (stringify(NAME), (Editing::ImportDisposition)Editing::NAME)
1080         luabridge::getGlobalNamespace (L)
1081                 .beginNamespace ("Editing")
1082 #               include "editing_syms.h"
1083                 .endNamespace ();
1084 }
1085
1086 #undef xstr
1087 #undef stringify
1088
1089 ////////////////////////////////////////////////////////////////////////////////
1090
1091 using namespace ARDOUR;
1092 using namespace ARDOUR_UI_UTILS;
1093 using namespace PBD;
1094 using namespace std;
1095
1096 static void _lua_print (std::string s) {
1097 #ifndef NDEBUG
1098         std::cout << "LuaInstance: " << s << "\n";
1099 #endif
1100         PBD::info << "LuaInstance: " << s << endmsg;
1101 }
1102
1103 LuaInstance* LuaInstance::_instance = 0;
1104
1105 LuaInstance*
1106 LuaInstance::instance ()
1107 {
1108         if (!_instance) {
1109                 _instance  = new LuaInstance;
1110         }
1111
1112         return _instance;
1113 }
1114
1115 void
1116 LuaInstance::destroy_instance ()
1117 {
1118         delete _instance;
1119         _instance = 0;
1120 }
1121
1122 LuaInstance::LuaInstance ()
1123 {
1124         lua.Print.connect (&_lua_print);
1125         init ();
1126 }
1127
1128 LuaInstance::~LuaInstance ()
1129 {
1130         delete _lua_call_action;
1131         delete _lua_render_icon;
1132         delete _lua_add_action;
1133         delete _lua_del_action;
1134         delete _lua_get_action;
1135
1136         delete _lua_load;
1137         delete _lua_save;
1138         delete _lua_clear;
1139         _callbacks.clear();
1140 }
1141
1142 void
1143 LuaInstance::init ()
1144 {
1145         lua.sandbox (false);
1146         lua.do_command (
1147                         "function ScriptManager ()"
1148                         "  local self = { scripts = {}, instances = {}, icons = {} }"
1149                         ""
1150                         "  local remove = function (id)"
1151                         "   self.scripts[id] = nil"
1152                         "   self.instances[id] = nil"
1153                         "   self.icons[id] = nil"
1154                         "  end"
1155                         ""
1156                         "  local addinternal = function (i, n, s, f, c, a)"
1157                         "   assert(type(i) == 'number', 'id must be numeric')"
1158                         "   assert(type(n) == 'string', 'Name must be string')"
1159                         "   assert(type(s) == 'string', 'Script must be string')"
1160                         "   assert(type(f) == 'function', 'Factory is a not a function')"
1161                         "   assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
1162                         "   self.scripts[i] = { ['n'] = n, ['s'] = s, ['f'] = f, ['a'] = a, ['c'] = c }"
1163                         "   local env = _ENV; env.f = nil"
1164                         "   self.instances[i] = load (string.dump(f, true), nil, nil, env)(a)"
1165                         "   if type(c) == 'function' then"
1166                         "     self.icons[i] = load (string.dump(c, true), nil, nil, env)(a)"
1167                         "   else"
1168                         "     self.icons[i] = nil"
1169                         "   end"
1170                         "  end"
1171                         ""
1172                         "  local call = function (id)"
1173                         "   if type(self.instances[id]) == 'function' then"
1174                         "     local status, err = pcall (self.instances[id])"
1175                         "     if not status then"
1176                         "       print ('action \"'.. id .. '\": ', err)" // error out
1177                         "       remove (id)"
1178                         "     end"
1179                         "   end"
1180                         "   collectgarbage()"
1181                         "  end"
1182                         ""
1183                         "  local icon = function (id, ...)"
1184                         "   if type(self.icons[id]) == 'function' then"
1185                         "     pcall (self.icons[id], ...)"
1186                         "   end"
1187                         "   collectgarbage()"
1188                         "  end"
1189                         ""
1190                         "  local add = function (i, n, s, b, c, a)"
1191                         "   assert(type(b) == 'string', 'ByteCode must be string')"
1192                         "   f = nil load (b)()" // assigns f
1193                         "   icn = nil load (c)()" // may assign "icn"
1194                         "   assert(type(f) == 'string', 'Assigned ByteCode must be string')"
1195                         "   addinternal (i, n, s, load(f), type(icn) ~= \"string\" or icn == '' or load(icn), a)"
1196                         "  end"
1197                         ""
1198                         "  local get = function (id)"
1199                         "   if type(self.scripts[id]) == 'table' then"
1200                         "    return { ['name'] = self.scripts[id]['n'],"
1201                         "             ['script'] = self.scripts[id]['s'],"
1202                         "             ['icon'] = type(self.scripts[id]['c']) == 'function',"
1203                         "             ['args'] = self.scripts[id]['a'] }"
1204                         "   end"
1205                         "   return nil"
1206                         "  end"
1207                         ""
1208                         "  local function basic_serialize (o)"
1209                         "    if type(o) == \"number\" then"
1210                         "     return tostring(o)"
1211                         "    else"
1212                         "     return string.format(\"%q\", o)"
1213                         "    end"
1214                         "  end"
1215                         ""
1216                         "  local function serialize (name, value)"
1217                         "   local rv = name .. ' = '"
1218                         "   if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
1219                         "    return rv .. basic_serialize(value) .. ' '"
1220                         "   elseif type(value) == \"table\" then"
1221                         "    rv = rv .. '{} '"
1222                         "    for k,v in pairs(value) do"
1223                         "     local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
1224                         "     rv = rv .. serialize(fieldname, v) .. ' '"
1225                         "    end"
1226                         "    return rv;"
1227                         "   elseif type(value) == \"function\" then"
1228                         "     return rv .. string.format(\"%q\", string.dump(value, true))"
1229                         "   elseif type(value) == \"boolean\" then"
1230                         "     return rv .. tostring (value)"
1231                         "   else"
1232                         "    error('cannot save a ' .. type(value))"
1233                         "   end"
1234                         "  end"
1235                         ""
1236                         ""
1237                         "  local save = function ()"
1238                         "   return (serialize('scripts', self.scripts))"
1239                         "  end"
1240                         ""
1241                         "  local clear = function ()"
1242                         "   self.scripts = {}"
1243                         "   self.instances = {}"
1244                         "   self.icons = {}"
1245                         "   collectgarbage()"
1246                         "  end"
1247                         ""
1248                         "  local restore = function (state)"
1249                         "   clear()"
1250                         "   load (state)()"
1251                         "   for i, s in pairs (scripts) do"
1252                         "    addinternal (i, s['n'], s['s'], load(s['f']), type (s['c']) ~= \"string\" or s['c'] == '' or load (s['c']), s['a'])"
1253                         "   end"
1254                         "   collectgarbage()"
1255                         "  end"
1256                         ""
1257                         " return { call = call, add = add, remove = remove, get = get,"
1258                         "          restore = restore, save = save, clear = clear, icon = icon}"
1259                         " end"
1260                         " "
1261                         " manager = ScriptManager ()"
1262                         " ScriptManager = nil"
1263                         );
1264         lua_State* L = lua.getState();
1265
1266         try {
1267                 luabridge::LuaRef lua_mgr = luabridge::getGlobal (L, "manager");
1268                 lua.do_command ("manager = nil"); // hide it.
1269                 lua.do_command ("collectgarbage()");
1270
1271                 _lua_add_action = new luabridge::LuaRef(lua_mgr["add"]);
1272                 _lua_del_action = new luabridge::LuaRef(lua_mgr["remove"]);
1273                 _lua_get_action = new luabridge::LuaRef(lua_mgr["get"]);
1274                 _lua_call_action = new luabridge::LuaRef(lua_mgr["call"]);
1275                 _lua_render_icon = new luabridge::LuaRef(lua_mgr["icon"]);
1276                 _lua_save = new luabridge::LuaRef(lua_mgr["save"]);
1277                 _lua_load = new luabridge::LuaRef(lua_mgr["restore"]);
1278                 _lua_clear = new luabridge::LuaRef(lua_mgr["clear"]);
1279
1280         } catch (luabridge::LuaException const& e) {
1281                 fatal << string_compose (_("programming error: %1"),
1282                                 std::string ("Failed to setup Lua action interpreter") + e.what ())
1283                         << endmsg;
1284                 abort(); /*NOTREACHED*/
1285         } catch (...) {
1286                 fatal << string_compose (_("programming error: %1"),
1287                                 X_("Failed to setup Lua action interpreter"))
1288                         << endmsg;
1289                 abort(); /*NOTREACHED*/
1290         }
1291
1292         register_classes (L);
1293         register_hooks (L);
1294
1295         luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
1296         lua_setglobal (L, "Editor");
1297 }
1298
1299 int
1300 LuaInstance::load_state ()
1301 {
1302         std::string uiscripts;
1303         if (!find_file (ardour_config_search_path(), ui_scripts_file_name, uiscripts)) {
1304                 return -1;
1305         }
1306         XMLTree tree;
1307
1308         info << string_compose (_("Loading user ui scripts file %1"), uiscripts) << endmsg;
1309
1310         if (!tree.read (uiscripts)) {
1311                 error << string_compose(_("cannot read ui scripts file \"%1\""), uiscripts) << endmsg;
1312                 return -1;
1313         }
1314
1315         if (set_state (*tree.root())) {
1316                 error << string_compose(_("user ui scripts file \"%1\" not loaded successfully."), uiscripts) << endmsg;
1317                 return -1;
1318         }
1319
1320         return 0;
1321 }
1322
1323 int
1324 LuaInstance::save_state ()
1325 {
1326         if (!_session) {
1327                 /* action scripts are un-registered with the session */
1328                 return -1;
1329         }
1330
1331         std::string uiscripts = Glib::build_filename (user_config_directory(), ui_scripts_file_name);
1332
1333         XMLNode* node = new XMLNode (X_("UIScripts"));
1334         node->add_child_nocopy (get_action_state ());
1335         node->add_child_nocopy (get_hook_state ());
1336
1337         XMLTree tree;
1338         tree.set_root (node);
1339
1340         if (!tree.write (uiscripts.c_str())){
1341                 error << string_compose (_("UI script file %1 not saved"), uiscripts) << endmsg;
1342                 return -1;
1343         }
1344         return 0;
1345 }
1346
1347 void
1348 LuaInstance::set_dirty ()
1349 {
1350         if (!_session || _session->deletion_in_progress()) {
1351                 return;
1352         }
1353         save_state ();
1354         _session->set_dirty (); // XXX is this reasonable?
1355 }
1356
1357 void LuaInstance::set_session (Session* s)
1358 {
1359         SessionHandlePtr::set_session (s);
1360         if (!_session) {
1361                 return;
1362         }
1363
1364         load_state ();
1365
1366         lua_State* L = lua.getState();
1367         LuaBindings::set_session (L, _session);
1368
1369         for (LuaCallbackMap::iterator i = _callbacks.begin(); i != _callbacks.end(); ++i) {
1370                 i->second->set_session (s);
1371         }
1372         second_connection = Timers::rapid_connect (sigc::mem_fun(*this, & LuaInstance::every_second));
1373         point_one_second_connection = Timers::rapid_connect (sigc::mem_fun(*this, & LuaInstance::every_point_one_seconds));
1374         SetSession (); /* EMIT SIGNAL */
1375 }
1376
1377 void
1378 LuaInstance::session_going_away ()
1379 {
1380         ENSURE_GUI_THREAD (*this, &LuaInstance::session_going_away);
1381         second_connection.disconnect ();
1382         point_one_second_connection.disconnect ();
1383
1384         (*_lua_clear)();
1385         for (int i = 0; i < MAX_LUA_ACTION_SCRIPTS; ++i) {
1386                 ActionChanged (i, ""); /* EMIT SIGNAL */
1387         }
1388         SessionHandlePtr::session_going_away ();
1389         _session = 0;
1390
1391         lua_State* L = lua.getState();
1392         LuaBindings::set_session (L, _session);
1393         lua.do_command ("collectgarbage();");
1394 }
1395
1396 void
1397 LuaInstance::every_second ()
1398 {
1399         LuaTimerS (); // emit signal
1400 }
1401
1402 void
1403 LuaInstance::every_point_one_seconds ()
1404 {
1405         LuaTimerDS (); // emit signal
1406 }
1407
1408 int
1409 LuaInstance::set_state (const XMLNode& node)
1410 {
1411         XMLNode* child;
1412
1413         if ((child = find_named_node (node, "ActionScript"))) {
1414                 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
1415                         if (!(*n)->is_content ()) { continue; }
1416                         gsize size;
1417                         guchar* buf = g_base64_decode ((*n)->content ().c_str (), &size);
1418                         try {
1419                                 (*_lua_load)(std::string ((const char*)buf, size));
1420                         } catch (luabridge::LuaException const& e) {
1421                                 cerr << "LuaException:" << e.what () << endl;
1422                         } catch (...) { }
1423                         for (int i = 0; i < MAX_LUA_ACTION_SCRIPTS; ++i) {
1424                                 std::string name;
1425                                 if (lua_action_name (i, name)) {
1426                                         ActionChanged (i, name); /* EMIT SIGNAL */
1427                                 }
1428                         }
1429                         g_free (buf);
1430                 }
1431         }
1432
1433         assert (_callbacks.empty());
1434         if ((child = find_named_node (node, "ActionHooks"))) {
1435                 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
1436                         try {
1437                                 LuaCallbackPtr p (new LuaCallback (_session, *(*n)));
1438                                 _callbacks.insert (std::make_pair(p->id(), p));
1439                                 p->drop_callback.connect (_slotcon, MISSING_INVALIDATOR, boost::bind (&LuaInstance::unregister_lua_slot, this, p->id()), gui_context());
1440                                 SlotChanged (p->id(), p->name(), p->signals()); /* EMIT SIGNAL */
1441                         } catch (luabridge::LuaException const& e) {
1442                                 cerr << "LuaException:" << e.what () << endl;
1443                         } catch (...) { }
1444                 }
1445         }
1446
1447         return 0;
1448 }
1449
1450 bool
1451 LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id)
1452 {
1453         std::string title;
1454         std::string param_function = "action_params";
1455         std::vector<std::string> reg;
1456
1457         switch (type) {
1458                 case LuaScriptInfo::EditorAction:
1459                         reg = lua_action_names ();
1460                         title = _("Add Shortcut or Lua Script");
1461                         break;
1462                 case LuaScriptInfo::EditorHook:
1463                         reg = lua_slot_names ();
1464                         title = _("Add Lua Callback Hook");
1465                         break;
1466                 case LuaScriptInfo::Session:
1467                         if (!_session) {
1468                                 return false;
1469                         }
1470                         reg = _session->registered_lua_functions ();
1471                         title = _("Add Lua Session Script");
1472                         param_function = "sess_params";
1473                         break;
1474                 default:
1475                         return false;
1476         }
1477
1478         LuaScriptInfoPtr spi;
1479         ScriptSelector ss (title, type);
1480         switch (ss.run ()) {
1481                 case Gtk::RESPONSE_ACCEPT:
1482                         spi = ss.script();
1483                         break;
1484                 default:
1485                         return false;
1486         }
1487         ss.hide ();
1488
1489         std::string script = "";
1490
1491         try {
1492                 script = Glib::file_get_contents (spi->path);
1493         } catch (Glib::FileError const& e) {
1494                 string msg = string_compose (_("Cannot read script '%1': %2"), spi->path, e.what());
1495                 Gtk::MessageDialog am (msg);
1496                 am.run ();
1497                 return false;
1498         }
1499
1500         LuaState ls;
1501         register_classes (ls.getState ());
1502         LuaScriptParamList lsp = LuaScriptParams::script_params (ls, spi->path, param_function);
1503
1504         /* allow cancel */
1505         for (size_t i = 0; i < lsp.size(); ++i) {
1506                 if (lsp[i]->preseeded && lsp[i]->name == "x-script-abort") {
1507                         return false;
1508                 }
1509         }
1510
1511         ScriptParameterDialog spd (_("Set Script Parameters"), spi, reg, lsp);
1512
1513         if (spd.need_interation ()) {
1514                 switch (spd.run ()) {
1515                         case Gtk::RESPONSE_ACCEPT:
1516                                 break;
1517                         default:
1518                                 return false;
1519                 }
1520         }
1521
1522         LuaScriptParamPtr lspp (new LuaScriptParam("x-script-origin", "", spi->path, false, true));
1523         lsp.push_back (lspp);
1524
1525         switch (type) {
1526                 case LuaScriptInfo::EditorAction:
1527                         return set_lua_action (id, spd.name(), script, lsp);
1528                         break;
1529                 case LuaScriptInfo::EditorHook:
1530                         return register_lua_slot (spd.name(), script, lsp);
1531                         break;
1532                 case LuaScriptInfo::Session:
1533                         try {
1534                                 _session->register_lua_function (spd.name(), script, lsp);
1535                         } catch (luabridge::LuaException const& e) {
1536                                 string msg = string_compose (_("Session script '%1' instantiation failed: %2"), spd.name(), e.what ());
1537                                 Gtk::MessageDialog am (msg);
1538                                 am.run ();
1539                         } catch (SessionException const& e) {
1540                                 string msg = string_compose (_("Loading Session script '%1' failed: %2"), spd.name(), e.what ());
1541                                 Gtk::MessageDialog am (msg);
1542                                 am.run ();
1543                         } catch (...) {
1544                                 string msg = string_compose (_("Loading Session script '%1' failed: %2"), spd.name(), "Unknown Exception");
1545                                 Gtk::MessageDialog am (msg);
1546                                 am.run ();
1547                         }
1548                 default:
1549                         break;
1550         }
1551         return false;
1552 }
1553
1554 XMLNode&
1555 LuaInstance::get_action_state ()
1556 {
1557         std::string saved;
1558         {
1559                 luabridge::LuaRef savedstate ((*_lua_save)());
1560                 saved = savedstate.cast<std::string>();
1561         }
1562         lua.collect_garbage ();
1563
1564         gchar* b64 = g_base64_encode ((const guchar*)saved.c_str (), saved.size ());
1565         std::string b64s (b64);
1566         g_free (b64);
1567
1568         XMLNode* script_node = new XMLNode (X_("ActionScript"));
1569         script_node->set_property (X_("lua"), LUA_VERSION);
1570         script_node->add_content (b64s);
1571
1572         return *script_node;
1573 }
1574
1575 XMLNode&
1576 LuaInstance::get_hook_state ()
1577 {
1578         XMLNode* script_node = new XMLNode (X_("ActionHooks"));
1579         for (LuaCallbackMap::const_iterator i = _callbacks.begin(); i != _callbacks.end(); ++i) {
1580                 script_node->add_child_nocopy (i->second->get_state ());
1581         }
1582         return *script_node;
1583 }
1584
1585 void
1586 LuaInstance::call_action (const int id)
1587 {
1588         try {
1589                 (*_lua_call_action)(id + 1);
1590                 lua.collect_garbage_step ();
1591         } catch (luabridge::LuaException const& e) {
1592                 cerr << "LuaException:" << e.what () << endl;
1593         } catch (...) { }
1594 }
1595
1596 void
1597 LuaInstance::render_action_icon (cairo_t* cr, int w, int h, uint32_t c, void* i) {
1598         int ii = reinterpret_cast<uintptr_t> (i);
1599         instance()->render_icon (ii, cr, w, h, c);
1600 }
1601
1602 void
1603 LuaInstance::render_icon (int i, cairo_t* cr, int w, int h, uint32_t clr)
1604 {
1605          Cairo::Context ctx (cr);
1606          try {
1607                  (*_lua_render_icon)(i + 1, (Cairo::Context *)&ctx, w, h, clr);
1608          } catch (luabridge::LuaException const& e) {
1609                  cerr << "LuaException:" << e.what () << endl;
1610          } catch (...) { }
1611 }
1612
1613 bool
1614 LuaInstance::set_lua_action (
1615                 const int id,
1616                 const std::string& name,
1617                 const std::string& script,
1618                 const LuaScriptParamList& args)
1619 {
1620         try {
1621                 lua_State* L = lua.getState();
1622                 // get bytcode of factory-function in a sandbox
1623                 // (don't allow scripts to interfere)
1624                 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
1625                 const std::string& iconfunc = LuaScripting::get_factory_bytecode (script, "icon", "icn");
1626                 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
1627                 for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
1628                         if ((*i)->optional && !(*i)->is_set) { continue; }
1629                         tbl_arg[(*i)->name] = (*i)->value;
1630                 }
1631                 (*_lua_add_action)(id + 1, name, script, bytecode, iconfunc, tbl_arg);
1632                 ActionChanged (id, name); /* EMIT SIGNAL */
1633         } catch (luabridge::LuaException const& e) {
1634                 cerr << "LuaException:" << e.what () << endl;
1635                 return false;
1636         } catch (...) {
1637                 return false;
1638         }
1639         set_dirty ();
1640         return true;
1641 }
1642
1643 bool
1644 LuaInstance::remove_lua_action (const int id)
1645 {
1646         try {
1647                 (*_lua_del_action)(id + 1);
1648         } catch (luabridge::LuaException const& e) {
1649                 cerr << "LuaException:" << e.what () << endl;
1650                 return false;
1651         } catch (...) {
1652                 return false;
1653         }
1654         ActionChanged (id, ""); /* EMIT SIGNAL */
1655         set_dirty ();
1656         return true;
1657 }
1658
1659 bool
1660 LuaInstance::lua_action_name (const int id, std::string& rv)
1661 {
1662         try {
1663                 luabridge::LuaRef ref ((*_lua_get_action)(id + 1));
1664                 if (ref.isNil()) {
1665                         return false;
1666                 }
1667                 if (ref["name"].isString()) {
1668                         rv = ref["name"].cast<std::string>();
1669                         return true;
1670                 }
1671                 return true;
1672         } catch (luabridge::LuaException const& e) {
1673                 cerr << "LuaException:" << e.what () << endl;
1674         } catch (...) { }
1675         return false;
1676 }
1677
1678 std::vector<std::string>
1679 LuaInstance::lua_action_names ()
1680 {
1681         std::vector<std::string> rv;
1682         for (int i = 0; i < MAX_LUA_ACTION_SCRIPTS; ++i) {
1683                 std::string name;
1684                 if (lua_action_name (i, name)) {
1685                         rv.push_back (name);
1686                 }
1687         }
1688         return rv;
1689 }
1690
1691 bool
1692 LuaInstance::lua_action_has_icon (const int id)
1693 {
1694         try {
1695                 luabridge::LuaRef ref ((*_lua_get_action)(id + 1));
1696                 if (ref.isNil()) {
1697                         return false;
1698                 }
1699                 if (ref["icon"].isBoolean()) {
1700                         return ref["icon"].cast<bool>();
1701                 }
1702         } catch (luabridge::LuaException const& e) {
1703                 cerr << "LuaException:" << e.what () << endl;
1704         } catch (...) { }
1705         return false;
1706 }
1707
1708 bool
1709 LuaInstance::lua_action (const int id, std::string& name, std::string& script, LuaScriptParamList& args)
1710 {
1711         try {
1712                 luabridge::LuaRef ref ((*_lua_get_action)(id + 1));
1713                 if (ref.isNil()) {
1714                         return false;
1715                 }
1716                 if (!ref["name"].isString()) {
1717                         return false;
1718                 }
1719                 if (!ref["script"].isString()) {
1720                         return false;
1721                 }
1722                 if (!ref["args"].isTable()) {
1723                         return false;
1724                 }
1725                 name = ref["name"].cast<std::string>();
1726                 script = ref["script"].cast<std::string>();
1727
1728                 args.clear();
1729                 LuaScriptInfoPtr lsi = LuaScripting::script_info (script);
1730                 if (!lsi) {
1731                         return false;
1732                 }
1733                 args = LuaScriptParams::script_params (lsi, "action_params");
1734                 luabridge::LuaRef rargs (ref["args"]);
1735                 LuaScriptParams::ref_to_params (args, &rargs);
1736                 return true;
1737         } catch (luabridge::LuaException const& e) {
1738                 cerr << "LuaException:" << e.what () << endl;
1739         } catch (...) { }
1740         return false;
1741 }
1742
1743 bool
1744 LuaInstance::register_lua_slot (const std::string& name, const std::string& script, const ARDOUR::LuaScriptParamList& args)
1745 {
1746         /* parse script, get ActionHook(s) from script */
1747         ActionHook ah;
1748         try {
1749                 LuaState l;
1750                 l.Print.connect (&_lua_print);
1751                 l.sandbox (true);
1752                 lua_State* L = l.getState();
1753                 register_hooks (L);
1754                 l.do_command ("function ardour () end");
1755                 l.do_command (script);
1756                 luabridge::LuaRef signals = luabridge::getGlobal (L, "signals");
1757                 if (signals.isFunction()) {
1758                         ah = signals();
1759                 }
1760         } catch (luabridge::LuaException const& e) {
1761                 cerr << "LuaException:" << e.what () << endl;
1762         } catch (...) { }
1763
1764         if (ah.none ()) {
1765                 cerr << "Script registered no hooks." << endl;
1766                 return false;
1767         }
1768
1769         /* register script w/args, get entry-point / ID */
1770
1771         try {
1772                 LuaCallbackPtr p (new LuaCallback (_session, name, script, ah, args));
1773                 _callbacks.insert (std::make_pair(p->id(), p));
1774                 p->drop_callback.connect (_slotcon, MISSING_INVALIDATOR, boost::bind (&LuaInstance::unregister_lua_slot, this, p->id()), gui_context());
1775                 SlotChanged (p->id(), p->name(), p->signals()); /* EMIT SIGNAL */
1776                 set_dirty ();
1777                 return true;
1778         } catch (luabridge::LuaException const& e) {
1779                 cerr << "LuaException:" << e.what () << endl;
1780         } catch (...) { }
1781         return false;
1782 }
1783
1784 bool
1785 LuaInstance::unregister_lua_slot (const PBD::ID& id)
1786 {
1787         LuaCallbackMap::iterator i = _callbacks.find (id);
1788         if (i != _callbacks.end()) {
1789                 SlotChanged (id, "", ActionHook()); /* EMIT SIGNAL */
1790                 _callbacks.erase (i);
1791                 set_dirty ();
1792                 return true;
1793         }
1794         return false;
1795 }
1796
1797 std::vector<PBD::ID>
1798 LuaInstance::lua_slots () const
1799 {
1800         std::vector<PBD::ID> rv;
1801         for (LuaCallbackMap::const_iterator i = _callbacks.begin(); i != _callbacks.end(); ++i) {
1802                 rv.push_back (i->first);
1803         }
1804         return rv;
1805 }
1806
1807 bool
1808 LuaInstance::lua_slot_name (const PBD::ID& id, std::string& name) const
1809 {
1810         LuaCallbackMap::const_iterator i = _callbacks.find (id);
1811         if (i != _callbacks.end()) {
1812                 name = i->second->name();
1813                 return true;
1814         }
1815         return false;
1816 }
1817
1818 std::vector<std::string>
1819 LuaInstance::lua_slot_names () const
1820 {
1821         std::vector<std::string> rv;
1822         std::vector<PBD::ID> ids = lua_slots();
1823         for (std::vector<PBD::ID>::const_iterator i = ids.begin(); i != ids.end(); ++i) {
1824                 std::string name;
1825                 if (lua_slot_name (*i, name)) {
1826                         rv.push_back (name);
1827                 }
1828         }
1829         return rv;
1830 }
1831
1832 bool
1833 LuaInstance::lua_slot (const PBD::ID& id, std::string& name, std::string& script, ActionHook& ah, ARDOUR::LuaScriptParamList& args)
1834 {
1835         LuaCallbackMap::const_iterator i = _callbacks.find (id);
1836         if (i == _callbacks.end()) {
1837                 return false; // error
1838         }
1839         return i->second->lua_slot (name, script, ah, args);
1840 }
1841
1842 ///////////////////////////////////////////////////////////////////////////////
1843
1844 LuaCallback::LuaCallback (Session *s,
1845                 const std::string& name,
1846                 const std::string& script,
1847                 const ActionHook& ah,
1848                 const ARDOUR::LuaScriptParamList& args)
1849         : SessionHandlePtr (s)
1850         , _id ("0")
1851         , _name (name)
1852         , _signals (ah)
1853 {
1854         // TODO: allow to reference object (e.g region)
1855         init ();
1856
1857         lua_State* L = lua.getState();
1858         luabridge::LuaRef tbl_arg (luabridge::newTable(L));
1859         for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
1860                 if ((*i)->optional && !(*i)->is_set) { continue; }
1861                 tbl_arg[(*i)->name] = (*i)->value;
1862         }
1863
1864         try {
1865                 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
1866                 (*_lua_add)(name, script, bytecode, tbl_arg);
1867         } catch (luabridge::LuaException const& e) {
1868                 cerr << "LuaException:" << e.what () << endl;
1869                 throw failed_constructor ();
1870         } catch (...) {
1871                 throw failed_constructor ();
1872         }
1873
1874         _id.reset ();
1875         set_session (s);
1876 }
1877
1878 LuaCallback::LuaCallback (Session *s, XMLNode & node)
1879         : SessionHandlePtr (s)
1880 {
1881         XMLNode* child = NULL;
1882         if (node.name() != X_("LuaCallback")
1883                         || !node.property ("signals")
1884                         || !node.property ("id")
1885                         || !node.property ("name")) {
1886                 throw failed_constructor ();
1887         }
1888
1889         for (XMLNodeList::const_iterator n = node.children ().begin (); n != node.children ().end (); ++n) {
1890                 if (!(*n)->is_content ()) { continue; }
1891                 child = *n;
1892         }
1893
1894         if (!child) {
1895                 throw failed_constructor ();
1896         }
1897
1898         init ();
1899
1900         _id = PBD::ID (node.property ("id")->value ());
1901         _name = node.property ("name")->value ();
1902         _signals = ActionHook (node.property ("signals")->value ());
1903
1904         gsize size;
1905         guchar* buf = g_base64_decode (child->content ().c_str (), &size);
1906         try {
1907                 (*_lua_load)(std::string ((const char*)buf, size));
1908         } catch (luabridge::LuaException const& e) {
1909                 cerr << "LuaException:" << e.what () << endl;
1910         } catch (...) { }
1911         g_free (buf);
1912
1913         set_session (s);
1914 }
1915
1916 LuaCallback::~LuaCallback ()
1917 {
1918         delete _lua_add;
1919         delete _lua_get;
1920         delete _lua_call;
1921         delete _lua_load;
1922         delete _lua_save;
1923 }
1924
1925 XMLNode&
1926 LuaCallback::get_state (void)
1927 {
1928         std::string saved;
1929         {
1930                 luabridge::LuaRef savedstate ((*_lua_save)());
1931                 saved = savedstate.cast<std::string>();
1932         }
1933
1934         lua.collect_garbage (); // this may be expensive:
1935         /* Editor::instant_save() calls Editor::get_state() which
1936          * calls LuaInstance::get_hook_state() which in turn calls
1937          * this LuaCallback::get_state() for every registered hook.
1938          *
1939          * serialize in _lua_save() allocates many small strings
1940          * on the lua-stack, collecting them all may take a ms.
1941          */
1942
1943         gchar* b64 = g_base64_encode ((const guchar*)saved.c_str (), saved.size ());
1944         std::string b64s (b64);
1945         g_free (b64);
1946
1947         XMLNode* script_node = new XMLNode (X_("LuaCallback"));
1948         script_node->set_property (X_("lua"), LUA_VERSION);
1949         script_node->set_property (X_("id"), _id.to_s ());
1950         script_node->set_property (X_("name"), _name);
1951         script_node->set_property (X_("signals"), _signals.to_string ());
1952         script_node->add_content (b64s);
1953         return *script_node;
1954 }
1955
1956 void
1957 LuaCallback::init (void)
1958 {
1959         lua.Print.connect (&_lua_print);
1960         lua.sandbox (false);
1961
1962         lua.do_command (
1963                         "function ScriptManager ()"
1964                         "  local self = { script = {}, instance = {} }"
1965                         ""
1966                         "  local addinternal = function (n, s, f, a)"
1967                         "   assert(type(n) == 'string', 'Name must be string')"
1968                         "   assert(type(s) == 'string', 'Script must be string')"
1969                         "   assert(type(f) == 'function', 'Factory is a not a function')"
1970                         "   assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
1971                         "   self.script = { ['n'] = n, ['s'] = s, ['f'] = f, ['a'] = a }"
1972                         "   local env = _ENV; env.f = nil"
1973                         "   self.instance = load (string.dump(f, true), nil, nil, env)(a)"
1974                         "  end"
1975                         ""
1976                         "  local call = function (...)"
1977                         "   if type(self.instance) == 'function' then"
1978                         "     local status, err = pcall (self.instance, ...)"
1979                         "     if not status then"
1980                         "       print ('callback \"'.. self.script['n'] .. '\": ', err)" // error out
1981                         "       self.script = nil"
1982                         "       self.instance = nil"
1983                         "       return false"
1984                         "     end"
1985                         "   end"
1986                         "   collectgarbage()"
1987                         "   return true"
1988                         "  end"
1989                         ""
1990                         "  local add = function (n, s, b, a)"
1991                         "   assert(type(b) == 'string', 'ByteCode must be string')"
1992                         "   load (b)()" // assigns f
1993                         "   assert(type(f) == 'string', 'Assigned ByteCode must be string')"
1994                         "   addinternal (n, s, load(f), a)"
1995                         "  end"
1996                         ""
1997                         "  local get = function ()"
1998                         "   if type(self.instance) == 'function' and type(self.script['n']) == 'string' then"
1999                         "    return { ['name'] = self.script['n'],"
2000                         "             ['script'] = self.script['s'],"
2001                         "             ['args'] = self.script['a'] }"
2002                         "   end"
2003                         "   return nil"
2004                         "  end"
2005                         ""
2006                         // code dup
2007                         ""
2008                         "  local function basic_serialize (o)"
2009                         "    if type(o) == \"number\" then"
2010                         "     return tostring(o)"
2011                         "    else"
2012                         "     return string.format(\"%q\", o)"
2013                         "    end"
2014                         "  end"
2015                         ""
2016                         "  local function serialize (name, value)"
2017                         "   local rv = name .. ' = '"
2018                         "   if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
2019                         "    return rv .. basic_serialize(value) .. ' '"
2020                         "   elseif type(value) == \"table\" then"
2021                         "    rv = rv .. '{} '"
2022                         "    for k,v in pairs(value) do"
2023                         "     local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
2024                         "     rv = rv .. serialize(fieldname, v) .. ' '"
2025                         "    end"
2026                         "    return rv;"
2027                         "   elseif type(value) == \"function\" then"
2028                         "     return rv .. string.format(\"%q\", string.dump(value, true))"
2029                         "   elseif type(value) == \"boolean\" then"
2030                         "     return rv .. tostring (value)"
2031                         "   else"
2032                         "    error('cannot save a ' .. type(value))"
2033                         "   end"
2034                         "  end"
2035                         ""
2036                         // end code dup
2037                         ""
2038                         "  local save = function ()"
2039                         "   return (serialize('s', self.script))"
2040                         "  end"
2041                         ""
2042                         "  local restore = function (state)"
2043                         "   self.script = {}"
2044                         "   load (state)()"
2045                         "   addinternal (s['n'], s['s'], load(s['f']), s['a'])"
2046                         "  end"
2047                         ""
2048                         " return { call = call, add = add, get = get,"
2049                         "          restore = restore, save = save}"
2050                         " end"
2051                         " "
2052                         " manager = ScriptManager ()"
2053                         " ScriptManager = nil"
2054                         );
2055
2056         lua_State* L = lua.getState();
2057
2058         try {
2059                 luabridge::LuaRef lua_mgr = luabridge::getGlobal (L, "manager");
2060                 lua.do_command ("manager = nil"); // hide it.
2061                 lua.do_command ("collectgarbage()");
2062
2063                 _lua_add = new luabridge::LuaRef(lua_mgr["add"]);
2064                 _lua_get = new luabridge::LuaRef(lua_mgr["get"]);
2065                 _lua_call = new luabridge::LuaRef(lua_mgr["call"]);
2066                 _lua_save = new luabridge::LuaRef(lua_mgr["save"]);
2067                 _lua_load = new luabridge::LuaRef(lua_mgr["restore"]);
2068
2069         } catch (luabridge::LuaException const& e) {
2070                 fatal << string_compose (_("programming error: %1"),
2071                                 std::string ("Failed to setup Lua callback interpreter: ") + e.what ())
2072                         << endmsg;
2073                 abort(); /*NOTREACHED*/
2074         } catch (...) {
2075                 fatal << string_compose (_("programming error: %1"),
2076                                 X_("Failed to setup Lua callback interpreter"))
2077                         << endmsg;
2078                 abort(); /*NOTREACHED*/
2079         }
2080
2081         LuaInstance::register_classes (L);
2082         LuaInstance::register_hooks (L);
2083
2084         luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
2085         lua_setglobal (L, "Editor");
2086 }
2087
2088 bool
2089 LuaCallback::lua_slot (std::string& name, std::string& script, ActionHook& ah, ARDOUR::LuaScriptParamList& args)
2090 {
2091         // TODO consolidate w/ LuaInstance::lua_action()
2092         try {
2093                 luabridge::LuaRef ref = (*_lua_get)();
2094                 if (ref.isNil()) {
2095                         return false;
2096                 }
2097                 if (!ref["name"].isString()) {
2098                         return false;
2099                 }
2100                 if (!ref["script"].isString()) {
2101                         return false;
2102                 }
2103                 if (!ref["args"].isTable()) {
2104                         return false;
2105                 }
2106
2107                 ah = _signals;
2108                 name = ref["name"].cast<std::string> ();
2109                 script = ref["script"].cast<std::string> ();
2110
2111                 args.clear();
2112                 LuaScriptInfoPtr lsi = LuaScripting::script_info (script);
2113                 if (!lsi) {
2114                         return false;
2115                 }
2116                 args = LuaScriptParams::script_params (lsi, "action_params");
2117                 luabridge::LuaRef rargs (ref["args"]);
2118                 LuaScriptParams::ref_to_params (args, &rargs);
2119                 return true;
2120         } catch (luabridge::LuaException const& e) {
2121                 cerr << "LuaException:" << e.what () << endl;
2122                 return false;
2123         } catch (...) { }
2124         return false;
2125 }
2126
2127 void
2128 LuaCallback::set_session (ARDOUR::Session *s)
2129 {
2130         SessionHandlePtr::set_session (s);
2131
2132         if (!_session) {
2133                 return;
2134         }
2135
2136         lua_State* L = lua.getState();
2137         LuaBindings::set_session (L, _session);
2138
2139         reconnect();
2140 }
2141
2142 void
2143 LuaCallback::session_going_away ()
2144 {
2145         ENSURE_GUI_THREAD (*this, &LuaCallback::session_going_away);
2146         lua.do_command ("collectgarbage();");
2147
2148         SessionHandlePtr::session_going_away ();
2149         _session = 0;
2150
2151         drop_callback (); /* EMIT SIGNAL */
2152 }
2153
2154 void
2155 LuaCallback::reconnect ()
2156 {
2157         _connections.drop_connections ();
2158         if ((*_lua_get) ().isNil ()) {
2159                 drop_callback (); /* EMIT SIGNAL */
2160                 return;
2161         }
2162
2163         // TODO pass object which emits the signal (e.g region)
2164         //
2165         // save/load bound objects will be tricky.
2166         // Best idea so far is to save/lookup the PBD::ID
2167         // (either use boost::any indirection or templates for bindable
2168         // object types or a switch statement..)
2169         //
2170         // _session->route_by_id ()
2171         // _session->track_by_diskstream_id ()
2172         // _session->source_by_id ()
2173         // _session->controllable_by_id ()
2174         // _session->processor_by_id ()
2175         // RegionFactory::region_by_id ()
2176         //
2177         // TODO loop over objects (if any)
2178
2179         reconnect_object ((void*)0);
2180 }
2181
2182 template <class T> void
2183 LuaCallback::reconnect_object (T obj)
2184 {
2185         for (uint32_t i = 0; i < LuaSignal::LAST_SIGNAL; ++i) {
2186                 if (_signals[i]) {
2187 #define ENGINE(n,c,p) else if (i == LuaSignal::n) { connect_ ## p (LuaSignal::n, AudioEngine::instance(), &(AudioEngine::instance()->c)); }
2188 #define SESSION(n,c,p) else if (i == LuaSignal::n) { if (_session) { connect_ ## p (LuaSignal::n, _session, &(_session->c)); } }
2189 #define STATIC(n,c,p) else if (i == LuaSignal::n) { connect_ ## p (LuaSignal::n, obj, c); }
2190                         if (0) {}
2191 #                       include "luasignal_syms.h"
2192                         else {
2193                                 PBD::fatal << string_compose (_("programming error: %1: %2"), "Impossible LuaSignal type", i) << endmsg;
2194                                 abort(); /*NOTREACHED*/
2195                         }
2196 #undef ENGINE
2197 #undef SESSION
2198 #undef STATIC
2199                 }
2200         }
2201 }
2202
2203 template <typename T, typename S> void
2204 LuaCallback::connect_0 (enum LuaSignal::LuaSignal ls, T ref, S *signal) {
2205         signal->connect (
2206                         _connections, invalidator (*this),
2207                         boost::bind (&LuaCallback::proxy_0<T>, this, ls, ref),
2208                         gui_context());
2209 }
2210
2211 template <typename T, typename C1> void
2212 LuaCallback::connect_1 (enum LuaSignal::LuaSignal ls, T ref, PBD::Signal1<void, C1> *signal) {
2213         signal->connect (
2214                         _connections, invalidator (*this),
2215                         boost::bind (&LuaCallback::proxy_1<T, C1>, this, ls, ref, _1),
2216                         gui_context());
2217 }
2218
2219 template <typename T, typename C1, typename C2> void
2220 LuaCallback::connect_2 (enum LuaSignal::LuaSignal ls, T ref, PBD::Signal2<void, C1, C2> *signal) {
2221         signal->connect (
2222                         _connections, invalidator (*this),
2223                         boost::bind (&LuaCallback::proxy_2<T, C1, C2>, this, ls, ref, _1, _2),
2224                         gui_context());
2225 }
2226
2227 template <typename T, typename C1, typename C2, typename C3> void
2228 LuaCallback::connect_3 (enum LuaSignal::LuaSignal ls, T ref, PBD::Signal3<void, C1, C2, C3> *signal) {
2229         signal->connect (
2230                         _connections, invalidator (*this),
2231                         boost::bind (&LuaCallback::proxy_3<T, C1, C2, C3>, this, ls, ref, _1, _2, _3),
2232                         gui_context());
2233 }
2234
2235 template <typename T> void
2236 LuaCallback::proxy_0 (enum LuaSignal::LuaSignal ls, T ref) {
2237         bool ok = true;
2238         {
2239                 const luabridge::LuaRef& rv ((*_lua_call)((int)ls, ref));
2240                 if (! rv.cast<bool> ()) {
2241                         ok = false;
2242                 }
2243         }
2244         /* destroy LuaRef ^^ first before calling drop_callback() */
2245         if (!ok) {
2246                 drop_callback (); /* EMIT SIGNAL */
2247         }
2248 }
2249
2250 template <typename T, typename C1> void
2251 LuaCallback::proxy_1 (enum LuaSignal::LuaSignal ls, T ref, C1 a1) {
2252         bool ok = true;
2253         {
2254                 const luabridge::LuaRef& rv ((*_lua_call)((int)ls, ref, a1));
2255                 if (! rv.cast<bool> ()) {
2256                         ok = false;
2257                 }
2258         }
2259         if (!ok) {
2260                 drop_callback (); /* EMIT SIGNAL */
2261         }
2262 }
2263
2264 template <typename T, typename C1, typename C2> void
2265 LuaCallback::proxy_2 (enum LuaSignal::LuaSignal ls, T ref, C1 a1, C2 a2) {
2266         bool ok = true;
2267         {
2268                 const luabridge::LuaRef& rv ((*_lua_call)((int)ls, ref, a1, a2));
2269                 if (! rv.cast<bool> ()) {
2270                         ok = false;
2271                 }
2272         }
2273         if (!ok) {
2274                 drop_callback (); /* EMIT SIGNAL */
2275         }
2276 }
2277
2278 template <typename T, typename C1, typename C2, typename C3> void
2279 LuaCallback::proxy_3 (enum LuaSignal::LuaSignal ls, T ref, C1 a1, C2 a2, C3 a3) {
2280         bool ok = true;
2281         {
2282                 const luabridge::LuaRef& rv ((*_lua_call)((int)ls, ref, a1, a2, a3));
2283                 if (! rv.cast<bool> ()) {
2284                         ok = false;
2285                 }
2286         }
2287         if (!ok) {
2288                 drop_callback (); /* EMIT SIGNAL */
2289         }
2290 }