Package com.avpkit.core.video

Interface IConverter

All Known Implementing Classes:

AConverter, ArgbConverter, BgrConverter

public interface IConverter

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

Method Summary

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

Method Detail

getPictureType

IPixelFormat.Type getPictureType()

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

Returns:

the picture type of this converter.

See Also:

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 IVideoPicture, the IVideoPicture 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 AVPKit.

Returns:

true if this converter will re-sample during conversion.

See Also:

IVideoResampler, IVideoResampler.isSupported(com.avpkit.core.IVideoResampler.Feature)

toPicture

IVideoPicture toPicture(java.awt.image.BufferedImage image,
                        long timestamp)

Converts a BufferedImage to an IVideoPicture.

Parameters:

image - the source buffered image.

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

Throws:

java.lang.IllegalArgumentException - if the passed BufferedImage is NULL;

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

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

toImage

java.awt.image.BufferedImage toImage(IVideoPicture picture)

Converts an IVideoPicture to a BufferedImage.

Parameters:

picture - the source video picture.

Throws:

java.lang.IllegalArgumentException - if the passed IVideoPicture is NULL;

java.lang.IllegalArgumentException - if the passed IVideoPicture is not the correct type. See getPictureType().

getDescription

java.lang.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.