Adding audio unit tests for Android

media/audio/android/opensles_input.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "media/audio/android/opensles_input.h"
 
 #include "base/logging.h"
 #include "media/audio/android/audio_manager_android.h"
 
 #define LOG_ON_FAILURE_AND_RETURN(op, ...) \
   do { \
     SLresult err = (op);            \
     if (err != SL_RESULT_SUCCESS) { \
       DLOG(ERROR) << #op << " failed: " << err; \
       return __VA_ARGS__; \
     } \
   } while (0)
 
 namespace media {
 
 OpenSLESInputStream::OpenSLESInputStream(AudioManagerAndroid* audio_manager,
                                          const AudioParameters& params)
     : audio_manager_(audio_manager),
       callback_(NULL),
       recorder_(NULL),
       simple_buffer_queue_(NULL),
       active_queue_(0),
       buffer_size_bytes_(0),
       started_(false) {
+  DVLOG(2) << "OpenSLESInputStream::OpenSLESInputStream()";
   format_.formatType = SL_DATAFORMAT_PCM;
   format_.numChannels = static_cast<SLuint32>(params.channels());
   // Provides sampling rate in milliHertz to OpenSLES.
   format_.samplesPerSec = static_cast<SLuint32>(params.sample_rate() * 1000);
   format_.bitsPerSample = params.bits_per_sample();
   format_.containerSize = params.bits_per_sample();
   format_.endianness = SL_BYTEORDER_LITTLEENDIAN;
   if (format_.numChannels == 1)
     format_.channelMask = SL_SPEAKER_FRONT_CENTER;
   else if (format_.numChannels == 2)
     format_.channelMask = SL_SPEAKER_FRONT_LEFT | SL_SPEAKER_FRONT_RIGHT;
   else
     NOTREACHED() << "Unsupported number of channels: " << format_.numChannels;
 
   buffer_size_bytes_ = params.GetBytesPerBuffer();
 
   memset(&audio_data_, 0, sizeof(audio_data_));
 }
 
 OpenSLESInputStream::~OpenSLESInputStream() {
+  DVLOG(2) << "OpenSLESInputStream::~OpenSLESInputStream()";
+  DCHECK(thread_checker_.CalledOnValidThread());
   DCHECK(!recorder_object_.Get());
   DCHECK(!engine_object_.Get());
   DCHECK(!recorder_);
   DCHECK(!simple_buffer_queue_);
   DCHECK(!audio_data_[0]);
 }
 
 bool OpenSLESInputStream::Open() {
+  DVLOG(2) << "OpenSLESInputStream::Open()";
+  DCHECK(thread_checker_.CalledOnValidThread());
   if (engine_object_.Get())
     return false;
 
   if (!CreateRecorder())
     return false;
 
   SetupAudioBuffer();
 
   return true;
 }
 
 void OpenSLESInputStream::Start(AudioInputCallback* callback) {
+  DVLOG(2) << "OpenSLESInputStream::Start()";
+  DCHECK(thread_checker_.CalledOnValidThread());
   DCHECK(callback);
   DCHECK(recorder_);
   DCHECK(simple_buffer_queue_);
-  if (started_)
-    return;
-
-  // Enable the flags before streaming.
-  callback_ = callback;
-  active_queue_ = 0;
-  started_ = true;
 
   SLresult err = SL_RESULT_UNKNOWN_ERROR;
-  // Enqueues |kNumOfQueuesInBuffer| zero buffers to get the ball rolling.
-  for (int i = 0; i < kNumOfQueuesInBuffer; ++i) {
-    err = (*simple_buffer_queue_)->Enqueue(
-        simple_buffer_queue_,
-        audio_data_[i],
-        buffer_size_bytes_);
-    if (SL_RESULT_SUCCESS != err) {
-      HandleError(err);
+  {
+    base::AutoLock lock(lock_);
+    if (started_)

[wjia(left Chromium), 2013/08/29 14:21:55]

No need to guard this check since this is the only thread on which |started_|
could be modified.

       return;
+
+    // Enable the flags before streaming.
+    callback_ = callback;
+    active_queue_ = 0;
+    started_ = true;
+
+    // Enqueues |kNumOfQueuesInBuffer| zero buffers to get the ball rolling.
+    for (int i = 0; i < kNumOfQueuesInBuffer; ++i) {
+      err = (*simple_buffer_queue_)->Enqueue(
+          simple_buffer_queue_,
+          audio_data_[i],
+          buffer_size_bytes_);
+      if (SL_RESULT_SUCCESS != err) {
+        HandleError(err);
+        return;
+      }
     }
   }
 
   // Start the recording by setting the state to |SL_RECORDSTATE_RECORDING|.
   err = (*recorder_)->SetRecordState(recorder_, SL_RECORDSTATE_RECORDING);
   if (SL_RESULT_SUCCESS != err)
     HandleError(err);
 }
 
 void OpenSLESInputStream::Stop() {
-  if (!started_)
-    return;
+  DVLOG(2) << "OpenSLESInputStream::Stop()";
+  DCHECK(thread_checker_.CalledOnValidThread());
+  {
+    base::AutoLock lock(lock_);
+    if (!started_)

[wjia(left Chromium), 2013/08/29 14:21:55]

ditto.

+      return;
+  }
 
   // Stop recording by setting the record state to |SL_RECORDSTATE_STOPPED|.
   LOG_ON_FAILURE_AND_RETURN(
       (*recorder_)->SetRecordState(recorder_,
                                    SL_RECORDSTATE_STOPPED));
+  {
+    base::AutoLock lock(lock_);
 
-  // Clear the buffer queue to get rid of old data when resuming recording.
-  LOG_ON_FAILURE_AND_RETURN(
-      (*simple_buffer_queue_)->Clear(simple_buffer_queue_));
+    // Clear the buffer queue to get rid of old data when resuming recording.
+    LOG_ON_FAILURE_AND_RETURN(
+        (*simple_buffer_queue_)->Clear(simple_buffer_queue_));
 
-  started_ = false;
+    started_ = false;
+  }
 }
 
 void OpenSLESInputStream::Close() {
+  DVLOG(2) << "OpenSLESInputStream::Close()";
+  DCHECK(thread_checker_.CalledOnValidThread());
+
   // Stop the stream if it is still recording.
   Stop();

[wjia(left Chromium), 2013/08/29 14:21:55]

|lock_| is not needed after this point, since |started_| is already false and
opensl callback thread will never use other members.

 
-  // Explicitly free the player objects and invalidate their associated
-  // interfaces. They have to be done in the correct order.
+  {
+    base::AutoLock lock(lock_);
+    if (callback_) {
+      callback_->OnClose(this);
+      callback_ = NULL;
+    }
+  }
+
+  // Destroy the buffer queue recorder object and invalidate all associated
+  // interfaces.
   recorder_object_.Reset();
-  engine_object_.Reset();
-  simple_buffer_queue_ = NULL;
+  {
+    base::AutoLock lock(lock_);
+    simple_buffer_queue_ = NULL;
+  }
   recorder_ = NULL;
 
-  ReleaseAudioBuffer();
+  // Destroy the engine object. We don't store any associated interface for
+  // this object.
+  engine_object_.Reset();
+  {
+    base::AutoLock lock(lock_);
+    ReleaseAudioBuffer();
+  }
 
   audio_manager_->ReleaseInputStream(this);
 }
 
 double OpenSLESInputStream::GetMaxVolume() {
   NOTIMPLEMENTED();
   return 0.0;
 }
 
 void OpenSLESInputStream::SetVolume(double volume) {
   NOTIMPLEMENTED();
 }
 
 double OpenSLESInputStream::GetVolume() {
   NOTIMPLEMENTED();
   return 0.0;
 }
 
 void OpenSLESInputStream::SetAutomaticGainControl(bool enabled) {
   NOTIMPLEMENTED();
 }
 
 bool OpenSLESInputStream::GetAutomaticGainControl() {
   NOTIMPLEMENTED();
   return false;
 }
 
 bool OpenSLESInputStream::CreateRecorder() {
+  DCHECK(thread_checker_.CalledOnValidThread());
+  DCHECK(!engine_object_.Get());
+  DCHECK(!recorder_object_.Get());
+  DCHECK(!recorder_);
+  DCHECK(!simple_buffer_queue_);
+
   // Initializes the engine object with specific option. After working with the
   // object, we need to free the object and its resources.
   SLEngineOption option[] = {
     { SL_ENGINEOPTION_THREADSAFE, static_cast<SLuint32>(SL_BOOLEAN_TRUE) }
   };
   LOG_ON_FAILURE_AND_RETURN(slCreateEngine(engine_object_.Receive(),
                                            1,
                                            option,
                                            0,
                                            NULL,
@@ skipping 28 matching lines @@
 
   // Create an audio recorder.
   const SLInterfaceID interface_id[] = {
     SL_IID_ANDROIDSIMPLEBUFFERQUEUE,
     SL_IID_ANDROIDCONFIGURATION
   };
   const SLboolean interface_required[] = {
     SL_BOOLEAN_TRUE,
     SL_BOOLEAN_TRUE
   };
+
   // Create AudioRecorder and specify SL_IID_ANDROIDCONFIGURATION.
   LOG_ON_FAILURE_AND_RETURN(
       (*engine)->CreateAudioRecorder(engine,
                                      recorder_object_.Receive(),
                                      &audio_source,
                                      &audio_sink,
                                      arraysize(interface_id),
                                      interface_id,
                                      interface_required),
       false);
@@ skipping 44 matching lines @@
 }
 
 void OpenSLESInputStream::SimpleBufferQueueCallback(
     SLAndroidSimpleBufferQueueItf buffer_queue, void* instance) {
   OpenSLESInputStream* stream =
       reinterpret_cast<OpenSLESInputStream*>(instance);
   stream->ReadBufferQueue();
 }
 
 void OpenSLESInputStream::ReadBufferQueue() {
+  base::AutoLock lock(lock_);
   if (!started_)
     return;
 
   // TODO(xians): Get an accurate delay estimation.
   callback_->OnData(this,
                     audio_data_[active_queue_],
                     buffer_size_bytes_,
                     buffer_size_bytes_,
                     0.0);
 
   // Done with this buffer. Send it to device for recording.
   SLresult err = (*simple_buffer_queue_)->Enqueue(
       simple_buffer_queue_,
       audio_data_[active_queue_],
       buffer_size_bytes_);
   if (SL_RESULT_SUCCESS != err)
     HandleError(err);
 
   active_queue_ = (active_queue_ + 1) % kNumOfQueuesInBuffer;
 }
 
 void OpenSLESInputStream::SetupAudioBuffer() {
+  DCHECK(thread_checker_.CalledOnValidThread());
   DCHECK(!audio_data_[0]);
   for (int i = 0; i < kNumOfQueuesInBuffer; ++i) {
     audio_data_[i] = new uint8[buffer_size_bytes_];
   }
 }
 
 void OpenSLESInputStream::ReleaseAudioBuffer() {
+  DCHECK(thread_checker_.CalledOnValidThread());
   if (audio_data_[0]) {
     for (int i = 0; i < kNumOfQueuesInBuffer; ++i) {
       delete [] audio_data_[i];
       audio_data_[i] = NULL;
     }
   }
 }
 
 void OpenSLESInputStream::HandleError(SLresult error) {

[wjia(left Chromium), 2013/08/29 14:21:55]

This function should be called HandleErrorWithLock. Then you will find some
caller doesn't acquire lock before calling it.

   DLOG(FATAL) << "OpenSLES Input error " << error;
   if (callback_)
     callback_->OnError(this);
 }
 
 }  // namespace media