00001 /*!@file Media/MgzInputStream.H Read frames from mgz 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: Rob Peters <rjpeters at usc dot edu> 00034 // $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/Media/MgzInputStream.H $ 00035 // $Id: MgzInputStream.H 8301 2007-04-25 18:31:34Z rjpeters $ 00036 // 00037 00038 #ifndef MEDIA_MGZINPUTSTREAM_H_DEFINED 00039 #define MEDIA_MGZINPUTSTREAM_H_DEFINED 00040 00041 #include "Component/ModelComponent.H" 00042 #include "Component/ModelParam.H" 00043 #include "Transport/FrameIstream.H" 00044 #include "Raster/GenericFrame.H" 00045 00046 class MgzDecoder; 00047 00048 // ###################################################################### 00049 // ###################################################################### 00050 //! MgzInputStream is a wrapper class to read frames from .mgz files 00051 /*! mgz is a custom format that basically contains the raw frames in 00052 gzipped format. One mgz file can contain many frames of various 00053 sizes and types. */ 00054 00055 class MgzInputStream : public FrameIstream 00056 { 00057 public: 00058 //! Construct an mgzstream object for mgz input 00059 MgzInputStream(OptionManager& mgr, 00060 const std::string& descrName = "Mgz Input Stream", 00061 const std::string& tagName = "MgzInputStream"); 00062 00063 //! Virtual destructor 00064 virtual ~MgzInputStream(); 00065 00066 //! Override from FrameIstream; just calls setFileName() 00067 virtual void setConfigInfo(const std::string& filename); 00068 00069 //! get frame specifications, peeking at the first frame if necessary 00070 virtual GenericFrameSpec peekFrameSpec(); 00071 00072 //! Configure the MGZ Stream for decoding 00073 /*! @param fname name of file from which frames are to be read from */ 00074 void setFileName(std::string fname); 00075 00076 //! Read the next frame from the mgz stream 00077 /*! The native representation of the GenericFrame will be the same 00078 as what it was when the frame was stored into the stream. */ 00079 virtual GenericFrame readFrame(); 00080 00081 private: 00082 MgzDecoder *itsDecoder; 00083 GenericFrame itsFrame; // used for peeking of frame specs 00084 GenericFrameSpec itsFrameSpec; 00085 bool itsFrameSpecValid; 00086 }; 00087 00088 // ###################################################################### 00089 /* So things look consistent in everyone's emacs... */ 00090 /* Local Variables: */ 00091 /* mode: c++ */ 00092 /* indent-tabs-mode: nil */ 00093 /* End: */ 00094 00095 #endif // MEDIA_MGZINPUTSTREAM_H_DEFINED