com.sun.prism

Interface MediaFrame

public interface MediaFrame

This interface describes a video image as received by the media stack. It is generally just a wrapper/shim for VideoDataBuffer to avoid dependency issues.

Method Summary

Modifier and Type	Method and Description
MediaFrame	convertToFormat(PixelFormat fmt) Converts the video frame to a different video format.
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.

Method Detail

getBufferForPlane

ByteBuffer getBufferForPlane(int plane)

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

getPixelFormat

PixelFormat getPixelFormat()

Returns:

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

getWidth

int getWidth()

Returns:

width in pixels of the video image contained in this frame

getHeight

int getHeight()

Returns:

height in pixels of the video image contained in this frame

getEncodedWidth

int getEncodedWidth()

Returns:

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

getEncodedHeight

int getEncodedHeight()

Returns:

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

planeCount

int planeCount()

Returns:

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

planeStrides

int[] planeStrides()

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.

Returns:

int array containing the line stride for each plane

strideForPlane

int strideForPlane(int planeIndex)

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.

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

MediaFrame convertToFormat(PixelFormat fmt)

Converts the video frame to a different video format.

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 releaseFrame() or it will leak.

Returns:

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

holdFrame

void holdFrame()

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.

releaseFrame

void releaseFrame()

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