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
  26 #include "ardour/libardour_visibility.h"
  27
  28 #include "ardour/processor.h"
  29 #include "ardour/session.h"
  30
  31 namespace ARDOUR { namespace LuaAPI {
  32
  33         /** convenience contructor for DataType::NIL
  34          * @returns DataType::NIL
  35          */
  36         int datatype_ctor_null (lua_State *lua);
  37         /** convenience contructor for DataType::AUDIO
  38          * @returns DataType::AUDIO
  39          */
  40         int datatype_ctor_audio (lua_State *L);
  41         /** convenience contructor for DataType::MIDI
  42          * @returns DataType::MIDI
  43          */
  44         int datatype_ctor_midi (lua_State *L);
  45
  46         /** Create a null processor shared pointer
  47          *
  48          * This is useful for Track:bounce() to indicate no processing.
  49          */
  50         boost::shared_ptr<ARDOUR::Processor> nil_processor ();
  51
  52         /** create a new Lua Processor (Plugin)
  53          *
  54          * @param s Session Handle
  55          * @param p Identifier or Name of the Processor
  56          * @returns Processor object (may be nil)
  57          */
  58         boost::shared_ptr<ARDOUR::Processor> new_luaproc (ARDOUR::Session *s, const std::string& p);
  59
  60         /** search a Plugin
  61          *
  62          * @param id Plugin Name, ID or URI
  63          * @param type Plugin Type
  64          * @returns PluginInfo or nil if not found
  65          */
  66         boost::shared_ptr<ARDOUR::PluginInfo> new_plugin_info (const std::string& id, ARDOUR::PluginType type);
  67
  68         /** create a new Plugin Instance
  69          *
  70          * @param s Session Handle
  71          * @param id Plugin Name, ID or URI
  72          * @param type Plugin Type
  73          * @returns Processor or nil
  74          */
  75         boost::shared_ptr<ARDOUR::Processor> new_plugin (ARDOUR::Session *s, const std::string& id, ARDOUR::PluginType type, const std::string& preset = "");
  76
  77         /** set a plugin control-input parameter value
  78          *
  79          * @param proc Plugin-Processor
  80          * @param which control-input to set (starting at 0)
  81          * @param value value to set
  82          * @returns true on success, false on error or out-of-bounds value
  83          */
  84         bool set_processor_param (boost::shared_ptr<ARDOUR::Processor> proc, uint32_t which, float val);
  85         /** set a plugin control-input parameter value
  86          *
  87          * This is a wrapper around set_processor_param which looks up the Processor by plugin-insert.
  88          *
  89          * @param proc Plugin-Insert
  90          * @param which control-input to set (starting at 0)
  91          * @param value value to set
  92          * @returns true on success, false on error or out-of-bounds value
  93          */
  94         bool set_plugin_insert_param (boost::shared_ptr<ARDOUR::PluginInsert> pi, uint32_t which, float val);
  95
  96 } } /* namespace */
  97
  98 namespace ARDOUR { namespace LuaOSC {
  99         /** OSC transmitter
 100          *
 101          * A Class to send OSC messages.
 102          */
 103         class Address {
 104                 /*
 105                  * OSC is kinda special, lo_address is a void* and lo_send() has varags
 106                  * and typed arguments which makes it hard to bind, even lo_cpp.
 107                  */
 108                 public:
 109                         /** Construct a new OSC transmitter object
 110                          * @param uri the destination uri e.g. "osc.udp://localhost:7890"
 111                          */
 112                         Address (std::string uri) {
 113                                 _addr = lo_address_new_from_url (uri.c_str());
 114                         }
 115
 116                         ~Address () { if (_addr) { lo_address_free (_addr); } }
 117                         /** Transmit an OSC message
 118                          *
 119                          * Path (string) and type (string) must always be given.
 120                          * The number of following args must match the type.
 121                          * Supported types are:
 122                          *
 123                          *  'i': integer (lua number)
 124                          *
 125                          *  'f': float (lua number)
 126                          *
 127                          *  'd': double (lua number)
 128                          *
 129                          *  'h': 64bit integer (lua number)
 130                          *
 131                          *  's': string (lua string)
 132                          *
 133                          *  'c': character (lua string)
 134                          *
 135                          *  'T': boolean (lua bool) -- this is not implicily True, a lua true/false must be given
 136                          *
 137                          *  'F': boolean (lua bool) -- this is not implicily False, a lua true/false must be given
 138                          *
 139                          * @param lua: lua arguments: path, types, ...
 140                          * @returns boolean true if successful, false on error.
 141                          */
 142                         int send (lua_State *lua);
 143                 private:
 144                         lo_address _addr;
 145         };
 146
 147 } } /* namespace */
 148
 149 #endif // _ardour_lua_api_h_