AAX_IComponentDescriptor.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_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 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 = AAX_eDataInPortType_Buffered ) = 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, /* AAX_EPrivateDataOptions */ uint32_t iOptions = AAX_ePrivateDataOptions_DefaultOptions ) = 0;
    
    virtual AAX_Result  AddTemporaryData( AAX_CFieldIndex iFieldIndex, uint32_t iDataElementSize) = 0;

    virtual AAX_Result                  AddDmaInstance ( AAX_CFieldIndex iFieldIndex, AAX_IDma::EMode iDmaMode ) = 0;
    
    virtual AAX_Result                  AddMeters ( AAX_CFieldIndex iFieldIndex, const AAX_CTypeID* iMeterIDs, const uint32_t iMeterCount ) = 0;

    virtual AAX_Result                  AddMIDINode ( AAX_CFieldIndex iFieldIndex, AAX_EMIDINodeType iNodeType, const char iNodeName[], uint32_t channelMask ) = 0;

    virtual AAX_Result                  AddReservedField ( AAX_CFieldIndex iFieldIndex, uint32_t iFieldType ) = 0;

    virtual AAX_IPropertyMap *          NewPropertyMap () const = 0; // CONST?
    virtual AAX_IPropertyMap *          DuplicatePropertyMap (AAX_IPropertyMap* iPropertyMap) const = 0; // CONST?
    virtual AAX_Result                  AddProcessProc_Native ( 
        AAX_CProcessProc iProcessProc,  
        AAX_IPropertyMap * 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 [], 
        AAX_IPropertyMap * iProperties = NULL, 
        const char iInstanceInitProcSymbol [] = NULL,
        const char iBackgroundProcSymbol [] = NULL,
        AAX_CSelector * oProcID = NULL) = 0;


    template <typename aContextType>
    AAX_Result AddProcessProc_Native ( 
        void (AAX_CALLBACK *iProcessProc) ( aContextType * const iInstancesBegin [], const void * iInstancesEnd),
        AAX_IPropertyMap * iProperties = NULL,
        int32_t (AAX_CALLBACK *iInstanceInitProc) ( const aContextType * iInstanceContextPtr, AAX_EComponentInstanceInitAction iAction ) = NULL, 
        int32_t (AAX_CALLBACK *iBackgroundProc) ( void ) = NULL );
};

template <typename aContextType>
inline AAX_Result
AAX_IComponentDescriptor::AddProcessProc_Native ( 
    void (AAX_CALLBACK *iProcessProc) ( aContextType * const    iInstancesBegin [], const void * iInstancesEnd),
    AAX_IPropertyMap * iProperties,
    int32_t (AAX_CALLBACK *iInstanceInitProc) ( const aContextType * iInstanceContextPtr, AAX_EComponentInstanceInitAction iAction ),
    int32_t (AAX_CALLBACK *iBackgroundProc) ( void ) )
{
    return this->AddProcessProc_Native( 
        reinterpret_cast <AAX_CProcessProc>( iProcessProc ), 
        iProperties, 
        reinterpret_cast<AAX_CInstanceInitProc>( iInstanceInitProc ),
        reinterpret_cast<AAX_CBackgroundProc>( iBackgroundProc ) );
}

#endif // #ifndef _AAX_ICOMPONENTDESCRIPTOR_H_