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.hardware.kinect;
031
032import org.openimaj.image.Image;
033import org.openimaj.video.Video;
034
035
036/**
037 * A stream of (visual/ir/depth) data from the Kinect
038 * 
039 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
040 *
041 * @param <T>
042 */
043public abstract class KinectStream<T extends Image<?,T>> extends Video<T> {
044        KinectController controller;
045        KinectStreamCallback callback;
046        T frame;
047        long timeStamp;
048        int width;
049        int height;
050        double fps;
051        
052        /**
053         * Construct with a reference to the controller
054         * @param controller The controller
055         */
056        public KinectStream(KinectController controller) {
057                this.controller = controller;
058        }
059        
060        @Override
061        public T getNextFrame() {
062                currentFrame++;
063                callback.swapFrames();
064                return frame;
065        }
066
067        @Override
068        public T getCurrentFrame() {
069                return frame;
070        }
071
072        @Override
073        public int getWidth() {
074                return width;
075        }
076
077        @Override
078        public int getHeight() {
079                return height;
080        }
081
082        @Override
083        public boolean hasNextFrame() {
084                return true;
085        }
086
087        @Override
088        public long countFrames() {
089                return this.currentFrame;
090        }
091
092        @Override
093        public void reset() {
094                //do nothing
095        }
096        
097        /**
098         * Stop the stream
099         */
100        public void stop() {
101                callback.stop();
102        }
103        
104        /**
105         * Get the timestamp of the current frame
106         * @return the time stamp
107         */
108        @Override
109        public long getTimeStamp() {
110                return (long)(1000 * currentFrame / fps);
111        }
112        
113        /**
114         *  {@inheritDoc}
115         *  @see org.openimaj.video.Video#getFPS()
116         */
117        @Override
118        public double getFPS()
119        {
120            return fps;
121        }
122}