bug fixes, translation fixes

sfortis · sfortis · commit 847abc598856 · 2025-05-13T10:00:52.000+03:00
diff --git a/custom_components/openai_tts/config_flow.py b/custom_components/openai_tts/config_flow.py
@@ -30,6 +30,7 @@
     CONF_NORMALIZE_AUDIO,
     CONF_INSTRUCTIONS,
     CONF_VOLUME_RESTORE,
+    CONF_PAUSE_PLAYBACK,
 )
 
 _LOGGER = logging.getLogger(__name__)
@@ -119,40 +120,51 @@ async def async_step_user(self, user_input: dict[str, Any] | None = None):
 
     @staticmethod
     def async_get_options_flow(config_entry):
-        return OpenAITTSOptionsFlow()
+        return OpenAITTSOptionsFlow(config_entry)
 
 class OpenAITTSOptionsFlow(OptionsFlow):
     """Handle options flow for OpenAI TTS."""
+    
+    def __init__(self, config_entry):
+        """Initialize options flow."""
+        self._config_entry = config_entry
+    
     async def async_step_init(self, user_input: dict | None = None):
         if user_input is not None:
             return self.async_create_entry(title="", data=user_input)
 
         chime_opts = await self.hass.async_add_executor_job(get_chime_options)
         options_schema = vol.Schema({
             vol.Optional(
-                CONF_CHIME_ENABLE,
-                default=self.config_entry.options.get(CONF_CHIME_ENABLE, self.config_entry.data.get(CONF_CHIME_ENABLE, False)),
+                "chime",  # Use strings directly here, not constants
+                default=self._config_entry.options.get(CONF_CHIME_ENABLE, self._config_entry.data.get(CONF_CHIME_ENABLE, False)),
             ): selector({"boolean": {}}),
 
             vol.Optional(
-                CONF_CHIME_SOUND,
-                default=self.config_entry.options.get(CONF_CHIME_SOUND, self.config_entry.data.get(CONF_CHIME_SOUND, "threetone.mp3")),
+                "chime_sound",  # Use strings directly
+                default=self._config_entry.options.get(CONF_CHIME_SOUND, self._config_entry.data.get(CONF_CHIME_SOUND, "threetone.mp3")),
             ): selector({"select": {"options": chime_opts}}),
 
             vol.Optional(
-                CONF_NORMALIZE_AUDIO,
-                default=self.config_entry.options.get(CONF_NORMALIZE_AUDIO, self.config_entry.data.get(CONF_NORMALIZE_AUDIO, False)),
+                "normalize_audio",  # Use strings directly
+                default=self._config_entry.options.get(CONF_NORMALIZE_AUDIO, self._config_entry.data.get(CONF_NORMALIZE_AUDIO, False)),
             ): selector({"boolean": {}}),
 
             vol.Optional(
-                CONF_INSTRUCTIONS,
-                default=self.config_entry.options.get(CONF_INSTRUCTIONS, self.config_entry.data.get(CONF_INSTRUCTIONS, "")),
+                "instructions",  # Use strings directly
+                default=self._config_entry.options.get(CONF_INSTRUCTIONS, self._config_entry.data.get(CONF_INSTRUCTIONS, "")),
             ): TextSelector(TextSelectorConfig(type=TextSelectorType.TEXT, multiline=True)),
 
             vol.Optional(
-                CONF_VOLUME_RESTORE,
-                default=self.config_entry.options.get(CONF_VOLUME_RESTORE, self.config_entry.data.get(CONF_VOLUME_RESTORE, False)),
+                "volume_restore",  # Use strings directly
+                default=self._config_entry.options.get(CONF_VOLUME_RESTORE, self._config_entry.data.get(CONF_VOLUME_RESTORE, False)),
+            ): selector({"boolean": {}}),
+            
+            # Use string directly for pause_playback
+            vol.Optional(
+                "pause_playback",  # Must match exactly with translation key
+                default=self._config_entry.options.get(CONF_PAUSE_PLAYBACK, self._config_entry.data.get(CONF_PAUSE_PLAYBACK, False)),
             ): selector({"boolean": {}}),
         })
 
-        return self.async_show_form(step_id="init", data_schema=options_schema)
+        return self.async_show_form(step_id="init", data_schema=options_schema)
diff --git a/custom_components/openai_tts/const.py b/custom_components/openai_tts/const.py
@@ -21,5 +21,5 @@
 # Toggle to snapshot & restore volumes
 CONF_VOLUME_RESTORE = "volume_restore"
 
-# NEW: Toggle to pause/resume media playback
-CONF_PAUSE_PLAYBACK = "pause_playback"
+# Toggle to pause/resume media playback
+CONF_PAUSE_PLAYBACK = "pause_playback"
diff --git a/custom_components/openai_tts/manifest.json b/custom_components/openai_tts/manifest.json
@@ -10,5 +10,5 @@
   "iot_class": "cloud_polling",
   "issue_tracker": "https://github.com/sfortis/openai_tts/issues",
   "requirements": [],
-  "version": "3.4b0"
+  "version": "3.4b1"
 }
diff --git a/custom_components/openai_tts/services.yaml b/custom_components/openai_tts/services.yaml
@@ -68,7 +68,7 @@ say:
           mode: slider
     pause_playback:
       name: Pause Playback
-      description: Pause any currently playing media (only works with Sonos speakers).
+      description: Pause any currently playing media during announcement (only works with Sonos speakers).
       required: false
       default: false
       selector:
diff --git a/custom_components/openai_tts/strings.json b/custom_components/openai_tts/strings.json
@@ -29,9 +29,10 @@
           "voice": "Voice",
           "instructions": "Instructions (check https://www.openai.fm/ )",
           "normalize_audio": "Enable loudness for generated audio (uses more CPU)",
-          "volume_restore": "Restore speaker volumes after TTS playback"
+          "volume_restore": "Restore speaker volumes after TTS playback",
+          "pause_playback": "Pause media during TTS (Sonos only)"
         }
       }
     }
   }
-}
+}
diff --git a/custom_components/openai_tts/translations/cs.json b/custom_components/openai_tts/translations/cs.json
@@ -25,10 +25,14 @@
           "chime": "Povolte zvukový signál před řečí (užitečné pro oznámení)",
           "chime_sound": "Zvuk zvukového signálu",
           "speed": "Rychlost (0,25 až 4,0)",
+          "model": "Model",
           "voice": "Hlas",
-          "normalize_audio": "Povolte zvýšení hlasitosti generovaného audia (vyžaduje více CPU)"
+          "instructions": "Pokyny (viz https://www.openai.fm/)",
+          "normalize_audio": "Povolte zvýšení hlasitosti generovaného audia (vyžaduje více CPU)",
+          "volume_restore": "Obnovit hlasitost reproduktorů po přehrávání TTS",
+          "pause_playback": "Pozastavit přehrávání médií během TTS (pouze Sonos)"
         }
       }
     }
   }
-}
+}
diff --git a/custom_components/openai_tts/translations/de.json b/custom_components/openai_tts/translations/de.json
@@ -25,10 +25,14 @@
           "chime": "Aktivieren Sie den Signalton vor der Sprache (nützlich für Ansagen)",
           "chime_sound": "Signalton",
           "speed": "Geschwindigkeit (0,25 bis 4,0)",
+          "model": "Modell",
           "voice": "Stimme",
-          "normalize_audio": "Aktivieren Sie die Lautstärkeerhöhung für das erzeugte Audio (verwendet mehr CPU)"
+          "instructions": "Anweisungen (siehe https://www.openai.fm/)",
+          "normalize_audio": "Aktivieren Sie die Lautstärkeerhöhung für das erzeugte Audio (verwendet mehr CPU)",
+          "volume_restore": "Lautstärke der Lautsprecher nach der TTS-Wiedergabe wiederherstellen",
+          "pause_playback": "Medienwiedergabe während TTS pausieren (nur Sonos)"
         }
       }
     }
   }
-}
+}
diff --git a/custom_components/openai_tts/translations/el.json b/custom_components/openai_tts/translations/el.json
@@ -9,7 +9,7 @@
           "speed": "Ταχύτητα (0.25 έως 4.0, όπου το 1.0 είναι προεπιλογή)",
           "model": "Μοντέλο",
           "voice": "Φωνή",
-          "url": "Εισάγετε ένα endpoint συμβατό με OpenAI (προαιρετικά συμπεριλάβετε αριθμό θύρας)."
+          "url": "Εισάγετε ένα endpoint συμβατό με OpenAI (προαιρετικά συμπεριλάβετε την πόρτα)."
         }
       }
     },
@@ -22,13 +22,17 @@
       "init": {
         "title": "Διαμορφώστε τις επιλογές TTS",
         "data": {
-          "chime": "Ενεργοποιήστε τον ήχο του ηχητικού σήματος πριν από την ομιλία (χρήσιμο για ανακοινώσεις)",
-          "chime_sound": "Ήχος ηχητικού σήματος",
+          "chime": "Ενεργοποιήστε τον ηχο ανακοινωσεων πριν από την ομιλία",
+          "chime_sound": "Ήχος ανακοινώσεων",
           "speed": "Ταχύτητα (0.25 έως 4.0)",
+          "model": "Μοντέλο",
           "voice": "Φωνή",
-          "normalize_audio": "Ενεργοποιήστε την αύξηση της έντασης για τον παραγόμενο ήχο (χρησιμοποιεί περισσότερη CPU)"
+          "instructions": "Οδηγίες (δείτε https://www.openai.fm/)",
+          "normalize_audio": "Ενεργοποιήστε την αύξηση της έντασης για τον παραγόμενο ήχο (χρησιμοποιεί περισσότερη CPU)",
+          "volume_restore": "Επαναφορά έντασης μετά την αναπαραγωγή TTS",
+          "pause_playback": "Παύση πολυμέσων κατά τη διάρκεια TTS (μόνο για Sonos)"
         }
       }
     }
   }
-}
+}
diff --git a/custom_components/openai_tts/translations/en.json b/custom_components/openai_tts/translations/en.json
@@ -29,7 +29,8 @@
           "voice": "Voice",
           "instructions": "Instructions",
           "normalize_audio": "Enable loudness for generated audio (uses more CPU)",
-          "volume_restore": "Restore speaker volumes after TTS playback"
+          "volume_restore": "Restore speaker volumes after TTS playback",
+          "pause_playback": "Pause media during TTS (Sonos only)"
         }
       }
     }
diff --git a/custom_components/openai_tts/tts.py b/custom_components/openai_tts/tts.py
@@ -15,6 +15,8 @@
 from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity_platform import AddEntitiesCallback
 from homeassistant.helpers.entity import generate_entity_id
+from homeassistant.helpers.restore_state import RestoreEntity
+
 from .const import (
     CONF_API_KEY,
     CONF_MODEL,
@@ -73,7 +75,7 @@ async def async_setup_entry(
     async_add_entities([OpenAITTSEntity(hass, config_entry, engine)])
 
 
-class OpenAITTSEntity(TextToSpeechEntity):
+class OpenAITTSEntity(TextToSpeechEntity, RestoreEntity):
     _attr_has_entity_name = True
     _attr_should_poll = False
 
@@ -93,6 +95,41 @@ def __init__(self, hass: HomeAssistant, config: ConfigEntry, engine: OpenAITTSEn
         self._last_total_time = None
         self._last_media_duration_ms = None  # Store in milliseconds
 
+    async def async_added_to_hass(self) -> None:
+        """When entity is added to hass, restore previous state."""
+        await super().async_added_to_hass()
+        
+        # Restore previous state if it exists
+        last_state = await self.async_get_last_state()
+        
+        if last_state is not None and last_state.attributes:
+            # Restore from attributes
+            self._engine_active = last_state.attributes.get("engine_active", False)
+            
+            # Restore time values
+            api_time_str = last_state.attributes.get("last_api_time")
+            if api_time_str and " msec" in api_time_str:
+                self._last_api_time = int(api_time_str.replace(" msec", ""))
+            
+            ffmpeg_time_str = last_state.attributes.get("last_ffmpeg_time")
+            if ffmpeg_time_str and " msec" in ffmpeg_time_str:
+                self._last_ffmpeg_time = int(ffmpeg_time_str.replace(" msec", ""))
+            
+            total_time_str = last_state.attributes.get("last_total_time")
+            if total_time_str and " msec" in total_time_str:
+                self._last_total_time = int(total_time_str.replace(" msec", ""))
+            
+            # Restore media duration directly (stored as raw milliseconds)
+            self._last_media_duration_ms = last_state.attributes.get("media_duration")
+            
+            _LOGGER.debug(
+                "Restored OpenAI TTS entity state: api_time=%s, ffmpeg_time=%s, total_time=%s, media_duration=%s", 
+                self._last_api_time, 
+                self._last_ffmpeg_time, 
+                self._last_total_time,
+                self._last_media_duration_ms
+            )
+
     @property
     def default_language(self) -> str:
         return "en"
@@ -266,6 +303,10 @@ def get_tts_audio(
                 # Compute media duration in milliseconds before cleaning up.
                 duration_seconds = get_media_duration(merged_output_path)
                 self._last_media_duration_ms = int(duration_seconds * 1000)
+                
+                # DO NOT call self.async_write_ha_state() here - thread safety issue
+                # It will be called from the async_get_tts_audio method
+                
                 # Cleanup temporary files.
                 try:
                     os.remove(tts_path)
@@ -306,6 +347,10 @@ def get_tts_audio(
                     # Compute media duration in milliseconds for the normalized file.
                     duration_seconds = get_media_duration(norm_output_path)
                     self._last_media_duration_ms = int(duration_seconds * 1000)
+                    
+                    # DO NOT call self.async_write_ha_state() here - thread safety issue
+                    # It will be called from the async_get_tts_audio method
+                    
                     try:
                         os.remove(norm_input_path)
                         os.remove(norm_output_path)
@@ -328,6 +373,10 @@ def get_tts_audio(
                     _LOGGER.debug("Overall TTS processing time: %.2f ms", overall_duration)
                     self._last_total_time = overall_duration
                     self._last_ffmpeg_time = 0  # No ffmpeg processing used.
+                    
+                    # DO NOT call self.async_write_ha_state() here - thread safety issue
+                    # It will be called from the async_get_tts_audio method
+                    
                     return "mp3", audio_content
 
         except CancelledError as ce:
@@ -347,11 +396,17 @@ async def async_get_tts_audio(
         try:
             self._engine_active = True
             self.async_write_ha_state()
-            return await asyncio.shield(
+            
+            result = await asyncio.shield(
                 self.hass.async_add_executor_job(
                     partial(self.get_tts_audio, message, language, options=options)
                 )
             )
+            
+            # Update the entity state from within the event loop
+            self.async_write_ha_state()
+            
+            return result
         except asyncio.CancelledError:
             _LOGGER.exception("async_get_tts_audio cancelled")
             raise
diff --git a/custom_components/openai_tts/volume_restore.py b/custom_components/openai_tts/volume_restore.py

Original file line number	Diff line number	Diff line change
`@@ -10,5 +10,5 @@`
`10`	`10`	`"iot_class": "cloud_polling",`
`11`	`11`	`"issue_tracker": "https://github.com/sfortis/openai_tts/issues",`
`12`	`12`	`"requirements": [],`
`13`		`- "version": "3.4b0"`
	`13`	`+ "version": "3.4b1"`
`14`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,9 +29,10 @@`
`29`	`29`	`"voice": "Voice",`
`30`	`30`	`"instructions": "Instructions (check https://www.openai.fm/ )",`
`31`	`31`	`"normalize_audio": "Enable loudness for generated audio (uses more CPU)",`
`32`		`- "volume_restore": "Restore speaker volumes after TTS playback"`
	`32`	`+ "volume_restore": "Restore speaker volumes after TTS playback",`
	`33`	`+ "pause_playback": "Pause media during TTS (Sonos only)"`
`33`	`34`	`}`
`34`	`35`	`}`
`35`	`36`	`}`
`36`	`37`	`}`
`37`		`-}`
	`38`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -25,10 +25,14 @@`
`25`	`25`	`"chime": "Povolte zvukový signál před řečí (užitečné pro oznámení)",`
`26`	`26`	`"chime_sound": "Zvuk zvukového signálu",`
`27`	`27`	`"speed": "Rychlost (0,25 až 4,0)",`
	`28`	`+ "model": "Model",`
`28`	`29`	`"voice": "Hlas",`
`29`		`- "normalize_audio": "Povolte zvýšení hlasitosti generovaného audia (vyžaduje více CPU)"`
	`30`	`+ "instructions": "Pokyny (viz https://www.openai.fm/)",`
	`31`	`+ "normalize_audio": "Povolte zvýšení hlasitosti generovaného audia (vyžaduje více CPU)",`
	`32`	`+ "volume_restore": "Obnovit hlasitost reproduktorů po přehrávání TTS",`
	`33`	`+ "pause_playback": "Pozastavit přehrávání médií během TTS (pouze Sonos)"`
`30`	`34`	`}`
`31`	`35`	`}`
`32`	`36`	`}`
`33`	`37`	`}`
`34`		`-}`
	`38`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`"speed": "Ταχύτητα (0.25 έως 4.0, όπου το 1.0 είναι προεπιλογή)",`
`10`	`10`	`"model": "Μοντέλο",`
`11`	`11`	`"voice": "Φωνή",`
`12`		`- "url": "Εισάγετε ένα endpoint συμβατό με OpenAI (προαιρετικά συμπεριλάβετε αριθμό θύρας)."`
	`12`	`+ "url": "Εισάγετε ένα endpoint συμβατό με OpenAI (προαιρετικά συμπεριλάβετε την πόρτα)."`
`13`	`13`	`}`
`14`	`14`	`}`
`15`	`15`	`},`
`@@ -22,13 +22,17 @@`
`22`	`22`	`"init": {`
`23`	`23`	`"title": "Διαμορφώστε τις επιλογές TTS",`
`24`	`24`	`"data": {`
`25`		`- "chime": "Ενεργοποιήστε τον ήχο του ηχητικού σήματος πριν από την ομιλία (χρήσιμο για ανακοινώσεις)",`
`26`		`- "chime_sound": "Ήχος ηχητικού σήματος",`
	`25`	`+ "chime": "Ενεργοποιήστε τον ηχο ανακοινωσεων πριν από την ομιλία",`
	`26`	`+ "chime_sound": "Ήχος ανακοινώσεων",`
`27`	`27`	`"speed": "Ταχύτητα (0.25 έως 4.0)",`
	`28`	`+ "model": "Μοντέλο",`
`28`	`29`	`"voice": "Φωνή",`
`29`		`- "normalize_audio": "Ενεργοποιήστε την αύξηση της έντασης για τον παραγόμενο ήχο (χρησιμοποιεί περισσότερη CPU)"`
	`30`	`+ "instructions": "Οδηγίες (δείτε https://www.openai.fm/)",`
	`31`	`+ "normalize_audio": "Ενεργοποιήστε την αύξηση της έντασης για τον παραγόμενο ήχο (χρησιμοποιεί περισσότερη CPU)",`
	`32`	`+ "volume_restore": "Επαναφορά έντασης μετά την αναπαραγωγή TTS",`
	`33`	`+ "pause_playback": "Παύση πολυμέσων κατά τη διάρκεια TTS (μόνο για Sonos)"`
`30`	`34`	`}`
`31`	`35`	`}`
`32`	`36`	`}`
`33`	`37`	`}`
`34`		`-}`
	`38`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,8 @@`
`29`	`29`	`"voice": "Voice",`
`30`	`30`	`"instructions": "Instructions",`
`31`	`31`	`"normalize_audio": "Enable loudness for generated audio (uses more CPU)",`
`32`		`- "volume_restore": "Restore speaker volumes after TTS playback"`
	`32`	`+ "volume_restore": "Restore speaker volumes after TTS playback",`
	`33`	`+ "pause_playback": "Pause media during TTS (Sonos only)"`
`33`	`34`	`}`
`34`	`35`	`}`
`35`	`36`	`}`