ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

screenshot plugin: fix to paint client ui from EDT

Browse Source 
Fix deadlock between the game thread and the EDT
This commit is contained in:
Adam
2019-01-02 10:52:51 -05:00
parent 2a77d7db39
commit 487ec5fad3
2 changed files with 84 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

154
runelite-client/src/main/java/net/runelite/client/plugins/screenshot/ScreenshotPlugin.java
View File

@@ -40,6 +40,7 @@ import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.io.InputStreamReader; import java.io.InputStreamReader;
import java.lang.reflect.InvocationTargetException;
import java.text.DateFormat; import java.text.DateFormat;
import java.text.SimpleDateFormat; import java.text.SimpleDateFormat;
import java.time.LocalDate; import java.time.LocalDate;
@@ -51,6 +52,7 @@ import java.util.regex.Matcher;
import java.util.regex.Pattern; import java.util.regex.Pattern;
import javax.imageio.ImageIO; import javax.imageio.ImageIO;
import javax.inject.Inject; import javax.inject.Inject;
import javax.swing.SwingUtilities;
import lombok.AccessLevel; import lombok.AccessLevel;
import lombok.Getter; import lombok.Getter;
import lombok.extern.slf4j.Slf4j; import lombok.extern.slf4j.Slf4j;
@@ -524,85 +526,95 @@ public class ScreenshotPlugin extends Plugin
return; return;
} }
Consumer<Image> screenshotConsumer = image -> Consumer<Image> imageCallback = (img) ->
{ {
BufferedImage screenshot = config.includeFrame() // This callback is on the game thread, move to executor thread
? new BufferedImage(clientUi.getWidth(), clientUi.getHeight(), BufferedImage.TYPE_INT_ARGB) executor.submit(() -> takeScreenshot(fileName, img));
: new BufferedImage(image.getWidth(null), image.getHeight(null), BufferedImage.TYPE_INT_ARGB);
Graphics graphics = screenshot.getGraphics();
int gameOffsetX = 0;
int gameOffsetY = 0;
if (config.includeFrame())
{
// Draw the client frame onto the screenshot
clientUi.paint(graphics);
// Evaluate the position of the game inside the frame
final Point canvasOffset = clientUi.getCanvasOffset();
gameOffsetX = canvasOffset.getX();
gameOffsetY = canvasOffset.getY();
}
// Draw the game onto the screenshot
graphics.drawImage(image, gameOffsetX, gameOffsetY, null);
File playerFolder;
if (client.getLocalPlayer() != null && client.getLocalPlayer().getName() != null)
{
final EnumSet<WorldType> worldTypes = client.getWorldType();
final boolean dmm = worldTypes.contains(WorldType.DEADMAN);
final boolean sdmm = worldTypes.contains(WorldType.SEASONAL_DEADMAN);
final boolean dmmt = worldTypes.contains(WorldType.DEADMAN_TOURNAMENT);
final boolean isDmmWorld = dmm || sdmm || dmmt;
String playerDir = client.getLocalPlayer().getName();
if (isDmmWorld)
{
playerDir += "-Deadman";
}
playerFolder = new File(SCREENSHOT_DIR, playerDir);
}
else
{
playerFolder = SCREENSHOT_DIR;
}
playerFolder.mkdirs();
executor.execute(() ->
{
try
{
File screenshotFile = new File(playerFolder, fileName + ".png");
ImageIO.write(screenshot, "PNG", screenshotFile);
if (config.uploadScreenshot())
{
uploadScreenshot(screenshotFile);
}
else if (config.notifyWhenTaken())
{
notifier.notify("A screenshot was saved to " + screenshotFile, TrayIcon.MessageType.INFO);
}
}
catch (IOException ex)
{
log.warn("error writing screenshot", ex);
}
});
}; };
if (config.displayDate()) if (config.displayDate())
{ {
screenshotOverlay.queueForTimestamp(screenshotConsumer); screenshotOverlay.queueForTimestamp(imageCallback);
} }
else else
{ {
drawManager.requestNextFrameListener(screenshotConsumer); drawManager.requestNextFrameListener(imageCallback);
}
}
private void takeScreenshot(String fileName, Image image)
{
BufferedImage screenshot = config.includeFrame()
? new BufferedImage(clientUi.getWidth(), clientUi.getHeight(), BufferedImage.TYPE_INT_ARGB)
: new BufferedImage(image.getWidth(null), image.getHeight(null), BufferedImage.TYPE_INT_ARGB);
Graphics graphics = screenshot.getGraphics();
int gameOffsetX = 0;
int gameOffsetY = 0;
if (config.includeFrame())
{
// Draw the client frame onto the screenshot
try
{
SwingUtilities.invokeAndWait(() -> clientUi.paint(graphics));
}
catch (InterruptedException | InvocationTargetException e)
{
log.warn("unable to paint client UI on screenshot", e);
}
// Evaluate the position of the game inside the frame
final Point canvasOffset = clientUi.getCanvasOffset();
gameOffsetX = canvasOffset.getX();
gameOffsetY = canvasOffset.getY();
}
// Draw the game onto the screenshot
graphics.drawImage(image, gameOffsetX, gameOffsetY, null);
File playerFolder;
if (client.getLocalPlayer() != null && client.getLocalPlayer().getName() != null)
{
final EnumSet<WorldType> worldTypes = client.getWorldType();
final boolean dmm = worldTypes.contains(WorldType.DEADMAN);
final boolean sdmm = worldTypes.contains(WorldType.SEASONAL_DEADMAN);
final boolean dmmt = worldTypes.contains(WorldType.DEADMAN_TOURNAMENT);
final boolean isDmmWorld = dmm || sdmm || dmmt;
String playerDir = client.getLocalPlayer().getName();
if (isDmmWorld)
{
playerDir += "-Deadman";
}
playerFolder = new File(SCREENSHOT_DIR, playerDir);
}
else
{
playerFolder = SCREENSHOT_DIR;
}
playerFolder.mkdirs();
try
{
File screenshotFile = new File(playerFolder, fileName + ".png");
ImageIO.write(screenshot, "PNG", screenshotFile);
if (config.uploadScreenshot())
{
uploadScreenshot(screenshotFile);
}
else if (config.notifyWhenTaken())
{
notifier.notify("A screenshot was saved to " + screenshotFile, TrayIcon.MessageType.INFO);
}
}
catch (IOException ex)
{
log.warn("error writing screenshot", ex);
} }
} }

1
runelite-client/src/main/java/net/runelite/client/ui/ClientUI.java
View File

@@ -543,6 +543,7 @@ public class ClientUI
*/ */
public void paint(final Graphics graphics) public void paint(final Graphics graphics)
{ {
assert SwingUtilities.isEventDispatchThread() : "paint must be called on EDT";
frame.paint(graphics); frame.paint(graphics);
} }