X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/fc038829d566f4e0cfdb249fac1e67db8456e347..ca1f7cb56322e35a5bf3d9612cd14c128246947c:/src/common/imagtiff.cpp

diff --git a/src/common/imagtiff.cpp b/src/common/imagtiff.cpp
index 4c09339ca7..0e90db2a5f 100644
--- a/src/common/imagtiff.cpp
+++ b/src/common/imagtiff.cpp
@@ -7,46 +7,114 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+// ============================================================================
+// declarations
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 #ifdef __BORLANDC__
-#pragma hdrstop
+    #pragma hdrstop
 #endif
 
-#include "wx/defs.h"
-
 #if wxUSE_IMAGE && wxUSE_LIBTIFF
 
 #include "wx/imagtiff.h"
-#include "wx/bitmap.h"
-#include "wx/debug.h"
-#include "wx/log.h"
-#include "wx/app.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/app.h"
+    #include "wx/intl.h"
+    #include "wx/bitmap.h"
+    #include "wx/module.h"
+    #include "wx/wxcrtvararg.h"
+#endif
+
 extern "C"
 {
+#ifdef __DMC__
+    #include "tif_config.h"
+#endif
     #include "tiff.h"
     #include "tiffio.h"
 }
 #include "wx/filefn.h"
 #include "wx/wfstream.h"
-#include "wx/intl.h"
-#include "wx/module.h"
 
 #ifndef TIFFLINKAGEMODE
-  #if defined(__WATCOMC__) && defined(__WXMGL__)
-    #define TIFFLINKAGEMODE cdecl
-  #else
-    #define TIFFLINKAGEMODE LINKAGEMODE
-  #endif
+    #if defined(__WATCOMC__) && defined(__WXMGL__)
+        #define TIFFLINKAGEMODE cdecl
+    #else
+        #define TIFFLINKAGEMODE LINKAGEMODE
+    #endif
 #endif
 
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// TIFF library error/warning handlers
+// ----------------------------------------------------------------------------
+
+static wxString
+FormatTiffMessage(const char *module, const char *fmt, va_list ap)
+{
+    char buf[512];
+    if ( wxCRT_VsnprintfA(buf, WXSIZEOF(buf), fmt, ap) <= 0 )
+    {
+        // this isn't supposed to happen, but if it does, it's better
+        // than nothing
+        strcpy(buf, "Incorrectly formatted TIFF message");
+    }
+    buf[WXSIZEOF(buf)-1] = 0; // make sure it is always NULL-terminated
+
+    wxString msg(buf);
+    if ( module )
+        msg += wxString::Format(_(" (in module \"%s\")"), module);
+
+    return msg;
+}
+
+extern "C"
+{
+
+static void
+TIFFwxWarningHandler(const char* module, const char *fmt, va_list ap)
+{
+    wxLogWarning("%s", FormatTiffMessage(module, fmt, ap));
+}
+
+static void
+TIFFwxErrorHandler(const char* module, const char *fmt, va_list ap)
+{
+    wxLogError("%s", FormatTiffMessage(module, fmt, ap));
+}
+
+} // extern "C"
+
 //-----------------------------------------------------------------------------
 // wxTIFFHandler
 //-----------------------------------------------------------------------------
 
 IMPLEMENT_DYNAMIC_CLASS(wxTIFFHandler,wxImageHandler)
 
+wxTIFFHandler::wxTIFFHandler()
+{
+    m_name = wxT("TIFF file");
+    m_extension = wxT("tif");
+    m_altExtensions.Add(wxT("tiff"));
+    m_type = wxBITMAP_TYPE_TIF;
+    m_mime = wxT("image/tiff");
+    TIFFSetWarningHandler((TIFFErrorHandler) TIFFwxWarningHandler);
+    TIFFSetErrorHandler((TIFFErrorHandler) TIFFwxErrorHandler);
+}
+
 #if wxUSE_STREAMS
 
 // helper to translate our, possibly 64 bit, wxFileOffset to TIFF, always 32
@@ -58,7 +126,7 @@ static toff_t wxFileOffsetToTIFF(wxFileOffset ofs)
 
     toff_t tofs = wx_truncate_cast(toff_t, ofs);
     wxCHECK_MSG( (wxFileOffset)tofs == ofs, (toff_t)-1,
-                    _T("TIFF library doesn't support large files") );
+                    wxT("TIFF library doesn't support large files") );
 
     return tofs;
 }
@@ -86,7 +154,7 @@ extern "C"
 {
 
 tsize_t TIFFLINKAGEMODE
-_tiffNullProc(thandle_t WXUNUSED(handle),
+wxTIFFNullProc(thandle_t WXUNUSED(handle),
           tdata_t WXUNUSED(buf),
           tsize_t WXUNUSED(size))
 {
@@ -94,7 +162,7 @@ _tiffNullProc(thandle_t WXUNUSED(handle),
 }
 
 tsize_t TIFFLINKAGEMODE
-_tiffReadProc(thandle_t handle, tdata_t buf, tsize_t size)
+wxTIFFReadProc(thandle_t handle, tdata_t buf, tsize_t size)
 {
     wxInputStream *stream = (wxInputStream*) handle;
     stream->Read( (void*) buf, (size_t) size );
@@ -102,7 +170,7 @@ _tiffReadProc(thandle_t handle, tdata_t buf, tsize_t size)
 }
 
 tsize_t TIFFLINKAGEMODE
-_tiffWriteProc(thandle_t handle, tdata_t buf, tsize_t size)
+wxTIFFWriteProc(thandle_t handle, tdata_t buf, tsize_t size)
 {
     wxOutputStream *stream = (wxOutputStream*) handle;
     stream->Write( (void*) buf, (size_t) size );
@@ -110,7 +178,7 @@ _tiffWriteProc(thandle_t handle, tdata_t buf, tsize_t size)
 }
 
 toff_t TIFFLINKAGEMODE
-_tiffSeekIProc(thandle_t handle, toff_t off, int whence)
+wxTIFFSeekIProc(thandle_t handle, toff_t off, int whence)
 {
     wxInputStream *stream = (wxInputStream*) handle;
 
@@ -119,7 +187,7 @@ _tiffSeekIProc(thandle_t handle, toff_t off, int whence)
 }
 
 toff_t TIFFLINKAGEMODE
-_tiffSeekOProc(thandle_t handle, toff_t off, int whence)
+wxTIFFSeekOProc(thandle_t handle, toff_t off, int whence)
 {
     wxOutputStream *stream = (wxOutputStream*) handle;
 
@@ -128,20 +196,29 @@ _tiffSeekOProc(thandle_t handle, toff_t off, int whence)
 }
 
 int TIFFLINKAGEMODE
-_tiffCloseProc(thandle_t WXUNUSED(handle))
+wxTIFFCloseIProc(thandle_t WXUNUSED(handle))
 {
-    return 0;  // ?
+    // there is no need to close the input stream
+    return 0;
+}
+
+int TIFFLINKAGEMODE
+wxTIFFCloseOProc(thandle_t handle)
+{
+    wxOutputStream *stream = (wxOutputStream*) handle;
+
+    return stream->Close() ? 0 : -1;
 }
 
 toff_t TIFFLINKAGEMODE
-_tiffSizeProc(thandle_t handle)
+wxTIFFSizeProc(thandle_t handle)
 {
     wxStreamBase *stream = (wxStreamBase*) handle;
     return (toff_t) stream->GetSize();
 }
 
 int TIFFLINKAGEMODE
-_tiffMapProc(thandle_t WXUNUSED(handle),
+wxTIFFMapProc(thandle_t WXUNUSED(handle),
              tdata_t* WXUNUSED(pbase),
              toff_t* WXUNUSED(psize))
 {
@@ -149,44 +226,12 @@ _tiffMapProc(thandle_t WXUNUSED(handle),
 }
 
 void TIFFLINKAGEMODE
-_tiffUnmapProc(thandle_t WXUNUSED(handle),
+wxTIFFUnmapProc(thandle_t WXUNUSED(handle),
                tdata_t WXUNUSED(base),
                toff_t WXUNUSED(size))
 {
 }
 
-static void
-TIFFwxWarningHandler(const char* module,
-                     const char* WXUNUSED_IN_UNICODE(fmt),
-                     va_list WXUNUSED_IN_UNICODE(ap))
-{
-    if (module != NULL)
-        wxLogWarning(_("tiff module: %s"), wxString::FromAscii(module).c_str());
-
-    // FIXME: this is not terrible informative but better than crashing!
-#if wxUSE_UNICODE
-    wxLogWarning(_("TIFF library warning."));
-#else
-    wxVLogWarning(fmt, ap);
-#endif
-}
-
-static void
-TIFFwxErrorHandler(const char* module,
-                   const char* WXUNUSED_IN_UNICODE(fmt),
-                   va_list WXUNUSED_IN_UNICODE(ap))
-{
-    if (module != NULL)
-        wxLogError(_("tiff module: %s"), wxString::FromAscii(module).c_str());
-
-    // FIXME: as above
-#if wxUSE_UNICODE
-    wxLogError(_("TIFF library error."));
-#else
-    wxVLogError(fmt, ap);
-#endif
-}
-
 } // extern "C"
 
 TIFF*
@@ -194,9 +239,9 @@ TIFFwxOpen(wxInputStream &stream, const char* name, const char* mode)
 {
     TIFF* tif = TIFFClientOpen(name, mode,
         (thandle_t) &stream,
-        _tiffReadProc, _tiffNullProc,
-        _tiffSeekIProc, _tiffCloseProc, _tiffSizeProc,
-        _tiffMapProc, _tiffUnmapProc);
+        wxTIFFReadProc, wxTIFFNullProc,
+        wxTIFFSeekIProc, wxTIFFCloseIProc, wxTIFFSizeProc,
+        wxTIFFMapProc, wxTIFFUnmapProc);
 
     return tif;
 }
@@ -206,23 +251,13 @@ TIFFwxOpen(wxOutputStream &stream, const char* name, const char* mode)
 {
     TIFF* tif = TIFFClientOpen(name, mode,
         (thandle_t) &stream,
-        _tiffNullProc, _tiffWriteProc,
-        _tiffSeekOProc, _tiffCloseProc, _tiffSizeProc,
-        _tiffMapProc, _tiffUnmapProc);
+        wxTIFFNullProc, wxTIFFWriteProc,
+        wxTIFFSeekOProc, wxTIFFCloseOProc, wxTIFFSizeProc,
+        wxTIFFMapProc, wxTIFFUnmapProc);
 
     return tif;
 }
 
-wxTIFFHandler::wxTIFFHandler()
-{
-    m_name = wxT("TIFF file");
-    m_extension = wxT("tif");
-    m_type = wxBITMAP_TYPE_TIF;
-    m_mime = wxT("image/tiff");
-    TIFFSetWarningHandler((TIFFErrorHandler) TIFFwxWarningHandler);
-    TIFFSetErrorHandler((TIFFErrorHandler) TIFFwxErrorHandler);
-}
-
 bool wxTIFFHandler::LoadFile( wxImage *image, wxInputStream& stream, bool verbose, int index )
 {
     if (index == -1)
@@ -235,7 +270,9 @@ bool wxTIFFHandler::LoadFile( wxImage *image, wxInputStream& stream, bool verbos
     if (!tif)
     {
         if (verbose)
+        {
             wxLogError( _("TIFF: Error loading image.") );
+        }
 
         return false;
     }
@@ -243,7 +280,9 @@ bool wxTIFFHandler::LoadFile( wxImage *image, wxInputStream& stream, bool verbos
     if (!TIFFSetDirectory( tif, (tdir_t)index ))
     {
         if (verbose)
+        {
             wxLogError( _("Invalid TIFF image index.") );
+        }
 
         TIFFClose( tif );
 
@@ -251,20 +290,42 @@ bool wxTIFFHandler::LoadFile( wxImage *image, wxInputStream& stream, bool verbos
     }
 
     uint32 w, h;
-    uint32 npixels;
     uint32 *raster;
 
     TIFFGetField( tif, TIFFTAG_IMAGEWIDTH, &w );
     TIFFGetField( tif, TIFFTAG_IMAGELENGTH, &h );
 
-    npixels = w * h;
+    uint16 extraSamples;
+    uint16* samplesInfo;
+    TIFFGetFieldDefaulted(tif, TIFFTAG_EXTRASAMPLES,
+                          &extraSamples, &samplesInfo);
+    const bool hasAlpha = (extraSamples == 1 &&
+                           (samplesInfo[0] == EXTRASAMPLE_ASSOCALPHA ||
+                            samplesInfo[0] == EXTRASAMPLE_UNASSALPHA));
+
+    // guard against integer overflow during multiplication which could result
+    // in allocating a too small buffer and then overflowing it
+    const double bytesNeeded = (double)w * (double)h * sizeof(uint32);
+    if ( bytesNeeded >= wxUINT32_MAX )
+    {
+        if ( verbose )
+        {
+            wxLogError( _("TIFF: Image size is abnormally big.") );
+        }
+
+        TIFFClose(tif);
+
+        return false;
+    }
 
-    raster = (uint32*) _TIFFmalloc( npixels * sizeof(uint32) );
+    raster = (uint32*) _TIFFmalloc( (uint32)bytesNeeded );
 
     if (!raster)
     {
         if (verbose)
+        {
             wxLogError( _("TIFF: Couldn't allocate memory.") );
+        }
 
         TIFFClose( tif );
 
@@ -275,7 +336,9 @@ bool wxTIFFHandler::LoadFile( wxImage *image, wxInputStream& stream, bool verbos
     if (!image->Ok())
     {
         if (verbose)
+        {
             wxLogError( _("TIFF: Couldn't allocate memory.") );
+        }
 
         _TIFFfree( raster );
         TIFFClose( tif );
@@ -283,10 +346,15 @@ bool wxTIFFHandler::LoadFile( wxImage *image, wxInputStream& stream, bool verbos
         return false;
     }
 
+    if ( hasAlpha )
+        image->SetAlpha();
+
     if (!TIFFReadRGBAImage( tif, w, h, raster, 0 ))
     {
         if (verbose)
+        {
             wxLogError( _("TIFF: Error reading image.") );
+        }
 
         _TIFFfree( raster );
         image->Destroy();
@@ -295,51 +363,79 @@ bool wxTIFFHandler::LoadFile( wxImage *image, wxInputStream& stream, bool verbos
         return false;
     }
 
-    bool hasmask = false;
-
     unsigned char *ptr = image->GetData();
     ptr += w*3*(h-1);
+
+    unsigned char *alpha = hasAlpha ? image->GetAlpha() : NULL;
+    if ( hasAlpha )
+        alpha += w*(h-1);
+
     uint32 pos = 0;
 
     for (uint32 i = 0; i < h; i++)
     {
         for (uint32 j = 0; j < w; j++)
         {
-            unsigned char alpha = (unsigned char)TIFFGetA(raster[pos]);
-            if (alpha < 127)
-            {
-                hasmask = true;
-                ptr[0] = image->GetMaskRed();
-                ptr++;
-                ptr[0] = image->GetMaskGreen();
-                ptr++;
-                ptr[0] = image->GetMaskBlue();
-                ptr++;
-            }
-            else
-            {
-                ptr[0] = (unsigned char)TIFFGetR(raster[pos]);
-                ptr++;
-                ptr[0] = (unsigned char)TIFFGetG(raster[pos]);
-                ptr++;
-                ptr[0] = (unsigned char)TIFFGetB(raster[pos]);
-                ptr++;
-            }
+            *(ptr++) = (unsigned char)TIFFGetR(raster[pos]);
+            *(ptr++) = (unsigned char)TIFFGetG(raster[pos]);
+            *(ptr++) = (unsigned char)TIFFGetB(raster[pos]);
+            if ( hasAlpha )
+                *(alpha++) = (unsigned char)TIFFGetA(raster[pos]);
+
             pos++;
         }
-        ptr -= 2*w*3; // subtract line we just added plus one line
+
+        // subtract line we just added plus one line:
+        ptr -= 2*w*3;
+        if ( hasAlpha )
+            alpha -= 2*w;
     }
 
+    // set the image resolution if it's available
+    uint16 tiffRes;
+    if ( TIFFGetField(tif, TIFFTAG_RESOLUTIONUNIT, &tiffRes) )
+    {
+        wxImageResolution res;
+        switch ( tiffRes )
+        {
+            default:
+                wxLogWarning(_("Unknown TIFF resolution unit %d ignored"),
+                             tiffRes);
+                // fall through
+
+            case RESUNIT_NONE:
+                res = wxIMAGE_RESOLUTION_NONE;
+                break;
+
+            case RESUNIT_INCH:
+                res = wxIMAGE_RESOLUTION_INCHES;
+                break;
+
+            case RESUNIT_CENTIMETER:
+                res = wxIMAGE_RESOLUTION_CM;
+                break;
+        }
+
+        if ( res != wxIMAGE_RESOLUTION_NONE )
+        {
+            float xres, yres;
+            if ( TIFFGetField(tif, TIFFTAG_XRESOLUTION, &xres) )
+                image->SetOption(wxIMAGE_OPTION_RESOLUTIONX, wxRound(xres));
+
+            if ( TIFFGetField(tif, TIFFTAG_YRESOLUTION, &yres) )
+                image->SetOption(wxIMAGE_OPTION_RESOLUTIONY, wxRound(yres));
+        }
+    }
+
+
     _TIFFfree( raster );
 
     TIFFClose( tif );
 
-    image->SetMask( hasmask );
-
     return true;
 }
 
-int wxTIFFHandler::GetImageCount( wxInputStream& stream )
+int wxTIFFHandler::DoGetImageCount( wxInputStream& stream )
 {
     TIFF *tif = TIFFwxOpen( stream, "image", "r" );
 
@@ -353,6 +449,9 @@ int wxTIFFHandler::GetImageCount( wxInputStream& stream )
 
     TIFFClose( tif );
 
+    // NOTE: this function modifies the current stream position but it's ok
+    //       (see wxImageHandler::GetImageCount)
+
     return dircount;
 }
 
@@ -363,7 +462,9 @@ bool wxTIFFHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbo
     if (!tif)
     {
         if (verbose)
+        {
             wxLogError( _("TIFF: Error saving image.") );
+        }
 
         return false;
     }
@@ -374,26 +475,54 @@ bool wxTIFFHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbo
     TIFFSetField(tif, TIFFTAG_ORIENTATION, ORIENTATION_TOPLEFT);
     TIFFSetField(tif, TIFFTAG_PLANARCONFIG, PLANARCONFIG_CONTIG);
 
-    if ( image->HasOption(wxIMAGE_OPTION_RESOLUTIONX) &&
-            image->HasOption(wxIMAGE_OPTION_RESOLUTIONY) )
+    // save the image resolution if we have it
+    int xres, yres;
+    const wxImageResolution res = GetResolutionFromOptions(*image, &xres, &yres);
+    uint16 tiffRes;
+    switch ( res )
+    {
+        default:
+            wxFAIL_MSG( wxT("unknown image resolution units") );
+            // fall through
+
+        case wxIMAGE_RESOLUTION_NONE:
+            tiffRes = RESUNIT_NONE;
+            break;
+
+        case wxIMAGE_RESOLUTION_INCHES:
+            tiffRes = RESUNIT_INCH;
+            break;
+
+        case wxIMAGE_RESOLUTION_CM:
+            tiffRes = RESUNIT_CENTIMETER;
+            break;
+    }
+
+    if ( tiffRes != RESUNIT_NONE )
     {
-        TIFFSetField(tif, TIFFTAG_XRESOLUTION,
-                        (float)image->GetOptionInt(wxIMAGE_OPTION_RESOLUTIONX));
-        TIFFSetField(tif, TIFFTAG_YRESOLUTION,
-                        (float)image->GetOptionInt(wxIMAGE_OPTION_RESOLUTIONY));
+        TIFFSetField(tif, TIFFTAG_RESOLUTIONUNIT, tiffRes);
+        TIFFSetField(tif, TIFFTAG_XRESOLUTION, (float)xres);
+        TIFFSetField(tif, TIFFTAG_YRESOLUTION, (float)yres);
     }
 
+
     int spp = image->GetOptionInt(wxIMAGE_OPTION_SAMPLESPERPIXEL);
     if ( !spp )
         spp = 3;
 
     int bpp = image->GetOptionInt(wxIMAGE_OPTION_BITSPERSAMPLE);
     if ( !bpp )
-        bpp=8;
+        bpp = 8;
 
     int compression = image->GetOptionInt(wxIMAGE_OPTION_COMPRESSION);
     if ( !compression )
-        compression=COMPRESSION_LZW;
+    {
+        // we can't use COMPRESSION_LZW because current version of libtiff
+        // doesn't implement it ("no longer implemented due to Unisys patent
+        // enforcement") and other compression methods are lossy so we
+        // shouldn't use them by default -- and the only remaining one is none
+        compression = COMPRESSION_NONE;
+    }
 
     TIFFSetField(tif, TIFFTAG_SAMPLESPERPIXEL, spp);
     TIFFSetField(tif, TIFFTAG_BITSPERSAMPLE, bpp);
@@ -415,7 +544,9 @@ bool wxTIFFHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbo
         if (!buf)
         {
             if (verbose)
+            {
                 wxLogError( _("TIFF: Couldn't allocate memory.") );
+            }
 
             TIFFClose( tif );
 
@@ -461,7 +592,9 @@ bool wxTIFFHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbo
         if ( TIFFWriteScanline(tif, buf ? buf : ptr, (uint32)row, 0) < 0 )
         {
             if (verbose)
+            {
                 wxLogError( _("TIFF: Error writing image.") );
+            }
 
             TIFFClose( tif );
             if (buf)
@@ -485,7 +618,7 @@ bool wxTIFFHandler::DoCanRead( wxInputStream& stream )
 {
     unsigned char hdr[2];
 
-    if ( !stream.Read(&hdr[0], WXSIZEOF(hdr)) )
+    if ( !stream.Read(&hdr[0], WXSIZEOF(hdr)) )     // it's ok to modify the stream position here
         return false;
 
     return (hdr[0] == 'I' && hdr[1] == 'I') ||