/[pcsx2_0.9.7]/trunk/3rdparty/portaudio/src/common/pa_trace.h
ViewVC logotype

Contents of /trunk/3rdparty/portaudio/src/common/pa_trace.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 273 - (show annotations) (download)
Fri Nov 12 01:10:22 2010 UTC (9 years, 2 months ago) by william
File MIME type: text/plain
File size: 3534 byte(s)
Auto Commited Import of: pcsx2-0.9.7-DEBUG (upstream: v0.9.7.4013 local: v0.9.7.197-latest) in ./trunk
1 #ifndef PA_TRACE_H
2 #define PA_TRACE_H
3 /*
4 * $Id: pa_trace.h 1339 2008-02-15 07:50:33Z rossb $
5 * Portable Audio I/O Library Trace Facility
6 * Store trace information in real-time for later printing.
7 *
8 * Based on the Open Source API proposed by Ross Bencina
9 * Copyright (c) 1999-2000 Phil Burk
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining
12 * a copy of this software and associated documentation files
13 * (the "Software"), to deal in the Software without restriction,
14 * including without limitation the rights to use, copy, modify, merge,
15 * publish, distribute, sublicense, and/or sell copies of the Software,
16 * and to permit persons to whom the Software is furnished to do so,
17 * subject to the following conditions:
18 *
19 * The above copyright notice and this permission notice shall be
20 * included in all copies or substantial portions of the Software.
21 *
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
25 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
26 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
27 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 */
30
31 /*
32 * The text above constitutes the entire PortAudio license; however,
33 * the PortAudio community also makes the following non-binding requests:
34 *
35 * Any person wishing to distribute modifications to the Software is
36 * requested to send the modifications to the original developer so that
37 * they can be incorporated into the canonical version. It is also
38 * requested that these non-binding requests be included along with the
39 * license above.
40 */
41
42 /** @file
43 @ingroup common_src
44
45 @brief Real-time safe event trace logging facility for debugging.
46
47 Allows data to be logged to a fixed size trace buffer in a real-time
48 execution context (such as at interrupt time). Each log entry consists
49 of a message comprising a string pointer and an int. The trace buffer
50 may be dumped to stdout later.
51
52 This facility is only active if PA_TRACE_REALTIME_EVENTS is set to 1,
53 otherwise the trace functions expand to no-ops.
54
55 @fn PaUtil_ResetTraceMessages
56 @brief Clear the trace buffer.
57
58 @fn PaUtil_AddTraceMessage
59 @brief Add a message to the trace buffer. A message consists of string and an int.
60 @param msg The string pointer must remain valid until PaUtil_DumpTraceMessages
61 is called. As a result, usually only string literals should be passed as
62 the msg parameter.
63
64 @fn PaUtil_DumpTraceMessages
65 @brief Print all messages in the trace buffer to stdout and clear the trace buffer.
66 */
67
68 #ifndef PA_TRACE_REALTIME_EVENTS
69 #define PA_TRACE_REALTIME_EVENTS (0) /**< Set to 1 to enable logging using the trace functions defined below */
70 #endif
71
72 #ifndef PA_MAX_TRACE_RECORDS
73 #define PA_MAX_TRACE_RECORDS (2048) /**< Maximum number of records stored in trace buffer */
74 #endif
75
76 #ifdef __cplusplus
77 extern "C"
78 {
79 #endif /* __cplusplus */
80
81
82 #if PA_TRACE_REALTIME_EVENTS
83
84 void PaUtil_ResetTraceMessages();
85 void PaUtil_AddTraceMessage( const char *msg, int data );
86 void PaUtil_DumpTraceMessages();
87
88 #else
89
90 #define PaUtil_ResetTraceMessages() /* noop */
91 #define PaUtil_AddTraceMessage(msg,data) /* noop */
92 #define PaUtil_DumpTraceMessages() /* noop */
93
94 #endif
95
96
97 #ifdef __cplusplus
98 }
99 #endif /* __cplusplus */
100
101 #endif /* PA_TRACE_H */

  ViewVC Help
Powered by ViewVC 1.1.22