Fix #1499: Add support of FITS file format

caclark · caclark · commit 96b7e41a14ee · 2024-11-11T16:27:07.000Z
#1499 Supports 2D images only. Disable via: meson -Dfits=disabled
diff --git a/.github/workflows/check-build-actions.yml b/.github/workflows/check-build-actions.yml
@@ -49,6 +49,7 @@ jobs:
           -Dexiv2=disabled
           -Dexr=disabled
           -Dextended_stacktrace=disabled
+          -Dfits=disabled
           -Dgit=disabled
           -Dgps-map=disabled
           -Dgtk4=disabled
diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ Geeqie is a graphics file viewer. Basic features:
     * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
 
 * Viewing raster and vector images, in the following formats:
-    * 3FR ANI ARW AVIF BMP CR2 CR3 CRW CUR DDS DJVU DNG ERF EXR GIF GQV HEIC HEIF ICO JP2 JPE JPEG JPG JPS JXL KDC MEF MOS MPO MRW NEF ORF PBM PDF PEF PGM PNG PNM PPM PSD QIF QTIF RAF RAW RW2 SCR SR2 SRF SVG SVGZ TGA TIF TIFF WEBP XBM XPM.
+    * 3FR ANI ARW AVIF BMP CR2 CR3 CRW CUR DDS DJVU DNG ERF EXR FIT FITS FTS GIF GQV HEIC HEIF ICO JP2 JPE JPEG JPG JPS JXL KDC MEF MOS MPO MRW NEF NPY ORF PBM PDF PEF PGM PNG PNM PPM PSD QIF QTIF RAF RAW RW2 SCR SR2 SRF SVG SVGZ TGA TIF TIFF WEBP XBM XPM.
     * Display images in archive files (.ZIP, .RAR etc.).
     * Animated GIF and WEBP files are supported.
 
diff --git a/auto-complete/geeqie b/auto-complete/geeqie
@@ -1,6 +1,6 @@
 # bash completion for geeqie                              -*- shell-script -*-
 
-file_types='@(3fr|ani|arw|avif|bmp|cr2|cr3|crw|cur|dds|djvu|dng|erf|exr|gif|gqv|heic|heif|ico|jp2|jpe|jpeg|jpg|jps|jxl|kdc|mef|mos|mpo|mrw|nef|orf|pbm|pdf|pef|pgm|png|pnm|ppm|psd|qif|qtif|raf|raw|rw2|scr|sr2|srf|svg|svgz|tga|tif|tiff|webp|xbm|xpm)'
+file_types='@(3fr|ani|arw|avif|bmp|cr2|cr3|crw|cur|dds|djvu|dng|erf|exr|.fits|fit|fts|gif|gqv|heic|heif|ico|jp2|jpe|jpeg|jpg|jps|jxl|kdc|mef|mos|mpo|mrw|nef|orf|pbm|pdf|pef|pgm|png|pnm|ppm|psd|qif|qtif|raf|raw|rw2|scr|sr2|srf|svg|svgz|tga|tif|tiff|webp|xbm|xpm)'
 
 actions='About AddMark0 AddMark1 AddMark2 AddMark3 AddMark4 AddMark5 AddMark6 AddMark7 AddMark8 AddMark9 AlterNone Animate Back ClearMarks CloseWindow ColorProfile0 ColorProfile1 ColorProfile2 ColorProfile3 ColorProfile4 ColorProfile5 ConnectZoom100 ConnectZoom200 ConnectZoom25 ConnectZoom300 ConnectZoom33 ConnectZoom400 ConnectZoom50 ConnectZoomFillHor ConnectZoomFillVert ConnectZoomFit ConnectZoomIn ConnectZoomOut Copy CopyImage CopyPath CopyPathUnquoted CropFourThree CropNone CropOneOne CropRectangle CropSixteenNine CropThreeTwo CutPath Delete DeleteWindow DrawRectangle Escape ExifRotate ExifWin FilterMark0 FilterMark1 FilterMark2 FilterMark3 FilterMark4 FilterMark5 FilterMark6 FilterMark7 FilterMark8 FilterMark9 FindDupes FirstImage FirstPage Flip FloatTools FolderTree Forward FullScreen Grayscale HelpChangeLog HelpContents HelpKbd HelpNotes HelpPdf HelpSearch HelpShortcuts HideBars HideSelectableToolbars HideTools HistogramChanB HistogramChanCycle HistogramChanG HistogramChanR HistogramChanRGB HistogramChanV HistogramModeCycle HistogramModeLin HistogramModeLog Home IgnoreAlpha ImageBack ImageForward ImageHistogram ImageOverlay ImageOverlayCycle IntMark0 IntMark1 IntMark2 IntMark3 IntMark4 IntMark5 IntMark6 IntMark7 IntMark8 IntMark9 KeywordAutocomplete LastImage LastPage LayoutConfig LogWindow Maintenance Mark0 Mark1 Mark2 Mark3 Mark4 Mark5 Mark6 Mark7 Mark8 Mark9 Mirror Move NewCollection NewFolder NewWindow NewWindowDefault NewWindowFromCurrent NextImage NextPage OpenArchive OpenCollection OpenRecent OpenWith OverUnderExposed PanView PermanentDelete Plugins Preferences PrevImage PrevPage Print Quit Rating0 Rating1 Rating2 Rating3 Rating4 Rating5 RatingM1 RectangularSelection Refresh Rename RenameWindow ResetMark0 ResetMark1 ResetMark2 ResetMark3 ResetMark4 ResetMark5 ResetMark6 ResetMark7 ResetMark8 ResetMark9 Rotate180 RotateCCW RotateCW SBar SBarSort SaveMetadata Search SearchAndRunCommand SelectAll SelectInvert SelectMark0 SelectMark1 SelectMark2 SelectMark3 SelectMark4 SelectMark5 SelectMark6 SelectMark7 SelectMark8 SelectMark9 SelectNone SetMark0 SetMark1 SetMark2 SetMark3 SetMark4 SetMark5 SetMark6 SetMark7 SetMark8 SetMark9 ShowFileFilter ShowInfoPixel ShowMarks SlideShow SlideShowFaster SlideShowPause SlideShowSlower SplitDownPane SplitHorizontal SplitNextPane SplitPaneSync SplitPreviousPane SplitQuad SplitSingle SplitTriple SplitUpPane SplitVertical StereoAuto StereoCross StereoCycle StereoOff StereoSBS Thumbnails ToggleMark0 ToggleMark1 ToggleMark2 ToggleMark3 ToggleMark4 ToggleMark5 ToggleMark6 ToggleMark7 ToggleMark8 ToggleMark9 UnselMark0 UnselMark1 UnselMark2 UnselMark3 UnselMark4 UnselMark5 UnselMark6 UnselMark7 UnselMark8 UnselMark9 Up UseColorProfiles UseImageProfile ViewIcons ViewInNewWindow ViewList WriteRotation WriteRotationKeepDate Zoom100 Zoom200 Zoom25 Zoom300 Zoom33 Zoom400 Zoom50 ZoomFillHor ZoomFillVert ZoomFit ZoomIn ZoomOut ZoomToRectangle'
 
diff --git a/config.h.in b/config.h.in
@@ -68,6 +68,9 @@
 /* Define if ffmpegthumbnailer supports specifying size by width/height */
 #mesondefine HAVE_FFMPEGTHUMBNAILER_WH
 
+/* Define to enable fits support */
+#mesondefine HAVE_FITS
+
 /* Define to enable heif support */
 #mesondefine HAVE_HEIF
 
diff --git a/doxygen.conf b/doxygen.conf
@@ -2427,6 +2427,7 @@ PREDEFINED             = DEBUG=1 \
                          HAVE_EXECINFO_H=1 \
                          HAVE_EXIV2=1 \
                          HAVE_FFMPEGTHUMBNAILER=1 \
+                         HAVE_FITS=1 \
                          HAVE_HEIF=1 \
                          HAVE_J2K=1 \
                          HAVE_JPEG=1 \
diff --git a/geeqie-install-debian.sh b/geeqie-install-debian.sh
@@ -8,7 +8,7 @@
 ## Dialogs allow the user to install additional features.
 ##
 
-version="2024-10-29"
+version="2024-11-11"
 description='
 Geeqie is an image viewer.
 This script will download, compile, and install Geeqie on Debian-based systems.
@@ -96,7 +96,9 @@ libchamplain-0.12-dev
 libpoppler (for pdf file preview)
 libpoppler-glib-dev
 libjxl (for viewing .jxl images)
-libjxl-dev"
+libjxl-dev
+libcfitsio (for .fits images)
+libcfitsio-dev"
 
 ####################################################################
 # Get System Info
diff --git a/meson.build b/meson.build
@@ -329,6 +329,21 @@ else
     summary({'exr' : ['disabled - exr files supported:', false]}, section : 'Configuration', bool_yn : true)
 endif
 
+conf_data.set('HAVE_FITS', 0)
+fits_dep = []
+option = get_option('fits')
+if not option.disabled()
+    fits_dep = dependency('cfitsio', required: get_option('fits'))
+    if fits_dep.found()
+		conf_data.set('HAVE_FITS', 1)
+		summary({'fits' : ['fits files supported:', true]}, section : 'Configuration', bool_yn : true)
+    else
+        summary({'fits' : ['libcfitsio not found - fits files supported:', false]}, section : 'Configuration', bool_yn : true)
+    endif
+else
+    summary({'fits' : ['disabled - fits files supported:', false]}, section : 'Configuration', bool_yn : true)
+endif
+
 conf_data.set('HAVE_CLUTTER', 0)
 conf_data.set('HAVE_LIBCHAMPLAIN', 0)
 conf_data.set('HAVE_LIBCHAMPLAIN_GTK', 0)
diff --git a/meson_options.txt b/meson_options.txt
@@ -32,6 +32,7 @@ option('execinfo', type : 'feature', value : 'auto', description : 'execinfo.h')
 option('exiv2', type : 'feature', value : 'auto', description : 'exiv2')
 option('exr', type : 'feature', value : 'auto', description : 'exr')
 option('extended_stacktrace', type : 'feature', value : 'auto', description : 'extended stacktrace')
+option('fits', type : 'feature', value : 'auto', description : 'fits')
 option('git', type : 'feature', value : 'auto', description : 'lua-api and changelog.html')
 option('gps-map', type : 'feature', value : 'auto', description : 'gps map')
 option('gtk4', type : 'feature', value : 'disabled', description : 'gtk4 - do not use')
diff --git a/scripts/test-all.sh b/scripts/test-all.sh
@@ -53,6 +53,7 @@ meson setup \
 -Dexiv2=disabled \
 -Dexr=disabled \
 -Dextended_stacktrace=disabled \
+-Dfits=disabled \
 -Dgit=disabled \
 -Dgps-map=disabled \
 -Dgtk4=disabled \
diff --git a/src/filefilter.cc b/src/filefilter.cc
@@ -171,6 +171,9 @@ void filter_add_defaults()
 #if HAVE_EXR
 	filter_add_if_missing("exr", "Exr Image", ".exr", FORMAT_CLASS_IMAGE, FALSE, TRUE, TRUE);
 #endif
+#if HAVE_FITS
+	filter_add_if_missing("fits", "Fits Image", ".fits;.fit;.fts", FORMAT_CLASS_IMAGE, FALSE, TRUE, TRUE);
+#endif
 #if HAVE_HEIF
 	filter_add_if_missing("heif/avif", "HEIF/AVIF Image", ".heif;.heic;.avif", FORMAT_CLASS_IMAGE, FALSE, TRUE, TRUE);
 #endif
diff --git a/src/image-load-fits.cc b/src/image-load-fits.cc
@@ -0,0 +1,212 @@
+/*
+ * Copyright (C) 2024 - The Geeqie Team
+ *
+ * Author: Colin Clark
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include "image-load-fits.h"
+
+#include <cmath>
+#include <fitsio.h>
+#include <limits>
+
+#include "debug.h"
+#include "image-load.h"
+
+namespace
+{
+
+struct ImageLoaderFITS : public ImageLoaderBackend
+{
+public:
+	~ImageLoaderFITS() override;
+
+	void init(AreaUpdatedCb area_updated_cb, SizePreparedCb size_prepared_cb, AreaPreparedCb area_prepared_cb, gpointer data) override;
+	gboolean write(const guchar *buf, gsize &chunk_size, gsize count, GError **error) override;
+	GdkPixbuf *get_pixbuf() override;
+	gchar *get_format_name() override;
+	gchar **get_format_mime_types() override;
+	void set_page_num(gint page_num) override;
+	gint get_page_total() override;
+
+private:
+	AreaUpdatedCb area_updated_cb;
+	gpointer data;
+
+	GdkPixbuf *pixbuf;
+	gint page_num;
+	gint page_total;
+};
+
+gboolean ImageLoaderFITS::write(const guchar *buf, gsize &chunk_size, gsize count, GError **)
+{
+	fitsfile *fptr;           // FITS file pointer
+	gint anynul;
+	gint bitpix;
+	gint naxis;
+	gint status = 0;          // cfitsio status value must be initialized to zero
+	glong fpixel = 1;
+	glong naxes[2] = {1, 1};  // Image width and height
+
+	/* Open FITS file from memory buffer */
+	if (fits_open_memfile(&fptr, "mem://", READONLY, (void **)&buf, &count, 0, nullptr, &status))
+		{
+		fits_report_error(stderr, status);
+		return FALSE;
+		}
+
+	/* Check that the file is an image and get its dimensions */
+	if (fits_get_img_param(fptr, 2, &bitpix, &naxis, naxes, &status))
+		{
+		fits_report_error(stderr, status);
+		fits_close_file(fptr, &status);
+		return FALSE;
+		}
+
+	if (naxis != 2)    // Ensure it's a 2D image
+		{
+		log_printf("Error: FITS image is not 2D");
+		fits_close_file(fptr, &status);
+		return FALSE;
+		}
+
+	glong width = naxes[0];
+	glong height = naxes[1];
+
+	/* Allocate memory for the image data */
+	auto *image_data = (gfloat *)malloc(width * height * sizeof(gfloat));
+	if (!image_data)
+		{
+		log_printf("Memory allocation error when processing .fits file");
+		fits_close_file(fptr, &status);
+		return FALSE;
+		}
+
+	/* Read the image data */
+	if (fits_read_img(fptr, TFLOAT, fpixel, width * height, nullptr, image_data, &anynul, &status))
+		{
+		fits_report_error(stderr, status);
+		free(image_data);
+		fits_close_file(fptr, &status);
+		return FALSE;
+		}
+
+	/* Close the FITS file */
+	fits_close_file(fptr, &status);
+
+	/* Create a GdkPixbuf in RGB format (24-bit depth, 8 bits per channel) */
+	GdkPixbuf *pixbuf_tmp = gdk_pixbuf_new(GDK_COLORSPACE_RGB, FALSE, 8, width, height);
+	if (!pixbuf_tmp)
+		{
+		log_printf("Failed to create GdkPixbuf for .fits file");
+		free(image_data);
+
+		return FALSE;
+		}
+
+	guchar *pixels = gdk_pixbuf_get_pixels(pixbuf_tmp);
+	gint rowstride = gdk_pixbuf_get_rowstride(pixbuf_tmp);
+
+	gfloat max_value = 0;
+	gfloat min_value = std::numeric_limits<float>::max();
+
+	/* Get the max and min intensity values in the image */
+	for (glong y = 0; y < height; y++)
+		{
+		for (glong x = 0; x < width; x++)
+			{
+			gfloat value =  (image_data[y * width + x]);
+
+			max_value = std::max(max_value, value);
+			min_value = std::min(min_value, value);
+			}
+		}
+
+	/* Map the float data to RGB and load it into the GdkPixbuf */
+	for (glong y = 0; y < height; y++)
+		{
+		for (glong x = 0; x < width; x++)
+			{
+			gint pixel_index = y * rowstride + x * 3;
+			gfloat value = (image_data[y * width + x]);
+			/* fits images seem to have a large intensity range, but the useful data is mostly at the lower end.
+			 * Using linear scaling results in a black image. */
+			auto intensity = (guchar)(255.0 * (log(value - min_value) / log((max_value - min_value))));
+
+			/* Set the RGB channels to the intensity value for grayscale */
+			pixels[pixel_index] = intensity;     // Red
+			pixels[pixel_index + 1] = intensity; // Green
+			pixels[pixel_index + 2] = intensity; // Blue
+			}
+		}
+
+	pixbuf = gdk_pixbuf_copy(pixbuf_tmp);
+	g_object_unref(pixbuf_tmp);
+
+	area_updated_cb(nullptr, 0, 0, width, height, data);
+
+	chunk_size = count;
+
+	return TRUE;
+}
+
+void ImageLoaderFITS::init(AreaUpdatedCb area_updated_cb, SizePreparedCb, AreaPreparedCb, gpointer data)
+{
+	this->area_updated_cb = area_updated_cb;
+	this->data = data;
+	page_num = 0;
+}
+
+GdkPixbuf *ImageLoaderFITS::get_pixbuf()
+{
+	return pixbuf;
+}
+
+gchar *ImageLoaderFITS::get_format_name()
+{
+	return g_strdup("fits");
+}
+
+gchar **ImageLoaderFITS::get_format_mime_types()
+{
+	static const gchar *mime[] = {"image/fits", nullptr};
+	return g_strdupv(const_cast<gchar **>(mime));
+}
+
+void ImageLoaderFITS::set_page_num(gint page_num)
+{
+	this->page_num = page_num;
+}
+
+gint ImageLoaderFITS::get_page_total()
+{
+	return page_total;
+}
+
+ImageLoaderFITS::~ImageLoaderFITS()
+{
+	if (pixbuf) g_object_unref(pixbuf);
+}
+
+} // namespace
+
+std::unique_ptr<ImageLoaderBackend> get_image_loader_backend_fits()
+{
+	return std::make_unique<ImageLoaderFITS>();
+}
+
+/* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */
diff --git a/src/image-load-fits.h b/src/image-load-fits.h
@@ -0,0 +1,31 @@
+/*
+ * Copyright (C) 2024 - The Geeqie Team
+ *
+ * Author: Colin Clark
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef IMAGE_LOAD_FITS_H
+#define IMAGE_LOAD_FITS_H
+
+#include <memory>
+
+struct ImageLoaderBackend;
+
+std::unique_ptr<ImageLoaderBackend> get_image_loader_backend_fits();
+
+#endif /* IMAGE_LOAD_FITS_H */
+/* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */
diff --git a/src/image-load.cc b/src/image-load.cc
@@ -43,6 +43,9 @@
 #if HAVE_FFMPEGTHUMBNAILER
 #  include "image-load-ffmpegthumbnailer.h"
 #endif
+#if HAVE_FITS
+#  include "image-load-fits.h"
+#endif
 #include "image-load-gdk.h"
 #if HAVE_HEIF
 #  include "image-load-heif.h"
@@ -680,6 +683,15 @@ static void image_loader_setup_loader(ImageLoader *il)
 			}
 		else
 #endif
+#if HAVE_FITS
+		if (il->bytes_total >= 6 &&
+			(memcmp(il->mapped_file, "SIMPLE", 6) == 0))
+			{
+			DEBUG_1("Using custom fits loader");
+			il->backend = get_image_loader_backend_fits();
+			}
+		else
+#endif
 #if HAVE_PDF
 		if (il->bytes_total >= 4 &&
 		    (memcmp(il->mapped_file + 0, "%PDF", 4) == 0))
diff --git a/src/meson.build b/src/meson.build
