#line 1 "/user/cvsspst/ees1cg/RAVL/RAVL-0.7/Image/VideoIO/ImgIOrgb.hh"
// This file is part of RAVL, Recognition And Vision Library 
// Copyright (C) 2001, University of Surrey
// This code may be redistributed under the terms of the GNU Lesser
// General Public License (LGPL). See the lgpl.licence file for details or
// see http://www.gnu.org/copyleft/lesser.html
// file-header-ends-here
#ifndef RAVLIMAGE_IMGIORGB_HEADER
#define RAVLIMAGE_IMGIORGB_HEADER 1
////////////////////////////////////////////////////
//! file="Ravl/Image/VideoIO/ImgIOrgb.hh"
//! lib=RavlVideoIO
//! docentry="Ravl.Images.Video.Formats"
//! example=exImgSeq.cc
//! rcsid="$Id: ImgIOrgb.hh,v 1.7 2002/05/21 14:47:40 craftit Exp $"
//! author="Charles Galambos"
//! date="13/05/1999"

#include "Ravl/DP/SPort.hh"
#include "Ravl/Image/Image.hh"
#include "Ravl/Image/ByteRGBValue.hh"
#include "Ravl/Stream.hh"
#include "Ravl/Assert.hh"

namespace RavlImageN {

  ///////////////////////////////////
  //! userlevel=Develop
  //: Basic information about a raw rgb file
  
  class DPImageRGBBaseBodyC {
  public:  
    DPImageRGBBaseBodyC(const Index2dC &size = Index2dC(576,720));
    //: Constructor.
    // This constructs with the basic yuv format.
    
    bool SetupForVariant(const StringC &suffix);
    //: Setup for cif variant.
    // str should be one of :
    // ??
    
    bool SetupForVariant(const Index2dC &size);
    //: Setup for cif variant.
    // Where size in the size of the Y image.
    
    inline UIntT CalcOffset(UIntT frameNo) const  {
      RavlAssert(frameSize > 0);
      return frameSize * frameNo; 
    }
    //: Calculate the offset of a frame.
    
    inline IntT CalcOffset(IntT frameNo) const {
      RavlAssert(frameSize > 0);
      return frameSize * frameNo; 
    }
    //: Calculate the offset of a frame.
    
    bool WriteHdr(StringC type);
    //: Write header block.
    
    bool ReadHdr(StringC &type);
    //: Read header block.
    
    void SetSequenceSize(UIntT val) { seqSize = val; }
    //: Set the sequence size.
    
    UIntT SeqSize() const { return seqSize; }
    //: Get the sequence size.
    
    
  protected:
    static inline bool is_odd (IndexC x) {return bool (x%2 != 0);}
    // Is an index odd ?
    
    ImageRectangleC rect; // Size of RGB variant. Origin 0,0
    UIntT frameSize; // Size of one frame in bytes.
    UIntT frameNo;   // Current frameno.
    UIntT seqSize;   // Number of frames in sequence, ((UIntT) -1) if unknown
    UIntT blockSize; // Size of blocks.
    UIntT padSize;   // Pad size..
    bool rawMode; // Raw IO mode ?
    bool doneHdr; // Written header yet ?
    int fd; // File descriptor.
  };
  
  ///////////////////////////////////
  //! userlevel=Develop
  //: Load a RGB image in raw RGB format.
  
  class DPIImageRGBBodyC 
    : public DPISPortBodyC<ImageC<ByteRGBValueC> >,
      public DPImageRGBBaseBodyC
  {
  public:  
    DPIImageRGBBodyC(const IStreamC &nStrm,const Index2dC &size = Index2dC(576,720));
    //: Constructor from stream 
    
    DPIImageRGBBodyC(const StringC &fn,bool useHdr = true);
    //: Constructor from filename
    
    virtual bool Seek(UIntT off);
    //: Seek to location in stream.
    // Returns FALSE, if seek failed. (Maybe because its
    // not implemented.)
    // if an error occurered (Seek returned False) then stream
    // position will not be changed.
    
    virtual bool DSeek(IntT off);
    //: Delta Seek, goto location relative to the current one.
    
    virtual UIntT Tell() const; 
    //: Find current location in stream.
    
    virtual UIntT Size() const; 
    //: Find the total size of the stream.
    
    virtual ImageC<ByteRGBValueC> Get();
    //: Get next image.
    
    virtual bool Get(ImageC<ByteRGBValueC> &buff);
    //: Get next image.
    
    virtual bool IsGetReady() const 
      { return strm.good(); }
  //: Is some data ready ?
    // TRUE = yes.
    // Defaults to !IsGetEOS().
    
    virtual bool IsGetEOS() const
      { return strm.good(); }
    //: Has the End Of Stream been reached ?
    // TRUE = yes.
    
  protected:
    IStreamC strm;
  };
  
  ///////////////////////////////////
  //! userlevel=Develop
  //: Save a RGB image in raw RGB format.
  
  class DPOImageRGBBodyC 
    : public DPOSPortBodyC<ImageC<ByteRGBValueC> >,
      public DPImageRGBBaseBodyC
  {
  public:
    DPOImageRGBBodyC(const OStreamC &nStrm,const Index2dC &size  = Index2dC(576,720));
    //: Constructor from stream 
    
    DPOImageRGBBodyC(const StringC &fn,bool useHdr = true);
    //: Constructor from filename
    
    virtual bool Seek(UIntT off);
    //: Seek to location in stream.
    // Returns FALSE, if seek failed. (Maybe because its
    // not implemented.)
    // if an error occurered (Seek returned False) then stream
    // position will not be changed.
    
    virtual bool DSeek(IntT off);
    //: Delta Seek, goto location relative to the current one.
    
    virtual UIntT Tell() const; 
    //: Find current location in stream.
    
    virtual UIntT Size() const; 
    //: Find the total size of the stream.
    
    bool Put(const ImageC<ByteRGBValueC> &Img);
    //: Put image to a stream.
    
    virtual bool IsPutReady() const 
      { return strm.good(); }
    //: Read to write some data ?
    // TRUE = yes.
    
    virtual void PutEOS() {}
    //: Put End Of Stream marker.
    
  protected:  
    OStreamC strm;
  };
  
  //! userlevel=Normal
  //: Load a RGB image in RGB format.
  
  class DPIImageRGBC 
    : public DPISPortC<ImageC<ByteRGBValueC> >
  {
  public:
    DPIImageRGBC(const StringC &fn);
    //: Constructor from filename.  
    
    DPIImageRGBC(const IStreamC &nStrm,const Index2dC &size = Index2dC(576,720))
      : DPEntityC(*new DPIImageRGBBodyC(nStrm,size))
      {}
    //: Constructor from stream 
    
  };
  
  //! userlevel=Normal
  //: Save a RGB image in raw RGB format.
  
  class DPOImageRGBC 
    : public DPOSPortC<ImageC<ByteRGBValueC> >
  {
  public:
    DPOImageRGBC(const StringC &fn);
    //: Constructor from filename.  
    
    DPOImageRGBC(const OStreamC &nStrm,const Index2dC &size = Index2dC(576,720))
      : DPEntityC(*new DPOImageRGBBodyC(nStrm,size))
      {}
    //: Constructor from stream 
    
  };
}
#endif