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 */
030package org.openimaj.video;
031
032import java.io.File;
033import java.io.IOException;
034import java.util.List;
035
036import org.openimaj.image.ImageUtilities;
037import org.openimaj.image.MBFImage;
038
039/**
040 * A video backed by a image files on disk. Each image file
041 * is a single frame. Images are of the RGB MBFImage type.
042 * 
043 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
044 *
045 */
046public class MBFImageFileBackedVideo extends FileBackedVideo<MBFImage> {
047        /**
048         * Construct the video from the provided files. Assumes a frame rate
049         * of 30 FPS
050         * @param files the image files
051         */
052        public MBFImageFileBackedVideo(List<File> files){
053                super(files);
054        }
055        
056        /**
057         * Construct the video from the provided files.
058         * @param files the image files
059         * @param fps the frame rate
060         */
061        public MBFImageFileBackedVideo(List<File> files, double fps) {
062                super(files, fps);
063        }
064        
065        /**
066         * Construct videos from numbered files using the given format string and
067         * indices. The format string should contain a single %d substitution.
068         *  
069         * @param filenameFormat format string
070         * @param start starting index (inclusive)
071         * @param stop stop index (exclusive)
072         */
073        public MBFImageFileBackedVideo(String filenameFormat, int start, int stop) {
074                super(filenameFormat, start, stop);
075        }
076
077        @Override
078        protected MBFImage loadImage(File f) throws IOException {
079                return ImageUtilities.readMBF(f);
080        }
081}