Changeset 88887 in vbox for trunk/include

Timestamp:

May 5, 2021 11:38:58 PM (4 years ago)

Author:

vboxsync

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

144222

Message:

Audio: Changed PDMIHOSTAUDIO::pfnStreamGetStatus into pfnStreamGetState and defined a simpler state enum (PDMHOSTAUDIOSTREAMSTATE) that fits what DrvAudio needs and the backends actually want to tell us. Fixes one VRDE issue. bugref:9890

Location:

trunk/include/VBox/vmm

Files:

• pdmaudioifs.h (modified) (3 diffs)
• pdmaudioinline.h (modified) (3 diffs)

trunk/include/VBox/vmm/pdmaudioifs.h

@@ -1308 +1308 @@
 #define PDMAUDIOBACKENDSTREAM_MAGIC PDM_VERSION_MAKE(0xa0d4, 1, 0)
 
+/**
+ * Host audio (backend) stream state returned by PDMIHOSTAUDIO::pfnStreamGetState.
+ */
+typedef enum PDMHOSTAUDIOSTREAMSTATE
+{
+    /** Invalid zero value, as per usual.   */
+    PDMHOSTAUDIOSTREAMSTATE_INVALID = 0,
+    /** The stream is being initialized.
+     * This should also be used when switching to a new device and the stream
+     * stops to work with the old device while the new one being configured.  */
+    PDMHOSTAUDIOSTREAMSTATE_INITIALIZING,
+    /** The stream does not work (async init failed, audio subsystem gone
+     *  fishing, or similar). */
+    PDMHOSTAUDIOSTREAMSTATE_NOT_WORKING,
+    /** Backend is working okay. */
+    PDMHOSTAUDIOSTREAMSTATE_OKAY,
+    /** Backend is working but doesn't want any commands or data reads/writes. */
+    PDMHOSTAUDIOSTREAMSTATE_INACTIVE,
+    /** End of valid values. */
+    PDMHOSTAUDIOSTREAMSTATE_END,
+    /** Blow the type up to 32 bits. */
+    PDMHOSTAUDIOSTREAMSTATE_32BIT_HACK = 0x7fffffff
+} PDMHOSTAUDIOSTREAMSTATE;
+
 
 /** Pointer to a host audio interface. */
@@ -1500 +1524 @@
 
     /**
-     * Returns the current status of the given backend stream.
-     *
-     * @returns PDMAUDIOSTREAM_STS_XXX
+     * Returns the current state of the given backend stream.
+     *
+     * @returns PDMHOSTAUDIOSTREAMSTATE value.
+     * @retval  PDMHOSTAUDIOSTREAMSTATE_INVALID if invalid stream.
      * @param   pInterface          Pointer to the interface structure containing the called function pointer.
      * @param   pStream             Pointer to audio stream.
      */
-    DECLR3CALLBACKMEMBER(uint32_t, pfnStreamGetStatus, (PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream));
+    DECLR3CALLBACKMEMBER(PDMHOSTAUDIOSTREAMSTATE, pfnStreamGetState, (PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream));
 
     /**
@@ -1533 +1558 @@
     DECLR3CALLBACKMEMBER(int, pfnStreamCapture, (PPDMIHOSTAUDIO pInterface, PPDMAUDIOBACKENDSTREAM pStream,
                                                  void *pvBuf, uint32_t cbBuf, uint32_t *pcbRead));
-
 } PDMIHOSTAUDIO;
 
 /** PDMIHOSTAUDIO interface ID. */
-#define PDMIHOSTAUDIO_IID                           "b320d6ab-6cbc-46a8-8011-57e7f7eb0e25"
+#define PDMIHOSTAUDIO_IID                           "53949a0a-ca2d-4d25-869f-2a8357991293"
 
 

trunk/include/VBox/vmm/pdmaudioinline.h

@@ -1107 +1107 @@
 
 /**
+ * Converts a audio stream state enum value to a string.
+ *
+ * @returns Pointer to read-only audio stream state string on success,
+ *          "illegal" if invalid command value.
+ * @param   enmStreamState  The state to convert.
+ */
+DECLINLINE(const char *) PDMAudioStreamStateGetName(PDMAUDIOSTREAMSTATE enmStreamState)
+{
+    switch (enmStreamState)
+    {
+        case PDMAUDIOSTREAMSTATE_INVALID:           return "invalid";
+        case PDMAUDIOSTREAMSTATE_NOT_WORKING:       return "not-working";
+        case PDMAUDIOSTREAMSTATE_NEED_REINIT:       return "need-reinit";
+        case PDMAUDIOSTREAMSTATE_INACTIVE:          return "inactive";
+        case PDMAUDIOSTREAMSTATE_ENABLED:           return "enabled";
+        case PDMAUDIOSTREAMSTATE_ENABLED_READABLE:  return "enabled-readable";
+        case PDMAUDIOSTREAMSTATE_ENABLED_WRITABLE:  return "enabled-writable";
+        /* no default: */
+        case PDMAUDIOSTREAMSTATE_END:
+        case PDMAUDIOSTREAMSTATE_32BIT_HACK:
+            break;
+    }
+    AssertMsgFailedReturn(("Invalid audio stream state: %d\n", enmStreamState), "illegal");
+}
+
+/**
+ * Converts a host audio (backend) stream state enum value to a string.
+ *
+ * @returns Pointer to read-only host audio stream state string on success,
+ *          "illegal" if invalid command value.
+ * @param   enmHostAudioStreamState The state to convert.
+ */
+DECLINLINE(const char *) PDMHostAudioStreamStateGetName(PDMHOSTAUDIOSTREAMSTATE enmHostAudioStreamState)
+{
+    switch (enmHostAudioStreamState)
+    {
+        case PDMHOSTAUDIOSTREAMSTATE_INVALID:       return "invalid";
+        case PDMHOSTAUDIOSTREAMSTATE_INITIALIZING:  return "initializing";
+        case PDMHOSTAUDIOSTREAMSTATE_NOT_WORKING:   return "not-working";
+        case PDMHOSTAUDIOSTREAMSTATE_OKAY:          return "okay";
+        case PDMHOSTAUDIOSTREAMSTATE_INACTIVE:      return "inactive";
+        /* no default: */
+        case PDMHOSTAUDIOSTREAMSTATE_END:
+        case PDMHOSTAUDIOSTREAMSTATE_32BIT_HACK:
+            break;
+    }
+    AssertMsgFailedReturn(("Invalid host audio stream state: %d\n", enmHostAudioStreamState), "illegal");
+}
+
+/**
  * Checks if the stream status is one that can be read from.
  *
@@ -1121 +1171 @@
                        | PDMAUDIOSTREAM_STS_PAUSED
                        | PDMAUDIOSTREAM_STS_NEED_REINIT))
-        == (  PDMAUDIOSTREAM_STS_INITIALIZED
-            | PDMAUDIOSTREAM_STS_ENABLED);
-}
-
-/**
- * Checks if the stream status is one that can be read from.
- *
- * @returns @c true if ready to be read from, @c false if not.
- * @param   fStatus     Stream status to evaluate, PDMAUDIOSTREAM_STS_XXX.
- * @note    Only for backend statuses.
- */
-DECLINLINE(bool) PDMAudioStrmStatusBackendCanRead(uint32_t fStatus)
-{
-    PDMAUDIOSTREAM_STS_ASSERT_VALID_BACKEND(fStatus);
-    AssertReturn(!(fStatus & ~PDMAUDIOSTREAM_STS_VALID_MASK_BACKEND), false);
-    return (fStatus & (  PDMAUDIOSTREAM_STS_INITIALIZED
-                       | PDMAUDIOSTREAM_STS_ENABLED
-                       | PDMAUDIOSTREAM_STS_PAUSED
-                       | PDMAUDIOSTREAM_STS_NEED_REINIT ))
         == (  PDMAUDIOSTREAM_STS_INITIALIZED
             | PDMAUDIOSTREAM_STS_ENABLED);
@@ -1165 +1196 @@
 
 /**
- * Checks if the stream status is one that can be written to, backend edition.
- *
- * @returns @c true if ready to be written to, @c false if not.
- * @param   fStatus     Stream status to evaluate, PDMAUDIOSTREAM_STS_XXX.
- * @note    Only for backend statuses.
- */
-DECLINLINE(bool) PDMAudioStrmStatusBackendCanWrite(uint32_t fStatus)
-{
-    PDMAUDIOSTREAM_STS_ASSERT_VALID_BACKEND(fStatus);
-    AssertReturn(!(fStatus & ~PDMAUDIOSTREAM_STS_VALID_MASK_BACKEND), false);
-    return (fStatus & (  PDMAUDIOSTREAM_STS_INITIALIZED
-                       | PDMAUDIOSTREAM_STS_ENABLED
-                       | PDMAUDIOSTREAM_STS_PAUSED
-                       | PDMAUDIOSTREAM_STS_PENDING_DISABLE))
-        == (  PDMAUDIOSTREAM_STS_INITIALIZED
-            | PDMAUDIOSTREAM_STS_ENABLED);
-}
-
-/**
  * Checks if the stream status is a ready-to-operate one.
  *