AAX_Properties.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013-2017, 2019-2021, 2023-2024 Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  This file is part of the Avid AAX SDK.
 *  
 *  The AAX SDK is subject to commercial or open-source licensing.
 *  
 *  By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
 *  Agreement and Avid Privacy Policy.
 *  
 *  AAX SDK License: https://developer.avid.com/aax
 *  Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
 *  
 *  Or: You may also use this code under the terms of the GPL v3 (see
 *  www.gnu.org/licenses).
 *  
 *  THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
 *  EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
 *  DISCLAIMED.
 *
 */
 
/*================================================================================================*/
 
 
#pragma once
#ifndef AAX_PROPERTIES_H
#define AAX_PROPERTIES_H
 
#ifndef _AAX_H_
#include "AAX.h"
#endif
 
 
// Add new values only at the end of existing sections!
 
// Current CCS doesn't support C++11
#ifdef _TMS320C6X
enum AAX_EProperty
#else
enum AAX_EProperty : int32_t
#endif
{
    AAX_eProperty_NoID = 0,
    AAX_eProperty_MinProp = 10, // MUST BE EQUAL TO MINIMUM PROPERTY VALUE
    
//--------------------------------------------------------------------- 
#if 0
#pragma mark Plug-In spec properties
#endif
    AAX_eProperty_PlugInSpecPropsBase = 10,
    AAX_eProperty_ManufacturerID = 11,
    AAX_eProperty_ProductID = 12,
    AAX_eProperty_PlugInID_Native = 13,
    AAX_eProperty_PlugInID_RTAS = AAX_eProperty_PlugInID_Native,
    AAX_eProperty_PlugInID_AudioSuite = 14,
    AAX_eProperty_PlugInID_TI = 15,
    AAX_eProperty_PlugInID_NoProcessing = 16,
    AAX_eProperty_PlugInID_Deprecated = 18,
    AAX_eProperty_Deprecated_Plugin_List = 21,
    AAX_eProperty_Related_DSP_Plugin_List = 22,
    AAX_eProperty_Related_Native_Plugin_List = 23,
    AAX_eProperty_Deprecated_DSP_Plugin_List = 24,
    AAX_eProperty_Deprecated_Native_Plugin_List = AAX_eProperty_Deprecated_Plugin_List,
    AAX_eProperty_PlugInID_ExternalProcessor = 25,
    AAX_eProperty_ExternalProcessorTypeID = 26,
    
//--------------------------------------------------------------------- 
#if 0
#pragma mark ProcessProc properties
#endif
    AAX_eProperty_ProcessProcPropsBase = 35,
    AAX_eProperty_NativeProcessProc = 36,
    AAX_eProperty_NativeInstanceInitProc = 37,
    AAX_eProperty_NativeBackgroundProc = 38,
    AAX_eProperty_TIDLLFileName = 39,
    AAX_eProperty_TIProcessProc = 40,
    AAX_eProperty_TIInstanceInitProc = 41,
    AAX_eProperty_TIBackgroundProc = 42,
    
//--------------------------------------------------------------------- 
#if 0
#pragma mark General properties
#endif
    AAX_eProperty_GeneralPropsBase = 50,
    AAX_eProperty_InputStemFormat = 51,
    AAX_eProperty_OutputStemFormat = 52,
    AAX_eProperty_DSP_AudioBufferLength = 54,
    AAX_eProperty_AudioBufferLength = AAX_eProperty_DSP_AudioBufferLength,
    AAX_eProperty_LatencyContribution = 56,
    AAX_eProperty_SampleRate = 58,
    AAX_eProperty_CanBypass = 60,
    AAX_eProperty_SideChainStemFormat = 61,
    
//--------------------------------------------------------------------- 
#if 0
#pragma mark TI-specific properties
#endif
    AAX_eProperty_TI_SharedCycleCount = 62,
    AAX_eProperty_TI_InstanceCycleCount = 63,
    AAX_eProperty_TI_MaxInstancesPerChip = 64,
    AAX_eProperty_TI_ForceAllowChipSharing = 65,
    
//--------------------------------------------------------------------- 
#if 0
#pragma mark General properties (continued)
#endif
    AAX_eProperty_AlwaysBypass = 75,
    AAX_eProperty_ShowInMenus = 76,
 
//--------------------------------------------------------------------- 
#if 0
#pragma mark AAX Hybrid properties
#endif
    AAX_eProperty_HybridOutputStemFormat = 90,
    AAX_eProperty_HybridInputStemFormat = 91,
    
//--------------------------------------------------------------------- 
#if 0
#pragma mark Offline (AudioSuite) properties
#endif
    AAX_eProperty_AudiosuitePropsBase = 100,
    AAX_eProperty_UsesRandomAccess = 101,
    AAX_eProperty_RequiresAnalysis = 102,
    AAX_eProperty_OptionalAnalysis = 103,
    AAX_eProperty_AllowPreviewWithoutAnalysis = 104,
    AAX_eProperty_DestinationTrack = 105,
    AAX_eProperty_RequestsAllTrackData = 106,
    AAX_eProperty_ContinuousOnly = 107,
    AAX_eProperty_MultiInputModeOnly = 108,
    AAX_eProperty_DisablePreview = 110,
    AAX_eProperty_DoesntIncrOutputSample = 112,
    AAX_eProperty_NumberOfInputs = 113,
    AAX_eProperty_NumberOfOutputs = 114,
    AAX_eProperty_DisableHandles = 115,
    AAX_eProperty_SupportsSideChainInput = 116,
    AAX_eProperty_NeedsOutputDithered = 117,
    AAX_eProperty_DisableAudioSuiteReverse = 118,
 
    AAX_eProperty_MaxASProp, // Intentionally given no explicit value
    
//--------------------------------------------------------------------- 
#if 0
#pragma mark GUI properties
#endif
    AAX_eProperty_GUIBase = 150,
    AAX_eProperty_UsesClientGUI = 151,
    
    AAX_eProperty_MaxGUIProp, // Intentionally given no explicit value
    
//--------------------------------------------------------------------- 
#if 0
#pragma mark Meter properties
#endif
    AAX_eProperty_MeterBase = 199,
    AAX_eProperty_Meter_Type = 200,
    AAX_eProperty_Meter_Orientation = 201,
    AAX_eProperty_Meter_Ballistics = 202,
    
    AAX_eProperty_MaxMeterProp, // Intentionally given no explicit value
    
//--------------------------------------------------------------------- 
#if 0
#pragma mark Plug-in management constraints
#endif
    AAX_eProperty_ConstraintBase = 299,
    AAX_eProperty_Constraint_Location = 300,
    AAX_eProperty_Constraint_Topology = 301,
    AAX_eProperty_Constraint_NeverUnload = 302,
    AAX_eProperty_Constraint_NeverCache = 303,
    AAX_eProperty_Constraint_MultiMonoSupport = 304,
    
    AAX_eProperty_MaxConstraintProp, // Intentionally given no explicit value
    
//--------------------------------------------------------------------- 
#if 0
#pragma mark Plug-in features
#endif
    AAX_eProperty_FeaturesBase = 305, // No room was given, so this equals AAX_eProperty_SupportsSaveRestore
    AAX_eProperty_SupportsSaveRestore = 305,
    AAX_eProperty_UsesTransport = 306,
    AAX_eProperty_StoreXMLPageTablesByEffect = 307,
    AAX_eProperty_StoreXMLPageTablesByType = AAX_eProperty_StoreXMLPageTablesByEffect,
    AAX_eProperty_RequiresChunkCallsOnMainThread = 308,
    AAX_eProperty_ObservesTransportState = 309,
    AAX_eProperty_UsesTransportControl = 311,
 
    AAX_eProperty_MaxFeaturesProp, // Intentionally given no explicit value
 
//--------------------------------------------------------------------- 
#if 0
#pragma mark Plug-in management constraints (continued)
#endif
    AAX_eProperty_ConstraintBase_2 = 350,
    
    AAX_eProperty_Constraint_AlwaysProcess = 351,
    
    AAX_eProperty_Constraint_DoNotApplyDefaultSettings = 352,
    
    AAX_eProperty_MaxConstraintProp_2, // Intentionally given no explicit value
    
//--------------------------------------------------------------------- 
#if 0
#pragma mark Debug properties
#endif
    AAX_eProperty_DebugPropertiesBase = 400,
    AAX_eProperty_EnableHostDebugLogs = 401,
    
    AAX_eProperty_MaxProp,          // ALWAYS LEAVE AS LAST PROPERTY VALUE
    AAX_eProperty_MaxCap = 10000    // Maximum possible property value over the lifetime of AAX
}; AAX_ENUM_SIZE_CHECK(AAX_EProperty);
 
#endif  // AAX_PROPERTIES_H