AAX SDK  2.4.1
Avid Audio Extensions Development Kit
AAX_Properties.h
Go to the documentation of this file.
1 /*================================================================================================*/
2 /*
3  *
4  * Copyright 2013-2017, 2019-2021 by Avid Technology, Inc.
5  * All rights reserved.
6  *
7  * CONFIDENTIAL: This document contains confidential information. Do not
8  * read or examine this document unless you are an Avid Technology employee
9  * or have signed a non-disclosure agreement with Avid Technology which protects
10  * the confidentiality of this document. DO NOT DISCLOSE ANY INFORMATION
11  * CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT
12  * OF Avid Technology, INC.
13  *
14  */
15 
22 /*================================================================================================*/
23 
24 
26 #pragma once
27 #ifndef AAX_PROPERTIES_H
28 #define AAX_PROPERTIES_H
30 
31 #ifndef _AAX_H_
32 #include "AAX.h"
33 #endif
34 
35 
36 // Add new values only at the end of existing sections!
37 
66 // Current CCS doesn't support C++11
67 #ifdef _TMS320C6X
68 enum AAX_EProperty
69 #else
70 enum AAX_EProperty : int32_t
71 #endif
72 {
74  AAX_eProperty_MinProp = 10, // MUST BE EQUAL TO MINIMUM PROPERTY VALUE
75 
76 //---------------------------------------------------------------------
77 #if 0
78 #pragma mark Plug-In spec properties
79 #endif
256 
257 //---------------------------------------------------------------------
258 #if 0
259 #pragma mark ProcessProc properties
260 #endif
317 
318 //---------------------------------------------------------------------
319 #if 0
320 #pragma mark General properties
321 #endif
398 
399 //---------------------------------------------------------------------
400 #if 0
401 #pragma mark TI-specific properties
402 #endif
441 
442 //---------------------------------------------------------------------
443 #if 0
444 #pragma mark General properties (continued)
445 #endif
460 
461 //---------------------------------------------------------------------
462 #if 0
463 #pragma mark AAX Hybrid properties
464 #endif
492 
493 //---------------------------------------------------------------------
494 #if 0
495 #pragma mark Offline (AudioSuite) properties
496 #endif
640 
641  AAX_eProperty_MaxASProp, // Intentionally given no explicit value
643 
644 //---------------------------------------------------------------------
645 #if 0
646 #pragma mark GUI properties
647 #endif
667 
668  AAX_eProperty_MaxGUIProp, // Intentionally given no explicit value
670 
671 //---------------------------------------------------------------------
672 #if 0
673 #pragma mark Meter properties
674 #endif
699 
700  AAX_eProperty_MaxMeterProp, // Intentionally given no explicit value
702 
703 //---------------------------------------------------------------------
704 #if 0
705 #pragma mark Plug-in management constraints
706 #endif
759 
760  AAX_eProperty_MaxConstraintProp, // Intentionally given no explicit value
762 
763 //---------------------------------------------------------------------
764 #if 0
765 #pragma mark Plug-in features
766 #endif
773  AAX_eProperty_FeaturesBase = 305, // No room was given, so this equals AAX_eProperty_SupportsSaveRestore
827 
828  AAX_eProperty_MaxFeaturesProp, // Intentionally given no explicit value
830 
831 //---------------------------------------------------------------------
832 #if 0
833 #pragma mark Plug-in management constraints (continued)
834 #endif
841 
858 
877 
878  AAX_eProperty_MaxConstraintProp_2, // Intentionally given no explicit value
880 
881 //---------------------------------------------------------------------
882 #if 0
883 #pragma mark Debug properties
884 #endif
898 
899  AAX_eProperty_MaxProp, // ALWAYS LEAVE AS LAST PROPERTY VALUE
900  AAX_eProperty_MaxCap = 10000 // Maximum possible property value over the lifetime of AAX
902 
904 #endif // AAX_PROPERTIES_H
Various utility definitions for AAX.
AAX_EProperty
The list of properties that can be added to an AAX_IPropertyMap.
Definition: AAX_Properties.h:72
@ AAX_eProperty_NumberOfInputs
The number of input channels that the plug-in supports.
Definition: AAX_Properties.h:600
@ AAX_eProperty_PlugInID_RTAS
Definition: AAX_Properties.h:133
@ AAX_eProperty_RequiresChunkCallsOnMainThread
Indicates whether the plug-in supports SetChunk and GetChunk calls on threads other than the main thr...
Definition: AAX_Properties.h:816
@ AAX_eProperty_GUIBase
Definition: AAX_Properties.h:653
@ AAX_eProperty_DSP_AudioBufferLength
Audio buffer length for DSP processing callbacks. One of AAX_EAudioBufferLengthDSP.
Definition: AAX_Properties.h:348
@ AAX_eProperty_FeaturesBase
Definition: AAX_Properties.h:773
@ AAX_eProperty_NativeInstanceInitProc
Definition: AAX_Properties.h:280
@ AAX_eProperty_ConstraintBase
Definition: AAX_Properties.h:715
@ AAX_eProperty_StoreXMLPageTablesByEffect
This property specifies whether the plug-in bundle contains an XML file per plug-in type.
Definition: AAX_Properties.h:801
@ AAX_eProperty_TIProcessProc
Definition: AAX_Properties.h:301
@ AAX_eProperty_MaxCap
Definition: AAX_Properties.h:900
@ AAX_eProperty_OutputStemFormat
Output stem format. One of AAX_EStemFormat.
Definition: AAX_Properties.h:341
@ AAX_eProperty_Deprecated_Plugin_List
Definition: AAX_Properties.h:199
@ AAX_eProperty_PlugInID_ExternalProcessor
Four-character osid-style plug-in type identifier for audio effects rendered on external hardware.
Definition: AAX_Properties.h:244
@ AAX_eProperty_Meter_Orientation
Indicates meter orientation as one of AAX_EMeterOrientation.
Definition: AAX_Properties.h:693
@ AAX_eProperty_TI_ForceAllowChipSharing
Allow different plug-in types to share the same DSP even if AAX_eProperty_TI_MaxInstancesPerChip is d...
Definition: AAX_Properties.h:439
@ AAX_eProperty_SupportsSideChainInput
Tells the host that the plug-in supports side chain inputs.
Definition: AAX_Properties.h:621
@ AAX_eProperty_AudioBufferLength
Definition: AAX_Properties.h:351
@ AAX_eProperty_GeneralPropsBase
Definition: AAX_Properties.h:327
@ AAX_eProperty_NeedsOutputDithered
Requests that the host apply dithering to the Effect's output.
Definition: AAX_Properties.h:629
@ AAX_eProperty_ProductID
Four-character osid-style Effect identifier.
Definition: AAX_Properties.h:111
@ AAX_eProperty_TI_SharedCycleCount
Shared cycle count (outer, per clump, loop overhead)
Definition: AAX_Properties.h:412
@ AAX_eProperty_Deprecated_Native_Plugin_List
Specify a list of Native plug-ins that are deprecated by a new plug-in type.
Definition: AAX_Properties.h:227
@ AAX_eProperty_MaxConstraintProp_2
Definition: AAX_Properties.h:878
@ AAX_eProperty_NativeProcessProc
Definition: AAX_Properties.h:273
@ AAX_eProperty_Constraint_AlwaysProcess
Indicates that the plug-in's processing should never be disabled by the host (true/false)
Definition: AAX_Properties.h:857
@ AAX_eProperty_OptionalAnalysis
The Effect supports an analysis pass, but does not require it.
Definition: AAX_Properties.h:530
@ AAX_eProperty_TI_MaxInstancesPerChip
Maximum number of instances of this plug-in that can be loaded on a chip. This property is only used ...
Definition: AAX_Properties.h:425
@ AAX_eProperty_Constraint_Topology
Constraint on the topology of the Effect's modules, as one of AAX_EConstraintTopology.
Definition: AAX_Properties.h:726
@ AAX_eProperty_TI_InstanceCycleCount
Instance cycle count (inner, per instance, loop overhead)
Definition: AAX_Properties.h:418
@ AAX_eProperty_MaxMeterProp
Definition: AAX_Properties.h:700
@ AAX_eProperty_CanBypass
The plug-in supports a Master Bypass control.
Definition: AAX_Properties.h:387
@ AAX_eProperty_PlugInID_NoProcessing
Four-character osid-style plug-in type identifier for Effect types that do not process audio.
Definition: AAX_Properties.h:185
@ AAX_eProperty_SupportsSaveRestore
Indicates whether or not the plug-in supports Save/Restore features. (true/false)
Definition: AAX_Properties.h:782
@ AAX_eProperty_Meter_Type
Indicates meter type as one of AAX_EMeterType.
Definition: AAX_Properties.h:688
@ AAX_eProperty_Constraint_NeverUnload
Tells the host that it should never unload the plug-in binary.
Definition: AAX_Properties.h:733
@ AAX_eProperty_PlugInID_TI
Four-character osid-style plug-in type identifier for real-time TI-accelerated audio Effect types.
Definition: AAX_Properties.h:168
@ AAX_eProperty_MaxFeaturesProp
Definition: AAX_Properties.h:828
@ AAX_eProperty_Constraint_NeverCache
Tells the host that it should never cache the plug-in binary. Only use this if required as there is a...
Definition: AAX_Properties.h:747
@ AAX_eProperty_Constraint_Location
Constraint on the algorithm's location, as a mask of AAX_EConstraintLocationMask.
Definition: AAX_Properties.h:720
@ AAX_eProperty_Constraint_DoNotApplyDefaultSettings
Requests that the host does not send default settings chunks to the plug-in after instantiation (true...
Definition: AAX_Properties.h:876
@ AAX_eProperty_Constraint_MultiMonoSupport
Indicates whether or not the plug-in supports multi-mono configurations (true/false)
Definition: AAX_Properties.h:758
@ AAX_eProperty_DisablePreview
The Effect does not support preview.
Definition: AAX_Properties.h:582
@ AAX_eProperty_PlugInID_Native
Four-character osid-style plug-in type identifier for real-time native audio Effects.
Definition: AAX_Properties.h:130
@ AAX_eProperty_MaxConstraintProp
Definition: AAX_Properties.h:760
@ AAX_eProperty_RequiresAnalysis
The Effect requires an analysis pass.
Definition: AAX_Properties.h:519
@ AAX_eProperty_DisableHandles
Prevents the application of rendered region handles by the host.
Definition: AAX_Properties.h:615
@ AAX_eProperty_AlwaysBypass
The plug-in never alters its audio signal, audio output is always equal to audio input.
Definition: AAX_Properties.h:458
@ AAX_eProperty_ContinuousOnly
The Effect only processes on continuous data and does not support 'clip by clip' rendering.
Definition: AAX_Properties.h:566
@ AAX_eProperty_AllowPreviewWithoutAnalysis
The Effect requires analysis, but is also allowed to preview.
Definition: AAX_Properties.h:538
@ AAX_eProperty_ConstraintBase_2
Definition: AAX_Properties.h:840
@ AAX_eProperty_ManufacturerID
Four-character osid-style manufacturer identifier.
Definition: AAX_Properties.h:98
@ AAX_eProperty_ProcessProcPropsBase
Definition: AAX_Properties.h:266
@ AAX_eProperty_EnableHostDebugLogs
Enables host debug logging for this plug-in.
Definition: AAX_Properties.h:896
@ AAX_eProperty_Related_DSP_Plugin_List
Specify a list of DSP plug-ins that are related to a plug-in type.
Definition: AAX_Properties.h:208
@ AAX_eProperty_MultiInputModeOnly
The Effect wants multi-input mode only (no mono mode option)
Definition: AAX_Properties.h:574
@ AAX_eProperty_MeterBase
Definition: AAX_Properties.h:683
@ AAX_eProperty_TIDLLFileName
Definition: AAX_Properties.h:294
@ AAX_eProperty_RequestsAllTrackData
The host should make all of the processed track's data available to the Effect.
Definition: AAX_Properties.h:557
@ AAX_eProperty_Meter_Ballistics
Indicates meter ballistics preference as one of AAX_EMeterBallisticType.
Definition: AAX_Properties.h:698
@ AAX_eProperty_LatencyContribution
Default latency contribution of a given processing callback, in samples.
Definition: AAX_Properties.h:368
@ AAX_eProperty_DebugPropertiesBase
Definition: AAX_Properties.h:888
@ AAX_eProperty_DoesntIncrOutputSample
The Effect may not increment its output sample during some rendering calls.
Definition: AAX_Properties.h:591
@ AAX_eProperty_UsesRandomAccess
The Effect requires random access to audio data.
Definition: AAX_Properties.h:511
@ AAX_eProperty_Deprecated_DSP_Plugin_List
Specify a list of DSP plug-ins that are deprecated by a new plug-in type.
Definition: AAX_Properties.h:221
@ AAX_eProperty_DisableAudiosuiteReverse
The plug-in supports audiosuite reverse. By default, all reverb and delay plug-ins support this featu...
Definition: AAX_Properties.h:639
@ AAX_eProperty_NumberOfOutputs
The number of output channels that the plug-in supports.
Definition: AAX_Properties.h:609
@ AAX_eProperty_MaxASProp
Definition: AAX_Properties.h:641
@ AAX_eProperty_SampleRate
Specifies which sample rates the Effect supports. A mask of AAX_ESampleRateMask.
Definition: AAX_Properties.h:375
@ AAX_eProperty_MaxGUIProp
Definition: AAX_Properties.h:668
@ AAX_eProperty_TIInstanceInitProc
Definition: AAX_Properties.h:308
@ AAX_eProperty_PlugInID_AudioSuite
Four-character osid-style plug-in type identifier for offline native audio Effects.
Definition: AAX_Properties.h:148
@ AAX_eProperty_MinProp
Definition: AAX_Properties.h:74
@ AAX_eProperty_MaxProp
Definition: AAX_Properties.h:899
@ AAX_eProperty_PlugInID_Deprecated
Four-character osid-style plug-in type identifier for a corresponding deprecated type.
Definition: AAX_Properties.h:195
@ AAX_eProperty_PlugInSpecPropsBase
Definition: AAX_Properties.h:85
@ AAX_eProperty_DestinationTrack
Informs the host application to reassign output to a different track.
Definition: AAX_Properties.h:548
@ AAX_eProperty_InputStemFormat
Input stem format. One of AAX_EStemFormat.
Definition: AAX_Properties.h:334
@ AAX_eProperty_Related_Native_Plugin_List
Specify a list of Native plug-ins that are related to a plug-in type.
Definition: AAX_Properties.h:215
@ AAX_eProperty_ExternalProcessorTypeID
Identifier for the type of the external processor hardware.
Definition: AAX_Properties.h:254
@ AAX_eProperty_StoreXMLPageTablesByType
Definition: AAX_Properties.h:804
@ AAX_eProperty_SideChainStemFormat
Side chain stem format. One of AAX_EStemFormat.
Definition: AAX_Properties.h:396
@ AAX_eProperty_AudiosuitePropsBase
Definition: AAX_Properties.h:502
@ AAX_eProperty_NoID
Definition: AAX_Properties.h:73
@ AAX_eProperty_NativeBackgroundProc
Definition: AAX_Properties.h:287
@ AAX_eProperty_UsesTransport
Indicates whether or not the plug-in uses transport requests. (true/false)
Definition: AAX_Properties.h:789
@ AAX_eProperty_UsesClientGUI
Requests a host-generated GUI based on the Effect's parameters.
Definition: AAX_Properties.h:666
@ AAX_eProperty_TIBackgroundProc
Definition: AAX_Properties.h:315
@ AAX_eProperty_ObservesTransportState
Indicates whether the plug-in subscribes to the TransportStateChanged notification to receive transpo...
Definition: AAX_Properties.h:826
AAX_ENUM_SIZE_CHECK(AAX_EProperty)
@ AAX_eProperty_HybridInputStemFormat
Hybrid Input stem format. One of AAX_EStemFormat.
Definition: AAX_Properties.h:490
@ AAX_eProperty_HybridOutputStemFormat
Hybrid Output stem format. One of AAX_EStemFormat.
Definition: AAX_Properties.h:479