AAX_CInstrumentParameters.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright (c) 1993 - 2009 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_CINSTRUMENTPARAMETERS_H
#define AAX_CINSTRUMENTPARAMETERS_H

// AAX headers
//
// Parent class
#include "AAX_CEffectParameters.h"
//
// Describe
#include "AAX_IEffectDescriptor.h"
#include "AAX_IComponentDescriptor.h"
#include "AAX_IPropertyMap.h"
//
// Utilities
#include "AAX_IMIDINode.h"
#include "AAX_IString.h"

// Max number of additional midi nodes is 15, for a grand total of 16 input midi nodes.  We're not aware of any plug-in that uses more.  
#define kMaxAdditionalMIDINodes     15

// Max number of additional midi nodes is 15, for a grand total of 16 input midi nodes.  We're not aware of any plug-in that uses more.  You can increase this if you need, it
// is not a system limitation.
#define kMaxAuxOutputStems     32


struct AAX_SInstrumentSetupInfo
{
    //Global MIDI Nodes
    bool                mNeedsGlobalMIDI;           
    const char*         mGlobalMIDINodeName;        
    uint32_t            mGlobalMIDIEventMask;       
    
    //Input MIDI Nodes
    bool                mNeedsInputMIDI;                
    const char*         mInputMIDINodeName;             
    uint32_t            mInputMIDIChannelMask;          
    int32_t             mNumAdditionalInputMIDINodes;   
    
    //Transport
    bool                mNeedsTransport;            
    const char*         mTransportMIDINodeName;     
    
    //Meters
    int32_t             mNumMeters;                 
    const AAX_CTypeID*  mMeterIDs;                  
    
    //Aux Output Stems Feature.
    int32_t             mNumAuxOutputStems;         
    const char*         mAuxOutputStemNames[kMaxAuxOutputStems];     
    AAX_EStemFormat     mAuxOutputStemFormats[kMaxAuxOutputStems];      
    
    //General Properties
    AAX_EStemFormat mInputStemFormat;               
    AAX_EStemFormat mOutputStemFormat;              
    bool            mUseHostGeneratedGUI;           
    bool            mCanBypass;                     
    AAX_CTypeID     mManufacturerID;                
    AAX_CTypeID     mProductID;                     
    AAX_CTypeID     mPluginID;                      
    
    
    AAX_SInstrumentSetupInfo()
    {
        mNeedsGlobalMIDI = false;
        mGlobalMIDINodeName = "GlobalMIDI";
        mGlobalMIDIEventMask = 0xffff;
        mNeedsInputMIDI = false;
        mInputMIDINodeName = "InputMIDI";
        mInputMIDIChannelMask = 0xffff;
        mNumAdditionalInputMIDINodes = 0;
        mNeedsTransport = false;
        mTransportMIDINodeName = "Transport";
        mNumMeters = 0;
        mMeterIDs = 0;
        mInputStemFormat = AAX_eStemFormat_Mono;
        mOutputStemFormat = AAX_eStemFormat_Mono;
        mUseHostGeneratedGUI = false;
        mCanBypass = true;
        mManufacturerID = 'none';
        mProductID = 'none';
        mPluginID = 'none';
        
        mNumAuxOutputStems = 0;
        for (int32_t i=0; i<kMaxAuxOutputStems; i++)
        {
            mAuxOutputStemNames[i] = 0;
            mAuxOutputStemFormats[i] = AAX_eStemFormat_Mono;
        }
    }
};

class AAX_CInstrumentParameters;    //predefined for AAX_SInstrumentPrivateData
struct AAX_SInstrumentPrivateData
{
    AAX_CInstrumentParameters*  mInstrumentParametersPtr;
    
    //<DMT>  Removed mOutputStemFormat. Adding it to this structure was not intentional.  Please call Controller()->GetOutputStemFormat() from your RenderAudio call if you need this info.
    //<DMT>  Please note, nothing else should be added to this struct.  All host information is accessible through the AAX_IController in the RenderAudio call.
};


struct AAX_SInstrumentRenderInfo
{
    float**                     mAudioInputs;           
    float**                     mAudioOutputs;          
    int32_t*                    mNumSamples;            
    AAX_CTimestamp*             mClock;                 

    AAX_IMIDINode*              mInputNode;             
    AAX_IMIDINode*              mGlobalNode;            
    AAX_IMIDINode*              mTransportNode;         
    AAX_IMIDINode*              mAdditionalInputMIDINodes[kMaxAdditionalMIDINodes];  

    AAX_SInstrumentPrivateData* mPrivateData;           

    float**                     mMeters;                
};

class AAX_CInstrumentParameters : public AAX_CEffectParameters
{
public: 
    
    AAX_CInstrumentParameters (void);
    virtual ~AAX_CInstrumentParameters (void);
            
public: 
        
    virtual void                RenderAudio(AAX_SInstrumentRenderInfo* ioRenderInfo);       
    
public: 
    
    virtual AAX_Result ResetFieldData (AAX_CFieldIndex iFieldIndex, void * oData, uint32_t iDataSize) const; 
    static  AAX_Result  StaticDescribe (AAX_IEffectDescriptor * ioDescriptor, const AAX_SInstrumentSetupInfo & setupInfo);
    static  void    AAX_CALLBACK    StaticRenderAudio(AAX_SInstrumentRenderInfo* const  inInstancesBegin [], const void* inInstancesEnd);   
};

    



#endif