/src/gdal/frmts/bsb/bsb_read.c

Source
/******************************************************************************
 *
 * Project:  BSB Reader
 * Purpose:  Low level BSB Access API Implementation (non-GDAL).
 * Author:   Frank Warmerdam, warmerdam@pobox.com
 *
 * NOTE: This code is implemented on the basis of work by Mike Higgins.  The
 * BSB format is subject to US patent 5,727,090; however, that patent
 * apparently only covers *writing* BSB files, not reading them, so this code
 * should not be affected.
 *
 ******************************************************************************
 * Copyright (c) 2001, Frank Warmerdam
 * Copyright (c) 2007-2013, Even Rouault <even dot rouault at spatialys.com>
 *
 * SPDX-License-Identifier: MIT
 ****************************************************************************/

#include "bsb_read.h"
#include "cpl_conv.h"
#include "cpl_string.h"

#include <stdbool.h>

static int BSBReadHeaderLine(BSBInfo *psInfo, char *pszLine, int nLineMaxLen,
                             int bNO1);
static int BSBSeekAndCheckScanlineNumber(BSBInfo *psInfo, unsigned nScanline,
                                         int bVerboseIfError);

/************************************************************************

Background:

To: Frank Warmerdam <warmerda@home.com>
From: Mike Higgins <higgins@monitor.net>
Subject: Re: GISTrans: Maptech / NDI BSB Chart Format
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"; format=flowed

         I did it! I just wrote a program that reads NOAA BSB chart files
and converts them to BMP files! BMP files are not the final goal of my
project, but it served as a proof-of-concept.  Next I will want to write
routines to extract pieces of the file at full resolution for printing, and
routines to filter pieces of the chart for display at lower resolution on
the screen.  (One of the terrible things about most chart display programs
is that they all sub-sample the charts instead of filtering it down). How
did I figure out how to read the BSB files?

         If you recall, I have been trying to reverse engineer the file
formats of those nautical charts. When I am between projects I often do a
WEB search for the BSB file format to see if someone else has published a
hack for them. Monday I hit a NOAA project status report that mentioned
some guy named Marty Yellin who had recently completed writing a program to
convert BSB files to other file formats! I searched for him and found him
mentioned as a contact person for some NOAA program. I was composing a
letter to him in my head, or considering calling the NOAA phone number and
asking for his extension number, when I saw another NOAA status report
indicating that he had retired in 1998. His name showed up in a few more
reports, one of which said that he was the inventor of the BSB file format,
that it was patented (#5,727,090), and that the patent had been licensed to
Maptech (the evil company that will not allow anyone using their file
format to convert them to non-proprietary formats). Patents are readily
available on the WEB at the IBM patent server and this one is in the
dtabase!  I printed up a copy of the patent and of course it describes very
nicely (despite the usual typos and omissions of referenced items in the
figures) how to write one of these BSB files!

         I was considering talking to a patent lawyer about the legality of
using information in the patent to read files without getting a license,
when I noticed that the patent is only claiming programs that WRITE the
file format. I have noticed this before in RF patents where they describe
how to make a receiver and never bother to claim a transmitter. The logic
is that the transmitter is no good to anybody unless they license receivers
from the patent holder. But I think they did it backwards here! They should
have claimed a program that can READ the described file format. Now I can
read the files, build programs that read the files, and even sell them
without violating the claims in the patent! As long as I never try to write
one of the evil BSB files, I'm OK!!!

         If you ever need to read these BSB chart programs, drop me a
note.  I would be happy to send you a copy of this conversion program.

... later email ...

         Well, here is my little proof of concept program. I hereby give
you permission to distribute it freely, modify for your own use, etc.
I built it as a "WIN32 Console application" which means it runs in an MS
DOS box under Microsoft Windows. But the only Windows specific stuff in it
are the include files for the BMP file headers.  If you ripped out the BMP
code it should compile under UNIX or anyplace else.
         I'd be overjoyed to have you announce it to GISTrans or anywhere
else.  I'm philosophically opposed to the proprietary treatment of the  BSB
file format and I want to break it open! Chart data for the People!

 ************************************************************************/

/************************************************************************/
/*                             BSBUngetc()                              */
/************************************************************************/

static void BSBUngetc(BSBInfo *psInfo, int nCharacter)

{
    CPLAssert(psInfo->nSavedCharacter2 == -1000);
    psInfo->nSavedCharacter2 = psInfo->nSavedCharacter;
    psInfo->nSavedCharacter = nCharacter;
}

/************************************************************************/
/*                              BSBGetc()                               */
/************************************************************************/

static int BSBGetc(BSBInfo *psInfo, int bNO1, int *pbErrorFlag)

{
    int nByte;

    if (psInfo->nSavedCharacter != -1000)
    {
        nByte = psInfo->nSavedCharacter;
        psInfo->nSavedCharacter = psInfo->nSavedCharacter2;
        psInfo->nSavedCharacter2 = -1000;
        return nByte;
    }

    if (psInfo->nBufferOffset >= psInfo->nBufferSize)
    {
        psInfo->nBufferOffset = 0;
        psInfo->nBufferSize = (int)VSIFReadL(
            psInfo->pabyBuffer, 1, psInfo->nBufferAllocation, psInfo->fp);
        if (psInfo->nBufferSize <= 0)
        {
            if (pbErrorFlag)
                *pbErrorFlag = TRUE;
            return 0;
        }
    }

    nByte = psInfo->pabyBuffer[psInfo->nBufferOffset++];

    if (bNO1)
    {
        nByte = nByte - 9;
        if (nByte < 0)
            nByte = nByte + 256;
    }

    return nByte;
}

/************************************************************************/
/*                              BSBOpen()                               */
/*                                                                      */
/*      Read BSB header, and return information.                        */
/************************************************************************/

BSBInfo *BSBOpen(const char *pszFilename)

{
    VSILFILE *fp;
    char achTestBlock[1000];
    char szLine[1000];
    int i, bNO1 = FALSE;
    BSBInfo *psInfo;
    int nSkipped = 0;
    const char *pszPalette;
    int nOffsetFirstLine;
    int bErrorFlag = FALSE;

    /* -------------------------------------------------------------------- */
    /*      Which palette do we want to use?                                */
    /* -------------------------------------------------------------------- */
    pszPalette = CPLGetConfigOption("BSB_PALETTE", "RGB");

    /* -------------------------------------------------------------------- */
    /*      Open the file.                                                  */
    /* -------------------------------------------------------------------- */
    fp = VSIFOpenL(pszFilename, "rb");
    if (fp == NULL)
    {
        CPLError(CE_Failure, CPLE_OpenFailed, "File %s not found.",
                 pszFilename);
        return NULL;
    }

    /* -------------------------------------------------------------------- */
    /*  Read the first 1000 bytes, and verify that it contains the  */
    /*  "BSB/" keyword"             */
    /* -------------------------------------------------------------------- */
    if (VSIFReadL(achTestBlock, 1, sizeof(achTestBlock), fp) !=
        sizeof(achTestBlock))
    {
        VSIFCloseL(fp);
        CPLError(CE_Failure, CPLE_FileIO,
                 "Could not read first %d bytes for header!",
                 (int)sizeof(achTestBlock));
        return NULL;
    }

    for (i = 0; (size_t)i < sizeof(achTestBlock) - 4; i++)
    {
        /* Test for "BSB/" */
        if (achTestBlock[i + 0] == 'B' && achTestBlock[i + 1] == 'S' &&
            achTestBlock[i + 2] == 'B' && achTestBlock[i + 3] == '/')
            break;

        /* Test for "NOS/" */
        if (achTestBlock[i + 0] == 'N' && achTestBlock[i + 1] == 'O' &&
            achTestBlock[i + 2] == 'S' && achTestBlock[i + 3] == '/')
            break;

        /* Test for "NOS/" offset by 9 in ASCII for NO1 files */
        if (achTestBlock[i + 0] == 'W' && achTestBlock[i + 1] == 'X' &&
            achTestBlock[i + 2] == '\\' && achTestBlock[i + 3] == '8')
        {
            bNO1 = TRUE;
            break;
        }
    }

    if (i == sizeof(achTestBlock) - 4)
    {
        VSIFCloseL(fp);
        CPLError(CE_Failure, CPLE_AppDefined,
                 "This does not appear to be a BSB file, no BSB/ header.");
        return NULL;
    }

    /* -------------------------------------------------------------------- */
    /*      Create info structure.                                          */
    /* -------------------------------------------------------------------- */
    psInfo = (BSBInfo *)CPLCalloc(1, sizeof(BSBInfo));
    psInfo->fp = fp;
    psInfo->bNO1 = bNO1;

    psInfo->nBufferAllocation = 1024;
    psInfo->pabyBuffer = (GByte *)CPLMalloc(psInfo->nBufferAllocation);
    psInfo->nBufferSize = 0;
    psInfo->nBufferOffset = 0;
    psInfo->nSavedCharacter = -1000;
    psInfo->nSavedCharacter2 = -1000;

    /* -------------------------------------------------------------------- */
    /*      Rewind, and read line by line.                                  */
    /* -------------------------------------------------------------------- */
    VSIFSeekL(fp, 0, SEEK_SET);

    while (BSBReadHeaderLine(psInfo, szLine, sizeof(szLine), bNO1))
    {
        char **papszTokens = NULL;
        int nCount = 0;

        if (szLine[0] != '\0' && szLine[1] != '\0' && szLine[2] != '\0' &&
            szLine[3] == '/')
        {
            psInfo->papszHeader = CSLAddString(psInfo->papszHeader, szLine);
            papszTokens =
                CSLTokenizeStringComplex(szLine + 4, ",=", FALSE, FALSE);
            nCount = CSLCount(papszTokens);
        }
        if (papszTokens == NULL)
            continue;

        if (STARTS_WITH_CI(szLine, "BSB/"))
        {
            int nRAIndex;

            nRAIndex = CSLFindString(papszTokens, "RA");
            if (nRAIndex < 0 || nRAIndex + 2 >= nCount)
            {
                CSLDestroy(papszTokens);
                CPLError(CE_Failure, CPLE_AppDefined,
                         "Failed to extract RA from BSB/ line.");
                BSBClose(psInfo);
                return NULL;
            }
            psInfo->nXSize = atoi(papszTokens[nRAIndex + 1]);
            psInfo->nYSize = atoi(papszTokens[nRAIndex + 2]);
        }
        else if (STARTS_WITH_CI(szLine, "NOS/"))
        {
            int nRAIndex;

            nRAIndex = CSLFindString(papszTokens, "RA");
            if (nRAIndex < 0 || nRAIndex + 4 >= nCount)
            {
                CSLDestroy(papszTokens);
                CPLError(CE_Failure, CPLE_AppDefined,
                         "Failed to extract RA from NOS/ line.");
                BSBClose(psInfo);
                return NULL;
            }
            psInfo->nXSize = atoi(papszTokens[nRAIndex + 3]);
            psInfo->nYSize = atoi(papszTokens[nRAIndex + 4]);
        }
        else if (EQUALN(szLine, pszPalette, 3) && szLine[0] != '\0' &&
                 szLine[1] != '\0' && szLine[2] != '\0' && szLine[3] == '/' &&
                 nCount >= 4)
        {
            int iPCT = atoi(papszTokens[0]);
            if (iPCT < 0 || iPCT > 128)
            {
                CSLDestroy(papszTokens);
                CPLError(CE_Failure, CPLE_AppDefined,
                         "BSBOpen : Invalid color table index. Probably due to "
                         "corrupted BSB file (iPCT = %d).",
                         iPCT);
                BSBClose(psInfo);
                return NULL;
            }
            if (iPCT > psInfo->nPCTSize - 1)
            {
                unsigned char *pabyNewPCT =
                    (unsigned char *)VSI_REALLOC_VERBOSE(psInfo->pabyPCT,
                                                         (iPCT + 1) * 3);
                if (pabyNewPCT == NULL)
                {
                    CSLDestroy(papszTokens);
                    BSBClose(psInfo);
                    return NULL;
                }
                psInfo->pabyPCT = pabyNewPCT;
                memset(psInfo->pabyPCT + psInfo->nPCTSize * 3, 0,
                       (iPCT + 1 - psInfo->nPCTSize) * 3);
                psInfo->nPCTSize = iPCT + 1;
            }

            psInfo->pabyPCT[iPCT * 3 + 0] = (unsigned char)atoi(papszTokens[1]);
            psInfo->pabyPCT[iPCT * 3 + 1] = (unsigned char)atoi(papszTokens[2]);
            psInfo->pabyPCT[iPCT * 3 + 2] = (unsigned char)atoi(papszTokens[3]);
        }
        else if (STARTS_WITH_CI(szLine, "VER/") && nCount >= 1)
        {
            psInfo->nVersion = (int)(100 * CPLAtof(papszTokens[0]) + 0.5);
        }

        CSLDestroy(papszTokens);
    }

    /* -------------------------------------------------------------------- */
    /*      Verify we found required keywords.                              */
    /* -------------------------------------------------------------------- */
    if (psInfo->nXSize == 0 || psInfo->nPCTSize == 0)
    {
        BSBClose(psInfo);
        CPLError(CE_Failure, CPLE_AppDefined,
                 "Failed to find required RGB/ or BSB/ keyword in header.");

        return NULL;
    }

    if (psInfo->nXSize <= 0 || psInfo->nYSize <= 0)
    {
        CPLError(CE_Failure, CPLE_AppDefined,
                 "Wrong dimensions found in header : %d x %d.", psInfo->nXSize,
                 psInfo->nYSize);
        BSBClose(psInfo);
        return NULL;
    }

    if (psInfo->nVersion == 0)
    {
        CPLError(CE_Warning, CPLE_AppDefined,
                 "VER (version) keyword not found, assuming 2.0.");
        psInfo->nVersion = 200;
    }

    /* -------------------------------------------------------------------- */
    /*      If all has gone well this far, we should be pointing at the     */
    /*      sequence "0x1A 0x00".  Read past to get to start of data.       */
    /*                                                                      */
    /*      We actually do some funny stuff here to be able to read past    */
    /*      some garbage to try and find the 0x1a 0x00 sequence since in    */
    /*      at least some files (i.e. optech/World.kap) we find a few       */
    /*      bytes of extra junk in the way.                                 */
    /* -------------------------------------------------------------------- */
    /* from optech/World.kap

       11624: 30333237 34353938 2C302E30 35373836 03274598,0.05786
       11640: 39303232 38332C31 332E3135 39363435 902283,13.159645
       11656: 35390D0A 1A0D0A1A 00040190 C0510002 59~~~~~~~~~~~Q~~
       11672: 90C05100 0390C051 000490C0 51000590 ~~Q~~~~Q~~~~Q~~~
     */

    {
        int nChar = -1;

        while (nSkipped < 100 &&
               (BSBGetc(psInfo, bNO1, &bErrorFlag) != 0x1A ||
                (nChar = BSBGetc(psInfo, bNO1, &bErrorFlag)) != 0x00) &&
               !bErrorFlag)
        {
            if (nChar == 0x1A)
            {
                BSBUngetc(psInfo, nChar);
                nChar = -1;
            }
            nSkipped++;
        }

        if (bErrorFlag)
        {
            BSBClose(psInfo);
            CPLError(CE_Failure, CPLE_FileIO,
                     "Truncated BSB file or I/O error.");
            return NULL;
        }

        if (nSkipped == 100)
        {
            BSBClose(psInfo);
            CPLError(CE_Failure, CPLE_AppDefined,
                     "Failed to find compressed data segment of BSB file.");
            return NULL;
        }
    }

    /* -------------------------------------------------------------------- */
    /*      Read the number of bit size of color numbers.                   */
    /* -------------------------------------------------------------------- */
    psInfo->nColorSize = BSBGetc(psInfo, bNO1, NULL);

    /* The USGS files like 83116_1.KAP seem to use the ASCII number instead
       of the binary number for the colorsize value. */

    if (nSkipped > 0 && psInfo->nColorSize >= 0x31 &&
        psInfo->nColorSize <= 0x38)
        psInfo->nColorSize -= 0x30;

    if (!(psInfo->nColorSize > 0 && psInfo->nColorSize <= 7))
    {
        CPLError(CE_Failure, CPLE_AppDefined,
                 "BSBOpen : Bad value for nColorSize (%d). Probably due to "
                 "corrupted BSB file",
                 psInfo->nColorSize);
        BSBClose(psInfo);
        return NULL;
    }

    /* -------------------------------------------------------------------- */
    /*      Initialize memory for line offset list.                         */
    /* -------------------------------------------------------------------- */
    if (psInfo->nYSize > 10000000)
    {
        vsi_l_offset nCurOffset = VSIFTellL(fp);
        vsi_l_offset nFileSize;
        VSIFSeekL(fp, 0, SEEK_END);
        nFileSize = VSIFTellL(fp);
        if (nFileSize < (vsi_l_offset)(psInfo->nYSize))
        {
            CPLError(CE_Failure, CPLE_AppDefined, "Truncated file");
            BSBClose(psInfo);
            return NULL;
        }
        VSIFSeekL(fp, nCurOffset, SEEK_SET);
    }
    psInfo->panLineOffset =
        (int *)VSI_MALLOC2_VERBOSE(sizeof(int), psInfo->nYSize);
    if (psInfo->panLineOffset == NULL)
    {
        BSBClose(psInfo);
        return NULL;
    }

    /* This is the offset to the data of first line, if there is no index table
     */
    nOffsetFirstLine =
        (int)(VSIFTellL(fp) - psInfo->nBufferSize) + psInfo->nBufferOffset;

    /* -------------------------------------------------------------------- */
    /*       Read the line offset list                                      */
    /* -------------------------------------------------------------------- */
    if (!CPLTestBoolean(CPLGetConfigOption("BSB_DISABLE_INDEX", "NO")))
    {
        /* build the list from file's index table */
        /* To overcome endian compatibility issues individual
         * bytes are being read instead of the whole integers. */
        int nVal;
        int listIsOK = 1;
        int nOffsetIndexTable;
        vsi_l_offset nFileLenLarge;
        int nFileLen;

        /* Seek fp to point the last 4 byte integer which points
         * the offset of the first line */
        VSIFSeekL(fp, 0, SEEK_END);
        nFileLenLarge = VSIFTellL(fp);
        if (nFileLenLarge > INT_MAX)
        {
            // Potentially the format could support up to 32 bit unsigned ?
            BSBClose(psInfo);
            return NULL;
        }
        nFileLen = (int)nFileLenLarge;
        VSIFSeekL(fp, nFileLen - 4, SEEK_SET);

        VSIFReadL(&nVal, 1, 4, fp);  // last 4 bytes
        CPL_MSBPTR32(&nVal);
        nOffsetIndexTable = nVal;

        /* For some charts, like 1115A_1.KAP, coming from */
        /* http://www.nauticalcharts.noaa.gov/mcd/Raster/index.htm, */
        /* the index table can have one row less than nYSize */
        /* If we look into the file closely, there is no data for */
        /* that last row (the end of line psInfo->nYSize - 1 is the start */
        /* of the index table), so we can decrement psInfo->nYSize. */
        if (nOffsetIndexTable <= 0 || psInfo->nYSize > INT_MAX / 4 ||
            4 * psInfo->nYSize > INT_MAX - nOffsetIndexTable)
        {
            /* int32 overflow */
            BSBClose(psInfo);
            return NULL;
        }
        if (nOffsetIndexTable + 4 * (psInfo->nYSize - 1) == nFileLen - 4)
        {
            CPLDebug("BSB", "Index size is one row shorter than declared image "
                            "height. Correct this");
            psInfo->nYSize--;
        }

        if (nOffsetIndexTable <= nOffsetFirstLine ||
            nOffsetIndexTable + 4 * psInfo->nYSize > nFileLen - 4)
        {
            /* The last 4 bytes are not the value of the offset to the index
             * table */
        }
        else if (VSIFSeekL(fp, nOffsetIndexTable, SEEK_SET) != 0)
        {
            CPLError(CE_Failure, CPLE_FileIO,
                     "Seek to offset 0x%08x for first line offset failed.",
                     nOffsetIndexTable);
        }
        else
        {
            int nIndexSize = (nFileLen - 4 - nOffsetIndexTable) / 4;
            if (nIndexSize != psInfo->nYSize)
            {
                CPLDebug("BSB", "Index size is %d. Expected %d", nIndexSize,
                         psInfo->nYSize);
            }

            for (i = 0; i < psInfo->nYSize; i++)
            {
                VSIFReadL(&nVal, 1, 4, fp);
                CPL_MSBPTR32(&nVal);
                psInfo->panLineOffset[i] = nVal;
            }
            /* Simple checks for the integrity of the list */
            for (i = 0; i < psInfo->nYSize; i++)
            {
                if (psInfo->panLineOffset[i] < nOffsetFirstLine ||
                    psInfo->panLineOffset[i] >= nOffsetIndexTable ||
                    (i < psInfo->nYSize - 1 &&
                     psInfo->panLineOffset[i] > psInfo->panLineOffset[i + 1]) ||
                    !BSBSeekAndCheckScanlineNumber(psInfo, i, FALSE))
                {
                    CPLDebug("BSB", "Index table is invalid at index %d", i);
                    listIsOK = 0;
                    break;
                }
            }
            if (listIsOK)
            {
                CPLDebug("BSB", "Index table is valid");
                return psInfo;
            }
        }
    }

    /* If we can't build the offset list for some reason we just
     * initialize the offset list to indicate "no value" (except for the first).
     */
    psInfo->panLineOffset[0] = nOffsetFirstLine;
    for (i = 1; i < psInfo->nYSize; i++)
        psInfo->panLineOffset[i] = -1;

    return psInfo;
}

/************************************************************************/
/*                         BSBReadHeaderLine()                          */
/*                                                                      */
/*      Read one virtual line of text from the BSB header.  This        */
/*      will end if a 0x1A 0x00 (EOF) is encountered, indicating the    */
/*      data is about to start.  It will also merge multiple physical   */
/*      lines where appropriate.                                        */
/************************************************************************/

static int BSBReadHeaderLine(BSBInfo *psInfo, char *pszLine, int nLineMaxLen,
                             int bNO1)

{
    char chNext;
    int nLineLen = 0;
    bool bGot1A = false;
    while (!VSIFEofL(psInfo->fp) && nLineLen < nLineMaxLen - 1)
    {
        chNext = (char)BSBGetc(psInfo, bNO1, NULL);
        /* '\0' is not really expected at this point in correct products */
        /* but we must escape if found. */
        if (chNext == '\0')
        {
            BSBUngetc(psInfo, chNext);
            if (bGot1A)
                BSBUngetc(psInfo, 0x1A);
            return FALSE;
        }
        bGot1A = false;

        if (chNext == 0x1A)
        {
            bGot1A = true;
            continue;
        }

        /* each CR/LF (or LF/CR) as if just "CR" */
        if (chNext == 10 || chNext == 13)
        {
            char chLF;

            chLF = (char)BSBGetc(psInfo, bNO1, NULL);
            if (chLF != 10 && chLF != 13)
                BSBUngetc(psInfo, chLF);
            chNext = '\n';
        }

        /* If we are at the end-of-line, check for blank at start
        ** of next line, to indicate need of continuation.
        */
        if (chNext == '\n')
        {
            char chTest;

            chTest = (char)BSBGetc(psInfo, bNO1, NULL);
            /* Are we done? */
            if (chTest != ' ')
            {
                BSBUngetc(psInfo, chTest);
                pszLine[nLineLen] = '\0';
                return TRUE;
            }

            /* eat pending spaces */
            while (chTest == ' ')
                chTest = (char)BSBGetc(psInfo, bNO1, NULL);
            BSBUngetc(psInfo, chTest);

            /* insert comma in data stream */
            pszLine[nLineLen++] = ',';
        }
        else
        {
            pszLine[nLineLen++] = chNext;
        }
    }

    return FALSE;
}

/************************************************************************/
/*                  BSBSeekAndCheckScanlineNumber()                     */
/*                                                                      */
/*       Seek to the beginning of the scanline and check that the       */
/*       scanline number in file is consistent with what we expect      */
/*                                                                      */
/* @param nScanline zero based line number                              */
/************************************************************************/

CPL_NOSANITIZE_UNSIGNED_INT_OVERFLOW
static unsigned UpdateLineMarker(unsigned nLineMarker, int byNext)
{
    return nLineMarker * 128U + (unsigned)(byNext & 0x7f);
}

static int BSBSeekAndCheckScanlineNumber(BSBInfo *psInfo, unsigned nScanline,
                                         int bVerboseIfError)
{
    unsigned nLineMarker = 0;
    int byNext;
    VSILFILE *fp = psInfo->fp;
    int bErrorFlag = FALSE;

    /* -------------------------------------------------------------------- */
    /*      Seek to requested scanline.                                     */
    /* -------------------------------------------------------------------- */
    psInfo->nBufferSize = 0;
    if (VSIFSeekL(fp, psInfo->panLineOffset[nScanline], SEEK_SET) != 0)
    {
        if (bVerboseIfError)
        {
            CPLError(CE_Failure, CPLE_FileIO,
                     "Seek to offset %d for scanline %d failed.",
                     psInfo->panLineOffset[nScanline], nScanline);
        }
        else
        {
            CPLDebug("BSB", "Seek to offset %d for scanline %d failed.",
                     psInfo->panLineOffset[nScanline], nScanline);
        }
        return FALSE;
    }

    /* -------------------------------------------------------------------- */
    /*      Read the line number.  Pre 2.0 BSB seemed to expect the line    */
    /*      numbers to be zero based, while 2.0 and later seemed to         */
    /*      expect it to be one based, and for a 0 to be some sort of       */
    /*      missing line marker.                                            */
    /* -------------------------------------------------------------------- */
    do
    {
        byNext = BSBGetc(psInfo, psInfo->bNO1, &bErrorFlag);

        /* Special hack to skip over extra zeros in some files, such
        ** as optech/sample1.kap.
        */
        while (nScanline != 0 && nLineMarker == 0 && byNext == 0 && !bErrorFlag)
            byNext = BSBGetc(psInfo, psInfo->bNO1, &bErrorFlag);

        nLineMarker = UpdateLineMarker(nLineMarker, byNext);
    } while ((byNext & 0x80) != 0);

    if (bErrorFlag)
    {
        if (bVerboseIfError)
        {
            CPLError(CE_Failure, CPLE_FileIO,
                     "Truncated BSB file or I/O error.");
        }
        return FALSE;
    }
    if (nLineMarker != nScanline && nLineMarker != nScanline + 1)
    {
        int bIgnoreLineNumbers =
            CPLTestBoolean(CPLGetConfigOption("BSB_IGNORE_LINENUMBERS", "NO"));

        if (bVerboseIfError && !bIgnoreLineNumbers)
        {
            CPLError(CE_Failure, CPLE_AppDefined,
                     "Got scanline id %u when looking for %u @ offset %d.\nSet "
                     "BSB_IGNORE_LINENUMBERS=TRUE configuration option to try "
                     "file anyways.",
                     nLineMarker, nScanline + 1,
                     psInfo->panLineOffset[nScanline]);
        }
        else
        {
            CPLDebug(
                "BSB", "Got scanline id %u when looking for %u @ offset %d.",
                nLineMarker, nScanline + 1, psInfo->panLineOffset[nScanline]);
        }

        if (!bIgnoreLineNumbers)
            return FALSE;
    }

    return TRUE;
}

/************************************************************************/
/*                          BSBReadScanline()                           */
/* @param nScanline zero based line number                              */
/************************************************************************/

int BSBReadScanline(BSBInfo *psInfo, int nScanline,
                    unsigned char *pabyScanlineBuf)

{
    int nValueShift, iPixel = 0;
    unsigned char byValueMask, byCountMask;
    VSILFILE *fp = psInfo->fp;
    int byNext, i;

    /* -------------------------------------------------------------------- */
    /*      Do we know where the requested line is?  If not, read all       */
    /*      the preceding ones to "find" our line.                          */
    /* -------------------------------------------------------------------- */
    if (nScanline < 0 || nScanline >= psInfo->nYSize)
    {
        CPLError(CE_Failure, CPLE_FileIO, "Scanline %d out of range.",
                 nScanline);
        return FALSE;
    }

    if (psInfo->panLineOffset[nScanline] == -1)
    {
        for (i = 0; i < nScanline; i++)
        {
            if (psInfo->panLineOffset[i + 1] == -1)
            {
                if (!BSBReadScanline(psInfo, i, pabyScanlineBuf))
                    return FALSE;
            }
        }
    }

    /* -------------------------------------------------------------------- */
    /*       Seek to the beginning of the scanline and check that the       */
    /*       scanline number in file is consistent with what we expect      */
    /* -------------------------------------------------------------------- */
    if (!BSBSeekAndCheckScanlineNumber(psInfo, nScanline, TRUE))
    {
        return FALSE;
    }

    /* -------------------------------------------------------------------- */
    /*      Setup masking values.                                           */
    /* -------------------------------------------------------------------- */
    nValueShift = 7 - psInfo->nColorSize;
    byValueMask =
        (unsigned char)((((1 << psInfo->nColorSize)) - 1) << nValueShift);
    byCountMask = (unsigned char)(1 << (7 - psInfo->nColorSize)) - 1;

    /* -------------------------------------------------------------------- */
    /*      Read and expand runs.                                           */
    /*      If for some reason the buffer is not filled,                    */
    /*      just repeat the process until the buffer is filled.             */
    /*      This is the case for IS1612_4.NOS (#2782)                       */
    /* -------------------------------------------------------------------- */
    do
    {
        int bErrorFlag = FALSE;
        while ((byNext = BSBGetc(psInfo, psInfo->bNO1, &bErrorFlag)) != 0 &&
               !bErrorFlag)
        {
            int nPixValue;
            int nRunCount;

            nPixValue = (byNext & byValueMask) >> nValueShift;

            nRunCount = byNext & byCountMask;

            while ((byNext & 0x80) != 0 && !bErrorFlag)
            {
                byNext = BSBGetc(psInfo, psInfo->bNO1, &bErrorFlag);
                if (nRunCount > (INT_MAX - (byNext & 0x7f)) / 128)
                {
                    CPLError(CE_Failure, CPLE_FileIO, "Corrupted run count");
                    return FALSE;
                }
                nRunCount = nRunCount * 128 + (byNext & 0x7f);
            }

            /* Prevent over-run of line data */
            if (nRunCount < 0 || nRunCount > INT_MAX - (iPixel + 1))
            {
                CPLError(CE_Failure, CPLE_FileIO, "Corrupted run count : %d",
                         nRunCount);
                return FALSE;
            }
            if (nRunCount > psInfo->nXSize)
            {
                CPLDebugOnce("BSB", "Too big run count : %d", nRunCount);
            }

            if (iPixel + nRunCount + 1 > psInfo->nXSize)
                nRunCount = psInfo->nXSize - iPixel - 1;

            for (i = 0; i < nRunCount + 1; i++)
                pabyScanlineBuf[iPixel++] = (unsigned char)nPixValue;
        }
        if (bErrorFlag)
        {
            CPLError(CE_Failure, CPLE_FileIO,
                     "Truncated BSB file or I/O error.");
            return FALSE;
        }

        /* --------------------------------------------------------------------
         */
        /*      For reasons that are unclear, some scanlines are exactly one */
        /*      pixel short (such as in the BSB 3.0 354704.KAP product from */
        /*      NDI/CHS) but are otherwise OK.  Just add a zero if this */
        /*      appear to have occurred. */
        /* --------------------------------------------------------------------
         */
        if (iPixel == psInfo->nXSize - 1)
            pabyScanlineBuf[iPixel++] = 0;

        /* --------------------------------------------------------------------
         */
        /*   If we have not enough data and no offset table, check that the */
        /*   next bytes are not the expected next scanline number. If they are
         */
        /*   not, then we can use them to fill the row again */
        /* --------------------------------------------------------------------
         */
        else if (iPixel < psInfo->nXSize && nScanline != psInfo->nYSize - 1 &&
                 psInfo->panLineOffset[nScanline + 1] == -1)
        {
            int nCurOffset = (int)(VSIFTellL(fp) - psInfo->nBufferSize) +
                             psInfo->nBufferOffset;
            psInfo->panLineOffset[nScanline + 1] = nCurOffset;
            if (BSBSeekAndCheckScanlineNumber(psInfo, nScanline + 1, FALSE))
            {
                CPLDebug("BSB",
                         "iPixel=%d, nScanline=%d, nCurOffset=%d --> found new "
                         "row marker",
                         iPixel, nScanline, nCurOffset);
                break;
            }
            else
            {
                CPLDebug("BSB",
                         "iPixel=%d, nScanline=%d, nCurOffset=%d --> did NOT "
                         "find new row marker",
                         iPixel, nScanline, nCurOffset);

                /* The next bytes are not the expected next scanline number, so
                 */
                /* use them to fill the row */
                VSIFSeekL(fp, nCurOffset, SEEK_SET);
                psInfo->panLineOffset[nScanline + 1] = -1;
                psInfo->nBufferOffset = 0;
                psInfo->nBufferSize = 0;
            }
        }
    } while (iPixel < psInfo->nXSize &&
             (nScanline == psInfo->nYSize - 1 ||
              psInfo->panLineOffset[nScanline + 1] == -1 ||
              VSIFTellL(fp) - psInfo->nBufferSize + psInfo->nBufferOffset <
                  (vsi_l_offset)psInfo->panLineOffset[nScanline + 1]));

    /* -------------------------------------------------------------------- */
    /*      If the line buffer is not filled after reading the line in the  */
    /*      file up to the next line offset, just fill it with zeros.       */
    /*      (The last pixel value from nPixValue could be a better value?)  */
    /* -------------------------------------------------------------------- */
    while (iPixel < psInfo->nXSize)
        pabyScanlineBuf[iPixel++] = 0;

    /* -------------------------------------------------------------------- */
    /*      Remember the start of the next line.                            */
    /*      But only if it is not already known.                            */
    /* -------------------------------------------------------------------- */
    if (nScanline < psInfo->nYSize - 1 &&
        psInfo->panLineOffset[nScanline + 1] == -1)
    {
        psInfo->panLineOffset[nScanline + 1] =
            (int)(VSIFTellL(fp) - psInfo->nBufferSize) + psInfo->nBufferOffset;
    }

    return TRUE;
}

/************************************************************************/
/*                              BSBClose()                              */
/************************************************************************/

void BSBClose(BSBInfo *psInfo)

{
    if (psInfo->fp != NULL)
        VSIFCloseL(psInfo->fp);

    CPLFree(psInfo->pabyBuffer);

    CSLDestroy(psInfo->papszHeader);
    CPLFree(psInfo->panLineOffset);
    CPLFree(psInfo->pabyPCT);
    CPLFree(psInfo);
}

/************************************************************************/
/*                             BSBCreate()                              */
/************************************************************************/

BSBInfo *BSBCreate(const char *pszFilename, CPL_UNUSED int nCreationFlags,
                   int nVersion, int nXSize, int nYSize)
{
    VSILFILE *fp;
    BSBInfo *psInfo;

    /* -------------------------------------------------------------------- */
    /*      Open new KAP file.                                              */
    /* -------------------------------------------------------------------- */
    fp = VSIFOpenL(pszFilename, "wb");
    if (fp == NULL)
    {
        CPLError(CE_Failure, CPLE_OpenFailed, "Failed to open output file %s.",
                 pszFilename);
        return NULL;
    }

    /* -------------------------------------------------------------------- */
    /*      Write out BSB line.                                             */
    /* -------------------------------------------------------------------- */
    VSIFPrintfL(fp, "!Copyright unknown\n");
    VSIFPrintfL(fp, "VER/%.1f\n", nVersion / 100.0);
    VSIFPrintfL(fp, "BSB/NA=UNKNOWN,NU=999502,RA=%d,%d,DU=254\n", nXSize,
                nYSize);
    VSIFPrintfL(fp, "KNP/SC=25000,GD=WGS84,PR=Mercator\n");
    VSIFPrintfL(fp,
                "    PP=31.500000,PI=0.033333,SP=,SK=0.000000,TA=90.000000\n");
    VSIFPrintfL(fp, "     UN=Metres,SD=HHWLT,DX=2.500000,DY=2.500000\n");

    /* -------------------------------------------------------------------- */
    /*      Create info structure.                                          */
    /* -------------------------------------------------------------------- */
    psInfo = (BSBInfo *)CPLCalloc(1, sizeof(BSBInfo));
    psInfo->fp = fp;
    psInfo->bNO1 = FALSE;
    psInfo->nVersion = nVersion;
    psInfo->nXSize = nXSize;
    psInfo->nYSize = nYSize;
    psInfo->bNewFile = TRUE;
    psInfo->nLastLineWritten = -1;

    return psInfo;
}

/************************************************************************/
/*                            BSBWritePCT()                             */
/************************************************************************/

int BSBWritePCT(BSBInfo *psInfo, int nPCTSize, unsigned char *pabyPCT)

{
    int i;

    /* -------------------------------------------------------------------- */
    /*      Verify the PCT not too large.                                   */
    /* -------------------------------------------------------------------- */
    if (nPCTSize > 128)
    {
        CPLError(CE_Failure, CPLE_AppDefined,
                 "Pseudo-color table too large (%d entries), at most 128\n"
                 " entries allowed in BSB format.",
                 nPCTSize);
        return FALSE;
    }

    /* -------------------------------------------------------------------- */
    /*      Compute the number of bits required for the colors.             */
    /* -------------------------------------------------------------------- */
    for (psInfo->nColorSize = 1; (1 << psInfo->nColorSize) < nPCTSize;
         psInfo->nColorSize++)
    {
    }

    /* -------------------------------------------------------------------- */
    /*      Write out the color table.  Note that color table entry zero    */
    /*      is ignored.  Zero is not a legal value.                         */
    /* -------------------------------------------------------------------- */
    for (i = 1; i < nPCTSize; i++)
    {
        VSIFPrintfL(psInfo->fp, "RGB/%d,%d,%d,%d\n", i, pabyPCT[i * 3 + 0],
                    pabyPCT[i * 3 + 1], pabyPCT[i * 3 + 2]);
    }

    return TRUE;
}

/************************************************************************/
/*                          BSBWriteScanline()                          */
/************************************************************************/

int BSBWriteScanline(BSBInfo *psInfo, unsigned char *pabyScanlineBuf)

{
    int nValue, iX;

    if (psInfo->nLastLineWritten == psInfo->nYSize - 1)
    {
        CPLError(CE_Failure, CPLE_AppDefined,
                 "Attempt to write too many scanlines.");
        return FALSE;
    }

    /* -------------------------------------------------------------------- */
    /*      If this is the first scanline written out the EOF marker, and   */
    /*      the introductory info in the image segment.                     */
    /* -------------------------------------------------------------------- */
    if (psInfo->nLastLineWritten == -1)
    {
        VSIFPutcL(0x1A, psInfo->fp);
        VSIFPutcL(0x00, psInfo->fp);
        VSIFPutcL(psInfo->nColorSize, psInfo->fp);
    }

    /* -------------------------------------------------------------------- */
    /*      Write the line number.                                          */
    /* -------------------------------------------------------------------- */
    nValue = ++psInfo->nLastLineWritten;

    if (psInfo->nVersion >= 200)
        nValue++;

    if (nValue >= 128 * 128)
        VSIFPutcL(0x80 | ((nValue & (0x7f << 14)) >> 14), psInfo->fp);
    if (nValue >= 128)
        VSIFPutcL(0x80 | ((nValue & (0x7f << 7)) >> 7), psInfo->fp);
    VSIFPutcL(nValue & 0x7f, psInfo->fp);

    /* -------------------------------------------------------------------- */
    /*      Write out each pixel as a separate byte.  We don't try to       */
    /*      actually capture the runs since that radical and futuristic     */
    /*      concept is patented!                                            */
    /* -------------------------------------------------------------------- */
    for (iX = 0; iX < psInfo->nXSize; iX++)
    {
        VSIFPutcL(pabyScanlineBuf[iX] << (7 - psInfo->nColorSize), psInfo->fp);
    }

    VSIFPutcL(0x00, psInfo->fp);

    return TRUE;
}

Coverage Report

Created: 2026-02-14 09:00