org.jitsi.impl.neomedia.jmfext.media.protocol.directshow

Class DirectShowStream

java.lang.Object

org.jitsi.impl.neomedia.control.AbstractControls

org.jitsi.impl.neomedia.jmfext.media.protocol.AbstractPushBufferStream<DataSource>

org.jitsi.impl.neomedia.jmfext.media.protocol.directshow.DirectShowStream

All Implemented Interfaces:

javax.media.Controls, javax.media.protocol.PushBufferStream, javax.media.protocol.SourceStream

public class DirectShowStream
extends AbstractPushBufferStream<DataSource>

Implements a PushBufferStream using DirectShow.

Author:

Lyubomir Marinov, Sebastien Vincent

Field Summary

Fields

Modifier and Type	Field and Description
protected T	dataSource The DataSource which has created this instance and which contains it as one of its streams.
protected javax.media.control.FormatControl	formatControl The FormatControl which gives access to the Format of the media data provided by this SourceStream and which, optionally, allows setting it.

Fields inherited from class org.jitsi.impl.neomedia.jmfext.media.protocol.AbstractPushBufferStream

PUSH_BUFFER_STREAM_CLASS_NAME, transferHandler

Fields inherited from interface javax.media.protocol.SourceStream

LENGTH_UNKNOWN

Method Summary

Modifier and Type	Method and Description
void	close() Releases the resources used by this instance throughout its existence and makes it available for garbage collection.
protected javax.media.Format	doGetFormat() Gets the Format of this PushBufferStream as directly known by it.
protected javax.media.Format	doSetFormat(javax.media.Format format) Attempts to set the Format of this AbstractBufferStream.
boolean	endOfStream() Determines whether the end of this SourceStream has been reached.
javax.media.protocol.ContentDescriptor	getContentDescriptor() Gets a ContentDescriptor which describes the type of the content made available by this SourceStream.
long	getContentLength() Gets the length in bytes of the content made available by this SourceStream.
Object[]	getControls() Implements Controls.getControls().
javax.media.Format	getFormat() Gets the Format of the media data made available by this AbstractBufferStream.
void	read(javax.media.Buffer buffer) Reads media data from this PushBufferStream into a specific Buffer without blocking.
void	start() Starts the transfer of media data from this PushBufferStream.
void	stop() Stops the transfer of media data from this PushBufferStream.

Methods inherited from class org.jitsi.impl.neomedia.jmfext.media.protocol.AbstractPushBufferStream

setTransferHandler

Methods inherited from class org.jitsi.impl.neomedia.control.AbstractControls

getControl, getControl, queryInterface, queryInterface

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.media.protocol.PushBufferStream

getFormat

Methods inherited from interface javax.media.protocol.SourceStream

endOfStream, getContentDescriptor, getContentLength

Methods inherited from interface javax.media.Controls

getControl, getControls

Field Detail

dataSource

protected final T extends javax.media.protocol.DataSource dataSource

The DataSource which has created this instance and which contains it as one of its streams.

formatControl

protected final javax.media.control.FormatControl formatControl

The FormatControl which gives access to the Format of the media data provided by this SourceStream and which, optionally, allows setting it.

Method Detail

doGetFormat

protected javax.media.Format doGetFormat()

Gets the Format of this PushBufferStream as directly known by it.

Returns:

the Format of this PushBufferStream as directly known by it or null if this PushBufferStream does not directly know its Format and it relies on the PushBufferDataSource which created it to report its Format

doSetFormat

protected javax.media.Format doSetFormat(javax.media.Format format)

Attempts to set the Format of this AbstractBufferStream. Allows extenders to enable setting the Format of an existing AbstractBufferStream (in contract to setting it before the AbstractBufferStream is created by the DataSource which will provide it). Overrides the super implementation to enable setting the Format of this DirectShowStream after the DataSource which provides it has been connected.

Parameters:

format - the Format to be set as the format of this AbstractBufferStream

Returns:

the Format of this AbstractBufferStream or null if the attempt to set the Format did not succeed and any last-known Format is to be left in effect

read

public void read(javax.media.Buffer buffer)
          throws IOException

Reads media data from this PushBufferStream into a specific Buffer without blocking.

Parameters:

buffer - the Buffer in which media data is to be read from this PushBufferStream

Throws:

IOException - if anything goes wrong while reading media data from this PushBufferStream into the specified buffer

start

public void start()
           throws IOException

Starts the transfer of media data from this PushBufferStream.

Throws:

IOException - if anything goes wrong while starting the transfer of media data from this PushBufferStream

stop

public void stop()
          throws IOException

Stops the transfer of media data from this PushBufferStream.

Throws:

IOException - if anything goes wrong while stopping the transfer of media data from this PushBufferStream

close

public void close()

Releases the resources used by this instance throughout its existence and makes it available for garbage collection. This instance is considered unusable after closing.

Warning: The method is not invoked by the framework, extenders may choose to invoke it.

endOfStream

public boolean endOfStream()

Determines whether the end of this SourceStream has been reached. The AbstractBufferStream implementation always returns false.

Specified by:

endOfStream in interface javax.media.protocol.SourceStream

Returns:

true if the end of this SourceStream has been reached; otherwise, false

getContentDescriptor

public javax.media.protocol.ContentDescriptor getContentDescriptor()

Gets a ContentDescriptor which describes the type of the content made available by this SourceStream. The AbstractBufferStream implementation always returns a ContentDescriptor with content type equal to ContentDescriptor#RAW.

Specified by:

getContentDescriptor in interface javax.media.protocol.SourceStream

Returns:

a ContentDescriptor which describes the type of the content made available by this SourceStream

getContentLength

public long getContentLength()

Gets the length in bytes of the content made available by this SourceStream. The AbstractBufferStream implementation always returns LENGTH_UNKNOWN.

Specified by:

getContentLength in interface javax.media.protocol.SourceStream

Returns:

the length in bytes of the content made available by this SourceStream if it is known; otherwise, LENGTH_UKNOWN

getControls

public Object[] getControls()

Implements Controls.getControls(). Gets the controls available for this instance.

Specified by:

getControls in interface javax.media.Controls

Returns:

an array of Objects which represent the controls available for this instance

getFormat

public javax.media.Format getFormat()

Gets the Format of the media data made available by this AbstractBufferStream.

Returns:

the Format of the media data made available by this AbstractBufferStream