fix: 🐛Update codec issue while recording audio on android (#391)

Co-authored-by: Manoj Padiya <“[email protected]”>

Author: manoj-simform

CHANGELOG.md

@@ -3,6 +3,8 @@
 - Fixed [#386](https://github.com/SimformSolutionsPvtLtd/audio_waveforms/pull/386) - On permission denied isRecording flag changed
 - Fixed [#384](https://github.com/SimformSolutionsPvtLtd/audio_waveforms/issues/384) - Provide a callback of drag,tap,start and end details on user gesture
 - Fixed [#309](https://github.com/SimformSolutionsPvtLtd/audio_waveforms/issues/309) - Added support for Liner PCM codec in iOS
+- Fixed [#291](https://github.com/SimformSolutionsPvtLtd/audio_waveforms/issues/291) - Codec issue while recording audio on android
+- Fixed wrong codec selection on the platform side on both Android and iOS.
 
 ## 1.2.0
 

README.md

@@ -133,7 +133,7 @@ Widget build(BuildContext context) {
 #### Function to control recording and waveforms
 1. record
    ```dart
-   recorderController.record(); // If path isn't provided by default sets current date time as file name m4a is used as file extension.
+   recorderController.record(); // If a path isn't provided, by default, the current date and time are set as the file name; m4a is used as the file extension.
    ```
 2. pause
    ```dart
@@ -174,9 +174,9 @@ Widget build(BuildContext context) {
    Reported duration is in **milliseconds**.
 #### Other available parameters
 ```dart
-recorderController.waveData; // The waveform data in form of normalised peak power for Ios and normalised peak amplitude for Android. The values are between 0.0 and 1.0.
+recorderController.waveData; // The waveform data is in the form of normalized peak power for iOS and normalized peak amplitude for Android. The values are between 0.0 and 1.0.
 recorderController.elapsedDuration; // Recorded duration of the file.
-recorderController.recordedDuration; // Duration of recorded audio file when recording has been stopped. Until recording has been stopped, this duration will be zero(Duration.zero). Also, once new recording is started this duration will be reset to zero.
+recorderController.recordedDuration; // Duration of recorded audio file when recording has been stopped. Until recording has been stopped, this duration will be zero (Duration.zero). Also, once a new recording is started, this duration will be reset to zero.
 recorderController.hasPermission; // If we have microphone permission or not.
 recorderController.isRecording; // If the recorder is currently recording.
 recorderController.recorderState; // Current state of the recorder.
@@ -301,16 +301,16 @@ AudioFileWaveforms(
 
 #### Listening to events from the player
 ```dart
-playerController.onPlayerStateChanged.listen((state) {}); // Provides events when the player state changes.
-playerController.onCurrentDurationChanged.listen((duration) {}); // Provides events when audio is sought to any duration.
+playerController.onPlayerStateChanged.listen((state) {}); // Triggers events when the player state changes.
+playerController.onCurrentDurationChanged.listen((duration) {}); // Triggers events when the audio playback position is adjusted to a specific duration.
 playerController.onCurrentExtractedWaveformData.listen((data) {}); // Provides latest data while extracting the waveforms.
 playerController.onExtractionProgress.listen((progress) {}); // Provides progress of the waveform extractions.
-playerController.onCompletion.listen((_){}); // Provides events every time audio file is finished playing.  
+playerController.onCompletion.listen((_){}); // Triggers events every time when an audio file is finished playing.  
 ```
 #### Getting the current or maximum duration of the audio file
 ```dart
 final fileLengthInDuration = await playerController.getDuration(DurationType.max);
-final currentDuration = await playerController.getDuration(DurationType.current); // This is where file is paused or an in progress audio files current duration.
+final currentDuration = await playerController.getDuration(DurationType.current); // Provides the current duration where the file is in a paused or in-progress state.
 ```
 #### The types of waveforms
 1. fitWidth
@@ -346,7 +346,7 @@ final currentDuration = await playerController.getDuration(DurationType.current)
 ```dart
 playerController.updateFrequency = UpdateFrequency.high;
 ```
-There are 3 modes low, medium and high. Setting **updateFrequency** to `high` will update current progress of the playing file faster(every 50ms) which will mame waveform seek animation smooth and `low` makes slower(every 200ms) which could make seek animation a little laggy. You can update this according to device configuration.
+There are 3 modes low, medium and high. Setting **updateFrequency** to `high` will update current progress of the playing file faster(every 50ms) which will make waveform seek animation smooth and `low` makes slower(every 200ms) which could make seek animation a little laggy. You can update this according to device configuration.
 
 #### Releasing resources of native player
 ```dart

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

@@ -38,23 +38,19 @@ class AudioRecorder : PluginRegistry.RequestPermissionsResultListener {
     }
 
     fun initRecorder(
-        path: String,
         result: MethodChannel.Result,
         recorder: MediaRecorder?,
-        encoder: Int,
-        outputFormat: Int,
-        sampleRate: Int,
-        bitRate: Int?
+        recorderSettings: RecorderSettings
     ) {
         recorder?.apply {
             setAudioSource(MediaRecorder.AudioSource.MIC)
-            setOutputFormat(getOutputFormat(outputFormat))
-            setAudioEncoder(getEncoder(encoder))
-            setAudioSamplingRate(sampleRate)
-            if (bitRate != null) {
-                setAudioEncodingBitRate(bitRate)
+            setOutputFormat(getOutputFormat(recorderSettings.outputFormat))
+            setAudioEncoder(getEncoder(recorderSettings.encoder))
+            setAudioSamplingRate(recorderSettings.sampleRate)
+            if (recorderSettings.bitRate != null) {
+                setAudioEncodingBitRate(recorderSettings.bitRate)
             }
-            setOutputFile(path)
+            setOutputFile(recorderSettings.path)
             try {
                 recorder.prepare()
                 result.success(true)

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

@@ -27,11 +27,7 @@ class AudioWaveformsPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     private var recorder: MediaRecorder? = null
     private var activity: Activity? = null
     private lateinit var audioRecorder: AudioRecorder
-    private var path: String? = null
-    private var encoder: Int = 0
-    private var outputFormat: Int = 0
-    private var sampleRate: Int = 44100
-    private var bitRate: Int? = null
+    private var recorderSettings = RecorderSettings(path = null, bitRate = null)
     private lateinit var applicationContext: Context
     private var audioPlayers = mutableMapOf<String, AudioPlayer?>()
     private var extractors = mutableMapOf<String, WaveformExtractor?>()
@@ -48,12 +44,19 @@ class AudioWaveformsPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     override fun onMethodCall(@NonNull call: MethodCall, @NonNull result: Result) {
         when (call.method) {
             Constants.initRecorder -> {
-                path = call.argument(Constants.path) as String?
-                encoder = (call.argument(Constants.encoder) as Int?) ?: 0
-                outputFormat = (call.argument(Constants.outputFormat) as Int?) ?: 0
-                sampleRate = (call.argument(Constants.sampleRate) as Int?) ?: 44100
-                bitRate = (call.argument(Constants.bitRate) as Int?)
-                checkPathAndInitialiseRecorder(result, encoder, outputFormat, sampleRate, bitRate)
+                val arguments = call.arguments;
+                if (arguments != null && arguments is Map<*, *>) {
+                    @Suppress("UNCHECKED_CAST")
+                    recorderSettings =
+                        RecorderSettings.fromJson(json = arguments as Map<String, Any?>)
+
+                    checkPathAndInitialiseRecorder(
+                        result,
+                        recorderSettings
+                    )
+                } else {
+                    result.error(Constants.LOG_TAG, "Failed to initialise Recorder", "Invalid Arguments")
+                }
             }
 
             Constants.startRecording -> {
@@ -63,7 +66,11 @@ class AudioWaveformsPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
             }
 
             Constants.stopRecording -> {
-                audioRecorder.stopRecording(result, recorder, path!!)
+                audioRecorder.stopRecording(
+                    result,
+                    recorder,
+                    recorderSettings.path!!
+                )
                 recorder = null
             }
 
@@ -79,10 +86,10 @@ class AudioWaveformsPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
                 if (key != null) {
                     initPlayer(key)
                     audioPlayers[key]?.preparePlayer(
-                            result,
-                            audioPath,
-                            volume?.toFloat(),
-                            frequency?.toLong(),
+                        result,
+                        audioPath,
+                        volume?.toFloat(),
+                        frequency?.toLong(),
                     )
                 } else {
                     result.error(Constants.LOG_TAG, "Player key can't be null", "")
@@ -207,46 +214,36 @@ class AudioWaveformsPlugin : FlutterPlugin, MethodCallHandler, ActivityAware {
     }
 
     private fun checkPathAndInitialiseRecorder(
-            result: Result,
-            encoder: Int,
-            outputFormat: Int,
-            sampleRate: Int,
-            bitRate: Int?
+        result: Result,
+        recorderSettings: RecorderSettings
     ) {
         try {
             recorder = MediaRecorder()
         } catch (e: Exception) {
             Log.e(Constants.LOG_TAG, "Failed to initialise Recorder")
         }
-        if (path == null) {
+        if (recorderSettings.path == null) {
             val outputDir = activity?.cacheDir
             val outputFile: File?
-            val dateTimeInstance = SimpleDateFormat(Constants.fileNameFormat, Locale.US)
+            val dateTimeInstance =
+                SimpleDateFormat(Constants.fileNameFormat, Locale.US)
             val currentDate = dateTimeInstance.format(Date())
             try {
                 outputFile = File.createTempFile(currentDate, ".m4a", outputDir)
-                path = outputFile.path
+                recorderSettings.path = outputFile.path
                 audioRecorder.initRecorder(
-                        path!!,
-                        result,
-                        recorder,
-                        encoder,
-                        outputFormat,
-                        sampleRate,
-                        bitRate
+                    result,
+                    recorder,
+                    recorderSettings,
                 )
             } catch (e: IOException) {
                 Log.e(Constants.LOG_TAG, "Failed to create file")
             }
         } else {
             audioRecorder.initRecorder(
-                    path!!,
-                    result,
-                    recorder,
-                    encoder,
-                    outputFormat,
-                    sampleRate,
-                    bitRate
+                result,
+                recorder,
+                recorderSettings,
             )
         }
     }

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

@@ -0,0 +1,21 @@
+package com.simform.audio_waveforms
+
+data class RecorderSettings(
+    var path: String?,
+    val encoder: Int = 0,
+    val outputFormat: Int = 0,
+    val sampleRate: Int = 44100,
+    val bitRate: Int?
+) {
+    companion object {
+        fun fromJson(json: Map<String, Any?>): RecorderSettings {
+            return RecorderSettings(
+                path = json[Constants.path] as String?,
+                encoder = (json[Constants.encoder] as Int?) ?: 0,
+                outputFormat = (json[Constants.outputFormat] as Int?) ?: 0,
+                sampleRate = (json[Constants.sampleRate] as Int?) ?: 44100,
+                bitRate = json[Constants.bitRate] as Int?
+            )
+        }
+    }
+}

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

@@ -22,23 +22,23 @@ object Constants {
 
 
     /** encoder */
-    const val acc = 1
-    const val aac_eld = 2
-    const val he_aac = 3
-    const val opus = 6
-    const val vorbis = 7
+    const val acc = 0
+    const val aac_eld = 1
+    const val he_aac = 2
+    const val opus = 5
+    const val vorbis = 6
 
     /** output format */
-    const val mpeg4 = 1
-    const val three_gpp = 2
-    const val ogg = 3
-    const val webm = 6
-    const val mpeg_2_ts = 7
-    const val aac_adts = 8
+    const val mpeg4 = 0
+    const val three_gpp = 1
+    const val ogg = 2
+    const val webm = 5
+    const val mpeg_2_ts = 6
+    const val aac_adts = 7
 
     /** common */
-    const val amr_nb = 4
-    const val amr_wb = 5
+    const val amr_nb = 3
+    const val amr_wb = 4
 
     const val preparePlayer = "preparePlayer"
     const val startPlayer = "startPlayer"

lib/src/controllers/player_controller.dart

@@ -223,7 +223,7 @@ class PlayerController extends ChangeNotifier {
     notifyListeners();
   }
 
-  /// A function to stop player. After calling this.
+  /// A function to stop player.
   Future<void> stopPlayer() async {
     final isStopped =
         await AudioWaveformsInterface.instance.stopPlayer(playerKey);