Changeset 17364 in josm for trunk/src/org/openstreetmap/josm/tools/ImageResource.java

Timestamp:

2020-11-26T22:24:27+01:00 (3 years ago)

Author:

simon04

Message:

see #20141 - ImageProvider: cache rendered SVG images using JCS

This experimental feature is disabled by default. Set the advanced preference jcs.cache.use_image_resource_cache=true to enable. No cache eviction for altered images is implemented at the moment.

File:

• trunk/src/org/openstreetmap/josm/tools/ImageResource.java (modified) (10 diffs)

trunk/src/org/openstreetmap/josm/tools/ImageResource.java

@@ -5 +5 @@
 import java.awt.Image;
 import java.awt.image.BufferedImage;
+import java.io.IOException;
+import java.io.UncheckedIOException;
 import java.util.List;
-import java.util.Map;
-import java.util.concurrent.ConcurrentHashMap;
+import java.util.Locale;
+import java.util.Objects;
+import java.util.function.Supplier;
 
 import javax.swing.AbstractAction;
@@ -15 +18 @@
 import javax.swing.JPanel;
 import javax.swing.UIManager;
+
+import org.apache.commons.jcs3.access.behavior.ICacheAccess;
+import org.openstreetmap.josm.data.cache.BufferedImageCacheEntry;
+import org.openstreetmap.josm.data.cache.JCSCacheManager;
 
 import com.kitfox.svg.SVGDiagram;
@@ -29 +36 @@
 
     /**
-     * Caches the image data for resized versions of the same image. The key is obtained using {@link ImageResizeMode#cacheKey(Dimension)}.
-     */
-    private final Map<Integer, BufferedImage> imgCache = new ConcurrentHashMap<>(4);
+     * Caches the image data for resized versions of the same image.
+     * Depending on {@link JCSCacheManager#USE_IMAGE_RESOURCE_CACHE}, a combined memory/disk, or an in-memory-cache is used.
+     */
+    private static final ICacheAccess<String, BufferedImageCacheEntry> imgCache = JCSCacheManager.getImageResourceCache();
+
+    private final String cacheKey;
     /**
      * SVG diagram information in case of SVG vector image.
@@ -37 +47 @@
     private SVGDiagram svg;
     /**
+     * Supplier for SVG diagram information in case of possibly cached SVG vector image.
+     */
+    private Supplier<SVGDiagram> svgSupplier;
+    /**
      * Use this dimension to request original file dimension.
      */
@@ -55 +69 @@
     /**
      * Constructs a new {@code ImageResource} from an image.
+     * @param cacheKey the caching identifier of the image
      * @param img the image
      */
-    public ImageResource(Image img) {
-        CheckParameterUtil.ensureParameterNotNull(img);
-        baseImage = img;
+    public ImageResource(String cacheKey, Image img) {
+        this.cacheKey = Objects.requireNonNull(cacheKey);
+        this.baseImage = Objects.requireNonNull(img);
     }
 
     /**
      * Constructs a new {@code ImageResource} from SVG data.
+     * @param cacheKey the caching identifier of the image
      * @param svg SVG data
      */
-    public ImageResource(SVGDiagram svg) {
-        CheckParameterUtil.ensureParameterNotNull(svg);
-        this.svg = svg;
+    public ImageResource(String cacheKey, SVGDiagram svg) {
+        this.cacheKey = Objects.requireNonNull(cacheKey);
+        this.svg = Objects.requireNonNull(svg);
+    }
+
+    public ImageResource(String cacheKey, Supplier<SVGDiagram> svgSupplier) {
+        this.cacheKey = Objects.requireNonNull(cacheKey);
+        this.svgSupplier = Objects.requireNonNull(svgSupplier);
     }
 
@@ -78 +99 @@
      */
     public ImageResource(ImageResource res, List<ImageOverlay> overlayInfo) {
+        this.cacheKey = res.cacheKey;
         this.svg = res.svg;
+        this.svgSupplier = res.svgSupplier;
         this.baseImage = res.baseImage;
         this.overlayInfo = overlayInfo;
@@ -157 +180 @@
     ImageIcon getImageIcon(Dimension dim, boolean multiResolution, ImageResizeMode resizeMode) {
         return getImageIconAlreadyScaled(GuiSizesHelper.getDimensionDpiAdjusted(dim), multiResolution, false, resizeMode);
+    }
+
+    private BufferedImage getImageFromCache(String cacheKey) {
+        try {
+            BufferedImageCacheEntry image = imgCache.get(cacheKey);
+            if (image == null || image.getImage() == null) {
+                return null;
+            }
+            Logging.trace("{0} is in cache :-)", cacheKey);
+            return image.getImage();
+        } catch (IOException e) {
+            throw new UncheckedIOException(e);
+        }
     }
 
@@ -181 +217 @@
             resizeMode = ImageResizeMode.BOUNDED;
         }
-        final int cacheKey = resizeMode.cacheKey(dim);
-        BufferedImage img = imgCache.get(cacheKey);
+        final String cacheKey = String.format(Locale.ROOT, "%s--%s--%d--%d",
+                this.cacheKey, resizeMode.name(), dim.width, dim.height);
+        BufferedImage img = getImageFromCache(cacheKey);
         if (img == null) {
+            if (svgSupplier != null) {
+                svg = svgSupplier.get();
+                Logging.trace("{0} is not in cache :-(", cacheKey);
+                svgSupplier = null;
+            }
             if (svg != null) {
                 img = ImageProvider.createImageFromSvg(svg, dim, resizeMode);
@@ -211 +253 @@
                 disabledIcon.paintIcon(new JPanel(), img.getGraphics(), 0, 0);
             }
-            imgCache.put(cacheKey, img);
+            if (img == null) {
+                return null;
+            }
+            BufferedImageCacheEntry cacheEntry = BufferedImageCacheEntry.pngEncoded(img);
+            Logging.trace("Storing {0} ({1} bytes) in cache...", cacheKey, cacheEntry.getContent().length);
+            imgCache.put(cacheKey, cacheEntry);
         }
 
@@ -251 +298 @@
     }
 
+    static String statistics() {
+        return String.format("ImageResource cache: [%s]", imgCache.getStatistics());
+    }
+
     @Override
     public String toString() {