AAX_IACFEffectParameters.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_IACFEFFECTPARAMETERS_H
#define AAX_IACFEFFECTPARAMETERS_H
 
#include "AAX.h"
 
class AAX_IString;
class AAX_IParameter;
 
 
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wnon-virtual-dtor"
#endif
 
#include "acfunknown.h"
 
class AAX_IACFEffectParameters : public IACFUnknown
{
public:
    
    virtual AAX_Result          Initialize(IACFUnknown * iController) = 0;
    virtual AAX_Result          Uninitialize () = 0;
    
 
    virtual AAX_Result          NotificationReceived( /* AAX_ENotificationEvent */ AAX_CTypeID inNotificationType, const void * inNotificationData, uint32_t    inNotificationDataSize) = 0;
    
    
    virtual AAX_Result          GetNumberOfParameters ( int32_t * oNumControls )   const = 0;
    virtual AAX_Result          GetMasterBypassParameter ( AAX_IString * oIDString )   const = 0;
    virtual AAX_Result          GetParameterIsAutomatable ( AAX_CParamID iParameterID, AAX_CBoolean * oAutomatable )   const = 0;
    virtual AAX_Result          GetParameterNumberOfSteps ( AAX_CParamID iParameterID, int32_t * oNumSteps )   const = 0;
    virtual AAX_Result          GetParameterName ( AAX_CParamID iParameterID, AAX_IString * oName )   const = 0;
    virtual AAX_Result          GetParameterNameOfLength ( AAX_CParamID iParameterID, AAX_IString * oName, int32_t iNameLength )   const = 0;
    virtual AAX_Result          GetParameterDefaultNormalizedValue ( AAX_CParamID iParameterID, double * oValue )   const = 0;
    virtual AAX_Result          SetParameterDefaultNormalizedValue ( AAX_CParamID iParameterID, double iValue ) = 0;
    virtual AAX_Result          GetParameterType ( AAX_CParamID iParameterID, AAX_EParameterType * oParameterType )   const = 0;
    virtual AAX_Result          GetParameterOrientation ( AAX_CParamID iParameterID, AAX_EParameterOrientation * oParameterOrientation )   const = 0;
    virtual AAX_Result          GetParameter ( AAX_CParamID iParameterID, AAX_IParameter ** oParameter )  = 0;
    virtual AAX_Result          GetParameterIndex ( AAX_CParamID iParameterID, int32_t * oControlIndex )   const = 0;
    virtual AAX_Result          GetParameterIDFromIndex ( int32_t iControlIndex, AAX_IString * oParameterIDString )   const = 0;
    virtual AAX_Result          GetParameterValueInfo ( AAX_CParamID iParameterID, int32_t iSelector, int32_t* oValue) const = 0;
    
    
    
    virtual AAX_Result          GetParameterValueFromString ( AAX_CParamID iParameterID, double * oValue, const AAX_IString & iValueString )   const = 0;
    virtual AAX_Result          GetParameterStringFromValue ( AAX_CParamID iParameterID, double iValue, AAX_IString * oValueString, int32_t iMaxLength )   const = 0;
    virtual AAX_Result          GetParameterValueString ( AAX_CParamID iParameterID, AAX_IString* oValueString, int32_t iMaxLength  )   const = 0;
    virtual AAX_Result          GetParameterNormalizedValue ( AAX_CParamID iParameterID, double * oValuePtr )   const = 0;
    virtual AAX_Result          SetParameterNormalizedValue ( AAX_CParamID iParameterID, double iValue ) = 0;   
    virtual AAX_Result          SetParameterNormalizedRelative ( AAX_CParamID iParameterID, double iValue ) = 0;
    
    
    
    virtual AAX_Result          TouchParameter ( AAX_CParamID iParameterID ) = 0;
    virtual AAX_Result          ReleaseParameter ( AAX_CParamID iParameterID ) = 0;
    virtual AAX_Result          UpdateParameterTouch ( AAX_CParamID iParameterID, AAX_CBoolean iTouchState ) = 0;
    
    
    virtual AAX_Result          UpdateParameterNormalizedValue ( AAX_CParamID iParameterID, double iValue, AAX_EUpdateSource iSource ) = 0; 
    virtual AAX_Result          UpdateParameterNormalizedRelative ( AAX_CParamID iParameterID, double iValue ) = 0;
    virtual AAX_Result          GenerateCoefficients() = 0; 
 
 
    virtual AAX_Result          ResetFieldData (AAX_CFieldIndex inFieldIndex, void * oData, uint32_t inDataSize) const = 0;
 
    
    virtual AAX_Result          GetNumberOfChunks ( int32_t * oNumChunks )   const = 0;
    virtual AAX_Result          GetChunkIDFromIndex ( int32_t iIndex, AAX_CTypeID * oChunkID )   const = 0;
    virtual AAX_Result          GetChunkSize ( AAX_CTypeID iChunkID, uint32_t * oSize )   const = 0;
    virtual AAX_Result          GetChunk ( AAX_CTypeID iChunkID, AAX_SPlugInChunk * oChunk )   const = 0;
    virtual AAX_Result          SetChunk ( AAX_CTypeID iChunkID, const AAX_SPlugInChunk * iChunk ) = 0;
    virtual AAX_Result          CompareActiveChunk ( const AAX_SPlugInChunk * iChunkP, AAX_CBoolean * oIsEqual )   const = 0;
    virtual AAX_Result          GetNumberOfChanges ( int32_t * oNumChanges )   const = 0;
    
    virtual AAX_Result          TimerWakeup( ) = 0;
    
    virtual AAX_Result          GetCurveData( /* AAX_ECurveType */ AAX_CTypeID iCurveType, const float * iValues, uint32_t iNumValues, float * oValues ) const = 0;
    
    virtual AAX_Result          GetCustomData( AAX_CTypeID iDataBlockID, uint32_t inDataSize, void* oData, uint32_t* oDataWritten) const = 0;
    
    virtual AAX_Result          SetCustomData( AAX_CTypeID iDataBlockID, uint32_t inDataSize, const void* iData ) = 0;
 
    virtual AAX_Result          DoMIDITransfers() = 0;
};
 
struct AAX_SHybridRenderInfo
{
    float**                     mAudioInputs;
    int32_t*                    mNumAudioInputs;
    float**                     mAudioOutputs;
    int32_t*                    mNumAudioOutputs;
    int32_t*                    mNumSamples;
    AAX_CTimestamp*             mClock;                 
};
 
class AAX_IACFEffectParameters_V2 : public AAX_IACFEffectParameters
{
public:
    
    virtual AAX_Result          RenderAudio_Hybrid(AAX_SHybridRenderInfo* ioRenderInfo) = 0;
    
    virtual AAX_Result          UpdateMIDINodes ( AAX_CFieldIndex inFieldIndex, AAX_CMidiPacket& iPacket ) = 0;
 
    virtual AAX_Result          UpdateControlMIDINodes ( AAX_CTypeID nodeID, AAX_CMidiPacket& iPacket ) = 0;
};
 
class AAX_IACFEffectParameters_V3 : public AAX_IACFEffectParameters_V2
{
public:
    
    virtual AAX_Result          GetCurveDataMeterIds( /* AAX_ECurveType */ AAX_CTypeID iCurveType, uint32_t *oXMeterId, uint32_t *oYMeterId)  const = 0;
 
    virtual AAX_Result          GetCurveDataDisplayRange( /* AAX_ECurveType */ AAX_CTypeID iCurveType, float *oXMin, float *oXMax, float *oYMin, float *oYMax ) const = 0;
};
 
class AAX_IACFEffectParameters_V4 : public AAX_IACFEffectParameters_V3
{
public:
    
    virtual AAX_Result UpdatePageTable(uint32_t inTableType, int32_t inTablePageSize, IACFUnknown* iHostUnknown, IACFUnknown* ioPageTableUnknown) const = 0;
};
 
#ifdef __clang__
#pragma clang diagnostic pop
#endif
 
#endif // AAX_IACFEFFECTPARAMETERS_H