Changeset 88022 in vbox for trunk/src/VBox/Devices/Audio/DrvAudioCommon.cpp

Timestamp:

Mar 8, 2021 5:50:57 PM (4 years ago)

Author:

vboxsync

Message:

Audio: Preparing to move some of the DrvAudio.h stuff into PDM. bugref:9890

File:

• trunk/src/VBox/Devices/Audio/DrvAudioCommon.cpp (modified) (21 diffs)

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

@@ -801 +801 @@
 {
     AssertPtrReturn(pCfg, false);
-    return DrvAudioHlpPcmPropsAreEqual(pProps, &pCfg->Props);
+    return PDMAudioPropsAreEqual(pProps, &pCfg->Props);
 }
 
@@ -997 +997 @@
  * @param   pProps              PCM properties to calculate bitrate for.
  */
-uint32_t DrvAudioHlpGetBitrate(PCPDMAUDIOPCMPROPS pProps)
+uint32_t PDMAudioPropsGetBitrate(PCPDMAUDIOPCMPROPS pProps)
 {
     return DrvAudioHlpCalcBitrate(pProps->cbSample * 8, pProps->uHz, pProps->cChannels);
@@ -1009 +1009 @@
  * @param   cb          The size (in bytes) to round.
  */
-uint32_t DrvAudioHlpFloorBytesToFrame(PCPDMAUDIOPCMPROPS pProps, uint32_t cb)
+uint32_t PDMAudioPropsFloorBytesToFrame(PCPDMAUDIOPCMPROPS pProps, uint32_t cb)
 {
     AssertPtrReturn(pProps, 0);
@@ -1022 +1022 @@
  * @param   cb          The size (in bytes) to check.
  */
-bool DrvAudioHlpIsBytesAligned(PCPDMAUDIOPCMPROPS pProps, uint32_t cb)
+bool PDMAudioPropsIsSizeAligned(PCPDMAUDIOPCMPROPS pProps, uint32_t cb)
 {
     AssertPtrReturn(pProps, false);
@@ -1037 +1037 @@
  * @param   cb          The number of bytes to convert.
  */
-uint32_t DrvAudioHlpBytesToFrames(PCPDMAUDIOPCMPROPS pProps, uint32_t cb)
+uint32_t PDMAudioPropsBytesToFrames(PCPDMAUDIOPCMPROPS pProps, uint32_t cb)
 {
     AssertPtrReturn(pProps, 0);
@@ -1052 +1052 @@
  * @note    Rounds up the result.
  */
-uint64_t DrvAudioHlpBytesToMilli(PCPDMAUDIOPCMPROPS pProps, uint32_t cb)
+uint64_t PDMAudioPropsBytesToMilli(PCPDMAUDIOPCMPROPS pProps, uint32_t cb)
 {
     AssertPtrReturn(pProps, 0);
@@ -1082 +1082 @@
  * @note    Rounds up the result.
  */
-uint64_t DrvAudioHlpBytesToMicro(PCPDMAUDIOPCMPROPS pProps, uint32_t cb)
+uint64_t PDMAudioPropsBytesToMicro(PCPDMAUDIOPCMPROPS pProps, uint32_t cb)
 {
     AssertPtrReturn(pProps, 0);
@@ -1112 +1112 @@
  * @note    Rounds up the result.
  */
-uint64_t DrvAudioHlpBytesToNano(PCPDMAUDIOPCMPROPS pProps, uint32_t cb)
+uint64_t PDMAudioPropsBytesToNano(PCPDMAUDIOPCMPROPS pProps, uint32_t cb)
 {
     AssertPtrReturn(pProps, 0);
@@ -1141 +1141 @@
  * @sa      PDMAUDIOPCMPROPS_F2B
  */
-uint32_t DrvAudioHlpFramesToBytes(PCPDMAUDIOPCMPROPS pProps, uint32_t cFrames)
+uint32_t PDMAudioPropsFramesToBytes(PCPDMAUDIOPCMPROPS pProps, uint32_t cFrames)
 {
     AssertPtrReturn(pProps, 0);
@@ -1155 +1155 @@
  * @note    No rounding here, result is floored.
  */
-uint64_t DrvAudioHlpFramesToMilli(PCPDMAUDIOPCMPROPS pProps, uint32_t cFrames)
+uint64_t PDMAudioPropsFramesToMilli(PCPDMAUDIOPCMPROPS pProps, uint32_t cFrames)
 {
     AssertPtrReturn(pProps, 0);
@@ -1174 +1174 @@
  * @note    No rounding here, result is floored.
  */
-uint64_t DrvAudioHlpFramesToNano(PCPDMAUDIOPCMPROPS pProps, uint32_t cFrames)
+uint64_t PDMAudioPropsFramesToNano(PCPDMAUDIOPCMPROPS pProps, uint32_t cFrames)
 {
     AssertPtrReturn(pProps, 0);
@@ -1194 +1194 @@
  * @note    The result is rounded rather than floored (hysterical raisins).
  */
-uint32_t DrvAudioHlpMilliToFrames(PCPDMAUDIOPCMPROPS pProps, uint64_t cMs)
+uint32_t PDMAudioPropsMilliToFrames(PCPDMAUDIOPCMPROPS pProps, uint64_t cMs)
 {
     AssertPtrReturn(pProps, 0);
@@ -1220 +1220 @@
  * @note    The result is rounded rather than floored (hysterical raisins).
  */
-uint32_t DrvAudioHlpMilliToBytes(PCPDMAUDIOPCMPROPS pProps, uint64_t cMs)
-{
-    return PDMAUDIOPCMPROPS_F2B(pProps, DrvAudioHlpMilliToFrames(pProps, cMs));
+uint32_t PDMAudioPropsMilliToBytes(PCPDMAUDIOPCMPROPS pProps, uint64_t cMs)
+{
+    return PDMAUDIOPCMPROPS_F2B(pProps, PDMAudioPropsMilliToFrames(pProps, cMs));
 }
 
@@ -1234 +1234 @@
  * @note    The result is rounded rather than floored (hysterical raisins).
  */
-uint32_t DrvAudioHlpNanoToFrames(PCPDMAUDIOPCMPROPS pProps, uint64_t cNs)
+uint32_t PDMAudioPropsNanoToFrames(PCPDMAUDIOPCMPROPS pProps, uint64_t cNs)
 {
     AssertPtrReturn(pProps, 0);
@@ -1260 +1260 @@
  * @note    The result is rounded rather than floored (hysterical raisins).
  */
-uint32_t DrvAudioHlpNanoToBytes(PCPDMAUDIOPCMPROPS pProps, uint64_t cNs)
-{
-    return PDMAUDIOPCMPROPS_F2B(pProps, DrvAudioHlpNanoToFrames(pProps, cNs));
+uint32_t PDMAudioPropsNanoToBytes(PCPDMAUDIOPCMPROPS pProps, uint64_t cNs)
+{
+    return PDMAUDIOPCMPROPS_F2B(pProps, PDMAudioPropsNanoToFrames(pProps, cNs));
 }
 
@@ -1269 +1269 @@
  * given by the PCM properties).
  *
- * @param   pPCMProps               PCM properties to use for the buffer to clear.
- * @param   pvBuf                   Buffer to clear.
- * @param   cbBuf                   Size (in bytes) of the buffer.
- * @param   cFrames                 Number of audio frames to clear in the buffer.
- */
-void DrvAudioHlpClearBuf(PCPDMAUDIOPCMPROPS pPCMProps, void *pvBuf, size_t cbBuf, uint32_t cFrames)
+ * @param   pProps      The PCM properties to apply.
+ * @param   pvBuf       The buffer to clear.
+ * @param   cbBuf       The buffer size in bytes.
+ * @param   cFrames     The number of audio frames to clear.  Capped at @a cbBuf
+ *                      if exceeding the buffer.  If the size is an unaligned
+ *                      number of frames, the extra bytes may be left
+ *                      uninitialized in some configurations.
+ */
+void PDMAudioPropsClearBuffer(PCPDMAUDIOPCMPROPS pProps, void *pvBuf, size_t cbBuf, uint32_t cFrames)
 {
     /*
      * Validate input
      */
-    AssertPtrReturnVoid(pPCMProps);
-    Assert(pPCMProps->cbSample);
+    AssertPtrReturnVoid(pProps);
+    Assert(pProps->cbSample);
     if (!cbBuf || !cFrames)
         return;
     AssertPtrReturnVoid(pvBuf);
 
-    Assert(pPCMProps->fSwapEndian == false); /** @todo Swapping Endianness is not supported yet. */
+    Assert(pProps->fSwapEndian == false); /** @todo Swapping Endianness is not supported yet. */
 
     /*
      * Decide how much needs clearing.
      */
-    size_t cbToClear = DrvAudioHlpFramesToBytes(pPCMProps, cFrames);
+    size_t cbToClear = PDMAudioPropsFramesToBytes(pProps, cFrames);
     AssertStmt(cbToClear <= cbBuf, cbToClear = cbBuf);
 
-    Log2Func(("pPCMProps=%p, pvBuf=%p, cFrames=%RU32, fSigned=%RTbool, cBytes=%RU8\n",
-              pPCMProps, pvBuf, cFrames, pPCMProps->fSigned, pPCMProps->cbSample));
+    Log2Func(("pProps=%p, pvBuf=%p, cFrames=%RU32, fSigned=%RTbool, cBytes=%RU8\n",
+              pProps, pvBuf, cFrames, pProps->fSigned, pProps->cbSample));
 
     /*
      * Do the job.
      */
-    if (pPCMProps->fSigned)
+    if (pProps->fSigned)
         RT_BZERO(pvBuf, cbToClear);
     else /* Unsigned formats. */
     {
-        switch (pPCMProps->cbSample)
+        switch (pProps->cbSample)
         {
             case 1: /* 8 bit */
@@ -1325 +1328 @@
 
             default:
-                AssertMsgFailed(("Invalid bytes per sample: %RU8\n", pPCMProps->cbSample));
+                AssertMsgFailed(("Invalid bytes per sample: %RU8\n", pProps->cbSample));
         }
     }
@@ -1337 +1340 @@
  * @param   pProps2     The second set of properties to compare.
  */
-bool DrvAudioHlpPcmPropsAreEqual(PCPDMAUDIOPCMPROPS pProps1, PCPDMAUDIOPCMPROPS pProps2)
+bool PDMAudioPropsAreEqual(PCPDMAUDIOPCMPROPS pProps1, PCPDMAUDIOPCMPROPS pProps2)
 {
     AssertPtrReturn(pProps1, false);
@@ -1416 +1419 @@
  * @sa      PDMAUDIOPCMPROPS_F2B
  */
-uint32_t DrvAudioHlpBytesPerFrame(PCPDMAUDIOPCMPROPS pProps)
+uint32_t PDMAudioPropsBytesPerFrame(PCPDMAUDIOPCMPROPS pProps)
 {
     return PDMAUDIOPCMPROPS_F2B(pProps, 1 /*cFrames*/);
@@ -1426 +1429 @@
  * @param   pProps              Stream configuration to log.
  */
-void DrvAudioHlpPcmPropsLog(PCPDMAUDIOPCMPROPS pProps)
+void PDMAudioPropsLog(PCPDMAUDIOPCMPROPS pProps)
 {
     AssertPtrReturnVoid(pProps);
@@ -1714 +1717 @@
             pData->Hdr.u16NumChannels   = pProps->cChannels;
             pData->Hdr.u32SampleRate    = pProps->uHz;
-            pData->Hdr.u32ByteRate      = DrvAudioHlpGetBitrate(pProps) / 8;
+            pData->Hdr.u32ByteRate      = PDMAudioPropsGetBitrate(pProps) / 8;
             pData->Hdr.u16BlockAlign    = pProps->cChannels * pProps->cbSample;
             pData->Hdr.u16BitsPerSample = pProps->cbSample * 8;