libs/ardour/ardour/lua_api.h

   1 /*
   2  * Copyright (C) 2016 Robin Gareus <robin@gareus.org>
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17  *
  18  */
  19 #ifndef _ardour_lua_api_h_
  20 #define _ardour_lua_api_h_
  21
  22 #include <string>
  23 #include <lo/lo.h>
  24 #include <boost/shared_ptr.hpp>
  25 #include <vamp-hostsdk/Plugin.h>
  26
  27 #include "evoral/Note.hpp"
  28
  29 #include "ardour/libardour_visibility.h"
  30
  31 #include "ardour/processor.h"
  32 #include "ardour/session.h"
  33
  34 namespace ARDOUR {
  35         class Readable;
  36 }
  37
  38 namespace ARDOUR { namespace LuaAPI {
  39
  40         /** convenience constructor for DataType::NIL with managed lifetime
  41          * @returns DataType::NIL
  42          */
  43         int datatype_ctor_null (lua_State *lua);
  44         /** convenience constructor for DataType::AUDIO with managed lifetime
  45          * @returns DataType::AUDIO
  46          */
  47         int datatype_ctor_audio (lua_State *L);
  48         /** convenience constructor for DataType::MIDI with managed lifetime
  49          * @returns DataType::MIDI
  50          */
  51         int datatype_ctor_midi (lua_State *L);
  52
  53         /** Create a null processor shared pointer
  54          *
  55          * This is useful for Track:bounce() to indicate no processing.
  56          */
  57         boost::shared_ptr<ARDOUR::Processor> nil_processor ();
  58
  59         /** create a new Lua Processor (Plugin)
  60          *
  61          * @param s Session Handle
  62          * @param p Identifier or Name of the Processor
  63          * @returns Processor object (may be nil)
  64          */
  65         boost::shared_ptr<ARDOUR::Processor> new_luaproc (ARDOUR::Session *s, const std::string& p);
  66
  67         /** search a Plugin
  68          *
  69          * @param id Plugin Name, ID or URI
  70          * @param type Plugin Type
  71          * @returns PluginInfo or nil if not found
  72          */
  73         boost::shared_ptr<ARDOUR::PluginInfo> new_plugin_info (const std::string& id, ARDOUR::PluginType type);
  74
  75         /** create a new Plugin Instance
  76          *
  77          * @param s Session Handle
  78          * @param id Plugin Name, ID or URI
  79          * @param type Plugin Type
  80          * @returns Processor or nil
  81          */
  82         boost::shared_ptr<ARDOUR::Processor> new_plugin (ARDOUR::Session *s, const std::string& id, ARDOUR::PluginType type, const std::string& preset = "");
  83
  84         /** set a plugin control-input parameter value
  85          *
  86          * @param proc Plugin-Processor
  87          * @param which control-input to set (starting at 0)
  88          * @param value value to set
  89          * @returns true on success, false on error or out-of-bounds value
  90          */
  91         bool set_processor_param (boost::shared_ptr<ARDOUR::Processor> proc, uint32_t which, float val);
  92
  93         /** get a plugin control parameter value
  94          *
  95          * @param proc Plugin-Processor
  96          * @param which control port to set (starting at 0, including ports of type input and output))
  97          * @param ok boolean variable contains true or false after call returned. to be checked by caller before using value.
  98          * @returns value
  99          */
 100         float get_processor_param (boost::shared_ptr<Processor> proc, uint32_t which, bool &ok);
 101
 102         /** reset a processor to its default values (only works for plugins )
 103          *
 104          * This is a wrapper which looks up the Processor by plugin-insert.
 105          *
 106          * @param proc Plugin-Insert
 107          * @returns true on success, false when the processor is not a plugin
 108          */
 109         bool reset_processor_to_default (boost::shared_ptr<Processor> proc);
 110
 111         /** set a plugin control-input parameter value
 112          *
 113          * This is a wrapper around set_processor_param which looks up the Processor by plugin-insert.
 114          *
 115          * @param proc Plugin-Insert
 116          * @param which control-input to set (starting at 0)
 117          * @param value value to set
 118          * @returns true on success, false on error or out-of-bounds value
 119          */
 120         bool set_plugin_insert_param (boost::shared_ptr<ARDOUR::PluginInsert> pi, uint32_t which, float val);
 121
 122         /** get a plugin control parameter value
 123          *
 124          * @param proc Plugin-Insert
 125          * @param which control port to query (starting at 0, including ports of type input and output)
 126          * @param ok boolean variable contains true or false after call returned. to be checked by caller before using value.
 127          * @returns value
 128          */
 129         float get_plugin_insert_param (boost::shared_ptr<ARDOUR::PluginInsert> pi, uint32_t which, bool &ok);
 130
 131         /**
 132          * A convenience function to get a Automation Lists and ParamaterDescriptor
 133          * for a given plugin control.
 134          *
 135          * This is equivalent to the following lua code
 136          * @code
 137          * function (processor, param_id)
 138          *  local plugininsert = processor:to_insert ()
 139          *  local plugin = plugininsert:plugin(0)
 140          *  local _, t = plugin:get_parameter_descriptor(param_id, ARDOUR.ParameterDescriptor ())
 141          *  local ctrl = Evoral.Parameter (ARDOUR.AutomationType.PluginAutomation, 0, param_id)
 142          *  local ac = pi:automation_control (ctrl, false)
 143          *  local acl = ac:alist()
 144          *  return ac:alist(), ac:to_ctrl():list(), t[2]
 145          * end
 146          * @endcode
 147          *
 148          * Example usage: get the third input parameter of first plugin on the given route
 149          * (Ardour starts counting at zero).
 150          * @code
 151          * local al, cl, pd = ARDOUR.LuaAPI.plugin_automation (route:nth_plugin (0), 3)
 152          * @endcode
 153          * @returns 3 parameters: AutomationList, ControlList, ParamaterDescriptor
 154          */
 155         int plugin_automation (lua_State *lua);
 156
 157         /**
 158          * A convenience function for colorspace HSL to RGB conversion.
 159          * All ranges are 0..1
 160          *
 161          * Example:
 162          * @code
 163          * local r, g, b, a = ARDOUR.LuaAPI.hsla_to_rgba (hue, saturation, luminosity, alpha)
 164          * @endcode
 165          * @returns 4 parameters: red, green, blue, alpha (in range 0..1)
 166          */
 167         int hsla_to_rgba (lua_State *lua);
 168
 169         /**
 170          * A convenience function to expand RGBA parameters from an integer
 171          *
 172          * convert a Canvas::Color (uint32_t 0xRRGGBBAA) into
 173          * double RGBA values which can be passed as parameters to
 174          * Cairo::Context::set_source_rgba
 175          *
 176          * Example:
 177          * @code
 178          * local r, g, b, a = ARDOUR.LuaAPI.color_to_rgba (0x88aa44ff)
 179          * cairo_ctx:set_source_rgba (ARDOUR.LuaAPI.color_to_rgba (0x11336699)
 180          * @endcode
 181          * @returns 4 parameters: red, green, blue, alpha (in range 0..1)
 182          */
 183         int color_to_rgba (lua_State *lua);
 184
 185         /**
 186          * Creates a filename from a series of elements using the correct separator for filenames.
 187          *
 188          * No attempt is made to force the resulting filename to be an absolute path.
 189          * If the first element is a relative path, the result will be a relative path.
 190          */
 191         int build_filename (lua_State *lua);
 192
 193         /**
 194          * Generic conversion from audio sample count to timecode.
 195          * (TimecodeType, sample-rate, sample-pos)
 196          */
 197         int sample_to_timecode (lua_State *L);
 198
 199         /**
 200          * Generic conversion from timecode to audio sample count.
 201          * (TimecodeType, sample-rate, hh, mm, ss, ff)
 202          */
 203         int timecode_to_sample (lua_State *L);
 204
 205         /**
 206          * Use current session settings to convert
 207          * audio-sample count into hh, mm, ss, ff
 208          * timecode (this include session pull up/down).
 209          */
 210         int sample_to_timecode_lua (lua_State *L);
 211
 212         /**
 213          * Use current session settings to convert
 214          * timecode (hh, mm, ss, ff) to audio-sample
 215          * count (this include session pull up/down).
 216          */
 217         int timecode_to_sample_lua (lua_State *L);
 218
 219         class Vamp {
 220         /** Vamp Plugin Interface
 221          *
 222          * Vamp is an audio processing plugin system for plugins that extract descriptive information
 223          * from audio data - typically referred to as audio analysis plugins or audio feature
 224          * extraction plugins.
 225          *
 226          * This interface allows to load a plugins and directly access it using the Vamp Plugin API.
 227          *
 228          * A convenience method is provided to analyze Ardour::Readable objects (Regions).
 229          */
 230                 public:
 231                         Vamp (const std::string&, float sample_rate);
 232                         ~Vamp ();
 233
 234                         /** Search for all available available Vamp plugins.
 235                          * @returns list of plugin-keys
 236                          */
 237                         static std::vector<std::string> list_plugins ();
 238
 239                         ::Vamp::Plugin* plugin () { return _plugin; }
 240
 241                         /** high-level abstraction to process a single channel of the given Readable.
 242                          *
 243                          * If the plugin is not yet initialized, initialize() is called.
 244                          *
 245                          * if @cb is not nil, it is called with the immediate
 246                          * Vamp::Plugin::Features on every process call.
 247                          *
 248                          * @param r readable
 249                          * @param channel channel to process
 250                          * @param fn lua callback function
 251                          * @return 0 on success
 252                          */
 253                         int analyze (boost::shared_ptr<ARDOUR::Readable> r, uint32_t channel, luabridge::LuaRef fn);
 254
 255                         /** call plugin():reset() and clear intialization flag */
 256                         void reset ();
 257
 258                         /** initialize the plugin for use with analyze().
 259                          *
 260                          * This is equivalent to plugin():initialise (1, ssiz, bsiz)
 261                          * and prepares a plugin for analyze.
 262                          * (by preferred step and block sizes are used. if the plugin
 263                          * does not specify them or they're larger than 8K, both are set to 1024)
 264                          *
 265                          * Manual initialization is only required to set plugin-parameters
 266                          * which depend on prior initialization of the plugin.
 267                          *
 268                          * @code
 269                          * vamp:reset ()
 270                          * vamp:initialize ()
 271                          * vamp:plugin():setParameter (0, 1.5, nil)
 272                          * vamp:analyze (r, 0)
 273                          * @endcode
 274                          */
 275                         bool initialize ();
 276
 277                         bool initialized () const { return _initialized; }
 278
 279                         /** process given array of audio-samples.
 280                          *
 281                          * This is a lua-binding for vamp:plugin():process ()
 282                          *
 283                          * @param d audio-data, the vector must match the configured channel count
 284                          *    and hold a complete buffer for every channel as set during
 285                          *    plugin():initialise()
 286                          * @param rt timestamp matching the provided buffer.
 287                          * @returns features extracted from that data (if the plugin is causal)
 288                          */
 289                         ::Vamp::Plugin::FeatureSet process (const std::vector<float*>& d, ::Vamp::RealTime rt);
 290
 291                 private:
 292                         ::Vamp::Plugin* _plugin;
 293                         float           _sample_rate;
 294                         framecnt_t      _bufsize;
 295                         framecnt_t      _stepsize;
 296                         bool            _initialized;
 297
 298         };
 299
 300         boost::shared_ptr<Evoral::Note<Evoral::Beats> >
 301                 new_noteptr (uint8_t, Evoral::Beats, Evoral::Beats, uint8_t, uint8_t);
 302
 303 } } /* namespace */
 304
 305 namespace ARDOUR { namespace LuaOSC {
 306         /** OSC transmitter
 307          *
 308          * A Class to send OSC messages.
 309          */
 310         class Address {
 311                 /*
 312                  * OSC is kinda special, lo_address is a void* and lo_send() has varags
 313                  * and typed arguments which makes it hard to bind, even lo_cpp.
 314                  */
 315                 public:
 316                         /** Construct a new OSC transmitter object
 317                          * @param uri the destination uri e.g. "osc.udp://localhost:7890"
 318                          */
 319                         Address (std::string uri) {
 320                                 _addr = lo_address_new_from_url (uri.c_str());
 321                         }
 322
 323                         ~Address () { if (_addr) { lo_address_free (_addr); } }
 324                         /** Transmit an OSC message
 325                          *
 326                          * Path (string) and type (string) must always be given.
 327                          * The number of following args must match the type.
 328                          * Supported types are:
 329                          *
 330                          *  'i': integer (lua number)
 331                          *
 332                          *  'f': float (lua number)
 333                          *
 334                          *  'd': double (lua number)
 335                          *
 336                          *  'h': 64bit integer (lua number)
 337                          *
 338                          *  's': string (lua string)
 339                          *
 340                          *  'c': character (lua string)
 341                          *
 342                          *  'T': boolean (lua bool) -- this is not implicily True, a lua true/false must be given
 343                          *
 344                          *  'F': boolean (lua bool) -- this is not implicily False, a lua true/false must be given
 345                          *
 346                          * @param lua: lua arguments: path, types, ...
 347                          * @returns boolean true if successful, false on error.
 348                          */
 349                         int send (lua_State *lua);
 350                 private:
 351                         lo_address _addr;
 352         };
 353
 354 }
 355
 356 class LuaTableRef {
 357         public:
 358                 LuaTableRef ();
 359                 ~LuaTableRef ();
 360
 361                 int get (lua_State* L);
 362                 int set (lua_State* L);
 363
 364         private:
 365                 struct LuaTableEntry {
 366                         LuaTableEntry (int kt, int vt)
 367                                 : keytype (kt)
 368                                 , valuetype (vt)
 369                         { }
 370
 371                         int keytype;
 372                         std::string k_s;
 373                         unsigned int k_n;
 374
 375                         int valuetype;
 376                         // LUA_TUSERDATA
 377                         const void* c;
 378                         void* p;
 379                         // LUA_TBOOLEAN
 380                         bool b;
 381                         // LUA_TSTRING:
 382                         std::string s;
 383                         // LUA_TNUMBER:
 384                         double n;
 385                 };
 386
 387                 std::vector<LuaTableEntry> _data;
 388
 389                 static void* findclasskey (lua_State *L, const void* key);
 390                 template<typename T>
 391                 static void assign (luabridge::LuaRef* rv, T key, const LuaTableEntry& s);
 392 };
 393
 394 } /* namespace */
 395
 396 #endif // _ardour_lua_api_h_