123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266 |
- // 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.
- #ifndef MEDIA_AUDIO_AUDIO_MANAGER_H_
- #define MEDIA_AUDIO_AUDIO_MANAGER_H_
- #include <memory>
- #include <string>
- #include "base/callback.h"
- #include "base/gtest_prod_util.h"
- #include "base/memory/ref_counted.h"
- #include "base/threading/thread_checker.h"
- #include "build/build_config.h"
- #include "media/audio/audio_device_description.h"
- #include "media/audio/audio_logging.h"
- #include "media/audio/audio_thread.h"
- #include "media/base/audio_parameters.h"
- namespace base {
- class SingleThreadTaskRunner;
- }
- namespace audio {
- class AudioManagerPowerUser;
- } // namespace audio
- namespace media {
- class AudioDebugRecordingManager;
- class AudioInputStream;
- class AudioManager;
- class AudioOutputStream;
- // Manages all audio resources. Provides some convenience functions that avoid
- // the need to provide iterators over the existing streams.
- class MEDIA_EXPORT AudioManager {
- public:
- AudioManager(const AudioManager&) = delete;
- AudioManager& operator=(const AudioManager&) = delete;
- virtual ~AudioManager();
- // Construct the audio manager; only one instance is allowed.
- //
- // The manager will forward CreateAudioLog() calls to the provided
- // AudioLogFactory; as such |audio_log_factory| must outlive the AudioManager.
- //
- // The manager will use |audio_thread->GetTaskRunner()| for audio IO.
- // On OS_MAC, CoreAudio requires that |audio_thread->GetTaskRunner()|
- // must belong to the main thread of the process, which in our case is sadly
- // the browser UI thread. Failure to execute calls on the right thread leads
- // to crashes and odd behavior. See http://crbug.com/158170.
- //
- // The manager will use |audio_thread->GetWorkerTaskRunner()| for heavyweight
- // tasks. The |audio_thread->GetWorkerTaskRunner()| may be the same as
- // |audio_thread->GetTaskRunner()|.
- static std::unique_ptr<AudioManager> Create(
- std::unique_ptr<AudioThread> audio_thread,
- AudioLogFactory* audio_log_factory);
- // A convenience wrapper of AudioManager::Create for testing.
- static std::unique_ptr<AudioManager> CreateForTesting(
- std::unique_ptr<AudioThread> audio_thread);
- // Sets the name of the audio source as seen by external apps.
- static void SetGlobalAppName(const std::string& app_name);
- // Returns the app name or an empty string if it is not set.
- static const std::string& GetGlobalAppName();
- // Returns the pointer to the last created instance, or NULL if not yet
- // created. This is a utility method for the code outside of media directory,
- // like src/chrome.
- static AudioManager* Get();
- // Synchronously releases all audio resources.
- // Must be called before deletion and on the same thread as AudioManager
- // was created.
- // Returns true on success but false if AudioManager could not be shutdown.
- // AudioManager instance must not be deleted if shutdown failed.
- virtual bool Shutdown();
- // Log callback used for sending log messages from a stream to the object
- // that manages the stream.
- using LogCallback = base::RepeatingCallback<void(const std::string&)>;
- // Factory for all the supported stream formats. |params| defines parameters
- // of the audio stream to be created.
- //
- // |params.sample_per_packet| is the requested buffer allocation which the
- // audio source thinks it can usually fill without blocking. Internally two
- // or three buffers are created, one will be locked for playback and one will
- // be ready to be filled in the call to AudioSourceCallback::OnMoreData().
- //
- // To create a stream for the default output device, pass an empty string
- // for |device_id|, otherwise the specified audio device will be opened.
- //
- // Returns NULL if the combination of the parameters is not supported, or if
- // we have reached some other platform specific limit.
- //
- // |params.format| can be set to AUDIO_PCM_LOW_LATENCY and that has two
- // effects:
- // 1- Instead of triple buffered the audio will be double buffered.
- // 2- A low latency driver or alternative audio subsystem will be used when
- // available.
- //
- // Do not free the returned AudioOutputStream. It is owned by AudioManager.
- virtual AudioOutputStream* MakeAudioOutputStream(
- const AudioParameters& params,
- const std::string& device_id,
- const LogCallback& log_callback) = 0;
- // Creates new audio output proxy. A proxy implements
- // AudioOutputStream interface, but unlike regular output stream
- // created with MakeAudioOutputStream() it opens device only when a
- // sound is actually playing.
- virtual AudioOutputStream* MakeAudioOutputStreamProxy(
- const AudioParameters& params,
- const std::string& device_id) = 0;
- // Factory to create audio recording streams.
- // |channels| can be 1 or 2.
- // |sample_rate| is in hertz and can be any value supported by the platform.
- // |samples_per_packet| is in hertz as well and can be 0 to |sample_rate|,
- // with 0 suggesting that the implementation use a default value for that
- // platform.
- // Returns NULL if the combination of the parameters is not supported, or if
- // we have reached some other platform specific limit.
- //
- // Do not free the returned AudioInputStream. It is owned by AudioManager.
- // When you are done with it, call |Stop()| and |Close()| to release it.
- virtual AudioInputStream* MakeAudioInputStream(
- const AudioParameters& params,
- const std::string& device_id,
- const LogCallback& log_callback) = 0;
- // Returns the task runner used for audio IO.
- base::SingleThreadTaskRunner* GetTaskRunner() const {
- return audio_thread_->GetTaskRunner();
- }
- // Heavyweight tasks should use GetWorkerTaskRunner() instead of
- // GetTaskRunner(). On most platforms they are the same, but some share the
- // UI loop with the audio IO loop.
- base::SingleThreadTaskRunner* GetWorkerTaskRunner() const {
- return audio_thread_->GetWorkerTaskRunner();
- }
- // Allows clients to listen for device state changes; e.g. preferred sample
- // rate or channel layout changes. The typical response to receiving this
- // callback is to recreate the stream.
- class AudioDeviceListener {
- public:
- virtual void OnDeviceChange() = 0;
- };
- virtual void AddOutputDeviceChangeListener(AudioDeviceListener* listener) = 0;
- virtual void RemoveOutputDeviceChangeListener(
- AudioDeviceListener* listener) = 0;
- // Create a new AudioLog object for tracking the behavior for one or more
- // instances of the given component. See AudioLogFactory for more details.
- virtual std::unique_ptr<AudioLog> CreateAudioLog(
- AudioLogFactory::AudioComponent component,
- int component_id) = 0;
- // Get debug recording manager. This can only be called on AudioManager's
- // thread (GetTaskRunner()).
- virtual AudioDebugRecordingManager* GetAudioDebugRecordingManager() = 0;
- // Gets the name of the audio manager (e.g., Windows, Mac, PulseAudio).
- virtual const char* GetName() = 0;
- // Limits the number of streams that can be created for testing purposes.
- virtual void SetMaxStreamCountForTesting(int max_input, int max_output);
- protected:
- FRIEND_TEST_ALL_PREFIXES(AudioManagerTest, AudioDebugRecording);
- friend class AudioDeviceInfoAccessorForTests;
- friend class audio::AudioManagerPowerUser;
- explicit AudioManager(std::unique_ptr<AudioThread> audio_thread);
- virtual void ShutdownOnAudioThread() = 0;
- // Initializes debug recording. Can be called on any thread; will post to the
- // audio thread if not called on it.
- virtual void InitializeDebugRecording() = 0;
- // Returns true if the OS reports existence of audio devices. This does not
- // guarantee that the existing devices support all formats and sample rates.
- virtual bool HasAudioOutputDevices() = 0;
- // Returns true if the OS reports existence of audio recording devices. This
- // does not guarantee that the existing devices support all formats and
- // sample rates.
- virtual bool HasAudioInputDevices() = 0;
- // Appends a list of available input devices to |device_descriptions|,
- // which must initially be empty. It is not guaranteed that all the
- // devices in the list support all formats and sample rates for
- // recording.
- //
- // Not threadsafe; in production this should only be called from the
- // Audio worker thread (see GetTaskRunner()).
- virtual void GetAudioInputDeviceDescriptions(
- AudioDeviceDescriptions* device_descriptions) = 0;
- // Appends a list of available output devices to |device_descriptions|,
- // which must initially be empty.
- //
- // Not threadsafe; in production this should only be called from the
- // Audio worker thread (see GetTaskRunner()).
- virtual void GetAudioOutputDeviceDescriptions(
- AudioDeviceDescriptions* device_descriptions) = 0;
- // Returns the default output hardware audio parameters for opening output
- // streams. It is a convenience interface to
- // AudioManagerBase::GetPreferredOutputStreamParameters and each AudioManager
- // does not need their own implementation to this interface.
- // TODO(tommi): Remove this method and use GetOutputStreamParameteres instead.
- virtual AudioParameters GetDefaultOutputStreamParameters() = 0;
- // Returns the output hardware audio parameters for a specific output device.
- virtual AudioParameters GetOutputStreamParameters(
- const std::string& device_id) = 0;
- // Returns the input hardware audio parameters of the specific device
- // for opening input streams. Each AudioManager needs to implement their own
- // version of this interface.
- virtual AudioParameters GetInputStreamParameters(
- const std::string& device_id) = 0;
- // Returns the device id of an output device that belongs to the same hardware
- // as the specified input device.
- // If the hardware has only an input device (e.g. a webcam), the return value
- // will be empty (which the caller can then interpret to be the default output
- // device). Implementations that don't yet support this feature, must return
- // an empty string. Must be called on the audio worker thread (see
- // GetTaskRunner()).
- virtual std::string GetAssociatedOutputDeviceID(
- const std::string& input_device_id) = 0;
- // These functions return the ID of the default/communications audio
- // input/output devices respectively.
- // Implementations that do not support this functionality should return an
- // empty string.
- virtual std::string GetDefaultInputDeviceID() = 0;
- virtual std::string GetDefaultOutputDeviceID() = 0;
- virtual std::string GetCommunicationsInputDeviceID() = 0;
- virtual std::string GetCommunicationsOutputDeviceID() = 0;
- private:
- friend class AudioSystemHelper;
- std::unique_ptr<AudioThread> audio_thread_;
- bool shutdown_ = false; // True after |this| has been shutdown.
- THREAD_CHECKER(thread_checker_);
- };
- } // namespace media
- #endif // MEDIA_AUDIO_AUDIO_MANAGER_H_
|