vtkPlusMmfVideoSource.h

Go to the documentation of this file.

/*=Plus=header=begin======================================================
  Program: Plus
  Copyright (c) Laboratory for Percutaneous Surgery. All rights reserved.
  See License.txt for details.
=========================================================Plus=header=end*/

/*=========================================================================
The following copyright notice is applicable to parts of this file:
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
Authors include: Danielle Pace
(Robarts Research Institute and The University of Western Ontario)
=========================================================================*/

#ifndef __vtkPlusMmfVideoSource_h
#define __vtkPlusMmfVideoSource_h

// Local includes
#include "vtkPlusDataCollectionExport.h"
#include "vtkPlusDevice.h"
#include "vtkIGSIORecursiveCriticalSection.h"

// PlusDataCollection includes
#include <vtkPlusCameraControlParameters.h>

// VTK includes
#include <vtkSmartPointer.h>

class MmfVideoSourceReader;

class vtkPlusDataCollectionExport vtkPlusMmfVideoSource : public vtkPlusDevice
{
  friend class MmfVideoSourceReader;

  struct VideoFormat
  {
    unsigned int DeviceId;
    unsigned int StreamIndex;
    FrameSizeType FrameSize;
    std::wstring PixelFormatName; // e.g., YUY2
  };

public:
  static vtkPlusMmfVideoSource* New();
  vtkTypeMacro(vtkPlusMmfVideoSource, vtkPlusDevice);
  virtual void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  virtual void SetRequestedDeviceId(unsigned int deviceId);
  virtual void SetRequestedVideoFormat(const std::wstring& pixelFormatName);
  virtual void SetRequestedStreamIndex(unsigned int streamIndex);
  virtual void SetRequestedFrameSize(const FrameSizeType& frameSize);

  std::wstring GetRequestedDeviceName();
  std::wstring GetActiveDeviceName();
  void GetListOfCaptureVideoFormats(std::vector<std::wstring>& videoModes, unsigned int deviceId);
  void LogListOfCaptureVideoFormats(unsigned int deviceId);
  void GetListOfCaptureDevices(std::vector<std::wstring>& deviceNames);
  void LogListOfCaptureDevices();

  virtual PlusStatus ReadConfiguration(vtkXMLDataElement* xmlElement);
  virtual PlusStatus WriteConfiguration(vtkXMLDataElement* xmlElement);

  virtual PlusStatus NotifyConfigured();

  virtual bool IsTracker() const { return false; }

  virtual PlusStatus SetNewCameraControlParameters(const vtkPlusCameraControlParameters& newCameraControlParameters);
  vtkGetObjectMacro(CameraControlParameters, vtkPlusCameraControlParameters);

protected:
  vtkPlusMmfVideoSource();
  ~vtkPlusMmfVideoSource();

  virtual PlusStatus InternalConnect();

  virtual PlusStatus InternalDisconnect();

  virtual PlusStatus InternalStartRecording();

  virtual PlusStatus InternalStopRecording();

  PlusStatus UpdateFrameSize();

  PlusStatus AddFrame(unsigned char* bufferData, DWORD bufferSize);

  std::wstring GetCaptureDeviceName(unsigned int deviceId);

  virtual PlusStatus InternalApplyCameraControlParameterChange();

  int FrameIndex;

  vtkSmartPointer<vtkIGSIORecursiveCriticalSection> Mutex;
  igsioVideoFrame UncompressedVideoFrame;
  VideoFormat RequestedVideoFormat;
  VideoFormat ActiveVideoFormat;

  vtkSmartPointer<vtkPlusCameraControlParameters> CameraControlParameters;

  MmfVideoSourceReader* MmfSourceReader;
private:
  vtkPlusMmfVideoSource(const vtkPlusMmfVideoSource&);  // Not implemented.
  void operator=(const vtkPlusMmfVideoSource&);  // Not implemented.
};

#endif