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 "luainstance.h"
38 #include "luasignal.h"
40 #include "processor_box.h"
41 #include "time_axis_view.h"
42 #include "selection.h"
43 #include "script_selector.h"
45 #include "utils_videotl.h"
50 /** wrap RefPtr< Cairo::ImageSurface >
52 * Image surfaces provide the ability to render to memory buffers either
53 * allocated by cairo or by the calling code. The supported image formats are
54 * those defined in Cairo::Format.
59 * Creates an image surface of the specified format and dimensions. Initially
60 * the surface contents are all 0. (Specifically, within each pixel, each
61 * color or alpha channel belonging to format will be 0. The contents of bits
62 * within a pixel, but not belonging to the given format are undefined).
64 * @param format format of pixels in the surface to create
65 * @param width width of the surface, in pixels
66 * @param height height of the surface, in pixels
68 ImageSurface (Cairo::Format format, int width, int height)
69 : _surface (Cairo::ImageSurface::create (format, width, height))
70 , _ctx (Cairo::Context::create (_surface))
71 , ctx (_ctx->cobj ()) {}
76 * Set this surface as source for another context.
77 * This allows to draw this surface
79 void set_as_source (Cairo::Context* c, int x, int y) {
81 c->set_source (_surface, x, y);
85 * Returns a context object to perform operations on the surface
87 Cairo::Context* context () {
88 return (Cairo::Context *)&ctx;
92 * Returns the stride of the image surface in bytes (or 0 if surface is not
93 * an image surface). The stride is the distance in bytes from the beginning
94 * of one row of the image data to the beginning of the next row.
96 int get_stride () const {
97 return _surface->get_stride ();
100 /** Gets the width of the ImageSurface in pixels */
101 int get_width () const {
102 return _surface->get_width ();
105 /** Gets the height of the ImageSurface in pixels */
106 int get_height () const {
107 return _surface->get_height ();
111 * Get a pointer to the data of the image surface, for direct
112 * inspection or modification.
114 * Return value: a pointer to the image data of this surface or NULL
115 * if @surface is not an image surface.
118 unsigned char* get_data () {
119 return _surface->get_data ();
122 /** Tells cairo to consider the data buffer dirty.
124 * In particular, if you've created an ImageSurface with a data buffer that
125 * you've allocated yourself and you draw to that data buffer using means
126 * other than cairo, you must call mark_dirty() before doing any additional
127 * drawing to that surface with cairo.
129 * Note that if you do draw to the Surface outside of cairo, you must call
130 * flush() before doing the drawing.
133 _surface->mark_dirty ();
136 /** Marks a rectangular area of the given surface dirty.
138 * @param x X coordinate of dirty rectangle
139 * @param y Y coordinate of dirty rectangle
140 * @param width width of dirty rectangle
141 * @param height height of dirty rectangle
143 void mark_dirty (int x, int y, int width, int height) {
144 _surface->mark_dirty (x, y, width, height);
148 Cairo::RefPtr<Cairo::ImageSurface> _surface;
149 Cairo::RefPtr<Cairo::Context> _ctx;
155 /** Create a new PangoLayout Text Display
156 * @param c CairoContext for the layout
157 * @param font_name a font-description e.g. "Mono 8px"
159 PangoLayout (Cairo::Context* c, std::string font_name) {
160 ::PangoLayout* pl = pango_cairo_create_layout (c->cobj ());
161 _layout = Glib::wrap (pl);
162 Pango::FontDescription fd (font_name);
163 _layout->set_font_description (fd);
168 /** Gets the text in the layout. The returned text should not
169 * be freed or modified.
171 * @return The text in the @a layout.
173 std::string get_text () const {
174 return _layout->get_text ();
176 /** Set the text of the layout.
177 * @param text The text for the layout.
179 void set_text (const std::string& text) {
180 _layout->set_text (text);
183 /** Sets the layout text and attribute list from marked-up text (see markup format).
184 * Replaces the current text and attribute list.
185 * @param markup Some marked-up text.
187 void set_markup (const std::string& markup) {
188 _layout->set_markup (markup);
191 /** Sets the width to which the lines of the Pango::Layout should wrap or
192 * ellipsized. The default value is -1: no width set.
194 * @param width The desired width in Pango units, or -1 to indicate that no
195 * wrapping or ellipsization should be performed.
197 void set_width (int width) {
198 _layout->set_width (width * PANGO_SCALE);
201 /** Gets the width to which the lines of the Pango::Layout should wrap.
203 * @return The width in Pango units, or -1 if no width set.
205 int get_width () const {
206 return _layout->get_width () / PANGO_SCALE;
209 /** Sets the type of ellipsization being performed for @a layout.
210 * Depending on the ellipsization mode @a ellipsize text is
211 * removed from the start, middle, or end of text so they
212 * fit within the width and height of layout set with
213 * set_width() and set_height().
215 * If the layout contains characters such as newlines that
216 * force it to be layed out in multiple paragraphs, then whether
217 * each paragraph is ellipsized separately or the entire layout
218 * is ellipsized as a whole depends on the set height of the layout.
219 * See set_height() for details.
221 * @param ellipsize The new ellipsization mode for @a layout.
223 void set_ellipsize (Pango::EllipsizeMode ellipsize) {
224 _layout->set_ellipsize (ellipsize);
227 /** Gets the type of ellipsization being performed for @a layout.
228 * See set_ellipsize()
230 * @return The current ellipsization mode for @a layout.
232 * Use is_ellipsized() to query whether any paragraphs
233 * were actually ellipsized.
235 Pango::EllipsizeMode get_ellipsize () const {
236 return _layout->get_ellipsize ();
239 /** Queries whether the layout had to ellipsize any paragraphs.
241 * This returns <tt>true</tt> if the ellipsization mode for @a layout
242 * is not Pango::ELLIPSIZE_NONE, a positive width is set on @a layout,
243 * and there are paragraphs exceeding that width that have to be
246 * @return <tt>true</tt> if any paragraphs had to be ellipsized, <tt>false</tt>
249 bool is_ellipsized () const {
250 return _layout->is_ellipsized ();
253 /** Sets the wrap mode; the wrap mode only has effect if a width
254 * is set on the layout with set_width().
255 * To turn off wrapping, set the width to -1.
257 * @param wrap The wrap mode.
259 void set_wrap (Pango::WrapMode wrap) {
260 _layout->set_width (wrap);
263 /** Gets the wrap mode for the layout.
265 * Use is_wrapped() to query whether any paragraphs
266 * were actually wrapped.
268 * @return Active wrap mode.
270 Pango::WrapMode get_wrap () const {
271 return _layout->get_wrap ();
274 /** Queries whether the layout had to wrap any paragraphs.
276 * This returns <tt>true</tt> if a positive width is set on @a layout,
277 * ellipsization mode of @a layout is set to Pango::ELLIPSIZE_NONE,
278 * and there are paragraphs exceeding the layout width that have
281 * @return <tt>true</tt> if any paragraphs had to be wrapped, <tt>false</tt>
284 bool is_wrapped () const {
285 return _layout->is_wrapped ();
288 /** Determines the logical width and height of a Pango::Layout
291 int get_pixel_size (lua_State *L) {
293 _layout->get_pixel_size (width, height);
294 luabridge::Stack<int>::push (L, width);
295 luabridge::Stack<int>::push (L, height);
300 /** Draws a Layout in the specified Cairo @a context. The top-left
301 * corner of the Layout will be drawn at the current point of the
304 * @param context A Cairo context.
306 void show_in_cairo_context (Cairo::Context* c) {
307 pango_cairo_update_layout (c->cobj (), _layout->gobj());
308 pango_cairo_show_layout (c->cobj (), _layout->gobj());
312 Glib::RefPtr<Pango::Layout> _layout;
317 ////////////////////////////////////////////////////////////////////////////////
319 namespace LuaSignal {
321 #define STATIC(name,c,p) else if (!strcmp(type, #name)) {return name;}
322 #define SESSION(name,c,p) else if (!strcmp(type, #name)) {return name;}
323 #define ENGINE(name,c,p) else if (!strcmp(type, #name)) {return name;}
326 str2luasignal (const std::string &str) {
327 const char* type = str.c_str();
329 # include "luasignal_syms.h"
331 PBD::fatal << string_compose (_("programming error: %1: %2"), "Impossible LuaSignal type", str) << endmsg;
332 abort(); /*NOTREACHED*/
339 #define STATIC(name,c,p) N_(#name),
340 #define SESSION(name,c,p) N_(#name),
341 #define ENGINE(name,c,p) N_(#name),
342 const char *luasignalstr[] = {
343 # include "luasignal_syms.h"
353 /** special cases for Ardour's Mixer UI */
356 ProcessorBox::ProcSelection
357 processor_selection () {
358 return ProcessorBox::current_processor_selection ();
363 ////////////////////////////////////////////////////////////////////////////////
365 #define xstr(s) stringify(s)
366 #define stringify(s) #s
368 using namespace ARDOUR;
370 PBD::Signal0<void> LuaInstance::LuaTimerDS;
373 LuaInstance::register_hooks (lua_State* L)
376 #define ENGINE(name,c,p) .addConst (stringify(name), (LuaSignal::LuaSignal)LuaSignal::name)
377 #define STATIC(name,c,p) .addConst (stringify(name), (LuaSignal::LuaSignal)LuaSignal::name)
378 #define SESSION(name,c,p) .addConst (stringify(name), (LuaSignal::LuaSignal)LuaSignal::name)
379 luabridge::getGlobalNamespace (L)
380 .beginNamespace ("LuaSignal")
381 # include "luasignal_syms.h"
387 luabridge::getGlobalNamespace (L)
388 .beginNamespace ("LuaSignal")
389 .beginStdBitSet <LuaSignal::LAST_SIGNAL> ("Set")
395 LuaInstance::bind_cairo (lua_State* L)
397 /* std::vector<double> for set_dash()
398 * for Windows (DLL, .exe) this needs to be bound in the same memory context as "Cairo".
400 * The std::vector<> argument in set_dash() has a fixed address in ardour.exe, while
401 * the address of the one in libardour.dll is mapped when loading the .dll
403 * see LuaBindings::set_session() for a detailed explanation
405 luabridge::getGlobalNamespace (L)
406 .beginNamespace ("C")
407 .beginStdVector <double> ("DoubleVector")
411 luabridge::getGlobalNamespace (L)
412 .beginNamespace ("Cairo")
413 .beginClass <Cairo::Context> ("Context")
414 .addFunction ("save", &Cairo::Context::save)
415 .addFunction ("restore", &Cairo::Context::restore)
416 .addFunction ("set_operator", &Cairo::Context::set_operator)
417 //.addFunction ("set_source", &Cairo::Context::set_operator) // needs RefPtr
418 .addFunction ("set_source_rgb", &Cairo::Context::set_source_rgb)
419 .addFunction ("set_source_rgba", &Cairo::Context::set_source_rgba)
420 .addFunction ("set_line_width", &Cairo::Context::set_line_width)
421 .addFunction ("set_line_cap", &Cairo::Context::set_line_cap)
422 .addFunction ("set_line_join", &Cairo::Context::set_line_join)
423 .addFunction ("set_dash", (void (Cairo::Context::*)(const std::vector<double>&, double))&Cairo::Context::set_dash)
424 .addFunction ("unset_dash", &Cairo::Context::unset_dash)
425 .addFunction ("translate", &Cairo::Context::translate)
426 .addFunction ("scale", &Cairo::Context::scale)
427 .addFunction ("rotate", &Cairo::Context::rotate)
428 .addFunction ("begin_new_path", &Cairo::Context::begin_new_path)
429 .addFunction ("begin_new_sub_path", &Cairo::Context::begin_new_sub_path)
430 .addFunction ("move_to", &Cairo::Context::move_to)
431 .addFunction ("line_to", &Cairo::Context::line_to)
432 .addFunction ("curve_to", &Cairo::Context::curve_to)
433 .addFunction ("arc", &Cairo::Context::arc)
434 .addFunction ("arc_negative", &Cairo::Context::arc_negative)
435 .addFunction ("rel_move_to", &Cairo::Context::rel_move_to)
436 .addFunction ("rel_line_to", &Cairo::Context::rel_line_to)
437 .addFunction ("rel_curve_to", &Cairo::Context::rel_curve_to)
438 .addFunction ("rectangle", (void (Cairo::Context::*)(double, double, double, double))&Cairo::Context::rectangle)
439 .addFunction ("close_path", &Cairo::Context::close_path)
440 .addFunction ("paint", &Cairo::Context::paint)
441 .addFunction ("paint_with_alpha", &Cairo::Context::paint_with_alpha)
442 .addFunction ("stroke", &Cairo::Context::stroke)
443 .addFunction ("stroke_preserve", &Cairo::Context::stroke_preserve)
444 .addFunction ("fill", &Cairo::Context::fill)
445 .addFunction ("fill_preserve", &Cairo::Context::fill_preserve)
446 .addFunction ("reset_clip", &Cairo::Context::reset_clip)
447 .addFunction ("clip", &Cairo::Context::clip)
448 .addFunction ("clip_preserve", &Cairo::Context::clip_preserve)
449 .addFunction ("set_font_size", &Cairo::Context::set_font_size)
450 .addFunction ("show_text", &Cairo::Context::show_text)
453 // LineCap, LineJoin, Operator
454 .beginNamespace ("LineCap")
455 .addConst ("Butt", CAIRO_LINE_CAP_BUTT)
456 .addConst ("Round", CAIRO_LINE_CAP_ROUND)
457 .addConst ("Square", CAIRO_LINE_CAP_SQUARE)
460 .beginNamespace ("LineJoin")
461 .addConst ("Miter", CAIRO_LINE_JOIN_MITER)
462 .addConst ("Round", CAIRO_LINE_JOIN_ROUND)
463 .addConst ("Bevel", CAIRO_LINE_JOIN_BEVEL)
466 .beginNamespace ("Operator")
467 .addConst ("Clear", CAIRO_OPERATOR_CLEAR)
468 .addConst ("Source", CAIRO_OPERATOR_SOURCE)
469 .addConst ("Over", CAIRO_OPERATOR_OVER)
470 .addConst ("Add", CAIRO_OPERATOR_ADD)
473 .beginNamespace ("Format")
474 .addConst ("ARGB32", CAIRO_FORMAT_ARGB32)
475 .addConst ("RGB24", CAIRO_FORMAT_RGB24)
478 .beginClass <LuaCairo::ImageSurface> ("ImageSurface")
479 .addConstructor <void (*) (Cairo::Format, int, int)> ()
480 .addFunction ("set_as_source", &LuaCairo::ImageSurface::set_as_source)
481 .addFunction ("context", &LuaCairo::ImageSurface::context)
482 .addFunction ("get_stride", &LuaCairo::ImageSurface::get_stride)
483 .addFunction ("get_width", &LuaCairo::ImageSurface::get_width)
484 .addFunction ("get_height", &LuaCairo::ImageSurface::get_height)
485 //.addFunction ("get_data", &LuaCairo::ImageSurface::get_data) // uint8_t* array is n/a
488 .beginClass <LuaCairo::PangoLayout> ("PangoLayout")
489 .addConstructor <void (*) (Cairo::Context*, std::string)> ()
490 .addCFunction ("get_pixel_size", &LuaCairo::PangoLayout::get_pixel_size)
491 .addFunction ("get_text", &LuaCairo::PangoLayout::get_text)
492 .addFunction ("set_text", &LuaCairo::PangoLayout::set_text)
493 .addFunction ("show_in_cairo_context", &LuaCairo::PangoLayout::show_in_cairo_context)
494 .addFunction ("set_markup", &LuaCairo::PangoLayout::set_markup)
495 .addFunction ("set_width", &LuaCairo::PangoLayout::set_width)
496 .addFunction ("set_ellipsize", &LuaCairo::PangoLayout::set_ellipsize)
497 .addFunction ("get_ellipsize", &LuaCairo::PangoLayout::get_ellipsize)
498 .addFunction ("is_ellipsized", &LuaCairo::PangoLayout::is_ellipsized)
499 .addFunction ("set_wrap", &LuaCairo::PangoLayout::set_wrap)
500 .addFunction ("get_wrap", &LuaCairo::PangoLayout::get_wrap)
501 .addFunction ("is_wrapped", &LuaCairo::PangoLayout::is_wrapped)
505 .beginNamespace ("EllipsizeMode")
506 .addConst ("None", Pango::ELLIPSIZE_NONE)
507 .addConst ("Start", Pango::ELLIPSIZE_START)
508 .addConst ("Middle", Pango::ELLIPSIZE_MIDDLE)
509 .addConst ("End", Pango::ELLIPSIZE_END)
512 .beginNamespace ("WrapMode")
513 .addConst ("Word", Pango::WRAP_WORD)
514 .addConst ("Char", Pango::WRAP_CHAR)
515 .addConst ("WordChar", Pango::WRAP_WORD_CHAR)
520 /* Lua/cairo bindings operate on Cairo::Context, there is no Cairo::RefPtr wrapper [yet].
521 one can work around this as follows:
524 LuaInstance::register_classes (lua.getState());
526 "function render (ctx)"
527 " ctx:rectangle (0, 0, 100, 100)"
528 " ctx:set_source_rgba (0.1, 1.0, 0.1, 1.0)"
533 Cairo::RefPtr<Cairo::Context> context = get_window ()->create_cairo_context ();
534 Cairo::Context ctx (context->cobj ());
536 luabridge::LuaRef lua_render = luabridge::getGlobal (lua.getState(), "render");
537 lua_render ((Cairo::Context *)&ctx);
544 LuaInstance::register_classes (lua_State* L)
546 LuaBindings::stddef (L);
547 LuaBindings::common (L);
548 LuaBindings::session (L);
549 LuaBindings::osc (L);
554 luabridge::getGlobalNamespace (L)
555 .beginNamespace ("ArdourUI")
557 .addFunction ("http_get", (std::string (*)(const std::string&))&ArdourCurl::http_get)
559 .addFunction ("processor_selection", &LuaMixer::processor_selection)
561 .beginStdList <ArdourMarker*> ("ArdourMarkerList")
564 .beginClass <ArdourMarker> ("ArdourMarker")
565 .addFunction ("name", &ArdourMarker::name)
566 .addFunction ("position", &ArdourMarker::position)
567 .addFunction ("_type", &ArdourMarker::type)
571 .beginClass <AxisView> ("AxisView")
573 .deriveClass <TimeAxisView, AxisView> ("TimeAxisView")
575 .deriveClass <RouteTimeAxisView, TimeAxisView> ("RouteTimeAxisView")
579 .beginClass <RegionSelection> ("RegionSelection")
580 .addFunction ("clear_all", &RegionSelection::clear_all)
581 .addFunction ("start", &RegionSelection::start)
582 .addFunction ("end_frame", &RegionSelection::end_frame)
583 .addFunction ("n_midi_regions", &RegionSelection::n_midi_regions)
584 .addFunction ("regionlist", &RegionSelection::regionlist) // XXX check windows binding (libardour)
587 .deriveClass <TimeSelection, std::list<ARDOUR::AudioRange> > ("TimeSelection")
588 .addFunction ("start", &TimeSelection::start)
589 .addFunction ("end_frame", &TimeSelection::end_frame)
590 .addFunction ("length", &TimeSelection::length)
593 .deriveClass <MarkerSelection, std::list<ArdourMarker*> > ("MarkerSelection")
596 .beginClass <TrackViewList> ("TrackViewList")
597 .addFunction ("routelist", &TrackViewList::routelist) // XXX check windows binding (libardour)
600 .deriveClass <TrackSelection, TrackViewList> ("TrackSelection")
603 .beginClass <Selection> ("Selection")
604 .addFunction ("clear", &Selection::clear)
605 .addFunction ("clear_all", &Selection::clear_all)
606 .addFunction ("empty", &Selection::empty)
607 .addData ("tracks", &Selection::tracks)
608 .addData ("regions", &Selection::regions)
609 .addData ("time", &Selection::time)
610 .addData ("markers", &Selection::markers)
612 .addData ("lines", &Selection::lines)
613 .addData ("playlists", &Selection::playlists)
614 .addData ("points", &Selection::points)
615 .addData ("midi_regions", &Selection::midi_regions)
616 .addData ("midi_notes", &Selection::midi_notes) // cut buffer only
620 .beginClass <PublicEditor> ("Editor")
621 .addFunction ("snap_type", &PublicEditor::snap_type)
622 .addFunction ("snap_mode", &PublicEditor::snap_mode)
623 .addFunction ("set_snap_mode", &PublicEditor::set_snap_mode)
624 .addFunction ("set_snap_threshold", &PublicEditor::set_snap_threshold)
626 .addFunction ("undo", &PublicEditor::undo)
627 .addFunction ("redo", &PublicEditor::redo)
629 .addFunction ("set_mouse_mode", &PublicEditor::set_mouse_mode)
630 .addFunction ("current_mouse_mode", &PublicEditor::current_mouse_mode)
632 .addFunction ("consider_auditioning", &PublicEditor::consider_auditioning)
634 .addFunction ("new_region_from_selection", &PublicEditor::new_region_from_selection)
635 .addFunction ("separate_region_from_selection", &PublicEditor::separate_region_from_selection)
636 .addFunction ("pixel_to_sample", &PublicEditor::pixel_to_sample)
637 .addFunction ("sample_to_pixel", &PublicEditor::sample_to_pixel)
639 .addFunction ("get_selection", &PublicEditor::get_selection)
640 .addFunction ("get_cut_buffer", &PublicEditor::get_cut_buffer)
641 .addRefFunction ("get_selection_extents", &PublicEditor::get_selection_extents)
643 .addFunction ("play_selection", &PublicEditor::play_selection)
644 .addFunction ("play_with_preroll", &PublicEditor::play_with_preroll)
645 .addFunction ("maybe_locate_with_edit_preroll", &PublicEditor::maybe_locate_with_edit_preroll)
646 .addFunction ("goto_nth_marker", &PublicEditor::goto_nth_marker)
648 .addFunction ("add_location_from_playhead_cursor", &PublicEditor::add_location_from_playhead_cursor)
649 .addFunction ("remove_location_at_playhead_cursor", &PublicEditor::remove_location_at_playhead_cursor)
651 .addFunction ("set_show_measures", &PublicEditor::set_show_measures)
652 .addFunction ("show_measures", &PublicEditor::show_measures)
653 .addFunction ("remove_tracks", &PublicEditor::remove_tracks)
655 .addFunction ("set_loop_range", &PublicEditor::set_loop_range)
656 .addFunction ("set_punch_range", &PublicEditor::set_punch_range)
658 .addFunction ("effective_mouse_mode", &PublicEditor::effective_mouse_mode)
660 .addRefFunction ("do_import", &PublicEditor::do_import)
661 .addRefFunction ("do_embed", &PublicEditor::do_embed)
663 .addFunction ("export_audio", &PublicEditor::export_audio)
664 .addFunction ("stem_export", &PublicEditor::stem_export)
665 .addFunction ("export_selection", &PublicEditor::export_selection)
666 .addFunction ("export_range", &PublicEditor::export_range)
668 .addFunction ("set_zoom_focus", &PublicEditor::set_zoom_focus)
669 .addFunction ("get_zoom_focus", &PublicEditor::get_zoom_focus)
670 .addFunction ("get_current_zoom", &PublicEditor::get_current_zoom)
671 .addFunction ("reset_zoom", &PublicEditor::reset_zoom)
673 #if 0 // These need TimeAxisView* which isn't exposed, yet
674 .addFunction ("playlist_selector", &PublicEditor::playlist_selector)
675 .addFunction ("clear_playlist", &PublicEditor::clear_playlist)
676 .addFunction ("new_playlists", &PublicEditor::new_playlists)
677 .addFunction ("copy_playlists", &PublicEditor::copy_playlists)
678 .addFunction ("clear_playlists", &PublicEditor::clear_playlists)
681 .addFunction ("select_all_tracks", &PublicEditor::select_all_tracks)
682 .addFunction ("deselect_all", &PublicEditor::deselect_all)
684 .addFunction ("set_selected_track", &PublicEditor::set_selected_track)
685 .addFunction ("set_selected_mixer_strip", &PublicEditor::set_selected_mixer_strip)
686 .addFunction ("hide_track_in_display", &PublicEditor::hide_track_in_display)
688 .addFunction ("set_stationary_playhead", &PublicEditor::set_stationary_playhead)
689 .addFunction ("stationary_playhead", &PublicEditor::stationary_playhead)
690 .addFunction ("set_follow_playhead", &PublicEditor::set_follow_playhead)
691 .addFunction ("follow_playhead", &PublicEditor::follow_playhead)
693 .addFunction ("dragging_playhead", &PublicEditor::dragging_playhead)
694 .addFunction ("leftmost_sample", &PublicEditor::leftmost_sample)
695 .addFunction ("current_page_samples", &PublicEditor::current_page_samples)
696 .addFunction ("visible_canvas_height", &PublicEditor::visible_canvas_height)
697 .addFunction ("temporal_zoom_step", &PublicEditor::temporal_zoom_step)
698 //.addFunction ("ensure_time_axis_view_is_visible", &PublicEditor::ensure_time_axis_view_is_visible)
699 .addFunction ("override_visible_track_count", &PublicEditor::override_visible_track_count)
701 .addFunction ("scroll_tracks_down_line", &PublicEditor::scroll_tracks_down_line)
702 .addFunction ("scroll_tracks_up_line", &PublicEditor::scroll_tracks_up_line)
703 .addFunction ("scroll_down_one_track", &PublicEditor::scroll_down_one_track)
704 .addFunction ("scroll_up_one_track", &PublicEditor::scroll_up_one_track)
706 .addFunction ("reset_x_origin", &PublicEditor::reset_x_origin)
707 .addFunction ("get_y_origin", &PublicEditor::get_y_origin)
708 .addFunction ("reset_y_origin", &PublicEditor::reset_y_origin)
710 .addFunction ("remove_last_capture", &PublicEditor::remove_last_capture)
712 .addFunction ("maximise_editing_space", &PublicEditor::maximise_editing_space)
713 .addFunction ("restore_editing_space", &PublicEditor::restore_editing_space)
714 .addFunction ("toggle_meter_updating", &PublicEditor::toggle_meter_updating)
716 //.addFunction ("get_preferred_edit_position", &PublicEditor::get_preferred_edit_position)
717 //.addFunction ("split_regions_at", &PublicEditor::split_regions_at)
719 .addRefFunction ("get_nudge_distance", &PublicEditor::get_nudge_distance)
720 .addFunction ("get_paste_offset", &PublicEditor::get_paste_offset)
721 .addFunction ("get_grid_beat_divisions", &PublicEditor::get_grid_beat_divisions)
722 .addRefFunction ("get_grid_type_as_beats", &PublicEditor::get_grid_type_as_beats)
724 .addFunction ("toggle_ruler_video", &PublicEditor::toggle_ruler_video)
725 .addFunction ("toggle_xjadeo_proc", &PublicEditor::toggle_xjadeo_proc)
726 .addFunction ("get_videotl_bar_height", &PublicEditor::get_videotl_bar_height)
727 .addFunction ("set_video_timeline_height", &PublicEditor::set_video_timeline_height)
730 .addFunction ("get_route_view_by_route_id", &PublicEditor::get_route_view_by_route_id)
731 .addFunction ("get_equivalent_regions", &PublicEditor::get_equivalent_regions)
733 .addFunction ("axis_view_from_route", &PublicEditor::axis_view_from_route)
734 .addFunction ("axis_views_from_routes", &PublicEditor::axis_views_from_routes)
735 .addFunction ("get_track_views", &PublicEditor::get_track_views)
736 .addFunction ("drags", &PublicEditor::drags)
739 .addFunction ("center_screen", &PublicEditor::center_screen)
741 .addFunction ("get_smart_mode", &PublicEditor::get_smart_mode)
742 .addRefFunction ("get_pointer_position", &PublicEditor::get_pointer_position)
744 .addRefFunction ("find_location_from_marker", &PublicEditor::find_location_from_marker)
745 .addFunction ("find_marker_from_location_id", &PublicEditor::find_marker_from_location_id)
746 .addFunction ("mouse_add_new_marker", &PublicEditor::mouse_add_new_marker)
748 .addFunction ("get_regions_at", &PublicEditor::get_regions_at)
749 .addFunction ("get_regions_after", &PublicEditor::get_regions_after)
750 .addFunction ("get_regions_from_selection_and_mouse", &PublicEditor::get_regions_from_selection_and_mouse)
751 .addFunction ("get_regionviews_by_id", &PublicEditor::get_regionviews_by_id)
752 .addFunction ("get_per_region_note_selection", &PublicEditor::get_per_region_note_selection)
756 .addFunction ("mouse_add_new_tempo_event", &PublicEditor::mouse_add_new_tempo_event)
757 .addFunction ("mouse_add_new_meter_event", &PublicEditor::mouse_add_new_meter_event)
758 .addFunction ("edit_tempo_section", &PublicEditor::edit_tempo_section)
759 .addFunction ("edit_meter_section", &PublicEditor::edit_meter_section)
762 .addFunction ("access_action", &PublicEditor::access_action)
766 .beginNamespace ("MarkerType")
767 .addConst ("Mark", ArdourMarker::Type(ArdourMarker::Mark))
768 .addConst ("Tempo", ArdourMarker::Type(ArdourMarker::Tempo))
769 .addConst ("Meter", ArdourMarker::Type(ArdourMarker::Meter))
770 .addConst ("SessionStart", ArdourMarker::Type(ArdourMarker::SessionStart))
771 .addConst ("SessionEnd", ArdourMarker::Type(ArdourMarker::SessionEnd))
772 .addConst ("RangeStart", ArdourMarker::Type(ArdourMarker::RangeStart))
773 .addConst ("RangeEnd", ArdourMarker::Type(ArdourMarker::RangeEnd))
774 .addConst ("LoopStart", ArdourMarker::Type(ArdourMarker::LoopStart))
775 .addConst ("LoopEnd", ArdourMarker::Type(ArdourMarker::LoopEnd))
776 .addConst ("PunchIn", ArdourMarker::Type(ArdourMarker::PunchIn))
777 .addConst ("PunchOut", ArdourMarker::Type(ArdourMarker::PunchOut))
780 .endNamespace (); // end ArdourUI
788 #undef DISPLAYCONTROL
790 #undef IMPORTPOSITION
791 #undef IMPORTDISPOSITION
793 #define ZOOMFOCUS(NAME) .addConst (stringify(NAME), (Editing::ZoomFocus)Editing::NAME)
794 #define SNAPTYPE(NAME) .addConst (stringify(NAME), (Editing::SnapType)Editing::NAME)
795 #define SNAPMODE(NAME) .addConst (stringify(NAME), (Editing::SnapMode)Editing::NAME)
796 #define MOUSEMODE(NAME) .addConst (stringify(NAME), (Editing::MouseMode)Editing::NAME)
797 #define DISPLAYCONTROL(NAME) .addConst (stringify(NAME), (Editing::DisplayControl)Editing::NAME)
798 #define IMPORTMODE(NAME) .addConst (stringify(NAME), (Editing::ImportMode)Editing::NAME)
799 #define IMPORTPOSITION(NAME) .addConst (stringify(NAME), (Editing::ImportPosition)Editing::NAME)
800 #define IMPORTDISPOSITION(NAME) .addConst (stringify(NAME), (Editing::ImportDisposition)Editing::NAME)
801 luabridge::getGlobalNamespace (L)
802 .beginNamespace ("Editing")
803 # include "editing_syms.h"
810 ////////////////////////////////////////////////////////////////////////////////
812 using namespace ARDOUR;
813 using namespace ARDOUR_UI_UTILS;
817 static void _lua_print (std::string s) {
819 std::cout << "LuaInstance: " << s << "\n";
821 PBD::info << "LuaInstance: " << s << endmsg;
824 LuaInstance* LuaInstance::_instance = 0;
827 LuaInstance::instance ()
830 _instance = new LuaInstance;
837 LuaInstance::destroy_instance ()
843 LuaInstance::LuaInstance ()
845 lua.Print.connect (&_lua_print);
848 LuaScriptParamList args;
851 LuaInstance::~LuaInstance ()
853 delete _lua_call_action;
854 delete _lua_render_icon;
855 delete _lua_add_action;
856 delete _lua_del_action;
857 delete _lua_get_action;
869 "function ScriptManager ()"
870 " local self = { scripts = {}, instances = {}, icons = {} }"
872 " local remove = function (id)"
873 " self.scripts[id] = nil"
874 " self.instances[id] = nil"
875 " self.icons[id] = nil"
878 " local addinternal = function (i, n, s, f, c, a)"
879 " assert(type(i) == 'number', 'id must be numeric')"
880 " assert(type(n) == 'string', 'Name must be string')"
881 " assert(type(s) == 'string', 'Script must be string')"
882 " assert(type(f) == 'function', 'Factory is a not a function')"
883 " assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
884 " self.scripts[i] = { ['n'] = n, ['s'] = s, ['f'] = f, ['a'] = a, ['c'] = c }"
885 " local env = _ENV; env.f = nil env.debug = nil os.exit = nil require = nil dofile = nil loadfile = nil package = nil"
886 " self.instances[i] = load (string.dump(f, true), nil, nil, env)(a)"
887 " if type(c) == 'function' then"
888 " self.icons[i] = load (string.dump(c, true), nil, nil, env)(a)"
890 " self.icons[i] = nil"
894 " local call = function (id)"
895 " if type(self.instances[id]) == 'function' then"
896 " local status, err = pcall (self.instances[id])"
897 " if not status then"
898 " print ('action \"'.. id .. '\": ', err)" // error out
905 " local icon = function (id, ...)"
906 " if type(self.icons[id]) == 'function' then"
907 " pcall (self.icons[id], ...)"
912 " local add = function (i, n, s, b, c, a)"
913 " assert(type(b) == 'string', 'ByteCode must be string')"
914 " f = nil load (b)()" // assigns f
915 " icn = nil load (c)()" // may assign "icn"
916 " assert(type(f) == 'string', 'Assigned ByteCode must be string')"
917 " addinternal (i, n, s, load(f), type(icn) ~= \"string\" or icn == '' or load(icn), a)"
920 " local get = function (id)"
921 " if type(self.scripts[id]) == 'table' then"
922 " return { ['name'] = self.scripts[id]['n'],"
923 " ['script'] = self.scripts[id]['s'],"
924 " ['icon'] = type(self.scripts[id]['c']) == 'function',"
925 " ['args'] = self.scripts[id]['a'] }"
930 " local function basic_serialize (o)"
931 " if type(o) == \"number\" then"
932 " return tostring(o)"
934 " return string.format(\"%q\", o)"
938 " local function serialize (name, value)"
939 " local rv = name .. ' = '"
941 " if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
942 " return rv .. basic_serialize(value) .. ' '"
943 " elseif type(value) == \"table\" then"
945 " for k,v in pairs(value) do"
946 " local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
947 " rv = rv .. serialize(fieldname, v) .. ' '"
948 " collectgarbage()" // string concatenation allocates a new string
951 " elseif type(value) == \"function\" then"
952 " return rv .. string.format(\"%q\", string.dump(value, true))"
953 " elseif type(value) == \"boolean\" then"
954 " return rv .. tostring (value)"
956 " error('cannot save a ' .. type(value))"
961 " local save = function ()"
962 " return (serialize('scripts', self.scripts))"
965 " local clear = function ()"
967 " self.instances = {}"
972 " local restore = function (state)"
975 " for i, s in pairs (scripts) do"
976 " addinternal (i, s['n'], s['s'], load(s['f']), type (s['c']) ~= \"string\" or s['c'] == '' or load (s['c']), s['a'])"
981 " return { call = call, add = add, remove = remove, get = get,"
982 " restore = restore, save = save, clear = clear, icon = icon}"
985 " manager = ScriptManager ()"
986 " ScriptManager = nil"
989 lua_State* L = lua.getState();
992 luabridge::LuaRef lua_mgr = luabridge::getGlobal (L, "manager");
993 lua.do_command ("manager = nil"); // hide it.
994 lua.do_command ("collectgarbage()");
996 _lua_add_action = new luabridge::LuaRef(lua_mgr["add"]);
997 _lua_del_action = new luabridge::LuaRef(lua_mgr["remove"]);
998 _lua_get_action = new luabridge::LuaRef(lua_mgr["get"]);
999 _lua_call_action = new luabridge::LuaRef(lua_mgr["call"]);
1000 _lua_render_icon = new luabridge::LuaRef(lua_mgr["icon"]);
1001 _lua_save = new luabridge::LuaRef(lua_mgr["save"]);
1002 _lua_load = new luabridge::LuaRef(lua_mgr["restore"]);
1003 _lua_clear = new luabridge::LuaRef(lua_mgr["clear"]);
1005 } catch (luabridge::LuaException const& e) {
1006 fatal << string_compose (_("programming error: %1"),
1007 X_("Failed to setup Lua action interpreter"))
1009 abort(); /*NOTREACHED*/
1012 register_classes (L);
1014 luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
1015 lua_setglobal (L, "Editor");
1018 void LuaInstance::set_session (Session* s)
1020 SessionHandlePtr::set_session (s);
1025 lua_State* L = lua.getState();
1026 LuaBindings::set_session (L, _session);
1028 for (LuaCallbackMap::iterator i = _callbacks.begin(); i != _callbacks.end(); ++i) {
1029 i->second->set_session (s);
1031 point_one_second_connection = Timers::rapid_connect (sigc::mem_fun(*this, & LuaInstance::every_point_one_seconds));
1035 LuaInstance::session_going_away ()
1037 ENSURE_GUI_THREAD (*this, &LuaInstance::session_going_away);
1038 point_one_second_connection.disconnect ();
1041 for (int i = 0; i < 9; ++i) {
1042 ActionChanged (i, ""); /* EMIT SIGNAL */
1044 SessionHandlePtr::session_going_away ();
1047 lua_State* L = lua.getState();
1048 LuaBindings::set_session (L, _session);
1049 lua.do_command ("collectgarbage();");
1053 LuaInstance::every_point_one_seconds ()
1055 LuaTimerDS (); // emit signal
1059 LuaInstance::set_state (const XMLNode& node)
1064 if ((child = find_named_node (node, "ActionScript"))) {
1065 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
1066 if (!(*n)->is_content ()) { continue; }
1068 guchar* buf = g_base64_decode ((*n)->content ().c_str (), &size);
1070 (*_lua_load)(std::string ((const char*)buf, size));
1071 } catch (luabridge::LuaException const& e) {
1072 cerr << "LuaException:" << e.what () << endl;
1074 for (int i = 0; i < 9; ++i) {
1076 if (lua_action_name (i, name)) {
1077 ActionChanged (i, name); /* EMIT SIGNAL */
1084 if ((child = find_named_node (node, "ActionHooks"))) {
1085 for (XMLNodeList::const_iterator n = child->children ().begin (); n != child->children ().end (); ++n) {
1087 LuaCallbackPtr p (new LuaCallback (_session, *(*n)));
1088 _callbacks.insert (std::make_pair(p->id(), p));
1089 p->drop_callback.connect (_slotcon, MISSING_INVALIDATOR, boost::bind (&LuaInstance::unregister_lua_slot, this, p->id()), gui_context());
1090 SlotChanged (p->id(), p->name(), p->signals()); /* EMIT SIGNAL */
1091 } catch (luabridge::LuaException const& e) {
1092 cerr << "LuaException:" << e.what () << endl;
1101 LuaInstance::interactive_add (LuaScriptInfo::ScriptType type, int id)
1104 std::vector<std::string> reg;
1107 case LuaScriptInfo::EditorAction:
1108 reg = lua_action_names ();
1109 title = "Add Lua Action";
1111 case LuaScriptInfo::EditorHook:
1112 reg = lua_slot_names ();
1113 title = "Add Lua Callback Hook";
1119 LuaScriptInfoPtr spi;
1120 ScriptSelector ss (title, type);
1121 switch (ss.run ()) {
1122 case Gtk::RESPONSE_ACCEPT:
1130 std::string script = "";
1133 script = Glib::file_get_contents (spi->path);
1134 } catch (Glib::FileError e) {
1135 string msg = string_compose (_("Cannot read script '%1': %2"), spi->path, e.what());
1136 Gtk::MessageDialog am (msg);
1141 LuaScriptParamList lsp = LuaScriptParams::script_params (spi, "action_params");
1143 ScriptParameterDialog spd (_("Set Script Parameters"), spi, reg, lsp);
1144 switch (spd.run ()) {
1145 case Gtk::RESPONSE_ACCEPT:
1152 case LuaScriptInfo::EditorAction:
1153 return set_lua_action (id, spd.name(), script, lsp);
1155 case LuaScriptInfo::EditorHook:
1156 return register_lua_slot (spd.name(), script, lsp);
1165 LuaInstance::get_action_state ()
1170 luabridge::LuaRef savedstate ((*_lua_save)());
1171 saved = savedstate.cast<std::string>();
1173 lua.collect_garbage ();
1175 gchar* b64 = g_base64_encode ((const guchar*)saved.c_str (), saved.size ());
1176 std::string b64s (b64);
1179 XMLNode* script_node = new XMLNode (X_("ActionScript"));
1180 script_node->add_property (X_("lua"), LUA_VERSION);
1181 script_node->add_content (b64s);
1183 return *script_node;
1187 LuaInstance::get_hook_state ()
1189 XMLNode* script_node = new XMLNode (X_("ActionHooks"));
1190 for (LuaCallbackMap::const_iterator i = _callbacks.begin(); i != _callbacks.end(); ++i) {
1191 script_node->add_child_nocopy (i->second->get_state ());
1193 return *script_node;
1197 LuaInstance::call_action (const int id)
1200 (*_lua_call_action)(id + 1);
1201 lua.collect_garbage_step ();
1202 } catch (luabridge::LuaException const& e) {
1203 cerr << "LuaException:" << e.what () << endl;
1208 LuaInstance::render_action_icon (cairo_t* cr, int w, int h, uint32_t c, void* i) {
1209 int ii = reinterpret_cast<uintptr_t> (i);
1210 instance()->render_icon (ii, cr, w, h, c);
1214 LuaInstance::render_icon (int i, cairo_t* cr, int w, int h, uint32_t clr)
1216 Cairo::Context ctx (cr);
1218 (*_lua_render_icon)(i + 1, (Cairo::Context *)&ctx, w, h, clr);
1219 } catch (luabridge::LuaException const& e) {
1220 cerr << "LuaException:" << e.what () << endl;
1225 LuaInstance::set_lua_action (
1227 const std::string& name,
1228 const std::string& script,
1229 const LuaScriptParamList& args)
1232 lua_State* L = lua.getState();
1233 // get bytcode of factory-function in a sandbox
1234 // (don't allow scripts to interfere)
1235 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
1236 const std::string& iconfunc = LuaScripting::get_factory_bytecode (script, "icon", "icn");
1237 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
1238 for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
1239 if ((*i)->optional && !(*i)->is_set) { continue; }
1240 tbl_arg[(*i)->name] = (*i)->value;
1242 (*_lua_add_action)(id + 1, name, script, bytecode, iconfunc, tbl_arg);
1243 ActionChanged (id, name); /* EMIT SIGNAL */
1244 } catch (luabridge::LuaException const& e) {
1245 cerr << "LuaException:" << e.what () << endl;
1248 _session->set_dirty ();
1253 LuaInstance::remove_lua_action (const int id)
1256 (*_lua_del_action)(id + 1);
1257 } catch (luabridge::LuaException const& e) {
1258 cerr << "LuaException:" << e.what () << endl;
1261 ActionChanged (id, ""); /* EMIT SIGNAL */
1262 _session->set_dirty ();
1267 LuaInstance::lua_action_name (const int id, std::string& rv)
1270 luabridge::LuaRef ref ((*_lua_get_action)(id + 1));
1274 if (ref["name"].isString()) {
1275 rv = ref["name"].cast<std::string>();
1279 } catch (luabridge::LuaException const& e) {
1280 cerr << "LuaException:" << e.what () << endl;
1286 std::vector<std::string>
1287 LuaInstance::lua_action_names ()
1289 std::vector<std::string> rv;
1290 for (int i = 0; i < 9; ++i) {
1292 if (lua_action_name (i, name)) {
1293 rv.push_back (name);
1300 LuaInstance::lua_action_has_icon (const int id)
1303 luabridge::LuaRef ref ((*_lua_get_action)(id + 1));
1307 if (ref["icon"].isBoolean()) {
1308 return ref["icon"].cast<bool>();
1310 } catch (luabridge::LuaException const& e) {
1311 cerr << "LuaException:" << e.what () << endl;
1317 LuaInstance::lua_action (const int id, std::string& name, std::string& script, LuaScriptParamList& args)
1320 luabridge::LuaRef ref ((*_lua_get_action)(id + 1));
1324 if (!ref["name"].isString()) {
1327 if (!ref["script"].isString()) {
1330 if (!ref["args"].isTable()) {
1333 name = ref["name"].cast<std::string>();
1334 script = ref["script"].cast<std::string>();
1337 LuaScriptInfoPtr lsi = LuaScripting::script_info (script);
1341 args = LuaScriptParams::script_params (lsi, "action_params");
1342 luabridge::LuaRef rargs (ref["args"]);
1343 LuaScriptParams::ref_to_params (args, &rargs);
1345 } catch (luabridge::LuaException const& e) {
1346 cerr << "LuaException:" << e.what () << endl;
1353 LuaInstance::register_lua_slot (const std::string& name, const std::string& script, const ARDOUR::LuaScriptParamList& args)
1355 /* parse script, get ActionHook(s) from script */
1359 l.Print.connect (&_lua_print);
1360 lua_State* L = l.getState();
1362 l.do_command ("function ardour () end");
1363 l.do_command (script);
1364 luabridge::LuaRef signals = luabridge::getGlobal (L, "signals");
1365 if (signals.isFunction()) {
1368 } catch (luabridge::LuaException const& e) {
1369 cerr << "LuaException:" << e.what () << endl;
1373 cerr << "Script registered no hooks." << endl;
1377 /* register script w/args, get entry-point / ID */
1380 LuaCallbackPtr p (new LuaCallback (_session, name, script, ah, args));
1381 _callbacks.insert (std::make_pair(p->id(), p));
1382 p->drop_callback.connect (_slotcon, MISSING_INVALIDATOR, boost::bind (&LuaInstance::unregister_lua_slot, this, p->id()), gui_context());
1383 SlotChanged (p->id(), p->name(), p->signals()); /* EMIT SIGNAL */
1385 } catch (luabridge::LuaException const& e) {
1386 cerr << "LuaException:" << e.what () << endl;
1388 _session->set_dirty ();
1393 LuaInstance::unregister_lua_slot (const PBD::ID& id)
1395 LuaCallbackMap::iterator i = _callbacks.find (id);
1396 if (i != _callbacks.end()) {
1397 SlotChanged (id, "", ActionHook()); /* EMIT SIGNAL */
1398 _callbacks.erase (i);
1401 _session->set_dirty ();
1405 std::vector<PBD::ID>
1406 LuaInstance::lua_slots () const
1408 std::vector<PBD::ID> rv;
1409 for (LuaCallbackMap::const_iterator i = _callbacks.begin(); i != _callbacks.end(); ++i) {
1410 rv.push_back (i->first);
1416 LuaInstance::lua_slot_name (const PBD::ID& id, std::string& name) const
1418 LuaCallbackMap::const_iterator i = _callbacks.find (id);
1419 if (i != _callbacks.end()) {
1420 name = i->second->name();
1426 std::vector<std::string>
1427 LuaInstance::lua_slot_names () const
1429 std::vector<std::string> rv;
1430 std::vector<PBD::ID> ids = lua_slots();
1431 for (std::vector<PBD::ID>::const_iterator i = ids.begin(); i != ids.end(); ++i) {
1433 if (lua_slot_name (*i, name)) {
1434 rv.push_back (name);
1441 LuaInstance::lua_slot (const PBD::ID& id, std::string& name, std::string& script, ActionHook& ah, ARDOUR::LuaScriptParamList& args)
1443 LuaCallbackMap::const_iterator i = _callbacks.find (id);
1444 if (i == _callbacks.end()) {
1445 return false; // error
1447 return i->second->lua_slot (name, script, ah, args);
1450 ///////////////////////////////////////////////////////////////////////////////
1452 LuaCallback::LuaCallback (Session *s,
1453 const std::string& name,
1454 const std::string& script,
1455 const ActionHook& ah,
1456 const ARDOUR::LuaScriptParamList& args)
1457 : SessionHandlePtr (s)
1462 // TODO: allow to reference object (e.g region)
1465 lua_State* L = lua.getState();
1466 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
1467 for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
1468 if ((*i)->optional && !(*i)->is_set) { continue; }
1469 tbl_arg[(*i)->name] = (*i)->value;
1473 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
1474 (*_lua_add)(name, script, bytecode, tbl_arg);
1475 } catch (luabridge::LuaException const& e) {
1476 cerr << "LuaException:" << e.what () << endl;
1477 throw failed_constructor ();
1484 LuaCallback::LuaCallback (Session *s, XMLNode & node)
1485 : SessionHandlePtr (s)
1487 XMLNode* child = NULL;
1488 if (node.name() != X_("LuaCallback")
1489 || !node.property ("signals")
1490 || !node.property ("id")
1491 || !node.property ("name")) {
1492 throw failed_constructor ();
1495 for (XMLNodeList::const_iterator n = node.children ().begin (); n != node.children ().end (); ++n) {
1496 if (!(*n)->is_content ()) { continue; }
1501 throw failed_constructor ();
1506 _id = PBD::ID (node.property ("id")->value ());
1507 _name = node.property ("name")->value ();
1508 _signals = ActionHook (node.property ("signals")->value ());
1511 guchar* buf = g_base64_decode (child->content ().c_str (), &size);
1513 (*_lua_load)(std::string ((const char*)buf, size));
1514 } catch (luabridge::LuaException const& e) {
1515 cerr << "LuaException:" << e.what () << endl;
1522 LuaCallback::~LuaCallback ()
1532 LuaCallback::get_state (void)
1536 luabridge::LuaRef savedstate ((*_lua_save)());
1537 saved = savedstate.cast<std::string>();
1539 lua.collect_garbage ();
1541 gchar* b64 = g_base64_encode ((const guchar*)saved.c_str (), saved.size ());
1542 std::string b64s (b64);
1545 XMLNode* script_node = new XMLNode (X_("LuaCallback"));
1546 script_node->add_property (X_("lua"), LUA_VERSION);
1547 script_node->add_property (X_("id"), _id.to_s ());
1548 script_node->add_property (X_("name"), _name);
1549 script_node->add_property (X_("signals"), _signals.to_string ());
1550 script_node->add_content (b64s);
1551 return *script_node;
1555 LuaCallback::init (void)
1557 lua.Print.connect (&_lua_print);
1560 "function ScriptManager ()"
1561 " local self = { script = {}, instance = {} }"
1563 " local addinternal = function (n, s, f, a)"
1564 " assert(type(n) == 'string', 'Name must be string')"
1565 " assert(type(s) == 'string', 'Script must be string')"
1566 " assert(type(f) == 'function', 'Factory is a not a function')"
1567 " assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
1568 " self.script = { ['n'] = n, ['s'] = s, ['f'] = f, ['a'] = a }"
1569 " local env = _ENV; env.f = nil env.debug = nil os.exit = nil require = nil dofile = nil loadfile = nil package = nil"
1570 " self.instance = load (string.dump(f, true), nil, nil, env)(a)"
1573 " local call = function (...)"
1574 " if type(self.instance) == 'function' then"
1575 " local status, err = pcall (self.instance, ...)"
1576 " if not status then"
1577 " print ('callback \"'.. self.script['n'] .. '\": ', err)" // error out
1578 " self.script = nil"
1579 " self.instance = nil"
1587 " local add = function (n, s, b, a)"
1588 " assert(type(b) == 'string', 'ByteCode must be string')"
1589 " load (b)()" // assigns f
1590 " assert(type(f) == 'string', 'Assigned ByteCode must be string')"
1591 " addinternal (n, s, load(f), a)"
1594 " local get = function ()"
1595 " if type(self.instance) == 'function' and type(self.script['n']) == 'string' then"
1596 " return { ['name'] = self.script['n'],"
1597 " ['script'] = self.script['s'],"
1598 " ['args'] = self.script['a'] }"
1605 " local function basic_serialize (o)"
1606 " if type(o) == \"number\" then"
1607 " return tostring(o)"
1609 " return string.format(\"%q\", o)"
1613 " local function serialize (name, value)"
1614 " local rv = name .. ' = '"
1616 " if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
1617 " return rv .. basic_serialize(value) .. ' '"
1618 " elseif type(value) == \"table\" then"
1620 " for k,v in pairs(value) do"
1621 " local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
1622 " rv = rv .. serialize(fieldname, v) .. ' '"
1623 " collectgarbage()" // string concatenation allocates a new string
1626 " elseif type(value) == \"function\" then"
1627 " return rv .. string.format(\"%q\", string.dump(value, true))"
1628 " elseif type(value) == \"boolean\" then"
1629 " return rv .. tostring (value)"
1631 " error('cannot save a ' .. type(value))"
1637 " local save = function ()"
1638 " return (serialize('s', self.script))"
1641 " local restore = function (state)"
1644 " addinternal (s['n'], s['s'], load(s['f']), s['a'])"
1647 " return { call = call, add = add, get = get,"
1648 " restore = restore, save = save}"
1651 " manager = ScriptManager ()"
1652 " ScriptManager = nil"
1655 lua_State* L = lua.getState();
1658 luabridge::LuaRef lua_mgr = luabridge::getGlobal (L, "manager");
1659 lua.do_command ("manager = nil"); // hide it.
1660 lua.do_command ("collectgarbage()");
1662 _lua_add = new luabridge::LuaRef(lua_mgr["add"]);
1663 _lua_get = new luabridge::LuaRef(lua_mgr["get"]);
1664 _lua_call = new luabridge::LuaRef(lua_mgr["call"]);
1665 _lua_save = new luabridge::LuaRef(lua_mgr["save"]);
1666 _lua_load = new luabridge::LuaRef(lua_mgr["restore"]);
1668 } catch (luabridge::LuaException const& e) {
1669 fatal << string_compose (_("programming error: %1"),
1670 X_("Failed to setup Lua callback interpreter"))
1672 abort(); /*NOTREACHED*/
1675 LuaInstance::register_classes (L);
1677 luabridge::push <PublicEditor *> (L, &PublicEditor::instance());
1678 lua_setglobal (L, "Editor");
1682 LuaCallback::lua_slot (std::string& name, std::string& script, ActionHook& ah, ARDOUR::LuaScriptParamList& args)
1684 // TODO consolidate w/ LuaInstance::lua_action()
1686 luabridge::LuaRef ref = (*_lua_get)();
1690 if (!ref["name"].isString()) {
1693 if (!ref["script"].isString()) {
1696 if (!ref["args"].isTable()) {
1701 name = ref["name"].cast<std::string> ();
1702 script = ref["script"].cast<std::string> ();
1705 LuaScriptInfoPtr lsi = LuaScripting::script_info (script);
1709 args = LuaScriptParams::script_params (lsi, "action_params");
1710 luabridge::LuaRef rargs (ref["args"]);
1711 LuaScriptParams::ref_to_params (args, &rargs);
1713 } catch (luabridge::LuaException const& e) {
1714 cerr << "LuaException:" << e.what () << endl;
1721 LuaCallback::set_session (ARDOUR::Session *s)
1723 SessionHandlePtr::set_session (s);
1729 lua_State* L = lua.getState();
1730 LuaBindings::set_session (L, _session);
1736 LuaCallback::session_going_away ()
1738 ENSURE_GUI_THREAD (*this, &LuaCallback::session_going_away);
1739 lua.do_command ("collectgarbage();");
1741 SessionHandlePtr::session_going_away ();
1744 drop_callback (); /* EMIT SIGNAL */
1748 LuaCallback::reconnect ()
1750 _connections.drop_connections ();
1751 if ((*_lua_get) ().isNil ()) {
1752 drop_callback (); /* EMIT SIGNAL */
1756 // TODO pass object which emits the signal (e.g region)
1758 // save/load bound objects will be tricky.
1759 // Best idea so far is to save/lookup the PBD::ID
1760 // (either use boost::any indirection or templates for bindable
1761 // object types or a switch statement..)
1763 // _session->route_by_id ()
1764 // _session->track_by_diskstream_id ()
1765 // _session->source_by_id ()
1766 // _session->controllable_by_id ()
1767 // _session->processor_by_id ()
1768 // RegionFactory::region_by_id ()
1770 // TODO loop over objects (if any)
1772 reconnect_object ((void*)0);
1775 template <class T> void
1776 LuaCallback::reconnect_object (T obj)
1778 for (uint32_t i = 0; i < LuaSignal::LAST_SIGNAL; ++i) {
1780 #define ENGINE(n,c,p) else if (i == LuaSignal::n) { connect_ ## p (LuaSignal::n, AudioEngine::instance(), &(AudioEngine::instance()->c)); }
1781 #define SESSION(n,c,p) else if (i == LuaSignal::n) { if (_session) { connect_ ## p (LuaSignal::n, _session, &(_session->c)); } }
1782 #define STATIC(n,c,p) else if (i == LuaSignal::n) { connect_ ## p (LuaSignal::n, obj, c); }
1784 # include "luasignal_syms.h"
1786 PBD::fatal << string_compose (_("programming error: %1: %2"), "Impossible LuaSignal type", i) << endmsg;
1787 abort(); /*NOTREACHED*/
1796 template <typename T, typename S> void
1797 LuaCallback::connect_0 (enum LuaSignal::LuaSignal ls, T ref, S *signal) {
1799 _connections, invalidator (*this),
1800 boost::bind (&LuaCallback::proxy_0<T>, this, ls, ref),
1804 template <typename T, typename C1> void
1805 LuaCallback::connect_1 (enum LuaSignal::LuaSignal ls, T ref, PBD::Signal1<void, C1> *signal) {
1807 _connections, invalidator (*this),
1808 boost::bind (&LuaCallback::proxy_1<T, C1>, this, ls, ref, _1),
1812 template <typename T, typename C1, typename C2> void
1813 LuaCallback::connect_2 (enum LuaSignal::LuaSignal ls, T ref, PBD::Signal2<void, C1, C2> *signal) {
1815 _connections, invalidator (*this),
1816 boost::bind (&LuaCallback::proxy_2<T, C1, C2>, this, ls, ref, _1, _2),
1820 template <typename T> void
1821 LuaCallback::proxy_0 (enum LuaSignal::LuaSignal ls, T ref) {
1824 const luabridge::LuaRef& rv ((*_lua_call)((int)ls, ref));
1825 if (! rv.cast<bool> ()) {
1829 /* destroy LuaRef ^^ first before calling drop_callback() */
1831 drop_callback (); /* EMIT SIGNAL */
1835 template <typename T, typename C1> void
1836 LuaCallback::proxy_1 (enum LuaSignal::LuaSignal ls, T ref, C1 a1) {
1839 const luabridge::LuaRef& rv ((*_lua_call)((int)ls, ref, a1));
1840 if (! rv.cast<bool> ()) {
1845 drop_callback (); /* EMIT SIGNAL */
1849 template <typename T, typename C1, typename C2> void
1850 LuaCallback::proxy_2 (enum LuaSignal::LuaSignal ls, T ref, C1 a1, C2 a2) {
1853 const luabridge::LuaRef& rv ((*_lua_call)((int)ls, ref, a1, a2));
1854 if (! rv.cast<bool> ()) {
1859 drop_callback (); /* EMIT SIGNAL */