org.openimaj.video.xuggle

Class XuggleVideoWriter

java.lang.Object

org.openimaj.video.Video<T>

org.openimaj.video.processor.VideoProcessor<T>

org.openimaj.video.VideoWriter<MBFImage>

org.openimaj.video.xuggle.XuggleVideoWriter

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<MBFImage>

public class XuggleVideoWriter
extends VideoWriter<MBFImage>

An implementation of the video writer class that uses the Xuggler video API to write videos. Note that Xuggler will resize any images to fit within the given output size during its write process.

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

27 Jul 2011

Field Summary

Fields inherited from class org.openimaj.video.VideoWriter

frameRate, height, width

Constructor Summary

Constructors

Constructor and Description
XuggleVideoWriter(String filename, int width, int height, double frameRate) Default constructor that takes the frame size and frame rate of the resulting video.

Method Summary

Modifier and Type	Method and Description
void	addFrame(MBFImage frame) Add a frame to the video stream.
void	close() Close the video stream
static BufferedImage	convertToType(BufferedImage sourceImage, int targetType) Convert a BufferedImage of any type, to BufferedImage of a specified type.
void	initialise() Initialise the writer
void	processingComplete() A hook for subclasses to be called when processing for the video has completed to clean up after themselves.
void	reset() No implementation.

Methods inherited from class org.openimaj.video.VideoWriter

getFPS, getTimeStamp, processFrame

Methods inherited from class org.openimaj.video.processor.VideoProcessor

countFrames, getCurrentFrame, getHeight, getNextFrame, getWidth, hasNextFrame, process, process

Methods inherited from class org.openimaj.video.Video

getCurrentFrameIndex, iterator, seek, setCurrentFrameIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

XuggleVideoWriter

public XuggleVideoWriter(String filename,
                         int width,
                         int height,
                         double frameRate)

Default constructor that takes the frame size and frame rate of the resulting video.

Parameters:

filename - The filename to write the video to

width - The width of the video frame in pixels

height - The height of the video frame in pixels

frameRate - The frame rate of the resulting video

Method Detail

initialise

public void initialise()

Initialise the writer

processingComplete

public void processingComplete()

A hook for subclasses to be called when processing for the video has completed to clean up after themselves.

Overrides:

processingComplete in class VideoProcessor<MBFImage>

See Also:

VideoProcessor.processingComplete()

close

public void close()

Close the video stream

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class Video<MBFImage>

addFrame

public void addFrame(MBFImage frame)

Add a frame to the video stream.

Specified by:

addFrame in class VideoWriter<MBFImage>

Parameters:

frame - The frame to add to the video stream

See Also:

VideoWriter.addFrame(org.openimaj.image.Image)

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 specified target type.

reset

public void reset()

Description copied from class: VideoProcessor

No implementation.

Overrides:

reset in class VideoProcessor<MBFImage>