AAX_Enums.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013 by Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  CONFIDENTIAL: This document contains confidential information.  Do not 
 *  read or examine this document unless you are an Avid Technology employee
 *  or have signed a non-disclosure agreement with Avid Technology which protects
 *  the confidentiality of this document.  DO NOT DISCLOSE ANY INFORMATION 
 *  CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT 
 *  OF Avid Technolgy, INC.
 *
 */

/*================================================================================================*/


#ifndef AAX_ENUMS_H
#define AAX_ENUMS_H

#include <stdint.h>

#define AAX_INT32_MIN    (-2147483647 - 1) 
#define AAX_INT32_MAX      2147483647      
#define AAX_UINT32_MIN     0U              
#define AAX_UINT32_MAX     4294967295U     
#define AAX_INT16_MIN    (-32767 - 1)      
#define AAX_INT16_MAX      32767           
#define AAX_UINT16_MIN     0U              
#define AAX_UINT16_MAX     65535U          
#ifndef _TMS320C6X
#define AAX_ENUM_SIZE_CHECK(x) extern int __enumSizeCheck[ 2*(sizeof(uint32_t)==sizeof(x)) - 1]
#else
#define AAX_ENUM_SIZE_CHECK(x)
#endif

//******************************************************************
// ENUM: AAX_EIconGUIType
//******************************************************************
enum AAX_EIconGUIType
{
    AAX_eIconGUIType_Undefined = -1,
    AAX_eIconGUIType_GuitarRig = 0, // 60 x 64
    
    AAX_eIconGUIType_Num
}; AAX_ENUM_SIZE_CHECK( AAX_EIconGUIType );

//******************************************************************
// ENUM: AAX_EHighlightColor
//******************************************************************
enum AAX_EHighlightColor
{
    AAX_eHighlightColor_Red = 0,
    AAX_eHighlightColor_Blue = 1,
    AAX_eHighlightColor_Green = 2,
    AAX_eHighlightColor_Yellow = 3,

    AAX_eHighlightColor_Num
}; AAX_ENUM_SIZE_CHECK( AAX_EHighlightColor );


enum AAX_ETracePriorityHost
{
    AAX_eTracePriorityHost_None     = 0,
    AAX_eTracePriorityHost_High     = 0x08000000,
    AAX_eTracePriorityHost_Normal   = 0x04000000,
    AAX_eTracePriorityHost_Low      = 0x02000000
}; AAX_ENUM_SIZE_CHECK( AAX_ETracePriorityHost );

enum AAX_ETracePriorityDSP
{
    AAX_eTracePriorityDSP_None = 0,
    AAX_eTracePriorityDSP_Assert, 
    AAX_eTracePriorityDSP_High,
    AAX_eTracePriorityDSP_Normal,
    AAX_eTracePriorityDSP_Low
}; AAX_ENUM_SIZE_CHECK( AAX_ETracePriorityDSP );

enum AAX_EModifiers
{
    AAX_eModifiers_None             = 0,
    
    AAX_eModifiers_Shift            = ( 1 << 0 ), 
    AAX_eModifiers_Control          = ( 1 << 1 ), 
    AAX_eModifiers_Option           = ( 1 << 2 ), 
    AAX_eModifiers_Command          = ( 1 << 3 ), 
    AAX_eModifiers_SecondaryButton  = ( 1 << 4 ), 
    
    AAX_eModifiers_Alt              = AAX_eModifiers_Option,  
    AAX_eModifiers_Cntl             = AAX_eModifiers_Command, 
    AAX_eModifiers_WINKEY           = AAX_eModifiers_Control 
}; AAX_ENUM_SIZE_CHECK( AAX_EModifiers );

enum AAX_EAudioBufferLength
{
    AAX_eAudioBufferLength_Undefined = -1,
    AAX_eAudioBufferLength_1 = 0,
    AAX_eAudioBufferLength_2 = 1,
    AAX_eAudioBufferLength_4 = 2,
    AAX_eAudioBufferLength_8 = 3,
    AAX_eAudioBufferLength_16 = 4,
    AAX_eAudioBufferLength_32 = 5,
    AAX_eAudioBufferLength_64 = 6,
    AAX_eAudioBufferLength_128 = 7,
    AAX_eAudioBufferLength_256 = 8,
    AAX_eAudioBufferLength_512 = 9,
    AAX_eAudioBufferLength_1024 = 10,
    
    AAX_eAudioBufferLength_Max = AAX_eAudioBufferLength_1024
}; AAX_ENUM_SIZE_CHECK( AAX_EAudioBufferLength );

enum AAX_EAudioBufferLengthDSP
{
    AAX_eAudioBufferLengthDSP_Default = AAX_eAudioBufferLength_4,
    AAX_eAudioBufferLengthDSP_4 = AAX_eAudioBufferLength_4,
    AAX_eAudioBufferLengthDSP_16 = AAX_eAudioBufferLength_16,
    AAX_eAudioBufferLengthDSP_32 = AAX_eAudioBufferLength_32,
    AAX_eAudioBufferLengthDSP_64 = AAX_eAudioBufferLength_64,
    
    AAX_eAudioBufferLengthDSP_Max = AAX_eAudioBufferLengthDSP_64
}; AAX_ENUM_SIZE_CHECK( AAX_EAudioBufferLengthDSP );

enum AAE_EAudioBufferLengthNative
{
    AAX_eAudioBufferLengthNative_Min = AAX_eAudioBufferLength_32,   
    AAX_eAudioBufferLengthNative_Max = AAX_eAudioBufferLength_Max      
}; AAX_ENUM_SIZE_CHECK( AAE_EAudioBufferLengthNative );

enum AAX_EMaxAudioSuiteTracks
{
    AAX_eMaxAudioSuiteTracks = 48
}; AAX_ENUM_SIZE_CHECK( AAX_EMaxAudioSuiteTracks );

// The channel count ternary here will issue a warning due to a
// signed/unsigned mismatch if anyone tries to create an
// AAX_STEM_FORMAT definition with a negative channel count.
#define AAX_STEM_FORMAT( aIndex, aChannelCount )        ( static_cast<uint32_t>( ( static_cast<uint16_t>(aIndex) << 16 ) | ( (aChannelCount >= AAX_UINT16_MIN) && (aChannelCount <= 0xFFFF) ? aChannelCount & 0xFFFF : 0x0000 ) ) )
#define AAX_STEM_FORMAT_CHANNEL_COUNT( aStemFormat )    ( static_cast<uint16_t>( aStemFormat & 0xFFFF ) )
#define AAX_STEM_FORMAT_INDEX( aStemFormat )            ( static_cast<int16_t>( ( aStemFormat >> 16 ) & 0xFFFF ) )

enum AAX_EStemFormat
{
    AAX_eStemFormat_Mono        = AAX_STEM_FORMAT ( 0,   1 ),   
    AAX_eStemFormat_Stereo      = AAX_STEM_FORMAT ( 1,   2 ),   
    AAX_eStemFormat_LCR         = AAX_STEM_FORMAT ( 2,   3 ),   
    AAX_eStemFormat_LCRS        = AAX_STEM_FORMAT ( 3,   4 ),   
    AAX_eStemFormat_Quad        = AAX_STEM_FORMAT ( 4,   4 ),   
    AAX_eStemFormat_5_0         = AAX_STEM_FORMAT ( 5,   5 ),   
    AAX_eStemFormat_5_1         = AAX_STEM_FORMAT ( 6,   6 ),   
    AAX_eStemFormat_6_0         = AAX_STEM_FORMAT ( 7,   6 ),   
    AAX_eStemFormat_6_1         = AAX_STEM_FORMAT ( 8,   7 ),   
    AAX_eStemFormat_7_0_SDDS    = AAX_STEM_FORMAT ( 9,   7 ),   
    AAX_eStemFormat_7_1_SDDS    = AAX_STEM_FORMAT ( 10,  8 ),   
    AAX_eStemFormat_7_0_DTS     = AAX_STEM_FORMAT ( 11,  7 ),   
    AAX_eStemFormat_7_1_DTS     = AAX_STEM_FORMAT ( 12,  8 ),   
    
    AAX_eStemFormatNum          = 13,                           // This needs to increase as stem types are added.
    
    AAX_eStemFormat_None        = AAX_STEM_FORMAT ( -100, 0 ),
    AAX_eStemFormat_Any         = AAX_STEM_FORMAT ( -1, 0 ),
    
    AAX_eStemFormat_INT32_MAX = AAX_INT32_MAX
}; AAX_ENUM_SIZE_CHECK( AAX_EStemFormat );

enum AAX_EPlugInCategory                            
{
    AAX_ePlugInCategory_None            = 0x00000000,
    AAX_ePlugInCategory_EQ              = 0x00000001,   
    AAX_ePlugInCategory_Dynamics        = 0x00000002,   
    AAX_ePlugInCategory_PitchShift      = 0x00000004,   
    AAX_ePlugInCategory_Reverb          = 0x00000008,   
    AAX_ePlugInCategory_Delay           = 0x00000010,   
    AAX_ePlugInCategory_Modulation      = 0x00000020,   
    AAX_ePlugInCategory_Harmonic        = 0x00000040,   
    AAX_ePlugInCategory_NoiseReduction  = 0x00000080,   
    AAX_ePlugInCategory_Dither          = 0x00000100,   
    AAX_ePlugInCategory_SoundField      = 0x00000200,   
    AAX_ePlugInCategory_HWGenerators    = 0x00000400,   
    AAX_ePlugInCategory_SWGenerators    = 0x00000800,   
    AAX_ePlugInCategory_WrappedPlugin   = 0x00001000,   
    
    AAX_ePlugInCategory_Example         = 0x00004000,   
    
    AAX_ePlugInCategory_INT32_MAX = AAX_INT32_MAX
}; AAX_ENUM_SIZE_CHECK( AAX_EPlugInCategory );

enum AAX_EPlugInStrings
{
    AAX_ePlugInStrings_Analysis = 0,                    
    AAX_ePlugInStrings_MonoMode = 1,                    
    AAX_ePlugInStrings_MultiInputMode = 2,              
    AAX_ePlugInStrings_RegionByRegionAnalysis = 3,      
    AAX_ePlugInStrings_AllSelectedRegionsAnalysis = 4,  
    AAX_ePlugInStrings_RegionName = 5,                  
    AAX_ePlugInStrings_ClipName = 5,                    
    AAX_ePlugInStrings_Progress = 6,                    
    AAX_ePlugInStrings_PlugInFileName = 7,              
    AAX_ePlugInStrings_Preview = 8,                     
    AAX_ePlugInStrings_Process = 9,                     
    AAX_ePlugInStrings_Bypass = 10,                     
    
    AAX_ePlugInStrings_INT32_MAX = AAX_INT32_MAX
}; AAX_ENUM_SIZE_CHECK( AAX_EPlugInStrings );

enum AAX_EMeterOrientation
{
    AAX_eMeterOrientation_Default = 0,
    AAX_eMeterOrientation_BottomLeft = AAX_eMeterOrientation_Default,       
    AAX_eMeterOrientation_TopRight = 1,             
    AAX_eMeterOrientation_Center = 2,           
    AAX_eMeterOrientation_PhaseDot = 3          
}; AAX_ENUM_SIZE_CHECK( AAX_EMeterOrientation );


enum AAX_EMeterBallisticType
{
    AAX_eMeterBallisticType_Host = 0,           
    AAX_eMeterBallisticType_NoDecay = 1     
}; AAX_ENUM_SIZE_CHECK( AAX_EMeterBallisticType );

enum AAX_EMeterType
{
    AAX_eMeterType_Input = 0,               
    AAX_eMeterType_Output = 1,              
    AAX_eMeterType_CLGain = 2,              
    AAX_eMeterType_EGGain = 3,              
    AAX_eMeterType_Analysis = 4,                
    AAX_eMeterType_Other = 5                    
}; AAX_ENUM_SIZE_CHECK( AAX_EMeterType );

enum    AAX_ECurveType
{
    AAX_eCurveType_EQ = 'AXeq',             
    AAX_eCurveType_Dynamics = 'AXdy',       
    AAX_eCurveType_Reduction = 'AXdr'       
}; AAX_ENUM_SIZE_CHECK( AAX_ECurveType );

enum AAX_EResourceType
{
    AAX_eResourceType_None = 0,
    AAX_eResourceType_PageTable             
}; AAX_ENUM_SIZE_CHECK( AAX_EResourceType );

enum AAX_ENotificationEvent
{
    AAX_eNotificationEvent_ASProcessingState = 'AXPr',      
    AAX_eNotificationEvent_ASPreviewState = 'ASPv',         
    AAX_eNotificationEvent_SessionBeingOpened = 'AXso',     
    AAX_eNotificationEvent_PresetOpened = 'AXpo',           
    AAX_eNotificationEvent_EnteringOfflineMode = 'AXof',    
    AAX_eNotificationEvent_ExitingOfflineMode = 'AXox',     
    AAX_eNotificationEvent_SessionPathChanged = 'AXsp',     
    AAX_eNotificationEvent_SignalLatencyChanged = 'AXsl',   
    AAX_eNotificationEvent_MaxViewSizeChanged = 'AXws',     
    AAX_eNotificationEvent_SideChainBeingConnected = 'AXsc',
    AAX_eNotificationEvent_SideChainBeingDisconnected = 'AXsd' 
}; AAX_ENUM_SIZE_CHECK( AAX_ENotificationEvent );


enum AAX_EPrivateDataOptions
{
    AAX_ePrivateDataOptions_DefaultOptions  = 0,
    AAX_ePrivateDataOptions_KeepOnReset     = (1 << 0),         
    AAX_ePrivateDataOptions_External        = (1 << 1),         
    AAX_ePrivateDataOptions_Align8          = (1 << 2),         
    
    AAX_ePrivateDataOptions_INT32_MAX = AAX_INT32_MAX
}; AAX_ENUM_SIZE_CHECK( AAX_EPrivateDataOptions );


enum AAX_EConstraintLocationMask
{
    AAX_eConstraintLocationMask_None            = 0,
    AAX_eConstraintLocationMask_DataModel       = (1 << 0),
    AAX_eConstraintLocationMask_DLLChipAffinity = (1 << 1)
}; AAX_ENUM_SIZE_CHECK( AAX_EConstraintLocationMask );

enum AAX_EConstraintTopology
{
    AAX_eConstraintTopology_None            = 0,    
    AAX_eConstraintTopology_Monolithic      = 1     
}; AAX_ENUM_SIZE_CHECK( AAX_EConstraintTopology );

enum AAX_EComponentInstanceInitAction
{
    AAX_eComponentInstanceInitAction_AddingNewInstance = 0,
    AAX_eComponentInstanceInitAction_RemovingInstance = 1,
    AAX_eComponentInstanceInitAction_ResetInstance = 2
}; AAX_ENUM_SIZE_CHECK( AAX_EComponentInstanceInitAction );

enum AAX_ESampleRateMask
{
    AAX_eSampleRateMask_No = 0,
    
    AAX_eSampleRateMask_44100 = (1 << 0),
    AAX_eSampleRateMask_48000 = (1 << 1),
    AAX_eSampleRateMask_88200 = (1 << 2),
    AAX_eSampleRateMask_96000 = (1 << 3),
    AAX_eSampleRateMask_176400 = (1 << 4),
    AAX_eSampleRateMask_192000 = (1 << 5),
    
    AAX_eSampleRateMask_All = AAX_INT32_MAX
}; AAX_ENUM_SIZE_CHECK( AAX_ESampleRateMask );

typedef enum AAX_EParameterType
{
    AAX_eParameterType_Discrete,         
    AAX_eParameterType_Continuous        
} AAX_EParameterType;  AAX_ENUM_SIZE_CHECK( AAX_EParameterType );

enum AAX_EParameterOrientationBits {
    AAX_eParameterOrientation_BottomMinTopMax = 0,          // Choose this...
    AAX_eParameterOrientation_TopMinBottomMax = 1,          // or this.
    
    AAX_eParameterOrientation_LeftMinRightMax = 0,          // AND this...
    AAX_eParameterOrientation_RightMinLeftMax = 2,          // or this.
    
    // Rotary multi-Segment Display Choices
    AAX_eParameterOrientation_RotarySingleDotMode = 0,      // AND this...
    AAX_eParameterOrientation_RotaryBoostCutMode = 4,       // or this.
    AAX_eParameterOrientation_RotaryWrapMode = 8,           // or this.
    AAX_eParameterOrientation_RotarySpreadMode = 12,            // or this.
    
    // Rotary multi-Segment Display Polarity
    AAX_eParameterOrientation_RotaryLeftMinRightMax = 0,        // AND this...
    AAX_eParameterOrientation_RotaryRightMinLeftMax = 16        // or this.
}; AAX_ENUM_SIZE_CHECK( AAX_EParameterOrientationBits );

typedef int32_t     AAX_EParameterOrientation;

enum AAX_EParameterValueInfoSelector
{
    AAX_ePageTable_EQ_Band_Type = 0,
    AAX_ePageTable_EQ_InCircuitPolarity = 1,
    AAX_ePageTable_UseAlternateControl = 2
}; AAX_ENUM_SIZE_CHECK( AAX_EParameterValueInfoSelector );

enum AAX_EEQBandTypes
{
    AAX_eEQBandType_HighPass = 0,           
    AAX_eEQBandType_LowShelf = 1,           
    AAX_eEQBandType_Parametric = 2,         
    AAX_eEQBandType_HighShelf = 3,          
    AAX_eEQBandType_LowPass = 4,            
    AAX_eEQBandType_Notch = 5               
}; AAX_ENUM_SIZE_CHECK( AAX_EEQBandTypes );

enum AAX_EEQInCircuitPolarity
{
    AAX_eEQInCircuitPolarity_Enabled = 0,       
    AAX_eEQInCircuitPolarity_Bypassed = 1,      
    AAX_eEQInCircuitPolarity_Disabled = 2       
}; AAX_ENUM_SIZE_CHECK( AAX_EEQInCircuitPolarity );

enum AAX_EUseAlternateControl
{
    AAX_eUseAlternateControl_No = 0,
    AAX_eUseAlternateControl_Yes = 1
}; AAX_ENUM_SIZE_CHECK( AAX_EUseAlternateControl );

enum AAX_EMIDINodeType
{
    AAX_eMIDINodeType_LocalInput = 0,
    AAX_eMIDINodeType_LocalOutput = 1,
    AAX_eMIDINodeType_Global = 2,
    AAX_eMIDINodeType_Transport = 3
}; AAX_ENUM_SIZE_CHECK( AAX_EMIDINodeType );


enum AAX_EUpdateSource
{
    AAX_eUpdateSource_Unspecified = 0,          
    AAX_eUpdateSource_Parameter = 1,            
    AAX_eUpdateSource_Chunk = 2,                
    AAX_eUpdateSource_Delay = 3                 
}; AAX_ENUM_SIZE_CHECK( AAX_EUpdateSource );

enum AAX_EDataInPortType
{
    AAX_eDataInPortType_Unbuffered      = 0,    
    AAX_eDataInPortType_Buffered                
}; AAX_ENUM_SIZE_CHECK( AAX_EDataInPortType );

enum AAX_EFrameRate
{
    AAX_eFrameRate_Undeclared = 0,
    AAX_eFrameRate_24Frame,
    AAX_eFrameRate_25Frame,
    AAX_eFrameRate_2997NonDrop,
    AAX_eFrameRate_2997DropFrame,
    AAX_eFrameRate_30NonDrop,
    AAX_eFrameRate_30DropFrame,
    AAX_eFrameRate_23976
}; AAX_ENUM_SIZE_CHECK( AAX_EFrameRate );

enum AAX_EFeetFramesRate
{
    AAX_eFeetFramesRate_23976 = 0,
    AAX_eFeetFramesRate_24,
    AAX_eFeetFramesRate_25
}; AAX_ENUM_SIZE_CHECK( AAX_EFeetFramesRate );


enum AAX_EMidiGlobalNodeSelectors
{
    AAX_eMIDIClick        = 1 << 0, 
    AAX_eMIDIMtc          = 1 << 1, 
    AAX_eMIDIBeatClock    = 1 << 2  

}; AAX_ENUM_SIZE_CHECK( AAX_EMidiGlobalNodeSelectors );

enum AAX_EPreviewState
{
    AAX_ePreviewState_Stop = 0,
    AAX_ePreviewState_Start = 1
}; AAX_ENUM_SIZE_CHECK( AAX_EPreviewState );

enum AAX_EProcessingState
{
    AAX_eProcessingState_Stop = 2,
    AAX_eProcessingState_Start = 3
}; AAX_ENUM_SIZE_CHECK( AAX_EProcessingState );

#endif // include guard