ivsteditcontroller.h

Go to the documentation of this file.

//------------------------------------------------------------------------
// Project     : VST SDK
//
// Category    : Interfaces
// Filename    : pluginterfaces/vst/ivsteditcontroller.h
// Created by  : Steinberg, 09/2005
// Description : VST Edit Controller Interfaces
//
//-----------------------------------------------------------------------------
// This file is part of a Steinberg SDK. It is subject to the license terms
// in the LICENSE file found in the top-level directory of this distribution
// and at www.steinberg.net/sdklicenses. 
// No part of the SDK, including this file, may be copied, modified, propagated,
// or distributed except according to the terms contained in the LICENSE file.
//-----------------------------------------------------------------------------
 
#pragma once
 
#include "pluginterfaces/base/ipluginbase.h"
#include "pluginterfaces/vst/vsttypes.h"
 
//------------------------------------------------------------------------
#include "pluginterfaces/base/falignpush.h"
//------------------------------------------------------------------------
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
#ifndef kVstComponentControllerClass
#define kVstComponentControllerClass "Component Controller Class"
#endif
 
//------------------------------------------------------------------------
namespace Steinberg {
class IPlugView;
class IBStream;
 
//------------------------------------------------------------------------
namespace Vst {
 
//------------------------------------------------------------------------
struct ParameterInfo
{
//------------------------------------------------------------------------
        ParamID id;                             
        String128 title;                
        String128 shortTitle;   
        String128 units;                
        int32 stepCount;                
        ParamValue defaultNormalizedValue;      
        UnitID unitId;                  
 
        int32 flags;                    
        enum ParameterFlags
        {
                kNoFlags                 = 0,           
                kCanAutomate     = 1 << 0,      
                kIsReadOnly              = 1 << 1,      
                kIsWrapAround    = 1 << 2,      
                kIsList                  = 1 << 3,      
                kIsHidden                = 1 << 4,      
 
                kIsProgramChange = 1 << 15,     
                kIsBypass                = 1 << 16      
        };
//------------------------------------------------------------------------
};
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
namespace ViewType {
const CString kEditor = "editor";
}
 
//------------------------------------------------------------------------
enum RestartFlags
{
        kReloadComponent                        = 1 << 0,

        kIoChanged                                      = 1 << 1,

        kParamValuesChanged                     = 1 << 2,

        kLatencyChanged                         = 1 << 3,

        kParamTitlesChanged                     = 1 << 4,

        kMidiCCAssignmentChanged        = 1 << 5,
        
        kNoteExpressionChanged          = 1 << 6,
        
        kIoTitlesChanged                        = 1 << 7,
        
        kPrefetchableSupportChanged = 1 << 8,

        kRoutingInfoChanged                     = 1 << 9
};
 
//------------------------------------------------------------------------
class IComponentHandler : public FUnknown
{
public:
//------------------------------------------------------------------------
        virtual tresult PLUGIN_API beginEdit (ParamID id) = 0;

        virtual tresult PLUGIN_API performEdit (ParamID id, ParamValue valueNormalized) = 0;

        virtual tresult PLUGIN_API endEdit (ParamID id) = 0;

        virtual tresult PLUGIN_API restartComponent (int32 flags) = 0;
 
//------------------------------------------------------------------------
        static const FUID iid;
};
 
DECLARE_CLASS_IID (IComponentHandler, 0x93A0BEA3, 0x0BD045DB, 0x8E890B0C, 0xC1E46AC6)
 
//------------------------------------------------------------------------
class IComponentHandler2 : public FUnknown
{
public:
        //------------------------------------------------------------------------
        virtual tresult PLUGIN_API setDirty (TBool state) = 0;

        virtual tresult PLUGIN_API requestOpenEditor (FIDString name = ViewType::kEditor) = 0;
 
        //------------------------------------------------------------------------
        virtual tresult PLUGIN_API startGroupEdit () = 0;

        virtual tresult PLUGIN_API finishGroupEdit () = 0;
 
        //------------------------------------------------------------------------
        static const FUID iid;
};
 
DECLARE_CLASS_IID (IComponentHandler2, 0xF040B4B3, 0xA36045EC, 0xABCDC045, 0xB4D5A2CC)
 
//------------------------------------------------------------------------
class IComponentHandlerBusActivation : public FUnknown
{
public:
//------------------------------------------------------------------------
        virtual tresult PLUGIN_API requestBusActivation (MediaType type, BusDirection dir, int32 index,
                                                         TBool state) = 0;
 
//------------------------------------------------------------------------
        static const FUID iid;
};
 
DECLARE_CLASS_IID (IComponentHandlerBusActivation, 0x067D02C1, 0x5B4E274D, 0xA92D90FD, 0x6EAF7240)
 
//------------------------------------------------------------------------
class IProgress : public FUnknown
{
public:
        //------------------------------------------------------------------------
        enum ProgressType : uint32
        {
                AsyncStateRestoration = 0,      
                UIBackgroundTask                        
        };
 
        using ID = uint64;

        virtual tresult PLUGIN_API start (ProgressType type, const tchar* optionalDescription,
                                          ID& outID) = 0;
        virtual tresult PLUGIN_API update (ID id, ParamValue normValue) = 0;
        virtual tresult PLUGIN_API finish (ID id) = 0;
 
//------------------------------------------------------------------------
        static const FUID iid;
};
 
DECLARE_CLASS_IID (IProgress, 0x00C9DC5B, 0x9D904254, 0x91A388C8, 0xB4E91B69)
 
//------------------------------------------------------------------------
class IEditController : public IPluginBase
{
public:
//------------------------------------------------------------------------
        virtual tresult PLUGIN_API setComponentState (IBStream* state) = 0;

        virtual tresult PLUGIN_API setState (IBStream* state) = 0;

        virtual tresult PLUGIN_API getState (IBStream* state) = 0;
 
        // parameters -------------------------
        virtual int32 PLUGIN_API getParameterCount () = 0;
        virtual tresult PLUGIN_API getParameterInfo (int32 paramIndex, ParameterInfo& info /*out*/) = 0;

        virtual tresult PLUGIN_API getParamStringByValue (ParamID id, ParamValue valueNormalized /*in*/, String128 string /*out*/) = 0;
        virtual tresult PLUGIN_API getParamValueByString (ParamID id, TChar* string /*in*/, ParamValue& valueNormalized /*out*/) = 0;

        virtual ParamValue PLUGIN_API normalizedParamToPlain (ParamID id, ParamValue valueNormalized) = 0;
        virtual ParamValue PLUGIN_API plainParamToNormalized (ParamID id, ParamValue plainValue) = 0;

        virtual ParamValue PLUGIN_API getParamNormalized (ParamID id) = 0;
        virtual tresult PLUGIN_API setParamNormalized (ParamID id, ParamValue value) = 0;
 
        // handler ----------------------------
        virtual tresult PLUGIN_API setComponentHandler (IComponentHandler* handler) = 0;
 
        // view -------------------------------
        virtual IPlugView* PLUGIN_API createView (FIDString name) = 0;
 
//------------------------------------------------------------------------
        static const FUID iid;
};
 
DECLARE_CLASS_IID (IEditController, 0xDCD7BBE3, 0x7742448D, 0xA874AACC, 0x979C759E)
 
//------------------------------------------------------------------------
enum KnobModes
{
        kCircularMode = 0,              
        kRelativCircularMode,   
        kLinearMode                             
};
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
typedef int32 KnobMode; 
 
//------------------------------------------------------------------------
class IEditController2 : public FUnknown
{
public:
        virtual tresult PLUGIN_API setKnobMode (KnobMode mode) = 0;

        virtual tresult PLUGIN_API openHelp (TBool onlyCheck) = 0;

        virtual tresult PLUGIN_API openAboutBox (TBool onlyCheck) = 0;
 
        //------------------------------------------------------------------------
        static const FUID iid;
};
 
DECLARE_CLASS_IID (IEditController2, 0x7F4EFE59, 0xF3204967, 0xAC27A3AE, 0xAFB63038)
 
//------------------------------------------------------------------------
class IMidiMapping : public FUnknown
{
public:
        virtual tresult PLUGIN_API getMidiControllerAssignment (int32 busIndex, int16 channel,
                                                                                                                        CtrlNumber midiControllerNumber, ParamID& id/*out*/) = 0;
 
        //------------------------------------------------------------------------
        static const FUID iid;
};
 
DECLARE_CLASS_IID (IMidiMapping, 0xDF0FF9F7, 0x49B74669, 0xB63AB732, 0x7ADBF5E5)
 
//------------------------------------------------------------------------
class IEditControllerHostEditing : public FUnknown
{
public:
        virtual tresult PLUGIN_API beginEditFromHost (ParamID paramID) = 0;

        virtual tresult PLUGIN_API endEditFromHost (ParamID paramID) = 0;
 
        //------------------------------------------------------------------------
        static const FUID iid;
};
 
DECLARE_CLASS_IID (IEditControllerHostEditing, 0xC1271208, 0x70594098, 0xB9DD34B3, 0x6BB0195E)
 
//------------------------------------------------------------------------
} // namespace Vst
} // namespace Steinberg
 
//------------------------------------------------------------------------
#include "pluginterfaces/base/falignpop.h"
//------------------------------------------------------------------------