Merge pull request #292 from shiguredo/feature/audio-hard-mute

音声ソフトミュート/ハードミュート機能追加

Author: t-miya

CHANGES.md

@@ -11,14 +11,27 @@
 
 ## develop
 
-- [UPDATE] libwebrtc m144.7559.0.1 に上げる
-  - @miosakuma @zztkm
+- [UPDATE] libwebrtc m144.7559.2.1 に上げる
+  - @t-miya
 - [UPDATE] Statistics, StatisticsEntry をドキュメント対象として公開する
   - `getStats` メソッドの返り値である `Statistics` のドキュメントを生成するため
   - @t-miya
 - [UPDATE] Configuration.simulcastRid を非推奨にする
   - 移行先は `Configuration.simulcastRequestRid`
   - @zztkm
+- [ADD] MediaChannel に `setAudioSoftMute(_:)` を追加する
+  - 音声ソフトミュート機能のシンタックスシュガー
+  - 送信ストリームの AudioTrack を取得し、MediaStream.audioEnabled を切り替える
+  - AudioTrack の有無判定を行うため、 MediaStream に `hasAudioTrack` を追加する
+  - @t-miya
+- [ADD] 音声のハードミュート有効化/無効化機能を追加する
+  - iOS 端末のマイクインジケーターを消灯させる
+  - AudioDeviceModuleWrapper クラスを追加する
+    - RTCAudioDeviceModule の pauseRecording/resumeRecording を実行するためのラッパークラス
+    - インスタンスは NativePeerChannelFactory が保持する
+  - MediaChannel に setAudioHardMute(_:) を追加する
+    - 内部で NativePeerChannelFactory 経由で AudioDeviceModuleWrapper.setAudioHardMute(_:) を呼び出す
+  - @t-miya
 - [ADD] MediaChannel に libwebrtc の統計情報を取得する `getStats` メソッドを追加する
   - @t-miya
 - [ADD] RTCAudioTrack から音声データを受け取るためのコールバックプロトコルである RTCAudioTrackSink を追加する

Package.swift

@@ -3,7 +3,7 @@
 import Foundation
 import PackageDescription
 
-let libwebrtcVersion = "m144.7559.0.1"
+let libwebrtcVersion = "m144.7559.2.1"
 
 let package = Package(
     name: "Sora",
@@ -21,7 +21,7 @@ let package = Package(
         .binaryTarget(
             name: "WebRTC",
             url: "https://github.com/shiguredo-webrtc-build/webrtc-build/releases/download/\(libwebrtcVersion)/WebRTC.xcframework.zip",
-            checksum: "7429661f35274871f28b74c8b7105c6cc9c899c98fc5f6b08e59ec0aece8e529"
+            checksum: "610c342f3e8f6199e2b6672fd3e6102876cbd2a131470ef0077de7b3a895d011"
         ),
         .target(
             name: "Sora",

Sora/AudioDeviceModuleWrapper.swift

@@ -0,0 +1,46 @@
+import Foundation
+import WebRTC
+
+/// RTCAudioDeviceModule の録音ポーズ/再開をラップするクラス
+internal final class AudioDeviceModuleWrapper {
+  private let audioDeviceModule: RTCAudioDeviceModule
+  // ハードミュート処理を直列化するためのキュー
+  private let queue = DispatchQueue(label: "jp.shiguredo.sora.audio.device.wrapper")
+  // 現在のハードミュート状態
+  private var isHardMuted: Bool = false
+
+  init(audioDeviceModule: RTCAudioDeviceModule) {
+    self.audioDeviceModule = audioDeviceModule
+  }
+
+  /// 音声のハードミュート有効化/無効化します
+  /// - Parameter mute: `true` でミュート有効化、`false` でミュート無効化
+  /// - Returns: 成功した場合は `true`、失敗した場合は `false` を返します
+  func setAudioHardMute(_ mute: Bool) -> Bool {
+    queue.sync {
+      guard isHardMuted != mute else {
+        return true
+      }
+
+      let internalResult = mute ? pauseRecordingInternal() : resumeRecordingInternal()
+      let message = "setAudioHardMute via RTCAudioDeviceModule mute=\(mute)"
+      let result = internalResult == 0
+      if result {
+        isHardMuted = mute
+        Logger.debug(type: .mediaChannel, message: message)
+        return true
+      } else {
+        Logger.error(type: .mediaChannel, message: "\(message) failed")
+        return false
+      }
+    }
+  }
+
+  private func pauseRecordingInternal() -> Int32 {
+    Int32(audioDeviceModule.pauseRecording())
+  }
+
+  private func resumeRecordingInternal() -> Int32 {
+    Int32(audioDeviceModule.resumeRecording())
+  }
+}

Sora/MediaChannel.swift

@@ -521,6 +521,53 @@ public final class MediaChannel {
     return result
       ? nil : SoraError.messagingError(reason: "failed to send message: label => \(label)")
   }
+
+  /// MediaChannel の接続中にマイクをハードミュート有効化/無効化します
+  /// - Parameter mute: `true` で有効化、`false` で無効化
+  /// - Returns: 成功した場合は `nil`、失敗した場合は `Error` を返します
+  public func setAudioHardMute(_ mute: Bool) -> Error? {
+    guard state == .connected else {
+      return SoraError.mediaChannelError(
+        reason: "MediaChannel is not connected (state: \(state))")
+    }
+
+    guard configuration.audioEnabled else {
+      return SoraError.mediaChannelError(reason: "audioEnabled is false")
+    }
+
+    if !NativePeerChannelFactory.default.audioDeviceModuleWrapper.setAudioHardMute(mute) {
+      return SoraError.mediaChannelError(
+        reason: "AudioDeviceModuleWrapper::setAudioHardMute failed")
+    }
+
+    return nil
+  }
+
+  /// MediaChannel の接続中にマイクをソフトミュート有効化 / 無効化します
+  /// - Parameter mute: `true` で有効化、`false` で無効化
+  /// - Returns: 成功した場合は `nil`、失敗した場合は `Error` を返します
+  public func setAudioSoftMute(_ mute: Bool) -> Error? {
+    guard state == .connected else {
+      return SoraError.mediaChannelError(
+        reason: "MediaChannel is not connected (state: \(state))")
+    }
+
+    guard configuration.audioEnabled else {
+      return SoraError.mediaChannelError(reason: "audioEnabled is false")
+    }
+
+    guard let senderStream else {
+      return SoraError.mediaChannelError(reason: "senderStream is unavailable")
+    }
+
+    guard senderStream.hasAudioTrack else {
+      return SoraError.mediaChannelError(reason: "senderStream has no AudioTrack")
+    }
+
+    senderStream.audioEnabled = !mute
+    Logger.debug(type: .mediaChannel, message: "setAudioSoftMute mute=\(mute)")
+    return nil
+  }
 }
 
 extension MediaChannel: CustomStringConvertible {

Sora/MediaStream.swift

@@ -59,6 +59,11 @@ public protocol MediaStream: AnyObject {
   /// サーバーへの送受信を停止しても、マイクはミュートされませんので注意してください。
   var audioEnabled: Bool { get set }
 
+  /// 音声トラックを保持している場合は ``true`` を返します。
+  ///
+  /// SDK 内部で利用する判定用のプロパティです。
+  var hasAudioTrack: Bool { get }
+
   /// 受信した音声のボリューム。 0 から 10 (含む) までの値をセットします。
   /// このプロパティはロールがサブスクライバーの場合のみ有効です。
   var remoteAudioVolume: Double? { get set }
@@ -197,6 +202,10 @@ class BasicMediaStream: MediaStream {
     }
   }
 
+  var hasAudioTrack: Bool {
+    nativeAudioTrack != nil
+  }
+
   var remoteAudioVolume: Double? {
     get {
       nativeAudioTrack?.source.volume

Sora/NativePeerChannelFactory.swift

@@ -33,18 +33,26 @@ class WrapperVideoEncoderFactory: NSObject, RTCVideoEncoderFactory {
 class NativePeerChannelFactory {
   static var `default` = NativePeerChannelFactory()
 
+  let audioDeviceModule: RTCAudioDeviceModule
+  /// 録音ポーズ/再開制御用に保持する ADM ラッパー
+  let audioDeviceModuleWrapper: AudioDeviceModuleWrapper
+
   var nativeFactory: RTCPeerConnectionFactory
 
   init() {
     Logger.debug(type: .peerChannel, message: "create native peer channel factory")
 
+    audioDeviceModule = RTCAudioDeviceModule()
+    audioDeviceModuleWrapper = AudioDeviceModuleWrapper(audioDeviceModule: audioDeviceModule)
+
     // 映像コーデックのエンコーダーとデコーダーを用意する
     let encoder = WrapperVideoEncoderFactory.shared
     let decoder = RTCDefaultVideoDecoderFactory()
     nativeFactory =
       RTCPeerConnectionFactory(
         encoderFactory: encoder,
-        decoderFactory: decoder)
+        decoderFactory: decoder,
+        audioDeviceModule: audioDeviceModule)
 
     for info in encoder.supportedCodecs() {
       Logger.debug(

Sora/SoraError.swift

@@ -33,6 +33,9 @@ public enum SoraError: Error {
   /// ``PeerChannel`` で発生したエラー
   case peerChannelError(reason: String)
 
+  /// ``MediaChannel`` で発生したエラー
+  case mediaChannelError(reason: String)
+
   /// カメラに関するエラー
   case cameraError(reason: String)
 
@@ -74,6 +77,8 @@ extension SoraError: LocalizedError {
       return "Unknown signaling message type \(type)"
     case .peerChannelError(let reason):
       return "PeerChannel error (\(reason))"
+    case .mediaChannelError(let reason):
+      return "MediaChannel error (\(reason))"
     case .cameraError(let reason):
       return "Camera error: \(reason)"
     case .messagingError(let reason):