feat: Speaks welcome message when voice used for first time (#2093)

Author: atm1504

app/src/main/java/org/fossasia/susi/ai/chat/STTfragment.kt

@@ -3,9 +3,11 @@ package org.fossasia.susi.ai.chat
 import android.content.Context
 import android.content.Intent
 import android.os.Bundle
+import android.os.Handler
 import android.speech.RecognitionListener
 import android.speech.RecognizerIntent
 import android.speech.SpeechRecognizer
+import android.speech.tts.TextToSpeech
 import android.support.annotation.NonNull
 import android.support.v4.app.Fragment
 import android.support.v7.widget.LinearLayoutManager
@@ -19,6 +21,7 @@ import kotlinx.android.synthetic.main.fragment_sttframe.view.*
 import org.fossasia.susi.ai.R
 import org.fossasia.susi.ai.chat.adapters.recycleradapters.VoiceCommandsAdapter
 import org.fossasia.susi.ai.chat.contract.IChatPresenter
+import org.fossasia.susi.ai.helper.PrefManager
 import timber.log.Timber
 import java.util.Locale
 
@@ -29,6 +32,9 @@ class STTFragment : Fragment() {
     lateinit var recognizer: SpeechRecognizer
     lateinit var chatPresenter: IChatPresenter
     private val thisActivity = activity
+    private var textToSpeech: TextToSpeech? = null
+    private val mainHandler: Handler = Handler()
+    private val subHandler: Handler = Handler()
 
     override fun onAttach(context: Context?) {
         super.onAttach(context)
@@ -40,17 +46,49 @@ class STTFragment : Fragment() {
         val rootView = inflater.inflate(R.layout.fragment_sttframe, container, false)
         if (thisActivity is ChatActivity)
             thisActivity.fabsetting.hide()
-        promptSpeechInput()
         setupCommands(rootView)
         return rootView
     }
 
+    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
+
+        recognizer = SpeechRecognizer
+                .createSpeechRecognizer(activity?.applicationContext)
+
+        mainHandler.post(runnable)
+        if (!PrefManager.getBoolean(R.string.used_voice, true)) {
+            subHandler.postDelayed(delayRunnable, 1500)
+        }
+
+        super.onViewCreated(view, savedInstanceState)
+    }
+
+    private val runnable: Runnable = Runnable {
+        textToSpeech = TextToSpeech(requireContext(), TextToSpeech.OnInitListener { status ->
+            if (status != TextToSpeech.ERROR) {
+                val locale = textToSpeech?.language
+                textToSpeech?.language = locale
+                if (!PrefManager.getBoolean(R.string.used_voice, false)) {
+                    textToSpeech?.speak(getString(R.string.voice_welcome), TextToSpeech.QUEUE_FLUSH, null)
+                    PrefManager.putBoolean(R.string.used_voice, true)
+                } else {
+                    promptSpeechInput()
+                }
+            }
+        })
+    }
+
+    private val delayRunnable: Runnable = Runnable {
+        promptSpeechInput()
+    }
+
     private fun setupCommands(rootView: View) {
         var voiceCommand = getResources().getStringArray(R.array.voiceCommands)
         var voiceCommandsList = voiceCommand.toCollection(ArrayList())
         rootView.clickableCommands.layoutManager = LinearLayoutManager(activity, LinearLayoutManager.HORIZONTAL, false)
         rootView.clickableCommands.adapter = VoiceCommandsAdapter(voiceCommandsList, activity)
     }
+
     private fun promptSpeechInput() {
         val intent = Intent(RecognizerIntent.ACTION_RECOGNIZE_SPEECH)
         intent.putExtra(RecognizerIntent.EXTRA_LANGUAGE_MODEL,
@@ -62,8 +100,6 @@ class STTFragment : Fragment() {
         intent.putExtra(RecognizerIntent.EXTRA_SPEECH_INPUT_POSSIBLY_COMPLETE_SILENCE_LENGTH_MILLIS, 5000)
         intent.putExtra(RecognizerIntent.EXTRA_SPEECH_INPUT_COMPLETE_SILENCE_LENGTH_MILLIS, 5000)
 
-        recognizer = SpeechRecognizer
-                .createSpeechRecognizer(activity?.applicationContext)
         val listener = object : RecognitionListener {
             override fun onResults(results: Bundle) {
                 val voiceResults = results
@@ -145,7 +181,16 @@ class STTFragment : Fragment() {
             thisActivity.enableVoiceInput()
             thisActivity.fabsetting.show()
         }
+        if (textToSpeech != null) {
+            textToSpeech?.stop()
+        }
         recognizer.cancel()
         recognizer.destroy()
     }
+
+    override fun onDestroyView() {
+        super.onDestroyView()
+        mainHandler.removeCallbacks(runnable)
+        subHandler.removeCallbacks(delayRunnable)
+    }
 }

app/src/main/java/org/fossasia/susi/ai/login/WelcomeActivity.kt

@@ -48,6 +48,7 @@ class WelcomeActivity : AppCompatActivity() {
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
 
+        PrefManager.putBoolean(R.string.used_voice, false)
         if (PrefManager.getBoolean(R.string.activity_executed_key, false)) {
             val intent = Intent(this, LoginActivity::class.java)
             startActivity(intent)

app/src/main/res/values-de/strings.xml

@@ -28,6 +28,7 @@
     <string name="hotword_success">Hotword erkannt</string>
     <string name="custom_server">Benutzerdefinierter Server</string>
     <string name="settings_visit_website">Besuche die Website</string>
+    <string name="voice_welcome">Hallo! Womit kann ich Ihnen behilflich sein?</string>
 
     <string name="signup">Vielen dank für deine Registrierung</string>
     <string name="signup_msg">Wir haben eine E-Mail an die angegebene Adresse gesendet. Bitte benutzen Sie die

app/src/main/res/values-es/strings.xml

@@ -27,6 +27,7 @@
     <string name="hotword_success">Hotword detectado</string>
     <string name="custom_server">servidor personalizado</string>
     <string name="settings_visit_website">Visita la página web</string>
+    <string name="voice_welcome">¡Hola! ¿Como puedo ayudarte?</string>
 
     <string name="activity_executed_key" translatable="false">activity_executed</string>
     <string name="anonymous_logged_in_key" translatable="false">anonymous_logged_in</string>

app/src/main/res/values-hi/strings.xml

@@ -27,6 +27,7 @@
     <string name="dialog_retrieve_messages_title">पुराना संदेश पुनर्प्राप्त करना ...</string>
     <string name="hotword_success">हॉटवर्ड का पता चला</string>
     <string name="settings_visit_website">बेवसाइट देखना</string>
+    <string name="voice_welcome">नमस्ते! में आपकी कैसे मदद कर सकता हूं?</string>
 
     <string name="signup">साइन अप करने के लिए आभार</string>
     <string name="signup_msg">हमने आपके द्वारा प्रदान किए गए पते पर एक ईमेल भेजा है। कृपया का उपयोग करें

app/src/main/res/values-it/strings.xml

@@ -27,6 +27,7 @@
     <string name="hotword_success">Hotword rilevata</string>
     <string name="custom_server">server personalizzato</string>
     <string name="settings_visit_website">Visita il sito web</string>
+    <string name="voice_welcome">Ciao! Come posso aiutarla?</string>
 
     <string name="email_not_registered">L\'email che hai inserito non è registrata con noi. Per favore riprova.</string>
     <string name="email_not_registered_title">registrazione email</string>

app/src/main/res/values-ml-rIN/strings.xml

@@ -320,6 +320,7 @@
     <string name="accept_terms_and_conditions">സൈൻ അപ് ചെയ്യുന്നതിന് നിങ്ങൾ നിബന്ധനകളും വ്യവസ്ഥകളും അംഗീകരിക്കണം</string>
     <string name="accept_terms_conditions">നിബന്ധനകളും വ്യവസ്ഥകളും ഞാൻ അംഗീകരിക്കുന്നു</string>
     <string name="settings_visit_website">വെബ്സൈറ്റ് സന്ദർശിക്കുക</string>
+    <string name="voice_welcome">ഹായ്! എനിക്ക് നിങ്ങളെ എങ്ങനെ സഹായിക്കാനാകും?</string>
     <string name="error_skipping_signUp_process_text">ഇത് സൈൻ അപ്പ് പ്രോസസ്സ് റദ്ദാക്കുകയും ചാറ്റ് പേജിലേക്ക് നിങ്ങളെ റീഡയറക്ട് ചെയ്യുകയും ചെയ്യും.</string>
     <string name="dialog_skip_sign_up">സൈൻ അപ് ചെയ്യണോ?</string>
     <string name="settings_help">உதவி</string>

app/src/main/res/values-pt-rBR/strings.xml

@@ -26,6 +26,7 @@
     <string name="hotword_success">Hotword detectada</string>
     <string name="custom_server">servidor customizado</string>
     <string name="settings_visit_website">Visite o site</string>
+    <string name="voice_welcome">Oi! Como posso ajudá-lo?</string>
 
     <string name="signup">Obrigado pelo seu registro</string>
     <string name="signup_msg">Enviamos um email para o endereço fornecido. Por favor use o

app/src/main/res/values-ta-rIN/strings.xml

@@ -318,6 +318,7 @@
     <string name="accept_terms_and_conditions">பதிவு செய்ய நீங்கள் விதிமுறைகள் மற்றும் நிபந்தனைகளை ஏற்க வேண்டும்</string>
     <string name="accept_terms_conditions">நான் நியதிகளும் நிபந்தனைகள் ஒத்துகொள்கிறேன்</string>
     <string name="settings_visit_website">வலைத்தளத்தைப் பார்வையிடவும்</string>
+    <string name="voice_welcome">வணக்கம்! நான் எப்படி உங்களுக்கு உதவ முடியும்?</string>
     <string name="error_skipping_signUp_process_text">இது உள்நுழைவு செயல்முறையை ரத்துசெய்து, அரட்டை பக்கத்திற்கு உங்களை திருப்பி விடுகிறது.</string>
     <string name="dialog_skip_sign_up">உள்நுழையவும்?</string>
     <string name="settings_help">സഹായിക്കൂ</string>

app/src/main/res/values/strings.xml

@@ -10,6 +10,8 @@
     <string name="action_settings">Settings</string>
     <string name="action_share">Share</string>
     <string name="action_wall_settings">Wallpaper</string>
+    <string name="used_voice" translatable="false">Used Voice before?</string>
+    <string name="voice_welcome">Hi! How can I help you?</string>
 
     <string name="background_no_wall">no_wall</string>