org.openimaj.video

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

java.lang.Object

org.openimaj.video.Video<T>

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

org.openimaj.video.VideoWriter<I>

org.openimaj.video.VideoCache<I>

Type Parameters:

I - The type of video frames to be cached

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<I>

public class VideoCache<I extends Image<?,I>>
extends VideoWriter<I>

This class represents a cache of video material. It is also able to build the cache for you with the static methods.

Author:

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

Created:

14 Oct 2011

Field Summary

Fields inherited from class org.openimaj.video.VideoWriter

frameRate, height, width

Constructor Summary

Constructors

Constructor and Description
VideoCache(int width, int height, double frameRate) Create a video cache for frames of the given size and for a video of the given frame rate.

Method Summary

Modifier and Type	Method and Description
void	addFrame(I frame) Add a frame to the video stream.
static <I extends Image<?,I>> VideoCache<I>	cacheVideo(Video<I> video) Cache the whole of the given video.
static <I extends Image<?,I>> VideoCache<I>	cacheVideo(Video<I> video, VideoTimecode start, VideoTimecode end) Cache the given time range from the given video.
ArrayBackedVideo<I>	getArrayBackedVideo() Returns an ArrayBackedVideo for the frames in this cache.
I	getFrame(int i) Returns the frame at the given index.
int	getNumberOfFrames() Returns the number of frames that have been cached.
void	reset() Clears the cache.

Methods inherited from class org.openimaj.video.VideoWriter

getFPS, getTimeStamp, processFrame

Methods inherited from class org.openimaj.video.processor.VideoProcessor

countFrames, getCurrentFrame, getHeight, getNextFrame, getWidth, hasNextFrame, process, process, processingComplete

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

VideoCache

public VideoCache(int width,
                  int height,
                  double frameRate)

Create a video cache for frames of the given size and for a video of the given frame rate.

Parameters:

width - The width of the video frames

height - The height of the video frames

frameRate - The frame rate of the video

Method Detail

addFrame

public void addFrame(I frame)

Add a frame to the video stream.

Specified by:

addFrame in class VideoWriter<I extends Image<?,I>>

Parameters:

frame - The frame to add to the video stream

See Also:

VideoWriter.addFrame(org.openimaj.image.Image)

getArrayBackedVideo

public ArrayBackedVideo<I> getArrayBackedVideo()

Returns an ArrayBackedVideo for the frames in this cache.

Returns:

An ArrayBackedVideo

getNumberOfFrames

public int getNumberOfFrames()

Returns the number of frames that have been cached.

Returns:

The number of frames that have been cached.

getFrame

public I getFrame(int i)

Returns the frame at the given index.

Parameters:

i - The index to get the frame from

Returns:

The frame at the given index

reset

public void reset()

Clears the cache. No implementation.

Overrides:

reset in class VideoProcessor<I extends Image<?,I>>

See Also:

VideoProcessor.reset()

cacheVideo

public static <I extends Image<?,I>> VideoCache<I> cacheVideo(Video<I> video)

Cache the whole of the given video.

Type Parameters:

I - Type of Image

Parameters:

video - The video to cache

Returns:

A VideoCache

cacheVideo

public static <I extends Image<?,I>> VideoCache<I> cacheVideo(Video<I> video,
                                                              VideoTimecode start,
                                                              VideoTimecode end)

Cache the given time range from the given video.

Type Parameters:

I - The type of the video frames

Parameters:

video - The video to cache

start - The start of the video to cache

end - The end of the video to cache

Returns:

A VideoCache