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.translator;
034
035import org.openimaj.image.Image;
036import org.openimaj.video.Video;
037
038/**
039 * A video translator is a video processor where the input and output frame
040 * types may be different. This means that no processing can take place in place
041 * but new frames must be returned.
042 *
043 * @author David Dupplaw (dpd@ecs.soton.ac.uk)
044 * @created 1 Mar 2012
045 *
046 *
047 * @param <INPUT>
048 * @param <OUTPUT>
049 */
050public abstract class VideoTranslator<INPUT extends Image<?, INPUT>, OUTPUT extends Image<?, OUTPUT>>
051                extends Video<OUTPUT>
052{
053        /** The input video */
054        private Video<INPUT> video = null;
055
056        /** The last processed frame */
057        private OUTPUT currentFrame = null;
058
059        /**
060         * Construct a new VideoTranslator that will translate the given input
061         * video.
062         *
063         * @param in
064         *            The input video.
065         */
066        public VideoTranslator(Video<INPUT> in)
067        {
068                this.video = in;
069        }
070
071        @Override
072        public double getFPS()
073        {
074                return video.getFPS();
075        }
076
077        @Override
078        public OUTPUT getCurrentFrame()
079        {
080                return currentFrame;
081        }
082
083        @Override
084        public int getWidth()
085        {
086                return video.getWidth();
087        }
088
089        @Override
090        public int getHeight()
091        {
092                return video.getHeight();
093        }
094
095        @Override
096        public long getTimeStamp()
097        {
098                return video.getTimeStamp();
099        }
100
101        @Override
102        public boolean hasNextFrame()
103        {
104                return video.hasNextFrame();
105        }
106
107        @Override
108        public long countFrames()
109        {
110                return video.countFrames();
111        }
112
113        @Override
114        public void reset()
115        {
116                video.reset();
117        }
118
119        @Override
120        public OUTPUT getNextFrame()
121        {
122                return currentFrame = translateFrame(video.getNextFrame());
123        }
124
125        /**
126         * Translate the given input frame to the appropriate output frame.
127         *
128         * @param nextFrame
129         *            The input frame.
130         * @return The output frame
131         */
132        public abstract OUTPUT translateFrame(INPUT nextFrame);
133}