henrik.lundin | 92a7a18 | 2017-03-07 01:58:55 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2011 The WebRTC project authors. All Rights Reserved. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license |
| 5 | * that can be found in the LICENSE file in the root of the source |
| 6 | * tree. An additional intellectual property rights grant can be found |
| 7 | * in the file PATENTS. All contributing project authors may |
| 8 | * be found in the AUTHORS file in the root of the source tree. |
| 9 | */ |
| 10 | |
Fredrik Solenberg | a8b7c7f | 2018-01-17 11:18:31 +0100 | [diff] [blame] | 11 | #ifndef AUDIO_AUDIO_LEVEL_H_ |
| 12 | #define AUDIO_AUDIO_LEVEL_H_ |
henrik.lundin | 92a7a18 | 2017-03-07 01:58:55 -0800 | [diff] [blame] | 13 | |
Steve Anton | 10542f2 | 2019-01-11 09:11:00 -0800 | [diff] [blame] | 14 | #include "rtc_base/critical_section.h" |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 15 | #include "rtc_base/thread_annotations.h" |
henrik.lundin | 92a7a18 | 2017-03-07 01:58:55 -0800 | [diff] [blame] | 16 | |
| 17 | namespace webrtc { |
| 18 | |
| 19 | class AudioFrame; |
| 20 | namespace voe { |
| 21 | |
Henrik Boström | d2c336f | 2019-07-03 17:11:10 +0200 | [diff] [blame^] | 22 | // This class is thread-safe. However, TotalEnergy() and TotalDuration() are |
| 23 | // related, so if you call ComputeLevel() on a different thread than you read |
| 24 | // these values, you still need to use lock to read them as a pair. |
henrik.lundin | 92a7a18 | 2017-03-07 01:58:55 -0800 | [diff] [blame] | 25 | class AudioLevel { |
| 26 | public: |
| 27 | AudioLevel(); |
| 28 | ~AudioLevel(); |
Henrik Boström | d2c336f | 2019-07-03 17:11:10 +0200 | [diff] [blame^] | 29 | void Reset(); |
henrik.lundin | 92a7a18 | 2017-03-07 01:58:55 -0800 | [diff] [blame] | 30 | |
Henrik Boström | d2c336f | 2019-07-03 17:11:10 +0200 | [diff] [blame^] | 31 | // Returns the current audio level linearly [0,32767], which gets updated |
| 32 | // every "kUpdateFrequency+1" call to ComputeLevel() based on the maximum |
| 33 | // audio level of any audio frame, decaying by a factor of 1/4 each time |
| 34 | // LevelFullRange() gets updated. |
henrik.lundin | 92a7a18 | 2017-03-07 01:58:55 -0800 | [diff] [blame] | 35 | // Called on "API thread(s)" from APIs like VoEBase::CreateChannel(), |
Henrik Boström | d2c336f | 2019-07-03 17:11:10 +0200 | [diff] [blame^] | 36 | // VoEBase::StopSend(). |
henrik.lundin | 92a7a18 | 2017-03-07 01:58:55 -0800 | [diff] [blame] | 37 | int16_t LevelFullRange() const; |
Henrik Boström | d2c336f | 2019-07-03 17:11:10 +0200 | [diff] [blame^] | 38 | void ResetLevelFullRange(); |
zstein | 3c45186 | 2017-07-20 09:57:42 -0700 | [diff] [blame] | 39 | // See the description for "totalAudioEnergy" in the WebRTC stats spec |
Henrik Boström | d2c336f | 2019-07-03 17:11:10 +0200 | [diff] [blame^] | 40 | // (https://w3c.github.io/webrtc-stats/#dom-rtcaudiohandlerstats-totalaudioenergy) |
| 41 | // In our implementation, the total audio energy increases by the |
| 42 | // energy-equivalent of LevelFullRange() at the time of ComputeLevel(), rather |
| 43 | // than the energy of the samples in that specific audio frame. As a result, |
| 44 | // we may report a higher audio energy and audio level than the spec mandates. |
| 45 | // TODO(https://crbug.com/webrtc/10784): We should either do what the spec |
| 46 | // says or update the spec to match our implementation. If we want to have a |
| 47 | // decaying audio level we should probably update both the spec and the |
| 48 | // implementation to reduce the complexity of the definition. If we want to |
| 49 | // continue to have decaying audio we should have unittests covering the |
| 50 | // behavior of the decay. |
zstein | 3c45186 | 2017-07-20 09:57:42 -0700 | [diff] [blame] | 51 | double TotalEnergy() const; |
| 52 | double TotalDuration() const; |
henrik.lundin | 92a7a18 | 2017-03-07 01:58:55 -0800 | [diff] [blame] | 53 | |
| 54 | // Called on a native capture audio thread (platform dependent) from the |
| 55 | // AudioTransport::RecordedDataIsAvailable() callback. |
| 56 | // In Chrome, this method is called on the AudioInputDevice thread. |
zstein | 3c45186 | 2017-07-20 09:57:42 -0700 | [diff] [blame] | 57 | void ComputeLevel(const AudioFrame& audioFrame, double duration); |
henrik.lundin | 92a7a18 | 2017-03-07 01:58:55 -0800 | [diff] [blame] | 58 | |
| 59 | private: |
| 60 | enum { kUpdateFrequency = 10 }; |
| 61 | |
| 62 | rtc::CriticalSection crit_sect_; |
| 63 | |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 64 | int16_t abs_max_ RTC_GUARDED_BY(crit_sect_); |
| 65 | int16_t count_ RTC_GUARDED_BY(crit_sect_); |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 66 | int16_t current_level_full_range_ RTC_GUARDED_BY(crit_sect_); |
zstein | 3c45186 | 2017-07-20 09:57:42 -0700 | [diff] [blame] | 67 | |
danilchap | a37de39 | 2017-09-09 04:17:22 -0700 | [diff] [blame] | 68 | double total_energy_ RTC_GUARDED_BY(crit_sect_) = 0.0; |
| 69 | double total_duration_ RTC_GUARDED_BY(crit_sect_) = 0.0; |
henrik.lundin | 92a7a18 | 2017-03-07 01:58:55 -0800 | [diff] [blame] | 70 | }; |
| 71 | |
| 72 | } // namespace voe |
| 73 | } // namespace webrtc |
| 74 | |
Fredrik Solenberg | a8b7c7f | 2018-01-17 11:18:31 +0100 | [diff] [blame] | 75 | #endif // AUDIO_AUDIO_LEVEL_H_ |