From 3f5f1c2ad305a665fb2ecd3e31c57d405e19af97 Mon Sep 17 00:00:00 2001 From: kwiberg Date: Tue, 8 Sep 2015 23:15:33 -0700 Subject: [PATCH] Change return type of AudioEncoder::SetMaxPlaybackRate to void There's no point in returning a status code, since the max playback rate is only a suggestion that the encoder is free to disregard. Review URL: https://codereview.webrtc.org/1332573003 Cr-Commit-Position: refs/heads/master@{#9900} --- webrtc/modules/audio_coding/codecs/audio_encoder.cc | 4 +--- webrtc/modules/audio_coding/codecs/audio_encoder.h | 4 +--- webrtc/modules/audio_coding/codecs/cng/audio_encoder_cng.cc | 4 ++-- .../audio_coding/codecs/cng/include/audio_encoder_cng.h | 2 +- webrtc/modules/audio_coding/codecs/mock/mock_audio_encoder.h | 2 +- webrtc/modules/audio_coding/codecs/opus/audio_encoder_opus.cc | 4 ++-- .../audio_coding/codecs/opus/interface/audio_encoder_opus.h | 2 +- .../modules/audio_coding/codecs/red/audio_encoder_copy_red.cc | 4 ++-- .../modules/audio_coding/codecs/red/audio_encoder_copy_red.h | 2 +- .../audio_coding/main/acm2/audio_coding_module_impl.cc | 4 ++-- 10 files changed, 14 insertions(+), 18 deletions(-) diff --git a/webrtc/modules/audio_coding/codecs/audio_encoder.cc b/webrtc/modules/audio_coding/codecs/audio_encoder.cc index eb553a7e7d..8974cf18bc 100644 --- a/webrtc/modules/audio_coding/codecs/audio_encoder.cc +++ b/webrtc/modules/audio_coding/codecs/audio_encoder.cc @@ -46,9 +46,7 @@ bool AudioEncoder::SetApplication(Application application) { return false; } -bool AudioEncoder::SetMaxPlaybackRate(int frequency_hz) { - return true; -} +void AudioEncoder::SetMaxPlaybackRate(int frequency_hz) {} void AudioEncoder::SetProjectedPacketLossRate(double fraction) {} diff --git a/webrtc/modules/audio_coding/codecs/audio_encoder.h b/webrtc/modules/audio_coding/codecs/audio_encoder.h index 73b4468d46..c053b7fdef 100644 --- a/webrtc/modules/audio_coding/codecs/audio_encoder.h +++ b/webrtc/modules/audio_coding/codecs/audio_encoder.h @@ -126,9 +126,7 @@ class AudioEncoder { // use when decoding the bitstream. The encoder would typically use this // information to adjust the quality of the encoding. The default // implementation just returns true. - // TODO(kwiberg): Change return value to void, since it doesn't matter - // whether the encoder approved of the max playback rate or not. - virtual bool SetMaxPlaybackRate(int frequency_hz); + virtual void SetMaxPlaybackRate(int frequency_hz); // Tells the encoder what the projected packet loss rate is. The rate is in // the range [0.0, 1.0]. The encoder would typically use this information to diff --git a/webrtc/modules/audio_coding/codecs/cng/audio_encoder_cng.cc b/webrtc/modules/audio_coding/codecs/cng/audio_encoder_cng.cc index 1ef22f65fa..ab3bd770e6 100644 --- a/webrtc/modules/audio_coding/codecs/cng/audio_encoder_cng.cc +++ b/webrtc/modules/audio_coding/codecs/cng/audio_encoder_cng.cc @@ -187,8 +187,8 @@ bool AudioEncoderCng::SetApplication(Application application) { return speech_encoder_->SetApplication(application); } -bool AudioEncoderCng::SetMaxPlaybackRate(int frequency_hz) { - return speech_encoder_->SetMaxPlaybackRate(frequency_hz); +void AudioEncoderCng::SetMaxPlaybackRate(int frequency_hz) { + speech_encoder_->SetMaxPlaybackRate(frequency_hz); } void AudioEncoderCng::SetProjectedPacketLossRate(double fraction) { diff --git a/webrtc/modules/audio_coding/codecs/cng/include/audio_encoder_cng.h b/webrtc/modules/audio_coding/codecs/cng/include/audio_encoder_cng.h index 2ac1f95e57..fd2aa129c8 100644 --- a/webrtc/modules/audio_coding/codecs/cng/include/audio_encoder_cng.h +++ b/webrtc/modules/audio_coding/codecs/cng/include/audio_encoder_cng.h @@ -64,7 +64,7 @@ class AudioEncoderCng final : public AudioEncoder { bool SetFec(bool enable) override; bool SetDtx(bool enable) override; bool SetApplication(Application application) override; - bool SetMaxPlaybackRate(int frequency_hz) override; + void SetMaxPlaybackRate(int frequency_hz) override; void SetProjectedPacketLossRate(double fraction) override; void SetTargetBitrate(int target_bps) override; void SetMaxBitrate(int max_bps) override; diff --git a/webrtc/modules/audio_coding/codecs/mock/mock_audio_encoder.h b/webrtc/modules/audio_coding/codecs/mock/mock_audio_encoder.h index 41c7e58461..a34edb3150 100644 --- a/webrtc/modules/audio_coding/codecs/mock/mock_audio_encoder.h +++ b/webrtc/modules/audio_coding/codecs/mock/mock_audio_encoder.h @@ -38,7 +38,7 @@ class MockAudioEncoder final : public AudioEncoder { MOCK_METHOD1(SetFec, bool(bool enable)); MOCK_METHOD1(SetDtx, bool(bool enable)); MOCK_METHOD1(SetApplication, bool(Application application)); - MOCK_METHOD1(SetMaxPlaybackRate, bool(int frequency_hz)); + MOCK_METHOD1(SetMaxPlaybackRate, void(int frequency_hz)); MOCK_METHOD1(SetProjectedPacketLossRate, void(double fraction)); MOCK_METHOD1(SetTargetBitrate, void(int target_bps)); MOCK_METHOD1(SetMaxBitrate, void(int max_bps)); diff --git a/webrtc/modules/audio_coding/codecs/opus/audio_encoder_opus.cc b/webrtc/modules/audio_coding/codecs/opus/audio_encoder_opus.cc index e750aa1323..a68530e415 100644 --- a/webrtc/modules/audio_coding/codecs/opus/audio_encoder_opus.cc +++ b/webrtc/modules/audio_coding/codecs/opus/audio_encoder_opus.cc @@ -190,10 +190,10 @@ bool AudioEncoderOpus::SetApplication(Application application) { return RecreateEncoderInstance(conf); } -bool AudioEncoderOpus::SetMaxPlaybackRate(int frequency_hz) { +void AudioEncoderOpus::SetMaxPlaybackRate(int frequency_hz) { auto conf = config_; conf.max_playback_rate_hz = frequency_hz; - return RecreateEncoderInstance(conf); + CHECK(RecreateEncoderInstance(conf)); } void AudioEncoderOpus::SetProjectedPacketLossRate(double fraction) { diff --git a/webrtc/modules/audio_coding/codecs/opus/interface/audio_encoder_opus.h b/webrtc/modules/audio_coding/codecs/opus/interface/audio_encoder_opus.h index d95d6c6710..1b7e752694 100644 --- a/webrtc/modules/audio_coding/codecs/opus/interface/audio_encoder_opus.h +++ b/webrtc/modules/audio_coding/codecs/opus/interface/audio_encoder_opus.h @@ -76,7 +76,7 @@ class AudioEncoderOpus final : public AudioEncoder { bool SetDtx(bool enable) override; bool SetApplication(Application application) override; - bool SetMaxPlaybackRate(int frequency_hz) override; + void SetMaxPlaybackRate(int frequency_hz) override; void SetProjectedPacketLossRate(double fraction) override; void SetTargetBitrate(int target_bps) override; diff --git a/webrtc/modules/audio_coding/codecs/red/audio_encoder_copy_red.cc b/webrtc/modules/audio_coding/codecs/red/audio_encoder_copy_red.cc index a54e01845b..46febf7662 100644 --- a/webrtc/modules/audio_coding/codecs/red/audio_encoder_copy_red.cc +++ b/webrtc/modules/audio_coding/codecs/red/audio_encoder_copy_red.cc @@ -109,8 +109,8 @@ bool AudioEncoderCopyRed::SetApplication(Application application) { return speech_encoder_->SetApplication(application); } -bool AudioEncoderCopyRed::SetMaxPlaybackRate(int frequency_hz) { - return speech_encoder_->SetMaxPlaybackRate(frequency_hz); +void AudioEncoderCopyRed::SetMaxPlaybackRate(int frequency_hz) { + speech_encoder_->SetMaxPlaybackRate(frequency_hz); } void AudioEncoderCopyRed::SetProjectedPacketLossRate(double fraction) { diff --git a/webrtc/modules/audio_coding/codecs/red/audio_encoder_copy_red.h b/webrtc/modules/audio_coding/codecs/red/audio_encoder_copy_red.h index 5e2c9b2826..d0fcd41ed8 100644 --- a/webrtc/modules/audio_coding/codecs/red/audio_encoder_copy_red.h +++ b/webrtc/modules/audio_coding/codecs/red/audio_encoder_copy_red.h @@ -51,7 +51,7 @@ class AudioEncoderCopyRed final : public AudioEncoder { bool SetFec(bool enable) override; bool SetDtx(bool enable) override; bool SetApplication(Application application) override; - bool SetMaxPlaybackRate(int frequency_hz) override; + void SetMaxPlaybackRate(int frequency_hz) override; void SetProjectedPacketLossRate(double fraction) override; void SetTargetBitrate(int target_bps) override; void SetMaxBitrate(int max_bps) override; diff --git a/webrtc/modules/audio_coding/main/acm2/audio_coding_module_impl.cc b/webrtc/modules/audio_coding/main/acm2/audio_coding_module_impl.cc index eec00dec3e..2a81e469d0 100644 --- a/webrtc/modules/audio_coding/main/acm2/audio_coding_module_impl.cc +++ b/webrtc/modules/audio_coding/main/acm2/audio_coding_module_impl.cc @@ -787,8 +787,8 @@ int AudioCodingModuleImpl::SetOpusMaxPlaybackRate(int frequency_hz) { } if (!codec_manager_.CurrentEncoderIsOpus()) return -1; - return codec_manager_.CurrentEncoder()->SetMaxPlaybackRate(frequency_hz) ? 0 - : -1; + codec_manager_.CurrentEncoder()->SetMaxPlaybackRate(frequency_hz); + return 0; } int AudioCodingModuleImpl::EnableOpusDtx() {