/src/gdal/frmts/dted/dted_api.c

Source
/******************************************************************************
 *
 * Project:  DTED Translator
 * Purpose:  Implementation of DTED/CDED access functions.
 * Author:   Frank Warmerdam, warmerdam@pobox.com
 *
 ******************************************************************************
 * Copyright (c) 1999, Frank Warmerdam
 * Copyright (c) 2007-2012, Even Rouault <even dot rouault at spatialys.com>
 *
 * SPDX-License-Identifier: MIT
 ****************************************************************************/

#include "dted_api.h"

#ifndef AVOID_CPL
#endif

static int bWarnedTwoComplement = FALSE;

static void DTEDDetectVariantWithMissingColumns(DTEDInfo *psDInfo);

CPL_INLINE static void CPL_IGNORE_RET_VAL_INT(CPL_UNUSED int unused)
{
}

CPL_INLINE static void CPL_IGNORE_RET_VAL_SIZET(CPL_UNUSED size_t unused)
{
}

#define DIGIT_ZERO '0'

/************************************************************************/
/*                            DTEDGetField()                            */
/*                                                                      */
/*      Extract a field as a zero terminated string.  Address is        */
/*      deliberately 1 based so the getfield arguments will be the      */
/*      same as the numbers in the file format specification.           */
/************************************************************************/

static char *DTEDGetField(char szResult[81], const char *pachRecord, int nStart,
                          int nSize)

{
    CPLAssert(nSize < 81);
    memcpy(szResult, pachRecord + nStart - 1, nSize);
    szResult[nSize] = '\0';

    return szResult;
}

/************************************************************************/
/*                         StripLeadingZeros()                          */
/*                                                                      */
/*      Return a pointer to the first non-zero character in BUF.        */
/*      BUF must be null terminated.                                    */
/*      If buff is all zeros, then it will point to the last non-zero   */
/************************************************************************/

static const char *stripLeadingZeros(const char *buf)
{
    const char *ptr = buf;

    /* Go until we run out of characters  or hit something non-zero */

    while (*ptr == DIGIT_ZERO && *(ptr + 1) != '\0')
    {
        ptr++;
    }

    return ptr;
}

/************************************************************************/
/*                              DTEDOpen()                              */
/************************************************************************/

DTEDInfo *DTEDOpen(const char *pszFilename, const char *pszAccess,
                   int bTestOpen)

{
    VSILFILE *fp;

    /* -------------------------------------------------------------------- */
    /*      Open the physical file.                                         */
    /* -------------------------------------------------------------------- */
    if (EQUAL(pszAccess, "r") || EQUAL(pszAccess, "rb"))
        pszAccess = "rb";
    else
        pszAccess = "r+b";

    fp = VSIFOpenL(pszFilename, pszAccess);

    if (fp == NULL)
    {
        if (!bTestOpen)
        {
#ifndef AVOID_CPL
            CPLError(CE_Failure, CPLE_OpenFailed,
#else
            fprintf(stderr,
#endif
                     "Failed to open file %s.", pszFilename);
        }

        return NULL;
    }

    return DTEDOpenEx(fp, pszFilename, pszAccess, bTestOpen);
}

/************************************************************************/
/*                             DTEDOpenEx()                             */
/************************************************************************/

DTEDInfo *DTEDOpenEx(VSILFILE *fp, const char *pszFilename,
                     const char *pszAccess, int bTestOpen)

{
    char achRecord[DTED_UHL_SIZE];
    DTEDInfo *psDInfo = NULL;
    double dfLLOriginX, dfLLOriginY;
    int deg = 0;
    int min = 0;
    int sec = 0;
    int bSwapLatLong = FALSE;
    char szResult[81];
    int bIsWeirdDTED;
    char chHemisphere;

    /* -------------------------------------------------------------------- */
    /*      Read, trying to find the UHL record.  Skip VOL or HDR           */
    /*      records if they are encountered.                                */
    /* -------------------------------------------------------------------- */
    do
    {
        if (VSIFReadL(achRecord, 1, DTED_UHL_SIZE, fp) != DTED_UHL_SIZE)
        {
            if (!bTestOpen)
            {
#ifndef AVOID_CPL
                CPLError(CE_Failure, CPLE_OpenFailed,
#else
                fprintf(stderr,
#endif
                         "Unable to read header, %s is not DTED.", pszFilename);
            }
            CPL_IGNORE_RET_VAL_INT(VSIFCloseL(fp));
            return NULL;
        }

    } while (STARTS_WITH_CI(achRecord, "VOL") ||
             STARTS_WITH_CI(achRecord, "HDR"));

    if (!STARTS_WITH_CI(achRecord, "UHL"))
    {
        if (!bTestOpen)
        {
#ifndef AVOID_CPL
            CPLError(CE_Failure, CPLE_OpenFailed,
#else
            fprintf(stderr,
#endif
                     "No UHL record.  %s is not a DTED file.", pszFilename);
        }
        CPL_IGNORE_RET_VAL_INT(VSIFCloseL(fp));
        return NULL;
    }

    /* -------------------------------------------------------------------- */
    /*      Create and initialize the DTEDInfo structure.                   */
    /* -------------------------------------------------------------------- */
    psDInfo = (DTEDInfo *)CPLCalloc(1, sizeof(DTEDInfo));

    psDInfo->fp = fp;

    psDInfo->bUpdate = EQUAL(pszAccess, "r+b");
    psDInfo->bRewriteHeaders = FALSE;

    psDInfo->nUHLOffset = (int)VSIFTellL(fp) - DTED_UHL_SIZE;
    psDInfo->pachUHLRecord = (char *)CPLMalloc(DTED_UHL_SIZE);
    memcpy(psDInfo->pachUHLRecord, achRecord, DTED_UHL_SIZE);

    psDInfo->nDSIOffset = (int)VSIFTellL(fp);
    psDInfo->pachDSIRecord = (char *)CPLMalloc(DTED_DSI_SIZE);
    CPL_IGNORE_RET_VAL_SIZET(
        VSIFReadL(psDInfo->pachDSIRecord, 1, DTED_DSI_SIZE, fp));

    psDInfo->nACCOffset = (int)VSIFTellL(fp);
    psDInfo->pachACCRecord = (char *)CPLMalloc(DTED_ACC_SIZE);
    CPL_IGNORE_RET_VAL_SIZET(
        VSIFReadL(psDInfo->pachACCRecord, 1, DTED_ACC_SIZE, fp));

    if (!STARTS_WITH_CI(psDInfo->pachDSIRecord, "DSI") ||
        !STARTS_WITH_CI(psDInfo->pachACCRecord, "ACC"))
    {
#ifndef AVOID_CPL
        CPLError(CE_Failure, CPLE_OpenFailed,
#else
        fprintf(stderr,
#endif
                 "DSI or ACC record missing.  DTED access to\n%s failed.",
                 pszFilename);

        DTEDClose(psDInfo);
        return NULL;
    }

    psDInfo->nDataOffset = (int)VSIFTellL(fp);

    /* DTED3 file from http://www.falconview.org/trac/FalconView/downloads/20 */
    /* (co_elevation.zip) has really weird offsets that don't comply with the
     * 89020B specification */
    bIsWeirdDTED = achRecord[4] == ' ';

    /* -------------------------------------------------------------------- */
    /*      Parse out position information.  Note that we are extracting    */
    /*      the top left corner of the top left pixel area, not the         */
    /*      center of the area.                                             */
    /* -------------------------------------------------------------------- */
    if (!bIsWeirdDTED)
    {
        psDInfo->dfPixelSizeX =
            atoi(DTEDGetField(szResult, achRecord, 21, 4)) / 36000.0;

        psDInfo->dfPixelSizeY =
            atoi(DTEDGetField(szResult, achRecord, 25, 4)) / 36000.0;

        psDInfo->nXSize = atoi(DTEDGetField(szResult, achRecord, 48, 4));
        psDInfo->nYSize = atoi(DTEDGetField(szResult, achRecord, 52, 4));
    }
    else
    {
        psDInfo->dfPixelSizeX =
            atoi(DTEDGetField(szResult, achRecord, 41, 4)) / 36000.0;

        psDInfo->dfPixelSizeY =
            atoi(DTEDGetField(szResult, achRecord, 45, 4)) / 36000.0;

        psDInfo->nXSize =
            atoi(DTEDGetField(szResult, psDInfo->pachDSIRecord, 563, 4));
        psDInfo->nYSize =
            atoi(DTEDGetField(szResult, psDInfo->pachDSIRecord, 567, 4));
    }

    if (psDInfo->nXSize <= 0 || psDInfo->nYSize <= 0)
    {
#ifndef AVOID_CPL
        CPLError(CE_Failure, CPLE_OpenFailed,
#else
        fprintf(stderr,
#endif
                 "Invalid dimensions : %d x %d.  DTED access to\n%s failed.",
                 psDInfo->nXSize, psDInfo->nYSize, pszFilename);

        DTEDClose(psDInfo);
        return NULL;
    }

    /* create a scope so I don't need to declare these up top */
    if (!bIsWeirdDTED)
    {
        deg = atoi(stripLeadingZeros(DTEDGetField(szResult, achRecord, 5, 3)));
        min = atoi(stripLeadingZeros(DTEDGetField(szResult, achRecord, 8, 2)));
        sec = atoi(stripLeadingZeros(DTEDGetField(szResult, achRecord, 10, 2)));
        chHemisphere = achRecord[11];
    }
    else
    {
        deg = atoi(stripLeadingZeros(DTEDGetField(szResult, achRecord, 9, 3)));
        min = atoi(stripLeadingZeros(DTEDGetField(szResult, achRecord, 12, 2)));
        sec = atoi(stripLeadingZeros(DTEDGetField(szResult, achRecord, 14, 2)));
        chHemisphere = achRecord[15];
    }

    /* NOTE : The first version of MIL-D-89020 was buggy.
       The latitude and longitude of the LL corner of the UHF record was
       inverted. This was fixed in MIL-D-89020 Amendment 1, but some products
       may be affected. We detect this situation by looking at N/S in the
       longitude field and E/W in the latitude one.
    */

    dfLLOriginX = deg + min / 60.0 + sec / 3600.0;
    if (chHemisphere == 'W')
        dfLLOriginX *= -1;
    else if (chHemisphere == 'N')
        bSwapLatLong = TRUE;
    else if (chHemisphere == 'S')
    {
        dfLLOriginX *= -1;
        bSwapLatLong = TRUE;
    }

    if (!bIsWeirdDTED)
    {
        deg = atoi(stripLeadingZeros(DTEDGetField(szResult, achRecord, 13, 3)));
        min = atoi(stripLeadingZeros(DTEDGetField(szResult, achRecord, 16, 2)));
        sec = atoi(stripLeadingZeros(DTEDGetField(szResult, achRecord, 18, 2)));
        chHemisphere = achRecord[19];
    }
    else
    {
        deg = atoi(stripLeadingZeros(DTEDGetField(szResult, achRecord, 25, 3)));
        min = atoi(stripLeadingZeros(DTEDGetField(szResult, achRecord, 28, 2)));
        sec = atoi(stripLeadingZeros(DTEDGetField(szResult, achRecord, 30, 2)));
        chHemisphere = achRecord[31];
    }

    dfLLOriginY = deg + min / 60.0 + sec / 3600.0;
    if (chHemisphere == 'S' || (bSwapLatLong && chHemisphere == 'W'))
        dfLLOriginY *= -1;

    if (bSwapLatLong)
    {
        double dfTmp = dfLLOriginX;
        dfLLOriginX = dfLLOriginY;
        dfLLOriginY = dfTmp;
    }

    psDInfo->dfULCornerX = dfLLOriginX - 0.5 * psDInfo->dfPixelSizeX;
    psDInfo->dfULCornerY = dfLLOriginY - 0.5 * psDInfo->dfPixelSizeY +
                           psDInfo->nYSize * psDInfo->dfPixelSizeY;

    DTEDDetectVariantWithMissingColumns(psDInfo);

    psDInfo->bAssumeConformant =
        CPLTestBool(CPLGetConfigOption("DTED_ASSUME_CONFORMANT", "NO"));

    return psDInfo;
}

/************************************************************************/
/*               DTEDDetectVariantWithMissingColumns()                  */
/************************************************************************/

static void DTEDDetectVariantWithMissingColumns(DTEDInfo *psDInfo)
{
    /* -------------------------------------------------------------------- */
    /*      Some DTED files have only a subset of all possible columns.     */
    /*      They can declare for example 3601 columns, but in the file,     */
    /*      there are just columns 100->500. Detect that situation.         */
    /* -------------------------------------------------------------------- */

    GByte pabyRecordHeader[8];
    int nFirstDataBlockCount, nFirstLongitudeCount;
    int nLastDataBlockCount, nLastLongitudeCount;
    int nSize;
    int nColByteSize = 12 + psDInfo->nYSize * 2;

    if (VSIFSeekL(psDInfo->fp, psDInfo->nDataOffset, SEEK_SET) < 0 ||
        VSIFReadL(pabyRecordHeader, 1, 8, psDInfo->fp) != 8 ||
        pabyRecordHeader[0] != 0252)
    {
        CPLDebug("DTED", "Cannot find signature of first column");
        return;
    }

    nFirstDataBlockCount = (pabyRecordHeader[2] << 8) | pabyRecordHeader[3];
    nFirstLongitudeCount = (pabyRecordHeader[4] << 8) | pabyRecordHeader[5];

    CPL_IGNORE_RET_VAL_SIZET(VSIFSeekL(psDInfo->fp, 0, SEEK_END));
    nSize = (int)VSIFTellL(psDInfo->fp);
    if (nSize < 12 + psDInfo->nYSize * 2)
    {
        CPLDebug("DTED", "File too short");
        return;
    }

    if (VSIFSeekL(psDInfo->fp, nSize - nColByteSize, SEEK_SET) < 0 ||
        VSIFReadL(pabyRecordHeader, 1, 8, psDInfo->fp) != 8 ||
        pabyRecordHeader[0] != 0252)
    {
        CPLDebug("DTED", "Cannot find signature of last column");
        return;
    }

    nLastDataBlockCount = (pabyRecordHeader[2] << 8) | pabyRecordHeader[3];
    nLastLongitudeCount = (pabyRecordHeader[4] << 8) | pabyRecordHeader[5];

    if (nFirstDataBlockCount == 0 && nFirstLongitudeCount == 0 &&
        nLastDataBlockCount == psDInfo->nXSize - 1 &&
        nLastLongitudeCount == psDInfo->nXSize - 1 &&
        nSize - psDInfo->nDataOffset == psDInfo->nXSize * nColByteSize)
    {
        /* This is the most standard form of DTED. Return happily now. */
        return;
    }

    /* Well, we have an odd DTED file at that point */

    psDInfo->panMapLogicalColsToOffsets =
        (int *)CPLMalloc(psDInfo->nXSize * sizeof(int));

    if (nFirstDataBlockCount == 0 &&
        nLastLongitudeCount - nFirstLongitudeCount ==
            nLastDataBlockCount - nFirstDataBlockCount &&
        nSize - psDInfo->nDataOffset ==
            (nLastLongitudeCount - nFirstLongitudeCount + 1) * nColByteSize)
    {
        int i;

        /* Case seen in a real-world file */

        CPLDebug("DTED",
                 "The file only contains data from column %d to column %d.",
                 nFirstLongitudeCount, nLastLongitudeCount);

        for (i = 0; i < psDInfo->nXSize; i++)
        {
            if (i < nFirstLongitudeCount)
                psDInfo->panMapLogicalColsToOffsets[i] = -1;
            else if (i <= nLastLongitudeCount)
                psDInfo->panMapLogicalColsToOffsets[i] =
                    psDInfo->nDataOffset +
                    (i - nFirstLongitudeCount) * nColByteSize;
            else
                psDInfo->panMapLogicalColsToOffsets[i] = -1;
        }
    }
    else
    {
        int nPhysicalCols = (nSize - psDInfo->nDataOffset) / nColByteSize;
        int i;

        /* Theoretical case for now... */

        CPLDebug("DTED", "There columns appear to be in non sequential order. "
                         "Scanning the whole file.");

        for (i = 0; i < psDInfo->nXSize; i++)
        {
            psDInfo->panMapLogicalColsToOffsets[i] = -1;
        }

        for (i = 0; i < nPhysicalCols; i++)
        {
            int nDataBlockCount, nLongitudeCount;

            if (VSIFSeekL(psDInfo->fp, psDInfo->nDataOffset + i * nColByteSize,
                          SEEK_SET) < 0 ||
                VSIFReadL(pabyRecordHeader, 1, 8, psDInfo->fp) != 8 ||
                pabyRecordHeader[0] != 0252)
            {
                CPLDebug("DTED", "Cannot find signature of physical column %d",
                         i);
                return;
            }

            nDataBlockCount = (pabyRecordHeader[2] << 8) | pabyRecordHeader[3];
            if (nDataBlockCount != i)
            {
                CPLDebug("DTED",
                         "Unexpected block count(%d) at physical column %d. "
                         "Ignoring that and going on...",
                         nDataBlockCount, i);
            }

            nLongitudeCount = (pabyRecordHeader[4] << 8) | pabyRecordHeader[5];
            if (nLongitudeCount < 0 || nLongitudeCount >= psDInfo->nXSize)
            {
                CPLDebug("DTED",
                         "Invalid longitude count (%d) at physical column %d",
                         nLongitudeCount, i);
                return;
            }

            psDInfo->panMapLogicalColsToOffsets[nLongitudeCount] =
                psDInfo->nDataOffset + i * nColByteSize;
        }
    }
}

/************************************************************************/
/*                            DTEDReadPoint()                           */
/*                                                                      */
/*      Read one single sample. The coordinates are given from the      */
/*      top-left corner of the file (contrary to the internal           */
/*      organization or a DTED file)                                    */
/************************************************************************/

int DTEDReadPoint(DTEDInfo *psDInfo, int nXOff, int nYOff, GInt16 *panVal)
{
    int nOffset;
    GByte pabyData[2];

    if (nYOff < 0 || nXOff < 0 || nYOff >= psDInfo->nYSize ||
        nXOff >= psDInfo->nXSize)
    {
#ifndef AVOID_CPL
        CPLError(CE_Failure, CPLE_AppDefined,
#else
        fprintf(stderr,
#endif
                 "Invalid raster coordinates (%d,%d) in DTED file.\n", nXOff,
                 nYOff);
        return FALSE;
    }

    if (psDInfo->panMapLogicalColsToOffsets != NULL)
    {
        nOffset = psDInfo->panMapLogicalColsToOffsets[nXOff];
        if (nOffset < 0)
        {
            *panVal = DTED_NODATA_VALUE;
            return TRUE;
        }
    }
    else
        nOffset = psDInfo->nDataOffset + nXOff * (12 + psDInfo->nYSize * 2);
    nOffset += 8 + 2 * (psDInfo->nYSize - 1 - nYOff);

    if (VSIFSeekL(psDInfo->fp, nOffset, SEEK_SET) != 0 ||
        VSIFReadL(pabyData, 2, 1, psDInfo->fp) != 1)
    {
#ifndef AVOID_CPL
        CPLError(CE_Failure, CPLE_FileIO,
#else
        fprintf(stderr,
#endif
                 "Failed to seek to, or read (%d,%d) at offset %d\n"
                 "in DTED file.\n",
                 nXOff, nYOff, nOffset);
        return FALSE;
    }

    *panVal = ((pabyData[0] & 0x7f) << 8) | pabyData[1];

    if (pabyData[0] & 0x80)
    {
        *panVal *= -1;

        /*
        ** It seems that some files are improperly generated in twos
        ** complement form for negatives.  For these, redo the job
        ** in twos complement.  eg. w_069_s50.dt0
        */
        if (!psDInfo->bAssumeConformant && (*panVal < -16000) &&
            (*panVal != DTED_NODATA_VALUE))
        {
            *panVal = (pabyData[0] << 8) | pabyData[1];

            if (!bWarnedTwoComplement)
            {
                bWarnedTwoComplement = TRUE;
#ifndef AVOID_CPL
                CPLError(
                    CE_Warning, CPLE_AppDefined,
#else
                fprintf(
                    stderr,
#endif
                    "The DTED driver found values less than -16000, and has "
                    "adjusted\n"
                    "them assuming they are improperly two-complemented.  If "
                    "you wish to\n"
                    "disable this behavior, set the DTED_ASSUME_CONFORMANT "
                    "configuration\n"
                    "option to YES. No more warnings will be issued in this "
                    "session\n"
                    "about this operation.");
            }
        }
    }

    return TRUE;
}

/************************************************************************/
/*                          DTEDReadProfile()                           */
/*                                                                      */
/*      Read one profile line.  These are organized in bottom to top    */
/*      order starting from the leftmost column (0).                    */
/************************************************************************/

int DTEDReadProfile(DTEDInfo *psDInfo, int nColumnOffset, GInt16 *panData)
{
    return DTEDReadProfileEx(psDInfo, nColumnOffset, panData, FALSE);
}

int DTEDReadProfileEx(DTEDInfo *psDInfo, int nColumnOffset, GInt16 *panData,
                      int bVerifyChecksum)
{
    int nOffset;
    int i;
    GByte *pabyRecord;
    int nLongitudeCount;

    /* -------------------------------------------------------------------- */
    /*      Read data record from disk.                                     */
    /* -------------------------------------------------------------------- */
    if (psDInfo->panMapLogicalColsToOffsets != NULL)
    {
        nOffset = psDInfo->panMapLogicalColsToOffsets[nColumnOffset];
        if (nOffset < 0)
        {
            for (i = 0; i < psDInfo->nYSize; i++)
            {
                panData[i] = DTED_NODATA_VALUE;
            }
            return TRUE;
        }
    }
    else
        nOffset =
            psDInfo->nDataOffset + nColumnOffset * (12 + psDInfo->nYSize * 2);

    pabyRecord = (GByte *)CPLMalloc(12 + psDInfo->nYSize * 2);

    if (VSIFSeekL(psDInfo->fp, nOffset, SEEK_SET) != 0 ||
        VSIFReadL(pabyRecord, (12 + psDInfo->nYSize * 2), 1, psDInfo->fp) != 1)
    {
#ifndef AVOID_CPL
        CPLError(CE_Failure, CPLE_FileIO,
#else
        fprintf(stderr,
#endif
                 "Failed to seek to, or read profile %d at offset %d\n"
                 "in DTED file.\n",
                 nColumnOffset, nOffset);
        CPLFree(pabyRecord);
        return FALSE;
    }

    nLongitudeCount = (pabyRecord[4] << 8) | pabyRecord[5];
    if (nLongitudeCount != nColumnOffset)
    {
#ifndef AVOID_CPL
        CPLError(
            CE_Warning, CPLE_AppDefined,
#else
        fprintf(
            stderr,
#endif
            "Longitude count (%d) of column %d doesn't match expected value.\n",
            nLongitudeCount, nColumnOffset);
    }

    /* -------------------------------------------------------------------- */
    /*      Translate data values from "signed magnitude" to standard       */
    /*      binary.                                                         */
    /* -------------------------------------------------------------------- */
    for (i = 0; i < psDInfo->nYSize; i++)
    {
        panData[i] =
            ((pabyRecord[8 + i * 2] & 0x7f) << 8) | pabyRecord[8 + i * 2 + 1];

        if (pabyRecord[8 + i * 2] & 0x80)
        {
            panData[i] *= -1;

            /*
            ** It seems that some files are improperly generated in twos
            ** complement form for negatives.  For these, redo the job
            ** in twos complement.  eg. w_069_s50.dt0
            */
            if ((panData[i] < -16000) && (panData[i] != DTED_NODATA_VALUE))
            {
                panData[i] =
                    (pabyRecord[8 + i * 2] << 8) | pabyRecord[8 + i * 2 + 1];

                if (!bWarnedTwoComplement)
                {
                    bWarnedTwoComplement = TRUE;
#ifndef AVOID_CPL
                    CPLError(
                        CE_Warning, CPLE_AppDefined,
#else
                    fprintf(
                        stderr,
#endif
                        "The DTED driver found values less than -16000, and "
                        "has adjusted\n"
                        "them assuming they are improperly two-complemented.  "
                        "No more warnings\n"
                        "will be issued in this session about this operation.");
                }
            }
        }
    }

    if (bVerifyChecksum)
    {
        unsigned int nCheckSum = 0;
        unsigned int fileCheckSum;

        /* --------------------------------------------------------------------
         */
        /*      Verify the checksum. */
        /* --------------------------------------------------------------------
         */

        for (i = 0; i < psDInfo->nYSize * 2 + 8; i++)
            nCheckSum += pabyRecord[i];

        fileCheckSum = (pabyRecord[8 + psDInfo->nYSize * 2 + 0] << 24) |
                       (pabyRecord[8 + psDInfo->nYSize * 2 + 1] << 16) |
                       (pabyRecord[8 + psDInfo->nYSize * 2 + 2] << 8) |
                       pabyRecord[8 + psDInfo->nYSize * 2 + 3];

        if (fileCheckSum > 0xff * (8 + (unsigned int)psDInfo->nYSize * 2))
        {
            static int bWarned = FALSE;
            if (!bWarned)
            {
                bWarned = TRUE;
#ifndef AVOID_CPL
                CPLError(CE_Warning, CPLE_AppDefined,
#else
                fprintf(stderr,
#endif
                         "The DTED driver has read from the file a checksum "
                         "with an impossible value (0x%X) at column %d.\n"
                         "Check with your file producer.\n"
                         "No more warnings will be issued in this session "
                         "about this operation.",
                         fileCheckSum, nColumnOffset);
            }
        }
        else if (fileCheckSum != nCheckSum)
        {
#ifndef AVOID_CPL
            CPLError(
                CE_Failure, CPLE_AppDefined,
#else
            fprintf(
                stderr,
#endif
                "The DTED driver has found a computed and read checksum "
                "that do not match at column %d. Computed 0x%X, read 0x%X\n",
                nColumnOffset, nCheckSum, fileCheckSum);
            CPLFree(pabyRecord);
            return FALSE;
        }
    }

    CPLFree(pabyRecord);

    return TRUE;
}

/************************************************************************/
/*                          DTEDWriteProfile()                          */
/************************************************************************/

int DTEDWriteProfile(DTEDInfo *psDInfo, int nColumnOffset, GInt16 *panData)

{
    int nOffset;
    int i, nCheckSum = 0;
    GByte *pabyRecord;

    if (psDInfo->panMapLogicalColsToOffsets != NULL)
    {
#ifndef AVOID_CPL
        CPLError(CE_Failure, CPLE_NotSupported,
#else
        fprintf(stderr,
#endif
                 "Write to partial file not supported.\n");
        return FALSE;
    }

    /* -------------------------------------------------------------------- */
    /*      Format the data record.                                         */
    /* -------------------------------------------------------------------- */
    pabyRecord = (GByte *)CPLMalloc(12 + psDInfo->nYSize * 2);

    for (i = 0; i < psDInfo->nYSize; i++)
    {
        int nABSVal = ABS(panData[psDInfo->nYSize - i - 1]);
        pabyRecord[8 + i * 2] = (GByte)((nABSVal >> 8) & 0x7f);
        pabyRecord[8 + i * 2 + 1] = (GByte)(nABSVal & 0xff);

        if (panData[psDInfo->nYSize - i - 1] < 0)
            pabyRecord[8 + i * 2] |= 0x80;
    }

    pabyRecord[0] = 0xaa;
    pabyRecord[1] = 0;
    pabyRecord[2] = (GByte)(nColumnOffset / 256);
    pabyRecord[3] = (GByte)(nColumnOffset % 256);
    pabyRecord[4] = (GByte)(nColumnOffset / 256);
    pabyRecord[5] = (GByte)(nColumnOffset % 256);
    pabyRecord[6] = 0;
    pabyRecord[7] = 0;

    /* -------------------------------------------------------------------- */
    /*      Compute the checksum.                                           */
    /* -------------------------------------------------------------------- */
    for (i = 0; i < psDInfo->nYSize * 2 + 8; i++)
        nCheckSum += pabyRecord[i];

    pabyRecord[8 + psDInfo->nYSize * 2 + 0] = (GByte)((nCheckSum >> 24) & 0xff);
    pabyRecord[8 + psDInfo->nYSize * 2 + 1] = (GByte)((nCheckSum >> 16) & 0xff);
    pabyRecord[8 + psDInfo->nYSize * 2 + 2] = (GByte)((nCheckSum >> 8) & 0xff);
    pabyRecord[8 + psDInfo->nYSize * 2 + 3] = (GByte)(nCheckSum & 0xff);

    /* -------------------------------------------------------------------- */
    /*      Write the record.                                               */
    /* -------------------------------------------------------------------- */
    nOffset = psDInfo->nDataOffset + nColumnOffset * (12 + psDInfo->nYSize * 2);

    if (VSIFSeekL(psDInfo->fp, nOffset, SEEK_SET) != 0 ||
        VSIFWriteL(pabyRecord, (12 + psDInfo->nYSize * 2), 1, psDInfo->fp) != 1)
    {
#ifndef AVOID_CPL
        CPLError(CE_Failure, CPLE_FileIO,
#else
        fprintf(stderr,
#endif
                 "Failed to seek to, or write profile %d at offset %d\n"
                 "in DTED file.\n",
                 nColumnOffset, nOffset);
        CPLFree(pabyRecord);
        return FALSE;
    }

    CPLFree(pabyRecord);

    return TRUE;
}

/************************************************************************/
/*                      DTEDGetMetadataLocation()                       */
/************************************************************************/

static void DTEDGetMetadataLocation(DTEDInfo *psDInfo, DTEDMetaDataCode eCode,
                                    char **ppszLocation, int *pnLength)
{
    int bIsWeirdDTED = psDInfo->pachUHLRecord[4] == ' ';

    switch (eCode)
    {
        case DTEDMD_ORIGINLONG:
            if (bIsWeirdDTED)
                *ppszLocation = psDInfo->pachUHLRecord + 8;
            else
                *ppszLocation = psDInfo->pachUHLRecord + 4;
            *pnLength = 8;
            break;

        case DTEDMD_ORIGINLAT:
            if (bIsWeirdDTED)
                *ppszLocation = psDInfo->pachUHLRecord + 24;
            else
                *ppszLocation = psDInfo->pachUHLRecord + 12;
            *pnLength = 8;
            break;

        case DTEDMD_VERTACCURACY_UHL:
            if (bIsWeirdDTED)
                *ppszLocation = psDInfo->pachUHLRecord + 56;
            else
                *ppszLocation = psDInfo->pachUHLRecord + 28;
            *pnLength = 4;
            break;

        case DTEDMD_SECURITYCODE_UHL:
            if (bIsWeirdDTED)
                *ppszLocation = psDInfo->pachUHLRecord + 60;
            else
                *ppszLocation = psDInfo->pachUHLRecord + 32;
            *pnLength = 3;
            break;

        case DTEDMD_UNIQUEREF_UHL:
            if (bIsWeirdDTED)
                *ppszLocation = NULL;
            else
                *ppszLocation = psDInfo->pachUHLRecord + 35;
            *pnLength = 12;
            break;

        case DTEDMD_DATA_EDITION:
            if (bIsWeirdDTED)
                *ppszLocation = psDInfo->pachDSIRecord + 174;
            else
                *ppszLocation = psDInfo->pachDSIRecord + 87;
            *pnLength = 2;
            break;

        case DTEDMD_MATCHMERGE_VERSION:
            if (bIsWeirdDTED)
                *ppszLocation = psDInfo->pachDSIRecord + 176;
            else
                *ppszLocation = psDInfo->pachDSIRecord + 89;
            *pnLength = 1;
            break;

        case DTEDMD_MAINT_DATE:
            if (bIsWeirdDTED)
                *ppszLocation = psDInfo->pachDSIRecord + 177;
            else
                *ppszLocation = psDInfo->pachDSIRecord + 90;
            *pnLength = 4;
            break;

        case DTEDMD_MATCHMERGE_DATE:
            if (bIsWeirdDTED)
                *ppszLocation = psDInfo->pachDSIRecord + 181;
            else
                *ppszLocation = psDInfo->pachDSIRecord + 94;
            *pnLength = 4;
            break;

        case DTEDMD_MAINT_DESCRIPTION:
            if (bIsWeirdDTED)
                *ppszLocation = psDInfo->pachDSIRecord + 185;
            else
                *ppszLocation = psDInfo->pachDSIRecord + 98;
            *pnLength = 4;
            break;

        case DTEDMD_PRODUCER:
            if (bIsWeirdDTED)
                *ppszLocation = psDInfo->pachDSIRecord + 189;
            else
                *ppszLocation = psDInfo->pachDSIRecord + 102;
            *pnLength = 8;
            break;

        case DTEDMD_VERTDATUM:
            if (bIsWeirdDTED)
                *ppszLocation = psDInfo->pachDSIRecord + 267;
            else
                *ppszLocation = psDInfo->pachDSIRecord + 141;
            *pnLength = 3;
            break;

        case DTEDMD_HORIZDATUM:
            if (bIsWeirdDTED)
                *ppszLocation = psDInfo->pachDSIRecord + 270;
            else
                *ppszLocation = psDInfo->pachDSIRecord + 144;
            *pnLength = 5;
            break;

        case DTEDMD_DIGITIZING_SYS:
            if (bIsWeirdDTED)
                *ppszLocation = NULL;
            else
                *ppszLocation = psDInfo->pachDSIRecord + 149;
            *pnLength = 10;
            break;

        case DTEDMD_COMPILATION_DATE:
            if (bIsWeirdDTED)
                *ppszLocation = NULL;
            else
                *ppszLocation = psDInfo->pachDSIRecord + 159;
            *pnLength = 4;
            break;

        case DTEDMD_HORIZACCURACY:
            *ppszLocation = psDInfo->pachACCRecord + 3;
            *pnLength = 4;
            break;

        case DTEDMD_REL_HORIZACCURACY:
            *ppszLocation = psDInfo->pachACCRecord + 11;
            *pnLength = 4;
            break;

        case DTEDMD_REL_VERTACCURACY:
            *ppszLocation = psDInfo->pachACCRecord + 15;
            *pnLength = 4;
            break;

        case DTEDMD_VERTACCURACY_ACC:
            *ppszLocation = psDInfo->pachACCRecord + 7;
            *pnLength = 4;
            break;

        case DTEDMD_SECURITYCODE_DSI:
            *ppszLocation = psDInfo->pachDSIRecord + 3;
            *pnLength = 1;
            break;

        case DTEDMD_UNIQUEREF_DSI:
            if (bIsWeirdDTED)
                *ppszLocation = NULL;
            else
                *ppszLocation = psDInfo->pachDSIRecord + 64;
            *pnLength = 15;
            break;

        case DTEDMD_NIMA_DESIGNATOR:
            if (bIsWeirdDTED)
                *ppszLocation = psDInfo->pachDSIRecord + 118;
            else
                *ppszLocation = psDInfo->pachDSIRecord + 59;
            *pnLength = 5;
            break;

        case DTEDMD_PARTIALCELL_DSI:
            if (bIsWeirdDTED)
                *ppszLocation = NULL;
            else
                *ppszLocation = psDInfo->pachDSIRecord + 289;
            *pnLength = 2;
            break;

        case DTEDMD_SECURITYCONTROL:
            *ppszLocation = psDInfo->pachDSIRecord + 4;
            *pnLength = 2;
            break;

        case DTEDMD_SECURITYHANDLING:
            *ppszLocation = psDInfo->pachDSIRecord + 6;
            *pnLength = 27;
            break;

        default:
            *ppszLocation = NULL;
            *pnLength = 0;
    }
}

/************************************************************************/
/*                          DTEDGetMetadata()                           */
/************************************************************************/

char *DTEDGetMetadata(DTEDInfo *psDInfo, DTEDMetaDataCode eCode)

{
    int nFieldLen;
    char *pszFieldSrc;
    char *pszResult;

    DTEDGetMetadataLocation(psDInfo, eCode, &pszFieldSrc, &nFieldLen);
    if (pszFieldSrc == NULL)
        return CPLStrdup("");

    pszResult = (char *)CPLMalloc(nFieldLen + 1);
    strncpy(pszResult, pszFieldSrc, nFieldLen);
    pszResult[nFieldLen] = '\0';

    return pszResult;
}

/************************************************************************/
/*                          DTEDSetMetadata()                           */
/************************************************************************/

int DTEDSetMetadata(DTEDInfo *psDInfo, DTEDMetaDataCode eCode,
                    const char *pszNewValue)

{
    int nFieldLen;
    char *pszFieldSrc;
    size_t nLenToCopy;

    if (!psDInfo->bUpdate)
        return FALSE;

    /* -------------------------------------------------------------------- */
    /*      Get the location in the headers to update.                      */
    /* -------------------------------------------------------------------- */
    DTEDGetMetadataLocation(psDInfo, eCode, &pszFieldSrc, &nFieldLen);
    if (pszFieldSrc == NULL)
        return FALSE;

    /* -------------------------------------------------------------------- */
    /*      Update it, padding with spaces.                                 */
    /* -------------------------------------------------------------------- */
    nLenToCopy = MIN((size_t)nFieldLen, strlen(pszNewValue));
    memcpy(pszFieldSrc, pszNewValue, nLenToCopy);
    if (nLenToCopy < (size_t)nFieldLen)
        memset(pszFieldSrc + nLenToCopy, ' ', nFieldLen - nLenToCopy);

    /* Turn the flag on, so that the headers are rewritten at file */
    /* closing */
    psDInfo->bRewriteHeaders = TRUE;

    return TRUE;
}

/************************************************************************/
/*                             DTEDClose()                              */
/************************************************************************/

void DTEDClose(DTEDInfo *psDInfo)

{
    if (psDInfo->bRewriteHeaders)
    {
        /* --------------------------------------------------------------------
         */
        /*      Write all headers back to disk. */
        /* --------------------------------------------------------------------
         */
        CPL_IGNORE_RET_VAL_INT(
            VSIFSeekL(psDInfo->fp, psDInfo->nUHLOffset, SEEK_SET));
        CPL_IGNORE_RET_VAL_SIZET(
            VSIFWriteL(psDInfo->pachUHLRecord, 1, DTED_UHL_SIZE, psDInfo->fp));

        CPL_IGNORE_RET_VAL_INT(
            VSIFSeekL(psDInfo->fp, psDInfo->nDSIOffset, SEEK_SET));
        CPL_IGNORE_RET_VAL_SIZET(
            VSIFWriteL(psDInfo->pachDSIRecord, 1, DTED_DSI_SIZE, psDInfo->fp));

        CPL_IGNORE_RET_VAL_INT(
            VSIFSeekL(psDInfo->fp, psDInfo->nACCOffset, SEEK_SET));
        CPL_IGNORE_RET_VAL_SIZET(
            VSIFWriteL(psDInfo->pachACCRecord, 1, DTED_ACC_SIZE, psDInfo->fp));
    }

    CPL_IGNORE_RET_VAL_INT(VSIFCloseL(psDInfo->fp));

    CPLFree(psDInfo->pachUHLRecord);
    CPLFree(psDInfo->pachDSIRecord);
    CPLFree(psDInfo->pachACCRecord);

    CPLFree(psDInfo->panMapLogicalColsToOffsets);

    CPLFree(psDInfo);
}

Coverage Report

Created: 2025-12-31 08:30