clocked-0.4.1.2/ 0000755 0000000 0000000 00000000000 12030074431 011440 5 ustar 00 0000000 0000000 clocked-0.4.1.2/clocked.cabal 0000644 0000000 0000000 00000003106 12030074431 014030 0 ustar 00 0000000 0000000 Name: clocked
Version: 0.4.1.2
Synopsis: timer functionality to clock IO commands
Description: clocked is a library that allows you to clock IO-operations. You can use it to clock the rendering of frames, the calculation of steps in a physics engine, the triggering of musical events in a real-time system, etc.
Homepage: http://patch-tag.com/r/shahn/clocked/home
License: LGPL-3
License-file: LICENSE
Author: Sönke Hahn
Maintainer: shahn@joyridelabs.de
Category: Concurrency
Build-type: Simple
Cabal-version: >=1.8
extra-source-files:
README
source-repository head
type: darcs
location: http://patch-tag.com/r/shahn/clocked
Library
exposed-modules:
Clocked
other-modules:
Clocked.Common,
Clocked.WinTimePeriod
ghc-options:
-O3
hs-source-dirs:
-- choosing qt backend
src, src/qt-heuristic-seq
c-sources:
src/qt-heuristic-seq/clocked.cpp
if os(mingw32)
c-sources:
src/Clocked/WinTimePeriod.c
build-depends:
base >= 4 && < 5,
transformers,
MonadCatchIO-transformers,
containers
if !os(darwin)
build-depends:
clock == 0.2.0.0
if os(darwin)
build-depends:
time
extra-libraries:
stdc++
if os(linux)
PkgConfig-Depends:
QtCore
if os(mingw32)
extra-libraries:
QtCore4
if os(darwin)
frameworks:
QtCore
clocked-0.4.1.2/README 0000644 0000000 0000000 00000000073 12030074431 012320 0 ustar 00 0000000 0000000 There's a wiki: http://patch-tag.com/r/shahn/clocked/wiki/
clocked-0.4.1.2/LICENSE 0000644 0000000 0000000 00000016744 12030074431 012461 0 ustar 00 0000000 0000000 GNU LESSER GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.
0. Additional Definitions.
As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.
"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.
An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.
A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".
The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.
The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.
1. Exception to Section 3 of the GNU GPL.
You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.
2. Conveying Modified Versions.
If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:
a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or
b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.
3. Object Code Incorporating Material from Library Header Files.
The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:
a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the object code with a copy of the GNU GPL and this license
document.
4. Combined Works.
You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:
a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.
b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.
c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.
d) Do one of the following:
0) Convey the Minimal Corresponding Source under the terms of this
License, and the Corresponding Application Code in a form
suitable for, and under terms that permit, the user to
recombine or relink the Application with a modified version of
the Linked Version to produce a modified Combined Work, in the
manner specified by section 6 of the GNU GPL for conveying
Corresponding Source.
1) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (a) uses at run time
a copy of the Library already present on the user's computer
system, and (b) will operate properly with a modified version
of the Library that is interface-compatible with the Linked
Version.
e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)
5. Combined Libraries.
You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:
a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.
b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.
6. Revised Versions of the GNU Lesser General Public License.
The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.
If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.
clocked-0.4.1.2/Setup.hs 0000644 0000000 0000000 00000000106 12030074431 013071 0 ustar 00 0000000 0000000 #!/usr/bin/runhaskell
import Distribution.Simple
main = defaultMain
clocked-0.4.1.2/src/ 0000755 0000000 0000000 00000000000 12030074431 012227 5 ustar 00 0000000 0000000 clocked-0.4.1.2/src/Clocked/ 0000755 0000000 0000000 00000000000 12030074431 013573 5 ustar 00 0000000 0000000 clocked-0.4.1.2/src/Clocked/Common.hs 0000644 0000000 0000000 00000001001 12030074431 015347 0 ustar 00 0000000 0000000 {-# language CPP #-}
module Clocked.Common where
#ifdef darwin_HOST_OS
import Control.Applicative ((<$>))
import Data.Time.Clock.POSIX
getTimeDouble = realToFrac <$> getPOSIXTime
#else
import Control.Applicative ((<$>))
import System.Posix.Clock
-- | returns a monotonic time in seconds
getTimeDouble :: IO Double
getTimeDouble =
toSeconds <$> getTime Monotonic
where
toSeconds (TimeSpec seconds nanoSeconds) =
fromIntegral seconds + fromIntegral nanoSeconds * 10 ** (- 9)
#endif
clocked-0.4.1.2/src/Clocked/WinTimePeriod.c 0000644 0000000 0000000 00000000265 12030074431 016461 0 ustar 00 0000000 0000000
#include "windows.h"
void c_timeBeginPeriod(unsigned int uPeriod) {
timeBeginPeriod(uPeriod);
};
void c_timeEndPeriod(unsigned int uPeriod) {
timeEndPeriod(uPeriod);
};
clocked-0.4.1.2/src/Clocked/WinTimePeriod.hs 0000644 0000000 0000000 00000001213 12030074431 016643 0 ustar 00 0000000 0000000 {-# language CPP, ForeignFunctionInterface #-}
module Clocked.WinTimePeriod (withTimePeriod) where
#ifdef mingw32_HOST_OS
import Control.Monad.CatchIO
import Control.Monad.IO.Class
import Foreign.C.Types
foreign import ccall c_timeBeginPeriod :: CUInt -> IO ()
foreign import ccall c_timeEndPeriod :: CUInt -> IO ()
withTimePeriod :: MonadCatchIO m => CUInt -> m a -> m a
withTimePeriod n cmd =
bracket (liftIO $ c_timeBeginPeriod n) (const $ liftIO $ c_timeEndPeriod n) (const $ cmd)
#else
import Control.Monad.CatchIO
import Foreign.C.Types
withTimePeriod :: MonadCatchIO m => CUInt -> m a -> m a
withTimePeriod _ = id
#endif
clocked-0.4.1.2/src/qt-heuristic-seq/ 0000755 0000000 0000000 00000000000 12030074431 015436 5 ustar 00 0000000 0000000 clocked-0.4.1.2/src/qt-heuristic-seq/Clocked.hs 0000644 0000000 0000000 00000005230 12030074431 017336 0 ustar 00 0000000 0000000
{-# language ForeignFunctionInterface, ScopedTypeVariables #-}
-- Implementation using qt
-- and a heuristic to shorten the time span to be waited
-- to get closer to the wanted time span.
module Clocked (
Timer,
withTimer,
waitTimer,
getTimeDouble,
) where
import Data.IORef
import Data.Sequence
import Control.Monad
import Control.Monad.CatchIO
import Control.Monad.IO.Class
import Control.Applicative ((<$>))
import Clocked.Common
import Clocked.WinTimePeriod
-- | The heuristic correction is calculated using a moving average
-- of the time deviation. This is the size of the window for
-- calculating the moving average.
windowSize :: Double
windowSize = 10
-- | Estimate of the time deviation.
-- Empiric data on linux (2.6.35-28)
initialDeviation = 0.00018
-- | the heuristic correction gets limited by a fraction of the wanted time span
heuristicCorrectionFraction = 0.1
foreign import ccall qtUSleep :: Int -> IO ()
newtype Timer = Timer (IORef State)
-- | Run a monadic action with a 'Timer'.
withTimer :: MonadCatchIO m => (Timer -> m a) -> m a
withTimer m = withTimePeriod 1 $
(m =<< liftIO (Timer <$> (newIORef =<< mkState)))
data State = State {
lastTime :: Double,
deviations :: Seq Double,
deviationMovingAverage :: Double
}
mkState :: IO State
mkState = do
now <- getTimeDouble
return $ State now (mkFullBuffer (round windowSize) initialDeviation) initialDeviation
-- | Waits the given amount of seconds minus the elapsed time
-- since the last call to 'waitTimer' (or the initialisation of the timer).
waitTimer :: Timer -> Double -> IO ()
waitTimer (Timer ref) waitSeconds = do
state <- readIORef ref
now <- getTimeDouble
let heuristicCorrection = deviationMovingAverage state
waitTime :: Double = waitSeconds - (now - lastTime state) - heuristicCorrection
waitMicroSeconds = round (waitTime * 10 ^ 6)
when (waitMicroSeconds > 0) $
qtUSleep waitMicroSeconds
after <- getTimeDouble
let actuallyWaited = after - lastTime state
deviation = min
(actuallyWaited - waitSeconds + heuristicCorrection)
(waitSeconds * heuristicCorrectionFraction)
(droppedDeviation, newBuffer) = crank deviation (deviations state)
newAverage = deviationMovingAverage state + ((deviation - droppedDeviation) / windowSize)
state' = State after newBuffer newAverage
writeIORef ref state'
-- * buffer functions for Seq
mkFullBuffer :: Int -> a -> Seq a
mkFullBuffer = Data.Sequence.replicate
crank :: a -> Seq a -> (a, Seq a)
crank new buffer = case viewl buffer of
head :< tail -> (head, tail |> new)
EmptyL -> error "crank on empty buffer"
clocked-0.4.1.2/src/qt-heuristic-seq/clocked.cpp 0000644 0000000 0000000 00000000534 12030074431 017550 0 ustar 00 0000000 0000000
#include
#include
class MyThread : public QThread {
public:
void myUSleep(int microSeconds);
};
void MyThread::myUSleep(int microSeconds) {
QThread::usleep(microSeconds);
};
MyThread* myThread = new MyThread();
extern "C" void qtUSleep(int microSeconds) {
myThread->myUSleep(microSeconds);
};