bc8b4047a952260004f0d2f4207a65d48721ca4d
[u/mrichter/AliRoot.git] / TPC / AliTPCCompression.h
1 /* Copyright(c) 1998-2003, ALICE Experiment at CERN, All rights reserved. *
2  * See cxx source for full Copyright notice                               */
3
4 //////////////////////////////////////////////////////
5 // Class for Compression and Decompression          //
6 //////////////////////////////////////////////////////
7
8  
9 #ifndef AliTPCCOMPRESSION_H
10 #define AliTPCCOMPRESSION_H
11
12 class AliTPCHNode;
13 class AliTPCHTable;
14
15 class AliTPCCompression:public TObject{
16  public:
17   AliTPCCompression();
18   virtual ~AliTPCCompression(){;}
19   AliTPCCompression(const AliTPCCompression &source); // copy constructor
20   AliTPCCompression& operator=(const AliTPCCompression &source); // ass. op.
21   Int_t  CompressData(AliTPCHTable* table[],Int_t NumTable,const char* fSource,const char* fDest);
22   //This method is used to compress the data stored in the Altro format file using specific tables
23   //calculated considering the frequencies of the symbol of the file that has to be compressed
24   //The tables are stored at the beginning of the compressed file
25   Int_t  CompressDataOptTables(Int_t NumTable,const char* fSource,const char* fDest);
26   //This method is used to compress an Altro file using a set of general table previously calculated  and
27   //stored as a sequence of txt file. In this case the tables are not stored in the compressed file
28   Int_t  DecompressData(Int_t NumTables,const char* fname,char* fDest="SourceDecompressed.dat");
29   //This method is used tho decompress a file compressed using the CompressData method
30   Int_t  DecompressDataOptTables(Int_t NumTables,const char* fname,char* fDest="SourceDecompressed.dat");
31   //This method is used to decompress a file compressed using the CompressDataOptTable method
32   //It expects a set of table used for compressing the file in the same directory of the compressed file
33   Int_t  FillTables(const char* fSource,AliTPCHTable* table[],const Int_t NumTables);
34   //This method is used to compute the frequencies of the symbols in the source file
35   Int_t  CreateTables(const char* fSource,const Int_t NumTables);
36   //This method is used to create and store the tables 
37   Int_t CreateTableFormula(Double_t beta,ULong_t  M,Int_t dim,Int_t Type);
38   //This method is used to create and store the Bunch length or Time Gap Table using a formula
39   void   SetVerbose(Int_t val){fVerbose=val;}
40   //This method is used to set up the verbose level
41   //   0 ==> No output messages are displayed
42   //   1 ==> Some output messages are displayed during the running
43   //   2 ==> A complete output is displayed
44   void   ReadAltroFormat(char* fileOut,char* fileIn)const;
45   //This method is used to read an Altro file and generate a text file containing the same information
46   //It's is useful for debugging
47   Int_t  CreateTablesFromTxtFiles(Int_t NumTable);
48   //This method creates a set of binary tables starting from a set of txt tables
49  private:
50   Int_t   StoreTables(AliTPCHTable* table[],const Int_t NumTable);
51   //This method is used to store an array of tables in a sequence of binary files
52   //Each file contains the Size of the table (number of words) and for each word contains the correspondent 
53   //codeword and codelength
54   Int_t   RetrieveTables(AliTPCHTable* table[],Int_t NumTable);
55   //This method is used to retrieve an array of tables from a sequence of binary files created using 
56   //the previous method 
57   void    DeleteHuffmanTree(AliTPCHNode* node);
58   //This method is used to delete an Huffman tree
59   void    VisitHuffmanTree(AliTPCHNode* node);
60   //This method realizes an in order visit of a binary tree
61   void    CreateTrees(AliTPCHNode *RootNode[],const Int_t NumTables);
62   //This method is used to create one or more Huffman tree starting from one or more tables 
63   //It is used in the decompression phase (DecompressData())
64   void    CreateTreesFromFile(AliTPCHNode *RootNode[],const Int_t NumTables);
65   //This method is like the previous one but the tables are stored in binary files
66   //It is used in the decompression phase (DecompressDataOptTables())
67   void    NextTable(Int_t Val,Int_t &NextTableType,Int_t &BunchLen,Int_t &Count)const;
68   //This method is used to deduce which is the next table that as to be used to interpret the next value
69   //reading the Altro format
70   void    StoreValue(ULong_t val,UChar_t len);
71   //This method is used to store a value in the compressed file 
72   ULong_t Mirror(ULong_t val,UChar_t len)const;
73   //This method is used to get the specular value of a given value
74   //for instance the specular value of 12345 is 54321
75   void    Flush();
76   //This method is used to complete and store the buffer in the output file when it isn't completely full 
77   ULong_t ReadWord(Int_t NumberOfBit);
78   //this method is used to read a specified number of bits from the compressed file
79   void    ReadTrailer(Int_t &WordsNumber,Int_t &PadNumber,Int_t &RowNumber,Int_t &SecNumber);
80   //This method is used to read the trailer 
81   ULong_t GetDecodedWord(AliTPCHNode* root);
82   //This method is used to get a decoded word from the compressed file
83
84
85   fstream f;                  // f is the logical name for the compressed and uncompressed file
86   ofstream fStat;             // Logical name for the Statistics file
87   ULong_t fBuffer;            // buffer 
88   Int_t   fDimBuffer;         // buffer dimension (32 bit)
89   Int_t   fFreeBitsBuffer;    // number of free bits inside the buffer
90   Int_t   fReadBits;          // number of bit read
91   ULong_t fPos;               // current file position
92   Int_t   fVerbose;           // verbose level (0 silent, !=0 output messages)
93   ULong_t fFillWords;         // Number of hexadecimally words (2AA pattern) inside a pad data block 
94   ClassDef(AliTPCCompression,1)
95 };
96 #endif