Updated version of raw data classes (D.Favretto)
[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  CompressDataOptTables(Int_t NumTable,const char* fSource,const char* fDest);
22   //This method is used to compress an Altro file using a set of general table previously calculated  and
23   //stored as a sequence of txt file. 
24   Int_t  DecompressDataOptTables(Int_t NumTables,const char* fname,char* fDest="SourceDecompressed.dat");
25   //This method is used to decompress a file compressed using the CompressDataOptTable method
26   //It expects a set of table used for compressing the file in the same directory of the compressed file
27   Int_t  Decompress(AliTPCHNode *RootNode[],const Int_t NumTables,char* PointBuffer,ULong_t BufferSize,UShort_t out[],ULong_t &dim);
28   //This method is used to decompress data stored in a char* buffer
29   Int_t  FillTables(const char* fSource,AliTPCHTable* table[],const Int_t NumTables);
30   //This method is used to compute the frequencies of the symbols in the source file
31   Int_t  CreateTables(const char* fSource,const Int_t NumTables);
32   //This method is used to create and store the tables 
33   Int_t  CreateTableFormula(Double_t beta,ULong_t  M,Int_t dim,Int_t Type);
34   //This method is used to create and store the Bunch length or Time Gap Table using a formula
35   void   SetVerbose(Int_t val){fVerbose=val;}
36   //This method is used to set up the verbose level
37   //   0 ==> No output messages are displayed
38   //   1 ==> Some output messages are displayed during the running
39   //   2 ==> A complete output is displayed
40   void   ReadAltroFormat(char* fileOut,char* fileIn)const;
41   //This method is used to read an Altro file and generate a text file containing the same information
42   //It's is useful for debugging
43   Int_t  CreateTablesFromTxtFiles(Int_t NumTable);
44   //This method creates a set of binary tables starting from a set of txt tables
45   Int_t  DestroyTables(AliTPCHNode *RootNode[],const Int_t NumTables);
46   //This methods is use to deallocate the memory used by Huffman trees
47   void    CreateTreesFromFile(AliTPCHNode *RootNode[],const Int_t NumTables);
48   //This method is like the previous one but the tables are stored in binary files
49   //It is used in the decompression phase (DecompressDataOptTables())
50  private:
51   Int_t   StoreTables(AliTPCHTable* table[],const Int_t NumTable);
52   //This method is used to store an array of tables in a sequence of binary files
53   //Each file contains the Size of the table (number of words) and for each word contains the correspondent 
54   //codeword and codelength
55   Int_t   RetrieveTables(AliTPCHTable* table[],Int_t NumTable);
56   //This method is used to retrieve an array of tables from a sequence of binary files created using 
57   //the previous method 
58   void    DeleteHuffmanTree(AliTPCHNode* node);
59   //This method is used to delete an Huffman tree
60   void    VisitHuffmanTree(AliTPCHNode* node);
61   //This method realizes an in order visit of a binary tree
62   void    NextTable(Int_t Val,Int_t &NextTableType,Int_t &BunchLen,Int_t &Count)const;
63   //This method is used to deduce which is the next table that as to be used to interpret the next value
64   //reading the Altro format
65   void    StoreValue(ULong_t val,UChar_t len);
66   //This method is used to store a value in the compressed file 
67   ULong_t Mirror(ULong_t val,UChar_t len)const;
68   //This method is used to get the specular value of a given value
69   //for instance the specular value of 12345 is 54321
70   void    Flush();
71   //This method is used to complete and store the buffer in the output file when it isn't completely full 
72   ULong_t ReadWord(Int_t NumberOfBit);
73   //this method is used to read a specified number of bits from the compressed file
74   ULong_t ReadWordBuffer(Int_t NumberOfBit);
75   //this method is used to read a specified number of bits from the compressed memory buffer
76   void    ReadTrailer(Int_t &WordsNumber,Int_t &PadNumber,Int_t &RowNumber,Int_t &SecNumberr,Bool_t Memory);
77   //This method is used to read the trailer 
78   ULong_t GetDecodedWord(AliTPCHNode* root,Bool_t Memory);
79   //This method is used to get a decoded word from the compressed file
80
81   fstream f;                  // f is the logical name for the compressed and uncompressed file
82   ofstream fStat;             // Logical name for the Statistics file
83   ULong_t fBuffer;            // buffer 
84   Int_t   fDimBuffer;         // buffer dimension (32 bit)
85   Int_t   fFreeBitsBuffer;    // number of free bits inside the buffer
86   Int_t   fReadBits;          // number of bit read
87   ULong_t fPos;               // current file position
88   Int_t   fVerbose;           // verbose level (0 silent, !=0 output messages)
89   ULong_t fFillWords;         // Number of hexadecimally words (2AA pattern) inside a pad data block 
90   char*   fPointBuffer;       //pointer to the compressed raw data
91   ClassDef(AliTPCCompression,1)
92 };
93 #endif