//------------------------------------------------------------------------------
// 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 SOUND_LIST_H_
#define SOUND_LIST_H_

namespace Lamp{

class SoundCache;
class TextReader;

//------------------------------------------------------------------------------
/**
 * サウンドリスト
 *
 * テキストファイルからサウンドリストをサウンドキャッシュに読み込む。
 * 具体的にはサウンドファイルが置いてあるディレクトリに以下に示すフォーマットの
 * テキストファイルを配置する。その後、サウンドキャッシュのloadSoundList()
 * を使用してサウンドリストをロードします。
 * このファイルはエクセル等のツールで編集すると楽でしょう。<br>
 * <br>
 * <hr>
 * // 行頭の「//」コメントに対応している。 各要素はタブで区切る。<br>
 * //ファイル名	Stereo,3D	Once,Loop	Priority	MaxMixingCount	Min3DDistance
 * Max3DDistance<br>
 * muda	Stereo	Once	-1	0<br>
 * mudamuda	3D	Loop	100	16	5.73	76.5<br>
 * <hr>
 * ファイル名<br>
 * 　相対ファイル名を指定します。拡張子はサウンドキャッシュで指定すると
 * いいでしょう。<br>
 * <br>
 * Stereo,3D<br>
 * 　ステレオサウンドか3Dサウンドかを指定します。3Dサウンドはモノラルである必要が
 * あります。<br>
 * <br>
 * Once,Loop<br>
 * 　一回の再生かループ再生かを指定します。<br>
 * <br>
 * Priority<br>
 * 　優先度を32767〜-32768の範囲で指定します。どうしても鳴ってほしい音の優先度を
 * 上げましょう。<br>
 * <br>
 * MaxMixingCount<br>
 * 　最大同音同時発音数を指定します。0を指定するとサウンドキャッシュのデフォルト値を
 * 使用します<br>
 * <br>
 * Min3DDistance<br>
 *  3Dサウンドの最小距離を指定します。<br>
 * <br>
 * Max3DDistance<br>
 *  3Dサウンドの最大距離を指定します。<br>
 */
class SoundList{
public:
	/**
	 * ロード
	 * @param soundCache サウンドキャッシュ
	 * @param filePath ファイルパス
	 * @return 成功すればtrue
	 */
	static bool load(SoundCache* soundCache, const String& filePath);

	/**
	 * ロード
	 * @param soundCache サウンドキャッシュ
	 * @param textReader テキストリーダ
	 * @return 成功すればtrue
	 */
	static bool load(SoundCache* soundCache, TextReader* textReader);

	/**
	 * サウンドのロード
	 * @param soundCache サウンドキャッシュ
	 * @param line ロード文字列
	 * @return 成功すればtrue
	 */
	static bool loadSound(SoundCache* soundCache, const String& line);


private:
	// コンストラクタの隠蔽
	SoundList();

};

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

