12a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 22a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 32a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// found in the LICENSE file. 42a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 52a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#ifndef CONTENT_RENDERER_MEDIA_WEBRTC_LOCAL_AUDIO_RENDERER_H_ 62a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#define CONTENT_RENDERER_MEDIA_WEBRTC_LOCAL_AUDIO_RENDERER_H_ 72a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 8bb1529ce867d8845a77ec7cdf3e3003ef1771a40Ben Murdoch#include <vector> 9bb1529ce867d8845a77ec7cdf3e3003ef1771a40Ben Murdoch 102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/callback.h" 112a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/memory/ref_counted.h" 12f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)#include "base/message_loop/message_loop_proxy.h" 132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/synchronization/lock.h" 142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/threading/thread_checker.h" 152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "content/common/content_export.h" 16a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#include "content/public/renderer/media_stream_audio_sink.h" 177dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#include "content/renderer/media/media_stream_audio_renderer.h" 182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "content/renderer/media/webrtc_audio_device_impl.h" 19c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "content/renderer/media/webrtc_local_audio_track.h" 20a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#include "third_party/WebKit/public/platform/WebMediaStreamTrack.h" 212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 222a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace media { 232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class AudioBus; 245f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)class AudioBlockFifo; 25c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)class AudioOutputDevice; 262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class AudioParameters; 272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} 282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)namespace content { 302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class WebRtcAudioCapturer; 322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 337dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch// WebRtcLocalAudioRenderer is a MediaStreamAudioRenderer designed for rendering 347dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch// local audio media stream tracks, 352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// http://dev.w3.org/2011/webrtc/editor/getusermedia.html#mediastreamtrack 362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// It also implements media::AudioRendererSink::RenderCallback to render audio 37c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// data provided from a WebRtcLocalAudioTrack source. 382a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// When the audio layer in the browser process asks for data to render, this 39a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)// class provides the data by implementing the MediaStreamAudioSink 402a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// interface, i.e., we are a sink seen from the WebRtcAudioCapturer perspective. 412a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// TODO(henrika): improve by using similar principles as in RTCVideoRenderer 422a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// which register itself to the video track when the provider is started and 432a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// deregisters itself when it is stopped. 442a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)// Tracking this at http://crbug.com/164813. 452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class CONTENT_EXPORT WebRtcLocalAudioRenderer 467dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch : NON_EXPORTED_BASE(public MediaStreamAudioRenderer), 47a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) NON_EXPORTED_BASE(public MediaStreamAudioSink), 48a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) NON_EXPORTED_BASE(public media::AudioRendererSink::RenderCallback) { 492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) public: 502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Creates a local renderer and registers a capturing |source| object. 512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // The |source| is owned by the WebRtcAudioDeviceImpl. 522a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called on the main thread. 53a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) WebRtcLocalAudioRenderer(const blink::WebMediaStreamTrack& audio_track, 5458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) int source_render_view_id, 555d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) int source_render_frame_id, 5658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) int session_id, 5758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) int frames_per_buffer); 582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 597dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch // MediaStreamAudioRenderer implementation. 602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called on the main thread. 612a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void Start() OVERRIDE; 622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void Stop() OVERRIDE; 632a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void Play() OVERRIDE; 642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void Pause() OVERRIDE; 652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void SetVolume(float volume) OVERRIDE; 662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual base::TimeDelta GetCurrentRenderTime() const OVERRIDE; 672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual bool IsLocalRenderer() const OVERRIDE; 682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 69c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) const base::TimeDelta& total_render_time() const { 70c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) return total_render_time_; 71c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) } 72c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 73c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) protected: 74c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual ~WebRtcLocalAudioRenderer(); 75c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 76c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) private: 77a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) // MediaStreamAudioSink implementation. 782a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 792a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called on the AudioInputDevice worker thread. 80a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) virtual void OnData(const int16* audio_data, 81a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) int sample_rate, 82a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) int number_of_channels, 83a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) int number_of_frames) OVERRIDE; 84a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 85a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) // Called on the AudioInputDevice worker thread. 86a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) virtual void OnSetFormat(const media::AudioParameters& params) OVERRIDE; 872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // media::AudioRendererSink::RenderCallback implementation. 892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Render() is called on the AudioOutputDevice thread and OnRenderError() 902a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // on the IO thread. 912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual int Render(media::AudioBus* audio_bus, 922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) int audio_delay_milliseconds) OVERRIDE; 932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual void OnRenderError() OVERRIDE; 942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 95f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Initializes and starts the |sink_| if 96f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // we have received valid |source_params_| && 97f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // |playing_| has been set to true && 98f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // |volume_| is not zero. 99f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) void MaybeStartSink(); 100f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 101f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Sets new |source_params_| and then re-initializes and restarts |sink_|. 102f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) void ReconfigureSink(const media::AudioParameters& params); 10368043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) 104c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // The audio track which provides data to render. Given that this class 105c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // implements local loopback, the audio track is getting data from a capture 106c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // instance like a selected microphone and forwards the recorded data to its 107c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // sinks. The recorded data is stored in a FIFO and consumed 1082a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // by this class when the sink asks for new data. 109a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) // This class is calling MediaStreamAudioSink::AddToAudioTrack() and 110a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) // MediaStreamAudioSink::RemoveFromAudioTrack() to connect and disconnect 111a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) // with the audio track. 112a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) blink::WebMediaStreamTrack audio_track_; 1132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1145d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // The render view and frame in which the audio is rendered into |sink_|. 1152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const int source_render_view_id_; 1165d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const int source_render_frame_id_; 11758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) const int session_id_; 1182a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 119f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // MessageLoop associated with the single thread that performs all control 120f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // tasks. Set to the MessageLoop that invoked the ctor. 121f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) const scoped_refptr<base::MessageLoopProxy> message_loop_; 122f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 1232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // The sink (destination) for rendered audio. 124c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) scoped_refptr<media::AudioOutputDevice> sink_; 1252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Contains copies of captured audio frames. 1275f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles) scoped_ptr<media::AudioBlockFifo> loopback_fifo_; 1282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1292a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Stores last time a render callback was received. The time difference 1302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // between a new time stamp and this value can be used to derive the 1312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // total render time. 132f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) base::TimeTicks last_render_time_; 1332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Keeps track of total time audio has been rendered. 1352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) base::TimeDelta total_render_time_; 1362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 137f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // The audio parameters of the capture source. 138116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Must only be touched on the main thread. 139f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) media::AudioParameters source_params_; 140f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 141f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // The audio parameters used by the sink. 142116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Must only be touched on the main thread. 143f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) media::AudioParameters sink_params_; 144c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 1452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Set when playing, cleared when paused. 1462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool playing_; 1472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Protects |loopback_fifo_|, |playing_| and |sink_|. 1492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) mutable base::Lock thread_lock_; 1502a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 151f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // The preferred buffer size provided via the ctor. 15258537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) const int frames_per_buffer_; 15358537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 15458537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) // The preferred device id of the output device or empty for the default 15558537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) // output device. 15658537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) const std::string output_device_id_; 15758537e28ecd584eab876aee8be7156509866d23aTorne (Richard Coles) 15868043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) // Cache value for the volume. 15968043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) float volume_; 16068043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) 161f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Flag to indicate whether |sink_| has been started yet. 16268043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) bool sink_started_; 16368043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) 164f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) // Used to DCHECK that some methods are called on the capture audio thread. 165f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) base::ThreadChecker capture_thread_checker_; 166f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles) 1672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(WebRtcLocalAudioRenderer); 1682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)}; 1692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} // namespace content 1712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#endif // CONTENT_RENDERER_MEDIA_WEBRTC_LOCAL_AUDIO_RENDERER_H_ 173