AAX_IACFComponentDescriptor.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_IACFCOMPONENTDESCRIPTOR_H_
#define _AAX_IACFCOMPONENTDESCRIPTOR_H_
 
#include "AAX.h"
#include "AAX_Callbacks.h"
#include "AAX_IDma.h"
 
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wnon-virtual-dtor"
#endif
 
#include "acfunknown.h"
 
 
class AAX_IACFComponentDescriptor : public IACFUnknown
{
public:
    virtual AAX_Result  Clear () = 0;   
    virtual AAX_Result  AddReservedField ( AAX_CFieldIndex inFieldIndex, uint32_t inFieldType ) = 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) = 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, uint32_t inOptions = AAX_ePrivateDataOptions_DefaultOptions ) = 0;   
    virtual AAX_Result  AddDmaInstance ( AAX_CFieldIndex inFieldIndex, AAX_IDma::EMode inDmaMode ) = 0; 
    virtual AAX_Result  AddMIDINode ( AAX_CFieldIndex inFieldIndex, AAX_EMIDINodeType inNodeType, const char inNodeName[], uint32_t channelMask ) = 0;  
 
    virtual AAX_Result  AddProcessProc_Native ( 
        AAX_CProcessProc inProcessProc,
        IACFUnknown * inProperties,
        AAX_CInstanceInitProc inInstanceInitProc,
        AAX_CBackgroundProc inBackgroundProc,
        AAX_CSelector * outProcID) = 0; 
    virtual AAX_Result  AddProcessProc_TI ( 
        const char inDLLFileNameUTF8 [], 
        const char inProcessProcSymbol [],
        IACFUnknown * inProperties,
        const char inInstanceInitProcSymbol [],
        const char inBackgroundProcSymbol [],
        AAX_CSelector * outProcID) = 0; 
    
    virtual AAX_Result  AddMeters ( AAX_CFieldIndex inFieldIndex, const AAX_CTypeID* inMeterIDs, const uint32_t inMeterCount ) = 0; 
};
 
class AAX_IACFComponentDescriptor_V2 : public AAX_IACFComponentDescriptor
{
public:
    virtual AAX_Result  AddTemporaryData( AAX_CFieldIndex inFieldIndex, uint32_t inDataElementSize) = 0;    
};
 
class AAX_IACFComponentDescriptor_V3 : public AAX_IACFComponentDescriptor_V2
{
public:
    virtual AAX_Result AddProcessProc (
        IACFUnknown * inProperties,
        AAX_CSelector* outProcIDs,
        int32_t inProcIDsSize) = 0; 
};
 
#ifdef __clang__
#pragma clang diagnostic pop
#endif
 
#endif // #ifndef _AAX_IACFCOMPONENTDESCRIPTOR_H_