/****************************************************************************** * * Project: GDAL Utilities * Purpose: GDAL Image Translator Program * Author: Frank Warmerdam, warmerdam@pobox.com * ****************************************************************************** * Copyright (c) 1998, 2002, Frank Warmerdam * Copyright (c) 2007-2015, Even Rouault * Copyright (c) 2015, Faza Mahamood * * SPDX-License-Identifier: MIT ****************************************************************************/ #include "cpl_port.h" #include "gdal_utils.h" #include "gdal_utils_priv.h" #include "gdalargumentparser.h" #include #include #include #include #include #include #include #include "commonutils.h" #include "cpl_conv.h" #include "cpl_error.h" #include "cpl_json.h" #include "cpl_progress.h" #include "cpl_string.h" #include "cpl_vsi.h" #include "gdal.h" #include "gdal_priv.h" #include "gdal_priv_templates.hpp" #include "gdal_rat.h" #include "gdal_vrt.h" #include "ogr_core.h" #include "ogr_spatialref.h" #include "vrtdataset.h" static void AttachMetadata(GDALDatasetH, const CPLStringList &); static void AttachDomainMetadata(GDALDatasetH, const CPLStringList &); static void CopyBandInfo(GDALRasterBand *poSrcBand, GDALRasterBand *poDstBand, int bCanCopyStatsMetadata, int bCopyScale, int bCopyNoData, bool bCopyRAT, const GDALTranslateOptions *psOptions); typedef enum { MASK_DISABLED, MASK_AUTO, MASK_USER } MaskMode; /************************************************************************/ /* GDALTranslateScaleParams */ /************************************************************************/ /** scaling parameters for use in GDALTranslateOptions. */ struct GDALTranslateScaleParams { /*! scaling is done only if it is set to TRUE. This is helpful when there is a need to scale only certain bands. */ bool bScale = false; /*! the range of input pixel values which need to be scaled. If not set, the input range is automatically computed from the source data. */ double dfScaleSrcMin = std::numeric_limits::quiet_NaN(); double dfScaleSrcMax = std::numeric_limits::quiet_NaN(); /*! the range of output pixel values. */ double dfScaleDstMin = std::numeric_limits::quiet_NaN(); double dfScaleDstMax = std::numeric_limits::quiet_NaN(); }; /************************************************************************/ /* GDALTranslateOptions */ /************************************************************************/ /** Options for use with GDALTranslate(). GDALTranslateOptions* must be * allocated and freed with GDALTranslateOptionsNew() and * GDALTranslateOptionsFree() respectively. */ struct GDALTranslateOptions { /*! Raw program arguments */ CPLStringList aosArgs{}; /*! output format. Use the short format name. */ std::string osFormat{}; /*! allow or suppress progress monitor and other non-error output */ bool bQuiet = false; /*! the progress function to use */ GDALProgressFunc pfnProgress = GDALDummyProgress; /*! pointer to the progress data variable */ void *pProgressData = nullptr; /*! for the output bands to be of the indicated data type */ GDALDataType eOutputType = GDT_Unknown; /*! Used only by parser logic */ bool bParsedMaskArgument = false; MaskMode eMaskMode = MASK_AUTO; /*! number of input bands to write to the output file, or to reorder bands */ int nBandCount = 0; /*! list of input bands to write to the output file, or to reorder bands. The value 1 corresponds to the 1st band. */ std::vector anBandList{}; /* negative value of panBandList[i] means mask band of ABS(panBandList[i]) */ /*! size of the output file. GDALTranslateOptions::nOXSizePixel is in pixels and GDALTranslateOptions::nOYSizePixel is in lines. If one of the two values is set to 0, its value will be determined from the other one, while maintaining the aspect ratio of the source dataset */ int nOXSizePixel = 0; int nOYSizePixel = 0; /*! size of the output file. GDALTranslateOptions::dfOXSizePct and GDALTranslateOptions::dfOYSizePct are fraction of the input image size. The value 100 means 100%. If one of the two values is set to 0, its value will be determined from the other one, while maintaining the aspect ratio of the source dataset */ double dfOXSizePct = 0; double dfOYSizePct = 0; /*! list of creation options to the output format driver */ CPLStringList aosCreateOptions{}; /*! subwindow from the source image for copying based on pixel/line location */ struct PixelLineWindow { double dfXOff{0}; double dfYOff{0}; double dfXSize{0}; double dfYSize{0}; }; PixelLineWindow srcWin{}; /*! don't be forgiving of mismatches and lost data when translating to the * output format */ bool bStrict = false; /*! apply the scale/offset metadata for the bands to convert scaled values * to unscaled values. It is also often necessary to reset the output * datatype with GDALTranslateOptions::eOutputType */ bool bUnscale = false; bool bSetScale = false; double dfScale = 1; bool bSetOffset = false; double dfOffset = 0; /*! the list of scale parameters for each band. */ std::vector asScaleParams{}; /*! It is set to TRUE, when scale parameters are specific to each band */ bool bHasUsedExplicitScaleBand = false; bool bNoClip = false; bool bNoWarnAboutOutsideWindow = false; /*! to apply non-linear scaling with a power function. It is the list of exponents of the power function (must be positive). This option must be used with GDALTranslateOptions::asScaleParams. If GDALTranslateOptions::adfExponent.size() is 1, it is applied to all bands of the output image. */ std::vector adfExponent{}; bool bHasUsedExplicitExponentBand = false; /*! list of metadata key and value to set on the output dataset if possible. */ CPLStringList aosMetadataOptions{}; /*! list of metadata key and value in a domain to set on the output dataset if possible. */ CPLStringList aosDomainMetadataOptions{}; /*! override the projection for the output file. The SRS may be any of the usual GDAL/OGR forms, complete WKT, PROJ.4, EPSG:n or a file containing the WKT. */ std::string osOutputSRS{}; /*! Coordinate epoch of output SRS */ double dfOutputCoordinateEpoch = 0; /*! does not copy source GCP into destination dataset (when TRUE) */ bool bNoGCP = false; /*! list of GCPs to be added to the output dataset */ std::vector asGCPs{}; /*! assign/override the georeferenced bounds of the output file. This assigns georeferenced bounds to the output file, ignoring what would have been derived from the source file. So this does not cause reprojection to the specified SRS. */ std::array adfULLR{{0, 0, 0, 0}}; /*! assign/override the geotransform of the output file. This assigns a geotransform to the output file, ignoring what would have been derived from the source file. So this does not cause reprojection to the specified SRS. */ GDALGeoTransform gt{0.0, 0.0, 0.0, 0.0, 0.0, 0.0}; /*! set a nodata value specified in GDALTranslateOptions::osNoData to the * output bands */ bool bSetNoData = 0; /*! avoid setting a nodata value to the output file if one exists for the * source file */ bool bUnsetNoData = 0; /*! Assign a specified nodata value to output bands ( GDALTranslateOptions::bSetNoData option should be set). Note that if the input dataset has a nodata value, this does not cause pixel values that are equal to that nodata value to be changed to the value specified. */ std::string osNoData{}; /*! to expose a dataset with 1 band with a color table as a dataset with 3 (RGB) or 4 (RGBA) bands. Useful for output drivers such as JPEG, JPEG2000, MrSID, ECW that don't support color indexed datasets. The 1 value enables to expand a dataset with a color table that only contains gray levels to a gray indexed dataset. */ int nRGBExpand = 0; int nMaskBand = 0; /* negative value means mask band of ABS(nMaskBand) */ /*! force recomputation of statistics */ bool bStats = false; bool bApproxStats = false; /*! If this option is set, GDALTranslateOptions::adfSrcWin or (GDALTranslateOptions::dfULX, GDALTranslateOptions::dfULY, GDALTranslateOptions::dfLRX, GDALTranslateOptions::dfLRY) values that falls partially outside the source raster extent will be considered as an error. The default behavior is to accept such requests. */ bool bErrorOnPartiallyOutside = false; /*! Same as bErrorOnPartiallyOutside, except that the criterion for erroring out is when the request falls completely outside the source raster extent. */ bool bErrorOnCompletelyOutside = false; /*! does not copy source RAT into destination dataset (when TRUE) */ bool bNoRAT = false; /*! resampling algorithm nearest (default), bilinear, cubic, cubicspline, lanczos, average, mode */ std::string osResampling{}; /*! target resolution. The values must be expressed in georeferenced units. Both must be positive values. This is exclusive with GDALTranslateOptions::nOXSizePixel (or GDALTranslateOptions::dfOXSizePct), GDALTranslateOptions::nOYSizePixel (or GDALTranslateOptions::dfOYSizePct), GDALTranslateOptions::adfULLR, and GDALTranslateOptions::gt. */ double dfXRes = 0; double dfYRes = 0; /*! subwindow from the source image for copying (like GDALTranslateOptions::adfSrcWin) but with the corners given in georeferenced coordinates (by default expressed in the SRS of the dataset. Can be changed with osProjSRS) */ double dfULX = 0; double dfULY = 0; double dfLRX = 0; double dfLRY = 0; /*! SRS in which to interpret the coordinates given with GDALTranslateOptions::dfULX, GDALTranslateOptions::dfULY, GDALTranslateOptions::dfLRX, GDALTranslateOptions::dfLRY. The SRS may be any of the usual GDAL/OGR forms, complete WKT, PROJ.4, EPSG:n or a file containing the WKT. Note that this does not cause reprojection of the dataset to the specified SRS. */ std::string osProjSRS{}; int nLimitOutSize = 0; // Array of color interpretations per band. Should be a GDALColorInterp // value, or -1 if no override. std::vector anColorInterp{}; /*! does not copy source XMP into destination dataset (when TRUE) */ bool bNoXMP = false; /*! overview level of source file to be used */ int nOvLevel = OVR_LEVEL_AUTO; /*! set to true to prevent overwriting existing dataset */ bool bNoOverwrite = false; GDALTranslateOptions() = default; GDALTranslateOptions(const GDALTranslateOptions &) = default; GDALTranslateOptions &operator=(const GDALTranslateOptions &) = delete; }; /************************************************************************/ /* SrcToDst() */ /************************************************************************/ static void SrcToDst(double dfX, double dfY, double dfSrcXOff, double dfSrcYOff, double dfSrcXSize, double dfSrcYSize, double dfDstXOff, double dfDstYOff, double dfDstXSize, double dfDstYSize, double &dfXOut, double &dfYOut) { dfXOut = ((dfX - dfSrcXOff) / dfSrcXSize) * dfDstXSize + dfDstXOff; dfYOut = ((dfY - dfSrcYOff) / dfSrcYSize) * dfDstYSize + dfDstYOff; } /************************************************************************/ /* GetSrcDstWindow() */ /************************************************************************/ static bool FixSrcDstWindow(GDALTranslateOptions::PixelLineWindow &srcWin, GDALTranslateOptions::PixelLineWindow &dstWin, int nSrcRasterXSize, int nSrcRasterYSize) { const double dfSrcXOff = srcWin.dfXOff; const double dfSrcYOff = srcWin.dfYOff; const double dfSrcXSize = srcWin.dfXSize; const double dfSrcYSize = srcWin.dfYSize; const double dfDstXOff = dstWin.dfXOff; const double dfDstYOff = dstWin.dfYOff; const double dfDstXSize = dstWin.dfXSize; const double dfDstYSize = dstWin.dfYSize; bool bModifiedX = false; bool bModifiedY = false; double dfModifiedSrcXOff = dfSrcXOff; double dfModifiedSrcYOff = dfSrcYOff; double dfModifiedSrcXSize = dfSrcXSize; double dfModifiedSrcYSize = dfSrcYSize; /* -------------------------------------------------------------------- */ /* Clamp within the bounds of the available source data. */ /* -------------------------------------------------------------------- */ if (dfModifiedSrcXOff < 0) { dfModifiedSrcXSize += dfModifiedSrcXOff; dfModifiedSrcXOff = 0; bModifiedX = true; } if (dfModifiedSrcYOff < 0) { dfModifiedSrcYSize += dfModifiedSrcYOff; dfModifiedSrcYOff = 0; bModifiedY = true; } if (dfModifiedSrcXOff + dfModifiedSrcXSize > nSrcRasterXSize) { dfModifiedSrcXSize = nSrcRasterXSize - dfModifiedSrcXOff; bModifiedX = true; } if (dfModifiedSrcYOff + dfModifiedSrcYSize > nSrcRasterYSize) { dfModifiedSrcYSize = nSrcRasterYSize - dfModifiedSrcYOff; bModifiedY = true; } /* -------------------------------------------------------------------- */ /* Don't do anything if the requesting region is completely off */ /* the source image. */ /* -------------------------------------------------------------------- */ if (dfModifiedSrcXOff >= nSrcRasterXSize || dfModifiedSrcYOff >= nSrcRasterYSize || dfModifiedSrcXSize <= 0 || dfModifiedSrcYSize <= 0) { return false; } srcWin.dfXOff = dfModifiedSrcXOff; srcWin.dfYOff = dfModifiedSrcYOff; srcWin.dfXSize = dfModifiedSrcXSize; srcWin.dfYSize = dfModifiedSrcYSize; /* -------------------------------------------------------------------- */ /* If we haven't had to modify the source rectangle, then the */ /* destination rectangle must be the whole region. */ /* -------------------------------------------------------------------- */ if (!bModifiedX && !bModifiedY) return true; /* -------------------------------------------------------------------- */ /* Now transform this possibly reduced request back into the */ /* destination buffer coordinates in case the output region is */ /* less than the whole buffer. */ /* -------------------------------------------------------------------- */ double dfDstULX, dfDstULY, dfDstLRX, dfDstLRY; SrcToDst(dfModifiedSrcXOff, dfModifiedSrcYOff, dfSrcXOff, dfSrcYOff, dfSrcXSize, dfSrcYSize, dfDstXOff, dfDstYOff, dfDstXSize, dfDstYSize, dfDstULX, dfDstULY); SrcToDst(dfModifiedSrcXOff + dfModifiedSrcXSize, dfModifiedSrcYOff + dfModifiedSrcYSize, dfSrcXOff, dfSrcYOff, dfSrcXSize, dfSrcYSize, dfDstXOff, dfDstYOff, dfDstXSize, dfDstYSize, dfDstLRX, dfDstLRY); double dfModifiedDstXOff = dfDstXOff; double dfModifiedDstYOff = dfDstYOff; double dfModifiedDstXSize = dfDstXSize; double dfModifiedDstYSize = dfDstYSize; if (bModifiedX) { dfModifiedDstXOff = dfDstULX - dfDstXOff; dfModifiedDstXSize = (dfDstLRX - dfDstXOff) - dfModifiedDstXOff; dfModifiedDstXOff = std::max(0.0, dfModifiedDstXOff); if (dfModifiedDstXOff + dfModifiedDstXSize > dfDstXSize) dfModifiedDstXSize = dfDstXSize - dfModifiedDstXOff; } if (bModifiedY) { dfModifiedDstYOff = dfDstULY - dfDstYOff; dfModifiedDstYSize = (dfDstLRY - dfDstYOff) - dfModifiedDstYOff; dfModifiedDstYOff = std::max(0.0, dfModifiedDstYOff); if (dfModifiedDstYOff + dfModifiedDstYSize > dfDstYSize) dfModifiedDstYSize = dfDstYSize - dfModifiedDstYOff; } if (dfModifiedDstXSize <= 0.0 || dfModifiedDstYSize <= 0.0) { return false; } dstWin.dfXOff = dfModifiedDstXOff; dstWin.dfYOff = dfModifiedDstYOff; dstWin.dfXSize = dfModifiedDstXSize; dstWin.dfYSize = dfModifiedDstYSize; return true; } /************************************************************************/ /* GDALTranslateFlush() */ /************************************************************************/ static GDALDatasetH GDALTranslateFlush(GDALDatasetH hOutDS) { if (hOutDS != nullptr) { CPLErr eErrBefore = CPLGetLastErrorType(); GDALFlushCache(hOutDS); if (eErrBefore == CE_None && CPLGetLastErrorType() != CE_None) { GDALClose(hOutDS); hOutDS = nullptr; } } return hOutDS; } /************************************************************************/ /* EditISIS3MetadataForBandChange() */ /************************************************************************/ static CPLJSONObject Clone(const CPLJSONObject &obj) { auto serialized = obj.Format(CPLJSONObject::PrettyFormat::Plain); CPLJSONDocument oJSONDocument; const GByte *pabyData = reinterpret_cast(serialized.c_str()); oJSONDocument.LoadMemory(pabyData); return oJSONDocument.GetRoot(); } static void ReworkArray(CPLJSONObject &container, const CPLJSONObject &obj, int nSrcBandCount, const GDALTranslateOptions *psOptions) { auto oArray = obj.ToArray(); if (oArray.Size() == nSrcBandCount) { CPLJSONArray oNewArray; for (int nBand : psOptions->anBandList) { const int iSrcIdx = nBand - 1; oNewArray.Add(oArray[iSrcIdx]); } const auto childName(obj.GetName()); container.Delete(childName); container.Add(childName, oNewArray); } } static std::string EditISIS3MetadataForBandChange(const char *pszJSON, int nSrcBandCount, const GDALTranslateOptions *psOptions) { CPLJSONDocument oJSONDocument; if (!oJSONDocument.LoadMemory(pszJSON)) { return std::string(); } auto oRoot = oJSONDocument.GetRoot(); if (!oRoot.IsValid()) { return std::string(); } auto oBandBin = oRoot.GetObj("IsisCube/BandBin"); if (oBandBin.IsValid() && oBandBin.GetType() == CPLJSONObject::Type::Object) { // Backup original BandBin object oRoot.GetObj("IsisCube").Add("OriginalBandBin", Clone(oBandBin)); // Iterate over BandBin members and reorder/resize its arrays that // have the same number of elements than the number of bands of the // source dataset. for (auto &child : oBandBin.GetChildren()) { if (child.GetType() == CPLJSONObject::Type::Array) { ReworkArray(oBandBin, child, nSrcBandCount, psOptions); } else if (child.GetType() == CPLJSONObject::Type::Object) { auto oValue = child.GetObj("value"); auto oUnit = child.GetObj("unit"); if (oValue.GetType() == CPLJSONObject::Type::Array) { ReworkArray(child, oValue, nSrcBandCount, psOptions); } } } } return oRoot.Format(CPLJSONObject::PrettyFormat::Pretty); } /************************************************************************/ /* EditISIS3ForMetadataChanges() */ /************************************************************************/ static std::string EditISIS3ForMetadataChanges(const char *pszJSON, bool bKeepExtent, bool bKeepResolution, const GDALTranslateOptions *psOptions) { CPLJSONDocument oJSONDocument; if (!oJSONDocument.LoadMemory(pszJSON)) { return std::string(); } auto oRoot = oJSONDocument.GetRoot(); if (!oRoot.IsValid()) { return std::string(); } auto oGDALHistory = oRoot.GetObj("GDALHistory"); if (!oGDALHistory.IsValid()) { oGDALHistory = CPLJSONObject(); oRoot.Add("GDALHistory", oGDALHistory); } oGDALHistory["_type"] = "object"; char szFullFilename[2048] = {0}; if (!CPLGetExecPath(szFullFilename, sizeof(szFullFilename) - 1)) strcpy(szFullFilename, "unknown_program"); const CPLString osProgram(CPLGetBasenameSafe(szFullFilename)); const CPLString osPath(CPLGetPathSafe(szFullFilename)); oGDALHistory["GdalVersion"] = GDALVersionInfo("RELEASE_NAME"); oGDALHistory["Program"] = osProgram; if (osPath != ".") oGDALHistory["ProgramPath"] = osPath; std::vector aosOps; if (!bKeepExtent) { aosOps.push_back("a clipping operation"); } if (!bKeepResolution) { aosOps.push_back("a resolution change operation"); } if (psOptions->bUnscale) { aosOps.push_back("an unscaling operation"); } else if (!psOptions->asScaleParams.empty()) { aosOps.push_back("a scaling operation"); } std::string osArgs; for (const char *pszArg : psOptions->aosArgs) { if (!osArgs.empty()) osArgs += ' '; osArgs += pszArg; } oGDALHistory["ProgramArguments"] = osArgs; std::string osComment = "Part of that metadata might be invalid due to "; for (size_t i = 0; i < aosOps.size(); ++i) { if (i > 0 && i + 1 == aosOps.size()) osComment += " and "; else if (i > 0) osComment += ", "; osComment += aosOps[i]; } osComment += " having been performed by GDAL tools"; oGDALHistory.Add("Comment", osComment); return oRoot.Format(CPLJSONObject::PrettyFormat::Pretty); } /************************************************************************/ /* GDALTranslate() */ /************************************************************************/ /* clang-format off */ /** * Converts raster data between different formats. * * This is the equivalent of the * gdal_translate utility. * * GDALTranslateOptions* must be allocated and freed with * GDALTranslateOptionsNew() and GDALTranslateOptionsFree() respectively. * * @param pszDest the destination dataset path. * @param hSrcDataset the source dataset handle. * @param psOptionsIn the options struct returned by GDALTranslateOptionsNew() * or NULL. * @param pbUsageError pointer to a integer output variable to store if any * usage error has occurred or NULL. * @return the output dataset (new dataset that must be closed using * GDALClose()) or NULL in case of error. If the output * format is a VRT dataset, then the returned VRT dataset has a reference to * hSrcDataset. Hence hSrcDataset should be closed after the returned dataset * if using GDALClose(). * A safer alternative is to use GDALReleaseDataset() instead of using * GDALClose(), in which case you can close datasets in any order. * * @since GDAL 2.1 */ /* clang-format on */ GDALDatasetH GDALTranslate(const char *pszDest, GDALDatasetH hSrcDataset, const GDALTranslateOptions *psOptionsIn, int *pbUsageError) { CPLErrorReset(); if (hSrcDataset == nullptr) { CPLError(CE_Failure, CPLE_AppDefined, "No source dataset specified."); if (pbUsageError) *pbUsageError = TRUE; return nullptr; } if (pszDest == nullptr) { CPLError(CE_Failure, CPLE_AppDefined, "No target dataset specified."); if (pbUsageError) *pbUsageError = TRUE; return nullptr; } auto psOptions = psOptionsIn ? std::make_unique(*psOptionsIn) : std::unique_ptr( GDALTranslateOptionsNew(nullptr, nullptr)); GDALDatasetH hOutDS = nullptr; bool bGotBounds = false; bool bGotGeoTransform = false; if (pbUsageError) *pbUsageError = FALSE; if (psOptions->adfULLR[0] != 0.0 || psOptions->adfULLR[1] != 0.0 || psOptions->adfULLR[2] != 0.0 || psOptions->adfULLR[3] != 0.0) bGotBounds = true; if (psOptions->gt != GDALGeoTransform(0, 0, 0, 0, 0, 0)) bGotGeoTransform = true; GDALDataset *poSrcDS = GDALDataset::FromHandle(hSrcDataset); const char *pszSource = poSrcDS->GetDescription(); if (strcmp(pszSource, pszDest) == 0 && pszSource[0] != '\0' && poSrcDS->GetDriver() != GDALGetDriverByName("MEM")) { CPLError(CE_Failure, CPLE_AppDefined, "Source and destination datasets must be different."); if (pbUsageError) *pbUsageError = TRUE; return nullptr; } CPLString osProjSRS; if (!psOptions->osProjSRS.empty()) { OGRSpatialReference oSRS; oSRS.SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER); if (oSRS.SetFromUserInput(psOptions->osProjSRS.c_str()) != OGRERR_NONE) { CPLError(CE_Failure, CPLE_AppDefined, "Failed to process SRS definition: %s", psOptions->osProjSRS.c_str()); return nullptr; } char *pszSRS = nullptr; oSRS.exportToWkt(&pszSRS); if (pszSRS) osProjSRS = pszSRS; CPLFree(pszSRS); } if (!psOptions->osOutputSRS.empty() && psOptions->osOutputSRS != "null" && psOptions->osOutputSRS != "none") { OGRSpatialReference oOutputSRS; if (oOutputSRS.SetFromUserInput(psOptions->osOutputSRS.c_str()) != OGRERR_NONE) { CPLError(CE_Failure, CPLE_AppDefined, "Failed to process SRS definition: %s", psOptions->osOutputSRS.c_str()); return nullptr; } } /* -------------------------------------------------------------------- */ /* Check that incompatible options are not used */ /* -------------------------------------------------------------------- */ if ((psOptions->nOXSizePixel != 0 || psOptions->dfOXSizePct != 0.0 || psOptions->nOYSizePixel != 0 || psOptions->dfOYSizePct != 0.0) && (psOptions->dfXRes != 0 && psOptions->dfYRes != 0)) { CPLError(CE_Failure, CPLE_IllegalArg, "-outsize and -tr options cannot be used at the same time."); if (pbUsageError) *pbUsageError = TRUE; return nullptr; } if ((bGotBounds | bGotGeoTransform) && (psOptions->dfXRes != 0 && psOptions->dfYRes != 0)) { CPLError( CE_Failure, CPLE_IllegalArg, "-a_ullr or -a_gt options cannot be used at the same time as -tr."); if (pbUsageError) *pbUsageError = TRUE; return nullptr; } if (bGotBounds && bGotGeoTransform) { CPLError(CE_Failure, CPLE_IllegalArg, "-a_ullr and -a_gt options cannot be used at the same time."); if (pbUsageError) *pbUsageError = TRUE; return nullptr; } /* -------------------------------------------------------------------- */ /* Collect some information from the source file. */ /* -------------------------------------------------------------------- */ if (psOptions->srcWin.dfXSize == 0 && psOptions->srcWin.dfYSize == 0) { psOptions->srcWin.dfXSize = poSrcDS->GetRasterXSize(); psOptions->srcWin.dfYSize = poSrcDS->GetRasterYSize(); } /* -------------------------------------------------------------------- */ /* Build band list to translate */ /* -------------------------------------------------------------------- */ bool bAllBandsInOrder = true; if (psOptions->anBandList.empty()) { psOptions->nBandCount = poSrcDS->GetRasterCount(); if ((psOptions->nBandCount == 0) && (psOptions->bStrict)) { // if not strict then the driver can fail if it doesn't support zero // bands CPLError(CE_Failure, CPLE_AppDefined, "Input file has no bands, and so cannot be translated."); return nullptr; } psOptions->anBandList.resize(psOptions->nBandCount); for (int i = 0; i < psOptions->nBandCount; i++) psOptions->anBandList[i] = i + 1; } else { for (int i = 0; i < psOptions->nBandCount; i++) { if (std::abs(psOptions->anBandList[i]) > poSrcDS->GetRasterCount()) { CPLError(CE_Failure, CPLE_AppDefined, "Band %d requested, but only bands 1 to %d available.", std::abs(psOptions->anBandList[i]), poSrcDS->GetRasterCount()); return nullptr; } if (psOptions->anBandList[i] != i + 1) bAllBandsInOrder = FALSE; } if (psOptions->nBandCount != poSrcDS->GetRasterCount()) bAllBandsInOrder = FALSE; } if (static_cast(psOptions->asScaleParams.size()) > psOptions->nBandCount) { if (!psOptions->bHasUsedExplicitScaleBand) CPLError(CE_Failure, CPLE_IllegalArg, "-scale has been specified more times than the number of " "output bands"); else CPLError(CE_Failure, CPLE_IllegalArg, "-scale_XX has been specified with XX greater than the " "number of output bands"); if (pbUsageError) *pbUsageError = TRUE; return nullptr; } if (static_cast(psOptions->adfExponent.size()) > psOptions->nBandCount) { if (!psOptions->bHasUsedExplicitExponentBand) CPLError(CE_Failure, CPLE_IllegalArg, "-exponent has been specified more times than the number " "of output bands"); else CPLError(CE_Failure, CPLE_IllegalArg, "-exponent_XX has been specified with XX greater than the " "number of output bands"); if (pbUsageError) *pbUsageError = TRUE; return nullptr; } if (!psOptions->bQuiet && (psOptions->bSetScale || psOptions->bSetOffset) && psOptions->bUnscale) { // Cf https://github.com/OSGeo/gdal/issues/7863 CPLError(CE_Warning, CPLE_AppDefined, "-a_scale/-a_offset are not applied by -unscale, but are set " "after it, and -unscale uses the original source band " "scale/offset values. " "You may want to use -scale 0 1 %.16g %.16g instead. " "This warning will not appear if -q is specified.", psOptions->dfOffset, psOptions->dfOffset + psOptions->dfScale); } /* -------------------------------------------------------------------- */ /* Compute the source window from the projected source window */ /* if the projected coordinates were provided. Note that the */ /* projected coordinates are in ulx, uly, lrx, lry format, */ /* while the adfSrcWin is xoff, yoff, xsize, ysize with the */ /* xoff,yoff being the ulx, uly in pixel/line. */ /* -------------------------------------------------------------------- */ const char *pszProjection = nullptr; if (psOptions->dfULX != 0.0 || psOptions->dfULY != 0.0 || psOptions->dfLRX != 0.0 || psOptions->dfLRY != 0.0) { GDALGeoTransform gt; poSrcDS->GetGeoTransform(gt); if (gt[1] == 0.0 || gt[5] == 0.0) { CPLError(CE_Failure, CPLE_AppDefined, "The -projwin option was used, but the geotransform is " "invalid."); return nullptr; } if (gt[2] != 0.0 || gt[4] != 0.0) { CPLError(CE_Failure, CPLE_AppDefined, "The -projwin option was used, but the geotransform is\n" "rotated. This configuration is not supported."); return nullptr; } if (!osProjSRS.empty()) { pszProjection = poSrcDS->GetProjectionRef(); if (pszProjection != nullptr && strlen(pszProjection) > 0) { OGRSpatialReference oSRSIn; OGRSpatialReference oSRSDS; oSRSIn.SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER); oSRSDS.SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER); oSRSIn.SetFromUserInput(osProjSRS); oSRSDS.SetFromUserInput(pszProjection); if (!oSRSIn.IsSame(&oSRSDS)) { OGRCoordinateTransformation *poCT = OGRCreateCoordinateTransformation(&oSRSIn, &oSRSDS); if (!(poCT && poCT->TransformBounds( psOptions->dfULX, psOptions->dfLRY, psOptions->dfLRX, psOptions->dfULY, &psOptions->dfULX, &psOptions->dfLRY, &psOptions->dfLRX, &psOptions->dfULY, 21))) { OGRCoordinateTransformation::DestroyCT(poCT); CPLError(CE_Failure, CPLE_AppDefined, "-projwin_srs ignored since coordinate " "transformation failed."); return nullptr; } delete poCT; } } else { CPLError(CE_Warning, CPLE_None, "-projwin_srs ignored since the dataset has no " "projection."); } } bool bAlignToInputPixels = psOptions->osResampling.empty() || EQUALN(psOptions->osResampling.c_str(), "NEAR", 4); double dfULX = psOptions->dfULX; double dfULY = psOptions->dfULY; psOptions->srcWin.dfXOff = (dfULX - gt[0]) / gt[1]; psOptions->srcWin.dfYOff = (dfULY - gt[3]) / gt[5]; // In case of nearest resampling, round to integer pixels (#6610) if (bAlignToInputPixels) { psOptions->srcWin.dfXOff = std::floor(psOptions->srcWin.dfXOff + 0.001); // xoff psOptions->srcWin.dfYOff = std::floor(psOptions->srcWin.dfYOff + 0.001); // yoff dfULX = psOptions->srcWin.dfXOff * gt[1] + gt[0]; dfULY = psOptions->srcWin.dfYOff * gt[5] + gt[3]; } // Calculate xsize and ysize based on the (possibly snapped) ULX, ULY psOptions->srcWin.dfXSize = (psOptions->dfLRX - dfULX) / gt[1]; // xsize psOptions->srcWin.dfYSize = (psOptions->dfLRY - dfULY) / gt[5]; // ysize if (bAlignToInputPixels) { psOptions->srcWin.dfXSize = std::ceil(psOptions->srcWin.dfXSize - 0.001); psOptions->srcWin.dfYSize = std::ceil(psOptions->srcWin.dfYSize - 0.001); } /*if( !bQuiet ) fprintf( stdout, "Computed -srcwin %g %g %g %g from projected window.\n", srcWin.dfXOff, srcWin.dfYOff, srcWin.dfXSize, srcWin.dfYSize ); */ } /* -------------------------------------------------------------------- */ /* Verify source window dimensions. */ /* -------------------------------------------------------------------- */ if (poSrcDS->GetRasterXSize() != 0 && poSrcDS->GetRasterYSize() != 0 && (psOptions->srcWin.dfXSize <= 0 || psOptions->srcWin.dfYSize <= 0)) { CPLError( CE_Failure, CPLE_AppDefined, "Error: %s-srcwin %g %g %g %g has negative width and/or height.", (psOptions->dfULX != 0.0 || psOptions->dfULY != 0.0 || psOptions->dfLRX != 0.0 || psOptions->dfLRY != 0.0) ? "Computed " : "", psOptions->srcWin.dfXOff, psOptions->srcWin.dfYOff, psOptions->srcWin.dfXSize, psOptions->srcWin.dfYSize); return nullptr; } /* -------------------------------------------------------------------- */ /* Verify source window dimensions. */ /* -------------------------------------------------------------------- */ else if (psOptions->srcWin.dfXOff <= -1 || psOptions->srcWin.dfYOff <= -1 || psOptions->srcWin.dfXOff + psOptions->srcWin.dfXSize - 1 >= poSrcDS->GetRasterXSize() || psOptions->srcWin.dfYOff + psOptions->srcWin.dfYSize - 1 >= poSrcDS->GetRasterYSize()) { const bool bCompletelyOutside = psOptions->srcWin.dfXOff + psOptions->srcWin.dfXSize <= 0 || psOptions->srcWin.dfYOff + psOptions->srcWin.dfYSize <= 0 || psOptions->srcWin.dfXOff >= poSrcDS->GetRasterXSize() || psOptions->srcWin.dfYOff >= poSrcDS->GetRasterYSize(); const bool bIsError = psOptions->bErrorOnPartiallyOutside || (bCompletelyOutside && psOptions->bErrorOnCompletelyOutside); if ((!psOptions->bQuiet && !psOptions->bNoWarnAboutOutsideWindow) || bIsError) { CPLErr eErr = bIsError ? CE_Failure : CE_Warning; CPLError(eErr, CPLE_AppDefined, "%s-srcwin %g %g %g %g falls %s outside source raster " "extent.%s", (psOptions->dfULX != 0.0 || psOptions->dfULY != 0.0 || psOptions->dfLRX != 0.0 || psOptions->dfLRY != 0.0) ? "Computed " : "", psOptions->srcWin.dfXOff, psOptions->srcWin.dfYOff, psOptions->srcWin.dfXSize, psOptions->srcWin.dfYSize, bCompletelyOutside ? "completely" : "partially", bIsError ? "" : " Pixels outside the source raster extent will be " "set to the NoData value (if defined), or zero."); } if (bIsError) { return nullptr; } } /* -------------------------------------------------------------------- */ /* Find the output driver. */ /* -------------------------------------------------------------------- */ if (psOptions->osFormat.empty()) { psOptions->osFormat = GetOutputDriverForRaster(pszDest); if (psOptions->osFormat.empty()) { CPLError(CE_Failure, CPLE_AppDefined, "Could not identify an output driver for %s", pszDest); return nullptr; } } GDALDriverH hDriver = GDALGetDriverByName(psOptions->osFormat.c_str()); if (hDriver == nullptr) { CPLError(CE_Failure, CPLE_IllegalArg, "Output driver `%s' not recognised.", psOptions->osFormat.c_str()); return nullptr; } /* -------------------------------------------------------------------- */ /* Make sure we cleanup if there is an existing dataset of this */ /* name. But even if that seems to fail we will continue since */ /* it might just be a corrupt file or something. */ /* This is needed for */ /* gdal_translate foo.tif foo.tif.ovr -outsize 50% 50% */ /* -------------------------------------------------------------------- */ if (psOptions->aosCreateOptions.FetchBool("APPEND_SUBDATASET", false)) { if (GDALGetMetadataItem(hDriver, GDAL_DCAP_CREATE_SUBDATASETS, nullptr) == nullptr) { CPLError(CE_Failure, CPLE_NotSupported, "Subdataset creation not supported for driver %s", GDALGetDescription(hDriver)); return nullptr; } } else { if (!EQUAL(psOptions->osFormat.c_str(), "VRT")) { // Prevent GDALDriver::CreateCopy() from doing that again. psOptions->aosCreateOptions.SetNameValue( "@QUIET_DELETE_ON_CREATE_COPY", "NO"); } if (psOptions->bNoOverwrite && !EQUAL(pszDest, "") && !EQUAL(pszDest, "/vsistdout/")) { VSIStatBufL sStat; if (VSIStatL(pszDest, &sStat) == 0) { CPLError(CE_Failure, CPLE_AppDefined, "File '%s' already exists. Specify the --overwrite " "option to overwrite it.", pszDest); return nullptr; } else { bool bExists; { CPLErrorStateBackuper oBackuper(CPLQuietErrorHandler); bExists = std::unique_ptr( GDALDataset::Open(pszDest)) != nullptr; } if (bExists) { CPLError( CE_Failure, CPLE_AppDefined, "Dataset '%s' already exists. Specify the --overwrite " "option to overwrite it.", pszDest); return nullptr; } } } GDALDriver::FromHandle(hDriver)->QuietDeleteForCreateCopy(pszDest, poSrcDS); // Make sure to load early overviews, so that on the GTiff driver // external .ovr is looked for before it might be created as the // output dataset ! if (poSrcDS->GetRasterCount()) { auto poBand = poSrcDS->GetRasterBand(1); if (poBand) poBand->GetOverviewCount(); } } char **papszDriverMD = GDALGetMetadata(hDriver, nullptr); if (!CPLTestBool( CSLFetchNameValueDef(papszDriverMD, GDAL_DCAP_RASTER, "FALSE"))) { CPLError(CE_Failure, CPLE_AppDefined, "%s driver has no raster capabilities.", psOptions->osFormat.c_str()); return nullptr; } if (!CPLTestBool( CSLFetchNameValueDef(papszDriverMD, GDAL_DCAP_CREATE, "FALSE")) && !CPLTestBool( CSLFetchNameValueDef(papszDriverMD, GDAL_DCAP_CREATECOPY, "FALSE"))) { CPLError(CE_Failure, CPLE_AppDefined, "%s driver has no creation capabilities.", psOptions->osFormat.c_str()); return nullptr; } /* -------------------------------------------------------------------- */ /* The short form is to CreateCopy(). We use this if the input */ /* matches the whole dataset. Eventually we should rewrite */ /* this entire program to use virtual datasets to construct a */ /* virtual input source to copy from. */ /* -------------------------------------------------------------------- */ const bool bKeepResolution = psOptions->nOXSizePixel == 0 && psOptions->dfOXSizePct == 0.0 && psOptions->nOYSizePixel == 0 && psOptions->dfOYSizePct == 0.0 && psOptions->dfXRes == 0.0; const bool bKeepExtent = psOptions->srcWin.dfXOff == 0 && psOptions->srcWin.dfYOff == 0 && psOptions->srcWin.dfXSize == poSrcDS->GetRasterXSize() && psOptions->srcWin.dfYSize == poSrcDS->GetRasterYSize(); const bool bSpatialArrangementPreserved = bKeepExtent && bKeepResolution; const bool bValuesChanged = psOptions->bUnscale || !psOptions->asScaleParams.empty(); if (psOptions->eOutputType == GDT_Unknown && psOptions->asScaleParams.empty() && psOptions->adfExponent.empty() && !psOptions->bUnscale && !psOptions->bSetScale && !psOptions->bSetOffset && psOptions->aosMetadataOptions.empty() && psOptions->aosDomainMetadataOptions.empty() && bAllBandsInOrder && psOptions->eMaskMode == MASK_AUTO && bSpatialArrangementPreserved && !psOptions->bNoGCP && psOptions->asGCPs.empty() && !bGotBounds && !bGotGeoTransform && psOptions->osOutputSRS.empty() && psOptions->dfOutputCoordinateEpoch == 0 && !psOptions->bSetNoData && !psOptions->bUnsetNoData && psOptions->nRGBExpand == 0 && !psOptions->bNoRAT && psOptions->anColorInterp.empty() && !psOptions->bNoXMP && psOptions->nOvLevel == OVR_LEVEL_AUTO) { // For gdal_translate_fuzzer if (psOptions->nLimitOutSize > 0) { vsi_l_offset nRawOutSize = static_cast(poSrcDS->GetRasterXSize()) * poSrcDS->GetRasterYSize() * psOptions->nBandCount; if (psOptions->nBandCount) { nRawOutSize *= GDALGetDataTypeSizeBytes( poSrcDS->GetRasterBand(1)->GetRasterDataType()); } if (nRawOutSize > static_cast(psOptions->nLimitOutSize)) { CPLError(CE_Failure, CPLE_IllegalArg, "Attempt to create %dx%d dataset is above authorized " "limit.", poSrcDS->GetRasterXSize(), poSrcDS->GetRasterYSize()); return nullptr; } } /* -------------------------------------------------------------------- */ /* Compute stats if required. */ /* -------------------------------------------------------------------- */ if (psOptions->bStats && EQUAL(psOptions->osFormat.c_str(), "COG")) { psOptions->aosCreateOptions.SetNameValue("STATISTICS", "YES"); } else if (psOptions->bStats) { for (int i = 0; i < poSrcDS->GetRasterCount(); i++) { double dfMin, dfMax, dfMean, dfStdDev; poSrcDS->GetRasterBand(i + 1)->ComputeStatistics( psOptions->bApproxStats, &dfMin, &dfMax, &dfMean, &dfStdDev, GDALDummyProgress, nullptr); } } hOutDS = GDALCreateCopy( hDriver, pszDest, GDALDataset::ToHandle(poSrcDS), psOptions->bStrict, psOptions->aosCreateOptions.List(), psOptions->pfnProgress, psOptions->pProgressData); hOutDS = GDALTranslateFlush(hOutDS); return hOutDS; } if (psOptions->aosCreateOptions.FetchNameValue("COPY_SRC_OVERVIEWS")) { CPLError(CE_Warning, CPLE_AppDefined, "General options of gdal_translate make the " "COPY_SRC_OVERVIEWS creation option ineffective as they hide " "the overviews"); } /* -------------------------------------------------------------------- */ /* Establish some parameters. */ /* -------------------------------------------------------------------- */ int nOXSize = 0; int nOYSize = 0; bool bHasSrcGeoTransform = false; GDALGeoTransform srcGT; if (poSrcDS->GetGeoTransform(srcGT) == CE_None) bHasSrcGeoTransform = true; const bool bOutsizeExplicitlySet = !(psOptions->nOXSizePixel == 0 && psOptions->dfOXSizePct == 0.0 && psOptions->nOYSizePixel == 0 && psOptions->dfOYSizePct == 0.0); if (psOptions->dfXRes != 0.0 && psOptions->dfYRes != 0.0) { if (!(bHasSrcGeoTransform && psOptions->asGCPs.empty() && srcGT[2] == 0.0 && srcGT[4] == 0.0)) { CPLError(CE_Failure, CPLE_IllegalArg, "The -tr option was used, but there's no geotransform or " "it is\n" "rotated. This configuration is not supported."); return nullptr; } const double dfOXSize = psOptions->srcWin.dfXSize / psOptions->dfXRes * srcGT[1] + 0.5; const double dfOYSize = psOptions->srcWin.dfYSize / psOptions->dfYRes * fabs(srcGT[5]) + 0.5; if (dfOXSize < 1 || !GDALIsValueInRange(dfOXSize) || dfOYSize < 1 || !GDALIsValueInRange(dfOYSize)) { CPLError(CE_Failure, CPLE_IllegalArg, "Invalid output size: %g x %g", dfOXSize, dfOYSize); return nullptr; } nOXSize = static_cast(dfOXSize); nOYSize = static_cast(dfOYSize); } else if (!bOutsizeExplicitlySet) { double dfOXSize = ceil(psOptions->srcWin.dfXSize - 0.001); double dfOYSize = ceil(psOptions->srcWin.dfYSize - 0.001); if (dfOXSize < 1 || !GDALIsValueInRange(dfOXSize) || dfOYSize < 1 || !GDALIsValueInRange(dfOYSize)) { CPLError(CE_Failure, CPLE_IllegalArg, "Invalid output size: %g x %g", dfOXSize, dfOYSize); return nullptr; } nOXSize = static_cast(dfOXSize); nOYSize = static_cast(dfOYSize); } else { if (!(psOptions->nOXSizePixel == 0 && psOptions->dfOXSizePct == 0.0)) { if (psOptions->nOXSizePixel != 0) nOXSize = psOptions->nOXSizePixel; else { const double dfOXSize = psOptions->dfOXSizePct / 100 * psOptions->srcWin.dfXSize; if (dfOXSize < 1 || !GDALIsValueInRange(dfOXSize)) { CPLError(CE_Failure, CPLE_IllegalArg, "Invalid output width: %g", dfOXSize); return nullptr; } nOXSize = static_cast(dfOXSize); } } if (!(psOptions->nOYSizePixel == 0 && psOptions->dfOYSizePct == 0.0)) { if (psOptions->nOYSizePixel != 0) nOYSize = psOptions->nOYSizePixel; else { const double dfOYSize = psOptions->dfOYSizePct / 100 * psOptions->srcWin.dfYSize; if (dfOYSize < 1 || !GDALIsValueInRange(dfOYSize)) { CPLError(CE_Failure, CPLE_IllegalArg, "Invalid output height: %g", dfOYSize); return nullptr; } nOYSize = static_cast(dfOYSize); } } if (psOptions->nOXSizePixel == 0 && psOptions->dfOXSizePct == 0.0) { const double dfOXSize = static_cast(nOYSize) * psOptions->srcWin.dfXSize / psOptions->srcWin.dfYSize + 0.5; if (dfOXSize < 1 || !GDALIsValueInRange(dfOXSize)) { CPLError(CE_Failure, CPLE_IllegalArg, "Invalid output width: %g", dfOXSize); return nullptr; } nOXSize = static_cast(dfOXSize); } else if (psOptions->nOYSizePixel == 0 && psOptions->dfOYSizePct == 0.0) { const double dfOYSize = static_cast(nOXSize) * psOptions->srcWin.dfYSize / psOptions->srcWin.dfXSize + 0.5; if (dfOYSize < 1 || !GDALIsValueInRange(dfOYSize)) { CPLError(CE_Failure, CPLE_IllegalArg, "Invalid output height: %g", dfOYSize); return nullptr; } nOYSize = static_cast(dfOYSize); } } if (nOXSize <= 0 || nOYSize <= 0) { CPLError(CE_Failure, CPLE_IllegalArg, "Attempt to create %dx%d dataset is illegal.", nOXSize, nOYSize); return nullptr; } // Build overview dataset if -ovr is specified GDALDataset *poSrcOvrDS = nullptr; GDALDataset *poSrcDSOri = poSrcDS; const auto poFirstBand = poSrcDS->GetRasterBand(1); const int nOvCount = poFirstBand ? poFirstBand->GetOverviewCount() : 0; if (psOptions->nOvLevel < OVR_LEVEL_AUTO && poFirstBand && nOvCount > 0) { int iOvr = 0; for (; iOvr < nOvCount - 1; iOvr++) { if (poFirstBand->GetOverview(iOvr)->GetXSize() <= nOXSize) { break; } } iOvr += (psOptions->nOvLevel - OVR_LEVEL_AUTO); if (iOvr >= 0) { CPLDebug("GDAL", "Selecting overview level %d", iOvr); poSrcOvrDS = GDALCreateOverviewDataset(poSrcDS, iOvr, /* bThisLevelOnly = */ true); } } else if (psOptions->nOvLevel >= OVR_LEVEL_NONE) { poSrcOvrDS = GDALCreateOverviewDataset(poSrcDS, psOptions->nOvLevel, /* bThisLevelOnly = */ true); if (poSrcOvrDS == nullptr) { if (!psOptions->bQuiet) { if (nOvCount > 0) { CPLError(CE_Warning, CPLE_AppDefined, "Cannot get overview level %d. " "Defaulting to level %d.", psOptions->nOvLevel, nOvCount - 1); } else { CPLError(CE_Warning, CPLE_AppDefined, "Cannot get overview level %d. " "Defaulting to full resolution.", psOptions->nOvLevel); } } if (nOvCount > 0) poSrcOvrDS = GDALCreateOverviewDataset(poSrcDS, nOvCount - 1, /* bThisLevelOnly = */ true); } if (poSrcOvrDS && psOptions->dfXRes == 0.0 && !bOutsizeExplicitlySet) { const double dfRatioX = static_cast(poSrcDSOri->GetRasterXSize()) / poSrcOvrDS->GetRasterXSize(); const double dfRatioY = static_cast(poSrcDSOri->GetRasterYSize()) / poSrcOvrDS->GetRasterYSize(); nOXSize = std::max(1, static_cast(ceil(nOXSize / dfRatioX - 0.001))); nOYSize = std::max(1, static_cast(ceil(nOYSize / dfRatioY - 0.001))); } } if (poSrcOvrDS) poSrcDS = poSrcOvrDS; else poSrcDS->Reference(); // For gdal_translate_fuzzer if (psOptions->nLimitOutSize > 0) { vsi_l_offset nRawOutSize = static_cast(nOXSize) * nOYSize; if (psOptions->nBandCount) { if (nRawOutSize > std::numeric_limits::max() / psOptions->nBandCount) { poSrcDS->Release(); return nullptr; } nRawOutSize *= psOptions->nBandCount; const int nDTSize = GDALGetDataTypeSizeBytes( poSrcDS->GetRasterBand(1)->GetRasterDataType()); if (nDTSize > 0 && nRawOutSize > std::numeric_limits::max() / nDTSize) { poSrcDS->Release(); return nullptr; } nRawOutSize *= nDTSize; } if (nRawOutSize > static_cast(psOptions->nLimitOutSize)) { CPLError( CE_Failure, CPLE_IllegalArg, "Attempt to create %dx%d dataset is above authorized limit.", nOXSize, nOYSize); poSrcDS->Release(); return nullptr; } } /* ==================================================================== */ /* Create a virtual dataset. */ /* ==================================================================== */ /* -------------------------------------------------------------------- */ /* Make a virtual clone. */ /* -------------------------------------------------------------------- */ VRTDataset *poVDS = static_cast(VRTCreate(nOXSize, nOYSize)); if (psOptions->asGCPs.empty()) { if (psOptions->osOutputSRS == "null" || psOptions->osOutputSRS == "none") { poVDS->SetSpatialRef(nullptr); } else { OGRSpatialReference oSRS; if (!psOptions->osOutputSRS.empty()) { oSRS.SetFromUserInput(psOptions->osOutputSRS.c_str()); oSRS.SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER); } else { const OGRSpatialReference *poSrcSRS = poSrcDS->GetSpatialRef(); if (poSrcSRS) oSRS = *poSrcSRS; } if (!oSRS.IsEmpty()) { if (psOptions->dfOutputCoordinateEpoch > 0) oSRS.SetCoordinateEpoch(psOptions->dfOutputCoordinateEpoch); poVDS->SetSpatialRef(&oSRS); } } } bool bHasDstGeoTransform = false; GDALGeoTransform dstGT; if (bGotBounds) { bHasDstGeoTransform = true; dstGT[0] = psOptions->adfULLR[0]; dstGT[1] = (psOptions->adfULLR[2] - psOptions->adfULLR[0]) / nOXSize; dstGT[2] = 0.0; dstGT[3] = psOptions->adfULLR[1]; dstGT[4] = 0.0; dstGT[5] = (psOptions->adfULLR[3] - psOptions->adfULLR[1]) / nOYSize; poVDS->SetGeoTransform(dstGT); } else if (bGotGeoTransform) { bHasDstGeoTransform = true; poVDS->SetGeoTransform(psOptions->gt); } else if (bHasSrcGeoTransform && psOptions->asGCPs.empty()) { bHasDstGeoTransform = true; dstGT = srcGT; dstGT[0] += psOptions->srcWin.dfXOff * dstGT[1] + psOptions->srcWin.dfYOff * dstGT[2]; dstGT[3] += psOptions->srcWin.dfXOff * dstGT[4] + psOptions->srcWin.dfYOff * dstGT[5]; const double dfXRatio = psOptions->srcWin.dfXSize / nOXSize; const double dfYRatio = psOptions->srcWin.dfYSize / nOYSize; dstGT.Rescale(dfXRatio, dfYRatio); if (psOptions->dfXRes != 0.0) { dstGT[1] = psOptions->dfXRes; dstGT[5] = (dstGT[5] > 0) ? psOptions->dfYRes : -psOptions->dfYRes; } poVDS->SetGeoTransform(dstGT); } if (!psOptions->asGCPs.empty()) { OGRSpatialReference oSRS; if (psOptions->osOutputSRS == "null" || psOptions->osOutputSRS == "none") { // nothing to do } else if (!psOptions->osOutputSRS.empty()) { oSRS.SetFromUserInput(psOptions->osOutputSRS.c_str()); oSRS.SetAxisMappingStrategy(OAMS_TRADITIONAL_GIS_ORDER); } else { const OGRSpatialReference *poSrcSRS = poSrcDS->GetGCPSpatialRef(); if (poSrcSRS) oSRS = *poSrcSRS; } poVDS->SetGCPs(static_cast(psOptions->asGCPs.size()), gdal::GCP::c_ptr(psOptions->asGCPs), !oSRS.IsEmpty() ? &oSRS : nullptr); } else if (!psOptions->bNoGCP && poSrcDSOri->GetGCPCount() > 0) { const int nGCPs = poSrcDSOri->GetGCPCount(); GDAL_GCP *pasGCPs = GDALDuplicateGCPs(nGCPs, poSrcDSOri->GetGCPs()); for (int i = 0; i < nGCPs; i++) { pasGCPs[i].dfGCPPixel -= psOptions->srcWin.dfXOff; pasGCPs[i].dfGCPLine -= psOptions->srcWin.dfYOff; pasGCPs[i].dfGCPPixel *= nOXSize / static_cast(psOptions->srcWin.dfXSize); pasGCPs[i].dfGCPLine *= nOYSize / static_cast(psOptions->srcWin.dfYSize); } poVDS->SetGCPs(nGCPs, pasGCPs, poSrcDSOri->GetGCPSpatialRef()); GDALDeinitGCPs(nGCPs, pasGCPs); CPLFree(pasGCPs); } /* -------------------------------------------------------------------- */ /* To make the VRT to look less awkward (but this is optional */ /* in fact), avoid negative values. */ /* -------------------------------------------------------------------- */ GDALTranslateOptions::PixelLineWindow dstWin{ 0.0, 0.0, static_cast(nOXSize), static_cast(nOYSize)}; // When specifying -tr with non-nearest resampling, make sure that the // size of target window precisely matches the requested resolution, to // avoid any shift. if (bHasSrcGeoTransform && bHasDstGeoTransform && psOptions->dfXRes != 0.0 && !psOptions->osResampling.empty() && !EQUALN(psOptions->osResampling.c_str(), "NEAR", 4)) { dstWin.dfXSize = psOptions->srcWin.dfXSize * srcGT[1] / dstGT[1]; dstWin.dfYSize = psOptions->srcWin.dfYSize * fabs(srcGT[5] / dstGT[5]); } GDALTranslateOptions::PixelLineWindow srcWinOri(psOptions->srcWin); const double dfRatioX = poSrcDS->GetRasterXSize() == 0 ? 1.0 : static_cast(poSrcDSOri->GetRasterXSize()) / poSrcDS->GetRasterXSize(); const double dfRatioY = poSrcDS->GetRasterYSize() == 0 ? 1.0 : static_cast(poSrcDSOri->GetRasterYSize()) / poSrcDS->GetRasterYSize(); psOptions->srcWin.dfXOff /= dfRatioX; psOptions->srcWin.dfYOff /= dfRatioY; psOptions->srcWin.dfXSize /= dfRatioX; psOptions->srcWin.dfYSize /= dfRatioY; FixSrcDstWindow(psOptions->srcWin, dstWin, poSrcDS->GetRasterXSize(), poSrcDS->GetRasterYSize()); /* -------------------------------------------------------------------- */ /* Transfer generally applicable metadata. */ /* -------------------------------------------------------------------- */ char **papszMetadata = CSLDuplicate(poSrcDS->GetMetadata()); if (!psOptions->asScaleParams.empty() || psOptions->bUnscale || psOptions->eOutputType != GDT_Unknown) { /* Remove TIFFTAG_MINSAMPLEVALUE and TIFFTAG_MAXSAMPLEVALUE */ /* if the data range may change because of options */ char **papszIter = papszMetadata; while (papszIter && *papszIter) { if (STARTS_WITH_CI(*papszIter, "TIFFTAG_MINSAMPLEVALUE=") || STARTS_WITH_CI(*papszIter, "TIFFTAG_MAXSAMPLEVALUE=")) { CPLFree(*papszIter); memmove(papszIter, papszIter + 1, sizeof(char *) * (CSLCount(papszIter + 1) + 1)); } else papszIter++; } } // Remove NITF_BLOCKA_ stuff if georeferencing is changed if (!(psOptions->srcWin.dfXOff == 0 && psOptions->srcWin.dfYOff == 0 && psOptions->srcWin.dfXSize == poSrcDS->GetRasterXSize() && psOptions->srcWin.dfYSize == poSrcDS->GetRasterYSize() && psOptions->asGCPs.empty() && !bGotBounds && !bGotGeoTransform)) { char **papszIter = papszMetadata; while (papszIter && *papszIter) { if (STARTS_WITH_CI(*papszIter, "NITF_BLOCKA_")) { CPLFree(*papszIter); memmove(papszIter, papszIter + 1, sizeof(char *) * (CSLCount(papszIter + 1) + 1)); } else papszIter++; } } { char **papszIter = papszMetadata; while (papszIter && *papszIter) { // Do not preserve the CACHE_PATH from the WMS driver if (STARTS_WITH_CI(*papszIter, "CACHE_PATH=")) { CPLFree(*papszIter); memmove(papszIter, papszIter + 1, sizeof(char *) * (CSLCount(papszIter + 1) + 1)); } else papszIter++; } } if (CSLFetchNameValue(papszMetadata, "NODATA_VALUES") && !(bAllBandsInOrder && psOptions->nBandCount == poSrcDS->GetRasterCount())) { papszMetadata = CSLSetNameValue(papszMetadata, "NODATA_VALUES", nullptr); } poVDS->SetMetadata(papszMetadata); CSLDestroy(papszMetadata); AttachMetadata(GDALDataset::ToHandle(poVDS), psOptions->aosMetadataOptions); AttachDomainMetadata(GDALDataset::ToHandle(poVDS), psOptions->aosDomainMetadataOptions); const char *pszInterleave = poSrcDS->GetMetadataItem("INTERLEAVE", "IMAGE_STRUCTURE"); if (pszInterleave) poVDS->SetMetadataItem("INTERLEAVE", pszInterleave, "IMAGE_STRUCTURE"); { const char *pszCompression = poSrcDS->GetMetadataItem("COMPRESSION", "IMAGE_STRUCTURE"); if (pszCompression) { poVDS->SetMetadataItem("COMPRESSION", pszCompression, "IMAGE_STRUCTURE"); } } /* ISIS3 metadata preservation */ char **papszMD_ISIS3 = poSrcDS->GetMetadata("json:ISIS3"); if (papszMD_ISIS3 != nullptr && papszMD_ISIS3[0]) { std::string osJSON = papszMD_ISIS3[0]; if (!bAllBandsInOrder) { osJSON = EditISIS3MetadataForBandChange( osJSON.c_str(), poSrcDS->GetRasterCount(), psOptions.get()); } if (!bSpatialArrangementPreserved || bValuesChanged) { osJSON = EditISIS3ForMetadataChanges( osJSON.c_str(), bKeepExtent, bKeepResolution, psOptions.get()); } if (!osJSON.empty()) { char *apszMD[] = {osJSON.data(), nullptr}; poVDS->SetMetadata(apszMD, "json:ISIS3"); } } // PDS4 -> PDS4 special case if (EQUAL(psOptions->osFormat.c_str(), "PDS4")) { char **papszMD_PDS4 = poSrcDS->GetMetadata("xml:PDS4"); if (papszMD_PDS4 != nullptr) poVDS->SetMetadata(papszMD_PDS4, "xml:PDS4"); } // VICAR -> VICAR special case if (EQUAL(psOptions->osFormat.c_str(), "VICAR")) { char **papszMD_VICAR = poSrcDS->GetMetadata("json:VICAR"); if (papszMD_VICAR != nullptr) poVDS->SetMetadata(papszMD_VICAR, "json:VICAR"); } // Copy XMP metadata if (!psOptions->bNoXMP) { char **papszXMP = poSrcDS->GetMetadata("xml:XMP"); if (papszXMP != nullptr && *papszXMP != nullptr) { poVDS->SetMetadata(papszXMP, "xml:XMP"); } } /* -------------------------------------------------------------------- */ /* Transfer metadata that remains valid if the spatial */ /* arrangement of the data is unaltered. */ /* -------------------------------------------------------------------- */ if (bSpatialArrangementPreserved) { char **papszMD = poSrcDS->GetMetadata("RPC"); if (papszMD != nullptr) poVDS->SetMetadata(papszMD, "RPC"); papszMD = poSrcDS->GetMetadata("GEOLOCATION"); if (papszMD != nullptr) poVDS->SetMetadata(papszMD, "GEOLOCATION"); } else { char **papszMD = poSrcDSOri->GetMetadata("RPC"); if (papszMD != nullptr) { papszMD = CSLDuplicate(papszMD); double dfSAMP_OFF = CPLAtof(CSLFetchNameValueDef(papszMD, "SAMP_OFF", "0")); double dfLINE_OFF = CPLAtof(CSLFetchNameValueDef(papszMD, "LINE_OFF", "0")); double dfSAMP_SCALE = CPLAtof(CSLFetchNameValueDef(papszMD, "SAMP_SCALE", "1")); double dfLINE_SCALE = CPLAtof(CSLFetchNameValueDef(papszMD, "LINE_SCALE", "1")); dfSAMP_OFF -= srcWinOri.dfXOff; dfLINE_OFF -= srcWinOri.dfYOff; const double df2 = srcWinOri.dfXSize; const double df3 = srcWinOri.dfYSize; const double dfXRatio = nOXSize / df2; const double dfYRatio = nOYSize / df3; // For line offset and pixel offset, we need to convert from RPC // pixel center registration convention to GDAL pixel top-left corner // registration convention by adding an initial 0.5 shift, and un-apply // it after scaling. dfSAMP_OFF += 0.5; dfSAMP_OFF *= dfXRatio; dfSAMP_OFF -= 0.5; dfLINE_OFF += 0.5; dfLINE_OFF *= dfYRatio; dfLINE_OFF -= 0.5; dfSAMP_SCALE *= dfXRatio; dfLINE_SCALE *= dfYRatio; CPLString osField; osField.Printf("%.15g", dfLINE_OFF); papszMD = CSLSetNameValue(papszMD, "LINE_OFF", osField); osField.Printf("%.15g", dfSAMP_OFF); papszMD = CSLSetNameValue(papszMD, "SAMP_OFF", osField); osField.Printf("%.15g", dfLINE_SCALE); papszMD = CSLSetNameValue(papszMD, "LINE_SCALE", osField); osField.Printf("%.15g", dfSAMP_SCALE); papszMD = CSLSetNameValue(papszMD, "SAMP_SCALE", osField); poVDS->SetMetadata(papszMD, "RPC"); CSLDestroy(papszMD); } } const int nSrcBandCount = psOptions->nBandCount; if (psOptions->nRGBExpand != 0) { GDALRasterBand *poSrcBand = poSrcDS->GetRasterBand(std::abs(psOptions->anBandList[0])); if (psOptions->anBandList[0] < 0) poSrcBand = poSrcBand->GetMaskBand(); GDALColorTable *poColorTable = poSrcBand->GetColorTable(); if (poColorTable == nullptr) { CPLError(CE_Failure, CPLE_AppDefined, "Error : band %d has no color table", std::abs(psOptions->anBandList[0])); GDALClose(poVDS); return nullptr; } /* Check that the color table only contains gray levels */ /* when using -expand gray */ if (psOptions->nRGBExpand == 1) { int nColorCount = poColorTable->GetColorEntryCount(); for (int nColor = 0; nColor < nColorCount; nColor++) { const GDALColorEntry *poEntry = poColorTable->GetColorEntry(nColor); if (poEntry->c1 != poEntry->c2 || poEntry->c1 != poEntry->c3) { CPLError(CE_Warning, CPLE_AppDefined, "Warning : color table contains non gray levels " "colors"); break; } } } if (psOptions->nBandCount == 1) { psOptions->nBandCount = psOptions->nRGBExpand; } else if (psOptions->nBandCount == 2 && (psOptions->nRGBExpand == 3 || psOptions->nRGBExpand == 4)) { psOptions->nBandCount = psOptions->nRGBExpand; } else { CPLError(CE_Failure, CPLE_IllegalArg, "Error : invalid use of -expand option."); GDALClose(poVDS); return nullptr; } } // Can be set to TRUE in the band loop too bool bFilterOutStatsMetadata = bValuesChanged || !bSpatialArrangementPreserved || psOptions->nRGBExpand != 0; if (static_cast(psOptions->anColorInterp.size()) > psOptions->nBandCount) { CPLError(CE_Warning, CPLE_AppDefined, "More bands defined in -colorinterp than output bands"); } /* ==================================================================== */ /* Process all bands. */ /* ==================================================================== */ GDALDataType eOutputType = psOptions->eOutputType; for (int i = 0; i < psOptions->nBandCount; i++) { int nComponent = 0; int nSrcBand = 0; if (psOptions->nRGBExpand != 0) { if (nSrcBandCount == 2 && psOptions->nRGBExpand == 4 && i == 3) nSrcBand = psOptions->anBandList[1]; else { nSrcBand = psOptions->anBandList[0]; nComponent = i + 1; } } else { nSrcBand = psOptions->anBandList[i]; } GDALRasterBand *poSrcBand = poSrcDS->GetRasterBand(std::abs(nSrcBand)); /* -------------------------------------------------------------------- */ /* Select output data type to match source. */ /* -------------------------------------------------------------------- */ GDALRasterBand *poRealSrcBand = (nSrcBand < 0) ? poSrcBand->GetMaskBand() : poSrcBand; GDALDataType eBandType; if (eOutputType == GDT_Unknown) { eBandType = poRealSrcBand->GetRasterDataType(); if (eBandType != GDT_Byte && psOptions->nRGBExpand != 0) { // Use case of https://github.com/OSGeo/gdal/issues/9402 if (const auto poColorTable = poRealSrcBand->GetColorTable()) { bool bIn0To255Range = true; const int nColorCount = poColorTable->GetColorEntryCount(); for (int nColor = 0; nColor < nColorCount; nColor++) { const GDALColorEntry *poEntry = poColorTable->GetColorEntry(nColor); if (poEntry->c1 > 255 || poEntry->c2 > 255 || poEntry->c3 > 255 || poEntry->c4 > 255) { bIn0To255Range = false; break; } } if (bIn0To255Range) { if (!psOptions->bQuiet) { CPLError(CE_Warning, CPLE_AppDefined, "Using Byte output data type due to range " "of values in color table"); } eBandType = GDT_Byte; } } eOutputType = eBandType; } } else { eBandType = eOutputType; // Check that we can copy existing statistics GDALDataType eSrcBandType = poRealSrcBand->GetRasterDataType(); const char *pszMin = poRealSrcBand->GetMetadataItem("STATISTICS_MINIMUM"); const char *pszMax = poRealSrcBand->GetMetadataItem("STATISTICS_MAXIMUM"); if (!bFilterOutStatsMetadata && eBandType != eSrcBandType && pszMin != nullptr && pszMax != nullptr) { const bool bSrcIsInteger = CPL_TO_BOOL(GDALDataTypeIsInteger(eSrcBandType) && !GDALDataTypeIsComplex(eSrcBandType)); const bool bDstIsInteger = CPL_TO_BOOL(GDALDataTypeIsInteger(eBandType) && !GDALDataTypeIsComplex(eBandType)); if (bSrcIsInteger && bDstIsInteger) { std::int64_t nDstMin = 0; std::uint64_t nDstMax = 0; switch (eBandType) { case GDT_Byte: nDstMin = std::numeric_limits::min(); nDstMax = std::numeric_limits::max(); break; case GDT_Int8: nDstMin = std::numeric_limits::min(); nDstMax = std::numeric_limits::max(); break; case GDT_UInt16: nDstMin = std::numeric_limits::min(); nDstMax = std::numeric_limits::max(); break; case GDT_Int16: nDstMin = std::numeric_limits::min(); nDstMax = std::numeric_limits::max(); break; case GDT_UInt32: nDstMin = std::numeric_limits::min(); nDstMax = std::numeric_limits::max(); break; case GDT_Int32: nDstMin = std::numeric_limits::min(); nDstMax = std::numeric_limits::max(); break; case GDT_UInt64: nDstMin = std::numeric_limits::min(); nDstMax = std::numeric_limits::max(); break; case GDT_Int64: nDstMin = std::numeric_limits::min(); nDstMax = std::numeric_limits::max(); break; default: CPLAssert(false); break; } try { const auto nMin = std::stoll(pszMin); const auto nMax = std::stoull(pszMax); if (nMin < nDstMin || nMax > nDstMax) bFilterOutStatsMetadata = true; } catch (const std::exception &) { } } // Float64 is large enough to hold all integer <= 32 bit or // float32 values there might be other OK cases, but ere on safe // side for now else if (!((bSrcIsInteger || eSrcBandType == GDT_Float32) && eBandType == GDT_Float64)) { bFilterOutStatsMetadata = true; } } } /* -------------------------------------------------------------------- */ /* Create this band. */ /* -------------------------------------------------------------------- */ CPLStringList aosAddBandOptions; int nSrcBlockXSize, nSrcBlockYSize; poSrcBand->GetBlockSize(&nSrcBlockXSize, &nSrcBlockYSize); if (bKeepResolution && (fmod(psOptions->srcWin.dfXOff, nSrcBlockXSize)) == 0 && (fmod(psOptions->srcWin.dfYOff, nSrcBlockYSize)) == 0) { aosAddBandOptions.SetNameValue("BLOCKXSIZE", CPLSPrintf("%d", nSrcBlockXSize)); aosAddBandOptions.SetNameValue("BLOCKYSIZE", CPLSPrintf("%d", nSrcBlockYSize)); } const char *pszBlockXSize = psOptions->aosCreateOptions.FetchNameValue("BLOCKXSIZE"); if (pszBlockXSize) aosAddBandOptions.SetNameValue("BLOCKXSIZE", pszBlockXSize); const char *pszBlockYSize = psOptions->aosCreateOptions.FetchNameValue("BLOCKYSIZE"); if (pszBlockYSize) aosAddBandOptions.SetNameValue("BLOCKYSIZE", pszBlockYSize); poVDS->AddBand(eBandType, aosAddBandOptions.List()); VRTSourcedRasterBand *poVRTBand = static_cast(poVDS->GetRasterBand(i + 1)); if (nSrcBand < 0) { poVRTBand->AddMaskBandSource( poSrcBand, psOptions->srcWin.dfXOff, psOptions->srcWin.dfYOff, psOptions->srcWin.dfXSize, psOptions->srcWin.dfYSize, dstWin.dfXOff, dstWin.dfYOff, dstWin.dfXSize, dstWin.dfYSize); poVRTBand->SetColorInterpretation(GCI_AlphaBand); // Color interpretation override if (!psOptions->anColorInterp.empty()) { if (i < static_cast(psOptions->anColorInterp.size()) && psOptions->anColorInterp[i] >= 0) { poVRTBand->SetColorInterpretation( static_cast( psOptions->anColorInterp[i])); } } continue; } // Preserve NBITS if no option change values const char *pszNBits = poSrcBand->GetMetadataItem("NBITS", "IMAGE_STRUCTURE"); if (pszNBits && psOptions->nRGBExpand == 0 && psOptions->asScaleParams.empty() && !psOptions->bUnscale && psOptions->eOutputType == GDT_Unknown && psOptions->osResampling.empty()) { poVRTBand->SetMetadataItem("NBITS", pszNBits, "IMAGE_STRUCTURE"); } // Preserve PIXELTYPE if no option change values if (poSrcBand->GetRasterDataType() == GDT_Byte && psOptions->nRGBExpand == 0 && psOptions->asScaleParams.empty() && !psOptions->bUnscale && psOptions->eOutputType == GDT_Unknown && psOptions->osResampling.empty()) { poSrcBand->EnablePixelTypeSignedByteWarning(false); const char *pszPixelType = poSrcBand->GetMetadataItem("PIXELTYPE", "IMAGE_STRUCTURE"); poSrcBand->EnablePixelTypeSignedByteWarning(true); if (pszPixelType) { poVRTBand->SetMetadataItem("PIXELTYPE", pszPixelType, "IMAGE_STRUCTURE"); } } const char *pszCompression = poSrcBand->GetMetadataItem("COMPRESSION", "IMAGE_STRUCTURE"); if (pszCompression) { poVRTBand->SetMetadataItem("COMPRESSION", pszCompression, "IMAGE_STRUCTURE"); } /* -------------------------------------------------------------------- */ /* Do we need to collect scaling information? */ /* -------------------------------------------------------------------- */ double dfScale = 1.0; double dfOffset = 0.0; bool bScale = false; double dfScaleSrcMin = std::numeric_limits::quiet_NaN(); double dfScaleSrcMax = std::numeric_limits::quiet_NaN(); double dfScaleDstMin = std::numeric_limits::quiet_NaN(); double dfScaleDstMax = std::numeric_limits::quiet_NaN(); bool bExponentScaling = false; double dfExponent = 0.0; if (i < static_cast(psOptions->asScaleParams.size()) && psOptions->asScaleParams[i].bScale) { bScale = psOptions->asScaleParams[i].bScale; dfScaleSrcMin = psOptions->asScaleParams[i].dfScaleSrcMin; dfScaleSrcMax = psOptions->asScaleParams[i].dfScaleSrcMax; dfScaleDstMin = psOptions->asScaleParams[i].dfScaleDstMin; dfScaleDstMax = psOptions->asScaleParams[i].dfScaleDstMax; } else if (psOptions->asScaleParams.size() == 1 && !psOptions->bHasUsedExplicitScaleBand) { bScale = psOptions->asScaleParams[0].bScale; dfScaleSrcMin = psOptions->asScaleParams[0].dfScaleSrcMin; dfScaleSrcMax = psOptions->asScaleParams[0].dfScaleSrcMax; dfScaleDstMin = psOptions->asScaleParams[0].dfScaleDstMin; dfScaleDstMax = psOptions->asScaleParams[0].dfScaleDstMax; } if (i < static_cast(psOptions->adfExponent.size()) && psOptions->adfExponent[i] != 0.0) { bExponentScaling = TRUE; dfExponent = psOptions->adfExponent[i]; } else if (psOptions->adfExponent.size() == 1 && !psOptions->bHasUsedExplicitExponentBand) { bExponentScaling = TRUE; dfExponent = psOptions->adfExponent[0]; } if (bExponentScaling && !bScale) { CPLError(CE_Failure, CPLE_IllegalArg, "For band %d, -scale should be specified when -exponent " "is specified.", i + 1); if (pbUsageError) *pbUsageError = TRUE; delete poVDS; poSrcDS->Release(); return nullptr; } if (bScale && std::isnan(dfScaleSrcMin)) { double adfCMinMax[2] = {}; GDALComputeRasterMinMax(poSrcBand, TRUE, adfCMinMax); dfScaleSrcMin = adfCMinMax[0]; dfScaleSrcMax = adfCMinMax[1]; } if (bScale) { /* To avoid a divide by zero */ if (dfScaleSrcMax == dfScaleSrcMin) dfScaleSrcMax += 0.1; // Can still occur for very big values if (dfScaleSrcMax == dfScaleSrcMin) { CPLError(CE_Failure, CPLE_AppDefined, "-scale cannot be applied due to source " "minimum and maximum being equal"); delete poVDS; poSrcDS->Release(); return nullptr; } if (std::isnan(dfScaleDstMin)) { switch (poVRTBand->GetRasterDataType()) { case GDT_Byte: dfScaleDstMin = std::numeric_limits::lowest(); dfScaleDstMax = std::numeric_limits::max(); break; case GDT_Int8: dfScaleDstMin = std::numeric_limits::lowest(); dfScaleDstMax = std::numeric_limits::max(); break; case GDT_UInt16: dfScaleDstMin = std::numeric_limits::lowest(); dfScaleDstMax = std::numeric_limits::max(); break; case GDT_Int16: case GDT_CInt16: dfScaleDstMin = std::numeric_limits::lowest(); dfScaleDstMax = std::numeric_limits::max(); break; case GDT_UInt32: dfScaleDstMin = std::numeric_limits::lowest(); dfScaleDstMax = std::numeric_limits::max(); break; case GDT_Int32: case GDT_CInt32: dfScaleDstMin = std::numeric_limits::lowest(); dfScaleDstMax = std::numeric_limits::max(); break; case GDT_UInt64: dfScaleDstMin = static_cast( std::numeric_limits::lowest()); dfScaleDstMax = static_cast( std::numeric_limits::max() - 2048); break; case GDT_Int64: dfScaleDstMin = static_cast( std::numeric_limits::lowest() + 1024); dfScaleDstMax = static_cast( std::numeric_limits::max() - 2048); break; case GDT_Float16: case GDT_Float32: case GDT_Float64: case GDT_CFloat16: case GDT_CFloat32: case GDT_CFloat64: case GDT_Unknown: case GDT_TypeCount: dfScaleDstMin = 0; dfScaleDstMax = 1; break; } } if (!bExponentScaling) { dfScale = (dfScaleDstMax - dfScaleDstMin) / (dfScaleSrcMax - dfScaleSrcMin); dfOffset = -1 * dfScaleSrcMin * dfScale + dfScaleDstMin; } } if (psOptions->bUnscale) { dfScale = poSrcBand->GetScale(); dfOffset = poSrcBand->GetOffset(); } /* -------------------------------------------------------------------- */ /* Create a simple or complex data source depending on the */ /* translation type required. */ /* -------------------------------------------------------------------- */ std::unique_ptr poSimpleSource; if (psOptions->bUnscale || bScale || (psOptions->nRGBExpand != 0 && i < psOptions->nRGBExpand)) { auto poComplexSource = std::make_unique(); /* -------------------------------------------------------------------- */ /* Set complex parameters. */ /* -------------------------------------------------------------------- */ if (dfOffset != 0.0 || dfScale != 1.0) { poComplexSource->SetLinearScaling(dfOffset, dfScale); } else if (bExponentScaling) { poComplexSource->SetPowerScaling( dfExponent, dfScaleSrcMin, dfScaleSrcMax, dfScaleDstMin, dfScaleDstMax, !psOptions->bNoClip); } poComplexSource->SetColorTableComponent(nComponent); int bSuccess; double dfNoData = poSrcBand->GetNoDataValue(&bSuccess); if (bSuccess) { poComplexSource->SetNoDataValue(dfNoData); } poSimpleSource = std::move(poComplexSource); } else { poSimpleSource = std::make_unique(); } poSimpleSource->SetResampling(psOptions->osResampling.empty() ? nullptr : psOptions->osResampling.c_str()); poVRTBand->ConfigureSource( poSimpleSource.get(), poSrcBand, FALSE, psOptions->srcWin.dfXOff, psOptions->srcWin.dfYOff, psOptions->srcWin.dfXSize, psOptions->srcWin.dfYSize, dstWin.dfXOff, dstWin.dfYOff, dstWin.dfXSize, dstWin.dfYSize); poVRTBand->AddSource(std::move(poSimpleSource)); /* -------------------------------------------------------------------- */ /* In case of color table translate, we only set the color */ /* interpretation other info copied by CopyBandInfo are */ /* not relevant in RGB expansion. */ /* -------------------------------------------------------------------- */ if (psOptions->nRGBExpand == 1) { poVRTBand->SetColorInterpretation(GCI_GrayIndex); } else if (psOptions->nRGBExpand != 0 && i < psOptions->nRGBExpand) { poVRTBand->SetColorInterpretation( static_cast(GCI_RedBand + i)); } /* -------------------------------------------------------------------- */ /* copy over some other information of interest. */ /* -------------------------------------------------------------------- */ else { CopyBandInfo(poSrcBand, poVRTBand, !psOptions->bStats && !bFilterOutStatsMetadata, !psOptions->bUnscale && !psOptions->bSetScale && !psOptions->bSetOffset, !psOptions->bSetNoData && !psOptions->bUnsetNoData, !psOptions->bNoRAT, psOptions.get()); if (psOptions->asScaleParams.empty() && psOptions->adfExponent.empty() && EQUAL(psOptions->osFormat.c_str(), "GRIB")) { char **papszMD_GRIB = poSrcBand->GetMetadata("GRIB"); if (papszMD_GRIB != nullptr) poVRTBand->SetMetadata(papszMD_GRIB, "GRIB"); } } // Color interpretation override if (!psOptions->anColorInterp.empty()) { if (i < static_cast(psOptions->anColorInterp.size()) && psOptions->anColorInterp[i] >= 0) { poVRTBand->SetColorInterpretation( static_cast(psOptions->anColorInterp[i])); } } /* -------------------------------------------------------------------- */ /* Set a forcible nodata value? */ /* -------------------------------------------------------------------- */ if (psOptions->bSetNoData) { const char *pszPixelType = psOptions->aosCreateOptions.FetchNameValue("PIXELTYPE"); if (pszPixelType == nullptr && poVRTBand->GetRasterDataType() == GDT_Byte) { poVRTBand->EnablePixelTypeSignedByteWarning(false); pszPixelType = poVRTBand->GetMetadataItem("PIXELTYPE", "IMAGE_STRUCTURE"); poVRTBand->EnablePixelTypeSignedByteWarning(true); } bool bCannotBeExactlyRepresented = false; if (pszPixelType != nullptr && EQUAL(pszPixelType, "SIGNEDBYTE")) { char *endptr = nullptr; const double dfVal = CPLStrtod(psOptions->osNoData.c_str(), &endptr); if (endptr == psOptions->osNoData.c_str() + psOptions->osNoData.size() && dfVal >= -128.0 && dfVal <= 127.0 && static_cast(dfVal) == dfVal) { poVRTBand->SetNoDataValue(dfVal); } else { bCannotBeExactlyRepresented = true; } } else { poVRTBand->SetNoDataValueAsString(psOptions->osNoData.c_str(), &bCannotBeExactlyRepresented); } if (bCannotBeExactlyRepresented) { CPLError(CE_Warning, CPLE_AppDefined, "Nodata value was not set to output band, " "as it cannot be represented on its data type."); } } if (psOptions->bSetScale) poVRTBand->SetScale(psOptions->dfScale); if (psOptions->bSetOffset) poVRTBand->SetOffset(psOptions->dfOffset); if (psOptions->eMaskMode == MASK_AUTO && (poSrcDS->GetRasterBand(1)->GetMaskFlags() & GMF_PER_DATASET) == 0 && (poSrcBand->GetMaskFlags() & (GMF_ALL_VALID | GMF_NODATA)) == 0) { if (poVRTBand->CreateMaskBand(poSrcBand->GetMaskFlags()) == CE_None) { VRTSourcedRasterBand *hMaskVRTBand = cpl::down_cast( poVRTBand->GetMaskBand()); hMaskVRTBand->AddMaskBandSource( poSrcBand, psOptions->srcWin.dfXOff, psOptions->srcWin.dfYOff, psOptions->srcWin.dfXSize, psOptions->srcWin.dfYSize, dstWin.dfXOff, dstWin.dfYOff, dstWin.dfXSize, dstWin.dfYSize); } } } if (psOptions->eMaskMode == MASK_USER) { GDALRasterBand *poSrcBand = poSrcDS->GetRasterBand(std::abs(psOptions->nMaskBand)); if (poSrcBand && poVDS->CreateMaskBand(GMF_PER_DATASET) == CE_None) { VRTSourcedRasterBand *hMaskVRTBand = static_cast(GDALGetMaskBand( GDALGetRasterBand(static_cast(poVDS), 1))); if (psOptions->nMaskBand > 0) hMaskVRTBand->AddSimpleSource( poSrcBand, psOptions->srcWin.dfXOff, psOptions->srcWin.dfYOff, psOptions->srcWin.dfXSize, psOptions->srcWin.dfYSize, dstWin.dfXOff, dstWin.dfYOff, dstWin.dfXSize, dstWin.dfYSize); else hMaskVRTBand->AddMaskBandSource( poSrcBand, psOptions->srcWin.dfXOff, psOptions->srcWin.dfYOff, psOptions->srcWin.dfXSize, psOptions->srcWin.dfYSize, dstWin.dfXOff, dstWin.dfYOff, dstWin.dfXSize, dstWin.dfYSize); } } else if (psOptions->eMaskMode == MASK_AUTO && nSrcBandCount > 0 && poSrcDS->GetRasterBand(1)->GetMaskFlags() == GMF_PER_DATASET) { if (poVDS->CreateMaskBand(GMF_PER_DATASET) == CE_None) { VRTSourcedRasterBand *hMaskVRTBand = static_cast(GDALGetMaskBand( GDALGetRasterBand(static_cast(poVDS), 1))); hMaskVRTBand->AddMaskBandSource( poSrcDS->GetRasterBand(1), psOptions->srcWin.dfXOff, psOptions->srcWin.dfYOff, psOptions->srcWin.dfXSize, psOptions->srcWin.dfYSize, dstWin.dfXOff, dstWin.dfYOff, dstWin.dfXSize, dstWin.dfYSize); } } /* -------------------------------------------------------------------- */ /* Compute stats if required. */ /* -------------------------------------------------------------------- */ if (psOptions->bStats && EQUAL(psOptions->osFormat.c_str(), "COG")) { psOptions->aosCreateOptions.SetNameValue("STATISTICS", "YES"); } else if (psOptions->bStats) { for (int i = 0; i < poVDS->GetRasterCount(); i++) { double dfMin, dfMax, dfMean, dfStdDev; poVDS->GetRasterBand(i + 1)->ComputeStatistics( psOptions->bApproxStats, &dfMin, &dfMax, &dfMean, &dfStdDev, GDALDummyProgress, nullptr); } } /* -------------------------------------------------------------------- */ /* Write to the output file using CopyCreate(). */ /* -------------------------------------------------------------------- */ if (EQUAL(psOptions->osFormat.c_str(), "VRT") && (psOptions->aosCreateOptions.empty() || (psOptions->aosCreateOptions.size() == 1 && psOptions->aosCreateOptions.FetchNameValue("BLOCKXSIZE")) || (psOptions->aosCreateOptions.size() == 1 && psOptions->aosCreateOptions.FetchNameValue("BLOCKYSIZE")) || (psOptions->aosCreateOptions.size() == 2 && psOptions->aosCreateOptions.FetchNameValue("BLOCKXSIZE") && psOptions->aosCreateOptions.FetchNameValue("BLOCKYSIZE")))) { poVDS->SetDescription(pszDest); hOutDS = GDALDataset::ToHandle(poVDS); if (!EQUAL(pszDest, "")) { hOutDS = GDALTranslateFlush(hOutDS); } } else { hOutDS = GDALCreateCopy( hDriver, pszDest, GDALDataset::ToHandle(poVDS), psOptions->bStrict, psOptions->aosCreateOptions.List(), psOptions->pfnProgress, psOptions->pProgressData); hOutDS = GDALTranslateFlush(hOutDS); GDALClose(poVDS); } poSrcDS->Release(); return hOutDS; } /************************************************************************/ /* AttachMetadata() */ /************************************************************************/ static void AttachMetadata(GDALDatasetH hDS, const CPLStringList &aosMetadataOptions) { for (const auto &[pszKey, pszValue] : cpl::IterateNameValue(aosMetadataOptions)) { GDALSetMetadataItem(hDS, pszKey, pszValue, nullptr); } } /************************************************************************/ /* AttachDomainMetadata() */ /************************************************************************/ static void AttachDomainMetadata(GDALDatasetH hDS, const CPLStringList &aosDomainMetadataOptions) { for (const char *pszStr : aosDomainMetadataOptions) { char *pszKey = nullptr; char *pszDomain = nullptr; // parse the DOMAIN:KEY=value, Remainder is KEY=value const char *pszRemainder = CPLParseNameValueSep(pszStr, &pszDomain, ':'); if (pszDomain && pszRemainder) { const char *pszValue = CPLParseNameValueSep(pszRemainder, &pszKey, '='); if (pszKey && pszValue) { GDALSetMetadataItem(hDS, pszKey, pszValue, pszDomain); } } CPLFree(pszKey); CPLFree(pszDomain); } } /************************************************************************/ /* CopyBandInfo() */ /************************************************************************/ /* A bit of a clone of VRTRasterBand::CopyCommonInfoFrom(), but we need */ /* more and more custom behavior in the context of gdal_translate ... */ static void CopyBandInfo(GDALRasterBand *poSrcBand, GDALRasterBand *poDstBand, int bCanCopyStatsMetadata, int bCopyScale, int bCopyNoData, bool bCopyRAT, const GDALTranslateOptions * /*psOptions*/) { if (bCanCopyStatsMetadata) { poDstBand->SetMetadata(poSrcBand->GetMetadata()); if (bCopyRAT) { poDstBand->SetDefaultRAT(poSrcBand->GetDefaultRAT()); } } else { char **papszMetadata = poSrcBand->GetMetadata(); char **papszMetadataNew = nullptr; for (int i = 0; papszMetadata != nullptr && papszMetadata[i] != nullptr; i++) { if (!STARTS_WITH(papszMetadata[i], "STATISTICS_")) papszMetadataNew = CSLAddString(papszMetadataNew, papszMetadata[i]); } poDstBand->SetMetadata(papszMetadataNew); CSLDestroy(papszMetadataNew); // we need to strip histogram data from the source RAT if (poSrcBand->GetDefaultRAT() && bCopyRAT) { GDALRasterAttributeTable *poNewRAT = poSrcBand->GetDefaultRAT()->Clone(); // strip histogram data (as defined by the source RAT) poNewRAT->RemoveStatistics(); if (poNewRAT->GetColumnCount()) { poDstBand->SetDefaultRAT(poNewRAT); } // since SetDefaultRAT copies the RAT data we need to delete our // original delete poNewRAT; } } poDstBand->SetColorTable(poSrcBand->GetColorTable()); poDstBand->SetColorInterpretation(poSrcBand->GetColorInterpretation()); if (strlen(poSrcBand->GetDescription()) > 0) poDstBand->SetDescription(poSrcBand->GetDescription()); if (bCopyNoData) { int bSuccess = FALSE; CPL_IGNORE_RET_VAL(poSrcBand->GetNoDataValue(&bSuccess)); if (bSuccess) { bool bCannotBeExactlyRepresented = false; if (!GDALCopyNoDataValue(poDstBand, poSrcBand, &bCannotBeExactlyRepresented) && bCannotBeExactlyRepresented) { CPLError(CE_Warning, CPLE_AppDefined, "Source nodata value was not copied to output band, " "as it cannot be represented on its data type."); } } } if (bCopyScale) { poDstBand->SetOffset(poSrcBand->GetOffset()); poDstBand->SetScale(poSrcBand->GetScale()); } poDstBand->SetCategoryNames(poSrcBand->GetCategoryNames()); // Copy unit only if the range of pixel values is not modified if (bCanCopyStatsMetadata && bCopyScale && !EQUAL(poSrcBand->GetUnitType(), "")) poDstBand->SetUnitType(poSrcBand->GetUnitType()); } /************************************************************************/ /* GetColorInterp() */ /************************************************************************/ static int GetColorInterp(const char *pszStr) { if (EQUAL(pszStr, "undefined")) return GCI_Undefined; const int eInterp = GDALGetColorInterpretationByName(pszStr); if (eInterp != GCI_Undefined) return eInterp; CPLError(CE_Warning, CPLE_NotSupported, "Unsupported color interpretation: %s", pszStr); return -1; } /************************************************************************/ /* GDALTranslateOptionsGetParser() */ /************************************************************************/ static std::unique_ptr GDALTranslateOptionsGetParser(GDALTranslateOptions *psOptions, GDALTranslateOptionsForBinary *psOptionsForBinary) { auto argParser = std::make_unique( "gdal_translate", /* bForBinary=*/psOptionsForBinary != nullptr); argParser->add_description( _("Convert raster data between different formats, with potential " "subsetting, resampling, and rescaling pixels in the process.")); argParser->add_epilog(_("For more details, consult " "https://gdal.org/programs/gdal_translate.html")); argParser->add_output_type_argument(psOptions->eOutputType); argParser->add_argument("-if") .append() .metavar("") .action( [psOptionsForBinary](const std::string &s) { if (psOptionsForBinary) { if (GDALGetDriverByName(s.c_str()) == nullptr) { CPLError(CE_Warning, CPLE_AppDefined, "%s is not a recognized driver", s.c_str()); } psOptionsForBinary->aosAllowedInputDrivers.AddString( s.c_str()); } }) .help(_("Format/driver name(s) to try when opening the input file.")); argParser->add_output_format_argument(psOptions->osFormat); argParser->add_quiet_argument(&(psOptions->bQuiet)); argParser->add_argument("-b") .append() .metavar("") .action( [psOptions](const std::string &s) { const char *pszBand = s.c_str(); bool bMask = false; if (EQUAL(pszBand, "mask")) pszBand = "mask,1"; if (STARTS_WITH_CI(pszBand, "mask,")) { bMask = true; pszBand += 5; /* If we use the source mask band as a regular band */ /* don't create a target mask band by default */ if (!psOptions->bParsedMaskArgument) psOptions->eMaskMode = MASK_DISABLED; } const int nBand = atoi(pszBand); if (nBand < 1) { throw std::invalid_argument(CPLSPrintf( "Unrecognizable band number (%s).", s.c_str())); } psOptions->nBandCount++; psOptions->anBandList.emplace_back(nBand * (bMask ? -1 : 1)); }) .help(_("Select input band(s)")); argParser->add_argument("-mask") .metavar("") .action( [psOptions](const std::string &s) { psOptions->bParsedMaskArgument = true; const char *pszBand = s.c_str(); if (EQUAL(pszBand, "none")) { psOptions->eMaskMode = MASK_DISABLED; } else if (EQUAL(pszBand, "auto")) { psOptions->eMaskMode = MASK_AUTO; } else { bool bMask = false; if (EQUAL(pszBand, "mask")) pszBand = "mask,1"; if (STARTS_WITH_CI(pszBand, "mask,")) { bMask = true; pszBand += 5; } const int nBand = atoi(pszBand); if (nBand < 1) { throw std::invalid_argument(CPLSPrintf( "Unrecognizable band number (%s).", s.c_str())); } psOptions->eMaskMode = MASK_USER; psOptions->nMaskBand = nBand; if (bMask) psOptions->nMaskBand *= -1; } }) .help(_("Select an input band to create output dataset mask band")); argParser->add_argument("-expand") .metavar("gray|rgb|rgba") .action( [psOptions](const std::string &s) { if (EQUAL(s.c_str(), "gray")) psOptions->nRGBExpand = 1; else if (EQUAL(s.c_str(), "rgb")) psOptions->nRGBExpand = 3; else if (EQUAL(s.c_str(), "rgba")) psOptions->nRGBExpand = 4; else { throw std::invalid_argument(CPLSPrintf( "Value %s unsupported. Only gray, rgb or rgba are " "supported.", s.c_str())); } }) .help(_("To expose a dataset with 1 band with a color table as a " "dataset with 3 (RGB) or 4 (RGBA) bands.")); { auto &group = argParser->add_mutually_exclusive_group(); group.add_argument("-strict") .store_into(psOptions->bStrict) .help(_("Enable strict mode")); group.add_argument("-not_strict") .flag() .action([psOptions](const std::string &) { psOptions->bStrict = false; }) .help(_("Disable strict mode")); } argParser->add_argument("-outsize") .metavar(" ") .nargs(2) .help(_("Set the size of the output file.")); argParser->add_argument("-tr") .metavar(" ") .nargs(2) .scan<'g', double>() .help(_("Set target resolution.")); argParser->add_argument("-ovr") .metavar("|AUTO|AUTO-|NONE") .action( [psOptions](const std::string &s) { const char *pszOvLevel = s.c_str(); if (EQUAL(pszOvLevel, "AUTO")) psOptions->nOvLevel = OVR_LEVEL_AUTO; else if (STARTS_WITH_CI(pszOvLevel, "AUTO-")) psOptions->nOvLevel = OVR_LEVEL_AUTO - atoi(pszOvLevel + strlen("AUTO-")); else if (EQUAL(pszOvLevel, "NONE")) psOptions->nOvLevel = OVR_LEVEL_NONE; else if (CPLGetValueType(pszOvLevel) == CPL_VALUE_INTEGER) psOptions->nOvLevel = atoi(pszOvLevel); else { throw std::invalid_argument(CPLSPrintf( "Invalid value '%s' for -ovr option", pszOvLevel)); } }) .help(_("Specify which overview level of source file must be used")); if (psOptionsForBinary) { argParser->add_argument("-sds") .store_into(psOptionsForBinary->bCopySubDatasets) .help(_("Copy subdatasets")); } argParser->add_argument("-r") .metavar("nearest,bilinear,cubic,cubicspline,lanczos,average,mode") .store_into(psOptions->osResampling) .help(_("Resampling algorithm.")); { auto &group = argParser->add_mutually_exclusive_group(); group.add_argument("-scale") .metavar("[ [ ]]") //.nargs(0, 4) .append() .scan<'g', double>() .help(_("Rescale the input pixels values from the range src_min to " "src_max to the range dst_min to dst_max.")); group.add_argument("-scale_X") .metavar("[ [ ]]") //.nargs(0, 4) .append() .scan<'g', double>() .help(_("Rescale the input pixels values for band X.")); group.add_argument("-unscale") .store_into(psOptions->bUnscale) .help(_("Apply the scale/offset metadata for the bands to convert " "scaled values to unscaled values.")); } { auto &group = argParser->add_mutually_exclusive_group(); group.add_argument("-exponent") .metavar("") .scan<'g', double>() .help(_( "Exponent to apply non-linear scaling with a power function")); group.add_argument("-exponent_X") .append() .metavar("") .scan<'g', double>() .help( _("Exponent to apply non-linear scaling with a power function, " "for band X")); } argParser->add_argument("-srcwin") .metavar(" ") .nargs(4) .scan<'g', double>() .help(_("Selects a subwindow from the source image based on pixel/line " "location.")); argParser->add_argument("-projwin") .metavar(" ") .nargs(4) .scan<'g', double>() .help(_("Selects a subwindow from the source image based on " "georeferenced coordinates.")); argParser->add_argument("-projwin_srs") .metavar("") .store_into(psOptions->osProjSRS) .help(_("Specifies the SRS in which to interpret the coordinates given " "with -projwin.")); argParser->add_argument("-epo") .flag() .action( [psOptions](const std::string &) { psOptions->bErrorOnPartiallyOutside = true; psOptions->bErrorOnCompletelyOutside = true; }) .help(_("Error when Partially Outside.")); argParser->add_argument("-eco") .store_into(psOptions->bErrorOnCompletelyOutside) .help(_("Error when Completely Outside.")); argParser->add_argument("-a_srs") .metavar("") .store_into(psOptions->osOutputSRS) .help(_("Override the projection for the output file.")); argParser->add_argument("-a_coord_epoch") .metavar("") .store_into(psOptions->dfOutputCoordinateEpoch) .help(_("Assign a coordinate epoch.")); argParser->add_argument("-a_ullr") .metavar(" ") .nargs(4) .scan<'g', double>() .help( _("Assign/override the georeferenced bounds of the output file.")); argParser->add_argument("-a_nodata") .metavar("|none") .help(_("Assign a specified nodata value to output bands.")); argParser->add_argument("-a_gt") .metavar(" ") .nargs(6) .scan<'g', double>() .help(_("Assign/override the geotransform of the output file.")); argParser->add_argument("-a_scale") .metavar("") .store_into(psOptions->dfScale) .help(_("Set band scaling value.")); argParser->add_argument("-a_offset") .metavar("") .store_into(psOptions->dfOffset) .help(_("Set band offset value.")); argParser->add_argument("-nogcp") .store_into(psOptions->bNoGCP) .help(_("Do not copy the GCPs in the source dataset to the output " "dataset.")); argParser->add_argument("-gcp") .metavar(" []") .nargs(4, 5) .append() .scan<'g', double>() .help( _("Add the indicated ground control point to the output dataset.")); argParser->add_argument("-colorinterp") .metavar("{red|green|blue|alpha|gray|undefined|pan|coastal|rededge|nir|" "swir|mwir|lwir|...},...") .action( [psOptions](const std::string &s) { CPLStringList aosList(CSLTokenizeString2(s.c_str(), ",", 0)); psOptions->anColorInterp.resize(aosList.size()); for (int j = 0; j < aosList.size(); j++) { psOptions->anColorInterp[j] = GetColorInterp(aosList[j]); } }) .help(_("Override the color interpretation of all specified bands.")); argParser->add_argument("-colorinterp_X") .append() .metavar("{red|green|blue|alpha|gray|undefined|pan|coastal|rededge|nir|" "swir|mwir|lwir|...}") .help(_("Override the color interpretation of band X.")); { auto &group = argParser->add_mutually_exclusive_group(); group.add_argument("-stats") .flag() .action( [psOptions](const std::string &) { psOptions->bStats = true; psOptions->bApproxStats = false; }) .help(_("Force (re)computation of statistics.")); group.add_argument("-approx_stats") .flag() .action( [psOptions](const std::string &) { psOptions->bStats = true; psOptions->bApproxStats = true; }) .help(_("Force (re)computation of approximate statistics.")); } argParser->add_argument("-norat") .store_into(psOptions->bNoRAT) .help(_("Do not copy source RAT into destination dataset.")); argParser->add_argument("-noxmp") .store_into(psOptions->bNoXMP) .help(_("Do not copy the XMP metadata into destination dataset.")); argParser->add_creation_options_argument(psOptions->aosCreateOptions); argParser->add_metadata_item_options_argument( psOptions->aosMetadataOptions); argParser->add_argument("-dmo") .metavar(":=") .append() .action([psOptions](const std::string &s) { psOptions->aosDomainMetadataOptions.AddString(s.c_str()); }) .help(_("Passes a metadata key and value in specified domain to set on " "the output dataset if possible.")); argParser->add_open_options_argument( psOptionsForBinary ? &(psOptionsForBinary->aosOpenOptions) : nullptr); // Undocumented option used by gdal_translate_fuzzer argParser->add_argument("-limit_outsize") .hidden() .store_into(psOptions->nLimitOutSize); // Undocumented option used by gdal raster convert argParser->add_argument("--no-overwrite") .store_into(psOptions->bNoOverwrite) .hidden(); // Undocumented option used by gdal raster scale argParser->add_argument("--no-clip") .store_into(psOptions->bNoClip) .hidden(); // Undocumented option used by gdal raster clip argParser->add_argument("--no-warn-about-outside-window") .store_into(psOptions->bNoWarnAboutOutsideWindow) .hidden(); if (psOptionsForBinary) { argParser->add_argument("input_file") .metavar("") .store_into(psOptionsForBinary->osSource) .help(_("Input file.")); argParser->add_argument("output_file") .metavar("") .store_into(psOptionsForBinary->osDest) .help(_("Output file.")); } return argParser; } /************************************************************************/ /* GDALTranslateGetParserUsage() */ /************************************************************************/ std::string GDALTranslateGetParserUsage() { try { GDALTranslateOptions sOptions; GDALTranslateOptionsForBinary sOptionsForBinary; auto argParser = GDALTranslateOptionsGetParser(&sOptions, &sOptionsForBinary); return argParser->usage(); } catch (const std::exception &err) { CPLError(CE_Failure, CPLE_AppDefined, "Unexpected exception: %s", err.what()); return std::string(); } } /************************************************************************/ /* GDALTranslateOptionsNew() */ /************************************************************************/ /** * Allocates a GDALTranslateOptions struct. * * @param papszArgv NULL terminated list of options (potentially including * filename and open options too), or NULL. The accepted options are the ones of * the gdal_translate utility. * @param psOptionsForBinary (output) may be NULL (and should generally be * NULL), otherwise (gdal_translate_bin.cpp use case) must be allocated with * GDALTranslateOptionsForBinaryNew() prior to this * function. Will be filled with potentially present filename, open options,... * @return pointer to the allocated GDALTranslateOptions struct. Must be freed * with GDALTranslateOptionsFree(). * * @since GDAL 2.1 */ GDALTranslateOptions * GDALTranslateOptionsNew(char **papszArgv, GDALTranslateOptionsForBinary *psOptionsForBinary) { auto psOptions = std::make_unique(); psOptions->aosArgs.Assign(CSLDuplicate(papszArgv), true); /* -------------------------------------------------------------------- */ /* Pre-processing for custom syntax that ArgumentParser does not */ /* support. */ /* -------------------------------------------------------------------- */ CPLStringList aosArgv; const int argc = CSLCount(papszArgv); for (int i = 0; i < argc && papszArgv != nullptr && papszArgv[i] != nullptr; i++) { if (i + 4 < argc && EQUAL(papszArgv[i], "-gcp")) { /* -gcp pixel line easting northing [elev] */ psOptions->asGCPs.resize(psOptions->asGCPs.size() + 1); psOptions->asGCPs.back().Pixel() = CPLAtofM(papszArgv[++i]); psOptions->asGCPs.back().Line() = CPLAtofM(papszArgv[++i]); psOptions->asGCPs.back().X() = CPLAtofM(papszArgv[++i]); psOptions->asGCPs.back().Y() = CPLAtofM(papszArgv[++i]); char *endptr = nullptr; if (papszArgv[i + 1] != nullptr && (CPLStrtod(papszArgv[i + 1], &endptr) != 0.0 || papszArgv[i + 1][0] == '0')) { /* Check that last argument is really a number and not a * filename */ /* looking like a number (see ticket #863) */ if (endptr && *endptr == 0) psOptions->asGCPs.back().Z() = CPLAtofM(papszArgv[++i]); } /* should set id and info? */ } else if (EQUAL(papszArgv[i], "-scale") || STARTS_WITH_CI(papszArgv[i], "-scale_")) { int nIndex = 0; if (STARTS_WITH_CI(papszArgv[i], "-scale_")) { if (!psOptions->bHasUsedExplicitScaleBand && !psOptions->asScaleParams.empty()) { CPLError(CE_Failure, CPLE_NotSupported, "Cannot mix -scale and -scale_XX syntax"); return nullptr; } psOptions->bHasUsedExplicitScaleBand = true; nIndex = atoi(papszArgv[i] + 7); if (nIndex <= 0 || nIndex > 65535) { CPLError(CE_Failure, CPLE_NotSupported, "Invalid parameter name: %s", papszArgv[i]); return nullptr; } nIndex--; } else { if (psOptions->bHasUsedExplicitScaleBand) { CPLError(CE_Failure, CPLE_NotSupported, "Cannot mix -scale and -scale_XX syntax"); return nullptr; } nIndex = static_cast(psOptions->asScaleParams.size()); } if (nIndex >= static_cast(psOptions->asScaleParams.size())) { psOptions->asScaleParams.resize(nIndex + 1); } psOptions->asScaleParams[nIndex].bScale = true; bool bScanForDst = false; if (i < argc - 2 && EQUAL(papszArgv[i + 1], "NaN") && EQUAL(papszArgv[i + 2], "NaN")) { bScanForDst = true; i += 2; } else if (i < argc - 2 && ArgIsNumeric(papszArgv[i + 1])) { if (!ArgIsNumeric(papszArgv[i + 2])) { CPLError(CE_Failure, CPLE_IllegalArg, "Value of -scale must be numeric"); return nullptr; } psOptions->asScaleParams[nIndex].dfScaleSrcMin = CPLAtofM(papszArgv[i + 1]); psOptions->asScaleParams[nIndex].dfScaleSrcMax = CPLAtofM(papszArgv[i + 2]); bScanForDst = true; i += 2; } if (i < argc - 2 && bScanForDst && ArgIsNumeric(papszArgv[i + 1])) { if (!ArgIsNumeric(papszArgv[i + 2])) { CPLError(CE_Failure, CPLE_IllegalArg, "Value of -scale must be numeric"); return nullptr; } psOptions->asScaleParams[nIndex].dfScaleDstMin = CPLAtofM(papszArgv[i + 1]); psOptions->asScaleParams[nIndex].dfScaleDstMax = CPLAtofM(papszArgv[i + 2]); i += 2; } } else if ((EQUAL(papszArgv[i], "-exponent") || STARTS_WITH_CI(papszArgv[i], "-exponent_")) && papszArgv[i + 1]) { int nIndex = 0; if (STARTS_WITH_CI(papszArgv[i], "-exponent_")) { if (!psOptions->bHasUsedExplicitExponentBand && !psOptions->adfExponent.empty()) { CPLError(CE_Failure, CPLE_NotSupported, "Cannot mix -exponent and -exponent_XX syntax"); return nullptr; } psOptions->bHasUsedExplicitExponentBand = true; nIndex = atoi(papszArgv[i] + 10); if (nIndex <= 0 || nIndex > 65535) { CPLError(CE_Failure, CPLE_NotSupported, "Invalid parameter name: %s", papszArgv[i]); return nullptr; } nIndex--; } else { if (psOptions->bHasUsedExplicitExponentBand) { CPLError(CE_Failure, CPLE_NotSupported, "Cannot mix -exponent and -exponent_XX syntax"); return nullptr; } nIndex = static_cast(psOptions->adfExponent.size()); } if (nIndex >= static_cast(psOptions->adfExponent.size())) { psOptions->adfExponent.resize(nIndex + 1); } double dfExponent = CPLAtofM(papszArgv[++i]); psOptions->adfExponent[nIndex] = dfExponent; } else if (STARTS_WITH_CI(papszArgv[i], "-colorinterp_") && papszArgv[i + 1]) { int nIndex = atoi(papszArgv[i] + strlen("-colorinterp_")); if (nIndex <= 0 || nIndex > 65535) { CPLError(CE_Failure, CPLE_NotSupported, "Invalid parameter name: %s", papszArgv[i]); return nullptr; } nIndex--; if (nIndex >= static_cast(psOptions->anColorInterp.size())) { psOptions->anColorInterp.resize(nIndex + 1, -1); } ++i; psOptions->anColorInterp[nIndex] = GetColorInterp(papszArgv[i]); } // argparser will be confused if the value of a string argument // starts with a negative sign. else if (EQUAL(papszArgv[i], "-a_nodata") && papszArgv[i + 1]) { ++i; const char *s = papszArgv[i]; if (EQUAL(s, "none") || EQUAL(s, "null")) { psOptions->bUnsetNoData = true; } else { psOptions->bSetNoData = true; psOptions->osNoData = s; } } else { aosArgv.AddString(papszArgv[i]); } } try { auto argParser = GDALTranslateOptionsGetParser(psOptions.get(), psOptionsForBinary); argParser->parse_args_without_binary_name(aosArgv.List()); psOptions->bSetScale = argParser->is_used("-a_scale"); psOptions->bSetOffset = argParser->is_used("-a_offset"); if (auto adfULLR = argParser->present>("-a_ullr")) { CPLAssert(psOptions->adfULLR.size() == adfULLR->size()); for (size_t i = 0; i < adfULLR->size(); ++i) psOptions->adfULLR[i] = (*adfULLR)[i]; } if (auto adfGT = argParser->present>("-a_gt")) { CPLAssert(adfGT->size() == 6); for (size_t i = 0; i < adfGT->size(); ++i) psOptions->gt[i] = (*adfGT)[i]; } bool bOutsizeExplicitlySet = false; if (auto aosOutSize = argParser->present>("-outsize")) { if ((*aosOutSize)[0].back() == '%') psOptions->dfOXSizePct = CPLAtofM((*aosOutSize)[0].c_str()); else psOptions->nOXSizePixel = atoi((*aosOutSize)[0].c_str()); if ((*aosOutSize)[1].back() == '%') psOptions->dfOYSizePct = CPLAtofM((*aosOutSize)[1].c_str()); else psOptions->nOYSizePixel = atoi((*aosOutSize)[1].c_str()); bOutsizeExplicitlySet = true; } if (auto adfTargetRes = argParser->present>("-tr")) { psOptions->dfXRes = (*adfTargetRes)[0]; psOptions->dfYRes = fabs((*adfTargetRes)[1]); if (psOptions->dfXRes == 0 || psOptions->dfYRes == 0) { CPLError(CE_Failure, CPLE_IllegalArg, "Wrong value for -tr parameters."); return nullptr; } } if (auto adfSrcWin = argParser->present>("-srcwin")) { psOptions->srcWin.dfXOff = (*adfSrcWin)[0]; psOptions->srcWin.dfYOff = (*adfSrcWin)[1]; psOptions->srcWin.dfXSize = (*adfSrcWin)[2]; psOptions->srcWin.dfYSize = (*adfSrcWin)[3]; } if (auto adfProjWin = argParser->present>("-projwin")) { psOptions->dfULX = (*adfProjWin)[0]; psOptions->dfULY = (*adfProjWin)[1]; psOptions->dfLRX = (*adfProjWin)[2]; psOptions->dfLRY = (*adfProjWin)[3]; } if (!psOptions->asGCPs.empty() && psOptions->bNoGCP) { CPLError(CE_Failure, CPLE_IllegalArg, "-nogcp and -gcp cannot be used as the same time"); return nullptr; } if (bOutsizeExplicitlySet && psOptions->nOXSizePixel == 0 && psOptions->dfOXSizePct == 0.0 && psOptions->nOYSizePixel == 0 && psOptions->dfOYSizePct == 0.0) { CPLError(CE_Failure, CPLE_NotSupported, "-outsize %d %d invalid.", psOptions->nOXSizePixel, psOptions->nOYSizePixel); return nullptr; } if (!psOptions->asScaleParams.empty() && psOptions->bUnscale) { CPLError(CE_Failure, CPLE_IllegalArg, "-scale and -unscale cannot be used as the same time"); return nullptr; } if (psOptionsForBinary) { psOptionsForBinary->bQuiet = psOptions->bQuiet; psOptionsForBinary->aosCreateOptions = psOptions->aosCreateOptions; if (!psOptions->osFormat.empty()) psOptionsForBinary->osFormat = psOptions->osFormat; } return psOptions.release(); } catch (const std::exception &err) { CPLError(CE_Failure, CPLE_AppDefined, "%s", err.what()); return nullptr; } } /************************************************************************/ /* GDALTranslateOptionsFree() */ /************************************************************************/ /** * Frees the GDALTranslateOptions struct. * * @param psOptions the options struct for GDALTranslate(). * * @since GDAL 2.1 */ void GDALTranslateOptionsFree(GDALTranslateOptions *psOptions) { delete psOptions; } /************************************************************************/ /* GDALTranslateOptionsSetProgress() */ /************************************************************************/ /** * Set a progress function. * * @param psOptions the options struct for GDALTranslate(). * @param pfnProgress the progress callback. * @param pProgressData the user data for the progress callback. * * @since GDAL 2.1 */ void GDALTranslateOptionsSetProgress(GDALTranslateOptions *psOptions, GDALProgressFunc pfnProgress, void *pProgressData) { psOptions->pfnProgress = pfnProgress; psOptions->pProgressData = pProgressData; if (pfnProgress == GDALTermProgress) psOptions->bQuiet = false; }