Changeset 75341 in vbox for trunk/src/VBox/Main/include

Timestamp:

Nov 9, 2018 8:37:28 AM (6 years ago)

Author:

vboxsync

Message:

Recording: Renaming APIs ICapture* -> IRecord* and other terminology to better distinguish from features like mouse capturing and stuff.

Location:

trunk/src/VBox/Main/include

Files:

• ConsoleImpl.h (modified) (2 diffs)
• DrvAudioVideoRec.h (modified) (2 diffs)
• MachineImpl.h (modified) (8 diffs)
• RecordScreenSettingsImpl.h (moved) (moved from trunk/src/VBox/Main/include/CaptureScreenSettingsImpl.h ) (7 diffs)
• RecordSettingsImpl.h (moved) (moved from trunk/src/VBox/Main/include/CaptureSettingsImpl.h ) (4 diffs)
• SessionImpl.h (modified) (1 diff)
• VideoRec.h (modified) (5 diffs)
• VideoRecStream.h (modified) (5 diffs)

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

@@ -145 +145 @@
     void i_videoRecDestroy(void);
     int i_videoRecEnable(BOOL fEnable, util::AutoWriteLock *pAutoLock);
-    int i_videoRecGetSettings(settings::CaptureSettings &Settings);
+    int i_videoRecGetSettings(settings::RecordSettings &Settings);
     int i_videoRecStart(void);
     int i_videoRecStop(void);
@@ -179 +179 @@
     HRESULT i_onDnDModeChange(DnDMode_T aDnDMode);
     HRESULT i_onVRDEServerChange(BOOL aRestart);
-    HRESULT i_onCaptureChange();
+    HRESULT i_onRecordChange();
     HRESULT i_onUSBControllerChange();
     HRESULT i_onSharedFolderChange(BOOL aGlobal);

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

@@ -45 +45 @@
 public:
 
-    int applyConfiguration(const settings::CaptureSettings &Settings);
+    int applyConfiguration(const settings::RecordSettings &Settings);
 
 public:
@@ -61 +61 @@
     struct DRVAUDIOVIDEOREC         *mpDrv;
     /** Capturing configuration used for configuring the driver. */
-    struct settings::CaptureSettings mVideoRecCfg;
+    struct settings::RecordSettings mVideoRecCfg;
 };
 

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

@@ -32 +32 @@
 #include "ParallelPortImpl.h"
 #include "BIOSSettingsImpl.h"
-#include "CaptureSettingsImpl.h"
+#include "RecordSettingsImpl.h"
 #include "StorageControllerImpl.h"          // required for MachineImpl.h to compile on Windows
 #include "USBControllerImpl.h"              // required for MachineImpl.h to compile on Windows
@@ -266 +266 @@
         GraphicsControllerType_T mGraphicsControllerType;
         ULONG               mVRAMSize;
-        settings::CaptureSettings mCaptureSettings;
+        settings::RecordSettings mRecordSettings;
         ULONG               mMonitorCount;
         BOOL                mHWVirtExEnabled;
@@ -477 +477 @@
         IsModified_Snapshots            = 0x0800,
         IsModified_BandwidthControl     = 0x1000,
-        IsModified_Capture              = 0x2000
+        IsModified_Record               = 0x2000
     };
 
@@ -524 +524 @@
     virtual HRESULT i_onStorageDeviceChange(IMediumAttachment * /* mediumAttachment */, BOOL /* remove */,
                                             BOOL /* silent */) { return S_OK; }
-    virtual HRESULT i_onCaptureChange() { return S_OK; }
+    virtual HRESULT i_onRecordChange() { return S_OK; }
 
     HRESULT i_saveRegistryEntry(settings::MachineRegistryEntry &data);
@@ -777 +777 @@
     const ComObjPtr<USBDeviceFilters>  mUSBDeviceFilters;
     const ComObjPtr<BIOSSettings>      mBIOSSettings;
-    const ComObjPtr<CaptureSettings>   mCaptureSettings;
+    const ComObjPtr<RecordSettings>    mRecordSettings;
     const ComObjPtr<BandwidthControl>  mBandwidthControl;
 
@@ -825 +825 @@
 
     friend class Appliance;
-    friend class CaptureSettings;
-    friend class CaptureScreenSettings;
+    friend class RecordSettings;
+    friend class RecordScreenSettings;
     friend class SessionMachine;
     friend class SnapshotMachine;
@@ -880 +880 @@
     HRESULT setMonitorCount(ULONG aMonitorCount);
     HRESULT getBIOSSettings(ComPtr<IBIOSSettings> &aBIOSSettings);
-    HRESULT getCaptureSettings(ComPtr<ICaptureSettings> &aCaptureSettings);
+    HRESULT getRecordSettings(ComPtr<IRecordSettings> &aRecordSettings);
     HRESULT getFirmwareType(FirmwareType_T *aFirmwareType);
     HRESULT setFirmwareType(FirmwareType_T aFirmwareType);
@@ -1326 +1326 @@
     HRESULT i_onCPUChange(ULONG aCPU, BOOL aRemove);
     HRESULT i_onVRDEServerChange(BOOL aRestart);
-    HRESULT i_onCaptureChange();
+    HRESULT i_onRecordChange();
     HRESULT i_onUSBControllerChange();
     HRESULT i_onUSBDeviceAttach(IUSBDevice *aDevice,

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

@@ -18 +18 @@
  */
 
-#ifndef ____H_CAPTURESCREENSETTINGS
-#define ____H_CAPTURESCREENSETTINGS
+#ifndef ____H_RecordScreenSettings
+#define ____H_RecordScreenSettings
 
-#include "CaptureScreenSettingsWrap.h"
+#include "RecordScreenSettingsWrap.h"
 
-class CaptureSettings;
+class RecordSettings;
 
 namespace settings
 {
-    struct CaptureScreenSettings;
+    struct RecordScreenSettings;
 }
 
-class ATL_NO_VTABLE CaptureScreenSettings :
-    public CaptureScreenSettingsWrap
+class ATL_NO_VTABLE RecordScreenSettings :
+    public RecordScreenSettingsWrap
 {
 public:
 
-    DECLARE_EMPTY_CTOR_DTOR(CaptureScreenSettings)
+    DECLARE_EMPTY_CTOR_DTOR(RecordScreenSettings)
 
     HRESULT FinalConstruct();
@@ -41 +41 @@
 
     // public initializer/uninitializer for internal purposes only
-    HRESULT init(CaptureSettings *aParent, uint32_t uScreenId, const settings::CaptureScreenSettings& data);
-    HRESULT init(CaptureSettings *aParent, CaptureScreenSettings *that);
-    HRESULT initCopy(CaptureSettings *aParent, CaptureScreenSettings *that);
+    HRESULT init(RecordSettings *aParent, uint32_t uScreenId, const settings::RecordScreenSettings& data);
+    HRESULT init(RecordSettings *aParent, RecordScreenSettings *that);
+    HRESULT initCopy(RecordSettings *aParent, RecordScreenSettings *that);
     void uninit();
 
     // public methods only for internal purposes
-    HRESULT i_loadSettings(const settings::CaptureScreenSettings &data);
-    HRESULT i_saveSettings(settings::CaptureScreenSettings &data);
+    HRESULT i_loadSettings(const settings::RecordScreenSettings &data);
+    HRESULT i_saveSettings(settings::RecordScreenSettings &data);
 
     void i_rollback();
     void i_commit();
-    void i_copyFrom(CaptureScreenSettings *aThat);
+    void i_copyFrom(RecordScreenSettings *aThat);
     void i_applyDefaults();
 
 private:
 
-    // wrapped ICaptureScreenSettings methods
-    HRESULT isFeatureEnabled(CaptureFeature_T aFeature, BOOL *aEnabled);
+    // wrapped IRecordScreenSettings methods
+    HRESULT isFeatureEnabled(RecordFeature_T aFeature, BOOL *aEnabled);
 
-    // wrapped ICaptureScreenSettings properties
+    // wrapped IRecordScreenSettings properties
     HRESULT getId(ULONG *id);
     HRESULT getEnabled(BOOL *enabled);
@@ -66 +66 @@
     HRESULT getFeatures(ULONG *aFeatures);
     HRESULT setFeatures(ULONG aFeatures);
-    HRESULT getDestination(CaptureDestination_T *aDestination);
-    HRESULT setDestination(CaptureDestination_T aDestination);
+    HRESULT getDestination(RecordDestination_T *aDestination);
+    HRESULT setDestination(RecordDestination_T aDestination);
 
     HRESULT getFileName(com::Utf8Str &aFileName);
@@ -78 +78 @@
     HRESULT setOptions(const com::Utf8Str &aOptions);
 
-    HRESULT getAudioCodec(CaptureAudioCodec_T *aCodec);
-    HRESULT setAudioCodec(CaptureAudioCodec_T aCodec);
+    HRESULT getAudioCodec(RecordAudioCodec_T *aCodec);
+    HRESULT setAudioCodec(RecordAudioCodec_T aCodec);
     HRESULT getAudioHz(ULONG *aHz);
     HRESULT setAudioHz(ULONG aHz);
@@ -87 +87 @@
     HRESULT setAudioChannels(ULONG aChannels);
 
-    HRESULT getVideoCodec(CaptureVideoCodec_T *aCodec);
-    HRESULT setVideoCodec(CaptureVideoCodec_T aCodec);
+    HRESULT getVideoCodec(RecordVideoCodec_T *aCodec);
+    HRESULT setVideoCodec(RecordVideoCodec_T aCodec);
     HRESULT getVideoWidth(ULONG *aVideoWidth);
     HRESULT setVideoWidth(ULONG aVideoWidth);
@@ -95 +95 @@
     HRESULT getVideoRate(ULONG *aVideoRate);
     HRESULT setVideoRate(ULONG aVideoRate);
-    HRESULT getVideoRateControlMode(CaptureVideoRateControlMode_T *aMode);
-    HRESULT setVideoRateControlMode(CaptureVideoRateControlMode_T aMode);
+    HRESULT getVideoRateControlMode(RecordVideoRateControlMode_T *aMode);
+    HRESULT setVideoRateControlMode(RecordVideoRateControlMode_T aMode);
     HRESULT getVideoFPS(ULONG *aVideoFPS);
     HRESULT setVideoFPS(ULONG aVideoFPS);
-    HRESULT getVideoScalingMethod(CaptureVideoScalingMethod_T *aMode);
-    HRESULT setVideoScalingMethod(CaptureVideoScalingMethod_T aMode);
+    HRESULT getVideoScalingMethod(RecordVideoScalingMethod_T *aMode);
+    HRESULT setVideoScalingMethod(RecordVideoScalingMethod_T aMode);
 
 private:
@@ -113 +113 @@
 };
 
-#endif // ____H_CAPTURESCREENSETTINGS
+#endif // ____H_RecordScreenSettings
 

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

@@ -18 +18 @@
  */
 
-#ifndef ____H_CAPTURESETTINGS
-#define ____H_CAPTURESETTINGS
+#ifndef ____H_RecordSettings
+#define ____H_RecordSettings
 
-#include "CaptureSettingsWrap.h"
+#include "RecordSettingsWrap.h"
 
 namespace settings
 {
-    struct CaptureSettings;
-    struct CaptureScreenSettings;
+    struct RecordSettings;
+    struct RecordScreenSettings;
 }
 
-class CaptureScreenSettings;
+class RecordScreenSettings;
 
-class ATL_NO_VTABLE CaptureSettings :
-    public CaptureSettingsWrap
+class ATL_NO_VTABLE RecordSettings :
+    public RecordSettingsWrap
 {
 public:
 
-    DECLARE_EMPTY_CTOR_DTOR(CaptureSettings)
+    DECLARE_EMPTY_CTOR_DTOR(RecordSettings)
 
     HRESULT FinalConstruct();
@@ -43 +43 @@
     // public initializer/uninitializer for internal purposes only
     HRESULT init(Machine *parent);
-    HRESULT init(Machine *parent, CaptureSettings *that);
-    HRESULT initCopy(Machine *parent, CaptureSettings *that);
+    HRESULT init(Machine *parent, RecordSettings *that);
+    HRESULT initCopy(Machine *parent, RecordSettings *that);
     void uninit();
 
     // public methods only for internal purposes
-    HRESULT i_loadSettings(const settings::CaptureSettings &data);
-    HRESULT i_saveSettings(settings::CaptureSettings &data);
+    HRESULT i_loadSettings(const settings::RecordSettings &data);
+    HRESULT i_saveSettings(settings::RecordSettings &data);
 
     void i_rollback();
     void i_commit();
-    void i_copyFrom(CaptureSettings *aThat);
+    void i_copyFrom(RecordSettings *aThat);
     void i_applyDefaults(void);
 
@@ -63 +63 @@
 
     /** Map of screen settings objects. The key specifies the screen ID. */
-    typedef std::map <uint32_t, ComObjPtr<CaptureScreenSettings> > CaptureScreenSettingsMap;
+    typedef std::map <uint32_t, ComObjPtr<RecordScreenSettings> > RecordScreenSettingsMap;
 
     void i_reset(void);
     int i_syncToMachineDisplays(void);
-    int i_createScreenObj(CaptureScreenSettingsMap &screenSettingsMap, uint32_t uScreenId, const settings::CaptureScreenSettings &data);
-    int i_destroyScreenObj(CaptureScreenSettingsMap &screenSettingsMap, uint32_t uScreenId);
-    int i_destroyAllScreenObj(CaptureScreenSettingsMap &screenSettingsMap);
+    int i_createScreenObj(RecordScreenSettingsMap &screenSettingsMap, uint32_t uScreenId, const settings::RecordScreenSettings &data);
+    int i_destroyScreenObj(RecordScreenSettingsMap &screenSettingsMap, uint32_t uScreenId);
+    int i_destroyAllScreenObj(RecordScreenSettingsMap &screenSettingsMap);
 
 private:
 
-    // wrapped ICaptureSettings properties
+    // wrapped IRecordSettings properties
     HRESULT getEnabled(BOOL *enabled);
     HRESULT setEnabled(BOOL enable);
-    HRESULT getScreens(std::vector<ComPtr<ICaptureScreenSettings> > &aCaptureScreenSettings);
+    HRESULT getScreens(std::vector<ComPtr<IRecordScreenSettings> > &aRecordScreenSettings);
 
-    // wrapped ICaptureSettings methods
-    HRESULT getScreenSettings(ULONG uScreenId, ComPtr<ICaptureScreenSettings> &aCaptureScreenSettings);
+    // wrapped IRecordSettings methods
+    HRESULT getScreenSettings(ULONG uScreenId, ComPtr<IRecordScreenSettings> &aRecordScreenSettings);
 
 private:
@@ -86 +86 @@
     Data *m;
 };
-#endif // ____H_CAPTURESETTINGS
+#endif // ____H_RecordSettings
 

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

@@ -102 +102 @@
     HRESULT onCPUExecutionCapChange(ULONG aExecutionCap);
     HRESULT onVRDEServerChange(BOOL aRestart);
-    HRESULT onCaptureChange();
+    HRESULT onRecordChange();
     HRESULT onUSBControllerChange();
     HRESULT onSharedFolderChange(BOOL aGlobal);

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

@@ -41 +41 @@
     CaptureContext(Console *pConsole);
 
-    CaptureContext(Console *pConsole, const settings::CaptureSettings &a_Settings);
+    CaptureContext(Console *pConsole, const settings::RecordSettings &a_Settings);
 
     virtual ~CaptureContext(void);
@@ -47 +47 @@
 public:
 
-    const settings::CaptureSettings &GetConfig(void) const;
+    const settings::RecordSettings &GetConfig(void) const;
     CaptureStream *GetStream(unsigned uScreen) const;
     size_t GetStreamCount(void) const;
 
-    int Create(const settings::CaptureSettings &a_Settings);
+    int Create(const settings::RecordSettings &a_Settings);
     int Destroy(void);
 
@@ -64 +64 @@
 public:
 
-    bool IsFeatureEnabled(CaptureFeature_T enmFeature) const;
+    bool IsFeatureEnabled(RecordFeature_T enmFeature) const;
     bool IsReady(void) const;
     bool IsReady(uint32_t uScreen, uint64_t uTimeStampMs) const;
@@ -72 +72 @@
 protected:
 
-    int createInternal(const settings::CaptureSettings &a_Settings);
+    int createInternal(const settings::RecordSettings &a_Settings);
     int startInternal(void);
     int stopInternal(void);
@@ -104 +104 @@
     Console                  *pConsole;
     /** Used recording configuration. */
-    settings::CaptureSettings Settings;
+    settings::RecordSettings Settings;
     /** The current state. */
     VIDEORECSTS               enmState;

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

@@ -111 +111 @@
     CaptureStream(CaptureContext *pCtx);
 
-    CaptureStream(CaptureContext *pCtx, uint32_t uScreen, const settings::CaptureScreenSettings &Settings);
+    CaptureStream(CaptureContext *pCtx, uint32_t uScreen, const settings::RecordScreenSettings &Settings);
 
     virtual ~CaptureStream(void);
@@ -117 +117 @@
 public:
 
-    int Init(CaptureContext *pCtx, uint32_t uScreen, const settings::CaptureScreenSettings &Settings);
+    int Init(CaptureContext *pCtx, uint32_t uScreen, const settings::RecordScreenSettings &Settings);
     int Uninit(void);
 
@@ -124 +124 @@
                        uint32_t uSrcWidth, uint32_t uSrcHeight, uint8_t *puSrcData, uint64_t uTimeStampMs);
 
-    const settings::CaptureScreenSettings &GetConfig(void) const;
+    const settings::RecordScreenSettings &GetConfig(void) const;
     bool IsLimitReached(uint64_t tsNowMs) const;
     bool IsReady(void) const;
@@ -130 +130 @@
 protected:
 
-    int open(const settings::CaptureScreenSettings &Settings);
+    int open(const settings::RecordScreenSettings &Settings);
     int close(void);
 
-    int initInternal(CaptureContext *pCtx, uint32_t uScreen, const settings::CaptureScreenSettings &Settings);
+    int initInternal(CaptureContext *pCtx, uint32_t uScreen, const settings::RecordScreenSettings &Settings);
     int uninitInternal(void);
 
@@ -205 +205 @@
     } Video;
 
-    settings::CaptureScreenSettings ScreenSettings;
+    settings::RecordScreenSettings ScreenSettings;
     /** Common set of video recording (data) blocks, needed for
      *  multiplexing to all recording streams. */