Moves ownership of OpenSL engine object to Android audio manager

webrtc/modules/audio_device/android/audio_manager.h

 /*
  *  Copyright (c) 2015 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.
  */
 
 #ifndef WEBRTC_MODULES_AUDIO_DEVICE_ANDROID_AUDIO_MANAGER_H_
 #define WEBRTC_MODULES_AUDIO_DEVICE_ANDROID_AUDIO_MANAGER_H_
 
 #include <memory>
 
 #include <jni.h>
+#include <SLES/OpenSLES.h>
 
 #include "webrtc/base/thread_checker.h"
 #include "webrtc/modules/audio_device/android/audio_common.h"
 #include "webrtc/modules/audio_device/audio_device_config.h"
 #include "webrtc/modules/audio_device/include/audio_device_defines.h"
+#include "webrtc/modules/audio_device/android/opensles_common.h"
 #include "webrtc/modules/audio_device/audio_device_generic.h"
 #include "webrtc/modules/utility/include/helpers_android.h"
 #include "webrtc/modules/utility/include/jvm_android.h"
 
 namespace webrtc {
 
 // Implements support for functions in the WebRTC audio stack for Android that
 // relies on the AudioManager in android.media. It also populates an
 // AudioParameter structure with native audio parameters detected at
 // construction. This class does not make any audio-related modifications
@@ skipping 24 matching lines @@
     jmethodID is_device_blacklisted_for_open_sles_usage_;
   };
 
   AudioManager();
   ~AudioManager();
 
   // Sets the currently active audio layer combination. Must be called before
   // Init().
   void SetActiveAudioLayer(AudioDeviceModule::AudioLayer audio_layer);
 
+  // Creates and realizes the main (global) Open SL engine object and returns
+  // a reference to it. The engine object is only created at the first call
+  // since OpenSL ES for Android only supports a single engine per application.
+  // Subsequent calls returns the already created engine. The SL engine object
+  // is destroyed when the AudioManager object is deleted. It means that the
+  // engine object will be the first OpenSL ES object to be created and last
+  // object to be destroyed.
+  // Note that NULL will be returned unless the audio layer is specified as
+  // AudioDeviceModule::kAndroidOpenSLESAudio or
+  // AudioDeviceModule::kAndroidJavaInputAndOpenSLESOutputAudio.
+  SLObjectItf GetOpenSLEngine();
+
   // Initializes the audio manager and stores the current audio mode.
   bool Init();
   // Revert any setting done by Init().
   bool Close();
 
   // Returns true if current audio mode is AudioManager.MODE_IN_COMMUNICATION.
   bool IsCommunicationModeEnabled() const;
 
   // Native audio parameters stored during construction.
   const AudioParameters& GetPlayoutAudioParameters();
@@ skipping 60 matching lines @@
 
   // Wraps the JNI interface pointer and methods associated with it.
   std::unique_ptr<JNIEnvironment> j_environment_;
 
   // Contains factory method for creating the Java object.
   std::unique_ptr<NativeRegistration> j_native_registration_;
 
   // Wraps the Java specific parts of the AudioManager.
   std::unique_ptr<AudioManager::JavaAudioManager> j_audio_manager_;
 
+  // Contains the selected audio layer specified by the AudioLayer enumerator
+  // in the AudioDeviceModule class.
   AudioDeviceModule::AudioLayer audio_layer_;
 
+  // This object is the global entry point of the OpenSL ES API.
+  // After creating the engine object, the application can obtain this object‘s
+  // SLEngineItf interface. This interface contains creation methods for all
+  // the other object types in the API. None of these interface are realized
+  // by this class. It only provides access to the global engine object.
+  webrtc::ScopedSLObjectItf engine_object_;
+
   // Set to true by Init() and false by Close().
   bool initialized_;
 
   // True if device supports hardware (or built-in) AEC.
   bool hardware_aec_;
   // True if device supports hardware (or built-in) AGC.
   bool hardware_agc_;
   // True if device supports hardware (or built-in) NS.
   bool hardware_ns_;
 
@@ skipping 10 matching lines @@
   // Contains native parameters (e.g. sample rate, channel configuration).
   // Set at construction in OnCacheAudioParameters() which is called from
   // Java on the same thread as this object is created on.
   AudioParameters playout_parameters_;
   AudioParameters record_parameters_;
 };
 
 }  // namespace webrtc
 
 #endif  // WEBRTC_MODULES_AUDIO_DEVICE_ANDROID_AUDIO_MANAGER_H_