qgsmaprenderercustompainterjob.cpp

Go to the documentation of this file.

/***************************************************************************
  qgsmaprenderercustompainterjob.cpp
  --------------------------------------
  Date                 : December 2013
  Copyright            : (C) 2013 by Martin Dobias
  Email                : wonder dot sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsmaprenderercustompainterjob.h"
 
#include <memory>
 
#include "qgselevationmap.h"
#include "qgsfeedback.h"
#include "qgslabelingengine.h"
#include "qgslogger.h"
#include "qgsmaplayerlistutils_p.h"
#include "qgsmaplayerrenderer.h"
#include "qgspainting.h"
 
#include <QString>
#include <QtConcurrentRun>
 
#include "moc_qgsmaprenderercustompainterjob.cpp"
 
using namespace Qt::StringLiterals;
 
//
// QgsMapRendererAbstractCustomPainterJob
//
 
QgsMapRendererAbstractCustomPainterJob::QgsMapRendererAbstractCustomPainterJob( const QgsMapSettings &settings )
  : QgsMapRendererJob( settings )
{}
 
void QgsMapRendererAbstractCustomPainterJob::preparePainter( QPainter *painter, const QColor &backgroundColor )
{
  // clear the background
  painter->fillRect( 0, 0, mSettings.deviceOutputSize().width(), mSettings.deviceOutputSize().height(), backgroundColor );
 
  painter->setRenderHint( QPainter::Antialiasing, mSettings.testFlag( Qgis::MapSettingsFlag::Antialiasing ) );
  painter->setRenderHint( QPainter::SmoothPixmapTransform, mSettings.testFlag( Qgis::MapSettingsFlag::HighQualityImageTransforms ) );
  painter->setRenderHint( QPainter::LosslessImageRendering, mSettings.testFlag( Qgis::MapSettingsFlag::LosslessImageRendering ) );
 
#ifndef QT_NO_DEBUG
  QPaintDevice *paintDevice = painter->device();
  const QString errMsg = u"pre-set DPI not equal to painter's DPI (%1 vs %2)"_s.arg( paintDevice->logicalDpiX() ).arg( mSettings.outputDpi() );
  Q_ASSERT_X( qgsDoubleNear( paintDevice->logicalDpiX(), mSettings.outputDpi(), 1.0 ), "Job::startRender()", errMsg.toLatin1().data() );
#endif
}
 
 
//
// QgsMapRendererCustomPainterJob
//
 
QgsMapRendererCustomPainterJob::QgsMapRendererCustomPainterJob( const QgsMapSettings &settings, QPainter *painter )
  : QgsMapRendererAbstractCustomPainterJob( settings )
  , mPainter( painter )
{
  QgsDebugMsgLevel( u"QPAINTER construct"_s, 5 );
}
 
QgsMapRendererCustomPainterJob::~QgsMapRendererCustomPainterJob()
{
  QgsDebugMsgLevel( u"QPAINTER destruct"_s, 5 );
  Q_ASSERT( !mFutureWatcher.isRunning() );
  //cancel();
}
 
void QgsMapRendererCustomPainterJob::startPrivate()
{
  if ( isActive() )
    return;
 
  if ( !mPrepareOnly )
    mRenderingStart.start();
 
  mActive = true;
 
  mErrors.clear();
 
  QgsDebugMsgLevel( u"QPAINTER run!"_s, 5 );
 
  QgsDebugMsgLevel( u"Preparing list of layer jobs for rendering"_s, 5 );
  QElapsedTimer prepareTime;
  prepareTime.start();
 
  preparePainter( mPainter, mSettings.backgroundColor() );
 
  mLabelingEngineV2.reset();
 
  if ( mSettings.testFlag( Qgis::MapSettingsFlag::DrawLabeling ) )
  {
    mLabelingEngineV2 = std::make_unique<QgsDefaultLabelingEngine>();
    mLabelingEngineV2->setMapSettings( mSettings );
  }
 
  const bool canUseLabelCache = prepareLabelCache();
  mLayerJobs = prepareJobs( mPainter, mLabelingEngineV2.get() );
  mLabelJob = prepareLabelingJob( mPainter, mLabelingEngineV2.get(), canUseLabelCache );
  mSecondPassLayerJobs = prepareSecondPassJobs( mLayerJobs, mLabelJob );
 
  QgsDebugMsgLevel( u"Rendering prepared in (seconds): %1"_s.arg( prepareTime.elapsed() / 1000.0 ), 4 );
 
  if ( mRenderSynchronously )
  {
    if ( !mPrepareOnly )
    {
      // do the rendering right now!
      doRender();
    }
    return;
  }
 
  // now we are ready to start rendering!
  connect( &mFutureWatcher, &QFutureWatcher<void>::finished, this, &QgsMapRendererCustomPainterJob::futureFinished );
 
  mFuture = QtConcurrent::run( staticRender, this );
  mFutureWatcher.setFuture( mFuture );
}
 
 
void QgsMapRendererCustomPainterJob::cancel()
{
  if ( !isActive() )
  {
    QgsDebugMsgLevel( u"QPAINTER not running!"_s, 4 );
    return;
  }
 
  QgsDebugMsgLevel( u"QPAINTER canceling"_s, 5 );
  disconnect( &mFutureWatcher, &QFutureWatcher<void>::finished, this, &QgsMapRendererCustomPainterJob::futureFinished );
  cancelWithoutBlocking();
 
  QElapsedTimer t;
  t.start();
 
  mFutureWatcher.waitForFinished();
 
  QgsDebugMsgLevel( u"QPAINER cancel waited %1 ms"_s.arg( t.elapsed() / 1000.0 ), 5 );
 
  futureFinished();
 
  QgsDebugMsgLevel( u"QPAINTER canceled"_s, 5 );
}
 
void QgsMapRendererCustomPainterJob::cancelWithoutBlocking()
{
  if ( !isActive() )
  {
    QgsDebugError( u"QPAINTER not running!"_s );
    return;
  }
 
  mLabelJob.context.setRenderingStopped( true );
  for ( LayerRenderJob &job : mLayerJobs )
  {
    job.context()->setRenderingStopped( true );
    if ( job.renderer && job.renderer->feedback() )
      job.renderer->feedback()->cancel();
  }
}
 
void QgsMapRendererCustomPainterJob::waitForFinished()
{
  if ( !isActive() )
    return;
 
  disconnect( &mFutureWatcher, &QFutureWatcher<void>::finished, this, &QgsMapRendererCustomPainterJob::futureFinished );
 
  QElapsedTimer t;
  t.start();
 
  mFutureWatcher.waitForFinished();
 
  QgsDebugMsgLevel( u"waitForFinished: %1 ms"_s.arg( t.elapsed() / 1000.0 ), 4 );
 
  futureFinished();
}
 
bool QgsMapRendererCustomPainterJob::isActive() const
{
  return mActive;
}
 
bool QgsMapRendererCustomPainterJob::usedCachedLabels() const
{
  return mLabelJob.cached;
}
 
QgsLabelingResults *QgsMapRendererCustomPainterJob::takeLabelingResults()
{
  if ( mLabelingEngineV2 )
    return mLabelingEngineV2->takeResults();
  else
    return nullptr;
}
 
 
void QgsMapRendererCustomPainterJob::waitForFinishedWithEventLoop( QEventLoop::ProcessEventsFlags flags )
{
  QEventLoop loop;
  connect( &mFutureWatcher, &QFutureWatcher<void>::finished, &loop, &QEventLoop::quit );
  loop.exec( flags );
}
 
 
void QgsMapRendererCustomPainterJob::renderSynchronously()
{
  mRenderSynchronously = true;
  start();
  futureFinished();
  mRenderSynchronously = false;
}
 
void QgsMapRendererCustomPainterJob::prepare()
{
  mRenderSynchronously = true;
  mPrepareOnly = true;
  start();
  mPrepared = true;
}
 
void QgsMapRendererCustomPainterJob::renderPrepared()
{
  if ( !mPrepared )
    return;
 
  doRender();
  futureFinished();
  mRenderSynchronously = false;
  mPrepareOnly = false;
  mPrepared = false;
}
 
void QgsMapRendererCustomPainterJob::futureFinished()
{
  mActive = false;
  if ( !mPrepared ) // can't access from other thread
    mRenderingTime = mRenderingStart.elapsed();
  QgsDebugMsgLevel( u"QPAINTER futureFinished"_s, 5 );
 
  if ( !mPrepared )
    logRenderingTime( mLayerJobs, {}, mLabelJob );
 
  // final cleanup
  cleanupJobs( mLayerJobs );
  cleanupSecondPassJobs( mSecondPassLayerJobs );
  cleanupLabelJob( mLabelJob );
 
  emit finished();
}
 
 
void QgsMapRendererCustomPainterJob::staticRender( QgsMapRendererCustomPainterJob *self )
{
  try
  {
    self->doRender();
  }
  catch ( QgsException &e )
  {
    Q_UNUSED( e )
    QgsDebugError( "Caught unhandled QgsException: " + e.what() );
  }
  catch ( std::exception &e )
  {
    Q_UNUSED( e )
    QgsDebugError( "Caught unhandled std::exception: " + QString::fromLatin1( e.what() ) );
  }
  catch ( ... )
  {
    QgsDebugError( u"Caught unhandled unknown exception"_s );
  }
}
 
void QgsMapRendererCustomPainterJob::doRender()
{
  const bool hasSecondPass = !mSecondPassLayerJobs.empty();
  QgsDebugMsgLevel( u"Starting to render layer stack."_s, 5 );
  QElapsedTimer renderTime;
  renderTime.start();
 
  const QgsElevationShadingRenderer mapShadingRenderer = mSettings.elevationShadingRenderer();
  std::unique_ptr<QgsElevationMap> mainElevationMap;
  if ( mapShadingRenderer.isActive() )
    mainElevationMap = std::make_unique<QgsElevationMap>( mSettings.deviceOutputSize(), mSettings.devicePixelRatio() );
 
  for ( LayerRenderJob &job : mLayerJobs )
  {
    if ( job.context()->renderingStopped() )
      break;
 
    emit layerRenderingStarted( job.layerId );
 
    if ( !hasSecondPass
         && ( job.context()->flags().testFlag( Qgis::RenderContextFlag::UseAdvancedEffects ) && job.context()->rasterizedRenderingPolicy() != Qgis::RasterizedRenderingPolicy::ForceVector ) )
    {
      // Set the QPainter composition mode so that this layer is rendered using
      // the desired blending mode
      mPainter->setCompositionMode( job.blendMode );
    }
 
    if ( !job.cached )
    {
      QElapsedTimer layerTime;
      layerTime.start();
 
      if ( job.previewRenderImage && !job.previewRenderImageInitialized )
      {
        job.previewRenderImage->fill( 0 );
        job.previewRenderImageInitialized = true;
      }
 
      if ( job.img )
      {
        job.img->fill( 0 );
        job.imageInitialized = true;
      }
 
      job.completed = job.renderer->render();
 
      if ( job.picture )
      {
        job.renderer->renderContext()->painter()->end();
      }
 
      job.renderingTime += layerTime.elapsed();
    }
 
    if ( !hasSecondPass && job.img )
    {
      // If we flattened this layer for alternate blend modes, composite it now
      mPainter->setOpacity( job.opacity );
      mPainter->drawImage( 0, 0, *job.img );
      mPainter->setOpacity( 1.0 );
    }
 
    if ( mainElevationMap && job.context()->elevationMap() )
    {
      const QgsElevationMap &layerElevationMap = *job.context()->elevationMap();
      if ( layerElevationMap.isValid() )
        mainElevationMap->combine( layerElevationMap, mapShadingRenderer.combinedElevationMethod() );
    }
 
    emit layerRendered( job.layerId );
  }
 
  emit renderingLayersFinished();
  QgsDebugMsgLevel( u"Done rendering map layers"_s, 5 );
 
  if ( mapShadingRenderer.isActive() && mainElevationMap )
  {
    QImage image( mainElevationMap->rawElevationImage().size(), QImage::Format_RGB32 );
    image.setDevicePixelRatio( mSettings.devicePixelRatio() );
    image.fill( Qt::white );
    mapShadingRenderer.renderShading( *mainElevationMap.get(), image, QgsRenderContext::fromMapSettings( mSettings ) );
    mPainter->save();
    mPainter->setCompositionMode( QPainter::CompositionMode_Multiply );
    mPainter->drawImage( 0, 0, image );
    mPainter->restore();
  }
 
  if ( mSettings.testFlag( Qgis::MapSettingsFlag::DrawLabeling ) && !mLabelJob.context.renderingStopped() )
  {
    if ( !mLabelJob.cached )
    {
      QElapsedTimer labelTime;
      labelTime.start();
 
      if ( mLabelJob.img )
      {
        QPainter painter;
        mLabelJob.img->fill( 0 );
        painter.begin( mLabelJob.img );
        mLabelJob.context.setPainter( &painter );
        drawLabeling( mLabelJob.context, mLabelingEngineV2.get(), &painter );
        painter.end();
      }
      else if ( mLabelJob.picture )
      {
        QPainter painter;
        painter.begin( mLabelJob.picture.get() );
        mLabelJob.context.setPainter( &painter );
        drawLabeling( mLabelJob.context, mLabelingEngineV2.get(), &painter );
        painter.end();
      }
      else
      {
        drawLabeling( mLabelJob.context, mLabelingEngineV2.get(), mPainter );
      }
 
      mLabelJob.complete = true;
      mLabelJob.renderingTime = labelTime.elapsed();
      mLabelJob.participatingLayers = participatingLabelLayers( mLabelingEngineV2.get() );
    }
  }
 
  if ( !hasSecondPass )
  {
    if ( mLabelJob.img && mLabelJob.complete )
    {
      mPainter->setCompositionMode( QPainter::CompositionMode_SourceOver );
      mPainter->setOpacity( 1.0 );
      mPainter->drawImage( 0, 0, *mLabelJob.img );
    }
  }
  else
  {
    initSecondPassJobs( mSecondPassLayerJobs, mLabelJob );
 
    for ( LayerRenderJob &job : mSecondPassLayerJobs )
    {
      if ( job.context()->renderingStopped() )
        break;
 
      if ( !job.cached )
      {
        QElapsedTimer layerTime;
        layerTime.start();
 
        if ( job.previewRenderImage && !job.previewRenderImageInitialized )
        {
          job.previewRenderImage->fill( 0 );
          job.previewRenderImageInitialized = true;
        }
 
        if ( job.img )
        {
          job.img->fill( 0 );
          job.imageInitialized = true;
        }
 
        job.completed = job.renderer->render();
 
        if ( job.picture )
        {
          job.renderer->renderContext()->painter()->end();
        }
 
        job.renderingTime += layerTime.elapsed();
      }
    }
 
    bool forceVector = mSettings.testFlag( Qgis::MapSettingsFlag::ForceVectorOutput ) && !mSettings.testFlag( Qgis::MapSettingsFlag::ForceRasterMasks );
    composeSecondPass( mSecondPassLayerJobs, mLabelJob, forceVector );
 
    if ( !forceVector )
    {
      const QImage finalImage = composeImage( mSettings, mLayerJobs, mLabelJob );
 
      mPainter->setCompositionMode( QPainter::CompositionMode_SourceOver );
      mPainter->setOpacity( 1.0 );
      mPainter->drawImage( 0, 0, finalImage );
    }
    else
    {
      //Vector composition is simply draw the saved picture on the painter
      for ( LayerRenderJob &job : mLayerJobs )
      {
        // if there is vector rendering we use it, else we use the raster rendering
        if ( job.picture )
        {
          QgsPainting::drawPicture( mPainter, QPointF( 0, 0 ), *job.picture );
        }
        else
          mPainter->drawImage( 0, 0, *job.img );
      }
 
      if ( mLabelJob.picture )
      {
        QgsPainting::drawPicture( mPainter, QPointF( 0, 0 ), *mLabelJob.picture );
      }
    }
  }
 
  QgsDebugMsgLevel( u"Rendering completed in (seconds): %1"_s.arg( renderTime.elapsed() / 1000.0 ), 2 );
}