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 #endif
  27
  28 extern "C"
  29 {
  30     #include "tiff.h"
  31     #include "tiffio.h"
  32 }
  33 #include "wx/filefn.h"
  34 #include "wx/wfstream.h"
  35 #include "wx/module.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 _tiffNullProc(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 _tiffReadProc(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 _tiffWriteProc(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 _tiffSeekIProc(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 _tiffSeekOProc(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 _tiffCloseProc(thandle_t WXUNUSED(handle))
 133 {
 134     return 0;  // ?
 135 }
 136
 137 toff_t TIFFLINKAGEMODE
 138 _tiffSizeProc(thandle_t handle)
 139 {
 140     wxStreamBase *stream = (wxStreamBase*) handle;
 141     return (toff_t) stream->GetSize();
 142 }
 143
 144 int TIFFLINKAGEMODE
 145 _tiffMapProc(thandle_t WXUNUSED(handle),
 146              tdata_t* WXUNUSED(pbase),
 147              toff_t* WXUNUSED(psize))
 148 {
 149     return 0;
 150 }
 151
 152 void TIFFLINKAGEMODE
 153 _tiffUnmapProc(thandle_t WXUNUSED(handle),
 154                tdata_t WXUNUSED(base),
 155                toff_t WXUNUSED(size))
 156 {
 157 }
 158
 159 static void
 160 TIFFwxWarningHandler(const char* module,
 161                      const char* WXUNUSED_IN_UNICODE(fmt),
 162                      va_list WXUNUSED_IN_UNICODE(ap))
 163 {
 164     if (module != NULL)
 165         wxLogWarning(_("tiff module: %s"), wxString::FromAscii(module).c_str());
 166
 167     // FIXME: this is not terrible informative but better than crashing!
 168 #if wxUSE_UNICODE
 169     wxLogWarning(_("TIFF library warning."));
 170 #else
 171     wxVLogWarning(fmt, ap);
 172 #endif
 173 }
 174
 175 static void
 176 TIFFwxErrorHandler(const char* module,
 177                    const char* WXUNUSED_IN_UNICODE(fmt),
 178                    va_list WXUNUSED_IN_UNICODE(ap))
 179 {
 180     if (module != NULL)
 181         wxLogError(_("tiff module: %s"), wxString::FromAscii(module).c_str());
 182
 183     // FIXME: as above
 184 #if wxUSE_UNICODE
 185     wxLogError(_("TIFF library error."));
 186 #else
 187     wxVLogError(fmt, ap);
 188 #endif
 189 }
 190
 191 } // extern "C"
 192
 193 TIFF*
 194 TIFFwxOpen(wxInputStream &stream, const char* name, const char* mode)
 195 {
 196     TIFF* tif = TIFFClientOpen(name, mode,
 197         (thandle_t) &stream,
 198         _tiffReadProc, _tiffNullProc,
 199         _tiffSeekIProc, _tiffCloseProc, _tiffSizeProc,
 200         _tiffMapProc, _tiffUnmapProc);
 201
 202     return tif;
 203 }
 204
 205 TIFF*
 206 TIFFwxOpen(wxOutputStream &stream, const char* name, const char* mode)
 207 {
 208     TIFF* tif = TIFFClientOpen(name, mode,
 209         (thandle_t) &stream,
 210         _tiffNullProc, _tiffWriteProc,
 211         _tiffSeekOProc, _tiffCloseProc, _tiffSizeProc,
 212         _tiffMapProc, _tiffUnmapProc);
 213
 214     return tif;
 215 }
 216
 217 wxTIFFHandler::wxTIFFHandler()
 218 {
 219     m_name = wxT("TIFF file");
 220     m_extension = wxT("tif");
 221     m_type = wxBITMAP_TYPE_TIF;
 222     m_mime = wxT("image/tiff");
 223     TIFFSetWarningHandler((TIFFErrorHandler) TIFFwxWarningHandler);
 224     TIFFSetErrorHandler((TIFFErrorHandler) TIFFwxErrorHandler);
 225 }
 226
 227 bool wxTIFFHandler::LoadFile( wxImage *image, wxInputStream& stream, bool verbose, int index )
 228 {
 229     if (index == -1)
 230         index = 0;
 231
 232     image->Destroy();
 233
 234     TIFF *tif = TIFFwxOpen( stream, "image", "r" );
 235
 236     if (!tif)
 237     {
 238         if (verbose)
 239             wxLogError( _("TIFF: Error loading image.") );
 240
 241         return false;
 242     }
 243
 244     if (!TIFFSetDirectory( tif, (tdir_t)index ))
 245     {
 246         if (verbose)
 247             wxLogError( _("Invalid TIFF image index.") );
 248
 249         TIFFClose( tif );
 250
 251         return false;
 252     }
 253
 254     uint32 w, h;
 255     uint32 npixels;
 256     uint32 *raster;
 257
 258     TIFFGetField( tif, TIFFTAG_IMAGEWIDTH, &w );
 259     TIFFGetField( tif, TIFFTAG_IMAGELENGTH, &h );
 260
 261     npixels = w * h;
 262
 263     raster = (uint32*) _TIFFmalloc( npixels * sizeof(uint32) );
 264
 265     if (!raster)
 266     {
 267         if (verbose)
 268             wxLogError( _("TIFF: Couldn't allocate memory.") );
 269
 270         TIFFClose( tif );
 271
 272         return false;
 273     }
 274
 275     image->Create( (int)w, (int)h );
 276     if (!image->Ok())
 277     {
 278         if (verbose)
 279             wxLogError( _("TIFF: Couldn't allocate memory.") );
 280
 281         _TIFFfree( raster );
 282         TIFFClose( tif );
 283
 284         return false;
 285     }
 286
 287     if (!TIFFReadRGBAImage( tif, w, h, raster, 0 ))
 288     {
 289         if (verbose)
 290             wxLogError( _("TIFF: Error reading image.") );
 291
 292         _TIFFfree( raster );
 293         image->Destroy();
 294         TIFFClose( tif );
 295
 296         return false;
 297     }
 298
 299     bool hasmask = false;
 300
 301     unsigned char *ptr = image->GetData();
 302     ptr += w*3*(h-1);
 303     uint32 pos = 0;
 304
 305     for (uint32 i = 0; i < h; i++)
 306     {
 307         for (uint32 j = 0; j < w; j++)
 308         {
 309             unsigned char alpha = (unsigned char)TIFFGetA(raster[pos]);
 310             if (alpha < 127)
 311             {
 312                 hasmask = true;
 313                 ptr[0] = image->GetMaskRed();
 314                 ptr++;
 315                 ptr[0] = image->GetMaskGreen();
 316                 ptr++;
 317                 ptr[0] = image->GetMaskBlue();
 318                 ptr++;
 319             }
 320             else
 321             {
 322                 ptr[0] = (unsigned char)TIFFGetR(raster[pos]);
 323                 ptr++;
 324                 ptr[0] = (unsigned char)TIFFGetG(raster[pos]);
 325                 ptr++;
 326                 ptr[0] = (unsigned char)TIFFGetB(raster[pos]);
 327                 ptr++;
 328             }
 329             pos++;
 330         }
 331         ptr -= 2*w*3; // subtract line we just added plus one line
 332     }
 333
 334     _TIFFfree( raster );
 335
 336     TIFFClose( tif );
 337
 338     image->SetMask( hasmask );
 339
 340     return true;
 341 }
 342
 343 int wxTIFFHandler::GetImageCount( wxInputStream& stream )
 344 {
 345     TIFF *tif = TIFFwxOpen( stream, "image", "r" );
 346
 347     if (!tif)
 348         return 0;
 349
 350     int dircount = 0;  // according to the libtiff docs, dircount should be set to 1 here???
 351     do {
 352         dircount++;
 353     } while (TIFFReadDirectory(tif));
 354
 355     TIFFClose( tif );
 356
 357     return dircount;
 358 }
 359
 360 bool wxTIFFHandler::SaveFile( wxImage *image, wxOutputStream& stream, bool verbose )
 361 {
 362     TIFF *tif = TIFFwxOpen( stream, "image", "w" );
 363
 364     if (!tif)
 365     {
 366         if (verbose)
 367             wxLogError( _("TIFF: Error saving image.") );
 368
 369         return false;
 370     }
 371
 372     TIFFSetField(tif, TIFFTAG_ORIENTATION, ORIENTATION_TOPLEFT);
 373     TIFFSetField(tif, TIFFTAG_IMAGEWIDTH,  (uint32)image->GetWidth());
 374     TIFFSetField(tif, TIFFTAG_IMAGELENGTH, (uint32)image->GetHeight());
 375     TIFFSetField(tif, TIFFTAG_ORIENTATION, ORIENTATION_TOPLEFT);
 376     TIFFSetField(tif, TIFFTAG_PLANARCONFIG, PLANARCONFIG_CONTIG);
 377
 378     if ( image->HasOption(wxIMAGE_OPTION_RESOLUTIONX) &&
 379             image->HasOption(wxIMAGE_OPTION_RESOLUTIONY) )
 380     {
 381         TIFFSetField(tif, TIFFTAG_XRESOLUTION,
 382                         (float)image->GetOptionInt(wxIMAGE_OPTION_RESOLUTIONX));
 383         TIFFSetField(tif, TIFFTAG_YRESOLUTION,
 384                         (float)image->GetOptionInt(wxIMAGE_OPTION_RESOLUTIONY));
 385     }
 386
 387     int spp = image->GetOptionInt(wxIMAGE_OPTION_SAMPLESPERPIXEL);
 388     if ( !spp )
 389         spp = 3;
 390
 391     int bpp = image->GetOptionInt(wxIMAGE_OPTION_BITSPERSAMPLE);
 392     if ( !bpp )
 393         bpp=8;
 394
 395     int compression = image->GetOptionInt(wxIMAGE_OPTION_COMPRESSION);
 396     if ( !compression )
 397     {
 398         // we can't use COMPRESSION_LZW because current version of libtiff
 399         // doesn't implement it ("no longer implemented due to Unisys patent
 400         // enforcement") and other compression methods are lossy so we
 401         // shouldn't use them by default -- and the only remaining one is none
 402         compression = COMPRESSION_NONE;
 403     }
 404
 405     TIFFSetField(tif, TIFFTAG_SAMPLESPERPIXEL, spp);
 406     TIFFSetField(tif, TIFFTAG_BITSPERSAMPLE, bpp);
 407     TIFFSetField(tif, TIFFTAG_PHOTOMETRIC, spp*bpp == 1 ? PHOTOMETRIC_MINISBLACK
 408                                                         : PHOTOMETRIC_RGB);
 409     TIFFSetField(tif, TIFFTAG_COMPRESSION, compression);
 410
 411     // scanlinesize if determined by spp and bpp
 412     tsize_t linebytes = (tsize_t)image->GetWidth() * spp * bpp / 8;
 413
 414     if ( (image->GetWidth() % 8 > 0) && (spp * bpp < 8) )
 415         linebytes+=1;
 416
 417     unsigned char *buf;
 418
 419     if (TIFFScanlineSize(tif) > linebytes || (spp * bpp < 24))
 420     {
 421         buf = (unsigned char *)_TIFFmalloc(TIFFScanlineSize(tif));
 422         if (!buf)
 423         {
 424             if (verbose)
 425                 wxLogError( _("TIFF: Couldn't allocate memory.") );
 426
 427             TIFFClose( tif );
 428
 429             return false;
 430         }
 431     }
 432     else
 433     {
 434         buf = NULL;
 435     }
 436
 437     TIFFSetField(tif, TIFFTAG_ROWSPERSTRIP,TIFFDefaultStripSize(tif, (uint32) -1));
 438
 439     unsigned char *ptr = image->GetData();
 440     for ( int row = 0; row < image->GetHeight(); row++ )
 441     {
 442         if ( buf )
 443         {
 444             if ( spp * bpp > 1 )
 445             {
 446                 // color image
 447                 memcpy(buf, ptr, image->GetWidth());
 448             }
 449             else // black and white image
 450             {
 451                 for ( int column = 0; column < linebytes; column++ )
 452                 {
 453                     uint8 reverse = 0;
 454                     for ( int bp = 0; bp < 8; bp++ )
 455                     {
 456                         if ( ptr[column*24 + bp*3] > 0 )
 457                         {
 458                             // check only red as this is sufficient
 459                             reverse = (uint8)(reverse | 128 >> bp);
 460                         }
 461                     }
 462
 463                     buf[column] = reverse;
 464                 }
 465             }
 466         }
 467
 468         if ( TIFFWriteScanline(tif, buf ? buf : ptr, (uint32)row, 0) < 0 )
 469         {
 470             if (verbose)
 471                 wxLogError( _("TIFF: Error writing image.") );
 472
 473             TIFFClose( tif );
 474             if (buf)
 475                 _TIFFfree(buf);
 476
 477             return false;
 478         }
 479
 480         ptr += image->GetWidth()*3;
 481     }
 482
 483     (void) TIFFClose(tif);
 484
 485     if (buf)
 486         _TIFFfree(buf);
 487
 488     return true;
 489 }
 490
 491 bool wxTIFFHandler::DoCanRead( wxInputStream& stream )
 492 {
 493     unsigned char hdr[2];
 494
 495     if ( !stream.Read(&hdr[0], WXSIZEOF(hdr)) )
 496         return false;
 497
 498     return (hdr[0] == 'I' && hdr[1] == 'I') ||
 499            (hdr[0] == 'M' && hdr[1] == 'M');
 500 }
 501
 502 #endif  // wxUSE_STREAMS
 503
 504 #endif  // wxUSE_LIBTIFF