feat: implement Produce Sound functionality in Wave Generator (fossasia#3123)

rahul31124 · web-flow · commit d8e10d878b0e · 2026-03-09T18:28:11.000Z
diff --git a/lib/l10n/app_en.arb b/lib/l10n/app_en.arb
@@ -663,5 +663,6 @@
     "pin_cap_name": "CAP",
     "pin_cap_desc": "Capacitance Measurement Pin",
     "pin_res_name": "RES",
-    "pin_res_desc": "Resistance Measurement Pin"
+    "pin_res_desc": "Resistance Measurement Pin",
+    "stopSound" : "Stop Sound"
 }
diff --git a/lib/l10n/app_localizations.dart b/lib/l10n/app_localizations.dart
@@ -4103,6 +4103,12 @@ abstract class AppLocalizations {
   /// In en, this message translates to:
   /// **'Resistance Measurement Pin'**
   String get pin_res_desc;
+
+  /// No description provided for @stopSound.
+  ///
+  /// In en, this message translates to:
+  /// **'Stop Sound'**
+  String get stopSound;
 }
 
 class _AppLocalizationsDelegate
diff --git a/lib/l10n/app_localizations_de.dart b/lib/l10n/app_localizations_de.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsDe extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_en.dart b/lib/l10n/app_localizations_en.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsEn extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_es.dart b/lib/l10n/app_localizations_es.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsEs extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_fr.dart b/lib/l10n/app_localizations_fr.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsFr extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_he.dart b/lib/l10n/app_localizations_he.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsHe extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_hi.dart b/lib/l10n/app_localizations_hi.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsHi extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_id.dart b/lib/l10n/app_localizations_id.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsId extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_it.dart b/lib/l10n/app_localizations_it.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsIt extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_ja.dart b/lib/l10n/app_localizations_ja.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsJa extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_ml.dart b/lib/l10n/app_localizations_ml.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsMl extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_my.dart b/lib/l10n/app_localizations_my.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsMy extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_nb.dart b/lib/l10n/app_localizations_nb.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsNb extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_pt.dart b/lib/l10n/app_localizations_pt.dart
@@ -2155,6 +2155,9 @@ class AppLocalizationsPt extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
 
 /// The translations for Portuguese, as used in Brazil (`pt_BR`).
diff --git a/lib/l10n/app_localizations_ru.dart b/lib/l10n/app_localizations_ru.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsRu extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_te.dart b/lib/l10n/app_localizations_te.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsTe extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_uk.dart b/lib/l10n/app_localizations_uk.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsUk extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_vi.dart b/lib/l10n/app_localizations_vi.dart
@@ -2155,4 +2155,7 @@ class AppLocalizationsVi extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
diff --git a/lib/l10n/app_localizations_zh.dart b/lib/l10n/app_localizations_zh.dart
@@ -2155,6 +2155,9 @@ class AppLocalizationsZh extends AppLocalizations {
 
   @override
   String get pin_res_desc => 'Resistance Measurement Pin';
+
+  @override
+  String get stopSound => 'Stop Sound';
 }
 
 /// The translations for Chinese, using the Han script (`zh_Hant`).
diff --git a/lib/providers/wave_generator_state_provider.dart b/lib/providers/wave_generator_state_provider.dart
@@ -1,11 +1,13 @@
 import 'dart:convert';
 import 'dart:math';
 import 'dart:math' as math;
+import 'dart:typed_data';
 
 import 'package:fl_chart/fl_chart.dart';
 import 'package:flutter/material.dart';
 import 'package:geolocator/geolocator.dart';
 import 'package:intl/intl.dart';
+import 'package:mp_audio_stream/mp_audio_stream.dart';
 import 'package:pslab/communication/science_lab.dart';
 import 'package:pslab/others/logger_service.dart';
 import 'package:pslab/others/wave_generator_constants.dart';
@@ -65,6 +67,12 @@ class WaveGeneratorStateProvider extends ChangeNotifier {
 
   Position? currentPosition;
 
+  AudioStream? _audioStream;
+
+  bool isPlayingSound = false;
+
+  double _audioAngle = 0.0;
+
   WaveGeneratorStateProvider() {
     selectedAnalogWave = WaveConst.wave1;
 
@@ -83,6 +91,146 @@ class WaveGeneratorStateProvider extends ChangeNotifier {
     _configProvider = configProvider;
   }
 
+  void toggleSound() {
+    if (isPlayingSound) {
+      isPlayingSound = false;
+
+      _stopAudioStream();
+    } else {
+      isPlayingSound = true;
+
+      _startAudioStream();
+    }
+
+    notifyListeners();
+  }
+
+  Future<void> _startAudioStream() async {
+    _audioStream = getAudioStream();
+
+    _audioStream!.init(bufferMilliSec: 1000, channels: 1, sampleRate: 44100);
+
+    _audioStream!.resume();
+
+    await Future.delayed(const Duration(milliseconds: 100));
+
+    _audioAngle = 0.0;
+
+    final int bufferSize = 4096;
+
+    final double bufferDurationMs = (bufferSize / 44100.0) * 1000.0;
+
+    final List<Float32List> bufferPool =
+        List.generate(5, (_) => Float32List(bufferSize));
+
+    int poolIndex = 0;
+
+    double generatedAudioMs = 0.0;
+
+    Stopwatch stopwatch = Stopwatch()..start();
+
+    for (int i = 0; i < 3; i++) {
+      final buffer = bufferPool[poolIndex];
+
+      poolIndex = (poolIndex + 1) % bufferPool.length;
+
+      _fillAudioBuffer(buffer, bufferSize);
+
+      _audioStream!.push(buffer);
+
+      generatedAudioMs += bufferDurationMs;
+    }
+
+    while (isPlayingSound) {
+      double elapsedRealTimeMs = stopwatch.elapsedMilliseconds.toDouble();
+
+      if (generatedAudioMs - elapsedRealTimeMs < 300.0) {
+        final buffer = bufferPool[poolIndex];
+
+        poolIndex = (poolIndex + 1) % bufferPool.length;
+
+        _fillAudioBuffer(buffer, bufferSize);
+
+        _audioStream!.push(buffer);
+
+        generatedAudioMs += bufferDurationMs;
+      } else {
+        await Future.delayed(const Duration(milliseconds: 20));
+      }
+
+      if (elapsedRealTimeMs > generatedAudioMs) {
+        generatedAudioMs = elapsedRealTimeMs;
+      }
+    }
+  }
+
+  void _fillAudioBuffer(Float32List buffer, int bufferSize) {
+    double frequency;
+
+    double duty = 0.5;
+
+    if (waveGeneratorConstants.modeSelected == WaveConst.square) {
+      frequency = waveGeneratorConstants
+          .wave[selectedAnalogWave]![WaveConst.frequency]!
+          .toDouble();
+    } else {
+      frequency = waveGeneratorConstants
+          .wave[WaveConst.sqr1]![WaveConst.frequency]!
+          .toDouble();
+
+      int currentDuty =
+          waveGeneratorConstants.wave[selectedDigitalWave]![WaveConst.duty] ??
+              50;
+
+      duty = currentDuty / 100.0;
+    }
+
+    if (frequency <= 0) frequency = 1;
+
+    double increment = (2 * math.pi * frequency) / 44100.0;
+
+    const double volume = 0.15;
+
+    for (int i = 0; i < bufferSize; i++) {
+      if (waveGeneratorConstants.modeSelected == WaveConst.pwm) {
+        buffer[i] = (_audioAngle < (2 * math.pi * duty)) ? volume : -volume;
+      } else {
+        double safeSin = math.sin(_audioAngle).clamp(-1.0, 1.0);
+
+        double sample = safeSin;
+
+        if (waveGeneratorConstants
+                .wave[selectedAnalogWave]![WaveConst.waveType] ==
+            triangular) {
+          sample = (2 / math.pi) * math.asin(safeSin);
+        }
+
+        buffer[i] = sample * volume;
+      }
+
+      _audioAngle += increment;
+
+      if (_audioAngle >= 2 * math.pi) {
+        _audioAngle -= 2 * math.pi;
+      }
+    }
+  }
+
+  void _stopAudioStream() {
+    if (_audioStream != null) {
+      _audioStream!.uninit();
+
+      _audioStream = null;
+    }
+  }
+
+  @override
+  void dispose() {
+    _stopAudioStream();
+    isPlayingSound = false;
+    super.dispose();
+  }
+
   Future<void> _getCurrentLocation() async {
     bool serviceEnabled;
     LocationPermission permission;
diff --git a/lib/view/wave_generator_screen.dart b/lib/view/wave_generator_screen.dart
@@ -269,21 +269,30 @@ class _WaveGeneratorScreenState extends State<WaveGeneratorScreen> {
                                   Expanded(
                                     child: TextButton(
                                       style: TextButton.styleFrom(
-                                        backgroundColor: primaryRed,
+                                        backgroundColor: provider.isPlayingSound
+                                            ? Colors.grey[800]
+                                            : primaryRed,
                                         shape: RoundedRectangleBorder(
                                           borderRadius:
                                               BorderRadius.circular(6),
                                         ),
                                       ),
                                       child: Text(
-                                        appLocalizations.produceSound,
+                                        provider.isPlayingSound
+                                            ? appLocalizations.stopSound
+                                            : appLocalizations.produceSound,
                                         textAlign: TextAlign.center,
                                         style: TextStyle(
                                           color: Colors.white,
                                           fontSize: 14,
+                                          fontWeight: provider.isPlayingSound
+                                              ? FontWeight.bold
+                                              : FontWeight.normal,
                                         ),
                                       ),
-                                      onPressed: () => {},
+                                      onPressed: () {
+                                        provider.toggleSound();
+                                      },
                                     ),
                                   ),
                                   const SizedBox(width: 4),
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -73,6 +73,7 @@ dependencies:
   image: ^4.1.3
   serial: ^0.0.7+1
   web: ^1.1.1
+  mp_audio_stream: ^0.2.2
 dependency_overrides:
   ffi: ^2.1.3
 

Original file line number	Diff line number	Diff line change
`@@ -663,5 +663,6 @@`
`663`	`663`	`"pin_cap_name": "CAP",`
`664`	`664`	`"pin_cap_desc": "Capacitance Measurement Pin",`
`665`	`665`	`"pin_res_name": "RES",`
`666`		`- "pin_res_desc": "Resistance Measurement Pin"`
	`666`	`+ "pin_res_desc": "Resistance Measurement Pin",`
	`667`	`+ "stopSound" : "Stop Sound"`
`667`	`668`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2155,4 +2155,7 @@ class AppLocalizationsDe extends AppLocalizations {`
`2155`	`2155`
`2156`	`2156`	`@override`
`2157`	`2157`	`String get pin_res_desc => 'Resistance Measurement Pin';`
	`2158`	`+`
	`2159`	`+ @override`
	`2160`	`+ String get stopSound => 'Stop Sound';`
`2158`	`2161`	`}`