neo/framework/Compressor.h

   1 /*
   2 ===========================================================================
   3
   4 Doom 3 GPL Source Code
   5 Copyright (C) 1999-2011 id Software LLC, a ZeniMax Media company.
   6
   7 This file is part of the Doom 3 GPL Source Code (?Doom 3 Source Code?).
   8
   9 Doom 3 Source Code is free software: you can redistribute it and/or modify
  10 it under the terms of the GNU General Public License as published by
  11 the Free Software Foundation, either version 3 of the License, or
  12 (at your option) any later version.
  13
  14 Doom 3 Source Code is distributed in the hope that it will be useful,
  15 but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 GNU General Public License for more details.
  18
  19 You should have received a copy of the GNU General Public License
  20 along with Doom 3 Source Code.  If not, see <http://www.gnu.org/licenses/>.
  21
  22 In addition, the Doom 3 Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU General Public License which accompanied the Doom 3 Source Code.  If not, please request a copy in writing from id Software at the address below.
  23
  24 If you have questions concerning this license or the applicable additional terms, you may contact in writing id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
  25
  26 ===========================================================================
  27 */
  28
  29 #ifndef __COMPRESSOR_H__
  30 #define __COMPRESSOR_H__
  31
  32 /*
  33 ===============================================================================
  34
  35         idCompressor is a layer ontop of idFile which provides lossless data
  36         compression. The compressor can be used as a regular file and multiple
  37         compressors can be stacked ontop of each other.
  38
  39 ===============================================================================
  40 */
  41
  42 class idCompressor : public idFile {
  43 public:
  44                                                         // compressor allocation
  45         static idCompressor *   AllocNoCompression( void );
  46         static idCompressor *   AllocBitStream( void );
  47         static idCompressor *   AllocRunLength( void );
  48         static idCompressor *   AllocRunLength_ZeroBased( void );
  49         static idCompressor *   AllocHuffman( void );
  50         static idCompressor *   AllocArithmetic( void );
  51         static idCompressor *   AllocLZSS( void );
  52         static idCompressor *   AllocLZSS_WordAligned( void );
  53         static idCompressor *   AllocLZW( void );
  54
  55                                                         // initialization
  56         virtual void                    Init( idFile *f, bool compress, int wordLength ) = 0;
  57         virtual void                    FinishCompress( void ) = 0;
  58         virtual float                   GetCompressionRatio( void ) const = 0;
  59
  60                                                         // common idFile interface
  61         virtual const char *    GetName( void ) = 0;
  62         virtual const char *    GetFullPath( void ) = 0;
  63         virtual int                             Read( void *outData, int outLength ) = 0;
  64         virtual int                             Write( const void *inData, int inLength ) = 0;
  65         virtual int                             Length( void ) = 0;
  66         virtual ID_TIME_T                       Timestamp( void ) = 0;
  67         virtual int                             Tell( void ) = 0;
  68         virtual void                    ForceFlush( void ) = 0;
  69         virtual void                    Flush( void ) = 0;
  70         virtual int                             Seek( long offset, fsOrigin_t origin ) = 0;
  71 };
  72
  73 #endif /* !__COMPRESSOR_H__ */