org.xiph.speex
Interface Decoder

All Known Implementing Classes:

NbDecoder, SbDecoder

public interface Decoder

Speex Decoder inteface, used as a base for the Narrowband and sideband decoders.

Version:

$Revision: 1.5 $

Author:

Jim Lawrence, helloNetwork.com, Marc Gimpel, Wimba S.A. (marc@wimba.com)

Method Summary

int	decode(Bits bits, float[] out) Decode the given input bits.
void	decodeStereo(float[] data, int frameSize) Decode the given bits to stereo.
boolean	getDtx() Returns whether or not we are using Discontinuous Transmission encoding.
float[]	getExc() Returns the excitation array.
int	getFrameSize() Returns the size of a frame.
float[]	getInnov() Returns the innovation array.
boolean	getPerceptualEnhancement() Returns whether perceptual enhancement is enabled or disabled.
float[]	getPiGain() Returns the Pitch Gain array.
void	setPerceptualEnhancement(boolean enhanced) Enables or disables perceptual enhancement.

Method Detail

decode

public int decode(Bits bits,
                  float[] out)
           throws java.io.StreamCorruptedException

Decode the given input bits.

Parameters:

bits - - Speex bits buffer.

out - - the decoded mono audio frame.

Returns:

1 if a terminator was found, 0 if not.

Throws:

java.io.StreamCorruptedException - If there is an error detected in the data stream.

decodeStereo

public void decodeStereo(float[] data,
                         int frameSize)

Decode the given bits to stereo.

Parameters:

data - - float array of size 2*frameSize, that contains the mono audio samples in the first half. When the function has completed, the array will contain the interlaced stereo audio samples.

frameSize - - the size of a frame of mono audio samples.

setPerceptualEnhancement

public void setPerceptualEnhancement(boolean enhanced)

Enables or disables perceptual enhancement.

Parameters:

enhanced -

getPerceptualEnhancement

public boolean getPerceptualEnhancement()

Returns whether perceptual enhancement is enabled or disabled.

Returns:

whether perceptual enhancement is enabled or disabled.

getFrameSize

public int getFrameSize()

Returns the size of a frame.

Returns:

the size of a frame.

getDtx

public boolean getDtx()

Returns whether or not we are using Discontinuous Transmission encoding.

Returns:

whether or not we are using Discontinuous Transmission encoding.

getPiGain

public float[] getPiGain()

Returns the Pitch Gain array.

Returns:

the Pitch Gain array.

getExc

public float[] getExc()

Returns the excitation array.

Returns:

the excitation array.

getInnov

public float[] getInnov()

Returns the innovation array.

Returns:

the innovation array.