Changeset 88057 in vbox

Timestamp:

Mar 9, 2021 3:11:22 PM (4 years ago)

Author:

vboxsync

Message:

Audio: enums must have an 'END' entry for validation purposes. bugref:9890

Location:

trunk

Files:

• include/VBox/vmm/pdmaudioifs.h (modified) (10 diffs)
• include/VBox/vmm/pdmaudioinline.h (modified) (9 diffs)
• src/VBox/Devices/Audio/DevIchAc97.cpp (modified) (1 diff)
• src/VBox/Devices/Audio/DrvAudio.cpp (modified) (3 diffs)

trunk/include/VBox/vmm/pdmaudioifs.h

@@ -281 +281 @@
     /** 32-bit, signed. */
     PDMAUDIOFMT_S32,
+    /** End of valid values. */
+    PDMAUDIOFMT_END,
     /** Hack to blow the type up to 32-bit. */
     PDMAUDIOFMT_32BIT_HACK = 0x7fffffff
@@ -300 +302 @@
     /** Duplex handling. */
     PDMAUDIODIR_DUPLEX,
+    /** End of valid values. */
+    PDMAUDIODIR_END,
     /** Hack to blow the type up to 32-bit. */
     PDMAUDIODIR_32BIT_HACK = 0x7fffffff
@@ -395 +399 @@
 } PDMAUDIOHOSTDEV;
 AssertCompileSizeAlignment(PDMAUDIOHOSTDEV, 16);
-/** Pointer to audio device info (enum result). */
+/** Pointer to audio device info (enumeration result). */
 typedef PDMAUDIOHOSTDEV *PPDMAUDIOHOSTDEV;
-/** Pointer to a const audio device info (enum result). */
+/** Pointer to a const audio device info (enumeration result). */
 typedef PDMAUDIOHOSTDEV const *PCPDMAUDIOHOSTDEV;
 
@@ -513 +517 @@
     /** Rear channel. */
     PDMAUDIOPLAYBACKDST_REAR,
+    /** End of valid values. */
+    PDMAUDIOPLAYBACKDST_END,
     /** Hack to blow the type up to 32-bit. */
     PDMAUDIOPLAYBACKDST_32BIT_HACK = 0x7fffffff
@@ -539 +545 @@
     /** Phone-In. */
     PDMAUDIORECSRC_PHONE,
+    /** End of valid values. */
+    PDMAUDIORECSRC_END,
     /** Hack to blow the type up to 32-bit. */
     PDMAUDIORECSRC_32BIT_HACK = 0x7fffffff
@@ -579 +587 @@
      *  directly. Don't use this if you don't have to. */
     PDMAUDIOSTREAMLAYOUT_RAW,
+    /** End of valid values. */
+    PDMAUDIOSTREAMLAYOUT_END,
     /** Hack to blow the type up to 32-bit. */
     PDMAUDIOSTREAMLAYOUT_32BIT_HACK = 0x7fffffff
@@ -644 +654 @@
     /** Right height channel. */
     PDMAUDIOSTREAMCHANNELID_RIGHT_HEIGHT,
+    /** End of valid values. */
+    PDMAUDIOSTREAMCHANNELID_END,
     /** Hack to blow the type up to 32-bit. */
     PDMAUDIOSTREAMCHANNELID_32BIT_HACK = 0x7fffffff
@@ -812 +824 @@
     /** Microphone-In. */
     PDMAUDIOMIXERCTL_MIC_IN,
+    /** End of valid values. */
+    PDMAUDIOMIXERCTL_END,
     /** Hack to blow the type up to 32-bit. */
     PDMAUDIOMIXERCTL_32BIT_HACK = 0x7fffffff
@@ -846 +860 @@
      *  No supported by all backends. */
     PDMAUDIOSTREAMCMD_DROP,
+    /** End of valid values. */
+    PDMAUDIOSTREAMCMD_END,
     /** Hack to blow the type up to 32-bit. */
     PDMAUDIOSTREAMCMD_32BIT_HACK = 0x7fffffff
@@ -1056 +1072 @@
 /**
  * Audio file types.
+ * @todo r=bird: This does not really belong here.
  */
 typedef enum PDMAUDIOFILETYPE

trunk/include/VBox/vmm/pdmaudioinline.h

@@ -77 +77 @@
 
         /* no default */
+        case PDMAUDIODIR_END:
         case PDMAUDIODIR_INVALID:
         case PDMAUDIODIR_32BIT_HACK:
@@ -102 +103 @@
         case PDMAUDIOMIXERCTL_MIC_IN:        return "Microphone-In";
         /* no default */
+        case PDMAUDIOMIXERCTL_END:
         case PDMAUDIOMIXERCTL_INVALID:
         case PDMAUDIOMIXERCTL_32BIT_HACK:
@@ -125 +127 @@
         /* no default */
         case PDMAUDIOPLAYBACKDST_INVALID:
+        case PDMAUDIOPLAYBACKDST_END:
         case PDMAUDIOPLAYBACKDST_32BIT_HACK:
             break;
@@ -149 +152 @@
         case PDMAUDIORECSRC_PHONE:   return "Phone";
         /* no default */
+        case PDMAUDIORECSRC_END:
         case PDMAUDIORECSRC_32BIT_HACK:
             break;
@@ -177 +181 @@
         /* no default */
         case PDMAUDIOFMT_INVALID:
+        case PDMAUDIOFMT_END:
         case PDMAUDIOFMT_32BIT_HACK:
             break;
@@ -207 +212 @@
         /* no default */
         case PDMAUDIOFMT_INVALID:
+        case PDMAUDIOFMT_END:
         case PDMAUDIOFMT_32BIT_HACK:
             break;
@@ -232 +238 @@
         /* no default */
         case PDMAUDIOFMT_INVALID:
+        case PDMAUDIOFMT_END:
         case PDMAUDIOFMT_32BIT_HACK:
             break;
@@ -296 +303 @@
 {
     AssertPtrReturn(pCfg, false);
-    AssertMsgReturn(pCfg->enmDir    >= PDMAUDIODIR_UNKNOWN          && pCfg->enmDir    <= PDMAUDIODIR_DUPLEX,
+    AssertMsgReturn(pCfg->enmDir    >= PDMAUDIODIR_UNKNOWN          && pCfg->enmDir    < PDMAUDIODIR_END,
                     ("%d\n", pCfg->enmDir), false);
-    AssertMsgReturn(pCfg->enmLayout >= PDMAUDIOSTREAMLAYOUT_UNKNOWN && pCfg->enmLayout <= PDMAUDIOSTREAMLAYOUT_RAW,
+    AssertMsgReturn(pCfg->enmLayout >= PDMAUDIOSTREAMLAYOUT_UNKNOWN && pCfg->enmLayout < PDMAUDIOSTREAMLAYOUT_END,
                     ("%d\n", pCfg->enmLayout), false);
     return PDMAudioPropsAreValid(&pCfg->Props);
@@ -380 +387 @@
         case PDMAUDIOSTREAMCMD_DRAIN:   return "Drain";
         case PDMAUDIOSTREAMCMD_DROP:    return "Drop";
+        case PDMAUDIOSTREAMCMD_END:
         case PDMAUDIOSTREAMCMD_32BIT_HACK:
             break;

trunk/src/VBox/Devices/Audio/DevIchAc97.cpp

@@ -2571 +2571 @@
         case PDMAUDIORECSRC_LINE:    return AC97_REC_LINE_IN;
         case PDMAUDIORECSRC_PHONE:   return AC97_REC_PHONE;
-        default:
+        /* no default */
+        case PDMAUDIORECSRC_UNKNOWN:
+        case PDMAUDIORECSRC_END:
+        case PDMAUDIORECSRC_32BIT_HACK:
             break;
     }

trunk/src/VBox/Devices/Audio/DrvAudio.cpp

@@ -419 +419 @@
             rc = drvAudioStreamControlInternalBackend(pThis, pStream, PDMAUDIOSTREAMCMD_DROP);
             if (RT_SUCCESS(rc))
-            {
                 drvAudioStreamDropInternal(pThis, pStream);
-            }
             break;
         }
@@ -1643 +1641 @@
 
                 if (RT_LIKELY(pStream->Host.Cfg.enmLayout == PDMAUDIOSTREAMLAYOUT_NON_INTERLEAVED))
-                {
                     rc = drvAudioStreamPlayNonInterleaved(pThis, pStream, cfToPlay, &cfPlayedTotal);
-                }
                 else if (pStream->Host.Cfg.enmLayout == PDMAUDIOSTREAMLAYOUT_RAW)
-                {
                     rc = drvAudioStreamPlayRaw(pThis, pStream, cfToPlay, &cfPlayedTotal);
-                }
                 else
                     AssertFailedStmt(rc = VERR_NOT_IMPLEMENTED);
@@ -1937 +1931 @@
 
         if (RT_LIKELY(pStream->Host.Cfg.enmLayout == PDMAUDIOSTREAMLAYOUT_NON_INTERLEAVED))
-        {
             rc = drvAudioStreamCaptureNonInterleaved(pThis, pStream, &cfCaptured);
-        }
         else if (pStream->Host.Cfg.enmLayout == PDMAUDIOSTREAMLAYOUT_RAW)
-        {
             rc = drvAudioStreamCaptureRaw(pThis, pStream, &cfCaptured);
-        }
         else
             AssertFailedStmt(rc = VERR_NOT_IMPLEMENTED);