Files
pipelines/app/lib/features/settings/settings_read_aloud_section.dart
T
alan 3164b7c8df Prefer natural voices for read aloud
Rank platform voice quality and select the most natural automatic voice while keeping explicit voice choices intact. Surface natural labels, hide novelty voices in the picker, and guide Apple users to download enhanced voices when needed.
2026-11-13 15:59:35 +00:00

172 lines
5.8 KiB
Dart
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import 'dart:async';
import 'package:flutter/material.dart';
import '../chat/speech/speech.dart';
import 'settings_group.dart';
import 'settings_row.dart';
import 'settings_theme.dart';
import 'settings_voice_picker.dart';
/// Read aloud: the voice and speaking rate replies are read with, saved on
/// this device, with a sample and a reset to the system voice at normal speed.
class SettingsReadAloudSection extends StatefulWidget {
const SettingsReadAloudSection({super.key, this.controller});
/// The reader; the app's own by default.
final SpeechController? controller;
@override
State<SettingsReadAloudSection> createState() =>
_SettingsReadAloudSectionState();
}
class _SettingsReadAloudSectionState extends State<SettingsReadAloudSection> {
SpeechController get _speech => widget.controller ?? speechController;
late final Future<List<SpeechVoice>> _voices;
@override
void initState() {
super.initState();
unawaited(_speech.restore());
_voices = _speech.voices();
}
Future<void> _pickVoice() async {
final choice = await showSpeechVoicePicker(context, _speech);
if (choice != null) await _speech.setVoice(choice.voice);
}
@override
Widget build(BuildContext context) => ListenableBuilder(
listenable: _speech,
builder: (context, _) {
final rate = _speech.rate;
final label = '${rate.toStringAsFixed(1)}×';
final voice = _speech.voice;
final sampling = _speech.messageId == speechSampleId;
return SettingsGroup(
title: 'Read aloud',
footer: Column(
crossAxisAlignment: CrossAxisAlignment.stretch,
children: [
const Text(
'Saved on this device. Replies are read with this voice and rate.',
),
if (_speech.saveFailed)
Text(
'Could not save; applies until reload.',
style: TextStyle(color: settingsErrorColor(context)),
),
],
),
children: [
SettingsRow(
key: const Key('settings-read-aloud-voice'),
leading: const Icon(Icons.record_voice_over_outlined),
title: const Text('Voice'),
subtitle: Text(
voice == null
? 'Automatic (most natural)'
: '${voice.name} · ${voice.locale}',
),
chevron: true,
onTap: () => unawaited(_pickVoice()),
),
_voiceDownloadHint(context),
SettingsGroupItem(
child: Column(
crossAxisAlignment: CrossAxisAlignment.stretch,
children: [
Text(
'Speaking rate $label',
style: settingsTextStyle(context, title: true),
),
Semantics(
label: 'Speaking rate',
child: Slider(
key: const Key('settings-read-aloud-rate'),
value: rate,
min: minSpeechRate,
max: maxSpeechRate,
divisions: 15,
label: label,
semanticFormatterCallback: (value) =>
'${value.toStringAsFixed(1)} times',
onChanged: (value) =>
unawaited(_speech.setRate(value, save: false)),
onChangeEnd: (value) => unawaited(_speech.setRate(value)),
),
),
const Wrap(
alignment: WrapAlignment.spaceBetween,
children: [Text('0.5× · Slower'), Text('2.0× · Faster')],
),
],
),
),
SettingsGroupItem(
child: Wrap(
spacing: 8,
runSpacing: 8,
crossAxisAlignment: WrapCrossAlignment.center,
children: [
FilledButton.tonalIcon(
key: const Key('settings-read-aloud-sample'),
onPressed: () =>
unawaited(sampling ? _speech.stop() : _speech.sample()),
icon: Icon(
sampling ? Icons.stop_outlined : Icons.play_arrow_outlined,
),
label: Text(sampling ? 'Stop sample' : 'Play sample'),
),
TextButton(
key: const Key('settings-read-aloud-reset'),
onPressed: _speech.isDefault
? null
: () => unawaited(_speech.reset()),
child: const Text('Reset to defaults'),
),
],
),
),
],
);
},
);
Widget _voiceDownloadHint(BuildContext context) {
return FutureBuilder<List<SpeechVoice>>(
future: _voices,
builder: (context, snapshot) {
if (!snapshot.hasData ||
!needsSpeechVoiceHint(
snapshot.data!,
View.of(context).platformDispatcher.locale.languageCode,
supportsVoiceDownloadHint:
_speech.engine.supportsVoiceDownloadHint,
)) {
return const SizedBox.shrink();
}
const hint =
'For a more natural voice, download one in System Settings > '
'Accessibility > Spoken Content > System voice > Manage voices.';
return SettingsGroupItem(
key: const Key('settings-read-aloud-voice-hint'),
child: Tooltip(
message: hint,
child: Text(
hint,
maxLines: 1,
overflow: TextOverflow.ellipsis,
style: Theme.of(context).textTheme.bodySmall?.copyWith(
color: Theme.of(context).colorScheme.onSurfaceVariant,
),
),
),
);
},
);
}
}