Changeset 88884 in vbox for trunk/include/VBox

Timestamp:

May 5, 2021 6:27:18 PM (4 years ago)

Author:

vboxsync

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

144219

Message:

DrvAudio,Mixer: Changed PDMIAUDIOCONNECTOR::pfnStreamGetStatus into pfnStreamGetState and defined a simpler state enum (PDMAUDIOSTREAMSTATE) that fits the Mixer's need and nothing more. PDMAUDIOSTREAM_STS_XXX will soon be DrvAudio internal. Changed some state checks in the mixer from ENABLED and ENABLED+WRITABLE/READABLE (probably more that needs adjusting). bugref:9890

Location:

trunk/include/VBox/vmm

Files:

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

trunk/include/VBox/vmm/pdmaudioifs.h

@@ -989 +989 @@
 } PDMAUDIOBACKENDSTS;
 
+/**
+ * PDM audio stream state.
+ *
+ * This is all the mixer/device needs.  The PDMAUDIOSTREAM_STS_XXX stuff will
+ * become DrvAudio internal state once the backend stuff is destilled out of it.
+ *
+ * @note    The value order is significant, don't change it willy-nilly.
+ */
+typedef enum PDMAUDIOSTREAMSTATE
+{
+    /** Invalid state value. */
+    PDMAUDIOSTREAMSTATE_INVALID = 0,
+    /** The stream is not operative and cannot be enabled. */
+    PDMAUDIOSTREAMSTATE_NOT_WORKING,
+    /** The stream needs to be re-initialized by the device/mixer
+     * (i.e. call PDMIAUDIOCONNECTOR::pfnStreamReInit). */
+    PDMAUDIOSTREAMSTATE_NEED_REINIT,
+    /** The stream is inactive (not enabled). */
+    PDMAUDIOSTREAMSTATE_INACTIVE,
+    /** The stream is enabled but nothing to read/write.
+     *  @todo not sure if we need this variant... */
+    PDMAUDIOSTREAMSTATE_ENABLED,
+    /** The stream is enabled and captured samples can be read. */
+    PDMAUDIOSTREAMSTATE_ENABLED_READABLE,
+    /** The stream is enabled and samples can be written for playback. */
+    PDMAUDIOSTREAMSTATE_ENABLED_WRITABLE,
+    /** End of valid states.   */
+    PDMAUDIOSTREAMSTATE_END,
+    /** Make sure the type is 32-bit wide. */
+    PDMAUDIOSTREAMSTATE_32BIT_HACK = 0x7fffffff
+} PDMAUDIOSTREAMSTATE;
+
 /** @name PDMAUDIOSTREAM_CREATE_F_XXX
  * @{ */
@@ -1190 +1222 @@
 
     /**
-     * Returns the status of a specific audio stream.
-     *
-     * @returns PDMAUDIOSTREAM_STS_XXX
+     * Returns the state of a specific audio stream (destilled status).
+     *
+     * @returns PDMAUDIOSTREAMSTATE value.
+     * @retval  PDMAUDIOSTREAMSTATE_INVALID if the input isn't valid (w/ assertion).
      * @param   pInterface      Pointer to the interface structure containing the called function pointer.
      * @param   pStream         Pointer to audio stream.
      */
-    DECLR3CALLBACKMEMBER(uint32_t, pfnStreamGetStatus, (PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOSTREAM pStream));
+    DECLR3CALLBACKMEMBER(PDMAUDIOSTREAMSTATE, pfnStreamGetState, (PPDMIAUDIOCONNECTOR pInterface, PPDMAUDIOSTREAM pStream));
 
     /**
@@ -1250 +1283 @@
 
 /** PDMIAUDIOCONNECTOR interface ID. */
-#define PDMIAUDIOCONNECTOR_IID                  "ff6788cc-1a4d-4d4b-a2e0-9f56fce9b397"
+#define PDMIAUDIOCONNECTOR_IID                  "5bd85091-e99c-4092-acea-f0c5e9872408"
 
 

trunk/include/VBox/vmm/pdmaudioinline.h

@@ -1184 +1184 @@
 
 /**
- * Checks if the stream status is a read-to-operate one.
+ * Checks if the stream status is a ready-to-operate one.
  *
  * @returns @c true if ready to operate, @c false if not.