MeVis/Foundation/Sources/ML/include/host/mlClassicHost.h

Go to the documentation of this file.

// **InsertLicense** code
//-------------------------------------------------------------------------
//-------------------------------------------------------------------------
#ifndef __mlClassicHost_H
#define __mlClassicHost_H

//ML-includes
#ifndef __mlInitSystemML_H
#include "mlInitSystemML.h"
#endif
#ifndef __mlBasics_H
#include "mlBasics.h"
#endif
#ifndef __mlPagedImage_H
#include "mlPagedImage.h"
#endif
#ifndef __mlSubImage_H
#include "mlSubImage.h"
#endif
#ifndef __mlWaitCondition_H
#include "mlWaitCondition.h"
#endif
#ifndef __mlThread_H
#include "mlThread.h"
#endif

#include <host/mlProcessingTimeLine.h>

ML_START_NAMESPACE

class Module;
class ThreadDataClass;
class ProcessAllPagesHandler;
class Host;

class MLEXPORT ClassicHost 
{

public:
  ClassicHost(Host* host);
  ~ClassicHost();

  //------------------------------------------------------

  //------------------------------------------------------

  MLErrorCode getTile(PagedImage&             outputImage,
                      SubImageBox             location,
                      MLDataType            dataType,
                      void**                data,
                      const ScaleShiftData& scaleShiftData=ScaleShiftData()) ML_RETURN_VALUE_SHOULD_BE_USED;


  // ------------------------------------------------------------------------------
  // ------------------------------------------------------------------------------
  MLErrorCode processAllPages(Module&  module,
                               MLint      outputIndex,
                               SubImageBox  region,
                               ProcessAllPagesHandler* handler
                               ) ML_RETURN_VALUE_SHOULD_BE_USED;

  //----------------------------------------------------------------------------------------
  //----------------------------------------------------------------------------------------
  void shutdownWorkerThreads();

  void enableTimeLineProfiling(bool flag) { _useTimeLineProfiling = flag; }

  ProcessingTimeLine& getProcessingTimeLine() { return _profile; }

protected:

  // ------------------------------------------------------------------------------
  // ------------------------------------------------------------------------------
  MLErrorCode _processPagesHelper(PagedImage             &outputImage,
                                  const SubImageBox      &location,
                                  MLDataType            dataType,
                                  void                 *data,
                                  const ScaleShiftData &scaleShiftData,
                                  bool                  calledByProcessAllPages) ML_RETURN_VALUE_SHOULD_BE_USED;

  ML_DISALLOW_COPY_AND_ASSIGN(ClassicHost)

  


  MLErrorCode _getTileCore(PagedImage             &outputImage,
                           SubImageBox             location,
                           MLDataType            dataType,
                           void                 *data,
                           const ScaleShiftData &scaleShiftData) ML_RETURN_VALUE_SHOULD_BE_USED;

  //------------------------------------------------------

  //------------------------------------------------------


  void _calcPages(PagedImage                 &outputImage,
                  const std::vector <MLint> pageIDs,
                  MLMemoryBlockHandle*      memoryBlockHandles);

  //----------------------------------------------------------------------------------------
  //----------------------------------------------------------------------------------------
  void _initializePageData(ThreadDataClass &tData, bool permitInCaching);

  //----------------------------------------------------------------------------------------
  //----------------------------------------------------------------------------------------
  static void _calcPagesMT(ThreadDataClass** threadDataContainers, ProcessingTimeLine::TimeLine* timeLine);

  friend struct CalcPagesWorkerThreadFunction;

  //----------------------------------------------------------------------------------------
  //----------------------------------------------------------------------------------------
  ThreadDataClass** _getWorkForWorkerThread(size_t workIndex);

  //----------------------------------------------------------------------------------------
  //----------------------------------------------------------------------------------------
  void _increaseErrorCounter();

  //------------------------------------------------------

  //------------------------------------------------------

  WaitCondition      _workAvailable;

  WaitCondition      _workDone;

  Mutex              _workAvailableMutex;

  std::vector<Thread*> _workerThreads;

  std::vector<ThreadDataClass**> _workerThreadClassData;

  bool               _shutdownWorkerThreadsFlag;

  Mutex              _countSyncMutex;

  MLint32            _errorCounter;

  MLint32            _numFinishedThreads;

  MLint32            _numLaunchedThreads;

  size_t             _maxNumPagesToCalculateInSingleWorkerThread;

  Host*              _host;

  ProcessingTimeLine _profile;
  ProcessingTimeLine::TimeLine* _guiTimeLine;

  std::vector<ProcessingTimeLine::TimeLine*> _workerThreadTimeLines;
  bool _useTimeLineProfiling;


};

ML_END_NAMESPACE

#endif