cxImageStreamerSonix.cpp

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.

Copyright (c) 2008-2014, SINTEF Department of Medical Technology
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, 
   this list of conditions and the following disclaimer in the documentation 
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors 
   may be used to endorse or promote products derived from this software 
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================*/

#include "cxImageStreamerSonix.h"

#include "cxVector3D.h"

#ifdef CX_WIN32

#include <QTimer>
#include <QTime>
#include <QHostAddress>
#include "igtlOSUtil.h"
#include "igtlImageMessage.h"
#include "igtlServerSocket.h"
#include "vtkImageData.h"
#include "vtkSmartPointer.h"
#include "vtkMetaImageReader.h"
#include "vtkImageImport.h"
#include "vtkLookupTable.h"
#include "vtkImageMapToColors.h"
#include "vtkMetaImageWriter.h"
#include "cxSonixProbeFileReader.h"

#include "vtkSonixVideoSource.h"

#include "cxDataLocations.h"
#include "cxSonixProbeFileReader.h"
//#include "cxTypeConversions.h"

namespace cx
{

ImageStreamerSonix::ImageStreamerSonix() :
        mEmitStatusMessage(false),
        mLastFrameTimestamp(0.0),
        mCurrentFrameTimestamp(0.0),
        mMaxqueueInfo(20),
        mDroppedImages(0),
        mSonixHelper(new SonixHelper())
{
        mSendTimer = new QTimer;
}

QString ImageStreamerSonix::getType()
{
        return "Sonix";
}

QStringList ImageStreamerSonix::getArgumentDescription()
{
        QStringList retval;
        retval << "--ipaddress: IP address to connect to, default=127.0.0.1 (localhost)";
        retval << "--imagingmode:       default=2 (0 = B-mode, 2 = Color)";//, 6 = Dual, 12 = RF)";
        retval << "--datatype:  Video type, default=0x008 (4 = gray, 8 = color)";
        retval << "--buffersize:        Grabber buffer size,   default=500";
        retval << "--properties:        dump image properties";
        retval << "--debug:     Debug output";
        retval << "--delay:     Delay (sec) before connecting to Sonix (first time), default=80";
        return retval;
}

ImageStreamerSonix::~ImageStreamerSonix()
{
        mSendTimer->stop();
        if (mSonixGrabber)
        {
                mSonixGrabber->Stop();
                std::cout << "Releasing Ultrasonix resources" << std::endl;
                mSonixGrabber->ReleaseSystemResources();
        }
}


void ImageStreamerSonix::initialize(StringMap arguments)
{
        std::cout << "Creating sender type Sonix" << std::endl;
                  
        CommandLineStreamer::initialize(arguments);

//      mMaxBufferSize = 19200000; //800(width)*600(height)*4(bytes)*10(images)

        typedef cx::Frame Frame;
        qRegisterMetaType<Frame>("Frame");
        
        connect(this, SIGNAL(imageOnQueue(int)), this, SLOT(sendOpenIGTLinkImageSlot(int)), Qt::QueuedConnection);
        connect(this, SIGNAL(statusOnQueue(int)), this, SLOT(sendOpenIGTLinkStatusSlot(int)), Qt::QueuedConnection);//Do not work yet

        connect(mSendTimer, SIGNAL(timeout()), this, SLOT(initializeSonixSlot()));
        this->setSendInterval(10000);
        mSendTimer->setInterval(getSendInterval());
        mSendTimer->start();

        this->initializeSonixGrabber();
}

void ImageStreamerSonix::initializeSonixSlot()
{
        if(!mSonixGrabber->IsInitialized())
        {
                mSonixGrabber->Initialize();
                return;
        }

        //Don't reinitialize if in freeze state
        if(!mSonixGrabber->getFreezeState() && similar(mLastFrameTimestamp, mCurrentFrameTimestamp, 0.001))
        {
                std::cout << "initializeSonixSlot() Got no new frame. Reinitializing..." << std::endl;
                // If sonix exam is closed we need to create a new mSonixGrabber
                // Free resources. Do we need to delete?
                mSonixGrabber->Stop();
                std::cout << "Releasing Ultrasonix resources" << std::endl;
                mSonixGrabber->ReleaseSystemResources();
                disconnect(mSonixHelper, SIGNAL(frame(Frame&)), this, SLOT(receiveFrameSlot(Frame&)));

                this->initializeSonixGrabber();
        }
        else
        {
                mLastFrameTimestamp = mCurrentFrameTimestamp;
        }
}

void ImageStreamerSonix::initializeSonixGrabber()
{
        if (!mArguments.count("ipaddress"))
                mArguments["ipaddress"] = "127.0.0.1";
        if (!mArguments.count("imagingmode"))
                mArguments["imagingmode"] = "0";
        if (!mArguments.count("datatype"))
                mArguments["datatype"] = "0x00000008";
        if (!mArguments.count("buffersize"))
                mArguments["buffersize"] = "500";
        if (!mArguments.count("delay"))
                mArguments["buffersize"] = "80";

        QString ipaddress       = mArguments["ipaddress"];
        int imagingMode         = convertStringWithDefault(mArguments["imagingmode"], 0);
        int acquisitionDataType = convertStringWithDefault(mArguments["datatype"], 0x00000008);
        int bufferSize          = convertStringWithDefault(mArguments["buffersize"], 500);
        int delay                       = convertStringWithDefault(mArguments["delay"], 80);
        bool useSharedMemory = false;
        if (ipaddress.contains("127.0.0.1"))
                useSharedMemory = true;

        mSonixGrabber = vtkSonixVideoSource::New();
        if (mArguments.count("debug"))
                mSonixGrabber->setDebugOutput(true);
        else
                mSonixGrabber->setDebugOutput(false);
        mSonixGrabber->setSonixConnectionDelay(delay);
        mSonixGrabber->SetSonixIP(ipaddress.toStdString().c_str());
        mSonixGrabber->SetImagingMode(imagingMode);
        mSonixGrabber->SetAcquisitionDataType(acquisitionDataType);
        mSonixGrabber->SetFrameBufferSize(bufferSize);  // Number of image frames in buffer
        mSonixGrabber->setUseSharedMemory(useSharedMemory);
        mSonixGrabber->Initialize(); // Run initialize to set spacing and offset

        //TODO move to debug function OR DELETE!!! <jbake>
        //std::cout << "imagingMode: " << imagingMode << std::endl;
        //std::cout << "datatype: " << mArguments["datatype"].toStdString().c_str() << std::endl;
        //std::cout << "acquisitionDataType: " << acquisitionDataType << " ";
        //std::cout << "GetAcquisitionDataType: " << mSonixGrabber->GetAcquisitionDataType() << std::endl;

        mSonixGrabber->setSonixHelper(this->mSonixHelper);
        connect(mSonixHelper, SIGNAL(frame(Frame&)), this, SLOT(receiveFrameSlot(Frame&)), Qt::DirectConnection);
}

bool ImageStreamerSonix::startStreaming(SenderPtr sender)
{
        mSender = sender;
        mSonixGrabber->Record();
        mEmitStatusMessage = true;
        std::cout << "Started streaming from sonix device" << std::endl;
        return true;
}

void ImageStreamerSonix::stopStreaming()
{
  mSonixGrabber->Stop();
  mSender.reset();
}

void ImageStreamerSonix::receiveFrameSlot(Frame& frame)
{
        mCurrentFrameTimestamp = frame.mTimestamp;

        if (!mSender || !mSender->isReady())
                return;

  //TODO: Get info like origin from frame and create a IGTLinkUSStatusMessage
  if (frame.mNewStatus || mEmitStatusMessage)
  {
    IGTLinkUSStatusMessage::Pointer statMsg = getFrameStatus(frame);
        //double spacing[3];
        //statMsg->GetSpacing(spacing);
        //std::cout << "Spacing3: " << spacing[0] << ", " << spacing[1] << ", " << spacing[2] << std::endl;
    this->addStatusMessageToQueue(statMsg);
    // Pack (serialize) and send
//    statMsg->Pack();
//    mSocket->write(reinterpret_cast<const char*>(statMsg->GetPackPointer()), statMsg->GetPackSize());
    mEmitStatusMessage = false;
  }

  IGTLinkImageMessage::Pointer imgMsg = convertFrame(frame);
//  std::cout << "Socket bytesToWrite: " << mSocket->bytesToWrite() << std::endl;
//  std::cout << "Socket readBufferSize: " << mSocket->readBufferSize() << std::endl;
  this->addImageToQueue(imgMsg);


  //------------------------------------------------------------
  // Pack (serialize) and send
//  imgMsg->Pack();
//  mSocket->write(reinterpret_cast<const char*>(imgMsg->GetPackPointer()), imgMsg->GetPackSize());
}

IGTLinkUSStatusMessage::Pointer ImageStreamerSonix::getFrameStatus(Frame& frame)
{
  IGTLinkUSStatusMessage::Pointer retval = IGTLinkUSStatusMessage::New();

  retval->SetOrigin(frame.mOrigin[0], frame.mOrigin[1], 0);

  //std::cout << "Received probe name: " << frame.probeName << std::endl;

  //Path to probes.xml on on ultrasonix scanner:
  QString probeFile = "C:/Program Files/Ultrasonix/Exam/config/probes.xml";
  cx::SonixProbeFileReader reader(probeFile);
  if(!reader.init())
  {
          std::cout << "Failed to initialize probe xml reader" << std::endl;
          return retval;
  }
  QDomNode probeNode = reader.getProbeNode(frame.probeName.c_str());
  long radius = reader.getProbeParam(probeNode, "radius") / 1000; //microns -> mm
  long probeLenght = reader.getProbeLenght(probeNode) / 1000; //microns -> mm
  double probeWidth;

  if(frame.mSectorSizeInPercent <= 100)
        {
                double widthReductionFactor = 0.98;
          probeWidth = probeLenght * frame.mSectorSizeInPercent / 100.0 * widthReductionFactor;
        }
  else
          probeWidth = probeLenght;

  if(reader.isProbeLinear(probeNode))
  {
          retval->SetProbeType(2);
          retval->SetDepthStart((frame.uly-frame.mOrigin[1]) * frame.mSpacing[1]);// Start of sector in mm from origin
          retval->SetDepthEnd((frame.bly-frame.mOrigin[1]) * frame.mSpacing[1]);        // End of sector in mm from origin
          retval->SetWidth(probeWidth);
  }
  else // sector
  {
          retval->SetProbeType(1);
          retval->SetWidth(probeWidth/radius);
          double depthStart = radius;
          double depthStartIncreaseFactor = 1.01;
          double depthEndReductionFactor = 0.99;
          retval->SetDepthStart(depthStart * depthStartIncreaseFactor);
          retval->SetDepthEnd((depthStart + frame.mImagingDepth) * depthEndReductionFactor);
  }

  retval->SetDeviceName(createDeviceName().c_str());
  return retval;
}

std::string ImageStreamerSonix::createDeviceName()
{
        std::string retval = "Sonix[BGRX]";
        return retval;
}

IGTLinkImageMessage::Pointer ImageStreamerSonix::convertFrame(Frame& frame)
{
  IGTLinkImageMessage::Pointer retval = IGTLinkImageMessage::New();

  //extract data needed variables from the frame
  int size[] = {frame.mWidth, frame.mHeight, 1};
  int offset[] = {0, 0, 0};

  // Create a new IMAGE type message
  retval->SetDimensions(size);
  retval->SetSpacing(frame.mSpacing[0], frame.mSpacing[1],1);
  //std::cout << "Frame spacing: " << frame.mSpacing[0] << " " << frame.mSpacing[1] << std::endl;
  retval->SetScalarType(frame.mPixelFormat); //Use frame.mPixelFormat directly
  retval->SetDeviceName(createDeviceName().c_str());

  retval->SetSubVolume(size,offset);
  retval->AllocateScalars();

  igtl::TimeStamp::Pointer ts;
  ts = igtl::TimeStamp::New();
  double seconds = frame.mTimestamp;
  ts->SetTime(seconds); //in seconds
  retval->SetTimeStamp(ts);

  igtl::Matrix4x4 matrix;
  matrix[0][0] = 1.0;  matrix[1][0] = 0.0;  matrix[2][0] = 0.0; matrix[3][0] = 0.0;
  matrix[0][1] = 0.0;  matrix[1][1] = 1.0;  matrix[2][1] = 0.0; matrix[3][1] = 0.0;
  matrix[0][2] = 0.0;  matrix[1][2] = 0.0;  matrix[2][2] = 1.0; matrix[3][2] = 0.0;
  matrix[0][3] = 0.0;  matrix[1][3] = 0.0;  matrix[2][3] = 0.0; matrix[3][3] = 1.0;
  retval->SetMatrix(matrix);
  
  retval->SetOrigin(frame.mOrigin[0], frame.mOrigin[1], 0);//Set origin after frame is set
  // Set image data
  int fsize = retval->GetImageSize();
  memcpy(retval->GetScalarPointer(), frame.mFirstPixel, fsize); // not sure if we need to copy
  
  //float origin[3];
  //retval->GetOrigin(origin);
  //std::cout << "origin3: " << origin[0] << " " << origin[1] << " " << origin[2] << " " << std::endl;
  //float spacing[3];
  //retval->GetSpacing(spacing);
  //std::cout << "spacing: " << spacing[0] << " " << spacing[1] << " " << spacing[2] << " " << std::endl;

  //int dimensions[3];
  //retval->GetDimensions(dimensions);
  //std::cout << "dimensions: " << dimensions[0] << " " << dimensions[1] << " " << dimensions[2] << " " << std::endl;
  return retval;
}
void ImageStreamerSonix::sendOpenIGTLinkImageSlot(int sendNumberOfMessages)
{
        if (!mSender || !mSender->isReady())
                return;

//      if(!mSocket)
//              return;
//  if(mSocket->bytesToWrite() > mMaxBufferSize)
//    return;

  for(int i=0; i<sendNumberOfMessages; ++i)
  {
    IGTLinkImageMessage::Pointer message = this->getLastImageMessageFromQueue();
    if(!message)
      break;
    PackagePtr package(new Package());
    package->mIgtLinkImageMessage = message;
    mSender->send(package);
//    message->Pack();
//    mSocket->write(reinterpret_cast<const char*>(message->GetPackPointer()), message->GetPackSize());
  }
}
void ImageStreamerSonix::sendOpenIGTLinkStatusSlot(int sendNumberOfMessage)
{
        if (!this->isReadyToSend())
                return;

//      if(!mSocket)
//              return;
  //std::cout << "ImageStreamerSonix::sendOpenIGTLinkStatusSlot" << std::endl;
//  if(mSocket->bytesToWrite() > mMaxBufferSize)
//    return;

  for(int i=0; i<sendNumberOfMessage; ++i)
  {
    IGTLinkUSStatusMessage::Pointer message = this->getLastStatusMessageFromQueue();
    if(!message)
      break;

    PackagePtr package(new Package());
    package->mIgtLinkUSStatusMessage = message;
    mSender->send(package);

//    message->Pack();
//    mSocket->write(reinterpret_cast<const char*>(message->GetPackPointer()), message->GetPackSize());
  }
}
void ImageStreamerSonix::addImageToQueue(IGTLinkImageMessage::Pointer msg)
{
  QMutexLocker sentry(&mImageMutex);
  if(mMutexedImageMessageQueue.size() > mMaxqueueInfo)
  {
    mMutexedImageMessageQueue.pop_front();
    mDroppedImages++;
  }

  mMutexedImageMessageQueue.push_back(msg);
  int size = mMutexedImageMessageQueue.size();
  sentry.unlock();

  emit queueInfo(size, mDroppedImages);
  emit imageOnQueue(size); // emit signal outside lock, catch possibly in another thread
}

IGTLinkImageMessage::Pointer ImageStreamerSonix::getLastImageMessageFromQueue()
{
  QMutexLocker sentry(&mImageMutex);
  if (mMutexedImageMessageQueue.empty())
    return IGTLinkImageMessage::Pointer();
  IGTLinkImageMessage::Pointer retval = mMutexedImageMessageQueue.front();
  mMutexedImageMessageQueue.pop_front();
  return retval;
}

void ImageStreamerSonix::addStatusMessageToQueue(IGTLinkUSStatusMessage::Pointer msg)
{
  QMutexLocker sentry(&mStatusMutex);
  if(mMutexedStatusMessageQueue.size() > mMaxqueueInfo)
  {
    mMutexedStatusMessageQueue.pop_front();
  }

  mMutexedStatusMessageQueue.push_back(msg);
  int size = mMutexedStatusMessageQueue.size();
  sentry.unlock();
  emit statusOnQueue(size); // emit signal outside lock, catch possibly in another thread
}

IGTLinkUSStatusMessage::Pointer ImageStreamerSonix::getLastStatusMessageFromQueue()
{
  QMutexLocker sentry(&mStatusMutex);
  if (mMutexedStatusMessageQueue.empty())
    return IGTLinkUSStatusMessage::Pointer();
  IGTLinkUSStatusMessage::Pointer retval = mMutexedStatusMessageQueue.front();
  mMutexedStatusMessageQueue.pop_front();
  return retval;
}

}

#endif // CX_WIN32