528 lines
17 KiB
C++
528 lines
17 KiB
C++
/*
|
|
* Copyright (C) 2016-2019 Robin Gareus <robin@gareus.org>
|
|
* Copyright (C) 2017 Paul Davis <paul@linuxaudiosystems.com>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
#ifndef _ardour_lua_api_h_
|
|
#define _ardour_lua_api_h_
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
#include <lo/lo.h>
|
|
#include <boost/enable_shared_from_this.hpp>
|
|
#include <rubberband/RubberBandStretcher.h>
|
|
#include <vamp-hostsdk/Plugin.h>
|
|
|
|
#include "evoral/Note.h"
|
|
|
|
#include "ardour/libardour_visibility.h"
|
|
|
|
#include "ardour/audioregion.h"
|
|
#include "ardour/midi_model.h"
|
|
#include "ardour/processor.h"
|
|
#include "ardour/session.h"
|
|
|
|
namespace ARDOUR {
|
|
class AudioReadable;
|
|
}
|
|
|
|
namespace ARDOUR { namespace LuaAPI {
|
|
|
|
/** convenience constructor for DataType::NIL with managed lifetime
|
|
* @returns DataType::NIL
|
|
*/
|
|
int datatype_ctor_null (lua_State *lua);
|
|
/** convenience constructor for DataType::AUDIO with managed lifetime
|
|
* @returns DataType::AUDIO
|
|
*/
|
|
int datatype_ctor_audio (lua_State *L);
|
|
/** convenience constructor for DataType::MIDI with managed lifetime
|
|
* @returns DataType::MIDI
|
|
*/
|
|
int datatype_ctor_midi (lua_State *L);
|
|
|
|
/** add a new [external] Send to the given Route
|
|
*
|
|
* @param s Session Handle
|
|
* @param r Route to add Send to
|
|
* @param p add send before given processor (or \ref nil_processor to add at the end)
|
|
*/
|
|
std::shared_ptr<Processor> new_send (Session* s, std::shared_ptr<ARDOUR::Route> r, std::shared_ptr<ARDOUR::Processor> p);
|
|
|
|
/** Create a null processor shared pointer
|
|
*
|
|
* This is useful for Track:bounce() to indicate no processing.
|
|
*/
|
|
std::shared_ptr<ARDOUR::Processor> nil_processor ();
|
|
|
|
/** create a new Lua Processor (Plugin)
|
|
*
|
|
* @param s Session Handle
|
|
* @param p Identifier or Name of the Processor
|
|
* @param td Time domain (audio or beats) for any automation data
|
|
* @returns Processor object (may be nil)
|
|
*/
|
|
std::shared_ptr<ARDOUR::Processor> new_luaproc_with_time_domain (ARDOUR::Session *s, const std::string& p, Temporal::TimeDomain td);
|
|
|
|
/* As above but uses default time domain for the session/application */
|
|
std::shared_ptr<ARDOUR::Processor> new_luaproc (ARDOUR::Session *s, const std::string& p);
|
|
|
|
/** List all installed plugins */
|
|
std::list<std::shared_ptr<ARDOUR::PluginInfo> > list_plugins ();
|
|
|
|
/** Write a list of untagged plugins to a file, so we can bulk-tag them
|
|
* @returns path to XML file or empty string on error
|
|
*/
|
|
std::string dump_untagged_plugins ();
|
|
|
|
/** search a Plugin
|
|
*
|
|
* @param id Plugin Name, ID or URI
|
|
* @param type Plugin Type
|
|
* @returns PluginInfo or nil if not found
|
|
*/
|
|
std::shared_ptr<ARDOUR::PluginInfo> new_plugin_info (const std::string& id, ARDOUR::PluginType type);
|
|
|
|
/** create a new Plugin Instance
|
|
*
|
|
* @param s Session Handle
|
|
* @param id Plugin Name, ID or URI
|
|
* @param type Plugin Type
|
|
* @param preset name of plugin-preset to load, leave empty "" to not load any preset after instantiation
|
|
* @param td Time domain for any automation data
|
|
* @returns Processor or nil
|
|
*/
|
|
std::shared_ptr<ARDOUR::Processor> new_plugin_with_time_domain (ARDOUR::Session *s, const std::string& id, ARDOUR::PluginType type, Temporal::TimeDomain td, const std::string& preset = "");
|
|
|
|
/* As above but uses default time domain for the session/application */
|
|
std::shared_ptr<ARDOUR::Processor> new_plugin (ARDOUR::Session *s, const std::string& id, ARDOUR::PluginType type, const std::string& preset = "");
|
|
|
|
/** set a plugin control-input parameter value
|
|
*
|
|
* @param proc Plugin-Processor
|
|
* @param which control-input to set (starting at 0)
|
|
* @param value value to set
|
|
* @returns true on success, false on error or out-of-bounds value
|
|
*/
|
|
bool set_processor_param (std::shared_ptr<ARDOUR::Processor> proc, uint32_t which, float value);
|
|
|
|
/** get a plugin control parameter value
|
|
*
|
|
* @param proc Plugin-Processor
|
|
* @param which control port to set (starting at 0, including ports of type input and output))
|
|
* @param ok boolean variable contains true or false after call returned. to be checked by caller before using value.
|
|
* @returns value
|
|
*/
|
|
float get_processor_param (std::shared_ptr<Processor> proc, uint32_t which, bool &ok);
|
|
|
|
/** reset a processor to its default values (only works for plugins )
|
|
*
|
|
* This is a wrapper which looks up the Processor by plugin-insert.
|
|
*
|
|
* @param proc Plugin-Insert
|
|
* @returns true on success, false when the processor is not a plugin
|
|
*/
|
|
bool reset_processor_to_default (std::shared_ptr<Processor> proc);
|
|
|
|
/** set a plugin control-input parameter value
|
|
*
|
|
* This is a wrapper around set_processor_param which looks up the Processor by plugin-insert.
|
|
*
|
|
* @param pi Plugin-Insert
|
|
* @param which control-input to set (starting at 0)
|
|
* @param value value to set
|
|
* @returns true on success, false on error or out-of-bounds value
|
|
*/
|
|
bool set_plugin_insert_param (std::shared_ptr<ARDOUR::PluginInsert> pi, uint32_t which, float value);
|
|
|
|
/** get a plugin control parameter value
|
|
*
|
|
* @param pi Plugin-Insert
|
|
* @param which control port to query (starting at 0, including ports of type input and output)
|
|
* @param ok boolean variable contains true or false after call returned. to be checked by caller before using value.
|
|
* @returns value
|
|
*/
|
|
float get_plugin_insert_param (std::shared_ptr<ARDOUR::PluginInsert> pi, uint32_t which, bool &ok);
|
|
|
|
/** set a plugin property (LV2 plugins only)
|
|
*
|
|
* @param pi Plugin-Insert
|
|
* @param uri the identifier of the parameter
|
|
* @param value the value to set (boolean, integer, float, string/path)
|
|
* @returns true on success, false if the given plugin has no property with the given URI
|
|
*/
|
|
bool set_plugin_insert_property (std::shared_ptr<ARDOUR::PluginInsert> pi, std::string const& uri, luabridge::LuaRef value);
|
|
|
|
/** get a plugin property (LV2 plugins only)
|
|
*
|
|
* @param p two arguments: Plugin-Inster, URI of the property
|
|
* @param value the value to set (boolean, integer, float, string/path)
|
|
* @returns value, depending on datatype or nil if property is not found
|
|
*/
|
|
int get_plugin_insert_property (lua_State *lua);
|
|
|
|
/**
|
|
* A convenience function to get a Automation Lists and ParameterDescriptor
|
|
* for a given plugin control.
|
|
*
|
|
* This is equivalent to the following lua code
|
|
* @code
|
|
* function (processor, param_id)
|
|
* local plugininsert = processor:to_insert ()
|
|
* local plugin = plugininsert:plugin(0)
|
|
* local _, t = plugin:get_parameter_descriptor(param_id, ARDOUR.ParameterDescriptor ())
|
|
* local ctrl = Evoral.Parameter (ARDOUR.AutomationType.PluginAutomation, 0, param_id)
|
|
* local ac = pi:automation_control (ctrl, false)
|
|
* local acl = ac:alist()
|
|
* return ac:alist(), ac:to_ctrl():list(), t[2]
|
|
* end
|
|
* @endcode
|
|
*
|
|
* Example usage: get the third input parameter of first plugin on the given route
|
|
* (Ardour starts counting at zero).
|
|
* @code
|
|
* local al, cl, pd = ARDOUR.LuaAPI.plugin_automation (route:nth_plugin (0), 3)
|
|
* @endcode
|
|
* @returns 3 parameters: AutomationList, ControlList, ParameterDescriptor
|
|
*/
|
|
int plugin_automation (lua_State *lua);
|
|
|
|
/*
|
|
* A convenience function to get a scale-points from a ParameterDescriptor
|
|
* @param p a ParameterDescriptor
|
|
* @returns Lua Table with "name" -> value pairs
|
|
*/
|
|
int desc_scale_points (lua_State* p);
|
|
|
|
/* Replace all automation data for an AutomationContol from a Lua table
|
|
* @param ac an AutomationControl
|
|
* @param tbl Lua Table {[sample-time] = value}
|
|
* @param thin thinning factor (-1; use default, 0: no thinning)
|
|
* @returns true on success
|
|
*/
|
|
bool set_automation_data (std::shared_ptr<ARDOUR::AutomationControl> ac, luabridge::LuaRef tbl, double thin = -1);
|
|
|
|
/**
|
|
* A convenience function for colorspace HSL to RGB conversion.
|
|
* All ranges are 0..1
|
|
*
|
|
* Example:
|
|
* @code
|
|
* local r, g, b, a = ARDOUR.LuaAPI.hsla_to_rgba (hue, saturation, luminosity, alpha)
|
|
* @endcode
|
|
* @returns 4 parameters: red, green, blue, alpha (in range 0..1)
|
|
*/
|
|
int hsla_to_rgba (lua_State *lua);
|
|
|
|
/**
|
|
* A convenience function to expand RGBA parameters from an integer
|
|
*
|
|
* convert a Canvas::Color (uint32_t 0xRRGGBBAA) into
|
|
* double RGBA values which can be passed as parameters to
|
|
* Cairo::Context::set_source_rgba
|
|
*
|
|
* Example:
|
|
* @code
|
|
* local r, g, b, a = ARDOUR.LuaAPI.color_to_rgba (0x88aa44ff)
|
|
* cairo_ctx:set_source_rgba (ARDOUR.LuaAPI.color_to_rgba (0x11336699)
|
|
* @endcode
|
|
* @returns 4 parameters: red, green, blue, alpha (in range 0..1)
|
|
*/
|
|
int color_to_rgba (lua_State *lua);
|
|
|
|
/**
|
|
*/
|
|
std::string ascii_dtostr (const double d);
|
|
|
|
/**
|
|
* Creates a filename from a series of elements using the correct separator for filenames.
|
|
*
|
|
* No attempt is made to force the resulting filename to be an absolute path.
|
|
* If the first element is a relative path, the result will be a relative path.
|
|
*/
|
|
int build_filename (lua_State *lua);
|
|
|
|
/**
|
|
* Generic conversion from audio sample count to timecode.
|
|
* (TimecodeType, sample-rate, sample-pos)
|
|
*/
|
|
int sample_to_timecode (lua_State *L);
|
|
|
|
/**
|
|
* Generic conversion from timecode to audio sample count.
|
|
* (TimecodeType, sample-rate, hh, mm, ss, ff)
|
|
*/
|
|
int timecode_to_sample (lua_State *L);
|
|
|
|
/**
|
|
* Use current session settings to convert
|
|
* audio-sample count into hh, mm, ss, ff
|
|
* timecode (this include session pull up/down).
|
|
*/
|
|
int sample_to_timecode_lua (lua_State *L);
|
|
|
|
/**
|
|
* Use current session settings to convert
|
|
* timecode (hh, mm, ss, ff) to audio-sample
|
|
* count (this include session pull up/down).
|
|
*/
|
|
int timecode_to_sample_lua (lua_State *L);
|
|
|
|
/** create a \ref SimpleExport Object
|
|
* for the current session
|
|
*/
|
|
int simple_export (lua_State* L);
|
|
|
|
/**
|
|
* Delay execution until next process cycle starts.
|
|
* @param n_cycles process-cycles to wait for.
|
|
* 0: means wait until next cycle-start, otherwise skip given number of cycles.
|
|
* @param timeout_ms wait at most this many milliseconds
|
|
* @return true on success, false if timeout was reached or engine was not running
|
|
*/
|
|
bool wait_for_process_callback (size_t n_cycles, int64_t timeout_ms);
|
|
|
|
/** Crash Test Dummy */
|
|
void segfault ();
|
|
|
|
/** Return system environment variables (POSIX environ) */
|
|
std::vector<std::string> env ();
|
|
|
|
class Vamp {
|
|
/** Vamp Plugin Interface
|
|
*
|
|
* Vamp is an audio processing plugin system for plugins that extract descriptive information
|
|
* from audio data - typically referred to as audio analysis plugins or audio feature
|
|
* extraction plugins.
|
|
*
|
|
* This interface allows to load a plugins and directly access it using the Vamp Plugin API.
|
|
*
|
|
* A convenience method is provided to analyze Ardour::AudioReadable objects (Regions).
|
|
*/
|
|
public:
|
|
Vamp (const std::string&, float sample_rate);
|
|
~Vamp ();
|
|
|
|
/** Search for all available available Vamp plugins.
|
|
* @returns list of plugin-keys
|
|
*/
|
|
static std::vector<std::string> list_plugins ();
|
|
|
|
::Vamp::Plugin* plugin () { return _plugin; }
|
|
|
|
/** high-level abstraction to process a single channel of the given AudioReadable.
|
|
*
|
|
* If the plugin is not yet initialized, initialize() is called.
|
|
*
|
|
* if \p fn is not nil, it is called with the immediate
|
|
* Vamp::Plugin::Features on every process call.
|
|
*
|
|
* @param r readable
|
|
* @param channel channel to process
|
|
* @param fn lua callback function or nil
|
|
* @return 0 on success
|
|
*/
|
|
int analyze (std::shared_ptr<ARDOUR::AudioReadable> r, uint32_t channel, luabridge::LuaRef fn);
|
|
|
|
/** call plugin():reset() and clear initialization flag */
|
|
void reset ();
|
|
|
|
/** initialize the plugin for use with analyze().
|
|
*
|
|
* This is equivalent to plugin():initialise (1, ssiz, bsiz)
|
|
* and prepares a plugin for analyze.
|
|
* (by preferred step and block sizes are used. if the plugin
|
|
* does not specify them or they're larger than 8K, both are set to 1024)
|
|
*
|
|
* Manual initialization is only required to set plugin-parameters
|
|
* which depend on prior initialization of the plugin.
|
|
*
|
|
* @code
|
|
* vamp:reset ()
|
|
* vamp:initialize ()
|
|
* vamp:plugin():setParameter (0, 1.5, nil)
|
|
* vamp:analyze (r, 0)
|
|
* @endcode
|
|
*/
|
|
bool initialize ();
|
|
|
|
bool initialized () const { return _initialized; }
|
|
|
|
/** process given array of audio-samples.
|
|
*
|
|
* This is a lua-binding for vamp:plugin():process ()
|
|
*
|
|
* @param d audio-data, the vector must match the configured channel count
|
|
* and hold a complete buffer for every channel as set during
|
|
* plugin():initialise()
|
|
* @param rt timestamp matching the provided buffer.
|
|
* @returns features extracted from that data (if the plugin is causal)
|
|
*/
|
|
::Vamp::Plugin::FeatureSet process (const std::vector<float*>& d, ::Vamp::RealTime rt);
|
|
|
|
private:
|
|
::Vamp::Plugin* _plugin;
|
|
float _sample_rate;
|
|
samplecnt_t _bufsize;
|
|
samplecnt_t _stepsize;
|
|
bool _initialized;
|
|
|
|
};
|
|
|
|
class Rubberband : public AudioReadable , public std::enable_shared_from_this<Rubberband>
|
|
{
|
|
public:
|
|
Rubberband (std::shared_ptr<AudioRegion>, bool percussive);
|
|
~Rubberband ();
|
|
bool set_strech_and_pitch (double stretch_ratio, double pitch_ratio);
|
|
bool set_mapping (luabridge::LuaRef tbl);
|
|
std::shared_ptr<AudioRegion> process (luabridge::LuaRef cb);
|
|
std::shared_ptr<AudioReadable> readable ();
|
|
|
|
/* audioreadable API */
|
|
samplecnt_t readable_length_samples () const { return _read_len; }
|
|
uint32_t n_channels () const { return _n_channels; }
|
|
samplecnt_t read (Sample*, samplepos_t pos, samplecnt_t cnt, int channel) const;
|
|
|
|
private:
|
|
Rubberband (Rubberband const&); // no copy construction
|
|
bool read_region (bool study);
|
|
bool retrieve (float**);
|
|
void cleanup (bool abort);
|
|
std::shared_ptr<AudioRegion> finalize ();
|
|
|
|
std::shared_ptr<AudioRegion> _region;
|
|
|
|
uint32_t _n_channels;
|
|
samplecnt_t _read_len;
|
|
samplecnt_t _read_start;
|
|
samplecnt_t _read_offset;
|
|
|
|
std::vector<std::shared_ptr<AudioSource> > _asrc;
|
|
|
|
RubberBand::RubberBandStretcher _rbs;
|
|
std::map<size_t, size_t> _mapping;
|
|
|
|
double _stretch_ratio;
|
|
double _pitch_ratio;
|
|
|
|
luabridge::LuaRef* _cb;
|
|
std::shared_ptr<Rubberband> _self;
|
|
static const samplecnt_t _bufsize;
|
|
};
|
|
|
|
std::shared_ptr<Evoral::Note<Temporal::Beats> >
|
|
new_noteptr (uint8_t, Temporal::Beats, Temporal::Beats, uint8_t, uint8_t);
|
|
|
|
std::list<std::shared_ptr< Evoral::Note<Temporal::Beats> > >
|
|
note_list (std::shared_ptr<ARDOUR::MidiModel>);
|
|
|
|
} } /* namespace */
|
|
|
|
namespace ARDOUR { namespace LuaOSC {
|
|
/** OSC transmitter
|
|
*
|
|
* A Class to send OSC messages.
|
|
*/
|
|
class Address {
|
|
/*
|
|
* OSC is kinda special, lo_address is a void* and lo_send() has varags
|
|
* and typed arguments which makes it hard to bind, even lo_cpp.
|
|
*/
|
|
public:
|
|
/** Construct a new OSC transmitter object
|
|
* @param uri the destination uri e.g. "osc.udp://localhost:7890"
|
|
*/
|
|
Address (std::string uri) {
|
|
_addr = lo_address_new_from_url (uri.c_str());
|
|
}
|
|
|
|
~Address () { if (_addr) { lo_address_free (_addr); } }
|
|
/** Transmit an OSC message
|
|
*
|
|
* Path (string) and type (string) must always be given.
|
|
* The number of following args must match the type.
|
|
* Supported types are:
|
|
*
|
|
* 'i': integer (lua number)
|
|
*
|
|
* 'f': float (lua number)
|
|
*
|
|
* 'd': double (lua number)
|
|
*
|
|
* 'h': 64bit integer (lua number)
|
|
*
|
|
* 's': string (lua string)
|
|
*
|
|
* 'c': character (lua string)
|
|
*
|
|
* 'T': boolean (lua bool) -- this is not implicily True, a lua true/false must be given
|
|
*
|
|
* 'F': boolean (lua bool) -- this is not implicily False, a lua true/false must be given
|
|
*
|
|
* @param lua: lua arguments: path, types, ...
|
|
* @returns boolean true if successful, false on error.
|
|
*/
|
|
int send (lua_State *lua);
|
|
private:
|
|
lo_address _addr;
|
|
};
|
|
|
|
}
|
|
|
|
class LuaTableRef {
|
|
public:
|
|
LuaTableRef ();
|
|
~LuaTableRef ();
|
|
|
|
int get (lua_State* L);
|
|
int set (lua_State* L);
|
|
|
|
private:
|
|
struct LuaTableEntry {
|
|
LuaTableEntry (int kt, int vt)
|
|
: keytype (kt)
|
|
, valuetype (vt)
|
|
{ }
|
|
|
|
int keytype;
|
|
std::string k_s;
|
|
unsigned int k_n;
|
|
|
|
int valuetype;
|
|
// LUA_TUSERDATA
|
|
const void* c;
|
|
void* p;
|
|
// LUA_TBOOLEAN
|
|
bool b;
|
|
// LUA_TSTRING:
|
|
std::string s;
|
|
// LUA_TNUMBER:
|
|
double n;
|
|
};
|
|
|
|
std::vector<LuaTableEntry> _data;
|
|
|
|
static void* findclasskey (lua_State *L, const void* key);
|
|
template<typename T>
|
|
static void assign (luabridge::LuaRef* rv, T key, const LuaTableEntry& s);
|
|
};
|
|
|
|
} /* namespace */
|
|
|
|
#endif // _ardour_lua_api_h_
|