ConsoleIO.java

package sidplay.consoleplayer;

import builder.resid.SIDMixer;
import libsidplay.common.ChipModel;
import libsidplay.common.Emulation;
import libsidplay.common.Engine;
import libsidplay.common.Mixer;
import libsidplay.config.IConfig;
import libsidplay.config.IConsoleSection;
import libsidplay.config.IEmulationSection;
import libsidplay.config.IWhatsSidSection;
import libsidplay.sidtune.SidTune;
import libsidutils.fingerprinting.rest.beans.MusicInfoWithConfidenceBean;
import sidplay.Player;
import sidplay.player.PlayList;
import sidplay.player.Timer;

import java.io.IOException;
import java.io.InputStream;
import java.io.PrintStream;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Iterator;
import java.util.function.Function;

import static libsidplay.config.ISidPlay2SystemProperties.MAX_SIDS;

public class ConsoleIO {

    private final Function<String, String> resourceBundle;

    private final IConfig config;

    private final String filename;

    public ConsoleIO(IConfig config, String filename, Function<String, String> resourceBundle) {
        this.config = config;
        this.filename = filename;
        this.resourceBundle = resourceBundle;
    }

    public void menu(SidTune tune, PlayList playList, Timer timer, int verboseLevel, boolean quiet, boolean keys,
                     PrintStream out) {
        if (quiet) {
            return;
        }
        final IConsoleSection console = config.getConsoleSection();

        printTopLine(out, console);
        printHeading(out, console);
        printSeparatorLine(out, console);
        if (tune.getInfo().getInfoString().size() == 3) {
            printTitleAutorReleased(out, console, tune);
        } else {
            printDecription(out, console, tune);
        }
        if (!tune.getInfo().getInfoString().isEmpty()) {
            printSeparatorLine(out, console);
        }
        if (verboseLevel != 0) {
            printFileDetails(out, console, tune);
        }
        printPlaylist(out, console, tune, playList);

        if (verboseLevel > 0) {
            printHorizontalBottomLine(out, console);
            printSongSpeedCIAorVBI(out, console, tune, playList);
        }
        printSongLength(out, console, timer);
        if (verboseLevel > 0) {
            printHorizontalBottomLine(out, console);
            printAddresses(out, console, tune);
            printSIDDetails(out, console, tune);
        }
        printHorizontalBottomLine(out, console);
        if (keys) {
            printKeyboardControls(out);
        }
    }

    public void decodeKeys(Player player, InputStream in) {
        try {
            if (in.available() == 0) {
                return;
            }
            final int key = in.read();
            IEmulationSection emulation = config.getEmulationSection();
            IWhatsSidSection whatsSid = config.getWhatsSidSection();
            switch (key) {
                case 'h':
                    player.firstSong();
                    break;

                case 'e':
                    player.lastSong();
                    break;

                case '>':
                    if (player.getPlayList().hasNext()) {
                        player.nextSong();
                    }
                    break;

                case '<':
                    if (player.getPlayList().hasPrevious()) {
                        player.previousSong();
                    }
                    break;

                case 'n':
                    player.getPlayList().last();
                    player.getTimer().end();
                    break;

                case 'W':
                    player.setWarp(!player.isWarp());
                    break;

                case '.':
                    player.configureMixer(Mixer::fastForward);
                    break;

                case ',':
                    player.configureMixer(Mixer::normalSpeed);
                    break;

                case 'p':
                    player.pauseContinue();
                    break;

                case '1': {
                    boolean isMuteVoice = !emulation.isMuteVoice(0, 0);
                    emulation.setMuteVoice(0, 0, isMuteVoice);
                    player.configureSID(0, sid -> sid.setVoiceMute(0, isMuteVoice));
                    break;
                }

                case '2': {
                    boolean isMuteVoice = !emulation.isMuteVoice(0, 1);
                    emulation.setMuteVoice(0, 1, isMuteVoice);
                    player.configureSID(0, sid -> sid.setVoiceMute(1, isMuteVoice));
                    break;
                }

                case '3': {
                    boolean isMuteVoice = !emulation.isMuteVoice(0, 2);
                    emulation.setMuteVoice(0, 2, isMuteVoice);
                    player.configureSID(0, sid -> sid.setVoiceMute(2, isMuteVoice));
                    break;
                }

                case '4': {
                    boolean isMuteVoice = !emulation.isMuteVoice(0, 3);
                    emulation.setMuteVoice(0, 3, isMuteVoice);
                    player.configureSID(0, sid -> sid.setVoiceMute(3, isMuteVoice));
                    break;
                }

                case '5': {
                    boolean isMuteVoice = !emulation.isMuteVoice(1, 0);
                    emulation.setMuteVoice(1, 0, isMuteVoice);
                    player.configureSID(1, sid -> sid.setVoiceMute(0, isMuteVoice));
                    break;
                }

                case '6': {
                    boolean isMuteVoice = !emulation.isMuteVoice(1, 1);
                    emulation.setMuteVoice(1, 1, isMuteVoice);
                    player.configureSID(1, sid -> sid.setVoiceMute(1, isMuteVoice));
                    break;
                }

                case '7': {
                    boolean isMuteVoice = !emulation.isMuteVoice(1, 2);
                    emulation.setMuteVoice(1, 2, isMuteVoice);
                    player.configureSID(1, sid -> sid.setVoiceMute(2, isMuteVoice));
                    break;
                }

                case '8': {
                    boolean isMuteVoice = !emulation.isMuteVoice(1, 3);
                    emulation.setMuteVoice(1, 3, isMuteVoice);
                    player.configureSID(1, sid -> sid.setVoiceMute(3, isMuteVoice));
                    break;
                }

                case '9': {
                    boolean isMuteVoice = !emulation.isMuteVoice(2, 0);
                    emulation.setMuteVoice(2, 0, isMuteVoice);
                    player.configureSID(2, sid -> sid.setVoiceMute(0, isMuteVoice));
                    break;
                }

                case 'a': {
                    boolean isMuteVoice = !emulation.isMuteVoice(2, 1);
                    emulation.setMuteVoice(2, 1, isMuteVoice);
                    player.configureSID(2, sid -> sid.setVoiceMute(1, isMuteVoice));
                    break;
                }

                case 'b': {
                    boolean isMuteVoice = !emulation.isMuteVoice(2, 2);
                    emulation.setMuteVoice(2, 2, isMuteVoice);
                    player.configureSID(2, sid -> sid.setVoiceMute(2, isMuteVoice));
                    break;
                }

                case 'c': {
                    boolean isMuteVoice = !emulation.isMuteVoice(2, 3);
                    emulation.setMuteVoice(2, 3, isMuteVoice);
                    player.configureSID(2, sid -> sid.setVoiceMute(3, isMuteVoice));
                    break;
                }

                case 'f': {
                    boolean filterEnable = !emulation.isFilter();
                    emulation.setFilter(filterEnable);
                    player.configureSID(0, sid -> sid.setFilterEnable(emulation, 0));
                    break;
                }

                case 'g': {
                    boolean filterEnable = !emulation.isStereoFilter();
                    emulation.setStereoFilter(filterEnable);
                    player.configureSID(1, sid -> sid.setFilterEnable(emulation, 1));
                    break;
                }

                case 'G': {
                    boolean filterEnable = !emulation.isThirdSIDFilter();
                    emulation.setThirdSIDFilter(filterEnable);
                    player.configureSID(2, sid -> sid.setFilterEnable(emulation, 2));
                    break;
                }

                case 'w': {
                    boolean whatsSidEnable = !whatsSid.isEnable();
                    whatsSid.setEnable(whatsSidEnable);
                    player.configureMixer(mixer -> {
                        if (mixer instanceof SIDMixer) {
                            ((SIDMixer) mixer).setWhatsSidEnabled(whatsSidEnable);
                        }
                    });
                    break;
                }

                case 'q':
                    player.quit();
                    break;

                default:
                    break;
            }
        } catch (final IOException e) {
            player.quit();
        }
    }

    public void whatsSid(MusicInfoWithConfidenceBean musicInfoWithConfidence, boolean quiet, PrintStream out) {
        if (quiet) {
            return;
        }
        out.println(musicInfoWithConfidence);
    }

    private void printTopLine(PrintStream out, final IConsoleSection console) {
        out.printf("%c%s%c\n", console.getTopLeft(), setFill(console.getHorizontal(), 54), console.getTopRight());
    }

    private void printHeading(PrintStream out, final IConsoleSection console) {
        out.printf("%c %52s %c\n", console.getVertical(), resourceBundle.apply("HEADING"), console.getVertical());
    }

    private void printSeparatorLine(PrintStream out, final IConsoleSection console) {
        out.printf("%c%s%c\n", console.getJunctionLeft(), setFill(console.getHorizontal(), 54),
                console.getJunctionRight());
    }

    private void printTitleAutorReleased(PrintStream out, final IConsoleSection console, final SidTune tune) {
        Iterator<String> description = tune.getInfo().getInfoString().iterator();
        out.printf("%c %-12s : %37s %c\n", console.getVertical(), resourceBundle.apply("TITLE"), description.next(),
                console.getVertical());
        out.printf("%c %-12s : %37s %c\n", console.getVertical(), resourceBundle.apply("AUTHOR"), description.next(),
                console.getVertical());
        out.printf("%c %-12s : %37s %c\n", console.getVertical(), resourceBundle.apply("RELEASED"), description.next(),
                console.getVertical());
    }

    private void printDecription(PrintStream out, final IConsoleSection console, final SidTune tune) {
        for (String description : tune.getInfo().getInfoString()) {
            out.printf("%c %-12s : %37s %c\n", console.getVertical(), resourceBundle.apply("DESCRIPTION"), description,
                    console.getVertical());
        }
    }

    private void printFileDetails(PrintStream out, final IConsoleSection console, final SidTune tune) {
        out.printf("%c %-12s : %37s %c\n", console.getVertical(), resourceBundle.apply("FILE_FORMAT"),
                tune.getClass().getSimpleName(), console.getVertical());
        out.printf("%c %-12s : %37s %c\n", console.getVertical(), resourceBundle.apply("FILENAMES"), filename,
                console.getVertical());
    }

    private void printPlaylist(PrintStream out, final IConsoleSection console, final SidTune tune,
                               final PlayList playList) {
        int trackNum = playList.getTrackNum();
        out.printf("%c %-12s : ", console.getVertical(), resourceBundle.apply("PLAYLIST"));
        StringBuilder trackList = new StringBuilder();
        trackList.append(trackNum).append("/").append(playList.getLength());
        trackList.append(" (tune ").append(tune.getInfo().getCurrentSong()).append("/")
                .append(tune.getInfo().getSongs());
        trackList.append("[").append(tune.getInfo().getStartSong()).append("])");
        if (config.getSidplay2Section().isLoop()) {
            trackList.append(" [").append(resourceBundle.apply("LOOPING")).append("]");
        }
        out.printf("%37s %c\n", trackList, console.getVertical());
    }

    private void printSongSpeedCIAorVBI(PrintStream out, final IConsoleSection console, final SidTune tune,
                                        final PlayList playList) {
        out.printf("%c %-12s : %37s %c\n", console.getVertical(), resourceBundle.apply("SONG_SPEED"),
                tune.getSongSpeed(playList.getCurrent()), console.getVertical());
    }

    private void printSongLength(PrintStream out, final IConsoleSection console, final Timer timer) {
        out.printf("%c %-12s : ", console.getVertical(), resourceBundle.apply("SONG_LENGTH"));
        if (timer.getEnd() != 0) {
            String time = new SimpleDateFormat("mm:ss.SSS").format(new Date((long) (timer.getEnd() * 1000)));
            out.printf("%37s %c\n", time, console.getVertical());
        } else {
            out.printf("%37s %c\n", resourceBundle.apply("UNLIMITED"), console.getVertical());
        }
    }

    private void printHorizontalBottomLine(PrintStream out, final IConsoleSection console) {
        out.printf("%c%s%c\n", console.getBottomLeft(), setFill(console.getHorizontal(), 54), console.getBottomRight());
    }

    private void printAddresses(PrintStream out, final IConsoleSection console, final SidTune tune) {
        StringBuilder line = new StringBuilder();
        // Display PSID Driver location
        line.append(resourceBundle.apply("DRIVER_ADDR")).append(" = ");
        if (tune.getInfo().getDeterminedDriverAddr() == 0) {
            line.append(resourceBundle.apply("NOT_PRESENT"));
        } else {
            line.append(String.format("$%04x", tune.getInfo().getDeterminedDriverAddr()));
            line.append(String.format("-$%04x",
                    tune.getInfo().getDeterminedDriverAddr() + tune.getInfo().getDeterminedDriverLength() - 1));
        }
        if (tune.getInfo().getPlayAddr() == 0xffff) {
            line.append(String.format(", " + resourceBundle.apply("SYS") + " = $%04x", tune.getInfo().getInitAddr()));
        } else {
            line.append(String.format(", " + resourceBundle.apply("INIT") + " = $%04x", tune.getInfo().getInitAddr()));
        }

        out.printf("%c %-12s : %37s %c\n", console.getVertical(), resourceBundle.apply("ADDRESSES"), line,
                console.getVertical());
        line = new StringBuilder();
        line.append(String.format(resourceBundle.apply("LOAD") + " = $%04x", tune.getInfo().getLoadAddr()));
        line.append(String.format("-$%04x", tune.getInfo().getLoadAddr() + tune.getInfo().getC64dataLen() - 1));
        if (tune.getInfo().getPlayAddr() != 0xffff) {
            line.append(String.format(", %s = $%04x", resourceBundle.apply("PLAY"), tune.getInfo().getPlayAddr()));
        }
        out.printf("%c              : %37s %c\n", console.getVertical(), line, console.getVertical());
    }

    private void printSIDDetails(PrintStream out, final IConsoleSection console, final SidTune tune) {
        StringBuilder line = new StringBuilder();
        IEmulationSection emulationSection = config.getEmulationSection();
        line.append(resourceBundle.apply("FILTER")).append(emulationSection.isFilter() ? " = on" : " = off");
        out.printf("%c %-12s : %37s %c\n", console.getVertical(), resourceBundle.apply("SID_DETAILS"), line,
                console.getVertical());

        for (int sidNum = 0; sidNum < MAX_SIDS; sidNum++) {
            if (SidTune.isSIDUsed(emulationSection, tune, sidNum)) {
                Engine engine = Engine.getEngine(emulationSection, tune);
                out.printf("%c %-10s %02d: %37s %c\n", console.getVertical(), resourceBundle.apply("ENGINE"),
                        sidNum + 1, engine, console.getVertical());
            }
        }
        for (int sidNum = 0; sidNum < MAX_SIDS; sidNum++) {
            if (SidTune.isSIDUsed(emulationSection, tune, sidNum)) {
                Emulation emulation = Emulation.getEmulation(emulationSection, sidNum);
                out.printf("%c %-10s %02d: %37s %c\n", console.getVertical(), resourceBundle.apply("EMULATION"),
                        sidNum + 1, emulation, console.getVertical());
            }
        }
        for (int sidNum = 0; sidNum < MAX_SIDS; sidNum++) {
            if (SidTune.isSIDUsed(emulationSection, tune, sidNum)) {
                ChipModel chipModel = ChipModel.getChipModel(emulationSection, tune, sidNum);
                out.printf("%c %-10s %02d: %37s %c\n", console.getVertical(), resourceBundle.apply("MODEL"), sidNum + 1,
                        chipModel, console.getVertical());
            }
        }
        for (int sidNum = 0; sidNum < MAX_SIDS; sidNum++) {
            if (SidTune.isSIDUsed(emulationSection, tune, sidNum)) {
                Engine engine = Engine.getEngine(emulationSection, tune);
                Emulation emulation = Emulation.getEmulation(emulationSection, sidNum);
                ChipModel chipModel = ChipModel.getChipModel(emulationSection, tune, sidNum);
                String filterName = emulationSection.getFilterName(sidNum, engine, emulation, chipModel);
                out.printf("%c %-10s %02d: %37s %c\n", console.getVertical(), resourceBundle.apply("SID_FILTER"),
                        sidNum + 1, filterName, console.getVertical());
            }
        }
    }

    private void printKeyboardControls(PrintStream out) {
        out.println(resourceBundle.apply("KEYBOARD_CONTROLS"));
        out.println(resourceBundle.apply("FORWARD_REWIND"));
        out.println(resourceBundle.apply("FIRST_LAST"));
        out.println(resourceBundle.apply("NORMAL_FAST"));
        out.println(resourceBundle.apply("WARP"));
        out.println(resourceBundle.apply("FORWARD_TUNE"));
        out.println(resourceBundle.apply("PAUSE_CONTINUE"));
        out.println(resourceBundle.apply("MUTE_1"));
        out.println(resourceBundle.apply("MUTE_2"));
        out.println(resourceBundle.apply("MUTE_3"));
        out.println(resourceBundle.apply("MUTE_4"));
        out.println(resourceBundle.apply("MUTE_5"));
        out.println(resourceBundle.apply("MUTE_6"));
        out.println(resourceBundle.apply("MUTE_7"));
        out.println(resourceBundle.apply("MUTE_8"));
        out.println(resourceBundle.apply("MUTE_9"));
        out.println(resourceBundle.apply("MUTE_10"));
        out.println(resourceBundle.apply("MUTE_11"));
        out.println(resourceBundle.apply("MUTE_12"));
        out.println(resourceBundle.apply("FILTER_ENABLE"));
        out.println(resourceBundle.apply("STEREO_FILTER_ENABLE"));
        out.println(resourceBundle.apply("3RD_SID_FILTER_ENABLE"));
        out.println(resourceBundle.apply("WHATSSID_ENABLE"));
        out.println(resourceBundle.apply("QUIT"));
    }

    private String setFill(final char ch, final int length) {
        final StringBuilder ret = new StringBuilder();
        for (int i = 0; i < length; i++) {
            ret.append(ch);
        }
        return ret.toString();
    }

}