//=========================================================
//  MusE
//  Linux Music Editor
//  $Id: plugin.h,v 1.9.2.13 2009/12/06 01:25:21 terminator356 Exp $
//
//  (C) Copyright 2000 Werner Schweer (ws@seh.de)
//  (C) Copyright 2011-2016 Tim E. Real (terminator356 on sourceforge)
//
//  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; 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 __PLUGIN_H__
#define __PLUGIN_H__

#include <list>
#include <vector>
#include <QSet>
#include <QMap>
#include <QPair>
#include <QFileInfo>
#include <QMainWindow>
#include <QMouseEvent>
#include <QUiLoader>
#include <QRect>
#include <QList>
#include <QMetaObject>

#include <ladspa.h>

#include "globaldefs.h"
#include "ctrl.h"
#include "controlfifo.h"
#include "config.h"

#ifdef OSC_SUPPORT
#include "osc.h"
#endif

#ifdef DSSI_SUPPORT
#include <dssi.h>
#endif

// BUG I have filed a Qt bug report 64773. If we do NOT
//  set a position on a new QWidget, Qt seems to take control
//  of the position management such that it will NOT accept
//  any new position after that! It seems to decide to
//  remain in 'auto-placement' mode forever.
// If the bug is ever fixed by Qt, this define should then
//  become version-sensitive.         2017/11/28 Tim.
#define QT_SHOW_POS_BUG_WORKAROUND 1;


// Forward declarations:
class QScrollArea;
class QShowEvent;
class QHideEvent;
class QAction;
class QSpinBox;
class QToolButton;

namespace MusEGui {
class PluginGui;
class DoubleLabel;
class DoubleText;
}

namespace MusEPlugin {
class PluginScanInfoStruct;
}

namespace MusECore {
class AudioTrack;
class Xml;

class PluginI;

//---------------------------------------------------------
//   Plugin
//---------------------------------------------------------

class Plugin {

   protected:
   friend class PluginI;

      void* _handle;
      int _references;
      int _instNo;
      QFileInfo fi;
      // Universal resource identifier, for plugins that use it (LV2).
      // If this exists, it should be used INSTEAD of file info, for comparison etc.
      // Never rely on the file info if a uri exists.
      QString _uri;
      LADSPA_Descriptor_Function ladspa;
      const LADSPA_Descriptor *plugin;
      unsigned long _uniqueID;
      QString _label;
      QString _name;
      QString _maker;
      QString _copyright;

      bool _isDssiSynth;
      bool _isDssi;
      bool _isLV2Synth;
      bool _isLV2Plugin;
      // Hack: Special flag required.
      bool _isDssiVst;
      bool _isVstNativeSynth;
      bool _isVstNativePlugin;

      #ifdef DSSI_SUPPORT
      const DSSI_Descriptor* dssi_descr;
      #endif

      unsigned long _portCount;
      unsigned long _inports;
      unsigned long _outports;
      unsigned long _controlInPorts;
      unsigned long _controlOutPorts;
      std::vector<unsigned long> rpIdx; // Port number to control input index. Item is -1 if it's not a control input.

      bool _usesTimePosition;
      unsigned long _freewheelPortIndex;
      unsigned long _latencyPortIndex;
      unsigned long _enableOrBypassPortIndex;
      PluginLatencyReportingType _pluginLatencyReportingType;
      PluginBypassType _pluginBypassType;
      PluginFreewheelType _pluginFreewheelType;

      PluginFeatures_t _requiredFeatures;

   public:
      Plugin();
      Plugin(const MusEPlugin::PluginScanInfoStruct&);
      virtual ~Plugin();
      virtual PluginFeatures_t requiredFeatures() const { return _requiredFeatures; }
      QString uri() const                          { return _uri; }
      virtual QString label() const                        { return _label; }
      QString name() const                         { return _name; }
      unsigned long id() const                     { return _uniqueID; }
      QString maker() const                        { return _maker; }
      QString copyright() const                    { return _copyright; }
      QString lib(bool complete = true) const      { return complete ? fi.completeBaseName() : fi.baseName(); } // ddskrjo const
      QString dirPath(bool complete = true) const  { return complete ? fi.absolutePath() : fi.path(); }
      QString filePath() const                     { return fi.filePath(); }
      QString fileName() const                     { return fi.fileName(); }
        
      int references() const                       { return _references; }
      virtual int incReferences(int);
      int instNo()                                 { return _instNo++;        }

      inline bool isDssiPlugin() const { return _isDssi; }
      inline bool isDssiSynth() const  { return _isDssiSynth; }
      inline bool isDssiVst() const  { return _isDssiVst; }
      inline bool isLV2Plugin() const { return _isLV2Plugin; } //inline it to use in RT audio thread
      inline bool isLV2Synth() const { return _isLV2Synth; }
      inline bool isVstNativePlugin() const { return _isVstNativePlugin; } //inline it to use in RT audio thread
      inline bool isVstNativeSynth() const { return _isVstNativeSynth; }

      virtual LADSPA_Handle instantiate(PluginI *);
      virtual void activate(LADSPA_Handle handle) {
            if (plugin && plugin->activate)
                  plugin->activate(handle);
            }
      virtual void deactivate(LADSPA_Handle handle) {
            if (plugin && plugin->deactivate)
                  plugin->deactivate(handle);
            }
      virtual void cleanup(LADSPA_Handle handle) {
            if (plugin && plugin->cleanup)
                  plugin->cleanup(handle);
            }
      virtual void connectPort(LADSPA_Handle handle, unsigned long port, float* value) {
            if(plugin)
              plugin->connect_port(handle, port, value);
            }
      virtual void apply(LADSPA_Handle handle, unsigned long n, float /*latency_corr*/ = 0.0f);

      #ifdef OSC_SUPPORT
      int oscConfigure(LADSPA_Handle handle, const char* key, const char* value);
      #endif

      unsigned long ports() { return _portCount; }

      virtual LADSPA_PortDescriptor portd(unsigned long k) const {
            return plugin ? plugin->PortDescriptors[k] : 0;
            }

      // This version of range does not apply any changes, such as sample rate, to the bounds.
      // The information returned is verbose. See the other range() which does apply changes.
      virtual LADSPA_PortRangeHint range(unsigned long i) const {
            // FIXME:
            //return plugin ? plugin->PortRangeHints[i] : 0; DELETETHIS
            return plugin->PortRangeHints[i];
            }

      virtual double defaultValue(unsigned long port) const;
      // This version of range applies any changes, such as sample rate, to the bounds.
      // The information returned is not verbose. See the other range() which does not apply changes.
      virtual void range(unsigned long i, float*, float*) const;
      virtual CtrlValueType ctrlValueType(unsigned long i) const;
      virtual CtrlList::Mode ctrlMode(unsigned long i) const;
      virtual const CtrlVal::CtrlEnumValues* ctrlEnumValues ( unsigned long ) const;
      // Returns a value unit string for displaying unit symbols.
      virtual QString unitSymbol ( unsigned long ) const;
      // Returns index into the global value units for displaying unit symbols.
      // Can be -1 meaning no units.
      virtual int valueUnit ( unsigned long ) const;

      virtual const char* portName(unsigned long i) const {
            return plugin ? plugin->PortNames[i] : 0;
            }

      bool usesTimePosition() const;
      unsigned long freewheelPortIndex() const;
      unsigned long latencyPortIndex() const;
      unsigned long enableOrBypassPortIndex() const;
      PluginLatencyReportingType pluginLatencyReportingType() const;
      PluginBypassType pluginBypassType() const;
      PluginFreewheelType pluginFreewheelType() const;

      // Returns the plugin latency, if it has such as function.
      // NOTE: If the plugin has a latency controller out, use that instead.
      virtual float getPluginLatency(void* /*handle*/);

      unsigned long inports() const         { return _inports; }
      unsigned long outports() const        { return _outports; }
      unsigned long controlInPorts() const  { return _controlInPorts; }
      unsigned long controlOutPorts() const { return _controlOutPorts; }

      const std::vector<unsigned long>* getRpIdx() { return &rpIdx; }
      };

typedef std::list<Plugin *>::iterator iPlugin;
typedef std::list<Plugin *>::const_iterator ciPlugin;


class PluginGroups : public QMap< QPair<QString, QString>, QSet<int> >
{
  public:
    QSet<int>& get(QString a, QString b) { return (*this)[(QPair<QString,QString>(a,b))]; }
    QSet<int>& get(const Plugin *p)
      { return (*this)[(QPair<QString,QString>(p->uri().isEmpty() ? p->lib() : p->uri(), p->label()))]; }

    void shift_left(int first, int last);
    void shift_right(int first, int last);
    void erase(int index);

  private:
    void replace_group(int old, int now);
};


//---------------------------------------------------------
//   PluginList
//---------------------------------------------------------

class PluginList : public std::list<Plugin *> {
   public:
      void add(const MusEPlugin::PluginScanInfoStruct& scan_info)
      { push_back(new Plugin(scan_info)); }

      // Each argument optional, can be empty.
      // If uri is not empty, the search is based solely on it, the other arguments are ignored.
      Plugin* find(const QString& file, const QString& uri, const QString& label) const;
      PluginList() {}
      };

//---------------------------------------------------------
//   Port
//---------------------------------------------------------

struct Port {
      unsigned long idx;
      
      //   NOTE: These values represent the lowest level of control value storage.
      //         The choice of float or double depends on the underlying system using this struct.
      //         For example plugins and synthesizers usually use floats to represent control values
      //          and they are directly pointed to this float, while our own track controls 
      //          (volume, pan etc.) take advantage of the double precision.
      //         Double precision is preferred if possible because above this lowest level all other 
      //          controller usage is in double precision. Thus our very own track controllers are 
      //          perfectly matched double precision throughout the system.
      union {
        float val;
        double dval;
        };
      union {
        float tmpVal; // TODO Try once again and for all to remove this, was it really required?
        //double dtmpVal; // Not used, should not be required.
        };
      
      bool enCtrl;  // Enable controller stream.
      CtrlInterpolate interp;
      };

//---------------------------------------------------------
//   PluginQuirks
//    An ugly but necessary class due to differences in plugin behaviour.
//---------------------------------------------------------

class PluginQuirks
{
public:
    enum NatUISCaling {GLOBAL, ON, OFF};
    // Whether the LV2 'speed' timePosition property switches to 0.0 in stop mode, or remains
    //  fixed at 1.0 regardless of play or stop mode. Fixes plugins like TAL NoiseMak3r
    //  stuck repeating small modulator segment at speed = 0.0.
    bool _fixedSpeed;
    // If the plugin uses our transport (ex. as an LV2 timePosition), sets whether the timePosition
    //  affects actual audio latency (not just say, beat or sequencer or arpeggiator latency).
    // Example: LV2 Example Metronome.
    bool _transportAffectsAudioLatency;
    // Override the plugin's reported latency. Some plugins get it wrong or not quite right.
    bool _overrideReportedLatency;
    // Value to override the reported latency.
    int _latencyOverrideValue;

  PluginQuirks() :
    _fixedSpeed(false),
    _transportAffectsAudioLatency(false),
    _overrideReportedLatency(false),
    _latencyOverrideValue(0),
    _fixNativeUIScaling(NatUISCaling::GLOBAL)
    { }

  void write(int level, Xml& xml) const;
  // Return true on error.
  bool read(Xml& xml);
  bool fixNativeUIScaling() const;
  void setFixNativeUIScaling(NatUISCaling fixScaling) { _fixNativeUIScaling = fixScaling; };
  NatUISCaling getFixNativeUIScaling() const { return _fixNativeUIScaling; };

private:
  // Reverse scaling of native UI windows on HiDPI
  NatUISCaling _fixNativeUIScaling;
};

typedef enum {
    PROP_NONE = -1, PROP_INT = 0, PROP_LONG, PROP_FLOAT, PROP_DOUBLE, PROP_BOOL, PROP_STRING, PROP_PATH
} PropType;

//---------------------------------------------------------
//   PluginIBase
//---------------------------------------------------------

class PluginIBase
{
   protected:
      ControlFifo _controlFifo;
      MusEGui::PluginGui* _gui;
      QRect _guiGeometry;
      QRect _nativeGuiGeometry;
      PluginQuirks _quirks;
      // True if activate has been called. False by default or if deactivate has been called.
      bool _curActiveState;

      void makeGui();

      virtual void activate() = 0;
      virtual void deactivate() = 0;

   public:
      PluginIBase();
      virtual ~PluginIBase();
      virtual PluginFeatures_t requiredFeatures() const = 0;
      inline virtual bool hasActiveButton() const = 0;
      inline virtual bool active() const = 0;
      inline virtual void setActive(bool v) = 0;
      inline virtual bool hasBypass() const = 0;
      virtual bool on() const = 0;
      virtual void setOn(bool val) = 0;
      virtual unsigned long pluginID() const = 0;
      virtual int id() const = 0;
      virtual QString pluginLabel() const = 0;
      virtual QString name() const = 0;
      virtual QString uri() const = 0;
      virtual QString lib() const = 0;
      virtual QString dirPath() const = 0;
      virtual QString fileName() const = 0;
      virtual QString titlePrefix() const = 0;

      virtual AudioTrack* track() const = 0;

      virtual void enableController(unsigned long i, bool v = true) = 0;
      virtual bool controllerEnabled(unsigned long i) const = 0;
      virtual void enableAllControllers(bool v = true) = 0;
      virtual void updateControllers() = 0;

      virtual void writeConfiguration(int level, Xml& xml) = 0;
      virtual bool readConfiguration(Xml& xml, bool readPreset=false) = 0;

      virtual bool addScheduledControlEvent(unsigned long i, double val, unsigned frame);    // returns true if event cannot be delivered
      virtual unsigned long parameters() const = 0;
      virtual unsigned long parametersOut() const = 0;
      virtual void setParam(unsigned long i, double val) = 0;
      virtual double param(unsigned long i) const = 0;
      virtual double paramOut(unsigned long i) const = 0;
      virtual const char* paramName(unsigned long i) const = 0;
      virtual const char* paramOutName(unsigned long i) const = 0;
      // These versions of range do not apply any changes, such as sample rate, to the bounds.
      // The information returned is verbose. See the other range() which does apply changes.
      // FIXME TODO: Either find a way to agnosticize these two ranges, or change them from ladspa ranges to a new MusE range class.
      virtual LADSPA_PortRangeHint range(unsigned long i) const = 0;
      virtual LADSPA_PortRangeHint rangeOut(unsigned long i) const = 0;
      // These versions of range apply any changes, such as sample rate, to the bounds.
      // The information returned is not verbose. See the other range() which does not apply changes.
      virtual void range(unsigned long i, float*, float*) const = 0;
      virtual void rangeOut(unsigned long i, float*, float*) const = 0;

      virtual bool usesTransportSource() const = 0;
      virtual unsigned long latencyOutPortIndex() const = 0;
      virtual float latency() const = 0;
      virtual unsigned long freewheelPortIndex() const = 0;
      virtual unsigned long enableOrBypassPortIndex() const = 0;
      virtual PluginLatencyReportingType pluginLatencyReportingType() const = 0;
      virtual PluginBypassType pluginBypassType() const = 0;
      virtual PluginFreewheelType pluginFreewheelType() const = 0;

      const PluginQuirks& cquirks() const { return _quirks; }
      PluginQuirks& quirks() { return _quirks; }
      
      virtual void setCustomData(const std::vector<QString> &) {/* Do nothing by default */}
      virtual CtrlValueType ctrlValueType(unsigned long i) const = 0;
      virtual CtrlList::Mode ctrlMode(unsigned long i) const = 0;
      virtual const CtrlVal::CtrlEnumValues *ctrlEnumValues(unsigned long i) const;
      virtual QString portGroup(long unsigned int i) const;
      virtual bool ctrlIsTrigger(long unsigned int i) const;
      virtual bool ctrlNotOnGui(long unsigned int i) const;
      virtual CtrlValueType ctrlOutValueType(unsigned long i) const = 0;
      virtual CtrlList::Mode ctrlOutMode(unsigned long i) const = 0;
      virtual const CtrlVal::CtrlEnumValues *ctrlOutEnumValues(unsigned long i) const;
      virtual QString portGroupOut(long unsigned int i) const;
      virtual bool ctrlOutIsTrigger(long unsigned int i) const;
      virtual bool ctrlOutNotOnGui(long unsigned int i) const;
      // Returns a value unit string for displaying unit symbols.
      virtual QString unitSymbol(long unsigned int i) const;
      virtual QString unitSymbolOut(long unsigned int i) const;
      // Returns index into the global value units for displaying unit symbols.
      // Can be -1 meaning no units.
      virtual int valueUnit ( unsigned long i) const;
      virtual int valueUnitOut ( unsigned long i) const;

      QString dssi_ui_filename() const;

      MusEGui::PluginGui* gui() const { return _gui; }
      void deleteGui();
      virtual void guiHeartBeat();
      virtual void showGui();
      virtual void showGui(bool);
      virtual bool guiVisible() const;
      // Sets the gui's geometry. Also updates the saved geometry.
      virtual void setGeometry(int x, int y, int w, int h);
      // Returns the current geometry of the gui, or if the gui does not exist, 
      //  the saved gui geometry.
      virtual void getGeometry(int *x, int *y, int *w, int *h) const;
      // Saves the current gui geometry.
      virtual void saveGeometry(int x, int y, int w, int h);
      // Returns the saved gui geometry.
      virtual void savedGeometry(int *x, int *y, int *w, int *h) const;

      virtual void showNativeGui() { }
      virtual void showNativeGui(bool) { }
      virtual bool nativeGuiVisible() const { return false; }
      // Sets the gui's geometry. Also updates the saved geometry.
      virtual void setNativeGeometry(int x, int y, int w, int h);
      // Returns the current geometry of the gui, or if the gui does not exist, 
      //  the saved gui geometry.
      virtual void getNativeGeometry(int *x, int *y, int *w, int *h) const;
      // Saves the current gui geometry.
      virtual void saveNativeGeometry(int x, int y, int w, int h);
      // Returns the saved gui geometry.
      virtual void savedNativeGeometry(int *x, int *y, int *w, int *h) const;
};

//---------------------------------------------------------
//   PluginI
//    plugin instance
//---------------------------------------------------------

#define IS_AUDIO_IN (LADSPA_PORT_AUDIO  | LADSPA_PORT_INPUT)
#define IS_AUDIO_OUT (LADSPA_PORT_AUDIO | LADSPA_PORT_OUTPUT)

class PluginI : public PluginIBase {
#ifdef LV2_SUPPORT
    friend class LV2PluginWrapper;
    friend class LV2Synth;    
#endif
#ifdef VST_NATIVE_SUPPORT
    friend class VstNativeSynth;
    friend class VstNativePluginWrapper;
#endif
      Plugin* _plugin;
      int channel;
      int instances;
      AudioTrack* _track;
      int _id;

      LADSPA_Handle* handle;         // per instance
      Port* controls;
      Port* controlsOut;
      Port* controlsOutDummy;

      unsigned long controlPorts;      
      unsigned long controlOutPorts;    
      
      float *_audioInSilenceBuf; // Just all zeros all the time, so we don't have to clear for silence.
      float *_audioOutDummyBuf;  // A place to connect unused outputs.
      
      bool _active;
      bool _on;
      bool initControlValues;
      QString _name;
      QString _label;

      #ifdef OSC_SUPPORT
      OscEffectIF _oscif;
      #endif
      bool _showNativeGuiPending;

      void init();

   protected:
      void activate();
      void deactivate();

   public:
      PluginI();
      virtual ~PluginI();

      Plugin* plugin() const { return _plugin; }

      virtual PluginFeatures_t requiredFeatures() const { return _plugin->requiredFeatures(); }
      
      inline bool hasActiveButton() const { return true; }
      inline bool active() const { return _active; }
      inline void setActive(bool v) { _active = v; }

      inline bool hasBypass() const  { return true; };
      bool on() const        { return _on; }
      void setOn(bool val)   { _on = val; }

      void setTrack(AudioTrack* t)   { _track = t; }
      AudioTrack* track() const      { return _track; }
      unsigned long pluginID() const { return _plugin->id(); }
      void setID(int i);
      int id() const                 { return _id; }
      void updateControllers();

      bool initPluginInstance(Plugin*, int channels);
      void setChannels(int);
      void connect(unsigned long ports, bool connectAllToDummyPorts, unsigned long offset, float** src, float** dst);
      void apply(unsigned pos, unsigned long n,
                 unsigned long ports, bool wantActive, float** bufIn, float** bufOut, float latency_corr_offset = 0.0f);

      void enableController(unsigned long i, bool v = true)   { controls[i].enCtrl = v; }
      bool controllerEnabled(unsigned long i) const           { return controls[i].enCtrl; }
      void enableAllControllers(bool v = true);

      void cleanup();

      QString pluginLabel() const    { return _plugin->label(); }
      QString label() const          { return _label; }
      QString name() const           { return _name; }
      QString lib() const            { return _plugin->lib(); }
      QString uri() const            { return _plugin->uri(); }
      QString dirPath() const        { return _plugin->dirPath(); }
      QString fileName() const       { return _plugin->fileName(); }
      QString titlePrefix() const;

      #ifdef OSC_SUPPORT
      OscEffectIF& oscIF() { return _oscif; }

      int oscControl(unsigned long dssiPort, float val);
      int oscConfigure(const char *key, const char *val);
      int oscUpdate();
      #endif

      void writeConfiguration(int level, Xml& xml);
      bool readConfiguration(Xml& xml, bool readPreset=false);
      bool loadControl(Xml& xml);
      bool setControl(const QString& s, double val);
      void showGui();
      void showGui(bool);
      bool isDssiPlugin() const { return _plugin->isDssiPlugin(); }
      bool isLV2Plugin() const { return _plugin->isLV2Plugin(); }
      bool isVstNativePlugin() const { return _plugin->isVstNativePlugin(); }
      void showNativeGui();
      void showNativeGui(bool);
      bool isShowNativeGuiPending() { return _showNativeGuiPending; }
      bool nativeGuiVisible() const;
      void guiHeartBeat();

      unsigned long parameters() const           { return controlPorts; }
      unsigned long parametersOut() const           { return controlOutPorts; }
      void setParam(unsigned long i, double val);
      void putParam(unsigned long i, double val) { controls[i].val = controls[i].tmpVal = val; }
      double param(unsigned long i) const        { return controls[i].val; }
      double paramOut(unsigned long i) const        { return controlsOut[i].val; }
      double defaultValue(unsigned long param) const;
      double defaultOutValue(unsigned long param) const;
      const char* paramName(unsigned long i) const     { return _plugin->portName(controls[i].idx); }
      const char* paramOutName(unsigned long i) const     { return _plugin->portName(controlsOut[i].idx); }
      LADSPA_PortDescriptor portd(unsigned long i) const { return _plugin->portd(controls[i].idx); }
      LADSPA_PortDescriptor portdOut(unsigned long i) const { return _plugin->portd(controlsOut[i].idx); }
      void range(unsigned long i, float* min, float* max) const { _plugin->range(controls[i].idx, min, max); }
      void rangeOut(unsigned long i, float* min, float* max) const { _plugin->range(controlsOut[i].idx, min, max); }
      bool isAudioIn(unsigned long k) { return (_plugin->portd(k) & IS_AUDIO_IN) == IS_AUDIO_IN; }
      bool isAudioOut(unsigned long k) { return (_plugin->portd(k) & IS_AUDIO_OUT) == IS_AUDIO_OUT; }
      LADSPA_PortRangeHint range(unsigned long i) const { return _plugin->range(controls[i].idx); }
      LADSPA_PortRangeHint rangeOut(unsigned long i) const { return _plugin->range(controlsOut[i].idx); }
      bool usesTransportSource() const;
      unsigned long latencyOutPortIndex() const;
      float latency() const;
      unsigned long freewheelPortIndex() const;
      unsigned long enableOrBypassPortIndex() const;
      PluginLatencyReportingType pluginLatencyReportingType() const;
      PluginBypassType pluginBypassType() const;
      PluginFreewheelType pluginFreewheelType() const;

      CtrlValueType ctrlValueType(unsigned long i) const { return _plugin->ctrlValueType(controls[i].idx); }
      const CtrlVal::CtrlEnumValues* ctrlEnumValues( unsigned long i) const { return _plugin->ctrlEnumValues(controls[i].idx); }
      CtrlList::Mode ctrlMode(unsigned long i) const { return _plugin->ctrlMode(controls[i].idx); }
      void setCustomData(const std::vector<QString> &customParams);
      CtrlValueType ctrlOutValueType(unsigned long i) const { return _plugin->ctrlValueType(controlsOut[i].idx); }
      const CtrlVal::CtrlEnumValues* ctrlOutEnumValues( unsigned long i) const { return _plugin->ctrlEnumValues(controlsOut[i].idx); }
      CtrlList::Mode ctrlOutMode(unsigned long i) const { return _plugin->ctrlMode(controlsOut[i].idx); }
      // Returns a value unit string for displaying unit symbols.
      QString unitSymbol(long unsigned int i) const { return _plugin->unitSymbol(controls[i].idx); }
      QString unitSymbolOut(long unsigned int i) const { return _plugin->unitSymbol(controlsOut[i].idx); }
      // Returns index into the global value units for displaying unit symbols.
      // Can be -1 meaning no units.
      int valueUnit ( unsigned long i) const { return _plugin->valueUnit(controls[i].idx); }
      int valueUnitOut ( unsigned long i) const { return _plugin->valueUnit(controlsOut[i].idx); }
      };

//---------------------------------------------------------
//   Pipeline
//    chain of connected efx inserts
//---------------------------------------------------------

class Pipeline : public std::vector<PluginI*> {
   private:
      float* buffer[MusECore::MAX_CHANNELS];
      void initBuffers();
   public:
      Pipeline();
      Pipeline(const Pipeline&, AudioTrack*);
      ~Pipeline();
      void insert(PluginI* p, int index);
      void remove(int index);
      void removeAll();
      bool isActive(int idx) const;
      void setActive(int, bool);
      bool isOn(int idx) const;
      void setOn(int, bool);
      QString label(int idx) const;
      QString name(int idx) const;
      QString uri(int idx) const;
      void showGui(int, bool);
      bool isDssiPlugin(int) const;
      bool isLV2Plugin(int idx) const;
      bool isVstNativePlugin(int idx) const;
      bool hasNativeGui(int idx) const;
      void showNativeGui(int, bool);
      void deleteGui(int idx);
      void deleteAllGuis();
      bool guiVisible(int);
      bool nativeGuiVisible(int);
      void guiHeartBeat();

      void apply(unsigned pos, unsigned long ports, unsigned long nframes, bool wantActive, float** buffer);

      void move(int idx1, int idx2);
      bool empty(int idx) const;
      void setChannels(int);
      bool addScheduledControlEvent(int track_ctrl_id, double val, unsigned frame); // returns true if event cannot be delivered
      void enableController(int track_ctrl_id, bool en);
      bool controllerEnabled(int track_ctrl_id);
      float latency() const;
      };

typedef Pipeline::iterator iPluginI;
typedef Pipeline::const_iterator ciPluginI;

extern void initPlugins();

extern bool ladspaDefaultValue(const LADSPA_Descriptor* plugin, unsigned long port, float* val);
extern void ladspaControlRange(const LADSPA_Descriptor* plugin, unsigned long port, float* min, float* max);
extern bool ladspa2MidiControlValues(const LADSPA_Descriptor* plugin, unsigned long port, int ctlnum, int* min, int* max, int* def);
extern float midi2LadspaValue(const LADSPA_Descriptor* plugin, unsigned long port, int ctlnum, int val);
extern CtrlValueType ladspaCtrlValueType(const LADSPA_Descriptor* plugin, int port);
extern CtrlList::Mode ladspaCtrlMode(const LADSPA_Descriptor* plugin, int port);

} // namespace MusECore


namespace MusEGui {
class DoubleLabel;

//   PluginLoader
//---------------------------------------------------------

class PluginLoader : public QUiLoader
{
   public:
      virtual QWidget* createWidget(const QString & className, QWidget * parent = 0, const QString & name = QString());
      PluginLoader(QObject * parent = 0) : QUiLoader(parent) {}
};

//---------------------------------------------------------
//   GuiParam
//---------------------------------------------------------

struct GuiParam {
      enum {
            GUI_SLIDER, GUI_CHECKBOX, GUI_SWITCH, GUI_METER, GUI_ENUM
            };
      int type;
      int hint;
      bool pressed;

      MusEGui::DoubleLabel* label;
      MusEGui::DoubleText* textLabel;
      QWidget* actuator;  // Slider or Toggle Button (SWITCH)
      };

//---------------------------------------------------------
//   GuiWidgets
//---------------------------------------------------------

struct GuiWidgets {
      enum {
            SLIDER, DOUBLE_LABEL,
            CHECKBOX,
            SWITCH,
            QCOMBOBOX
            };
      QWidget* widget;
      int type;
      int hint;
      unsigned long param;
      bool pressed;
      };

//---------------------------------------------------------
//   PluginGui
//---------------------------------------------------------

class PluginGui : public QMainWindow {
      Q_OBJECT

      MusECore::PluginIBase* plugin;        // plugin instance

      GuiParam* params;
      GuiParam* paramsOut;
      unsigned long nobj;             // number of widgets in gw
      GuiWidgets* gw;

      QAction* activeButton;
      QAction* onOff;
      QWidget* mw;            // main widget
      QScrollArea* view;

      QMetaObject::Connection _configChangedMetaConn;

      void updateControls();
      void getPluginConvertedValues(LADSPA_PortRangeHint range,
                     double &lower, double &upper, double &dlower, double &dupper, double &dval);
      void constructGUIFromFile(QFile& uifile);
      void constructGUIFromPluginMetadata();

   protected:
      virtual void showEvent(QShowEvent *e);
      virtual void hideEvent(QHideEvent *e);
    
   private slots:
      void load();
      void save();
      void activeToggled(bool);
      void bypassToggled(bool);
      void showSettings();
      void sliderChanged(double value, int id, int scrollMode);
      void switchChanged(bool value, int id);
      void labelChanged(double, int);
      void comboChanged(unsigned long);
      void guiParamChanged(unsigned long int);
      void sliderPressed(double, int);
      void sliderReleased(double, int);
      void switchPressed(int);
      void switchReleased(int);
      void guiParamPressed(unsigned long int);
      void guiParamReleased(unsigned long int);
      void guiSliderPressed(double, unsigned long int);
      void guiSliderReleased(double, unsigned long int);
      void ctrlRightClicked(const QPoint &, int);
      void guiSliderRightClicked(const QPoint &, unsigned long int);
      void guiContextMenuReq(unsigned long int idx);

   public slots:
      void heartBeat();
      void configChanged();

   public:
      PluginGui(MusECore::PluginIBase*);
      ~PluginGui();

      void setActive(bool);
      void setOn(bool);
      void updateValues();
      void updateWindowTitle();
      };


} // namespace MusEGui

namespace MusEGlobal {
extern MusECore::PluginList plugins;
extern MusECore::PluginGroups plugin_groups;
extern QList<QString> plugin_group_names;

void writePluginGroupConfiguration(int level, MusECore::Xml& xml);
void readPluginGroupConfiguration(MusECore::Xml& xml);
}
#endif

