Merge pull request #1732 from CapSoftware/ultra-recording

Studio recording quality setting + screen capture auto-restart

Author: richiemcilroy

apps/desktop/src-tauri/src/general_settings.rs

@@ -42,6 +42,14 @@ pub enum EditorPreviewQuality {
     Full,
 }
 
+#[derive(Default, Serialize, Deserialize, Type, Debug, Clone, Copy, PartialEq, Eq)]
+#[serde(rename_all = "camelCase")]
+pub enum StudioRecordingQuality {
+    #[default]
+    Balanced,
+    Ultra,
+}
+
 impl MainWindowRecordingStartBehaviour {
     pub fn perform(&self, window: &tauri::WebviewWindow) -> tauri::Result<()> {
         match self {
@@ -144,6 +152,8 @@ pub struct GeneralSettingsStore {
     #[serde(default)]
     pub editor_preview_quality: EditorPreviewQuality,
     #[serde(default)]
+    pub studio_recording_quality: StudioRecordingQuality,
+    #[serde(default)]
     pub main_window_position: Option<WindowPosition>,
     #[serde(default)]
     pub camera_window_position: Option<WindowPosition>,
@@ -228,6 +238,7 @@ impl Default for GeneralSettingsStore {
             max_fps: 60,
             transcription_hints: default_transcription_hints(),
             editor_preview_quality: EditorPreviewQuality::Half,
+            studio_recording_quality: StudioRecordingQuality::Balanced,
             main_window_position: None,
             camera_window_position: None,
             camera_window_positions_by_monitor_name: BTreeMap::new(),

apps/desktop/src-tauri/src/recording.rs

@@ -919,6 +919,20 @@ pub async fn start_recording(
                             )
                             .with_max_fps(
                                 general_settings.as_ref().map(|s| s.max_fps).unwrap_or(60),
+                            )
+                            .with_quality(
+                                match general_settings
+                                    .as_ref()
+                                    .map(|s| s.studio_recording_quality)
+                                    .unwrap_or_default()
+                                {
+                                    crate::general_settings::StudioRecordingQuality::Balanced => {
+                                        cap_recording::StudioQuality::Balanced
+                                    }
+                                    crate::general_settings::StudioRecordingQuality::Ultra => {
+                                        cap_recording::StudioQuality::Ultra
+                                    }
+                                },
                             );
 
                             #[cfg(target_os = "macos")]

apps/desktop/src/routes/(window-chrome)/settings/general.tsx

@@ -38,6 +38,7 @@ import {
 	type MainWindowRecordingStartBehaviour,
 	type PostDeletionBehaviour,
 	type PostStudioRecordingBehaviour,
+	type StudioRecordingQuality,
 	type WindowExclusion,
 } from "~/utils/tauri";
 import IconLucidePlus from "~icons/lucide/plus";
@@ -328,6 +329,7 @@ function Inner(props: { initialStore: GeneralSettingsStore | null }) {
 			| MainWindowRecordingStartBehaviour
 			| PostStudioRecordingBehaviour
 			| PostDeletionBehaviour
+			| StudioRecordingQuality
 			| number,
 	>(props: {
 		label: string;
@@ -423,6 +425,16 @@ function Inner(props: { initialStore: GeneralSettingsStore | null }) {
 				)}
 
 				<SettingGroup title="Recording">
+					<SelectSettingItem
+						label="Studio mode quality"
+						description="Balanced uses less storage and CPU. Ultra records at higher bitrate for maximum quality."
+						value={settings.studioRecordingQuality ?? "balanced"}
+						onChange={(value) => handleChange("studioRecordingQuality", value)}
+						options={[
+							{ text: "Balanced", value: "balanced" as StudioRecordingQuality },
+							{ text: "Ultra", value: "ultra" as StudioRecordingQuality },
+						]}
+					/>
 					<SelectSettingItem
 						label="Instant mode max resolution"
 						description="Choose the maximum resolution for Instant Mode recordings."

apps/desktop/src/utils/tauri.ts

@@ -486,7 +486,7 @@ export type ExportSettings = ({ format: "Mp4" } & Mp4ExportSettings) | ({ format
 export type FileType = "recording" | "screenshot"
 export type Flags = { captions: boolean }
 export type FramesRendered = { renderedCount: number; totalFrames: number; type: "FramesRendered" }
-export type GeneralSettingsStore = { instanceId?: string; uploadIndividualFiles?: boolean; hideDockIcon?: boolean; autoCreateShareableLink?: boolean; enableNotifications?: boolean; disableAutoOpenLinks?: boolean; hasCompletedStartup?: boolean; theme?: AppTheme; commercialLicense?: CommercialLicense | null; lastVersion?: string | null; windowTransparency?: boolean; postStudioRecordingBehaviour?: PostStudioRecordingBehaviour; mainWindowRecordingStartBehaviour?: MainWindowRecordingStartBehaviour; custom_cursor_capture2?: boolean; serverUrl?: string; recordingCountdown?: number | null; enableNativeCameraPreview: boolean; autoZoomOnClicks?: boolean; captureKeyboardEvents?: boolean; postDeletionBehaviour?: PostDeletionBehaviour; excludedWindows?: WindowExclusion[]; deleteInstantRecordingsAfterUpload?: boolean; instantModeMaxResolution?: number; defaultProjectNameTemplate?: string | null; crashRecoveryRecording?: boolean; maxFps?: number; transcriptionHints?: string[]; editorPreviewQuality?: EditorPreviewQuality; mainWindowPosition?: WindowPosition | null; cameraWindowPosition?: WindowPosition | null; cameraWindowPositionsByMonitorName?: { [key in string]: WindowPosition }; hasCompletedOnboarding?: boolean }
+export type GeneralSettingsStore = { instanceId?: string; uploadIndividualFiles?: boolean; hideDockIcon?: boolean; autoCreateShareableLink?: boolean; enableNotifications?: boolean; disableAutoOpenLinks?: boolean; hasCompletedStartup?: boolean; theme?: AppTheme; commercialLicense?: CommercialLicense | null; lastVersion?: string | null; windowTransparency?: boolean; postStudioRecordingBehaviour?: PostStudioRecordingBehaviour; mainWindowRecordingStartBehaviour?: MainWindowRecordingStartBehaviour; custom_cursor_capture2?: boolean; serverUrl?: string; recordingCountdown?: number | null; enableNativeCameraPreview: boolean; autoZoomOnClicks?: boolean; captureKeyboardEvents?: boolean; postDeletionBehaviour?: PostDeletionBehaviour; excludedWindows?: WindowExclusion[]; deleteInstantRecordingsAfterUpload?: boolean; instantModeMaxResolution?: number; defaultProjectNameTemplate?: string | null; crashRecoveryRecording?: boolean; maxFps?: number; transcriptionHints?: string[]; editorPreviewQuality?: EditorPreviewQuality; studioRecordingQuality?: StudioRecordingQuality; mainWindowPosition?: WindowPosition | null; cameraWindowPosition?: WindowPosition | null; cameraWindowPositionsByMonitorName?: { [key in string]: WindowPosition }; hasCompletedOnboarding?: boolean }
 export type GifExportSettings = { fps: number; resolution_base: XY<number>; quality: GifQuality | null }
 export type GifQuality = { 
 /**
@@ -581,6 +581,7 @@ export type SingleSegment = { display: VideoMeta; camera?: VideoMeta | null; aud
 export type StartRecordingInputs = { capture_target: ScreenCaptureTarget; capture_system_audio?: boolean; mode: RecordingMode; organization_id?: string | null }
 export type StereoMode = "stereo" | "monoL" | "monoR"
 export type StudioRecordingMeta = { segment: SingleSegment } | { inner: MultipleSegments }
+export type StudioRecordingQuality = "balanced" | "ultra"
 export type StudioRecordingStatus = { status: "InProgress" } | { status: "NeedsRemux" } | { status: "Failed"; error: string } | { status: "Complete" }
 export type SystemDiagnostics = { macosVersion: MacOSVersionInfo | null; availableEncoders: string[]; screenCaptureSupported: boolean; metalSupported: boolean; gpuName: string | null }
 export type TargetUnderCursor = { display_id: DisplayId | null; window: WindowUnderCursor | null }

crates/enc-avfoundation/src/mp4.rs

@@ -119,7 +119,30 @@ impl MP4Encoder {
         audio_config: Option<AudioInfo>,
         output_height: Option<u32>,
     ) -> Result<Self, InitError> {
-        Self::init_with_options(output, video_config, audio_config, output_height, false)
+        Self::init_with_options(
+            output,
+            video_config,
+            audio_config,
+            output_height,
+            false,
+            false,
+        )
+    }
+
+    pub fn init_ultra(
+        output: PathBuf,
+        video_config: VideoInfo,
+        audio_config: Option<AudioInfo>,
+        output_height: Option<u32>,
+    ) -> Result<Self, InitError> {
+        Self::init_with_options(
+            output,
+            video_config,
+            audio_config,
+            output_height,
+            false,
+            true,
+        )
     }
 
     pub fn init_instant_mode(
@@ -128,7 +151,14 @@ impl MP4Encoder {
         audio_config: Option<AudioInfo>,
         output_height: Option<u32>,
     ) -> Result<Self, InitError> {
-        Self::init_with_options(output, video_config, audio_config, output_height, true)
+        Self::init_with_options(
+            output,
+            video_config,
+            audio_config,
+            output_height,
+            true,
+            false,
+        )
     }
 
     fn init_with_options(
@@ -137,6 +167,7 @@ impl MP4Encoder {
         audio_config: Option<AudioInfo>,
         output_height: Option<u32>,
         instant_mode: bool,
+        ultra_quality: bool,
     ) -> Result<Self, InitError> {
         info!(
             width = video_config.width,
@@ -227,18 +258,22 @@ impl MP4Encoder {
 
             let bitrate = if instant_mode {
                 get_instant_mode_bitrate(output_width as f32, output_height as f32, fps)
+            } else if ultra_quality {
+                get_ultra_bitrate(output_width as f32, output_height as f32, fps)
             } else {
                 get_average_bitrate(output_width as f32, output_height as f32, fps)
             };
 
-            debug!(instant_mode, "recording bitrate: {bitrate}");
+            debug!(instant_mode, ultra_quality, "recording bitrate: {bitrate}");
 
             let keyframe_interval = if instant_mode {
                 fps as i32
             } else {
                 (fps * 2.0) as i32
             };
 
+            let allow_frame_reordering = ultra_quality && !instant_mode;
+
             output_settings.insert(
                 av::video_settings_keys::compression_props(),
                 ns::Dictionary::with_keys_values(
@@ -250,7 +285,7 @@ impl MP4Encoder {
                     ],
                     &[
                         ns::Number::with_f32(bitrate).as_id_ref(),
-                        ns::Number::with_bool(false).as_id_ref(),
+                        ns::Number::with_bool(allow_frame_reordering).as_id_ref(),
                         ns::Number::with_f32(fps).as_id_ref(),
                         ns::Number::with_i32(keyframe_interval).as_id_ref(),
                     ],
@@ -935,10 +970,19 @@ fn timescale_value_to_duration(value: i64, timescale: i32) -> Duration {
     Duration::from_nanos(nanos)
 }
 
+const MIN_STUDIO_BITRATE: f32 = 8_000_000.0;
+const MAX_ULTRA_BITRATE: f32 = 120_000_000.0;
+
 fn get_average_bitrate(width: f32, height: f32, fps: f32) -> f32 {
-    5_000_000.0
-        + width * height / (1920.0 * 1080.0) * 2_000_000.0
-        + fps.min(60.0) / 30.0 * 5_000_000.0
+    let pixels = width * height;
+    let fps_factor = fps.min(60.0) / 30.0;
+    (pixels * fps_factor * 5.0).max(MIN_STUDIO_BITRATE)
+}
+
+fn get_ultra_bitrate(width: f32, height: f32, fps: f32) -> f32 {
+    let pixels = width * height;
+    let fps_factor = fps.min(60.0) / 30.0;
+    (pixels * fps_factor * 10.0).clamp(MIN_STUDIO_BITRATE, MAX_ULTRA_BITRATE)
 }
 
 fn get_instant_mode_bitrate(width: f32, height: f32, fps: f32) -> f32 {

crates/enc-ffmpeg/src/video/h264.rs

@@ -53,6 +53,7 @@ pub enum H264EncoderError {
 
 impl H264EncoderBuilder {
     pub const QUALITY_BPP: f32 = 0.3;
+    pub const ULTRA_BPP: f32 = 1.0;
     pub const INSTANT_MODE_BPP: f32 = 0.15;
 
     pub fn new(input_config: VideoInfo) -> Self {
@@ -808,17 +809,12 @@ fn get_codec_and_options(
                         options.set("trellis", "0");
                     }
                 } else {
-                    options.set(
-                        "preset",
-                        match preset {
-                            H264Preset::Slow => "slow",
-                            H264Preset::Medium => "medium",
-                            H264Preset::Ultrafast | H264Preset::HighThroughput => "ultrafast",
-                        },
-                    );
-                    if matches!(preset, H264Preset::Ultrafast | H264Preset::HighThroughput) {
-                        options.set("tune", "zerolatency");
-                    }
+                    let realtime_preset = match preset {
+                        H264Preset::Slow | H264Preset::Medium => "veryfast",
+                        H264Preset::Ultrafast | H264Preset::HighThroughput => "ultrafast",
+                    };
+                    options.set("preset", realtime_preset);
+                    options.set("tune", "zerolatency");
                 }
                 options.set("vsync", "1");
                 options.set("g", &keyframe_interval_str);