OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CHROME_BROWSER_MEDIA_AUDIO_STREAM_MONITOR_H_ | 5 #ifndef CONTENT_BROWSER_MEDIA_AUDIO_STREAM_MONITOR_H_ |
6 #define CHROME_BROWSER_MEDIA_AUDIO_STREAM_MONITOR_H_ | 6 #define CONTENT_BROWSER_MEDIA_AUDIO_STREAM_MONITOR_H_ |
7 | 7 |
8 #include <map> | 8 #include <map> |
9 | 9 |
10 #include "base/callback_forward.h" | 10 #include "base/callback_forward.h" |
11 #include "base/threading/thread_checker.h" | 11 #include "base/threading/thread_checker.h" |
12 #include "base/time/default_tick_clock.h" | 12 #include "base/time/default_tick_clock.h" |
13 #include "base/time/time.h" | 13 #include "base/time/time.h" |
14 #include "base/timer/timer.h" | 14 #include "base/timer/timer.h" |
15 #include "content/public/browser/web_contents_user_data.h" | 15 #include "content/public/browser/web_contents_user_data.h" |
16 | 16 |
17 namespace base { | 17 namespace base { |
18 class TickClock; | 18 class TickClock; |
19 } | 19 } |
20 | 20 |
| 21 namespace content { |
| 22 class PowerSaveBlocker; |
| 23 |
21 // Repeatedly polls audio streams for their power levels, and "debounces" the | 24 // Repeatedly polls audio streams for their power levels, and "debounces" the |
22 // information into a simple, binary "was recently audible" result for the audio | 25 // information into a simple, binary "was recently audible" result for the audio |
23 // indicators in the tab UI. The debouncing logic is to: 1) Turn on immediately | 26 // indicators in the tab UI. The debouncing logic is to: 1) Turn on immediately |
24 // when sound is audible; and 2) Hold on for X amount of time after sound has | 27 // when sound is audible; and 2) Hold on for X amount of time after sound has |
25 // gone silent, then turn off. Said another way, we don't want tab indicators | 28 // gone silent, then turn off. Said another way, we don't want tab indicators |
26 // to turn on/off repeatedly and annoy the user. AudioStreamMonitor sends UI | 29 // to turn on/off repeatedly and annoy the user. AudioStreamMonitor sends UI |
27 // update notifications only when needed, but may be queried at any time. | 30 // update notifications only when needed, but may be queried at any time. |
28 // | 31 // |
29 // There are zero or one instances of AudioStreamMonitor per | 32 // There are zero or one instances of AudioStreamMonitor per |
30 // content::WebContents instance (referred to as "the tab" in comments below). | 33 // content::WebContents instance (referred to as "the tab" in comments below). |
31 // AudioStreamMonitor is created on-demand, and automatically destroyed when its | 34 // AudioStreamMonitor is created on-demand, and automatically destroyed when its |
32 // associated WebContents is destroyed. See content::WebContentsUserData for | 35 // associated WebContents is destroyed. See content::WebContentsUserData for |
33 // usage. | 36 // usage. |
34 class AudioStreamMonitor | 37 // |
35 : public content::WebContentsUserData<AudioStreamMonitor> { | 38 // AudioStreamMonitor will additionally create a PowerSaveBlocker to prevent app |
| 39 // suspension when audible audio is being produced. |
| 40 class CONTENT_EXPORT AudioStreamMonitor |
| 41 : public WebContentsUserData<AudioStreamMonitor> { |
36 public: | 42 public: |
37 // Returns true if audio has recently been audible from the tab. This is | 43 // Returns true if audio has recently been audible from the tab. This is |
38 // usually called whenever the tab data model is refreshed; but there are | 44 // usually called whenever the tab data model is refreshed; but there are |
39 // other use cases as well (e.g., the OOM killer uses this to de-prioritize | 45 // other use cases as well (e.g., the OOM killer uses this to de-prioritize |
40 // the killing of tabs making sounds). | 46 // the killing of tabs making sounds). |
41 bool WasRecentlyAudible() const; | 47 bool WasRecentlyAudible() const; |
42 | 48 |
43 // Starts polling the stream for audio stream power levels using |callback|. | 49 // Starts or stops audio level monitoring respectively for the stream owned by |
| 50 // the specified renderer. Safe to call from any thread. |
| 51 // |
| 52 // The callback returns the current power level (in dBFS units) and the clip |
| 53 // status (true if any part of the audio signal has clipped since the last |
| 54 // callback run). |
44 typedef base::Callback<std::pair<float, bool>()> ReadPowerAndClipCallback; | 55 typedef base::Callback<std::pair<float, bool>()> ReadPowerAndClipCallback; |
45 void StartMonitoringStream(int stream_id, | 56 static void StartMonitoringStream( |
46 const ReadPowerAndClipCallback& callback); | 57 int render_process_id, |
47 | 58 int render_frame_id, |
48 // Stops polling the stream, discarding the internal copy of the |callback| | 59 int stream_id, |
49 // provided in the call to StartMonitoringStream(). | 60 const ReadPowerAndClipCallback& read_power_callback); |
50 void StopMonitoringStream(int stream_id); | 61 static void StopMonitoringStream(int render_process_id, |
| 62 int render_frame_id, |
| 63 int stream_id); |
51 | 64 |
52 private: | 65 private: |
53 friend class content::WebContentsUserData<AudioStreamMonitor>; | 66 friend class WebContentsUserData<AudioStreamMonitor>; |
54 friend class AudioStreamMonitorTest; | 67 friend class AudioStreamMonitorTest; |
55 | 68 |
56 enum { | 69 enum { |
57 // Desired polling frequency. Note: If this is set too low, short-duration | 70 // Desired polling frequency. Note: If this is set too low, short-duration |
58 // "blip" sounds won't be detected. http://crbug.com/339133#c4 | 71 // "blip" sounds won't be detected. http://crbug.com/339133#c4 |
59 kPowerMeasurementsPerSecond = 15, | 72 kPowerMeasurementsPerSecond = 15, |
60 | 73 |
61 // Amount of time to hold a tab indicator on after its last blurt. | 74 // Amount of time to hold a tab indicator on after its last blurt. |
62 kHoldOnMilliseconds = 2000 | 75 kHoldOnMilliseconds = 2000 |
63 }; | 76 }; |
64 | 77 |
65 // Invoked by content::WebContentsUserData only. | 78 // Invoked by WebContentsUserData only. |
66 explicit AudioStreamMonitor(content::WebContents* contents); | 79 explicit AudioStreamMonitor(WebContents* contents); |
67 virtual ~AudioStreamMonitor(); | 80 virtual ~AudioStreamMonitor(); |
68 | 81 |
| 82 // Helper methods for starting and stopping monitoring which lookup the |
| 83 // identified renderer and forward calls to the correct AudioStreamMonitor. |
| 84 static void StartMonitoringHelper( |
| 85 int render_process_id, |
| 86 int render_frame_id, |
| 87 int stream_id, |
| 88 const ReadPowerAndClipCallback& read_power_callback); |
| 89 static void StopMonitoringHelper(int render_process_id, |
| 90 int render_frame_id, |
| 91 int stream_id); |
| 92 |
| 93 // Starts polling the stream for audio stream power levels using |callback|. |
| 94 void StartMonitoringStreamOnUIThread( |
| 95 int stream_id, |
| 96 const ReadPowerAndClipCallback& callback); |
| 97 |
| 98 // Stops polling the stream, discarding the internal copy of the |callback| |
| 99 // provided in the call to StartMonitoringStream(). |
| 100 void StopMonitoringStreamOnUIThread(int stream_id); |
| 101 |
69 // Called by |poll_timer_| to sample the power levels from each of the streams | 102 // Called by |poll_timer_| to sample the power levels from each of the streams |
70 // playing in the tab. | 103 // playing in the tab. |
71 void Poll(); | 104 void Poll(); |
72 | 105 |
73 // Compares last known indicator state with what it should be, and triggers UI | 106 // Compares last known indicator state with what it should be, and triggers UI |
74 // updates through |web_contents_| if needed. When the indicator is turned | 107 // updates through |web_contents_| if needed. When the indicator is turned |
75 // on, |off_timer_| is started to re-invoke this method in the future. | 108 // on, |off_timer_| is started to re-invoke this method in the future. |
76 void MaybeToggle(); | 109 void MaybeToggle(); |
77 | 110 |
78 // The WebContents instance instance to receive indicator toggle | 111 // The WebContents instance instance to receive indicator toggle |
79 // notifications. This pointer should be valid for the lifetime of | 112 // notifications. This pointer should be valid for the lifetime of |
80 // AudioStreamMonitor. | 113 // AudioStreamMonitor. |
81 content::WebContents* const web_contents_; | 114 WebContents* const web_contents_; |
82 | 115 |
83 // Note: |clock_| is always |&default_tick_clock_|, except during unit | 116 // Note: |clock_| is always |&default_tick_clock_|, except during unit |
84 // testing. | 117 // testing. |
85 base::DefaultTickClock default_tick_clock_; | 118 base::DefaultTickClock default_tick_clock_; |
86 base::TickClock* const clock_; | 119 base::TickClock* const clock_; |
87 | 120 |
88 // Confirms single-threaded access in debug builds. | 121 // Confirms single-threaded access in debug builds. |
89 base::ThreadChecker thread_checker_; | 122 base::ThreadChecker thread_checker_; |
90 | 123 |
91 // The callbacks to read power levels for each stream. Only playing (i.e., | 124 // The callbacks to read power levels for each stream. Only playing (i.e., |
92 // not paused) streams will have an entry in this map. | 125 // not paused) streams will have an entry in this map. |
93 typedef std::map<int, ReadPowerAndClipCallback> StreamPollCallbackMap; | 126 typedef std::map<int, ReadPowerAndClipCallback> StreamPollCallbackMap; |
94 StreamPollCallbackMap poll_callbacks_; | 127 StreamPollCallbackMap poll_callbacks_; |
95 | 128 |
96 // Records the last time at which sound was audible from any stream. | 129 // Records the last time at which sound was audible from any stream. |
97 base::TimeTicks last_blurt_time_; | 130 base::TimeTicks last_blurt_time_; |
98 | 131 |
99 // Set to true if the last call to MaybeToggle() determined the indicator | 132 // Set to true if the last call to MaybeToggle() determined the indicator |
100 // should be turned on. | 133 // should be turned on. |
101 bool was_recently_audible_; | 134 bool was_recently_audible_; |
102 | 135 |
103 // Calls Poll() at regular intervals while |poll_callbacks_| is non-empty. | 136 // Calls Poll() at regular intervals while |poll_callbacks_| is non-empty. |
104 base::RepeatingTimer<AudioStreamMonitor> poll_timer_; | 137 base::RepeatingTimer<AudioStreamMonitor> poll_timer_; |
105 | 138 |
106 // Started only when an indicator is toggled on, to turn it off again in the | 139 // Started only when an indicator is toggled on, to turn it off again in the |
107 // future. | 140 // future. |
108 base::OneShotTimer<AudioStreamMonitor> off_timer_; | 141 base::OneShotTimer<AudioStreamMonitor> off_timer_; |
109 | 142 |
| 143 // Prevent app suspension when audio is active. |
| 144 scoped_ptr<PowerSaveBlocker> blocker_; |
| 145 |
110 DISALLOW_COPY_AND_ASSIGN(AudioStreamMonitor); | 146 DISALLOW_COPY_AND_ASSIGN(AudioStreamMonitor); |
111 }; | 147 }; |
112 | 148 |
113 #endif // CHROME_BROWSER_MEDIA_AUDIO_STREAM_MONITOR_H_ | 149 } // namespace content |
| 150 |
| 151 #endif // CONTENT_BROWSER_MEDIA_AUDIO_STREAM_MONITOR_H_ |
OLD | NEW |