main.java.ddf.minim.spi.AudioStream Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of minim Show documentation

A sound synthesis library for Java

The newest version!

/*
 *  Copyright (c) 2007 - 2008 by Damien Di Fede 
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Library General Public License as published
 *   by the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Library General Public License for more details.
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this program; if not, write to the Free Software
 *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

package ddf.minim.spi;

import ddf.minim.MultiChannelBuffer;

/**
 * An AudioStream is a stream of samples that is coming from 
 * somewhere. Users of an AudioStream don't really need to know
 * where the samples are coming from. However, typically they will be read 
 * from a Line or a file. An AudioStream needs to 
 * be opened before being used and closed when you are finished with it.
 * 
 * @author Damien Di Fede
 *
 */
public interface AudioStream extends AudioResource
{    
  /**
   * Reads the next sample frame.
   * 
   * @return an array of floats containing the value of each channel in the sample frame just read.
   * 		 The size of the returned array will be the same size as getFormat().getChannels(). 
   */
  @Deprecated
  float[] read();
  
  /**
   * Reads buffer.getBufferSize() sample frames and puts them into buffer's channels.
   * The provided buffer will be forced to have the same number of channels that this 
   * AudioStream does.
   * 
   * @param buffer The MultiChannelBuffer to fill with audio samples.
   * 
   * @return int: the number of sample frames that were actually read, could be smaller than the size of the buffer.
   */
  int read(MultiChannelBuffer buffer);
}