ivstnoteexpression.h

Go to the documentation of this file.

//------------------------------------------------------------------------
// Project     : VST SDK
//
// Category    : Interfaces
// Filename    : pluginterfaces/vst/ivstnoteexpression.h
// Created by  : Steinberg, 10/2010
// Description : VST Note Expression 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/funknown.h"
#include "pluginterfaces/vst/vsttypes.h"
 
//------------------------------------------------------------------------
#include "pluginterfaces/base/falignpush.h"
//------------------------------------------------------------------------
 
//------------------------------------------------------------------------
namespace Steinberg {
namespace Vst {
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
typedef uint32 NoteExpressionTypeID;
typedef double NoteExpressionValue;
 
//------------------------------------------------------------------------
enum NoteExpressionTypeIDs : uint32
{
        kVolumeTypeID = 0,              
        kPanTypeID,                             
        kTuningTypeID,                  
        kVibratoTypeID,                 
        kExpressionTypeID,              
        kBrightnessTypeID,              
        kTextTypeID,                    
        kPhonemeTypeID,                 
 
        kCustomStart = 100000,  
        kCustomEnd   = 200000,  
        
        kInvalidTypeID = 0xFFFFFFFF     
};
 
//------------------------------------------------------------------------
struct NoteExpressionValueDescription
{
        NoteExpressionValue defaultValue;       
        NoteExpressionValue minimum;            
        NoteExpressionValue maximum;            
        int32 stepCount;                                        
};
 
#if SMTG_OS_WINDOWS && !SMTG_PLATFORM_64
#include "pluginterfaces/vst/vstpshpack4.h"
#endif
//------------------------------------------------------------------------
struct NoteExpressionValueEvent
{
        NoteExpressionTypeID typeId;    
        int32 noteId;                                   
 
        NoteExpressionValue value;              
};
 
//------------------------------------------------------------------------
struct NoteExpressionTextEvent
{
        NoteExpressionTypeID typeId;    
        int32 noteId;                                   
 
        uint32 textLen;                                 
 
        const TChar* text;                              
};
 
#if SMTG_OS_WINDOWS && !SMTG_PLATFORM_64
#include "pluginterfaces/base/falignpop.h"
#endif
 
//------------------------------------------------------------------------
struct NoteExpressionTypeInfo
{
        NoteExpressionTypeID typeId;                    
        String128 title;                                                
        String128 shortTitle;                                   
        String128 units;                                                
        int32 unitId;                                                   
        NoteExpressionValueDescription valueDesc;       
        ParamID associatedParameterId;                  
 
        int32 flags;                                                    
        enum NoteExpressionTypeFlags
        {
                kIsBipolar              = 1 << 0,                       
                kIsOneShot              = 1 << 1,                       
                kIsAbsolute             = 1 << 2,                       
                kAssociatedParameterIDValid     = 1 << 3,
        };
};
 
//------------------------------------------------------------------------
class INoteExpressionController : public FUnknown
{
public:
        virtual int32 PLUGIN_API getNoteExpressionCount (int32 busIndex, int16 channel) = 0;

        virtual tresult PLUGIN_API getNoteExpressionInfo (int32 busIndex, int16 channel, int32 noteExpressionIndex, NoteExpressionTypeInfo& info /*out*/) = 0;

        virtual tresult PLUGIN_API getNoteExpressionStringByValue (int32 busIndex, int16 channel, NoteExpressionTypeID id, NoteExpressionValue valueNormalized /*in*/, String128 string /*out*/) = 0;

        virtual tresult PLUGIN_API getNoteExpressionValueByString (int32 busIndex, int16 channel, NoteExpressionTypeID id, const TChar* string /*in*/, NoteExpressionValue& valueNormalized /*out*/) = 0;
 
        //------------------------------------------------------------------------
        static const FUID iid;
};
 
DECLARE_CLASS_IID (INoteExpressionController, 0xB7F8F859, 0x41234872, 0x91169581, 0x4F3721A3)
 
//------------------------------------------------------------------------
//------------------------------------------------------------------------
enum KeyswitchTypeIDs : uint32
{
        kNoteOnKeyswitchTypeID = 0,     
        kOnTheFlyKeyswitchTypeID,       
        kOnReleaseKeyswitchTypeID,      
        kKeyRangeTypeID                         
};
 
typedef uint32 KeyswitchTypeID;
 
//------------------------------------------------------------------------
struct KeyswitchInfo
{
        KeyswitchTypeID typeId;         
        String128 title;                        
        String128 shortTitle;           
 
        int32 keyswitchMin;                     
        int32 keyswitchMax;                     
        int32 keyRemapped;                      
 
        int32 unitId;                           
 
        int32 flags;                            
};
 
//------------------------------------------------------------------------
class IKeyswitchController : public FUnknown
{
public:
        virtual int32 PLUGIN_API getKeyswitchCount (int32 busIndex, int16 channel) = 0;

        virtual tresult PLUGIN_API getKeyswitchInfo (int32 busIndex, int16 channel, int32 keySwitchIndex, KeyswitchInfo& info /*out*/) = 0;
 
        //------------------------------------------------------------------------
        static const FUID iid;
};
 
DECLARE_CLASS_IID (IKeyswitchController, 0x1F2F76D3, 0xBFFB4B96, 0xB99527A5, 0x5EBCCEF4)
 
//------------------------------------------------------------------------
} // namespace Vst
} // namespace Steinberg
 
//------------------------------------------------------------------------
#include "pluginterfaces/base/falignpop.h"
//------------------------------------------------------------------------