org.openimaj.video

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

java.lang.Object

org.openimaj.video.Video<T>

org.openimaj.video.FileBackedVideo<T>

Type Parameters:

T - the image type of the frames

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<T>

Direct Known Subclasses:

FImageFileBackedVideo, MBFImageFileBackedVideo

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

A video backed by a image files on disk. Each image file is a single frame.

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 inherited from class org.openimaj.video.Video

currentFrame

Constructor Summary

Constructors

Constructor and Description
FileBackedVideo(List<File> files) Construct the video from the provided files.
FileBackedVideo(List<File> files, double fps) Construct the video from the provided files.
FileBackedVideo(String filenameFormat, int start, int stop) Construct videos from numbered files using the given format string and indices.

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
static List<File>	getFilesList(String filenameFormat, int start, int stop) Get a list of numbered files using the given format string and indices.
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.
protected abstract T	loadImage(File f)
void	reset() Reset the video - putting the frame counter back to the start.

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

FileBackedVideo

public FileBackedVideo(List<File> files)

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

Parameters:

files - the image files

FileBackedVideo

public FileBackedVideo(List<File> files,
                       double fps)

Construct the video from the provided files.

Parameters:

files - the image files

fps - the frame rate

FileBackedVideo

public FileBackedVideo(String filenameFormat,
                       int start,
                       int stop)

Construct videos from numbered files using the given format string and indices. The format string should contain a single %d substitution.

Parameters:

filenameFormat - format string

start - starting index (inclusive)

stop - stop index (exclusive)

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

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

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

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

loadImage

protected abstract T loadImage(File f)
                        throws IOException

Throws:

IOException

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

getFilesList

public static List<File> getFilesList(String filenameFormat,
                                      int start,
                                      int stop)

Get a list of numbered files using the given format string and indices. The format string should contain a single %d substitution.

Parameters:

filenameFormat - format string

start - starting index (inclusive)

stop - stop index (exclusive)

Returns:

list of files