AAX_IComponentDescriptor.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013-2017, 2023-2024 Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  This file is part of the Avid AAX SDK.
 *  
 *  The AAX SDK is subject to commercial or open-source licensing.
 *  
 *  By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
 *  Agreement and Avid Privacy Policy.
 *  
 *  AAX SDK License: https://developer.avid.com/aax
 *  Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
 *  
 *  Or: You may also use this code under the terms of the GPL v3 (see
 *  www.gnu.org/licenses).
 *  
 *  THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
 *  EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
 *  DISCLAIMED.
 *
 */
 
/*================================================================================================*/
 
 
#ifndef _AAX_ICOMPONENTDESCRIPTOR_H_
#define _AAX_ICOMPONENTDESCRIPTOR_H_
 
#include "AAX.h"
#include "AAX_IDma.h"
#include "AAX_Callbacks.h"
 
class AAX_IPropertyMap;
 
 
class AAX_IComponentDescriptor
{
public:
    virtual ~AAX_IComponentDescriptor() {}
        
    virtual AAX_Result                  Clear () = 0;
    
    virtual AAX_Result                  AddAudioIn ( AAX_CFieldIndex inFieldIndex ) = 0;
 
    virtual AAX_Result                  AddAudioOut ( AAX_CFieldIndex inFieldIndex ) = 0;
 
    virtual AAX_Result                  AddAudioBufferLength ( AAX_CFieldIndex inFieldIndex ) = 0;
 
    virtual AAX_Result                  AddSampleRate ( AAX_CFieldIndex inFieldIndex ) = 0;
 
    virtual AAX_Result                  AddClock ( AAX_CFieldIndex inFieldIndex ) = 0;
 
    virtual AAX_Result                  AddSideChainIn ( AAX_CFieldIndex inFieldIndex ) = 0;
 
    virtual AAX_Result                  AddDataInPort ( AAX_CFieldIndex inFieldIndex, uint32_t inPacketSize, AAX_EDataInPortType inPortType = AAX_eDataInPortType_Buffered ) = 0;
 
    virtual AAX_Result                  AddAuxOutputStem ( AAX_CFieldIndex inFieldIndex, int32_t inStemFormat, const char inNameUTF8[]) = 0;
    virtual AAX_Result                  AddPrivateData ( AAX_CFieldIndex inFieldIndex, int32_t inDataSize, /* AAX_EPrivateDataOptions */ uint32_t inOptions = AAX_ePrivateDataOptions_DefaultOptions ) = 0;
    
    virtual AAX_Result                  AddTemporaryData( AAX_CFieldIndex inFieldIndex, uint32_t inDataElementSize) = 0;
 
    virtual AAX_Result                  AddDmaInstance ( AAX_CFieldIndex inFieldIndex, AAX_IDma::EMode inDmaMode ) = 0;
    
    virtual AAX_Result                  AddMeters ( AAX_CFieldIndex inFieldIndex, const AAX_CTypeID* inMeterIDs, const uint32_t inMeterCount ) = 0;
 
    virtual AAX_Result                  AddMIDINode ( AAX_CFieldIndex inFieldIndex, AAX_EMIDINodeType inNodeType, const char inNodeName[], uint32_t channelMask ) = 0;
 
    virtual AAX_Result                  AddReservedField ( AAX_CFieldIndex inFieldIndex, uint32_t inFieldType ) = 0;
 
    virtual AAX_IPropertyMap *          NewPropertyMap () const = 0; // CONST?
    
    virtual AAX_IPropertyMap *          DuplicatePropertyMap (AAX_IPropertyMap* inPropertyMap) const = 0;
    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;
    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;
    
    virtual AAX_Result                  AddProcessProc (
        AAX_IPropertyMap* inProperties,
        AAX_CSelector* outProcIDs = NULL,
        int32_t inProcIDsSize = 0) = 0;
    
    template <typename aContextType>
    AAX_Result                          AddProcessProc_Native (
        void (AAX_CALLBACK *inProcessProc) ( aContextType * const inInstancesBegin [], const void * inInstancesEnd),
        AAX_IPropertyMap * inProperties = NULL,
        int32_t (AAX_CALLBACK *inInstanceInitProc) ( const aContextType * inInstanceContextPtr, AAX_EComponentInstanceInitAction inAction ) = NULL, 
        int32_t (AAX_CALLBACK *inBackgroundProc) ( void ) = NULL );
};
 
template <typename aContextType>
inline AAX_Result
AAX_IComponentDescriptor::AddProcessProc_Native ( 
    void (AAX_CALLBACK *inProcessProc) ( aContextType * const   inInstancesBegin [], const void * inInstancesEnd),
    AAX_IPropertyMap * inProperties,
    int32_t (AAX_CALLBACK *inInstanceInitProc) ( const aContextType * inInstanceContextPtr, AAX_EComponentInstanceInitAction inAction ),
    int32_t (AAX_CALLBACK *inBackgroundProc) ( void ) )
{
    return this->AddProcessProc_Native( 
        reinterpret_cast <AAX_CProcessProc>( inProcessProc ),
        inProperties,
        reinterpret_cast<AAX_CInstanceInitProc>( inInstanceInitProc ),
        reinterpret_cast<AAX_CBackgroundProc>( inBackgroundProc ) );
}
 
#endif // #ifndef _AAX_ICOMPONENTDESCRIPTOR_H_