io.humble.video.awt

Interface MediaPictureConverter

public interface MediaPictureConverter

This interface describes a converter which can perform bidirectional translation between a given MediaPicture type and a BufferedImage type. Converters are created by MediaPictureConverterFactory. Each converter can translate between any supported io.humble.video.IPixelFormat.Type and a single BufferedImage type. Converters can optionally resize images during the conversion process.

Method Summary

Modifier and Type	Method and Description
void	delete() Release any resources used by this converter.
String	getDescription() Return a written description of the converter.
int	getImageType() Get the image type, as defined by BufferedImage, which this converter recognizes.
PixelFormat.Type	getPictureType() Get the picture type, as defined by PixelFormat.Type, which this converter recognizes.
BufferedImage	toImage(BufferedImage output, MediaPicture input) Converts an MediaPicture to a BufferedImage.
MediaPicture	toPicture(MediaPicture output, BufferedImage input, long timestamp) Converts a BufferedImage to an MediaPicture.
boolean	willResample() Test if this converter is going to re-sample during conversion.

Method Detail

getPictureType

PixelFormat.Type getPictureType()

Get the picture type, as defined by PixelFormat.Type, which this converter recognizes.

Returns:

the picture type of this converter.

See Also:

io.humble.video.IPixelFormat.Type

getImageType

int getImageType()

Get the image type, as defined by BufferedImage, which this converter recognizes.

Returns:

the image type of this converter.

See Also:

BufferedImage

willResample

boolean willResample()

Test if this converter is going to re-sample during conversion. For some conversions between BufferedImage and MediaPicture, the MediaPicture will need to be re-sampled into another pixel type, commonly between YUV and RGB types. This re-sample is time consuming, and may not be available for all installations of Humble Video.

Returns:

true if this converter will re-sample during conversion.

toPicture

MediaPicture toPicture(MediaPicture output,
                       BufferedImage input,
                       long timestamp)

Converts a BufferedImage to an MediaPicture.

Parameters:

output - the image to write the output to. any data previous in output will be overwritten. if null, a new output MediaPicture of the correct dimensions will be allocated and returned.

input - the source buffered image.

timestamp - the time stamp which should be attached to the the video picture (in microseconds).

Throws:

IllegalArgumentException - if the passed MediaPicture is not NULL but is of an unexpected width, height or format;

IllegalArgumentException - if the passed BufferedImage is NULL;

IllegalArgumentException - if the passed BufferedImage is not the correct type. See getImageType().

IllegalArgumentException - if the underlying data buffer of the BufferedImage is composed elements other bytes or integers.

toImage

BufferedImage toImage(BufferedImage output,
                      MediaPicture input)

Converts an MediaPicture to a BufferedImage.

Parameters:

output - the BufferedImage to copy data into, or if null, a new BufferedImage of the correct dimensions will be allocated.

input - the source video picture.

Throws:

IllegalArgumentException - if the passed BufferedImage is NOT NULL but has the wrong width, height or type;

IllegalArgumentException - if the passed MediaPicture is NULL;

IllegalArgumentException - if the passed MediaPicture is not the correct type. See getPictureType().

getDescription

String getDescription()

Return a written description of the converter.

Returns:

a detailed description of what this converter does.

delete

void delete()

Release any resources used by this converter. Calls to the converter after this call are illegal and may fail in unspecified ways.