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 *      A class that represents a keyframe of a video. Encapsualtes the image
040 *      representing the keyframe as well as the timecode at which the keyframe
041 *      occurs in the video.
042 * 
043 *  @author David Dupplaw (dpd@ecs.soton.ac.uk)
044 *      
045 *      @param <T> the {@link Image} type 
046 *      @created 1 Jun 2011
047 */
048public class VideoKeyframe<T extends Image<?,T>>
049{
050        /** An image at the shot boundary */
051        public T imageAtBoundary = null;
052        
053        /** The timecode of the keyframe */
054        public VideoTimecode timecode = null;
055        
056        /**
057         *      Constructor that allows construction of an image-based shot
058         *      boundary.
059         * 
060         *  @param timecode The timecode of the shot boundary
061         *  @param img The image at the shot boundary
062         */
063        public VideoKeyframe( VideoTimecode timecode, T img )
064        {
065            this.imageAtBoundary = img;
066            this.timecode = timecode;
067    }
068        
069        /**
070         *      Return the image at the shot boundary.
071         *  @return The image at the shot boundary.
072         */
073        public T getImage()
074        {
075                return imageAtBoundary;
076        }
077        
078        /**
079         *      Returns the timecode of this keyframe.
080         *      @return The timecode of the keyframe in the video.
081         */
082        public VideoTimecode getTimecode()
083        {
084                return this.timecode;
085        }
086        
087        /**
088         *      {@inheritDoc}
089         */
090        @Override
091        public VideoKeyframe<T> clone()
092        {
093                return new VideoKeyframe<T>( this.timecode.clone(), 
094                                this.imageAtBoundary.clone() );
095        }
096}