org.openimaj.video.translator

Class VideoTranslator<INPUT extends Image<?,INPUT>,OUTPUT extends Image<?,OUTPUT>>

java.lang.Object

org.openimaj.video.Video<OUTPUT>

org.openimaj.video.translator.VideoTranslator<INPUT,OUTPUT>

Type Parameters:

INPUT -

OUTPUT -

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<OUTPUT>

Direct Known Subclasses:

FImageToMBFImageVideoTranslator, MBFImageToFImageVideoTranslator

public abstract class VideoTranslator<INPUT extends Image<?,INPUT>,OUTPUT extends Image<?,OUTPUT>>
extends Video<OUTPUT>

A video translator is a video processor where the input and output frame types may be different. This means that no processing can take place in place but new frames must be returned.

Although it overrides VideoProcessor, this processor must be used in chain mode - that is, it appears as a Video of the output type while taking a video of the input type.

Author:

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

Constructor Summary

Constructors

Constructor and Description
VideoTranslator(Video<INPUT> in) Construct a new VideoTranslator that will translate the given input video.

Method Summary

Methods

Modifier and Type	Method and Description
long	countFrames() Return the number of frames in the whole video.
OUTPUT	getCurrentFrame() Get the current frame
double	getFPS() Get the frame rate
int	getHeight() Get the height of the video frame.
OUTPUT	getNextFrame() Get the next frame.
long	getTimeStamp() Get the timestamp of the current frame in milliseconds
int	getWidth() Get the width of the video frame
boolean	hasNextFrame() Returns whether this video has another frame to provide.
void	reset() Reset the video - putting the frame counter back to the start.
abstract OUTPUT	translateFrame(INPUT nextFrame) Translate the given input frame to the appropriate output frame.

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

Constructor Detail

VideoTranslator

public VideoTranslator(Video<INPUT> in)

Construct a new VideoTranslator that will translate the given input video.

Parameters:

in - The input video.

Method Detail

getFPS

public double getFPS()

Description copied from class: Video

Get the frame rate

Specified by:

getFPS in class Video<OUTPUT extends Image<?,OUTPUT>>

Returns:

the frame rate

getCurrentFrame

public OUTPUT getCurrentFrame()

Description copied from class: Video

Get the current frame

Specified by:

getCurrentFrame in class Video<OUTPUT extends Image<?,OUTPUT>>

Returns:

the current frame

getWidth

public int getWidth()

Description copied from class: Video

Get the width of the video frame

Specified by:

getWidth in class Video<OUTPUT extends Image<?,OUTPUT>>

Returns:

the width of the video frame.

getHeight

public int getHeight()

Description copied from class: Video

Get the height of the video frame.

Specified by:

getHeight in class Video<OUTPUT extends Image<?,OUTPUT>>

Returns:

the height of the video frame.

getTimeStamp

public long getTimeStamp()

Description copied from class: Video

Get the timestamp of the current frame in milliseconds

Specified by:

getTimeStamp in class Video<OUTPUT extends Image<?,OUTPUT>>

Returns:

the time stamp in milliseconds

hasNextFrame

public boolean hasNextFrame()

Description copied from class: Video

Returns whether this video has another frame to provide.

Specified by:

hasNextFrame in class Video<OUTPUT extends Image<?,OUTPUT>>

Returns:

Whether the video has another frame available

countFrames

public long countFrames()

Description copied from class: Video

Return the number of frames in the whole video. If the video is a live stream, then this method should return -1.

Specified by:

countFrames in class Video<OUTPUT extends Image<?,OUTPUT>>

Returns:

the number of frames in the whole video or -1 if unknown

reset

public void reset()

Description copied from class: Video

Reset the video - putting the frame counter back to the start.

Specified by:

reset in class Video<OUTPUT extends Image<?,OUTPUT>>

getNextFrame

public OUTPUT getNextFrame()

Description copied from class: Video

Get the next frame. Increments the frame counter by 1.

Specified by:

getNextFrame in class Video<OUTPUT extends Image<?,OUTPUT>>

Returns:

the next frame

translateFrame

public abstract OUTPUT translateFrame(INPUT nextFrame)

Translate the given input frame to the appropriate output frame.

Parameters:

nextFrame - The input frame.

Returns:

The output frame