2 Copyright (C) 2016 Robin Gareus <robin@gareus.org>
4 This program is free software; you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2 of the License, or (at your option)
9 This program is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License along
15 with this program; if not, write to the Free Software Foundation, Inc.,
16 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "timecode/bbt_time.h"
22 #include "pbd/stateful_diff_command.h"
23 #include "evoral/Control.hpp"
24 #include "evoral/ControlList.hpp"
25 #include "evoral/Range.hpp"
27 #include "ardour/amp.h"
28 #include "ardour/audioengine.h"
29 #include "ardour/audiosource.h"
30 #include "ardour/audio_backend.h"
31 #include "ardour/audio_buffer.h"
32 #include "ardour/audio_port.h"
33 #include "ardour/audio_track.h"
34 #include "ardour/buffer_set.h"
35 #include "ardour/chan_mapping.h"
36 #include "ardour/dB.h"
37 #include "ardour/dsp_filter.h"
38 #include "ardour/interthread_info.h"
39 #include "ardour/lua_api.h"
40 #include "ardour/luabindings.h"
41 #include "ardour/luaproc.h"
42 #include "ardour/meter.h"
43 #include "ardour/midi_track.h"
44 #include "ardour/midi_port.h"
45 #include "ardour/phase_control.h"
46 #include "ardour/playlist.h"
47 #include "ardour/plugin.h"
48 #include "ardour/plugin_insert.h"
49 #include "ardour/port_manager.h"
50 #include "ardour/runtime_functions.h"
51 #include "ardour/region.h"
52 #include "ardour/region_factory.h"
53 #include "ardour/route_group.h"
54 #include "ardour/session.h"
55 #include "ardour/session_object.h"
56 #include "ardour/sidechain.h"
57 #include "ardour/solo_isolate_control.h"
58 #include "ardour/solo_safe_control.h"
59 #include "ardour/stripable.h"
60 #include "ardour/track.h"
61 #include "ardour/tempo.h"
63 #include "LuaBridge/LuaBridge.h"
65 #ifdef PLATFORM_WINDOWS
66 /* luabridge uses addresses of static functions/variables to identify classes.
68 * Static symbols on windows (even identical symbols) are not
69 * mapped to the same address when mixing .dll + .exe.
70 * So we need a single point to define those static functions.
71 * (normally they're header-only in libs/lua/LuaBridge/detail/ClassInfo.h)
73 * Really!! A static function with a static variable in a library header
74 * should never ever be replicated, even if it is a template.
75 * But then again this is windows... what else can go wrong.
80 luabridge::ClassInfo<T>::getStaticKey ()
88 luabridge::ClassInfo<T>::getClassKey ()
96 luabridge::ClassInfo<T>::getConstKey ()
103 luabridge::getIdentityKey ()
109 /* ...and this is the ugly part of it.
111 * We need to foward declare classes from gtk2_ardour
112 * end explicily list classes which are used by gtk2_ardour's bindings.
114 * This is needed because some of the GUI classes use objects from libardour
115 * as function parameters and the .exe would re-create symbols for libardour
118 * Classes which don't use libardour symbols could be moved to
119 * gtk2_ardour/luainstance.cc, but keeping this here reduces code
120 * duplication and does not give the compiler a chance to even think
121 * about replicating the symbols.
124 #define CLASSKEYS(CLS) \
125 template void const* luabridge::ClassInfo< CLS >::getStaticKey(); \
126 template void const* luabridge::ClassInfo< CLS >::getClassKey(); \
127 template void const* luabridge::ClassInfo< CLS >::getConstKey();
129 #define CLASSINFO(CLS) \
131 template void const* luabridge::ClassInfo< CLS >::getStaticKey(); \
132 template void const* luabridge::ClassInfo< CLS >::getClassKey(); \
133 template void const* luabridge::ClassInfo< CLS >::getConstKey();
135 CLASSINFO(MarkerSelection);
136 CLASSINFO(TrackSelection);
137 CLASSINFO(TrackViewList);
138 CLASSINFO(TimeSelection);
139 CLASSINFO(RegionSelection);
140 CLASSINFO(PublicEditor);
141 CLASSINFO(Selection);
142 CLASSINFO(ArdourMarker);
143 CLASSINFO(LuaCairoImageSurface);
148 CLASSKEYS(Cairo::Context);
149 CLASSKEYS(std::vector<double>);
150 CLASSKEYS(std::list<ArdourMarker*>);
151 CLASSKEYS(std::bitset<46ul>); // LuaSignal::LAST_SIGNAL
152 CLASSKEYS(ArdourMarker*);
153 CLASSKEYS(ARDOUR::RouteGroup);
154 CLASSKEYS(ARDOUR::LuaProc);
155 CLASSKEYS(ARDOUR::DataType);
156 CLASSKEYS(ARDOUR::ChanCount);
157 CLASSKEYS(boost::shared_ptr<ARDOUR::Processor>);
158 CLASSKEYS(ARDOUR::ParameterDescriptor);
159 CLASSKEYS(boost::shared_ptr<ARDOUR::AutomationList>);
160 CLASSKEYS(boost::shared_ptr<Evoral::ControlList>);
161 CLASSKEYS(ARDOUR::LuaOSC::Address);
162 CLASSKEYS(ARDOUR::Session);
163 CLASSKEYS(ARDOUR::BufferSet);
164 CLASSKEYS(ARDOUR::ChanMapping);
165 CLASSKEYS(ARDOUR::DSP::DspShm);
167 CLASSKEYS(ARDOUR::Location);
168 CLASSKEYS(ARDOUR::PluginInfo);
169 CLASSKEYS(PBD::PropertyChange);
170 CLASSKEYS(std::vector<std::string>);
171 CLASSKEYS(std::list<boost::shared_ptr<ARDOUR::Route> >);
172 CLASSKEYS(std::list<boost::shared_ptr<ARDOUR::Port> >);
173 CLASSKEYS(boost::shared_ptr<ARDOUR::PluginInfo>);
174 CLASSKEYS(boost::shared_ptr<ARDOUR::Region>);
175 CLASSKEYS(boost::weak_ptr<ARDOUR::Route>);
176 CLASSKEYS(std::list<boost::shared_ptr<ARDOUR::Region> >);
177 CLASSKEYS(std::list<ARDOUR::AudioRange>);
178 CLASSKEYS(Evoral::Beats);
179 CLASSKEYS(ARDOUR::PortEngine);
180 CLASSKEYS(ARDOUR::PortManager);
181 CLASSKEYS(ARDOUR::AudioEngine);
185 #endif // end windows special case
187 /* Some notes on Lua bindings for libardour and friends
189 * - Prefer factory methods over Contructors whenever possible.
190 * Don't expose the constructor method unless required.
192 * e.g. Don't allow the script to construct a "Track" Object directly
193 * but do allow to create a "BBT_TIME" object.
195 * - Do not dereference Shared or Weak Pointers. Pass the pointer to Lua.
196 * - Define Objects as boost:shared_ptr Object whenever possible.
198 * Storing a boost::shared_ptr in a Lua-variable keeps the reference
199 * until that variable is set to 'nil'.
200 * (if the script were to keep a direct pointer to the object instance, the
201 * behaviour is undefined if the actual object goes away)
203 * Methods of the actual class are indirectly exposed,
204 * boost::*_ptr get() and ::lock() is implicit when the class is exported
205 * as LuaBridge's "WSPtrClass".
208 using namespace ARDOUR;
211 LuaBindings::stddef (lua_State* L)
213 // std::list<std::string>
214 luabridge::getGlobalNamespace (L)
215 .beginNamespace ("C")
216 .beginStdList <std::string> ("StringList")
219 // std::vector<std::string>
220 .beginStdVector <std::string> ("StringVector")
223 // register float array (float*)
224 .registerArray <float> ("FloatArray")
226 // register float array (int32_t*)
227 .registerArray <int32_t> ("IntArray")
234 LuaBindings::common (lua_State* L)
236 luabridge::getGlobalNamespace (L)
237 .beginNamespace ("PBD")
238 .beginClass <PBD::ID> ("ID")
239 .addConstructor <void (*) (std::string)> ()
240 .addFunction ("to_s", &PBD::ID::to_s) // TODO special case LUA __tostring ?
243 .beginStdVector <PBD::ID> ("IdVector").endClass ()
245 .beginClass <XMLNode> ("XMLNode")
246 .addFunction ("name", &XMLNode::name)
249 .beginClass <PBD::Stateful> ("Stateful")
250 .addFunction ("id", &PBD::Stateful::id)
251 .addFunction ("properties", &PBD::Stateful::properties)
252 .addFunction ("clear_changes", &PBD::Stateful::clear_changes)
255 .beginWSPtrClass <PBD::Stateful> ("StatefulPtr")
256 .addFunction ("id", &PBD::Stateful::id)
257 .addFunction ("properties", &PBD::Stateful::properties)
258 .addFunction ("clear_changes", &PBD::Stateful::clear_changes)
261 .deriveClass <PBD::StatefulDestructible, PBD::Stateful> ("StatefulDestructible")
264 .deriveWSPtrClass <PBD::StatefulDestructible, PBD::Stateful> ("StatefulDestructiblePtr")
267 .deriveClass <Command, PBD::StatefulDestructible> ("Command")
268 .addFunction ("set_name", &Command::set_name)
269 .addFunction ("name", &Command::name)
272 /* UndoTransaction::add_command() subscribes to DropReferences()
273 * and deletes the object.
275 * This object cannot be constructed by lua because lua would manage lifetime
276 * and delete the object leading to a double free.
278 * use Session::add_stateful_diff_command()
279 * and Session::abort_reversible_command()
281 .deriveClass <PBD::StatefulDiffCommand, Command> ("StatefulDiffCommand")
282 .addFunction ("undo", &PBD::StatefulDiffCommand::undo)
283 .addFunction ("empty", &PBD::StatefulDiffCommand::empty)
286 .deriveWSPtrClass <PBD::Controllable, PBD::StatefulDestructible> ("Controllable")
287 .addFunction ("name", &PBD::Controllable::name)
288 .addFunction ("get_value", &PBD::Controllable::get_value)
292 .beginNamespace ("GroupControlDisposition")
293 .addConst ("InverseGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::InverseGroup))
294 .addConst ("NoGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::NoGroup))
295 .addConst ("UseGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::UseGroup))
298 .endNamespace (); // PBD
300 luabridge::getGlobalNamespace (L)
301 .beginNamespace ("Timecode")
302 .beginClass <Timecode::BBT_Time> ("BBT_TIME")
303 .addConstructor <void (*) (uint32_t, uint32_t, uint32_t)> ()
307 luabridge::getGlobalNamespace (L)
309 .beginNamespace ("Evoral")
310 .beginClass <Evoral::Parameter> ("Parameter")
311 .addConstructor <void (*) (uint32_t, uint8_t, uint32_t)> ()
312 .addFunction ("type", &Evoral::Parameter::type)
313 .addFunction ("channel", &Evoral::Parameter::channel)
314 .addFunction ("id", &Evoral::Parameter::id)
317 .beginWSPtrClass <Evoral::ControlList> ("ControlList")
318 .addFunction ("add", &Evoral::ControlList::add)
319 .addFunction ("thin", &Evoral::ControlList::thin)
320 .addFunction ("eval", &Evoral::ControlList::eval)
321 .addRefFunction ("rt_safe_eval", &Evoral::ControlList::rt_safe_eval)
322 .addFunction ("interpolation", &Evoral::ControlList::interpolation)
323 .addFunction ("set_interpolation", &Evoral::ControlList::set_interpolation)
324 .addFunction ("truncate_end", &Evoral::ControlList::truncate_end)
325 .addFunction ("truncate_start", &Evoral::ControlList::truncate_start)
326 .addFunction ("clear", (void (Evoral::ControlList::*)(double, double))&Evoral::ControlList::clear)
327 .addFunction ("in_write_pass", &Evoral::ControlList::in_write_pass)
330 .beginWSPtrClass <Evoral::ControlSet> ("ControlSet")
333 .beginWSPtrClass <Evoral::Control> ("Control")
334 .addFunction ("list", (boost::shared_ptr<Evoral::ControlList>(Evoral::Control::*)())&Evoral::Control::list)
337 .beginClass <Evoral::ParameterDescriptor> ("ParameterDescriptor")
338 .addVoidConstructor ()
339 .addData ("lower", &Evoral::ParameterDescriptor::lower)
340 .addData ("upper", &Evoral::ParameterDescriptor::upper)
341 .addData ("normal", &Evoral::ParameterDescriptor::normal)
342 .addData ("toggled", &Evoral::ParameterDescriptor::toggled)
345 .beginClass <Evoral::Range<framepos_t> > ("Range")
346 .addConstructor <void (*) (framepos_t, framepos_t)> ()
347 .addData ("from", &Evoral::Range<framepos_t>::from)
348 .addData ("to", &Evoral::Range<framepos_t>::to)
351 /* libevoral enums */
352 .beginNamespace ("InterpolationStyle")
353 .addConst ("Discrete", Evoral::ControlList::InterpolationStyle(Evoral::ControlList::Discrete))
354 .addConst ("Linear", Evoral::ControlList::InterpolationStyle(Evoral::ControlList::Linear))
355 .addConst ("Curved", Evoral::ControlList::InterpolationStyle(Evoral::ControlList::Curved))
358 .endNamespace () // Evoral
360 .beginNamespace ("ARDOUR")
362 .beginClass <InterThreadInfo> ("InterThreadInfo")
363 .addVoidConstructor ()
364 .addData ("done", const_cast<bool InterThreadInfo::*>(&InterThreadInfo::done))
365 #if 0 // currently unused, lua is single-threaded, no custom UIs.
366 .addData ("cancel", (bool InterThreadInfo::*)&InterThreadInfo::cancel)
368 .addData ("progress", const_cast<float InterThreadInfo::*>(&InterThreadInfo::progress))
371 .beginClass <AudioRange> ("AudioRange")
372 .addConstructor <void (*) (framepos_t, framepos_t, uint32_t)> ()
373 .addFunction ("length", &AudioRange::length)
374 .addFunction ("equal", &AudioRange::equal)
375 .addData ("start", &AudioRange::start)
376 .addData ("_end", &AudioRange::end) // XXX "end" is a lua reserved word
377 .addData ("id", &AudioRange::id)
380 .beginWSPtrClass <PluginInfo> ("PluginInfo")
381 .addVoidConstructor ()
384 .beginNamespace ("Route")
385 .beginClass <Route::ProcessorStreams> ("ProcessorStreams")
386 .addVoidConstructor ()
390 .beginClass <ChanMapping> ("ChanMapping")
391 .addVoidConstructor ()
392 .addFunction ("get", static_cast<uint32_t(ChanMapping::*)(DataType, uint32_t) const>(&ChanMapping::get))
393 .addFunction ("set", &ChanMapping::set)
394 .addConst ("Invalid", 4294967295U) // UINT32_MAX
397 .beginNamespace ("Properties")
398 // templated class definitions
399 .beginClass <PBD::PropertyDescriptor<bool> > ("BoolProperty").endClass ()
400 .beginClass <PBD::PropertyDescriptor<float> > ("FloatProperty").endClass ()
401 .beginClass <PBD::PropertyDescriptor<framepos_t> > ("FrameposProperty").endClass ()
402 // actual references (TODO: also expose GQuark for std::set)
404 .addConst ("Start", &ARDOUR::Properties::start)
405 .addConst ("Length", &ARDOUR::Properties::length)
406 .addConst ("Position", &ARDOUR::Properties::position)
409 .beginClass <PBD::PropertyChange> ("PropertyChange")
410 // TODO add special handling (std::set<PropertyID>), PropertyID is a GQuark.
411 // -> direct map to lua table beginStdSet()A
413 // expand templated PropertyDescriptor<T>
414 .addFunction ("containsBool", &PBD::PropertyChange::contains<bool>)
415 .addFunction ("containsFloat", &PBD::PropertyChange::contains<float>)
416 .addFunction ("containsFramePos", &PBD::PropertyChange::contains<framepos_t>)
419 .beginClass <PBD::PropertyList> ("PropertyList")
420 // is-a std::map<PropertyID, PropertyBase*>
423 .deriveClass <PBD::OwnedPropertyList, PBD::PropertyList> ("OwnedPropertyList")
426 .beginWSPtrClass <AutomationList> ("AutomationList")
427 .addCast<PBD::Stateful> ("to_stateful")
428 .addCast<PBD::StatefulDestructible> ("to_statefuldestructible")
429 .addCast<Evoral::ControlList> ("list")
430 .addFunction ("get_state", &AutomationList::get_state)
431 .addFunction ("memento_command", &AutomationList::memento_command)
432 .addFunction ("touching", &AutomationList::touching)
433 .addFunction ("writing", &AutomationList::writing)
434 .addFunction ("touch_enabled", &AutomationList::touch_enabled)
437 .deriveClass <Location, PBD::StatefulDestructible> ("Location")
438 .addFunction ("locked", &Location::locked)
439 .addFunction ("lock", &Location::lock)
440 .addFunction ("start", &Location::start)
441 .addFunction ("_end", &Location::end) // XXX "end" is a lua reserved word
442 .addFunction ("length", &Location::length)
443 .addFunction ("set_start", &Location::set_start)
444 .addFunction ("set_end", &Location::set_end)
445 .addFunction ("set_length", &Location::set)
446 .addFunction ("move_to", &Location::move_to)
449 .deriveClass <Locations, PBD::StatefulDestructible> ("Locations")
450 .addFunction ("auto_loop_location", &Locations::auto_loop_location)
451 .addFunction ("auto_punch_location", &Locations::auto_punch_location)
452 .addFunction ("session_range_location", &Locations::session_range_location)
453 .addFunction ("first_mark_after", &Locations::first_mark_after)
454 .addFunction ("first_mark_before", &Locations::first_mark_before)
455 .addFunction ("first_mark_at", &Locations::mark_at)
456 .addRefFunction ("marks_either_side", &Locations::marks_either_side)
457 .addRefFunction ("find_all_between", &Locations::find_all_between)
460 .beginWSPtrClass <SessionObject> ("SessionObject")
461 /* SessionObject is-a PBD::StatefulDestructible,
462 * but multiple inheritance is not covered by luabridge,
463 * we need explicit casts */
464 .addCast<PBD::Stateful> ("to_stateful")
465 .addCast<PBD::StatefulDestructible> ("to_statefuldestructible")
466 .addFunction ("name", &SessionObject::name)
469 .beginWSPtrClass <Port> ("Port")
470 .addCast<MidiPort> ("to_midiport")
471 .addCast<AudioPort> ("to_audioport")
472 .addFunction ("name", &Port::name)
473 .addFunction ("pretty_name", &Port::pretty_name)
474 .addFunction ("receives_input", &Port::receives_input)
475 .addFunction ("sends_output", &Port::sends_output)
476 .addFunction ("connected", &Port::connected)
477 .addFunction ("disconnect_all", &Port::disconnect_all)
478 .addFunction ("connected_to_name", (bool (Port::*)(std::string const &)const)&Port::connected_to)
479 .addFunction ("connect_by_name", (int (Port::*)(std::string const &))&Port::connect)
480 .addFunction ("disconnect_by_name", (int (Port::*)(std::string const &))&Port::disconnect)
481 .addFunction ("connected_to", (bool (Port::*)(Port*)const)&Port::connected_to)
482 .addFunction ("connect", (int (Port::*)(Port*))&Port::connect)
483 .addFunction ("disconnect", (int (Port::*)(Port*))&Port::disconnect)
484 //.addStaticFunction ("port_offset", &Port::port_offset) // static
487 .deriveWSPtrClass <AudioPort, Port> ("AudioPort")
490 .deriveWSPtrClass <MidiPort, Port> ("MidiPort")
491 .addFunction ("input_active", &MidiPort::input_active)
492 .addFunction ("set_input_active", &MidiPort::set_input_active)
493 .addFunction ("get_midi_buffer", &MidiPort::get_midi_buffer) // DSP only
496 .beginWSPtrClass <PortSet> ("PortSet")
497 .addFunction ("num_ports", (size_t (PortSet::*)(DataType)const)&PortSet::num_ports)
498 .addFunction ("add", &PortSet::add)
499 .addFunction ("remove", &PortSet::remove)
500 .addFunction ("port", (boost::shared_ptr<Port> (PortSet::*)(DataType, size_t)const)&PortSet::port)
501 .addFunction ("contains", &PortSet::contains)
502 .addFunction ("clear", &PortSet::clear)
503 .addFunction ("empty", &PortSet::empty)
506 .deriveWSPtrClass <IO, SessionObject> ("IO")
507 .addFunction ("active", &IO::active)
508 .addFunction ("add_port", &IO::add_port)
509 .addFunction ("remove_port", &IO::remove_port)
510 .addFunction ("connect", &IO::connect)
511 .addFunction ("disconnect", (int (IO::*)(boost::shared_ptr<Port>, std::string, void *))&IO::disconnect)
512 .addFunction ("physically_connected", &IO::physically_connected)
513 .addFunction ("has_port", &IO::has_port)
514 .addFunction ("nth", &IO::nth)
515 .addFunction ("audio", &IO::audio)
516 .addFunction ("midi", &IO::midi)
517 .addFunction ("port_by_name", &IO::nth)
518 .addFunction ("n_ports", &IO::n_ports)
521 .beginClass <RouteGroup> ("RouteGroup")
522 // stub RouteGroup* is needed for new_audio_track()
525 .deriveWSPtrClass <Stripable, SessionObject> ("Stripable")
526 .addCast<Route> ("to_route")
527 .addFunction ("is_auditioner", &Stripable::is_auditioner)
528 .addFunction ("is_master", &Stripable::is_master)
529 .addFunction ("is_monitor", &Stripable::is_monitor)
530 .addFunction ("is_hidden", &Stripable::is_hidden)
531 .addFunction ("is_selected", &Stripable::is_selected)
532 .addFunction ("gain_control", &Stripable::gain_control)
533 .addFunction ("solo_control", &Stripable::solo_control)
534 .addFunction ("solo_isolate_control", &Stripable::solo_isolate_control)
535 .addFunction ("solo_safe_control", &Stripable::solo_safe_control)
536 .addFunction ("mute_control", &Stripable::mute_control)
537 .addFunction ("phase_control", &Stripable::phase_control)
538 .addFunction ("trim_control", &Stripable::trim_control)
539 .addFunction ("rec_enable_control", &Stripable::rec_enable_control)
540 .addFunction ("rec_safe_control", &Stripable::rec_safe_control)
543 .deriveWSPtrClass <Route, Stripable> ("Route")
544 .addCast<Track> ("to_track")
545 .addFunction ("set_name", &Route::set_name)
546 .addFunction ("comment", &Route::comment)
547 .addFunction ("active", &Route::active)
548 .addFunction ("set_active", &Route::set_active)
549 .addFunction ("nth_plugin", &Route::nth_plugin)
550 .addFunction ("nth_processor", &Route::nth_processor)
551 .addFunction ("nth_send", &Route::nth_send)
552 .addFunction ("add_processor_by_index", &Route::add_processor_by_index)
553 .addFunction ("remove_processor", &Route::remove_processor)
554 .addFunction ("replace_processor", &Route::replace_processor)
555 .addFunction ("n_inputs", &Route::n_inputs)
556 .addFunction ("n_outputs", &Route::n_outputs)
557 .addFunction ("set_comment", &Route::set_comment)
558 .addFunction ("strict_io", &Route::strict_io)
559 .addFunction ("set_strict_io", &Route::set_strict_io)
560 .addFunction ("reset_plugin_insert", &Route::reset_plugin_insert)
561 .addFunction ("customize_plugin_insert", &Route::customize_plugin_insert)
562 .addFunction ("add_sidechain", &Route::add_sidechain)
563 .addFunction ("remove_sidechain", &Route::remove_sidechain)
564 .addFunction ("main_outs", &Route::main_outs)
565 .addFunction ("muted", &Route::muted)
566 .addFunction ("soloed", &Route::soloed)
567 .addFunction ("amp", &Route::amp)
568 .addFunction ("trim", &Route::trim)
571 .deriveWSPtrClass <Playlist, SessionObject> ("Playlist")
572 .addFunction ("region_by_id", &Playlist::region_by_id)
573 .addFunction ("data_type", &Playlist::data_type)
574 .addFunction ("n_regions", &Playlist::n_regions)
575 //.addFunction ("get_extent", &Playlist::get_extent) // pair<framepos_t, framepos_t>
576 .addFunction ("region_list", &Playlist::region_list)
577 .addFunction ("add_region", &Playlist::add_region)
578 .addFunction ("remove_region", &Playlist::remove_region)
579 .addFunction ("regions_at", &Playlist::regions_at)
580 .addFunction ("top_region_at", &Playlist::top_region_at)
581 .addFunction ("top_unmuted_region_at", &Playlist::top_unmuted_region_at)
582 .addFunction ("find_next_region", &Playlist::find_next_region)
583 .addFunction ("find_next_region_boundary", &Playlist::find_next_region_boundary)
584 .addFunction ("count_regions_at", &Playlist::count_regions_at)
585 .addFunction ("regions_touched", &Playlist::regions_touched)
586 .addFunction ("regions_with_start_within", &Playlist::regions_with_start_within)
587 .addFunction ("regions_with_end_within", &Playlist::regions_with_end_within)
588 .addFunction ("raise_region", &Playlist::raise_region)
589 .addFunction ("lower_region", &Playlist::lower_region)
590 .addFunction ("raise_region_to_top", &Playlist::raise_region_to_top)
591 .addFunction ("lower_region_to_bottom", &Playlist::lower_region_to_bottom)
592 .addFunction ("duplicate", (void (Playlist::*)(boost::shared_ptr<Region>, framepos_t, framecnt_t, float))&Playlist::duplicate)
593 .addFunction ("duplicate_until", &Playlist::duplicate_until)
594 .addFunction ("duplicate_range", &Playlist::duplicate_range)
595 .addFunction ("combine", &Playlist::combine)
596 .addFunction ("uncombine", &Playlist::uncombine)
597 .addFunction ("split_region", &Playlist::split_region)
598 .addFunction ("split", (void (Playlist::*)(framepos_t))&Playlist::split)
599 .addFunction ("cut", (boost::shared_ptr<Playlist> (Playlist::*)(std::list<AudioRange>&, bool))&Playlist::cut)
601 .addFunction ("copy", &Playlist::copy)
602 .addFunction ("paste", &Playlist::paste)
606 .deriveWSPtrClass <Track, Route> ("Track")
607 .addCast<AudioTrack> ("to_audio_track")
608 .addCast<MidiTrack> ("to_midi_track")
609 .addFunction ("set_name", &Track::set_name)
610 .addFunction ("can_record", &Track::can_record)
611 .addFunction ("bounceable", &Track::bounceable)
612 .addFunction ("bounce", &Track::bounce)
613 .addFunction ("bounce_range", &Track::bounce_range)
614 .addFunction ("playlist", &Track::playlist)
617 .deriveWSPtrClass <AudioTrack, Track> ("AudioTrack")
620 .deriveWSPtrClass <MidiTrack, Track> ("MidiTrack")
623 .deriveWSPtrClass <Region, SessionObject> ("Region")
625 .addFunction ("position", &Region::position)
626 .addFunction ("start", &Region::start)
627 .addFunction ("length", &Region::length)
628 .addFunction ("layer", &Region::layer)
629 .addFunction ("data_type", &Region::data_type)
630 .addFunction ("stretch", &Region::stretch)
631 .addFunction ("shift", &Region::shift)
632 .addRefFunction ("sync_offset", &Region::sync_offset)
633 .addFunction ("sync_position", &Region::sync_position)
634 .addFunction ("hidden", &Region::hidden)
635 .addFunction ("muted", &Region::muted)
636 .addFunction ("opaque", &Region::opaque)
637 .addFunction ("locked", &Region::locked)
638 .addFunction ("position_locked", &Region::position_locked)
639 .addFunction ("video_locked", &Region::video_locked)
640 .addFunction ("automatic", &Region::automatic)
641 .addFunction ("whole_file", &Region::whole_file)
642 .addFunction ("captured", &Region::captured)
643 .addFunction ("can_move", &Region::can_move)
644 .addFunction ("sync_marked", &Region::sync_marked)
645 .addFunction ("external", &Region::external)
646 .addFunction ("import", &Region::import)
647 .addFunction ("covers", &Region::covers)
648 .addFunction ("at_natural_position", &Region::at_natural_position)
649 .addFunction ("is_compound", &Region::is_compound)
650 /* editing operations */
651 .addFunction ("set_length", &Region::set_length)
652 .addFunction ("set_start", &Region::set_start)
653 .addFunction ("set_position", &Region::set_position)
654 .addFunction ("set_initial_position", &Region::set_initial_position)
655 .addFunction ("nudge_position", &Region::nudge_position)
656 .addFunction ("move_to_natural_position", &Region::move_to_natural_position)
657 .addFunction ("move_start", &Region::move_start)
658 .addFunction ("trim_front", &Region::trim_front)
659 .addFunction ("trim_end", &Region::trim_end)
660 .addFunction ("trim_to", &Region::trim_to)
661 .addFunction ("cut_front", &Region::cut_front)
662 .addFunction ("cut_end", &Region::cut_end)
663 .addFunction ("raise", &Region::raise)
664 .addFunction ("lower", &Region::lower)
665 .addFunction ("raise_to_top", &Region::raise_to_top)
666 .addFunction ("lower_to_bottom", &Region::lower_to_bottom)
667 .addFunction ("set_sync_position", &Region::set_sync_position)
668 .addFunction ("clear_sync_position", &Region::clear_sync_position)
669 .addFunction ("set_hidden", &Region::set_hidden)
670 .addFunction ("set_muted", &Region::set_muted)
671 .addFunction ("set_opaque", &Region::set_opaque)
672 .addFunction ("set_locked", &Region::set_locked)
673 .addFunction ("set_video_locked", &Region::set_video_locked)
674 .addFunction ("set_position_locked", &Region::set_position_locked)
677 .beginWSPtrClass <Source> ("Source")
680 .beginClass <Plugin::PresetRecord> ("PresetRecord")
681 .addVoidConstructor ()
682 .addData ("uri", &Plugin::PresetRecord::uri, false)
683 .addData ("label", &Plugin::PresetRecord::label, false)
684 .addData ("user", &Plugin::PresetRecord::user, false)
685 .addData ("valid", &Plugin::PresetRecord::valid, false)
688 .deriveWSPtrClass <Automatable, Evoral::ControlSet> ("Automatable")
689 .addFunction ("automation_control", (boost::shared_ptr<AutomationControl>(Automatable::*)(const Evoral::Parameter&, bool))&Automatable::automation_control)
692 .deriveClass <ParameterDescriptor, Evoral::ParameterDescriptor> ("ParameterDescriptor")
693 .addVoidConstructor ()
694 .addData ("label", &ParameterDescriptor::label)
695 .addData ("logarithmic", &ParameterDescriptor::logarithmic)
698 .deriveWSPtrClass <Processor, SessionObject> ("Processor")
699 .addCast<Automatable> ("to_automatable")
700 .addCast<PluginInsert> ("to_insert")
701 .addCast<SideChain> ("to_sidechain")
702 .addCast<IOProcessor> ("to_ioprocessor")
703 .addCast<UnknownProcessor> ("to_unknownprocessor")
704 .addCast<Amp> ("to_amp")
705 #if 0 // those objects are not yet bound
706 .addCast<MonitorProcessor> ("to_monitorprocessor")
707 .addCast<CapturingProcessor> ("to_capturingprocessor")
708 .addCast<DelayLine> ("to_delayline")
709 .addCast<PeakMeter> ("to_meter")
711 .addFunction ("display_name", &Processor::display_name)
712 .addFunction ("active", &Processor::active)
713 .addFunction ("activate", &Processor::activate)
714 .addFunction ("deactivate", &Processor::deactivate)
717 .deriveWSPtrClass <IOProcessor, Processor> ("IOProcessor")
718 .addFunction ("natural_input_streams", &IOProcessor::natural_input_streams)
719 .addFunction ("natural_output_streams", &IOProcessor::natural_output_streams)
720 .addFunction ("input", (boost::shared_ptr<IO>(IOProcessor::*)())&IOProcessor::input)
721 .addFunction ("output", (boost::shared_ptr<IO>(IOProcessor::*)())&IOProcessor::output)
724 .deriveWSPtrClass <SideChain, IOProcessor> ("SideChain")
727 .deriveWSPtrClass <Delivery, IOProcessor> ("Delivery")
730 .deriveWSPtrClass <Plugin, PBD::StatefulDestructible> ("Plugin")
731 .addFunction ("label", &Plugin::label)
732 .addFunction ("name", &Plugin::name)
733 .addFunction ("maker", &Plugin::maker)
734 .addFunction ("parameter_count", &Plugin::parameter_count)
735 .addRefFunction ("nth_parameter", &Plugin::nth_parameter)
736 .addFunction ("preset_by_label", &Plugin::preset_by_label)
737 .addFunction ("preset_by_uri", &Plugin::preset_by_uri)
738 .addFunction ("load_preset", &Plugin::load_preset)
739 .addFunction ("parameter_is_input", &Plugin::parameter_is_input)
740 .addFunction ("get_docs", &Plugin::get_docs)
741 .addFunction ("get_parameter_docs", &Plugin::get_parameter_docs)
742 .addRefFunction ("get_parameter_descriptor", &Plugin::get_parameter_descriptor)
745 .deriveWSPtrClass <PluginInsert, Processor> ("PluginInsert")
746 .addFunction ("plugin", &PluginInsert::plugin)
747 .addFunction ("activate", &PluginInsert::activate)
748 .addFunction ("deactivate", &PluginInsert::deactivate)
749 .addFunction ("strict_io_configured", &PluginInsert::strict_io_configured)
750 .addFunction ("input_map", (ARDOUR::ChanMapping (PluginInsert::*)(uint32_t) const)&PluginInsert::input_map)
751 .addFunction ("output_map", (ARDOUR::ChanMapping (PluginInsert::*)(uint32_t) const)&PluginInsert::output_map)
752 .addFunction ("set_input_map", &PluginInsert::set_input_map)
753 .addFunction ("set_output_map", &PluginInsert::set_output_map)
754 .addFunction ("sidechain_input", &PluginInsert::sidechain_input)
757 .deriveWSPtrClass <AutomationControl, PBD::Controllable> ("AutomationControl")
758 .addCast<Evoral::Control> ("to_ctrl")
759 .addFunction ("automation_state", &AutomationControl::automation_state)
760 .addFunction ("automation_style", &AutomationControl::automation_style)
761 .addFunction ("set_automation_state", &AutomationControl::set_automation_state)
762 .addFunction ("set_automation_style", &AutomationControl::set_automation_style)
763 .addFunction ("start_touch", &AutomationControl::start_touch)
764 .addFunction ("stop_touch", &AutomationControl::stop_touch)
765 .addFunction ("get_value", &AutomationControl::get_value)
766 .addFunction ("set_value", &AutomationControl::set_value)
767 .addFunction ("writable", &AutomationControl::writable)
768 .addFunction ("alist", &AutomationControl::alist)
771 .deriveWSPtrClass <SlavableAutomationControl, AutomationControl> ("SlavableAutomationControl,")
772 .addFunction ("add_master", &SlavableAutomationControl::add_master)
773 .addFunction ("remove_master", &SlavableAutomationControl::remove_master)
774 .addFunction ("clear_masters", &SlavableAutomationControl::clear_masters)
775 .addFunction ("slaved_to", &SlavableAutomationControl::slaved_to)
776 .addFunction ("slaved", &SlavableAutomationControl::slaved)
777 .addFunction ("get_masters_value", &SlavableAutomationControl::get_masters_value)
778 .addFunction ("get_boolean_masters", &SlavableAutomationControl::get_boolean_masters)
779 //.addFunction ("masters", &SlavableAutomationControl::masters) // not implemented
782 .deriveWSPtrClass <PhaseControl, AutomationControl> ("PhaseControl")
783 .addFunction ("set_phase_invert", (void(PhaseControl::*)(uint32_t, bool))&PhaseControl::set_phase_invert)
784 .addFunction ("inverted", &PhaseControl::inverted)
787 .deriveWSPtrClass <GainControl, SlavableAutomationControl> ("GainControl")
790 .deriveWSPtrClass <SoloControl, SlavableAutomationControl> ("SoloControl")
791 .addFunction ("can_solo", &SoloControl::can_solo)
792 .addFunction ("soloed", &SoloControl::soloed)
793 .addFunction ("self_soloed", &SoloControl::self_soloed)
796 .deriveWSPtrClass <MuteControl, SlavableAutomationControl> ("MuteControl")
797 .addFunction ("muted", &MuteControl::muted)
798 .addFunction ("muted_by_self", &MuteControl::muted_by_self)
801 .deriveWSPtrClass <SoloIsolateControl, SlavableAutomationControl> ("SoloIsolateControl")
802 .addFunction ("solo_isolated", &SoloIsolateControl::solo_isolated)
803 .addFunction ("self_solo_isolated", &SoloIsolateControl::self_solo_isolated)
806 .deriveWSPtrClass <SoloSafeControl, SlavableAutomationControl> ("SoloSafeControl")
807 .addFunction ("solo_safe", &SoloSafeControl::solo_safe)
810 .deriveWSPtrClass <Amp, Processor> ("Amp")
811 .addFunction ("gain_control", (boost::shared_ptr<GainControl>(Amp::*)())&Amp::gain_control)
814 .deriveWSPtrClass <UnknownProcessor, Processor> ("UnknownProcessor")
817 .deriveWSPtrClass <PluginInsert::PluginControl, AutomationControl> ("PluginControl")
820 .deriveWSPtrClass <AudioSource, Source> ("AudioSource")
821 .addFunction ("readable_length", &AudioSource::readable_length)
822 .addFunction ("n_channels", &AudioSource::n_channels)
825 // <std::list<boost::shared_ptr <AudioTrack> >
826 .beginStdList <boost::shared_ptr<AudioTrack> > ("AudioTrackList")
829 // std::list<boost::shared_ptr <MidiTrack> >
830 .beginStdList <boost::shared_ptr<MidiTrack> > ("MidiTrackList")
833 // RouteList == std::list<boost::shared_ptr<Route> >
834 .beginConstStdList <boost::shared_ptr<Route> > ("RouteList")
837 // boost::shared_ptr<RouteList>
838 .beginPtrStdList <boost::shared_ptr<Route> > ("RouteListPtr")
841 // typedef std::list<boost::weak_ptr <Route> > WeakRouteList
842 .beginConstStdList <boost::weak_ptr<Route> > ("WeakRouteList")
845 // std::list< boost::weak_ptr <AudioSource> >
846 .beginConstStdList <boost::weak_ptr<AudioSource> > ("WeakAudioSourceList")
849 // typedef std::list<boost::shared_ptr<Region> > RegionList
850 .beginConstStdList <boost::shared_ptr<Region> > ("RegionList")
853 // boost::shared_ptr <std::list<boost::shared_ptr<Region> > >
854 .beginPtrStdList <boost::shared_ptr<Region> > ("RegionListPtr")
857 //std::list<boost::shared_ptr<Port> > PortList;
858 .beginConstStdList <boost::shared_ptr<Port> > ("PortList")
861 // used by Playlist::cut/copy
862 .beginConstStdList <AudioRange> ("AudioRangeList")
865 .beginConstStdList <Location*> ("LocationList")
868 #if 0 // depends on Evoal:: Note, Beats see note_fixer.h
869 // typedef Evoral::Note<Evoral::Beats> Note;
870 // std::set< boost::weak_ptr<Note> >
871 .beginStdSet <boost::weak_ptr<Note> > ("WeakNoteSet")
875 // std::list<boost::weak_ptr<Source> >
876 .beginConstStdList <boost::weak_ptr<Source> > ("WeakSourceList")
879 .beginClass <Tempo> ("Tempo")
880 .addConstructor <void (*) (double, double)> ()
881 .addFunction ("note_type", &Tempo::note_type)
882 .addFunction ("beats_per_minute", &Tempo::beats_per_minute)
883 .addFunction ("frames_per_beat", &Tempo::frames_per_beat)
886 .beginClass <Meter> ("Meter")
887 .addConstructor <void (*) (double, double)> ()
888 .addFunction ("divisions_per_bar", &Meter::divisions_per_bar)
889 .addFunction ("note_divisor", &Meter::note_divisor)
890 .addFunction ("frames_per_bar", &Meter::frames_per_bar)
891 .addFunction ("frames_per_grid", &Meter::frames_per_grid)
894 .beginClass <TempoMap> ("TempoMap")
895 .addFunction ("add_tempo", &TempoMap::add_tempo)
896 .addFunction ("add_meter", &TempoMap::add_meter)
897 .addFunction ("tempo_section_at_frame", &TempoMap::tempo_section_at_frame)
898 .addFunction ("meter_section_at_frame", &TempoMap::meter_section_at_frame)
899 .addFunction ("meter_section_at_beat", &TempoMap::meter_section_at_beat)
902 .beginClass <MetricSection> ("MetricSection")
903 .addFunction ("pulse", &MetricSection::pulse)
904 .addFunction ("set_pulse", &MetricSection::set_pulse)
907 .deriveClass <TempoSection, MetricSection> ("TempoSection")
908 .addFunction ("c_func", (double(TempoSection::*)()const)&TempoSection::c_func)
911 .deriveClass <MeterSection, MetricSection> ("MeterSection")
912 .addCast<Meter> ("to_meter")
913 .addFunction ("set_pulse", &MeterSection::set_pulse)
914 .addFunction ("set_beat", (void(MeterSection::*)(double))&MeterSection::set_beat)
917 .beginClass <ChanCount> ("ChanCount")
918 .addConstructor <void (*) (DataType, uint32_t)> ()
919 .addFunction ("get", &ChanCount::get)
920 .addFunction ("set", &ChanCount::set)
921 .addFunction ("n_audio", &ChanCount::n_audio)
922 .addFunction ("n_midi", &ChanCount::n_midi)
923 .addFunction ("n_total", &ChanCount::n_total)
924 .addFunction ("reset", &ChanCount::reset)
927 .beginClass <DataType> ("DataType")
928 .addConstructor <void (*) (std::string)> ()
929 .addStaticCFunction ("null", &LuaAPI::datatype_ctor_null) // "nil" is a lua reseved word
930 .addStaticCFunction ("audio", &LuaAPI::datatype_ctor_audio)
931 .addStaticCFunction ("midi", &LuaAPI::datatype_ctor_midi)
932 .addFunction ("to_string", &DataType::to_string) // TODO Lua __tostring
933 // TODO add uint32_t cast, add operator== !=
936 /* libardour enums */
937 .beginNamespace ("PluginType")
938 .addConst ("AudioUnit", ARDOUR::PluginType(AudioUnit))
939 .addConst ("LADSPA", ARDOUR::PluginType(LADSPA))
940 .addConst ("LV2", ARDOUR::PluginType(LV2))
941 .addConst ("Windows_VST", ARDOUR::PluginType(Windows_VST))
942 .addConst ("LXVST", ARDOUR::PluginType(LXVST))
943 .addConst ("Lua", ARDOUR::PluginType(Lua))
946 .beginNamespace ("PresentationInfo")
947 .beginNamespace ("Flag")
948 .addConst ("AudioTrack", ARDOUR::PresentationInfo::Flag(PresentationInfo::AudioTrack))
949 .addConst ("MidiTrack", ARDOUR::PresentationInfo::Flag(PresentationInfo::MidiTrack))
950 .addConst ("AudioBus", ARDOUR::PresentationInfo::Flag(PresentationInfo::AudioBus))
951 .addConst ("MidiBus", ARDOUR::PresentationInfo::Flag(PresentationInfo::MidiBus))
952 .addConst ("VCA", ARDOUR::PresentationInfo::Flag(PresentationInfo::VCA))
953 .addConst ("MasterOut", ARDOUR::PresentationInfo::Flag(PresentationInfo::MasterOut))
954 .addConst ("MonitorOut", ARDOUR::PresentationInfo::Flag(PresentationInfo::MonitorOut))
955 .addConst ("Auditioner", ARDOUR::PresentationInfo::Flag(PresentationInfo::Auditioner))
956 .addConst ("Selected", ARDOUR::PresentationInfo::Flag(PresentationInfo::Selected))
957 .addConst ("Hidden", ARDOUR::PresentationInfo::Flag(PresentationInfo::Hidden))
958 .addConst ("GroupOrderSet", ARDOUR::PresentationInfo::Flag(PresentationInfo::OrderSet))
959 .addConst ("StatusMask", ARDOUR::PresentationInfo::Flag(PresentationInfo::StatusMask))
963 .beginNamespace ("AutoStyle")
964 .addConst ("Absolute", ARDOUR::AutoStyle(Absolute))
965 .addConst ("Trim", ARDOUR::AutoStyle(Trim))
968 .beginNamespace ("AutoState")
969 .addConst ("Off", ARDOUR::AutoState(Off))
970 .addConst ("Write", ARDOUR::AutoState(Write))
971 .addConst ("Touch", ARDOUR::AutoState(Touch))
972 .addConst ("Play", ARDOUR::AutoState(Play))
975 .beginNamespace ("AutomationType")
976 .addConst ("GainAutomation", ARDOUR::AutomationType(GainAutomation))
977 .addConst ("PluginAutomation", ARDOUR::AutomationType(PluginAutomation))
978 .addConst ("SoloAutomation", ARDOUR::AutomationType(SoloAutomation))
979 .addConst ("SoloIsolateAutomation", ARDOUR::AutomationType(SoloIsolateAutomation))
980 .addConst ("SoloSafeAutomation", ARDOUR::AutomationType(SoloSafeAutomation))
981 .addConst ("MuteAutomation", ARDOUR::AutomationType(MuteAutomation))
982 .addConst ("RecEnableAutomation", ARDOUR::AutomationType(RecEnableAutomation))
983 .addConst ("RecSafeAutomation", ARDOUR::AutomationType(RecSafeAutomation))
984 .addConst ("TrimAutomation", ARDOUR::AutomationType(TrimAutomation))
985 .addConst ("PhaseAutomation", ARDOUR::AutomationType(PhaseAutomation))
988 .beginNamespace ("SrcQuality")
989 .addConst ("SrcBest", ARDOUR::SrcQuality(SrcBest))
992 .beginNamespace ("PortFlags")
993 .addConst ("IsInput", ARDOUR::PortFlags(IsInput))
994 .addConst ("IsOutput", ARDOUR::PortFlags(IsOutput))
995 .addConst ("IsPhysical", ARDOUR::PortFlags(IsPhysical))
996 .addConst ("CanMonitor", ARDOUR::PortFlags(CanMonitor))
997 .addConst ("IsTerminal", ARDOUR::PortFlags(IsTerminal))
1000 .beginNamespace ("PlaylistDisposition")
1001 .addConst ("CopyPlaylist", ARDOUR::PlaylistDisposition(CopyPlaylist))
1002 .addConst ("NewPlaylist", ARDOUR::PlaylistDisposition(NewPlaylist))
1003 .addConst ("SharePlaylist", ARDOUR::PlaylistDisposition(SharePlaylist))
1006 .beginNamespace ("RegionPoint")
1007 .addConst ("Start", ARDOUR::RegionPoint(Start))
1008 .addConst ("End", ARDOUR::RegionPoint(End))
1009 .addConst ("SyncPoint", ARDOUR::RegionPoint(SyncPoint))
1012 .beginNamespace ("TempoSection")
1013 .beginNamespace ("PositionLockStyle")
1014 .addConst ("AudioTime", ARDOUR::PositionLockStyle(AudioTime))
1015 .addConst ("MusicTime", ARDOUR::PositionLockStyle(MusicTime))
1019 .beginNamespace ("TempoSection")
1020 .beginNamespace ("Type")
1021 .addConst ("Ramp", ARDOUR::TempoSection::Type(TempoSection::Ramp))
1022 .addConst ("Constant", ARDOUR::TempoSection::Type(TempoSection::Constant))
1026 .beginNamespace ("TrackMode")
1027 .addConst ("Normal", ARDOUR::TrackMode(Start))
1028 .addConst ("NonLayered", ARDOUR::TrackMode(NonLayered))
1029 .addConst ("Destructive", ARDOUR::TrackMode(Destructive))
1031 .endNamespace (); // end ARDOUR
1033 luabridge::getGlobalNamespace (L)
1034 .beginNamespace ("ARDOUR")
1035 .beginClass <AudioBackendInfo> ("AudioBackendInfo")
1036 .addData ("name", &AudioBackendInfo::name)
1038 .beginStdVector <const AudioBackendInfo*> ("BackendVector").endClass ()
1040 .beginClass <AudioBackend::DeviceStatus> ("DeviceStatus")
1041 .addData ("name", &AudioBackend::DeviceStatus::name)
1042 .addData ("available", &AudioBackend::DeviceStatus::available)
1044 .beginStdVector <AudioBackend::DeviceStatus> ("DeviceStatusVector").endClass ()
1046 .beginWSPtrClass <AudioBackend> ("AudioBackend")
1047 .addFunction ("info", &AudioBackend::info)
1048 .addFunction ("sample_rate", &AudioBackend::sample_rate)
1049 .addFunction ("buffer_size", &AudioBackend::buffer_size)
1050 .addFunction ("period_size", &AudioBackend::period_size)
1051 .addFunction ("input_channels", &AudioBackend::input_channels)
1052 .addFunction ("output_channels", &AudioBackend::output_channels)
1053 .addFunction ("dsp_load", &AudioBackend::dsp_load)
1055 .addFunction ("set_sample_rate", &AudioBackend::set_sample_rate)
1056 .addFunction ("set_buffer_size", &AudioBackend::set_buffer_size)
1057 .addFunction ("set_peridod_size", &AudioBackend::set_peridod_size)
1059 .addFunction ("enumerate_drivers", &AudioBackend::enumerate_drivers)
1060 .addFunction ("driver_name", &AudioBackend::driver_name)
1061 .addFunction ("set_driver", &AudioBackend::set_driver)
1063 .addFunction ("use_separate_input_and_output_devices", &AudioBackend::use_separate_input_and_output_devices)
1064 .addFunction ("enumerate_devices", &AudioBackend::enumerate_devices)
1065 .addFunction ("enumerate_input_devices", &AudioBackend::enumerate_input_devices)
1066 .addFunction ("enumerate_output_devices", &AudioBackend::enumerate_output_devices)
1067 .addFunction ("device_name", &AudioBackend::device_name)
1068 .addFunction ("input_device_name", &AudioBackend::input_device_name)
1069 .addFunction ("output_device_name", &AudioBackend::output_device_name)
1070 .addFunction ("set_device_name", &AudioBackend::set_device_name)
1071 .addFunction ("set_input_device_name", &AudioBackend::set_input_device_name)
1072 .addFunction ("set_output_device_name", &AudioBackend::set_output_device_name)
1075 .beginClass <PortEngine> ("PortEngine")
1078 .beginClass <PortManager> ("PortManager")
1079 .addFunction ("port_engine", &PortManager::port_engine)
1080 .addFunction ("connected", &PortManager::connected)
1081 .addFunction ("connect", &PortManager::connect)
1082 .addFunction ("physically_connected", &PortManager::physically_connected)
1083 .addFunction ("disconnect", (int (PortManager::*)(const std::string&, const std::string&))&PortManager::disconnect)
1084 .addFunction ("disconnect_port", (int (PortManager::*)(boost::shared_ptr<Port>))&PortManager::disconnect)
1085 .addFunction ("get_port_by_name", &PortManager::get_port_by_name)
1086 .addFunction ("get_pretty_name_by_name", &PortManager::get_pretty_name_by_name)
1087 .addFunction ("port_is_physical", &PortManager::port_is_physical)
1088 .addFunction ("get_physical_outputs", &PortManager::get_physical_outputs)
1089 .addFunction ("get_physical_inputs", &PortManager::get_physical_inputs)
1090 .addFunction ("n_physical_outputs", &PortManager::n_physical_outputs)
1091 .addFunction ("n_physical_inputs", &PortManager::n_physical_inputs)
1092 .addRefFunction ("get_connections", &PortManager::get_connections)
1093 .addRefFunction ("get_ports", (int (PortManager::*)(DataType, PortManager::PortList&))&PortManager::get_ports)
1094 .addRefFunction ("get_backend_ports", (int (PortManager::*)(const std::string&, DataType, PortFlags, std::vector<std::string>&))&PortManager::get_ports)
1097 .deriveClass <AudioEngine, PortManager> ("AudioEngine")
1098 .addFunction ("available_backends", &AudioEngine::available_backends)
1099 .addFunction ("current_backend_name", &AudioEngine::current_backend_name)
1100 .addFunction ("set_backend", &AudioEngine::set_backend)
1101 .addFunction ("setup_required", &AudioEngine::setup_required)
1102 .addFunction ("start", &AudioEngine::start)
1103 .addFunction ("stop", &AudioEngine::stop)
1104 .addFunction ("get_dsp_load", &AudioEngine::get_dsp_load)
1105 .addFunction ("set_device_name", &AudioEngine::set_device_name)
1106 .addFunction ("set_sample_rate", &AudioEngine::set_sample_rate)
1107 .addFunction ("set_buffer_size", &AudioEngine::set_buffer_size)
1108 .addFunction ("get_last_backend_error", &AudioEngine::get_last_backend_error)
1112 // basic representation of Session
1113 // functions which can be used from realtime and non-realtime contexts
1114 luabridge::getGlobalNamespace (L)
1115 .beginNamespace ("ARDOUR")
1116 .beginClass <Session> ("Session")
1117 .addFunction ("scripts_changed", &Session::scripts_changed) // used internally
1118 .addFunction ("transport_rolling", &Session::transport_rolling)
1119 .addFunction ("request_transport_speed", &Session::request_transport_speed)
1120 .addFunction ("transport_frame", &Session::transport_frame)
1121 .addFunction ("transport_speed", &Session::transport_speed)
1122 .addFunction ("frame_rate", &Session::frame_rate)
1123 .addFunction ("nominal_frame_rate", &Session::nominal_frame_rate)
1124 .addFunction ("frames_per_timecode_frame", &Session::frames_per_timecode_frame)
1125 .addFunction ("timecode_frames_per_hour", &Session::timecode_frames_per_hour)
1126 .addFunction ("timecode_frames_per_second", &Session::timecode_frames_per_second)
1127 .addFunction ("timecode_drop_frames", &Session::timecode_drop_frames)
1128 .addFunction ("request_locate", &Session::request_locate)
1129 .addFunction ("request_stop", &Session::request_stop)
1130 .addFunction ("last_transport_start", &Session::last_transport_start)
1131 .addFunction ("goto_start", &Session::goto_start)
1132 .addFunction ("goto_end", &Session::goto_end)
1133 .addFunction ("current_start_frame", &Session::current_start_frame)
1134 .addFunction ("current_end_frame", &Session::current_end_frame)
1135 .addFunction ("actively_recording", &Session::actively_recording)
1136 .addFunction ("new_audio_track", &Session::new_audio_track)
1137 .addFunction ("new_audio_route", &Session::new_audio_route)
1138 .addFunction ("new_midi_track", &Session::new_midi_track)
1139 .addFunction ("new_midi_route", &Session::new_midi_route)
1140 .addFunction ("get_routes", &Session::get_routes)
1141 .addFunction ("get_tracks", &Session::get_tracks)
1142 .addFunction ("name", &Session::name)
1143 .addFunction ("path", &Session::path)
1144 .addFunction ("record_status", &Session::record_status)
1145 .addFunction ("route_by_id", &Session::route_by_id)
1146 .addFunction ("route_by_name", &Session::route_by_name)
1147 .addFunction ("get_remote_nth_stripable", &Session::get_remote_nth_stripable)
1148 .addFunction ("get_remote_nth_route", &Session::get_remote_nth_route)
1149 .addFunction ("route_by_selected_count", &Session::route_by_selected_count)
1150 .addFunction ("track_by_diskstream_id", &Session::track_by_diskstream_id)
1151 .addFunction ("source_by_id", &Session::source_by_id)
1152 .addFunction ("controllable_by_id", &Session::controllable_by_id)
1153 .addFunction ("processor_by_id", &Session::processor_by_id)
1154 .addFunction ("snap_name", &Session::snap_name)
1155 .addFunction ("monitor_out", &Session::monitor_out)
1156 .addFunction ("master_out", &Session::master_out)
1157 .addFunction ("tempo_map", (TempoMap& (Session::*)())&Session::tempo_map)
1158 .addFunction ("locations", &Session::locations)
1159 .addFunction ("begin_reversible_command", (void (Session::*)(const std::string&))&Session::begin_reversible_command)
1160 .addFunction ("commit_reversible_command", &Session::commit_reversible_command)
1161 .addFunction ("abort_reversible_command", &Session::abort_reversible_command)
1162 .addFunction ("add_command", &Session::add_command)
1163 .addFunction ("add_stateful_diff_command", &Session::add_stateful_diff_command)
1164 .addFunction ("engine", (AudioEngine& (Session::*)())&Session::engine)
1165 .addFunction ("get_block_size", &Session::get_block_size)
1166 .addFunction ("worst_output_latency", &Session::worst_output_latency)
1167 .addFunction ("worst_input_latency", &Session::worst_input_latency)
1168 .addFunction ("worst_track_latency", &Session::worst_track_latency)
1169 .addFunction ("worst_playback_latency", &Session::worst_playback_latency)
1172 .beginClass <RegionFactory> ("RegionFactory")
1173 .addStaticFunction ("region_by_id", &RegionFactory::region_by_id)
1176 /* session enums (rt-safe, common) */
1177 .beginNamespace ("Session")
1179 .beginNamespace ("RecordState")
1180 .addConst ("Disabled", ARDOUR::Session::RecordState(Session::Disabled))
1181 .addConst ("Enabled", ARDOUR::Session::RecordState(Session::Enabled))
1182 .addConst ("Recording", ARDOUR::Session::RecordState(Session::Recording))
1185 .endNamespace () // end Session enums
1187 /* ardour enums (rt-safe, common) */
1188 .beginNamespace ("LocationFlags")
1189 .addConst ("IsMark", ARDOUR::Location::Flags(Location::IsMark))
1190 .addConst ("IsAutoPunch", ARDOUR::Location::Flags(Location::IsAutoPunch))
1191 .addConst ("IsAutoLoop", ARDOUR::Location::Flags(Location::IsAutoLoop))
1192 .addConst ("IsHidden", ARDOUR::Location::Flags(Location::IsHidden))
1193 .addConst ("IsCDMarker", ARDOUR::Location::Flags(Location::IsCDMarker))
1194 .addConst ("IsRangeMarker", ARDOUR::Location::Flags(Location::IsRangeMarker))
1195 .addConst ("IsSessionRange", ARDOUR::Location::Flags(Location::IsSessionRange))
1196 .addConst ("IsSkip", ARDOUR::Location::Flags(Location::IsSkip))
1197 .addConst ("IsSkipping", ARDOUR::Location::Flags(Location::IsSkipping))
1200 .beginNamespace ("LuaAPI")
1201 .addFunction ("nil_proc", ARDOUR::LuaAPI::nil_processor)
1202 .addFunction ("new_luaproc", ARDOUR::LuaAPI::new_luaproc)
1203 .addFunction ("new_plugin_info", ARDOUR::LuaAPI::new_plugin_info)
1204 .addFunction ("new_plugin", ARDOUR::LuaAPI::new_plugin)
1205 .addFunction ("set_processor_param", ARDOUR::LuaAPI::set_processor_param)
1206 .addFunction ("set_plugin_insert_param", ARDOUR::LuaAPI::set_plugin_insert_param)
1207 .addCFunction ("plugin_automation", ARDOUR::LuaAPI::plugin_automation)
1208 .addCFunction ("hsla_to_rgba", ARDOUR::LuaAPI::hsla_to_rgba)
1209 .addFunction ("usleep", Glib::usleep)
1210 .endNamespace () // end LuaAPI
1211 .endNamespace ();// end ARDOUR
1215 LuaBindings::dsp (lua_State* L)
1217 luabridge::getGlobalNamespace (L)
1218 .beginNamespace ("ARDOUR")
1220 .beginClass <AudioBuffer> ("AudioBuffer")
1222 .addFunction ("data", (Sample*(AudioBuffer::*)(framecnt_t))&AudioBuffer::data)
1223 .addFunction ("silence", &AudioBuffer::silence)
1224 .addFunction ("apply_gain", &AudioBuffer::apply_gain)
1225 .addFunction ("check_silence", &AudioBuffer::check_silence)
1226 .addFunction ("read_from", (void (AudioBuffer::*)(const Sample*, framecnt_t, framecnt_t, framecnt_t))&AudioBuffer::check_silence)
1229 .beginClass <MidiBuffer> ("MidiBuffer")
1231 .addFunction ("silence", &MidiBuffer::silence)
1232 .addFunction ("push_event", (bool (MidiBuffer::*)(const Evoral::MIDIEvent<framepos_t>&))&MidiBuffer::push_back)
1233 .addFunction ("push_back", (bool (MidiBuffer::*)(framepos_t, size_t, const uint8_t*))&MidiBuffer::push_back)
1235 .addExtCFunction ("table", &luabridge::CFunc::listToTable<const Evoral::MIDIEvent<framepos_t>, MidiBuffer>)
1238 .beginClass <BufferSet> ("BufferSet")
1240 .addFunction ("get_audio", static_cast<AudioBuffer&(BufferSet::*)(size_t)>(&BufferSet::get_audio))
1241 .addFunction ("count", static_cast<const ChanCount&(BufferSet::*)()const>(&BufferSet::count))
1245 luabridge::getGlobalNamespace (L)
1246 .beginNamespace ("Evoral")
1247 .beginClass <Evoral::Event<framepos_t> > ("Event")
1248 .addFunction ("clear", &Evoral::Event<framepos_t>::clear)
1249 .addFunction ("size", &Evoral::Event<framepos_t>::size)
1250 .addFunction ("set_buffer", &Evoral::Event<framepos_t>::set_buffer)
1251 .addFunction ("buffer", (uint8_t*(Evoral::Event<framepos_t>::*)())&Evoral::Event<framepos_t>::buffer)
1254 .beginClass <Evoral::Beats> ("Beats")
1255 .addFunction ("to_double", &Evoral::Beats::to_double)
1258 .deriveClass <Evoral::MIDIEvent<framepos_t>, Evoral::Event<framepos_t> > ("MidiEvent")
1260 .addFunction ("type", &Evoral::MIDIEvent<framepos_t>::type)
1261 .addFunction ("channel", &Evoral::MIDIEvent<framepos_t>::channel)
1262 .addFunction ("set_type", &Evoral::MIDIEvent<framepos_t>::set_type)
1263 .addFunction ("set_channel", &Evoral::MIDIEvent<framepos_t>::set_channel)
1267 // dsp releated session functions
1268 luabridge::getGlobalNamespace (L)
1269 .beginNamespace ("ARDOUR")
1270 .beginClass <Session> ("Session")
1271 .addFunction ("get_scratch_buffers", &Session::get_scratch_buffers)
1272 .addFunction ("get_silent_buffers", &Session::get_silent_buffers)
1276 luabridge::getGlobalNamespace (L)
1277 .beginNamespace ("ARDOUR")
1278 .beginNamespace ("DSP")
1279 .addFunction ("compute_peak", ARDOUR::compute_peak)
1280 .addFunction ("find_peaks", ARDOUR::find_peaks)
1281 .addFunction ("apply_gain_to_buffer", ARDOUR::apply_gain_to_buffer)
1282 .addFunction ("mix_buffers_no_gain", ARDOUR::mix_buffers_no_gain)
1283 .addFunction ("mix_buffers_with_gain", ARDOUR::mix_buffers_with_gain)
1284 .addFunction ("copy_vector", ARDOUR::copy_vector)
1285 .addFunction ("dB_to_coefficient", &dB_to_coefficient)
1286 .addFunction ("fast_coefficient_to_dB", &fast_coefficient_to_dB)
1287 .addFunction ("accurate_coefficient_to_dB", &accurate_coefficient_to_dB)
1288 .addFunction ("memset", &DSP::memset)
1289 .addFunction ("mmult", &DSP::mmult)
1290 .addFunction ("log_meter", &DSP::log_meter)
1291 .addFunction ("log_meter_coeff", &DSP::log_meter_coeff)
1292 .addRefFunction ("peaks", &DSP::peaks)
1294 .beginClass <DSP::LowPass> ("LowPass")
1295 .addConstructor <void (*) (double, float)> ()
1296 .addFunction ("proc", &DSP::LowPass::proc)
1297 .addFunction ("ctrl", &DSP::LowPass::ctrl)
1298 .addFunction ("set_cutoff", &DSP::LowPass::set_cutoff)
1299 .addFunction ("reset", &DSP::LowPass::reset)
1301 .beginClass <DSP::Biquad> ("Biquad")
1302 .addConstructor <void (*) (double)> ()
1303 .addFunction ("run", &DSP::Biquad::run)
1304 .addFunction ("compute", &DSP::Biquad::compute)
1305 .addFunction ("configure", &DSP::Biquad::configure)
1306 .addFunction ("reset", &DSP::Biquad::reset)
1307 .addFunction ("dB_at_freq", &DSP::Biquad::dB_at_freq)
1309 .beginClass <DSP::FFTSpectrum> ("FFTSpectrum")
1310 .addConstructor <void (*) (uint32_t, double)> ()
1311 .addFunction ("set_data_hann", &DSP::FFTSpectrum::set_data_hann)
1312 .addFunction ("execute", &DSP::FFTSpectrum::execute)
1313 .addFunction ("power_at_bin", &DSP::FFTSpectrum::power_at_bin)
1314 .addFunction ("freq_at_bin", &DSP::FFTSpectrum::freq_at_bin)
1318 .beginNamespace ("BiquadType")
1319 .addConst ("LowPass", ARDOUR::DSP::Biquad::LowPass)
1320 .addConst ("HighPass", ARDOUR::DSP::Biquad::HighPass)
1321 .addConst ("BandPassSkirt", ARDOUR::DSP::Biquad::BandPassSkirt)
1322 .addConst ("BandPass0dB", ARDOUR::DSP::Biquad::BandPass0dB)
1323 .addConst ("Notch", ARDOUR::DSP::Biquad::Notch)
1324 .addConst ("AllPass", ARDOUR::DSP::Biquad::AllPass)
1325 .addConst ("Peaking", ARDOUR::DSP::Biquad::Peaking)
1326 .addConst ("LowShelf", ARDOUR::DSP::Biquad::LowShelf)
1327 .addConst ("HighShelf", ARDOUR::DSP::Biquad::HighShelf)
1330 .beginClass <DSP::DspShm> ("DspShm")
1331 .addFunction ("allocate", &DSP::DspShm::allocate)
1332 .addFunction ("clear", &DSP::DspShm::clear)
1333 .addFunction ("to_float", &DSP::DspShm::to_float)
1334 .addFunction ("to_int", &DSP::DspShm::to_int)
1335 .addFunction ("atomic_set_int", &DSP::DspShm::atomic_set_int)
1336 .addFunction ("atomic_get_int", &DSP::DspShm::atomic_get_int)
1339 .endNamespace () // DSP
1340 .endNamespace (); // ARDOUR
1344 LuaBindings::session (lua_State* L)
1346 // non-realtime session functions
1347 luabridge::getGlobalNamespace (L)
1348 .beginNamespace ("ARDOUR")
1349 .beginClass <Session> ("Session")
1350 .addFunction ("save_state", &Session::save_state)
1351 .addFunction ("set_dirty", &Session::set_dirty)
1352 .addFunction ("unknown_processors", &Session::unknown_processors)
1354 .addFunction<RouteList (Session::*)(uint32_t, const std::string&, const std::string&, PlaylistDisposition)> ("new_route_from_template", &Session::new_route_from_template)
1355 // TODO session_add_audio_track session_add_midi_track session_add_mixed_track
1356 //.addFunction ("new_midi_track", &Session::new_midi_track)
1359 .endNamespace (); // ARDOUR
1363 LuaBindings::osc (lua_State* L)
1365 luabridge::getGlobalNamespace (L)
1366 .beginNamespace ("ARDOUR")
1367 .beginNamespace ("LuaOSC")
1368 .beginClass<LuaOSC::Address> ("Address")
1369 .addConstructor<void (*) (std::string)> ()
1370 .addCFunction ("send", &LuaOSC::Address::send)
1377 LuaBindings::set_session (lua_State* L, Session *s)
1379 /* LuaBridge uses unique keys to identify classes/c-types.
1381 * Those keys are "generated" by using the memory-address of a static
1382 * variable, templated for every Class.
1383 * (see libs/lua/LuaBridge/detail/ClassInfo.h)
1385 * When linking the final executable there must be exactly one static
1386 * function (static variable) for every templated class.
1387 * This works fine on OSX and Linux...
1389 * Windows (mingw and MSVC) however expand the template differently for libardour
1390 * AND gtk2_ardour. We end up with two identical static functions
1391 * at different addresses!!
1393 * The Solution: have gtk2_ardour never include LuaBridge headers directly
1394 * and always go via libardour function calls for classes that are registered
1395 * in libardour. (calling lua itself is fine, calling c-functions in the GUI
1396 * which expand the template is not)
1398 * (the actual cause: even static symbols in a .dll have no fixed address
1399 * and are mapped when loading the dll. static functions in .exe do have a fixed
1403 * 0000000000000000 I __imp__ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
1404 * 0000000000000000 I __nm__ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
1405 * 0000000000000000 T _ZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEv
1408 * 000000000104f560 d .data$_ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
1409 * 000000000104f560 D _ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
1410 * 0000000000e9baf0 T _ZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEv
1414 luabridge::push <Session *> (L, s);
1415 lua_setglobal (L, "Session");
1418 // call lua function.
1419 luabridge::LuaRef cb_ses = luabridge::getGlobal (L, "new_session");
1420 if (cb_ses.type() == LUA_TFUNCTION) { cb_ses(s->name()); } // TODO args