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 for encapsulating shot boundary information.
040 * 
041 *  @author David Dupplaw (dpd@ecs.soton.ac.uk)
042 *      @param <T> The type of image 
043 *      
044 *      @created 1 Jun 2011
045 */
046public class ShotBoundary<T extends Image<?,T>>
047{       
048        /** The timecode of the shot boundary */
049        protected VideoTimecode timecode = null;
050        
051        /** The keyframe of the boundary. May not be set */
052        protected VideoKeyframe<T> keyframe = null;
053
054        /**
055         *      Construct a shot boundary using the given video timecode.
056         * 
057         *  @param timecode The timecode
058         */
059        public ShotBoundary( VideoTimecode timecode )
060        {
061                this.timecode = timecode;
062        }
063
064        /**
065         *      Get the timecode of this shot boundary.
066         *      @return The timecode of this shot boundary;
067         */
068        public VideoTimecode getTimecode()
069        {
070                return this.timecode;
071        }
072        
073        /**
074         *  {@inheritDoc}
075         *  @see java.lang.Object#toString()
076         */
077        @Override
078        public String toString()
079        {
080            return this.timecode.toString();
081        }
082
083        /**
084         *      @return the keyframe
085         */
086        public VideoKeyframe<T> getKeyframe()
087        {
088                return keyframe;
089        }
090
091        /**
092         *      @param keyframe the keyframe to set
093         */
094        public void setKeyframe( VideoKeyframe<T> keyframe )
095        {
096                this.keyframe = keyframe;
097        }
098}