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 *      Represents a shot boundary that is a fade shot boundary between
040 *      two scenes. This occurs over a time duration so has both a start
041 *      and end timecode.
042 *
043 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
044 *      @param <T> Type of image 
045 *  @created 7 Jun 2011
046 *      
047 */
048public class FadeShotBoundary<T extends Image<?,T>> extends ShotBoundary<T>
049{
050        /** The timecode at the end of the fade */
051        private VideoTimecode endTimecode;
052        
053        /**
054         *      Create a new fade shot boundary giving the start
055         *      of the fade as a starting point.
056         * 
057         *      @param b The boundary at the start of the fade.
058         */
059        public FadeShotBoundary( ShotBoundary<T> b )
060        {
061                super( b.timecode );
062        }
063        
064        /**
065         *      Get the timecode at the end of the fade.
066         *      @return The timecode at the end of the fade.
067         */
068        public VideoTimecode getEndTimecode()
069        {
070                return this.endTimecode;
071        }
072        
073        /**
074         *      Get the timecode at the start of the fade.
075         *      @return The timecode at the start of the fade.
076         */
077        public VideoTimecode getStartTimecode()
078        {
079                return super.timecode;
080        }
081        
082        /**
083         *      Set the timecode at the end of the fade. 
084         *      @param v The timecode of end of the fade
085         */
086        public void setEndTimecode( VideoTimecode v )
087        {
088                this.endTimecode = v;
089        }
090
091        /**
092         *      {@inheritDoc}
093         *      @see org.openimaj.video.processing.shotdetector.ShotBoundary#getTimecode()
094         */
095        @Override
096        public VideoTimecode getTimecode()
097        {
098                return this.getEndTimecode();
099        }
100        
101        /**
102         *      {@inheritDoc}
103         *      @see org.openimaj.video.processing.shotdetector.ShotBoundary#toString()
104         */
105        @Override
106        public String toString()
107        {
108                return "Fade "+getStartTimecode()+" -> "+getEndTimecode();
109        }
110}