CnC_Remastered_Collection

Command and Conquer: Red Alert
Log | Files | Refs | README | LICENSE

LCWPIPE.H (4072B)

      1 //
      2 // Copyright 2020 Electronic Arts Inc.
      3 //
      4 // TiberianDawn.DLL and RedAlert.dll and corresponding source code is free 
      5 // software: you can redistribute it and/or modify it under the terms of 
      6 // the GNU General Public License as published by the Free Software Foundation, 
      7 // either version 3 of the License, or (at your option) any later version.
      8 
      9 // TiberianDawn.DLL and RedAlert.dll and corresponding source code is distributed 
     10 // in the hope that it will be useful, but with permitted additional restrictions 
     11 // under Section 7 of the GPL. See the GNU General Public License in LICENSE.TXT 
     12 // distributed with this program. You should have received a copy of the 
     13 // GNU General Public License along with permitted additional restrictions 
     14 // with this program. If not, see https://github.com/electronicarts/CnC_Remastered_Collection
     15 
     16 /* $Header: /CounterStrike/LCWPIPE.H 1     3/03/97 10:25a Joe_bostic $ */
     17 /***********************************************************************************************
     18  ***              C O N F I D E N T I A L  ---  W E S T W O O D  S T U D I O S               ***
     19  ***********************************************************************************************
     20  *                                                                                             *
     21  *                 Project Name : Command & Conquer                                            *
     22  *                                                                                             *
     23  *                    File Name : LCWPIPE.H                                                    *
     24  *                                                                                             *
     25  *                   Programmer : Joe L. Bostic                                                *
     26  *                                                                                             *
     27  *                   Start Date : 06/30/96                                                     *
     28  *                                                                                             *
     29  *                  Last Update : June 30, 1996 [JLB]                                          *
     30  *                                                                                             *
     31  *---------------------------------------------------------------------------------------------*
     32  * Functions:                                                                                  *
     33  * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
     34 
     35 
     36 #ifndef LCWPIPE_H
     37 #define LCWPIPE_H
     38 
     39 #include	"pipe.h"
     40 
     41 
     42 /*
     43 **	Performs LCW compression/decompression on the data stream that is piped through this
     44 **	class. The data is compressed in blocks so of small enough size to be compressed
     45 **	quickly and large enough size to get decent compression rates.
     46 */
     47 class LCWPipe : public Pipe
     48 {
     49 	public:
     50 		typedef enum CompControl {
     51 			COMPRESS,
     52 			DECOMPRESS
     53 		} CompControl;
     54 
     55 		LCWPipe(CompControl, int blocksize=1024*8);
     56 		virtual ~LCWPipe(void);
     57 
     58 		virtual int Flush(void);
     59 		virtual int Put(void const * source, int slen);
     60 
     61 	private:
     62 		/*
     63 		**	This tells the pipe if it should be decompressing or compressing the data stream.
     64 		*/
     65 		CompControl Control;
     66 
     67 		/*
     68 		**	The number of bytes accumulated into the staging buffer.
     69 		*/
     70 		int Counter;
     71 
     72 		/*
     73 		**	Pointer to the working buffer that compression/decompression will use.
     74 		*/
     75 		char * Buffer;
     76 		char * Buffer2;
     77 
     78 		/*
     79 		**	The working block size. Data will be compressed in chunks of this size.
     80 		*/
     81 		int BlockSize;
     82 
     83 		/*
     84 		**	LCW compression requires a safety margin when decompressing over itself. This
     85 		**	margin is only for the worst case situation (very rare).
     86 		*/
     87 		int SafetyMargin;
     88 
     89 		/*
     90 		**	Each block has a header of this format.
     91 		*/
     92 		struct {
     93 			unsigned short CompCount;		// Size of data block (compressed).
     94 			unsigned short UncompCount;	// Bytes of uncompressed data it represents.
     95 		} BlockHeader;
     96 
     97 		LCWPipe(LCWPipe & rvalue);
     98 		LCWPipe & operator = (LCWPipe const & pipe);
     99 };
    100 
    101 
    102 #endif