]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/imagtiff.cpp
abandon attempts to make wxAnyStrPtr behave as bool: user-defined logical operators...
[wxWidgets.git] / src / common / imagtiff.cpp
index 3cd681f75775d59cf0ae59de5e1cfcb905297ecf..91b70afbae6ff882f50e4f2d2d86a59d22073cd1 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        imagtiff.cpp
+// Name:        src/common/imagtiff.cpp
 // Purpose:     wxImage TIFF handler
 // Author:      Robert Roebling
 // RCS-ID:      $Id$
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma implementation "imagtiff.h"
-#endif
+// ============================================================================
+// 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
-  #define TIFFLINKAGEMODE LINKAGEMODE
+    #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
+// bit, toff_t
+static toff_t wxFileOffsetToTIFF(wxFileOffset ofs)
+{
+    if ( ofs == wxInvalidOffset )
+        return (toff_t)-1;
+
+    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") );
+
+    return tofs;
+}
+
+// another helper to convert standard seek mode to our
+static wxSeekMode wxSeekModeFromTIFF(int whence)
+{
+    switch ( whence )
+    {
+        case SEEK_SET:
+            return wxFromStart;
+
+        case SEEK_CUR:
+            return wxFromCurrent;
+
+        case SEEK_END:
+            return wxFromEnd;
+
+        default:
+            return wxFromCurrent;
+    }
+}
+
 extern "C"
 {
 
 tsize_t TIFFLINKAGEMODE
-_tiffNullProc(thandle_t WXUNUSED(handle),
+wxTIFFNullProc(thandle_t WXUNUSED(handle),
           tdata_t WXUNUSED(buf),
           tsize_t WXUNUSED(size))
 {
@@ -61,68 +162,63 @@ _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 );
-    return stream->LastRead();
+    return wx_truncate_cast(tsize_t, stream->LastRead());
 }
 
 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 );
-    return stream->LastWrite();
+    return wx_truncate_cast(tsize_t, stream->LastWrite());
 }
 
 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;
-    wxSeekMode mode;
-    switch (whence)
-    {
-        case SEEK_SET: mode = wxFromStart; break;
-        case SEEK_CUR: mode = wxFromCurrent; break;
-        case SEEK_END: mode = wxFromEnd; break;
-        default:       mode = wxFromCurrent; break;
-    }
 
-    return (toff_t)stream->SeekI( (wxFileOffset)off, mode );
+    return wxFileOffsetToTIFF(stream->SeekI((wxFileOffset)off,
+                                            wxSeekModeFromTIFF(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;
-    wxSeekMode mode;
-    switch (whence)
-    {
-        case SEEK_SET: mode = wxFromStart; break;
-        case SEEK_CUR: mode = wxFromCurrent; break;
-        case SEEK_END: mode = wxFromEnd; break;
-        default:       mode = wxFromCurrent; break;
-    }
 
-    return (toff_t)stream->SeekO( (wxFileOffset)off, mode );
+    return wxFileOffsetToTIFF(stream->SeekO((wxFileOffset)off,
+                                            wxSeekModeFromTIFF(whence)));
+}
+
+int TIFFLINKAGEMODE
+wxTIFFCloseIProc(thandle_t WXUNUSED(handle))
+{
+    // there is no need to close the input stream
+    return 0;
 }
 
 int TIFFLINKAGEMODE
-_tiffCloseProc(thandle_t WXUNUSED(handle))
+wxTIFFCloseOProc(thandle_t handle)
 {
-    return 0;  // ?
+    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))
 {
@@ -130,28 +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* fmt, va_list ap)
-{
-    if (module != NULL)
-            wxLogWarning(_("tiff module: %s"), module);
-    wxLogWarning((wxChar *) fmt, ap);
-}
-
-static void
-TIFFwxErrorHandler(const char* module, const char* fmt, va_list ap)
-{
-    if (module != NULL)
-            wxLogError(_("tiff module: %s"), module);
-    wxVLogError((wxChar *) fmt, ap);
-}
-
 } // extern "C"
 
 TIFF*
@@ -159,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;
 }
@@ -171,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)
@@ -222,6 +292,14 @@ bool wxTIFFHandler::LoadFile( wxImage *image, wxInputStream& stream, bool verbos
     TIFFGetField( tif, TIFFTAG_IMAGEWIDTH, &w );
     TIFFGetField( tif, TIFFTAG_IMAGELENGTH, &h );
 
+    uint16 extraSamples;
+    uint16* samplesInfo;
+    TIFFGetFieldDefaulted(tif, TIFFTAG_EXTRASAMPLES,
+                          &extraSamples, &samplesInfo);
+    const bool hasAlpha = (extraSamples == 1 &&
+                           (samplesInfo[0] == EXTRASAMPLE_ASSOCALPHA ||
+                            samplesInfo[0] == EXTRASAMPLE_UNASSALPHA));
+
     npixels = w * h;
 
     raster = (uint32*) _TIFFmalloc( npixels * sizeof(uint32) );
@@ -248,6 +326,9 @@ bool wxTIFFHandler::LoadFile( wxImage *image, wxInputStream& stream, bool verbos
         return false;
     }
 
+    if ( hasAlpha )
+        image->SetAlpha();
+
     if (!TIFFReadRGBAImage( tif, w, h, raster, 0 ))
     {
         if (verbose)
@@ -260,47 +341,75 @@ 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;
 }
 
@@ -333,19 +442,76 @@ bool wxTIFFHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbo
         return false;
     }
 
+    TIFFSetField(tif, TIFFTAG_ORIENTATION, ORIENTATION_TOPLEFT);
     TIFFSetField(tif, TIFFTAG_IMAGEWIDTH,  (uint32)image->GetWidth());
     TIFFSetField(tif, TIFFTAG_IMAGELENGTH, (uint32)image->GetHeight());
     TIFFSetField(tif, TIFFTAG_ORIENTATION, ORIENTATION_TOPLEFT);
-    TIFFSetField(tif, TIFFTAG_SAMPLESPERPIXEL, 3);
-    TIFFSetField(tif, TIFFTAG_BITSPERSAMPLE, 8);
     TIFFSetField(tif, TIFFTAG_PLANARCONFIG, PLANARCONFIG_CONTIG);
-    TIFFSetField(tif, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_RGB);
-    TIFFSetField(tif, TIFFTAG_COMPRESSION, COMPRESSION_LZW);
 
-    tsize_t linebytes = (tsize_t)image->GetWidth() * 3;
+    // 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( _T("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_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;
+
+    int compression = image->GetOptionInt(wxIMAGE_OPTION_COMPRESSION);
+    if ( !compression )
+    {
+        // 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);
+    TIFFSetField(tif, TIFFTAG_PHOTOMETRIC, spp*bpp == 1 ? PHOTOMETRIC_MINISBLACK
+                                                        : PHOTOMETRIC_RGB);
+    TIFFSetField(tif, TIFFTAG_COMPRESSION, compression);
+
+    // scanlinesize if determined by spp and bpp
+    tsize_t linebytes = (tsize_t)image->GetWidth() * spp * bpp / 8;
+
+    if ( (image->GetWidth() % 8 > 0) && (spp * bpp < 8) )
+        linebytes+=1;
+
     unsigned char *buf;
 
-    if (TIFFScanlineSize(tif) > linebytes)
+    if (TIFFScanlineSize(tif) > linebytes || (spp * bpp < 24))
     {
         buf = (unsigned char *)_TIFFmalloc(TIFFScanlineSize(tif));
         if (!buf)
@@ -363,16 +529,38 @@ bool wxTIFFHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbo
         buf = NULL;
     }
 
-    TIFFSetField(tif, TIFFTAG_ROWSPERSTRIP,
-        TIFFDefaultStripSize(tif, (uint32) -1));
+    TIFFSetField(tif, TIFFTAG_ROWSPERSTRIP,TIFFDefaultStripSize(tif, (uint32) -1));
 
     unsigned char *ptr = image->GetData();
-    for (int row = 0; row < image->GetHeight(); row++)
+    for ( int row = 0; row < image->GetHeight(); row++ )
     {
-        if (buf)
-            memcpy(buf, ptr, image->GetWidth());
+        if ( buf )
+        {
+            if ( spp * bpp > 1 )
+            {
+                // color image
+                memcpy(buf, ptr, image->GetWidth());
+            }
+            else // black and white image
+            {
+                for ( int column = 0; column < linebytes; column++ )
+                {
+                    uint8 reverse = 0;
+                    for ( int bp = 0; bp < 8; bp++ )
+                    {
+                        if ( ptr[column*24 + bp*3] > 0 )
+                        {
+                            // check only red as this is sufficient
+                            reverse = (uint8)(reverse | 128 >> bp);
+                        }
+                    }
+
+                    buf[column] = reverse;
+                }
+            }
+        }
 
-        if (TIFFWriteScanline(tif, buf ? buf : ptr, (uint32)row, 0) < 0)
+        if ( TIFFWriteScanline(tif, buf ? buf : ptr, (uint32)row, 0) < 0 )
         {
             if (verbose)
                 wxLogError( _("TIFF: Error writing image.") );
@@ -383,13 +571,14 @@ bool wxTIFFHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbo
 
             return false;
         }
+
         ptr += image->GetWidth()*3;
     }
 
     (void) TIFFClose(tif);
 
     if (buf)
-    _TIFFfree(buf);
+        _TIFFfree(buf);
 
     return true;
 }
@@ -408,4 +597,3 @@ bool wxTIFFHandler::DoCanRead( wxInputStream& stream )
 #endif  // wxUSE_STREAMS
 
 #endif  // wxUSE_LIBTIFF
-