org.openimaj.video.processing.shotdetector

Class HistogramVideoShotDetector

java.lang.Object

org.openimaj.video.Video<T>

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

org.openimaj.video.processing.shotdetector.VideoShotDetector<MBFImage>

org.openimaj.video.processing.shotdetector.HistogramVideoShotDetector

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<MBFImage>, VideoDisplayListener<MBFImage>

public class HistogramVideoShotDetector
extends VideoShotDetector<MBFImage>

Video shot detector class implemented as a video display listener. This means that shots can be detected as the video plays. The class also supports direct processing of a video file (with no display). The default shot boundary threshold is 5000 which is an unnormalised value and will depend on the frame size.

Only the last keyframe is stored during processing, so if you want to store a list of keyframes you must store this list yourself by listening to the ShotDetected event which provides a VideoKeyframe which has a timecode and an image. Each event will receive the same VideoKeyframe instance containing different information. USe VideoKeyframe#clone() to make a copy.

Author:

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

Created:

1 Jun 2011

Field Summary

Fields inherited from class org.openimaj.video.processing.shotdetector.VideoShotDetector

lastFrameWasBoundary, threshold

Constructor Summary

Constructors

Constructor and Description
HistogramVideoShotDetector() If you use this constructor, your timecodes will be messed up unless you call VideoShotDetector.setFPS(double) before you process any frames.
HistogramVideoShotDetector(double fps) Constructor that takes the frame rate of the source material.
HistogramVideoShotDetector(Video<MBFImage> video) Default constructor takes the video to process.
HistogramVideoShotDetector(Video<MBFImage> video, boolean display) Constructor that determines whether to display the processing.

Method Summary

Modifier and Type	Method and Description
protected double	getInterframeDistance(MBFImage frame) Checks whether a shot boundary occurred between the given frame and the previous frame, and if so, it will add a shot boundary to the shot boundary list.

Methods inherited from class org.openimaj.video.processing.shotdetector.VideoShotDetector

addShotDetectedListener, afterUpdate, beforeUpdate, fireDifferentialCalculated, fireShotDetected, getDifferentials, getLastKeyframe, getLastShotBoundary, getShotBoundaries, getThreshold, process, processFrame, removeShotDetectedListener, reset, setFindKeyframes, setFPS, setStoreAllDifferentials, setThreshold, wasLastFrameBoundary

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

countFrames, getCurrentFrame, getFPS, getHeight, getNextFrame, getTimeStamp, getWidth, hasNextFrame, 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

HistogramVideoShotDetector

public HistogramVideoShotDetector()

If you use this constructor, your timecodes will be messed up unless you call VideoShotDetector.setFPS(double) before you process any frames.

HistogramVideoShotDetector

public HistogramVideoShotDetector(double fps)

Constructor that takes the frame rate of the source material.

Parameters:

fps - The FPS

HistogramVideoShotDetector

public HistogramVideoShotDetector(Video<MBFImage> video)

Default constructor takes the video to process.

Parameters:

video - The video

HistogramVideoShotDetector

public HistogramVideoShotDetector(Video<MBFImage> video,
                                  boolean display)

Constructor that determines whether to display the processing.

Parameters:

video - The video

display - Whether to display the video while processing

Method Detail

getInterframeDistance

protected double getInterframeDistance(MBFImage frame)

Checks whether a shot boundary occurred between the given frame and the previous frame, and if so, it will add a shot boundary to the shot boundary list.

Specified by:

getInterframeDistance in class VideoShotDetector<MBFImage>

Parameters:

frame - The new frame to process.

Returns:

The inter-frame distance