org.openimaj.demos.sandbox.image.gif

Class GifSequenceWriter

java.lang.Object

org.openimaj.demos.sandbox.image.gif.GifSequenceWriter

public class GifSequenceWriter
extends Object

A GifSequenceWriter uses java ImageIO to write animated gifs. Taken wholesale from: http://elliot.kroo.net/software/java/GifSequenceWriter/ and modified to play nicely with openimaj

Author:

Elliot Kroo (elliot[at]kroo[dot]net), Sina Samangooei (ss@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
protected ImageWriter	gifWriter
protected IIOMetadata	imageMetaData
protected ImageWriteParam	imageWriteParam

Constructor Summary

Constructors

Constructor and Description
GifSequenceWriter(ImageOutputStream outputStream, int timeBetweenFramesMS, boolean loopContinuously) Creates a new GifSequenceWriter.
GifSequenceWriter(ImageOutputStream outputStream, int imageType, int timeBetweenFramesMS, boolean loopContinuously) Creates a new GifSequenceWriter

Method Summary

Modifier and Type	Method and Description
void	close() Close this GifSequenceWriter object.
static GifSequenceWriter	createWriter(int timeBetweenFramesMS, boolean loopContinuously, File f) Construct a GifSequenceWriter which writes to a file
static void	writeGif(List<Image<?,?>> frames, int timeBetweenFramesMS, boolean loopContinuously, File file) Write an array of images to a gif file.
static void	writeGif(List<Image<?,?>> frames, int timeBetweenFramesMS, boolean loopContinuously, ImageOutputStream output) Write some frames into an ImageOutputStream
static void	writeGif(List<Image<?,?>> frames, int timeBetweenFramesMS, boolean loopContinuously, OutputStream stream) Write an array of images to a gif output stream
void	writeToSequence(Image<?,?> img) Write an image to the sequence

Methods inherited from class java.lang.Object

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

Field Detail

gifWriter

protected ImageWriter gifWriter

imageWriteParam

protected ImageWriteParam imageWriteParam

imageMetaData

protected IIOMetadata imageMetaData

Constructor Detail

GifSequenceWriter

public GifSequenceWriter(ImageOutputStream outputStream,
                         int imageType,
                         int timeBetweenFramesMS,
                         boolean loopContinuously)
                  throws IIOException,
                         IOException

Creates a new GifSequenceWriter

Parameters:

outputStream - the ImageOutputStream to be written to

imageType - one of the imageTypes specified in BufferedImage

timeBetweenFramesMS - the time between frames in miliseconds

loopContinuously - wether the gif should loop repeatedly

Throws:

IIOException - if no gif ImageWriters are found

IOException

GifSequenceWriter

public GifSequenceWriter(ImageOutputStream outputStream,
                         int timeBetweenFramesMS,
                         boolean loopContinuously)
                  throws IIOException,
                         IOException

Creates a new GifSequenceWriter. Not specifying the imageType means that initialisation of the writer is delayed until the first image is written

Parameters:

outputStream - the ImageOutputStream to be written to

timeBetweenFramesMS - the time between frames in miliseconds

loopContinuously - whether the gif should loop repeatedly

Throws:

IIOException - if no gif ImageWriters are found

IOException

Method Detail

writeToSequence

public void writeToSequence(Image<?,?> img)
                     throws IOException

Write an image to the sequence

Parameters:

img -

Throws:

IOException

close

public void close()
           throws IOException

Close this GifSequenceWriter object. This does not close the underlying stream, just finishes off the GIF.

Throws:

IOException

writeGif

public static void writeGif(List<Image<?,?>> frames,
                            int timeBetweenFramesMS,
                            boolean loopContinuously,
                            File file)
                     throws IOException

Write an array of images to a gif file. The type of the output gif is taken from the first frame. All future frames are assumed to be the same type.

Parameters:

frames -

timeBetweenFramesMS -

loopContinuously -

file -

Throws:

IOException

createWriter

public static GifSequenceWriter createWriter(int timeBetweenFramesMS,
                                             boolean loopContinuously,
                                             File f)
                                      throws IIOException,
                                             FileNotFoundException,
                                             IOException

Construct a GifSequenceWriter which writes to a file

Parameters:

timeBetweenFramesMS -

loopContinuously -

f -

Returns:

GifSequenceWriter instance

Throws:

IOException

FileNotFoundException

IIOException

writeGif

public static void writeGif(List<Image<?,?>> frames,
                            int timeBetweenFramesMS,
                            boolean loopContinuously,
                            OutputStream stream)
                     throws IOException

Write an array of images to a gif output stream

Parameters:

frames -

timeBetweenFramesMS -

loopContinuously -

stream -

Throws:

IOException

writeGif

public static void writeGif(List<Image<?,?>> frames,
                            int timeBetweenFramesMS,
                            boolean loopContinuously,
                            ImageOutputStream output)
                     throws IOException

Write some frames into an ImageOutputStream

Parameters:

frames -

timeBetweenFramesMS -

loopContinuously -

output -

Throws:

IOException