gtk2_ardour/luainstance.cc

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