Package org.jitsi.impl.neomedia.codec

Class SilenceEffect

java.lang.Object

net.sf.fmj.media.AbstractControls

net.sf.fmj.media.AbstractPlugIn

net.sf.fmj.media.AbstractCodec

org.jitsi.impl.neomedia.codec.AbstractCodec2

org.jitsi.impl.neomedia.codec.SilenceEffect

All Implemented Interfaces:

javax.media.Codec, javax.media.Controls, javax.media.Effect, javax.media.PlugIn

public class SilenceEffect
extends AbstractCodec2
implements javax.media.Effect

An Effect which detects discontinuities in an audio stream by monitoring the input Buffers' timestamps and lengths, and inserts silence to account for missing data.

Author:

Boris Grozev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SilenceEffect.Listener

Field Summary

Fields

Modifier and Type	Field	Description
static javax.media.Format[]	SUPPORTED_FORMATS	The Formats supported as input/output by this Effect.

Fields inherited from class org.jitsi.impl.neomedia.codec.AbstractCodec2

BUFFER_FLAG_FEC, BUFFER_FLAG_PLC, EMPTY_FORMATS, features, MAX_AUDIO_SEQUENCE_NUMBERS_TO_PLC, SEQUENCE_MAX, SEQUENCE_MIN

Fields inherited from class net.sf.fmj.media.AbstractCodec

inputFormat, inputFormats, opened, outputFormat

Fields inherited from interface javax.media.PlugIn

BUFFER_PROCESSED_FAILED, BUFFER_PROCESSED_OK, INPUT_BUFFER_NOT_CONSUMED, OUTPUT_BUFFER_NOT_FILLED, PLUGIN_TERMINATED

Constructor Summary

Constructors

Constructor	Description
SilenceEffect()	Initializes a new SilenceEffect, which is to use the input Buffers' timestamps (as opposed to using their RTP timestamps).
SilenceEffect(int rtpClockRate)	Initializes a new SilenceEffect, which is to use the input Buffers' RTP timestamps.

Method Summary

Modifier and Type	Method	Description
protected void	doClose()
protected void	doOpen()	Opens this Codec and acquires the resources that it needs to operate.
protected int	doProcess(javax.media.Buffer inBuf, javax.media.Buffer outBuf)	Processes inBuf, and either copies its data to outBuf or copies silence
void	resetSilence()	Resets the state of this SilenceEffect.
void	setListener(SilenceEffect.Listener listener)

Methods inherited from class org.jitsi.impl.neomedia.codec.AbstractCodec2

calculateLostSeqNoCount, close, discardOutputBuffer, getMatchingOutputFormats, getName, getSupportedOutputFormats, incrementSeqNo, matches, open, process, setInputFormat, setOutputFormat, specialize, updateOutput, validateByteArraySize, validateShortArraySize

Methods inherited from class net.sf.fmj.media.AbstractCodec

checkInputBuffer, dump, getInputFormat, getOutputFormat, getSupportedInputFormats, isEOM, propagateEOM

Methods inherited from class net.sf.fmj.media.AbstractPlugIn

reset

Methods inherited from class net.sf.fmj.media.AbstractControls

addControl, getControl, getControls, removeControl

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.media.Codec

getSupportedInputFormats, getSupportedOutputFormats, process, setInputFormat, setOutputFormat

Methods inherited from interface javax.media.Controls

getControl, getControls

Methods inherited from interface javax.media.PlugIn

close, getName, open, reset

Field Detail

SUPPORTED_FORMATS

public static final javax.media.Format[] SUPPORTED_FORMATS

The Formats supported as input/output by this Effect.

Constructor Detail

SilenceEffect

public SilenceEffect()

Initializes a new SilenceEffect, which is to use the input Buffers' timestamps (as opposed to using their RTP timestamps).

SilenceEffect

public SilenceEffect(int rtpClockRate)

Initializes a new SilenceEffect, which is to use the input Buffers' RTP timestamps.

Parameters:

rtpClockRate - the clock rate that the RTP timestamps use.

Method Detail

doClose

protected void doClose()

Specified by:

doClose in class AbstractCodec2

doOpen

protected void doOpen()
               throws javax.media.ResourceUnavailableException

Opens this Codec and acquires the resources that it needs to operate. A call to PlugIn.open() on this instance will result in a call to doOpen only if AbstractCodec.opened is false. All required input and/or output formats are assumed to have been set on this Codec before doOpen is called.

Specified by:

doOpen in class AbstractCodec2

Throws:

javax.media.ResourceUnavailableException - if any of the resources that this Codec needs to operate cannot be acquired

doProcess

protected int doProcess(javax.media.Buffer inBuf,
                        javax.media.Buffer outBuf)

Processes inBuf, and either copies its data to outBuf or copies silence

Specified by:

doProcess in class AbstractCodec2

Parameters:

inBuf - the input Buffer.

outBuf - the output Buffer.

Returns:

BUFFER_PROCESSED_OK if inBuf's date was copied to outBuf, and INPUT_BUFFER_NOT_CONSUMED if silence was inserted instead.

resetSilence

public void resetSilence()

Resets the state of this SilenceEffect. TODO: is it appropriate to override the reset() method?

setListener

public void setListener(SilenceEffect.Listener listener)