2 * Copyright (C) 2016 Robin Gareus <robin@gareus.org>
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.
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.
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.
19 #ifndef _ardour_lua_api_h_
20 #define _ardour_lua_api_h_
24 #include <boost/shared_ptr.hpp>
25 #include <vamp-hostsdk/Plugin.h>
27 #include "ardour/libardour_visibility.h"
29 #include "ardour/processor.h"
30 #include "ardour/session.h"
36 namespace ARDOUR { namespace LuaAPI {
38 /** convenience constructor for DataType::NIL with managed lifetime
39 * @returns DataType::NIL
41 int datatype_ctor_null (lua_State *lua);
42 /** convenience constructor for DataType::AUDIO with managed lifetime
43 * @returns DataType::AUDIO
45 int datatype_ctor_audio (lua_State *L);
46 /** convenience constructor for DataType::MIDI with managed lifetime
47 * @returns DataType::MIDI
49 int datatype_ctor_midi (lua_State *L);
51 /** Create a null processor shared pointer
53 * This is useful for Track:bounce() to indicate no processing.
55 boost::shared_ptr<ARDOUR::Processor> nil_processor ();
57 /** create a new Lua Processor (Plugin)
59 * @param s Session Handle
60 * @param p Identifier or Name of the Processor
61 * @returns Processor object (may be nil)
63 boost::shared_ptr<ARDOUR::Processor> new_luaproc (ARDOUR::Session *s, const std::string& p);
67 * @param id Plugin Name, ID or URI
68 * @param type Plugin Type
69 * @returns PluginInfo or nil if not found
71 boost::shared_ptr<ARDOUR::PluginInfo> new_plugin_info (const std::string& id, ARDOUR::PluginType type);
73 /** create a new Plugin Instance
75 * @param s Session Handle
76 * @param id Plugin Name, ID or URI
77 * @param type Plugin Type
78 * @returns Processor or nil
80 boost::shared_ptr<ARDOUR::Processor> new_plugin (ARDOUR::Session *s, const std::string& id, ARDOUR::PluginType type, const std::string& preset = "");
82 /** set a plugin control-input parameter value
84 * @param proc Plugin-Processor
85 * @param which control-input to set (starting at 0)
86 * @param value value to set
87 * @returns true on success, false on error or out-of-bounds value
89 bool set_processor_param (boost::shared_ptr<ARDOUR::Processor> proc, uint32_t which, float val);
91 /** get a plugin control parameter value
93 * @param proc Plugin-Processor
94 * @param which control port to set (starting at 0, including ports of type input and output))
95 * @param ok boolean variable contains true or false after call returned. to be checked by caller before using value.
98 float get_processor_param (boost::shared_ptr<Processor> proc, uint32_t which, bool &ok);
100 /** set a plugin control-input parameter value
102 * This is a wrapper around set_processor_param which looks up the Processor by plugin-insert.
104 * @param proc Plugin-Insert
105 * @param which control-input to set (starting at 0)
106 * @param value value to set
107 * @returns true on success, false on error or out-of-bounds value
109 bool set_plugin_insert_param (boost::shared_ptr<ARDOUR::PluginInsert> pi, uint32_t which, float val);
111 /** get a plugin control parameter value
113 * @param proc Plugin-Insert
114 * @param which control port to query (starting at 0, including ports of type input and output)
115 * @param ok boolean variable contains true or false after call returned. to be checked by caller before using value.
118 float get_plugin_insert_param (boost::shared_ptr<ARDOUR::PluginInsert> pi, uint32_t which, bool &ok);
121 * A convenience function to get a Automation Lists and ParamaterDescriptor
122 * for a given plugin control.
124 * This is equivalent to the following lua code
126 * function (processor, param_id)
127 * local plugininsert = processor:to_insert ()
128 * local plugin = plugininsert:plugin(0)
129 * local _, t = plugin:get_parameter_descriptor(param_id, ARDOUR.ParameterDescriptor ())
130 * local ctrl = Evoral.Parameter (ARDOUR.AutomationType.PluginAutomation, 0, param_id)
131 * local ac = pi:automation_control (ctrl, false)
132 * local acl = ac:alist()
133 * return ac:alist(), ac:to_ctrl():list(), t[2]
137 * Example usage: get the third input parameter of first plugin on the given route
138 * (Ardour starts counting at zero).
140 * local al, cl, pd = ARDOUR.LuaAPI.plugin_automation (route:nth_plugin (0), 3)
142 * @returns 3 parameters: AutomationList, ControlList, ParamaterDescriptor
144 int plugin_automation (lua_State *lua);
147 * A convenience function for colorspace HSL to RGB conversion.
148 * All ranges are 0..1
152 * local r, g, b, a = ARDOUR.LuaAPI.hsla_to_rgba (hue, saturation, luminosity, alpha)
154 * @returns 4 parameters: red, green, blue, alpha (in range 0..1)
156 int hsla_to_rgba (lua_State *lua);
158 /* Creates a filename from a series of elements using the correct separator for filenames.
160 * No attempt is made to force the resulting filename to be an absolute path.
161 * If the first element is a relative path, the result will be a relative path.
163 int build_filename (lua_State *lua);
166 /** Vamp Plugin Interface
168 * Vamp is an audio processing plugin system for plugins that extract descriptive information
169 * from audio data - typically referred to as audio analysis plugins or audio feature
170 * extraction plugins.
172 * This interface allows to load a plugins and directly access it using the Vamp Plugin API.
174 * A convenience method is provided to analyze Ardour::Readable objects (Regions).
177 Vamp (const std::string&, float sample_rate);
179 ::Vamp::Plugin* plugin () { return _plugin; }
181 /* high-level abstraction to process a single channel of the given Readable.
183 * If the plugin is not yet initialized, initialize() is called.
185 * if @cb is not nil, it is called with the immediate
186 * Vamp::Plugin::Features on every process call.
189 * @channel channel to process
190 * @cb lua callback function
191 * @return 0 on success
193 int analyze (boost::shared_ptr<ARDOUR::Readable>, uint32_t channel, luabridge::LuaRef fn);
195 /** call plugin():reset() and clear intialization flag */
198 /** initialize the plugin for use with analyze().
200 * This is equivalent to plugin():initialise (1, 512, 1024)
201 * and prepares a plugin for analyze.
203 * Manual initialization is only required to set plugin-parameters
204 * which depend on prior initialization of the plugin.
209 * vamp:plugin():setParameter (0, 1.5, nil)
210 * vamp:analyze (r, 0)
215 bool initialized () const { return _initialized; }
217 /** process given array of audio-samples.
219 * This is a lua-binding for vamp:plugin():process ()
221 * @d audio-data, the vector must match the configured channel count
222 * and hold a complete buffer for every channel as set during
223 * plugin():initialise()
224 * @rt timestamp matching the provided buffer.
225 * @returns features extracted from that data (if the plugin is causal)
227 ::Vamp::Plugin::FeatureSet process (const std::vector<float*>& d, ::Vamp::RealTime rt);
230 ::Vamp::Plugin* _plugin;
233 framecnt_t _stepsize;
240 namespace ARDOUR { namespace LuaOSC {
243 * A Class to send OSC messages.
247 * OSC is kinda special, lo_address is a void* and lo_send() has varags
248 * and typed arguments which makes it hard to bind, even lo_cpp.
251 /** Construct a new OSC transmitter object
252 * @param uri the destination uri e.g. "osc.udp://localhost:7890"
254 Address (std::string uri) {
255 _addr = lo_address_new_from_url (uri.c_str());
258 ~Address () { if (_addr) { lo_address_free (_addr); } }
259 /** Transmit an OSC message
261 * Path (string) and type (string) must always be given.
262 * The number of following args must match the type.
263 * Supported types are:
265 * 'i': integer (lua number)
267 * 'f': float (lua number)
269 * 'd': double (lua number)
271 * 'h': 64bit integer (lua number)
273 * 's': string (lua string)
275 * 'c': character (lua string)
277 * 'T': boolean (lua bool) -- this is not implicily True, a lua true/false must be given
279 * 'F': boolean (lua bool) -- this is not implicily False, a lua true/false must be given
281 * @param lua: lua arguments: path, types, ...
282 * @returns boolean true if successful, false on error.
284 int send (lua_State *lua);
296 int get (lua_State* L);
297 int set (lua_State* L);
300 struct LuaTableEntry {
301 LuaTableEntry (int kt, int vt)
322 std::vector<LuaTableEntry> _data;
324 static void* findclasskey (lua_State *L, const void* key);
326 static void assign (luabridge::LuaRef* rv, T key, const LuaTableEntry& s);
331 #endif // _ardour_lua_api_h_