| AAX SDK 2.8.0 Avid Audio Extensions Development Kit

- Welcome
- Manual
- Classes
- Files
- Lists
- Support

- File List
- File Members

Loading...
Searching...
No Matches
AAX_IController.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2013-2017, 2023-2024 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * This file is part of the Avid AAX SDK.
8 *
9 * The AAX SDK is subject to commercial or open-source licensing.
10 *
11 * By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
12 * Agreement and Avid Privacy Policy.
13 *
14 * AAX SDK License: https://developer.avid.com/aax
15 * Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
16 *
17 * Or: You may also use this code under the terms of the GPL v3 (see
18 * www.gnu.org/licenses).
19 *
20 * THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
21 * EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
22 * DISCLAIMED.
23 *
24 */
25
32/*================================================================================================*/
33
34
35#ifndef _AAX_ICONTROLLER_H_
36#define _AAX_ICONTROLLER_H_
37
38#include "AAX_Properties.h"
39#include "AAX_IString.h"
40#include "AAX.h"
41#include <memory>
42
43// Forward declarations
44 class AAX_IPageTable;
45
46
54 class AAX_IController
55{
56 public:
57
58 virtual ~AAX_IController(void) {}
59
65 virtual AAX_Result GetEffectID (
66 AAX_IString * outEffectID) const = 0;
73 virtual // AAX_VController
74 AAX_Result
75 GetSampleRate (
76 AAX_CSampleRate *outSampleRate ) const = 0;
83 virtual // AAX_VController
84 AAX_Result
85 GetInputStemFormat (
86 AAX_EStemFormat *outStemFormat ) const = 0;
93 virtual // AAX_VController
94 AAX_Result
95 GetOutputStemFormat (
96 AAX_EStemFormat *outStemFormat) const = 0;
113 virtual
114 AAX_Result
115 GetSignalLatency(
116 int32_t* outSamples) const = 0;
140 virtual
141 AAX_Result
142 GetCycleCount(
143 AAX_EProperty inWhichCycleCount,
144 AAX_CPropertyValue* outNumCycles) const = 0;
158 virtual
159 AAX_Result
160 GetTODLocation (
161 AAX_CTimeOfDay* outTODLocation ) const = 0;
163
193 virtual
194 AAX_Result
195 SetSignalLatency(
196 int32_t inNumSamples) = 0;
223 virtual
224 AAX_Result
225 SetCycleCount(
226 AAX_EProperty* inWhichCycleCounts,
227 AAX_CPropertyValue* iValues,
228 int32_t numValues) = 0;
230
261 virtual // AAX_VController
262 AAX_Result
263 PostPacket (
264 AAX_CFieldIndex inFieldIndex,
265 const void * inPayloadP,
266 uint32_t inPayloadSize) = 0;
268
296 virtual AAX_Result SendNotification (/* AAX_ENotificationEvent */ AAX_CTypeID inNotificationType, const void* inNotificationData, uint32_t inNotificationDataSize) = 0;
307 virtual AAX_Result SendNotification (/* AAX_ENotificationEvent */ AAX_CTypeID inNotificationType) = 0;
309
325 virtual AAX_Result GetCurrentMeterValue ( AAX_CTypeID inMeterID, float * outMeterValue ) const = 0;
334 virtual AAX_Result GetMeterPeakValue ( AAX_CTypeID inMeterID, float * outMeterPeakValue ) const = 0;
341 virtual AAX_Result ClearMeterPeakValue ( AAX_CTypeID inMeterID ) const = 0;
350 virtual AAX_Result GetMeterCount ( uint32_t * outMeterCount ) const = 0;
361 virtual AAX_Result GetMeterClipped ( AAX_CTypeID inMeterID, AAX_CBoolean * outClipped ) const = 0;
370 virtual AAX_Result ClearMeterClipped ( AAX_CTypeID inMeterID ) const = 0;
372
373
388 virtual AAX_Result GetNextMIDIPacket ( AAX_CFieldIndex* outPort, AAX_CMidiPacket* outPacket ) = 0;
390
405 virtual
406 AAX_Result GetHybridSignalLatency(int32_t* outSamples) const = 0;
421 virtual
422 AAX_Result GetCurrentAutomationTimestamp(AAX_CTransportCounter* outTimestamp) const = 0;
432 virtual
433 AAX_Result GetHostName(AAX_IString* outHostNameString) const = 0;
440 virtual
441 AAX_Result GetPlugInTargetPlatform(AAX_CTargetPlatform* outTargetPlatform) const = 0;
448 virtual
449 AAX_Result GetIsAudioSuite(AAX_CBoolean* outIsAudioSuite) const = 0;
450
477 virtual
478 AAX_IPageTable*
479 CreateTableCopyForEffect(
480 AAX_CPropertyValue inManufacturerID,
481 AAX_CPropertyValue inProductID,
482 AAX_CPropertyValue inPlugInID,
483 uint32_t inTableType,
484 int32_t inTablePageSize) const = 0;
485
509 virtual
510 AAX_IPageTable*
511 CreateTableCopyForLayout(
512 const char * inEffectID,
513 const char * inLayoutName,
514 uint32_t inTableType,
515 int32_t inTablePageSize) const = 0;
516
540 virtual
541 AAX_IPageTable*
542 CreateTableCopyForEffectFromFile(
543 const char* inPageTableFilePath,
544 AAX_ETextEncoding inFilePathEncoding,
545 AAX_CPropertyValue inManufacturerID,
546 AAX_CPropertyValue inProductID,
547 AAX_CPropertyValue inPlugInID,
548 uint32_t inTableType,
549 int32_t inTablePageSize) const = 0;
550
569 virtual
570 AAX_IPageTable*
571 CreateTableCopyForLayoutFromFile(
572 const char* inPageTableFilePath,
573 AAX_ETextEncoding inFilePathEncoding,
574 const char* inLayoutName,
575 uint32_t inTableType,
576 int32_t inTablePageSize) const = 0;
577};
578
579#endif // #ifndef _AAX_IPLUGIN_H_
AAX_ETextEncoding
AAX_ETextEncoding
Describes possible string encodings.
Definition: AAX_Enums.h:1377
AAX_EStemFormat
AAX_EStemFormat
Stem format definitions.
Definition: AAX_Enums.h:243
AAX.h
Various utility definitions for AAX.
AAX_CSampleRate
float AAX_CSampleRate
Literal sample rate value used by the sample rate field. For AAX_eProperty_SampleRate,...
Definition: AAX.h:344
AAX_CTimeOfDay
int64_t AAX_CTimeOfDay
Hardware running clock value. MIDI packet time stamps are measured against this clock....
Definition: AAX.h:342
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
AAX_CTargetPlatform
int32_t AAX_CTargetPlatform
Matches type of target platform.
Definition: AAX.h:357
AAX_CBoolean
uint8_t AAX_CBoolean
Cross-compiler boolean type used by AAX interfaces.
Definition: AAX.h:339
AAX_CPropertyValue
int32_t AAX_CPropertyValue
32-bit property values
Definition: AAX.h:348
AAX_CTransportCounter
int64_t AAX_CTransportCounter
Offset of samples from transport start. Same as TimeOfDay, but added for new interfaces as TimeOfDay ...
Definition: AAX.h:343
AAX_CTypeID
uint32_t AAX_CTypeID
Matches type of OSType used in classic plugins.
Definition: AAX.h:346
AAX_CFieldIndex
AAX_CIndex AAX_CFieldIndex
Not used by AAX plug-ins (except in AAX_FIELD_INDEX macro)
Definition: AAX.h:359
AAX_IString.h
An AAX string interface.
AAX_Properties.h
Contains IDs for properties that can be added to an AAX_IPropertyMap.
AAX_EProperty
AAX_EProperty
The list of properties that can be added to an AAX_IPropertyMap.
Definition: AAX_Properties.h:82
AAX_IController::GetHybridSignalLatency
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...
AAX_CMidiPacket
Packet structure for MIDI data.
Definition: AAX.h:649
AAX_IController
Interface for the AAX host's view of a single instance of an effect. Used by both clients of the AAX ...
Definition: AAX_IController.h:55
AAX_IController::SendNotification
virtual AAX_Result SendNotification(AAX_CTypeID inNotificationType, const void *inNotificationData, uint32_t inNotificationDataSize)=0
CALL: Dispatch a notification.
AAX_IController::GetCurrentMeterValue
virtual AAX_Result GetCurrentMeterValue(AAX_CTypeID inMeterID, float *outMeterValue) const =0
CALL: Retrieves the current value of a host-managed plug-in meter.
AAX_IController::SetCycleCount
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.
AAX_IController::GetMeterClipped
virtual AAX_Result GetMeterClipped(AAX_CTypeID inMeterID, AAX_CBoolean *outClipped) const =0
CALL: Retrieves the clipped flag from a host-managed plug-in meter.
AAX_IController::CreateTableCopyForLayout
virtual AAX_IPageTable * CreateTableCopyForLayout(const char *inEffectID, const char *inLayoutName, uint32_t inTableType, int32_t inTablePageSize) const =0
Copy the current page table data for a particular plug-in effect and page table layout.
AAX_IController::GetCycleCount
virtual AAX_Result GetCycleCount(AAX_EProperty inWhichCycleCount, AAX_CPropertyValue *outNumCycles) const =0
CALL: returns the plug-in's current real-time DSP cycle count.
AAX_IController::GetNextMIDIPacket
virtual AAX_Result GetNextMIDIPacket(AAX_CFieldIndex *outPort, AAX_CMidiPacket *outPacket)=0
CALL: Retrieves MIDI packets for described MIDI nodes.
AAX_IController::ClearMeterClipped
virtual AAX_Result ClearMeterClipped(AAX_CTypeID inMeterID) const =0
CALL: Clears the clipped flag from a host-managed plug-in meter.
AAX_IController::GetMeterCount
virtual AAX_Result GetMeterCount(uint32_t *outMeterCount) const =0
CALL: Retrieves the number of host-managed meters registered by a plug-in.
AAX_IController::CreateTableCopyForLayoutFromFile
virtual AAX_IPageTable * CreateTableCopyForLayoutFromFile(const char *inPageTableFilePath, AAX_ETextEncoding inFilePathEncoding, const char *inLayoutName, uint32_t inTableType, int32_t inTablePageSize) const =0
Copy the current page table data for a particular plug-in effect and page table layout.
AAX_IController::GetPlugInTargetPlatform
virtual AAX_Result GetPlugInTargetPlatform(AAX_CTargetPlatform *outTargetPlatform) const =0
CALL: Returns execution platform type, native or TI.
AAX_IController::CreateTableCopyForEffectFromFile
virtual AAX_IPageTable * CreateTableCopyForEffectFromFile(const char *inPageTableFilePath, AAX_ETextEncoding inFilePathEncoding, AAX_CPropertyValue inManufacturerID, AAX_CPropertyValue inProductID, AAX_CPropertyValue inPlugInID, uint32_t inTableType, int32_t inTablePageSize) const =0
Copy the current page table data for a particular plug-in type.
AAX_IController::GetMeterPeakValue
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.
AAX_IController::~AAX_IController
virtual ~AAX_IController(void)
Definition: AAX_IController.h:58
AAX_IController::ClearMeterPeakValue
virtual AAX_Result ClearMeterPeakValue(AAX_CTypeID inMeterID) const =0
CALL: Clears the peak value from a host-managed plug-in meter.
AAX_IController::GetOutputStemFormat
virtual AAX_Result GetOutputStemFormat(AAX_EStemFormat *outStemFormat) const =0
CALL: Returns the plug-in's output stem format.
AAX_IController::GetInputStemFormat
virtual AAX_Result GetInputStemFormat(AAX_EStemFormat *outStemFormat) const =0
CALL: Returns the plug-in's input stem format.
AAX_IController::GetEffectID
virtual AAX_Result GetEffectID(AAX_IString *outEffectID) const =0
AAX_IController::GetHostName
virtual AAX_Result GetHostName(AAX_IString *outHostNameString) const =0
CALL: Returns name of the host application this plug-in instance is being loaded by....
AAX_IController::GetSignalLatency
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.
AAX_IController::SendNotification
virtual AAX_Result SendNotification(AAX_CTypeID inNotificationType)=0
CALL: Sends an event to the GUI (no payload)
AAX_IController::CreateTableCopyForEffect
virtual AAX_IPageTable * CreateTableCopyForEffect(AAX_CPropertyValue inManufacturerID, AAX_CPropertyValue inProductID, AAX_CPropertyValue inPlugInID, uint32_t inTableType, int32_t inTablePageSize) const =0
Copy the current page table data for a particular plug-in type.
AAX_IController::PostPacket
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.
AAX_IController::SetSignalLatency
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 ...
AAX_IController::GetIsAudioSuite
virtual AAX_Result GetIsAudioSuite(AAX_CBoolean *outIsAudioSuite) const =0
CALL: Returns true for AudioSuite instances.
AAX_IController::GetCurrentAutomationTimestamp
virtual AAX_Result GetCurrentAutomationTimestamp(AAX_CTransportCounter *outTimestamp) const =0
CALL: Returns the current automation timestamp if called during the GenerateCoefficients() call AND t...
AAX_IController::GetSampleRate
virtual AAX_Result GetSampleRate(AAX_CSampleRate *outSampleRate) const =0
CALL: Returns the current literal sample rate.
AAX_IController::GetTODLocation
virtual AAX_Result GetTODLocation(AAX_CTimeOfDay *outTODLocation) const =0
CALL: Returns the current Time Of Day (TOD) of the system.
AAX_IPageTable
Interface to the host's representation of a plug-in instance's page table.
Definition: AAX_IPageTable.h:38
AAX_IString
A simple string container that can be passed across a binary boundary. This class,...
Definition: AAX_IString.h:51