Changeset 24539 in vbox

Timestamp:

Nov 10, 2009 11:59:03 AM (15 years ago)

Author:

vboxsync

Message:

Saved state screenshot API (xTracker 4364).

Location:

trunk/src/VBox/Main

Files:

• DisplayImpl.cpp (modified) (2 diffs)
• MachineImpl.cpp (modified) (10 diffs)
• idl/VirtualBox.xidl (modified) (3 diffs)
• include/MachineImpl.h (modified) (1 diff)

trunk/src/VBox/Main/DisplayImpl.cpp

@@ -666 +666 @@
     AssertRCReturn(rc, rc);
 
-#if 0
     /* uInstance is an arbitrary value greater than 1024. Such a value will ensure a quick seek in saved state file. */
     rc = SSMR3RegisterExternal(pVM, "DisplayScreenshot", 1100 /*uInstance*/, sSSMDisplayScreenshotVer, 0 /*cbGuess*/,
@@ -674 +673 @@
 
     AssertRCReturn(rc, rc);
-#endif
 
     return VINF_SUCCESS;

trunk/src/VBox/Main/MachineImpl.cpp

@@ -3923 +3923 @@
 static int readSavedDisplayScreenshot(Utf8Str *pStateFilePath, uint32_t u32Type, uint8_t **ppu8Data, uint32_t *pcbData, uint32_t *pu32Width, uint32_t *pu32Height)
 {
+    LogFlowFunc(("u32Type = %d [%s]\n", u32Type, pStateFilePath->raw()));
+
     /* @todo cache read data */
     if (pStateFilePath->isEmpty())
@@ -3984 +3986 @@
                             /* No saved state data. */
                             rc = VERR_NOT_SUPPORTED;
-                            break;
                         }
+
+                        break;
                     }
                     else
@@ -4021 +4024 @@
         *pu32Width = u32Width;
         *pu32Height = u32Height;
-    }
-
+        LogFlowFunc(("cbData %d, u32Width %d, u32Height %d\n", cbData, u32Width, u32Height));
+    }
+
+    LogFlowFunc(("rc %Rrc\n", rc));
     return rc;
 }
@@ -4056 +4061 @@
                          tr("Saved screenshot data is not available (%Rrc)"), vrc);
 
+    *aSize = cbData;
+    *aWidth = u32Width;
+    *aHeight = u32Height;
+
     freeSavedDisplayScreenshot(pu8Data);
 
@@ -4061 +4070 @@
 }
 
-STDMETHODIMP Machine::ReadSavedThumbnail(BYTE *aAddress, ULONG aSize)
+STDMETHODIMP Machine::ReadSavedThumbnailToArray(BOOL aBGR, ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData))
 {
     LogFlowThisFunc(("\n"));
 
-    CheckComArgNotNull(aAddress);
+    CheckComArgNotNull(aWidth);
+    CheckComArgNotNull(aHeight);
+    CheckComArgExpr(aData, !ComSafeArrayOutIsNull(aData));
 
     AutoCaller autoCaller(this);
@@ -4082 +4093 @@
         return setError (VBOX_E_IPRT_ERROR,
                          tr("Saved screenshot data is not available (%Rrc)"), vrc);
-    if (aSize != cbData)
-        return setError (E_INVALIDARG,
-                         tr("Invalid size of data buffer: %d"), aSize);
-
-    memcpy(aAddress, pu8Data, cbData);
+
+    *aWidth = u32Width;
+    *aHeight = u32Height;
+
+    com::SafeArray<BYTE> bitmap(cbData);
+    /* Convert pixels to format expected by the API caller. */
+    if (aBGR)
+    {
+        /* [0] B, [1] G, [2] R, [3] A. */
+        for (unsigned i = 0; i < cbData; i += 4)
+        {
+            bitmap[i]     = pu8Data[i];
+            bitmap[i + 1] = pu8Data[i + 1];
+            bitmap[i + 2] = pu8Data[i + 2];
+            bitmap[i + 3] = 0xff;
+        }
+    }
+    else
+    {
+        /* [0] R, [1] G, [2] B, [3] A. */
+        for (unsigned i = 0; i < cbData; i += 4)
+        {
+            bitmap[i]     = pu8Data[i + 2];
+            bitmap[i + 1] = pu8Data[i + 1];
+            bitmap[i + 2] = pu8Data[i];
+            bitmap[i + 3] = 0xff;
+        }
+    }
+    bitmap.detachTo(ComSafeArrayOutArg(aData));
 
     freeSavedDisplayScreenshot(pu8Data);
@@ -4093 +4128 @@
 }
 
-STDMETHODIMP Machine::ReadSavedThumbnailToArray(ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData))
+STDMETHODIMP Machine::QuerySavedScreenshotPNGSize(ULONG *aSize, ULONG *aWidth, ULONG *aHeight)
 {
     LogFlowThisFunc(("\n"));
 
+    CheckComArgNotNull(aSize);
     CheckComArgNotNull(aWidth);
     CheckComArgNotNull(aHeight);
-    CheckComArgSafeArrayNotNull(aData);
 
     AutoCaller autoCaller(this);
@@ -4111 +4146 @@
     uint32_t u32Height = 0;
 
-    int vrc = readSavedDisplayScreenshot(&mSSData->mStateFilePath, 0 /* u32Type */, &pu8Data, &cbData, &u32Width, &u32Height);
+    int vrc = readSavedDisplayScreenshot(&mSSData->mStateFilePath, 1 /* u32Type */, &pu8Data, &cbData, &u32Width, &u32Height);
 
     if (RT_FAILURE(vrc))
@@ -4117 +4152 @@
                          tr("Saved screenshot data is not available (%Rrc)"), vrc);
 
+    *aSize = cbData;
     *aWidth = u32Width;
     *aHeight = u32Height;
 
-    com::SafeArray<BYTE> bitmap(cbData);
-    /* Convert pixels to format expected by the API caller: [0] R, [1] G, [2] B, [3] A. */
-    for (unsigned i = 0; i < cbData; i += 4)
-    {
-        bitmap[i]     = pu8Data[i + 2];
-        bitmap[i + 1] = pu8Data[i + 1];
-        bitmap[i + 2] = pu8Data[i];
-        bitmap[i + 3] = 0xff;
-    }
-    bitmap.detachTo(ComSafeArrayOutArg(aData));
-
     freeSavedDisplayScreenshot(pu8Data);
 
@@ -4136 +4161 @@
 }
 
-STDMETHODIMP Machine::QuerySavedScreenshotPNGSize(ULONG *aSize, ULONG *aWidth, ULONG *aHeight)
+STDMETHODIMP Machine::ReadSavedScreenshotPNGToArray(ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData))
 {
     LogFlowThisFunc(("\n"));
 
-    CheckComArgNotNull(aSize);
     CheckComArgNotNull(aWidth);
     CheckComArgNotNull(aHeight);
-
-    AutoCaller autoCaller(this);
-    CheckComRCReturnRC(autoCaller.rc());
-
-    AutoReadLock alock(this);
-
-    uint8_t *pu8Data = NULL;
-    uint32_t cbData = 0;
-    uint32_t u32Width = 0;
-    uint32_t u32Height = 0;
-
-    int vrc = readSavedDisplayScreenshot(&mSSData->mStateFilePath, 1 /* u32Type */, &pu8Data, &cbData, &u32Width, &u32Height);
-
-    if (RT_FAILURE(vrc))
-        return setError (VBOX_E_IPRT_ERROR,
-                         tr("Saved screenshot data is not available (%Rrc)"), vrc);
-
-    freeSavedDisplayScreenshot(pu8Data);
-
-    return S_OK;
-}
-
-STDMETHODIMP Machine::ReadSavedScreenshotPNG(BYTE *aAddress, ULONG aSize)
-{
-    LogFlowThisFunc(("\n"));
-
-    CheckComArgNotNull(aAddress);
-
-    AutoCaller autoCaller(this);
-    CheckComRCReturnRC(autoCaller.rc());
-
-    AutoReadLock alock(this);
-
-    uint8_t *pu8Data = NULL;
-    uint32_t cbData = 0;
-    uint32_t u32Width = 0;
-    uint32_t u32Height = 0;
-
-    int vrc = readSavedDisplayScreenshot(&mSSData->mStateFilePath, 1 /* u32Type */, &pu8Data, &cbData, &u32Width, &u32Height);
-
-    if (RT_FAILURE(vrc))
-        return setError (VBOX_E_IPRT_ERROR,
-                         tr("Saved screenshot data is not available (%Rrc)"), vrc);
-    if (aSize != cbData)
-        return setError (E_INVALIDARG,
-                         tr("Invalid size of data buffer: %d"), aSize);
-
-    memcpy(aAddress, pu8Data, cbData);
-
-    freeSavedDisplayScreenshot(pu8Data);
-
-    return S_OK;
-}
-
-STDMETHODIMP Machine::ReadSavedScreenshotPNGToArray(ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData))
-{
-    LogFlowThisFunc(("\n"));
-
-    CheckComArgNotNull(aWidth);
-    CheckComArgNotNull(aHeight);
-    CheckComArgSafeArrayNotNull(aData);
+    CheckComArgExpr(aData, !ComSafeArrayOutIsNull(aData));
 
     AutoCaller autoCaller(this);

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -4105 +4105 @@
   <interface
      name="IMachine" extends="$unknown"
-     uuid="c5669e1a-491a-4367-99c6-28110dd474c6"
+     uuid="99404f50-dd10-40d3-889b-dd2f79f1e95e"
      wsmap="managed"
      >
@@ -5796 +5796 @@
     </method>
 
-    <method name="readSavedThumbnail">
-      <desc>
-        Reads a saved thumbnail bitmap from saved state.
-        A pixel consists of 4 bytes in order: B, G, R, 0.
-
-        <note>This API can be used only by the COM/XPCOM C++ API as it
-            requires pointer support. Use <link to="#readSavedThumbnailToArray" />
-            with other language bindings.
-        </note>
-      </desc>
-      <param name="address" type="octet" mod="ptr" dir="in">
-        <desc>
-          Buffer allocated by caller. Size must be at least equal
-          to value returned by querySavedThumbnailSize.
-        </desc>
-      </param>
-      <param name="size" type="unsigned long" dir="in">
-        <desc>
-          Size of buffer allocated by caller. If the buffer is too small,
-          the method fails.
-        </desc>
-      </param>
-    </method>
-
     <method name="readSavedThumbnailToArray">
       <desc>
-        Thumbnail is retrieved to an array of bytes in uncompressed 32-bit RGBA format.
-        A pixel consists of 4 bytes in order: R, G, B, 0xFF.
-
-        This API is slow, but could be the only option to get image
-        for scriptable languages not allowed to manipulate with addresses
-        directly.
-      </desc>
+        Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
+      </desc>
+      <param name="BGR" type="boolean" dir="in">
+        <desc>
+          How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
+          bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF. 
+        </desc>
+      </param>
       <param name="width" type="unsigned long" dir="out">
         <desc>
@@ -5867 +5844 @@
     </method>
 
-    <method name="readSavedScreenshotPNG">
-      <desc>
-        Reads a saved screenshot in PNG format from saved state.
-
-        <note>This API can be used only by the COM/XPCOM C++ API as it
-            requires pointer support. Use <link to="#readSavedScreenshotPNGToArray" />
-            with other language bindings.
-        </note>
-      </desc>
-      <param name="address" type="octet" mod="ptr" dir="in">
-        <desc>
-          Buffer allocated by caller. Size must be at least equal
-          to value returned by querySavedScreenshotPNGSize.
-        </desc>
-      </param>
-      <param name="size" type="unsigned long" dir="in">
-        <desc>
-          Size of buffer allocated by caller. If the buffer is too small,
-          the method fails.
-        </desc>
-      </param>
-    </method>
-
     <method name="readSavedScreenshotPNGToArray">
       <desc>
         Screenshot in PNG format is retrieved to an array of bytes.
-
-        This API is slow, but could be the only option to get image
-        for scriptable languages not allowed to manipulate with addresses
-        directly.
       </desc>
       <param name="width" type="unsigned long" dir="out">

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

@@ -630 +630 @@
 
     STDMETHOD(QuerySavedThumbnailSize)(ULONG *aSize, ULONG *aWidth, ULONG *aHeight);
-    STDMETHOD(ReadSavedThumbnail)(BYTE *aAddress, ULONG aSize);
-    STDMETHOD(ReadSavedThumbnailToArray)(ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData));
+    STDMETHOD(ReadSavedThumbnailToArray)(BOOL aBGR, ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData));
     STDMETHOD(QuerySavedScreenshotPNGSize)(ULONG *aSize, ULONG *aWidth, ULONG *aHeight);
-    STDMETHOD(ReadSavedScreenshotPNG)(BYTE *aAddress, ULONG aSize);
     STDMETHOD(ReadSavedScreenshotPNGToArray)(ULONG *aWidth, ULONG *aHeight, ComSafeArrayOut(BYTE, aData));