2 * Copyright (C) 2016 Robin Gareus <robin@gareus.org>
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 #include <cairomm/context.h>
20 #include <cairomm/surface.h>
21 #include <pango/pangocairo.h>
23 #include "gtkmm2ext/gui_thread.h"
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"
31 #include "LuaBridge/LuaBridge.h"
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"
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"
48 #include "utils_videotl.h"
53 /** wrap RefPtr< Cairo::ImageSurface >
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.
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).
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
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 ()) {}
79 * Set this surface as source for another context.
80 * This allows to draw this surface
82 void set_as_source (Cairo::Context* c, int x, int y) {
84 c->set_source (_surface, x, y);
88 * Returns a context object to perform operations on the surface
90 Cairo::Context* context () {
91 return (Cairo::Context *)&ctx;
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.
99 int get_stride () const {
100 return _surface->get_stride ();
103 /** Gets the width of the ImageSurface in pixels */
104 int get_width () const {
105 return _surface->get_width ();
108 /** Gets the height of the ImageSurface in pixels */
109 int get_height () const {
110 return _surface->get_height ();
114 * Get a pointer to the data of the image surface, for direct
115 * inspection or modification.
117 * Return value: a pointer to the image data of this surface or NULL
118 * if @surface is not an image surface.
121 unsigned char* get_data () {
122 return _surface->get_data ();
125 /** Tells cairo to consider the data buffer dirty.
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.
132 * Note that if you do draw to the Surface outside of cairo, you must call
133 * flush() before doing the drawing.
136 _surface->mark_dirty ();
139 /** Marks a rectangular area of the given surface dirty.
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
146 void mark_dirty (int x, int y, int width, int height) {
147 _surface->mark_dirty (x, y, width, height);
151 Cairo::RefPtr<Cairo::ImageSurface> _surface;
152 Cairo::RefPtr<Cairo::Context> _ctx;
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"
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);
171 /** Gets the text in the layout. The returned text should not
172 * be freed or modified.
174 * @return The text in the @a layout.
176 std::string get_text () const {
177 return _layout->get_text ();
179 /** Set the text of the layout.
180 * @param text The text for the layout.
182 void set_text (const std::string& text) {
183 _layout->set_text (text);
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.
190 void set_markup (const std::string& markup) {
191 _layout->set_markup (markup);
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.
197 * @param width The desired width in Pango units, or -1 to indicate that no
198 * wrapping or ellipsization should be performed.
200 void set_width (int width) {
201 _layout->set_width (width * PANGO_SCALE);
204 /** Gets the width to which the lines of the Pango::Layout should wrap.
206 * @return The width in Pango units, or -1 if no width set.
208 int get_width () const {
209 return _layout->get_width () / PANGO_SCALE;
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().
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.
224 * @param ellipsize The new ellipsization mode for @a layout.
226 void set_ellipsize (Pango::EllipsizeMode ellipsize) {
227 _layout->set_ellipsize (ellipsize);
230 /** Gets the type of ellipsization being performed for @a layout.
231 * See set_ellipsize()
233 * @return The current ellipsization mode for @a layout.
235 * Use is_ellipsized() to query whether any paragraphs
236 * were actually ellipsized.
238 Pango::EllipsizeMode get_ellipsize () const {
239 return _layout->get_ellipsize ();
242 /** Queries whether the layout had to ellipsize any paragraphs.
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
249 * @return <tt>true</tt> if any paragraphs had to be ellipsized, <tt>false</tt>
252 bool is_ellipsized () const {
253 return _layout->is_ellipsized ();
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.
260 * @param wrap The wrap mode.
262 void set_wrap (Pango::WrapMode wrap) {
263 _layout->set_width (wrap);
266 /** Gets the wrap mode for the layout.
268 * Use is_wrapped() to query whether any paragraphs
269 * were actually wrapped.
271 * @return Active wrap mode.
273 Pango::WrapMode get_wrap () const {
274 return _layout->get_wrap ();
277 /** Queries whether the layout had to wrap any paragraphs.
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
284 * @return <tt>true</tt> if any paragraphs had to be wrapped, <tt>false</tt>
287 bool is_wrapped () const {
288 return _layout->is_wrapped ();
291 /** Determines the logical width and height of a Pango::Layout
294 int get_pixel_size (lua_State *L) {
296 _layout->get_pixel_size (width, height);
297 luabridge::Stack<int>::push (L, width);
298 luabridge::Stack<int>::push (L, height);
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
307 * @param context A Cairo context.
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());
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());
320 Glib::RefPtr<Pango::Layout> _layout;
325 ////////////////////////////////////////////////////////////////////////////////
327 namespace LuaSignal {
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;}
334 str2luasignal (const std::string &str) {
335 const char* type = str.c_str();
337 # include "luasignal_syms.h"
339 PBD::fatal << string_compose (_("programming error: %1: %2"), "Impossible LuaSignal type", str) << endmsg;
340 abort(); /*NOTREACHED*/
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"
361 /** special cases for Ardour's Mixer UI */
364 ProcessorBox::ProcSelection
365 processor_selection () {
366 return ProcessorBox::current_processor_selection ();
371 ////////////////////////////////////////////////////////////////////////////////
373 #define xstr(s) stringify(s)
374 #define stringify(s) #s
376 using namespace ARDOUR;
378 PBD::Signal0<void> LuaInstance::LuaTimerDS;
381 LuaInstance::register_hooks (lua_State* L)
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"
395 luabridge::getGlobalNamespace (L)
396 .beginNamespace ("LuaSignal")
397 .beginStdBitSet <LuaSignal::LAST_SIGNAL> ("Set")
403 LuaInstance::bind_cairo (lua_State* L)
405 /* std::vector<double> for set_dash()
406 * for Windows (DLL, .exe) this needs to be bound in the same memory context as "Cairo".
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
411 * see LuaBindings::set_session() for a detailed explanation
413 luabridge::getGlobalNamespace (L)
414 .beginNamespace ("C")
415 .beginStdVector <double> ("DoubleVector")
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)
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)
468 .beginNamespace ("LineJoin")
469 .addConst ("Miter", CAIRO_LINE_JOIN_MITER)
470 .addConst ("Round", CAIRO_LINE_JOIN_ROUND)
471 .addConst ("Bevel", CAIRO_LINE_JOIN_BEVEL)
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)
481 .beginNamespace ("Format")
482 .addConst ("ARGB32", CAIRO_FORMAT_ARGB32)
483 .addConst ("RGB24", CAIRO_FORMAT_RGB24)
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
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)
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)
521 .beginNamespace ("WrapMode")
522 .addConst ("Word", Pango::WRAP_WORD)
523 .addConst ("Char", Pango::WRAP_CHAR)
524 .addConst ("WordChar", Pango::WRAP_WORD_CHAR)
529 /* Lua/cairo bindings operate on Cairo::Context, there is no Cairo::RefPtr wrapper [yet].
530 one can work around this as follows:
533 LuaInstance::register_classes (lua.getState());
535 "function render (ctx)"
536 " ctx:rectangle (0, 0, 100, 100)"
537 " ctx:set_source_rgba (0.1, 1.0, 0.1, 1.0)"
542 Cairo::RefPtr<Cairo::Context> context = get_window ()->create_cairo_context ();
543 Cairo::Context ctx (context->cobj ());
545 luabridge::LuaRef lua_render = luabridge::getGlobal (lua.getState(), "render");
546 lua_render ((Cairo::Context *)&ctx);
553 LuaInstance::bind_dialog (lua_State* L)
555 luabridge::getGlobalNamespace (L)
556 .beginNamespace ("LuaDialog")
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)
563 .beginClass <LuaDialog::Dialog> ("Dialog")
564 .addConstructor <void (*) (std::string const&, luabridge::LuaRef)> ()
565 .addCFunction ("run", &LuaDialog::Dialog::run)
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)
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)
584 .beginNamespace ("Response")
586 .addConst ("Cancel", 1)
587 .addConst ("Close", 2)
590 .addConst ("None", -1)
598 LuaInstance::register_classes (lua_State* L)
600 LuaBindings::stddef (L);
601 LuaBindings::common (L);
602 LuaBindings::session (L);
603 LuaBindings::osc (L);
609 luabridge::getGlobalNamespace (L)
610 .beginNamespace ("ArdourUI")
612 .addFunction ("http_get", (std::string (*)(const std::string&))&ArdourCurl::http_get)
614 .addFunction ("processor_selection", &LuaMixer::processor_selection)
616 .beginStdList <ArdourMarker*> ("ArdourMarkerList")
619 .beginClass <ArdourMarker> ("ArdourMarker")
620 .addFunction ("name", &ArdourMarker::name)
621 .addFunction ("position", &ArdourMarker::position)
622 .addFunction ("_type", &ArdourMarker::type)
625 .beginClass <AxisView> ("AxisView")
628 .deriveClass <TimeAxisView, AxisView> ("TimeAxisView")
631 .beginClass <Selectable> ("Selectable")
634 .deriveClass <TimeAxisViewItem, Selectable> ("TimeAxisViewItem")
637 .deriveClass <RegionView, TimeAxisViewItem> ("RegionView")
640 .deriveClass <RouteUI, Selectable> ("RouteUI")
643 .deriveClass <RouteTimeAxisView, RouteUI> ("RouteTimeAxisView")
644 .addCast<TimeAxisView> ("to_timeaxisview")
647 // std::list<Selectable*>
648 .beginStdCPtrList <Selectable> ("SelectionList")
651 // std::list<TimeAxisView*>
652 .beginStdCPtrList <TimeAxisView> ("TrackViewStdList")
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)
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)
669 .deriveClass <MarkerSelection, std::list<ArdourMarker*> > ("MarkerSelection")
672 .deriveClass <TrackViewList, std::list<TimeAxisView*> > ("TrackViewList")
673 .addFunction ("contains", &TrackViewList::contains)
674 .addFunction ("routelist", &TrackViewList::routelist)
677 .deriveClass <TrackSelection, TrackViewList> ("TrackSelection")
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)
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
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)
703 .addFunction ("undo", &PublicEditor::undo)
704 .addFunction ("redo", &PublicEditor::redo)
706 .addFunction ("set_mouse_mode", &PublicEditor::set_mouse_mode)
707 .addFunction ("current_mouse_mode", &PublicEditor::current_mouse_mode)
709 .addFunction ("consider_auditioning", &PublicEditor::consider_auditioning)
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)
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)
720 .addFunction ("set_selection", &PublicEditor::set_selection)
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)
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)
730 .addFunction ("set_show_measures", &PublicEditor::set_show_measures)
731 .addFunction ("show_measures", &PublicEditor::show_measures)
732 .addFunction ("remove_tracks", &PublicEditor::remove_tracks)
734 .addFunction ("set_loop_range", &PublicEditor::set_loop_range)
735 .addFunction ("set_punch_range", &PublicEditor::set_punch_range)
737 .addFunction ("effective_mouse_mode", &PublicEditor::effective_mouse_mode)
739 .addRefFunction ("do_import", &PublicEditor::do_import)
740 .addRefFunction ("do_embed", &PublicEditor::do_embed)
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)
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)
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)
757 .addFunction ("select_all_tracks", &PublicEditor::select_all_tracks)
758 .addFunction ("deselect_all", &PublicEditor::deselect_all)
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)
765 .addFunction ("hide_track_in_display", &PublicEditor::hide_track_in_display)
766 .addFunction ("show_track_in_display", &PublicEditor::show_track_in_display)
768 .addFunction ("regionview_from_region", &PublicEditor::regionview_from_region)
769 .addFunction ("set_stationary_playhead", &PublicEditor::set_stationary_playhead)
770 .addFunction ("stationary_playhead", &PublicEditor::stationary_playhead)
771 .addFunction ("set_follow_playhead", &PublicEditor::set_follow_playhead)
772 .addFunction ("follow_playhead", &PublicEditor::follow_playhead)
774 .addFunction ("dragging_playhead", &PublicEditor::dragging_playhead)
775 .addFunction ("leftmost_sample", &PublicEditor::leftmost_sample)
776 .addFunction ("current_page_samples", &PublicEditor::current_page_samples)
777 .addFunction ("visible_canvas_height", &PublicEditor::visible_canvas_height)
778 .addFunction ("temporal_zoom_step", &PublicEditor::temporal_zoom_step)
779 .addFunction ("override_visible_track_count", &PublicEditor::override_visible_track_count)
781 .addFunction ("scroll_tracks_down_line", &PublicEditor::scroll_tracks_down_line)
782 .addFunction ("scroll_tracks_up_line", &PublicEditor::scroll_tracks_up_line)
783 .addFunction ("scroll_down_one_track", &PublicEditor::scroll_down_one_track)
784 .addFunction ("scroll_up_one_track", &PublicEditor::scroll_up_one_track)
786 .addFunction ("reset_x_origin", &PublicEditor::reset_x_origin)
787 .addFunction ("get_y_origin", &PublicEditor::get_y_origin)
788 .addFunction ("reset_y_origin", &PublicEditor::reset_y_origin)
790 .addFunction ("remove_last_capture", &PublicEditor::remove_last_capture)
792 .addFunction ("maximise_editing_space", &PublicEditor::maximise_editing_space)
793 .addFunction ("restore_editing_space", &PublicEditor::restore_editing_space)
794 .addFunction ("toggle_meter_updating", &PublicEditor::toggle_meter_updating)
796 //.addFunction ("get_preferred_edit_position", &PublicEditor::get_preferred_edit_position)
797 //.addFunction ("split_regions_at", &PublicEditor::split_regions_at)
799 .addRefFunction ("get_nudge_distance", &PublicEditor::get_nudge_distance)
800 .addFunction ("get_paste_offset", &PublicEditor::get_paste_offset)
801 .addFunction ("get_grid_beat_divisions", &PublicEditor::get_grid_beat_divisions)
802 .addRefFunction ("get_grid_type_as_beats", &PublicEditor::get_grid_type_as_beats)
804 .addFunction ("toggle_ruler_video", &PublicEditor::toggle_ruler_video)
805 .addFunction ("toggle_xjadeo_proc", &PublicEditor::toggle_xjadeo_proc)
806 .addFunction ("get_videotl_bar_height", &PublicEditor::get_videotl_bar_height)
807 .addFunction ("set_video_timeline_height", &PublicEditor::set_video_timeline_height)
810 .addFunction ("get_equivalent_regions", &PublicEditor::get_equivalent_regions)
811 .addFunction ("drags", &PublicEditor::drags)
814 .addFunction ("get_route_view_by_route_id", &PublicEditor::get_route_view_by_route_id)
815 .addFunction ("get_track_views", &PublicEditor::get_track_views)
816 .addFunction ("rtav_from_route", &PublicEditor::rtav_from_route)
817 .addFunction ("axis_views_from_routes", &PublicEditor::axis_views_from_routes)
819 .addFunction ("center_screen", &PublicEditor::center_screen)
821 .addFunction ("get_smart_mode", &PublicEditor::get_smart_mode)
822 .addRefFunction ("get_pointer_position", &PublicEditor::get_pointer_position)
824 .addRefFunction ("find_location_from_marker", &PublicEditor::find_location_from_marker)
825 .addFunction ("find_marker_from_location_id", &PublicEditor::find_marker_from_location_id)
826 .addFunction ("mouse_add_new_marker", &PublicEditor::mouse_add_new_marker)
828 .addFunction ("get_regions_at", &PublicEditor::get_regions_at)
829 .addFunction ("get_regions_after", &PublicEditor::get_regions_after)
830 .addFunction ("get_regions_from_selection_and_mouse", &PublicEditor::get_regions_from_selection_and_mouse)
831 .addFunction ("get_regionviews_by_id", &PublicEditor::get_regionviews_by_id)
832 .addFunction ("get_per_region_note_selection", &PublicEditor::get_per_region_note_selection)
836 .addFunction ("mouse_add_new_tempo_event", &PublicEditor::mouse_add_new_tempo_event)
837 .addFunction ("mouse_add_new_meter_event", &PublicEditor::mouse_add_new_meter_event)
838 .addFunction ("edit_tempo_section", &PublicEditor::edit_tempo_section)
839 .addFunction ("edit_meter_section", &PublicEditor::edit_meter_section)
842 .addFunction ("access_action", &PublicEditor::access_action)
846 .beginNamespace ("MarkerType")
847 .addConst ("Mark", ArdourMarker::Type(ArdourMarker::Mark))
848 .addConst ("Tempo", ArdourMarker::Type(ArdourMarker::Tempo))
849 .addConst ("Meter", ArdourMarker::Type(ArdourMarker::Meter))
850 .addConst ("SessionStart", ArdourMarker::Type(ArdourMarker::SessionStart))
851 .addConst ("SessionEnd", ArdourMarker::Type(ArdourMarker::SessionEnd))
852 .addConst ("RangeStart", ArdourMarker::Type(ArdourMarker::RangeStart))
853 .addConst ("RangeEnd", ArdourMarker::Type(ArdourMarker::RangeEnd))
854 .addConst ("LoopStart", ArdourMarker::Type(ArdourMarker::LoopStart))
855 .addConst ("LoopEnd", ArdourMarker::Type(ArdourMarker::LoopEnd))
856 .addConst ("PunchIn", ArdourMarker::Type(ArdourMarker::PunchIn))
857 .addConst ("PunchOut", ArdourMarker::Type(ArdourMarker::PunchOut))
860 .beginNamespace ("SelectionOp")
861 .addConst ("Toggle", Selection::Operation(Selection::Toggle))
862 .addConst ("Set", Selection::Operation(Selection::Set))
863 .addConst ("Extend", Selection::Operation(Selection::Extend))
864 .addConst ("Add", Selection::Operation(Selection::Add))
867 .endNamespace (); // end ArdourUI
875 #undef DISPLAYCONTROL
877 #undef IMPORTPOSITION
878 #undef IMPORTDISPOSITION
880 #define ZOOMFOCUS(NAME) .addConst (stringify(NAME), (Editing::ZoomFocus)Editing::NAME)
881 #define SNAPTYPE(NAME) .addConst (stringify(NAME), (Editing::SnapType)Editing::NAME)
882 #define SNAPMODE(NAME) .addConst (stringify(NAME), (Editing::SnapMode)Editing::NAME)
883 #define MOUSEMODE(NAME) .addConst (stringify(NAME), (Editing::MouseMode)Editing::NAME)
884 #define DISPLAYCONTROL(NAME) .addConst (stringify(NAME), (Editing::DisplayControl)Editing::NAME)
885 #define IMPORTMODE(NAME) .addConst (stringify(NAME), (Editing::ImportMode)Editing::NAME)
886 #define IMPORTPOSITION(NAME) .addConst (stringify(NAME), (Editing::ImportPosition)Editing::NAME)
887 #define IMPORTDISPOSITION(NAME) .addConst (stringify(NAME), (Editing::ImportDisposition)Editing::NAME)
888 luabridge::getGlobalNamespace (L)
889 .beginNamespace ("Editing")
890 # include "editing_syms.h"
897 ////////////////////////////////////////////////////////////////////////////////
899 using namespace ARDOUR;
900 using namespace ARDOUR_UI_UTILS;
904 static void _lua_print (std::string s) {
906 std::cout << "LuaInstance: " << s << "\n";
908 PBD::info << "LuaInstance: " << s << endmsg;
911 LuaInstance* LuaInstance::_instance = 0;
914 LuaInstance::instance ()
917 _instance = new LuaInstance;
924 LuaInstance::destroy_instance ()
930 LuaInstance::LuaInstance ()
932 lua.Print.connect (&_lua_print);
935 LuaScriptParamList args;
938 LuaInstance::~LuaInstance ()
940 delete _lua_call_action;
941 delete _lua_render_icon;
942 delete _lua_add_action;
943 delete _lua_del_action;
944 delete _lua_get_action;
956 "function ScriptManager ()"
957 " local self = { scripts = {}, instances = {}, icons = {} }"
959 " local remove = function (id)"
960 " self.scripts[id] = nil"
961 " self.instances[id] = nil"
962 " self.icons[id] = nil"
965 " local addinternal = function (i, n, s, f, c, a)"
966 " assert(type(i) == 'number', 'id must be numeric')"
967 " assert(type(n) == 'string', 'Name must be string')"
968 " assert(type(s) == 'string', 'Script must be string')"
969 " assert(type(f) == 'function', 'Factory is a not a function')"
970 " assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
971 " self.scripts[i] = { ['n'] = n, ['s'] = s, ['f'] = f, ['a'] = a, ['c'] = c }"
972 " local env = _ENV; env.f = nil env.debug = nil os.exit = nil require = nil dofile = nil loadfile = nil package = nil"
973 " self.instances[i] = load (string.dump(f, true), nil, nil, env)(a)"
974 " if type(c) == 'function' then"
975 " self.icons[i] = load (string.dump(c, true), nil, nil, env)(a)"
977 " self.icons[i] = nil"
981 " local call = function (id)"
982 " if type(self.instances[id]) == 'function' then"
983 " local status, err = pcall (self.instances[id])"
984 " if not status then"
985 " print ('action \"'.. id .. '\": ', err)" // error out
992 " local icon = function (id, ...)"
993 " if type(self.icons[id]) == 'function' then"
994 " pcall (self.icons[id], ...)"
999 " local add = function (i, n, s, b, c, a)"
1000 " assert(type(b) == 'string', 'ByteCode must be string')"
1001 " f = nil load (b)()" // assigns f
1002 " icn = nil load (c)()" // may assign "icn"
1003 " assert(type(f) == 'string', 'Assigned ByteCode must be string')"
1004 " addinternal (i, n, s, load(f), type(icn) ~= \"string\" or icn == '' or load(icn), a)"
1007 " local get = function (id)"
1008 " if type(self.scripts[id]) == 'table' then"
1009 " return { ['name'] = self.scripts[id]['n'],"
1010 " ['script'] = self.scripts[id]['s'],"
1011 " ['icon'] = type(self.scripts[id]['c']) == 'function',"
1012 " ['args'] = self.scripts[id]['a'] }"
1017 " local function basic_serialize (o)"
1018 " if type(o) == \"number\" then"
1019 " return tostring(o)"
1021 " return string.format(\"%q\", o)"
1025 " local function serialize (name, value)"
1026 " local rv = name .. ' = '"
1027 " if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
1028 " return rv .. basic_serialize(value) .. ' '"
1029 " elseif type(value) == \"table\" then"
1031 " for k,v in pairs(value) do"
1032 " local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
1033 " rv = rv .. serialize(fieldname, v) .. ' '"
1036 " elseif type(value) == \"function\" then"
1037 " return rv .. string.format(\"%q\", string.dump(value, true))"
1038 " elseif type(value) == \"boolean\" then"
1039 " return rv .. tostring (value)"
1041 " error('cannot save a ' .. type(value))"
1046 " local save = function ()"
1047 " return (serialize('scripts', self.scripts))"
1050 " local clear = function ()"
1051 " self.scripts = {}"
1052 " self.instances = {}"
1057 " local restore = function (state)"
1060 " for i, s in pairs (scripts) do"
1061 " addinternal (i, s['n'], s['s'], load(s['f']), type (s['c']) ~= \"string\" or s['c'] == '' or load (s['c']), s['a'])"
1066 " return { call = call, add = add, remove = remove, get = get,"
1067 " restore = restore, save = save, clear = clear, icon = icon}"
1070 " manager = ScriptManager ()"
1071 " ScriptManager = nil"
1074 lua_State* L = lua.getState();
1077 luabridge::LuaRef lua_mgr = luabridge::getGlobal (L, "manager");
1078 lua.do_command ("manager = nil"); // hide it.
1079 lua.do_command ("collectgarbage()");
1081 _lua_add_action = new luabridge::LuaRef(lua_mgr["add"]);
1082 _lua_del_action = new luabridge::LuaRef(lua_mgr["remove"]);
1083 _lua_get_action = new luabridge::LuaRef(lua_mgr["get"]);
1084 _lua_call_action = new luabridge::LuaRef(lua_mgr["call"]);
1085 _lua_render_icon = new luabridge::LuaRef(lua_mgr["icon"]);
1086 _lua_save = new luabridge::LuaRef(lua_mgr["save"]);
1087 _lua_load = new luabridge::LuaRef(lua_mgr["restore"]);
1088 _lua_clear = new luabridge::LuaRef(lua_mgr["clear"]);
1090 } catch (luabridge::LuaException const& e) {
1091 fatal << string_compose (_("programming error: %1"),
1092 X_("Failed to setup Lua action interpreter"))
1094 abort(); /*NOTREACHED*/
1097 register_classes (L);
1099 luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
1100 lua_setglobal (L, "Editor");
1103 void LuaInstance::set_session (Session* s)
1105 SessionHandlePtr::set_session (s);
1110 lua_State* L = lua.getState();
1111 LuaBindings::set_session (L, _session);
1113 for (LuaCallbackMap::iterator i = _callbacks.begin(); i != _callbacks.end(); ++i) {
1114 i->second->set_session (s);
1116 point_one_second_connection = Timers::rapid_connect (sigc::mem_fun(*this, & LuaInstance::every_point_one_seconds));
1120 LuaInstance::session_going_away ()
1122 ENSURE_GUI_THREAD (*this, &LuaInstance::session_going_away);
1123 point_one_second_connection.disconnect ();
1126 for (int i = 0; i < 9; ++i) {
1127 ActionChanged (i, ""); /* EMIT SIGNAL */
1129 SessionHandlePtr::session_going_away ();
1132 lua_State* L = lua.getState();
1133 LuaBindings::set_session (L, _session);
1134 lua.do_command ("collectgarbage();");
1138 LuaInstance::every_point_one_seconds ()
1140 LuaTimerDS (); // emit signal
1144 LuaInstance::set_state (const XMLNode& node)
1148 if ((child = find_named_node (node, "ActionScript"))) {
1149 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
1150 if (!(*n)->is_content ()) { continue; }
1152 guchar* buf = g_base64_decode ((*n)->content ().c_str (), &size);
1154 (*_lua_load)(std::string ((const char*)buf, size));
1155 } catch (luabridge::LuaException const& e) {
1156 cerr << "LuaException:" << e.what () << endl;
1158 for (int i = 0; i < 9; ++i) {
1160 if (lua_action_name (i, name)) {
1161 ActionChanged (i, name); /* EMIT SIGNAL */
1168 if ((child = find_named_node (node, "ActionHooks"))) {
1169 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
1171 LuaCallbackPtr p (new LuaCallback (_session, *(*n)));
1172 _callbacks.insert (std::make_pair(p->id(), p));
1173 p->drop_callback.connect (_slotcon, MISSING_INVALIDATOR, boost::bind (&LuaInstance::unregister_lua_slot, this, p->id()), gui_context());
1174 SlotChanged (p->id(), p->name(), p->signals()); /* EMIT SIGNAL */
1175 } catch (luabridge::LuaException const& e) {
1176 cerr << "LuaException:" << e.what () << endl;
1185 LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id)
1188 std::string param_function = "action_params";
1189 std::vector<std::string> reg;
1192 case LuaScriptInfo::EditorAction:
1193 reg = lua_action_names ();
1194 title = _("Add Lua Action");
1196 case LuaScriptInfo::EditorHook:
1197 reg = lua_slot_names ();
1198 title = _("Add Lua Callback Hook");
1200 case LuaScriptInfo::Session:
1204 reg = _session->registered_lua_functions ();
1205 title = _("Add Lua Session Script");
1206 param_function = "sess_params";
1212 LuaScriptInfoPtr spi;
1213 ScriptSelector ss (title, type);
1214 switch (ss.run ()) {
1215 case Gtk::RESPONSE_ACCEPT:
1223 std::string script = "";
1226 script = Glib::file_get_contents (spi->path);
1227 } catch (Glib::FileError e) {
1228 string msg = string_compose (_("Cannot read script '%1': %2"), spi->path, e.what());
1229 Gtk::MessageDialog am (msg);
1234 LuaScriptParamList lsp = LuaScriptParams::script_params (spi, param_function);
1236 ScriptParameterDialog spd (_("Set Script Parameters"), spi, reg, lsp);
1238 if (!spd.need_interation ()) {
1239 switch (spd.run ()) {
1240 case Gtk::RESPONSE_ACCEPT:
1247 LuaScriptParamPtr lspp (new LuaScriptParam("x-script-origin", "", spi->path, false));
1248 lsp.push_back (lspp);
1251 case LuaScriptInfo::EditorAction:
1252 return set_lua_action (id, spd.name(), script, lsp);
1254 case LuaScriptInfo::EditorHook:
1255 return register_lua_slot (spd.name(), script, lsp);
1257 case LuaScriptInfo::Session:
1259 _session->register_lua_function (spd.name(), script, lsp);
1260 } catch (luabridge::LuaException const& e) {
1261 string msg = string_compose (_("Session script '%1' instantiation failed: %2"), spd.name(), e.what ());
1262 Gtk::MessageDialog am (msg);
1264 } catch (SessionException e) {
1265 string msg = string_compose (_("Loading Session script '%1' failed: %2"), spd.name(), e.what ());
1266 Gtk::MessageDialog am (msg);
1276 LuaInstance::get_action_state ()
1280 luabridge::LuaRef savedstate ((*_lua_save)());
1281 saved = savedstate.cast<std::string>();
1283 lua.collect_garbage ();
1285 gchar* b64 = g_base64_encode ((const guchar*)saved.c_str (), saved.size ());
1286 std::string b64s (b64);
1289 XMLNode* script_node = new XMLNode (X_("ActionScript"));
1290 script_node->set_property (X_("lua"), LUA_VERSION);
1291 script_node->add_content (b64s);
1293 return *script_node;
1297 LuaInstance::get_hook_state ()
1299 XMLNode* script_node = new XMLNode (X_("ActionHooks"));
1300 for (LuaCallbackMap::const_iterator i = _callbacks.begin(); i != _callbacks.end(); ++i) {
1301 script_node->add_child_nocopy (i->second->get_state ());
1303 return *script_node;
1307 LuaInstance::call_action (const int id)
1310 (*_lua_call_action)(id + 1);
1311 lua.collect_garbage_step ();
1312 } catch (luabridge::LuaException const& e) {
1313 cerr << "LuaException:" << e.what () << endl;
1318 LuaInstance::render_action_icon (cairo_t* cr, int w, int h, uint32_t c, void* i) {
1319 int ii = reinterpret_cast<uintptr_t> (i);
1320 instance()->render_icon (ii, cr, w, h, c);
1324 LuaInstance::render_icon (int i, cairo_t* cr, int w, int h, uint32_t clr)
1326 Cairo::Context ctx (cr);
1328 (*_lua_render_icon)(i + 1, (Cairo::Context *)&ctx, w, h, clr);
1329 } catch (luabridge::LuaException const& e) {
1330 cerr << "LuaException:" << e.what () << endl;
1335 LuaInstance::set_lua_action (
1337 const std::string& name,
1338 const std::string& script,
1339 const LuaScriptParamList& args)
1342 lua_State* L = lua.getState();
1343 // get bytcode of factory-function in a sandbox
1344 // (don't allow scripts to interfere)
1345 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
1346 const std::string& iconfunc = LuaScripting::get_factory_bytecode (script, "icon", "icn");
1347 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
1348 for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
1349 if ((*i)->optional && !(*i)->is_set) { continue; }
1350 tbl_arg[(*i)->name] = (*i)->value;
1352 (*_lua_add_action)(id + 1, name, script, bytecode, iconfunc, tbl_arg);
1353 ActionChanged (id, name); /* EMIT SIGNAL */
1354 } catch (luabridge::LuaException const& e) {
1355 cerr << "LuaException:" << e.what () << endl;
1358 _session->set_dirty ();
1363 LuaInstance::remove_lua_action (const int id)
1366 (*_lua_del_action)(id + 1);
1367 } catch (luabridge::LuaException const& e) {
1368 cerr << "LuaException:" << e.what () << endl;
1371 ActionChanged (id, ""); /* EMIT SIGNAL */
1372 _session->set_dirty ();
1377 LuaInstance::lua_action_name (const int id, std::string& rv)
1380 luabridge::LuaRef ref ((*_lua_get_action)(id + 1));
1384 if (ref["name"].isString()) {
1385 rv = ref["name"].cast<std::string>();
1389 } catch (luabridge::LuaException const& e) {
1390 cerr << "LuaException:" << e.what () << endl;
1396 std::vector<std::string>
1397 LuaInstance::lua_action_names ()
1399 std::vector<std::string> rv;
1400 for (int i = 0; i < 9; ++i) {
1402 if (lua_action_name (i, name)) {
1403 rv.push_back (name);
1410 LuaInstance::lua_action_has_icon (const int id)
1413 luabridge::LuaRef ref ((*_lua_get_action)(id + 1));
1417 if (ref["icon"].isBoolean()) {
1418 return ref["icon"].cast<bool>();
1420 } catch (luabridge::LuaException const& e) {
1421 cerr << "LuaException:" << e.what () << endl;
1427 LuaInstance::lua_action (const int id, std::string& name, std::string& script, LuaScriptParamList& args)
1430 luabridge::LuaRef ref ((*_lua_get_action)(id + 1));
1434 if (!ref["name"].isString()) {
1437 if (!ref["script"].isString()) {
1440 if (!ref["args"].isTable()) {
1443 name = ref["name"].cast<std::string>();
1444 script = ref["script"].cast<std::string>();
1447 LuaScriptInfoPtr lsi = LuaScripting::script_info (script);
1451 args = LuaScriptParams::script_params (lsi, "action_params");
1452 luabridge::LuaRef rargs (ref["args"]);
1453 LuaScriptParams::ref_to_params (args, &rargs);
1455 } catch (luabridge::LuaException const& e) {
1456 cerr << "LuaException:" << e.what () << endl;
1463 LuaInstance::register_lua_slot (const std::string& name, const std::string& script, const ARDOUR::LuaScriptParamList& args)
1465 /* parse script, get ActionHook(s) from script */
1469 l.Print.connect (&_lua_print);
1470 lua_State* L = l.getState();
1472 l.do_command ("function ardour () end");
1473 l.do_command (script);
1474 luabridge::LuaRef signals = luabridge::getGlobal (L, "signals");
1475 if (signals.isFunction()) {
1478 } catch (luabridge::LuaException const& e) {
1479 cerr << "LuaException:" << e.what () << endl;
1483 cerr << "Script registered no hooks." << endl;
1487 /* register script w/args, get entry-point / ID */
1490 LuaCallbackPtr p (new LuaCallback (_session, name, script, ah, args));
1491 _callbacks.insert (std::make_pair(p->id(), p));
1492 p->drop_callback.connect (_slotcon, MISSING_INVALIDATOR, boost::bind (&LuaInstance::unregister_lua_slot, this, p->id()), gui_context());
1493 SlotChanged (p->id(), p->name(), p->signals()); /* EMIT SIGNAL */
1495 } catch (luabridge::LuaException const& e) {
1496 cerr << "LuaException:" << e.what () << endl;
1498 _session->set_dirty ();
1503 LuaInstance::unregister_lua_slot (const PBD::ID& id)
1505 LuaCallbackMap::iterator i = _callbacks.find (id);
1506 if (i != _callbacks.end()) {
1507 SlotChanged (id, "", ActionHook()); /* EMIT SIGNAL */
1508 _callbacks.erase (i);
1511 _session->set_dirty ();
1515 std::vector<PBD::ID>
1516 LuaInstance::lua_slots () const
1518 std::vector<PBD::ID> rv;
1519 for (LuaCallbackMap::const_iterator i = _callbacks.begin(); i != _callbacks.end(); ++i) {
1520 rv.push_back (i->first);
1526 LuaInstance::lua_slot_name (const PBD::ID& id, std::string& name) const
1528 LuaCallbackMap::const_iterator i = _callbacks.find (id);
1529 if (i != _callbacks.end()) {
1530 name = i->second->name();
1536 std::vector<std::string>
1537 LuaInstance::lua_slot_names () const
1539 std::vector<std::string> rv;
1540 std::vector<PBD::ID> ids = lua_slots();
1541 for (std::vector<PBD::ID>::const_iterator i = ids.begin(); i != ids.end(); ++i) {
1543 if (lua_slot_name (*i, name)) {
1544 rv.push_back (name);
1551 LuaInstance::lua_slot (const PBD::ID& id, std::string& name, std::string& script, ActionHook& ah, ARDOUR::LuaScriptParamList& args)
1553 LuaCallbackMap::const_iterator i = _callbacks.find (id);
1554 if (i == _callbacks.end()) {
1555 return false; // error
1557 return i->second->lua_slot (name, script, ah, args);
1560 ///////////////////////////////////////////////////////////////////////////////
1562 LuaCallback::LuaCallback (Session *s,
1563 const std::string& name,
1564 const std::string& script,
1565 const ActionHook& ah,
1566 const ARDOUR::LuaScriptParamList& args)
1567 : SessionHandlePtr (s)
1572 // TODO: allow to reference object (e.g region)
1575 lua_State* L = lua.getState();
1576 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
1577 for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
1578 if ((*i)->optional && !(*i)->is_set) { continue; }
1579 tbl_arg[(*i)->name] = (*i)->value;
1583 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
1584 (*_lua_add)(name, script, bytecode, tbl_arg);
1585 } catch (luabridge::LuaException const& e) {
1586 cerr << "LuaException:" << e.what () << endl;
1587 throw failed_constructor ();
1594 LuaCallback::LuaCallback (Session *s, XMLNode & node)
1595 : SessionHandlePtr (s)
1597 XMLNode* child = NULL;
1598 if (node.name() != X_("LuaCallback")
1599 || !node.property ("signals")
1600 || !node.property ("id")
1601 || !node.property ("name")) {
1602 throw failed_constructor ();
1605 for (XMLNodeList::const_iterator n = node.children ().begin (); n != node.children ().end (); ++n) {
1606 if (!(*n)->is_content ()) { continue; }
1611 throw failed_constructor ();
1616 _id = PBD::ID (node.property ("id")->value ());
1617 _name = node.property ("name")->value ();
1618 _signals = ActionHook (node.property ("signals")->value ());
1621 guchar* buf = g_base64_decode (child->content ().c_str (), &size);
1623 (*_lua_load)(std::string ((const char*)buf, size));
1624 } catch (luabridge::LuaException const& e) {
1625 cerr << "LuaException:" << e.what () << endl;
1632 LuaCallback::~LuaCallback ()
1642 LuaCallback::get_state (void)
1646 luabridge::LuaRef savedstate ((*_lua_save)());
1647 saved = savedstate.cast<std::string>();
1650 lua.collect_garbage (); // this may be expensive:
1651 /* Editor::instant_save() calls Editor::get_state() which
1652 * calls LuaInstance::get_hook_state() which in turn calls
1653 * this LuaCallback::get_state() for every registered hook.
1655 * serialize in _lua_save() allocates many small strings
1656 * on the lua-stack, collecting them all may take a ms.
1659 gchar* b64 = g_base64_encode ((const guchar*)saved.c_str (), saved.size ());
1660 std::string b64s (b64);
1663 XMLNode* script_node = new XMLNode (X_("LuaCallback"));
1664 script_node->set_property (X_("lua"), LUA_VERSION);
1665 script_node->set_property (X_("id"), _id.to_s ());
1666 script_node->set_property (X_("name"), _name);
1667 script_node->set_property (X_("signals"), _signals.to_string ());
1668 script_node->add_content (b64s);
1669 return *script_node;
1673 LuaCallback::init (void)
1675 lua.Print.connect (&_lua_print);
1678 "function ScriptManager ()"
1679 " local self = { script = {}, instance = {} }"
1681 " local addinternal = function (n, s, f, a)"
1682 " assert(type(n) == 'string', 'Name must be string')"
1683 " assert(type(s) == 'string', 'Script must be string')"
1684 " assert(type(f) == 'function', 'Factory is a not a function')"
1685 " assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
1686 " self.script = { ['n'] = n, ['s'] = s, ['f'] = f, ['a'] = a }"
1687 " local env = _ENV; env.f = nil env.debug = nil os.exit = nil require = nil dofile = nil loadfile = nil package = nil"
1688 " self.instance = load (string.dump(f, true), nil, nil, env)(a)"
1691 " local call = function (...)"
1692 " if type(self.instance) == 'function' then"
1693 " local status, err = pcall (self.instance, ...)"
1694 " if not status then"
1695 " print ('callback \"'.. self.script['n'] .. '\": ', err)" // error out
1696 " self.script = nil"
1697 " self.instance = nil"
1705 " local add = function (n, s, b, a)"
1706 " assert(type(b) == 'string', 'ByteCode must be string')"
1707 " load (b)()" // assigns f
1708 " assert(type(f) == 'string', 'Assigned ByteCode must be string')"
1709 " addinternal (n, s, load(f), a)"
1712 " local get = function ()"
1713 " if type(self.instance) == 'function' and type(self.script['n']) == 'string' then"
1714 " return { ['name'] = self.script['n'],"
1715 " ['script'] = self.script['s'],"
1716 " ['args'] = self.script['a'] }"
1723 " local function basic_serialize (o)"
1724 " if type(o) == \"number\" then"
1725 " return tostring(o)"
1727 " return string.format(\"%q\", o)"
1731 " local function serialize (name, value)"
1732 " local rv = name .. ' = '"
1733 " if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
1734 " return rv .. basic_serialize(value) .. ' '"
1735 " elseif type(value) == \"table\" then"
1737 " for k,v in pairs(value) do"
1738 " local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
1739 " rv = rv .. serialize(fieldname, v) .. ' '"
1742 " elseif type(value) == \"function\" then"
1743 " return rv .. string.format(\"%q\", string.dump(value, true))"
1744 " elseif type(value) == \"boolean\" then"
1745 " return rv .. tostring (value)"
1747 " error('cannot save a ' .. type(value))"
1753 " local save = function ()"
1754 " return (serialize('s', self.script))"
1757 " local restore = function (state)"
1760 " addinternal (s['n'], s['s'], load(s['f']), s['a'])"
1763 " return { call = call, add = add, get = get,"
1764 " restore = restore, save = save}"
1767 " manager = ScriptManager ()"
1768 " ScriptManager = nil"
1771 lua_State* L = lua.getState();
1774 luabridge::LuaRef lua_mgr = luabridge::getGlobal (L, "manager");
1775 lua.do_command ("manager = nil"); // hide it.
1776 lua.do_command ("collectgarbage()");
1778 _lua_add = new luabridge::LuaRef(lua_mgr["add"]);
1779 _lua_get = new luabridge::LuaRef(lua_mgr["get"]);
1780 _lua_call = new luabridge::LuaRef(lua_mgr["call"]);
1781 _lua_save = new luabridge::LuaRef(lua_mgr["save"]);
1782 _lua_load = new luabridge::LuaRef(lua_mgr["restore"]);
1784 } catch (luabridge::LuaException const& e) {
1785 fatal << string_compose (_("programming error: %1"),
1786 X_("Failed to setup Lua callback interpreter"))
1788 abort(); /*NOTREACHED*/
1791 LuaInstance::register_classes (L);
1793 luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
1794 lua_setglobal (L, "Editor");
1798 LuaCallback::lua_slot (std::string& name, std::string& script, ActionHook& ah, ARDOUR::LuaScriptParamList& args)
1800 // TODO consolidate w/ LuaInstance::lua_action()
1802 luabridge::LuaRef ref = (*_lua_get)();
1806 if (!ref["name"].isString()) {
1809 if (!ref["script"].isString()) {
1812 if (!ref["args"].isTable()) {
1817 name = ref["name"].cast<std::string> ();
1818 script = ref["script"].cast<std::string> ();
1821 LuaScriptInfoPtr lsi = LuaScripting::script_info (script);
1825 args = LuaScriptParams::script_params (lsi, "action_params");
1826 luabridge::LuaRef rargs (ref["args"]);
1827 LuaScriptParams::ref_to_params (args, &rargs);
1829 } catch (luabridge::LuaException const& e) {
1830 cerr << "LuaException:" << e.what () << endl;
1837 LuaCallback::set_session (ARDOUR::Session *s)
1839 SessionHandlePtr::set_session (s);
1845 lua_State* L = lua.getState();
1846 LuaBindings::set_session (L, _session);
1852 LuaCallback::session_going_away ()
1854 ENSURE_GUI_THREAD (*this, &LuaCallback::session_going_away);
1855 lua.do_command ("collectgarbage();");
1857 SessionHandlePtr::session_going_away ();
1860 drop_callback (); /* EMIT SIGNAL */
1864 LuaCallback::reconnect ()
1866 _connections.drop_connections ();
1867 if ((*_lua_get) ().isNil ()) {
1868 drop_callback (); /* EMIT SIGNAL */
1872 // TODO pass object which emits the signal (e.g region)
1874 // save/load bound objects will be tricky.
1875 // Best idea so far is to save/lookup the PBD::ID
1876 // (either use boost::any indirection or templates for bindable
1877 // object types or a switch statement..)
1879 // _session->route_by_id ()
1880 // _session->track_by_diskstream_id ()
1881 // _session->source_by_id ()
1882 // _session->controllable_by_id ()
1883 // _session->processor_by_id ()
1884 // RegionFactory::region_by_id ()
1886 // TODO loop over objects (if any)
1888 reconnect_object ((void*)0);
1891 template <class T> void
1892 LuaCallback::reconnect_object (T obj)
1894 for (uint32_t i = 0; i < LuaSignal::LAST_SIGNAL; ++i) {
1896 #define ENGINE(n,c,p) else if (i == LuaSignal::n) { connect_ ## p (LuaSignal::n, AudioEngine::instance(), &(AudioEngine::instance()->c)); }
1897 #define SESSION(n,c,p) else if (i == LuaSignal::n) { if (_session) { connect_ ## p (LuaSignal::n, _session, &(_session->c)); } }
1898 #define STATIC(n,c,p) else if (i == LuaSignal::n) { connect_ ## p (LuaSignal::n, obj, c); }
1900 # include "luasignal_syms.h"
1902 PBD::fatal << string_compose (_("programming error: %1: %2"), "Impossible LuaSignal type", i) << endmsg;
1903 abort(); /*NOTREACHED*/
1912 template <typename T, typename S> void
1913 LuaCallback::connect_0 (enum LuaSignal::LuaSignal ls, T ref, S *signal) {
1915 _connections, invalidator (*this),
1916 boost::bind (&LuaCallback::proxy_0<T>, this, ls, ref),
1920 template <typename T, typename C1> void
1921 LuaCallback::connect_1 (enum LuaSignal::LuaSignal ls, T ref, PBD::Signal1<void, C1> *signal) {
1923 _connections, invalidator (*this),
1924 boost::bind (&LuaCallback::proxy_1<T, C1>, this, ls, ref, _1),
1928 template <typename T, typename C1, typename C2> void
1929 LuaCallback::connect_2 (enum LuaSignal::LuaSignal ls, T ref, PBD::Signal2<void, C1, C2> *signal) {
1931 _connections, invalidator (*this),
1932 boost::bind (&LuaCallback::proxy_2<T, C1, C2>, this, ls, ref, _1, _2),
1936 template <typename T> void
1937 LuaCallback::proxy_0 (enum LuaSignal::LuaSignal ls, T ref) {
1940 const luabridge::LuaRef& rv ((*_lua_call)((int)ls, ref));
1941 if (! rv.cast<bool> ()) {
1945 /* destroy LuaRef ^^ first before calling drop_callback() */
1947 drop_callback (); /* EMIT SIGNAL */
1951 template <typename T, typename C1> void
1952 LuaCallback::proxy_1 (enum LuaSignal::LuaSignal ls, T ref, C1 a1) {
1955 const luabridge::LuaRef& rv ((*_lua_call)((int)ls, ref, a1));
1956 if (! rv.cast<bool> ()) {
1961 drop_callback (); /* EMIT SIGNAL */
1965 template <typename T, typename C1, typename C2> void
1966 LuaCallback::proxy_2 (enum LuaSignal::LuaSignal ls, T ref, C1 a1, C2 a2) {
1969 const luabridge::LuaRef& rv ((*_lua_call)((int)ls, ref, a1, a2));
1970 if (! rv.cast<bool> ()) {
1975 drop_callback (); /* EMIT SIGNAL */