AAX_CMonolithicParameters.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *  Copyright 2014-2016, 2019, 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_CMONOLITHICPARAMETERS_H
#define AAX_CMONOLITHICPARAMETERS_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_CAtomicQueue.h"
#include "AAX_IParameter.h"
#include "AAX_IMIDINode.h"
#include "AAX_IString.h"
 
// Standard Includes
#include <set>
#include <list>
#include <utility>
 
 
// 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
 
// You can increase this if you need, it is not a system limitation.
#define kMaxAuxOutputStems     32
 
// You can increase this if you need; it should be set to a value greater than or equal to the number of synchronized parameters in your plug-in
#define kSynchronizedParameterQueueSize     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];      
    
    //AAX Hybrid
    AAX_EStemFormat     mHybridInputStemFormat;     
    AAX_EStemFormat     mHybridOutputStemFormat;    
    
    
    //General Properties
    AAX_EStemFormat mInputStemFormat;               
    AAX_EStemFormat mOutputStemFormat;              
    bool            mUseHostGeneratedGUI;           
    bool            mCanBypass;                     
    AAX_CTypeID     mManufacturerID;                
    AAX_CTypeID     mProductID;                     
    AAX_CTypeID     mPluginID;                      
    AAX_CTypeID     mAudiosuiteID;                  
    
    AAX_CBoolean    mMultiMonoSupport;
    
    
    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';
        mAudiosuiteID = 'none';
        mMultiMonoSupport = true;
        
        mNumAuxOutputStems = 0;
        for (int32_t i=0; i<kMaxAuxOutputStems; i++)
        {
            mAuxOutputStemNames[i] = 0;
            mAuxOutputStemFormats[i] = AAX_eStemFormat_Mono;
        }
        
        mHybridInputStemFormat = AAX_eStemFormat_None;
        mHybridOutputStemFormat = AAX_eStemFormat_None;
    }
};
 
class AAX_CMonolithicParameters;    //predefined for AAX_SInstrumentPrivateData
struct AAX_SInstrumentPrivateData
{
    AAX_CMonolithicParameters*  mMonolithicParametersPtr;
    
    //<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;                
    
    int64_t*                    mCurrentStateNum;       
};
 
class AAX_CMonolithicParameters : public AAX_CEffectParameters
{
public: 
    AAX_CMonolithicParameters (void);
    ~AAX_CMonolithicParameters (void) AAX_OVERRIDE;
            
protected: 
    typedef std::pair<AAX_CParamID const, const AAX_IParameterValue*> TParamValPair;
    
    virtual void        RenderAudio(AAX_SInstrumentRenderInfo* ioRenderInfo, const TParamValPair* inSynchronizedParamValues[], int32_t inNumSynchronizedParamValues) {}
    
    void                AddSynchronizedParameter(const AAX_IParameter& inParameter);
    
public: 
    // Overrides from \ref AAX_CEffectParameters
    AAX_Result  UpdateParameterNormalizedValue(AAX_CParamID iParamID, double aValue, AAX_EUpdateSource inSource) AAX_OVERRIDE;
    AAX_Result  GenerateCoefficients() AAX_OVERRIDE;
    AAX_Result  ResetFieldData (AAX_CFieldIndex iFieldIndex, void * oData, uint32_t iDataSize) const AAX_OVERRIDE;
    AAX_Result  TimerWakeup() AAX_OVERRIDE;
    static  AAX_Result  StaticDescribe (AAX_IEffectDescriptor * ioDescriptor, const AAX_SInstrumentSetupInfo & setupInfo);
    static  void    AAX_CALLBACK    StaticRenderAudio(AAX_SInstrumentRenderInfo* const  inInstancesBegin [], const void* inInstancesEnd);   
    
private:
    // This structure is used on the render thread to set up the contiguous array of TParamValPair* values
    // which is passed to RenderAudio(). The values are drawn from lists of parameter value updates which
    // were queued during GenerateCoefficients()
    struct SParamValList
    {
        // Using 4x the preset queue size: the buffer must be large enough to accommodate the maximum
        // number of updates that we expect to be queued between/before executions of the render callback.
        // The maximum queuing that will likely ever occur is during a preset change (i.e. a call to
        // SetChunk()), in which updates to all parameters may be queued in the same state frame. It is
        // possible that the host would call SetChunk() on the plug-in more than once before the render
        // callback executes, but probably not more than 2-3x. Therefore 4x seems like a safe upper limit
        // for the capacity of this buffer.
        static const int32_t sCap = 4*kSynchronizedParameterQueueSize;
        
        TParamValPair* mElem[sCap];
        int32_t mSize;
        
        SParamValList()
        {
            Clear();
        }
        
        void Add(TParamValPair* inElem)
        {
            AAX_ASSERT(sCap > mSize);
            if (sCap > mSize)
            {
                mElem[mSize++] = inElem;
            }
        }
        
        void Append(const SParamValList& inOther)
        {
            AAX_ASSERT(sCap >= mSize + inOther.mSize);
            for (int32_t i = 0; i < inOther.mSize; ++i)
            {
                Add(inOther.mElem[i]);
            }
        }
        
        void Append(const std::list<TParamValPair*>& inOther)
        {
            AAX_ASSERT(sCap >= mSize + (int64_t)inOther.size());
            for (std::list<TParamValPair*>::const_iterator iter = inOther.begin(); iter != inOther.end(); ++iter)
            {
                Add(*iter);
            }
        }
        
        void Merge(AAX_IPointerQueue<TParamValPair>& inOther)
        {
            do
            {
                TParamValPair* const val = inOther.Pop();
                if (NULL == val) { break; }
                Add(val);
            } while (1);
        }
        
        void Clear() 
        {
            std::memset(mElem, 0x0, sizeof(mElem));
            mSize = 0;
        }
    };
    
    typedef std::set<const AAX_IParameter*> TParamSet;
    typedef std::pair<int64_t, std::list<TParamValPair*> > TNumberedParamStateList;
    typedef AAX_CAtomicQueue<TNumberedParamStateList, 256> TNumberedStateListQueue;
    typedef AAX_CAtomicQueue<const TParamValPair, 16*kSynchronizedParameterQueueSize> TParamValPairQueue;
    
    
    SParamValList GetUpdatesForState(int64_t inTargetStateNum);
    void DeleteUsedParameterChanges();
    
private:
    std::set<std::string>                   mSynchronizedParameters;
    int64_t                                 mStateCounter;
    TParamSet                               mDirtyParameters;
    TNumberedStateListQueue                 mQueuedParameterChanges;
    TNumberedStateListQueue                 mFinishedParameterChanges; // Parameter changes ready for deletion
    TParamValPairQueue                      mFinishedParameterValues; // Parameter values ready for deletion
};
 
    
 
 
 
#endif // AAX_CMONOLITHICPARAMETERS_H