From 0e957a7762e163f13c1e6ea849c66407221e5c84 Mon Sep 17 00:00:00 2001 From: csf Date: Tue, 5 Jul 2022 22:31:08 +0800 Subject: [PATCH] refactor:VideoQoS --- src/server.rs | 1 + src/server/video_qos.rs | 219 +++++++++++++++++++++++++++++++++++ src/server/video_service.rs | 222 +----------------------------------- 3 files changed, 222 insertions(+), 220 deletions(-) create mode 100644 src/server/video_qos.rs diff --git a/src/server.rs b/src/server.rs index 9bafa09d1..516f1932a 100644 --- a/src/server.rs +++ b/src/server.rs @@ -38,6 +38,7 @@ pub const NAME_POS: &'static str = ""; mod connection; mod service; +mod video_qos; pub mod video_service; use hbb_common::tcp::new_listener; diff --git a/src/server/video_qos.rs b/src/server/video_qos.rs new file mode 100644 index 000000000..efad1f9d9 --- /dev/null +++ b/src/server/video_qos.rs @@ -0,0 +1,219 @@ +use super::*; +use std::time::Duration; +const FPS: u8 = 30; +trait Percent { + fn as_percent(&self) -> u32; +} + +impl Percent for ImageQuality { + fn as_percent(&self) -> u32 { + match self { + ImageQuality::NotSet => 0, + ImageQuality::Low => 50, + ImageQuality::Balanced => 66, + ImageQuality::Best => 100, + } + } +} + +pub struct VideoQoS { + width: u32, + height: u32, + user_image_quality: u32, + current_image_quality: u32, + enable_abr: bool, + pub current_delay: u32, + pub fps: u8, // abr + pub target_bitrate: u32, // abr + updated: bool, + state: DelayState, + debounce_count: u32, +} + +#[derive(PartialEq, Debug)] +enum DelayState { + Normal = 0, + LowDelay = 200, + HighDelay = 500, + Broken = 1000, +} + +impl DelayState { + fn from_delay(delay: u32) -> Self { + if delay > DelayState::Broken as u32 { + DelayState::Broken + } else if delay > DelayState::HighDelay as u32 { + DelayState::HighDelay + } else if delay > DelayState::LowDelay as u32 { + DelayState::LowDelay + } else { + DelayState::Normal + } + } +} + +impl Default for VideoQoS { + fn default() -> Self { + VideoQoS { + fps: FPS, + user_image_quality: ImageQuality::Balanced.as_percent(), + current_image_quality: ImageQuality::Balanced.as_percent(), + enable_abr: false, + width: 0, + height: 0, + current_delay: 0, + target_bitrate: 0, + updated: false, + state: DelayState::Normal, + debounce_count: 0, + } + } +} + +impl VideoQoS { + pub fn set_size(&mut self, width: u32, height: u32) { + if width == 0 || height == 0 { + return; + } + self.width = width; + self.height = height; + } + + pub fn spf(&mut self) -> Duration { + if self.fps <= 0 { + self.fps = FPS; + } + Duration::from_secs_f32(1. / (self.fps as f32)) + } + + // update_network_delay periodically + // decrease the bitrate when the delay gets bigger + pub fn update_network_delay(&mut self, delay: u32) { + if self.current_delay.eq(&0) { + self.current_delay = delay; + return; + } + + self.current_delay = delay / 2 + self.current_delay / 2; + log::trace!( + "VideoQoS update_network_delay:{}, {}, state:{:?}", + self.current_delay, + delay, + self.state, + ); + + // ABR + if !self.enable_abr { + return; + } + let current_state = DelayState::from_delay(self.current_delay); + if current_state != self.state && self.debounce_count > 5 { + log::debug!( + "VideoQoS state changed:{:?} -> {:?}", + self.state, + current_state + ); + self.state = current_state; + self.debounce_count = 0; + self.refresh_quality(); + } else { + self.debounce_count += 1; + } + } + + fn refresh_quality(&mut self) { + match self.state { + DelayState::Normal => { + self.fps = FPS; + self.current_image_quality = self.user_image_quality; + } + DelayState::LowDelay => { + self.fps = FPS; + self.current_image_quality = std::cmp::min(self.user_image_quality, 50); + } + DelayState::HighDelay => { + self.fps = FPS / 2; + self.current_image_quality = std::cmp::min(self.user_image_quality, 25); + } + DelayState::Broken => { + self.fps = FPS / 4; + self.current_image_quality = 10; + } + } + let _ = self.generate_bitrate().ok(); + self.updated = true; + } + + // handle image_quality change from peer + pub fn update_image_quality(&mut self, image_quality: i32) { + let image_quality = Self::convert_quality(image_quality) as _; + log::debug!("VideoQoS update_image_quality: {}", image_quality); + if self.current_image_quality != image_quality { + self.current_image_quality = image_quality; + let _ = self.generate_bitrate().ok(); + self.updated = true; + } + + self.user_image_quality = self.current_image_quality; + } + + pub fn generate_bitrate(&mut self) -> ResultType { + // https://www.nvidia.com/en-us/geforce/guides/broadcasting-guide/ + if self.width == 0 || self.height == 0 { + bail!("Fail to generate_bitrate, width or height is not set"); + } + if self.current_image_quality == 0 { + self.current_image_quality = ImageQuality::Balanced.as_percent(); + } + + let base_bitrate = ((self.width * self.height) / 800) as u32; + + #[cfg(target_os = "android")] + { + // fix when andorid screen shrinks + let fix = Display::fix_quality() as u32; + log::debug!("Android screen, fix quality:{}", fix); + let base_bitrate = base_bitrate * fix; + self.target_bitrate = base_bitrate * self.current_image_quality / 100; + Ok(self.target_bitrate) + } + #[cfg(not(target_os = "android"))] + { + self.target_bitrate = base_bitrate * self.current_image_quality / 100; + Ok(self.target_bitrate) + } + } + + pub fn check_if_updated(&mut self) -> bool { + if self.updated { + self.updated = false; + return true; + } + return false; + } + + pub fn reset(&mut self) { + *self = Default::default(); + } + + pub fn check_abr_config(&mut self) -> bool { + self.enable_abr = if let Some(v) = Config2::get().options.get("enable-abr") { + v != "N" + } else { + true // default is true + }; + self.enable_abr + } + + pub fn convert_quality(q: i32) -> i32 { + if q == ImageQuality::Balanced.value() { + 100 * 2 / 3 + } else if q == ImageQuality::Low.value() { + 100 / 2 + } else if q == ImageQuality::Best.value() { + 100 + } else { + (q >> 8 & 0xFF) * 2 + } + } +} diff --git a/src/server/video_service.rs b/src/server/video_service.rs index 3b770d250..657bac67a 100644 --- a/src/server/video_service.rs +++ b/src/server/video_service.rs @@ -18,7 +18,7 @@ // to-do: // https://slhck.info/video/2017/03/01/rate-control.html -use super::*; +use super::{video_qos::VideoQoS, *}; use hbb_common::tokio::sync::{ mpsc::{unbounded_channel, UnboundedReceiver, UnboundedSender}, Mutex as TokioMutex, @@ -37,7 +37,6 @@ use std::{ use virtual_display; pub const NAME: &'static str = "video"; -const FPS: u8 = 30; lazy_static::lazy_static! { static ref CURRENT_DISPLAY: Arc> = Arc::new(Mutex::new(usize::MAX)); @@ -52,223 +51,6 @@ lazy_static::lazy_static! { pub static ref VIDEO_QOS: Arc> = Default::default(); } -trait Percent { - fn as_percent(&self) -> u32; -} - -impl Percent for ImageQuality { - fn as_percent(&self) -> u32 { - match self { - ImageQuality::NotSet => 0, - ImageQuality::Low => 50, - ImageQuality::Balanced => 66, - ImageQuality::Best => 100, - } - } -} - -pub struct VideoQoS { - width: u32, - height: u32, - user_image_quality: u32, - current_image_quality: u32, - enable_abr: bool, - pub current_delay: u32, - pub fps: u8, // abr - pub target_bitrate: u32, // abr - updated: bool, - state: DelayState, - debounce_count: u32, -} - -#[derive(PartialEq, Debug)] -enum DelayState { - Normal = 0, - LowDelay = 200, - HighDelay = 500, - Broken = 1000, -} - -impl DelayState { - fn from_delay(delay: u32) -> Self { - if delay > DelayState::Broken as u32 { - DelayState::Broken - } else if delay > DelayState::HighDelay as u32 { - DelayState::HighDelay - } else if delay > DelayState::LowDelay as u32 { - DelayState::LowDelay - } else { - DelayState::Normal - } - } -} - -impl Default for VideoQoS { - fn default() -> Self { - VideoQoS { - fps: FPS, - user_image_quality: ImageQuality::Balanced.as_percent(), - current_image_quality: ImageQuality::Balanced.as_percent(), - enable_abr: false, - width: 0, - height: 0, - current_delay: 0, - target_bitrate: 0, - updated: false, - state: DelayState::Normal, - debounce_count: 0, - } - } -} - -impl VideoQoS { - pub fn set_size(&mut self, width: u32, height: u32) { - if width == 0 || height == 0 { - return; - } - self.width = width; - self.height = height; - } - - pub fn spf(&mut self) -> Duration { - if self.fps <= 0 { - self.fps = FPS; - } - time::Duration::from_secs_f32(1. / (self.fps as f32)) - } - - // update_network_delay periodically - // decrease the bitrate when the delay gets bigger - pub fn update_network_delay(&mut self, delay: u32) { - if self.current_delay.eq(&0) { - self.current_delay = delay; - return; - } - - self.current_delay = delay / 2 + self.current_delay / 2; - log::trace!( - "VideoQoS update_network_delay:{}, {}, state:{:?}", - self.current_delay, - delay, - self.state, - ); - - // ABR - if !self.enable_abr { - return; - } - let current_state = DelayState::from_delay(self.current_delay); - if current_state != self.state && self.debounce_count > 5 { - log::debug!( - "VideoQoS state changed:{:?} -> {:?}", - self.state, - current_state - ); - self.state = current_state; - self.debounce_count = 0; - self.refresh_quality(); - } else { - self.debounce_count += 1; - } - } - - fn refresh_quality(&mut self) { - match self.state { - DelayState::Normal => { - self.fps = FPS; - self.current_image_quality = self.user_image_quality; - } - DelayState::LowDelay => { - self.fps = FPS; - self.current_image_quality = std::cmp::min(self.user_image_quality, 50); - } - DelayState::HighDelay => { - self.fps = FPS / 2; - self.current_image_quality = std::cmp::min(self.user_image_quality, 25); - } - DelayState::Broken => { - self.fps = FPS / 4; - self.current_image_quality = 10; - } - } - let _ = self.generate_bitrate().ok(); - self.updated = true; - } - - // handle image_quality change from peer - pub fn update_image_quality(&mut self, image_quality: i32) { - let image_quality = Self::convert_quality(image_quality) as _; - log::debug!("VideoQoS update_image_quality: {}", image_quality); - if self.current_image_quality != image_quality { - self.current_image_quality = image_quality; - let _ = self.generate_bitrate().ok(); - self.updated = true; - } - - self.user_image_quality = self.current_image_quality; - } - - pub fn generate_bitrate(&mut self) -> ResultType { - // https://www.nvidia.com/en-us/geforce/guides/broadcasting-guide/ - if self.width == 0 || self.height == 0 { - bail!("Fail to generate_bitrate, width or height is not set"); - } - if self.current_image_quality == 0 { - self.current_image_quality = ImageQuality::Balanced.as_percent(); - } - - let base_bitrate = ((self.width * self.height) / 800) as u32; - - #[cfg(target_os = "android")] - { - // fix when andorid screen shrinks - let fix = Display::fix_quality() as u32; - log::debug!("Android screen, fix quality:{}", fix); - let base_bitrate = base_bitrate * fix; - self.target_bitrate = base_bitrate * self.current_image_quality / 100; - Ok(self.target_bitrate) - } - #[cfg(not(target_os = "android"))] - { - self.target_bitrate = base_bitrate * self.current_image_quality / 100; - Ok(self.target_bitrate) - } - } - - pub fn check_if_updated(&mut self) -> bool { - if self.updated { - self.updated = false; - return true; - } - return false; - } - - pub fn reset(&mut self) { - *self = Default::default(); - } - - fn check_abr_config(&mut self) -> bool { - self.enable_abr = if let Some(v) = Config2::get().options.get("enable-abr") { - v != "N" - } else { - true // default is true - }; - self.enable_abr - } - - pub fn convert_quality(q: i32) -> i32 { - if q == ImageQuality::Balanced.value() { - 100 * 2 / 3 - } else if q == ImageQuality::Low.value() { - 100 / 2 - } else if q == ImageQuality::Best.value() { - 100 - } else { - (q >> 8 & 0xFF) * 2 - } - } -} - fn is_capturer_mag_supported() -> bool { #[cfg(windows)] return scrap::CapturerMag::is_supported(); @@ -587,7 +369,7 @@ fn run(sp: GenericService) -> ResultType<()> { Ok(x) => encoder = x, Err(err) => bail!("Failed to create encoder: {}", err), } - + let privacy_mode_id = *PRIVACY_MODE_CONN_ID.lock().unwrap(); #[cfg(not(windows))] let captuerer_privacy_mode_id = privacy_mode_id;