Changeset 105266 in vbox for trunk/src/VBox/Main/include/Recording.h

Timestamp:

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

Author:

vboxsync

svn:sync-xref-src-repo-rev:

163915

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

File:

• trunk/src/VBox/Main/include/Recording.h (modified) (8 diffs)

trunk/src/VBox/Main/include/Recording.h

@@ -36 +36 @@
 
 #include "RecordingStream.h"
+#include "ProgressImpl.h"
 
 class Console;
@@ -123 +124 @@
     RecordingContext();
 
-    RecordingContext(Console *ptrConsole, const settings::RecordingSettings &Settings);
-
     virtual ~RecordingContext(void);
 
@@ -136 +135 @@
 #endif
 
-    int Create(Console *pConsole, const settings::RecordingSettings &Settings);
+    int Create(Console *pConsole, const settings::RecordingSettings &Settings, ComPtr<IProgress> &pProgress);
     void Destroy(void);
 
     int Start(void);
     int Stop(void);
+
+    int SetError(int rc, const com::Utf8Str &strText);
 
     int SendAudioFrame(const void *pvData, size_t cbData, uint64_t uTimestampMs);
@@ -167 +168 @@
 protected:
 
-    int createInternal(Console *ptrConsole, const settings::RecordingSettings &Settings);
+    int createInternal(Console *ptrConsole, const settings::RecordingSettings &Settings, ComPtr<IProgress> &pProgress);
+    void reset(void);
     int startInternal(void);
     int stopInternal(void);
@@ -183 +185 @@
     int onLimitReached(uint32_t uScreen, int vrc);
 
+    bool progressIsCanceled(void) const;
+    bool progressIsCompleted(void) const;
+    int progressCreate(const settings::RecordingSettings &Settings, ComObjPtr<Progress> &pProgress);
+    int progressNotifyComplete(HRESULT hrc = S_OK, IVirtualBoxErrorInfo *pErrorInfo = NULL);
+    int progressSet(uint32_t uOp, const Bstr &strDesc);
+    int progressSet(uint64_t msTimestamp);
+
     static DECLCALLBACK(int) threadMain(RTTHREAD hThreadSelf, void *pvUser);
 
@@ -191 +200 @@
     int audioInit(const settings::RecordingScreenSettings &screenSettings);
 
-    static DECLCALLBACK(int) audioCodecWriteDataCallback(PRECORDINGCODEC pCodec, const void *pvData, size_t cbData, uint64_t msAbsPTS, uint32_t uFlags, void *pvUser);
+protected:
+
+    static DECLCALLBACK(void) s_progressCancelCallback(void *pvUser);
+
+    static DECLCALLBACK(void) s_recordingStateChangedCallback(RecordingContext *pCtx, RECORDINGSTS enmSts, uint32_t uScreen, int vrc, void *pvUser);
+
+    static DECLCALLBACK(int)  s_audioCodecWriteDataCallback(PRECORDINGCODEC pCodec, const void *pvData, size_t cbData, uint64_t msAbsPTS, uint32_t uFlags, void *pvUser);
 
 protected:
@@ -207 +222 @@
     /** Semaphore to signal the encoding worker thread. */
     RTSEMEVENT                   m_WaitEvent;
+    /** Current operation of progress. Set to 0 if not started yet, >= 1 if started. */
+    ULONG                        m_ulCurOp;
+    /** Number of progress operations. Always >= 1. */
+    ULONG                        m_cOps;
+    /** The progress object assigned to this context.
+     *  Might be NULL if not being used. */
+    const ComObjPtr<Progress>    m_pProgress;
     /** Shutdown indicator. */
     bool                         m_fShutdown;
@@ -236 +258 @@
      *
      *  This avoids doing the (expensive) encoding + multiplexing work in other
-     *  threads like EMT / audio async I/O..
+     *  threads like EMT / audio async I/O.
      *
      *  For now this only affects audio, e.g. all recording streams