AAX.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.
 *
 */

/*================================================================================================*/


#pragma once

#ifndef _AAX_H_
#define _AAX_H_

#include <stdint.h>
#include <stddef.h>

#include "AAX_Version.h"
#include "AAX_Enums.h"
#include "AAX_Errors.h"
#include "AAX_Properties.h"



#if ( defined(_WIN64) || defined(__LP64__) )  
    #define AAX_ALIGN_FILE_HOST     "AAX_Push8ByteStructAlignment.h"
#else
    #define AAX_ALIGN_FILE_HOST     "AAX_Push2ByteStructAlignment.h"
#endif
#define AAX_ALIGN_FILE_ALG      "AAX_Push8ByteStructAlignment.h"
#define AAX_ALIGN_FILE_RESET    "AAX_PopStructAlignment.h"


#ifndef AAX_CALLBACK
#   ifdef _MSC_VER
#       define AAX_CALLBACK     __cdecl
#   else
#       define AAX_CALLBACK
#   endif
#endif // AAX_CALLBACK


#ifdef _MSC_VER
#   define AAX_RESTRICT
#elif defined(_TMS320C6X) // TI
#   define AAX_RESTRICT restrict
#elif defined (__GNUC__)// Mac
#   define AAX_RESTRICT __restrict__
#endif // _MSC_VER

#ifdef _MSC_VER
// Disable unknown pragma warning for TI pragmas under VC++
#pragma warning( disable : 4068 )
#endif

#define AAX_FIELD_INDEX( aContextType, aMember ) \
    ((AAX_CFieldIndex) (offsetof (aContextType, aMember) / sizeof (void *)))


typedef int32_t     AAX_CIndex;        
typedef AAX_CIndex  AAX_CCount;        
typedef uint8_t     AAX_CBoolean;      
typedef uint32_t    AAX_CSelector;     
typedef int64_t     AAX_CTimestamp;    
typedef int64_t     AAX_CTimeOfDay;    
typedef int64_t     AAX_CTransportCounter;  
typedef float       AAX_CSampleRate;   

typedef uint32_t    AAX_CTypeID;  
typedef int32_t     AAX_Result;
typedef int32_t     AAX_CPropertyValue;


static const AAX_CTimestamp     kAAX_Never = (AAX_CTimestamp) ~0ULL;


typedef AAX_CIndex      AAX_CFieldIndex;    
typedef AAX_CSelector   AAX_CComponentID;   
typedef AAX_CSelector   AAX_CMeterID;       
typedef const char *    AAX_CParamID;       
typedef const char *    AAX_CEffectID;      


#ifdef _TMS320C6X
    // TI's C compiler defaults to 8 byte alignment of doubles
    #define AAX_ALIGNED(v)
#elif defined(__GNUC__)
    #define AAX_ALIGNED(v) __attribute__((aligned(v)))
#elif defined(_MSC_VER)
    #define AAX_ALIGNED(v) __declspec(align(v))
#else
    #error Teach me to align data types with this compiler.
#endif

typedef AAX_ALIGNED(8) double AAX_AlignedDouble;


static
inline
int32_t
AAX_GetStemFormatChannelCount (
                               AAX_EStemFormat      inStemFormat)
{
    return AAX_STEM_FORMAT_CHANNEL_COUNT (inStemFormat);
}


typedef const float * const *       AAX_CAudioInPort;


typedef float * const *     AAX_CAudioOutPort;


typedef  float * const      AAX_CMeterPort;


inline AAX_CBoolean sampleRateInMask(AAX_CSampleRate inSR, uint32_t iMask)
{
    return  static_cast<AAX_CBoolean>(
        (44100.0 == inSR) ? ((iMask & AAX_eSampleRateMask_44100) != 0) :
        (48000.0 == inSR) ?  ((iMask & AAX_eSampleRateMask_48000)  != 0) :
        (88200.0 == inSR) ?  ((iMask & AAX_eSampleRateMask_88200)  != 0) :
        (96000.0 == inSR) ?  ((iMask & AAX_eSampleRateMask_96000)  != 0) :
        (176400.0 == inSR) ? ((iMask & AAX_eSampleRateMask_176400) != 0) :
        (192000.0 == inSR) ? ((iMask & AAX_eSampleRateMask_192000) != 0) : false
    );
}


#ifndef _TMS320C6X
#include AAX_ALIGN_FILE_HOST

struct AAX_SPlugInChunk {
    int32_t             fSize;              
    int32_t             fVersion;           
    AAX_CTypeID         fManufacturerID;    
    AAX_CTypeID         fProductID;         
    AAX_CTypeID         fPlugInID;          
    AAX_CTypeID         fChunkID;           
    unsigned char       fName[32];          
    char                fData[1];           
};
typedef struct AAX_SPlugInChunk AAX_SPlugInChunk, *AAX_SPlugInChunkPtr;

struct AAX_SPlugInIdentifierTriad {
    AAX_CTypeID         mManufacturerID;    
    AAX_CTypeID         mProductID;         
    AAX_CTypeID         mPlugInID;          
};
typedef struct AAX_SPlugInIdentifierTriad AAX_SPlugInIdentifierTriad, *AAX_SPlugInIdentifierTriadPtr;
#include AAX_ALIGN_FILE_RESET
#endif


//<DMT> For historical compatibility with PT10, we have to make the MIDI structures DEFAULT aligned instead of ALG aligned.  With PT11 and 64 bit, these will now be ALG aligned.
#if ( defined(_WIN64) || defined(__LP64__) || defined(_TMS320C6X) )
    #include AAX_ALIGN_FILE_ALG
#else
    #if defined (__GNUC__)
        #pragma options align=power // To maintain backwards-compatibility with pre-10 versions of Pro Tools
    #else // Windows, other
        #include AAX_ALIGN_FILE_HOST
    #endif
#endif

struct AAX_CMidiPacket 
{
    uint32_t            mTimestamp;     
    uint32_t            mLength;        
    unsigned char       mData[4];       
    AAX_CBoolean        mIsImmediate;   
};

struct AAX_CMidiStream
{
    uint32_t            mBufferSize;        
    AAX_CMidiPacket*        mBuffer;        
};  

#if ( defined(_WIN64) || defined(__LP64__) || defined(_TMS320C6X) )
    #include AAX_ALIGN_FILE_RESET
#else
    #if defined (__GNUC__)
        #pragma pack()  // To maintian backwards-compatibility with pre-10 versions of Pro Tools
    #else
        #include AAX_ALIGN_FILE_RESET
    #endif
#endif

#endif // #ifndef _AAX_H_