Line data    Source code

       1             : /*
       2             :  * Copyright (c) 2002-2012, California Institute of Technology.
       3             :  * All rights reserved.  Based on Government Sponsored Research under contracts
       4             :  * NAS7-1407 and/or NAS7-03001.
       5             :  *
       6             :  * Redistribution and use in source and binary forms, with or without
       7             :  * modification, are permitted provided that the following conditions are met:
       8             :  *   1. Redistributions of source code must retain the above copyright notice,
       9             :  * this list of conditions and the following disclaimer.
      10             :  *   2. Redistributions in binary form must reproduce the above copyright
      11             :  * notice, this list of conditions and the following disclaimer in the
      12             :  * documentation and/or other materials provided with the distribution.
      13             :  *   3. Neither the name of the California Institute of Technology (Caltech),
      14             :  * its operating division the Jet Propulsion Laboratory (JPL), the National
      15             :  * Aeronautics and Space Administration (NASA), nor the names of its
      16             :  * contributors may be used to endorse or promote products derived from this
      17             :  * software without specific prior written permission.
      18             :  *
      19             :  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
      20             :  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
      21             :  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
      22             :  * ARE DISCLAIMED. IN NO EVENT SHALL THE CALIFORNIA INSTITUTE OF TECHNOLOGY BE
      23             :  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
      24             :  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
      25             :  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
      26             :  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
      27             :  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
      28             :  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
      29             :  * POSSIBILITY OF SUCH DAMAGE.
      30             :  *
      31             :  * Copyright (c) 2014-2021 Esri
      32             :  *
      33             :  * Licensed under the Apache License, Version 2.0 (the "License");
      34             :  * you may not use this file except in compliance with the License.
      35             :  * You may obtain a copy of the License at
      36             :  *
      37             :  * http://www.apache.org/licenses/LICENSE-2.0
      38             :  *
      39             :  * Unless required by applicable law or agreed to in writing, software
      40             :  * distributed under the License is distributed on an "AS IS" BASIS,
      41             :  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      42             :  * See the License for the specific language governing permissions and
      43             :  * limitations under the License.
      44             :  *
      45             :  * Author: Lucian Plesea
      46             :  *
      47             :  */
      48             : 
      49             : /*
      50             :  * PNG band
      51             :  * PNG page compression and decompression functions
      52             :  * These functions are not methods, they reside in the global space
      53             :  *
      54             :  */
      55             : 
      56             : #include "marfa.h"
      57             : #include <cassert>
      58             : #include <algorithm>
      59             : 
      60             : CPL_C_START
      61             : #include <png.h>
      62             : CPL_C_END
      63             : 
      64             : NAMESPACE_MRF_START
      65             : 
      66             : // Do Nothing
      67           0 : static void flush_png(png_structp)
      68             : {
      69           0 : }
      70             : 
      71             : // Warning Emit
      72           0 : static void pngWH(png_struct * /*png*/, png_const_charp message)
      73             : {
      74           0 :     CPLError(CE_Warning, CPLE_AppDefined, "MRF: PNG warning %s", message);
      75           0 : }
      76             : 
      77             : // Fatal Warning
      78           0 : static void pngEH(png_struct *png, png_const_charp message)
      79             : {
      80           0 :     CPLError(CE_Failure, CPLE_AppDefined, "MRF: PNG Failure %s", message);
      81           0 :     longjmp(png_jmpbuf(png), 1);
      82             : }
      83             : 
      84             : // Read memory handlers for PNG
      85             : // No check for attempting to read past the end of the buffer
      86             : 
      87         321 : static void read_png(png_structp pngp, png_bytep data, png_size_t length)
      88             : {
      89         321 :     buf_mgr *pmgr = (buf_mgr *)png_get_io_ptr(pngp);
      90         321 :     if (pmgr->size < length)
      91             :     {
      92           0 :         CPLError(CE_Failure, CPLE_AppDefined,
      93             :                  "MRF: PNG Failure: Not enough bytes in buffer");
      94           0 :         longjmp(png_jmpbuf(pngp), 1);
      95             :     }
      96         321 :     memcpy(data, pmgr->buffer, length);
      97         321 :     pmgr->buffer += length;
      98         321 :     pmgr->size -= length;
      99         321 : }
     100             : 
     101         420 : static void write_png(png_structp pngp, png_bytep data, png_size_t length)
     102             : {
     103         420 :     buf_mgr *mgr = (buf_mgr *)png_get_io_ptr(pngp);
     104             :     // Buffer could be too small, trigger an error on debug mode
     105         420 :     assert(length <= mgr->size);
     106         420 :     memcpy(mgr->buffer, data, length);
     107         420 :     mgr->buffer += length;
     108         420 :     mgr->size -= length;
     109         420 : }
     110             : 
     111             : /**
     112             :  *\brief In memory decompression of PNG file
     113             :  */
     114             : 
     115          11 : CPLErr PNG_Codec::DecompressPNG(buf_mgr &dst, buf_mgr &src)
     116             : {
     117          11 :     const buf_mgr src_ori = src;
     118          11 :     png_bytep *png_rowp = nullptr;
     119          11 :     volatile png_bytep *p_volatile_png_rowp = (volatile png_bytep *)&png_rowp;
     120             : 
     121             :     // pngp=png_create_read_struct(PNG_LIBPNG_VER_STRING,0,pngEH,pngWH);
     122          11 :     png_structp pngp = png_create_read_struct(PNG_LIBPNG_VER_STRING, nullptr,
     123          11 :                                               nullptr, nullptr);
     124          11 :     if (nullptr == pngp)
     125             :     {
     126           0 :         CPLError(CE_Failure, CPLE_AppDefined,
     127             :                  "MRF: Error creating PNG decompress");
     128           0 :         return CE_Failure;
     129             :     }
     130             : 
     131          11 :     png_infop infop = png_create_info_struct(pngp);
     132          11 :     if (nullptr == infop)
     133             :     {
     134           0 :         png_destroy_read_struct(&pngp, &infop, nullptr);
     135           0 :         CPLError(CE_Failure, CPLE_AppDefined, "MRF: Error creating PNG info");
     136           0 :         return CE_Failure;
     137             :     }
     138             : 
     139          11 :     if (setjmp(png_jmpbuf(pngp)))
     140             :     {
     141           0 :         CPLError(CE_Failure, CPLE_AppDefined,
     142             :                  "MRF: Error during PNG decompress");
     143           0 :         CPLFree((void *)(*p_volatile_png_rowp));
     144           0 :         png_destroy_read_struct(&pngp, &infop, nullptr);
     145           0 :         return CE_Failure;
     146             :     }
     147             : 
     148             :     // The mgr data ptr is already set up
     149          11 :     png_set_read_fn(pngp, &src, read_png);
     150             :     // Ready to read
     151          11 :     png_read_info(pngp, infop);
     152             : 
     153          11 :     if (png_get_bit_depth(pngp, infop) == 8)
     154             :     {
     155             :         // Use the PNG driver for decompression of 8-bit images, as it
     156             :         // has optimizations for whole image decompression.
     157           9 :         const CPLString osTmpFilename(VSIMemGenerateHiddenFilename("mrf.png"));
     158           9 :         VSIFCloseL(VSIFileFromMemBuffer(
     159           9 :             osTmpFilename.c_str(), reinterpret_cast<GByte *>(src_ori.buffer),
     160           9 :             src_ori.size, false));
     161           9 :         const char *const apszAllowedDrivers[] = {"PNG", nullptr};
     162             :         auto poDS = std::unique_ptr<GDALDataset>(GDALDataset::Open(
     163           9 :             osTmpFilename.c_str(), GDAL_OF_RASTER, apszAllowedDrivers));
     164          18 :         if (poDS && static_cast<GUIntBig>(poDS->GetRasterXSize()) *
     165           9 :                             poDS->GetRasterYSize() * poDS->GetRasterCount() ==
     166          18 :                         dst.size)
     167             :         {
     168          27 :             if (poDS->RasterIO(
     169             :                     GF_Read, 0, 0, poDS->GetRasterXSize(),
     170           9 :                     poDS->GetRasterYSize(), dst.buffer, poDS->GetRasterXSize(),
     171             :                     poDS->GetRasterYSize(), GDT_Byte, poDS->GetRasterCount(),
     172          18 :                     nullptr, poDS->GetRasterCount(), 0, 1, nullptr) == CE_None)
     173             :             {
     174           9 :                 png_destroy_read_struct(&pngp, &infop, nullptr);
     175           9 :                 VSIUnlink(osTmpFilename.c_str());
     176           9 :                 return CE_None;
     177             :             }
     178             :         }
     179           0 :         VSIUnlink(osTmpFilename.c_str());
     180             :     }
     181             : 
     182           2 :     GInt32 height = static_cast<GInt32>(png_get_image_height(pngp, infop));
     183             :     // Check the size
     184           2 :     if (dst.size < (png_get_rowbytes(pngp, infop) * height))
     185             :     {
     186           0 :         CPLError(CE_Failure, CPLE_AppDefined,
     187             :                  "MRF: PNG Page data bigger than the buffer provided");
     188           0 :         png_destroy_read_struct(&pngp, &infop, nullptr);
     189           0 :         return CE_Failure;
     190             :     }
     191             : 
     192           2 :     png_rowp = (png_bytep *)CPLMalloc(sizeof(png_bytep) * height);
     193             : 
     194           2 :     int rowbytes = static_cast<int>(png_get_rowbytes(pngp, infop));
     195        1026 :     for (int i = 0; i < height; i++)
     196        1024 :         png_rowp[i] = (png_bytep)dst.buffer + i * rowbytes;
     197             : 
     198             : #if defined(CPL_LSB)
     199           2 :     if (png_get_bit_depth(pngp, infop) > 8)
     200             :     {
     201           2 :         png_set_swap(pngp);
     202             :         // Call update info if any png_set is used
     203           2 :         png_read_update_info(pngp, infop);
     204             :     }
     205             : #endif
     206             : 
     207             :     // Finally, the read
     208             :     // This is the lower level, the png_read_end allows some transforms
     209             :     // Like palette to RGBA
     210           2 :     png_read_image(pngp, png_rowp);
     211             : 
     212             :     //    ppmWrite("Test.ppm",(char *)data,ILSize(512,512,1,4,0));
     213             :     // Required
     214           2 :     png_read_end(pngp, infop);
     215             : 
     216             :     // png_set_rows(pngp,infop,png_rowp);
     217             :     // png_read_png(pngp,infop,PNG_TRANSFORM_IDENTITY,0);
     218             : 
     219           2 :     CPLFree(png_rowp);
     220           2 :     png_destroy_read_struct(&pngp, &infop, nullptr);
     221           2 :     return CE_None;
     222             : }
     223             : 
     224             : /**
     225             :  *\brief Compress a page in PNG format
     226             :  * Returns the compressed size in dst.size
     227             :  *
     228             :  */
     229             : 
     230          16 : CPLErr PNG_Codec::CompressPNG(buf_mgr &dst, const buf_mgr &src)
     231             : 
     232             : {
     233             :     png_structp pngp;
     234             :     png_infop infop;
     235          16 :     buf_mgr mgr = dst;
     236             : 
     237          16 :     pngp =
     238          16 :         png_create_write_struct(PNG_LIBPNG_VER_STRING, nullptr, pngEH, pngWH);
     239          16 :     if (!pngp)
     240             :     {
     241           0 :         CPLError(CE_Failure, CPLE_AppDefined,
     242             :                  "MRF: Error creating png structure");
     243           0 :         return CE_Failure;
     244             :     }
     245          16 :     infop = png_create_info_struct(pngp);
     246          16 :     if (!infop)
     247             :     {
     248           0 :         png_destroy_write_struct(&pngp, nullptr);
     249           0 :         CPLError(CE_Failure, CPLE_AppDefined,
     250             :                  "MRF: Error creating png info structure");
     251           0 :         return CE_Failure;
     252             :     }
     253             : 
     254          16 :     if (setjmp(png_jmpbuf(pngp)))
     255             :     {
     256           0 :         png_destroy_write_struct(&pngp, &infop);
     257           0 :         CPLError(CE_Failure, CPLE_AppDefined, "MRF: Error during png init");
     258           0 :         return CE_Failure;
     259             :     }
     260             : 
     261          16 :     png_set_write_fn(pngp, &mgr, write_png, flush_png);
     262             : 
     263             :     int png_ctype;
     264             : 
     265          16 :     switch (img.pagesize.c)
     266             :     {
     267          16 :         case 1:
     268          16 :             if (PNGColors != nullptr)
     269           1 :                 png_ctype = PNG_COLOR_TYPE_PALETTE;
     270             :             else
     271          15 :                 png_ctype = PNG_COLOR_TYPE_GRAY;
     272          16 :             break;
     273           0 :         case 2:
     274           0 :             png_ctype = PNG_COLOR_TYPE_GRAY_ALPHA;
     275           0 :             break;
     276           0 :         case 3:
     277           0 :             png_ctype = PNG_COLOR_TYPE_RGB;
     278           0 :             break;
     279           0 :         case 4:
     280           0 :             png_ctype = PNG_COLOR_TYPE_RGB_ALPHA;
     281           0 :             break;
     282           0 :         default:
     283             :         {  // This never happens if we check at the open
     284           0 :             CPLError(CE_Failure, CPLE_AppDefined,
     285           0 :                      "MRF:PNG Write with %d colors called", img.pagesize.c);
     286           0 :             return CE_Failure;
     287             :         }
     288             :     }
     289             : 
     290          16 :     png_set_IHDR(pngp, infop, img.pagesize.x, img.pagesize.y,
     291          16 :                  GDALGetDataTypeSize(img.dt), png_ctype, PNG_INTERLACE_NONE,
     292             :                  PNG_COMPRESSION_TYPE_BASE, PNG_FILTER_TYPE_BASE);
     293             : 
     294             :     // Optional, force certain filters only.  Makes it somewhat faster but worse
     295             :     // compression png_set_filter(pngp, PNG_FILTER_TYPE_BASE, PNG_FILTER_SUB);
     296             : 
     297             : #if defined(PNG_LIBPNG_VER) && (PNG_LIBPNG_VER > 10200) &&                     \
     298             :     defined(PNG_SELECT_READ)
     299             :     png_uint_32 mask, flags;
     300             : 
     301             :     flags = png_get_asm_flags(pngp);
     302             :     mask = png_get_asm_flagmask(PNG_SELECT_READ | PNG_SELECT_WRITE);
     303             :     png_set_asm_flags(pngp, flags | mask);  // use flags &~mask to disable all
     304             : #endif
     305             : 
     306             :     // Let the quality control the compression level
     307          16 :     png_set_compression_level(pngp, std::clamp(img.quality / 10, 1, 9));
     308             : 
     309             :     // Custom strategy for zlib, set using the band option Z_STRATEGY
     310          16 :     if (deflate_flags & ZFLAG_SMASK)
     311           0 :         png_set_compression_strategy(pngp, (deflate_flags & ZFLAG_SMASK) >> 6);
     312             : 
     313             :     // Write the palette and the transparencies if they exist
     314          16 :     if (PNGColors != nullptr)
     315             :     {
     316           1 :         png_set_PLTE(pngp, infop, (png_colorp)PNGColors, PalSize);
     317           1 :         if (TransSize != 0)
     318           0 :             png_set_tRNS(pngp, infop, (unsigned char *)PNGAlpha, TransSize,
     319             :                          nullptr);
     320             :     }
     321             : 
     322          16 :     png_write_info(pngp, infop);
     323             : 
     324             : #if defined(CPL_LSB)
     325          16 :     if (img.dt != GDT_Byte)
     326           4 :         png_set_swap(pngp);
     327             : #endif
     328             : 
     329             :     png_bytep *png_rowp =
     330          16 :         (png_bytep *)CPLMalloc(sizeof(png_bytep) * img.pagesize.y);
     331             : 
     332          16 :     if (setjmp(png_jmpbuf(pngp)))
     333             :     {
     334           0 :         CPLFree(png_rowp);
     335           0 :         png_destroy_write_struct(&pngp, &infop);
     336           0 :         CPLError(CE_Failure, CPLE_AppDefined,
     337             :                  "MRF: Error during png compression");
     338           0 :         return CE_Failure;
     339             :     }
     340             : 
     341          16 :     int rowbytes = static_cast<int>(png_get_rowbytes(pngp, infop));
     342        8208 :     for (int i = 0; i < img.pagesize.y; i++)
     343        8192 :         png_rowp[i] = (png_bytep)(src.buffer + i * rowbytes);
     344             : 
     345          16 :     png_write_image(pngp, png_rowp);
     346          16 :     png_write_end(pngp, infop);
     347             : 
     348             :     // Done
     349          16 :     CPLFree(png_rowp);
     350          16 :     png_destroy_write_struct(&pngp, &infop);
     351             : 
     352             :     // Done
     353             :     // mgr.size holds the available bytes, so the size of the compressed png
     354             :     // is the original destination size minus the still available bytes
     355          16 :     dst.size -= mgr.size;
     356             : 
     357          16 :     return CE_None;
     358             : }
     359             : 
     360             : // Builds a PNG palette from a GDAL color table
     361           1 : static void ResetPalette(GDALColorTable *poCT, PNG_Codec &codec)
     362             : {  // Convert the GDAL LUT to PNG style
     363           1 :     codec.TransSize = codec.PalSize = poCT->GetColorEntryCount();
     364             : 
     365             :     png_color *pasPNGColors =
     366           1 :         (png_color *)CPLMalloc(sizeof(png_color) * codec.PalSize);
     367           1 :     unsigned char *pabyAlpha = (unsigned char *)CPLMalloc(codec.TransSize);
     368           1 :     codec.PNGColors = (void *)pasPNGColors;
     369           1 :     codec.PNGAlpha = (void *)pabyAlpha;
     370           1 :     bool NoTranspYet = true;
     371             : 
     372             :     // Set the palette from the end to reduce the size of the opacity mask
     373         257 :     for (int iColor = codec.PalSize - 1; iColor >= 0; iColor--)
     374             :     {
     375             :         GDALColorEntry sEntry;
     376         256 :         poCT->GetColorEntryAsRGB(iColor, &sEntry);
     377             : 
     378         256 :         pasPNGColors[iColor].red = (png_byte)sEntry.c1;
     379         256 :         pasPNGColors[iColor].green = (png_byte)sEntry.c2;
     380         256 :         pasPNGColors[iColor].blue = (png_byte)sEntry.c3;
     381         256 :         if (NoTranspYet && sEntry.c4 == 255)
     382         256 :             codec.TransSize--;
     383             :         else
     384             :         {
     385           0 :             NoTranspYet = false;
     386           0 :             pabyAlpha[iColor] = (unsigned char)sEntry.c4;
     387             :         }
     388             :     }
     389           1 : }
     390             : 
     391          11 : CPLErr PNG_Band::Decompress(buf_mgr &dst, buf_mgr &src)
     392             : {
     393          11 :     return codec.DecompressPNG(dst, src);
     394             : }
     395             : 
     396          16 : CPLErr PNG_Band::Compress(buf_mgr &dst, buf_mgr &src)
     397             : {
     398          16 :     if (!codec.PNGColors && img.comp == IL_PPNG)
     399             :     {  // Late set PNG palette to conserve memory
     400           1 :         GDALColorTable *poCT = GetColorTable();
     401           1 :         if (!poCT)
     402             :         {
     403           0 :             CPLError(CE_Failure, CPLE_NotSupported,
     404             :                      "MRF PPNG needs a color table");
     405           0 :             return CE_Failure;
     406             :         }
     407           1 :         ResetPalette(poCT, codec);
     408             :     }
     409             : 
     410          16 :     codec.deflate_flags = deflate_flags;
     411          16 :     return codec.CompressPNG(dst, src);
     412             : }
     413             : 
     414             : /**
     415             :  * \brief For PPNG, builds the data structures needed to write the palette
     416             :  * The presence of the PNGColors and PNGAlpha is used as a flag for PPNG only
     417             :  */
     418             : 
     419         159 : PNG_Band::PNG_Band(MRFDataset *pDS, const ILImage &image, int b, int level)
     420         159 :     : MRFRasterBand(pDS, image, b, level), codec(image)
     421             : {  // Check error conditions
     422         159 :     if (image.dt != GDT_Byte && image.dt != GDT_Int16 && image.dt != GDT_UInt16)
     423             :     {
     424          52 :         CPLError(CE_Failure, CPLE_NotSupported,
     425             :                  "Data type not supported by MRF PNG");
     426          52 :         return;
     427             :     }
     428         107 :     if (image.pagesize.c > 4)
     429             :     {
     430           0 :         CPLError(CE_Failure, CPLE_NotSupported,
     431             :                  "MRF PNG can only handle up to 4 bands per page");
     432           0 :         return;
     433             :     }
     434             :     // PNGs can be larger than the source, especially for small page size
     435             :     // If PPNG is used, the palette can take up to 2100 bytes
     436         107 :     poMRFDS->SetPBufferSize(
     437         107 :         static_cast<unsigned int>(1.1 * image.pageSizeBytes + 4000));
     438             : }
     439             : 
     440             : NAMESPACE_MRF_END