VST 3 Interfaces  VST 3.6.7
SDK for developing VST Plug-in
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Groups Pages
Namespaces | Macros | Typedefs | Functions | Variables
vsttypes.h File Reference
#include "pluginterfaces/base/fstrdefs.h"

Namespaces

 Steinberg
 
 Steinberg::Vst
 All VST specific interfaces are located in Vst namespace.
 
 Steinberg::Vst::SpeakerArr
 Speaker Arrangement Definitions (SpeakerArrangement)
 

Macros

#define kVstVersionString   "VST 3.6.7"
 SDK version for PClassInfo2. More...
 
#define kVstVersionMajor   3
 
#define kVstVersionMinor   6
 
#define kVstVersionSub   7
 
#define VST_VERSION   ((kVstVersionMajor << 16) | (kVstVersionMinor << 8) | kVstVersionSub)
 

Typedefs

typedef char16 TChar
 UTF-16 character. More...
 
typedef TChar String128 [128]
 128 character UTF-16 string More...
 
typedef const char8CString
 C-String. More...
 
typedef int32 MediaType
 media type (audio/event) More...
 
typedef int32 BusDirection
 bus direction (in/out) More...
 
typedef int32 BusType
 bus type (main/aux) More...
 
typedef int32 IoMode
 I/O mode. More...
 
typedef int32 UnitID
 unit identifier More...
 
typedef double ParamValue
 parameter value type More...
 
typedef uint32 ParamID
 parameter identifier More...
 
typedef int32 ProgramListID
 program list identifier More...
 
typedef int16 CtrlNumber
 MIDI controller number (see ControllerNumbers for allowed values) More...
 
typedef double TQuarterNotes
 time expressed in quarter notes More...
 
typedef int64 TSamples
 time expressed in audio samples More...
 
typedef uint32 ColorSpec
 color defining by 4 component ARGB value (Alpha/Red/Green/Blue) More...
 
typedef float Sample32
 32-bit precision audio sample More...
 
typedef double Sample64
 64-bit precision audio sample More...
 
typedef double SampleRate
 sample rate More...
 
typedef uint64 SpeakerArrangement
 Bitset of speakers. More...
 
typedef uint64 Speaker
 Bit for one speaker. More...
 

Functions

int32 getChannelCount (SpeakerArrangement arr)
 Returns number of channels used in speaker arrangement. More...
 
int32 getSpeakerIndex (Speaker speaker, SpeakerArrangement arrangement)
 Returns the index of a given speaker in a speaker arrangement (-1 if speaker is not part of the arrangement). More...
 
Speaker getSpeaker (const SpeakerArrangement &arr, int32 index)
 Returns the speaker for a given index in a speaker arrangement (return 0 when out of range). More...
 
bool isSubsetOf (const SpeakerArrangement &arrSubSet, const SpeakerArrangement &arr)
 Returns true if arrSubSet is a subset speaker of arr (means each speaker of arrSubSet is included in arr). More...
 
SpeakerArrangement getSpeakerArrangementFromString (CString arrStr)
 Returns the speaker arrangement associated to a string representation. More...
 
CString getSpeakerArrangementString (SpeakerArrangement arr, bool withSpeakersName)
 Returns the string representation of a given speaker arrangement. More...
 
CString getSpeakerShortName (const SpeakerArrangement &arr, int32 index)
 Returns a CString representation of a given speaker in a given arrangement. More...
 

Variables

const Speaker kSpeakerL = 1 << 0
 Speaker Definitions. More...
 
const Speaker kSpeakerR = 1 << 1
 Right (R) More...
 
const Speaker kSpeakerC = 1 << 2
 Center (C) More...
 
const Speaker kSpeakerLfe = 1 << 3
 Subbass (Lfe) More...
 
const Speaker kSpeakerLs = 1 << 4
 Left Surround (Ls) More...
 
const Speaker kSpeakerRs = 1 << 5
 Right Surround (Rs) More...
 
const Speaker kSpeakerLc = 1 << 6
 Left of Center (Lc) - Front Left Center. More...
 
const Speaker kSpeakerRc = 1 << 7
 Right of Center (Rc) - Front Right Center. More...
 
const Speaker kSpeakerS = 1 << 8
 Surround (S) More...
 
const Speaker kSpeakerCs = kSpeakerS
 Center of Surround (Cs) - Back Center - Surround (S) More...
 
const Speaker kSpeakerSl = 1 << 9
 Side Left (Sl) More...
 
const Speaker kSpeakerSr = 1 << 10
 Side Right (Sr) More...
 
const Speaker kSpeakerTc = 1 << 11
 Top Center Over-head, Top Middle (Tc) More...
 
const Speaker kSpeakerTfl = 1 << 12
 Top Front Left (Tfl) More...
 
const Speaker kSpeakerTfc = 1 << 13
 Top Front Center (Tfc) More...
 
const Speaker kSpeakerTfr = 1 << 14
 Top Front Right (Tfr) More...
 
const Speaker kSpeakerTrl = 1 << 15
 Top Rear/Back Left (Trl) More...
 
const Speaker kSpeakerTrc = 1 << 16
 Top Rear/Back Center (Trc) More...
 
const Speaker kSpeakerTrr = 1 << 17
 Top Rear/Back Right (Trr) More...
 
const Speaker kSpeakerLfe2 = 1 << 18
 Subbass 2 (Lfe2) More...
 
const Speaker kSpeakerM = 1 << 19
 Mono (M) More...
 
const Speaker kSpeakerW = 1 << 20
 B-Format W. More...
 
const Speaker kSpeakerX = 1 << 21
 B-Format X. More...
 
const Speaker kSpeakerY = 1 << 22
 B-Format Y. More...
 
const Speaker kSpeakerZ = 1 << 23
 B-Format Z. More...
 
const Speaker kSpeakerTsl = 1 << 24
 Top Side Left (Tsl) More...
 
const Speaker kSpeakerTsr = 1 << 25
 Top Side Right (Tsr) More...
 
const Speaker kSpeakerLcs = 1 << 26
 Left of Center Surround (Lcs) - Back Left Center. More...
 
const Speaker kSpeakerRcs = 1 << 27
 Right of Center Surround (Rcs) - Back Right Center. More...
 
const Speaker kSpeakerBfl = 1 << 28
 Bottom Front Left (Bfl) More...
 
const Speaker kSpeakerBfc = 1 << 29
 Bottom Front Center (Bfc) More...
 
const Speaker kSpeakerBfr = 1 << 30
 Bottom Front Right (Bfr) More...
 
const Speaker kSpeakerPl = (Speaker)1 << 31
 Proximity Left (Pl) More...
 
const Speaker kSpeakerPr = (Speaker)1 << 32
 Proximity Right (Pr) More...
 
const SpeakerArrangement kEmpty = 0
 Speaker Arrangement Definitions. More...
 
const SpeakerArrangement kMono = kSpeakerM
 M. More...
 
const SpeakerArrangement kStereo = kSpeakerL | kSpeakerR
 L R. More...
 
const SpeakerArrangement kStereoSurround = kSpeakerLs | kSpeakerRs
 Ls Rs. More...
 
const SpeakerArrangement kStereoCenter = kSpeakerLc | kSpeakerRc
 Lc Rc. More...
 
const SpeakerArrangement kStereoSide = kSpeakerSl | kSpeakerSr
 Sl Sr. More...
 
const SpeakerArrangement kStereoCLfe = kSpeakerC | kSpeakerLfe
 C Lfe. More...
 
const SpeakerArrangement kStereoTF = kSpeakerTfl | kSpeakerTfr
 Tfl Tfr. More...
 
const SpeakerArrangement kStereoTS = kSpeakerTsl | kSpeakerTsr
 Tsl Tsr. More...
 
const SpeakerArrangement kStereoTR = kSpeakerTrl | kSpeakerTrr
 Trl Trr. More...
 
const SpeakerArrangement kStereoBF = kSpeakerBfl | kSpeakerBfr
 Bfl Bfr. More...
 
const SpeakerArrangement k30Cine = kSpeakerL | kSpeakerR | kSpeakerC
 L R C. More...
 
const SpeakerArrangement k30Music = kSpeakerL | kSpeakerR | kSpeakerS
 L R S. More...
 
const SpeakerArrangement k31Cine = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLfe
 L R C Lfe. More...
 
const SpeakerArrangement k31Music = kSpeakerL | kSpeakerR | kSpeakerLfe | kSpeakerS
 L R Lfe S. More...
 
const SpeakerArrangement k40Cine = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerS
 L R C S (LCRS) More...
 
const SpeakerArrangement k40Music = kSpeakerL | kSpeakerR | kSpeakerLs | kSpeakerRs
 L R Ls Rs (Quadro) More...
 
const SpeakerArrangement k41Cine = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLfe | kSpeakerS
 L R C Lfe S (LCRS+Lfe) More...
 
const SpeakerArrangement k41Music = kSpeakerL | kSpeakerR | kSpeakerLfe | kSpeakerLs | kSpeakerRs
 L R Lfe Ls Rs (Quadro+Lfe) More...
 
const SpeakerArrangement k50 = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLs | kSpeakerRs
 L R C Ls Rs. More...
 
const SpeakerArrangement k51 = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLfe | kSpeakerLs | kSpeakerRs
 L R C Lfe Ls Rs. More...
 
const SpeakerArrangement k60Cine = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLs | kSpeakerRs | kSpeakerCs
 L R C Ls Rs Cs. More...
 
const SpeakerArrangement k60Music = kSpeakerL | kSpeakerR | kSpeakerLs | kSpeakerRs | kSpeakerSl | kSpeakerSr
 L R Ls Rs Sl Sr. More...
 
const SpeakerArrangement k61Cine = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerCs
 L R C Lfe Ls Rs Cs. More...
 
const SpeakerArrangement k61Music = kSpeakerL | kSpeakerR | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerSl | kSpeakerSr
 L R Lfe Ls Rs Sl Sr. More...
 
const SpeakerArrangement k70Cine = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLs | kSpeakerRs | kSpeakerLc | kSpeakerRc
 L R C Ls Rs Lc Rc. More...
 
const SpeakerArrangement k70Music = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLs | kSpeakerRs | kSpeakerSl | kSpeakerSr
 L R C Ls Rs Sl Sr. More...
 
const SpeakerArrangement k71Cine = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerLc | kSpeakerRc
 L R C Lfe Ls Rs Lc Rc. More...
 
const SpeakerArrangement k71CineFullFront = k71Cine
 
const SpeakerArrangement k71CineFullRear = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerLcs | kSpeakerRcs
 L R C Lfe Ls Rs Lcs Rcs. More...
 
const SpeakerArrangement k71Music = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerSl | kSpeakerSr
 L R C Lfe Ls Rs Sl Sr. More...
 
const SpeakerArrangement k71CineSideFill = k71Music
 
const SpeakerArrangement k71Proximity = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerPl | kSpeakerPr
 L R C Lfe Ls Rs Pl Pr. More...
 
const SpeakerArrangement k80Cine = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLs | kSpeakerRs | kSpeakerLc | kSpeakerRc | kSpeakerCs
 L R C Ls Rs Lc Rc Cs. More...
 
const SpeakerArrangement k80Music = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLs | kSpeakerRs | kSpeakerCs | kSpeakerSl | kSpeakerSr
 L R C Ls Rs Cs Sl Sr. More...
 
const SpeakerArrangement k81Cine = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerLc | kSpeakerRc | kSpeakerCs
 L R C Lfe Ls Rs Lc Rc Cs. More...
 
const SpeakerArrangement k81Music = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerCs | kSpeakerSl | kSpeakerSr
 L R C Lfe Ls Rs Cs Sl Sr. More...
 
const SpeakerArrangement kBFormat1stOrder = kSpeakerW | kSpeakerX | kSpeakerY | kSpeakerZ
 W X Y Z (First Order) More...
 
const SpeakerArrangement kBFormat = kBFormat1stOrder
 
const SpeakerArrangement k80Cube = kSpeakerL | kSpeakerR | kSpeakerLs | kSpeakerRs | kSpeakerTfl| kSpeakerTfr| kSpeakerTrl | kSpeakerTrr
 L R Ls Rs Tfl Tfr Trl Trr. More...
 
const SpeakerArrangement k71CineTopCenter = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerCs | kSpeakerTc
 L R C Lfe Ls Rs Cs Tc. More...
 
const SpeakerArrangement k71CineCenterHigh = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerCs | kSpeakerTfc
 L R C Lfe Ls Rs Cs Tfc. More...
 
const SpeakerArrangement k71CineFrontHigh = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerTfl | kSpeakerTfr
 L R C Lfe Ls Rs Tfl Tfr. More...
 
const SpeakerArrangement k71MPEG3D = k71CineFrontHigh
 
const SpeakerArrangement k71CineSideHigh = kSpeakerL | kSpeakerR | kSpeakerC | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerTsl | kSpeakerTsr
 L R C Lfe Ls Rs Tsl Tsr. More...
 
const SpeakerArrangement k81MPEG3D
 L R Lfe Ls Rs Tfl Tfc Tfr Bfc. More...
 
const SpeakerArrangement k90
 L R C Ls Rs Tfl Tfr Trl Trr. More...
 
const SpeakerArrangement k91
 L R C Lfe Ls Rs Tfl Tfr Trl Trr. More...
 
const SpeakerArrangement k71_2
 L R C Lfe Ls Rs Sl Sr Tsl Tsr. More...
 
const SpeakerArrangement k91Atmos = k71_2
 
const SpeakerArrangement k100
 L R C Ls Rs Tc Tfl Tfr Trl Trr. More...
 
const SpeakerArrangement k101
 L R C Lfe Ls Rs Tc Tfl Tfr Trl Trr. More...
 
const SpeakerArrangement k101MPEG3D = k101
 
const SpeakerArrangement k102
 L R C Lfe Ls Rs Tfl Tfc Tfr Trl Trr Lfe2. More...
 
const SpeakerArrangement k110
 L R C Ls Rs Tc Tfl Tfc Tfr Trl Trr. More...
 
const SpeakerArrangement k111
 L R C Lfe Ls Rs Tc Tfl Tfc Tfr Trl Trr. More...
 
const SpeakerArrangement k122
 L R C Lfe Ls Rs Lc Rc Tfl Tfc Tfr Trl Trr Lfe2. More...
 
const SpeakerArrangement k130
 L R C Ls Rs Cs Tc Tfl Tfc Tfr Trl Trc Trr. More...
 
const SpeakerArrangement k131
 L R C Lfe Ls Rs Cs Tc Tfl Tfc Tfr Trl Trc Trr. More...
 
const SpeakerArrangement k222
 L R C Lfe Ls Rs Lc Rc Cs Sl Sr Tc Tfl Tfc Tfr Trl Trc Trr Lfe2 Tsl Tsr Bfl Bfc Bfr. More...
 
const CString kStringEmpty = ""
 Speaker Arrangement String Representation. More...
 
const CString kStringMono = "Mono"
 
const CString kStringStereo = "Stereo"
 
const CString kStringStereoR = "Stereo (Ls Rs)"
 
const CString kStringStereoC = "Stereo (Lc Rc)"
 
const CString kStringStereoSide = "Stereo (Sl Sr)"
 
const CString kStringStereoCLfe = "Stereo (C LFE)"
 
const CString kStringStereoTF = "Stereo (Tfl Tfr)"
 
const CString kStringStereoTS = "Stereo (Tsl Tsr)"
 
const CString kStringStereoTR = "Stereo (Trl Trr)"
 
const CString kStringStereoBF = "Stereo (Bfl Bfr)"
 
const CString kString30Cine = "LRC"
 
const CString kString30Music = "LRS"
 
const CString kString31Cine = "LRC+LFE"
 
const CString kString31Music = "LRS+LFE"
 
const CString kString40Cine = "LRCS"
 
const CString kString40Music = "Quadro"
 
const CString kString41Cine = "LRCS+LFE"
 
const CString kString41Music = "Quadro+LFE"
 
const CString kString50 = "5.0"
 
const CString kString51 = "5.1"
 
const CString kString60Cine = "6.0 Cine"
 
const CString kString60Music = "6.0 Music"
 
const CString kString61Cine = "6.1 Cine"
 
const CString kString61Music = "6.1 Music"
 
const CString kString70Cine = "7.0 Cine (SDDS)"
 
const CString kString70Music = "7.0 Music (Dolby)"
 
const CString kString71Cine = "7.1 Cine (SDDS)"
 
const CString kString71Music = "7.1 Music (Dolby)"
 
const CString kString71CineTopCenter = "7.1 Cine Top Center"
 
const CString kString71CineCenterHigh = "7.1 Cine Center High"
 
const CString kString71CineFrontHigh = "7.1 Cine Front High"
 
const CString kString71CineSideHigh = "7.1 Cine Side High"
 
const CString kString71CineFullRear = "7.1 Cine Full Rear"
 
const CString kString71Proximity = "7.1 Proximity"
 
const CString kString80Cine = "8.0 Cine"
 
const CString kString80Music = "8.0 Music"
 
const CString kString80Cube = "8.0 Cube"
 
const CString kString81Cine = "8.1 Cine"
 
const CString kString81Music = "8.1 Music"
 
const CString kString102 = "10.2 Experimental"
 
const CString kString122 = "12.2"
 
const CString kString90 = "9.0 Auro-3D"
 
const CString kString91 = "9.1 Auro-3D"
 
const CString kString91Atmos = "9.1 Dolby Atmos"
 
const CString kString100 = "10.0 Auro-3D"
 
const CString kString101 = "10.1 Auro-3D"
 
const CString kString110 = "11.0 Auro-3D"
 
const CString kString111 = "11.1 Auro-3D"
 
const CString kString130 = "13.0 Auro-3D"
 
const CString kString131 = "13.1 Auro-3D"
 
const CString kString81MPEG = "8.1 MPEG"
 
const CString kString222 = "22.2"
 
const CString kStringBFormat1stOrder = "BFormat"
 
const CString kStringMonoS = "M"
 Speaker Arrangement String Representation with Speakers Name. More...
 
const CString kStringStereoS = "L R"
 
const CString kStringStereoRS = "Ls Rs"
 
const CString kStringStereoCS = "Lc Rc"
 
const CString kStringStereoSS = "Sl Sr"
 
const CString kStringStereoCLfeS = "C LFE"
 
const CString kStringStereoTFS = "Tfl Tfr"
 
const CString kStringStereoTSS = "Tsl Tsr"
 
const CString kStringStereoTRS = "Trl Trr"
 
const CString kStringStereoBFS = "Bfl Bfr"
 
const CString kString30CineS = "L R C"
 
const CString kString30MusicS = "L R S"
 
const CString kString31CineS = "L R C LFE"
 
const CString kString31MusicS = "L R LFE S"
 
const CString kString40CineS = "L R C S"
 
const CString kString40MusicS = "L R Ls Rs"
 
const CString kString41CineS = "L R C LFE S"
 
const CString kString41MusicS = "L R LFE Ls Rs"
 
const CString kString50S = "L R C Ls Rs"
 
const CString kString51S = "L R C LFE Ls Rs"
 
const CString kString60CineS = "L R C Ls Rs Cs"
 
const CString kString60MusicS = "L R Ls Rs Sl Sr"
 
const CString kString61CineS = "L R C LFE Ls Rs Cs"
 
const CString kString61MusicS = "L R LFE Ls Rs Sl Sr"
 
const CString kString70CineS = "L R C Ls Rs Lc Rc"
 
const CString kString70MusicS = "L R C Ls Rs Sl Sr"
 
const CString kString71CineS = "L R C LFE Ls Rs Lc Rc"
 
const CString kString71MusicS = "L R C LFE Ls Rs Sl Sr"
 
const CString kString80CineS = "L R C Ls Rs Lc Rc Cs"
 
const CString kString80MusicS = "L R C Ls Rs Cs Sl Sr"
 
const CString kString81CineS = "L R C LFE Ls Rs Lc Rc Cs"
 
const CString kString81MusicS = "L R C LFE Ls Rs Cs Sl Sr"
 
const CString kString80CubeS = "L R Ls Rs Tfl Tfr Trl Trr"
 
const CString kStringBFormat1stOrderS = "W X Y Z"
 
const CString kString71CineTopCenterS = "L R C LFE Ls Rs Cs Tc"
 
const CString kString71CineCenterHighS = "L R C LFE Ls Rs Cs Tfc"
 
const CString kString71CineFrontHighS = "L R C LFE Ls Rs Tfl Tfl"
 
const CString kString71CineSideHighS = "L R C LFE Ls Rs Tsl Tsl"
 
const CString kString71CineFullRearS = "L R C LFE Ls Rs Lcs Rcs"
 
const CString kString71ProximityS = "L R C LFE Ls Rs Pl Pr"
 
const CString kString90S = "L R C Ls Rs Tfl Tfr Trl Trr"
 
const CString kString91S = "L R C LFE Ls Rs Tfl Tfr Trl Trr"
 
const CString kString91AtmosS = "L R C LFE Ls Rs Sl Sr Tsl Tsr"
 
const CString kString100S = "L R C Ls Rs Tc Tfl Tfr Trl Trr"
 
const CString kString101S = "L R C LFE Ls Rs Tc Tfl Tfr Trl Trr"
 
const CString kString110S = "L R C Ls Rs Tc Tfl Tfc Tfr Trl Trr"
 
const CString kString111S = "L R C LFE Ls Rs Tc Tfl Tfc Tfr Trl Trr"
 
const CString kString130S = "L R C Ls Rs Sl Sr Tc Tfl Tfc Tfr Trl Trr"
 
const CString kString131S = "L R C LFE Ls Rs Sl Sr Tc Tfl Tfc Tfr Trl Trr"
 
const CString kString102S = "L R C LFE Ls Rs Tfl Tfc Tfr Trl Trr LFE2"
 
const CString kString122S = "L R C LFE Ls Rs Lc Rc Tfl Tfc Tfr Trl Trr LFE2"
 
const CString kString81MPEGS = "L R LFE Ls Rs Tfl Tfc Tfr Bfc"
 
const CString kString222S = "L R C LFE Ls Rs Lc Rc Cs Sl Sr Tc Tfl Tfc Tfr Trl Trc Trr LFE2 Tsl Tsr Bfl Bfc Bfr"
 

Macro Definition Documentation

#define kVstVersionString   "VST 3.6.7"

SDK version for PClassInfo2.

#define kVstVersionMajor   3
#define kVstVersionMinor   6
#define kVstVersionSub   7
#define VST_VERSION   ((kVstVersionMajor << 16) | (kVstVersionMinor << 8) | kVstVersionSub)
Empty

Copyright ©2017 Steinberg Media Technologies GmbH. All Rights Reserved. This documentation is under this license.