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