feat: added csv playback for soundmeter instrument. (#2879)

Author: Yugesh-Kumar-S

lib/l10n/app_en.arb

@@ -477,5 +477,10 @@
     "distance" : "Distance",
     "distanceUnitLabel" : "mm",
     "legacyFirmwareAlertTitle": "Legacy Firmware Detected",
-    "legacyFirmwareAlertMessage": "We have detected that your PSLab device is running legacy firmware. Please note that support for this firmware has ended. For the best experience and continued support, please update your device to the latest firmware version."
+    "legacyFirmwareAlertMessage": "We have detected that your PSLab device is running legacy firmware. Please note that support for this firmware has ended. For the best experience and continued support, please update your device to the latest firmware version.",
+    "playbackStarted" : "Playback started",
+    "playback" : "Playback",
+    "stopPlayback" : "Stop Playback",
+    "resumePlayback" : "Resume Playback",
+    "pausePlayback" : "Pause Playback"
 }

lib/l10n/app_localizations.dart

@@ -2993,6 +2993,36 @@ abstract class AppLocalizations {
   /// In en, this message translates to:
   /// **'We have detected that your PSLab device is running legacy firmware. Please note that support for this firmware has ended. For the best experience and continued support, please update your device to the latest firmware version.'**
   String get legacyFirmwareAlertMessage;
+
+  /// No description provided for @playbackStarted.
+  ///
+  /// In en, this message translates to:
+  /// **'Playback started'**
+  String get playbackStarted;
+
+  /// No description provided for @playback.
+  ///
+  /// In en, this message translates to:
+  /// **'Playback'**
+  String get playback;
+
+  /// No description provided for @stopPlayback.
+  ///
+  /// In en, this message translates to:
+  /// **'Stop Playback'**
+  String get stopPlayback;
+
+  /// No description provided for @resumePlayback.
+  ///
+  /// In en, this message translates to:
+  /// **'Resume Playback'**
+  String get resumePlayback;
+
+  /// No description provided for @pausePlayback.
+  ///
+  /// In en, this message translates to:
+  /// **'Pause Playback'**
+  String get pausePlayback;
 }
 
 class _AppLocalizationsDelegate

lib/l10n/app_localizations_en.dart

@@ -1552,4 +1552,19 @@ class AppLocalizationsEn extends AppLocalizations {
   @override
   String get legacyFirmwareAlertMessage =>
       'We have detected that your PSLab device is running legacy firmware. Please note that support for this firmware has ended. For the best experience and continued support, please update your device to the latest firmware version.';
+
+  @override
+  String get playbackStarted => 'Playback started';
+
+  @override
+  String get playback => 'Playback';
+
+  @override
+  String get stopPlayback => 'Stop Playback';
+
+  @override
+  String get resumePlayback => 'Resume Playback';
+
+  @override
+  String get pausePlayback => 'Pause Playback';
 }

lib/providers/soundmeter_state_provider.dart

@@ -7,6 +7,7 @@ import 'package:pslab/others/logger_service.dart';
 import 'package:flutter/foundation.dart';
 import 'package:pslab/providers/locator.dart';
 import 'package:pslab/others/audio_jack.dart';
+import 'package:permission_handler/permission_handler.dart';
 
 class SoundMeterStateProvider extends ChangeNotifier {
   AppLocalizations appLocalizations = getIt.get<AppLocalizations>();
@@ -26,14 +27,38 @@ class SoundMeterStateProvider extends ChangeNotifier {
   int _dataCount = 0;
   bool _isRecording = false;
   List<List<dynamic>> _recordedData = [];
+  bool _isPlayingBack = false;
+  List<List<dynamic>>? _playbackData;
+  int _playbackIndex = 0;
+  Timer? _playbackTimer;
+  bool _isPlaybackPaused = false;
   bool get isRecording => _isRecording;
+  bool get isPlayingBack => _isPlayingBack;
+  bool get isPlaybackPaused => _isPlaybackPaused;
 
   Function(String)? onSensorError;
+  Function? onPlaybackEnd;
 
   void initializeSensors({Function(String)? onError}) async {
     onSensorError = onError;
 
     try {
+      PermissionStatus microphonePermission =
+          await Permission.microphone.status;
+
+      if (microphonePermission != PermissionStatus.granted) {
+        microphonePermission = await Permission.microphone.request();
+      }
+      if (microphonePermission != PermissionStatus.granted) {
+        if (microphonePermission == PermissionStatus.permanentlyDenied) {
+          await openAppSettings();
+          _handleSensorError("Microphone permission is permanently denied.");
+          return;
+        } else {
+          return;
+        }
+      }
+
       _audioJack = AudioJack();
       await _audioJack!.initialize();
       await _audioJack!.start();
@@ -92,8 +117,116 @@ class SoundMeterStateProvider extends ChangeNotifier {
     _audioJack = null;
   }
 
+  void startPlayback(List<List<dynamic>> data) {
+    if (data.length <= 1) return;
+
+    _isPlayingBack = true;
+    _isPlaybackPaused = false;
+    _playbackData = data;
+    _playbackIndex = 1;
+
+    _timeTimer?.cancel();
+    _audioTimer?.cancel();
+
+    _dbData.clear();
+    dbChartData.clear();
+    _timeData.clear();
+    _startTime = DateTime.now().millisecondsSinceEpoch / 1000.0;
+    _currentTime = 0;
+    _dbSum = 0;
+    _dataCount = 0;
+
+    _startPlaybackTimer();
+    notifyListeners();
+  }
+
+  void _startPlaybackTimer() {
+    if (_playbackIndex >= _playbackData!.length) {
+      stopPlayback();
+      return;
+    }
+
+    final currentRow = _playbackData![_playbackIndex];
+    if (currentRow.length > 2) {
+      _currentDb = double.tryParse(currentRow[2].toString()) ?? 0.0;
+      _currentTime = (_playbackIndex - 1).toDouble();
+      _updateData();
+      _playbackIndex++;
+      notifyListeners();
+    } else {
+      logger.e(
+          'Skipping playback row at index $_playbackIndex due to insufficient columns (found ${currentRow.length}, expected at least 3');
+      _playbackIndex++;
+      notifyListeners();
+    }
+
+    Duration interval = const Duration(seconds: 1);
+
+    if (_playbackIndex < _playbackData!.length && _playbackIndex > 1) {
+      try {
+        final currentTimestamp =
+            int.tryParse(_playbackData![_playbackIndex - 1][0].toString());
+        final nextTimestamp =
+            int.tryParse(_playbackData![_playbackIndex][0].toString());
+
+        if (currentTimestamp != null && nextTimestamp != null) {
+          final timeDiff = nextTimestamp - currentTimestamp;
+          interval = Duration(milliseconds: timeDiff);
+          if (interval.inMilliseconds < 100) {
+            interval = const Duration(milliseconds: 100);
+          } else if (interval.inMilliseconds > 10000) {
+            interval = const Duration(seconds: 10);
+          }
+        }
+      } catch (e) {
+        interval = const Duration(seconds: 1);
+      }
+    }
+
+    _playbackTimer = Timer(interval, () {
+      if (_isPlayingBack && !_isPlaybackPaused) {
+        _startPlaybackTimer();
+      }
+    });
+  }
+
+  Future<void> stopPlayback() async {
+    _isPlayingBack = false;
+    _isPlaybackPaused = false;
+    _playbackTimer?.cancel();
+    _playbackData = null;
+    _playbackIndex = 0;
+
+    _dbData.clear();
+    dbChartData.clear();
+    _timeData.clear();
+    _dbSum = 0;
+    _dataCount = 0;
+    _currentDb = 0.0;
+    _currentTime = 0;
+    notifyListeners();
+    onPlaybackEnd?.call();
+  }
+
+  void pausePlayback() {
+    if (_isPlayingBack) {
+      _isPlaybackPaused = true;
+      _playbackTimer?.cancel();
+      notifyListeners();
+    }
+  }
+
+  void resumePlayback() {
+    if (_isPlayingBack && _isPlaybackPaused) {
+      _isPlaybackPaused = false;
+      _startPlaybackTimer();
+      notifyListeners();
+    }
+  }
+
   @override
   void dispose() {
+    _playbackTimer?.cancel();
     disposeSensors();
     super.dispose();
   }

lib/view/logged_data_screen.dart

@@ -4,7 +4,7 @@ import 'package:intl/intl.dart';
 import 'package:pslab/others/csv_service.dart';
 import 'package:pslab/theme/colors.dart';
 import 'package:pslab/view/logged_data_chart_screen.dart';
-
+import 'package:pslab/view/soundmeter_screen.dart';
 import '../l10n/app_localizations.dart';
 import '../providers/locator.dart';
 
@@ -164,6 +164,22 @@ class _LoggedDataScreenState extends State<LoggedDataScreen> {
     }
   }
 
+  Future<void> _playFile(File file) async {
+    final data = await _csvService.readCsvFromFile(file);
+    if (data.isNotEmpty && mounted) {
+      switch (widget.instrumentName) {
+        case 'soundmeter':
+          Navigator.push(
+            context,
+            MaterialPageRoute(
+              builder: (context) => SoundMeterScreen(playbackData: data),
+            ),
+          );
+          break;
+      }
+    }
+  }
+
   Future<void> _pickAndImportFile() async {
     final data = await _csvService.pickAndReadCsvFile();
     if (data != null && mounted) {
@@ -288,6 +304,12 @@ class _LoggedDataScreenState extends State<LoggedDataScreen> {
                             mainAxisAlignment: MainAxisAlignment.center,
                             mainAxisSize: MainAxisSize.min,
                             children: [
+                              if (widget.instrumentName == "soundmeter")
+                                IconButton(
+                                  icon:
+                                      Icon(Icons.play_arrow, color: primaryRed),
+                                  onPressed: () => _playFile(file),
+                                ),
                               IconButton(
                                 icon: Icon(Icons.share, color: primaryRed),
                                 onPressed: () =>

lib/view/soundmeter_screen.dart

@@ -15,7 +15,9 @@ import '../constants.dart';
 import '../theme/colors.dart';
 
 class SoundMeterScreen extends StatefulWidget {
-  const SoundMeterScreen({super.key});
+  final List<List<dynamic>>? playbackData;
+  const SoundMeterScreen({super.key, this.playbackData});
+
   @override
   State<StatefulWidget> createState() => _SoundMeterScreenState();
 }
@@ -105,7 +107,7 @@ class _SoundMeterScreenState extends State<SoundMeterScreen> {
       MaterialPageRoute(
         builder: (context) => LoggedDataScreen(
           instrumentName: 'soundmeter',
-          appBarName: 'Sound Meter',
+          appBarName: appLocalizations.soundMeter,
           instrumentIcon: instrumentIcons[15],
         ),
       ),
@@ -196,9 +198,18 @@ class _SoundMeterScreenState extends State<SoundMeterScreen> {
   void initState() {
     super.initState();
     _provider = SoundMeterStateProvider();
+    _provider.onPlaybackEnd = () {
+      if (mounted && Navigator.canPop(context)) {
+        Navigator.pop(context);
+      }
+    };
     WidgetsBinding.instance.addPostFrameCallback((_) {
       if (mounted) {
-        _provider.initializeSensors(onError: _showSensorErrorSnackbar);
+        if (widget.playbackData != null) {
+          _provider.startPlayback(widget.playbackData!);
+        } else {
+          _provider.initializeSensors(onError: _showSensorErrorSnackbar);
+        }
       }
     });
   }
@@ -234,11 +245,27 @@ class _SoundMeterScreenState extends State<SoundMeterScreen> {
           Consumer<SoundMeterStateProvider>(
             builder: (context, provider, child) {
               return CommonScaffold(
-                title: appLocalizations.soundMeterTitle,
+                title: provider.isPlayingBack
+                    ? '${appLocalizations.soundMeter} - ${appLocalizations.playback}'
+                    : appLocalizations.soundMeterTitle,
                 onGuidePressed: _showInstrumentGuide,
-                onOptionsPressed: _showOptionsMenu,
-                onRecordPressed: _toggleRecording,
+                onOptionsPressed:
+                    provider.isPlayingBack ? null : _showOptionsMenu,
+                onRecordPressed:
+                    provider.isPlayingBack ? null : _toggleRecording,
                 isRecording: provider.isRecording,
+                isPlayingBack: provider.isPlayingBack,
+                isPlaybackPaused: provider.isPlaybackPaused,
+                onPlaybackPauseResume: provider.isPlayingBack
+                    ? (provider.isPlaybackPaused
+                        ? _provider.resumePlayback
+                        : _provider.pausePlayback)
+                    : null,
+                onPlaybackStop: provider.isPlayingBack
+                    ? () async {
+                        await _provider.stopPlayback();
+                      }
+                    : null,
                 body: SafeArea(
                   child: LayoutBuilder(
                     builder: (context, constraints) {