org.openimaj.video

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

java.lang.Object

org.openimaj.video.Video<T>

org.openimaj.video.ArrayBackedVideo<T>

Type Parameters:

T - the image type of the frames

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<T>

public class ArrayBackedVideo<T extends Image<?,T>>
extends Video<T>

A video from an array of frames

Author:

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

Field Summary

Fields inherited from class org.openimaj.video.Video

currentFrame

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ArrayBackedVideo() Default constructor for creating array backed videos with no frames for subclasses.
	ArrayBackedVideo(T[] frames) Construct a video from the provided frames.
	ArrayBackedVideo(T[] frames, double fps) Construct a video from the provided frames.
	ArrayBackedVideo(T[] frames, double fps, boolean loop) Construct a video from the provided frames.

Method Summary

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	reset() Reset the video - putting the frame counter back to the start.
void	setCurrentFrameIndex(long newFrame) Set the current frame index (i.e.

Methods inherited from class org.openimaj.video.Video

close, getCurrentFrameIndex, iterator, seek

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

ArrayBackedVideo

protected ArrayBackedVideo()

Default constructor for creating array backed videos with no frames for subclasses.

ArrayBackedVideo

public ArrayBackedVideo(T[] frames)

Construct a video from the provided frames. Assumes a rate of 30 FPS.

Parameters:

frames - the frames

ArrayBackedVideo

public ArrayBackedVideo(T[] frames,
                        double fps)

Construct a video from the provided frames.

Parameters:

frames - the frames

fps - the frame rate

ArrayBackedVideo

public ArrayBackedVideo(T[] frames,
                        double fps,
                        boolean loop)

Construct a video from the provided frames.

Parameters:

frames - the frames

fps - the frame rate

loop - loop the video

Method Detail

getNextFrame

public T getNextFrame()

Description copied from class: Video

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

Specified by:

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

Returns:

the next frame

getCurrentFrame

public T getCurrentFrame()

Description copied from class: Video

Get the current frame

Specified by:

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

Returns:

the current frame

setCurrentFrameIndex

public void setCurrentFrameIndex(long newFrame)

Description copied from class: Video

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.

Overrides:

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

Parameters:

newFrame - the new index

hasNextFrame

public boolean hasNextFrame()

Description copied from class: Video

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

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()

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

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<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()