1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

package tonfall.util
{
	import tonfall.format.IAudioDecoder;

	/**
	 * Defines a sheet of an instrument where keys are stored in a single audio file
	 * 
	 * [Check /load/piano.mp3 for instance]
	 * 
	 * @author Andre Michelle
	 */
	public interface ISoundSheet
	{
		/**
		 * @param note The note that should be played
		 * @return The nearest key availble in sheet
		 */
		function getNearestKeyIndexByNote( note: int ): int;
		
		/**
		 * @param keyIndex The index of the key in sheet
		 * @return The actual frequency of the key
		 */
		function getFrequencyByKeyIndex( keyIndex: int ): Number;
		
		/**
		 * @param keyIndex The index of the key in sheet
		 * @return The start position in samples 
		 */
		function getStartPositionFromKeyIndex( keyIndex: int ): Number;
		
		/**
		 * @param keyIndex The index of the key in sheet
		 * @return The end position in samples 
		 */
		function getEndPositionFromKeyIndex( keyIndex: int ): Number;
		
		/**
		 * @return The decoder where to read the sheet audio
		 */
		function get decoder(): IAudioDecoder;
	}
}