Adding AecDump functionality to AppRTCDemo for iOS

webrtc/examples/objc/AppRTCDemo/ARDAppClient.m

 /*
  *  Copyright 2014 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.
  */
 
@@ skipping 111 matching lines @@
 @synthesize roomId = _roomId;
 @synthesize clientId = _clientId;
 @synthesize isInitiator = _isInitiator;
 @synthesize iceServers = _iceServers;
 @synthesize webSocketURL = _websocketURL;
 @synthesize webSocketRestURL = _websocketRestURL;
 @synthesize defaultPeerConnectionConstraints =
     _defaultPeerConnectionConstraints;
 @synthesize isLoopback = _isLoopback;
 @synthesize isAudioOnly = _isAudioOnly;
+@synthesize shouldMakeAecDump = _shouldMakeAecDump;
+

[tkchin_webrtc, 2016/08/24 00:42:20]

nit: remove extra line

[peah-webrtc, 2016/08/25 09:25:08]

Done.

 
 - (instancetype)init {
   if (self = [super init]) {
     _roomServerClient = [[ARDAppEngineClient alloc] init];
     NSURL *turnRequestURL = [NSURL URLWithString:kARDTurnRequestUrl];
     _turnClient = [[ARDCEODTURNClient alloc] initWithURL:turnRequestURL];
     [self configure];
   }
   return self;
 }
@@ skipping 71 matching lines @@
 - (void)setState:(ARDAppClientState)state {
   if (_state == state) {
     return;
   }
   _state = state;
   [_delegate appClient:self didChangeState:_state];
 }
 
 - (void)connectToRoomWithId:(NSString *)roomId
                  isLoopback:(BOOL)isLoopback
-                isAudioOnly:(BOOL)isAudioOnly {
+                isAudioOnly:(BOOL)isAudioOnly
+                shouldMakeAecDump:(BOOL)shouldMakeAecDump {

[tkchin_webrtc, 2016/08/24 00:42:20]

nit: align :

[peah-webrtc, 2016/08/25 09:25:08]

Done.

   NSParameterAssert(roomId.length);
   NSParameterAssert(_state == kARDAppClientStateDisconnected);
   _isLoopback = isLoopback;
   _isAudioOnly = isAudioOnly;
+  _shouldMakeAecDump = shouldMakeAecDump;
   self.state = kARDAppClientStateConnecting;
 
 #if defined(WEBRTC_IOS)
   if (kARDAppClientEnableTracing) {
     NSString *filePath = [self documentsFilePathForFileName:@"webrtc-trace.txt"];
     RTCStartInternalCapture(filePath);
   }
 #endif
 
   // Request TURN.
@@ skipping 64 matching lines @@
     }
     // Disconnect from collider.
     _channel = nil;
   }
   _clientId = nil;
   _roomId = nil;
   _isInitiator = NO;
   _hasReceivedSdp = NO;
   _messageQueue = [NSMutableArray array];
 #if defined(WEBRTC_IOS)
+  if (_shouldMakeAecDump) {

[tkchin_webrtc, 2016/08/24 00:42:20]

is this conditional useful? Could be that it failed to start.
are multiple calls to start idempotent?

[peah-webrtc, 2016/08/25 09:25:08]

The StopAecDump method does an internal check to see whether an aecdump is being
done or not, so the conditional is not needed.

I think it does, however, make sense to not rely on that fact in this code as it
not really part of the documented api.

I added a bool that keeps track inside this class of whether an aecdump
recording has been successfully started.

+    [_factory stopAecDump];
+  }
   [_peerConnection stopRtcEventLog];
 #endif
   _peerConnection = nil;
   self.state = kARDAppClientStateDisconnected;
 #if defined(WEBRTC_IOS)
   RTCStopInternalCapture();
 #endif
 }
 
 #pragma mark - ARDSignalingChannelDelegate
@@ skipping 233 matching lines @@
   }
 #if defined(WEBRTC_IOS)
   // Start event log.
   if (kARDAppClientEnableRtcEventLog) {
     NSString *filePath = [self documentsFilePathForFileName:@"webrtc-rtceventlog"];
     if (![_peerConnection startRtcEventLogWithFilePath:filePath
                                  maxSizeInBytes:kARDAppClientRtcEventLogMaxSizeInBytes]) {
       RTCLogError(@"Failed to start event logging.");
     }
   }
+
+  // Start aecdump diagnostic recording.
+  if (_shouldMakeAecDump) {
+    NSString *filePath = [self documentsFilePathForFileName:@"audio.aecdump"];
+    int fd = open(filePath.UTF8String, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
+    if (fd < 0) {
+      RTCLogError(@"Failed to create the aecdump file!");
+    }

[tkchin_webrtc, 2016/08/24 00:42:20]

nit: else on same line as }

[peah-webrtc, 2016/08/25 09:25:08]

Done.

+    else {
+      if (![_factory startAecDump:fd  fileSizeLimitBytes:-1]) {

[tkchin_webrtc, 2016/08/24 00:42:20]

nit: remove extra space after fd

[peah-webrtc, 2016/08/25 09:25:08]

Done.

+        RTCLogError(@"Failed to create aecdump.");
+      }
+    }
+  }
 #endif
 }
 
 // Processes the messages that we've received from the room server and the
 // signaling channel. The offer or answer message must be processed before other
 // signaling messages, however they can arrive out of order. Hence, this method
 // only processes pending messages if there is a peer connection object and
 // if we have received either an offer or answer.
 - (void)drainMessageQueueIfReady {
   if (!_peerConnection || !_hasReceivedSdp) {
@@ skipping 239 matching lines @@
                                          code:kARDAppClientErrorInvalidRoom
                                      userInfo:@{
         NSLocalizedDescriptionKey: @"Invalid room.",
       }];
       break;
   }
   return error;
 }
 
 @end