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 "pbd/openuri.h"
  24 #include "evoral/Control.hpp"
  25 #include "evoral/ControlList.hpp"
  26 #include "evoral/Range.hpp"
  27
  28 #include "ardour/amp.h"
  29 #include "ardour/audioengine.h"
  30 #include "ardour/audiosource.h"
  31 #include "ardour/audio_backend.h"
  32 #include "ardour/audio_buffer.h"
  33 #include "ardour/audio_port.h"
  34 #include "ardour/audio_track.h"
  35 #include "ardour/buffer_set.h"
  36 #include "ardour/chan_mapping.h"
  37 #include "ardour/dB.h"
  38 #include "ardour/dsp_filter.h"
  39 #include "ardour/fluid_synth.h"
  40 #include "ardour/interthread_info.h"
  41 #include "ardour/lua_api.h"
  42 #include "ardour/luabindings.h"
  43 #include "ardour/luaproc.h"
  44 #include "ardour/meter.h"
  45 #include "ardour/midi_track.h"
  46 #include "ardour/midi_port.h"
  47 #include "ardour/phase_control.h"
  48 #include "ardour/playlist.h"
  49 #include "ardour/plugin.h"
  50 #include "ardour/plugin_insert.h"
  51 #include "ardour/port_manager.h"
  52 #include "ardour/runtime_functions.h"
  53 #include "ardour/region.h"
  54 #include "ardour/region_factory.h"
  55 #include "ardour/route_group.h"
  56 #include "ardour/session.h"
  57 #include "ardour/session_object.h"
  58 #include "ardour/sidechain.h"
  59 #include "ardour/solo_isolate_control.h"
  60 #include "ardour/solo_safe_control.h"
  61 #include "ardour/stripable.h"
  62 #include "ardour/track.h"
  63 #include "ardour/tempo.h"
  64
  65 #include "LuaBridge/LuaBridge.h"
  66
  67 #ifdef PLATFORM_WINDOWS
  68 /* luabridge uses addresses of static functions/variables to identify classes.
  69  *
  70  * Static symbols on windows (even identical symbols) are not
  71  * mapped to the same address when mixing .dll + .exe.
  72  * So we need a single point to define those static functions.
  73  * (normally they're header-only in libs/lua/LuaBridge/detail/ClassInfo.h)
  74  *
  75  * Really!! A static function with a static variable in a library header
  76  * should never ever be replicated, even if it is a template.
  77  * But then again this is windows... what else can go wrong.
  78  */
  79
  80 template <class T>
  81 void const*
  82 luabridge::ClassInfo<T>::getStaticKey ()
  83 {
  84         static char value;
  85         return &value;
  86 }
  87
  88 template <class T>
  89 void const*
  90 luabridge::ClassInfo<T>::getClassKey ()
  91 {
  92         static char value;
  93         return &value;
  94 }
  95
  96 template <class T>
  97 void const*
  98 luabridge::ClassInfo<T>::getConstKey ()
  99 {
 100         static char value;
 101         return &value;
 102 }
 103
 104 void*
 105 luabridge::getIdentityKey ()
 106 {
 107   static char value;
 108   return &value;
 109 }
 110
 111 /* ...and this is the ugly part of it.
 112  *
 113  * We need to foward declare classes from gtk2_ardour
 114  * end explicily list classes which are used by gtk2_ardour's bindings.
 115  *
 116  * This is needed because some of the GUI classes use objects from libardour
 117  * as function parameters and the .exe would re-create symbols for libardour
 118  * objects.
 119  *
 120  * Classes which don't use libardour symbols could be moved to
 121  * gtk2_ardour/luainstance.cc, but keeping this here reduces code
 122  * duplication and does not give the compiler a chance to even think
 123  * about replicating the symbols.
 124  */
 125
 126 #define CLASSKEYS(CLS) \
 127         template void const* luabridge::ClassInfo< CLS >::getStaticKey(); \
 128         template void const* luabridge::ClassInfo< CLS >::getClassKey();  \
 129         template void const* luabridge::ClassInfo< CLS >::getConstKey();
 130
 131 #define CLASSINFO(CLS) \
 132         class CLS; \
 133         template void const* luabridge::ClassInfo< CLS >::getStaticKey(); \
 134         template void const* luabridge::ClassInfo< CLS >::getClassKey();  \
 135         template void const* luabridge::ClassInfo< CLS >::getConstKey();
 136
 137 CLASSINFO(MarkerSelection);
 138 CLASSINFO(TrackSelection);
 139 CLASSINFO(TrackViewList);
 140 CLASSINFO(TimeSelection);
 141 CLASSINFO(RegionSelection);
 142 CLASSINFO(PublicEditor);
 143 CLASSINFO(Selection);
 144 CLASSINFO(ArdourMarker);
 145
 146 namespace LuaCairo {
 147         class ImageSurface;
 148         class PangoLayout;
 149 }
 150 CLASSKEYS(LuaCairo::ImageSurface);
 151 CLASSKEYS(LuaCairo::PangoLayout);
 152
 153 namespace Cairo {
 154         class Context;
 155 }
 156 CLASSKEYS(Cairo::Context);
 157 CLASSKEYS(std::vector<double>);
 158 CLASSKEYS(std::list<ArdourMarker*>);
 159 CLASSKEYS(std::bitset<47ul>); // LuaSignal::LAST_SIGNAL
 160 CLASSKEYS(ArdourMarker*);
 161 CLASSKEYS(ARDOUR::RouteGroup);
 162 CLASSKEYS(ARDOUR::LuaProc);
 163 CLASSKEYS(ARDOUR::DataType);
 164 CLASSKEYS(ARDOUR::ChanCount);
 165 CLASSKEYS(boost::shared_ptr<ARDOUR::Processor>);
 166 CLASSKEYS(ARDOUR::ParameterDescriptor);
 167 CLASSKEYS(boost::shared_ptr<ARDOUR::AutomationList>);
 168 CLASSKEYS(boost::shared_ptr<Evoral::ControlList>);
 169 CLASSKEYS(ARDOUR::LuaOSC::Address);
 170 CLASSKEYS(ARDOUR::Session);
 171 CLASSKEYS(ARDOUR::BufferSet);
 172 CLASSKEYS(ARDOUR::ChanMapping);
 173 CLASSKEYS(ARDOUR::FluidSynth);
 174 CLASSKEYS(ARDOUR::DSP::DspShm);
 175 CLASSKEYS(ARDOUR::LuaTableRef);
 176 CLASSKEYS(PBD::Configuration);
 177 CLASSKEYS(ARDOUR::PresentationInfo);
 178 CLASSKEYS(ARDOUR::SessionConfiguration);
 179 CLASSKEYS(PBD::ID);
 180 CLASSKEYS(ARDOUR::Location);
 181 CLASSKEYS(ARDOUR::PluginInfo);
 182 CLASSKEYS(ARDOUR::MonitorProcessor);
 183 CLASSKEYS(ARDOUR::Plugin::PresetRecord);
 184 CLASSKEYS(std::vector<ARDOUR::Plugin::PresetRecord>);
 185 CLASSKEYS(PBD::PropertyChange);
 186 CLASSKEYS(std::vector<std::string>);
 187 CLASSKEYS(std::list<boost::shared_ptr<ARDOUR::Route> >);
 188 CLASSKEYS(std::list<boost::shared_ptr<ARDOUR::Port> >);
 189 CLASSKEYS(std::vector<boost::shared_ptr<ARDOUR::Processor> >);
 190 CLASSKEYS(boost::shared_ptr<ARDOUR::PluginInfo>);
 191 CLASSKEYS(boost::shared_ptr<ARDOUR::Region>);
 192 CLASSKEYS(boost::weak_ptr<ARDOUR::Route>);
 193 CLASSKEYS(std::list<boost::shared_ptr<ARDOUR::Region> >);
 194 CLASSKEYS(std::list<ARDOUR::AudioRange>);
 195 CLASSKEYS(Evoral::Beats);
 196 CLASSKEYS(ARDOUR::PortEngine);
 197 CLASSKEYS(ARDOUR::PortManager);
 198 CLASSKEYS(ARDOUR::AudioEngine);
 199 CLASSKEYS(void);
 200 CLASSKEYS(float);
 201 CLASSKEYS(unsigned char);
 202
 203 #endif // end windows special case
 204
 205 /* Some notes on Lua bindings for libardour and friends
 206  *
 207  * - Prefer factory methods over Contructors whenever possible.
 208  *   Don't expose the constructor method unless required.
 209  *
 210  *   e.g. Don't allow the script to construct a "Track" Object directly
 211  *   but do allow to create a "BBT_TIME" object.
 212  *
 213  * - Do not dereference Shared or Weak Pointers. Pass the pointer to Lua.
 214  * - Define Objects as boost:shared_ptr Object whenever possible.
 215  *
 216  *   Storing a boost::shared_ptr in a Lua-variable keeps the reference
 217  *   until that variable is set to 'nil'.
 218  *   (if the script were to keep a direct pointer to the object instance, the
 219  *   behaviour is undefined if the actual object goes away)
 220  *
 221  *   Methods of the actual class are indirectly exposed,
 222  *   boost::*_ptr get() and ::lock() is implicit when the class is exported
 223  *   as LuaBridge's "WSPtrClass".
 224  */
 225
 226 using namespace ARDOUR;
 227
 228 void
 229 LuaBindings::stddef (lua_State* L)
 230 {
 231         // std::list<std::string>
 232         luabridge::getGlobalNamespace (L)
 233                 .beginNamespace ("C")
 234                 .beginStdList <std::string> ("StringList")
 235                 .endClass ()
 236
 237         // std::vector<std::string>
 238                 .beginStdVector <std::string> ("StringVector")
 239                 .endClass ()
 240
 241         // register float array (uint8_t*)
 242                 .registerArray <uint8_t> ("ByteArray")
 243
 244         // register float array (float*)
 245                 .registerArray <float> ("FloatArray")
 246
 247         // register float array (int32_t*)
 248                 .registerArray <int32_t> ("IntArray")
 249
 250         // TODO std::set
 251                 .endNamespace ();
 252 }
 253
 254 void
 255 LuaBindings::common (lua_State* L)
 256 {
 257         luabridge::getGlobalNamespace (L)
 258                 .beginNamespace ("PBD")
 259
 260                 .addFunction ("open_uri", (bool (*) (const std::string&))&PBD::open_uri)
 261                 .addFunction ("open_uri", &PBD::open_folder)
 262
 263                 .beginClass <PBD::ID> ("ID")
 264                 .addConstructor <void (*) (std::string)> ()
 265                 .addFunction ("to_s", &PBD::ID::to_s) // TODO special case LUA __tostring ?
 266                 .endClass ()
 267
 268                 .beginStdVector <PBD::ID> ("IdVector").endClass ()
 269
 270                 .beginClass <XMLNode> ("XMLNode")
 271                 .addFunction ("name", &XMLNode::name)
 272                 .endClass ()
 273
 274                 .beginClass <PBD::Stateful> ("Stateful")
 275                 .addFunction ("id", &PBD::Stateful::id)
 276                 .addFunction ("properties", &PBD::Stateful::properties)
 277                 .addFunction ("clear_changes", &PBD::Stateful::clear_changes)
 278                 .endClass ()
 279
 280                 .beginWSPtrClass <PBD::Stateful> ("StatefulPtr")
 281                 .addFunction ("id", &PBD::Stateful::id)
 282                 .addFunction ("properties", &PBD::Stateful::properties)
 283                 .addFunction ("clear_changes", &PBD::Stateful::clear_changes)
 284                 .endClass ()
 285
 286                 .deriveClass <PBD::StatefulDestructible, PBD::Stateful> ("StatefulDestructible")
 287                 .endClass ()
 288
 289                 .deriveClass <PBD::Configuration, PBD::Stateful> ("Configuration")
 290                 .endClass()
 291
 292                 .deriveWSPtrClass <PBD::StatefulDestructible, PBD::Stateful> ("StatefulDestructiblePtr")
 293                 .endClass ()
 294
 295                 .deriveClass <Command, PBD::StatefulDestructible> ("Command")
 296                 .addFunction ("set_name", &Command::set_name)
 297                 .addFunction ("name", &Command::name)
 298                 .endClass ()
 299
 300                 /* UndoTransaction::add_command() subscribes to DropReferences()
 301                  * and deletes the object.
 302                  *
 303                  * This object cannot be constructed by lua because lua would manage lifetime
 304                  * and delete the object leading to a double free.
 305                  *
 306                  * use Session::add_stateful_diff_command()
 307                  * and Session::abort_reversible_command()
 308                  */
 309                 .deriveClass <PBD::StatefulDiffCommand, Command> ("StatefulDiffCommand")
 310                 .addFunction ("undo", &PBD::StatefulDiffCommand::undo)
 311                 .addFunction ("empty", &PBD::StatefulDiffCommand::empty)
 312                 .endClass ()
 313
 314                 .deriveWSPtrClass <PBD::Controllable, PBD::StatefulDestructible> ("Controllable")
 315                 .addFunction ("name", &PBD::Controllable::name)
 316                 .addFunction ("get_value", &PBD::Controllable::get_value)
 317                 .endClass ()
 318
 319                 .beginClass <PBD::RingBufferNPT <uint8_t> > ("RingBuffer8")
 320                 .addConstructor <void (*) (size_t)> ()
 321                 .addFunction ("reset", &PBD::RingBufferNPT<uint8_t>::reset)
 322                 .addFunction ("read", &PBD::RingBufferNPT<uint8_t>::read)
 323                 .addFunction ("write", &PBD::RingBufferNPT<uint8_t>::write)
 324                 .addFunction ("write_one", &PBD::RingBufferNPT<uint8_t>::write_one)
 325                 .addFunction ("write_space", &PBD::RingBufferNPT<uint8_t>::write_space)
 326                 .addFunction ("read_space", &PBD::RingBufferNPT<uint8_t>::read_space)
 327                 .addFunction ("increment_read_ptr", &PBD::RingBufferNPT<uint8_t>::increment_read_ptr)
 328                 .addFunction ("increment_write_ptr", &PBD::RingBufferNPT<uint8_t>::increment_write_ptr)
 329                 .endClass ()
 330
 331                 .beginClass <PBD::RingBufferNPT <float> > ("RingBufferF")
 332                 .addConstructor <void (*) (size_t)> ()
 333                 .addFunction ("reset", &PBD::RingBufferNPT<float>::reset)
 334                 .addFunction ("read", &PBD::RingBufferNPT<float>::read)
 335                 .addFunction ("write", &PBD::RingBufferNPT<float>::write)
 336                 .addFunction ("write_one", &PBD::RingBufferNPT<float>::write_one)
 337                 .addFunction ("write_space", &PBD::RingBufferNPT<float>::write_space)
 338                 .addFunction ("read_space", &PBD::RingBufferNPT<float>::read_space)
 339                 .addFunction ("increment_read_ptr", &PBD::RingBufferNPT<float>::increment_read_ptr)
 340                 .addFunction ("increment_write_ptr", &PBD::RingBufferNPT<float>::increment_write_ptr)
 341                 .endClass ()
 342
 343                 .beginClass <PBD::RingBufferNPT <int> > ("RingBufferI")
 344                 .addConstructor <void (*) (size_t)> ()
 345                 .addFunction ("reset", &PBD::RingBufferNPT<int>::reset)
 346                 .addFunction ("read", &PBD::RingBufferNPT<int>::read)
 347                 .addFunction ("write", &PBD::RingBufferNPT<int>::write)
 348                 .addFunction ("write_one", &PBD::RingBufferNPT<int>::write_one)
 349                 .addFunction ("write_space", &PBD::RingBufferNPT<int>::write_space)
 350                 .addFunction ("read_space", &PBD::RingBufferNPT<int>::read_space)
 351                 .addFunction ("increment_read_ptr", &PBD::RingBufferNPT<int>::increment_read_ptr)
 352                 .addFunction ("increment_write_ptr", &PBD::RingBufferNPT<int>::increment_write_ptr)
 353                 .endClass ()
 354
 355                 /* PBD enums */
 356                 .beginNamespace ("GroupControlDisposition")
 357                 .addConst ("InverseGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::InverseGroup))
 358                 .addConst ("NoGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::NoGroup))
 359                 .addConst ("UseGroup", PBD::Controllable::GroupControlDisposition(PBD::Controllable::UseGroup))
 360                 .endNamespace ()
 361
 362                 .endNamespace (); // PBD
 363
 364         luabridge::getGlobalNamespace (L)
 365                 .beginNamespace ("Timecode")
 366                 .beginClass <Timecode::BBT_Time> ("BBT_TIME")
 367                 .addConstructor <void (*) (uint32_t, uint32_t, uint32_t)> ()
 368                 .endClass ()
 369
 370                 /* libtimecode enums */
 371                 .beginNamespace ("TimecodeFormat")
 372                 .addConst ("TC23976", Timecode::TimecodeFormat(Timecode::timecode_23976))
 373                 .addConst ("TC24", Timecode::TimecodeFormat(Timecode::timecode_24))
 374                 .addConst ("TC24976", Timecode::TimecodeFormat(Timecode::timecode_24976))
 375                 .addConst ("TC25", Timecode::TimecodeFormat(Timecode::timecode_25))
 376                 .addConst ("TC2997", Timecode::TimecodeFormat(Timecode::timecode_2997))
 377                 .addConst ("TC2997DF", Timecode::TimecodeFormat(Timecode::timecode_2997drop))
 378                 .addConst ("TC2997000", Timecode::TimecodeFormat(Timecode::timecode_2997000))
 379                 .addConst ("TC2997000DF", Timecode::TimecodeFormat(Timecode::timecode_2997000drop))
 380                 .addConst ("TC30", Timecode::TimecodeFormat(Timecode::timecode_30))
 381                 .addConst ("TC5994", Timecode::TimecodeFormat(Timecode::timecode_5994))
 382                 .addConst ("TC60", Timecode::TimecodeFormat(Timecode::timecode_60))
 383                 .endNamespace ()
 384                 .endNamespace ();
 385
 386         luabridge::getGlobalNamespace (L)
 387
 388                 .beginNamespace ("Evoral")
 389                 .beginClass <Evoral::Parameter> ("Parameter")
 390                 .addConstructor <void (*) (uint32_t, uint8_t, uint32_t)> ()
 391                 .addFunction ("type", &Evoral::Parameter::type)
 392                 .addFunction ("channel", &Evoral::Parameter::channel)
 393                 .addFunction ("id", &Evoral::Parameter::id)
 394                 .endClass ()
 395
 396                 .beginWSPtrClass <Evoral::ControlList> ("ControlList")
 397                 .addFunction ("add", &Evoral::ControlList::add)
 398                 .addFunction ("thin", &Evoral::ControlList::thin)
 399                 .addFunction ("eval", &Evoral::ControlList::eval)
 400                 .addRefFunction ("rt_safe_eval", &Evoral::ControlList::rt_safe_eval)
 401                 .addFunction ("interpolation", &Evoral::ControlList::interpolation)
 402                 .addFunction ("set_interpolation", &Evoral::ControlList::set_interpolation)
 403                 .addFunction ("truncate_end", &Evoral::ControlList::truncate_end)
 404                 .addFunction ("truncate_start", &Evoral::ControlList::truncate_start)
 405                 .addFunction ("clear", (void (Evoral::ControlList::*)(double, double))&Evoral::ControlList::clear)
 406                 .addFunction ("in_write_pass", &Evoral::ControlList::in_write_pass)
 407                 .endClass ()
 408
 409                 .beginWSPtrClass <Evoral::ControlSet> ("ControlSet")
 410                 .endClass ()
 411
 412                 .beginWSPtrClass <Evoral::Control> ("Control")
 413                 .addFunction ("list", (boost::shared_ptr<Evoral::ControlList>(Evoral::Control::*)())&Evoral::Control::list)
 414                 .endClass ()
 415
 416                 .beginClass <Evoral::ParameterDescriptor> ("ParameterDescriptor")
 417                 .addVoidConstructor ()
 418                 .addData ("lower", &Evoral::ParameterDescriptor::lower)
 419                 .addData ("upper", &Evoral::ParameterDescriptor::upper)
 420                 .addData ("normal", &Evoral::ParameterDescriptor::normal)
 421                 .addData ("toggled", &Evoral::ParameterDescriptor::toggled)
 422                 .endClass ()
 423
 424                 .beginClass <Evoral::Range<framepos_t> > ("Range")
 425                 .addConstructor <void (*) (framepos_t, framepos_t)> ()
 426                 .addData ("from", &Evoral::Range<framepos_t>::from)
 427                 .addData ("to", &Evoral::Range<framepos_t>::to)
 428                 .endClass ()
 429
 430                 /* libevoral enums */
 431                 .beginNamespace ("InterpolationStyle")
 432                 .addConst ("Discrete", Evoral::ControlList::InterpolationStyle(Evoral::ControlList::Discrete))
 433                 .addConst ("Linear", Evoral::ControlList::InterpolationStyle(Evoral::ControlList::Linear))
 434                 .addConst ("Curved", Evoral::ControlList::InterpolationStyle(Evoral::ControlList::Curved))
 435                 .endNamespace ()
 436
 437                 .endNamespace () // Evoral
 438
 439                 .beginNamespace ("ARDOUR")
 440
 441                 .beginClass <InterThreadInfo> ("InterThreadInfo")
 442                 .addVoidConstructor ()
 443                 .addData ("done", const_cast<bool InterThreadInfo::*>(&InterThreadInfo::done))
 444 #if 0 // currently unused, lua is single-threaded, no custom UIs.
 445                 .addData ("cancel", (bool InterThreadInfo::*)&InterThreadInfo::cancel)
 446 #endif
 447                 .addData ("progress", const_cast<float InterThreadInfo::*>(&InterThreadInfo::progress))
 448                 .endClass ()
 449
 450                 .beginClass <AudioRange> ("AudioRange")
 451                 .addConstructor <void (*) (framepos_t, framepos_t, uint32_t)> ()
 452                 .addFunction ("length", &AudioRange::length)
 453                 .addFunction ("equal", &AudioRange::equal)
 454                 .addData ("start", &AudioRange::start)
 455                 .addData ("_end", &AudioRange::end) // XXX "end" is a lua reserved word
 456                 .addData ("id", &AudioRange::id)
 457                 .endClass ()
 458
 459                 .beginWSPtrClass <PluginInfo> ("PluginInfo")
 460                 .addVoidConstructor ()
 461                 .addData ("name", &PluginInfo::name, false)
 462                 .addData ("category", &PluginInfo::category, false)
 463                 .addData ("creator", &PluginInfo::creator, false)
 464                 .addData ("path", &PluginInfo::path, false)
 465                 .addData ("n_inputs", &PluginInfo::n_inputs, false)
 466                 .addData ("n_outputs", &PluginInfo::n_outputs, false)
 467                 .addData ("type", &PluginInfo::type, false)
 468                 .addData ("unique_id", &PluginInfo::unique_id, false)
 469                 .addFunction ("is_instrument", &PluginInfo::is_instrument)
 470                 .addFunction ("get_presets", &PluginInfo::get_presets)
 471                 .endClass ()
 472
 473                 .beginNamespace ("Route")
 474                 .beginClass <Route::ProcessorStreams> ("ProcessorStreams")
 475                 .addVoidConstructor ()
 476                 .endClass ()
 477                 .endNamespace ()
 478
 479                 .beginClass <ChanMapping> ("ChanMapping")
 480                 .addVoidConstructor ()
 481                 .addFunction ("get", static_cast<uint32_t(ChanMapping::*)(DataType, uint32_t) const>(&ChanMapping::get))
 482                 .addFunction ("set", &ChanMapping::set)
 483                 .addFunction ("count", &ChanMapping::count)
 484                 .addFunction ("n_total", &ChanMapping::n_total)
 485                 .addFunction ("is_monotonic", &ChanMapping::is_monotonic)
 486                 .addConst ("Invalid", 4294967295U) // UINT32_MAX
 487                 .endClass ()
 488
 489                 .beginNamespace ("Properties")
 490                 // templated class definitions
 491                 .beginClass <PBD::PropertyDescriptor<bool> > ("BoolProperty").endClass ()
 492                 .beginClass <PBD::PropertyDescriptor<float> > ("FloatProperty").endClass ()
 493                 .beginClass <PBD::PropertyDescriptor<framepos_t> > ("FrameposProperty").endClass ()
 494                 // actual references (TODO: also expose GQuark for std::set)
 495                 //   ardour/region.h
 496                 .addConst ("Start", &ARDOUR::Properties::start)
 497                 .addConst ("Length", &ARDOUR::Properties::length)
 498                 .addConst ("Position", &ARDOUR::Properties::position)
 499                 .endNamespace ()
 500
 501                 .beginClass <PBD::PropertyChange> ("PropertyChange")
 502                 // TODO add special handling (std::set<PropertyID>), PropertyID is a GQuark.
 503                 // -> direct map to lua table  beginStdSet()A
 504                 //
 505                 // expand templated PropertyDescriptor<T>
 506                 .addFunction ("containsBool", &PBD::PropertyChange::contains<bool>)
 507                 .addFunction ("containsFloat", &PBD::PropertyChange::contains<float>)
 508                 .addFunction ("containsFramePos", &PBD::PropertyChange::contains<framepos_t>)
 509                 .endClass ()
 510
 511                 .beginClass <PBD::PropertyList> ("PropertyList")
 512                 // is-a  std::map<PropertyID, PropertyBase*>
 513                 .endClass ()
 514
 515                 .deriveClass <PBD::OwnedPropertyList, PBD::PropertyList> ("OwnedPropertyList")
 516                 .endClass ()
 517
 518                 .beginWSPtrClass <AutomationList> ("AutomationList")
 519                 .addCast<PBD::Stateful> ("to_stateful")
 520                 .addCast<PBD::StatefulDestructible> ("to_statefuldestructible")
 521                 .addCast<Evoral::ControlList> ("list")
 522                 .addFunction ("get_state", &AutomationList::get_state)
 523                 .addFunction ("memento_command", &AutomationList::memento_command)
 524                 .addFunction ("touching", &AutomationList::touching)
 525                 .addFunction ("writing", &AutomationList::writing)
 526                 .addFunction ("touch_enabled", &AutomationList::touch_enabled)
 527                 .endClass ()
 528
 529                 .deriveClass <Location, PBD::StatefulDestructible> ("Location")
 530                 .addFunction ("locked", &Location::locked)
 531                 .addFunction ("lock", &Location::lock)
 532                 .addFunction ("unlock", &Location::unlock)
 533                 .addFunction ("start", &Location::start)
 534                 .addFunction ("_end", &Location::end) // XXX "end" is a lua reserved word
 535                 .addFunction ("length", &Location::length)
 536                 .addFunction ("set_start", &Location::set_start)
 537                 .addFunction ("set_end", &Location::set_end)
 538                 .addFunction ("set_length", &Location::set)
 539                 .addFunction ("move_to", &Location::move_to)
 540                 .addFunction ("matches", &Location::matches)
 541                 .addFunction ("flags", &Location::flags)
 542                 .addFunction ("is_auto_punch", &Location::is_auto_punch)
 543                 .addFunction ("is_auto_loop", &Location::is_auto_loop)
 544                 .addFunction ("is_mark", &Location::is_mark)
 545                 .addFunction ("is_hidden", &Location::is_hidden)
 546                 .addFunction ("is_cd_marker", &Location::is_cd_marker)
 547                 .addFunction ("is_session_range", &Location::is_session_range)
 548                 .addFunction ("is_range_marker", &Location::is_range_marker)
 549                 .endClass ()
 550
 551                 .deriveClass <Locations, PBD::StatefulDestructible> ("Locations")
 552                 .addFunction ("list", static_cast<Locations::LocationList (Locations::*)()>(&Locations::list))
 553                 .addFunction ("auto_loop_location", &Locations::auto_loop_location)
 554                 .addFunction ("auto_punch_location", &Locations::auto_punch_location)
 555                 .addFunction ("session_range_location", &Locations::session_range_location)
 556                 .addFunction ("first_mark_after", &Locations::first_mark_after)
 557                 .addFunction ("first_mark_before", &Locations::first_mark_before)
 558                 .addFunction ("first_mark_at", &Locations::mark_at)
 559                 .addRefFunction ("marks_either_side", &Locations::marks_either_side)
 560                 .addRefFunction ("find_all_between", &Locations::find_all_between)
 561                 .endClass ()
 562
 563                 .beginWSPtrClass <SessionObject> ("SessionObject")
 564                 /* SessionObject is-a PBD::StatefulDestructible,
 565                  * but multiple inheritance is not covered by luabridge,
 566                  * we need explicit casts */
 567                 .addCast<PBD::Stateful> ("to_stateful")
 568                 .addCast<PBD::StatefulDestructible> ("to_statefuldestructible")
 569                 .addFunction ("name", &SessionObject::name)
 570                 .endClass ()
 571
 572                 .beginWSPtrClass <Port> ("Port")
 573                 .addCast<MidiPort> ("to_midiport")
 574                 .addCast<AudioPort> ("to_audioport")
 575                 .addFunction ("name", &Port::name)
 576                 .addFunction ("pretty_name", &Port::pretty_name)
 577                 .addFunction ("receives_input", &Port::receives_input)
 578                 .addFunction ("sends_output", &Port::sends_output)
 579                 .addFunction ("connected", &Port::connected)
 580                 .addFunction ("disconnect_all", &Port::disconnect_all)
 581                 .addFunction ("connected_to_name", (bool (Port::*)(std::string const &)const)&Port::connected_to)
 582                 .addFunction ("connect_by_name", (int (Port::*)(std::string const &))&Port::connect)
 583                 .addFunction ("disconnect_by_name", (int (Port::*)(std::string const &))&Port::disconnect)
 584                 .addFunction ("connected_to", (bool (Port::*)(Port*)const)&Port::connected_to)
 585                 .addFunction ("connect", (int (Port::*)(Port*))&Port::connect)
 586                 .addFunction ("disconnect", (int (Port::*)(Port*))&Port::disconnect)
 587                 //.addStaticFunction ("port_offset", &Port::port_offset) // static
 588                 .endClass ()
 589
 590                 .deriveWSPtrClass <AudioPort, Port> ("AudioPort")
 591                 .endClass ()
 592
 593                 .deriveWSPtrClass <MidiPort, Port> ("MidiPort")
 594                 .addFunction ("input_active", &MidiPort::input_active)
 595                 .addFunction ("set_input_active", &MidiPort::set_input_active)
 596                 .addFunction ("get_midi_buffer", &MidiPort::get_midi_buffer) // DSP only
 597                 .endClass ()
 598
 599                 .beginWSPtrClass <PortSet> ("PortSet")
 600                 .addFunction ("num_ports", (size_t (PortSet::*)(DataType)const)&PortSet::num_ports)
 601                 .addFunction ("add", &PortSet::add)
 602                 .addFunction ("remove", &PortSet::remove)
 603                 .addFunction ("port", (boost::shared_ptr<Port> (PortSet::*)(DataType, size_t)const)&PortSet::port)
 604                 .addFunction ("contains", &PortSet::contains)
 605                 .addFunction ("clear", &PortSet::clear)
 606                 .addFunction ("empty", &PortSet::empty)
 607                 .endClass ()
 608
 609                 .deriveWSPtrClass <IO, SessionObject> ("IO")
 610                 .addFunction ("active", &IO::active)
 611                 .addFunction ("add_port", &IO::add_port)
 612                 .addFunction ("remove_port", &IO::remove_port)
 613                 .addFunction ("connect", &IO::connect)
 614                 .addFunction ("disconnect", (int (IO::*)(boost::shared_ptr<Port>, std::string, void *))&IO::disconnect)
 615                 .addFunction ("physically_connected", &IO::physically_connected)
 616                 .addFunction ("has_port", &IO::has_port)
 617                 .addFunction ("nth", &IO::nth)
 618                 .addFunction ("audio", &IO::audio)
 619                 .addFunction ("midi", &IO::midi)
 620                 .addFunction ("port_by_name", &IO::nth)
 621                 .addFunction ("n_ports", &IO::n_ports)
 622                 .endClass ()
 623
 624                 .beginClass <RouteGroup> ("RouteGroup")
 625                 // stub RouteGroup* is needed for new_audio_track()
 626                 .endClass ()
 627
 628                 .deriveClass <PresentationInfo, PBD::Stateful> ("PresentationInfo")
 629                 .addFunction ("color", &PresentationInfo::color)
 630                 .addFunction ("set_color", &PresentationInfo::set_color)
 631                 .addFunction ("order", &PresentationInfo::order)
 632                 .endClass ()
 633
 634                 .deriveWSPtrClass <Stripable, SessionObject> ("Stripable")
 635                 .addCast<Route> ("to_route")
 636                 .addFunction ("is_auditioner", &Stripable::is_auditioner)
 637                 .addFunction ("is_master", &Stripable::is_master)
 638                 .addFunction ("is_monitor", &Stripable::is_monitor)
 639                 .addFunction ("is_hidden", &Stripable::is_hidden)
 640                 .addFunction ("is_selected", &Stripable::is_selected)
 641                 .addFunction ("gain_control", &Stripable::gain_control)
 642                 .addFunction ("solo_control", &Stripable::solo_control)
 643                 .addFunction ("solo_isolate_control", &Stripable::solo_isolate_control)
 644                 .addFunction ("solo_safe_control", &Stripable::solo_safe_control)
 645                 .addFunction ("mute_control", &Stripable::mute_control)
 646                 .addFunction ("phase_control", &Stripable::phase_control)
 647                 .addFunction ("trim_control", &Stripable::trim_control)
 648                 .addFunction ("rec_enable_control", &Stripable::rec_enable_control)
 649                 .addFunction ("rec_safe_control", &Stripable::rec_safe_control)
 650                 .addFunction ("pan_azimuth_control", &Stripable::pan_azimuth_control)
 651                 .addFunction ("pan_elevation_control", &Stripable::pan_elevation_control)
 652                 .addFunction ("pan_width_control", &Stripable::pan_width_control)
 653                 .addFunction ("pan_frontback_control", &Stripable::pan_frontback_control)
 654                 .addFunction ("pan_lfe_control", &Stripable::pan_lfe_control)
 655                 .addFunction ("send_level_control", &Stripable::send_level_controllable)
 656                 .addFunction ("send_enable_control", &Stripable::send_level_controllable)
 657                 .addFunction ("send_name", &Stripable::send_name)
 658                 .addFunction ("monitor_control", &Stripable::monitor_control)
 659                 .addFunction ("master_send_enable_control ", &Stripable::master_send_enable_controllable )
 660                 .addFunction ("comp_enable_control ", &Stripable::comp_enable_controllable )
 661                 .addFunction ("comp_threshold_control ", &Stripable::comp_threshold_controllable )
 662                 .addFunction ("comp_speed_control ", &Stripable::comp_speed_controllable )
 663                 .addFunction ("comp_mode_control ", &Stripable::comp_mode_controllable )
 664                 .addFunction ("comp_makeup_control ", &Stripable::comp_makeup_controllable )
 665                 .addFunction ("comp_redux_control ", &Stripable::comp_redux_controllable )
 666                 .addFunction ("comp_mode_name", &Stripable::comp_mode_name)
 667                 .addFunction ("comp_speed_name", &Stripable::comp_speed_name)
 668                 .addFunction ("eq_band_cnt ", &Stripable::eq_band_cnt)
 669                 .addFunction ("eq_band_name", &Stripable::eq_band_name)
 670                 .addFunction ("eq_gain_control", &Stripable::eq_gain_controllable)
 671                 .addFunction ("eq_freq_control ", &Stripable::eq_freq_controllable )
 672                 .addFunction ("eq_q_control ", &Stripable::eq_q_controllable )
 673                 .addFunction ("eq_shape_control ", &Stripable::eq_shape_controllable )
 674                 .addFunction ("eq_enable_control ", &Stripable::eq_enable_controllable )
 675                 .addFunction ("eq_hpf_control ", &Stripable::eq_hpf_controllable )
 676                 .addFunction ("set_presentation_order", &Stripable::set_presentation_order)
 677                 .addFunction ("presentation_info_ptr", &Stripable::presentation_info_ptr)
 678
 679                 .endClass ()
 680
 681                 .deriveWSPtrClass <Route, Stripable> ("Route")
 682                 .addCast<Track> ("to_track")
 683                 .addFunction ("set_name", &Route::set_name)
 684                 .addFunction ("comment", &Route::comment)
 685                 .addFunction ("active", &Route::active)
 686                 .addFunction ("set_active", &Route::set_active)
 687                 .addFunction ("nth_plugin", &Route::nth_plugin)
 688                 .addFunction ("nth_processor", &Route::nth_processor)
 689                 .addFunction ("nth_send", &Route::nth_send)
 690                 .addFunction ("add_processor_by_index", &Route::add_processor_by_index)
 691                 .addFunction ("remove_processor", &Route::remove_processor)
 692                 .addFunction ("replace_processor", &Route::replace_processor)
 693                 .addFunction ("n_inputs", &Route::n_inputs)
 694                 .addFunction ("n_outputs", &Route::n_outputs)
 695                 .addFunction ("set_comment", &Route::set_comment)
 696                 .addFunction ("strict_io", &Route::strict_io)
 697                 .addFunction ("set_strict_io", &Route::set_strict_io)
 698                 .addFunction ("reset_plugin_insert", &Route::reset_plugin_insert)
 699                 .addFunction ("customize_plugin_insert", &Route::customize_plugin_insert)
 700                 .addFunction ("add_sidechain", &Route::add_sidechain)
 701                 .addFunction ("remove_sidechain", &Route::remove_sidechain)
 702                 .addFunction ("main_outs", &Route::main_outs)
 703                 .addFunction ("muted", &Route::muted)
 704                 .addFunction ("soloed", &Route::soloed)
 705                 .addFunction ("amp", &Route::amp)
 706                 .addFunction ("trim", &Route::trim)
 707                 .endClass ()
 708
 709                 .deriveWSPtrClass <Playlist, SessionObject> ("Playlist")
 710                 .addFunction ("region_by_id", &Playlist::region_by_id)
 711                 .addFunction ("data_type", &Playlist::data_type)
 712                 .addFunction ("n_regions", &Playlist::n_regions)
 713                 //.addFunction ("get_extent", &Playlist::get_extent) // pair<framepos_t, framepos_t>
 714                 .addFunction ("region_list", &Playlist::region_list)
 715                 .addFunction ("add_region", &Playlist::add_region)
 716                 .addFunction ("remove_region", &Playlist::remove_region)
 717                 .addFunction ("regions_at", &Playlist::regions_at)
 718                 .addFunction ("top_region_at", &Playlist::top_region_at)
 719                 .addFunction ("top_unmuted_region_at", &Playlist::top_unmuted_region_at)
 720                 .addFunction ("find_next_region", &Playlist::find_next_region)
 721                 .addFunction ("find_next_region_boundary", &Playlist::find_next_region_boundary)
 722                 .addFunction ("count_regions_at", &Playlist::count_regions_at)
 723                 .addFunction ("regions_touched", &Playlist::regions_touched)
 724                 .addFunction ("regions_with_start_within", &Playlist::regions_with_start_within)
 725                 .addFunction ("regions_with_end_within", &Playlist::regions_with_end_within)
 726                 .addFunction ("raise_region", &Playlist::raise_region)
 727                 .addFunction ("lower_region", &Playlist::lower_region)
 728                 .addFunction ("raise_region_to_top", &Playlist::raise_region_to_top)
 729                 .addFunction ("lower_region_to_bottom", &Playlist::lower_region_to_bottom)
 730                 .addFunction ("duplicate", (void (Playlist::*)(boost::shared_ptr<Region>, framepos_t, framecnt_t, float))&Playlist::duplicate)
 731                 .addFunction ("duplicate_until", &Playlist::duplicate_until)
 732                 .addFunction ("duplicate_range", &Playlist::duplicate_range)
 733                 .addFunction ("combine", &Playlist::combine)
 734                 .addFunction ("uncombine", &Playlist::uncombine)
 735                 .addFunction ("split_region", &Playlist::split_region)
 736                 .addFunction ("split", (void (Playlist::*)(framepos_t))&Playlist::split)
 737                 .addFunction ("cut", (boost::shared_ptr<Playlist> (Playlist::*)(std::list<AudioRange>&, bool))&Playlist::cut)
 738 #if 0
 739                 .addFunction ("copy", &Playlist::copy)
 740                 .addFunction ("paste", &Playlist::paste)
 741 #endif
 742                 .endClass ()
 743
 744                 .deriveWSPtrClass <Track, Route> ("Track")
 745                 .addCast<AudioTrack> ("to_audio_track")
 746                 .addCast<MidiTrack> ("to_midi_track")
 747                 .addFunction ("set_name", &Track::set_name)
 748                 .addFunction ("can_record", &Track::can_record)
 749                 .addFunction ("bounceable", &Track::bounceable)
 750                 .addFunction ("bounce", &Track::bounce)
 751                 .addFunction ("bounce_range", &Track::bounce_range)
 752                 .addFunction ("playlist", &Track::playlist)
 753                 .endClass ()
 754
 755                 .deriveWSPtrClass <AudioTrack, Track> ("AudioTrack")
 756                 .endClass ()
 757
 758                 .deriveWSPtrClass <MidiTrack, Track> ("MidiTrack")
 759                 .endClass ()
 760
 761                 .deriveWSPtrClass <Region, SessionObject> ("Region")
 762                 /* properties */
 763                 .addFunction ("position", &Region::position)
 764                 .addFunction ("start", &Region::start)
 765                 .addFunction ("length", &Region::length)
 766                 .addFunction ("layer", &Region::layer)
 767                 .addFunction ("data_type", &Region::data_type)
 768                 .addFunction ("stretch", &Region::stretch)
 769                 .addFunction ("shift", &Region::shift)
 770                 .addRefFunction ("sync_offset", &Region::sync_offset)
 771                 .addFunction ("sync_position", &Region::sync_position)
 772                 .addFunction ("hidden", &Region::hidden)
 773                 .addFunction ("muted", &Region::muted)
 774                 .addFunction ("opaque", &Region::opaque)
 775                 .addFunction ("locked", &Region::locked)
 776                 .addFunction ("position_locked", &Region::position_locked)
 777                 .addFunction ("video_locked", &Region::video_locked)
 778                 .addFunction ("automatic", &Region::automatic)
 779                 .addFunction ("whole_file", &Region::whole_file)
 780                 .addFunction ("captured", &Region::captured)
 781                 .addFunction ("can_move", &Region::can_move)
 782                 .addFunction ("sync_marked", &Region::sync_marked)
 783                 .addFunction ("external", &Region::external)
 784                 .addFunction ("import", &Region::import)
 785                 .addFunction ("covers", &Region::covers)
 786                 .addFunction ("at_natural_position", &Region::at_natural_position)
 787                 .addFunction ("is_compound", &Region::is_compound)
 788                 /* editing operations */
 789                 .addFunction ("set_length", &Region::set_length)
 790                 .addFunction ("set_start", &Region::set_start)
 791                 .addFunction ("set_position", &Region::set_position)
 792                 .addFunction ("set_initial_position", &Region::set_initial_position)
 793                 .addFunction ("nudge_position", &Region::nudge_position)
 794                 .addFunction ("move_to_natural_position", &Region::move_to_natural_position)
 795                 .addFunction ("move_start", &Region::move_start)
 796                 .addFunction ("trim_front", &Region::trim_front)
 797                 .addFunction ("trim_end", &Region::trim_end)
 798                 .addFunction ("trim_to", &Region::trim_to)
 799                 .addFunction ("cut_front", &Region::cut_front)
 800                 .addFunction ("cut_end", &Region::cut_end)
 801                 .addFunction ("raise", &Region::raise)
 802                 .addFunction ("lower", &Region::lower)
 803                 .addFunction ("raise_to_top", &Region::raise_to_top)
 804                 .addFunction ("lower_to_bottom", &Region::lower_to_bottom)
 805                 .addFunction ("set_sync_position", &Region::set_sync_position)
 806                 .addFunction ("clear_sync_position", &Region::clear_sync_position)
 807                 .addFunction ("set_hidden", &Region::set_hidden)
 808                 .addFunction ("set_muted", &Region::set_muted)
 809                 .addFunction ("set_opaque", &Region::set_opaque)
 810                 .addFunction ("set_locked", &Region::set_locked)
 811                 .addFunction ("set_video_locked", &Region::set_video_locked)
 812                 .addFunction ("set_position_locked", &Region::set_position_locked)
 813                 .endClass ()
 814
 815                 .beginWSPtrClass <Source> ("Source")
 816                 .endClass ()
 817
 818                 .beginClass <Plugin::PresetRecord> ("PresetRecord")
 819                 .addVoidConstructor ()
 820                 .addData ("uri", &Plugin::PresetRecord::uri, false)
 821                 .addData ("label", &Plugin::PresetRecord::label, false)
 822                 .addData ("user", &Plugin::PresetRecord::user, false)
 823                 .addData ("valid", &Plugin::PresetRecord::valid, false)
 824                 .endClass ()
 825
 826                 .beginStdVector <Plugin::PresetRecord> ("PresetVector").endClass ()
 827
 828                 .deriveWSPtrClass <Automatable, Evoral::ControlSet> ("Automatable")
 829                 .addFunction ("automation_control", (boost::shared_ptr<AutomationControl>(Automatable::*)(const Evoral::Parameter&, bool))&Automatable::automation_control)
 830                 .endClass ()
 831
 832                 .deriveClass <ParameterDescriptor, Evoral::ParameterDescriptor> ("ParameterDescriptor")
 833                 .addVoidConstructor ()
 834                 .addData ("label", &ParameterDescriptor::label)
 835                 .addData ("logarithmic", &ParameterDescriptor::logarithmic)
 836                 .addStaticFunction ("midi_note_name", &ParameterDescriptor::midi_note_name)
 837                 .endClass ()
 838
 839                 .beginStdVector <boost::shared_ptr<ARDOUR::Processor> > ("ProcessorVector").endClass ()
 840
 841                 .deriveWSPtrClass <Processor, SessionObject> ("Processor")
 842                 .addCast<Automatable> ("to_automatable")
 843                 .addCast<PluginInsert> ("to_insert")
 844                 .addCast<SideChain> ("to_sidechain")
 845                 .addCast<IOProcessor> ("to_ioprocessor")
 846                 .addCast<UnknownProcessor> ("to_unknownprocessor")
 847                 .addCast<Amp> ("to_amp")
 848                 .addCast<MonitorProcessor> ("to_monitorprocessor")
 849 #if 0 // those objects are not yet bound
 850                 .addCast<CapturingProcessor> ("to_capturingprocessor")
 851                 .addCast<DelayLine> ("to_delayline")
 852                 .addCast<PeakMeter> ("to_meter")
 853 #endif
 854                 .addFunction ("display_name", &Processor::display_name)
 855                 .addFunction ("active", &Processor::active)
 856                 .addFunction ("activate", &Processor::activate)
 857                 .addFunction ("deactivate", &Processor::deactivate)
 858                 .endClass ()
 859
 860                 .deriveWSPtrClass <IOProcessor, Processor> ("IOProcessor")
 861                 .addFunction ("natural_input_streams", &IOProcessor::natural_input_streams)
 862                 .addFunction ("natural_output_streams", &IOProcessor::natural_output_streams)
 863                 .addFunction ("input", (boost::shared_ptr<IO>(IOProcessor::*)())&IOProcessor::input)
 864                 .addFunction ("output", (boost::shared_ptr<IO>(IOProcessor::*)())&IOProcessor::output)
 865                 .endClass ()
 866
 867                 .deriveWSPtrClass <SideChain, IOProcessor> ("SideChain")
 868                 .endClass ()
 869
 870                 .deriveWSPtrClass <Delivery, IOProcessor> ("Delivery")
 871                 .endClass ()
 872
 873                 .deriveWSPtrClass <Plugin, PBD::StatefulDestructible> ("Plugin")
 874                 .addFunction ("label", &Plugin::label)
 875                 .addFunction ("name", &Plugin::name)
 876                 .addFunction ("maker", &Plugin::maker)
 877                 .addFunction ("parameter_count", &Plugin::parameter_count)
 878                 .addRefFunction ("nth_parameter", &Plugin::nth_parameter)
 879                 .addFunction ("preset_by_label", &Plugin::preset_by_label)
 880                 .addFunction ("preset_by_uri", &Plugin::preset_by_uri)
 881                 .addFunction ("load_preset", &Plugin::load_preset)
 882                 .addFunction ("parameter_is_input", &Plugin::parameter_is_input)
 883                 .addFunction ("get_docs", &Plugin::get_docs)
 884                 .addFunction ("get_info", &Plugin::get_info)
 885                 .addFunction ("get_parameter_docs", &Plugin::get_parameter_docs)
 886                 .addRefFunction ("get_parameter_descriptor", &Plugin::get_parameter_descriptor)
 887                 .endClass ()
 888
 889                 .deriveWSPtrClass <PluginInsert, Processor> ("PluginInsert")
 890                 .addFunction ("plugin", &PluginInsert::plugin)
 891                 .addFunction ("activate", &PluginInsert::activate)
 892                 .addFunction ("deactivate", &PluginInsert::deactivate)
 893                 .addFunction ("strict_io_configured", &PluginInsert::strict_io_configured)
 894                 .addFunction ("input_map", (ARDOUR::ChanMapping (PluginInsert::*)(uint32_t) const)&PluginInsert::input_map)
 895                 .addFunction ("output_map", (ARDOUR::ChanMapping (PluginInsert::*)(uint32_t) const)&PluginInsert::output_map)
 896                 .addFunction ("set_input_map", &PluginInsert::set_input_map)
 897                 .addFunction ("set_output_map", &PluginInsert::set_output_map)
 898                 .addFunction ("sidechain_input", &PluginInsert::sidechain_input)
 899                 .endClass ()
 900
 901                 .deriveWSPtrClass <AutomationControl, PBD::Controllable> ("AutomationControl")
 902                 .addCast<Evoral::Control> ("to_ctrl")
 903                 .addFunction ("automation_state", &AutomationControl::automation_state)
 904                 .addFunction ("automation_style", &AutomationControl::automation_style)
 905                 .addFunction ("set_automation_state", &AutomationControl::set_automation_state)
 906                 .addFunction ("set_automation_style", &AutomationControl::set_automation_style)
 907                 .addFunction ("start_touch", &AutomationControl::start_touch)
 908                 .addFunction ("stop_touch", &AutomationControl::stop_touch)
 909                 .addFunction ("get_value", &AutomationControl::get_value)
 910                 .addFunction ("set_value", &AutomationControl::set_value)
 911                 .addFunction ("writable", &AutomationControl::writable)
 912                 .addFunction ("alist", &AutomationControl::alist)
 913                 .endClass ()
 914
 915                 .deriveWSPtrClass <SlavableAutomationControl, AutomationControl> ("SlavableAutomationControl,")
 916                 .addFunction ("add_master", &SlavableAutomationControl::add_master)
 917                 .addFunction ("remove_master", &SlavableAutomationControl::remove_master)
 918                 .addFunction ("clear_masters", &SlavableAutomationControl::clear_masters)
 919                 .addFunction ("slaved_to", &SlavableAutomationControl::slaved_to)
 920                 .addFunction ("slaved", &SlavableAutomationControl::slaved)
 921                 .addFunction ("get_masters_value", &SlavableAutomationControl::get_masters_value)
 922                 .addFunction ("get_boolean_masters", &SlavableAutomationControl::get_boolean_masters)
 923                 //.addFunction ("masters", &SlavableAutomationControl::masters) // not implemented
 924                 .endClass ()
 925
 926                 .deriveWSPtrClass <PhaseControl, AutomationControl> ("PhaseControl")
 927                 .addFunction ("set_phase_invert", (void(PhaseControl::*)(uint32_t, bool))&PhaseControl::set_phase_invert)
 928                 .addFunction ("inverted", &PhaseControl::inverted)
 929                 .endClass ()
 930
 931                 .deriveWSPtrClass <GainControl, SlavableAutomationControl> ("GainControl")
 932                 .endClass ()
 933
 934                 .deriveWSPtrClass <SoloControl, SlavableAutomationControl> ("SoloControl")
 935                 .addFunction ("can_solo", &SoloControl::can_solo)
 936                 .addFunction ("soloed", &SoloControl::soloed)
 937                 .addFunction ("self_soloed", &SoloControl::self_soloed)
 938                 .endClass ()
 939
 940                 .deriveWSPtrClass <MuteControl, SlavableAutomationControl> ("MuteControl")
 941                 .addFunction ("muted", &MuteControl::muted)
 942                 .addFunction ("muted_by_self", &MuteControl::muted_by_self)
 943                 .endClass ()
 944
 945                 .deriveWSPtrClass <SoloIsolateControl, SlavableAutomationControl> ("SoloIsolateControl")
 946                 .addFunction ("solo_isolated", &SoloIsolateControl::solo_isolated)
 947                 .addFunction ("self_solo_isolated", &SoloIsolateControl::self_solo_isolated)
 948                 .endClass ()
 949
 950                 .deriveWSPtrClass <SoloSafeControl, SlavableAutomationControl> ("SoloSafeControl")
 951                 .addFunction ("solo_safe", &SoloSafeControl::solo_safe)
 952                 .endClass ()
 953
 954                 .deriveWSPtrClass <Amp, Processor> ("Amp")
 955                 .addFunction ("gain_control", (boost::shared_ptr<GainControl>(Amp::*)())&Amp::gain_control)
 956                 .endClass ()
 957
 958                 .deriveWSPtrClass <MonitorProcessor, Processor> ("MonitorProcessor")
 959                 .addFunction ("set_cut_all", &MonitorProcessor::set_cut_all)
 960                 .addFunction ("set_dim_all", &MonitorProcessor::set_dim_all)
 961                 .addFunction ("set_polarity", &MonitorProcessor::set_polarity)
 962                 .addFunction ("set_cut", &MonitorProcessor::set_cut)
 963                 .addFunction ("set_dim", &MonitorProcessor::set_dim)
 964                 .addFunction ("set_solo", &MonitorProcessor::set_solo)
 965                 .addFunction ("set_mono", &MonitorProcessor::set_mono)
 966                 .addFunction ("dim_level", &MonitorProcessor::dim_level)
 967                 .addFunction ("solo_boost_level", &MonitorProcessor::solo_boost_level)
 968                 .addFunction ("dimmed", &MonitorProcessor::dimmed)
 969                 .addFunction ("soloed", &MonitorProcessor::soloed)
 970                 .addFunction ("inverted", &MonitorProcessor::inverted)
 971                 .addFunction ("cut", &MonitorProcessor::cut)
 972                 .addFunction ("cut_all", &MonitorProcessor::cut_all)
 973                 .addFunction ("dim_all", &MonitorProcessor::dim_all)
 974                 .addFunction ("mono", &MonitorProcessor::mono)
 975                 .addFunction ("monitor_active", &MonitorProcessor::monitor_active)
 976                 .addFunction ("channel_cut_control", &MonitorProcessor::channel_cut_control)
 977                 .addFunction ("channel_dim_control", &MonitorProcessor::channel_dim_control)
 978                 .addFunction ("channel_polarity_control", &MonitorProcessor::channel_polarity_control)
 979                 .addFunction ("channel_solo_control", &MonitorProcessor::channel_solo_control)
 980                 .addFunction ("dim_control", &MonitorProcessor::dim_control)
 981                 .addFunction ("cut_control", &MonitorProcessor::cut_control)
 982                 .addFunction ("mono_control", &MonitorProcessor::mono_control)
 983                 .addFunction ("dim_level_control", &MonitorProcessor::dim_level_control)
 984                 .addFunction ("solo_boost_control", &MonitorProcessor::solo_boost_control)
 985                 .endClass ()
 986
 987                 .deriveWSPtrClass <UnknownProcessor, Processor> ("UnknownProcessor")
 988                 .endClass ()
 989
 990                 .deriveWSPtrClass <PluginInsert::PluginControl, AutomationControl> ("PluginControl")
 991                 .endClass ()
 992
 993                 .deriveWSPtrClass <AudioSource, Source> ("AudioSource")
 994                 .addFunction ("readable_length", &AudioSource::readable_length)
 995                 .addFunction ("n_channels", &AudioSource::n_channels)
 996                 .endClass ()
 997
 998                 // <std::list<boost::shared_ptr <AudioTrack> >
 999                 .beginStdList <boost::shared_ptr<AudioTrack> > ("AudioTrackList")
1000                 .endClass ()
1001
1002                 // std::list<boost::shared_ptr <MidiTrack> >
1003                 .beginStdList <boost::shared_ptr<MidiTrack> > ("MidiTrackList")
1004                 .endClass ()
1005
1006                 // RouteList == std::list<boost::shared_ptr<Route> >
1007                 .beginConstStdList <boost::shared_ptr<Route> > ("RouteList")
1008                 .endClass ()
1009
1010                 // boost::shared_ptr<RouteList>
1011                 .beginPtrStdList <boost::shared_ptr<Route> > ("RouteListPtr")
1012                 .endClass ()
1013
1014                 // typedef std::list<boost::weak_ptr <Route> > WeakRouteList
1015                 .beginConstStdList <boost::weak_ptr<Route> > ("WeakRouteList")
1016                 .endClass ()
1017
1018                 // std::list< boost::weak_ptr <AudioSource> >
1019                 .beginConstStdList <boost::weak_ptr<AudioSource> > ("WeakAudioSourceList")
1020                 .endClass ()
1021
1022                 // typedef std::list<boost::shared_ptr<Region> > RegionList
1023                 .beginConstStdList <boost::shared_ptr<Region> > ("RegionList")
1024                 .endClass ()
1025
1026                 // boost::shared_ptr <std::list<boost::shared_ptr<Region> > >
1027                 .beginPtrStdList <boost::shared_ptr<Region> > ("RegionListPtr")
1028                 .endClass ()
1029
1030                 //std::list<boost::shared_ptr<Port> > PortList;
1031                 .beginConstStdList <boost::shared_ptr<Port> > ("PortList")
1032                 .endClass ()
1033
1034                 // used by Playlist::cut/copy
1035                 .beginConstStdList <AudioRange> ("AudioRangeList")
1036                 .endClass ()
1037
1038                 .beginConstStdList <Location*> ("LocationList")
1039                 .endClass ()
1040
1041 #if 0  // depends on Evoal:: Note, Beats see note_fixer.h
1042         // typedef Evoral::Note<Evoral::Beats> Note;
1043         // std::set< boost::weak_ptr<Note> >
1044                 .beginStdSet <boost::weak_ptr<Note> > ("WeakNoteSet")
1045                 .endClass ()
1046 #endif
1047
1048         // std::list<boost::weak_ptr<Source> >
1049                 .beginConstStdList <boost::weak_ptr<Source> > ("WeakSourceList")
1050                 .endClass ()
1051
1052                 .beginClass <Tempo> ("Tempo")
1053                 .addConstructor <void (*) (double, double)> ()
1054                 .addFunction ("note_type", &Tempo::note_type)
1055                 .addFunction ("beats_per_minute", &Tempo::beats_per_minute)
1056                 .addFunction ("frames_per_beat", &Tempo::frames_per_beat)
1057                 .endClass ()
1058
1059                 .beginClass <Meter> ("Meter")
1060                 .addConstructor <void (*) (double, double)> ()
1061                 .addFunction ("divisions_per_bar", &Meter::divisions_per_bar)
1062                 .addFunction ("note_divisor", &Meter::note_divisor)
1063                 .addFunction ("frames_per_bar", &Meter::frames_per_bar)
1064                 .addFunction ("frames_per_grid", &Meter::frames_per_grid)
1065                 .endClass ()
1066
1067                 .beginClass <TempoMap> ("TempoMap")
1068                 .addFunction ("add_tempo", &TempoMap::add_tempo)
1069                 .addFunction ("add_meter", &TempoMap::add_meter)
1070                 .addFunction ("tempo_section_at_frame", &TempoMap::tempo_section_at_frame)
1071                 .addFunction ("meter_section_at_frame", &TempoMap::meter_section_at_frame)
1072                 .addFunction ("meter_section_at_beat", &TempoMap::meter_section_at_beat)
1073                 .endClass ()
1074
1075                 .beginClass <MetricSection> ("MetricSection")
1076                 .addFunction ("pulse", &MetricSection::pulse)
1077                 .addFunction ("set_pulse", &MetricSection::set_pulse)
1078                 .endClass ()
1079
1080                 .deriveClass <TempoSection, MetricSection> ("TempoSection")
1081                 .addFunction ("c_func", (double(TempoSection::*)()const)&TempoSection::c_func)
1082                 .endClass ()
1083
1084                 .deriveClass <MeterSection, MetricSection> ("MeterSection")
1085                 .addCast<Meter> ("to_meter")
1086                 .addFunction ("set_pulse", &MeterSection::set_pulse)
1087                 .addFunction ("set_beat", (void(MeterSection::*)(double))&MeterSection::set_beat)
1088                 .endClass ()
1089
1090                 .beginClass <ChanCount> ("ChanCount")
1091                 .addConstructor <void (*) (DataType, uint32_t)> ()
1092                 .addFunction ("get", &ChanCount::get)
1093                 .addFunction ("set", &ChanCount::set)
1094                 .addFunction ("n_audio", &ChanCount::n_audio)
1095                 .addFunction ("n_midi", &ChanCount::n_midi)
1096                 .addFunction ("n_total", &ChanCount::n_total)
1097                 .addFunction ("reset", &ChanCount::reset)
1098                 .endClass()
1099
1100                 .beginClass <DataType> ("DataType")
1101                 .addConstructor <void (*) (std::string)> ()
1102                 .addStaticCFunction ("null",  &LuaAPI::datatype_ctor_null) // "nil" is a lua reseved word
1103                 .addStaticCFunction ("audio", &LuaAPI::datatype_ctor_audio)
1104                 .addStaticCFunction ("midi",  &LuaAPI::datatype_ctor_midi)
1105                 .addFunction ("to_string",  &DataType::to_string) // TODO Lua __tostring
1106                 // TODO add uint32_t cast, add operator==  !=
1107                 .endClass()
1108
1109                 /* libardour enums */
1110                 .beginNamespace ("PluginType")
1111                 .addConst ("AudioUnit", ARDOUR::PluginType(AudioUnit))
1112                 .addConst ("LADSPA", ARDOUR::PluginType(LADSPA))
1113                 .addConst ("LV2", ARDOUR::PluginType(LV2))
1114                 .addConst ("Windows_VST", ARDOUR::PluginType(Windows_VST))
1115                 .addConst ("LXVST", ARDOUR::PluginType(LXVST))
1116                 .addConst ("Lua", ARDOUR::PluginType(Lua))
1117                 .endNamespace ()
1118
1119                 .beginNamespace ("PresentationInfo")
1120                 .beginNamespace ("Flag")
1121                 .addConst ("AudioTrack", ARDOUR::PresentationInfo::Flag(PresentationInfo::AudioTrack))
1122                 .addConst ("MidiTrack", ARDOUR::PresentationInfo::Flag(PresentationInfo::MidiTrack))
1123                 .addConst ("AudioBus", ARDOUR::PresentationInfo::Flag(PresentationInfo::AudioBus))
1124                 .addConst ("MidiBus", ARDOUR::PresentationInfo::Flag(PresentationInfo::MidiBus))
1125                 .addConst ("VCA", ARDOUR::PresentationInfo::Flag(PresentationInfo::VCA))
1126                 .addConst ("MasterOut", ARDOUR::PresentationInfo::Flag(PresentationInfo::MasterOut))
1127                 .addConst ("MonitorOut", ARDOUR::PresentationInfo::Flag(PresentationInfo::MonitorOut))
1128                 .addConst ("Auditioner", ARDOUR::PresentationInfo::Flag(PresentationInfo::Auditioner))
1129                 .addConst ("Selected", ARDOUR::PresentationInfo::Flag(PresentationInfo::Selected))
1130                 .addConst ("Hidden", ARDOUR::PresentationInfo::Flag(PresentationInfo::Hidden))
1131                 .addConst ("GroupOrderSet", ARDOUR::PresentationInfo::Flag(PresentationInfo::OrderSet))
1132                 .addConst ("StatusMask", ARDOUR::PresentationInfo::Flag(PresentationInfo::StatusMask))
1133                 .endNamespace ()
1134                 .endNamespace ()
1135
1136                 .beginNamespace ("AutoStyle")
1137                 .addConst ("Absolute", ARDOUR::AutoStyle(Absolute))
1138                 .addConst ("Trim", ARDOUR::AutoStyle(Trim))
1139                 .endNamespace ()
1140
1141                 .beginNamespace ("AutoState")
1142                 .addConst ("Off", ARDOUR::AutoState(Off))
1143                 .addConst ("Write", ARDOUR::AutoState(Write))
1144                 .addConst ("Touch", ARDOUR::AutoState(Touch))
1145                 .addConst ("Play", ARDOUR::AutoState(Play))
1146                 .endNamespace ()
1147
1148                 .beginNamespace ("AutomationType")
1149                 .addConst ("GainAutomation", ARDOUR::AutomationType(GainAutomation))
1150                 .addConst ("PluginAutomation", ARDOUR::AutomationType(PluginAutomation))
1151                 .addConst ("SoloAutomation", ARDOUR::AutomationType(SoloAutomation))
1152                 .addConst ("SoloIsolateAutomation", ARDOUR::AutomationType(SoloIsolateAutomation))
1153                 .addConst ("SoloSafeAutomation", ARDOUR::AutomationType(SoloSafeAutomation))
1154                 .addConst ("MuteAutomation", ARDOUR::AutomationType(MuteAutomation))
1155                 .addConst ("RecEnableAutomation", ARDOUR::AutomationType(RecEnableAutomation))
1156                 .addConst ("RecSafeAutomation", ARDOUR::AutomationType(RecSafeAutomation))
1157                 .addConst ("TrimAutomation", ARDOUR::AutomationType(TrimAutomation))
1158                 .addConst ("PhaseAutomation", ARDOUR::AutomationType(PhaseAutomation))
1159                 .endNamespace ()
1160
1161                 .beginNamespace ("SrcQuality")
1162                 .addConst ("SrcBest", ARDOUR::SrcQuality(SrcBest))
1163                 .endNamespace ()
1164
1165                 .beginNamespace ("PortFlags")
1166                 .addConst ("IsInput", ARDOUR::PortFlags(IsInput))
1167                 .addConst ("IsOutput", ARDOUR::PortFlags(IsOutput))
1168                 .addConst ("IsPhysical", ARDOUR::PortFlags(IsPhysical))
1169                 .addConst ("CanMonitor", ARDOUR::PortFlags(CanMonitor))
1170                 .addConst ("IsTerminal", ARDOUR::PortFlags(IsTerminal))
1171                 .endNamespace ()
1172
1173                 .beginNamespace ("PlaylistDisposition")
1174                 .addConst ("CopyPlaylist", ARDOUR::PlaylistDisposition(CopyPlaylist))
1175                 .addConst ("NewPlaylist", ARDOUR::PlaylistDisposition(NewPlaylist))
1176                 .addConst ("SharePlaylist", ARDOUR::PlaylistDisposition(SharePlaylist))
1177                 .endNamespace ()
1178
1179                 .beginNamespace ("RegionPoint")
1180                 .addConst ("Start", ARDOUR::RegionPoint(Start))
1181                 .addConst ("End", ARDOUR::RegionPoint(End))
1182                 .addConst ("SyncPoint", ARDOUR::RegionPoint(SyncPoint))
1183                 .endNamespace ()
1184
1185                 .beginNamespace ("TempoSection")
1186                 .beginNamespace ("PositionLockStyle")
1187                 .addConst ("AudioTime", ARDOUR::PositionLockStyle(AudioTime))
1188                 .addConst ("MusicTime", ARDOUR::PositionLockStyle(MusicTime))
1189                 .endNamespace ()
1190                 .endNamespace ()
1191
1192                 .beginNamespace ("TempoSection")
1193                 .beginNamespace ("Type")
1194                 .addConst ("Ramp", ARDOUR::TempoSection::Type(TempoSection::Ramp))
1195                 .addConst ("Constant", ARDOUR::TempoSection::Type(TempoSection::Constant))
1196                 .endNamespace ()
1197                 .endNamespace ()
1198
1199                 .beginNamespace ("TrackMode")
1200                 .addConst ("Normal", ARDOUR::TrackMode(Start))
1201                 .addConst ("NonLayered", ARDOUR::TrackMode(NonLayered))
1202                 .addConst ("Destructive", ARDOUR::TrackMode(Destructive))
1203                 .endNamespace ()
1204
1205                 .beginNamespace ("SampleFormat")
1206                 .addConst ("Float", ARDOUR::SampleFormat(FormatFloat))
1207                 .addConst ("Int24", ARDOUR::SampleFormat(FormatInt24))
1208                 .addConst ("Int16", ARDOUR::SampleFormat(FormatInt16))
1209                 .endNamespace ()
1210
1211                 .beginNamespace ("HeaderFormat")
1212                 .addConst ("BWF", ARDOUR::HeaderFormat(BWF))
1213                 .addConst ("WAVE", ARDOUR::HeaderFormat(WAVE))
1214                 .addConst ("WAVE64", ARDOUR::HeaderFormat(WAVE64))
1215                 .addConst ("CAF", ARDOUR::HeaderFormat(CAF))
1216                 .addConst ("AIFF", ARDOUR::HeaderFormat(AIFF))
1217                 .addConst ("iXML", ARDOUR::HeaderFormat(iXML))
1218                 .addConst ("RF64", ARDOUR::HeaderFormat(RF64))
1219                 .addConst ("RF64_WAV", ARDOUR::HeaderFormat(RF64_WAV))
1220                 .addConst ("MBWF", ARDOUR::HeaderFormat(MBWF))
1221                 .endNamespace ()
1222
1223                 .beginNamespace ("InsertMergePolicy")
1224                 .addConst ("Reject", ARDOUR::InsertMergePolicy(InsertMergeReject))
1225                 .addConst ("Relax", ARDOUR::InsertMergePolicy(InsertMergeRelax))
1226                 .addConst ("Replace", ARDOUR::InsertMergePolicy(InsertMergeReplace))
1227                 .addConst ("TruncateExisting", ARDOUR::InsertMergePolicy(InsertMergeTruncateExisting))
1228                 .addConst ("TruncateAddition", ARDOUR::InsertMergePolicy(InsertMergeTruncateAddition))
1229                 .addConst ("Extend", ARDOUR::InsertMergePolicy(InsertMergeExtend))
1230                 .endNamespace ()
1231
1232                 .endNamespace (); // end ARDOUR
1233
1234         luabridge::getGlobalNamespace (L)
1235                 .beginNamespace ("ARDOUR")
1236                 .beginClass <AudioBackendInfo> ("AudioBackendInfo")
1237                 .addData ("name", &AudioBackendInfo::name)
1238                 .endClass()
1239                 .beginStdVector <const AudioBackendInfo*> ("BackendVector").endClass ()
1240
1241                 .beginClass <AudioBackend::DeviceStatus> ("DeviceStatus")
1242                 .addData ("name", &AudioBackend::DeviceStatus::name)
1243                 .addData ("available", &AudioBackend::DeviceStatus::available)
1244                 .endClass()
1245                 .beginStdVector <AudioBackend::DeviceStatus> ("DeviceStatusVector").endClass ()
1246
1247                 .beginWSPtrClass <AudioBackend> ("AudioBackend")
1248                 .addFunction ("info", &AudioBackend::info)
1249                 .addFunction ("sample_rate", &AudioBackend::sample_rate)
1250                 .addFunction ("buffer_size", &AudioBackend::buffer_size)
1251                 .addFunction ("period_size", &AudioBackend::period_size)
1252                 .addFunction ("input_channels", &AudioBackend::input_channels)
1253                 .addFunction ("output_channels", &AudioBackend::output_channels)
1254                 .addFunction ("dsp_load", &AudioBackend::dsp_load)
1255
1256                 .addFunction ("set_sample_rate", &AudioBackend::set_sample_rate)
1257                 .addFunction ("set_buffer_size", &AudioBackend::set_buffer_size)
1258                 .addFunction ("set_peridod_size", &AudioBackend::set_peridod_size)
1259
1260                 .addFunction ("enumerate_drivers", &AudioBackend::enumerate_drivers)
1261                 .addFunction ("driver_name", &AudioBackend::driver_name)
1262                 .addFunction ("set_driver", &AudioBackend::set_driver)
1263
1264                 .addFunction ("use_separate_input_and_output_devices", &AudioBackend::use_separate_input_and_output_devices)
1265                 .addFunction ("enumerate_devices", &AudioBackend::enumerate_devices)
1266                 .addFunction ("enumerate_input_devices", &AudioBackend::enumerate_input_devices)
1267                 .addFunction ("enumerate_output_devices", &AudioBackend::enumerate_output_devices)
1268                 .addFunction ("device_name", &AudioBackend::device_name)
1269                 .addFunction ("input_device_name", &AudioBackend::input_device_name)
1270                 .addFunction ("output_device_name", &AudioBackend::output_device_name)
1271                 .addFunction ("set_device_name", &AudioBackend::set_device_name)
1272                 .addFunction ("set_input_device_name", &AudioBackend::set_input_device_name)
1273                 .addFunction ("set_output_device_name", &AudioBackend::set_output_device_name)
1274                 .endClass()
1275
1276                 .beginClass <PortEngine> ("PortEngine")
1277                 .endClass()
1278
1279                 .beginClass <PortManager> ("PortManager")
1280                 .addFunction ("port_engine", &PortManager::port_engine)
1281                 .addFunction ("connected", &PortManager::connected)
1282                 .addFunction ("connect", &PortManager::connect)
1283                 .addFunction ("physically_connected", &PortManager::physically_connected)
1284                 .addFunction ("disconnect", (int (PortManager::*)(const std::string&, const std::string&))&PortManager::disconnect)
1285                 .addFunction ("disconnect_port", (int (PortManager::*)(boost::shared_ptr<Port>))&PortManager::disconnect)
1286                 .addFunction ("get_port_by_name", &PortManager::get_port_by_name)
1287                 .addFunction ("get_pretty_name_by_name", &PortManager::get_pretty_name_by_name)
1288                 .addFunction ("port_is_physical", &PortManager::port_is_physical)
1289                 .addFunction ("get_physical_outputs", &PortManager::get_physical_outputs)
1290                 .addFunction ("get_physical_inputs", &PortManager::get_physical_inputs)
1291                 .addFunction ("n_physical_outputs", &PortManager::n_physical_outputs)
1292                 .addFunction ("n_physical_inputs", &PortManager::n_physical_inputs)
1293                 .addRefFunction ("get_connections", &PortManager::get_connections)
1294                 .addRefFunction ("get_ports", (int (PortManager::*)(DataType, PortManager::PortList&))&PortManager::get_ports)
1295                 .addRefFunction ("get_backend_ports", (int (PortManager::*)(const std::string&, DataType, PortFlags, std::vector<std::string>&))&PortManager::get_ports)
1296                 .endClass()
1297
1298                 .deriveClass <AudioEngine, PortManager> ("AudioEngine")
1299                 .addFunction ("available_backends", &AudioEngine::available_backends)
1300                 .addFunction ("current_backend_name", &AudioEngine::current_backend_name)
1301                 .addFunction ("set_backend", &AudioEngine::set_backend)
1302                 .addFunction ("setup_required", &AudioEngine::setup_required)
1303                 .addFunction ("start", &AudioEngine::start)
1304                 .addFunction ("stop", &AudioEngine::stop)
1305                 .addFunction ("get_dsp_load", &AudioEngine::get_dsp_load)
1306                 .addFunction ("set_device_name", &AudioEngine::set_device_name)
1307                 .addFunction ("set_sample_rate", &AudioEngine::set_sample_rate)
1308                 .addFunction ("set_buffer_size", &AudioEngine::set_buffer_size)
1309                 .addFunction ("get_last_backend_error", &AudioEngine::get_last_backend_error)
1310                 .endClass()
1311
1312                 .deriveClass <SessionConfiguration, PBD::Configuration> ("SessionConfiguration")
1313 #undef  CONFIG_VARIABLE
1314 #undef  CONFIG_VARIABLE_SPECIAL
1315 #define CONFIG_VARIABLE(Type,var,name,value) \
1316                 .addFunction ("get_" # var, &SessionConfiguration::get_##var) \
1317                 .addFunction ("set_" # var, &SessionConfiguration::set_##var) \
1318                 .addProperty (#var, &SessionConfiguration::get_##var, &SessionConfiguration::set_##var)
1319
1320 #define CONFIG_VARIABLE_SPECIAL(Type,var,name,value,mutator) \
1321                 .addFunction ("get_" # var, &SessionConfiguration::get_##var) \
1322                 .addFunction ("set_" # var, &SessionConfiguration::set_##var) \
1323                 .addProperty (#var, &SessionConfiguration::get_##var, &SessionConfiguration::set_##var)
1324
1325 #include "ardour/session_configuration_vars.h"
1326
1327 #undef CONFIG_VARIABLE
1328 #undef CONFIG_VARIABLE_SPECIAL
1329                 .endClass()
1330                 .endNamespace ();
1331
1332         // basic representation of Session
1333         // functions which can be used from realtime and non-realtime contexts
1334         luabridge::getGlobalNamespace (L)
1335                 .beginNamespace ("ARDOUR")
1336                 .beginClass <Session> ("Session")
1337                 .addFunction ("scripts_changed", &Session::scripts_changed) // used internally
1338                 .addFunction ("transport_rolling", &Session::transport_rolling)
1339                 .addFunction ("request_transport_speed", &Session::request_transport_speed)
1340                 .addFunction ("transport_frame", &Session::transport_frame)
1341                 .addFunction ("transport_speed", &Session::transport_speed)
1342                 .addFunction ("frame_rate", &Session::frame_rate)
1343                 .addFunction ("nominal_frame_rate", &Session::nominal_frame_rate)
1344                 .addFunction ("frames_per_timecode_frame", &Session::frames_per_timecode_frame)
1345                 .addFunction ("timecode_frames_per_hour", &Session::timecode_frames_per_hour)
1346                 .addFunction ("timecode_frames_per_second", &Session::timecode_frames_per_second)
1347                 .addFunction ("timecode_drop_frames", &Session::timecode_drop_frames)
1348                 .addFunction ("request_locate", &Session::request_locate)
1349                 .addFunction ("request_stop", &Session::request_stop)
1350                 .addFunction ("last_transport_start", &Session::last_transport_start)
1351                 .addFunction ("goto_start", &Session::goto_start)
1352                 .addFunction ("goto_end", &Session::goto_end)
1353                 .addFunction ("current_start_frame", &Session::current_start_frame)
1354                 .addFunction ("current_end_frame", &Session::current_end_frame)
1355                 .addFunction ("actively_recording", &Session::actively_recording)
1356                 .addFunction ("new_audio_track", &Session::new_audio_track)
1357                 .addFunction ("new_audio_route", &Session::new_audio_route)
1358                 .addFunction ("new_midi_track", &Session::new_midi_track)
1359                 .addFunction ("new_midi_route", &Session::new_midi_route)
1360                 .addFunction ("get_routes", &Session::get_routes)
1361                 .addFunction ("get_tracks", &Session::get_tracks)
1362                 .addFunction ("name", &Session::name)
1363                 .addFunction ("path", &Session::path)
1364                 .addFunction ("record_status", &Session::record_status)
1365                 .addFunction ("route_by_id", &Session::route_by_id)
1366                 .addFunction ("route_by_name", &Session::route_by_name)
1367                 .addFunction ("get_remote_nth_stripable", &Session::get_remote_nth_stripable)
1368                 .addFunction ("get_remote_nth_route", &Session::get_remote_nth_route)
1369                 .addFunction ("route_by_selected_count", &Session::route_by_selected_count)
1370                 .addFunction ("track_by_diskstream_id", &Session::track_by_diskstream_id)
1371                 .addFunction ("source_by_id", &Session::source_by_id)
1372                 .addFunction ("controllable_by_id", &Session::controllable_by_id)
1373                 .addFunction ("processor_by_id", &Session::processor_by_id)
1374                 .addFunction ("snap_name", &Session::snap_name)
1375                 .addFunction ("monitor_out", &Session::monitor_out)
1376                 .addFunction ("master_out", &Session::master_out)
1377                 .addFunction ("tempo_map", (TempoMap& (Session::*)())&Session::tempo_map)
1378                 .addFunction ("locations", &Session::locations)
1379                 .addFunction ("begin_reversible_command", (void (Session::*)(const std::string&))&Session::begin_reversible_command)
1380                 .addFunction ("commit_reversible_command", &Session::commit_reversible_command)
1381                 .addFunction ("abort_reversible_command", &Session::abort_reversible_command)
1382                 .addFunction ("add_command", &Session::add_command)
1383                 .addFunction ("add_stateful_diff_command", &Session::add_stateful_diff_command)
1384                 .addFunction ("engine", (AudioEngine& (Session::*)())&Session::engine)
1385                 .addFunction ("get_block_size", &Session::get_block_size)
1386                 .addFunction ("worst_output_latency", &Session::worst_output_latency)
1387                 .addFunction ("worst_input_latency", &Session::worst_input_latency)
1388                 .addFunction ("worst_track_latency", &Session::worst_track_latency)
1389                 .addFunction ("worst_playback_latency", &Session::worst_playback_latency)
1390                 .addFunction ("cfg", &Session::cfg)
1391                 .endClass ()
1392
1393                 .beginClass <RegionFactory> ("RegionFactory")
1394                 .addStaticFunction ("region_by_id", &RegionFactory::region_by_id)
1395                 .endClass ()
1396
1397                 /* session enums (rt-safe, common) */
1398                 .beginNamespace ("Session")
1399
1400                 .beginNamespace ("RecordState")
1401                 .addConst ("Disabled", ARDOUR::Session::RecordState(Session::Disabled))
1402                 .addConst ("Enabled", ARDOUR::Session::RecordState(Session::Enabled))
1403                 .addConst ("Recording", ARDOUR::Session::RecordState(Session::Recording))
1404                 .endNamespace ()
1405
1406                 .endNamespace () // end Session enums
1407
1408                 /* ardour enums (rt-safe, common) */
1409                 .beginNamespace ("LocationFlags")
1410                 .addConst ("IsMark", ARDOUR::Location::Flags(Location::IsMark))
1411                 .addConst ("IsAutoPunch", ARDOUR::Location::Flags(Location::IsAutoPunch))
1412                 .addConst ("IsAutoLoop", ARDOUR::Location::Flags(Location::IsAutoLoop))
1413                 .addConst ("IsHidden", ARDOUR::Location::Flags(Location::IsHidden))
1414                 .addConst ("IsCDMarker", ARDOUR::Location::Flags(Location::IsCDMarker))
1415                 .addConst ("IsRangeMarker", ARDOUR::Location::Flags(Location::IsRangeMarker))
1416                 .addConst ("IsSessionRange", ARDOUR::Location::Flags(Location::IsSessionRange))
1417                 .addConst ("IsSkip", ARDOUR::Location::Flags(Location::IsSkip))
1418                 .addConst ("IsSkipping", ARDOUR::Location::Flags(Location::IsSkipping))
1419                 .endNamespace ()
1420
1421                 .beginNamespace ("LuaAPI")
1422                 .addFunction ("nil_proc", ARDOUR::LuaAPI::nil_processor)
1423                 .addFunction ("new_luaproc", ARDOUR::LuaAPI::new_luaproc)
1424                 .addFunction ("new_plugin_info", ARDOUR::LuaAPI::new_plugin_info)
1425                 .addFunction ("new_plugin", ARDOUR::LuaAPI::new_plugin)
1426                 .addFunction ("set_processor_param", ARDOUR::LuaAPI::set_processor_param)
1427                 .addFunction ("set_plugin_insert_param", ARDOUR::LuaAPI::set_plugin_insert_param)
1428                 .addCFunction ("plugin_automation", ARDOUR::LuaAPI::plugin_automation)
1429                 .addCFunction ("hsla_to_rgba", ARDOUR::LuaAPI::hsla_to_rgba)
1430                 .addFunction ("usleep", Glib::usleep)
1431                 .endNamespace () // end LuaAPI
1432                 .endNamespace ();// end ARDOUR
1433 }
1434
1435 void
1436 LuaBindings::dsp (lua_State* L)
1437 {
1438         luabridge::getGlobalNamespace (L)
1439                 .beginNamespace ("ARDOUR")
1440
1441                 .beginClass <AudioBuffer> ("AudioBuffer")
1442                 .addEqualCheck ()
1443                 .addFunction ("data", (Sample*(AudioBuffer::*)(framecnt_t))&AudioBuffer::data)
1444                 .addFunction ("silence", &AudioBuffer::silence)
1445                 .addFunction ("apply_gain", &AudioBuffer::apply_gain)
1446                 .addFunction ("check_silence", &AudioBuffer::check_silence)
1447                 .addFunction ("read_from", (void (AudioBuffer::*)(const Sample*, framecnt_t, framecnt_t, framecnt_t))&AudioBuffer::check_silence)
1448                 .endClass()
1449
1450                 .beginClass <MidiBuffer> ("MidiBuffer")
1451                 .addEqualCheck ()
1452                 .addFunction ("silence", &MidiBuffer::silence)
1453                 .addFunction ("size", &MidiBuffer::size)
1454                 .addFunction ("empty", &MidiBuffer::empty)
1455                 .addFunction ("resize", &MidiBuffer::resize)
1456                 .addFunction ("copy", (void (MidiBuffer::*)(MidiBuffer const * const))&MidiBuffer::copy)
1457                 .addFunction ("push_event", (bool (MidiBuffer::*)(const Evoral::MIDIEvent<framepos_t>&))&MidiBuffer::push_back)
1458                 .addFunction ("push_back", (bool (MidiBuffer::*)(framepos_t, size_t, const uint8_t*))&MidiBuffer::push_back)
1459                 // TODO iterators..
1460                 .addExtCFunction ("table", &luabridge::CFunc::listToTable<const Evoral::MIDIEvent<framepos_t>, MidiBuffer>)
1461                 .endClass()
1462
1463                 .beginClass <BufferSet> ("BufferSet")
1464                 .addEqualCheck ()
1465                 .addFunction ("get_audio", static_cast<AudioBuffer&(BufferSet::*)(size_t)>(&BufferSet::get_audio))
1466                 .addFunction ("get_midi", static_cast<MidiBuffer&(BufferSet::*)(size_t)>(&BufferSet::get_midi))
1467                 .addFunction ("count", static_cast<const ChanCount&(BufferSet::*)()const>(&BufferSet::count))
1468                 .endClass()
1469                 .endNamespace ();
1470
1471         luabridge::getGlobalNamespace (L)
1472                 .beginNamespace ("Evoral")
1473                 .beginClass <Evoral::Event<framepos_t> > ("Event")
1474                 .addFunction ("clear", &Evoral::Event<framepos_t>::clear)
1475                 .addFunction ("size", &Evoral::Event<framepos_t>::size)
1476                 .addFunction ("set_buffer", &Evoral::Event<framepos_t>::set_buffer)
1477                 .addFunction ("buffer", (uint8_t*(Evoral::Event<framepos_t>::*)())&Evoral::Event<framepos_t>::buffer)
1478                 .addFunction ("time", (framepos_t (Evoral::Event<framepos_t>::*)())&Evoral::MIDIEvent<framepos_t>::time)
1479                 .endClass ()
1480
1481                 .beginClass <Evoral::Beats> ("Beats")
1482                 .addFunction ("to_double", &Evoral::Beats::to_double)
1483                 .endClass ()
1484
1485                 .deriveClass <Evoral::MIDIEvent<framepos_t>, Evoral::Event<framepos_t> > ("MidiEvent")
1486                 // add Ctor?
1487                 .addFunction ("type", &Evoral::MIDIEvent<framepos_t>::type)
1488                 .addFunction ("channel", &Evoral::MIDIEvent<framepos_t>::channel)
1489                 .addFunction ("set_type", &Evoral::MIDIEvent<framepos_t>::set_type)
1490                 .addFunction ("set_channel", &Evoral::MIDIEvent<framepos_t>::set_channel)
1491                 .endClass ()
1492                 .endNamespace ();
1493
1494         // dsp releated session functions
1495         luabridge::getGlobalNamespace (L)
1496                 .beginNamespace ("ARDOUR")
1497                 .beginClass <Session> ("Session")
1498                 .addFunction ("get_scratch_buffers", &Session::get_scratch_buffers)
1499                 .addFunction ("get_silent_buffers", &Session::get_silent_buffers)
1500                 .endClass ()
1501                 .endNamespace ();
1502
1503         luabridge::getGlobalNamespace (L)
1504                 .beginNamespace ("ARDOUR")
1505                 .beginClass <FluidSynth> ("FluidSynth")
1506                 .addConstructor <void (*) (float, int)> ()
1507                 .addFunction ("load_sf2", &FluidSynth::load_sf2)
1508                 .addFunction ("synth", &FluidSynth::synth)
1509                 .addFunction ("midi_event", &FluidSynth::midi_event)
1510                 .addFunction ("panic", &FluidSynth::panic)
1511                 .addFunction ("select_program", &FluidSynth::select_program)
1512                 .addFunction ("program_count", &FluidSynth::program_count)
1513                 .addFunction ("program_name", &FluidSynth::program_name)
1514                 .endClass ()
1515                 .endNamespace ();
1516
1517         luabridge::getGlobalNamespace (L)
1518                 .beginNamespace ("ARDOUR")
1519                 .beginNamespace ("DSP")
1520                 .addFunction ("compute_peak", ARDOUR::compute_peak)
1521                 .addFunction ("find_peaks", ARDOUR::find_peaks)
1522                 .addFunction ("apply_gain_to_buffer", ARDOUR::apply_gain_to_buffer)
1523                 .addFunction ("mix_buffers_no_gain", ARDOUR::mix_buffers_no_gain)
1524                 .addFunction ("mix_buffers_with_gain", ARDOUR::mix_buffers_with_gain)
1525                 .addFunction ("copy_vector", ARDOUR::copy_vector)
1526                 .addFunction ("dB_to_coefficient", &dB_to_coefficient)
1527                 .addFunction ("fast_coefficient_to_dB", &fast_coefficient_to_dB)
1528                 .addFunction ("accurate_coefficient_to_dB", &accurate_coefficient_to_dB)
1529                 .addFunction ("memset", &DSP::memset)
1530                 .addFunction ("mmult", &DSP::mmult)
1531                 .addFunction ("log_meter", &DSP::log_meter)
1532                 .addFunction ("log_meter_coeff", &DSP::log_meter_coeff)
1533                 .addFunction ("process_map", &DSP::process_map)
1534                 .addRefFunction ("peaks", &DSP::peaks)
1535
1536                 .beginClass <DSP::LowPass> ("LowPass")
1537                 .addConstructor <void (*) (double, float)> ()
1538                 .addFunction ("proc", &DSP::LowPass::proc)
1539                 .addFunction ("ctrl", &DSP::LowPass::ctrl)
1540                 .addFunction ("set_cutoff", &DSP::LowPass::set_cutoff)
1541                 .addFunction ("reset", &DSP::LowPass::reset)
1542                 .endClass ()
1543                 .beginClass <DSP::Biquad> ("Biquad")
1544                 .addConstructor <void (*) (double)> ()
1545                 .addFunction ("run", &DSP::Biquad::run)
1546                 .addFunction ("compute", &DSP::Biquad::compute)
1547                 .addFunction ("configure", &DSP::Biquad::configure)
1548                 .addFunction ("reset", &DSP::Biquad::reset)
1549                 .addFunction ("dB_at_freq", &DSP::Biquad::dB_at_freq)
1550                 .endClass ()
1551                 .beginClass <DSP::FFTSpectrum> ("FFTSpectrum")
1552                 .addConstructor <void (*) (uint32_t, double)> ()
1553                 .addFunction ("set_data_hann", &DSP::FFTSpectrum::set_data_hann)
1554                 .addFunction ("execute", &DSP::FFTSpectrum::execute)
1555                 .addFunction ("power_at_bin", &DSP::FFTSpectrum::power_at_bin)
1556                 .addFunction ("freq_at_bin", &DSP::FFTSpectrum::freq_at_bin)
1557                 .endClass ()
1558
1559                 /* DSP enums */
1560                 .beginNamespace ("BiquadType")
1561                 .addConst ("LowPass", ARDOUR::DSP::Biquad::LowPass)
1562                 .addConst ("HighPass", ARDOUR::DSP::Biquad::HighPass)
1563                 .addConst ("BandPassSkirt", ARDOUR::DSP::Biquad::BandPassSkirt)
1564                 .addConst ("BandPass0dB", ARDOUR::DSP::Biquad::BandPass0dB)
1565                 .addConst ("Notch", ARDOUR::DSP::Biquad::Notch)
1566                 .addConst ("AllPass", ARDOUR::DSP::Biquad::AllPass)
1567                 .addConst ("Peaking", ARDOUR::DSP::Biquad::Peaking)
1568                 .addConst ("LowShelf", ARDOUR::DSP::Biquad::LowShelf)
1569                 .addConst ("HighShelf", ARDOUR::DSP::Biquad::HighShelf)
1570                 .endNamespace ()
1571
1572                 .beginClass <DSP::DspShm> ("DspShm")
1573                 .addConstructor<void (*) (size_t)> ()
1574                 .addFunction ("allocate", &DSP::DspShm::allocate)
1575                 .addFunction ("clear", &DSP::DspShm::clear)
1576                 .addFunction ("to_float", &DSP::DspShm::to_float)
1577                 .addFunction ("to_int", &DSP::DspShm::to_int)
1578                 .addFunction ("atomic_set_int", &DSP::DspShm::atomic_set_int)
1579                 .addFunction ("atomic_get_int", &DSP::DspShm::atomic_get_int)
1580                 .endClass ()
1581
1582                 .endNamespace () // DSP
1583
1584                 .beginClass <LuaTableRef> ("LuaTableRef")
1585                 .addCFunction ("get", &LuaTableRef::get)
1586                 .addCFunction ("set", &LuaTableRef::set)
1587                 .endClass ()
1588
1589                 .endNamespace (); // ARDOUR
1590 }
1591
1592 void
1593 LuaBindings::session (lua_State* L)
1594 {
1595         // non-realtime session functions
1596         luabridge::getGlobalNamespace (L)
1597                 .beginNamespace ("ARDOUR")
1598                 .beginClass <Session> ("Session")
1599                 .addFunction ("save_state", &Session::save_state)
1600                 .addFunction ("set_dirty", &Session::set_dirty)
1601                 .addFunction ("unknown_processors", &Session::unknown_processors)
1602
1603                 .addFunction<RouteList (Session::*)(uint32_t, PresentationInfo::order_t, const std::string&, const std::string&, PlaylistDisposition)> ("new_route_from_template", &Session::new_route_from_template)
1604                 // TODO  session_add_audio_track  session_add_midi_track  session_add_mixed_track
1605                 //.addFunction ("new_midi_track", &Session::new_midi_track)
1606                 .endClass ()
1607
1608                 .endNamespace (); // ARDOUR
1609 }
1610
1611 void
1612 LuaBindings::osc (lua_State* L)
1613 {
1614         luabridge::getGlobalNamespace (L)
1615                 .beginNamespace ("ARDOUR")
1616                 .beginNamespace ("LuaOSC")
1617                 .beginClass<LuaOSC::Address> ("Address")
1618                 .addConstructor<void (*) (std::string)> ()
1619                 .addCFunction ("send", &LuaOSC::Address::send)
1620                 .endClass ()
1621                 .endNamespace ()
1622                 .endNamespace ();
1623 }
1624
1625 void
1626 LuaBindings::set_session (lua_State* L, Session *s)
1627 {
1628         /* LuaBridge uses unique keys to identify classes/c-types.
1629          *
1630          * Those keys are "generated" by using the memory-address of a static
1631          * variable, templated for every Class.
1632          * (see libs/lua/LuaBridge/detail/ClassInfo.h)
1633          *
1634          * When linking the final executable there must be exactly one static
1635          * function (static variable) for every templated class.
1636          * This works fine on OSX and Linux...
1637          *
1638          * Windows (mingw and MSVC) however expand the template differently for libardour
1639          * AND gtk2_ardour. We end up with two identical static functions
1640          * at different addresses!!
1641          *
1642          * The Solution: have gtk2_ardour never include LuaBridge headers directly
1643          * and always go via libardour function calls for classes that are registered
1644          * in libardour. (calling lua itself is fine,  calling c-functions in the GUI
1645          * which expand the template is not)
1646          *
1647          * (the actual cause: even static symbols in a .dll have no fixed address
1648          * and are mapped when loading the dll. static functions in .exe do have a fixed
1649          * address)
1650          *
1651          * libardour:
1652          *  0000000000000000 I __imp__ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
1653          *  0000000000000000 I __nm__ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
1654          *  0000000000000000 T _ZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEv
1655          *
1656          * ardour.exe
1657          *  000000000104f560 d .data$_ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
1658          *  000000000104f560 D _ZZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEvE5value
1659          *  0000000000e9baf0 T _ZN9luabridge9ClassInfoIN6ARDOUR7SessionEE11getClassKeyEv
1660          *
1661          *
1662          */
1663         luabridge::push <Session *> (L, s);
1664         lua_setglobal (L, "Session");
1665
1666         if (s) {
1667                 // call lua function.
1668                 luabridge::LuaRef cb_ses = luabridge::getGlobal (L, "new_session");
1669                 if (cb_ses.type() == LUA_TFUNCTION) { cb_ses(s->name()); } // TODO args
1670         }
1671 }