org.jitsi.impl.neomedia.audiolevel.AudioLevelEffect2 Maven / Gradle / Ivy
/*
* Copyright @ 2015 Atlassian Pty Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jitsi.impl.neomedia.audiolevel;
import javax.media.*;
import javax.media.format.*;
import org.jitsi.impl.neomedia.control.*;
/**
* An {@link javax.media.Effect} implementation which calculates audio levels
* based on the samples in the Buffer and includes them in the
* buffer's headerExtension field in the SSRC audio level format
* specified in RFC6464.
*
* The class is based on
* {@link org.jitsi.impl.neomedia.audiolevel.AudioLevelEffect}, but an important
* difference is that the actual calculation is performed in the same thread
* that calls {@link #process(javax.media.Buffer, javax.media.Buffer)}.
*
* @author Boris Grozev
* @author Damian Minkov
* @author Emil Ivov
* @author Lyubomir Marinov
*/
public class AudioLevelEffect2
extends ControlsAdapter
implements Effect
{
/**
* The indicator which determines whether AudioLevelEffect
* instances are to perform the copying of the data from input
* Buffers to output Buffers themselves (e.g. using
* {@link System#arraycopy(Object, int, Object, int, int)}).
*/
private static final boolean COPY_DATA_FROM_INPUT_TO_OUTPUT = true;
/**
* The supported audio formats by this effect.
*/
private Format[] supportedAudioFormats;
/**
* Whether this effect is enabled or disabled. If disabled, this
* Effect will set the RTP header extension of the output buffer
* to null.
*/
private boolean enabled = false;
/**
* The ID of the RTP header extension for SSRC audio levels, which is to be
* added by this Effect.
*/
private byte rtpHeaderExtensionId = -1;
/**
* Initializes a new AudioLevelEffect2.
*/
public AudioLevelEffect2()
{
supportedAudioFormats
= new Format[]
{
new AudioFormat(
AudioFormat.LINEAR,
Format.NOT_SPECIFIED,
16,
1,
AudioFormat.LITTLE_ENDIAN,
AudioFormat.SIGNED,
16,
Format.NOT_SPECIFIED,
Format.byteArray)
};
}
/**
* Lists all of the input formats that this codec accepts.
*
* @return An array that contains the supported input Formats.
*/
public Format[] getSupportedInputFormats()
{
return supportedAudioFormats;
}
/**
* Lists the output formats that this codec can generate.
*
* @param input The Format of the data to be used as input to the
* plug-in.
* @return An array that contains the supported output Formats.
*/
public Format[] getSupportedOutputFormats(Format input)
{
return
new Format[]
{
new AudioFormat(
AudioFormat.LINEAR,
((AudioFormat)input).getSampleRate(),
16,
1,
AudioFormat.LITTLE_ENDIAN,
AudioFormat.SIGNED,
16,
Format.NOT_SPECIFIED,
Format.byteArray)
};
}
/**
* Sets the format of the data to be input to this codec.
*
* @param format The Format to be set.
* @return The Format that was set.
*/
public Format setInputFormat(Format format)
{
return (format instanceof AudioFormat) ? (AudioFormat) format : null;
}
/**
* Sets the format for the data this codec outputs.
*
* @param format The Format to be set.
* @return The Format that was set.
*/
public Format setOutputFormat(Format format)
{
return (format instanceof AudioFormat) ? (AudioFormat) format : null;
}
/**
* Performs the media processing defined by this codec.
*
* @param inputBuffer The Buffer that contains the media data to be
* processed.
* @param outputBuffer The Buffer in which to store the processed
* media data.
* @return BUFFER_PROCESSED_OK if the processing is successful.
* @see PlugIn
*/
public int process(Buffer inputBuffer, Buffer outputBuffer)
{
if (COPY_DATA_FROM_INPUT_TO_OUTPUT)
{
// Copy the actual data from the input to the output.
Object data = outputBuffer.getData();
int inputBufferLength = inputBuffer.getLength();
byte[] bufferData;
if ((data instanceof byte[]) &&
(((byte[])data).length >= inputBufferLength))
{
bufferData = (byte[])data;
}
else
{
bufferData = new byte[inputBufferLength];
outputBuffer.setData(bufferData);
}
outputBuffer.setLength(inputBufferLength);
outputBuffer.setOffset(0);
System.arraycopy(
inputBuffer.getData(), inputBuffer.getOffset(),
bufferData, 0,
inputBufferLength);
// Now copy the remaining attributes.
outputBuffer.setFormat(inputBuffer.getFormat());
outputBuffer.setHeader(inputBuffer.getHeader());
outputBuffer.setSequenceNumber(inputBuffer.getSequenceNumber());
outputBuffer.setTimeStamp(inputBuffer.getTimeStamp());
outputBuffer.setRtpTimeStamp(inputBuffer.getRtpTimeStamp());
outputBuffer.setFlags(inputBuffer.getFlags());
outputBuffer.setDiscard(inputBuffer.isDiscard());
outputBuffer.setEOM(inputBuffer.isEOM());
outputBuffer.setDuration(inputBuffer.getDuration());
}
else
{
outputBuffer.copy(inputBuffer);
}
Object data = outputBuffer.getData();
Buffer.RTPHeaderExtension ext = outputBuffer.getHeaderExtension();
if (enabled && rtpHeaderExtensionId != -1 && data instanceof byte[])
{
byte level
= AudioLevelCalculator.calculateAudioLevel(
(byte[]) data,
outputBuffer.getOffset(),
outputBuffer.getLength());
if (ext == null)
{
ext = new Buffer.RTPHeaderExtension(rtpHeaderExtensionId,
new byte[1]);
}
ext.id = rtpHeaderExtensionId;
if (ext.value == null || ext.value.length < 1)
ext.value = new byte[1];
ext.value[0] = level;
outputBuffer.setHeaderExtension(ext);
}
else
{
// Make sure that the output buffer doesn't retain the extension
// from a previous payload.
outputBuffer.setHeaderExtension(null);
}
return BUFFER_PROCESSED_OK;
}
/**
* Gets the name of this plug-in as a human-readable string.
*
* @return A String that contains the descriptive name of the
* plug-in.
*/
public String getName()
{
return "Audio Level Effect2";
}
/**
* {@inheritDoc}
*/
@Override
public void open()
{
}
/**
* {@inheritDoc}
*/
@Override
public void close()
{
}
/**
* {@inheritDoc}
*/
@Override
public void reset()
{
}
public boolean isEnabled()
{
return enabled;
}
/**
* Enables or disables this AudioLevelEffect2 according to the
* value of enabled.
* @param enabled whether to enable or disabled this Effect.
*/
public void setEnabled(boolean enabled)
{
this.enabled = enabled;
}
/**
* Sets the ID of the RTP header extension which will be added.
* @param rtpHeaderExtensionId the ID to set.
*/
public void setRtpHeaderExtensionId(byte rtpHeaderExtensionId)
{
this.rtpHeaderExtensionId = rtpHeaderExtensionId;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy