Coverage Report

Created: 2025-08-28 06:57

/src/gdal/apps/gdal_translate_lib.cpp
Line
Count
Source (jump to first uncovered line)
1
/******************************************************************************
2
 *
3
 * Project:  GDAL Utilities
4
 * Purpose:  GDAL Image Translator Program
5
 * Author:   Frank Warmerdam, warmerdam@pobox.com
6
 *
7
 ******************************************************************************
8
 * Copyright (c) 1998, 2002, Frank Warmerdam
9
 * Copyright (c) 2007-2015, Even Rouault <even dot rouault at spatialys.com>
10
 * Copyright (c) 2015, Faza Mahamood
11
 *
12
 * SPDX-License-Identifier: MIT
13
 ****************************************************************************/
14
15
#include "cpl_port.h"
16
#include "gdal_utils.h"
17
#include "gdal_utils_priv.h"
18
#include "gdalargumentparser.h"
19
20
#include <cmath>
21
#include <cstdlib>
22
#include <cstring>
23
24
#include <algorithm>
25
#include <array>
26
#include <limits>
27
#include <set>
28
29
#include "commonutils.h"
30
#include "cpl_conv.h"
31
#include "cpl_error.h"
32
#include "cpl_json.h"
33
#include "cpl_progress.h"
34
#include "cpl_string.h"
35
#include "cpl_vsi.h"
36
#include "gdal.h"
37
#include "gdal_priv.h"
38
#include "gdal_priv_templates.hpp"
39
#include "gdal_rat.h"
40
#include "gdal_vrt.h"
41
#include "ogr_core.h"
42
#include "ogr_spatialref.h"
43
#include "vrtdataset.h"
44
45
static void AttachMetadata(GDALDatasetH, const CPLStringList &);
46
static void AttachDomainMetadata(GDALDatasetH, const CPLStringList &);
47
48
static void CopyBandInfo(GDALRasterBand *poSrcBand, GDALRasterBand *poDstBand,
49
                         int bCanCopyStatsMetadata, int bCopyScale,
50
                         int bCopyNoData, bool bCopyRAT,
51
                         const GDALTranslateOptions *psOptions);
52
53
typedef enum
54
{
55
    MASK_DISABLED,
56
    MASK_AUTO,
57
    MASK_USER
58
} MaskMode;
59
60
/************************************************************************/
61
/*                         GDALTranslateScaleParams                     */
62
/************************************************************************/
63
64
/** scaling parameters for use in GDALTranslateOptions.
65
 */
66
struct GDALTranslateScaleParams
67
{
68
    /*! scaling is done only if it is set to TRUE. This is helpful when there is
69
       a need to scale only certain bands. */
70
    bool bScale = false;
71
72
    /*! the range of input pixel values which need to be scaled.
73
        If not set, the input range is automatically computed from the source data. */
74
    double dfScaleSrcMin = std::numeric_limits<double>::quiet_NaN();
75
    double dfScaleSrcMax = std::numeric_limits<double>::quiet_NaN();
76
77
    /*! the range of output pixel values. */
78
    double dfScaleDstMin = std::numeric_limits<double>::quiet_NaN();
79
    double dfScaleDstMax = std::numeric_limits<double>::quiet_NaN();
80
};
81
82
/************************************************************************/
83
/*                         GDALTranslateOptions                         */
84
/************************************************************************/
85
86
/** Options for use with GDALTranslate(). GDALTranslateOptions* must be
87
 * allocated and freed with GDALTranslateOptionsNew() and
88
 * GDALTranslateOptionsFree() respectively.
89
 */
90
struct GDALTranslateOptions
91
{
92
93
    /*! output format. Use the short format name. */
94
    std::string osFormat{};
95
96
    /*! allow or suppress progress monitor and other non-error output */
97
    bool bQuiet = false;
98
99
    /*! the progress function to use */
100
    GDALProgressFunc pfnProgress = GDALDummyProgress;
101
102
    /*! pointer to the progress data variable */
103
    void *pProgressData = nullptr;
104
105
    /*! for the output bands to be of the indicated data type */
106
    GDALDataType eOutputType = GDT_Unknown;
107
108
    /*! Used only by parser logic */
109
    bool bParsedMaskArgument = false;
110
111
    MaskMode eMaskMode = MASK_AUTO;
112
113
    /*! number of input bands to write to the output file, or to reorder bands
114
     */
115
    int nBandCount = 0;
116
117
    /*! list of input bands to write to the output file, or to reorder bands.
118
       The value 1 corresponds to the 1st band. */
119
    std::vector<int> anBandList{}; /* negative value of panBandList[i] means
120
                                      mask band of ABS(panBandList[i]) */
121
122
    /*! size of the output file. GDALTranslateOptions::nOXSizePixel is in pixels
123
       and GDALTranslateOptions::nOYSizePixel is in lines. If one of the two
124
       values is set to 0, its value will be determined from the other one,
125
       while maintaining the aspect ratio of the source dataset */
126
    int nOXSizePixel = 0;
127
    int nOYSizePixel = 0;
128
129
    /*! size of the output file. GDALTranslateOptions::dfOXSizePct and
130
       GDALTranslateOptions::dfOYSizePct are fraction of the input image size.
131
       The value 100 means 100%. If one of the two values is set to 0, its value
132
       will be determined from the other one, while maintaining the aspect ratio
133
       of the source dataset */
134
    double dfOXSizePct = 0;
135
    double dfOYSizePct = 0;
136
137
    /*! list of creation options to the output format driver */
138
    CPLStringList aosCreateOptions{};
139
140
    /*! subwindow from the source image for copying based on pixel/line location
141
     */
142
    struct PixelLineWindow
143
    {
144
        double dfXOff{0};
145
        double dfYOff{0};
146
        double dfXSize{0};
147
        double dfYSize{0};
148
    };
149
150
    PixelLineWindow srcWin{};
151
152
    /*! don't be forgiving of mismatches and lost data when translating to the
153
     * output format */
154
    bool bStrict = false;
155
156
    /*! apply the scale/offset metadata for the bands to convert scaled values
157
     * to unscaled values. It is also often necessary to reset the output
158
     * datatype with GDALTranslateOptions::eOutputType */
159
    bool bUnscale = false;
160
161
    bool bSetScale = false;
162
163
    double dfScale = 1;
164
165
    bool bSetOffset = false;
166
167
    double dfOffset = 0;
168
169
    /*! the list of scale parameters for each band. */
170
    std::vector<GDALTranslateScaleParams> asScaleParams{};
171
172
    /*! It is set to TRUE, when scale parameters are specific to each band */
173
    bool bHasUsedExplicitScaleBand = false;
174
175
    bool bNoClip = false;
176
177
    /*! to apply non-linear scaling with a power function. It is the list of
178
       exponents of the power function (must be positive). This option must be
179
       used with GDALTranslateOptions::asScaleParams. If
180
        GDALTranslateOptions::adfExponent.size() is 1, it is applied to all
181
       bands of the output image. */
182
    std::vector<double> adfExponent{};
183
184
    bool bHasUsedExplicitExponentBand = false;
185
186
    /*! list of metadata key and value to set on the output dataset if possible. */
187
    CPLStringList aosMetadataOptions{};
188
189
    /*! list of metadata key and value in a domain to set on the output dataset if possible. */
190
    CPLStringList aosDomainMetadataOptions{};
191
192
    /*! override the projection for the output file. The SRS may be any of the
193
       usual GDAL/OGR forms, complete WKT, PROJ.4, EPSG:n or a file containing
194
       the WKT. */
195
    std::string osOutputSRS{};
196
197
    /*! Coordinate epoch of output SRS */
198
    double dfOutputCoordinateEpoch = 0;
199
200
    /*! does not copy source GCP into destination dataset (when TRUE) */
201
    bool bNoGCP = false;
202
203
    /*! list of GCPs to be added to the output dataset */
204
    std::vector<gdal::GCP> asGCPs{};
205
206
    /*! assign/override the georeferenced bounds of the output file. This
207
       assigns georeferenced bounds to the output file, ignoring what would have
208
       been derived from the source file. So this does not cause reprojection to
209
       the specified SRS. */
210
    std::array<double, 4> adfULLR{{0, 0, 0, 0}};
211
212
    /*! assign/override the geotransform of the output file. This
213
       assigns a geotransform to the output file, ignoring what would have
214
       been derived from the source file. So this does not cause reprojection to
215
       the specified SRS. */
216
    GDALGeoTransform gt{0.0, 0.0, 0.0, 0.0, 0.0, 0.0};
217
218
    /*! set a nodata value specified in GDALTranslateOptions::osNoData to the
219
     * output bands */
220
    bool bSetNoData = 0;
221
222
    /*! avoid setting a nodata value to the output file if one exists for the
223
     * source file */
224
    bool bUnsetNoData = 0;
225
226
    /*! Assign a specified nodata value to output bands (
227
       GDALTranslateOptions::bSetNoData option should be set). Note that if the
228
       input dataset has a nodata value, this does not cause pixel values that
229
       are equal to that nodata value to be changed to the value specified. */
230
    std::string osNoData{};
231
232
    /*! to expose a dataset with 1 band with a color table as a dataset with
233
        3 (RGB) or 4 (RGBA) bands. Useful for output drivers such as JPEG,
234
        JPEG2000, MrSID, ECW that don't support color indexed datasets.
235
        The 1 value enables to expand a dataset with a color table that only
236
        contains gray levels to a gray indexed dataset. */
237
    int nRGBExpand = 0;
238
239
    int nMaskBand = 0; /* negative value means mask band of ABS(nMaskBand) */
240
241
    /*! force recomputation of statistics */
242
    bool bStats = false;
243
244
    bool bApproxStats = false;
245
246
    /*! If this option is set, GDALTranslateOptions::adfSrcWin or
247
       (GDALTranslateOptions::dfULX, GDALTranslateOptions::dfULY,
248
       GDALTranslateOptions::dfLRX, GDALTranslateOptions::dfLRY) values that
249
       falls partially outside the source raster extent will be considered as an
250
       error. The default behavior is to accept such requests. */
251
    bool bErrorOnPartiallyOutside = false;
252
253
    /*! Same as bErrorOnPartiallyOutside, except that the criterion for
254
        erroring out is when the request falls completely outside the
255
        source raster extent. */
256
    bool bErrorOnCompletelyOutside = false;
257
258
    /*! does not copy source RAT into destination dataset (when TRUE) */
259
    bool bNoRAT = false;
260
261
    /*! resampling algorithm
262
        nearest (default), bilinear, cubic, cubicspline, lanczos, average, mode
263
     */
264
    std::string osResampling{};
265
266
    /*! target resolution. The values must be expressed in georeferenced units.
267
        Both must be positive values. This is exclusive with
268
       GDALTranslateOptions::nOXSizePixel (or
269
       GDALTranslateOptions::dfOXSizePct), GDALTranslateOptions::nOYSizePixel
270
        (or GDALTranslateOptions::dfOYSizePct), GDALTranslateOptions::adfULLR,
271
        and GDALTranslateOptions::gt.
272
     */
273
    double dfXRes = 0;
274
    double dfYRes = 0;
275
276
    /*! subwindow from the source image for copying (like
277
       GDALTranslateOptions::adfSrcWin) but with the corners given in
278
       georeferenced coordinates (by default expressed in the SRS of the
279
       dataset. Can be changed with osProjSRS) */
280
    double dfULX = 0;
281
    double dfULY = 0;
282
    double dfLRX = 0;
283
    double dfLRY = 0;
284
285
    /*! SRS in which to interpret the coordinates given with
286
       GDALTranslateOptions::dfULX, GDALTranslateOptions::dfULY,
287
       GDALTranslateOptions::dfLRX, GDALTranslateOptions::dfLRY. The SRS may be
288
       any of the usual GDAL/OGR forms, complete WKT, PROJ.4, EPSG:n or a file
289
       containing the WKT. Note that this does not cause reprojection of the
290
        dataset to the specified SRS. */
291
    std::string osProjSRS{};
292
293
    int nLimitOutSize = 0;
294
295
    // Array of color interpretations per band. Should be a GDALColorInterp
296
    // value, or -1 if no override.
297
    std::vector<int> anColorInterp{};
298
299
    /*! does not copy source XMP into destination dataset (when TRUE) */
300
    bool bNoXMP = false;
301
302
    /*! overview level of source file to be used */
303
    int nOvLevel = OVR_LEVEL_AUTO;
304
305
    /*! set to true to prevent overwriting existing dataset */
306
    bool bNoOverwrite = false;
307
308
0
    GDALTranslateOptions() = default;
309
0
    GDALTranslateOptions(const GDALTranslateOptions &) = default;
310
    GDALTranslateOptions &operator=(const GDALTranslateOptions &) = delete;
311
};
312
313
/************************************************************************/
314
/*                              SrcToDst()                              */
315
/************************************************************************/
316
317
static void SrcToDst(double dfX, double dfY, double dfSrcXOff, double dfSrcYOff,
318
                     double dfSrcXSize, double dfSrcYSize, double dfDstXOff,
319
                     double dfDstYOff, double dfDstXSize, double dfDstYSize,
320
                     double &dfXOut, double &dfYOut)
321
322
0
{
323
0
    dfXOut = ((dfX - dfSrcXOff) / dfSrcXSize) * dfDstXSize + dfDstXOff;
324
0
    dfYOut = ((dfY - dfSrcYOff) / dfSrcYSize) * dfDstYSize + dfDstYOff;
325
0
}
326
327
/************************************************************************/
328
/*                          GetSrcDstWindow()                           */
329
/************************************************************************/
330
331
static bool FixSrcDstWindow(GDALTranslateOptions::PixelLineWindow &srcWin,
332
                            GDALTranslateOptions::PixelLineWindow &dstWin,
333
                            int nSrcRasterXSize, int nSrcRasterYSize)
334
335
0
{
336
0
    const double dfSrcXOff = srcWin.dfXOff;
337
0
    const double dfSrcYOff = srcWin.dfYOff;
338
0
    const double dfSrcXSize = srcWin.dfXSize;
339
0
    const double dfSrcYSize = srcWin.dfYSize;
340
341
0
    const double dfDstXOff = dstWin.dfXOff;
342
0
    const double dfDstYOff = dstWin.dfYOff;
343
0
    const double dfDstXSize = dstWin.dfXSize;
344
0
    const double dfDstYSize = dstWin.dfYSize;
345
346
0
    bool bModifiedX = false;
347
0
    bool bModifiedY = false;
348
349
0
    double dfModifiedSrcXOff = dfSrcXOff;
350
0
    double dfModifiedSrcYOff = dfSrcYOff;
351
352
0
    double dfModifiedSrcXSize = dfSrcXSize;
353
0
    double dfModifiedSrcYSize = dfSrcYSize;
354
355
    /* -------------------------------------------------------------------- */
356
    /*      Clamp within the bounds of the available source data.           */
357
    /* -------------------------------------------------------------------- */
358
0
    if (dfModifiedSrcXOff < 0)
359
0
    {
360
0
        dfModifiedSrcXSize += dfModifiedSrcXOff;
361
0
        dfModifiedSrcXOff = 0;
362
363
0
        bModifiedX = true;
364
0
    }
365
366
0
    if (dfModifiedSrcYOff < 0)
367
0
    {
368
0
        dfModifiedSrcYSize += dfModifiedSrcYOff;
369
0
        dfModifiedSrcYOff = 0;
370
0
        bModifiedY = true;
371
0
    }
372
373
0
    if (dfModifiedSrcXOff + dfModifiedSrcXSize > nSrcRasterXSize)
374
0
    {
375
0
        dfModifiedSrcXSize = nSrcRasterXSize - dfModifiedSrcXOff;
376
0
        bModifiedX = true;
377
0
    }
378
379
0
    if (dfModifiedSrcYOff + dfModifiedSrcYSize > nSrcRasterYSize)
380
0
    {
381
0
        dfModifiedSrcYSize = nSrcRasterYSize - dfModifiedSrcYOff;
382
0
        bModifiedY = true;
383
0
    }
384
385
    /* -------------------------------------------------------------------- */
386
    /*      Don't do anything if the requesting region is completely off    */
387
    /*      the source image.                                               */
388
    /* -------------------------------------------------------------------- */
389
0
    if (dfModifiedSrcXOff >= nSrcRasterXSize ||
390
0
        dfModifiedSrcYOff >= nSrcRasterYSize || dfModifiedSrcXSize <= 0 ||
391
0
        dfModifiedSrcYSize <= 0)
392
0
    {
393
0
        return false;
394
0
    }
395
396
0
    srcWin.dfXOff = dfModifiedSrcXOff;
397
0
    srcWin.dfYOff = dfModifiedSrcYOff;
398
0
    srcWin.dfXSize = dfModifiedSrcXSize;
399
0
    srcWin.dfYSize = dfModifiedSrcYSize;
400
401
    /* -------------------------------------------------------------------- */
402
    /*      If we haven't had to modify the source rectangle, then the      */
403
    /*      destination rectangle must be the whole region.                 */
404
    /* -------------------------------------------------------------------- */
405
0
    if (!bModifiedX && !bModifiedY)
406
0
        return true;
407
408
    /* -------------------------------------------------------------------- */
409
    /*      Now transform this possibly reduced request back into the       */
410
    /*      destination buffer coordinates in case the output region is     */
411
    /*      less than the whole buffer.                                     */
412
    /* -------------------------------------------------------------------- */
413
0
    double dfDstULX, dfDstULY, dfDstLRX, dfDstLRY;
414
415
0
    SrcToDst(dfModifiedSrcXOff, dfModifiedSrcYOff, dfSrcXOff, dfSrcYOff,
416
0
             dfSrcXSize, dfSrcYSize, dfDstXOff, dfDstYOff, dfDstXSize,
417
0
             dfDstYSize, dfDstULX, dfDstULY);
418
0
    SrcToDst(dfModifiedSrcXOff + dfModifiedSrcXSize,
419
0
             dfModifiedSrcYOff + dfModifiedSrcYSize, dfSrcXOff, dfSrcYOff,
420
0
             dfSrcXSize, dfSrcYSize, dfDstXOff, dfDstYOff, dfDstXSize,
421
0
             dfDstYSize, dfDstLRX, dfDstLRY);
422
423
0
    double dfModifiedDstXOff = dfDstXOff;
424
0
    double dfModifiedDstYOff = dfDstYOff;
425
0
    double dfModifiedDstXSize = dfDstXSize;
426
0
    double dfModifiedDstYSize = dfDstYSize;
427
428
0
    if (bModifiedX)
429
0
    {
430
0
        dfModifiedDstXOff = dfDstULX - dfDstXOff;
431
0
        dfModifiedDstXSize = (dfDstLRX - dfDstXOff) - dfModifiedDstXOff;
432
433
0
        dfModifiedDstXOff = std::max(0.0, dfModifiedDstXOff);
434
0
        if (dfModifiedDstXOff + dfModifiedDstXSize > dfDstXSize)
435
0
            dfModifiedDstXSize = dfDstXSize - dfModifiedDstXOff;
436
0
    }
437
438
0
    if (bModifiedY)
439
0
    {
440
0
        dfModifiedDstYOff = dfDstULY - dfDstYOff;
441
0
        dfModifiedDstYSize = (dfDstLRY - dfDstYOff) - dfModifiedDstYOff;
442
443
0
        dfModifiedDstYOff = std::max(0.0, dfModifiedDstYOff);
444
0
        if (dfModifiedDstYOff + dfModifiedDstYSize > dfDstYSize)
445
0
            dfModifiedDstYSize = dfDstYSize - dfModifiedDstYOff;
446
0
    }
447
448
0
    if (dfModifiedDstXSize <= 0.0 || dfModifiedDstYSize <= 0.0)
449
0
    {
450
0
        return false;
451
0
    }
452
453
0
    dstWin.dfXOff = dfModifiedDstXOff;
454
0
    dstWin.dfYOff = dfModifiedDstYOff;
455
0
    dstWin.dfXSize = dfModifiedDstXSize;
456
0
    dstWin.dfYSize = dfModifiedDstYSize;
457
458
0
    return true;
459
0
}
460
461
/************************************************************************/
462
/*                        GDALTranslateFlush()                          */
463
/************************************************************************/
464
465
static GDALDatasetH GDALTranslateFlush(GDALDatasetH hOutDS)
466
0
{
467
0
    if (hOutDS != nullptr)
468
0
    {
469
0
        CPLErr eErrBefore = CPLGetLastErrorType();
470
0
        GDALFlushCache(hOutDS);
471
0
        if (eErrBefore == CE_None && CPLGetLastErrorType() != CE_None)
472
0
        {
473
0
            GDALClose(hOutDS);
474
0
            hOutDS = nullptr;
475
0
        }
476
0
    }
477
0
    return hOutDS;
478
0
}
479
480
/************************************************************************/
481
/*                    EditISIS3MetadataForBandChange()                  */
482
/************************************************************************/
483
484
static CPLJSONObject Clone(const CPLJSONObject &obj)
485
0
{
486
0
    auto serialized = obj.Format(CPLJSONObject::PrettyFormat::Plain);
487
0
    CPLJSONDocument oJSONDocument;
488
0
    const GByte *pabyData = reinterpret_cast<const GByte *>(serialized.c_str());
489
0
    oJSONDocument.LoadMemory(pabyData);
490
0
    return oJSONDocument.GetRoot();
491
0
}
492
493
static void ReworkArray(CPLJSONObject &container, const CPLJSONObject &obj,
494
                        int nSrcBandCount,
495
                        const GDALTranslateOptions *psOptions)
496
0
{
497
0
    auto oArray = obj.ToArray();
498
0
    if (oArray.Size() == nSrcBandCount)
499
0
    {
500
0
        CPLJSONArray oNewArray;
501
0
        for (int nBand : psOptions->anBandList)
502
0
        {
503
0
            const int iSrcIdx = nBand - 1;
504
0
            oNewArray.Add(oArray[iSrcIdx]);
505
0
        }
506
0
        const auto childName(obj.GetName());
507
0
        container.Delete(childName);
508
0
        container.Add(childName, oNewArray);
509
0
    }
510
0
}
511
512
static CPLString
513
EditISIS3MetadataForBandChange(const char *pszJSON, int nSrcBandCount,
514
                               const GDALTranslateOptions *psOptions)
515
0
{
516
0
    CPLJSONDocument oJSONDocument;
517
0
    const GByte *pabyData = reinterpret_cast<const GByte *>(pszJSON);
518
0
    if (!oJSONDocument.LoadMemory(pabyData))
519
0
    {
520
0
        return CPLString();
521
0
    }
522
523
0
    auto oRoot = oJSONDocument.GetRoot();
524
0
    if (!oRoot.IsValid())
525
0
    {
526
0
        return CPLString();
527
0
    }
528
529
0
    auto oBandBin = oRoot.GetObj("IsisCube/BandBin");
530
0
    if (oBandBin.IsValid() && oBandBin.GetType() == CPLJSONObject::Type::Object)
531
0
    {
532
        // Backup original BandBin object
533
0
        oRoot.GetObj("IsisCube").Add("OriginalBandBin", Clone(oBandBin));
534
535
        // Iterate over BandBin members and reorder/resize its arrays that
536
        // have the same number of elements than the number of bands of the
537
        // source dataset.
538
0
        for (auto &child : oBandBin.GetChildren())
539
0
        {
540
0
            if (child.GetType() == CPLJSONObject::Type::Array)
541
0
            {
542
0
                ReworkArray(oBandBin, child, nSrcBandCount, psOptions);
543
0
            }
544
0
            else if (child.GetType() == CPLJSONObject::Type::Object)
545
0
            {
546
0
                auto oValue = child.GetObj("value");
547
0
                auto oUnit = child.GetObj("unit");
548
0
                if (oValue.GetType() == CPLJSONObject::Type::Array)
549
0
                {
550
0
                    ReworkArray(child, oValue, nSrcBandCount, psOptions);
551
0
                }
552
0
            }
553
0
        }
554
0
    }
555
556
0
    return oRoot.Format(CPLJSONObject::PrettyFormat::Pretty);
557
0
}
558
559
/************************************************************************/
560
/*                             GDALTranslate()                          */
561
/************************************************************************/
562
563
/* clang-format off */
564
/**
565
 * Converts raster data between different formats.
566
 *
567
 * This is the equivalent of the
568
 * <a href="/programs/gdal_translate.html">gdal_translate</a> utility.
569
 *
570
 * GDALTranslateOptions* must be allocated and freed with
571
 * GDALTranslateOptionsNew() and GDALTranslateOptionsFree() respectively.
572
 *
573
 * @param pszDest the destination dataset path.
574
 * @param hSrcDataset the source dataset handle.
575
 * @param psOptionsIn the options struct returned by GDALTranslateOptionsNew()
576
 * or NULL.
577
 * @param pbUsageError pointer to a integer output variable to store if any
578
 * usage error has occurred or NULL.
579
 * @return the output dataset (new dataset that must be closed using
580
 * GDALClose()) or NULL in case of error. If the output
581
 * format is a VRT dataset, then the returned VRT dataset has a reference to
582
 * hSrcDataset. Hence hSrcDataset should be closed after the returned dataset
583
 * if using GDALClose().
584
 * A safer alternative is to use GDALReleaseDataset() instead of using
585
 * GDALClose(), in which case you can close datasets in any order.
586
 *
587
 * @since GDAL 2.1
588
 */
589
/* clang-format on */
590
591
GDALDatasetH GDALTranslate(const char *pszDest, GDALDatasetH hSrcDataset,
592
                           const GDALTranslateOptions *psOptionsIn,
593
                           int *pbUsageError)
594
595
0
{
596
0
    CPLErrorReset();
597
0
    if (hSrcDataset == nullptr)
598
0
    {
599
0
        CPLError(CE_Failure, CPLE_AppDefined, "No source dataset specified.");
600
601
0
        if (pbUsageError)
602
0
            *pbUsageError = TRUE;
603
0
        return nullptr;
604
0
    }
605
0
    if (pszDest == nullptr)
606
0
    {
607
0
        CPLError(CE_Failure, CPLE_AppDefined, "No target dataset specified.");
608
609
0
        if (pbUsageError)
610
0
            *pbUsageError = TRUE;
611
0
        return nullptr;
612
0
    }
613
614
0
    auto psOptions = psOptionsIn
615
0
                         ? std::make_unique<GDALTranslateOptions>(*psOptionsIn)
616
0
                         : std::unique_ptr<GDALTranslateOptions>(
617
0
                               GDALTranslateOptionsNew(nullptr, nullptr));
618
619
0
    GDALDatasetH hOutDS = nullptr;
620
0
    bool bGotBounds = false;
621
0
    bool bGotGeoTransform = false;
622
623
0
    if (pbUsageError)
624
0
        *pbUsageError = FALSE;
625
626
0
    if (psOptions->adfULLR[0] != 0.0 || psOptions->adfULLR[1] != 0.0 ||
627
0
        psOptions->adfULLR[2] != 0.0 || psOptions->adfULLR[3] != 0.0)
628
0
        bGotBounds = true;
629
630
0
    if (psOptions->gt != GDALGeoTransform(0, 0, 0, 0, 0, 0))
631
0
        bGotGeoTransform = true;
632
633
0
    GDALDataset *poSrcDS = GDALDataset::FromHandle(hSrcDataset);
634
0
    const char *pszSource = poSrcDS->GetDescription();
635
636
0
    if (strcmp(pszSource, pszDest) == 0 && pszSource[0] != '\0' &&
637
0
        poSrcDS->GetDriver() != GDALGetDriverByName("MEM"))
638
0
    {
639
0
        CPLError(CE_Failure, CPLE_AppDefined,
640
0
                 "Source and destination datasets must be different.");
641
642
0
        if (pbUsageError)
643
0
            *pbUsageError = TRUE;
644
0
        return nullptr;
645
0
    }
646
647
0
    CPLString osProjSRS;
648
649
0
    if (!psOptions->osProjSRS.empty())
650
0
    {
651
0
        OGRSpatialReference oSRS;
652
0
        oSRS.SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER);
653
654
0
        if (oSRS.SetFromUserInput(psOptions->osProjSRS.c_str()) != OGRERR_NONE)
655
0
        {
656
0
            CPLError(CE_Failure, CPLE_AppDefined,
657
0
                     "Failed to process SRS definition: %s",
658
0
                     psOptions->osProjSRS.c_str());
659
0
            return nullptr;
660
0
        }
661
662
0
        char *pszSRS = nullptr;
663
0
        oSRS.exportToWkt(&pszSRS);
664
0
        if (pszSRS)
665
0
            osProjSRS = pszSRS;
666
0
        CPLFree(pszSRS);
667
0
    }
668
669
0
    if (!psOptions->osOutputSRS.empty() && psOptions->osOutputSRS != "null" &&
670
0
        psOptions->osOutputSRS != "none")
671
0
    {
672
0
        OGRSpatialReference oOutputSRS;
673
0
        if (oOutputSRS.SetFromUserInput(psOptions->osOutputSRS.c_str()) !=
674
0
            OGRERR_NONE)
675
0
        {
676
0
            CPLError(CE_Failure, CPLE_AppDefined,
677
0
                     "Failed to process SRS definition: %s",
678
0
                     psOptions->osOutputSRS.c_str());
679
0
            return nullptr;
680
0
        }
681
0
    }
682
683
    /* -------------------------------------------------------------------- */
684
    /*      Check that incompatible options are not used                    */
685
    /* -------------------------------------------------------------------- */
686
687
0
    if ((psOptions->nOXSizePixel != 0 || psOptions->dfOXSizePct != 0.0 ||
688
0
         psOptions->nOYSizePixel != 0 || psOptions->dfOYSizePct != 0.0) &&
689
0
        (psOptions->dfXRes != 0 && psOptions->dfYRes != 0))
690
0
    {
691
0
        CPLError(CE_Failure, CPLE_IllegalArg,
692
0
                 "-outsize and -tr options cannot be used at the same time.");
693
0
        if (pbUsageError)
694
0
            *pbUsageError = TRUE;
695
0
        return nullptr;
696
0
    }
697
0
    if ((bGotBounds | bGotGeoTransform) &&
698
0
        (psOptions->dfXRes != 0 && psOptions->dfYRes != 0))
699
0
    {
700
0
        CPLError(
701
0
            CE_Failure, CPLE_IllegalArg,
702
0
            "-a_ullr or -a_gt options cannot be used at the same time as -tr.");
703
0
        if (pbUsageError)
704
0
            *pbUsageError = TRUE;
705
0
        return nullptr;
706
0
    }
707
0
    if (bGotBounds && bGotGeoTransform)
708
0
    {
709
0
        CPLError(CE_Failure, CPLE_IllegalArg,
710
0
                 "-a_ullr and -a_gt options cannot be used at the same time.");
711
0
        if (pbUsageError)
712
0
            *pbUsageError = TRUE;
713
0
        return nullptr;
714
0
    }
715
716
    /* -------------------------------------------------------------------- */
717
    /*      Collect some information from the source file.                  */
718
    /* -------------------------------------------------------------------- */
719
0
    if (psOptions->srcWin.dfXSize == 0 && psOptions->srcWin.dfYSize == 0)
720
0
    {
721
0
        psOptions->srcWin.dfXSize = poSrcDS->GetRasterXSize();
722
0
        psOptions->srcWin.dfYSize = poSrcDS->GetRasterYSize();
723
0
    }
724
725
    /* -------------------------------------------------------------------- */
726
    /*      Build band list to translate                                    */
727
    /* -------------------------------------------------------------------- */
728
0
    bool bAllBandsInOrder = true;
729
730
0
    if (psOptions->anBandList.empty())
731
0
    {
732
733
0
        psOptions->nBandCount = poSrcDS->GetRasterCount();
734
0
        if ((psOptions->nBandCount == 0) && (psOptions->bStrict))
735
0
        {
736
            // if not strict then the driver can fail if it doesn't support zero
737
            // bands
738
0
            CPLError(CE_Failure, CPLE_AppDefined,
739
0
                     "Input file has no bands, and so cannot be translated.");
740
0
            return nullptr;
741
0
        }
742
743
0
        psOptions->anBandList.resize(psOptions->nBandCount);
744
0
        for (int i = 0; i < psOptions->nBandCount; i++)
745
0
            psOptions->anBandList[i] = i + 1;
746
0
    }
747
0
    else
748
0
    {
749
0
        for (int i = 0; i < psOptions->nBandCount; i++)
750
0
        {
751
0
            if (std::abs(psOptions->anBandList[i]) > poSrcDS->GetRasterCount())
752
0
            {
753
0
                CPLError(CE_Failure, CPLE_AppDefined,
754
0
                         "Band %d requested, but only bands 1 to %d available.",
755
0
                         std::abs(psOptions->anBandList[i]),
756
0
                         poSrcDS->GetRasterCount());
757
0
                return nullptr;
758
0
            }
759
760
0
            if (psOptions->anBandList[i] != i + 1)
761
0
                bAllBandsInOrder = FALSE;
762
0
        }
763
764
0
        if (psOptions->nBandCount != poSrcDS->GetRasterCount())
765
0
            bAllBandsInOrder = FALSE;
766
0
    }
767
768
0
    if (static_cast<int>(psOptions->asScaleParams.size()) >
769
0
        psOptions->nBandCount)
770
0
    {
771
0
        if (!psOptions->bHasUsedExplicitScaleBand)
772
0
            CPLError(CE_Failure, CPLE_IllegalArg,
773
0
                     "-scale has been specified more times than the number of "
774
0
                     "output bands");
775
0
        else
776
0
            CPLError(CE_Failure, CPLE_IllegalArg,
777
0
                     "-scale_XX has been specified with XX greater than the "
778
0
                     "number of output bands");
779
0
        if (pbUsageError)
780
0
            *pbUsageError = TRUE;
781
0
        return nullptr;
782
0
    }
783
784
0
    if (static_cast<int>(psOptions->adfExponent.size()) > psOptions->nBandCount)
785
0
    {
786
0
        if (!psOptions->bHasUsedExplicitExponentBand)
787
0
            CPLError(CE_Failure, CPLE_IllegalArg,
788
0
                     "-exponent has been specified more times than the number "
789
0
                     "of output bands");
790
0
        else
791
0
            CPLError(CE_Failure, CPLE_IllegalArg,
792
0
                     "-exponent_XX has been specified with XX greater than the "
793
0
                     "number of output bands");
794
0
        if (pbUsageError)
795
0
            *pbUsageError = TRUE;
796
0
        return nullptr;
797
0
    }
798
799
0
    if (!psOptions->bQuiet && (psOptions->bSetScale || psOptions->bSetOffset) &&
800
0
        psOptions->bUnscale)
801
0
    {
802
        // Cf https://github.com/OSGeo/gdal/issues/7863
803
0
        CPLError(CE_Warning, CPLE_AppDefined,
804
0
                 "-a_scale/-a_offset are not applied by -unscale, but are set "
805
0
                 "after it, and -unscale uses the original source band "
806
0
                 "scale/offset values. "
807
0
                 "You may want to use -scale 0 1 %.16g %.16g instead. "
808
0
                 "This warning will not appear if -q is specified.",
809
0
                 psOptions->dfOffset, psOptions->dfOffset + psOptions->dfScale);
810
0
    }
811
812
    /* -------------------------------------------------------------------- */
813
    /*      Compute the source window from the projected source window      */
814
    /*      if the projected coordinates were provided.  Note that the      */
815
    /*      projected coordinates are in ulx, uly, lrx, lry format,         */
816
    /*      while the adfSrcWin is xoff, yoff, xsize, ysize with the        */
817
    /*      xoff,yoff being the ulx, uly in pixel/line.                     */
818
    /* -------------------------------------------------------------------- */
819
0
    const char *pszProjection = nullptr;
820
821
0
    if (psOptions->dfULX != 0.0 || psOptions->dfULY != 0.0 ||
822
0
        psOptions->dfLRX != 0.0 || psOptions->dfLRY != 0.0)
823
0
    {
824
0
        GDALGeoTransform gt;
825
0
        poSrcDS->GetGeoTransform(gt);
826
827
0
        if (gt[1] == 0.0 || gt[5] == 0.0)
828
0
        {
829
0
            CPLError(CE_Failure, CPLE_AppDefined,
830
0
                     "The -projwin option was used, but the geotransform is "
831
0
                     "invalid.");
832
0
            return nullptr;
833
0
        }
834
0
        if (gt[2] != 0.0 || gt[4] != 0.0)
835
0
        {
836
0
            CPLError(CE_Failure, CPLE_AppDefined,
837
0
                     "The -projwin option was used, but the geotransform is\n"
838
0
                     "rotated.  This configuration is not supported.");
839
0
            return nullptr;
840
0
        }
841
842
0
        if (!osProjSRS.empty())
843
0
        {
844
0
            pszProjection = poSrcDS->GetProjectionRef();
845
0
            if (pszProjection != nullptr && strlen(pszProjection) > 0)
846
0
            {
847
0
                OGRSpatialReference oSRSIn;
848
0
                OGRSpatialReference oSRSDS;
849
0
                oSRSIn.SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER);
850
0
                oSRSDS.SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER);
851
0
                oSRSIn.SetFromUserInput(osProjSRS);
852
0
                oSRSDS.SetFromUserInput(pszProjection);
853
0
                if (!oSRSIn.IsSame(&oSRSDS))
854
0
                {
855
0
                    OGRCoordinateTransformation *poCT =
856
0
                        OGRCreateCoordinateTransformation(&oSRSIn, &oSRSDS);
857
0
                    if (!(poCT &&
858
0
                          poCT->TransformBounds(
859
0
                              psOptions->dfULX, psOptions->dfLRY,
860
0
                              psOptions->dfLRX, psOptions->dfULY,
861
0
                              &psOptions->dfULX, &psOptions->dfLRY,
862
0
                              &psOptions->dfLRX, &psOptions->dfULY, 21)))
863
0
                    {
864
0
                        OGRCoordinateTransformation::DestroyCT(poCT);
865
866
0
                        CPLError(CE_Failure, CPLE_AppDefined,
867
0
                                 "-projwin_srs ignored since coordinate "
868
0
                                 "transformation failed.");
869
0
                        return nullptr;
870
0
                    }
871
0
                    delete poCT;
872
0
                }
873
0
            }
874
0
            else
875
0
            {
876
0
                CPLError(CE_Warning, CPLE_None,
877
0
                         "-projwin_srs ignored since the dataset has no "
878
0
                         "projection.");
879
0
            }
880
0
        }
881
882
0
        bool bAlignToInputPixels =
883
0
            psOptions->osResampling.empty() ||
884
0
            EQUALN(psOptions->osResampling.c_str(), "NEAR", 4);
885
886
0
        double dfULX = psOptions->dfULX;
887
0
        double dfULY = psOptions->dfULY;
888
889
0
        psOptions->srcWin.dfXOff = (dfULX - gt[0]) / gt[1];
890
0
        psOptions->srcWin.dfYOff = (dfULY - gt[3]) / gt[5];
891
892
        // In case of nearest resampling, round to integer pixels (#6610)
893
0
        if (bAlignToInputPixels)
894
0
        {
895
0
            psOptions->srcWin.dfXOff =
896
0
                std::floor(psOptions->srcWin.dfXOff + 0.001);  // xoff
897
0
            psOptions->srcWin.dfYOff =
898
0
                std::floor(psOptions->srcWin.dfYOff + 0.001);  // yoff
899
900
0
            dfULX = psOptions->srcWin.dfXOff * gt[1] + gt[0];
901
0
            dfULY = psOptions->srcWin.dfYOff * gt[5] + gt[3];
902
0
        }
903
904
        // Calculate xsize and ysize based on the (possibly snapped) ULX, ULY
905
0
        psOptions->srcWin.dfXSize =
906
0
            (psOptions->dfLRX - dfULX) / gt[1];  // xsize
907
0
        psOptions->srcWin.dfYSize =
908
0
            (psOptions->dfLRY - dfULY) / gt[5];  // ysize
909
910
0
        if (bAlignToInputPixels)
911
0
        {
912
0
            psOptions->srcWin.dfXSize =
913
0
                std::ceil(psOptions->srcWin.dfXSize - 0.001);
914
0
            psOptions->srcWin.dfYSize =
915
0
                std::ceil(psOptions->srcWin.dfYSize - 0.001);
916
0
        }
917
918
        /*if( !bQuiet )
919
            fprintf( stdout,
920
                     "Computed -srcwin %g %g %g %g from projected window.\n",
921
                     srcWin.dfXOff,
922
                     srcWin.dfYOff,
923
                     srcWin.dfXSize,
924
                     srcWin.dfYSize ); */
925
0
    }
926
927
    /* -------------------------------------------------------------------- */
928
    /*      Verify source window dimensions.                                */
929
    /* -------------------------------------------------------------------- */
930
0
    if (poSrcDS->GetRasterXSize() != 0 && poSrcDS->GetRasterYSize() != 0 &&
931
0
        (psOptions->srcWin.dfXSize <= 0 || psOptions->srcWin.dfYSize <= 0))
932
0
    {
933
0
        CPLError(
934
0
            CE_Failure, CPLE_AppDefined,
935
0
            "Error: %s-srcwin %g %g %g %g has negative width and/or height.",
936
0
            (psOptions->dfULX != 0.0 || psOptions->dfULY != 0.0 ||
937
0
             psOptions->dfLRX != 0.0 || psOptions->dfLRY != 0.0)
938
0
                ? "Computed "
939
0
                : "",
940
0
            psOptions->srcWin.dfXOff, psOptions->srcWin.dfYOff,
941
0
            psOptions->srcWin.dfXSize, psOptions->srcWin.dfYSize);
942
0
        return nullptr;
943
0
    }
944
945
    /* -------------------------------------------------------------------- */
946
    /*      Verify source window dimensions.                                */
947
    /* -------------------------------------------------------------------- */
948
0
    else if (psOptions->srcWin.dfXOff <= -1 || psOptions->srcWin.dfYOff <= -1 ||
949
0
             psOptions->srcWin.dfXOff + psOptions->srcWin.dfXSize - 1 >=
950
0
                 poSrcDS->GetRasterXSize() ||
951
0
             psOptions->srcWin.dfYOff + psOptions->srcWin.dfYSize - 1 >=
952
0
                 poSrcDS->GetRasterYSize())
953
0
    {
954
0
        const bool bCompletelyOutside =
955
0
            psOptions->srcWin.dfXOff + psOptions->srcWin.dfXSize <= 0 ||
956
0
            psOptions->srcWin.dfYOff + psOptions->srcWin.dfYSize <= 0 ||
957
0
            psOptions->srcWin.dfXOff >= poSrcDS->GetRasterXSize() ||
958
0
            psOptions->srcWin.dfYOff >= poSrcDS->GetRasterYSize();
959
0
        const bool bIsError =
960
0
            psOptions->bErrorOnPartiallyOutside ||
961
0
            (bCompletelyOutside && psOptions->bErrorOnCompletelyOutside);
962
0
        if (!psOptions->bQuiet || bIsError)
963
0
        {
964
0
            CPLErr eErr = bIsError ? CE_Failure : CE_Warning;
965
966
0
            CPLError(eErr, CPLE_AppDefined,
967
0
                     "%s-srcwin %g %g %g %g falls %s outside source raster "
968
0
                     "extent.%s",
969
0
                     (psOptions->dfULX != 0.0 || psOptions->dfULY != 0.0 ||
970
0
                      psOptions->dfLRX != 0.0 || psOptions->dfLRY != 0.0)
971
0
                         ? "Computed "
972
0
                         : "",
973
0
                     psOptions->srcWin.dfXOff, psOptions->srcWin.dfYOff,
974
0
                     psOptions->srcWin.dfXSize, psOptions->srcWin.dfYSize,
975
0
                     bCompletelyOutside ? "completely" : "partially",
976
0
                     bIsError
977
0
                         ? ""
978
0
                         : " Pixels outside the source raster extent will be "
979
0
                           "set to the NoData value (if defined), or zero.");
980
0
        }
981
0
        if (bIsError)
982
0
        {
983
0
            return nullptr;
984
0
        }
985
0
    }
986
987
    /* -------------------------------------------------------------------- */
988
    /*      Find the output driver.                                         */
989
    /* -------------------------------------------------------------------- */
990
0
    if (psOptions->osFormat.empty())
991
0
    {
992
0
        psOptions->osFormat = GetOutputDriverForRaster(pszDest);
993
0
        if (psOptions->osFormat.empty())
994
0
        {
995
0
            CPLError(CE_Failure, CPLE_AppDefined,
996
0
                     "Could not identify an output driver for %s", pszDest);
997
0
            return nullptr;
998
0
        }
999
0
    }
1000
1001
0
    GDALDriverH hDriver = GDALGetDriverByName(psOptions->osFormat.c_str());
1002
0
    if (hDriver == nullptr)
1003
0
    {
1004
0
        CPLError(CE_Failure, CPLE_IllegalArg,
1005
0
                 "Output driver `%s' not recognised.",
1006
0
                 psOptions->osFormat.c_str());
1007
0
        return nullptr;
1008
0
    }
1009
1010
    /* -------------------------------------------------------------------- */
1011
    /*      Make sure we cleanup if there is an existing dataset of this    */
1012
    /*      name.  But even if that seems to fail we will continue since    */
1013
    /*      it might just be a corrupt file or something.                   */
1014
    /*      This is needed for                                              */
1015
    /*      gdal_translate foo.tif foo.tif.ovr -outsize 50% 50%             */
1016
    /* -------------------------------------------------------------------- */
1017
0
    if (psOptions->aosCreateOptions.FetchBool("APPEND_SUBDATASET", false))
1018
0
    {
1019
0
        if (GDALGetMetadataItem(hDriver, GDAL_DCAP_CREATE_SUBDATASETS,
1020
0
                                nullptr) == nullptr)
1021
0
        {
1022
0
            CPLError(CE_Failure, CPLE_NotSupported,
1023
0
                     "Subdataset creation not supported for driver %s",
1024
0
                     GDALGetDescription(hDriver));
1025
0
            return nullptr;
1026
0
        }
1027
0
    }
1028
0
    else
1029
0
    {
1030
0
        if (!EQUAL(psOptions->osFormat.c_str(), "VRT"))
1031
0
        {
1032
            // Prevent GDALDriver::CreateCopy() from doing that again.
1033
0
            psOptions->aosCreateOptions.SetNameValue(
1034
0
                "@QUIET_DELETE_ON_CREATE_COPY", "NO");
1035
0
        }
1036
1037
0
        if (psOptions->bNoOverwrite && !EQUAL(pszDest, ""))
1038
0
        {
1039
0
            VSIStatBufL sStat;
1040
0
            if (VSIStatL(pszDest, &sStat) == 0)
1041
0
            {
1042
0
                CPLError(CE_Failure, CPLE_AppDefined,
1043
0
                         "File '%s' already exists. Specify the --overwrite "
1044
0
                         "option to overwrite it.",
1045
0
                         pszDest);
1046
0
                return nullptr;
1047
0
            }
1048
0
            else if (std::unique_ptr<GDALDataset>(GDALDataset::Open(pszDest)))
1049
0
            {
1050
0
                CPLError(CE_Failure, CPLE_AppDefined,
1051
0
                         "Dataset '%s' already exists. Specify the --overwrite "
1052
0
                         "option to overwrite it.",
1053
0
                         pszDest);
1054
0
                return nullptr;
1055
0
            }
1056
0
        }
1057
1058
0
        GDALDriver::FromHandle(hDriver)->QuietDeleteForCreateCopy(pszDest,
1059
0
                                                                  poSrcDS);
1060
1061
        // Make sure to load early overviews, so that on the GTiff driver
1062
        // external .ovr is looked for before it might be created as the
1063
        // output dataset !
1064
0
        if (poSrcDS->GetRasterCount())
1065
0
        {
1066
0
            auto poBand = poSrcDS->GetRasterBand(1);
1067
0
            if (poBand)
1068
0
                poBand->GetOverviewCount();
1069
0
        }
1070
0
    }
1071
1072
0
    char **papszDriverMD = GDALGetMetadata(hDriver, nullptr);
1073
1074
0
    if (!CPLTestBool(
1075
0
            CSLFetchNameValueDef(papszDriverMD, GDAL_DCAP_RASTER, "FALSE")))
1076
0
    {
1077
0
        CPLError(CE_Failure, CPLE_AppDefined,
1078
0
                 "%s driver has no raster capabilities.",
1079
0
                 psOptions->osFormat.c_str());
1080
0
        return nullptr;
1081
0
    }
1082
1083
0
    if (!CPLTestBool(
1084
0
            CSLFetchNameValueDef(papszDriverMD, GDAL_DCAP_CREATE, "FALSE")) &&
1085
0
        !CPLTestBool(
1086
0
            CSLFetchNameValueDef(papszDriverMD, GDAL_DCAP_CREATECOPY, "FALSE")))
1087
0
    {
1088
0
        CPLError(CE_Failure, CPLE_AppDefined,
1089
0
                 "%s driver has no creation capabilities.",
1090
0
                 psOptions->osFormat.c_str());
1091
0
        return nullptr;
1092
0
    }
1093
1094
    /* -------------------------------------------------------------------- */
1095
    /*      The short form is to CreateCopy().  We use this if the input    */
1096
    /*      matches the whole dataset.  Eventually we should rewrite        */
1097
    /*      this entire program to use virtual datasets to construct a      */
1098
    /*      virtual input source to copy from.                              */
1099
    /* -------------------------------------------------------------------- */
1100
1101
0
    const bool bKeepResolution =
1102
0
        psOptions->nOXSizePixel == 0 && psOptions->dfOXSizePct == 0.0 &&
1103
0
        psOptions->nOYSizePixel == 0 && psOptions->dfOYSizePct == 0.0 &&
1104
0
        psOptions->dfXRes == 0.0;
1105
0
    const bool bSpatialArrangementPreserved =
1106
0
        psOptions->srcWin.dfXOff == 0 && psOptions->srcWin.dfYOff == 0 &&
1107
0
        psOptions->srcWin.dfXSize == poSrcDS->GetRasterXSize() &&
1108
0
        psOptions->srcWin.dfYSize == poSrcDS->GetRasterYSize() &&
1109
0
        bKeepResolution;
1110
1111
0
    if (psOptions->eOutputType == GDT_Unknown &&
1112
0
        psOptions->asScaleParams.empty() && psOptions->adfExponent.empty() &&
1113
0
        !psOptions->bUnscale && !psOptions->bSetScale &&
1114
0
        !psOptions->bSetOffset && psOptions->aosMetadataOptions.empty() &&
1115
0
        psOptions->aosDomainMetadataOptions.empty() && bAllBandsInOrder &&
1116
0
        psOptions->eMaskMode == MASK_AUTO && bSpatialArrangementPreserved &&
1117
0
        !psOptions->bNoGCP && psOptions->asGCPs.empty() && !bGotBounds &&
1118
0
        !bGotGeoTransform && psOptions->osOutputSRS.empty() &&
1119
0
        psOptions->dfOutputCoordinateEpoch == 0 && !psOptions->bSetNoData &&
1120
0
        !psOptions->bUnsetNoData && psOptions->nRGBExpand == 0 &&
1121
0
        !psOptions->bNoRAT && psOptions->anColorInterp.empty() &&
1122
0
        !psOptions->bNoXMP && psOptions->nOvLevel == OVR_LEVEL_AUTO)
1123
0
    {
1124
1125
        // For gdal_translate_fuzzer
1126
0
        if (psOptions->nLimitOutSize > 0)
1127
0
        {
1128
0
            vsi_l_offset nRawOutSize =
1129
0
                static_cast<vsi_l_offset>(poSrcDS->GetRasterXSize()) *
1130
0
                poSrcDS->GetRasterYSize() * psOptions->nBandCount;
1131
0
            if (psOptions->nBandCount)
1132
0
            {
1133
0
                nRawOutSize *= GDALGetDataTypeSizeBytes(
1134
0
                    poSrcDS->GetRasterBand(1)->GetRasterDataType());
1135
0
            }
1136
0
            if (nRawOutSize >
1137
0
                static_cast<vsi_l_offset>(psOptions->nLimitOutSize))
1138
0
            {
1139
0
                CPLError(CE_Failure, CPLE_IllegalArg,
1140
0
                         "Attempt to create %dx%d dataset is above authorized "
1141
0
                         "limit.",
1142
0
                         poSrcDS->GetRasterXSize(), poSrcDS->GetRasterYSize());
1143
0
                return nullptr;
1144
0
            }
1145
0
        }
1146
1147
        /* --------------------------------------------------------------------
1148
         */
1149
        /*      Compute stats if required. */
1150
        /* --------------------------------------------------------------------
1151
         */
1152
1153
0
        if (psOptions->bStats && EQUAL(psOptions->osFormat.c_str(), "COG"))
1154
0
        {
1155
0
            psOptions->aosCreateOptions.SetNameValue("STATISTICS", "YES");
1156
0
        }
1157
0
        else if (psOptions->bStats)
1158
0
        {
1159
0
            for (int i = 0; i < poSrcDS->GetRasterCount(); i++)
1160
0
            {
1161
0
                double dfMin, dfMax, dfMean, dfStdDev;
1162
0
                poSrcDS->GetRasterBand(i + 1)->ComputeStatistics(
1163
0
                    psOptions->bApproxStats, &dfMin, &dfMax, &dfMean, &dfStdDev,
1164
0
                    GDALDummyProgress, nullptr);
1165
0
            }
1166
0
        }
1167
1168
0
        hOutDS = GDALCreateCopy(
1169
0
            hDriver, pszDest, GDALDataset::ToHandle(poSrcDS),
1170
0
            psOptions->bStrict, psOptions->aosCreateOptions.List(),
1171
0
            psOptions->pfnProgress, psOptions->pProgressData);
1172
0
        hOutDS = GDALTranslateFlush(hOutDS);
1173
1174
0
        return hOutDS;
1175
0
    }
1176
1177
0
    if (psOptions->aosCreateOptions.FetchNameValue("COPY_SRC_OVERVIEWS"))
1178
0
    {
1179
0
        CPLError(CE_Warning, CPLE_AppDefined,
1180
0
                 "General options of gdal_translate make the "
1181
0
                 "COPY_SRC_OVERVIEWS creation option ineffective as they hide "
1182
0
                 "the overviews");
1183
0
    }
1184
1185
    /* -------------------------------------------------------------------- */
1186
    /*      Establish some parameters.                                      */
1187
    /* -------------------------------------------------------------------- */
1188
0
    int nOXSize = 0;
1189
0
    int nOYSize = 0;
1190
1191
0
    bool bHasSrcGeoTransform = false;
1192
0
    GDALGeoTransform srcGT;
1193
0
    if (poSrcDS->GetGeoTransform(srcGT) == CE_None)
1194
0
        bHasSrcGeoTransform = true;
1195
1196
0
    const bool bOutsizeExplicitlySet =
1197
0
        !(psOptions->nOXSizePixel == 0 && psOptions->dfOXSizePct == 0.0 &&
1198
0
          psOptions->nOYSizePixel == 0 && psOptions->dfOYSizePct == 0.0);
1199
0
    if (psOptions->dfXRes != 0.0 && psOptions->dfYRes != 0.0)
1200
0
    {
1201
0
        if (!(bHasSrcGeoTransform && psOptions->asGCPs.empty() &&
1202
0
              srcGT[2] == 0.0 && srcGT[4] == 0.0))
1203
0
        {
1204
0
            CPLError(CE_Failure, CPLE_IllegalArg,
1205
0
                     "The -tr option was used, but there's no geotransform or "
1206
0
                     "it is\n"
1207
0
                     "rotated.  This configuration is not supported.");
1208
0
            return nullptr;
1209
0
        }
1210
0
        const double dfOXSize =
1211
0
            psOptions->srcWin.dfXSize / psOptions->dfXRes * srcGT[1] + 0.5;
1212
0
        const double dfOYSize =
1213
0
            psOptions->srcWin.dfYSize / psOptions->dfYRes * fabs(srcGT[5]) +
1214
0
            0.5;
1215
0
        if (dfOXSize < 1 || !GDALIsValueInRange<int>(dfOXSize) ||
1216
0
            dfOYSize < 1 || !GDALIsValueInRange<int>(dfOYSize))
1217
0
        {
1218
0
            CPLError(CE_Failure, CPLE_IllegalArg,
1219
0
                     "Invalid output size: %g x %g", dfOXSize, dfOYSize);
1220
0
            return nullptr;
1221
0
        }
1222
0
        nOXSize = static_cast<int>(dfOXSize);
1223
0
        nOYSize = static_cast<int>(dfOYSize);
1224
0
    }
1225
0
    else if (!bOutsizeExplicitlySet)
1226
0
    {
1227
0
        double dfOXSize = ceil(psOptions->srcWin.dfXSize - 0.001);
1228
0
        double dfOYSize = ceil(psOptions->srcWin.dfYSize - 0.001);
1229
0
        if (dfOXSize < 1 || !GDALIsValueInRange<int>(dfOXSize) ||
1230
0
            dfOYSize < 1 || !GDALIsValueInRange<int>(dfOYSize))
1231
0
        {
1232
0
            CPLError(CE_Failure, CPLE_IllegalArg,
1233
0
                     "Invalid output size: %g x %g", dfOXSize, dfOYSize);
1234
0
            return nullptr;
1235
0
        }
1236
0
        nOXSize = static_cast<int>(dfOXSize);
1237
0
        nOYSize = static_cast<int>(dfOYSize);
1238
0
    }
1239
0
    else
1240
0
    {
1241
0
        if (!(psOptions->nOXSizePixel == 0 && psOptions->dfOXSizePct == 0.0))
1242
0
        {
1243
0
            if (psOptions->nOXSizePixel != 0)
1244
0
                nOXSize = psOptions->nOXSizePixel;
1245
0
            else
1246
0
            {
1247
0
                const double dfOXSize =
1248
0
                    psOptions->dfOXSizePct / 100 * psOptions->srcWin.dfXSize;
1249
0
                if (dfOXSize < 1 || !GDALIsValueInRange<int>(dfOXSize))
1250
0
                {
1251
0
                    CPLError(CE_Failure, CPLE_IllegalArg,
1252
0
                             "Invalid output width: %g", dfOXSize);
1253
0
                    return nullptr;
1254
0
                }
1255
0
                nOXSize = static_cast<int>(dfOXSize);
1256
0
            }
1257
0
        }
1258
1259
0
        if (!(psOptions->nOYSizePixel == 0 && psOptions->dfOYSizePct == 0.0))
1260
0
        {
1261
0
            if (psOptions->nOYSizePixel != 0)
1262
0
                nOYSize = psOptions->nOYSizePixel;
1263
0
            else
1264
0
            {
1265
0
                const double dfOYSize =
1266
0
                    psOptions->dfOYSizePct / 100 * psOptions->srcWin.dfYSize;
1267
0
                if (dfOYSize < 1 || !GDALIsValueInRange<int>(dfOYSize))
1268
0
                {
1269
0
                    CPLError(CE_Failure, CPLE_IllegalArg,
1270
0
                             "Invalid output height: %g", dfOYSize);
1271
0
                    return nullptr;
1272
0
                }
1273
0
                nOYSize = static_cast<int>(dfOYSize);
1274
0
            }
1275
0
        }
1276
1277
0
        if (psOptions->nOXSizePixel == 0 && psOptions->dfOXSizePct == 0.0)
1278
0
        {
1279
0
            const double dfOXSize = static_cast<double>(nOYSize) *
1280
0
                                        psOptions->srcWin.dfXSize /
1281
0
                                        psOptions->srcWin.dfYSize +
1282
0
                                    0.5;
1283
0
            if (dfOXSize < 1 || !GDALIsValueInRange<int>(dfOXSize))
1284
0
            {
1285
0
                CPLError(CE_Failure, CPLE_IllegalArg,
1286
0
                         "Invalid output width: %g", dfOXSize);
1287
0
                return nullptr;
1288
0
            }
1289
0
            nOXSize = static_cast<int>(dfOXSize);
1290
0
        }
1291
0
        else if (psOptions->nOYSizePixel == 0 && psOptions->dfOYSizePct == 0.0)
1292
0
        {
1293
0
            const double dfOYSize = static_cast<double>(nOXSize) *
1294
0
                                        psOptions->srcWin.dfYSize /
1295
0
                                        psOptions->srcWin.dfXSize +
1296
0
                                    0.5;
1297
0
            if (dfOYSize < 1 || !GDALIsValueInRange<int>(dfOYSize))
1298
0
            {
1299
0
                CPLError(CE_Failure, CPLE_IllegalArg,
1300
0
                         "Invalid output height: %g", dfOYSize);
1301
0
                return nullptr;
1302
0
            }
1303
0
            nOYSize = static_cast<int>(dfOYSize);
1304
0
        }
1305
0
    }
1306
1307
0
    if (nOXSize <= 0 || nOYSize <= 0)
1308
0
    {
1309
0
        CPLError(CE_Failure, CPLE_IllegalArg,
1310
0
                 "Attempt to create %dx%d dataset is illegal.", nOXSize,
1311
0
                 nOYSize);
1312
0
        return nullptr;
1313
0
    }
1314
1315
    // Build overview dataset if -ovr is specified
1316
0
    GDALDataset *poSrcOvrDS = nullptr;
1317
0
    GDALDataset *poSrcDSOri = poSrcDS;
1318
0
    const auto poFirstBand = poSrcDS->GetRasterBand(1);
1319
0
    const int nOvCount = poFirstBand ? poFirstBand->GetOverviewCount() : 0;
1320
0
    if (psOptions->nOvLevel < OVR_LEVEL_AUTO && poFirstBand && nOvCount > 0)
1321
0
    {
1322
0
        int iOvr = 0;
1323
0
        for (; iOvr < nOvCount - 1; iOvr++)
1324
0
        {
1325
0
            if (poFirstBand->GetOverview(iOvr)->GetXSize() <= nOXSize)
1326
0
            {
1327
0
                break;
1328
0
            }
1329
0
        }
1330
0
        iOvr += (psOptions->nOvLevel - OVR_LEVEL_AUTO);
1331
0
        if (iOvr >= 0)
1332
0
        {
1333
0
            CPLDebug("GDAL", "Selecting overview level %d", iOvr);
1334
0
            poSrcOvrDS = GDALCreateOverviewDataset(poSrcDS, iOvr,
1335
0
                                                   /* bThisLevelOnly = */ true);
1336
0
        }
1337
0
    }
1338
0
    else if (psOptions->nOvLevel >= OVR_LEVEL_NONE)
1339
0
    {
1340
0
        poSrcOvrDS = GDALCreateOverviewDataset(poSrcDS, psOptions->nOvLevel,
1341
0
                                               /* bThisLevelOnly = */ true);
1342
0
        if (poSrcOvrDS == nullptr)
1343
0
        {
1344
0
            if (!psOptions->bQuiet)
1345
0
            {
1346
0
                if (nOvCount > 0)
1347
0
                {
1348
0
                    CPLError(CE_Warning, CPLE_AppDefined,
1349
0
                             "Cannot get overview level %d. "
1350
0
                             "Defaulting to level %d.",
1351
0
                             psOptions->nOvLevel, nOvCount - 1);
1352
0
                }
1353
0
                else
1354
0
                {
1355
0
                    CPLError(CE_Warning, CPLE_AppDefined,
1356
0
                             "Cannot get overview level %d. "
1357
0
                             "Defaulting to full resolution.",
1358
0
                             psOptions->nOvLevel);
1359
0
                }
1360
0
            }
1361
0
            if (nOvCount > 0)
1362
0
                poSrcOvrDS =
1363
0
                    GDALCreateOverviewDataset(poSrcDS, nOvCount - 1,
1364
0
                                              /* bThisLevelOnly = */ true);
1365
0
        }
1366
0
        if (poSrcOvrDS && psOptions->dfXRes == 0.0 && !bOutsizeExplicitlySet)
1367
0
        {
1368
0
            const double dfRatioX =
1369
0
                static_cast<double>(poSrcDSOri->GetRasterXSize()) /
1370
0
                poSrcOvrDS->GetRasterXSize();
1371
0
            const double dfRatioY =
1372
0
                static_cast<double>(poSrcDSOri->GetRasterYSize()) /
1373
0
                poSrcOvrDS->GetRasterYSize();
1374
0
            nOXSize =
1375
0
                std::max(1, static_cast<int>(ceil(nOXSize / dfRatioX - 0.001)));
1376
0
            nOYSize =
1377
0
                std::max(1, static_cast<int>(ceil(nOYSize / dfRatioY - 0.001)));
1378
0
        }
1379
0
    }
1380
1381
0
    if (poSrcOvrDS)
1382
0
        poSrcDS = poSrcOvrDS;
1383
0
    else
1384
0
        poSrcDS->Reference();
1385
1386
    // For gdal_translate_fuzzer
1387
0
    if (psOptions->nLimitOutSize > 0)
1388
0
    {
1389
0
        vsi_l_offset nRawOutSize = static_cast<vsi_l_offset>(nOXSize) * nOYSize;
1390
0
        if (psOptions->nBandCount)
1391
0
        {
1392
0
            if (nRawOutSize > std::numeric_limits<vsi_l_offset>::max() /
1393
0
                                  psOptions->nBandCount)
1394
0
            {
1395
0
                poSrcDS->Release();
1396
0
                return nullptr;
1397
0
            }
1398
0
            nRawOutSize *= psOptions->nBandCount;
1399
0
            const int nDTSize = GDALGetDataTypeSizeBytes(
1400
0
                poSrcDS->GetRasterBand(1)->GetRasterDataType());
1401
0
            if (nDTSize > 0 &&
1402
0
                nRawOutSize >
1403
0
                    std::numeric_limits<vsi_l_offset>::max() / nDTSize)
1404
0
            {
1405
0
                poSrcDS->Release();
1406
0
                return nullptr;
1407
0
            }
1408
0
            nRawOutSize *= nDTSize;
1409
0
        }
1410
0
        if (nRawOutSize > static_cast<vsi_l_offset>(psOptions->nLimitOutSize))
1411
0
        {
1412
0
            CPLError(
1413
0
                CE_Failure, CPLE_IllegalArg,
1414
0
                "Attempt to create %dx%d dataset is above authorized limit.",
1415
0
                nOXSize, nOYSize);
1416
0
            poSrcDS->Release();
1417
0
            return nullptr;
1418
0
        }
1419
0
    }
1420
1421
    /* ==================================================================== */
1422
    /*      Create a virtual dataset.                                       */
1423
    /* ==================================================================== */
1424
1425
    /* -------------------------------------------------------------------- */
1426
    /*      Make a virtual clone.                                           */
1427
    /* -------------------------------------------------------------------- */
1428
0
    VRTDataset *poVDS = static_cast<VRTDataset *>(VRTCreate(nOXSize, nOYSize));
1429
1430
0
    if (psOptions->asGCPs.empty())
1431
0
    {
1432
0
        if (psOptions->osOutputSRS == "null" ||
1433
0
            psOptions->osOutputSRS == "none")
1434
0
        {
1435
0
            poVDS->SetSpatialRef(nullptr);
1436
0
        }
1437
0
        else
1438
0
        {
1439
0
            OGRSpatialReference oSRS;
1440
0
            if (!psOptions->osOutputSRS.empty())
1441
0
            {
1442
0
                oSRS.SetFromUserInput(psOptions->osOutputSRS.c_str());
1443
0
                oSRS.SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER);
1444
0
            }
1445
0
            else
1446
0
            {
1447
0
                const OGRSpatialReference *poSrcSRS = poSrcDS->GetSpatialRef();
1448
0
                if (poSrcSRS)
1449
0
                    oSRS = *poSrcSRS;
1450
0
            }
1451
0
            if (!oSRS.IsEmpty())
1452
0
            {
1453
0
                if (psOptions->dfOutputCoordinateEpoch > 0)
1454
0
                    oSRS.SetCoordinateEpoch(psOptions->dfOutputCoordinateEpoch);
1455
0
                poVDS->SetSpatialRef(&oSRS);
1456
0
            }
1457
0
        }
1458
0
    }
1459
1460
0
    bool bHasDstGeoTransform = false;
1461
0
    GDALGeoTransform dstGT;
1462
1463
0
    if (bGotBounds)
1464
0
    {
1465
0
        bHasDstGeoTransform = true;
1466
0
        dstGT[0] = psOptions->adfULLR[0];
1467
0
        dstGT[1] = (psOptions->adfULLR[2] - psOptions->adfULLR[0]) / nOXSize;
1468
0
        dstGT[2] = 0.0;
1469
0
        dstGT[3] = psOptions->adfULLR[1];
1470
0
        dstGT[4] = 0.0;
1471
0
        dstGT[5] = (psOptions->adfULLR[3] - psOptions->adfULLR[1]) / nOYSize;
1472
1473
0
        poVDS->SetGeoTransform(dstGT);
1474
0
    }
1475
1476
0
    else if (bGotGeoTransform)
1477
0
    {
1478
0
        bHasDstGeoTransform = true;
1479
0
        poVDS->SetGeoTransform(psOptions->gt);
1480
0
    }
1481
1482
0
    else if (bHasSrcGeoTransform && psOptions->asGCPs.empty())
1483
0
    {
1484
0
        bHasDstGeoTransform = true;
1485
0
        dstGT = srcGT;
1486
0
        dstGT[0] += psOptions->srcWin.dfXOff * dstGT[1] +
1487
0
                    psOptions->srcWin.dfYOff * dstGT[2];
1488
0
        dstGT[3] += psOptions->srcWin.dfXOff * dstGT[4] +
1489
0
                    psOptions->srcWin.dfYOff * dstGT[5];
1490
1491
0
        const double dfXRatio = psOptions->srcWin.dfXSize / nOXSize;
1492
0
        const double dfYRatio = psOptions->srcWin.dfYSize / nOYSize;
1493
0
        dstGT.Rescale(dfXRatio, dfYRatio);
1494
1495
0
        if (psOptions->dfXRes != 0.0)
1496
0
        {
1497
0
            dstGT[1] = psOptions->dfXRes;
1498
0
            dstGT[5] = (dstGT[5] > 0) ? psOptions->dfYRes : -psOptions->dfYRes;
1499
0
        }
1500
1501
0
        poVDS->SetGeoTransform(dstGT);
1502
0
    }
1503
1504
0
    if (!psOptions->asGCPs.empty())
1505
0
    {
1506
0
        OGRSpatialReference oSRS;
1507
0
        if (psOptions->osOutputSRS == "null" ||
1508
0
            psOptions->osOutputSRS == "none")
1509
0
        {
1510
            // nothing to do
1511
0
        }
1512
0
        else if (!psOptions->osOutputSRS.empty())
1513
0
        {
1514
0
            oSRS.SetFromUserInput(psOptions->osOutputSRS.c_str());
1515
0
            oSRS.SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER);
1516
0
        }
1517
0
        else
1518
0
        {
1519
0
            const OGRSpatialReference *poSrcSRS = poSrcDS->GetGCPSpatialRef();
1520
0
            if (poSrcSRS)
1521
0
                oSRS = *poSrcSRS;
1522
0
        }
1523
0
        poVDS->SetGCPs(static_cast<int>(psOptions->asGCPs.size()),
1524
0
                       gdal::GCP::c_ptr(psOptions->asGCPs),
1525
0
                       !oSRS.IsEmpty() ? &oSRS : nullptr);
1526
0
    }
1527
1528
0
    else if (!psOptions->bNoGCP && poSrcDSOri->GetGCPCount() > 0)
1529
0
    {
1530
0
        const int nGCPs = poSrcDSOri->GetGCPCount();
1531
1532
0
        GDAL_GCP *pasGCPs = GDALDuplicateGCPs(nGCPs, poSrcDSOri->GetGCPs());
1533
1534
0
        for (int i = 0; i < nGCPs; i++)
1535
0
        {
1536
0
            pasGCPs[i].dfGCPPixel -= psOptions->srcWin.dfXOff;
1537
0
            pasGCPs[i].dfGCPLine -= psOptions->srcWin.dfYOff;
1538
0
            pasGCPs[i].dfGCPPixel *=
1539
0
                nOXSize / static_cast<double>(psOptions->srcWin.dfXSize);
1540
0
            pasGCPs[i].dfGCPLine *=
1541
0
                nOYSize / static_cast<double>(psOptions->srcWin.dfYSize);
1542
0
        }
1543
1544
0
        poVDS->SetGCPs(nGCPs, pasGCPs, poSrcDSOri->GetGCPSpatialRef());
1545
1546
0
        GDALDeinitGCPs(nGCPs, pasGCPs);
1547
0
        CPLFree(pasGCPs);
1548
0
    }
1549
1550
    /* -------------------------------------------------------------------- */
1551
    /*      To make the VRT to look less awkward (but this is optional      */
1552
    /*      in fact), avoid negative values.                                */
1553
    /* -------------------------------------------------------------------- */
1554
0
    GDALTranslateOptions::PixelLineWindow dstWin{
1555
0
        0.0, 0.0, static_cast<double>(nOXSize), static_cast<double>(nOYSize)};
1556
1557
    // When specifying -tr with non-nearest resampling, make sure that the
1558
    // size of target window precisely matches the requested resolution, to
1559
    // avoid any shift.
1560
0
    if (bHasSrcGeoTransform && bHasDstGeoTransform &&
1561
0
        psOptions->dfXRes != 0.0 && !psOptions->osResampling.empty() &&
1562
0
        !EQUALN(psOptions->osResampling.c_str(), "NEAR", 4))
1563
0
    {
1564
0
        dstWin.dfXSize = psOptions->srcWin.dfXSize * srcGT[1] / dstGT[1];
1565
0
        dstWin.dfYSize = psOptions->srcWin.dfYSize * fabs(srcGT[5] / dstGT[5]);
1566
0
    }
1567
1568
0
    GDALTranslateOptions::PixelLineWindow srcWinOri(psOptions->srcWin);
1569
0
    const double dfRatioX =
1570
0
        poSrcDS->GetRasterXSize() == 0
1571
0
            ? 1.0
1572
0
            : static_cast<double>(poSrcDSOri->GetRasterXSize()) /
1573
0
                  poSrcDS->GetRasterXSize();
1574
0
    const double dfRatioY =
1575
0
        poSrcDS->GetRasterYSize() == 0
1576
0
            ? 1.0
1577
0
            : static_cast<double>(poSrcDSOri->GetRasterYSize()) /
1578
0
                  poSrcDS->GetRasterYSize();
1579
0
    psOptions->srcWin.dfXOff /= dfRatioX;
1580
0
    psOptions->srcWin.dfYOff /= dfRatioY;
1581
0
    psOptions->srcWin.dfXSize /= dfRatioX;
1582
0
    psOptions->srcWin.dfYSize /= dfRatioY;
1583
0
    FixSrcDstWindow(psOptions->srcWin, dstWin, poSrcDS->GetRasterXSize(),
1584
0
                    poSrcDS->GetRasterYSize());
1585
1586
    /* -------------------------------------------------------------------- */
1587
    /*      Transfer generally applicable metadata.                         */
1588
    /* -------------------------------------------------------------------- */
1589
0
    char **papszMetadata = CSLDuplicate(poSrcDS->GetMetadata());
1590
0
    if (!psOptions->asScaleParams.empty() || psOptions->bUnscale ||
1591
0
        psOptions->eOutputType != GDT_Unknown)
1592
0
    {
1593
        /* Remove TIFFTAG_MINSAMPLEVALUE and TIFFTAG_MAXSAMPLEVALUE */
1594
        /* if the data range may change because of options */
1595
0
        char **papszIter = papszMetadata;
1596
0
        while (papszIter && *papszIter)
1597
0
        {
1598
0
            if (STARTS_WITH_CI(*papszIter, "TIFFTAG_MINSAMPLEVALUE=") ||
1599
0
                STARTS_WITH_CI(*papszIter, "TIFFTAG_MAXSAMPLEVALUE="))
1600
0
            {
1601
0
                CPLFree(*papszIter);
1602
0
                memmove(papszIter, papszIter + 1,
1603
0
                        sizeof(char *) * (CSLCount(papszIter + 1) + 1));
1604
0
            }
1605
0
            else
1606
0
                papszIter++;
1607
0
        }
1608
0
    }
1609
1610
    // Remove NITF_BLOCKA_ stuff if georeferencing is changed
1611
0
    if (!(psOptions->srcWin.dfXOff == 0 && psOptions->srcWin.dfYOff == 0 &&
1612
0
          psOptions->srcWin.dfXSize == poSrcDS->GetRasterXSize() &&
1613
0
          psOptions->srcWin.dfYSize == poSrcDS->GetRasterYSize() &&
1614
0
          psOptions->asGCPs.empty() && !bGotBounds && !bGotGeoTransform))
1615
0
    {
1616
0
        char **papszIter = papszMetadata;
1617
0
        while (papszIter && *papszIter)
1618
0
        {
1619
0
            if (STARTS_WITH_CI(*papszIter, "NITF_BLOCKA_"))
1620
0
            {
1621
0
                CPLFree(*papszIter);
1622
0
                memmove(papszIter, papszIter + 1,
1623
0
                        sizeof(char *) * (CSLCount(papszIter + 1) + 1));
1624
0
            }
1625
0
            else
1626
0
                papszIter++;
1627
0
        }
1628
0
    }
1629
1630
0
    {
1631
0
        char **papszIter = papszMetadata;
1632
0
        while (papszIter && *papszIter)
1633
0
        {
1634
            // Do not preserve the CACHE_PATH from the WMS driver
1635
0
            if (STARTS_WITH_CI(*papszIter, "CACHE_PATH="))
1636
0
            {
1637
0
                CPLFree(*papszIter);
1638
0
                memmove(papszIter, papszIter + 1,
1639
0
                        sizeof(char *) * (CSLCount(papszIter + 1) + 1));
1640
0
            }
1641
0
            else
1642
0
                papszIter++;
1643
0
        }
1644
0
    }
1645
1646
0
    if (CSLFetchNameValue(papszMetadata, "NODATA_VALUES") &&
1647
0
        !(bAllBandsInOrder &&
1648
0
          psOptions->nBandCount == poSrcDS->GetRasterCount()))
1649
0
    {
1650
0
        papszMetadata =
1651
0
            CSLSetNameValue(papszMetadata, "NODATA_VALUES", nullptr);
1652
0
    }
1653
1654
0
    poVDS->SetMetadata(papszMetadata);
1655
0
    CSLDestroy(papszMetadata);
1656
0
    AttachMetadata(GDALDataset::ToHandle(poVDS), psOptions->aosMetadataOptions);
1657
1658
0
    AttachDomainMetadata(GDALDataset::ToHandle(poVDS),
1659
0
                         psOptions->aosDomainMetadataOptions);
1660
1661
0
    const char *pszInterleave =
1662
0
        poSrcDS->GetMetadataItem("INTERLEAVE", "IMAGE_STRUCTURE");
1663
0
    if (pszInterleave)
1664
0
        poVDS->SetMetadataItem("INTERLEAVE", pszInterleave, "IMAGE_STRUCTURE");
1665
1666
0
    {
1667
0
        const char *pszCompression =
1668
0
            poSrcDS->GetMetadataItem("COMPRESSION", "IMAGE_STRUCTURE");
1669
0
        if (pszCompression)
1670
0
        {
1671
0
            poVDS->SetMetadataItem("COMPRESSION", pszCompression,
1672
0
                                   "IMAGE_STRUCTURE");
1673
0
        }
1674
0
    }
1675
1676
    /* ISIS3 metadata preservation */
1677
0
    char **papszMD_ISIS3 = poSrcDS->GetMetadata("json:ISIS3");
1678
0
    if (papszMD_ISIS3 != nullptr)
1679
0
    {
1680
0
        if (!bAllBandsInOrder)
1681
0
        {
1682
0
            CPLString osJSON = EditISIS3MetadataForBandChange(
1683
0
                papszMD_ISIS3[0], poSrcDS->GetRasterCount(), psOptions.get());
1684
0
            if (!osJSON.empty())
1685
0
            {
1686
0
                char *apszMD[] = {&osJSON[0], nullptr};
1687
0
                poVDS->SetMetadata(apszMD, "json:ISIS3");
1688
0
            }
1689
0
        }
1690
0
        else
1691
0
        {
1692
0
            poVDS->SetMetadata(papszMD_ISIS3, "json:ISIS3");
1693
0
        }
1694
0
    }
1695
1696
    // PDS4 -> PDS4 special case
1697
0
    if (EQUAL(psOptions->osFormat.c_str(), "PDS4"))
1698
0
    {
1699
0
        char **papszMD_PDS4 = poSrcDS->GetMetadata("xml:PDS4");
1700
0
        if (papszMD_PDS4 != nullptr)
1701
0
            poVDS->SetMetadata(papszMD_PDS4, "xml:PDS4");
1702
0
    }
1703
1704
    // VICAR -> VICAR special case
1705
0
    if (EQUAL(psOptions->osFormat.c_str(), "VICAR"))
1706
0
    {
1707
0
        char **papszMD_VICAR = poSrcDS->GetMetadata("json:VICAR");
1708
0
        if (papszMD_VICAR != nullptr)
1709
0
            poVDS->SetMetadata(papszMD_VICAR, "json:VICAR");
1710
0
    }
1711
1712
    // Copy XMP metadata
1713
0
    if (!psOptions->bNoXMP)
1714
0
    {
1715
0
        char **papszXMP = poSrcDS->GetMetadata("xml:XMP");
1716
0
        if (papszXMP != nullptr && *papszXMP != nullptr)
1717
0
        {
1718
0
            poVDS->SetMetadata(papszXMP, "xml:XMP");
1719
0
        }
1720
0
    }
1721
1722
    /* -------------------------------------------------------------------- */
1723
    /*      Transfer metadata that remains valid if the spatial             */
1724
    /*      arrangement of the data is unaltered.                           */
1725
    /* -------------------------------------------------------------------- */
1726
0
    if (bSpatialArrangementPreserved)
1727
0
    {
1728
0
        char **papszMD = poSrcDS->GetMetadata("RPC");
1729
0
        if (papszMD != nullptr)
1730
0
            poVDS->SetMetadata(papszMD, "RPC");
1731
1732
0
        papszMD = poSrcDS->GetMetadata("GEOLOCATION");
1733
0
        if (papszMD != nullptr)
1734
0
            poVDS->SetMetadata(papszMD, "GEOLOCATION");
1735
0
    }
1736
0
    else
1737
0
    {
1738
0
        char **papszMD = poSrcDSOri->GetMetadata("RPC");
1739
0
        if (papszMD != nullptr)
1740
0
        {
1741
0
            papszMD = CSLDuplicate(papszMD);
1742
1743
0
            double dfSAMP_OFF =
1744
0
                CPLAtof(CSLFetchNameValueDef(papszMD, "SAMP_OFF", "0"));
1745
0
            double dfLINE_OFF =
1746
0
                CPLAtof(CSLFetchNameValueDef(papszMD, "LINE_OFF", "0"));
1747
0
            double dfSAMP_SCALE =
1748
0
                CPLAtof(CSLFetchNameValueDef(papszMD, "SAMP_SCALE", "1"));
1749
0
            double dfLINE_SCALE =
1750
0
                CPLAtof(CSLFetchNameValueDef(papszMD, "LINE_SCALE", "1"));
1751
1752
0
            dfSAMP_OFF -= srcWinOri.dfXOff;
1753
0
            dfLINE_OFF -= srcWinOri.dfYOff;
1754
1755
0
            const double df2 = srcWinOri.dfXSize;
1756
0
            const double df3 = srcWinOri.dfYSize;
1757
0
            const double dfXRatio = nOXSize / df2;
1758
0
            const double dfYRatio = nOYSize / df3;
1759
1760
            // For line offset and pixel offset, we need to convert from RPC
1761
            // pixel center registration convention to GDAL pixel top-left corner
1762
            // registration convention by adding an initial 0.5 shift, and un-apply
1763
            // it after scaling.
1764
1765
0
            dfSAMP_OFF += 0.5;
1766
0
            dfSAMP_OFF *= dfXRatio;
1767
0
            dfSAMP_OFF -= 0.5;
1768
1769
0
            dfLINE_OFF += 0.5;
1770
0
            dfLINE_OFF *= dfYRatio;
1771
0
            dfLINE_OFF -= 0.5;
1772
1773
0
            dfSAMP_SCALE *= dfXRatio;
1774
0
            dfLINE_SCALE *= dfYRatio;
1775
1776
0
            CPLString osField;
1777
0
            osField.Printf("%.15g", dfLINE_OFF);
1778
0
            papszMD = CSLSetNameValue(papszMD, "LINE_OFF", osField);
1779
1780
0
            osField.Printf("%.15g", dfSAMP_OFF);
1781
0
            papszMD = CSLSetNameValue(papszMD, "SAMP_OFF", osField);
1782
1783
0
            osField.Printf("%.15g", dfLINE_SCALE);
1784
0
            papszMD = CSLSetNameValue(papszMD, "LINE_SCALE", osField);
1785
1786
0
            osField.Printf("%.15g", dfSAMP_SCALE);
1787
0
            papszMD = CSLSetNameValue(papszMD, "SAMP_SCALE", osField);
1788
1789
0
            poVDS->SetMetadata(papszMD, "RPC");
1790
0
            CSLDestroy(papszMD);
1791
0
        }
1792
0
    }
1793
1794
0
    const int nSrcBandCount = psOptions->nBandCount;
1795
1796
0
    if (psOptions->nRGBExpand != 0)
1797
0
    {
1798
0
        GDALRasterBand *poSrcBand =
1799
0
            poSrcDS->GetRasterBand(std::abs(psOptions->anBandList[0]));
1800
0
        if (psOptions->anBandList[0] < 0)
1801
0
            poSrcBand = poSrcBand->GetMaskBand();
1802
0
        GDALColorTable *poColorTable = poSrcBand->GetColorTable();
1803
0
        if (poColorTable == nullptr)
1804
0
        {
1805
0
            CPLError(CE_Failure, CPLE_AppDefined,
1806
0
                     "Error : band %d has no color table",
1807
0
                     std::abs(psOptions->anBandList[0]));
1808
0
            GDALClose(poVDS);
1809
0
            return nullptr;
1810
0
        }
1811
1812
        /* Check that the color table only contains gray levels */
1813
        /* when using -expand gray */
1814
0
        if (psOptions->nRGBExpand == 1)
1815
0
        {
1816
0
            int nColorCount = poColorTable->GetColorEntryCount();
1817
0
            for (int nColor = 0; nColor < nColorCount; nColor++)
1818
0
            {
1819
0
                const GDALColorEntry *poEntry =
1820
0
                    poColorTable->GetColorEntry(nColor);
1821
0
                if (poEntry->c1 != poEntry->c2 || poEntry->c1 != poEntry->c3)
1822
0
                {
1823
0
                    CPLError(CE_Warning, CPLE_AppDefined,
1824
0
                             "Warning : color table contains non gray levels "
1825
0
                             "colors");
1826
0
                    break;
1827
0
                }
1828
0
            }
1829
0
        }
1830
1831
0
        if (psOptions->nBandCount == 1)
1832
0
        {
1833
0
            psOptions->nBandCount = psOptions->nRGBExpand;
1834
0
        }
1835
0
        else if (psOptions->nBandCount == 2 &&
1836
0
                 (psOptions->nRGBExpand == 3 || psOptions->nRGBExpand == 4))
1837
0
        {
1838
0
            psOptions->nBandCount = psOptions->nRGBExpand;
1839
0
        }
1840
0
        else
1841
0
        {
1842
0
            CPLError(CE_Failure, CPLE_IllegalArg,
1843
0
                     "Error : invalid use of -expand option.");
1844
0
            GDALClose(poVDS);
1845
0
            return nullptr;
1846
0
        }
1847
0
    }
1848
1849
    // Can be set to TRUE in the band loop too
1850
0
    bool bFilterOutStatsMetadata =
1851
0
        !psOptions->asScaleParams.empty() || psOptions->bUnscale ||
1852
0
        !bSpatialArrangementPreserved || psOptions->nRGBExpand != 0;
1853
1854
0
    if (static_cast<int>(psOptions->anColorInterp.size()) >
1855
0
        psOptions->nBandCount)
1856
0
    {
1857
0
        CPLError(CE_Warning, CPLE_AppDefined,
1858
0
                 "More bands defined in -colorinterp than output bands");
1859
0
    }
1860
1861
    /* ==================================================================== */
1862
    /*      Process all bands.                                              */
1863
    /* ==================================================================== */
1864
0
    GDALDataType eOutputType = psOptions->eOutputType;
1865
1866
0
    for (int i = 0; i < psOptions->nBandCount; i++)
1867
0
    {
1868
0
        int nComponent = 0;
1869
0
        int nSrcBand = 0;
1870
1871
0
        if (psOptions->nRGBExpand != 0)
1872
0
        {
1873
0
            if (nSrcBandCount == 2 && psOptions->nRGBExpand == 4 && i == 3)
1874
0
                nSrcBand = psOptions->anBandList[1];
1875
0
            else
1876
0
            {
1877
0
                nSrcBand = psOptions->anBandList[0];
1878
0
                nComponent = i + 1;
1879
0
            }
1880
0
        }
1881
0
        else
1882
0
        {
1883
0
            nSrcBand = psOptions->anBandList[i];
1884
0
        }
1885
1886
0
        GDALRasterBand *poSrcBand = poSrcDS->GetRasterBand(std::abs(nSrcBand));
1887
1888
        /* --------------------------------------------------------------------
1889
         */
1890
        /*      Select output data type to match source. */
1891
        /* --------------------------------------------------------------------
1892
         */
1893
0
        GDALRasterBand *poRealSrcBand =
1894
0
            (nSrcBand < 0) ? poSrcBand->GetMaskBand() : poSrcBand;
1895
0
        GDALDataType eBandType;
1896
0
        if (eOutputType == GDT_Unknown)
1897
0
        {
1898
0
            eBandType = poRealSrcBand->GetRasterDataType();
1899
0
            if (eBandType != GDT_Byte && psOptions->nRGBExpand != 0)
1900
0
            {
1901
                // Use case of https://github.com/OSGeo/gdal/issues/9402
1902
0
                if (const auto poColorTable = poRealSrcBand->GetColorTable())
1903
0
                {
1904
0
                    bool bIn0To255Range = true;
1905
0
                    const int nColorCount = poColorTable->GetColorEntryCount();
1906
0
                    for (int nColor = 0; nColor < nColorCount; nColor++)
1907
0
                    {
1908
0
                        const GDALColorEntry *poEntry =
1909
0
                            poColorTable->GetColorEntry(nColor);
1910
0
                        if (poEntry->c1 > 255 || poEntry->c2 > 255 ||
1911
0
                            poEntry->c3 > 255 || poEntry->c4 > 255)
1912
0
                        {
1913
0
                            bIn0To255Range = false;
1914
0
                            break;
1915
0
                        }
1916
0
                    }
1917
0
                    if (bIn0To255Range)
1918
0
                    {
1919
0
                        if (!psOptions->bQuiet)
1920
0
                        {
1921
0
                            CPLError(CE_Warning, CPLE_AppDefined,
1922
0
                                     "Using Byte output data type due to range "
1923
0
                                     "of values in color table");
1924
0
                        }
1925
0
                        eBandType = GDT_Byte;
1926
0
                    }
1927
0
                }
1928
0
                eOutputType = eBandType;
1929
0
            }
1930
0
        }
1931
0
        else
1932
0
        {
1933
0
            eBandType = eOutputType;
1934
1935
            // Check that we can copy existing statistics
1936
0
            GDALDataType eSrcBandType = poRealSrcBand->GetRasterDataType();
1937
0
            const char *pszMin =
1938
0
                poRealSrcBand->GetMetadataItem("STATISTICS_MINIMUM");
1939
0
            const char *pszMax =
1940
0
                poRealSrcBand->GetMetadataItem("STATISTICS_MAXIMUM");
1941
0
            if (!bFilterOutStatsMetadata && eBandType != eSrcBandType &&
1942
0
                pszMin != nullptr && pszMax != nullptr)
1943
0
            {
1944
0
                const bool bSrcIsInteger =
1945
0
                    CPL_TO_BOOL(GDALDataTypeIsInteger(eSrcBandType) &&
1946
0
                                !GDALDataTypeIsComplex(eSrcBandType));
1947
0
                const bool bDstIsInteger =
1948
0
                    CPL_TO_BOOL(GDALDataTypeIsInteger(eBandType) &&
1949
0
                                !GDALDataTypeIsComplex(eBandType));
1950
0
                if (bSrcIsInteger && bDstIsInteger)
1951
0
                {
1952
0
                    std::int64_t nDstMin = 0;
1953
0
                    std::uint64_t nDstMax = 0;
1954
0
                    switch (eBandType)
1955
0
                    {
1956
0
                        case GDT_Byte:
1957
0
                            nDstMin = std::numeric_limits<std::uint8_t>::min();
1958
0
                            nDstMax = std::numeric_limits<std::uint8_t>::max();
1959
0
                            break;
1960
0
                        case GDT_Int8:
1961
0
                            nDstMin = std::numeric_limits<std::int8_t>::min();
1962
0
                            nDstMax = std::numeric_limits<std::int8_t>::max();
1963
0
                            break;
1964
0
                        case GDT_UInt16:
1965
0
                            nDstMin = std::numeric_limits<std::uint16_t>::min();
1966
0
                            nDstMax = std::numeric_limits<std::uint16_t>::max();
1967
0
                            break;
1968
0
                        case GDT_Int16:
1969
0
                            nDstMin = std::numeric_limits<std::int16_t>::min();
1970
0
                            nDstMax = std::numeric_limits<std::int16_t>::max();
1971
0
                            break;
1972
0
                        case GDT_UInt32:
1973
0
                            nDstMin = std::numeric_limits<std::uint32_t>::min();
1974
0
                            nDstMax = std::numeric_limits<std::uint32_t>::max();
1975
0
                            break;
1976
0
                        case GDT_Int32:
1977
0
                            nDstMin = std::numeric_limits<std::int32_t>::min();
1978
0
                            nDstMax = std::numeric_limits<std::int32_t>::max();
1979
0
                            break;
1980
0
                        case GDT_UInt64:
1981
0
                            nDstMin = std::numeric_limits<std::uint64_t>::min();
1982
0
                            nDstMax = std::numeric_limits<std::uint64_t>::max();
1983
0
                            break;
1984
0
                        case GDT_Int64:
1985
0
                            nDstMin = std::numeric_limits<std::int64_t>::min();
1986
0
                            nDstMax = std::numeric_limits<std::int64_t>::max();
1987
0
                            break;
1988
0
                        default:
1989
0
                            CPLAssert(false);
1990
0
                            break;
1991
0
                    }
1992
1993
0
                    try
1994
0
                    {
1995
0
                        const auto nMin = std::stoll(pszMin);
1996
0
                        const auto nMax = std::stoull(pszMax);
1997
0
                        if (nMin < nDstMin || nMax > nDstMax)
1998
0
                            bFilterOutStatsMetadata = true;
1999
0
                    }
2000
0
                    catch (const std::exception &)
2001
0
                    {
2002
0
                    }
2003
0
                }
2004
                // Float64 is large enough to hold all integer <= 32 bit or
2005
                // float32 values there might be other OK cases, but ere on safe
2006
                // side for now
2007
0
                else if (!((bSrcIsInteger || eSrcBandType == GDT_Float32) &&
2008
0
                           eBandType == GDT_Float64))
2009
0
                {
2010
0
                    bFilterOutStatsMetadata = true;
2011
0
                }
2012
0
            }
2013
0
        }
2014
2015
        /* --------------------------------------------------------------------
2016
         */
2017
        /*      Create this band. */
2018
        /* --------------------------------------------------------------------
2019
         */
2020
0
        CPLStringList aosAddBandOptions;
2021
0
        int nSrcBlockXSize, nSrcBlockYSize;
2022
0
        poSrcBand->GetBlockSize(&nSrcBlockXSize, &nSrcBlockYSize);
2023
0
        if (bKeepResolution &&
2024
0
            (fmod(psOptions->srcWin.dfXOff, nSrcBlockXSize)) == 0 &&
2025
0
            (fmod(psOptions->srcWin.dfYOff, nSrcBlockYSize)) == 0)
2026
0
        {
2027
0
            aosAddBandOptions.SetNameValue("BLOCKXSIZE",
2028
0
                                           CPLSPrintf("%d", nSrcBlockXSize));
2029
0
            aosAddBandOptions.SetNameValue("BLOCKYSIZE",
2030
0
                                           CPLSPrintf("%d", nSrcBlockYSize));
2031
0
        }
2032
0
        const char *pszBlockXSize =
2033
0
            psOptions->aosCreateOptions.FetchNameValue("BLOCKXSIZE");
2034
0
        if (pszBlockXSize)
2035
0
            aosAddBandOptions.SetNameValue("BLOCKXSIZE", pszBlockXSize);
2036
0
        const char *pszBlockYSize =
2037
0
            psOptions->aosCreateOptions.FetchNameValue("BLOCKYSIZE");
2038
0
        if (pszBlockYSize)
2039
0
            aosAddBandOptions.SetNameValue("BLOCKYSIZE", pszBlockYSize);
2040
0
        poVDS->AddBand(eBandType, aosAddBandOptions.List());
2041
0
        VRTSourcedRasterBand *poVRTBand =
2042
0
            static_cast<VRTSourcedRasterBand *>(poVDS->GetRasterBand(i + 1));
2043
2044
0
        if (nSrcBand < 0)
2045
0
        {
2046
0
            poVRTBand->AddMaskBandSource(
2047
0
                poSrcBand, psOptions->srcWin.dfXOff, psOptions->srcWin.dfYOff,
2048
0
                psOptions->srcWin.dfXSize, psOptions->srcWin.dfYSize,
2049
0
                dstWin.dfXOff, dstWin.dfYOff, dstWin.dfXSize, dstWin.dfYSize);
2050
2051
            // Color interpretation override
2052
0
            if (!psOptions->anColorInterp.empty())
2053
0
            {
2054
0
                if (i < static_cast<int>(psOptions->anColorInterp.size()) &&
2055
0
                    psOptions->anColorInterp[i] >= 0)
2056
0
                {
2057
0
                    poVRTBand->SetColorInterpretation(
2058
0
                        static_cast<GDALColorInterp>(
2059
0
                            psOptions->anColorInterp[i]));
2060
0
                }
2061
0
            }
2062
2063
0
            continue;
2064
0
        }
2065
2066
        // Preserve NBITS if no option change values
2067
0
        const char *pszNBits =
2068
0
            poSrcBand->GetMetadataItem("NBITS", "IMAGE_STRUCTURE");
2069
0
        if (pszNBits && psOptions->nRGBExpand == 0 &&
2070
0
            psOptions->asScaleParams.empty() && !psOptions->bUnscale &&
2071
0
            psOptions->eOutputType == GDT_Unknown &&
2072
0
            psOptions->osResampling.empty())
2073
0
        {
2074
0
            poVRTBand->SetMetadataItem("NBITS", pszNBits, "IMAGE_STRUCTURE");
2075
0
        }
2076
2077
        // Preserve PIXELTYPE if no option change values
2078
0
        if (poSrcBand->GetRasterDataType() == GDT_Byte &&
2079
0
            psOptions->nRGBExpand == 0 && psOptions->asScaleParams.empty() &&
2080
0
            !psOptions->bUnscale && psOptions->eOutputType == GDT_Unknown &&
2081
0
            psOptions->osResampling.empty())
2082
0
        {
2083
0
            poSrcBand->EnablePixelTypeSignedByteWarning(false);
2084
0
            const char *pszPixelType =
2085
0
                poSrcBand->GetMetadataItem("PIXELTYPE", "IMAGE_STRUCTURE");
2086
0
            poSrcBand->EnablePixelTypeSignedByteWarning(true);
2087
0
            if (pszPixelType)
2088
0
            {
2089
0
                poVRTBand->SetMetadataItem("PIXELTYPE", pszPixelType,
2090
0
                                           "IMAGE_STRUCTURE");
2091
0
            }
2092
0
        }
2093
2094
0
        const char *pszCompression =
2095
0
            poSrcBand->GetMetadataItem("COMPRESSION", "IMAGE_STRUCTURE");
2096
0
        if (pszCompression)
2097
0
        {
2098
0
            poVRTBand->SetMetadataItem("COMPRESSION", pszCompression,
2099
0
                                       "IMAGE_STRUCTURE");
2100
0
        }
2101
2102
        /* --------------------------------------------------------------------
2103
         */
2104
        /*      Do we need to collect scaling information? */
2105
        /* --------------------------------------------------------------------
2106
         */
2107
0
        double dfScale = 1.0;
2108
0
        double dfOffset = 0.0;
2109
0
        bool bScale = false;
2110
0
        double dfScaleSrcMin = std::numeric_limits<double>::quiet_NaN();
2111
0
        double dfScaleSrcMax = std::numeric_limits<double>::quiet_NaN();
2112
0
        double dfScaleDstMin = std::numeric_limits<double>::quiet_NaN();
2113
0
        double dfScaleDstMax = std::numeric_limits<double>::quiet_NaN();
2114
0
        bool bExponentScaling = false;
2115
0
        double dfExponent = 0.0;
2116
2117
0
        if (i < static_cast<int>(psOptions->asScaleParams.size()) &&
2118
0
            psOptions->asScaleParams[i].bScale)
2119
0
        {
2120
0
            bScale = psOptions->asScaleParams[i].bScale;
2121
0
            dfScaleSrcMin = psOptions->asScaleParams[i].dfScaleSrcMin;
2122
0
            dfScaleSrcMax = psOptions->asScaleParams[i].dfScaleSrcMax;
2123
0
            dfScaleDstMin = psOptions->asScaleParams[i].dfScaleDstMin;
2124
0
            dfScaleDstMax = psOptions->asScaleParams[i].dfScaleDstMax;
2125
0
        }
2126
0
        else if (psOptions->asScaleParams.size() == 1 &&
2127
0
                 !psOptions->bHasUsedExplicitScaleBand)
2128
0
        {
2129
0
            bScale = psOptions->asScaleParams[0].bScale;
2130
0
            dfScaleSrcMin = psOptions->asScaleParams[0].dfScaleSrcMin;
2131
0
            dfScaleSrcMax = psOptions->asScaleParams[0].dfScaleSrcMax;
2132
0
            dfScaleDstMin = psOptions->asScaleParams[0].dfScaleDstMin;
2133
0
            dfScaleDstMax = psOptions->asScaleParams[0].dfScaleDstMax;
2134
0
        }
2135
2136
0
        if (i < static_cast<int>(psOptions->adfExponent.size()) &&
2137
0
            psOptions->adfExponent[i] != 0.0)
2138
0
        {
2139
0
            bExponentScaling = TRUE;
2140
0
            dfExponent = psOptions->adfExponent[i];
2141
0
        }
2142
0
        else if (psOptions->adfExponent.size() == 1 &&
2143
0
                 !psOptions->bHasUsedExplicitExponentBand)
2144
0
        {
2145
0
            bExponentScaling = TRUE;
2146
0
            dfExponent = psOptions->adfExponent[0];
2147
0
        }
2148
2149
0
        if (bExponentScaling && !bScale)
2150
0
        {
2151
0
            CPLError(CE_Failure, CPLE_IllegalArg,
2152
0
                     "For band %d, -scale should be specified when -exponent "
2153
0
                     "is specified.",
2154
0
                     i + 1);
2155
0
            if (pbUsageError)
2156
0
                *pbUsageError = TRUE;
2157
0
            delete poVDS;
2158
0
            poSrcDS->Release();
2159
0
            return nullptr;
2160
0
        }
2161
2162
0
        if (bScale && std::isnan(dfScaleSrcMin))
2163
0
        {
2164
0
            double adfCMinMax[2] = {};
2165
0
            GDALComputeRasterMinMax(poSrcBand, TRUE, adfCMinMax);
2166
0
            dfScaleSrcMin = adfCMinMax[0];
2167
0
            dfScaleSrcMax = adfCMinMax[1];
2168
0
        }
2169
2170
0
        if (bScale)
2171
0
        {
2172
            /* To avoid a divide by zero */
2173
0
            if (dfScaleSrcMax == dfScaleSrcMin)
2174
0
                dfScaleSrcMax += 0.1;
2175
2176
            // Can still occur for very big values
2177
0
            if (dfScaleSrcMax == dfScaleSrcMin)
2178
0
            {
2179
0
                CPLError(CE_Failure, CPLE_AppDefined,
2180
0
                         "-scale cannot be applied due to source "
2181
0
                         "minimum and maximum being equal");
2182
0
                delete poVDS;
2183
0
                poSrcDS->Release();
2184
0
                return nullptr;
2185
0
            }
2186
2187
0
            if (std::isnan(dfScaleDstMin))
2188
0
            {
2189
0
                switch (poVRTBand->GetRasterDataType())
2190
0
                {
2191
0
                    case GDT_Byte:
2192
0
                        dfScaleDstMin = std::numeric_limits<uint8_t>::lowest();
2193
0
                        dfScaleDstMax = std::numeric_limits<uint8_t>::max();
2194
0
                        break;
2195
0
                    case GDT_Int8:
2196
0
                        dfScaleDstMin = std::numeric_limits<int8_t>::lowest();
2197
0
                        dfScaleDstMax = std::numeric_limits<int8_t>::max();
2198
0
                        break;
2199
0
                    case GDT_UInt16:
2200
0
                        dfScaleDstMin = std::numeric_limits<uint16_t>::lowest();
2201
0
                        dfScaleDstMax = std::numeric_limits<uint16_t>::max();
2202
0
                        break;
2203
0
                    case GDT_Int16:
2204
0
                    case GDT_CInt16:
2205
0
                        dfScaleDstMin = std::numeric_limits<int16_t>::lowest();
2206
0
                        dfScaleDstMax = std::numeric_limits<int16_t>::max();
2207
0
                        break;
2208
0
                    case GDT_UInt32:
2209
0
                        dfScaleDstMin = std::numeric_limits<uint32_t>::lowest();
2210
0
                        dfScaleDstMax = std::numeric_limits<uint32_t>::max();
2211
0
                        break;
2212
0
                    case GDT_Int32:
2213
0
                    case GDT_CInt32:
2214
0
                        dfScaleDstMin = std::numeric_limits<int32_t>::lowest();
2215
0
                        dfScaleDstMax = std::numeric_limits<int32_t>::max();
2216
0
                        break;
2217
0
                    case GDT_UInt64:
2218
0
                        dfScaleDstMin = static_cast<double>(
2219
0
                            std::numeric_limits<uint64_t>::lowest());
2220
0
                        dfScaleDstMax = static_cast<double>(
2221
0
                            std::numeric_limits<uint64_t>::max() - 2048);
2222
0
                        break;
2223
0
                    case GDT_Int64:
2224
0
                        dfScaleDstMin = static_cast<double>(
2225
0
                            std::numeric_limits<int64_t>::lowest() + 1024);
2226
0
                        dfScaleDstMax = static_cast<double>(
2227
0
                            std::numeric_limits<int64_t>::max() - 2048);
2228
0
                        break;
2229
0
                    case GDT_Float16:
2230
0
                    case GDT_Float32:
2231
0
                    case GDT_Float64:
2232
0
                    case GDT_CFloat16:
2233
0
                    case GDT_CFloat32:
2234
0
                    case GDT_CFloat64:
2235
0
                    case GDT_Unknown:
2236
0
                    case GDT_TypeCount:
2237
0
                        dfScaleDstMin = 0;
2238
0
                        dfScaleDstMax = 1;
2239
0
                        break;
2240
0
                }
2241
0
            }
2242
2243
0
            if (!bExponentScaling)
2244
0
            {
2245
0
                dfScale = (dfScaleDstMax - dfScaleDstMin) /
2246
0
                          (dfScaleSrcMax - dfScaleSrcMin);
2247
0
                dfOffset = -1 * dfScaleSrcMin * dfScale + dfScaleDstMin;
2248
0
            }
2249
0
        }
2250
2251
0
        if (psOptions->bUnscale)
2252
0
        {
2253
0
            dfScale = poSrcBand->GetScale();
2254
0
            dfOffset = poSrcBand->GetOffset();
2255
0
        }
2256
2257
        /* --------------------------------------------------------------------
2258
         */
2259
        /*      Create a simple or complex data source depending on the */
2260
        /*      translation type required. */
2261
        /* --------------------------------------------------------------------
2262
         */
2263
0
        std::unique_ptr<VRTSimpleSource> poSimpleSource;
2264
0
        if (psOptions->bUnscale || bScale ||
2265
0
            (psOptions->nRGBExpand != 0 && i < psOptions->nRGBExpand))
2266
0
        {
2267
0
            auto poComplexSource = std::make_unique<VRTComplexSource>();
2268
2269
            /* --------------------------------------------------------------------
2270
             */
2271
            /*      Set complex parameters. */
2272
            /* --------------------------------------------------------------------
2273
             */
2274
2275
0
            if (dfOffset != 0.0 || dfScale != 1.0)
2276
0
            {
2277
0
                poComplexSource->SetLinearScaling(dfOffset, dfScale);
2278
0
            }
2279
0
            else if (bExponentScaling)
2280
0
            {
2281
0
                poComplexSource->SetPowerScaling(
2282
0
                    dfExponent, dfScaleSrcMin, dfScaleSrcMax, dfScaleDstMin,
2283
0
                    dfScaleDstMax, !psOptions->bNoClip);
2284
0
            }
2285
2286
0
            poComplexSource->SetColorTableComponent(nComponent);
2287
2288
0
            int bSuccess;
2289
0
            double dfNoData = poSrcBand->GetNoDataValue(&bSuccess);
2290
0
            if (bSuccess)
2291
0
            {
2292
0
                poComplexSource->SetNoDataValue(dfNoData);
2293
0
            }
2294
2295
0
            poSimpleSource = std::move(poComplexSource);
2296
0
        }
2297
0
        else
2298
0
        {
2299
0
            poSimpleSource = std::make_unique<VRTSimpleSource>();
2300
0
        }
2301
2302
0
        poSimpleSource->SetResampling(psOptions->osResampling.empty()
2303
0
                                          ? nullptr
2304
0
                                          : psOptions->osResampling.c_str());
2305
0
        poVRTBand->ConfigureSource(
2306
0
            poSimpleSource.get(), poSrcBand, FALSE, psOptions->srcWin.dfXOff,
2307
0
            psOptions->srcWin.dfYOff, psOptions->srcWin.dfXSize,
2308
0
            psOptions->srcWin.dfYSize, dstWin.dfXOff, dstWin.dfYOff,
2309
0
            dstWin.dfXSize, dstWin.dfYSize);
2310
2311
0
        poVRTBand->AddSource(std::move(poSimpleSource));
2312
2313
        /* --------------------------------------------------------------------
2314
         */
2315
        /*      In case of color table translate, we only set the color */
2316
        /*      interpretation other info copied by CopyBandInfo are */
2317
        /*      not relevant in RGB expansion. */
2318
        /* --------------------------------------------------------------------
2319
         */
2320
0
        if (psOptions->nRGBExpand == 1)
2321
0
        {
2322
0
            poVRTBand->SetColorInterpretation(GCI_GrayIndex);
2323
0
        }
2324
0
        else if (psOptions->nRGBExpand != 0 && i < psOptions->nRGBExpand)
2325
0
        {
2326
0
            poVRTBand->SetColorInterpretation(
2327
0
                static_cast<GDALColorInterp>(GCI_RedBand + i));
2328
0
        }
2329
2330
        /* --------------------------------------------------------------------
2331
         */
2332
        /*      copy over some other information of interest. */
2333
        /* --------------------------------------------------------------------
2334
         */
2335
0
        else
2336
0
        {
2337
0
            CopyBandInfo(poSrcBand, poVRTBand,
2338
0
                         !psOptions->bStats && !bFilterOutStatsMetadata,
2339
0
                         !psOptions->bUnscale && !psOptions->bSetScale &&
2340
0
                             !psOptions->bSetOffset,
2341
0
                         !psOptions->bSetNoData && !psOptions->bUnsetNoData,
2342
0
                         !psOptions->bNoRAT, psOptions.get());
2343
0
            if (psOptions->asScaleParams.empty() &&
2344
0
                psOptions->adfExponent.empty() &&
2345
0
                EQUAL(psOptions->osFormat.c_str(), "GRIB"))
2346
0
            {
2347
0
                char **papszMD_GRIB = poSrcBand->GetMetadata("GRIB");
2348
0
                if (papszMD_GRIB != nullptr)
2349
0
                    poVRTBand->SetMetadata(papszMD_GRIB, "GRIB");
2350
0
            }
2351
0
        }
2352
2353
        // Color interpretation override
2354
0
        if (!psOptions->anColorInterp.empty())
2355
0
        {
2356
0
            if (i < static_cast<int>(psOptions->anColorInterp.size()) &&
2357
0
                psOptions->anColorInterp[i] >= 0)
2358
0
            {
2359
0
                poVRTBand->SetColorInterpretation(
2360
0
                    static_cast<GDALColorInterp>(psOptions->anColorInterp[i]));
2361
0
            }
2362
0
        }
2363
2364
        /* --------------------------------------------------------------------
2365
         */
2366
        /*      Set a forcible nodata value? */
2367
        /* --------------------------------------------------------------------
2368
         */
2369
0
        if (psOptions->bSetNoData)
2370
0
        {
2371
0
            const char *pszPixelType =
2372
0
                psOptions->aosCreateOptions.FetchNameValue("PIXELTYPE");
2373
0
            if (pszPixelType == nullptr &&
2374
0
                poVRTBand->GetRasterDataType() == GDT_Byte)
2375
0
            {
2376
0
                poVRTBand->EnablePixelTypeSignedByteWarning(false);
2377
0
                pszPixelType =
2378
0
                    poVRTBand->GetMetadataItem("PIXELTYPE", "IMAGE_STRUCTURE");
2379
0
                poVRTBand->EnablePixelTypeSignedByteWarning(true);
2380
0
            }
2381
2382
0
            bool bCannotBeExactlyRepresented = false;
2383
2384
0
            if (pszPixelType != nullptr && EQUAL(pszPixelType, "SIGNEDBYTE"))
2385
0
            {
2386
0
                char *endptr = nullptr;
2387
0
                const double dfVal =
2388
0
                    CPLStrtod(psOptions->osNoData.c_str(), &endptr);
2389
0
                if (endptr == psOptions->osNoData.c_str() +
2390
0
                                  psOptions->osNoData.size() &&
2391
0
                    dfVal >= -128.0 && dfVal <= 127.0 &&
2392
0
                    static_cast<int8_t>(dfVal) == dfVal)
2393
0
                {
2394
0
                    poVRTBand->SetNoDataValue(dfVal);
2395
0
                }
2396
0
                else
2397
0
                {
2398
0
                    bCannotBeExactlyRepresented = true;
2399
0
                }
2400
0
            }
2401
0
            else
2402
0
            {
2403
0
                poVRTBand->SetNoDataValueAsString(psOptions->osNoData.c_str(),
2404
0
                                                  &bCannotBeExactlyRepresented);
2405
0
            }
2406
0
            if (bCannotBeExactlyRepresented)
2407
0
            {
2408
0
                CPLError(CE_Warning, CPLE_AppDefined,
2409
0
                         "Nodata value was not set to output band, "
2410
0
                         "as it cannot be represented on its data type.");
2411
0
            }
2412
0
        }
2413
2414
0
        if (psOptions->bSetScale)
2415
0
            poVRTBand->SetScale(psOptions->dfScale);
2416
2417
0
        if (psOptions->bSetOffset)
2418
0
            poVRTBand->SetOffset(psOptions->dfOffset);
2419
2420
0
        if (psOptions->eMaskMode == MASK_AUTO &&
2421
0
            (poSrcDS->GetRasterBand(1)->GetMaskFlags() & GMF_PER_DATASET) ==
2422
0
                0 &&
2423
0
            (poSrcBand->GetMaskFlags() & (GMF_ALL_VALID | GMF_NODATA)) == 0)
2424
0
        {
2425
0
            if (poVRTBand->CreateMaskBand(poSrcBand->GetMaskFlags()) == CE_None)
2426
0
            {
2427
0
                VRTSourcedRasterBand *hMaskVRTBand =
2428
0
                    cpl::down_cast<VRTSourcedRasterBand *>(
2429
0
                        poVRTBand->GetMaskBand());
2430
0
                hMaskVRTBand->AddMaskBandSource(
2431
0
                    poSrcBand, psOptions->srcWin.dfXOff,
2432
0
                    psOptions->srcWin.dfYOff, psOptions->srcWin.dfXSize,
2433
0
                    psOptions->srcWin.dfYSize, dstWin.dfXOff, dstWin.dfYOff,
2434
0
                    dstWin.dfXSize, dstWin.dfYSize);
2435
0
            }
2436
0
        }
2437
0
    }
2438
2439
0
    if (psOptions->eMaskMode == MASK_USER)
2440
0
    {
2441
0
        GDALRasterBand *poSrcBand =
2442
0
            poSrcDS->GetRasterBand(std::abs(psOptions->nMaskBand));
2443
0
        if (poSrcBand && poVDS->CreateMaskBand(GMF_PER_DATASET) == CE_None)
2444
0
        {
2445
0
            VRTSourcedRasterBand *hMaskVRTBand =
2446
0
                static_cast<VRTSourcedRasterBand *>(GDALGetMaskBand(
2447
0
                    GDALGetRasterBand(static_cast<GDALDataset *>(poVDS), 1)));
2448
0
            if (psOptions->nMaskBand > 0)
2449
0
                hMaskVRTBand->AddSimpleSource(
2450
0
                    poSrcBand, psOptions->srcWin.dfXOff,
2451
0
                    psOptions->srcWin.dfYOff, psOptions->srcWin.dfXSize,
2452
0
                    psOptions->srcWin.dfYSize, dstWin.dfXOff, dstWin.dfYOff,
2453
0
                    dstWin.dfXSize, dstWin.dfYSize);
2454
0
            else
2455
0
                hMaskVRTBand->AddMaskBandSource(
2456
0
                    poSrcBand, psOptions->srcWin.dfXOff,
2457
0
                    psOptions->srcWin.dfYOff, psOptions->srcWin.dfXSize,
2458
0
                    psOptions->srcWin.dfYSize, dstWin.dfXOff, dstWin.dfYOff,
2459
0
                    dstWin.dfXSize, dstWin.dfYSize);
2460
0
        }
2461
0
    }
2462
0
    else if (psOptions->eMaskMode == MASK_AUTO && nSrcBandCount > 0 &&
2463
0
             poSrcDS->GetRasterBand(1)->GetMaskFlags() == GMF_PER_DATASET)
2464
0
    {
2465
0
        if (poVDS->CreateMaskBand(GMF_PER_DATASET) == CE_None)
2466
0
        {
2467
0
            VRTSourcedRasterBand *hMaskVRTBand =
2468
0
                static_cast<VRTSourcedRasterBand *>(GDALGetMaskBand(
2469
0
                    GDALGetRasterBand(static_cast<GDALDataset *>(poVDS), 1)));
2470
0
            hMaskVRTBand->AddMaskBandSource(
2471
0
                poSrcDS->GetRasterBand(1), psOptions->srcWin.dfXOff,
2472
0
                psOptions->srcWin.dfYOff, psOptions->srcWin.dfXSize,
2473
0
                psOptions->srcWin.dfYSize, dstWin.dfXOff, dstWin.dfYOff,
2474
0
                dstWin.dfXSize, dstWin.dfYSize);
2475
0
        }
2476
0
    }
2477
2478
    /* -------------------------------------------------------------------- */
2479
    /*      Compute stats if required.                                      */
2480
    /* -------------------------------------------------------------------- */
2481
0
    if (psOptions->bStats && EQUAL(psOptions->osFormat.c_str(), "COG"))
2482
0
    {
2483
0
        psOptions->aosCreateOptions.SetNameValue("STATISTICS", "YES");
2484
0
    }
2485
0
    else if (psOptions->bStats)
2486
0
    {
2487
0
        for (int i = 0; i < poVDS->GetRasterCount(); i++)
2488
0
        {
2489
0
            double dfMin, dfMax, dfMean, dfStdDev;
2490
0
            poVDS->GetRasterBand(i + 1)->ComputeStatistics(
2491
0
                psOptions->bApproxStats, &dfMin, &dfMax, &dfMean, &dfStdDev,
2492
0
                GDALDummyProgress, nullptr);
2493
0
        }
2494
0
    }
2495
2496
    /* -------------------------------------------------------------------- */
2497
    /*      Write to the output file using CopyCreate().                    */
2498
    /* -------------------------------------------------------------------- */
2499
0
    if (EQUAL(psOptions->osFormat.c_str(), "VRT") &&
2500
0
        (psOptions->aosCreateOptions.empty() ||
2501
0
         (psOptions->aosCreateOptions.size() == 1 &&
2502
0
          psOptions->aosCreateOptions.FetchNameValue("BLOCKXSIZE")) ||
2503
0
         (psOptions->aosCreateOptions.size() == 1 &&
2504
0
          psOptions->aosCreateOptions.FetchNameValue("BLOCKYSIZE")) ||
2505
0
         (psOptions->aosCreateOptions.size() == 2 &&
2506
0
          psOptions->aosCreateOptions.FetchNameValue("BLOCKXSIZE") &&
2507
0
          psOptions->aosCreateOptions.FetchNameValue("BLOCKYSIZE"))))
2508
0
    {
2509
0
        poVDS->SetDescription(pszDest);
2510
0
        hOutDS = GDALDataset::ToHandle(poVDS);
2511
0
        if (!EQUAL(pszDest, ""))
2512
0
        {
2513
0
            hOutDS = GDALTranslateFlush(hOutDS);
2514
0
        }
2515
0
    }
2516
0
    else
2517
0
    {
2518
0
        hOutDS = GDALCreateCopy(
2519
0
            hDriver, pszDest, GDALDataset::ToHandle(poVDS), psOptions->bStrict,
2520
0
            psOptions->aosCreateOptions.List(), psOptions->pfnProgress,
2521
0
            psOptions->pProgressData);
2522
0
        hOutDS = GDALTranslateFlush(hOutDS);
2523
2524
0
        GDALClose(poVDS);
2525
0
    }
2526
2527
0
    poSrcDS->Release();
2528
2529
0
    return hOutDS;
2530
0
}
2531
2532
/************************************************************************/
2533
/*                           AttachMetadata()                           */
2534
/************************************************************************/
2535
2536
static void AttachMetadata(GDALDatasetH hDS,
2537
                           const CPLStringList &aosMetadataOptions)
2538
2539
0
{
2540
0
    for (const auto &[pszKey, pszValue] :
2541
0
         cpl::IterateNameValue(aosMetadataOptions))
2542
0
    {
2543
0
        GDALSetMetadataItem(hDS, pszKey, pszValue, nullptr);
2544
0
    }
2545
0
}
2546
2547
/************************************************************************/
2548
/*                           AttachDomainMetadata()                     */
2549
/************************************************************************/
2550
2551
static void AttachDomainMetadata(GDALDatasetH hDS,
2552
                                 const CPLStringList &aosDomainMetadataOptions)
2553
2554
0
{
2555
0
    for (const char *pszStr : aosDomainMetadataOptions)
2556
0
    {
2557
2558
0
        char *pszKey = nullptr;
2559
0
        char *pszDomain = nullptr;
2560
2561
        // parse the DOMAIN:KEY=value, Remainder is KEY=value
2562
0
        const char *pszRemainder =
2563
0
            CPLParseNameValueSep(pszStr, &pszDomain, ':');
2564
2565
0
        if (pszDomain && pszRemainder)
2566
0
        {
2567
2568
0
            const char *pszValue =
2569
0
                CPLParseNameValueSep(pszRemainder, &pszKey, '=');
2570
0
            if (pszKey && pszValue)
2571
0
            {
2572
0
                GDALSetMetadataItem(hDS, pszKey, pszValue, pszDomain);
2573
0
            }
2574
0
        }
2575
0
        CPLFree(pszKey);
2576
2577
0
        CPLFree(pszDomain);
2578
0
    }
2579
0
}
2580
2581
/************************************************************************/
2582
/*                           CopyBandInfo()                            */
2583
/************************************************************************/
2584
2585
/* A bit of a clone of VRTRasterBand::CopyCommonInfoFrom(), but we need */
2586
/* more and more custom behavior in the context of gdal_translate ... */
2587
2588
static void CopyBandInfo(GDALRasterBand *poSrcBand, GDALRasterBand *poDstBand,
2589
                         int bCanCopyStatsMetadata, int bCopyScale,
2590
                         int bCopyNoData, bool bCopyRAT,
2591
                         const GDALTranslateOptions * /*psOptions*/)
2592
2593
0
{
2594
2595
0
    if (bCanCopyStatsMetadata)
2596
0
    {
2597
0
        poDstBand->SetMetadata(poSrcBand->GetMetadata());
2598
0
        if (bCopyRAT)
2599
0
        {
2600
0
            poDstBand->SetDefaultRAT(poSrcBand->GetDefaultRAT());
2601
0
        }
2602
0
    }
2603
0
    else
2604
0
    {
2605
0
        char **papszMetadata = poSrcBand->GetMetadata();
2606
0
        char **papszMetadataNew = nullptr;
2607
0
        for (int i = 0; papszMetadata != nullptr && papszMetadata[i] != nullptr;
2608
0
             i++)
2609
0
        {
2610
0
            if (!STARTS_WITH(papszMetadata[i], "STATISTICS_"))
2611
0
                papszMetadataNew =
2612
0
                    CSLAddString(papszMetadataNew, papszMetadata[i]);
2613
0
        }
2614
0
        poDstBand->SetMetadata(papszMetadataNew);
2615
0
        CSLDestroy(papszMetadataNew);
2616
2617
        // we need to strip histogram data from the source RAT
2618
0
        if (poSrcBand->GetDefaultRAT() && bCopyRAT)
2619
0
        {
2620
0
            GDALRasterAttributeTable *poNewRAT =
2621
0
                poSrcBand->GetDefaultRAT()->Clone();
2622
2623
            // strip histogram data (as defined by the source RAT)
2624
0
            poNewRAT->RemoveStatistics();
2625
0
            if (poNewRAT->GetColumnCount())
2626
0
            {
2627
0
                poDstBand->SetDefaultRAT(poNewRAT);
2628
0
            }
2629
            // since SetDefaultRAT copies the RAT data we need to delete our
2630
            // original
2631
0
            delete poNewRAT;
2632
0
        }
2633
0
    }
2634
2635
0
    poDstBand->SetColorTable(poSrcBand->GetColorTable());
2636
0
    poDstBand->SetColorInterpretation(poSrcBand->GetColorInterpretation());
2637
0
    if (strlen(poSrcBand->GetDescription()) > 0)
2638
0
        poDstBand->SetDescription(poSrcBand->GetDescription());
2639
2640
0
    if (bCopyNoData)
2641
0
    {
2642
0
        int bSuccess = FALSE;
2643
0
        CPL_IGNORE_RET_VAL(poSrcBand->GetNoDataValue(&bSuccess));
2644
0
        if (bSuccess)
2645
0
        {
2646
0
            bool bCannotBeExactlyRepresented = false;
2647
0
            if (!GDALCopyNoDataValue(poDstBand, poSrcBand,
2648
0
                                     &bCannotBeExactlyRepresented) &&
2649
0
                bCannotBeExactlyRepresented)
2650
0
            {
2651
0
                CPLError(CE_Warning, CPLE_AppDefined,
2652
0
                         "Source nodata value was not copied to output band, "
2653
0
                         "as it cannot be represented on its data type.");
2654
0
            }
2655
0
        }
2656
0
    }
2657
2658
0
    if (bCopyScale)
2659
0
    {
2660
0
        poDstBand->SetOffset(poSrcBand->GetOffset());
2661
0
        poDstBand->SetScale(poSrcBand->GetScale());
2662
0
    }
2663
2664
0
    poDstBand->SetCategoryNames(poSrcBand->GetCategoryNames());
2665
2666
    // Copy unit only if the range of pixel values is not modified
2667
0
    if (bCanCopyStatsMetadata && bCopyScale &&
2668
0
        !EQUAL(poSrcBand->GetUnitType(), ""))
2669
0
        poDstBand->SetUnitType(poSrcBand->GetUnitType());
2670
0
}
2671
2672
/************************************************************************/
2673
/*                             GetColorInterp()                         */
2674
/************************************************************************/
2675
2676
static int GetColorInterp(const char *pszStr)
2677
0
{
2678
0
    if (EQUAL(pszStr, "undefined"))
2679
0
        return GCI_Undefined;
2680
0
    const int eInterp = GDALGetColorInterpretationByName(pszStr);
2681
0
    if (eInterp != GCI_Undefined)
2682
0
        return eInterp;
2683
0
    CPLError(CE_Warning, CPLE_NotSupported,
2684
0
             "Unsupported color interpretation: %s", pszStr);
2685
0
    return -1;
2686
0
}
2687
2688
/************************************************************************/
2689
/*                     GDALTranslateOptionsGetParser()                  */
2690
/************************************************************************/
2691
2692
static std::unique_ptr<GDALArgumentParser>
2693
GDALTranslateOptionsGetParser(GDALTranslateOptions *psOptions,
2694
                              GDALTranslateOptionsForBinary *psOptionsForBinary)
2695
0
{
2696
0
    auto argParser = std::make_unique<GDALArgumentParser>(
2697
0
        "gdal_translate", /* bForBinary=*/psOptionsForBinary != nullptr);
2698
2699
0
    argParser->add_description(
2700
0
        _("Convert raster data between different formats, with potential "
2701
0
          "subsetting, resampling, and rescaling pixels in the process."));
2702
2703
0
    argParser->add_epilog(_("For more details, consult "
2704
0
                            "https://gdal.org/programs/gdal_translate.html"));
2705
2706
0
    argParser->add_output_type_argument(psOptions->eOutputType);
2707
2708
0
    argParser->add_argument("-if")
2709
0
        .append()
2710
0
        .metavar("<format>")
2711
0
        .action(
2712
0
            [psOptionsForBinary](const std::string &s)
2713
0
            {
2714
0
                if (psOptionsForBinary)
2715
0
                {
2716
0
                    if (GDALGetDriverByName(s.c_str()) == nullptr)
2717
0
                    {
2718
0
                        CPLError(CE_Warning, CPLE_AppDefined,
2719
0
                                 "%s is not a recognized driver", s.c_str());
2720
0
                    }
2721
0
                    psOptionsForBinary->aosAllowedInputDrivers.AddString(
2722
0
                        s.c_str());
2723
0
                }
2724
0
            })
2725
0
        .help(_("Format/driver name(s) to try when opening the input file."));
2726
2727
0
    argParser->add_output_format_argument(psOptions->osFormat);
2728
2729
0
    argParser->add_quiet_argument(&(psOptions->bQuiet));
2730
2731
0
    argParser->add_argument("-b")
2732
0
        .append()
2733
0
        .metavar("<band>")
2734
0
        .action(
2735
0
            [psOptions](const std::string &s)
2736
0
            {
2737
0
                const char *pszBand = s.c_str();
2738
0
                bool bMask = false;
2739
0
                if (EQUAL(pszBand, "mask"))
2740
0
                    pszBand = "mask,1";
2741
0
                if (STARTS_WITH_CI(pszBand, "mask,"))
2742
0
                {
2743
0
                    bMask = true;
2744
0
                    pszBand += 5;
2745
                    /* If we use the source mask band as a regular band */
2746
                    /* don't create a target mask band by default */
2747
0
                    if (!psOptions->bParsedMaskArgument)
2748
0
                        psOptions->eMaskMode = MASK_DISABLED;
2749
0
                }
2750
0
                const int nBand = atoi(pszBand);
2751
0
                if (nBand < 1)
2752
0
                {
2753
0
                    throw std::invalid_argument(CPLSPrintf(
2754
0
                        "Unrecognizable band number (%s).", s.c_str()));
2755
0
                }
2756
2757
0
                psOptions->nBandCount++;
2758
0
                psOptions->anBandList.emplace_back(nBand * (bMask ? -1 : 1));
2759
0
            })
2760
0
        .help(_("Select input band(s)"));
2761
2762
0
    argParser->add_argument("-mask")
2763
0
        .metavar("<mask>")
2764
0
        .action(
2765
0
            [psOptions](const std::string &s)
2766
0
            {
2767
0
                psOptions->bParsedMaskArgument = true;
2768
0
                const char *pszBand = s.c_str();
2769
0
                if (EQUAL(pszBand, "none"))
2770
0
                {
2771
0
                    psOptions->eMaskMode = MASK_DISABLED;
2772
0
                }
2773
0
                else if (EQUAL(pszBand, "auto"))
2774
0
                {
2775
0
                    psOptions->eMaskMode = MASK_AUTO;
2776
0
                }
2777
0
                else
2778
0
                {
2779
0
                    bool bMask = false;
2780
2781
0
                    if (EQUAL(pszBand, "mask"))
2782
0
                        pszBand = "mask,1";
2783
0
                    if (STARTS_WITH_CI(pszBand, "mask,"))
2784
0
                    {
2785
0
                        bMask = true;
2786
0
                        pszBand += 5;
2787
0
                    }
2788
0
                    const int nBand = atoi(pszBand);
2789
0
                    if (nBand < 1)
2790
0
                    {
2791
0
                        throw std::invalid_argument(CPLSPrintf(
2792
0
                            "Unrecognizable band number (%s).", s.c_str()));
2793
0
                    }
2794
2795
0
                    psOptions->eMaskMode = MASK_USER;
2796
0
                    psOptions->nMaskBand = nBand;
2797
0
                    if (bMask)
2798
0
                        psOptions->nMaskBand *= -1;
2799
0
                }
2800
0
            })
2801
0
        .help(_("Select an input band to create output dataset mask band"));
2802
2803
0
    argParser->add_argument("-expand")
2804
0
        .metavar("gray|rgb|rgba")
2805
0
        .action(
2806
0
            [psOptions](const std::string &s)
2807
0
            {
2808
0
                if (EQUAL(s.c_str(), "gray"))
2809
0
                    psOptions->nRGBExpand = 1;
2810
0
                else if (EQUAL(s.c_str(), "rgb"))
2811
0
                    psOptions->nRGBExpand = 3;
2812
0
                else if (EQUAL(s.c_str(), "rgba"))
2813
0
                    psOptions->nRGBExpand = 4;
2814
0
                else
2815
0
                {
2816
0
                    throw std::invalid_argument(CPLSPrintf(
2817
0
                        "Value %s unsupported. Only gray, rgb or rgba are "
2818
0
                        "supported.",
2819
0
                        s.c_str()));
2820
0
                }
2821
0
            })
2822
0
        .help(_("To expose a dataset with 1 band with a color table as a "
2823
0
                "dataset with 3 (RGB) or 4 (RGBA) bands."));
2824
2825
0
    {
2826
0
        auto &group = argParser->add_mutually_exclusive_group();
2827
0
        group.add_argument("-strict")
2828
0
            .store_into(psOptions->bStrict)
2829
0
            .help(_("Enable strict mode"));
2830
2831
0
        group.add_argument("-not_strict")
2832
0
            .flag()
2833
0
            .action([psOptions](const std::string &)
2834
0
                    { psOptions->bStrict = false; })
2835
0
            .help(_("Disable strict mode"));
2836
0
    }
2837
2838
0
    argParser->add_argument("-outsize")
2839
0
        .metavar("<xsize[%]|0> <ysize[%]|0>")
2840
0
        .nargs(2)
2841
0
        .help(_("Set the size of the output file."));
2842
2843
0
    argParser->add_argument("-tr")
2844
0
        .metavar("<xres> <yes>")
2845
0
        .nargs(2)
2846
0
        .scan<'g', double>()
2847
0
        .help(_("Set target resolution."));
2848
2849
0
    argParser->add_argument("-ovr")
2850
0
        .metavar("<level>|AUTO|AUTO-<n>|NONE")
2851
0
        .action(
2852
0
            [psOptions](const std::string &s)
2853
0
            {
2854
0
                const char *pszOvLevel = s.c_str();
2855
0
                if (EQUAL(pszOvLevel, "AUTO"))
2856
0
                    psOptions->nOvLevel = OVR_LEVEL_AUTO;
2857
0
                else if (STARTS_WITH_CI(pszOvLevel, "AUTO-"))
2858
0
                    psOptions->nOvLevel =
2859
0
                        OVR_LEVEL_AUTO - atoi(pszOvLevel + strlen("AUTO-"));
2860
0
                else if (EQUAL(pszOvLevel, "NONE"))
2861
0
                    psOptions->nOvLevel = OVR_LEVEL_NONE;
2862
0
                else if (CPLGetValueType(pszOvLevel) == CPL_VALUE_INTEGER)
2863
0
                    psOptions->nOvLevel = atoi(pszOvLevel);
2864
0
                else
2865
0
                {
2866
0
                    throw std::invalid_argument(CPLSPrintf(
2867
0
                        "Invalid value '%s' for -ovr option", pszOvLevel));
2868
0
                }
2869
0
            })
2870
0
        .help(_("Specify which overview level of source file must be used"));
2871
2872
0
    if (psOptionsForBinary)
2873
0
    {
2874
0
        argParser->add_argument("-sds")
2875
0
            .store_into(psOptionsForBinary->bCopySubDatasets)
2876
0
            .help(_("Copy subdatasets"));
2877
0
    }
2878
2879
0
    argParser->add_argument("-r")
2880
0
        .metavar("nearest,bilinear,cubic,cubicspline,lanczos,average,mode")
2881
0
        .store_into(psOptions->osResampling)
2882
0
        .help(_("Resampling algorithm."));
2883
2884
0
    {
2885
0
        auto &group = argParser->add_mutually_exclusive_group();
2886
0
        group.add_argument("-scale")
2887
0
            .metavar("[<src_min> <src_max> [<dst_min> <dst_max>]]")
2888
            //.nargs(0, 4)
2889
0
            .append()
2890
0
            .scan<'g', double>()
2891
0
            .help(_("Rescale the input pixels values from the range src_min to "
2892
0
                    "src_max to the range dst_min to dst_max."));
2893
2894
0
        group.add_argument("-scale_X")
2895
0
            .metavar("[<src_min> <src_max> [<dst_min> <dst_max>]]")
2896
            //.nargs(0, 4)
2897
0
            .append()
2898
0
            .scan<'g', double>()
2899
0
            .help(_("Rescale the input pixels values for band X."));
2900
2901
0
        group.add_argument("-unscale")
2902
0
            .store_into(psOptions->bUnscale)
2903
0
            .help(_("Apply the scale/offset metadata for the bands to convert "
2904
0
                    "scaled values to unscaled values."));
2905
0
    }
2906
2907
0
    {
2908
0
        auto &group = argParser->add_mutually_exclusive_group();
2909
0
        group.add_argument("-exponent")
2910
0
            .metavar("<value>")
2911
0
            .scan<'g', double>()
2912
0
            .help(_(
2913
0
                "Exponent to apply non-linear scaling with a power function"));
2914
2915
0
        group.add_argument("-exponent_X")
2916
0
            .append()
2917
0
            .metavar("<value>")
2918
0
            .scan<'g', double>()
2919
0
            .help(
2920
0
                _("Exponent to apply non-linear scaling with a power function, "
2921
0
                  "for band X"));
2922
0
    }
2923
2924
0
    argParser->add_argument("-srcwin")
2925
0
        .metavar("<xoff> <yoff> <xsize> <ysize>")
2926
0
        .nargs(4)
2927
0
        .scan<'g', double>()
2928
0
        .help(_("Selects a subwindow from the source image based on pixel/line "
2929
0
                "location."));
2930
2931
0
    argParser->add_argument("-projwin")
2932
0
        .metavar("<ulx> <uly> <lrx> <lry>")
2933
0
        .nargs(4)
2934
0
        .scan<'g', double>()
2935
0
        .help(_("Selects a subwindow from the source image based on "
2936
0
                "georeferenced coordinates."));
2937
2938
0
    argParser->add_argument("-projwin_srs")
2939
0
        .metavar("<srs_def>")
2940
0
        .store_into(psOptions->osProjSRS)
2941
0
        .help(_("Specifies the SRS in which to interpret the coordinates given "
2942
0
                "with -projwin."));
2943
2944
0
    argParser->add_argument("-epo")
2945
0
        .flag()
2946
0
        .action(
2947
0
            [psOptions](const std::string &)
2948
0
            {
2949
0
                psOptions->bErrorOnPartiallyOutside = true;
2950
0
                psOptions->bErrorOnCompletelyOutside = true;
2951
0
            })
2952
0
        .help(_("Error when Partially Outside."));
2953
2954
0
    argParser->add_argument("-eco")
2955
0
        .store_into(psOptions->bErrorOnCompletelyOutside)
2956
0
        .help(_("Error when Completely Outside."));
2957
2958
0
    argParser->add_argument("-a_srs")
2959
0
        .metavar("<srs_def>")
2960
0
        .store_into(psOptions->osOutputSRS)
2961
0
        .help(_("Override the projection for the output file."));
2962
2963
0
    argParser->add_argument("-a_coord_epoch")
2964
0
        .metavar("<epoch>")
2965
0
        .store_into(psOptions->dfOutputCoordinateEpoch)
2966
0
        .help(_("Assign a coordinate epoch."));
2967
2968
0
    argParser->add_argument("-a_ullr")
2969
0
        .metavar("<ulx> <uly> <lrx> <lry>")
2970
0
        .nargs(4)
2971
0
        .scan<'g', double>()
2972
0
        .help(
2973
0
            _("Assign/override the georeferenced bounds of the output file."));
2974
2975
0
    argParser->add_argument("-a_nodata")
2976
0
        .metavar("<value>|none")
2977
0
        .help(_("Assign a specified nodata value to output bands."));
2978
2979
0
    argParser->add_argument("-a_gt")
2980
0
        .metavar("<gt(0)> <gt(1)> <gt(2)> <gt(3)> <gt(4)> <gt(5)>")
2981
0
        .nargs(6)
2982
0
        .scan<'g', double>()
2983
0
        .help(_("Assign/override the geotransform of the output file."));
2984
2985
0
    argParser->add_argument("-a_scale")
2986
0
        .metavar("<value>")
2987
0
        .store_into(psOptions->dfScale)
2988
0
        .help(_("Set band scaling value."));
2989
2990
0
    argParser->add_argument("-a_offset")
2991
0
        .metavar("<value>")
2992
0
        .store_into(psOptions->dfOffset)
2993
0
        .help(_("Set band offset value."));
2994
2995
0
    argParser->add_argument("-nogcp")
2996
0
        .store_into(psOptions->bNoGCP)
2997
0
        .help(_("Do not copy the GCPs in the source dataset to the output "
2998
0
                "dataset."));
2999
3000
0
    argParser->add_argument("-gcp")
3001
0
        .metavar("<pixel> <line> <easting> <northing> [<elevation>]")
3002
0
        .nargs(4, 5)
3003
0
        .append()
3004
0
        .scan<'g', double>()
3005
0
        .help(
3006
0
            _("Add the indicated ground control point to the output dataset."));
3007
3008
0
    argParser->add_argument("-colorinterp")
3009
0
        .metavar("{red|green|blue|alpha|gray|undefined|pan|coastal|rededge|nir|"
3010
0
                 "swir|mwir|lwir|...},...")
3011
0
        .action(
3012
0
            [psOptions](const std::string &s)
3013
0
            {
3014
0
                CPLStringList aosList(CSLTokenizeString2(s.c_str(), ",", 0));
3015
0
                psOptions->anColorInterp.resize(aosList.size());
3016
0
                for (int j = 0; j < aosList.size(); j++)
3017
0
                {
3018
0
                    psOptions->anColorInterp[j] = GetColorInterp(aosList[j]);
3019
0
                }
3020
0
            })
3021
0
        .help(_("Override the color interpretation of all specified bands."));
3022
3023
0
    argParser->add_argument("-colorinterp_X")
3024
0
        .append()
3025
0
        .metavar("{red|green|blue|alpha|gray|undefined|pan|coastal|rededge|nir|"
3026
0
                 "swir|mwir|lwir|...}")
3027
0
        .help(_("Override the color interpretation of band X."));
3028
3029
0
    {
3030
0
        auto &group = argParser->add_mutually_exclusive_group();
3031
0
        group.add_argument("-stats")
3032
0
            .flag()
3033
0
            .action(
3034
0
                [psOptions](const std::string &)
3035
0
                {
3036
0
                    psOptions->bStats = true;
3037
0
                    psOptions->bApproxStats = false;
3038
0
                })
3039
0
            .help(_("Force (re)computation of statistics."));
3040
3041
0
        group.add_argument("-approx_stats")
3042
0
            .flag()
3043
0
            .action(
3044
0
                [psOptions](const std::string &)
3045
0
                {
3046
0
                    psOptions->bStats = true;
3047
0
                    psOptions->bApproxStats = true;
3048
0
                })
3049
0
            .help(_("Force (re)computation of approximate statistics."));
3050
0
    }
3051
3052
0
    argParser->add_argument("-norat")
3053
0
        .store_into(psOptions->bNoRAT)
3054
0
        .help(_("Do not copy source RAT into destination dataset."));
3055
3056
0
    argParser->add_argument("-noxmp")
3057
0
        .store_into(psOptions->bNoXMP)
3058
0
        .help(_("Do not copy the XMP metadata into destination dataset."));
3059
3060
0
    argParser->add_creation_options_argument(psOptions->aosCreateOptions);
3061
3062
0
    argParser->add_metadata_item_options_argument(
3063
0
        psOptions->aosMetadataOptions);
3064
3065
0
    argParser->add_argument("-dmo")
3066
0
        .metavar("<DOMAIN>:<KEY>=<VALUE>")
3067
0
        .append()
3068
0
        .action([psOptions](const std::string &s)
3069
0
                { psOptions->aosDomainMetadataOptions.AddString(s.c_str()); })
3070
0
        .help(_("Passes a metadata key and value in specified domain to set on "
3071
0
                "the output dataset if possible."));
3072
3073
0
    argParser->add_open_options_argument(
3074
0
        psOptionsForBinary ? &(psOptionsForBinary->aosOpenOptions) : nullptr);
3075
3076
    // Undocumented option used by gdal_translate_fuzzer
3077
0
    argParser->add_argument("-limit_outsize")
3078
0
        .hidden()
3079
0
        .store_into(psOptions->nLimitOutSize);
3080
3081
    // Undocumented option used by gdal raster convert
3082
0
    argParser->add_argument("--no-overwrite")
3083
0
        .store_into(psOptions->bNoOverwrite)
3084
0
        .hidden();
3085
3086
    // Undocumented option used by gdal raster scale
3087
0
    argParser->add_argument("--no-clip")
3088
0
        .store_into(psOptions->bNoClip)
3089
0
        .hidden();
3090
3091
0
    if (psOptionsForBinary)
3092
0
    {
3093
0
        argParser->add_argument("input_file")
3094
0
            .metavar("<input_file>")
3095
0
            .store_into(psOptionsForBinary->osSource)
3096
0
            .help(_("Input file."));
3097
3098
0
        argParser->add_argument("output_file")
3099
0
            .metavar("<output_file>")
3100
0
            .store_into(psOptionsForBinary->osDest)
3101
0
            .help(_("Output file."));
3102
0
    }
3103
3104
0
    return argParser;
3105
0
}
3106
3107
/************************************************************************/
3108
/*                      GDALTranslateGetParserUsage()                   */
3109
/************************************************************************/
3110
3111
std::string GDALTranslateGetParserUsage()
3112
0
{
3113
0
    try
3114
0
    {
3115
0
        GDALTranslateOptions sOptions;
3116
0
        GDALTranslateOptionsForBinary sOptionsForBinary;
3117
0
        auto argParser =
3118
0
            GDALTranslateOptionsGetParser(&sOptions, &sOptionsForBinary);
3119
0
        return argParser->usage();
3120
0
    }
3121
0
    catch (const std::exception &err)
3122
0
    {
3123
0
        CPLError(CE_Failure, CPLE_AppDefined, "Unexpected exception: %s",
3124
0
                 err.what());
3125
0
        return std::string();
3126
0
    }
3127
0
}
3128
3129
/************************************************************************/
3130
/*                             GDALTranslateOptionsNew()                */
3131
/************************************************************************/
3132
3133
/**
3134
 * Allocates a GDALTranslateOptions struct.
3135
 *
3136
 * @param papszArgv NULL terminated list of options (potentially including
3137
 * filename and open options too), or NULL. The accepted options are the ones of
3138
 * the <a href="/programs/gdal_translate.html">gdal_translate</a> utility.
3139
 * @param psOptionsForBinary (output) may be NULL (and should generally be
3140
 * NULL), otherwise (gdal_translate_bin.cpp use case) must be allocated with
3141
 *                           GDALTranslateOptionsForBinaryNew() prior to this
3142
 * function. Will be filled with potentially present filename, open options,...
3143
 * @return pointer to the allocated GDALTranslateOptions struct. Must be freed
3144
 * with GDALTranslateOptionsFree().
3145
 *
3146
 * @since GDAL 2.1
3147
 */
3148
3149
GDALTranslateOptions *
3150
GDALTranslateOptionsNew(char **papszArgv,
3151
                        GDALTranslateOptionsForBinary *psOptionsForBinary)
3152
0
{
3153
0
    auto psOptions = std::make_unique<GDALTranslateOptions>();
3154
3155
    /* -------------------------------------------------------------------- */
3156
    /*      Pre-processing for custom syntax that ArgumentParser does not   */
3157
    /*      support.                                                        */
3158
    /* -------------------------------------------------------------------- */
3159
3160
0
    CPLStringList aosArgv;
3161
0
    const int argc = CSLCount(papszArgv);
3162
0
    for (int i = 0; i < argc && papszArgv != nullptr && papszArgv[i] != nullptr;
3163
0
         i++)
3164
0
    {
3165
0
        if (i + 4 < argc && EQUAL(papszArgv[i], "-gcp"))
3166
0
        {
3167
            /* -gcp pixel line easting northing [elev] */
3168
0
            psOptions->asGCPs.resize(psOptions->asGCPs.size() + 1);
3169
0
            psOptions->asGCPs.back().Pixel() = CPLAtofM(papszArgv[++i]);
3170
0
            psOptions->asGCPs.back().Line() = CPLAtofM(papszArgv[++i]);
3171
0
            psOptions->asGCPs.back().X() = CPLAtofM(papszArgv[++i]);
3172
0
            psOptions->asGCPs.back().Y() = CPLAtofM(papszArgv[++i]);
3173
3174
0
            char *endptr = nullptr;
3175
0
            if (papszArgv[i + 1] != nullptr &&
3176
0
                (CPLStrtod(papszArgv[i + 1], &endptr) != 0.0 ||
3177
0
                 papszArgv[i + 1][0] == '0'))
3178
0
            {
3179
                /* Check that last argument is really a number and not a
3180
                 * filename */
3181
                /* looking like a number (see ticket #863) */
3182
0
                if (endptr && *endptr == 0)
3183
0
                    psOptions->asGCPs.back().Z() = CPLAtofM(papszArgv[++i]);
3184
0
            }
3185
3186
            /* should set id and info? */
3187
0
        }
3188
3189
0
        else if (EQUAL(papszArgv[i], "-scale") ||
3190
0
                 STARTS_WITH_CI(papszArgv[i], "-scale_"))
3191
0
        {
3192
0
            int nIndex = 0;
3193
0
            if (STARTS_WITH_CI(papszArgv[i], "-scale_"))
3194
0
            {
3195
0
                if (!psOptions->bHasUsedExplicitScaleBand &&
3196
0
                    !psOptions->asScaleParams.empty())
3197
0
                {
3198
0
                    CPLError(CE_Failure, CPLE_NotSupported,
3199
0
                             "Cannot mix -scale and -scale_XX syntax");
3200
0
                    return nullptr;
3201
0
                }
3202
0
                psOptions->bHasUsedExplicitScaleBand = true;
3203
0
                nIndex = atoi(papszArgv[i] + 7);
3204
0
                if (nIndex <= 0 || nIndex > 65535)
3205
0
                {
3206
0
                    CPLError(CE_Failure, CPLE_NotSupported,
3207
0
                             "Invalid parameter name: %s", papszArgv[i]);
3208
0
                    return nullptr;
3209
0
                }
3210
0
                nIndex--;
3211
0
            }
3212
0
            else
3213
0
            {
3214
0
                if (psOptions->bHasUsedExplicitScaleBand)
3215
0
                {
3216
0
                    CPLError(CE_Failure, CPLE_NotSupported,
3217
0
                             "Cannot mix -scale and -scale_XX syntax");
3218
0
                    return nullptr;
3219
0
                }
3220
0
                nIndex = static_cast<int>(psOptions->asScaleParams.size());
3221
0
            }
3222
3223
0
            if (nIndex >= static_cast<int>(psOptions->asScaleParams.size()))
3224
0
            {
3225
0
                psOptions->asScaleParams.resize(nIndex + 1);
3226
0
            }
3227
0
            psOptions->asScaleParams[nIndex].bScale = true;
3228
0
            bool bScanForDst = false;
3229
0
            if (i < argc - 2 && EQUAL(papszArgv[i + 1], "NaN") &&
3230
0
                EQUAL(papszArgv[i + 2], "NaN"))
3231
0
            {
3232
0
                bScanForDst = true;
3233
0
                i += 2;
3234
0
            }
3235
0
            else if (i < argc - 2 && ArgIsNumeric(papszArgv[i + 1]))
3236
0
            {
3237
0
                if (!ArgIsNumeric(papszArgv[i + 2]))
3238
0
                {
3239
0
                    CPLError(CE_Failure, CPLE_IllegalArg,
3240
0
                             "Value of -scale must be numeric");
3241
0
                    return nullptr;
3242
0
                }
3243
0
                psOptions->asScaleParams[nIndex].dfScaleSrcMin =
3244
0
                    CPLAtofM(papszArgv[i + 1]);
3245
0
                psOptions->asScaleParams[nIndex].dfScaleSrcMax =
3246
0
                    CPLAtofM(papszArgv[i + 2]);
3247
0
                bScanForDst = true;
3248
0
                i += 2;
3249
0
            }
3250
0
            if (i < argc - 2 && bScanForDst && ArgIsNumeric(papszArgv[i + 1]))
3251
0
            {
3252
0
                if (!ArgIsNumeric(papszArgv[i + 2]))
3253
0
                {
3254
0
                    CPLError(CE_Failure, CPLE_IllegalArg,
3255
0
                             "Value of -scale must be numeric");
3256
0
                    return nullptr;
3257
0
                }
3258
0
                psOptions->asScaleParams[nIndex].dfScaleDstMin =
3259
0
                    CPLAtofM(papszArgv[i + 1]);
3260
0
                psOptions->asScaleParams[nIndex].dfScaleDstMax =
3261
0
                    CPLAtofM(papszArgv[i + 2]);
3262
0
                i += 2;
3263
0
            }
3264
0
        }
3265
3266
0
        else if ((EQUAL(papszArgv[i], "-exponent") ||
3267
0
                  STARTS_WITH_CI(papszArgv[i], "-exponent_")) &&
3268
0
                 papszArgv[i + 1])
3269
0
        {
3270
0
            int nIndex = 0;
3271
0
            if (STARTS_WITH_CI(papszArgv[i], "-exponent_"))
3272
0
            {
3273
0
                if (!psOptions->bHasUsedExplicitExponentBand &&
3274
0
                    !psOptions->adfExponent.empty())
3275
0
                {
3276
0
                    CPLError(CE_Failure, CPLE_NotSupported,
3277
0
                             "Cannot mix -exponent and -exponent_XX syntax");
3278
0
                    return nullptr;
3279
0
                }
3280
0
                psOptions->bHasUsedExplicitExponentBand = true;
3281
0
                nIndex = atoi(papszArgv[i] + 10);
3282
0
                if (nIndex <= 0 || nIndex > 65535)
3283
0
                {
3284
0
                    CPLError(CE_Failure, CPLE_NotSupported,
3285
0
                             "Invalid parameter name: %s", papszArgv[i]);
3286
0
                    return nullptr;
3287
0
                }
3288
0
                nIndex--;
3289
0
            }
3290
0
            else
3291
0
            {
3292
0
                if (psOptions->bHasUsedExplicitExponentBand)
3293
0
                {
3294
0
                    CPLError(CE_Failure, CPLE_NotSupported,
3295
0
                             "Cannot mix -exponent and -exponent_XX syntax");
3296
0
                    return nullptr;
3297
0
                }
3298
0
                nIndex = static_cast<int>(psOptions->adfExponent.size());
3299
0
            }
3300
3301
0
            if (nIndex >= static_cast<int>(psOptions->adfExponent.size()))
3302
0
            {
3303
0
                psOptions->adfExponent.resize(nIndex + 1);
3304
0
            }
3305
0
            double dfExponent = CPLAtofM(papszArgv[++i]);
3306
0
            psOptions->adfExponent[nIndex] = dfExponent;
3307
0
        }
3308
3309
0
        else if (STARTS_WITH_CI(papszArgv[i], "-colorinterp_") &&
3310
0
                 papszArgv[i + 1])
3311
0
        {
3312
0
            int nIndex = atoi(papszArgv[i] + strlen("-colorinterp_"));
3313
0
            if (nIndex <= 0 || nIndex > 65535)
3314
0
            {
3315
0
                CPLError(CE_Failure, CPLE_NotSupported,
3316
0
                         "Invalid parameter name: %s", papszArgv[i]);
3317
0
                return nullptr;
3318
0
            }
3319
0
            nIndex--;
3320
3321
0
            if (nIndex >= static_cast<int>(psOptions->anColorInterp.size()))
3322
0
            {
3323
0
                psOptions->anColorInterp.resize(nIndex + 1, -1);
3324
0
            }
3325
0
            ++i;
3326
0
            psOptions->anColorInterp[nIndex] = GetColorInterp(papszArgv[i]);
3327
0
        }
3328
3329
        // argparser will be confused if the value of a string argument
3330
        // starts with a negative sign.
3331
0
        else if (EQUAL(papszArgv[i], "-a_nodata") && papszArgv[i + 1])
3332
0
        {
3333
0
            ++i;
3334
0
            const char *s = papszArgv[i];
3335
0
            if (EQUAL(s, "none") || EQUAL(s, "null"))
3336
0
            {
3337
0
                psOptions->bUnsetNoData = true;
3338
0
            }
3339
0
            else
3340
0
            {
3341
0
                psOptions->bSetNoData = true;
3342
0
                psOptions->osNoData = s;
3343
0
            }
3344
0
        }
3345
3346
0
        else
3347
0
        {
3348
0
            aosArgv.AddString(papszArgv[i]);
3349
0
        }
3350
0
    }
3351
3352
0
    try
3353
0
    {
3354
3355
0
        auto argParser =
3356
0
            GDALTranslateOptionsGetParser(psOptions.get(), psOptionsForBinary);
3357
3358
0
        argParser->parse_args_without_binary_name(aosArgv.List());
3359
3360
0
        psOptions->bSetScale = argParser->is_used("-a_scale");
3361
0
        psOptions->bSetOffset = argParser->is_used("-a_offset");
3362
3363
0
        if (auto adfULLR = argParser->present<std::vector<double>>("-a_ullr"))
3364
0
        {
3365
0
            CPLAssert(psOptions->adfULLR.size() == adfULLR->size());
3366
0
            for (size_t i = 0; i < adfULLR->size(); ++i)
3367
0
                psOptions->adfULLR[i] = (*adfULLR)[i];
3368
0
        }
3369
3370
0
        if (auto adfGT = argParser->present<std::vector<double>>("-a_gt"))
3371
0
        {
3372
0
            CPLAssert(adfGT->size() == 6);
3373
0
            for (size_t i = 0; i < adfGT->size(); ++i)
3374
0
                psOptions->gt[i] = (*adfGT)[i];
3375
0
        }
3376
3377
0
        bool bOutsizeExplicitlySet = false;
3378
0
        if (auto aosOutSize =
3379
0
                argParser->present<std::vector<std::string>>("-outsize"))
3380
0
        {
3381
0
            if ((*aosOutSize)[0].back() == '%')
3382
0
                psOptions->dfOXSizePct = CPLAtofM((*aosOutSize)[0].c_str());
3383
0
            else
3384
0
                psOptions->nOXSizePixel = atoi((*aosOutSize)[0].c_str());
3385
3386
0
            if ((*aosOutSize)[1].back() == '%')
3387
0
                psOptions->dfOYSizePct = CPLAtofM((*aosOutSize)[1].c_str());
3388
0
            else
3389
0
                psOptions->nOYSizePixel = atoi((*aosOutSize)[1].c_str());
3390
0
            bOutsizeExplicitlySet = true;
3391
0
        }
3392
3393
0
        if (auto adfTargetRes = argParser->present<std::vector<double>>("-tr"))
3394
0
        {
3395
0
            psOptions->dfXRes = (*adfTargetRes)[0];
3396
0
            psOptions->dfYRes = fabs((*adfTargetRes)[1]);
3397
0
            if (psOptions->dfXRes == 0 || psOptions->dfYRes == 0)
3398
0
            {
3399
0
                CPLError(CE_Failure, CPLE_IllegalArg,
3400
0
                         "Wrong value for -tr parameters.");
3401
0
                return nullptr;
3402
0
            }
3403
0
        }
3404
3405
0
        if (auto adfSrcWin = argParser->present<std::vector<double>>("-srcwin"))
3406
0
        {
3407
0
            psOptions->srcWin.dfXOff = (*adfSrcWin)[0];
3408
0
            psOptions->srcWin.dfYOff = (*adfSrcWin)[1];
3409
0
            psOptions->srcWin.dfXSize = (*adfSrcWin)[2];
3410
0
            psOptions->srcWin.dfYSize = (*adfSrcWin)[3];
3411
0
        }
3412
3413
0
        if (auto adfProjWin =
3414
0
                argParser->present<std::vector<double>>("-projwin"))
3415
0
        {
3416
0
            psOptions->dfULX = (*adfProjWin)[0];
3417
0
            psOptions->dfULY = (*adfProjWin)[1];
3418
0
            psOptions->dfLRX = (*adfProjWin)[2];
3419
0
            psOptions->dfLRY = (*adfProjWin)[3];
3420
0
        }
3421
3422
0
        if (!psOptions->asGCPs.empty() && psOptions->bNoGCP)
3423
0
        {
3424
0
            CPLError(CE_Failure, CPLE_IllegalArg,
3425
0
                     "-nogcp and -gcp cannot be used as the same time");
3426
0
            return nullptr;
3427
0
        }
3428
3429
0
        if (bOutsizeExplicitlySet && psOptions->nOXSizePixel == 0 &&
3430
0
            psOptions->dfOXSizePct == 0.0 && psOptions->nOYSizePixel == 0 &&
3431
0
            psOptions->dfOYSizePct == 0.0)
3432
0
        {
3433
0
            CPLError(CE_Failure, CPLE_NotSupported, "-outsize %d %d invalid.",
3434
0
                     psOptions->nOXSizePixel, psOptions->nOYSizePixel);
3435
0
            return nullptr;
3436
0
        }
3437
3438
0
        if (!psOptions->asScaleParams.empty() && psOptions->bUnscale)
3439
0
        {
3440
0
            CPLError(CE_Failure, CPLE_IllegalArg,
3441
0
                     "-scale and -unscale cannot be used as the same time");
3442
0
            return nullptr;
3443
0
        }
3444
3445
0
        if (psOptionsForBinary)
3446
0
        {
3447
0
            psOptionsForBinary->bQuiet = psOptions->bQuiet;
3448
0
            psOptionsForBinary->aosCreateOptions = psOptions->aosCreateOptions;
3449
0
            if (!psOptions->osFormat.empty())
3450
0
                psOptionsForBinary->osFormat = psOptions->osFormat;
3451
0
        }
3452
3453
0
        return psOptions.release();
3454
0
    }
3455
0
    catch (const std::exception &err)
3456
0
    {
3457
0
        CPLError(CE_Failure, CPLE_AppDefined, "%s", err.what());
3458
0
        return nullptr;
3459
0
    }
3460
0
}
3461
3462
/************************************************************************/
3463
/*                        GDALTranslateOptionsFree()                    */
3464
/************************************************************************/
3465
3466
/**
3467
 * Frees the GDALTranslateOptions struct.
3468
 *
3469
 * @param psOptions the options struct for GDALTranslate().
3470
 *
3471
 * @since GDAL 2.1
3472
 */
3473
3474
void GDALTranslateOptionsFree(GDALTranslateOptions *psOptions)
3475
0
{
3476
0
    delete psOptions;
3477
0
}
3478
3479
/************************************************************************/
3480
/*                 GDALTranslateOptionsSetProgress()                    */
3481
/************************************************************************/
3482
3483
/**
3484
 * Set a progress function.
3485
 *
3486
 * @param psOptions the options struct for GDALTranslate().
3487
 * @param pfnProgress the progress callback.
3488
 * @param pProgressData the user data for the progress callback.
3489
 *
3490
 * @since GDAL 2.1
3491
 */
3492
3493
void GDALTranslateOptionsSetProgress(GDALTranslateOptions *psOptions,
3494
                                     GDALProgressFunc pfnProgress,
3495
                                     void *pProgressData)
3496
0
{
3497
0
    psOptions->pfnProgress = pfnProgress;
3498
0
    psOptions->pProgressData = pProgressData;
3499
0
    if (pfnProgress == GDALTermProgress)
3500
0
        psOptions->bQuiet = false;
3501
0
}