VirtualBox

Changeset 88299 in vbox


Ignore:
Timestamp:
Mar 26, 2021 2:05:04 PM (4 years ago)
Author:
vboxsync
Message:

Audio: We don't return IPRT status codes, but VBox status codes. duh. bugref:9890

Location:
trunk/src/VBox/Devices/Audio
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/Devices/Audio/AudioMixBuffer.cpp

    r88282 r88299  
    142142 * audio frames.
    143143 *
    144  * @return  IPRT status code. VINF_TRY_AGAIN for getting next pointer at beginning (circular).
     144 * @returns VBox status code. VINF_TRY_AGAIN for getting next pointer at beginning (circular).
    145145 * @param   pMixBuf                 Mixing buffer to acquire audio frames from.
    146146 * @param   cFrames                 Number of requested audio frames to write.
    … …  
    364364 * Allocates the internal audio frame buffer.
    365365 *
    366  * @return  IPRT status code.
     366 * @returns VBox status code.
    367367 * @param   pMixBuf                 Mixing buffer to allocate frame buffer for.
    368368 * @param   cFrames                 Number of audio frames to allocate.
    … …  
    774774 * Converts a PDM audio volume to an internal mixing buffer volume.
    775775 *
    776  * @returns IPRT status code.
     776 * @returns VBox status code.
    777777 * @param   pVolDst                 Where to store the converted mixing buffer volume.
    778778 * @param   pVolSrc                 Volume to convert.
    … …  
    798798 * Initializes a mixing buffer.
    799799 *
    800  * @return  IPRT status code.
     800 * @returns VBox status code.
    801801 * @param   pMixBuf                 Mixing buffer to initialize.
    802802 * @param   pszName                 Name of mixing buffer for easier identification. Optional.
    … …  
    908908 * then will automatically do the (needed) conversion.
    909909 *
    910  * @return  IPRT status code.
     910 * @returns VBox status code.
    911911 * @param   pMixBuf                 Mixing buffer to link parent to.
    912912 * @param   pParent                 Parent mixing buffer to use for linking.
    … …  
    10491049 * Mixes audio frames from a source mixing buffer to a destination mixing buffer.
    10501050 *
    1051  * @return  IPRT status code.
     1051 * @returns VBox status code.
    10521052 *          VERR_BUFFER_UNDERFLOW if the source did not have enough audio data.
    10531053 *          VERR_BUFFER_OVERFLOW if the destination did not have enough space to store the converted source audio data.
    … …  
    12321232 * Mixes audio frames down to the parent mixing buffer, extended version.
    12331233 *
    1234  * @return  IPRT status code. See audioMixBufMixTo() for a more detailed explanation.
     1234 * @returns VBox status code. See audioMixBufMixTo() for a more detailed explanation.
    12351235 * @param   pMixBuf                 Source mixing buffer to mix to its parent.
    12361236 * @param   cSrcOffset              Offset (in frames) of source mixing buffer.
    … …  
    12501250 * Mixes audio frames down to the parent mixing buffer.
    12511251 *
    1252  * @return  IPRT status code. See audioMixBufMixTo() for a more detailed explanation.
     1252 * @returns VBox status code. See audioMixBufMixTo() for a more detailed explanation.
    12531253 * @param   pMixBuf                 Source mixing buffer to mix to its parent.
    12541254 * @param   cSrcFrames              Number of source audio frames to mix to its parent.
    … …  
    12651265 * Internal helper function for debugging. Do not use directly.
    12661266 *
    1267  * @return  IPRT status code.
     1267 * @returns VBox status code.
    12681268 * @param   pMixBuf                 Mixing buffer to print.
    12691269 * @param   pszFunc                 Function name to log this for.
    … …  
    13191319 * Do not use directly.
    13201320 *
    1321  * @return  IPRT status code.
     1321 * @returns VBox status code.
    13221322 * @param   pMixBuf                 Mixing buffer to print.
    13231323 * @param   pszFunc                 Function name to print the chain for.
    … …  
    13641364 * For debug versions only.
    13651365 *
    1366  * @return  IPRT status code.
     1366 * @returns VBox status code.
    13671367 * @param   pMixBuf                 Mixing buffer to print.
    13681368 */
    … …  
    13931393 * For debug versions only.
    13941394 *
    1395  * @return  IPRT status code.
     1395 * @returns VBox status code.
    13961396 * @param   pMixBuf                 Mixing buffer to print.
    13971397 */
    … …  
    14291429 * Reads audio frames at a specific offset.
    14301430 *
    1431  * @return  IPRT status code.
     1431 * @returns VBox status code.
    14321432 * @param   pMixBuf                 Mixing buffer to read audio frames from.
    14331433 * @param   offFrames               Offset (in audio frames) to start reading from.
    … …  
    14461446 * not match the output will be converted accordingly.
    14471447 *
    1448  * @return  IPRT status code.
     1448 * @returns VBox status code.
    14491449 * @param   pMixBuf     Mixing buffer to read audio frames from.
    14501450 * @param   pDstProps   The target format.
    … …  
    16331633 * Returns the current read position of a mixing buffer.
    16341634 *
    1635  * @returns IPRT status code.
     1635 * @returns VBox status code.
    16361636 * @param   pMixBuf                 Mixing buffer to return position for.
    16371637 */
    … …  
    17061706 * Unlinks a mixing buffer from its parent, if any.
    17071707 *
    1708  * @return  IPRT status code.
     1708 * @returns VBox status code.
    17091709 * @param   pMixBuf                 Mixing buffer to unlink from parent.
    17101710 */
    … …  
    17681768 * The sample format being written must match the format of the mixing buffer.
    17691769 *
    1770  * @return  IPRT status code.
     1770 * @returns VBox status code.
    17711771 * @param   pMixBuf                 Pointer to mixing buffer to write to.
    17721772 * @param   offFrames               Offset (in frames) starting to write at.
    … …  
    17891789 * the mixing buffer operates on.
    17901790 *
    1791  * @return  IPRT status code.
     1791 * @returns VBox status code.
    17921792 * @param   pMixBuf     Pointer to mixing buffer to write to.
    17931793 * @param   pSrcProps   The source format.
    … …  
    18921892 * The sample format being written must match the format of the mixing buffer.
    18931893 *
    1894  * @return  IPRT status code, or VERR_BUFFER_OVERFLOW if frames which not have
    1895  *          been processed yet have been overwritten (due to cyclic buffer).
     1894 * @returns VBox status code
     1895 * @retval  VERR_BUFFER_OVERFLOW if frames which not have been processed yet
     1896 *          have been overwritten (due to cyclic buffer).
    18961897 * @param   pMixBuf                 Pointer to mixing buffer to write to.
    18971898 * @param   pvBuf                   Pointer to audio buffer to be written.
    … …  
    19081909 * This function might write less data at once than requested.
    19091910 *
    1910  * @return  IPRT status code, or VERR_BUFFER_OVERFLOW no space is available for writing anymore.
     1911 * @returns VBox status code
     1912 * @retval  VERR_BUFFER_OVERFLOW no space is available for writing anymore.
    19111913 * @param   pMixBuf     Pointer to mixing buffer to write to.
    19121914 * @param   pSrcProps   The source format.
    … …  
    20092011 * Returns the current write position of a mixing buffer.
    20102012 *
    2011  * @returns IPRT status code.
     2013 * @returns VBox status code.
    20122014 * @param   pMixBuf                 Mixing buffer to return position for.
    20132015 */

  • trunk/src/VBox/Devices/Audio/AudioMixer.cpp

    r88298 r88299  
    160160 * Creates an audio sink and attaches it to the given mixer.
    161161 *
    162  * @returns IPRT status code.
     162 * @returns VBox status code.
    163163 * @param   pMixer              Mixer to attach created sink to.
    164164 * @param   pszName             Name of the sink to create.
    … …  
    210210 * Creates an audio mixer.
    211211 *
    212  * @returns IPRT status code.
     212 * @returns VBox status code.
    213213 * @param   pcszName            Name of the audio mixer.
    214214 * @param   fFlags              Creation flags.
    … …  
    342342 * Invalidates all internal data, internal version.
    343343 *
    344  * @returns IPRT status code.
     344 * @returns VBox status code.
    345345 * @param   pMixer              Mixer to invalidate data for.
    346346 */
    … …  
    365365 * Invalidates all internal data.
    366366 *
    367  * @returns IPRT status code.
     367 * @returns VBox status code.
    368368 * @param   pMixer              Mixer to invalidate data for.
    369369 */
    … …  
    411411 * Removes a formerly attached audio sink for an audio mixer, internal version.
    412412 *
    413  * @returns IPRT status code.
     413 * @returns VBox status code.
    414414 * @param   pMixer              Mixer to remove sink from.
    415415 * @param   pSink               Sink to remove.
    … …  
    442442 * Removes a formerly attached audio sink for an audio mixer.
    443443 *
    444  * @returns IPRT status code.
     444 * @returns VBox status code.
    445445 * @param   pMixer              Mixer to remove sink from.
    446446 * @param   pSink               Sink to remove.
    … …  
    460460 * Sets the mixer's master volume.
    461461 *
    462  * @returns IPRT status code.
     462 * @returns VBox status code.
    463463 * @param   pMixer              Mixer to set master volume for.
    464464 * @param   pVol                Volume to set.
    … …  
    494494 * Adds an audio stream to a specific audio sink.
    495495 *
    496  * @returns IPRT status code.
     496 * @returns VBox status code.
    497497 * @param   pSink               Sink to add audio stream to.
    498498 * @param   pStream             Stream to add.
    … …  
    557557 * Creates an audio mixer stream.
    558558 *
    559  * @returns IPRT status code.
     559 * @returns VBox status code.
    560560 * @param   pSink               Sink to use for creating the stream.
    561561 * @param   pConn               Audio connector interface to use.
    … …  
    708708 * Controls a mixer sink.
    709709 *
    710  * @returns IPRT status code.
     710 * @returns VBox status code.
    711711 * @param   pSink               Mixer sink to control.
    712712 * @param   enmSinkCmd          Sink command to set.
    … …  
    11841184 * Reads audio data from a mixer sink.
    11851185 *
    1186  * @returns IPRT status code.
     1186 * @returns VBox status code.
    11871187 * @param   pSink               Mixer sink to read data from.
    11881188 * @param   enmOp               Mixer operation to use for reading the data.
    … …  
    12911291 * Removes a mixer stream from a mixer sink, internal version.
    12921292 *
    1293  * @returns IPRT status code.
     1293 * @returns VBox status code.
    12941294 * @param   pSink               Sink to remove mixer stream from.
    12951295 * @param   pStream             Stream to remove.
    … …  
    14551455 * Sets the audio format of a mixer sink.
    14561456 *
    1457  * @returns IPRT status code.
     1457 * @returns VBox status code.
    14581458 * @param   pSink               Sink to set audio format for.
    14591459 * @param   pPCMProps           Audio format (PCM properties) to set.
    … …  
    15281528 * Set the current recording source of an input mixer sink, internal version.
    15291529 *
    1530  * @return  IPRT status code.
     1530 * @returns VBox status code.
    15311531 * @param   pSink               Input mixer sink to set recording source for.
    15321532 * @param   pStream             Mixer stream to set as current recording source. Must be an input stream.
    … …  
    16011601 * Set the current recording source of an input mixer sink.
    16021602 *
    1603  * @return  IPRT status code.
     1603 * @returns VBox status code.
    16041604 * @param   pSink               Input mixer sink to set recording source for.
    16051605 * @param   pStream             Mixer stream to set as current recording source. Must be an input stream.
    … …  
    16251625 * Sets the volume of an individual sink.
    16261626 *
    1627  * @returns IPRT status code.
     1627 * @returns VBox status code.
    16281628 * @param   pSink               Sink to set volume for.
    16291629 * @param   pVol                Volume to set.
    … …  
    16581658 * Updates a mixer sink, internal version.
    16591659 *
    1660  * @returns IPRT status code.
     1660 * @returns VBox status code.
    16611661 * @param   pSink               Mixer sink to update.
    16621662 */
    … …  
    18191819 * Updates (invalidates) a mixer sink.
    18201820 *
    1821  * @returns IPRT status code.
     1821 * @returns VBox status code.
    18221822 * @param   pSink               Mixer sink to update.
    18231823 */
    … …  
    18411841 * Updates the (master) volume of a mixer sink.
    18421842 *
    1843  * @returns IPRT status code.
     1843 * @returns VBox status code.
    18441844 * @param   pSink               Mixer sink to update volume for.
    18451845 * @param   pVolMaster          Master volume to set.
    … …  
    18821882 * Writes (buffered) output data of a sink's stream to the bound audio connector stream.
    18831883 *
    1884  * @returns IPRT status code.
     1884 * @returns VBox status code.
    18851885 * @param   pSink               Sink of stream that contains the mixer stream.
    18861886 * @param   pMixStream          Mixer stream to write output data for.
    … …  
    18971897 * Writes (buffered) output data of a sink's stream to the bound audio connector stream, extended version.
    18981898 *
    1899  * @returns IPRT status code.
     1899 * @returns VBox status code.
    19001900 * @param   pSink               Sink of stream that contains the mixer stream.
    19011901 * @param   pMixStream          Mixer stream to write output data for.
    … …  
    19891989 * only multiplex as much data as all streams can handle at this time.
    19901990 *
    1991  * @returns IPRT status code.
     1991 * @returns VBox status code.
    19921992 * @param   pSink       Sink to write audio output to.
    19931993 * @param   pvBuf       Pointer to audio data to write.
    … …  
    20622062 * Writes data to a mixer sink.
    20632063 *
    2064  * @returns IPRT status code.
     2064 * @returns VBox status code.
    20652065 * @param   pSink               Sink to write data to.
    20662066 * @param   enmOp               Mixer operation to use when writing data to the sink.
    … …  
    21252125 * Controls a mixer stream, internal version.
    21262126 *
    2127  * @returns IPRT status code.
     2127 * @returns VBox status code.
    21282128 * @param   pMixStream          Mixer stream to control.
    21292129 * @param   enmCmd              Mixer stream command to use.
    … …  
    21872187 * Controls a mixer stream.
    21882188 *
    2189  * @returns IPRT status code.
     2189 * @returns VBox status code.
    21902190 * @param   pMixStream          Mixer stream to control.
    21912191 * @param   enmCmd              Mixer stream command to use.
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette