src/common/imagtiff.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/imagtiff.cpp
   3 // Purpose:     wxImage TIFF handler
   4 // Author:      Robert Roebling
   5 // RCS-ID:      $Id$
   6 // Copyright:   (c) Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 // ============================================================================
  11 // declarations
  12 // ============================================================================
  13
  14 // ----------------------------------------------------------------------------
  15 // headers
  16 // ----------------------------------------------------------------------------
  17
  18 // For compilers that support precompilation, includes "wx.h".
  19 #include "wx/wxprec.h"
  20
  21 #ifdef __BORLANDC__
  22     #pragma hdrstop
  23 #endif
  24
  25 #if wxUSE_IMAGE && wxUSE_LIBTIFF
  26
  27 #include "wx/imagtiff.h"
  28 #include "wx/versioninfo.h"
  29
  30 #ifndef WX_PRECOMP
  31     #include "wx/log.h"
  32     #include "wx/app.h"
  33     #include "wx/intl.h"
  34     #include "wx/bitmap.h"
  35     #include "wx/module.h"
  36     #include "wx/wxcrtvararg.h"
  37 #endif
  38
  39 extern "C"
  40 {
  41 #ifdef __DMC__
  42     #include "tif_config.h"
  43 #endif
  44     #include "tiff.h"
  45     #include "tiffio.h"
  46 }
  47 #include "wx/filefn.h"
  48 #include "wx/wfstream.h"
  49
  50 #ifndef TIFFLINKAGEMODE
  51     #if defined(__WATCOMC__) && defined(__WXMGL__)
  52         #define TIFFLINKAGEMODE cdecl
  53     #else
  54         #define TIFFLINKAGEMODE LINKAGEMODE
  55     #endif
  56 #endif
  57
  58 // ============================================================================
  59 // implementation
  60 // ============================================================================
  61
  62 // ----------------------------------------------------------------------------
  63 // TIFF library error/warning handlers
  64 // ----------------------------------------------------------------------------
  65
  66 static wxString
  67 FormatTiffMessage(const char *module, const char *fmt, va_list ap)
  68 {
  69     char buf[512];
  70     if ( wxCRT_VsnprintfA(buf, WXSIZEOF(buf), fmt, ap) <= 0 )
  71     {
  72         // this isn't supposed to happen, but if it does, it's better
  73         // than nothing
  74         strcpy(buf, "Incorrectly formatted TIFF message");
  75     }
  76     buf[WXSIZEOF(buf)-1] = 0; // make sure it is always NULL-terminated
  77
  78     wxString msg(buf);
  79     if ( module )
  80         msg += wxString::Format(_(" (in module \"%s\")"), module);
  81
  82     return msg;
  83 }
  84
  85 extern "C"
  86 {
  87
  88 static void
  89 TIFFwxWarningHandler(const char* module, const char *fmt, va_list ap)
  90 {
  91     wxLogWarning("%s", FormatTiffMessage(module, fmt, ap));
  92 }
  93
  94 static void
  95 TIFFwxErrorHandler(const char* module, const char *fmt, va_list ap)
  96 {
  97     wxLogError("%s", FormatTiffMessage(module, fmt, ap));
  98 }
  99
 100 } // extern "C"
 101
 102 //-----------------------------------------------------------------------------
 103 // wxTIFFHandler
 104 //-----------------------------------------------------------------------------
 105
 106 IMPLEMENT_DYNAMIC_CLASS(wxTIFFHandler,wxImageHandler)
 107
 108 wxTIFFHandler::wxTIFFHandler()
 109 {
 110     m_name = wxT("TIFF file");
 111     m_extension = wxT("tif");
 112     m_altExtensions.Add(wxT("tiff"));
 113     m_type = wxBITMAP_TYPE_TIF;
 114     m_mime = wxT("image/tiff");
 115     TIFFSetWarningHandler((TIFFErrorHandler) TIFFwxWarningHandler);
 116     TIFFSetErrorHandler((TIFFErrorHandler) TIFFwxErrorHandler);
 117 }
 118
 119 #if wxUSE_STREAMS
 120
 121 // helper to translate our, possibly 64 bit, wxFileOffset to TIFF, always 32
 122 // bit, toff_t
 123 static toff_t wxFileOffsetToTIFF(wxFileOffset ofs)
 124 {
 125     if ( ofs == wxInvalidOffset )
 126         return (toff_t)-1;
 127
 128     toff_t tofs = wx_truncate_cast(toff_t, ofs);
 129     wxCHECK_MSG( (wxFileOffset)tofs == ofs, (toff_t)-1,
 130                     wxT("TIFF library doesn't support large files") );
 131
 132     return tofs;
 133 }
 134
 135 // another helper to convert standard seek mode to our
 136 static wxSeekMode wxSeekModeFromTIFF(int whence)
 137 {
 138     switch ( whence )
 139     {
 140         case SEEK_SET:
 141             return wxFromStart;
 142
 143         case SEEK_CUR:
 144             return wxFromCurrent;
 145
 146         case SEEK_END:
 147             return wxFromEnd;
 148
 149         default:
 150             return wxFromCurrent;
 151     }
 152 }
 153
 154 extern "C"
 155 {
 156
 157 tsize_t TIFFLINKAGEMODE
 158 wxTIFFNullProc(thandle_t WXUNUSED(handle),
 159           tdata_t WXUNUSED(buf),
 160           tsize_t WXUNUSED(size))
 161 {
 162     return (tsize_t) -1;
 163 }
 164
 165 tsize_t TIFFLINKAGEMODE
 166 wxTIFFReadProc(thandle_t handle, tdata_t buf, tsize_t size)
 167 {
 168     wxInputStream *stream = (wxInputStream*) handle;
 169     stream->Read( (void*) buf, (size_t) size );
 170     return wx_truncate_cast(tsize_t, stream->LastRead());
 171 }
 172
 173 tsize_t TIFFLINKAGEMODE
 174 wxTIFFWriteProc(thandle_t handle, tdata_t buf, tsize_t size)
 175 {
 176     wxOutputStream *stream = (wxOutputStream*) handle;
 177     stream->Write( (void*) buf, (size_t) size );
 178     return wx_truncate_cast(tsize_t, stream->LastWrite());
 179 }
 180
 181 toff_t TIFFLINKAGEMODE
 182 wxTIFFSeekIProc(thandle_t handle, toff_t off, int whence)
 183 {
 184     wxInputStream *stream = (wxInputStream*) handle;
 185
 186     return wxFileOffsetToTIFF(stream->SeekI((wxFileOffset)off,
 187                                             wxSeekModeFromTIFF(whence)));
 188 }
 189
 190 toff_t TIFFLINKAGEMODE
 191 wxTIFFSeekOProc(thandle_t handle, toff_t off, int whence)
 192 {
 193     wxOutputStream *stream = (wxOutputStream*) handle;
 194
 195     return wxFileOffsetToTIFF(stream->SeekO((wxFileOffset)off,
 196                                             wxSeekModeFromTIFF(whence)));
 197 }
 198
 199 int TIFFLINKAGEMODE
 200 wxTIFFCloseIProc(thandle_t WXUNUSED(handle))
 201 {
 202     // there is no need to close the input stream
 203     return 0;
 204 }
 205
 206 int TIFFLINKAGEMODE
 207 wxTIFFCloseOProc(thandle_t handle)
 208 {
 209     wxOutputStream *stream = (wxOutputStream*) handle;
 210
 211     return stream->Close() ? 0 : -1;
 212 }
 213
 214 toff_t TIFFLINKAGEMODE
 215 wxTIFFSizeProc(thandle_t handle)
 216 {
 217     wxStreamBase *stream = (wxStreamBase*) handle;
 218     return (toff_t) stream->GetSize();
 219 }
 220
 221 int TIFFLINKAGEMODE
 222 wxTIFFMapProc(thandle_t WXUNUSED(handle),
 223              tdata_t* WXUNUSED(pbase),
 224              toff_t* WXUNUSED(psize))
 225 {
 226     return 0;
 227 }
 228
 229 void TIFFLINKAGEMODE
 230 wxTIFFUnmapProc(thandle_t WXUNUSED(handle),
 231                tdata_t WXUNUSED(base),
 232                toff_t WXUNUSED(size))
 233 {
 234 }
 235
 236 } // extern "C"
 237
 238 TIFF*
 239 TIFFwxOpen(wxInputStream &stream, const char* name, const char* mode)
 240 {
 241     TIFF* tif = TIFFClientOpen(name, mode,
 242         (thandle_t) &stream,
 243         wxTIFFReadProc, wxTIFFNullProc,
 244         wxTIFFSeekIProc, wxTIFFCloseIProc, wxTIFFSizeProc,
 245         wxTIFFMapProc, wxTIFFUnmapProc);
 246
 247     return tif;
 248 }
 249
 250 TIFF*
 251 TIFFwxOpen(wxOutputStream &stream, const char* name, const char* mode)
 252 {
 253     TIFF* tif = TIFFClientOpen(name, mode,
 254         (thandle_t) &stream,
 255         wxTIFFNullProc, wxTIFFWriteProc,
 256         wxTIFFSeekOProc, wxTIFFCloseOProc, wxTIFFSizeProc,
 257         wxTIFFMapProc, wxTIFFUnmapProc);
 258
 259     return tif;
 260 }
 261
 262 bool wxTIFFHandler::LoadFile( wxImage *image, wxInputStream& stream, bool verbose, int index )
 263 {
 264     if (index == -1)
 265         index = 0;
 266
 267     image->Destroy();
 268
 269     TIFF *tif = TIFFwxOpen( stream, "image", "r" );
 270
 271     if (!tif)
 272     {
 273         if (verbose)
 274         {
 275             wxLogError( _("TIFF: Error loading image.") );
 276         }
 277
 278         return false;
 279     }
 280
 281     if (!TIFFSetDirectory( tif, (tdir_t)index ))
 282     {
 283         if (verbose)
 284         {
 285             wxLogError( _("Invalid TIFF image index.") );
 286         }
 287
 288         TIFFClose( tif );
 289
 290         return false;
 291     }
 292
 293     uint32 w, h;
 294     uint32 *raster;
 295
 296     TIFFGetField( tif, TIFFTAG_IMAGEWIDTH, &w );
 297     TIFFGetField( tif, TIFFTAG_IMAGELENGTH, &h );
 298
 299     uint16 photometric;
 300     uint16 samplesPerPixel;
 301     uint16 extraSamples;
 302     uint16* samplesInfo;
 303     TIFFGetFieldDefaulted(tif, TIFFTAG_SAMPLESPERPIXEL, &samplesPerPixel);
 304     TIFFGetFieldDefaulted(tif, TIFFTAG_EXTRASAMPLES,
 305                           &extraSamples, &samplesInfo);
 306     if (!TIFFGetField(tif, TIFFTAG_PHOTOMETRIC, &photometric))
 307     {
 308         photometric = PHOTOMETRIC_MINISWHITE;
 309     }
 310     const bool hasAlpha = (extraSamples >= 1
 311         && ((samplesInfo[0] == EXTRASAMPLE_UNSPECIFIED && samplesPerPixel > 3)
 312             || samplesInfo[0] == EXTRASAMPLE_ASSOCALPHA
 313             || samplesInfo[0] == EXTRASAMPLE_UNASSALPHA))
 314         || (extraSamples == 0 && samplesPerPixel == 4
 315             && photometric == PHOTOMETRIC_RGB);
 316
 317     // guard against integer overflow during multiplication which could result
 318     // in allocating a too small buffer and then overflowing it
 319     const double bytesNeeded = (double)w * (double)h * sizeof(uint32);
 320     if ( bytesNeeded >= wxUINT32_MAX )
 321     {
 322         if ( verbose )
 323         {
 324             wxLogError( _("TIFF: Image size is abnormally big.") );
 325         }
 326
 327         TIFFClose(tif);
 328
 329         return false;
 330     }
 331
 332     raster = (uint32*) _TIFFmalloc( (uint32)bytesNeeded );
 333
 334     if (!raster)
 335     {
 336         if (verbose)
 337         {
 338             wxLogError( _("TIFF: Couldn't allocate memory.") );
 339         }
 340
 341         TIFFClose( tif );
 342
 343         return false;
 344     }
 345
 346     image->Create( (int)w, (int)h );
 347     if (!image->Ok())
 348     {
 349         if (verbose)
 350         {
 351             wxLogError( _("TIFF: Couldn't allocate memory.") );
 352         }
 353
 354         _TIFFfree( raster );
 355         TIFFClose( tif );
 356
 357         return false;
 358     }
 359
 360     if ( hasAlpha )
 361         image->SetAlpha();
 362
 363     if (!TIFFReadRGBAImage( tif, w, h, raster, 0 ))
 364     {
 365         if (verbose)
 366         {
 367             wxLogError( _("TIFF: Error reading image.") );
 368         }
 369
 370         _TIFFfree( raster );
 371         image->Destroy();
 372         TIFFClose( tif );
 373
 374         return false;
 375     }
 376
 377     unsigned char *ptr = image->GetData();
 378     ptr += w*3*(h-1);
 379
 380     unsigned char *alpha = hasAlpha ? image->GetAlpha() : NULL;
 381     if ( hasAlpha )
 382         alpha += w*(h-1);
 383
 384     uint32 pos = 0;
 385
 386     for (uint32 i = 0; i < h; i++)
 387     {
 388         for (uint32 j = 0; j < w; j++)
 389         {
 390             *(ptr++) = (unsigned char)TIFFGetR(raster[pos]);
 391             *(ptr++) = (unsigned char)TIFFGetG(raster[pos]);
 392             *(ptr++) = (unsigned char)TIFFGetB(raster[pos]);
 393             if ( hasAlpha )
 394                 *(alpha++) = (unsigned char)TIFFGetA(raster[pos]);
 395
 396             pos++;
 397         }
 398
 399         // subtract line we just added plus one line:
 400         ptr -= 2*w*3;
 401         if ( hasAlpha )
 402             alpha -= 2*w;
 403     }
 404
 405     // set the image resolution if it's available
 406     uint16 tiffRes;
 407     if ( TIFFGetField(tif, TIFFTAG_RESOLUTIONUNIT, &tiffRes) )
 408     {
 409         wxImageResolution res;
 410         switch ( tiffRes )
 411         {
 412             default:
 413                 wxLogWarning(_("Unknown TIFF resolution unit %d ignored"),
 414                              tiffRes);
 415                 // fall through
 416
 417             case RESUNIT_NONE:
 418                 res = wxIMAGE_RESOLUTION_NONE;
 419                 break;
 420
 421             case RESUNIT_INCH:
 422                 res = wxIMAGE_RESOLUTION_INCHES;
 423                 break;
 424
 425             case RESUNIT_CENTIMETER:
 426                 res = wxIMAGE_RESOLUTION_CM;
 427                 break;
 428         }
 429
 430         if ( res != wxIMAGE_RESOLUTION_NONE )
 431         {
 432             float xres, yres;
 433             if ( TIFFGetField(tif, TIFFTAG_XRESOLUTION, &xres) )
 434                 image->SetOption(wxIMAGE_OPTION_RESOLUTIONX, wxRound(xres));
 435
 436             if ( TIFFGetField(tif, TIFFTAG_YRESOLUTION, &yres) )
 437                 image->SetOption(wxIMAGE_OPTION_RESOLUTIONY, wxRound(yres));
 438         }
 439     }
 440
 441
 442     _TIFFfree( raster );
 443
 444     TIFFClose( tif );
 445
 446     return true;
 447 }
 448
 449 int wxTIFFHandler::DoGetImageCount( wxInputStream& stream )
 450 {
 451     TIFF *tif = TIFFwxOpen( stream, "image", "r" );
 452
 453     if (!tif)
 454         return 0;
 455
 456     int dircount = 0;  // according to the libtiff docs, dircount should be set to 1 here???
 457     do {
 458         dircount++;
 459     } while (TIFFReadDirectory(tif));
 460
 461     TIFFClose( tif );
 462
 463     // NOTE: this function modifies the current stream position but it's ok
 464     //       (see wxImageHandler::GetImageCount)
 465
 466     return dircount;
 467 }
 468
 469 bool wxTIFFHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbose )
 470 {
 471     TIFF *tif = TIFFwxOpen( stream, "image", "w" );
 472
 473     if (!tif)
 474     {
 475         if (verbose)
 476         {
 477             wxLogError( _("TIFF: Error saving image.") );
 478         }
 479
 480         return false;
 481     }
 482
 483     TIFFSetField(tif, TIFFTAG_ORIENTATION, ORIENTATION_TOPLEFT);
 484     TIFFSetField(tif, TIFFTAG_IMAGEWIDTH,  (uint32)image->GetWidth());
 485     TIFFSetField(tif, TIFFTAG_IMAGELENGTH, (uint32)image->GetHeight());
 486     TIFFSetField(tif, TIFFTAG_ORIENTATION, ORIENTATION_TOPLEFT);
 487     TIFFSetField(tif, TIFFTAG_PLANARCONFIG, PLANARCONFIG_CONTIG);
 488
 489     // save the image resolution if we have it
 490     int xres, yres;
 491     const wxImageResolution res = GetResolutionFromOptions(*image, &xres, &yres);
 492     uint16 tiffRes;
 493     switch ( res )
 494     {
 495         default:
 496             wxFAIL_MSG( wxT("unknown image resolution units") );
 497             // fall through
 498
 499         case wxIMAGE_RESOLUTION_NONE:
 500             tiffRes = RESUNIT_NONE;
 501             break;
 502
 503         case wxIMAGE_RESOLUTION_INCHES:
 504             tiffRes = RESUNIT_INCH;
 505             break;
 506
 507         case wxIMAGE_RESOLUTION_CM:
 508             tiffRes = RESUNIT_CENTIMETER;
 509             break;
 510     }
 511
 512     if ( tiffRes != RESUNIT_NONE )
 513     {
 514         TIFFSetField(tif, TIFFTAG_RESOLUTIONUNIT, tiffRes);
 515         TIFFSetField(tif, TIFFTAG_XRESOLUTION, (float)xres);
 516         TIFFSetField(tif, TIFFTAG_YRESOLUTION, (float)yres);
 517     }
 518
 519
 520     int spp = image->GetOptionInt(wxIMAGE_OPTION_SAMPLESPERPIXEL);
 521     if ( !spp )
 522         spp = 3;
 523
 524     int bpp = image->GetOptionInt(wxIMAGE_OPTION_BITSPERSAMPLE);
 525     if ( !bpp )
 526         bpp = 8;
 527
 528     int compression = image->GetOptionInt(wxIMAGE_OPTION_COMPRESSION);
 529     if ( !compression )
 530     {
 531         // we can't use COMPRESSION_LZW because current version of libtiff
 532         // doesn't implement it ("no longer implemented due to Unisys patent
 533         // enforcement") and other compression methods are lossy so we
 534         // shouldn't use them by default -- and the only remaining one is none
 535         compression = COMPRESSION_NONE;
 536     }
 537
 538     TIFFSetField(tif, TIFFTAG_SAMPLESPERPIXEL, spp);
 539     TIFFSetField(tif, TIFFTAG_BITSPERSAMPLE, bpp);
 540     TIFFSetField(tif, TIFFTAG_PHOTOMETRIC, spp*bpp == 1 ? PHOTOMETRIC_MINISBLACK
 541                                                         : PHOTOMETRIC_RGB);
 542     TIFFSetField(tif, TIFFTAG_COMPRESSION, compression);
 543
 544     // scanlinesize if determined by spp and bpp
 545     tsize_t linebytes = (tsize_t)image->GetWidth() * spp * bpp / 8;
 546
 547     if ( (image->GetWidth() % 8 > 0) && (spp * bpp < 8) )
 548         linebytes+=1;
 549
 550     unsigned char *buf;
 551
 552     if (TIFFScanlineSize(tif) > linebytes || (spp * bpp < 24))
 553     {
 554         buf = (unsigned char *)_TIFFmalloc(TIFFScanlineSize(tif));
 555         if (!buf)
 556         {
 557             if (verbose)
 558             {
 559                 wxLogError( _("TIFF: Couldn't allocate memory.") );
 560             }
 561
 562             TIFFClose( tif );
 563
 564             return false;
 565         }
 566     }
 567     else
 568     {
 569         buf = NULL;
 570     }
 571
 572     TIFFSetField(tif, TIFFTAG_ROWSPERSTRIP,TIFFDefaultStripSize(tif, (uint32) -1));
 573
 574     unsigned char *ptr = image->GetData();
 575     for ( int row = 0; row < image->GetHeight(); row++ )
 576     {
 577         if ( buf )
 578         {
 579             if ( spp * bpp > 1 )
 580             {
 581                 // color image
 582                 memcpy(buf, ptr, image->GetWidth());
 583             }
 584             else // black and white image
 585             {
 586                 for ( int column = 0; column < linebytes; column++ )
 587                 {
 588                     uint8 reverse = 0;
 589                     for ( int bp = 0; bp < 8; bp++ )
 590                     {
 591                         if ( ptr[column*24 + bp*3] > 0 )
 592                         {
 593                             // check only red as this is sufficient
 594                             reverse = (uint8)(reverse | 128 >> bp);
 595                         }
 596                     }
 597
 598                     buf[column] = reverse;
 599                 }
 600             }
 601         }
 602
 603         if ( TIFFWriteScanline(tif, buf ? buf : ptr, (uint32)row, 0) < 0 )
 604         {
 605             if (verbose)
 606             {
 607                 wxLogError( _("TIFF: Error writing image.") );
 608             }
 609
 610             TIFFClose( tif );
 611             if (buf)
 612                 _TIFFfree(buf);
 613
 614             return false;
 615         }
 616
 617         ptr += image->GetWidth()*3;
 618     }
 619
 620     (void) TIFFClose(tif);
 621
 622     if (buf)
 623         _TIFFfree(buf);
 624
 625     return true;
 626 }
 627
 628 bool wxTIFFHandler::DoCanRead( wxInputStream& stream )
 629 {
 630     unsigned char hdr[2];
 631
 632     if ( !stream.Read(&hdr[0], WXSIZEOF(hdr)) )     // it's ok to modify the stream position here
 633         return false;
 634
 635     return (hdr[0] == 'I' && hdr[1] == 'I') ||
 636            (hdr[0] == 'M' && hdr[1] == 'M');
 637 }
 638
 639 #endif  // wxUSE_STREAMS
 640
 641 /*static*/ wxVersionInfo wxTIFFHandler::GetLibraryVersionInfo()
 642 {
 643     int major,
 644         minor,
 645         micro;
 646
 647     const wxString ver(::TIFFGetVersion());
 648     if ( wxSscanf(ver, "LIBTIFF, Version %d.%d.%d", &major, &minor, &micro) != 3 )
 649     {
 650         wxLogDebug("Unrecognized libtiff version string \"%s\"", ver);
 651
 652         major =
 653         minor =
 654         micro = 0;
 655     }
 656
 657     wxString copyright;
 658     const wxString desc = ver.BeforeFirst('\n', &copyright);
 659     copyright.Replace("\n", "");
 660
 661     return wxVersionInfo("libtiff", major, minor, micro, desc, copyright);
 662 }
 663
 664 #endif  // wxUSE_LIBTIFF