✨ Allow users to update reported duration for smoothening wave progress animation

Author: Ujas-Majithiya

CHANGELOG.md

@@ -1,6 +1,7 @@
-## 1.0.4 (Unreleased)
+## 1.0.4
 
 - Fixed [#171](https://github.com/SimformSolutionsPvtLtd/audio_waveforms/issues/171) - Do not call `notifyListeners()` when disposed
+- Add `UpdateFrequency` to update reporting rate of current duration. Fixes [#118](https://github.com/SimformSolutionsPvtLtd/audio_waveforms/issues/118) & [#145](https://github.com/SimformSolutionsPvtLtd/audio_waveforms/issues/145)
 
 ## 1.0.3
 

README.md

@@ -62,7 +62,7 @@ import 'package:audio_waveforms/audio_waveforms.dart';
 ```dart
 RecorderController controller = RecorderController();      // Initialise
 await controller.record(path: 'path');                     // Record (path is optional)
-final hasPermission = await controller.checkPermission();  // Check mic permission (also called duration record)
+final hasPermission = await controller.checkPermission();  // Check mic permission (also called during record)
 await controller.pause();                                  // Pause recording
 final path = await controller.stop();                      // Stop recording and get the path
 controller.refresh();                                      // Refresh waveform to original position
@@ -129,7 +129,8 @@ await controller.pausePlayer();                                     // Pause aud
 await controller.stopPlayer();                                      // Stop audio player
 await controller.setVolume(1.0);                                    // Set volume level
 await controller.seekTo(5000);                                      // Seek audio
-final duration = await controller.getDuration(DurationType.max);    // Get duration of audio player      
+final duration = await controller.getDuration(DurationType.max);    // Get duration of audio player
+controller.updateFrequency = UpdateFrequency.low;                   // Update reporting rate of current duration.
 controller.onPlayerStateChanged.listen((state) {});                 // Listening to player state changes
 controller.onCurrentDurationChanged.listen((duration) {});          // Listening to current duration changes
 controller.onCurrentExtractedWaveformData.listen((data) {});        // Listening to latest extraction data

android/src/main/kotlin/com/simform/audio_waveforms/AudioPlayer.kt

@@ -24,13 +24,16 @@ class AudioPlayer(
     private var isPlayerPrepared: Boolean = false
     private var finishMode = FinishMode.Stop
     private var key = playerKey
+    private var updateFrequency = UpdateFrequency.Low
 
     fun preparePlayer(
         result: MethodChannel.Result,
         path: String?,
-        volume: Float?
+        volume: Float?,
+        frequency: UpdateFrequency,
     ) {
         if (path != null) {
+            updateFrequency = frequency
             val uri = Uri.parse(path)
             val mediaItem = MediaItem.fromUri(uri)
             player = ExoPlayer.Builder(appContext).build()
@@ -167,7 +170,7 @@ class AudioPlayer(
                     args[Constants.current] = currentPosition
                     args[Constants.playerKey] = key
                     methodChannel.invokeMethod(Constants.onCurrentDuration, args)
-                    handler.postDelayed(this, 200)
+                    handler.postDelayed(this, updateFrequency.value)
                 } else {
                     result.error(Constants.LOG_TAG, "Can't get current Position of player", "")
                 }

android/src/main/kotlin/com/simform/audio_waveforms/AudioWaveformsPlugin.kt

@@ -71,9 +71,15 @@ class AudioWaveformsPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
                 val audioPath = call.argument(Constants.path) as String?
                 val volume = call.argument(Constants.volume) as Double?
                 val key = call.argument(Constants.playerKey) as String?
+                val frequency = call.argument(Constants.updateFrequency) as Int?
                 if (key != null) {
                     initPlayer(key)
-                    audioPlayers[key]?.preparePlayer(result, audioPath, volume?.toFloat())
+                    audioPlayers[key]?.preparePlayer(
+                        result,
+                        audioPath,
+                        volume?.toFloat(),
+                        getUpdateFrequency(frequency),
+                    )
                 } else {
                     result.error(Constants.LOG_TAG, "Player key can't be null", "")
                 }
@@ -225,6 +231,15 @@ class AudioWaveformsPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
         return
     }
 
+    private fun getUpdateFrequency(frequency: Int?): UpdateFrequency {
+        if (frequency == 2) {
+            return UpdateFrequency.High
+        } else if (frequency == 1) {
+            return UpdateFrequency.Medium
+        }
+        return UpdateFrequency.Low
+    }
+
     private fun createOrUpdateExtractor(
         playerKey: String,
         noOfSamples: Int,

android/src/main/kotlin/com/simform/audio_waveforms/Utils.kt

@@ -62,10 +62,17 @@ object Constants {
     const val onCurrentExtractedWaveformData = "onCurrentExtractedWaveformData"
     const val waveformData = "waveformData"
     const val useLegacyNormalization = "useLegacyNormalization"
+    const val updateFrequency = "updateFrequency"
 }
 
 enum class FinishMode(val value:Int) {
     Loop(0),
     Pause(1),
     Stop(2)
+}
+
+enum class UpdateFrequency(val value:Long) {
+    High(50),
+    Medium(100),
+    Low(200),
 }

ios/Classes/AudioPlayer.swift

@@ -8,18 +8,21 @@ class AudioPlayer: NSObject, AVAudioPlayerDelegate {
     private var timer: Timer?
     private var player: AVAudioPlayer?
     private var finishMode: FinishMode = FinishMode.stop
+    private var updateFrequency = UpdateFrequency.low
     var plugin: SwiftAudioWaveformsPlugin
     var playerKey: String
     var flutterChannel: FlutterMethodChannel
+    
 
     init(plugin: SwiftAudioWaveformsPlugin, playerKey: String, channel: FlutterMethodChannel) {
         self.plugin = plugin
         self.playerKey = playerKey
         flutterChannel = channel
     }
 
-    func preparePlayer(path: String?, volume: Double?, result: @escaping FlutterResult) {
+    func preparePlayer(path: String?, volume: Double?, updateFrequency: UpdateFrequency,result: @escaping FlutterResult) {
         if(!(path ?? "").isEmpty) {
+            self.updateFrequency = updateFrequency
             let audioUrl = URL.init(string: path!)
             if(audioUrl == nil){
                 result(FlutterError(code: Constants.audioWaveforms, message: "Failed to initialise Url from provided audio file", details: "If path contains `file://` try removing it"))
@@ -114,7 +117,7 @@ class AudioPlayer: NSObject, AVAudioPlayerDelegate {
 
     func startListening() {
         if #available(iOS 10.0, *) {
-            timer = Timer.scheduledTimer(withTimeInterval: 0.2, repeats: true, block: { _ in
+            timer = Timer.scheduledTimer(withTimeInterval: (updateFrequency.rawValue / 1000), repeats: true, block: { _ in
                 let ms = (self.player?.currentTime ?? 0) * 1000
                 self.flutterChannel.invokeMethod(Constants.onCurrentDuration, arguments: [Constants.current: Int(ms), Constants.playerKey: self.playerKey])
             })

ios/Classes/SwiftAudioWaveformsPlugin.swift

@@ -48,7 +48,10 @@ public class SwiftAudioWaveformsPlugin: NSObject, FlutterPlugin {
             let key = args?[Constants.playerKey] as? String
             if(key != nil){
                 initPlayer(playerKey: key!)
-                audioPlayers[key!]?.preparePlayer(path: args?[Constants.path] as? String, volume: args?[Constants.volume] as? Double,result: result)
+                audioPlayers[key!]?.preparePlayer(path: args?[Constants.path] as? String,
+                                                  volume: args?[Constants.volume] as? Double,
+                                                  updateFrequency: getUpdateFrequency(freq: args?[Constants.updateFrequency] as? Int) ,
+                                                  result: result)
             } else {
                 result(FlutterError(code: Constants.audioWaveforms, message: "Can not prepare player", details: "Player key is null"))
             }
@@ -129,6 +132,15 @@ public class SwiftAudioWaveformsPlugin: NSObject, FlutterPlugin {
         }
     }
 
+    func getUpdateFrequency(freq: Int?) -> UpdateFrequency{
+        if(freq == 2){
+            return UpdateFrequency.high
+        } else if(freq == 1){
+            return UpdateFrequency.medium
+        }
+        return UpdateFrequency.low
+    }
+    
     func initPlayer(playerKey: String) {
         if audioPlayers[playerKey] == nil {
             let newPlayer = AudioPlayer(plugin: self,playerKey: playerKey,channel: flutterChannel)
@@ -144,7 +156,7 @@ public class SwiftAudioWaveformsPlugin: NSObject, FlutterPlugin {
                     result(FlutterError(code: Constants.audioWaveforms, message: "Failed to initialise Url from provided audio file", details: "If path contains `file://` try removing it"))
                     return
                 }
-                var newExtractor = try WaveformExtractor(url: audioUrl!, flutterResult: result, channel: flutterChannel)
+                let newExtractor = try WaveformExtractor(url: audioUrl!, flutterResult: result, channel: flutterChannel)
                 extractors[playerKey] = newExtractor
                 let data = newExtractor.extractWaveform(samplesPerPixel: noOfSamples, playerKey: playerKey)
                 newExtractor.cancel()

ios/Classes/Utils.swift

@@ -56,6 +56,7 @@ struct Constants {
     static let waveformData = "waveformData"
     static let onExtractionProgressUpdate = "onExtractionProgressUpdate"
     static let useLegacyNormalization = "useLegacyNormalization"
+    static let updateFrequency = "updateFrequency"
 }
 
 enum FinishMode : Int{
@@ -64,6 +65,11 @@ enum FinishMode : Int{
     case stop = 2
 }
 
+enum UpdateFrequency : Double{
+    case high = 50.0
+    case medium = 100.0
+    case low = 200.0
+}
 /// Creates an 2D array of floats
 public typealias FloatChannelData = [[Float]]
 

lib/src/base/audio_waveforms_interface.dart

@@ -91,11 +91,17 @@ class AudioWaveformsInterface {
   }
 
   ///platform call to prepare player
-  Future<bool> preparePlayer(String path, String key, [double? volume]) async {
+  Future<bool> preparePlayer({
+    required String path,
+    required String key,
+    required int frequency,
+    double? volume,
+  }) async {
     var result = await _methodChannel.invokeMethod(Constants.preparePlayer, {
       Constants.path: path,
       Constants.volume: volume,
       Constants.playerKey: key,
+      Constants.updateFrequency: frequency,
     });
     return result ?? false;
   }

lib/src/base/constants.dart

@@ -43,4 +43,5 @@ class Constants {
   static const String onCurrentExtractedWaveformData =
       "onCurrentExtractedWaveformData";
   static const String useLegacyNormalization = "useLegacyNormalization";
+  static const String updateFrequency = "updateFrequency";
 }