niftkNVidiaSDIDataType.h

Go to the documentation of this file.

/*=============================================================================

  NifTK: A software platform for medical image computing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/

#ifndef niftkNVidiaSDIDataType_h
#define niftkNVidiaSDIDataType_h

#include <niftkIGIDataType.h>

namespace niftk
{

class NVidiaSDIDataType : public IGIDataType
{
public:

  //typedef unsigned __int64 NVidiaSDITimeType;
  typedef unsigned long long NVidiaSDITimeType;

  mitkClassMacro(NVidiaSDIDataType, IGIDataType)
  mitkNewMacro3Param(NVidiaSDIDataType, unsigned int, unsigned int, NVidiaSDITimeType)

  unsigned int GetSequenceNumber() const;
  unsigned int GetCookie() const;

protected:

  NVidiaSDIDataType(unsigned int, unsigned int, NVidiaSDITimeType); // Purposefully hidden.
  virtual ~NVidiaSDIDataType(); // Purposefully hidden.

  NVidiaSDIDataType(const NVidiaSDIDataType&); // Purposefully not implemented.
  NVidiaSDIDataType& operator=(const NVidiaSDIDataType&); // Purposefully not implemented.

private:

  // Used internally to make sure this data item comes from a valid
  // capture session. Otherwise what could happen is that when signal drops out (e.g. due to
  // interference on the wire) the old capture context is destroyed and a new one is created 
  // (fairly quickly) but any in-flight NVidiaSDIDataType hanging around in the IGIDataSourceManager
  // might still reference the previous one.
  unsigned int       m_MagicCookie;

  // SDI sequence number. Starts counting at 1 and increases for every set of captured images.
  unsigned int       m_SequenceNumber;

  // The SDI card keeps a time stamp for each frame coming out of the wire.
  // This is in some arbitrary unit (nanoseconds?) in reference to some arbitrary clock.
  NVidiaSDITimeType  m_GpuArrivalTime;
};

} // end namespace

#endif