// -----------------------------------------------------------------------------
// ----- TTofTrbTdcUnpacker source file                                    -----
// -----                                                                   -----
// ----- created by C. Simon on 2014-04-03                                 -----
// -----                                                                   -----
// ----- based on TTofVftxUnpacker by P.-A. Loizeau                      -----
// ----- https://subversion.gsi.de/fairroot/cbmroot/development/ploizeau/  -----
// -----   main/unpack/tof/tdc/vftx/TTofVftxUnpacker.cxx                 -----
// ----- revision 20754, 2013-07-17                                        -----
// -----------------------------------------------------------------------------

#include "TTofTrbTdcUnpacker.h"

// Parameter header
#include "TMbsUnpackTofPar.h"

// Output data objects
#include "TTofTrbTdcBoard.h"

// Defines
#include "TofDef.h"
#include "TofTdcDef.h"

// TDC iterator
#include "HadaqTdcIterator.h"

// ROOT
#include "TClonesArray.h"
#include "TH1.h"
#include "TROOT.h"

// FairRoot
#include "FairRootManager.h"
#include "FairLogger.h"

ClassImp(TTofTrbTdcUnpacker)

TTofTrbTdcUnpacker::TTofTrbTdcUnpacker( TMbsUnpackTofPar * parIn ):
   fParUnpack( parIn ),
   fuNbActiveTrbTdc( parIn->GetNbActiveBoards( tofMbs::trbtdc ) ),
   fTrbTdcBoardCollection(0)
{
   LOG(INFO)<<"**** TTofTrbTdcUnpacker: Call TTofTrbTdcUnpacker()..."<<FairLogger::endl;

   // Recover first the TRB-TDC board objects created in TTrbUnpackTof
   FairRootManager* rootMgr = FairRootManager::Instance();
   
   fTrbTdcBoardCollection = (TClonesArray*) rootMgr->GetObject("TofTrbTdc");
   if(0 == fTrbTdcBoardCollection) 
   {
      LOG(WARNING)<<"TTofTrbTdcUnpacker::TTofTrbTdcUnpacker : no TOF TRB-TDC array! "<<FairLogger::endl;
      fuNbActiveTrbTdc = 0;
   }
    
}

TTofTrbTdcUnpacker::~TTofTrbTdcUnpacker()
{
   LOG(INFO)<<"**** TTofTrbTdcUnpacker: Call ~TTofTrbTdcUnpacker()..."<<FairLogger::endl;
  // Creation and clean-up of member histogram vectors done by TMbsUnpTofMonitor
}

void TTofTrbTdcUnpacker::Clear(Option_t *option)
{
   LOG(INFO)<<"**** TTofTrbTdcUnpacker: Call Clear()..."<<FairLogger::endl;

   fParUnpack = 0;
   fuNbActiveTrbTdc = 0;
   fTrbTdcBoardCollection = 0;
}

Int_t TTofTrbTdcUnpacker::ProcessData( hadaq::RawSubevent* tSubevent, UInt_t uStartIndex )
{
/* unclear points:
   - EPOCH reset compensation in stream
*/
  LOG(DEBUG)<<"**** TTofTrbTdcUnpacker: Call ProcessData()..."<<FairLogger::endl;

  UInt_t uTdcDataIndex = uStartIndex;

  UInt_t uTdcData = tSubevent->Data(uTdcDataIndex);
  UInt_t uTdcAddress = uTdcData & 0xffff;
  UInt_t uNbTdcDataWords = (uTdcData >> 16) & 0xffff;
  Int_t iTdcBoardIndex = fParUnpack->GetActiveTrbTdcIndex( uTdcAddress );

  TTofTrbTdcBoard* tTrbTdcBoard = (TTofTrbTdcBoard*) fTrbTdcBoardCollection->ConstructedAt( iTdcBoardIndex );

  UInt_t uTdcWordCount = 0;

  hadaq::TdcIterator tTrbTdcIterator = hadaq::TdcIterator();
  tTrbTdcIterator.assign(tSubevent, uTdcDataIndex+1, uNbTdcDataWords);

  hadaq::TdcMessage& tTrbTdcMessage = tTrbTdcIterator.msg();

  Bool_t bPreviousIsEpoch = kFALSE;
  UInt_t uPreviousChannel = 0;

  while ( tTrbTdcIterator.next() )
  {
    uTdcWordCount++;

    if( 1 == uTdcWordCount )
    {
      if ( tTrbTdcMessage.isHeaderMsg() )
      {
        tTrbTdcBoard->SetTriggerCode(tTrbTdcMessage.getHeaderTrig());
        if( tTrbTdcMessage.getHeaderErr() )
        {
          tTrbTdcBoard->SetChannelFifoIssue();
        }
      }
      else
      {
        LOG(ERROR)<<Form("First data word from TDC 0x%.4x is not a TDC HEADER word. Skip this TDC subsubevent!",uTdcAddress)<<FairLogger::endl;
        return trbtdc::process_FirstNoHeader;
      }
      
      continue;
    }

    if( 2 == uTdcWordCount )
    {
      if ( tTrbTdcMessage.isEpochMsg() )
      {
        tTrbTdcIterator.setRefEpoch( tTrbTdcIterator.getCurEpoch() );
      }
      else
      {
        LOG(ERROR)<<Form("Second data word from TDC 0x%.4x is not a TDC EPOCH word. Skip this TDC subsubevent!",uTdcAddress)<<FairLogger::endl;
        return trbtdc::process_SecondNoEpoch;
      }
      
      continue;
    }

    if( 3 == uTdcWordCount )
    {
      if ( tTrbTdcMessage.isTimeMsg() )
      {
        if( tTrbTdcMessage.getTimeChannel() == 0 )
        {
          if( trbtdc::kuHighestReasonableFineTimeBin >= tTrbTdcMessage.getTimeTmFine() )
          {
            ( tTrbTdcBoard->GetRefChannelData() ).SetData( 
              tTrbTdcMessage.getTimeChannel(),
              tTrbTdcMessage.getTimeTmFine(),
              ( UInt_t )( tTrbTdcIterator.getMsgStamp() & ( trbtdc::kiCoarseCounterSize-1 ) ),
              0,
              tTrbTdcMessage.getTimeEdge() );
            ( tTrbTdcBoard->GetRefChannelData() ).SetEpoch( tTrbTdcIterator.getCurEpoch() );
            ( tTrbTdcBoard->GetRefChannelData() ).SetFullCoarseTime( tTrbTdcIterator.getMsgStamp() );

            tTrbTdcBoard->SetTriggerTime( ( tTrbTdcBoard->GetRefChannelData() ).GetCoarseTime() );

          }
          else
          {
            LOG(ERROR)<<Form("Third data word from TDC 0x%.4x is a TDC TIME word from channel 0 but with an unreasonable fine time of 0x%.3x. Skip this TDC subsubevent!",uTdcAddress,tTrbTdcMessage.getTimeTmFine())<<FairLogger::endl;
            return trbtdc::process_ThirdBadRefTime;
          }
        }
        else
        {
          LOG(ERROR)<<Form("Third data word from TDC 0x%.4x is a TDC TIME word but not from channel 0. Skip this TDC subsubevent!",uTdcAddress)<<FairLogger::endl;
          return trbtdc::process_ThirdNoRefTime;
        }
      }
      else
      {
        LOG(ERROR)<<Form("Third data word from TDC 0x%.4x is not a TDC TIME word. Skip this TDC subsubevent!",uTdcAddress)<<FairLogger::endl;
        return trbtdc::process_ThirdNoTime;
      }
      
      continue;
    }

    if( 4 == uTdcWordCount )
    {
      if ( !tTrbTdcMessage.isEpochMsg() )
      {
        LOG(ERROR)<<Form("Fourth data word from TDC 0x%.4x is not a TDC EPOCH word. Stop unpacking this TDC subsubevent! Left words: %d",
			 uTdcAddress,uNbTdcDataWords-uTdcWordCount)
		  <<FairLogger::endl;
        return trbtdc::process_FourthNoEpoch;
      }

      bPreviousIsEpoch = kTRUE;
      continue;
    }

    if( kTRUE == bPreviousIsEpoch )
    {
      switch ( tTrbTdcMessage.getKind() ) 
      {
        case trbtdc::message_Time:
        case trbtdc::message_Time1:
        case trbtdc::message_Time2:
        case trbtdc::message_Time3:
        {
          bPreviousIsEpoch = kFALSE;

          UInt_t uChNumber         = tTrbTdcMessage.getTimeChannel();
          UInt_t uChFineTime       = tTrbTdcMessage.getTimeTmFine();
          UInt_t uChCoarseTime     = ( UInt_t )( tTrbTdcIterator.getMsgStamp() & ( trbtdc::kiCoarseCounterSize-1 ) );
          UInt_t uChEdge           = tTrbTdcMessage.getTimeEdge();
          UInt_t uChEpoch          = tTrbTdcIterator.getCurEpoch();
          ULong64_t uChFullCoarseTime = tTrbTdcIterator.getMsgStamp();

          uPreviousChannel = uChNumber;

          if ( ( 0 == uChNumber ) || ( tTrbTdcBoard->GetChannelNb() < uChNumber ) )
          {
            LOG(ERROR)<<Form("Invalid channel number %u in TDC TIME word from TDC 0x%.4x. Stop unpacking this TDC subsubevent!", uChNumber, uTdcAddress)<<FairLogger::endl;
            return trbtdc::process_BadChannelNumber;
          }

          if ( trbtdc::time_FineTimeBitMask == uChFineTime )
          {
            LOG(DEBUG2)<<Form("Hit detected in channel %u but not properly processed by TDC 0x%.4x. Skip it.", uChNumber, uTdcAddress)<<FairLogger::endl;
            continue;
          }
          else
          {
            LOG(DEBUG2)<<Form("Hit in channel %u properly processed by TDC 0x%.4x. Store it.", uChNumber, uTdcAddress)<<FairLogger::endl;
            TTofTrbTdcData tValidHit( uChNumber-1, uChFineTime, uChCoarseTime, 0, uChEdge, uChEpoch, uChFullCoarseTime );
            tTrbTdcBoard->AddData( tValidHit );
            continue;
          }
       
          break;
        }
        case trbtdc::message_Epoch:

            LOG(DEBUG3)<<Form("Two consecutive TDC EPOCH words from TDC 0x%.4x. Stop unpacking this TDC subsubevent!", uTdcAddress)<<FairLogger::endl;
            //return;

          break;

        default:

          continue;

          break;
      }

    }
    else
    {
      switch ( tTrbTdcMessage.getKind() ) 
      {
        case trbtdc::message_Time:
        case trbtdc::message_Time1:
        case trbtdc::message_Time2:
        case trbtdc::message_Time3:
        {
          UInt_t uChNumber         = tTrbTdcMessage.getTimeChannel();
          UInt_t uChFineTime       = tTrbTdcMessage.getTimeTmFine();
          UInt_t uChCoarseTime     = ( UInt_t )( tTrbTdcIterator.getMsgStamp() & ( trbtdc::kiCoarseCounterSize-1 ) );
          UInt_t uChEdge           = tTrbTdcMessage.getTimeEdge();
          UInt_t uChEpoch          = tTrbTdcIterator.getCurEpoch();
          ULong64_t uChFullCoarseTime = tTrbTdcIterator.getMsgStamp();

          if( ( 0 == uChNumber ) || ( tTrbTdcBoard->GetChannelNb() < uChNumber ) )
          {
            LOG(ERROR)<<Form("Invalid channel number %u in TDC TIME word from TDC 0x%.4x. Stop unpacking this TDC subsubevent!", uChNumber, uTdcAddress)<<FairLogger::endl;
            return trbtdc::process_BadChannelNumber;
          }

          if( uPreviousChannel != uChNumber )
          {
            LOG(ERROR)<<Form("Change in hit channel number from %u to %u without a TDC EPOCH word in between in TDC 0x%.4x. Stop unpacking this TDC subsubevent!", uPreviousChannel, uChNumber, uTdcAddress)<<FairLogger::endl;
            return trbtdc::process_ChannelButNoEpochChange;
          }

          if( trbtdc::time_FineTimeBitMask == uChFineTime )
          {
            LOG(DEBUG2)<<Form("Hit detected in channel %u but not properly processed by TDC 0x%.4x. Skip it.", uChNumber, uTdcAddress)<<FairLogger::endl;
            continue;
          }
          else
          {
            LOG(DEBUG2)<<Form("Hit in channel %u properly processed by TDC 0x%.4x. Store it.", uChNumber, uTdcAddress)<<FairLogger::endl;
            TTofTrbTdcData tValidHit( uChNumber-1, uChFineTime, uChCoarseTime, 0, uChEdge, uChEpoch, uChFullCoarseTime );
            tTrbTdcBoard->AddData( tValidHit );
            continue;
          }

          break;
        }
        case trbtdc::message_Epoch:

          bPreviousIsEpoch = kTRUE;
          continue;

          break;

        default:

          continue;

          break;
      }

    }



  }

   tTrbTdcBoard->SortData();

   LOG(DEBUG)<<Form("TRB-TDC subsubevent from FPGA 0x%.4x fully unpacked. Success!",uTdcAddress)<<FairLogger::endl;
   return trbtdc::process_Success;

}

// Histogram management
// TODO: maybe add some options to control which histograms are 
// created and filed (memory management)
void TTofTrbTdcUnpacker::CreateHistos()
{
   LOG(INFO)<<"**** TTofTrbTdcUnpacker: Call CreateHistos()..."<<FairLogger::endl;
  
   TDirectory * oldir = gDirectory; // <= To prevent histos from being sucked in by the param file of the TRootManager!
   gROOT->cd(); // <= To prevent histos from being sucked in by the param file of the TRootManager !
   
   TH1* hTemp = 0;

   fTrbTdcChannelFineTime.resize( fuNbActiveTrbTdc );
   fTrbTdcChannelCoarseTime.resize( fuNbActiveTrbTdc );

   for( Int_t iBoardIndex = 0; iBoardIndex < fuNbActiveTrbTdc; iBoardIndex++)
   {
      UInt_t uTrbNetAddress = fParUnpack->GetActiveTrbTdcAddr(iBoardIndex);

      // Board specific histograms
      hTemp = new TH1I( Form("tof_%s_ch_occ_%03d", toftdc::ksTdcHistName[ toftdc::trb ].Data(), iBoardIndex),
                        Form("Channel occupancy in TRB-TDC #%03d (0x%0.4x)", iBoardIndex, uTrbNetAddress),
                        trbtdc::kuNbChan+1, 0.0, trbtdc::kuNbChan+1 );
      fTrbTdcChannelOccupancy.push_back( hTemp );

      hTemp = new TH1I( Form("tof_%s_ch_highft_%03d", toftdc::ksTdcHistName[ toftdc::trb ].Data(), iBoardIndex),
                        Form("Fine time overshoot in TRB-TDC #%03d (0x%0.4x)", iBoardIndex, uTrbNetAddress),
                        trbtdc::kuNbChan+1, 0.0, trbtdc::kuNbChan+1 );
      fTrbTdcChannelFineTimeOvershoot.push_back( hTemp );


      hTemp = new TH1I( Form("tof_%s_ch_unproc_%03d", toftdc::ksTdcHistName[ toftdc::trb ].Data(), iBoardIndex),
                        Form("Unprocessed hits in TRB-TDC #%03d (0x%0.4x)", iBoardIndex, uTrbNetAddress),
                        trbtdc::kuNbChan+1, 0.0, trbtdc::kuNbChan+1 );
      fTrbTdcChannelUnprocessedHits.push_back( hTemp );
      
      // Reference Channel specific histograms
      hTemp = new TH1I( Form("tof_%s_ft_b%03d_ref", 
                                 toftdc::ksTdcHistName[ toftdc::trb ].Data(), 
                                 iBoardIndex),
                        Form("Counts per fine-time bin for reference channel on TRB-TDC #%03d (0x%0.4x)", iBoardIndex, uTrbNetAddress),
                        trbtdc::kiFineCounterSize, -0.5, trbtdc::kiFineCounterSize - 0.5 );

      (fTrbTdcChannelFineTime[iBoardIndex]).push_back( hTemp );

      hTemp = new TH1I( Form("tof_%s_ct_b%03d_ref", 
                                 toftdc::ksTdcHistName[ toftdc::trb ].Data(), 
                                 iBoardIndex),
                        Form("Counts per coarse-time bin for reference channel on TRB-TDC #%03d (0x%0.4x)", iBoardIndex, uTrbNetAddress),
                           trbtdc::kiCoarseCounterSize/1024/512, -0.5, trbtdc::kiCoarseCounterSize/1024/512 - 0.5 );
      // TODO: remove hard coding
      (fTrbTdcChannelCoarseTime[iBoardIndex]).push_back( hTemp );

      for( Int_t iChannelIndex = 0; iChannelIndex < trbtdc::kuNbChan; iChannelIndex++)
      {
         // Channel specific histograms
         hTemp = new TH1I( Form("tof_%s_ft_b%03d_ch%03d", 
                                    toftdc::ksTdcHistName[ toftdc::trb ].Data(), 
                                    iBoardIndex, iChannelIndex),
                           Form("Counts per fine-time bin for channel %3d on TRB-TDC #%03d (0x%0.4x)", iChannelIndex, iBoardIndex, uTrbNetAddress),
                           trbtdc::kiFineCounterSize, -0.5, trbtdc::kiFineCounterSize - 0.5 );

         (fTrbTdcChannelFineTime[iBoardIndex]).push_back( hTemp );

         hTemp = new TH1I( Form("tof_%s_ct_b%03d_ch%03d", 
                                    toftdc::ksTdcHistName[ toftdc::trb ].Data(), 
                                    iBoardIndex, iChannelIndex),
                           Form("Counts per coarse-time bin for channel %3d on TRB-TDC #%03d (0x%0.4x)", iChannelIndex, iBoardIndex, uTrbNetAddress),
                           trbtdc::kiCoarseCounterSize/1024/512, -0.5, trbtdc::kiCoarseCounterSize/1024/512 - 0.5 );
// TODO: remove hard coding
         (fTrbTdcChannelCoarseTime[iBoardIndex]).push_back( hTemp );

         
      }
      
   }
   
   gDirectory->cd( oldir->GetPath() ); // <= To prevent histos from being sucked in by the param file of the TRootManager!
}

void TTofTrbTdcUnpacker::FillHistos()
{
   LOG(DEBUG)<<"**** TTofTrbTdcUnpacker: Call FillHistos()..."<<FairLogger::endl;

   // loop over TDC boards
   TTofTrbTdcBoard * tTrbTdcBoard;

   for( Int_t iBoardIndex = 0; iBoardIndex < fuNbActiveTrbTdc; iBoardIndex++)
   { 
      UInt_t uTrbNetAddress = fParUnpack->GetActiveTrbTdcAddr(iBoardIndex);

      tTrbTdcBoard = (TTofTrbTdcBoard*) fTrbTdcBoardCollection->ConstructedAt(iBoardIndex);

      // Loop over regular channels
      for( Int_t iDataIndex = 0; iDataIndex < tTrbTdcBoard->GetDataNb() ; iDataIndex++ )
      {
         TTofTrbTdcData data = tTrbTdcBoard->GetData( iDataIndex );
         TString sTemp = Form( " TTofTrbTdcUnpacker::FillHistos: Addr 0x%0.4x Board #%03d Data #%04d Chan %3d CT %7d FT %7d",
                  uTrbNetAddress, iBoardIndex, iDataIndex, data.GetChannel()+1, 
                  data.GetCoarseTime(), data.GetFineTime() );
         LOG(DEBUG2)<<sTemp<<FairLogger::endl;
         
         fTrbTdcChannelOccupancy[iBoardIndex]->Fill( data.GetChannel() + 1 );

         if( trbtdc::time_FineTimeBitMask == data.GetFineTime() )
         {
           fTrbTdcChannelUnprocessedHits[iBoardIndex]->Fill( data.GetChannel() + 1 );
         }

         if( trbtdc::kuHighestReasonableFineTimeBin < data.GetFineTime() )
         {
           fTrbTdcChannelFineTimeOvershoot[iBoardIndex]->Fill( data.GetChannel() + 1 );           
         }

         fTrbTdcChannelFineTime[iBoardIndex][ data.GetChannel() +1 ]->Fill( data.GetFineTime() );
         fTrbTdcChannelCoarseTime[iBoardIndex][ data.GetChannel() +1 ]->Fill( data.GetCoarseTime()%2048 );
      }

      // Consider the respective reference channel
      fTrbTdcChannelOccupancy[iBoardIndex]->Fill(0);

      if( trbtdc::time_FineTimeBitMask == ( tTrbTdcBoard->GetRefChannelData() ).GetFineTime() )
      {
        fTrbTdcChannelUnprocessedHits[iBoardIndex]->Fill(0);
      }

      if( trbtdc::kuHighestReasonableFineTimeBin < ( tTrbTdcBoard->GetRefChannelData() ).GetFineTime() )
      {
        fTrbTdcChannelFineTimeOvershoot[iBoardIndex]->Fill(0);           
      }

      fTrbTdcChannelFineTime[iBoardIndex][0]->Fill( ( tTrbTdcBoard->GetRefChannelData() ).GetFineTime() );
      fTrbTdcChannelCoarseTime[iBoardIndex][0]->Fill( ( tTrbTdcBoard->GetRefChannelData() ).GetCoarseTime()%2048 );

   }
}

void TTofTrbTdcUnpacker::WriteHistos( TDirectory* inDir)
{
   LOG(INFO)<<"**** TTofTrbTdcUnpacker: Call WriteHistos()..."<<FairLogger::endl;

   TDirectory * oldir = gDirectory;
   TDirectory * cdTrbTdcUnp[fuNbActiveTrbTdc];
   
   for( Int_t iBoardIndex = 0; iBoardIndex < fuNbActiveTrbTdc; iBoardIndex++)
   { 
      cdTrbTdcUnp[iBoardIndex] = inDir->mkdir( Form( "Unp_%s_%03d", toftdc::ksTdcHistName[ toftdc::trb ].Data(), iBoardIndex) );
      cdTrbTdcUnp[iBoardIndex]->cd();    // make the "Unp..." directory the current directory
      
      fTrbTdcChannelOccupancy[iBoardIndex]->Write();
      fTrbTdcChannelFineTimeOvershoot[iBoardIndex]->Write();
      fTrbTdcChannelUnprocessedHits[iBoardIndex]->Write();
      
      for( Int_t iChannelIndex = 0; iChannelIndex <= trbtdc::kuNbChan; iChannelIndex++)
      {
         fTrbTdcChannelFineTime[iBoardIndex][iChannelIndex]->Write();
         fTrbTdcChannelCoarseTime[iBoardIndex][iChannelIndex]->Write();
      }
      
   }
}

void TTofTrbTdcUnpacker::DeleteHistos()
{
   LOG(INFO)<<"**** TTofTrbTdcUnpacker: Call DeleteHistos()..."<<FairLogger::endl;

   fTrbTdcChannelOccupancy.clear();
   fTrbTdcChannelFineTimeOvershoot.clear();
   fTrbTdcChannelUnprocessedHits.clear();

   for( Int_t iBoardIndex = 0; iBoardIndex < fuNbActiveTrbTdc; iBoardIndex++)
   {
      (fTrbTdcChannelFineTime[iBoardIndex]).clear();
      (fTrbTdcChannelCoarseTime[iBoardIndex]).clear();
   }

   fTrbTdcChannelFineTime.clear();
   fTrbTdcChannelCoarseTime.clear();
}