enum for speech priority and flags for blocking speech

Author: anderoonies

Makefile

@@ -24,12 +24,11 @@ ifeq ($(GRAPHICS),YES)
 	sources += $(addprefix src/platform/,sdl2-platform.c tiles.c)
 	cflags += $(shell $(SDL_CONFIG) --cflags)
 	cppflags += -DBROGUE_SDL
-	libs += $(shell $(SDL_CONFIG) --libs) -lSDL2_image
+	libs += $(shell $(SDL_CONFIG) --libs) -lSDL2_image -lespeak-ng
 endif
 
 ifeq ($(SPEECH),YES)
 	cppflags += -DBROGUE_SPEECH
-	libs += -lespeak-ng
 endif
 
 ifeq ($(WEBBROGUE),YES)

config.mk

@@ -13,10 +13,10 @@ SDL_CONFIG := sdl2-config
 WEBBROGUE := NO
 
 # Add TTS. Requires GRAPHICS for now, just to add SDL.
-SPEECH := YES
+SPEECH := NO
 
 # Enable debugging mode. See top of Rogue.h for features
-DEBUG := NO
+DEBUG := YES
 
 # Declare this is a release build
 RELEASE := NO

src/brogue/IO.c

@@ -2690,6 +2690,9 @@ void executeKeystroke(signed long keystroke, boolean controlKey, boolean shiftKe
                 gameOver("Quit", true);
             }
             break;
+        case TTS_TOGGLE_KEY:
+            toggleTTS();
+            break;
         case GRAPHICS_KEY:
             if (hasGraphics) {
                 graphicsMode = setGraphicsMode((graphicsMode + 1) % 3);
@@ -2974,8 +2977,8 @@ boolean confirm(char *prompt, boolean alsoDuringPlayback) {
         return true; // oh yes he did
     }
 
-    playSpeech(prompt, 3);
-    playSpeech("Yes... No", 3);
+    playSpeech(prompt, THREE_SPEECH, SPEECH_BLOCKS);
+    playSpeech("Yes... No", THREE_SPEECH, 0);
 
     encodeMessageColor(whiteColorEscape, 0, &white);
     encodeMessageColor(yellowColorEscape, 0, KEYBOARD_LABELS ? &yellow : &white);
@@ -3441,17 +3444,17 @@ void temporaryMessage(const char *msg, enum messageFlags flags) {
     }
     restoreRNG;
 
-    playSpeech(msg, 1);
+    playSpeech(msg, ONE_SPEECH, 0);
 }
 
-void messageWithColor(char *msg, color *theColor, enum messageFlags flags, short speechPriority) {
+void messageWithColor(char *msg, color *theColor, enum messageFlags flags, enum speechPriority priority) {
     char buf[COLS*2] = "";
     short i;
 
     i=0;
     i = encodeMessageColor(buf, i, theColor);
     strcpy(&(buf[i]), msg);
-    message(buf, flags, speechPriority);
+    message(buf, flags, priority);
 }
 
 void flavorMessage(char *msg) {
@@ -3479,7 +3482,7 @@ void flavorMessage(char *msg) {
 // arrived on the same turn, they may collapse.  Alternately, they may collapse
 // if the older message is the latest one in the archive and the new one is not
 // semi-colon foldable (such as a combat message.)
-void message(const char *msg, enum messageFlags flags, short speechPriority) {
+void message(const char *msg, enum messageFlags flags, enum speechPriority priority) {
     short i;
     archivedMessage *archiveEntry;
     boolean newMessage;
@@ -3549,7 +3552,7 @@ void message(const char *msg, enum messageFlags flags, short speechPriority) {
 
     restoreRNG;
 
-    playSpeech(msg, speechPriority);
+    playSpeech(msg, priority, 0);
 }
 
 // Only used for the "you die..." message, to enable posthumous inventory viewing.

src/brogue/Items.c

@@ -2958,7 +2958,7 @@ char displayInventory(unsigned short categoryMask,
 
                 overlayDisplayBuffer(dbuf, NULL);
 
-                playSpeech(buttons[highlightItemLine].text, 3);
+                playSpeech(buttons[highlightItemLine].text, THREE_SPEECH, 0);
 
                 //buttons[highlightItemLine].buttonColor = interfaceBoxColor;
                 drawButton(&(buttons[highlightItemLine]), BUTTON_PRESSED, NULL);

src/brogue/MainMenu.c

@@ -344,7 +344,7 @@ void titleMenu() {
     initializeMenuFlames(true, colors, colorStorage, colorSources, flames, mask);
     rogue.creaturesWillFlashThisTurn = false; // total unconscionable hack
 
-    playSpeech("Welcome to Brogue!", 1);
+    playSpeech("Welcome to Brogue!", ONE_SPEECH, 0);
 
     do {
         if (isApplicationActive()) {

src/brogue/Movement.c

@@ -405,7 +405,7 @@ void speakLocation(char *locationDescription, short x, short y) {
     strcat(locationMessage, posY);
     strcat(locationMessage, posX);
 
-    playSpeech(locationMessage, 0);
+    playSpeech(locationMessage, ZERO_SPEECH, 0);
 }
 
 void printLocationDescription(short x, short y) {

src/brogue/Rogue.h

@@ -325,6 +325,18 @@ enum graphicsModes {
     HYBRID_GRAPHICS, // text for items and creatures, tiles for environment
 };
 
+enum speechPriority {
+    NO_SPEECH,
+    ZERO_SPEECH,
+    ONE_SPEECH,
+    TWO_SPEECH,
+    THREE_SPEECH
+};
+
+enum TTSFlags {
+    SPEECH_BLOCKS = Fl(0),
+};
+
 enum eventTypes {
     KEYSTROKE,
     MOUSE_UP,
@@ -357,6 +369,7 @@ typedef struct rogueEvent {
 
 typedef struct speechData {
     short priority;
+    unsigned long flags;
     char message[DCOLS];
 } speechData;
 
@@ -1160,6 +1173,7 @@ enum tileFlags {
 #define AUTOPLAY_KEY        'A'
 #define SEED_KEY            '~'
 #define EASY_MODE_KEY       '&'
+#define TTS_TOGGLE_KEY      '!'
 #define ESCAPE_KEY          '\033'
 #define RETURN_KEY          '\012'
 #define DELETE_KEY          '\177'
@@ -2750,8 +2764,9 @@ extern "C" {
     void nextKeyOrMouseEvent(rogueEvent *returnEvent, boolean textInput, boolean colorsDance);
     void notifyEvent(short eventId, int data1, int data2, const char *str1, const char *str2);
     boolean takeScreenshot();
+    void toggleTTS();
     enum graphicsModes setGraphicsMode(enum graphicsModes mode);
-    void playSpeech(char *text, short priority);
+    void playSpeech(char *text, enum speechPriority priority, unsigned long flags);
     boolean controlKeyIsDown();
     boolean shiftKeyIsDown();
     short getHighScoresList(rogueHighScoresEntry returnList[HIGH_SCORES_COUNT]);
@@ -2924,9 +2939,9 @@ extern "C" {
     void displayRecentMessages();
     void displayMessageArchive();
     void temporaryMessage(const char *msg1, enum messageFlags flags);
-    void messageWithColor(char *msg, color *theColor, enum messageFlags flags, short speechPriority);
+    void messageWithColor(char *msg, color *theColor, enum messageFlags flags, enum speechPriority priority);
     void flavorMessage(char *msg);
-    void message(const char *msg, enum messageFlags flags, short speechPriority);
+    void message(const char *msg, enum messageFlags flags, enum speechPriority priority);
     void displayMoreSignWithoutWaitingForAcknowledgment();
     void displayMoreSign();
     short encodeMessageColor(char *msg, short i, const color *theColor);

src/platform/platform.h

@@ -84,6 +84,7 @@ struct brogueConsole {
     */
     enum graphicsModes (*setGraphicsMode)(enum graphicsModes mode);
     void (*playSpeech)();
+    boolean (*toggleTTS)();
 };
 
 // defined in platform

src/platform/platformdependent.c

@@ -267,9 +267,15 @@ enum graphicsModes setGraphicsMode(enum graphicsModes mode) {
     }
 }
 
-void playSpeech(char *text, short priority) {
+void toggleTTS() {
+    if (currentConsole.toggleTTS) {
+        currentConsole.toggleTTS();
+    }
+}
+
+void playSpeech(char *text, enum speechPriority priority, unsigned long flags) {
     if (currentConsole.playSpeech) {
-        currentConsole.playSpeech(text, priority);
+        currentConsole.playSpeech(text, priority, flags);
     }
 }
 

src/platform/sdl2-platform.c

@@ -21,6 +21,12 @@ static struct keypair remapping[MAX_REMAPS];
 static size_t nremaps = 0;
 static enum graphicsModes showGraphics = TEXT_GRAPHICS;
 
+#ifdef BROGUE_SPEECH
+    static boolean useTTS = true;
+#else 
+    static boolean useTTS = false;
+#endif
+
 static rogueEvent lastEvent;
 static speechData lastSpeech;
 
@@ -152,20 +158,25 @@ static boolean audioInit() {
 
 static void _playSpeech(
     char *text,
-    short priority
+    enum speechPriority priority,
+    unsigned long flags
 ) {
-    if (priority >= lastSpeech.priority) {
-        espeak_Cancel();
-    } else {
+    if (!useTTS) {
+        return;
+    }
+    if (lastSpeech.flags & SPEECH_BLOCKS) {
         espeak_Synchronize();
+    } else if (priority >= lastSpeech.priority) {
+        espeak_Cancel();
     }
     // remove any escape codes from the text
     int i, j;
     char sanitizedMessage[90] = "";
+    color white;
     for(i = 0, j = 0; i < strlen(text); i++)
     {
-        while (text[i] == COLOR_ESCAPE) {
-            i += 4;
+        if (text[i] == COLOR_ESCAPE) {
+            i = decodeMessageColor(text, i, &white);
         }
 
         if(i >= strlen(text)) {
@@ -187,6 +198,7 @@ static void _playSpeech(
     );
     // TODO: mark interruptable messages with unique_identifier
     lastSpeech.priority = priority;
+    lastSpeech.flags = flags;
 }
 
 
@@ -474,6 +486,13 @@ static enum graphicsModes _setGraphicsMode(enum graphicsModes mode) {
     return mode;
 }
 
+static boolean _toggleTTS() {
+    useTTS = !useTTS;
+    if (useTTS) {
+        playSpeech("Speech enabled", ZERO_SPEECH, 0);
+    }
+}
+
 
 struct brogueConsole sdlConsole = {
     _gameLoop,
@@ -485,5 +504,6 @@ struct brogueConsole sdlConsole = {
     NULL,
     _takeScreenshot,
     _setGraphicsMode,
+    .toggleTTS = _toggleTTS,
     .playSpeech = _playSpeech
 };