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