org.jcodec.codecs.raw

Class RAWVideoEncoder

java.lang.Object

org.jcodec.common.VideoEncoder

org.jcodec.codecs.raw.RAWVideoEncoder

public class RAWVideoEncoder
extends VideoEncoder

This class is part of JCodec ( www.jcodec.org ) This software is distributed under FreeBSD License Encodes image data into raw bytes according to the color space.

Author:

The JCodec project

Nested Class Summary

Nested classes/interfaces inherited from class org.jcodec.common.VideoEncoder

VideoEncoder.EncodedFrame

Constructor Summary

Constructors

Constructor and Description
RAWVideoEncoder()

Method Summary

Modifier and Type	Method and Description
VideoEncoder.EncodedFrame	encodeFrame(Picture pic, ByteBuffer _out) Encode one video frame.
int	estimateBufferSize(Picture frame) Estimate the output buffer size that will likely be needed for the current instance of encoder to encode a given frame.
ColorSpace[]	getSupportedColorSpaces() Native color spaces of this video encoder, i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

RAWVideoEncoder

public RAWVideoEncoder()

Method Detail

encodeFrame

public VideoEncoder.EncodedFrame encodeFrame(Picture pic,
                                             ByteBuffer _out)

Description copied from class: VideoEncoder

Encode one video frame.

Specified by:

encodeFrame in class VideoEncoder

Parameters:

pic - The video frame to be encoded. Must be in one of the encoder's native color spaces.

_out - The buffer to store the encoded frame into. Note, only the storage of this buffer is used, the position and limit are kept untouched. Instead the returned value contains a duplicate of this buffer with the position and limit set correctly to the boundaries of the encoded frame. This buffer must be large enough to hold the encoded frame. It is undefined what will happen if the buffer is not large enough. Most commonly some exception will be thrown.

Returns:

The bytes of an encoded frame with additional metadata. The bytes are located in the storage supplied by the buffer argument, no allocation happens.

getSupportedColorSpaces

public ColorSpace[] getSupportedColorSpaces()

Description copied from class: VideoEncoder

Native color spaces of this video encoder, i.e. the color space the video encoder uses internally to represent color. For example the native color space of an h.264 encoder is most commonly yuv420. This information is used to find the correct color transform. The encoder may return null which means that ANY color space will be taken. This is useful in some cases for instance for the raw video encoder.

Specified by:

getSupportedColorSpaces in class VideoEncoder

Returns:

The array of this encoder's native color spaces.

estimateBufferSize

public int estimateBufferSize(Picture frame)

Description copied from class: VideoEncoder

Estimate the output buffer size that will likely be needed for the current instance of encoder to encode a given frame. Note: expect a very coarse estimate that reflects the settings the encoder has been created with as well as the input frame size.

Specified by:

estimateBufferSize in class VideoEncoder

Parameters:

frame - A frame in question.

Returns:

The number of bytes the encoded frame will likely take.