AAX SDK  2.4.1
Avid Audio Extensions Development Kit
AAX_IACFComponentDescriptor.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 
22 /*================================================================================================*/
23 
24 
25 #ifndef _AAX_IACFCOMPONENTDESCRIPTOR_H_
26 #define _AAX_IACFCOMPONENTDESCRIPTOR_H_
27 
28 #include "AAX.h"
29 #include "AAX_Callbacks.h"
30 #include "AAX_IDma.h"
31 
32 #ifdef __clang__
33 #pragma clang diagnostic push
34 #pragma clang diagnostic ignored "-Wnon-virtual-dtor"
35 #endif
36 
37 #include "acfunknown.h"
38 
39 
43 {
44 public:
45  virtual AAX_Result Clear () = 0;
46  virtual AAX_Result AddReservedField ( AAX_CFieldIndex inFieldIndex, uint32_t inFieldType ) = 0;
47  virtual AAX_Result AddAudioIn ( AAX_CFieldIndex inFieldIndex ) = 0;
48  virtual AAX_Result AddAudioOut ( AAX_CFieldIndex inFieldIndex ) = 0;
49  virtual AAX_Result AddAudioBufferLength ( AAX_CFieldIndex inFieldIndex ) = 0;
50  virtual AAX_Result AddSampleRate ( AAX_CFieldIndex inFieldIndex ) = 0;
51  virtual AAX_Result AddClock ( AAX_CFieldIndex inFieldIndex ) = 0;
52  virtual AAX_Result AddSideChainIn ( AAX_CFieldIndex inFieldIndex ) = 0;
53  virtual AAX_Result AddDataInPort ( AAX_CFieldIndex inFieldIndex, uint32_t inPacketSize, AAX_EDataInPortType inPortType) = 0;
54  virtual AAX_Result AddAuxOutputStem ( AAX_CFieldIndex inFieldIndex, int32_t inStemFormat, const char inNameUTF8[]) = 0;
55  virtual AAX_Result AddPrivateData ( AAX_CFieldIndex inFieldIndex, int32_t inDataSize, uint32_t inOptions = AAX_ePrivateDataOptions_DefaultOptions ) = 0;
56  virtual AAX_Result AddDmaInstance ( AAX_CFieldIndex inFieldIndex, AAX_IDma::EMode inDmaMode ) = 0;
57  virtual AAX_Result AddMIDINode ( AAX_CFieldIndex inFieldIndex, AAX_EMIDINodeType inNodeType, const char inNodeName[], uint32_t channelMask ) = 0;
58 
60  AAX_CProcessProc inProcessProc,
61  IACFUnknown * inProperties,
62  AAX_CInstanceInitProc inInstanceInitProc,
63  AAX_CBackgroundProc inBackgroundProc,
64  AAX_CSelector * outProcID) = 0;
66  const char inDLLFileNameUTF8 [],
67  const char inProcessProcSymbol [],
68  IACFUnknown * inProperties,
69  const char inInstanceInitProcSymbol [],
70  const char inBackgroundProcSymbol [],
71  AAX_CSelector * outProcID) = 0;
72 
73  virtual AAX_Result AddMeters ( AAX_CFieldIndex inFieldIndex, const AAX_CTypeID* inMeterIDs, const uint32_t inMeterCount ) = 0;
74 };
75 
79 {
80 public:
81  virtual AAX_Result AddTemporaryData( AAX_CFieldIndex inFieldIndex, uint32_t inDataElementSize) = 0;
82 };
83 
87 {
88 public:
90  IACFUnknown * inProperties,
91  AAX_CSelector* outProcIDs,
92  int32_t inProcIDsSize) = 0;
93 };
94 
95 #ifdef __clang__
96 #pragma clang diagnostic pop
97 #endif
98 
99 #endif // #ifndef _AAX_IACFCOMPONENTDESCRIPTOR_H_
Various utility definitions for AAX.
int32_t AAX_Result
Definition: AAX.h:337
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
uint32_t AAX_CSelector
Definition: AAX.h:330
AAX callback prototypes and ProcPtr definitions
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:138
AAX_Component< void >::CBackgroundProc AAX_CBackgroundProc
A user-defined callback that AAX calls in the AAX Idle time.
Definition: AAX_Callbacks.h:149
AAX_Component< void >::CProcessProc AAX_CProcessProc
A user-defined callback that AAX calls to process data packets and/or audio.
Definition: AAX_Callbacks.h:102
AAX_EMIDINodeType
MIDI node types.
Definition: AAX_Enums.h:961
@ AAX_ePrivateDataOptions_DefaultOptions
Definition: AAX_Enums.h:737
AAX_EDataInPortType
Property value for whether a data in port should be buffered or not.
Definition: AAX_Enums.h:1042
Cross-platform interface for access to the host's direct memory access (DMA) facilities.
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:248
Versioned description interface for an AAX plug-in algorithm callback.
Definition: AAX_IACFComponentDescriptor.h:43
virtual AAX_Result AddAudioBufferLength(AAX_CFieldIndex inFieldIndex)=0
Subscribes a buffer length context field.
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.
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.
virtual AAX_Result AddAudioOut(AAX_CFieldIndex inFieldIndex)=0
Subscribes an audio output context field.
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.
virtual AAX_Result AddAudioIn(AAX_CFieldIndex inFieldIndex)=0
Subscribes an audio input context field.
virtual AAX_Result AddAuxOutputStem(AAX_CFieldIndex inFieldIndex, int32_t inStemFormat, const char inNameUTF8[])=0
Adds an auxiliary output stem for a plug-in.
virtual AAX_Result AddSampleRate(AAX_CFieldIndex inFieldIndex)=0
Subscribes a sample rate context field.
virtual AAX_Result AddReservedField(AAX_CFieldIndex inFieldIndex, uint32_t inFieldType)=0
Subscribes a context field to host-provided services or information.
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.
virtual AAX_Result Clear()=0
Clears the descriptor.
virtual AAX_Result AddSideChainIn(AAX_CFieldIndex inFieldIndex)=0
Subscribes a side-chain input context field.
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.
virtual AAX_Result AddDmaInstance(AAX_CFieldIndex inFieldIndex, AAX_IDma::EMode inDmaMode)=0
Adds a DMA field to the plug-in's context.
virtual AAX_Result AddDataInPort(AAX_CFieldIndex inFieldIndex, uint32_t inPacketSize, AAX_EDataInPortType inPortType)=0
Adds a custom data port to the algorithm context.
virtual AAX_Result AddClock(AAX_CFieldIndex inFieldIndex)=0
Subscribes a clock context field.
Versioned description interface for an AAX plug-in algorithm callback.
Definition: AAX_IACFComponentDescriptor.h:79
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...
Versioned description interface for an AAX plug-in algorithm callback.
Definition: AAX_IACFComponentDescriptor.h:87
virtual AAX_Result AddProcessProc(IACFUnknown *inProperties, AAX_CSelector *outProcIDs, int32_t inProcIDsSize)=0
Registers one or more algorithm processing entrypoints (process procedures)
EMode
DMA mode IDs.
Definition: AAX_IDma.h:71