AAX_IACFComponentDescriptor.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013 by Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  CONFIDENTIAL: This document contains confidential information.  Do not 
 *  read or examine this document unless you are an Avid Technology employee
 *  or have signed a non-disclosure agreement with Avid Technology which protects
 *  the confidentiality of this document.  DO NOT DISCLOSE ANY INFORMATION 
 *  CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT 
 *  OF Avid Technolgy, INC.
 *
 */

/*================================================================================================*/


#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 iFieldIndex, uint32_t iFieldType ) = 0;  
    virtual AAX_Result  AddAudioIn ( AAX_CFieldIndex iFieldIndex ) = 0; 
    virtual AAX_Result  AddAudioOut ( AAX_CFieldIndex iFieldIndex ) = 0;    
    virtual AAX_Result  AddAudioBufferLength ( AAX_CFieldIndex iFieldIndex ) = 0;   
    virtual AAX_Result  AddSampleRate ( AAX_CFieldIndex iFieldIndex ) = 0;  
    virtual AAX_Result  AddClock ( AAX_CFieldIndex iFieldIndex ) = 0;   
    virtual AAX_Result  AddSideChainIn ( AAX_CFieldIndex iFieldIndex ) = 0; 
    virtual AAX_Result  AddDataInPort ( AAX_CFieldIndex iFieldIndex, uint32_t iPacketSize, AAX_EDataInPortType iPortType) = 0;  
    virtual AAX_Result  AddAuxOutputStem ( AAX_CFieldIndex iFieldIndex, int32_t iStemFormat, const char iNameUTF8[]) = 0;   
    virtual AAX_Result  AddPrivateData ( AAX_CFieldIndex iFieldIndex, int32_t iDataSize, uint32_t iOptions = AAX_ePrivateDataOptions_DefaultOptions ) = 0;  
    virtual AAX_Result  AddDmaInstance ( AAX_CFieldIndex iFieldIndex, AAX_IDma::EMode iDmaMode ) = 0;   
    virtual AAX_Result  AddMIDINode ( AAX_CFieldIndex iFieldIndex, AAX_EMIDINodeType iNodeType, const char iNodeName[], uint32_t channelMask ) = 0; 

    virtual AAX_Result  AddProcessProc_Native ( 
        AAX_CProcessProc iProcessProc,  
        IACFUnknown * iProperties = NULL, 
        AAX_CInstanceInitProc iInstanceInitProc = NULL, 
        AAX_CBackgroundProc iBackgroundProc = NULL, 
        AAX_CSelector * oProcID = NULL) = 0;    
    virtual AAX_Result  AddProcessProc_TI ( 
        const char inDLLFileNameUTF8 [], 
        const char iProcessProcSymbol [], 
        IACFUnknown * iProperties = NULL, 
        const char iInstanceInitProcSymbol [] = NULL,
        const char iBackgroundProcSymbol [] = NULL,
        AAX_CSelector * oProcID = NULL) = 0;    
    
    virtual AAX_Result  AddMeters ( AAX_CFieldIndex iFieldIndex, const AAX_CTypeID* iMeterIDs, const uint32_t iMeterCount ) = 0;    
};

class AAX_IACFComponentDescriptor_V2 : public AAX_IACFComponentDescriptor
{
public:
    virtual AAX_Result  AddTemporaryData( AAX_CFieldIndex iFieldIndex, uint32_t iDataElementSize) = 0;  
};

#ifdef __clang__
#pragma clang diagnostic pop
#endif

#endif // #ifndef _AAX_IACFCOMPONENTDESCRIPTOR_H_