| AAX SDK 2.6.1 Avid Audio Extensions Development Kit

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

- File List
- File Members

Loading...
Searching...
No Matches
AAX_Callbacks.h
Go to the documentation of this file.
1/*================================================================================================*/
2/*
3 *
4 * Copyright 2014-2017, 2023 Avid Technology, Inc.
5 * All rights reserved.
6 *
7 * CONFIDENTIAL: this document contains confidential information of Avid. Do
8 * not disclose to any third party. Use of the information contained in this
9 * document is subject to an Avid SDK license.
10 *
11 */
12
19/*================================================================================================*/
20
21
23#ifndef AAX_CALLBACKS_H_
24#define AAX_CALLBACKS_H_
26
27#include "AAX.h"
28
29// Callback IDs
30 enum AAX_CProcPtrID
31{
32 kAAX_ProcPtrID_Create_EffectParameters = 0,
33 kAAX_ProcPtrID_Create_EffectGUI = 1,
34 kAAX_ProcPtrID_Create_HostProcessor = 3,
35 kAAX_ProcPtrID_Create_EffectDirectData = 5,
36 kAAX_ProcPtrID_Create_TaskAgent = 6,
37 kAAX_ProcPtrID_Create_SessionDocumentClient = 7
38};
39
40 class IACFUnknown;
41
42 typedef IACFUnknown* (AAX_CALLBACK *AAXCreateObjectProc)(void);
43
44
48 template <typename aContextType>
49 class AAX_Component
50{
51 public:
52
53 typedef void
54 (AAX_CALLBACK *CProcessProc) (
55 aContextType * const inContextPtrsBegin [],
56 const void * inContextPtrsEnd);
57
58 typedef void *
59 (AAX_CALLBACK *CPacketAllocator) (
60 const aContextType * inContextPtr,
61 AAX_CFieldIndex inOutputPort,
62 AAX_CTimestamp inTimestamp);
63
64 typedef int32_t
65 (AAX_CALLBACK *CInstanceInitProc) (
66 const aContextType * inInstanceContextPtr,
67 AAX_EComponentInstanceInitAction iAction );
68
69 typedef int32_t
70 (AAX_CALLBACK *CBackgroundProc) ( void );
71
72 typedef void
73 (AAX_CALLBACK *CInitPrivateDataProc) (
74 AAX_CFieldIndex inFieldIndex,
75 void * inNewBlock,
76 int32_t inSize,
77 IACFUnknown * const inController);
78
79};
80
101 typedef AAX_Component <void>::CProcessProc AAX_CProcessProc;
102
115 typedef AAX_Component <void>::CPacketAllocator AAX_CPacketAllocator;
116
137 typedef AAX_Component <void>::CInstanceInitProc AAX_CInstanceInitProc;
138
148 typedef AAX_Component <void>::CBackgroundProc AAX_CBackgroundProc;
149
191 typedef AAX_Component <void>::CInitPrivateDataProc AAX_CInitPrivateDataProc;
192
194#endif // AAX_CALLBACKS_H_
AAX_EComponentInstanceInitAction
AAX_EComponentInstanceInitAction
Selector indicating the action that occurred to prompt a component initialization callback.
Definition: AAX_Enums.h:814
AAX.h
Various utility definitions for AAX.
AAX_CALLBACK
#define AAX_CALLBACK
Definition: AAX.h:282
AAX_CTimestamp
int64_t AAX_CTimestamp
Time stamp value. Measured against the DAE clock (see AAX_IComponentDescriptor::AddClock() )
Definition: AAX.h:328
AAX_CFieldIndex
AAX_CIndex AAX_CFieldIndex
Not used by AAX plug-ins (except in AAX_FIELD_INDEX macro)
Definition: AAX.h:346
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:137
AAX_CPacketAllocator
AAX_Component< void >::CPacketAllocator AAX_CPacketAllocator
Used by AAX_SchedulePacket()
Definition: AAX_Callbacks.h:115
AAXCreateObjectProc
IACFUnknown *(AAX_CALLBACK * AAXCreateObjectProc)(void)
Definition: AAX_Callbacks.h:42
AAX_CBackgroundProc
AAX_Component< void >::CBackgroundProc AAX_CBackgroundProc
A user-defined callback that AAX calls in the AAX Idle time.
Definition: AAX_Callbacks.h:148
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:101
AAX_CInitPrivateDataProc
AAX_Component< void >::CInitPrivateDataProc AAX_CInitPrivateDataProc
A user-defined callback to initialize a private data block.
Definition: AAX_Callbacks.h:191
AAX_CProcPtrID
AAX_CProcPtrID
Definition: AAX_Callbacks.h:31
kAAX_ProcPtrID_Create_HostProcessor
@ kAAX_ProcPtrID_Create_HostProcessor
AAX_IHostProcessor creation procedure
Definition: AAX_Callbacks.h:34
kAAX_ProcPtrID_Create_EffectGUI
@ kAAX_ProcPtrID_Create_EffectGUI
AAX_IEffectGUI creation procedure
Definition: AAX_Callbacks.h:33
kAAX_ProcPtrID_Create_EffectDirectData
@ kAAX_ProcPtrID_Create_EffectDirectData
AAX_IEffectDirectData creation procedure, used by plug-ins that want direct access to their alg memor...
Definition: AAX_Callbacks.h:35
kAAX_ProcPtrID_Create_EffectParameters
@ kAAX_ProcPtrID_Create_EffectParameters
AAX_IEffectParameters creation procedure
Definition: AAX_Callbacks.h:32
kAAX_ProcPtrID_Create_SessionDocumentClient
@ kAAX_ProcPtrID_Create_SessionDocumentClient
AAX_ISessionDocumentClient creation procedure
Definition: AAX_Callbacks.h:37
kAAX_ProcPtrID_Create_TaskAgent
@ kAAX_ProcPtrID_Create_TaskAgent
AAX_ITaskAgent creation procedure, used by plug-ins that want to process task requests made by the ho...
Definition: AAX_Callbacks.h:36
IACFUnknown
COM compatible IUnknown C++ interface.
Definition: AAX_ACFInterface.doxygen:252
AAX_Component
Empty class containing type declarations for the AAX algorithm and associated callbacks.
Definition: AAX_Callbacks.h:50
AAX_Component::CInitPrivateDataProc
void(AAX_CALLBACK * CInitPrivateDataProc)(AAX_CFieldIndex inFieldIndex, void *inNewBlock, int32_t inSize, IACFUnknown *const inController)
Definition: AAX_Callbacks.h:73
AAX_Component::CBackgroundProc
int32_t(AAX_CALLBACK * CBackgroundProc)(void)
Definition: AAX_Callbacks.h:70
AAX_Component::CPacketAllocator
void *(AAX_CALLBACK * CPacketAllocator)(const aContextType *inContextPtr, AAX_CFieldIndex inOutputPort, AAX_CTimestamp inTimestamp)
Definition: AAX_Callbacks.h:59
AAX_Component::CProcessProc
void(AAX_CALLBACK * CProcessProc)(aContextType *const inContextPtrsBegin[], const void *inContextPtrsEnd)
Definition: AAX_Callbacks.h:54
AAX_Component::CInstanceInitProc
int32_t(AAX_CALLBACK * CInstanceInitProc)(const aContextType *inInstanceContextPtr, AAX_EComponentInstanceInitAction iAction)
Definition: AAX_Callbacks.h:65