mirrors/alsa-lib
1
0
Fork 0
mirror of https://github.com/alsa-project/alsa-lib.git synced 2025-10-29 05:40:25 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

pcm: extend doc for snd_pcm_hw_params_get_sbits()

Browse source 
Try to explain more the output value and its relation between
format and sample bits defined by the format.

Link: https://github.com/larsimmisch/pyalsaaudio/pull/146
Signed-off-by: Jaroslav Kysela <perex@perex.cz>
This commit is contained in:
Jaroslav Kysela 2024-02-26 14:52:02 +01:00
parent 13057b74c8
commit 4489923d2c
1 changed files with 9 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

13
src/pcm/pcm.c
View file

@ -3904,11 +3904,16 @@ int snd_pcm_hw_params_get_rate_numden(const snd_pcm_hw_params_t *params,
/**
* \brief Get sample resolution info from a configuration space
* \param params Configuration space
* \return signification bits in sample otherwise a negative error code if the info is not available
* \return sample resolution (in bits) otherwise a negative error code if the info is not available
*
* Significant bits are related to usable sample bits (width) not the
* physical sample bits (width). For non-linear formats, this value may have
* a special meaning which may be defined in future.
* For linear formats, this function returns sample resolution -
* used bits starting from the first usable significant bit defined by
* the format (e.g. bit 31 for S32_LE format or bit 23 for S24_LE format -
* starting from bit zero). Application may use full sample bit range defined
* by the format, but additional bits (outside this sample resolution) are
* stripped (not processed).
*
* For non-linear formats, this value may have a special meaning which may be defined in future.
*
* This function should only be called when the configuration space
* contains a single configuration. Call #snd_pcm_hw_params to choose