LocalAudioTrack.kt
6.0 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
/*
* Copyright 2023-2024 LiveKit, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.livekit.android.room.track
import android.Manifest
import android.content.Context
import android.content.pm.PackageManager
import androidx.core.content.ContextCompat
import dagger.assisted.Assisted
import dagger.assisted.AssistedFactory
import dagger.assisted.AssistedInject
import io.livekit.android.audio.AudioProcessingController
import io.livekit.android.dagger.InjectionNames
import io.livekit.android.room.participant.LocalParticipant
import io.livekit.android.util.FlowObservable
import io.livekit.android.util.flow
import io.livekit.android.util.flowDelegate
import io.livekit.android.webrtc.peerconnection.executeBlockingOnRTCThread
import kotlinx.coroutines.CoroutineDispatcher
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.SupervisorJob
import kotlinx.coroutines.flow.SharingStarted
import kotlinx.coroutines.flow.combine
import kotlinx.coroutines.flow.map
import kotlinx.coroutines.flow.stateIn
import livekit.LivekitModels.AudioTrackFeature
import livekit.org.webrtc.MediaConstraints
import livekit.org.webrtc.PeerConnectionFactory
import livekit.org.webrtc.RtpSender
import livekit.org.webrtc.RtpTransceiver
import java.util.UUID
import javax.inject.Named
/**
* Represents a local audio track (generally using the microphone as input).
*
* This class should not be constructed directly, but rather through [LocalParticipant.createAudioTrack].
*/
class LocalAudioTrack
@AssistedInject
constructor(
@Assisted name: String,
@Assisted mediaTrack: livekit.org.webrtc.AudioTrack,
@Assisted private val options: LocalAudioTrackOptions,
private val audioProcessingController: AudioProcessingController,
@Named(InjectionNames.DISPATCHER_DEFAULT)
private val dispatcher: CoroutineDispatcher,
) : AudioTrack(name, mediaTrack) {
/**
* To only be used for flow delegate scoping, and should not be cancelled.
**/
private val delegateScope = CoroutineScope(dispatcher + SupervisorJob())
var enabled: Boolean
get() = executeBlockingOnRTCThread { rtcTrack.enabled() }
set(value) {
executeBlockingOnRTCThread { rtcTrack.setEnabled(value) }
}
internal var transceiver: RtpTransceiver? = null
internal val sender: RtpSender?
get() = transceiver?.sender
/**
* Changes can be observed by using [io.livekit.android.util.flow]
*/
@FlowObservable
@get:FlowObservable
val features by flowDelegate(
stateFlow = combine(
audioProcessingController::capturePostProcessor.flow,
audioProcessingController::bypassCapturePostProcessing.flow,
) { processor, bypass ->
processor to bypass
}
.map {
val features = getConstantFeatures()
val (processor, bypass) = it
if (!bypass && processor?.getName() == "krisp_noise_cancellation") {
features.add(AudioTrackFeature.TF_ENHANCED_NOISE_CANCELLATION)
}
return@map features
}
.stateIn(delegateScope, SharingStarted.Eagerly, emptySet()),
)
private fun getConstantFeatures(): MutableSet<AudioTrackFeature> {
val features = mutableSetOf<AudioTrackFeature>()
if (options.echoCancellation) {
features.add(AudioTrackFeature.TF_ECHO_CANCELLATION)
}
if (options.noiseSuppression) {
features.add(AudioTrackFeature.TF_NOISE_SUPPRESSION)
}
if (options.autoGainControl) {
features.add(AudioTrackFeature.TF_AUTO_GAIN_CONTROL)
}
// TODO: Handle getting other info from JavaAudioDeviceModule
return features
}
companion object {
internal fun createTrack(
context: Context,
factory: PeerConnectionFactory,
options: LocalAudioTrackOptions = LocalAudioTrackOptions(),
audioTrackFactory: Factory,
name: String = "",
): LocalAudioTrack {
if (ContextCompat.checkSelfPermission(context, Manifest.permission.RECORD_AUDIO) !=
PackageManager.PERMISSION_GRANTED
) {
throw SecurityException("Record audio permissions are required to create an audio track.")
}
val audioConstraints = MediaConstraints()
val items = listOf(
MediaConstraints.KeyValuePair("googEchoCancellation", options.echoCancellation.toString()),
MediaConstraints.KeyValuePair("googAutoGainControl", options.autoGainControl.toString()),
MediaConstraints.KeyValuePair("googHighpassFilter", options.highPassFilter.toString()),
MediaConstraints.KeyValuePair("googNoiseSuppression", options.noiseSuppression.toString()),
MediaConstraints.KeyValuePair("googTypingNoiseDetection", options.typingNoiseDetection.toString()),
)
audioConstraints.optional.addAll(items)
val audioSource = factory.createAudioSource(audioConstraints)
val rtcAudioTrack =
factory.createAudioTrack(UUID.randomUUID().toString(), audioSource)
return audioTrackFactory.create(name = name, mediaTrack = rtcAudioTrack, options = options)
}
}
@AssistedFactory
interface Factory {
fun create(
name: String,
mediaTrack: livekit.org.webrtc.AudioTrack,
options: LocalAudioTrackOptions,
): LocalAudioTrack
}
}