/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/

#ifndef itkGPUImageDataManager_h
#define itkGPUImageDataManager_h

#include "itkObject.h"
#include "itkTimeStamp.h"
#include "itkLightObject.h"
#include "itkObjectFactory.h"
#include "itkOpenCLUtil.h"
#include "itkGPUDataManager.h"
#include "itkGPUContextManager.h"
#include <mutex>

namespace itk
{
template <typename TPixel, unsigned int VDimension>
class GPUImage;

/**
 * \class GPUImageDataManager
 *
 * DataManager for GPUImage. This class will take care of data synchronization
 * between CPU Image and GPU Image.
 *
 * \ingroup ITKGPUCommon
 */
template <typename ImageType>
class ITK_TEMPLATE_EXPORT GPUImageDataManager : public GPUDataManager
{
  // allow GPUKernelManager to access GPU buffer pointer
  friend class GPUKernelManager;
  friend class GPUImage<typename ImageType::PixelType, ImageType::ImageDimension>;

public:
  ITK_DISALLOW_COPY_AND_MOVE(GPUImageDataManager);

  using Self = GPUImageDataManager;
  using Superclass = GPUDataManager;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkNewMacro(Self);
  itkOverrideGetNameOfClassMacro(GPUImageDataManager);

  static constexpr unsigned int ImageDimension = ImageType::ImageDimension;

  itkGetModifiableObjectMacro(GPUBufferedRegionIndex, GPUDataManager);
  itkGetModifiableObjectMacro(GPUBufferedRegionSize, GPUDataManager);

  void
  SetImagePointer(ImageType * img);

  ImageType *
  GetImagePointer()
  {
    return this->m_Image.GetPointer();
  }

  /** actual GPU->CPU memory copy takes place here */
  virtual void
  MakeCPUBufferUpToDate();

  /** actual CPU->GPU memory copy takes place here */
  virtual void
  MakeGPUBufferUpToDate();

protected:
  GPUImageDataManager() = default;
  ~GPUImageDataManager() override = default;

private:
  WeakPointer<ImageType> m_Image{}; // WeakPointer has to be used here
                                    // to avoid SmartPointer loop
  int                              m_BufferedRegionIndex[ImageType::ImageDimension]{};
  int                              m_BufferedRegionSize[ImageType::ImageDimension]{};
  typename GPUDataManager::Pointer m_GPUBufferedRegionIndex{};
  typename GPUDataManager::Pointer m_GPUBufferedRegionSize{};
};

} // namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkGPUImageDataManager.hxx"
#endif

#endif
