| 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_IComponentDescriptor.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_ICOMPONENTDESCRIPTOR_H_
36#define _AAX_ICOMPONENTDESCRIPTOR_H_
37
38#include "AAX.h"
39#include "AAX_IDma.h"
40#include "AAX_Callbacks.h"
41
42 class AAX_IPropertyMap;
43
44
56 class AAX_IComponentDescriptor
57{
58 public:
59 virtual ~AAX_IComponentDescriptor() {}
60
67 virtual AAX_Result Clear () = 0;
68
81 virtual AAX_Result AddAudioIn ( AAX_CFieldIndex inFieldIndex ) = 0;
82
95 virtual AAX_Result AddAudioOut ( AAX_CFieldIndex inFieldIndex ) = 0;
96
109 virtual AAX_Result AddAudioBufferLength ( AAX_CFieldIndex inFieldIndex ) = 0;
110
123 virtual AAX_Result AddSampleRate ( AAX_CFieldIndex inFieldIndex ) = 0;
124
142 virtual AAX_Result AddClock ( AAX_CFieldIndex inFieldIndex ) = 0;
143
157 virtual AAX_Result AddSideChainIn ( AAX_CFieldIndex inFieldIndex ) = 0;
158
181 virtual AAX_Result AddDataInPort ( AAX_CFieldIndex inFieldIndex, uint32_t inPacketSize, AAX_EDataInPortType inPortType = AAX_eDataInPortType_Buffered ) = 0;
182
218 virtual AAX_Result AddAuxOutputStem ( AAX_CFieldIndex inFieldIndex, int32_t inStemFormat, const char inNameUTF8[]) = 0;
235 virtual AAX_Result AddPrivateData ( AAX_CFieldIndex inFieldIndex, int32_t inDataSize, /* AAX_EPrivateDataOptions */ uint32_t inOptions = AAX_ePrivateDataOptions_DefaultOptions ) = 0;
236
251 virtual AAX_Result AddTemporaryData( AAX_CFieldIndex inFieldIndex, uint32_t inDataElementSize) = 0;
252
273 virtual AAX_Result AddDmaInstance ( AAX_CFieldIndex inFieldIndex, AAX_IDma::EMode inDmaMode ) = 0;
274
290 virtual AAX_Result AddMeters ( AAX_CFieldIndex inFieldIndex, const AAX_CTypeID* inMeterIDs, const uint32_t inMeterCount ) = 0;
291
314 virtual AAX_Result AddMIDINode ( AAX_CFieldIndex inFieldIndex, AAX_EMIDINodeType inNodeType, const char inNodeName[], uint32_t channelMask ) = 0;
315
326 virtual AAX_Result AddReservedField ( AAX_CFieldIndex inFieldIndex, uint32_t inFieldType ) = 0;
327
335 virtual AAX_IPropertyMap * NewPropertyMap () const = 0; // CONST?
336
347 virtual AAX_IPropertyMap * DuplicatePropertyMap (AAX_IPropertyMap* inPropertyMap) const = 0;
367 virtual AAX_Result AddProcessProc_Native (
368 AAX_CProcessProc inProcessProc,
369 AAX_IPropertyMap * inProperties = NULL,
370 AAX_CInstanceInitProc inInstanceInitProc = NULL,
371 AAX_CBackgroundProc inBackgroundProc = NULL,
372 AAX_CSelector * outProcID = NULL) = 0;
396 virtual AAX_Result AddProcessProc_TI (
397 const char inDLLFileNameUTF8 [],
398 const char inProcessProcSymbol [],
399 AAX_IPropertyMap * inProperties,
400 const char inInstanceInitProcSymbol [] = NULL,
401 const char inBackgroundProcSymbol [] = NULL,
402 AAX_CSelector * outProcID = NULL) = 0;
403
449 virtual AAX_Result AddProcessProc (
450 AAX_IPropertyMap* inProperties,
451 AAX_CSelector* outProcIDs = NULL,
452 int32_t inProcIDsSize = 0) = 0;
453
467 template <typename aContextType>
468 AAX_Result AddProcessProc_Native (
469 void (AAX_CALLBACK *inProcessProc) ( aContextType * const inInstancesBegin [], const void * inInstancesEnd),
470 AAX_IPropertyMap * inProperties = NULL,
471 int32_t (AAX_CALLBACK *inInstanceInitProc) ( const aContextType * inInstanceContextPtr, AAX_EComponentInstanceInitAction inAction ) = NULL,
472 int32_t (AAX_CALLBACK *inBackgroundProc) ( void ) = NULL );
473};
474
475 template <typename aContextType>
476 inline AAX_Result
477 AAX_IComponentDescriptor::AddProcessProc_Native (
478 void (AAX_CALLBACK *inProcessProc) ( aContextType * const inInstancesBegin [], const void * inInstancesEnd),
479 AAX_IPropertyMap * inProperties,
480 int32_t (AAX_CALLBACK *inInstanceInitProc) ( const aContextType * inInstanceContextPtr, AAX_EComponentInstanceInitAction inAction ),
481 int32_t (AAX_CALLBACK *inBackgroundProc) ( void ) )
482{
483 return this->AddProcessProc_Native(
484 reinterpret_cast <AAX_CProcessProc>( inProcessProc ),
485 inProperties,
486 reinterpret_cast<AAX_CInstanceInitProc>( inInstanceInitProc ),
487 reinterpret_cast<AAX_CBackgroundProc>( inBackgroundProc ) );
488}
489
490#endif // #ifndef _AAX_ICOMPONENTDESCRIPTOR_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_eDataInPortType_Buffered
@ AAX_eDataInPortType_Buffered
Definition: AAX_Enums.h:1119
AAX_EComponentInstanceInitAction
AAX_EComponentInstanceInitAction
Selector indicating the action that occurred to prompt a component initialization callback.
Definition: AAX_Enums.h:860
AAX.h
Various utility definitions for AAX.
AAX_Result
int32_t AAX_Result
Definition: AAX.h:347
AAX_CALLBACK
#define AAX_CALLBACK
Definition: AAX.h:295
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
AAX_IComponentDescriptor
Description interface for an AAX plug-in component.
Definition: AAX_IComponentDescriptor.h:57
AAX_IComponentDescriptor::Clear
virtual AAX_Result Clear()=0
Clears the descriptor.
AAX_IComponentDescriptor::AddProcessProc
virtual AAX_Result AddProcessProc(AAX_IPropertyMap *inProperties, AAX_CSelector *outProcIDs=NULL, int32_t inProcIDsSize=0)=0
Registers one or more algorithm processing entrypoints (process procedures)
AAX_IComponentDescriptor::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_IComponentDescriptor::~AAX_IComponentDescriptor
virtual ~AAX_IComponentDescriptor()
Definition: AAX_IComponentDescriptor.h:59
AAX_IComponentDescriptor::NewPropertyMap
virtual AAX_IPropertyMap * NewPropertyMap() const =0
Creates a new, empty property map.
AAX_IComponentDescriptor::AddProcessProc_Native
virtual AAX_Result AddProcessProc_Native(AAX_CProcessProc inProcessProc, AAX_IPropertyMap *inProperties=NULL, AAX_CInstanceInitProc inInstanceInitProc=NULL, AAX_CBackgroundProc inBackgroundProc=NULL, AAX_CSelector *outProcID=NULL)=0
Registers an algorithm processing entrypoint (process procedure) for the native architecture.
AAX_IComponentDescriptor::AddSideChainIn
virtual AAX_Result AddSideChainIn(AAX_CFieldIndex inFieldIndex)=0
Subscribes a side-chain input context field.
AAX_IComponentDescriptor::AddDataInPort
virtual AAX_Result AddDataInPort(AAX_CFieldIndex inFieldIndex, uint32_t inPacketSize, AAX_EDataInPortType inPortType=AAX_eDataInPortType_Buffered)=0
Adds a custom data port to the algorithm context.
AAX_IComponentDescriptor::AddReservedField
virtual AAX_Result AddReservedField(AAX_CFieldIndex inFieldIndex, uint32_t inFieldType)=0
Subscribes a context field to host-provided services or information.
AAX_IComponentDescriptor::AddAudioBufferLength
virtual AAX_Result AddAudioBufferLength(AAX_CFieldIndex inFieldIndex)=0
Subscribes a buffer length context field.
AAX_IComponentDescriptor::AddClock
virtual AAX_Result AddClock(AAX_CFieldIndex inFieldIndex)=0
Subscribes a clock context field.
AAX_IComponentDescriptor::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_IComponentDescriptor::AddAudioIn
virtual AAX_Result AddAudioIn(AAX_CFieldIndex inFieldIndex)=0
Subscribes an audio input context field.
AAX_IComponentDescriptor::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_IComponentDescriptor::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_IComponentDescriptor::AddProcessProc_TI
virtual AAX_Result AddProcessProc_TI(const char inDLLFileNameUTF8[], const char inProcessProcSymbol[], AAX_IPropertyMap *inProperties, const char inInstanceInitProcSymbol[]=NULL, const char inBackgroundProcSymbol[]=NULL, AAX_CSelector *outProcID=NULL)=0
Registers an algorithm processing entrypoint (process procedure) for the native architecture.
AAX_IComponentDescriptor::DuplicatePropertyMap
virtual AAX_IPropertyMap * DuplicatePropertyMap(AAX_IPropertyMap *inPropertyMap) const =0
Creates a new property map using an existing property map.
AAX_IComponentDescriptor::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_IComponentDescriptor::AddSampleRate
virtual AAX_Result AddSampleRate(AAX_CFieldIndex inFieldIndex)=0
Subscribes a sample rate context field.
AAX_IComponentDescriptor::AddAudioOut
virtual AAX_Result AddAudioOut(AAX_CFieldIndex inFieldIndex)=0
Subscribes an audio output context field.
AAX_IComponentDescriptor::AddDmaInstance
virtual AAX_Result AddDmaInstance(AAX_CFieldIndex inFieldIndex, AAX_IDma::EMode inDmaMode)=0
Adds a DMA field to the plug-in's context.
AAX_IDma::EMode
EMode
DMA mode IDs.
Definition: AAX_IDma.h:81
AAX_IPropertyMap
Generic plug-in description property map.
Definition: AAX_IPropertyMap.h:69