lab5

Class Guitar

java.lang.Object

lab5.Guitar

public class Guitar
extends java.lang.Object

The Guitar class generates guitar sounds based on user input. In order to use this class correctly, one must create a Guitar object, add all of the desired notes to the object, and then call the play() method. The play() method will generate a list of samples for all of the notes to be played (by calling an internal method (jaffeSmith())) and then send them to the audio output stream.

Field Summary

Fields

Modifier and Type	Field and Description
private float	decayRate Decay rate
private static float	DEFAULT_DECAY_RATE Default decay rate
private static int	DEFAULT_SAMPLE_RATE Default sample rate in Hz
private static int	MAX_SAMPLE_RATE Maximum sample rate in Hz
private java.util.List<Note>	notes List of notes
private int	sampleRate Sample rate in samples per second

Constructor Summary

Constructors

Constructor and Description
Guitar() Constructs a new Guitar object with the default sample rate and decay rate.
Guitar(int sampleRate, float decayRate) Constructs a new Guitar object with the specified parameters.

Method Summary

Methods

Modifier and Type	Method and Description
void	addNote(Note note) Adds the specified note to this Guitar.
Note[]	getNotes() Returns an array containing all the notes in this Guitar.
private java.util.List<java.lang.Float>	jaffeSmith() Uses the Jaffe-Smith algorithm to generate the audio samples.
void	play() Generates the audio samples for the notes listed in the current Guitar object by calling the jaffeSmith algorithm and sends the samples to the speakers.
void	removeNote(int index) Removes the note at the specified index from this Guitar.
void	write(java.io.File file) Creates a new file and writes to that file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_SAMPLE_RATE

private static final int DEFAULT_SAMPLE_RATE

Default sample rate in Hz

See Also:

Constant Field Values

MAX_SAMPLE_RATE

private static final int MAX_SAMPLE_RATE

Maximum sample rate in Hz

See Also:

Constant Field Values

DEFAULT_DECAY_RATE

private static final float DEFAULT_DECAY_RATE

Default decay rate

See Also:

Constant Field Values

notes

private java.util.List<Note> notes

List of notes

sampleRate

private int sampleRate

Sample rate in samples per second

decayRate

private float decayRate

Decay rate

Constructor Detail

Guitar

public Guitar()

Constructs a new Guitar object with the default sample rate and decay rate.

Guitar

public Guitar(int sampleRate,
      float decayRate)

Constructs a new Guitar object with the specified parameters. If an invalid sampleRate or decayRate is specified, the default value will be used and an error message is sent to System.err.

Parameters:

sampleRate - sample rate (between 8000 Hz and 48000 Hz)

decayRate - decay rate (between 0.0f and 1.0f)

Method Detail

addNote

public void addNote(Note note)

Adds the specified note to this Guitar.

Parameters:

note - Note to be added.

play

public void play()
          throws javax.sound.sampled.LineUnavailableException,
                 java.io.IOException

Generates the audio samples for the notes listed in the current Guitar object by calling the jaffeSmith algorithm and sends the samples to the speakers.

Throws:

javax.sound.sampled.LineUnavailableException

java.io.IOException

jaffeSmith

private java.util.List<java.lang.Float> jaffeSmith()

Uses the Jaffe-Smith algorithm to generate the audio samples.
Implementation note:
Use Jaffe-Smith algorithm described on the assignment page to generate a sequence of samples for each note in the list of notes.

Returns:

List of samples comprising the pluck sound(s).

removeNote

public void removeNote(int index)

Removes the note at the specified index from this Guitar. OPTIONAL

Parameters:

index - Index of the note to be removed.

getNotes

public Note[] getNotes()

Returns an array containing all the notes in this Guitar. OPTIONAL

Returns:

An array of Notes in the Guitar object.

write

public void write(java.io.File file)
           throws java.io.IOException

Creates a new file and writes to that file. OPTIONAL

Parameters:

file - File to write to.

Throws:

java.io.IOException