/*=========================================================================
 *
 *  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.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#include "itkTemporalDataObject.h"


namespace itk
{

//----------------------------------------------------------------------------
TemporalDataObject::TemporalDataObject()
  : m_LargestPossibleTemporalRegion()
  , m_RequestedTemporalRegion()
  , m_BufferedTemporalRegion()

{
  m_DataObjectBuffer = BufferType::New();
}

//----------------------------------------------------------------------------
TemporalDataObject::~TemporalDataObject() = default;

//----------------------------------------------------------------------------
TemporalDataObject::TemporalUnitType
TemporalDataObject::GetTemporalUnit() const
{
  return m_TemporalUnit;
}

//----------------------------------------------------------------------------
void
TemporalDataObject::SetTemporalUnitToFrame()
{
  m_TemporalUnit = TemporalUnitEnum::Frame;
}

//----------------------------------------------------------------------------
void
TemporalDataObject::SetTemporalUnitToRealTime()
{
  m_TemporalUnit = TemporalUnitEnum::RealTime;
}

//----------------------------------------------------------------------------
void
TemporalDataObject::SetTemporalUnitToFrameAndRealTime()
{
  m_TemporalUnit = TemporalUnitEnum::FrameAndRealTime;
}

//----------------------------------------------------------------------------
SizeValueType
TemporalDataObject::GetNumberOfBuffers()
{
  return m_DataObjectBuffer->GetNumberOfBuffers();
}

//----------------------------------------------------------------------------
void
TemporalDataObject::SetNumberOfBuffers(SizeValueType num)
{
  m_DataObjectBuffer->SetNumberOfBuffers(num);
}

//----------------------------------------------------------------------------
void
TemporalDataObject::SetLargestPossibleTemporalRegion(const TemporalRegionType & region)
{
  m_LargestPossibleTemporalRegion = region;
  this->Modified();
}

//----------------------------------------------------------------------------
const TemporalDataObject::TemporalRegionType &
TemporalDataObject::GetLargestPossibleTemporalRegion() const
{
  return m_LargestPossibleTemporalRegion;
}

//----------------------------------------------------------------------------
void
TemporalDataObject::SetBufferedTemporalRegion(const TemporalRegionType & region)
{
  m_BufferedTemporalRegion = region;
  this->Modified();
}

//----------------------------------------------------------------------------
const TemporalDataObject::TemporalRegionType &
TemporalDataObject::GetBufferedTemporalRegion() const
{
  return m_BufferedTemporalRegion;
}

//----------------------------------------------------------------------------
void
TemporalDataObject::SetRequestedTemporalRegion(const TemporalRegionType & region)
{
  m_RequestedTemporalRegion = region;
  this->Modified();
}

//----------------------------------------------------------------------------
const TemporalDataObject::TemporalRegionType &
TemporalDataObject::GetRequestedTemporalRegion() const
{
  return m_RequestedTemporalRegion;
}

//----------------------------------------------------------------------------
const TemporalDataObject::TemporalRegionType
TemporalDataObject::GetUnbufferedRequestedTemporalRegion()
{
  // If nothing is buffered or nothing is requested, just return the entire request
  if (m_BufferedTemporalRegion.GetFrameDuration() == 0 || m_RequestedTemporalRegion.GetFrameDuration() == 0)
  {
    return m_RequestedTemporalRegion;
  }

  // Get the start and end of the buffered and requested temporal regions
  SizeValueType reqStart = m_RequestedTemporalRegion.GetFrameStart();
  SizeValueType reqEnd = m_RequestedTemporalRegion.GetFrameStart() + m_RequestedTemporalRegion.GetFrameDuration() - 1;

  SizeValueType bufStart = m_BufferedTemporalRegion.GetFrameStart();
  SizeValueType bufEnd = m_BufferedTemporalRegion.GetFrameStart() + m_BufferedTemporalRegion.GetFrameDuration() - 1;

  // If the request starts after the buffered region, return the whole request
  if (reqStart > bufEnd)
  {
    return m_RequestedTemporalRegion;
  }

  // Handle case with unbuffered frames at beginning and end
  if (reqStart < bufStart && reqEnd > bufEnd)
  {
    itkDebugMacro("Unbuffered frames at beginning and end. Returning entire "
                  << "requested region as unbuffered");
    return this->m_RequestedTemporalRegion;
  }

  // Handle case with unbuffered frames at end -- TODO: FIX FOR REAL TIME!!!!!
  else if (reqEnd > bufEnd)
  {
    TemporalRegionType out;
    out.SetFrameStart(bufEnd + 1);
    out.SetFrameDuration(reqEnd - bufEnd);
    return out;
  }

  // Handle case with unbuffered frames at beginning -- TODO: FIX FOR REAL TIME!!!!!
  else if (reqStart < bufStart)
  {
    TemporalRegionType out;
    out.SetFrameStart(reqStart);
    out.SetFrameDuration(bufStart - reqStart);
    return out;
  }

  // Otherwise, nothing unbuffered
  else
  {
    TemporalRegionType out;
    out.SetFrameStart(0);
    out.SetFrameDuration(0);
    return out;
  }
}

//----------------------------------------------------------------------------
void
TemporalDataObject::SetRequestedRegionToLargestPossibleRegion()
{
  this->SetRequestedTemporalRegion(this->GetLargestPossibleTemporalRegion());
}

//----------------------------------------------------------------------------
bool
TemporalDataObject::RequestedRegionIsOutsideOfTheBufferedRegion()
{
  bool frameFlag = m_RequestedTemporalRegion.GetFrameStart() < m_BufferedTemporalRegion.GetFrameStart();
  frameFlag |= m_RequestedTemporalRegion.GetFrameDuration() + m_RequestedTemporalRegion.GetFrameStart() >
               m_BufferedTemporalRegion.GetFrameDuration() + m_BufferedTemporalRegion.GetFrameStart();
  bool realTimeFlag = m_RequestedTemporalRegion.GetRealStart() < m_BufferedTemporalRegion.GetRealStart();
  realTimeFlag |= m_RequestedTemporalRegion.GetRealStart() + m_RequestedTemporalRegion.GetRealDuration() >
                  m_BufferedTemporalRegion.GetRealStart() + m_BufferedTemporalRegion.GetRealDuration();

  switch (m_TemporalUnit)
  {
    case TemporalUnitEnum::Frame:
    {
      return frameFlag;
    }
    case TemporalUnitEnum::RealTime:
    {
      return realTimeFlag;
    }
    case TemporalUnitEnum::FrameAndRealTime:
    {
      return frameFlag || realTimeFlag;
    }
    default:
      itkExceptionMacro("itk::TemporalDataObject::"
                        << "RequestedRegionIsOutsideOfTheBufferedRegion() "
                        << "Invalid Temporal Unit");
  }
}

//----------------------------------------------------------------------------
bool
TemporalDataObject::VerifyRequestedRegion()
{
  bool frameFlag = m_RequestedTemporalRegion.GetFrameStart() >= m_LargestPossibleTemporalRegion.GetFrameStart();
  frameFlag &= m_RequestedTemporalRegion.GetFrameDuration() <= m_LargestPossibleTemporalRegion.GetFrameDuration();
  bool realTimeFlag = m_RequestedTemporalRegion.GetRealStart() >= m_LargestPossibleTemporalRegion.GetRealStart();
  realTimeFlag &= m_RequestedTemporalRegion.GetRealDuration() <= m_LargestPossibleTemporalRegion.GetRealDuration();
  switch (m_TemporalUnit)
  {
    case TemporalUnitEnum::Frame:
    {
      return frameFlag;
    }
    case TemporalUnitEnum::RealTime:
    {
      return realTimeFlag;
    }
    case TemporalUnitEnum::FrameAndRealTime:
    {
      return frameFlag && realTimeFlag;
    }
    default:
      itkExceptionMacro("itk::TemporalDataObject::VerifyRequestedRegion() "
                        << "Invalid Temporal Unit");
  }
}

//----------------------------------------------------------------------------
void
TemporalDataObject::CopyInformation(const DataObject * data)
{
  // Standard call to the superclass' method
  Superclass::CopyInformation(data);

  const TemporalDataObject * temporalData;
  temporalData = dynamic_cast<const TemporalDataObject *>(data);

  if (temporalData)
  {
    // Copy the meta data for this data type
    this->SetLargestPossibleTemporalRegion(temporalData->GetLargestPossibleTemporalRegion());
    for (unsigned int i = 0; i < this->m_DataObjectBuffer->GetNumberOfBuffers(); ++i)
    {
      if (this->m_DataObjectBuffer->BufferIsFull(i))
      {
        m_DataObjectBuffer->GetBufferContents(i)->CopyInformation(
          temporalData->m_DataObjectBuffer->GetBufferContents(i));
      }
    }
  }
  else
  {
    // pointer could not be cast back down
    itkExceptionMacro("itk::TemporalDataObject::CopyInformation() "
                      << "cannot cast " << typeid(data).name() << " to " << typeid(const TemporalDataObject *).name());
  }
}

//----------------------------------------------------------------------------
void
TemporalDataObject::Graft(const DataObject * data)
{
  const TemporalDataObject * temporalData;

  temporalData = dynamic_cast<const TemporalDataObject *>(data);

  if (temporalData)
  {
    // Copy the meta-information
    this->CopyInformation(temporalData);

    this->SetBufferedTemporalRegion(temporalData->GetBufferedTemporalRegion());
    this->SetRequestedTemporalRegion(temporalData->GetRequestedTemporalRegion());

    for (unsigned int i = 0; i < this->m_DataObjectBuffer->GetNumberOfBuffers(); ++i)
    {
      if (this->m_DataObjectBuffer->BufferIsFull(i))
      {
        m_DataObjectBuffer->GetBufferContents(i)->Graft(temporalData->m_DataObjectBuffer->GetBufferContents(i));
      }
    }
  }
  else
  {
    // pointer could not be cast back down
    itkExceptionMacro("itk::TemporalDataObject::Graft() "
                      << "cannot cast " << typeid(data).name() << " to " << typeid(const TemporalDataObject *).name());
  }
}

//----------------------------------------------------------------------------
void
TemporalDataObject::SetRequestedRegion(const DataObject * data)
{
  const TemporalDataObject * temporalData;

  temporalData = dynamic_cast<const TemporalDataObject *>(data);

  if (temporalData)
  {
    // only copy the RequestedTemporalRegion if the parameter object is
    // a temporal data object
    this->SetRequestedTemporalRegion(temporalData->GetRequestedTemporalRegion());
    for (unsigned int i = 0; i < this->m_DataObjectBuffer->GetNumberOfBuffers(); ++i)
    {
      if (this->m_DataObjectBuffer->BufferIsFull(i))
      {
        m_DataObjectBuffer->GetBufferContents(i)->SetRequestedRegion(
          temporalData->m_DataObjectBuffer->GetBufferContents(i));
      }
    }
  }
  else
  {
    // pointer could not be cast back down
    itkExceptionMacro("itk::TemporalDataObject:SetRequestedRegion() "
                      << "cannot cast " << typeid(data).name() << " to " << typeid(const TemporalDataObject *).name());
  }
}

//----------------------------------------------------------------------------
void
TemporalDataObject::PrintSelf(std::ostream & os, Indent indent) const
{
  Superclass::PrintSelf(os, indent);
  os << indent << "Data Object Buffer: " << m_DataObjectBuffer.GetPointer() << std::endl;
  os << indent << "LargestPossibleTemporalRegion: " << std::endl;
  this->GetLargestPossibleTemporalRegion().Print(os, indent.GetNextIndent());

  os << indent << "BufferedTemporalRegion: " << std::endl;
  this->GetBufferedTemporalRegion().Print(os, indent.GetNextIndent());

  os << indent << "RequestedTemporalRegion: " << std::endl;
  this->GetRequestedTemporalRegion().Print(os, indent.GetNextIndent());
}

/** Print enum values */
std::ostream &
operator<<(std::ostream & out, const TemporalDataObjectEnums::TemporalUnit value)
{
  return out << [value] {
    switch (value)
    {
      case TemporalDataObjectEnums::TemporalUnit::Frame:
        return "itk::TemporalDataObjectEnums::TemporalUnit::Frame";
      case TemporalDataObjectEnums::TemporalUnit::RealTime:
        return "itk::TemporalDataObjectEnums::TemporalUnit::RealTime";
      case TemporalDataObjectEnums::TemporalUnit::FrameAndRealTime:
        return "itk::TemporalDataObjectEnums::TemporalUnit::FrameAndRealTime";
      default:
        return "INVALID VALUE FOR itk::TemporalDataObjectEnums::TemporalUnit";
    }
  }();
}
} // end namespace itk