mirror of https://github.com/sipwise/jitsi.git
Implement desktop streaming capture device as a PullBufferCaptureDevice (rather than a PushBuffer ones). Reduce memory allocation by refactoring screencapture JNI.
Sebastien Vincent
16 years ago
parent
33374d3711
commit
6196c19805
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@ -0,0 +1,721 @@
|
||||
/*
|
||||
* SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
|
||||
*
|
||||
* Distributable under LGPL license.
|
||||
* See terms of license at gnu.org.
|
||||
*/
|
||||
package net.java.sip.communicator.impl.neomedia.jmfext.media.protocol;
|
||||
|
||||
import java.io.*;
|
||||
import java.lang.reflect.*;
|
||||
import java.util.*;
|
||||
|
||||
import javax.media.*;
|
||||
import javax.media.control.*;
|
||||
import javax.media.protocol.*;
|
||||
|
||||
import net.java.sip.communicator.impl.neomedia.control.*;
|
||||
import net.java.sip.communicator.util.*;
|
||||
|
||||
/**
|
||||
* Provides a base implementation of <tt>PullBufferDataSource</tt> and
|
||||
* <tt>CaptureDevice</tt> in order to facilitate implementers by taking care of
|
||||
* boilerplate in the most common cases.
|
||||
*
|
||||
* @author Lubomir Marinov
|
||||
*/
|
||||
public abstract class AbstractPullBufferCaptureDevice
|
||||
extends PullBufferDataSource
|
||||
implements CaptureDevice
|
||||
{
|
||||
|
||||
/**
|
||||
* The <tt>Logger</tt> used by the <tt>AbstractPullBufferCaptureDevice</tt>
|
||||
* class and its instances for logging output.
|
||||
*/
|
||||
private static final Logger logger
|
||||
= Logger.getLogger(AbstractPullBufferCaptureDevice.class);
|
||||
|
||||
/**
|
||||
* The value of the <tt>formatControls</tt> property of
|
||||
* <tt>AbstractPullBufferCaptureDevice</tt> which represents an empty array
|
||||
* of <tt>FormatControl</tt>s. Explicitly defined in order to reduce
|
||||
* unnecessary allocations.
|
||||
*/
|
||||
protected static final FormatControl[] EMPTY_FORMAT_CONTROLS
|
||||
= new FormatControl[0];
|
||||
|
||||
/**
|
||||
* The value of the <tt>streams</tt> property of
|
||||
* <tt>AbstractPullBufferCaptureDevice</tt> which represents an empty array
|
||||
* of <tt>PullBufferStream</tt>s. Explicitly defined in order to reduce
|
||||
* unnecessary allocations.
|
||||
*/
|
||||
protected static final PullBufferStream[] EMPTY_STREAMS
|
||||
= new PullBufferStream[0];
|
||||
|
||||
/**
|
||||
* The indicator which determines whether a connection to the media source
|
||||
* specified by the <tt>MediaLocator</tt> of this <tt>DataSource</tt> has
|
||||
* been opened.
|
||||
*/
|
||||
private boolean connected = false;
|
||||
|
||||
/**
|
||||
* The array of <tt>FormatControl</tt> instances each one of which can be
|
||||
* used before {@link #connect()} to get and set the capture <tt>Format</tt>
|
||||
* of each one of the capture streams.
|
||||
*/
|
||||
private FormatControl[] formatControls;
|
||||
|
||||
/**
|
||||
* The indicator which determines whether the transfer of media data from
|
||||
* this <tt>DataSource</tt> has been started.
|
||||
*/
|
||||
private boolean started = false;
|
||||
|
||||
/**
|
||||
* The <tt>PullBufferStream</tt>s through which this
|
||||
* <tt>PullBufferDataSource</tt> gives access to its media data.
|
||||
* <p>
|
||||
* Warning: Caution is advised when directly using the field and access to
|
||||
* it is to be synchronized with sync root <tt>this</tt>.
|
||||
* </p>
|
||||
*/
|
||||
protected AbstractPullBufferStream[] streams;
|
||||
|
||||
/**
|
||||
* Initializes a new <tt>AbstractPullBufferCaptureDevice</tt> instance.
|
||||
*/
|
||||
protected AbstractPullBufferCaptureDevice()
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes a new <tt>AbstractPullBufferCaptureDevice</tt> instance from
|
||||
* a specific <tt>MediaLocator</tt>.
|
||||
*
|
||||
* @param locator the <tt>MediaLocator</tt> to create the new instance from
|
||||
*/
|
||||
protected AbstractPullBufferCaptureDevice(MediaLocator locator)
|
||||
{
|
||||
setLocator(locator);
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens a connection to the media source specified by the
|
||||
* <tt>MediaLocator</tt> of this <tt>DataSource</tt>.
|
||||
*
|
||||
* @throws IOException if anything goes wrong while opening the connection
|
||||
* to the media source specified by the <tt>MediaLocator</tt> of this
|
||||
* <tt>DataSource</tt>
|
||||
*/
|
||||
public synchronized void connect()
|
||||
throws IOException
|
||||
{
|
||||
if (!connected)
|
||||
{
|
||||
doConnect();
|
||||
connected = true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new <tt>FormatControl</tt> instance which is to be associated
|
||||
* with a <tt>PullBufferStream</tt> at a specific zero-based index in the
|
||||
* list of streams of this <tt>PullBufferDataSource</tt>. As the
|
||||
* <tt>FormatControl</tt>s of a <tt>PullBufferDataSource</tt> can be
|
||||
* requested before {@link #connect()}, its <tt>PullBufferStream</tt>s may
|
||||
* not exist at the time of the request for the creation of the
|
||||
* <tt>FormatControl</tt>.
|
||||
*
|
||||
* @param streamIndex the zero-based index of the <tt>PullBufferStream</tt>
|
||||
* in the list of streams of this <tt>PullBufferDataSource</tt> which is to
|
||||
* be associated with the new <tt>FormatControl</tt> instance
|
||||
* @return a new <tt>FormatControl</tt> instance which is to be associated
|
||||
* with a <tt>PullBufferStream</tt> at the specified <tt>streamIndex</tt> in
|
||||
* the list of streams of this <tt>PullBufferDataSource</tt>
|
||||
*/
|
||||
protected FormatControl createFormatControl(final int streamIndex)
|
||||
{
|
||||
return
|
||||
new AbstractFormatControl()
|
||||
{
|
||||
/**
|
||||
* The <tt>Format</tt> of this <tt>FormatControl</tt> and,
|
||||
* respectively, of the media data of its owner.
|
||||
*/
|
||||
private Format format;
|
||||
|
||||
/**
|
||||
* Gets the <tt>Format</tt> of the media data of the owner of
|
||||
* this <tt>FormatControl</tt>.
|
||||
*
|
||||
* @return the <tt>Format</tt> of the media data of the owner of
|
||||
* this <tt>FormatControl</tt>
|
||||
*/
|
||||
public Format getFormat()
|
||||
{
|
||||
format
|
||||
= AbstractPullBufferCaptureDevice.this
|
||||
.internalGetFormat(streamIndex, format);
|
||||
return format;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the <tt>Format</tt>s in which the owner of this
|
||||
* <tt>FormatControl</tt> is capable of providing media data.
|
||||
*
|
||||
* @return an array of <tt>Format</tt>s in which the owner of
|
||||
* this <tt>FormatControl</tt> is capable of providing media
|
||||
* data
|
||||
*/
|
||||
public Format[] getSupportedFormats()
|
||||
{
|
||||
return
|
||||
AbstractPullBufferCaptureDevice.this
|
||||
.getSupportedFormats(streamIndex);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements {@link FormatControl#setFormat(Format)}. Attempts
|
||||
* to set the <tt>Format</tt> in which the owner of this
|
||||
* <tt>FormatControl</tt> is to provide media data.
|
||||
*
|
||||
* @param format the <tt>Format</tt> to be set on this instance
|
||||
* @return the currently set <tt>Format</tt> after the attempt
|
||||
* to set it on this instance if <tt>format</tt> is supported by
|
||||
* this instance and regardless of whether it was actually set;
|
||||
* <tt>null</tt> if <tt>format</tt> is not supported by this
|
||||
* instance
|
||||
*/
|
||||
@Override
|
||||
public Format setFormat(Format format)
|
||||
{
|
||||
Format setFormat = super.setFormat(format);
|
||||
|
||||
if (setFormat != null)
|
||||
{
|
||||
setFormat
|
||||
= AbstractPullBufferCaptureDevice.this
|
||||
.internalSetFormat(
|
||||
streamIndex,
|
||||
setFormat,
|
||||
format);
|
||||
if (setFormat != null)
|
||||
this.format = setFormat;
|
||||
}
|
||||
return setFormat;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates the <tt>FormatControl</tt>s of this <tt>CaptureDevice</tt>.
|
||||
*
|
||||
* @return an array of the <tt>FormatControl</tt>s of this
|
||||
* <tt>CaptureDevice</tt>
|
||||
*/
|
||||
protected FormatControl[] createFormatControls()
|
||||
{
|
||||
FormatControl formatControl = createFormatControl(0);
|
||||
|
||||
return
|
||||
(formatControl == null)
|
||||
? EMPTY_FORMAT_CONTROLS
|
||||
: new FormatControl[] { formatControl };
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new <tt>PullBufferStream</tt> which is to be at a specific
|
||||
* zero-based index in the list of streams of this
|
||||
* <tt>PullBufferDataSource</tt>. The <tt>Format</tt>-related information of
|
||||
* the new instance is to be abstracted by a specific
|
||||
* <tt>FormatControl</tt>.
|
||||
*
|
||||
* @param streamIndex the zero-based index of the <tt>PullBufferStream</tt>
|
||||
* in the list of streams of this <tt>PullBufferDataSource</tt>
|
||||
* @param formatControl the <tt>FormatControl</tt> which is to abstract the
|
||||
* <tt>Format</tt>-related information of the new instance
|
||||
* @return a new <tt>PullBufferStream</tt> which is to be at the specified
|
||||
* <tt>streamIndex</tt> in the list of streams of this
|
||||
* <tt>PullBufferDataSource</tt> and which has its <tt>Format</tt>-related
|
||||
* information abstracted by the specified <tt>formatControl</tt>
|
||||
*/
|
||||
protected abstract AbstractPullBufferStream createStream(
|
||||
int streamIndex,
|
||||
FormatControl formatControl);
|
||||
|
||||
/**
|
||||
* Closes the connection to the media source specified by the
|
||||
* <tt>MediaLocator</tt> of this <tt>DataSource</tt>. If such a connection
|
||||
* has not been opened, the call is ignored.
|
||||
*/
|
||||
public synchronized void disconnect()
|
||||
{
|
||||
try
|
||||
{
|
||||
stop();
|
||||
}
|
||||
catch (IOException ioex)
|
||||
{
|
||||
logger.error("Failed to stop " + getClass().getSimpleName(), ioex);
|
||||
}
|
||||
|
||||
if (connected)
|
||||
{
|
||||
doDisconnect();
|
||||
connected = false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Opens a connection to the media source specified by the
|
||||
* <tt>MediaLocator</tt> of this <tt>DataSource</tt>. Allows extenders to
|
||||
* override and be sure that there will be no request to open a connection
|
||||
* if the connection has already been opened.
|
||||
*
|
||||
* @throws IOException if anything goes wrong while opening the connection
|
||||
* to the media source specified by the <tt>MediaLocator</tt> of this
|
||||
* <tt>DataSource</tt>
|
||||
*/
|
||||
protected synchronized void doConnect()
|
||||
throws IOException
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* Closes the connection to the media source specified by the
|
||||
* <tt>MediaLocator</tt> of this <tt>DataSource</tt>. Allows extenders to
|
||||
* override and be sure that there will be no request to close a connection
|
||||
* if the connection has not been opened yet.
|
||||
*/
|
||||
protected synchronized void doDisconnect()
|
||||
{
|
||||
/*
|
||||
* While it is not clear whether the streams can be released upon
|
||||
* disconnect, com.imb.media.protocol.SuperCloneableDataSource gets the
|
||||
* streams of the DataSource it adapts (i.e. this DataSource when
|
||||
* SourceCloneable support is to be created for it) before #connect().
|
||||
* Unfortunately, it means that it isn't clear when the streams are to
|
||||
* be disposed.
|
||||
*/
|
||||
// if (streams != null)
|
||||
// try
|
||||
// {
|
||||
// for (AbstractPullBufferStream stream : streams)
|
||||
// stream.close();
|
||||
// }
|
||||
// finally
|
||||
// {
|
||||
// streams = null;
|
||||
// }
|
||||
}
|
||||
|
||||
/**
|
||||
* Starts the transfer of media data from this <tt>DataSource</tt>. Allows
|
||||
* extenders to override and be sure that there will be no request to start
|
||||
* the transfer of media data if it has already been started.
|
||||
*
|
||||
* @throws IOException if anything goes wrong while starting the transfer of
|
||||
* media data from this <tt>DataSource</tt>
|
||||
*/
|
||||
protected synchronized void doStart()
|
||||
throws IOException
|
||||
{
|
||||
if (streams != null)
|
||||
for (AbstractPullBufferStream stream : streams)
|
||||
stream.start();
|
||||
}
|
||||
|
||||
/**
|
||||
* Stops the transfer of media data from this <tt>DataSource</tt>. Allows
|
||||
* extenders to override and be sure that there will be no request to stop
|
||||
* the transfer of media data if it has not been started yet.
|
||||
*
|
||||
* @throws IOException if anything goes wrong while stopping the transfer of
|
||||
* media data from this <tt>DataSource</tt>
|
||||
*/
|
||||
protected synchronized void doStop()
|
||||
throws IOException
|
||||
{
|
||||
if (streams != null)
|
||||
for (AbstractPullBufferStream stream : streams)
|
||||
stream.stop();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the <tt>CaptureDeviceInfo</tt> of this <tt>CaptureDevice</tt> which
|
||||
* describes it.
|
||||
*
|
||||
* @return the <tt>CaptureDeviceInfo</tt> of this <tt>CaptureDevice</tt>
|
||||
* which describes it
|
||||
*/
|
||||
public CaptureDeviceInfo getCaptureDeviceInfo()
|
||||
{
|
||||
return getCaptureDeviceInfo(this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the <tt>CaptureDeviceInfo</tt> of a specific <tt>CaptureDevice</tt>
|
||||
* by locating its registration in JMF using its <tt>MediaLocator</tt>.
|
||||
*
|
||||
* @param captureDevice the <tt>CaptureDevice</tt> to gets the
|
||||
* <tt>CaptureDeviceInfo</tt> of
|
||||
* @return the <tt>CaptureDeviceInfo</tt> of the specified
|
||||
* <tt>CaptureDevice</tt> as registered in JMF
|
||||
*/
|
||||
public static CaptureDeviceInfo getCaptureDeviceInfo(
|
||||
DataSource captureDevice)
|
||||
{
|
||||
/*
|
||||
* TODO The implemented search for the CaptureDeviceInfo of this
|
||||
* CaptureDevice by looking for its MediaLocator is inefficient.
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
Vector<CaptureDeviceInfo> captureDeviceInfos
|
||||
= (Vector<CaptureDeviceInfo>)
|
||||
CaptureDeviceManager.getDeviceList(null);
|
||||
MediaLocator locator = captureDevice.getLocator();
|
||||
|
||||
for (CaptureDeviceInfo captureDeviceInfo : captureDeviceInfos)
|
||||
if (captureDeviceInfo.getLocator().equals(locator))
|
||||
return captureDeviceInfo;
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the content type of the media represented by this instance. The
|
||||
* <tt>AbstractPullBufferCaptureDevice</tt> implementation always returns
|
||||
* {@link ContentDescriptor#RAW}.
|
||||
*
|
||||
* @return the content type of the media represented by this instance
|
||||
*/
|
||||
public String getContentType()
|
||||
{
|
||||
return ContentDescriptor.RAW;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the control of the specified type available for this instance.
|
||||
*
|
||||
* @param controlType the type of the control available for this instance to
|
||||
* be retrieved
|
||||
* @return an <tt>Object</tt> which represents the control of the specified
|
||||
* type available for this instance if such a control is indeed available;
|
||||
* otherwise, <tt>null</tt>
|
||||
*/
|
||||
public Object getControl(String controlType)
|
||||
{
|
||||
return AbstractControls.getControl(this, controlType);
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements {@link Controls#getControls()}. Gets the controls available
|
||||
* for this instance.
|
||||
*
|
||||
* @return an array of <tt>Object</tt>s which represent the controls
|
||||
* available for this instance
|
||||
*/
|
||||
public Object[] getControls()
|
||||
{
|
||||
FormatControl[] formatControls = internalGetFormatControls();
|
||||
|
||||
if ((formatControls == null) || (formatControls.length == 0))
|
||||
return ControlsAdapter.EMPTY_CONTROLS;
|
||||
else
|
||||
{
|
||||
Object[] controls = new Object[formatControls.length];
|
||||
|
||||
System.arraycopy(
|
||||
formatControls,
|
||||
0,
|
||||
controls,
|
||||
0,
|
||||
formatControls.length);
|
||||
return controls;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the duration of the media represented by this instance. The
|
||||
* <tt>AbstractPullBufferCaptureDevice</tt> always returns
|
||||
* {@link #DURATION_UNBOUNDED}.
|
||||
*
|
||||
* @return the duration of the media represented by this instance
|
||||
*/
|
||||
public Time getDuration()
|
||||
{
|
||||
return DURATION_UNBOUNDED;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the <tt>Format</tt> to be reported by the <tt>FormatControl</tt> of
|
||||
* a <tt>PullBufferStream</tt> at a specific zero-based index in the list of
|
||||
* streams of this <tt>PullBufferDataSource</tt>. The
|
||||
* <tt>PullBufferStream</tt> may not exist at the time of requesting its
|
||||
* <tt>Format</tt>. Allows extenders to override the default behavior which
|
||||
* is to report any last-known format or the first <tt>Format</tt> from the
|
||||
* list of supported formats as defined in the JMF registration of this
|
||||
* <tt>CaptureDevice</tt>.
|
||||
*
|
||||
* @param streamIndex the zero-based index of the <tt>PullBufferStream</tt>
|
||||
* the <tt>Format</tt> of which is to be retrieved
|
||||
* @param oldValue the last-known <tt>Format</tt> for the
|
||||
* <tt>PullBufferStream</tt> at the specified <tt>streamIndex</tt>
|
||||
* @return the <tt>Format</tt> to be reported by the <tt>FormatControl</tt>
|
||||
* of the <tt>PullBufferStream</tt> at the specified <tt>streamIndex</tt> in
|
||||
* the list of streams of this <tt>PullBufferDataSource</tt>.
|
||||
*/
|
||||
protected Format getFormat(int streamIndex, Format oldValue)
|
||||
{
|
||||
if (oldValue != null)
|
||||
return oldValue;
|
||||
|
||||
Format[] supportedFormats = getSupportedFormats(streamIndex);
|
||||
|
||||
return
|
||||
((supportedFormats == null) || (supportedFormats.length < 1))
|
||||
? null
|
||||
: supportedFormats[0];
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets an array of <tt>FormatControl</tt> instances each one of which can
|
||||
* be used before {@link #connect()} to get and set the capture
|
||||
* <tt>Format</tt> of each one of the capture streams.
|
||||
*
|
||||
* @return an array of <tt>FormatControl</tt> instances each one of which
|
||||
* can be used before {@link #connect()} to get and set the capture
|
||||
* <tt>Format</tt> of each one of the capture streams
|
||||
*/
|
||||
public FormatControl[] getFormatControls()
|
||||
{
|
||||
return AbstractFormatControl.getFormatControls(this);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the <tt>PullBufferStream</tt>s through which this
|
||||
* <tt>PullBufferDataSource</tt> gives access to its media data.
|
||||
*
|
||||
* @return an array of the <tt>PullBufferStream</tt>s through which this
|
||||
* <tt>PullBufferDataSource</tt> gives access to its media data
|
||||
*/
|
||||
public synchronized PullBufferStream[] getStreams()
|
||||
{
|
||||
if (streams == null)
|
||||
{
|
||||
FormatControl[] formatControls = internalGetFormatControls();
|
||||
|
||||
if (formatControls != null)
|
||||
{
|
||||
int formatControlCount = formatControls.length;
|
||||
|
||||
streams = new AbstractPullBufferStream[formatControlCount];
|
||||
for (int i = 0; i < formatControlCount; i++)
|
||||
streams[i] = createStream(i, formatControls[i]);
|
||||
|
||||
/*
|
||||
* Start the streams if this DataSource has already been
|
||||
* started.
|
||||
*/
|
||||
if (started)
|
||||
for (AbstractPullBufferStream stream : streams)
|
||||
try
|
||||
{
|
||||
stream.start();
|
||||
}
|
||||
catch (IOException ioex)
|
||||
{
|
||||
throw new UndeclaredThrowableException(ioex);
|
||||
}
|
||||
}
|
||||
}
|
||||
if (streams == null)
|
||||
return EMPTY_STREAMS;
|
||||
else
|
||||
{
|
||||
PullBufferStream[] clone = new PullBufferStream[streams.length];
|
||||
|
||||
System.arraycopy(streams, 0, clone, 0, streams.length);
|
||||
return clone;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the <tt>Format</tt>s which are to be reported by a
|
||||
* <tt>FormatControl</tt> as supported formats for a
|
||||
* <tt>PullBufferStream</tt> at a specific zero-based index in the list of
|
||||
* streams of this <tt>PullBufferDataSource</tt>.
|
||||
*
|
||||
* @param streamIndex the zero-based index of the <tt>PullBufferStream</tt>
|
||||
* for which the specified <tt>FormatControl</tt> is to report the list of
|
||||
* supported <tt>Format</tt>s
|
||||
* @return an array of <tt>Format</tt>s to be reported by a
|
||||
* <tt>FormatControl</tt> as the supported formats for the
|
||||
* <tt>PullBufferStream</tt> at the specified <tt>streamIndex</tt> in the
|
||||
* list of streams of this <tt>PullBufferDataSource</tt>
|
||||
*/
|
||||
protected Format[] getSupportedFormats(int streamIndex)
|
||||
{
|
||||
CaptureDeviceInfo captureDeviceInfo = getCaptureDeviceInfo();
|
||||
|
||||
return
|
||||
(captureDeviceInfo == null) ? null : captureDeviceInfo.getFormats();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the <tt>Format</tt> to be reported by the <tt>FormatControl</tt> of
|
||||
* a <tt>PullBufferStream</tt> at a specific zero-based index in the list of
|
||||
* streams of this <tt>PullBufferDataSource</tt>. The
|
||||
* <tt>PullBufferStream</tt> may not exist at the time of requesting its
|
||||
* <tt>Format</tt>.
|
||||
*
|
||||
* @param streamIndex the zero-based index of the <tt>PullBufferStream</tt>
|
||||
* the <tt>Format</tt> of which is to be retrieved
|
||||
* @param oldValue the last-known <tt>Format</tt> for the
|
||||
* <tt>PullBufferStream</tt> at the specified <tt>streamIndex</tt>
|
||||
* @return the <tt>Format</tt> to be reported by the <tt>FormatControl</tt>
|
||||
* of the <tt>PullBufferStream</tt> at the specified <tt>streamIndex</tt> in
|
||||
* the list of streams of this <tt>PullBufferDataSource</tt>.
|
||||
*/
|
||||
private Format internalGetFormat(int streamIndex, Format oldValue)
|
||||
{
|
||||
synchronized (this)
|
||||
{
|
||||
if (streams != null)
|
||||
{
|
||||
AbstractPullBufferStream stream = streams[streamIndex];
|
||||
|
||||
if (stream != null)
|
||||
{
|
||||
Format streamFormat = stream.internalGetFormat();
|
||||
|
||||
if (streamFormat != null)
|
||||
return streamFormat;
|
||||
}
|
||||
}
|
||||
}
|
||||
return getFormat(streamIndex, oldValue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets an array of <tt>FormatControl</tt> instances each one of which can
|
||||
* be used before {@link #connect()} to get and set the capture
|
||||
* <tt>Format</tt> of each one of the capture streams.
|
||||
*
|
||||
* @return an array of <tt>FormatControl</tt> instances each one of which
|
||||
* can be used before {@link #connect()} to get and set the capture
|
||||
* <tt>Format</tt> of each one of the capture streams
|
||||
*/
|
||||
private synchronized FormatControl[] internalGetFormatControls()
|
||||
{
|
||||
if (formatControls == null)
|
||||
formatControls = createFormatControls();
|
||||
return formatControls;
|
||||
}
|
||||
|
||||
/**
|
||||
* Attempts to set the <tt>Format</tt> to be reported by the
|
||||
* <tt>FormatControl</tt> of a <tt>PullBufferStream</tt> at a specific
|
||||
* zero-based index in the list of streams of this
|
||||
* <tt>PullBufferDataSource</tt>.
|
||||
*
|
||||
* @param streamIndex the zero-based index of the <tt>PullBufferStream</tt>
|
||||
* the <tt>Format</tt> of which is to be set
|
||||
* @param oldValue the last-known <tt>Format</tt> for the
|
||||
* <tt>PullBufferStream</tt> at the specified <tt>streamIndex</tt>
|
||||
* @param newValue the <tt>Format</tt> which is to be set
|
||||
* @return the <tt>Format</tt> to be reported by the <tt>FormatControl</tt>
|
||||
* of the <tt>PullBufferStream</tt> at the specified <tt>streamIndex</tt>
|
||||
* in the list of streams of this <tt>PullBufferStream</tt> or <tt>null</tt>
|
||||
* if the attempt to set the <tt>Format</tt> did not success and any
|
||||
* last-known <tt>Format</tt> is to be left in effect
|
||||
*/
|
||||
private Format internalSetFormat(
|
||||
int streamIndex,
|
||||
Format oldValue,
|
||||
Format newValue)
|
||||
{
|
||||
synchronized (this)
|
||||
{
|
||||
if (streams != null)
|
||||
{
|
||||
AbstractPullBufferStream stream = streams[streamIndex];
|
||||
|
||||
if (stream != null)
|
||||
return stream.internalSetFormat(newValue);
|
||||
}
|
||||
}
|
||||
return setFormat(streamIndex, oldValue, newValue);
|
||||
}
|
||||
|
||||
/**
|
||||
* Attempts to set the <tt>Format</tt> to be reported by the
|
||||
* <tt>FormatControl</tt> of a <tt>PullBufferStream</tt> at a specific
|
||||
* zero-based index in the list of streams of this
|
||||
* <tt>PullBufferDataSource</tt>. The <tt>PullBufferStream</tt> does not
|
||||
* exist at the time of the attempt to set its <tt>Format</tt>. Allows
|
||||
* extenders to override the default behavior which is to not attempt to set
|
||||
* the specified <tt>Format</tt> so that they can enable setting the
|
||||
* <tt>Format</tt> prior to creating the <tt>PullBufferStream</tt>. If
|
||||
* setting the <tt>Format</tt> of an existing <tt>PullBufferStream</tt> is
|
||||
* desired, <tt>AbstractPullBufferStream#doSetFormat(Format)</tt> should be
|
||||
* overridden instead.
|
||||
*
|
||||
* @param streamIndex the zero-based index of the <tt>PullBufferStream</tt>
|
||||
* the <tt>Format</tt> of which is to be set
|
||||
* @param oldValue the last-known <tt>Format</tt> for the
|
||||
* <tt>PullBufferStream</tt> at the specified <tt>streamIndex</tt>
|
||||
* @param newValue the <tt>Format</tt> which is to be set
|
||||
* @return the <tt>Format</tt> to be reported by the <tt>FormatControl</tt>
|
||||
* of the <tt>PullBufferStream</tt> at the specified <tt>streamIndex</tt>
|
||||
* in the list of streams of this <tt>PullBufferStream</tt> or <tt>null</tt>
|
||||
* if the attempt to set the <tt>Format</tt> did not success and any
|
||||
* last-known <tt>Format</tt> is to be left in effect
|
||||
*/
|
||||
protected Format setFormat(
|
||||
int streamIndex,
|
||||
Format oldValue,
|
||||
Format newValue)
|
||||
{
|
||||
return oldValue;
|
||||
}
|
||||
|
||||
/**
|
||||
* Starts the transfer of media data from this <tt>DataSource</tt>
|
||||
*
|
||||
* @throws IOException if anything goes wrong while starting the transfer of
|
||||
* media data from this <tt>DataSource</tt>
|
||||
*/
|
||||
public synchronized void start()
|
||||
throws IOException
|
||||
{
|
||||
if (!started)
|
||||
{
|
||||
if (!connected)
|
||||
throw
|
||||
new IOException(
|
||||
getClass().getSimpleName() + " not connected");
|
||||
|
||||
doStart();
|
||||
started = true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Stops the transfer of media data from this <tt>DataSource</tt>.
|
||||
*
|
||||
* @throws IOException if anything goes wrong while stopping the transfer of
|
||||
* media data from this <tt>DataSource</tt>
|
||||
*/
|
||||
public synchronized void stop()
|
||||
throws IOException
|
||||
{
|
||||
if (started)
|
||||
{
|
||||
doStop();
|
||||
started = false;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,241 @@
|
||||
/*
|
||||
* SIP Communicator, the OpenSource Java VoIP and Instant Messaging client.
|
||||
*
|
||||
* Distributable under LGPL license.
|
||||
* See terms of license at gnu.org.
|
||||
*/
|
||||
package net.java.sip.communicator.impl.neomedia.jmfext.media.protocol;
|
||||
|
||||
import java.io.*;
|
||||
|
||||
import javax.media.*;
|
||||
import javax.media.control.*;
|
||||
import javax.media.protocol.*;
|
||||
|
||||
import net.java.sip.communicator.impl.neomedia.control.*;
|
||||
import net.java.sip.communicator.util.*;
|
||||
|
||||
/**
|
||||
* Provides a base implementation of <tt>PullBufferStream</tt> in order to
|
||||
* facilitate implementers by taking care of boilerplate in the most common
|
||||
* cases.
|
||||
*
|
||||
* @author Lubomir Marinov
|
||||
*/
|
||||
public abstract class AbstractPullBufferStream
|
||||
extends AbstractControls
|
||||
implements PullBufferStream
|
||||
{
|
||||
|
||||
/**
|
||||
* The <tt>Logger</tt> used by the <tt>AbstractPullBufferStream</tt> class
|
||||
* and its instances for logging output.
|
||||
*/
|
||||
private static final Logger logger
|
||||
= Logger.getLogger(AbstractPullBufferStream.class);
|
||||
|
||||
/**
|
||||
* The (default) <tt>ContentDescriptor</tt> of the
|
||||
* <tt>AbstractPullBufferStream</tt> instances.
|
||||
*/
|
||||
private static final ContentDescriptor CONTENT_DESCRIPTOR
|
||||
= new ContentDescriptor(ContentDescriptor.RAW);
|
||||
|
||||
/**
|
||||
* The <tt>FormatControl</tt> which gives access to the <tt>Format</tt> of
|
||||
* the media data provided by this <tt>SourceStream</tt> and which,
|
||||
* optionally, allows setting it.
|
||||
*/
|
||||
private final FormatControl formatControl;
|
||||
|
||||
/**
|
||||
* Initializes a new <tt>AbstractPullBufferStream</tt> instance which is to
|
||||
* have its <tt>Format</tt>-related information abstracted by a specific
|
||||
* <tt>FormatControl</tt>.
|
||||
*
|
||||
* @param formatControl the <tt>FormatControl</tt> which is to abstract the
|
||||
* <tt>Format</tt>-related information of the new instance
|
||||
*/
|
||||
protected AbstractPullBufferStream(FormatControl formatControl)
|
||||
{
|
||||
this.formatControl = formatControl;
|
||||
}
|
||||
|
||||
/**
|
||||
* Releases the resources used by this instance throughout its existence and
|
||||
* makes it available for garbage collection. This instance is considered
|
||||
* unusable after closing.
|
||||
*/
|
||||
public void close()
|
||||
{
|
||||
try
|
||||
{
|
||||
stop();
|
||||
}
|
||||
catch (IOException ioex)
|
||||
{
|
||||
logger.error("Failed to stop " + getClass().getSimpleName(), ioex);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the <tt>Format</tt> of this <tt>PullBufferStream</tt> as directly
|
||||
* known by it. Allows extenders to override the <tt>Format</tt> known to
|
||||
* the <tt>PullBufferDataSource</tt> which created this instance and
|
||||
* possibly provide more details on the currently set <tt>Format</tt>.
|
||||
*
|
||||
* @return the <tt>Format</tt> of this <tt>PullBufferStream</tt> as directly
|
||||
* known by it or <tt>null</tt> if this <tt>PullBufferStream</tt> does not
|
||||
* directly know its <tt>Format</tt> and it relies on the
|
||||
* <tt>PullBufferDataSource</tt> which created it to report its
|
||||
* <tt>Format</tt>
|
||||
*/
|
||||
protected Format doGetFormat()
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Attempts to set the <tt>Format</tt> of this <tt>PullBufferStream</tt>.
|
||||
* Allows extenders to enable setting the <tt>Format</tt> of an existing
|
||||
* <tt>PullBufferStream</tt> (in contract to setting it before the
|
||||
* <tt>PullBufferStream</tt> is created by the <tt>PullBufferDataSource</tt>
|
||||
* which will provide it).
|
||||
*
|
||||
* @param format the <tt>Format</tt> to be set as the format of this
|
||||
* <tt>PullBufferStream</tt>
|
||||
* @return the <tt>Format</tt> of this <tt>PullBufferStream</tt> or
|
||||
* <tt>null</tt> if the attempt to set the <tt>Format</tt> did not succeed
|
||||
* and any last-known <tt>Format</tt> is to be left in effect
|
||||
*/
|
||||
protected Format doSetFormat(Format format)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines whether the end of this <tt>SourceStream</tt> has been
|
||||
* reached. The <tt>AbstractPullBufferStream</tt> implementation always
|
||||
* returns <tt>false</tt>.
|
||||
*
|
||||
* @return <tt>true</tt> if the end of this <tt>SourceStream</tt> has been
|
||||
* reached; otherwise, <tt>false</tt>
|
||||
*/
|
||||
public boolean endOfStream()
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines if read will block.
|
||||
*
|
||||
* @return <tt>true</tt> if read block, <tt>false</tt> otherwise
|
||||
*/
|
||||
public boolean willReadBlock()
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a <tt>ContentDescriptor</tt> which describes the type of the content
|
||||
* made available by this <tt>SourceStream</tt>. The
|
||||
* <tt>AbstractPullBufferStream</tt> implementation always returns a
|
||||
* <tt>ContentDescriptor</tt> with content type equal to
|
||||
* <tt>ContentDescriptor#RAW</tt>.
|
||||
*
|
||||
* @return a <tt>ContentDescriptor</tt> which describes the type of the
|
||||
* content made available by this <tt>SourceStream</tt>
|
||||
*/
|
||||
public ContentDescriptor getContentDescriptor()
|
||||
{
|
||||
return CONTENT_DESCRIPTOR;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the length in bytes of the content made available by this
|
||||
* <tt>SourceStream</tt>. The <tt>AbstractPullBufferStream</tt>
|
||||
* implementation always returns <tt>LENGTH_UNKNOWN</tt>.
|
||||
*
|
||||
* @return the length in bytes of the content made available by this
|
||||
* <tt>SourceStream</tt> if it is known; otherwise, <tt>LENGTH_UKNOWN</tt>
|
||||
*/
|
||||
public long getContentLength()
|
||||
{
|
||||
return LENGTH_UNKNOWN;
|
||||
}
|
||||
|
||||
/**
|
||||
* Implements {@link Controls#getControls()}. Gets the controls available
|
||||
* for this instance.
|
||||
*
|
||||
* @return an array of <tt>Object</tt>s which represent the controls
|
||||
* available for this instance
|
||||
*/
|
||||
public Object[] getControls()
|
||||
{
|
||||
if (formatControl != null)
|
||||
return new Object[] { formatControl };
|
||||
else
|
||||
return ControlsAdapter.EMPTY_CONTROLS;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the <tt>Format</tt> of the media data made available by this
|
||||
* <tt>PullBufferStream</tt>.
|
||||
*
|
||||
* @return the <tt>Format</tt> of the media data made available by this
|
||||
* <tt>PullBufferStream</tt>
|
||||
*/
|
||||
public Format getFormat()
|
||||
{
|
||||
return (formatControl == null) ? null : formatControl.getFormat();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the <tt>Format</tt> of this <tt>PullBufferStream</tt> as directly
|
||||
* known by it.
|
||||
*
|
||||
* @return the <tt>Format</tt> of this <tt>PullBufferStream</tt> as directly
|
||||
* known by it
|
||||
*/
|
||||
Format internalGetFormat()
|
||||
{
|
||||
return doGetFormat();
|
||||
}
|
||||
|
||||
/**
|
||||
* Attempts to set the <tt>Format</tt> of this <tt>PullBufferStream</tt>.
|
||||
*
|
||||
* @param format the <tt>Format</tt> to be set as the format of this
|
||||
* <tt>PullBufferStream</tt>
|
||||
* @return the <tt>Format</tt> of this <tt>PullBufferStream</tt> or
|
||||
* <tt>null</tt> if the attempt to set the <tt>Format</tt> did not succeed
|
||||
* and any last-known <tt>Format</tt> is to be left in effect
|
||||
*/
|
||||
Format internalSetFormat(Format format)
|
||||
{
|
||||
return doSetFormat(format);
|
||||
}
|
||||
|
||||
/**
|
||||
* Starts the transfer of media data from this <tt>PullBufferStream</tt>.
|
||||
*
|
||||
* @throws IOException if anything goes wrong while starting the transfer of
|
||||
* media data from this <tt>PullBufferStream</tt>
|
||||
*/
|
||||
public void start()
|
||||
throws IOException
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* Stops the transfer of media data from this <tt>PullBufferStream</tt>.
|
||||
*
|
||||
* @throws IOException if anything goes wrong while stopping the transfer of
|
||||
* media data from this <tt>PullBufferStream</tt>
|
||||
*/
|
||||
public void stop()
|
||||
throws IOException
|
||||
{
|
||||
}
|
||||
}
|
||||
Loading…
Reference in new issue