1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/****************************************************************************
* *
* OpenNI 1.x Alpha *
* Copyright (C) 2011 PrimeSense Ltd. *
* *
* This file is part of OpenNI. *
* *
* OpenNI is free software: you can redistribute it and/or modify *
* it under the terms of the GNU Lesser General Public License as published *
* by the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* OpenNI is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public License *
* along with OpenNI. If not, see <http://www.gnu.org/licenses/>. *
* *
****************************************************************************/
#ifndef _XN_PROFILING_H_
#define _XN_PROFILING_H_
//---------------------------------------------------------------------------
// Includes
//---------------------------------------------------------------------------
#include <XnOS.h>
//---------------------------------------------------------------------------
// Defines
//---------------------------------------------------------------------------
#define INVALID_PROFILING_HANDLE -1
//---------------------------------------------------------------------------
// Types
//---------------------------------------------------------------------------
typedef XnInt32 XnProfilingHandle;
//---------------------------------------------------------------------------
// Exported Function Declaration
//---------------------------------------------------------------------------
/**
* Initializes profiling.
*
* @param nProfilingInterval [in] The number of milliseconds between profiler printings. A value
* of zero means profiling is off.
*/
XN_C_API XnStatus XN_C_DECL xnProfilingInit(XnUInt32 nProfilingInterval = 0);
/**
* Initializes using INI file.
*
* @param cpINIFileName [in] Name of INI file.
* @param cpSectionName [in] Name of section in INI file.
*/
XN_C_API XnStatus XN_C_DECL xnProfilingInitFromINI(const XnChar* cpINIFileName, const XnChar* cpSectionName);
/**
* Shuts down profiling.
*/
XN_C_API XnStatus XN_C_DECL xnProfilingShutdown();
/**
* Returns TRUE if profiling is active, or FALSE otherwise.
*/
XN_C_API XnBool XN_C_DECL xnProfilingIsActive();
/**
* Start a profiled section. This function is not meant to be used directly. Please use the
* XN_PROFILING_START_SECTION macro.
*
* @param csSectionName [in] The name of the profiled section.
* @param bMT [in] TRUE if this section is multi-threaded, FALSE otherwise.
* @param pHandle [out] A handle to be used each time this section executes again.
*/
XN_C_API XnStatus XN_C_DECL xnProfilingSectionStart(const char* csSectionName, XnBool bMT, XnProfilingHandle* pHandle);
/**
* Ends a profiled section. This function is not meant to be used directly. Please use the
* XN_PROFILING_END_SECTION macro.
*
* @param pHandle [in] A handle returned from xnProfilingSectionStart.
*/
XN_C_API XnStatus XN_C_DECL xnProfilingSectionEnd(XnProfilingHandle* pHandle);
/**
* Starts a profiled section. The code section between this declaration
* and the following XN_PROFILING_END_SECTION declaration will be time-measured.
*
* @param name [in] The name of the section (for printing purposes).
* @param mt [in] TRUE if this section is multi-threaded, FALSE otherwise.
*/
#define _XN_PROFILING_START_SECTION(name, mt) \
{ \
static XnProfilingHandle __profiling = INVALID_PROFILING_HANDLE; \
if (xnProfilingIsActive()) \
{ \
xnProfilingSectionStart(name, mt, &__profiling); \
}
#define XN_PROFILING_START_SECTION(name) _XN_PROFILING_START_SECTION(name, FALSE)
#define XN_PROFILING_START_MT_SECTION(name) _XN_PROFILING_START_SECTION(name, TRUE)
/**
* Ends a profiled section.
*/
#define XN_PROFILING_END_SECTION \
if (__profiling != INVALID_PROFILING_HANDLE) \
{ \
xnProfilingSectionEnd(&__profiling); \
} \
}
/**
* Starts a profiled section, giving it the name of the current function.
* The code section between this declaration and the following XN_PROFILING_END_FUNCTION
* declaration will be time-measured.
*
* @param name [in] The name of the section (for printing purposes).
*/
#define XN_PROFILING_START_FUNCTION XN_PROFILING_START_SECTION(__FUNCTION__)
/**
* Ends a profiled function.
*/
#define XN_PROFILING_END_FUNCTION XN_PROFILING_END_SECTION
#endif //_XN_PROFILING_H_
|
