Class PcmChannelDecoder

java.lang.Object

net.avadeaux.klipspringer.codec.PcmChannelDecoder

All Implemented Interfaces:

Closeable, AutoCloseable, AudioDecoder

public class PcmChannelDecoder
extends Object
implements AudioDecoder

Audio decoder that reads PCM data from a channel. Does not actually perform any decoding, but copies data verbatim from the channel. This is useful for wrapping input of raw PCM data, for instance from a WAV file with ofWav or a raw file by ofRaw.

Nested Class Summary

Nested classes/interfaces inherited from interface net.avadeaux.klipspringer.codec.AudioDecoder

AudioDecoder.PictureTarget, AudioDecoder.Target

Method Summary

Modifier and Type	Method	Description
void	close()	See Closeable.close().
boolean	decodeAll(long fromSampleNo)	Sends audio data to the target, one block at the time, starting from the given sample frame (zero to start at the beginning).
void	decodeMetadata()	Decodes metadata and sends it to the target, without writing any blocks.
static PcmChannelDecoder	ofRaw(ReadableByteChannel channel, PcmFormat format, long totalFrames, AudioDecoder.Target target)	Factory method that gets a decoder for reading raw PCM format data.
static PcmChannelDecoder	ofWav(SeekableByteChannel seekable, AudioDecoder.Target target)	Factory method that gets a decoder for reading PCM format data with a WAV header.
boolean	reusable()	Returns true if the underlying channel is seekable.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.avadeaux.klipspringer.codec.AudioDecoder

quality

Method Details

reusable

public boolean reusable()

Returns true if the underlying channel is seekable.

Specified by:

reusable in interface AudioDecoder

close

public void close()
           throws IOException

Description copied from interface: AudioDecoder

See Closeable.close().

Specified by:

close in interface AudioDecoder

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

decodeMetadata

public void decodeMetadata()
                    throws IOException

Description copied from interface: AudioDecoder

Decodes metadata and sends it to the target, without writing any blocks. Must be called at most once, and never after decodeAll. If this is not called, metadata gets sent to the target by decodeAll.

Specified by:

decodeMetadata in interface AudioDecoder

Throws:

IOException

decodeAll

public boolean decodeAll(long fromSampleNo)
                  throws IOException

Description copied from interface: AudioDecoder

Sends audio data to the target, one block at the time, starting from the given sample frame (zero to start at the beginning). If AudioDecoder.decodeMetadata() has not been called, metadata is sent to the target before the first block. Returns when the input is exhausted (in which case it returns true) or the target aborts decoding by returning false from write (in which case this method returns false). In either case, if this decoder is AudioDecoder.reusable(), decodeAll may be called again to once more decode part of the same file.

Specified by:

decodeAll in interface AudioDecoder

Throws:

IOException

ofRaw

public static PcmChannelDecoder ofRaw(ReadableByteChannel channel,
 PcmFormat format,
 long totalFrames,
 AudioDecoder.Target target)

Factory method that gets a decoder for reading raw PCM format data.

ofWav

public static PcmChannelDecoder ofWav(SeekableByteChannel seekable,
 AudioDecoder.Target target)
                               throws IOException

Factory method that gets a decoder for reading PCM format data with a WAV header.

Throws:

IOException