Add a button to copy the current frame to the clipboard. (#583)

* Add a button to copy the current frame to the clipboard.

* Always use png for the clipboard.

Author: leMaik

chunky/src/java/se/llbit/chunky/map/MapBuffer.java

@@ -16,6 +16,7 @@
  */
 package se.llbit.chunky.map;
 
+import java.io.FileOutputStream;
 import javafx.scene.canvas.GraphicsContext;
 import javafx.scene.image.PixelFormat;
 import javafx.scene.image.WritableImage;
@@ -266,7 +267,7 @@ public synchronized void renderPng(File targetFile) throws IOException {
     int height = view.height;
     int[] pixels = new int[width * height];
     image.getPixelReader().getPixels(0, 0, width, height, PIXEL_FORMAT, pixels, 0, width);
-    try (PngFileWriter pngWriter = new PngFileWriter(targetFile)) {
+    try (PngFileWriter pngWriter = new PngFileWriter(new FileOutputStream(targetFile))) {
       pngWriter.write(pixels, width, height, TaskTracker.Task.NONE);
     }
   }

chunky/src/java/se/llbit/chunky/renderer/scene/Scene.java

@@ -16,6 +16,7 @@
  */
 package se.llbit.chunky.renderer.scene;
 
+import java.io.FileOutputStream;
 import org.apache.commons.math3.util.FastMath;
 import se.llbit.chunky.PersistentSettings;
 import se.llbit.chunky.block.Air;
@@ -1465,18 +1466,30 @@ public void saveSnapshot(File directory, TaskTracker progress, int threadCount)
     if (!finalized) {
       postProcessFrame(progress);
     }
-    writeImage(targetFile, progress);
+    writeImage(targetFile, outputMode, progress);
   }
 
   /**
-   * Save the current frame as a PNG image.
+   * Save the current frame as a PNG or TIFF image.
    */
   public synchronized void saveFrame(File targetFile, TaskTracker progress, int threadCount) {
     computeAlpha(progress, threadCount);
     if (!finalized) {
       postProcessFrame(progress);
     }
-    writeImage(targetFile, progress);
+    writeImage(targetFile, outputMode, progress);
+  }
+
+  /**
+   * Save the current frame as a PNG or TIFF image into the given output stream.
+   */
+  public synchronized void writeFrame(OutputStream out, OutputMode mode, TaskTracker progress, int threadCount)
+      throws IOException {
+    computeAlpha(progress, threadCount);
+    if (!finalized) {
+      postProcessFrame(progress);
+    }
+    writeImage(out, mode, progress);
   }
 
   /**
@@ -1546,30 +1559,39 @@ public void postProcessFrame(TaskTracker progress) {
   /**
    * Write buffer data to image.
    *
-   * @param targetFile file to write to.
+   * @param out output stream to write to.
    */
-  private void writeImage(File targetFile, TaskTracker progress) {
-    if (outputMode == OutputMode.PNG) {
-      writePng(targetFile, progress);
-    } else if (outputMode == OutputMode.TIFF_32) {
-      writeTiff(targetFile, progress);
+  private void writeImage(OutputStream out, OutputMode mode, TaskTracker progress) throws IOException {
+    if (mode == OutputMode.PNG) {
+      writePng(out, progress);
+    } else if (mode == OutputMode.TIFF_32) {
+      writeTiff(out, progress);
+    }
+  }
+
+  private void writeImage(File targetFile, OutputMode mode, TaskTracker progress) {
+    try (FileOutputStream out = new FileOutputStream(targetFile)) {
+      writeImage(out, mode, progress);
+    } catch (IOException e) {
+      Log.warn("Failed to write file: " + targetFile.getAbsolutePath(), e);
     }
   }
 
   /**
    * Write PNG image.
    *
-   * @param targetFile file to write to.
+   * @param out output stream to write to.
    */
-  private void writePng(File targetFile, TaskTracker progress) {
+  private void writePng(OutputStream out, TaskTracker progress) throws IOException {
     try (TaskTracker.Task task = progress.task("Writing PNG");
-        PngFileWriter writer = new PngFileWriter(targetFile)) {
+        PngFileWriter writer = new PngFileWriter(out)) {
       if (transparentSky) {
         writer.write(backBuffer.data, alphaChannel, width, height, task);
       } else {
         writer.write(backBuffer.data, width, height, task);
       }
-      if (camera.getProjectionMode() == ProjectionMode.PANORAMIC && camera.getFov() >= 179
+      if (camera.getProjectionMode() == ProjectionMode.PANORAMIC
+          && camera.getFov() >= 179
           && camera.getFov() <= 181) {
         String xmp = "";
         xmp += "<rdf:RDF xmlns:rdf='http://www.w3.org/1999/02/22-rdf-syntax-ns#'>\n";
@@ -1596,22 +1618,18 @@ private void writePng(File targetFile, TaskTracker progress) {
         ITXT iTXt = new ITXT("XML:com.adobe.xmp", xmp);
         writer.writeChunk(iTXt);
       }
-    } catch (IOException e) {
-      Log.warn("Failed to write PNG file: " + targetFile.getAbsolutePath(), e);
     }
   }
 
   /**
    * Write TIFF image.
    *
-   * @param targetFile file to write to.
+   * @param out output stream to write to.
    */
-  private void writeTiff(File targetFile, TaskTracker progress) {
+  private void writeTiff(OutputStream out, TaskTracker progress) throws IOException {
     try (TaskTracker.Task task = progress.task("Writing TIFF");
-        TiffFileWriter writer = new TiffFileWriter(targetFile)) {
+        TiffFileWriter writer = new TiffFileWriter(out)) {
       writer.write32(this, task);
-    } catch (IOException e) {
-      Log.warn("Failed to write TIFF file: " + targetFile.getAbsolutePath(), e);
     }
   }
 

chunky/src/java/se/llbit/chunky/ui/ChunkyFxController.java

@@ -16,6 +16,8 @@
  */
 package se.llbit.chunky.ui;
 
+import java.io.PipedInputStream;
+import java.io.PipedOutputStream;
 import javafx.application.Application;
 import javafx.application.Platform;
 import javafx.beans.property.BooleanProperty;
@@ -41,7 +43,10 @@
 import javafx.scene.control.TextFormatter;
 import javafx.scene.control.ToggleButton;
 import javafx.scene.control.Tooltip;
+import javafx.scene.image.Image;
 import javafx.scene.image.ImageView;
+import javafx.scene.input.Clipboard;
+import javafx.scene.input.ClipboardContent;
 import javafx.scene.input.KeyCode;
 import javafx.scene.input.KeyCodeCombination;
 import javafx.scene.input.KeyCombination;
@@ -150,6 +155,7 @@ public class ChunkyFxController
   @FXML private Button loadScene;
 
   @FXML private Button saveFrameBtn;
+  @FXML private Button copyFrameBtn;
   @FXML private ProgressBar progressBar;
   @FXML private Label progressLbl;
   @FXML private Label etaLbl;
@@ -640,6 +646,7 @@ public synchronized void exportZip(File targetFile, ProgressTracker progress) {
     previewTab.setGraphic(new ImageView(Icon.sky.fxImage()));
 
     saveFrameBtn.setOnAction(this::saveCurrentFrame);
+    copyFrameBtn.setOnAction(this::copyCurrentFrame);
     start.setGraphic(new ImageView(Icon.play.fxImage()));
     start.setTooltip(new Tooltip("Start rendering."));
     start.setOnAction(e -> scene.startRender());
@@ -717,6 +724,25 @@ private void saveCurrentFrame(Event event) {
     }
   }
 
+  private void copyCurrentFrame(Event event) {
+    try {
+      PipedInputStream in = new PipedInputStream();
+      PipedOutputStream out = new PipedOutputStream(in);
+      new Thread(() -> {
+        try {
+          scene.writeFrame(out, OutputMode.PNG, new TaskTracker(ProgressListener.NONE), renderController.getContext().numRenderThreads());
+        } catch (IOException e) {
+          Log.warn("Failed to copy image to clipboard", e);
+        }
+      }).start();
+      ClipboardContent content = new ClipboardContent();
+      content.putImage(new Image(in));
+      Clipboard.getSystemClipboard().setContent(content);
+    } catch(IOException e) {
+      Log.warn("Failed to copy image to clipboard", e);
+    }
+  }
+
   @Override  public boolean allowSceneRefresh() {
     if (scene.getResetReason() == ResetReason.SCENE_LOADED
         || renderer.getRenderStatus().getRenderTime() < SCENE_EDIT_GRACE_PERIOD) {

chunky/src/java/se/llbit/png/PngFileWriter.java

@@ -16,11 +16,10 @@
  */
 package se.llbit.png;
 
+import java.io.OutputStream;
 import se.llbit.util.TaskTracker;
 
 import java.io.DataOutputStream;
-import java.io.File;
-import java.io.FileOutputStream;
 import java.io.IOException;
 import java.util.zip.Deflater;
 
@@ -41,9 +40,9 @@ public class PngFileWriter implements AutoCloseable {
   /**
    * @throws IOException
    */
-  public PngFileWriter(File file) throws IOException {
-    out = new DataOutputStream(new FileOutputStream(file));
-    out.writeLong(PNG_SIGNATURE);
+  public PngFileWriter(OutputStream out) throws IOException {
+    this.out = new DataOutputStream(out);
+    this.out.writeLong(PNG_SIGNATURE);
   }
 
   /**

chunky/src/java/se/llbit/tiff/TiffFileWriter.java

@@ -20,8 +20,7 @@
 import se.llbit.util.TaskTracker;
 
 import java.io.DataOutputStream;
-import java.io.File;
-import java.io.FileOutputStream;
+import java.io.OutputStream;
 import java.io.IOException;
 
 /**
@@ -40,8 +39,8 @@ public class TiffFileWriter implements AutoCloseable {
 
   private final DataOutputStream out;
 
-  public TiffFileWriter(File file) throws IOException {
-    out = new DataOutputStream(new FileOutputStream(file));
+  public TiffFileWriter(OutputStream out) throws IOException {
+    this.out = new DataOutputStream(out);
     out.write(0x4D);
     out.write(0x4D);
     out.write(0x00);

chunky/src/res/se/llbit/chunky/ui/Chunky.fxml

@@ -49,6 +49,7 @@
       </tooltip>
     </Button>
     <Button fx:id="saveFrameBtn" mnemonicParsing="false" text="Save current frame" />
+    <Button fx:id="copyFrameBtn" mnemonicParsing="false" text="Copy current frame" />
   </HBox>
   <SplitPane fx:id="splitPane"
              VBox.vgrow="ALWAYS"