Package nzilbb.media.wav

Class SingleChannelAudioInputStream

java.lang.Object

java.io.InputStream

javax.sound.sampled.AudioInputStream

nzilbb.media.wav.SingleChannelAudioInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class SingleChannelAudioInputStream
extends AudioInputStream

Input stream that extracts a single selected channel from another input stream - i.e. read operations only return data for one stream (e.g. left channel only of a stereo recording).

Author:

Robert Fromont robert@fromont.net.nz

Constructor Summary

Constructors

Constructor	Description
SingleChannelAudioInputStream(AudioInputStream audioInputStream, int channel)	Constructor.

Method Summary

Modifier and Type	Method	Description
int	available()	Returns the maximum number of bytes that can be read (or skipped over) from this audio input stream without blocking.
void	close()	Closes this audio input stream and releases any system resources associated with the stream.
int	getChannel()	Getter for channel: Which channel to pass through, e.g. 0 for left, 1 for right.
long	getFrameLength()	Obtains the length of the audio data contained in the file, expressed in sample frames.
AudioInputStream	getInputStream()	InputStream accessor
void	mark(int nReadLimit)	Marks the current position in this audio input stream.
boolean	markSupported()	Tests whether this audio input stream supports the mark and reset methods.
int	read()
int	read(byte[] data, int offset, int length)
void	reset()	Repositions this audio input stream to the position it had at the time its mark method was last invoked.
SingleChannelAudioInputStream	setChannel(int newChannel)	Setter for channel: Which channel to pass through, e.g. 0 for left, 1 for right.
SingleChannelAudioInputStream	setInputStream(AudioInputStream newInputStream)	InputStream mutator
long	skip(long lLength)	Skips over and discards a specified number of bytes from this audio input stream.

Methods inherited from class javax.sound.sampled.AudioInputStream

getFormat, read

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleChannelAudioInputStream

public SingleChannelAudioInputStream(AudioInputStream audioInputStream,
                                     int channel)
                              throws IOException

Constructor.

Parameters:

channel - Which channel to pass through, e.g. 0 for left, 1 for right.

Throws:

IOException

Method Detail

getInputStream

public AudioInputStream getInputStream()

InputStream accessor

Returns:

The input stream that this is to truncate

setInputStream

public SingleChannelAudioInputStream setInputStream(AudioInputStream newInputStream)

InputStream mutator

Parameters:

newInputStream - The input stream that this is to truncate

getChannel

public int getChannel()

Getter for channel: Which channel to pass through, e.g. 0 for left, 1 for right.

Returns:

Which channel to pass through, e.g. 0 for left, 1 for right.

setChannel

public SingleChannelAudioInputStream setChannel(int newChannel)

Setter for channel: Which channel to pass through, e.g. 0 for left, 1 for right.

Parameters:

newChannel - Which channel to pass through, e.g. 0 for left, 1 for right.

read

public int read()
         throws IOException

Overrides:

read in class AudioInputStream

Throws:

IOException

read

public int read(byte[] data,
                int offset,
                int length)
         throws IOException

Overrides:

read in class AudioInputStream

Throws:

IOException

getFrameLength

public long getFrameLength()

Obtains the length of the audio data contained in the file, expressed in sample frames.

Overrides:

getFrameLength in class AudioInputStream

Returns:

the number of sample frames of audio data in the file

skip

public long skip(long lLength)
          throws IOException

Skips over and discards a specified number of bytes from this audio input stream.

Overrides:

skip in class AudioInputStream

Throws:

IOException

available

public int available()
              throws IOException

Returns the maximum number of bytes that can be read (or skipped over) from this audio input stream without blocking.

Overrides:

available in class AudioInputStream

Throws:

IOException

close

public void close()
           throws IOException

Closes this audio input stream and releases any system resources associated with the stream.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class AudioInputStream

Throws:

IOException

mark

public void mark(int nReadLimit)

Marks the current position in this audio input stream.

Overrides:

mark in class AudioInputStream

reset

public void reset()
           throws IOException

Repositions this audio input stream to the position it had at the time its mark method was last invoked.

Overrides:

reset in class AudioInputStream

Throws:

IOException

markSupported

public boolean markSupported()

Tests whether this audio input stream supports the mark and reset methods.

Overrides:

markSupported in class AudioInputStream