libs/ardour/luabindings.cc

   1 /*
   2     Copyright (C) 2016 Robin Gareus <robin@gareus.org>
   3
   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)
   7     any later version.
   8
   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
  12     for more details.
  13
  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.
  17 */
  18
  19 #include "timecode/bbt_time.h"
  20 #include "evoral/Control.hpp"
  21 #include "evoral/ControlList.hpp"
  22
  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/luabindings.h"
  33 #include "ardour/meter.h"
  34 #include "ardour/midi_track.h"
  35 #include "ardour/plugin.h"
  36 #include "ardour/plugin_insert.h"
  37 #include "ardour/runtime_functions.h"
  38 #include "ardour/region.h"
  39 #include "ardour/region_factory.h"
  40 #include "ardour/session.h"
  41 #include "ardour/session_object.h"
  42 #include "ardour/tempo.h"
  43
  44 #include "LuaBridge/LuaBridge.h"
  45
  46 /* Some notes on Lua bindings for libardour and friends
  47  *
  48  * - Prefer factory methods over Contructors whenever possible.
  49  *   Don't expose the constructor method unless required.
  50  *
  51  *   e.g. Don't allow the script to construct a "Track" Object directly
  52  *   but do allow to create a "BBT_TIME" object.
  53  *
  54  * - Do not dereference Shared or Weak Pointers. Pass the pointer to Lua.
  55  * - Define Objects as boost:shared_ptr Object whenever possible.
  56  *
  57  *   Storing a boost::shared_ptr in a Lua-variable keeps the reference
  58  *   until that variable is set to 'nil'.
  59  *   (if the script were to keep a direct pointer to the object instance, the
  60  *   behaviour is undefined if the actual object goes away)
  61  *
  62  *   Methods of the actual class are indirectly exposed,
  63  *   boost::*_ptr get() and ::lock() is implicit when the class is exported
  64  *   as LuaBridge's "WSPtrClass".
  65  */
  66
  67 using namespace ARDOUR;
  68
  69 void
  70 LuaBindings::stddef (lua_State* L)
  71 {
  72         // std::list<std::string>
  73         luabridge::getGlobalNamespace (L)
  74                 .beginNamespace ("ARDOUR")
  75                 .beginStdList <std::string> ("StringList")
  76                 .endClass ()
  77                 .endNamespace ();
  78
  79         // std::vector<std::string>
  80         luabridge::getGlobalNamespace (L)
  81                 .beginNamespace ("ARDOUR")
  82                 .beginStdVector <std::string> ("StringVector")
  83                 .endClass ()
  84                 .endNamespace ();
  85
  86         // register float array (float*)
  87         luabridge::getGlobalNamespace (L)
  88                 .beginNamespace ("ARDOUR")
  89                 .registerArray <float> ("FloatArray")
  90                 .endNamespace ();
  91
  92         // TODO std::set
  93 }
  94
  95 void
  96 LuaBindings::common (lua_State* L)
  97 {
  98         luabridge::getGlobalNamespace (L)
  99                 .beginNamespace ("PBD")
 100                 .beginClass <PBD::ID> ("ID")
 101                 .addConstructor <void (*) (std::string)> ()
 102                 .addFunction ("to_s", &PBD::ID::to_s) // TODO special case LUA __tostring ?
 103                 .endClass ()
 104
 105                 .beginWSPtrClass <PBD::Stateful> ("Stateful")
 106                 .addFunction ("properties", &PBD::Stateful::properties)
 107                 .endClass ()
 108
 109                 .deriveWSPtrClass <PBD::StatefulDestructible, PBD::Stateful> ("StatefulDestructible")
 110                 .endClass ()
 111
 112                 .deriveWSPtrClass <PBD::Controllable, PBD::StatefulDestructible> ("Controllable")
 113                 .addFunction ("get_value", &PBD::Controllable::get_value)
 114                 .endClass ()
 115
 116                 .beginNamespace ("GroupControlDisposition")
 117                 .addConst ("InverseGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::InverseGroup))
 118                 .addConst ("NoGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::NoGroup))
 119                 .addConst ("UseGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::UseGroup))
 120                 .endNamespace ()
 121
 122                 .endNamespace ();
 123
 124         luabridge::getGlobalNamespace (L)
 125                 .beginNamespace ("ARDOUR") // XXX really libtimecode
 126                 .beginClass <Timecode::BBT_Time> ("BBT_TIME")
 127                 .addConstructor <void (*) (uint32_t, uint32_t, uint32_t)> ()
 128                 .endClass ()
 129                 .endNamespace ();
 130
 131         luabridge::getGlobalNamespace (L)
 132                 .beginNamespace ("ARDOUR")
 133                 .beginWSPtrClass <PluginInfo> ("PluginInfo")
 134                 .addVoidConstructor ()
 135                 .endClass ()
 136
 137                 .beginNamespace ("Properties")
 138                 // templated class definitions
 139                 .beginClass <PBD::PropertyDescriptor<bool> > ("BoolProperty").endClass ()
 140                 .beginClass <PBD::PropertyDescriptor<float> > ("FloatProperty").endClass ()
 141                 .beginClass <PBD::PropertyDescriptor<framepos_t> > ("FrameposProperty").endClass ()
 142                 // actual references (TODO: also expose GQuark for std::set)
 143                 //   ardour/region.h
 144                 .addConst ("Start", &ARDOUR::Properties::start)
 145                 .addConst ("Length", &ARDOUR::Properties::length)
 146                 .addConst ("Position", &ARDOUR::Properties::position)
 147                 .endNamespace ()
 148
 149                 .beginClass <PBD::PropertyChange> ("PropertyChange")
 150                 // TODO add special handling (std::set<PropertyID>), PropertyID is a GQuark.
 151                 // -> direct map to lua table  beginStdSet()A
 152                 //
 153                 // expand templated PropertyDescriptor<T>
 154                 .addFunction ("containsBool", &PBD::PropertyChange::contains<bool>)
 155                 .addFunction ("containsFloat", &PBD::PropertyChange::contains<float>)
 156                 .addFunction ("containsFramePos", &PBD::PropertyChange::contains<framepos_t>)
 157                 .endClass ()
 158
 159                 .beginClass <PBD::PropertyList> ("PropertyList")
 160                 // is-a  std::map<PropertyID, PropertyBase*>
 161                 .endClass ()
 162
 163                 .deriveClass <PBD::OwnedPropertyList, PBD::PropertyList> ("OwnedPropertyList")
 164                 .endClass ()
 165
 166                 .deriveWSPtrClass <SessionObject, PBD::StatefulDestructible> ("SessionObject")
 167                 .addFunction ("name", &SessionObject::name)
 168                 .endClass ()
 169
 170                 .deriveWSPtrClass <Route, SessionObject> ("Route")
 171                 .addFunction ("set_name", &Route::set_name)
 172                 .addFunction ("comment", &Route::comment)
 173                 .addFunction ("active", &Route::active)
 174                 .addFunction ("set_active", &Route::set_active)
 175                 .addFunction ("nth_plugin", &Route::nth_plugin)
 176                 .endClass ()
 177
 178                 .deriveWSPtrClass <Track, Route> ("Track")
 179                 .addFunction ("set_name", &Track::set_name)
 180                 .addFunction ("can_record", &Track::can_record)
 181                 .addFunction ("record_enabled", &Track::record_enabled)
 182                 .addFunction ("record_safe", &Track::record_safe)
 183                 .addFunction ("set_record_enabled", &Track::set_record_enabled)
 184                 .addFunction ("set_record_safe", &Track::set_record_safe)
 185                 .endClass ()
 186
 187                 .deriveWSPtrClass <AudioTrack, Track> ("AudioTrack")
 188                 .endClass ()
 189
 190                 .deriveWSPtrClass <MidiTrack, Track> ("MidiTrack")
 191                 .endClass ()
 192
 193                 .deriveWSPtrClass <Region, SessionObject> ("Region")
 194                 .endClass ()
 195
 196                 .beginWSPtrClass <Source> ("Source")
 197                 .endClass ()
 198
 199                 .beginClass <Evoral::Parameter> ("EvoralParameter")
 200                 .addConstructor <void (*) (uint32_t, uint8_t, uint32_t)> ()
 201                 .addFunction ("type", &Evoral::Parameter::type)
 202                 .addFunction ("channel", &Evoral::Parameter::channel)
 203                 .addFunction ("id", &Evoral::Parameter::id)
 204                 .endClass ()
 205
 206                 .beginWSPtrClass <Evoral::ControlList> ("EvoralControlList")
 207                 .addFunction ("add", &Evoral::ControlList::add)
 208                 .endClass ()
 209
 210                 .beginWSPtrClass <Evoral::ControlSet> ("EvoralControlSet")
 211                 .endClass ()
 212
 213                 .deriveWSPtrClass <Automatable, Evoral::ControlSet> ("Automatable")
 214                 .addFunction ("automation_control", (boost::shared_ptr<AutomationControl>(Automatable::*)(const Evoral::Parameter&, bool))&Automatable::automation_control)
 215                 .endClass ()
 216
 217                 .beginWSPtrClass <Evoral::Control> ("EvoralControl")
 218                 .addFunction ("list", (boost::shared_ptr<Evoral::ControlList>(Evoral::Control::*)())&Evoral::Control::list)
 219                 .endClass ()
 220
 221                 .beginClass <Evoral::ParameterDescriptor> ("EvoralParameterDescriptor")
 222                 .addVoidConstructor ()
 223                 .addData ("lower", &Evoral::ParameterDescriptor::lower)
 224                 .addData ("upper", &Evoral::ParameterDescriptor::upper)
 225                 .addData ("normal", &Evoral::ParameterDescriptor::normal)
 226                 .addData ("toggled", &Evoral::ParameterDescriptor::toggled)
 227                 .endClass ()
 228
 229                 .deriveClass <ParameterDescriptor, Evoral::ParameterDescriptor> ("ParameterDescriptor")
 230                 .addVoidConstructor ()
 231                 .addData ("label", &ParameterDescriptor::label)
 232                 .addData ("logarithmic", &ParameterDescriptor::logarithmic)
 233                 .endClass ()
 234
 235                 .deriveWSPtrClass <Processor, SessionObject> ("Processor")
 236                 // TODO mult. inheritance
 237                 .endClass ()
 238
 239                 .deriveWSPtrClass <Processor, Automatable> ("Processor")
 240                 .addCast<PluginInsert> ("to_insert")
 241                 .addFunction ("display_name", &Processor::display_name)
 242                 .addFunction ("active", &Processor::active)
 243                 .addFunction ("activate", &Processor::activate)
 244                 .addFunction ("deactivate", &Processor::deactivate)
 245                 .addFunction ("control", (boost::shared_ptr<Evoral::Control>(Evoral::ControlSet::*)(const Evoral::Parameter&, bool))&Evoral::ControlSet::control)
 246                 .addFunction ("automation_control", (boost::shared_ptr<AutomationControl>(Automatable::*)(const Evoral::Parameter&, bool))&Automatable::automation_control)
 247                 .endClass ()
 248
 249                 .deriveWSPtrClass <Plugin, PBD::StatefulDestructible> ("PluginInsert")
 250                 .addFunction ("label", &Plugin::label)
 251                 .addFunction ("name", &Plugin::name)
 252                 .addFunction ("maker", &Plugin::maker)
 253                 .addFunction ("parameter_count", &Plugin::parameter_count)
 254                 .addFunction ("nth_parameter", &Plugin::nth_parameter)
 255                 .addFunction ("parameter_is_input", &Plugin::parameter_is_input)
 256                 .addFunction ("get_docs", &Plugin::get_docs)
 257                 .addFunction ("get_parameter_docs", &Plugin::get_parameter_docs)
 258                 .addRefFunction ("get_parameter_descriptor", &Plugin::get_parameter_descriptor)
 259                 .endClass ()
 260
 261                 .deriveWSPtrClass <PluginInsert, Processor> ("PluginInsert")
 262                 .addFunction ("plugin", &PluginInsert::plugin)
 263                 .addFunction ("activate", &PluginInsert::activate)
 264                 .addFunction ("deactivate", &PluginInsert::deactivate)
 265                 .endClass ()
 266
 267                 .deriveWSPtrClass <AutomationControl, Evoral::Control> ("AutomationControl")
 268                 .addFunction ("automation_state", &AutomationControl::automation_state)
 269                 .addFunction ("automation_style", &AutomationControl::automation_style)
 270                 .addFunction ("set_automation_state", &AutomationControl::set_automation_state)
 271                 .addFunction ("set_automation_style", &AutomationControl::set_automation_style)
 272                 .addFunction ("start_touch", &AutomationControl::start_touch)
 273                 .addFunction ("stop_touch", &AutomationControl::stop_touch)
 274                 .addFunction ("get_value", &AutomationControl::get_value)
 275                 .addFunction ("set_value", &AutomationControl::set_value)
 276                 .addFunction ("writable", &AutomationControl::writable)
 277                 .endClass ()
 278
 279                 .deriveWSPtrClass <PluginInsert::PluginControl, AutomationControl> ("PluginControl")
 280                 .endClass ()
 281
 282                 .deriveWSPtrClass <AudioSource, Source> ("AudioSource")
 283                 .addFunction ("readable_length", &AudioSource::readable_length)
 284                 .addFunction ("n_channels", &AudioSource::n_channels)
 285                 .endClass ()
 286
 287         // <std::list<boost::shared_ptr <AudioTrack> >
 288                 .beginStdList <boost::shared_ptr<AudioTrack> > ("AudioTrackList")
 289                 .endClass ()
 290
 291         // std::list<boost::shared_ptr <MidiTrack> >
 292                 .beginStdList <boost::shared_ptr<MidiTrack> > ("MidiTrackList")
 293                 .endClass ()
 294
 295         // RouteList ==  boost::shared_ptr<std::list<boost::shared_ptr<Route> > >
 296                 .beginPtrStdList <boost::shared_ptr<Route> > ("RouteListPtr")
 297                 .endClass ()
 298
 299         // typedef std::list<boost::weak_ptr <Route> > WeakRouteList
 300                 .beginConstStdList <boost::weak_ptr<Route> > ("WeakRouteList")
 301                 .endClass ()
 302
 303         // std::list< boost::weak_ptr <AudioSource>
 304                 .beginConstStdList <boost::weak_ptr<AudioSource> > ("WeakAudioSourceList")
 305                 .endClass ()
 306
 307 #if 0  // depends on Evoal:: Note, Beats see note_fixer.h
 308         // typedef Evoral::Note<Evoral::Beats> Note;
 309         // std::set< boost::weak_ptr<Note> >
 310                 .beginStdSet <boost::weak_ptr<Note> > ("WeakNoteSet")
 311                 .endClass ()
 312 #endif
 313
 314         // typedef std::set<boost::weak_ptr<AudioPort> > PortSet
 315                 .beginStdSet <boost::weak_ptr<AudioPort> > ("WeakPortSet")
 316                 .endClass ()
 317
 318         // std::list<boost::weak_ptr<Source> >
 319                 .beginConstStdList <boost::weak_ptr<Source> > ("WeakSourceList")
 320                 .endClass ()
 321
 322                 .beginClass <Tempo> ("Tempo")
 323                 .addConstructor <void (*) (double, double)> ()
 324                 .addFunction ("note_type", &Tempo::note_type)
 325                 .addFunction ("beats_per_minute", &Tempo::beats_per_minute)
 326                 .addFunction ("frames_per_beat", &Tempo::frames_per_beat)
 327                 .endClass ()
 328
 329                 .beginClass <Meter> ("Meter")
 330                 .addConstructor <void (*) (double, double)> ()
 331                 .addFunction ("divisions_per_bar", &Meter::divisions_per_bar)
 332                 .addFunction ("note_divisor", &Meter::note_divisor)
 333                 .addFunction ("frames_per_bar", &Meter::frames_per_bar)
 334                 .addFunction ("frames_per_grid", &Meter::frames_per_grid)
 335                 .endClass ()
 336
 337                 .beginClass <TempoMap> ("TempoMap")
 338                 .addFunction ("add_tempo", &TempoMap::add_tempo)
 339                 .addFunction ("add_meter", &TempoMap::add_meter)
 340                 .endClass ()
 341
 342                 .beginClass <ChanCount> ("ChanCount")
 343                 .addFunction ("n_audio", &ChanCount::n_audio)
 344                 .endClass()
 345
 346                 .beginClass <DataType> ("DataType")
 347                 .addConstructor <void (*) (std::string)> ()
 348                 .endClass()
 349
 350                 /* libardour enums */
 351                 .beginNamespace ("Autostyle")
 352                 .addConst ("Absolute", ARDOUR::AutoState(Absolute))
 353                 .addConst ("Trim", ARDOUR::AutoState(Trim))
 354                 .endNamespace ()
 355
 356                 .beginNamespace ("AutoState")
 357                 .addConst ("Off", ARDOUR::AutoState(Off))
 358                 .addConst ("Write", ARDOUR::AutoState(Write))
 359                 .addConst ("Touch", ARDOUR::AutoState(Touch))
 360                 .addConst ("Play", ARDOUR::AutoState(Play))
 361                 .endNamespace ()
 362
 363                 .beginNamespace ("AutomationType")
 364                 .addConst ("PluginAutomation", ARDOUR::AutomationType(PluginAutomation))
 365                 .endNamespace ()
 366
 367                 .beginNamespace ("SrcQuality")
 368                 .addConst ("SrcBest", ARDOUR::SrcQuality(SrcBest))
 369                 .endNamespace ()
 370
 371                 .beginNamespace ("PlaylistDisposition")
 372                 .addConst ("CopyPlaylist", ARDOUR::PlaylistDisposition(CopyPlaylist))
 373                 .addConst ("NewPlaylist", ARDOUR::PlaylistDisposition(NewPlaylist))
 374                 .addConst ("SharePlaylist", ARDOUR::PlaylistDisposition(SharePlaylist))
 375                 .endNamespace ();
 376
 377         luabridge::getGlobalNamespace (L)
 378                 .beginNamespace ("ARDOUR")
 379                 .beginClass <AudioBackendInfo> ("AudioBackendInfo")
 380                 .addData ("name", &AudioBackendInfo::name)
 381                 .endClass()
 382                 .beginStdVector <const AudioBackendInfo*> ("BackendVector").endClass ()
 383
 384                 .beginNamespace ("ARDOUR")
 385                 .beginClass <AudioBackend::DeviceStatus> ("DeviceStatus")
 386                 .addData ("name", &AudioBackend::DeviceStatus::name)
 387                 .addData ("available", &AudioBackend::DeviceStatus::available)
 388                 .endClass()
 389                 .beginStdVector <AudioBackend::DeviceStatus> ("DeviceStatusVector").endClass ()
 390                 .endNamespace ()
 391
 392                 .beginWSPtrClass <AudioBackend> ("AudioBackend")
 393                 .addFunction ("info", &AudioBackend::info)
 394                 .addFunction ("sample_rate", &AudioBackend::sample_rate)
 395                 .addFunction ("buffer_size", &AudioBackend::buffer_size)
 396                 .addFunction ("period_size", &AudioBackend::period_size)
 397                 .addFunction ("input_channels", &AudioBackend::input_channels)
 398                 .addFunction ("output_channels", &AudioBackend::output_channels)
 399                 .addFunction ("dsp_load", &AudioBackend::dsp_load)
 400
 401                 .addFunction ("set_sample_rate", &AudioBackend::set_sample_rate)
 402                 .addFunction ("set_buffer_size", &AudioBackend::set_buffer_size)
 403                 .addFunction ("set_peridod_size", &AudioBackend::set_peridod_size)
 404
 405                 .addFunction ("enumerate_drivers", &AudioBackend::enumerate_drivers)
 406                 .addFunction ("driver_name", &AudioBackend::driver_name)
 407                 .addFunction ("set_driver", &AudioBackend::set_driver)
 408
 409                 .addFunction ("use_separate_input_and_output_devices", &AudioBackend::use_separate_input_and_output_devices)
 410                 .addFunction ("enumerate_devices", &AudioBackend::enumerate_devices)
 411                 .addFunction ("enumerate_input_devices", &AudioBackend::enumerate_input_devices)
 412                 .addFunction ("enumerate_output_devices", &AudioBackend::enumerate_output_devices)
 413                 .addFunction ("device_name", &AudioBackend::device_name)
 414                 .addFunction ("input_device_name", &AudioBackend::input_device_name)
 415                 .addFunction ("output_device_name", &AudioBackend::output_device_name)
 416                 .addFunction ("set_device_name", &AudioBackend::set_device_name)
 417                 .addFunction ("set_input_device_name", &AudioBackend::set_input_device_name)
 418                 .addFunction ("set_output_device_name", &AudioBackend::set_output_device_name)
 419                 .endClass()
 420
 421                 .beginClass <AudioEngine> ("AudioEngine")
 422                 .addFunction ("available_backends", &AudioEngine::available_backends)
 423                 .addFunction ("current_backend_name", &AudioEngine::current_backend_name)
 424                 .addFunction ("set_backend", &AudioEngine::set_backend)
 425                 .addFunction ("setup_required", &AudioEngine::setup_required)
 426                 .addFunction ("start", &AudioEngine::start)
 427                 .addFunction ("stop", &AudioEngine::stop)
 428                 .addFunction ("get_dsp_load", &AudioEngine::get_dsp_load)
 429                 .addFunction ("set_device_name", &AudioEngine::set_device_name)
 430                 .addFunction ("set_sample_rate", &AudioEngine::set_sample_rate)
 431                 .addFunction ("set_buffer_size", &AudioEngine::set_buffer_size)
 432                 .addFunction ("get_last_backend_error", &AudioEngine::get_last_backend_error)
 433                 .endClass()
 434                 .endNamespace ();
 435
 436         // basic representation of Session
 437         // functions which can be used from realtime and non-realtime contexts
 438         luabridge::getGlobalNamespace (L)
 439                 .beginNamespace ("ARDOUR")
 440                 .beginClass <Session> ("Session")
 441                 .addFunction ("transport_rolling", &Session::transport_rolling)
 442                 .addFunction ("request_transport_speed", &Session::request_transport_speed)
 443                 .addFunction ("transport_frame", &Session::transport_frame)
 444                 .addFunction ("transport_speed", &Session::transport_speed)
 445                 .addFunction ("frame_rate", &Session::frame_rate)
 446                 .addFunction ("nominal_frame_rate", &Session::nominal_frame_rate)
 447                 .addFunction ("frames_per_timecode_frame", &Session::frames_per_timecode_frame)
 448                 .addFunction ("timecode_frames_per_hour", &Session::timecode_frames_per_hour)
 449                 .addFunction ("timecode_frames_per_second", &Session::timecode_frames_per_second)
 450                 .addFunction ("timecode_drop_frames", &Session::timecode_drop_frames)
 451                 .addFunction ("request_locate", &Session::request_locate)
 452                 .addFunction ("request_stop", &Session::request_stop)
 453                 .addFunction ("last_transport_start", &Session::last_transport_start)
 454                 .addFunction ("goto_start", &Session::goto_start)
 455                 .addFunction ("goto_end", &Session::goto_end)
 456                 .addFunction ("current_start_frame", &Session::current_start_frame)
 457                 .addFunction ("current_end_frame", &Session::current_end_frame)
 458                 .addFunction ("actively_recording", &Session::actively_recording)
 459                 .addFunction ("get_routes", &Session::get_routes)
 460                 .addFunction ("get_tracks", &Session::get_tracks)
 461                 .addFunction ("name", &Session::name)
 462                 .addFunction ("path", &Session::path)
 463                 .addFunction ("record_status", &Session::record_status)
 464                 .addFunction ("route_by_id", &Session::route_by_id)
 465                 .addFunction ("route_by_name", &Session::route_by_name)
 466                 .addFunction ("route_by_remote_id", &Session::route_by_remote_id)
 467                 .addFunction ("track_by_diskstream_id", &Session::track_by_diskstream_id)
 468                 .addFunction ("source_by_id", &Session::source_by_id)
 469                 .addFunction ("controllable_by_id", &Session::controllable_by_id)
 470                 .addFunction ("processor_by_id", &Session::processor_by_id)
 471                 .addFunction ("snap_name", &Session::snap_name)
 472                 .addFunction ("tempo_map", (TempoMap& (Session::*)())&Session::tempo_map)
 473                 .endClass ()
 474
 475                 .beginClass <RegionFactory> ("RegionFactory")
 476                 .addStaticFunction ("region_by_id", &RegionFactory::region_by_id)
 477                 .endClass ()
 478
 479                 /* session enums */
 480                 .beginNamespace ("Session")
 481
 482                 .beginNamespace ("RecordState")
 483                 .addConst ("Disabled", ARDOUR::Session::RecordState(Session::Disabled))
 484                 .addConst ("Enabled", ARDOUR::Session::RecordState(Session::Enabled))
 485                 .addConst ("Recording", ARDOUR::Session::RecordState(Session::Recording))
 486                 .endNamespace ()
 487
 488                 .endNamespace () // END Session enums
 489
 490                 .endNamespace ();// END ARDOUR
 491 }
 492
 493 void
 494 LuaBindings::dsp (lua_State* L)
 495 {
 496         luabridge::getGlobalNamespace (L)
 497                 .beginNamespace ("ARDOUR")
 498
 499                 .beginClass <AudioBuffer> ("AudioBuffer")
 500                 .addFunction ("data", (Sample*(AudioBuffer::*)(framecnt_t))&AudioBuffer::data)
 501                 .addFunction ("silence", &AudioBuffer::silence)
 502                 .addFunction ("apply_gain", &AudioBuffer::apply_gain)
 503                 .endClass()
 504
 505                 .beginClass <MidiBuffer> ("MidiBuffer")
 506                 .addFunction ("silence", &MidiBuffer::silence)
 507                 .addFunction ("empty", &MidiBuffer::empty)
 508                 // TODO iterators..
 509                 .endClass()
 510
 511                 .beginClass <BufferSet> ("BufferSet")
 512                 .addFunction ("get_audio", static_cast<AudioBuffer&(BufferSet::*)(size_t)>(&BufferSet::get_audio))
 513                 .addFunction ("count", static_cast<const ChanCount&(BufferSet::*)()const>(&BufferSet::count))
 514                 .endClass()
 515
 516                 .beginClass <ChanMapping> ("ChanMapping")
 517                 .addFunction ("get", static_cast<uint32_t(ChanMapping::*)(DataType, uint32_t)>(&ChanMapping::get))
 518                 .addFunction ("set", &ChanMapping::set)
 519                 .addConst ("Invalid", 4294967295) // UINT32_MAX
 520                 .endClass ()
 521                 .endNamespace ();
 522
 523         luabridge::getGlobalNamespace (L)
 524                 .beginNamespace ("Evoral")
 525                 .beginClass <Evoral::Event<framepos_t> > ("Event")
 526                 .addFunction ("clear", &Evoral::Event<framepos_t>::clear)
 527                 .addFunction ("size", &Evoral::Event<framepos_t>::size)
 528                 .addFunction ("set_buffer", &Evoral::Event<framepos_t>::set_buffer)
 529                 .addFunction ("buffer", (uint8_t*(Evoral::Event<framepos_t>::*)())&Evoral::Event<framepos_t>::buffer)
 530                 .endClass ()
 531
 532                 .deriveClass <Evoral::MIDIEvent<framepos_t>, Evoral::Event<framepos_t> > ("MidiEvent")
 533                 // add Ctor?
 534                 .addFunction ("type", &Evoral::MIDIEvent<framepos_t>::type)
 535                 .addFunction ("channel", &Evoral::MIDIEvent<framepos_t>::channel)
 536                 .addFunction ("set_type", &Evoral::MIDIEvent<framepos_t>::type)
 537                 .addFunction ("set_channel", &Evoral::MIDIEvent<framepos_t>::channel)
 538                 .endClass ()
 539                 .endNamespace ();
 540
 541         // dsp releated session functions
 542         luabridge::getGlobalNamespace (L)
 543                 .beginNamespace ("ARDOUR")
 544                 .beginClass <Session> ("Session")
 545                 .addFunction ("get_scratch_buffers", &Session::get_scratch_buffers)
 546                 .addFunction ("get_silent_buffers", &Session::get_silent_buffers)
 547                 .endClass ()
 548                 .endNamespace ();
 549
 550         luabridge::getGlobalNamespace (L)
 551                 .beginNamespace ("ARDOUR")
 552                 .beginNamespace ("DSP")
 553                 .addFunction ("compute_peak", ARDOUR::compute_peak)
 554                 .addFunction ("find_peaks", ARDOUR::find_peaks)
 555                 .addFunction ("apply_gain_to_buffer", ARDOUR::apply_gain_to_buffer)
 556                 .addFunction ("mix_buffers_no_gain", ARDOUR::mix_buffers_no_gain)
 557                 .addFunction ("mix_buffers_with_gain", ARDOUR::mix_buffers_with_gain)
 558                 .addFunction ("copy_vector", ARDOUR::copy_vector)
 559                 .addFunction ("dB_to_coefficient", &dB_to_coefficient)
 560                 .addFunction ("fast_coefficient_to_dB", &fast_coefficient_to_dB)
 561                 .addFunction ("accurate_coefficient_to_dB", &accurate_coefficient_to_dB)
 562                 .addFunction ("memset", &DSP::memset)
 563                 .addFunction ("mmult", &DSP::mmult)
 564                 .beginClass <DSP::LowPass> ("LowPass")
 565                 .addConstructor <void (*) (double, float)> ()
 566                 .addFunction ("proc", &DSP::LowPass::proc)
 567                 .addFunction ("ctrl", &DSP::LowPass::ctrl)
 568                 .addFunction ("set_cutoff", &DSP::LowPass::set_cutoff)
 569                 .addFunction ("reset", &DSP::LowPass::reset)
 570                 .endClass ()
 571                 .beginClass <DSP::BiQuad> ("Biquad")
 572                 .addConstructor <void (*) (double)> ()
 573                 .addFunction ("run", &DSP::BiQuad::run)
 574                 .addFunction ("compute", &DSP::BiQuad::compute)
 575                 .addFunction ("reset", &DSP::BiQuad::reset)
 576                 .endClass ()
 577                 .endNamespace ()
 578                 .endNamespace ();
 579 }
 580
 581 void
 582 LuaBindings::session (lua_State* L)
 583 {
 584         // non-realtime session functions
 585         luabridge::getGlobalNamespace (L)
 586                 .beginNamespace ("ARDOUR")
 587                 .beginClass <Session> ("Session")
 588                 .addFunction ("save_state", &Session::save_state)
 589                 .addFunction ("set_dirty", &Session::set_dirty)
 590                 .addFunction ("unknown_processors", &Session::unknown_processors)
 591
 592                 .addFunction<RouteList (Session::*)(uint32_t, const std::string&, const std::string&, PlaylistDisposition)> ("new_route_from_template", &Session::new_route_from_template)
 593                 // TODO  session_add_audio_track  session_add_midi_track  session_add_mixed_track
 594                 //.addFunction ("new_midi_track", &Session::new_midi_track)
 595                 .endClass ()
 596
 597                 .endNamespace (); // ARDOUR
 598 }
 599
 600 void
 601 LuaBindings::set_session (lua_State* L, Session *s)
 602 {
 603         /* LuaBridge uses unique keys to identify classes/c-types.
 604          *
 605          * Those keys are "generated" by using the memory-address of a static
 606          * variable, templated for every Class.
 607          * (see libs/lua/LuaBridge/detail/ClassInfo.h)
 608          *
 609          * When linking the final executable there must be exactly one static
 610          * function (static variable) for every templated class.
 611          * This works fine on OSX and Linux...
 612          *
 613          * Windows (mingw and MSVC) however expand the template differently for libardour
 614          * AND gtk2_ardour. We end up with two identical static functions
 615          * at different addresses!!
 616          *
 617          * The Solution: have gtk2_ardour never include LuaBridge headers directly
 618          * and always go via libardour function calls for classes that are registered
 619          * in libardour. (calling lua itself is fine,  calling c-functions in the GUI
 620          * which expand the template is not)
 621          *
 622          * (the actual cause: even static symbols in a .dll have no fixed address
 623          * and are mapped when loading the dll. static functions in .exe do have a fixed
 624          * address)
 625          *
 626          * libardour:
 627          *  0000000000000000 I __imp__ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
 628          *  0000000000000000 I __nm__ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
 629          *  0000000000000000 T _ZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEv
 630          *
 631          * ardour.exe
 632          *  000000000104f560 d .data$_ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
 633          *  000000000104f560 D _ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
 634          *  0000000000e9baf0 T _ZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEv
 635          *
 636          *
 637          */
 638         luabridge::push <Session *> (L, s);
 639         lua_setglobal (L, "Session");
 640
 641         if (s) {
 642                 // call lua function.
 643                 luabridge::LuaRef cb_ses = luabridge::getGlobal (L, "new_session");
 644                 if (cb_ses.type() == LUA_TFUNCTION) { cb_ses(s->name()); } // TODO args
 645         }
 646 }