Changeset 91668 in vbox for trunk/src/VBox/ValidationKit/utils

Timestamp:

Oct 11, 2021 5:09:51 PM (3 years ago)

Author:

vboxsync

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

147395

Message:

Audio/Validation Kit: Added syntax help for the 'verify' sub command. ​bugref:10008

File:

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

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

@@ -1118 +1118 @@
 }
 
+/** Option help for the 'verify' command. */
+static DECLCALLBACK(const char *) audioTestCmdVerifyHelp(PCRTGETOPTDEF pOpt)
+{
+    switch (pOpt->iShort)
+    {
+        case VKAT_VERIFY_OPT_MAX_DIFF_COUNT:    return "Specifies the maximum number of differences\n"
+                                                       "    Default: 0 (strict)";
+        case VKAT_VERIFY_OPT_MAX_DIFF_PERCENT:  return "Specifies the maximum difference (percent)\n"
+                                                       "    Default: 0 (strict)";
+        case VKAT_VERIFY_OPT_MAX_SIZE_PERCENT:  return "Specifies the maximum size difference (percent)\n"
+                                                       "    Default: 1 (strict)";
+        case VKAT_VERIFY_OPT_NORMALIZE:         return "Enables / disables audio data normalization\n"
+                                                       "    Default: false";
+        default:
+            break;
+    }
+    return NULL;
+}
+
 /**
  * Main (entry) function for the verification functionality of VKAT.
@@ -1208 +1227 @@
     g_aCmdVerifyOptions,
     RT_ELEMENTS(g_aCmdVerifyOptions),
-    NULL,
+    audioTestCmdVerifyHelp,
     false /* fNeedsTransport */
 };