Interface SoundList

public interface SoundList

Method Summary

Modifier and Type	Method and Description
void	addEcho(float delay, float percent) Add an echo effect to the SoundList.
void	addSample(float sample) Add a single sample to the end of the SoundList.
void	addSample(float[] sample) Adds a single sample for each channel to the end of the SoundList.
void	changeSpeed(float percentChange) Change the speed of the sound.
void	changeVolume(float percentToChange, boolean allowClipping) Change the volume of all tracks in the sound list, by multiplying every value by the percent to change.
void	clip(float startTime, float endTime) Trim the SoundList, by removing all samples before the startTime, and all samples past the end time.
SoundList	clone() Returns a clone of this SoundList
void	combine(SoundList clipToCombine, boolean allowClipping) Combines this SoundList with a new SoundList, by adding the samples together.
void	fadeIn(float fadeDuration) Fade in.
void	fadeOut(float fadeDuration, float startTime) Fade out.
float	getDuration() Returns The duration of the sound, in seconds.
int	getNumChannels() The number of channels in the SoundList
int	getNumSamples() Returns the number of samples in the MusicList
float	getSampleRate() Returns the sample rate, in samples per second
java.util.Iterator<float[]>	iterator() Return an iterator that traverses the entire sample, returning an array floats (one for each channel)
java.util.Iterator<java.lang.Float>	iterator(int channel) Return an iterator that traverses a single channel of the list
void	makeMono(boolean allowClipping) Combine all channels into a single channel, by adding together all channels into a single channel.
void	reverse() Reverse the SoundList.
void	spliceIn(float startSpliceTime, SoundList clipToSplice) Splice a new SoundList into this soundList.
void	trimSilence(float maxLevel) Remove the silence at the front and back of the clip.

Method Detail

getNumChannels

int getNumChannels()

The number of channels in the SoundList

Returns:

The number f channels in the SoundList

getSampleRate

float getSampleRate()

Returns the sample rate, in samples per second

Returns:

The sample rate, in samples per second

getNumSamples

int getNumSamples()

Returns the number of samples in the MusicList

Returns:

The number of samples in the MusicList.

getDuration

float getDuration()

Returns The duration of the sound, in seconds.

Returns:

the duration of the sound, in seconds.

fadeIn

void fadeIn(float fadeDuration)

Fade in. Smoothly ramp the volume up for fadeDuration sections.

Parameters:

fadeDuration - The time (in seconds) to fade in.

fadeOut

void fadeOut(float fadeDuration,
             float startTime)

Fade out. Smoothly ramp the volume down for fadeDuration sections.

Parameters:

fadeDuration - The time (in seconds) to fade out.

startTime - The time (in seconds) to start to fade out

trimSilence

void trimSilence(float maxLevel)

Remove the silence at the front and back of the clip. All samples at the beginning of the clip whose absolute value is less than or equal to maxLevel are removed, until a sample whose absolute value is that is greater than maxLevel appears. Then retain all samples until the end, at which point all samples whose absolute value is less than or equal to maxLevel are removed. Note that a value greater than maxLevel on any channel is sufficient to keep the sample.

Parameters:

maxLevel - The level at which the sample is kept.

addEcho

void addEcho(float delay,
             float percent)

Add an echo effect to the SoundList.

Parameters:

delay - The time (in seconds) before the echo starts

percent - The percent falloff of the echo (0.5 is 50 percent volume, 0.25 is 25 percent volume, and so on. All samples should be clipped to the range -1 .. 1

reverse

void reverse()

Reverse the SoundList.

changeSpeed

void changeSpeed(float percentChange)

Change the speed of the sound.

Parameters:

percentChange - How much to change the speed. 1.0 is no change, 2.0 doubles the speed (and the pitch), 0.5 cuts the speed in half (and lowers the pitch) The sample rate should remain unchanged! This is probably the hardest function to implement in the entire project.

addSample

void addSample(float sample)

Add a single sample to the end of the SoundList. Throws an exception if the soundlist has more than 1 channel

Parameters:

sample - The sample to add

addSample

void addSample(float[] sample)

Adds a single sample for each channel to the end of the SoundList. Throws an exception if the size of the sample array is not the same as the number of channels in the sound list

Parameters:

sample - Array of samples (one for each channel) to add to the end of the SoundList

iterator

java.util.Iterator<float[]> iterator()

Return an iterator that traverses the entire sample, returning an array floats (one for each channel)

Returns:

iterator

changeVolume

void changeVolume(float percentToChange,
                  boolean allowClipping)

Change the volume of all tracks in the sound list, by multiplying every value by the percent to change. If allowClipping is true, values greater than 1.0 are set to 1.0, and values less than -1.0 are set to -1.0 If allowClipping is false, then if any values are greater than 1.0 or less than -1.0 in any clip, the entire sample is rescaled to fit in the range.

Parameters:

percentToChange - The percent to increase the volume. A value of 1 will leave the clip unchanged, 2.0 will make the volume twice as loud, and 0.5 will make the volume 50% as loud.

allowClipping - If allowClipping is true, then values greater than 1.0 or less than -1.0 after the volume change are clipped to fit in the range. If allowClipping is false, then if any values are greater than 1.0 or less than -1.0, the entire sample is rescaled to fit in the range.

iterator

java.util.Iterator<java.lang.Float> iterator(int channel)

Return an iterator that traverses a single channel of the list

Parameters:

channel - The channel to traverse

Returns:

the iterator to traverse the list

clip

void clip(float startTime,
          float endTime)

Trim the SoundList, by removing all samples before the startTime, and all samples past the end time. Note that if a SoundList represents an 8 second sound, and we call clip(4,7), the new SoundList will be a 3-second sound (from seconds 4-7 in the old SoundList)

Parameters:

startTime - Time to start (in seconds)

endTime - Time to end clip (as measured from the front of the original clip, in seconds)

spliceIn

void spliceIn(float startSpliceTime,
              SoundList clipToSplice)

Splice a new SoundList into this soundList. Both SoundLists will be modified. If the sampleRate of the clipToSplice is not the same as this SoundList, an exception is thrown.

Parameters:

startSpliceTime - Time to start the splice

clipToSplice - The other SoundClip to splice in.

makeMono

void makeMono(boolean allowClipping)

Combine all channels into a single channel, by adding together all channels into a single channel.

Parameters:

allowClipping - If allowClipping is true, then values greater than 1.0 or less than -1.0 after the addition are clipped to fit in the range. If allowClipping is false, then if any values are greater than 1.0 or less than -1.0, the entire sample is rescaled to fit in the range.

combine

void combine(SoundList clipToCombine,
             boolean allowClipping)

Combines this SoundList with a new SoundList, by adding the samples together. This SoundList is modified. If the sampleRate of the clipTocombine is not the same as this SoundList, an exception is thrown. If a SoundList of length 3 seconds and a SoundList of length 7 seconds are combined, the result will be a SoundList of 7 seconds.

Parameters:

clipToCombine - The clip to combine with this clip

allowClipping - If allowClipping is true, then values greater than 1.0 or less than -1.0 after the addition are clipped to fit in the range. If allowClipping is false, then the entire sample is rescaled

clone

SoundList clone()

Returns a clone of this SoundList

Returns:

The cloned SoundList