{"id":146,"date":"2021-07-26T12:07:38","date_gmt":"2021-07-26T12:07:38","guid":{"rendered":"https:\/\/blogs.scummvm.org\/twan\/?p=146"},"modified":"2021-07-26T12:07:39","modified_gmt":"2021-07-26T12:07:39","slug":"how-to-add-tts-to-the-intro-of-griffon","status":"publish","type":"post","link":"https:\/\/blogs.scummvm.org\/twan\/2021\/07\/26\/how-to-add-tts-to-the-intro-of-griffon\/","title":{"rendered":"How to add TTS to the intro of Griffon"},"content":{"rendered":"\n

Note<\/h2>\n\n\n\n

It’s just an overview.<\/p>\n\n\n\n

Find the Text<\/h2>\n\n\n\n

In Griffon’s case, the text is in the code<\/p>\n\n\n\n

So just search for “Ever since I was a child”, and there it is, in cutscenes.cpp<\/code><\/p>\n\n\n\n

const char *story[48] = {\n\t\"The Griffon Legend\",\n\t\"http:\/\/syn9.thehideoutgames.com\/\",\n\t\"\",\n\t\"Programming\/Graphics: Daniel Kennedy\",\n\t\"Music\/Sound effects: David Turner\",\n\t\"\",\n\t\"Porting to GCW-Zero: Dmitry Smagin\",\n\t\"\",\n\t\"\",\n\t\"Story\",\n\t\"Ever since I was a child\",\n\t\"I remember being told the\",\n\t\"Legend of the Griffon Knights,\",<\/code><\/pre>\n\n\n\n
Pass to Text To Speech Manager<\/h2>\n\n\n\n
Then, we would like to pass the text to text to speech manager<\/p>\n\n\n\n
To call for TTS manager, first, include this in the header<\/p>\n\n\n\n
#include \"common\/text-to-speech.h\"<\/code><\/pre>\n\n\n\n
Then initialize TTS manager like this<\/p>\n\n\n\n
Common::TextToSpeechManager *ttsMan = g_system->getTextToSpeechManager();<\/code><\/pre>\n\n\n\n
Before passing the text to it, we check to see if it is null pointer, to avoid a crash<\/p>\n\n\n\n
if (ttsMan != nullptr) \n\tttsMan->say(\"The Griffon Legend\");<\/code><\/pre>\n\n\n\n
We also would like to check if TTS has been enabled already<\/p>\n\n\n\n
(This works given that there are proper adjustments to detection.cpp about “tts_enabed”)<\/p>\n\n\n\n
#include \"common\/config-manager.h\"\n\nif (ttsMan != nullptr && ConfMan.getBool(\"tts_enabled\"))\t\n\tttsMan->say(\"The Griffon Legend\");<\/code><\/pre>\n\n\n\n
Obviously we would like the whole story to have TTS, so we loop through<\/p>\n\n\n\n
for (int i = 0; i < ARRAYSIZE(story); i++) {\n \t\/\/ Do the TTS thing\n}<\/code><\/pre>\n\n\n\n
Staying in pace<\/h2>\n\n\n\n
We would like to have the text shown on the screen be in pace with the TTS speaker.<\/p>\n\n\n\n
Therefore, we would like to use the same for loop that is used for showing the text on the screen<\/p>\n\n\n\n
See this in the same file, under void GriffonEngine::intro()<\/code>, there is a  do<\/code> { <\/p>\n\n\n\n
for (int i = 0; i < ARRAYSIZE(story); i++) {           \/\/ go through the story array\n\n \tint yy = y + i * 10;                               \/\/ calculate position\n\n\tif (yy > -8 && yy < 240) {\n\t\tint x = 160 - strlen(story[i]) * 4;            \/\/ when time comes\n\t\tdrawString(_videoBuffer, story[i], x, yy, 4);  \/\/ draw text to the screen\n\t}\n\n  \tif (yy < 10 && i == ARRAYSIZE(story) - 1) {        \/\/ last paragraph has left the screen\n\t\treturn;                                        \/\/ proceed to game\n\t}<\/code><\/pre>\n\n\n\n
Because there are multiple lines appearing on the screen at once, we need a way to keep track of what has been narrated, and what hasn’t yet<\/p>\n\n\n\n
\nint nextparagraph = 0;               \/\/this is new\n\nfor (int i = 0; i < ARRAYSIZE(story); i++) {\n\n    int yy = y + i * 10;                           \n\n    \/\/ if (i == nextparagraph)     \n        \/\/ do Text To Speech\n        \/\/ update nextparagraph to reflect progress\n\n    if (yy > -8 && yy < 240) {\n\tint x = 160 - strlen(story[i]) * 4;\n \tdrawString(_videoBuffer, story[i], x, yy, 4);  \n    }\n\n    if (yy < 10 && i == ARRAYSIZE(story) - 1) {        \n\treturn;\n    }<\/code><\/pre>\n\n\n\n
There are also two more issues to be addressed:<\/p>\n\n\n\n
  1. It’s better to glue sentences that belong to the same paragraph together. The narrating sounds more natural <\/li>
  2. Queue new paragraphs behind the current paragraph that is being spoken<\/li><\/ol>\n\n\n\n
    We ended up doing this<\/p>\n\n\n\n
    int textToSpeech(int nextparagraph, const char *storyVariable[], int arraysize) {\n \tCommon::TextToSpeechManager *ttsMan = g_system->getTextToSpeechManager();\n \tif (ttsMan != nullptr && ConfMan.getBool(\"tts_enabled\") && storyVariable[nextparagraph][0] != 0) {\n \t\tCommon::String paragraph;\n \t\twhile (nextparagraph < arraysize && storyVariable[nextparagraph][0] != ' ') {\n \t\t\tif (!paragraph.empty())\n \t\t\t\tparagraph += \" \";\n \t\t\tparagraph += storyVariable[nextparagraph++];\n \t\t}\n \t\twhile (nextparagraph < arraysize && storyVariable[nextparagraph][0] == ' ') {\n \t\t\tnextparagraph += 1;\n \t\t}\n \t\tttsMan->say(paragraph, Common::TextToSpeechManager::QUEUE_NO_REPEAT);\n \t}\n \treturn nextparagraph;\n }\n\n<\/code><\/pre>\n\n\n\n
    And calling it with this<\/p>\n\n\n\n
    if (i == nextparagraph)\n \tnextparagraph = textToSpeech(nextparagraph, story, ARRAYSIZE(story));<\/code><\/pre>\n\n\n\n
    Enter game after TTS is finished<\/h2>\n\n\n\n
    Check if ttsMan is speaking (unless it’s nullptr) before return<\/p>\n\n\n\n
    if (ttsMan == nullptr || ttsMan->isSpeaking() == false)\n \treturn;\n\n\n\n<\/code><\/pre>\n\n\n\n
    Stop TTS if intro is interrupted<\/h2>\n\n\n\n
    If we press escape, the intro ends and so should the narrating<\/p>\n\n\n\n
    else if (_event.customType == kGriffonMenu) {\n \tif (ttsMan != nullptr)\n \t\tttsMan->stop();\n\treturn;<\/code><\/pre>\n\n\n\n
    <\/p>\n\n\n\n
    And That’s about it!<\/h2>\n\n\n\n
    Full changes can be found here<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
    Note It’s just an overview. Find the Text In Griffon’s case, the text is in the code So just search for “Ever since I was a child”, and there it is, in cutscenes.cpp Pass to Text To Speech Manager Then, we would like to pass the text to text to speech manager To call for … Read moreHow to add TTS to the intro of Griffon<\/span><\/a><\/p>\n","protected":false},"author":9,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[5],"class_list":["post-146","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-griffon"],"_links":{"self":[{"href":"https:\/\/blogs.scummvm.org\/twan\/wp-json\/wp\/v2\/posts\/146","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blogs.scummvm.org\/twan\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.scummvm.org\/twan\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.scummvm.org\/twan\/wp-json\/wp\/v2\/users\/9"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.scummvm.org\/twan\/wp-json\/wp\/v2\/comments?post=146"}],"version-history":[{"count":8,"href":"https:\/\/blogs.scummvm.org\/twan\/wp-json\/wp\/v2\/posts\/146\/revisions"}],"predecessor-version":[{"id":154,"href":"https:\/\/blogs.scummvm.org\/twan\/wp-json\/wp\/v2\/posts\/146\/revisions\/154"}],"wp:attachment":[{"href":"https:\/\/blogs.scummvm.org\/twan\/wp-json\/wp\/v2\/media?parent=146"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.scummvm.org\/twan\/wp-json\/wp\/v2\/categories?post=146"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.scummvm.org\/twan\/wp-json\/wp\/v2\/tags?post=146"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}