|
| 1 | +/* |
| 2 | + * Copyright 2016 The WebRTC Project Authors. All rights reserved. |
| 3 | + * |
| 4 | + * Use of this source code is governed by a BSD-style license |
| 5 | + * that can be found in the LICENSE file in the root of the source |
| 6 | + * tree. An additional intellectual property rights grant can be found |
| 7 | + * in the file PATENTS. All contributing project authors may |
| 8 | + * be found in the AUTHORS file in the root of the source tree. |
| 9 | + */ |
| 10 | + |
| 11 | +#import <AVFoundation/AVFoundation.h> |
| 12 | +#import <Foundation/Foundation.h> |
| 13 | + |
| 14 | +#import <WebRTC/RTCMacros.h> |
| 15 | + |
| 16 | +NS_ASSUME_NONNULL_BEGIN |
| 17 | + |
| 18 | +extern NSString *const kRTCAudioSessionErrorDomain; |
| 19 | +/** Method that requires lock was called without lock. */ |
| 20 | +extern NSInteger const kRTCAudioSessionErrorLockRequired; |
| 21 | +/** Unknown configuration error occurred. */ |
| 22 | +extern NSInteger const kRTCAudioSessionErrorConfiguration; |
| 23 | + |
| 24 | +@class RTC_OBJC_TYPE(RTCAudioSession); |
| 25 | +@class RTC_OBJC_TYPE(RTCAudioSessionConfiguration); |
| 26 | + |
| 27 | +// Surfaces AVAudioSession events. WebRTC will listen directly for notifications |
| 28 | +// from AVAudioSession and handle them before calling these delegate methods, |
| 29 | +// at which point applications can perform additional processing if required. |
| 30 | +RTC_OBJC_EXPORT |
| 31 | +@protocol RTC_OBJC_TYPE |
| 32 | +(RTCAudioSessionDelegate)<NSObject> |
| 33 | + |
| 34 | + @optional |
| 35 | +/** Called on a system notification thread when AVAudioSession starts an |
| 36 | + * interruption event. |
| 37 | + */ |
| 38 | +- (void)audioSessionDidBeginInterruption:(RTC_OBJC_TYPE(RTCAudioSession) *)session; |
| 39 | + |
| 40 | +/** Called on a system notification thread when AVAudioSession ends an |
| 41 | + * interruption event. |
| 42 | + */ |
| 43 | +- (void)audioSessionDidEndInterruption:(RTC_OBJC_TYPE(RTCAudioSession) *)session |
| 44 | + shouldResumeSession:(BOOL)shouldResumeSession; |
| 45 | + |
| 46 | +/** Called on a system notification thread when AVAudioSession changes the |
| 47 | + * route. |
| 48 | + */ |
| 49 | +- (void)audioSessionDidChangeRoute:(RTC_OBJC_TYPE(RTCAudioSession) *)session |
| 50 | + reason:(AVAudioSessionRouteChangeReason)reason |
| 51 | + previousRoute:(AVAudioSessionRouteDescription *)previousRoute; |
| 52 | + |
| 53 | +/** Called on a system notification thread when AVAudioSession media server |
| 54 | + * terminates. |
| 55 | + */ |
| 56 | +- (void)audioSessionMediaServerTerminated:(RTC_OBJC_TYPE(RTCAudioSession) *)session; |
| 57 | + |
| 58 | +/** Called on a system notification thread when AVAudioSession media server |
| 59 | + * restarts. |
| 60 | + */ |
| 61 | +- (void)audioSessionMediaServerReset:(RTC_OBJC_TYPE(RTCAudioSession) *)session; |
| 62 | + |
| 63 | +// TODO(tkchin): Maybe handle SilenceSecondaryAudioHintNotification. |
| 64 | + |
| 65 | +- (void)audioSession:(RTC_OBJC_TYPE(RTCAudioSession) *)session |
| 66 | + didChangeCanPlayOrRecord:(BOOL)canPlayOrRecord; |
| 67 | + |
| 68 | +/** Called on a WebRTC thread when the audio device is notified to begin |
| 69 | + * playback or recording. |
| 70 | + */ |
| 71 | +- (void)audioSessionDidStartPlayOrRecord:(RTC_OBJC_TYPE(RTCAudioSession) *)session; |
| 72 | + |
| 73 | +/** Called on a WebRTC thread when the audio device is notified to stop |
| 74 | + * playback or recording. |
| 75 | + */ |
| 76 | +- (void)audioSessionDidStopPlayOrRecord:(RTC_OBJC_TYPE(RTCAudioSession) *)session; |
| 77 | + |
| 78 | +/** Called when the AVAudioSession output volume value changes. */ |
| 79 | +- (void)audioSession:(RTC_OBJC_TYPE(RTCAudioSession) *)audioSession |
| 80 | + didChangeOutputVolume:(float)outputVolume; |
| 81 | + |
| 82 | +/** Called when the audio device detects a playout glitch. The argument is the |
| 83 | + * number of glitches detected so far in the current audio playout session. |
| 84 | + */ |
| 85 | +- (void)audioSession:(RTC_OBJC_TYPE(RTCAudioSession) *)audioSession |
| 86 | + didDetectPlayoutGlitch:(int64_t)totalNumberOfGlitches; |
| 87 | + |
| 88 | +/** Called when the audio session is about to change the active state. |
| 89 | + */ |
| 90 | +- (void)audioSession:(RTC_OBJC_TYPE(RTCAudioSession) *)audioSession willSetActive:(BOOL)active; |
| 91 | + |
| 92 | +/** Called after the audio session sucessfully changed the active state. |
| 93 | + */ |
| 94 | +- (void)audioSession:(RTC_OBJC_TYPE(RTCAudioSession) *)audioSession didSetActive:(BOOL)active; |
| 95 | + |
| 96 | +/** Called after the audio session failed to change the active state. |
| 97 | + */ |
| 98 | +- (void)audioSession:(RTC_OBJC_TYPE(RTCAudioSession) *)audioSession |
| 99 | + failedToSetActive:(BOOL)active |
| 100 | + error:(NSError *)error; |
| 101 | + |
| 102 | +@end |
| 103 | + |
| 104 | +/** This is a protocol used to inform RTCAudioSession when the audio session |
| 105 | + * activation state has changed outside of RTCAudioSession. The current known use |
| 106 | + * case of this is when CallKit activates the audio session for the application |
| 107 | + */ |
| 108 | +RTC_OBJC_EXPORT |
| 109 | +@protocol RTC_OBJC_TYPE |
| 110 | +(RTCAudioSessionActivationDelegate)<NSObject> |
| 111 | + |
| 112 | + /** Called when the audio session is activated outside of the app by iOS. */ |
| 113 | + - (void)audioSessionDidActivate : (AVAudioSession *)session; |
| 114 | + |
| 115 | +/** Called when the audio session is deactivated outside of the app by iOS. */ |
| 116 | +- (void)audioSessionDidDeactivate:(AVAudioSession *)session; |
| 117 | + |
| 118 | +@end |
| 119 | + |
| 120 | +/** Proxy class for AVAudioSession that adds a locking mechanism similar to |
| 121 | + * AVCaptureDevice. This is used to that interleaving configurations between |
| 122 | + * WebRTC and the application layer are avoided. |
| 123 | + * |
| 124 | + * RTCAudioSession also coordinates activation so that the audio session is |
| 125 | + * activated only once. See |setActive:error:|. |
| 126 | + */ |
| 127 | +RTC_OBJC_EXPORT |
| 128 | +@interface RTC_OBJC_TYPE (RTCAudioSession) : NSObject <RTC_OBJC_TYPE(RTCAudioSessionActivationDelegate)> |
| 129 | + |
| 130 | +/** Convenience property to access the AVAudioSession singleton. Callers should |
| 131 | + * not call setters on AVAudioSession directly, but other method invocations |
| 132 | + * are fine. |
| 133 | + */ |
| 134 | +@property(nonatomic, readonly) AVAudioSession *session; |
| 135 | + |
| 136 | +/** Our best guess at whether the session is active based on results of calls to |
| 137 | + * AVAudioSession. |
| 138 | + */ |
| 139 | +@property(nonatomic, readonly) BOOL isActive; |
| 140 | +/** Whether RTCAudioSession is currently locked for configuration. */ |
| 141 | +@property(nonatomic, readonly) BOOL isLocked; |
| 142 | + |
| 143 | +/** If YES, WebRTC will not initialize the audio unit automatically when an |
| 144 | + * audio track is ready for playout or recording. Instead, applications should |
| 145 | + * call setIsAudioEnabled. If NO, WebRTC will initialize the audio unit |
| 146 | + * as soon as an audio track is ready for playout or recording. |
| 147 | + */ |
| 148 | +@property(nonatomic, assign) BOOL useManualAudio; |
| 149 | + |
| 150 | +/** This property is only effective if useManualAudio is YES. |
| 151 | + * Represents permission for WebRTC to initialize the VoIP audio unit. |
| 152 | + * When set to NO, if the VoIP audio unit used by WebRTC is active, it will be |
| 153 | + * stopped and uninitialized. This will stop incoming and outgoing audio. |
| 154 | + * When set to YES, WebRTC will initialize and start the audio unit when it is |
| 155 | + * needed (e.g. due to establishing an audio connection). |
| 156 | + * This property was introduced to work around an issue where if an AVPlayer is |
| 157 | + * playing audio while the VoIP audio unit is initialized, its audio would be |
| 158 | + * either cut off completely or played at a reduced volume. By preventing |
| 159 | + * the audio unit from being initialized until after the audio has completed, |
| 160 | + * we are able to prevent the abrupt cutoff. |
| 161 | + */ |
| 162 | +@property(nonatomic, assign) BOOL isAudioEnabled; |
| 163 | + |
| 164 | +// Proxy properties. |
| 165 | +@property(readonly) NSString *category; |
| 166 | +@property(readonly) AVAudioSessionCategoryOptions categoryOptions; |
| 167 | +@property(readonly) NSString *mode; |
| 168 | +@property(readonly) BOOL secondaryAudioShouldBeSilencedHint; |
| 169 | +@property(readonly) AVAudioSessionRouteDescription *currentRoute; |
| 170 | +@property(readonly) NSInteger maximumInputNumberOfChannels; |
| 171 | +@property(readonly) NSInteger maximumOutputNumberOfChannels; |
| 172 | +@property(readonly) float inputGain; |
| 173 | +@property(readonly) BOOL inputGainSettable; |
| 174 | +@property(readonly) BOOL inputAvailable; |
| 175 | +@property(readonly, nullable) NSArray<AVAudioSessionDataSourceDescription *> *inputDataSources; |
| 176 | +@property(readonly, nullable) AVAudioSessionDataSourceDescription *inputDataSource; |
| 177 | +@property(readonly, nullable) NSArray<AVAudioSessionDataSourceDescription *> *outputDataSources; |
| 178 | +@property(readonly, nullable) AVAudioSessionDataSourceDescription *outputDataSource; |
| 179 | +@property(readonly) double sampleRate; |
| 180 | +@property(readonly) double preferredSampleRate; |
| 181 | +@property(readonly) NSInteger inputNumberOfChannels; |
| 182 | +@property(readonly) NSInteger outputNumberOfChannels; |
| 183 | +@property(readonly) float outputVolume; |
| 184 | +@property(readonly) NSTimeInterval inputLatency; |
| 185 | +@property(readonly) NSTimeInterval outputLatency; |
| 186 | +@property(readonly) NSTimeInterval IOBufferDuration; |
| 187 | +@property(readonly) NSTimeInterval preferredIOBufferDuration; |
| 188 | + |
| 189 | +/** |
| 190 | + When YES, calls to -setConfiguration:error: and -setConfiguration:active:error: ignore errors in |
| 191 | + configuring the audio session's "preferred" attributes (e.g. preferredInputNumberOfChannels). |
| 192 | + Typically, configurations to preferred attributes are optimizations, and ignoring this type of |
| 193 | + configuration error allows code flow to continue along the happy path when these optimization are |
| 194 | + not available. The default value of this property is NO. |
| 195 | + */ |
| 196 | +@property(nonatomic) BOOL ignoresPreferredAttributeConfigurationErrors; |
| 197 | + |
| 198 | +/** Default constructor. */ |
| 199 | ++ (instancetype)sharedInstance; |
| 200 | +- (instancetype)init NS_UNAVAILABLE; |
| 201 | + |
| 202 | +/** Adds a delegate, which is held weakly. */ |
| 203 | +- (void)addDelegate:(id<RTC_OBJC_TYPE(RTCAudioSessionDelegate)>)delegate; |
| 204 | +/** Removes an added delegate. */ |
| 205 | +- (void)removeDelegate:(id<RTC_OBJC_TYPE(RTCAudioSessionDelegate)>)delegate; |
| 206 | + |
| 207 | +/** Request exclusive access to the audio session for configuration. This call |
| 208 | + * will block if the lock is held by another object. |
| 209 | + */ |
| 210 | +- (void)lockForConfiguration; |
| 211 | +/** Relinquishes exclusive access to the audio session. */ |
| 212 | +- (void)unlockForConfiguration; |
| 213 | + |
| 214 | +/** If |active|, activates the audio session if it isn't already active. |
| 215 | + * Successful calls must be balanced with a setActive:NO when activation is no |
| 216 | + * longer required. If not |active|, deactivates the audio session if one is |
| 217 | + * active and this is the last balanced call. When deactivating, the |
| 218 | + * AVAudioSessionSetActiveOptionNotifyOthersOnDeactivation option is passed to |
| 219 | + * AVAudioSession. |
| 220 | + */ |
| 221 | +- (BOOL)setActive:(BOOL)active error:(NSError **)outError; |
| 222 | + |
| 223 | +// The following methods are proxies for the associated methods on |
| 224 | +// AVAudioSession. |lockForConfiguration| must be called before using them |
| 225 | +// otherwise they will fail with kRTCAudioSessionErrorLockRequired. |
| 226 | + |
| 227 | +- (BOOL)setCategory:(NSString *)category |
| 228 | + withOptions:(AVAudioSessionCategoryOptions)options |
| 229 | + error:(NSError **)outError; |
| 230 | +- (BOOL)setMode:(NSString *)mode error:(NSError **)outError; |
| 231 | +- (BOOL)setInputGain:(float)gain error:(NSError **)outError; |
| 232 | +- (BOOL)setPreferredSampleRate:(double)sampleRate error:(NSError **)outError; |
| 233 | +- (BOOL)setPreferredIOBufferDuration:(NSTimeInterval)duration error:(NSError **)outError; |
| 234 | +- (BOOL)setPreferredInputNumberOfChannels:(NSInteger)count error:(NSError **)outError; |
| 235 | +- (BOOL)setPreferredOutputNumberOfChannels:(NSInteger)count error:(NSError **)outError; |
| 236 | +- (BOOL)overrideOutputAudioPort:(AVAudioSessionPortOverride)portOverride error:(NSError **)outError; |
| 237 | +- (BOOL)setPreferredInput:(AVAudioSessionPortDescription *)inPort error:(NSError **)outError; |
| 238 | +- (BOOL)setInputDataSource:(AVAudioSessionDataSourceDescription *)dataSource |
| 239 | + error:(NSError **)outError; |
| 240 | +- (BOOL)setOutputDataSource:(AVAudioSessionDataSourceDescription *)dataSource |
| 241 | + error:(NSError **)outError; |
| 242 | +@end |
| 243 | + |
| 244 | +@interface RTC_OBJC_TYPE (RTCAudioSession) |
| 245 | +(Configuration) |
| 246 | + |
| 247 | + /** Applies the configuration to the current session. Attempts to set all |
| 248 | + * properties even if previous ones fail. Only the last error will be |
| 249 | + * returned. |
| 250 | + * |lockForConfiguration| must be called first. |
| 251 | + */ |
| 252 | + - (BOOL)setConfiguration : (RTC_OBJC_TYPE(RTCAudioSessionConfiguration) *)configuration error |
| 253 | + : (NSError **)outError; |
| 254 | + |
| 255 | +/** Convenience method that calls both setConfiguration and setActive. |
| 256 | + * |lockForConfiguration| must be called first. |
| 257 | + */ |
| 258 | +- (BOOL)setConfiguration:(RTC_OBJC_TYPE(RTCAudioSessionConfiguration) *)configuration |
| 259 | + active:(BOOL)active |
| 260 | + error:(NSError **)outError; |
| 261 | + |
| 262 | +@end |
| 263 | + |
| 264 | +NS_ASSUME_NONNULL_END |
0 commit comments