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.tools.imagecollection.collection.video;
031
032import java.util.HashMap;
033import java.util.Iterator;
034
035import org.openimaj.image.Image;
036import org.openimaj.tools.imagecollection.collection.ImageCollectionEntry;
037import org.openimaj.tools.imagecollection.collection.ImageCollectionEntrySelection;
038import org.openimaj.video.Video;
039
040public class MetadataVideoIterator<T extends Image<?, T>> implements Iterator<ImageCollectionEntry<T>> {
041
042        private Video<T> video;
043        private ImageCollectionEntrySelection<T> selection;
044        private int frameCount = 0;
045
046        public MetadataVideoIterator(ImageCollectionEntrySelection<T> selection, Video<T> video) {
047                this.video = video;
048                this.selection = selection;
049        }
050
051        @Override
052        public boolean hasNext() {
053                return frameCount >= 0 && video.hasNextFrame();
054        }
055
056        @Override
057        public ImageCollectionEntry<T> next() {
058                final T image = video.getNextFrame();
059                final ImageCollectionEntry<T> entry = new ImageCollectionEntry<T>();
060                entry.meta = new HashMap<String, String>();
061                entry.meta.put("timestamp", "" + this.frameCount / this.video.getFPS());
062                entry.accepted = selection.acceptEntry(image);
063                entry.image = image;
064                this.frameCount++;
065
066                // hack to stop the iterator at the end until hasNext works properly
067                if (image == null)
068                        frameCount = -1;
069
070                return entry;
071        }
072
073        @Override
074        public void remove() {
075                // TODO Auto-generated method stub
076
077        }
078
079}