org.refcodes.audio.MonoSampleWriter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of refcodes-audio Show documentation

Artifact providing audio provessing functionality such as generating sine waves or writing raw audio samples to WAV files.

There is a newer version: 3.3.9

Show newest version

// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// /////////////////////////////////////////////////////////////////////////////
// This code is copyright (c) by Siegfried Steiner, Munich, Germany, distributed
// on an "AS IS" BASIS WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, and licen-
// sed under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// -----------------------------------------------------------------------------
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// -----------------------------------------------------------------------------
// Apache License, v2.0 ("http://www.apache.org/licenses/TEXT-2.0")
// -----------------------------------------------------------------------------
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////

package org.refcodes.audio;

import java.io.IOException;

/**
 * The {@link MonoSampleWriter} writes sound samples to a stream or a file.
 * 
 * @param  The {@link MonoSampleWriter} implementing this
 *        {@link MonoSampleWriter}.
 */
public interface MonoSampleWriter> extends SampleWriter {

	/**
	 * Writes the next samples, one sample for each channel. Provide one sample
	 * for mono audio, two samples for stereo audio and so on. In case you
	 * provide more or less samples than channels being supported by the writer,
	 * then it is up to the writer whether to duplicate the samples or calculate
	 * an average or the like.
	 *
	 * @param aSample The samples, one for each channel.
	 * 
	 * @throws IOException thrown in case writing the sample caused an I/O
	 *         related problem.
	 */
	void writeNext( double aSample ) throws IOException;

}