AAX_IDma.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2014-2015, 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.
 *
 */
 
/*================================================================================================*/
 
 
#pragma once
 
#ifndef AAX_IDMA_H
#define AAX_IDMA_H
 
#include "AAX.h"
 
 
#ifndef AAX_DMA_API
#   ifdef _MSC_VER
#       define AAX_DMA_API      __cdecl
#   else
#       define AAX_DMA_API
#   endif
#endif // AAX_DMA_API
 
class AAX_IDma 
{
public:
    enum EState
    {
        eState_Error = -1,
        eState_Init = 0,
        eState_Running = 1,
        eState_Complete = 2,
        eState_Pending = 3
    };
 
    // WARNING! These need to be kept in sync with the TI dMAX microcode EventType IDs!
    enum EMode
    {
        eMode_Error = -1,
        
        eMode_Burst = 6,        
        eMode_Gather = 10,      
        eMode_Scatter = 11,     
        
    }; 
    
 
public:
    virtual ~AAX_IDma() {}
 
 
    virtual AAX_Result  AAX_DMA_API     PostRequest() = 0;
    virtual int32_t     AAX_DMA_API     IsTransferComplete() = 0;
    virtual AAX_Result  AAX_DMA_API     SetDmaState( EState iState ) = 0;
    virtual EState      AAX_DMA_API     GetDmaState() const = 0;
    virtual EMode       AAX_DMA_API     GetDmaMode() const = 0;
            
    
 
    virtual AAX_Result      AAX_DMA_API     SetSrc( int8_t * iSrc ) = 0;
    virtual int8_t *        AAX_DMA_API     GetSrc() = 0;
    virtual AAX_Result      AAX_DMA_API     SetDst( int8_t * iDst ) = 0;
    virtual int8_t *        AAX_DMA_API     GetDst() = 0;
    
    virtual AAX_Result      AAX_DMA_API     SetBurstLength( int32_t iBurstLengthBytes ) = 0;
    virtual int32_t         AAX_DMA_API     GetBurstLength() = 0;
    virtual AAX_Result      AAX_DMA_API     SetNumBursts( int32_t iNumBursts ) = 0;
    virtual int32_t         AAX_DMA_API     GetNumBursts() = 0;
    virtual AAX_Result      AAX_DMA_API     SetTransferSize( int32_t iTransferSizeBytes ) = 0;
    virtual int32_t         AAX_DMA_API     GetTransferSize() = 0;
 
 
 
    virtual AAX_Result      AAX_DMA_API     SetFifoBuffer( int8_t * iFifoBase ) = 0;
    virtual int8_t *        AAX_DMA_API     GetFifoBuffer() = 0;
    virtual AAX_Result      AAX_DMA_API     SetLinearBuffer( int8_t * iLinearBase ) = 0;
    virtual int8_t *        AAX_DMA_API     GetLinearBuffer() = 0;
    virtual AAX_Result      AAX_DMA_API     SetOffsetTable( const int32_t * iOffsetTable ) = 0;
    virtual const int32_t * AAX_DMA_API     GetOffsetTable() = 0;
    virtual AAX_Result      AAX_DMA_API     SetNumOffsets( int32_t iNumOffsets ) = 0;
    virtual int32_t         AAX_DMA_API     GetNumOffsets() = 0;
    virtual AAX_Result      AAX_DMA_API     SetBaseOffset( int32_t iBaseOffsetBytes ) = 0;
    virtual int32_t         AAX_DMA_API     GetBaseOffset() = 0;
    virtual AAX_Result      AAX_DMA_API     SetFifoSize( int32_t iSizeBytes ) = 0;
    virtual int32_t         AAX_DMA_API     GetFifoSize() = 0;
};
 
 
 
#endif // AAX_IDMA_H