/******************************************************************************
 *
 * Project:  GeoTIFF Driver
 * Purpose:  Code to build overviews of external databases as a TIFF file.
 *           Only used by the GDALDefaultOverviews::BuildOverviews() method.
 * Author:   Frank Warmerdam, warmerdam@pobox.com
 *
 ******************************************************************************
 * Copyright (c) 2000, Frank Warmerdam
 * Copyright (c) 2008-2012, Even Rouault <even dot rouault at spatialys.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 ****************************************************************************/

#include "cpl_port.h"

#include "gt_overview.h"

#include <cstdlib>
#include <cstring>

#include <algorithm>
#include <string>

#include "cpl_conv.h"
#include "cpl_error.h"
#include "cpl_progress.h"
#include "cpl_string.h"
#include "cpl_vsi.h"
#include "gdal.h"
#include "gdal_priv.h"
#include "gtiff.h"
#include "tiff.h"
#include "tiffvers.h"
#include "tifvsi.h"
#include "xtiffio.h"

// TODO(schwehr): Explain why 128 and not 127.
constexpr int knMaxOverviews = 128;

#if TIFFLIB_VERSION > 20181110  // > 4.0.10
#define SUPPORTS_GET_OFFSET_BYTECOUNT
#endif

/************************************************************************/
/*                         GTIFFWriteDirectory()                        */
/*                                                                      */
/*      Create a new directory, without any image data for an overview  */
/*      or a mask                                                       */
/*      Returns offset of newly created directory, but the              */
/*      current directory is reset to be the one in used when this      */
/*      function is called.                                             */
/************************************************************************/

toff_t GTIFFWriteDirectory(TIFF *hTIFF, int nSubfileType, int nXSize,
                           int nYSize, int nBitsPerPixel, int nPlanarConfig,
                           int nSamples, int nBlockXSize, int nBlockYSize,
                           int bTiled, int nCompressFlag, int nPhotometric,
                           int nSampleFormat, int nPredictor,
                           unsigned short *panRed, unsigned short *panGreen,
                           unsigned short *panBlue, int nExtraSamples,
                           unsigned short *panExtraSampleValues,
                           const char *pszMetadata, const char *pszJPEGQuality,
                           const char *pszJPEGTablesMode, const char *pszNoData,
                           const uint32_t *panLercAddCompressionAndVersion,
                           bool bDeferStrileArrayWriting)

{
    const toff_t nBaseDirOffset = TIFFCurrentDirOffset(hTIFF);

    // This is a bit of a hack to cause (*tif->tif_cleanup)(tif); to be called.
    // See https://trac.osgeo.org/gdal/ticket/2055
    TIFFSetField(hTIFF, TIFFTAG_COMPRESSION, COMPRESSION_NONE);
    TIFFFreeDirectory(hTIFF);

    TIFFCreateDirectory(hTIFF);

    /* -------------------------------------------------------------------- */
    /*      Setup TIFF fields.                                              */
    /* -------------------------------------------------------------------- */
    TIFFSetField(hTIFF, TIFFTAG_IMAGEWIDTH, nXSize);
    TIFFSetField(hTIFF, TIFFTAG_IMAGELENGTH, nYSize);
    if (nSamples == 1)
        TIFFSetField(hTIFF, TIFFTAG_PLANARCONFIG, PLANARCONFIG_CONTIG);
    else
        TIFFSetField(hTIFF, TIFFTAG_PLANARCONFIG, nPlanarConfig);

    TIFFSetField(hTIFF, TIFFTAG_BITSPERSAMPLE, nBitsPerPixel);
    TIFFSetField(hTIFF, TIFFTAG_SAMPLESPERPIXEL, nSamples);
    TIFFSetField(hTIFF, TIFFTAG_COMPRESSION, nCompressFlag);
    TIFFSetField(hTIFF, TIFFTAG_PHOTOMETRIC, nPhotometric);
    TIFFSetField(hTIFF, TIFFTAG_SAMPLEFORMAT, nSampleFormat);

    if (bTiled)
    {
        TIFFSetField(hTIFF, TIFFTAG_TILEWIDTH, nBlockXSize);
        TIFFSetField(hTIFF, TIFFTAG_TILELENGTH, nBlockYSize);
    }
    else
    {
        TIFFSetField(hTIFF, TIFFTAG_ROWSPERSTRIP, nBlockYSize);
    }

    TIFFSetField(hTIFF, TIFFTAG_SUBFILETYPE, nSubfileType);

    if (panExtraSampleValues != nullptr)
    {
        TIFFSetField(hTIFF, TIFFTAG_EXTRASAMPLES, nExtraSamples,
                     panExtraSampleValues);
    }

    if (GTIFFSupportsPredictor(nCompressFlag))
        TIFFSetField(hTIFF, TIFFTAG_PREDICTOR, nPredictor);

    /* -------------------------------------------------------------------- */
    /*      Write color table if one is present.                            */
    /* -------------------------------------------------------------------- */
    if (panRed != nullptr)
    {
        TIFFSetField(hTIFF, TIFFTAG_COLORMAP, panRed, panGreen, panBlue);
    }

    /* -------------------------------------------------------------------- */
    /*      Write metadata if we have some.                                 */
    /* -------------------------------------------------------------------- */
    if (pszMetadata && strlen(pszMetadata) > 0)
        TIFFSetField(hTIFF, TIFFTAG_GDAL_METADATA, pszMetadata);

    /* -------------------------------------------------------------------- */
    /*      Write JPEG tables if needed.                                    */
    /* -------------------------------------------------------------------- */
    if (nCompressFlag == COMPRESSION_JPEG)
    {
        GTiffWriteJPEGTables(hTIFF,
                             (nPhotometric == PHOTOMETRIC_RGB) ? "RGB"
                             : (nPhotometric == PHOTOMETRIC_YCBCR)
                                 ? "YCBCR"
                                 : "MINISBLACK",
                             pszJPEGQuality, pszJPEGTablesMode);

        if (nPhotometric == PHOTOMETRIC_YCBCR)
        {
            // Explicitly register the subsampling so that JPEGFixupTags
            // is a no-op (helps for cloud optimized geotiffs)
            TIFFSetField(hTIFF, TIFFTAG_YCBCRSUBSAMPLING, 2, 2);
        }
    }

    if (nCompressFlag == COMPRESSION_LERC && panLercAddCompressionAndVersion)
    {
        TIFFSetField(hTIFF, TIFFTAG_LERC_PARAMETERS, 2,
                     panLercAddCompressionAndVersion);
    }

    /* -------------------------------------------------------------------- */
    /*      Write no data value if we have one.                             */
    /* -------------------------------------------------------------------- */
    if (pszNoData != nullptr)
    {
        TIFFSetField(hTIFF, TIFFTAG_GDAL_NODATA, pszNoData);
    }

    if (bDeferStrileArrayWriting)
    {
#ifdef SUPPORTS_GET_OFFSET_BYTECOUNT
        TIFFDeferStrileArrayWriting(hTIFF);
#endif
    }

    /* -------------------------------------------------------------------- */
    /*      Write directory, and return byte offset.                        */
    /* -------------------------------------------------------------------- */
    if (TIFFWriteCheck(hTIFF, bTiled, "GTIFFWriteDirectory") == 0)
    {
        TIFFSetSubDirectory(hTIFF, nBaseDirOffset);
        return 0;
    }

    TIFFWriteDirectory(hTIFF);
    TIFFSetDirectory(hTIFF,
                     static_cast<tdir_t>(TIFFNumberOfDirectories(hTIFF) - 1));

    const toff_t nOffset = TIFFCurrentDirOffset(hTIFF);

    TIFFSetSubDirectory(hTIFF, nBaseDirOffset);

    return nOffset;
}

/************************************************************************/
/*                     GTIFFBuildOverviewMetadata()                     */
/************************************************************************/

void GTIFFBuildOverviewMetadata(const char *pszResampling,
                                GDALDataset *poBaseDS, CPLString &osMetadata)

{
    osMetadata = "<GDALMetadata>";

    if (pszResampling && STARTS_WITH_CI(pszResampling, "AVERAGE_BIT2"))
        osMetadata += "<Item name=\"RESAMPLING\" sample=\"0\">"
                      "AVERAGE_BIT2GRAYSCALE</Item>";

    if (poBaseDS->GetMetadataItem("INTERNAL_MASK_FLAGS_1"))
    {
        for (int iBand = 0; iBand < 200; iBand++)
        {
            CPLString osItem;
            CPLString osName;

            osName.Printf("INTERNAL_MASK_FLAGS_%d", iBand + 1);
            if (poBaseDS->GetMetadataItem(osName))
            {
                osItem.Printf("<Item name=\"%s\">%s</Item>", osName.c_str(),
                              poBaseDS->GetMetadataItem(osName));
                osMetadata += osItem;
            }
        }
    }

    const char *pszNoDataValues = poBaseDS->GetMetadataItem("NODATA_VALUES");
    if (pszNoDataValues)
    {
        CPLString osItem;
        osItem.Printf("<Item name=\"NODATA_VALUES\">%s</Item>",
                      pszNoDataValues);
        osMetadata += osItem;
    }

    if (!EQUAL(osMetadata, "<GDALMetadata>"))
        osMetadata += "</GDALMetadata>";
    else
        osMetadata = "";
}

/************************************************************************/
/*                      GTIFFGetMaxColorChannels()                      */
/************************************************************************/

/*
 * Return the maximum number of color channels specified for a given photometric
 * type. 0 is returned if photometric type isn't supported or no default value
 * is defined by the specification.
 */
static int GTIFFGetMaxColorChannels(int photometric)
{
    switch (photometric)
    {
        case PHOTOMETRIC_PALETTE:
        case PHOTOMETRIC_MINISWHITE:
        case PHOTOMETRIC_MINISBLACK:
            return 1;
        case PHOTOMETRIC_YCBCR:
        case PHOTOMETRIC_RGB:
        case PHOTOMETRIC_CIELAB:
        case PHOTOMETRIC_LOGLUV:
        case PHOTOMETRIC_ITULAB:
        case PHOTOMETRIC_ICCLAB:
            return 3;
        case PHOTOMETRIC_SEPARATED:
        case PHOTOMETRIC_MASK:
            return 4;
        case PHOTOMETRIC_LOGL:
        default:
            return 0;
    }
}

/************************************************************************/
/*                        GTIFFBuildOverviews()                         */
/************************************************************************/

CPLErr GTIFFBuildOverviews(const char *pszFilename, int nBands,
                           GDALRasterBand *const *papoBandList, int nOverviews,
                           const int *panOverviewList,
                           const char *pszResampling,
                           GDALProgressFunc pfnProgress, void *pProgressData,
                           CSLConstList papszOptions)

{
    return GTIFFBuildOverviewsEx(pszFilename, nBands, papoBandList, nOverviews,
                                 panOverviewList, nullptr, pszResampling,
                                 papszOptions, pfnProgress, pProgressData);
}

CPLErr GTIFFBuildOverviewsEx(const char *pszFilename, int nBands,
                             GDALRasterBand *const *papoBandList,
                             int nOverviews, const int *panOverviewList,
                             const std::pair<int, int> *pasOverviewSize,
                             const char *pszResampling,
                             const char *const *papszOptions,
                             GDALProgressFunc pfnProgress, void *pProgressData)
{
    if (nBands == 0 || nOverviews == 0)
        return CE_None;

    CPLAssert((panOverviewList != nullptr) ^ (pasOverviewSize != nullptr));

    GTiffOneTimeInit();

    TIFF *hOTIFF = nullptr;
    int nBitsPerPixel = 0;
    int nCompression = COMPRESSION_NONE;
    uint16_t nPhotometric = 0;
    int nSampleFormat = 0;
    uint16_t nPlanarConfig = 0;
    int iOverview = 0;
    int nXSize = 0;
    int nYSize = 0;

    /* -------------------------------------------------------------------- */
    /*      Verify that the list of bands is suitable for emitting in       */
    /*      TIFF file.                                                      */
    /* -------------------------------------------------------------------- */
    for (int iBand = 0; iBand < nBands; iBand++)
    {
        int nBandBits = 0;
        int nBandFormat = 0;
        GDALRasterBand *hBand = papoBandList[iBand];

        switch (hBand->GetRasterDataType())
        {
            case GDT_Byte:
                nBandBits = 8;
                nBandFormat = SAMPLEFORMAT_UINT;
                break;

            case GDT_Int8:
                nBandBits = 8;
                nBandFormat = SAMPLEFORMAT_INT;
                break;

            case GDT_UInt16:
                nBandBits = 16;
                nBandFormat = SAMPLEFORMAT_UINT;
                break;

            case GDT_Int16:
                nBandBits = 16;
                nBandFormat = SAMPLEFORMAT_INT;
                break;

            case GDT_UInt32:
                nBandBits = 32;
                nBandFormat = SAMPLEFORMAT_UINT;
                break;

            case GDT_Int32:
                nBandBits = 32;
                nBandFormat = SAMPLEFORMAT_INT;
                break;

            case GDT_UInt64:
                nBandBits = 64;
                nBandFormat = SAMPLEFORMAT_UINT;
                break;

            case GDT_Int64:
                nBandBits = 64;
                nBandFormat = SAMPLEFORMAT_INT;
                break;

            case GDT_Float32:
                nBandBits = 32;
                nBandFormat = SAMPLEFORMAT_IEEEFP;
                break;

            case GDT_Float64:
                nBandBits = 64;
                nBandFormat = SAMPLEFORMAT_IEEEFP;
                break;

            case GDT_CInt16:
                nBandBits = 32;
                nBandFormat = SAMPLEFORMAT_COMPLEXINT;
                break;

            case GDT_CInt32:
                nBandBits = 64;
                nBandFormat = SAMPLEFORMAT_COMPLEXINT;
                break;

            case GDT_CFloat32:
                nBandBits = 64;
                nBandFormat = SAMPLEFORMAT_COMPLEXIEEEFP;
                break;

            case GDT_CFloat64:
                nBandBits = 128;
                nBandFormat = SAMPLEFORMAT_COMPLEXIEEEFP;
                break;

            case GDT_Unknown:
            case GDT_TypeCount:
                CPLAssert(false);
                return CE_Failure;
        }

        if (hBand->GetMetadataItem("NBITS", "IMAGE_STRUCTURE"))
        {
            nBandBits =
                atoi(hBand->GetMetadataItem("NBITS", "IMAGE_STRUCTURE"));

            if (nBandBits == 1 && STARTS_WITH_CI(pszResampling, "AVERAGE_BIT2"))
                nBandBits = 8;
        }

        if (iBand == 0)
        {
            nBitsPerPixel = nBandBits;
            nSampleFormat = nBandFormat;
            nXSize = hBand->GetXSize();
            nYSize = hBand->GetYSize();
        }
        else if (nBitsPerPixel != nBandBits || nSampleFormat != nBandFormat)
        {
            CPLError(CE_Failure, CPLE_NotSupported,
                     "GTIFFBuildOverviews() doesn't support a mixture of band"
                     " data types.");
            return CE_Failure;
        }
        else if (hBand->GetColorTable() != nullptr)
        {
            CPLError(CE_Failure, CPLE_NotSupported,
                     "GTIFFBuildOverviews() doesn't support building"
                     " overviews of multiple colormapped bands.");
            return CE_Failure;
        }
        else if (hBand->GetXSize() != nXSize || hBand->GetYSize() != nYSize)
        {
            CPLError(CE_Failure, CPLE_NotSupported,
                     "GTIFFBuildOverviews() doesn't support building"
                     " overviews of different sized bands.");
            return CE_Failure;
        }
    }

    const auto GetOptionValue =
        [papszOptions](const char *pszOptionKey, const char *pszConfigOptionKey,
                       const char **ppszKeyUsed = nullptr)
    {
        const char *pszVal = CSLFetchNameValue(papszOptions, pszOptionKey);
        if (pszVal)
        {
            if (ppszKeyUsed)
                *ppszKeyUsed = pszOptionKey;
            return pszVal;
        }
        pszVal = CPLGetConfigOption(pszConfigOptionKey, nullptr);
        if (pszVal && ppszKeyUsed)
            *ppszKeyUsed = pszConfigOptionKey;
        return pszVal;
    };

    /* -------------------------------------------------------------------- */
    /*      Use specified compression method.                               */
    /* -------------------------------------------------------------------- */
    const char *pszCompressKey = "";
    const char *pszCompress =
        GetOptionValue("COMPRESS", "COMPRESS_OVERVIEW", &pszCompressKey);

    if (pszCompress != nullptr && pszCompress[0] != '\0')
    {
        nCompression = GTIFFGetCompressionMethod(pszCompress, pszCompressKey);
        if (nCompression < 0)
            return CE_Failure;
    }

    if (nCompression == COMPRESSION_JPEG && nBitsPerPixel > 8)
    {
        if (nBitsPerPixel > 16)
        {
            CPLError(CE_Failure, CPLE_NotSupported,
                     "GTIFFBuildOverviews() doesn't support building"
                     " JPEG compressed overviews of nBitsPerPixel > 16.");
            return CE_Failure;
        }

        nBitsPerPixel = 12;
    }

    /* -------------------------------------------------------------------- */
    /*      Figure out the planar configuration to use.                     */
    /* -------------------------------------------------------------------- */
    if (nBands == 1)
        nPlanarConfig = PLANARCONFIG_CONTIG;
    else
        nPlanarConfig = PLANARCONFIG_SEPARATE;

    bool bSourceIsPixelInterleaved = false;
    bool bSourceIsJPEG2000 = false;
    if (nBands > 1)
    {
        GDALDataset *poSrcDS = papoBandList[0]->GetDataset();
        if (poSrcDS)
        {
            const char *pszSrcInterleave =
                poSrcDS->GetMetadataItem("INTERLEAVE", "IMAGE_STRUCTURE");
            if (pszSrcInterleave && EQUAL(pszSrcInterleave, "PIXEL"))
            {
                bSourceIsPixelInterleaved = true;
            }
        }

        const char *pszSrcCompression =
            papoBandList[0]->GetMetadataItem("COMPRESSION", "IMAGE_STRUCTURE");
        if (pszSrcCompression)
        {
            bSourceIsJPEG2000 = EQUAL(pszSrcCompression, "JPEG2000");
        }
        if (bSourceIsPixelInterleaved && bSourceIsJPEG2000)
        {
            nPlanarConfig = PLANARCONFIG_CONTIG;
        }
        else if (nCompression == COMPRESSION_WEBP)
        {
            nPlanarConfig = PLANARCONFIG_CONTIG;
        }
    }

    const char *pszInterleave =
        GetOptionValue("INTERLEAVE", "INTERLEAVE_OVERVIEW");
    if (pszInterleave != nullptr && pszInterleave[0] != '\0')
    {
        if (EQUAL(pszInterleave, "PIXEL"))
            nPlanarConfig = PLANARCONFIG_CONTIG;
        else if (EQUAL(pszInterleave, "BAND"))
            nPlanarConfig = PLANARCONFIG_SEPARATE;
        else
        {
            CPLError(CE_Failure, CPLE_AppDefined,
                     "INTERLEAVE_OVERVIEW=%s unsupported, "
                     "value must be PIXEL or BAND. ignoring",
                     pszInterleave);
        }
    }

    /* -------------------------------------------------------------------- */
    /*      Figure out the photometric interpretation to use.               */
    /* -------------------------------------------------------------------- */
    if (nBands == 3)
        nPhotometric = PHOTOMETRIC_RGB;
    else if (papoBandList[0]->GetColorTable() != nullptr &&
             (papoBandList[0]->GetRasterDataType() == GDT_Byte ||
              papoBandList[0]->GetRasterDataType() == GDT_UInt16) &&
             !STARTS_WITH_CI(pszResampling, "AVERAGE_BIT2"))
    {
        nPhotometric = PHOTOMETRIC_PALETTE;
        // Should set the colormap up at this point too!
    }
    else if (nBands >= 3 &&
             papoBandList[0]->GetColorInterpretation() == GCI_RedBand &&
             papoBandList[1]->GetColorInterpretation() == GCI_GreenBand &&
             papoBandList[2]->GetColorInterpretation() == GCI_BlueBand)
    {
        nPhotometric = PHOTOMETRIC_RGB;
    }
    else
        nPhotometric = PHOTOMETRIC_MINISBLACK;

    const char *pszOptionKey = "";
    const char *pszPhotometric =
        GetOptionValue("PHOTOMETRIC", "PHOTOMETRIC_OVERVIEW", &pszOptionKey);
    if (!GTIFFUpdatePhotometric(pszPhotometric, pszOptionKey, nCompression,
                                pszInterleave, nBands, nPhotometric,
                                nPlanarConfig))
    {
        return CE_Failure;
    }

    /* -------------------------------------------------------------------- */
    /*      Figure out the predictor value to use.                          */
    /* -------------------------------------------------------------------- */
    int nPredictor = PREDICTOR_NONE;
    if (GTIFFSupportsPredictor(nCompression))
    {
        const char *pszPredictor =
            GetOptionValue("PREDICTOR", "PREDICTOR_OVERVIEW");
        if (pszPredictor != nullptr)
        {
            nPredictor = atoi(pszPredictor);
        }
    }

    /* -------------------------------------------------------------------- */
    /*      Create the file, if it does not already exist.                  */
    /* -------------------------------------------------------------------- */
    VSIStatBufL sStatBuf;
    VSILFILE *fpL = nullptr;

    bool bCreateBigTIFF = false;
    if (VSIStatExL(pszFilename, &sStatBuf, VSI_STAT_EXISTS_FLAG) != 0)
    {
        /* --------------------------------------------------------------------
         */
        /*      Compute the uncompressed size. */
        /* --------------------------------------------------------------------
         */
        double dfUncompressedOverviewSize = 0;
        int nDataTypeSize =
            GDALGetDataTypeSizeBytes(papoBandList[0]->GetRasterDataType());

        for (iOverview = 0; iOverview < nOverviews; iOverview++)
        {
            const int nOXSize =
                panOverviewList ? (nXSize + panOverviewList[iOverview] - 1) /
                                      panOverviewList[iOverview]
                                :
                                // cppcheck-suppress nullPointer
                    pasOverviewSize[iOverview].first;
            const int nOYSize =
                panOverviewList ? (nYSize + panOverviewList[iOverview] - 1) /
                                      panOverviewList[iOverview]
                                :
                                // cppcheck-suppress nullPointer
                    pasOverviewSize[iOverview].second;

            dfUncompressedOverviewSize +=
                nOXSize * static_cast<double>(nOYSize) * nBands * nDataTypeSize;
        }

        /* --------------------------------------------------------------------
         */
        /*      Should the file be created as a bigtiff file? */
        /* --------------------------------------------------------------------
         */
        const char *pszBIGTIFF = GetOptionValue("BIGTIFF", "BIGTIFF_OVERVIEW");

        if (pszBIGTIFF == nullptr)
            pszBIGTIFF = "IF_SAFER";

        if (EQUAL(pszBIGTIFF, "IF_NEEDED"))
        {
            if (nCompression == COMPRESSION_NONE &&
                dfUncompressedOverviewSize > 4200000000.0)
                bCreateBigTIFF = true;
        }
        else if (EQUAL(pszBIGTIFF, "IF_SAFER"))
        {
            // Look at the size of the base image and suppose that
            // the added overview levels won't be more than 1/2 of
            // the size of the base image. The theory says 1/3 of the
            // base image size if the overview levels are 2, 4, 8, 16.
            // Thus take 1/2 as the security margin for 1/3.
            const double dfUncompressedImageSize =
                nXSize * static_cast<double>(nYSize) * nBands * nDataTypeSize;
            if (dfUncompressedImageSize * 0.5 > 4200000000.0)
                bCreateBigTIFF = true;
        }
        else
        {
            bCreateBigTIFF = CPLTestBool(pszBIGTIFF);
            if (!bCreateBigTIFF && nCompression == COMPRESSION_NONE &&
                dfUncompressedOverviewSize > 4200000000.0)
            {
                CPLError(CE_Failure, CPLE_NotSupported,
                         "The overview file will be larger than 4GB, "
                         "so BigTIFF is necessary.  "
                         "Creation failed.");
                return CE_Failure;
            }
        }

        if (bCreateBigTIFF)
            CPLDebug("GTiff", "File being created as a BigTIFF.");

        fpL = VSIFOpenL(pszFilename, "w+");
        if (fpL == nullptr)
            hOTIFF = nullptr;
        else
            hOTIFF =
                VSI_TIFFOpen(pszFilename, bCreateBigTIFF ? "w+8" : "w+", fpL);
        if (hOTIFF == nullptr)
        {
            if (CPLGetLastErrorNo() == 0)
                CPLError(CE_Failure, CPLE_OpenFailed,
                         "Attempt to create new tiff file `%s' "
                         "failed in VSI_TIFFOpen().",
                         pszFilename);
            if (fpL != nullptr)
                CPL_IGNORE_RET_VAL(VSIFCloseL(fpL));
            return CE_Failure;
        }
    }
    /* -------------------------------------------------------------------- */
    /*      Otherwise just open it for update access.                       */
    /* -------------------------------------------------------------------- */
    else
    {
        fpL = VSIFOpenL(pszFilename, "r+");
        if (fpL == nullptr)
            hOTIFF = nullptr;
        else
        {
            GByte abyBuffer[4] = {0};
            VSIFReadL(abyBuffer, 1, 4, fpL);
            VSIFSeekL(fpL, 0, SEEK_SET);
            bCreateBigTIFF = abyBuffer[2] == 43 || abyBuffer[3] == 43;
            hOTIFF = VSI_TIFFOpen(pszFilename, "r+", fpL);
        }
        if (hOTIFF == nullptr)
        {
            if (CPLGetLastErrorNo() == 0)
                CPLError(CE_Failure, CPLE_OpenFailed,
                         "Attempt to create new tiff file `%s' "
                         "failed in VSI_TIFFOpen().",
                         pszFilename);
            if (fpL != nullptr)
                CPL_IGNORE_RET_VAL(VSIFCloseL(fpL));
            return CE_Failure;
        }
    }

    /* -------------------------------------------------------------------- */
    /*      Do we have a palette?  If so, create a TIFF compatible version. */
    /* -------------------------------------------------------------------- */
    unsigned short *panRed = nullptr;
    unsigned short *panGreen = nullptr;
    unsigned short *panBlue = nullptr;

    if (nPhotometric == PHOTOMETRIC_PALETTE)
    {
        GDALColorTable *poCT = papoBandList[0]->GetColorTable();
        int nColorCount = 65536;

        if (nBitsPerPixel <= 8)
            nColorCount = 256;

        panRed = static_cast<unsigned short *>(
            CPLCalloc(nColorCount, sizeof(unsigned short)));
        panGreen = static_cast<unsigned short *>(
            CPLCalloc(nColorCount, sizeof(unsigned short)));
        panBlue = static_cast<unsigned short *>(
            CPLCalloc(nColorCount, sizeof(unsigned short)));

        for (int iColor = 0; iColor < nColorCount; iColor++)
        {
            GDALColorEntry sRGB = {0, 0, 0, 0};

            if (poCT->GetColorEntryAsRGB(iColor, &sRGB))
            {
                // TODO(schwehr): Check for underflow.
                // Going from signed short to unsigned short.
                panRed[iColor] = static_cast<unsigned short>(257 * sRGB.c1);
                panGreen[iColor] = static_cast<unsigned short>(257 * sRGB.c2);
                panBlue[iColor] = static_cast<unsigned short>(257 * sRGB.c3);
            }
        }
    }

    /* -------------------------------------------------------------------- */
    /*      Do we need some metadata for the overviews?                     */
    /* -------------------------------------------------------------------- */
    CPLString osMetadata;
    GDALDataset *poBaseDS = papoBandList[0]->GetDataset();
    if (poBaseDS)
    {
        GTIFFBuildOverviewMetadata(pszResampling, poBaseDS, osMetadata);
    }

    if (poBaseDS != nullptr && poBaseDS->GetRasterCount() == nBands)
    {
        const bool bStandardColorInterp = GTIFFIsStandardColorInterpretation(
            GDALDataset::ToHandle(poBaseDS),
            static_cast<uint16_t>(nPhotometric), nullptr);
        if (!bStandardColorInterp)
        {
            if (osMetadata.size() >= strlen("</GDALMetadata>") &&
                osMetadata.substr(osMetadata.size() -
                                  strlen("</GDALMetadata>")) ==
                    "</GDALMetadata>")
            {
                osMetadata.resize(osMetadata.size() -
                                  strlen("</GDALMetadata>"));
            }
            else
            {
                CPLAssert(osMetadata.empty());
                osMetadata = "<GDALMetadata>";
            }
            for (int i = 0; i < poBaseDS->GetRasterCount(); ++i)
            {
                const GDALColorInterp eInterp =
                    poBaseDS->GetRasterBand(i + 1)->GetColorInterpretation();
                osMetadata +=
                    CPLSPrintf("<Item sample=\"%d\" name=\"COLORINTERP\" "
                               "role=\"colorinterp\">",
                               i);
                osMetadata += GDALGetColorInterpretationName(eInterp);
                osMetadata += "</Item>";
            }
            osMetadata += "</GDALMetadata>";
        }
    }

    /* -------------------------------------------------------------------- */
    /*      Loop, creating overviews.                                       */
    /* -------------------------------------------------------------------- */
    int nOvrBlockXSize = 0;
    int nOvrBlockYSize = 0;
    GTIFFGetOverviewBlockSize(papoBandList[0], &nOvrBlockXSize,
                              &nOvrBlockYSize);

    CPLString osNoData;  // don't move this in inner scope
    const char *pszNoData = nullptr;
    int bNoDataSet = FALSE;
    const double dfNoDataValue = papoBandList[0]->GetNoDataValue(&bNoDataSet);
    if (bNoDataSet)
    {
        osNoData = GTiffFormatGDALNoDataTagValue(dfNoDataValue);
        pszNoData = osNoData.c_str();
    }

    std::vector<uint16_t> anExtraSamples;
    for (int i = GTIFFGetMaxColorChannels(nPhotometric) + 1; i <= nBands; i++)
    {
        if (papoBandList[i - 1]->GetColorInterpretation() == GCI_AlphaBand)
        {
            anExtraSamples.push_back(GTiffGetAlphaValue(
                GetOptionValue("ALPHA", "GTIFF_ALPHA"), DEFAULT_ALPHA_TYPE));
        }
        else
        {
            anExtraSamples.push_back(EXTRASAMPLE_UNSPECIFIED);
        }
    }

    const uint32_t *panLercAddCompressionAndVersion = nullptr;
    uint32_t anLercAddCompressionAndVersion[2] = {LERC_VERSION_2_4,
                                                  LERC_ADD_COMPRESSION_NONE};
    if (pszCompress && EQUAL(pszCompress, "LERC_DEFLATE"))
    {
        anLercAddCompressionAndVersion[1] = LERC_ADD_COMPRESSION_DEFLATE;
        panLercAddCompressionAndVersion = anLercAddCompressionAndVersion;
    }
    else if (pszCompress && EQUAL(pszCompress, "LERC_ZSTD"))
    {
        anLercAddCompressionAndVersion[1] = LERC_ADD_COMPRESSION_ZSTD;
        panLercAddCompressionAndVersion = anLercAddCompressionAndVersion;
    }

    for (iOverview = 0; iOverview < nOverviews; iOverview++)
    {
        const int nOXSize = panOverviewList
                                ? (nXSize + panOverviewList[iOverview] - 1) /
                                      panOverviewList[iOverview]
                                :
                                // cppcheck-suppress nullPointer
                                pasOverviewSize[iOverview].first;
        const int nOYSize = panOverviewList
                                ? (nYSize + panOverviewList[iOverview] - 1) /
                                      panOverviewList[iOverview]
                                :
                                // cppcheck-suppress nullPointer
                                pasOverviewSize[iOverview].second;

        unsigned nTileXCount = DIV_ROUND_UP(nOXSize, nOvrBlockXSize);
        unsigned nTileYCount = DIV_ROUND_UP(nOYSize, nOvrBlockYSize);
        // libtiff implementation limitation
        if (nTileXCount > 0x80000000U / (bCreateBigTIFF ? 8 : 4) / nTileYCount)
        {
            CPLError(CE_Failure, CPLE_NotSupported,
                     "File too large regarding tile size. This would result "
                     "in a file with tile arrays larger than 2GB");
            XTIFFClose(hOTIFF);
            VSIFCloseL(fpL);
            return CE_Failure;
        }

        if (GTIFFWriteDirectory(
                hOTIFF, FILETYPE_REDUCEDIMAGE, nOXSize, nOYSize, nBitsPerPixel,
                nPlanarConfig, nBands, nOvrBlockXSize, nOvrBlockYSize, TRUE,
                nCompression, nPhotometric, nSampleFormat, nPredictor, panRed,
                panGreen, panBlue, static_cast<int>(anExtraSamples.size()),
                anExtraSamples.empty() ? nullptr : anExtraSamples.data(),
                osMetadata,
                GetOptionValue("JPEG_QUALITY", "JPEG_QUALITY_OVERVIEW"),
                GetOptionValue("JPEG_TABLESMODE", "JPEG_TABLESMODE_OVERVIEW"),
                pszNoData, panLercAddCompressionAndVersion, false) == 0)
        {
            XTIFFClose(hOTIFF);
            VSIFCloseL(fpL);
            return CE_Failure;
        }
    }

    if (panRed)
    {
        CPLFree(panRed);
        CPLFree(panGreen);
        CPLFree(panBlue);
        panRed = nullptr;
        panGreen = nullptr;
        panBlue = nullptr;
    }

    XTIFFClose(hOTIFF);
    if (VSIFCloseL(fpL) != 0)
        return CE_Failure;
    fpL = nullptr;

    /* -------------------------------------------------------------------- */
    /*      Open the overview dataset so that we can get at the overview    */
    /*      bands.                                                          */
    /* -------------------------------------------------------------------- */
    CPLStringList aosOpenOptions;
    aosOpenOptions.SetNameValue("NUM_THREADS",
                                CSLFetchNameValue(papszOptions, "NUM_THREADS"));
    aosOpenOptions.SetNameValue(
        "SPARSE_OK", GetOptionValue("SPARSE_OK", "SPARSE_OK_OVERVIEW"));
    aosOpenOptions.SetNameValue(
        "@MASK_OVERVIEW_DATASET",
        CSLFetchNameValue(papszOptions, "MASK_OVERVIEW_DATASET"));
    GDALDataset *hODS =
        GDALDataset::Open(pszFilename, GDAL_OF_RASTER | GDAL_OF_UPDATE, nullptr,
                          aosOpenOptions.List());
    if (hODS == nullptr)
        return CE_Failure;

    /* -------------------------------------------------------------------- */
    /*      Do we need to set the jpeg quality?                             */
    /* -------------------------------------------------------------------- */
    TIFF *hTIFF = static_cast<TIFF *>(hODS->GetInternalHandle(nullptr));

    const char *pszJPEGQuality =
        GetOptionValue("JPEG_QUALITY", "JPEG_QUALITY_OVERVIEW");
    if (nCompression == COMPRESSION_JPEG && pszJPEGQuality != nullptr)
    {
        const int nJpegQuality = atoi(pszJPEGQuality);
        TIFFSetField(hTIFF, TIFFTAG_JPEGQUALITY, nJpegQuality);
        GTIFFSetJpegQuality(GDALDataset::ToHandle(hODS), nJpegQuality);
    }

    const char *pszWebpLevel =
        GetOptionValue("WEBP_LEVEL", "WEBP_LEVEL_OVERVIEW");
    if (nCompression == COMPRESSION_WEBP && pszWebpLevel != nullptr)
    {
        const int nWebpLevel = atoi(pszWebpLevel);
        if (nWebpLevel >= 1)
        {
            TIFFSetField(hTIFF, TIFFTAG_WEBP_LEVEL, nWebpLevel);
            GTIFFSetWebPLevel(GDALDataset::ToHandle(hODS), nWebpLevel);
        }
    }

    const char *pszWebpLossless =
        GetOptionValue("WEBP_LOSSLESS", "WEBP_LOSSLESS_OVERVIEW");
    if (nCompression == COMPRESSION_WEBP && pszWebpLossless != nullptr)
    {
        const bool bWebpLossless = CPLTestBool(pszWebpLossless);
        TIFFSetField(hTIFF, TIFFTAG_WEBP_LOSSLESS,
                     static_cast<int>(bWebpLossless));
        GTIFFSetWebPLossless(GDALDataset::ToHandle(hODS), bWebpLossless);
    }

    const char *pszJPEGTablesMode =
        GetOptionValue("JPEG_TABLESMODE", "JPEG_TABLESMODE_OVERVIEW");
    if (nCompression == COMPRESSION_JPEG && pszJPEGTablesMode != nullptr)
    {
        const int nJpegTablesMode = atoi(pszJPEGTablesMode);
        TIFFSetField(hTIFF, TIFFTAG_JPEGTABLESMODE, nJpegTablesMode);
        GTIFFSetJpegTablesMode(GDALDataset::ToHandle(hODS), nJpegTablesMode);
    }

    const char *pszZLevel = GetOptionValue("ZLEVEL", "ZLEVEL_OVERVIEW");
    if ((nCompression == COMPRESSION_DEFLATE ||
         anLercAddCompressionAndVersion[1] == LERC_ADD_COMPRESSION_DEFLATE) &&
        pszZLevel != nullptr)
    {
        const int nZLevel = atoi(pszZLevel);
        if (nZLevel >= 1)
        {
            TIFFSetField(hTIFF, TIFFTAG_ZIPQUALITY, nZLevel);
            GTIFFSetZLevel(GDALDataset::ToHandle(hODS), nZLevel);
        }
    }

    const char *pszZSTDLevel =
        GetOptionValue("ZSTD_LEVEL", "ZSTD_LEVEL_OVERVIEW");
    if ((nCompression == COMPRESSION_ZSTD ||
         anLercAddCompressionAndVersion[1] == LERC_ADD_COMPRESSION_ZSTD) &&
        pszZSTDLevel != nullptr)
    {
        const int nZSTDLevel = atoi(pszZSTDLevel);
        if (nZSTDLevel >= 1)
        {
            TIFFSetField(hTIFF, TIFFTAG_ZSTD_LEVEL, nZSTDLevel);
            GTIFFSetZSTDLevel(GDALDataset::ToHandle(hODS), nZSTDLevel);
        }
    }

    const char *pszMaxZError =
        GetOptionValue("MAX_Z_ERROR", "MAX_Z_ERROR_OVERVIEW");
    if (nCompression == COMPRESSION_LERC && pszMaxZError != nullptr)
    {
        const double dfMaxZError = CPLAtof(pszMaxZError);
        if (dfMaxZError >= 0)
        {
            TIFFSetField(hTIFF, TIFFTAG_LERC_MAXZERROR, dfMaxZError);
            GTIFFSetMaxZError(GDALDataset::ToHandle(hODS), dfMaxZError);
        }
    }

    /* -------------------------------------------------------------------- */
    /*      Loop writing overview data.                                     */
    /* -------------------------------------------------------------------- */

    int *panOverviewListSorted = nullptr;
    if (panOverviewList)
    {
        panOverviewListSorted =
            static_cast<int *>(CPLMalloc(sizeof(int) * nOverviews));
        memcpy(panOverviewListSorted, panOverviewList,
               sizeof(int) * nOverviews);
        std::sort(panOverviewListSorted, panOverviewListSorted + nOverviews);
    }

    GTIFFSetThreadLocalInExternalOvr(true);

    CPLErr eErr = CE_None;

    // If we have an alpha band, we want it to be generated before downsampling
    // other bands
    bool bHasAlphaBand = false;
    for (int iBand = 0; iBand < nBands; iBand++)
    {
        if (papoBandList[iBand]->GetColorInterpretation() == GCI_AlphaBand)
            bHasAlphaBand = true;
    }

    const auto poColorTable = papoBandList[0]->GetColorTable();
    if (((((bSourceIsPixelInterleaved && bSourceIsJPEG2000) ||
           (nCompression != COMPRESSION_NONE)) &&
          nPlanarConfig == PLANARCONFIG_CONTIG) ||
         bHasAlphaBand) &&
        !GDALDataTypeIsComplex(papoBandList[0]->GetRasterDataType()) &&
        (poColorTable == nullptr || STARTS_WITH_CI(pszResampling, "NEAR") ||
         poColorTable->IsIdentity()) &&
        (STARTS_WITH_CI(pszResampling, "NEAR") ||
         EQUAL(pszResampling, "AVERAGE") || EQUAL(pszResampling, "RMS") ||
         EQUAL(pszResampling, "GAUSS") || EQUAL(pszResampling, "CUBIC") ||
         EQUAL(pszResampling, "CUBICSPLINE") ||
         EQUAL(pszResampling, "LANCZOS") || EQUAL(pszResampling, "BILINEAR") ||
         EQUAL(pszResampling, "MODE")))
    {
        // In the case of pixel interleaved compressed overviews, we want to
        // generate the overviews for all the bands block by block, and not
        // band after band, in order to write the block once and not loose
        // space in the TIFF file.
        GDALRasterBand ***papapoOverviewBands =
            static_cast<GDALRasterBand ***>(CPLCalloc(sizeof(void *), nBands));
        for (int iBand = 0; iBand < nBands && eErr == CE_None; iBand++)
        {
            GDALRasterBand *poSrcBand = papoBandList[iBand];
            GDALRasterBand *poDstBand = hODS->GetRasterBand(iBand + 1);
            papapoOverviewBands[iBand] = static_cast<GDALRasterBand **>(
                CPLCalloc(sizeof(void *), nOverviews));

            int bHasNoData = FALSE;
            const double noDataValue = poSrcBand->GetNoDataValue(&bHasNoData);
            if (bHasNoData)
                poDstBand->SetNoDataValue(noDataValue);
            std::vector<bool> abDstOverviewAssigned(
                1 + poDstBand->GetOverviewCount());

            for (int i = 0; i < nOverviews && eErr == CE_None; i++)
            {
                const bool bDegenerateOverview =
                    panOverviewListSorted != nullptr &&
                    (poSrcBand->GetXSize() >> panOverviewListSorted[i]) == 0 &&
                    (poSrcBand->GetYSize() >> panOverviewListSorted[i]) == 0;

                for (int j = -1;
                     j < poDstBand->GetOverviewCount() && eErr == CE_None; j++)
                {
                    if (abDstOverviewAssigned[1 + j])
                        continue;
                    GDALRasterBand *poOverview =
                        (j < 0) ? poDstBand : poDstBand->GetOverview(j);
                    if (poOverview == nullptr)
                    {
                        eErr = CE_Failure;
                        continue;
                    }

                    bool bMatch;
                    if (panOverviewListSorted)
                    {
                        const int nOvFactor = GDALComputeOvFactor(
                            poOverview->GetXSize(), poSrcBand->GetXSize(),
                            poOverview->GetYSize(), poSrcBand->GetYSize());

                        bMatch = nOvFactor == panOverviewListSorted[i] ||
                                 nOvFactor == GDALOvLevelAdjust2(
                                                  panOverviewListSorted[i],
                                                  poSrcBand->GetXSize(),
                                                  poSrcBand->GetYSize())
                                 // Deal with edge cases where overview levels
                                 // lead to degenerate 1x1 overviews
                                 || (bDegenerateOverview &&
                                     poOverview->GetXSize() == 1 &&
                                     poOverview->GetYSize() == 1);
                    }
                    else
                    {
                        bMatch = (
                            // cppcheck-suppress nullPointer
                            poOverview->GetXSize() ==
                                pasOverviewSize[i].first &&
                            // cppcheck-suppress nullPointer
                            poOverview->GetYSize() ==
                                pasOverviewSize[i].second);
                    }
                    if (bMatch)
                    {
                        abDstOverviewAssigned[j + 1] = true;
                        papapoOverviewBands[iBand][i] = poOverview;
                        if (bHasNoData)
                            poOverview->SetNoDataValue(noDataValue);
                        break;
                    }
                }

                CPLAssert(papapoOverviewBands[iBand][i] != nullptr);
            }
        }

        {
            CPLConfigOptionSetter oSetter(
                "GDAL_NUM_THREADS",
                CSLFetchNameValue(papszOptions, "NUM_THREADS"), true);

            if (eErr == CE_None)
                eErr = GDALRegenerateOverviewsMultiBand(
                    nBands, papoBandList, nOverviews, papapoOverviewBands,
                    pszResampling, pfnProgress, pProgressData, papszOptions);
        }

        for (int iBand = 0; iBand < nBands; iBand++)
        {
            CPLFree(papapoOverviewBands[iBand]);
        }
        CPLFree(papapoOverviewBands);
    }
    else
    {
        GDALRasterBand **papoOverviews = static_cast<GDALRasterBand **>(
            CPLCalloc(sizeof(void *), knMaxOverviews));

        for (int iBand = 0; iBand < nBands && eErr == CE_None; iBand++)
        {
            GDALRasterBand *hSrcBand = papoBandList[iBand];
            GDALRasterBand *hDstBand = hODS->GetRasterBand(iBand + 1);

            int bHasNoData = FALSE;
            const double noDataValue = hSrcBand->GetNoDataValue(&bHasNoData);
            if (bHasNoData)
                hDstBand->SetNoDataValue(noDataValue);

            // FIXME: this logic regenerates all overview bands, not only the
            // ones requested.

            papoOverviews[0] = hDstBand;
            int nDstOverviews = hDstBand->GetOverviewCount() + 1;
            CPLAssert(nDstOverviews < knMaxOverviews);
            nDstOverviews = std::min(knMaxOverviews, nDstOverviews);

            // TODO(schwehr): Convert to starting with i = 1 and remove +1.
            for (int i = 0; i < nDstOverviews - 1 && eErr == CE_None; i++)
            {
                papoOverviews[i + 1] = hDstBand->GetOverview(i);
                if (papoOverviews[i + 1] == nullptr)
                {
                    eErr = CE_Failure;
                }
                else
                {
                    if (bHasNoData)
                        papoOverviews[i + 1]->SetNoDataValue(noDataValue);
                }
            }

            void *pScaledProgressData = GDALCreateScaledProgress(
                iBand / static_cast<double>(nBands),
                (iBand + 1) / static_cast<double>(nBands), pfnProgress,
                pProgressData);

            {
                CPLConfigOptionSetter oSetter(
                    "GDAL_NUM_THREADS",
                    CSLFetchNameValue(papszOptions, "NUM_THREADS"), true);

                if (eErr == CE_None)
                    eErr = GDALRegenerateOverviewsEx(
                        hSrcBand, nDstOverviews,
                        reinterpret_cast<GDALRasterBandH *>(papoOverviews),
                        pszResampling, GDALScaledProgress, pScaledProgressData,
                        papszOptions);
            }

            GDALDestroyScaledProgress(pScaledProgressData);
        }

        CPLFree(papoOverviews);
    }

    /* -------------------------------------------------------------------- */
    /*      Cleanup                                                         */
    /* -------------------------------------------------------------------- */
    if (eErr == CE_None)
        hODS->FlushCache(true);
    delete hODS;

    GTIFFSetThreadLocalInExternalOvr(false);

    CPLFree(panOverviewListSorted);

    pfnProgress(1.0, nullptr, pProgressData);

    return eErr;
}
