1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/common/imagtiff.cpp
3 // Purpose: wxImage TIFF handler
4 // Author: Robert Roebling
6 // Copyright: (c) Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 // ============================================================================
12 // ============================================================================
14 // ----------------------------------------------------------------------------
16 // ----------------------------------------------------------------------------
18 // For compilers that support precompilation, includes "wx.h".
19 #include "wx/wxprec.h"
25 #if wxUSE_IMAGE && wxUSE_LIBTIFF
27 #include "wx/imagtiff.h"
28 #include "wx/versioninfo.h"
34 #include "wx/bitmap.h"
35 #include "wx/module.h"
36 #include "wx/wxcrtvararg.h"
42 #include "tif_config.h"
47 #include "wx/filefn.h"
48 #include "wx/wfstream.h"
50 #ifndef TIFFLINKAGEMODE
51 #if defined(__WATCOMC__) && defined(__WXMGL__)
52 #define TIFFLINKAGEMODE cdecl
54 #define TIFFLINKAGEMODE LINKAGEMODE
58 // ============================================================================
60 // ============================================================================
62 // ----------------------------------------------------------------------------
63 // TIFF library error/warning handlers
64 // ----------------------------------------------------------------------------
67 FormatTiffMessage(const char *module, const char *fmt
, va_list ap
)
70 if ( wxCRT_VsnprintfA(buf
, WXSIZEOF(buf
), fmt
, ap
) <= 0 )
72 // this isn't supposed to happen, but if it does, it's better
74 strcpy(buf
, "Incorrectly formatted TIFF message");
76 buf
[WXSIZEOF(buf
)-1] = 0; // make sure it is always NULL-terminated
80 msg
+= wxString::Format(_(" (in module \"%s\")"), module);
89 TIFFwxWarningHandler(const char* module, const char *fmt
, va_list ap
)
91 wxLogWarning("%s", FormatTiffMessage(module, fmt
, ap
));
95 TIFFwxErrorHandler(const char* module, const char *fmt
, va_list ap
)
97 wxLogError("%s", FormatTiffMessage(module, fmt
, ap
));
102 //-----------------------------------------------------------------------------
104 //-----------------------------------------------------------------------------
106 IMPLEMENT_DYNAMIC_CLASS(wxTIFFHandler
,wxImageHandler
)
108 wxTIFFHandler::wxTIFFHandler()
110 m_name
= wxT("TIFF file");
111 m_extension
= wxT("tif");
112 m_altExtensions
.Add(wxT("tiff"));
113 m_type
= wxBITMAP_TYPE_TIFF
;
114 m_mime
= wxT("image/tiff");
115 TIFFSetWarningHandler((TIFFErrorHandler
) TIFFwxWarningHandler
);
116 TIFFSetErrorHandler((TIFFErrorHandler
) TIFFwxErrorHandler
);
121 // helper to translate our, possibly 64 bit, wxFileOffset to TIFF, always 32
123 static toff_t
wxFileOffsetToTIFF(wxFileOffset ofs
)
125 if ( ofs
== wxInvalidOffset
)
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") );
135 // another helper to convert standard seek mode to our
136 static wxSeekMode
wxSeekModeFromTIFF(int whence
)
144 return wxFromCurrent
;
150 return wxFromCurrent
;
157 tsize_t TIFFLINKAGEMODE
158 wxTIFFNullProc(thandle_t
WXUNUSED(handle
),
159 tdata_t
WXUNUSED(buf
),
160 tsize_t
WXUNUSED(size
))
165 tsize_t TIFFLINKAGEMODE
166 wxTIFFReadProc(thandle_t handle
, tdata_t buf
, tsize_t size
)
168 wxInputStream
*stream
= (wxInputStream
*) handle
;
169 stream
->Read( (void*) buf
, (size_t) size
);
170 return wx_truncate_cast(tsize_t
, stream
->LastRead());
173 tsize_t TIFFLINKAGEMODE
174 wxTIFFWriteProc(thandle_t handle
, tdata_t buf
, tsize_t size
)
176 wxOutputStream
*stream
= (wxOutputStream
*) handle
;
177 stream
->Write( (void*) buf
, (size_t) size
);
178 return wx_truncate_cast(tsize_t
, stream
->LastWrite());
181 toff_t TIFFLINKAGEMODE
182 wxTIFFSeekIProc(thandle_t handle
, toff_t off
, int whence
)
184 wxInputStream
*stream
= (wxInputStream
*) handle
;
186 return wxFileOffsetToTIFF(stream
->SeekI((wxFileOffset
)off
,
187 wxSeekModeFromTIFF(whence
)));
190 toff_t TIFFLINKAGEMODE
191 wxTIFFSeekOProc(thandle_t handle
, toff_t off
, int whence
)
193 wxOutputStream
*stream
= (wxOutputStream
*) handle
;
195 toff_t offset
= wxFileOffsetToTIFF(
196 stream
->SeekO((wxFileOffset
)off
, wxSeekModeFromTIFF(whence
)) );
198 if (offset
!= (toff_t
) -1 || whence
!= SEEK_SET
)
205 Try to workaround problems with libtiff seeking past the end of streams.
207 This occurs when libtiff is writing tag entries past the end of a
208 stream but hasn't written the directory yet (which will be placed
209 before the tags and contain offsets to the just written tags).
210 The behaviour for seeking past the end of a stream is not consistent
211 and doesn't work with for example wxMemoryOutputStream. When this type
212 of seeking fails (with SEEK_SET), fill in the gap with zeroes and try
216 wxFileOffset streamLength
= stream
->GetLength();
217 if (streamLength
!= wxInvalidOffset
&& (wxFileOffset
) off
> streamLength
)
219 if (stream
->SeekO(streamLength
, wxFromStart
) == wxInvalidOffset
)
224 for (wxFileOffset i
= 0; i
< (wxFileOffset
) off
- streamLength
; ++i
)
230 return wxFileOffsetToTIFF( stream
->TellO() );
234 wxTIFFCloseIProc(thandle_t
WXUNUSED(handle
))
236 // there is no need to close the input stream
241 wxTIFFCloseOProc(thandle_t handle
)
243 wxOutputStream
*stream
= (wxOutputStream
*) handle
;
245 return stream
->Close() ? 0 : -1;
248 toff_t TIFFLINKAGEMODE
249 wxTIFFSizeProc(thandle_t handle
)
251 wxStreamBase
*stream
= (wxStreamBase
*) handle
;
252 return (toff_t
) stream
->GetSize();
256 wxTIFFMapProc(thandle_t
WXUNUSED(handle
),
257 tdata_t
* WXUNUSED(pbase
),
258 toff_t
* WXUNUSED(psize
))
264 wxTIFFUnmapProc(thandle_t
WXUNUSED(handle
),
265 tdata_t
WXUNUSED(base
),
266 toff_t
WXUNUSED(size
))
273 TIFFwxOpen(wxInputStream
&stream
, const char* name
, const char* mode
)
275 TIFF
* tif
= TIFFClientOpen(name
, mode
,
277 wxTIFFReadProc
, wxTIFFNullProc
,
278 wxTIFFSeekIProc
, wxTIFFCloseIProc
, wxTIFFSizeProc
,
279 wxTIFFMapProc
, wxTIFFUnmapProc
);
285 TIFFwxOpen(wxOutputStream
&stream
, const char* name
, const char* mode
)
287 TIFF
* tif
= TIFFClientOpen(name
, mode
,
289 wxTIFFNullProc
, wxTIFFWriteProc
,
290 wxTIFFSeekOProc
, wxTIFFCloseOProc
, wxTIFFSizeProc
,
291 wxTIFFMapProc
, wxTIFFUnmapProc
);
296 bool wxTIFFHandler::LoadFile( wxImage
*image
, wxInputStream
& stream
, bool verbose
, int index
)
303 TIFF
*tif
= TIFFwxOpen( stream
, "image", "r" );
309 wxLogError( _("TIFF: Error loading image.") );
315 if (!TIFFSetDirectory( tif
, (tdir_t
)index
))
319 wxLogError( _("Invalid TIFF image index.") );
330 TIFFGetField( tif
, TIFFTAG_IMAGEWIDTH
, &w
);
331 TIFFGetField( tif
, TIFFTAG_IMAGELENGTH
, &h
);
334 uint16 samplesPerPixel
;
337 TIFFGetFieldDefaulted(tif
, TIFFTAG_SAMPLESPERPIXEL
, &samplesPerPixel
);
338 TIFFGetFieldDefaulted(tif
, TIFFTAG_EXTRASAMPLES
,
339 &extraSamples
, &samplesInfo
);
340 if (!TIFFGetField(tif
, TIFFTAG_PHOTOMETRIC
, &photometric
))
342 photometric
= PHOTOMETRIC_MINISWHITE
;
344 const bool hasAlpha
= (extraSamples
>= 1
345 && ((samplesInfo
[0] == EXTRASAMPLE_UNSPECIFIED
&& samplesPerPixel
> 3)
346 || samplesInfo
[0] == EXTRASAMPLE_ASSOCALPHA
347 || samplesInfo
[0] == EXTRASAMPLE_UNASSALPHA
))
348 || (extraSamples
== 0 && samplesPerPixel
== 4
349 && photometric
== PHOTOMETRIC_RGB
);
351 // guard against integer overflow during multiplication which could result
352 // in allocating a too small buffer and then overflowing it
353 const double bytesNeeded
= (double)w
* (double)h
* sizeof(uint32
);
354 if ( bytesNeeded
>= wxUINT32_MAX
)
358 wxLogError( _("TIFF: Image size is abnormally big.") );
366 raster
= (uint32
*) _TIFFmalloc( (uint32
)bytesNeeded
);
372 wxLogError( _("TIFF: Couldn't allocate memory.") );
380 image
->Create( (int)w
, (int)h
);
385 wxLogError( _("TIFF: Couldn't allocate memory.") );
397 if (!TIFFReadRGBAImage( tif
, w
, h
, raster
, 0 ))
401 wxLogError( _("TIFF: Error reading image.") );
411 unsigned char *ptr
= image
->GetData();
414 unsigned char *alpha
= hasAlpha
? image
->GetAlpha() : NULL
;
420 for (uint32 i
= 0; i
< h
; i
++)
422 for (uint32 j
= 0; j
< w
; j
++)
424 *(ptr
++) = (unsigned char)TIFFGetR(raster
[pos
]);
425 *(ptr
++) = (unsigned char)TIFFGetG(raster
[pos
]);
426 *(ptr
++) = (unsigned char)TIFFGetB(raster
[pos
]);
428 *(alpha
++) = (unsigned char)TIFFGetA(raster
[pos
]);
433 // subtract line we just added plus one line:
440 image
->SetOption(wxIMAGE_OPTION_TIFF_PHOTOMETRIC
, photometric
);
442 uint16 spp
, bps
, compression
;
444 Read some baseline TIFF tags which helps when re-saving a TIFF
445 to be similar to the original image.
447 if ( TIFFGetFieldDefaulted(tif
, TIFFTAG_SAMPLESPERPIXEL
, &spp
) )
449 image
->SetOption(wxIMAGE_OPTION_TIFF_SAMPLESPERPIXEL
, spp
);
452 if ( TIFFGetFieldDefaulted(tif
, TIFFTAG_BITSPERSAMPLE
, &bps
) )
454 image
->SetOption(wxIMAGE_OPTION_TIFF_BITSPERSAMPLE
, bps
);
457 if ( TIFFGetFieldDefaulted(tif
, TIFFTAG_COMPRESSION
, &compression
) )
459 image
->SetOption(wxIMAGE_OPTION_TIFF_COMPRESSION
, compression
);
462 // Set the resolution unit.
463 wxImageResolution resUnit
= wxIMAGE_RESOLUTION_NONE
;
465 if ( TIFFGetFieldDefaulted(tif
, TIFFTAG_RESOLUTIONUNIT
, &tiffRes
) )
470 wxLogWarning(_("Unknown TIFF resolution unit %d ignored"),
475 resUnit
= wxIMAGE_RESOLUTION_NONE
;
479 resUnit
= wxIMAGE_RESOLUTION_INCHES
;
482 case RESUNIT_CENTIMETER
:
483 resUnit
= wxIMAGE_RESOLUTION_CM
;
488 image
->SetOption(wxIMAGE_OPTION_RESOLUTIONUNIT
, resUnit
);
491 Set the image resolution if it's available. Resolution tag is not
492 dependant on RESOLUTIONUNIT != RESUNIT_NONE (according to TIFF spec).
496 if ( TIFFGetField(tif
, TIFFTAG_XRESOLUTION
, &resX
) )
499 Use a string value to not lose precision.
500 rounding to int as cm and then converting to inch may
501 result in whole integer rounding error, eg. 201 instead of 200 dpi.
502 If an app wants an int, GetOptionInt will convert and round down.
504 image
->SetOption(wxIMAGE_OPTION_RESOLUTIONX
,
505 wxString::FromCDouble((double) resX
));
508 if ( TIFFGetField(tif
, TIFFTAG_YRESOLUTION
, &resY
) )
510 image
->SetOption(wxIMAGE_OPTION_RESOLUTIONY
,
511 wxString::FromCDouble((double) resY
));
521 int wxTIFFHandler::DoGetImageCount( wxInputStream
& stream
)
523 TIFF
*tif
= TIFFwxOpen( stream
, "image", "r" );
528 int dircount
= 0; // according to the libtiff docs, dircount should be set to 1 here???
531 } while (TIFFReadDirectory(tif
));
535 // NOTE: this function modifies the current stream position but it's ok
536 // (see wxImageHandler::GetImageCount)
541 bool wxTIFFHandler::SaveFile( wxImage
*image
, wxOutputStream
& stream
, bool verbose
)
543 TIFF
*tif
= TIFFwxOpen( stream
, "image", "w" );
549 wxLogError( _("TIFF: Error saving image.") );
555 TIFFSetField(tif
, TIFFTAG_ORIENTATION
, ORIENTATION_TOPLEFT
);
556 TIFFSetField(tif
, TIFFTAG_IMAGEWIDTH
, (uint32
)image
->GetWidth());
557 TIFFSetField(tif
, TIFFTAG_IMAGELENGTH
, (uint32
)image
->GetHeight());
558 TIFFSetField(tif
, TIFFTAG_ORIENTATION
, ORIENTATION_TOPLEFT
);
559 TIFFSetField(tif
, TIFFTAG_PLANARCONFIG
, PLANARCONFIG_CONTIG
);
561 // save the image resolution if we have it
563 const wxImageResolution res
= GetResolutionFromOptions(*image
, &xres
, &yres
);
568 wxFAIL_MSG( wxT("unknown image resolution units") );
571 case wxIMAGE_RESOLUTION_NONE
:
572 tiffRes
= RESUNIT_NONE
;
575 case wxIMAGE_RESOLUTION_INCHES
:
576 tiffRes
= RESUNIT_INCH
;
579 case wxIMAGE_RESOLUTION_CM
:
580 tiffRes
= RESUNIT_CENTIMETER
;
584 if ( tiffRes
!= RESUNIT_NONE
)
586 TIFFSetField(tif
, TIFFTAG_RESOLUTIONUNIT
, tiffRes
);
587 TIFFSetField(tif
, TIFFTAG_XRESOLUTION
, (float)xres
);
588 TIFFSetField(tif
, TIFFTAG_YRESOLUTION
, (float)yres
);
592 int spp
= image
->GetOptionInt(wxIMAGE_OPTION_TIFF_SAMPLESPERPIXEL
);
596 int bps
= image
->GetOptionInt(wxIMAGE_OPTION_TIFF_BITSPERSAMPLE
);
603 // One bit per sample combined with 3 samples per pixel is
604 // not allowed and crashes libtiff.
608 int photometric
= PHOTOMETRIC_RGB
;
610 if ( image
->HasOption(wxIMAGE_OPTION_TIFF_PHOTOMETRIC
) )
612 photometric
= image
->GetOptionInt(wxIMAGE_OPTION_TIFF_PHOTOMETRIC
);
613 if (photometric
== PHOTOMETRIC_MINISWHITE
614 || photometric
== PHOTOMETRIC_MINISBLACK
)
616 // either b/w or greyscale
622 photometric
= PHOTOMETRIC_MINISWHITE
;
625 const bool isColouredImage
= (spp
> 1)
626 && (photometric
!= PHOTOMETRIC_MINISWHITE
)
627 && (photometric
!= PHOTOMETRIC_MINISBLACK
);
629 int compression
= image
->GetOptionInt(wxIMAGE_OPTION_TIFF_COMPRESSION
);
632 // we can't use COMPRESSION_LZW because current version of libtiff
633 // doesn't implement it ("no longer implemented due to Unisys patent
634 // enforcement") and other compression methods are lossy so we
635 // shouldn't use them by default -- and the only remaining one is none
636 compression
= COMPRESSION_NONE
;
639 TIFFSetField(tif
, TIFFTAG_SAMPLESPERPIXEL
, spp
);
640 TIFFSetField(tif
, TIFFTAG_BITSPERSAMPLE
, bps
);
641 TIFFSetField(tif
, TIFFTAG_PHOTOMETRIC
, photometric
);
642 TIFFSetField(tif
, TIFFTAG_COMPRESSION
, compression
);
644 // scanlinesize if determined by spp and bps
645 tsize_t linebytes
= (tsize_t
)image
->GetWidth() * spp
* bps
/ 8;
647 if ( (image
->GetWidth() % 8 > 0) && (spp
* bps
< 8) )
652 if (TIFFScanlineSize(tif
) > linebytes
|| !isColouredImage
)
654 buf
= (unsigned char *)_TIFFmalloc(TIFFScanlineSize(tif
));
659 wxLogError( _("TIFF: Couldn't allocate memory.") );
672 TIFFSetField(tif
, TIFFTAG_ROWSPERSTRIP
,TIFFDefaultStripSize(tif
, (uint32
) -1));
674 const bool minIsWhite
= (photometric
== PHOTOMETRIC_MINISWHITE
);
675 unsigned char *ptr
= image
->GetData();
676 for ( int row
= 0; row
< image
->GetHeight(); row
++ )
683 memcpy(buf
, ptr
, image
->GetWidth());
685 else if (spp
* bps
== 8) // greyscale image
687 for ( int column
= 0; column
< linebytes
; column
++ )
689 uint8 value
= ptr
[column
*3 + 1];
698 else // black and white image
700 for ( int column
= 0; column
< linebytes
; column
++ )
703 for ( int bp
= 0; bp
< 8; bp
++ )
705 if ( (ptr
[column
*24 + bp
*3 + 1] <=127) == minIsWhite
)
707 // check only green as this is sufficient
708 reverse
= (uint8
)(reverse
| 128 >> bp
);
712 buf
[column
] = reverse
;
717 if ( TIFFWriteScanline(tif
, buf
? buf
: ptr
, (uint32
)row
, 0) < 0 )
721 wxLogError( _("TIFF: Error writing image.") );
731 ptr
+= image
->GetWidth()*3;
734 (void) TIFFClose(tif
);
742 bool wxTIFFHandler::DoCanRead( wxInputStream
& stream
)
744 unsigned char hdr
[2];
746 if ( !stream
.Read(&hdr
[0], WXSIZEOF(hdr
)) ) // it's ok to modify the stream position here
749 return (hdr
[0] == 'I' && hdr
[1] == 'I') ||
750 (hdr
[0] == 'M' && hdr
[1] == 'M');
753 #endif // wxUSE_STREAMS
755 /*static*/ wxVersionInfo
wxTIFFHandler::GetLibraryVersionInfo()
761 const wxString
ver(::TIFFGetVersion());
762 if ( wxSscanf(ver
, "LIBTIFF, Version %d.%d.%d", &major
, &minor
, µ
) != 3 )
764 wxLogDebug("Unrecognized libtiff version string \"%s\"", ver
);
772 const wxString desc
= ver
.BeforeFirst('\n', ©right
);
773 copyright
.Replace("\n", "");
775 return wxVersionInfo("libtiff", major
, minor
, micro
, desc
, copyright
);
778 #endif // wxUSE_LIBTIFF