AAX_VController.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_VCONTROLLER_H
#define AAX_VCONTROLLER_H
 
#include "AAX_IController.h"
#include "AAX_IACFController.h"
 
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wself-assign"
#pragma clang diagnostic ignored "-Wnon-virtual-dtor"
#endif
 
#include "ACFPtr.h"
 
#ifdef __clang__
#pragma clang diagnostic pop
#endif
 
class IACFUnknown;
class IACFComponentFactory;
class AAX_IACFPageTableController;
class AAX_IACFPageTableController_V2;
class AAX_IACFPageTable_V2;
 
class AAX_VController : public AAX_IController
{
public:
    AAX_VController( IACFUnknown* pUnknown );
    ~AAX_VController() override;
    
    //Host Information Getters
    AAX_Result  GetEffectID ( AAX_IString * outEffectID) const AAX_OVERRIDE; 
    AAX_Result  GetSampleRate ( AAX_CSampleRate * outSampleRate ) const AAX_OVERRIDE; 
    AAX_Result  GetInputStemFormat ( AAX_EStemFormat * outStemFormat ) const AAX_OVERRIDE; 
    AAX_Result  GetOutputStemFormat ( AAX_EStemFormat * outStemFormat ) const AAX_OVERRIDE; 
    AAX_Result  GetSignalLatency( int32_t* outSamples) const AAX_OVERRIDE; 
    AAX_Result  GetHybridSignalLatency(int32_t* outSamples) const AAX_OVERRIDE; 
    AAX_Result  GetPlugInTargetPlatform(AAX_CTargetPlatform* outTargetPlatform) const AAX_OVERRIDE; 
    AAX_Result  GetIsAudioSuite(AAX_CBoolean* outIsAudioSuite) const AAX_OVERRIDE; 
    AAX_Result  GetCycleCount( AAX_EProperty inWhichCycleCount, AAX_CPropertyValue* outNumCycles) const AAX_OVERRIDE; 
    AAX_Result  GetTODLocation ( AAX_CTimeOfDay* outTODLocation ) const AAX_OVERRIDE; 
    AAX_Result  GetCurrentAutomationTimestamp(AAX_CTransportCounter* outTimestamp) const AAX_OVERRIDE; 
    AAX_Result  GetHostName(AAX_IString* outHostNameString) const AAX_OVERRIDE; 
 
    //Host Information Setters (Dynamic info)
    AAX_Result  SetSignalLatency(int32_t inNumSamples) AAX_OVERRIDE; 
    AAX_Result  SetCycleCount( AAX_EProperty* inWhichCycleCounts, AAX_CPropertyValue* iValues, int32_t numValues) AAX_OVERRIDE; 
    
    //Posting functions.
    AAX_Result  PostPacket ( AAX_CFieldIndex inFieldIndex, const void * inPayloadP, uint32_t inPayloadSize ) AAX_OVERRIDE; 
    
    // Notification functions
    AAX_Result  SendNotification ( AAX_CTypeID inNotificationType, const void* inNotificationData, uint32_t inNotificationDataSize ) AAX_OVERRIDE; 
    AAX_Result  SendNotification ( AAX_CTypeID inNotificationType) AAX_OVERRIDE; 
    
    //Metering functions
    AAX_Result  GetCurrentMeterValue ( AAX_CTypeID inMeterID, float * outMeterValue ) const AAX_OVERRIDE; 
    AAX_Result  GetMeterPeakValue( AAX_CTypeID inMeterID, float * outMeterPeakValue ) const AAX_OVERRIDE; 
    AAX_Result  ClearMeterPeakValue ( AAX_CTypeID inMeterID ) const AAX_OVERRIDE; 
    AAX_Result  GetMeterClipped ( AAX_CTypeID inMeterID, AAX_CBoolean * outClipped ) const AAX_OVERRIDE; 
    AAX_Result  ClearMeterClipped ( AAX_CTypeID inMeterID ) const AAX_OVERRIDE; 
    AAX_Result  GetMeterCount ( uint32_t * outMeterCount ) const AAX_OVERRIDE; 
 
    //MIDI functions
    AAX_Result  GetNextMIDIPacket( AAX_CFieldIndex* outPort, AAX_CMidiPacket* outPacket ) AAX_OVERRIDE; 
 
    // PageTables functions
    AAX_IPageTable*
    CreateTableCopyForEffect(AAX_CPropertyValue inManufacturerID,
                             AAX_CPropertyValue inProductID,
                             AAX_CPropertyValue inPlugInID,
                             uint32_t inTableType,
                             int32_t inTablePageSize) const AAX_OVERRIDE;
    AAX_IPageTable*
    CreateTableCopyForLayout(const char * inEffectID,
                             const char * inLayoutName,
                             uint32_t inTableType,
                             int32_t inTablePageSize) const AAX_OVERRIDE;
    AAX_IPageTable*
    CreateTableCopyForEffectFromFile(const char* inPageTableFilePath,
                                     AAX_ETextEncoding inFilePathEncoding,
                                     AAX_CPropertyValue inManufacturerID,
                                     AAX_CPropertyValue inProductID,
                                     AAX_CPropertyValue inPlugInID,
                                     uint32_t inTableType,
                                     int32_t inTablePageSize) const AAX_OVERRIDE;
    AAX_IPageTable*
    CreateTableCopyForLayoutFromFile(const char* inPageTableFilePath,
                                    AAX_ETextEncoding inFilePathEncoding,
                                    const char* inLayoutName,
                                    uint32_t inTableType,
                                    int32_t inTablePageSize) const AAX_OVERRIDE;
 
private:
    ACFPtr<AAX_IACFPageTable_V2> CreatePageTable() const;
    
private:
    ACFPtr<AAX_IACFController>      mIController;
    ACFPtr<AAX_IACFController_V2>   mIControllerV2;
    ACFPtr<AAX_IACFController_V3>   mIControllerV3;
    
    // AAX_IACFPageTableController interface methods are aggregated into AAX_IController
    ACFPtr<AAX_IACFPageTableController>     mIPageTableController;
    ACFPtr<AAX_IACFPageTableController_V2>  mIPageTableControllerV2;
    
    ACFPtr<IACFComponentFactory>    mComponentFactory;
};
 
 
#endif // AAX_VCONTROLLER_H