NativeVideoBuffer

java.lang.Object
- com.sun.media.jfxmediaimpl.NativeVideoBuffer

All Implemented Interfaces:: VideoDataBuffer

final class NativeVideoBuffer
extends java.lang.Object
implements VideoDataBuffer

Native implementation of VideoDataBuffer

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class NativeVideoBuffer.VideoBufferDisposer

Nested Classes
Modifier and Type	Class and Description
`private static class`	`NativeVideoBuffer.VideoBufferDisposer`

Field Summary

Fields
Modifier and Type	Field and Description
`private NativeVideoBuffer`	`cachedBGRARep`
`private static boolean`	`DEBUG_DISPOSED_BUFFERS`
`private static NativeVideoBuffer.VideoBufferDisposer`	`disposer`
`private java.util.concurrent.atomic.AtomicInteger`	`holdCount`
`private long`	`nativePeer`

Fields inherited from interface com.sun.media.jfxmedia.control.VideoDataBuffer
PACKED_FORMAT_PLANE, YCBCR_PLANE_ALPHA, YCBCR_PLANE_CB, YCBCR_PLANE_CR, YCBCR_PLANE_LUMA

Constructor Summary

Constructors
Modifier Constructor and Description

private NativeVideoBuffer(long nativePeer)

Constructors
Modifier	Constructor and Description
`private`	`NativeVideoBuffer(long nativePeer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VideoDataBuffer`	`convertToFormat(VideoFormat newFormat)` Converts the video image to the specified format.
`static NativeVideoBuffer`	`createVideoBuffer(long nativePeer)`
`java.nio.ByteBuffer`	`getBufferForPlane(int plane)` Retrieve the data buffer for the specified plane.
`int`	`getEncodedHeight()` Gets the height of the image as created by the decoder, this may be larger than the display height.
`int`	`getEncodedWidth()` Gets the width of the image as created by the decoder, this may be larger than the display width.
`VideoFormat`	`getFormat()`
`int`	`getHeight()` Gets the height of the VideoDataBuffer
`int`	`getPlaneCount()`
`int[]`	`getPlaneStrides()`
`int`	`getStrideForPlane(int planeIndex)` Returns the number of bytes in each row of pixels for the specified plane.
`double`	`getTimestamp()` Retrieve the timestamp of the buffer.
`int`	`getWidth()` Gets the width of the VideoDataBuffer
`boolean`	`hasAlpha()` Determine if a video buffer has an alpha channel.
`void`	`holdFrame()` Place a hold on a buffer so that it cannot be reused by the buffer pool from whence it came.
`private long`	`nativeConvertToFormat(long handle, int formatType)`
`private static void`	`nativeDisposeBuffer(long handle)`
`private java.nio.ByteBuffer`	`nativeGetBufferForPlane(long handle, int plane)`
`private int`	`nativeGetEncodedHeight(long handle)`
`private int`	`nativeGetEncodedWidth(long handle)`
`private int`	`nativeGetFormat(long handle)`
`private int`	`nativeGetHeight(long handle)`
`private int`	`nativeGetPlaneCount(long handle)`
`private int[]`	`nativeGetPlaneStrides(long handle)`
`private double`	`nativeGetTimestamp(long handle)`
`private int`	`nativeGetWidth(long handle)`
`private boolean`	`nativeHasAlpha(long handle)`
`private void`	`nativeSetDirty(long handle)`
`void`	`releaseFrame()` Releases a hold previously placed on this frame.
`void`	`setDirty()` Flags a video buffer indicating the contents of the buffer have been updated and any cached representations need to be updated.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - nativePeer
```
private long nativePeer
```
  - holdCount
```
private final java.util.concurrent.atomic.AtomicInteger holdCount
```
  - cachedBGRARep
```
private NativeVideoBuffer cachedBGRARep
```
  - DEBUG_DISPOSED_BUFFERS
```
private static final boolean DEBUG_DISPOSED_BUFFERS
```
    See Also:
    
    Constant Field Values
  - disposer
```
private static final NativeVideoBuffer.VideoBufferDisposer disposer
```
- Constructor Detail
  - NativeVideoBuffer
```
private NativeVideoBuffer(long nativePeer)
```
- Method Detail
  - nativeDisposeBuffer
```
private static void nativeDisposeBuffer(long handle)
```
  - nativeGetTimestamp
```
private double nativeGetTimestamp(long handle)
```
  - nativeGetBufferForPlane
```
private java.nio.ByteBuffer nativeGetBufferForPlane(long handle,
                                                    int plane)
```
  - nativeGetWidth
```
private int nativeGetWidth(long handle)
```
  - nativeGetHeight
```
private int nativeGetHeight(long handle)
```
  - nativeGetEncodedWidth
```
private int nativeGetEncodedWidth(long handle)
```
  - nativeGetEncodedHeight
```
private int nativeGetEncodedHeight(long handle)
```
  - nativeGetFormat
```
private int nativeGetFormat(long handle)
```
  - nativeHasAlpha
```
private boolean nativeHasAlpha(long handle)
```
  - nativeGetPlaneCount
```
private int nativeGetPlaneCount(long handle)
```
  - nativeGetPlaneStrides
```
private int[] nativeGetPlaneStrides(long handle)
```
  - nativeConvertToFormat
```
private long nativeConvertToFormat(long handle,
                                   int formatType)
```
  - nativeSetDirty
```
private void nativeSetDirty(long handle)
```
  - createVideoBuffer
```
public static NativeVideoBuffer createVideoBuffer(long nativePeer)
```
  - holdFrame
```
public void holdFrame()
```
    Description copied from interface: VideoDataBuffer
    
    Place a hold on a buffer so that it cannot be reused by the buffer pool from whence it came. Holding a buffer too long may cause additional buffers to be allocated which will increase memory usage, so one should take care to release a frame as soon as possible.
    
    Specified by:
    
    holdFrame in interface VideoDataBuffer
  - releaseFrame
```
public void releaseFrame()
```
    Description copied from interface: VideoDataBuffer
    
    Releases a hold previously placed on this frame. When the hold count reaches zero then the frame will be disposed or reused, thus preventing memory allocation overhead.
    
    Specified by:
    
    releaseFrame in interface VideoDataBuffer
  - getTimestamp
```
public double getTimestamp()
```
    Description copied from interface: VideoDataBuffer
    
    Retrieve the timestamp of the buffer.
    
    Specified by:
    
    getTimestamp in interface VideoDataBuffer
    
    Returns:
    
    The buffer's timestamp.
  - getBufferForPlane
```
public java.nio.ByteBuffer getBufferForPlane(int plane)
```
    Description copied from interface: VideoDataBuffer
    
    Retrieve the data buffer for the specified plane. For chunky formats, pass PACKED_FORMAT_PLANE as the plane index. If an invalid plane index is passed this method returns null.
    
    Specified by:
    
    getBufferForPlane in interface VideoDataBuffer
    
    Parameters:
    
    plane - The numeric index of the plane
    
    Returns:
    
    the ByteBuffer containing video data for the specified plane or null for non-existent or invalid planes
  - getWidth
```
public int getWidth()
```
    Description copied from interface: VideoDataBuffer
    
    Gets the width of the VideoDataBuffer
    
    Specified by:
    
    getWidth in interface VideoDataBuffer
    
    Returns:
    
    the width of the buffer
  - getHeight
```
public int getHeight()
```
    Description copied from interface: VideoDataBuffer
    
    Gets the height of the VideoDataBuffer
    
    Specified by:
    
    getHeight in interface VideoDataBuffer
    
    Returns:
    
    the height
  - getEncodedWidth
```
public int getEncodedWidth()
```
    Description copied from interface: VideoDataBuffer
    
    Gets the width of the image as created by the decoder, this may be larger than the display width.
    
    Specified by:
    
    getEncodedWidth in interface VideoDataBuffer
    
    Returns:
    
    the number of pixels per row in the image
  - getEncodedHeight
```
public int getEncodedHeight()
```
    Description copied from interface: VideoDataBuffer
    
    Gets the height of the image as created by the decoder, this may be larger than the display height.
    
    Specified by:
    
    getEncodedHeight in interface VideoDataBuffer
    
    Returns:
    
    the number of rows in the image
  - getFormat
```
public VideoFormat getFormat()
```
    Specified by:
    
    getFormat in interface VideoDataBuffer
    
    Returns:
    
    the format of the videoDataBuffer
  - hasAlpha
```
public boolean hasAlpha()
```
    Description copied from interface: VideoDataBuffer
    
    Determine if a video buffer has an alpha channel. This merely determines if the buffer itself has an alpha channel, not if there is any transparency to the image.
    
    Specified by:
    
    hasAlpha in interface VideoDataBuffer
    
    Returns:
    
    true if an alpha channel is present
  - getPlaneCount
```
public int getPlaneCount()
```
    Specified by:
    
    getPlaneCount in interface VideoDataBuffer
    
    Returns:
    
    the number of planes this video buffer contains, or 1 for non-planar formats
  - getStrideForPlane
```
public int getStrideForPlane(int planeIndex)
```
    Description copied from interface: VideoDataBuffer
    
    Returns the number of bytes in each row of pixels for the specified plane.
    
    Specified by:
    
    getStrideForPlane in interface VideoDataBuffer
    
    Parameters:
    
    planeIndex - The numeric index of the plane.
    
    Returns:
    
    Number of bytes that comprises a single row of pixels in the specified plane. Will return zero if the plane is not in use.
  - getPlaneStrides
```
public int[] getPlaneStrides()
```
    Specified by:
    
    getPlaneStrides in interface VideoDataBuffer
    
    Returns:
    
    an array containing the plane strides for all planes
    
    See Also:
    
    getStrideForPlane
  - convertToFormat
```
public VideoDataBuffer convertToFormat(VideoFormat newFormat)
```
    Description copied from interface: VideoDataBuffer
    
    Converts the video image to the specified format. You can only convert TO either ARGB_PRE or BGRA_PRE, converting to YCbCr is not supported here. Once a conversion is done, a reference to the converted buffer is retained so that future conversions do not need to be performed.
    
    Specified by:
    
    convertToFormat in interface VideoDataBuffer
    
    Parameters:
    
    newFormat - the video format to convert to
    
    Returns:
    
    new buffer containing a converted copy of the source video image
  - setDirty
```
public void setDirty()
```
    Description copied from interface: VideoDataBuffer
    
    Flags a video buffer indicating the contents of the buffer have been updated and any cached representations need to be updated.
    
    Specified by:
    
    setDirty in interface VideoDataBuffer
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class NativeVideoBuffer

Nested Class Summary

Field Summary

Fields inherited from interface com.sun.media.jfxmedia.control.VideoDataBuffer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

nativePeer

holdCount

cachedBGRARep

DEBUG_DISPOSED_BUFFERS

disposer

Constructor Detail

NativeVideoBuffer

Method Detail

nativeDisposeBuffer

nativeGetTimestamp

nativeGetBufferForPlane

nativeGetWidth

nativeGetHeight

nativeGetEncodedWidth

nativeGetEncodedHeight

nativeGetFormat

nativeHasAlpha

nativeGetPlaneCount

nativeGetPlaneStrides

nativeConvertToFormat

nativeSetDirty

createVideoBuffer

holdFrame

releaseFrame

getTimestamp

getBufferForPlane

getWidth

getHeight

getEncodedWidth

getEncodedHeight

getFormat

hasAlpha

getPlaneCount

getStrideForPlane

getPlaneStrides

convertToFormat

setDirty

toString