AAX_CHostProcessor.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_CHOSTPROCESSOR_H
#define AAX_CHOSTPROCESSOR_H
 
#include "AAX_IEffectParameters.h"
#include "AAX_IHostProcessor.h"
#include "ACFPtr.h"
 
 
class AAX_IHostProcessorDelegate;
class AAX_IController;
class AAX_IEffectParameters;
class IACFUnknown;
 
class AAX_CHostProcessor : public AAX_IHostProcessor
{
public:
    /* default constructor */   AAX_CHostProcessor (void);
    virtual /* destructor */    ~AAX_CHostProcessor ();
    
    AAX_Result      Initialize(IACFUnknown* iController) AAX_OVERRIDE;
    AAX_Result      Uninitialize() AAX_OVERRIDE;
    
    AAX_Result      InitOutputBounds ( int64_t iSrcStart, int64_t iSrcEnd, int64_t * oDstStart, int64_t * oDstEnd ) AAX_OVERRIDE;
    
    AAX_Result      SetLocation ( int64_t iSample ) AAX_OVERRIDE;
 
    AAX_Result      RenderAudio ( const float * const inAudioIns [], int32_t inAudioInCount, float * const iAudioOuts [], int32_t iAudioOutCount, int32_t * ioWindowSize ) AAX_OVERRIDE;
    
    AAX_Result      PreRender ( int32_t inAudioInCount, int32_t iAudioOutCount, int32_t iWindowSize ) AAX_OVERRIDE;
    
    AAX_Result      PostRender () AAX_OVERRIDE;
 
    AAX_Result      AnalyzeAudio ( const float * const inAudioIns [], int32_t inAudioInCount, int32_t * ioWindowSize ) AAX_OVERRIDE;
    
    AAX_Result      PreAnalyze ( int32_t inAudioInCount, int32_t iWindowSize ) AAX_OVERRIDE;
    
    AAX_Result      PostAnalyze () AAX_OVERRIDE;
    AAX_Result      GetClipNameSuffix ( int32_t inMaxLength, AAX_IString* outString ) const AAX_OVERRIDE;
    
    
    AAX_IEffectParameters *             GetEffectParameters () { return mEffectParameters; }
    const AAX_IEffectParameters *       GetEffectParameters () const { return mEffectParameters; }
    AAX_IHostProcessorDelegate*         GetHostProcessorDelegate () { return mHostProcessingDelegate; }
    const AAX_IHostProcessorDelegate*   GetHostProcessorDelegate () const { return mHostProcessingDelegate; }
    
    int64_t                         GetLocation() const { return mLocation; }
    
    int64_t                         GetInputRange() const { return (mSrcEnd - mSrcStart); }
    int64_t                         GetOutputRange() const { return (mDstEnd - mDstStart); }
    int64_t                         GetSrcStart() const { return mSrcStart; }
    int64_t                         GetSrcEnd() const { return mSrcEnd; }
    int64_t                         GetDstStart() const { return mDstStart; }
    int64_t                         GetDstEnd() const { return mDstEnd; }
    
protected:
    virtual AAX_Result      TranslateOutputBounds ( int64_t iSrcStart, int64_t iSrcEnd, int64_t& oDstStart, int64_t& oDstEnd );
 
    virtual AAX_Result      GetAudio ( const float * const inAudioIns [], int32_t inAudioInCount, int64_t inLocation, int32_t * ioNumSamples );
 
    virtual int32_t         GetSideChainInputNum ();
    
    // Exterior Object Access
    AAX_IController*                    Controller()                    { return mController; }
    const AAX_IController*              Controller() const              { return mController; }
    AAX_IHostProcessorDelegate*         HostProcessorDelegate()         { return mHostProcessingDelegate; }
    const AAX_IHostProcessorDelegate*   HostProcessorDelegate() const   { return mHostProcessingDelegate; }
    AAX_IEffectParameters*              EffectParameters()              { return mEffectParameters; }
    const AAX_IEffectParameters*        EffectParameters() const        { return mEffectParameters; }
 
private:
    AAX_IController*                mController;
    AAX_IHostProcessorDelegate*     mHostProcessingDelegate;
    AAX_IEffectParameters*          mEffectParameters;
    int64_t                         mSrcStart;
    int64_t                         mSrcEnd;
    int64_t                         mDstStart;
    int64_t                         mDstEnd;    
    int64_t                         mLocation; 
    
};
 
 
#endif