/*
 *  VideoIterator
 *
 *  Author: Andrew Salamon
 *  Date: Tue Feb 26, 2008
 *
 *  Copyright (c) 2008 Machine Perception Laboratory
 *  University of California San Diego.
 *
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 *    3. The name of the author may not be used to endorse or promote products derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef __CERT_VIDEOITERATOR__
#define __CERT_VIDEOITERATOR__

#include <string>
#include "rimage.h"

namespace CERT
{
    class VideoIterator_imp;

    /** A wrapper class for the VideoIterator implemenetations.
     * The constructor will create an appropriate system-specific implementation (Mac, Win, Unix, etc)
     *   or use one supplied by the caller.
     * Currently only supports Mac OS X.
     */
    class VideoIterator
    {
    public:
        VideoIterator( VideoIterator_imp *_imp );
        VideoIterator( const std::string &_path = std::string() );
        ~VideoIterator();

        bool nextFrame( RImage<float> &pixels );
        bool operator++();
        bool operator++( int );
        RImage<float> &operator*();

        bool isVideo();
        int getFrameNumber();
        std::string getPath();
        void setPath( const std::string &_path );

        void cleanup();

    private:
        RImage<float> frame;
        VideoIterator_imp *imp;
    };

    /** A base class for all VideoIterator implementations.
     * Does nothing if used.
     */
    class VideoIterator_imp
    {
    public:
        VideoIterator_imp() { }
        VideoIterator_imp( const std::string &_path ) { }
        virtual ~VideoIterator_imp() { }

        virtual bool nextFrame( RImage<float> &pixels ) { return false; }

        virtual bool isVideo() { return false; }
        virtual int getFrameNumber() { return -1; }
        virtual std::string getPath() { return std::string(); }
        virtual void setPath( const std::string &_path ) { }
    };
}

#endif