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 * A class that represents a keyframe of a video. Encapsualtes the image 40 * representing the keyframe as well as the timecode at which the keyframe 41 * occurs in the video. 42 * 43 * @author David Dupplaw (dpd@ecs.soton.ac.uk) 44 * 45 * @param <T> the {@link Image} type 46 * @created 1 Jun 2011 47 */ 48 public class VideoKeyframe<T extends Image<?,T>> 49 { 50 /** An image at the shot boundary */ 51 public T imageAtBoundary = null; 52 53 /** The timecode of the keyframe */ 54 public VideoTimecode timecode = null; 55 56 /** 57 * Constructor that allows construction of an image-based shot 58 * boundary. 59 * 60 * @param timecode The timecode of the shot boundary 61 * @param img The image at the shot boundary 62 */ 63 public VideoKeyframe( VideoTimecode timecode, T img ) 64 { 65 this.imageAtBoundary = img; 66 this.timecode = timecode; 67 } 68 69 /** 70 * Return the image at the shot boundary. 71 * @return The image at the shot boundary. 72 */ 73 public T getImage() 74 { 75 return imageAtBoundary; 76 } 77 78 /** 79 * Returns the timecode of this keyframe. 80 * @return The timecode of the keyframe in the video. 81 */ 82 public VideoTimecode getTimecode() 83 { 84 return this.timecode; 85 } 86 87 /** 88 * {@inheritDoc} 89 */ 90 @Override 91 public VideoKeyframe<T> clone() 92 { 93 return new VideoKeyframe<T>( this.timecode.clone(), 94 this.imageAtBoundary.clone() ); 95 } 96 }