Changeset 95639 in vbox for trunk/include/VBox

Timestamp:

Jul 14, 2022 8:30:45 AM (2 years ago)

Author:

vboxsync

Message:

Recording: Settings handling fixes / overhaul. This adds the ability to handle per-screen settings, which can be different from the first screen (screen 0). Also fixed a couple of bugs regarding snapshot handling and persistence (committing, rolling back, ++) in that area. FE/VBoxManage now can also list the per-screen settings. Added some further @todos. bugref:9286

File:

• trunk/include/VBox/settings.h (modified) (10 diffs)

trunk/include/VBox/settings.h

@@ -636 +636 @@
     bool isFeatureEnabled(RecordingFeature_T enmFeature) const;
 
+    static const char *getDefaultOptions(void);
+
     bool operator==(const RecordingScreenSettings &d) const;
 
@@ -641 +643 @@
     bool                   fEnabled;   // requires settings version 1.14 (VirtualBox 4.3)
     /** Destination to record to. */
-    RecordingDestination_T enmDest;    /** @todo Implement with next settings version bump. */
+    RecordingDestination_T enmDest;
     /** Which features are enable or not. */
     RecordingFeatureMap    featureMap; /** @todo Implement with next settings version bump. */
     /** Maximum time (in s) to record. If set to 0, no time limit is set. */
     uint32_t               ulMaxTimeS; // requires settings version 1.14 (VirtualBox 4.3)
-    /** Options string for hidden / advanced / experimental features. */
+    /** Options string for hidden / advanced / experimental features.
+     *  Use RecordingScreenSettings::getDefaultOptions(). */
     com::Utf8Str           strOptions; // new since VirtualBox 5.2.
 
@@ -703 +706 @@
 
         /** Maximum size (in MB) the file is allowed to have.
-         *  When reaching the limit, recording will stop. */
+         *  When reaching the limit, recording will stop. 0 means no limit. */
         uint32_t     ulMaxSizeMB; // requires settings version 1.14 (VirtualBox 4.3)
-        /** Absolute file name path to use for recording. */
+        /** Absolute file name path to use for recording.
+         *  When empty, this is considered as being the default setting. */
         com::Utf8Str strName;     // requires settings version 1.14 (VirtualBox 4.3)
     } File;
@@ -712 +716 @@
 /** Map for keeping settings per virtual screen.
  *  The key specifies the screen ID. */
-typedef std::map<uint32_t, RecordingScreenSettings> RecordingScreenMap;
+typedef std::map<uint32_t, RecordingScreenSettings> RecordingScreenSettingsMap;
+
+/**
+ * Common recording settings, shared among all per-screen recording settings.
+ */
+struct RecordingCommonSettings
+{
+    RecordingCommonSettings();
+
+    void applyDefaults(void);
+
+    bool areDefaultSettings(void) const;
+
+    bool operator==(const RecordingCommonSettings &d) const;
+
+    /** Whether recording as a whole is enabled or disabled. */
+    bool fEnabled;       // requires settings version 1.14 (VirtualBox 4.3)
+};
 
 /**
@@ -727 +748 @@
     bool areDefaultSettings(void) const;
 
-    bool operator==(const RecordingSettings &d) const;
-
-    /** Whether recording as a whole is enabled or disabled. */
-    bool               fEnabled;       // requires settings version 1.14 (VirtualBox 4.3)
+    bool operator==(const RecordingSettings &that) const;
+
+    /** Common settings for all per-screen recording settings. */
+    RecordingCommonSettings    common;
     /** Map of handled recording screen settings.
      *  The key specifies the screen ID. */
-    RecordingScreenMap mapScreens;
+    RecordingScreenSettingsMap mapScreens;
 };
 
@@ -1235 +1256 @@
     BIOSSettings        biosSettings;
     NvramSettings       nvramSettings;
-    RecordingSettings   recordingSettings;
     GraphicsAdapter     graphicsAdapter;
     USB                 usbSettings;
@@ -1311 +1331 @@
     bool operator==(const Snapshot &s) const;
 
-    com::Guid       uuid;
-    com::Utf8Str    strName,
-                    strDescription;             // optional
-    RTTIMESPEC      timestamp;
-
-    com::Utf8Str    strStateFile;               // for online snapshots only
-
-    Hardware        hardware;
-
-    Debugging       debugging;
-    Autostart       autostart;
-
-    SnapshotsList   llChildSnapshots;
+    com::Guid           uuid;
+    com::Utf8Str        strName,
+                        strDescription;             // optional
+    RTTIMESPEC          timestamp;
+
+    com::Utf8Str        strStateFile;               // for online snapshots only
+
+    Hardware            hardware;
+
+    Debugging           debugging;
+    Autostart           autostart;
+    RecordingSettings   recordingSettings;
+
+    SnapshotsList       llChildSnapshots;
 
     static const struct Snapshot Empty;
@@ -1391 +1412 @@
     Debugging               debugging;
     Autostart               autostart;
+    RecordingSettings       recordingSettings;
 
     StringsMap              mapExtraDataItems;
@@ -1447 +1469 @@
     void readDebugging(const xml::ElementNode &elmDbg, Debugging &dbg);
     void readAutostart(const xml::ElementNode &elmAutostart, Autostart &autostrt);
+    void readRecordingSettings(const xml::ElementNode &elmRecording, RecordingSettings &recording);
     void readGroups(const xml::ElementNode &elmGroups, StringsList &llGroups);
     bool readSnapshot(const com::Guid &curSnapshotUuid, const xml::ElementNode &elmSnapshot, Snapshot &snap);
@@ -1461 +1484 @@
     void buildDebuggingXML(xml::ElementNode &elmParent, const Debugging &dbg);
     void buildAutostartXML(xml::ElementNode &elmParent, const Autostart &autostrt);
+    void buildRecordingXML(xml::ElementNode &elmParent, const RecordingSettings &recording);
     void buildGroupsXML(xml::ElementNode &elmParent, const StringsList &llGroups);
     void buildSnapshotXML(xml::ElementNode &elmParent, const Snapshot &snap);