Changeset 105266 in vbox for trunk/src/VBox/Frontends

Timestamp:

Jul 11, 2024 7:49:37 AM (7 months ago)

Author:

vboxsync

Message:

Recording: Implemented support for a dedicated progress object, which is exposed to API clients. This can be used for better tracking the recording progress as well as for error reporting. The RecordingSettings API also now has a dedicated start() method to start recording, as well as support for attaching to an already ongoing recording by retrieving the progress object at a later time. Adapted FE/Qt (draft, see @todos), FE/VBoxManage and the Validation Kit testdriver to the new APIs. VBoxManage also can attach to an ongoing recording now. The recording progress object also will have multiple operations to get the recording progress for convenience. bugref:10718

Location:

trunk/src/VBox/Frontends

Files:

• VBoxManage/VBoxManageControlVM.cpp (modified) (2 diffs)
• VBoxManage/VBoxManageInfo.cpp (modified) (1 diff)
• VirtualBox/src/globals/UIDetailsGenerator.cpp (modified) (2 diffs)
• VirtualBox/src/globals/UIMainEventListener.cpp (modified) (1 diff)
• VirtualBox/src/runtime/UIConsoleEventHandler.cpp (modified) (1 diff)
• VirtualBox/src/runtime/UISession.cpp (modified) (2 diffs)
• VirtualBox/src/settings/machine/UIMachineSettingsDisplay.cpp (modified) (3 diffs)

trunk/src/VBox/Frontends/VBoxManage/VBoxManageControlVM.cpp

@@ -1797 +1797 @@
                  || !strcmp(a->argv[1], "videocap") /* legacy command */)
         {
+            if (!strcmp(a->argv[1], "videocap"))
+                RTMsgWarning(ControlVM::tr("Sub command 'videocap' is deprecated -- please use 'recording' instead ."));
+
             if (a->argc < 3)
             {
@@ -1815 +1818 @@
             /* Note: For now all screens have the same configuration. */
 
-            /*
-             * Note: Commands starting with "vcp" are the deprecated versions and are
-             *       kept to ensure backwards compatibility.
-             */
             bool fEnabled;
             if (RT_SUCCESS(parseBool(a->argv[2], &fEnabled)))
             {
-                setCurrentSubcommand(HELP_SCOPE_CONTROLVM_RECORDING);
+                //setCurrentSubcommand(HELP_SCOPE_CONTROLVM_RECORDING);
                 CHECK_ERROR_RET(recordingSettings, COMSETTER(Enabled)(fEnabled), RTEXITCODE_FAILURE);
+
+                if (fEnabled)
+                    RTPrintf(ControlVM::tr("Recording enabled. Use 'start' to start recording.\n"));
+            }
+            else if (!strcmp(a->argv[2], "start"))
+            {
+                //setCurrentSubcommand(HELP_SCOPE_CONTROLVM_RECORDING_START);
+                bool fWait = false;
+                if (a->argc >= 4 && !strcmp(a->argv[3], "--wait"))
+                    fWait = true;
+
+                ComPtr<IProgress> progress;
+                CHECK_ERROR_BREAK(recordingSettings, Start(progress.asOutParam()));
+
+                if (fWait)
+                {
+                    hrc = showProgress(progress, SHOW_PROGRESS_OPS);
+                    CHECK_PROGRESS_ERROR(progress, (ControlVM::tr("Recording failed.")));
+                }
+                else
+                    RTPrintf(ControlVM::tr("Recording started (detacted).\n"));
+            }
+            else if (!strcmp(a->argv[2], "stop"))
+            {
+                //setCurrentSubcommand(HELP_SCOPE_CONTROLVM_RECORDING_STOP);
+                ComPtr<IProgress> progress;
+                CHECK_ERROR_BREAK(recordingSettings, COMGETTER(Progress)(progress.asOutParam()));
+                CHECK_ERROR_BREAK(progress, Cancel());
+            }
+            else if (!strcmp(a->argv[2], "attach"))
+            {
+                //setCurrentSubcommand(HELP_SCOPE_CONTROLVM_RECORDING_ATTACH);
+                ComPtr<IProgress> progress;
+                CHECK_ERROR_BREAK(recordingSettings, COMGETTER(Progress)(progress.asOutParam()));
+                hrc = showProgress(progress, SHOW_PROGRESS_OPS);
             }
             else if (!strcmp(a->argv[2], "screens"))

trunk/src/VBox/Frontends/VBoxManage/VBoxManageInfo.cpp

@@ -2899 +2899 @@
         CHECK_ERROR_RET(machine, COMGETTER(RecordingSettings)(recordingSettings.asOutParam()), hrc);
 
-        BOOL  fEnabled;
+        BOOL fStarted = FALSE;
+        ComPtr<IProgress> progress;
+        hrc = recordingSettings->COMGETTER(Progress)(progress.asOutParam());
+        if (SUCCEEDED(hrc))
+        {
+            hrc = progress->COMGETTER(Completed)(&fStarted);
+            fStarted = !fStarted;
+        }
+        SHOW_BOOL_VALUE_EX("recording_started", Info::tr("Recording status:"), fStarted, Info::tr("started"), Info::tr("stopped"));
+
+        BOOL fEnabled;
         CHECK_ERROR_RET(recordingSettings, COMGETTER(Enabled)(&fEnabled), hrc);
         SHOW_BOOL_VALUE_EX("recording_enabled", Info::tr("Recording enabled:"), fEnabled, Info::tr("yes"), Info::tr("no"));

trunk/src/VBox/Frontends/VirtualBox/src/globals/UIDetailsGenerator.cpp

@@ -527 +527 @@
     {
         CRecordingSettings comRecordingSettings = comMachine.GetRecordingSettings();
-        if (comRecordingSettings.GetEnabled())
+        CProgress comProgress = comRecordingSettings.GetProgress(); /** @todo r=andy Revamp this. */
+        /** @r=andy Check if recording is running: if not completed AND not canceled. */
+        if (comProgress.isOk() && !comProgress.GetCompleted() && !comProgress.GetCanceled())
         {
             /* For now all screens have the same config: */
@@ -1462 +1464 @@
     /* Get recording settings: */
     CRecordingSettings comRecordingSettings = comMachine.GetRecordingSettings();
-    fRecordingEnabled = comRecordingSettings.GetEnabled();
+    CProgress comProgress = comRecordingSettings.GetProgress(); /** r=andy Revamp this. */
+    /** @r=andy Check if recording is running: if not completed AND not canceled. */
+    fRecordingEnabled = comProgress.isOk() && !comProgress.GetCompleted() && !comProgress.GetCanceled();
     if (fRecordingEnabled)
     {

trunk/src/VBox/Frontends/VirtualBox/src/globals/UIMainEventListener.cpp

@@ -481 +481 @@
             break;
         }
-        case KVBoxEventType_OnRecordingChanged:
+        case KVBoxEventType_OnRecordingStateChanged:
         {
             emit sigRecordingChange();

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIConsoleEventHandler.cpp

@@ -217 +217 @@
         << KVBoxEventType_OnVRDEServerChanged
         << KVBoxEventType_OnVRDEServerInfoChanged
-        << KVBoxEventType_OnRecordingChanged
+        << KVBoxEventType_OnRecordingStateChanged
         << KVBoxEventType_OnUSBControllerChanged
         << KVBoxEventType_OnUSBDeviceStateChanged

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UISession.cpp

@@ -1939 +1939 @@
     else
     {
-        const BOOL fSettingsEnabled = comSettings.GetEnabled();
-        fSuccess = comSettings.isOk();
-        if (!fSuccess)
-            UINotificationMessage::cannotAcquireRecordingSettingsParameter(comSettings);
-        else
-            fEnabled = fSettingsEnabled == TRUE;
+        /** @todo r=andy Revamp this. */
+        CProgress comProgress = comSettings.GetProgress();
+        fEnabled = comProgress.isOk() && !comProgress.GetCompleted() && !comProgress.GetCanceled();
     }
     return fSuccess;
@@ -1958 +1955 @@
     else
     {
-        comSettings.SetEnabled(fEnabled);
-        fSuccess = comSettings.isOk();
-        if (!fSuccess)
-            UINotificationMessage::cannotToggleRecording(comSettings, machineName(), fEnabled);
+        /** @todo r=andy Revamp this function to better use the progress object.
+         *               Probably also needs a bit of refactoring of the overall handling within FE/Qt. */
+        CProgress comProgress;
+        if (fEnabled)
+        {
+            comProgress = comSettings.Start();
+            fSuccess = comSettings.isOk();
+            if (!fSuccess)
+                UINotificationMessage::cannotToggleRecording(comSettings, machineName(), fEnabled);
+        }
+        else
+        {
+            comProgress = comSettings.GetProgress();
+            if (comProgress.isOk())
+                comProgress.Cancel();
+            else
+                UINotificationMessage::cannotToggleRecording(comSettings, machineName(), fEnabled);
+        }
+
     }
     return fSuccess;

trunk/src/VBox/Frontends/VirtualBox/src/settings/machine/UIMachineSettingsDisplay.cpp

@@ -53 +53 @@
 #include "CExtPackManager.h"
 #include "CGraphicsAdapter.h"
+#include "CProgress.h" /* For starting recording. */
 #include "CRecordingScreenSettings.h"
 #include "CRecordingSettings.h"
@@ -1329 +1330 @@
                     fSuccess = comRecordingScreenSettings.isOk();
                 }
-
                 if (!fSuccess)
                 {
@@ -1344 +1344 @@
                 recordingSettings.SetEnabled(newDisplayData.m_fRecordingEnabled);
                 fSuccess = recordingSettings.isOk();
+                if (fSuccess)
+                {
+                    /* Start recording when recording got enabled. */
+                    /** @todo r=andy Not sure if this is the right place for it. */
+                    CProgress comProgress = recordingSettings.Start();
+                    fSuccess = recordingSettings.isOk();
+                }
             }
         }