org.openimaj.video

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

java.lang.Object

org.openimaj.video.Video<T>

Type Parameters:

T - the image type of the frames

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<T>

Direct Known Subclasses:

AnimatedVideo, ArrayBackedVideo, FileBackedVideo, GStreamerVideo, KinectStream, VGetVideo, VideoCapture, VideoProcessor, VideoTranslator, XuggleVideo

public abstract class Video<T extends Image<?,T>>
extends Object
implements Iterable<T>, Closeable

Abstract base class for videos.

Author:

Sina Samangooei (ss@ecs.soton.ac.uk), Jonathon Hare (jsh2@ecs.soton.ac.uk), David Dupplaw (dpd@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
protected int	currentFrame The current frame being displayed

Constructor Summary

Constructors

Constructor and Description
Video()

Method Summary

Modifier and Type	Method and Description
void	close() Close the video object
abstract long	countFrames() Return the number of frames in the whole video.
abstract T	getCurrentFrame() Get the current frame
int	getCurrentFrameIndex() Get the index of the current frame
abstract double	getFPS() Get the frame rate
abstract int	getHeight() Get the height of the video frame.
abstract T	getNextFrame() Get the next frame.
abstract long	getTimeStamp() Get the timestamp of the current frame in milliseconds
abstract int	getWidth() Get the width of the video frame
abstract boolean	hasNextFrame() Returns whether this video has another frame to provide.
Iterator<T>	iterator()
abstract void	reset() Reset the video - putting the frame counter back to the start.
void	seek(double timestamp) Seek the video to a given timestamp in SECONDS.
void	setCurrentFrameIndex(long newFrame) Set the current frame index (i.e.

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

currentFrame

protected int currentFrame

The current frame being displayed

Constructor Detail

Video

public Video()

Method Detail

getNextFrame

public abstract T getNextFrame()

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

Returns:

the next frame

getCurrentFrame

public abstract T getCurrentFrame()

Get the current frame

Returns:

the current frame

getWidth

public abstract int getWidth()

Get the width of the video frame

Returns:

the width of the video frame.

getHeight

public abstract int getHeight()

Get the height of the video frame.

Returns:

the height of the video frame.

getTimeStamp

public abstract long getTimeStamp()

Get the timestamp of the current frame in milliseconds

Returns:

the time stamp in milliseconds

getFPS

public abstract double getFPS()

Get the frame rate

Returns:

the frame rate

getCurrentFrameIndex

public int getCurrentFrameIndex()

Get the index of the current frame

Returns:

the current frame index

setCurrentFrameIndex

public void setCurrentFrameIndex(long newFrame)

Set the current frame index (i.e. skips to a certain frame). If your video subclass can implement this in a cleverer way, then override this method, otherwise this method will simply grab frames until it gets to the given frame index. This method is naive and may take some time as each frame will be decoded by the video decoder.

Parameters:

newFrame - the new index

seek

public void seek(double timestamp)

Seek the video to a given timestamp in SECONDS. Many videos (including cameras etc.) will have no ability to seek so by default this function does nothing.

Parameters:

timestamp -

hasNextFrame

public abstract boolean hasNextFrame()

Returns whether this video has another frame to provide.

Returns:

Whether the video has another frame available

countFrames

public abstract long countFrames()

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

Returns:

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

reset

public abstract void reset()

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

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends Image<?,T>>

close

public void close()

Close the video object

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable