b458c75ac7deb23e6756272b8a1cf4f93034fd03
[u/mrichter/AliRoot.git] / RAW / AliRawReaderRoot.cxx
1 /**************************************************************************
2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
3  *                                                                        *
4  * Author: The ALICE Off-line Project.                                    *
5  * Contributors are mentioned in the code where appropriate.              *
6  *                                                                        *
7  * Permission to use, copy, modify and distribute this software and its   *
8  * documentation strictly for non-commercial purposes is hereby granted   *
9  * without fee, provided that the above copyright notice appears in all   *
10  * copies and that both the copyright notice and this permission notice   *
11  * appear in the supporting documentation. The authors make no claims     *
12  * about the suitability of this software for any purpose. It is          *
13  * provided "as is" without express or implied warranty.                  *
14  **************************************************************************/
15
16 /* $Id$ */
17
18 ///////////////////////////////////////////////////////////////////////////////
19 ///
20 /// This is a class for reading raw data from a root file.
21 ///
22 /// The root file is expected to contain a tree of name "RAW" with
23 /// a branch of name "rawevent" which contains objects of type
24 /// AliRawEvent.
25 /// 
26 /// The file name and the event number are arguments of the constructor
27 /// of AliRawReaderRoot.
28 ///
29 ///////////////////////////////////////////////////////////////////////////////
30
31 #include <TFile.h>
32 #include <TTree.h>
33 #include "AliRawReaderRoot.h"
34 #include "AliRawEvent.h"
35 #include "AliRawEventHeader.h"
36 #include "AliRawEquipment.h"
37 #include "AliRawEquipmentHeader.h"
38 #include "AliRawData.h"
39
40
41 ClassImp(AliRawReaderRoot)
42
43
44 AliRawReaderRoot::AliRawReaderRoot(const char* fileName, Int_t eventNumber) :
45   fFile(NULL),
46   fBranch(NULL),
47   fEventIndex(eventNumber),
48   fEvent(NULL),
49   fSubEventIndex(0),
50   fSubEvent(NULL),
51   fEquipmentIndex(0),
52   fEquipment(NULL),
53   fRawData(NULL),
54   fPosition(NULL),
55   fEnd(NULL)
56 {
57 // create an object to read digits from the given input file for the
58 // event with the given number
59
60   TDirectory* dir = gDirectory;
61   fFile = TFile::Open(fileName);
62   dir->cd();
63   if (!fFile || !fFile->IsOpen()) {
64     Error("AliRawReaderRoot", "could not open file %s", fileName);
65     return;
66   }
67   TTree* tree = (TTree*) fFile->Get("RAW");
68   if (!tree) {
69     Error("AliRawReaderRoot", "no raw data tree found");
70     return;
71   }
72   fBranch = tree->GetBranch("rawevent");
73   if (!fBranch) {
74     Error("AliRawReaderRoot", "no raw data branch found");
75     return;
76   }
77
78   fEvent = new AliRawEvent;
79   fBranch->SetAddress(&fEvent);
80   if (fEventIndex >= 0) {
81     if (fBranch->GetEntry(fEventIndex) <= 0) {
82       Error("AliRawReaderRoot", "no event with number %d found", fEventIndex);
83       return;
84     }
85   }
86 }
87
88 AliRawReaderRoot::AliRawReaderRoot(AliRawEvent* event) :
89   fFile(NULL),
90   fBranch(NULL),
91   fEventIndex(-1),
92   fEvent(event),
93   fSubEventIndex(0),
94   fSubEvent(NULL),
95   fEquipmentIndex(0),
96   fEquipment(NULL),
97   fRawData(NULL),
98   fPosition(NULL),
99   fEnd(NULL)
100 {
101 // create an object to read digits from the given raw event
102
103 }
104
105 AliRawReaderRoot::AliRawReaderRoot(const AliRawReaderRoot& rawReader) :
106   AliRawReader(rawReader),
107   fFile(NULL),
108   fBranch(NULL),
109   fEventIndex(rawReader.fEventIndex),
110   fEvent(NULL),
111   fSubEventIndex(rawReader.fSubEventIndex),
112   fSubEvent(NULL),
113   fEquipmentIndex(rawReader.fEquipmentIndex),
114   fEquipment(NULL),
115   fRawData(NULL),
116   fPosition(NULL),
117   fEnd(NULL)
118 {
119 // copy constructor
120
121   if (rawReader.fFile) {
122     TDirectory* dir = gDirectory;
123     fFile = TFile::Open(rawReader.fFile->GetName());
124     dir->cd();
125     if (!fFile || !fFile->IsOpen()) {
126       Error("AliRawReaderRoot", "could not open file %s", 
127             rawReader.fFile->GetName());
128       return;
129     }
130     TTree* tree = (TTree*) fFile->Get("RAW");
131     if (!tree) {
132       Error("AliRawReaderRoot", "no raw data tree found");
133       return;
134     }
135     fBranch = tree->GetBranch("rawevent");
136     if (!fBranch) {
137       Error("AliRawReaderRoot", "no raw data branch found");
138       return;
139     }
140
141     fEvent = new AliRawEvent;
142     fBranch->SetAddress(&fEvent);
143     if (fEventIndex >= 0) {
144       if (fBranch->GetEntry(fEventIndex) <= 0) {
145         Error("AliRawReaderRoot", "no event with number %d found", 
146               fEventIndex);
147         return;
148       }
149     }
150   } else {
151     fEvent = rawReader.fEvent;
152   }
153
154   if (fSubEventIndex > 0) {
155     fSubEvent = fEvent->GetSubEvent(fSubEventIndex-1);
156     fEquipment = fSubEvent->GetEquipment(fEquipmentIndex);
157     fRawData = fEquipment->GetRawData();
158       fCount = 0;
159     fHeader = (AliRawDataHeader*) ((UChar_t*) fRawData->GetBuffer() + 
160       ((UChar_t*) rawReader.fHeader - 
161        (UChar_t*) rawReader.fRawData->GetBuffer()));
162     fPosition = (UChar_t*) fRawData->GetBuffer() + 
163       (rawReader.fPosition - (UChar_t*) rawReader.fRawData->GetBuffer());
164     fEnd = ((UChar_t*) fRawData->GetBuffer()) + fRawData->GetSize();
165   }
166 }
167
168 AliRawReaderRoot& AliRawReaderRoot::operator = (const AliRawReaderRoot& 
169                                                 rawReader)
170 {
171 // assignment operator
172
173   this->~AliRawReaderRoot();
174   new(this) AliRawReaderRoot(rawReader);
175   return *this;
176 }
177
178 AliRawReaderRoot::~AliRawReaderRoot()
179 {
180 // delete objects and close root file
181
182   if (fFile) {
183     if (fEvent) delete fEvent;
184     fFile->Close();
185     delete fFile;
186   }
187 }
188
189
190 UInt_t AliRawReaderRoot::GetType() const
191 {
192 // get the type from the event header
193
194   if (!fEvent) return 0;
195   return fEvent->GetHeader()->GetType();
196 }
197
198 UInt_t AliRawReaderRoot::GetRunNumber() const
199 {
200 // get the run number from the event header
201
202   if (!fEvent) return 0;
203   return fEvent->GetHeader()->GetRunNumber();
204 }
205
206 const UInt_t* AliRawReaderRoot::GetEventId() const
207 {
208 // get the event id from the event header
209
210   if (!fEvent) return NULL;
211   return fEvent->GetHeader()->GetId();
212 }
213
214 const UInt_t* AliRawReaderRoot::GetTriggerPattern() const
215 {
216 // get the trigger pattern from the event header
217
218   if (!fEvent) return NULL;
219   return fEvent->GetHeader()->GetTriggerPattern();
220 }
221
222 const UInt_t* AliRawReaderRoot::GetDetectorPattern() const
223 {
224 // get the detector pattern from the event header
225
226   if (!fEvent) return NULL;
227   return fEvent->GetHeader()->GetDetectorPattern();
228 }
229
230 const UInt_t* AliRawReaderRoot::GetAttributes() const
231 {
232 // get the type attributes from the event header
233
234   if (!fEvent) return NULL;
235   return fEvent->GetHeader()->GetTypeAttribute();
236 }
237
238 UInt_t AliRawReaderRoot::GetLDCId() const
239 {
240 // get the LDC Id from the event header
241
242   if (!fEvent || !fSubEvent) return 0;
243   return fSubEvent->GetHeader()->GetLDCId();
244 }
245
246 UInt_t AliRawReaderRoot::GetGDCId() const
247 {
248 // get the GDC Id from the event header
249
250   if (!fEvent) return 0;
251   return fEvent->GetHeader()->GetGDCId();
252 }
253
254
255 Int_t AliRawReaderRoot::GetEquipmentSize() const
256 {
257 // get the size of the equipment
258
259   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
260   return fEquipment->GetEquipmentHeader()->GetEquipmentSize();
261 }
262
263 Int_t AliRawReaderRoot::GetEquipmentType() const
264 {
265 // get the type from the equipment header
266
267   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
268   return fEquipment->GetEquipmentHeader()->GetEquipmentType();
269 }
270
271 Int_t AliRawReaderRoot::GetEquipmentId() const
272 {
273 // get the ID from the equipment header
274
275   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return -1;
276   return fEquipment->GetEquipmentHeader()->GetId();
277 }
278
279 const UInt_t* AliRawReaderRoot::GetEquipmentAttributes() const
280 {
281 // get the attributes from the equipment header
282
283   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return NULL;
284   return fEquipment->GetEquipmentHeader()->GetTypeAttribute();
285 }
286
287 Int_t AliRawReaderRoot::GetEquipmentElementSize() const
288 {
289 // get the basic element size from the equipment header
290
291   if (!fEvent || !fEquipment || !fEquipment->GetEquipmentHeader()) return 0;
292   return fEquipment->GetEquipmentHeader()->GetBasicSizeType();
293 }
294
295
296 Bool_t AliRawReaderRoot::ReadHeader()
297 {
298 // read a data header at the current position
299 // returns kFALSE if the data header could not be read
300
301   fErrorCode = 0;
302   if (!fEvent) return kFALSE;
303
304   do {
305     // skip payload (if event was not selected)
306     if (fCount > 0) fPosition += fCount;
307
308     // get the first or the next equipment if at the end of an equipment
309     if (!fEquipment || (fPosition >= fEnd)) {
310
311       // get the first or the next sub event if at the end of a sub event
312       if (!fSubEvent || (fEquipmentIndex >= fSubEvent->GetNEquipments())) {
313
314         // check for end of event data
315         if (fSubEventIndex >= fEvent->GetNSubEvents()) return kFALSE;
316         fSubEvent = fEvent->GetSubEvent(fSubEventIndex++);
317
318         // check the magic word of the sub event
319         if (!fSubEvent->GetHeader()->IsValid()) {
320           Error("ReadHeader", "wrong magic number in sub event!");
321           fSubEvent->GetHeader()->Dump();
322           fErrorCode = kErrMagic;
323           return kFALSE;
324         }
325
326         fEquipmentIndex = 0;
327         fEquipment = NULL;
328         fRawData = NULL;
329       }
330
331       // get the next equipment and raw data
332       fCount = 0;
333       fEquipment = fSubEvent->GetEquipment(fEquipmentIndex++);
334       if (!fEquipment) continue;
335       fRawData = fEquipment->GetRawData();
336       if (!fRawData) {
337         fPosition = fEnd;
338         continue;
339       }
340       fPosition = (UChar_t*) fRawData->GetBuffer();
341       fEnd = ((UChar_t*) fRawData->GetBuffer()) + fRawData->GetSize();
342     }
343
344     // continue with the next equipment if no data left in the payload
345     if (fPosition >= fEnd) continue;
346
347     // check that there are enough bytes left for the data header
348     if (fPosition + sizeof(AliRawDataHeader) > fEnd) {
349       Error("ReadHeader", "could not read data header!");
350       Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
351       fEquipment->GetEquipmentHeader()->Dump();
352       fCount = 0;
353       fPosition = fEnd;
354       fErrorCode = kErrNoDataHeader;
355       continue;
356     }
357
358     // "read" the data header
359     fHeader = (AliRawDataHeader*) fPosition;
360     fPosition += sizeof(AliRawDataHeader);
361     if (fHeader->fSize != 0xFFFFFFFF) {
362       fCount = fHeader->fSize - sizeof(AliRawDataHeader);
363     } else {
364       fCount = fEnd - fPosition;
365     }
366
367     // check consistency of data size in the header and in the sub event
368     if (fPosition + fCount > fEnd) {  
369       Error("ReadHeader", "size in data header exceeds event size!");
370       Warning("ReadHeader", "skipping %d bytes", fEnd - fPosition);
371       fEquipment->GetEquipmentHeader()->Dump();
372       fCount = 0;
373       fPosition = fEnd;
374       fErrorCode = kErrSize;
375       continue;
376     }
377
378   } while (!IsSelected());
379
380   return kTRUE;
381 }
382
383 Bool_t AliRawReaderRoot::ReadNextData(UChar_t*& data)
384 {
385 // reads the next payload at the current position
386 // returns kFALSE if the data could not be read
387
388   fErrorCode = 0;
389   while (fCount == 0) {
390     if (!ReadHeader()) return kFALSE;
391   }
392   data = fPosition;
393   fPosition += fCount;  
394   fCount = 0;
395   return kTRUE;
396 }
397
398 Bool_t AliRawReaderRoot::ReadNext(UChar_t* data, Int_t size)
399 {
400 // reads the next block of data at the current position
401 // returns kFALSE if the data could not be read
402
403   fErrorCode = 0;
404   if (fPosition + size > fEnd) {
405     Error("ReadNext", "could not read data!");
406     fErrorCode = kErrOutOfBounds;
407     return kFALSE;
408   }
409   memcpy(data, fPosition, size);
410   fPosition += size;
411   fCount -= size;
412   return kTRUE;
413 }
414
415
416 Bool_t AliRawReaderRoot::Reset()
417 {
418 // reset the current position to the beginning of the event
419
420   fSubEventIndex = 0;
421   fSubEvent = NULL;
422   fEquipmentIndex = 0;
423   fEquipment = NULL;
424   fRawData = NULL;
425   fHeader = NULL;
426
427   fCount = 0;
428   fPosition = fEnd = NULL;
429   return kTRUE;
430 }
431
432
433 Bool_t AliRawReaderRoot::NextEvent()
434 {
435 // go to the next event in the root file
436
437   if (!fFile) return kFALSE;
438
439   do {
440     if (fBranch->GetEntry(fEventIndex+1) <= 0) {
441       delete fEvent;
442       fEvent = new AliRawEvent;
443       fBranch->SetAddress(&fEvent);
444       return kFALSE;
445     }
446     fEventIndex++;
447   } while (!IsEventSelected());
448   return Reset();
449 }
450
451 Bool_t AliRawReaderRoot::RewindEvents()
452 {
453 // go back to the beginning of the root file
454
455   if (!fFile) return kFALSE;
456
457   fEventIndex = -1;
458   delete fEvent;
459   fEvent = new AliRawEvent;
460   fBranch->SetAddress(&fEvent);
461   return Reset();
462 }
463
464
465 Int_t AliRawReaderRoot::CheckData() const
466 {
467 // check the consistency of the data
468
469   if (!fEvent) return 0;
470
471   AliRawEvent* subEvent = NULL;
472   Int_t subEventIndex = 0;
473   AliRawEquipment* equipment = NULL;
474   Int_t equipmentIndex = 0;
475   UChar_t* position = 0;
476   UChar_t* end = 0;
477   Int_t result = 0;
478
479   while (kTRUE) {
480     // get the first or the next sub event if at the end of an equipment
481     if (!subEvent || (equipmentIndex >= subEvent->GetNEquipments())) {
482
483       // check for end of event data
484       if (subEventIndex >= fEvent->GetNSubEvents()) return result;
485       subEvent = fEvent->GetSubEvent(subEventIndex++);
486
487       // check the magic word of the sub event
488       if (!fSubEvent->GetHeader()->IsValid()) {
489         result |= kErrMagic;
490         return result;
491       }
492
493       equipmentIndex = 0;
494     }
495
496     // get the next equipment and raw data
497     equipment = subEvent->GetEquipment(equipmentIndex++);
498     if (!equipment) continue;
499     AliRawData* rawData = equipment->GetRawData();
500     if (!rawData) continue;
501     position = (UChar_t*) rawData->GetBuffer();
502     end = ((UChar_t*) rawData->GetBuffer()) + rawData->GetSize();
503
504     // continue with the next sub event if no data left in the payload
505     if (position >= end) continue;
506
507     // check that there are enough bytes left for the data header
508     if (position + sizeof(AliRawDataHeader) > end) {
509       result |= kErrNoDataHeader;
510       continue;
511     }
512
513     // check consistency of data size in the header and in the equipment
514     AliRawDataHeader* header = (AliRawDataHeader*) position;
515     if (header->fSize != 0xFFFFFFFF) {
516       if (position + header->fSize > end) {
517         result |= kErrSize;
518       }
519     }
520   };
521
522   return result;
523 }