001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030/**
031 * 
032 */
033package org.openimaj.video.processing.shotdetector;
034
035import org.openimaj.image.Image;
036import org.openimaj.video.timecode.VideoTimecode;
037
038/**
039 *      Interface for objects that wish to listen to shot detections from
040 *      the shot detector. 
041 * 
042 *  @author David Dupplaw (dpd@ecs.soton.ac.uk)
043 *      
044 *  @param <T> The type of {@link Image}  
045 *      @created 26 Sep 2011
046 */
047public interface ShotDetectedListener<T extends Image<?,T>>
048{
049        /**
050         *      Called when a shot is detected by the shot detector with the
051         *      shot boundary definition and an associated key frame.
052         * 
053         *  @param sb The shot boundary definition
054         *  @param vk The keyframe
055         */
056        public void shotDetected( ShotBoundary<T> sb, VideoKeyframe<T> vk );
057        
058        /**
059         *      Called every time a differential between two frames has been
060         *      calculated.
061         * 
062         *  @param vt The timecode of the differential frame.
063         *  @param d The differential value
064         *  @param frame The current frame
065         */
066        public void differentialCalculated( VideoTimecode vt, double d, T frame );
067}