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         /** set a plugin control-input parameter value
 103          *
 104          * This is a wrapper around set_processor_param which looks up the Processor by plugin-insert.
 105          *
 106          * @param proc Plugin-Insert
 107          * @param which control-input to set (starting at 0)
 108          * @param value value to set
 109          * @returns true on success, false on error or out-of-bounds value
 110          */
 111         bool set_plugin_insert_param (boost::shared_ptr<ARDOUR::PluginInsert> pi, uint32_t which, float val);
 112
 113         /** get a plugin control parameter value
 114          *
 115          * @param proc Plugin-Insert
 116          * @param which control port to query (starting at 0, including ports of type input and output)
 117          * @param ok boolean variable contains true or false after call returned. to be checked by caller before using value.
 118          * @returns value
 119          */
 120         float get_plugin_insert_param (boost::shared_ptr<ARDOUR::PluginInsert> pi, uint32_t which, bool &ok);
 121
 122         /**
 123          * A convenience function to get a Automation Lists and ParamaterDescriptor
 124          * for a given plugin control.
 125          *
 126          * This is equivalent to the following lua code
 127          * @code
 128          * function (processor, param_id)
 129          *  local plugininsert = processor:to_insert ()
 130          *  local plugin = plugininsert:plugin(0)
 131          *  local _, t = plugin:get_parameter_descriptor(param_id, ARDOUR.ParameterDescriptor ())
 132          *  local ctrl = Evoral.Parameter (ARDOUR.AutomationType.PluginAutomation, 0, param_id)
 133          *  local ac = pi:automation_control (ctrl, false)
 134          *  local acl = ac:alist()
 135          *  return ac:alist(), ac:to_ctrl():list(), t[2]
 136          * end
 137          * @endcode
 138          *
 139          * Example usage: get the third input parameter of first plugin on the given route
 140          * (Ardour starts counting at zero).
 141          * @code
 142          * local al, cl, pd = ARDOUR.LuaAPI.plugin_automation (route:nth_plugin (0), 3)
 143          * @endcode
 144          * @returns 3 parameters: AutomationList, ControlList, ParamaterDescriptor
 145          */
 146         int plugin_automation (lua_State *lua);
 147
 148         /**
 149          * A convenience function for colorspace HSL to RGB conversion.
 150          * All ranges are 0..1
 151          *
 152          * Example:
 153          * @code
 154          * local r, g, b, a = ARDOUR.LuaAPI.hsla_to_rgba (hue, saturation, luminosity, alpha)
 155          * @endcode
 156          * @returns 4 parameters: red, green, blue, alpha (in range 0..1)
 157          */
 158         int hsla_to_rgba (lua_State *lua);
 159
 160         /* Creates a filename from a series of elements using the correct separator for filenames.
 161          *
 162          * No attempt is made to force the resulting filename to be an absolute path.
 163          * If the first element is a relative path, the result will be a relative path.
 164          */
 165         int build_filename (lua_State *lua);
 166
 167         class Vamp {
 168         /** Vamp Plugin Interface
 169          *
 170          * Vamp is an audio processing plugin system for plugins that extract descriptive information
 171          * from audio data - typically referred to as audio analysis plugins or audio feature
 172          * extraction plugins.
 173          *
 174          * This interface allows to load a plugins and directly access it using the Vamp Plugin API.
 175          *
 176          * A convenience method is provided to analyze Ardour::Readable objects (Regions).
 177          */
 178                 public:
 179                         Vamp (const std::string&, float sample_rate);
 180                         ~Vamp ();
 181
 182                         /** Search for all available available Vamp plugins.
 183                          * @returns list of plugin-keys
 184                          */
 185                         static std::vector<std::string> list_plugins ();
 186
 187                         ::Vamp::Plugin* plugin () { return _plugin; }
 188
 189                         /** high-level abstraction to process a single channel of the given Readable.
 190                          *
 191                          * If the plugin is not yet initialized, initialize() is called.
 192                          *
 193                          * if @cb is not nil, it is called with the immediate
 194                          * Vamp::Plugin::Features on every process call.
 195                          *
 196                          * @param r readable
 197                          * @param channel channel to process
 198                          * @param fn lua callback function
 199                          * @return 0 on success
 200                          */
 201                         int analyze (boost::shared_ptr<ARDOUR::Readable> r, uint32_t channel, luabridge::LuaRef fn);
 202
 203                         /** call plugin():reset() and clear intialization flag */
 204                         void reset ();
 205
 206                         /** initialize the plugin for use with analyze().
 207                          *
 208                          * This is equivalent to plugin():initialise (1, ssiz, bsiz)
 209                          * and prepares a plugin for analyze.
 210                          * (by preferred step and block sizes are used. if the plugin
 211                          * does not specify them or they're larger than 8K, both are set to 1024)
 212                          *
 213                          * Manual initialization is only required to set plugin-parameters
 214                          * which depend on prior initialization of the plugin.
 215                          *
 216                          * @code
 217                          * vamp:reset ()
 218                          * vamp:initialize ()
 219                          * vamp:plugin():setParameter (0, 1.5, nil)
 220                          * vamp:analyze (r, 0)
 221                          * @endcode
 222                          */
 223                         bool initialize ();
 224
 225                         bool initialized () const { return _initialized; }
 226
 227                         /** process given array of audio-samples.
 228                          *
 229                          * This is a lua-binding for vamp:plugin():process ()
 230                          *
 231                          * @param d audio-data, the vector must match the configured channel count
 232                          *    and hold a complete buffer for every channel as set during
 233                          *    plugin():initialise()
 234                          * @param rt timestamp matching the provided buffer.
 235                          * @returns features extracted from that data (if the plugin is causal)
 236                          */
 237                         ::Vamp::Plugin::FeatureSet process (const std::vector<float*>& d, ::Vamp::RealTime rt);
 238
 239                 private:
 240                         ::Vamp::Plugin* _plugin;
 241                         float           _sample_rate;
 242                         framecnt_t      _bufsize;
 243                         framecnt_t      _stepsize;
 244                         bool            _initialized;
 245
 246         };
 247
 248         boost::shared_ptr<Evoral::Note<Evoral::Beats> >
 249                 new_noteptr (uint8_t, Evoral::Beats, Evoral::Beats, uint8_t, uint8_t);
 250
 251 } } /* namespace */
 252
 253 namespace ARDOUR { namespace LuaOSC {
 254         /** OSC transmitter
 255          *
 256          * A Class to send OSC messages.
 257          */
 258         class Address {
 259                 /*
 260                  * OSC is kinda special, lo_address is a void* and lo_send() has varags
 261                  * and typed arguments which makes it hard to bind, even lo_cpp.
 262                  */
 263                 public:
 264                         /** Construct a new OSC transmitter object
 265                          * @param uri the destination uri e.g. "osc.udp://localhost:7890"
 266                          */
 267                         Address (std::string uri) {
 268                                 _addr = lo_address_new_from_url (uri.c_str());
 269                         }
 270
 271                         ~Address () { if (_addr) { lo_address_free (_addr); } }
 272                         /** Transmit an OSC message
 273                          *
 274                          * Path (string) and type (string) must always be given.
 275                          * The number of following args must match the type.
 276                          * Supported types are:
 277                          *
 278                          *  'i': integer (lua number)
 279                          *
 280                          *  'f': float (lua number)
 281                          *
 282                          *  'd': double (lua number)
 283                          *
 284                          *  'h': 64bit integer (lua number)
 285                          *
 286                          *  's': string (lua string)
 287                          *
 288                          *  'c': character (lua string)
 289                          *
 290                          *  'T': boolean (lua bool) -- this is not implicily True, a lua true/false must be given
 291                          *
 292                          *  'F': boolean (lua bool) -- this is not implicily False, a lua true/false must be given
 293                          *
 294                          * @param lua: lua arguments: path, types, ...
 295                          * @returns boolean true if successful, false on error.
 296                          */
 297                         int send (lua_State *lua);
 298                 private:
 299                         lo_address _addr;
 300         };
 301
 302 }
 303
 304 class LuaTableRef {
 305         public:
 306                 LuaTableRef ();
 307                 ~LuaTableRef ();
 308
 309                 int get (lua_State* L);
 310                 int set (lua_State* L);
 311
 312         private:
 313                 struct LuaTableEntry {
 314                         LuaTableEntry (int kt, int vt)
 315                                 : keytype (kt)
 316                                 , valuetype (vt)
 317                         { }
 318
 319                         int keytype;
 320                         std::string k_s;
 321                         unsigned int k_n;
 322
 323                         int valuetype;
 324                         // LUA_TUSERDATA
 325                         const void* c;
 326                         void* p;
 327                         // LUA_TBOOLEAN
 328                         bool b;
 329                         // LUA_TSTRING:
 330                         std::string s;
 331                         // LUA_TNUMBER:
 332                         double n;
 333                 };
 334
 335                 std::vector<LuaTableEntry> _data;
 336
 337                 static void* findclasskey (lua_State *L, const void* key);
 338                 template<typename T>
 339                 static void assign (luabridge::LuaRef* rv, T key, const LuaTableEntry& s);
 340 };
 341
 342 } /* namespace */
 343
 344 #endif // _ardour_lua_api_h_