AAX SDK  2.4.1
Avid Audio Extensions Development Kit
AAX_IACFController.h
Go to the documentation of this file.
1 /*================================================================================================*/
2 /*
3  *
4  * Copyright 2013-2017 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 
23 /*================================================================================================*/
24 
25 
26 #ifndef _AAX_IACFCONTROLLER_H_
27 #define _AAX_IACFCONTROLLER_H_
28 
29 #include "AAX.h"
30 
31 #ifdef __clang__
32 #pragma clang diagnostic push
33 #pragma clang diagnostic ignored "-Wnon-virtual-dtor"
34 #endif
35 
36 #include "acfunknown.h"
37 
38 // Forward declarations
39 class AAX_IPageTable;
40 class AAX_IString;
41 
46 {
47 public:
48 
49  // Host information getters
51  virtual
54  AAX_IString * outEffectID) const = 0;
55 
57  virtual
60  AAX_CSampleRate *outSampleRate ) const = 0;
61 
63  virtual
66  AAX_EStemFormat *outStemFormat ) const = 0;
67 
69  virtual
72  AAX_EStemFormat *outStemFormat) const = 0;
73 
75  virtual
76  AAX_Result
78  int32_t* outSamples) const = 0;
79 
81  virtual
84  AAX_EProperty inWhichCycleCount,
85  AAX_CPropertyValue* outNumCycles) const = 0;
86 
88  virtual
89  AAX_Result
91  AAX_CTimeOfDay* outTODLocation ) const = 0;
92 
93  //Host Information Setters (Dynamic info)
95  virtual
96  AAX_Result
98  int32_t inNumSamples) = 0;
99 
101  virtual
102  AAX_Result
104  AAX_EProperty* inWhichCycleCounts,
105  AAX_CPropertyValue* iValues,
106  int32_t numValues) = 0;
107 
108  // Posting functions
110  virtual
111  AAX_Result
113  AAX_CFieldIndex inFieldIndex,
114  const void * inPayloadP,
115  uint32_t inPayloadSize) = 0;
116 
117  //Metering functions
119  virtual
120  AAX_Result
122  AAX_CTypeID inMeterID,
123  float * outMeterValue ) const = 0;
124 
126  virtual
127  AAX_Result
129  AAX_CTypeID inMeterID,
130  float * outMeterPeakValue ) const = 0;
131 
133  virtual
134  AAX_Result
136  AAX_CTypeID inMeterID ) const = 0;
137 
139  virtual
140  AAX_Result
142  AAX_CTypeID inMeterID,
143  AAX_CBoolean * outClipped ) const = 0;
144 
146  virtual
147  AAX_Result
149  AAX_CTypeID inMeterID ) const = 0;
150 
152  virtual
153  AAX_Result
155  uint32_t * outMeterCount ) const = 0;
156 
157  // MIDI methods
159  virtual
160  AAX_Result
162  AAX_CFieldIndex* outPort,
163  AAX_CMidiPacket* outPacket ) = 0;
164 
165  };
166 
170 {
171 public:
172  // Notification method
174  virtual
175  AAX_Result
177  AAX_CTypeID inNotificationType,
178  const void* inNotificationData,
179  uint32_t inNotificationDataSize) = 0;
180 
182  virtual
183  AAX_Result
185  int32_t* outSamples) const = 0;
186 
188  virtual
189  AAX_Result
191  AAX_CTransportCounter* outTimestamp) const = 0;
192 
194  virtual
195  AAX_Result
197  AAX_IString* outHostNameString) const = 0;
198 };
199 
203 {
204 public:
206  virtual
207  AAX_Result
209  AAX_CTargetPlatform* outTargetPlatform) const = 0;
210 
212  virtual
213  AAX_Result
214  GetIsAudioSuite(AAX_CBoolean* outIsAudioSuite) const = 0;
215 };
216 
217 #ifdef __clang__
218 #pragma clang diagnostic pop
219 #endif
220 
221 #endif // #ifndef _AAX_IACFCONTROLLER_H_
Various utility definitions for AAX.
float AAX_CSampleRate
Literal sample rate value used by the sample rate field. For AAX_eProperty_SampleRate,...
Definition: AAX.h:334
int64_t AAX_CTimeOfDay
Hardware running clock value. MIDI packet time stamps are measured against this clock....
Definition: AAX.h:332
int32_t AAX_Result
Definition: AAX.h:337
int32_t AAX_CTargetPlatform
Matches type of target platform.
Definition: AAX.h:347
uint8_t AAX_CBoolean
Cross-compiler boolean type used by AAX interfaces.
Definition: AAX.h:329
int32_t AAX_CPropertyValue
32-bit property values
Definition: AAX.h:338
int64_t AAX_CTransportCounter
Offset of samples from transport start. Same as TimeOfDay, but added for new interfaces as TimeOfDay ...
Definition: AAX.h:333
uint32_t AAX_CTypeID
Matches type of OSType used in classic plugins.
Definition: AAX.h:336
AAX_CIndex AAX_CFieldIndex
Not used by AAX plug-ins (except in AAX_FIELD_INDEX macro)
Definition: AAX.h:349
AAX_EStemFormat
Stem format definitions.
Definition: AAX_Enums.h:232
AAX_EProperty
The list of properties that can be added to an AAX_IPropertyMap.
Definition: AAX_Properties.h:72
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:248
Packet structure for MIDI data.
Definition: AAX.h:637
Interface for the AAX host's view of a single instance of an effect. Used by both clients of the AAXH...
Definition: AAX_IACFController.h:46
virtual AAX_Result GetCurrentMeterValue(AAX_CTypeID inMeterID, float *outMeterValue) const =0
CALL: Retrieves the current value of a host-managed plug-in meter.
virtual AAX_Result GetCycleCount(AAX_EProperty inWhichCycleCount, AAX_CPropertyValue *outNumCycles) const =0
CALL: returns the plug-in's current real-time DSP cycle count.
virtual AAX_Result GetSampleRate(AAX_CSampleRate *outSampleRate) const =0
CALL: Returns the current literal sample rate.
virtual AAX_Result SetCycleCount(AAX_EProperty *inWhichCycleCounts, AAX_CPropertyValue *iValues, int32_t numValues)=0
CALL: Indicates a change in the plug-in's real-time DSP cycle count.
virtual AAX_Result PostPacket(AAX_CFieldIndex inFieldIndex, const void *inPayloadP, uint32_t inPayloadSize)=0
CALL: Posts a data packet to the host for routing between plug-in components.
virtual AAX_Result GetMeterClipped(AAX_CTypeID inMeterID, AAX_CBoolean *outClipped) const =0
CALL: Retrieves the clipped flag from a host-managed plug-in meter.
virtual AAX_Result GetNextMIDIPacket(AAX_CFieldIndex *outPort, AAX_CMidiPacket *outPacket)=0
CALL: Retrieves MIDI packets for described MIDI nodes.
virtual AAX_Result GetOutputStemFormat(AAX_EStemFormat *outStemFormat) const =0
CALL: Returns the plug-in's output stem format.
virtual AAX_Result ClearMeterClipped(AAX_CTypeID inMeterID) const =0
CALL: Clears the clipped flag from a host-managed plug-in meter.
virtual AAX_Result GetMeterCount(uint32_t *outMeterCount) const =0
CALL: Retrieves the number of host-managed meters registered by a plug-in.
virtual AAX_Result GetEffectID(AAX_IString *outEffectID) const =0
virtual AAX_Result ClearMeterPeakValue(AAX_CTypeID inMeterID) const =0
CALL: Clears the peak value from a host-managed plug-in meter.
virtual AAX_Result GetInputStemFormat(AAX_EStemFormat *outStemFormat) const =0
CALL: Returns the plug-in's input stem format.
virtual AAX_Result GetSignalLatency(int32_t *outSamples) const =0
CALL: Returns the most recent signal (algorithmic) latency that has been published by the plug-in.
virtual AAX_Result GetMeterPeakValue(AAX_CTypeID inMeterID, float *outMeterPeakValue) const =0
CALL: Retrieves the currently held peak value of a host-managed plug-in meter.
virtual AAX_Result SetSignalLatency(int32_t inNumSamples)=0
CALL: Submits a request to change the delay compensation value that the host uses to account for the ...
virtual AAX_Result GetTODLocation(AAX_CTimeOfDay *outTODLocation) const =0
CALL: Returns the current Time Of Day (TOD) of the system.
Interface for the AAX host's view of a single instance of an effect. Used by both clients of the AAXH...
Definition: AAX_IACFController.h:170
virtual AAX_Result GetCurrentAutomationTimestamp(AAX_CTransportCounter *outTimestamp) const =0
CALL: Returns the current automation timestamp if called during the GenerateCoefficients() call AND t...
virtual AAX_Result SendNotification(AAX_CTypeID inNotificationType, const void *inNotificationData, uint32_t inNotificationDataSize)=0
CALL: Dispatch a notification.
virtual AAX_Result GetHostName(AAX_IString *outHostNameString) const =0
CALL: Returns name of the host application this plug-in instance is being loaded by....
virtual AAX_Result GetHybridSignalLatency(int32_t *outSamples) const =0
CALL: Returns the latency between the algorithm normal input samples and the inputs returning from th...
Interface for the AAX host's view of a single instance of an effect. Used by both clients of the AAXH...
Definition: AAX_IACFController.h:203
virtual AAX_Result GetIsAudioSuite(AAX_CBoolean *outIsAudioSuite) const =0
CALL: Returns true for AudioSuite instances.
virtual AAX_Result GetPlugInTargetPlatform(AAX_CTargetPlatform *outTargetPlatform) const =0
CALL: Returns execution platform type, native or TI.
Interface to the host's representation of a plug-in instance's page table.
Definition: AAX_IPageTable.h:28
A simple string container that can be passed across a binary boundary. This class,...
Definition: AAX_IString.h:41