/* Copyright (C) 2016 Robin Gareus This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ #include "timecode/bbt_time.h" #include "evoral/Control.hpp" #include "evoral/ControlList.hpp" #include "ardour/audioengine.h" #include "ardour/audiosource.h" #include "ardour/audio_backend.h" #include "ardour/audio_buffer.h" #include "ardour/audio_track.h" #include "ardour/buffer_set.h" #include "ardour/chan_mapping.h" #include "ardour/dB.h" #include "ardour/dsp_filter.h" #include "ardour/luabindings.h" #include "ardour/meter.h" #include "ardour/midi_track.h" #include "ardour/plugin.h" #include "ardour/plugin_insert.h" #include "ardour/runtime_functions.h" #include "ardour/region.h" #include "ardour/region_factory.h" #include "ardour/session.h" #include "ardour/session_object.h" #include "ardour/tempo.h" #include "LuaBridge/LuaBridge.h" /* Some notes on Lua bindings for libardour and friends * * - Prefer factory methods over Contructors whenever possible. * Don't expose the constructor method unless required. * * e.g. Don't allow the script to construct a "Track" Object directly * but do allow to create a "BBT_TIME" object. * * - Do not dereference Shared or Weak Pointers. Pass the pointer to Lua. * - Define Objects as boost:shared_ptr Object whenever possible. * * Storing a boost::shared_ptr in a Lua-variable keeps the reference * until that variable is set to 'nil'. * (if the script were to keep a direct pointer to the object instance, the * behaviour is undefined if the actual object goes away) * * Methods of the actual class are indirectly exposed, * boost::*_ptr get() and ::lock() is implicit when the class is exported * as LuaBridge's "WSPtrClass". */ using namespace ARDOUR; void LuaBindings::stddef (lua_State* L) { // std::list luabridge::getGlobalNamespace (L) .beginNamespace ("ARDOUR") .beginStdList ("StringList") .endClass () .endNamespace (); // std::vector luabridge::getGlobalNamespace (L) .beginNamespace ("ARDOUR") .beginStdVector ("StringVector") .endClass () .endNamespace (); // register float array (float*) luabridge::getGlobalNamespace (L) .beginNamespace ("ARDOUR") .registerArray ("FloatArray") .endNamespace (); // TODO std::set } void LuaBindings::common (lua_State* L) { luabridge::getGlobalNamespace (L) .beginNamespace ("PBD") .beginClass ("ID") .addConstructor () .addFunction ("to_s", &PBD::ID::to_s) // TODO special case LUA __tostring ? .endClass () .beginWSPtrClass ("Stateful") .addFunction ("properties", &PBD::Stateful::properties) .endClass () .deriveWSPtrClass ("StatefulDestructible") .endClass () .deriveWSPtrClass ("Controllable") .addFunction ("get_value", &PBD::Controllable::get_value) .endClass () .beginNamespace ("GroupControlDisposition") .addConst ("InverseGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::InverseGroup)) .addConst ("NoGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::NoGroup)) .addConst ("UseGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::UseGroup)) .endNamespace () .endNamespace (); luabridge::getGlobalNamespace (L) .beginNamespace ("ARDOUR") // XXX really libtimecode .beginClass ("BBT_TIME") .addConstructor () .endClass () .endNamespace (); luabridge::getGlobalNamespace (L) .beginNamespace ("ARDOUR") .beginWSPtrClass ("PluginInfo") .addVoidConstructor () .endClass () .beginNamespace ("Properties") // templated class definitions .beginClass > ("BoolProperty").endClass () .beginClass > ("FloatProperty").endClass () .beginClass > ("FrameposProperty").endClass () // actual references (TODO: also expose GQuark for std::set) // ardour/region.h .addConst ("Start", &ARDOUR::Properties::start) .addConst ("Length", &ARDOUR::Properties::length) .addConst ("Position", &ARDOUR::Properties::position) .endNamespace () .beginClass ("PropertyChange") // TODO add special handling (std::set), PropertyID is a GQuark. // -> direct map to lua table beginStdSet()A // // expand templated PropertyDescriptor .addFunction ("containsBool", &PBD::PropertyChange::contains) .addFunction ("containsFloat", &PBD::PropertyChange::contains) .addFunction ("containsFramePos", &PBD::PropertyChange::contains) .endClass () .beginClass ("PropertyList") // is-a std::map .endClass () .deriveClass ("OwnedPropertyList") .endClass () .deriveWSPtrClass ("SessionObject") .addFunction ("name", &SessionObject::name) .endClass () .deriveWSPtrClass ("Route") .addFunction ("set_name", &Route::set_name) .addFunction ("comment", &Route::comment) .addFunction ("active", &Route::active) .addFunction ("set_active", &Route::set_active) .addFunction ("nth_plugin", &Route::nth_plugin) .endClass () .deriveWSPtrClass ("Track") .addFunction ("set_name", &Track::set_name) .addFunction ("can_record", &Track::can_record) .addFunction ("record_enabled", &Track::record_enabled) .addFunction ("record_safe", &Track::record_safe) .addFunction ("set_record_enabled", &Track::set_record_enabled) .addFunction ("set_record_safe", &Track::set_record_safe) .endClass () .deriveWSPtrClass ("AudioTrack") .endClass () .deriveWSPtrClass ("MidiTrack") .endClass () .deriveWSPtrClass ("Region") .endClass () .beginWSPtrClass ("Source") .endClass () .beginClass ("EvoralParameter") .addConstructor () .addFunction ("type", &Evoral::Parameter::type) .addFunction ("channel", &Evoral::Parameter::channel) .addFunction ("id", &Evoral::Parameter::id) .endClass () .beginWSPtrClass ("EvoralControlList") .addFunction ("add", &Evoral::ControlList::add) .endClass () .beginWSPtrClass ("EvoralControlSet") .endClass () .deriveWSPtrClass ("Automatable") .addFunction ("automation_control", (boost::shared_ptr(Automatable::*)(const Evoral::Parameter&, bool))&Automatable::automation_control) .endClass () .beginWSPtrClass ("EvoralControl") .addFunction ("list", (boost::shared_ptr(Evoral::Control::*)())&Evoral::Control::list) .endClass () .beginClass ("EvoralParameterDescriptor") .addVoidConstructor () .addData ("lower", &Evoral::ParameterDescriptor::lower) .addData ("upper", &Evoral::ParameterDescriptor::upper) .addData ("normal", &Evoral::ParameterDescriptor::normal) .addData ("toggled", &Evoral::ParameterDescriptor::toggled) .endClass () .deriveClass ("ParameterDescriptor") .addVoidConstructor () .addData ("label", &ParameterDescriptor::label) .addData ("logarithmic", &ParameterDescriptor::logarithmic) .endClass () .deriveWSPtrClass ("Processor") // TODO mult. inheritance .endClass () .deriveWSPtrClass ("Processor") .addCast ("to_insert") .addFunction ("display_name", &Processor::display_name) .addFunction ("active", &Processor::active) .addFunction ("activate", &Processor::activate) .addFunction ("deactivate", &Processor::deactivate) .addFunction ("control", (boost::shared_ptr(Evoral::ControlSet::*)(const Evoral::Parameter&, bool))&Evoral::ControlSet::control) .addFunction ("automation_control", (boost::shared_ptr(Automatable::*)(const Evoral::Parameter&, bool))&Automatable::automation_control) .endClass () .deriveWSPtrClass ("PluginInsert") .addFunction ("label", &Plugin::label) .addFunction ("name", &Plugin::name) .addFunction ("maker", &Plugin::maker) .addFunction ("parameter_count", &Plugin::parameter_count) .addFunction ("nth_parameter", &Plugin::nth_parameter) .addFunction ("parameter_is_input", &Plugin::parameter_is_input) .addFunction ("get_docs", &Plugin::get_docs) .addFunction ("get_parameter_docs", &Plugin::get_parameter_docs) .addRefFunction ("get_parameter_descriptor", &Plugin::get_parameter_descriptor) .endClass () .deriveWSPtrClass ("PluginInsert") .addFunction ("plugin", &PluginInsert::plugin) .addFunction ("activate", &PluginInsert::activate) .addFunction ("deactivate", &PluginInsert::deactivate) .endClass () .deriveWSPtrClass ("AutomationControl") .addFunction ("automation_state", &AutomationControl::automation_state) .addFunction ("automation_style", &AutomationControl::automation_style) .addFunction ("set_automation_state", &AutomationControl::set_automation_state) .addFunction ("set_automation_style", &AutomationControl::set_automation_style) .addFunction ("start_touch", &AutomationControl::start_touch) .addFunction ("stop_touch", &AutomationControl::stop_touch) .addFunction ("get_value", &AutomationControl::get_value) .addFunction ("set_value", &AutomationControl::set_value) .addFunction ("writable", &AutomationControl::writable) .endClass () .deriveWSPtrClass ("PluginControl") .endClass () .deriveWSPtrClass ("AudioSource") .addFunction ("readable_length", &AudioSource::readable_length) .addFunction ("n_channels", &AudioSource::n_channels) .endClass () // > .beginStdList > ("AudioTrackList") .endClass () // std::list > .beginStdList > ("MidiTrackList") .endClass () // RouteList == boost::shared_ptr > > .beginPtrStdList > ("RouteListPtr") .endClass () // typedef std::list > WeakRouteList .beginConstStdList > ("WeakRouteList") .endClass () // std::list< boost::weak_ptr .beginConstStdList > ("WeakAudioSourceList") .endClass () #if 0 // depends on Evoal:: Note, Beats see note_fixer.h // typedef Evoral::Note Note; // std::set< boost::weak_ptr > .beginStdSet > ("WeakNoteSet") .endClass () #endif // typedef std::set > PortSet .beginStdSet > ("WeakPortSet") .endClass () // std::list > .beginConstStdList > ("WeakSourceList") .endClass () .beginClass ("Tempo") .addConstructor () .addFunction ("note_type", &Tempo::note_type) .addFunction ("beats_per_minute", &Tempo::beats_per_minute) .addFunction ("frames_per_beat", &Tempo::frames_per_beat) .endClass () .beginClass ("Meter") .addConstructor () .addFunction ("divisions_per_bar", &Meter::divisions_per_bar) .addFunction ("note_divisor", &Meter::note_divisor) .addFunction ("frames_per_bar", &Meter::frames_per_bar) .addFunction ("frames_per_grid", &Meter::frames_per_grid) .endClass () .beginClass ("TempoMap") .addFunction ("add_tempo", &TempoMap::add_tempo) .addFunction ("add_meter", &TempoMap::add_meter) .endClass () .beginClass ("ChanCount") .addFunction ("n_audio", &ChanCount::n_audio) .endClass() .beginClass ("DataType") .addConstructor () .endClass() /* libardour enums */ .beginNamespace ("Autostyle") .addConst ("Absolute", ARDOUR::AutoState(Absolute)) .addConst ("Trim", ARDOUR::AutoState(Trim)) .endNamespace () .beginNamespace ("AutoState") .addConst ("Off", ARDOUR::AutoState(Off)) .addConst ("Write", ARDOUR::AutoState(Write)) .addConst ("Touch", ARDOUR::AutoState(Touch)) .addConst ("Play", ARDOUR::AutoState(Play)) .endNamespace () .beginNamespace ("AutomationType") .addConst ("PluginAutomation", ARDOUR::AutomationType(PluginAutomation)) .endNamespace () .beginNamespace ("SrcQuality") .addConst ("SrcBest", ARDOUR::SrcQuality(SrcBest)) .endNamespace () .beginNamespace ("PlaylistDisposition") .addConst ("CopyPlaylist", ARDOUR::PlaylistDisposition(CopyPlaylist)) .addConst ("NewPlaylist", ARDOUR::PlaylistDisposition(NewPlaylist)) .addConst ("SharePlaylist", ARDOUR::PlaylistDisposition(SharePlaylist)) .endNamespace (); luabridge::getGlobalNamespace (L) .beginNamespace ("ARDOUR") .beginClass ("AudioBackendInfo") .addData ("name", &AudioBackendInfo::name) .endClass() .beginStdVector ("BackendVector").endClass () .beginNamespace ("ARDOUR") .beginClass ("DeviceStatus") .addData ("name", &AudioBackend::DeviceStatus::name) .addData ("available", &AudioBackend::DeviceStatus::available) .endClass() .beginStdVector ("DeviceStatusVector").endClass () .endNamespace () .beginWSPtrClass ("AudioBackend") .addFunction ("info", &AudioBackend::info) .addFunction ("sample_rate", &AudioBackend::sample_rate) .addFunction ("buffer_size", &AudioBackend::buffer_size) .addFunction ("period_size", &AudioBackend::period_size) .addFunction ("input_channels", &AudioBackend::input_channels) .addFunction ("output_channels", &AudioBackend::output_channels) .addFunction ("dsp_load", &AudioBackend::dsp_load) .addFunction ("set_sample_rate", &AudioBackend::set_sample_rate) .addFunction ("set_buffer_size", &AudioBackend::set_buffer_size) .addFunction ("set_peridod_size", &AudioBackend::set_peridod_size) .addFunction ("enumerate_drivers", &AudioBackend::enumerate_drivers) .addFunction ("driver_name", &AudioBackend::driver_name) .addFunction ("set_driver", &AudioBackend::set_driver) .addFunction ("use_separate_input_and_output_devices", &AudioBackend::use_separate_input_and_output_devices) .addFunction ("enumerate_devices", &AudioBackend::enumerate_devices) .addFunction ("enumerate_input_devices", &AudioBackend::enumerate_input_devices) .addFunction ("enumerate_output_devices", &AudioBackend::enumerate_output_devices) .addFunction ("device_name", &AudioBackend::device_name) .addFunction ("input_device_name", &AudioBackend::input_device_name) .addFunction ("output_device_name", &AudioBackend::output_device_name) .addFunction ("set_device_name", &AudioBackend::set_device_name) .addFunction ("set_input_device_name", &AudioBackend::set_input_device_name) .addFunction ("set_output_device_name", &AudioBackend::set_output_device_name) .endClass() .beginClass ("AudioEngine") .addFunction ("available_backends", &AudioEngine::available_backends) .addFunction ("current_backend_name", &AudioEngine::current_backend_name) .addFunction ("set_backend", &AudioEngine::set_backend) .addFunction ("setup_required", &AudioEngine::setup_required) .addFunction ("start", &AudioEngine::start) .addFunction ("stop", &AudioEngine::stop) .addFunction ("get_dsp_load", &AudioEngine::get_dsp_load) .addFunction ("set_device_name", &AudioEngine::set_device_name) .addFunction ("set_sample_rate", &AudioEngine::set_sample_rate) .addFunction ("set_buffer_size", &AudioEngine::set_buffer_size) .addFunction ("get_last_backend_error", &AudioEngine::get_last_backend_error) .endClass() .endNamespace (); // basic representation of Session // functions which can be used from realtime and non-realtime contexts luabridge::getGlobalNamespace (L) .beginNamespace ("ARDOUR") .beginClass ("Session") .addFunction ("scripts_changed", &Session::scripts_changed) // used internally .addFunction ("transport_rolling", &Session::transport_rolling) .addFunction ("request_transport_speed", &Session::request_transport_speed) .addFunction ("transport_frame", &Session::transport_frame) .addFunction ("transport_speed", &Session::transport_speed) .addFunction ("frame_rate", &Session::frame_rate) .addFunction ("nominal_frame_rate", &Session::nominal_frame_rate) .addFunction ("frames_per_timecode_frame", &Session::frames_per_timecode_frame) .addFunction ("timecode_frames_per_hour", &Session::timecode_frames_per_hour) .addFunction ("timecode_frames_per_second", &Session::timecode_frames_per_second) .addFunction ("timecode_drop_frames", &Session::timecode_drop_frames) .addFunction ("request_locate", &Session::request_locate) .addFunction ("request_stop", &Session::request_stop) .addFunction ("last_transport_start", &Session::last_transport_start) .addFunction ("goto_start", &Session::goto_start) .addFunction ("goto_end", &Session::goto_end) .addFunction ("current_start_frame", &Session::current_start_frame) .addFunction ("current_end_frame", &Session::current_end_frame) .addFunction ("actively_recording", &Session::actively_recording) .addFunction ("get_routes", &Session::get_routes) .addFunction ("get_tracks", &Session::get_tracks) .addFunction ("name", &Session::name) .addFunction ("path", &Session::path) .addFunction ("record_status", &Session::record_status) .addFunction ("route_by_id", &Session::route_by_id) .addFunction ("route_by_name", &Session::route_by_name) .addFunction ("route_by_remote_id", &Session::route_by_remote_id) .addFunction ("track_by_diskstream_id", &Session::track_by_diskstream_id) .addFunction ("source_by_id", &Session::source_by_id) .addFunction ("controllable_by_id", &Session::controllable_by_id) .addFunction ("processor_by_id", &Session::processor_by_id) .addFunction ("snap_name", &Session::snap_name) .addFunction ("tempo_map", (TempoMap& (Session::*)())&Session::tempo_map) .endClass () .beginClass ("RegionFactory") .addStaticFunction ("region_by_id", &RegionFactory::region_by_id) .endClass () /* session enums */ .beginNamespace ("Session") .beginNamespace ("RecordState") .addConst ("Disabled", ARDOUR::Session::RecordState(Session::Disabled)) .addConst ("Enabled", ARDOUR::Session::RecordState(Session::Enabled)) .addConst ("Recording", ARDOUR::Session::RecordState(Session::Recording)) .endNamespace () .endNamespace () // END Session enums .endNamespace ();// END ARDOUR } void LuaBindings::dsp (lua_State* L) { luabridge::getGlobalNamespace (L) .beginNamespace ("ARDOUR") .beginClass ("AudioBuffer") .addFunction ("data", (Sample*(AudioBuffer::*)(framecnt_t))&AudioBuffer::data) .addFunction ("silence", &AudioBuffer::silence) .addFunction ("apply_gain", &AudioBuffer::apply_gain) .endClass() .beginClass ("MidiBuffer") .addFunction ("silence", &MidiBuffer::silence) .addFunction ("empty", &MidiBuffer::empty) // TODO iterators.. .endClass() .beginClass ("BufferSet") .addFunction ("get_audio", static_cast(&BufferSet::get_audio)) .addFunction ("count", static_cast(&BufferSet::count)) .endClass() .beginClass ("ChanMapping") .addFunction ("get", static_cast(&ChanMapping::get)) .addFunction ("set", &ChanMapping::set) .addConst ("Invalid", 4294967295) // UINT32_MAX .endClass () .endNamespace (); luabridge::getGlobalNamespace (L) .beginNamespace ("Evoral") .beginClass > ("Event") .addFunction ("clear", &Evoral::Event::clear) .addFunction ("size", &Evoral::Event::size) .addFunction ("set_buffer", &Evoral::Event::set_buffer) .addFunction ("buffer", (uint8_t*(Evoral::Event::*)())&Evoral::Event::buffer) .endClass () .deriveClass , Evoral::Event > ("MidiEvent") // add Ctor? .addFunction ("type", &Evoral::MIDIEvent::type) .addFunction ("channel", &Evoral::MIDIEvent::channel) .addFunction ("set_type", &Evoral::MIDIEvent::type) .addFunction ("set_channel", &Evoral::MIDIEvent::channel) .endClass () .endNamespace (); // dsp releated session functions luabridge::getGlobalNamespace (L) .beginNamespace ("ARDOUR") .beginClass ("Session") .addFunction ("get_scratch_buffers", &Session::get_scratch_buffers) .addFunction ("get_silent_buffers", &Session::get_silent_buffers) .endClass () .endNamespace (); luabridge::getGlobalNamespace (L) .beginNamespace ("ARDOUR") .beginNamespace ("DSP") .addFunction ("compute_peak", ARDOUR::compute_peak) .addFunction ("find_peaks", ARDOUR::find_peaks) .addFunction ("apply_gain_to_buffer", ARDOUR::apply_gain_to_buffer) .addFunction ("mix_buffers_no_gain", ARDOUR::mix_buffers_no_gain) .addFunction ("mix_buffers_with_gain", ARDOUR::mix_buffers_with_gain) .addFunction ("copy_vector", ARDOUR::copy_vector) .addFunction ("dB_to_coefficient", &dB_to_coefficient) .addFunction ("fast_coefficient_to_dB", &fast_coefficient_to_dB) .addFunction ("accurate_coefficient_to_dB", &accurate_coefficient_to_dB) .addFunction ("memset", &DSP::memset) .addFunction ("mmult", &DSP::mmult) .beginClass ("LowPass") .addConstructor () .addFunction ("proc", &DSP::LowPass::proc) .addFunction ("ctrl", &DSP::LowPass::ctrl) .addFunction ("set_cutoff", &DSP::LowPass::set_cutoff) .addFunction ("reset", &DSP::LowPass::reset) .endClass () .beginClass ("Biquad") .addConstructor () .addFunction ("run", &DSP::BiQuad::run) .addFunction ("compute", &DSP::BiQuad::compute) .addFunction ("reset", &DSP::BiQuad::reset) .endClass () .endNamespace () .endNamespace (); } void LuaBindings::session (lua_State* L) { // non-realtime session functions luabridge::getGlobalNamespace (L) .beginNamespace ("ARDOUR") .beginClass ("Session") .addFunction ("save_state", &Session::save_state) .addFunction ("set_dirty", &Session::set_dirty) .addFunction ("unknown_processors", &Session::unknown_processors) .addFunction ("new_route_from_template", &Session::new_route_from_template) // TODO session_add_audio_track session_add_midi_track session_add_mixed_track //.addFunction ("new_midi_track", &Session::new_midi_track) .endClass () .endNamespace (); // ARDOUR } void LuaBindings::set_session (lua_State* L, Session *s) { /* LuaBridge uses unique keys to identify classes/c-types. * * Those keys are "generated" by using the memory-address of a static * variable, templated for every Class. * (see libs/lua/LuaBridge/detail/ClassInfo.h) * * When linking the final executable there must be exactly one static * function (static variable) for every templated class. * This works fine on OSX and Linux... * * Windows (mingw and MSVC) however expand the template differently for libardour * AND gtk2_ardour. We end up with two identical static functions * at different addresses!! * * The Solution: have gtk2_ardour never include LuaBridge headers directly * and always go via libardour function calls for classes that are registered * in libardour. (calling lua itself is fine, calling c-functions in the GUI * which expand the template is not) * * (the actual cause: even static symbols in a .dll have no fixed address * and are mapped when loading the dll. static functions in .exe do have a fixed * address) * * libardour: * 0000000000000000 I __imp__ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value * 0000000000000000 I __nm__ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value * 0000000000000000 T _ZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEv * * ardour.exe * 000000000104f560 d .data$_ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value * 000000000104f560 D _ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value * 0000000000e9baf0 T _ZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEv * * */ luabridge::push (L, s); lua_setglobal (L, "Session"); if (s) { // call lua function. luabridge::LuaRef cb_ses = luabridge::getGlobal (L, "new_session"); if (cb_ses.type() == LUA_TFUNCTION) { cb_ses(s->name()); } // TODO args } }