feat(core): audio: use AudioSource.CAMCORDER as the default audio source

Author: ThibaultBee

core/src/main/java/io/github/thibaultbee/streampack/core/elements/sources/audio/audiorecord/MicrophoneSource.kt

@@ -24,13 +24,17 @@ import android.os.Build
 import androidx.annotation.RequiresPermission
 import io.github.thibaultbee.streampack.core.elements.sources.audio.AudioSourceConfig
 import io.github.thibaultbee.streampack.core.elements.sources.audio.IAudioSourceInternal
+import io.github.thibaultbee.streampack.core.elements.utils.AudioSourceValue
 import java.util.UUID
 
 /**
  * The [MicrophoneSource] class is an implementation of [AudioRecordSource] that captures audio
  * from the microphone.
+ *
+ * @param audioSource The audio source to use (e.g., MediaRecorder.AudioSource.MIC).
  */
-internal class MicrophoneSource : AudioRecordSource() {
+internal class MicrophoneSource(@AudioSourceValue val audioSource: Int) :
+    AudioRecordSource() {
     @RequiresPermission(Manifest.permission.RECORD_AUDIO)
     override fun buildAudioRecord(config: AudioSourceConfig, bufferSize: Int): AudioRecord {
         return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
@@ -43,11 +47,11 @@ internal class MicrophoneSource : AudioRecordSource() {
             AudioRecord.Builder()
                 .setAudioFormat(audioFormat)
                 .setBufferSizeInBytes(bufferSize)
-                .setAudioSource(MediaRecorder.AudioSource.DEFAULT)
+                .setAudioSource(audioSource)
                 .build()
         } else {
             AudioRecord(
-                MediaRecorder.AudioSource.DEFAULT,
+                audioSource,
                 config.sampleRate,
                 config.channelConfig,
                 config.byteFormat,
@@ -60,16 +64,18 @@ internal class MicrophoneSource : AudioRecordSource() {
 /**
  * A factory to create a [MicrophoneSource].
  *
+ * @param audioSource the audio source to use (e.g., MediaRecorder.AudioSource.MIC)
  * @param effects a set of audio effects to apply to the audio source
  */
 class MicrophoneSourceFactory(
+    @AudioSourceValue val audioSource: Int = MediaRecorder.AudioSource.CAMCORDER,
     effects: Set<UUID> = defaultAudioEffects
 ) :
     AudioRecordSourceFactory(effects) {
-    override suspend fun createImpl(context: Context) = MicrophoneSource()
+    override suspend fun createImpl(context: Context) = MicrophoneSource(audioSource)
 
     override fun isSourceEquals(source: IAudioSourceInternal?): Boolean {
-        return source is MicrophoneSource
+        return source is MicrophoneSource && this.audioSource == source.audioSource
     }
 
     override fun toString(): String {

core/src/main/java/io/github/thibaultbee/streampack/core/elements/utils/Annotations.kt

@@ -3,6 +3,7 @@ package io.github.thibaultbee.streampack.core.elements.utils
 import android.hardware.camera2.CameraCharacteristics
 import android.media.AudioFormat
 import android.media.MediaFormat
+import android.media.MediaRecorder
 import android.os.Process
 import android.view.Surface
 import androidx.annotation.IntDef
@@ -85,7 +86,7 @@ annotation class ThreadPriorityValue
 
 
 /**
- * Valid thread priority values
+ * Valid lens facing direction values
  */
 @IntDef(
     CameraCharacteristics.LENS_FACING_BACK,
@@ -97,3 +98,22 @@ annotation class ThreadPriorityValue
 )
 annotation class Camera2FacingDirectionValue
 
+/**
+ * Valid audio source values
+ */
+@IntDef(
+    MediaRecorder.AudioSource.CAMCORDER,
+    MediaRecorder.AudioSource.DEFAULT,
+    MediaRecorder.AudioSource.MIC,
+    MediaRecorder.AudioSource.UNPROCESSED,
+    MediaRecorder.AudioSource.VOICE_CALL,
+    MediaRecorder.AudioSource.VOICE_COMMUNICATION,
+    MediaRecorder.AudioSource.VOICE_DOWNLINK,
+    MediaRecorder.AudioSource.VOICE_PERFORMANCE,
+    MediaRecorder.AudioSource.VOICE_RECOGNITION,
+    MediaRecorder.AudioSource.VOICE_UPLINK
+)
+@Retention(
+    AnnotationRetention.SOURCE
+)
+annotation class AudioSourceValue

core/src/test/java/io/github/thibaultbee/streampack/core/elements/sources/AudioCaptureUnitTest.kt

@@ -15,6 +15,7 @@
  */
 package io.github.thibaultbee.streampack.core.elements.sources
 
+import android.media.MediaRecorder
 import io.github.thibaultbee.streampack.core.elements.sources.audio.audiorecord.MicrophoneSource
 import io.github.thibaultbee.streampack.core.elements.utils.StubLogger
 import io.github.thibaultbee.streampack.core.elements.utils.StubRawFrameFactory
@@ -30,7 +31,7 @@ class MicrophoneSourceUnitTest {
 
     @Test
     fun `assert exception on bad state`() = runTest {
-        val microphoneSource = MicrophoneSource()
+        val microphoneSource = MicrophoneSource(MediaRecorder.AudioSource.CAMCORDER)
         try {
             microphoneSource.startStream()
             Assert.fail()
@@ -45,15 +46,15 @@ class MicrophoneSourceUnitTest {
 
     @Test
     fun `assert no exception on bad state`() = runTest {
-        val microphoneSource = MicrophoneSource()
+        val microphoneSource = MicrophoneSource(MediaRecorder.AudioSource.CAMCORDER)
         try {
             microphoneSource.stopStream()
-        } catch (t: Throwable) {
+        } catch (_: Throwable) {
             Assert.fail()
         }
         try {
             microphoneSource.release()
-        } catch (t: Throwable) {
+        } catch (_: Throwable) {
             Assert.fail()
         }
     }