org.openimaj.video

Class VideoWriter<T extends Image<?,T>>

java.lang.Object

org.openimaj.video.Video<T>

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

org.openimaj.video.VideoWriter<T>

Type Parameters:

T - Type of Image

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<T>

Direct Known Subclasses:

VideoCache, XuggleVideoWriter

public abstract class VideoWriter<T extends Image<?,T>>
extends VideoProcessor<T>

An abstract class which classes can override to provide video writing capabilities.

The addFrame(Image) method must be overridden by implementing subclasses to actually perform the encoding and writing of the video frame.

The class is an extension of a video processor which allows the writer to act in a processing chain. The implementation of the VideoProcessor interface calls the addFrame(Image) method for every frame that is passed in the processor.

Author:

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

Created:

27 Jul 2011

Field Summary

Fields

Modifier and Type	Field and Description
protected double	frameRate The frame rate at which written videos will be replayed
protected int	height The height of the video frames in pixels
protected int	width The width of the video frames in pixels

Constructor Summary

Constructors

Constructor and Description
VideoWriter(int width, int height, double frameRate) Default constructor that takes the frame rate at which the written video will be replayed.

Method Summary

Modifier and Type	Method and Description
abstract void	addFrame(T frame) Add a frame to the video stream.
double	getFPS() Get the frame rate
long	getTimeStamp() Get the timestamp of the current frame in milliseconds
T	processFrame(T frame) Process a frame in this video.

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

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

Methods inherited from class org.openimaj.video.Video

close, 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

Field Detail

frameRate

protected double frameRate

The frame rate at which written videos will be replayed

width

protected int width

The width of the video frames in pixels

height

protected int height

The height of the video frames in pixels

Constructor Detail

VideoWriter

public VideoWriter(int width,
                   int height,
                   double frameRate)

Default constructor that takes the frame rate at which the written video will be replayed.

Parameters:

width - The width of the video frames in pixels

height - The height of the video frames in pixels

frameRate - The frame rate in frames per second

Method Detail

addFrame

public abstract void addFrame(T frame)

Add a frame to the video stream.

Parameters:

frame - The frame to add to the video stream

processFrame

public T processFrame(T frame)

Process a frame in this video. The processor must determine itself what is to be done with the frame that is processed. It is suggest that subclass processors add listeners for processed frames if they are required. The implementation must process the frame in-place and the frame should be returned.

Specified by:

processFrame in class VideoProcessor<T extends Image<?,T>>

Parameters:

frame - The frame to process.

Returns:

the processed frame

See Also:

VideoProcessor.processFrame(org.openimaj.image.Image)

getTimeStamp

public long getTimeStamp()

Get the timestamp of the current frame in milliseconds

Overrides:

getTimeStamp in class VideoProcessor<T extends Image<?,T>>

Returns:

the time stamp in milliseconds

See Also:

Video.getTimeStamp()

getFPS

public double getFPS()

Get the frame rate

Overrides:

getFPS in class VideoProcessor<T extends Image<?,T>>

Returns:

the frame rate

See Also:

Video.getFPS()