JSidPlay2Main.java

package ui;

import com.beust.jcommander.JCommander;
import com.beust.jcommander.Parameter;
import com.beust.jcommander.ParameterException;
import javafx.application.Application;
import javafx.scene.Scene;
import javafx.stage.Stage;
import javafx.stage.Window;
import libsidplay.sidtune.SidTune;
import libsidplay.sidtune.SidTuneError;
import libsidplay.sidtune.SidTuneInfo;
import libsidutils.IOUtils;
import sidplay.Player;
import sidplay.fingerprinting.FingerprintJsonClient;
import sidplay.ini.converter.FileToStringConverter;
import sidplay.player.DebugUtil;
import ui.common.Convenience;
import ui.entities.config.Configuration;
import ui.entities.config.SidPlay2Section;
import ui.entities.config.WhatsSidSection;
import ui.entities.config.service.ConfigService;
import ui.entities.config.service.ConfigService.ConfigurationType;

import java.io.File;
import java.io.IOException;
import java.util.Iterator;
import java.util.function.Consumer;
import java.util.function.Function;

import static libsidutils.IOUtils.ioWrap;
import static ui.common.Convenience.LEXICALLY_FIRST_MEDIA;

/**
 *
 * Main class of the UI version of JSIDPlay2.
 *
 * @author Ken Händel
 * @author Joakim Eriksson
 * <p>
 * SID Player main class
 */
public class JSidPlay2Main extends Application implements Function<SidTune, String> {

    static {
        DebugUtil.init();
    }

    @com.beust.jcommander.Parameters(resourceBundle = "ui.JSidPlay2MainParameters")
    public static class JSIDPlay2MainParameters {

        @Parameter(names = {"--help", "-h"}, descriptionKey = "USAGE", help = true, order = 0)
        private Boolean help = Boolean.FALSE;

        @Parameter(names = {"--configurationType", "-c"}, descriptionKey = "CONFIGURATION_TYPE", order = 1)
        private ConfigurationType configurationType = ConfigurationType.XML;

        @Parameter(descriptionKey = "FILE", converter = FileToStringConverter.class)
        private File file;

    }

    /**
     * Command line arguments
     */
    private final JSIDPlay2MainParameters parameters = new JSIDPlay2MainParameters();

    /**
     * Main Window
     */
    protected JSidPlay2 jSidplay2;

    /**
     * Config service class.
     */
    private ConfigService configService;

    /**
     * Player
     */
    private Player player;

    private final Consumer<Player> menuHook = player -> {
        if (player.getTune() != SidTune.RESET) {
            SidTuneInfo info = player.getTune().getInfo();
            Iterator<String> detail = info.getInfoString().iterator();
            System.out.print("Playing: ");
            while (detail.hasNext()) {
                System.out.print(detail.next());
                if (detail.hasNext()) {
                    System.out.print(", ");
                }
            }
            if (info.getSongs() > 1) {
                System.out.print(", sub-song: ");
                System.out.print(info.getCurrentSong());
            }
            String path = player.getSidDatabaseInfo(db -> db.getPath(player.getTune()), "");
            if (!path.isEmpty()) {
                System.out.print(", ");
                System.out.print(path);
            }
            System.out.println();
        }
    };

    @Override
    public void start(Stage primaryStage) {
        try {
            final Configuration configuration = getConfigurationFromCommandLineArgs();
            final SidPlay2Section sidplay2Section = configuration.getSidplay2Section();
            final WhatsSidSection whatsSidSection = configuration.getWhatsSidSection();

            String url = whatsSidSection.getUrl();
            String username = whatsSidSection.getUsername();
            String password = whatsSidSection.getPassword();
            int connectionTimeout = whatsSidSection.getConnectionTimeout();

            player = new Player(configuration);
            player.setFirstPlayListEntryIsOne(sidplay2Section.isPlayListStartsWithOne());
            player.setMenuHook(menuHook);
            player.setRecordingFilenameProvider(this);
            player.setFingerPrintMatcher(new FingerprintJsonClient(url, username, password, connectionTimeout));

            autostartFilenames();

            jSidplay2 = new JSidPlay2(primaryStage, player);

            Scene scene = primaryStage.getScene();
            if (scene != null) {
                Window window = scene.getWindow();

                window.setX(sidplay2Section.getFrameX());
                sidplay2Section.frameXProperty().bind(window.xProperty());

                window.setY(sidplay2Section.getFrameY());
                sidplay2Section.frameYProperty().bind(window.yProperty());

                window.setWidth(sidplay2Section.getFrameWidth());
                sidplay2Section.frameWidthProperty().bind(window.widthProperty());

                window.setHeight(sidplay2Section.getFrameHeight());
                sidplay2Section.frameHeightProperty().bind(window.heightProperty());

                jSidplay2.open();
            }
        } catch (Throwable t) {
            // Uncover unparsable view or other development errors
            t.printStackTrace();
        }
    }

    @Override
    public void stop() {
        player.stopC64();
        // Eject media: Make it possible to auto-delete temporary files
        try {
            player.ejectDisk();
        } catch (IOException e) {
            System.err.println(e.getMessage());
        }
        try {
            player.getDatasette().ejectTape();
        } catch (IOException e) {
            System.err.println(e.getMessage());
        }
        configService.save((Configuration) player.getConfig());
        configService.close();
        System.exit(0);
    }

    /**
     * Provide a filename for the tune containing some tune infos.
     *
     * @see java.util.function.Function#apply(java.lang.Object)
     */
    @Override
    public String apply(SidTune tune) {
        String defaultName = "jsidplay2";
        if (tune == SidTune.RESET) {
            return new File(player.getConfig().getSidplay2Section().getTmpDir(), defaultName).getAbsolutePath();
        }
        SidTuneInfo info = tune.getInfo();
        Iterator<String> infos = info.getInfoString().iterator();
        String name = infos.hasNext() ? infos.next().replaceAll("[:\\\\/*?|<>]", "_") : defaultName;
        String filename = new File(player.getConfig().getSidplay2Section().getTmpDir(),
                IOUtils.getFilenameWithoutSuffix(name)).getAbsolutePath();
        if (info.getSongs() > 1) {
            filename += String.format("-%02d", info.getCurrentSong());
        }
        return filename;
    }

    //
    // Helper methods
    //

    /**
     * Parse optional command line arguments.
     *
     * @return configuration database chosen by command line arguments
     */
    private Configuration getConfigurationFromCommandLineArgs() {
        try {
            Parameters javafxParameters = getParameters();
            if (javafxParameters != null) {
                String[] args = javafxParameters.getRaw().toArray(new String[0]);
                JCommander commander = JCommander.newBuilder().addObject(parameters).programName(getClass().getName())
                        .build();
                commander.parse(args);
                if (parameters.help) {
                    commander.usage();
                    System.out.println("Press <enter> to exit!");
                    ioWrap(() -> System.in.read());
                    System.exit(0);
                }
            }
        } catch (ParameterException | IOException e) {
            System.err.println(e.getMessage());
        }
        return getConfiguration();
    }

    /**
     * Get the players configuration, create a new one, if absent.
     *
     * @return the players configuration to be used
     */
    private Configuration getConfiguration() {
        configService = new ConfigService(parameters.configurationType);
        return configService.load();
    }

    private void autostartFilenames() {
        if (parameters.file != null) {
            try {
                new Convenience(player).autostart(parameters.file, LEXICALLY_FIRST_MEDIA, null);
            } catch (IOException | SidTuneError e) {
                System.err.println(e.getMessage());
            }
        }
    }

    /**
     * Main method. Create an application frame and start emulation.
     *
     * @param args command line arguments
     */
    public static void main(final String[] args) {
        launch(args);
    }

}