AAX_CEffectParameters.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013-2017, 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_CEFFECTPARAMETERS_H
#define AAX_CEFFECTPARAMETERS_H
 
#include "AAX_IEffectParameters.h"
#include "AAX_IPageTable.h"
#include "AAX_CString.h"
#include "AAX_CChunkDataParser.h"
#include "AAX_CParameterManager.h"
#include "AAX_CPacketDispatcher.h"
 
#include <set>
#include <string>
#include <vector>
 
class AAX_IController;
class AAX_IAutomationDelegate;
class AAX_CParameterManager;
class AAX_CPacketDispatcher;
class AAX_ITransport;
 
extern "C" AAX_CParamID cPreviewID;
extern "C" AAX_CParamID cDefaultMasterBypassID;
 
class AAX_CEffectParameters : public AAX_IEffectParameters
{
public: 
    AAX_CEffectParameters (void);
    ~AAX_CEffectParameters (void) AAX_OVERRIDE;
    AAX_CEffectParameters& operator= (const AAX_CEffectParameters& other);
    
public: 
    AAX_Result Initialize(IACFUnknown* iController) AAX_OVERRIDE;
    AAX_Result Uninitialize (void) AAX_OVERRIDE;
    
    AAX_Result NotificationReceived( /* AAX_ENotificationEvent */ AAX_CTypeID inNotificationType, const void * inNotificationData, uint32_t inNotificationDataSize) AAX_OVERRIDE;
    
    AAX_Result GetNumberOfParameters (int32_t * oNumControls)  const AAX_OVERRIDE;
    AAX_Result GetMasterBypassParameter (AAX_IString * oIDString)  const AAX_OVERRIDE;
    AAX_Result GetParameterIsAutomatable (AAX_CParamID iParameterID, AAX_CBoolean * oAutomatable)  const AAX_OVERRIDE;
    AAX_Result GetParameterNumberOfSteps (AAX_CParamID iParameterID, int32_t * oNumSteps )  const AAX_OVERRIDE;
    AAX_Result GetParameterName (AAX_CParamID iParameterID, AAX_IString * oName )  const AAX_OVERRIDE;
    AAX_Result GetParameterNameOfLength (AAX_CParamID iParameterID, AAX_IString * oName, int32_t iNameLength )  const AAX_OVERRIDE;
    AAX_Result GetParameterDefaultNormalizedValue (AAX_CParamID iParameterID, double * oValue )  const AAX_OVERRIDE;
    AAX_Result SetParameterDefaultNormalizedValue (AAX_CParamID iParameterID, double iValue ) AAX_OVERRIDE;
    AAX_Result GetParameterType (AAX_CParamID iParameterID, AAX_EParameterType * oParameterType )  const AAX_OVERRIDE;
    AAX_Result GetParameterOrientation (AAX_CParamID iParameterID, AAX_EParameterOrientation * oParameterOrientation )  const AAX_OVERRIDE;
    AAX_Result GetParameter (AAX_CParamID iParameterID, AAX_IParameter ** oParameter ) AAX_OVERRIDE;
    AAX_Result GetParameterIndex (AAX_CParamID iParameterID, int32_t * oControlIndex )  const AAX_OVERRIDE;
    AAX_Result GetParameterIDFromIndex (int32_t iControlIndex, AAX_IString * oParameterIDString )  const AAX_OVERRIDE;
    AAX_Result GetParameterValueInfo ( AAX_CParamID iParameterID, int32_t iSelector, int32_t* oValue) const AAX_OVERRIDE;
    
    AAX_Result GetParameterValueFromString (AAX_CParamID iParameterID, double * oValue, const AAX_IString & iValueString )  const AAX_OVERRIDE;
    AAX_Result GetParameterStringFromValue (AAX_CParamID iParameterID, double iValue, AAX_IString * oValueString, int32_t iMaxLength )  const AAX_OVERRIDE;
    AAX_Result GetParameterValueString (AAX_CParamID iParameterID, AAX_IString * oValueString, int32_t iMaxLength)  const AAX_OVERRIDE;
    AAX_Result GetParameterNormalizedValue (AAX_CParamID iParameterID, double * oValuePtr )  const AAX_OVERRIDE;
    AAX_Result SetParameterNormalizedValue (AAX_CParamID iParameterID, double iValue ) AAX_OVERRIDE;
    AAX_Result SetParameterNormalizedRelative (AAX_CParamID iParameterID, double iValue ) AAX_OVERRIDE;
    
    AAX_Result TouchParameter ( AAX_CParamID iParameterID ) AAX_OVERRIDE;
    AAX_Result ReleaseParameter ( AAX_CParamID iParameterID ) AAX_OVERRIDE;
    AAX_Result UpdateParameterTouch ( AAX_CParamID iParameterID, AAX_CBoolean iTouchState ) AAX_OVERRIDE;
        
    AAX_Result UpdateParameterNormalizedValue (AAX_CParamID iParameterID, double iValue, AAX_EUpdateSource iSource ) AAX_OVERRIDE;
    AAX_Result UpdateParameterNormalizedRelative (AAX_CParamID iParameterID, double iValue ) AAX_OVERRIDE;
    AAX_Result GenerateCoefficients(void) AAX_OVERRIDE;
 
    AAX_Result ResetFieldData (AAX_CFieldIndex inFieldIndex, void * oData, uint32_t inDataSize) const AAX_OVERRIDE;
 
    AAX_Result GetNumberOfChunks (int32_t * oNumChunks )  const AAX_OVERRIDE;
    AAX_Result GetChunkIDFromIndex (int32_t iIndex, AAX_CTypeID * oChunkID )  const AAX_OVERRIDE;
    AAX_Result GetChunkSize (AAX_CTypeID iChunkID, uint32_t * oSize )  const AAX_OVERRIDE;
    AAX_Result GetChunk (AAX_CTypeID iChunkID, AAX_SPlugInChunk * oChunk ) const AAX_OVERRIDE;
    AAX_Result SetChunk (AAX_CTypeID iChunkID, const AAX_SPlugInChunk * iChunk ) AAX_OVERRIDE;
    AAX_Result CompareActiveChunk (const AAX_SPlugInChunk * iChunkP, AAX_CBoolean * oIsEqual )  const AAX_OVERRIDE;
    AAX_Result GetNumberOfChanges (int32_t * oNumChanges )  const AAX_OVERRIDE;
    
    AAX_Result TimerWakeup() AAX_OVERRIDE;
    
    AAX_Result GetCurveData( /* AAX_ECurveType */ AAX_CTypeID iCurveType, const float * iValues, uint32_t iNumValues, float * oValues ) const AAX_OVERRIDE;
    AAX_Result GetCurveDataMeterIds( /* AAX_ECurveType */ AAX_CTypeID iCurveType, uint32_t *oXMeterId, uint32_t *oYMeterId)  const AAX_OVERRIDE;
    AAX_Result GetCurveDataDisplayRange( /* AAX_ECurveType */ AAX_CTypeID iCurveType, float *oXMin, float *oXMax, float *oYMin, float *oYMax ) const AAX_OVERRIDE;
    
    AAX_Result UpdatePageTable(uint32_t inTableType, int32_t inTablePageSize, IACFUnknown* iHostUnknown, IACFUnknown* ioPageTableUnknown) const AAX_OVERRIDE AAX_FINAL;
    
    AAX_Result          GetCustomData( AAX_CTypeID iDataBlockID, uint32_t inDataSize, void* oData, uint32_t* oDataWritten) const AAX_OVERRIDE;
    AAX_Result          SetCustomData( AAX_CTypeID iDataBlockID, uint32_t inDataSize, const void* iData ) AAX_OVERRIDE;
    
    AAX_Result          DoMIDITransfers() AAX_OVERRIDE { return AAX_SUCCESS; }
    AAX_Result          UpdateMIDINodes ( AAX_CFieldIndex inFieldIndex, AAX_CMidiPacket& iPacket ) AAX_OVERRIDE;
    AAX_Result          UpdateControlMIDINodes ( AAX_CTypeID nodeID, AAX_CMidiPacket& iPacket ) AAX_OVERRIDE;
 
    AAX_Result          RenderAudio_Hybrid(AAX_SHybridRenderInfo* ioRenderInfo) AAX_OVERRIDE;
 
 
 
public: 
    AAX_IController*                Controller(); 
    const AAX_IController*          Controller() const; 
    AAX_ITransport*                 Transport(); 
    const AAX_ITransport*           Transport() const; 
    AAX_IAutomationDelegate*        AutomationDelegate(); 
    const AAX_IAutomationDelegate*  AutomationDelegate() const; 
    
protected:
    AAX_Result          SetTaperDelegate ( AAX_CParamID iParameterID, AAX_ITaperDelegateBase & iTaperDelegate, bool iPreserveValue );
    AAX_Result          SetDisplayDelegate ( AAX_CParamID iParameterID, AAX_IDisplayDelegateBase & iDisplayDelegate );
    bool                IsParameterTouched ( AAX_CParamID iParameterID ) const;
    bool                IsParameterLinkReady ( AAX_CParamID inParameterID, AAX_EUpdateSource inSource ) const;
    
    virtual AAX_Result  EffectInit(void) { return AAX_SUCCESS; };
    
    virtual AAX_Result UpdatePageTable(uint32_t /*inTableType*/, int32_t /*inTablePageSize*/, AAX_IPageTable& /*ioPageTable*/) const { return AAX_ERROR_UNIMPLEMENTED; }
 
    void FilterParameterIDOnSave(AAX_CParamID controlID);
 
    void BuildChunkData (void) const;
    
protected:
    int32_t                         mNumPlugInChanges;  
    mutable int32_t                 mChunkSize;             //this old behavior isn't const friendly yet.  Consider this a temp variable.           
    mutable AAX_CChunkDataParser    mChunkParser;           //this old behavior isn't const friendly yet.  Consider this a temp variable.
    int32_t                         mNumChunkedParameters;
    AAX_CPacketDispatcher           mPacketDispatcher;  
    AAX_CParameterManager           mParameterManager;  
    std::set<std::string>           mFilteredParameters;    
 
private:
    // interfaces provided by the host via the IACFUnknown passed to Initialize()
    AAX_IController*                mController; 
    AAX_ITransport*                 mTransport; 
    AAX_IAutomationDelegate*        mAutomationDelegate; 
 
};
 
// Convenience functions since many legacy plug-ins had internal int32 value representations.
extern int32_t NormalizedToInt32 (double normalizedValue );
extern double Int32ToNormalized (int32_t value );
extern double BoolToNormalized (bool value );
 
#endif