org.openimaj.video

Class AnimatedVideo<I extends Image<?,I>>

java.lang.Object

org.openimaj.video.Video<I>

org.openimaj.video.AnimatedVideo<I>

Type Parameters:

I -

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<I>

Direct Known Subclasses:

VideoVisualisation

public abstract class AnimatedVideo<I extends Image<?,I>>
extends Video<I>

A basic abstract implementation of a video that displays an image and provides double-buffering

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
AnimatedVideo(I blankFrame) Default video constructor with a rate of 30 fps using the given image as a basis.
AnimatedVideo(I blankFrame, double fps) Default video constructor with the given rate using the given image as a basis.

Method Summary

Modifier and Type	Method and Description
long	countFrames() Return the number of frames in the whole video.
I	getCurrentFrame() Get the current frame
double	getFPS() Get the frame rate
int	getHeight() Get the height of the video frame.
I	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.
protected void	init() Called by the constructor.
void	reset() Reset the video - putting the frame counter back to the start.
protected abstract void	updateNextFrame(I 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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

AnimatedVideo

public AnimatedVideo(I blankFrame)

Default video constructor with a rate of 30 fps using the given image as a basis.

Parameters:

blankFrame - blank video frame to pass to the update method

AnimatedVideo

public AnimatedVideo(I blankFrame,
                     double fps)

Default video constructor with the given rate using the given image as a basis.

Parameters:

blankFrame - blank video frame to pass to the update method

fps - the frame rate

Method Detail

updateNextFrame

protected abstract void updateNextFrame(I frame)

getNextFrame

public I getNextFrame()

Description copied from class: Video

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

Specified by:

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

Returns:

the next frame

getCurrentFrame

public I getCurrentFrame()

Description copied from class: Video

Get the current frame

Specified by:

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

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

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

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

Returns:

the time stamp in milliseconds

getFPS

public double getFPS()

Description copied from class: Video

Get the frame rate

Specified by:

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

Returns:

the frame rate

hasNextFrame

public boolean hasNextFrame()

Description copied from class: Video

Returns whether this video has another frame to provide.

Specified by:

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

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

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

init

protected void init()

Called by the constructor. Does nothing by default.