MCTimer.cpp

/*
 *  This file is part of the AiBO+ project
 *
 *  Copyright (C) 2005-2016 Csaba Kertész (csaba.kertesz@gmail.com)
 *
 *  AiBO+ is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  AiBO+ 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Street #330, Boston, MA 02111-1307, USA.
 *
 */

#include "MCTimer.hpp"

#include <limits.h>
#include <stdio.h>

#include "MCDefs.hpp"
#include "MCThreadLocalData.hpp"

#ifndef __AIBO_BUILD__
#include <QElapsedTimer>
#endif

namespace
{
#ifdef __AIBO_BUILD__
// Get the current time on Aibo
static SystemTime AiboTimer;
#else
// Global timer
MCThreadLocalData<QElapsedTimer> GlobalTimer(true);
#endif
// Optional custom system time handler
MCThreadLocalData<MASystemTimeHandler> SystemTimeHandler(true);
// System time start in a thread
MCThreadLocalData<int64_t> SystemTimeStart(true);
// System time shift caused by hibernation in a thread
MCThreadLocalData<int64_t> HibernationTimeShift(true);
// Start of time hibernation in a thread
MCThreadLocalData<int64_t> HibernationStartTime(true);
// System time shift caused by hibernation in a thread
MCThreadLocalData<MCTimer> HibernationTimer(true);

bool CheckStaticTimerVariables()
{
  if (!SystemTimeStart.get())
  {
    SystemTimeStart.reset(new int64_t);
    *SystemTimeStart = 0;
    HibernationTimeShift.reset(new int64_t);
    *HibernationTimeShift = 0;
    HibernationStartTime.reset(new int64_t);
    *HibernationStartTime = 0;
    HibernationTimer.reset(new MCTimer(MC::NoExpiration, 0));
    return true;
  }
  return false;
}
}

MCTimer::MCTimer(MC::TimerType timer_type, int duration) : TimerType(timer_type),
  Duration((int64_t)duration*(duration > 0 ? 1000 : 1)), LastShot(-1), Shots(-1),
  StartTime(0)
{
}


MCTimer::~MCTimer()
{
}


void MCTimer::SetCustomHandler(MASystemTimeHandler& handler)
{
  SystemTimeHandler.reset(&handler);
  // Reset the system start time
  CheckStaticTimerVariables();
  *SystemTimeStart = handler.GetSystemTime();
}


int64_t MCTimer::GetElapsedSystemTime(bool relative_time)
{
  int64_t CurrentTime = 0;

  if (HibernationStartTime.get() && *HibernationStartTime > 0)
  {
    CurrentTime = *HibernationStartTime;
  } else
  if (SystemTimeHandler.get())
  {
    CurrentTime = SystemTimeHandler->GetSystemTime();
  } else {
    // Get the current time in milliseconds
#ifdef __AIBO_BUILD__
    GetSystemTime(&AiboTimer);
    CurrentTime = (int64_t)AiboTimer.seconds*1000000+AiboTimer.useconds;
#else
    if (unlikely(!GlobalTimer.get()))
    {
      GlobalTimer.reset(new QElapsedTimer);
      GlobalTimer->start();
    }
    CurrentTime = (int64_t)GlobalTimer->nsecsElapsed() / 1000;
#endif
  }
  if (CheckStaticTimerVariables())
  {
    *SystemTimeStart = CurrentTime;
    return 0;
  }
  return relative_time ? CurrentTime-*SystemTimeStart-*HibernationTimeShift : CurrentTime-*HibernationTimeShift;
}


void MCTimer::ResetElapsedSystemTime()
{
  CheckStaticTimerVariables();
  *SystemTimeStart = GetElapsedSystemTime(false);
}


void MCTimer::HibernateSystemTime()
{
  CheckStaticTimerVariables();
  if (HibernationTimer->IsStarted())
    return;

  HibernationTimer->Start();
  // Set the hibernation start time to override all subsequent calls to GetElapsedSystemTime() until
  // the system time is resumed.
  *HibernationStartTime = GetElapsedSystemTime(false)+*HibernationTimeShift;
}


void MCTimer::ResumeSystemTime()
{
  CheckStaticTimerVariables();
  if (!HibernationTimer->IsStarted())
    return;

  // First reset the hibernation start time. -> The real, elapsed hibernation time can be read back.
  *HibernationStartTime = 0;
  *HibernationTimeShift += HibernationTimer->GetElapsedTimeInUSecs();
  HibernationTimer->Stop();
}


void MCTimer::SetDuration(int duration)
{
  Duration = (int64_t)duration*(duration > 0 ? 1000 : 1);
}


int MCTimer::GetDuration() const
{
  return (int)(Duration / (Duration > 0 ? 1000 : 1));
}


int MCTimer::GetStartTime() const
{
  return (int)(StartTime / 1000);
}


bool MCTimer::IsStarted() const
{
  return Shots != -1;
}


void MCTimer::Start(int time_shift)
{
  StartTime = GetElapsedSystemTime()-(int64_t)time_shift*1000;
  LastShot = StartTime;
  Shots = 0;
}


void MCTimer::StartFromTime(int start_time)
{
  StartTime = (int64_t)start_time*1000;
  LastShot = StartTime;
  Shots = 0;
}


void MCTimer::Stop()
{
  Reset();
}


int MCTimer::GetElapsedTime()
{
  return (int)(GetElapsedTimeInUSecs() / 1000);
}


int64_t MCTimer::GetElapsedTimeInUSecs()
{
  if (LastShot < 0)
  {
    return 0;
  }
  return GetElapsedSystemTime()-LastShot;
}


bool MCTimer::Timeout()
{
  // The timer never expires or the timer is not started. -> Return
  if (TimerType == MC::NoExpiration || Duration < 0)
  {
    return false;
  }
  // The timer has been expired
  if (GetElapsedSystemTime()-LastShot > Duration)
  {
    if (TimerType == MC::SimpleExpiration)
    {
      return true;
    }
    LastShot = LastShot+Duration;
    Shots++;
    if (TimerType == MC::PeriodicShots || (TimerType == MC::SingleShot && Shots == 1))
    {
      return true;
    }
  }
  return false;
}


void MCTimer::Reset()
{
  LastShot = -1;
  Shots = -1;
  StartTime = 0;
}