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.
19 #include "timecode/bbt_time.h"
20 #include "evoral/Control.hpp"
21 #include "evoral/ControlList.hpp"
23 #include "ardour/audioengine.h"
24 #include "ardour/audiosource.h"
25 #include "ardour/audio_backend.h"
26 #include "ardour/audio_buffer.h"
27 #include "ardour/audio_track.h"
28 #include "ardour/buffer_set.h"
29 #include "ardour/chan_mapping.h"
30 #include "ardour/dB.h"
31 #include "ardour/dsp_filter.h"
32 #include "ardour/lua_api.h"
33 #include "ardour/luabindings.h"
34 #include "ardour/meter.h"
35 #include "ardour/midi_track.h"
36 #include "ardour/plugin.h"
37 #include "ardour/plugin_insert.h"
38 #include "ardour/runtime_functions.h"
39 #include "ardour/region.h"
40 #include "ardour/region_factory.h"
41 #include "ardour/session.h"
42 #include "ardour/session_object.h"
43 #include "ardour/tempo.h"
45 #include "LuaBridge/LuaBridge.h"
47 /* Some notes on Lua bindings for libardour and friends
49 * - Prefer factory methods over Contructors whenever possible.
50 * Don't expose the constructor method unless required.
52 * e.g. Don't allow the script to construct a "Track" Object directly
53 * but do allow to create a "BBT_TIME" object.
55 * - Do not dereference Shared or Weak Pointers. Pass the pointer to Lua.
56 * - Define Objects as boost:shared_ptr Object whenever possible.
58 * Storing a boost::shared_ptr in a Lua-variable keeps the reference
59 * until that variable is set to 'nil'.
60 * (if the script were to keep a direct pointer to the object instance, the
61 * behaviour is undefined if the actual object goes away)
63 * Methods of the actual class are indirectly exposed,
64 * boost::*_ptr get() and ::lock() is implicit when the class is exported
65 * as LuaBridge's "WSPtrClass".
68 using namespace ARDOUR;
71 LuaBindings::stddef (lua_State* L)
73 // std::list<std::string>
74 luabridge::getGlobalNamespace (L)
75 .beginNamespace ("ARDOUR")
76 .beginStdList <std::string> ("StringList")
80 // std::vector<std::string>
81 luabridge::getGlobalNamespace (L)
82 .beginNamespace ("ARDOUR")
83 .beginStdVector <std::string> ("StringVector")
87 // register float array (float*)
88 luabridge::getGlobalNamespace (L)
89 .beginNamespace ("ARDOUR")
90 .registerArray <float> ("FloatArray")
93 // register float array (int32_t*)
94 luabridge::getGlobalNamespace (L)
95 .beginNamespace ("ARDOUR")
96 .registerArray <int32_t> ("IntArray")
99 // std::vector<std::string>
100 luabridge::getGlobalNamespace (L)
101 .beginNamespace ("ARDOUR")
102 .beginStdVector <double> ("DoubleVector")
110 LuaBindings::common (lua_State* L)
112 luabridge::getGlobalNamespace (L)
113 .beginNamespace ("PBD")
114 .beginClass <PBD::ID> ("ID")
115 .addConstructor <void (*) (std::string)> ()
116 .addFunction ("to_s", &PBD::ID::to_s) // TODO special case LUA __tostring ?
119 .beginWSPtrClass <PBD::Stateful> ("Stateful")
120 .addFunction ("properties", &PBD::Stateful::properties)
123 .deriveWSPtrClass <PBD::StatefulDestructible, PBD::Stateful> ("StatefulDestructible")
126 .deriveWSPtrClass <PBD::Controllable, PBD::StatefulDestructible> ("Controllable")
127 .addFunction ("get_value", &PBD::Controllable::get_value)
130 .beginNamespace ("GroupControlDisposition")
131 .addConst ("InverseGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::InverseGroup))
132 .addConst ("NoGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::NoGroup))
133 .addConst ("UseGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::UseGroup))
138 luabridge::getGlobalNamespace (L)
139 .beginNamespace ("ARDOUR") // XXX really libtimecode
140 .beginClass <Timecode::BBT_Time> ("BBT_TIME")
141 .addConstructor <void (*) (uint32_t, uint32_t, uint32_t)> ()
145 luabridge::getGlobalNamespace (L)
146 .beginNamespace ("ARDOUR")
147 .beginWSPtrClass <PluginInfo> ("PluginInfo")
148 .addVoidConstructor ()
151 .beginNamespace ("Route")
152 .beginClass <Route::ProcessorStreams> ("ProcessorStreams")
153 .addVoidConstructor ()
157 .beginNamespace ("Properties")
158 // templated class definitions
159 .beginClass <PBD::PropertyDescriptor<bool> > ("BoolProperty").endClass ()
160 .beginClass <PBD::PropertyDescriptor<float> > ("FloatProperty").endClass ()
161 .beginClass <PBD::PropertyDescriptor<framepos_t> > ("FrameposProperty").endClass ()
162 // actual references (TODO: also expose GQuark for std::set)
164 .addConst ("Start", &ARDOUR::Properties::start)
165 .addConst ("Length", &ARDOUR::Properties::length)
166 .addConst ("Position", &ARDOUR::Properties::position)
169 .beginClass <PBD::PropertyChange> ("PropertyChange")
170 // TODO add special handling (std::set<PropertyID>), PropertyID is a GQuark.
171 // -> direct map to lua table beginStdSet()A
173 // expand templated PropertyDescriptor<T>
174 .addFunction ("containsBool", &PBD::PropertyChange::contains<bool>)
175 .addFunction ("containsFloat", &PBD::PropertyChange::contains<float>)
176 .addFunction ("containsFramePos", &PBD::PropertyChange::contains<framepos_t>)
179 .beginClass <PBD::PropertyList> ("PropertyList")
180 // is-a std::map<PropertyID, PropertyBase*>
183 .deriveClass <PBD::OwnedPropertyList, PBD::PropertyList> ("OwnedPropertyList")
186 .deriveWSPtrClass <SessionObject, PBD::StatefulDestructible> ("SessionObject")
187 .addFunction ("name", &SessionObject::name)
190 .deriveWSPtrClass <Route, SessionObject> ("Route")
191 .addFunction ("set_name", &Route::set_name)
192 .addFunction ("comment", &Route::comment)
193 .addFunction ("active", &Route::active)
194 .addFunction ("set_active", &Route::set_active)
195 .addFunction ("nth_plugin", &Route::nth_plugin)
196 .addFunction ("add_processor_by_index", &Route::add_processor_by_index)
199 .deriveWSPtrClass <Track, Route> ("Track")
200 .addFunction ("set_name", &Track::set_name)
201 .addFunction ("can_record", &Track::can_record)
202 .addFunction ("record_enabled", &Track::record_enabled)
203 .addFunction ("record_safe", &Track::record_safe)
204 .addFunction ("set_record_enabled", &Track::set_record_enabled)
205 .addFunction ("set_record_safe", &Track::set_record_safe)
208 .deriveWSPtrClass <AudioTrack, Track> ("AudioTrack")
211 .deriveWSPtrClass <MidiTrack, Track> ("MidiTrack")
214 .deriveWSPtrClass <Region, SessionObject> ("Region")
217 .beginWSPtrClass <Source> ("Source")
220 .beginClass <Evoral::Parameter> ("EvoralParameter")
221 .addConstructor <void (*) (uint32_t, uint8_t, uint32_t)> ()
222 .addFunction ("type", &Evoral::Parameter::type)
223 .addFunction ("channel", &Evoral::Parameter::channel)
224 .addFunction ("id", &Evoral::Parameter::id)
227 .beginWSPtrClass <Evoral::ControlList> ("EvoralControlList")
228 .addFunction ("add", &Evoral::ControlList::add)
231 .beginWSPtrClass <Evoral::ControlSet> ("EvoralControlSet")
234 .deriveWSPtrClass <Automatable, Evoral::ControlSet> ("Automatable")
235 .addFunction ("automation_control", (boost::shared_ptr<AutomationControl>(Automatable::*)(const Evoral::Parameter&, bool))&Automatable::automation_control)
238 .beginWSPtrClass <Evoral::Control> ("EvoralControl")
239 .addFunction ("list", (boost::shared_ptr<Evoral::ControlList>(Evoral::Control::*)())&Evoral::Control::list)
242 .beginClass <Evoral::ParameterDescriptor> ("EvoralParameterDescriptor")
243 .addVoidConstructor ()
244 .addData ("lower", &Evoral::ParameterDescriptor::lower)
245 .addData ("upper", &Evoral::ParameterDescriptor::upper)
246 .addData ("normal", &Evoral::ParameterDescriptor::normal)
247 .addData ("toggled", &Evoral::ParameterDescriptor::toggled)
250 .deriveClass <ParameterDescriptor, Evoral::ParameterDescriptor> ("ParameterDescriptor")
251 .addVoidConstructor ()
252 .addData ("label", &ParameterDescriptor::label)
253 .addData ("logarithmic", &ParameterDescriptor::logarithmic)
256 .deriveWSPtrClass <Processor, SessionObject> ("Processor")
257 // TODO mult. inheritance
260 .deriveWSPtrClass <Processor, Automatable> ("Processor")
261 .addCast<PluginInsert> ("to_insert")
262 .addFunction ("display_name", &Processor::display_name)
263 .addFunction ("active", &Processor::active)
264 .addFunction ("activate", &Processor::activate)
265 .addFunction ("deactivate", &Processor::deactivate)
266 .addFunction ("control", (boost::shared_ptr<Evoral::Control>(Evoral::ControlSet::*)(const Evoral::Parameter&, bool))&Evoral::ControlSet::control)
267 .addFunction ("automation_control", (boost::shared_ptr<AutomationControl>(Automatable::*)(const Evoral::Parameter&, bool))&Automatable::automation_control)
270 .deriveWSPtrClass <Plugin, PBD::StatefulDestructible> ("PluginInsert")
271 .addFunction ("label", &Plugin::label)
272 .addFunction ("name", &Plugin::name)
273 .addFunction ("maker", &Plugin::maker)
274 .addFunction ("parameter_count", &Plugin::parameter_count)
275 .addFunction ("nth_parameter", &Plugin::nth_parameter)
276 .addFunction ("parameter_is_input", &Plugin::parameter_is_input)
277 .addFunction ("get_docs", &Plugin::get_docs)
278 .addFunction ("get_parameter_docs", &Plugin::get_parameter_docs)
279 .addRefFunction ("get_parameter_descriptor", &Plugin::get_parameter_descriptor)
282 .deriveWSPtrClass <PluginInsert, Processor> ("PluginInsert")
283 .addFunction ("plugin", &PluginInsert::plugin)
284 .addFunction ("activate", &PluginInsert::activate)
285 .addFunction ("deactivate", &PluginInsert::deactivate)
288 .deriveWSPtrClass <AutomationControl, Evoral::Control> ("AutomationControl")
289 .addFunction ("automation_state", &AutomationControl::automation_state)
290 .addFunction ("automation_style", &AutomationControl::automation_style)
291 .addFunction ("set_automation_state", &AutomationControl::set_automation_state)
292 .addFunction ("set_automation_style", &AutomationControl::set_automation_style)
293 .addFunction ("start_touch", &AutomationControl::start_touch)
294 .addFunction ("stop_touch", &AutomationControl::stop_touch)
295 .addFunction ("get_value", &AutomationControl::get_value)
296 .addFunction ("set_value", &AutomationControl::set_value)
297 .addFunction ("writable", &AutomationControl::writable)
300 .deriveWSPtrClass <PluginInsert::PluginControl, AutomationControl> ("PluginControl")
303 .deriveWSPtrClass <AudioSource, Source> ("AudioSource")
304 .addFunction ("readable_length", &AudioSource::readable_length)
305 .addFunction ("n_channels", &AudioSource::n_channels)
308 // <std::list<boost::shared_ptr <AudioTrack> >
309 .beginStdList <boost::shared_ptr<AudioTrack> > ("AudioTrackList")
312 // std::list<boost::shared_ptr <MidiTrack> >
313 .beginStdList <boost::shared_ptr<MidiTrack> > ("MidiTrackList")
316 // RouteList == boost::shared_ptr<std::list<boost::shared_ptr<Route> > >
317 .beginPtrStdList <boost::shared_ptr<Route> > ("RouteListPtr")
320 // typedef std::list<boost::weak_ptr <Route> > WeakRouteList
321 .beginConstStdList <boost::weak_ptr<Route> > ("WeakRouteList")
324 // std::list< boost::weak_ptr <AudioSource>
325 .beginConstStdList <boost::weak_ptr<AudioSource> > ("WeakAudioSourceList")
328 #if 0 // depends on Evoal:: Note, Beats see note_fixer.h
329 // typedef Evoral::Note<Evoral::Beats> Note;
330 // std::set< boost::weak_ptr<Note> >
331 .beginStdSet <boost::weak_ptr<Note> > ("WeakNoteSet")
335 // typedef std::set<boost::weak_ptr<AudioPort> > PortSet
336 .beginStdSet <boost::weak_ptr<AudioPort> > ("WeakPortSet")
339 // std::list<boost::weak_ptr<Source> >
340 .beginConstStdList <boost::weak_ptr<Source> > ("WeakSourceList")
343 .beginClass <Tempo> ("Tempo")
344 .addConstructor <void (*) (double, double)> ()
345 .addFunction ("note_type", &Tempo::note_type)
346 .addFunction ("beats_per_minute", &Tempo::beats_per_minute)
347 .addFunction ("frames_per_beat", &Tempo::frames_per_beat)
350 .beginClass <Meter> ("Meter")
351 .addConstructor <void (*) (double, double)> ()
352 .addFunction ("divisions_per_bar", &Meter::divisions_per_bar)
353 .addFunction ("note_divisor", &Meter::note_divisor)
354 .addFunction ("frames_per_bar", &Meter::frames_per_bar)
355 .addFunction ("frames_per_grid", &Meter::frames_per_grid)
358 .beginClass <TempoMap> ("TempoMap")
359 .addFunction ("add_tempo", &TempoMap::add_tempo)
360 .addFunction ("add_meter", &TempoMap::add_meter)
363 .beginClass <ChanCount> ("ChanCount")
364 .addFunction ("n_audio", &ChanCount::n_audio)
367 .beginClass <DataType> ("DataType")
368 .addConstructor <void (*) (std::string)> ()
371 /* libardour enums */
372 .beginNamespace ("Autostyle")
373 .addConst ("Absolute", ARDOUR::AutoState(Absolute))
374 .addConst ("Trim", ARDOUR::AutoState(Trim))
377 .beginNamespace ("AutoState")
378 .addConst ("Off", ARDOUR::AutoState(Off))
379 .addConst ("Write", ARDOUR::AutoState(Write))
380 .addConst ("Touch", ARDOUR::AutoState(Touch))
381 .addConst ("Play", ARDOUR::AutoState(Play))
384 .beginNamespace ("AutomationType")
385 .addConst ("PluginAutomation", ARDOUR::AutomationType(PluginAutomation))
388 .beginNamespace ("SrcQuality")
389 .addConst ("SrcBest", ARDOUR::SrcQuality(SrcBest))
392 .beginNamespace ("PlaylistDisposition")
393 .addConst ("CopyPlaylist", ARDOUR::PlaylistDisposition(CopyPlaylist))
394 .addConst ("NewPlaylist", ARDOUR::PlaylistDisposition(NewPlaylist))
395 .addConst ("SharePlaylist", ARDOUR::PlaylistDisposition(SharePlaylist))
398 luabridge::getGlobalNamespace (L)
399 .beginNamespace ("ARDOUR")
400 .beginClass <AudioBackendInfo> ("AudioBackendInfo")
401 .addData ("name", &AudioBackendInfo::name)
403 .beginStdVector <const AudioBackendInfo*> ("BackendVector").endClass ()
405 .beginNamespace ("ARDOUR")
406 .beginClass <AudioBackend::DeviceStatus> ("DeviceStatus")
407 .addData ("name", &AudioBackend::DeviceStatus::name)
408 .addData ("available", &AudioBackend::DeviceStatus::available)
410 .beginStdVector <AudioBackend::DeviceStatus> ("DeviceStatusVector").endClass ()
413 .beginWSPtrClass <AudioBackend> ("AudioBackend")
414 .addFunction ("info", &AudioBackend::info)
415 .addFunction ("sample_rate", &AudioBackend::sample_rate)
416 .addFunction ("buffer_size", &AudioBackend::buffer_size)
417 .addFunction ("period_size", &AudioBackend::period_size)
418 .addFunction ("input_channels", &AudioBackend::input_channels)
419 .addFunction ("output_channels", &AudioBackend::output_channels)
420 .addFunction ("dsp_load", &AudioBackend::dsp_load)
422 .addFunction ("set_sample_rate", &AudioBackend::set_sample_rate)
423 .addFunction ("set_buffer_size", &AudioBackend::set_buffer_size)
424 .addFunction ("set_peridod_size", &AudioBackend::set_peridod_size)
426 .addFunction ("enumerate_drivers", &AudioBackend::enumerate_drivers)
427 .addFunction ("driver_name", &AudioBackend::driver_name)
428 .addFunction ("set_driver", &AudioBackend::set_driver)
430 .addFunction ("use_separate_input_and_output_devices", &AudioBackend::use_separate_input_and_output_devices)
431 .addFunction ("enumerate_devices", &AudioBackend::enumerate_devices)
432 .addFunction ("enumerate_input_devices", &AudioBackend::enumerate_input_devices)
433 .addFunction ("enumerate_output_devices", &AudioBackend::enumerate_output_devices)
434 .addFunction ("device_name", &AudioBackend::device_name)
435 .addFunction ("input_device_name", &AudioBackend::input_device_name)
436 .addFunction ("output_device_name", &AudioBackend::output_device_name)
437 .addFunction ("set_device_name", &AudioBackend::set_device_name)
438 .addFunction ("set_input_device_name", &AudioBackend::set_input_device_name)
439 .addFunction ("set_output_device_name", &AudioBackend::set_output_device_name)
442 .beginClass <AudioEngine> ("AudioEngine")
443 .addFunction ("available_backends", &AudioEngine::available_backends)
444 .addFunction ("current_backend_name", &AudioEngine::current_backend_name)
445 .addFunction ("set_backend", &AudioEngine::set_backend)
446 .addFunction ("setup_required", &AudioEngine::setup_required)
447 .addFunction ("start", &AudioEngine::start)
448 .addFunction ("stop", &AudioEngine::stop)
449 .addFunction ("get_dsp_load", &AudioEngine::get_dsp_load)
450 .addFunction ("set_device_name", &AudioEngine::set_device_name)
451 .addFunction ("set_sample_rate", &AudioEngine::set_sample_rate)
452 .addFunction ("set_buffer_size", &AudioEngine::set_buffer_size)
453 .addFunction ("get_last_backend_error", &AudioEngine::get_last_backend_error)
457 // basic representation of Session
458 // functions which can be used from realtime and non-realtime contexts
459 luabridge::getGlobalNamespace (L)
460 .beginNamespace ("ARDOUR")
461 .beginClass <Session> ("Session")
462 .addFunction ("scripts_changed", &Session::scripts_changed) // used internally
463 .addFunction ("transport_rolling", &Session::transport_rolling)
464 .addFunction ("request_transport_speed", &Session::request_transport_speed)
465 .addFunction ("transport_frame", &Session::transport_frame)
466 .addFunction ("transport_speed", &Session::transport_speed)
467 .addFunction ("frame_rate", &Session::frame_rate)
468 .addFunction ("nominal_frame_rate", &Session::nominal_frame_rate)
469 .addFunction ("frames_per_timecode_frame", &Session::frames_per_timecode_frame)
470 .addFunction ("timecode_frames_per_hour", &Session::timecode_frames_per_hour)
471 .addFunction ("timecode_frames_per_second", &Session::timecode_frames_per_second)
472 .addFunction ("timecode_drop_frames", &Session::timecode_drop_frames)
473 .addFunction ("request_locate", &Session::request_locate)
474 .addFunction ("request_stop", &Session::request_stop)
475 .addFunction ("last_transport_start", &Session::last_transport_start)
476 .addFunction ("goto_start", &Session::goto_start)
477 .addFunction ("goto_end", &Session::goto_end)
478 .addFunction ("current_start_frame", &Session::current_start_frame)
479 .addFunction ("current_end_frame", &Session::current_end_frame)
480 .addFunction ("actively_recording", &Session::actively_recording)
481 .addFunction ("get_routes", &Session::get_routes)
482 .addFunction ("get_tracks", &Session::get_tracks)
483 .addFunction ("name", &Session::name)
484 .addFunction ("path", &Session::path)
485 .addFunction ("record_status", &Session::record_status)
486 .addFunction ("route_by_id", &Session::route_by_id)
487 .addFunction ("route_by_name", &Session::route_by_name)
488 .addFunction ("route_by_remote_id", &Session::route_by_remote_id)
489 .addFunction ("track_by_diskstream_id", &Session::track_by_diskstream_id)
490 .addFunction ("source_by_id", &Session::source_by_id)
491 .addFunction ("controllable_by_id", &Session::controllable_by_id)
492 .addFunction ("processor_by_id", &Session::processor_by_id)
493 .addFunction ("snap_name", &Session::snap_name)
494 .addFunction ("tempo_map", (TempoMap& (Session::*)())&Session::tempo_map)
497 .beginClass <RegionFactory> ("RegionFactory")
498 .addStaticFunction ("region_by_id", &RegionFactory::region_by_id)
502 .beginNamespace ("Session")
504 .beginNamespace ("RecordState")
505 .addConst ("Disabled", ARDOUR::Session::RecordState(Session::Disabled))
506 .addConst ("Enabled", ARDOUR::Session::RecordState(Session::Enabled))
507 .addConst ("Recording", ARDOUR::Session::RecordState(Session::Recording))
510 .endNamespace () // END Session enums
512 .beginNamespace ("LuaAPI")
513 .addFunction ("new_luaproc", ARDOUR::LuaAPI::new_luaproc)
516 .endNamespace ();// END ARDOUR
520 LuaBindings::dsp (lua_State* L)
522 luabridge::getGlobalNamespace (L)
523 .beginNamespace ("ARDOUR")
525 .beginClass <AudioBuffer> ("AudioBuffer")
526 .addFunction ("data", (Sample*(AudioBuffer::*)(framecnt_t))&AudioBuffer::data)
527 .addFunction ("silence", &AudioBuffer::silence)
528 .addFunction ("apply_gain", &AudioBuffer::apply_gain)
531 .beginClass <MidiBuffer> ("MidiBuffer")
532 .addFunction ("silence", &MidiBuffer::silence)
533 .addFunction ("empty", &MidiBuffer::empty)
537 .beginClass <BufferSet> ("BufferSet")
538 .addFunction ("get_audio", static_cast<AudioBuffer&(BufferSet::*)(size_t)>(&BufferSet::get_audio))
539 .addFunction ("count", static_cast<const ChanCount&(BufferSet::*)()const>(&BufferSet::count))
542 .beginClass <ChanMapping> ("ChanMapping")
543 .addFunction ("get", static_cast<uint32_t(ChanMapping::*)(DataType, uint32_t)>(&ChanMapping::get))
544 .addFunction ("set", &ChanMapping::set)
545 .addConst ("Invalid", 4294967295) // UINT32_MAX
549 luabridge::getGlobalNamespace (L)
550 .beginNamespace ("Evoral")
551 .beginClass <Evoral::Event<framepos_t> > ("Event")
552 .addFunction ("clear", &Evoral::Event<framepos_t>::clear)
553 .addFunction ("size", &Evoral::Event<framepos_t>::size)
554 .addFunction ("set_buffer", &Evoral::Event<framepos_t>::set_buffer)
555 .addFunction ("buffer", (uint8_t*(Evoral::Event<framepos_t>::*)())&Evoral::Event<framepos_t>::buffer)
558 .deriveClass <Evoral::MIDIEvent<framepos_t>, Evoral::Event<framepos_t> > ("MidiEvent")
560 .addFunction ("type", &Evoral::MIDIEvent<framepos_t>::type)
561 .addFunction ("channel", &Evoral::MIDIEvent<framepos_t>::channel)
562 .addFunction ("set_type", &Evoral::MIDIEvent<framepos_t>::type)
563 .addFunction ("set_channel", &Evoral::MIDIEvent<framepos_t>::channel)
567 // dsp releated session functions
568 luabridge::getGlobalNamespace (L)
569 .beginNamespace ("ARDOUR")
570 .beginClass <Session> ("Session")
571 .addFunction ("get_scratch_buffers", &Session::get_scratch_buffers)
572 .addFunction ("get_silent_buffers", &Session::get_silent_buffers)
576 luabridge::getGlobalNamespace (L)
577 .beginNamespace ("ARDOUR")
578 .beginNamespace ("DSP")
579 .addFunction ("compute_peak", ARDOUR::compute_peak)
580 .addFunction ("find_peaks", ARDOUR::find_peaks)
581 .addFunction ("apply_gain_to_buffer", ARDOUR::apply_gain_to_buffer)
582 .addFunction ("mix_buffers_no_gain", ARDOUR::mix_buffers_no_gain)
583 .addFunction ("mix_buffers_with_gain", ARDOUR::mix_buffers_with_gain)
584 .addFunction ("copy_vector", ARDOUR::copy_vector)
585 .addFunction ("dB_to_coefficient", &dB_to_coefficient)
586 .addFunction ("fast_coefficient_to_dB", &fast_coefficient_to_dB)
587 .addFunction ("accurate_coefficient_to_dB", &accurate_coefficient_to_dB)
588 .addFunction ("memset", &DSP::memset)
589 .addFunction ("mmult", &DSP::mmult)
590 .addFunction ("log_meter", &DSP::log_meter)
591 .addFunction ("log_meter_coeff", &DSP::log_meter_coeff)
592 .addRefFunction ("peaks", &DSP::peaks)
594 .beginClass <DSP::LowPass> ("LowPass")
595 .addConstructor <void (*) (double, float)> ()
596 .addFunction ("proc", &DSP::LowPass::proc)
597 .addFunction ("ctrl", &DSP::LowPass::ctrl)
598 .addFunction ("set_cutoff", &DSP::LowPass::set_cutoff)
599 .addFunction ("reset", &DSP::LowPass::reset)
601 .beginClass <DSP::BiQuad> ("Biquad")
602 .addConstructor <void (*) (double)> ()
603 .addFunction ("run", &DSP::BiQuad::run)
604 .addFunction ("compute", &DSP::BiQuad::compute)
605 .addFunction ("reset", &DSP::BiQuad::reset)
608 .beginClass <DSP::DspShm> ("DspShm")
609 .addFunction ("allocate", &DSP::DspShm::allocate)
610 .addFunction ("clear", &DSP::DspShm::clear)
611 .addFunction ("to_float", &DSP::DspShm::to_float)
612 .addFunction ("to_int", &DSP::DspShm::to_int)
613 .addFunction ("atomic_set_int", &DSP::DspShm::atomic_set_int)
614 .addFunction ("atomic_get_int", &DSP::DspShm::atomic_get_int)
617 .endNamespace () // DSP
618 .endNamespace (); // ARDOUR
622 LuaBindings::session (lua_State* L)
624 // non-realtime session functions
625 luabridge::getGlobalNamespace (L)
626 .beginNamespace ("ARDOUR")
627 .beginClass <Session> ("Session")
628 .addFunction ("save_state", &Session::save_state)
629 .addFunction ("set_dirty", &Session::set_dirty)
630 .addFunction ("unknown_processors", &Session::unknown_processors)
632 .addFunction<RouteList (Session::*)(uint32_t, const std::string&, const std::string&, PlaylistDisposition)> ("new_route_from_template", &Session::new_route_from_template)
633 // TODO session_add_audio_track session_add_midi_track session_add_mixed_track
634 //.addFunction ("new_midi_track", &Session::new_midi_track)
637 .endNamespace (); // ARDOUR
641 LuaBindings::osc (lua_State* L)
643 luabridge::getGlobalNamespace (L)
644 .beginNamespace ("OSC")
645 .beginClass<LuaAPI::LuaOSCAddress> ("Address")
646 .addConstructor<void (*) (std::string)> ()
647 .addCFunction ("send", &LuaAPI::LuaOSCAddress::send)
653 LuaBindings::set_session (lua_State* L, Session *s)
655 /* LuaBridge uses unique keys to identify classes/c-types.
657 * Those keys are "generated" by using the memory-address of a static
658 * variable, templated for every Class.
659 * (see libs/lua/LuaBridge/detail/ClassInfo.h)
661 * When linking the final executable there must be exactly one static
662 * function (static variable) for every templated class.
663 * This works fine on OSX and Linux...
665 * Windows (mingw and MSVC) however expand the template differently for libardour
666 * AND gtk2_ardour. We end up with two identical static functions
667 * at different addresses!!
669 * The Solution: have gtk2_ardour never include LuaBridge headers directly
670 * and always go via libardour function calls for classes that are registered
671 * in libardour. (calling lua itself is fine, calling c-functions in the GUI
672 * which expand the template is not)
674 * (the actual cause: even static symbols in a .dll have no fixed address
675 * and are mapped when loading the dll. static functions in .exe do have a fixed
679 * 0000000000000000 I __imp__ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
680 * 0000000000000000 I __nm__ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
681 * 0000000000000000 T _ZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEv
684 * 000000000104f560 d .data$_ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
685 * 000000000104f560 D _ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
686 * 0000000000e9baf0 T _ZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEv
690 luabridge::push <Session *> (L, s);
691 lua_setglobal (L, "Session");
694 // call lua function.
695 luabridge::LuaRef cb_ses = luabridge::getGlobal (L, "new_session");
696 if (cb_ses.type() == LUA_TFUNCTION) { cb_ses(s->name()); } // TODO args