VirtualBox

Changeset 88300 in vbox for trunk/src/VBox


Ignore:
Timestamp:
Mar 26, 2021 2:31:55 PM (4 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
143513
Message:

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

Location:
trunk/src/VBox
Files:
11 edited

Legend:

Unmodified
Added
Removed

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

    r88292 r88300  
    277277 * will be replaced by an underscore ("_").
    278278 *
    279  * @return  IPRT status code.
     279 * @returns VBox status code.
    280280 * @param   pszPath             Path to sanitize.
    281281 * @param   cbPath              Size (in bytes) of path to sanitize.
    … …  
    313313 * Constructs an unique file name, based on the given path and the audio file type.
    314314 *
    315  * @returns IPRT status code.
     315 * @returns VBox status code.
    316316 * @param   pszFile             Where to store the constructed file name.
    317317 * @param   cchFile             Size (in characters) of the file name buffer.
    … …  
    437437 * Creates an audio file.
    438438 *
    439  * @returns IPRT status code.
     439 * @returns VBox status code.
    440440 * @param   enmType             Audio file type to open / create.
    441441 * @param   pszFile             File path of file to open or create.
    … …  
    506506 * Opens or creates an audio file.
    507507 *
    508  * @returns IPRT status code.
     508 * @returns VBox status code.
    509509 * @param   pFile               Pointer to audio file handle to use.
    510510 * @param   fOpen               Open flags.
    … …  
    646646 * Closes an audio file.
    647647 *
    648  * @returns IPRT status code.
     648 * @returns VBox status code.
    649649 * @param   pFile               Audio file handle to close.
    650650 */
    … …  
    709709 * Deletes an audio file.
    710710 *
    711  * @returns IPRT status code.
     711 * @returns VBox status code.
    712712 * @param   pFile               Audio file handle to delete.
    713713 */
    … …  
    776776 * Write PCM data to a wave (.WAV) file.
    777777 *
    778  * @returns IPRT status code.
     778 * @returns VBox status code.
    779779 * @param   pFile               Audio file handle to write PCM data to.
    780780 * @param   pvBuf               Audio data to write.

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

    r88269 r88300  
    670670 * Synchronizes the CORB / RIRB buffers between internal <-> device state.
    671671 *
    672  * @returns IPRT status code.
     672 * @returns VBox status code.
    673673 *
    674674 * @param   pDevIns             The device instance.
    … …  
    16421642 * Adds an audio output stream to the device setup using the given configuration.
    16431643 *
    1644  * @returns IPRT status code.
     1644 * @returns VBox status code.
    16451645 * @param   pThisCC             The ring-3 HDA device state.
    16461646 * @param   pCfg                Stream configuration to use for adding a stream.
    … …  
    17651765 * Adds an audio input stream to the device setup using the given configuration.
    17661766 *
    1767  * @returns IPRT status code.
     1767 * @returns VBox status code.
    17681768 * @param   pThisCC             The ring-3 HDA device state.
    17691769 * @param   pCfg                Stream configuration to use for adding a stream.
    … …  
    18001800 * Adds an audio stream to the device setup using the given configuration.
    18011801 *
    1802  * @returns IPRT status code.
     1802 * @returns VBox status code.
    18031803 * @param   pThisCC             The ring-3 HDA device state.
    18041804 * @param   pCfg                Stream configuration to use for adding a stream.
    … …  
    18351835 * Removes an audio stream from the device setup using the given configuration.
    18361836 *
    1837  * @returns IPRT status code.
     1837 * @returns VBox status code.
    18381838 * @param   pThisCC             The ring-3 HDA device state.
    18391839 * @param   pCfg                Stream configuration to use for removing a stream.
    … …  
    21842184 * Adds a specific HDA driver to the driver chain.
    21852185 *
    2186  * @return IPRT status code.
    2187  * @param   pThisCC             The ring-3 HDA device state.
    2188  * @param  pDrv                 HDA driver to add.
     2186 * @returns VBox status code.
     2187 * @param   pThisCC     The ring-3 HDA device state.
     2188 * @param   pDrv        HDA driver to add.
    21892189 */
    21902190static int hdaR3MixerAddDrv(PHDASTATER3 pThisCC, PHDADRIVER pDrv)
    … …  
    23062306 * Adds a driver stream to a specific mixer sink.
    23072307 *
    2308  * @returns IPRT status code (ignored by caller).
     2308 * @returns VBox status code (ignored by caller).
    23092309 * @param   pMixSink            Audio mixer sink to add audio streams to.
    23102310 * @param   pCfg                Audio stream configuration to use for the audio streams to add.
    … …  
    24292429 * Adds all current driver streams to a specific mixer sink.
    24302430 *
    2431  * @returns IPRT status code.
     2431 * @returns VBox status code.
    24322432 * @param   pThisCC             The ring-3 HDA device state.
    24332433 * @param   pMixSink            Audio mixer sink to add stream to.

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

    r88269 r88300  
    260260 * Converts an HDA stream's SDFMT register into a given PCM properties structure.
    261261 *
    262  * @return  IPRT status code.
     262 * @returns VBox status code.
    263263 * @param   u16SDFMT            The HDA stream's SDFMT value to convert.
    264264 * @param   pProps              PCM properties structure to hold converted result on success.

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

    r88269 r88300  
    5555 * Creates an HDA stream.
    5656 *
    57  * @returns IPRT status code.
     57 * @returns VBox status code.
    5858 * @param   pStreamShared       The HDA stream to construct - shared bits.
    5959 * @param   pStreamR3           The HDA stream to construct - ring-3 bits.
    … …  
    448448 * Sets up ((re-)iniitalizes) an HDA stream.
    449449 *
    450  * @returns IPRT status code. VINF_NO_CHANGE if the stream does not need
     450 * @returns VBox status code. VINF_NO_CHANGE if the stream does not need
    451451 *          be set-up again because the stream's (hardware) parameters did
    452452 *          not change.
    … …  
    878878 * Enables or disables an HDA audio stream.
    879879 *
    880  * @returns IPRT status code.
     880 * @returns VBox status code.
    881881 * @param   pStreamShared       HDA stream to enable or disable - shared bits.
    882882 * @param   pStreamR3           HDA stream to enable or disable - ring-3 bits.
    … …  
    22772277 * Locks an HDA stream for serialized access.
    22782278 *
    2279  * @returns IPRT status code.
     2279 * @returns VBox status code.
    22802280 * @param   pStreamShared       HDA stream to lock (shared bits).
    22812281 */
    … …  
    22922292 * Unlocks a formerly locked HDA stream.
    22932293 *
    2294  * @returns IPRT status code.
     2294 * @returns VBox status code.
    22952295 * @param   pStreamShared       HDA stream to unlock (shared bits).
    22962296 */
    … …  
    25732573 * Creates the async I/O thread for a specific HDA audio stream.
    25742574 *
    2575  * @returns IPRT status code.
     2575 * @returns VBox status code.
    25762576 * @param   pStreamR3           HDA audio stream to create the async I/O thread for.
    25772577 */
    … …  
    26102610 * Destroys the async I/O thread of a specific HDA audio stream.
    26112611 *
    2612  * @returns IPRT status code.
     2612 * @returns VBox status code.
    26132613 * @param   pStreamR3           HDA audio stream to destroy the async I/O thread for.
    26142614 */
    … …  
    26522652 * Lets the stream's async I/O thread know that there is some data to process.
    26532653 *
    2654  * @returns IPRT status code.
     2654 * @returns VBox status code.
    26552655 * @param   pStreamR3           HDA stream to notify async I/O thread for.
    26562656 */

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

    r88269 r88300  
    318318 * Initializes a stream mapping structure according to the given PCM properties.
    319319 *
    320  * @return  IPRT status code.
     320 * @returns VBox status code.
    321321 * @param   pMap            Pointer to mapping to initialize.
    322322 * @param   cHostChannels   The number of host channels to map to.

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

    r88269 r88300  
    841841 * Fetches the current BDLE (Buffer Descriptor List Entry) of an AC'97 audio stream.
    842842 *
    843  * @returns IPRT status code.
     843 * @returns VBox status code.
    844844 * @param   pDevIns             The device instance.
    845845 * @param   pStream             AC'97 stream to fetch BDLE for.
    … …  
    951951 * Returns whether an AC'97 stream is enabled or not.
    952952 *
    953  * @returns IPRT status code.
     953 * @returns VBox status code.
    954954 * @param   pThisCC             The ring-3 AC'97 device state.
    955955 * @param   pStream             Stream to return status for.
    … …  
    967967 * Enables or disables an AC'97 audio stream.
    968968 *
    969  * @returns IPRT status code.
     969 * @returns VBox status code.
    970970 * @param   pThis               The shared AC'97 state.
    971971 * @param   pThisCC             The ring-3 AC'97 state.
    … …  
    10721072 * Creates an AC'97 audio stream.
    10731073 *
    1074  * @returns IPRT status code.
     1074 * @returns VBox status code.
    10751075 * @param   pThisCC             The ring-3 AC'97 state.
    10761076 * @param   pStream             The AC'97 stream to create (shared).
    … …  
    11321132 * Destroys an AC'97 audio stream.
    11331133 *
    1134  * @returns IPRT status code.
     1134 * @returns VBox status code.
    11351135 * @param   pThis               The shared AC'97 state.
    11361136 * @param   pStream             The AC'97 stream to destroy (shared).
    … …  
    12251225 * Writes audio data from a mixer sink into an AC'97 stream's DMA buffer.
    12261226 *
    1227  * @returns IPRT status code.
     1227 * @returns VBox status code.
    12281228 * @param   pDstStreamCC        The AC'97 stream to write to (ring-3).
    12291229 * @param   pSrcMixSink         Mixer sink to get audio data to write from.
    … …  
    12681268 * Reads audio data from an AC'97 stream's DMA buffer and writes into a specified mixer sink.
    12691269 *
    1270  * @returns IPRT status code.
     1270 * @returns VBox status code.
    12711271 * @param   pSrcStreamCC        AC'97 stream to read audio data from (ring-3).
    12721272 * @param   pDstMixSink         Mixer sink to write audio data to.
    … …  
    13351335 * This will do the heavy lifting work for us as soon as it's getting notified by another thread.
    13361336 *
    1337  * @returns IPRT status code.
     1337 * @returns VBox status code.
    13381338 * @param   hThreadSelf         Thread handle.
    13391339 * @param   pvUser              User argument. Must be of type PAC97STREAMTHREADCTX.
    … …  
    14061406 * Creates the async I/O thread for a specific AC'97 audio stream.
    14071407 *
    1408  * @returns IPRT status code.
     1408 * @returns VBox status code.
    14091409 * @param   pThis               The shared AC'97 state (shared).
    14101410 * @param   pThisCC             The shared AC'97 state (ring-3).
    … …  
    14631463 * Lets the stream's async I/O thread know that there is some data to process.
    14641464 *
    1465  * @returns IPRT status code.
     1465 * @returns VBox status code.
    14661466 * @param   pStreamCC             The AC'97 stream to notify async I/O thread
    14671467 *                                for (ring-3).
    … …  
    14761476 * Destroys the async I/O thread of a specific AC'97 audio stream.
    14771477 *
    1478  * @returns IPRT status code.
     1478 * @returns VBox status code.
    14791479 * @param   pThis               The shared AC'97 state.
    14801480 * @param   pStreamCC           AC'97 audio stream to destroy the async I/O thread for.
    … …  
    17521752 * Sets a AC'97 mixer control to a specific value.
    17531753 *
    1754  * @returns IPRT status code.
     1754 * @returns VBox status code.
    17551755 * @param   pThis               The shared AC'97 state.
    17561756 * @param   uMixerIdx           Mixer control to set value for.
    … …  
    18381838 * Adds a driver stream to a specific mixer sink.
    18391839 *
    1840  * @returns IPRT status code.
     1840 * @returns VBox status code.
    18411841 * @param   pMixSink            Mixer sink to add driver stream to.
    18421842 * @param   pCfg                Stream configuration to use.
    … …  
    19311931 * Adds all current driver streams to a specific mixer sink.
    19321932 *
    1933  * @returns IPRT status code.
     1933 * @returns VBox status code.
    19341934 * @param   pThisCC             The ring-3 AC'97 state.
    19351935 * @param   pMixSink            Mixer sink to add stream to.
    … …  
    19651965 * Adds a specific AC'97 driver to the driver chain.
    19661966 *
    1967  * @return IPRT status code.
    1968  * @param  pThisCC              The ring-3 AC'97 device state.
    1969  * @param  pDrv                 The AC'97 driver to add.
     1967 * @returns VBox status code.
     1968 * @param   pThisCC     The ring-3 AC'97 device state.
     1969 * @param   pDrv        The AC'97 driver to add.
    19701970 */
    19711971static int ichac97R3MixerAddDrv(PAC97STATER3 pThisCC, PAC97DRIVER pDrv)
    … …  
    21272127 * the last set sample rate in the AC'97 mixer for this stream.
    21282128 *
    2129  * @returns IPRT status code.
     2129 * @returns VBox status code.
    21302130 * @param   pThis               The shared AC'97 device state (shared).
    21312131 * @param   pThisCC             The shared AC'97 device state (ring-3).
    … …  
    22492249 * Closes an AC'97 stream.
    22502250 *
    2251  * @returns IPRT status code.
     2251 * @returns VBox status code.
    22522252 * @param   pStream             The AC'97 stream to close (shared).
    22532253 */
    … …  
    22632263 * side with the current AC'97 mixer settings for this stream.
    22642264 *
    2265  * @returns IPRT status code.
     2265 * @returns VBox status code.
    22662266 * @param   pThis               The shared AC'97 device state.
    22672267 * @param   pThisCC             The ring-3 AC'97 device state.
    … …  
    22892289 * Locks an AC'97 stream for serialized access.
    22902290 *
    2291  * @returns IPRT status code.
     2291 * @returns VBox status code.
    22922292 * @param   pStreamCC           The AC'97 stream to lock (ring-3).
    22932293 */
    … …  
    23012301 * Unlocks a formerly locked AC'97 stream.
    23022302 *
    2303  * @returns IPRT status code.
     2303 * @returns VBox status code.
    23042304 * @param   pStreamCC           The AC'97 stream to unlock (ring-3).
    23052305 */
    … …  
    23432343 * This currently only supports attenuation -- gain support is currently not implemented.
    23442344 *
    2345  * @returns IPRT status code.
     2345 * @returns VBox status code.
    23462346 * @param   pThis               The shared AC'97 state.
    23472347 * @param   pThisCC             The ring-3 AC'97 state.
    … …  
    24472447 * NB: gain support is currently not implemented in PDM audio.
    24482448 *
    2449  * @returns IPRT status code.
     2449 * @returns VBox status code.
    24502450 * @param   pThis               The shared AC'97 state.
    24512451 * @param   pThisCC             The ring-3 AC'97 state.
    … …  
    26282628 * Resets the AC'97 mixer.
    26292629 *
    2630  * @returns IPRT status code.
     2630 * @returns VBox status code.
    26312631 * @param   pThis               The shared AC'97 state.
    26322632 * @param   pThisCC             The ring-3 AC'97 state.
    … …  
    28002800 * internal FIFO buffer and writing it as DMA data to the device.
    28012801 *
    2802  * @returns IPRT status code.
     2802 * @returns VBox status code.
    28032803 * @param   pDevIns             The device instance.
    28042804 * @param   pThis               The shared AC'97 state.
    … …  
    37183718 * Loads an AC'97 stream from SSM.
    37193719 *
    3720  * @returns IPRT status code.
     3720 * @returns VBox status code.
    37213721 * @param   pDevIns             The device instance.
    37223722 * @param   pSSM                Saved state manager (SSM) handle to use.

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

    r88269 r88300  
    17551755 * Creates the output PDM audio stream for a specific driver.
    17561756 *
    1757  * @returns IPRT status code.
     1757 * @returns VBox status code.
    17581758 * @param   pCfg                Stream configuration to use.
    17591759 * @param   pDrv                Driver stream to create PDM stream for.

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

    r88298 r88300  
    20082008 *       the device emulation!
    20092009 *
    2010  * @return  IPRT status code.
     2010 * @returns VBox status code.
    20112011 * @param   pThis               Driver instance to be called.
    20122012 */

  • trunk/src/VBox/Main/src-client/AudioDriver.cpp

    r88269 r88300  
    7979 * Attaches the driver via EMT, if configured.
    8080 *
    81  * @returns IPRT status code.
     81 * @returns VBox status code.
    8282 * @param   pUVM                The user mode VM handle for talking to EMT.
    8383 * @param   pAutoLock           The callers auto lock instance.  Can be NULL if
    … …  
    163163 * Detatches the driver via EMT, if configured.
    164164 *
    165  * @returns IPRT status code.
     165 * @returns VBox status code.
    166166 * @param   pUVM                The user mode VM handle for talking to EMT.
    167167 * @param   pAutoLock           The callers auto lock instance.  Can be NULL if

  • trunk/src/VBox/Main/src-client/DrvAudioRec.cpp

    r88269 r88300  
    296296 * Initializes a recording sink.
    297297 *
    298  * @returns IPRT status code.
     298 * @returns VBox status code.
    299299 * @param   pThis               Driver instance.
    300300 * @param   pSink               Sink to initialize.
    … …  
    457457 * Shuts down (closes) a recording sink,
    458458 *
    459  * @returns IPRT status code.
     459 * @returns VBox status code.
    460460 * @param   pSink               Recording sink to shut down.
    461461 */
    … …  
    499499 * Creates an audio output stream and associates it with the specified recording sink.
    500500 *
    501  * @returns IPRT status code.
     501 * @returns VBox status code.
    502502 * @param   pThis               Driver instance.
    503503 * @param   pStreamAV           Audio output stream to create.
    … …  
    569569 * Destroys (closes) an audio output stream.
    570570 *
    571  * @returns IPRT status code.
     571 * @returns VBox status code.
    572572 * @param   pThis               Driver instance.
    573573 * @param   pStreamAV           Audio output stream to destroy.
    … …  
    606606 * Controls an audio output stream
    607607 *
    608  * @returns IPRT status code.
     608 * @returns VBox status code.
    609609 * @param   pThis               Driver instance.
    610610 * @param   pStreamAV           Audio output stream to control.
    … …  
    10721072 * Applies a video recording configuration to this driver instance.
    10731073 *
    1074  * @returns IPRT status code.
     1074 * @returns VBox status code.
    10751075 * @param   Settings        Capturing configuration to apply.
    10761076 */

  • trunk/src/VBox/Main/src-client/DrvAudioVRDE.cpp

    r88269 r88300  
    623623 * RDP client.
    624624 *
    625  * @return  IPRT status code.
     625 * @returns VBox status code.
    626626 * @param   pvContext               The context; in this case a pointer to a
    627627 *                                  VRDESTREAMIN structure.
Note: See TracChangeset for help on using the changeset viewer.

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