//------------------------------------------------------------------------------
// Lamp : Open source game middleware
// Copyright (C) 2004  Junpei Ohtani ( Email : junpee@users.sourceforge.jp )
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//------------------------------------------------------------------------------

/** @file
 * FPSコントローラヘッダ
 * @author Junpee
 */

#ifndef FPS_CONTROLLER_H_
#define FPS_CONTROLLER_H_

#include <Core/Utility/Timer.h>
#include <Core/Thread/CriticalSection.h>
#include <Core/Container/Deque.h>

namespace Lamp{

class Thread;

//------------------------------------------------------------------------------
/**
 * FPSコントローラ
 */
class FPSController{
public:
	/// 60FPS
	static const float interval60FPS;
	/// 30FPS
	static const float interval30FPS;

	/**
	 * コンストラクタ
	 * @param targetInterval 目標時間間隔をミリ秒で指定
	 */
	FPSController(float targetInterval = interval60FPS);

	/**
	 * デストラクタ
	 */
	virtual ~FPSController();

	//--------------------------------------------------------------------------
	/**
	 * 目標時間間隔の設定
	 * @param targetInterval 目標時間間隔をミリ秒で指定
	 */
	virtual void setTargetInterval(float targetInterval){
		targetInterval_ = targetInterval;
		sleepTime_ = targetInterval_;
		intervalTime_ = targetInterval_;
	}

	/**
	 * 目標時間間隔の取得
	 * @return 目標時間間隔をミリ秒で返す
	 */
	virtual float getTargetInterval() const{ return targetInterval_; }

	/**
	 * FPSを維持するためにカレントスレッドをsleepする
	 * @return 前回のsleepとの時間間隔
	 */
	virtual float sleep();

	/**
	 * インターバルの取得
	 * @return インターバルをミリ秒で取得
	 */
	virtual float getIntervalTime() const{ return intervalTime_; }

	/**
	 * スリープ時間の取得
	 * @return スリープ時間をミリ秒で取得
	 */
	virtual float getSleepTime() const{ return sleepTime_; }

	/**
	 * 処理時間の取得
	 * @return 処理時間をミリ秒で取得
	 */
	virtual float getProcessingTime() const{
		return intervalTime_ - sleepTime_;
	}

	/**
	 * 処理割合の取得
	 * @return 処理割合
	 */
	virtual float getProcessingRate() const{
		return getProcessingTime() / getIntervalTime();
	}

	//--------------------------------------------------------------------------
	/**
	 * バックグラウンドスレッドの登録
	 * @param backgroundThread バックグラウンドスレッド
	 */
	virtual void registerBackgroundThread(Thread* backgroundThread);

	/**
	 * バックグラウンドスレッド数の取得
	 * @return バックグラウンドスレッド数
	 */
	virtual int getBackgroundThreadCount();

	/**
	 * バックグラウンドスレッド数の取得
	 * @param index インデックス
	 * @return バックグラウンドスレッド数
	 */
	virtual Thread* getBackgroundThread(int index);

	//--------------------------------------------------------------------------
	/**
	 * 文字列への変換
	 * @return 文字列
	 */
	virtual String toString() const;

private:
	// コピーコンストラクタの隠蔽
	FPSController(const FPSController& copy);

	// 代入コピーの隠蔽
	void operator =(const FPSController& copy);

	// バックグラウンドスレッド
	Deque<Thread*> backgroundThreads_;
	// クリティカルセクション
	CriticalSection criticalSection_;
	// 時間
	Timer::Tick tick_;
	// 間隔
	float intervalTime_;
	// ターゲット間隔
	float targetInterval_;
	// sleep時間
	float sleepTime_;
};

//------------------------------------------------------------------------------
} // End of namespace Lamp
#endif // End of FPS_CONTROLLER_H_
//------------------------------------------------------------------------------

