1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski // MARKER(update_precomp.py): autogen include statement, do not remove
25*b1cdbd2cSJim Jagielski #include "precompiled_canvas.hxx"
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski #include "osl/time.h"
28*b1cdbd2cSJim Jagielski #include "osl/diagnose.h"
29*b1cdbd2cSJim Jagielski #include "canvas/elapsedtime.hxx"
30*b1cdbd2cSJim Jagielski
31*b1cdbd2cSJim Jagielski #if defined(WNT)
32*b1cdbd2cSJim Jagielski
33*b1cdbd2cSJim Jagielski #if defined _MSC_VER
34*b1cdbd2cSJim Jagielski #pragma warning(push,1)
35*b1cdbd2cSJim Jagielski #endif
36*b1cdbd2cSJim Jagielski
37*b1cdbd2cSJim Jagielski // TEMP!!!
38*b1cdbd2cSJim Jagielski // Awaiting corresponding functionality in OSL
39*b1cdbd2cSJim Jagielski //
40*b1cdbd2cSJim Jagielski #define WIN32_LEAN_AND_MEAN
41*b1cdbd2cSJim Jagielski #include <windows.h>
42*b1cdbd2cSJim Jagielski #include <winbase.h>
43*b1cdbd2cSJim Jagielski #include <mmsystem.h>
44*b1cdbd2cSJim Jagielski #endif
45*b1cdbd2cSJim Jagielski
46*b1cdbd2cSJim Jagielski #if defined _MSC_VER
47*b1cdbd2cSJim Jagielski #pragma warning(pop)
48*b1cdbd2cSJim Jagielski #endif
49*b1cdbd2cSJim Jagielski
50*b1cdbd2cSJim Jagielski #include <algorithm>
51*b1cdbd2cSJim Jagielski #include <limits>
52*b1cdbd2cSJim Jagielski
53*b1cdbd2cSJim Jagielski namespace canvas {
54*b1cdbd2cSJim Jagielski namespace tools {
55*b1cdbd2cSJim Jagielski
56*b1cdbd2cSJim Jagielski
57*b1cdbd2cSJim Jagielski #if defined(WNT)
58*b1cdbd2cSJim Jagielski // TODO(Q2): is 0 okay for the failure case here?
getSystemTime()59*b1cdbd2cSJim Jagielski double ElapsedTime::getSystemTime()
60*b1cdbd2cSJim Jagielski {
61*b1cdbd2cSJim Jagielski // TEMP!!!
62*b1cdbd2cSJim Jagielski // Awaiting corresponding functionality in OSL
63*b1cdbd2cSJim Jagielski //
64*b1cdbd2cSJim Jagielski
65*b1cdbd2cSJim Jagielski // is there a performance counter available?
66*b1cdbd2cSJim Jagielski static bool bTimeSetupDone( false );
67*b1cdbd2cSJim Jagielski static bool bPerfTimerAvailable( false );
68*b1cdbd2cSJim Jagielski static LONGLONG nPerfCountFreq;
69*b1cdbd2cSJim Jagielski
70*b1cdbd2cSJim Jagielski // TODO(F1): This _might_ cause problems, as it prevents correct
71*b1cdbd2cSJim Jagielski // time handling for very long lifetimes of this class's
72*b1cdbd2cSJim Jagielski // surrounding component in memory. When the difference between
73*b1cdbd2cSJim Jagielski // current sys time and nInitialCount exceeds IEEE double's
74*b1cdbd2cSJim Jagielski // mantissa, time will start to run jerky.
75*b1cdbd2cSJim Jagielski static LONGLONG nInitialCount;
76*b1cdbd2cSJim Jagielski
77*b1cdbd2cSJim Jagielski if( !bTimeSetupDone )
78*b1cdbd2cSJim Jagielski {
79*b1cdbd2cSJim Jagielski if( QueryPerformanceFrequency(
80*b1cdbd2cSJim Jagielski reinterpret_cast<LARGE_INTEGER *>(&nPerfCountFreq) ) )
81*b1cdbd2cSJim Jagielski {
82*b1cdbd2cSJim Jagielski // read initial time:
83*b1cdbd2cSJim Jagielski QueryPerformanceCounter(
84*b1cdbd2cSJim Jagielski reinterpret_cast<LARGE_INTEGER *>(&nInitialCount) );
85*b1cdbd2cSJim Jagielski bPerfTimerAvailable = true;
86*b1cdbd2cSJim Jagielski }
87*b1cdbd2cSJim Jagielski bTimeSetupDone = true;
88*b1cdbd2cSJim Jagielski }
89*b1cdbd2cSJim Jagielski
90*b1cdbd2cSJim Jagielski if( bPerfTimerAvailable )
91*b1cdbd2cSJim Jagielski {
92*b1cdbd2cSJim Jagielski LONGLONG nCurrCount;
93*b1cdbd2cSJim Jagielski QueryPerformanceCounter(
94*b1cdbd2cSJim Jagielski reinterpret_cast<LARGE_INTEGER *>(&nCurrCount) );
95*b1cdbd2cSJim Jagielski nCurrCount -= nInitialCount;
96*b1cdbd2cSJim Jagielski return double(nCurrCount) / nPerfCountFreq;
97*b1cdbd2cSJim Jagielski }
98*b1cdbd2cSJim Jagielski else
99*b1cdbd2cSJim Jagielski {
100*b1cdbd2cSJim Jagielski LONGLONG nCurrTime = timeGetTime();
101*b1cdbd2cSJim Jagielski return double(nCurrTime) / 1000.0;
102*b1cdbd2cSJim Jagielski }
103*b1cdbd2cSJim Jagielski }
104*b1cdbd2cSJim Jagielski
105*b1cdbd2cSJim Jagielski #else // ! WNT
106*b1cdbd2cSJim Jagielski
107*b1cdbd2cSJim Jagielski // TODO(Q2): is 0 okay for the failure case here?
108*b1cdbd2cSJim Jagielski double ElapsedTime::getSystemTime()
109*b1cdbd2cSJim Jagielski {
110*b1cdbd2cSJim Jagielski TimeValue aTimeVal;
111*b1cdbd2cSJim Jagielski if( osl_getSystemTime( &aTimeVal ) )
112*b1cdbd2cSJim Jagielski return ((aTimeVal.Nanosec * 10e-10) + aTimeVal.Seconds);
113*b1cdbd2cSJim Jagielski else
114*b1cdbd2cSJim Jagielski return 0.0;
115*b1cdbd2cSJim Jagielski }
116*b1cdbd2cSJim Jagielski
117*b1cdbd2cSJim Jagielski #endif
118*b1cdbd2cSJim Jagielski
ElapsedTime()119*b1cdbd2cSJim Jagielski ElapsedTime::ElapsedTime()
120*b1cdbd2cSJim Jagielski : m_pTimeBase(),
121*b1cdbd2cSJim Jagielski m_fLastQueriedTime( 0.0 ),
122*b1cdbd2cSJim Jagielski m_fStartTime( getSystemTime() ),
123*b1cdbd2cSJim Jagielski m_fFrozenTime( 0.0 ),
124*b1cdbd2cSJim Jagielski m_bInPauseMode( false ),
125*b1cdbd2cSJim Jagielski m_bInHoldMode( false )
126*b1cdbd2cSJim Jagielski {
127*b1cdbd2cSJim Jagielski }
128*b1cdbd2cSJim Jagielski
ElapsedTime(boost::shared_ptr<ElapsedTime> const & pTimeBase)129*b1cdbd2cSJim Jagielski ElapsedTime::ElapsedTime(
130*b1cdbd2cSJim Jagielski boost::shared_ptr<ElapsedTime> const & pTimeBase )
131*b1cdbd2cSJim Jagielski : m_pTimeBase( pTimeBase ),
132*b1cdbd2cSJim Jagielski m_fLastQueriedTime( 0.0 ),
133*b1cdbd2cSJim Jagielski m_fStartTime( getCurrentTime() ),
134*b1cdbd2cSJim Jagielski m_fFrozenTime( 0.0 ),
135*b1cdbd2cSJim Jagielski m_bInPauseMode( false ),
136*b1cdbd2cSJim Jagielski m_bInHoldMode( false )
137*b1cdbd2cSJim Jagielski {
138*b1cdbd2cSJim Jagielski }
139*b1cdbd2cSJim Jagielski
getTimeBase() const140*b1cdbd2cSJim Jagielski boost::shared_ptr<ElapsedTime> const & ElapsedTime::getTimeBase() const
141*b1cdbd2cSJim Jagielski {
142*b1cdbd2cSJim Jagielski return m_pTimeBase;
143*b1cdbd2cSJim Jagielski }
144*b1cdbd2cSJim Jagielski
reset()145*b1cdbd2cSJim Jagielski void ElapsedTime::reset()
146*b1cdbd2cSJim Jagielski {
147*b1cdbd2cSJim Jagielski m_fLastQueriedTime = 0.0;
148*b1cdbd2cSJim Jagielski m_fStartTime = getCurrentTime();
149*b1cdbd2cSJim Jagielski m_fFrozenTime = 0.0;
150*b1cdbd2cSJim Jagielski m_bInPauseMode = false;
151*b1cdbd2cSJim Jagielski m_bInHoldMode = false;
152*b1cdbd2cSJim Jagielski }
153*b1cdbd2cSJim Jagielski
adjustTimer(double fOffset,bool)154*b1cdbd2cSJim Jagielski void ElapsedTime::adjustTimer( double fOffset, bool /*bLimitToLastQueriedTime*/ )
155*b1cdbd2cSJim Jagielski {
156*b1cdbd2cSJim Jagielski // to make getElapsedTime() become _larger_, have to reduce
157*b1cdbd2cSJim Jagielski // m_fStartTime.
158*b1cdbd2cSJim Jagielski m_fStartTime -= fOffset;
159*b1cdbd2cSJim Jagielski
160*b1cdbd2cSJim Jagielski // also adjust frozen time, this method must _always_ affect the
161*b1cdbd2cSJim Jagielski // value returned by getElapsedTime()!
162*b1cdbd2cSJim Jagielski if (m_bInHoldMode || m_bInPauseMode)
163*b1cdbd2cSJim Jagielski m_fFrozenTime += fOffset;
164*b1cdbd2cSJim Jagielski }
165*b1cdbd2cSJim Jagielski
getCurrentTime() const166*b1cdbd2cSJim Jagielski double ElapsedTime::getCurrentTime() const
167*b1cdbd2cSJim Jagielski {
168*b1cdbd2cSJim Jagielski return m_pTimeBase.get() == 0
169*b1cdbd2cSJim Jagielski ? getSystemTime() : m_pTimeBase->getElapsedTimeImpl();
170*b1cdbd2cSJim Jagielski }
171*b1cdbd2cSJim Jagielski
getElapsedTime() const172*b1cdbd2cSJim Jagielski double ElapsedTime::getElapsedTime() const
173*b1cdbd2cSJim Jagielski {
174*b1cdbd2cSJim Jagielski m_fLastQueriedTime = getElapsedTimeImpl();
175*b1cdbd2cSJim Jagielski return m_fLastQueriedTime;
176*b1cdbd2cSJim Jagielski }
177*b1cdbd2cSJim Jagielski
getElapsedTimeImpl() const178*b1cdbd2cSJim Jagielski double ElapsedTime::getElapsedTimeImpl() const
179*b1cdbd2cSJim Jagielski {
180*b1cdbd2cSJim Jagielski if (m_bInHoldMode || m_bInPauseMode)
181*b1cdbd2cSJim Jagielski return m_fFrozenTime;
182*b1cdbd2cSJim Jagielski
183*b1cdbd2cSJim Jagielski return getCurrentTime() - m_fStartTime;
184*b1cdbd2cSJim Jagielski }
185*b1cdbd2cSJim Jagielski
pauseTimer()186*b1cdbd2cSJim Jagielski void ElapsedTime::pauseTimer()
187*b1cdbd2cSJim Jagielski {
188*b1cdbd2cSJim Jagielski m_fFrozenTime = getElapsedTimeImpl();
189*b1cdbd2cSJim Jagielski m_bInPauseMode = true;
190*b1cdbd2cSJim Jagielski }
191*b1cdbd2cSJim Jagielski
continueTimer()192*b1cdbd2cSJim Jagielski void ElapsedTime::continueTimer()
193*b1cdbd2cSJim Jagielski {
194*b1cdbd2cSJim Jagielski m_bInPauseMode = false;
195*b1cdbd2cSJim Jagielski
196*b1cdbd2cSJim Jagielski // stop pausing, time runs again. Note that
197*b1cdbd2cSJim Jagielski // getElapsedTimeImpl() honors hold mode, i.e. a
198*b1cdbd2cSJim Jagielski // continueTimer() in hold mode will preserve the latter
199*b1cdbd2cSJim Jagielski const double fPauseDuration( getElapsedTimeImpl() - m_fFrozenTime );
200*b1cdbd2cSJim Jagielski
201*b1cdbd2cSJim Jagielski // adjust start time, such that subsequent getElapsedTime() calls
202*b1cdbd2cSJim Jagielski // will virtually start from m_fFrozenTime.
203*b1cdbd2cSJim Jagielski m_fStartTime += fPauseDuration;
204*b1cdbd2cSJim Jagielski }
205*b1cdbd2cSJim Jagielski
holdTimer()206*b1cdbd2cSJim Jagielski void ElapsedTime::holdTimer()
207*b1cdbd2cSJim Jagielski {
208*b1cdbd2cSJim Jagielski // when called during hold mode (e.g. more than once per time
209*b1cdbd2cSJim Jagielski // object), the original hold time will be maintained.
210*b1cdbd2cSJim Jagielski m_fFrozenTime = getElapsedTimeImpl();
211*b1cdbd2cSJim Jagielski m_bInHoldMode = true;
212*b1cdbd2cSJim Jagielski }
213*b1cdbd2cSJim Jagielski
releaseTimer()214*b1cdbd2cSJim Jagielski void ElapsedTime::releaseTimer()
215*b1cdbd2cSJim Jagielski {
216*b1cdbd2cSJim Jagielski m_bInHoldMode = false;
217*b1cdbd2cSJim Jagielski }
218*b1cdbd2cSJim Jagielski
219*b1cdbd2cSJim Jagielski } // namespace tools
220*b1cdbd2cSJim Jagielski } // namespace canvas
221