1 /**
2 * Copyright (c) 2011, The University of Southampton and the individual contributors.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without modification,
6 * are permitted provided that the following conditions are met:
7 *
8 * * Redistributions of source code must retain the above copyright notice,
9 * this list of conditions and the following disclaimer.
10 *
11 * * Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * * Neither the name of the University of Southampton nor the names of its
16 * contributors may be used to endorse or promote products derived from this
17 * software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30 /**
31 *
32 */
33 package org.openimaj.video.processing.shotdetector;
34
35 import org.openimaj.image.Image;
36 import org.openimaj.video.timecode.VideoTimecode;
37
38 /**
39 * Interface for objects that wish to listen to shot detections from
40 * the shot detector.
41 *
42 * @author David Dupplaw (dpd@ecs.soton.ac.uk)
43 *
44 * @param <T> The type of {@link Image}
45 * @created 26 Sep 2011
46 */
47 public interface ShotDetectedListener<T extends Image<?,T>>
48 {
49 /**
50 * Called when a shot is detected by the shot detector with the
51 * shot boundary definition and an associated key frame.
52 *
53 * @param sb The shot boundary definition
54 * @param vk The keyframe
55 */
56 public void shotDetected( ShotBoundary<T> sb, VideoKeyframe<T> vk );
57
58 /**
59 * Called every time a differential between two frames has been
60 * calculated.
61 *
62 * @param vt The timecode of the differential frame.
63 * @param d The differential value
64 * @param frame The current frame
65 */
66 public void differentialCalculated( VideoTimecode vt, double d, T frame );
67 }