AAX_Assert.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013-2015, 2018, 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_ASSERT_H
#define AAX_ASSERT_H
 
#include "AAX_Enums.h"
 
 
#ifdef  _TMS320C6X  // TI-only
 
    #ifndef TI_SHELL_TRACING_H
    #include "TI_Shell_Tracing.h"
    #endif
 
    typedef AAX_ETracePriorityDSP EAAX_Trace_Priority;
 
    #define kAAX_Trace_Priority_None        AAX_eTracePriorityDSP_None
    #define kAAX_Trace_Priority_Critical    AAX_eTracePriorityDSP_High
    #define kAAX_Trace_Priority_High        AAX_eTracePriorityDSP_High
    #define kAAX_Trace_Priority_Normal      AAX_eTracePriorityDSP_Normal
    #define kAAX_Trace_Priority_Low         AAX_eTracePriorityDSP_Low
    #define kAAX_Trace_Priority_Lowest      AAX_eTracePriorityDSP_Low
 
    //Note that the Message provided to AAX_TRACE must be a cons string available for indefinite time
    // because sending it to the host is done asynchronously.
    #define AAX_TRACE_RELEASE( ... ) TISHELLTRACE( __VA_ARGS__ )
 
    //Stack traces not supported on TI - just log
    #define AAX_STACKTRACE_RELEASE( ... ) TISHELLTRACE( __VA_ARGS__ )
    #define AAX_TRACEORSTACKTRACE_RELEASE( iTracePriority, iStackTracePriority, ... ) TISHELLTRACE( iTracePriority, __VA_ARGS__ )
 
    #define _STRINGIFY(x) #x
    #define _TOSTRING(x) _STRINGIFY(x)
 
    #define AAX_ASSERT( condition ) \
        { \
            if( ! (condition) ) _DoTrace( AAX_eTracePriorityDSP_Assert, \
            CAT(CAT( CAT(__FILE__, ":"), _TOSTRING(__LINE__) ) , CAT(" failed: ", #condition) ) );\
        }
 
    #if defined(_DEBUG)
        #define AAX_DEBUGASSERT( condition ) AAX_ASSERT( condition )
        #define AAX_TRACE( ... ) AAX_TRACE_RELEASE( __VA_ARGS__ )
        #define AAX_STACKTRACE( ... ) AAX_STACKTRACE_RELEASE( __VA_ARGS__ )
        #define AAX_TRACEORSTACKTRACE( iTracePriority, iStackTracePriority, ... ) AAX_TRACEORSTACKTRACE_RELEASE( iTracePriority, iStackTracePriority, __VA_ARGS__ )
 
    #else
        #define AAX_DEBUGASSERT( condition ) do { ; } while (0)
        #define AAX_TRACE( ... ) do { ; } while (0)
        #define AAX_STACKTRACE( ... ) do { ; } while (0)
        #define AAX_TRACEORSTACKTRACE( ... ) do { ; } while (0)
    #endif
 
#else // Host:
 
    #ifndef AAX_CHOSTSERVICES_H
    #include "AAX_CHostServices.h"
    #endif
 
    typedef AAX_ETracePriorityHost AAX_ETracePriority;
 
    #define kAAX_Trace_Priority_None        AAX_eTracePriorityHost_None
    #define kAAX_Trace_Priority_Critical    AAX_eTracePriorityHost_Critical
    #define kAAX_Trace_Priority_High        AAX_eTracePriorityHost_High
    #define kAAX_Trace_Priority_Normal      AAX_eTracePriorityHost_Normal
    #define kAAX_Trace_Priority_Low         AAX_eTracePriorityHost_Low
    #define kAAX_Trace_Priority_Lowest      AAX_eTracePriorityHost_Lowest
 
    //Note that the Message provided to AAX_TRACE must be a const string available for indefinite time
    // because sending it to the host is done asynchronously on TI
    #define AAX_TRACE_RELEASE( iPriority, ... ) \
        { \
            AAX_CHostServices::Trace ( iPriority, __VA_ARGS__ ); \
        };
 
    #define AAX_STACKTRACE_RELEASE( iPriority, ... ) \
        { \
            AAX_CHostServices::StackTrace ( iPriority, iPriority, __VA_ARGS__ ); \
        };
 
    #define AAX_TRACEORSTACKTRACE_RELEASE( iTracePriority, iStackTracePriority, ... ) \
        { \
            AAX_CHostServices::StackTrace ( iTracePriority, iStackTracePriority, __VA_ARGS__ ); \
        };
 
    #if defined(_DEBUG)
 
        #define AAX_ASSERT( condition ) \
            { \
                if( ! ( condition ) ) { \
                    AAX_CHostServices::HandleAssertFailure( __FILE__, __LINE__, #condition, (int32_t)AAX_eAssertFlags_Log | (int32_t)AAX_eAssertFlags_Dialog ); \
                } \
            };
 
        #define AAX_DEBUGASSERT( condition ) \
            { \
                if( ! ( condition ) ) { \
                    AAX_CHostServices::HandleAssertFailure( __FILE__, __LINE__, #condition, (int32_t)AAX_eAssertFlags_Log | (int32_t)AAX_eAssertFlags_Dialog ); \
                } \
            };
        
        #define AAX_TRACE( iPriority, ... ) AAX_TRACE_RELEASE( iPriority, __VA_ARGS__ )
        #define AAX_STACKTRACE( iPriority, ... ) AAX_STACKTRACE_RELEASE( iPriority, __VA_ARGS__ )
        #define AAX_TRACEORSTACKTRACE( iTracePriority, iStackTracePriority, ... ) AAX_TRACEORSTACKTRACE_RELEASE( iTracePriority, iStackTracePriority, __VA_ARGS__ )
 
    #else
        #define AAX_ASSERT( condition ) \
            { \
                if( ! ( condition ) ) { \
                    AAX_CHostServices::HandleAssertFailure( __FILE__, __LINE__, #condition, (int32_t)AAX_eAssertFlags_Log ); \
                } \
            };
 
        #define AAX_DEBUGASSERT( condition ) do { ; } while (0)
        #define AAX_TRACE( iPriority, ... ) do { ; } while (0)
        #define AAX_STACKTRACE( iPriority, ... ) do { ; } while (0)
        #define AAX_TRACEORSTACKTRACE( iTracePriority, iStackTracePriority, ... ) do { ; } while (0)
    #endif
 
#endif
 
 
#endif // include guard
// end of AAX_Assert.h