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_TIF
;
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 uint16 spp
, bpp
, compression
;
442 Read some baseline TIFF tags which helps when re-saving a TIFF
443 to be similar to the original image.
445 if ( TIFFGetFieldDefaulted(tif
, TIFFTAG_SAMPLESPERPIXEL
, &spp
) )
447 image
->SetOption(wxIMAGE_OPTION_SAMPLESPERPIXEL
, spp
);
450 if ( TIFFGetFieldDefaulted(tif
, TIFFTAG_BITSPERSAMPLE
, &bpp
) )
452 image
->SetOption(wxIMAGE_OPTION_BITSPERSAMPLE
, bpp
);
455 if ( TIFFGetFieldDefaulted(tif
, TIFFTAG_COMPRESSION
, &compression
) )
457 image
->SetOption(wxIMAGE_OPTION_COMPRESSION
, compression
);
460 // Set the resolution unit.
461 wxImageResolution resUnit
= wxIMAGE_RESOLUTION_NONE
;
463 if ( TIFFGetFieldDefaulted(tif
, TIFFTAG_RESOLUTIONUNIT
, &tiffRes
) )
468 wxLogWarning(_("Unknown TIFF resolution unit %d ignored"),
473 resUnit
= wxIMAGE_RESOLUTION_NONE
;
477 resUnit
= wxIMAGE_RESOLUTION_INCHES
;
480 case RESUNIT_CENTIMETER
:
481 resUnit
= wxIMAGE_RESOLUTION_CM
;
486 image
->SetOption(wxIMAGE_OPTION_RESOLUTIONUNIT
, resUnit
);
489 Set the image resolution if it's available. Resolution tag is not
490 dependant on RESOLUTIONUNIT != RESUNIT_NONE (according to TIFF spec).
494 if ( TIFFGetField(tif
, TIFFTAG_XRESOLUTION
, &resX
) )
497 Use a string value to not lose precision.
498 rounding to int as cm and then converting to inch may
499 result in whole integer rounding error, eg. 201 instead of 200 dpi.
500 If an app wants an int, GetOptionInt will convert and round down.
502 image
->SetOption(wxIMAGE_OPTION_RESOLUTIONX
,
503 wxString::FromCDouble((double) resX
));
506 if ( TIFFGetField(tif
, TIFFTAG_YRESOLUTION
, &resY
) )
508 image
->SetOption(wxIMAGE_OPTION_RESOLUTIONY
,
509 wxString::FromCDouble((double) resY
));
519 int wxTIFFHandler::DoGetImageCount( wxInputStream
& stream
)
521 TIFF
*tif
= TIFFwxOpen( stream
, "image", "r" );
526 int dircount
= 0; // according to the libtiff docs, dircount should be set to 1 here???
529 } while (TIFFReadDirectory(tif
));
533 // NOTE: this function modifies the current stream position but it's ok
534 // (see wxImageHandler::GetImageCount)
539 bool wxTIFFHandler::SaveFile( wxImage
*image
, wxOutputStream
& stream
, bool verbose
)
541 TIFF
*tif
= TIFFwxOpen( stream
, "image", "w" );
547 wxLogError( _("TIFF: Error saving image.") );
553 TIFFSetField(tif
, TIFFTAG_ORIENTATION
, ORIENTATION_TOPLEFT
);
554 TIFFSetField(tif
, TIFFTAG_IMAGEWIDTH
, (uint32
)image
->GetWidth());
555 TIFFSetField(tif
, TIFFTAG_IMAGELENGTH
, (uint32
)image
->GetHeight());
556 TIFFSetField(tif
, TIFFTAG_ORIENTATION
, ORIENTATION_TOPLEFT
);
557 TIFFSetField(tif
, TIFFTAG_PLANARCONFIG
, PLANARCONFIG_CONTIG
);
559 // save the image resolution if we have it
561 const wxImageResolution res
= GetResolutionFromOptions(*image
, &xres
, &yres
);
566 wxFAIL_MSG( wxT("unknown image resolution units") );
569 case wxIMAGE_RESOLUTION_NONE
:
570 tiffRes
= RESUNIT_NONE
;
573 case wxIMAGE_RESOLUTION_INCHES
:
574 tiffRes
= RESUNIT_INCH
;
577 case wxIMAGE_RESOLUTION_CM
:
578 tiffRes
= RESUNIT_CENTIMETER
;
582 if ( tiffRes
!= RESUNIT_NONE
)
584 TIFFSetField(tif
, TIFFTAG_RESOLUTIONUNIT
, tiffRes
);
585 TIFFSetField(tif
, TIFFTAG_XRESOLUTION
, (float)xres
);
586 TIFFSetField(tif
, TIFFTAG_YRESOLUTION
, (float)yres
);
590 int spp
= image
->GetOptionInt(wxIMAGE_OPTION_SAMPLESPERPIXEL
);
594 int bpp
= image
->GetOptionInt(wxIMAGE_OPTION_BITSPERSAMPLE
);
598 int compression
= image
->GetOptionInt(wxIMAGE_OPTION_COMPRESSION
);
601 // we can't use COMPRESSION_LZW because current version of libtiff
602 // doesn't implement it ("no longer implemented due to Unisys patent
603 // enforcement") and other compression methods are lossy so we
604 // shouldn't use them by default -- and the only remaining one is none
605 compression
= COMPRESSION_NONE
;
608 TIFFSetField(tif
, TIFFTAG_SAMPLESPERPIXEL
, spp
);
609 TIFFSetField(tif
, TIFFTAG_BITSPERSAMPLE
, bpp
);
610 TIFFSetField(tif
, TIFFTAG_PHOTOMETRIC
, spp
*bpp
== 1 ? PHOTOMETRIC_MINISBLACK
612 TIFFSetField(tif
, TIFFTAG_COMPRESSION
, compression
);
614 // scanlinesize if determined by spp and bpp
615 tsize_t linebytes
= (tsize_t
)image
->GetWidth() * spp
* bpp
/ 8;
617 if ( (image
->GetWidth() % 8 > 0) && (spp
* bpp
< 8) )
622 if (TIFFScanlineSize(tif
) > linebytes
|| (spp
* bpp
< 24))
624 buf
= (unsigned char *)_TIFFmalloc(TIFFScanlineSize(tif
));
629 wxLogError( _("TIFF: Couldn't allocate memory.") );
642 TIFFSetField(tif
, TIFFTAG_ROWSPERSTRIP
,TIFFDefaultStripSize(tif
, (uint32
) -1));
644 unsigned char *ptr
= image
->GetData();
645 for ( int row
= 0; row
< image
->GetHeight(); row
++ )
652 memcpy(buf
, ptr
, image
->GetWidth());
654 else // black and white image
656 for ( int column
= 0; column
< linebytes
; column
++ )
659 for ( int bp
= 0; bp
< 8; bp
++ )
661 if ( ptr
[column
*24 + bp
*3] > 0 )
663 // check only red as this is sufficient
664 reverse
= (uint8
)(reverse
| 128 >> bp
);
668 buf
[column
] = reverse
;
673 if ( TIFFWriteScanline(tif
, buf
? buf
: ptr
, (uint32
)row
, 0) < 0 )
677 wxLogError( _("TIFF: Error writing image.") );
687 ptr
+= image
->GetWidth()*3;
690 (void) TIFFClose(tif
);
698 bool wxTIFFHandler::DoCanRead( wxInputStream
& stream
)
700 unsigned char hdr
[2];
702 if ( !stream
.Read(&hdr
[0], WXSIZEOF(hdr
)) ) // it's ok to modify the stream position here
705 return (hdr
[0] == 'I' && hdr
[1] == 'I') ||
706 (hdr
[0] == 'M' && hdr
[1] == 'M');
709 #endif // wxUSE_STREAMS
711 /*static*/ wxVersionInfo
wxTIFFHandler::GetLibraryVersionInfo()
717 const wxString
ver(::TIFFGetVersion());
718 if ( wxSscanf(ver
, "LIBTIFF, Version %d.%d.%d", &major
, &minor
, µ
) != 3 )
720 wxLogDebug("Unrecognized libtiff version string \"%s\"", ver
);
728 const wxString desc
= ver
.BeforeFirst('\n', ©right
);
729 copyright
.Replace("\n", "");
731 return wxVersionInfo("libtiff", major
, minor
, micro
, desc
, copyright
);
734 #endif // wxUSE_LIBTIFF