org.jitsi.impl.neomedia.codec.audio.opus

Class JNIEncoder

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.audio.opus.JNIEncoder

All Implemented Interfaces:

javax.media.Codec, javax.media.Control, javax.media.Controls, javax.media.PlugIn, AdvancedAttributesAwareCodec, FormatParametersAwareCodec, PacketLossAwareEncoder

public class JNIEncoder
extends AbstractCodec2
implements FormatParametersAwareCodec, PacketLossAwareEncoder, AdvancedAttributesAwareCodec

Implements an Opus encoder.

Author:

Boris Grozev, Lyubomir Marinov

Field Summary

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 and Description
JNIEncoder() Initializes a new JNIEncoder instance.

Method Summary

Modifier and Type	Method and 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 inBuffer, javax.media.Buffer outBuffer) Processes (i.e.
Component	getControlComponent() Implements Control.getControlComponent().
javax.media.Format	getOutputFormat() Gets the Format of the media output by this Codec.
void	setAdvancedAttributes(Map<String,String> attributes) Sets the additional attributes to attributes
void	setExpectedPacketLoss(int percentage) Updates the encoder's expected packet loss percentage to the bigger of percentage and this.minPacketLoss.
void	setFormatParameters(Map<String,String> fmtps) Sets the format parameters.
javax.media.Format	setInputFormat(javax.media.Format format) Automatically tracks and calculates the size in bytes of an audio frame (to be) output by this instance.

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

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

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

checkInputBuffer, dump, getInputFormat, 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.PlugIn

reset

Methods inherited from interface javax.media.Controls

getControl, getControls

Constructor Detail

JNIEncoder

public JNIEncoder()

Initializes a new JNIEncoder instance.

Method Detail

doClose

protected void doClose()

Specified by:

doClose in class AbstractCodec2

See Also:

AbstractCodec2.doClose()

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

See Also:

AbstractCodec2.doOpen()

doProcess

protected int doProcess(javax.media.Buffer inBuffer,
                        javax.media.Buffer outBuffer)

Processes (i.e. encodes) a specific input Buffer.

Specified by:

doProcess in class AbstractCodec2

Parameters:

inBuffer - the Buffer from which the media to be encoded is to be read

outBuffer - the Buffer into which the encoded media is to be written

Returns:

BUFFER_PROCESSED_OK if the specified inBuffer has been processed successfully

See Also:

AbstractCodec2.doProcess(Buffer, Buffer)

getControlComponent

public Component getControlComponent()

Implements Control.getControlComponent(). JNIEncoder does not provide user interface of its own.

Specified by:

getControlComponent in interface javax.media.Control

Returns:

null to signify that JNIEncoder does not provide user interface of its own

getOutputFormat

public javax.media.Format getOutputFormat()

Gets the Format of the media output by this Codec.

Overrides:

getOutputFormat in class net.sf.fmj.media.AbstractCodec

Returns:

the Format of the media output by this Codec

See Also:

AbstractCodec.getOutputFormat()

setExpectedPacketLoss

public void setExpectedPacketLoss(int percentage)

Updates the encoder's expected packet loss percentage to the bigger of percentage and this.minPacketLoss.

Specified by:

setExpectedPacketLoss in interface PacketLossAwareEncoder

Parameters:

percentage - the expected packet loss percentage to set

setFormatParameters

public void setFormatParameters(Map<String,String> fmtps)

Sets the format parameters.

Specified by:

setFormatParameters in interface FormatParametersAwareCodec

Parameters:

fmtps - the format parameters to set

setInputFormat

public javax.media.Format setInputFormat(javax.media.Format format)

Automatically tracks and calculates the size in bytes of an audio frame (to be) output by this instance.

Specified by:

setInputFormat in interface javax.media.Codec

Overrides:

setInputFormat in class AbstractCodec2

setAdvancedAttributes

public void setAdvancedAttributes(Map<String,String> attributes)

Sets the additional attributes to attributes

Specified by:

setAdvancedAttributes in interface AdvancedAttributesAwareCodec

Parameters:

attributes - The additional attributes to set