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 <glibmm.h>
  20
  21 #include "timecode/bbt_time.h"
  22 #include "pbd/stateful_diff_command.h"
  23 #include "evoral/Control.hpp"
  24 #include "evoral/ControlList.hpp"
  25 #include "evoral/Range.hpp"
  26
  27 #include "ardour/amp.h"
  28 #include "ardour/audioengine.h"
  29 #include "ardour/audiosource.h"
  30 #include "ardour/audio_backend.h"
  31 #include "ardour/audio_buffer.h"
  32 #include "ardour/audio_port.h"
  33 #include "ardour/audio_track.h"
  34 #include "ardour/buffer_set.h"
  35 #include "ardour/chan_mapping.h"
  36 #include "ardour/dB.h"
  37 #include "ardour/dsp_filter.h"
  38 #include "ardour/interthread_info.h"
  39 #include "ardour/lua_api.h"
  40 #include "ardour/luabindings.h"
  41 #include "ardour/luaproc.h"
  42 #include "ardour/meter.h"
  43 #include "ardour/midi_track.h"
  44 #include "ardour/midi_port.h"
  45 #include "ardour/playlist.h"
  46 #include "ardour/plugin.h"
  47 #include "ardour/plugin_insert.h"
  48 #include "ardour/runtime_functions.h"
  49 #include "ardour/region.h"
  50 #include "ardour/region_factory.h"
  51 #include "ardour/session.h"
  52 #include "ardour/session_object.h"
  53 #include "ardour/sidechain.h"
  54 #include "ardour/track.h"
  55 #include "ardour/tempo.h"
  56
  57 #include "LuaBridge/LuaBridge.h"
  58
  59 #ifdef PLATFORM_WINDOWS
  60 /* luabridge uses addresses of static functions/variables to identify classes.
  61  *
  62  * Static symbols on windows (even identical symbols) are not
  63  * mapped to the same address when mixing .dll + .exe.
  64  * So we need a single point to define those static functions.
  65  * (normally they're header-only in libs/lua/LuaBridge/detail/ClassInfo.h)
  66  *
  67  * Really!! A static function with a static variable in a library header
  68  * should never ever be replicated, even if it is a template.
  69  * But then again this is windows... what else can go wrong.
  70  */
  71
  72 template <class T>
  73 void const*
  74 luabridge::ClassInfo<T>::getStaticKey ()
  75 {
  76         static char value;
  77         return &value;
  78 }
  79
  80 template <class T>
  81 void const*
  82 luabridge::ClassInfo<T>::getClassKey ()
  83 {
  84         static char value;
  85         return &value;
  86 }
  87
  88 template <class T>
  89 void const*
  90 luabridge::ClassInfo<T>::getConstKey ()
  91 {
  92         static char value;
  93         return &value;
  94 }
  95
  96 void*
  97 luabridge::getIdentityKey ()
  98 {
  99   static char value;
 100   return &value;
 101 }
 102
 103 /* ...and this is the ugly part of it.
 104  *
 105  * We need to foward declare classes from gtk2_ardour
 106  * end explicily list classes which are used by gtk2_ardour's bindings.
 107  *
 108  * This is needed because some of the GUI classes use objects from libardour
 109  * as function parameters and the .exe would re-create symbols for libardour
 110  * objects.
 111  *
 112  * Classes which don't use libardour symbols could be moved to
 113  * gtk2_ardour/luainstance.cc, but keeping this here reduces code
 114  * duplication and does not give the compiler a chance to even think
 115  * about replicating the symbols.
 116  */
 117
 118 #define CLASSKEYS(CLS) \
 119         template void const* luabridge::ClassInfo< CLS >::getStaticKey(); \
 120         template void const* luabridge::ClassInfo< CLS >::getClassKey();  \
 121         template void const* luabridge::ClassInfo< CLS >::getConstKey();
 122
 123 #define CLASSINFO(CLS) \
 124         class CLS; \
 125         template void const* luabridge::ClassInfo< CLS >::getStaticKey(); \
 126         template void const* luabridge::ClassInfo< CLS >::getClassKey();  \
 127         template void const* luabridge::ClassInfo< CLS >::getConstKey();
 128
 129 CLASSINFO(MarkerSelection);
 130 CLASSINFO(TrackSelection);
 131 CLASSINFO(TrackViewList);
 132 CLASSINFO(TimeSelection);
 133 CLASSINFO(RegionSelection);
 134 CLASSINFO(PublicEditor);
 135 CLASSINFO(Selection);
 136 CLASSINFO(ArdourMarker);
 137
 138 namespace Cairo {
 139         class Context;
 140 }
 141 CLASSKEYS(Cairo::Context);
 142 CLASSKEYS(std::vector<double>);
 143 CLASSKEYS(std::list<ArdourMarker*>);
 144 CLASSKEYS(std::bitset<47ul>); // LuaSignal::LAST_SIGNAL
 145 CLASSKEYS(ArdourMarker*);
 146 CLASSKEYS(ARDOUR::RouteGroup);
 147 CLASSKEYS(ARDOUR::LuaProc);
 148 CLASSKEYS(ARDOUR::DataType);
 149 CLASSKEYS(ARDOUR::ChanCount);
 150 CLASSKEYS(boost::shared_ptr<ARDOUR::Processor>);
 151 CLASSKEYS(ARDOUR::ParameterDescriptor);
 152 CLASSKEYS(boost::shared_ptr<ARDOUR::AutomationList>);
 153 CLASSKEYS(boost::shared_ptr<Evoral::ControlList>);
 154 CLASSKEYS(ARDOUR::LuaOSC::Address);
 155 CLASSKEYS(ARDOUR::Session);
 156 CLASSKEYS(ARDOUR::BufferSet);
 157 CLASSKEYS(ARDOUR::ChanMapping);
 158 CLASSKEYS(ARDOUR::DSP::DspShm);
 159 CLASSKEYS(PBD::ID);
 160 CLASSKEYS(ARDOUR::Location);
 161 CLASSKEYS(ARDOUR::PluginInfo);
 162 CLASSKEYS(PBD::PropertyChange);
 163 CLASSKEYS(std::vector<std::string>);
 164 CLASSKEYS(std::list<boost::shared_ptr<ARDOUR::Route> >);
 165 CLASSKEYS(boost::shared_ptr<ARDOUR::PluginInfo>);
 166 CLASSKEYS(boost::shared_ptr<ARDOUR::Region>);
 167 CLASSKEYS(boost::weak_ptr<ARDOUR::Route>);
 168 CLASSKEYS(std::list<boost::shared_ptr<ARDOUR::Region> >);
 169 CLASSKEYS(std::list<ARDOUR::AudioRange>);
 170 CLASSKEYS(Evoral::Beats);
 171 CLASSKEYS(ARDOUR::AudioEngine);
 172 CLASSKEYS(void);
 173 CLASSKEYS(float);
 174
 175 #endif // end windows special case
 176
 177 /* Some notes on Lua bindings for libardour and friends
 178  *
 179  * - Prefer factory methods over Contructors whenever possible.
 180  *   Don't expose the constructor method unless required.
 181  *
 182  *   e.g. Don't allow the script to construct a "Track" Object directly
 183  *   but do allow to create a "BBT_TIME" object.
 184  *
 185  * - Do not dereference Shared or Weak Pointers. Pass the pointer to Lua.
 186  * - Define Objects as boost:shared_ptr Object whenever possible.
 187  *
 188  *   Storing a boost::shared_ptr in a Lua-variable keeps the reference
 189  *   until that variable is set to 'nil'.
 190  *   (if the script were to keep a direct pointer to the object instance, the
 191  *   behaviour is undefined if the actual object goes away)
 192  *
 193  *   Methods of the actual class are indirectly exposed,
 194  *   boost::*_ptr get() and ::lock() is implicit when the class is exported
 195  *   as LuaBridge's "WSPtrClass".
 196  */
 197
 198 using namespace ARDOUR;
 199
 200 void
 201 LuaBindings::stddef (lua_State* L)
 202 {
 203         // std::list<std::string>
 204         luabridge::getGlobalNamespace (L)
 205                 .beginNamespace ("C")
 206                 .beginStdList <std::string> ("StringList")
 207                 .endClass ()
 208
 209         // std::vector<std::string>
 210                 .beginStdVector <std::string> ("StringVector")
 211                 .endClass ()
 212
 213         // register float array (float*)
 214                 .registerArray <float> ("FloatArray")
 215
 216         // register float array (int32_t*)
 217                 .registerArray <int32_t> ("IntArray")
 218
 219         // TODO std::set
 220                 .endNamespace ();
 221 }
 222
 223 void
 224 LuaBindings::common (lua_State* L)
 225 {
 226         luabridge::getGlobalNamespace (L)
 227                 .beginNamespace ("PBD")
 228                 .beginClass <PBD::ID> ("ID")
 229                 .addConstructor <void (*) (std::string)> ()
 230                 .addFunction ("to_s", &PBD::ID::to_s) // TODO special case LUA __tostring ?
 231                 .endClass ()
 232
 233                 .beginClass <XMLNode> ("XMLNode")
 234                 .addFunction ("name", &XMLNode::name)
 235                 .endClass ()
 236
 237                 .beginClass <PBD::Stateful> ("Stateful")
 238                 .addFunction ("properties", &PBD::Stateful::properties)
 239                 .addFunction ("clear_changes", &PBD::Stateful::clear_changes)
 240                 .endClass ()
 241
 242                 .beginWSPtrClass <PBD::Stateful> ("StatefulPtr")
 243                 .addFunction ("properties", &PBD::Stateful::properties)
 244                 .addFunction ("clear_changes", &PBD::Stateful::clear_changes)
 245                 .endClass ()
 246
 247                 .deriveClass <PBD::StatefulDestructible, PBD::Stateful> ("StatefulDestructible")
 248                 .endClass ()
 249
 250                 .deriveWSPtrClass <PBD::StatefulDestructible, PBD::Stateful> ("StatefulDestructiblePtr")
 251                 .endClass ()
 252
 253                 .deriveClass <Command, PBD::StatefulDestructible> ("Command")
 254                 .addFunction ("set_name", &Command::set_name)
 255                 .addFunction ("name", &Command::name)
 256                 .endClass ()
 257
 258                 /* UndoTransaction::add_command() subscribes to DropReferences()
 259                  * and deletes the object.
 260                  *
 261                  * This object cannot be constructed by lua because lua would manage lifetime
 262                  * and delete the object leading to a double free.
 263                  *
 264                  * use Session::add_stateful_diff_command()
 265                  * and Session::abort_reversible_command()
 266                  */
 267                 .deriveClass <PBD::StatefulDiffCommand, Command> ("StatefulDiffCommand")
 268                 .addFunction ("undo", &PBD::StatefulDiffCommand::undo)
 269                 .addFunction ("empty", &PBD::StatefulDiffCommand::empty)
 270                 .endClass ()
 271
 272                 .deriveWSPtrClass <PBD::Controllable, PBD::StatefulDestructible> ("Controllable")
 273                 .addFunction ("name", &PBD::Controllable::name)
 274                 .addFunction ("get_value", &PBD::Controllable::get_value)
 275                 .endClass ()
 276
 277                 .beginNamespace ("GroupControlDisposition")
 278                 .addConst ("InverseGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::InverseGroup))
 279                 .addConst ("NoGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::NoGroup))
 280                 .addConst ("UseGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::UseGroup))
 281                 .endNamespace ()
 282
 283                 .endNamespace (); // PBD
 284
 285         luabridge::getGlobalNamespace (L)
 286                 .beginNamespace ("Timecode")
 287                 .beginClass <Timecode::BBT_Time> ("BBT_TIME")
 288                 .addConstructor <void (*) (uint32_t, uint32_t, uint32_t)> ()
 289                 .endClass ()
 290                 .endNamespace ();
 291
 292         luabridge::getGlobalNamespace (L)
 293
 294                 .beginNamespace ("Evoral")
 295                 .beginClass <Evoral::Parameter> ("Parameter")
 296                 .addConstructor <void (*) (uint32_t, uint8_t, uint32_t)> ()
 297                 .addFunction ("type", &Evoral::Parameter::type)
 298                 .addFunction ("channel", &Evoral::Parameter::channel)
 299                 .addFunction ("id", &Evoral::Parameter::id)
 300                 .endClass ()
 301
 302                 .beginWSPtrClass <Evoral::ControlList> ("ControlList")
 303                 .addFunction ("add", &Evoral::ControlList::add)
 304                 .addFunction ("thin", &Evoral::ControlList::thin)
 305                 .addFunction ("eval", &Evoral::ControlList::eval)
 306                 .addRefFunction ("rt_safe_eval", &Evoral::ControlList::rt_safe_eval)
 307                 .addFunction ("interpolation", &Evoral::ControlList::interpolation)
 308                 .addFunction ("set_interpolation", &Evoral::ControlList::set_interpolation)
 309                 .addFunction ("truncate_end", &Evoral::ControlList::truncate_end)
 310                 .addFunction ("truncate_start", &Evoral::ControlList::truncate_start)
 311                 .addFunction ("clear", (void (Evoral::ControlList::*)(double, double))&Evoral::ControlList::clear)
 312                 .addFunction ("in_write_pass", &Evoral::ControlList::in_write_pass)
 313                 .endClass ()
 314
 315                 .beginWSPtrClass <Evoral::ControlSet> ("ControlSet")
 316                 .endClass ()
 317
 318                 .beginWSPtrClass <Evoral::Control> ("Control")
 319                 .addFunction ("list", (boost::shared_ptr<Evoral::ControlList>(Evoral::Control::*)())&Evoral::Control::list)
 320                 .endClass ()
 321
 322                 .beginClass <Evoral::ParameterDescriptor> ("ParameterDescriptor")
 323                 .addVoidConstructor ()
 324                 .addData ("lower", &Evoral::ParameterDescriptor::lower)
 325                 .addData ("upper", &Evoral::ParameterDescriptor::upper)
 326                 .addData ("normal", &Evoral::ParameterDescriptor::normal)
 327                 .addData ("toggled", &Evoral::ParameterDescriptor::toggled)
 328                 .endClass ()
 329
 330                 .beginClass <Evoral::Range<framepos_t> > ("Range")
 331                 .addConstructor <void (*) (framepos_t, framepos_t)> ()
 332                 .addData ("from", &Evoral::Range<framepos_t>::from)
 333                 .addData ("to", &Evoral::Range<framepos_t>::to)
 334                 .endClass ()
 335
 336                 /* libevoral enums */
 337                 .beginNamespace ("InterpolationStyle")
 338                 .addConst ("Discrete", Evoral::ControlList::InterpolationStyle(Evoral::ControlList::Discrete))
 339                 .addConst ("Linear", Evoral::ControlList::InterpolationStyle(Evoral::ControlList::Linear))
 340                 .addConst ("Curved", Evoral::ControlList::InterpolationStyle(Evoral::ControlList::Curved))
 341                 .endNamespace ()
 342
 343                 .endNamespace () // Evoral
 344
 345                 .beginNamespace ("ARDOUR")
 346
 347                 .beginClass <InterThreadInfo> ("InterThreadInfo")
 348                 .addVoidConstructor ()
 349                 .addData ("done", const_cast<bool InterThreadInfo::*>(&InterThreadInfo::done))
 350 #if 0 // currently unused, lua is single-threaded, no custom UIs.
 351                 .addData ("cancel", (bool InterThreadInfo::*)&InterThreadInfo::cancel)
 352 #endif
 353                 .addData ("progress", const_cast<float InterThreadInfo::*>(&InterThreadInfo::progress))
 354                 .endClass ()
 355
 356                 .beginClass <AudioRange> ("AudioRange")
 357                 .addConstructor <void (*) (framepos_t, framepos_t, uint32_t)> ()
 358                 .addFunction ("length", &AudioRange::length)
 359                 .addFunction ("equal", &AudioRange::equal)
 360                 .addData ("start", &AudioRange::start)
 361                 .addData ("_end", &AudioRange::end) // XXX "end" is a lua reserved word
 362                 .addData ("id", &AudioRange::id)
 363                 .endClass ()
 364
 365                 .beginWSPtrClass <PluginInfo> ("PluginInfo")
 366                 .addVoidConstructor ()
 367                 .endClass ()
 368
 369                 .beginNamespace ("Route")
 370                 .beginClass <Route::ProcessorStreams> ("ProcessorStreams")
 371                 .addVoidConstructor ()
 372                 .endClass ()
 373                 .endNamespace ()
 374
 375                 .beginClass <ChanMapping> ("ChanMapping")
 376                 .addVoidConstructor ()
 377                 .addFunction ("get", static_cast<uint32_t(ChanMapping::*)(DataType, uint32_t) const>(&ChanMapping::get))
 378                 .addFunction ("set", &ChanMapping::set)
 379                 .addConst ("Invalid", 4294967295) // UINT32_MAX
 380                 .endClass ()
 381
 382                 .beginNamespace ("Properties")
 383                 // templated class definitions
 384                 .beginClass <PBD::PropertyDescriptor<bool> > ("BoolProperty").endClass ()
 385                 .beginClass <PBD::PropertyDescriptor<float> > ("FloatProperty").endClass ()
 386                 .beginClass <PBD::PropertyDescriptor<framepos_t> > ("FrameposProperty").endClass ()
 387                 // actual references (TODO: also expose GQuark for std::set)
 388                 //   ardour/region.h
 389                 .addConst ("Start", &ARDOUR::Properties::start)
 390                 .addConst ("Length", &ARDOUR::Properties::length)
 391                 .addConst ("Position", &ARDOUR::Properties::position)
 392                 .endNamespace ()
 393
 394                 .beginClass <PBD::PropertyChange> ("PropertyChange")
 395                 // TODO add special handling (std::set<PropertyID>), PropertyID is a GQuark.
 396                 // -> direct map to lua table  beginStdSet()A
 397                 //
 398                 // expand templated PropertyDescriptor<T>
 399                 .addFunction ("containsBool", &PBD::PropertyChange::contains<bool>)
 400                 .addFunction ("containsFloat", &PBD::PropertyChange::contains<float>)
 401                 .addFunction ("containsFramePos", &PBD::PropertyChange::contains<framepos_t>)
 402                 .endClass ()
 403
 404                 .beginClass <PBD::PropertyList> ("PropertyList")
 405                 // is-a  std::map<PropertyID, PropertyBase*>
 406                 .endClass ()
 407
 408                 .deriveClass <PBD::OwnedPropertyList, PBD::PropertyList> ("OwnedPropertyList")
 409                 .endClass ()
 410
 411                 .beginWSPtrClass <AutomationList> ("AutomationList")
 412                 .addCast<PBD::Stateful> ("to_stateful")
 413                 .addCast<PBD::StatefulDestructible> ("to_statefuldestructible")
 414                 .addCast<Evoral::ControlList> ("list")
 415                 .addFunction ("get_state", &AutomationList::get_state)
 416                 .addFunction ("memento_command", &AutomationList::memento_command)
 417                 .addFunction ("touching", &AutomationList::touching)
 418                 .addFunction ("writing", &AutomationList::writing)
 419                 .addFunction ("touch_enabled", &AutomationList::touch_enabled)
 420                 .endClass ()
 421
 422                 .deriveClass <Location, PBD::StatefulDestructible> ("Location")
 423                 .addFunction ("locked", &Location::locked)
 424                 .addFunction ("lock", &Location::lock)
 425                 .addFunction ("start", &Location::start)
 426                 .addFunction ("_end", &Location::end) // XXX "end" is a lua reserved word
 427                 .addFunction ("length", &Location::length)
 428                 .addFunction ("set_start", &Location::set_start)
 429                 .addFunction ("set_end", &Location::set_end)
 430                 .addFunction ("set_length", &Location::set)
 431                 .addFunction ("move_to", &Location::move_to)
 432                 .endClass ()
 433
 434                 .deriveClass <Locations, PBD::StatefulDestructible> ("Locations")
 435                 .addFunction ("auto_loop_location", &Locations::auto_loop_location)
 436                 .addFunction ("auto_punch_location", &Locations::auto_punch_location)
 437                 .addFunction ("session_range_location", &Locations::session_range_location)
 438                 .addFunction ("first_mark_after", &Locations::first_mark_after)
 439                 .addFunction ("first_mark_after", &Locations::first_mark_after)
 440                 .endClass ()
 441
 442                 .beginWSPtrClass <SessionObject> ("SessionObject")
 443                 /* SessionObject is-a PBD::StatefulDestructible,
 444                  * but multiple inheritance is not covered by luabridge,
 445                  * we need explicit casts */
 446                 .addCast<PBD::Stateful> ("to_stateful")
 447                 .addCast<PBD::StatefulDestructible> ("to_statefuldestructible")
 448                 .addFunction ("name", &SessionObject::name)
 449                 .endClass ()
 450
 451                 .beginWSPtrClass <Port> ("Port")
 452                 .addFunction ("name", &Port::name)
 453                 .addFunction ("pretty_name", &Port::pretty_name)
 454                 .addFunction ("receives_input", &Port::receives_input)
 455                 .addFunction ("sends_output", &Port::sends_output)
 456                 .addFunction ("connected", &Port::connected)
 457                 .addFunction ("disconnect_all", &Port::disconnect_all)
 458                 .addFunction ("connected_to_name", (bool (Port::*)(std::string const &)const)&Port::connected_to)
 459                 .addFunction ("connect_by_name", (int (Port::*)(std::string const &))&Port::connect)
 460                 .addFunction ("disconnect_by_name", (int (Port::*)(std::string const &))&Port::disconnect)
 461                 .addFunction ("connected_to", (bool (Port::*)(Port*)const)&Port::connected_to)
 462                 .addFunction ("connect", (int (Port::*)(Port*))&Port::connect)
 463                 .addFunction ("disconnect", (int (Port::*)(Port*))&Port::disconnect)
 464                 .endClass ()
 465
 466                 .deriveWSPtrClass <AudioPort, Port> ("AudioPort")
 467                 .endClass ()
 468
 469                 .deriveWSPtrClass <MidiPort, Port> ("MidiPort")
 470                 .addFunction ("input_active", &MidiPort::input_active)
 471                 .addFunction ("set_input_active", &MidiPort::set_input_active)
 472                 .endClass ()
 473
 474                 .beginWSPtrClass <PortSet> ("PortSet")
 475                 .addFunction ("num_ports", (size_t (PortSet::*)(DataType)const)&PortSet::num_ports)
 476                 .addFunction ("add", &PortSet::add)
 477                 .addFunction ("remove", &PortSet::remove)
 478                 .addFunction ("port", (boost::shared_ptr<Port> (PortSet::*)(DataType, size_t)const)&PortSet::port)
 479                 .addFunction ("contains", &PortSet::contains)
 480                 .addFunction ("clear", &PortSet::clear)
 481                 .addFunction ("empty", &PortSet::empty)
 482                 .endClass ()
 483
 484                 .deriveWSPtrClass <IO, SessionObject> ("IO")
 485                 .addFunction ("active", &IO::active)
 486                 .addFunction ("add_port", &IO::add_port)
 487                 .addFunction ("remove_port", &IO::remove_port)
 488                 .addFunction ("connect", &IO::connect)
 489                 .addFunction ("disconnect", (int (IO::*)(boost::shared_ptr<Port>, std::string, void *))&IO::disconnect)
 490                 .addFunction ("physically_connected", &IO::physically_connected)
 491                 .addFunction ("has_port", &IO::has_port)
 492                 .addFunction ("nth", &IO::nth)
 493                 .addFunction ("audio", &IO::audio)
 494                 .addFunction ("midi", &IO::midi)
 495                 .addFunction ("port_by_name", &IO::nth)
 496                 .addFunction ("n_ports", &IO::n_ports)
 497                 .endClass ()
 498
 499                 .deriveWSPtrClass <RouteGroup, SessionObject> ("RouteGroupPtr")
 500                 .endClass ()
 501
 502                 .beginClass <RouteGroup> ("RouteGroup")
 503                 // stub RouteGroup* is needed for new_audio_track()
 504                 .endClass ()
 505
 506                 .deriveWSPtrClass <Route, SessionObject> ("Route")
 507                 .addCast<Track> ("to_track")
 508                 .addFunction ("set_name", &Route::set_name)
 509                 .addFunction ("comment", &Route::comment)
 510                 .addFunction ("active", &Route::active)
 511                 .addFunction ("set_active", &Route::set_active)
 512                 .addFunction ("nth_plugin", &Route::nth_plugin)
 513                 .addFunction ("add_processor_by_index", &Route::add_processor_by_index)
 514                 .addFunction ("remove_processor", &Route::remove_processor)
 515                 .addFunction ("replace_processor", &Route::replace_processor)
 516                 .addFunction ("n_inputs", &Route::n_inputs)
 517                 .addFunction ("n_outputs", &Route::n_outputs)
 518                 .addFunction ("set_comment", &Route::set_comment)
 519                 .addFunction ("strict_io", &Route::strict_io)
 520                 .addFunction ("set_strict_io", &Route::set_strict_io)
 521                 .addFunction ("reset_plugin_insert", &Route::reset_plugin_insert)
 522                 .addFunction ("customize_plugin_insert", &Route::customize_plugin_insert)
 523                 .addFunction ("add_sidechain", &Route::add_sidechain)
 524                 .addFunction ("remove_sidechain", &Route::remove_sidechain)
 525                 .addFunction ("main_outs", &Route::main_outs)
 526                 .addFunction ("muted", &Route::muted)
 527                 .addFunction ("soloed", &Route::soloed)
 528                 .addFunction ("amp", &Route::amp)
 529                 .addFunction ("trim", &Route::trim)
 530                 .endClass ()
 531
 532                 .deriveWSPtrClass <Playlist, SessionObject> ("Playlist")
 533                 .addFunction ("region_by_id", &Playlist::region_by_id)
 534                 .addFunction ("data_type", &Playlist::data_type)
 535                 .addFunction ("n_regions", &Playlist::n_regions)
 536                 //.addFunction ("get_extent", &Playlist::get_extent) // pair<framepos_t, framepos_t>
 537                 //.addFunction ("region_list", &Playlist::region_list) // RegionListProperty&
 538                 .addFunction ("add_region", &Playlist::add_region)
 539                 .addFunction ("remove_region", &Playlist::remove_region)
 540                 .addFunction ("regions_at", &Playlist::regions_at)
 541                 .addFunction ("top_region_at", &Playlist::top_region_at)
 542                 .addFunction ("top_unmuted_region_at", &Playlist::top_unmuted_region_at)
 543                 .addFunction ("find_next_region", &Playlist::find_next_region)
 544                 .addFunction ("find_next_region_boundary", &Playlist::find_next_region_boundary)
 545                 .addFunction ("count_regions_at", &Playlist::count_regions_at)
 546                 .addFunction ("regions_touched", &Playlist::regions_touched)
 547                 .addFunction ("regions_with_start_within", &Playlist::regions_with_start_within)
 548                 .addFunction ("regions_with_end_within", &Playlist::regions_with_end_within)
 549                 .addFunction ("raise_region", &Playlist::raise_region)
 550                 .addFunction ("lower_region", &Playlist::lower_region)
 551                 .addFunction ("raise_region_to_top", &Playlist::raise_region_to_top)
 552                 .addFunction ("lower_region_to_bottom", &Playlist::lower_region_to_bottom)
 553                 .addFunction ("duplicate", (void (Playlist::*)(boost::shared_ptr<Region>, framepos_t, framecnt_t, float))&Playlist::duplicate)
 554                 .addFunction ("duplicate_until", &Playlist::duplicate_until)
 555                 .addFunction ("duplicate_range", &Playlist::duplicate_range)
 556                 .addFunction ("combine", &Playlist::combine)
 557                 .addFunction ("uncombine", &Playlist::uncombine)
 558                 .addFunction ("split_region", &Playlist::split_region)
 559                 .addFunction ("split", (void (Playlist::*)(framepos_t))&Playlist::split)
 560                 .addFunction ("cut", (boost::shared_ptr<Playlist> (Playlist::*)(std::list<AudioRange>&, bool))&Playlist::cut)
 561 #if 0
 562                 .addFunction ("copy", &Playlist::copy)
 563                 .addFunction ("paste", &Playlist::paste)
 564 #endif
 565                 .endClass ()
 566
 567                 .deriveWSPtrClass <Track, Route> ("Track")
 568                 .addCast<AudioTrack> ("to_audio_track")
 569                 .addCast<MidiTrack> ("to_midi_track")
 570                 .addFunction ("set_name", &Track::set_name)
 571                 .addFunction ("can_record", &Track::can_record)
 572                 .addFunction ("record_enabled", &Track::record_enabled)
 573                 .addFunction ("record_safe", &Track::record_safe)
 574                 .addFunction ("set_record_enabled", &Track::set_record_enabled)
 575                 .addFunction ("set_record_safe", &Track::set_record_safe)
 576                 .addFunction ("bounceable", &Track::bounceable)
 577                 .addFunction ("bounce", &Track::bounce)
 578                 .addFunction ("bounce_range", &Track::bounce_range)
 579                 .addFunction ("playlist", &Track::playlist)
 580                 .endClass ()
 581
 582                 .deriveWSPtrClass <AudioTrack, Track> ("AudioTrack")
 583                 .endClass ()
 584
 585                 .deriveWSPtrClass <MidiTrack, Track> ("MidiTrack")
 586                 .endClass ()
 587
 588                 .deriveWSPtrClass <Region, SessionObject> ("Region")
 589                 /* properties */
 590                 .addFunction ("position", &Region::position)
 591                 .addFunction ("start", &Region::start)
 592                 .addFunction ("length", &Region::length)
 593                 .addFunction ("layer", &Region::layer)
 594                 .addFunction ("data_type", &Region::data_type)
 595                 .addFunction ("stretch", &Region::stretch)
 596                 .addFunction ("shift", &Region::shift)
 597                 .addRefFunction ("sync_offset", &Region::sync_offset)
 598                 .addFunction ("sync_position", &Region::sync_position)
 599                 .addFunction ("hidden", &Region::hidden)
 600                 .addFunction ("muted", &Region::muted)
 601                 .addFunction ("opaque", &Region::opaque)
 602                 .addFunction ("locked", &Region::locked)
 603                 .addFunction ("position_locked", &Region::position_locked)
 604                 .addFunction ("video_locked", &Region::video_locked)
 605                 .addFunction ("valid_transients", &Region::valid_transients)
 606                 .addFunction ("automatic", &Region::automatic)
 607                 .addFunction ("whole_file", &Region::whole_file)
 608                 .addFunction ("captured", &Region::captured)
 609                 .addFunction ("can_move", &Region::can_move)
 610                 .addFunction ("sync_marked", &Region::sync_marked)
 611                 .addFunction ("external", &Region::external)
 612                 .addFunction ("import", &Region::import)
 613                 .addFunction ("covers", &Region::covers)
 614                 .addFunction ("at_natural_position", &Region::at_natural_position)
 615                 .addFunction ("is_compound", &Region::is_compound)
 616                 /* editing operations */
 617                 .addFunction ("set_length", &Region::set_length)
 618                 .addFunction ("set_start", &Region::set_start)
 619                 .addFunction ("set_position", &Region::set_position)
 620                 .addFunction ("set_initial_position", &Region::set_initial_position)
 621                 .addFunction ("nudge_position", &Region::nudge_position)
 622                 .addFunction ("move_to_natural_position", &Region::move_to_natural_position)
 623                 .addFunction ("move_start", &Region::move_start)
 624                 .addFunction ("trim_front", &Region::trim_front)
 625                 .addFunction ("trim_end", &Region::trim_end)
 626                 .addFunction ("trim_to", &Region::trim_to)
 627                 .addFunction ("cut_front", &Region::cut_front)
 628                 .addFunction ("cut_end", &Region::cut_end)
 629                 .addFunction ("raise", &Region::raise)
 630                 .addFunction ("lower", &Region::lower)
 631                 .addFunction ("raise_to_top", &Region::raise_to_top)
 632                 .addFunction ("lower_to_bottom", &Region::lower_to_bottom)
 633                 .addFunction ("set_sync_position", &Region::set_sync_position)
 634                 .addFunction ("clear_sync_position", &Region::clear_sync_position)
 635                 .addFunction ("set_hidden", &Region::set_hidden)
 636                 .addFunction ("set_muted", &Region::set_muted)
 637                 .addFunction ("set_opaque", &Region::set_opaque)
 638                 .addFunction ("set_locked", &Region::set_locked)
 639                 .addFunction ("set_video_locked", &Region::set_video_locked)
 640                 .addFunction ("set_position_locked", &Region::set_position_locked)
 641                 .endClass ()
 642
 643                 .beginWSPtrClass <Source> ("Source")
 644                 .endClass ()
 645
 646                 .beginClass <Plugin::PresetRecord> ("PresetRecord")
 647                 .addData ("uri", &Plugin::PresetRecord::uri, false)
 648                 .addData ("label", &Plugin::PresetRecord::label, false)
 649                 .addData ("user", &Plugin::PresetRecord::user, false)
 650                 .addData ("valid", &Plugin::PresetRecord::valid, false)
 651                 .endClass ()
 652
 653                 .deriveWSPtrClass <Automatable, Evoral::ControlSet> ("Automatable")
 654                 .addFunction ("automation_control", (boost::shared_ptr<AutomationControl>(Automatable::*)(const Evoral::Parameter&, bool))&Automatable::automation_control)
 655                 .endClass ()
 656
 657                 .deriveClass <ParameterDescriptor, Evoral::ParameterDescriptor> ("ParameterDescriptor")
 658                 .addVoidConstructor ()
 659                 .addData ("label", &ParameterDescriptor::label)
 660                 .addData ("logarithmic", &ParameterDescriptor::logarithmic)
 661                 .endClass ()
 662
 663                 .deriveWSPtrClass <Processor, SessionObject> ("Processor")
 664                 .addCast<Automatable> ("to_automatable")
 665                 .addCast<PluginInsert> ("to_insert")
 666                 .addCast<SideChain> ("to_sidechain")
 667                 .addCast<IOProcessor> ("to_ioprocessor")
 668                 .addFunction ("display_name", &Processor::display_name)
 669                 .addFunction ("active", &Processor::active)
 670                 .addFunction ("activate", &Processor::activate)
 671                 .addFunction ("deactivate", &Processor::deactivate)
 672                 .addFunction ("control", (boost::shared_ptr<Evoral::Control>(Evoral::ControlSet::*)(const Evoral::Parameter&, bool))&Evoral::ControlSet::control)
 673                 .addFunction ("automation_control", (boost::shared_ptr<AutomationControl>(Automatable::*)(const Evoral::Parameter&, bool))&Automatable::automation_control)
 674                 .endClass ()
 675
 676                 .deriveWSPtrClass <IOProcessor, Processor> ("IOProcessor")
 677                 .addFunction ("natural_input_streams", &IOProcessor::natural_input_streams)
 678                 .addFunction ("natural_output_streams", &IOProcessor::natural_output_streams)
 679                 .addFunction ("input", (boost::shared_ptr<IO>(IOProcessor::*)())&IOProcessor::input)
 680                 .addFunction ("output", (boost::shared_ptr<IO>(IOProcessor::*)())&IOProcessor::output)
 681                 .endClass ()
 682
 683                 .deriveWSPtrClass <SideChain, IOProcessor> ("SideChain")
 684                 .endClass ()
 685
 686                 .deriveWSPtrClass <Delivery, IOProcessor> ("Delivery")
 687                 .endClass ()
 688
 689                 .deriveWSPtrClass <Plugin, PBD::StatefulDestructible> ("Plugin")
 690                 .addFunction ("label", &Plugin::label)
 691                 .addFunction ("name", &Plugin::name)
 692                 .addFunction ("maker", &Plugin::maker)
 693                 .addFunction ("parameter_count", &Plugin::parameter_count)
 694                 .addRefFunction ("nth_parameter", &Plugin::nth_parameter)
 695                 .addFunction ("preset_by_label", &Plugin::preset_by_label)
 696                 .addFunction ("preset_by_uri", &Plugin::preset_by_uri)
 697                 .addFunction ("load_preset", &Plugin::load_preset)
 698                 .addFunction ("parameter_is_input", &Plugin::parameter_is_input)
 699                 .addFunction ("get_docs", &Plugin::get_docs)
 700                 .addFunction ("get_parameter_docs", &Plugin::get_parameter_docs)
 701                 .addRefFunction ("get_parameter_descriptor", &Plugin::get_parameter_descriptor)
 702                 .endClass ()
 703
 704                 .deriveWSPtrClass <PluginInsert, Processor> ("PluginInsert")
 705                 .addFunction ("plugin", &PluginInsert::plugin)
 706                 .addFunction ("activate", &PluginInsert::activate)
 707                 .addFunction ("deactivate", &PluginInsert::deactivate)
 708                 .addFunction ("strict_io_configured", &PluginInsert::strict_io_configured)
 709                 .addFunction ("input_map", (ARDOUR::ChanMapping (PluginInsert::*)(uint32_t) const)&PluginInsert::input_map)
 710                 .addFunction ("output_map", (ARDOUR::ChanMapping (PluginInsert::*)(uint32_t) const)&PluginInsert::output_map)
 711                 .addFunction ("set_input_map", &PluginInsert::set_input_map)
 712                 .addFunction ("set_output_map", &PluginInsert::set_output_map)
 713                 .addFunction ("sidechain_input", &PluginInsert::sidechain_input)
 714                 .endClass ()
 715
 716                 .deriveWSPtrClass <AutomationControl, PBD::Controllable> ("AutomationControl")
 717                 .addCast<Evoral::Control> ("to_ctrl")
 718                 .addFunction ("automation_state", &AutomationControl::automation_state)
 719                 .addFunction ("automation_style", &AutomationControl::automation_style)
 720                 .addFunction ("set_automation_state", &AutomationControl::set_automation_state)
 721                 .addFunction ("set_automation_style", &AutomationControl::set_automation_style)
 722                 .addFunction ("start_touch", &AutomationControl::start_touch)
 723                 .addFunction ("stop_touch", &AutomationControl::stop_touch)
 724                 .addFunction ("get_value", &AutomationControl::get_value)
 725                 .addFunction ("set_value", &AutomationControl::set_value)
 726                 .addFunction ("writable", &AutomationControl::writable)
 727                 .addFunction ("alist", &AutomationControl::alist)
 728                 .endClass ()
 729
 730                 .deriveWSPtrClass <GainControl, AutomationControl> ("GainControl")
 731                 .endClass ()
 732
 733                 .deriveWSPtrClass <Amp, Processor> ("Amp")
 734                 .addFunction ("gain_control", (boost::shared_ptr<GainControl>(Amp::*)())&Amp::gain_control)
 735                 .endClass ()
 736
 737                 .deriveWSPtrClass <PluginInsert::PluginControl, AutomationControl> ("PluginControl")
 738                 .endClass ()
 739
 740                 .deriveWSPtrClass <AudioSource, Source> ("AudioSource")
 741                 .addFunction ("readable_length", &AudioSource::readable_length)
 742                 .addFunction ("n_channels", &AudioSource::n_channels)
 743                 .endClass ()
 744
 745                 // <std::list<boost::shared_ptr <AudioTrack> >
 746                 .beginStdList <boost::shared_ptr<AudioTrack> > ("AudioTrackList")
 747                 .endClass ()
 748
 749                 // std::list<boost::shared_ptr <MidiTrack> >
 750                 .beginStdList <boost::shared_ptr<MidiTrack> > ("MidiTrackList")
 751                 .endClass ()
 752
 753                 // RouteList == std::list<boost::shared_ptr<Route> >
 754                 .beginConstStdList <boost::shared_ptr<Route> > ("RouteList")
 755                 .endClass ()
 756
 757                 // boost::shared_ptr<RouteList>
 758                 .beginPtrStdList <boost::shared_ptr<Route> > ("RouteListPtr")
 759                 .endClass ()
 760
 761                 // typedef std::list<boost::weak_ptr <Route> > WeakRouteList
 762                 .beginConstStdList <boost::weak_ptr<Route> > ("WeakRouteList")
 763                 .endClass ()
 764
 765                 // std::list< boost::weak_ptr <AudioSource> >
 766                 .beginConstStdList <boost::weak_ptr<AudioSource> > ("WeakAudioSourceList")
 767                 .endClass ()
 768
 769                 // typedef std::list<boost::shared_ptr<Region> > RegionList
 770                 .beginConstStdList <boost::shared_ptr<Region> > ("RegionList")
 771                 .endClass ()
 772
 773                 // boost::shared_ptr <std::list<boost::shared_ptr<Region> > >
 774                 .beginPtrStdList <boost::shared_ptr<Region> > ("RegionListPtr")
 775                 .endClass ()
 776
 777                 // used by Playlist::cut/copy
 778                 .beginConstStdList <AudioRange> ("AudioRangeList")
 779                 .endClass ()
 780
 781                 .beginConstStdList <Location*> ("LocationList")
 782                 .endClass ()
 783
 784 #if 0  // depends on Evoal:: Note, Beats see note_fixer.h
 785         // typedef Evoral::Note<Evoral::Beats> Note;
 786         // std::set< boost::weak_ptr<Note> >
 787                 .beginStdSet <boost::weak_ptr<Note> > ("WeakNoteSet")
 788                 .endClass ()
 789 #endif
 790
 791         // std::list<boost::weak_ptr<Source> >
 792                 .beginConstStdList <boost::weak_ptr<Source> > ("WeakSourceList")
 793                 .endClass ()
 794
 795                 .beginClass <Tempo> ("Tempo")
 796                 .addConstructor <void (*) (double, double)> ()
 797                 .addFunction ("note_type", &Tempo::note_type)
 798                 .addFunction ("beats_per_minute", &Tempo::beats_per_minute)
 799                 .addFunction ("frames_per_beat", &Tempo::frames_per_beat)
 800                 .endClass ()
 801
 802                 .beginClass <Meter> ("Meter")
 803                 .addConstructor <void (*) (double, double)> ()
 804                 .addFunction ("divisions_per_bar", &Meter::divisions_per_bar)
 805                 .addFunction ("note_divisor", &Meter::note_divisor)
 806                 .addFunction ("frames_per_bar", &Meter::frames_per_bar)
 807                 .addFunction ("frames_per_grid", &Meter::frames_per_grid)
 808                 .endClass ()
 809
 810                 .beginClass <TempoMap> ("TempoMap")
 811                 .addFunction ("add_tempo", &TempoMap::add_tempo)
 812                 .addFunction ("add_meter", &TempoMap::add_meter)
 813                 .endClass ()
 814
 815                 .beginClass <ChanCount> ("ChanCount")
 816                 .addConstructor <void (*) (DataType, uint32_t)> ()
 817                 .addFunction ("get", &ChanCount::get)
 818                 .addFunction ("set", &ChanCount::set)
 819                 .addFunction ("n_audio", &ChanCount::n_audio)
 820                 .addFunction ("n_midi", &ChanCount::n_midi)
 821                 .addFunction ("n_total", &ChanCount::n_total)
 822                 .addFunction ("reset", &ChanCount::reset)
 823                 .endClass()
 824
 825                 .beginClass <DataType> ("DataType")
 826                 .addConstructor <void (*) (std::string)> ()
 827                 .addStaticCFunction ("null",  &LuaAPI::datatype_ctor_null) // "nil" is a lua reseved word
 828                 .addStaticCFunction ("audio", &LuaAPI::datatype_ctor_audio)
 829                 .addStaticCFunction ("midi",  &LuaAPI::datatype_ctor_midi)
 830                 .addFunction ("to_string",  &DataType::to_string) // TODO Lua __tostring
 831                 // TODO add uint32_t cast, add operator==  !=
 832                 .endClass()
 833
 834                 /* libardour enums */
 835                 .beginNamespace ("PluginType")
 836                 .addConst ("AudioUnit", ARDOUR::PluginType(AudioUnit))
 837                 .addConst ("LADSPA", ARDOUR::PluginType(LADSPA))
 838                 .addConst ("LV2", ARDOUR::PluginType(LV2))
 839                 .addConst ("Windows_VST", ARDOUR::PluginType(Windows_VST))
 840                 .addConst ("LXVST", ARDOUR::PluginType(LXVST))
 841                 .addConst ("Lua", ARDOUR::PluginType(Lua))
 842                 .endNamespace ()
 843
 844                 .beginNamespace ("AutoStyle")
 845                 .addConst ("Absolute", ARDOUR::AutoStyle(Absolute))
 846                 .addConst ("Trim", ARDOUR::AutoStyle(Trim))
 847                 .endNamespace ()
 848
 849                 .beginNamespace ("AutoState")
 850                 .addConst ("Off", ARDOUR::AutoState(Off))
 851                 .addConst ("Write", ARDOUR::AutoState(Write))
 852                 .addConst ("Touch", ARDOUR::AutoState(Touch))
 853                 .addConst ("Play", ARDOUR::AutoState(Play))
 854                 .endNamespace ()
 855
 856                 .beginNamespace ("AutomationType")
 857                 .addConst ("PluginAutomation", ARDOUR::AutomationType(PluginAutomation))
 858                 .addConst ("PluginAutomation", ARDOUR::AutomationType(GainAutomation))
 859                 .addConst ("PluginAutomation", ARDOUR::AutomationType(TrimAutomation))
 860                 .endNamespace ()
 861
 862                 .beginNamespace ("SrcQuality")
 863                 .addConst ("SrcBest", ARDOUR::SrcQuality(SrcBest))
 864                 .endNamespace ()
 865
 866                 .beginNamespace ("PlaylistDisposition")
 867                 .addConst ("CopyPlaylist", ARDOUR::PlaylistDisposition(CopyPlaylist))
 868                 .addConst ("NewPlaylist", ARDOUR::PlaylistDisposition(NewPlaylist))
 869                 .addConst ("SharePlaylist", ARDOUR::PlaylistDisposition(SharePlaylist))
 870                 .endNamespace ()
 871
 872                 .beginNamespace ("RegionPoint")
 873                 .addConst ("Start", ARDOUR::RegionPoint(Start))
 874                 .addConst ("End", ARDOUR::RegionPoint(End))
 875                 .addConst ("SyncPoint", ARDOUR::RegionPoint(SyncPoint))
 876                 .endNamespace ()
 877
 878                 .beginNamespace ("TrackMode")
 879                 .addConst ("Normal", ARDOUR::TrackMode(Start))
 880                 .addConst ("NonLayered", ARDOUR::TrackMode(NonLayered))
 881                 .addConst ("Destructive", ARDOUR::TrackMode(Destructive))
 882                 .endNamespace ()
 883                 .endNamespace ();
 884
 885         luabridge::getGlobalNamespace (L)
 886                 .beginNamespace ("ARDOUR")
 887                 .beginClass <AudioBackendInfo> ("AudioBackendInfo")
 888                 .addData ("name", &AudioBackendInfo::name)
 889                 .endClass()
 890                 .beginStdVector <const AudioBackendInfo*> ("BackendVector").endClass ()
 891
 892                 .beginClass <AudioBackend::DeviceStatus> ("DeviceStatus")
 893                 .addData ("name", &AudioBackend::DeviceStatus::name)
 894                 .addData ("available", &AudioBackend::DeviceStatus::available)
 895                 .endClass()
 896                 .beginStdVector <AudioBackend::DeviceStatus> ("DeviceStatusVector").endClass ()
 897
 898                 .beginWSPtrClass <AudioBackend> ("AudioBackend")
 899                 .addFunction ("info", &AudioBackend::info)
 900                 .addFunction ("sample_rate", &AudioBackend::sample_rate)
 901                 .addFunction ("buffer_size", &AudioBackend::buffer_size)
 902                 .addFunction ("period_size", &AudioBackend::period_size)
 903                 .addFunction ("input_channels", &AudioBackend::input_channels)
 904                 .addFunction ("output_channels", &AudioBackend::output_channels)
 905                 .addFunction ("dsp_load", &AudioBackend::dsp_load)
 906
 907                 .addFunction ("set_sample_rate", &AudioBackend::set_sample_rate)
 908                 .addFunction ("set_buffer_size", &AudioBackend::set_buffer_size)
 909                 .addFunction ("set_peridod_size", &AudioBackend::set_peridod_size)
 910
 911                 .addFunction ("enumerate_drivers", &AudioBackend::enumerate_drivers)
 912                 .addFunction ("driver_name", &AudioBackend::driver_name)
 913                 .addFunction ("set_driver", &AudioBackend::set_driver)
 914
 915                 .addFunction ("use_separate_input_and_output_devices", &AudioBackend::use_separate_input_and_output_devices)
 916                 .addFunction ("enumerate_devices", &AudioBackend::enumerate_devices)
 917                 .addFunction ("enumerate_input_devices", &AudioBackend::enumerate_input_devices)
 918                 .addFunction ("enumerate_output_devices", &AudioBackend::enumerate_output_devices)
 919                 .addFunction ("device_name", &AudioBackend::device_name)
 920                 .addFunction ("input_device_name", &AudioBackend::input_device_name)
 921                 .addFunction ("output_device_name", &AudioBackend::output_device_name)
 922                 .addFunction ("set_device_name", &AudioBackend::set_device_name)
 923                 .addFunction ("set_input_device_name", &AudioBackend::set_input_device_name)
 924                 .addFunction ("set_output_device_name", &AudioBackend::set_output_device_name)
 925                 .endClass()
 926
 927                 .beginClass <AudioEngine> ("AudioEngine")
 928                 .addFunction ("available_backends", &AudioEngine::available_backends)
 929                 .addFunction ("current_backend_name", &AudioEngine::current_backend_name)
 930                 .addFunction ("set_backend", &AudioEngine::set_backend)
 931                 .addFunction ("setup_required", &AudioEngine::setup_required)
 932                 .addFunction ("start", &AudioEngine::start)
 933                 .addFunction ("stop", &AudioEngine::stop)
 934                 .addFunction ("get_dsp_load", &AudioEngine::get_dsp_load)
 935                 .addFunction ("set_device_name", &AudioEngine::set_device_name)
 936                 .addFunction ("set_sample_rate", &AudioEngine::set_sample_rate)
 937                 .addFunction ("set_buffer_size", &AudioEngine::set_buffer_size)
 938                 .addFunction ("get_last_backend_error", &AudioEngine::get_last_backend_error)
 939                 .endClass()
 940                 .endNamespace ();
 941
 942         // basic representation of Session
 943         // functions which can be used from realtime and non-realtime contexts
 944         luabridge::getGlobalNamespace (L)
 945                 .beginNamespace ("ARDOUR")
 946                 .beginClass <Session> ("Session")
 947                 .addFunction ("scripts_changed", &Session::scripts_changed) // used internally
 948                 .addFunction ("transport_rolling", &Session::transport_rolling)
 949                 .addFunction ("request_transport_speed", &Session::request_transport_speed)
 950                 .addFunction ("transport_frame", &Session::transport_frame)
 951                 .addFunction ("transport_speed", &Session::transport_speed)
 952                 .addFunction ("frame_rate", &Session::frame_rate)
 953                 .addFunction ("nominal_frame_rate", &Session::nominal_frame_rate)
 954                 .addFunction ("frames_per_timecode_frame", &Session::frames_per_timecode_frame)
 955                 .addFunction ("timecode_frames_per_hour", &Session::timecode_frames_per_hour)
 956                 .addFunction ("timecode_frames_per_second", &Session::timecode_frames_per_second)
 957                 .addFunction ("timecode_drop_frames", &Session::timecode_drop_frames)
 958                 .addFunction ("request_locate", &Session::request_locate)
 959                 .addFunction ("request_stop", &Session::request_stop)
 960                 .addFunction ("last_transport_start", &Session::last_transport_start)
 961                 .addFunction ("goto_start", &Session::goto_start)
 962                 .addFunction ("goto_end", &Session::goto_end)
 963                 .addFunction ("current_start_frame", &Session::current_start_frame)
 964                 .addFunction ("current_end_frame", &Session::current_end_frame)
 965                 .addFunction ("actively_recording", &Session::actively_recording)
 966                 .addFunction ("new_audio_track", &Session::new_audio_track)
 967                 .addFunction ("new_audio_route", &Session::new_audio_route)
 968                 .addFunction ("new_midi_track", &Session::new_midi_track)
 969                 .addFunction ("new_midi_route", &Session::new_midi_route)
 970                 .addFunction ("get_routes", &Session::get_routes)
 971                 .addFunction ("get_tracks", &Session::get_tracks)
 972                 .addFunction ("name", &Session::name)
 973                 .addFunction ("path", &Session::path)
 974                 .addFunction ("record_status", &Session::record_status)
 975                 .addFunction ("route_by_id", &Session::route_by_id)
 976                 .addFunction ("route_by_name", &Session::route_by_name)
 977                 .addFunction ("route_by_remote_id", &Session::route_by_remote_id)
 978                 .addFunction ("track_by_diskstream_id", &Session::track_by_diskstream_id)
 979                 .addFunction ("source_by_id", &Session::source_by_id)
 980                 .addFunction ("controllable_by_id", &Session::controllable_by_id)
 981                 .addFunction ("processor_by_id", &Session::processor_by_id)
 982                 .addFunction ("snap_name", &Session::snap_name)
 983                 .addFunction ("monitor_out", &Session::monitor_out)
 984                 .addFunction ("master_out", &Session::master_out)
 985                 .addFunction ("tempo_map", (TempoMap& (Session::*)())&Session::tempo_map)
 986                 .addFunction ("locations", &Session::locations)
 987                 .addFunction ("begin_reversible_command", (void (Session::*)(const std::string&))&Session::begin_reversible_command)
 988                 .addFunction ("commit_reversible_command", &Session::commit_reversible_command)
 989                 .addFunction ("abort_reversible_command", &Session::abort_reversible_command)
 990                 .addFunction ("add_command", &Session::add_command)
 991                 .addFunction ("add_stateful_diff_command", &Session::add_stateful_diff_command)
 992                 .endClass ()
 993
 994                 .beginClass <RegionFactory> ("RegionFactory")
 995                 .addStaticFunction ("region_by_id", &RegionFactory::region_by_id)
 996                 .endClass ()
 997
 998                 /* session enums */
 999                 .beginNamespace ("Session")
1000
1001                 .beginNamespace ("RecordState")
1002                 .addConst ("Disabled", ARDOUR::Session::RecordState(Session::Disabled))
1003                 .addConst ("Enabled", ARDOUR::Session::RecordState(Session::Enabled))
1004                 .addConst ("Recording", ARDOUR::Session::RecordState(Session::Recording))
1005                 .endNamespace ()
1006
1007                 .endNamespace () // END Session enums
1008
1009                 .beginNamespace ("LuaAPI")
1010                 .addFunction ("nil_proc", ARDOUR::LuaAPI::nil_processor)
1011                 .addFunction ("new_luaproc", ARDOUR::LuaAPI::new_luaproc)
1012                 .addFunction ("new_plugin_info", ARDOUR::LuaAPI::new_plugin_info)
1013                 .addFunction ("new_plugin", ARDOUR::LuaAPI::new_plugin)
1014                 .addFunction ("set_processor_param", ARDOUR::LuaAPI::set_processor_param)
1015                 .addFunction ("set_plugin_insert_param", ARDOUR::LuaAPI::set_plugin_insert_param)
1016                 .addCFunction ("plugin_automation", ARDOUR::LuaAPI::plugin_automation)
1017                 .addFunction ("usleep", Glib::usleep)
1018                 .endNamespace ()
1019
1020                 .endNamespace ();// END ARDOUR
1021 }
1022
1023 void
1024 LuaBindings::dsp (lua_State* L)
1025 {
1026         luabridge::getGlobalNamespace (L)
1027                 .beginNamespace ("ARDOUR")
1028
1029                 .beginClass <AudioBuffer> ("AudioBuffer")
1030                 .addEqualCheck ()
1031                 .addFunction ("data", (Sample*(AudioBuffer::*)(framecnt_t))&AudioBuffer::data)
1032                 .addFunction ("silence", &AudioBuffer::silence)
1033                 .addFunction ("apply_gain", &AudioBuffer::apply_gain)
1034                 .addFunction ("check_silence", &AudioBuffer::check_silence)
1035                 .addFunction ("read_from", (void (AudioBuffer::*)(const Sample*, framecnt_t, framecnt_t, framecnt_t))&AudioBuffer::check_silence)
1036                 .endClass()
1037
1038                 .beginClass <MidiBuffer> ("MidiBuffer")
1039                 .addEqualCheck ()
1040                 .addFunction ("silence", &MidiBuffer::silence)
1041                 .addFunction ("empty", &MidiBuffer::empty)
1042                 // TODO iterators..
1043                 .endClass()
1044
1045                 .beginClass <BufferSet> ("BufferSet")
1046                 .addEqualCheck ()
1047                 .addFunction ("get_audio", static_cast<AudioBuffer&(BufferSet::*)(size_t)>(&BufferSet::get_audio))
1048                 .addFunction ("count", static_cast<const ChanCount&(BufferSet::*)()const>(&BufferSet::count))
1049                 .endClass()
1050                 .endNamespace ();
1051
1052         luabridge::getGlobalNamespace (L)
1053                 .beginNamespace ("Evoral")
1054                 .beginClass <Evoral::Event<framepos_t> > ("Event")
1055                 .addFunction ("clear", &Evoral::Event<framepos_t>::clear)
1056                 .addFunction ("size", &Evoral::Event<framepos_t>::size)
1057                 .addFunction ("set_buffer", &Evoral::Event<framepos_t>::set_buffer)
1058                 .addFunction ("buffer", (uint8_t*(Evoral::Event<framepos_t>::*)())&Evoral::Event<framepos_t>::buffer)
1059                 .endClass ()
1060
1061                 .beginClass <Evoral::Beats> ("Beats")
1062                 .addFunction ("to_double", &Evoral::Beats::to_double)
1063                 .endClass ()
1064
1065                 .deriveClass <Evoral::MIDIEvent<framepos_t>, Evoral::Event<framepos_t> > ("MidiEvent")
1066                 // add Ctor?
1067                 .addFunction ("type", &Evoral::MIDIEvent<framepos_t>::type)
1068                 .addFunction ("channel", &Evoral::MIDIEvent<framepos_t>::channel)
1069                 .addFunction ("set_type", &Evoral::MIDIEvent<framepos_t>::type)
1070                 .addFunction ("set_channel", &Evoral::MIDIEvent<framepos_t>::channel)
1071                 .endClass ()
1072                 .endNamespace ();
1073
1074         // dsp releated session functions
1075         luabridge::getGlobalNamespace (L)
1076                 .beginNamespace ("ARDOUR")
1077                 .beginClass <Session> ("Session")
1078                 .addFunction ("get_scratch_buffers", &Session::get_scratch_buffers)
1079                 .addFunction ("get_silent_buffers", &Session::get_silent_buffers)
1080                 .endClass ()
1081                 .endNamespace ();
1082
1083         luabridge::getGlobalNamespace (L)
1084                 .beginNamespace ("ARDOUR")
1085                 .beginNamespace ("DSP")
1086                 .addFunction ("compute_peak", ARDOUR::compute_peak)
1087                 .addFunction ("find_peaks", ARDOUR::find_peaks)
1088                 .addFunction ("apply_gain_to_buffer", ARDOUR::apply_gain_to_buffer)
1089                 .addFunction ("mix_buffers_no_gain", ARDOUR::mix_buffers_no_gain)
1090                 .addFunction ("mix_buffers_with_gain", ARDOUR::mix_buffers_with_gain)
1091                 .addFunction ("copy_vector", ARDOUR::copy_vector)
1092                 .addFunction ("dB_to_coefficient", &dB_to_coefficient)
1093                 .addFunction ("fast_coefficient_to_dB", &fast_coefficient_to_dB)
1094                 .addFunction ("accurate_coefficient_to_dB", &accurate_coefficient_to_dB)
1095                 .addFunction ("memset", &DSP::memset)
1096                 .addFunction ("mmult", &DSP::mmult)
1097                 .addFunction ("log_meter", &DSP::log_meter)
1098                 .addFunction ("log_meter_coeff", &DSP::log_meter_coeff)
1099                 .addRefFunction ("peaks", &DSP::peaks)
1100
1101                 .beginClass <DSP::LowPass> ("LowPass")
1102                 .addConstructor <void (*) (double, float)> ()
1103                 .addFunction ("proc", &DSP::LowPass::proc)
1104                 .addFunction ("ctrl", &DSP::LowPass::ctrl)
1105                 .addFunction ("set_cutoff", &DSP::LowPass::set_cutoff)
1106                 .addFunction ("reset", &DSP::LowPass::reset)
1107                 .endClass ()
1108                 .beginClass <DSP::BiQuad> ("Biquad")
1109                 .addConstructor <void (*) (double)> ()
1110                 .addFunction ("run", &DSP::BiQuad::run)
1111                 .addFunction ("compute", &DSP::BiQuad::compute)
1112                 .addFunction ("reset", &DSP::BiQuad::reset)
1113                 .endClass ()
1114
1115                 /* DSP enums */
1116                 .beginNamespace ("BiQuadType")
1117                 .addConst ("LowPass", ARDOUR::DSP::BiQuad::LowPass)
1118                 .addConst ("HighPass", ARDOUR::DSP::BiQuad::HighPass)
1119                 .addConst ("BandPassSkirt", ARDOUR::DSP::BiQuad::BandPassSkirt)
1120                 .addConst ("BandPass0dB", ARDOUR::DSP::BiQuad::BandPass0dB)
1121                 .addConst ("Notch", ARDOUR::DSP::BiQuad::Notch)
1122                 .addConst ("AllPass", ARDOUR::DSP::BiQuad::AllPass)
1123                 .addConst ("Peaking", ARDOUR::DSP::BiQuad::Peaking)
1124                 .addConst ("LowShelf", ARDOUR::DSP::BiQuad::LowShelf)
1125                 .addConst ("HighShelf", ARDOUR::DSP::BiQuad::HighShelf)
1126                 .endNamespace ()
1127
1128                 .beginClass <DSP::DspShm> ("DspShm")
1129                 .addFunction ("allocate", &DSP::DspShm::allocate)
1130                 .addFunction ("clear", &DSP::DspShm::clear)
1131                 .addFunction ("to_float", &DSP::DspShm::to_float)
1132                 .addFunction ("to_int", &DSP::DspShm::to_int)
1133                 .addFunction ("atomic_set_int", &DSP::DspShm::atomic_set_int)
1134                 .addFunction ("atomic_get_int", &DSP::DspShm::atomic_get_int)
1135                 .endClass ()
1136
1137                 .endNamespace () // DSP
1138                 .endNamespace (); // ARDOUR
1139 }
1140
1141 void
1142 LuaBindings::session (lua_State* L)
1143 {
1144         // non-realtime session functions
1145         luabridge::getGlobalNamespace (L)
1146                 .beginNamespace ("ARDOUR")
1147                 .beginClass <Session> ("Session")
1148                 .addFunction ("save_state", &Session::save_state)
1149                 .addFunction ("set_dirty", &Session::set_dirty)
1150                 .addFunction ("unknown_processors", &Session::unknown_processors)
1151
1152                 .addFunction<RouteList (Session::*)(uint32_t, const std::string&, const std::string&, PlaylistDisposition)> ("new_route_from_template", &Session::new_route_from_template)
1153                 // TODO  session_add_audio_track  session_add_midi_track  session_add_mixed_track
1154                 //.addFunction ("new_midi_track", &Session::new_midi_track)
1155                 .endClass ()
1156
1157                 .endNamespace (); // ARDOUR
1158 }
1159
1160 void
1161 LuaBindings::osc (lua_State* L)
1162 {
1163         luabridge::getGlobalNamespace (L)
1164                 .beginNamespace ("ARDOUR")
1165                 .beginNamespace ("LuaOSC")
1166                 .beginClass<LuaOSC::Address> ("Address")
1167                 .addConstructor<void (*) (std::string)> ()
1168                 .addCFunction ("send", &LuaOSC::Address::send)
1169                 .endClass ()
1170                 .endNamespace ()
1171                 .endNamespace ();
1172 }
1173
1174 void
1175 LuaBindings::set_session (lua_State* L, Session *s)
1176 {
1177         /* LuaBridge uses unique keys to identify classes/c-types.
1178          *
1179          * Those keys are "generated" by using the memory-address of a static
1180          * variable, templated for every Class.
1181          * (see libs/lua/LuaBridge/detail/ClassInfo.h)
1182          *
1183          * When linking the final executable there must be exactly one static
1184          * function (static variable) for every templated class.
1185          * This works fine on OSX and Linux...
1186          *
1187          * Windows (mingw and MSVC) however expand the template differently for libardour
1188          * AND gtk2_ardour. We end up with two identical static functions
1189          * at different addresses!!
1190          *
1191          * The Solution: have gtk2_ardour never include LuaBridge headers directly
1192          * and always go via libardour function calls for classes that are registered
1193          * in libardour. (calling lua itself is fine,  calling c-functions in the GUI
1194          * which expand the template is not)
1195          *
1196          * (the actual cause: even static symbols in a .dll have no fixed address
1197          * and are mapped when loading the dll. static functions in .exe do have a fixed
1198          * address)
1199          *
1200          * libardour:
1201          *  0000000000000000 I __imp__ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
1202          *  0000000000000000 I __nm__ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
1203          *  0000000000000000 T _ZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEv
1204          *
1205          * ardour.exe
1206          *  000000000104f560 d .data$_ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
1207          *  000000000104f560 D _ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
1208          *  0000000000e9baf0 T _ZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEv
1209          *
1210          *
1211          */
1212         luabridge::push <Session *> (L, s);
1213         lua_setglobal (L, "Session");
1214
1215         if (s) {
1216                 // call lua function.
1217                 luabridge::LuaRef cb_ses = luabridge::getGlobal (L, "new_session");
1218                 if (cb_ses.type() == LUA_TFUNCTION) { cb_ses(s->name()); } // TODO args
1219         }
1220 }