src/media/audio/audio_output_controller.h

   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.
   4
   5 #ifndef MEDIA_AUDIO_AUDIO_OUTPUT_CONTROLLER_H_
   6 #define MEDIA_AUDIO_AUDIO_OUTPUT_CONTROLLER_H_
   7
   8 #include "base/atomic_ref_count.h"
   9 #include "base/callback.h"
  10 #include "base/memory/ref_counted.h"
  11 #include "base/timer/timer.h"
  12 #include "media/audio/audio_io.h"
  13 #include "media/audio/audio_manager.h"
  14 #include "media/audio/audio_power_monitor.h"
  15 #include "media/audio/audio_source_diverter.h"
  16 #include "media/audio/simple_sources.h"
  17 #include "media/base/media_export.h"
  18
  19 // An AudioOutputController controls an AudioOutputStream and provides data
  20 // to this output stream. It has an important function that it executes
  21 // audio operations like play, pause, stop, etc. on a separate thread,
  22 // namely the audio manager thread.
  23 //
  24 // All the public methods of AudioOutputController are non-blocking.
  25 // The actual operations are performed on the audio manager thread.
  26 //
  27 // Here is a state transition diagram for the AudioOutputController:
  28 //
  29 //   *[ Empty ]  -->  [ Created ]  -->  [ Playing ]  -------.
  30 //        |                |               |    ^           |
  31 //        |                |               |    |           |
  32 //        |                |               |    |           v
  33 //        |                |               |    `-----  [ Paused ]
  34 //        |                |               |                |
  35 //        |                v               v                |
  36 //        `----------->  [      Closed       ]  <-----------'
  37 //
  38 // * Initial state
  39 //
  40 // At any time after reaching the Created state but before Closed, the
  41 // AudioOutputController may be notified of a device change via
  42 // OnDeviceChange().  As the OnDeviceChange() is processed, state transitions
  43 // will occur, ultimately ending up in an equivalent pre-call state.  E.g., if
  44 // the state was Paused, the new state will be Created, since these states are
  45 // all functionally equivalent and require a Play() call to continue to the next
  46 // state.
  47 //
  48 // The AudioOutputStream can request data from the AudioOutputController via the
  49 // AudioSourceCallback interface. AudioOutputController uses the SyncReader
  50 // passed to it via construction to synchronously fulfill this read request.
  51 //
  52
  53 namespace media {
  54
  55 // Only do power monitoring for non-mobile platforms that need it for the UI.
  56 #if !defined(OS_ANDROID) && !defined(OS_IOS)
  57 #define AUDIO_POWER_MONITORING
  58 #endif
  59
  60 class MEDIA_EXPORT AudioOutputController
  61     : public base::RefCountedThreadSafe<AudioOutputController>,
  62       public AudioOutputStream::AudioSourceCallback,
  63       public AudioSourceDiverter,
  64       NON_EXPORTED_BASE(public AudioManager::AudioDeviceListener)  {
  65  public:
  66   // An event handler that receives events from the AudioOutputController. The
  67   // following methods are called on the audio manager thread.
  68   class MEDIA_EXPORT EventHandler {
  69    public:
  70     virtual void OnCreated() = 0;
  71     virtual void OnPlaying() = 0;
  72     virtual void OnPaused() = 0;
  73     virtual void OnError() = 0;
  74     virtual void OnDeviceChange(int new_buffer_size, int new_sample_rate) = 0;
  75
  76    protected:
  77     virtual ~EventHandler() {}
  78   };
  79
  80   // A synchronous reader interface used by AudioOutputController for
  81   // synchronous reading.
  82   // TODO(crogers): find a better name for this class and the Read() method
  83   // now that it can handle synchronized I/O.
  84   class SyncReader {
  85    public:
  86     virtual ~SyncReader() {}
  87
  88     // Notify the synchronous reader the number of bytes in the
  89     // AudioOutputController not yet played. This is used by SyncReader to
  90     // prepare more data and perform synchronization.
  91     virtual void UpdatePendingBytes(uint32 bytes) = 0;
  92
  93     // Attempts to completely fill |dest|, zeroing |dest| if the request can not
  94     // be fulfilled (due to timeout).  |source| may optionally be provided for
  95     // input data.
  96     virtual void Read(const AudioBus* source, AudioBus* dest) = 0;
  97
  98     // Close this synchronous reader.
  99     virtual void Close() = 0;
 100   };
 101
 102   // Factory method for creating an AudioOutputController.
 103   // This also creates and opens an AudioOutputStream on the audio manager
 104   // thread, and if this is successful, the |event_handler| will receive an
 105   // OnCreated() call from the same audio manager thread.  |audio_manager| must
 106   // outlive AudioOutputController.
 107   // The |output_device_id| can be either empty (default device) or specify a
 108   // specific hardware device for audio output.
 109   static scoped_refptr<AudioOutputController> Create(
 110       AudioManager* audio_manager, EventHandler* event_handler,
 111       const AudioParameters& params, const std::string& output_device_id,
 112       SyncReader* sync_reader);
 113
 114   // Methods to control playback of the stream.
 115
 116   // Starts the playback of this audio output stream.
 117   void Play();
 118
 119   // Pause this audio output stream.
 120   void Pause();
 121
 122   // Closes the audio output stream. The state is changed and the resources
 123   // are freed on the audio manager thread. closed_task is executed after that.
 124   // Callbacks (EventHandler and SyncReader) must exist until closed_task is
 125   // called.
 126   //
 127   // It is safe to call this method more than once. Calls after the first one
 128   // will have no effect.
 129   void Close(const base::Closure& closed_task);
 130
 131   // Sets the volume of the audio output stream.
 132   void SetVolume(double volume);
 133
 134   // Calls |callback| (on the caller's thread) with the current output
 135   // device ID.
 136   void GetOutputDeviceId(
 137       base::Callback<void(const std::string&)> callback) const;
 138
 139   // Changes which output device to use. If desired, you can provide a
 140   // callback that will be notified (on the thread you called from)
 141   // when the function has completed execution.
 142   //
 143   // Changing the output device causes the controller to go through
 144   // the same state transition back to the current state as a call to
 145   // OnDeviceChange (unless it is currently diverting, see
 146   // Start/StopDiverting below, in which case the state transition
 147   // will happen when StopDiverting is called).
 148   void SwitchOutputDevice(const std::string& output_device_id,
 149                           const base::Closure& callback);
 150
 151   // AudioSourceCallback implementation.
 152   virtual int OnMoreData(AudioBus* dest,
 153                          AudioBuffersState buffers_state) OVERRIDE;
 154   virtual int OnMoreIOData(AudioBus* source,
 155                            AudioBus* dest,
 156                            AudioBuffersState buffers_state) OVERRIDE;
 157   virtual void OnError(AudioOutputStream* stream) OVERRIDE;
 158
 159   // AudioDeviceListener implementation.  When called AudioOutputController will
 160   // shutdown the existing |stream_|, transition to the kRecreating state,
 161   // create a new stream, and then transition back to an equivalent state prior
 162   // to being called.
 163   virtual void OnDeviceChange() OVERRIDE;
 164
 165   // AudioSourceDiverter implementation.
 166   virtual const AudioParameters& GetAudioParameters() OVERRIDE;
 167   virtual void StartDiverting(AudioOutputStream* to_stream) OVERRIDE;
 168   virtual void StopDiverting() OVERRIDE;
 169
 170   // Accessor for AudioPowerMonitor::ReadCurrentPowerAndClip().  See comments in
 171   // audio_power_monitor.h for usage.  This may be called on any thread.
 172   std::pair<float, bool> ReadCurrentPowerAndClip();
 173
 174  protected:
 175   // Internal state of the source.
 176   enum State {
 177     kEmpty,
 178     kCreated,
 179     kPlaying,
 180     kPaused,
 181     kClosed,
 182     kError,
 183   };
 184
 185   friend class base::RefCountedThreadSafe<AudioOutputController>;
 186   virtual ~AudioOutputController();
 187
 188  private:
 189   // We are polling sync reader if data became available.
 190   static const int kPollNumAttempts;
 191   static const int kPollPauseInMilliseconds;
 192
 193   AudioOutputController(AudioManager* audio_manager, EventHandler* handler,
 194                         const AudioParameters& params,
 195                         const std::string& output_device_id,
 196                         SyncReader* sync_reader);
 197
 198   // The following methods are executed on the audio manager thread.
 199   void DoCreate(bool is_for_device_change);
 200   void DoPlay();
 201   void DoPause();
 202   void DoClose();
 203   void DoSetVolume(double volume);
 204   std::string DoGetOutputDeviceId() const;
 205   void DoSwitchOutputDevice(const std::string& output_device_id);
 206   void DoReportError();
 207   void DoStartDiverting(AudioOutputStream* to_stream);
 208   void DoStopDiverting();
 209
 210   // Helper method that stops the physical stream.
 211   void StopStream();
 212
 213   // Helper method that stops, closes, and NULLs |*stream_|.
 214   void DoStopCloseAndClearStream();
 215
 216   // Checks if a stream was started successfully but never calls OnMoreIOData().
 217   void WedgeCheck();
 218
 219   AudioManager* const audio_manager_;
 220   const AudioParameters params_;
 221   EventHandler* const handler_;
 222
 223   // Specifies the device id of the output device to open or empty for the
 224   // default output device.
 225   std::string output_device_id_;
 226
 227   AudioOutputStream* stream_;
 228
 229   // When non-NULL, audio is being diverted to this stream.
 230   AudioOutputStream* diverting_to_stream_;
 231
 232   // The current volume of the audio stream.
 233   double volume_;
 234
 235   // |state_| is written on the audio manager thread and is read on the
 236   // hardware audio thread. These operations need to be locked. But lock
 237   // is not required for reading on the audio manager thread.
 238   State state_;
 239
 240   // SyncReader is used only in low latency mode for synchronous reading.
 241   SyncReader* const sync_reader_;
 242
 243   // The message loop of audio manager thread that this object runs on.
 244   const scoped_refptr<base::SingleThreadTaskRunner> message_loop_;
 245
 246 #if defined(AUDIO_POWER_MONITORING)
 247   // Scans audio samples from OnMoreIOData() as input to compute power levels.
 248   AudioPowerMonitor power_monitor_;
 249 #endif
 250
 251   // Flags when we've asked for a stream to start but it never did.
 252   base::AtomicRefCount on_more_io_data_called_;
 253   scoped_ptr<base::OneShotTimer<AudioOutputController> > wedge_timer_;
 254
 255   DISALLOW_COPY_AND_ASSIGN(AudioOutputController);
 256 };
 257
 258 }  // namespace media
 259
 260 #endif  // MEDIA_AUDIO_AUDIO_OUTPUT_CONTROLLER_H_