//------------------------------------------------------------------------------
// 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
 * ストリームサウンドヘッダ
 * @author Junpee
 */

#ifndef STREAM_SOUND_H_
#define STREAM_SOUND_H_

#include <Sound/Stereo/StereoSound.h>
#include <Sound/System/SoundDefinition.h>

namespace Lamp{

class SoundReader;
class StreamPlayer;

//------------------------------------------------------------------------------
/**
 * ストリームサウンド
 */
class StreamSound : public StereoSound{
friend class SoundManager;
public:
	//--------------------------------------------------------------------------
	// 基本データ取得
	//--------------------------------------------------------------------------
	/**
	 * サウンドリーダの取得
	 * @return サウンドリーダ
	 */
	virtual SoundReader* getSoundReader(){ return soundReader_; }

	/**
	 * ストリームプレーヤの取得
	 * @return ストリームプレーヤ
	 */
	virtual StreamPlayer* getStreamPlayer(){ return streamPlayer_; }

	//--------------------------------------------------------------------------
	/**
	 * サイズの取得
	 * @return サイズ
	 */
	virtual u_int getSize() const;

	//--------------------------------------------------------------------------
	// 再生
	//--------------------------------------------------------------------------
	/**
	 * 再生
	 * @return 正常に再生されればtrue
	 */
	virtual bool play(){
		Assert((soundReader_ != NULL) && (streamPlayer_ != NULL));
		return StereoSound::play();
	}

	/**
	 * 停止
	 */
	virtual void stop();

	//--------------------------------------------------------------------------
	// 再生位置
	//--------------------------------------------------------------------------
	/**
	 * 再生位置設定
	 * @param cursor 再生位置のバイト数
	 */
	virtual void setCursor(u_int cursor);

	/**
	 * 再生位置取得
	 * @return 再生位置のバイト数
	 */
	virtual u_int getCursor() const;

	//--------------------------------------------------------------------------
	// ループ
	//--------------------------------------------------------------------------
	/**
	 * ループ位置の設定
	 * @param loopCursor ループ位置をバイト数で指定
	 */
	virtual void setLoopCursor(u_int loopCursor);

	/**
	 * ループ位置の取得
	 * @return ループ位置のバイト数
	 */
	virtual u_int getLoopCursor() const;

	//--------------------------------------------------------------------------
	// RTTI
	//--------------------------------------------------------------------------
	/**
	 * ストリームを使用しているか
	 * @return ストリームを使用しているtrue
	 */
	virtual bool useStream() const{ return true; }

	/**
	 * ストリームサウンドかどうか
	 * @return ストリームサウンドならtrue
	 */
	virtual bool isStreamSound() const{ return true; }

protected:
	//--------------------------------------------------------------------------
	// 生成、破棄
	//--------------------------------------------------------------------------
	/**
	 * コンストラクタ
	 * @param soundBuffer サウンドバッファ
	 */
	StreamSound(DirectSoundBuffer* soundBuffer);

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

	/**
	 * サウンドリーダの設定
	 * @param soundReader サウンドリーダ、ストリームサウンドによってdeleteされる。
	 */
	virtual void setSoundReader(SoundReader* soundReader);

	//--------------------------------------------------------------------------
	/**
	 * 再生フラグの取得
	 * @return 再生フラグ
	 */
	virtual u_int getPlayFlag(){
		// プライオリティ、再生時間による動的ボイス管理、ループ
		u_int result = (
//			DSBPLAY_TERMINATEBY_PRIORITY | 
//			DSBPLAY_TERMINATEBY_TIME | 
			DSBPLAY_LOOPING);
		return result;
	}

private:
	// サウンドリーダ
	SoundReader* soundReader_;
	// ストリームプレーヤ
	StreamPlayer* streamPlayer_;
};

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