/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLUtils/src/ICLUtils/FPSEstimator.h                   **
** Module : ICLUtils                                               **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/Time.h>
#include <deque>
#include <string>

namespace icl{
  namespace utils{
    ///Utility clas for online FPS estimation \ingroup TIME
    class ICLUtils_API FPSEstimator{
      public:
  
      ///Constructor
      /** Current FPS values are averaged over given intervall n*/
      FPSEstimator(int n=2);
  
      /// virtual destructor
      virtual ~FPSEstimator() {}
  
      /// Sets a new averaging interval
      void reset(int n);
      
      /// pushes current time into the time averaging queue and pop oldest time from the queue
      virtual void tic() const;
      
      /// applies tic() and returns current FPS estimate
      virtual float getFPSVal() const;
       
      /// applies tic() and returns current fps estimate as formated string
      virtual std::string getFPSString(const std::string &fmt="%3.4f fps", int bufferSize=30) const;
       
      /// applies tic() and shows current FPS estimate on std::out
      virtual void showFPS(const std::string &text="") const;
      
      private:
      /// internal time queue
      mutable std::deque<Time> m_qTimes;
      
      /// time-queues size
      int m_iN;
    };
  
  #define FPS_LOG_THIS_FUNCTION(N) static FPSEstimator __FPSEstimator__((N)); \
                                   __FPSEstimator__.showFps(__FUNCTION__);
    
  } // namespace utils
}