luaproc.h

Go to the documentation of this file.

/*
 * Copyright (C) 2016-2019 Robin Gareus <robin@gareus.org>
 *
 * 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.
 */
 
/* print runtime and garbage-collection timing statistics */
//#define WITH_LUAPROC_STATS
 
/* memory allocation system, default: ReallocPool */
//#define USE_TLSF // use TLSF instead of ReallocPool
//#define USE_MALLOC // or plain OS provided realloc (no mlock) -- if USE_TLSF isn't defined
 
#ifndef __ardour_luaproc_h__
#define __ardour_luaproc_h__
 
#include <set>
#include <vector>
#include <string>
 
#ifdef USE_TLSF
#  include "pbd/tlsf.h"
#else
#  include "pbd/reallocpool.h"
#endif
 
#include "pbd/stateful.h"
 
#include "ardour/types.h"
#include "ardour/plugin.h"
#include "ardour/luascripting.h"
#include "ardour/dsp_filter.h"
#include "ardour/lua_api.h"
 
#include "lua/luastate.h"
 
namespace luabridge {
        class LuaRef;
}
 
namespace ARDOUR {
 
class LIBARDOUR_API LuaProc : public ARDOUR::Plugin {
public:
        LuaProc (AudioEngine&, Session&, const std::string&);
        LuaProc (const LuaProc &);
        ~LuaProc ();
 
        /* Plugin interface */
 
        std::string unique_id() const { return get_info()->unique_id; }
        const char* name()  const { return get_info()->name.c_str(); }
        const char* label() const { return get_info()->name.c_str(); }
        const char* maker() const { return get_info()->creator.c_str(); }
 
        uint32_t    parameter_count() const;
        float       default_value (uint32_t port);
        void        set_parameter (uint32_t port, float val, sampleoffset_t);
        float       get_parameter (uint32_t port) const;
        int         get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
        uint32_t    nth_parameter (uint32_t port, bool& ok) const;
 
        std::string get_docs () const { return _docs; }
        std::string get_parameter_docs (uint32_t) const;
 
        PluginOutputConfiguration possible_output () const { return _output_configs; }
 
        void drop_references ();
 
        std::set<Evoral::Parameter> automatable() const;
 
        void activate () { }
        void deactivate () { }
        void cleanup () { }
 
        int set_block_size (pframes_t /*nframes*/) { return 0; }
        bool requires_fixed_sized_buffers () const { return _requires_fixed_sized_buffers; }
        bool connect_all_audio_outputs () const { return _connect_all_audio_outputs; }
 
        int connect_and_run (BufferSet& bufs,
                        samplepos_t start, samplepos_t end, double speed,
                        ChanMapping const& in, ChanMapping const& out,
                        pframes_t nframes, samplecnt_t offset);
 
        std::string describe_parameter (Evoral::Parameter);
        std::shared_ptr<ScalePoints> get_scale_points(uint32_t port_index) const;
 
        bool parameter_is_audio (uint32_t) const { return false; }
        bool parameter_is_control (uint32_t) const { return true; }
        bool parameter_is_input (uint32_t) const;
        bool parameter_is_output (uint32_t) const;
 
        uint32_t designated_bypass_port () {
                return _designated_bypass_port;
        }
 
        std::string state_node_name() const { return "luaproc"; }
        void add_state (XMLNode *) const;
        int set_state (const XMLNode&, int version);
        int set_script_from_state (const XMLNode&);
 
        bool load_preset (PresetRecord);
        std::string do_save_preset (std::string);
        void do_remove_preset (std::string);
 
        bool has_editor() const { return false; }
 
        bool match_variable_io (ChanCount& in, ChanCount& aux_in, ChanCount& out);
        bool reconfigure_io (ChanCount in, ChanCount aux_in, ChanCount out);
 
        ChanCount output_streams() const { return _configured_out; }
        ChanCount input_streams() const { return _configured_in; }
 
        bool has_inline_display () { return _lua_has_inline_display; }
        void setup_lua_inline_gui (LuaState *lua_gui);
 
        DSP::DspShm* instance_shm () { return &lshm; }
        LuaTableRef* instance_ref () { return &lref; }
 
        struct FactoryPreset {
                std::string               name;
                std::map<uint32_t, float> param;
        };
 
        std::map<std::string, FactoryPreset> _factory_presets;
 
private:
        samplecnt_t plugin_latency() const { return _signal_latency; }
        void find_presets ();
 
        /* END Plugin interface */
 
public:
        void set_origin (std::string& path) { _origin = path; }
 
protected:
        const std::string& script() const { return _script; }
        const std::string& origin() const { return _origin; }
 
private:
#ifdef USE_TLSF
        PBD::TLSF _mempool;
#else
        PBD::ReallocPool _mempool;
#endif
        LuaState lua;
        luabridge::LuaRef * _lua_dsp;
        luabridge::LuaRef * _lua_latency;
        std::string _script;
        std::string _origin;
        std::string _docs;
        bool _lua_does_channelmapping;
        bool _lua_has_inline_display;
        bool _requires_fixed_sized_buffers;
        bool _connect_all_audio_outputs;
        bool _set_time_info;
 
        void queue_draw () { QueueDraw(); /* EMIT SIGNAL */ }
        DSP::DspShm lshm;
 
        LuaTableRef lref;
 
        std::weak_ptr<Route> route () const;
 
        void init ();
        bool load_script ();
        void lua_print (std::string s);
 
        bool load_user_preset (PresetRecord const&);
        bool load_factory_preset (PresetRecord const&);
 
        std::string preset_name_to_uri (const std::string&) const;
        std::string presets_file () const;
        XMLTree* presets_tree () const;
 
        std::shared_ptr<ScalePoints> parse_scale_points (luabridge::LuaRef*);
 
        std::vector<std::pair<bool, int> > _ctrl_params;
        std::map<int, ARDOUR::ParameterDescriptor> _param_desc;
        std::map<int, std::string> _param_doc;
        uint32_t _designated_bypass_port;
 
        samplecnt_t _signal_latency;
 
        float* _control_data;
        float* _shadow_data;
 
        ChanCount _configured_in;
        ChanCount _configured_out;
 
        bool      _configured;
 
        ChanCount _selected_in;
        ChanCount _selected_out;
 
        PluginOutputConfiguration _output_configs;
 
        bool _has_midi_input;
        bool _has_midi_output;
 
 
#ifdef WITH_LUAPROC_STATS
        int64_t _stats_avg[2];
        int64_t _stats_max[2];
        int64_t _stats_cnt;
#endif
};
 
class LIBARDOUR_API LuaPluginInfo : public PluginInfo
{
  public:
        LuaPluginInfo (LuaScriptInfoPtr lsi);
        ~LuaPluginInfo () { };
 
        PluginPtr load (Session& session);
        std::vector<Plugin::PresetRecord> get_presets (bool user_only) const;
 
        bool reconfigurable_io() const { return true; }
        uint32_t max_configurable_outputs () const {
                return _max_outputs;
        }
 
        void set_factory_presets (std::vector<Plugin::PresetRecord> const& p) {
                _factory_presets = p;
        }
 
        private:
        uint32_t _max_outputs;
 
        std::vector<Plugin::PresetRecord> _factory_presets;
};
 
typedef std::shared_ptr<LuaPluginInfo> LuaPluginInfoPtr;
 
} // namespace ARDOUR
 
#endif // __ardour_luaproc_h__