vsttypes.h

Go to the documentation of this file.

//------------------------------------------------------------------------
// Project     : VST SDK
// Version     : 3.0
//
// Category    : Interfaces
// Filename    : vsttypes.h
// Created by  : Steinberg, 12/2005
// Modified    : $Date: 2008/01/16 07:48:01 $
// Description : common defines
//
//-----------------------------------------------------------------------------
// LICENSE
// © 2008, Steinberg Media Technologies GmbH, All Rights Reserved
//-----------------------------------------------------------------------------
// This Software Development Kit may not be distributed in parts or its entirety  
// without prior written agreement by Steinberg Media Technologies GmbH. 
// This SDK must not be used to re-engineer or manipulate any technology used  
// in any Steinberg or Third-party application or software module, 
// unless permitted by law.
// Neither the name of the Steinberg Media Technologies nor the names of its
// contributors may be used to endorse or promote products derived from this 
// software without specific prior written permission.
// 
// THIS SDK IS PROVIDED BY STEINBERG MEDIA TECHNOLOGIES GMBH "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL STEINBERG MEDIA TECHNOLOGIES GMBH BE LIABLE FOR ANY DIRECT, 
// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// OF THE POSSIBILITY OF SUCH DAMAGE.
//----------------------------------------------------------------------------------

#ifndef __vsttypes__
#define __vsttypes__

#include "pluginterfaces/base/ftypes.h"
#include "pluginterfaces/base/ustring.h"

//------------------------------------------------------------------------
namespace Steinberg {
namespace Vst {

//------------------------------------------------------------------------
#ifndef kVstVersionString
#define kVstVersionString       "VST 3.0"       
#endif

//------------------------------------------------------------------------
// string types
//------------------------------------------------------------------------
typedef char16 TChar;                   
typedef TChar String128[128];   
typedef const char8* CString;   

//------------------------------------------------------------------------
// general 
//------------------------------------------------------------------------
typedef int32 MediaType;                
typedef int32 BusDirection;             
typedef int32 BusType;                  
typedef int32 IoMode;                   
typedef int32 UnitID;                   
typedef double ParamValue;              
typedef uint32 ParamID;                 
typedef int32 ProgramListID;    
typedef int16 CtrlNumber;               

typedef double TQuarterNotes;   
typedef int64 TSamples;                 

//------------------------------------------------------------------------
// audio types
//------------------------------------------------------------------------
typedef float Sample32;                         
typedef double Sample64;                        
typedef double SampleRate;                      
typedef uint64 SpeakerArrangement;      

//------------------------------------------------------------------------
// restart flags
//------------------------------------------------------------------------
enum RestartFlags
{
        kReloadComponent        = 1 << 0,       
        kIoChanged                      = 1 << 1,       
        kParamValuesChanged     = 1 << 2,       
        kLatencyChanged         = 1 << 3,       
        kParamTitlesChanged     = 1 << 4        
};

//------------------------------------------------------------------------
//------------------------------------------------------------------------
enum Speaker
{
//------------------------------------------------------------------------
        kSpeakerL    = 1 << 0,          
        kSpeakerR    = 1 << 1,          
        kSpeakerC    = 1 << 2,          
        kSpeakerLfe  = 1 << 3,          
        kSpeakerLs   = 1 << 4,          
        kSpeakerRs   = 1 << 5,          
        kSpeakerLc   = 1 << 6,          
        kSpeakerRc   = 1 << 7,          
        kSpeakerS    = 1 << 8,          
        kSpeakerCs   = kSpeakerS,       
        kSpeakerSl   = 1 << 9,          
        kSpeakerSr   = 1 << 10,         
        kSpeakerTm   = 1 << 11,         
        kSpeakerTfl  = 1 << 12,         
        kSpeakerTfc  = 1 << 13,         
        kSpeakerTfr  = 1 << 14,         
        kSpeakerTrl  = 1 << 15,         
        kSpeakerTrc  = 1 << 16,         
        kSpeakerTrr  = 1 << 17,         
        kSpeakerLfe2 = 1 << 18,         
        kSpeakerM    = 1 << 19,         
        
        kSpeakerW        = 1 << 20,             
        kSpeakerX        = 1 << 21,             
        kSpeakerY        = 1 << 22,             
        kSpeakerZ        = 1 << 23,             

        kSpeakerTsl      = 1 << 24,             
        kSpeakerTsr      = 1 << 25,             
        kSpeakerLcs  = 1 << 26,         
        kSpeakerRcs  = 1 << 27          
        
//------------------------------------------------------------------------
};

//------------------------------------------------------------------------
//------------------------------------------------------------------------
namespace SpeakerArr
{
const SpeakerArrangement kEmpty                  = 0;          
const SpeakerArrangement kMono                   = kSpeakerM;  
const SpeakerArrangement kStereo                 = kSpeakerL  | kSpeakerR;    
const SpeakerArrangement kStereoSurround = kSpeakerLs | kSpeakerRs;       
const SpeakerArrangement kStereoCenter   = kSpeakerLc | kSpeakerRc;   
const SpeakerArrangement kStereoSide     = kSpeakerSl | kSpeakerSr;       
const SpeakerArrangement kStereoCLfe     = kSpeakerC  | kSpeakerLfe;  
const SpeakerArrangement k30Cine                 = kSpeakerL  | kSpeakerR | kSpeakerC;  
const SpeakerArrangement k30Music                = kSpeakerL  | kSpeakerR | kSpeakerS;  
const SpeakerArrangement k31Cine                 = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLfe;  
const SpeakerArrangement k31Music                = kSpeakerL  | kSpeakerR | kSpeakerLfe | kSpeakerS;    
const SpeakerArrangement k40Cine                 = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerS;    
const SpeakerArrangement k40Music                = kSpeakerL  | kSpeakerR | kSpeakerLs  | kSpeakerRs;   
const SpeakerArrangement k41Cine                 = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLfe | kSpeakerS;       
const SpeakerArrangement k41Music                = kSpeakerL  | kSpeakerR | kSpeakerLfe | kSpeakerLs  | kSpeakerRs;  
const SpeakerArrangement k50                     = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLs  | kSpeakerRs;      
const SpeakerArrangement k51                     = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLfe | kSpeakerLs | kSpeakerRs;  
const SpeakerArrangement k60Cine                 = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLs  | kSpeakerRs | kSpeakerCs;  
const SpeakerArrangement k60Music                = kSpeakerL  | kSpeakerR | kSpeakerLs  | kSpeakerRs  | kSpeakerSl | kSpeakerSr;  
const SpeakerArrangement k61Cine                 = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerCs;  
const SpeakerArrangement k61Music                = kSpeakerL  | kSpeakerR | kSpeakerLfe | kSpeakerLs  | kSpeakerRs | kSpeakerSl | kSpeakerSr;  
const SpeakerArrangement k70Cine                 = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLs  | kSpeakerRs | kSpeakerLc | kSpeakerRc;  
const SpeakerArrangement k70Music                = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLs  | kSpeakerRs | kSpeakerSl | kSpeakerSr;  
const SpeakerArrangement k71Cine                 = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerLc | kSpeakerRc;      
const SpeakerArrangement k71Music                = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerSl | kSpeakerSr;      
const SpeakerArrangement k80Cine                 = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLs  | kSpeakerRs | kSpeakerLc | kSpeakerRc | kSpeakerCs;  
const SpeakerArrangement k80Music                = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLs  | kSpeakerRs | kSpeakerCs | kSpeakerSl | kSpeakerSr;      
const SpeakerArrangement k81Cine                 = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerLc | kSpeakerRc | kSpeakerCs;  
const SpeakerArrangement k81Music                = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerCs | kSpeakerSl | kSpeakerSr;  
const SpeakerArrangement k102                    = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerTfl | kSpeakerTfc | kSpeakerTfr | kSpeakerTrl | kSpeakerTrr | kSpeakerLfe2;   
const SpeakerArrangement k102Plus                = kSpeakerL  | kSpeakerR | kSpeakerC   | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerLc | kSpeakerRc | kSpeakerTfl | kSpeakerTfc | kSpeakerTfr | kSpeakerTrl | kSpeakerTrr | kSpeakerLfe2; 
const SpeakerArrangement kCube                   = kSpeakerL  | kSpeakerR | kSpeakerLs  | kSpeakerRs  | kSpeakerTfl | kSpeakerTfr | kSpeakerTrl | kSpeakerTrr;  
const SpeakerArrangement kBFormat                = kSpeakerW  | kSpeakerX | kSpeakerY   | kSpeakerZ;  

const SpeakerArrangement k71CineTopCenter  = kSpeakerL | kSpeakerR | kSpeakerC  | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerCs | kSpeakerTm;              
const SpeakerArrangement k71CineCenterHigh = kSpeakerL | kSpeakerR | kSpeakerC  | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerCs | kSpeakerTfc;     
const SpeakerArrangement k71CineFrontHigh  = kSpeakerL | kSpeakerR | kSpeakerC  | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerTfl | kSpeakerTfr;    
const SpeakerArrangement k71CineSideHigh   = kSpeakerL | kSpeakerR | kSpeakerC  | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerTsl | kSpeakerTsr;    
const SpeakerArrangement k71CineSideFill   = k61Music;
const SpeakerArrangement k71CineFullRear   = kSpeakerL | kSpeakerR | kSpeakerC  | kSpeakerLfe | kSpeakerLs | kSpeakerRs | kSpeakerLcs | kSpeakerRcs;    
const SpeakerArrangement k71CineFullFront  = k71Cine;

inline int32 getChannelCount (SpeakerArrangement arr)
{
        int32 count = 0;
        while (arr) 
        {
                if (arr & SpeakerArrangement(1)) 
                        ++count;
                arr >>= 1;
        }
        return count;
}
//------------------------------------------------------------------------
}

} // namespace Vst
} // namespace Steinberg


#endif  // __vsttypes__

---

Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.