✨ Add legacy normalization and updated minor stopAllPlayer behaviour

Ujas-Majithiya · ujas-m-simformsolutions · commit 8f97a05b6a8d · 2023-01-18T19:23:11.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 1.0.2 (Unreleased)
+
+- Now, calling `stopAllPlayers` is not mandatory for disposing streams and it will also not dispose controller. With last remaining player they will be disposed (Streams can be re-initialised by creating a new PlayerController).
+- Added legacy normalization with this fixed [#144](https://github.com/SimformSolutionsPvtLtd/audio_waveforms/issues/144). 
+
 ## 1.0.1
 
 - Added `onCompletion` stream to get event when audio is finished playing.
diff --git a/android/src/main/kotlin/com/simform/audio_waveforms/AudioRecorder.kt b/android/src/main/kotlin/com/simform/audio_waveforms/AudioRecorder.kt
@@ -12,14 +12,26 @@ import io.flutter.plugin.common.MethodChannel
 import io.flutter.plugin.common.PluginRegistry
 import java.io.IOException
 import java.lang.IllegalStateException
+import kotlin.math.log10
 
 private const val LOG_TAG = "AudioWaveforms"
 private const val RECORD_AUDIO_REQUEST_CODE = 1001
 
 class AudioRecorder : PluginRegistry.RequestPermissionsResultListener {
     private var permissions = arrayOf(Manifest.permission.RECORD_AUDIO)
+    private var useLegacyNormalization = false
+
     fun getDecibel(result: MethodChannel.Result, recorder: MediaRecorder?) {
-        result.success(recorder?.maxAmplitude?.toDouble() ?: 0.0)
+        if (useLegacyNormalization) {
+            val db = 20 * log10(((recorder?.maxAmplitude?.toDouble() ?: (0.0 / 32768.0))))
+            if (db == Double.NEGATIVE_INFINITY) {
+                Log.d(LOG_TAG, "Microphone might be turned off")
+            } else {
+                result.success(db)
+            }
+        } else {
+            result.success(recorder?.maxAmplitude?.toDouble() ?: 0.0)
+        }
     }
 
     fun initRecorder(
@@ -62,8 +74,9 @@ class AudioRecorder : PluginRegistry.RequestPermissionsResultListener {
         }
     }
 
-    fun startRecorder(result: MethodChannel.Result, recorder: MediaRecorder?) {
+    fun startRecorder(result: MethodChannel.Result, recorder: MediaRecorder?, useLegacy: Boolean) {
         try {
+            useLegacyNormalization = useLegacy
             recorder?.start()
             result.success(true)
         } catch (e: IllegalStateException) {
@@ -137,14 +150,8 @@ class AudioRecorder : PluginRegistry.RequestPermissionsResultListener {
                     MediaRecorder.AudioEncoder.AAC
                 }
             }
-            Constants.vorbis -> {
-                return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
-                    MediaRecorder.AudioEncoder.VORBIS
-                } else {
-                    Log.e(LOG_TAG, "Minimum android Q is required, Setting Acc encoder.")
-                    MediaRecorder.AudioEncoder.AAC
-                }
-            }
+            Constants.vorbis -> return MediaRecorder.AudioEncoder.VORBIS
+
             else -> return MediaRecorder.AudioEncoder.AAC
         }
     }
@@ -164,14 +171,8 @@ class AudioRecorder : PluginRegistry.RequestPermissionsResultListener {
 
             Constants.amr_wb -> return MediaRecorder.OutputFormat.AMR_WB
             Constants.amr_nb -> return MediaRecorder.OutputFormat.AMR_NB
-            Constants.webm -> {
-                return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
-                    MediaRecorder.OutputFormat.WEBM
-                } else {
-                    Log.e(LOG_TAG, "Minimum android Q is required, Setting MPEG_4 output format.")
-                    MediaRecorder.OutputFormat.MPEG_4
-                }
-            }
+            Constants.webm ->
+                return MediaRecorder.OutputFormat.WEBM
             Constants.mpeg_2_ts -> {
                 return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
                     MediaRecorder.OutputFormat.MPEG_2_TS
diff --git a/android/src/main/kotlin/com/simform/audio_waveforms/AudioWaveformsPlugin.kt b/android/src/main/kotlin/com/simform/audio_waveforms/AudioWaveformsPlugin.kt
@@ -54,7 +54,11 @@ class AudioWaveformsPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
                 bitRate = (call.argument(Constants.bitRate) as Int?)
                 checkPathAndInitialiseRecorder(result, encoder, outputFormat, sampleRate, bitRate)
             }
-            Constants.startRecording -> audioRecorder.startRecorder(result, recorder)
+            Constants.startRecording -> {
+                var useLegacyNormalization =
+                    (call.argument(Constants.useLegacyNormalization) as Boolean?) ?: false
+                audioRecorder.startRecorder(result, recorder, useLegacyNormalization)
+            }
             Constants.stopRecording -> {
                 audioRecorder.stopRecording(result, recorder, path!!)
                 recorder = null
diff --git a/android/src/main/kotlin/com/simform/audio_waveforms/Utils.kt b/android/src/main/kotlin/com/simform/audio_waveforms/Utils.kt
@@ -61,6 +61,7 @@ object Constants {
     const val noOfSamples = "noOfSamples"
     const val onCurrentExtractedWaveformData = "onCurrentExtractedWaveformData"
     const val waveformData = "waveformData"
+    const val useLegacyNormalization = "useLegacyNormalization"
 }
 
 enum class FinishMode(val value:Int) {
diff --git a/example/lib/chat_bubble.dart b/example/lib/chat_bubble.dart
@@ -53,7 +53,6 @@ class WaveBubble extends StatefulWidget {
   final int? index;
   final String? path;
   final double? width;
-  final bool isLastWidget;
   final Directory appDirectory;
 
   const WaveBubble({
@@ -63,7 +62,6 @@ class WaveBubble extends StatefulWidget {
     this.index,
     this.isSender = false,
     this.path,
-    this.isLastWidget = false,
   }) : super(key: key);
 
   @override
@@ -124,9 +122,6 @@ class _WaveBubbleState extends State<WaveBubble> {
   @override
   void dispose() {
     playerStateSubscription.cancel();
-    if (widget.isLastWidget) {
-      controller.stopAllPlayers();
-    }
     controller.dispose();
     super.dispose();
   }
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -28,7 +28,7 @@ class Home extends StatefulWidget {
   State<Home> createState() => _HomeState();
 }
 
-class _HomeState extends State<Home> with WidgetsBindingObserver {
+class _HomeState extends State<Home> {
   late final RecorderController recorderController;
 
   String? path;
@@ -53,7 +53,7 @@ class _HomeState extends State<Home> with WidgetsBindingObserver {
   }
 
   void _initialiseControllers() {
-    recorderController = RecorderController()
+    recorderController = RecorderController(useLegacyNormalization: true)
       ..androidEncoder = AndroidEncoder.aac
       ..androidOutputFormat = AndroidOutputFormat.mpeg4
       ..iosEncoder = IosEncoder.kAudioFormatMPEG4AAC
@@ -113,8 +113,6 @@ class _HomeState extends State<Home> with WidgetsBindingObserver {
                           index: index + 1,
                           isSender: index.isOdd,
                           width: MediaQuery.of(context).size.width / 2,
-                          isLastWidget:
-                              !isRecordingCompleted || musicFile == null,
                           appDirectory: appDirectory,
                         );
                       },
@@ -124,14 +122,12 @@ class _HomeState extends State<Home> with WidgetsBindingObserver {
                     WaveBubble(
                       path: path,
                       isSender: true,
-                      isLastWidget: isRecordingCompleted && musicFile == null,
                       appDirectory: appDirectory,
                     ),
                   if (musicFile != null)
                     WaveBubble(
                       path: musicFile,
                       isSender: true,
-                      isLastWidget: true,
                       appDirectory: appDirectory,
                     ),
                   SafeArea(
diff --git a/ios/Classes/AudioRecorder.swift b/ios/Classes/AudioRecorder.swift
@@ -5,21 +5,22 @@ public class AudioRecorder: NSObject, AVAudioRecorderDelegate{
     var audioRecorder: AVAudioRecorder?
     var path: String?
     var hasPermission: Bool = false
-    public var meteringLevels: [Float]?
+    var useLegacyNormalization: Bool = false
     
-    public func startRecording(_ result: @escaping FlutterResult,_ path: String?,_ encoder : Int?,_ sampleRate : Int?,_ bitRate : Int?,_ fileNameFormat: String){
+    public func startRecording(_ result: @escaping FlutterResult,_ path: String?,_ encoder : Int?,_ sampleRate : Int?,_ bitRate : Int?,_ fileNameFormat: String, _ useLegacy: Bool?){
+        useLegacyNormalization = useLegacy ?? false
         let settings = [
             AVFormatIDKey: getEncoder(encoder ?? 0),
             AVSampleRateKey: sampleRate ?? 44100,
             AVNumberOfChannelsKey: 1,
             AVEncoderAudioQualityKey: AVAudioQuality.high.rawValue
         ]
         let settingsWithBitrate = [
-                AVEncoderBitRateKey: bitRate,
-                AVFormatIDKey: getEncoder(encoder ?? 0),
-                AVSampleRateKey: sampleRate ?? 44100,
-                AVNumberOfChannelsKey: 1,
-                AVEncoderAudioQualityKey: AVAudioQuality.high.rawValue
+            AVEncoderBitRateKey: bitRate,
+            AVFormatIDKey: getEncoder(encoder ?? 0),
+            AVSampleRateKey: sampleRate ?? 44100,
+            AVNumberOfChannelsKey: 1,
+            AVEncoderAudioQualityKey: AVAudioQuality.high.rawValue
         ]
         
         let options: AVAudioSession.CategoryOptions = [.defaultToSpeaker, .allowBluetooth]
@@ -69,9 +70,14 @@ public class AudioRecorder: NSObject, AVAudioRecorderDelegate{
     
     public func getDecibel(_ result: @escaping FlutterResult) {
         audioRecorder?.updateMeters()
-        let amp = audioRecorder?.peakPower(forChannel: 0) ?? 0.0
-        let linear = pow(10, amp / 20);
-        result(linear)
+        if(useLegacyNormalization){
+            let amp = audioRecorder?.averagePower(forChannel: 0) ?? 0.0
+            result(amp)
+        } else {
+            let amp = audioRecorder?.peakPower(forChannel: 0) ?? 0.0
+            let linear = pow(10, amp / 20);
+            result(linear)
+        }
     }
     
     public func checkHasPermission(_ result: @escaping FlutterResult){
diff --git a/ios/Classes/SwiftAudioWaveformsPlugin.swift b/ios/Classes/SwiftAudioWaveformsPlugin.swift
@@ -28,7 +28,7 @@ public class SwiftAudioWaveformsPlugin: NSObject, FlutterPlugin {
         switch call.method {
         case Constants.startRecording:
             audioRecorder.startRecording(result,  args?[Constants.path] as? String,
-                                         args?[Constants.encoder] as? Int, args?[Constants.sampleRate] as? Int, args?[Constants.bitRate] as? Int,Constants.fileNameFormat)
+                                         args?[Constants.encoder] as? Int, args?[Constants.sampleRate] as? Int, args?[Constants.bitRate] as? Int,Constants.fileNameFormat, args?[Constants.useLegacyNormalization] as? Bool)
             break
         case Constants.pauseRecording:
             audioRecorder.pauseRecording(result)
diff --git a/ios/Classes/Utils.swift b/ios/Classes/Utils.swift
@@ -55,6 +55,7 @@ struct Constants {
     static let onCurrentExtractedWaveformData = "onCurrentExtractedWaveformData"
     static let waveformData = "waveformData"
     static let onExtractionProgressUpdate = "onExtractionProgressUpdate"
+    static let useLegacyNormalization = "useLegacyNormalization"
 }
 
 enum FinishMode : Int{
diff --git a/lib/src/base/audio_waveforms_interface.dart b/lib/src/base/audio_waveforms_interface.dart
@@ -14,17 +14,22 @@ class AudioWaveformsInterface {
     required int sampleRate,
     int? bitRate,
     String? path,
+    bool useLegacyNormalization = false,
   }) async {
     final isRecording = await _methodChannel.invokeMethod(
-        Constants.startRecording,
-        Platform.isIOS
-            ? {
-                Constants.path: path,
-                Constants.encoder: audioFormat,
-                Constants.sampleRate: sampleRate,
-                Constants.bitRate: bitRate,
-              }
-            : null);
+      Constants.startRecording,
+      Platform.isIOS
+          ? {
+              Constants.path: path,
+              Constants.encoder: audioFormat,
+              Constants.sampleRate: sampleRate,
+              Constants.bitRate: bitRate,
+              Constants.useLegacyNormalization: useLegacyNormalization,
+            }
+          : {
+              Constants.useLegacyNormalization: useLegacyNormalization,
+            },
+    );
     return isRecording ?? false;
   }
 
diff --git a/lib/src/base/constants.dart b/lib/src/base/constants.dart
@@ -42,4 +42,5 @@ class Constants {
   static const String waveformData = "waveformData";
   static const String onCurrentExtractedWaveformData =
       "onCurrentExtractedWaveformData";
+  static const String useLegacyNormalization = "useLegacyNormalization";
 }
diff --git a/lib/src/controllers/player_controller.dart b/lib/src/controllers/player_controller.dart
@@ -239,31 +239,27 @@ class PlayerController extends ChangeNotifier {
   /// Release any resources taken by this controller. Disposing this
   /// will stop the player and release resources from native.
   ///
-  /// As there is common stream for every players, stream
-  /// will be still active without any events.
-  /// To dispose it call [stopAllPlayers] before calling this function.
+  /// If this is last remaining controller then it will also dispose
+  /// the platform stream. They can be re-initialised by initialising a
+  /// new controller.
   @override
   void dispose() async {
     if (playerState != PlayerState.stopped) await stopPlayer();
     PlatformStreams.instance.playerControllerFactory.remove(this);
+    if (PlatformStreams.instance.playerControllerFactory.length == 1) {
+      PlatformStreams.instance.dispose();
+    }
     super.dispose();
   }
 
   /// This method is to free all players [resources] all at once.
   ///
-  /// This method is required to call only [once] from any
-  /// one of the PlayerController(s).
-  ///
-  /// Make sure to call this function before last remaining PlayerController.
-  ///
   /// This method will close the stream and free resources taken by all
-  /// players but it will only dispose this controller. So make sure free
-  /// other PlayerController's resources.
+  /// players. This method will not dispose controller.
   void stopAllPlayers() async {
     PlatformStreams.instance.dispose();
     await AudioWaveformsInterface.instance.stopAllPlayers();
     PlatformStreams.instance.playerControllerFactory.remove(this);
-    super.dispose();
   }
 
   /// Sets [_shouldRefresh] flag with provided boolean parameter.
diff --git a/lib/src/controllers/recorder_controller.dart b/lib/src/controllers/recorder_controller.dart
@@ -23,6 +23,13 @@ class RecorderController extends ChangeNotifier {
 
   int? bitRate;
 
+  /// **Important**: This is legacy normalizationFactor which was removed
+  /// in 1.0.0 release. Only use this if you are using legacy normalization.
+  ///
+  /// Db we get from native is too high so in Android it the value is
+  /// subtracted and in IOS value added
+  double normalizationFactor = Platform.isAndroid ? 60 : 40;
+
   /// Current maximum peak power for ios and peak amplitude android.
   double _maxPeak = Platform.isIOS ? 1 : 32786.0;
 
@@ -61,8 +68,18 @@ class RecorderController extends ChangeNotifier {
 
   bool shouldClearLabels = false;
 
+  bool _useLegacyNormalization = false;
+
   final ValueNotifier<int> _currentScrolledDuration = ValueNotifier(0);
 
+  /// A class having controls for recording audio and other useful handlers.
+  ///
+  /// Use [useLegacyNormalization] parameter to use normalization before
+  /// 1.0.0 release.
+  RecorderController({bool useLegacyNormalization = false}) {
+    _useLegacyNormalization = useLegacyNormalization;
+  }
+
   /// A ValueNotifier which provides current position of scrolled waveform with
   /// respect to [middle line].
   ///
@@ -85,7 +102,7 @@ class RecorderController extends ChangeNotifier {
   /// it's documentation for more info.
   ///
   /// Path parameter is optional and if not provided current datetime
-  /// will be used for file name and default extension will be .aac.
+  /// will be used for file name and default extension will be .m4a.
   ///
   /// Below is the example format to save file with custom name and
   /// extension.
@@ -141,6 +158,7 @@ class RecorderController extends ChangeNotifier {
             sampleRate: sampleRate ?? this.sampleRate,
             bitRate: bitRate ?? this.bitRate,
             path: path,
+            useLegacyNormalization: _useLegacyNormalization,
           );
           if (_isRecording) {
             _recorderState = RecorderState.recording;
@@ -272,12 +290,33 @@ class RecorderController extends ChangeNotifier {
           _recorderState = RecorderState.stopped;
           throw "Failed to get sound level";
         }
-        _normalise(db);
+        if (_useLegacyNormalization) {
+          _normaliseLegacy(db);
+        } else {
+          _normalise(db);
+        }
         notifyListeners();
       },
     );
   }
 
+  /// This is normalization is used before 1.0.0 release. From user
+  /// feedback we have brought it back util we find better way to normalise
+  /// db.
+  void _normaliseLegacy(double peak) {
+    if (Platform.isAndroid) {
+      waveData.add(peak - normalizationFactor);
+    } else {
+      if (peak == 0.0) {
+        waveData.add(0);
+      } else if (peak + normalizationFactor < 1) {
+        waveData.add(0);
+      } else {
+        waveData.add(peak + normalizationFactor);
+      }
+    }
+  }
+
   /// Normalises the peak power for ios and peak amplitude for android
   void _normalise(double peak) {
     final absDb = peak.abs();
diff --git a/pubspec.yaml b/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ object Constants {`
`61`	`61`	`const val noOfSamples = "noOfSamples"`
`62`	`62`	`const val onCurrentExtractedWaveformData = "onCurrentExtractedWaveformData"`
`63`	`63`	`const val waveformData = "waveformData"`
	`64`	`+ const val useLegacyNormalization = "useLegacyNormalization"`
`64`	`65`	`}`
`65`	`66`
`66`	`67`	`enum class FinishMode(val value:Int) {`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@ struct Constants {`
`55`	`55`	`static let onCurrentExtractedWaveformData = "onCurrentExtractedWaveformData"`
`56`	`56`	`static let waveformData = "waveformData"`
`57`	`57`	`static let onExtractionProgressUpdate = "onExtractionProgressUpdate"`
	`58`	`+ static let useLegacyNormalization = "useLegacyNormalization"`
`58`	`59`	`}`
`59`	`60`
`60`	`61`	`enum FinishMode : Int{`