/*
 * The MIT License
 *
 * Copyright 2013 Dra0211.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package kinugasa.contents.sound;

import kinugasa.contents.resource.Freeable;
import kinugasa.contents.resource.Nameable;
import kinugasa.contents.resource.NotYetLoadedException;
import kinugasa.util.annotations.CastReturnValue;

/**
 * サウンドファイルの再生や停止などの機能を抽象化するためのインターフェースです.
 * <br>
 * 全てのサウンドデータは、このインターフェースを実装する必要があります。<br>
 * 通常の実装では、ロードされていないサウンドに対する操作は、何も行いません。<br>
 * また、すでにロードされている場合に再度ロードすることはありません。<br>
 * <br>
 * サウンドの名前とは、通常は、パスを除いたファイル名となります。<br>
 * たとえば、hoge/piyo/fuga.wavの場合はfuga.wavが名前となります。<br>
 * <br>
 *
 *
 * @version 1.0.0 - 2013/01/13_18:44:36<br>
 * @author Dra0211<br>
 */
public interface Sound extends Freeable, Nameable {

	@Override
	public String getName();

	/**
	 * サウンドの再生を開始します.
	 * サウンドがループ機能をサポートしている場合は、設定によってはループ再生を開始します.<Br>
	 * サウンドが既に再生されている場合は何もしません.<br>
	 * 
	 * @throws NotYetLoadedException サウンドがロードされていない場合に投げることができます。<br>
	 */
	public void play() throws NotYetLoadedException;

	/**
	 * サウンドを最初まで巻き戻してから再度再生します.
	 * 通常はstopを呼び出した後にplayを呼び出します.<br>
	 */
	public void again();

	/**
	 * サウンドの現在のフレーム位置を返します.
	 * 
	 * @return 現在のフレーム位置.<br>
	 */
	public long getFramePosition();

	/**
	 * このサウンドのフレームの最大長を返します.
	 * 
	 * @return フレームの最大長.<br>
	 */
	public long getFrameLength();

	/**
	 * サウンドの再生を停止して最初まで巻き戻します.
	 */
	public void stop();

	/**
	 * サウンドの再生を一時停止します.
	 * 次回playが呼び出されたとき、pauseが呼ばれた位置から再生します.<br>
	 */
	public void pause();

	/**
	 * サウンドが再生中かを調べます.
	 * 
	 * @return 再生中の場合はtrue,そうでないか、ロードされていない場合はfalse.<Br>
	 */
	public boolean isRunning();

	/**
	 * サウンドの音量を設定します.
	 * 
	 * @param vol 新しい音量.0fで無音になる.<br>
	 */
	public void setVolume(float vol);

	@CastReturnValue
	@Override
	public Sound load();

	@CastReturnValue
	@Override
	public Sound free();

	@Override
	public boolean isLoaded();
}
