cvd/videoframe.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
*/
//                                                                  //
//   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