cvd/videobuffer.h

/*                       
    This file is part of the CVD Library.

    Copyright (C) 2005 The Authors

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 
    51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/
#ifndef CVD_VIDEOBUFFER_H
#define CVD_VIDEOBUFFER_H

#include <cvd/videoframe.h>
#include <cvd/exceptions.h>
#include <memory>

namespace CVD {

struct VideoBufferType
{
    enum Type
    {
        NotLive, 
        Live,
        Flushable
    };
};

class RawVideoBuffer
{
    public:

        virtual RawVideoBuffer* source_buffer()
        {
            return this;
        }
        
        RawVideoBuffer* root_buffer()
        {
            RawVideoBuffer* b = this;
            while(b->source_buffer() != b)
                b = b->source_buffer();
            return b;
        }


        virtual ~RawVideoBuffer(){}

        virtual ImageRef size()=0;

        virtual bool frame_pending()=0;

        virtual double frame_rate()=0;
        virtual void seek_to(double)
        {}


        virtual void flush()=0;
        
};

template <class T> 
class VideoBuffer: public virtual RawVideoBuffer
{
    public:
        VideoBuffer(VideoBufferType::Type _type)
        :m_type(_type)
        {}

        virtual ~VideoBuffer()
        {}

        virtual VideoFrame<T>* get_frame()=0;           

        virtual void put_frame(VideoFrame<T>* f)=0;
        
        virtual void flush()
        {
            if(type() == VideoBufferType::Flushable)
                while(frame_pending())
                    put_frame(get_frame());
        }

        VideoBufferType::Type type()
        {
            return m_type;
        }

    private:
        VideoBufferType::Type m_type;
};


namespace Exceptions
{
    namespace VideoBuffer
    {
        struct All: public CVD::Exceptions::All
        {
        };

        struct BadPutFrame: public All
        {
            BadPutFrame();
        };
        
        struct BadColourSpace: public All
        {
            BadColourSpace(const std::string& colourspace, const std::string& b); 
        };
    }
}



}

#endif