Sound.OSC.Time

OSC related timing functions. OSC timestamps are NTP values, http://ntp.org/.

Temporal types

type NTPi = Word64

Type for integer (binary) representation of NTP time.

type UT = Double

Unix/Posix epoch time in real-valued (fractional) form.

Time conversion

ntpr_to_ntpi :: RealFrac n => n -> NTPi

Convert a real-valued NTP timestamp to an NTPi timestamp.

ntpi_to_ntpr :: Fractional n => NTPi -> n

Convert an NTPi timestamp to a real-valued NTP timestamp.

ntp_ut_epoch_diff :: Num n => n

Difference (in seconds) between NTP and UT epochs.

 ntp_ut_epoch_diff / (24 * 60 * 60) == 25567

ut_to_ntpi :: UT -> NTPi

Convert a UT timestamp to an NTPi timestamp.

ut_to_ntpr :: Num n => n -> n

Convert Unix/Posix to NTP.

ntpr_to_ut :: Num n => n -> n

Convert NTP to Unix/Posix.

ntpi_to_ut :: NTPi -> UT

Convert NTPi to Unix/Posix.

Time inter-operation.

ut_epoch :: UTCTime

The time at 1970-01-01:00:00:00.

utc_to_ut :: Fractional n => UTCTime -> n

Convert UTCTime to Unix/Posix.

Clock operations

time :: MonadIO m => m Time

Read current real-valued NTP timestamp.

 do {ct <- fmap utc_to_ut T.getCurrentTime
    ;pt <- fmap realToFrac T.getPOSIXTime
    ;print (pt - ct,pt - ct < 1e-5)}

Thread operations.

pauseThreadLimit :: Fractional n => n

The pauseThread limit (in seconds). Values larger than this require a different thread delay mechanism, see sleepThread. The value is the number of microseconds in maxBound::Int.

pauseThread :: (MonadIO m, Ord n, RealFrac n) => n -> m ()

Pause current thread for the indicated duration (in seconds), see pauseThreadLimit.

wait :: MonadIO m => Double -> m ()

Type restricted pauseThread.

pauseThreadUntil :: MonadIO m => Time -> m ()

Pause current thread until the given Time, see pauseThreadLimit.

sleepThread :: (RealFrac n, MonadIO m) => n -> m ()

Sleep current thread for the indicated duration (in seconds). Divides long sleeps into parts smaller than pauseThreadLimit.

sleepThreadUntil :: MonadIO m => Time -> m ()

Sleep current thread until the given Time. Divides long sleeps into parts smaller than pauseThreadLimit.