niftkNVidiaSDIDataSourceService.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 niftkNVidiaSDIDataSourceService_h
#define niftkNVidiaSDIDataSourceService_h

#include <niftkIGIDataSource.h>
#include <niftkIGIDataSourceLocker.h>
#include <niftkIGILocalDataSourceI.h>
#include <niftkIGIDataSourceGrabbingThread.h>
#include <niftkIGIDataSourceBuffer.h>
#include <niftkIGICleanableDataSourceI.h>
#include <niftkIGIDataSourceBackgroundDeleteThread.h>

#include <QObject>
#include <QSet>
#include <QMutex>
#include <QString>
#include <cv.h>

namespace niftk
{

// some forward decls to avoid header pollution
class NVidiaSDIDataSourceImpl;

class NVidiaSDIDataSourceService
    : public QObject
    , public IGIDataSource
    , public IGILocalDataSourceI
    , public IGICleanableDataSourceI
{

  Q_OBJECT

public:

  mitkClassMacroItkParent(NVidiaSDIDataSourceService, IGIDataSource)
  mitkNewMacro3Param(NVidiaSDIDataSourceService, QString, const IGIDataSourceProperties&, mitk::DataStorage::Pointer)

    // This should match libvideo/SDIInput::InterlacedBehaviour
  enum InterlacedBehaviour
  {
    DO_NOTHING_SPECIAL    = 0,
    DROP_ONE_FIELD        = 1,
    STACK_FIELDS          = 2, 
    SPLIT_LINE_INTERLEAVED_STEREO = 3
  };

  virtual void GrabData() override;

  virtual void CleanBuffer() override;

  virtual void StartPlayback(niftk::IGIDataType::IGITimeType firstTimeStamp,
                             niftk::IGIDataType::IGITimeType lastTimeStamp) override;

  void PlaybackData(niftk::IGIDataType::IGITimeType requestedTimeStamp) override;

  virtual void StopPlayback() override;

  virtual std::vector<IGIDataItemInfo> Update(const niftk::IGIDataType::IGITimeType& time) override;

  bool ProbeRecordedData(niftk::IGIDataType::IGITimeType* firstTimeStampInStore,
                         niftk::IGIDataType::IGITimeType* lastTimeStampInStore) override;

  virtual void SetProperties(const IGIDataSourceProperties& properties) override;

  virtual IGIDataSourceProperties GetProperties() const override;

  // used to capture a lower-resolution image
  // can only be changed when no capture is running! see IsCapturing() etc 
  void SetMipmapLevel(unsigned int l);
  void SetFieldMode(InterlacedBehaviour b);
  InterlacedBehaviour GetFieldMode() const;
  int GetNumberOfStreams();
  int GetCaptureWidth();
  int GetCaptureHeight();
  int GetRefreshRate();
  int GetTextureId(int stream);
  const char* GetWireFormatString();

protected slots:

  // to be used by NVidiaSDIDataSourceImpl to make us show a message box.
  void ShowFatalErrorMessage(QString msg);

protected:

  NVidiaSDIDataSourceService(QString factoryName,
                               const IGIDataSourceProperties& properties,
                               mitk::DataStorage::Pointer dataStorage
                               );
  virtual ~NVidiaSDIDataSourceService();

private:

  NVidiaSDIDataSourceService(const NVidiaSDIDataSourceService&); // deliberately not implemented
  NVidiaSDIDataSourceService& operator=(const NVidiaSDIDataSourceService&); // deliberately not implemented

  void SaveItem(niftk::IGIDataType::Pointer item);

  static niftk::IGIDataSourceLocker               s_Lock;
  QMutex                                          m_Lock;
  int                                             m_ChannelNumber;
  niftk::IGIDataType::IGIIndexType                m_FrameId;
  niftk::IGIDataSourceBuffer::Pointer             m_Buffer;
  niftk::IGIDataSourceGrabbingThread*             m_DataGrabbingThread;
  niftk::IGIDataSourceBackgroundDeleteThread*     m_BackgroundDeleteThread;

  // holds internals to prevent header pollution
  NVidiaSDIDataSourceImpl*                        m_Pimpl;
  unsigned int                                    m_MostRecentSequenceNumber;
  unsigned int                                    m_MipmapLevel;
  
  // used to correlate clock, frame numbers and other events
  std::ofstream                                   m_FrameMapLogFile;

  // used to detect whether record has stopped or not.
  // there's no notification when the user clicked stop-record.
  bool                                            m_WasSavingMessagesPreviously;

  // because the sdi thread is running separately to the data-source-interface
  // we can end up in a situation where sdi bits get recreated with new sequence numbers
  // but these parts here still expect the old sdi instance.
  unsigned int                                    m_ExpectedCookie;
  static const char*                              s_NODE_NAME;

  // Nested private type
  struct PlaybackPerFrameInfo
  {
    unsigned int m_SequenceNumber;
    // we have max 4 channels via sdi.
    unsigned int m_frameNumber[4];
    PlaybackPerFrameInfo();
  };
  std::map<niftk::IGIDataType::IGITimeType, 
    PlaybackPerFrameInfo>                         m_PlaybackIndex;

  // used to prevent replaying the same thing over and over again.
  // because decompression in its current implementation is quite heavy-weight,
  // the repeated calls to PlaybackData() and similarly Update() slow down the machine
  // quite significantly.
  niftk::IGIDataType::IGITimeType                 m_MostRecentlyPlayedbackTimeStamp;
  niftk::IGIDataType::IGITimeType                 m_MostRecentlyUpdatedTimeStamp;
  std::pair<IplImage*, int>                       m_CachedUpdate;

private:

  void StartCapturing();

  void StopCapturing();

  bool IsCapturing();

  bool InitWithRecordedData(
    std::map<niftk::IGIDataType::IGITimeType, PlaybackPerFrameInfo>& index, 
    const std::string& path, 
    niftk::IGIDataType::IGITimeType* firstTimeStampInStore, 
    niftk::IGIDataType::IGITimeType* lastTimeStampInStore, 
    bool forReal);

}; // end class

} // end namespace

#endif