LiveInput.java

package ddf.minim.ugens;

import ddf.minim.UGen;
import ddf.minim.spi.AudioStream;

/**
 * LiveInput is a way to wrap an input stream with the UGen interface so that you can 
 * easily route incoming audio through a UGen graph. You can get an AudioStream that is 
 * reading audio input from Minim by calling Minim.getInputStream.
 * 
 * @example Synthesis/liveInputExample
 * 
 * @author Damien Di Fede
 * 
 * @related UGen
 * @related Minim
 *
 */

public class LiveInput extends UGen 
{
	private AudioStream mInputStream;

	/**
	 * Constructs a LiveInput that will read from inputStream.
	 * @param inputStream
	 * 			AudioStream: the audio stream this LiveInput will read from
	 */
	public LiveInput( AudioStream inputStream )
	{
		mInputStream = inputStream;
		inputStream.open();
	}
	
	/**
	 * Calling close will close the AudioStream that this wraps, 
	 * which is proper cleanup for using the stream.
	 */
	public void close()
	{
		mInputStream.close();
	}
	
	@Override
	protected void uGenerate(float[] channels) 
	{
		float[] samples = mInputStream.read();
		// TODO: say the input is mono and output is stereo, what should we do?
		// should we just copy like this and have the input come in the 
		// left side? Or should we somehow expand across the extra channels?
		// what about the opposite problem? stereo input to mono output?
		int length = ( samples.length >= channels.length ) ? channels.length : samples.length;
		System.arraycopy(samples, 0, channels, 0, length);
	}

}