[gimp/wip/wormnest/windows-tiff-delete: 61/61] plug-ins: fix #3740 Impossible to delete multi page tiff with thumbnail

[Jacob Boerema <jboerema src gnome org>]

commit 42e61104d71a37f15cbc64d09b54e367db570afd
Author: Jacob Boerema <jgboerema gmail com>
Date:   Fri Aug 27 15:34:26 2021 -0400

    plug-ins: fix #3740 Impossible to delete multi page tiff with thumbnail
    
    On Windows there is a long standing issue in its File Explorer. When
    GIMP exported as a multi page (multi-layer) TIFF with thumbnail saving
    enabled, then the Windows thumbnailer apparently gets stuck and does not
    close the TIFF file when browsing a folder. Because those files are not
    closed it is impossible to delete them. This issue has been reported
    many times over the years to Microsoft without any reaction.
    
    Investigation showed us that this lock up only happens when we save the
    thumbnail as a subifd. To resolve this issue we change this and now let
    exiv2 handle our thumbnail saving, just as for other image formats. For
    TIFF this means the thumbnail is saved as the second page of a TIFF.
    
    Previous commits have made sure that it is now easier to recognize a TIFF
    page as a thumbnail and to make sure we don't load thumbnail TIFF pages.
    
    Since saving as a subifd is what made TIFF thumbnail saving different
    from other formats, this commit consists of only removal of code.

 plug-ins/file-tiff/file-tiff-save.c | 106 ------------------------------------
 1 file changed, 106 deletions(-)
---
diff --git a/plug-ins/file-tiff/file-tiff-save.c b/plug-ins/file-tiff/file-tiff-save.c
index daea3f8501..8ac722f9f0 100644
--- a/plug-ins/file-tiff/file-tiff-save.c
+++ b/plug-ins/file-tiff/file-tiff-save.c
@@ -75,9 +75,6 @@ static void      byte2bit               (const guchar  *byteline,
                                          guchar        *bitline,
                                          gboolean       invert);
 
-static void      save_thumbnail         (GimpImage     *image,
-                                         TIFF          *tif);
-
 
 static void
 double_to_psd_fixed (gdouble  value,
@@ -910,85 +907,6 @@ out:
   return status;
 }
 
-static void
-save_thumbnail (GimpImage *image,
-                TIFF      *tif)
-{
-  /* now switch IFD and write thumbnail
-   *
-   * the thumbnail must be saved in a subimage of the image.
-   * otherwise the thumbnail will be saved in a second page of the
-   * same image.
-   *
-   * Exif saves the thumbnail as a second page. To avoid this, the
-   * thumbnail must be saved with the functions of libtiff.
-   */
-
-  GdkPixbuf *thumb_pixbuf;
-  guchar    *thumb_pixels;
-  guchar    *buf;
-  gint       image_width;
-  gint       image_height;
-  gint       thumbw;
-  gint       thumbh;
-  gint       x, y;
-
-#define EXIF_THUMBNAIL_SIZE 256
-
-  image_width  = gimp_image_get_width  (image);
-  image_height = gimp_image_get_height (image);
-
-  if (image_width > image_height)
-    {
-      thumbw = EXIF_THUMBNAIL_SIZE;
-      thumbh = EXIF_THUMBNAIL_SIZE * image_height / image_width;
-    }
-  else
-    {
-      thumbh = EXIF_THUMBNAIL_SIZE;
-      thumbw = EXIF_THUMBNAIL_SIZE * image_width / image_height;
-    }
-
-  thumb_pixbuf = gimp_image_get_thumbnail (image, thumbw, thumbh,
-                                           GIMP_PIXBUF_KEEP_ALPHA);
-
-  thumb_pixels = gdk_pixbuf_get_pixels (thumb_pixbuf);
-
-  TIFFSetField (tif, TIFFTAG_SUBFILETYPE, FILETYPE_REDUCEDIMAGE);
-  TIFFSetField (tif, TIFFTAG_IMAGEWIDTH, thumbw);
-  TIFFSetField (tif, TIFFTAG_IMAGELENGTH, thumbh);
-  TIFFSetField (tif, TIFFTAG_BITSPERSAMPLE, 8);
-  TIFFSetField (tif, TIFFTAG_PHOTOMETRIC, PHOTOMETRIC_RGB);
-  TIFFSetField (tif, TIFFTAG_ROWSPERSTRIP, thumbh);
-  TIFFSetField (tif, TIFFTAG_COMPRESSION, COMPRESSION_NONE);
-  TIFFSetField (tif, TIFFTAG_SAMPLEFORMAT, SAMPLEFORMAT_UINT);
-  TIFFSetField (tif, TIFFTAG_PLANARCONFIG, PLANARCONFIG_CONTIG);
-  TIFFSetField (tif, TIFFTAG_SAMPLESPERPIXEL, 3);
-
-  buf = _TIFFmalloc (thumbw * 3);
-
-  for (y = 0; y < thumbh; y++)
-    {
-      guchar *p = buf;
-
-      for (x = 0; x < thumbw; x++)
-        {
-          *p++ = *thumb_pixels++; /* r */
-          *p++ = *thumb_pixels++; /* g */
-          *p++ = *thumb_pixels++; /* b */
-          thumb_pixels++;
-        }
-
-      TIFFWriteScanline (tif, buf, y, 0);
-    }
-
-  _TIFFfree (buf);
-
-  TIFFWriteDirectory (tif);
-
-  g_object_unref (thumb_pixbuf);
-}
-
 /* FIXME Most of the stuff in save_metadata except the
  * thumbnail saving should probably be moved to
  * gimpmetadata.c and gimpmetadata-save.c.
@@ -1001,7 +919,6 @@ save_metadata (GFile        *file,
                gint          saved_bpp)
 {
   gchar    **exif_tags;
-  gboolean   save_thumbnail;
 
   /* See bug 758909: clear TIFFTAG_MIN/MAXSAMPLEVALUE because
    * exiv2 saves them with wrong type and the original values
@@ -1050,21 +967,8 @@ save_metadata (GFile        *file,
 
   gimp_metadata_set_bits_per_sample (metadata, saved_bpp);
 
-  g_object_get (config,
-                "save-thumbnail", &save_thumbnail,
-                NULL);
-
-  /* never save metadata thumbnails for TIFF, see bug #729952 */
-  g_object_set (config,
-                "save-thumbnail", FALSE,
-                NULL);
-
   gimp_procedure_config_save_metadata (GIMP_PROCEDURE_CONFIG (config),
                                        image, file);
-
-  g_object_set (config,
-                "save-thumbnail", save_thumbnail,
-                NULL);
 }
 
 gboolean
@@ -1080,8 +984,6 @@ save_image (GFile         *file,
   const Babl *space               = NULL;
   gboolean    status              = FALSE;
   gboolean    out_linear          = FALSE;
-  gint        number_of_sub_IFDs  = 1;
-  toff_t      sub_IFDs_offsets[1] = { 0UL };
   gint32      num_layers;
   gint32      current_layer       = 0;
   GList      *layers;
@@ -1144,10 +1046,6 @@ save_image (GFile         *file,
       g_object_unref (profile);
     }
 
-  /* we put the whole file's thumbnail into the first IFD (i.e., page) */
-  if (config_save_thumbnail)
-    TIFFSetField (tif, TIFFTAG_SUBIFD, number_of_sub_IFDs, sub_IFDs_offsets);
-
   /* calculate the top-left coordinates */
   for (iter = layers; iter; iter = g_list_next (iter))
     {
@@ -1172,10 +1070,6 @@ save_image (GFile         *file,
     }
   current_layer++;
 
-  /* write thumbnail */
-  if (config_save_thumbnail)
-    save_thumbnail (image, tif);
-
   /* close file so we can safely let exiv2 work on it to write metadata.
    * this can be simplified once multi page TIFF is supported by exiv2
    */