Initialization of audio manager for Android is now done on the audio thread

media/audio/android/audio_manager_android.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/audio_manager_android.h"
 
 #include "base/android/build_info.h"
 #include "base/android/jni_array.h"
 #include "base/android/jni_string.h"
 #include "base/android/scoped_java_ref.h"
 #include "base/logging.h"
+#include "base/message_loop/message_loop.h"
 #include "base/strings/string_number_conversions.h"
 #include "jni/AudioManagerAndroid_jni.h"
 #include "media/audio/android/audio_record_input.h"
 #include "media/audio/android/opensles_input.h"
 #include "media/audio/android/opensles_output.h"
 #include "media/audio/audio_manager.h"
 #include "media/audio/audio_parameters.h"
 #include "media/audio/fake_audio_input_stream.h"
 #include "media/base/channel_layout.h"
 
@@ skipping 16 matching lines @@
 static const int kMaxOutputStreams = 10;
 
 static const int kDefaultInputBufferSize = 1024;
 static const int kDefaultOutputBufferSize = 2048;
 
 AudioManager* CreateAudioManager(AudioLogFactory* audio_log_factory) {
   return new AudioManagerAndroid(audio_log_factory);
 }
 
 AudioManagerAndroid::AudioManagerAndroid(AudioLogFactory* audio_log_factory)
-    : AudioManagerBase(audio_log_factory) {
+    : AudioManagerBase(audio_log_factory),
+      initialized_on_audio_thread_(false) {
   SetMaxOutputStreamsAllowed(kMaxOutputStreams);
-
   j_audio_manager_.Reset(
       Java_AudioManagerAndroid_createAudioManagerAndroid(
           base::android::AttachCurrentThread(),
           base::android::GetApplicationContext(),
           reinterpret_cast<intptr_t>(this)));
   Init();
 }
 
 AudioManagerAndroid::~AudioManagerAndroid() {
   Close();
   Shutdown();
+  // Verify that WillDestroyCurrentMessageLoop() has been called.
+  DCHECK(!initialized_on_audio_thread_);
 }
 
 bool AudioManagerAndroid::HasAudioOutputDevices() {
   return true;
 }
 
 bool AudioManagerAndroid::HasAudioInputDevices() {
   return true;
 }
 
 void AudioManagerAndroid::GetAudioInputDeviceNames(
     AudioDeviceNames* device_names) {
-  // Always add default device parameters as first element.
-  DCHECK(device_names->empty());
-  AddDefaultDevice(device_names);
-
-  JNIEnv* env = AttachCurrentThread();
-  ScopedJavaLocalRef<jobjectArray> j_device_array =
-      Java_AudioManagerAndroid_getAudioInputDeviceNames(
-          env, j_audio_manager_.obj());
-  jsize len = env->GetArrayLength(j_device_array.obj());
-  AudioDeviceName device;
-  for (jsize i = 0; i < len; ++i) {
-    ScopedJavaLocalRef<jobject> j_device(
-        env, env->GetObjectArrayElement(j_device_array.obj(), i));
-    ScopedJavaLocalRef<jstring> j_device_name =
-        Java_AudioDeviceName_name(env, j_device.obj());
-    ConvertJavaStringToUTF8(env, j_device_name.obj(), &device.device_name);
-    ScopedJavaLocalRef<jstring> j_device_id =
-        Java_AudioDeviceName_id(env, j_device.obj());
-    ConvertJavaStringToUTF8(env, j_device_id.obj(), &device.unique_id);
-    device_names->push_back(device);
+  // Get list of available audio devices and use the audio thread to reduce
+  // the number of calling threads to the Java layer. Also, ensure that the
+  // calling thread sees this function call as synchronous.
+  if (GetTaskRunner()->BelongsToCurrentThread()) {
+    GetAudioInputDeviceNamesOnAudioThread(NULL, device_names);
+  } else {
+    base::WaitableEvent event(false, false);
+    GetTaskRunner()->PostTask(

[tommi (sloooow) - chröme, 2014/01/30 12:51:11]

nit: You could avoid calling GetTaskRunner more than once.

[henrika (OOO until Aug 14), 2014/01/30 14:48:24]

Done.

+        FROM_HERE,
+        base::Bind(
+            &AudioManagerAndroid::GetAudioInputDeviceNamesOnAudioThread,
+            base::Unretained(this),
+            &event,
+            device_names));
+    event.Wait();
   }
 }
 
 void AudioManagerAndroid::GetAudioOutputDeviceNames(
     AudioDeviceNames* device_names) {
   // TODO(henrika): enumerate using GetAudioInputDeviceNames().
   AddDefaultDevice(device_names);
 }
 
 AudioParameters AudioManagerAndroid::GetInputStreamParameters(
@@ skipping 121 matching lines @@
     // shouldUse<Effect>. Only DCHECK on that condition to allow tests to use
     // the effect settings as a way to select the input path.
     DCHECK_GE(base::android::BuildInfo::GetInstance()->sdk_int(), 16);
     DVLOG(1) << "Creating AudioRecordInputStream";
     return new AudioRecordInputStream(this, params);
   }
   DVLOG(1) << "Creating OpenSLESInputStream";
   return new OpenSLESInputStream(this, params);
 }
 
+void AudioManagerAndroid::WillDestroyCurrentMessageLoop() {
+  // This call matches previous calls to InitializeOnAudioThread() and it
+  // ensures that we unregister receivers for events related to changes in
+  // availability of audio devices.
+  CloseOnAudioThread();
+}
+
 int AudioManagerAndroid::GetOptimalOutputFrameSize(int sample_rate,
                                                    int channels) {
   if (IsAudioLowLatencySupported()) {
     return GetAudioLowLatencyOutputFrameSize();
   } else {
     return std::max(kDefaultOutputBufferSize,
                     Java_AudioManagerAndroid_getMinOutputFrameSize(
                         base::android::AttachCurrentThread(),
                         sample_rate, channels));
   }
@@ skipping 51 matching lines @@
 
 void AudioManagerAndroid::SetMute(JNIEnv* env, jobject obj, jboolean muted) {
   GetTaskRunner()->PostTask(
       FROM_HERE,
       base::Bind(
           &AudioManagerAndroid::DoSetMuteOnAudioThread,
           base::Unretained(this),
           muted));
 }
 
+void AudioManagerAndroid::GetAudioInputDeviceNamesOnAudioThread(
+    base::WaitableEvent* event, AudioDeviceNames* device_names) {
+  DCHECK(GetTaskRunner()->BelongsToCurrentThread());
+
+  // Set up the initial list of available audio devices and register for
+  // broadcasted notifications about any changes of availability.
+  // This method is only executed when called for the first time and it can
+  // also be called from SetAudioDeviceOnAudioThread().
+  InitializeOnAudioThread();
+
+  // Always add default device parameters as first element.
+  DCHECK(device_names->empty());
+  AddDefaultDevice(device_names);
+
+  JNIEnv* env = AttachCurrentThread();
+  ScopedJavaLocalRef<jobjectArray> j_device_array =
+      Java_AudioManagerAndroid_getAudioInputDeviceNames(
+          env, j_audio_manager_.obj());
+  jsize len = env->GetArrayLength(j_device_array.obj());
+  AudioDeviceName device;
+  for (jsize i = 0; i < len; ++i) {
+    ScopedJavaLocalRef<jobject> j_device(
+        env, env->GetObjectArrayElement(j_device_array.obj(), i));
+    ScopedJavaLocalRef<jstring> j_device_name =
+        Java_AudioDeviceName_name(env, j_device.obj());
+    ConvertJavaStringToUTF8(env, j_device_name.obj(), &device.device_name);
+    ScopedJavaLocalRef<jstring> j_device_id =
+        Java_AudioDeviceName_id(env, j_device.obj());
+    ConvertJavaStringToUTF8(env, j_device_id.obj(), &device.unique_id);
+    device_names->push_back(device);
+  }
+
+  if (event)
+    event->Signal();
+}
+
+void AudioManagerAndroid::InitializeOnAudioThread() {
+  DCHECK(GetTaskRunner()->BelongsToCurrentThread());
+  if (!initialized_on_audio_thread_) {
+    base::MessageLoop::current()->AddDestructionObserver(this);
+    Java_AudioManagerAndroid_initAudioDeviceList(
+        base::android::AttachCurrentThread(),
+        j_audio_manager_.obj());
+    initialized_on_audio_thread_ = true;
+  }
+}
+
+void AudioManagerAndroid::CloseOnAudioThread() {
+  DCHECK(GetTaskRunner()->BelongsToCurrentThread());
+  if (!initialized_on_audio_thread_)
+    return;
+  Java_AudioManagerAndroid_closeAudioDeviceList(
+        base::android::AttachCurrentThread(),
+        j_audio_manager_.obj());
+  initialized_on_audio_thread_ = false;
+}
+
+bool AudioManagerAndroid::SetAudioDevice(const std::string& device_id) {
+  // Select audio device and use the audio thread to reduce the number of
+  // calling threads to the Java layer. Also, ensure that the calling thread
+  // sees this function call as synchronous.
+  bool result = false;
+  if (GetTaskRunner()->BelongsToCurrentThread()) {
+    SetAudioDeviceOnAudioThread(NULL, device_id, &result);
+  } else {
+    base::WaitableEvent event(false, false);

[tommi (sloooow) - chröme, 2014/01/30 12:51:11]

When is SetAudioDevice called outside of the audio thread?
I thought we would basically just add a DCHECK at the top of this function:
DCHECK(GetTaskRunner()->BelongsToCurrentThread());

and then do what is now done in SetAudioDeviceOnAudioThread.

If that's possible now, I would like to do it now instead of running into a
situation like we now have with MakeAudio[Input|Output]Stream.

[henrika (OOO until Aug 14), 2014/01/30 14:48:24]

I will have to fix the unit test to do so. Discussed with Joi. Will use same
style as he does in his private API test.

+    GetTaskRunner()->PostTask(
+        FROM_HERE,
+        base::Bind(
+            &AudioManagerAndroid::SetAudioDeviceOnAudioThread,
+            base::Unretained(this),
+            &event,
+            device_id,
+            &result));
+    event.Wait();
+  }
+  return result;
+}
+
+void AudioManagerAndroid::SetAudioDeviceOnAudioThread(
+    base::WaitableEvent* event, const std::string& device_id, bool* result) {
+  DCHECK(GetTaskRunner()->BelongsToCurrentThread());
+
+  // Set up the initial list of available audio devices and register for
+  // broadcasted notifications about any changes of availability.
+  // This method is only executed when called for the first time and it can
+  // also be called from GetAudioInputDeviceNamesOnAudioThread().
+  InitializeOnAudioThread();
+
+  // Send the unique device ID to the Java audio manager and make the
+  // device switch. Provide an empty string to the Java audio manager
+  // if the default device is selected.
+  JNIEnv* env = AttachCurrentThread();
+  ScopedJavaLocalRef<jstring> j_device_id = ConvertUTF8ToJavaString(
+      env,
+      device_id == AudioManagerBase::kDefaultDeviceId ?
+          std::string() : device_id);
+  *result = Java_AudioManagerAndroid_setDevice(
+      env, j_audio_manager_.obj(), j_device_id.obj());
+
+  if (event)
+    event->Signal();
+}
+
 void AudioManagerAndroid::DoSetMuteOnAudioThread(bool muted) {
+  DCHECK(GetTaskRunner()->BelongsToCurrentThread());
   base::AutoLock lock(streams_lock_);
   for (OutputStreams::iterator it = streams_.begin();
        it != streams_.end(); ++it) {
     (*it)->SetMute(muted);
   }
 }
 
 void AudioManagerAndroid::SetCommunicationAudioModeOn(bool on) {
   Java_AudioManagerAndroid_setCommunicationAudioModeOn(
       base::android::AttachCurrentThread(),
       j_audio_manager_.obj(), on);
 }
 
-bool AudioManagerAndroid::SetAudioDevice(const std::string& device_id) {
-  JNIEnv* env = AttachCurrentThread();
-
-  // Send the unique device ID to the Java audio manager and make the
-  // device switch. Provide an empty string to the Java audio manager
-  // if the default device is selected.
-  ScopedJavaLocalRef<jstring> j_device_id = ConvertUTF8ToJavaString(
-      env,
-      device_id == AudioManagerBase::kDefaultDeviceId ?
-          std::string() : device_id);
-  return Java_AudioManagerAndroid_setDevice(
-      env, j_audio_manager_.obj(), j_device_id.obj());
-}
-
 int AudioManagerAndroid::GetNativeOutputSampleRate() {
   return Java_AudioManagerAndroid_getNativeOutputSampleRate(
       base::android::AttachCurrentThread(),
       j_audio_manager_.obj());
 }
 
 bool AudioManagerAndroid::IsAudioLowLatencySupported() {
   return Java_AudioManagerAndroid_isAudioLowLatencySupported(
       base::android::AttachCurrentThread(),
       j_audio_manager_.obj());
 }
 
 int AudioManagerAndroid::GetAudioLowLatencyOutputFrameSize() {
   return Java_AudioManagerAndroid_getAudioLowLatencyOutputFrameSize(
       base::android::AttachCurrentThread(),
       j_audio_manager_.obj());
 }
 
 }  // namespace media