mlClassicHost.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef ML_CLASSIC_HOST_H
#define ML_CLASSIC_HOST_H

 
//ML-includes
#include "mlInitSystemML.h"
#include "mlPagedImage.h"
#include "mlWaitCondition.h"
#include <mlThread.h>
 
#include <host/mlProcessingTimeLine.h>
 
ML_START_NAMESPACE

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

class MLEXPORT ClassicHost
{
 
public:
  ClassicHost(Host* host);
  ~ClassicHost();
 
  //------------------------------------------------------
  //------------------------------------------------------

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

 
  // ------------------------------------------------------------------------------
  // ------------------------------------------------------------------------------
  [[nodiscard]]
  MLErrorCode processAllPages(Module&  module,
                               MLint      outputIndex,
                               SubImageBox  region,
                               ProcessAllPagesHandler* handler
                               );
 
  //----------------------------------------------------------------------------------------
  //----------------------------------------------------------------------------------------
  void shutdownWorkerThreads();

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

  ProcessingTimeLine& getProcessingTimeLine() { return _profile; }
 
protected:
 
  // ------------------------------------------------------------------------------
  // ------------------------------------------------------------------------------
  [[nodiscard]]
  MLErrorCode _processPagesHelper(PagedImage             &outputImage,
                                  const SubImageBox      &location,
                                  MLDataType            dataType,
                                  void                 *data,
                                  const ScaleShiftData &scaleShiftData,
                                  bool                  calledByProcessAllPages);
 
  ML_DISALLOW_COPY_AND_ASSIGN(ClassicHost)
 
  
  [[nodiscard]]
  MLErrorCode _getTileCore(PagedImage             &outputImage,
                           SubImageBox             location,
                           MLDataType            dataType,
                           void                 *data,
                           const ScaleShiftData &scaleShiftData);
 
  //------------------------------------------------------
  //------------------------------------------------------


  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