| 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_IACFComponentDescriptor.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_IACFCOMPONENTDESCRIPTOR_H_
36#define _AAX_IACFCOMPONENTDESCRIPTOR_H_
37
38#include "AAX.h"
39#include "AAX_Callbacks.h"
40#include "AAX_IDma.h"
41
42#ifdef __clang__
43#pragma clang diagnostic push
44#pragma clang diagnostic ignored "-Wnon-virtual-dtor"
45#endif
46
47#include "acfunknown.h"
48
49
52 class AAX_IACFComponentDescriptor : public IACFUnknown
53{
54 public:
55 virtual AAX_Result Clear () = 0;
56 virtual AAX_Result AddReservedField ( AAX_CFieldIndex inFieldIndex, uint32_t inFieldType ) = 0;
57 virtual AAX_Result AddAudioIn ( AAX_CFieldIndex inFieldIndex ) = 0;
58 virtual AAX_Result AddAudioOut ( AAX_CFieldIndex inFieldIndex ) = 0;
59 virtual AAX_Result AddAudioBufferLength ( AAX_CFieldIndex inFieldIndex ) = 0;
60 virtual AAX_Result AddSampleRate ( AAX_CFieldIndex inFieldIndex ) = 0;
61 virtual AAX_Result AddClock ( AAX_CFieldIndex inFieldIndex ) = 0;
62 virtual AAX_Result AddSideChainIn ( AAX_CFieldIndex inFieldIndex ) = 0;
63 virtual AAX_Result AddDataInPort ( AAX_CFieldIndex inFieldIndex, uint32_t inPacketSize, AAX_EDataInPortType inPortType) = 0;
64 virtual AAX_Result AddAuxOutputStem ( AAX_CFieldIndex inFieldIndex, int32_t inStemFormat, const char inNameUTF8[]) = 0;
65 virtual AAX_Result AddPrivateData ( AAX_CFieldIndex inFieldIndex, int32_t inDataSize, uint32_t inOptions = AAX_ePrivateDataOptions_DefaultOptions ) = 0;
66 virtual AAX_Result AddDmaInstance ( AAX_CFieldIndex inFieldIndex, AAX_IDma::EMode inDmaMode ) = 0;
67 virtual AAX_Result AddMIDINode ( AAX_CFieldIndex inFieldIndex, AAX_EMIDINodeType inNodeType, const char inNodeName[], uint32_t channelMask ) = 0;
68
69 virtual AAX_Result AddProcessProc_Native (
70 AAX_CProcessProc inProcessProc,
71 IACFUnknown * inProperties,
72 AAX_CInstanceInitProc inInstanceInitProc,
73 AAX_CBackgroundProc inBackgroundProc,
74 AAX_CSelector * outProcID) = 0;
75 virtual AAX_Result AddProcessProc_TI (
76 const char inDLLFileNameUTF8 [],
77 const char inProcessProcSymbol [],
78 IACFUnknown * inProperties,
79 const char inInstanceInitProcSymbol [],
80 const char inBackgroundProcSymbol [],
81 AAX_CSelector * outProcID) = 0;
82
83 virtual AAX_Result AddMeters ( AAX_CFieldIndex inFieldIndex, const AAX_CTypeID* inMeterIDs, const uint32_t inMeterCount ) = 0;
84};
85
88 class AAX_IACFComponentDescriptor_V2 : public AAX_IACFComponentDescriptor
89{
90 public:
91 virtual AAX_Result AddTemporaryData( AAX_CFieldIndex inFieldIndex, uint32_t inDataElementSize) = 0;
92};
93
96 class AAX_IACFComponentDescriptor_V3 : public AAX_IACFComponentDescriptor_V2
97{
98 public:
99 virtual AAX_Result AddProcessProc (
100 IACFUnknown * inProperties,
101 AAX_CSelector* outProcIDs,
102 int32_t inProcIDsSize) = 0;
103};
104
105#ifdef __clang__
106#pragma clang diagnostic pop
107#endif
108
109#endif // #ifndef _AAX_IACFCOMPONENTDESCRIPTOR_H_
AAX_EMIDINodeType
AAX_EMIDINodeType
MIDI node types.
Definition: AAX_Enums.h:1026
AAX_ePrivateDataOptions_DefaultOptions
@ AAX_ePrivateDataOptions_DefaultOptions
Definition: AAX_Enums.h:806
AAX_EDataInPortType
AAX_EDataInPortType
Property value for whether a data in port should be buffered or not.
Definition: AAX_Enums.h:1109
AAX.h
Various utility definitions for AAX.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
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_CSelector
uint32_t AAX_CSelector
Definition: AAX.h:340
AAX_IDma.h
Cross-platform interface for access to the host's direct memory access (DMA) facilities.
AAX_Callbacks.h
AAX callback prototypes and ProcPtr definitions
AAX_CInstanceInitProc
AAX_Component< void >::CInstanceInitProc AAX_CInstanceInitProc
A user-defined callback that AAX calls to notify the component that an instance is being added or rem...
Definition: AAX_Callbacks.h:150
AAX_CBackgroundProc
AAX_Component< void >::CBackgroundProc AAX_CBackgroundProc
A user-defined callback that AAX calls in the AAX Idle time.
Definition: AAX_Callbacks.h:161
AAX_CProcessProc
AAX_Component< void >::CProcessProc AAX_CProcessProc
A user-defined callback that AAX calls to process data packets and/or audio.
Definition: AAX_Callbacks.h:114
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:265
AAX_IACFComponentDescriptor
Versioned description interface for an AAX plug-in algorithm callback.
Definition: AAX_IACFComponentDescriptor.h:53
AAX_IACFComponentDescriptor::AddAudioBufferLength
virtual AAX_Result AddAudioBufferLength(AAX_CFieldIndex inFieldIndex)=0
Subscribes a buffer length context field.
AAX_IACFComponentDescriptor::AddProcessProc_Native
virtual AAX_Result AddProcessProc_Native(AAX_CProcessProc inProcessProc, IACFUnknown *inProperties, AAX_CInstanceInitProc inInstanceInitProc, AAX_CBackgroundProc inBackgroundProc, AAX_CSelector *outProcID)=0
Registers an algorithm processing entrypoint (process procedure) for the native architecture.
AAX_IACFComponentDescriptor::AddMeters
virtual AAX_Result AddMeters(AAX_CFieldIndex inFieldIndex, const AAX_CTypeID *inMeterIDs, const uint32_t inMeterCount)=0
Adds a meter field to the plug-in's context.
AAX_IACFComponentDescriptor::AddAudioOut
virtual AAX_Result AddAudioOut(AAX_CFieldIndex inFieldIndex)=0
Subscribes an audio output context field.
AAX_IACFComponentDescriptor::AddMIDINode
virtual AAX_Result AddMIDINode(AAX_CFieldIndex inFieldIndex, AAX_EMIDINodeType inNodeType, const char inNodeName[], uint32_t channelMask)=0
Adds a MIDI node field to the plug-in's context.
AAX_IACFComponentDescriptor::AddAudioIn
virtual AAX_Result AddAudioIn(AAX_CFieldIndex inFieldIndex)=0
Subscribes an audio input context field.
AAX_IACFComponentDescriptor::AddAuxOutputStem
virtual AAX_Result AddAuxOutputStem(AAX_CFieldIndex inFieldIndex, int32_t inStemFormat, const char inNameUTF8[])=0
Adds an auxiliary output stem for a plug-in.
AAX_IACFComponentDescriptor::AddSampleRate
virtual AAX_Result AddSampleRate(AAX_CFieldIndex inFieldIndex)=0
Subscribes a sample rate context field.
AAX_IACFComponentDescriptor::AddReservedField
virtual AAX_Result AddReservedField(AAX_CFieldIndex inFieldIndex, uint32_t inFieldType)=0
Subscribes a context field to host-provided services or information.
AAX_IACFComponentDescriptor::AddPrivateData
virtual AAX_Result AddPrivateData(AAX_CFieldIndex inFieldIndex, int32_t inDataSize, uint32_t inOptions=AAX_ePrivateDataOptions_DefaultOptions)=0
Adds a private data port to the algorithm context.
AAX_IACFComponentDescriptor::Clear
virtual AAX_Result Clear()=0
Clears the descriptor.
AAX_IACFComponentDescriptor::AddSideChainIn
virtual AAX_Result AddSideChainIn(AAX_CFieldIndex inFieldIndex)=0
Subscribes a side-chain input context field.
AAX_IACFComponentDescriptor::AddProcessProc_TI
virtual AAX_Result AddProcessProc_TI(const char inDLLFileNameUTF8[], const char inProcessProcSymbol[], IACFUnknown *inProperties, const char inInstanceInitProcSymbol[], const char inBackgroundProcSymbol[], AAX_CSelector *outProcID)=0
Registers an algorithm processing entrypoint (process procedure) for the native architecture.
AAX_IACFComponentDescriptor::AddDmaInstance
virtual AAX_Result AddDmaInstance(AAX_CFieldIndex inFieldIndex, AAX_IDma::EMode inDmaMode)=0
Adds a DMA field to the plug-in's context.
AAX_IACFComponentDescriptor::AddDataInPort
virtual AAX_Result AddDataInPort(AAX_CFieldIndex inFieldIndex, uint32_t inPacketSize, AAX_EDataInPortType inPortType)=0
Adds a custom data port to the algorithm context.
AAX_IACFComponentDescriptor::AddClock
virtual AAX_Result AddClock(AAX_CFieldIndex inFieldIndex)=0
Subscribes a clock context field.
AAX_IACFComponentDescriptor_V2
Versioned description interface for an AAX plug-in algorithm callback.
Definition: AAX_IACFComponentDescriptor.h:89
AAX_IACFComponentDescriptor_V2::AddTemporaryData
virtual AAX_Result AddTemporaryData(AAX_CFieldIndex inFieldIndex, uint32_t inDataElementSize)=0
Adds a block of data to a context that is not saved between callbacks and is scaled by the system buf...
AAX_IACFComponentDescriptor_V3
Versioned description interface for an AAX plug-in algorithm callback.
Definition: AAX_IACFComponentDescriptor.h:97
AAX_IACFComponentDescriptor_V3::AddProcessProc
virtual AAX_Result AddProcessProc(IACFUnknown *inProperties, AAX_CSelector *outProcIDs, int32_t inProcIDsSize)=0
Registers one or more algorithm processing entrypoints (process procedures)
AAX_IDma::EMode
EMode
DMA mode IDs.
Definition: AAX_IDma.h:81