org.openimaj.video.processor

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

java.lang.Object

org.openimaj.video.Video<T>

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

Type Parameters:

T - Type of Image

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<T>

Direct Known Subclasses:

GreyscaleSlitScanProcessor, SlitScanProcessor, VideoAnalyser, VideoFrameProcessor, VideoShotDetector, VideoWriter

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

A super class for classes which are able to process videos. This class can be used in two ways: one as a stand-alone video processor and another as a chainable video processor.

As a stand-alone processor it may be used as such: MyVideoProcessor vp = new MyVideoProcessor(); vp.process( myVideo );

As a chainable processor it may be used as so: MyVideoProcessor vp = new MyVideoProcessor( myVideo ); MyOtherProcessor op = new MyOtherProcessor( vp ); AnotherProcessor ap = new AnotherProcessor( op ); ap.process();

If any of the chain-based functions are called when the video has not been set, an UnsupportedOperationException is thrown.

In the same way that ImageProcessors are expected to change the image content, video processors should change the video frame content in place, returning new altered frames. If you do not need to do this then use the VideoAnalyser.

Author:

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

Constructor Summary

Constructors

Constructor and Description
VideoProcessor() Default constructor for using the video processor in an ad-hoc manner.
VideoProcessor(Video<T> v) Constructor for creating a video processor which is chainable.

Method Summary

Methods

Modifier and Type	Method and Description
long	countFrames() Return the number of frames in the whole video.
T	getCurrentFrame() Get the current frame
double	getFPS() Get the frame rate
int	getHeight() Get the height of the video frame.
T	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	process() This is a sugar function that will call process(Video) with the current video (for chainable processors).
void	process(Video<T> video) Process the given video using this processor.
abstract T	processFrame(T frame) Process a frame in this video.
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.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

VideoProcessor

public VideoProcessor()

Default constructor for using the video processor in an ad-hoc manner.

VideoProcessor

public VideoProcessor(Video<T> v)

Constructor for creating a video processor which is chainable.

Parameters:

v - The video to process

Method Detail

processFrame

public abstract 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.

Parameters:

frame - The frame to process.

Returns:

the processed frame

processingComplete

public void processingComplete()

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

process

public void process(Video<T> video)

Process the given video using this processor.

Parameters:

video - The video to process.

process

public void process()

This is a sugar function that will call process(Video) with the current video (for chainable processors).

getWidth

public int getWidth()

Get the width of the video frame

Specified by:

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

Returns:

the width of the video frame.

See Also:

Video.getWidth()

getHeight

public int getHeight()

Get the height of the video frame.

Specified by:

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

Returns:

the height of the video frame.

See Also:

Video.getHeight()

getNextFrame

public T getNextFrame()

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

Specified by:

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

Returns:

the next frame

See Also:

Video.getNextFrame()

hasNextFrame

public boolean hasNextFrame()

Returns whether this video has another frame to provide.

Specified by:

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

Returns:

Whether the video has another frame available

See Also:

Video.hasNextFrame()

countFrames

public long countFrames()

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<T extends Image<?,T>>

Returns:

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

See Also:

Video.hasNextFrame()

getCurrentFrame

public T getCurrentFrame()

Get the current frame

Specified by:

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

Returns:

the current frame

See Also:

Video.getCurrentFrame()

reset

public void reset()

No implementation.

Specified by:

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

getTimeStamp

public long getTimeStamp()

Get the timestamp of the current frame in milliseconds

Specified by:

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

Returns:

the time stamp in milliseconds

See Also:

Video.getTimeStamp()

getFPS

public double getFPS()

Get the frame rate

Specified by:

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

Returns:

the frame rate

See Also:

Video.getFPS()