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.processor;
034
035import org.openimaj.image.Image;
036import org.openimaj.image.processor.ImageProcessor;
037import org.openimaj.video.Video;
038
039/**
040 * This class is a {@link VideoProcessor} that uses an {@link ImageProcessor}
041 * for processing frames of a video.
042 * 
043 * @author David Dupplaw (dpd@ecs.soton.ac.uk)
044 * @created 27 Jul 2011
045 * 
046 * 
047 * @param <I>
048 *            The image type that this processor will process
049 */
050public class VideoFrameProcessor<I extends Image<?, I>>
051                extends VideoProcessor<I>
052{
053        /** The processor that will be used to process frames */
054        private ImageProcessor<I> processor = null;
055
056        /**
057         * Non-chainable constructor
058         * 
059         * @param processor
060         *            the processor to use
061         */
062        public VideoFrameProcessor(ImageProcessor<I> processor)
063        {
064                this.processor = processor;
065        }
066
067        /**
068         * Chainable constructor.
069         * 
070         * @param video
071         *            The video to process
072         * @param processor
073         *            the next processor in line
074         */
075        public VideoFrameProcessor(Video<I> video, ImageProcessor<I> processor)
076        {
077                super(video);
078                this.processor = processor;
079        }
080
081        /**
082         * {@inheritDoc}
083         * 
084         * @see org.openimaj.video.processor.VideoProcessor#processFrame(org.openimaj.image.Image)
085         */
086        @Override
087        public I processFrame(I frame)
088        {
089                return frame.process(this.processor);
090        }
091
092}