ivstevents.h

Go to the documentation of this file.

//------------------------------------------------------------------------
// Project     : VST SDK
//
// Category    : Interfaces
// Filename    : pluginterfaces/vst/ivstevents.h
// Created by  : Steinberg, 11/2005
// Description : VST Events 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/vst/ivstprocesscontext.h"
#include "pluginterfaces/vst/ivstnoteexpression.h"
 
//------------------------------------------------------------------------
#include "pluginterfaces/base/falignpush.h"
//------------------------------------------------------------------------
 
//------------------------------------------------------------------------
namespace Steinberg {
namespace Vst {
 
//------------------------------------------------------------------------
enum NoteIDUserRange
{
        kNoteIDUserRangeLowerBound = -10000, 
        kNoteIDUserRangeUpperBound = -1000,
};
 
//------------------------------------------------------------------------
struct NoteOnEvent
{
        int16 channel;          
        int16 pitch;            
        float tuning;           
        float velocity;         
        int32 length;           
        int32 noteId;           
};
 
//------------------------------------------------------------------------
struct NoteOffEvent
{
        int16 channel;          
        int16 pitch;            
        float velocity;         
        int32 noteId;           
        float tuning;           
};
 
//------------------------------------------------------------------------
struct DataEvent
{
        uint32 size;            
        uint32 type;            
        const uint8* bytes;     

        enum DataTypes
        {
                kMidiSysEx = 0  
        };
};
 
//------------------------------------------------------------------------
struct PolyPressureEvent
{
        int16 channel;          
        int16 pitch;            
        float pressure;         
        int32 noteId;           
};
 
//------------------------------------------------------------------------
struct ChordEvent
{
        int16 root;                     
        int16 bassNote;         
        int16 mask;                     
        uint16 textLen;         
        const TChar* text;      
};
 
//------------------------------------------------------------------------
struct ScaleEvent
{
        int16 root;                     
        int16 mask;                     
        uint16 textLen;         
        const TChar* text;      
};
 
//------------------------------------------------------------------------
struct LegacyMIDICCOutEvent
{
        uint8 controlNumber;
        int8 channel;           
        int8 value;                     
        int8 value2;            
};
 
//------------------------------------------------------------------------
struct Event
{
        int32 busIndex;                         
        int32 sampleOffset;                     
        TQuarterNotes ppqPosition;      
        uint16 flags;                           

        enum EventFlags
        {
                kIsLive = 1 << 0,                       
 
                kUserReserved1 = 1 << 14,       
                kUserReserved2 = 1 << 15        
        };

        enum EventTypes
        {
                kNoteOnEvent       = 0,                 
                kNoteOffEvent      = 1,                 
                kDataEvent         = 2,                 
                kPolyPressureEvent = 3,                 
                kNoteExpressionValueEvent = 4,  
                kNoteExpressionTextEvent  = 5,  
                kChordEvent        = 6,                 
                kScaleEvent        = 7,                 
                kLegacyMIDICCOutEvent = 65535   
        };
 
        uint16 type;                            
        union
        {
                NoteOnEvent noteOn;                                                             
                NoteOffEvent noteOff;                                                   
                DataEvent data;                                                                 
                PolyPressureEvent polyPressure;                                 
                NoteExpressionValueEvent noteExpressionValue;   
                NoteExpressionTextEvent noteExpressionText;             
                ChordEvent chord;                                                               
                ScaleEvent scale;                                                               
                LegacyMIDICCOutEvent midiCCOut;                                 
        };
};
 
//------------------------------------------------------------------------
class IEventList : public FUnknown
{
public:
//------------------------------------------------------------------------
        virtual int32 PLUGIN_API getEventCount () = 0;

        virtual tresult PLUGIN_API getEvent (int32 index, Event& e /*out*/) = 0;

        virtual tresult PLUGIN_API addEvent (Event& e /*in*/) = 0;
 
//------------------------------------------------------------------------
        static const FUID iid;
};
 
DECLARE_CLASS_IID (IEventList, 0x3A2C4214, 0x346349FE, 0xB2C4F397, 0xB9695A44)
 
//------------------------------------------------------------------------
} // namespace Vst
} // namespace Steinberg
 
//------------------------------------------------------------------------
#include "pluginterfaces/base/falignpop.h"
//------------------------------------------------------------------------