VM Support

Author: PulseBeat02

TODO

@@ -1,11 +1,10 @@
 Development Milestones
-  - Fix Virtual Machine Support
   - Build QEMU Statically for All Platforms
-
-  - Add Images and GIF Support into Plugin
   - Add Interaction Support for Virtual Machine
   - Add Interaction Support for Browser
 
+  - Add Images and GIF Support into Plugin
+
 Public Milestones
   - Update video showcase in the README (music discs for VM, etc)
   - Post onto Reddit (admincraft, sysadmin, etc..)

mcav-common/src/main/java/me/brandonli/mcav/media/player/vm/VMPlayerImpl.java

@@ -20,8 +20,10 @@
 import static java.util.Objects.requireNonNull;
 
 import java.io.IOException;
+import java.net.Socket;
 import java.util.ArrayList;
 import java.util.List;
+import me.brandonli.mcav.media.player.PlayerException;
 import me.brandonli.mcav.media.player.metadata.VideoMetadata;
 import me.brandonli.mcav.media.player.pipeline.step.VideoPipelineStep;
 import me.brandonli.mcav.media.player.vnc.VNCPlayer;
@@ -84,18 +86,32 @@ private void startQemuProcess() {
       final String[] arguments = command.toArray(new String[0]);
       final ProcessBuilder processBuilder = new ProcessBuilder(arguments);
       this.qemuProcess = processBuilder.start();
-      try {
-        Thread.sleep(10000);
-      } catch (final InterruptedException e) {
-        final Thread currentThread = Thread.currentThread();
-        currentThread.interrupt();
-        throw new AssertionError(e);
-      }
+      waitForConnection();
     } catch (final IOException e) {
       throw new UncheckedIOException(e.getMessage(), e);
     }
   }
 
+  private void waitForConnection() {
+    long timeout = System.currentTimeMillis() + 30000;
+    boolean connected = false;
+    while (System.currentTimeMillis() < timeout && !connected) {
+      try {
+        Socket socket = new Socket("localhost", this.vncPort);
+        socket.close();
+        connected = true;
+      } catch (final IOException e) {
+        try {
+          Thread.sleep(500);
+        } catch (final InterruptedException ex) {
+          Thread thread = Thread.currentThread();
+          thread.interrupt();
+          throw new PlayerException(ex.getMessage(), ex);
+        }
+      }
+    }
+  }
+
   private List<String> formatQemuArguments() {
     final List<String> command = new ArrayList<>();
     command.add(this.architecture.getCommand());

mcav-common/src/main/java/me/brandonli/mcav/media/player/vnc/VNCPlayerImpl.java

@@ -112,12 +112,15 @@ private VernacularConfig createConfig(final VNCSource source) {
   }
 
   private void processFrames() {
+    final int width = this.videoMetadata.getVideoWidth();
+    final int height = this.videoMetadata.getVideoHeight();
     while (this.running.get()) {
       try {
         if (this.current == null) {
           continue;
         }
         final StaticImage image = StaticImage.image(this.current);
+        image.resize(width, height);
         VideoPipelineStep current = this.videoPipeline;
         while (current != null) {
           current.process(image, this.videoMetadata);

mcav-common/src/test/java/me/brandonli/mcav/VMInputExample.java

@@ -107,7 +107,7 @@ private void startVM(final JFrame frame, final String isoPath) throws Exception
 
     final VMConfiguration config = VMConfiguration.builder().cdrom(isoPath).memory(2048);
 
-    this.vmPlayer.startAsync(pipeline, VMPlayer.Architecture.X86_64, config, VideoMetadata.of(600, 800));
+    this.vmPlayer.start(pipeline, VMPlayer.Architecture.X86_64, config, VideoMetadata.of(600, 800));
   }
 
   private void cleanup() {

sandbox/src/main/java/me/brandonli/mcav/sandbox/MCAVSandbox.java

@@ -26,13 +26,15 @@
 import me.brandonli.mcav.sandbox.command.AnnotationParserHandler;
 import me.brandonli.mcav.sandbox.command.video.VideoPlayerManager;
 import me.brandonli.mcav.sandbox.data.PluginDataConfigurationMapper;
+import me.brandonli.mcav.sandbox.listener.JukeBoxListener;
 import org.bukkit.plugin.java.JavaPlugin;
 
 public final class MCAVSandbox extends JavaPlugin {
 
   private Logger logger;
 
   private MCAVApi mcav;
+  private JukeBoxListener listener;
   private AudioProvider audioProvider;
   private VideoPlayerManager videoPlayerManager;
   private AnnotationParserHandler annotationParserHandler;
@@ -55,6 +57,7 @@ public void onEnable() {
     this.loadPluginData();
     this.loadManager();
     this.loadCommands();
+    this.loadListeners();
     this.initLookupTables();
   }
 
@@ -86,11 +89,21 @@ private void loadPluginData() {
   @Override
   public void onDisable() {
     this.shutdownLookupTables();
+    this.unloadListeners();
     this.shutdownCommands();
     this.saveData();
     this.unloadMCAV();
   }
 
+  private void unloadListeners() {
+    this.listener.shutdown();
+  }
+
+  private void loadListeners() {
+    this.listener = new JukeBoxListener(this);
+    this.listener.start();
+  }
+
   private void shutdownCommands() {
     if (this.annotationParserHandler != null) {
       this.annotationParserHandler.shutdownCommands();

sandbox/src/main/java/me/brandonli/mcav/sandbox/command/VirtualizeCommand.java

@@ -121,14 +121,15 @@ public void playVM(
     final VideoMetadata metadata = VideoMetadata.of(resolutionWidth, resolutionHeight);
     final VMConfiguration config = this.parseVMOptions(flags);
 
+    player.sendMessage(Message.VM_LOADING.build());
     try {
       this.vmPlayer = VMPlayer.vm();
-      this.vmPlayer.startAsync(pipeline, architecture, config, metadata, this.service);
+      this.vmPlayer.startAsync(pipeline, architecture, config, metadata, this.service).thenRun(() ->
+          player.sendMessage(Message.VM_CREATE.build())
+        );
     } catch (final Exception e) {
       throw new AssertionError(e);
     }
-
-    player.sendMessage(Message.VM_CREATE.build());
   }
 
   private VMConfiguration parseVMOptions(final String commandLine) {

sandbox/src/main/java/me/brandonli/mcav/sandbox/listener/JukeBoxListener.java

@@ -0,0 +1,119 @@
+/*
+ * This file is part of mcav, a media playback library for Minecraft
+ * Copyright (C) Brandon Li <https://brandonli.me/>
+ *
+ * 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 3 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, see <https://www.gnu.org/licenses/>.
+ */
+package me.brandonli.mcav.sandbox.listener;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Set;
+import java.util.stream.Collectors;
+import me.brandonli.mcav.sandbox.MCAVSandbox;
+import me.brandonli.mcav.utils.IOUtils;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.serializer.plain.PlainTextComponentSerializer;
+import org.bukkit.Bukkit;
+import org.bukkit.Material;
+import org.bukkit.Registry;
+import org.bukkit.Server;
+import org.bukkit.block.Block;
+import org.bukkit.entity.Player;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.HandlerList;
+import org.bukkit.event.Listener;
+import org.bukkit.event.block.Action;
+import org.bukkit.event.player.PlayerInteractEvent;
+import org.bukkit.inventory.ItemStack;
+import org.bukkit.plugin.PluginManager;
+import org.checkerframework.checker.initialization.qual.UnderInitialization;
+
+public final class JukeBoxListener implements Listener {
+
+  private static final PlainTextComponentSerializer PLAIN_TEXT_COMPONENT_SERIALIZER = PlainTextComponentSerializer.plainText();
+
+  private static final Set<Material> MUSIC_DISCS = Registry.MATERIAL.stream()
+    .filter(material -> material.name().startsWith("MUSIC_DISC_"))
+    .collect(Collectors.toSet());
+
+  private final MCAVSandbox sandbox;
+  private final Path isoPath;
+
+  public JukeBoxListener(final MCAVSandbox sandbox) {
+    this.isoPath = this.createFolder(sandbox);
+    this.sandbox = sandbox;
+  }
+
+  public void shutdown() {
+    HandlerList.unregisterAll(this);
+  }
+
+  public void start() {
+    final Server server = Bukkit.getServer();
+    final PluginManager pluginManager = server.getPluginManager();
+    pluginManager.registerEvents(this, this.sandbox);
+  }
+
+  private Path createFolder(@UnderInitialization JukeBoxListener this, final MCAVSandbox sandbox) {
+    final Path path = sandbox.getDataPath();
+    final Path iso = path.resolve("iso");
+    IOUtils.createDirectoryIfNotExists(iso);
+    return iso;
+  }
+
+  @EventHandler
+  public void onJukeboxInteract(final PlayerInteractEvent event) {
+    final Action action = event.getAction();
+    if (action != Action.RIGHT_CLICK_BLOCK) {
+      return;
+    }
+
+    final Block clickedBlock = event.getClickedBlock();
+    if (clickedBlock == null) {
+      return;
+    }
+
+    final Material blockType = clickedBlock.getType();
+    if (blockType != Material.JUKEBOX) {
+      return;
+    }
+
+    final ItemStack itemInHand = event.getItem();
+    if (itemInHand == null) {
+      return;
+    }
+
+    final Material itemType = itemInHand.getType();
+    if (!MUSIC_DISCS.contains(itemType)) {
+      return;
+    }
+
+    final Component name = itemInHand.displayName();
+    final String displayName = PLAIN_TEXT_COMPONENT_SERIALIZER.serialize(name);
+    final String sanitizedName = displayName.replaceAll("[\\\\/:*?\"<>|]", "_");
+    final String noBrackets = sanitizedName.replaceAll("[\\[\\]]", "");
+    final Path path = this.isoPath.resolve(noBrackets);
+    if (Files.notExists(path)) {
+      return;
+    }
+    event.setCancelled(true);
+
+    final Path absolute = path.toAbsolutePath();
+    final String raw = absolute.toString();
+    final String cmd = "mcav vm create @a 640x640 5x5 0 filter_lite x86_64 -cdrom %s -m 2048M".formatted(raw);
+    final Player player = event.getPlayer();
+    player.performCommand(cmd);
+  }
+}

sandbox/src/main/java/me/brandonli/mcav/sandbox/locale/Message.java

@@ -20,6 +20,7 @@
 import static me.brandonli.mcav.sandbox.locale.LocaleTools.direct;
 
 public interface Message extends LocaleTools {
+  NullComponent<Sender> VM_LOADING = direct("mcav.command.vm.loading");
   NullComponent<Sender> VM_CREATE = direct("mcav.command.vm.create");
   NullComponent<Sender> VM_RELEASE = direct("mcav.command.vm.release");
   UniComponent<Sender, String> AUDIO_HTTP = direct("mcav.command.audio.http", null);

sandbox/src/main/resources/locale/mcav_en_us.properties

@@ -41,4 +41,5 @@ mcav.command.audio.http=<green>Click on the URL to listen onto the website! <aqu
 mcav.command.vm.release.info=Releases the virtual machine
 mcav.command.vm.create.info=Creates a new virtual machine
 mcav.command.vm.release=<gold>Virtual machine released!</gold>
-mcav.command.vm.create=<gold>Virtual machine created!</gold>
+mcav.command.vm.loading=<gold>Loading virtual machine...</gold>
+mcav.command.vm.create=<gold>Created virtual machine!</gold>