![]() |
AAX SDK
2.4.1
Avid Audio Extensions Development Kit
|
Go to the source code of this file.
Declarations for cross-platform AAX_ASSERT, AAX_TRACE and related facilities.
false
triggers some manner of warning, e.g. a dialog in a developer build or a DigiTrace log in a shipping build. May be used on host or TI.DTF_AAXPLUGINS
DigiTrace facility.iStackTracePriority
. Otherwise, if logging is enabled at iTracePriority
then emits a log.For all trace macros:
inPriority
is one of
These correspond to how the trace messages are filtered using DigiTrace.
DTF_AAXPLUGINS
facility will slightly reduce the overhead of trace statements and chip communication on HDX systems.==============================================================================
Macros | |
#define | kAAX_Trace_Priority_None AAX_eTracePriorityHost_None |
#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 |
#define | AAX_TRACE_RELEASE(iPriority, ...) |
Print a trace statement to the log. More... | |
#define | AAX_STACKTRACE_RELEASE(iPriority, ...) |
Print a stack trace statement to the log. More... | |
#define | AAX_TRACEORSTACKTRACE_RELEASE(iTracePriority, iStackTracePriority, ...) |
Print a trace statement with an optional stack trace to the log. More... | |
#define | AAX_ASSERT(condition) |
Asserts that a condition is true and logs an error if the condition is false. More... | |
#define | AAX_DEBUGASSERT(condition) do { ; } while (0) |
Asserts that a condition is true and logs an error if the condition is false (debug plug-in builds only) More... | |
#define | AAX_TRACE(iPriority, ...) do { ; } while (0) |
Print a trace statement to the log (debug plug-in builds only) More... | |
#define | AAX_STACKTRACE(iPriority, ...) do { ; } while (0) |
Print a stack trace statement to the log (debug builds only) More... | |
#define | AAX_TRACEORSTACKTRACE(iTracePriority, iStackTracePriority, ...) do { ; } while (0) |
Print a trace statement with an optional stack trace to the log (debug builds only) More... | |
Typedefs | |
typedef AAX_ETracePriorityHost | AAX_ETracePriority |
#define kAAX_Trace_Priority_None AAX_eTracePriorityHost_None |
#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 |
#define AAX_TRACE_RELEASE | ( | iPriority, | |
... | |||
) |
Print a trace statement to the log.
Use this macro to print a trace statement to the log file. This macro will be included in all builds of the plug-in.
Notes
Usage Each invocation of this macro takes a trace priority and a printf
-style logging string.
Because output from this macro will be enabled on end users' systems under certain tracing configurations, logs should always be formatted with some standard information to avoid confusion between logs from different plug-ins. This is the recommended formatting for AAX_TRACE_RELEASE logs:
[Manufacturer name] [Plug-in name] [Plug-in version][logging text (indented)]
For example:
#define AAX_STACKTRACE_RELEASE | ( | iPriority, | |
... | |||
) |
Print a stack trace statement to the log.
#define AAX_TRACEORSTACKTRACE_RELEASE | ( | iTracePriority, | |
iStackTracePriority, | |||
... | |||
) |
Print a trace statement with an optional stack trace to the log.
[in] | iTracePriority | The log priority at which the trace statement will be printed |
[in] | iStackTracePriority | The log priority at which the stack trace will be printed |
#define AAX_ASSERT | ( | condition | ) |
Asserts that a condition is true and logs an error if the condition is false.
Notes
Usage Each invocation of this macro takes a single argument, which is interpreted as a bool
.
#define AAX_DEBUGASSERT | ( | condition | ) | do { ; } while (0) |
Asserts that a condition is true and logs an error if the condition is false (debug plug-in builds only)
#define AAX_TRACE | ( | iPriority, | |
... | |||
) | do { ; } while (0) |
Print a trace statement to the log (debug plug-in builds only)
Use this macro to print a trace statement to the log file from debug builds of a plug-in.
Notes
Usage Each invocation of this macro takes a trace priority and a printf
-style logging string. For example:
#define AAX_STACKTRACE | ( | iPriority, | |
... | |||
) | do { ; } while (0) |
Print a stack trace statement to the log (debug builds only)
#define AAX_TRACEORSTACKTRACE | ( | iTracePriority, | |
iStackTracePriority, | |||
... | |||
) | do { ; } while (0) |
Print a trace statement with an optional stack trace to the log (debug builds only)
[in] | iTracePriority | The log priority at which the trace statement will be printed |
[in] | iStackTracePriority | The log priority at which the stack trace will be printed |