plugins_unsupported/filter_photosynth/downloader.cpp

/*
 * The following code is slightly based on the C# application
 * SynthExport (http://synthexport.codeplex.com/) by Christoph Hausner
 * and on the C++ application
 * PhotoSynthToolkit (http://www.visual-experiments.com/) by Henri Astre
 */

#include "synthData.h"
#include <math.h>
#include <QtSoapMessage>
#include <QNetworkAccessManager>
#include <QNetworkRequest>
#include <QNetworkReply>
#include <QScriptEngine>
#include <QScriptValue>
#include <QScriptValueIterator>
#include <QImage>
#include <QFile>

/********************
 * CameraParameters *
 ********************/

Point3m CameraParameters::getTranslation()
{
  return Point3m(_fields[CameraParameters::POS_X], _fields[CameraParameters::POS_Z], -_fields[CameraParameters::POS_Y]);
}

Matrix44m CameraParameters::getRotation()
{
  qreal a = _fields[CameraParameters::ROT_X] * _fields[CameraParameters::ROT_X] +
            _fields[CameraParameters::ROT_Y] * _fields[CameraParameters::ROT_Y] +
            _fields[CameraParameters::ROT_Z] * _fields[CameraParameters::ROT_Z];
  qreal w2 = 1 - a;
  qreal w = sqrt(w2);
  Quaternion<CMeshO::ScalarType> q(w,_fields[CameraParameters::ROT_X],_fields[CameraParameters::ROT_Y],_fields[CameraParameters::ROT_Z]);
  Matrix44m rot;
  q.ToMatrix(rot);
  Matrix44m flip;
  flip.SetRotateDeg(180,Point3m(1,0,0));
  // (rot * flip)^T = flip^T * rot^T
  Matrix44m transposedFlippedRot = flip.transpose() * rot.transpose();

  Matrix44m rotate90;
  rotate90.SetRotateDeg(90,Point3m(1,0,0));
  Matrix44m rotation = transposedFlippedRot * rotate90;

  return rotation;
}

/**************
 * PointCloud *
 **************/

PointCloud::PointCloud(int coordSysID, int binFileCount, QObject *parent)
  : QObject(parent)
{
  _coordinateSystem = coordSysID;
  _binFileCount = binFileCount;
}

/********************
 * CoordinateSystem *
 ********************/

CoordinateSystem::CoordinateSystem(int id, QObject *parent)
  : QObject(parent)
{
  _id = id;
  _shouldBeImported = false;
  _pointCloud = 0;
}

/*************
 * SynthData *
 *************/

//contains the error descriptions relative to the errors that may occurr during the import process
//each position index in the array corresponds to the same value in the enum Errors of SynthData class.
//These strings are used by applyFilter in case of error.
const QString SynthData::errors[] =
{
  "The provided URL is invalid",
  "Save path is missing: specify one",
  "The web service returned an error",
  "The requested Synth is unavailable",
  "Could not parse web service response: unexpected response",
  "This filter is compatible with photosynths belonging to \"Synth\" category only",
  "Error parsing collection data",
  "This synth is empty",
  "Error reading binary data, file may be corrupted",
  "The point cloud is stored in an incompatible format and cannot be loaded",
  "Error creating output directory for images"
  "Error saving images to the filesystem"
};

const char *SynthData::steps[] =
{
  "Contacting web service...",
  "Downloading json data...",
  "Parsing json data...",
  "Downloading point cloud bin files...",
  "Loading point cloud data...",
  "Downloading images..."
};

bool SynthData::checkAndSetState(bool condition, Error errorCode, QNetworkReply *httpResponse)
{
  if(condition)
    setState(errorCode, httpResponse);
  return condition;
}

void SynthData::setState(Error errorCode, QNetworkReply *httpResponse)
{
  _state = errorCode;
  _mutex.lock();
  _dataReady = true;
  _mutex.unlock();
  if(httpResponse)
    httpResponse->deleteLater();
}

SynthData::SynthData(ImportSettings &settings, QObject *parent)
  : QObject(parent)
{
  _coordinateSystems = new QList<CoordinateSystem*>();
  _imageMap = new QHash<int,Image>();
  _settings = settings;
  _state = PENDING;
  _step = WEB_SERVICE;
  _progress = 0;
  _mutex.lock();
  _dataReady = false;
  _mutex.unlock();
  _semaphore = 0;
  _imagesToDownloadCount = 0;
}

SynthData::~SynthData()
{
  delete _coordinateSystems;
  delete _imageMap;
}

/*
 * Returns true if this SynthData represents a Synth downloaded from photosynth.net.
 * Upon a successful download this function returns true if called on the download operation result.
 * Use this function to determine if the data were successfully downloaded.
 */
bool SynthData::isValid()
{
  return (_state == SYNTH_NO_ERROR);
}

/*
 * Useful for cb().
 * Returns the progress for the current step, and sets info according to the step being executed
 */
int SynthData::progressInfo()
{
  _info = steps[_step];
  return _progress;
}

/*
 * Contacts the photosynth web service to retrieve informations about
 * the synth whose identifier is contained within the given url.
 */
void SynthData::downloadSynthInfo(vcg::CallBackPos *cb)
{
  _cb = cb;
  _step = WEB_SERVICE;
  _progress = 0;
  _cb(progressInfo(),_info.toStdString().data());
  if(_settings._url.isNull() || _settings._url.isEmpty())
  {
    _state = WRONG_URL;
    _mutex.lock();
    _dataReady = true;
    _mutex.unlock();
    return;
  }

  if(_settings._imageSavePath.isNull())
  {
    _state = WRONG_PATH;
    _mutex.lock();
    _dataReady = true;
    _mutex.unlock();
    return ;
  }
  _savePath = _settings._imageSavePath;

  //extracts the synth identifier
  int i = _settings._url.indexOf("cid=",0,Qt::CaseInsensitive);
  if(i < 0 || _settings._url.length() < i + 40)
  {
    _state = WRONG_URL;
    _mutex.lock();
    _dataReady = true;
    _mutex.unlock();
    return;
  }

  QString cid = _settings._url.mid(i + 4, 36);
  _collectionID = cid;

  QtSoapMessage message;
  message.setMethod("GetCollectionData", "http://labs.live.com/");
  message.addMethodArgument("collectionId", "", cid);
  message.addMethodArgument("incrementEmbedCount", "", false, 0);

  QtSoapHttpTransport *transport = new QtSoapHttpTransport(this);
  connect(transport, SIGNAL(responseReady(const QtSoapMessage &)),this, SLOT(readWSresponse(const QtSoapMessage &)));
  transport->setAction("http://labs.live.com/GetCollectionData");
  transport->setHost("photosynth.net");

  transport->submitRequest(message, "/photosynthws/PhotosynthService.asmx");
  _state = PENDING;
  _progress = 50;
  _cb(progressInfo(),_info.toStdString().data());
}

/*
 * Handles the photosynth web service response.
 */
void SynthData::readWSresponse(const QtSoapMessage &response)
{
  if(checkAndSetState(response.isFault(), WEBSERVICE_ERROR)) return;
  const QtSoapType &returnValue = response.returnValue();
  if(returnValue["Result"].isValid())
  {
    //the requested synth was found
    if(returnValue["Result"].toString() == "OK")
    {
      //we can only extract point clouds from synths
      if(returnValue["CollectionType"].toString() == "Synth")
      {
        _collectionRoot = returnValue["CollectionRoot"].toString();
        //the url of the json string containing data about the synth coordinate systems (different clusters of points)
        //their camera parameters and the number of binary files containing the point clouds data.
        QString jsonURL = returnValue["JsonUrl"].toString();
        _progress = 100;
        _cb(progressInfo(),_info.toStdString().data());
        downloadJsonData(jsonURL);
      }
      else
        setState(WRONG_COLLECTION_TYPE);
    }
    else
      setState(NEGATIVE_RESPONSE);
  }
  else
    setState(UNEXPECTED_RESPONSE);
}

/*
 * Performs an HTTP request to download a json string containing data
 * about the synth coordinate systems (different clusters of points)
 * their camera parameters and the number of binary files containing
 * the point clouds data.
 */
void SynthData::downloadJsonData(QString jsonURL)
{
  _step = DOWNLOAD_JSON;
  _progress = 0;
  _cb(progressInfo(),_info.toStdString().data());
  QNetworkAccessManager *manager = new QNetworkAccessManager(this);
  connect(manager, SIGNAL(finished(QNetworkReply*)),
          this, SLOT(parseJsonString(QNetworkReply*)));

  manager->get(QNetworkRequest(QUrl(jsonURL)));
  _progress = 50;
  _cb(progressInfo(),_info.toStdString().data());
}

/*
 * Extracts from the given string informations about the coordinate
 * systems and their camera parameters.
 */
void SynthData::parseJsonString(QNetworkReply *httpResponse)
{
  _progress = 100;
  _cb(progressInfo(),_info.toStdString().data());
  _step = PARSE_JSON;
  _progress = 0;
  _cb(progressInfo(),_info.toStdString().data());
  QByteArray payload = httpResponse->readAll();
  QString json(payload);
  QScriptEngine engine;
  QScriptValue jsonData = engine.evaluate("(" + json + ")");
  if(checkAndSetState(engine.hasUncaughtException(), JSON_PARSING, httpResponse)) return;
  //the "l" property contains an object whose name is the synth cid
  //and whose value is an array containing the coordinate systems
  QScriptValue collections = jsonData.property("l");
  if(checkAndSetState(!collections.isValid(), JSON_PARSING, httpResponse)) return;
  //use an iterator to retrieve the first collection
  QScriptValueIterator iterator(collections);
  QScriptValue collection;
  int coordSystemsCount = 0;
  if(iterator.hasNext())
  {
    iterator.next();
    collection = iterator.value();
    coordSystemsCount = collection.property("_num_coord_systems").toInt32();
    _numImages = collection.property("_num_images").toInt32();
  }
  else
  {
    setState(JSON_PARSING, httpResponse);
    return;
  }
  if(coordSystemsCount > 0)
  {
    //the json object containing the images informations
    QScriptValue map = collection.property("image_map");
    parseImageMap(map);
    CoordinateSystem *coordSys;
    //the coordinate systems list
    QScriptValue coordSystems = collection.property("x");
    for(int i = 0; i <= coordSystemsCount; ++i)
    {
      if(_settings._clusterID == -1 || i == _settings._clusterID)
      {
        _progress = 50 + (i / (2*coordSystemsCount) * 100);
        QScriptValue cs = coordSystems.property(QString::number(i));
        QScriptValue pointCloud = cs.property("k");
        if(pointCloud.isValid() && !pointCloud.isNull())
        {
          //NOTE: we are only interested in coordinate systems having a valid point cloud
          //so we create one only under this condition, and discard all other ones
          coordSys = new CoordinateSystem(i,this);
          coordSys->_shouldBeImported = true;
          _coordinateSystems->append(coordSys);
          QScriptValueIterator it(pointCloud);
          if(it.hasNext())
          {
            //pointCloud[0]
            it.next();
            QString str = it.value().toString();
            if(!str.isNull() && !str.isEmpty())
            {
              //pointCloud[1]
              it.next();
              int binFileCount = it.value().toInt32();
              PointCloud *p = new PointCloud(i,binFileCount,coordSys);
              coordSys->_pointCloud = p;
            }
          }
          //list of cameras
          //NOTE: we are only interested in camera lists belonging to a coordinate system having a valid point cloud
          //this is the reason why the code below is inside the previous if branch
          QScriptValue cameras = cs.property("r");
          if(cameras.isValid() && !cameras.isNull())
          {
            QScriptValueIterator it(cameras);
            while(it.hasNext())
            {
              it.next();
              int id = it.name().toInt();
              QScriptValue camera = it.value();
              //contains the camera extrinsics and some of intrinsics
              QScriptValue parameters = camera.property("j");
              CameraParameters params;
              params._camID = id;
              QScriptValueIterator paramIt(parameters);
              paramIt.next();
              params._imageID = paramIt.value().toInt32();
              Image img = _imageMap->value(params._imageID);
              img._shouldBeDownloaded = img._shouldBeDownloaded + 1;
              _imageMap->insert(img._ID,img);
              _imagesToDownloadCount++;
              for(int i = CameraParameters::FIRST; i <= CameraParameters::LAST; ++i)
              {
                paramIt.next();
                params[i] = paramIt.value().toNumber();
              }
              QScriptValue distortion = camera.property("f");
              if(distortion.isValid() && !distortion.isNull())
              {
                QScriptValueIterator distortionIt(distortion);
                distortionIt.next();
                params._distortionRadius1 = distortionIt.value().toNumber();
                distortionIt.next();
                params._distortionRadius2 = distortionIt.value().toNumber();
              }
              else
                params._distortionRadius1 = params._distortionRadius2 = 0;
              coordSys->_cameraParametersList.append(params);
            }
          }
        }
      }
    }
    _progress = 100;
    _cb(progressInfo(),_info.toStdString().data());
    downloadBinFiles();
  }
  else
    setState(EMPTY);
  httpResponse->deleteLater();
}

/*
 * Parse the image list and, for each element of the list, creates an Image and puts it in the dictionary
 */
void SynthData::parseImageMap(QScriptValue &map)
{
  QScriptValueIterator imageIt(map);
  int i = 0;
  while(imageIt.hasNext())
  {
    _progress = i / (2*_numImages) * 100;
    _cb(progressInfo(),_info.toStdString().data());
    imageIt.next();
    Image image;
    image._shouldBeDownloaded = 0;
    image._ID = imageIt.name().toInt();
    QScriptValue size = imageIt.value().property("d");
    QScriptValueIterator sizeIt(size);
    sizeIt.next();
    image._width = sizeIt.value().toInt32();
    sizeIt.next();
    image._height = sizeIt.value().toInt32();
    image._url = imageIt.value().property("u").toString();
    _imageMap->insert(image._ID,image);
    ++i;
  }
}

/*
 * Asks the server for bin files containing point clouds data
 * sending an http request for each bin file composing the synth
 */
void SynthData::downloadBinFiles()
{
  _step = DOWNLOAD_BIN;
  _progress = 0;
  _cb(progressInfo(),_info.toStdString().data());
  QNetworkAccessManager *manager = new QNetworkAccessManager(this);
  connect(manager, SIGNAL(finished(QNetworkReply*)),
          this, SLOT(loadBinFile(QNetworkReply*)));
  foreach(CoordinateSystem *sys, *_coordinateSystems)
  {
    if(sys->_shouldBeImported && sys->_pointCloud)
    {
      //As QNetworkAccessManager API is asynchronous, there is no mean, in the slot handling the response (loadBinFile),
      //to understand if the response received is the last one, and thus to know if all data have been received.
      //To let loadBinFile know when the processed response is the last one (allowing the _dataReady variable to be set to true)
      //the counter _semaphore is used
      _mutex.lock();
      _semaphore += sys->_pointCloud->_binFileCount;
      _mutex.unlock();
      for(int i = 0; i < sys->_pointCloud->_binFileCount; ++i)
      {
        QString url = QString("%0points_%1_%2.bin").arg(_collectionRoot).arg(sys->_id).arg(i);
        QNetworkRequest *request = new QNetworkRequest(QUrl(url));
        PointCloud *p = (PointCloud *)sys->_pointCloud;
        //the slot handling the response (loadBinFile) is able to know which pointCloud the received data belong to
        //retrieving the originating object of the request whose response is being processed
        request->setOriginatingObject(p);
        manager->get(*request);
        delete request;
      }
    }
  }
  _totalBinFilesCount = _semaphore;
  if(_totalBinFilesCount == 0)
  {
    _state = SYNTH_NO_ERROR;
    _mutex.lock();
    _dataReady = true;
    _mutex.unlock();
  }
}

/*
 * Reads point data from httpResponse payload and fills
 * the pointCloud of the coordinateSystem relative to the http request
 * originating httpResponse
 */
void SynthData::loadBinFile(QNetworkReply *httpResponse)
{
  //if(_state == READING_BIN_DATA || _state == BIN_DATA_FORMAT)
  bool ignore = false;
  _mutex.lock();
  ignore = _dataReady;
  _mutex.unlock();
  if(ignore)
  {
    httpResponse->deleteLater();
    return;
  }

  _step = LOADING_BIN;
  _progress = (_totalBinFilesCount - _semaphore) / _totalBinFilesCount * 100;
  _cb(progressInfo(),_info.toStdString().data());
  bool error = false;
  unsigned short versionMajor = readBigEndianUInt16(httpResponse,error);
  if(checkAndSetState(error,READING_BIN_DATA,httpResponse))
    return;
  unsigned short versionMinor = readBigEndianUInt16(httpResponse,error);
  if(checkAndSetState(error,READING_BIN_DATA,httpResponse)) return;
  if(checkAndSetState(versionMajor != 1 || versionMinor != 0, BIN_DATA_FORMAT, httpResponse)) return;
  int n = readCompressedInt(httpResponse,error);
  if(checkAndSetState(error,READING_BIN_DATA,httpResponse)) return;
  //skip the header section
  for (int i = 0; i < n; i++)
  {
    int m = readCompressedInt(httpResponse,error);
    if(checkAndSetState(error,READING_BIN_DATA,httpResponse)) return;
    for (int j = 0; j < m; j++)
    {
      readCompressedInt(httpResponse,error);
      if(checkAndSetState(error,READING_BIN_DATA,httpResponse)) return;
      readCompressedInt(httpResponse,error);
      if(checkAndSetState(error,READING_BIN_DATA,httpResponse)) return;
    }
  }

  int nPoints = readCompressedInt(httpResponse,error);
  if(checkAndSetState(error,READING_BIN_DATA,httpResponse)) return;
  for (int i = 0; i < nPoints; i++)
  {
    Point point;

    point._x = readBigEndianSingle(httpResponse,error);
    if(checkAndSetState(error,READING_BIN_DATA,httpResponse)) return;
    point._y = readBigEndianSingle(httpResponse,error);
    if(checkAndSetState(error,READING_BIN_DATA,httpResponse)) return;
    point._z = readBigEndianSingle(httpResponse,error);
    if(checkAndSetState(error,READING_BIN_DATA,httpResponse)) return;

    ushort color = readBigEndianUInt16(httpResponse,error);
    if(checkAndSetState(error,READING_BIN_DATA,httpResponse)) return;

    point._r = (uchar)(((color >> 11) * 255) / 31);
    point._g = (uchar)((((color >> 5) & 63) * 255) / 63);
    point._b = (uchar)(((color & 31) * 255) / 31);
    //the cloud whose received points belong to
    PointCloud *cloud = (PointCloud *)httpResponse->request().originatingObject();
    cloud->_points.append(point);
  }

  _mutex.lock();
  --_semaphore;
  _mutex.unlock();
  if(_semaphore == 0)
  {
    if(!_savePath.isEmpty())
    {
      _progress = 100;
      _cb(progressInfo(),_info.toStdString().data());
      downloadImages();
    }
    else
      setState(SYNTH_NO_ERROR);
  }

  httpResponse->deleteLater();
}

/*
 * Asks the server for the images making up this synth.
 * One http request is made for each image.
 */
void SynthData::downloadImages()
{
  _step = DOWNLOAD_IMG;
  _progress = 0;
  _cb(progressInfo(),_info.toStdString().data());
  QDir dir(_savePath);
  dir.mkdir(_collectionID);

  QNetworkAccessManager *manager = new QNetworkAccessManager(this);
  connect(manager, SIGNAL(finished(QNetworkReply*)),
          this, SLOT(saveImages(QNetworkReply*)));
  int requestCount = 0;
  foreach(Image img, *_imageMap)
  {
    for(int i = 0; i < img._shouldBeDownloaded; ++i)
    {
      QNetworkRequest *request = new QNetworkRequest(QUrl(img._url));
      request->setAttribute(QNetworkRequest::User,QVariant(img._ID));
      manager->get(*request);
      delete request;
      ++requestCount;
    }
  }
  if(requestCount == 0)
  {
    _state = SYNTH_NO_ERROR;
    _mutex.lock();
    _dataReady = true;
    _mutex.unlock();
  }
}

/*
 * Reads the http response and save the image to the filesystem
 */
void SynthData::saveImages(QNetworkReply *httpResponse)
{
  //if(_state == SAVE_IMG)
  bool ignore = false;
  _mutex.lock();
  ignore = _dataReady;
  _mutex.unlock();
  if(ignore)
  {
    httpResponse->deleteLater();
    return;
  }

  if(httpResponse->error() != QNetworkReply::NoError)
    qDebug() << httpResponse->errorString();

  _progress = (int)(_semaphore / _numImages) * 100;
  _cb(progressInfo(),_info.toStdString().data());
  QByteArray payload = httpResponse->readAll();
  QDir dir(_savePath);
  dir.cd(_collectionID);
  int id = httpResponse->request().attribute(QNetworkRequest::User).toInt();
  QString filename("IMG_%1.jpg");
  QFile file(dir.filePath(filename.arg(QString::number(id))));
  if(checkAndSetState(!file.open(QIODevice::WriteOnly), SAVE_IMG, httpResponse)) return;
  if(checkAndSetState(file.write(payload) == -1, SAVE_IMG, httpResponse)) return;
  file.close();

  _mutex.lock();
  ++_semaphore;
  _mutex.unlock();
  if(checkAndSetState(_semaphore == _imagesToDownloadCount, SYNTH_NO_ERROR, httpResponse)) return;

  httpResponse->deleteLater();
}

/******************
 * ImportSettings *
 ******************/

ImportSettings::ImportSettings(QString url, int clusterID, QString imageSavePath)
{
  _url = url;
  _clusterID = clusterID;
  _imageSavePath = imageSavePath;
}

/*********************
 * Utility functions *
 *********************/

/*
 * based on C# code from Christoph Hausner's SynthExport
 */
int readCompressedInt(QIODevice *device, bool &error)
{
  error = false;
  int i = 0;
  unsigned char byte;

  do
  {
    error = device->read((char *)&byte, sizeof(char)) == -1 ? true : false;
    if(error)
      return i;
    i = (i << 7) | (byte & 127);
  } while (byte < 128);
  return i;
}

/*
 * based on C# code from Christoph Hausner's SynthExport
 */
float readBigEndianSingle(QIODevice *device, bool &error)
{
  error = false;
  unsigned char bytes[4];
  for(int i = 0; i < 4; ++i)
  {
    error = device->read((char *)(bytes + i), sizeof(char)) == -1 ? true : false;
    if(error)
      return -1;
  }
  unsigned char reversed[] = { bytes[3],bytes[2],bytes[1],bytes[0] };

  float *f = (float *)(&  reversed[0]);
  return*f;
}

/*
 * based on C# code from Christoph Hausner's SynthExport
 */
unsigned short readBigEndianUInt16(QIODevice *device, bool &error)
{
  error = false;
  unsigned short byte1=0;
  error = device->read((char *)&byte1,sizeof(char)) == -1 ? true : false;
  if(error) return 0;
  unsigned short byte2=0;
  error = device->read((char *)&byte2,sizeof(char)) == -1 ? true : false;
  if(error)
    return 0;

  return byte2 | (byte1 << 8);
}

void printPoint(Point *p)
{
  qDebug() << "x =" << p->_x << "; y =" << p->_y << "; z =" << p->_z << "R: " << p->_r << " G: " << p->_g << " B: " << p->_b;
}