Coverage Report

Created: 2026-02-14 06:52

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/gdal/frmts/gtiff/gtiffdataset_write.cpp
Line
Count
Source
1
/******************************************************************************
2
 *
3
 * Project:  GeoTIFF Driver
4
 * Purpose:  Write/set operations on GTiffDataset
5
 * Author:   Frank Warmerdam, warmerdam@pobox.com
6
 *
7
 ******************************************************************************
8
 * Copyright (c) 1998, 2002, Frank Warmerdam <warmerdam@pobox.com>
9
 * Copyright (c) 2007-2015, Even Rouault <even dot rouault at spatialys dot com>
10
 *
11
 * SPDX-License-Identifier: MIT
12
 ****************************************************************************/
13
14
#include "gtiffdataset.h"
15
#include "gtiffrasterband.h"
16
#include "gtiffoddbitsband.h"
17
#include "gtiffjpegoverviewds.h"
18
19
#include <cassert>
20
#include <cerrno>
21
22
#include <algorithm>
23
#include <cmath>
24
#include <limits>
25
#include <memory>
26
#include <mutex>
27
#include <set>
28
#include <string>
29
#include <tuple>
30
#include <utility>
31
32
#include "cpl_error.h"
33
#include "cpl_error_internal.h"  // CPLErrorHandlerAccumulatorStruct
34
#include "cpl_float.h"
35
#include "cpl_md5.h"
36
#include "cpl_vsi.h"
37
#include "cpl_vsi_virtual.h"
38
#include "cpl_worker_thread_pool.h"
39
#include "fetchbufferdirectio.h"
40
#include "gdal_mdreader.h"  // GDALWriteRPCTXTFile()
41
#include "gdal_priv.h"
42
#include "gdal_priv_templates.hpp"  // GDALIsValueInRange<>
43
#include "gdal_thread_pool.h"       // GDALGetGlobalThreadPool()
44
#include "geovalues.h"              // RasterPixelIsPoint
45
#include "gt_jpeg_copy.h"
46
#include "gt_overview.h"  // GTIFFBuildOverviewMetadata()
47
#include "quant_table_md5sum.h"
48
#include "quant_table_md5sum_jpeg9e.h"
49
#include "tif_jxl.h"
50
#include "tifvsi.h"
51
#include "xtiffio.h"
52
53
#if LIFFLIB_VERSION > 20230908 || defined(INTERNAL_LIBTIFF)
54
/* libtiff < 4.6.1 doesn't generate a LERC mask for multi-band contig configuration */
55
#define LIBTIFF_MULTIBAND_LERC_NAN_OK
56
#endif
57
58
static const int knGTIFFJpegTablesModeDefault = JPEGTABLESMODE_QUANT;
59
60
static constexpr const char szPROFILE_BASELINE[] = "BASELINE";
61
static constexpr const char szPROFILE_GeoTIFF[] = "GeoTIFF";
62
static constexpr const char szPROFILE_GDALGeoTIFF[] = "GDALGeoTIFF";
63
64
// Due to libgeotiff/xtiff.c declaring TIFFTAG_GEOTIEPOINTS with field_readcount
65
// and field_writecount == -1 == TIFF_VARIABLE, we are limited to writing
66
// 65535 values in that tag. That could potentially be overcome by changing the tag
67
// declaration to using TIFF_VARIABLE2 where the count is a uint32_t.
68
constexpr int knMAX_GCP_COUNT =
69
    static_cast<int>(std::numeric_limits<uint16_t>::max() / 6);
70
71
enum
72
{
73
    ENDIANNESS_NATIVE,
74
    ENDIANNESS_LITTLE,
75
    ENDIANNESS_BIG
76
};
77
78
static signed char GTiffGetWebPLevel(CSLConstList papszOptions)
79
0
{
80
0
    int nWebPLevel = DEFAULT_WEBP_LEVEL;
81
0
    const char *pszValue = CSLFetchNameValue(papszOptions, "WEBP_LEVEL");
82
0
    if (pszValue != nullptr)
83
0
    {
84
0
        nWebPLevel = atoi(pszValue);
85
0
        if (!(nWebPLevel >= 1 && nWebPLevel <= 100))
86
0
        {
87
0
            CPLError(CE_Warning, CPLE_IllegalArg,
88
0
                     "WEBP_LEVEL=%s value not recognised, ignoring.", pszValue);
89
0
            nWebPLevel = DEFAULT_WEBP_LEVEL;
90
0
        }
91
0
    }
92
0
    return static_cast<signed char>(nWebPLevel);
93
0
}
94
95
static bool GTiffGetWebPLossless(CSLConstList papszOptions)
96
0
{
97
0
    return CPLFetchBool(papszOptions, "WEBP_LOSSLESS", false);
98
0
}
99
100
static double GTiffGetLERCMaxZError(CSLConstList papszOptions)
101
0
{
102
0
    return CPLAtof(CSLFetchNameValueDef(papszOptions, "MAX_Z_ERROR", "0.0"));
103
0
}
104
105
static double GTiffGetLERCMaxZErrorOverview(CSLConstList papszOptions)
106
0
{
107
0
    return CPLAtof(CSLFetchNameValueDef(
108
0
        papszOptions, "MAX_Z_ERROR_OVERVIEW",
109
0
        CSLFetchNameValueDef(papszOptions, "MAX_Z_ERROR", "0.0")));
110
0
}
111
112
#if HAVE_JXL
113
static bool GTiffGetJXLLossless(CSLConstList papszOptions,
114
                                bool *pbIsSpecified = nullptr)
115
{
116
    const char *pszVal = CSLFetchNameValue(papszOptions, "JXL_LOSSLESS");
117
    if (pbIsSpecified)
118
        *pbIsSpecified = pszVal != nullptr;
119
    return pszVal == nullptr || CPLTestBool(pszVal);
120
}
121
122
static uint32_t GTiffGetJXLEffort(CSLConstList papszOptions)
123
{
124
    return atoi(CSLFetchNameValueDef(papszOptions, "JXL_EFFORT", "5"));
125
}
126
127
static float GTiffGetJXLDistance(CSLConstList papszOptions,
128
                                 bool *pbIsSpecified = nullptr)
129
{
130
    const char *pszVal = CSLFetchNameValue(papszOptions, "JXL_DISTANCE");
131
    if (pbIsSpecified)
132
        *pbIsSpecified = pszVal != nullptr;
133
    return pszVal == nullptr ? 1.0f : static_cast<float>(CPLAtof(pszVal));
134
}
135
136
static float GTiffGetJXLAlphaDistance(CSLConstList papszOptions,
137
                                      bool *pbIsSpecified = nullptr)
138
{
139
    const char *pszVal = CSLFetchNameValue(papszOptions, "JXL_ALPHA_DISTANCE");
140
    if (pbIsSpecified)
141
        *pbIsSpecified = pszVal != nullptr;
142
    return pszVal == nullptr ? -1.0f : static_cast<float>(CPLAtof(pszVal));
143
}
144
145
#endif
146
147
/************************************************************************/
148
/*                           FillEmptyTiles()                           */
149
/************************************************************************/
150
151
CPLErr GTiffDataset::FillEmptyTiles()
152
153
0
{
154
    /* -------------------------------------------------------------------- */
155
    /*      How many blocks are there in this file?                         */
156
    /* -------------------------------------------------------------------- */
157
0
    const int nBlockCount = m_nPlanarConfig == PLANARCONFIG_SEPARATE
158
0
                                ? m_nBlocksPerBand * nBands
159
0
                                : m_nBlocksPerBand;
160
161
    /* -------------------------------------------------------------------- */
162
    /*      Fetch block maps.                                               */
163
    /* -------------------------------------------------------------------- */
164
0
    toff_t *panByteCounts = nullptr;
165
166
0
    if (TIFFIsTiled(m_hTIFF))
167
0
        TIFFGetField(m_hTIFF, TIFFTAG_TILEBYTECOUNTS, &panByteCounts);
168
0
    else
169
0
        TIFFGetField(m_hTIFF, TIFFTAG_STRIPBYTECOUNTS, &panByteCounts);
170
171
0
    if (panByteCounts == nullptr)
172
0
    {
173
        // Got here with libtiff 3.9.3 and tiff_write_8 test.
174
0
        ReportError(CE_Failure, CPLE_AppDefined,
175
0
                    "FillEmptyTiles() failed because panByteCounts == NULL");
176
0
        return CE_Failure;
177
0
    }
178
179
    /* -------------------------------------------------------------------- */
180
    /*      Prepare a blank data buffer to write for uninitialized blocks.  */
181
    /* -------------------------------------------------------------------- */
182
0
    const GPtrDiff_t nBlockBytes =
183
0
        TIFFIsTiled(m_hTIFF) ? static_cast<GPtrDiff_t>(TIFFTileSize(m_hTIFF))
184
0
                             : static_cast<GPtrDiff_t>(TIFFStripSize(m_hTIFF));
185
186
0
    GByte *pabyData = static_cast<GByte *>(VSI_CALLOC_VERBOSE(nBlockBytes, 1));
187
0
    if (pabyData == nullptr)
188
0
    {
189
0
        return CE_Failure;
190
0
    }
191
192
    // Force tiles completely filled with the nodata value to be written.
193
0
    m_bWriteEmptyTiles = true;
194
195
    /* -------------------------------------------------------------------- */
196
    /*      If set, fill data buffer with no data value.                    */
197
    /* -------------------------------------------------------------------- */
198
0
    if ((m_bNoDataSet && m_dfNoDataValue != 0.0) ||
199
0
        (m_bNoDataSetAsInt64 && m_nNoDataValueInt64 != 0) ||
200
0
        (m_bNoDataSetAsUInt64 && m_nNoDataValueUInt64 != 0))
201
0
    {
202
0
        const GDALDataType eDataType = GetRasterBand(1)->GetRasterDataType();
203
0
        const int nDataTypeSize = GDALGetDataTypeSizeBytes(eDataType);
204
0
        if (nDataTypeSize &&
205
0
            nDataTypeSize * 8 == static_cast<int>(m_nBitsPerSample))
206
0
        {
207
0
            if (m_bNoDataSetAsInt64)
208
0
            {
209
0
                GDALCopyWords64(&m_nNoDataValueInt64, GDT_Int64, 0, pabyData,
210
0
                                eDataType, nDataTypeSize,
211
0
                                nBlockBytes / nDataTypeSize);
212
0
            }
213
0
            else if (m_bNoDataSetAsUInt64)
214
0
            {
215
0
                GDALCopyWords64(&m_nNoDataValueUInt64, GDT_UInt64, 0, pabyData,
216
0
                                eDataType, nDataTypeSize,
217
0
                                nBlockBytes / nDataTypeSize);
218
0
            }
219
0
            else
220
0
            {
221
0
                double dfNoData = m_dfNoDataValue;
222
0
                GDALCopyWords64(&dfNoData, GDT_Float64, 0, pabyData, eDataType,
223
0
                                nDataTypeSize, nBlockBytes / nDataTypeSize);
224
0
            }
225
0
        }
226
0
        else if (nDataTypeSize)
227
0
        {
228
            // Handle non power-of-two depths.
229
            // Ideally make a packed buffer, but that is a bit tedious,
230
            // so use the normal I/O interfaces.
231
232
0
            CPLFree(pabyData);
233
234
0
            pabyData = static_cast<GByte *>(VSI_MALLOC3_VERBOSE(
235
0
                m_nBlockXSize, m_nBlockYSize, nDataTypeSize));
236
0
            if (pabyData == nullptr)
237
0
                return CE_Failure;
238
0
            if (m_bNoDataSetAsInt64)
239
0
            {
240
0
                GDALCopyWords64(&m_nNoDataValueInt64, GDT_Int64, 0, pabyData,
241
0
                                eDataType, nDataTypeSize,
242
0
                                static_cast<GPtrDiff_t>(m_nBlockXSize) *
243
0
                                    m_nBlockYSize);
244
0
            }
245
0
            else if (m_bNoDataSetAsUInt64)
246
0
            {
247
0
                GDALCopyWords64(&m_nNoDataValueUInt64, GDT_UInt64, 0, pabyData,
248
0
                                eDataType, nDataTypeSize,
249
0
                                static_cast<GPtrDiff_t>(m_nBlockXSize) *
250
0
                                    m_nBlockYSize);
251
0
            }
252
0
            else
253
0
            {
254
0
                GDALCopyWords64(&m_dfNoDataValue, GDT_Float64, 0, pabyData,
255
0
                                eDataType, nDataTypeSize,
256
0
                                static_cast<GPtrDiff_t>(m_nBlockXSize) *
257
0
                                    m_nBlockYSize);
258
0
            }
259
0
            CPLErr eErr = CE_None;
260
0
            for (int iBlock = 0; iBlock < nBlockCount; ++iBlock)
261
0
            {
262
0
                if (panByteCounts[iBlock] == 0)
263
0
                {
264
0
                    if (m_nPlanarConfig == PLANARCONFIG_SEPARATE || nBands == 1)
265
0
                    {
266
0
                        if (GetRasterBand(1 + iBlock / m_nBlocksPerBand)
267
0
                                ->WriteBlock((iBlock % m_nBlocksPerBand) %
268
0
                                                 m_nBlocksPerRow,
269
0
                                             (iBlock % m_nBlocksPerBand) /
270
0
                                                 m_nBlocksPerRow,
271
0
                                             pabyData) != CE_None)
272
0
                        {
273
0
                            eErr = CE_Failure;
274
0
                        }
275
0
                    }
276
0
                    else
277
0
                    {
278
                        // In contig case, don't directly call WriteBlock(), as
279
                        // it could cause useless decompression-recompression.
280
0
                        const int nXOff =
281
0
                            (iBlock % m_nBlocksPerRow) * m_nBlockXSize;
282
0
                        const int nYOff =
283
0
                            (iBlock / m_nBlocksPerRow) * m_nBlockYSize;
284
0
                        const int nXSize =
285
0
                            (nXOff + m_nBlockXSize <= nRasterXSize)
286
0
                                ? m_nBlockXSize
287
0
                                : nRasterXSize - nXOff;
288
0
                        const int nYSize =
289
0
                            (nYOff + m_nBlockYSize <= nRasterYSize)
290
0
                                ? m_nBlockYSize
291
0
                                : nRasterYSize - nYOff;
292
0
                        for (int iBand = 1; iBand <= nBands; ++iBand)
293
0
                        {
294
0
                            if (GetRasterBand(iBand)->RasterIO(
295
0
                                    GF_Write, nXOff, nYOff, nXSize, nYSize,
296
0
                                    pabyData, nXSize, nYSize, eDataType, 0, 0,
297
0
                                    nullptr) != CE_None)
298
0
                            {
299
0
                                eErr = CE_Failure;
300
0
                            }
301
0
                        }
302
0
                    }
303
0
                }
304
0
            }
305
0
            CPLFree(pabyData);
306
0
            return eErr;
307
0
        }
308
0
    }
309
310
    /* -------------------------------------------------------------------- */
311
    /*      When we must fill with zeroes, try to create non-sparse file    */
312
    /*      w.r.t TIFF spec ... as a sparse file w.r.t filesystem, ie by    */
313
    /*      seeking to end of file instead of writing zero blocks.          */
314
    /* -------------------------------------------------------------------- */
315
0
    else if (m_nCompression == COMPRESSION_NONE && (m_nBitsPerSample % 8) == 0)
316
0
    {
317
0
        CPLErr eErr = CE_None;
318
        // Only use libtiff to write the first sparse block to ensure that it
319
        // will serialize offset and count arrays back to disk.
320
0
        int nCountBlocksToZero = 0;
321
0
        for (int iBlock = 0; iBlock < nBlockCount; ++iBlock)
322
0
        {
323
0
            if (panByteCounts[iBlock] == 0)
324
0
            {
325
0
                if (nCountBlocksToZero == 0)
326
0
                {
327
0
                    const bool bWriteEmptyTilesBak = m_bWriteEmptyTiles;
328
0
                    m_bWriteEmptyTiles = true;
329
0
                    const bool bOK = WriteEncodedTileOrStrip(iBlock, pabyData,
330
0
                                                             FALSE) == CE_None;
331
0
                    m_bWriteEmptyTiles = bWriteEmptyTilesBak;
332
0
                    if (!bOK)
333
0
                    {
334
0
                        eErr = CE_Failure;
335
0
                        break;
336
0
                    }
337
0
                }
338
0
                nCountBlocksToZero++;
339
0
            }
340
0
        }
341
0
        CPLFree(pabyData);
342
343
0
        --nCountBlocksToZero;
344
345
        // And then seek to end of file for other ones.
346
0
        if (nCountBlocksToZero > 0)
347
0
        {
348
0
            toff_t *panByteOffsets = nullptr;
349
350
0
            if (TIFFIsTiled(m_hTIFF))
351
0
                TIFFGetField(m_hTIFF, TIFFTAG_TILEOFFSETS, &panByteOffsets);
352
0
            else
353
0
                TIFFGetField(m_hTIFF, TIFFTAG_STRIPOFFSETS, &panByteOffsets);
354
355
0
            if (panByteOffsets == nullptr)
356
0
            {
357
0
                ReportError(
358
0
                    CE_Failure, CPLE_AppDefined,
359
0
                    "FillEmptyTiles() failed because panByteOffsets == NULL");
360
0
                return CE_Failure;
361
0
            }
362
363
0
            VSILFILE *fpTIF = VSI_TIFFGetVSILFile(TIFFClientdata(m_hTIFF));
364
0
            VSIFSeekL(fpTIF, 0, SEEK_END);
365
0
            const vsi_l_offset nOffset = VSIFTellL(fpTIF);
366
367
0
            vsi_l_offset iBlockToZero = 0;
368
0
            for (int iBlock = 0; iBlock < nBlockCount; ++iBlock)
369
0
            {
370
0
                if (panByteCounts[iBlock] == 0)
371
0
                {
372
0
                    panByteOffsets[iBlock] = static_cast<toff_t>(
373
0
                        nOffset + iBlockToZero * nBlockBytes);
374
0
                    panByteCounts[iBlock] = nBlockBytes;
375
0
                    iBlockToZero++;
376
0
                }
377
0
            }
378
0
            CPLAssert(iBlockToZero ==
379
0
                      static_cast<vsi_l_offset>(nCountBlocksToZero));
380
381
0
            if (VSIFTruncateL(fpTIF, nOffset + iBlockToZero * nBlockBytes) != 0)
382
0
            {
383
0
                eErr = CE_Failure;
384
0
                ReportError(CE_Failure, CPLE_FileIO,
385
0
                            "Cannot initialize empty blocks");
386
0
            }
387
0
        }
388
389
0
        return eErr;
390
0
    }
391
392
    /* -------------------------------------------------------------------- */
393
    /*      Check all blocks, writing out data for uninitialized blocks.    */
394
    /* -------------------------------------------------------------------- */
395
396
0
    GByte *pabyRaw = nullptr;
397
0
    vsi_l_offset nRawSize = 0;
398
0
    CPLErr eErr = CE_None;
399
0
    for (int iBlock = 0; iBlock < nBlockCount; ++iBlock)
400
0
    {
401
0
        if (panByteCounts[iBlock] == 0)
402
0
        {
403
0
            if (pabyRaw == nullptr)
404
0
            {
405
0
                if (WriteEncodedTileOrStrip(iBlock, pabyData, FALSE) != CE_None)
406
0
                {
407
0
                    eErr = CE_Failure;
408
0
                    break;
409
0
                }
410
411
0
                vsi_l_offset nOffset = 0;
412
0
                if (!IsBlockAvailable(iBlock, &nOffset, &nRawSize, nullptr))
413
0
                    break;
414
415
                // When using compression, get back the compressed block
416
                // so we can use the raw API to write it faster.
417
0
                if (m_nCompression != COMPRESSION_NONE)
418
0
                {
419
0
                    pabyRaw = static_cast<GByte *>(
420
0
                        VSI_MALLOC_VERBOSE(static_cast<size_t>(nRawSize)));
421
0
                    if (pabyRaw)
422
0
                    {
423
0
                        VSILFILE *fp =
424
0
                            VSI_TIFFGetVSILFile(TIFFClientdata(m_hTIFF));
425
0
                        const vsi_l_offset nCurOffset = VSIFTellL(fp);
426
0
                        VSIFSeekL(fp, nOffset, SEEK_SET);
427
0
                        VSIFReadL(pabyRaw, 1, static_cast<size_t>(nRawSize),
428
0
                                  fp);
429
0
                        VSIFSeekL(fp, nCurOffset, SEEK_SET);
430
0
                    }
431
0
                }
432
0
            }
433
0
            else
434
0
            {
435
0
                WriteRawStripOrTile(iBlock, pabyRaw,
436
0
                                    static_cast<GPtrDiff_t>(nRawSize));
437
0
            }
438
0
        }
439
0
    }
440
441
0
    CPLFree(pabyData);
442
0
    VSIFree(pabyRaw);
443
0
    return eErr;
444
0
}
445
446
/************************************************************************/
447
/*                           HasOnlyNoData()                            */
448
/************************************************************************/
449
450
bool GTiffDataset::HasOnlyNoData(const void *pBuffer, int nWidth, int nHeight,
451
                                 int nLineStride, int nComponents)
452
0
{
453
0
    if (m_nSampleFormat == SAMPLEFORMAT_COMPLEXINT ||
454
0
        m_nSampleFormat == SAMPLEFORMAT_COMPLEXIEEEFP)
455
0
        return false;
456
0
    if (m_bNoDataSetAsInt64 || m_bNoDataSetAsUInt64)
457
0
        return false;  // FIXME: over pessimistic
458
0
    return GDALBufferHasOnlyNoData(
459
0
        pBuffer, m_bNoDataSet ? m_dfNoDataValue : 0.0, nWidth, nHeight,
460
0
        nLineStride, nComponents, m_nBitsPerSample,
461
0
        m_nSampleFormat == SAMPLEFORMAT_UINT  ? GSF_UNSIGNED_INT
462
0
        : m_nSampleFormat == SAMPLEFORMAT_INT ? GSF_SIGNED_INT
463
0
                                              : GSF_FLOATING_POINT);
464
0
}
465
466
/************************************************************************/
467
/*                     IsFirstPixelEqualToNoData()                      */
468
/************************************************************************/
469
470
inline bool GTiffDataset::IsFirstPixelEqualToNoData(const void *pBuffer)
471
0
{
472
0
    const GDALDataType eDT = GetRasterBand(1)->GetRasterDataType();
473
0
    const double dfEffectiveNoData = (m_bNoDataSet) ? m_dfNoDataValue : 0.0;
474
0
    if (m_bNoDataSetAsInt64 || m_bNoDataSetAsUInt64)
475
0
        return true;  // FIXME: over pessimistic
476
0
    if (m_nBitsPerSample == 8 ||
477
0
        (m_nBitsPerSample < 8 && dfEffectiveNoData == 0))
478
0
    {
479
0
        if (eDT == GDT_Int8)
480
0
        {
481
0
            return GDALIsValueInRange<signed char>(dfEffectiveNoData) &&
482
0
                   *(static_cast<const signed char *>(pBuffer)) ==
483
0
                       static_cast<signed char>(dfEffectiveNoData);
484
0
        }
485
0
        return GDALIsValueInRange<GByte>(dfEffectiveNoData) &&
486
0
               *(static_cast<const GByte *>(pBuffer)) ==
487
0
                   static_cast<GByte>(dfEffectiveNoData);
488
0
    }
489
0
    if (m_nBitsPerSample == 16 && eDT == GDT_UInt16)
490
0
    {
491
0
        return GDALIsValueInRange<GUInt16>(dfEffectiveNoData) &&
492
0
               *(static_cast<const GUInt16 *>(pBuffer)) ==
493
0
                   static_cast<GUInt16>(dfEffectiveNoData);
494
0
    }
495
0
    if (m_nBitsPerSample == 16 && eDT == GDT_Int16)
496
0
    {
497
0
        return GDALIsValueInRange<GInt16>(dfEffectiveNoData) &&
498
0
               *(static_cast<const GInt16 *>(pBuffer)) ==
499
0
                   static_cast<GInt16>(dfEffectiveNoData);
500
0
    }
501
0
    if (m_nBitsPerSample == 32 && eDT == GDT_UInt32)
502
0
    {
503
0
        return GDALIsValueInRange<GUInt32>(dfEffectiveNoData) &&
504
0
               *(static_cast<const GUInt32 *>(pBuffer)) ==
505
0
                   static_cast<GUInt32>(dfEffectiveNoData);
506
0
    }
507
0
    if (m_nBitsPerSample == 32 && eDT == GDT_Int32)
508
0
    {
509
0
        return GDALIsValueInRange<GInt32>(dfEffectiveNoData) &&
510
0
               *(static_cast<const GInt32 *>(pBuffer)) ==
511
0
                   static_cast<GInt32>(dfEffectiveNoData);
512
0
    }
513
0
    if (m_nBitsPerSample == 64 && eDT == GDT_UInt64)
514
0
    {
515
0
        return GDALIsValueInRange<std::uint64_t>(dfEffectiveNoData) &&
516
0
               *(static_cast<const std::uint64_t *>(pBuffer)) ==
517
0
                   static_cast<std::uint64_t>(dfEffectiveNoData);
518
0
    }
519
0
    if (m_nBitsPerSample == 64 && eDT == GDT_Int64)
520
0
    {
521
0
        return GDALIsValueInRange<std::int64_t>(dfEffectiveNoData) &&
522
0
               *(static_cast<const std::int64_t *>(pBuffer)) ==
523
0
                   static_cast<std::int64_t>(dfEffectiveNoData);
524
0
    }
525
0
    if (m_nBitsPerSample == 32 && eDT == GDT_Float32)
526
0
    {
527
0
        if (std::isnan(m_dfNoDataValue))
528
0
            return CPL_TO_BOOL(
529
0
                std::isnan(*(static_cast<const float *>(pBuffer))));
530
0
        return GDALIsValueInRange<float>(dfEffectiveNoData) &&
531
0
               *(static_cast<const float *>(pBuffer)) ==
532
0
                   static_cast<float>(dfEffectiveNoData);
533
0
    }
534
0
    if (m_nBitsPerSample == 64 && eDT == GDT_Float64)
535
0
    {
536
0
        if (std::isnan(dfEffectiveNoData))
537
0
            return CPL_TO_BOOL(
538
0
                std::isnan(*(static_cast<const double *>(pBuffer))));
539
0
        return *(static_cast<const double *>(pBuffer)) == dfEffectiveNoData;
540
0
    }
541
0
    return false;
542
0
}
543
544
/************************************************************************/
545
/*                      WriteDealWithLercAndNan()                       */
546
/************************************************************************/
547
548
template <typename T>
549
void GTiffDataset::WriteDealWithLercAndNan(T *pBuffer, int nActualBlockWidth,
550
                                           int nActualBlockHeight,
551
                                           int nStrileHeight)
552
0
{
553
    // This method does 2 things:
554
    // - warn the user if he tries to write NaN values with libtiff < 4.6.1
555
    //   and multi-band PlanarConfig=Contig configuration
556
    // - and in right-most and bottom-most tiles, replace non accessible
557
    //   pixel values by a safe one.
558
559
0
    const auto fPaddingValue =
560
#if !defined(LIBTIFF_MULTIBAND_LERC_NAN_OK)
561
        m_nPlanarConfig == PLANARCONFIG_CONTIG && nBands > 1
562
            ? 0
563
            :
564
#endif
565
0
            std::numeric_limits<T>::quiet_NaN();
566
567
0
    const int nBandsPerStrile =
568
0
        m_nPlanarConfig == PLANARCONFIG_CONTIG ? nBands : 1;
569
0
    for (int j = 0; j < nActualBlockHeight; ++j)
570
0
    {
571
#if !defined(LIBTIFF_MULTIBAND_LERC_NAN_OK)
572
        static bool bHasWarned = false;
573
        if (m_nPlanarConfig == PLANARCONFIG_CONTIG && nBands > 1 && !bHasWarned)
574
        {
575
            for (int i = 0; i < nActualBlockWidth * nBandsPerStrile; ++i)
576
            {
577
                if (std::isnan(
578
                        pBuffer[j * m_nBlockXSize * nBandsPerStrile + i]))
579
                {
580
                    bHasWarned = true;
581
                    CPLError(CE_Warning, CPLE_AppDefined,
582
                             "libtiff < 4.6.1 does not handle properly NaN "
583
                             "values for multi-band PlanarConfig=Contig "
584
                             "configuration. As a workaround, you can set the "
585
                             "INTERLEAVE=BAND creation option.");
586
                    break;
587
                }
588
            }
589
        }
590
#endif
591
0
        for (int i = nActualBlockWidth * nBandsPerStrile;
592
0
             i < m_nBlockXSize * nBandsPerStrile; ++i)
593
0
        {
594
0
            pBuffer[j * m_nBlockXSize * nBandsPerStrile + i] = fPaddingValue;
595
0
        }
596
0
    }
597
0
    for (int j = nActualBlockHeight; j < nStrileHeight; ++j)
598
0
    {
599
0
        for (int i = 0; i < m_nBlockXSize * nBandsPerStrile; ++i)
600
0
        {
601
0
            pBuffer[j * m_nBlockXSize * nBandsPerStrile + i] = fPaddingValue;
602
0
        }
603
0
    }
604
0
}
Unexecuted instantiation: void GTiffDataset::WriteDealWithLercAndNan<float>(float*, int, int, int)
Unexecuted instantiation: void GTiffDataset::WriteDealWithLercAndNan<double>(double*, int, int, int)
605
606
/************************************************************************/
607
/*                          WriteEncodedTile()                          */
608
/************************************************************************/
609
610
bool GTiffDataset::WriteEncodedTile(uint32_t tile, GByte *pabyData,
611
                                    int bPreserveDataBuffer)
612
0
{
613
0
    const int iColumn = (tile % m_nBlocksPerBand) % m_nBlocksPerRow;
614
0
    const int iRow = (tile % m_nBlocksPerBand) / m_nBlocksPerRow;
615
616
0
    const int nActualBlockWidth = (iColumn == m_nBlocksPerRow - 1)
617
0
                                      ? nRasterXSize - iColumn * m_nBlockXSize
618
0
                                      : m_nBlockXSize;
619
0
    const int nActualBlockHeight = (iRow == m_nBlocksPerColumn - 1)
620
0
                                       ? nRasterYSize - iRow * m_nBlockYSize
621
0
                                       : m_nBlockYSize;
622
623
    /* -------------------------------------------------------------------- */
624
    /*      Don't write empty blocks in some cases.                         */
625
    /* -------------------------------------------------------------------- */
626
0
    if (!m_bWriteEmptyTiles && IsFirstPixelEqualToNoData(pabyData))
627
0
    {
628
0
        if (!IsBlockAvailable(tile, nullptr, nullptr, nullptr))
629
0
        {
630
0
            const int nComponents =
631
0
                m_nPlanarConfig == PLANARCONFIG_CONTIG ? nBands : 1;
632
633
0
            if (HasOnlyNoData(pabyData, nActualBlockWidth, nActualBlockHeight,
634
0
                              m_nBlockXSize, nComponents))
635
0
            {
636
0
                return true;
637
0
            }
638
0
        }
639
0
    }
640
641
    // Is this a partial right edge or bottom edge tile?
642
0
    const bool bPartialTile = (nActualBlockWidth < m_nBlockXSize) ||
643
0
                              (nActualBlockHeight < m_nBlockYSize);
644
645
0
    const bool bIsLercFloatingPoint =
646
0
        m_nCompression == COMPRESSION_LERC &&
647
0
        (GetRasterBand(1)->GetRasterDataType() == GDT_Float32 ||
648
0
         GetRasterBand(1)->GetRasterDataType() == GDT_Float64);
649
650
    // Do we need to spread edge values right or down for a partial
651
    // JPEG encoded tile?  We do this to avoid edge artifacts.
652
    // We also need to be careful with LERC and NaN values
653
0
    const bool bNeedTempBuffer =
654
0
        bPartialTile &&
655
0
        (m_nCompression == COMPRESSION_JPEG || bIsLercFloatingPoint);
656
657
    // If we need to fill out the tile, or if we want to prevent
658
    // TIFFWriteEncodedTile from altering the buffer as part of
659
    // byte swapping the data on write then we will need a temporary
660
    // working buffer.  If not, we can just do a direct write.
661
0
    const GPtrDiff_t cc = static_cast<GPtrDiff_t>(TIFFTileSize(m_hTIFF));
662
663
0
    if (bPreserveDataBuffer &&
664
0
        (TIFFIsByteSwapped(m_hTIFF) || bNeedTempBuffer || m_panMaskOffsetLsb))
665
0
    {
666
0
        if (m_pabyTempWriteBuffer == nullptr)
667
0
        {
668
0
            m_pabyTempWriteBuffer = CPLMalloc(cc);
669
0
        }
670
0
        memcpy(m_pabyTempWriteBuffer, pabyData, cc);
671
672
0
        pabyData = static_cast<GByte *>(m_pabyTempWriteBuffer);
673
0
    }
674
675
    // Perform tile fill if needed.
676
    // TODO: we should also handle the case of nBitsPerSample == 12
677
    // but this is more involved.
678
0
    if (bPartialTile && m_nCompression == COMPRESSION_JPEG &&
679
0
        m_nBitsPerSample == 8)
680
0
    {
681
0
        const int nComponents =
682
0
            m_nPlanarConfig == PLANARCONFIG_CONTIG ? nBands : 1;
683
684
0
        CPLDebug("GTiff", "Filling out jpeg edge tile on write.");
685
686
0
        const int nRightPixelsToFill =
687
0
            iColumn == m_nBlocksPerRow - 1
688
0
                ? m_nBlockXSize * (iColumn + 1) - nRasterXSize
689
0
                : 0;
690
0
        const int nBottomPixelsToFill =
691
0
            iRow == m_nBlocksPerColumn - 1
692
0
                ? m_nBlockYSize * (iRow + 1) - nRasterYSize
693
0
                : 0;
694
695
        // Fill out to the right.
696
0
        const int iSrcX = m_nBlockXSize - nRightPixelsToFill - 1;
697
698
0
        for (int iX = iSrcX + 1; iX < m_nBlockXSize; ++iX)
699
0
        {
700
0
            for (int iY = 0; iY < m_nBlockYSize; ++iY)
701
0
            {
702
0
                memcpy(pabyData +
703
0
                           (static_cast<GPtrDiff_t>(m_nBlockXSize) * iY + iX) *
704
0
                               nComponents,
705
0
                       pabyData + (static_cast<GPtrDiff_t>(m_nBlockXSize) * iY +
706
0
                                   iSrcX) *
707
0
                                      nComponents,
708
0
                       nComponents);
709
0
            }
710
0
        }
711
712
        // Now fill out the bottom.
713
0
        const int iSrcY = m_nBlockYSize - nBottomPixelsToFill - 1;
714
0
        for (int iY = iSrcY + 1; iY < m_nBlockYSize; ++iY)
715
0
        {
716
0
            memcpy(pabyData + static_cast<GPtrDiff_t>(m_nBlockXSize) *
717
0
                                  nComponents * iY,
718
0
                   pabyData + static_cast<GPtrDiff_t>(m_nBlockXSize) *
719
0
                                  nComponents * iSrcY,
720
0
                   static_cast<GPtrDiff_t>(m_nBlockXSize) * nComponents);
721
0
        }
722
0
    }
723
724
0
    if (bIsLercFloatingPoint &&
725
0
        (bPartialTile
726
#if !defined(LIBTIFF_MULTIBAND_LERC_NAN_OK)
727
         /* libtiff < 4.6.1 doesn't generate a LERC mask for multi-band contig configuration */
728
         || (m_nPlanarConfig == PLANARCONFIG_CONTIG && nBands > 1)
729
#endif
730
0
             ))
731
0
    {
732
0
        if (GetRasterBand(1)->GetRasterDataType() == GDT_Float32)
733
0
            WriteDealWithLercAndNan(reinterpret_cast<float *>(pabyData),
734
0
                                    nActualBlockWidth, nActualBlockHeight,
735
0
                                    m_nBlockYSize);
736
0
        else
737
0
            WriteDealWithLercAndNan(reinterpret_cast<double *>(pabyData),
738
0
                                    nActualBlockWidth, nActualBlockHeight,
739
0
                                    m_nBlockYSize);
740
0
    }
741
742
0
    if (m_panMaskOffsetLsb)
743
0
    {
744
0
        const int iBand = m_nPlanarConfig == PLANARCONFIG_SEPARATE
745
0
                              ? static_cast<int>(tile) / m_nBlocksPerBand
746
0
                              : -1;
747
0
        DiscardLsb(pabyData, cc, iBand);
748
0
    }
749
750
0
    if (m_bStreamingOut)
751
0
    {
752
0
        if (tile != static_cast<uint32_t>(m_nLastWrittenBlockId + 1))
753
0
        {
754
0
            ReportError(CE_Failure, CPLE_NotSupported,
755
0
                        "Attempt to write block %d whereas %d was expected",
756
0
                        tile, m_nLastWrittenBlockId + 1);
757
0
            return false;
758
0
        }
759
0
        if (static_cast<GPtrDiff_t>(VSIFWriteL(pabyData, 1, cc, m_fpToWrite)) !=
760
0
            cc)
761
0
        {
762
0
            ReportError(CE_Failure, CPLE_FileIO,
763
0
                        "Could not write " CPL_FRMT_GUIB " bytes",
764
0
                        static_cast<GUIntBig>(cc));
765
0
            return false;
766
0
        }
767
0
        m_nLastWrittenBlockId = tile;
768
0
        return true;
769
0
    }
770
771
    /* -------------------------------------------------------------------- */
772
    /*      Should we do compression in a worker thread ?                   */
773
    /* -------------------------------------------------------------------- */
774
0
    if (SubmitCompressionJob(tile, pabyData, cc, m_nBlockYSize))
775
0
        return true;
776
777
0
    return TIFFWriteEncodedTile(m_hTIFF, tile, pabyData, cc) == cc;
778
0
}
779
780
/************************************************************************/
781
/*                         WriteEncodedStrip()                          */
782
/************************************************************************/
783
784
bool GTiffDataset::WriteEncodedStrip(uint32_t strip, GByte *pabyData,
785
                                     int bPreserveDataBuffer)
786
0
{
787
0
    GPtrDiff_t cc = static_cast<GPtrDiff_t>(TIFFStripSize(m_hTIFF));
788
0
    const auto ccFull = cc;
789
790
    /* -------------------------------------------------------------------- */
791
    /*      If this is the last strip in the image, and is partial, then    */
792
    /*      we need to trim the number of scanlines written to the          */
793
    /*      amount of valid data we have. (#2748)                           */
794
    /* -------------------------------------------------------------------- */
795
0
    const int nStripWithinBand = strip % m_nBlocksPerBand;
796
0
    int nStripHeight = m_nRowsPerStrip;
797
798
0
    if (nStripWithinBand * nStripHeight > GetRasterYSize() - nStripHeight)
799
0
    {
800
0
        nStripHeight = GetRasterYSize() - nStripWithinBand * m_nRowsPerStrip;
801
0
        cc = (cc / m_nRowsPerStrip) * nStripHeight;
802
0
        CPLDebug("GTiff",
803
0
                 "Adjusted bytes to write from " CPL_FRMT_GUIB
804
0
                 " to " CPL_FRMT_GUIB ".",
805
0
                 static_cast<GUIntBig>(TIFFStripSize(m_hTIFF)),
806
0
                 static_cast<GUIntBig>(cc));
807
0
    }
808
809
    /* -------------------------------------------------------------------- */
810
    /*      Don't write empty blocks in some cases.                         */
811
    /* -------------------------------------------------------------------- */
812
0
    if (!m_bWriteEmptyTiles && IsFirstPixelEqualToNoData(pabyData))
813
0
    {
814
0
        if (!IsBlockAvailable(strip, nullptr, nullptr, nullptr))
815
0
        {
816
0
            const int nComponents =
817
0
                m_nPlanarConfig == PLANARCONFIG_CONTIG ? nBands : 1;
818
819
0
            if (HasOnlyNoData(pabyData, m_nBlockXSize, nStripHeight,
820
0
                              m_nBlockXSize, nComponents))
821
0
            {
822
0
                return true;
823
0
            }
824
0
        }
825
0
    }
826
827
    /* -------------------------------------------------------------------- */
828
    /*      TIFFWriteEncodedStrip can alter the passed buffer if            */
829
    /*      byte-swapping is necessary so we use a temporary buffer         */
830
    /*      before calling it.                                              */
831
    /* -------------------------------------------------------------------- */
832
0
    if (bPreserveDataBuffer &&
833
0
        (TIFFIsByteSwapped(m_hTIFF) || m_panMaskOffsetLsb))
834
0
    {
835
0
        if (m_pabyTempWriteBuffer == nullptr)
836
0
        {
837
0
            m_pabyTempWriteBuffer = CPLMalloc(ccFull);
838
0
        }
839
0
        memcpy(m_pabyTempWriteBuffer, pabyData, cc);
840
0
        pabyData = static_cast<GByte *>(m_pabyTempWriteBuffer);
841
0
    }
842
843
#if !defined(LIBTIFF_MULTIBAND_LERC_NAN_OK)
844
    const bool bIsLercFloatingPoint =
845
        m_nCompression == COMPRESSION_LERC &&
846
        (GetRasterBand(1)->GetRasterDataType() == GDT_Float32 ||
847
         GetRasterBand(1)->GetRasterDataType() == GDT_Float64);
848
    if (bIsLercFloatingPoint &&
849
        /* libtiff < 4.6.1 doesn't generate a LERC mask for multi-band contig configuration */
850
        m_nPlanarConfig == PLANARCONFIG_CONTIG && nBands > 1)
851
    {
852
        if (GetRasterBand(1)->GetRasterDataType() == GDT_Float32)
853
            WriteDealWithLercAndNan(reinterpret_cast<float *>(pabyData),
854
                                    m_nBlockXSize, nStripHeight, nStripHeight);
855
        else
856
            WriteDealWithLercAndNan(reinterpret_cast<double *>(pabyData),
857
                                    m_nBlockXSize, nStripHeight, nStripHeight);
858
    }
859
#endif
860
861
0
    if (m_panMaskOffsetLsb)
862
0
    {
863
0
        int iBand = m_nPlanarConfig == PLANARCONFIG_SEPARATE
864
0
                        ? static_cast<int>(strip) / m_nBlocksPerBand
865
0
                        : -1;
866
0
        DiscardLsb(pabyData, cc, iBand);
867
0
    }
868
869
0
    if (m_bStreamingOut)
870
0
    {
871
0
        if (strip != static_cast<uint32_t>(m_nLastWrittenBlockId + 1))
872
0
        {
873
0
            ReportError(CE_Failure, CPLE_NotSupported,
874
0
                        "Attempt to write block %d whereas %d was expected",
875
0
                        strip, m_nLastWrittenBlockId + 1);
876
0
            return false;
877
0
        }
878
0
        if (static_cast<GPtrDiff_t>(VSIFWriteL(pabyData, 1, cc, m_fpToWrite)) !=
879
0
            cc)
880
0
        {
881
0
            ReportError(CE_Failure, CPLE_FileIO,
882
0
                        "Could not write " CPL_FRMT_GUIB " bytes",
883
0
                        static_cast<GUIntBig>(cc));
884
0
            return false;
885
0
        }
886
0
        m_nLastWrittenBlockId = strip;
887
0
        return true;
888
0
    }
889
890
    /* -------------------------------------------------------------------- */
891
    /*      Should we do compression in a worker thread ?                   */
892
    /* -------------------------------------------------------------------- */
893
0
    if (SubmitCompressionJob(strip, pabyData, cc, nStripHeight))
894
0
        return true;
895
896
0
    return TIFFWriteEncodedStrip(m_hTIFF, strip, pabyData, cc) == cc;
897
0
}
898
899
/************************************************************************/
900
/*                       InitCompressionThreads()                       */
901
/************************************************************************/
902
903
void GTiffDataset::InitCompressionThreads(bool bUpdateMode,
904
                                          CSLConstList papszOptions)
905
0
{
906
    // Raster == tile, then no need for threads
907
0
    if (m_nBlockXSize == nRasterXSize && m_nBlockYSize == nRasterYSize)
908
0
        return;
909
910
0
    const char *pszNumThreads = "";
911
0
    bool bOK = false;
912
0
    const int nThreads = GDALGetNumThreads(
913
0
        papszOptions, "NUM_THREADS", GDAL_DEFAULT_MAX_THREAD_COUNT,
914
0
        /* bDefaultToAllCPUs=*/false, &pszNumThreads, &bOK);
915
0
    if (nThreads > 1)
916
0
    {
917
0
        if ((bUpdateMode && m_nCompression != COMPRESSION_NONE) ||
918
0
            (nBands >= 1 && IsMultiThreadedReadCompatible()))
919
0
        {
920
0
            CPLDebug("GTiff",
921
0
                     "Using up to %d threads for compression/decompression",
922
0
                     nThreads);
923
924
0
            m_poThreadPool = GDALGetGlobalThreadPool(nThreads);
925
0
            if (bUpdateMode && m_poThreadPool)
926
0
                m_poCompressQueue = m_poThreadPool->CreateJobQueue();
927
928
0
            if (m_poCompressQueue != nullptr)
929
0
            {
930
                // Add a margin of an extra job w.r.t thread number
931
                // so as to optimize compression time (enables the main
932
                // thread to do boring I/O while all CPUs are working).
933
0
                m_asCompressionJobs.resize(nThreads + 1);
934
0
                memset(&m_asCompressionJobs[0], 0,
935
0
                       m_asCompressionJobs.size() *
936
0
                           sizeof(GTiffCompressionJob));
937
0
                for (int i = 0;
938
0
                     i < static_cast<int>(m_asCompressionJobs.size()); ++i)
939
0
                {
940
0
                    m_asCompressionJobs[i].pszTmpFilename =
941
0
                        CPLStrdup(VSIMemGenerateHiddenFilename(
942
0
                            CPLSPrintf("thread_job_%d.tif", i)));
943
0
                    m_asCompressionJobs[i].nStripOrTile = -1;
944
0
                }
945
946
                // This is kind of a hack, but basically using
947
                // TIFFWriteRawStrip/Tile and then TIFFReadEncodedStrip/Tile
948
                // does not work on a newly created file, because
949
                // TIFF_MYBUFFER is not set in tif_flags
950
                // (if using TIFFWriteEncodedStrip/Tile first,
951
                // TIFFWriteBufferSetup() is automatically called).
952
                // This should likely rather fixed in libtiff itself.
953
0
                CPL_IGNORE_RET_VAL(TIFFWriteBufferSetup(m_hTIFF, nullptr, -1));
954
0
            }
955
0
        }
956
0
    }
957
0
    else if (!bOK)
958
0
    {
959
0
        ReportError(CE_Warning, CPLE_AppDefined,
960
0
                    "Invalid value for NUM_THREADS: %s", pszNumThreads);
961
0
    }
962
0
}
963
964
/************************************************************************/
965
/*                       ThreadCompressionFunc()                        */
966
/************************************************************************/
967
968
void GTiffDataset::ThreadCompressionFunc(void *pData)
969
0
{
970
0
    GTiffCompressionJob *psJob = static_cast<GTiffCompressionJob *>(pData);
971
0
    GTiffDataset *poDS = psJob->poDS;
972
973
0
    VSILFILE *fpTmp = VSIFOpenL(psJob->pszTmpFilename, "wb+");
974
0
    TIFF *hTIFFTmp = VSI_TIFFOpen(
975
0
        psJob->pszTmpFilename, psJob->bTIFFIsBigEndian ? "wb+" : "wl+", fpTmp);
976
0
    CPLAssert(hTIFFTmp != nullptr);
977
0
    TIFFSetField(hTIFFTmp, TIFFTAG_IMAGEWIDTH, poDS->m_nBlockXSize);
978
0
    TIFFSetField(hTIFFTmp, TIFFTAG_IMAGELENGTH, psJob->nHeight);
979
0
    TIFFSetField(hTIFFTmp, TIFFTAG_BITSPERSAMPLE, poDS->m_nBitsPerSample);
980
0
    TIFFSetField(hTIFFTmp, TIFFTAG_COMPRESSION, poDS->m_nCompression);
981
0
    TIFFSetField(hTIFFTmp, TIFFTAG_PHOTOMETRIC, poDS->m_nPhotometric);
982
0
    TIFFSetField(hTIFFTmp, TIFFTAG_SAMPLEFORMAT, poDS->m_nSampleFormat);
983
0
    TIFFSetField(hTIFFTmp, TIFFTAG_SAMPLESPERPIXEL, poDS->m_nSamplesPerPixel);
984
0
    TIFFSetField(hTIFFTmp, TIFFTAG_ROWSPERSTRIP, poDS->m_nBlockYSize);
985
0
    TIFFSetField(hTIFFTmp, TIFFTAG_PLANARCONFIG, poDS->m_nPlanarConfig);
986
0
    if (psJob->nPredictor != PREDICTOR_NONE)
987
0
        TIFFSetField(hTIFFTmp, TIFFTAG_PREDICTOR, psJob->nPredictor);
988
0
    if (poDS->m_nCompression == COMPRESSION_LERC)
989
0
    {
990
0
        TIFFSetField(hTIFFTmp, TIFFTAG_LERC_PARAMETERS, 2,
991
0
                     poDS->m_anLercAddCompressionAndVersion);
992
0
    }
993
0
    if (psJob->nExtraSampleCount)
994
0
    {
995
0
        TIFFSetField(hTIFFTmp, TIFFTAG_EXTRASAMPLES, psJob->nExtraSampleCount,
996
0
                     psJob->pExtraSamples);
997
0
    }
998
999
0
    poDS->RestoreVolatileParameters(hTIFFTmp);
1000
1001
0
    bool bOK = TIFFWriteEncodedStrip(hTIFFTmp, 0, psJob->pabyBuffer,
1002
0
                                     psJob->nBufferSize) == psJob->nBufferSize;
1003
1004
0
    toff_t nOffset = 0;
1005
0
    if (bOK)
1006
0
    {
1007
0
        toff_t *panOffsets = nullptr;
1008
0
        toff_t *panByteCounts = nullptr;
1009
0
        TIFFGetField(hTIFFTmp, TIFFTAG_STRIPOFFSETS, &panOffsets);
1010
0
        TIFFGetField(hTIFFTmp, TIFFTAG_STRIPBYTECOUNTS, &panByteCounts);
1011
1012
0
        nOffset = panOffsets[0];
1013
0
        psJob->nCompressedBufferSize =
1014
0
            static_cast<GPtrDiff_t>(panByteCounts[0]);
1015
0
    }
1016
0
    else
1017
0
    {
1018
0
        CPLError(CE_Failure, CPLE_AppDefined,
1019
0
                 "Error when compressing strip/tile %d", psJob->nStripOrTile);
1020
0
    }
1021
1022
0
    XTIFFClose(hTIFFTmp);
1023
0
    if (VSIFCloseL(fpTmp) != 0)
1024
0
    {
1025
0
        if (bOK)
1026
0
        {
1027
0
            bOK = false;
1028
0
            CPLError(CE_Failure, CPLE_AppDefined,
1029
0
                     "Error when compressing strip/tile %d",
1030
0
                     psJob->nStripOrTile);
1031
0
        }
1032
0
    }
1033
1034
0
    if (bOK)
1035
0
    {
1036
0
        vsi_l_offset nFileSize = 0;
1037
0
        GByte *pabyCompressedBuffer =
1038
0
            VSIGetMemFileBuffer(psJob->pszTmpFilename, &nFileSize, FALSE);
1039
0
        CPLAssert(static_cast<vsi_l_offset>(
1040
0
                      nOffset + psJob->nCompressedBufferSize) <= nFileSize);
1041
0
        psJob->pabyCompressedBuffer = pabyCompressedBuffer + nOffset;
1042
0
    }
1043
0
    else
1044
0
    {
1045
0
        psJob->pabyCompressedBuffer = nullptr;
1046
0
        psJob->nCompressedBufferSize = 0;
1047
0
    }
1048
1049
0
    auto poMainDS = poDS->m_poBaseDS ? poDS->m_poBaseDS : poDS;
1050
0
    if (poMainDS->m_poCompressQueue)
1051
0
    {
1052
0
        std::lock_guard oLock(poMainDS->m_oCompressThreadPoolMutex);
1053
0
        psJob->bReady = true;
1054
0
    }
1055
0
}
1056
1057
/************************************************************************/
1058
/*                        WriteRawStripOrTile()                         */
1059
/************************************************************************/
1060
1061
void GTiffDataset::WriteRawStripOrTile(int nStripOrTile,
1062
                                       GByte *pabyCompressedBuffer,
1063
                                       GPtrDiff_t nCompressedBufferSize)
1064
0
{
1065
#ifdef DEBUG_VERBOSE
1066
    CPLDebug("GTIFF", "Writing raw strip/tile %d, size " CPL_FRMT_GUIB,
1067
             nStripOrTile, static_cast<GUIntBig>(nCompressedBufferSize));
1068
#endif
1069
0
    toff_t *panOffsets = nullptr;
1070
0
    toff_t *panByteCounts = nullptr;
1071
0
    bool bWriteAtEnd = true;
1072
0
    bool bWriteLeader = m_bLeaderSizeAsUInt4;
1073
0
    bool bWriteTrailer = m_bTrailerRepeatedLast4BytesRepeated;
1074
0
    if (TIFFGetField(m_hTIFF,
1075
0
                     TIFFIsTiled(m_hTIFF) ? TIFFTAG_TILEOFFSETS
1076
0
                                          : TIFFTAG_STRIPOFFSETS,
1077
0
                     &panOffsets) &&
1078
0
        panOffsets != nullptr && panOffsets[nStripOrTile] != 0)
1079
0
    {
1080
        // Forces TIFFAppendStrip() to consider if the location of the
1081
        // tile/strip can be reused or if the strile should be written at end of
1082
        // file.
1083
0
        TIFFSetWriteOffset(m_hTIFF, 0);
1084
1085
0
        if (m_bBlockOrderRowMajor)
1086
0
        {
1087
0
            if (TIFFGetField(m_hTIFF,
1088
0
                             TIFFIsTiled(m_hTIFF) ? TIFFTAG_TILEBYTECOUNTS
1089
0
                                                  : TIFFTAG_STRIPBYTECOUNTS,
1090
0
                             &panByteCounts) &&
1091
0
                panByteCounts != nullptr)
1092
0
            {
1093
0
                if (static_cast<GUIntBig>(nCompressedBufferSize) >
1094
0
                    panByteCounts[nStripOrTile])
1095
0
                {
1096
0
                    GTiffDataset *poRootDS = m_poBaseDS ? m_poBaseDS : this;
1097
0
                    if (!poRootDS->m_bKnownIncompatibleEdition &&
1098
0
                        !poRootDS->m_bWriteKnownIncompatibleEdition)
1099
0
                    {
1100
0
                        ReportError(
1101
0
                            CE_Warning, CPLE_AppDefined,
1102
0
                            "A strile cannot be rewritten in place, which "
1103
0
                            "invalidates the BLOCK_ORDER optimization.");
1104
0
                        poRootDS->m_bKnownIncompatibleEdition = true;
1105
0
                        poRootDS->m_bWriteKnownIncompatibleEdition = true;
1106
0
                    }
1107
0
                }
1108
                // For mask interleaving, if the size is not exactly the same,
1109
                // completely give up (we could potentially move the mask in
1110
                // case the imagery is smaller)
1111
0
                else if (m_poMaskDS && m_bMaskInterleavedWithImagery &&
1112
0
                         static_cast<GUIntBig>(nCompressedBufferSize) !=
1113
0
                             panByteCounts[nStripOrTile])
1114
0
                {
1115
0
                    GTiffDataset *poRootDS = m_poBaseDS ? m_poBaseDS : this;
1116
0
                    if (!poRootDS->m_bKnownIncompatibleEdition &&
1117
0
                        !poRootDS->m_bWriteKnownIncompatibleEdition)
1118
0
                    {
1119
0
                        ReportError(
1120
0
                            CE_Warning, CPLE_AppDefined,
1121
0
                            "A strile cannot be rewritten in place, which "
1122
0
                            "invalidates the MASK_INTERLEAVED_WITH_IMAGERY "
1123
0
                            "optimization.");
1124
0
                        poRootDS->m_bKnownIncompatibleEdition = true;
1125
0
                        poRootDS->m_bWriteKnownIncompatibleEdition = true;
1126
0
                    }
1127
0
                    bWriteLeader = false;
1128
0
                    bWriteTrailer = false;
1129
0
                    if (m_bLeaderSizeAsUInt4)
1130
0
                    {
1131
                        // If there was a valid leader, invalidat it
1132
0
                        VSI_TIFFSeek(m_hTIFF, panOffsets[nStripOrTile] - 4,
1133
0
                                     SEEK_SET);
1134
0
                        uint32_t nOldSize;
1135
0
                        VSIFReadL(&nOldSize, 1, 4,
1136
0
                                  VSI_TIFFGetVSILFile(TIFFClientdata(m_hTIFF)));
1137
0
                        CPL_LSBPTR32(&nOldSize);
1138
0
                        if (nOldSize == panByteCounts[nStripOrTile])
1139
0
                        {
1140
0
                            uint32_t nInvalidatedSize = 0;
1141
0
                            VSI_TIFFSeek(m_hTIFF, panOffsets[nStripOrTile] - 4,
1142
0
                                         SEEK_SET);
1143
0
                            VSI_TIFFWrite(m_hTIFF, &nInvalidatedSize,
1144
0
                                          sizeof(nInvalidatedSize));
1145
0
                        }
1146
0
                    }
1147
0
                }
1148
0
                else
1149
0
                {
1150
0
                    bWriteAtEnd = false;
1151
0
                }
1152
0
            }
1153
0
        }
1154
0
    }
1155
0
    if (bWriteLeader &&
1156
0
        static_cast<GUIntBig>(nCompressedBufferSize) <= 0xFFFFFFFFU)
1157
0
    {
1158
        // cppcheck-suppress knownConditionTrueFalse
1159
0
        if (bWriteAtEnd)
1160
0
        {
1161
0
            VSI_TIFFSeek(m_hTIFF, 0, SEEK_END);
1162
0
        }
1163
0
        else
1164
0
        {
1165
            // If we rewrite an existing strile in place with an existing
1166
            // leader, check that the leader is valid, before rewriting it. And
1167
            // if it is not valid, then do not write the trailer, as we could
1168
            // corrupt other data.
1169
0
            VSI_TIFFSeek(m_hTIFF, panOffsets[nStripOrTile] - 4, SEEK_SET);
1170
0
            uint32_t nOldSize;
1171
0
            VSIFReadL(&nOldSize, 1, 4,
1172
0
                      VSI_TIFFGetVSILFile(TIFFClientdata(m_hTIFF)));
1173
0
            CPL_LSBPTR32(&nOldSize);
1174
0
            bWriteLeader =
1175
0
                panByteCounts && nOldSize == panByteCounts[nStripOrTile];
1176
0
            bWriteTrailer = bWriteLeader;
1177
0
            VSI_TIFFSeek(m_hTIFF, panOffsets[nStripOrTile] - 4, SEEK_SET);
1178
0
        }
1179
        // cppcheck-suppress knownConditionTrueFalse
1180
0
        if (bWriteLeader)
1181
0
        {
1182
0
            uint32_t nSize = static_cast<uint32_t>(nCompressedBufferSize);
1183
0
            CPL_LSBPTR32(&nSize);
1184
0
            if (!VSI_TIFFWrite(m_hTIFF, &nSize, sizeof(nSize)))
1185
0
                m_bWriteError = true;
1186
0
        }
1187
0
    }
1188
0
    tmsize_t written;
1189
0
    if (TIFFIsTiled(m_hTIFF))
1190
0
        written = TIFFWriteRawTile(m_hTIFF, nStripOrTile, pabyCompressedBuffer,
1191
0
                                   nCompressedBufferSize);
1192
0
    else
1193
0
        written = TIFFWriteRawStrip(m_hTIFF, nStripOrTile, pabyCompressedBuffer,
1194
0
                                    nCompressedBufferSize);
1195
0
    if (written != nCompressedBufferSize)
1196
0
        m_bWriteError = true;
1197
0
    if (bWriteTrailer &&
1198
0
        static_cast<GUIntBig>(nCompressedBufferSize) <= 0xFFFFFFFFU)
1199
0
    {
1200
0
        GByte abyLastBytes[4] = {};
1201
0
        if (nCompressedBufferSize >= 4)
1202
0
            memcpy(abyLastBytes,
1203
0
                   pabyCompressedBuffer + nCompressedBufferSize - 4, 4);
1204
0
        else
1205
0
            memcpy(abyLastBytes, pabyCompressedBuffer, nCompressedBufferSize);
1206
0
        if (!VSI_TIFFWrite(m_hTIFF, abyLastBytes, 4))
1207
0
            m_bWriteError = true;
1208
0
    }
1209
0
}
1210
1211
/************************************************************************/
1212
/*                      WaitCompletionForJobIdx()                       */
1213
/************************************************************************/
1214
1215
void GTiffDataset::WaitCompletionForJobIdx(int i)
1216
0
{
1217
0
    auto poMainDS = m_poBaseDS ? m_poBaseDS : this;
1218
0
    auto poQueue = poMainDS->m_poCompressQueue.get();
1219
0
    auto &oQueue = poMainDS->m_asQueueJobIdx;
1220
0
    auto &asJobs = poMainDS->m_asCompressionJobs;
1221
0
    auto &mutex = poMainDS->m_oCompressThreadPoolMutex;
1222
1223
0
    CPLAssert(i >= 0 && static_cast<size_t>(i) < asJobs.size());
1224
0
    CPLAssert(asJobs[i].nStripOrTile >= 0);
1225
0
    CPLAssert(!oQueue.empty());
1226
1227
0
    bool bHasWarned = false;
1228
0
    while (true)
1229
0
    {
1230
0
        bool bReady;
1231
0
        {
1232
0
            std::lock_guard oLock(mutex);
1233
0
            bReady = asJobs[i].bReady;
1234
0
        }
1235
0
        if (!bReady)
1236
0
        {
1237
0
            if (!bHasWarned)
1238
0
            {
1239
0
                CPLDebug("GTIFF",
1240
0
                         "Waiting for worker job to finish handling block %d",
1241
0
                         asJobs[i].nStripOrTile);
1242
0
                bHasWarned = true;
1243
0
            }
1244
0
            poQueue->GetPool()->WaitEvent();
1245
0
        }
1246
0
        else
1247
0
        {
1248
0
            break;
1249
0
        }
1250
0
    }
1251
1252
0
    if (asJobs[i].nCompressedBufferSize)
1253
0
    {
1254
0
        asJobs[i].poDS->WriteRawStripOrTile(asJobs[i].nStripOrTile,
1255
0
                                            asJobs[i].pabyCompressedBuffer,
1256
0
                                            asJobs[i].nCompressedBufferSize);
1257
0
    }
1258
0
    asJobs[i].pabyCompressedBuffer = nullptr;
1259
0
    asJobs[i].nBufferSize = 0;
1260
0
    {
1261
        // Likely useless, but makes Coverity happy
1262
0
        std::lock_guard oLock(mutex);
1263
0
        asJobs[i].bReady = false;
1264
0
    }
1265
0
    asJobs[i].nStripOrTile = -1;
1266
0
    oQueue.pop();
1267
0
}
1268
1269
/************************************************************************/
1270
/*                       WaitCompletionForBlock()                       */
1271
/************************************************************************/
1272
1273
void GTiffDataset::WaitCompletionForBlock(int nBlockId)
1274
0
{
1275
0
    auto poQueue = m_poBaseDS ? m_poBaseDS->m_poCompressQueue.get()
1276
0
                              : m_poCompressQueue.get();
1277
    // cppcheck-suppress constVariableReference
1278
0
    auto &oQueue = m_poBaseDS ? m_poBaseDS->m_asQueueJobIdx : m_asQueueJobIdx;
1279
    // cppcheck-suppress constVariableReference
1280
0
    auto &asJobs =
1281
0
        m_poBaseDS ? m_poBaseDS->m_asCompressionJobs : m_asCompressionJobs;
1282
1283
0
    if (poQueue != nullptr && !oQueue.empty())
1284
0
    {
1285
0
        for (int i = 0; i < static_cast<int>(asJobs.size()); ++i)
1286
0
        {
1287
0
            if (asJobs[i].poDS == this && asJobs[i].nStripOrTile == nBlockId)
1288
0
            {
1289
0
                while (!oQueue.empty() &&
1290
0
                       !(asJobs[oQueue.front()].poDS == this &&
1291
0
                         asJobs[oQueue.front()].nStripOrTile == nBlockId))
1292
0
                {
1293
0
                    WaitCompletionForJobIdx(oQueue.front());
1294
0
                }
1295
0
                CPLAssert(!oQueue.empty() &&
1296
0
                          asJobs[oQueue.front()].poDS == this &&
1297
0
                          asJobs[oQueue.front()].nStripOrTile == nBlockId);
1298
0
                WaitCompletionForJobIdx(oQueue.front());
1299
0
            }
1300
0
        }
1301
0
    }
1302
0
}
1303
1304
/************************************************************************/
1305
/*                        SubmitCompressionJob()                        */
1306
/************************************************************************/
1307
1308
bool GTiffDataset::SubmitCompressionJob(int nStripOrTile, GByte *pabyData,
1309
                                        GPtrDiff_t cc, int nHeight)
1310
0
{
1311
    /* -------------------------------------------------------------------- */
1312
    /*      Should we do compression in a worker thread ?                   */
1313
    /* -------------------------------------------------------------------- */
1314
0
    auto poQueue = m_poBaseDS ? m_poBaseDS->m_poCompressQueue.get()
1315
0
                              : m_poCompressQueue.get();
1316
1317
0
    if (poQueue && m_nCompression == COMPRESSION_NONE)
1318
0
    {
1319
        // We don't do multi-threaded compression for uncompressed...
1320
        // but we must wait for other related compression tasks (e.g mask)
1321
        // to be completed
1322
0
        poQueue->WaitCompletion();
1323
1324
        // Flush remaining data
1325
        // cppcheck-suppress constVariableReference
1326
0
        auto &oQueue =
1327
0
            m_poBaseDS ? m_poBaseDS->m_asQueueJobIdx : m_asQueueJobIdx;
1328
0
        while (!oQueue.empty())
1329
0
        {
1330
0
            WaitCompletionForJobIdx(oQueue.front());
1331
0
        }
1332
0
    }
1333
1334
0
    const auto SetupJob =
1335
0
        [this, pabyData, cc, nHeight, nStripOrTile](GTiffCompressionJob &sJob)
1336
0
    {
1337
0
        sJob.poDS = this;
1338
0
        sJob.bTIFFIsBigEndian = CPL_TO_BOOL(TIFFIsBigEndian(m_hTIFF));
1339
0
        GByte *pabyBuffer =
1340
0
            static_cast<GByte *>(VSI_REALLOC_VERBOSE(sJob.pabyBuffer, cc));
1341
0
        if (!pabyBuffer)
1342
0
            return false;
1343
0
        sJob.pabyBuffer = pabyBuffer;
1344
0
        memcpy(sJob.pabyBuffer, pabyData, cc);
1345
0
        sJob.nBufferSize = cc;
1346
0
        sJob.nHeight = nHeight;
1347
0
        sJob.nStripOrTile = nStripOrTile;
1348
0
        sJob.nPredictor = PREDICTOR_NONE;
1349
0
        if (GTIFFSupportsPredictor(m_nCompression))
1350
0
        {
1351
0
            TIFFGetField(m_hTIFF, TIFFTAG_PREDICTOR, &sJob.nPredictor);
1352
0
        }
1353
1354
0
        sJob.pExtraSamples = nullptr;
1355
0
        sJob.nExtraSampleCount = 0;
1356
0
        TIFFGetField(m_hTIFF, TIFFTAG_EXTRASAMPLES, &sJob.nExtraSampleCount,
1357
0
                     &sJob.pExtraSamples);
1358
0
        return true;
1359
0
    };
1360
1361
0
    if (poQueue == nullptr || !(m_nCompression == COMPRESSION_ADOBE_DEFLATE ||
1362
0
                                m_nCompression == COMPRESSION_LZW ||
1363
0
                                m_nCompression == COMPRESSION_PACKBITS ||
1364
0
                                m_nCompression == COMPRESSION_LZMA ||
1365
0
                                m_nCompression == COMPRESSION_ZSTD ||
1366
0
                                m_nCompression == COMPRESSION_LERC ||
1367
0
                                m_nCompression == COMPRESSION_JXL ||
1368
0
                                m_nCompression == COMPRESSION_JXL_DNG_1_7 ||
1369
0
                                m_nCompression == COMPRESSION_WEBP ||
1370
0
                                m_nCompression == COMPRESSION_JPEG))
1371
0
    {
1372
0
        if (m_bBlockOrderRowMajor || m_bLeaderSizeAsUInt4 ||
1373
0
            m_bTrailerRepeatedLast4BytesRepeated)
1374
0
        {
1375
0
            GTiffCompressionJob sJob;
1376
0
            memset(&sJob, 0, sizeof(sJob));
1377
0
            if (SetupJob(sJob))
1378
0
            {
1379
0
                sJob.pszTmpFilename =
1380
0
                    CPLStrdup(VSIMemGenerateHiddenFilename("temp.tif"));
1381
1382
0
                ThreadCompressionFunc(&sJob);
1383
1384
0
                if (sJob.nCompressedBufferSize)
1385
0
                {
1386
0
                    sJob.poDS->WriteRawStripOrTile(sJob.nStripOrTile,
1387
0
                                                   sJob.pabyCompressedBuffer,
1388
0
                                                   sJob.nCompressedBufferSize);
1389
0
                }
1390
1391
0
                CPLFree(sJob.pabyBuffer);
1392
0
                VSIUnlink(sJob.pszTmpFilename);
1393
0
                CPLFree(sJob.pszTmpFilename);
1394
0
                return sJob.nCompressedBufferSize > 0 && !m_bWriteError;
1395
0
            }
1396
0
        }
1397
1398
0
        return false;
1399
0
    }
1400
1401
0
    auto poMainDS = m_poBaseDS ? m_poBaseDS : this;
1402
0
    auto &oQueue = poMainDS->m_asQueueJobIdx;
1403
0
    auto &asJobs = poMainDS->m_asCompressionJobs;
1404
1405
0
    int nNextCompressionJobAvail = -1;
1406
1407
0
    if (oQueue.size() == asJobs.size())
1408
0
    {
1409
0
        CPLAssert(!oQueue.empty());
1410
0
        nNextCompressionJobAvail = oQueue.front();
1411
0
        WaitCompletionForJobIdx(nNextCompressionJobAvail);
1412
0
    }
1413
0
    else
1414
0
    {
1415
0
        const int nJobs = static_cast<int>(asJobs.size());
1416
0
        for (int i = 0; i < nJobs; ++i)
1417
0
        {
1418
0
            if (asJobs[i].nBufferSize == 0)
1419
0
            {
1420
0
                nNextCompressionJobAvail = i;
1421
0
                break;
1422
0
            }
1423
0
        }
1424
0
    }
1425
0
    CPLAssert(nNextCompressionJobAvail >= 0);
1426
1427
0
    GTiffCompressionJob *psJob = &asJobs[nNextCompressionJobAvail];
1428
0
    bool bOK = SetupJob(*psJob);
1429
0
    if (bOK)
1430
0
    {
1431
0
        poQueue->SubmitJob(ThreadCompressionFunc, psJob);
1432
0
        oQueue.push(nNextCompressionJobAvail);
1433
0
    }
1434
1435
0
    return bOK;
1436
0
}
1437
1438
/************************************************************************/
1439
/*                             DiscardLsb()                             */
1440
/************************************************************************/
1441
1442
template <class T> bool MustNotDiscardLsb(T value, bool bHasNoData, T nodata)
1443
0
{
1444
0
    return bHasNoData && value == nodata;
1445
0
}
Unexecuted instantiation: bool MustNotDiscardLsb<signed char>(signed char, bool, signed char)
Unexecuted instantiation: bool MustNotDiscardLsb<short>(short, bool, short)
Unexecuted instantiation: bool MustNotDiscardLsb<unsigned short>(unsigned short, bool, unsigned short)
Unexecuted instantiation: bool MustNotDiscardLsb<int>(int, bool, int)
Unexecuted instantiation: bool MustNotDiscardLsb<unsigned int>(unsigned int, bool, unsigned int)
Unexecuted instantiation: bool MustNotDiscardLsb<long>(long, bool, long)
Unexecuted instantiation: bool MustNotDiscardLsb<unsigned long>(unsigned long, bool, unsigned long)
Unexecuted instantiation: bool MustNotDiscardLsb<cpl::Float16>(cpl::Float16, bool, cpl::Float16)
1446
1447
template <>
1448
bool MustNotDiscardLsb<float>(float value, bool bHasNoData, float nodata)
1449
0
{
1450
0
    return (bHasNoData && value == nodata) || !std::isfinite(value);
1451
0
}
1452
1453
template <>
1454
bool MustNotDiscardLsb<double>(double value, bool bHasNoData, double nodata)
1455
0
{
1456
0
    return (bHasNoData && value == nodata) || !std::isfinite(value);
1457
0
}
1458
1459
template <class T> T AdjustValue(T value, uint64_t nRoundUpBitTest);
1460
1461
template <class T> T AdjustValueInt(T value, uint64_t nRoundUpBitTest)
1462
0
{
1463
0
    if (value >=
1464
0
        static_cast<T>(std::numeric_limits<T>::max() - (nRoundUpBitTest << 1)))
1465
0
        return static_cast<T>(value - (nRoundUpBitTest << 1));
1466
0
    return static_cast<T>(value + (nRoundUpBitTest << 1));
1467
0
}
Unexecuted instantiation: signed char AdjustValueInt<signed char>(signed char, unsigned long)
Unexecuted instantiation: unsigned char AdjustValueInt<unsigned char>(unsigned char, unsigned long)
Unexecuted instantiation: short AdjustValueInt<short>(short, unsigned long)
Unexecuted instantiation: unsigned short AdjustValueInt<unsigned short>(unsigned short, unsigned long)
Unexecuted instantiation: int AdjustValueInt<int>(int, unsigned long)
Unexecuted instantiation: unsigned int AdjustValueInt<unsigned int>(unsigned int, unsigned long)
Unexecuted instantiation: long AdjustValueInt<long>(long, unsigned long)
Unexecuted instantiation: unsigned long AdjustValueInt<unsigned long>(unsigned long, unsigned long)
1468
1469
template <> int8_t AdjustValue<int8_t>(int8_t value, uint64_t nRoundUpBitTest)
1470
0
{
1471
0
    return AdjustValueInt(value, nRoundUpBitTest);
1472
0
}
1473
1474
template <>
1475
uint8_t AdjustValue<uint8_t>(uint8_t value, uint64_t nRoundUpBitTest)
1476
0
{
1477
0
    return AdjustValueInt(value, nRoundUpBitTest);
1478
0
}
1479
1480
template <>
1481
int16_t AdjustValue<int16_t>(int16_t value, uint64_t nRoundUpBitTest)
1482
0
{
1483
0
    return AdjustValueInt(value, nRoundUpBitTest);
1484
0
}
1485
1486
template <>
1487
uint16_t AdjustValue<uint16_t>(uint16_t value, uint64_t nRoundUpBitTest)
1488
0
{
1489
0
    return AdjustValueInt(value, nRoundUpBitTest);
1490
0
}
1491
1492
template <>
1493
int32_t AdjustValue<int32_t>(int32_t value, uint64_t nRoundUpBitTest)
1494
0
{
1495
0
    return AdjustValueInt(value, nRoundUpBitTest);
1496
0
}
1497
1498
template <>
1499
uint32_t AdjustValue<uint32_t>(uint32_t value, uint64_t nRoundUpBitTest)
1500
0
{
1501
0
    return AdjustValueInt(value, nRoundUpBitTest);
1502
0
}
1503
1504
template <>
1505
int64_t AdjustValue<int64_t>(int64_t value, uint64_t nRoundUpBitTest)
1506
0
{
1507
0
    return AdjustValueInt(value, nRoundUpBitTest);
1508
0
}
1509
1510
template <>
1511
uint64_t AdjustValue<uint64_t>(uint64_t value, uint64_t nRoundUpBitTest)
1512
0
{
1513
0
    return AdjustValueInt(value, nRoundUpBitTest);
1514
0
}
1515
1516
template <> GFloat16 AdjustValue<GFloat16>(GFloat16 value, uint64_t)
1517
0
{
1518
0
    using std::nextafter;
1519
0
    return nextafter(value, cpl::NumericLimits<GFloat16>::max());
1520
0
}
1521
1522
template <> float AdjustValue<float>(float value, uint64_t)
1523
0
{
1524
0
    return std::nextafter(value, std::numeric_limits<float>::max());
1525
0
}
1526
1527
template <> double AdjustValue<double>(double value, uint64_t)
1528
0
{
1529
0
    return std::nextafter(value, std::numeric_limits<double>::max());
1530
0
}
1531
1532
template <class Teffective, class T>
1533
T RoundValueDiscardLsb(const void *ptr, uint64_t nMask,
1534
                       uint64_t nRoundUpBitTest);
1535
1536
template <class T>
1537
T RoundValueDiscardLsbUnsigned(const void *ptr, uint64_t nMask,
1538
                               uint64_t nRoundUpBitTest)
1539
0
{
1540
0
    if ((*reinterpret_cast<const T *>(ptr) & nMask) >
1541
0
        static_cast<uint64_t>(std::numeric_limits<T>::max()) -
1542
0
            (nRoundUpBitTest << 1U))
1543
0
    {
1544
0
        return static_cast<T>(std::numeric_limits<T>::max() & nMask);
1545
0
    }
1546
0
    const uint64_t newval =
1547
0
        (*reinterpret_cast<const T *>(ptr) & nMask) + (nRoundUpBitTest << 1U);
1548
0
    return static_cast<T>(newval);
1549
0
}
Unexecuted instantiation: unsigned short RoundValueDiscardLsbUnsigned<unsigned short>(void const*, unsigned long, unsigned long)
Unexecuted instantiation: unsigned int RoundValueDiscardLsbUnsigned<unsigned int>(void const*, unsigned long, unsigned long)
Unexecuted instantiation: unsigned long RoundValueDiscardLsbUnsigned<unsigned long>(void const*, unsigned long, unsigned long)
1550
1551
template <class T>
1552
T RoundValueDiscardLsbSigned(const void *ptr, uint64_t nMask,
1553
                             uint64_t nRoundUpBitTest)
1554
0
{
1555
0
    T oldval = *reinterpret_cast<const T *>(ptr);
1556
0
    if (oldval < 0)
1557
0
    {
1558
0
        return static_cast<T>(oldval & nMask);
1559
0
    }
1560
0
    const uint64_t newval =
1561
0
        (*reinterpret_cast<const T *>(ptr) & nMask) + (nRoundUpBitTest << 1U);
1562
0
    if (newval > static_cast<uint64_t>(std::numeric_limits<T>::max()))
1563
0
        return static_cast<T>(std::numeric_limits<T>::max() & nMask);
1564
0
    return static_cast<T>(newval);
1565
0
}
Unexecuted instantiation: signed char RoundValueDiscardLsbSigned<signed char>(void const*, unsigned long, unsigned long)
Unexecuted instantiation: short RoundValueDiscardLsbSigned<short>(void const*, unsigned long, unsigned long)
Unexecuted instantiation: int RoundValueDiscardLsbSigned<int>(void const*, unsigned long, unsigned long)
Unexecuted instantiation: long RoundValueDiscardLsbSigned<long>(void const*, unsigned long, unsigned long)
1566
1567
template <>
1568
uint16_t RoundValueDiscardLsb<uint16_t, uint16_t>(const void *ptr,
1569
                                                  uint64_t nMask,
1570
                                                  uint64_t nRoundUpBitTest)
1571
0
{
1572
0
    return RoundValueDiscardLsbUnsigned<uint16_t>(ptr, nMask, nRoundUpBitTest);
1573
0
}
1574
1575
template <>
1576
uint32_t RoundValueDiscardLsb<uint32_t, uint32_t>(const void *ptr,
1577
                                                  uint64_t nMask,
1578
                                                  uint64_t nRoundUpBitTest)
1579
0
{
1580
0
    return RoundValueDiscardLsbUnsigned<uint32_t>(ptr, nMask, nRoundUpBitTest);
1581
0
}
1582
1583
template <>
1584
uint64_t RoundValueDiscardLsb<uint64_t, uint64_t>(const void *ptr,
1585
                                                  uint64_t nMask,
1586
                                                  uint64_t nRoundUpBitTest)
1587
0
{
1588
0
    return RoundValueDiscardLsbUnsigned<uint64_t>(ptr, nMask, nRoundUpBitTest);
1589
0
}
1590
1591
template <>
1592
int8_t RoundValueDiscardLsb<int8_t, int8_t>(const void *ptr, uint64_t nMask,
1593
                                            uint64_t nRoundUpBitTest)
1594
0
{
1595
0
    return RoundValueDiscardLsbSigned<int8_t>(ptr, nMask, nRoundUpBitTest);
1596
0
}
1597
1598
template <>
1599
int16_t RoundValueDiscardLsb<int16_t, int16_t>(const void *ptr, uint64_t nMask,
1600
                                               uint64_t nRoundUpBitTest)
1601
0
{
1602
0
    return RoundValueDiscardLsbSigned<int16_t>(ptr, nMask, nRoundUpBitTest);
1603
0
}
1604
1605
template <>
1606
int32_t RoundValueDiscardLsb<int32_t, int32_t>(const void *ptr, uint64_t nMask,
1607
                                               uint64_t nRoundUpBitTest)
1608
0
{
1609
0
    return RoundValueDiscardLsbSigned<int32_t>(ptr, nMask, nRoundUpBitTest);
1610
0
}
1611
1612
template <>
1613
int64_t RoundValueDiscardLsb<int64_t, int64_t>(const void *ptr, uint64_t nMask,
1614
                                               uint64_t nRoundUpBitTest)
1615
0
{
1616
0
    return RoundValueDiscardLsbSigned<int64_t>(ptr, nMask, nRoundUpBitTest);
1617
0
}
1618
1619
template <>
1620
uint16_t RoundValueDiscardLsb<GFloat16, uint16_t>(const void *ptr,
1621
                                                  uint64_t nMask,
1622
                                                  uint64_t nRoundUpBitTest)
1623
0
{
1624
0
    return RoundValueDiscardLsbUnsigned<uint16_t>(ptr, nMask, nRoundUpBitTest);
1625
0
}
1626
1627
template <>
1628
uint32_t RoundValueDiscardLsb<float, uint32_t>(const void *ptr, uint64_t nMask,
1629
                                               uint64_t nRoundUpBitTest)
1630
0
{
1631
0
    return RoundValueDiscardLsbUnsigned<uint32_t>(ptr, nMask, nRoundUpBitTest);
1632
0
}
1633
1634
template <>
1635
uint64_t RoundValueDiscardLsb<double, uint64_t>(const void *ptr, uint64_t nMask,
1636
                                                uint64_t nRoundUpBitTest)
1637
0
{
1638
0
    return RoundValueDiscardLsbUnsigned<uint64_t>(ptr, nMask, nRoundUpBitTest);
1639
0
}
1640
1641
template <class Teffective, class T>
1642
static void DiscardLsbT(GByte *pabyBuffer, size_t nBytes, int iBand, int nBands,
1643
                        uint16_t nPlanarConfig,
1644
                        const GTiffDataset::MaskOffset *panMaskOffsetLsb,
1645
                        bool bHasNoData, Teffective nNoDataValue)
1646
0
{
1647
0
    static_assert(sizeof(Teffective) == sizeof(T),
1648
0
                  "sizeof(Teffective) == sizeof(T)");
1649
0
    if (nPlanarConfig == PLANARCONFIG_SEPARATE)
1650
0
    {
1651
0
        const auto nMask = panMaskOffsetLsb[iBand].nMask;
1652
0
        const auto nRoundUpBitTest = panMaskOffsetLsb[iBand].nRoundUpBitTest;
1653
0
        for (size_t i = 0; i < nBytes / sizeof(T); ++i)
1654
0
        {
1655
0
            if (MustNotDiscardLsb(reinterpret_cast<Teffective *>(pabyBuffer)[i],
1656
0
                                  bHasNoData, nNoDataValue))
1657
0
            {
1658
0
                continue;
1659
0
            }
1660
1661
0
            if (reinterpret_cast<T *>(pabyBuffer)[i] & nRoundUpBitTest)
1662
0
            {
1663
0
                reinterpret_cast<T *>(pabyBuffer)[i] =
1664
0
                    RoundValueDiscardLsb<Teffective, T>(
1665
0
                        &(reinterpret_cast<T *>(pabyBuffer)[i]), nMask,
1666
0
                        nRoundUpBitTest);
1667
0
            }
1668
0
            else
1669
0
            {
1670
0
                reinterpret_cast<T *>(pabyBuffer)[i] = static_cast<T>(
1671
0
                    reinterpret_cast<T *>(pabyBuffer)[i] & nMask);
1672
0
            }
1673
1674
            // Make sure that by discarding LSB we don't end up to a value
1675
            // that is no the nodata value
1676
0
            if (MustNotDiscardLsb(reinterpret_cast<Teffective *>(pabyBuffer)[i],
1677
0
                                  bHasNoData, nNoDataValue))
1678
0
            {
1679
0
                reinterpret_cast<Teffective *>(pabyBuffer)[i] =
1680
0
                    AdjustValue(nNoDataValue, nRoundUpBitTest);
1681
0
            }
1682
0
        }
1683
0
    }
1684
0
    else
1685
0
    {
1686
0
        for (size_t i = 0; i < nBytes / sizeof(T); i += nBands)
1687
0
        {
1688
0
            for (int j = 0; j < nBands; ++j)
1689
0
            {
1690
0
                if (MustNotDiscardLsb(
1691
0
                        reinterpret_cast<Teffective *>(pabyBuffer)[i + j],
1692
0
                        bHasNoData, nNoDataValue))
1693
0
                {
1694
0
                    continue;
1695
0
                }
1696
1697
0
                if (reinterpret_cast<T *>(pabyBuffer)[i + j] &
1698
0
                    panMaskOffsetLsb[j].nRoundUpBitTest)
1699
0
                {
1700
0
                    reinterpret_cast<T *>(pabyBuffer)[i + j] =
1701
0
                        RoundValueDiscardLsb<Teffective, T>(
1702
0
                            &(reinterpret_cast<T *>(pabyBuffer)[i + j]),
1703
0
                            panMaskOffsetLsb[j].nMask,
1704
0
                            panMaskOffsetLsb[j].nRoundUpBitTest);
1705
0
                }
1706
0
                else
1707
0
                {
1708
0
                    reinterpret_cast<T *>(pabyBuffer)[i + j] = static_cast<T>(
1709
0
                        (reinterpret_cast<T *>(pabyBuffer)[i + j] &
1710
0
                         panMaskOffsetLsb[j].nMask));
1711
0
                }
1712
1713
                // Make sure that by discarding LSB we don't end up to a value
1714
                // that is no the nodata value
1715
0
                if (MustNotDiscardLsb(
1716
0
                        reinterpret_cast<Teffective *>(pabyBuffer)[i + j],
1717
0
                        bHasNoData, nNoDataValue))
1718
0
                {
1719
0
                    reinterpret_cast<Teffective *>(pabyBuffer)[i + j] =
1720
0
                        AdjustValue(nNoDataValue,
1721
0
                                    panMaskOffsetLsb[j].nRoundUpBitTest);
1722
0
                }
1723
0
            }
1724
0
        }
1725
0
    }
1726
0
}
Unexecuted instantiation: gtiffdataset_write.cpp:void DiscardLsbT<signed char, signed char>(unsigned char*, unsigned long, int, int, unsigned short, GTiffDataset::MaskOffset const*, bool, signed char)
Unexecuted instantiation: gtiffdataset_write.cpp:void DiscardLsbT<short, short>(unsigned char*, unsigned long, int, int, unsigned short, GTiffDataset::MaskOffset const*, bool, short)
Unexecuted instantiation: gtiffdataset_write.cpp:void DiscardLsbT<unsigned short, unsigned short>(unsigned char*, unsigned long, int, int, unsigned short, GTiffDataset::MaskOffset const*, bool, unsigned short)
Unexecuted instantiation: gtiffdataset_write.cpp:void DiscardLsbT<int, int>(unsigned char*, unsigned long, int, int, unsigned short, GTiffDataset::MaskOffset const*, bool, int)
Unexecuted instantiation: gtiffdataset_write.cpp:void DiscardLsbT<unsigned int, unsigned int>(unsigned char*, unsigned long, int, int, unsigned short, GTiffDataset::MaskOffset const*, bool, unsigned int)
Unexecuted instantiation: gtiffdataset_write.cpp:void DiscardLsbT<long, long>(unsigned char*, unsigned long, int, int, unsigned short, GTiffDataset::MaskOffset const*, bool, long)
Unexecuted instantiation: gtiffdataset_write.cpp:void DiscardLsbT<unsigned long, unsigned long>(unsigned char*, unsigned long, int, int, unsigned short, GTiffDataset::MaskOffset const*, bool, unsigned long)
Unexecuted instantiation: gtiffdataset_write.cpp:void DiscardLsbT<cpl::Float16, unsigned short>(unsigned char*, unsigned long, int, int, unsigned short, GTiffDataset::MaskOffset const*, bool, cpl::Float16)
Unexecuted instantiation: gtiffdataset_write.cpp:void DiscardLsbT<float, unsigned int>(unsigned char*, unsigned long, int, int, unsigned short, GTiffDataset::MaskOffset const*, bool, float)
Unexecuted instantiation: gtiffdataset_write.cpp:void DiscardLsbT<double, unsigned long>(unsigned char*, unsigned long, int, int, unsigned short, GTiffDataset::MaskOffset const*, bool, double)
1727
1728
static void DiscardLsb(GByte *pabyBuffer, GPtrDiff_t nBytes, int iBand,
1729
                       int nBands, uint16_t nSampleFormat,
1730
                       uint16_t nBitsPerSample, uint16_t nPlanarConfig,
1731
                       const GTiffDataset::MaskOffset *panMaskOffsetLsb,
1732
                       bool bHasNoData, double dfNoDataValue)
1733
0
{
1734
0
    if (nBitsPerSample == 8 && nSampleFormat == SAMPLEFORMAT_UINT)
1735
0
    {
1736
0
        uint8_t nNoDataValue = 0;
1737
0
        if (bHasNoData && GDALIsValueExactAs<uint8_t>(dfNoDataValue))
1738
0
        {
1739
0
            nNoDataValue = static_cast<uint8_t>(dfNoDataValue);
1740
0
        }
1741
0
        else
1742
0
        {
1743
0
            bHasNoData = false;
1744
0
        }
1745
0
        if (nPlanarConfig == PLANARCONFIG_SEPARATE)
1746
0
        {
1747
0
            const auto nMask =
1748
0
                static_cast<unsigned>(panMaskOffsetLsb[iBand].nMask);
1749
0
            const auto nRoundUpBitTest =
1750
0
                static_cast<unsigned>(panMaskOffsetLsb[iBand].nRoundUpBitTest);
1751
0
            for (decltype(nBytes) i = 0; i < nBytes; ++i)
1752
0
            {
1753
0
                if (bHasNoData && pabyBuffer[i] == nNoDataValue)
1754
0
                    continue;
1755
1756
                // Keep 255 in case it is alpha.
1757
0
                if (pabyBuffer[i] != 255)
1758
0
                {
1759
0
                    if (pabyBuffer[i] & nRoundUpBitTest)
1760
0
                        pabyBuffer[i] = static_cast<GByte>(
1761
0
                            std::min(255U, (pabyBuffer[i] & nMask) +
1762
0
                                               (nRoundUpBitTest << 1U)));
1763
0
                    else
1764
0
                        pabyBuffer[i] =
1765
0
                            static_cast<GByte>(pabyBuffer[i] & nMask);
1766
1767
                    // Make sure that by discarding LSB we don't end up to a
1768
                    // value that is no the nodata value
1769
0
                    if (bHasNoData && pabyBuffer[i] == nNoDataValue)
1770
0
                        pabyBuffer[i] =
1771
0
                            AdjustValue(nNoDataValue, nRoundUpBitTest);
1772
0
                }
1773
0
            }
1774
0
        }
1775
0
        else
1776
0
        {
1777
0
            for (decltype(nBytes) i = 0; i < nBytes; i += nBands)
1778
0
            {
1779
0
                for (int j = 0; j < nBands; ++j)
1780
0
                {
1781
0
                    if (bHasNoData && pabyBuffer[i + j] == nNoDataValue)
1782
0
                        continue;
1783
1784
                    // Keep 255 in case it is alpha.
1785
0
                    if (pabyBuffer[i + j] != 255)
1786
0
                    {
1787
0
                        if (pabyBuffer[i + j] &
1788
0
                            panMaskOffsetLsb[j].nRoundUpBitTest)
1789
0
                        {
1790
0
                            pabyBuffer[i + j] = static_cast<GByte>(std::min(
1791
0
                                255U,
1792
0
                                (pabyBuffer[i + j] &
1793
0
                                 static_cast<unsigned>(
1794
0
                                     panMaskOffsetLsb[j].nMask)) +
1795
0
                                    (static_cast<unsigned>(
1796
0
                                         panMaskOffsetLsb[j].nRoundUpBitTest)
1797
0
                                     << 1U)));
1798
0
                        }
1799
0
                        else
1800
0
                        {
1801
0
                            pabyBuffer[i + j] = static_cast<GByte>(
1802
0
                                pabyBuffer[i + j] & panMaskOffsetLsb[j].nMask);
1803
0
                        }
1804
1805
                        // Make sure that by discarding LSB we don't end up to a
1806
                        // value that is no the nodata value
1807
0
                        if (bHasNoData && pabyBuffer[i + j] == nNoDataValue)
1808
0
                            pabyBuffer[i + j] = AdjustValue(
1809
0
                                nNoDataValue,
1810
0
                                panMaskOffsetLsb[j].nRoundUpBitTest);
1811
0
                    }
1812
0
                }
1813
0
            }
1814
0
        }
1815
0
    }
1816
0
    else if (nBitsPerSample == 8 && nSampleFormat == SAMPLEFORMAT_INT)
1817
0
    {
1818
0
        int8_t nNoDataValue = 0;
1819
0
        if (bHasNoData && GDALIsValueExactAs<int8_t>(dfNoDataValue))
1820
0
        {
1821
0
            nNoDataValue = static_cast<int8_t>(dfNoDataValue);
1822
0
        }
1823
0
        else
1824
0
        {
1825
0
            bHasNoData = false;
1826
0
        }
1827
0
        DiscardLsbT<int8_t, int8_t>(pabyBuffer, nBytes, iBand, nBands,
1828
0
                                    nPlanarConfig, panMaskOffsetLsb, bHasNoData,
1829
0
                                    nNoDataValue);
1830
0
    }
1831
0
    else if (nBitsPerSample == 16 && nSampleFormat == SAMPLEFORMAT_INT)
1832
0
    {
1833
0
        int16_t nNoDataValue = 0;
1834
0
        if (bHasNoData && GDALIsValueExactAs<int16_t>(dfNoDataValue))
1835
0
        {
1836
0
            nNoDataValue = static_cast<int16_t>(dfNoDataValue);
1837
0
        }
1838
0
        else
1839
0
        {
1840
0
            bHasNoData = false;
1841
0
        }
1842
0
        DiscardLsbT<int16_t, int16_t>(pabyBuffer, nBytes, iBand, nBands,
1843
0
                                      nPlanarConfig, panMaskOffsetLsb,
1844
0
                                      bHasNoData, nNoDataValue);
1845
0
    }
1846
0
    else if (nBitsPerSample == 16 && nSampleFormat == SAMPLEFORMAT_UINT)
1847
0
    {
1848
0
        uint16_t nNoDataValue = 0;
1849
0
        if (bHasNoData && GDALIsValueExactAs<uint16_t>(dfNoDataValue))
1850
0
        {
1851
0
            nNoDataValue = static_cast<uint16_t>(dfNoDataValue);
1852
0
        }
1853
0
        else
1854
0
        {
1855
0
            bHasNoData = false;
1856
0
        }
1857
0
        DiscardLsbT<uint16_t, uint16_t>(pabyBuffer, nBytes, iBand, nBands,
1858
0
                                        nPlanarConfig, panMaskOffsetLsb,
1859
0
                                        bHasNoData, nNoDataValue);
1860
0
    }
1861
0
    else if (nBitsPerSample == 32 && nSampleFormat == SAMPLEFORMAT_INT)
1862
0
    {
1863
0
        int32_t nNoDataValue = 0;
1864
0
        if (bHasNoData && GDALIsValueExactAs<int32_t>(dfNoDataValue))
1865
0
        {
1866
0
            nNoDataValue = static_cast<int32_t>(dfNoDataValue);
1867
0
        }
1868
0
        else
1869
0
        {
1870
0
            bHasNoData = false;
1871
0
        }
1872
0
        DiscardLsbT<int32_t, int32_t>(pabyBuffer, nBytes, iBand, nBands,
1873
0
                                      nPlanarConfig, panMaskOffsetLsb,
1874
0
                                      bHasNoData, nNoDataValue);
1875
0
    }
1876
0
    else if (nBitsPerSample == 32 && nSampleFormat == SAMPLEFORMAT_UINT)
1877
0
    {
1878
0
        uint32_t nNoDataValue = 0;
1879
0
        if (bHasNoData && GDALIsValueExactAs<uint32_t>(dfNoDataValue))
1880
0
        {
1881
0
            nNoDataValue = static_cast<uint32_t>(dfNoDataValue);
1882
0
        }
1883
0
        else
1884
0
        {
1885
0
            bHasNoData = false;
1886
0
        }
1887
0
        DiscardLsbT<uint32_t, uint32_t>(pabyBuffer, nBytes, iBand, nBands,
1888
0
                                        nPlanarConfig, panMaskOffsetLsb,
1889
0
                                        bHasNoData, nNoDataValue);
1890
0
    }
1891
0
    else if (nBitsPerSample == 64 && nSampleFormat == SAMPLEFORMAT_INT)
1892
0
    {
1893
        // FIXME: we should not rely on dfNoDataValue when we support native
1894
        // data type for nodata
1895
0
        int64_t nNoDataValue = 0;
1896
0
        if (bHasNoData && GDALIsValueExactAs<int64_t>(dfNoDataValue))
1897
0
        {
1898
0
            nNoDataValue = static_cast<int64_t>(dfNoDataValue);
1899
0
        }
1900
0
        else
1901
0
        {
1902
0
            bHasNoData = false;
1903
0
        }
1904
0
        DiscardLsbT<int64_t, int64_t>(pabyBuffer, nBytes, iBand, nBands,
1905
0
                                      nPlanarConfig, panMaskOffsetLsb,
1906
0
                                      bHasNoData, nNoDataValue);
1907
0
    }
1908
0
    else if (nBitsPerSample == 64 && nSampleFormat == SAMPLEFORMAT_UINT)
1909
0
    {
1910
        // FIXME: we should not rely on dfNoDataValue when we support native
1911
        // data type for nodata
1912
0
        uint64_t nNoDataValue = 0;
1913
0
        if (bHasNoData && GDALIsValueExactAs<uint64_t>(dfNoDataValue))
1914
0
        {
1915
0
            nNoDataValue = static_cast<uint64_t>(dfNoDataValue);
1916
0
        }
1917
0
        else
1918
0
        {
1919
0
            bHasNoData = false;
1920
0
        }
1921
0
        DiscardLsbT<uint64_t, uint64_t>(pabyBuffer, nBytes, iBand, nBands,
1922
0
                                        nPlanarConfig, panMaskOffsetLsb,
1923
0
                                        bHasNoData, nNoDataValue);
1924
0
    }
1925
0
    else if (nBitsPerSample == 16 && nSampleFormat == SAMPLEFORMAT_IEEEFP)
1926
0
    {
1927
0
        const GFloat16 fNoDataValue = static_cast<GFloat16>(dfNoDataValue);
1928
0
        DiscardLsbT<GFloat16, uint16_t>(pabyBuffer, nBytes, iBand, nBands,
1929
0
                                        nPlanarConfig, panMaskOffsetLsb,
1930
0
                                        bHasNoData, fNoDataValue);
1931
0
    }
1932
0
    else if (nBitsPerSample == 32 && nSampleFormat == SAMPLEFORMAT_IEEEFP)
1933
0
    {
1934
0
        const float fNoDataValue = static_cast<float>(dfNoDataValue);
1935
0
        DiscardLsbT<float, uint32_t>(pabyBuffer, nBytes, iBand, nBands,
1936
0
                                     nPlanarConfig, panMaskOffsetLsb,
1937
0
                                     bHasNoData, fNoDataValue);
1938
0
    }
1939
0
    else if (nBitsPerSample == 64 && nSampleFormat == SAMPLEFORMAT_IEEEFP)
1940
0
    {
1941
0
        DiscardLsbT<double, uint64_t>(pabyBuffer, nBytes, iBand, nBands,
1942
0
                                      nPlanarConfig, panMaskOffsetLsb,
1943
0
                                      bHasNoData, dfNoDataValue);
1944
0
    }
1945
0
}
1946
1947
void GTiffDataset::DiscardLsb(GByte *pabyBuffer, GPtrDiff_t nBytes,
1948
                              int iBand) const
1949
0
{
1950
0
    ::DiscardLsb(pabyBuffer, nBytes, iBand, nBands, m_nSampleFormat,
1951
0
                 m_nBitsPerSample, m_nPlanarConfig, m_panMaskOffsetLsb,
1952
0
                 m_bNoDataSet, m_dfNoDataValue);
1953
0
}
1954
1955
/************************************************************************/
1956
/*                      WriteEncodedTileOrStrip()                       */
1957
/************************************************************************/
1958
1959
CPLErr GTiffDataset::WriteEncodedTileOrStrip(uint32_t tile_or_strip, void *data,
1960
                                             int bPreserveDataBuffer)
1961
0
{
1962
0
    CPLErr eErr = CE_None;
1963
1964
0
    if (TIFFIsTiled(m_hTIFF))
1965
0
    {
1966
0
        if (!(WriteEncodedTile(tile_or_strip, static_cast<GByte *>(data),
1967
0
                               bPreserveDataBuffer)))
1968
0
        {
1969
0
            eErr = CE_Failure;
1970
0
        }
1971
0
    }
1972
0
    else
1973
0
    {
1974
0
        if (!(WriteEncodedStrip(tile_or_strip, static_cast<GByte *>(data),
1975
0
                                bPreserveDataBuffer)))
1976
0
        {
1977
0
            eErr = CE_Failure;
1978
0
        }
1979
0
    }
1980
1981
0
    return eErr;
1982
0
}
1983
1984
/************************************************************************/
1985
/*                           FlushBlockBuf()                            */
1986
/************************************************************************/
1987
1988
CPLErr GTiffDataset::FlushBlockBuf()
1989
1990
0
{
1991
0
    if (m_nLoadedBlock < 0 || !m_bLoadedBlockDirty)
1992
0
        return CE_None;
1993
1994
0
    m_bLoadedBlockDirty = false;
1995
1996
0
    const CPLErr eErr =
1997
0
        WriteEncodedTileOrStrip(m_nLoadedBlock, m_pabyBlockBuf, true);
1998
0
    if (eErr != CE_None)
1999
0
    {
2000
0
        ReportError(CE_Failure, CPLE_AppDefined,
2001
0
                    "WriteEncodedTile/Strip() failed.");
2002
0
        m_bWriteError = true;
2003
0
    }
2004
2005
0
    return eErr;
2006
0
}
2007
2008
/************************************************************************/
2009
/*                 GTiffFillStreamableOffsetAndCount()                  */
2010
/************************************************************************/
2011
2012
static void GTiffFillStreamableOffsetAndCount(TIFF *hTIFF, int nSize)
2013
0
{
2014
0
    uint32_t nXSize = 0;
2015
0
    uint32_t nYSize = 0;
2016
0
    TIFFGetField(hTIFF, TIFFTAG_IMAGEWIDTH, &nXSize);
2017
0
    TIFFGetField(hTIFF, TIFFTAG_IMAGELENGTH, &nYSize);
2018
0
    const bool bIsTiled = CPL_TO_BOOL(TIFFIsTiled(hTIFF));
2019
0
    const int nBlockCount =
2020
0
        bIsTiled ? TIFFNumberOfTiles(hTIFF) : TIFFNumberOfStrips(hTIFF);
2021
2022
0
    toff_t *panOffset = nullptr;
2023
0
    TIFFGetField(hTIFF, bIsTiled ? TIFFTAG_TILEOFFSETS : TIFFTAG_STRIPOFFSETS,
2024
0
                 &panOffset);
2025
0
    toff_t *panSize = nullptr;
2026
0
    TIFFGetField(hTIFF,
2027
0
                 bIsTiled ? TIFFTAG_TILEBYTECOUNTS : TIFFTAG_STRIPBYTECOUNTS,
2028
0
                 &panSize);
2029
0
    toff_t nOffset = nSize;
2030
    // Trick to avoid clang static analyzer raising false positive about
2031
    // divide by zero later.
2032
0
    int nBlocksPerBand = 1;
2033
0
    uint32_t nRowsPerStrip = 0;
2034
0
    if (!bIsTiled)
2035
0
    {
2036
0
        TIFFGetField(hTIFF, TIFFTAG_ROWSPERSTRIP, &nRowsPerStrip);
2037
0
        if (nRowsPerStrip > static_cast<uint32_t>(nYSize))
2038
0
            nRowsPerStrip = nYSize;
2039
0
        nBlocksPerBand = DIV_ROUND_UP(nYSize, nRowsPerStrip);
2040
0
    }
2041
0
    for (int i = 0; i < nBlockCount; ++i)
2042
0
    {
2043
0
        GPtrDiff_t cc = bIsTiled
2044
0
                            ? static_cast<GPtrDiff_t>(TIFFTileSize(hTIFF))
2045
0
                            : static_cast<GPtrDiff_t>(TIFFStripSize(hTIFF));
2046
0
        if (!bIsTiled)
2047
0
        {
2048
            /* --------------------------------------------------------------------
2049
             */
2050
            /*      If this is the last strip in the image, and is partial, then
2051
             */
2052
            /*      we need to trim the number of scanlines written to the */
2053
            /*      amount of valid data we have. (#2748) */
2054
            /* --------------------------------------------------------------------
2055
             */
2056
0
            int nStripWithinBand = i % nBlocksPerBand;
2057
0
            if (nStripWithinBand * nRowsPerStrip > nYSize - nRowsPerStrip)
2058
0
            {
2059
0
                cc = (cc / nRowsPerStrip) *
2060
0
                     (nYSize - nStripWithinBand * nRowsPerStrip);
2061
0
            }
2062
0
        }
2063
0
        panOffset[i] = nOffset;
2064
0
        panSize[i] = cc;
2065
0
        nOffset += cc;
2066
0
    }
2067
0
}
2068
2069
/************************************************************************/
2070
/*                             Crystalize()                             */
2071
/*                                                                      */
2072
/*      Make sure that the directory information is written out for     */
2073
/*      a new file, require before writing any imagery data.            */
2074
/************************************************************************/
2075
2076
void GTiffDataset::Crystalize()
2077
2078
0
{
2079
0
    if (m_bCrystalized)
2080
0
        return;
2081
2082
    // TODO: libtiff writes extended tags in the order they are specified
2083
    // and not in increasing order.
2084
0
    WriteMetadata(this, m_hTIFF, true, m_eProfile, m_osFilename.c_str(),
2085
0
                  m_papszCreationOptions);
2086
0
    WriteGeoTIFFInfo();
2087
0
    if (m_bNoDataSet)
2088
0
        WriteNoDataValue(m_hTIFF, m_dfNoDataValue);
2089
0
    else if (m_bNoDataSetAsInt64)
2090
0
        WriteNoDataValue(m_hTIFF, m_nNoDataValueInt64);
2091
0
    else if (m_bNoDataSetAsUInt64)
2092
0
        WriteNoDataValue(m_hTIFF, m_nNoDataValueUInt64);
2093
2094
0
    m_bMetadataChanged = false;
2095
0
    m_bGeoTIFFInfoChanged = false;
2096
0
    m_bNoDataChanged = false;
2097
0
    m_bNeedsRewrite = false;
2098
2099
0
    m_bCrystalized = true;
2100
2101
0
    TIFFWriteCheck(m_hTIFF, TIFFIsTiled(m_hTIFF), "GTiffDataset::Crystalize");
2102
2103
0
    TIFFWriteDirectory(m_hTIFF);
2104
0
    if (m_bStreamingOut)
2105
0
    {
2106
        // We need to write twice the directory to be sure that custom
2107
        // TIFF tags are correctly sorted and that padding bytes have been
2108
        // added.
2109
0
        TIFFSetDirectory(m_hTIFF, 0);
2110
0
        TIFFWriteDirectory(m_hTIFF);
2111
2112
0
        if (VSIFSeekL(m_fpL, 0, SEEK_END) != 0)
2113
0
        {
2114
0
            ReportError(CE_Failure, CPLE_FileIO, "Could not seek");
2115
0
        }
2116
0
        const int nSize = static_cast<int>(VSIFTellL(m_fpL));
2117
2118
0
        TIFFSetDirectory(m_hTIFF, 0);
2119
0
        GTiffFillStreamableOffsetAndCount(m_hTIFF, nSize);
2120
0
        TIFFWriteDirectory(m_hTIFF);
2121
2122
0
        vsi_l_offset nDataLength = 0;
2123
0
        void *pabyBuffer =
2124
0
            VSIGetMemFileBuffer(m_pszTmpFilename, &nDataLength, FALSE);
2125
0
        if (static_cast<int>(VSIFWriteL(
2126
0
                pabyBuffer, 1, static_cast<int>(nDataLength), m_fpToWrite)) !=
2127
0
            static_cast<int>(nDataLength))
2128
0
        {
2129
0
            ReportError(CE_Failure, CPLE_FileIO, "Could not write %d bytes",
2130
0
                        static_cast<int>(nDataLength));
2131
0
        }
2132
        // In case of single strip file, there's a libtiff check that would
2133
        // issue a warning since the file hasn't the required size.
2134
0
        CPLPushErrorHandler(CPLQuietErrorHandler);
2135
0
        TIFFSetDirectory(m_hTIFF, 0);
2136
0
        CPLPopErrorHandler();
2137
0
    }
2138
0
    else
2139
0
    {
2140
0
        const tdir_t nNumberOfDirs = TIFFNumberOfDirectories(m_hTIFF);
2141
0
        if (nNumberOfDirs > 0)
2142
0
        {
2143
0
            TIFFSetDirectory(m_hTIFF, static_cast<tdir_t>(nNumberOfDirs - 1));
2144
0
        }
2145
0
    }
2146
2147
0
    RestoreVolatileParameters(m_hTIFF);
2148
2149
0
    m_nDirOffset = TIFFCurrentDirOffset(m_hTIFF);
2150
0
}
2151
2152
/************************************************************************/
2153
/*                             FlushCache()                             */
2154
/*                                                                      */
2155
/*      We override this so we can also flush out local tiff strip      */
2156
/*      cache if need be.                                               */
2157
/************************************************************************/
2158
2159
CPLErr GTiffDataset::FlushCache(bool bAtClosing)
2160
2161
0
{
2162
0
    return FlushCacheInternal(bAtClosing, true);
2163
0
}
2164
2165
CPLErr GTiffDataset::FlushCacheInternal(bool bAtClosing, bool bFlushDirectory)
2166
0
{
2167
0
    if (m_bIsFinalized)
2168
0
        return CE_None;
2169
2170
0
    CPLErr eErr = GDALPamDataset::FlushCache(bAtClosing);
2171
2172
0
    if (m_bLoadedBlockDirty && m_nLoadedBlock != -1)
2173
0
    {
2174
0
        if (FlushBlockBuf() != CE_None)
2175
0
            eErr = CE_Failure;
2176
0
    }
2177
2178
0
    CPLFree(m_pabyBlockBuf);
2179
0
    m_pabyBlockBuf = nullptr;
2180
0
    m_nLoadedBlock = -1;
2181
0
    m_bLoadedBlockDirty = false;
2182
2183
    // Finish compression
2184
0
    auto poQueue = m_poBaseDS ? m_poBaseDS->m_poCompressQueue.get()
2185
0
                              : m_poCompressQueue.get();
2186
0
    if (poQueue)
2187
0
    {
2188
0
        poQueue->WaitCompletion();
2189
2190
        // Flush remaining data
2191
        // cppcheck-suppress constVariableReference
2192
2193
0
        auto &oQueue =
2194
0
            m_poBaseDS ? m_poBaseDS->m_asQueueJobIdx : m_asQueueJobIdx;
2195
0
        while (!oQueue.empty())
2196
0
        {
2197
0
            WaitCompletionForJobIdx(oQueue.front());
2198
0
        }
2199
0
    }
2200
2201
0
    if (bFlushDirectory && GetAccess() == GA_Update)
2202
0
    {
2203
0
        if (FlushDirectory() != CE_None)
2204
0
            eErr = CE_Failure;
2205
0
    }
2206
0
    return eErr;
2207
0
}
2208
2209
/************************************************************************/
2210
/*                           FlushDirectory()                           */
2211
/************************************************************************/
2212
2213
CPLErr GTiffDataset::FlushDirectory()
2214
2215
0
{
2216
0
    CPLErr eErr = CE_None;
2217
2218
0
    const auto ReloadAllOtherDirectories = [this]()
2219
0
    {
2220
0
        const auto poBaseDS = m_poBaseDS ? m_poBaseDS : this;
2221
0
        for (auto &poOvrDS : poBaseDS->m_apoOverviewDS)
2222
0
        {
2223
0
            if (poOvrDS->m_bCrystalized && poOvrDS.get() != this)
2224
0
            {
2225
0
                poOvrDS->ReloadDirectory(true);
2226
0
            }
2227
2228
0
            if (poOvrDS->m_poMaskDS && poOvrDS->m_poMaskDS.get() != this &&
2229
0
                poOvrDS->m_poMaskDS->m_bCrystalized)
2230
0
            {
2231
0
                poOvrDS->m_poMaskDS->ReloadDirectory(true);
2232
0
            }
2233
0
        }
2234
0
        if (poBaseDS->m_poMaskDS && poBaseDS->m_poMaskDS.get() != this &&
2235
0
            poBaseDS->m_poMaskDS->m_bCrystalized)
2236
0
        {
2237
0
            poBaseDS->m_poMaskDS->ReloadDirectory(true);
2238
0
        }
2239
0
        if (poBaseDS->m_bCrystalized && poBaseDS != this)
2240
0
        {
2241
0
            poBaseDS->ReloadDirectory(true);
2242
0
        }
2243
0
    };
2244
2245
0
    if (eAccess == GA_Update)
2246
0
    {
2247
0
        if (m_bMetadataChanged)
2248
0
        {
2249
0
            m_bNeedsRewrite =
2250
0
                WriteMetadata(this, m_hTIFF, true, m_eProfile,
2251
0
                              m_osFilename.c_str(), m_papszCreationOptions);
2252
0
            m_bMetadataChanged = false;
2253
2254
0
            if (m_bForceUnsetRPC)
2255
0
            {
2256
0
                double *padfRPCTag = nullptr;
2257
0
                uint16_t nCount;
2258
0
                if (TIFFGetField(m_hTIFF, TIFFTAG_RPCCOEFFICIENT, &nCount,
2259
0
                                 &padfRPCTag))
2260
0
                {
2261
0
                    std::vector<double> zeroes(92);
2262
0
                    TIFFSetField(m_hTIFF, TIFFTAG_RPCCOEFFICIENT, 92,
2263
0
                                 zeroes.data());
2264
0
                    TIFFUnsetField(m_hTIFF, TIFFTAG_RPCCOEFFICIENT);
2265
0
                    m_bNeedsRewrite = true;
2266
0
                }
2267
2268
0
                if (m_poBaseDS == nullptr)
2269
0
                {
2270
0
                    GDALWriteRPCTXTFile(m_osFilename.c_str(), nullptr);
2271
0
                    GDALWriteRPBFile(m_osFilename.c_str(), nullptr);
2272
0
                }
2273
0
            }
2274
0
        }
2275
2276
0
        if (m_bGeoTIFFInfoChanged)
2277
0
        {
2278
0
            WriteGeoTIFFInfo();
2279
0
            m_bGeoTIFFInfoChanged = false;
2280
0
        }
2281
2282
0
        if (m_bNoDataChanged)
2283
0
        {
2284
0
            if (m_bNoDataSet)
2285
0
            {
2286
0
                WriteNoDataValue(m_hTIFF, m_dfNoDataValue);
2287
0
            }
2288
0
            else if (m_bNoDataSetAsInt64)
2289
0
            {
2290
0
                WriteNoDataValue(m_hTIFF, m_nNoDataValueInt64);
2291
0
            }
2292
0
            else if (m_bNoDataSetAsUInt64)
2293
0
            {
2294
0
                WriteNoDataValue(m_hTIFF, m_nNoDataValueUInt64);
2295
0
            }
2296
0
            else
2297
0
            {
2298
0
                UnsetNoDataValue(m_hTIFF);
2299
0
            }
2300
0
            m_bNeedsRewrite = true;
2301
0
            m_bNoDataChanged = false;
2302
0
        }
2303
2304
0
        if (m_bNeedsRewrite)
2305
0
        {
2306
0
            if (!m_bCrystalized)
2307
0
            {
2308
0
                Crystalize();
2309
0
            }
2310
0
            else
2311
0
            {
2312
0
                const TIFFSizeProc pfnSizeProc = TIFFGetSizeProc(m_hTIFF);
2313
2314
0
                m_nDirOffset = pfnSizeProc(TIFFClientdata(m_hTIFF));
2315
0
                if ((m_nDirOffset % 2) == 1)
2316
0
                    ++m_nDirOffset;
2317
2318
0
                if (TIFFRewriteDirectory(m_hTIFF) == 0)
2319
0
                    eErr = CE_Failure;
2320
2321
0
                TIFFSetSubDirectory(m_hTIFF, m_nDirOffset);
2322
2323
0
                ReloadAllOtherDirectories();
2324
2325
0
                if (m_bLayoutIFDSBeforeData && m_bBlockOrderRowMajor &&
2326
0
                    m_bLeaderSizeAsUInt4 &&
2327
0
                    m_bTrailerRepeatedLast4BytesRepeated &&
2328
0
                    !m_bKnownIncompatibleEdition &&
2329
0
                    !m_bWriteKnownIncompatibleEdition)
2330
0
                {
2331
0
                    ReportError(CE_Warning, CPLE_AppDefined,
2332
0
                                "The IFD has been rewritten at the end of "
2333
0
                                "the file, which breaks COG layout.");
2334
0
                    m_bKnownIncompatibleEdition = true;
2335
0
                    m_bWriteKnownIncompatibleEdition = true;
2336
0
                }
2337
0
            }
2338
2339
0
            m_bNeedsRewrite = false;
2340
0
        }
2341
0
    }
2342
2343
    // There are some circumstances in which we can reach this point
2344
    // without having made this our directory (SetDirectory()) in which
2345
    // case we should not risk a flush.
2346
0
    if (GetAccess() == GA_Update &&
2347
0
        TIFFCurrentDirOffset(m_hTIFF) == m_nDirOffset)
2348
0
    {
2349
0
        const TIFFSizeProc pfnSizeProc = TIFFGetSizeProc(m_hTIFF);
2350
2351
0
        toff_t nNewDirOffset = pfnSizeProc(TIFFClientdata(m_hTIFF));
2352
0
        if ((nNewDirOffset % 2) == 1)
2353
0
            ++nNewDirOffset;
2354
2355
0
        if (TIFFFlush(m_hTIFF) == 0)
2356
0
            eErr = CE_Failure;
2357
2358
0
        if (m_nDirOffset != TIFFCurrentDirOffset(m_hTIFF))
2359
0
        {
2360
0
            m_nDirOffset = nNewDirOffset;
2361
0
            ReloadAllOtherDirectories();
2362
0
            CPLDebug("GTiff",
2363
0
                     "directory moved during flush in FlushDirectory()");
2364
0
        }
2365
0
    }
2366
2367
0
    SetDirectory();
2368
0
    return eErr;
2369
0
}
2370
2371
/************************************************************************/
2372
/*                           CleanOverviews()                           */
2373
/************************************************************************/
2374
2375
CPLErr GTiffDataset::CleanOverviews()
2376
2377
0
{
2378
0
    CPLAssert(!m_poBaseDS);
2379
2380
0
    ScanDirectories();
2381
2382
0
    FlushDirectory();
2383
2384
    /* -------------------------------------------------------------------- */
2385
    /*      Cleanup overviews objects, and get offsets to all overview      */
2386
    /*      directories.                                                    */
2387
    /* -------------------------------------------------------------------- */
2388
0
    std::vector<toff_t> anOvDirOffsets;
2389
2390
0
    for (auto &poOvrDS : m_apoOverviewDS)
2391
0
    {
2392
0
        anOvDirOffsets.push_back(poOvrDS->m_nDirOffset);
2393
0
        if (poOvrDS->m_poMaskDS)
2394
0
            anOvDirOffsets.push_back(poOvrDS->m_poMaskDS->m_nDirOffset);
2395
0
    }
2396
0
    m_apoOverviewDS.clear();
2397
2398
    /* -------------------------------------------------------------------- */
2399
    /*      Loop through all the directories, translating the offsets       */
2400
    /*      into indexes we can use with TIFFUnlinkDirectory().             */
2401
    /* -------------------------------------------------------------------- */
2402
0
    std::vector<uint16_t> anOvDirIndexes;
2403
0
    int iThisOffset = 1;
2404
2405
0
    TIFFSetDirectory(m_hTIFF, 0);
2406
2407
0
    while (true)
2408
0
    {
2409
0
        for (toff_t nOffset : anOvDirOffsets)
2410
0
        {
2411
0
            if (nOffset == TIFFCurrentDirOffset(m_hTIFF))
2412
0
            {
2413
0
                anOvDirIndexes.push_back(static_cast<uint16_t>(iThisOffset));
2414
0
            }
2415
0
        }
2416
2417
0
        if (TIFFLastDirectory(m_hTIFF))
2418
0
            break;
2419
2420
0
        TIFFReadDirectory(m_hTIFF);
2421
0
        ++iThisOffset;
2422
0
    }
2423
2424
    /* -------------------------------------------------------------------- */
2425
    /*      Actually unlink the target directories.  Note that we do        */
2426
    /*      this from last to first so as to avoid renumbering any of       */
2427
    /*      the earlier directories we need to remove.                      */
2428
    /* -------------------------------------------------------------------- */
2429
0
    while (!anOvDirIndexes.empty())
2430
0
    {
2431
0
        TIFFUnlinkDirectory(m_hTIFF, anOvDirIndexes.back());
2432
0
        anOvDirIndexes.pop_back();
2433
0
    }
2434
2435
0
    if (m_poMaskDS)
2436
0
    {
2437
0
        m_poMaskDS->m_apoOverviewDS.clear();
2438
0
    }
2439
2440
0
    if (!SetDirectory())
2441
0
        return CE_Failure;
2442
2443
0
    return CE_None;
2444
0
}
2445
2446
/************************************************************************/
2447
/*                     RegisterNewOverviewDataset()                     */
2448
/************************************************************************/
2449
2450
CPLErr GTiffDataset::RegisterNewOverviewDataset(toff_t nOverviewOffset,
2451
                                                int l_nJpegQuality,
2452
                                                CSLConstList papszOptions)
2453
0
{
2454
0
    const auto GetOptionValue =
2455
0
        [papszOptions](const char *pszOptionKey, const char *pszConfigOptionKey,
2456
0
                       const char **ppszKeyUsed = nullptr)
2457
0
    {
2458
0
        const char *pszVal = CSLFetchNameValue(papszOptions, pszOptionKey);
2459
0
        if (pszVal)
2460
0
        {
2461
0
            if (ppszKeyUsed)
2462
0
                *ppszKeyUsed = pszOptionKey;
2463
0
            return pszVal;
2464
0
        }
2465
0
        pszVal = CSLFetchNameValue(papszOptions, pszConfigOptionKey);
2466
0
        if (pszVal)
2467
0
        {
2468
0
            if (ppszKeyUsed)
2469
0
                *ppszKeyUsed = pszConfigOptionKey;
2470
0
            return pszVal;
2471
0
        }
2472
0
        if (pszConfigOptionKey)
2473
0
        {
2474
0
            pszVal = CPLGetConfigOption(pszConfigOptionKey, nullptr);
2475
0
            if (pszVal && ppszKeyUsed)
2476
0
                *ppszKeyUsed = pszConfigOptionKey;
2477
0
        }
2478
0
        return pszVal;
2479
0
    };
2480
2481
0
    int nZLevel = m_nZLevel;
2482
0
    if (const char *opt = GetOptionValue("ZLEVEL", "ZLEVEL_OVERVIEW"))
2483
0
    {
2484
0
        nZLevel = atoi(opt);
2485
0
    }
2486
2487
0
    int nZSTDLevel = m_nZSTDLevel;
2488
0
    if (const char *opt = GetOptionValue("ZSTD_LEVEL", "ZSTD_LEVEL_OVERVIEW"))
2489
0
    {
2490
0
        nZSTDLevel = atoi(opt);
2491
0
    }
2492
2493
0
    bool bWebpLossless = m_bWebPLossless;
2494
0
    const char *pszWebPLosslessOverview =
2495
0
        GetOptionValue("WEBP_LOSSLESS", "WEBP_LOSSLESS_OVERVIEW");
2496
0
    if (pszWebPLosslessOverview)
2497
0
    {
2498
0
        bWebpLossless = CPLTestBool(pszWebPLosslessOverview);
2499
0
    }
2500
2501
0
    int nWebpLevel = m_nWebPLevel;
2502
0
    const char *pszKeyWebpLevel = "";
2503
0
    if (const char *opt = GetOptionValue("WEBP_LEVEL", "WEBP_LEVEL_OVERVIEW",
2504
0
                                         &pszKeyWebpLevel))
2505
0
    {
2506
0
        if (pszWebPLosslessOverview == nullptr && m_bWebPLossless)
2507
0
        {
2508
0
            CPLDebug("GTiff",
2509
0
                     "%s specified, but not WEBP_LOSSLESS_OVERVIEW. "
2510
0
                     "Assuming WEBP_LOSSLESS_OVERVIEW=NO",
2511
0
                     pszKeyWebpLevel);
2512
0
            bWebpLossless = false;
2513
0
        }
2514
0
        else if (bWebpLossless)
2515
0
        {
2516
0
            CPLError(CE_Warning, CPLE_AppDefined,
2517
0
                     "%s is specified, but WEBP_LOSSLESS_OVERVIEW=YES. "
2518
0
                     "%s will be ignored.",
2519
0
                     pszKeyWebpLevel, pszKeyWebpLevel);
2520
0
        }
2521
0
        nWebpLevel = atoi(opt);
2522
0
    }
2523
2524
0
    double dfMaxZError = m_dfMaxZErrorOverview;
2525
0
    if (const char *opt = GetOptionValue("MAX_Z_ERROR", "MAX_Z_ERROR_OVERVIEW"))
2526
0
    {
2527
0
        dfMaxZError = CPLAtof(opt);
2528
0
    }
2529
2530
0
    signed char nJpegTablesMode = m_nJpegTablesMode;
2531
0
    if (const char *opt =
2532
0
            GetOptionValue("JPEG_TABLESMODE", "JPEG_TABLESMODE_OVERVIEW"))
2533
0
    {
2534
0
        nJpegTablesMode = static_cast<signed char>(atoi(opt));
2535
0
    }
2536
2537
#ifdef HAVE_JXL
2538
    bool bJXLLossless = m_bJXLLossless;
2539
    if (const char *opt =
2540
            GetOptionValue("JXL_LOSSLESS", "JXL_LOSSLESS_OVERVIEW"))
2541
    {
2542
        bJXLLossless = CPLTestBool(opt);
2543
    }
2544
2545
    float fJXLDistance = m_fJXLDistance;
2546
    if (const char *opt =
2547
            GetOptionValue("JXL_DISTANCE", "JXL_DISTANCE_OVERVIEW"))
2548
    {
2549
        fJXLDistance = static_cast<float>(CPLAtof(opt));
2550
    }
2551
2552
    float fJXLAlphaDistance = m_fJXLAlphaDistance;
2553
    if (const char *opt =
2554
            GetOptionValue("JXL_ALPHA_DISTANCE", "JXL_ALPHA_DISTANCE_OVERVIEW"))
2555
    {
2556
        fJXLAlphaDistance = static_cast<float>(CPLAtof(opt));
2557
    }
2558
2559
    int nJXLEffort = m_nJXLEffort;
2560
    if (const char *opt = GetOptionValue("JXL_EFFORT", "JXL_EFFORT_OVERVIEW"))
2561
    {
2562
        nJXLEffort = atoi(opt);
2563
    }
2564
#endif
2565
2566
0
    auto poODS = std::make_shared<GTiffDataset>();
2567
0
    poODS->ShareLockWithParentDataset(this);
2568
0
    poODS->eAccess = GA_Update;
2569
0
    poODS->m_osFilename = m_osFilename;
2570
0
    const char *pszSparseOK = GetOptionValue("SPARSE_OK", "SPARSE_OK_OVERVIEW");
2571
0
    if (pszSparseOK && CPLTestBool(pszSparseOK))
2572
0
    {
2573
0
        poODS->m_bWriteEmptyTiles = false;
2574
0
        poODS->m_bFillEmptyTilesAtClosing = false;
2575
0
    }
2576
0
    else
2577
0
    {
2578
0
        poODS->m_bWriteEmptyTiles = m_bWriteEmptyTiles;
2579
0
        poODS->m_bFillEmptyTilesAtClosing = m_bFillEmptyTilesAtClosing;
2580
0
    }
2581
0
    poODS->m_nJpegQuality = static_cast<signed char>(l_nJpegQuality);
2582
0
    poODS->m_nWebPLevel = static_cast<signed char>(nWebpLevel);
2583
0
    poODS->m_nZLevel = static_cast<signed char>(nZLevel);
2584
0
    poODS->m_nLZMAPreset = m_nLZMAPreset;
2585
0
    poODS->m_nZSTDLevel = static_cast<signed char>(nZSTDLevel);
2586
0
    poODS->m_bWebPLossless = bWebpLossless;
2587
0
    poODS->m_nJpegTablesMode = nJpegTablesMode;
2588
0
    poODS->m_dfMaxZError = dfMaxZError;
2589
0
    poODS->m_dfMaxZErrorOverview = dfMaxZError;
2590
0
    memcpy(poODS->m_anLercAddCompressionAndVersion,
2591
0
           m_anLercAddCompressionAndVersion,
2592
0
           sizeof(m_anLercAddCompressionAndVersion));
2593
#ifdef HAVE_JXL
2594
    poODS->m_bJXLLossless = bJXLLossless;
2595
    poODS->m_fJXLDistance = fJXLDistance;
2596
    poODS->m_fJXLAlphaDistance = fJXLAlphaDistance;
2597
    poODS->m_nJXLEffort = nJXLEffort;
2598
#endif
2599
2600
0
    if (poODS->OpenOffset(VSI_TIFFOpenChild(m_hTIFF), nOverviewOffset,
2601
0
                          GA_Update) != CE_None)
2602
0
    {
2603
0
        return CE_Failure;
2604
0
    }
2605
2606
    // Assign color interpretation from main dataset
2607
0
    const int l_nBands = GetRasterCount();
2608
0
    for (int i = 1; i <= l_nBands; i++)
2609
0
    {
2610
0
        auto poBand = dynamic_cast<GTiffRasterBand *>(poODS->GetRasterBand(i));
2611
0
        if (poBand)
2612
0
            poBand->m_eBandInterp = GetRasterBand(i)->GetColorInterpretation();
2613
0
    }
2614
2615
    // Do that now that m_nCompression is set
2616
0
    poODS->RestoreVolatileParameters(poODS->m_hTIFF);
2617
2618
0
    poODS->m_poBaseDS = this;
2619
0
    poODS->m_bIsOverview = true;
2620
2621
0
    m_apoOverviewDS.push_back(std::move(poODS));
2622
0
    return CE_None;
2623
0
}
2624
2625
/************************************************************************/
2626
/*                        CreateTIFFColorTable()                        */
2627
/************************************************************************/
2628
2629
static void CreateTIFFColorTable(
2630
    GDALColorTable *poColorTable, int nBits, int nColorTableMultiplier,
2631
    std::vector<unsigned short> &anTRed, std::vector<unsigned short> &anTGreen,
2632
    std::vector<unsigned short> &anTBlue, unsigned short *&panRed,
2633
    unsigned short *&panGreen, unsigned short *&panBlue)
2634
0
{
2635
0
    int nColors;
2636
2637
0
    if (nBits == 8)
2638
0
        nColors = 256;
2639
0
    else if (nBits < 8)
2640
0
        nColors = 1 << nBits;
2641
0
    else
2642
0
        nColors = 65536;
2643
2644
0
    anTRed.resize(nColors, 0);
2645
0
    anTGreen.resize(nColors, 0);
2646
0
    anTBlue.resize(nColors, 0);
2647
2648
0
    for (int iColor = 0; iColor < nColors; ++iColor)
2649
0
    {
2650
0
        if (iColor < poColorTable->GetColorEntryCount())
2651
0
        {
2652
0
            GDALColorEntry sRGB;
2653
2654
0
            poColorTable->GetColorEntryAsRGB(iColor, &sRGB);
2655
2656
0
            anTRed[iColor] = GTiffDataset::ClampCTEntry(iColor, 1, sRGB.c1,
2657
0
                                                        nColorTableMultiplier);
2658
0
            anTGreen[iColor] = GTiffDataset::ClampCTEntry(
2659
0
                iColor, 2, sRGB.c2, nColorTableMultiplier);
2660
0
            anTBlue[iColor] = GTiffDataset::ClampCTEntry(iColor, 3, sRGB.c3,
2661
0
                                                         nColorTableMultiplier);
2662
0
        }
2663
0
        else
2664
0
        {
2665
0
            anTRed[iColor] = 0;
2666
0
            anTGreen[iColor] = 0;
2667
0
            anTBlue[iColor] = 0;
2668
0
        }
2669
0
    }
2670
2671
0
    panRed = &(anTRed[0]);
2672
0
    panGreen = &(anTGreen[0]);
2673
0
    panBlue = &(anTBlue[0]);
2674
0
}
2675
2676
/************************************************************************/
2677
/*                       GetOverviewParameters()                        */
2678
/************************************************************************/
2679
2680
bool GTiffDataset::GetOverviewParameters(
2681
    int &nCompression, uint16_t &nPlanarConfig, uint16_t &nPredictor,
2682
    uint16_t &nPhotometric, int &nOvrJpegQuality, std::string &osNoData,
2683
    uint16_t *&panExtraSampleValues, uint16_t &nExtraSamples,
2684
    CSLConstList papszOptions) const
2685
0
{
2686
0
    const auto GetOptionValue =
2687
0
        [papszOptions](const char *pszOptionKey, const char *pszConfigOptionKey,
2688
0
                       const char **ppszKeyUsed = nullptr)
2689
0
    {
2690
0
        const char *pszVal = CSLFetchNameValue(papszOptions, pszOptionKey);
2691
0
        if (pszVal)
2692
0
        {
2693
0
            if (ppszKeyUsed)
2694
0
                *ppszKeyUsed = pszOptionKey;
2695
0
            return pszVal;
2696
0
        }
2697
0
        pszVal = CSLFetchNameValue(papszOptions, pszConfigOptionKey);
2698
0
        if (pszVal)
2699
0
        {
2700
0
            if (ppszKeyUsed)
2701
0
                *ppszKeyUsed = pszConfigOptionKey;
2702
0
            return pszVal;
2703
0
        }
2704
0
        pszVal = CPLGetConfigOption(pszConfigOptionKey, nullptr);
2705
0
        if (pszVal && ppszKeyUsed)
2706
0
            *ppszKeyUsed = pszConfigOptionKey;
2707
0
        return pszVal;
2708
0
    };
2709
2710
    /* -------------------------------------------------------------------- */
2711
    /*      Determine compression method.                                   */
2712
    /* -------------------------------------------------------------------- */
2713
0
    nCompression = m_nCompression;
2714
0
    const char *pszOptionKey = "";
2715
0
    const char *pszCompressValue =
2716
0
        GetOptionValue("COMPRESS", "COMPRESS_OVERVIEW", &pszOptionKey);
2717
0
    if (pszCompressValue != nullptr)
2718
0
    {
2719
0
        nCompression =
2720
0
            GTIFFGetCompressionMethod(pszCompressValue, pszOptionKey);
2721
0
        if (nCompression < 0)
2722
0
        {
2723
0
            nCompression = m_nCompression;
2724
0
        }
2725
0
    }
2726
2727
    /* -------------------------------------------------------------------- */
2728
    /*      Determine planar configuration.                                 */
2729
    /* -------------------------------------------------------------------- */
2730
0
    nPlanarConfig = m_nPlanarConfig;
2731
0
    if (nCompression == COMPRESSION_WEBP)
2732
0
    {
2733
0
        nPlanarConfig = PLANARCONFIG_CONTIG;
2734
0
    }
2735
0
    const char *pszInterleave =
2736
0
        GetOptionValue("INTERLEAVE", "INTERLEAVE_OVERVIEW", &pszOptionKey);
2737
0
    if (pszInterleave != nullptr && pszInterleave[0] != '\0')
2738
0
    {
2739
0
        if (EQUAL(pszInterleave, "PIXEL"))
2740
0
            nPlanarConfig = PLANARCONFIG_CONTIG;
2741
0
        else if (EQUAL(pszInterleave, "BAND"))
2742
0
            nPlanarConfig = PLANARCONFIG_SEPARATE;
2743
0
        else
2744
0
        {
2745
0
            CPLError(CE_Warning, CPLE_AppDefined,
2746
0
                     "%s=%s unsupported, "
2747
0
                     "value must be PIXEL or BAND. ignoring",
2748
0
                     pszOptionKey, pszInterleave);
2749
0
        }
2750
0
    }
2751
2752
    /* -------------------------------------------------------------------- */
2753
    /*      Determine predictor tag                                         */
2754
    /* -------------------------------------------------------------------- */
2755
0
    nPredictor = PREDICTOR_NONE;
2756
0
    if (GTIFFSupportsPredictor(nCompression))
2757
0
    {
2758
0
        const char *pszPredictor =
2759
0
            GetOptionValue("PREDICTOR", "PREDICTOR_OVERVIEW");
2760
0
        if (pszPredictor != nullptr)
2761
0
        {
2762
0
            nPredictor = static_cast<uint16_t>(atoi(pszPredictor));
2763
0
        }
2764
0
        else if (GTIFFSupportsPredictor(m_nCompression))
2765
0
            TIFFGetField(m_hTIFF, TIFFTAG_PREDICTOR, &nPredictor);
2766
0
    }
2767
2768
    /* -------------------------------------------------------------------- */
2769
    /*      Determine photometric tag                                       */
2770
    /* -------------------------------------------------------------------- */
2771
0
    if (m_nPhotometric == PHOTOMETRIC_YCBCR && nCompression != COMPRESSION_JPEG)
2772
0
        nPhotometric = PHOTOMETRIC_RGB;
2773
0
    else
2774
0
        nPhotometric = m_nPhotometric;
2775
0
    const char *pszPhotometric =
2776
0
        GetOptionValue("PHOTOMETRIC", "PHOTOMETRIC_OVERVIEW", &pszOptionKey);
2777
0
    if (!GTIFFUpdatePhotometric(pszPhotometric, pszOptionKey, nCompression,
2778
0
                                pszInterleave, nBands, nPhotometric,
2779
0
                                nPlanarConfig))
2780
0
    {
2781
0
        return false;
2782
0
    }
2783
2784
    /* -------------------------------------------------------------------- */
2785
    /*      Determine JPEG quality                                          */
2786
    /* -------------------------------------------------------------------- */
2787
0
    nOvrJpegQuality = m_nJpegQuality;
2788
0
    if (nCompression == COMPRESSION_JPEG)
2789
0
    {
2790
0
        const char *pszJPEGQuality =
2791
0
            GetOptionValue("JPEG_QUALITY", "JPEG_QUALITY_OVERVIEW");
2792
0
        if (pszJPEGQuality != nullptr)
2793
0
        {
2794
0
            nOvrJpegQuality = atoi(pszJPEGQuality);
2795
0
        }
2796
0
    }
2797
2798
    /* -------------------------------------------------------------------- */
2799
    /*      Set nodata.                                                     */
2800
    /* -------------------------------------------------------------------- */
2801
0
    if (m_bNoDataSet)
2802
0
    {
2803
0
        osNoData = GTiffFormatGDALNoDataTagValue(m_dfNoDataValue);
2804
0
    }
2805
2806
    /* -------------------------------------------------------------------- */
2807
    /*      Fetch extra sample tag                                          */
2808
    /* -------------------------------------------------------------------- */
2809
0
    panExtraSampleValues = nullptr;
2810
0
    nExtraSamples = 0;
2811
0
    if (TIFFGetField(m_hTIFF, TIFFTAG_EXTRASAMPLES, &nExtraSamples,
2812
0
                     &panExtraSampleValues))
2813
0
    {
2814
0
        uint16_t *panExtraSampleValuesNew = static_cast<uint16_t *>(
2815
0
            CPLMalloc(nExtraSamples * sizeof(uint16_t)));
2816
0
        memcpy(panExtraSampleValuesNew, panExtraSampleValues,
2817
0
               nExtraSamples * sizeof(uint16_t));
2818
0
        panExtraSampleValues = panExtraSampleValuesNew;
2819
0
    }
2820
0
    else
2821
0
    {
2822
0
        panExtraSampleValues = nullptr;
2823
0
        nExtraSamples = 0;
2824
0
    }
2825
2826
0
    return true;
2827
0
}
2828
2829
/************************************************************************/
2830
/*                  CreateOverviewsFromSrcOverviews()                   */
2831
/************************************************************************/
2832
2833
// If poOvrDS is not null, it is used and poSrcDS is ignored.
2834
2835
CPLErr GTiffDataset::CreateOverviewsFromSrcOverviews(GDALDataset *poSrcDS,
2836
                                                     GDALDataset *poOvrDS,
2837
                                                     int nOverviews)
2838
0
{
2839
0
    CPLAssert(poSrcDS->GetRasterCount() != 0);
2840
0
    CPLAssert(m_apoOverviewDS.empty());
2841
2842
0
    ScanDirectories();
2843
2844
0
    FlushDirectory();
2845
2846
0
    int nOvBitsPerSample = m_nBitsPerSample;
2847
2848
    /* -------------------------------------------------------------------- */
2849
    /*      Do we need some metadata for the overviews?                     */
2850
    /* -------------------------------------------------------------------- */
2851
0
    CPLString osMetadata;
2852
2853
0
    GTIFFBuildOverviewMetadata("NONE", this, false, osMetadata);
2854
2855
0
    int nCompression;
2856
0
    uint16_t nPlanarConfig;
2857
0
    uint16_t nPredictor;
2858
0
    uint16_t nPhotometric;
2859
0
    int nOvrJpegQuality;
2860
0
    std::string osNoData;
2861
0
    uint16_t *panExtraSampleValues = nullptr;
2862
0
    uint16_t nExtraSamples = 0;
2863
0
    if (!GetOverviewParameters(nCompression, nPlanarConfig, nPredictor,
2864
0
                               nPhotometric, nOvrJpegQuality, osNoData,
2865
0
                               panExtraSampleValues, nExtraSamples,
2866
0
                               /*papszOptions=*/nullptr))
2867
0
    {
2868
0
        return CE_Failure;
2869
0
    }
2870
2871
    /* -------------------------------------------------------------------- */
2872
    /*      Do we have a palette?  If so, create a TIFF compatible version. */
2873
    /* -------------------------------------------------------------------- */
2874
0
    std::vector<unsigned short> anTRed;
2875
0
    std::vector<unsigned short> anTGreen;
2876
0
    std::vector<unsigned short> anTBlue;
2877
0
    unsigned short *panRed = nullptr;
2878
0
    unsigned short *panGreen = nullptr;
2879
0
    unsigned short *panBlue = nullptr;
2880
2881
0
    if (nPhotometric == PHOTOMETRIC_PALETTE && m_poColorTable != nullptr)
2882
0
    {
2883
0
        if (m_nColorTableMultiplier == 0)
2884
0
            m_nColorTableMultiplier = DEFAULT_COLOR_TABLE_MULTIPLIER_257;
2885
2886
0
        CreateTIFFColorTable(m_poColorTable.get(), nOvBitsPerSample,
2887
0
                             m_nColorTableMultiplier, anTRed, anTGreen, anTBlue,
2888
0
                             panRed, panGreen, panBlue);
2889
0
    }
2890
2891
0
    int nOvrBlockXSize = 0;
2892
0
    int nOvrBlockYSize = 0;
2893
0
    GTIFFGetOverviewBlockSize(GDALRasterBand::ToHandle(GetRasterBand(1)),
2894
0
                              &nOvrBlockXSize, &nOvrBlockYSize, nullptr,
2895
0
                              nullptr);
2896
2897
0
    CPLErr eErr = CE_None;
2898
2899
0
    for (int i = 0; i < nOverviews && eErr == CE_None; ++i)
2900
0
    {
2901
0
        GDALRasterBand *poOvrBand =
2902
0
            poOvrDS ? ((i == 0) ? poOvrDS->GetRasterBand(1)
2903
0
                                : poOvrDS->GetRasterBand(1)->GetOverview(i - 1))
2904
0
                    : poSrcDS->GetRasterBand(1)->GetOverview(i);
2905
2906
0
        int nOXSize = poOvrBand->GetXSize();
2907
0
        int nOYSize = poOvrBand->GetYSize();
2908
2909
0
        toff_t nOverviewOffset = GTIFFWriteDirectory(
2910
0
            m_hTIFF, FILETYPE_REDUCEDIMAGE, nOXSize, nOYSize, nOvBitsPerSample,
2911
0
            nPlanarConfig, m_nSamplesPerPixel, nOvrBlockXSize, nOvrBlockYSize,
2912
0
            TRUE, nCompression, nPhotometric, m_nSampleFormat, nPredictor,
2913
0
            panRed, panGreen, panBlue, nExtraSamples, panExtraSampleValues,
2914
0
            osMetadata,
2915
0
            nOvrJpegQuality >= 0 ? CPLSPrintf("%d", nOvrJpegQuality) : nullptr,
2916
0
            CPLSPrintf("%d", m_nJpegTablesMode),
2917
0
            osNoData.empty() ? nullptr : osNoData.c_str(),
2918
0
            m_anLercAddCompressionAndVersion, m_bWriteCOGLayout);
2919
2920
0
        if (nOverviewOffset == 0)
2921
0
            eErr = CE_Failure;
2922
0
        else
2923
0
            eErr = RegisterNewOverviewDataset(nOverviewOffset, nOvrJpegQuality,
2924
0
                                              nullptr);
2925
0
    }
2926
2927
    // For directory reloading, so that the chaining to the next directory is
2928
    // reloaded, as well as compression parameters.
2929
0
    ReloadDirectory();
2930
2931
0
    CPLFree(panExtraSampleValues);
2932
0
    panExtraSampleValues = nullptr;
2933
2934
0
    return eErr;
2935
0
}
2936
2937
/************************************************************************/
2938
/*                    CreateInternalMaskOverviews()                     */
2939
/************************************************************************/
2940
2941
CPLErr GTiffDataset::CreateInternalMaskOverviews(int nOvrBlockXSize,
2942
                                                 int nOvrBlockYSize)
2943
0
{
2944
0
    ScanDirectories();
2945
2946
    /* -------------------------------------------------------------------- */
2947
    /*      Create overviews for the mask.                                  */
2948
    /* -------------------------------------------------------------------- */
2949
0
    CPLErr eErr = CE_None;
2950
2951
0
    if (m_poMaskDS != nullptr && m_poMaskDS->GetRasterCount() == 1)
2952
0
    {
2953
0
        int nMaskOvrCompression;
2954
0
        if (strstr(GDALGetMetadataItem(GDALGetDriverByName("GTiff"),
2955
0
                                       GDAL_DMD_CREATIONOPTIONLIST, nullptr),
2956
0
                   "<Value>DEFLATE</Value>") != nullptr)
2957
0
            nMaskOvrCompression = COMPRESSION_ADOBE_DEFLATE;
2958
0
        else
2959
0
            nMaskOvrCompression = COMPRESSION_PACKBITS;
2960
2961
0
        for (auto &poOvrDS : m_apoOverviewDS)
2962
0
        {
2963
0
            if (poOvrDS->m_poMaskDS == nullptr)
2964
0
            {
2965
0
                const toff_t nOverviewOffset = GTIFFWriteDirectory(
2966
0
                    m_hTIFF, FILETYPE_REDUCEDIMAGE | FILETYPE_MASK,
2967
0
                    poOvrDS->nRasterXSize, poOvrDS->nRasterYSize, 1,
2968
0
                    PLANARCONFIG_CONTIG, 1, nOvrBlockXSize, nOvrBlockYSize,
2969
0
                    TRUE, nMaskOvrCompression, PHOTOMETRIC_MASK,
2970
0
                    SAMPLEFORMAT_UINT, PREDICTOR_NONE, nullptr, nullptr,
2971
0
                    nullptr, 0, nullptr, "", nullptr, nullptr, nullptr, nullptr,
2972
0
                    m_bWriteCOGLayout);
2973
2974
0
                if (nOverviewOffset == 0)
2975
0
                {
2976
0
                    eErr = CE_Failure;
2977
0
                    continue;
2978
0
                }
2979
2980
0
                auto poMaskODS = std::make_shared<GTiffDataset>();
2981
0
                poMaskODS->eAccess = GA_Update;
2982
0
                poMaskODS->ShareLockWithParentDataset(this);
2983
0
                poMaskODS->m_osFilename = m_osFilename;
2984
0
                if (poMaskODS->OpenOffset(VSI_TIFFOpenChild(m_hTIFF),
2985
0
                                          nOverviewOffset,
2986
0
                                          GA_Update) != CE_None)
2987
0
                {
2988
0
                    eErr = CE_Failure;
2989
0
                }
2990
0
                else
2991
0
                {
2992
0
                    poMaskODS->m_bPromoteTo8Bits =
2993
0
                        CPLTestBool(CPLGetConfigOption(
2994
0
                            "GDAL_TIFF_INTERNAL_MASK_TO_8BIT", "YES"));
2995
0
                    poMaskODS->m_poBaseDS = this;
2996
0
                    poMaskODS->m_poImageryDS = poOvrDS.get();
2997
0
                    poOvrDS->m_poMaskDS = poMaskODS;
2998
0
                    m_poMaskDS->m_apoOverviewDS.push_back(std::move(poMaskODS));
2999
0
                }
3000
0
            }
3001
0
        }
3002
0
    }
3003
3004
0
    ReloadDirectory();
3005
3006
0
    return eErr;
3007
0
}
3008
3009
/************************************************************************/
3010
/*                            AddOverviews()                            */
3011
/************************************************************************/
3012
3013
CPLErr
3014
GTiffDataset::AddOverviews(const std::vector<GDALDataset *> &apoSrcOvrDSIn,
3015
                           GDALProgressFunc pfnProgress, void *pProgressData,
3016
                           CSLConstList papszOptions)
3017
0
{
3018
    /* -------------------------------------------------------------------- */
3019
    /*      If we don't have read access, then create the overviews         */
3020
    /*      externally.                                                     */
3021
    /* -------------------------------------------------------------------- */
3022
0
    if (GetAccess() != GA_Update)
3023
0
    {
3024
0
        CPLDebug("GTiff", "File open for read-only accessing, "
3025
0
                          "creating overviews externally.");
3026
3027
0
        CPLErr eErr = GDALDataset::AddOverviews(apoSrcOvrDSIn, pfnProgress,
3028
0
                                                pProgressData, papszOptions);
3029
0
        if (eErr == CE_None && m_poMaskDS)
3030
0
        {
3031
0
            ReportError(
3032
0
                CE_Warning, CPLE_NotSupported,
3033
0
                "Building external overviews whereas there is an internal "
3034
0
                "mask is not fully supported. "
3035
0
                "The overviews of the non-mask bands will be created, "
3036
0
                "but not the overviews of the mask band.");
3037
0
        }
3038
0
        return eErr;
3039
0
    }
3040
3041
0
    std::vector<GDALDataset *> apoSrcOvrDS = apoSrcOvrDSIn;
3042
    // Sort overviews by descending size
3043
0
    std::sort(apoSrcOvrDS.begin(), apoSrcOvrDS.end(),
3044
0
              [](const GDALDataset *poDS1, const GDALDataset *poDS2)
3045
0
              { return poDS1->GetRasterXSize() > poDS2->GetRasterXSize(); });
3046
3047
0
    if (!GDALDefaultOverviews::CheckSrcOverviewsConsistencyWithBase(
3048
0
            this, apoSrcOvrDS))
3049
0
        return CE_Failure;
3050
3051
0
    ScanDirectories();
3052
3053
    // Make implicit JPEG overviews invisible, but do not destroy
3054
    // them in case they are already used (not sure that the client
3055
    // has the right to do that). Behavior maybe undefined in GDAL API.
3056
0
    std::swap(m_apoJPEGOverviewDSOld, m_apoJPEGOverviewDS);
3057
0
    m_apoJPEGOverviewDS.clear();
3058
3059
0
    FlushDirectory();
3060
3061
    /* -------------------------------------------------------------------- */
3062
    /*      If we are averaging bit data to grayscale we need to create     */
3063
    /*      8bit overviews.                                                 */
3064
    /* -------------------------------------------------------------------- */
3065
0
    int nOvBitsPerSample = m_nBitsPerSample;
3066
3067
    /* -------------------------------------------------------------------- */
3068
    /*      Do we need some metadata for the overviews?                     */
3069
    /* -------------------------------------------------------------------- */
3070
0
    CPLString osMetadata;
3071
3072
0
    const bool bIsForMaskBand = nBands == 1 && GetRasterBand(1)->IsMaskBand();
3073
0
    GTIFFBuildOverviewMetadata(/* resampling = */ "", this, bIsForMaskBand,
3074
0
                               osMetadata);
3075
3076
0
    int nCompression;
3077
0
    uint16_t nPlanarConfig;
3078
0
    uint16_t nPredictor;
3079
0
    uint16_t nPhotometric;
3080
0
    int nOvrJpegQuality;
3081
0
    std::string osNoData;
3082
0
    uint16_t *panExtraSampleValues = nullptr;
3083
0
    uint16_t nExtraSamples = 0;
3084
0
    if (!GetOverviewParameters(nCompression, nPlanarConfig, nPredictor,
3085
0
                               nPhotometric, nOvrJpegQuality, osNoData,
3086
0
                               panExtraSampleValues, nExtraSamples,
3087
0
                               papszOptions))
3088
0
    {
3089
0
        return CE_Failure;
3090
0
    }
3091
3092
    /* -------------------------------------------------------------------- */
3093
    /*      Do we have a palette?  If so, create a TIFF compatible version. */
3094
    /* -------------------------------------------------------------------- */
3095
0
    std::vector<unsigned short> anTRed;
3096
0
    std::vector<unsigned short> anTGreen;
3097
0
    std::vector<unsigned short> anTBlue;
3098
0
    unsigned short *panRed = nullptr;
3099
0
    unsigned short *panGreen = nullptr;
3100
0
    unsigned short *panBlue = nullptr;
3101
3102
0
    if (nPhotometric == PHOTOMETRIC_PALETTE && m_poColorTable != nullptr)
3103
0
    {
3104
0
        if (m_nColorTableMultiplier == 0)
3105
0
            m_nColorTableMultiplier = DEFAULT_COLOR_TABLE_MULTIPLIER_257;
3106
3107
0
        CreateTIFFColorTable(m_poColorTable.get(), nOvBitsPerSample,
3108
0
                             m_nColorTableMultiplier, anTRed, anTGreen, anTBlue,
3109
0
                             panRed, panGreen, panBlue);
3110
0
    }
3111
3112
    /* -------------------------------------------------------------------- */
3113
    /*      Establish which of the overview levels we already have, and     */
3114
    /*      which are new.  We assume that band 1 of the file is            */
3115
    /*      representative.                                                 */
3116
    /* -------------------------------------------------------------------- */
3117
0
    int nOvrBlockXSize = 0;
3118
0
    int nOvrBlockYSize = 0;
3119
0
    GTIFFGetOverviewBlockSize(GDALRasterBand::ToHandle(GetRasterBand(1)),
3120
0
                              &nOvrBlockXSize, &nOvrBlockYSize, papszOptions,
3121
0
                              "BLOCKSIZE");
3122
3123
0
    CPLErr eErr = CE_None;
3124
0
    for (const auto *poSrcOvrDS : apoSrcOvrDS)
3125
0
    {
3126
0
        bool bFound = false;
3127
0
        for (auto &poOvrDS : m_apoOverviewDS)
3128
0
        {
3129
0
            if (poOvrDS->GetRasterXSize() == poSrcOvrDS->GetRasterXSize() &&
3130
0
                poOvrDS->GetRasterYSize() == poSrcOvrDS->GetRasterYSize())
3131
0
            {
3132
0
                bFound = true;
3133
0
                break;
3134
0
            }
3135
0
        }
3136
0
        if (!bFound && eErr == CE_None)
3137
0
        {
3138
0
            if (m_bLayoutIFDSBeforeData && !m_bKnownIncompatibleEdition &&
3139
0
                !m_bWriteKnownIncompatibleEdition)
3140
0
            {
3141
0
                ReportError(CE_Warning, CPLE_AppDefined,
3142
0
                            "Adding new overviews invalidates the "
3143
0
                            "LAYOUT=IFDS_BEFORE_DATA property");
3144
0
                m_bKnownIncompatibleEdition = true;
3145
0
                m_bWriteKnownIncompatibleEdition = true;
3146
0
            }
3147
3148
0
            const toff_t nOverviewOffset = GTIFFWriteDirectory(
3149
0
                m_hTIFF, FILETYPE_REDUCEDIMAGE, poSrcOvrDS->GetRasterXSize(),
3150
0
                poSrcOvrDS->GetRasterYSize(), nOvBitsPerSample, nPlanarConfig,
3151
0
                m_nSamplesPerPixel, nOvrBlockXSize, nOvrBlockYSize, TRUE,
3152
0
                nCompression, nPhotometric, m_nSampleFormat, nPredictor, panRed,
3153
0
                panGreen, panBlue, nExtraSamples, panExtraSampleValues,
3154
0
                osMetadata,
3155
0
                nOvrJpegQuality >= 0 ? CPLSPrintf("%d", nOvrJpegQuality)
3156
0
                                     : nullptr,
3157
0
                CPLSPrintf("%d", m_nJpegTablesMode),
3158
0
                osNoData.empty() ? nullptr : osNoData.c_str(),
3159
0
                m_anLercAddCompressionAndVersion, false);
3160
3161
0
            if (nOverviewOffset == 0)
3162
0
                eErr = CE_Failure;
3163
0
            else
3164
0
                eErr = RegisterNewOverviewDataset(
3165
0
                    nOverviewOffset, nOvrJpegQuality, papszOptions);
3166
0
        }
3167
0
    }
3168
3169
0
    CPLFree(panExtraSampleValues);
3170
0
    panExtraSampleValues = nullptr;
3171
3172
0
    ReloadDirectory();
3173
3174
0
    if (!pfnProgress)
3175
0
        pfnProgress = GDALDummyProgress;
3176
3177
    // almost 0, but not 0 to please Coverity Scan
3178
0
    double dfTotalPixels = std::numeric_limits<double>::min();
3179
0
    for (const auto *poSrcOvrDS : apoSrcOvrDS)
3180
0
    {
3181
0
        dfTotalPixels += static_cast<double>(poSrcOvrDS->GetRasterXSize()) *
3182
0
                         poSrcOvrDS->GetRasterYSize();
3183
0
    }
3184
3185
    // Copy source datasets into target overview datasets
3186
0
    double dfCurPixels = 0;
3187
0
    for (auto *poSrcOvrDS : apoSrcOvrDS)
3188
0
    {
3189
0
        GDALDataset *poDstOvrDS = nullptr;
3190
0
        for (auto &poOvrDS : m_apoOverviewDS)
3191
0
        {
3192
0
            if (poOvrDS->GetRasterXSize() == poSrcOvrDS->GetRasterXSize() &&
3193
0
                poOvrDS->GetRasterYSize() == poSrcOvrDS->GetRasterYSize())
3194
0
            {
3195
0
                poDstOvrDS = poOvrDS.get();
3196
0
                break;
3197
0
            }
3198
0
        }
3199
0
        if (eErr == CE_None && poDstOvrDS)
3200
0
        {
3201
0
            const double dfThisPixels =
3202
0
                static_cast<double>(poSrcOvrDS->GetRasterXSize()) *
3203
0
                poSrcOvrDS->GetRasterYSize();
3204
0
            void *pScaledProgressData = GDALCreateScaledProgress(
3205
0
                dfCurPixels / dfTotalPixels,
3206
0
                (dfCurPixels + dfThisPixels) / dfTotalPixels, pfnProgress,
3207
0
                pProgressData);
3208
0
            dfCurPixels += dfThisPixels;
3209
0
            eErr = GDALDatasetCopyWholeRaster(GDALDataset::ToHandle(poSrcOvrDS),
3210
0
                                              GDALDataset::ToHandle(poDstOvrDS),
3211
0
                                              nullptr, GDALScaledProgress,
3212
0
                                              pScaledProgressData);
3213
0
            GDALDestroyScaledProgress(pScaledProgressData);
3214
0
        }
3215
0
    }
3216
3217
0
    return eErr;
3218
0
}
3219
3220
/************************************************************************/
3221
/*                          IBuildOverviews()                           */
3222
/************************************************************************/
3223
3224
CPLErr GTiffDataset::IBuildOverviews(const char *pszResampling, int nOverviews,
3225
                                     const int *panOverviewList, int nBandsIn,
3226
                                     const int *panBandList,
3227
                                     GDALProgressFunc pfnProgress,
3228
                                     void *pProgressData,
3229
                                     CSLConstList papszOptions)
3230
3231
0
{
3232
0
    ScanDirectories();
3233
3234
    // Make implicit JPEG overviews invisible, but do not destroy
3235
    // them in case they are already used (not sure that the client
3236
    // has the right to do that.  Behavior maybe undefined in GDAL API.
3237
0
    std::swap(m_apoJPEGOverviewDSOld, m_apoJPEGOverviewDS);
3238
0
    m_apoJPEGOverviewDS.clear();
3239
3240
    /* -------------------------------------------------------------------- */
3241
    /*      If RRD or external OVR overviews requested, then invoke         */
3242
    /*      generic handling.                                               */
3243
    /* -------------------------------------------------------------------- */
3244
0
    bool bUseGenericHandling = false;
3245
0
    bool bUseRRD = false;
3246
0
    CPLStringList aosOptions(papszOptions);
3247
3248
0
    const char *pszLocation = CSLFetchNameValue(papszOptions, "LOCATION");
3249
0
    if (pszLocation && EQUAL(pszLocation, "EXTERNAL"))
3250
0
    {
3251
0
        bUseGenericHandling = true;
3252
0
    }
3253
0
    else if (pszLocation && EQUAL(pszLocation, "INTERNAL"))
3254
0
    {
3255
0
        if (GetAccess() != GA_Update)
3256
0
        {
3257
0
            CPLError(CE_Failure, CPLE_AppDefined,
3258
0
                     "Cannot create internal overviews on file opened in "
3259
0
                     "read-only mode");
3260
0
            return CE_Failure;
3261
0
        }
3262
0
    }
3263
0
    else if (pszLocation && EQUAL(pszLocation, "RRD"))
3264
0
    {
3265
0
        bUseGenericHandling = true;
3266
0
        bUseRRD = true;
3267
0
        aosOptions.SetNameValue("USE_RRD", "YES");
3268
0
    }
3269
    // Legacy
3270
0
    else if ((bUseRRD = CPLTestBool(
3271
0
                  CSLFetchNameValueDef(papszOptions, "USE_RRD",
3272
0
                                       CPLGetConfigOption("USE_RRD", "NO")))) ||
3273
0
             CPLTestBool(CSLFetchNameValueDef(
3274
0
                 papszOptions, "TIFF_USE_OVR",
3275
0
                 CPLGetConfigOption("TIFF_USE_OVR", "NO"))))
3276
0
    {
3277
0
        bUseGenericHandling = true;
3278
0
    }
3279
3280
    /* -------------------------------------------------------------------- */
3281
    /*      If we don't have read access, then create the overviews         */
3282
    /*      externally.                                                     */
3283
    /* -------------------------------------------------------------------- */
3284
0
    if (GetAccess() != GA_Update)
3285
0
    {
3286
0
        CPLDebug("GTiff", "File open for read-only accessing, "
3287
0
                          "creating overviews externally.");
3288
3289
0
        bUseGenericHandling = true;
3290
0
    }
3291
3292
0
    if (bUseGenericHandling)
3293
0
    {
3294
0
        if (!m_apoOverviewDS.empty())
3295
0
        {
3296
0
            ReportError(CE_Failure, CPLE_NotSupported,
3297
0
                        "Cannot add external overviews when there are already "
3298
0
                        "internal overviews");
3299
0
            return CE_Failure;
3300
0
        }
3301
3302
0
        if (!m_bWriteEmptyTiles && !bUseRRD)
3303
0
        {
3304
0
            aosOptions.SetNameValue("SPARSE_OK", "YES");
3305
0
        }
3306
3307
0
        CPLErr eErr = GDALDataset::IBuildOverviews(
3308
0
            pszResampling, nOverviews, panOverviewList, nBandsIn, panBandList,
3309
0
            pfnProgress, pProgressData, aosOptions);
3310
0
        if (eErr == CE_None && m_poMaskDS)
3311
0
        {
3312
0
            ReportError(
3313
0
                CE_Warning, CPLE_NotSupported,
3314
0
                "Building external overviews whereas there is an internal "
3315
0
                "mask is not fully supported. "
3316
0
                "The overviews of the non-mask bands will be created, "
3317
0
                "but not the overviews of the mask band.");
3318
0
        }
3319
0
        return eErr;
3320
0
    }
3321
3322
    /* -------------------------------------------------------------------- */
3323
    /*      Our TIFF overview support currently only works safely if all    */
3324
    /*      bands are handled at the same time.                             */
3325
    /* -------------------------------------------------------------------- */
3326
0
    if (nBandsIn != GetRasterCount())
3327
0
    {
3328
0
        ReportError(CE_Failure, CPLE_NotSupported,
3329
0
                    "Generation of overviews in TIFF currently only "
3330
0
                    "supported when operating on all bands.  "
3331
0
                    "Operation failed.");
3332
0
        return CE_Failure;
3333
0
    }
3334
3335
    /* -------------------------------------------------------------------- */
3336
    /*      If zero overviews were requested, we need to clear all          */
3337
    /*      existing overviews.                                             */
3338
    /* -------------------------------------------------------------------- */
3339
0
    if (nOverviews == 0)
3340
0
    {
3341
0
        if (m_apoOverviewDS.empty())
3342
0
            return GDALDataset::IBuildOverviews(
3343
0
                pszResampling, nOverviews, panOverviewList, nBandsIn,
3344
0
                panBandList, pfnProgress, pProgressData, papszOptions);
3345
3346
0
        return CleanOverviews();
3347
0
    }
3348
3349
0
    CPLErr eErr = CE_None;
3350
3351
    /* -------------------------------------------------------------------- */
3352
    /*      Initialize progress counter.                                    */
3353
    /* -------------------------------------------------------------------- */
3354
0
    if (!pfnProgress(0.0, nullptr, pProgressData))
3355
0
    {
3356
0
        ReportError(CE_Failure, CPLE_UserInterrupt, "User terminated");
3357
0
        return CE_Failure;
3358
0
    }
3359
3360
0
    FlushDirectory();
3361
3362
    /* -------------------------------------------------------------------- */
3363
    /*      If we are averaging bit data to grayscale we need to create     */
3364
    /*      8bit overviews.                                                 */
3365
    /* -------------------------------------------------------------------- */
3366
0
    int nOvBitsPerSample = m_nBitsPerSample;
3367
3368
0
    if (STARTS_WITH_CI(pszResampling, "AVERAGE_BIT2"))
3369
0
        nOvBitsPerSample = 8;
3370
3371
    /* -------------------------------------------------------------------- */
3372
    /*      Do we need some metadata for the overviews?                     */
3373
    /* -------------------------------------------------------------------- */
3374
0
    CPLString osMetadata;
3375
3376
0
    const bool bIsForMaskBand = nBands == 1 && GetRasterBand(1)->IsMaskBand();
3377
0
    GTIFFBuildOverviewMetadata(pszResampling, this, bIsForMaskBand, osMetadata);
3378
3379
0
    int nCompression;
3380
0
    uint16_t nPlanarConfig;
3381
0
    uint16_t nPredictor;
3382
0
    uint16_t nPhotometric;
3383
0
    int nOvrJpegQuality;
3384
0
    std::string osNoData;
3385
0
    uint16_t *panExtraSampleValues = nullptr;
3386
0
    uint16_t nExtraSamples = 0;
3387
0
    if (!GetOverviewParameters(nCompression, nPlanarConfig, nPredictor,
3388
0
                               nPhotometric, nOvrJpegQuality, osNoData,
3389
0
                               panExtraSampleValues, nExtraSamples,
3390
0
                               papszOptions))
3391
0
    {
3392
0
        return CE_Failure;
3393
0
    }
3394
3395
    /* -------------------------------------------------------------------- */
3396
    /*      Do we have a palette?  If so, create a TIFF compatible version. */
3397
    /* -------------------------------------------------------------------- */
3398
0
    std::vector<unsigned short> anTRed;
3399
0
    std::vector<unsigned short> anTGreen;
3400
0
    std::vector<unsigned short> anTBlue;
3401
0
    unsigned short *panRed = nullptr;
3402
0
    unsigned short *panGreen = nullptr;
3403
0
    unsigned short *panBlue = nullptr;
3404
3405
0
    if (nPhotometric == PHOTOMETRIC_PALETTE && m_poColorTable != nullptr)
3406
0
    {
3407
0
        if (m_nColorTableMultiplier == 0)
3408
0
            m_nColorTableMultiplier = DEFAULT_COLOR_TABLE_MULTIPLIER_257;
3409
3410
0
        CreateTIFFColorTable(m_poColorTable.get(), nOvBitsPerSample,
3411
0
                             m_nColorTableMultiplier, anTRed, anTGreen, anTBlue,
3412
0
                             panRed, panGreen, panBlue);
3413
0
    }
3414
3415
    /* -------------------------------------------------------------------- */
3416
    /*      Establish which of the overview levels we already have, and     */
3417
    /*      which are new.  We assume that band 1 of the file is            */
3418
    /*      representative.                                                 */
3419
    /* -------------------------------------------------------------------- */
3420
0
    int nOvrBlockXSize = 0;
3421
0
    int nOvrBlockYSize = 0;
3422
0
    GTIFFGetOverviewBlockSize(GDALRasterBand::ToHandle(GetRasterBand(1)),
3423
0
                              &nOvrBlockXSize, &nOvrBlockYSize, papszOptions,
3424
0
                              "BLOCKSIZE");
3425
0
    std::vector<bool> abRequireNewOverview(nOverviews, true);
3426
0
    for (int i = 0; i < nOverviews && eErr == CE_None; ++i)
3427
0
    {
3428
0
        for (auto &poODS : m_apoOverviewDS)
3429
0
        {
3430
0
            const int nOvFactor =
3431
0
                GDALComputeOvFactor(poODS->GetRasterXSize(), GetRasterXSize(),
3432
0
                                    poODS->GetRasterYSize(), GetRasterYSize());
3433
3434
            // If we already have a 1x1 overview and this new one would result
3435
            // in it too, then don't create it.
3436
0
            if (poODS->GetRasterXSize() == 1 && poODS->GetRasterYSize() == 1 &&
3437
0
                DIV_ROUND_UP(GetRasterXSize(), panOverviewList[i]) == 1 &&
3438
0
                DIV_ROUND_UP(GetRasterYSize(), panOverviewList[i]) == 1)
3439
0
            {
3440
0
                abRequireNewOverview[i] = false;
3441
0
                break;
3442
0
            }
3443
3444
0
            if (nOvFactor == panOverviewList[i] ||
3445
0
                nOvFactor == GDALOvLevelAdjust2(panOverviewList[i],
3446
0
                                                GetRasterXSize(),
3447
0
                                                GetRasterYSize()))
3448
0
            {
3449
0
                abRequireNewOverview[i] = false;
3450
0
                break;
3451
0
            }
3452
0
        }
3453
3454
0
        if (abRequireNewOverview[i])
3455
0
        {
3456
0
            if (m_bLayoutIFDSBeforeData && !m_bKnownIncompatibleEdition &&
3457
0
                !m_bWriteKnownIncompatibleEdition)
3458
0
            {
3459
0
                ReportError(CE_Warning, CPLE_AppDefined,
3460
0
                            "Adding new overviews invalidates the "
3461
0
                            "LAYOUT=IFDS_BEFORE_DATA property");
3462
0
                m_bKnownIncompatibleEdition = true;
3463
0
                m_bWriteKnownIncompatibleEdition = true;
3464
0
            }
3465
3466
0
            const int nOXSize =
3467
0
                DIV_ROUND_UP(GetRasterXSize(), panOverviewList[i]);
3468
0
            const int nOYSize =
3469
0
                DIV_ROUND_UP(GetRasterYSize(), panOverviewList[i]);
3470
3471
0
            const toff_t nOverviewOffset = GTIFFWriteDirectory(
3472
0
                m_hTIFF, FILETYPE_REDUCEDIMAGE, nOXSize, nOYSize,
3473
0
                nOvBitsPerSample, nPlanarConfig, m_nSamplesPerPixel,
3474
0
                nOvrBlockXSize, nOvrBlockYSize, TRUE, nCompression,
3475
0
                nPhotometric, m_nSampleFormat, nPredictor, panRed, panGreen,
3476
0
                panBlue, nExtraSamples, panExtraSampleValues, osMetadata,
3477
0
                nOvrJpegQuality >= 0 ? CPLSPrintf("%d", nOvrJpegQuality)
3478
0
                                     : nullptr,
3479
0
                CPLSPrintf("%d", m_nJpegTablesMode),
3480
0
                osNoData.empty() ? nullptr : osNoData.c_str(),
3481
0
                m_anLercAddCompressionAndVersion, false);
3482
3483
0
            if (nOverviewOffset == 0)
3484
0
                eErr = CE_Failure;
3485
0
            else
3486
0
                eErr = RegisterNewOverviewDataset(
3487
0
                    nOverviewOffset, nOvrJpegQuality, papszOptions);
3488
0
        }
3489
0
    }
3490
3491
0
    CPLFree(panExtraSampleValues);
3492
0
    panExtraSampleValues = nullptr;
3493
3494
0
    ReloadDirectory();
3495
3496
    /* -------------------------------------------------------------------- */
3497
    /*      Create overviews for the mask.                                  */
3498
    /* -------------------------------------------------------------------- */
3499
0
    if (eErr != CE_None)
3500
0
        return eErr;
3501
3502
0
    eErr = CreateInternalMaskOverviews(nOvrBlockXSize, nOvrBlockYSize);
3503
3504
    /* -------------------------------------------------------------------- */
3505
    /*      Refresh overviews for the mask                                  */
3506
    /* -------------------------------------------------------------------- */
3507
0
    const bool bHasInternalMask =
3508
0
        m_poMaskDS != nullptr && m_poMaskDS->GetRasterCount() == 1;
3509
0
    const bool bHasExternalMask =
3510
0
        !bHasInternalMask && oOvManager.HaveMaskFile();
3511
0
    const bool bHasMask = bHasInternalMask || bHasExternalMask;
3512
3513
0
    if (bHasInternalMask)
3514
0
    {
3515
0
        std::vector<GDALRasterBandH> ahOverviewBands;
3516
0
        for (auto &poOvrDS : m_apoOverviewDS)
3517
0
        {
3518
0
            if (poOvrDS->m_poMaskDS != nullptr)
3519
0
            {
3520
0
                ahOverviewBands.push_back(GDALRasterBand::ToHandle(
3521
0
                    poOvrDS->m_poMaskDS->GetRasterBand(1)));
3522
0
            }
3523
0
        }
3524
3525
0
        void *pScaledProgressData = GDALCreateScaledProgress(
3526
0
            0, 1.0 / (nBands + 1), pfnProgress, pProgressData);
3527
0
        eErr = GDALRegenerateOverviewsEx(
3528
0
            m_poMaskDS->GetRasterBand(1),
3529
0
            static_cast<int>(ahOverviewBands.size()), ahOverviewBands.data(),
3530
0
            pszResampling, GDALScaledProgress, pScaledProgressData,
3531
0
            papszOptions);
3532
0
        GDALDestroyScaledProgress(pScaledProgressData);
3533
0
    }
3534
0
    else if (bHasExternalMask)
3535
0
    {
3536
0
        void *pScaledProgressData = GDALCreateScaledProgress(
3537
0
            0, 1.0 / (nBands + 1), pfnProgress, pProgressData);
3538
0
        eErr = oOvManager.BuildOverviewsMask(
3539
0
            pszResampling, nOverviews, panOverviewList, GDALScaledProgress,
3540
0
            pScaledProgressData, papszOptions);
3541
0
        GDALDestroyScaledProgress(pScaledProgressData);
3542
0
    }
3543
3544
    // If we have an alpha band, we want it to be generated before downsampling
3545
    // other bands
3546
0
    bool bHasAlphaBand = false;
3547
0
    for (int iBand = 0; iBand < nBands; iBand++)
3548
0
    {
3549
0
        if (papoBands[iBand]->GetColorInterpretation() == GCI_AlphaBand)
3550
0
            bHasAlphaBand = true;
3551
0
    }
3552
3553
    /* -------------------------------------------------------------------- */
3554
    /*      Refresh old overviews that were listed.                         */
3555
    /* -------------------------------------------------------------------- */
3556
0
    const auto poColorTable = GetRasterBand(panBandList[0])->GetColorTable();
3557
0
    if ((m_nPlanarConfig == PLANARCONFIG_CONTIG || bHasAlphaBand) &&
3558
0
        GDALDataTypeIsComplex(
3559
0
            GetRasterBand(panBandList[0])->GetRasterDataType()) == FALSE &&
3560
0
        (poColorTable == nullptr || STARTS_WITH_CI(pszResampling, "NEAR") ||
3561
0
         poColorTable->IsIdentity()) &&
3562
0
        (STARTS_WITH_CI(pszResampling, "NEAR") ||
3563
0
         EQUAL(pszResampling, "AVERAGE") || EQUAL(pszResampling, "RMS") ||
3564
0
         EQUAL(pszResampling, "GAUSS") || EQUAL(pszResampling, "CUBIC") ||
3565
0
         EQUAL(pszResampling, "CUBICSPLINE") ||
3566
0
         EQUAL(pszResampling, "LANCZOS") || EQUAL(pszResampling, "BILINEAR") ||
3567
0
         EQUAL(pszResampling, "MODE")))
3568
0
    {
3569
        // In the case of pixel interleaved compressed overviews, we want to
3570
        // generate the overviews for all the bands block by block, and not
3571
        // band after band, in order to write the block once and not loose
3572
        // space in the TIFF file.  We also use that logic for uncompressed
3573
        // overviews, since GDALRegenerateOverviewsMultiBand() will be able to
3574
        // trigger cascading overview regeneration even in the presence
3575
        // of an alpha band.
3576
3577
0
        int nNewOverviews = 0;
3578
3579
0
        GDALRasterBand ***papapoOverviewBands = static_cast<GDALRasterBand ***>(
3580
0
            CPLCalloc(sizeof(void *), nBandsIn));
3581
0
        GDALRasterBand **papoBandList =
3582
0
            static_cast<GDALRasterBand **>(CPLCalloc(sizeof(void *), nBandsIn));
3583
0
        for (int iBand = 0; iBand < nBandsIn; ++iBand)
3584
0
        {
3585
0
            GDALRasterBand *poBand = GetRasterBand(panBandList[iBand]);
3586
3587
0
            papoBandList[iBand] = poBand;
3588
0
            papapoOverviewBands[iBand] = static_cast<GDALRasterBand **>(
3589
0
                CPLCalloc(sizeof(void *), poBand->GetOverviewCount()));
3590
3591
0
            int iCurOverview = 0;
3592
0
            std::vector<bool> abAlreadyUsedOverviewBand(
3593
0
                poBand->GetOverviewCount(), false);
3594
3595
0
            for (int i = 0; i < nOverviews; ++i)
3596
0
            {
3597
0
                for (int j = 0; j < poBand->GetOverviewCount(); ++j)
3598
0
                {
3599
0
                    if (abAlreadyUsedOverviewBand[j])
3600
0
                        continue;
3601
3602
0
                    int nOvFactor;
3603
0
                    GDALRasterBand *poOverview = poBand->GetOverview(j);
3604
3605
0
                    nOvFactor = GDALComputeOvFactor(
3606
0
                        poOverview->GetXSize(), poBand->GetXSize(),
3607
0
                        poOverview->GetYSize(), poBand->GetYSize());
3608
3609
0
                    GDALCopyNoDataValue(poOverview, poBand);
3610
3611
0
                    if (nOvFactor == panOverviewList[i] ||
3612
0
                        nOvFactor == GDALOvLevelAdjust2(panOverviewList[i],
3613
0
                                                        poBand->GetXSize(),
3614
0
                                                        poBand->GetYSize()))
3615
0
                    {
3616
0
                        if (iBand == 0)
3617
0
                        {
3618
0
                            const auto osNewResampling =
3619
0
                                GDALGetNormalizedOvrResampling(pszResampling);
3620
0
                            const char *pszExistingResampling =
3621
0
                                poOverview->GetMetadataItem("RESAMPLING");
3622
0
                            if (pszExistingResampling &&
3623
0
                                pszExistingResampling != osNewResampling)
3624
0
                            {
3625
0
                                poOverview->SetMetadataItem(
3626
0
                                    "RESAMPLING", osNewResampling.c_str());
3627
0
                            }
3628
0
                        }
3629
3630
0
                        abAlreadyUsedOverviewBand[j] = true;
3631
0
                        CPLAssert(iCurOverview < poBand->GetOverviewCount());
3632
0
                        papapoOverviewBands[iBand][iCurOverview] = poOverview;
3633
0
                        ++iCurOverview;
3634
0
                        break;
3635
0
                    }
3636
0
                }
3637
0
            }
3638
3639
0
            if (nNewOverviews == 0)
3640
0
            {
3641
0
                nNewOverviews = iCurOverview;
3642
0
            }
3643
0
            else if (nNewOverviews != iCurOverview)
3644
0
            {
3645
0
                CPLAssert(false);
3646
0
                return CE_Failure;
3647
0
            }
3648
0
        }
3649
3650
0
        void *pScaledProgressData =
3651
0
            bHasMask ? GDALCreateScaledProgress(1.0 / (nBands + 1), 1.0,
3652
0
                                                pfnProgress, pProgressData)
3653
0
                     : GDALCreateScaledProgress(0.0, 1.0, pfnProgress,
3654
0
                                                pProgressData);
3655
0
        GDALRegenerateOverviewsMultiBand(nBandsIn, papoBandList, nNewOverviews,
3656
0
                                         papapoOverviewBands, pszResampling,
3657
0
                                         GDALScaledProgress,
3658
0
                                         pScaledProgressData, papszOptions);
3659
0
        GDALDestroyScaledProgress(pScaledProgressData);
3660
3661
0
        for (int iBand = 0; iBand < nBandsIn; ++iBand)
3662
0
        {
3663
0
            CPLFree(papapoOverviewBands[iBand]);
3664
0
        }
3665
0
        CPLFree(papapoOverviewBands);
3666
0
        CPLFree(papoBandList);
3667
0
    }
3668
0
    else
3669
0
    {
3670
0
        GDALRasterBand **papoOverviewBands = static_cast<GDALRasterBand **>(
3671
0
            CPLCalloc(sizeof(void *), nOverviews));
3672
3673
0
        const int iBandOffset = bHasMask ? 1 : 0;
3674
3675
0
        for (int iBand = 0; iBand < nBandsIn && eErr == CE_None; ++iBand)
3676
0
        {
3677
0
            GDALRasterBand *poBand = GetRasterBand(panBandList[iBand]);
3678
0
            if (poBand == nullptr)
3679
0
            {
3680
0
                eErr = CE_Failure;
3681
0
                break;
3682
0
            }
3683
3684
0
            std::vector<bool> abAlreadyUsedOverviewBand(
3685
0
                poBand->GetOverviewCount(), false);
3686
3687
0
            int nNewOverviews = 0;
3688
0
            for (int i = 0; i < nOverviews; ++i)
3689
0
            {
3690
0
                for (int j = 0; j < poBand->GetOverviewCount(); ++j)
3691
0
                {
3692
0
                    if (abAlreadyUsedOverviewBand[j])
3693
0
                        continue;
3694
3695
0
                    GDALRasterBand *poOverview = poBand->GetOverview(j);
3696
3697
0
                    GDALCopyNoDataValue(poOverview, poBand);
3698
3699
0
                    const int nOvFactor = GDALComputeOvFactor(
3700
0
                        poOverview->GetXSize(), poBand->GetXSize(),
3701
0
                        poOverview->GetYSize(), poBand->GetYSize());
3702
3703
0
                    if (nOvFactor == panOverviewList[i] ||
3704
0
                        nOvFactor == GDALOvLevelAdjust2(panOverviewList[i],
3705
0
                                                        poBand->GetXSize(),
3706
0
                                                        poBand->GetYSize()))
3707
0
                    {
3708
0
                        if (iBand == 0)
3709
0
                        {
3710
0
                            const auto osNewResampling =
3711
0
                                GDALGetNormalizedOvrResampling(pszResampling);
3712
0
                            const char *pszExistingResampling =
3713
0
                                poOverview->GetMetadataItem("RESAMPLING");
3714
0
                            if (pszExistingResampling &&
3715
0
                                pszExistingResampling != osNewResampling)
3716
0
                            {
3717
0
                                poOverview->SetMetadataItem(
3718
0
                                    "RESAMPLING", osNewResampling.c_str());
3719
0
                            }
3720
0
                        }
3721
3722
0
                        abAlreadyUsedOverviewBand[j] = true;
3723
0
                        CPLAssert(nNewOverviews < poBand->GetOverviewCount());
3724
0
                        papoOverviewBands[nNewOverviews++] = poOverview;
3725
0
                        break;
3726
0
                    }
3727
0
                }
3728
0
            }
3729
3730
0
            void *pScaledProgressData = GDALCreateScaledProgress(
3731
0
                (iBand + iBandOffset) /
3732
0
                    static_cast<double>(nBandsIn + iBandOffset),
3733
0
                (iBand + iBandOffset + 1) /
3734
0
                    static_cast<double>(nBandsIn + iBandOffset),
3735
0
                pfnProgress, pProgressData);
3736
3737
0
            eErr = GDALRegenerateOverviewsEx(
3738
0
                poBand, nNewOverviews,
3739
0
                reinterpret_cast<GDALRasterBandH *>(papoOverviewBands),
3740
0
                pszResampling, GDALScaledProgress, pScaledProgressData,
3741
0
                papszOptions);
3742
3743
0
            GDALDestroyScaledProgress(pScaledProgressData);
3744
0
        }
3745
3746
        /* --------------------------------------------------------------------
3747
         */
3748
        /*      Cleanup */
3749
        /* --------------------------------------------------------------------
3750
         */
3751
0
        CPLFree(papoOverviewBands);
3752
0
    }
3753
3754
0
    pfnProgress(1.0, nullptr, pProgressData);
3755
3756
0
    return eErr;
3757
0
}
3758
3759
/************************************************************************/
3760
/*                   GTiffWriteDummyGeokeyDirectory()                   */
3761
/************************************************************************/
3762
3763
static void GTiffWriteDummyGeokeyDirectory(TIFF *hTIFF)
3764
0
{
3765
    // If we have existing geokeys, try to wipe them
3766
    // by writing a dummy geokey directory. (#2546)
3767
0
    uint16_t *panVI = nullptr;
3768
0
    uint16_t nKeyCount = 0;
3769
3770
0
    if (TIFFGetField(hTIFF, TIFFTAG_GEOKEYDIRECTORY, &nKeyCount, &panVI))
3771
0
    {
3772
0
        GUInt16 anGKVersionInfo[4] = {1, 1, 0, 0};
3773
0
        double adfDummyDoubleParams[1] = {0.0};
3774
0
        TIFFSetField(hTIFF, TIFFTAG_GEOKEYDIRECTORY, 4, anGKVersionInfo);
3775
0
        TIFFSetField(hTIFF, TIFFTAG_GEODOUBLEPARAMS, 1, adfDummyDoubleParams);
3776
0
        TIFFSetField(hTIFF, TIFFTAG_GEOASCIIPARAMS, "");
3777
0
    }
3778
0
}
3779
3780
/************************************************************************/
3781
/*                      IsSRSCompatibleOfGeoTIFF()                      */
3782
/************************************************************************/
3783
3784
static bool IsSRSCompatibleOfGeoTIFF(const OGRSpatialReference *poSRS,
3785
                                     GTIFFKeysFlavorEnum eGeoTIFFKeysFlavor)
3786
0
{
3787
0
    char *pszWKT = nullptr;
3788
0
    if ((poSRS->IsGeographic() || poSRS->IsProjected()) && !poSRS->IsCompound())
3789
0
    {
3790
0
        const char *pszAuthName = poSRS->GetAuthorityName(nullptr);
3791
0
        const char *pszAuthCode = poSRS->GetAuthorityCode(nullptr);
3792
0
        if (pszAuthName && pszAuthCode && EQUAL(pszAuthName, "EPSG"))
3793
0
            return true;
3794
0
    }
3795
0
    OGRErr eErr;
3796
0
    {
3797
0
        CPLErrorStateBackuper oErrorStateBackuper(CPLQuietErrorHandler);
3798
0
        if (poSRS->IsDerivedGeographic() ||
3799
0
            (poSRS->IsProjected() && !poSRS->IsCompound() &&
3800
0
             poSRS->GetAxesCount() == 3))
3801
0
        {
3802
0
            eErr = OGRERR_FAILURE;
3803
0
        }
3804
0
        else
3805
0
        {
3806
            // Geographic3D CRS can't be exported to WKT1, but are
3807
            // valid GeoTIFF 1.1
3808
0
            const char *const apszOptions[] = {
3809
0
                poSRS->IsGeographic() ? nullptr : "FORMAT=WKT1", nullptr};
3810
0
            eErr = poSRS->exportToWkt(&pszWKT, apszOptions);
3811
0
            if (eErr == OGRERR_FAILURE && poSRS->IsProjected() &&
3812
0
                eGeoTIFFKeysFlavor == GEOTIFF_KEYS_ESRI_PE)
3813
0
            {
3814
0
                CPLFree(pszWKT);
3815
0
                const char *const apszOptionsESRIWKT[] = {"FORMAT=WKT1_ESRI",
3816
0
                                                          nullptr};
3817
0
                eErr = poSRS->exportToWkt(&pszWKT, apszOptionsESRIWKT);
3818
0
            }
3819
0
        }
3820
0
    }
3821
0
    const bool bCompatibleOfGeoTIFF =
3822
0
        (eErr == OGRERR_NONE && pszWKT != nullptr &&
3823
0
         strstr(pszWKT, "custom_proj4") == nullptr);
3824
0
    CPLFree(pszWKT);
3825
0
    return bCompatibleOfGeoTIFF;
3826
0
}
3827
3828
/************************************************************************/
3829
/*                          WriteGeoTIFFInfo()                          */
3830
/************************************************************************/
3831
3832
void GTiffDataset::WriteGeoTIFFInfo()
3833
3834
0
{
3835
0
    bool bPixelIsPoint = false;
3836
0
    bool bPointGeoIgnore = false;
3837
3838
0
    const char *pszAreaOrPoint =
3839
0
        GTiffDataset::GetMetadataItem(GDALMD_AREA_OR_POINT);
3840
0
    if (pszAreaOrPoint && EQUAL(pszAreaOrPoint, GDALMD_AOP_POINT))
3841
0
    {
3842
0
        bPixelIsPoint = true;
3843
0
        bPointGeoIgnore =
3844
0
            CPLTestBool(CPLGetConfigOption("GTIFF_POINT_GEO_IGNORE", "FALSE"));
3845
0
    }
3846
3847
0
    if (m_bForceUnsetGTOrGCPs)
3848
0
    {
3849
0
        m_bNeedsRewrite = true;
3850
0
        m_bForceUnsetGTOrGCPs = false;
3851
3852
0
        TIFFUnsetField(m_hTIFF, TIFFTAG_GEOPIXELSCALE);
3853
0
        TIFFUnsetField(m_hTIFF, TIFFTAG_GEOTIEPOINTS);
3854
0
        TIFFUnsetField(m_hTIFF, TIFFTAG_GEOTRANSMATRIX);
3855
0
    }
3856
3857
0
    if (m_bForceUnsetProjection)
3858
0
    {
3859
0
        m_bNeedsRewrite = true;
3860
0
        m_bForceUnsetProjection = false;
3861
3862
0
        TIFFUnsetField(m_hTIFF, TIFFTAG_GEOKEYDIRECTORY);
3863
0
        TIFFUnsetField(m_hTIFF, TIFFTAG_GEODOUBLEPARAMS);
3864
0
        TIFFUnsetField(m_hTIFF, TIFFTAG_GEOASCIIPARAMS);
3865
0
    }
3866
3867
    /* -------------------------------------------------------------------- */
3868
    /*      Write geotransform if valid.                                    */
3869
    /* -------------------------------------------------------------------- */
3870
0
    if (m_bGeoTransformValid)
3871
0
    {
3872
0
        m_bNeedsRewrite = true;
3873
3874
        /* --------------------------------------------------------------------
3875
         */
3876
        /*      Clear old tags to ensure we don't end up with conflicting */
3877
        /*      information. (#2625) */
3878
        /* --------------------------------------------------------------------
3879
         */
3880
0
        TIFFUnsetField(m_hTIFF, TIFFTAG_GEOPIXELSCALE);
3881
0
        TIFFUnsetField(m_hTIFF, TIFFTAG_GEOTIEPOINTS);
3882
0
        TIFFUnsetField(m_hTIFF, TIFFTAG_GEOTRANSMATRIX);
3883
3884
        /* --------------------------------------------------------------------
3885
         */
3886
        /*      Write the transform.  If we have a normal north-up image we */
3887
        /*      use the tiepoint plus pixelscale otherwise we use a matrix. */
3888
        /* --------------------------------------------------------------------
3889
         */
3890
0
        if (m_gt.xrot == 0.0 && m_gt.yrot == 0.0 && m_gt.yscale < 0.0)
3891
0
        {
3892
0
            double dfOffset = 0.0;
3893
0
            if (m_eProfile != GTiffProfile::BASELINE)
3894
0
            {
3895
                // In the case the SRS has a vertical component and we have
3896
                // a single band, encode its scale/offset in the GeoTIFF tags
3897
0
                int bHasScale = FALSE;
3898
0
                double dfScale = GetRasterBand(1)->GetScale(&bHasScale);
3899
0
                int bHasOffset = FALSE;
3900
0
                dfOffset = GetRasterBand(1)->GetOffset(&bHasOffset);
3901
0
                const bool bApplyScaleOffset =
3902
0
                    m_oSRS.IsVertical() && GetRasterCount() == 1;
3903
0
                if (bApplyScaleOffset && !bHasScale)
3904
0
                    dfScale = 1.0;
3905
0
                if (!bApplyScaleOffset || !bHasOffset)
3906
0
                    dfOffset = 0.0;
3907
0
                const double adfPixelScale[3] = {m_gt.xscale, fabs(m_gt.yscale),
3908
0
                                                 bApplyScaleOffset ? dfScale
3909
0
                                                                   : 0.0};
3910
0
                TIFFSetField(m_hTIFF, TIFFTAG_GEOPIXELSCALE, 3, adfPixelScale);
3911
0
            }
3912
3913
0
            double adfTiePoints[6] = {0.0,        0.0,        0.0,
3914
0
                                      m_gt.xorig, m_gt.yorig, dfOffset};
3915
3916
0
            if (bPixelIsPoint && !bPointGeoIgnore)
3917
0
            {
3918
0
                adfTiePoints[3] += m_gt.xscale * 0.5 + m_gt.xrot * 0.5;
3919
0
                adfTiePoints[4] += m_gt.yrot * 0.5 + m_gt.yscale * 0.5;
3920
0
            }
3921
3922
0
            if (m_eProfile != GTiffProfile::BASELINE)
3923
0
                TIFFSetField(m_hTIFF, TIFFTAG_GEOTIEPOINTS, 6, adfTiePoints);
3924
0
        }
3925
0
        else
3926
0
        {
3927
0
            double adfMatrix[16] = {};
3928
3929
0
            adfMatrix[0] = m_gt.xscale;
3930
0
            adfMatrix[1] = m_gt.xrot;
3931
0
            adfMatrix[3] = m_gt.xorig;
3932
0
            adfMatrix[4] = m_gt.yrot;
3933
0
            adfMatrix[5] = m_gt.yscale;
3934
0
            adfMatrix[7] = m_gt.yorig;
3935
0
            adfMatrix[15] = 1.0;
3936
3937
0
            if (bPixelIsPoint && !bPointGeoIgnore)
3938
0
            {
3939
0
                adfMatrix[3] += m_gt.xscale * 0.5 + m_gt.xrot * 0.5;
3940
0
                adfMatrix[7] += m_gt.yrot * 0.5 + m_gt.yscale * 0.5;
3941
0
            }
3942
3943
0
            if (m_eProfile != GTiffProfile::BASELINE)
3944
0
                TIFFSetField(m_hTIFF, TIFFTAG_GEOTRANSMATRIX, 16, adfMatrix);
3945
0
        }
3946
3947
0
        if (m_poBaseDS == nullptr)
3948
0
        {
3949
            // Do we need a world file?
3950
0
            if (CPLFetchBool(m_papszCreationOptions, "TFW", false))
3951
0
                GDALWriteWorldFile(m_osFilename.c_str(), "tfw", m_gt.data());
3952
0
            else if (CPLFetchBool(m_papszCreationOptions, "WORLDFILE", false))
3953
0
                GDALWriteWorldFile(m_osFilename.c_str(), "wld", m_gt.data());
3954
0
        }
3955
0
    }
3956
0
    else if (GetGCPCount() > 0 && GetGCPCount() <= knMAX_GCP_COUNT &&
3957
0
             m_eProfile != GTiffProfile::BASELINE)
3958
0
    {
3959
0
        m_bNeedsRewrite = true;
3960
3961
0
        double *padfTiePoints = static_cast<double *>(
3962
0
            CPLMalloc(6 * sizeof(double) * GetGCPCount()));
3963
3964
0
        for (size_t iGCP = 0; iGCP < m_aoGCPs.size(); ++iGCP)
3965
0
        {
3966
3967
0
            padfTiePoints[iGCP * 6 + 0] = m_aoGCPs[iGCP].Pixel();
3968
0
            padfTiePoints[iGCP * 6 + 1] = m_aoGCPs[iGCP].Line();
3969
0
            padfTiePoints[iGCP * 6 + 2] = 0;
3970
0
            padfTiePoints[iGCP * 6 + 3] = m_aoGCPs[iGCP].X();
3971
0
            padfTiePoints[iGCP * 6 + 4] = m_aoGCPs[iGCP].Y();
3972
0
            padfTiePoints[iGCP * 6 + 5] = m_aoGCPs[iGCP].Z();
3973
3974
0
            if (bPixelIsPoint && !bPointGeoIgnore)
3975
0
            {
3976
0
                padfTiePoints[iGCP * 6 + 0] += 0.5;
3977
0
                padfTiePoints[iGCP * 6 + 1] += 0.5;
3978
0
            }
3979
0
        }
3980
3981
0
        TIFFSetField(m_hTIFF, TIFFTAG_GEOTIEPOINTS, 6 * GetGCPCount(),
3982
0
                     padfTiePoints);
3983
0
        CPLFree(padfTiePoints);
3984
0
    }
3985
3986
    /* -------------------------------------------------------------------- */
3987
    /*      Write out projection definition.                                */
3988
    /* -------------------------------------------------------------------- */
3989
0
    const bool bHasProjection = !m_oSRS.IsEmpty();
3990
0
    if ((bHasProjection || bPixelIsPoint) &&
3991
0
        m_eProfile != GTiffProfile::BASELINE)
3992
0
    {
3993
0
        m_bNeedsRewrite = true;
3994
3995
        // If we have existing geokeys, try to wipe them
3996
        // by writing a dummy geokey directory. (#2546)
3997
0
        GTiffWriteDummyGeokeyDirectory(m_hTIFF);
3998
3999
0
        GTIF *psGTIF = GTiffDataset::GTIFNew(m_hTIFF);
4000
4001
        // Set according to coordinate system.
4002
0
        if (bHasProjection)
4003
0
        {
4004
0
            if (IsSRSCompatibleOfGeoTIFF(&m_oSRS, m_eGeoTIFFKeysFlavor))
4005
0
            {
4006
0
                GTIFSetFromOGISDefnEx(psGTIF,
4007
0
                                      OGRSpatialReference::ToHandle(&m_oSRS),
4008
0
                                      m_eGeoTIFFKeysFlavor, m_eGeoTIFFVersion);
4009
0
            }
4010
0
            else
4011
0
            {
4012
0
                GDALPamDataset::SetSpatialRef(&m_oSRS);
4013
0
            }
4014
0
        }
4015
4016
0
        if (bPixelIsPoint)
4017
0
        {
4018
0
            GTIFKeySet(psGTIF, GTRasterTypeGeoKey, TYPE_SHORT, 1,
4019
0
                       RasterPixelIsPoint);
4020
0
        }
4021
4022
0
        GTIFWriteKeys(psGTIF);
4023
0
        GTIFFree(psGTIF);
4024
0
    }
4025
0
}
4026
4027
/************************************************************************/
4028
/*                         AppendMetadataItem()                         */
4029
/************************************************************************/
4030
4031
static void AppendMetadataItem(CPLXMLNode **ppsRoot, CPLXMLNode **ppsTail,
4032
                               const char *pszKey, const char *pszValue,
4033
                               CPLXMLNode *psValueNode, int nBand,
4034
                               const char *pszRole, const char *pszDomain)
4035
4036
0
{
4037
0
    CPLAssert(pszValue || psValueNode);
4038
0
    CPLAssert(!(pszValue && psValueNode));
4039
4040
    /* -------------------------------------------------------------------- */
4041
    /*      Create the Item element, and subcomponents.                     */
4042
    /* -------------------------------------------------------------------- */
4043
0
    CPLXMLNode *psItem = CPLCreateXMLNode(nullptr, CXT_Element, "Item");
4044
0
    CPLAddXMLAttributeAndValue(psItem, "name", pszKey);
4045
4046
0
    if (nBand > 0)
4047
0
    {
4048
0
        char szBandId[32] = {};
4049
0
        snprintf(szBandId, sizeof(szBandId), "%d", nBand - 1);
4050
0
        CPLAddXMLAttributeAndValue(psItem, "sample", szBandId);
4051
0
    }
4052
4053
0
    if (pszRole != nullptr)
4054
0
        CPLAddXMLAttributeAndValue(psItem, "role", pszRole);
4055
4056
0
    if (pszDomain != nullptr && strlen(pszDomain) > 0)
4057
0
        CPLAddXMLAttributeAndValue(psItem, "domain", pszDomain);
4058
4059
0
    if (pszValue)
4060
0
    {
4061
        // Note: this escaping should not normally be done, as the serialization
4062
        // of the tree to XML also does it, so we end up width double XML escaping,
4063
        // but keep it for backward compatibility.
4064
0
        char *pszEscapedItemValue = CPLEscapeString(pszValue, -1, CPLES_XML);
4065
0
        CPLCreateXMLNode(psItem, CXT_Text, pszEscapedItemValue);
4066
0
        CPLFree(pszEscapedItemValue);
4067
0
    }
4068
0
    else
4069
0
    {
4070
0
        CPLAddXMLChild(psItem, psValueNode);
4071
0
    }
4072
4073
    /* -------------------------------------------------------------------- */
4074
    /*      Create root, if missing.                                        */
4075
    /* -------------------------------------------------------------------- */
4076
0
    if (*ppsRoot == nullptr)
4077
0
        *ppsRoot = CPLCreateXMLNode(nullptr, CXT_Element, "GDALMetadata");
4078
4079
    /* -------------------------------------------------------------------- */
4080
    /*      Append item to tail.  We keep track of the tail to avoid        */
4081
    /*      O(nsquared) time as the list gets longer.                       */
4082
    /* -------------------------------------------------------------------- */
4083
0
    if (*ppsTail == nullptr)
4084
0
        CPLAddXMLChild(*ppsRoot, psItem);
4085
0
    else
4086
0
        CPLAddXMLSibling(*ppsTail, psItem);
4087
4088
0
    *ppsTail = psItem;
4089
0
}
4090
4091
/************************************************************************/
4092
/*                         AppendMetadataItem()                         */
4093
/************************************************************************/
4094
4095
static void AppendMetadataItem(CPLXMLNode **ppsRoot, CPLXMLNode **ppsTail,
4096
                               const char *pszKey, const char *pszValue,
4097
                               int nBand, const char *pszRole,
4098
                               const char *pszDomain)
4099
4100
0
{
4101
0
    AppendMetadataItem(ppsRoot, ppsTail, pszKey, pszValue, nullptr, nBand,
4102
0
                       pszRole, pszDomain);
4103
0
}
4104
4105
/************************************************************************/
4106
/*                          WriteMDMetadata()                           */
4107
/************************************************************************/
4108
4109
static void WriteMDMetadata(GDALMultiDomainMetadata *poMDMD, TIFF *hTIFF,
4110
                            CPLXMLNode **ppsRoot, CPLXMLNode **ppsTail,
4111
                            int nBand, GTiffProfile eProfile)
4112
4113
0
{
4114
4115
    /* ==================================================================== */
4116
    /*      Process each domain.                                            */
4117
    /* ==================================================================== */
4118
0
    CSLConstList papszDomainList = poMDMD->GetDomainList();
4119
0
    for (int iDomain = 0; papszDomainList && papszDomainList[iDomain];
4120
0
         ++iDomain)
4121
0
    {
4122
0
        CSLConstList papszMD = poMDMD->GetMetadata(papszDomainList[iDomain]);
4123
0
        bool bIsXMLOrJSON = false;
4124
4125
0
        if (EQUAL(papszDomainList[iDomain], "IMAGE_STRUCTURE") ||
4126
0
            EQUAL(papszDomainList[iDomain], "DERIVED_SUBDATASETS"))
4127
0
            continue;  // Ignored.
4128
0
        if (EQUAL(papszDomainList[iDomain], "COLOR_PROFILE"))
4129
0
            continue;  // Handled elsewhere.
4130
0
        if (EQUAL(papszDomainList[iDomain], MD_DOMAIN_RPC))
4131
0
            continue;  // Handled elsewhere.
4132
0
        if (EQUAL(papszDomainList[iDomain], "xml:ESRI") &&
4133
0
            CPLTestBool(CPLGetConfigOption("ESRI_XML_PAM", "NO")))
4134
0
            continue;  // Handled elsewhere.
4135
0
        if (EQUAL(papszDomainList[iDomain], "xml:XMP"))
4136
0
            continue;  // Handled in SetMetadata.
4137
4138
0
        if (STARTS_WITH_CI(papszDomainList[iDomain], "xml:") ||
4139
0
            STARTS_WITH_CI(papszDomainList[iDomain], "json:"))
4140
0
        {
4141
0
            bIsXMLOrJSON = true;
4142
0
        }
4143
4144
        /* --------------------------------------------------------------------
4145
         */
4146
        /*      Process each item in this domain. */
4147
        /* --------------------------------------------------------------------
4148
         */
4149
0
        for (int iItem = 0; papszMD && papszMD[iItem]; ++iItem)
4150
0
        {
4151
0
            const char *pszItemValue = nullptr;
4152
0
            char *pszItemName = nullptr;
4153
4154
0
            if (bIsXMLOrJSON)
4155
0
            {
4156
0
                pszItemName = CPLStrdup("doc");
4157
0
                pszItemValue = papszMD[iItem];
4158
0
            }
4159
0
            else
4160
0
            {
4161
0
                pszItemValue = CPLParseNameValue(papszMD[iItem], &pszItemName);
4162
0
                if (pszItemName == nullptr)
4163
0
                {
4164
0
                    CPLDebug("GTiff", "Invalid metadata item : %s",
4165
0
                             papszMD[iItem]);
4166
0
                    continue;
4167
0
                }
4168
0
            }
4169
4170
            /* --------------------------------------------------------------------
4171
             */
4172
            /*      Convert into XML item or handle as a special TIFF tag. */
4173
            /* --------------------------------------------------------------------
4174
             */
4175
0
            if (strlen(papszDomainList[iDomain]) == 0 && nBand == 0 &&
4176
0
                (STARTS_WITH_CI(pszItemName, "TIFFTAG_") ||
4177
0
                 (EQUAL(pszItemName, "GEO_METADATA") &&
4178
0
                  eProfile == GTiffProfile::GDALGEOTIFF) ||
4179
0
                 (EQUAL(pszItemName, "TIFF_RSID") &&
4180
0
                  eProfile == GTiffProfile::GDALGEOTIFF)))
4181
0
            {
4182
0
                if (EQUAL(pszItemName, "TIFFTAG_RESOLUTIONUNIT"))
4183
0
                {
4184
                    // ResolutionUnit can't be 0, which is the default if
4185
                    // atoi() fails.  Set to 1=Unknown.
4186
0
                    int v = atoi(pszItemValue);
4187
0
                    if (!v)
4188
0
                        v = RESUNIT_NONE;
4189
0
                    TIFFSetField(hTIFF, TIFFTAG_RESOLUTIONUNIT, v);
4190
0
                }
4191
0
                else
4192
0
                {
4193
0
                    bool bFoundTag = false;
4194
0
                    size_t iTag = 0;  // Used after for.
4195
0
                    const auto *pasTIFFTags = GTiffDataset::GetTIFFTags();
4196
0
                    for (; pasTIFFTags[iTag].pszTagName; ++iTag)
4197
0
                    {
4198
0
                        if (EQUAL(pszItemName, pasTIFFTags[iTag].pszTagName))
4199
0
                        {
4200
0
                            bFoundTag = true;
4201
0
                            break;
4202
0
                        }
4203
0
                    }
4204
4205
0
                    if (bFoundTag &&
4206
0
                        pasTIFFTags[iTag].eType == GTIFFTAGTYPE_STRING)
4207
0
                        TIFFSetField(hTIFF, pasTIFFTags[iTag].nTagVal,
4208
0
                                     pszItemValue);
4209
0
                    else if (bFoundTag &&
4210
0
                             pasTIFFTags[iTag].eType == GTIFFTAGTYPE_FLOAT)
4211
0
                        TIFFSetField(hTIFF, pasTIFFTags[iTag].nTagVal,
4212
0
                                     CPLAtof(pszItemValue));
4213
0
                    else if (bFoundTag &&
4214
0
                             pasTIFFTags[iTag].eType == GTIFFTAGTYPE_SHORT)
4215
0
                        TIFFSetField(hTIFF, pasTIFFTags[iTag].nTagVal,
4216
0
                                     atoi(pszItemValue));
4217
0
                    else if (bFoundTag && pasTIFFTags[iTag].eType ==
4218
0
                                              GTIFFTAGTYPE_BYTE_STRING)
4219
0
                    {
4220
0
                        uint32_t nLen =
4221
0
                            static_cast<uint32_t>(strlen(pszItemValue));
4222
0
                        if (nLen)
4223
0
                        {
4224
0
                            TIFFSetField(hTIFF, pasTIFFTags[iTag].nTagVal, nLen,
4225
0
                                         pszItemValue);
4226
0
                        }
4227
0
                    }
4228
0
                    else
4229
0
                        CPLError(CE_Warning, CPLE_NotSupported,
4230
0
                                 "%s metadata item is unhandled and "
4231
0
                                 "will not be written",
4232
0
                                 pszItemName);
4233
0
                }
4234
0
            }
4235
0
            else if (nBand == 0 && EQUAL(pszItemName, GDALMD_AREA_OR_POINT))
4236
0
            {
4237
0
                /* Do nothing, handled elsewhere. */;
4238
0
            }
4239
0
            else
4240
0
            {
4241
0
                AppendMetadataItem(ppsRoot, ppsTail, pszItemName, pszItemValue,
4242
0
                                   nBand, nullptr, papszDomainList[iDomain]);
4243
0
            }
4244
4245
0
            CPLFree(pszItemName);
4246
0
        }
4247
4248
        /* --------------------------------------------------------------------
4249
         */
4250
        /*      Remove TIFFTAG_xxxxxx that are already set but no longer in */
4251
        /*      the metadata list (#5619) */
4252
        /* --------------------------------------------------------------------
4253
         */
4254
0
        if (strlen(papszDomainList[iDomain]) == 0 && nBand == 0)
4255
0
        {
4256
0
            const auto *pasTIFFTags = GTiffDataset::GetTIFFTags();
4257
0
            for (size_t iTag = 0; pasTIFFTags[iTag].pszTagName; ++iTag)
4258
0
            {
4259
0
                uint32_t nCount = 0;
4260
0
                char *pszText = nullptr;
4261
0
                int16_t nVal = 0;
4262
0
                float fVal = 0.0f;
4263
0
                const char *pszVal =
4264
0
                    CSLFetchNameValue(papszMD, pasTIFFTags[iTag].pszTagName);
4265
0
                if (pszVal == nullptr &&
4266
0
                    ((pasTIFFTags[iTag].eType == GTIFFTAGTYPE_STRING &&
4267
0
                      TIFFGetField(hTIFF, pasTIFFTags[iTag].nTagVal,
4268
0
                                   &pszText)) ||
4269
0
                     (pasTIFFTags[iTag].eType == GTIFFTAGTYPE_SHORT &&
4270
0
                      TIFFGetField(hTIFF, pasTIFFTags[iTag].nTagVal, &nVal)) ||
4271
0
                     (pasTIFFTags[iTag].eType == GTIFFTAGTYPE_FLOAT &&
4272
0
                      TIFFGetField(hTIFF, pasTIFFTags[iTag].nTagVal, &fVal)) ||
4273
0
                     (pasTIFFTags[iTag].eType == GTIFFTAGTYPE_BYTE_STRING &&
4274
0
                      TIFFGetField(hTIFF, pasTIFFTags[iTag].nTagVal, &nCount,
4275
0
                                   &pszText))))
4276
0
                {
4277
0
                    TIFFUnsetField(hTIFF, pasTIFFTags[iTag].nTagVal);
4278
0
                }
4279
0
            }
4280
0
        }
4281
0
    }
4282
0
}
4283
4284
/************************************************************************/
4285
/*                              WriteRPC()                              */
4286
/************************************************************************/
4287
4288
void GTiffDataset::WriteRPC(GDALDataset *poSrcDS, TIFF *l_hTIFF,
4289
                            int bSrcIsGeoTIFF, GTiffProfile eProfile,
4290
                            const char *pszTIFFFilename,
4291
                            CSLConstList papszCreationOptions,
4292
                            bool bWriteOnlyInPAMIfNeeded)
4293
0
{
4294
    /* -------------------------------------------------------------------- */
4295
    /*      Handle RPC data written to TIFF RPCCoefficient tag, RPB file,   */
4296
    /*      RPCTEXT file or PAM.                                            */
4297
    /* -------------------------------------------------------------------- */
4298
0
    CSLConstList papszRPCMD = poSrcDS->GetMetadata(MD_DOMAIN_RPC);
4299
0
    if (papszRPCMD != nullptr)
4300
0
    {
4301
0
        bool bRPCSerializedOtherWay = false;
4302
4303
0
        if (eProfile == GTiffProfile::GDALGEOTIFF)
4304
0
        {
4305
0
            if (!bWriteOnlyInPAMIfNeeded)
4306
0
                GTiffDatasetWriteRPCTag(l_hTIFF, papszRPCMD);
4307
0
            bRPCSerializedOtherWay = true;
4308
0
        }
4309
4310
        // Write RPB file if explicitly asked, or if a non GDAL specific
4311
        // profile is selected and RPCTXT is not asked.
4312
0
        bool bRPBExplicitlyAsked =
4313
0
            CPLFetchBool(papszCreationOptions, "RPB", false);
4314
0
        bool bRPBExplicitlyDenied =
4315
0
            !CPLFetchBool(papszCreationOptions, "RPB", true);
4316
0
        if ((eProfile != GTiffProfile::GDALGEOTIFF &&
4317
0
             !CPLFetchBool(papszCreationOptions, "RPCTXT", false) &&
4318
0
             !bRPBExplicitlyDenied) ||
4319
0
            bRPBExplicitlyAsked)
4320
0
        {
4321
0
            if (!bWriteOnlyInPAMIfNeeded)
4322
0
                GDALWriteRPBFile(pszTIFFFilename, papszRPCMD);
4323
0
            bRPCSerializedOtherWay = true;
4324
0
        }
4325
4326
0
        if (CPLFetchBool(papszCreationOptions, "RPCTXT", false))
4327
0
        {
4328
0
            if (!bWriteOnlyInPAMIfNeeded)
4329
0
                GDALWriteRPCTXTFile(pszTIFFFilename, papszRPCMD);
4330
0
            bRPCSerializedOtherWay = true;
4331
0
        }
4332
4333
0
        if (!bRPCSerializedOtherWay && bWriteOnlyInPAMIfNeeded && bSrcIsGeoTIFF)
4334
0
            cpl::down_cast<GTiffDataset *>(poSrcDS)
4335
0
                ->GDALPamDataset::SetMetadata(papszRPCMD, MD_DOMAIN_RPC);
4336
0
    }
4337
0
}
4338
4339
/************************************************************************/
4340
/*                           WriteMetadata()                            */
4341
/************************************************************************/
4342
4343
bool GTiffDataset::WriteMetadata(GDALDataset *poSrcDS, TIFF *l_hTIFF,
4344
                                 bool bSrcIsGeoTIFF, GTiffProfile eProfile,
4345
                                 const char *pszTIFFFilename,
4346
                                 CSLConstList papszCreationOptions,
4347
                                 bool bExcludeRPBandIMGFileWriting)
4348
4349
0
{
4350
    /* -------------------------------------------------------------------- */
4351
    /*      Convert all the remaining metadata into a simple XML            */
4352
    /*      format.                                                         */
4353
    /* -------------------------------------------------------------------- */
4354
0
    CPLXMLNode *psRoot = nullptr;
4355
0
    CPLXMLNode *psTail = nullptr;
4356
4357
0
    const char *pszCopySrcMDD =
4358
0
        CSLFetchNameValueDef(papszCreationOptions, "COPY_SRC_MDD", "AUTO");
4359
0
    char **papszSrcMDD =
4360
0
        CSLFetchNameValueMultiple(papszCreationOptions, "SRC_MDD");
4361
4362
0
    GTiffDataset *poSrcDSGTiff =
4363
0
        bSrcIsGeoTIFF ? cpl::down_cast<GTiffDataset *>(poSrcDS) : nullptr;
4364
4365
0
    if (poSrcDSGTiff)
4366
0
    {
4367
0
        WriteMDMetadata(&poSrcDSGTiff->m_oGTiffMDMD, l_hTIFF, &psRoot, &psTail,
4368
0
                        0, eProfile);
4369
0
    }
4370
0
    else
4371
0
    {
4372
0
        if (EQUAL(pszCopySrcMDD, "AUTO") || CPLTestBool(pszCopySrcMDD) ||
4373
0
            papszSrcMDD)
4374
0
        {
4375
0
            GDALMultiDomainMetadata l_oMDMD;
4376
0
            {
4377
0
                CSLConstList papszMD = poSrcDS->GetMetadata();
4378
0
                if (CSLCount(papszMD) > 0 &&
4379
0
                    (!papszSrcMDD || CSLFindString(papszSrcMDD, "") >= 0 ||
4380
0
                     CSLFindString(papszSrcMDD, "_DEFAULT_") >= 0))
4381
0
                {
4382
0
                    l_oMDMD.SetMetadata(papszMD);
4383
0
                }
4384
0
            }
4385
4386
0
            if (EQUAL(pszCopySrcMDD, "AUTO") && !papszSrcMDD)
4387
0
            {
4388
                // Propagate ISIS3 or VICAR metadata
4389
0
                for (const char *pszMDD : {"json:ISIS3", "json:VICAR"})
4390
0
                {
4391
0
                    CSLConstList papszMD = poSrcDS->GetMetadata(pszMDD);
4392
0
                    if (papszMD)
4393
0
                    {
4394
0
                        l_oMDMD.SetMetadata(papszMD, pszMDD);
4395
0
                    }
4396
0
                }
4397
0
            }
4398
4399
0
            if ((!EQUAL(pszCopySrcMDD, "AUTO") && CPLTestBool(pszCopySrcMDD)) ||
4400
0
                papszSrcMDD)
4401
0
            {
4402
0
                char **papszDomainList = poSrcDS->GetMetadataDomainList();
4403
0
                for (CSLConstList papszIter = papszDomainList;
4404
0
                     papszIter && *papszIter; ++papszIter)
4405
0
                {
4406
0
                    const char *pszDomain = *papszIter;
4407
0
                    if (pszDomain[0] != 0 &&
4408
0
                        (!papszSrcMDD ||
4409
0
                         CSLFindString(papszSrcMDD, pszDomain) >= 0))
4410
0
                    {
4411
0
                        l_oMDMD.SetMetadata(poSrcDS->GetMetadata(pszDomain),
4412
0
                                            pszDomain);
4413
0
                    }
4414
0
                }
4415
0
                CSLDestroy(papszDomainList);
4416
0
            }
4417
4418
0
            WriteMDMetadata(&l_oMDMD, l_hTIFF, &psRoot, &psTail, 0, eProfile);
4419
0
        }
4420
0
    }
4421
4422
0
    if (!bExcludeRPBandIMGFileWriting &&
4423
0
        (!poSrcDSGTiff || poSrcDSGTiff->m_poBaseDS == nullptr))
4424
0
    {
4425
0
        WriteRPC(poSrcDS, l_hTIFF, bSrcIsGeoTIFF, eProfile, pszTIFFFilename,
4426
0
                 papszCreationOptions);
4427
4428
        /* ------------------------------------------------------------------ */
4429
        /*      Handle metadata data written to an IMD file. */
4430
        /* ------------------------------------------------------------------ */
4431
0
        CSLConstList papszIMDMD = poSrcDS->GetMetadata(MD_DOMAIN_IMD);
4432
0
        if (papszIMDMD != nullptr)
4433
0
        {
4434
0
            GDALWriteIMDFile(pszTIFFFilename, papszIMDMD);
4435
0
        }
4436
0
    }
4437
4438
0
    uint16_t nPhotometric = 0;
4439
0
    if (!TIFFGetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, &(nPhotometric)))
4440
0
        nPhotometric = PHOTOMETRIC_MINISBLACK;
4441
4442
0
    const bool bStandardColorInterp = GTIFFIsStandardColorInterpretation(
4443
0
        GDALDataset::ToHandle(poSrcDS), nPhotometric, papszCreationOptions);
4444
4445
    /* -------------------------------------------------------------------- */
4446
    /*      We also need to address band specific metadata, and special     */
4447
    /*      "role" metadata.                                                */
4448
    /* -------------------------------------------------------------------- */
4449
0
    for (int nBand = 1; nBand <= poSrcDS->GetRasterCount(); ++nBand)
4450
0
    {
4451
0
        GDALRasterBand *poBand = poSrcDS->GetRasterBand(nBand);
4452
4453
0
        if (bSrcIsGeoTIFF)
4454
0
        {
4455
0
            GTiffRasterBand *poSrcBandGTiff =
4456
0
                cpl::down_cast<GTiffRasterBand *>(poBand);
4457
0
            assert(poSrcBandGTiff);
4458
0
            WriteMDMetadata(&poSrcBandGTiff->m_oGTiffMDMD, l_hTIFF, &psRoot,
4459
0
                            &psTail, nBand, eProfile);
4460
0
        }
4461
0
        else
4462
0
        {
4463
0
            GDALMultiDomainMetadata l_oMDMD;
4464
0
            bool bOMDMDSet = false;
4465
4466
0
            if (EQUAL(pszCopySrcMDD, "AUTO") && !papszSrcMDD)
4467
0
            {
4468
0
                for (const char *pszDomain : {"", "IMAGERY"})
4469
0
                {
4470
0
                    if (CSLConstList papszMD = poBand->GetMetadata(pszDomain))
4471
0
                    {
4472
0
                        if (papszMD[0])
4473
0
                        {
4474
0
                            bOMDMDSet = true;
4475
0
                            l_oMDMD.SetMetadata(papszMD, pszDomain);
4476
0
                        }
4477
0
                    }
4478
0
                }
4479
0
            }
4480
0
            else if (CPLTestBool(pszCopySrcMDD) || papszSrcMDD)
4481
0
            {
4482
0
                char **papszDomainList = poBand->GetMetadataDomainList();
4483
0
                for (const char *pszDomain :
4484
0
                     cpl::Iterate(CSLConstList(papszDomainList)))
4485
0
                {
4486
0
                    if (pszDomain[0] != 0 &&
4487
0
                        !EQUAL(pszDomain, "IMAGE_STRUCTURE") &&
4488
0
                        (!papszSrcMDD ||
4489
0
                         CSLFindString(papszSrcMDD, pszDomain) >= 0))
4490
0
                    {
4491
0
                        bOMDMDSet = true;
4492
0
                        l_oMDMD.SetMetadata(poBand->GetMetadata(pszDomain),
4493
0
                                            pszDomain);
4494
0
                    }
4495
0
                }
4496
0
                CSLDestroy(papszDomainList);
4497
0
            }
4498
4499
0
            if (bOMDMDSet)
4500
0
            {
4501
0
                WriteMDMetadata(&l_oMDMD, l_hTIFF, &psRoot, &psTail, nBand,
4502
0
                                eProfile);
4503
0
            }
4504
0
        }
4505
4506
0
        const double dfOffset = poBand->GetOffset();
4507
0
        const double dfScale = poBand->GetScale();
4508
0
        bool bGeoTIFFScaleOffsetInZ = false;
4509
0
        GDALGeoTransform gt;
4510
        // Check if we have already encoded scale/offset in the GeoTIFF tags
4511
0
        if (poSrcDS->GetGeoTransform(gt) == CE_None && gt.xrot == 0.0 &&
4512
0
            gt.yrot == 0.0 && gt.yscale < 0.0 && poSrcDS->GetSpatialRef() &&
4513
0
            poSrcDS->GetSpatialRef()->IsVertical() &&
4514
0
            poSrcDS->GetRasterCount() == 1)
4515
0
        {
4516
0
            bGeoTIFFScaleOffsetInZ = true;
4517
0
        }
4518
4519
0
        if ((dfOffset != 0.0 || dfScale != 1.0) && !bGeoTIFFScaleOffsetInZ)
4520
0
        {
4521
0
            char szValue[128] = {};
4522
4523
0
            CPLsnprintf(szValue, sizeof(szValue), "%.17g", dfOffset);
4524
0
            AppendMetadataItem(&psRoot, &psTail, "OFFSET", szValue, nBand,
4525
0
                               "offset", "");
4526
0
            CPLsnprintf(szValue, sizeof(szValue), "%.17g", dfScale);
4527
0
            AppendMetadataItem(&psRoot, &psTail, "SCALE", szValue, nBand,
4528
0
                               "scale", "");
4529
0
        }
4530
4531
0
        const char *pszUnitType = poBand->GetUnitType();
4532
0
        if (pszUnitType != nullptr && pszUnitType[0] != '\0')
4533
0
        {
4534
0
            bool bWriteUnit = true;
4535
0
            auto poSRS = poSrcDS->GetSpatialRef();
4536
0
            if (poSRS && poSRS->IsCompound())
4537
0
            {
4538
0
                const char *pszVertUnit = nullptr;
4539
0
                poSRS->GetTargetLinearUnits("COMPD_CS|VERT_CS", &pszVertUnit);
4540
0
                if (pszVertUnit && EQUAL(pszVertUnit, pszUnitType))
4541
0
                {
4542
0
                    bWriteUnit = false;
4543
0
                }
4544
0
            }
4545
0
            if (bWriteUnit)
4546
0
            {
4547
0
                AppendMetadataItem(&psRoot, &psTail, "UNITTYPE", pszUnitType,
4548
0
                                   nBand, "unittype", "");
4549
0
            }
4550
0
        }
4551
4552
0
        if (strlen(poBand->GetDescription()) > 0)
4553
0
        {
4554
0
            AppendMetadataItem(&psRoot, &psTail, "DESCRIPTION",
4555
0
                               poBand->GetDescription(), nBand, "description",
4556
0
                               "");
4557
0
        }
4558
4559
0
        if (!bStandardColorInterp &&
4560
0
            !(nBand <= 3 && EQUAL(CSLFetchNameValueDef(papszCreationOptions,
4561
0
                                                       "PHOTOMETRIC", ""),
4562
0
                                  "RGB")))
4563
0
        {
4564
0
            AppendMetadataItem(&psRoot, &psTail, "COLORINTERP",
4565
0
                               GDALGetColorInterpretationName(
4566
0
                                   poBand->GetColorInterpretation()),
4567
0
                               nBand, "colorinterp", "");
4568
0
        }
4569
0
    }
4570
4571
0
    CSLDestroy(papszSrcMDD);
4572
4573
0
    const char *pszTilingSchemeName =
4574
0
        CSLFetchNameValue(papszCreationOptions, "@TILING_SCHEME_NAME");
4575
0
    if (pszTilingSchemeName)
4576
0
    {
4577
0
        AppendMetadataItem(&psRoot, &psTail, "NAME", pszTilingSchemeName, 0,
4578
0
                           nullptr, "TILING_SCHEME");
4579
4580
0
        const char *pszZoomLevel = CSLFetchNameValue(
4581
0
            papszCreationOptions, "@TILING_SCHEME_ZOOM_LEVEL");
4582
0
        if (pszZoomLevel)
4583
0
        {
4584
0
            AppendMetadataItem(&psRoot, &psTail, "ZOOM_LEVEL", pszZoomLevel, 0,
4585
0
                               nullptr, "TILING_SCHEME");
4586
0
        }
4587
4588
0
        const char *pszAlignedLevels = CSLFetchNameValue(
4589
0
            papszCreationOptions, "@TILING_SCHEME_ALIGNED_LEVELS");
4590
0
        if (pszAlignedLevels)
4591
0
        {
4592
0
            AppendMetadataItem(&psRoot, &psTail, "ALIGNED_LEVELS",
4593
0
                               pszAlignedLevels, 0, nullptr, "TILING_SCHEME");
4594
0
        }
4595
0
    }
4596
4597
0
    if (const char *pszOverviewResampling =
4598
0
            CSLFetchNameValue(papszCreationOptions, "@OVERVIEW_RESAMPLING"))
4599
0
    {
4600
0
        AppendMetadataItem(&psRoot, &psTail, "OVERVIEW_RESAMPLING",
4601
0
                           pszOverviewResampling, 0, nullptr,
4602
0
                           "IMAGE_STRUCTURE");
4603
0
    }
4604
4605
    /* -------------------------------------------------------------------- */
4606
    /*      Write information about some codecs.                            */
4607
    /* -------------------------------------------------------------------- */
4608
0
    if (CPLTestBool(
4609
0
            CPLGetConfigOption("GTIFF_WRITE_IMAGE_STRUCTURE_METADATA", "YES")))
4610
0
    {
4611
0
        const char *pszTileInterleave =
4612
0
            CSLFetchNameValue(papszCreationOptions, "@TILE_INTERLEAVE");
4613
0
        if (pszTileInterleave && CPLTestBool(pszTileInterleave))
4614
0
        {
4615
0
            AppendMetadataItem(&psRoot, &psTail, "INTERLEAVE", "TILE", 0,
4616
0
                               nullptr, "IMAGE_STRUCTURE");
4617
0
        }
4618
4619
0
        const char *pszCompress =
4620
0
            CSLFetchNameValue(papszCreationOptions, "COMPRESS");
4621
0
        if (pszCompress && EQUAL(pszCompress, "WEBP"))
4622
0
        {
4623
0
            if (GTiffGetWebPLossless(papszCreationOptions))
4624
0
            {
4625
0
                AppendMetadataItem(&psRoot, &psTail,
4626
0
                                   "COMPRESSION_REVERSIBILITY", "LOSSLESS", 0,
4627
0
                                   nullptr, "IMAGE_STRUCTURE");
4628
0
            }
4629
0
            else
4630
0
            {
4631
0
                AppendMetadataItem(
4632
0
                    &psRoot, &psTail, "WEBP_LEVEL",
4633
0
                    CPLSPrintf("%d", GTiffGetWebPLevel(papszCreationOptions)),
4634
0
                    0, nullptr, "IMAGE_STRUCTURE");
4635
0
            }
4636
0
        }
4637
0
        else if (pszCompress && STARTS_WITH_CI(pszCompress, "LERC"))
4638
0
        {
4639
0
            const double dfMaxZError =
4640
0
                GTiffGetLERCMaxZError(papszCreationOptions);
4641
0
            const double dfMaxZErrorOverview =
4642
0
                GTiffGetLERCMaxZErrorOverview(papszCreationOptions);
4643
0
            if (dfMaxZError == 0.0 && dfMaxZErrorOverview == 0.0)
4644
0
            {
4645
0
                AppendMetadataItem(&psRoot, &psTail,
4646
0
                                   "COMPRESSION_REVERSIBILITY", "LOSSLESS", 0,
4647
0
                                   nullptr, "IMAGE_STRUCTURE");
4648
0
            }
4649
0
            else
4650
0
            {
4651
0
                AppendMetadataItem(&psRoot, &psTail, "MAX_Z_ERROR",
4652
0
                                   CSLFetchNameValueDef(papszCreationOptions,
4653
0
                                                        "MAX_Z_ERROR", ""),
4654
0
                                   0, nullptr, "IMAGE_STRUCTURE");
4655
0
                if (dfMaxZError != dfMaxZErrorOverview)
4656
0
                {
4657
0
                    AppendMetadataItem(
4658
0
                        &psRoot, &psTail, "MAX_Z_ERROR_OVERVIEW",
4659
0
                        CSLFetchNameValueDef(papszCreationOptions,
4660
0
                                             "MAX_Z_ERROR_OVERVIEW", ""),
4661
0
                        0, nullptr, "IMAGE_STRUCTURE");
4662
0
                }
4663
0
            }
4664
0
        }
4665
#if HAVE_JXL
4666
        else if (pszCompress && EQUAL(pszCompress, "JXL"))
4667
        {
4668
            float fDistance = 0.0f;
4669
            if (GTiffGetJXLLossless(papszCreationOptions))
4670
            {
4671
                AppendMetadataItem(&psRoot, &psTail,
4672
                                   "COMPRESSION_REVERSIBILITY", "LOSSLESS", 0,
4673
                                   nullptr, "IMAGE_STRUCTURE");
4674
            }
4675
            else
4676
            {
4677
                fDistance = GTiffGetJXLDistance(papszCreationOptions);
4678
                AppendMetadataItem(
4679
                    &psRoot, &psTail, "JXL_DISTANCE",
4680
                    CPLSPrintf("%f", static_cast<double>(fDistance)), 0,
4681
                    nullptr, "IMAGE_STRUCTURE");
4682
            }
4683
            const float fAlphaDistance =
4684
                GTiffGetJXLAlphaDistance(papszCreationOptions);
4685
            if (fAlphaDistance >= 0.0f && fAlphaDistance != fDistance)
4686
            {
4687
                AppendMetadataItem(
4688
                    &psRoot, &psTail, "JXL_ALPHA_DISTANCE",
4689
                    CPLSPrintf("%f", static_cast<double>(fAlphaDistance)), 0,
4690
                    nullptr, "IMAGE_STRUCTURE");
4691
            }
4692
            AppendMetadataItem(
4693
                &psRoot, &psTail, "JXL_EFFORT",
4694
                CPLSPrintf("%d", GTiffGetJXLEffort(papszCreationOptions)), 0,
4695
                nullptr, "IMAGE_STRUCTURE");
4696
        }
4697
#endif
4698
0
    }
4699
4700
0
    if (!CPLTestBool(CPLGetConfigOption("GTIFF_WRITE_RAT_TO_PAM", "NO")))
4701
0
    {
4702
0
        for (int nBand = 1; nBand <= poSrcDS->GetRasterCount(); ++nBand)
4703
0
        {
4704
0
            GDALRasterBand *poBand = poSrcDS->GetRasterBand(nBand);
4705
0
            const auto poRAT = poBand->GetDefaultRAT();
4706
0
            if (poRAT)
4707
0
            {
4708
0
                auto psSerializedRAT = poRAT->Serialize();
4709
0
                if (psSerializedRAT)
4710
0
                {
4711
0
                    AppendMetadataItem(
4712
0
                        &psRoot, &psTail, DEFAULT_RASTER_ATTRIBUTE_TABLE,
4713
0
                        nullptr, psSerializedRAT, nBand, RAT_ROLE, nullptr);
4714
0
                }
4715
0
            }
4716
0
        }
4717
0
    }
4718
4719
    /* -------------------------------------------------------------------- */
4720
    /*      Write out the generic XML metadata if there is any.             */
4721
    /* -------------------------------------------------------------------- */
4722
0
    if (psRoot != nullptr)
4723
0
    {
4724
0
        bool bRet = true;
4725
4726
0
        if (eProfile == GTiffProfile::GDALGEOTIFF)
4727
0
        {
4728
0
            char *pszXML_MD = CPLSerializeXMLTree(psRoot);
4729
0
            TIFFSetField(l_hTIFF, TIFFTAG_GDAL_METADATA, pszXML_MD);
4730
0
            CPLFree(pszXML_MD);
4731
0
        }
4732
0
        else
4733
0
        {
4734
0
            if (bSrcIsGeoTIFF)
4735
0
                cpl::down_cast<GTiffDataset *>(poSrcDS)->PushMetadataToPam();
4736
0
            else
4737
0
                bRet = false;
4738
0
        }
4739
4740
0
        CPLDestroyXMLNode(psRoot);
4741
4742
0
        return bRet;
4743
0
    }
4744
4745
    // If we have no more metadata but it existed before,
4746
    // remove the GDAL_METADATA tag.
4747
0
    if (eProfile == GTiffProfile::GDALGEOTIFF)
4748
0
    {
4749
0
        char *pszText = nullptr;
4750
0
        if (TIFFGetField(l_hTIFF, TIFFTAG_GDAL_METADATA, &pszText))
4751
0
        {
4752
0
            TIFFUnsetField(l_hTIFF, TIFFTAG_GDAL_METADATA);
4753
0
        }
4754
0
    }
4755
4756
0
    return true;
4757
0
}
4758
4759
/************************************************************************/
4760
/*                         PushMetadataToPam()                          */
4761
/*                                                                      */
4762
/*      When producing a strict profile TIFF or if our aggregate        */
4763
/*      metadata is too big for a single tiff tag we may end up         */
4764
/*      needing to write it via the PAM mechanisms.  This method        */
4765
/*      copies all the appropriate metadata into the PAM level          */
4766
/*      metadata object but with special care to avoid copying          */
4767
/*      metadata handled in other ways in TIFF format.                  */
4768
/************************************************************************/
4769
4770
void GTiffDataset::PushMetadataToPam()
4771
4772
0
{
4773
0
    if (GetPamFlags() & GPF_DISABLED)
4774
0
        return;
4775
4776
0
    const bool bStandardColorInterp = GTIFFIsStandardColorInterpretation(
4777
0
        GDALDataset::ToHandle(this), m_nPhotometric, m_papszCreationOptions);
4778
4779
0
    for (int nBand = 0; nBand <= GetRasterCount(); ++nBand)
4780
0
    {
4781
0
        GDALMultiDomainMetadata *poSrcMDMD = nullptr;
4782
0
        GTiffRasterBand *poBand = nullptr;
4783
4784
0
        if (nBand == 0)
4785
0
        {
4786
0
            poSrcMDMD = &(this->m_oGTiffMDMD);
4787
0
        }
4788
0
        else
4789
0
        {
4790
0
            poBand = cpl::down_cast<GTiffRasterBand *>(GetRasterBand(nBand));
4791
0
            poSrcMDMD = &(poBand->m_oGTiffMDMD);
4792
0
        }
4793
4794
        /* --------------------------------------------------------------------
4795
         */
4796
        /*      Loop over the available domains. */
4797
        /* --------------------------------------------------------------------
4798
         */
4799
0
        CSLConstList papszDomainList = poSrcMDMD->GetDomainList();
4800
0
        for (int iDomain = 0; papszDomainList && papszDomainList[iDomain];
4801
0
             ++iDomain)
4802
0
        {
4803
0
            char **papszMD = poSrcMDMD->GetMetadata(papszDomainList[iDomain]);
4804
4805
0
            if (EQUAL(papszDomainList[iDomain], MD_DOMAIN_RPC) ||
4806
0
                EQUAL(papszDomainList[iDomain], MD_DOMAIN_IMD) ||
4807
0
                EQUAL(papszDomainList[iDomain], "_temporary_") ||
4808
0
                EQUAL(papszDomainList[iDomain], "IMAGE_STRUCTURE") ||
4809
0
                EQUAL(papszDomainList[iDomain], "COLOR_PROFILE"))
4810
0
                continue;
4811
4812
0
            papszMD = CSLDuplicate(papszMD);
4813
4814
0
            for (int i = CSLCount(papszMD) - 1; i >= 0; --i)
4815
0
            {
4816
0
                if (STARTS_WITH_CI(papszMD[i], "TIFFTAG_") ||
4817
0
                    EQUALN(papszMD[i], GDALMD_AREA_OR_POINT,
4818
0
                           strlen(GDALMD_AREA_OR_POINT)))
4819
0
                    papszMD = CSLRemoveStrings(papszMD, i, 1, nullptr);
4820
0
            }
4821
4822
0
            if (nBand == 0)
4823
0
                GDALPamDataset::SetMetadata(papszMD, papszDomainList[iDomain]);
4824
0
            else
4825
0
                poBand->GDALPamRasterBand::SetMetadata(
4826
0
                    papszMD, papszDomainList[iDomain]);
4827
4828
0
            CSLDestroy(papszMD);
4829
0
        }
4830
4831
        /* --------------------------------------------------------------------
4832
         */
4833
        /*      Handle some "special domain" stuff. */
4834
        /* --------------------------------------------------------------------
4835
         */
4836
0
        if (poBand != nullptr)
4837
0
        {
4838
0
            poBand->GDALPamRasterBand::SetOffset(poBand->GetOffset());
4839
0
            poBand->GDALPamRasterBand::SetScale(poBand->GetScale());
4840
0
            poBand->GDALPamRasterBand::SetUnitType(poBand->GetUnitType());
4841
0
            poBand->GDALPamRasterBand::SetDescription(poBand->GetDescription());
4842
0
            if (!bStandardColorInterp)
4843
0
            {
4844
0
                poBand->GDALPamRasterBand::SetColorInterpretation(
4845
0
                    poBand->GetColorInterpretation());
4846
0
            }
4847
0
        }
4848
0
    }
4849
0
    MarkPamDirty();
4850
0
}
4851
4852
/************************************************************************/
4853
/*                          WriteNoDataValue()                          */
4854
/************************************************************************/
4855
4856
void GTiffDataset::WriteNoDataValue(TIFF *hTIFF, double dfNoData)
4857
4858
0
{
4859
0
    CPLString osVal(GTiffFormatGDALNoDataTagValue(dfNoData));
4860
0
    TIFFSetField(hTIFF, TIFFTAG_GDAL_NODATA, osVal.c_str());
4861
0
}
4862
4863
void GTiffDataset::WriteNoDataValue(TIFF *hTIFF, int64_t nNoData)
4864
4865
0
{
4866
0
    TIFFSetField(hTIFF, TIFFTAG_GDAL_NODATA,
4867
0
                 CPLSPrintf(CPL_FRMT_GIB, static_cast<GIntBig>(nNoData)));
4868
0
}
4869
4870
void GTiffDataset::WriteNoDataValue(TIFF *hTIFF, uint64_t nNoData)
4871
4872
0
{
4873
0
    TIFFSetField(hTIFF, TIFFTAG_GDAL_NODATA,
4874
0
                 CPLSPrintf(CPL_FRMT_GUIB, static_cast<GUIntBig>(nNoData)));
4875
0
}
4876
4877
/************************************************************************/
4878
/*                          UnsetNoDataValue()                          */
4879
/************************************************************************/
4880
4881
void GTiffDataset::UnsetNoDataValue(TIFF *l_hTIFF)
4882
4883
0
{
4884
0
    TIFFUnsetField(l_hTIFF, TIFFTAG_GDAL_NODATA);
4885
0
}
4886
4887
/************************************************************************/
4888
/*                             SaveICCProfile()                         */
4889
/*                                                                      */
4890
/*      Save ICC Profile or colorimetric data into file                 */
4891
/* pDS:                                                                 */
4892
/*      Dataset that contains the metadata with the ICC or colorimetric */
4893
/*      data. If this argument is specified, all other arguments are    */
4894
/*      ignored. Set them to NULL or 0.                                 */
4895
/* hTIFF:                                                               */
4896
/*      Pointer to TIFF handle. Only needed if pDS is NULL or           */
4897
/*      pDS->m_hTIFF is NULL.                                             */
4898
/* papszParamList:                                                       */
4899
/*      Options containing the ICC profile or colorimetric metadata.    */
4900
/*      Ignored if pDS is not NULL.                                     */
4901
/* nBitsPerSample:                                                      */
4902
/*      Bits per sample. Ignored if pDS is not NULL.                    */
4903
/************************************************************************/
4904
4905
void GTiffDataset::SaveICCProfile(GTiffDataset *pDS, TIFF *l_hTIFF,
4906
                                  CSLConstList papszParamList,
4907
                                  uint32_t l_nBitsPerSample)
4908
0
{
4909
0
    if ((pDS != nullptr) && (pDS->eAccess != GA_Update))
4910
0
        return;
4911
4912
0
    if (l_hTIFF == nullptr)
4913
0
    {
4914
0
        if (pDS == nullptr)
4915
0
            return;
4916
4917
0
        l_hTIFF = pDS->m_hTIFF;
4918
0
        if (l_hTIFF == nullptr)
4919
0
            return;
4920
0
    }
4921
4922
0
    if ((papszParamList == nullptr) && (pDS == nullptr))
4923
0
        return;
4924
4925
0
    const char *pszICCProfile =
4926
0
        (pDS != nullptr)
4927
0
            ? pDS->GetMetadataItem("SOURCE_ICC_PROFILE", "COLOR_PROFILE")
4928
0
            : CSLFetchNameValue(papszParamList, "SOURCE_ICC_PROFILE");
4929
0
    if (pszICCProfile != nullptr)
4930
0
    {
4931
0
        char *pEmbedBuffer = CPLStrdup(pszICCProfile);
4932
0
        int32_t nEmbedLen =
4933
0
            CPLBase64DecodeInPlace(reinterpret_cast<GByte *>(pEmbedBuffer));
4934
4935
0
        TIFFSetField(l_hTIFF, TIFFTAG_ICCPROFILE, nEmbedLen, pEmbedBuffer);
4936
4937
0
        CPLFree(pEmbedBuffer);
4938
0
    }
4939
0
    else
4940
0
    {
4941
        // Output colorimetric data.
4942
0
        float pCHR[6] = {};     // Primaries.
4943
0
        uint16_t pTXR[6] = {};  // Transfer range.
4944
0
        const char *pszCHRNames[] = {"SOURCE_PRIMARIES_RED",
4945
0
                                     "SOURCE_PRIMARIES_GREEN",
4946
0
                                     "SOURCE_PRIMARIES_BLUE"};
4947
0
        const char *pszTXRNames[] = {"TIFFTAG_TRANSFERRANGE_BLACK",
4948
0
                                     "TIFFTAG_TRANSFERRANGE_WHITE"};
4949
4950
        // Output chromacities.
4951
0
        bool bOutputCHR = true;
4952
0
        for (int i = 0; i < 3 && bOutputCHR; ++i)
4953
0
        {
4954
0
            const char *pszColorProfile =
4955
0
                (pDS != nullptr)
4956
0
                    ? pDS->GetMetadataItem(pszCHRNames[i], "COLOR_PROFILE")
4957
0
                    : CSLFetchNameValue(papszParamList, pszCHRNames[i]);
4958
0
            if (pszColorProfile == nullptr)
4959
0
            {
4960
0
                bOutputCHR = false;
4961
0
                break;
4962
0
            }
4963
4964
0
            const CPLStringList aosTokens(CSLTokenizeString2(
4965
0
                pszColorProfile, ",",
4966
0
                CSLT_ALLOWEMPTYTOKENS | CSLT_STRIPLEADSPACES |
4967
0
                    CSLT_STRIPENDSPACES));
4968
4969
0
            if (aosTokens.size() != 3)
4970
0
            {
4971
0
                bOutputCHR = false;
4972
0
                break;
4973
0
            }
4974
4975
0
            for (int j = 0; j < 3; ++j)
4976
0
            {
4977
0
                float v = static_cast<float>(CPLAtof(aosTokens[j]));
4978
4979
0
                if (j == 2)
4980
0
                {
4981
                    // Last term of xyY color must be 1.0.
4982
0
                    if (v != 1.0f)
4983
0
                    {
4984
0
                        bOutputCHR = false;
4985
0
                        break;
4986
0
                    }
4987
0
                }
4988
0
                else
4989
0
                {
4990
0
                    pCHR[i * 2 + j] = v;
4991
0
                }
4992
0
            }
4993
0
        }
4994
4995
0
        if (bOutputCHR)
4996
0
        {
4997
0
            TIFFSetField(l_hTIFF, TIFFTAG_PRIMARYCHROMATICITIES, pCHR);
4998
0
        }
4999
5000
        // Output whitepoint.
5001
0
        const char *pszSourceWhitePoint =
5002
0
            (pDS != nullptr)
5003
0
                ? pDS->GetMetadataItem("SOURCE_WHITEPOINT", "COLOR_PROFILE")
5004
0
                : CSLFetchNameValue(papszParamList, "SOURCE_WHITEPOINT");
5005
0
        if (pszSourceWhitePoint != nullptr)
5006
0
        {
5007
0
            const CPLStringList aosTokens(CSLTokenizeString2(
5008
0
                pszSourceWhitePoint, ",",
5009
0
                CSLT_ALLOWEMPTYTOKENS | CSLT_STRIPLEADSPACES |
5010
0
                    CSLT_STRIPENDSPACES));
5011
5012
0
            bool bOutputWhitepoint = true;
5013
0
            float pWP[2] = {0.0f, 0.0f};  // Whitepoint
5014
0
            if (aosTokens.size() != 3)
5015
0
            {
5016
0
                bOutputWhitepoint = false;
5017
0
            }
5018
0
            else
5019
0
            {
5020
0
                for (int j = 0; j < 3; ++j)
5021
0
                {
5022
0
                    const float v = static_cast<float>(CPLAtof(aosTokens[j]));
5023
5024
0
                    if (j == 2)
5025
0
                    {
5026
                        // Last term of xyY color must be 1.0.
5027
0
                        if (v != 1.0f)
5028
0
                        {
5029
0
                            bOutputWhitepoint = false;
5030
0
                            break;
5031
0
                        }
5032
0
                    }
5033
0
                    else
5034
0
                    {
5035
0
                        pWP[j] = v;
5036
0
                    }
5037
0
                }
5038
0
            }
5039
5040
0
            if (bOutputWhitepoint)
5041
0
            {
5042
0
                TIFFSetField(l_hTIFF, TIFFTAG_WHITEPOINT, pWP);
5043
0
            }
5044
0
        }
5045
5046
        // Set transfer function metadata.
5047
0
        char const *pszTFRed =
5048
0
            (pDS != nullptr)
5049
0
                ? pDS->GetMetadataItem("TIFFTAG_TRANSFERFUNCTION_RED",
5050
0
                                       "COLOR_PROFILE")
5051
0
                : CSLFetchNameValue(papszParamList,
5052
0
                                    "TIFFTAG_TRANSFERFUNCTION_RED");
5053
5054
0
        char const *pszTFGreen =
5055
0
            (pDS != nullptr)
5056
0
                ? pDS->GetMetadataItem("TIFFTAG_TRANSFERFUNCTION_GREEN",
5057
0
                                       "COLOR_PROFILE")
5058
0
                : CSLFetchNameValue(papszParamList,
5059
0
                                    "TIFFTAG_TRANSFERFUNCTION_GREEN");
5060
5061
0
        char const *pszTFBlue =
5062
0
            (pDS != nullptr)
5063
0
                ? pDS->GetMetadataItem("TIFFTAG_TRANSFERFUNCTION_BLUE",
5064
0
                                       "COLOR_PROFILE")
5065
0
                : CSLFetchNameValue(papszParamList,
5066
0
                                    "TIFFTAG_TRANSFERFUNCTION_BLUE");
5067
5068
0
        if ((pszTFRed != nullptr) && (pszTFGreen != nullptr) &&
5069
0
            (pszTFBlue != nullptr))
5070
0
        {
5071
            // Get length of table.
5072
0
            const int nTransferFunctionLength =
5073
0
                1 << ((pDS != nullptr) ? pDS->m_nBitsPerSample
5074
0
                                       : l_nBitsPerSample);
5075
5076
0
            const CPLStringList aosTokensRed(CSLTokenizeString2(
5077
0
                pszTFRed, ",",
5078
0
                CSLT_ALLOWEMPTYTOKENS | CSLT_STRIPLEADSPACES |
5079
0
                    CSLT_STRIPENDSPACES));
5080
0
            const CPLStringList aosTokensGreen(CSLTokenizeString2(
5081
0
                pszTFGreen, ",",
5082
0
                CSLT_ALLOWEMPTYTOKENS | CSLT_STRIPLEADSPACES |
5083
0
                    CSLT_STRIPENDSPACES));
5084
0
            const CPLStringList aosTokensBlue(CSLTokenizeString2(
5085
0
                pszTFBlue, ",",
5086
0
                CSLT_ALLOWEMPTYTOKENS | CSLT_STRIPLEADSPACES |
5087
0
                    CSLT_STRIPENDSPACES));
5088
5089
0
            if ((aosTokensRed.size() == nTransferFunctionLength) &&
5090
0
                (aosTokensGreen.size() == nTransferFunctionLength) &&
5091
0
                (aosTokensBlue.size() == nTransferFunctionLength))
5092
0
            {
5093
0
                std::vector<uint16_t> anTransferFuncRed(
5094
0
                    nTransferFunctionLength);
5095
0
                std::vector<uint16_t> anTransferFuncGreen(
5096
0
                    nTransferFunctionLength);
5097
0
                std::vector<uint16_t> anTransferFuncBlue(
5098
0
                    nTransferFunctionLength);
5099
5100
                // Convert our table in string format into int16_t format.
5101
0
                for (int i = 0; i < nTransferFunctionLength; ++i)
5102
0
                {
5103
0
                    anTransferFuncRed[i] =
5104
0
                        static_cast<uint16_t>(atoi(aosTokensRed[i]));
5105
0
                    anTransferFuncGreen[i] =
5106
0
                        static_cast<uint16_t>(atoi(aosTokensGreen[i]));
5107
0
                    anTransferFuncBlue[i] =
5108
0
                        static_cast<uint16_t>(atoi(aosTokensBlue[i]));
5109
0
                }
5110
5111
0
                TIFFSetField(
5112
0
                    l_hTIFF, TIFFTAG_TRANSFERFUNCTION, anTransferFuncRed.data(),
5113
0
                    anTransferFuncGreen.data(), anTransferFuncBlue.data());
5114
0
            }
5115
0
        }
5116
5117
        // Output transfer range.
5118
0
        bool bOutputTransferRange = true;
5119
0
        for (int i = 0; (i < 2) && bOutputTransferRange; ++i)
5120
0
        {
5121
0
            const char *pszTXRVal =
5122
0
                (pDS != nullptr)
5123
0
                    ? pDS->GetMetadataItem(pszTXRNames[i], "COLOR_PROFILE")
5124
0
                    : CSLFetchNameValue(papszParamList, pszTXRNames[i]);
5125
0
            if (pszTXRVal == nullptr)
5126
0
            {
5127
0
                bOutputTransferRange = false;
5128
0
                break;
5129
0
            }
5130
5131
0
            const CPLStringList aosTokens(CSLTokenizeString2(
5132
0
                pszTXRVal, ",",
5133
0
                CSLT_ALLOWEMPTYTOKENS | CSLT_STRIPLEADSPACES |
5134
0
                    CSLT_STRIPENDSPACES));
5135
5136
0
            if (aosTokens.size() != 3)
5137
0
            {
5138
0
                bOutputTransferRange = false;
5139
0
                break;
5140
0
            }
5141
5142
0
            for (int j = 0; j < 3; ++j)
5143
0
            {
5144
0
                pTXR[i + j * 2] = static_cast<uint16_t>(atoi(aosTokens[j]));
5145
0
            }
5146
0
        }
5147
5148
0
        if (bOutputTransferRange)
5149
0
        {
5150
0
            const int TIFFTAG_TRANSFERRANGE = 0x0156;
5151
0
            TIFFSetField(l_hTIFF, TIFFTAG_TRANSFERRANGE, pTXR);
5152
0
        }
5153
0
    }
5154
0
}
5155
5156
static signed char GTiffGetLZMAPreset(CSLConstList papszOptions)
5157
0
{
5158
0
    int nLZMAPreset = -1;
5159
0
    const char *pszValue = CSLFetchNameValue(papszOptions, "LZMA_PRESET");
5160
0
    if (pszValue != nullptr)
5161
0
    {
5162
0
        nLZMAPreset = atoi(pszValue);
5163
0
        if (!(nLZMAPreset >= 0 && nLZMAPreset <= 9))
5164
0
        {
5165
0
            CPLError(CE_Warning, CPLE_IllegalArg,
5166
0
                     "LZMA_PRESET=%s value not recognised, ignoring.",
5167
0
                     pszValue);
5168
0
            nLZMAPreset = -1;
5169
0
        }
5170
0
    }
5171
0
    return static_cast<signed char>(nLZMAPreset);
5172
0
}
5173
5174
static signed char GTiffGetZSTDPreset(CSLConstList papszOptions)
5175
0
{
5176
0
    int nZSTDLevel = -1;
5177
0
    const char *pszValue = CSLFetchNameValue(papszOptions, "ZSTD_LEVEL");
5178
0
    if (pszValue != nullptr)
5179
0
    {
5180
0
        nZSTDLevel = atoi(pszValue);
5181
0
        if (!(nZSTDLevel >= 1 && nZSTDLevel <= 22))
5182
0
        {
5183
0
            CPLError(CE_Warning, CPLE_IllegalArg,
5184
0
                     "ZSTD_LEVEL=%s value not recognised, ignoring.", pszValue);
5185
0
            nZSTDLevel = -1;
5186
0
        }
5187
0
    }
5188
0
    return static_cast<signed char>(nZSTDLevel);
5189
0
}
5190
5191
static signed char GTiffGetZLevel(CSLConstList papszOptions)
5192
0
{
5193
0
    int nZLevel = -1;
5194
0
    const char *pszValue = CSLFetchNameValue(papszOptions, "ZLEVEL");
5195
0
    if (pszValue != nullptr)
5196
0
    {
5197
0
        nZLevel = atoi(pszValue);
5198
0
#ifdef TIFFTAG_DEFLATE_SUBCODEC
5199
0
        constexpr int nMaxLevel = 12;
5200
0
#ifndef LIBDEFLATE_SUPPORT
5201
0
        if (nZLevel > 9 && nZLevel <= nMaxLevel)
5202
0
        {
5203
0
            CPLDebug("GTiff",
5204
0
                     "ZLEVEL=%d not supported in a non-libdeflate enabled "
5205
0
                     "libtiff build. Capping to 9",
5206
0
                     nZLevel);
5207
0
            nZLevel = 9;
5208
0
        }
5209
0
#endif
5210
#else
5211
        constexpr int nMaxLevel = 9;
5212
#endif
5213
0
        if (nZLevel < 1 || nZLevel > nMaxLevel)
5214
0
        {
5215
0
            CPLError(CE_Warning, CPLE_IllegalArg,
5216
0
                     "ZLEVEL=%s value not recognised, ignoring.", pszValue);
5217
0
            nZLevel = -1;
5218
0
        }
5219
0
    }
5220
0
    return static_cast<signed char>(nZLevel);
5221
0
}
5222
5223
static signed char GTiffGetJpegQuality(CSLConstList papszOptions)
5224
0
{
5225
0
    int nJpegQuality = -1;
5226
0
    const char *pszValue = CSLFetchNameValue(papszOptions, "JPEG_QUALITY");
5227
0
    if (pszValue != nullptr)
5228
0
    {
5229
0
        nJpegQuality = atoi(pszValue);
5230
0
        if (nJpegQuality < 1 || nJpegQuality > 100)
5231
0
        {
5232
0
            CPLError(CE_Warning, CPLE_IllegalArg,
5233
0
                     "JPEG_QUALITY=%s value not recognised, ignoring.",
5234
0
                     pszValue);
5235
0
            nJpegQuality = -1;
5236
0
        }
5237
0
    }
5238
0
    return static_cast<signed char>(nJpegQuality);
5239
0
}
5240
5241
static signed char GTiffGetJpegTablesMode(CSLConstList papszOptions)
5242
0
{
5243
0
    return static_cast<signed char>(atoi(
5244
0
        CSLFetchNameValueDef(papszOptions, "JPEGTABLESMODE",
5245
0
                             CPLSPrintf("%d", knGTIFFJpegTablesModeDefault))));
5246
0
}
5247
5248
/************************************************************************/
5249
/*                        GetDiscardLsbOption()                         */
5250
/************************************************************************/
5251
5252
static GTiffDataset::MaskOffset *GetDiscardLsbOption(TIFF *hTIFF,
5253
                                                     CSLConstList papszOptions)
5254
0
{
5255
0
    const char *pszBits = CSLFetchNameValue(papszOptions, "DISCARD_LSB");
5256
0
    if (pszBits == nullptr)
5257
0
        return nullptr;
5258
5259
0
    uint16_t nPhotometric = 0;
5260
0
    TIFFGetFieldDefaulted(hTIFF, TIFFTAG_PHOTOMETRIC, &nPhotometric);
5261
5262
0
    uint16_t nBitsPerSample = 0;
5263
0
    if (!TIFFGetField(hTIFF, TIFFTAG_BITSPERSAMPLE, &nBitsPerSample))
5264
0
        nBitsPerSample = 1;
5265
5266
0
    uint16_t nSamplesPerPixel = 0;
5267
0
    if (!TIFFGetField(hTIFF, TIFFTAG_SAMPLESPERPIXEL, &nSamplesPerPixel))
5268
0
        nSamplesPerPixel = 1;
5269
5270
0
    uint16_t nSampleFormat = 0;
5271
0
    if (!TIFFGetField(hTIFF, TIFFTAG_SAMPLEFORMAT, &nSampleFormat))
5272
0
        nSampleFormat = SAMPLEFORMAT_UINT;
5273
5274
0
    if (nPhotometric == PHOTOMETRIC_PALETTE)
5275
0
    {
5276
0
        CPLError(CE_Warning, CPLE_AppDefined,
5277
0
                 "DISCARD_LSB ignored on a paletted image");
5278
0
        return nullptr;
5279
0
    }
5280
0
    if (!(nBitsPerSample == 8 || nBitsPerSample == 16 || nBitsPerSample == 32 ||
5281
0
          nBitsPerSample == 64))
5282
0
    {
5283
0
        CPLError(CE_Warning, CPLE_AppDefined,
5284
0
                 "DISCARD_LSB ignored on non 8, 16, 32 or 64 bits images");
5285
0
        return nullptr;
5286
0
    }
5287
5288
0
    const CPLStringList aosTokens(CSLTokenizeString2(pszBits, ",", 0));
5289
0
    const int nTokens = aosTokens.size();
5290
0
    GTiffDataset::MaskOffset *panMaskOffsetLsb = nullptr;
5291
0
    if (nTokens == 1 || nTokens == nSamplesPerPixel)
5292
0
    {
5293
0
        panMaskOffsetLsb = static_cast<GTiffDataset::MaskOffset *>(
5294
0
            CPLCalloc(nSamplesPerPixel, sizeof(GTiffDataset::MaskOffset)));
5295
0
        for (int i = 0; i < nSamplesPerPixel; ++i)
5296
0
        {
5297
0
            const int nBits = atoi(aosTokens[nTokens == 1 ? 0 : i]);
5298
0
            const int nMaxBits = (nSampleFormat == SAMPLEFORMAT_IEEEFP)
5299
0
                                     ? ((nBitsPerSample == 16)   ? 11 - 1
5300
0
                                        : (nBitsPerSample == 32) ? 23 - 1
5301
0
                                        : (nBitsPerSample == 64) ? 53 - 1
5302
0
                                                                 : 0)
5303
0
                                 : nSampleFormat == SAMPLEFORMAT_INT
5304
0
                                     ? nBitsPerSample - 2
5305
0
                                     : nBitsPerSample - 1;
5306
5307
0
            if (nBits < 0 || nBits > nMaxBits)
5308
0
            {
5309
0
                CPLError(
5310
0
                    CE_Warning, CPLE_AppDefined,
5311
0
                    "DISCARD_LSB ignored: values should be in [0,%d] range",
5312
0
                    nMaxBits);
5313
0
                VSIFree(panMaskOffsetLsb);
5314
0
                return nullptr;
5315
0
            }
5316
0
            panMaskOffsetLsb[i].nMask =
5317
0
                ~((static_cast<uint64_t>(1) << nBits) - 1);
5318
0
            if (nBits > 1)
5319
0
            {
5320
0
                panMaskOffsetLsb[i].nRoundUpBitTest = static_cast<uint64_t>(1)
5321
0
                                                      << (nBits - 1);
5322
0
            }
5323
0
        }
5324
0
    }
5325
0
    else
5326
0
    {
5327
0
        CPLError(CE_Warning, CPLE_AppDefined,
5328
0
                 "DISCARD_LSB ignored: wrong number of components");
5329
0
    }
5330
0
    return panMaskOffsetLsb;
5331
0
}
5332
5333
void GTiffDataset::GetDiscardLsbOption(CSLConstList papszOptions)
5334
0
{
5335
0
    m_panMaskOffsetLsb = ::GetDiscardLsbOption(m_hTIFF, papszOptions);
5336
0
}
5337
5338
/************************************************************************/
5339
/*                             GetProfile()                             */
5340
/************************************************************************/
5341
5342
static GTiffProfile GetProfile(const char *pszProfile)
5343
0
{
5344
0
    GTiffProfile eProfile = GTiffProfile::GDALGEOTIFF;
5345
0
    if (pszProfile != nullptr)
5346
0
    {
5347
0
        if (EQUAL(pszProfile, szPROFILE_BASELINE))
5348
0
            eProfile = GTiffProfile::BASELINE;
5349
0
        else if (EQUAL(pszProfile, szPROFILE_GeoTIFF))
5350
0
            eProfile = GTiffProfile::GEOTIFF;
5351
0
        else if (!EQUAL(pszProfile, szPROFILE_GDALGeoTIFF))
5352
0
        {
5353
0
            CPLError(CE_Warning, CPLE_NotSupported,
5354
0
                     "Unsupported value for PROFILE: %s", pszProfile);
5355
0
        }
5356
0
    }
5357
0
    return eProfile;
5358
0
}
5359
5360
/************************************************************************/
5361
/*                            GTiffCreate()                             */
5362
/*                                                                      */
5363
/*      Shared functionality between GTiffDataset::Create() and         */
5364
/*      GTiffCreateCopy() for creating TIFF file based on a set of      */
5365
/*      options and a configuration.                                    */
5366
/************************************************************************/
5367
5368
TIFF *GTiffDataset::CreateLL(const char *pszFilename, int nXSize, int nYSize,
5369
                             int l_nBands, GDALDataType eType,
5370
                             double dfExtraSpaceForOverviews,
5371
                             int nColorTableMultiplier,
5372
                             CSLConstList papszParamList, VSILFILE **pfpL,
5373
                             CPLString &l_osTmpFilename, bool bCreateCopy,
5374
                             bool &bTileInterleavingOut)
5375
5376
0
{
5377
0
    bTileInterleavingOut = false;
5378
5379
0
    GTiffOneTimeInit();
5380
5381
    /* -------------------------------------------------------------------- */
5382
    /*      Blow on a few errors.                                           */
5383
    /* -------------------------------------------------------------------- */
5384
0
    if (nXSize < 1 || nYSize < 1 || l_nBands < 1)
5385
0
    {
5386
0
        ReportError(
5387
0
            pszFilename, CE_Failure, CPLE_AppDefined,
5388
0
            "Attempt to create %dx%dx%d TIFF file, but width, height and bands"
5389
0
            "must be positive.",
5390
0
            nXSize, nYSize, l_nBands);
5391
5392
0
        return nullptr;
5393
0
    }
5394
5395
0
    if (l_nBands > 65535)
5396
0
    {
5397
0
        ReportError(pszFilename, CE_Failure, CPLE_AppDefined,
5398
0
                    "Attempt to create %dx%dx%d TIFF file, but bands "
5399
0
                    "must be lesser or equal to 65535.",
5400
0
                    nXSize, nYSize, l_nBands);
5401
5402
0
        return nullptr;
5403
0
    }
5404
5405
    /* -------------------------------------------------------------------- */
5406
    /*      Setup values based on options.                                  */
5407
    /* -------------------------------------------------------------------- */
5408
0
    const GTiffProfile eProfile =
5409
0
        GetProfile(CSLFetchNameValue(papszParamList, "PROFILE"));
5410
5411
0
    const bool bTiled = CPLFetchBool(papszParamList, "TILED", false);
5412
5413
0
    int l_nBlockXSize = 0;
5414
0
    if (const char *pszValue = CSLFetchNameValue(papszParamList, "BLOCKXSIZE"))
5415
0
    {
5416
0
        l_nBlockXSize = atoi(pszValue);
5417
0
        if (l_nBlockXSize < 0)
5418
0
        {
5419
0
            ReportError(pszFilename, CE_Failure, CPLE_IllegalArg,
5420
0
                        "Invalid value for BLOCKXSIZE");
5421
0
            return nullptr;
5422
0
        }
5423
0
        if (!bTiled)
5424
0
        {
5425
0
            ReportError(pszFilename, CE_Warning, CPLE_IllegalArg,
5426
0
                        "BLOCKXSIZE can only be used with TILED=YES");
5427
0
        }
5428
0
        else if (l_nBlockXSize % 16 != 0)
5429
0
        {
5430
0
            ReportError(pszFilename, CE_Failure, CPLE_IllegalArg,
5431
0
                        "BLOCKXSIZE must be a multiple of 16");
5432
0
            return nullptr;
5433
0
        }
5434
0
    }
5435
5436
0
    int l_nBlockYSize = 0;
5437
0
    if (const char *pszValue = CSLFetchNameValue(papszParamList, "BLOCKYSIZE"))
5438
0
    {
5439
0
        l_nBlockYSize = atoi(pszValue);
5440
0
        if (l_nBlockYSize < 0)
5441
0
        {
5442
0
            ReportError(pszFilename, CE_Failure, CPLE_IllegalArg,
5443
0
                        "Invalid value for BLOCKYSIZE");
5444
0
            return nullptr;
5445
0
        }
5446
0
        if (bTiled && (l_nBlockYSize % 16 != 0))
5447
0
        {
5448
0
            ReportError(pszFilename, CE_Failure, CPLE_IllegalArg,
5449
0
                        "BLOCKYSIZE must be a multiple of 16");
5450
0
            return nullptr;
5451
0
        }
5452
0
    }
5453
5454
0
    if (bTiled)
5455
0
    {
5456
0
        if (l_nBlockXSize == 0)
5457
0
            l_nBlockXSize = 256;
5458
5459
0
        if (l_nBlockYSize == 0)
5460
0
            l_nBlockYSize = 256;
5461
0
    }
5462
5463
0
    int nPlanar = 0;
5464
5465
    // Hidden @TILE_INTERLEAVE=YES parameter used by the COG driver
5466
0
    if (bCreateCopy && CPLTestBool(CSLFetchNameValueDef(
5467
0
                           papszParamList, "@TILE_INTERLEAVE", "NO")))
5468
0
    {
5469
0
        bTileInterleavingOut = true;
5470
0
        nPlanar = PLANARCONFIG_SEPARATE;
5471
0
    }
5472
0
    else
5473
0
    {
5474
0
        if (const char *pszValue =
5475
0
                CSLFetchNameValue(papszParamList, "INTERLEAVE"))
5476
0
        {
5477
0
            if (EQUAL(pszValue, "PIXEL"))
5478
0
                nPlanar = PLANARCONFIG_CONTIG;
5479
0
            else if (EQUAL(pszValue, "BAND"))
5480
0
            {
5481
0
                nPlanar = PLANARCONFIG_SEPARATE;
5482
0
            }
5483
0
            else if (EQUAL(pszValue, "BAND"))
5484
0
            {
5485
0
                nPlanar = PLANARCONFIG_SEPARATE;
5486
0
            }
5487
0
            else
5488
0
            {
5489
0
                ReportError(
5490
0
                    pszFilename, CE_Failure, CPLE_IllegalArg,
5491
0
                    "INTERLEAVE=%s unsupported, value must be PIXEL or BAND.",
5492
0
                    pszValue);
5493
0
                return nullptr;
5494
0
            }
5495
0
        }
5496
0
        else
5497
0
        {
5498
0
            nPlanar = PLANARCONFIG_CONTIG;
5499
0
        }
5500
0
    }
5501
5502
0
    int l_nCompression = COMPRESSION_NONE;
5503
0
    if (const char *pszValue = CSLFetchNameValue(papszParamList, "COMPRESS"))
5504
0
    {
5505
0
        l_nCompression = GTIFFGetCompressionMethod(pszValue, "COMPRESS");
5506
0
        if (l_nCompression < 0)
5507
0
            return nullptr;
5508
0
    }
5509
5510
0
    constexpr int JPEG_MAX_DIMENSION = 65500;  // Defined in jpeglib.h
5511
0
    constexpr int WEBP_MAX_DIMENSION = 16383;
5512
5513
0
    const struct
5514
0
    {
5515
0
        int nCodecID;
5516
0
        const char *pszCodecName;
5517
0
        int nMaxDim;
5518
0
    } asLimitations[] = {
5519
0
        {COMPRESSION_JPEG, "JPEG", JPEG_MAX_DIMENSION},
5520
0
        {COMPRESSION_WEBP, "WEBP", WEBP_MAX_DIMENSION},
5521
0
    };
5522
5523
0
    for (const auto &sLimitation : asLimitations)
5524
0
    {
5525
0
        if (l_nCompression == sLimitation.nCodecID && !bTiled &&
5526
0
            nXSize > sLimitation.nMaxDim)
5527
0
        {
5528
0
            ReportError(
5529
0
                pszFilename, CE_Failure, CPLE_IllegalArg,
5530
0
                "COMPRESS=%s is only compatible of un-tiled images whose "
5531
0
                "width is lesser or equal to %d pixels. "
5532
0
                "To overcome this limitation, set the TILED=YES creation "
5533
0
                "option.",
5534
0
                sLimitation.pszCodecName, sLimitation.nMaxDim);
5535
0
            return nullptr;
5536
0
        }
5537
0
        else if (l_nCompression == sLimitation.nCodecID && bTiled &&
5538
0
                 l_nBlockXSize > sLimitation.nMaxDim)
5539
0
        {
5540
0
            ReportError(pszFilename, CE_Failure, CPLE_IllegalArg,
5541
0
                        "COMPRESS=%s is only compatible of tiled images whose "
5542
0
                        "BLOCKXSIZE is lesser or equal to %d pixels.",
5543
0
                        sLimitation.pszCodecName, sLimitation.nMaxDim);
5544
0
            return nullptr;
5545
0
        }
5546
0
        else if (l_nCompression == sLimitation.nCodecID &&
5547
0
                 l_nBlockYSize > sLimitation.nMaxDim)
5548
0
        {
5549
0
            ReportError(pszFilename, CE_Failure, CPLE_IllegalArg,
5550
0
                        "COMPRESS=%s is only compatible of images whose "
5551
0
                        "BLOCKYSIZE is lesser or equal to %d pixels. "
5552
0
                        "To overcome this limitation, set the TILED=YES "
5553
0
                        "creation option",
5554
0
                        sLimitation.pszCodecName, sLimitation.nMaxDim);
5555
0
            return nullptr;
5556
0
        }
5557
0
    }
5558
5559
    /* -------------------------------------------------------------------- */
5560
    /*      How many bits per sample?  We have a special case if NBITS      */
5561
    /*      specified for GDT_UInt8, GDT_UInt16, GDT_UInt32.                 */
5562
    /* -------------------------------------------------------------------- */
5563
0
    int l_nBitsPerSample = GDALGetDataTypeSizeBits(eType);
5564
0
    if (CSLFetchNameValue(papszParamList, "NBITS") != nullptr)
5565
0
    {
5566
0
        int nMinBits = 0;
5567
0
        int nMaxBits = 0;
5568
0
        l_nBitsPerSample = atoi(CSLFetchNameValue(papszParamList, "NBITS"));
5569
0
        if (eType == GDT_UInt8)
5570
0
        {
5571
0
            nMinBits = 1;
5572
0
            nMaxBits = 8;
5573
0
        }
5574
0
        else if (eType == GDT_UInt16)
5575
0
        {
5576
0
            nMinBits = 9;
5577
0
            nMaxBits = 16;
5578
0
        }
5579
0
        else if (eType == GDT_UInt32)
5580
0
        {
5581
0
            nMinBits = 17;
5582
0
            nMaxBits = 32;
5583
0
        }
5584
0
        else if (eType == GDT_Float32)
5585
0
        {
5586
0
            if (l_nBitsPerSample != 16 && l_nBitsPerSample != 32)
5587
0
            {
5588
0
                ReportError(pszFilename, CE_Warning, CPLE_NotSupported,
5589
0
                            "Only NBITS=16 is supported for data type Float32");
5590
0
                l_nBitsPerSample = GDALGetDataTypeSizeBits(eType);
5591
0
            }
5592
0
        }
5593
0
        else
5594
0
        {
5595
0
            ReportError(pszFilename, CE_Warning, CPLE_NotSupported,
5596
0
                        "NBITS is not supported for data type %s",
5597
0
                        GDALGetDataTypeName(eType));
5598
0
            l_nBitsPerSample = GDALGetDataTypeSizeBits(eType);
5599
0
        }
5600
5601
0
        if (nMinBits != 0)
5602
0
        {
5603
0
            if (l_nBitsPerSample < nMinBits)
5604
0
            {
5605
0
                ReportError(
5606
0
                    pszFilename, CE_Warning, CPLE_AppDefined,
5607
0
                    "NBITS=%d is invalid for data type %s. Using NBITS=%d",
5608
0
                    l_nBitsPerSample, GDALGetDataTypeName(eType), nMinBits);
5609
0
                l_nBitsPerSample = nMinBits;
5610
0
            }
5611
0
            else if (l_nBitsPerSample > nMaxBits)
5612
0
            {
5613
0
                ReportError(
5614
0
                    pszFilename, CE_Warning, CPLE_AppDefined,
5615
0
                    "NBITS=%d is invalid for data type %s. Using NBITS=%d",
5616
0
                    l_nBitsPerSample, GDALGetDataTypeName(eType), nMaxBits);
5617
0
                l_nBitsPerSample = nMaxBits;
5618
0
            }
5619
0
        }
5620
0
    }
5621
5622
#ifdef HAVE_JXL
5623
    if ((l_nCompression == COMPRESSION_JXL ||
5624
         l_nCompression == COMPRESSION_JXL_DNG_1_7) &&
5625
        eType != GDT_Float16 && eType != GDT_Float32)
5626
    {
5627
        // Reflects tif_jxl's GetJXLDataType()
5628
        if (eType != GDT_UInt8 && eType != GDT_UInt16)
5629
        {
5630
            ReportError(pszFilename, CE_Failure, CPLE_NotSupported,
5631
                        "Data type %s not supported for JXL compression. Only "
5632
                        "Byte, UInt16, Float16, Float32 are supported",
5633
                        GDALGetDataTypeName(eType));
5634
            return nullptr;
5635
        }
5636
5637
        const struct
5638
        {
5639
            GDALDataType eDT;
5640
            int nBitsPerSample;
5641
        } asSupportedDTBitsPerSample[] = {
5642
            {GDT_UInt8, 8},
5643
            {GDT_UInt16, 16},
5644
        };
5645
5646
        for (const auto &sSupportedDTBitsPerSample : asSupportedDTBitsPerSample)
5647
        {
5648
            if (eType == sSupportedDTBitsPerSample.eDT &&
5649
                l_nBitsPerSample != sSupportedDTBitsPerSample.nBitsPerSample)
5650
            {
5651
                ReportError(
5652
                    pszFilename, CE_Failure, CPLE_NotSupported,
5653
                    "Bits per sample=%d not supported for JXL compression. "
5654
                    "Only %d is supported for %s data type.",
5655
                    l_nBitsPerSample, sSupportedDTBitsPerSample.nBitsPerSample,
5656
                    GDALGetDataTypeName(eType));
5657
                return nullptr;
5658
            }
5659
        }
5660
    }
5661
#endif
5662
5663
0
    int nPredictor = PREDICTOR_NONE;
5664
0
    const char *pszPredictor = CSLFetchNameValue(papszParamList, "PREDICTOR");
5665
0
    if (pszPredictor)
5666
0
    {
5667
0
        nPredictor = atoi(pszPredictor);
5668
0
    }
5669
5670
0
    if (nPredictor != PREDICTOR_NONE &&
5671
0
        l_nCompression != COMPRESSION_ADOBE_DEFLATE &&
5672
0
        l_nCompression != COMPRESSION_LZW &&
5673
0
        l_nCompression != COMPRESSION_LZMA &&
5674
0
        l_nCompression != COMPRESSION_ZSTD)
5675
0
    {
5676
0
        ReportError(pszFilename, CE_Warning, CPLE_NotSupported,
5677
0
                    "PREDICTOR option is ignored for COMPRESS=%s. "
5678
0
                    "Only valid for DEFLATE, LZW, LZMA or ZSTD",
5679
0
                    CSLFetchNameValueDef(papszParamList, "COMPRESS", "NONE"));
5680
0
    }
5681
5682
    // Do early checks as libtiff will only error out when starting to write.
5683
0
    else if (nPredictor != PREDICTOR_NONE &&
5684
0
             CPLTestBool(
5685
0
                 CPLGetConfigOption("GDAL_GTIFF_PREDICTOR_CHECKS", "YES")))
5686
0
    {
5687
0
#if (TIFFLIB_VERSION > 20210416) || defined(INTERNAL_LIBTIFF)
5688
0
#define HAVE_PREDICTOR_2_FOR_64BIT
5689
0
#endif
5690
0
        if (nPredictor == 2)
5691
0
        {
5692
0
            if (l_nBitsPerSample != 8 && l_nBitsPerSample != 16 &&
5693
0
                l_nBitsPerSample != 32
5694
0
#ifdef HAVE_PREDICTOR_2_FOR_64BIT
5695
0
                && l_nBitsPerSample != 64
5696
0
#endif
5697
0
            )
5698
0
            {
5699
#if !defined(HAVE_PREDICTOR_2_FOR_64BIT)
5700
                if (l_nBitsPerSample == 64)
5701
                {
5702
                    ReportError(pszFilename, CE_Failure, CPLE_AppDefined,
5703
                                "PREDICTOR=2 is supported on 64 bit samples "
5704
                                "starting with libtiff > 4.3.0.");
5705
                }
5706
                else
5707
#endif
5708
0
                {
5709
0
                    const int nBITSHint = (l_nBitsPerSample < 8)    ? 8
5710
0
                                          : (l_nBitsPerSample < 16) ? 16
5711
0
                                          : (l_nBitsPerSample < 32) ? 32
5712
0
                                                                    : 64;
5713
0
                    ReportError(pszFilename, CE_Failure, CPLE_AppDefined,
5714
0
#ifdef HAVE_PREDICTOR_2_FOR_64BIT
5715
0
                                "PREDICTOR=2 is only supported with 8/16/32/64 "
5716
0
                                "bit samples. You can specify the NBITS=%d "
5717
0
                                "creation option to promote to the closest "
5718
0
                                "supported bits per sample value.",
5719
#else
5720
                                "PREDICTOR=2 is only supported with 8/16/32 "
5721
                                "bit samples. You can specify the NBITS=%d "
5722
                                "creation option to promote to the closest "
5723
                                "supported bits per sample value.",
5724
#endif
5725
0
                                nBITSHint);
5726
0
                }
5727
0
                return nullptr;
5728
0
            }
5729
0
        }
5730
0
        else if (nPredictor == 3)
5731
0
        {
5732
0
            if (eType != GDT_Float32 && eType != GDT_Float64)
5733
0
            {
5734
0
                ReportError(
5735
0
                    pszFilename, CE_Failure, CPLE_AppDefined,
5736
0
                    "PREDICTOR=3 is only supported with Float32 or Float64.");
5737
0
                return nullptr;
5738
0
            }
5739
0
        }
5740
0
        else
5741
0
        {
5742
0
            ReportError(pszFilename, CE_Failure, CPLE_AppDefined,
5743
0
                        "PREDICTOR=%s is not supported.", pszPredictor);
5744
0
            return nullptr;
5745
0
        }
5746
0
    }
5747
5748
0
    const int l_nZLevel = GTiffGetZLevel(papszParamList);
5749
0
    const int l_nLZMAPreset = GTiffGetLZMAPreset(papszParamList);
5750
0
    const int l_nZSTDLevel = GTiffGetZSTDPreset(papszParamList);
5751
0
    const int l_nWebPLevel = GTiffGetWebPLevel(papszParamList);
5752
0
    const bool l_bWebPLossless = GTiffGetWebPLossless(papszParamList);
5753
0
    const int l_nJpegQuality = GTiffGetJpegQuality(papszParamList);
5754
0
    const int l_nJpegTablesMode = GTiffGetJpegTablesMode(papszParamList);
5755
0
    const double l_dfMaxZError = GTiffGetLERCMaxZError(papszParamList);
5756
#if HAVE_JXL
5757
    bool bJXLLosslessSpecified = false;
5758
    const bool l_bJXLLossless =
5759
        GTiffGetJXLLossless(papszParamList, &bJXLLosslessSpecified);
5760
    const uint32_t l_nJXLEffort = GTiffGetJXLEffort(papszParamList);
5761
    bool bJXLDistanceSpecified = false;
5762
    const float l_fJXLDistance =
5763
        GTiffGetJXLDistance(papszParamList, &bJXLDistanceSpecified);
5764
    if (bJXLDistanceSpecified && l_bJXLLossless)
5765
    {
5766
        ReportError(pszFilename, CE_Warning, CPLE_AppDefined,
5767
                    "JXL_DISTANCE creation option is ignored, given %s "
5768
                    "JXL_LOSSLESS=YES",
5769
                    bJXLLosslessSpecified ? "(explicit)" : "(implicit)");
5770
    }
5771
    bool bJXLAlphaDistanceSpecified = false;
5772
    const float l_fJXLAlphaDistance =
5773
        GTiffGetJXLAlphaDistance(papszParamList, &bJXLAlphaDistanceSpecified);
5774
    if (bJXLAlphaDistanceSpecified && l_bJXLLossless)
5775
    {
5776
        ReportError(pszFilename, CE_Warning, CPLE_AppDefined,
5777
                    "JXL_ALPHA_DISTANCE creation option is ignored, given %s "
5778
                    "JXL_LOSSLESS=YES",
5779
                    bJXLLosslessSpecified ? "(explicit)" : "(implicit)");
5780
    }
5781
#endif
5782
    /* -------------------------------------------------------------------- */
5783
    /*      Streaming related code                                          */
5784
    /* -------------------------------------------------------------------- */
5785
0
    const CPLString osOriFilename(pszFilename);
5786
0
    bool bStreaming = strcmp(pszFilename, "/vsistdout/") == 0 ||
5787
0
                      CPLFetchBool(papszParamList, "STREAMABLE_OUTPUT", false);
5788
0
#ifdef S_ISFIFO
5789
0
    if (!bStreaming)
5790
0
    {
5791
0
        VSIStatBufL sStat;
5792
0
        if (VSIStatExL(pszFilename, &sStat,
5793
0
                       VSI_STAT_EXISTS_FLAG | VSI_STAT_NATURE_FLAG) == 0 &&
5794
0
            S_ISFIFO(sStat.st_mode))
5795
0
        {
5796
0
            bStreaming = true;
5797
0
        }
5798
0
    }
5799
0
#endif
5800
0
    if (bStreaming && !EQUAL("NONE", CSLFetchNameValueDef(papszParamList,
5801
0
                                                          "COMPRESS", "NONE")))
5802
0
    {
5803
0
        ReportError(pszFilename, CE_Failure, CPLE_NotSupported,
5804
0
                    "Streaming only supported to uncompressed TIFF");
5805
0
        return nullptr;
5806
0
    }
5807
0
    if (bStreaming && CPLFetchBool(papszParamList, "SPARSE_OK", false))
5808
0
    {
5809
0
        ReportError(pszFilename, CE_Failure, CPLE_NotSupported,
5810
0
                    "Streaming not supported with SPARSE_OK");
5811
0
        return nullptr;
5812
0
    }
5813
0
    const bool bCopySrcOverviews =
5814
0
        CPLFetchBool(papszParamList, "COPY_SRC_OVERVIEWS", false);
5815
0
    if (bStreaming && bCopySrcOverviews)
5816
0
    {
5817
0
        ReportError(pszFilename, CE_Failure, CPLE_NotSupported,
5818
0
                    "Streaming not supported with COPY_SRC_OVERVIEWS");
5819
0
        return nullptr;
5820
0
    }
5821
0
    if (bStreaming)
5822
0
    {
5823
0
        l_osTmpFilename = VSIMemGenerateHiddenFilename("vsistdout.tif");
5824
0
        pszFilename = l_osTmpFilename.c_str();
5825
0
    }
5826
5827
    /* -------------------------------------------------------------------- */
5828
    /*      Compute the uncompressed size.                                  */
5829
    /* -------------------------------------------------------------------- */
5830
0
    const unsigned nTileXCount =
5831
0
        bTiled ? DIV_ROUND_UP(nXSize, l_nBlockXSize) : 0;
5832
0
    const unsigned nTileYCount =
5833
0
        bTiled ? DIV_ROUND_UP(nYSize, l_nBlockYSize) : 0;
5834
0
    const double dfUncompressedImageSize =
5835
0
        (bTiled ? (static_cast<double>(nTileXCount) * nTileYCount *
5836
0
                   l_nBlockXSize * l_nBlockYSize)
5837
0
                : (nXSize * static_cast<double>(nYSize))) *
5838
0
            l_nBands * GDALGetDataTypeSizeBytes(eType) +
5839
0
        dfExtraSpaceForOverviews;
5840
5841
    /* -------------------------------------------------------------------- */
5842
    /*      Should the file be created as a bigtiff file?                   */
5843
    /* -------------------------------------------------------------------- */
5844
0
    const char *pszBIGTIFF = CSLFetchNameValue(papszParamList, "BIGTIFF");
5845
5846
0
    if (pszBIGTIFF == nullptr)
5847
0
        pszBIGTIFF = "IF_NEEDED";
5848
5849
0
    bool bCreateBigTIFF = false;
5850
0
    if (EQUAL(pszBIGTIFF, "IF_NEEDED"))
5851
0
    {
5852
0
        if (l_nCompression == COMPRESSION_NONE &&
5853
0
            dfUncompressedImageSize > 4200000000.0)
5854
0
            bCreateBigTIFF = true;
5855
0
    }
5856
0
    else if (EQUAL(pszBIGTIFF, "IF_SAFER"))
5857
0
    {
5858
0
        if (dfUncompressedImageSize > 2000000000.0)
5859
0
            bCreateBigTIFF = true;
5860
0
    }
5861
0
    else
5862
0
    {
5863
0
        bCreateBigTIFF = CPLTestBool(pszBIGTIFF);
5864
0
        if (!bCreateBigTIFF && l_nCompression == COMPRESSION_NONE &&
5865
0
            dfUncompressedImageSize > 4200000000.0)
5866
0
        {
5867
0
            ReportError(pszFilename, CE_Failure, CPLE_NotSupported,
5868
0
                        "The TIFF file will be larger than 4GB, so BigTIFF is "
5869
0
                        "necessary.  Creation failed.");
5870
0
            return nullptr;
5871
0
        }
5872
0
    }
5873
5874
0
    if (bCreateBigTIFF)
5875
0
        CPLDebug("GTiff", "File being created as a BigTIFF.");
5876
5877
    /* -------------------------------------------------------------------- */
5878
    /*      Sanity check.                                                   */
5879
    /* -------------------------------------------------------------------- */
5880
0
    if (bTiled)
5881
0
    {
5882
        // libtiff implementation limitation
5883
0
        if (nTileXCount > 0x80000000U / (bCreateBigTIFF ? 8 : 4) / nTileYCount)
5884
0
        {
5885
0
            ReportError(pszFilename, CE_Failure, CPLE_NotSupported,
5886
0
                        "File too large regarding tile size. This would result "
5887
0
                        "in a file with tile arrays larger than 2GB");
5888
0
            return nullptr;
5889
0
        }
5890
0
    }
5891
5892
    /* -------------------------------------------------------------------- */
5893
    /*      Check free space (only for big, non sparse)                     */
5894
    /* -------------------------------------------------------------------- */
5895
0
    const double dfLikelyFloorOfFinalSize =
5896
0
        l_nCompression == COMPRESSION_NONE
5897
0
            ? dfUncompressedImageSize
5898
0
            :
5899
            /* For compressed, we target 1% as the most optimistic reduction factor! */
5900
0
            0.01 * dfUncompressedImageSize;
5901
0
    if (dfLikelyFloorOfFinalSize >= 1e9 &&
5902
0
        !CPLFetchBool(papszParamList, "SPARSE_OK", false) &&
5903
0
        osOriFilename != "/vsistdout/" &&
5904
0
        osOriFilename != "/vsistdout_redirect/" &&
5905
0
        CPLTestBool(CPLGetConfigOption("CHECK_DISK_FREE_SPACE", "TRUE")))
5906
0
    {
5907
0
        const GIntBig nFreeDiskSpace =
5908
0
            VSIGetDiskFreeSpace(CPLGetDirnameSafe(pszFilename).c_str());
5909
0
        if (nFreeDiskSpace >= 0 && nFreeDiskSpace < dfLikelyFloorOfFinalSize)
5910
0
        {
5911
0
            ReportError(
5912
0
                pszFilename, CE_Failure, CPLE_FileIO,
5913
0
                "Free disk space available is %s, "
5914
0
                "whereas %s are %s necessary. "
5915
0
                "You can disable this check by defining the "
5916
0
                "CHECK_DISK_FREE_SPACE configuration option to FALSE.",
5917
0
                CPLFormatReadableFileSize(static_cast<uint64_t>(nFreeDiskSpace))
5918
0
                    .c_str(),
5919
0
                CPLFormatReadableFileSize(dfLikelyFloorOfFinalSize).c_str(),
5920
0
                l_nCompression == COMPRESSION_NONE
5921
0
                    ? "at least"
5922
0
                    : "likely at least (probably more)");
5923
0
            return nullptr;
5924
0
        }
5925
0
    }
5926
5927
    /* -------------------------------------------------------------------- */
5928
    /*      Check if the user wishes a particular endianness                */
5929
    /* -------------------------------------------------------------------- */
5930
5931
0
    int eEndianness = ENDIANNESS_NATIVE;
5932
0
    const char *pszEndianness = CSLFetchNameValue(papszParamList, "ENDIANNESS");
5933
0
    if (pszEndianness == nullptr)
5934
0
        pszEndianness = CPLGetConfigOption("GDAL_TIFF_ENDIANNESS", nullptr);
5935
0
    if (pszEndianness != nullptr)
5936
0
    {
5937
0
        if (EQUAL(pszEndianness, "LITTLE"))
5938
0
        {
5939
0
            eEndianness = ENDIANNESS_LITTLE;
5940
0
        }
5941
0
        else if (EQUAL(pszEndianness, "BIG"))
5942
0
        {
5943
0
            eEndianness = ENDIANNESS_BIG;
5944
0
        }
5945
0
        else if (EQUAL(pszEndianness, "INVERTED"))
5946
0
        {
5947
0
#ifdef CPL_LSB
5948
0
            eEndianness = ENDIANNESS_BIG;
5949
#else
5950
            eEndianness = ENDIANNESS_LITTLE;
5951
#endif
5952
0
        }
5953
0
        else if (!EQUAL(pszEndianness, "NATIVE"))
5954
0
        {
5955
0
            ReportError(pszFilename, CE_Warning, CPLE_NotSupported,
5956
0
                        "ENDIANNESS=%s not supported. Defaulting to NATIVE",
5957
0
                        pszEndianness);
5958
0
        }
5959
0
    }
5960
5961
    /* -------------------------------------------------------------------- */
5962
    /*      Try opening the dataset.                                        */
5963
    /* -------------------------------------------------------------------- */
5964
5965
0
    const bool bAppend =
5966
0
        CPLFetchBool(papszParamList, "APPEND_SUBDATASET", false);
5967
5968
0
    char szOpeningFlag[5] = {};
5969
0
    strcpy(szOpeningFlag, bAppend ? "r+" : "w+");
5970
0
    if (bCreateBigTIFF)
5971
0
        strcat(szOpeningFlag, "8");
5972
0
    if (eEndianness == ENDIANNESS_BIG)
5973
0
        strcat(szOpeningFlag, "b");
5974
0
    else if (eEndianness == ENDIANNESS_LITTLE)
5975
0
        strcat(szOpeningFlag, "l");
5976
5977
0
    VSIErrorReset();
5978
0
    const bool bOnlyVisibleAtCloseTime = CPLTestBool(CSLFetchNameValueDef(
5979
0
        papszParamList, "@CREATE_ONLY_VISIBLE_AT_CLOSE_TIME", "NO"));
5980
0
    const bool bSuppressASAP = CPLTestBool(
5981
0
        CSLFetchNameValueDef(papszParamList, "@SUPPRESS_ASAP", "NO"));
5982
0
    auto l_fpL =
5983
0
        (bOnlyVisibleAtCloseTime || bSuppressASAP) && !bAppend
5984
0
            ? VSIFileManager::GetHandler(pszFilename)
5985
0
                  ->CreateOnlyVisibleAtCloseTime(pszFilename, true, nullptr)
5986
0
                  .release()
5987
0
            : VSIFilesystemHandler::OpenStatic(pszFilename,
5988
0
                                               bAppend ? "r+b" : "w+b", true)
5989
0
                  .release();
5990
0
    if (l_fpL == nullptr)
5991
0
    {
5992
0
        VSIToCPLErrorWithMsg(CE_Failure, CPLE_OpenFailed,
5993
0
                             std::string("Attempt to create new tiff file `")
5994
0
                                 .append(pszFilename)
5995
0
                                 .append("' failed")
5996
0
                                 .c_str());
5997
0
        return nullptr;
5998
0
    }
5999
6000
0
    if (bSuppressASAP)
6001
0
    {
6002
0
        l_fpL->CancelCreation();
6003
0
    }
6004
6005
0
    TIFF *l_hTIFF = VSI_TIFFOpen(pszFilename, szOpeningFlag, l_fpL);
6006
0
    if (l_hTIFF == nullptr)
6007
0
    {
6008
0
        if (CPLGetLastErrorNo() == 0)
6009
0
            CPLError(CE_Failure, CPLE_OpenFailed,
6010
0
                     "Attempt to create new tiff file `%s' "
6011
0
                     "failed in XTIFFOpen().",
6012
0
                     pszFilename);
6013
0
        l_fpL->CancelCreation();
6014
0
        CPL_IGNORE_RET_VAL(VSIFCloseL(l_fpL));
6015
0
        return nullptr;
6016
0
    }
6017
6018
0
    if (bAppend)
6019
0
    {
6020
#if !(defined(INTERNAL_LIBTIFF) || TIFFLIB_VERSION > 20240911)
6021
        // This is a bit of a hack to cause (*tif->tif_cleanup)(tif); to be
6022
        // called. See https://trac.osgeo.org/gdal/ticket/2055
6023
        // Fixed in libtiff > 4.7.0
6024
        TIFFSetField(l_hTIFF, TIFFTAG_COMPRESSION, COMPRESSION_NONE);
6025
        TIFFFreeDirectory(l_hTIFF);
6026
#endif
6027
0
        TIFFCreateDirectory(l_hTIFF);
6028
0
    }
6029
6030
    /* -------------------------------------------------------------------- */
6031
    /*      Do we have a custom pixel type (just used for signed byte now). */
6032
    /* -------------------------------------------------------------------- */
6033
0
    const char *pszPixelType = CSLFetchNameValue(papszParamList, "PIXELTYPE");
6034
0
    if (pszPixelType == nullptr)
6035
0
        pszPixelType = "";
6036
0
    if (eType == GDT_UInt8 && EQUAL(pszPixelType, "SIGNEDBYTE"))
6037
0
    {
6038
0
        CPLError(CE_Warning, CPLE_AppDefined,
6039
0
                 "Using PIXELTYPE=SIGNEDBYTE with Byte data type is deprecated "
6040
0
                 "(but still works). "
6041
0
                 "Using Int8 data type instead is now recommended.");
6042
0
    }
6043
6044
    /* -------------------------------------------------------------------- */
6045
    /*      Setup some standard flags.                                      */
6046
    /* -------------------------------------------------------------------- */
6047
0
    TIFFSetField(l_hTIFF, TIFFTAG_IMAGEWIDTH, nXSize);
6048
0
    TIFFSetField(l_hTIFF, TIFFTAG_IMAGELENGTH, nYSize);
6049
0
    TIFFSetField(l_hTIFF, TIFFTAG_BITSPERSAMPLE, l_nBitsPerSample);
6050
6051
0
    uint16_t l_nSampleFormat = 0;
6052
0
    if ((eType == GDT_UInt8 && EQUAL(pszPixelType, "SIGNEDBYTE")) ||
6053
0
        eType == GDT_Int8 || eType == GDT_Int16 || eType == GDT_Int32 ||
6054
0
        eType == GDT_Int64)
6055
0
        l_nSampleFormat = SAMPLEFORMAT_INT;
6056
0
    else if (eType == GDT_CInt16 || eType == GDT_CInt32)
6057
0
        l_nSampleFormat = SAMPLEFORMAT_COMPLEXINT;
6058
0
    else if (eType == GDT_Float16 || eType == GDT_Float32 ||
6059
0
             eType == GDT_Float64)
6060
0
        l_nSampleFormat = SAMPLEFORMAT_IEEEFP;
6061
0
    else if (eType == GDT_CFloat16 || eType == GDT_CFloat32 ||
6062
0
             eType == GDT_CFloat64)
6063
0
        l_nSampleFormat = SAMPLEFORMAT_COMPLEXIEEEFP;
6064
0
    else
6065
0
        l_nSampleFormat = SAMPLEFORMAT_UINT;
6066
6067
0
    TIFFSetField(l_hTIFF, TIFFTAG_SAMPLEFORMAT, l_nSampleFormat);
6068
0
    TIFFSetField(l_hTIFF, TIFFTAG_SAMPLESPERPIXEL, l_nBands);
6069
0
    TIFFSetField(l_hTIFF, TIFFTAG_PLANARCONFIG, nPlanar);
6070
6071
    /* -------------------------------------------------------------------- */
6072
    /*      Setup Photometric Interpretation. Take this value from the user */
6073
    /*      passed option or guess correct value otherwise.                 */
6074
    /* -------------------------------------------------------------------- */
6075
0
    int nSamplesAccountedFor = 1;
6076
0
    bool bForceColorTable = false;
6077
6078
0
    if (const char *pszValue = CSLFetchNameValue(papszParamList, "PHOTOMETRIC"))
6079
0
    {
6080
0
        if (EQUAL(pszValue, "MINISBLACK"))
6081
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_MINISBLACK);
6082
0
        else if (EQUAL(pszValue, "MINISWHITE"))
6083
0
        {
6084
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_MINISWHITE);
6085
0
        }
6086
0
        else if (EQUAL(pszValue, "PALETTE"))
6087
0
        {
6088
0
            if (eType == GDT_UInt8 || eType == GDT_UInt16)
6089
0
            {
6090
0
                TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_PALETTE);
6091
0
                nSamplesAccountedFor = 1;
6092
0
                bForceColorTable = true;
6093
0
            }
6094
0
            else
6095
0
            {
6096
0
                ReportError(
6097
0
                    pszFilename, CE_Warning, CPLE_AppDefined,
6098
0
                    "PHOTOMETRIC=PALETTE only compatible with Byte or UInt16");
6099
0
            }
6100
0
        }
6101
0
        else if (EQUAL(pszValue, "RGB"))
6102
0
        {
6103
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_RGB);
6104
0
            nSamplesAccountedFor = 3;
6105
0
        }
6106
0
        else if (EQUAL(pszValue, "CMYK"))
6107
0
        {
6108
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_SEPARATED);
6109
0
            nSamplesAccountedFor = 4;
6110
0
        }
6111
0
        else if (EQUAL(pszValue, "YCBCR"))
6112
0
        {
6113
            // Because of subsampling, setting YCBCR without JPEG compression
6114
            // leads to a crash currently. Would need to make
6115
            // GTiffRasterBand::IWriteBlock() aware of subsampling so that it
6116
            // doesn't overrun buffer size returned by libtiff.
6117
0
            if (l_nCompression != COMPRESSION_JPEG)
6118
0
            {
6119
0
                ReportError(
6120
0
                    pszFilename, CE_Failure, CPLE_NotSupported,
6121
0
                    "Currently, PHOTOMETRIC=YCBCR requires COMPRESS=JPEG");
6122
0
                XTIFFClose(l_hTIFF);
6123
0
                l_fpL->CancelCreation();
6124
0
                CPL_IGNORE_RET_VAL(VSIFCloseL(l_fpL));
6125
0
                return nullptr;
6126
0
            }
6127
6128
0
            if (nPlanar == PLANARCONFIG_SEPARATE)
6129
0
            {
6130
0
                ReportError(pszFilename, CE_Failure, CPLE_NotSupported,
6131
0
                            "PHOTOMETRIC=YCBCR requires INTERLEAVE=PIXEL");
6132
0
                XTIFFClose(l_hTIFF);
6133
0
                l_fpL->CancelCreation();
6134
0
                CPL_IGNORE_RET_VAL(VSIFCloseL(l_fpL));
6135
0
                return nullptr;
6136
0
            }
6137
6138
            // YCBCR strictly requires 3 bands. Not less, not more Issue an
6139
            // explicit error message as libtiff one is a bit cryptic:
6140
            // TIFFVStripSize64:Invalid td_samplesperpixel value.
6141
0
            if (l_nBands != 3)
6142
0
            {
6143
0
                ReportError(
6144
0
                    pszFilename, CE_Failure, CPLE_NotSupported,
6145
0
                    "PHOTOMETRIC=YCBCR not supported on a %d-band raster: "
6146
0
                    "only compatible of a 3-band (RGB) raster",
6147
0
                    l_nBands);
6148
0
                XTIFFClose(l_hTIFF);
6149
0
                l_fpL->CancelCreation();
6150
0
                CPL_IGNORE_RET_VAL(VSIFCloseL(l_fpL));
6151
0
                return nullptr;
6152
0
            }
6153
6154
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_YCBCR);
6155
0
            nSamplesAccountedFor = 3;
6156
6157
            // Explicitly register the subsampling so that JPEGFixupTags
6158
            // is a no-op (helps for cloud optimized geotiffs)
6159
0
            TIFFSetField(l_hTIFF, TIFFTAG_YCBCRSUBSAMPLING, 2, 2);
6160
0
        }
6161
0
        else if (EQUAL(pszValue, "CIELAB"))
6162
0
        {
6163
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_CIELAB);
6164
0
            nSamplesAccountedFor = 3;
6165
0
        }
6166
0
        else if (EQUAL(pszValue, "ICCLAB"))
6167
0
        {
6168
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_ICCLAB);
6169
0
            nSamplesAccountedFor = 3;
6170
0
        }
6171
0
        else if (EQUAL(pszValue, "ITULAB"))
6172
0
        {
6173
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_ITULAB);
6174
0
            nSamplesAccountedFor = 3;
6175
0
        }
6176
0
        else
6177
0
        {
6178
0
            ReportError(pszFilename, CE_Warning, CPLE_IllegalArg,
6179
0
                        "PHOTOMETRIC=%s value not recognised, ignoring.  "
6180
0
                        "Set the Photometric Interpretation as MINISBLACK.",
6181
0
                        pszValue);
6182
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_MINISBLACK);
6183
0
        }
6184
6185
0
        if (l_nBands < nSamplesAccountedFor)
6186
0
        {
6187
0
            ReportError(pszFilename, CE_Warning, CPLE_IllegalArg,
6188
0
                        "PHOTOMETRIC=%s value does not correspond to number "
6189
0
                        "of bands (%d), ignoring.  "
6190
0
                        "Set the Photometric Interpretation as MINISBLACK.",
6191
0
                        pszValue, l_nBands);
6192
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_MINISBLACK);
6193
0
        }
6194
0
    }
6195
0
    else
6196
0
    {
6197
        // If image contains 3 or 4 bands and datatype is Byte then we will
6198
        // assume it is RGB. In all other cases assume it is MINISBLACK.
6199
0
        if (l_nBands == 3 && eType == GDT_UInt8)
6200
0
        {
6201
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_RGB);
6202
0
            nSamplesAccountedFor = 3;
6203
0
        }
6204
0
        else if (l_nBands == 4 && eType == GDT_UInt8)
6205
0
        {
6206
0
            uint16_t v[1] = {
6207
0
                GTiffGetAlphaValue(CSLFetchNameValue(papszParamList, "ALPHA"),
6208
0
                                   DEFAULT_ALPHA_TYPE)};
6209
6210
0
            TIFFSetField(l_hTIFF, TIFFTAG_EXTRASAMPLES, 1, v);
6211
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_RGB);
6212
0
            nSamplesAccountedFor = 4;
6213
0
        }
6214
0
        else
6215
0
        {
6216
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_MINISBLACK);
6217
0
            nSamplesAccountedFor = 1;
6218
0
        }
6219
0
    }
6220
6221
    /* -------------------------------------------------------------------- */
6222
    /*      If there are extra samples, we need to mark them with an        */
6223
    /*      appropriate extrasamples definition here.                       */
6224
    /* -------------------------------------------------------------------- */
6225
0
    if (l_nBands > nSamplesAccountedFor)
6226
0
    {
6227
0
        const int nExtraSamples = l_nBands - nSamplesAccountedFor;
6228
6229
0
        uint16_t *v = static_cast<uint16_t *>(
6230
0
            CPLMalloc(sizeof(uint16_t) * nExtraSamples));
6231
6232
0
        v[0] = GTiffGetAlphaValue(CSLFetchNameValue(papszParamList, "ALPHA"),
6233
0
                                  EXTRASAMPLE_UNSPECIFIED);
6234
6235
0
        for (int i = 1; i < nExtraSamples; ++i)
6236
0
            v[i] = EXTRASAMPLE_UNSPECIFIED;
6237
6238
0
        TIFFSetField(l_hTIFF, TIFFTAG_EXTRASAMPLES, nExtraSamples, v);
6239
6240
0
        CPLFree(v);
6241
0
    }
6242
6243
    // Set the ICC color profile.
6244
0
    if (eProfile != GTiffProfile::BASELINE)
6245
0
    {
6246
0
        SaveICCProfile(nullptr, l_hTIFF, papszParamList, l_nBitsPerSample);
6247
0
    }
6248
6249
    // Set the compression method before asking the default strip size
6250
    // This is useful when translating to a JPEG-In-TIFF file where
6251
    // the default strip size is 8 or 16 depending on the photometric value.
6252
0
    TIFFSetField(l_hTIFF, TIFFTAG_COMPRESSION, l_nCompression);
6253
6254
0
    if (l_nCompression == COMPRESSION_LERC)
6255
0
    {
6256
0
        const char *pszCompress =
6257
0
            CSLFetchNameValueDef(papszParamList, "COMPRESS", "");
6258
0
        if (EQUAL(pszCompress, "LERC_DEFLATE"))
6259
0
        {
6260
0
            TIFFSetField(l_hTIFF, TIFFTAG_LERC_ADD_COMPRESSION,
6261
0
                         LERC_ADD_COMPRESSION_DEFLATE);
6262
0
        }
6263
0
        else if (EQUAL(pszCompress, "LERC_ZSTD"))
6264
0
        {
6265
0
            if (TIFFSetField(l_hTIFF, TIFFTAG_LERC_ADD_COMPRESSION,
6266
0
                             LERC_ADD_COMPRESSION_ZSTD) != 1)
6267
0
            {
6268
0
                XTIFFClose(l_hTIFF);
6269
0
                l_fpL->CancelCreation();
6270
0
                CPL_IGNORE_RET_VAL(VSIFCloseL(l_fpL));
6271
0
                return nullptr;
6272
0
            }
6273
0
        }
6274
0
    }
6275
    // TODO later: take into account LERC version
6276
6277
    /* -------------------------------------------------------------------- */
6278
    /*      Setup tiling/stripping flags.                                   */
6279
    /* -------------------------------------------------------------------- */
6280
0
    if (bTiled)
6281
0
    {
6282
0
        if (!TIFFSetField(l_hTIFF, TIFFTAG_TILEWIDTH, l_nBlockXSize) ||
6283
0
            !TIFFSetField(l_hTIFF, TIFFTAG_TILELENGTH, l_nBlockYSize))
6284
0
        {
6285
0
            XTIFFClose(l_hTIFF);
6286
0
            l_fpL->CancelCreation();
6287
0
            CPL_IGNORE_RET_VAL(VSIFCloseL(l_fpL));
6288
0
            return nullptr;
6289
0
        }
6290
0
    }
6291
0
    else
6292
0
    {
6293
0
        const uint32_t l_nRowsPerStrip = std::min(
6294
0
            nYSize, l_nBlockYSize == 0
6295
0
                        ? static_cast<int>(TIFFDefaultStripSize(l_hTIFF, 0))
6296
0
                        : l_nBlockYSize);
6297
6298
0
        TIFFSetField(l_hTIFF, TIFFTAG_ROWSPERSTRIP, l_nRowsPerStrip);
6299
0
    }
6300
6301
    /* -------------------------------------------------------------------- */
6302
    /*      Set compression related tags.                                   */
6303
    /* -------------------------------------------------------------------- */
6304
0
    if (GTIFFSupportsPredictor(l_nCompression))
6305
0
        TIFFSetField(l_hTIFF, TIFFTAG_PREDICTOR, nPredictor);
6306
0
    if (l_nCompression == COMPRESSION_ADOBE_DEFLATE ||
6307
0
        l_nCompression == COMPRESSION_LERC)
6308
0
    {
6309
0
        GTiffSetDeflateSubCodec(l_hTIFF);
6310
6311
0
        if (l_nZLevel != -1)
6312
0
            TIFFSetField(l_hTIFF, TIFFTAG_ZIPQUALITY, l_nZLevel);
6313
0
    }
6314
0
    if (l_nCompression == COMPRESSION_JPEG && l_nJpegQuality != -1)
6315
0
        TIFFSetField(l_hTIFF, TIFFTAG_JPEGQUALITY, l_nJpegQuality);
6316
0
    if (l_nCompression == COMPRESSION_LZMA && l_nLZMAPreset != -1)
6317
0
        TIFFSetField(l_hTIFF, TIFFTAG_LZMAPRESET, l_nLZMAPreset);
6318
0
    if ((l_nCompression == COMPRESSION_ZSTD ||
6319
0
         l_nCompression == COMPRESSION_LERC) &&
6320
0
        l_nZSTDLevel != -1)
6321
0
        TIFFSetField(l_hTIFF, TIFFTAG_ZSTD_LEVEL, l_nZSTDLevel);
6322
0
    if (l_nCompression == COMPRESSION_LERC)
6323
0
    {
6324
0
        TIFFSetField(l_hTIFF, TIFFTAG_LERC_MAXZERROR, l_dfMaxZError);
6325
0
    }
6326
#if HAVE_JXL
6327
    if (l_nCompression == COMPRESSION_JXL ||
6328
        l_nCompression == COMPRESSION_JXL_DNG_1_7)
6329
    {
6330
        TIFFSetField(l_hTIFF, TIFFTAG_JXL_LOSSYNESS,
6331
                     l_bJXLLossless ? JXL_LOSSLESS : JXL_LOSSY);
6332
        TIFFSetField(l_hTIFF, TIFFTAG_JXL_EFFORT, l_nJXLEffort);
6333
        TIFFSetField(l_hTIFF, TIFFTAG_JXL_DISTANCE,
6334
                     static_cast<double>(l_fJXLDistance));
6335
        TIFFSetField(l_hTIFF, TIFFTAG_JXL_ALPHA_DISTANCE,
6336
                     static_cast<double>(l_fJXLAlphaDistance));
6337
    }
6338
#endif
6339
0
    if (l_nCompression == COMPRESSION_WEBP)
6340
0
        TIFFSetField(l_hTIFF, TIFFTAG_WEBP_LEVEL, l_nWebPLevel);
6341
0
    if (l_nCompression == COMPRESSION_WEBP && l_bWebPLossless)
6342
0
        TIFFSetField(l_hTIFF, TIFFTAG_WEBP_LOSSLESS, 1);
6343
6344
0
    if (l_nCompression == COMPRESSION_JPEG)
6345
0
        TIFFSetField(l_hTIFF, TIFFTAG_JPEGTABLESMODE, l_nJpegTablesMode);
6346
6347
    /* -------------------------------------------------------------------- */
6348
    /*      If we forced production of a file with photometric=palette,     */
6349
    /*      we need to push out a default color table.                      */
6350
    /* -------------------------------------------------------------------- */
6351
0
    if (bForceColorTable)
6352
0
    {
6353
0
        const int nColors = eType == GDT_UInt8 ? 256 : 65536;
6354
6355
0
        unsigned short *panTRed = static_cast<unsigned short *>(
6356
0
            CPLMalloc(sizeof(unsigned short) * nColors));
6357
0
        unsigned short *panTGreen = static_cast<unsigned short *>(
6358
0
            CPLMalloc(sizeof(unsigned short) * nColors));
6359
0
        unsigned short *panTBlue = static_cast<unsigned short *>(
6360
0
            CPLMalloc(sizeof(unsigned short) * nColors));
6361
6362
0
        for (int iColor = 0; iColor < nColors; ++iColor)
6363
0
        {
6364
0
            if (eType == GDT_UInt8)
6365
0
            {
6366
0
                panTRed[iColor] = GTiffDataset::ClampCTEntry(
6367
0
                    iColor, 1, iColor, nColorTableMultiplier);
6368
0
                panTGreen[iColor] = GTiffDataset::ClampCTEntry(
6369
0
                    iColor, 2, iColor, nColorTableMultiplier);
6370
0
                panTBlue[iColor] = GTiffDataset::ClampCTEntry(
6371
0
                    iColor, 3, iColor, nColorTableMultiplier);
6372
0
            }
6373
0
            else
6374
0
            {
6375
0
                panTRed[iColor] = static_cast<unsigned short>(iColor);
6376
0
                panTGreen[iColor] = static_cast<unsigned short>(iColor);
6377
0
                panTBlue[iColor] = static_cast<unsigned short>(iColor);
6378
0
            }
6379
0
        }
6380
6381
0
        TIFFSetField(l_hTIFF, TIFFTAG_COLORMAP, panTRed, panTGreen, panTBlue);
6382
6383
0
        CPLFree(panTRed);
6384
0
        CPLFree(panTGreen);
6385
0
        CPLFree(panTBlue);
6386
0
    }
6387
6388
    // This trick
6389
    // creates a temporary in-memory file and fetches its JPEG tables so that
6390
    // we can directly set them, before tif_jpeg.c compute them at the first
6391
    // strip/tile writing, which is too late, since we have already crystalized
6392
    // the directory. This way we avoid a directory rewriting.
6393
0
    if (l_nCompression == COMPRESSION_JPEG &&
6394
0
        CPLTestBool(
6395
0
            CSLFetchNameValueDef(papszParamList, "WRITE_JPEGTABLE_TAG", "YES")))
6396
0
    {
6397
0
        GTiffWriteJPEGTables(
6398
0
            l_hTIFF, CSLFetchNameValue(papszParamList, "PHOTOMETRIC"),
6399
0
            CSLFetchNameValue(papszParamList, "JPEG_QUALITY"),
6400
0
            CSLFetchNameValue(papszParamList, "JPEGTABLESMODE"));
6401
0
    }
6402
6403
0
    *pfpL = l_fpL;
6404
6405
0
    return l_hTIFF;
6406
0
}
6407
6408
/************************************************************************/
6409
/*                            GuessJPEGQuality()                        */
6410
/*                                                                      */
6411
/*      Guess JPEG quality from JPEGTABLES tag.                         */
6412
/************************************************************************/
6413
6414
static const GByte *GTIFFFindNextTable(const GByte *paby, GByte byMarker,
6415
                                       int nLen, int *pnLenTable)
6416
0
{
6417
0
    for (int i = 0; i + 1 < nLen;)
6418
0
    {
6419
0
        if (paby[i] != 0xFF)
6420
0
            return nullptr;
6421
0
        ++i;
6422
0
        if (paby[i] == 0xD8)
6423
0
        {
6424
0
            ++i;
6425
0
            continue;
6426
0
        }
6427
0
        if (i + 2 >= nLen)
6428
0
            return nullptr;
6429
0
        int nMarkerLen = paby[i + 1] * 256 + paby[i + 2];
6430
0
        if (i + 1 + nMarkerLen >= nLen)
6431
0
            return nullptr;
6432
0
        if (paby[i] == byMarker)
6433
0
        {
6434
0
            if (pnLenTable)
6435
0
                *pnLenTable = nMarkerLen;
6436
0
            return paby + i + 1;
6437
0
        }
6438
0
        i += 1 + nMarkerLen;
6439
0
    }
6440
0
    return nullptr;
6441
0
}
6442
6443
constexpr GByte MARKER_HUFFMAN_TABLE = 0xC4;
6444
constexpr GByte MARKER_QUANT_TABLE = 0xDB;
6445
6446
// We assume that if there are several quantization tables, they are
6447
// in the same order. Which is a reasonable assumption for updating
6448
// a file generated by ourselves.
6449
static bool GTIFFQuantizationTablesEqual(const GByte *paby1, int nLen1,
6450
                                         const GByte *paby2, int nLen2)
6451
0
{
6452
0
    bool bFound = false;
6453
0
    while (true)
6454
0
    {
6455
0
        int nLenTable1 = 0;
6456
0
        int nLenTable2 = 0;
6457
0
        const GByte *paby1New =
6458
0
            GTIFFFindNextTable(paby1, MARKER_QUANT_TABLE, nLen1, &nLenTable1);
6459
0
        const GByte *paby2New =
6460
0
            GTIFFFindNextTable(paby2, MARKER_QUANT_TABLE, nLen2, &nLenTable2);
6461
0
        if (paby1New == nullptr && paby2New == nullptr)
6462
0
            return bFound;
6463
0
        if (paby1New == nullptr || paby2New == nullptr)
6464
0
            return false;
6465
0
        if (nLenTable1 != nLenTable2)
6466
0
            return false;
6467
0
        if (memcmp(paby1New, paby2New, nLenTable1) != 0)
6468
0
            return false;
6469
0
        paby1New += nLenTable1;
6470
0
        paby2New += nLenTable2;
6471
0
        nLen1 -= static_cast<int>(paby1New - paby1);
6472
0
        nLen2 -= static_cast<int>(paby2New - paby2);
6473
0
        paby1 = paby1New;
6474
0
        paby2 = paby2New;
6475
0
        bFound = true;
6476
0
    }
6477
0
}
6478
6479
// Guess the JPEG quality by comparing against the MD5Sum of precomputed
6480
// quantization tables
6481
static int GuessJPEGQualityFromMD5(const uint8_t md5JPEGQuantTable[][16],
6482
                                   const GByte *const pabyJPEGTable,
6483
                                   int nJPEGTableSize)
6484
0
{
6485
0
    int nRemainingLen = nJPEGTableSize;
6486
0
    const GByte *pabyCur = pabyJPEGTable;
6487
6488
0
    struct CPLMD5Context context;
6489
0
    CPLMD5Init(&context);
6490
6491
0
    while (true)
6492
0
    {
6493
0
        int nLenTable = 0;
6494
0
        const GByte *pabyNew = GTIFFFindNextTable(pabyCur, MARKER_QUANT_TABLE,
6495
0
                                                  nRemainingLen, &nLenTable);
6496
0
        if (pabyNew == nullptr)
6497
0
            break;
6498
0
        CPLMD5Update(&context, pabyNew, nLenTable);
6499
0
        pabyNew += nLenTable;
6500
0
        nRemainingLen -= static_cast<int>(pabyNew - pabyCur);
6501
0
        pabyCur = pabyNew;
6502
0
    }
6503
6504
0
    GByte digest[16];
6505
0
    CPLMD5Final(digest, &context);
6506
6507
0
    for (int i = 0; i < 100; i++)
6508
0
    {
6509
0
        if (memcmp(md5JPEGQuantTable[i], digest, 16) == 0)
6510
0
        {
6511
0
            return i + 1;
6512
0
        }
6513
0
    }
6514
0
    return -1;
6515
0
}
6516
6517
int GTiffDataset::GuessJPEGQuality(bool &bOutHasQuantizationTable,
6518
                                   bool &bOutHasHuffmanTable)
6519
0
{
6520
0
    CPLAssert(m_nCompression == COMPRESSION_JPEG);
6521
0
    uint32_t nJPEGTableSize = 0;
6522
0
    void *pJPEGTable = nullptr;
6523
0
    if (!TIFFGetField(m_hTIFF, TIFFTAG_JPEGTABLES, &nJPEGTableSize,
6524
0
                      &pJPEGTable))
6525
0
    {
6526
0
        bOutHasQuantizationTable = false;
6527
0
        bOutHasHuffmanTable = false;
6528
0
        return -1;
6529
0
    }
6530
6531
0
    bOutHasQuantizationTable =
6532
0
        GTIFFFindNextTable(static_cast<const GByte *>(pJPEGTable),
6533
0
                           MARKER_QUANT_TABLE, nJPEGTableSize,
6534
0
                           nullptr) != nullptr;
6535
0
    bOutHasHuffmanTable =
6536
0
        GTIFFFindNextTable(static_cast<const GByte *>(pJPEGTable),
6537
0
                           MARKER_HUFFMAN_TABLE, nJPEGTableSize,
6538
0
                           nullptr) != nullptr;
6539
0
    if (!bOutHasQuantizationTable)
6540
0
        return -1;
6541
6542
0
    if ((nBands == 1 && m_nBitsPerSample == 8) ||
6543
0
        (nBands == 3 && m_nBitsPerSample == 8 &&
6544
0
         m_nPhotometric == PHOTOMETRIC_RGB) ||
6545
0
        (nBands == 4 && m_nBitsPerSample == 8 &&
6546
0
         m_nPhotometric == PHOTOMETRIC_SEPARATED))
6547
0
    {
6548
0
        return GuessJPEGQualityFromMD5(md5JPEGQuantTable_generic_8bit,
6549
0
                                       static_cast<const GByte *>(pJPEGTable),
6550
0
                                       static_cast<int>(nJPEGTableSize));
6551
0
    }
6552
6553
0
    if (nBands == 3 && m_nBitsPerSample == 8 &&
6554
0
        m_nPhotometric == PHOTOMETRIC_YCBCR)
6555
0
    {
6556
0
        int nRet =
6557
0
            GuessJPEGQualityFromMD5(md5JPEGQuantTable_3_YCBCR_8bit,
6558
0
                                    static_cast<const GByte *>(pJPEGTable),
6559
0
                                    static_cast<int>(nJPEGTableSize));
6560
0
        if (nRet < 0)
6561
0
        {
6562
            // libjpeg 9e has modified the YCbCr quantization tables.
6563
0
            nRet =
6564
0
                GuessJPEGQualityFromMD5(md5JPEGQuantTable_3_YCBCR_8bit_jpeg9e,
6565
0
                                        static_cast<const GByte *>(pJPEGTable),
6566
0
                                        static_cast<int>(nJPEGTableSize));
6567
0
        }
6568
0
        return nRet;
6569
0
    }
6570
6571
0
    char **papszLocalParameters = nullptr;
6572
0
    papszLocalParameters =
6573
0
        CSLSetNameValue(papszLocalParameters, "COMPRESS", "JPEG");
6574
0
    if (m_nPhotometric == PHOTOMETRIC_YCBCR)
6575
0
        papszLocalParameters =
6576
0
            CSLSetNameValue(papszLocalParameters, "PHOTOMETRIC", "YCBCR");
6577
0
    else if (m_nPhotometric == PHOTOMETRIC_SEPARATED)
6578
0
        papszLocalParameters =
6579
0
            CSLSetNameValue(papszLocalParameters, "PHOTOMETRIC", "CMYK");
6580
0
    papszLocalParameters =
6581
0
        CSLSetNameValue(papszLocalParameters, "BLOCKYSIZE", "16");
6582
0
    if (m_nBitsPerSample == 12)
6583
0
        papszLocalParameters =
6584
0
            CSLSetNameValue(papszLocalParameters, "NBITS", "12");
6585
6586
0
    const CPLString osTmpFilenameIn(
6587
0
        VSIMemGenerateHiddenFilename("gtiffdataset_guess_jpeg_quality_tmp"));
6588
6589
0
    int nRet = -1;
6590
0
    for (int nQuality = 0; nQuality <= 100 && nRet < 0; ++nQuality)
6591
0
    {
6592
0
        VSILFILE *fpTmp = nullptr;
6593
0
        if (nQuality == 0)
6594
0
            papszLocalParameters =
6595
0
                CSLSetNameValue(papszLocalParameters, "JPEG_QUALITY", "75");
6596
0
        else
6597
0
            papszLocalParameters =
6598
0
                CSLSetNameValue(papszLocalParameters, "JPEG_QUALITY",
6599
0
                                CPLSPrintf("%d", nQuality));
6600
6601
0
        CPLPushErrorHandler(CPLQuietErrorHandler);
6602
0
        CPLString osTmp;
6603
0
        bool bTileInterleaving;
6604
0
        TIFF *hTIFFTmp = CreateLL(
6605
0
            osTmpFilenameIn, 16, 16, (nBands <= 4) ? nBands : 1,
6606
0
            GetRasterBand(1)->GetRasterDataType(), 0.0, 0, papszLocalParameters,
6607
0
            &fpTmp, osTmp, /* bCreateCopy=*/false, bTileInterleaving);
6608
0
        CPLPopErrorHandler();
6609
0
        if (!hTIFFTmp)
6610
0
        {
6611
0
            break;
6612
0
        }
6613
6614
0
        TIFFWriteCheck(hTIFFTmp, FALSE, "CreateLL");
6615
0
        TIFFWriteDirectory(hTIFFTmp);
6616
0
        TIFFSetDirectory(hTIFFTmp, 0);
6617
        // Now reset jpegcolormode.
6618
0
        if (m_nPhotometric == PHOTOMETRIC_YCBCR &&
6619
0
            CPLTestBool(CPLGetConfigOption("CONVERT_YCBCR_TO_RGB", "YES")))
6620
0
        {
6621
0
            TIFFSetField(hTIFFTmp, TIFFTAG_JPEGCOLORMODE, JPEGCOLORMODE_RGB);
6622
0
        }
6623
6624
0
        GByte abyZeroData[(16 * 16 * 4 * 3) / 2] = {};
6625
0
        const int nBlockSize =
6626
0
            (16 * 16 * ((nBands <= 4) ? nBands : 1) * m_nBitsPerSample) / 8;
6627
0
        TIFFWriteEncodedStrip(hTIFFTmp, 0, abyZeroData, nBlockSize);
6628
6629
0
        uint32_t nJPEGTableSizeTry = 0;
6630
0
        void *pJPEGTableTry = nullptr;
6631
0
        if (TIFFGetField(hTIFFTmp, TIFFTAG_JPEGTABLES, &nJPEGTableSizeTry,
6632
0
                         &pJPEGTableTry))
6633
0
        {
6634
0
            if (GTIFFQuantizationTablesEqual(
6635
0
                    static_cast<GByte *>(pJPEGTable), nJPEGTableSize,
6636
0
                    static_cast<GByte *>(pJPEGTableTry), nJPEGTableSizeTry))
6637
0
            {
6638
0
                nRet = (nQuality == 0) ? 75 : nQuality;
6639
0
            }
6640
0
        }
6641
6642
0
        XTIFFClose(hTIFFTmp);
6643
0
        CPL_IGNORE_RET_VAL(VSIFCloseL(fpTmp));
6644
0
    }
6645
6646
0
    CSLDestroy(papszLocalParameters);
6647
0
    VSIUnlink(osTmpFilenameIn);
6648
6649
0
    return nRet;
6650
0
}
6651
6652
/************************************************************************/
6653
/*                SetJPEGQualityAndTablesModeFromFile()                 */
6654
/************************************************************************/
6655
6656
void GTiffDataset::SetJPEGQualityAndTablesModeFromFile(
6657
    int nQuality, bool bHasQuantizationTable, bool bHasHuffmanTable)
6658
0
{
6659
0
    if (nQuality > 0)
6660
0
    {
6661
0
        CPLDebug("GTiff", "Guessed JPEG quality to be %d", nQuality);
6662
0
        m_nJpegQuality = static_cast<signed char>(nQuality);
6663
0
        TIFFSetField(m_hTIFF, TIFFTAG_JPEGQUALITY, nQuality);
6664
6665
        // This means we will use the quantization tables from the
6666
        // JpegTables tag.
6667
0
        m_nJpegTablesMode = JPEGTABLESMODE_QUANT;
6668
0
    }
6669
0
    else
6670
0
    {
6671
0
        uint32_t nJPEGTableSize = 0;
6672
0
        void *pJPEGTable = nullptr;
6673
0
        if (!TIFFGetField(m_hTIFF, TIFFTAG_JPEGTABLES, &nJPEGTableSize,
6674
0
                          &pJPEGTable))
6675
0
        {
6676
0
            toff_t *panByteCounts = nullptr;
6677
0
            const int nBlockCount = m_nPlanarConfig == PLANARCONFIG_SEPARATE
6678
0
                                        ? m_nBlocksPerBand * nBands
6679
0
                                        : m_nBlocksPerBand;
6680
0
            if (TIFFIsTiled(m_hTIFF))
6681
0
                TIFFGetField(m_hTIFF, TIFFTAG_TILEBYTECOUNTS, &panByteCounts);
6682
0
            else
6683
0
                TIFFGetField(m_hTIFF, TIFFTAG_STRIPBYTECOUNTS, &panByteCounts);
6684
6685
0
            bool bFoundNonEmptyBlock = false;
6686
0
            if (panByteCounts != nullptr)
6687
0
            {
6688
0
                for (int iBlock = 0; iBlock < nBlockCount; ++iBlock)
6689
0
                {
6690
0
                    if (panByteCounts[iBlock] != 0)
6691
0
                    {
6692
0
                        bFoundNonEmptyBlock = true;
6693
0
                        break;
6694
0
                    }
6695
0
                }
6696
0
            }
6697
0
            if (bFoundNonEmptyBlock)
6698
0
            {
6699
0
                CPLDebug("GTiff", "Could not guess JPEG quality. "
6700
0
                                  "JPEG tables are missing, so going in "
6701
0
                                  "TIFFTAG_JPEGTABLESMODE = 0/2 mode");
6702
                // Write quantization tables in each strile.
6703
0
                m_nJpegTablesMode = 0;
6704
0
            }
6705
0
        }
6706
0
        else
6707
0
        {
6708
0
            if (bHasQuantizationTable)
6709
0
            {
6710
                // FIXME in libtiff: this is likely going to cause issues
6711
                // since libtiff will reuse in each strile the number of
6712
                // the global quantization table, which is invalid.
6713
0
                CPLDebug("GTiff",
6714
0
                         "Could not guess JPEG quality although JPEG "
6715
0
                         "quantization tables are present, so going in "
6716
0
                         "TIFFTAG_JPEGTABLESMODE = 0/2 mode");
6717
0
            }
6718
0
            else
6719
0
            {
6720
0
                CPLDebug("GTiff",
6721
0
                         "Could not guess JPEG quality since JPEG "
6722
0
                         "quantization tables are not present, so going in "
6723
0
                         "TIFFTAG_JPEGTABLESMODE = 0/2 mode");
6724
0
            }
6725
6726
            // Write quantization tables in each strile.
6727
0
            m_nJpegTablesMode = 0;
6728
0
        }
6729
0
    }
6730
0
    if (bHasHuffmanTable)
6731
0
    {
6732
        // If there are Huffman tables in header use them, otherwise
6733
        // if we use optimized tables, libtiff will currently reuse
6734
        // the number of the Huffman tables of the header for the
6735
        // optimized version of each strile, which is illegal.
6736
0
        m_nJpegTablesMode |= JPEGTABLESMODE_HUFF;
6737
0
    }
6738
0
    if (m_nJpegTablesMode >= 0)
6739
0
        TIFFSetField(m_hTIFF, TIFFTAG_JPEGTABLESMODE, m_nJpegTablesMode);
6740
0
}
6741
6742
/************************************************************************/
6743
/*                               Create()                               */
6744
/*                                                                      */
6745
/*      Create a new GeoTIFF or TIFF file.                              */
6746
/************************************************************************/
6747
6748
GDALDataset *GTiffDataset::Create(const char *pszFilename, int nXSize,
6749
                                  int nYSize, int l_nBands, GDALDataType eType,
6750
                                  CSLConstList papszParamList)
6751
6752
0
{
6753
0
    VSILFILE *l_fpL = nullptr;
6754
0
    CPLString l_osTmpFilename;
6755
6756
0
    const int nColorTableMultiplier = std::max(
6757
0
        1,
6758
0
        std::min(257,
6759
0
                 atoi(CSLFetchNameValueDef(
6760
0
                     papszParamList, "COLOR_TABLE_MULTIPLIER",
6761
0
                     CPLSPrintf("%d", DEFAULT_COLOR_TABLE_MULTIPLIER_257)))));
6762
6763
    /* -------------------------------------------------------------------- */
6764
    /*      Create the underlying TIFF file.                                */
6765
    /* -------------------------------------------------------------------- */
6766
0
    bool bTileInterleaving;
6767
0
    TIFF *l_hTIFF =
6768
0
        CreateLL(pszFilename, nXSize, nYSize, l_nBands, eType, 0,
6769
0
                 nColorTableMultiplier, papszParamList, &l_fpL, l_osTmpFilename,
6770
0
                 /* bCreateCopy=*/false, bTileInterleaving);
6771
0
    const bool bStreaming = !l_osTmpFilename.empty();
6772
6773
0
    if (l_hTIFF == nullptr)
6774
0
        return nullptr;
6775
6776
    /* -------------------------------------------------------------------- */
6777
    /*      Create the new GTiffDataset object.                             */
6778
    /* -------------------------------------------------------------------- */
6779
0
    auto poDS = std::make_unique<GTiffDataset>();
6780
0
    poDS->m_hTIFF = l_hTIFF;
6781
0
    poDS->m_fpL = l_fpL;
6782
0
    const bool bSuppressASAP = CPLTestBool(
6783
0
        CSLFetchNameValueDef(papszParamList, "@SUPPRESS_ASAP", "NO"));
6784
0
    if (bSuppressASAP)
6785
0
        poDS->MarkSuppressOnClose();
6786
0
    if (bStreaming)
6787
0
    {
6788
0
        poDS->m_bStreamingOut = true;
6789
0
        poDS->m_pszTmpFilename = CPLStrdup(l_osTmpFilename);
6790
0
        poDS->m_fpToWrite = VSIFOpenL(pszFilename, "wb");
6791
0
        if (poDS->m_fpToWrite == nullptr)
6792
0
        {
6793
0
            VSIUnlink(l_osTmpFilename);
6794
0
            return nullptr;
6795
0
        }
6796
0
    }
6797
0
    poDS->nRasterXSize = nXSize;
6798
0
    poDS->nRasterYSize = nYSize;
6799
0
    poDS->eAccess = GA_Update;
6800
6801
0
    poDS->m_nColorTableMultiplier = nColorTableMultiplier;
6802
6803
0
    poDS->m_bCrystalized = false;
6804
0
    poDS->m_nSamplesPerPixel = static_cast<uint16_t>(l_nBands);
6805
0
    poDS->m_osFilename = pszFilename;
6806
6807
    // Don't try to load external metadata files (#6597).
6808
0
    poDS->m_bIMDRPCMetadataLoaded = true;
6809
6810
    // Avoid premature crystalization that will cause directory re-writing if
6811
    // GetProjectionRef() or GetGeoTransform() are called on the newly created
6812
    // GeoTIFF.
6813
0
    poDS->m_bLookedForProjection = true;
6814
6815
0
    TIFFGetField(l_hTIFF, TIFFTAG_SAMPLEFORMAT, &(poDS->m_nSampleFormat));
6816
0
    TIFFGetField(l_hTIFF, TIFFTAG_PLANARCONFIG, &(poDS->m_nPlanarConfig));
6817
    // Weird that we need this, but otherwise we get a Valgrind warning on
6818
    // tiff_write_124.
6819
0
    if (!TIFFGetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, &(poDS->m_nPhotometric)))
6820
0
        poDS->m_nPhotometric = PHOTOMETRIC_MINISBLACK;
6821
0
    TIFFGetField(l_hTIFF, TIFFTAG_BITSPERSAMPLE, &(poDS->m_nBitsPerSample));
6822
0
    TIFFGetField(l_hTIFF, TIFFTAG_COMPRESSION, &(poDS->m_nCompression));
6823
6824
0
    if (TIFFIsTiled(l_hTIFF))
6825
0
    {
6826
0
        TIFFGetField(l_hTIFF, TIFFTAG_TILEWIDTH, &(poDS->m_nBlockXSize));
6827
0
        TIFFGetField(l_hTIFF, TIFFTAG_TILELENGTH, &(poDS->m_nBlockYSize));
6828
0
    }
6829
0
    else
6830
0
    {
6831
0
        if (!TIFFGetField(l_hTIFF, TIFFTAG_ROWSPERSTRIP,
6832
0
                          &(poDS->m_nRowsPerStrip)))
6833
0
            poDS->m_nRowsPerStrip = 1;  // Dummy value.
6834
6835
0
        poDS->m_nBlockXSize = nXSize;
6836
0
        poDS->m_nBlockYSize =
6837
0
            std::min(static_cast<int>(poDS->m_nRowsPerStrip), nYSize);
6838
0
    }
6839
6840
0
    if (!poDS->ComputeBlocksPerColRowAndBand(l_nBands))
6841
0
    {
6842
0
        poDS->m_fpL->CancelCreation();
6843
0
        return nullptr;
6844
0
    }
6845
6846
0
    poDS->m_eProfile = GetProfile(CSLFetchNameValue(papszParamList, "PROFILE"));
6847
6848
    /* -------------------------------------------------------------------- */
6849
    /*      YCbCr JPEG compressed images should be translated on the fly    */
6850
    /*      to RGB by libtiff/libjpeg unless specifically requested         */
6851
    /*      otherwise.                                                      */
6852
    /* -------------------------------------------------------------------- */
6853
0
    if (poDS->m_nCompression == COMPRESSION_JPEG &&
6854
0
        poDS->m_nPhotometric == PHOTOMETRIC_YCBCR &&
6855
0
        CPLTestBool(CPLGetConfigOption("CONVERT_YCBCR_TO_RGB", "YES")))
6856
0
    {
6857
0
        int nColorMode = 0;
6858
6859
0
        poDS->SetMetadataItem("SOURCE_COLOR_SPACE", "YCbCr", "IMAGE_STRUCTURE");
6860
0
        if (!TIFFGetField(l_hTIFF, TIFFTAG_JPEGCOLORMODE, &nColorMode) ||
6861
0
            nColorMode != JPEGCOLORMODE_RGB)
6862
0
            TIFFSetField(l_hTIFF, TIFFTAG_JPEGCOLORMODE, JPEGCOLORMODE_RGB);
6863
0
    }
6864
6865
0
    if (poDS->m_nCompression == COMPRESSION_LERC)
6866
0
    {
6867
0
        uint32_t nLercParamCount = 0;
6868
0
        uint32_t *panLercParams = nullptr;
6869
0
        if (TIFFGetField(l_hTIFF, TIFFTAG_LERC_PARAMETERS, &nLercParamCount,
6870
0
                         &panLercParams) &&
6871
0
            nLercParamCount == 2)
6872
0
        {
6873
0
            memcpy(poDS->m_anLercAddCompressionAndVersion, panLercParams,
6874
0
                   sizeof(poDS->m_anLercAddCompressionAndVersion));
6875
0
        }
6876
0
    }
6877
6878
    /* -------------------------------------------------------------------- */
6879
    /*      Read palette back as a color table if it has one.               */
6880
    /* -------------------------------------------------------------------- */
6881
0
    unsigned short *panRed = nullptr;
6882
0
    unsigned short *panGreen = nullptr;
6883
0
    unsigned short *panBlue = nullptr;
6884
6885
0
    if (poDS->m_nPhotometric == PHOTOMETRIC_PALETTE &&
6886
0
        TIFFGetField(l_hTIFF, TIFFTAG_COLORMAP, &panRed, &panGreen, &panBlue))
6887
0
    {
6888
6889
0
        poDS->m_poColorTable = std::make_unique<GDALColorTable>();
6890
6891
0
        const int nColorCount = 1 << poDS->m_nBitsPerSample;
6892
6893
0
        for (int iColor = nColorCount - 1; iColor >= 0; iColor--)
6894
0
        {
6895
0
            const GDALColorEntry oEntry = {
6896
0
                static_cast<short>(panRed[iColor] / nColorTableMultiplier),
6897
0
                static_cast<short>(panGreen[iColor] / nColorTableMultiplier),
6898
0
                static_cast<short>(panBlue[iColor] / nColorTableMultiplier),
6899
0
                static_cast<short>(255)};
6900
6901
0
            poDS->m_poColorTable->SetColorEntry(iColor, &oEntry);
6902
0
        }
6903
0
    }
6904
6905
    /* -------------------------------------------------------------------- */
6906
    /*      Do we want to ensure all blocks get written out on close to     */
6907
    /*      avoid sparse files?                                             */
6908
    /* -------------------------------------------------------------------- */
6909
0
    if (!CPLFetchBool(papszParamList, "SPARSE_OK", false))
6910
0
        poDS->m_bFillEmptyTilesAtClosing = true;
6911
6912
0
    poDS->m_bWriteEmptyTiles =
6913
0
        bStreaming || (poDS->m_nCompression != COMPRESSION_NONE &&
6914
0
                       poDS->m_bFillEmptyTilesAtClosing);
6915
    // Only required for people writing non-compressed striped files in the
6916
    // right order and wanting all tstrips to be written in the same order
6917
    // so that the end result can be memory mapped without knowledge of each
6918
    // strip offset.
6919
0
    if (CPLTestBool(CSLFetchNameValueDef(
6920
0
            papszParamList, "WRITE_EMPTY_TILES_SYNCHRONOUSLY", "FALSE")) ||
6921
0
        CPLTestBool(CSLFetchNameValueDef(
6922
0
            papszParamList, "@WRITE_EMPTY_TILES_SYNCHRONOUSLY", "FALSE")))
6923
0
    {
6924
0
        poDS->m_bWriteEmptyTiles = true;
6925
0
    }
6926
6927
    /* -------------------------------------------------------------------- */
6928
    /*      Preserve creation options for consulting later (for instance    */
6929
    /*      to decide if a TFW file should be written).                     */
6930
    /* -------------------------------------------------------------------- */
6931
0
    poDS->m_papszCreationOptions = CSLDuplicate(papszParamList);
6932
6933
0
    poDS->m_nZLevel = GTiffGetZLevel(papszParamList);
6934
0
    poDS->m_nLZMAPreset = GTiffGetLZMAPreset(papszParamList);
6935
0
    poDS->m_nZSTDLevel = GTiffGetZSTDPreset(papszParamList);
6936
0
    poDS->m_nWebPLevel = GTiffGetWebPLevel(papszParamList);
6937
0
    poDS->m_bWebPLossless = GTiffGetWebPLossless(papszParamList);
6938
0
    if (poDS->m_nWebPLevel != 100 && poDS->m_bWebPLossless &&
6939
0
        CSLFetchNameValue(papszParamList, "WEBP_LEVEL"))
6940
0
    {
6941
0
        CPLError(CE_Warning, CPLE_AppDefined,
6942
0
                 "WEBP_LEVEL is specified, but WEBP_LOSSLESS=YES. "
6943
0
                 "WEBP_LEVEL will be ignored.");
6944
0
    }
6945
0
    poDS->m_nJpegQuality = GTiffGetJpegQuality(papszParamList);
6946
0
    poDS->m_nJpegTablesMode = GTiffGetJpegTablesMode(papszParamList);
6947
0
    poDS->m_dfMaxZError = GTiffGetLERCMaxZError(papszParamList);
6948
0
    poDS->m_dfMaxZErrorOverview = GTiffGetLERCMaxZErrorOverview(papszParamList);
6949
#if HAVE_JXL
6950
    poDS->m_bJXLLossless = GTiffGetJXLLossless(papszParamList);
6951
    poDS->m_nJXLEffort = GTiffGetJXLEffort(papszParamList);
6952
    poDS->m_fJXLDistance = GTiffGetJXLDistance(papszParamList);
6953
    poDS->m_fJXLAlphaDistance = GTiffGetJXLAlphaDistance(papszParamList);
6954
#endif
6955
0
    poDS->InitCreationOrOpenOptions(true, papszParamList);
6956
6957
    /* -------------------------------------------------------------------- */
6958
    /*      Create band information objects.                                */
6959
    /* -------------------------------------------------------------------- */
6960
0
    for (int iBand = 0; iBand < l_nBands; ++iBand)
6961
0
    {
6962
0
        if (poDS->m_nBitsPerSample == 8 || poDS->m_nBitsPerSample == 16 ||
6963
0
            poDS->m_nBitsPerSample == 32 || poDS->m_nBitsPerSample == 64 ||
6964
0
            poDS->m_nBitsPerSample == 128)
6965
0
        {
6966
0
            poDS->SetBand(iBand + 1, std::make_unique<GTiffRasterBand>(
6967
0
                                         poDS.get(), iBand + 1));
6968
0
        }
6969
0
        else
6970
0
        {
6971
0
            poDS->SetBand(iBand + 1, std::make_unique<GTiffOddBitsBand>(
6972
0
                                         poDS.get(), iBand + 1));
6973
0
            poDS->GetRasterBand(iBand + 1)->SetMetadataItem(
6974
0
                "NBITS", CPLString().Printf("%d", poDS->m_nBitsPerSample),
6975
0
                "IMAGE_STRUCTURE");
6976
0
        }
6977
0
    }
6978
6979
0
    poDS->GetDiscardLsbOption(papszParamList);
6980
6981
0
    if (poDS->m_nPlanarConfig == PLANARCONFIG_CONTIG && l_nBands != 1)
6982
0
        poDS->SetMetadataItem("INTERLEAVE", "PIXEL", "IMAGE_STRUCTURE");
6983
0
    else
6984
0
        poDS->SetMetadataItem("INTERLEAVE", "BAND", "IMAGE_STRUCTURE");
6985
6986
0
    poDS->oOvManager.Initialize(poDS.get(), pszFilename);
6987
6988
0
    return poDS.release();
6989
0
}
6990
6991
/************************************************************************/
6992
/*                         CopyImageryAndMask()                         */
6993
/************************************************************************/
6994
6995
CPLErr GTiffDataset::CopyImageryAndMask(GTiffDataset *poDstDS,
6996
                                        GDALDataset *poSrcDS,
6997
                                        GDALRasterBand *poSrcMaskBand,
6998
                                        GDALProgressFunc pfnProgress,
6999
                                        void *pProgressData)
7000
0
{
7001
0
    CPLErr eErr = CE_None;
7002
7003
0
    const auto eType = poDstDS->GetRasterBand(1)->GetRasterDataType();
7004
0
    const int nDataTypeSize = GDALGetDataTypeSizeBytes(eType);
7005
0
    const int l_nBands = poDstDS->GetRasterCount();
7006
0
    GByte *pBlockBuffer = static_cast<GByte *>(
7007
0
        VSI_MALLOC3_VERBOSE(poDstDS->m_nBlockXSize, poDstDS->m_nBlockYSize,
7008
0
                            cpl::fits_on<int>(l_nBands * nDataTypeSize)));
7009
0
    if (pBlockBuffer == nullptr)
7010
0
    {
7011
0
        eErr = CE_Failure;
7012
0
    }
7013
0
    const int nYSize = poDstDS->nRasterYSize;
7014
0
    const int nXSize = poDstDS->nRasterXSize;
7015
0
    const bool bIsOddBand =
7016
0
        dynamic_cast<GTiffOddBitsBand *>(poDstDS->GetRasterBand(1)) != nullptr;
7017
7018
0
    if (poDstDS->m_poMaskDS)
7019
0
    {
7020
0
        CPLAssert(poDstDS->m_poMaskDS->m_nBlockXSize == poDstDS->m_nBlockXSize);
7021
0
        CPLAssert(poDstDS->m_poMaskDS->m_nBlockYSize == poDstDS->m_nBlockYSize);
7022
0
    }
7023
7024
0
    if (poDstDS->m_nPlanarConfig == PLANARCONFIG_SEPARATE &&
7025
0
        !poDstDS->m_bTileInterleave)
7026
0
    {
7027
0
        int iBlock = 0;
7028
0
        const int nBlocks = poDstDS->m_nBlocksPerBand *
7029
0
                            (l_nBands + (poDstDS->m_poMaskDS ? 1 : 0));
7030
0
        for (int i = 0; eErr == CE_None && i < l_nBands; i++)
7031
0
        {
7032
0
            for (int iY = 0, nYBlock = 0; iY < nYSize && eErr == CE_None;
7033
0
                 iY = ((nYSize - iY < poDstDS->m_nBlockYSize)
7034
0
                           ? nYSize
7035
0
                           : iY + poDstDS->m_nBlockYSize),
7036
0
                     nYBlock++)
7037
0
            {
7038
0
                const int nReqYSize =
7039
0
                    std::min(nYSize - iY, poDstDS->m_nBlockYSize);
7040
0
                for (int iX = 0, nXBlock = 0; iX < nXSize && eErr == CE_None;
7041
0
                     iX = ((nXSize - iX < poDstDS->m_nBlockXSize)
7042
0
                               ? nXSize
7043
0
                               : iX + poDstDS->m_nBlockXSize),
7044
0
                         nXBlock++)
7045
0
                {
7046
0
                    const int nReqXSize =
7047
0
                        std::min(nXSize - iX, poDstDS->m_nBlockXSize);
7048
0
                    if (nReqXSize < poDstDS->m_nBlockXSize ||
7049
0
                        nReqYSize < poDstDS->m_nBlockYSize)
7050
0
                    {
7051
0
                        memset(pBlockBuffer, 0,
7052
0
                               static_cast<size_t>(poDstDS->m_nBlockXSize) *
7053
0
                                   poDstDS->m_nBlockYSize * nDataTypeSize);
7054
0
                    }
7055
0
                    eErr = poSrcDS->GetRasterBand(i + 1)->RasterIO(
7056
0
                        GF_Read, iX, iY, nReqXSize, nReqYSize, pBlockBuffer,
7057
0
                        nReqXSize, nReqYSize, eType, nDataTypeSize,
7058
0
                        static_cast<GSpacing>(nDataTypeSize) *
7059
0
                            poDstDS->m_nBlockXSize,
7060
0
                        nullptr);
7061
0
                    if (eErr == CE_None)
7062
0
                    {
7063
0
                        eErr = poDstDS->WriteEncodedTileOrStrip(
7064
0
                            iBlock, pBlockBuffer, false);
7065
0
                    }
7066
7067
0
                    iBlock++;
7068
0
                    if (pfnProgress &&
7069
0
                        !pfnProgress(static_cast<double>(iBlock) / nBlocks,
7070
0
                                     nullptr, pProgressData))
7071
0
                    {
7072
0
                        eErr = CE_Failure;
7073
0
                    }
7074
7075
0
                    if (poDstDS->m_bWriteError)
7076
0
                        eErr = CE_Failure;
7077
0
                }
7078
0
            }
7079
0
        }
7080
0
        if (poDstDS->m_poMaskDS && eErr == CE_None)
7081
0
        {
7082
0
            int iBlockMask = 0;
7083
0
            for (int iY = 0, nYBlock = 0; iY < nYSize && eErr == CE_None;
7084
0
                 iY = ((nYSize - iY < poDstDS->m_nBlockYSize)
7085
0
                           ? nYSize
7086
0
                           : iY + poDstDS->m_nBlockYSize),
7087
0
                     nYBlock++)
7088
0
            {
7089
0
                const int nReqYSize =
7090
0
                    std::min(nYSize - iY, poDstDS->m_nBlockYSize);
7091
0
                for (int iX = 0, nXBlock = 0; iX < nXSize && eErr == CE_None;
7092
0
                     iX = ((nXSize - iX < poDstDS->m_nBlockXSize)
7093
0
                               ? nXSize
7094
0
                               : iX + poDstDS->m_nBlockXSize),
7095
0
                         nXBlock++)
7096
0
                {
7097
0
                    const int nReqXSize =
7098
0
                        std::min(nXSize - iX, poDstDS->m_nBlockXSize);
7099
0
                    if (nReqXSize < poDstDS->m_nBlockXSize ||
7100
0
                        nReqYSize < poDstDS->m_nBlockYSize)
7101
0
                    {
7102
0
                        memset(pBlockBuffer, 0,
7103
0
                               static_cast<size_t>(poDstDS->m_nBlockXSize) *
7104
0
                                   poDstDS->m_nBlockYSize);
7105
0
                    }
7106
0
                    eErr = poSrcMaskBand->RasterIO(
7107
0
                        GF_Read, iX, iY, nReqXSize, nReqYSize, pBlockBuffer,
7108
0
                        nReqXSize, nReqYSize, GDT_UInt8, 1,
7109
0
                        poDstDS->m_nBlockXSize, nullptr);
7110
0
                    if (eErr == CE_None)
7111
0
                    {
7112
                        // Avoid any attempt to load from disk
7113
0
                        poDstDS->m_poMaskDS->m_nLoadedBlock = iBlockMask;
7114
0
                        eErr =
7115
0
                            poDstDS->m_poMaskDS->GetRasterBand(1)->WriteBlock(
7116
0
                                nXBlock, nYBlock, pBlockBuffer);
7117
0
                        if (eErr == CE_None)
7118
0
                            eErr = poDstDS->m_poMaskDS->FlushBlockBuf();
7119
0
                    }
7120
7121
0
                    iBlockMask++;
7122
0
                    if (pfnProgress &&
7123
0
                        !pfnProgress(static_cast<double>(iBlock + iBlockMask) /
7124
0
                                         nBlocks,
7125
0
                                     nullptr, pProgressData))
7126
0
                    {
7127
0
                        eErr = CE_Failure;
7128
0
                    }
7129
7130
0
                    if (poDstDS->m_poMaskDS->m_bWriteError)
7131
0
                        eErr = CE_Failure;
7132
0
                }
7133
0
            }
7134
0
        }
7135
0
    }
7136
0
    else
7137
0
    {
7138
0
        int iBlock = 0;
7139
0
        const int nBlocks = poDstDS->m_nBlocksPerBand;
7140
0
        for (int iY = 0, nYBlock = 0; iY < nYSize && eErr == CE_None;
7141
0
             iY = ((nYSize - iY < poDstDS->m_nBlockYSize)
7142
0
                       ? nYSize
7143
0
                       : iY + poDstDS->m_nBlockYSize),
7144
0
                 nYBlock++)
7145
0
        {
7146
0
            const int nReqYSize = std::min(nYSize - iY, poDstDS->m_nBlockYSize);
7147
0
            for (int iX = 0, nXBlock = 0; iX < nXSize && eErr == CE_None;
7148
0
                 iX = ((nXSize - iX < poDstDS->m_nBlockXSize)
7149
0
                           ? nXSize
7150
0
                           : iX + poDstDS->m_nBlockXSize),
7151
0
                     nXBlock++)
7152
0
            {
7153
0
                const int nReqXSize =
7154
0
                    std::min(nXSize - iX, poDstDS->m_nBlockXSize);
7155
0
                if (nReqXSize < poDstDS->m_nBlockXSize ||
7156
0
                    nReqYSize < poDstDS->m_nBlockYSize)
7157
0
                {
7158
0
                    memset(pBlockBuffer, 0,
7159
0
                           static_cast<size_t>(poDstDS->m_nBlockXSize) *
7160
0
                               poDstDS->m_nBlockYSize * l_nBands *
7161
0
                               nDataTypeSize);
7162
0
                }
7163
7164
0
                if (poDstDS->m_bTileInterleave)
7165
0
                {
7166
0
                    eErr = poSrcDS->RasterIO(
7167
0
                        GF_Read, iX, iY, nReqXSize, nReqYSize, pBlockBuffer,
7168
0
                        nReqXSize, nReqYSize, eType, l_nBands, nullptr,
7169
0
                        nDataTypeSize,
7170
0
                        static_cast<GSpacing>(nDataTypeSize) *
7171
0
                            poDstDS->m_nBlockXSize,
7172
0
                        static_cast<GSpacing>(nDataTypeSize) *
7173
0
                            poDstDS->m_nBlockXSize * poDstDS->m_nBlockYSize,
7174
0
                        nullptr);
7175
0
                    if (eErr == CE_None)
7176
0
                    {
7177
0
                        for (int i = 0; eErr == CE_None && i < l_nBands; i++)
7178
0
                        {
7179
0
                            eErr = poDstDS->WriteEncodedTileOrStrip(
7180
0
                                iBlock + i * poDstDS->m_nBlocksPerBand,
7181
0
                                pBlockBuffer + static_cast<size_t>(i) *
7182
0
                                                   poDstDS->m_nBlockXSize *
7183
0
                                                   poDstDS->m_nBlockYSize *
7184
0
                                                   nDataTypeSize,
7185
0
                                false);
7186
0
                        }
7187
0
                    }
7188
0
                }
7189
0
                else if (!bIsOddBand)
7190
0
                {
7191
0
                    eErr = poSrcDS->RasterIO(
7192
0
                        GF_Read, iX, iY, nReqXSize, nReqYSize, pBlockBuffer,
7193
0
                        nReqXSize, nReqYSize, eType, l_nBands, nullptr,
7194
0
                        static_cast<GSpacing>(nDataTypeSize) * l_nBands,
7195
0
                        static_cast<GSpacing>(nDataTypeSize) * l_nBands *
7196
0
                            poDstDS->m_nBlockXSize,
7197
0
                        nDataTypeSize, nullptr);
7198
0
                    if (eErr == CE_None)
7199
0
                    {
7200
0
                        eErr = poDstDS->WriteEncodedTileOrStrip(
7201
0
                            iBlock, pBlockBuffer, false);
7202
0
                    }
7203
0
                }
7204
0
                else
7205
0
                {
7206
                    // In the odd bit case, this is a bit messy to ensure
7207
                    // the strile gets written synchronously.
7208
                    // We load the content of the n-1 bands in the cache,
7209
                    // and for the last band we invoke WriteBlock() directly
7210
                    // We also force FlushBlockBuf()
7211
0
                    std::vector<GDALRasterBlock *> apoLockedBlocks;
7212
0
                    for (int i = 0; eErr == CE_None && i < l_nBands - 1; i++)
7213
0
                    {
7214
0
                        auto poBlock =
7215
0
                            poDstDS->GetRasterBand(i + 1)->GetLockedBlockRef(
7216
0
                                nXBlock, nYBlock, TRUE);
7217
0
                        if (poBlock)
7218
0
                        {
7219
0
                            eErr = poSrcDS->GetRasterBand(i + 1)->RasterIO(
7220
0
                                GF_Read, iX, iY, nReqXSize, nReqYSize,
7221
0
                                poBlock->GetDataRef(), nReqXSize, nReqYSize,
7222
0
                                eType, nDataTypeSize,
7223
0
                                static_cast<GSpacing>(nDataTypeSize) *
7224
0
                                    poDstDS->m_nBlockXSize,
7225
0
                                nullptr);
7226
0
                            poBlock->MarkDirty();
7227
0
                            apoLockedBlocks.emplace_back(poBlock);
7228
0
                        }
7229
0
                        else
7230
0
                        {
7231
0
                            eErr = CE_Failure;
7232
0
                        }
7233
0
                    }
7234
0
                    if (eErr == CE_None)
7235
0
                    {
7236
0
                        eErr = poSrcDS->GetRasterBand(l_nBands)->RasterIO(
7237
0
                            GF_Read, iX, iY, nReqXSize, nReqYSize, pBlockBuffer,
7238
0
                            nReqXSize, nReqYSize, eType, nDataTypeSize,
7239
0
                            static_cast<GSpacing>(nDataTypeSize) *
7240
0
                                poDstDS->m_nBlockXSize,
7241
0
                            nullptr);
7242
0
                    }
7243
0
                    if (eErr == CE_None)
7244
0
                    {
7245
                        // Avoid any attempt to load from disk
7246
0
                        poDstDS->m_nLoadedBlock = iBlock;
7247
0
                        eErr = poDstDS->GetRasterBand(l_nBands)->WriteBlock(
7248
0
                            nXBlock, nYBlock, pBlockBuffer);
7249
0
                        if (eErr == CE_None)
7250
0
                            eErr = poDstDS->FlushBlockBuf();
7251
0
                    }
7252
0
                    for (auto poBlock : apoLockedBlocks)
7253
0
                    {
7254
0
                        poBlock->MarkClean();
7255
0
                        poBlock->DropLock();
7256
0
                    }
7257
0
                }
7258
7259
0
                if (eErr == CE_None && poDstDS->m_poMaskDS)
7260
0
                {
7261
0
                    if (nReqXSize < poDstDS->m_nBlockXSize ||
7262
0
                        nReqYSize < poDstDS->m_nBlockYSize)
7263
0
                    {
7264
0
                        memset(pBlockBuffer, 0,
7265
0
                               static_cast<size_t>(poDstDS->m_nBlockXSize) *
7266
0
                                   poDstDS->m_nBlockYSize);
7267
0
                    }
7268
0
                    eErr = poSrcMaskBand->RasterIO(
7269
0
                        GF_Read, iX, iY, nReqXSize, nReqYSize, pBlockBuffer,
7270
0
                        nReqXSize, nReqYSize, GDT_UInt8, 1,
7271
0
                        poDstDS->m_nBlockXSize, nullptr);
7272
0
                    if (eErr == CE_None)
7273
0
                    {
7274
                        // Avoid any attempt to load from disk
7275
0
                        poDstDS->m_poMaskDS->m_nLoadedBlock = iBlock;
7276
0
                        eErr =
7277
0
                            poDstDS->m_poMaskDS->GetRasterBand(1)->WriteBlock(
7278
0
                                nXBlock, nYBlock, pBlockBuffer);
7279
0
                        if (eErr == CE_None)
7280
0
                            eErr = poDstDS->m_poMaskDS->FlushBlockBuf();
7281
0
                    }
7282
0
                }
7283
0
                if (poDstDS->m_bWriteError)
7284
0
                    eErr = CE_Failure;
7285
7286
0
                iBlock++;
7287
0
                if (pfnProgress &&
7288
0
                    !pfnProgress(static_cast<double>(iBlock) / nBlocks, nullptr,
7289
0
                                 pProgressData))
7290
0
                {
7291
0
                    eErr = CE_Failure;
7292
0
                }
7293
0
            }
7294
0
        }
7295
0
    }
7296
7297
0
    poDstDS->FlushCache(false);  // mostly to wait for thread completion
7298
0
    VSIFree(pBlockBuffer);
7299
7300
0
    return eErr;
7301
0
}
7302
7303
/************************************************************************/
7304
/*                             CreateCopy()                             */
7305
/************************************************************************/
7306
7307
GDALDataset *GTiffDataset::CreateCopy(const char *pszFilename,
7308
                                      GDALDataset *poSrcDS, int bStrict,
7309
                                      CSLConstList papszOptions,
7310
                                      GDALProgressFunc pfnProgress,
7311
                                      void *pProgressData)
7312
7313
0
{
7314
0
    if (poSrcDS->GetRasterCount() == 0)
7315
0
    {
7316
0
        ReportError(pszFilename, CE_Failure, CPLE_AppDefined,
7317
0
                    "Unable to export GeoTIFF files with zero bands.");
7318
0
        return nullptr;
7319
0
    }
7320
7321
0
    GDALRasterBand *const poPBand = poSrcDS->GetRasterBand(1);
7322
0
    GDALDataType eType = poPBand->GetRasterDataType();
7323
7324
    /* -------------------------------------------------------------------- */
7325
    /*      Check, whether all bands in input dataset has the same type.    */
7326
    /* -------------------------------------------------------------------- */
7327
0
    const int l_nBands = poSrcDS->GetRasterCount();
7328
0
    for (int iBand = 2; iBand <= l_nBands; ++iBand)
7329
0
    {
7330
0
        if (eType != poSrcDS->GetRasterBand(iBand)->GetRasterDataType())
7331
0
        {
7332
0
            if (bStrict)
7333
0
            {
7334
0
                ReportError(
7335
0
                    pszFilename, CE_Failure, CPLE_AppDefined,
7336
0
                    "Unable to export GeoTIFF file with different datatypes "
7337
0
                    "per different bands. All bands should have the same "
7338
0
                    "types in TIFF.");
7339
0
                return nullptr;
7340
0
            }
7341
0
            else
7342
0
            {
7343
0
                ReportError(
7344
0
                    pszFilename, CE_Warning, CPLE_AppDefined,
7345
0
                    "Unable to export GeoTIFF file with different datatypes "
7346
0
                    "per different bands. All bands should have the same "
7347
0
                    "types in TIFF.");
7348
0
            }
7349
0
        }
7350
0
    }
7351
7352
    /* -------------------------------------------------------------------- */
7353
    /*      Capture the profile.                                            */
7354
    /* -------------------------------------------------------------------- */
7355
0
    const GTiffProfile eProfile =
7356
0
        GetProfile(CSLFetchNameValue(papszOptions, "PROFILE"));
7357
7358
0
    const bool bGeoTIFF = eProfile != GTiffProfile::BASELINE;
7359
7360
    /* -------------------------------------------------------------------- */
7361
    /*      Special handling for NBITS.  Copy from band metadata if found.  */
7362
    /* -------------------------------------------------------------------- */
7363
0
    char **papszCreateOptions = CSLDuplicate(papszOptions);
7364
7365
0
    if (poPBand->GetMetadataItem("NBITS", "IMAGE_STRUCTURE") != nullptr &&
7366
0
        atoi(poPBand->GetMetadataItem("NBITS", "IMAGE_STRUCTURE")) > 0 &&
7367
0
        CSLFetchNameValue(papszCreateOptions, "NBITS") == nullptr)
7368
0
    {
7369
0
        papszCreateOptions = CSLSetNameValue(
7370
0
            papszCreateOptions, "NBITS",
7371
0
            poPBand->GetMetadataItem("NBITS", "IMAGE_STRUCTURE"));
7372
0
    }
7373
7374
0
    if (CSLFetchNameValue(papszOptions, "PIXELTYPE") == nullptr &&
7375
0
        eType == GDT_UInt8)
7376
0
    {
7377
0
        poPBand->EnablePixelTypeSignedByteWarning(false);
7378
0
        const char *pszPixelType =
7379
0
            poPBand->GetMetadataItem("PIXELTYPE", "IMAGE_STRUCTURE");
7380
0
        poPBand->EnablePixelTypeSignedByteWarning(true);
7381
0
        if (pszPixelType)
7382
0
        {
7383
0
            papszCreateOptions =
7384
0
                CSLSetNameValue(papszCreateOptions, "PIXELTYPE", pszPixelType);
7385
0
        }
7386
0
    }
7387
7388
    /* -------------------------------------------------------------------- */
7389
    /*      Color profile.  Copy from band metadata if found.              */
7390
    /* -------------------------------------------------------------------- */
7391
0
    if (bGeoTIFF)
7392
0
    {
7393
0
        const char *pszOptionsMD[] = {"SOURCE_ICC_PROFILE",
7394
0
                                      "SOURCE_PRIMARIES_RED",
7395
0
                                      "SOURCE_PRIMARIES_GREEN",
7396
0
                                      "SOURCE_PRIMARIES_BLUE",
7397
0
                                      "SOURCE_WHITEPOINT",
7398
0
                                      "TIFFTAG_TRANSFERFUNCTION_RED",
7399
0
                                      "TIFFTAG_TRANSFERFUNCTION_GREEN",
7400
0
                                      "TIFFTAG_TRANSFERFUNCTION_BLUE",
7401
0
                                      "TIFFTAG_TRANSFERRANGE_BLACK",
7402
0
                                      "TIFFTAG_TRANSFERRANGE_WHITE",
7403
0
                                      nullptr};
7404
7405
        // Copy all the tags.  Options will override tags in the source.
7406
0
        int i = 0;
7407
0
        while (pszOptionsMD[i] != nullptr)
7408
0
        {
7409
0
            char const *pszMD =
7410
0
                CSLFetchNameValue(papszOptions, pszOptionsMD[i]);
7411
0
            if (pszMD == nullptr)
7412
0
                pszMD =
7413
0
                    poSrcDS->GetMetadataItem(pszOptionsMD[i], "COLOR_PROFILE");
7414
7415
0
            if ((pszMD != nullptr) && !EQUAL(pszMD, ""))
7416
0
            {
7417
0
                papszCreateOptions =
7418
0
                    CSLSetNameValue(papszCreateOptions, pszOptionsMD[i], pszMD);
7419
7420
                // If an ICC profile exists, other tags are not needed.
7421
0
                if (EQUAL(pszOptionsMD[i], "SOURCE_ICC_PROFILE"))
7422
0
                    break;
7423
0
            }
7424
7425
0
            ++i;
7426
0
        }
7427
0
    }
7428
7429
0
    double dfExtraSpaceForOverviews = 0;
7430
0
    const bool bCopySrcOverviews =
7431
0
        CPLFetchBool(papszCreateOptions, "COPY_SRC_OVERVIEWS", false);
7432
0
    std::unique_ptr<GDALDataset> poOvrDS;
7433
0
    int nSrcOverviews = 0;
7434
0
    if (bCopySrcOverviews)
7435
0
    {
7436
0
        const char *pszOvrDS =
7437
0
            CSLFetchNameValue(papszCreateOptions, "@OVERVIEW_DATASET");
7438
0
        if (pszOvrDS)
7439
0
        {
7440
            // Empty string is used by COG driver to indicate that we want
7441
            // to ignore source overviews.
7442
0
            if (!EQUAL(pszOvrDS, ""))
7443
0
            {
7444
0
                poOvrDS.reset(GDALDataset::Open(pszOvrDS));
7445
0
                if (!poOvrDS)
7446
0
                {
7447
0
                    CSLDestroy(papszCreateOptions);
7448
0
                    return nullptr;
7449
0
                }
7450
0
                if (poOvrDS->GetRasterCount() != l_nBands)
7451
0
                {
7452
0
                    CSLDestroy(papszCreateOptions);
7453
0
                    return nullptr;
7454
0
                }
7455
0
                nSrcOverviews =
7456
0
                    poOvrDS->GetRasterBand(1)->GetOverviewCount() + 1;
7457
0
            }
7458
0
        }
7459
0
        else
7460
0
        {
7461
0
            nSrcOverviews = poSrcDS->GetRasterBand(1)->GetOverviewCount();
7462
0
        }
7463
7464
        // Limit number of overviews if specified
7465
0
        const char *pszOverviewCount =
7466
0
            CSLFetchNameValue(papszCreateOptions, "@OVERVIEW_COUNT");
7467
0
        if (pszOverviewCount)
7468
0
            nSrcOverviews =
7469
0
                std::max(0, std::min(nSrcOverviews, atoi(pszOverviewCount)));
7470
7471
0
        if (nSrcOverviews)
7472
0
        {
7473
0
            for (int j = 1; j <= l_nBands; ++j)
7474
0
            {
7475
0
                const int nOtherBandOverviewCount =
7476
0
                    poOvrDS ? poOvrDS->GetRasterBand(j)->GetOverviewCount() + 1
7477
0
                            : poSrcDS->GetRasterBand(j)->GetOverviewCount();
7478
0
                if (nOtherBandOverviewCount < nSrcOverviews)
7479
0
                {
7480
0
                    ReportError(
7481
0
                        pszFilename, CE_Failure, CPLE_NotSupported,
7482
0
                        "COPY_SRC_OVERVIEWS cannot be used when the bands have "
7483
0
                        "not the same number of overview levels.");
7484
0
                    CSLDestroy(papszCreateOptions);
7485
0
                    return nullptr;
7486
0
                }
7487
0
                for (int i = 0; i < nSrcOverviews; ++i)
7488
0
                {
7489
0
                    GDALRasterBand *poOvrBand =
7490
0
                        poOvrDS
7491
0
                            ? (i == 0 ? poOvrDS->GetRasterBand(j)
7492
0
                                      : poOvrDS->GetRasterBand(j)->GetOverview(
7493
0
                                            i - 1))
7494
0
                            : poSrcDS->GetRasterBand(j)->GetOverview(i);
7495
0
                    if (poOvrBand == nullptr)
7496
0
                    {
7497
0
                        ReportError(
7498
0
                            pszFilename, CE_Failure, CPLE_NotSupported,
7499
0
                            "COPY_SRC_OVERVIEWS cannot be used when one "
7500
0
                            "overview band is NULL.");
7501
0
                        CSLDestroy(papszCreateOptions);
7502
0
                        return nullptr;
7503
0
                    }
7504
0
                    GDALRasterBand *poOvrFirstBand =
7505
0
                        poOvrDS
7506
0
                            ? (i == 0 ? poOvrDS->GetRasterBand(1)
7507
0
                                      : poOvrDS->GetRasterBand(1)->GetOverview(
7508
0
                                            i - 1))
7509
0
                            : poSrcDS->GetRasterBand(1)->GetOverview(i);
7510
0
                    if (poOvrBand->GetXSize() != poOvrFirstBand->GetXSize() ||
7511
0
                        poOvrBand->GetYSize() != poOvrFirstBand->GetYSize())
7512
0
                    {
7513
0
                        ReportError(
7514
0
                            pszFilename, CE_Failure, CPLE_NotSupported,
7515
0
                            "COPY_SRC_OVERVIEWS cannot be used when the "
7516
0
                            "overview bands have not the same dimensions "
7517
0
                            "among bands.");
7518
0
                        CSLDestroy(papszCreateOptions);
7519
0
                        return nullptr;
7520
0
                    }
7521
0
                }
7522
0
            }
7523
7524
0
            for (int i = 0; i < nSrcOverviews; ++i)
7525
0
            {
7526
0
                GDALRasterBand *poOvrFirstBand =
7527
0
                    poOvrDS
7528
0
                        ? (i == 0
7529
0
                               ? poOvrDS->GetRasterBand(1)
7530
0
                               : poOvrDS->GetRasterBand(1)->GetOverview(i - 1))
7531
0
                        : poSrcDS->GetRasterBand(1)->GetOverview(i);
7532
0
                dfExtraSpaceForOverviews +=
7533
0
                    static_cast<double>(poOvrFirstBand->GetXSize()) *
7534
0
                    poOvrFirstBand->GetYSize();
7535
0
            }
7536
0
            dfExtraSpaceForOverviews *=
7537
0
                l_nBands * GDALGetDataTypeSizeBytes(eType);
7538
0
        }
7539
0
        else
7540
0
        {
7541
0
            CPLDebug("GTiff", "No source overviews to copy");
7542
0
        }
7543
0
    }
7544
7545
/* -------------------------------------------------------------------- */
7546
/*      Should we use optimized way of copying from an input JPEG       */
7547
/*      dataset?                                                        */
7548
/* -------------------------------------------------------------------- */
7549
7550
// TODO(schwehr): Refactor bDirectCopyFromJPEG to be a const.
7551
#if defined(HAVE_LIBJPEG) || defined(JPEG_DIRECT_COPY)
7552
    bool bDirectCopyFromJPEG = false;
7553
#endif
7554
7555
    // Note: JPEG_DIRECT_COPY is not defined by default, because it is mainly
7556
    // useful for debugging purposes.
7557
#ifdef JPEG_DIRECT_COPY
7558
    if (CPLFetchBool(papszCreateOptions, "JPEG_DIRECT_COPY", false) &&
7559
        GTIFF_CanDirectCopyFromJPEG(poSrcDS, papszCreateOptions))
7560
    {
7561
        CPLDebug("GTiff", "Using special direct copy mode from a JPEG dataset");
7562
7563
        bDirectCopyFromJPEG = true;
7564
    }
7565
#endif
7566
7567
#ifdef HAVE_LIBJPEG
7568
    bool bCopyFromJPEG = false;
7569
7570
    // When CreateCopy'ing() from a JPEG dataset, and asking for COMPRESS=JPEG,
7571
    // use DCT coefficients (unless other options are incompatible, like
7572
    // strip/tile dimensions, specifying JPEG_QUALITY option, incompatible
7573
    // PHOTOMETRIC with the source colorspace, etc.) to avoid the lossy steps
7574
    // involved by decompression/recompression.
7575
    if (!bDirectCopyFromJPEG &&
7576
        GTIFF_CanCopyFromJPEG(poSrcDS, papszCreateOptions))
7577
    {
7578
        CPLDebug("GTiff", "Using special copy mode from a JPEG dataset");
7579
7580
        bCopyFromJPEG = true;
7581
    }
7582
#endif
7583
7584
    /* -------------------------------------------------------------------- */
7585
    /*      If the source is RGB, then set the PHOTOMETRIC=RGB value        */
7586
    /* -------------------------------------------------------------------- */
7587
7588
0
    const bool bForcePhotometric =
7589
0
        CSLFetchNameValue(papszOptions, "PHOTOMETRIC") != nullptr;
7590
7591
0
    if (l_nBands >= 3 && !bForcePhotometric &&
7592
#ifdef HAVE_LIBJPEG
7593
        !bCopyFromJPEG &&
7594
#endif
7595
0
        poSrcDS->GetRasterBand(1)->GetColorInterpretation() == GCI_RedBand &&
7596
0
        poSrcDS->GetRasterBand(2)->GetColorInterpretation() == GCI_GreenBand &&
7597
0
        poSrcDS->GetRasterBand(3)->GetColorInterpretation() == GCI_BlueBand)
7598
0
    {
7599
0
        papszCreateOptions =
7600
0
            CSLSetNameValue(papszCreateOptions, "PHOTOMETRIC", "RGB");
7601
0
    }
7602
7603
    /* -------------------------------------------------------------------- */
7604
    /*      Create the file.                                                */
7605
    /* -------------------------------------------------------------------- */
7606
0
    VSILFILE *l_fpL = nullptr;
7607
0
    CPLString l_osTmpFilename;
7608
7609
0
    const int nXSize = poSrcDS->GetRasterXSize();
7610
0
    const int nYSize = poSrcDS->GetRasterYSize();
7611
7612
0
    const int nColorTableMultiplier = std::max(
7613
0
        1,
7614
0
        std::min(257,
7615
0
                 atoi(CSLFetchNameValueDef(
7616
0
                     papszOptions, "COLOR_TABLE_MULTIPLIER",
7617
0
                     CPLSPrintf("%d", DEFAULT_COLOR_TABLE_MULTIPLIER_257)))));
7618
7619
0
    bool bTileInterleaving = false;
7620
0
    TIFF *l_hTIFF = CreateLL(pszFilename, nXSize, nYSize, l_nBands, eType,
7621
0
                             dfExtraSpaceForOverviews, nColorTableMultiplier,
7622
0
                             papszCreateOptions, &l_fpL, l_osTmpFilename,
7623
0
                             /* bCreateCopy = */ true, bTileInterleaving);
7624
0
    const bool bStreaming = !l_osTmpFilename.empty();
7625
7626
0
    CSLDestroy(papszCreateOptions);
7627
0
    papszCreateOptions = nullptr;
7628
7629
0
    if (l_hTIFF == nullptr)
7630
0
    {
7631
0
        if (bStreaming)
7632
0
            VSIUnlink(l_osTmpFilename);
7633
0
        return nullptr;
7634
0
    }
7635
7636
0
    uint16_t l_nPlanarConfig = 0;
7637
0
    TIFFGetField(l_hTIFF, TIFFTAG_PLANARCONFIG, &l_nPlanarConfig);
7638
7639
0
    uint16_t l_nCompression = 0;
7640
7641
0
    if (!TIFFGetField(l_hTIFF, TIFFTAG_COMPRESSION, &(l_nCompression)))
7642
0
        l_nCompression = COMPRESSION_NONE;
7643
7644
    /* -------------------------------------------------------------------- */
7645
    /*      Set the alpha channel if we find one.                           */
7646
    /* -------------------------------------------------------------------- */
7647
0
    uint16_t *extraSamples = nullptr;
7648
0
    uint16_t nExtraSamples = 0;
7649
0
    if (TIFFGetField(l_hTIFF, TIFFTAG_EXTRASAMPLES, &nExtraSamples,
7650
0
                     &extraSamples) &&
7651
0
        nExtraSamples > 0)
7652
0
    {
7653
        // We need to allocate a new array as (current) libtiff
7654
        // versions will not like that we reuse the array we got from
7655
        // TIFFGetField().
7656
0
        uint16_t *pasNewExtraSamples = static_cast<uint16_t *>(
7657
0
            CPLMalloc(nExtraSamples * sizeof(uint16_t)));
7658
0
        memcpy(pasNewExtraSamples, extraSamples,
7659
0
               nExtraSamples * sizeof(uint16_t));
7660
0
        const char *pszAlpha = CPLGetConfigOption(
7661
0
            "GTIFF_ALPHA", CSLFetchNameValue(papszOptions, "ALPHA"));
7662
0
        const uint16_t nAlpha =
7663
0
            GTiffGetAlphaValue(pszAlpha, DEFAULT_ALPHA_TYPE);
7664
0
        const int nBaseSamples = l_nBands - nExtraSamples;
7665
0
        for (int iExtraBand = nBaseSamples + 1; iExtraBand <= l_nBands;
7666
0
             iExtraBand++)
7667
0
        {
7668
0
            if (poSrcDS->GetRasterBand(iExtraBand)->GetColorInterpretation() ==
7669
0
                GCI_AlphaBand)
7670
0
            {
7671
0
                pasNewExtraSamples[iExtraBand - nBaseSamples - 1] = nAlpha;
7672
0
                if (!pszAlpha)
7673
0
                {
7674
                    // Use the ALPHA metadata item from the source band, when
7675
                    // present, if no explicit ALPHA creation option
7676
0
                    pasNewExtraSamples[iExtraBand - nBaseSamples - 1] =
7677
0
                        GTiffGetAlphaValue(
7678
0
                            poSrcDS->GetRasterBand(iExtraBand)
7679
0
                                ->GetMetadataItem("ALPHA", "IMAGE_STRUCTURE"),
7680
0
                            nAlpha);
7681
0
                }
7682
0
            }
7683
0
        }
7684
0
        TIFFSetField(l_hTIFF, TIFFTAG_EXTRASAMPLES, nExtraSamples,
7685
0
                     pasNewExtraSamples);
7686
7687
0
        CPLFree(pasNewExtraSamples);
7688
0
    }
7689
7690
    /* -------------------------------------------------------------------- */
7691
    /*      If the output is jpeg compressed, and the input is RGB make     */
7692
    /*      sure we note that.                                              */
7693
    /* -------------------------------------------------------------------- */
7694
7695
0
    if (l_nCompression == COMPRESSION_JPEG)
7696
0
    {
7697
0
        if (l_nBands >= 3 &&
7698
0
            (poSrcDS->GetRasterBand(1)->GetColorInterpretation() ==
7699
0
             GCI_YCbCr_YBand) &&
7700
0
            (poSrcDS->GetRasterBand(2)->GetColorInterpretation() ==
7701
0
             GCI_YCbCr_CbBand) &&
7702
0
            (poSrcDS->GetRasterBand(3)->GetColorInterpretation() ==
7703
0
             GCI_YCbCr_CrBand))
7704
0
        {
7705
            // Do nothing.
7706
0
        }
7707
0
        else
7708
0
        {
7709
            // Assume RGB if it is not explicitly YCbCr.
7710
0
            CPLDebug("GTiff", "Setting JPEGCOLORMODE_RGB");
7711
0
            TIFFSetField(l_hTIFF, TIFFTAG_JPEGCOLORMODE, JPEGCOLORMODE_RGB);
7712
0
        }
7713
0
    }
7714
7715
    /* -------------------------------------------------------------------- */
7716
    /*      Does the source image consist of one band, with a palette?      */
7717
    /*      If so, copy over.                                               */
7718
    /* -------------------------------------------------------------------- */
7719
0
    if ((l_nBands == 1 || l_nBands == 2) &&
7720
0
        poSrcDS->GetRasterBand(1)->GetColorTable() != nullptr &&
7721
0
        eType == GDT_UInt8)
7722
0
    {
7723
0
        unsigned short anTRed[256] = {0};
7724
0
        unsigned short anTGreen[256] = {0};
7725
0
        unsigned short anTBlue[256] = {0};
7726
0
        GDALColorTable *poCT = poSrcDS->GetRasterBand(1)->GetColorTable();
7727
7728
0
        for (int iColor = 0; iColor < 256; ++iColor)
7729
0
        {
7730
0
            if (iColor < poCT->GetColorEntryCount())
7731
0
            {
7732
0
                GDALColorEntry sRGB = {0, 0, 0, 0};
7733
7734
0
                poCT->GetColorEntryAsRGB(iColor, &sRGB);
7735
7736
0
                anTRed[iColor] = GTiffDataset::ClampCTEntry(
7737
0
                    iColor, 1, sRGB.c1, nColorTableMultiplier);
7738
0
                anTGreen[iColor] = GTiffDataset::ClampCTEntry(
7739
0
                    iColor, 2, sRGB.c2, nColorTableMultiplier);
7740
0
                anTBlue[iColor] = GTiffDataset::ClampCTEntry(
7741
0
                    iColor, 3, sRGB.c3, nColorTableMultiplier);
7742
0
            }
7743
0
            else
7744
0
            {
7745
0
                anTRed[iColor] = 0;
7746
0
                anTGreen[iColor] = 0;
7747
0
                anTBlue[iColor] = 0;
7748
0
            }
7749
0
        }
7750
7751
0
        if (!bForcePhotometric)
7752
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_PALETTE);
7753
0
        TIFFSetField(l_hTIFF, TIFFTAG_COLORMAP, anTRed, anTGreen, anTBlue);
7754
0
    }
7755
0
    else if ((l_nBands == 1 || l_nBands == 2) &&
7756
0
             poSrcDS->GetRasterBand(1)->GetColorTable() != nullptr &&
7757
0
             eType == GDT_UInt16)
7758
0
    {
7759
0
        unsigned short *panTRed = static_cast<unsigned short *>(
7760
0
            CPLMalloc(65536 * sizeof(unsigned short)));
7761
0
        unsigned short *panTGreen = static_cast<unsigned short *>(
7762
0
            CPLMalloc(65536 * sizeof(unsigned short)));
7763
0
        unsigned short *panTBlue = static_cast<unsigned short *>(
7764
0
            CPLMalloc(65536 * sizeof(unsigned short)));
7765
7766
0
        GDALColorTable *poCT = poSrcDS->GetRasterBand(1)->GetColorTable();
7767
7768
0
        for (int iColor = 0; iColor < 65536; ++iColor)
7769
0
        {
7770
0
            if (iColor < poCT->GetColorEntryCount())
7771
0
            {
7772
0
                GDALColorEntry sRGB = {0, 0, 0, 0};
7773
7774
0
                poCT->GetColorEntryAsRGB(iColor, &sRGB);
7775
7776
0
                panTRed[iColor] = GTiffDataset::ClampCTEntry(
7777
0
                    iColor, 1, sRGB.c1, nColorTableMultiplier);
7778
0
                panTGreen[iColor] = GTiffDataset::ClampCTEntry(
7779
0
                    iColor, 2, sRGB.c2, nColorTableMultiplier);
7780
0
                panTBlue[iColor] = GTiffDataset::ClampCTEntry(
7781
0
                    iColor, 3, sRGB.c3, nColorTableMultiplier);
7782
0
            }
7783
0
            else
7784
0
            {
7785
0
                panTRed[iColor] = 0;
7786
0
                panTGreen[iColor] = 0;
7787
0
                panTBlue[iColor] = 0;
7788
0
            }
7789
0
        }
7790
7791
0
        if (!bForcePhotometric)
7792
0
            TIFFSetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_PALETTE);
7793
0
        TIFFSetField(l_hTIFF, TIFFTAG_COLORMAP, panTRed, panTGreen, panTBlue);
7794
7795
0
        CPLFree(panTRed);
7796
0
        CPLFree(panTGreen);
7797
0
        CPLFree(panTBlue);
7798
0
    }
7799
0
    else if (poSrcDS->GetRasterBand(1)->GetColorTable() != nullptr)
7800
0
        ReportError(
7801
0
            pszFilename, CE_Failure, CPLE_AppDefined,
7802
0
            "Unable to export color table to GeoTIFF file.  Color tables "
7803
0
            "can only be written to 1 band or 2 bands Byte or "
7804
0
            "UInt16 GeoTIFF files.");
7805
7806
0
    if (l_nCompression == COMPRESSION_JPEG)
7807
0
    {
7808
0
        uint16_t l_nPhotometric = 0;
7809
0
        TIFFGetField(l_hTIFF, TIFFTAG_PHOTOMETRIC, &l_nPhotometric);
7810
        // Check done in tif_jpeg.c later, but not with a very clear error
7811
        // message
7812
0
        if (l_nPhotometric == PHOTOMETRIC_PALETTE)
7813
0
        {
7814
0
            ReportError(pszFilename, CE_Failure, CPLE_NotSupported,
7815
0
                        "JPEG compression not supported with paletted image");
7816
0
            XTIFFClose(l_hTIFF);
7817
0
            VSIUnlink(l_osTmpFilename);
7818
0
            CPL_IGNORE_RET_VAL(VSIFCloseL(l_fpL));
7819
0
            return nullptr;
7820
0
        }
7821
0
    }
7822
7823
0
    if (l_nBands == 2 &&
7824
0
        poSrcDS->GetRasterBand(1)->GetColorTable() != nullptr &&
7825
0
        (eType == GDT_UInt8 || eType == GDT_UInt16))
7826
0
    {
7827
0
        uint16_t v[1] = {EXTRASAMPLE_UNASSALPHA};
7828
7829
0
        TIFFSetField(l_hTIFF, TIFFTAG_EXTRASAMPLES, 1, v);
7830
0
    }
7831
7832
0
    const int nMaskFlags = poSrcDS->GetRasterBand(1)->GetMaskFlags();
7833
0
    bool bCreateMask = false;
7834
0
    CPLString osHiddenStructuralMD;
7835
0
    const char *pszInterleave =
7836
0
        CSLFetchNameValueDef(papszOptions, "INTERLEAVE", "PIXEL");
7837
0
    if (bCopySrcOverviews &&
7838
0
        CPLTestBool(CSLFetchNameValueDef(papszOptions, "TILED", "NO")))
7839
0
    {
7840
0
        osHiddenStructuralMD += "LAYOUT=IFDS_BEFORE_DATA\n";
7841
0
        osHiddenStructuralMD += "BLOCK_ORDER=ROW_MAJOR\n";
7842
0
        osHiddenStructuralMD += "BLOCK_LEADER=SIZE_AS_UINT4\n";
7843
0
        osHiddenStructuralMD += "BLOCK_TRAILER=LAST_4_BYTES_REPEATED\n";
7844
0
        if (l_nBands > 1 && !EQUAL(pszInterleave, "PIXEL"))
7845
0
        {
7846
0
            osHiddenStructuralMD += "INTERLEAVE=";
7847
0
            osHiddenStructuralMD += CPLString(pszInterleave).toupper();
7848
0
            osHiddenStructuralMD += "\n";
7849
0
        }
7850
0
        osHiddenStructuralMD +=
7851
0
            "KNOWN_INCOMPATIBLE_EDITION=NO\n ";  // Final space intended, so
7852
                                                 // this can be replaced by YES
7853
0
    }
7854
0
    if (!(nMaskFlags & (GMF_ALL_VALID | GMF_ALPHA | GMF_NODATA)) &&
7855
0
        (nMaskFlags & GMF_PER_DATASET) && !bStreaming)
7856
0
    {
7857
0
        bCreateMask = true;
7858
0
        if (GTiffDataset::MustCreateInternalMask() &&
7859
0
            !osHiddenStructuralMD.empty() && EQUAL(pszInterleave, "PIXEL"))
7860
0
        {
7861
0
            osHiddenStructuralMD += "MASK_INTERLEAVED_WITH_IMAGERY=YES\n";
7862
0
        }
7863
0
    }
7864
0
    if (!osHiddenStructuralMD.empty() &&
7865
0
        CPLTestBool(CPLGetConfigOption("GTIFF_WRITE_COG_GHOST_AREA", "YES")))
7866
0
    {
7867
0
        const int nHiddenMDSize = static_cast<int>(osHiddenStructuralMD.size());
7868
0
        osHiddenStructuralMD =
7869
0
            CPLOPrintf("GDAL_STRUCTURAL_METADATA_SIZE=%06d bytes\n",
7870
0
                       nHiddenMDSize) +
7871
0
            osHiddenStructuralMD;
7872
0
        VSI_TIFFWrite(l_hTIFF, osHiddenStructuralMD.c_str(),
7873
0
                      osHiddenStructuralMD.size());
7874
0
    }
7875
7876
    // FIXME? libtiff writes extended tags in the order they are specified
7877
    // and not in increasing order.
7878
7879
    /* -------------------------------------------------------------------- */
7880
    /*      Transfer some TIFF specific metadata, if available.             */
7881
    /*      The return value will tell us if we need to try again later with*/
7882
    /*      PAM because the profile doesn't allow to write some metadata    */
7883
    /*      as TIFF tag                                                     */
7884
    /* -------------------------------------------------------------------- */
7885
0
    const bool bHasWrittenMDInGeotiffTAG = GTiffDataset::WriteMetadata(
7886
0
        poSrcDS, l_hTIFF, false, eProfile, pszFilename, papszOptions);
7887
7888
    /* -------------------------------------------------------------------- */
7889
    /*      Write NoData value, if exist.                                   */
7890
    /* -------------------------------------------------------------------- */
7891
0
    if (eProfile == GTiffProfile::GDALGEOTIFF)
7892
0
    {
7893
0
        int bSuccess = FALSE;
7894
0
        GDALRasterBand *poFirstBand = poSrcDS->GetRasterBand(1);
7895
0
        if (poFirstBand->GetRasterDataType() == GDT_Int64)
7896
0
        {
7897
0
            const auto nNoData = poFirstBand->GetNoDataValueAsInt64(&bSuccess);
7898
0
            if (bSuccess)
7899
0
                GTiffDataset::WriteNoDataValue(l_hTIFF, nNoData);
7900
0
        }
7901
0
        else if (poFirstBand->GetRasterDataType() == GDT_UInt64)
7902
0
        {
7903
0
            const auto nNoData = poFirstBand->GetNoDataValueAsUInt64(&bSuccess);
7904
0
            if (bSuccess)
7905
0
                GTiffDataset::WriteNoDataValue(l_hTIFF, nNoData);
7906
0
        }
7907
0
        else
7908
0
        {
7909
0
            const auto dfNoData = poFirstBand->GetNoDataValue(&bSuccess);
7910
0
            if (bSuccess)
7911
0
                GTiffDataset::WriteNoDataValue(l_hTIFF, dfNoData);
7912
0
        }
7913
0
    }
7914
7915
    /* -------------------------------------------------------------------- */
7916
    /*      Are we addressing PixelIsPoint mode?                            */
7917
    /* -------------------------------------------------------------------- */
7918
0
    bool bPixelIsPoint = false;
7919
0
    bool bPointGeoIgnore = false;
7920
7921
0
    if (poSrcDS->GetMetadataItem(GDALMD_AREA_OR_POINT) &&
7922
0
        EQUAL(poSrcDS->GetMetadataItem(GDALMD_AREA_OR_POINT), GDALMD_AOP_POINT))
7923
0
    {
7924
0
        bPixelIsPoint = true;
7925
0
        bPointGeoIgnore =
7926
0
            CPLTestBool(CPLGetConfigOption("GTIFF_POINT_GEO_IGNORE", "FALSE"));
7927
0
    }
7928
7929
    /* -------------------------------------------------------------------- */
7930
    /*      Write affine transform if it is meaningful.                     */
7931
    /* -------------------------------------------------------------------- */
7932
0
    const OGRSpatialReference *l_poSRS = nullptr;
7933
0
    GDALGeoTransform l_gt;
7934
0
    if (poSrcDS->GetGeoTransform(l_gt) == CE_None)
7935
0
    {
7936
0
        if (bGeoTIFF)
7937
0
        {
7938
0
            l_poSRS = poSrcDS->GetSpatialRef();
7939
7940
0
            if (l_gt.xrot == 0.0 && l_gt.yrot == 0.0 && l_gt.yscale < 0.0)
7941
0
            {
7942
0
                double dfOffset = 0.0;
7943
0
                {
7944
                    // In the case the SRS has a vertical component and we have
7945
                    // a single band, encode its scale/offset in the GeoTIFF
7946
                    // tags
7947
0
                    int bHasScale = FALSE;
7948
0
                    double dfScale =
7949
0
                        poSrcDS->GetRasterBand(1)->GetScale(&bHasScale);
7950
0
                    int bHasOffset = FALSE;
7951
0
                    dfOffset =
7952
0
                        poSrcDS->GetRasterBand(1)->GetOffset(&bHasOffset);
7953
0
                    const bool bApplyScaleOffset =
7954
0
                        l_poSRS && l_poSRS->IsVertical() &&
7955
0
                        poSrcDS->GetRasterCount() == 1;
7956
0
                    if (bApplyScaleOffset && !bHasScale)
7957
0
                        dfScale = 1.0;
7958
0
                    if (!bApplyScaleOffset || !bHasOffset)
7959
0
                        dfOffset = 0.0;
7960
0
                    const double adfPixelScale[3] = {
7961
0
                        l_gt.xscale, fabs(l_gt.yscale),
7962
0
                        bApplyScaleOffset ? dfScale : 0.0};
7963
7964
0
                    TIFFSetField(l_hTIFF, TIFFTAG_GEOPIXELSCALE, 3,
7965
0
                                 adfPixelScale);
7966
0
                }
7967
7968
0
                double adfTiePoints[6] = {0.0,        0.0,        0.0,
7969
0
                                          l_gt.xorig, l_gt.yorig, dfOffset};
7970
7971
0
                if (bPixelIsPoint && !bPointGeoIgnore)
7972
0
                {
7973
0
                    adfTiePoints[3] += l_gt.xscale * 0.5 + l_gt.xrot * 0.5;
7974
0
                    adfTiePoints[4] += l_gt.yrot * 0.5 + l_gt.yscale * 0.5;
7975
0
                }
7976
7977
0
                TIFFSetField(l_hTIFF, TIFFTAG_GEOTIEPOINTS, 6, adfTiePoints);
7978
0
            }
7979
0
            else
7980
0
            {
7981
0
                double adfMatrix[16] = {0.0};
7982
7983
0
                adfMatrix[0] = l_gt.xscale;
7984
0
                adfMatrix[1] = l_gt.xrot;
7985
0
                adfMatrix[3] = l_gt.xorig;
7986
0
                adfMatrix[4] = l_gt.yrot;
7987
0
                adfMatrix[5] = l_gt.yscale;
7988
0
                adfMatrix[7] = l_gt.yorig;
7989
0
                adfMatrix[15] = 1.0;
7990
7991
0
                if (bPixelIsPoint && !bPointGeoIgnore)
7992
0
                {
7993
0
                    adfMatrix[3] += l_gt.xscale * 0.5 + l_gt.xrot * 0.5;
7994
0
                    adfMatrix[7] += l_gt.yrot * 0.5 + l_gt.yscale * 0.5;
7995
0
                }
7996
7997
0
                TIFFSetField(l_hTIFF, TIFFTAG_GEOTRANSMATRIX, 16, adfMatrix);
7998
0
            }
7999
0
        }
8000
8001
        /* --------------------------------------------------------------------
8002
         */
8003
        /*      Do we need a TFW file? */
8004
        /* --------------------------------------------------------------------
8005
         */
8006
0
        if (CPLFetchBool(papszOptions, "TFW", false))
8007
0
            GDALWriteWorldFile(pszFilename, "tfw", l_gt.data());
8008
0
        else if (CPLFetchBool(papszOptions, "WORLDFILE", false))
8009
0
            GDALWriteWorldFile(pszFilename, "wld", l_gt.data());
8010
0
    }
8011
8012
    /* -------------------------------------------------------------------- */
8013
    /*      Otherwise write tiepoints if they are available.                */
8014
    /* -------------------------------------------------------------------- */
8015
0
    else if (poSrcDS->GetGCPCount() > 0 && bGeoTIFF)
8016
0
    {
8017
0
        const GDAL_GCP *pasGCPs = poSrcDS->GetGCPs();
8018
0
        double *padfTiePoints = static_cast<double *>(
8019
0
            CPLMalloc(6 * sizeof(double) * poSrcDS->GetGCPCount()));
8020
8021
0
        for (int iGCP = 0; iGCP < poSrcDS->GetGCPCount(); ++iGCP)
8022
0
        {
8023
8024
0
            padfTiePoints[iGCP * 6 + 0] = pasGCPs[iGCP].dfGCPPixel;
8025
0
            padfTiePoints[iGCP * 6 + 1] = pasGCPs[iGCP].dfGCPLine;
8026
0
            padfTiePoints[iGCP * 6 + 2] = 0;
8027
0
            padfTiePoints[iGCP * 6 + 3] = pasGCPs[iGCP].dfGCPX;
8028
0
            padfTiePoints[iGCP * 6 + 4] = pasGCPs[iGCP].dfGCPY;
8029
0
            padfTiePoints[iGCP * 6 + 5] = pasGCPs[iGCP].dfGCPZ;
8030
8031
0
            if (bPixelIsPoint && !bPointGeoIgnore)
8032
0
            {
8033
0
                padfTiePoints[iGCP * 6 + 0] -= 0.5;
8034
0
                padfTiePoints[iGCP * 6 + 1] -= 0.5;
8035
0
            }
8036
0
        }
8037
8038
0
        TIFFSetField(l_hTIFF, TIFFTAG_GEOTIEPOINTS, 6 * poSrcDS->GetGCPCount(),
8039
0
                     padfTiePoints);
8040
0
        CPLFree(padfTiePoints);
8041
8042
0
        l_poSRS = poSrcDS->GetGCPSpatialRef();
8043
8044
0
        if (CPLFetchBool(papszOptions, "TFW", false) ||
8045
0
            CPLFetchBool(papszOptions, "WORLDFILE", false))
8046
0
        {
8047
0
            ReportError(
8048
0
                pszFilename, CE_Warning, CPLE_AppDefined,
8049
0
                "TFW=ON or WORLDFILE=ON creation options are ignored when "
8050
0
                "GCPs are available");
8051
0
        }
8052
0
    }
8053
0
    else
8054
0
    {
8055
0
        l_poSRS = poSrcDS->GetSpatialRef();
8056
0
    }
8057
8058
    /* -------------------------------------------------------------------- */
8059
    /*      Copy xml:XMP data                                               */
8060
    /* -------------------------------------------------------------------- */
8061
0
    CSLConstList papszXMP = poSrcDS->GetMetadata("xml:XMP");
8062
0
    if (papszXMP != nullptr && *papszXMP != nullptr)
8063
0
    {
8064
0
        int nTagSize = static_cast<int>(strlen(*papszXMP));
8065
0
        TIFFSetField(l_hTIFF, TIFFTAG_XMLPACKET, nTagSize, *papszXMP);
8066
0
    }
8067
8068
    /* -------------------------------------------------------------------- */
8069
    /*      Write the projection information, if possible.                  */
8070
    /* -------------------------------------------------------------------- */
8071
0
    const bool bHasProjection = l_poSRS != nullptr;
8072
0
    bool bExportSRSToPAM = false;
8073
0
    if ((bHasProjection || bPixelIsPoint) && bGeoTIFF)
8074
0
    {
8075
0
        GTIF *psGTIF = GTiffDataset::GTIFNew(l_hTIFF);
8076
8077
0
        if (bHasProjection)
8078
0
        {
8079
0
            const auto eGeoTIFFKeysFlavor = GetGTIFFKeysFlavor(papszOptions);
8080
0
            if (IsSRSCompatibleOfGeoTIFF(l_poSRS, eGeoTIFFKeysFlavor))
8081
0
            {
8082
0
                GTIFSetFromOGISDefnEx(
8083
0
                    psGTIF,
8084
0
                    OGRSpatialReference::ToHandle(
8085
0
                        const_cast<OGRSpatialReference *>(l_poSRS)),
8086
0
                    eGeoTIFFKeysFlavor, GetGeoTIFFVersion(papszOptions));
8087
0
            }
8088
0
            else
8089
0
            {
8090
0
                bExportSRSToPAM = true;
8091
0
            }
8092
0
        }
8093
8094
0
        if (bPixelIsPoint)
8095
0
        {
8096
0
            GTIFKeySet(psGTIF, GTRasterTypeGeoKey, TYPE_SHORT, 1,
8097
0
                       RasterPixelIsPoint);
8098
0
        }
8099
8100
0
        GTIFWriteKeys(psGTIF);
8101
0
        GTIFFree(psGTIF);
8102
0
    }
8103
8104
0
    bool l_bDontReloadFirstBlock = false;
8105
8106
#ifdef HAVE_LIBJPEG
8107
    if (bCopyFromJPEG)
8108
    {
8109
        GTIFF_CopyFromJPEG_WriteAdditionalTags(l_hTIFF, poSrcDS);
8110
    }
8111
#endif
8112
8113
    /* -------------------------------------------------------------------- */
8114
    /*      Cleanup                                                         */
8115
    /* -------------------------------------------------------------------- */
8116
0
    if (bCopySrcOverviews)
8117
0
    {
8118
0
        TIFFDeferStrileArrayWriting(l_hTIFF);
8119
0
    }
8120
0
    TIFFWriteCheck(l_hTIFF, TIFFIsTiled(l_hTIFF), "GTiffCreateCopy()");
8121
0
    TIFFWriteDirectory(l_hTIFF);
8122
0
    if (bStreaming)
8123
0
    {
8124
        // We need to write twice the directory to be sure that custom
8125
        // TIFF tags are correctly sorted and that padding bytes have been
8126
        // added.
8127
0
        TIFFSetDirectory(l_hTIFF, 0);
8128
0
        TIFFWriteDirectory(l_hTIFF);
8129
8130
0
        if (VSIFSeekL(l_fpL, 0, SEEK_END) != 0)
8131
0
            ReportError(pszFilename, CE_Failure, CPLE_FileIO, "Cannot seek");
8132
0
        const int nSize = static_cast<int>(VSIFTellL(l_fpL));
8133
8134
0
        vsi_l_offset nDataLength = 0;
8135
0
        VSIGetMemFileBuffer(l_osTmpFilename, &nDataLength, FALSE);
8136
0
        TIFFSetDirectory(l_hTIFF, 0);
8137
0
        GTiffFillStreamableOffsetAndCount(l_hTIFF, nSize);
8138
0
        TIFFWriteDirectory(l_hTIFF);
8139
0
    }
8140
0
    const auto nDirCount = TIFFNumberOfDirectories(l_hTIFF);
8141
0
    if (nDirCount >= 1)
8142
0
    {
8143
0
        TIFFSetDirectory(l_hTIFF, static_cast<tdir_t>(nDirCount - 1));
8144
0
    }
8145
0
    const toff_t l_nDirOffset = TIFFCurrentDirOffset(l_hTIFF);
8146
0
    TIFFFlush(l_hTIFF);
8147
0
    XTIFFClose(l_hTIFF);
8148
8149
0
    VSIFSeekL(l_fpL, 0, SEEK_SET);
8150
8151
    // fpStreaming will assigned to the instance and not closed here.
8152
0
    VSILFILE *fpStreaming = nullptr;
8153
0
    if (bStreaming)
8154
0
    {
8155
0
        vsi_l_offset nDataLength = 0;
8156
0
        void *pabyBuffer =
8157
0
            VSIGetMemFileBuffer(l_osTmpFilename, &nDataLength, FALSE);
8158
0
        fpStreaming = VSIFOpenL(pszFilename, "wb");
8159
0
        if (fpStreaming == nullptr)
8160
0
        {
8161
0
            VSIUnlink(l_osTmpFilename);
8162
0
            CPL_IGNORE_RET_VAL(VSIFCloseL(l_fpL));
8163
0
            return nullptr;
8164
0
        }
8165
0
        if (static_cast<vsi_l_offset>(VSIFWriteL(pabyBuffer, 1,
8166
0
                                                 static_cast<int>(nDataLength),
8167
0
                                                 fpStreaming)) != nDataLength)
8168
0
        {
8169
0
            ReportError(pszFilename, CE_Failure, CPLE_FileIO,
8170
0
                        "Could not write %d bytes",
8171
0
                        static_cast<int>(nDataLength));
8172
0
            CPL_IGNORE_RET_VAL(VSIFCloseL(fpStreaming));
8173
0
            VSIUnlink(l_osTmpFilename);
8174
0
            CPL_IGNORE_RET_VAL(VSIFCloseL(l_fpL));
8175
0
            return nullptr;
8176
0
        }
8177
0
    }
8178
8179
    /* -------------------------------------------------------------------- */
8180
    /*      Re-open as a dataset and copy over missing metadata using       */
8181
    /*      PAM facilities.                                                 */
8182
    /* -------------------------------------------------------------------- */
8183
0
    l_hTIFF = VSI_TIFFOpen(bStreaming ? l_osTmpFilename.c_str() : pszFilename,
8184
0
                           "r+", l_fpL);
8185
0
    if (l_hTIFF == nullptr)
8186
0
    {
8187
0
        if (bStreaming)
8188
0
            VSIUnlink(l_osTmpFilename);
8189
0
        l_fpL->CancelCreation();
8190
0
        CPL_IGNORE_RET_VAL(VSIFCloseL(l_fpL));
8191
0
        return nullptr;
8192
0
    }
8193
8194
    /* -------------------------------------------------------------------- */
8195
    /*      Create a corresponding GDALDataset.                             */
8196
    /* -------------------------------------------------------------------- */
8197
0
    auto poDS = std::make_unique<GTiffDataset>();
8198
0
    const bool bSuppressASAP =
8199
0
        CPLTestBool(CSLFetchNameValueDef(papszOptions, "@SUPPRESS_ASAP", "NO"));
8200
0
    if (bSuppressASAP)
8201
0
        poDS->MarkSuppressOnClose();
8202
0
    poDS->SetDescription(pszFilename);
8203
0
    poDS->eAccess = GA_Update;
8204
0
    poDS->m_osFilename = pszFilename;
8205
0
    poDS->m_fpL = l_fpL;
8206
0
    poDS->m_bIMDRPCMetadataLoaded = true;
8207
0
    poDS->m_nColorTableMultiplier = nColorTableMultiplier;
8208
0
    poDS->m_bTileInterleave = bTileInterleaving;
8209
8210
0
    if (bTileInterleaving)
8211
0
    {
8212
0
        poDS->m_oGTiffMDMD.SetMetadataItem("INTERLEAVE", "TILE",
8213
0
                                           "IMAGE_STRUCTURE");
8214
0
    }
8215
8216
0
    const bool bAppend = CPLFetchBool(papszOptions, "APPEND_SUBDATASET", false);
8217
0
    if (poDS->OpenOffset(l_hTIFF,
8218
0
                         bAppend ? l_nDirOffset : TIFFCurrentDirOffset(l_hTIFF),
8219
0
                         GA_Update,
8220
0
                         false,  // bAllowRGBAInterface
8221
0
                         true    // bReadGeoTransform
8222
0
                         ) != CE_None)
8223
0
    {
8224
0
        l_fpL->CancelCreation();
8225
0
        poDS.reset();
8226
0
        if (bStreaming)
8227
0
            VSIUnlink(l_osTmpFilename);
8228
0
        return nullptr;
8229
0
    }
8230
8231
    // Legacy... Patch back GDT_Int8 type to GDT_UInt8 if the user used
8232
    // PIXELTYPE=SIGNEDBYTE
8233
0
    const char *pszPixelType = CSLFetchNameValue(papszOptions, "PIXELTYPE");
8234
0
    if (pszPixelType == nullptr)
8235
0
        pszPixelType = "";
8236
0
    if (eType == GDT_UInt8 && EQUAL(pszPixelType, "SIGNEDBYTE"))
8237
0
    {
8238
0
        for (int i = 0; i < poDS->nBands; ++i)
8239
0
        {
8240
0
            auto poBand = static_cast<GTiffRasterBand *>(poDS->papoBands[i]);
8241
0
            poBand->eDataType = GDT_UInt8;
8242
0
            poBand->EnablePixelTypeSignedByteWarning(false);
8243
0
            poBand->SetMetadataItem("PIXELTYPE", "SIGNEDBYTE",
8244
0
                                    "IMAGE_STRUCTURE");
8245
0
            poBand->EnablePixelTypeSignedByteWarning(true);
8246
0
        }
8247
0
    }
8248
8249
0
    poDS->oOvManager.Initialize(poDS.get(), pszFilename);
8250
8251
0
    if (bStreaming)
8252
0
    {
8253
0
        VSIUnlink(l_osTmpFilename);
8254
0
        poDS->m_fpToWrite = fpStreaming;
8255
0
    }
8256
0
    poDS->m_eProfile = eProfile;
8257
8258
0
    int nCloneInfoFlags = GCIF_PAM_DEFAULT & ~GCIF_MASK;
8259
8260
    // If we explicitly asked not to tag the alpha band as such, do not
8261
    // reintroduce this alpha color interpretation in PAM.
8262
0
    if (poSrcDS->GetRasterBand(l_nBands)->GetColorInterpretation() ==
8263
0
            GCI_AlphaBand &&
8264
0
        GTiffGetAlphaValue(
8265
0
            CPLGetConfigOption("GTIFF_ALPHA",
8266
0
                               CSLFetchNameValue(papszOptions, "ALPHA")),
8267
0
            DEFAULT_ALPHA_TYPE) == EXTRASAMPLE_UNSPECIFIED)
8268
0
    {
8269
0
        nCloneInfoFlags &= ~GCIF_COLORINTERP;
8270
0
    }
8271
    // Ignore source band color interpretation if requesting PHOTOMETRIC=RGB
8272
0
    else if (l_nBands >= 3 &&
8273
0
             EQUAL(CSLFetchNameValueDef(papszOptions, "PHOTOMETRIC", ""),
8274
0
                   "RGB"))
8275
0
    {
8276
0
        for (int i = 1; i <= 3; i++)
8277
0
        {
8278
0
            poDS->GetRasterBand(i)->SetColorInterpretation(
8279
0
                static_cast<GDALColorInterp>(GCI_RedBand + (i - 1)));
8280
0
        }
8281
0
        nCloneInfoFlags &= ~GCIF_COLORINTERP;
8282
0
        if (!(l_nBands == 4 &&
8283
0
              CSLFetchNameValue(papszOptions, "ALPHA") != nullptr))
8284
0
        {
8285
0
            for (int i = 4; i <= l_nBands; i++)
8286
0
            {
8287
0
                poDS->GetRasterBand(i)->SetColorInterpretation(
8288
0
                    poSrcDS->GetRasterBand(i)->GetColorInterpretation());
8289
0
            }
8290
0
        }
8291
0
    }
8292
8293
0
    CPLString osOldGTIFF_REPORT_COMPD_CSVal(
8294
0
        CPLGetConfigOption("GTIFF_REPORT_COMPD_CS", ""));
8295
0
    CPLSetThreadLocalConfigOption("GTIFF_REPORT_COMPD_CS", "YES");
8296
0
    poDS->CloneInfo(poSrcDS, nCloneInfoFlags);
8297
0
    CPLSetThreadLocalConfigOption("GTIFF_REPORT_COMPD_CS",
8298
0
                                  osOldGTIFF_REPORT_COMPD_CSVal.empty()
8299
0
                                      ? nullptr
8300
0
                                      : osOldGTIFF_REPORT_COMPD_CSVal.c_str());
8301
8302
0
    if ((!bGeoTIFF || bExportSRSToPAM) &&
8303
0
        (poDS->GetPamFlags() & GPF_DISABLED) == 0)
8304
0
    {
8305
        // Copy georeferencing info to PAM if the profile is not GeoTIFF
8306
0
        poDS->GDALPamDataset::SetSpatialRef(poDS->GetSpatialRef());
8307
0
        GDALGeoTransform gt;
8308
0
        if (poDS->GetGeoTransform(gt) == CE_None)
8309
0
        {
8310
0
            poDS->GDALPamDataset::SetGeoTransform(gt);
8311
0
        }
8312
0
        poDS->GDALPamDataset::SetGCPs(poDS->GetGCPCount(), poDS->GetGCPs(),
8313
0
                                      poDS->GetGCPSpatialRef());
8314
0
    }
8315
8316
0
    poDS->m_papszCreationOptions = CSLDuplicate(papszOptions);
8317
0
    poDS->m_bDontReloadFirstBlock = l_bDontReloadFirstBlock;
8318
8319
    /* -------------------------------------------------------------------- */
8320
    /*      CloneInfo() does not merge metadata, it just replaces it        */
8321
    /*      totally.  So we have to merge it.                               */
8322
    /* -------------------------------------------------------------------- */
8323
8324
0
    CSLConstList papszSRC_MD = poSrcDS->GetMetadata();
8325
0
    char **papszDST_MD = CSLDuplicate(poDS->GetMetadata());
8326
8327
0
    papszDST_MD = CSLMerge(papszDST_MD, papszSRC_MD);
8328
8329
0
    poDS->SetMetadata(papszDST_MD);
8330
0
    CSLDestroy(papszDST_MD);
8331
8332
    // Depending on the PHOTOMETRIC tag, the TIFF file may not have the same
8333
    // band count as the source. Will fail later in GDALDatasetCopyWholeRaster
8334
    // anyway.
8335
0
    for (int nBand = 1;
8336
0
         nBand <= std::min(poDS->GetRasterCount(), poSrcDS->GetRasterCount());
8337
0
         ++nBand)
8338
0
    {
8339
0
        GDALRasterBand *poSrcBand = poSrcDS->GetRasterBand(nBand);
8340
0
        GDALRasterBand *poDstBand = poDS->GetRasterBand(nBand);
8341
0
        papszSRC_MD = poSrcBand->GetMetadata();
8342
0
        papszDST_MD = CSLDuplicate(poDstBand->GetMetadata());
8343
8344
0
        papszDST_MD = CSLMerge(papszDST_MD, papszSRC_MD);
8345
8346
0
        poDstBand->SetMetadata(papszDST_MD);
8347
0
        CSLDestroy(papszDST_MD);
8348
8349
0
        char **papszCatNames = poSrcBand->GetCategoryNames();
8350
0
        if (nullptr != papszCatNames)
8351
0
            poDstBand->SetCategoryNames(papszCatNames);
8352
0
    }
8353
8354
0
    l_hTIFF = static_cast<TIFF *>(poDS->GetInternalHandle("TIFF_HANDLE"));
8355
8356
    /* -------------------------------------------------------------------- */
8357
    /*      Handle forcing xml:ESRI data to be written to PAM.              */
8358
    /* -------------------------------------------------------------------- */
8359
0
    if (CPLTestBool(CPLGetConfigOption("ESRI_XML_PAM", "NO")))
8360
0
    {
8361
0
        CSLConstList papszESRIMD = poSrcDS->GetMetadata("xml:ESRI");
8362
0
        if (papszESRIMD)
8363
0
        {
8364
0
            poDS->SetMetadata(papszESRIMD, "xml:ESRI");
8365
0
        }
8366
0
    }
8367
8368
    /* -------------------------------------------------------------------- */
8369
    /*      Second chance: now that we have a PAM dataset, it is possible   */
8370
    /*      to write metadata that we could not write as a TIFF tag.        */
8371
    /* -------------------------------------------------------------------- */
8372
0
    if (!bHasWrittenMDInGeotiffTAG && !bStreaming)
8373
0
    {
8374
0
        GTiffDataset::WriteMetadata(
8375
0
            poDS.get(), l_hTIFF, true, eProfile, pszFilename, papszOptions,
8376
0
            true /* don't write RPC and IMD file again */);
8377
0
    }
8378
8379
0
    if (!bStreaming)
8380
0
        GTiffDataset::WriteRPC(poDS.get(), l_hTIFF, true, eProfile, pszFilename,
8381
0
                               papszOptions,
8382
0
                               true /* write only in PAM AND if needed */);
8383
8384
0
    poDS->m_bWriteCOGLayout = bCopySrcOverviews;
8385
8386
    // To avoid unnecessary directory rewriting.
8387
0
    poDS->m_bMetadataChanged = false;
8388
0
    poDS->m_bGeoTIFFInfoChanged = false;
8389
0
    poDS->m_bNoDataChanged = false;
8390
0
    poDS->m_bForceUnsetGTOrGCPs = false;
8391
0
    poDS->m_bForceUnsetProjection = false;
8392
0
    poDS->m_bStreamingOut = bStreaming;
8393
8394
    // Don't try to load external metadata files (#6597).
8395
0
    poDS->m_bIMDRPCMetadataLoaded = true;
8396
8397
    // We must re-set the compression level at this point, since it has been
8398
    // lost a few lines above when closing the newly create TIFF file The
8399
    // TIFFTAG_ZIPQUALITY & TIFFTAG_JPEGQUALITY are not store in the TIFF file.
8400
    // They are just TIFF session parameters.
8401
8402
0
    poDS->m_nZLevel = GTiffGetZLevel(papszOptions);
8403
0
    poDS->m_nLZMAPreset = GTiffGetLZMAPreset(papszOptions);
8404
0
    poDS->m_nZSTDLevel = GTiffGetZSTDPreset(papszOptions);
8405
0
    poDS->m_nWebPLevel = GTiffGetWebPLevel(papszOptions);
8406
0
    poDS->m_bWebPLossless = GTiffGetWebPLossless(papszOptions);
8407
0
    if (poDS->m_nWebPLevel != 100 && poDS->m_bWebPLossless &&
8408
0
        CSLFetchNameValue(papszOptions, "WEBP_LEVEL"))
8409
0
    {
8410
0
        CPLError(CE_Warning, CPLE_AppDefined,
8411
0
                 "WEBP_LEVEL is specified, but WEBP_LOSSLESS=YES. "
8412
0
                 "WEBP_LEVEL will be ignored.");
8413
0
    }
8414
0
    poDS->m_nJpegQuality = GTiffGetJpegQuality(papszOptions);
8415
0
    poDS->m_nJpegTablesMode = GTiffGetJpegTablesMode(papszOptions);
8416
0
    poDS->GetDiscardLsbOption(papszOptions);
8417
0
    poDS->m_dfMaxZError = GTiffGetLERCMaxZError(papszOptions);
8418
0
    poDS->m_dfMaxZErrorOverview = GTiffGetLERCMaxZErrorOverview(papszOptions);
8419
#if HAVE_JXL
8420
    poDS->m_bJXLLossless = GTiffGetJXLLossless(papszOptions);
8421
    poDS->m_nJXLEffort = GTiffGetJXLEffort(papszOptions);
8422
    poDS->m_fJXLDistance = GTiffGetJXLDistance(papszOptions);
8423
    poDS->m_fJXLAlphaDistance = GTiffGetJXLAlphaDistance(papszOptions);
8424
#endif
8425
0
    poDS->InitCreationOrOpenOptions(true, papszOptions);
8426
8427
0
    if (l_nCompression == COMPRESSION_ADOBE_DEFLATE ||
8428
0
        l_nCompression == COMPRESSION_LERC)
8429
0
    {
8430
0
        GTiffSetDeflateSubCodec(l_hTIFF);
8431
8432
0
        if (poDS->m_nZLevel != -1)
8433
0
        {
8434
0
            TIFFSetField(l_hTIFF, TIFFTAG_ZIPQUALITY, poDS->m_nZLevel);
8435
0
        }
8436
0
    }
8437
0
    if (l_nCompression == COMPRESSION_JPEG)
8438
0
    {
8439
0
        if (poDS->m_nJpegQuality != -1)
8440
0
        {
8441
0
            TIFFSetField(l_hTIFF, TIFFTAG_JPEGQUALITY, poDS->m_nJpegQuality);
8442
0
        }
8443
0
        TIFFSetField(l_hTIFF, TIFFTAG_JPEGTABLESMODE, poDS->m_nJpegTablesMode);
8444
0
    }
8445
0
    if (l_nCompression == COMPRESSION_LZMA)
8446
0
    {
8447
0
        if (poDS->m_nLZMAPreset != -1)
8448
0
        {
8449
0
            TIFFSetField(l_hTIFF, TIFFTAG_LZMAPRESET, poDS->m_nLZMAPreset);
8450
0
        }
8451
0
    }
8452
0
    if (l_nCompression == COMPRESSION_ZSTD ||
8453
0
        l_nCompression == COMPRESSION_LERC)
8454
0
    {
8455
0
        if (poDS->m_nZSTDLevel != -1)
8456
0
        {
8457
0
            TIFFSetField(l_hTIFF, TIFFTAG_ZSTD_LEVEL, poDS->m_nZSTDLevel);
8458
0
        }
8459
0
    }
8460
0
    if (l_nCompression == COMPRESSION_LERC)
8461
0
    {
8462
0
        TIFFSetField(l_hTIFF, TIFFTAG_LERC_MAXZERROR, poDS->m_dfMaxZError);
8463
0
    }
8464
#if HAVE_JXL
8465
    if (l_nCompression == COMPRESSION_JXL ||
8466
        l_nCompression == COMPRESSION_JXL_DNG_1_7)
8467
    {
8468
        TIFFSetField(l_hTIFF, TIFFTAG_JXL_LOSSYNESS,
8469
                     poDS->m_bJXLLossless ? JXL_LOSSLESS : JXL_LOSSY);
8470
        TIFFSetField(l_hTIFF, TIFFTAG_JXL_EFFORT, poDS->m_nJXLEffort);
8471
        TIFFSetField(l_hTIFF, TIFFTAG_JXL_DISTANCE,
8472
                     static_cast<double>(poDS->m_fJXLDistance));
8473
        TIFFSetField(l_hTIFF, TIFFTAG_JXL_ALPHA_DISTANCE,
8474
                     static_cast<double>(poDS->m_fJXLAlphaDistance));
8475
    }
8476
#endif
8477
0
    if (l_nCompression == COMPRESSION_WEBP)
8478
0
    {
8479
0
        if (poDS->m_nWebPLevel != -1)
8480
0
        {
8481
0
            TIFFSetField(l_hTIFF, TIFFTAG_WEBP_LEVEL, poDS->m_nWebPLevel);
8482
0
        }
8483
8484
0
        if (poDS->m_bWebPLossless)
8485
0
        {
8486
0
            TIFFSetField(l_hTIFF, TIFFTAG_WEBP_LOSSLESS, poDS->m_bWebPLossless);
8487
0
        }
8488
0
    }
8489
8490
    /* -------------------------------------------------------------------- */
8491
    /*      Do we want to ensure all blocks get written out on close to     */
8492
    /*      avoid sparse files?                                             */
8493
    /* -------------------------------------------------------------------- */
8494
0
    if (!CPLFetchBool(papszOptions, "SPARSE_OK", false))
8495
0
        poDS->m_bFillEmptyTilesAtClosing = true;
8496
8497
0
    poDS->m_bWriteEmptyTiles =
8498
0
        (bCopySrcOverviews && poDS->m_bFillEmptyTilesAtClosing) || bStreaming ||
8499
0
        (poDS->m_nCompression != COMPRESSION_NONE &&
8500
0
         poDS->m_bFillEmptyTilesAtClosing);
8501
    // Only required for people writing non-compressed striped files in the
8502
    // rightorder and wanting all tstrips to be written in the same order
8503
    // so that the end result can be memory mapped without knowledge of each
8504
    // strip offset
8505
0
    if (CPLTestBool(CSLFetchNameValueDef(
8506
0
            papszOptions, "WRITE_EMPTY_TILES_SYNCHRONOUSLY", "FALSE")) ||
8507
0
        CPLTestBool(CSLFetchNameValueDef(
8508
0
            papszOptions, "@WRITE_EMPTY_TILES_SYNCHRONOUSLY", "FALSE")))
8509
0
    {
8510
0
        poDS->m_bWriteEmptyTiles = true;
8511
0
    }
8512
8513
    // Precreate (internal) mask, so that the IBuildOverviews() below
8514
    // has a chance to create also the overviews of the mask.
8515
0
    CPLErr eErr = CE_None;
8516
8517
0
    if (bCreateMask)
8518
0
    {
8519
0
        eErr = poDS->CreateMaskBand(nMaskFlags);
8520
0
        if (poDS->m_poMaskDS)
8521
0
        {
8522
0
            poDS->m_poMaskDS->m_bFillEmptyTilesAtClosing =
8523
0
                poDS->m_bFillEmptyTilesAtClosing;
8524
0
            poDS->m_poMaskDS->m_bWriteEmptyTiles = poDS->m_bWriteEmptyTiles;
8525
0
        }
8526
0
    }
8527
8528
    /* -------------------------------------------------------------------- */
8529
    /*      Create and then copy existing overviews if requested            */
8530
    /*  We do it such that all the IFDs are at the beginning of the file,   */
8531
    /*  and that the imagery data for the smallest overview is written      */
8532
    /*  first, that way the file is more usable when embedded in a          */
8533
    /*  compressed stream.                                                  */
8534
    /* -------------------------------------------------------------------- */
8535
8536
    // For scaled progress due to overview copying.
8537
0
    const int nBandsWidthMask = l_nBands + (bCreateMask ? 1 : 0);
8538
0
    double dfTotalPixels =
8539
0
        static_cast<double>(nXSize) * nYSize * nBandsWidthMask;
8540
0
    double dfCurPixels = 0;
8541
8542
0
    if (eErr == CE_None && bCopySrcOverviews)
8543
0
    {
8544
0
        std::unique_ptr<GDALDataset> poMaskOvrDS;
8545
0
        const char *pszMaskOvrDS =
8546
0
            CSLFetchNameValue(papszOptions, "@MASK_OVERVIEW_DATASET");
8547
0
        if (pszMaskOvrDS)
8548
0
        {
8549
0
            poMaskOvrDS.reset(GDALDataset::Open(pszMaskOvrDS));
8550
0
            if (!poMaskOvrDS)
8551
0
            {
8552
0
                l_fpL->CancelCreation();
8553
0
                return nullptr;
8554
0
            }
8555
0
            if (poMaskOvrDS->GetRasterCount() != 1)
8556
0
            {
8557
0
                l_fpL->CancelCreation();
8558
0
                return nullptr;
8559
0
            }
8560
0
        }
8561
0
        if (nSrcOverviews)
8562
0
        {
8563
0
            eErr = poDS->CreateOverviewsFromSrcOverviews(poSrcDS, poOvrDS.get(),
8564
0
                                                         nSrcOverviews);
8565
8566
0
            if (eErr == CE_None &&
8567
0
                (poMaskOvrDS != nullptr ||
8568
0
                 (poSrcDS->GetRasterBand(1)->GetOverview(0) &&
8569
0
                  poSrcDS->GetRasterBand(1)->GetOverview(0)->GetMaskFlags() ==
8570
0
                      GMF_PER_DATASET)))
8571
0
            {
8572
0
                int nOvrBlockXSize = 0;
8573
0
                int nOvrBlockYSize = 0;
8574
0
                GTIFFGetOverviewBlockSize(
8575
0
                    GDALRasterBand::ToHandle(poDS->GetRasterBand(1)),
8576
0
                    &nOvrBlockXSize, &nOvrBlockYSize, nullptr, nullptr);
8577
0
                eErr = poDS->CreateInternalMaskOverviews(nOvrBlockXSize,
8578
0
                                                         nOvrBlockYSize);
8579
0
            }
8580
0
        }
8581
8582
0
        TIFFForceStrileArrayWriting(poDS->m_hTIFF);
8583
8584
0
        if (poDS->m_poMaskDS)
8585
0
        {
8586
0
            TIFFForceStrileArrayWriting(poDS->m_poMaskDS->m_hTIFF);
8587
0
        }
8588
8589
0
        for (auto &poIterOvrDS : poDS->m_apoOverviewDS)
8590
0
        {
8591
0
            TIFFForceStrileArrayWriting(poIterOvrDS->m_hTIFF);
8592
8593
0
            if (poIterOvrDS->m_poMaskDS)
8594
0
            {
8595
0
                TIFFForceStrileArrayWriting(poIterOvrDS->m_poMaskDS->m_hTIFF);
8596
0
            }
8597
0
        }
8598
8599
0
        if (eErr == CE_None && nSrcOverviews)
8600
0
        {
8601
0
            if (poDS->m_apoOverviewDS.size() !=
8602
0
                static_cast<size_t>(nSrcOverviews))
8603
0
            {
8604
0
                ReportError(
8605
0
                    pszFilename, CE_Failure, CPLE_AppDefined,
8606
0
                    "Did only manage to instantiate %d overview levels, "
8607
0
                    "whereas source contains %d",
8608
0
                    static_cast<int>(poDS->m_apoOverviewDS.size()),
8609
0
                    nSrcOverviews);
8610
0
                eErr = CE_Failure;
8611
0
            }
8612
8613
0
            for (int i = 0; eErr == CE_None && i < nSrcOverviews; ++i)
8614
0
            {
8615
0
                GDALRasterBand *poOvrBand =
8616
0
                    poOvrDS
8617
0
                        ? (i == 0
8618
0
                               ? poOvrDS->GetRasterBand(1)
8619
0
                               : poOvrDS->GetRasterBand(1)->GetOverview(i - 1))
8620
0
                        : poSrcDS->GetRasterBand(1)->GetOverview(i);
8621
0
                const double dfOvrPixels =
8622
0
                    static_cast<double>(poOvrBand->GetXSize()) *
8623
0
                    poOvrBand->GetYSize();
8624
0
                dfTotalPixels += dfOvrPixels * l_nBands;
8625
0
                if (poOvrBand->GetMaskFlags() == GMF_PER_DATASET ||
8626
0
                    poMaskOvrDS != nullptr)
8627
0
                {
8628
0
                    dfTotalPixels += dfOvrPixels;
8629
0
                }
8630
0
                else if (i == 0 && poDS->GetRasterBand(1)->GetMaskFlags() ==
8631
0
                                       GMF_PER_DATASET)
8632
0
                {
8633
0
                    ReportError(pszFilename, CE_Warning, CPLE_AppDefined,
8634
0
                                "Source dataset has a mask band on full "
8635
0
                                "resolution, overviews on the regular bands, "
8636
0
                                "but lacks overviews on the mask band.");
8637
0
                }
8638
0
            }
8639
8640
            // Now copy the imagery.
8641
            // Begin with the smallest overview.
8642
0
            for (int iOvrLevel = nSrcOverviews - 1;
8643
0
                 eErr == CE_None && iOvrLevel >= 0; --iOvrLevel)
8644
0
            {
8645
0
                auto poDstDS = poDS->m_apoOverviewDS[iOvrLevel].get();
8646
8647
                // Create a fake dataset with the source overview level so that
8648
                // GDALDatasetCopyWholeRaster can cope with it.
8649
0
                GDALDataset *poSrcOvrDS =
8650
0
                    poOvrDS
8651
0
                        ? (iOvrLevel == 0 ? poOvrDS.get()
8652
0
                                          : GDALCreateOverviewDataset(
8653
0
                                                poOvrDS.get(), iOvrLevel - 1,
8654
0
                                                /* bThisLevelOnly = */ true))
8655
0
                        : GDALCreateOverviewDataset(
8656
0
                              poSrcDS, iOvrLevel,
8657
0
                              /* bThisLevelOnly = */ true);
8658
0
                GDALRasterBand *poSrcOvrBand =
8659
0
                    poOvrDS ? (iOvrLevel == 0
8660
0
                                   ? poOvrDS->GetRasterBand(1)
8661
0
                                   : poOvrDS->GetRasterBand(1)->GetOverview(
8662
0
                                         iOvrLevel - 1))
8663
0
                            : poSrcDS->GetRasterBand(1)->GetOverview(iOvrLevel);
8664
0
                double dfNextCurPixels =
8665
0
                    dfCurPixels +
8666
0
                    static_cast<double>(poSrcOvrBand->GetXSize()) *
8667
0
                        poSrcOvrBand->GetYSize() * l_nBands;
8668
8669
0
                poDstDS->m_bBlockOrderRowMajor = true;
8670
0
                poDstDS->m_bLeaderSizeAsUInt4 = true;
8671
0
                poDstDS->m_bTrailerRepeatedLast4BytesRepeated = true;
8672
0
                poDstDS->m_bFillEmptyTilesAtClosing =
8673
0
                    poDS->m_bFillEmptyTilesAtClosing;
8674
0
                poDstDS->m_bWriteEmptyTiles = poDS->m_bWriteEmptyTiles;
8675
0
                poDstDS->m_bTileInterleave = poDS->m_bTileInterleave;
8676
0
                GDALRasterBand *poSrcMaskBand = nullptr;
8677
0
                if (poDstDS->m_poMaskDS)
8678
0
                {
8679
0
                    poDstDS->m_poMaskDS->m_bBlockOrderRowMajor = true;
8680
0
                    poDstDS->m_poMaskDS->m_bLeaderSizeAsUInt4 = true;
8681
0
                    poDstDS->m_poMaskDS->m_bTrailerRepeatedLast4BytesRepeated =
8682
0
                        true;
8683
0
                    poDstDS->m_poMaskDS->m_bFillEmptyTilesAtClosing =
8684
0
                        poDS->m_bFillEmptyTilesAtClosing;
8685
0
                    poDstDS->m_poMaskDS->m_bWriteEmptyTiles =
8686
0
                        poDS->m_bWriteEmptyTiles;
8687
8688
0
                    poSrcMaskBand =
8689
0
                        poMaskOvrDS
8690
0
                            ? (iOvrLevel == 0
8691
0
                                   ? poMaskOvrDS->GetRasterBand(1)
8692
0
                                   : poMaskOvrDS->GetRasterBand(1)->GetOverview(
8693
0
                                         iOvrLevel - 1))
8694
0
                            : poSrcOvrBand->GetMaskBand();
8695
0
                }
8696
8697
0
                if (poDstDS->m_poMaskDS)
8698
0
                {
8699
0
                    dfNextCurPixels +=
8700
0
                        static_cast<double>(poSrcOvrBand->GetXSize()) *
8701
0
                        poSrcOvrBand->GetYSize();
8702
0
                }
8703
0
                void *pScaledData =
8704
0
                    GDALCreateScaledProgress(dfCurPixels / dfTotalPixels,
8705
0
                                             dfNextCurPixels / dfTotalPixels,
8706
0
                                             pfnProgress, pProgressData);
8707
8708
0
                eErr = CopyImageryAndMask(poDstDS, poSrcOvrDS, poSrcMaskBand,
8709
0
                                          GDALScaledProgress, pScaledData);
8710
8711
0
                dfCurPixels = dfNextCurPixels;
8712
0
                GDALDestroyScaledProgress(pScaledData);
8713
8714
0
                if (poSrcOvrDS != poOvrDS.get())
8715
0
                    delete poSrcOvrDS;
8716
0
                poSrcOvrDS = nullptr;
8717
0
            }
8718
0
        }
8719
0
    }
8720
8721
    /* -------------------------------------------------------------------- */
8722
    /*      Copy actual imagery.                                            */
8723
    /* -------------------------------------------------------------------- */
8724
0
    double dfNextCurPixels =
8725
0
        dfCurPixels + static_cast<double>(nXSize) * nYSize * l_nBands;
8726
0
    void *pScaledData = GDALCreateScaledProgress(
8727
0
        dfCurPixels / dfTotalPixels, dfNextCurPixels / dfTotalPixels,
8728
0
        pfnProgress, pProgressData);
8729
8730
#if defined(HAVE_LIBJPEG) || defined(JPEG_DIRECT_COPY)
8731
    bool bTryCopy = true;
8732
#endif
8733
8734
#ifdef HAVE_LIBJPEG
8735
    if (bCopyFromJPEG)
8736
    {
8737
        eErr = GTIFF_CopyFromJPEG(poDS.get(), poSrcDS, pfnProgress,
8738
                                  pProgressData, bTryCopy);
8739
8740
        // In case of failure in the decompression step, try normal copy.
8741
        if (bTryCopy)
8742
            eErr = CE_None;
8743
    }
8744
#endif
8745
8746
#ifdef JPEG_DIRECT_COPY
8747
    if (bDirectCopyFromJPEG)
8748
    {
8749
        eErr = GTIFF_DirectCopyFromJPEG(poDS.get(), poSrcDS, pfnProgress,
8750
                                        pProgressData, bTryCopy);
8751
8752
        // In case of failure in the reading step, try normal copy.
8753
        if (bTryCopy)
8754
            eErr = CE_None;
8755
    }
8756
#endif
8757
8758
0
    bool bWriteMask = true;
8759
0
    if (
8760
#if defined(HAVE_LIBJPEG) || defined(JPEG_DIRECT_COPY)
8761
        bTryCopy &&
8762
#endif
8763
0
        (poDS->m_bTreatAsSplit || poDS->m_bTreatAsSplitBitmap))
8764
0
    {
8765
        // For split bands, we use TIFFWriteScanline() interface.
8766
0
        CPLAssert(poDS->m_nBitsPerSample == 8 || poDS->m_nBitsPerSample == 1);
8767
8768
0
        if (poDS->m_nPlanarConfig == PLANARCONFIG_CONTIG && poDS->nBands > 1)
8769
0
        {
8770
0
            GByte *pabyScanline = static_cast<GByte *>(
8771
0
                VSI_MALLOC_VERBOSE(TIFFScanlineSize(l_hTIFF)));
8772
0
            if (pabyScanline == nullptr)
8773
0
                eErr = CE_Failure;
8774
0
            for (int j = 0; j < nYSize && eErr == CE_None; ++j)
8775
0
            {
8776
0
                eErr = poSrcDS->RasterIO(GF_Read, 0, j, nXSize, 1, pabyScanline,
8777
0
                                         nXSize, 1, GDT_UInt8, l_nBands,
8778
0
                                         nullptr, poDS->nBands, 0, 1, nullptr);
8779
0
                if (eErr == CE_None &&
8780
0
                    TIFFWriteScanline(l_hTIFF, pabyScanline, j, 0) == -1)
8781
0
                {
8782
0
                    ReportError(pszFilename, CE_Failure, CPLE_AppDefined,
8783
0
                                "TIFFWriteScanline() failed.");
8784
0
                    eErr = CE_Failure;
8785
0
                }
8786
0
                if (!GDALScaledProgress((j + 1) * 1.0 / nYSize, nullptr,
8787
0
                                        pScaledData))
8788
0
                    eErr = CE_Failure;
8789
0
            }
8790
0
            CPLFree(pabyScanline);
8791
0
        }
8792
0
        else
8793
0
        {
8794
0
            GByte *pabyScanline =
8795
0
                static_cast<GByte *>(VSI_MALLOC_VERBOSE(nXSize));
8796
0
            if (pabyScanline == nullptr)
8797
0
                eErr = CE_Failure;
8798
0
            else
8799
0
                eErr = CE_None;
8800
0
            for (int iBand = 1; iBand <= l_nBands && eErr == CE_None; ++iBand)
8801
0
            {
8802
0
                for (int j = 0; j < nYSize && eErr == CE_None; ++j)
8803
0
                {
8804
0
                    eErr = poSrcDS->GetRasterBand(iBand)->RasterIO(
8805
0
                        GF_Read, 0, j, nXSize, 1, pabyScanline, nXSize, 1,
8806
0
                        GDT_UInt8, 0, 0, nullptr);
8807
0
                    if (poDS->m_bTreatAsSplitBitmap)
8808
0
                    {
8809
0
                        for (int i = 0; i < nXSize; ++i)
8810
0
                        {
8811
0
                            const GByte byVal = pabyScanline[i];
8812
0
                            if ((i & 0x7) == 0)
8813
0
                                pabyScanline[i >> 3] = 0;
8814
0
                            if (byVal)
8815
0
                                pabyScanline[i >> 3] |= 0x80 >> (i & 0x7);
8816
0
                        }
8817
0
                    }
8818
0
                    if (eErr == CE_None &&
8819
0
                        TIFFWriteScanline(l_hTIFF, pabyScanline, j,
8820
0
                                          static_cast<uint16_t>(iBand - 1)) ==
8821
0
                            -1)
8822
0
                    {
8823
0
                        ReportError(pszFilename, CE_Failure, CPLE_AppDefined,
8824
0
                                    "TIFFWriteScanline() failed.");
8825
0
                        eErr = CE_Failure;
8826
0
                    }
8827
0
                    if (!GDALScaledProgress((j + 1 + (iBand - 1) * nYSize) *
8828
0
                                                1.0 / (l_nBands * nYSize),
8829
0
                                            nullptr, pScaledData))
8830
0
                        eErr = CE_Failure;
8831
0
                }
8832
0
            }
8833
0
            CPLFree(pabyScanline);
8834
0
        }
8835
8836
        // Necessary to be able to read the file without re-opening.
8837
0
        TIFFSizeProc pfnSizeProc = TIFFGetSizeProc(l_hTIFF);
8838
8839
0
        TIFFFlushData(l_hTIFF);
8840
8841
0
        toff_t nNewDirOffset = pfnSizeProc(TIFFClientdata(l_hTIFF));
8842
0
        if ((nNewDirOffset % 2) == 1)
8843
0
            ++nNewDirOffset;
8844
8845
0
        TIFFFlush(l_hTIFF);
8846
8847
0
        if (poDS->m_nDirOffset != TIFFCurrentDirOffset(l_hTIFF))
8848
0
        {
8849
0
            poDS->m_nDirOffset = nNewDirOffset;
8850
0
            CPLDebug("GTiff", "directory moved during flush.");
8851
0
        }
8852
0
    }
8853
0
    else if (
8854
#if defined(HAVE_LIBJPEG) || defined(JPEG_DIRECT_COPY)
8855
        bTryCopy &&
8856
#endif
8857
0
        eErr == CE_None)
8858
0
    {
8859
0
        const char *papszCopyWholeRasterOptions[3] = {nullptr, nullptr,
8860
0
                                                      nullptr};
8861
0
        int iNextOption = 0;
8862
0
        papszCopyWholeRasterOptions[iNextOption++] = "SKIP_HOLES=YES";
8863
0
        if (l_nCompression != COMPRESSION_NONE)
8864
0
        {
8865
0
            papszCopyWholeRasterOptions[iNextOption++] = "COMPRESSED=YES";
8866
0
        }
8867
8868
        // For streaming with separate, we really want that bands are written
8869
        // after each other, even if the source is pixel interleaved.
8870
0
        else if (bStreaming && poDS->m_nPlanarConfig == PLANARCONFIG_SEPARATE)
8871
0
        {
8872
0
            papszCopyWholeRasterOptions[iNextOption++] = "INTERLEAVE=BAND";
8873
0
        }
8874
8875
0
        if (bCopySrcOverviews || bTileInterleaving)
8876
0
        {
8877
0
            poDS->m_bBlockOrderRowMajor = true;
8878
0
            poDS->m_bLeaderSizeAsUInt4 = bCopySrcOverviews;
8879
0
            poDS->m_bTrailerRepeatedLast4BytesRepeated = bCopySrcOverviews;
8880
0
            if (poDS->m_poMaskDS)
8881
0
            {
8882
0
                poDS->m_poMaskDS->m_bBlockOrderRowMajor = true;
8883
0
                poDS->m_poMaskDS->m_bLeaderSizeAsUInt4 = bCopySrcOverviews;
8884
0
                poDS->m_poMaskDS->m_bTrailerRepeatedLast4BytesRepeated =
8885
0
                    bCopySrcOverviews;
8886
0
                GDALDestroyScaledProgress(pScaledData);
8887
0
                pScaledData =
8888
0
                    GDALCreateScaledProgress(dfCurPixels / dfTotalPixels, 1.0,
8889
0
                                             pfnProgress, pProgressData);
8890
0
            }
8891
8892
0
            eErr = CopyImageryAndMask(poDS.get(), poSrcDS,
8893
0
                                      poSrcDS->GetRasterBand(1)->GetMaskBand(),
8894
0
                                      GDALScaledProgress, pScaledData);
8895
0
            if (poDS->m_poMaskDS)
8896
0
            {
8897
0
                bWriteMask = false;
8898
0
            }
8899
0
        }
8900
0
        else
8901
0
        {
8902
0
            eErr = GDALDatasetCopyWholeRaster(GDALDataset::ToHandle(poSrcDS),
8903
0
                                              GDALDataset::ToHandle(poDS.get()),
8904
0
                                              papszCopyWholeRasterOptions,
8905
0
                                              GDALScaledProgress, pScaledData);
8906
0
        }
8907
0
    }
8908
8909
0
    GDALDestroyScaledProgress(pScaledData);
8910
8911
0
    if (eErr == CE_None && !bStreaming && bWriteMask)
8912
0
    {
8913
0
        pScaledData = GDALCreateScaledProgress(dfNextCurPixels / dfTotalPixels,
8914
0
                                               1.0, pfnProgress, pProgressData);
8915
0
        if (poDS->m_poMaskDS)
8916
0
        {
8917
0
            const char *l_papszOptions[2] = {"COMPRESSED=YES", nullptr};
8918
0
            eErr = GDALRasterBandCopyWholeRaster(
8919
0
                poSrcDS->GetRasterBand(1)->GetMaskBand(),
8920
0
                poDS->GetRasterBand(1)->GetMaskBand(),
8921
0
                const_cast<char **>(l_papszOptions), GDALScaledProgress,
8922
0
                pScaledData);
8923
0
        }
8924
0
        else
8925
0
        {
8926
0
            eErr = GDALDriver::DefaultCopyMasks(poSrcDS, poDS.get(), bStrict,
8927
0
                                                nullptr, GDALScaledProgress,
8928
0
                                                pScaledData);
8929
0
        }
8930
0
        GDALDestroyScaledProgress(pScaledData);
8931
0
    }
8932
8933
0
    poDS->m_bWriteCOGLayout = false;
8934
8935
0
    if (eErr == CE_None &&
8936
0
        CPLTestBool(CSLFetchNameValueDef(poDS->m_papszCreationOptions,
8937
0
                                         "@FLUSHCACHE", "NO")))
8938
0
    {
8939
0
        if (poDS->FlushCache(false) != CE_None)
8940
0
        {
8941
0
            eErr = CE_Failure;
8942
0
        }
8943
0
    }
8944
8945
0
    if (eErr == CE_Failure)
8946
0
    {
8947
0
        if (CPLTestBool(CPLGetConfigOption("GTIFF_DELETE_ON_ERROR", "YES")))
8948
0
        {
8949
0
            l_fpL->CancelCreation();
8950
0
            poDS.reset();
8951
8952
0
            if (!bStreaming)
8953
0
            {
8954
                // Should really delete more carefully.
8955
0
                VSIUnlink(pszFilename);
8956
0
            }
8957
0
        }
8958
0
        else
8959
0
        {
8960
0
            poDS.reset();
8961
0
        }
8962
0
    }
8963
8964
0
    return poDS.release();
8965
0
}
8966
8967
/************************************************************************/
8968
/*                           SetSpatialRef()                            */
8969
/************************************************************************/
8970
8971
CPLErr GTiffDataset::SetSpatialRef(const OGRSpatialReference *poSRS)
8972
8973
0
{
8974
0
    if (m_bStreamingOut && m_bCrystalized)
8975
0
    {
8976
0
        ReportError(CE_Failure, CPLE_NotSupported,
8977
0
                    "Cannot modify projection at that point in "
8978
0
                    "a streamed output file");
8979
0
        return CE_Failure;
8980
0
    }
8981
8982
0
    LoadGeoreferencingAndPamIfNeeded();
8983
0
    LookForProjection();
8984
8985
0
    CPLErr eErr = CE_None;
8986
0
    if (eAccess == GA_Update)
8987
0
    {
8988
0
        if ((m_eProfile == GTiffProfile::BASELINE) &&
8989
0
            (GetPamFlags() & GPF_DISABLED) == 0)
8990
0
        {
8991
0
            eErr = GDALPamDataset::SetSpatialRef(poSRS);
8992
0
        }
8993
0
        else
8994
0
        {
8995
0
            if (GDALPamDataset::GetSpatialRef() != nullptr)
8996
0
            {
8997
                // Cancel any existing SRS from PAM file.
8998
0
                GDALPamDataset::SetSpatialRef(nullptr);
8999
0
            }
9000
0
            m_bGeoTIFFInfoChanged = true;
9001
0
        }
9002
0
    }
9003
0
    else
9004
0
    {
9005
0
        CPLDebug("GTIFF", "SetSpatialRef() goes to PAM instead of TIFF tags");
9006
0
        eErr = GDALPamDataset::SetSpatialRef(poSRS);
9007
0
    }
9008
9009
0
    if (eErr == CE_None)
9010
0
    {
9011
0
        if (poSRS == nullptr || poSRS->IsEmpty())
9012
0
        {
9013
0
            if (!m_oSRS.IsEmpty())
9014
0
            {
9015
0
                m_bForceUnsetProjection = true;
9016
0
            }
9017
0
            m_oSRS.Clear();
9018
0
        }
9019
0
        else
9020
0
        {
9021
0
            m_oSRS = *poSRS;
9022
0
            m_oSRS.SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER);
9023
0
        }
9024
0
    }
9025
9026
0
    return eErr;
9027
0
}
9028
9029
/************************************************************************/
9030
/*                          SetGeoTransform()                           */
9031
/************************************************************************/
9032
9033
CPLErr GTiffDataset::SetGeoTransform(const GDALGeoTransform &gt)
9034
9035
0
{
9036
0
    if (m_bStreamingOut && m_bCrystalized)
9037
0
    {
9038
0
        ReportError(CE_Failure, CPLE_NotSupported,
9039
0
                    "Cannot modify geotransform at that point in a "
9040
0
                    "streamed output file");
9041
0
        return CE_Failure;
9042
0
    }
9043
9044
0
    LoadGeoreferencingAndPamIfNeeded();
9045
9046
0
    CPLErr eErr = CE_None;
9047
0
    if (eAccess == GA_Update)
9048
0
    {
9049
0
        if (!m_aoGCPs.empty())
9050
0
        {
9051
0
            ReportError(CE_Warning, CPLE_AppDefined,
9052
0
                        "GCPs previously set are going to be cleared "
9053
0
                        "due to the setting of a geotransform.");
9054
0
            m_bForceUnsetGTOrGCPs = true;
9055
0
            m_aoGCPs.clear();
9056
0
        }
9057
0
        else if (gt.xorig == 0.0 && gt.xscale == 0.0 && gt.xrot == 0.0 &&
9058
0
                 gt.yorig == 0.0 && gt.yrot == 0.0 && gt.yscale == 0.0)
9059
0
        {
9060
0
            if (m_bGeoTransformValid)
9061
0
            {
9062
0
                m_bForceUnsetGTOrGCPs = true;
9063
0
                m_bGeoTIFFInfoChanged = true;
9064
0
            }
9065
0
            m_bGeoTransformValid = false;
9066
0
            m_gt = gt;
9067
0
            return CE_None;
9068
0
        }
9069
9070
0
        if ((m_eProfile == GTiffProfile::BASELINE) &&
9071
0
            !CPLFetchBool(m_papszCreationOptions, "TFW", false) &&
9072
0
            !CPLFetchBool(m_papszCreationOptions, "WORLDFILE", false) &&
9073
0
            (GetPamFlags() & GPF_DISABLED) == 0)
9074
0
        {
9075
0
            eErr = GDALPamDataset::SetGeoTransform(gt);
9076
0
        }
9077
0
        else
9078
0
        {
9079
            // Cancel any existing geotransform from PAM file.
9080
0
            GDALPamDataset::DeleteGeoTransform();
9081
0
            m_bGeoTIFFInfoChanged = true;
9082
0
        }
9083
0
    }
9084
0
    else
9085
0
    {
9086
0
        CPLDebug("GTIFF", "SetGeoTransform() goes to PAM instead of TIFF tags");
9087
0
        eErr = GDALPamDataset::SetGeoTransform(gt);
9088
0
    }
9089
9090
0
    if (eErr == CE_None)
9091
0
    {
9092
0
        m_gt = gt;
9093
0
        m_bGeoTransformValid = true;
9094
0
    }
9095
9096
0
    return eErr;
9097
0
}
9098
9099
/************************************************************************/
9100
/*                              SetGCPs()                               */
9101
/************************************************************************/
9102
9103
CPLErr GTiffDataset::SetGCPs(int nGCPCountIn, const GDAL_GCP *pasGCPListIn,
9104
                             const OGRSpatialReference *poGCPSRS)
9105
0
{
9106
0
    CPLErr eErr = CE_None;
9107
0
    LoadGeoreferencingAndPamIfNeeded();
9108
0
    LookForProjection();
9109
9110
0
    if (eAccess == GA_Update)
9111
0
    {
9112
0
        if (!m_aoGCPs.empty() && nGCPCountIn == 0)
9113
0
        {
9114
0
            m_bForceUnsetGTOrGCPs = true;
9115
0
        }
9116
0
        else if (nGCPCountIn > 0 && m_bGeoTransformValid)
9117
0
        {
9118
0
            ReportError(CE_Warning, CPLE_AppDefined,
9119
0
                        "A geotransform previously set is going to be cleared "
9120
0
                        "due to the setting of GCPs.");
9121
0
            m_gt = GDALGeoTransform();
9122
0
            m_bGeoTransformValid = false;
9123
0
            m_bForceUnsetGTOrGCPs = true;
9124
0
        }
9125
0
        if ((m_eProfile == GTiffProfile::BASELINE) &&
9126
0
            (GetPamFlags() & GPF_DISABLED) == 0)
9127
0
        {
9128
0
            eErr = GDALPamDataset::SetGCPs(nGCPCountIn, pasGCPListIn, poGCPSRS);
9129
0
        }
9130
0
        else
9131
0
        {
9132
0
            if (nGCPCountIn > knMAX_GCP_COUNT)
9133
0
            {
9134
0
                if (GDALPamDataset::GetGCPCount() == 0 && !m_aoGCPs.empty())
9135
0
                {
9136
0
                    m_bForceUnsetGTOrGCPs = true;
9137
0
                }
9138
0
                ReportError(CE_Warning, CPLE_AppDefined,
9139
0
                            "Trying to write %d GCPs, whereas the maximum "
9140
0
                            "supported in GeoTIFF tag is %d. "
9141
0
                            "Falling back to writing them to PAM",
9142
0
                            nGCPCountIn, knMAX_GCP_COUNT);
9143
0
                eErr = GDALPamDataset::SetGCPs(nGCPCountIn, pasGCPListIn,
9144
0
                                               poGCPSRS);
9145
0
            }
9146
0
            else if (GDALPamDataset::GetGCPCount() > 0)
9147
0
            {
9148
                // Cancel any existing GCPs from PAM file.
9149
0
                GDALPamDataset::SetGCPs(
9150
0
                    0, nullptr,
9151
0
                    static_cast<const OGRSpatialReference *>(nullptr));
9152
0
            }
9153
0
            m_bGeoTIFFInfoChanged = true;
9154
0
        }
9155
0
    }
9156
0
    else
9157
0
    {
9158
0
        CPLDebug("GTIFF", "SetGCPs() goes to PAM instead of TIFF tags");
9159
0
        eErr = GDALPamDataset::SetGCPs(nGCPCountIn, pasGCPListIn, poGCPSRS);
9160
0
    }
9161
9162
0
    if (eErr == CE_None)
9163
0
    {
9164
0
        if (poGCPSRS == nullptr || poGCPSRS->IsEmpty())
9165
0
        {
9166
0
            if (!m_oSRS.IsEmpty())
9167
0
            {
9168
0
                m_bForceUnsetProjection = true;
9169
0
            }
9170
0
            m_oSRS.Clear();
9171
0
        }
9172
0
        else
9173
0
        {
9174
0
            m_oSRS = *poGCPSRS;
9175
0
            m_oSRS.SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER);
9176
0
        }
9177
9178
0
        m_aoGCPs = gdal::GCP::fromC(pasGCPListIn, nGCPCountIn);
9179
0
    }
9180
9181
0
    return eErr;
9182
0
}
9183
9184
/************************************************************************/
9185
/*                            SetMetadata()                             */
9186
/************************************************************************/
9187
CPLErr GTiffDataset::SetMetadata(CSLConstList papszMD, const char *pszDomain)
9188
9189
0
{
9190
0
    LoadGeoreferencingAndPamIfNeeded();
9191
9192
0
    if (m_bStreamingOut && m_bCrystalized)
9193
0
    {
9194
0
        ReportError(
9195
0
            CE_Failure, CPLE_NotSupported,
9196
0
            "Cannot modify metadata at that point in a streamed output file");
9197
0
        return CE_Failure;
9198
0
    }
9199
9200
0
    if (pszDomain && EQUAL(pszDomain, "json:ISIS3"))
9201
0
    {
9202
0
        m_oISIS3Metadata.Deinit();
9203
0
        m_oMapISIS3MetadataItems.clear();
9204
0
    }
9205
9206
0
    CPLErr eErr = CE_None;
9207
0
    if (eAccess == GA_Update)
9208
0
    {
9209
0
        if (pszDomain != nullptr && EQUAL(pszDomain, MD_DOMAIN_RPC))
9210
0
        {
9211
            // So that a subsequent GetMetadata() wouldn't override our new
9212
            // values
9213
0
            LoadMetadata();
9214
0
            m_bForceUnsetRPC = (CSLCount(papszMD) == 0);
9215
0
        }
9216
9217
0
        if ((papszMD != nullptr) && (pszDomain != nullptr) &&
9218
0
            EQUAL(pszDomain, "COLOR_PROFILE"))
9219
0
        {
9220
0
            m_bColorProfileMetadataChanged = true;
9221
0
        }
9222
0
        else if (pszDomain == nullptr || !EQUAL(pszDomain, "_temporary_"))
9223
0
        {
9224
0
            m_bMetadataChanged = true;
9225
            // Cancel any existing metadata from PAM file.
9226
0
            if (GDALPamDataset::GetMetadata(pszDomain) != nullptr)
9227
0
                GDALPamDataset::SetMetadata(nullptr, pszDomain);
9228
0
        }
9229
9230
0
        if ((pszDomain == nullptr || EQUAL(pszDomain, "")) &&
9231
0
            CSLFetchNameValue(papszMD, GDALMD_AREA_OR_POINT) != nullptr)
9232
0
        {
9233
0
            const char *pszPrevValue = GetMetadataItem(GDALMD_AREA_OR_POINT);
9234
0
            const char *pszNewValue =
9235
0
                CSLFetchNameValue(papszMD, GDALMD_AREA_OR_POINT);
9236
0
            if (pszPrevValue == nullptr || pszNewValue == nullptr ||
9237
0
                !EQUAL(pszPrevValue, pszNewValue))
9238
0
            {
9239
0
                LookForProjection();
9240
0
                m_bGeoTIFFInfoChanged = true;
9241
0
            }
9242
0
        }
9243
9244
0
        if (pszDomain != nullptr && EQUAL(pszDomain, "xml:XMP"))
9245
0
        {
9246
0
            if (papszMD != nullptr && *papszMD != nullptr)
9247
0
            {
9248
0
                int nTagSize = static_cast<int>(strlen(*papszMD));
9249
0
                TIFFSetField(m_hTIFF, TIFFTAG_XMLPACKET, nTagSize, *papszMD);
9250
0
            }
9251
0
            else
9252
0
            {
9253
0
                TIFFUnsetField(m_hTIFF, TIFFTAG_XMLPACKET);
9254
0
            }
9255
0
        }
9256
0
    }
9257
0
    else
9258
0
    {
9259
0
        CPLDebug(
9260
0
            "GTIFF",
9261
0
            "GTiffDataset::SetMetadata() goes to PAM instead of TIFF tags");
9262
0
        eErr = GDALPamDataset::SetMetadata(papszMD, pszDomain);
9263
0
    }
9264
9265
0
    if (eErr == CE_None)
9266
0
    {
9267
0
        eErr = m_oGTiffMDMD.SetMetadata(papszMD, pszDomain);
9268
0
    }
9269
0
    return eErr;
9270
0
}
9271
9272
/************************************************************************/
9273
/*                          SetMetadataItem()                           */
9274
/************************************************************************/
9275
9276
CPLErr GTiffDataset::SetMetadataItem(const char *pszName, const char *pszValue,
9277
                                     const char *pszDomain)
9278
9279
0
{
9280
0
    LoadGeoreferencingAndPamIfNeeded();
9281
9282
0
    if (m_bStreamingOut && m_bCrystalized)
9283
0
    {
9284
0
        ReportError(
9285
0
            CE_Failure, CPLE_NotSupported,
9286
0
            "Cannot modify metadata at that point in a streamed output file");
9287
0
        return CE_Failure;
9288
0
    }
9289
9290
0
    if (pszDomain && EQUAL(pszDomain, "json:ISIS3"))
9291
0
    {
9292
0
        ReportError(CE_Failure, CPLE_NotSupported,
9293
0
                    "Updating part of json:ISIS3 is not supported. "
9294
0
                    "Use SetMetadata() instead");
9295
0
        return CE_Failure;
9296
0
    }
9297
9298
0
    CPLErr eErr = CE_None;
9299
0
    if (eAccess == GA_Update)
9300
0
    {
9301
0
        if ((pszDomain != nullptr) && EQUAL(pszDomain, "COLOR_PROFILE"))
9302
0
        {
9303
0
            m_bColorProfileMetadataChanged = true;
9304
0
        }
9305
0
        else if (pszDomain == nullptr || !EQUAL(pszDomain, "_temporary_"))
9306
0
        {
9307
0
            m_bMetadataChanged = true;
9308
            // Cancel any existing metadata from PAM file.
9309
0
            if (GDALPamDataset::GetMetadataItem(pszName, pszDomain) != nullptr)
9310
0
                GDALPamDataset::SetMetadataItem(pszName, nullptr, pszDomain);
9311
0
        }
9312
9313
0
        if ((pszDomain == nullptr || EQUAL(pszDomain, "")) &&
9314
0
            pszName != nullptr && EQUAL(pszName, GDALMD_AREA_OR_POINT))
9315
0
        {
9316
0
            LookForProjection();
9317
0
            m_bGeoTIFFInfoChanged = true;
9318
0
        }
9319
0
    }
9320
0
    else
9321
0
    {
9322
0
        CPLDebug(
9323
0
            "GTIFF",
9324
0
            "GTiffDataset::SetMetadataItem() goes to PAM instead of TIFF tags");
9325
0
        eErr = GDALPamDataset::SetMetadataItem(pszName, pszValue, pszDomain);
9326
0
    }
9327
9328
0
    if (eErr == CE_None)
9329
0
    {
9330
0
        eErr = m_oGTiffMDMD.SetMetadataItem(pszName, pszValue, pszDomain);
9331
0
    }
9332
9333
0
    return eErr;
9334
0
}
9335
9336
/************************************************************************/
9337
/*                           CreateMaskBand()                           */
9338
/************************************************************************/
9339
9340
CPLErr GTiffDataset::CreateMaskBand(int nFlagsIn)
9341
0
{
9342
0
    ScanDirectories();
9343
9344
0
    if (m_poMaskDS != nullptr)
9345
0
    {
9346
0
        ReportError(CE_Failure, CPLE_AppDefined,
9347
0
                    "This TIFF dataset has already an internal mask band");
9348
0
        return CE_Failure;
9349
0
    }
9350
0
    else if (MustCreateInternalMask())
9351
0
    {
9352
0
        if (nFlagsIn != GMF_PER_DATASET)
9353
0
        {
9354
0
            ReportError(CE_Failure, CPLE_AppDefined,
9355
0
                        "The only flag value supported for internal mask is "
9356
0
                        "GMF_PER_DATASET");
9357
0
            return CE_Failure;
9358
0
        }
9359
9360
0
        int l_nCompression = COMPRESSION_PACKBITS;
9361
0
        if (strstr(GDALGetMetadataItem(GDALGetDriverByName("GTiff"),
9362
0
                                       GDAL_DMD_CREATIONOPTIONLIST, nullptr),
9363
0
                   "<Value>DEFLATE</Value>") != nullptr)
9364
0
            l_nCompression = COMPRESSION_ADOBE_DEFLATE;
9365
9366
        /* --------------------------------------------------------------------
9367
         */
9368
        /*      If we don't have read access, then create the mask externally.
9369
         */
9370
        /* --------------------------------------------------------------------
9371
         */
9372
0
        if (GetAccess() != GA_Update)
9373
0
        {
9374
0
            ReportError(CE_Warning, CPLE_AppDefined,
9375
0
                        "File open for read-only accessing, "
9376
0
                        "creating mask externally.");
9377
9378
0
            return GDALPamDataset::CreateMaskBand(nFlagsIn);
9379
0
        }
9380
9381
0
        if (m_bLayoutIFDSBeforeData && !m_bKnownIncompatibleEdition &&
9382
0
            !m_bWriteKnownIncompatibleEdition)
9383
0
        {
9384
0
            ReportError(CE_Warning, CPLE_AppDefined,
9385
0
                        "Adding a mask invalidates the "
9386
0
                        "LAYOUT=IFDS_BEFORE_DATA property");
9387
0
            m_bKnownIncompatibleEdition = true;
9388
0
            m_bWriteKnownIncompatibleEdition = true;
9389
0
        }
9390
9391
0
        bool bIsOverview = false;
9392
0
        uint32_t nSubType = 0;
9393
0
        if (TIFFGetField(m_hTIFF, TIFFTAG_SUBFILETYPE, &nSubType))
9394
0
        {
9395
0
            bIsOverview = (nSubType & FILETYPE_REDUCEDIMAGE) != 0;
9396
9397
0
            if ((nSubType & FILETYPE_MASK) != 0)
9398
0
            {
9399
0
                ReportError(CE_Failure, CPLE_AppDefined,
9400
0
                            "Cannot create a mask on a TIFF mask IFD !");
9401
0
                return CE_Failure;
9402
0
            }
9403
0
        }
9404
9405
0
        const int bIsTiled = TIFFIsTiled(m_hTIFF);
9406
9407
0
        FlushDirectory();
9408
9409
0
        const toff_t nOffset = GTIFFWriteDirectory(
9410
0
            m_hTIFF,
9411
0
            bIsOverview ? FILETYPE_REDUCEDIMAGE | FILETYPE_MASK : FILETYPE_MASK,
9412
0
            nRasterXSize, nRasterYSize, 1, PLANARCONFIG_CONTIG, 1,
9413
0
            m_nBlockXSize, m_nBlockYSize, bIsTiled, l_nCompression,
9414
0
            PHOTOMETRIC_MASK, PREDICTOR_NONE, SAMPLEFORMAT_UINT, nullptr,
9415
0
            nullptr, nullptr, 0, nullptr, "", nullptr, nullptr, nullptr,
9416
0
            nullptr, m_bWriteCOGLayout);
9417
9418
0
        ReloadDirectory();
9419
9420
0
        if (nOffset == 0)
9421
0
            return CE_Failure;
9422
9423
0
        m_poMaskDS = std::make_shared<GTiffDataset>();
9424
0
        m_poMaskDS->eAccess = GA_Update;
9425
0
        m_poMaskDS->m_poBaseDS = this;
9426
0
        m_poMaskDS->m_poImageryDS = this;
9427
0
        m_poMaskDS->ShareLockWithParentDataset(this);
9428
0
        m_poMaskDS->m_osFilename = m_osFilename;
9429
0
        m_poMaskDS->m_bPromoteTo8Bits = CPLTestBool(
9430
0
            CPLGetConfigOption("GDAL_TIFF_INTERNAL_MASK_TO_8BIT", "YES"));
9431
0
        return m_poMaskDS->OpenOffset(VSI_TIFFOpenChild(m_hTIFF), nOffset,
9432
0
                                      GA_Update);
9433
0
    }
9434
9435
0
    return GDALPamDataset::CreateMaskBand(nFlagsIn);
9436
0
}
9437
9438
/************************************************************************/
9439
/*                       MustCreateInternalMask()                       */
9440
/************************************************************************/
9441
9442
bool GTiffDataset::MustCreateInternalMask()
9443
0
{
9444
0
    return CPLTestBool(CPLGetConfigOption("GDAL_TIFF_INTERNAL_MASK", "YES"));
9445
0
}
9446
9447
/************************************************************************/
9448
/*                           CreateMaskBand()                           */
9449
/************************************************************************/
9450
9451
CPLErr GTiffRasterBand::CreateMaskBand(int nFlagsIn)
9452
0
{
9453
0
    m_poGDS->ScanDirectories();
9454
9455
0
    if (m_poGDS->m_poMaskDS != nullptr)
9456
0
    {
9457
0
        ReportError(CE_Failure, CPLE_AppDefined,
9458
0
                    "This TIFF dataset has already an internal mask band");
9459
0
        return CE_Failure;
9460
0
    }
9461
9462
0
    const char *pszGDAL_TIFF_INTERNAL_MASK =
9463
0
        CPLGetConfigOption("GDAL_TIFF_INTERNAL_MASK", nullptr);
9464
0
    if ((pszGDAL_TIFF_INTERNAL_MASK &&
9465
0
         CPLTestBool(pszGDAL_TIFF_INTERNAL_MASK)) ||
9466
0
        nFlagsIn == GMF_PER_DATASET)
9467
0
    {
9468
0
        return m_poGDS->CreateMaskBand(nFlagsIn);
9469
0
    }
9470
9471
0
    return GDALPamRasterBand::CreateMaskBand(nFlagsIn);
9472
0
}
9473
9474
/************************************************************************/
9475
/*                            ClampCTEntry()                            */
9476
/************************************************************************/
9477
9478
/* static */ unsigned short GTiffDataset::ClampCTEntry(int iColor, int iComp,
9479
                                                       int nCTEntryVal,
9480
                                                       int nMultFactor)
9481
0
{
9482
0
    const int nVal = nCTEntryVal * nMultFactor;
9483
0
    if (nVal < 0)
9484
0
    {
9485
0
        CPLError(CE_Warning, CPLE_AppDefined,
9486
0
                 "Color table entry [%d][%d] = %d, clamped to 0", iColor, iComp,
9487
0
                 nCTEntryVal);
9488
0
        return 0;
9489
0
    }
9490
0
    if (nVal > 65535)
9491
0
    {
9492
0
        CPLError(CE_Warning, CPLE_AppDefined,
9493
0
                 "Color table entry [%d][%d] = %d, clamped to 65535", iColor,
9494
0
                 iComp, nCTEntryVal);
9495
0
        return 65535;
9496
0
    }
9497
0
    return static_cast<unsigned short>(nVal);
9498
0
}