io.humble.video.awt

Class MediaPictureConverterFactory

java.lang.Object

io.humble.video.awt.MediaPictureConverterFactory

public class MediaPictureConverterFactory
extends Object

This factory class creates MediaPictureConverter objects for translation between a number of MediaPicture and BufferedImage types. Not all image and picture types are supported. When an unsupported converter is requested, a descriptive UnsupportedOperationException is thrown.

Each converter can translate between any supported PixelFormat.Type and a single BufferedImage type. Converters can optionally resize during the conversion process.

Each converter will re-sample the MediaPicture it is converting to get the data in the same native byte layout as a BufferedImage if needed (using MediaPictureResampler). This step takes time and creates a new temporary copy of the image data. To avoid this step you can make sure the MediaPicture#getPixelType() is of the same binary type as a BufferedImage.

Put another way, if you're converting to BufferedImage.TYPE_3BYTE_BGR, we will not resample if the MediaPicture#getPixelType() is io.humble.video.PixelFormat.Type#BGR24.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MediaPictureConverterFactory.Type This class describes a converter type and is used to register and unregister types with MediaPictureConverterFactory.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HUMBLE_BGR_24 Converts between MediaPictures and BufferedImage of type BufferedImage.TYPE_3BYTE_BGR

Method Summary

Modifier and Type	Method and Description
static BufferedImage	convertToType(BufferedImage sourceImage, int targetType) Convert a BufferedImage of any type, to BufferedImage of a specified type.
static MediaPictureConverter	createConverter(BufferedImage image, MediaPicture picture) Create a converter which translates between BufferedImage and MediaPicture.
static MediaPictureConverter	createConverter(BufferedImage image, PixelFormat.Type pictureType) Create a converter which translates between BufferedImage and MediaPicture types.
static MediaPictureConverter	createConverter(String converterDescriptor, MediaPicture picture) Create a converter which translates betewen BufferedImage and MediaPicture types.
static MediaPictureConverter	createConverter(String converterDescriptor, PixelFormat.Type pictureType, int width, int height) Create a converter which translates between BufferedImage and MediaPicture types.
static MediaPictureConverter	createConverter(String converterDescriptor, PixelFormat.Type pictureType, int pictureWidth, int pictureHeight, int imageWidth, int imageHeight) Create a converter which translates betewen BufferedImage and MediaPicture types.
static String	findDescriptor(BufferedImage image) Find a descriptor given a BufferedImage.
static MediaPictureConverterFactory.Type	findRegisteredConverter(String descriptor) Find a converter given a type descriptor.
static Collection<MediaPictureConverterFactory.Type>	getRegisteredConverters() Get a collection of the registered converters.
static MediaPictureConverterFactory.Type	registerConverter(MediaPictureConverterFactory.Type converterType) Register a converter with this factory.
static MediaPictureConverterFactory.Type	unregisterConverter(MediaPictureConverterFactory.Type converterType) Unregister a converter with this factory.

Methods inherited from class java.lang.Object

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

Field Detail

HUMBLE_BGR_24

public static final String HUMBLE_BGR_24

Converts between MediaPictures and BufferedImage of type BufferedImage.TYPE_3BYTE_BGR

See Also:

Constant Field Values

Method Detail

registerConverter

public static MediaPictureConverterFactory.Type registerConverter(MediaPictureConverterFactory.Type converterType)

Register a converter with this factory. The factory oragnizes the converters by descriptor, and thus each should be unique unless one whishes to replace an existing converter.

Parameters:

converterType - the type for the converter to be registered

Returns:

the converter type which this converter displaced, or NULL of this is a novel converter

unregisterConverter

public static MediaPictureConverterFactory.Type unregisterConverter(MediaPictureConverterFactory.Type converterType)

Unregister a converter with this factory.

Parameters:

converterType - the type for the converter to be unregistered

Returns:

the converter type which removed, or NULL of this converter was not recognized

getRegisteredConverters

public static Collection<MediaPictureConverterFactory.Type> getRegisteredConverters()

Get a collection of the registered converters. The collection is unmodifiable.

Returns:

an unmodifiable collection of converter types.

findRegisteredConverter

public static MediaPictureConverterFactory.Type findRegisteredConverter(String descriptor)

Find a converter given a type descriptor.

Parameters:

descriptor - a unique string which describes this converter

Returns:

the converter found or NULL if it was not found.

findDescriptor

public static String findDescriptor(BufferedImage image)

Find a descriptor given a BufferedImage.

Parameters:

image - a buffered image for which to find a descriptor

Returns:

the descriptor which matches the image or NULL if it was not found

createConverter

public static MediaPictureConverter createConverter(String converterDescriptor,
                                                    MediaPicture picture)

Create a converter which translates betewen BufferedImage and MediaPicture types. The PixelFormat.Type and size are extracted from the passed in picture. This factory will attempt to create a converter which can perform the translation. If no converter can be created, a descriptive UnsupportedOperationException is thrown.

Parameters:

converterDescriptor - the unique string descriptor of the converter which is to be created

picture - the picture from which size and type are extracted

Throws:

UnsupportedOperationException - if the converter can not be found

UnsupportedOperationException - if the found converter can not be properly initialized

IllegalArgumentException - if the passed MediaPicture is NULL;

createConverter

public static MediaPictureConverter createConverter(BufferedImage image,
                                                    MediaPicture picture)

Create a converter which translates between BufferedImage and MediaPicture. This factory will attempt to create a converter which can perform the translation. If no converter can be created, a descriptive UnsupportedOperationException is thrown.

Parameters:

image - a prototypical BufferedImage that is in the format you want to convert to/from.

picture - a prototypical MediaPicture in the format you want to convert to/from.

Throws:

UnsupportedOperationException - if the converter can not be found

UnsupportedOperationException - if the found converter can not be properly initialized

createConverter

public static MediaPictureConverter createConverter(BufferedImage image,
                                                    PixelFormat.Type pictureType)

Create a converter which translates between BufferedImage and MediaPicture types. The BufferedImage type and size are extracted from the passed in image. This factory will attempt to create a converter which can perform the translation. If no converter can be created, a descriptive UnsupportedOperationException is thrown.

Parameters:

image - the image from which size and type are extracted

pictureType - the picture type of the converter

Throws:

UnsupportedOperationException - if no converter for the specified BufferedImage type exists

UnsupportedOperationException - if the found converter can not be properly initialized

IllegalArgumentException - if the passed BufferedImage is NULL;

createConverter

public static MediaPictureConverter createConverter(String converterDescriptor,
                                                    PixelFormat.Type pictureType,
                                                    int width,
                                                    int height)

Create a converter which translates between BufferedImage and MediaPicture types. This factory will attempt to create a converter which can perform the translation. If no converter can be created, a descriptive UnsupportedOperationException is thrown.

Parameters:

converterDescriptor - the unique string descriptor of the converter which is to be created

pictureType - the picture type of the converter

width - the width of pictures and images

height - the height of pictures and images

Throws:

UnsupportedOperationException - if the converter can not be found

UnsupportedOperationException - if the found converter can not be properly initialized

createConverter

public static MediaPictureConverter createConverter(String converterDescriptor,
                                                    PixelFormat.Type pictureType,
                                                    int pictureWidth,
                                                    int pictureHeight,
                                                    int imageWidth,
                                                    int imageHeight)

Create a converter which translates betewen BufferedImage and MediaPicture types. This factory will attempt to create a converter which can perform the translation. If different image and pictures sizes are passed the converter will resize during translation. If no converter can be created, a descriptive UnsupportedOperationException is thrown.

Parameters:

converterDescriptor - the unique string descriptor of the converter which is to be created

pictureType - the picture type of the converter

pictureWidth - the width of pictures

pictureHeight - the height of pictures

imageWidth - the width of images

imageHeight - the height of images

Throws:

UnsupportedOperationException - if the converter can not be found

UnsupportedOperationException - if the converter can not be properly created or initialized

convertToType

public static BufferedImage convertToType(BufferedImage sourceImage,
                                          int targetType)

Convert a BufferedImage of any type, to BufferedImage of a specified type. If the source image is the same type as the target type, then original image is returned, otherwise new image of the correct type is created and the content of the source image is copied into the new image.

Parameters:

sourceImage - the image to be converted

targetType - the desired BufferedImage type

Returns:

a BufferedImage of the specifed target type.

See Also:

BufferedImage