cmtkCompressedStream.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2011 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit 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 General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 2752 $
//
//  $LastChangedDate: 2011-01-17 11:33:31 -0800 (Mon, 17 Jan 2011) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkCompressedStream_h_included_
#define __cmtkCompressedStream_h_included_

#include <cmtkconfig.h>

#include <System/cmtkCannotBeCopied.h>

#include <System/cmtkException.h>
#include <System/cmtkSmartPtr.h>

#include <stdio.h>

#include <zlib.h>

#ifdef CMTK_USE_BZIP2
#  include <bzlib.h>
#endif

#ifdef CMTK_USE_LZMA
#  include <lzmadec.h>
#endif

#ifdef HAVE_SYS_STAT_H
#  include <sys/stat.h>
#endif

#include <string>

#if defined(_MSC_VER)
#define CMTK_FILE_MODE "rb"
#elif defined(__linux__)
#define CMTK_FILE_MODE "r"
#else
#define CMTK_FILE_MODE "rb"
#endif

namespace
cmtk
{


class CompressedStream :
  private CannotBeCopied
{
public:
  typedef CompressedStream Self;
  
  CompressedStream() : m_Reader( NULL ) {};
  
  CompressedStream ( const char *filename );
  
  ~CompressedStream ();
  
  bool IsValid() const
  {
    return (this->m_Reader != NULL); 
  }
  
  bool IsCompressed() const
  {
    return this->m_Compressed;
  }
  
  bool Open( const char *filename );
  
  void Close();
  
  void Rewind()
  {
    this->m_Reader->Rewind();
  }

  int Seek ( const long int offset, int whence )
  {
    return this->m_Reader->Seek( offset, whence );
  }

  size_t Read ( void *data, size_t size, size_t count )
  {
    return this->m_Reader->Read( data, size, count );
  }

  int Get ( char &c)
  {
    return this->m_Reader->Get( c );
  }

  int Tell () const
  {
    return this->m_Reader->Tell();
  }

  bool Feof () const
  {
    return this->m_Reader->Feof();
  }

  static std::string GetBaseName( const std::string& path );

  static int Stat( const char *path, struct stat *const buf = NULL );

private:
  bool OpenDecompressionPipe ( const char* filename, const char* suffix, const char* command, const char* compressedSuffix );

  typedef struct 
  {
    const char *suffix;
    
    const char *command;
  } ArchiveLookupEntry;
  
  static const ArchiveLookupEntry ArchiveLookup[];

private:
  class ReaderBase
  {
  public:
    typedef ReaderBase Self;
    
    typedef SmartPointer<Self> SmartPtr;

    ReaderBase() : m_BytesRead( 0 ) {}

    virtual void Close() = 0;

    virtual void Rewind()
    {
      this->m_BytesRead = 0;
    }
    
    virtual int Seek ( const long int offset, int whence );
    
    virtual size_t Read ( void *data, size_t size, size_t count ) = 0;
    
    virtual bool Get ( char &c) = 0;
    
    virtual int Tell () const = 0;
    
    virtual bool Feof () const = 0;

  private:
    static const size_t SeekBlockSize = 8192;

  protected:
    size_t m_BytesRead;
  };

  class File
    : public ReaderBase
  {
  public:
    typedef File Self;
    
    typedef SmartPointer<Self> SmartPtr;

    File( const char *filename );
    
    virtual void Close();
    
    virtual void Rewind();
    
    virtual int Seek ( const long int offset, int whence );
    
    virtual size_t Read ( void *data, size_t size, size_t count );
    
    virtual bool Get ( char &c);
    
    virtual int Tell () const;
    
    virtual bool Feof () const;

  private:
    FILE* m_File;    
  };

  class Pipe
    : public ReaderBase
  {
  public:
    typedef Pipe Self;
    
    typedef SmartPointer<Self> SmartPtr;

    Pipe( const char* filename, const char* command );
    
    virtual void Close();
    
    virtual void Rewind();
    
    virtual size_t Read ( void *data, size_t size, size_t count );
    
    virtual bool Get ( char &c);
    
    virtual int Tell () const;
    
    virtual bool Feof () const;

  private:
    FILE* m_File;    
    
#ifdef _MSC_VER

    char m_TempName[256];
#endif
  };

  class Zlib 
    : public ReaderBase
  {
  public:
    typedef Zlib Self;
    
    typedef SmartPointer<Self> SmartPtr;

    Zlib( const char *filename );
    
    virtual void Close();
    
    virtual void Rewind();
    
    virtual int Seek ( const long int offset, int whence );
    
    virtual size_t Read ( void *data, size_t size, size_t count );
    
    virtual bool Get ( char &c );
    
    virtual int Tell () const;
    
    virtual bool Feof () const;

  private:
    gzFile m_GzFile;    
  };

#ifdef CMTK_USE_BZIP2

  class BZip2 
    : public ReaderBase
  {
  public:
    typedef BZip2 Self;
    
    typedef SmartPointer<Self> SmartPtr;

    BZip2( const char *filename );
    
    virtual void Close();
    
    virtual void Rewind();
    
    virtual size_t Read ( void *data, size_t size, size_t count );
    
    virtual bool Get ( char &c);
    
    virtual int Tell () const;
    
    virtual bool Feof () const;

  private:
    BZFILE* m_BzFile;    

    int m_BzError;
  };
#endif

#ifdef CMTK_USE_LZMA

  class LZMA 
    : public ReaderBase
  {
  public:
    typedef LZMA Self;
    
    typedef SmartPointer<Self> SmartPtr;

    LZMA( const char *filename );
    
    virtual void Close();
    
    virtual void Rewind();
    
    virtual size_t Read ( void *data, size_t size, size_t count );
    
    virtual bool Get ( char &c);
    
    virtual int Tell () const;
    
    virtual bool Feof () const;

  private:
    lzmadec_FILE* m_File;    
  };
#endif // #ifdef CMTK_USE_LZMA

  ReaderBase::SmartPtr m_Reader;

  bool m_Compressed;
};


} // namespace cmtk

#endif // #ifndef __cmtkCompressedStream_h_included_