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