Create a new method : startPlayerFromBuffer, to play from a buffer (Canardoux#170)

* Create a new method : startPlayerFromBuffer, to play from a memory buffer instead of a URL
* Add support for OPUS encoder on iOS.
* Actually on iOS, you can choose from two encoders :
   - AAC (this is the default)
   - CAF/OPUS
* Fix bug in example, when the user try to play from buffer but has not record anything with the recorder
* README : default path for Android
* Suppress superfluous spaces when calling a dart method
* Minor cosmetic fixes, after Hyo remarks

Author: Larpoux

README.md

@@ -43,9 +43,10 @@ On *Android* you need to add a permission to `AndroidManifest.xml`:
 | Func  | Param  | Return | Description |
 | :------------ |:---------------:| :---------------:| :-----|
 | setSubscriptionDuration | `double sec` | `String` message | Set subscription timer in seconds. Default is `0.01` if not using this method.|
-| startRecorder | `String uri`, `int sampleRate`, `int numChannels` | `String` uri | Start recording. This will return uri used. |
+| startRecorder | `String uri`, `int sampleRate`, `int numChannels`, t_CODEC codec | `String` uri | Start recording. This will return uri used. |
 | stopRecorder | | `String` message | Stop recording.  |
 | startPlayer | `String uri` | `String` message | Start playing.  |
+| startPlayerFromBuffer | `Uint8List dataBuffer` | `String` message | Start playing.  |
 | stopPlayer | | `String` message | Stop playing. |
 | pausePlayer | | `String` message | Pause playing. |
 | resumePlayer | | `String` message | Resume playing. |
@@ -61,7 +62,7 @@ On *Android* you need to add a permission to `AndroidManifest.xml`:
 ## Default uri path
 When uri path is not set during the `function call` in `startRecorder` or `startPlayer`, they are saved in below path depending on the platform.
 + Default path for android
-  * `sdcard/sound.aac`.
+  * `Library/Caches/sound.aac`.
 + Default path for ios
   * `sound.aac`.
 
@@ -91,6 +92,17 @@ If you want to take your own path specify it like below.
 ```
 String path = await flutterSound.startRecorder(Platform.isIOS ? 'ios.aac' : 'android.aac');
 ```
+Actually on iOS, you can choose from two encoders :
+- AAC (this is the default)
+- CAF/OPUS
+
+To encode with OPUS you do the following :
+```dart
+await flutterSound.startRecorder(null, codec: t_CODEC.CODEC_CAF_OPUS,)
+```
+Recently, Apple added a support for encoding with the standard OPUS codec. Unfortunetly, Apple encapsulates its data in its own proprietary envelope : CAF. This is really stupid, this is Apple
+
+On Android the OPUS codec is not yet supported by flutter_sound.
 
 #### Stop recorder
 ```dart
@@ -118,7 +130,8 @@ void dispose() {
 ```
 
 #### Start player
-To start playback of a recording call startPlayer.
+- To start playback of a record from a URL call startPlayer.
+- To start playback of a record from a memory buffer call startPlayerFromBuffer
 
 You must wait for the return value to complete before attempting to add any listeners
 to ensure that the player has fully initialised.

android/build.gradle

@@ -22,10 +22,10 @@ rootProject.allprojects {
 apply plugin: 'com.android.library'
 
 android {
-    compileSdkVersion 28
+    compileSdkVersion 29
 
     defaultConfig {
-        minSdkVersion 16
+        minSdkVersion 23
     }
     lintOptions {
         disable 'InvalidPackage'

android/src/main/java/com/dooboolab/fluttersound/AudioInterface.java

@@ -2,8 +2,20 @@
 
 import io.flutter.plugin.common.MethodChannel;
 
+// this enum MUST be synchronized with lib/flutter_sound.dart and ios/Classes/FlutterSoundPlugin.h
+enum t_CODEC
+{
+	   DEFAULT
+     , AAC
+     , OPUS
+     , CODEC_CAF_OPUS // Apple encapsulates its bits in its own special envelope : .caf instead of a regular ogg/opus (.opus). This is completely stupid, this is Apple.
+     , MP3
+     , VORBIS
+     , PCM
+}
+
 interface AudioInterface {
-  void startRecorder(Integer numChannels, Integer sampleRate, Integer bitRate, int androidEncoder, int androidAudioSource, int androidOutputFormat, String path, MethodChannel.Result result);
+  void startRecorder(Integer numChannels, Integer sampleRate, Integer bitRate, t_CODEC codec, int androidEncoder, int androidAudioSource, int androidOutputFormat, String path, MethodChannel.Result result);
   void stopRecorder(MethodChannel.Result result);
   void startPlayer(String path, MethodChannel.Result result);
   void stopPlayer(MethodChannel.Result result);
@@ -15,3 +27,4 @@ interface AudioInterface {
   void setDbPeakLevelUpdate(double intervalInSecs, MethodChannel.Result result);
   void setDbLevelEnabled(boolean enabled, MethodChannel.Result result);
 }
+  

android/src/main/java/com/dooboolab/fluttersound/AudioModel.java

@@ -5,7 +5,7 @@
 import android.os.Environment;
 
 public class AudioModel {
-  final public static String DEFAULT_FILE_LOCATION = Environment.getExternalStorageDirectory().getPath() + "/default.aac";
+  final public static String DEFAULT_FILE_LOCATION = Environment.getDataDirectory().getPath() + "/default.aac"; // SDK 29 : you may not write in getExternalStorageDirectory()
   public int subsDurationMillis = 10;
   public long peakLevelUpdateMillis = 800;
   public boolean shouldProcessDbLevel = true;

android/src/main/java/com/dooboolab/fluttersound/FlutterSoundPlugin.java

@@ -4,12 +4,15 @@
 import android.content.pm.PackageManager;
 import android.media.MediaPlayer;
 import android.media.MediaRecorder;
+import android.media.MediaDataSource;
 import android.os.Build;
+import android.os.Environment;
 import android.os.Handler;
 import android.os.SystemClock;
 import android.util.Log;
 import android.os.Environment;
 
+import io.flutter.util.PathUtils;
 import org.json.JSONException;
 import org.json.JSONObject;
 
@@ -65,9 +68,11 @@ public void onMethodCall(final MethodCall call, final Result result) {
           Integer numChannels = call.argument("numChannels");
           Integer bitRate = call.argument("bitRate");
           int androidEncoder = call.argument("androidEncoder");
+          int _codec = call.argument("codec");
+          t_CODEC codec = t_CODEC.values()[_codec];
           int androidAudioSource = call.argument("androidAudioSource");
           int androidOutputFormat = call.argument("androidOutputFormat");
-          startRecorder(numChannels, sampleRate, bitRate, androidEncoder, androidAudioSource, androidOutputFormat, path, result);
+          startRecorder(numChannels, sampleRate, bitRate, codec,  androidEncoder, androidAudioSource, androidOutputFormat, path, result);
         });
         break;
       case "stopRecorder":
@@ -76,6 +81,11 @@ public void onMethodCall(final MethodCall call, final Result result) {
       case "startPlayer":
         this.startPlayer(path, result);
         break;
+      case "startPlayerFromBuffer":
+        byte[] dataBuffer = call.argument("dataBuffer");
+        this.startPlayerFromBuffer(dataBuffer, result);
+        break;
+
       case "stopPlayer":
         this.stopPlayer(result);
         break;
@@ -124,8 +134,10 @@ public boolean onRequestPermissionsResult(int requestCode, String[] permissions,
     return false;
   }
 
+  int codecArray[] = {MediaRecorder.AudioEncoder.AAC, MediaRecorder.AudioEncoder.OPUS};
+
   @Override
-  public void startRecorder(Integer numChannels, Integer sampleRate, Integer bitRate, int androidEncoder, int androidAudioSource, int androidOutputFormat, String path, final Result result) {
+  public void startRecorder(Integer numChannels, Integer sampleRate, Integer bitRate, t_CODEC codec, int androidEncoder, int androidAudioSource, int androidOutputFormat, String path, final Result result) {
     if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
       if (
           reg.activity().checkSelfPermission(Manifest.permission.RECORD_AUDIO) != PackageManager.PERMISSION_GRANTED
@@ -140,17 +152,66 @@ public void startRecorder(Integer numChannels, Integer sampleRate, Integer bitRa
       }
     }
 
-    if (path == null) {
-      path = AudioModel.DEFAULT_FILE_LOCATION;
-    } else {
-      path = Environment.getExternalStorageDirectory().getPath() + "/" + path;
-    }
-
-    if (this.model.getMediaRecorder() == null) {
+    path = PathUtils.getDataDirectory(reg.context()) + "/" + path; // SDK 29 : you may not write in getExternalStorageDirectory() [LARPOUX]
+ 
+    if (this.model.getMediaRecorder() == null)
+    {
       this.model.setMediaRecorder(new MediaRecorder());
-      this.model.getMediaRecorder().setAudioSource(androidAudioSource);
-      this.model.getMediaRecorder().setOutputFormat(androidOutputFormat);
-      this.model.getMediaRecorder().setAudioEncoder(androidEncoder);
+    } else
+    {
+      this.model.getMediaRecorder().reset(); 
+    }
+    this.model.getMediaRecorder().setAudioSource(androidAudioSource);
+    int codecArray[] =
+            {
+                    0 // DEFAULT
+                    , MediaRecorder.AudioEncoder.AAC
+                    , MediaRecorder.AudioEncoder.OPUS
+                    , 0 // CODEC_CAF_OPUS (specific Apple)
+                    , 0 // CODEC_MP3 (not implemented)
+                    , 0 // CODEC_VORBIS (not implemented)
+                    , 0 // CODEC_PCM (not implemented)
+            };
+    int formatsArray[] =
+            {
+                      MediaRecorder.OutputFormat.MPEG_4 // DEFAULT
+                    , MediaRecorder.OutputFormat.MPEG_4 // CODEC_AAC
+                    , MediaRecorder.OutputFormat.OGG    // CODEC_OPUS
+                    , 0                                 // CODEC_CAF_OPUS (this is apple specific)
+                    , 0                                 // CODEC_MP3
+                    , MediaRecorder.OutputFormat.OGG    // CODEC_VORBIS
+                    , 0                                 // CODEC_PCM
+
+            };
+    if (codecArray[codec.ordinal()] != 0)
+    {
+      androidEncoder = codecArray[codec.ordinal()];
+      androidOutputFormat = formatsArray[codec.ordinal()];
+    }
+    this.model.getMediaRecorder().setOutputFormat (androidOutputFormat);
+    model.getMediaRecorder().setAudioEncoder(androidEncoder);
+
+    if (path == null)
+    {
+      switch(androidEncoder)
+      {
+        case MediaRecorder.AudioEncoder.AAC:
+          path = "sound.acc";
+          break;
+        case MediaRecorder.AudioEncoder.OPUS:
+          path = "sound.opus";
+          break;
+        case MediaRecorder.AudioEncoder.VORBIS:
+          path = "sound.ogg";
+          break;
+        case MediaRecorder.AudioEncoder.DEFAULT:
+          path = "sound.acc";
+          break; // ?
+        default:
+          path = "sound.acc";
+          break; // ?
+      }
+    }
 
       this.model.getMediaRecorder().setOutputFile(path);
 
@@ -165,7 +226,6 @@ public void startRecorder(Integer numChannels, Integer sampleRate, Integer bitRa
       // If bitrate is defined, then use it, otherwise use the OS default
       if (bitRate != null) {
         this.model.getMediaRecorder().setAudioEncodingBitRate(bitRate);
-      }
     }
 
     try {
@@ -264,9 +324,8 @@ public void run() {
 
   }
 
-  @Override
-  public void startPlayer(final String path, final Result result) {
-    if (this.model.getMediaPlayer() != null) {
+  public void _startPlayer(final String path, MediaDataSource dataBuffer, final Result result) {
+     if (this.model.getMediaPlayer() != null) {
       Boolean isPaused = !this.model.getMediaPlayer().isPlaying()
           && this.model.getMediaPlayer().getCurrentPosition() > 1;
 
@@ -285,6 +344,10 @@ public void startPlayer(final String path, final Result result) {
     mTimer = new Timer();
 
     try {
+      if (dataBuffer != null)
+      {
+        model.getMediaPlayer().setDataSource(dataBuffer);
+      } else
       if (path == null) {
         this.model.getMediaPlayer().setDataSource(AudioModel.DEFAULT_FILE_LOCATION);
       } else {
@@ -322,7 +385,12 @@ public void run() {
         };
 
         mTimer.schedule(mTask, 0, model.subsDurationMillis);
-        String resolvedPath = path == null ? AudioModel.DEFAULT_FILE_LOCATION : path;
+        String resolvedPath;
+        if (dataBuffer != null)
+        {
+          resolvedPath = "(From memory buffer)";
+        } else
+          resolvedPath = (path == null) ? AudioModel.DEFAULT_FILE_LOCATION : path;
         result.success((resolvedPath));
       });
       /*
@@ -357,6 +425,37 @@ public void run() {
     }
   }
 
+  @Override
+  public void startPlayer(final String path, final Result result)
+  {
+    _startPlayer(path, null, result) ;
+  }
+
+  public void startPlayerFromBuffer(final byte[] dataBuffer, final Result result)
+  {
+    class flutterSoundBuffer extends MediaDataSource
+    {
+      byte[] dataBuffer;
+      /* ctor */ flutterSoundBuffer(byte[] buffer){dataBuffer = buffer;}
+      public int readAt(long position, byte[] buffer, int offset, int size)
+      {
+        if (position > dataBuffer.length)
+          return -1; // end of buffer
+        long ln = size;
+        if (position + size > dataBuffer.length)
+          ln = dataBuffer.length - position;
+        System.arraycopy(dataBuffer, (int)position, buffer, offset, (int)ln);
+        return (int)ln;
+      }
+      public long getSize(){return dataBuffer.length;}
+      public void close(){dataBuffer = null;}
+    }
+
+    _startPlayer(null, new flutterSoundBuffer(dataBuffer), result) ;
+  }
+
+
+
   @Override
   public void stopPlayer(final Result result) {
     mTimer.cancel();

example/.flutter-plugins-dependencies

@@ -0,0 +1 @@
+{"_info":"// This is a generated file; do not edit or check into version control.","dependencyGraph":[{"name":"flutter_sound","dependencies":[]}]}

example/android/app/build.gradle

@@ -25,7 +25,7 @@ apply plugin: 'com.android.application'
 apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
 
 android {
-    compileSdkVersion 28
+    compileSdkVersion 29
 
     lintOptions {
         disable 'InvalidPackage'
@@ -34,8 +34,8 @@ android {
     defaultConfig {
         // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
         applicationId "com.dooboolab.fluttersoundexample"
-        minSdkVersion 16
-        targetSdkVersion 28
+        minSdkVersion 23
+        targetSdkVersion 29
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName
     }

example/android/build.gradle

@@ -5,7 +5,7 @@ buildscript {
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.4.0'
+        classpath 'com.android.tools.build:gradle:3.5.3'
     }
 }
 

example/android/gradle.properties

@@ -1 +1,2 @@
 org.gradle.jvmargs=-Xmx1536M
+android.enableR8=true

example/android/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
-#Thu May 09 09:01:19 CEST 2019
+#Fri Dec 13 14:24:13 CET 2019
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.1.1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.4.1-all.zip

example/android/res/values/strings_en.arb

@@ -0,0 +1 @@
+{}

example/ios/Flutter/Flutter.podspec

@@ -0,0 +1,18 @@
+#
+# NOTE: This podspec is NOT to be published. It is only used as a local source!
+#
+
+Pod::Spec.new do |s|
+  s.name             = 'Flutter'
+  s.version          = '1.0.0'
+  s.summary          = 'High-performance, high-fidelity mobile apps.'
+  s.description      = <<-DESC
+Flutter provides an easy and productive way to build and deploy high-performance mobile apps for Android and iOS.
+                       DESC
+  s.homepage         = 'https://flutter.io'
+  s.license          = { :type => 'MIT' }
+  s.author           = { 'Flutter Dev Team' => '[email protected]' }
+  s.source           = { :git => 'https://github.com/flutter/engine', :tag => s.version.to_s }
+  s.ios.deployment_target = '8.0'
+  s.vendored_frameworks = 'Flutter.framework'
+end