feat: allow specifying use in android

Author: itsramiel

android/src/main/cpp/AudioEngine.cpp

@@ -8,7 +8,10 @@
 
 #include "audio/AAssetDataSource.h"
 
-SetupAudioStreamResult AudioEngine::setupAudioStream(double sampleRate, double channelCount) {
+SetupAudioStreamResult AudioEngine::setupAudioStream(
+        double sampleRate,
+        double channelCount,
+        int usage) {
     if(mAudioStream) {
         return { .error =  "Setting up an audio stream while one is already available"};
     }
@@ -18,6 +21,7 @@ SetupAudioStreamResult AudioEngine::setupAudioStream(double sampleRate, double c
 
     oboe::AudioStreamBuilder builder {};
 
+    builder.setUsage(getUsageFromInt(usage));
     builder.setFormat(oboe::AudioFormat::Float);
     builder.setFormatConversionAllowed(true);
     builder.setPerformanceMode(oboe::PerformanceMode::LowLatency);
@@ -185,3 +189,21 @@ void AudioEngine::unloadSounds(const std::optional<std::vector<std::string>> &id
         mPlayers.clear();
     }
 }
+
+oboe::Usage AudioEngine::getUsageFromInt(int usage) {
+    switch(usage) {
+        case 0: return oboe::Usage::Media;
+        case 1: return oboe::Usage::VoiceCommunication;
+        case 2: return oboe::Usage::VoiceCommunicationSignalling;
+        case 3: return oboe::Usage::Alarm;
+        case 4: return oboe::Usage::Notification;
+        case 5: return oboe::Usage::NotificationRingtone;
+        case 6: return oboe::Usage::NotificationEvent;
+        case 7: return oboe::Usage::AssistanceAccessibility;
+        case 8: return oboe::Usage::AssistanceNavigationGuidance;
+        case 9: return oboe::Usage::AssistanceSonification;
+        case 10: return oboe::Usage::Game;
+        case 11: return oboe::Usage::Assistant;
+        default: return oboe::Usage::Media;
+    }
+}

android/src/main/cpp/AudioEngine.h

@@ -16,7 +16,7 @@
 
 class AudioEngine : public oboe::AudioStreamDataCallback{
 public:
-    SetupAudioStreamResult setupAudioStream(double sampleRate, double channelCount);
+    SetupAudioStreamResult setupAudioStream(double sampleRate, double channelCount, int usage);
     OpenAudioStreamResult openAudioStream();
     PauseAudioStreamResult pauseAudioStream();
     CloseAudioStreamResult closeAudioStream();
@@ -34,6 +34,8 @@ class AudioEngine : public oboe::AudioStreamDataCallback{
     std::map<std::string, std::unique_ptr<Player>> mPlayers;
     int32_t mDesiredSampleRate{};
     int mDesiredChannelCount{};
+
+    oboe::Usage getUsageFromInt(int usage);
 };
 
 #endif //AUDIOPLAYBACK_AUDIOENGINE_H

android/src/main/cpp/native-lib.cpp

@@ -83,8 +83,13 @@ std::vector<std::string> jniStringArrayToStringVector(JNIEnv* env, jobjectArray
 
 extern "C" {
 JNIEXPORT jobject JNICALL
-Java_com_audioplayback_AudioPlaybackModule_setupAudioStreamNative(JNIEnv *env, jobject thiz, jdouble sample_rate, jdouble channel_count) {
-    auto result = audioEngine->setupAudioStream(sample_rate, channel_count);
+Java_com_audioplayback_AudioPlaybackModule_setupAudioStreamNative(
+        JNIEnv *env,
+        jobject thiz,
+        jdouble sample_rate,
+        jdouble channel_count,
+        jint usage) {
+    auto result = audioEngine->setupAudioStream(sample_rate, channel_count, usage);
 
     jclass structClass = env->FindClass("com/audioplayback/models/SetupAudioStreamResult");
     jmethodID constructor = env->GetMethodID(structClass, "<init>", "(Ljava/lang/String;)V");

android/src/main/java/com/audioplayback/AudioPlaybackModule.kt

@@ -13,6 +13,7 @@ import com.audioplayback.models.OpenAudioStreamResult
 import com.audioplayback.models.PauseAudioStreamResult
 import com.audioplayback.models.SetupAudioStreamResult
 import com.facebook.react.bridge.Arguments
+import com.facebook.react.bridge.ReadableMap
 import com.facebook.react.bridge.WritableMap
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
@@ -29,8 +30,12 @@ class AudioPlaybackModule internal constructor(context: ReactApplicationContext)
   }
 
   @ReactMethod(isBlockingSynchronousMethod = true)
-  override fun setupAudioStream(sampleRate: Double, channelCount: Double): WritableMap {
-    val result = setupAudioStreamNative(sampleRate, channelCount)
+  override fun setupAudioStream(options: ReadableMap): WritableMap {
+    val sampleRate = options.getDouble("sampleRate")
+    val channelCount = options.getDouble("channelCount")
+    val usage = options.getMap("android")!!.getInt("usage")
+
+    val result = setupAudioStreamNative(sampleRate, channelCount, usage)
     val map = Arguments.createMap()
     result.error?.let { map.putString("error", it) } ?: map.putNull("error")
     return map
@@ -185,7 +190,7 @@ class AudioPlaybackModule internal constructor(context: ReactApplicationContext)
     unloadSoundsNative(null)
   }
 
-  private external fun setupAudioStreamNative(sampleRate: Double, channelCount: Double): SetupAudioStreamResult
+  private external fun setupAudioStreamNative(sampleRate: Double, channelCount: Double, usage: Int): SetupAudioStreamResult
   private external fun openAudioStreamNative(): OpenAudioStreamResult
   private external fun pauseAudioStreamNative(): PauseAudioStreamResult
   private external fun closeAudioStreamNative(): CloseAudioStreamResult

example/Gemfile.lock

@@ -66,7 +66,7 @@ GEM
       netrc (~> 0.11)
     cocoapods-try (1.2.0)
     colored2 (3.1.2)
-    concurrent-ruby (1.3.4)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
     drb (2.2.1)
     escape (0.0.4)
@@ -110,6 +110,7 @@ PLATFORMS
 DEPENDENCIES
   activesupport (>= 6.1.7.5, != 7.1.0)
   cocoapods (>= 1.13, != 1.15.1, != 1.15.0)
+  concurrent-ruby (< 1.3.4)
   xcodeproj (< 1.26.0)
 
 RUBY VERSION

example/android/gradle.properties

@@ -32,7 +32,7 @@ reactNativeArchitectures=armeabi-v7a,arm64-v8a,x86,x86_64
 # your application. You should enable this flag either if you want
 # to write custom TurboModules/Fabric components OR use libraries that
 # are providing them.
-newArchEnabled=false
+newArchEnabled=true
 
 # Use this property to enable or disable the Hermes JS engine.
 # If set to false, you will be using JSC instead.

example/ios/Podfile.lock

@@ -1854,4 +1854,4 @@ SPEC CHECKSUMS:
 
 PODFILE CHECKSUM: 0de3c0d5ec96ef8679c10cf5c8e600381b2b0ac8
 
-COCOAPODS: 1.14.3
+COCOAPODS: 1.15.2

example/src/components/StreamControl.tsx

@@ -1,4 +1,7 @@
-import { AudioManager } from 'react-native-audio-playback';
+import {
+  AndroidAudioStreamUsage,
+  AudioManager,
+} from 'react-native-audio-playback';
 
 import { Button } from './Button';
 import { Section } from './Section';
@@ -9,7 +12,11 @@ interface StreamControlProps {
 
 export function StreamControl({ onLoadSounds }: StreamControlProps) {
   function onSetupStream() {
-    AudioManager.shared.setupAudioStream();
+    AudioManager.shared.setupAudioStream({
+      android: {
+        usage: AndroidAudioStreamUsage.Alarm,
+      },
+    });
   }
 
   function onOpenStream() {

src/NativeAudioPlayback.ts

@@ -1,22 +1,16 @@
 import type { TurboModule } from 'react-native';
 import { TurboModuleRegistry } from 'react-native';
 
-export enum IosAudioSessionCategory {
-  Ambient,
-  MultiRoute,
-  PlayAndRecord,
-  Playback,
-  Record,
-  SoloAmbient,
-}
-
 export interface Spec extends TurboModule {
   setupAudioStream: (options: {
     sampleRate: number;
     channelCount: number;
     ios: {
       audioSessionCategory: number;
     };
+    android: {
+      usage: number;
+    };
   }) => { error: string | null };
   openAudioStream: () => { error: string | null };
   pauseAudioStream: () => { error: string | null };

src/index.tsx

@@ -1,2 +1,2 @@
 export { AudioManager, Player } from './models';
-export { IosAudioSessionCategory } from './NativeAudioPlayback';
+export { IosAudioSessionCategory, AndroidAudioStreamUsage } from './types';