rename packages, update README

Author: RhythmicSys

README.md

@@ -1,28 +1,7 @@
-# Command Line TTS
-I will keep on accidentally referring to it as CLI TTS - so I just named the repo that to get it out of the way
-
-This is a basic Command Line based Text-To-Speech application.
-This application interfaces with Amazon Polly, and requires the use of standard voices.
-It has the ability to use [SSML](https://docs.aws.amazon.com/polly/latest/dg/supportedtags.html) (Speech Synthesis
-Markup Language), and the configuration has the ability to set up text to replace.
-
-## Replace Text
-
-The replace text section of the configuration allows you to set specific strings that will be replaced by other strings.
-This can be very useful for when you want to use SSML and set a shorthand for the beginning tag and ending tag.
-This can also be useful for having 'macros'/'commands' with different responses
-
-> **Note**:
-> <br>It is advised to only replace specific combinations of characters, and not common combinations/single characters
-> <br>For example don't replace `"e"` with `"𝔼"` otherwise the tag `"__"` will break because it will now
-> be `<𝔼mphasis l𝔼v𝔼l=\"strong\">` instead of `<emphasis level=\"strong\">`
-> <br>You can mitigate this issue by surrounding the letter with a space like this: `" e "`
-
-## Voice Prefixes
-
-The voice prefixes section allows you to set a prefix that will switch the voice to a specific Polly voice.
-Then, if you use that prefix at the beginning of a message, the application will switch to that voice until another
-prefix is used.
+# Console Text To Speech
+This program is meant to be an intuitive text-to-speech program that runs on command line. 
+  This was made with streamers who struggle speaking in mind - but is open to use for many other things.
+  This uses SSML - and uses markdown-esque formatting for the effects.
 
 ### AWS
 Using this requires an AWS account - https://aws.amazon.com/
@@ -34,47 +13,80 @@ References:
 - [Amazon Polly Description of Limits/Price](https://aws.amazon.com/polly/pricing/)
 - [Setting up a user and how to use IAM](https://docs.aws.amazon.com/signer/latest/developerguide/iam-setup.html)
 
+## Voice Prefixes
+
+The voice prefixes section allows you to set a prefix that will switch the voice to a specific Polly voice.
+Then, if you use that prefix at the beginning of a message, the application will switch to that voice until another prefix is used. 
+Prefixes will be matched ignoring case and even if there's a `:` or `-` after it.
+
+## Speech Effect Markdown
+
+This is where the marks for the effects are declared. [SSML Tags Can Be Found Here](https://docs.aws.amazon.com/polly/latest/dg/supportedtags.html) - Currently self-closing tags such as 'break' are not supported
+Effect declaration in the config looks like this:
+
+```yml
+speech-effect-markdown:
+  "!": //The character(s) that will be on either side of the text you want the effect to be used on
+    type: tag-name     //This is the tag name, might have 'amazon:' before it
+    attribute: value   // Any customization settings go after that, like "volume" and "loud"
+```
+
+By default, the markdown will be matched if surrounded by spaces or newlines/end of lines, but not if surrounded by other characters. 
+So you can have '.' and '..' as effect markdowns if you want
+
+
+## Text Replacements
+
+This is generic text replacement - it is run through a regex so that things aren't caught in the middle of a sentence. 
+
+## Other Settings
+
+**Server Port:**
+Used for the HTTP server the amazon requests are being made from. You shouldn't need to change this unless you already know what you're doing
 
 ### Default configuration
 
-```HOCON
-aws-region= "US_EAST_1"
-aws-access-id= ""
-aws-secret-key= ""
-connect-to-twitch= false
-twitch-channel= ""
-twitch-app-client-id= ""
-twitch-app-client-secret= ""
-replace-text {
-  "**"= "<prosody volume=\"x-loud\" pitch=\"low\" rate=\"slow\">"
-  "/*"= "</prosody>"
-  "*/"= "</prosody>"
-  "~~"= "<amazon:effect name=\"whispered\">"
-  "/~"= "</amazon:effect>"
-  "~/"= "</amazon:effect>"
-  "__"= "<emphasis level=\"strong\">"
-  "/_"= "</emphasis>"
-  "_/"= "</emphasis>"
-  "++"= "<prosody volume=\"x-loud\" rate=\"x-fast\" pitch=\"x-high\">"
-  "/+"= "</prosody>"
-  "+/"= "</prosody>"
-  "!!"= "<say-as interpret-as=\"expletive\">"
-  "/!"= "</say-as>"
-  "!/"= "</say-as>"
-  " - "= "<break time=\"300ms\"/>"
-  "<3"= "heart emoji"
-}
-default-voice= "Brian"
-voice-prefixes {
-  "Sal:"= "Salli"
-  "Kim:"= "Kimberly"
-  "Bri:"= "Brian"
-}
+```yml
+aws-api:
+  access-key: ""
+  secret-key: ""
+  region: "US_EAST_1"
+  default-voice: "Brian"
+  voice-prefixes:
+    Sal: Salli
+    Kim: Kimberly
+    Bri: Brian
+speech-effect-markdown:
+  "**":
+    type: prosody
+    volume: x-loud
+    pitch: low
+    rate: slow
+  "~~":
+    type: amazon:effect
+    name: whispered
+  "__":
+    type: emphasis
+    level: strong
+  "*":
+    type: prosody
+    volume: x-loud
+    rate: x-fast
+    pitch: x-high
+  "||":
+    type: say-as
+    interpret-as: expletive
+text-replacements:
+    "<3": "heart emoji"
+internal-settings:
+  server-port: 3000
+
 ```
 
 Todo:
 
-- [ ] Make closing tags less annoying
+- [x] Make closing tags less annoying
 - [x] Manage exceptions better
 - [x] Probably unify the config into one file
 - [ ] Add configuration for audio output destination
+- [ ] Add more Polly configuration (how dates are said, numbers, etc)

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>simplexity</groupId>
     <artifactId>Console-TTS</artifactId>
-    <version>2.0.0</version>
+    <version>3.0.0</version>
     <packaging>jar</packaging>
 
     <properties>

src/main/java/simplexity/Main.java

@@ -13,12 +13,12 @@
 import simplexity.config.ConfigHandler;
 import simplexity.config.LocaleHandler;
 import simplexity.config.YmlConfig;
+import simplexity.console.InputHandler;
+import simplexity.console.Logging;
 import simplexity.httpserver.LocalServer;
-import simplexity.util.Logging;
 
 import java.io.File;
 import java.io.IOException;
-import java.util.Scanner;
 
 public class Main {
     private static final Logger logger = LoggerFactory.getLogger(Main.class);
@@ -27,15 +27,13 @@ public class Main {
     private static CommandManager commandManager;
     public static PollyHandler pollyHandler;
     private static SpeechHandler speechHandler;
-    public static Scanner scanner;
+    private static InputHandler inputHandler;
+
     public static boolean runApp = true;
 
     @SuppressWarnings("CallToPrintStackTrace")
     public static void main(String[] args) {
         Logging.log(logger, "Starting application", Level.INFO);
-        scanner = new Scanner(System.in);
-        commandManager = new CommandManager();
-        registerCommands(commandManager);
         File file = new File("config/config.yml");
         File localeFile = new File("config/locale.yml");
         try {
@@ -48,15 +46,13 @@ public static void main(String[] args) {
         }
         LocaleHandler.getInstance().reloadMessages();
         ConfigHandler.getInstance().reloadValues();
+        commandManager = new CommandManager();
+        speechHandler = new SpeechHandler();
+        registerCommands(commandManager);
         PollySetup.setupPollyAndSpeech();
         LocalServer.run();
-        while (runApp) {
-            String input = scanner.nextLine();
-            if (!commandManager.runCommand(input)) {
-                input = stripInvalidCharacters(input);
-                speechHandler.processSpeech(input);
-            }
-        }
+        inputHandler = new InputHandler(commandManager, speechHandler);
+        inputHandler.runLoop();
     }
 
     private static void registerCommands(CommandManager commandManager) {
@@ -65,16 +61,15 @@ private static void registerCommands(CommandManager commandManager) {
         commandManager.registerCommand(new ReloadCommand("--reload", "Reloads the configuration"));
     }
 
-    private static String stripInvalidCharacters(String input) {
-        if (input == null) return null;
-        return input.replaceAll("\u001B\\[[;\\d]*[ -/]*[@-~]", "")
-                .replaceAll("\\p{C}", "");
-    }
 
     public static CommandManager getCommandManager() {
         return commandManager;
     }
 
+    public static InputHandler getInputHandler() {
+        return inputHandler;
+    }
+
     public static PollyHandler getPollyHandler() {
         return pollyHandler;
     }
@@ -87,15 +82,11 @@ public static void setPollyHandler(PollyHandler pollyHandlerToSet) {
         pollyHandler = pollyHandlerToSet;
     }
 
-    public static Scanner getScanner() {
-        return scanner;
-    }
-
-    public static YmlConfig getConfig(){
+    public static YmlConfig getConfig() {
         return config;
     }
 
-    public static YmlConfig getLocaleConfig(){
+    public static YmlConfig getLocaleConfig() {
         return localeConfig;
     }
 

src/main/java/simplexity/amazon/PollySetup.java

@@ -7,13 +7,10 @@
 import simplexity.Main;
 import simplexity.config.ConfigHandler;
 import simplexity.config.LocaleHandler;
-import simplexity.util.Logging;
-
-import java.util.Scanner;
+import simplexity.console.Logging;
 
 public class PollySetup {
     private static final Logger logger = LoggerFactory.getLogger(PollySetup.class);
-    private static final Scanner scanner = Main.getScanner();
 
     public static void setupPollyAndSpeech() {
         connectToPolly();
@@ -38,17 +35,11 @@ public static PollyHandler createPollyHandler() {
     }
 
     public static void connectToPolly() {
-        while (true) {
-            Main.setPollyHandler(createPollyHandler());
-            if (Main.getPollyHandler() != null) {
-                return;
-            }
-            Logging.logAndPrint(logger, LocaleHandler.getInstance().getSaveAwsInfo(), Level.INFO);
-            scanner.nextLine();
-            ConfigHandler.getInstance().reloadValues();
-            if (Main.getPollyHandler() != null) {
-                return;
-            }
+        Main.setPollyHandler(createPollyHandler());
+        if (Main.getPollyHandler() != null) {
+            return;
         }
+        Logging.logAndPrint(logger, LocaleHandler.getInstance().getSaveAwsInfo(), Level.INFO);
+        System.exit(-1);
     }
 }

src/main/java/simplexity/amazon/SpeechHandler.java

@@ -16,7 +16,7 @@
 import simplexity.config.rules.SpeechEffectRule;
 import simplexity.config.rules.TextReplaceRule;
 import simplexity.config.rules.VoicePrefixRule;
-import simplexity.util.Logging;
+import simplexity.console.Logging;
 
 import java.io.InputStream;
 

src/main/java/simplexity/commands/CommandManager.java

@@ -4,7 +4,7 @@
 import org.slf4j.LoggerFactory;
 import org.slf4j.event.Level;
 import simplexity.config.LocaleHandler;
-import simplexity.util.Logging;
+import simplexity.console.Logging;
 
 import java.util.HashMap;
 

src/main/java/simplexity/commands/ExitCommand.java

@@ -4,7 +4,7 @@
 import simplexity.Main;
 import simplexity.config.LocaleHandler;
 import simplexity.httpserver.LocalServer;
-import simplexity.util.Logging;
+import simplexity.console.Logging;
 
 public class ExitCommand extends Command {
 

src/main/java/simplexity/commands/HelpCommand.java

@@ -5,7 +5,7 @@
 import org.slf4j.event.Level;
 import simplexity.Main;
 import simplexity.config.LocaleHandler;
-import simplexity.util.Logging;
+import simplexity.console.Logging;
 
 public class HelpCommand extends Command {
     private static final Logger logger = LoggerFactory.getLogger(HelpCommand.class);

src/main/java/simplexity/commands/ReloadCommand.java

@@ -7,9 +7,10 @@
 import simplexity.config.ConfigHandler;
 import simplexity.config.LocaleHandler;
 import simplexity.httpserver.LocalServer;
-import simplexity.util.Logging;
+import simplexity.console.Logging;
 
 import java.io.IOException;
+import java.util.Arrays;
 
 public class ReloadCommand extends Command {
 
@@ -29,7 +30,7 @@ public void execute() {
             LocaleHandler.getInstance().reloadMessages();
         } catch (IOException e) {
             Logging.logAndPrint(logger, "Fatal Error Reloading Config Files", Level.WARN);
-            Logging.logAndPrint(logger, e.getStackTrace().toString(), Level.WARN);
+            Logging.logAndPrint(logger, Arrays.toString(e.getStackTrace()), Level.WARN);
             System.exit(-1);
         }
         Logging.log(logger, "Stopping local server", Level.INFO);

src/main/java/simplexity/config/ConfigHandler.java

@@ -10,7 +10,7 @@
 import simplexity.config.rules.SpeechEffectRule;
 import simplexity.config.rules.TextReplaceRule;
 import simplexity.config.rules.VoicePrefixRule;
-import simplexity.util.Logging;
+import simplexity.console.Logging;
 
 import java.util.HashSet;
 import java.util.Map;