Changeset 89442 in vbox

Timestamp:

Jun 1, 2021 8:13:51 PM (3 years ago)

Author:

vboxsync

Message:

ValKit/AudioTest: Added some comments to the play command. bugref:10008

File:

• trunk/src/VBox/ValidationKit/utils/audio/vkat.cpp (modified) (4 diffs)

trunk/src/VBox/ValidationKit/utils/audio/vkat.cpp

@@ -1647 +1647 @@
 
 /**
- * Worker for audioTestPlayOne.
+ * Worker for audioTestPlayOne implementing the play loop.
  */
 static RTEXITCODE audioTestPlayOneInner(PAUDIOTESTDRVMIXSTREAM pMix, PAUDIOTESTWAVEFILE pWaveFile,
@@ -1790 +1790 @@
             if (RT_SUCCESS(rc))
             {
+                /*
+                 * Create a mixer wrapper.  This is just a thin wrapper if fWithMixer
+                 * is false, otherwise it's doing mixing, resampling and recoding.
+                 */
                 AUDIOTESTDRVMIXSTREAM Mix;
                 rc = AudioTestMixStreamInit(&Mix, &DrvStack, pStream, fWithMixer ? &WaveFile.Props : NULL, 100 /*ms*/);
@@ -1798 +1802 @@
                                   pStream->cbBackend, fWithMixer ? " mixed" : "");
 
+                    /*
+                     * Enable the stream and start playing.
+                     */
                     rc = audioTestDriverStackStreamEnable(&DrvStack, pStream);
                     if (RT_SUCCESS(rc))
@@ -1804 +1811 @@
                         rcExit = RTMsgErrorExitFailure("Enabling the output stream failed: %Rrc", rc);
 
+                    /*
+                     * Clean up.
+                     */
                     AudioTestMixStreamTerm(&Mix);
                 }