MgzJDecoder.H

Go to the documentation of this file.
00001 /*!@file Media/MgzJDecoder.H Low-level class to decode mgzj files */
00002 
00003 // //////////////////////////////////////////////////////////////////// //
00004 // The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2000-2005   //
00005 // by the University of Southern California (USC) and the iLab at USC.  //
00006 // See http://iLab.usc.edu for information about this project.          //
00007 // //////////////////////////////////////////////////////////////////// //
00008 // Major portions of the iLab Neuromorphic Vision Toolkit are protected //
00009 // under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
00010 // in Visual Environments, and Applications'' by Christof Koch and      //
00011 // Laurent Itti, California Institute of Technology, 2001 (patent       //
00012 // pending; application number 09/912,225 filed July 23, 2001; see      //
00013 // http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
00014 // //////////////////////////////////////////////////////////////////// //
00015 // This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
00016 //                                                                      //
00017 // The iLab Neuromorphic Vision C++ Toolkit is free software; you can   //
00018 // redistribute it and/or modify it under the terms of the GNU General  //
00019 // Public License as published by the Free Software Foundation; either  //
00020 // version 2 of the License, or (at your option) any later version.     //
00021 //                                                                      //
00022 // The iLab Neuromorphic Vision C++ Toolkit is distributed in the hope  //
00023 // that it will be useful, but WITHOUT ANY WARRANTY; without even the   //
00024 // implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      //
00025 // PURPOSE.  See the GNU General Public License for more details.       //
00026 //                                                                      //
00027 // You should have received a copy of the GNU General Public License    //
00028 // along with the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
00029 // to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
00030 // Boston, MA 02111-1307 USA.                                           //
00031 // //////////////////////////////////////////////////////////////////// //
00032 //
00033 // Primary maintainer for this file: Randolph Voorhies <voories at usc dot edu>
00034 
00035 #ifndef MEDIA_MGZJDECODER_H_DEFINED
00036 #define MEDIA_MGZJDECODER_H_DEFINED
00037 #include "Util/Types.H" // for byte
00038 #include "Raster/GenericFrame.H"
00039 #include "Media/MgzJEncoder.H"
00040 #include <zlib.h>
00041 #include <iostream>
00042 #include <fstream>
00043 
00044 /// Low-level decoder for multi-frame "mgzJ" file format
00045 class MgzJDecoder
00046 {
00047 public:
00048   //! Constructor
00049   MgzJDecoder(const std::string& fname);
00050 
00051   //! Defualt Constructor
00052   MgzJDecoder() {};
00053 
00054   //! Virtual destructor for safe inheritance
00055   virtual ~MgzJDecoder();
00056 
00057   //! Read an RGB image from the stream
00058   virtual GenericFrame readFrame();
00059 
00060   //! Open the filename and init the structure
00061   void init();
00062   void shutdown();
00063   void setFilename(const std::string& fname) { itsFileName = fname; }
00064 
00065   //! Get the total number of frames in the journal
00066   int getNumFrames();
00067 
00068   //! Get the current frame num
00069   int getFrameNum() { return itsFrameNum; }
00070 
00071   //! Set the current frame number
00072   bool setFrameNumber(unsigned int n);
00073 
00074 private:
00075   std::string itsFileName;
00076   std::ifstream itsFile;
00077   std::vector<MgzJEncoder::journalEntry> itsJournal;
00078   int itsFrameNum;
00079 };
00080 
00081 #endif //MEDIA_MGZJDECODER_H_DEFINED
Generated on Sun May 8 08:41:01 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3