1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef MEDIA_AUDIO_AUDIO_MANAGER_BASE_H_
6 #define MEDIA_AUDIO_AUDIO_MANAGER_BASE_H_
11 #include "base/compiler_specific.h"
12 #include "base/memory/scoped_ptr.h"
13 #include "base/memory/scoped_vector.h"
14 #include "base/observer_list.h"
15 #include "base/threading/thread.h"
16 #include "media/audio/audio_manager.h"
18 #include "media/audio/audio_output_dispatcher.h"
21 #include "base/win/scoped_com_initializer.h"
26 class AudioOutputDispatcher;
28 // AudioManagerBase provides AudioManager functions common for all platforms.
29 class MEDIA_EXPORT AudioManagerBase : public AudioManager {
31 // TODO(sergeyu): The constants below belong to AudioManager interface, not
32 // to the base implementation.
34 // Name of the generic "default" device.
35 static const char kDefaultDeviceName[];
36 // Unique Id of the generic "default" device.
37 static const char kDefaultDeviceId[];
39 // Input device ID used to capture the default system playback stream. When
40 // this device ID is passed to MakeAudioInputStream() the returned
41 // AudioInputStream will be capturing audio currently being played on the
42 // default playback device. At the moment this feature is supported only on
43 // some platforms. AudioInputStream::Intialize() will return an error on
44 // platforms that don't support it. GetInputStreamParameters() must be used
45 // to get the parameters of the loopback device before creating a loopback
46 // stream, otherwise stream initialization may fail.
47 static const char kLoopbackInputDeviceId[];
49 virtual ~AudioManagerBase();
51 virtual scoped_refptr<base::SingleThreadTaskRunner> GetTaskRunner() OVERRIDE;
52 virtual scoped_refptr<base::SingleThreadTaskRunner> GetWorkerTaskRunner()
55 virtual base::string16 GetAudioInputDeviceModel() OVERRIDE;
57 virtual void ShowAudioInputSettings() OVERRIDE;
59 virtual void GetAudioInputDeviceNames(
60 AudioDeviceNames* device_names) OVERRIDE;
62 virtual void GetAudioOutputDeviceNames(
63 AudioDeviceNames* device_names) OVERRIDE;
65 virtual AudioOutputStream* MakeAudioOutputStream(
66 const AudioParameters& params,
67 const std::string& device_id,
68 const std::string& input_device_id) OVERRIDE;
70 virtual AudioInputStream* MakeAudioInputStream(
71 const AudioParameters& params, const std::string& device_id) OVERRIDE;
73 virtual AudioOutputStream* MakeAudioOutputStreamProxy(
74 const AudioParameters& params,
75 const std::string& device_id,
76 const std::string& input_device_id) OVERRIDE;
78 // Called internally by the audio stream when it has been closed.
79 virtual void ReleaseOutputStream(AudioOutputStream* stream);
80 virtual void ReleaseInputStream(AudioInputStream* stream);
82 // Creates the output stream for the |AUDIO_PCM_LINEAR| format. The legacy
83 // name is also from |AUDIO_PCM_LINEAR|.
84 virtual AudioOutputStream* MakeLinearOutputStream(
85 const AudioParameters& params) = 0;
87 // Creates the output stream for the |AUDIO_PCM_LOW_LATENCY| format.
88 // |input_device_id| is used by unified IO to open the correct input device.
89 virtual AudioOutputStream* MakeLowLatencyOutputStream(
90 const AudioParameters& params,
91 const std::string& device_id,
92 const std::string& input_device_id) = 0;
94 // Creates the input stream for the |AUDIO_PCM_LINEAR| format. The legacy
95 // name is also from |AUDIO_PCM_LINEAR|.
96 virtual AudioInputStream* MakeLinearInputStream(
97 const AudioParameters& params, const std::string& device_id) = 0;
99 // Creates the input stream for the |AUDIO_PCM_LOW_LATENCY| format.
100 virtual AudioInputStream* MakeLowLatencyInputStream(
101 const AudioParameters& params, const std::string& device_id) = 0;
103 // Listeners will be notified on the GetTaskRunner() task runner.
104 virtual void AddOutputDeviceChangeListener(
105 AudioDeviceListener* listener) OVERRIDE;
106 virtual void RemoveOutputDeviceChangeListener(
107 AudioDeviceListener* listener) OVERRIDE;
109 virtual AudioParameters GetDefaultOutputStreamParameters() OVERRIDE;
110 virtual AudioParameters GetOutputStreamParameters(
111 const std::string& device_id) OVERRIDE;
113 virtual AudioParameters GetInputStreamParameters(
114 const std::string& device_id) OVERRIDE;
116 virtual std::string GetAssociatedOutputDeviceID(
117 const std::string& input_device_id) OVERRIDE;
119 virtual scoped_ptr<AudioLog> CreateAudioLog(
120 AudioLogFactory::AudioComponent component) OVERRIDE;
122 virtual void FixWedgedAudio() OVERRIDE;
125 AudioManagerBase(AudioLogFactory* audio_log_factory);
127 // Shuts down the audio thread and releases all the audio output dispatchers
128 // on the audio thread. All audio streams should be freed before Shutdown()
129 // is called. This must be called in the destructor of every AudioManagerBase
133 void SetMaxOutputStreamsAllowed(int max) { max_num_output_streams_ = max; }
135 // Called by each platform specific AudioManager to notify output state change
136 // listeners that a state change has occurred. Must be called from the audio
138 void NotifyAllOutputDeviceChangeListeners();
140 // Returns user buffer size as specified on the command line or 0 if no buffer
141 // size has been specified.
142 int GetUserBufferSize();
144 // Returns the preferred hardware audio output parameters for opening output
145 // streams. If the users inject a valid |input_params|, each AudioManager
146 // will decide if they should return the values from |input_params| or the
147 // default hardware values. If the |input_params| is invalid, it will return
148 // the default hardware audio parameters.
149 // If |output_device_id| is empty, the implementation must treat that as
150 // a request for the default output device.
151 virtual AudioParameters GetPreferredOutputStreamParameters(
152 const std::string& output_device_id,
153 const AudioParameters& input_params) = 0;
155 // Returns the ID of the default audio output device.
156 // Implementations that don't yet support this should return an empty string.
157 virtual std::string GetDefaultOutputDeviceID();
159 // Get number of input or output streams.
160 int input_stream_count() { return num_input_streams_; }
161 int output_stream_count() { return num_output_streams_; }
164 struct DispatcherParams;
165 typedef ScopedVector<DispatcherParams> AudioOutputDispatchers;
167 class CompareByParams;
169 // Called by Shutdown().
170 void ShutdownOnAudioThread();
172 // Max number of open output streams, modified by
173 // SetMaxOutputStreamsAllowed().
174 int max_num_output_streams_;
176 // Max number of open input streams.
177 int max_num_input_streams_;
179 // Number of currently open output streams.
180 int num_output_streams_;
182 // Number of currently open input streams.
183 int num_input_streams_;
185 // Track output state change listeners.
186 ObserverList<AudioDeviceListener> output_listeners_;
188 // Thread used to interact with audio streams created by this audio manager.
189 base::Thread audio_thread_;
191 // The task runner of the audio thread this object runs on. Used for internal
192 // tasks which run on the audio thread even after Shutdown() has been started
193 // and GetTaskRunner() starts returning NULL.
194 scoped_refptr<base::SingleThreadTaskRunner> task_runner_;
196 // Map of cached AudioOutputDispatcher instances. Must only be touched
197 // from the audio thread (no locking).
198 AudioOutputDispatchers output_dispatchers_;
200 // Proxy for creating AudioLog objects.
201 AudioLogFactory* const audio_log_factory_;
203 DISALLOW_COPY_AND_ASSIGN(AudioManagerBase);
208 #endif // MEDIA_AUDIO_AUDIO_MANAGER_BASE_H_