Merge pull request #1317 from heropj/feat/speed-control-for-tts

Feat: Added speed control option for Text-to-Speech module

Author: kelson42

resources/i18n/en.json

@@ -185,5 +185,8 @@
     "select-read-voice": "Select reading voice",
     "select-read-language": "Select reading language",
     "save-or-open": "Save or Open file",
-    "save-or-open-text": "What should Kiwix do with this file?"
+    "save-or-open-text": "What should Kiwix do with this file?",
+    "speed": "Speed",
+    "increase-tts-speed": "Increase TTS speed.",
+    "decrease-tts-speed": "Decrease TTS speed."
 }

resources/i18n/qqq.json

@@ -192,5 +192,8 @@
 	"select-read-voice": "Represents the action of opening the voice selection for text-to-speech.",
 	"select-read-language": "Represents the action of opening the language selection for text-to-speech.",
 	"save-or-open": "Title of the message box allowing to choose whether a remote resource should be saved to disk or opened with a respective application",
-	"save-or-open-text": "Text of the message box allowing to choose whether a remote resource should be saved to disk or opened with a respective application"
+	"save-or-open-text": "Text of the message box allowing to choose whether a remote resource should be saved to disk or opened with a respective application",
+	"speed": "Label for text-to-speech speed adjustment control.",
+	"increase-tts-speed": "Represents the action of increasing the speed of the text-to-speech.",
+	"decrease-tts-speed": "Represents the action of decreasing the speed of the text-to-speech."
 }

src/kiwixapp.cpp

@@ -406,6 +406,8 @@ void KiwixApp::createActions()
     CREATE_ACTION_SHORTCUT(ReadStopAction, gt("read-stop"), QKeySequence(Qt::ALT | Qt::SHIFT | Qt::Key_X));
     CREATE_ACTION_SHORTCUT(ToggleTTSLanguageAction, gt("select-read-language"), QKeySequence(Qt::ALT | Qt::SHIFT | Qt::Key_L));
     CREATE_ACTION_SHORTCUT(ToggleTTSVoiceAction, gt("select-read-voice"), QKeySequence(Qt::ALT | Qt::SHIFT | Qt::Key_V));
+    CREATE_ACTION_SHORTCUT(IncreaseTTSSpeedAction, gt("increase-tts-speed"), QKeySequence(Qt::Key_Greater));
+    CREATE_ACTION_SHORTCUT(DecreaseTTSSpeedAction, gt("decrease-tts-speed"), QKeySequence(Qt::Key_Less));
     mpa_actions[ToggleTTSLanguageAction]->setCheckable(true);
     mpa_actions[ToggleTTSVoiceAction]->setCheckable(true);
 
@@ -562,6 +564,11 @@ void KiwixApp::saveVoiceName(const QString& langName, const QString& voiceName)
   mp_session->setValue("voice/" + langName, voiceName);
 }
 
+void KiwixApp::saveTtsSpeed(const QString& langName, double speed)
+{
+    mp_session->setValue("speed/" + langName, speed);
+}
+
 void KiwixApp::restoreWindowState()
 {
   getMainWindow()->restoreGeometry(mp_session->value("geometry").toByteArray());
@@ -583,6 +590,11 @@ QString KiwixApp::getSavedVoiceName(const QString& langName) const
   return mp_session->value("voice/" + langName, "").toString();
 }
 
+double KiwixApp::getSavedTtsSpeed(const QString& langName) const
+{
+    return mp_session->value("speed/" + langName, 1.0).toDouble(); // Default: 1.0 (normal speed)
+}
+
 QString KiwixApp::getPrevSaveDir() const
 {
   QString prevSaveDir = mp_session->value("prevSaveDir", DEFAULT_SAVE_DIR).toString();

src/kiwixapp.h

@@ -50,6 +50,8 @@ class KiwixApp : public QtSingleApplication
         ToggleAddBookmarkAction,
         ToggleTTSLanguageAction,
         ToggleTTSVoiceAction,
+        IncreaseTTSSpeedAction,
+        DecreaseTTSSpeedAction,
         ZoomInAction,
         ZoomOutAction,
         ZoomResetAction,
@@ -101,10 +103,12 @@ class KiwixApp : public QtSingleApplication
     void saveListOfOpenTabs();
     void saveWindowState();
     void saveVoiceName(const QString& langName, const QString& voiceName);
+    void saveTtsSpeed(const QString& langName, double speed);
     void restoreWindowState();
     void saveCurrentTabIndex();
     void savePrevSaveDir(const QString& prevSaveDir);
     QString getSavedVoiceName(const QString& langName) const;
+    double getSavedTtsSpeed(const QString& langName) const;
     QString getPrevSaveDir() const;
     void restoreTabs();
     void setupDirectoryMonitoring();

src/mainmenu.cpp

@@ -49,6 +49,8 @@ MainMenu::MainMenu(QWidget *parent) :
     m_viewMenu.ADD_ACTION(ToggleReadingListAction);
     m_viewMenu.ADD_ACTION(ToggleTTSLanguageAction);
     m_viewMenu.ADD_ACTION(ToggleTTSVoiceAction);
+    m_viewMenu.ADD_ACTION(IncreaseTTSSpeedAction);
+    m_viewMenu.ADD_ACTION(DecreaseTTSSpeedAction);
     m_viewMenu.ADD_ACTION(ZoomInAction);
     m_viewMenu.ADD_ACTION(ZoomOutAction);
     m_viewMenu.ADD_ACTION(ZoomResetAction);

src/texttospeechbar.cpp

@@ -21,13 +21,36 @@ TextToSpeechBar::TextToSpeechBar(QWidget *parent)
     connect(ui->closeButton, &QPushButton::pressed,
                 this, &TextToSpeechBar::speechClose);
 
+    setupSpeedOptionsComboBox();
     setupVoiceComboBox();
     setupLanguageComboBox();
     languageSelected(ui->langComboBox->currentIndex());
     connect(app->getAction(KiwixApp::ToggleTTSLanguageAction), &QAction::triggered,
             this, &TextToSpeechBar::toggleLanguage);
     connect(app->getAction(KiwixApp::ToggleTTSVoiceAction), &QAction::triggered,
             this, &TextToSpeechBar::toggleVoice);
+    connect(app->getAction(KiwixApp::IncreaseTTSSpeedAction), &QAction::triggered,
+            this, &TextToSpeechBar::increaseSpeed);
+    connect(app->getAction(KiwixApp::DecreaseTTSSpeedAction), &QAction::triggered,
+            this, &TextToSpeechBar::decreaseSpeed);
+    connect(ui->speedComboBox, QOverload<int>::of(&QComboBox::currentIndexChanged),
+            this, &TextToSpeechBar::onSpeedChanged);
+}
+
+void TextToSpeechBar::increaseSpeed()
+{
+    int currentIndex = ui->speedComboBox->currentIndex();
+    if (currentIndex < ui->speedComboBox->count() - 1) {
+        ui->speedComboBox->setCurrentIndex(currentIndex + 1);
+    }
+}
+
+void TextToSpeechBar::decreaseSpeed()
+{
+    int currentIndex = ui->speedComboBox->currentIndex();
+    if (currentIndex > 0) {
+        ui->speedComboBox->setCurrentIndex(currentIndex - 1);
+    }
 }
 
 void TextToSpeechBar::speak(const QString &text)
@@ -54,6 +77,16 @@ void TextToSpeechBar::setLocale(const QLocale& locale)
     }
 }
 
+void TextToSpeechBar::setupSpeedOptionsComboBox()
+{
+    ui->speedLabel->setText(gt("speed"));
+    ui->speedComboBox->setMaxVisibleItems(10);
+    ui->speedComboBox->setLineEdit(new ComboBoxLineEdit(ui->speedComboBox));
+
+    QStringList speedOptions = {"0.25","0.50","0.75","1.00","1.25","1.50","1.75","2.00"};
+    ui->speedComboBox->addItems(speedOptions);
+}
+
 void TextToSpeechBar::setupLanguageComboBox()
 {
     ui->langLabel->setText(gt("language"));
@@ -107,6 +140,13 @@ void TextToSpeechBar::resetVoiceComboBox()
     connect(ui->voiceComboBox, QOverload<int>::of(&QComboBox::currentIndexChanged), this, &TextToSpeechBar::voiceSelected);
 }
 
+void TextToSpeechBar::resetSpeedComboBox()
+{
+    double savedSpeed = KiwixApp::instance()->getSavedTtsSpeed(m_speech.locale().name());
+    int index = (savedSpeed - 0.25) * 4;
+    ui->speedComboBox->setCurrentIndex(index);
+}
+
 int TextToSpeechBar::getVoiceIndex()
 {
     int voiceIndex = 0;
@@ -174,6 +214,7 @@ void TextToSpeechBar::languageSelected(int index)
     const QLocale locale = ui->langComboBox->itemData(index).toLocale();
     m_speech.setLocale(locale);
     resetVoiceComboBox();
+    resetSpeedComboBox();
 }
 
 void TextToSpeechBar::voiceSelected(int index)
@@ -203,6 +244,24 @@ void TextToSpeechBar::onStateChanged(QTextToSpeech::State state)
     ui->stopButton->setEnabled(state != QTextToSpeech::Ready);
 }
 
+void TextToSpeechBar::onSpeedChanged(int index)
+{
+    QString speedText = ui->speedComboBox->itemText(index);
+    double speed = speedText.toDouble();
+    m_speech.setRate(speed - 1);  // range:-1,1
+
+    // Save tts speed for current lang
+    const auto currentLang = ui->langComboBox->currentData().toLocale().name();
+    KiwixApp::instance()->saveTtsSpeed(currentLang, speed);
+
+    // Restarting the speech with new speed set above
+    if (m_speech.state() == QTextToSpeech::Speaking)
+    {
+        m_speech.stop();
+        m_speech.say(m_text);
+    }
+}
+
 ComboBoxLineEdit::ComboBoxLineEdit(QWidget *parent) : QLineEdit(parent)
 {
     setFrame(false);

src/texttospeechbar.h

@@ -35,6 +35,8 @@ class TextToSpeechBar : public QFrame
     void setupLanguageComboBox();
     void setupVoiceComboBox();
     void resetVoiceComboBox();
+    void setupSpeedOptionsComboBox();
+    void resetSpeedComboBox();
 
     int getVoiceIndex();
 
@@ -46,6 +48,9 @@ public slots:
     void toggleLanguage();
     void languageSelected(int index);
     void voiceSelected(int index);
+    void onSpeedChanged(int index);
+    void increaseSpeed();
+    void decreaseSpeed();
 
 protected:
     void keyPressEvent(QKeyEvent *event);

src/texttospeechbar.ui

@@ -51,6 +51,20 @@
      </property>
     </widget>
    </item>
+   <item>
+    <widget class="QLabel" name="speedLabel">
+     <property name="text">
+      <string>Speed</string>
+     </property>
+    </widget>
+   </item>
+   <item>
+    <widget class="QComboBox" name="speedComboBox">
+     <property name="editable">
+      <bool>false</bool>
+     </property>
+    </widget>
+   </item>
    <item>
     <spacer name="horizontalSpacer_2">
      <property name="orientation">