Module webrtc.java

Package dev.onvoid.webrtc.media.video

Class NativeI420Buffer

java.lang.Object

dev.onvoid.webrtc.internal.NativeObject

dev.onvoid.webrtc.internal.RefCountedObject

dev.onvoid.webrtc.media.video.NativeI420Buffer

All Implemented Interfaces:

dev.onvoid.webrtc.internal.RefCounted, I420Buffer, VideoFrameBuffer

public class NativeI420Buffer
extends dev.onvoid.webrtc.internal.RefCountedObject
implements I420Buffer

This class wraps the native WebRTC I420BufferInterface.

Method Summary

Modifier and Type	Method	Description
static NativeI420Buffer	allocate(int width, int height)	Allocates an empty I420Buffer suitable for an image of the given dimensions.
VideoFrameBuffer	cropAndScale(int cropX, int cropY, int cropWidth, int cropHeight, int scaleWidth, int scaleHeight)	Crops a region defined by |cropx|, |cropY|, |cropWidth| and |cropHeight|.
ByteBuffer	getDataU()	Returns a direct ByteBuffer containing U-plane data.
ByteBuffer	getDataV()	Returns a direct ByteBuffer containing V-plane data.
ByteBuffer	getDataY()	Returns a direct ByteBuffer containing Y-plane data.
int	getHeight()
int	getStrideU()
int	getStrideV()
int	getStrideY()
int	getWidth()	Resolution of the buffer in pixels.
I420Buffer	toI420()	Returns a memory-backed frame in I420 format.
String	toString()

Methods inherited from class dev.onvoid.webrtc.internal.RefCountedObject

release, retain

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.onvoid.webrtc.internal.RefCounted

release, retain

Method Detail

getDataY

public ByteBuffer getDataY()

Description copied from interface: I420Buffer

Returns a direct ByteBuffer containing Y-plane data. The buffer capacity is at least getStrideY() * getHeight() bytes. The position of the returned buffer is ignored and must be 0. Callers may mutate the ByteBuffer (eg. through relative-read operations), so implementations must return a new ByteBuffer or slice for each call.

Specified by:

getDataY in interface I420Buffer

getDataU

public ByteBuffer getDataU()

Description copied from interface: I420Buffer

Returns a direct ByteBuffer containing U-plane data. The buffer capacity is at least getStrideU() * ((getHeight() + 1) / 2) bytes. The position of the returned buffer is ignored and must be 0. Callers may mutate the ByteBuffer (eg. through relative-read operations), so implementations must return a new ByteBuffer or slice for each call.

Specified by:

getDataU in interface I420Buffer

getDataV

public ByteBuffer getDataV()

Description copied from interface: I420Buffer

Returns a direct ByteBuffer containing V-plane data. The buffer capacity is at least getStrideV() * ((getHeight() + 1) / 2) bytes. The position of the returned buffer is ignored and must be 0. Callers may mutate the ByteBuffer (eg. through relative-read operations), so implementations must return a new ByteBuffer or slice for each call.

Specified by:

getDataV in interface I420Buffer

getStrideY

public int getStrideY()

Specified by:

getStrideY in interface I420Buffer

getStrideU

public int getStrideU()

Specified by:

getStrideU in interface I420Buffer

getStrideV

public int getStrideV()

Specified by:

getStrideV in interface I420Buffer

getWidth

public int getWidth()

Description copied from interface: VideoFrameBuffer

Resolution of the buffer in pixels.

Specified by:

getWidth in interface VideoFrameBuffer

getHeight

public int getHeight()

Specified by:

getHeight in interface VideoFrameBuffer

toI420

public I420Buffer toI420()

Description copied from interface: VideoFrameBuffer

Returns a memory-backed frame in I420 format. If the pixel data is in another format, a conversion will take place. All implementations must provide a fallback to I420 for compatibility with e.g. the internal WebRTC software encoders.

Specified by:

toI420 in interface VideoFrameBuffer

cropAndScale

public VideoFrameBuffer cropAndScale(int cropX,
                                     int cropY,
                                     int cropWidth,
                                     int cropHeight,
                                     int scaleWidth,
                                     int scaleHeight)

Description copied from interface: VideoFrameBuffer

Crops a region defined by |cropx|, |cropY|, |cropWidth| and |cropHeight|. Scales it to size |scaleWidth| x |scaleHeight|.

Specified by:

cropAndScale in interface VideoFrameBuffer

toString

public String toString()

Overrides:

toString in class Object

allocate

public static NativeI420Buffer allocate(int width,
                                        int height)

Allocates an empty I420Buffer suitable for an image of the given dimensions.