qgsalgorithmextractlabels.cpp

Go to the documentation of this file.

/***************************************************************************
  qgsalgorithmextractlabels.cpp - QgsExtractLabelsAlgorithm
 ---------------------
 begin                : 30.12.2021
 copyright            : (C) 2021 by Mathieu Pellerin
 email                : nirvn dot asia 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 "qgsalgorithmextractlabels.h"
 
#include <cmath>
 
#include "pal/feature.h"
#include "pal/labelposition.h"
#include "qgsexpressioncontextutils.h"
#include "qgslabelsink.h"
#include "qgslayertree.h"
#include "qgsmaprenderercustompainterjob.h"
#include "qgsmapthemecollection.h"
#include "qgsnullpainterdevice.h"
#include "qgsnullsymbolrenderer.h"
#include "qgsprocessingfeedback.h"
#include "qgsprocessingparameters.h"
#include "qgsscalecalculator.h"
#include "qgstextlabelfeature.h"
#include "qgsvectorlayer.h"
 
#include <QPainter>
#include <QString>
 
using namespace Qt::StringLiterals;

 
QString QgsExtractLabelsAlgorithm::name() const
{
  return u"extractlabels"_s;
}
 
QString QgsExtractLabelsAlgorithm::displayName() const
{
  return QObject::tr( "Extract labels" );
}
 
QStringList QgsExtractLabelsAlgorithm::tags() const
{
  return QObject::tr( "map themes,font,position" ).split( ',' );
}
 
Qgis::ProcessingAlgorithmFlags QgsExtractLabelsAlgorithm::flags() const
{
  return QgsProcessingAlgorithm::flags() | Qgis::ProcessingAlgorithmFlag::RequiresProject;
}
 
QString QgsExtractLabelsAlgorithm::group() const
{
  return QObject::tr( "Cartography" );
}
 
QString QgsExtractLabelsAlgorithm::groupId() const
{
  return u"cartography"_s;
}
 
void QgsExtractLabelsAlgorithm::initAlgorithm( const QVariantMap & )
{
  addParameter( new QgsProcessingParameterExtent( u"EXTENT"_s, QObject::tr( "Map extent" ) ) );
 
  addParameter( new QgsProcessingParameterScale( u"SCALE"_s, QObject::tr( "Map scale" ) ) );
 
  auto mapThemeParameter = std::make_unique<QgsProcessingParameterMapTheme>( u"MAP_THEME"_s, QObject::tr( "Map theme" ), QVariant(), true );
  mapThemeParameter->setHelp( QObject::tr( "This parameter is optional. When left unset, the algorithm will fallback to extracting labels from all currently visible layers in the project." ) );
  addParameter( mapThemeParameter.release() );
 
  addParameter( new QgsProcessingParameterBoolean( u"INCLUDE_UNPLACED"_s, QObject::tr( "Include unplaced labels" ), QVariant( true ) ) );
 
  auto dpiParameter = std::make_unique<QgsProcessingParameterNumber>( u"DPI"_s, QObject::tr( "Map resolution (in DPI)" ), Qgis::ProcessingNumberParameterType::Double, QVariant( 96.0 ), true );
  dpiParameter->setFlags( dpiParameter->flags() | Qgis::ProcessingParameterFlag::Advanced );
  addParameter( dpiParameter.release() );
 
  addParameter( new QgsProcessingParameterFeatureSink( u"OUTPUT"_s, QObject::tr( "Extracted labels" ), Qgis::ProcessingSourceType::VectorPoint ) );
}
 
QString QgsExtractLabelsAlgorithm::shortDescription() const
{
  return QObject::tr( "Converts map labels to a point layer with relevant details saved as attributes." );
}
 
Qgis::ProcessingAlgorithmDocumentationFlags QgsExtractLabelsAlgorithm::documentationFlags() const
{
  return Qgis::ProcessingAlgorithmDocumentationFlag::RegeneratesPrimaryKey;
}
 
QString QgsExtractLabelsAlgorithm::shortHelpString() const
{
  return QObject::tr(
    "This algorithm extracts label information from a rendered map at a given extent and scale.\n\n"
    "If a map theme is provided, the rendered map will match the visibility and symbology of that theme. If left blank, all visible layers from the project will be used.\n\n"
    "Extracted label information include: position (served as point geometries), the associated layer name and feature ID, label text, rotation (in degree, clockwise), multiline alignment, and font "
    "details."
  );
}
 
QgsExtractLabelsAlgorithm *QgsExtractLabelsAlgorithm::createInstance() const
{
  return new QgsExtractLabelsAlgorithm();
}
 
class ExtractLabelSink : public QgsLabelSink
{
  public:
    ExtractLabelSink( const QMap<QString, QString> &mapLayerNames, QgsProcessingFeedback *feedback )
      : mMapLayerNames( mapLayerNames )
      , mFeedback( feedback )
    {}
 
    void drawLabel( const QString &layerId, QgsRenderContext &context, pal::LabelPosition *label, const QgsPalLayerSettings &settings ) override
    {
      processLabel( layerId, context, label, settings, false );
    }
 
    void drawUnplacedLabel( const QString &layerId, QgsRenderContext &context, pal::LabelPosition *label, const QgsPalLayerSettings &settings ) override
    {
      processLabel( layerId, context, label, settings, true );
    }
 
    void processLabel( const QString &layerId, QgsRenderContext &context, pal::LabelPosition *label, const QgsPalLayerSettings &settings, bool unplacedLabel )
    {
      if ( mFeedback->isCanceled() )
      {
        context.setRenderingStopped( true );
      }
 
      const QgsFeatureId fid = label->getFeaturePart()->featureId();
      switch ( settings.placement )
      {
        case Qgis::LabelPlacement::Curved:
        case Qgis::LabelPlacement::PerimeterCurved:
        {
          if ( !mCurvedWarningPushed.contains( layerId ) )
          {
            mCurvedWarningPushed << layerId;
            mFeedback->pushWarning( QObject::tr( "Curved placement not supported, skipping labels from layer %1" ).arg( mMapLayerNames.value( layerId ) ) );
          }
          return;
        }
 
        case Qgis::LabelPlacement::AroundPoint:
        case Qgis::LabelPlacement::OverPoint:
        case Qgis::LabelPlacement::Line:
        case Qgis::LabelPlacement::Horizontal:
        case Qgis::LabelPlacement::Free:
        case Qgis::LabelPlacement::OrderedPositionsAroundPoint:
        case Qgis::LabelPlacement::OutsidePolygons:
          break;
      }
 
      QgsTextLabelFeature *labelFeature = dynamic_cast<QgsTextLabelFeature *>( label->getFeaturePart()->feature() );
      if ( !labelFeature )
        return;
 
      QgsPalLayerSettings labelSettings( settings );
      const QMap<QgsPalLayerSettings::Property, QVariant> &dataDefinedValues = labelFeature->dataDefinedValues();
 
      if ( dataDefinedValues.contains( QgsPalLayerSettings::Property::MultiLineWrapChar ) )
      {
        labelSettings.wrapChar = dataDefinedValues.value( QgsPalLayerSettings::Property::MultiLineWrapChar ).toString();
      }
      if ( dataDefinedValues.contains( QgsPalLayerSettings::Property::AutoWrapLength ) )
      {
        labelSettings.autoWrapLength = dataDefinedValues.value( QgsPalLayerSettings::Property::AutoWrapLength ).toInt();
      }
      const QString labelText = QgsPalLabeling::splitToLines( labelFeature->text( -1 ), labelSettings.wrapChar, labelSettings.autoWrapLength, labelSettings.useMaxLineLengthForAutoWrap ).join( '\n' );
 
      QString labelAlignment;
      if ( dataDefinedValues.contains( QgsPalLayerSettings::Property::MultiLineAlignment ) )
      {
        labelSettings.multilineAlign = static_cast<Qgis::LabelMultiLineAlignment>( dataDefinedValues.value( QgsPalLayerSettings::Property::MultiLineAlignment ).toInt() );
      }
      switch ( labelSettings.multilineAlign )
      {
        case Qgis::LabelMultiLineAlignment::Right:
          labelAlignment = u"right"_s;
          break;
 
        case Qgis::LabelMultiLineAlignment::Center:
          labelAlignment = u"center"_s;
          break;
 
        case Qgis::LabelMultiLineAlignment::Left:
          labelAlignment = u"left"_s;
          break;
 
        case Qgis::LabelMultiLineAlignment::Justify:
          labelAlignment = u"justify"_s;
          break;
 
        case Qgis::LabelMultiLineAlignment::FollowPlacement:
          switch ( label->quadrant() )
          {
            case Qgis::LabelQuadrantPosition::AboveLeft:
            case Qgis::LabelQuadrantPosition::Left:
            case Qgis::LabelQuadrantPosition::BelowLeft:
              labelAlignment = u"right"_s;
              break;
 
            case Qgis::LabelQuadrantPosition::Above:
            case Qgis::LabelQuadrantPosition::Over:
            case Qgis::LabelQuadrantPosition::Below:
              labelAlignment = u"center"_s;
              break;
 
            case Qgis::LabelQuadrantPosition::AboveRight:
            case Qgis::LabelQuadrantPosition::Right:
            case Qgis::LabelQuadrantPosition::BelowRight:
              labelAlignment = u"left"_s;
              break;
          }
          break;
      }
 
      const double labelRotation = !qgsDoubleNear( label->getAlpha(), 0.0 ) ? -( label->getAlpha() * 180 / M_PI ) + 360 : 0.0;
 
      const QFont font = labelFeature->definedFont();
      const QString fontFamily = font.family();
      const QString fontStyle = font.styleName();
      const double fontSize = static_cast<double>( font.pixelSize() ) * 72 / context.painter()->device()->logicalDpiX();
      const bool fontItalic = font.italic();
      const bool fontBold = font.bold();
      const bool fontUnderline = font.underline();
      const double fontLetterSpacing = font.letterSpacing();
      const double fontWordSpacing = font.wordSpacing();
 
      QgsTextFormat format = labelSettings.format();
      if ( dataDefinedValues.contains( QgsPalLayerSettings::Property::Size ) )
      {
        format.setSize( dataDefinedValues.value( QgsPalLayerSettings::Property::Size ).toDouble() );
      }
      if ( dataDefinedValues.contains( QgsPalLayerSettings::Property::Color ) )
      {
        format.setColor( dataDefinedValues.value( QgsPalLayerSettings::Property::Color ).value<QColor>() );
      }
      if ( dataDefinedValues.contains( QgsPalLayerSettings::Property::FontOpacity ) )
      {
        format.setOpacity( dataDefinedValues.value( QgsPalLayerSettings::Property::FontOpacity ).toDouble() / 100.0 );
      }
      if ( dataDefinedValues.contains( QgsPalLayerSettings::Property::MultiLineHeight ) )
      {
        format.setLineHeight( dataDefinedValues.value( QgsPalLayerSettings::Property::MultiLineHeight ).toDouble() );
      }
 
      const QString formatColor = format.color().name();
      const double formatOpacity = format.opacity() * 100;
      const double formatLineHeight = format.lineHeight();
 
      QgsTextBufferSettings buffer = format.buffer();
      if ( dataDefinedValues.contains( QgsPalLayerSettings::Property::BufferDraw ) )
      {
        buffer.setEnabled( dataDefinedValues.value( QgsPalLayerSettings::Property::BufferDraw ).toBool() );
      }
      const bool bufferDraw = buffer.enabled();
      double bufferSize = 0.0;
      QString bufferColor;
      double bufferOpacity = 0.0;
      if ( bufferDraw )
      {
        if ( dataDefinedValues.contains( QgsPalLayerSettings::Property::BufferSize ) )
        {
          buffer.setSize( dataDefinedValues.value( QgsPalLayerSettings::Property::BufferSize ).toDouble() );
        }
        if ( dataDefinedValues.contains( QgsPalLayerSettings::Property::BufferColor ) )
        {
          buffer.setColor( dataDefinedValues.value( QgsPalLayerSettings::Property::BufferColor ).value<QColor>() );
        }
        if ( dataDefinedValues.contains( QgsPalLayerSettings::Property::BufferOpacity ) )
        {
          buffer.setOpacity( dataDefinedValues.value( QgsPalLayerSettings::Property::BufferOpacity ).toDouble() / 100.0 );
        }
 
        bufferSize = buffer.sizeUnit() == Qgis::RenderUnit::Percentage ? context.convertToPainterUnits( format.size(), format.sizeUnit(), format.sizeMapUnitScale() ) * buffer.size() / 100
                                                                       : context.convertToPainterUnits( buffer.size(), buffer.sizeUnit(), buffer.sizeMapUnitScale() );
        bufferSize = bufferSize * 72 / context.painter()->device()->logicalDpiX();
        bufferColor = buffer.color().name();
        bufferOpacity = buffer.opacity() * 100;
      }
 
      QgsAttributes attributes;
      attributes
        << mMapLayerNames.value( layerId )
        << fid
        << labelText
        << label->getWidth()
        << label->getHeight()
        << labelRotation
        << unplacedLabel
        << fontFamily
        << fontSize
        << fontItalic
        << fontBold
        << fontUnderline
        << fontStyle
        << fontLetterSpacing
        << fontWordSpacing
        << labelAlignment
        << formatLineHeight
        << formatColor
        << formatOpacity
        << bufferDraw
        << bufferSize
        << bufferColor
        << bufferOpacity;
 
      double x = label->getX();
      double y = label->getY();
      QgsGeometry geometry( new QgsPoint( x, y ) );
 
      QgsFeature feature;
      feature.setAttributes( attributes );
      feature.setGeometry( geometry );
      features << feature;
    }
 
    QList<QgsFeature> features;
 
  private:
    QMap<QString, QString> mMapLayerNames;
    QList<QString> mCurvedWarningPushed;
 
    QgsProcessingFeedback *mFeedback = nullptr;
};
 
QVariantMap QgsExtractLabelsAlgorithm::processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback )
{
  const QgsRectangle extent = parameterAsExtent( parameters, u"EXTENT"_s, context );
  const double scale = parameterAsDouble( parameters, u"SCALE"_s, context );
  if ( qgsDoubleNear( scale, 0.0 ) )
  {
    throw QgsProcessingException( QObject::tr( "Invalid scale value, a number greater than 0 is required" ) );
  }
  double dpi = parameterAsDouble( parameters, u"DPI"_s, context );
  if ( qgsDoubleNear( dpi, 0.0 ) )
  {
    dpi = 96.0;
  }
 
  QgsScaleCalculator calculator;
  calculator.setDpi( dpi );
  calculator.setMapUnits( mCrs.mapUnits() );
  const QSize imageSize = calculator.calculateImageSize( extent, scale ).toSize();
 
  QgsFields fields;
  fields.append( QgsField( u"Layer"_s, QMetaType::Type::QString, QString(), 0, 0 ) );
  fields.append( QgsField( u"FeatureID"_s, QMetaType::Type::LongLong, QString(), 20 ) );
  fields.append( QgsField( u"LabelText"_s, QMetaType::Type::QString, QString(), 0, 0 ) );
  fields.append( QgsField( u"LabelWidth"_s, QMetaType::Type::Double, QString(), 20, 8 ) );
  fields.append( QgsField( u"LabelHeight"_s, QMetaType::Type::Double, QString(), 20, 8 ) );
  fields.append( QgsField( u"LabelRotation"_s, QMetaType::Type::Double, QString(), 20, 2 ) );
  fields.append( QgsField( u"LabelUnplaced"_s, QMetaType::Type::Bool, QString(), 1, 0 ) );
  fields.append( QgsField( u"Family"_s, QMetaType::Type::QString, QString(), 0, 0 ) );
  fields.append( QgsField( u"Size"_s, QMetaType::Type::Double, QString(), 20, 4 ) );
  fields.append( QgsField( u"Italic"_s, QMetaType::Type::Bool, QString(), 1, 0 ) );
  fields.append( QgsField( u"Bold"_s, QMetaType::Type::Bool, QString(), 1, 0 ) );
  fields.append( QgsField( u"Underline"_s, QMetaType::Type::Bool, QString(), 1, 0 ) );
  fields.append( QgsField( u"FontStyle"_s, QMetaType::Type::QString, QString(), 0, 0 ) );
  fields.append( QgsField( u"FontLetterSpacing"_s, QMetaType::Type::Double, QString(), 20, 4 ) );
  fields.append( QgsField( u"FontWordSpacing"_s, QMetaType::Type::Double, QString(), 20, 4 ) );
  fields.append( QgsField( u"MultiLineAlignment"_s, QMetaType::Type::QString, QString(), 0, 0 ) );
  fields.append( QgsField( u"MultiLineHeight"_s, QMetaType::Type::Double, QString(), 20, 2 ) );
  fields.append( QgsField( u"Color"_s, QMetaType::Type::QString, QString(), 7, 0 ) );
  fields.append( QgsField( u"FontOpacity"_s, QMetaType::Type::Double, QString(), 20, 1 ) );
  fields.append( QgsField( u"BufferDraw"_s, QMetaType::Type::Bool, QString(), 1, 0 ) );
  fields.append( QgsField( u"BufferSize"_s, QMetaType::Type::Double, QString(), 20, 4 ) );
  fields.append( QgsField( u"BufferColor"_s, QMetaType::Type::QString, QString(), 7, 0 ) );
  fields.append( QgsField( u"BufferOpacity"_s, QMetaType::Type::Double, QString(), 20, 1 ) );
 
  QString dest;
  std::unique_ptr<QgsFeatureSink> sink( parameterAsSink( parameters, u"OUTPUT"_s, context, dest, fields, Qgis::WkbType::Point, mCrs, QgsFeatureSink::RegeneratePrimaryKey ) );
  if ( !sink )
    throw QgsProcessingException( invalidSinkError( parameters, u"OUTPUT"_s ) );
 
  QgsMapSettings mapSettings;
  mapSettings.setDestinationCrs( mCrs );
  mapSettings.setExtent( extent );
  mapSettings.setOutputSize( imageSize );
  mapSettings.setOutputDpi( dpi );
  mapSettings.setFlag( Qgis::MapSettingsFlag::DrawLabeling, true );
  mapSettings.setFlag( Qgis::MapSettingsFlag::SkipSymbolRendering, true );
  mapSettings.setFlag( Qgis::MapSettingsFlag::UseRenderingOptimization, true );
  mapSettings.setLayers( mMapLayers );
  mapSettings.setLayerStyleOverrides( mMapThemeStyleOverrides );
  mapSettings.setLabelingEngineSettings( mLabelSettings );
  mapSettings.setScaleMethod( mScaleMethod );
  mapSettings.setEllipsoid( context.ellipsoid() );
 
  //build the expression context
  QgsExpressionContext expressionContext;
  expressionContext << QgsExpressionContextUtils::globalScope() << QgsExpressionContextUtils::projectScope( context.project() ) << QgsExpressionContextUtils::mapSettingsScope( mapSettings );
  mapSettings.setExpressionContext( expressionContext );
 
  QgsNullPaintDevice nullPaintDevice;
  nullPaintDevice.setOutputSize( imageSize );
  nullPaintDevice.setOutputDpi( static_cast<int>( std::round( dpi ) ) );
  QPainter painter( &nullPaintDevice );
 
  QgsMapRendererCustomPainterJob renderJob( mapSettings, &painter );
  ExtractLabelSink labelSink( mMapLayerNames, feedback );
  renderJob.setLabelSink( &labelSink );
 
  feedback->pushInfo( QObject::tr( "Extracting labels" ) );
 
  QgsProcessingMultiStepFeedback multiStepFeedback( 10, feedback );
  multiStepFeedback.setCurrentStep( 0 );
 
  QEventLoop loop;
  QObject::connect( feedback, &QgsFeedback::canceled, &renderJob, &QgsMapRendererCustomPainterJob::cancel );
  QObject::connect( &renderJob, &QgsMapRendererJob::renderingLayersFinished, feedback, [feedback]() { feedback->pushInfo( QObject::tr( "Calculating label placement" ) ); } );
  int labelsCollectedFromLayers = 0;
  QObject::connect( &renderJob, &QgsMapRendererJob::layerRenderingStarted, feedback, [this, &multiStepFeedback, &labelsCollectedFromLayers]( const QString &layerId ) {
    multiStepFeedback.pushInfo( QObject::tr( "Collecting labelled features from %1" ).arg( mMapLayerNames.value( layerId ) ) );
    multiStepFeedback.setProgress( 100.0 * static_cast<double>( labelsCollectedFromLayers ) / mMapLayers.size() );
    labelsCollectedFromLayers++;
  } );
 
  QObject::connect( renderJob.labelingEngineFeedback(), &QgsLabelingEngineFeedback::labelRegistrationAboutToBegin, &multiStepFeedback, [&multiStepFeedback]() {
    multiStepFeedback.setCurrentStep( 1 );
    multiStepFeedback.pushInfo( QObject::tr( "Registering labels" ) );
  } );
 
  QObject::connect( renderJob.labelingEngineFeedback(), &QgsLabelingEngineFeedback::providerRegistrationAboutToBegin, &multiStepFeedback, [this, &multiStepFeedback]( QgsAbstractLabelProvider *provider ) {
    multiStepFeedback.setCurrentStep( 2 );
    if ( !provider->layerId().isEmpty() )
    {
      multiStepFeedback.pushInfo( QObject::tr( "Adding labels from %1" ).arg( mMapLayerNames.value( provider->layerId() ) ) );
    }
  } );
  QObject::connect( renderJob.labelingEngineFeedback(), &QgsLabelingEngineFeedback::candidateCreationAboutToBegin, &multiStepFeedback, [this, &multiStepFeedback]( QgsAbstractLabelProvider *provider ) {
    multiStepFeedback.setCurrentStep( 3 );
    if ( !provider->layerId().isEmpty() )
    {
      multiStepFeedback.pushInfo( QObject::tr( "Generating label placement candidates for %1" ).arg( mMapLayerNames.value( provider->layerId() ) ) );
    }
  } );
  QObject::connect( renderJob.labelingEngineFeedback(), &QgsLabelingEngineFeedback::obstacleCostingAboutToBegin, &multiStepFeedback, [&multiStepFeedback]() {
    multiStepFeedback.setCurrentStep( 4 );
    multiStepFeedback.setProgressText( QObject::tr( "Calculating obstacle costs" ) );
  } );
  QObject::connect( renderJob.labelingEngineFeedback(), &QgsLabelingEngineFeedback::calculatingConflictsAboutToBegin, &multiStepFeedback, [&multiStepFeedback]() {
    multiStepFeedback.setCurrentStep( 5 );
    multiStepFeedback.setProgressText( QObject::tr( "Calculating label conflicts" ) );
  } );
  QObject::connect( renderJob.labelingEngineFeedback(), &QgsLabelingEngineFeedback::finalizingCandidatesAboutToBegin, &multiStepFeedback, [&multiStepFeedback]() {
    multiStepFeedback.setCurrentStep( 6 );
    multiStepFeedback.setProgressText( QObject::tr( "Finalizing candidates" ) );
  } );
  QObject::connect( renderJob.labelingEngineFeedback(), &QgsLabelingEngineFeedback::reductionAboutToBegin, &multiStepFeedback, [&multiStepFeedback]() {
    multiStepFeedback.setCurrentStep( 7 );
    multiStepFeedback.setProgressText( QObject::tr( "Reducing problem" ) );
  } );
  QObject::connect( renderJob.labelingEngineFeedback(), &QgsLabelingEngineFeedback::solvingPlacementAboutToBegin, &multiStepFeedback, [&multiStepFeedback]() {
    multiStepFeedback.setCurrentStep( 8 );
    multiStepFeedback.setProgressText( QObject::tr( "Determining optimal label placements" ) );
  } );
  QObject::connect( renderJob.labelingEngineFeedback(), &QgsLabelingEngineFeedback::solvingPlacementFinished, &multiStepFeedback, [&multiStepFeedback]() {
    multiStepFeedback.setProgressText( QObject::tr( "Labeling complete" ) );
  } );
 
  QObject::connect( renderJob.labelingEngineFeedback(), &QgsLabelingEngineFeedback::progressChanged, &multiStepFeedback, [&multiStepFeedback]( double progress ) {
    multiStepFeedback.setProgress( progress );
  } );
 
  QObject::connect( &renderJob, &QgsMapRendererJob::finished, &loop, [&loop]() { loop.exit(); } );
  renderJob.start();
  loop.exec();
 
  qDeleteAll( mMapLayers );
  mMapLayers.clear();
 
  multiStepFeedback.setCurrentStep( 9 );
  feedback->pushInfo( QObject::tr( "Writing %n label(s) to output layer", "", labelSink.features.count() ) );
  const double step = !labelSink.features.empty() ? 100.0 / labelSink.features.count() : 1;
  long long index = -1;
  for ( QgsFeature &feature : labelSink.features )
  {
    index++;
    multiStepFeedback.setProgress( step * index );
    if ( feedback->isCanceled() )
      break;
 
    if ( !sink->addFeature( feature, QgsFeatureSink::FastInsert ) )
      throw QgsProcessingException( writeFeatureError( sink.get(), parameters, u"OUTPUT"_s ) );
    else
      feedback->featureAddedToSink( u"OUTPUT"_s );
  }
  sink->finalize();
  feedback->featureSinkFinalized( u"OUTPUT"_s );
  sink.reset();
 
  if ( QgsVectorLayer *vl = qobject_cast<QgsVectorLayer *>( QgsProcessingUtils::mapLayerFromString( dest, context ) ) )
  {
    vl->setRenderer( new QgsNullSymbolRenderer() );
    if ( vl->renderer() )
    {
      vl->renderer()->setReferenceScale( scale );
 
      QgsPalLayerSettings settings;
      QgsPropertyCollection settingsProperties;
 
      settings.fieldName = u"LabelText"_s;
      settings.obstacleSettings().setIsObstacle( false );
      settings.placement = Qgis::LabelPlacement::OverPoint;
      settings.pointSettings().setQuadrant( Qgis::LabelQuadrantPosition::AboveRight );
      settings.placementSettings().setAllowDegradedPlacement( true );
      settings.placementSettings().setOverlapHandling( Qgis::LabelOverlapHandling::AllowOverlapIfRequired );
 
      QgsTextFormat textFormat;
      textFormat.setSize( 9 );
      textFormat.setSizeUnit( Qgis::RenderUnit::Points );
      textFormat.setColor( QColor( 0, 0, 0 ) );
 
      QgsTextBufferSettings buffer = textFormat.buffer();
      buffer.setSizeUnit( Qgis::RenderUnit::Points );
 
      textFormat.setBuffer( buffer );
      settings.setFormat( textFormat );
 
      settingsProperties.setProperty( QgsPalLayerSettings::Property::Color, QgsProperty::fromExpression( u"if(\"LabelUnplaced\",'255,0,0',\"Color\")"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::FontOpacity, QgsProperty::fromField( u"FontOpacity"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::Family, QgsProperty::fromField( u"Family"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::Italic, QgsProperty::fromField( u"Italic"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::Bold, QgsProperty::fromField( u"Bold"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::Underline, QgsProperty::fromField( u"Underline"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::Size, QgsProperty::fromField( u"Size"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::FontLetterSpacing, QgsProperty::fromField( u"FontLetterSpacing"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::FontWordSpacing, QgsProperty::fromField( u"FontWordSpacing"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::MultiLineAlignment, QgsProperty::fromField( u"MultiLineAlignment"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::MultiLineHeight, QgsProperty::fromField( u"MultiLineHeight"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::LabelRotation, QgsProperty::fromField( u"LabelRotation"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::BufferDraw, QgsProperty::fromField( u"BufferDraw"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::BufferSize, QgsProperty::fromField( u"BufferSize"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::BufferColor, QgsProperty::fromField( u"BufferColor"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::BufferOpacity, QgsProperty::fromField( u"BufferOpacity"_s ) );
      settingsProperties.setProperty( QgsPalLayerSettings::Property::Show, QgsProperty::fromExpression( u"\"LabelUnplaced\"=false"_s ) );
      settings.setDataDefinedProperties( settingsProperties );
 
      QgsAbstractVectorLayerLabeling *labeling = new QgsVectorLayerSimpleLabeling( settings );
      vl->setLabeling( labeling );
      vl->setLabelsEnabled( true );
 
      QString errorMessage;
      vl->saveStyleToDatabaseV2( QString(), QString(), true, QString(), errorMessage );
    }
  }
 
  QVariantMap outputs;
  outputs.insert( u"OUTPUT"_s, dest );
  return outputs;
}
 
 
bool QgsExtractLabelsAlgorithm::prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * )
{
  // Retrieve and clone layers
  const QString mapTheme = parameterAsString( parameters, u"MAP_THEME"_s, context );
 
  QgsProject *project = context.project();
  if ( project )
  {
    if ( !mapTheme.isEmpty() && project->mapThemeCollection()->hasMapTheme( mapTheme ) )
    {
      const QList<QgsMapLayer *> constLayers = project->mapThemeCollection()->mapThemeVisibleLayers( mapTheme );
      for ( const QgsMapLayer *l : constLayers )
      {
        // only copy vector layers as other layer types aren't actors in the labeling process
        if ( l->type() == Qgis::LayerType::Vector )
          mMapLayers.push_back( l->clone() );
      }
      mMapThemeStyleOverrides = project->mapThemeCollection()->mapThemeStyleOverrides( mapTheme );
    }
  }
 
  if ( project && mMapLayers.isEmpty() )
  {
    QList<QgsMapLayer *> layers;
    QgsLayerTree *root = project->layerTreeRoot();
    const QList<QgsLayerTreeLayer *> layerTreeLayers = root->findLayers();
    layers.reserve( layerTreeLayers.size() );
    for ( QgsLayerTreeLayer *nodeLayer : layerTreeLayers )
    {
      QgsMapLayer *layer = nodeLayer->layer();
      if ( nodeLayer->isVisible() && root->layerOrder().contains( layer ) )
        layers << layer;
    }
 
    for ( const QgsMapLayer *l : std::as_const( layers ) )
    {
      if ( l->type() == Qgis::LayerType::Vector )
        mMapLayers.push_back( l->clone() );
    }
  }
 
  for ( const QgsMapLayer *l : std::as_const( mMapLayers ) )
  {
    mMapLayerNames.insert( l->id(), l->name() );
  }
 
  mCrs = parameterAsExtentCrs( parameters, u"EXTENT"_s, context );
  if ( project && !mCrs.isValid() )
    mCrs = project->crs();
 
  bool includeUnplaced = parameterAsBoolean( parameters, u"INCLUDE_UNPLACED"_s, context );
  mLabelSettings = project ? project->labelingEngineSettings() : QgsLabelingEngineSettings();
  mLabelSettings.setFlag( Qgis::LabelingFlag::DrawUnplacedLabels, includeUnplaced );
  mLabelSettings.setFlag( Qgis::LabelingFlag::CollectUnplacedLabels, includeUnplaced );
 
  if ( project )
  {
    mScaleMethod = project->scaleMethod();
  }
 
  return true;
}