videoframe.h

//                                                                  //
//   VideoFrame - An image with a timestamp, like from a video      //
//                source                                            //
//                                                                  //
//   Tom Drummond     3 April 2002                                  //
//                                                                  //

#ifndef CVD_VIDEOFRAME_H
#define CVD_VIDEOFRAME_H

#include <cvd/image.h>

namespace CVD
{

namespace VideoFrameFlags
{
    enum FieldType
    {
        Top,
        Bottom,
        Both,
        Progressive,
        Unknown
    };
}

template <class T>
class VideoFrame : public BasicImage<T>
{
    public:
    VideoFrame(double t, T* data, const ImageRef& size, VideoFrameFlags::FieldType f = VideoFrameFlags::Unknown)
        : BasicImage<T>(data, size)
        , my_field(f)
        , my_timestamp(t)
    {
    }

    VideoFrame(double t, const BasicImage<T>& im, VideoFrameFlags::FieldType f = VideoFrameFlags::Unknown)
        : BasicImage<T>(im)
        , my_field(f)
        , my_timestamp(t)
    {
    }

    double timestamp() const
    {
        return my_timestamp;
    }

    VideoFrameFlags::FieldType field() const
    {
        return my_field;
    }

    protected:
    virtual ~VideoFrame()
    {
    }

    VideoFrameFlags::FieldType my_field; 
    double my_timestamp; 
};

}

#endif