audio_output_dispatcher.h revision 5d1f7b1de12d16ceb2c938c56701a3e8bfa558f7
1f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)// AudioOutputDispatcher is a single-threaded base class that dispatches 6f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)// creation and deletion of audio output streams. AudioOutputProxy objects use 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// this class to allocate and recycle actual audio output streams. When playback 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// is started, the proxy calls StartStream() to get an output stream that it 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// uses to play audio. When playback is stopped, the proxy returns the stream 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// back to the dispatcher by calling StopStream(). 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// AudioManagerBase creates one specialization of AudioOutputDispatcher on the 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// audio thread for each possible set of audio parameters. I.e streams with 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// different parameters are managed independently. The AudioOutputDispatcher 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// instance is then deleted on the audio thread when the AudioManager shuts 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// down. 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef MEDIA_AUDIO_AUDIO_OUTPUT_DISPATCHER_H_ 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define MEDIA_AUDIO_AUDIO_OUTPUT_DISPATCHER_H_ 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/ref_counted.h" 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/timer/timer.h" 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "media/audio/audio_io.h" 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "media/audio/audio_manager.h" 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "media/audio/audio_parameters.h" 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SingleThreadTaskRunner; 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace media { 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class AudioOutputProxy; 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class MEDIA_EXPORT AudioOutputDispatcher 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) : public base::RefCountedThreadSafe<AudioOutputDispatcher> { 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AudioOutputDispatcher(AudioManager* audio_manager, 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const AudioParameters& params, 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& device_id); 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called by AudioOutputProxy to open the stream. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns false, if it fails to open it. 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OpenStream() = 0; 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called by AudioOutputProxy when the stream is started. 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Uses |callback| to get source data and report errors, if any. 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Does *not* take ownership of this callback. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if started successfully, false otherwise. 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool StartStream(AudioOutputStream::AudioSourceCallback* callback, 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AudioOutputProxy* stream_proxy) = 0; 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called by AudioOutputProxy when the stream is stopped. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Ownership of the |stream_proxy| is passed to the dispatcher. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void StopStream(AudioOutputProxy* stream_proxy) = 0; 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called by AudioOutputProxy when the volume is set. 59424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) virtual void StreamVolumeSet(AudioOutputProxy* stream_proxy, 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) double volume) = 0; 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called by AudioOutputProxy when the stream is closed. 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void CloseStream(AudioOutputProxy* stream_proxy) = 0; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called on the audio thread when the AudioManager is shutting down. 66a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) virtual void Shutdown() = 0; 67a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called by the AudioManager to restart streams when a wedge is detected. A 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // wedge means the OS failed to request any audio after StartStream(). When a 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // wedge is detected all streams across all dispatchers must be closed. After 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // all streams are closed, streams are restarted. See http://crbug.com/160920 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void CloseStreamsForWedgeFix() = 0; 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void RestartStreamsForWedgeFix() = 0; 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const std::string& device_id() const { return device_id_; } 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class base::RefCountedThreadSafe<AudioOutputDispatcher>; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~AudioOutputDispatcher(); 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A no-reference-held pointer (we don't want circular references) back to the 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // AudioManager that owns this object. 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AudioManager* audio_manager_; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const scoped_refptr<base::SingleThreadTaskRunner> task_runner_; 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const AudioParameters params_; 86424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) std::string device_id_; 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(AudioOutputDispatcher); 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace media 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // MEDIA_AUDIO_AUDIO_OUTPUT_DISPATCHER_H_ 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)