com.sun.javafx.media

Class PrismMediaFrameHandler.PrismFrameBuffer

java.lang.Object

com.sun.javafx.media.PrismMediaFrameHandler.PrismFrameBuffer

All Implemented Interfaces:

MediaFrame

Enclosing class:

PrismMediaFrameHandler

private class PrismMediaFrameHandler.PrismFrameBuffer
extends java.lang.Object
implements MediaFrame

Bridge class to avoid having to import JFXMedia into a bunch of prism code.

Field Summary

Fields

Modifier and Type	Field and Description
private VideoDataBuffer	master
private PixelFormat	videoFormat

Constructor Summary

Constructors

Constructor and Description
PrismFrameBuffer(VideoDataBuffer sourceBuffer)

Method Summary

Modifier and Type	Method and Description
MediaFrame	convertToFormat(PixelFormat fmt) Converts the video frame to a different video format.
java.nio.ByteBuffer	getBufferForPlane(int plane)
int	getEncodedHeight()
int	getEncodedWidth()
int	getHeight()
PixelFormat	getPixelFormat()
int	getWidth()
void	holdFrame() This method will prevent the frame from being deallocated or recycled.
int	planeCount()
int[]	planeStrides() The plane line stride is the number of bytes between two consecutive lines in the buffer.
void	releaseFrame() When you're finished with a video frame, call this to allow the media subsystem to deallocate or recycle the frame immediately.
int	strideForPlane(int planeIndex) The plane line stride is the number of bytes between two consecutive lines in the buffer.

Methods inherited from class java.lang.Object

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

Field Detail

videoFormat

private final PixelFormat videoFormat

master

private final VideoDataBuffer master

Constructor Detail

PrismFrameBuffer

public PrismFrameBuffer(VideoDataBuffer sourceBuffer)

Method Detail

getBufferForPlane

public java.nio.ByteBuffer getBufferForPlane(int plane)

Specified by:

getBufferForPlane in interface MediaFrame

Parameters:

plane - the numeric index of the plane, for chunky formats pass zero

Returns:

the ByteBuffer for the specified plane or null for non-existent planes

holdFrame

public void holdFrame()

Description copied from interface: MediaFrame

This method will prevent the frame from being deallocated or recycled. It is very important to balance the use of this method by calling releaseFrame when you're done with it otherwise the memory occupied by the frame will never be released which could lead to out of memory conditions.

Specified by:

holdFrame in interface MediaFrame

releaseFrame

public void releaseFrame()

Description copied from interface: MediaFrame

When you're finished with a video frame, call this to allow the media subsystem to deallocate or recycle the frame immediately.

Specified by:

releaseFrame in interface MediaFrame

getPixelFormat

public PixelFormat getPixelFormat()

Specified by:

getPixelFormat in interface MediaFrame

Returns:

PixelFormat describing how pixels are stored in this frame's buffer

getWidth

public int getWidth()

Specified by:

getWidth in interface MediaFrame

Returns:

width in pixels of the video image contained in this frame

getHeight

public int getHeight()

Specified by:

getHeight in interface MediaFrame

Returns:

height in pixels of the video image contained in this frame

getEncodedWidth

public int getEncodedWidth()

Specified by:

getEncodedWidth in interface MediaFrame

Returns:

width in pixels of the video image as produced by the video decoder

getEncodedHeight

public int getEncodedHeight()

Specified by:

getEncodedHeight in interface MediaFrame

Returns:

height in pixels of the video image as produced by the video decoder

planeCount

public int planeCount()

Specified by:

planeCount in interface MediaFrame

Returns:

the number of component planes, for packed formats this will always be one

planeStrides

public int[] planeStrides()

Description copied from interface: MediaFrame

The plane line stride is the number of bytes between two consecutive lines in the buffer. This number will vary depending on the frame's PixelFormat and decoder output.

Specified by:

planeStrides in interface MediaFrame

Returns:

int array containing the line stride for each plane

strideForPlane

public int strideForPlane(int planeIndex)

Description copied from interface: MediaFrame

The plane line stride is the number of bytes between two consecutive lines in the buffer. This number will vary depending on the frame's PixelFormat and decoder output.

Specified by:

strideForPlane in interface MediaFrame

Parameters:

planeIndex - which plane to get the stride for, valid range is zero to planeCount() non-inclusive

Returns:

the line stride for the specified plane

convertToFormat

public MediaFrame convertToFormat(PixelFormat fmt)

Description copied from interface: MediaFrame

Converts the video frame to a different video format.

Specified by:

convertToFormat in interface MediaFrame

Parameters:

fmt - The new video pixel format, if the same format is specified then the same frame will be returned. If a conversion is unsupported then this will return null. The converted frame must be released when you're done with it by calling MediaFrame.releaseFrame() or it will leak.

Returns:

valid MediaFrame in the specified format, or null if it cannot be converted