AAX_CEffectParameters.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_CEFFECTPARAMETERS_H
#define AAX_CEFFECTPARAMETERS_H

#include "AAX_IEffectParameters.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);
    virtual ~AAX_CEffectParameters (void);
    AAX_CEffectParameters& operator= (const AAX_CEffectParameters& other);
    
public: 

    virtual AAX_Result Initialize(IACFUnknown* iController);
    virtual AAX_Result Uninitialize (void);
    
    virtual AAX_Result NotificationReceived( /* AAX_ENotificationEvent */ AAX_CTypeID iNotificationType, const void * iNotificationData, uint32_t   iNotificationDataSize);
    
    virtual AAX_Result GetNumberOfParameters (int32_t * oNumControls)  const ;
    virtual AAX_Result GetMasterBypassParameter (AAX_IString * oIDString)  const ;
    virtual AAX_Result GetParameterIsAutomatable (AAX_CParamID iParameterID, AAX_CBoolean * oAutomatable)  const ;
    virtual AAX_Result GetParameterNumberOfSteps (AAX_CParamID iParameterID, int32_t * oNumSteps )  const ;
    virtual AAX_Result GetParameterName (AAX_CParamID iParameterID, AAX_IString * oName )  const ;
    virtual AAX_Result GetParameterNameOfLength (AAX_CParamID iParameterID, AAX_IString * oName, int32_t iNameLength )  const ;
    virtual AAX_Result GetParameterDefaultNormalizedValue (AAX_CParamID iParameterID, double * oValue )  const ;
    virtual AAX_Result SetParameterDefaultNormalizedValue (AAX_CParamID iParameterID, double iValue );
    virtual AAX_Result GetParameterType (AAX_CParamID iParameterID, AAX_EParameterType * oParameterType )  const ;
    virtual AAX_Result GetParameterOrientation (AAX_CParamID iParameterID, AAX_EParameterOrientation * oParameterOrientation )  const ;
    virtual AAX_Result GetParameter (AAX_CParamID iParameterID, AAX_IParameter ** oParameter ) ;
    virtual AAX_Result GetParameterIndex (AAX_CParamID iParameterID, int32_t * oControlIndex )  const ;
    virtual AAX_Result GetParameterIDFromIndex (int32_t iControlIndex, AAX_IString * oParameterIDString )  const ;
    virtual AAX_Result GetParameterValueInfo ( AAX_CParamID iParameterID, int32_t iSelector, int32_t* oValue) const;
    
    virtual AAX_Result GetParameterValueFromString (AAX_CParamID iParameterID, double * oValue, const AAX_IString & iValueString )  const ;
    virtual AAX_Result GetParameterStringFromValue (AAX_CParamID iParameterID, double iValue, AAX_IString * oValueString, int32_t iMaxLength )  const ;
    virtual AAX_Result GetParameterValueString (AAX_CParamID iParameterID, AAX_IString * oValueString, int32_t iMaxLength)  const ;
    virtual AAX_Result GetParameterNormalizedValue (AAX_CParamID iParameterID, double * oValuePtr )  const ;
    virtual AAX_Result SetParameterNormalizedValue (AAX_CParamID iParameterID, double iValue ); 
    virtual AAX_Result SetParameterNormalizedRelative (AAX_CParamID iParameterID, double iValue );
    
    virtual AAX_Result TouchParameter ( AAX_CParamID iParameterID );
    virtual AAX_Result ReleaseParameter ( AAX_CParamID iParameterID );
    virtual AAX_Result UpdateParameterTouch ( AAX_CParamID iParameterID, AAX_CBoolean iTouchState );
        
    virtual AAX_Result UpdateParameterNormalizedValue (AAX_CParamID iParameterID, double iValue, AAX_EUpdateSource iSource );
    virtual AAX_Result UpdateParameterNormalizedRelative (AAX_CParamID iParameterID, double iValue );
    virtual AAX_Result GenerateCoefficients(void);

    virtual AAX_Result ResetFieldData (AAX_CFieldIndex iFieldIndex, void * oData, uint32_t iDataSize) const;

    virtual AAX_Result GetNumberOfChunks (int32_t * oNumChunks )  const ;
    virtual AAX_Result GetChunkIDFromIndex (int32_t iIndex, AAX_CTypeID * oChunkID )  const ;
    virtual AAX_Result GetChunkSize (AAX_CTypeID iChunkID, uint32_t * oSize )  const ;
    virtual AAX_Result GetChunk (AAX_CTypeID iChunkID, AAX_SPlugInChunk * oChunk ) const;   
    virtual AAX_Result SetChunk (AAX_CTypeID iChunkID, const AAX_SPlugInChunk * iChunk );
    virtual AAX_Result CompareActiveChunk (const AAX_SPlugInChunk * iChunkP, AAX_CBoolean * oIsEqual )  const ;
    virtual AAX_Result GetNumberOfChanges (int32_t * oNumChanges )  const ;
    
    virtual AAX_Result TimerWakeup(); 
    
    virtual AAX_Result GetCurveData( /* AAX_ECurveType */ AAX_CTypeID iCurveType, const float * iValues, uint32_t iNumValues, float * oValues ) const;
    
    virtual AAX_Result          GetCustomData( AAX_CTypeID iDataBlockID, uint32_t iDataSize, void* oData, uint32_t* oDataWritten) const;
    virtual AAX_Result          SetCustomData( AAX_CTypeID iDataBlockID, uint32_t iDataSize, const void* iData );
    
    virtual AAX_Result          DoMIDITransfers() { return AAX_SUCCESS; };
    virtual AAX_Result          UpdateMIDINodes ( AAX_CFieldIndex iFieldIndex, AAX_CMidiPacket& iPacket );
    virtual AAX_Result          UpdateControlMIDINodes ( AAX_CTypeID nodeID, AAX_CMidiPacket& iPacket );

    virtual AAX_Result          RenderAudio_Hybrid(AAX_SHybridRenderInfo* ioRenderInfo);



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; };   

    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_CBoolean                    mClipped;               
    AAX_CPacketDispatcher           mPacketDispatcher;  
    AAX_CParameterManager           mParameterManager;  
    std::set<std::string>           mFilteredParameters;    

private:  //There are accessor functions in this class for these Host objects.  Use them instead.
    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