libs/ardour/ardour/luaproc.h

   1 /*
   2     Copyright (C) 2016 Robin Gareus <robin@gareus.org>
   3     Copyright (C) 2006 Paul Davis
   4
   5     This program is free software; you can redistribute it and/or modify it
   6     under the terms of the GNU General Public License as published by the Free
   7     Software Foundation; either version 2 of the License, or (at your option)
   8     any later version.
   9
  10     This program is distributed in the hope that it will be useful, but WITHOUT
  11     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13     for more details.
  14
  15     You should have received a copy of the GNU General Public License along
  16     with this program; if not, write to the Free Software Foundation, Inc.,
  17     675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #ifndef __ardour_luaproc_h__
  21 #define __ardour_luaproc_h__
  22
  23 #include <set>
  24 #include <vector>
  25 #include <string>
  26
  27 #include "pbd/reallocpool.h"
  28 #include "pbd/stateful.h"
  29
  30 #include "ardour/types.h"
  31 #include "ardour/plugin.h"
  32 #include "ardour/luascripting.h"
  33 #include "ardour/dsp_filter.h"
  34
  35 #include "lua/luastate.h"
  36 #include "LuaBridge/LuaBridge.h"
  37
  38 namespace ARDOUR {
  39
  40 class LIBARDOUR_API LuaProc : public ARDOUR::Plugin {
  41 public:
  42         LuaProc (AudioEngine&, Session&, const std::string&);
  43         LuaProc (const LuaProc &);
  44         ~LuaProc ();
  45
  46         /* Plugin interface */
  47
  48         std::string unique_id() const { return get_info()->unique_id; }
  49         const char* name()  const { return get_info()->name.c_str(); }
  50         const char* label() const { return get_info()->name.c_str(); }
  51         const char* maker() const { return get_info()->creator.c_str(); }
  52
  53         uint32_t    parameter_count() const;
  54         float       default_value (uint32_t port);
  55         void        set_parameter (uint32_t port, float val);
  56         float       get_parameter (uint32_t port) const;
  57         int         get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
  58         uint32_t    nth_parameter (uint32_t port, bool& ok) const;
  59
  60         std::string get_docs () const { return _docs; }
  61         std::string get_parameter_docs (uint32_t) const;
  62
  63         std::set<Evoral::Parameter> automatable() const;
  64
  65         void activate () { }
  66         void deactivate () { }
  67         void cleanup () { }
  68
  69         int set_block_size (pframes_t /*nframes*/) { return 0; }
  70         framecnt_t  signal_latency() const { return 0; }
  71
  72         int connect_and_run (BufferSet& bufs,
  73                         ChanMapping in, ChanMapping out,
  74                         pframes_t nframes, framecnt_t offset);
  75
  76         std::string describe_parameter (Evoral::Parameter);
  77         void        print_parameter (uint32_t, char*, uint32_t len) const;
  78         boost::shared_ptr<ScalePoints> get_scale_points(uint32_t port_index) const;
  79
  80         bool parameter_is_audio (uint32_t) const { return false; }
  81         bool parameter_is_control (uint32_t) const { return true; }
  82         bool parameter_is_input (uint32_t) const;
  83         bool parameter_is_output (uint32_t) const;
  84
  85         std::string state_node_name() const { return "luaproc"; }
  86         void add_state (XMLNode *) const;
  87         int set_state (const XMLNode&, int version);
  88         int set_script_from_state (const XMLNode&);
  89
  90         bool load_preset (PresetRecord) { return false; }
  91         bool has_editor() const { return false; }
  92
  93         bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
  94         bool configure_io (ChanCount in, ChanCount out);
  95
  96         ChanCount output_streams() const { return _configured_out; }
  97         ChanCount input_streams() const { return _configured_in; }
  98
  99         std::string do_save_preset (std::string) { return ""; }
 100         void do_remove_preset (std::string) { }
 101
 102         bool has_inline_display () { return _lua_has_inline_display; }
 103         void setup_lua_inline_gui (LuaState *lua_gui);
 104
 105 private:
 106         void find_presets () { }
 107
 108         /* END Plugin interface */
 109 protected:
 110         const std::string& script() const { return _script; }
 111
 112 private:
 113         PBD::ReallocPool _mempool;
 114         LuaState lua;
 115         luabridge::LuaRef * _lua_dsp;
 116         std::string _script;
 117         std::string _docs;
 118         bool _lua_does_channelmapping;
 119         bool _lua_has_inline_display;
 120
 121         void queue_draw () { QueueDraw(); /* EMIT SIGNAL */ }
 122         DSP::DspShm* instance_shm () { return &lshm; }
 123         DSP::DspShm lshm;
 124
 125         void init ();
 126         bool load_script ();
 127         void lua_print (std::string s);
 128
 129         boost::shared_ptr<ScalePoints> parse_scale_points (luabridge::LuaRef*);
 130
 131         std::vector<std::pair<bool, int> > _ctrl_params;
 132         std::map<int, ARDOUR::ParameterDescriptor> _param_desc;
 133         std::map<int, std::string> _param_doc;
 134
 135         float* _control_data;
 136         float* _shadow_data;
 137
 138         ChanCount _configured_in;
 139         ChanCount _configured_out;
 140
 141         bool _has_midi_input;
 142         bool _has_midi_output;
 143
 144 #ifdef WITH_LUAPROC_STATS
 145         int64_t _stats_avg[2];
 146         int64_t _stats_max[2];
 147         int64_t _stats_cnt;
 148 #endif
 149 };
 150
 151 class LIBARDOUR_API LuaPluginInfo : public PluginInfo
 152 {
 153   public:
 154         LuaPluginInfo (LuaScriptInfoPtr lsi);
 155         ~LuaPluginInfo () { };
 156
 157         PluginPtr load (Session& session);
 158         std::vector<Plugin::PresetRecord> get_presets (bool user_only) const;
 159
 160         bool is_instrument () const { return false; }
 161         bool reconfigurable_io() const { return true; }
 162 };
 163
 164 typedef boost::shared_ptr<LuaPluginInfo> LuaPluginInfoPtr;
 165
 166 } // namespace ARDOUR
 167
 168 #endif // __ardour_luaproc_h__