Package org.xiph.speex

Class SbDecoder

java.lang.Object

org.xiph.speex.NbCodec

org.xiph.speex.SbCodec

org.xiph.speex.SbDecoder

All Implemented Interfaces:

Codebook, Decoder

public class SbDecoder
extends SbCodec
implements Decoder

Sideband Speex Decoder

Version:

$Revision: 1.3 $

Author:

Jim Lawrence, helloNetwork.com, Marc Gimpel, Wimba S.A. (mgimpel@horizonwimba.com)

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	enhanced
private float[]	innov2
protected Decoder	lowdec
protected Stereo	stereo

Fields inherited from class org.xiph.speex.SbCodec

foldingGain, fullFrameSize, g0_mem, g1_mem, high, QMF_ORDER, SB_FRAME_SIZE, SB_SUBMODE_BITS, SB_SUBMODES, x0d, y0, y1

Fields inherited from class org.xiph.speex.NbCodec

awk1, awk2, awk3, bufSize, dtx_enabled, exc_gain_quant_scal1, exc_gain_quant_scal3, excBuf, excIdx, filters, first, frameSize, frmBuf, frmIdx, gamma1, gamma2, innov, interp_qlpc, interp_qlsp, lag_factor, lpc, lpc_floor, lpcSize, m_lsp, max_pitch, mem_sp, min_pitch, NB_FRAME_SIZE, NB_SUBMODE_BITS, NB_SUBMODES, nbSubframes, old_qlsp, pi_gain, pre_mem, preemph, qlsp, subframeSize, submodeID, submodes, VERY_SMALL, voc_m1, voc_m2, voc_mean, voc_offset, windowSize

Fields inherited from interface org.xiph.speex.Codebook

cdbk_nb, cdbk_nb_high1, cdbk_nb_high2, cdbk_nb_low1, cdbk_nb_low2, exc_10_16_table, exc_10_32_table, exc_20_32_table, exc_5_256_table, exc_5_64_table, exc_8_128_table, gain_cdbk_lbr, gain_cdbk_nb, h0, h1, hexc_10_32_table, hexc_table, high_lsp_cdbk, high_lsp_cdbk2, NB_CDBK_SIZE, NB_CDBK_SIZE_HIGH1, NB_CDBK_SIZE_HIGH2, NB_CDBK_SIZE_LOW1, NB_CDBK_SIZE_LOW2

Constructor Summary

Constructors

Constructor	Description
SbDecoder()	Constructor

Method Summary

Modifier and Type	Method	Description
int	decode(Bits bits, float[] out)	Decode the given input bits.
int	decodeLost(float[] out, boolean dtx)	Decode when packets are lost.
void	decodeStereo(float[] data, int frameSize)	Decode the given bits to stereo.
boolean	getPerceptualEnhancement()	Returns whether perceptual enhancement is enabled or disabled.
void	init(int frameSize, int subframeSize, int lpcSize, int bufSize, float foldingGain)	Initialisation
void	setPerceptualEnhancement(boolean enhanced)	Enables or disables perceptual enhancement.
void	uwbinit()	Ultra-wideband initialisation
void	wbinit()	Wideband initialisation

Methods inherited from class org.xiph.speex.SbCodec

buildUwbSubModes, buildWbSubModes, getDtx, getExc, getFrameSize, getInnov

Methods inherited from class org.xiph.speex.NbCodec

getPiGain, init, nbinit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xiph.speex.Decoder

getDtx, getExc, getFrameSize, getInnov, getPiGain

Field Detail

lowdec

protected Decoder lowdec

stereo

protected Stereo stereo

enhanced

protected boolean enhanced

innov2

private float[] innov2

Constructor Detail

SbDecoder

public SbDecoder()

Constructor

Method Detail

wbinit

public void wbinit()

Wideband initialisation

Overrides:

wbinit in class SbCodec

uwbinit

public void uwbinit()

Ultra-wideband initialisation

Overrides:

uwbinit in class SbCodec

init

public void init(int frameSize,
                 int subframeSize,
                 int lpcSize,
                 int bufSize,
                 float foldingGain)

Initialisation

Overrides:

init in class SbCodec

Parameters:

frameSize -

subframeSize -

lpcSize -

bufSize -

foldingGain -

decode

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

Decode the given input bits.

Specified by:

decode in interface Decoder

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.

decodeLost

public int decodeLost(float[] out,
                      boolean dtx)

Decode when packets are lost.

Parameters:

out - - the generated mono audio frame.

dtx -

Returns:

0 if successful.

decodeStereo

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

Decode the given bits to stereo.

Specified by:

decodeStereo in interface Decoder

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.

Specified by:

setPerceptualEnhancement in interface Decoder

Parameters:

enhanced -

getPerceptualEnhancement

public boolean getPerceptualEnhancement()

Returns whether perceptual enhancement is enabled or disabled.

Specified by:

getPerceptualEnhancement in interface Decoder

Returns:

whether perceptual enhancement is enabled or disabled.