mirror of https://github.com/oxen-io/session-ios
Merge branch 'mkirk/webrtc-mtl-view'
Michael Kirk
8 years ago
commit
0989068822
@ -1 +1 @@
|
||||
Subproject commit fc8eebb92367031f60ea337c897551cc54baa4b2
|
||||
Subproject commit a3eede219e225d5ae420c3e46161a6363e45cefc
|
||||
@ -1,7 +0,0 @@
|
||||
The RTCAudioSession.h header isn't included in the standard build of
|
||||
WebRTC, so we've vendored it here. Otherwise we're using the vanilla
|
||||
framework.
|
||||
|
||||
We use the RTCAudioSession header to manually manage the RTC audio
|
||||
session, so as to not start recording until the call is connected.
|
||||
|
||||
@ -1,224 +0,0 @@
|
||||
/*
|
||||
* Copyright 2016 The WebRTC Project Authors. All rights reserved.
|
||||
*
|
||||
* Use of this source code is governed by a BSD-style license
|
||||
* that can be found in the LICENSE file in the root of the source
|
||||
* tree. An additional intellectual property rights grant can be found
|
||||
* in the file PATENTS. All contributing project authors may
|
||||
* be found in the AUTHORS file in the root of the source tree.
|
||||
*/
|
||||
|
||||
#import <AVFoundation/AVFoundation.h>
|
||||
#import <Foundation/Foundation.h>
|
||||
|
||||
#import "WebRTC/RTCMacros.h"
|
||||
|
||||
NS_ASSUME_NONNULL_BEGIN
|
||||
|
||||
extern NSString * const kRTCAudioSessionErrorDomain;
|
||||
/** Method that requires lock was called without lock. */
|
||||
extern NSInteger const kRTCAudioSessionErrorLockRequired;
|
||||
/** Unknown configuration error occurred. */
|
||||
extern NSInteger const kRTCAudioSessionErrorConfiguration;
|
||||
|
||||
@class RTCAudioSession;
|
||||
@class RTCAudioSessionConfiguration;
|
||||
|
||||
// Surfaces AVAudioSession events. WebRTC will listen directly for notifications
|
||||
// from AVAudioSession and handle them before calling these delegate methods,
|
||||
// at which point applications can perform additional processing if required.
|
||||
RTC_EXPORT
|
||||
@protocol RTCAudioSessionDelegate <NSObject>
|
||||
|
||||
@optional
|
||||
/** Called on a system notification thread when AVAudioSession starts an
|
||||
* interruption event.
|
||||
*/
|
||||
- (void)audioSessionDidBeginInterruption:(RTCAudioSession *)session;
|
||||
|
||||
/** Called on a system notification thread when AVAudioSession ends an
|
||||
* interruption event.
|
||||
*/
|
||||
- (void)audioSessionDidEndInterruption:(RTCAudioSession *)session
|
||||
shouldResumeSession:(BOOL)shouldResumeSession;
|
||||
|
||||
/** Called on a system notification thread when AVAudioSession changes the
|
||||
* route.
|
||||
*/
|
||||
- (void)audioSessionDidChangeRoute:(RTCAudioSession *)session
|
||||
reason:(AVAudioSessionRouteChangeReason)reason
|
||||
previousRoute:(AVAudioSessionRouteDescription *)previousRoute;
|
||||
|
||||
/** Called on a system notification thread when AVAudioSession media server
|
||||
* terminates.
|
||||
*/
|
||||
- (void)audioSessionMediaServerTerminated:(RTCAudioSession *)session;
|
||||
|
||||
/** Called on a system notification thread when AVAudioSession media server
|
||||
* restarts.
|
||||
*/
|
||||
- (void)audioSessionMediaServerReset:(RTCAudioSession *)session;
|
||||
|
||||
// TODO(tkchin): Maybe handle SilenceSecondaryAudioHintNotification.
|
||||
|
||||
- (void)audioSession:(RTCAudioSession *)session
|
||||
didChangeCanPlayOrRecord:(BOOL)canPlayOrRecord;
|
||||
|
||||
/** Called on a WebRTC thread when the audio device is notified to begin
|
||||
* playback or recording.
|
||||
*/
|
||||
- (void)audioSessionDidStartPlayOrRecord:(RTCAudioSession *)session;
|
||||
|
||||
/** Called on a WebRTC thread when the audio device is notified to stop
|
||||
* playback or recording.
|
||||
*/
|
||||
- (void)audioSessionDidStopPlayOrRecord:(RTCAudioSession *)session;
|
||||
|
||||
@end
|
||||
|
||||
/** Proxy class for AVAudioSession that adds a locking mechanism similar to
|
||||
* AVCaptureDevice. This is used to that interleaving configurations between
|
||||
* WebRTC and the application layer are avoided.
|
||||
*
|
||||
* RTCAudioSession also coordinates activation so that the audio session is
|
||||
* activated only once. See |setActive:error:|.
|
||||
*/
|
||||
RTC_EXPORT
|
||||
@interface RTCAudioSession : NSObject
|
||||
|
||||
/** Convenience property to access the AVAudioSession singleton. Callers should
|
||||
* not call setters on AVAudioSession directly, but other method invocations
|
||||
* are fine.
|
||||
*/
|
||||
@property(nonatomic, readonly) AVAudioSession *session;
|
||||
|
||||
/** Our best guess at whether the session is active based on results of calls to
|
||||
* AVAudioSession.
|
||||
*/
|
||||
@property(nonatomic, readonly) BOOL isActive;
|
||||
/** Whether RTCAudioSession is currently locked for configuration. */
|
||||
@property(nonatomic, readonly) BOOL isLocked;
|
||||
|
||||
/** If YES, WebRTC will not initialize the audio unit automatically when an
|
||||
* audio track is ready for playout or recording. Instead, applications should
|
||||
* call setIsAudioEnabled. If NO, WebRTC will initialize the audio unit
|
||||
* as soon as an audio track is ready for playout or recording.
|
||||
*/
|
||||
@property(nonatomic, assign) BOOL useManualAudio;
|
||||
|
||||
/** This property is only effective if useManualAudio is YES.
|
||||
* Represents permission for WebRTC to initialize the VoIP audio unit.
|
||||
* When set to NO, if the VoIP audio unit used by WebRTC is active, it will be
|
||||
* stopped and uninitialized. This will stop incoming and outgoing audio.
|
||||
* When set to YES, WebRTC will initialize and start the audio unit when it is
|
||||
* needed (e.g. due to establishing an audio connection).
|
||||
* This property was introduced to work around an issue where if an AVPlayer is
|
||||
* playing audio while the VoIP audio unit is initialized, its audio would be
|
||||
* either cut off completely or played at a reduced volume. By preventing
|
||||
* the audio unit from being initialized until after the audio has completed,
|
||||
* we are able to prevent the abrupt cutoff.
|
||||
*/
|
||||
@property(nonatomic, assign) BOOL isAudioEnabled;
|
||||
|
||||
// Proxy properties.
|
||||
@property(readonly) NSString *category;
|
||||
@property(readonly) AVAudioSessionCategoryOptions categoryOptions;
|
||||
@property(readonly) NSString *mode;
|
||||
@property(readonly) BOOL secondaryAudioShouldBeSilencedHint;
|
||||
@property(readonly) AVAudioSessionRouteDescription *currentRoute;
|
||||
@property(readonly) NSInteger maximumInputNumberOfChannels;
|
||||
@property(readonly) NSInteger maximumOutputNumberOfChannels;
|
||||
@property(readonly) float inputGain;
|
||||
@property(readonly) BOOL inputGainSettable;
|
||||
@property(readonly) BOOL inputAvailable;
|
||||
@property(readonly, nullable)
|
||||
NSArray<AVAudioSessionDataSourceDescription *> * inputDataSources;
|
||||
@property(readonly, nullable)
|
||||
AVAudioSessionDataSourceDescription *inputDataSource;
|
||||
@property(readonly, nullable)
|
||||
NSArray<AVAudioSessionDataSourceDescription *> * outputDataSources;
|
||||
@property(readonly, nullable)
|
||||
AVAudioSessionDataSourceDescription *outputDataSource;
|
||||
@property(readonly) double sampleRate;
|
||||
@property(readonly) double preferredSampleRate;
|
||||
@property(readonly) NSInteger inputNumberOfChannels;
|
||||
@property(readonly) NSInteger outputNumberOfChannels;
|
||||
@property(readonly) float outputVolume;
|
||||
@property(readonly) NSTimeInterval inputLatency;
|
||||
@property(readonly) NSTimeInterval outputLatency;
|
||||
@property(readonly) NSTimeInterval IOBufferDuration;
|
||||
@property(readonly) NSTimeInterval preferredIOBufferDuration;
|
||||
|
||||
/** Default constructor. */
|
||||
+ (instancetype)sharedInstance;
|
||||
- (instancetype)init NS_UNAVAILABLE;
|
||||
|
||||
/** Adds a delegate, which is held weakly. */
|
||||
- (void)addDelegate:(id<RTCAudioSessionDelegate>)delegate;
|
||||
/** Removes an added delegate. */
|
||||
- (void)removeDelegate:(id<RTCAudioSessionDelegate>)delegate;
|
||||
|
||||
/** Request exclusive access to the audio session for configuration. This call
|
||||
* will block if the lock is held by another object.
|
||||
*/
|
||||
- (void)lockForConfiguration;
|
||||
/** Relinquishes exclusive access to the audio session. */
|
||||
- (void)unlockForConfiguration;
|
||||
|
||||
/** If |active|, activates the audio session if it isn't already active.
|
||||
* Successful calls must be balanced with a setActive:NO when activation is no
|
||||
* longer required. If not |active|, deactivates the audio session if one is
|
||||
* active and this is the last balanced call. When deactivating, the
|
||||
* AVAudioSessionSetActiveOptionNotifyOthersOnDeactivation option is passed to
|
||||
* AVAudioSession.
|
||||
*/
|
||||
- (BOOL)setActive:(BOOL)active
|
||||
error:(NSError **)outError;
|
||||
|
||||
// The following methods are proxies for the associated methods on
|
||||
// AVAudioSession. |lockForConfiguration| must be called before using them
|
||||
// otherwise they will fail with kRTCAudioSessionErrorLockRequired.
|
||||
|
||||
- (BOOL)setCategory:(NSString *)category
|
||||
withOptions:(AVAudioSessionCategoryOptions)options
|
||||
error:(NSError **)outError;
|
||||
- (BOOL)setMode:(NSString *)mode error:(NSError **)outError;
|
||||
- (BOOL)setInputGain:(float)gain error:(NSError **)outError;
|
||||
- (BOOL)setPreferredSampleRate:(double)sampleRate error:(NSError **)outError;
|
||||
- (BOOL)setPreferredIOBufferDuration:(NSTimeInterval)duration
|
||||
error:(NSError **)outError;
|
||||
- (BOOL)setPreferredInputNumberOfChannels:(NSInteger)count
|
||||
error:(NSError **)outError;
|
||||
- (BOOL)setPreferredOutputNumberOfChannels:(NSInteger)count
|
||||
error:(NSError **)outError;
|
||||
- (BOOL)overrideOutputAudioPort:(AVAudioSessionPortOverride)portOverride
|
||||
error:(NSError **)outError;
|
||||
- (BOOL)setPreferredInput:(AVAudioSessionPortDescription *)inPort
|
||||
error:(NSError **)outError;
|
||||
- (BOOL)setInputDataSource:(AVAudioSessionDataSourceDescription *)dataSource
|
||||
error:(NSError **)outError;
|
||||
- (BOOL)setOutputDataSource:(AVAudioSessionDataSourceDescription *)dataSource
|
||||
error:(NSError **)outError;
|
||||
|
||||
@end
|
||||
|
||||
@interface RTCAudioSession (Configuration)
|
||||
|
||||
/** Applies the configuration to the current session. Attempts to set all
|
||||
* properties even if previous ones fail. Only the last error will be
|
||||
* returned.
|
||||
* |lockForConfiguration| must be called first.
|
||||
*/
|
||||
- (BOOL)setConfiguration:(RTCAudioSessionConfiguration *)configuration
|
||||
error:(NSError **)outError;
|
||||
|
||||
/** Convenience method that calls both setConfiguration and setActive.
|
||||
* |lockForConfiguration| must be called first.
|
||||
*/
|
||||
- (BOOL)setConfiguration:(RTCAudioSessionConfiguration *)configuration
|
||||
active:(BOOL)active
|
||||
error:(NSError **)outError;
|
||||
|
||||
@end
|
||||
|
||||
NS_ASSUME_NONNULL_END
|
||||
@ -0,0 +1,17 @@
|
||||
//
|
||||
// Copyright (c) 2017 Open Whisper Systems. All rights reserved.
|
||||
//
|
||||
|
||||
#import <WebRTC/RTCVideoRenderer.h>
|
||||
|
||||
NS_ASSUME_NONNULL_BEGIN
|
||||
|
||||
/**
|
||||
* Drives the full screen remote video. This is *not* a swift class
|
||||
* so we can take advantage of some compile time constants from WebRTC
|
||||
*/
|
||||
@interface RemoteVideoView : UIView <RTCVideoRenderer>
|
||||
|
||||
@end
|
||||
|
||||
NS_ASSUME_NONNULL_END
|
||||
@ -0,0 +1,238 @@
|
||||
//
|
||||
// Copyright (c) 2017 Open Whisper Systems. All rights reserved.
|
||||
//
|
||||
|
||||
#import "RemoteVideoView.h"
|
||||
#import "UIFont+OWS.h"
|
||||
#import "UIView+OWS.h"
|
||||
#import <MetalKit/MetalKit.h>
|
||||
#import <PureLayout/PureLayout.h>
|
||||
#import <SignalServiceKit/Threading.h>
|
||||
#import <WebRTC/RTCEAGLVideoView.h>
|
||||
#import <WebRTC/RTCMTLVideoView.h>
|
||||
#import <WebRTC/RTCVideoRenderer.h>
|
||||
|
||||
NS_ASSUME_NONNULL_BEGIN
|
||||
|
||||
// As of RTC M61, iOS8 crashes when ending calls while de-alloc'ing the EAGLVideoView.
|
||||
// WebRTC doesn't seem to support iOS8 - e.g. their Podfile requires iOS9+, and they
|
||||
// unconditionally require MetalKit on a 64bit iOS8 device (which crashes).
|
||||
// Until WebRTC supports iOS8, we show a "upgrade iOS to see remote video" view
|
||||
// to our few remaining iOS8 users
|
||||
@interface NullVideoRenderer : UIView <RTCVideoRenderer>
|
||||
|
||||
@end
|
||||
|
||||
@implementation NullVideoRenderer
|
||||
|
||||
- (instancetype)initWithFrame:(CGRect)frame
|
||||
{
|
||||
self = [super initWithFrame:frame];
|
||||
if (!self) {
|
||||
return self;
|
||||
}
|
||||
|
||||
self.backgroundColor = UIColor.blackColor;
|
||||
|
||||
UILabel *label = [UILabel new];
|
||||
label.numberOfLines = 0;
|
||||
label.text
|
||||
= NSLocalizedString(@"CALL_REMOTE_VIDEO_DISABLED", @"Text shown on call screen in place of remote video");
|
||||
label.textAlignment = NSTextAlignmentCenter;
|
||||
label.font = [UIFont ows_boldFontWithSize:ScaleFromIPhone5(20)];
|
||||
label.textColor = UIColor.whiteColor;
|
||||
label.lineBreakMode = NSLineBreakByWordWrapping;
|
||||
|
||||
[self addSubview:label];
|
||||
[label autoVCenterInSuperview];
|
||||
[label autoPinWidthToSuperviewWithMargin:ScaleFromIPhone5(16)];
|
||||
|
||||
return self;
|
||||
}
|
||||
|
||||
#pragma mark - RTCVideoRenderer
|
||||
|
||||
/** The size of the frame. */
|
||||
- (void)setSize:(CGSize)size
|
||||
{
|
||||
// Do nothing.
|
||||
}
|
||||
|
||||
/** The frame to be displayed. */
|
||||
- (void)renderFrame:(nullable RTCVideoFrame *)frame
|
||||
{
|
||||
// Do nothing.
|
||||
}
|
||||
|
||||
@end
|
||||
|
||||
@interface RemoteVideoView () <RTCEAGLVideoViewDelegate>
|
||||
|
||||
@property (nonatomic, readonly) __kindof UIView<RTCVideoRenderer> *videoRenderer;
|
||||
|
||||
// Used for legacy EAGLVideoView
|
||||
@property (nullable, nonatomic) NSMutableArray<NSLayoutConstraint *> *remoteVideoConstraints;
|
||||
|
||||
@end
|
||||
|
||||
@implementation RemoteVideoView
|
||||
|
||||
- (instancetype)init
|
||||
{
|
||||
self = [super init];
|
||||
if (!self) {
|
||||
return self;
|
||||
}
|
||||
|
||||
// On iOS8: prints a message saying the feature is unavailable.
|
||||
if (!SYSTEM_VERSION_GREATER_THAN_OR_EQUAL_TO(9, 0)) {
|
||||
_videoRenderer = [NullVideoRenderer new];
|
||||
[self addSubview:_videoRenderer];
|
||||
[_videoRenderer autoPinEdgesToSuperviewEdges];
|
||||
}
|
||||
|
||||
// Currently RTC only supports metal on 64bit machines
|
||||
#if defined(RTC_SUPPORTS_METAL)
|
||||
// On 64-bit, iOS9+: uses the MetalKit backed view for improved battery/rendering performance.
|
||||
if (_videoRenderer == nil) {
|
||||
|
||||
// It is insufficient to check the RTC_SUPPORTS_METAL macro to determine Metal support.
|
||||
// RTCMTLVideoView requires the MTKView class, available only in iOS9+
|
||||
// So check that it exists before proceeding.
|
||||
if ([MTKView class]) {
|
||||
_videoRenderer = [[RTCMTLVideoView alloc] initWithFrame:CGRectZero];
|
||||
[self addSubview:_videoRenderer];
|
||||
[_videoRenderer autoPinEdgesToSuperviewEdges];
|
||||
// HACK: Although RTCMTLVideo view is positioned to the top edge of the screen
|
||||
// It's inner (private) MTKView is below the status bar.
|
||||
for (UIView *subview in [_videoRenderer subviews]) {
|
||||
if ([subview isKindOfClass:[MTKView class]]) {
|
||||
[NSLayoutConstraint autoSetPriority:UILayoutPriorityRequired
|
||||
forConstraints:^{
|
||||
[subview autoPinEdgesToSuperviewEdges];
|
||||
}];
|
||||
} else {
|
||||
OWSFail(@"New subviews added to MTLVideoView. Reconsider this hack.");
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
#elif defined(__arm64__)
|
||||
// Canary incase the upstream RTC_SUPPORTS_METAL macro changes semantics
|
||||
OWSFail(@"should only use legacy video view on 32bit systems");
|
||||
#endif
|
||||
|
||||
// On 32-bit iOS9+ systems, use the legacy EAGL backed view.
|
||||
if (_videoRenderer == nil) {
|
||||
RTCEAGLVideoView *eaglVideoView = [RTCEAGLVideoView new];
|
||||
eaglVideoView.delegate = self;
|
||||
_videoRenderer = eaglVideoView;
|
||||
[self addSubview:_videoRenderer];
|
||||
// Pinning legacy RTCEAGL view discards aspect ratio.
|
||||
// So we have a more verbose layout in the RTCEAGLVideoViewDelegate methods
|
||||
// [_videoRenderer autoPinEdgesToSuperviewEdges];
|
||||
}
|
||||
|
||||
// We want the rendered video to go edge-to-edge.
|
||||
_videoRenderer.layoutMargins = UIEdgeInsetsZero;
|
||||
|
||||
return self;
|
||||
}
|
||||
|
||||
#pragma mark - RTCVideoRenderer
|
||||
|
||||
/** The size of the frame. */
|
||||
- (void)setSize:(CGSize)size
|
||||
{
|
||||
[self.videoRenderer setSize:size];
|
||||
}
|
||||
|
||||
#pragma mark - RTCEAGLVideoViewDelegate
|
||||
|
||||
- (void)videoView:(RTCEAGLVideoView *)videoView didChangeVideoSize:(CGSize)remoteVideoSize
|
||||
{
|
||||
AssertIsOnMainThread();
|
||||
if (remoteVideoSize.height <= 0) {
|
||||
OWSFail(@"Illegal video height: %f", remoteVideoSize.height);
|
||||
return;
|
||||
}
|
||||
|
||||
CGFloat aspectRatio = remoteVideoSize.width / remoteVideoSize.height;
|
||||
|
||||
DDLogVerbose(@"%@ Remote video size: width: %f height: %f ratio: %f",
|
||||
self.logTag,
|
||||
remoteVideoSize.width,
|
||||
remoteVideoSize.height,
|
||||
aspectRatio);
|
||||
|
||||
UIView *containingView = self.superview;
|
||||
if (containingView == nil) {
|
||||
DDLogDebug(@"%@ Cannot layout video view without superview", self.logTag);
|
||||
return;
|
||||
}
|
||||
|
||||
if (![self.videoRenderer isKindOfClass:[RTCEAGLVideoView class]]) {
|
||||
OWSFail(@"%@ Unexpected video renderer: %@", self.logTag, self.videoRenderer);
|
||||
return;
|
||||
}
|
||||
|
||||
[NSLayoutConstraint deactivateConstraints:self.remoteVideoConstraints];
|
||||
|
||||
NSMutableArray<NSLayoutConstraint *> *constraints = [NSMutableArray new];
|
||||
if (remoteVideoSize.width > 0 && remoteVideoSize.height > 0 && containingView.bounds.size.width > 0
|
||||
&& containingView.bounds.size.height > 0) {
|
||||
|
||||
// to approximate "scale to fill" contentMode
|
||||
// - Pin aspect ratio
|
||||
// - Width and height is *at least* as wide as superview
|
||||
[constraints addObject:[videoView autoPinToAspectRatio:aspectRatio]];
|
||||
[constraints addObject:[videoView autoSetDimension:ALDimensionWidth
|
||||
toSize:containingView.width
|
||||
relation:NSLayoutRelationGreaterThanOrEqual]];
|
||||
[constraints addObject:[videoView autoSetDimension:ALDimensionHeight
|
||||
toSize:containingView.height
|
||||
relation:NSLayoutRelationGreaterThanOrEqual]];
|
||||
[constraints addObjectsFromArray:[videoView autoCenterInSuperview]];
|
||||
|
||||
// Low priority constraints force view to be no larger than necessary.
|
||||
[NSLayoutConstraint autoSetPriority:UILayoutPriorityDefaultLow
|
||||
forConstraints:^{
|
||||
[constraints addObjectsFromArray:[videoView autoPinEdgesToSuperviewEdges]];
|
||||
}];
|
||||
|
||||
} else {
|
||||
[constraints addObjectsFromArray:[videoView autoPinEdgesToSuperviewEdges]];
|
||||
}
|
||||
|
||||
self.remoteVideoConstraints = constraints;
|
||||
// We need to force relayout to occur immediately (and not
|
||||
// wait for a UIKit layout/render pass) or the remoteVideoView
|
||||
// (which presumably is updating its CALayer directly) will
|
||||
// ocassionally appear to have bad frames.
|
||||
[videoView setNeedsLayout];
|
||||
[[videoView superview] setNeedsLayout];
|
||||
[videoView layoutIfNeeded];
|
||||
[[videoView superview] layoutIfNeeded];
|
||||
}
|
||||
|
||||
/** The frame to be displayed. */
|
||||
- (void)renderFrame:(nullable RTCVideoFrame *)frame
|
||||
{
|
||||
[self.videoRenderer renderFrame:frame];
|
||||
}
|
||||
|
||||
#pragma mark - Logging
|
||||
|
||||
+ (NSString *)logTag
|
||||
{
|
||||
return [NSString stringWithFormat:@"[%@]", self.class];
|
||||
}
|
||||
|
||||
- (NSString *)logTag
|
||||
{
|
||||
return self.class.logTag;
|
||||
}
|
||||
|
||||
@end
|
||||
|
||||
NS_ASSUME_NONNULL_END
|
||||
Loading…
Reference in New Issue