ipslcontextinfo.h

Go to the documentation of this file.

//************************************************************************************************
//
// PreSonus Plug-In Extensions
// Written and placed in the PUBLIC DOMAIN by PreSonus Software Ltd.
//
// Filename    : ipslcontextinfo.h
// Created by  : PreSonus Software Ltd., 08/2013, last updated 11/2016
// Description : Context Information Interface
//
//************************************************************************************************
/*
        DISCLAIMER:
        The PreSonus Plug-In Extensions are host-specific extensions of existing proprietary technologies,
        provided to the community on an AS IS basis. They are not part of any official 3rd party SDK and
        PreSonus is not affiliated with the owner of the underlying technology in any way.
*/
//************************************************************************************************
 
#ifndef _ipslcontextinfo_h
#define _ipslcontextinfo_h
 
#include "pluginterfaces/vst/vsttypes.h"
#include "pluginterfaces/base/falignpush.h"
 
namespace Presonus {
 
//************************************************************************************************
// IContextInfoProvider
//************************************************************************************************
 
struct IContextInfoProvider: Steinberg::FUnknown
{       
        virtual Steinberg::tresult PLUGIN_API getContextInfoValue (Steinberg::int32& value, Steinberg::FIDString id) = 0;

        virtual Steinberg::tresult PLUGIN_API getContextInfoString (Steinberg::Vst::TChar* string, Steinberg::int32 maxCharCount, Steinberg::FIDString id) = 0;
        
    static const Steinberg::FUID iid;
};
 
DECLARE_CLASS_IID (IContextInfoProvider, 0x483e61ea, 0x17994494, 0x8199a35a, 0xebb35e3c)
 
//************************************************************************************************
// IContextInfoProvider2
//************************************************************************************************
 
struct IContextInfoProvider2: IContextInfoProvider
{
        using IContextInfoProvider::getContextInfoValue;

        virtual Steinberg::tresult PLUGIN_API getContextInfoValue (double& value, Steinberg::FIDString id) = 0;
                
        virtual Steinberg::tresult PLUGIN_API setContextInfoValue (Steinberg::FIDString id, double value) = 0;
        
        virtual Steinberg::tresult PLUGIN_API setContextInfoValue (Steinberg::FIDString id, Steinberg::int32 value) = 0;
        
        virtual Steinberg::tresult PLUGIN_API setContextInfoString (Steinberg::FIDString id, Steinberg::Vst::TChar* string) = 0;
        
    static const Steinberg::FUID iid;
};
 
DECLARE_CLASS_IID (IContextInfoProvider2, 0x61e45968, 0x3d364f39, 0xb15e1733, 0x4944172b)
 
//************************************************************************************************
// IContextInfoHandler
//************************************************************************************************
 
struct IContextInfoHandler: Steinberg::FUnknown
{
        virtual void PLUGIN_API notifyContextInfoChange () = 0;
  
        static const Steinberg::FUID iid;
};
 
DECLARE_CLASS_IID (IContextInfoHandler, 0xc3b17bc0, 0x2c174494, 0x80293402, 0xfbc4bbf8)
 
//************************************************************************************************
// IContextInfoHandler2
//************************************************************************************************
 
struct IContextInfoHandler2: Steinberg::FUnknown
{
        virtual void PLUGIN_API notifyContextInfoChange (Steinberg::FIDString id) = 0;
  
        static const Steinberg::FUID iid;
};
 
DECLARE_CLASS_IID (IContextInfoHandler2, 0x31e29a7a, 0xe55043ad, 0x8b95b9b8, 0xda1fbe1e)
 
//************************************************************************************************
// Context Information Attributes
//************************************************************************************************
 
namespace ContextInfo
{
        enum ChannelType
        {
                kTrack = 0,             
                kBus,                   
                kFX,                    
                kSynth,                 
                kIn,                    
                kOut                    
        };
        
        enum ChannelIndexMode
        {
                kFlatIndex = 0, 
                kPerTypeIndex   
        };
 
        // per instance
        const Steinberg::FIDString kID = "id";                                                  
        const Steinberg::FIDString kName = "name";                                              
        const Steinberg::FIDString kType = "type";                                              
        const Steinberg::FIDString kMain = "main";                                              
        const Steinberg::FIDString kIndex = "index";                                    
        const Steinberg::FIDString kColor = "color";                                    
        const Steinberg::FIDString kVisibility = "visibility";                  
        const Steinberg::FIDString kSelected = "selected";                              
        const Steinberg::FIDString kMultiSelect = "multiselect";                
        const Steinberg::FIDString kFocused = "focused";                                
 
        const Steinberg::FIDString kRegionName = "regionName";                  
        const Steinberg::FIDString kRegionSelected = "regionSelected";  
 
        // per instance (requires IContextInfoHandler2 on plug-in side)
        const Steinberg::FIDString kVolume = "volume";                                  
        const Steinberg::FIDString kMaxVolume = "maxVolume";                    
        const Steinberg::FIDString kPan = "pan";                                                
        const Steinberg::FIDString kMute = "mute";                                              
        const Steinberg::FIDString kSolo = "solo";                                              
        const Steinberg::FIDString kSendCount = "sendcount";                    
        const Steinberg::FIDString kSendLevel = "sendlevel";                    
        const Steinberg::FIDString kMaxSendLevel = "maxSendlevel";              
 
        // global
        const Steinberg::FIDString kActiveDocumentID = "activeDocumentID";      
        const Steinberg::FIDString kDocumentID = "documentID";                          
        const Steinberg::FIDString kDocumentName = "documentName";                      
        const Steinberg::FIDString kDocumentFolder = "documentFolder";          
        const Steinberg::FIDString kAudioFolder = "audioFolder";                        
        const Steinberg::FIDString kIndexMode = "indexMode";                            
}
 
} // namespace Presonus
 
#include "pluginterfaces/base/falignpop.h"
 
#endif // _ipslcontextinfo_h