//------------------------------------------------------------------------------
// 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
 * OggVorbisリーダヘッダ
 * @author Junpee
 */

#ifndef OGG_VORBIS_READER_H_
#define OGG_VORBIS_READER_H_

#include <Sound/Reader/SoundReader.h>
#include <Core/InputOutput/FilePath.h>

namespace Lamp{

// OggVorbisのヘッダを外部に見せないようにする
class OggVorbisReaderImpl;

//------------------------------------------------------------------------------
/**
 * OggVorbisリーダ
 *
 * ov_open_callbacks()を使用すればメモリから読み込める。必要そうなら実装する。
 * ファイル末尾からのseekが必要なので独自パックファイルを導入する必要がある。
 */
class OggVorbisReader : public SoundReader{
public:
	/**
	 * コンストラクタ
	 * @param filePath ファイルパス
	 */
	OggVorbisReader(const FilePath& filePath);

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

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

	/**
	 * サンプル数の取得
	 * @return サンプル数
	 */
	virtual int getSample() const;

	/**
	 * チャンネル数の取得
	 * @return チャンネル数
	 */
	virtual int getChannel() const;

	/**
	 * ビット数の取得
	 * @return ビット数
	 */
	virtual int getBit() const;

	/**
	 * コメントの取得
	 * @return コメント
	 */
	virtual const String& getComment();

	//--------------------------------------------------------------------------
	/**
	 * 位置の設定
	 * @param cursor 設定する位置
	 */
	virtual void setCursor(u_int cursor);

	/**
	 * 位置の取得
	 * @return 位置
	 */
	virtual u_int getCursor();

	//--------------------------------------------------------------------------
	/**
	 * ヘッダ読み込み
	 * @return 成功すればtrue
	 */
	virtual bool readHeader();

	/**
	 * 読み込み
	 * @param buffer 読み込みバッファ
	 * @param size 読み込みサイズ
	 * @return 読み込んだサイズ。終端なら0、失敗すれば-1
	 */
	virtual int read(void* buffer, u_int size);

	//--------------------------------------------------------------------------
	/**
	 * ファイルがOggVorbisファイルか
	 * @param filePath ファイルパス
	 * @return OggVorbisファイルならtrue
	 */
	static bool isOggVorbisFileName(const FilePath& filePath){
		return filePath.getExtension().equals("ogg");
	}

private:
	/**
	 * コンストラクタ
	 * @param implement 実装
	 */
//	OggVorbisReader(OggVorbisReaderImpl* implement);

	// 実装クラス
	OggVorbisReaderImpl* implement_;

};

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