LowLevelEncoderMap.H

Go to the documentation of this file.
00001 /*!@file Transport/LowLevelEncoderMap.H A partial implementation of FrameOstream, using a map between 'shortnames' and LowLevelEncoder objects */
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/Transport/LowLevelEncoderMap.H $
00035 // $Id: LowLevelEncoderMap.H 8905 2007-10-25 23:21:41Z rjpeters $
00036 //
00037 
00038 #ifndef TRANSPORT_LOWLEVELENCODERMAP_H_DEFINED
00039 #define TRANSPORT_LOWLEVELENCODERMAP_H_DEFINED
00040 
00041 #include "Transport/FrameOstream.H"
00042 #include "Transport/LowLevelEncoder.H"
00043 #include "rutz/shared_ptr.h"
00044 
00045 class GenericFrameSpec;
00046 
00047 /// A partial implementation of FrameOstream, using a map between 'shortnames' and LowLevelEncoder objects
00048 /** Subclasses must implement makeEncoderForStem(), but do not need to
00049     implement writeFrame() or closeStream(). Subclasses may implement
00050     setConfigInfo() as needed. */
00051 class LowLevelEncoderMap : public FrameOstream
00052 {
00053 public:
00054   LowLevelEncoderMap(OptionManager& mgr,
00055                       const std::string& descrName,
00056                       const std::string& tagName);
00057 
00058   virtual ~LowLevelEncoderMap();
00059 
00060   /// Send the frame to the LowLevelEncoder corresponding to shortname
00061   /** If no such encoder exists yet, then a new one will be created by
00062       calling the subclass's implementation of makeEncoderForStem(). */
00063   virtual void writeFrame(const GenericFrame& frame,
00064                           const std::string& shortname,
00065                           const FrameInfo& auxinfo);
00066 
00067   /// Close and delete the LowLevelEncoder corresponding to shortname
00068   /*! This means that if additional frames are later sent to that same
00069       shortname, then a new LowLevelEncoder object will be created for
00070       that shortname (possibly overwriting previous files or output
00071       destinations, etc.). */
00072   virtual void closeStream(const std::string& shortname);
00073 
00074 protected:
00075   /// Must be implemented by subclasses to return a type-appropriate encoder object
00076   virtual rutz::shared_ptr<LowLevelEncoder>
00077   makeEncoder(const GenericFrameSpec& spec,
00078               const std::string& shortname,
00079               const FrameInfo& auxinfo) = 0;
00080 
00081   /// Overridden to destroy our encoder map
00082   virtual void stop2();
00083 
00084 private:
00085   LowLevelEncoderMap(const LowLevelEncoderMap&);
00086   LowLevelEncoderMap& operator=(const LowLevelEncoderMap&);
00087 
00088   struct Impl;
00089   Impl* rep;
00090 };
00091 
00092 // ######################################################################
00093 /* So things look consistent in everyone's emacs... */
00094 /* Local Variables: */
00095 /* mode: c++ */
00096 /* indent-tabs-mode: nil */
00097 /* End: */
00098 
00099 #endif // TRANSPORT_LOWLEVELENCODERMAP_H_DEFINED
Generated on Sun May 8 08:42:24 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3